There are various approaches for adding indexes, but here's a typical way to add index entries.
prolog | metadata | keywordselement of a topic, add index terms The
prologelement comes just after the
shortdescelement (which follows the title). Here's a sample:
When you want to create a "see" entry for an index, code it like this:
The result of the index-see element is the following:
If you want to include a page number with the see also reference, write it like this:
The output will look like this:
Keep in mind that index entries added to the
prolog section will include page
numbers pointing to the location of the
prolog. Since most topics are short,
this isn't a problem. Also, since the online help is usually the main deliverable, it's also
not a problem. However, you can also add index entries in the middle of your topics. (But
apparently this causes some problems, especially with translation.)
Also, some PDF renderers don't include page numbers to index entries. At any rate, since PDF isn't usually the main deliverable, this is not a concern with index terms.
I'd Rather Be Writing Newsletter
Get new posts delivered straight to your inbox.