Idxtools uses a number of configuration files to specify default behavior of the various tools. There are three configuration files which are used (see Table 2-1 for the files and their typical locations).
Table 2-1. Configuration file locations
| Configuration file | UNIX systems | Microsoft Windows systems |
|---|---|---|
| System wide | /usr/local/etc/idxtools/defaults.scm | c:\Program Files\idxtools-0.0.3\etc\defaults.scm |
| Per user | $HOME/.idxtools.scm | ??? |
| Per project | ./idxtools.scm | idxtools.scm (in current folder) |
The configuration files use Guile a variation of the programming language Scheme. See Appendix B for a quick introduction to Guile.
Specifies whether entries should be sorted in letter by letter (#t) or word by word order (#f).
The function called to generate the keys from a heading. Unless you've written your own key generator set this to standard-generate-key.
Specifies whether entries with the same key should be merged (#t) or kept separate (#f).
Specifies whether cross references with the same key should merged (#t) or kept separate (#f).
Specifies whether overlapping page ranges should be merged into a single page range (#t) or kept separate (#f).
Specifies whether the sort keys should be displayed after the headings (#t) or hidden (#f).
Table 2-2. Idxsorter option defaults
| Option | Default value |
|---|---|
| letter-by-letter | #f |
| generate-key | standard-generate-key |
| allow-entry-merging | #t |
| allow-crossref-merging | #t |
| allow-pageref-merging | #t |
| show-keys | #f |