@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
90 lines • 32.8 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Documentation configuration options — The lpdoc Documentation Generator v3.5</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="lpdoc-logo-128_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="Writing.html">↑</a><a class="lpdoc-navbutton" href="Writing.html">←</a><a class="lpdoc-navbutton" href="doccfg_props.html">→</a><a class="lpdoc-navbutton" href="lpdoc_ref_mansearch.html">🔍</a></span><span><a href="lpdoc_ref_manfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="lpdoc_ref_man.html">The lpdoc Documentation Generator</a> »<br/> </li><li><a href="Writing.html">Writing documentation</a> »<br/> </li><li><a href=""><strong>Documentation configuration options</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Documentation configuration options</h1><a class="lpdoc-idx-anchor" href="lpdoc_ref_mansearch.html#doccfg"></a>
These are the predicates that define the options that can be used in documentation configuration files. Their admissible values are given in their corresponding types in <a href="doccfg_props.html">Admissible values for the documentation configuration options</a>. See <a href="Writing.html">Writing documentation</a> for an introduction.<br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/>Use with the <tt>:- module(_, [], [doccfg])</tt> directive in the documentation configuration file and provide the definition for the required entries.<li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#doc_structure/1"><tt>doc_structure/1</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#filepath/1"><tt>filepath/1</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#output_name/1"><tt>output_name/1</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#output_dir/1"><tt>output_dir/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#doc_mainopts/1"><tt>doc_mainopts/1</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#doc_compopts/1"><tt>doc_compopts/1</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#docformat/1"><tt>docformat/1</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#index/1"><tt>index/1</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#bibfile/1"><tt>bibfile/1</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#startpage/1"><tt>startpage/1</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#papertype/1"><tt>papertype/1</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#libtexinfo/1"><tt>libtexinfo/1</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#comment_version/1"><tt>comment_version/1</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#allow_markdown/1"><tt>allow_markdown/1</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="#allow_runnable/1"><tt>allow_runnable/1</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="#syntax_highlight/1"><tt>syntax_highlight/1</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="#verbosity/1"><tt>verbosity/1</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="#warning_level/1"><tt>warning_level/1</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="#autogen_warning/1"><tt>autogen_warning/1</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="#html_layout/1"><tt>html_layout/1</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="#htmlurl/1"><tt>htmlurl/1</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="#html_asset/1"><tt>html_asset/1</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="#tmplpath/1"><tt>tmplpath/1</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="#load_doc_module/1"><tt>load_doc_module/1</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="#end_of_file/0"><tt>end_of_file/0</tt></a>.
</ul><li><strong>New operators defined:</strong><br/><a class="lpdoc-idx-anchor" id="25" href="lpdoc_ref_mansearch.html#function/1"><tt>function/1</tt></a> [1150,fx], <a class="lpdoc-idx-anchor" id="26" href="lpdoc_ref_mansearch.html#fun_eval/1"><tt>fun_eval/1</tt></a> [1150,fx], <a class="lpdoc-idx-anchor" id="27" href="lpdoc_ref_mansearch.html#fun_return/1"><tt>fun_return/1</tt></a> [1150,fx], <a class="lpdoc-idx-anchor" id="28" href="lpdoc_ref_mansearch.html#:=/2"><tt>:=/2</tt></a> [1130,xfx], <a class="lpdoc-idx-anchor" id="29" href="lpdoc_ref_mansearch.html#~/1"><tt>~/1</tt></a> [50,fx], <a class="lpdoc-idx-anchor" id="30" href="lpdoc_ref_mansearch.html#^^/1"><tt>^^/1</tt></a> [910,fx], <a class="lpdoc-idx-anchor" id="31" href="lpdoc_ref_mansearch.html#^/1"><tt>^/1</tt></a> [25,fy], <a class="lpdoc-idx-anchor" id="32" href="lpdoc_ref_mansearch.html#|/2"><tt>|/2</tt></a> [1105,xfy], <a class="lpdoc-idx-anchor" id="33" href="lpdoc_ref_mansearch.html#?/2"><tt>?/2</tt></a> [1050,xfy].
<li><strong>Implicit imports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Application modules:</em><br/><a class="lpdoc-idx-anchor" id="34" href="doccfg_props.html"><tt>doccfg_props</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="35" href="lpdoc_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="lpdoc_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="lpdoc_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="lpdoc_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="lpdoc_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="lpdoc_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="lpdoc_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="lpdoc_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="basic_props.html"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="lpdoc_ref_mansearch.html#stream_basic"><tt>stream_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="45" href="lpdoc_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="lpdoc_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="lpdoc_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="lpdoc_ref_mansearch.html#fsyntax"><tt>fsyntax</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="lpdoc_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="regtypes_doc.html"><tt>regtypes</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="doc_structure/1" href="lpdoc_ref_mansearch.html#doc_structure/1">doc_structure/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>doc_structure(Term)</tt>
</span><p>It defines the document structure as a tree.<p>The tree is defined as a root node with optional children. Nodes can be atoms or pairs (<tt>N-Cs</tt>), where <tt>Cs</tt> is a list of nodes. The root of the tree is the main file of the manual, i.e., the file which determines the manual's cover page, and first chapter. The children files are used as components, i.e., they will constitute the subsequent chapters of the manual.<p>If the main or any component file name ends with <tt>_doc</tt>, then it is treated as documenting the same file name without the <tt>_doc</tt> suffix. This is useful for separating the documentation from the source file (see <a href="Writing.html#Separating the documentation from the source file">Separating the documentation from the source file</a>).</p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="filepath/1" href="lpdoc_ref_mansearch.html#filepath/1">filepath/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>filepath(Path)</tt>
</span><p>It defines the directories where the <tt>.pl</tt> files to be documented can be found.<p>You also need to specify all the paths containing files which are used by the files being documented. For example, the paths to files included by an <tt>@include</tt> command or to figures.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="52" href="doccfg_props.html#dirpath/1"><tt>dirpath/1</tt></a>)</span><span><span class="lpdoc-var">Path</span> is a full path to a directory.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="output_name/1" href="lpdoc_ref_mansearch.html#output_name/1">output_name/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>output_name(Base)</tt>
</span><p>It determines the base file name of the main documents generated by <a class="lpdoc-idx-anchor" id="53" href="lpdoc_ref_mansearch.html#lpdoc"><tt>lpdoc</tt></a>.<p>By default it is equal to the main file name (root) specified in <a class="lpdoc-idx-anchor" id="54" href="#doc_structure/1"><tt>doc_structure/1</tt></a>.<p>If the main file name ends with <tt>_doc</tt>, then it is equal to the name without the <tt>_doc</tt> suffix (see <a class="lpdoc-idx-anchor" id="55" href="#doc_structure/1"><tt>doc_structure/1</tt></a>).<p>If the <tt>versioned_output</tt> option is specified in <a class="lpdoc-idx-anchor" id="56" href="#doc_mainopts/1"><tt>doc_mainopts/1</tt></a>, the bundle version number is appended to the output name.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="57" href="lpdoc_ref_mansearch.html#sourcename/1"><tt>sourcename/1</tt></a>)</span><span><span class="lpdoc-var">Base</span> is a source name.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="output_dir/1" href="lpdoc_ref_mansearch.html#output_dir/1">output_dir/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>output_dir(Base)</tt>
</span><p>Output directory. If undefined, uses directory of input</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="58" href="lpdoc_ref_mansearch.html#sourcename/1"><tt>sourcename/1</tt></a>)</span><span><span class="lpdoc-var">Base</span> is a source name.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="doc_mainopts/1" href="lpdoc_ref_mansearch.html#doc_mainopts/1">doc_mainopts/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>doc_mainopts(Option)</tt>
</span><p><span class="lpdoc-var">Option</span> is a processing option which should be activated when processing the main file.<p>It can be set to a series of options which allow more detailed control of what is included in the documentation for the main file and how (i.e., including bug information <a class="lpdoc-idx-anchor" id="59" href="lpdoc_ref_mansearch.html#including or not bug info"></a>, versions and patches or only patches <a class="lpdoc-idx-anchor" id="60" href="lpdoc_ref_mansearch.html#including or not versions, patches"></a>, authors <a class="lpdoc-idx-anchor" id="61" href="lpdoc_ref_mansearch.html#including or not authors"></a>, changelog <a class="lpdoc-idx-anchor" id="62" href="lpdoc_ref_mansearch.html#including or not changelog"></a>, explanation of modes, <a class="lpdoc-idx-anchor" id="63" href="lpdoc_ref_mansearch.html#one-sided printing"><em>one-sided printing</em></a> (<a class="lpdoc-idx-anchor" id="64" href="lpdoc_ref_mansearch.html#two-sided"><em>two-sided</em></a> is the default), etc.).<p>See <a class="lpdoc-idx-anchor" id="65" href="doccfg_props.html#option_comment/2"><tt>option_comment/2</tt></a> for a description of these options.<p>The default values are: <tt>no_bugs</tt>, <tt>no_patches</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="66" href="doccfg_props.html#supported_option/1"><tt>supported_option/1</tt></a>)</span><span>Documentation generation options.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="doc_compopts/1" href="lpdoc_ref_mansearch.html#doc_compopts/1">doc_compopts/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>doc_compopts(Option)</tt>
</span><p><span class="lpdoc-var">Option</span> is a processing option which should be activated when processing the secondary files (all except the main file).<p>Currently these options are common to all component files but they can be different from <a class="lpdoc-idx-anchor" id="67" href="#doc_mainopts/1"><tt>doc_mainopts/1</tt></a>.<p>See <a class="lpdoc-idx-anchor" id="68" href="doccfg_props.html#option_comment/2"><tt>option_comment/2</tt></a> for a description of these options.<p>The default values are: <tt>no_bugs</tt>, <tt>no_patches</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="69" href="doccfg_props.html#supported_option/1"><tt>supported_option/1</tt></a>)</span><span>Documentation generation options.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="docformat/1" href="lpdoc_ref_mansearch.html#docformat/1">docformat/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>docformat(Format)</tt>
</span><p>Defines the documentation formats to be generated by default.<p>If the main file is an <strong>application</strong>, and the <tt>manl</tt> option is selected, then <a class="lpdoc-idx-anchor" id="70" href="lpdoc_ref_mansearch.html#lpdoc"><tt>lpdoc</tt></a> looks for a <a class="lpdoc-idx-anchor" id="71" href="lpdoc_ref_mansearch.html#usage_message/1"><tt>usage_message/1</tt></a> fact, which should contain a string as argument, and will use that string to document the <a class="lpdoc-idx-anchor" id="72" href="lpdoc_ref_mansearch.html#usage of the application"><em>usage of the application</em></a> (i.e., it will be used to fill in the <a class="lpdoc-idx-anchor" id="73" href="lpdoc_ref_mansearch.html#synopsis section of the man page"><em>synopsis section of the man page</em></a>).<p>See <a class="lpdoc-idx-anchor" id="74" href="doccfg_props.html#supported_format/1"><tt>supported_format/1</tt></a> for the available formats.<p>The default values are: <tt>pdf</tt>, <tt>manl</tt>, <tt>info</tt>, <tt>html</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="75" href="doccfg_props.html#supported_format/1"><tt>supported_format/1</tt></a>)</span><span>Available formats
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="index/1" href="lpdoc_ref_mansearch.html#index/1">index/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>index(Idx)</tt>
</span><p>Defines the index sections to be generated by default.<p>Selecting <tt>all</tt> generates all the supported indices. However, note that this (as well as selecting many indices explicitely) exceeds the capacity of most texinfo installations.<p>See <a class="lpdoc-idx-anchor" id="76" href="lpdoc_ref_mansearch.html#index_comment/1"><tt>index_comment/1</tt></a> for a description of the indices.<p>The default values are: <tt>concept</tt>, <tt>lib</tt>, <tt>pred</tt>, <tt>prop</tt>, <tt>regtype</tt>, <tt>decl</tt>, <tt>author</tt>, <tt>global</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="77" href="doccfg_props.html#supported_index/1"><tt>supported_index/1</tt></a>)</span><span>Supported indexes
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="bibfile/1" href="lpdoc_ref_mansearch.html#bibfile/1">bibfile/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>bibfile(F)</tt>
</span><p>It determines a list of <a class="lpdoc-idx-anchor" id="78" href="lpdoc_ref_mansearch.html#.bib files"><em>.bib files</em></a> (one file per path), i.e., files containing <a class="lpdoc-idx-anchor" id="79" href="lpdoc_ref_mansearch.html#bibliographic entries"><em>bibliographic entries</em></a> in <a class="lpdoc-idx-anchor" id="80" href="lpdoc_ref_mansearch.html#bibtex"><tt>bibtex</tt></a> <a class="lpdoc-idx-anchor" id="81" href="lpdoc_ref_mansearch.html#bibtex"></a> format.<p>This is only relevant if you are <a class="lpdoc-idx-anchor" id="82" href="lpdoc_ref_mansearch.html#using citations">using citations</a> in the text (using the <a class="lpdoc-idx-anchor" id="83" href="lpdoc_ref_mansearch.html#@cite command">@cite command</a>). In that case those will be the files in which the citations will be searched for. All the references will appear together in a <em>References</em> appendix at the end of the manual.<p>If you are not using citations, then select the <tt>no_biblio</tt> option on the main file, which will prevent an empty 'References' appendix from appearing in the manual.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="84" href="doccfg_props.html#filename/1"><tt>filename/1</tt></a>)</span><span><span class="lpdoc-var">F</span> is an atom describing the name of a file.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="startpage/1" href="lpdoc_ref_mansearch.html#startpage/1">startpage/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>startpage(PageNumber)</tt>
</span><p>Page number of the first page of the manual.<p><a class="lpdoc-idx-anchor" id="85" href="lpdoc_ref_mansearch.html#page numbering, changing"></a> <p>Setting this to a different value allows changing the page number of the first page of the manual. This can be useful if the manual is to be included in a larger document or set of manuals. Typically, this should be an <em>odd</em> number.<p>The default value is 1.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="86" href="basic_props.html#int/1"><tt>int/1</tt></a>)</span><span><span class="lpdoc-var">PageNumber</span> is an integer.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="papertype/1" href="lpdoc_ref_mansearch.html#papertype/1">papertype/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>papertype(PageNumber)</tt>
</span><p>Type of paper/format for printable outputs (e.g., <tt>pdf</tt>).<p><a class="lpdoc-idx-anchor" id="87" href="lpdoc_ref_mansearch.html#page size, changing"></a> <a class="lpdoc-idx-anchor" id="88" href="lpdoc_ref_mansearch.html#page style, changing"></a> <p>The currently supported outputs (most of them inherited from <a class="lpdoc-idx-anchor" id="89" href="lpdoc_ref_mansearch.html#texinfo"><tt>texinfo</tt></a>) are:<p><dl> <p><dt><tt>afourpaper</tt><dd> <p>The default, usable for printing on <a class="lpdoc-idx-anchor" id="90" href="lpdoc_ref_mansearch.html#A4 paper"><em>A4 paper</em></a>. Rather busy, but saves trees.<p><dt><tt>afourwide</tt><dd> <p>This one crams even more stuff than <tt>afourpaper</tt> on an A4 page. Useful for generating manuals in the least amount of space. It saves more trees.<p><dt><tt>afourlatex</tt><dd> <p>This one is a little less compressed than <tt>afourpaper</tt>.<p><dt><tt>smallbook</tt><dd> <p>Small pages, like in a handbook.<p><dt><tt>letterpaper</tt><dd> <p>For printing on American <a class="lpdoc-idx-anchor" id="91" href="lpdoc_ref_mansearch.html#letter size paper"><em>letter size paper</em></a>.<p><dt><tt>afourthesis</tt><dd> <p>A <a class="lpdoc-idx-anchor" id="92" href="lpdoc_ref_mansearch.html#thesis-like style"><em>thesis-like style</em></a> (i.e., double spaced, wide margins etc.). Useful -- for inserting <a class="lpdoc-idx-anchor" id="93" href="lpdoc_ref_mansearch.html#lpdoc"><tt>lpdoc</tt></a> output as appendices of a thesis or similar document. It does not save trees.<p></dl> <p>See also the <tt>onesided</tt> option for the main file.<p>The default value is: <tt>afourpaper</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="94" href="doccfg_props.html#supported_papertype/1"><tt>supported_papertype/1</tt></a>)</span><span>Possible papertypes
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="libtexinfo/1" href="lpdoc_ref_mansearch.html#libtexinfo/1">libtexinfo/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>If set to yes the <a class="lpdoc-idx-anchor" id="95" href="lpdoc_ref_mansearch.html#texinfo.tex"><tt>texinfo.tex</tt></a> file that comes with the lpdoc distribution will be used when generating manuals in formats such as <tt>dvi</tt> and <tt>ps</tt>. Otherwise, the texinfo file that comes with your <a class="lpdoc-idx-anchor" id="96" href="lpdoc_ref_mansearch.html#tex"><tt>tex</tt></a> installation will be used. It is recommended that you leave this set to <tt>'yes'</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="97" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="comment_version/1" href="lpdoc_ref_mansearch.html#comment_version/1">comment_version/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>The source files contain version information. If not specified lpdoc will assume the opposite</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="98" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="allow_markdown/1" href="lpdoc_ref_mansearch.html#allow_markdown/1">allow_markdown/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Allow LPdoc-flavored markdown in docstrings</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="99" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="allow_runnable/1" href="lpdoc_ref_mansearch.html#allow_runnable/1">allow_runnable/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Allow runnable code blocks (Ciao Playground)</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="100" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="syntax_highlight/1" href="lpdoc_ref_mansearch.html#syntax_highlight/1">syntax_highlight/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Syntax highlight code blocks (only for HTML backend)</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="101" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="verbosity/1" href="lpdoc_ref_mansearch.html#verbosity/1">verbosity/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Level of verbosity of (normally progress) messages. <tt>quiet</tt> means no messages printed, <tt>normal</tt> means standard messages, and <tt>all</tt> means more detailed messages. See <a class="lpdoc-idx-anchor" id="102" href="lpdoc_ref_mansearch.html#autodoc_message_t/1"><tt>autodoc_message_t/1</tt></a>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="103" href="doccfg_props.html#verbosity_t/1"><tt>verbosity_t/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is a verbosity level.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="warning_level/1" href="lpdoc_ref_mansearch.html#warning_level/1">warning_level/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Warning reporting level. <tt>none</tt> means only error messages are printed, <tt>normal</tt> means errors and warnings, <tt>all</tt> means also notes. See <a class="lpdoc-idx-anchor" id="104" href="lpdoc_ref_mansearch.html#autodoc_message_t/1"><tt>autodoc_message_t/1</tt></a>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="105" href="doccfg_props.html#warning_level_t/1"><tt>warning_level_t/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is a warning level.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autogen_warning/1" href="lpdoc_ref_mansearch.html#autogen_warning/1">autogen_warning/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Include an <em>automatically generated</em> notice inside the output text.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="106" href="doccfg_props.html#yesno/1"><tt>yesno/1</tt></a>)</span><span>Enumerated type for yes/no
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="html_layout/1" href="lpdoc_ref_mansearch.html#html_layout/1">html_layout/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Layout for html output.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="107" href="basic_props.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is any term.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="htmlurl/1" href="lpdoc_ref_mansearch.html#htmlurl/1">htmlurl/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Deploy URL for html output</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="108" href="basic_props.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is any term.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="html_asset/1" href="lpdoc_ref_mansearch.html#html_asset/1">html_asset/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Directory with additional files for HTML backend</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="109" href="doccfg_props.html#dirpath/1"><tt>dirpath/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is a full path to a directory.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="tmplpath/1" href="lpdoc_ref_mansearch.html#tmplpath/1">tmplpath/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Directory for HTML templates</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="110" href="doccfg_props.html#dirpath/1"><tt>dirpath/1</tt></a>)</span><span><span class="lpdoc-var">Arg1</span> is a full path to a directory.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="load_doc_module/1" href="lpdoc_ref_mansearch.html#load_doc_module/1">load_doc_module/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>load_doc_module(F)</tt>
</span><p>Documentation module (<tt>doc_module</tt>) for extensions (see <a class="lpdoc-idx-anchor" id="111" href="lpdoc_ref_mansearch.html#doc_module"><tt>doc_module</tt></a>).</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="112" href="basic_props.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">F</span> is any term.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="end_of_file/0" href="lpdoc_ref_mansearch.html#end_of_file/0">end_of_file/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
</div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>