evergreen-docs:adding_indexterms
This is an old revision of the document!
Table of Contents
Index features in the Evergreen Manual
Each manual has an index, based on the contents of the manual.
Here's an example from the Acquisitions manual: http://docs.evergreen-ils.org/reorg/3.1/acquisitions/_index.html
Adding terms to the index
Each entry in the index gets its own ASCIIDoc indexterm command, starting from the most general entry, and going to the most specific. Here's an example:
indexterm:[self check interface,audio alerts] indexterm:[self check interface,checking out]
This will produce two entries in the index:
self check interface
audio alerts
checking out
Documentation files that are missing indexterms
Re-generating this list
Run the following command in the main Evergreen directory.
grep -rL indexterm docs | grep /.*adoc | grep -Ev 'TechRef|RELEASE|root'
evergreen-docs/adding_indexterms.1525311697.txt.gz · Last modified: 2022/02/10 13:34 (external edit)