summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/printind.helpmark
diff options
context:
space:
mode:
Diffstat (limited to 'macros/text1/cms_help_files/printind.helpmark')
-rw-r--r--macros/text1/cms_help_files/printind.helpmark58
1 files changed, 58 insertions, 0 deletions
diff --git a/macros/text1/cms_help_files/printind.helpmark b/macros/text1/cms_help_files/printind.helpmark
new file mode 100644
index 0000000000..3f796827af
--- /dev/null
+++ b/macros/text1/cms_help_files/printind.helpmark
@@ -0,0 +1,58 @@
++-----------------------------------------------------------------------------+
+| printindex |
++-----------------------------------------------------------------------------+
+
+Abbreviation: ã|noneã%
+
+Parameters: ã|index numberã%
+
+ ã|Description:ã%
+The \printindex markup sorts and prints the index entries generated with the
+\index markup. The \printindex markup would usually come at the end of a
+document before the table of contents. This markup has the format
+
+\printindexN
+
+where N is the index number: 1, 2 or 3. By default, the index is
+printed using the indent style of index in ten point Computer Modern. It
+is recommended that you print the index in two columns (\twocolumns). For
+a complete list of the defaults and how to modify them, refer to the
+\indexformat markup.
+
+ ã|Example:ã%
+The following illustrates how to place an index at the end of a document,
+after the last appendix, and before the table of contents. Assume the table
+of contents is to begin on page "iv".
+
+\appendix{Sample Data}
+
+\preface{Index}
+\twocolumns
+\printindex1
+\onecolumns
+\tableofcontents{-4}
+
+Using the \preface markup will start a new page with the title
+"Index" at the top of the page. Then \twocolumns will begin two column
+formatting (typical for indexes). Next \printindex1 will sort index "1" and
+print the sorted index according to the defaults set by the \indexformat
+markup. After printing the last of the index, \onecolumn will switch back
+to single column mode before printing the table of contents.
+
+ ã|Example:ã%
+Sometimes multiple indexes are required. If you had used \index1 and
+\index2, then you would use \printindex1 and \printindex2 to print them out:
+
+\index1item in first index
+\index2item in second index
+\preface{Index One}
+\twocolumns
+\printindex1
+\onecolumns
+\preface{Index Two}
+\twocolumns
+\printindex2
+\onecolumns
+
+ ã|Notes:ã%
+none.