aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2008-09-15 21:52:19 -0400
committerRalph Amissah <ralph@amissah.com>2008-09-15 21:52:19 -0400
commit87a7cfcd56eed6746b1500c88df3fc3e76a81668 (patch)
tree9e653d09f0e8c130273ef5ef3e7be0daf12d6007 /man/man1
parentdal_idx, and concordance, letter list for navigation (diff)
various small fixes
* html segments, name more accurately * rough description of how book index markup works * clean out book index from these outputs * book markup sample, free as in freedom, start doing book index, only letter "A" done so far * texpdf, url matching, special characters * # Please enter the commit message for your changes.
Diffstat (limited to 'man/man1')
-rw-r--r--man/man1/sisu.181
1 files changed, 81 insertions, 0 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index fe745b87..e8d68e2d 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -2213,6 +2213,87 @@ some \ later \ time]
.fi
.SH
+9.7 BOOK INDEX
+
+.BR
+To make an index append to paragraph the book index term relates to it, using
+an equal sign and curly braces.
+
+.BR
+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.
+
+
+.nf
+ Paragraph containing main term and sub\-term.
+.BR
+ ={Main term:sub\-term}
+.fi
+
+.BR
+The index syntax starts on a new line, but there should not be an empty line
+between paragraph and index markup.
+
+.BR
+The structure of the resulting index would be:
+
+
+.nf
+ Main term, 1
+.BR
+ sub\-term, 1
+.fi
+
+.BR
+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.
+
+
+.nf
+ Paragraph containing main term, second term and sub\-term.
+.BR
+ ={first term; second term: sub\-term}
+.fi
+
+.BR
+The structure of the resulting index would be:
+
+
+.nf
+ First term, 1,
+.BR
+ Second term, 1,
+.BR
+ sub\-term, 1
+.fi
+
+.BR
+If multiple sub\-terms appear under one paragraph, they are separated under the
+main term heading from each other by a pipe symbol.
+
+
+.nf
+ Paragraph containing main term, second term and sub\-term.
+.BR
+ ={Main term:sub\-term+1|second sub\-term
+.BR
+ A paragraph that continues discussion of the first sub\-term
+.fi
+
+.BR
+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:
+
+
+.nf
+ Main term, 1,
+.BR
+ sub\-term, 1\-3,
+.BR
+ second sub\-term, 1,
+.fi
+
+.SH
10. COMPOSITE DOCUMENTS MARKUP
.BR