[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-transclusion 9e7580b2f4 5/5: docs: minor change & G
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/org-transclusion 9e7580b2f4 5/5: docs: minor change & GitHub Page (still used for now) |
|
Date: |
Wed, 29 Dec 2021 06:02:06 -0500 (EST) |
branch: externals/org-transclusion
commit 9e7580b2f4f1342c80e2a82c7c72d11322ce91cc
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
docs: minor change & GitHub Page (still used for now)
---
docs/index.html | 17 ++++++++++-------
docs/org-transclusion-manual.org | 2 +-
2 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/docs/index.html b/docs/index.html
index b8848a6ec3..ff27e377bf 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -311,7 +311,7 @@ Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>,
Previous: <a href="#I
</p>
<p>Alternatively, you can also put cursor somewhere on the link and type
‘<samp>M-x org-transclusion-make-from-link RET</samp>’. That will
insert another line with ‘<samp>#+transclusion:</samp>’ keyword
added in front of a copy of the original link in the next empty line.
</p>
-<p>The transcluded paragraphs will be visually marked with “| ” in
the fringe (on graphical display) or in the beginning of line (on a text-only
terminal) by default. The source (original) of the transcluded paragraphs will
be also visually marked with an overlay. The appearance of these visual
elements can be customized (refer to section <a
href="#Faces-_0026-fringe-bitmap">Faces & fringe bitmap</a>).
+<p>The transcluded paragraphs will be visually marked with a vertical line
“| ” in the fringe (on graphical display) or in the beginning of
line (on a text-only terminal) by default. The source (original) of the
transcluded paragraphs will be also visually marked with an overlay. The
appearance of these visual elements can be customized (refer to section <a
href="#Faces-_0026-fringe-bitmap">Faces & fringe bitmap</a>).
</p>
<p>The transcluded text is <strong>read-only</strong> but you can copy it and
export it as normal text. Org-transclusion remembers where it has transcluded
the text from (its source buffer).
</p>
@@ -460,7 +460,7 @@ Next: <a href="#Filter-Org-elements-per-transclusion"
accesskey="n" rel="next">F
<pre class="example">#+transclude: [[file:path/to/file.org::*Headline]] :level
2
</pre></div>
-<p>The top level of the transcluded headline will set to the value of
‘<samp>:level</samp>’ 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.
+<p>The top level of the transcluded headline will be set to the value of
‘<samp>:level</samp>’ 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.
</p>
<p>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 ‘<samp>:level</samp>’ property; the rest of headlines in the
buffer will align accordingly.
</p>
@@ -681,9 +681,9 @@ Next: <a
href="#end-property-to-specify-a-search-term-to-dynamically-look-for-th
</p>
<p>To transclude a single line, have the the same number in both places (e.g.
10-10, meaning line 10 only).
</p>
-<p>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.
+<p>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.
</p>
-<p>You can combine the ‘<samp>:lines</samp>’ property with the
‘<samp>:src</samp>’ property to transclude only a certain range of
source files (Example 1 below).
+<p>You can combine ‘<samp>:lines</samp>’ with
‘<samp>:src</samp>’ to transclude only a certain range of source
files (Example 1 below).
</p>
<p>For Org’s file links, you can use <a
href="https://orgmode.org/manual/Search-Options.html";>search options</a>
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 ‘<samp>:lines</samp>’ property.
</p>
@@ -697,8 +697,11 @@ Next: <a
href="#end-property-to-specify-a-search-term-to-dynamically-look-for-th
<pre class="example">#+transclude: [[file:../../test/test.txt::Transcendental
Ontology]] :lines 1-1
</pre></div>
-<p>Note search-options ‘<samp>::/regex/</samp>’ and
‘<samp>::number</samp>’ do not work as intended.
+<blockquote>
+<p><b>Note:</b> Search-options ‘<samp>::/regex/</samp>’ and
‘<samp>::number</samp>’ do not work as intended.
</p>
+</blockquote>
+
<hr>
<span
id="end-property-to-specify-a-search-term-to-dynamically-look-for-the-end-of-a-range"></span><div
class="header">
<p>
@@ -710,9 +713,9 @@ Previous: <a
href="#lines-property-to-specify-a-range-of-lines" accesskey="p" re
<p>You can add ‘<samp>:end</samp>’ property and specify the search
term as its value. Surround the search term with double quotation marks
(mandatory).
</p>
-<p>See Example 3 below. This transclusion will look for
‘<samp>id-1234</samp>’ as the beginning line of the range as
specified by the search option ‘<samp>::id-1234</samp>’ in the
link. With the ‘<samp>:end</samp>’ property, the search term
‘<samp>id-1234 end here</samp>’ defines the end of the range. The
search looks for ‘<samp>id-123 end here</samp>’ in the body text,
and use the line one before the one where the text is find [...]
+<p>See Example 3 below. This transclusion will look for
‘<samp>id-1234</samp>’ as the beginning line of the range as
specified by the search option ‘<samp>::id-1234</samp>’ in the
link. With the ‘<samp>:end</samp>’ property, the search string
‘<samp>id-1234 end here</samp>’ defines the end of the range. The
search looks for ‘<samp>id-123 end here</samp>’ in the body text.
When found, the line one before the search string is used [...]
</p>
-<p>You can also combined ‘<samp>:lines</samp>’ property with
‘<samp>:end</samp>’ 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 [...]
+<p>You can also combine ‘<samp>:lines</samp>’ with
‘<samp>:end</samp>’. 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 ‘<samp>:end</samp>’
property (one line before the strin [...]
</p>
<p>Example 3:
</p><div class="example">
diff --git a/docs/org-transclusion-manual.org b/docs/org-transclusion-manual.org
index adf2ce715a..ce6d3b77b9 100644
--- a/docs/org-transclusion-manual.org
+++ b/docs/org-transclusion-manual.org
@@ -92,7 +92,7 @@ Put your cursor somewhere on this keyword line and type =M-x
org-transclusion-ad
Alternatively, you can also put cursor somewhere on the link and type =M-x
org-transclusion-make-from-link RET=. That will insert another line with
=#+transclusion:= keyword added in front of a copy of the original link in the
next empty line.
-The transcluded paragraphs will be visually marked with "| " in the fringe (on
graphical display) or in the beginning of line (on a text-only terminal) by
default. The source (original) of the transcluded paragraphs will be also
visually marked with an overlay. The appearance of these visual elements can be
customized (refer to section [[#faces][Faces & fringe bitmap]]).
+The transcluded paragraphs will be visually marked with a vertical line "| "
in the fringe (on graphical display) or in the beginning of line (on a
text-only terminal) by default. The source (original) of the transcluded
paragraphs will be also visually marked with an overlay. The appearance of
these visual elements can be customized (refer to section [[#faces][Faces &
fringe bitmap]]).
The transcluded text is *read-only* but you can copy it and export it as
normal text. Org-transclusion remembers where it has transcluded the text from
(its source buffer).