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

Documentation on exports

No further documentation available for this predicate.

Usage:

Prepare references for the translation of the current file.

Usage:

Clean the data stored by prepare_current_refs/1.

PREDICATEpretty_cite/3

Usage:pretty_cite(Ref,DocSt,Text)

Obtain citation text Text for Ref using the default bibliography style

    REGTYPEsecttree/1

    Usage:

    A tree of sections

      PREDICATEget_nav/4

      Usage:

      Obtain some navigation links and the tree for the current section from a global tree

      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.

      • Call and exit should be compatible with:
        (string/1)LabelName is a string (a list of character codes).
        (doctree/1)Intermediate tree representation for documentation
        (doclink/1)A link to a document label

      Documentation on imports

      This module has the following direct dependencies: