Added READMEindexing document to explain indexing.
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
index f17cf38..28b9994 100644 (file)
@@ -77,8 +77,18 @@ escapeinside={\%*}{*)}  % if you want to add a comment within your code
 
 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
 
-%Fors simple index entries, this saves typing.
+% The following two let us mark a word as 'do not link' or
+% 'do not index' to indicate the word is used generically
+% and has been considered so do not index or link it.
+% There is no sigificant difference in the two commands, though
+% \nolink would be more oriented to words such as flag or address
+% that might be linked (and indexed) in some circumstances.
+\newcommand{\nolink}[1]{#1}
+\newcommand{\noindex}[1]{#1}
+
+%For index entries.
 \newcommand{\addtoindex}[1]{#1\index{#1}}
+\newcommand{\addtoindexi}[2]{#1\index{#2}}
 
 
 \begin{document}