Resolution of bibliographical references

Author(s): Manuel Hermenegildo (original version), Jose F. Morales.

This module provides a predicate to resolve the bibliographical references found during the generation of documentation.

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc_bibrefs)).
Exports:
- Predicates:
  resolve_bibliography/1, parse_commands/3.

Documentation on exports

PREDICATEresolve_bibliography/1

Usage:resolve_bibliography(DocSt)

This predicate resolves bibliographical references. The algorithm is as follows:

Write all the bibliographical references to a .aux file.
Invoke BibTeX with a customized .bst file that generates a pseudo-docstring.
Load the docstring and fix its syntax.
Parse the docstring as a doctree.
Extract (Label,Ref) pairs from bibitem commands.

Both the docstring and label/reference pairs are kept in the DocSt, and used later to map symbolic references to textual labels.

The following properties should hold at call time:
(docstate/1)docstate(DocSt)

PREDICATEparse_commands/3

No further documentation available for this predicate.

Documentation on imports

This module has the following direct dependencies:

Application modules:
autodoc_state, autodoc_doctree, autodoc_refsdb, autodoc_settings, autodoc_filesystem, autodoc_aux, autodoc_messages, autodoc_parse.
System library modules:
dict, aggregates, terms, stream_utils, lists, format, pathnames, system.
Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props, stream_basic.
Packages:
prelude, initial, condcomp, dcg, assertions, assertions/assertions_basic, regtypes, fsyntax.