Node:chap 4, Next:, Previous:chap 3, Up:Top



Index and cross reference

There are different kind of insertions for making indexes and cross references, that reproduce equivalent Texinfo commands.

Indexes

Index entries are inserted with a group of empty elements: cindex, findex, vindex, kindex, pindex, tindex and userindex. All these elements have the same attribute, entry, that define the item text to be inserted. The userindex has an additional attribute, to define the user index name (that should be made of two letters).

These elements are a kind of block that may be inserted just after any sectioning title, like this:

     <h1>IP protocol history</h1>
     <cindex entry="IP protocol">
     <cindex entry="history">
     
     <p>Bla bla bla...</p>
     

The following table resumes the meaning for so many different index entry elements.

Element Attribute Content Description or Texinfo equivalence
cindex entry empty concept index item
findex entry empty function index item
vindex entry empty variable index item
kindex entry empty keystroke index item
pindex entry empty program index item
tindex entry empty data type index item
userindex entry empty user defined index item
name user defined index name (two letters)
printindex name print the named index (two letters)

The index is inserted with the element printindex, already described. Standard index names are listed in the following table.

Index name Description
cp concept index.
ky keystroke index.
pg program index.
fn function index.
vr variable index.
tp data type index.

Cross references

Cross reference elements are all in-line empty elements. All information is given via attributes. As all cross reference elements are implementations of equivalent Texinfo commands, there is only the following table as description. Every attribute description follow its own element. Please note that not all attributes are necessary.

Element Attribute Content Description or Texinfo equivalence
anchor empty @anchor
id anchor identity string
xref empty @xref
id node or anchor name
name cross reference name
title title or topic
info info file name
ptitle printed manual title
ref empty @ref
id node or anchor name
name cross reference name
title title or topic
info info file name
ptitle printed manual title
pxref empty @pxref
id node or anchor name
name cross reference name
title title or topic
info info file name
ptitle printed manual title
inforef empty @inforef
id node or anchor name
name cross reference name
info info file name
uref empty @uref
uri URI address
name title or description
replace replacement text
email empty @email
email electronic mail address
name title or description

Use like this:

     <p>Sgmltexi creates automatically the Top node menu. As already
     explained before (<pxref id="top node menu">), the menu can be
     ...