wiki.pl

wiki_file_to_dom(+File, +DOM) is det: DOM is the HTML dom representation for the content of File.
include(+Object, +Type, +Options)//
file(+Path, Options)//: Trap translation of \file(+Path, Options)
index_wiki_pages: Create a (title) index of the available wiki pages

Re-exported predicates

The following predicates are re-exported from other modules

multifile(+Obj, +Options) is semidet

True if Obj is a multifile predicate.

is_op_type(+Atom, ?Type)

True if Atom is an operator of Type. Type is one of prefix, infix or postfix.

doc_file_objects(+FileSpec, -File, -Objects, -FileOptions, +Options) is det

Extracts relevant information for FileSpec from the PlDoc database. FileOptions contains:

file(Title:string, Comment:string)
module(Module:atom)
public(Public:list(predicate_indicator)

Objects contains

doc(PI:predicate_indicator, File:Line, Comment)

We distinguish three different states for FileSpec:

File was cross-referenced with collection enabled. All information is in the xref database.
File was loaded. If comments are not loaded, cross-reference the file, while storing the comments as the compiler would do.
Neither of the above. In this case we cross-reference the file.

Arguments:

`FileSpec`	- `File` specification as used for load_files/2.
`File`	- Prolog canonical filename

private(+Obj, +Options) is semidet

True if Obj is not exported from Options. This means Options defined a module and Obj is not member of the exports of the module.

pred_anchor_name(+Head, -PI:atom/integer, -Anchor:string) is det

Create an HTML anchor name from Head.

unquote_filespec(+Spec, -Unquoted) is det

Translate e.g. library('semweb/rdf_db') into library(semweb/rdf_db).

doc_tag_title(+Tag, -Title) is det

Title is the name to use for Tag in the generated documentation.

existing_linked_file(+File, -Path) is semidet

True if File is a path to an existing file relative to the current file. Path is the absolute location of File.

ensure_doc_objects(+File) is det

Ensure we have documentation about File. If we have no comments for the file because it was loaded before comment collection was enabled, run the cross-referencer on it to collect the comments and meta-information.

Arguments:

File

- is a canonical filename that is loaded.

doc_hide_private(+Objs, +Public, +Options)

Remove the private objects from Objs according to Options.

module_info(+File, -ModuleOptions, +OtherOptions) is det

Add options module(Name), public(Exports) to OtherOptions if File is a module file.

print_html_head(+Out:stream) is det

Print the DOCTYPE line.

doc_page_dom(+Title, +Body, -DOM) is det

Create the complete HTML DOM from the Title and Body. It adds links to the style-sheet and javaScript files.

doc_for_wiki_file(+File, +Options) is det

Write HTML for the File containing wiki data.

doc_for_file(+File, +Options) is det

HTTP handler that writes documentation for File as HTML. Options:

public_only(+Bool): If true (default), only emit documentation for exported predicates.
edit(Bool): If true, provide edit buttons. Default, these buttons are suppressed.
title(+Title): Specify the page title. Default is the base name of the file.

Arguments:

File

- Prolog file specification or xref source id.

doc_write_html(+Out:stream, +Title:atomic, +DOM) is det

Write HTML for the documentation page DOM using Title to Out.

object_href(+Object, -HREF) is det

object_href(+Object, -HREF, +Options) is det

HREF is the URL to access Object.

is_pi(@Term) is semidet

True if Term is a predicate indicator.

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.