ON THIS PAGE
Current documentation settings
Author(s): Jose F. Morales.
This module defines the predicates to load and access documentation configurations (modules implementing doccfg).
Usage and interface
- Library usage:
:- use_module(lpdoc(autodoc_settings)). - Exports:
- Predicates:
autodoc_option/1, settings_file/1, clean_autodoc_settings/0, load_settings/3, verify_settings/0, setting_value_or_default/2, setting_value/2, all_setting_values/2, load_vpaths/1, custom_html_layout/0, bibtex/1, tex/1, texindex/1, awk/1, dvips/1, ps2pdf/1, makeinfo/1, convertc/1. - Multifiles:
file_search_path/2.
- Predicates:
Documentation on exports
PREDICATEautodoc_option/1
No further documentation available for this predicate.
The predicate is of type data.
PREDICATEsettings_file/1
No further documentation available for this predicate.
The predicate is of type data.
PREDICATEclean_autodoc_settings/0
No further documentation available for this predicate.
PREDICATEload_settings/3
Usage:load_settings(InFile,InKind,Opts)
Set configuration from InFile of kind InKind and Opts
PREDICATEverify_settings/0
No further documentation available for this predicate.
PREDICATEsetting_value_or_default/2
Usage:setting_value_or_default(Var,Value)
Returns in Value the value of the variable Var. In case this variable does not exist, it returns a default value. If there is no default value for the variable Var it fails.
PREDICATEsetting_value/2
No further documentation available for this predicate.
PREDICATEall_setting_values/2
No further documentation available for this predicate.
PREDICATEload_vpaths/1
No further documentation available for this predicate.
PREDICATEcustom_html_layout/0
No further documentation available for this predicate.
PREDICATEbibtex/1
No further documentation available for this predicate.
PREDICATEtex/1
No further documentation available for this predicate.
PREDICATEtexindex/1
No further documentation available for this predicate.
PREDICATEawk/1
No further documentation available for this predicate.
PREDICATEdvips/1
No further documentation available for this predicate.
PREDICATEps2pdf/1
No further documentation available for this predicate.
PREDICATEmakeinfo/1
No further documentation available for this predicate.
PREDICATEconvertc/1
No further documentation available for this predicate.
Documentation on multifiles
PREDICATEfile_search_path/2
No further documentation available for this predicate.
The predicate is multifile.
The predicate is of type dynamic.
The predicate is of type dynamic.
Documentation on imports
This module has the following direct dependencies:- Application modules:
autodoc_messages, doccfg_holder, autodoc_filesystem. - System library modules:
datafacts_rt, pathnames, aggregates, lists, system, bundle_paths. - 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, datafacts.