summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-02-15 00:55:44 +0000
committerKarl Berry <karl@freefriends.org>2009-02-15 00:55:44 +0000
commit35dfe7a6a088eb623a6f1a840fa573c4086a5c14 (patch)
tree19d40889ec8db713e67e1c66d604aa6d2297a72e /Master/texmf-dist/doc/latex
parent5bdca602c5c123a0b10fe2501cb34dad9e02fef6 (diff)
(belated?) amsmidx update, 14feb09
git-svn-id: svn://tug.org/texlive/trunk@12163 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/amscls/amsmidx.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/amscls/amsmidx.txt b/Master/texmf-dist/doc/latex/amscls/amsmidx.txt
new file mode 100644
index 00000000000..307c24ec39f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/amscls/amsmidx.txt
@@ -0,0 +1,45 @@
+Instructions for using amsmidx.sty
+
+Put these commands in the preamble:
+
+ \usepackage{amsmidx}
+ \makeindex{<filename>}
+
+for example:
+
+ \makeindex{subject}
+ \makeindex{author}
+
+You may include as many indexes as you need using whatever file names
+make sense. Each \makeindex command will initiate the creation of a
+<filename>.idx file.
+
+To identify the index entries in the text:
+
+ \index{<filename>}{index term}
+
+This will populate the .idx files. Do not leave a space between the
+\index entry and the text being indexed; that leaves unsightly spaces
+in the output, and may also cause the page number for the index entry
+to be different from the page where the term actually appears.
+
+In the backmatter, insert \Printindex commands to print the indexes;
+the second argument gives the title to be printed at the top of the
+index:
+
+ \Printindex{<filename>}{First Index}
+ \Printindex{<filename>}{Second Index}
+
+When the file is processed, files of index terms, <filename>.idx,
+will be generated. To sort the index terms, process the .idx files
+separately with Makeindex; this will create <filename>.ind files,
+which will in turn be input by \Printindex the next time the .tex file
+is processed.
+
+To include a paragraph of comments below the index title, insert the
+text as an \indexcomment before the relevant \Printindex:
+
+ \indexcomment{Text of comments}
+ \Printindex{<filename>}{...}
+
+The \indexcomment text will be cleared after use.