Database of Documentation References
Author(s): Jose F. Morales.
This module stores and manages all the documentation references (indices, sections, bibliography, etc.). It includes the generation of the table of contents.
Usage and interface
- Library usage:
:- use_module(lpdoc(autodoc_refsdb)). - Exports:
- Predicates:
compute_refs_and_biblio/1, prepare_current_refs/1, clean_current_refs/1, get_nav/4, secttree_resolve/3. - Regular Types:
secttree/1.
- Predicates:
- Imports:
- Application modules:
autodoc_state, autodoc_doctree, autodoc_structure, autodoc_filesystem, autodoc_bibrefs. - System library modules:
aggregates, lists. - 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.
- Application modules:
Documentation on exports
PREDICATE
Usage:
Prepare references for the translation of the current file.
- Call and exit should be compatible with:
(docstate/1)docstate(Arg1)
PREDICATE
Usage:
Clean the data stored by prepare_current_refs/1.
- Call and exit should be compatible with:
(docstate/1)docstate(Arg1)
PREDICATE
Usage:
Obtain some navigation links and the tree for the current section from a global tree
- Call and exit should be compatible with:
(secttree/1)A tree of sections
(atm/1)Arg2 is an atom.
(term/1)Arg3 is any term.
(secttree/1)A tree of sections
PREDICATE
Usage:secttree_resolve(LabelName,Tree,Link)
Locate in the section tree Tree the section with label name LabelName and return the Link to the section.
