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. When the xpce reference manual is installed it is prepended as a single xpce subtree so xpce classes and their members appear in the navigation tree under Documentation -> Packages -> XPCE.

 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 function
• c(Function) display documentation of a C API function
• section(Level, Number, Id, File) Display a section of the manual
• sec(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.

link_scheme(Scheme)

Write the manual references as Scheme:Object IRIs rather than as links into the PlDoc server. References that do not resolve to a documentation object are removed. Used by help/1 to create clickable terminal output. See man_object_uri/2.

 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.

 xpce_object_label(+Object, -Label) is semidet

Label is the conventional xpce arrow notation for an xpce/3 class member, e.g. `point<-x`.

 prolog:doc_object_href(+Object, -HREF) is semidet[multifile]

Produce a HREF for section objects.

 man_param_object(+Param, -Object) is semidet

True when Param, a parameter of the PlDoc HTTP interface, refers to documentation Object. Param is one of

• predicate(PI)
• function(PI)
• 'CAPI'(Name)
• section(Id)
• object(Text)

See also

- pldoc_href_object/2 does the same for a complete HREF.

 pldoc_href_object(+HREF, -Object) is semidet

True when HREF, a link as generated for the PlDoc web server, points at documentation Object. Fails if HREF does not address a specific documented object, e.g., a link into a source file.

 man_object_uri(+Object, -URI) is semidet

 man_uri_object(+URI, -Object) is semidet

Convert between a documentation object and a `man:` IRI. Such IRIs embed manual hyperlinks into terminal output using OSC8 hyperlinks. man_object_uri/2 fails if Object is not fully specified.

See also

- help/1 and ansi_hyperlink/3.

Re-exported predicates

The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.

 man_object_uri(+Object, -URI) is semidet

 man_uri_object(+URI, -Object) is semidet

Convert between a documentation object and a `man:` IRI. Such IRIs embed manual hyperlinks into terminal output using OSC8 hyperlinks. man_object_uri/2 fails if Object is not fully specified.

See also

- help/1 and ansi_hyperlink/3.