This module translates the Herbrand term from the documentation extracting module doc_wiki.pl into HTML+CSS.
true
(default), only emit documentation for
exported predicates.true
, provide edit buttons. Default, these buttons
are suppressed.doc_files.pl
. A bit hacky ...file(Title:string, Comment:string)
module(Module:atom)
list(predicate_indicator)
Objects contains
doc(PI:predicate_indicator, File:Line, Comment)
We distinguish three different states for FileSpec:
module(Name)
, public(Exports)
to OtherOptions if
File is a module file.true
, provide a navitation tree.DOCTYPE
line.tag(Name, Values)
terms produced by doc_wiki.pl.prefix
,
infix
or postfix
.
Current file must be available through the global variable
pldoc_file
. If this variable not set it creates a link to
/doc/<file>#anchor. Such links only work in the online browser.
name/arity
, non-linking predicate indicator.inline
or title
number
, title
or number_title
file(File)
terms in the DOM term generated by wiki.pl
. Supported
options are:
file(Name, Link)
that specifies that we must
user Link for the given physical file Name.include(File,
Type)
terms in the DOM term generated by wiki.pl
if it
encounters [[file.ext]].The following predicates are exported, but not or incorrectly documented.