[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-transclusion ace8e00b4c 4/5: docs: edit for clarity
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org-transclusion ace8e00b4c 4/5: docs: edit for clarity (hopefully) |
Date: |
Wed, 29 Dec 2021 06:02:05 -0500 (EST) |
branch: externals/org-transclusion
commit ace8e00b4c9822033028f18299ba41581f4ec9cf
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
docs: edit for clarity (hopefully)
---
docs/org-transclusion-manual.org | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/docs/org-transclusion-manual.org b/docs/org-transclusion-manual.org
index 82b50643ce..adf2ce715a 100644
--- a/docs/org-transclusion-manual.org
+++ b/docs/org-transclusion-manual.org
@@ -208,7 +208,7 @@ Use the =:level= property with a value of single digit
number from 1 to 9 like t
#+transclude: [[file:path/to/file.org::*Headline]] :level 2
#+end_example
-The top level of the transcluded headline will set to the value of =:level=
property -- in this example, level 2 regardless of that in the source. When the
headline contains sub-headlines, they will be all automatically promoted or
demoted to align according to how many levels the top of the subtree will move.
+The top level of the transcluded headline will be set to the value of =:level=
property -- in this example, level 2 regardless of that in the source. When the
headline contains sub-headlines, they will be all automatically promoted or
demoted to align according to how many levels the top of the subtree will move.
When you transclude an entire Org file, it may contain multiple subtrees. In
such cases, the top-most level among the subtrees will be set according to the
=:level= property; the rest of headlines in the buffer will align accordingly.
@@ -388,9 +388,9 @@ The rage is specified by the number "3-5"; in this case,
lines from 3 to 5, both
To transclude a single line, have the the same number in both places (e.g.
10-10, meaning line 10 only).
-One of the numbers can be omitted. When the first number is omitted (e.g.
-10), it means from the beginning of the file to line 10. Likewise, when the
second number is omitted (e.g. 10-), it means from line 10 to the end of file.
+One of the numbers can be omitted. When the first number is omitted (e.g.
-10), it means from the beginning of the file to line 10. Likewise, when the
second number is omitted (e.g. 10-), it means from line 10 to the end of file.
-You can combine the =:lines= property with the =:src= property to transclude
only a certain range of source files (Example 1 below).
+You can combine =:lines= with =:src= to transclude only a certain range of
source files (Example 1 below).
For Org's file links, you can use
[[https://orgmode.org/manual/Search-Options.html][search options]] specified by
the "::" (two colons) notation. When a search finds a line that includes the
string, the Org-transclude counts it as the starting line 1 for the =:lines=
property.
@@ -404,7 +404,10 @@ Example 2: This transcludes only the single line that
contains the line found by
#+transclude: [[file:../../test/test.txt::Transcendental Ontology]] :lines 1-1
#+end_example
-Note search-options =::/regex/= and =::number= do not work as intended.
+#+ATTR_TEXINFO: :tag Note
+#+begin_quote
+Search-options =::/regex/= and =::number= do not work as intended.
+#+end_quote
*** =:end= property to specify a search term to dynamically look for the end
of a range
@@ -412,9 +415,9 @@ Note search-options =::/regex/= and =::number= do not work
as intended.
You can add =:end= property and specify the search term as its value. Surround
the search term with double quotation marks (mandatory).
-See Example 3 below. This transclusion will look for =id-1234= as the
beginning line of the range as specified by the search option =::id-1234= in
the link. With the =:end= property, the search term =id-1234 end here= defines
the end of the range. The search looks for =id-123 end here= in the body text,
and use the line one before the one where the text is find (thus, the
transcluded range will not contain =id-1234 end here=).
+See Example 3 below. This transclusion will look for =id-1234= as the
beginning line of the range as specified by the search option =::id-1234= in
the link. With the =:end= property, the search string =id-1234 end here=
defines the end of the range. The search looks for =id-123 end here= in the
body text. When found, the line one before the search string is used as the
ending line (thus, the transcluded range will not contain string =id-1234 end
here=).
-You can also combined =:lines= property with =:end= property. It will only
displace the beginning, and the end part of the range (the second number after
the hyphen "-") is ignored. In the same example, the beginning of the range is
the one line after the line where "id-1234" is found; it's the "second line, or
line 2". Instead of transcluding until the end of the buffer, the end is
defined by the =:end= property.
+You can also combine =:lines= with =:end=. It will only displace the
beginning, and the end part of the range (the second number after the hyphen
"-") is ignored. In the same example, the beginning of the range is the next
line after "id-1234" (line 2). Instead of transcluding all the text until the
end of the buffer, the end is defined by the =:end= property (one line before
the string =id-1234 end here= is found).
Example 3:
#+begin_example