branch: externals/org-transclusion
commit aa1bb8c58b5d21019481ff9c858330f90724b5c4
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
docs: A new README.org & user manual
---
README.org | 12 ++++----
docs/index.html | 19 +-----------
org-transclusion.info | 80 +++++++++++++++++++++------------------------------
3 files changed, 40 insertions(+), 71 deletions(-)
diff --git a/README.org b/README.org
index 348dfe2..b5f47f3 100644
--- a/README.org
+++ b/README.org
@@ -3,10 +3,14 @@
#+email: m...@nobiot.com
#+options: toc:nil
-* Introduction
-
Org-transclusion lets you insert a copy of text content via a file link or ID
link within an Org file. It lets you have the same content present in different
buffers at the same time without copy-and-pasting it. Edit the source of the
content, and you can refresh the transcluded copies to the up-to-date state.
Org-transclusion keeps your files clear of the transcluded copies, leaving only
the links to the original content.<<whatis>>
+A complete user manual is available
[[https://nobiot.github.io/org-transclusion/][online]] or Emacs in-system as an
Info document (=C-h i= and find the =Org-transclusion= node).
+
+For installation, refer to [[*Installation][Instalaltion]] below or the
corresponding section in the user manaul.
+
+The [[https://nobiot.github.io/org-transclusion/#Getting-Started][Getting
Started]] in the user manaul will get you started in 5 minutes.
+
#+caption: Animation to show creation of a transclusion from an ID link
[[./resources/2021-09-10-transclusion.gif]]
@@ -71,7 +75,7 @@ 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).
+Org-transclusion.
Below are some example keybindings that can be put into your Emacs
configuration.
@@ -105,8 +109,6 @@ For Doom users, you would need to do something like this
below to install the pa
- Create issues, discussion, and/or pull requests. All welcome.
-** Notes on pull requests and Free Software Foundation (FSF) copy right
assignment
-
Org-transclusion is part of GNU ELPA and thus copyrighted by the
[[http://fsf.org][Free Software Foundation]] (FSF). This means that anyone who
is making a substantive code contribution will need to "assign the copyright
for your contributions to the FSF so that they can be included in GNU Emacs"
([[https://orgmode.org/contribute.html#copyright][Org Mode website]]).
Thank you.
diff --git a/docs/index.html b/docs/index.html
index 588559e..956687f 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -165,11 +165,6 @@ Credits
<tr><td align="left" valign="top">• <a
href="#Text_002dClone">Text-Clone</a></td><td> </td><td align="left"
valign="top">
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-Contributing
-
-</pre></th></tr><tr><td align="left" valign="top">• <a
href="#Notes-on-pull-requests-and-Free-Software-Foundation-_0028FSF_0029-copy-right-assignment">Notes
on pull requests and Free Software Foundation (FSF) copy right
assignment</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr></table>
<hr>
@@ -228,7 +223,7 @@ 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).
+Org-transclusion.
</p>
<p>Below are some example keybindings that can be put into your Emacs
configuration.
</p>
@@ -1063,18 +1058,6 @@ Next: <a href="#Index-_002d-Features" accesskey="n"
rel="next">Index - Features<
</li><li> Create issues, discussion, and/or pull requests. All welcome.
</li></ul>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top">• <a
href="#Notes-on-pull-requests-and-Free-Software-Foundation-_0028FSF_0029-copy-right-assignment"
accesskey="1">Notes on pull requests and Free Software Foundation (FSF) copy
right assignment</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
-<hr>
-<span
id="Notes-on-pull-requests-and-Free-Software-Foundation-_0028FSF_0029-copy-right-assignment"></span><div
class="header">
-<p>
-Up: <a href="#Contributing" accesskey="u" rel="up">Contributing</a> [<a
href="#Index-_002d-Features" title="Index" rel="index">Index</a>]</p>
-</div>
-<span
id="Notes-on-pull-requests-and-Free-Software-Foundation-_0028FSF_0029-copy-right-assignment-1"></span><h3
class="section">8.1 Notes on pull requests and Free Software Foundation (FSF)
copy right assignment</h3>
-
<p>Org-transclusion is part of GNU ELPA and thus copyrighted by the <a
href="http://fsf.org";>Free Software Foundation</a> (FSF). This means that
anyone who is making a substantive code contribution will need to "assign
the copyright for your contributions to the FSF so that they can be included in
GNU Emacs" (<a href="https://orgmode.org/contribute.html#copyright";>Org
Mode website</a>).
</p>
<p>Thank you.
diff --git a/org-transclusion.info b/org-transclusion.info
index 186a913..1bf0650 100644
--- a/org-transclusion.info
+++ b/org-transclusion.info
@@ -104,10 +104,6 @@ Credits
* Original idea by John Kitchin::
* Text-Clone::
-Contributing
-
-* Notes on pull requests and Free Software Foundation (FSF) copy right
assignment::
-
File: org-transclusion.info, Node: Example Use Cases & Main Features, Next:
Installation, Prev: Top, Up: Top
@@ -177,8 +173,7 @@ File: org-transclusion.info, Node: Installation, Next:
Getting Started, Prev:
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).
+installation, you can start using Org-transclusion.
Below are some example keybindings that can be put into your Emacs
configuration.
@@ -1054,16 +1049,6 @@ File: org-transclusion.info, Node: Contributing, Next:
Index - Features, Prev
• Create issues, discussion, and/or pull requests. All welcome.
-* Menu:
-
-* Notes on pull requests and Free Software Foundation (FSF) copy right
assignment::
-
-
-File: org-transclusion.info, Node: Notes on pull requests and Free Software
Foundation (FSF) copy right assignment, Up: Contributing
-
-8.1 Notes on pull requests and Free Software Foundation (FSF) copy right
assignment
-===================================================================================
-
Org-transclusion is part of GNU ELPA and thus copyrighted by the Free
Software Foundation (http://fsf.org) (FSF). This means that anyone who
is making a substantive code contribution will need to "assign the
@@ -1670,38 +1655,37 @@ their use in free software.
Tag Table:
Node: Top846
Ref: whatis1507
-Node: Example Use Cases & Main Features3673
-Node: Installation5993
-Node: Getting Started7176
-Node: Usage10163
-Node: Org-transclusion mode activate and deactivate10633
-Node: Org links supported12668
-Node: Control levels of headlines per transclusion14410
-Node: Filter Org elements per transclusion16202
-Node: Notes on excluding the headline element19869
-Node: Live-sync edit20839
-Node: Transclude source file into src-block23209
-Node: Transclude range of lines for text and source files24294
-Node: lines property to specify a range of lines24846
-Node: end property to specify a search term to dynamically look for the end of
a range26767
-Node: Extensions28335
-Node: Customizing30193
-Node: Customizable filter to exclude certain Org elements32020
-Node: Include the section before the first headline (Org file only)33045
-Node: Faces & fringe bitmap33720
-Node: Face for the #+transclude keyword34061
-Node: Faces for the fringes next to transcluded region and source region34555
-Node: Keybindings36128
-Node: Known Limitations37134
-Node: Credits39768
-Node: Original idea by John Kitchin39952
-Node: Text-Clone42513
-Node: Contributing43090
-Node: Notes on pull requests and Free Software Foundation (FSF) copy right
assignment43615
-Node: Index - Features44298
-Node: Index - Commands46929
-Node: Index - User Options48748
-Node: GNU Free Documentation License51090
+Node: Example Use Cases & Main Features3574
+Node: Installation5894
+Node: Getting Started7030
+Node: Usage10017
+Node: Org-transclusion mode activate and deactivate10487
+Node: Org links supported12522
+Node: Control levels of headlines per transclusion14264
+Node: Filter Org elements per transclusion16056
+Node: Notes on excluding the headline element19723
+Node: Live-sync edit20693
+Node: Transclude source file into src-block23063
+Node: Transclude range of lines for text and source files24148
+Node: lines property to specify a range of lines24700
+Node: end property to specify a search term to dynamically look for the end of
a range26621
+Node: Extensions28189
+Node: Customizing30047
+Node: Customizable filter to exclude certain Org elements31874
+Node: Include the section before the first headline (Org file only)32899
+Node: Faces & fringe bitmap33574
+Node: Face for the #+transclude keyword33915
+Node: Faces for the fringes next to transcluded region and source region34409
+Node: Keybindings35982
+Node: Known Limitations36988
+Node: Credits39622
+Node: Original idea by John Kitchin39806
+Node: Text-Clone42367
+Node: Contributing42944
+Node: Index - Features43751
+Node: Index - Commands46382
+Node: Index - User Options48201
+Node: GNU Free Documentation License50543
End Tag Table
