High-level access is provided by doc_latex/3,
while more low level access is provided by the remaining predicates.
Generated LaTeX depends on the style file pldoc.sty, which
is a plain copy of pl.sty from the SWI-Prolog manual
sources. The installation installs
pldoc.sty in the pldoc subdirectory of the
Prolog manual.
- [det]doc_latex(+Spec,
+OutFile, +Options)
- Process one or more objects, writing the LaTeX output to
OutFile. Spec is one of:
- Name
/ Arity - Generate documentation for predicate
- Name
// Arity - Generate documentation for DCG rule
- File
- If File is a prolog file (as defined by
user:prolog_file_type/2), process using
latex_for_file/3, otherwise
process using
latex_for_wiki_file/3.
Typically Spec is either a list of filenames or a list of
predicate indicators. Defined options are:
- stand_alone(+Bool)
- If
true (default), create a document that can be run
through LaTeX. If false, produce a document to be included
in another LaTeX document.
- public_only(+Bool)
- If
true (default), only emit documentation for exported
predicates.
- section_level(+Level)
- Outermost section level produced. Level is the name of a
LaTeX section command. Default is
section.
- summary(+File)
- Write summary declarations to the named File.
- modules(+List)
- If [[Name/Arity]] needs to be resolved, search for the predicates in the
given modules.
- module(+Module)
- Same as
modules([Module]).
- [det]latex_for_file(+File,
+Out, +Options)
- Generate a LaTeX description of all commented predicates in
File, writing the LaTeX text to the stream Out.
Supports the options
stand_alone, public_only
and section_level. See doc_latex/3
for a description of the options.
- [det]latex_for_wiki_file(+File,
+Out, +Options)
- Write a LaTeX translation of a Wiki file to the steam Out.
Supports the options
stand_alone, public_only
and
section_level. See doc_latex/3
for a description of the options.
- [det]latex_for_predicates(+PI:list,
+Out, +Options)
- Generate LaTeX for a list of predicate indicators. This does
not produce the
\begin{description}...\end{description}
environment, just a plain list of \predicate, etc.
statements. The current implementation ignores Options.
