diff options
author | Karl Berry <karl@freefriends.org> | 2009-05-23 00:23:51 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-05-23 00:23:51 +0000 |
commit | a683c3d7e9fac38ec713f23fb6b9d2c7143aea82 (patch) | |
tree | 424ab223921f85fd3f167a4ccd0e2d37d05c2927 /Master/texmf-dist/doc/latex/tlc2/indexexa.ltx | |
parent | 5beb5368a684995153c8566797ba054f21c666af (diff) |
move english latex doc out of texmf-doc
git-svn-id: svn://tug.org/texlive/trunk@13412 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tlc2/indexexa.ltx')
-rw-r--r-- | Master/texmf-dist/doc/latex/tlc2/indexexa.ltx | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tlc2/indexexa.ltx b/Master/texmf-dist/doc/latex/tlc2/indexexa.ltx new file mode 100644 index 00000000000..61823aa406b --- /dev/null +++ b/Master/texmf-dist/doc/latex/tlc2/indexexa.ltx @@ -0,0 +1,42 @@ +\documentclass{article} +\setlength\textwidth{260pt} +\setlength\marginparwidth{90pt} +\usepackage{makeidx,showidx} +\newcommand\bs{\symbol{'134}}% print backslash +\newcommand\Com[1]{\texttt{\bs#1}% + \index{#1@\texttt{\bs#1}}} +\newcommand\Prog[1]{\texttt{#1}% + \index{#1@\texttt{#1} program}} +\makeindex +\begin{document} +\section{Generating an Index} +Using the \textsf{showidx} package users can +see where they define index entries. +\par Entries are entered into the index by the +\Com{index} command. More precisely, the argument +of the \Com{index} command is written literally into +the auxiliary file \texttt{idx}. Note, however, that +information is actually written into that file only +when the \Com{makeindex} command was given in the +document preamble. + +\section{Preparing the Index} +To prepare the index for printing, the +\texttt{idx} file has to be transformed by an external +program, such as \Prog{makeindex}. +This program writes the \texttt{ind} file. +\begin{verbatim} +makeindex filename +\end{verbatim} + +\section{Printing the Index} + +During the final production run of a document the +index can be included by putting a \Com{printindex} +command at the position in the text where you want +the index to appear (normally at the end). +This command will input the \texttt{ind} file +prepared by the index processor and \LaTeX{} will +typeset the information. +\printindex +\end{document} |