Texinfo backend

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

This module implements the output format backend for texinfo (see The GNU Texinfo Documentation System manual for more info). This backend is is used to generate both ps/pdf and info manuals.

In this backend the documentation for a module is a texinfo chapter, suitable for inclusion in a wrapper ``main'' document file.

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc_texinfo)).
Exports:
- Predicates:
  infodir_base/2.
- Multifiles:
  autodoc_escape_string_hook/5, autodoc_rw_command_hook/4, autodoc_is_operational_hook/2, autodoc_finish_hook/1, autodoc_gen_alternative_hook/2.

Documentation on exports

PREDICATEinfodir_base/2

No further documentation available for this predicate.

Documentation on multifiles

PREDICATEautodoc_escape_string_hook/5

No further documentation available for this predicate. The predicate is multifile.

PREDICATEautodoc_rw_command_hook/4

Usage:autodoc_rw_command_hook(Backend,DocSt,Command,NewCommand)

The following properties should hold at call time:
(backend_id/1)Backend is a supported backend.
(docstate/1)docstate(DocSt)
(doctree/1)Intermediate tree representation for documentation
(doctree/1)Intermediate tree representation for documentation

The predicate is multifile.

PREDICATEautodoc_is_operational_hook/2

No further documentation available for this predicate. The predicate is multifile.

PREDICATEautodoc_finish_hook/1

No further documentation available for this predicate. The predicate is multifile.

PREDICATEautodoc_gen_alternative_hook/2

No further documentation available for this predicate. The predicate is multifile.

Documentation on imports

This module has the following direct dependencies:

Application modules:
autodoc_state, autodoc_filesystem, autodoc_structure, autodoc_index, autodoc_doctree, autodoc_images, autodoc_settings, autodoc_aux, comments, autodoc_messages.
System library modules:
lists, terms, format, format_to_string, system, pathnames, glob, system_extra, stream_utils.
Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props.
Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, regtypes, fsyntax.