@ciao-lang/ts-ciao-interface

<!DOCTYPE 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>Admissible values for the 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="doccfg_doc.html">←</a><a class="lpdoc-navbutton" href="comments.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>Admissible values for the 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><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Admissible values for the documentation configuration options</h1><a class="lpdoc-idx-anchor" href="lpdoc_ref_mansearch.html#doccfg_props"></a> This module defines the regular types that define the admissible values for the documentation configuration options.<br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(doccfg/doccfg_props)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#option_comment/2"><tt>option_comment/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#index_comment/2"><tt>index_comment/2</tt></a>. <li><em>Regular Types:</em><br/><a class="lpdoc-idx-anchor" id="2" href="#dirpath/1"><tt>dirpath/1</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#filename/1"><tt>filename/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#supported_option/1"><tt>supported_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#supported_format/1"><tt>supported_format/1</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#supported_index/1"><tt>supported_index/1</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#supported_papertype/1"><tt>supported_papertype/1</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#yesno/1"><tt>yesno/1</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#verbosity_t/1"><tt>verbosity_t/1</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#warning_level_t/1"><tt>warning_level_t/1</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">REGTYPE</span><a class="lpdoc-idx-anchor" id="dirpath/1" href="lpdoc_ref_mansearch.html#dirpath/1">dirpath/1</a></div><div class="lpdoc-deftext">An atom describing a path to a directory. Should be a full, explicit path (i.e., not containing environment variables).<p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>dirpath(P)</tt> </span><p><span class="lpdoc-var">P</span> is a full path to a directory.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="filename/1" href="lpdoc_ref_mansearch.html#filename/1">filename/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>filename(P)</tt> </span><p><span class="lpdoc-var">P</span> is a full path to a file.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="supported_option/1" href="lpdoc_ref_mansearch.html#supported_option/1">supported_option/1</a></div><div class="lpdoc-deftext">In general, selecting none of these options generates the most verbose manuals, i.e., each option generally supresses the production of a certain kind of output (on the other hand, <tt>'verbose'</tt> selects verbose output from <a class="lpdoc-idx-anchor" id="11" href="lpdoc_ref_mansearch.html#ciaoc"><tt>ciaoc</tt></a> when processing the file).<p>Possible options: <pre class="lpdoc-codeblock">supported_option(verbose). supported_option(no_bugs). supported_option(no_authors). supported_option(no_stability). supported_option(no_version). supported_option(versioned_output). supported_option(no_lpdocack). supported_option(no_changelog). supported_option(no_patches). supported_option(autogen_warning). supported_option(modes). supported_option(head_props). supported_option(literal_props). supported_option(no_propnames). supported_option(no_undefined). supported_option(no_propsepln). supported_option(no_biblio). supported_option(no_sysmods). supported_option(no_engmods). supported_option(no_packages). supported_option(no_isoline). supported_option(propmods). supported_option(no_propuses). supported_option(shorttoc). supported_option(regtype_props). supported_option(onesided). supported_option(no_math). supported_option(tests). supported_option(no_examples). supported_option(status). </pre><p><span class="lpdoc-usage-header">Usage:</span><p>Documentation generation options.</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="option_comment/2" href="lpdoc_ref_mansearch.html#option_comment/2">option_comment/2</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>option_comment(Option,Text)</tt> </span><p>The currently supported options are: <pre class="lpdoc-codeblock">option_comment(verbose,"Verbose output (good for debugging)."). option_comment(no_bugs,"Do not include information on bugs."). option_comment(no_authors,"Do not include author names."). option_comment(no_stability,"Do not include stability comment."). option_comment(no_version,"Do not include version information."). option_comment(versioned_output,"Include version in the output name."). option_comment(no_lpdocack,"Do not include an ack of LPdoc in output."). option_comment(no_changelog,"Do not include change log."). option_comment(no_patches,"Do not include comments for patches."). option_comment(autogen_warning,"Include autogenerated warning (only ascii backend)."). option_comment(modes,"Do not translate modes and their arguments (except for properties)"). option_comment(head_props,"Do not move head properties to body."). option_comment(literal_props,"Do not use text to document properties."). option_comment(no_propnames,"Do not include property names in prop text."). option_comment(no_undefined,"Do not signal undefined properties in text."). option_comment(no_propsepln,"Do not put each property in a separate line."). option_comment(no_biblio,"Do not include a bibliographical 'References' appendix."). option_comment(no_sysmods,"Do not include system modules in the import list."). option_comment(no_engmods,"Do not include system engine modules in the import list."). option_comment(no_packages,"Do not include packages in the import list."). option_comment(no_isoline,"Do not include *textual* description that a given usage conforms to the ISO standard."). option_comment(propmods,"Include module name to which props belong."). option_comment(no_propuses,"Do not include property uses (from assertions) in indices."). option_comment(shorttoc,"Produce shorter table of contents (no entries for individual defs of preds, props, etc.)."). option_comment(regtype_props,"Include in the doc for regtypes the global prop stating that they are indeed regtypes."). option_comment(onesided,"For printing on one side (default is two)."). option_comment(no_math,"Disable mathematical environments."). option_comment(tests,"Include test assertions in doc for preds (default: only tests that have 'example' in comp field)."). option_comment(no_examples,"Document no test assertions, i.e., also not those that have 'example' as a comp property."). option_comment(status,"Document also the status of assertions (default is no status, more appropriate for manuals)."). </pre><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>option_comment(Option,Text)</tt> </span><p><span class="lpdoc-var">Option</span> is a documentation option which is supported. These options can be applied to the main file or to the components. <span class="lpdoc-var">Text</span> describes the effect of selecting that option.</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="12" href="#supported_option/1"><tt>supported_option/1</tt></a>)</span><span>Documentation generation options. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#string/1"><tt>string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes). </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="supported_format/1" href="lpdoc_ref_mansearch.html#supported_format/1">supported_format/1</a></div><div class="lpdoc-deftext">The available formats are: <pre class="lpdoc-codeblock">supported_format(texi). supported_format(dvi). supported_format(ps). supported_format(pdf). supported_format(ascii). supported_format(manl). supported_format(info). supported_format(html). </pre><p><span class="lpdoc-usage-header">Usage:</span><p>Available formats</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="supported_index/1" href="lpdoc_ref_mansearch.html#supported_index/1">supported_index/1</a></div><div class="lpdoc-deftext">Supported indexes: <pre class="lpdoc-codeblock">supported_index(concept). supported_index(lib). supported_index(apl). supported_index(pred). supported_index(prop). supported_index(regtype). supported_index(decl). supported_index(op). supported_index(modedef). supported_index(file). supported_index(global). supported_index(all). </pre><p><span class="lpdoc-usage-header">Usage:</span><p>Supported indexes</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="index_comment/2" href="lpdoc_ref_mansearch.html#index_comment/2">index_comment/2</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>index_comment(Index,Text)</tt> </span><p>The currently supported indices are: <pre class="lpdoc-codeblock">index_comment(lib,"Library/module index"). index_comment(apl,"Application index"). index_comment(pred,"Predicate/method index"). index_comment(prop,"Property index"). index_comment(regtype,"Regular type index"). index_comment(decl,"Declaration index"). index_comment(op,"Operator index"). index_comment(modedef,"Mode index"). index_comment(file,"File/directory index"). index_comment(concept,"Concept index"). index_comment(author,"Author index"). index_comment(global,"Global index"). index_comment(all,"All supported indices"). </pre><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>index_comment(Index,Text)</tt> </span><p><span class="lpdoc-var">Type</span> is a type of index which is supported. <span class="lpdoc-var">Text</span> describes the index contents.</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="14" href="lpdoc_ref_mansearch.html#atom/1"><tt>atom/1</tt></a>)</span><span><span class="lpdoc-var">Index</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#string/1"><tt>string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes). </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="supported_papertype/1" href="lpdoc_ref_mansearch.html#supported_papertype/1">supported_papertype/1</a></div><div class="lpdoc-deftext">Possible papertypes: <pre class="lpdoc-codeblock">supported_papertype(letterpaper). supported_papertype(smallbook). supported_papertype(afourpaper). supported_papertype(afourlatex). supported_papertype(afourwide). supported_papertype(afourthesis). </pre><p><span class="lpdoc-usage-header">Usage:</span><p>Possible papertypes</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="yesno/1" href="lpdoc_ref_mansearch.html#yesno/1">yesno/1</a></div><div class="lpdoc-deftext">Enumerated type: <pre class="lpdoc-codeblock">yesno(yes). yesno(no). </pre><p><span class="lpdoc-usage-header">Usage:</span><p>Enumerated type for yes/no</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="verbosity_t/1" href="lpdoc_ref_mansearch.html#verbosity_t/1">verbosity_t/1</a></div><div class="lpdoc-deftext">Defines the levels of verbosity for the messages produced by the message priting predicates. <pre class="lpdoc-codeblock">verbosity_t(quiet). verbosity_t(progress). verbosity_t(full). </pre><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>verbosity_t(L)</tt> </span><p><span class="lpdoc-var">L</span> is a verbosity level.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="warning_level_t/1" href="lpdoc_ref_mansearch.html#warning_level_t/1">warning_level_t/1</a></div><div class="lpdoc-deftext">Defines which levels of warning will be printed by the message priting predicates. <pre class="lpdoc-codeblock">warning_level_t(none). warning_level_t(normal). warning_level_t(all). </pre><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>warning_level_t(L)</tt> </span><p><span class="lpdoc-var">L</span> is a warning level.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="16" href="lpdoc_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="lpdoc_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="lpdoc_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="lpdoc_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="lpdoc_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="lpdoc_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="lpdoc_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="lpdoc_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="basic_props.html"><tt>basic_props</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="25" href="lpdoc_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="lpdoc_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="lpdoc_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="lpdoc_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="lpdoc_ref_mansearch.html#fsyntax"><tt>fsyntax</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>