[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-transclusion 0dccf2b 5/5: docs: update some text
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org-transclusion 0dccf2b 5/5: docs: update some text |
Date: |
Thu, 23 Dec 2021 12:57:40 -0500 (EST) |
branch: externals/org-transclusion
commit 0dccf2b2f5af611a1466139f07f767b34db09fd0
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
docs: update some text
---
docs/index.html | 15 ++++-----
org-transclusion.info | 87 ++++++++++++++++++++++++++-------------------------
org-transclusion.org | 17 +++++-----
org-transclusion.texi | 15 ++++-----
4 files changed, 70 insertions(+), 64 deletions(-)
diff --git a/docs/index.html b/docs/index.html
index 5914a27..87fdd4e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -179,11 +179,11 @@ Next: <a href="#Installation" accesskey="n"
rel="next">Installation</a>, Previou
</div>
<span id="Example-Use-Cases-_0026-Main-Features-1"></span><h2
class="chapter">1 Example Use Cases & Main Features</h2>
-<p>Example Use Cases:
+<p>Here are a summary of some real use cases that users have shared with the
author, including his own.
</p>
<dl compact="compact">
<dt>Book writing</dt>
-<dd><p>You have a collection of notes. You can quickly transclude paragraphs
and sections from them into a draft. As they are links, it’s easy to
re-organize them into different sequences to see which way works the best.
+<dd><p>You have a collection of notes. You can quickly transclude paragraphs
and sections from your notes and put together a draft. As transclusions are
links, it’s easy to re-organize them into different sequences to see
which way works the best.
</p>
</dd>
<dt>Academic writing</dt>
@@ -191,7 +191,7 @@ Next: <a href="#Installation" accesskey="n"
rel="next">Installation</a>, Previou
</p>
</dd>
<dt>Technical writing</dt>
-<dd><p>You write technical documents for software. Transclude relevant lines
of code into the document. As the code is only transcluded. You can keep the
document up-to-date as the code evolves.
+<dd><p>You write technical documents for software. Transclude relevant lines
of code into the document. As the code is only transcluded, you can keep the
document up-to-date as the code evolves.
</p>
</dd>
<dt>Project status reports</dt>
@@ -228,21 +228,22 @@ Next: <a href="#Getting-Started" accesskey="n"
rel="next">Getting Started</a>, P
<p>This package is available on <a
href="https://elpa.gnu.org/packages/org-transclusion.html">GNU ELPA</a>. You
can do ‘<samp>M-x package-install RET
org-transclusion</samp>’ to install it. After installation, you can
start using
-Org-transclusion (refer to the <a href="#Getting-Started">Getting Started</a>
section). You can define
-keybindings in your configuration like this below.
+Org-transclusion (refer to the <a href="#Getting-Started">Getting Started</a>
section).
+</p>
+<p>Below are some example keybindings that can be put into your Emacs
configuration.
</p>
<div class="lisp">
<pre class="lisp">(define-key global-map (kbd "<f12>")
#'org-transclusion-add)
(define-key global-map (kbd "C-n t") #'org-transclusion-mode)
</pre></div>
-<p>If you use Doom, you can do something like this below to install the
package. Then add ‘<samp>use-package!</samp>’ to load the package
in your ‘<samp>config.el</samp>’ like an example below.
+<p>For Doom users, you would need to do something like this below to install
the package and configure the keybindings.
</p>
<div class="lisp">
<pre class="lisp">;; ~/.doom.d/package.el
(package! org-transclusion)
-</pre></div>
+</pre></div>
<div class="lisp">
<pre class="lisp">;; ~/.doom.d/config.el
diff --git a/org-transclusion.info b/org-transclusion.info
index 574cb76..4680c7e 100644
--- a/org-transclusion.info
+++ b/org-transclusion.info
@@ -116,13 +116,14 @@ File: org-transclusion.info, Node: Example Use Cases &
Main Features, Next: In
1 Example Use Cases & Main Features
***********************************
-Example Use Cases:
+Here are a summary of some real use cases that users have shared with
+the author, including his own.
Book writing
You have a collection of notes. You can quickly transclude
- paragraphs and sections from them into a draft. As they are links,
- it’s easy to re-organize them into different sequences to see which
- way works the best.
+ paragraphs and sections from your notes and put together a draft.
+ As transclusions are links, it’s easy to re-organize them into
+ different sequences to see which way works the best.
Academic writing
You have a collection of quotes and notes from your research and
@@ -132,8 +133,8 @@ Academic writing
Technical writing
You write technical documents for software. Transclude relevant
- lines of code into the document. As the code is only transcluded.
- You can keep the document up-to-date as the code evolves.
+ lines of code into the document. As the code is only transcluded,
+ you can keep the document up-to-date as the code evolves.
Project status reports
You work on multiple projects at the same time and need to report
@@ -178,19 +179,21 @@ This package is available on GNU ELPA
(https://elpa.gnu.org/packages/org-transclusion.html). You can do ‘M-x
package-install RET org-transclusion’ to install it. After
installation, you can start using Org-transclusion (refer to the *note
-Getting Started:: section). You can define keybindings in your
-configuration like this below.
+Getting Started:: section).
+
+ Below are some example keybindings that can be put into your Emacs
+configuration.
(define-key global-map (kbd "<f12>") #'org-transclusion-add)
(define-key global-map (kbd "C-n t") #'org-transclusion-mode)
- If you use Doom, you can do something like this below to install the
-package. Then add ‘use-package!’ to load the package in your
-‘config.el’ like an example below.
+ For Doom users, you would need to do something like this below to
+install the package and configure the keybindings.
;; ~/.doom.d/package.el
(package! org-transclusion)
+
;; ~/.doom.d/config.el
(use-package! org-transclusion
:after org
@@ -1673,37 +1676,37 @@ their use in free software.
Tag Table:
Node: Top846
Node: Example Use Cases & Main Features3652
-Node: Installation5867
-Node: Getting Started7010
-Node: Usage10019
-Node: Org-transclusion mode activate and deactivate10489
-Node: Org links supported12542
-Node: Control levels of headlines per transclusion14288
-Node: Filter Org elements per transclusion16092
-Node: Notes on excluding the headline element19768
-Node: Live-sync edit20740
-Node: Transclude source file into src-block23125
-Node: Transclude range of lines for text and source files24222
-Node: lines property to specify a range of lines24777
-Node: end property to specify a search term to dynamically look for the end of
a range26722
-Node: Extensions28299
-Node: Customizing30166
-Node: Customizable filter to exclude certain Org elements31993
-Node: Include the section before the first headline (Org file only)33027
-Node: Faces & fringe bitmap33702
-Node: Face for the #+transclude keyword34043
-Node: Faces for the fringes next to transcluded region and source region34537
-Node: Keybindings36119
-Node: Known Limitations37125
-Node: Credits39759
-Node: Original idea by John Kitchin39943
-Node: Text-Clone42504
-Node: Contributing43081
-Node: Notes on pull requests and Free Software Foundation (FSF) copy right
assignment43606
-Node: Index - Features44292
-Node: Index - Commands46923
-Node: Index - User Options48742
-Node: GNU Free Documentation License51084
+Node: Installation5975
+Node: Getting Started7081
+Node: Usage10090
+Node: Org-transclusion mode activate and deactivate10560
+Node: Org links supported12613
+Node: Control levels of headlines per transclusion14359
+Node: Filter Org elements per transclusion16163
+Node: Notes on excluding the headline element19839
+Node: Live-sync edit20811
+Node: Transclude source file into src-block23196
+Node: Transclude range of lines for text and source files24293
+Node: lines property to specify a range of lines24848
+Node: end property to specify a search term to dynamically look for the end of
a range26793
+Node: Extensions28370
+Node: Customizing30237
+Node: Customizable filter to exclude certain Org elements32064
+Node: Include the section before the first headline (Org file only)33098
+Node: Faces & fringe bitmap33773
+Node: Face for the #+transclude keyword34114
+Node: Faces for the fringes next to transcluded region and source region34608
+Node: Keybindings36190
+Node: Known Limitations37196
+Node: Credits39830
+Node: Original idea by John Kitchin40014
+Node: Text-Clone42575
+Node: Contributing43152
+Node: Notes on pull requests and Free Software Foundation (FSF) copy right
assignment43677
+Node: Index - Features44363
+Node: Index - Commands46994
+Node: Index - User Options48813
+Node: GNU Free Documentation License51155
End Tag Table
diff --git a/org-transclusion.org b/org-transclusion.org
index ccc6023..7d6eff9 100644
--- a/org-transclusion.org
+++ b/org-transclusion.org
@@ -1,6 +1,6 @@
#+title: Org-transclusion User Manual
#+author: Noboru Ota <me@nobiot.com>
-#+modified: 2021-12-23T181620
+#+modified: 2021-12-23T184320
#+language: en
#+export_file_name: org-transclusion.texi
#+texinfo_dir_category: Emacs
@@ -47,11 +47,11 @@ modify this GNU manual.”
* Example Use Cases & Main Features
-Example Use Cases:
+Here are a summary of some real use cases that users have shared with the
author, including his own.
- Book writing ::
- You have a collection of notes. You can quickly transclude paragraphs and
sections from them into a draft. As they are links, it's easy to re-organize
them into different sequences to see which way works the best.
+ You have a collection of notes. You can quickly transclude paragraphs and
sections from your notes and put together a draft. As transclusions are links,
it's easy to re-organize them into different sequences to see which way works
the best.
- Academic writing ::
@@ -59,7 +59,7 @@ Example Use Cases:
- Technical writing ::
- You write technical documents for software. Transclude relevant lines of
code into the document. As the code is only transcluded. You can keep the
document up-to-date as the code evolves.
+ You write technical documents for software. Transclude relevant lines of
code into the document. As the code is only transcluded, you can keep the
document up-to-date as the code evolves.
- Project status reports ::
@@ -87,21 +87,22 @@ Main Features:
This package is available on
[[https://elpa.gnu.org/packages/org-transclusion.html][GNU ELPA]]. You can do
=M-x package-install RET
org-transclusion= to install it. After installation, you can start using
-Org-transclusion (refer to the [[#getting-started][Getting Started]] section).
You can define
-keybindings in your configuration like this below.
+Org-transclusion (refer to the [[#getting-started][Getting Started]] section).
+
+Below are some example keybindings that can be put into your Emacs
configuration.
#+BEGIN_SRC elisp
(define-key global-map (kbd "<f12>") #'org-transclusion-add)
(define-key global-map (kbd "C-n t") #'org-transclusion-mode)
#+END_SRC
-If you use Doom, you can do something like this below to install the package.
Then add =use-package!= to load the package in your =config.el= like an example
below.
+For Doom users, you would need to do something like this below to install the
package and configure the keybindings.
#+begin_src elisp
;; ~/.doom.d/package.el
(package! org-transclusion)
-#+end_src
+#+end_src
#+begin_src elisp
;; ~/.doom.d/config.el
diff --git a/org-transclusion.texi b/org-transclusion.texi
index eddcbff..b8dfb4a 100644
--- a/org-transclusion.texi
+++ b/org-transclusion.texi
@@ -116,17 +116,17 @@ Contributing
@node Example Use Cases & Main Features
@chapter Example Use Cases & Main Features
-Example Use Cases:
+Here are a summary of some real use cases that users have shared with the
author, including his own.
@table @asis
@item Book writing
-You have a collection of notes. You can quickly transclude paragraphs and
sections from them into a draft. As they are links, it's easy to re-organize
them into different sequences to see which way works the best.
+You have a collection of notes. You can quickly transclude paragraphs and
sections from your notes and put together a draft. As transclusions are links,
it's easy to re-organize them into different sequences to see which way works
the best.
@item Academic writing
You have a collection of quotes and notes from your research and literature
review. Transclude relevant elements of quotes and notes into different papers.
You can keep your collection as the central repository of your research.
@item Technical writing
-You write technical documents for software. Transclude relevant lines of code
into the document. As the code is only transcluded. You can keep the document
up-to-date as the code evolves.
+You write technical documents for software. Transclude relevant lines of code
into the document. As the code is only transcluded, you can keep the document
up-to-date as the code evolves.
@item Project status reports
You work on multiple projects at the same time and need to report to different
project managers. Transclude relevant parts of your work notes and logs into
respective project reports. You can keep a single collection of your work notes
and logs.
@@ -165,21 +165,22 @@ Extend Org-transclusion with its extension framework
This package is available on
@uref{https://elpa.gnu.org/packages/org-transclusion.html, GNU ELPA}. You can
do @samp{M-x package-install RET
org-transclusion} to install it. After installation, you can start using
-Org-transclusion (refer to the @ref{Getting Started} section). You can define
-keybindings in your configuration like this below.
+Org-transclusion (refer to the @ref{Getting Started} section).
+
+Below are some example keybindings that can be put into your Emacs
configuration.
@lisp
(define-key global-map (kbd "<f12>") #'org-transclusion-add)
(define-key global-map (kbd "C-n t") #'org-transclusion-mode)
@end lisp
-If you use Doom, you can do something like this below to install the package.
Then add @samp{use-package!} to load the package in your @samp{config.el} like
an example below.
+For Doom users, you would need to do something like this below to install the
package and configure the keybindings.
@lisp
;; ~/.doom.d/package.el
(package! org-transclusion)
-@end lisp
+@end lisp
@lisp
;; ~/.doom.d/config.el
- [elpa] externals/org-transclusion updated (664b973 -> 0dccf2b), ELPA Syncer, 2021/12/23
- [elpa] externals/org-transclusion 9373c3e 3/5: docs: add .nojekyll file for GitHub Pages, ELPA Syncer, 2021/12/23
- [elpa] externals/org-transclusion 0dccf2b 5/5: docs: update some text,
ELPA Syncer <=
- [elpa] externals/org-transclusion 324842d 1/5: docs:initial version of dedicated user manual, ELPA Syncer, 2021/12/23
- [elpa] externals/org-transclusion 8f5f714 2/5: docs: add User Manual .texi, .info, and .html, ELPA Syncer, 2021/12/23
- [elpa] externals/org-transclusion 97380c0 4/5: docs: add missing transclusions, ELPA Syncer, 2021/12/23