next up previous index
Next: Some Other Guidelines Up: Writing Documentation Previous: Writing Email Addresses in   Index

Indexing

Terms should be indexed as documentation is written. Use \index{ ... } and related commands to accomplish this. There should be a space on either side of the index command, and the command should not be placed anywhere a space should not exist (such as between a word and a subsequent period or comma).

In order to encourage consistency and ease sweeping changes of indexed terms, there are macros defined in the indexcommands.tex file. These macros for commonly used--or complex--index terms should be taken advantage of whenever possible rather than manually using the \index{ ... } command. Care should be taken that any new macros added to the file maintain the existing alphabetic ordering to facilitate a manual look-up of index commands.


next up previous index
Next: Some Other Guidelines Up: Writing Documentation Previous: Writing Email Addresses in   Index
info (at) urbansim.org