Updated documentation
This commit is contained in:
@@ -13,12 +13,12 @@ This is done through a series of keyword-replace steps.
|
|||||||
|
|
||||||
The keyword ``%title%`` will always be replaced by the text you put after the ``#`` characters in your document.
|
The keyword ``%title%`` will always be replaced by the text you put after the ``#`` characters in your document.
|
||||||
|
|
||||||
The keywords ``%chnum%`` and ``%chnumword%`` is replaced by a number, or a number word, respectively.
|
The keywords ``%ch%`` and ``%chword%`` is replaced by a number, or a number word, respectively.
|
||||||
The number is incremented by one each time the build tool sees a new heading of level two in a file with layout "Chapter".
|
The number is incremented by one each time the build tool sees a new heading of level two in a file with layout "Chapter".
|
||||||
If the file has layout "Unnumbered", the counter is not incremented.
|
If the file has layout "Unnumbered", the counter is not incremented.
|
||||||
the latter is useful for for instance Prologue and Epilogue chapters.
|
the latter is useful for for instance Prologue and Epilogue chapters.
|
||||||
|
|
||||||
Likewise, the keywords ``%scnum%`` and ``%scabsnum%`` are number counters for scene files.
|
Likewise, the keywords ``%sc1%`` and ``%sc2%`` are number counters for scene files.
|
||||||
These are incremented each time a heading of level three is encountered.
|
These are incremented each time a heading of level three is encountered.
|
||||||
The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered.
|
The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered.
|
||||||
|
|
||||||
|
|||||||
@@ -9,14 +9,14 @@
|
|||||||
<p>The available formatting keywords are:</p>
|
<p>The available formatting keywords are:</p>
|
||||||
<p><mark>%title%</mark> – This is replaced with the text you put in your headings in your
|
<p><mark>%title%</mark> – This is replaced with the text you put in your headings in your
|
||||||
documents</p>
|
documents</p>
|
||||||
<p><mark>%chnum%</mark> – This is replaced with the chapter number of your chapter type
|
<p><mark>%ch%</mark> – This is replaced with the chapter number of your chapter type
|
||||||
headings. These are generated automaticall starting from 1, but ignoring chapter headings in
|
headings. These are generated automaticall starting from 1, but ignoring chapter headings in
|
||||||
files with "Unnumbered" layout.</p>
|
files with "Unnumbered" layout.</p>
|
||||||
<p><mark>%chnumword%</mark> – This is replaced with the chapter number, but instead of an
|
<p><mark>%chword%</mark> – This is replaced with the chapter number, but instead of an
|
||||||
arabic number, the word for it is used, e.g. One, Two, Fifteen, Twenty-Five, etc.</p>
|
arabic number, the word for it is used, e.g. One, Two, Fifteen, Twenty-Five, etc.</p>
|
||||||
<p><mark>%scnum%</mark> – This is replaced with the scene number. The number is reset to one
|
<p><mark>%sc1%</mark> – This is replaced with the scene number. The number is reset to one
|
||||||
for each new chapter, so it is the scene number within the current chapter.</p>
|
for each new chapter, so it is the scene number within the current chapter.</p>
|
||||||
<p><mark>%scabsnum%</mark> – This is replaced with the absolute scene number. That is, the
|
<p><mark>%sc2%</mark> – This is replaced with the absolute scene number. That is, the
|
||||||
number is counted from the first scene in the novel, and not reset for each chapter.</p>
|
number is counted from the first scene in the novel, and not reset for each chapter.</p>
|
||||||
<p><mark>\\</mark> – Two backslashes are replaced by a line break.</p>
|
<p><mark>\\</mark> – Two backslashes are replaced by a line break.</p>
|
||||||
<p><b>Note:</b> The Scene and Section formats are treated slightly differently than the other title
|
<p><b>Note:</b> The Scene and Section formats are treated slightly differently than the other title
|
||||||
|
|||||||
Reference in New Issue
Block a user