man_content_tree(+Dir, -Tree) is det- Compute the content tree for a multi-file HTML document. We do
this by processing
Contents.html for making the toplevel tree
that links to the individual files. Then we use
html_content_tree/2 to materialize the trees for the files.
- man_packages_tree(-Tree) is det
- Tree is the content tree of all packages
- man_page(+Obj, +Options)// is semidet
- Produce a Prolog manual page for Obj. The page consists of a
link to the section-file and a search field, followed by the
predicate description. Obj is one of:
- Name/Arity
Predicate indicator: display documentation of the predicate
f(Name/Arity)
display documentation of an arithmetic functionc(Function)
display documentation of a C API functionsection(Level, Number, Id, File)
Display a section of the manualsec(DocFile#Id)
Display a section of the manual (from short form)
Options:
- no_manual(Action)
- If Action =
fail, fail instead of displaying a
not-found message.
- synopsis(Bool)
- If
false, omit the synopsis line
- links(Bool)
- If
true (default), include links to the parent object;
if false, just emit the manual material.
- navtree(Bool)
- If
true (default), display the navigation tree, otherwise
suppress it.
- man_synopsis(+Object, +Section)//
- Give synopsis details for a fully specified predicate indicator
and link this to the section.
- man_overview(+Options)// is det
- Provide a toplevel overview on the manual: the reference manual
and the available packages.
- prolog:doc_object_link(+Obj, +Options)//[multifile]
- Provide the HTML to describe Obj for linking purposes.
- prolog:doc_object_href(+Object, -HREF) is semidet[multifile]
- Produce a HREF for section objects.
