aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst')
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst68
1 files changed, 66 insertions, 2 deletions
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
index 32659adf..09a8f427 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
@@ -39,7 +39,7 @@
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
-% @prefix:
+% @prefix:
:A~? @title @creator
@@ -1057,6 +1057,70 @@ code{
}code
+2~ Book index
+
+To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces.
+
+Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon.
+
+code{
+
+ Paragraph containing main term and sub-term.
+ ={Main term:sub-term}
+
+}code
+
+The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup.
+
+The structure of the resulting index would be:
+
+code{
+
+ Main term, 1
+ sub-term, 1
+
+}code
+
+Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs.
+
+code{
+
+ Paragraph containing main term, second term and sub-term.
+ ={first term; second term: sub-term}
+
+}code
+
+The structure of the resulting index would be:
+
+code{
+
+ First term, 1,
+ Second term, 1,
+ sub-term, 1
+
+}code
+
+If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol.
+
+code{
+
+ Paragraph containing main term, second term and sub-term.
+ ={Main term:sub-term+1|second sub-term
+
+ A paragraph that continues discussion of the first sub-term
+
+}code
+
+The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be:
+
+code{
+
+ Main term, 1,
+ sub-term, 1-3,
+ second sub-term, 1,
+
+}code
+
1~ Composite documents markup
It is possible to build a document by creating a master document that requires other documents. The documents required may be complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built from other documents), it should be named with the suffix *{.ssm}* Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}*
@@ -1143,7 +1207,7 @@ and
code{
-~[* my note ]~ or ~[+ another note ]~
+~[* my note ]~ or ~[+ another note ]~
}code