Merge branch 'HEAD' of dwarfgit@dwarfstd.org:dwarf-doc.git
[dwarf-doc.git] / dwarf5 / READMEindexing
index d809894..4870832 100644 (file)
@@ -17,6 +17,7 @@ Of course the command also indexes the link.
 The actual command definitions in dwarf5.tex are:
 \newcommand{\addtoindex}[1]{#1\index{#1}}
 \newcommand{\addtoindexi}[2]{#1\index{#2}}
+\newcommand{\addtoindexx}[1]{\index{#1}}
 \newcommand{\noindex}[1]{#1}
 
 Where a word or phrase is to be indexed.
@@ -59,6 +60,10 @@ a math character.
 \addtoindexi{address selection}{address selection|see{base address selection}}
 
 
+Use \textgreater  and \textless to represent < and >
+in indexes (and other contexts).  For example
+       \textless caf\textgreater   results in <caf>
+oddly enough.
 
 
 ---Linking
@@ -75,12 +80,34 @@ a definition of the term.  The intent is that clicking
 on the word or phrase in the document switches you to
 a display of the definition.
 
+--- Linking of attributes
 Attributes in DWARF may have multiple definition points, so
 for example DW_AT_abstract_origin links one to the attribute table
 and that in turn links to the 3 distinct definitions.
 Other than Attributes though, links are usually directly
 to the definition.
 
+It is critical that the hypertarget and livelink be
+separated to avoid problems with latex. Example:
+
+out\dash of\dash line instance 
+\hypertarget{chap:DWATabstractoriginoutoflineinstance}
+makes use of
+\livelink{chap:DWATabstractorigin}{DW\-\_AT\-\_abstract\-\_origin}
+
+If the 'makes use of' or some other text is not between
+the hypertarget and hyperlink latex produces output text of
+chap:DWATabstractorigin instead of thinking of it as a link.
+
+It's also useful to put the hypertarget before the livelink
+for the attribute use in the sentence because then when your
+reader takes you to the hypertarget (via a mouse click) 
+you will see the attribute instance (assumuing
+your  viewer puts the 'target' location at the top of
+the viewing area).
+
+--- Linking (continued)
+
 The first argument in a livelink/livetarg/livetargi command
 is a string that must be unique to the target, it is used
 by latex to tie each link to its single target location.