Indexing commands (definition and formatting)

Author(s): Jose F. Morales.

This module defines index commands and formatting.

Usage and interface

Documentation on exports

PREDICATEtypeindex/5

Usage:typeindex(IdxName,IndexId,IType,Name,Comment)

Define properties of the index IdxName. IndexId is the index ID for texinfo. IType is the type of index; an empty string means normal. Name is the title of the index in the documentation. Comment is a comment to include before the index.

  • The following properties should hold upon exit:
    (atom/1)IdxName is currently instantiated to an atom.
    (atm/1)IndexId is an atom.
    (string/1)IType is a string (a list of character codes).
    (string/1)Name is a string (a list of character codes).
    (doctree/1)Intermediate tree representation for documentation

No further documentation available for this predicate.

No further documentation available for this predicate.

PREDICATEcodetype/1
No further documentation available for this predicate.

No further documentation available for this predicate.

PREDICATEfmt_idx_env/7
No further documentation available for this predicate.

No further documentation available for this predicate.

PREDICATEfmt_index/3
No further documentation available for this predicate.

Documentation on imports

This module has the following direct dependencies: