Added READMEindexing document to explain indexing.
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
index 2722213..28b9994 100644 (file)
@@ -38,11 +38,12 @@ escapeinside={\%*}{*)}  % if you want to add a comment within your code
 \usepackage{eepic} % For the diagram of section relationships
 \usepackage{makeidx}
 % hyperref must be the last package listed.
-% hypertextnames=false helps hypertext get right links.
-\usepackage[hypertexnames=false]{hyperref}  % Lets us generate colored active links inside a pdf.
+% The hyperref settings helps hypertext get right links in the 
+% pdf of the index.
+\usepackage[plainpages=false,pdfpagelabels,pagebackref]{hyperref}  % Lets us generate colored active links inside a pdf.
 \makeindex  % This and the makeidx package allow \index to create index entries.
 
-\newcommand{\docdate}{13 May 2012}
+\newcommand{\docdate}{29 May 2012}
 
 \newcommand{\dwf}{DWARF Debugging Information Format}
 \newenvironment{myindentpara}[1]%
@@ -65,14 +66,29 @@ escapeinside={\%*}{*)}  % if you want to add a comment within your code
 % use like   \refersec{chap:registerbasedaddressing}
 \newcommand{\refersec}[1]{ \ref{#1} Page \pageref{#1} }
 
-%Generate a live link into the doc
-% use like \livelink{DW\_OP\_dup}{chap:DWOPdup}
-\newcommand{\livelink}[2]{ \hyperref[#2]{#1} }
+% Generate a live link in the document
+% use like \livelink{chap:DWOPdup}{DW\-\_OP\-\_dup}
+\newcommand{\livelink}[2]{\hyperlink{#1}{#2}\index{#2} }
+% livetarg is the declaration this is the target of livelinks.
+% FIXME: we might want livetarg and livetargi  #2 to be \textbf{#2}
+\newcommand{\livetarg}[2]{\hypertarget{#1}{#2}\index{#2}}
+% When we want the index entry to look different from the name.
+\newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
 
 \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}