Indexing Commands (Definition and Formatting)

Author(s): Jose F. Morales.

This module defines index commands and formatting.

Note: This part needs better documentation. -- JFMC

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc_index)).
Exports:
- Predicates:
  get_idxsub/2, get_idxbase/3, typeindex/5, idx_get_indices/3, is_index_cmd/1, codetype/1, normalize_index_cmd/3, fmt_idx_env/7, fmt_index/3.
Imports:
- Application modules:
  autodoc_state, autodoc_filesystem, autodoc_doctree, autodoc_structure, autodoc_refsdb.
- System library modules:
  dict, lists, aggregates.
- Internal (engine) modules:
  term_basic, arithmetic, atomic_basic, basic_props, basiccontrol, data_facts, exceptions, io_aux, io_basic, prolog_flags, streams_basic, system_info, term_compare, term_typing, hiord_rt, debugger_support.
- Packages:
  prelude, nonpure, condcomp, dcg, assertions, regtypes.

Documentation on exports

PREDICATE

get_idxsub/2:

No further documentation available for this predicate.

PREDICATE

get_idxbase/3:

No further documentation available for this predicate.

PREDICATE

typeindex/5:

Usage:typeindex(Type,Index,IType,Name,Comment)

Index is the (info) index name in which objects of type Type go. Name is the title of the index in the documentation. IType is the type of index; an empty string means normal. codeComment is a comment to include before the index.

The following properties should hold upon exit:
(atom/1)Type is currently instantiated to an atom.
(atm/1)Index 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