doc_access.pl![Show source Show source](/pldoc/res/source.png) |
host_access_options/2 | Filter the authorization options from AllOptions, leaving the remaining options in NoAuthOptions. | ![Show source Source](/pldoc/res/source.png) |
doc_colour.pl -- Source colouring support![Show source Show source](/pldoc/res/source.png) |
colour_fragments/2 | Create a list of colour fragments from In. | ![Show source Source](/pldoc/res/source.png) |
doc_html.pl -- PlDoc HTML backend![Show source Show source](/pldoc/res/source.png) |
cite/3 | Emit citations. | ![Show source Source](/pldoc/res/source.png) |
doc_file_objects/5 | Extracts relevant information for FileSpec from the PlDoc database. | ![Show source Source](/pldoc/res/source.png) |
doc_for_file/2 | HTTP handler that writes documentation for File as HTML. | ![Show source Source](/pldoc/res/source.png) |
doc_for_wiki_file/2 | Write HTML for the File containing wiki data. | ![Show source Source](/pldoc/res/source.png) |
doc_hide_private/3 | Remove the private objects from Objs according to Options. | ![Show source Source](/pldoc/res/source.png) |
doc_page_dom/3 | Create the complete HTML DOM from the Title and Body. | ![Show source Source](/pldoc/res/source.png) |
doc_resources/3 | Include required resources (CSS, JS) into the output. | ![Show source Source](/pldoc/res/source.png) |
doc_tag_title/2 | Title is the name to use for Tag in the generated documentation. | ![Show source Source](/pldoc/res/source.png) |
doc_write_html/3 | Write HTML for the documentation page DOM using Title to Out. | ![Show source Source](/pldoc/res/source.png) |
edit_button/4 | Create an edit button for File. | ![Show source Source](/pldoc/res/source.png) |
ensure_doc_objects/1 | Ensure we have documentation about File. | ![Show source Source](/pldoc/res/source.png) |
existing_linked_file/2 | True if File is a path to an existing file relative to the current file. | ![Show source Source](/pldoc/res/source.png) |
file/3 | Create a link to another filename if the file exists. | ![Show source Source](/pldoc/res/source.png) |
file/4 | Create a link to another filename if the file exists. | ![Show source Source](/pldoc/res/source.png) |
file_header/4 | Create the file header. | ![Show source Source](/pldoc/res/source.png) |
flagref/3 | Reference to a Prolog flag. | ![Show source Source](/pldoc/res/source.png) |
include/5 | Inline FileName. | ![Show source Source](/pldoc/res/source.png) |
is_op_type/2 | True if Atom is an operator of Type. | ![Show source Source](/pldoc/res/source.png) |
is_pi/1 | True if Term is a predicate indicator. | ![Show source Source](/pldoc/res/source.png) |
mode_anchor_name/2 | Get the anchor name for a mode. | ![Show source Source](/pldoc/res/source.png) |
module_info/3 | Add options module(Name) , public(Exports) to OtherOptions if File is a module file. | ![Show source Source](/pldoc/res/source.png) |
multifile/2 | True if Obj is a multifile predicate. | ![Show source Source](/pldoc/res/source.png) |
nopredref/3 | Result of name/arity , non-linking predicate indicator. | ![Show source Source](/pldoc/res/source.png) |
object_edit_button/4 | Create a button for editing Object. | ![Show source Source](/pldoc/res/source.png) |
object_footer/4 | Call the hook doc_object_footer//2. | ![Show source Source](/pldoc/res/source.png) |
object_href/2 | HREF is the URL to access Object. | ![Show source Source](/pldoc/res/source.png) |
object_name/4 | HTML description of documented Obj. | ![Show source Source](/pldoc/res/source.png) |
object_page/4 | Generate an HTML page describing Obj. | ![Show source Source](/pldoc/res/source.png) |
object_page_footer/4 | Call the hook doc_object_page_footer//2. | ![Show source Source](/pldoc/res/source.png) |
object_ref/4 | Create a hyperlink to Object. | ![Show source Source](/pldoc/res/source.png) |
object_source_button/4 | Create a button for showing the source of Object. | ![Show source Source](/pldoc/res/source.png) |
object_synopsis/4 | Provide additional information about Obj. | ![Show source Source](/pldoc/res/source.png) |
object_tree/5 | Render a tree of objects used for navigation. | ![Show source Source](/pldoc/res/source.png) |
objects/4 | Emit the documentation body. | ![Show source Source](/pldoc/res/source.png) |
pred_anchor_name/3 | Create an HTML anchor name from Head. | ![Show source Source](/pldoc/res/source.png) |
pred_dt/5 | Emit the predicate header. | ![Show source Source](/pldoc/res/source.png) |
pred_edit_button/4 | Create a button for editing the given predicate. | ![Show source Source](/pldoc/res/source.png) |
predref/3 | Create a reference to a predicate. | ![Show source Source](/pldoc/res/source.png) |
predref/4 | Create a reference to a predicate. | ![Show source Source](/pldoc/res/source.png) |
print_html_head/1 | Print the DOCTYPE line. | ![Show source Source](/pldoc/res/source.png) |
private/2 | True if Obj is not exported from Options. | ![Show source Source](/pldoc/res/source.png) |
source_button/4 | Add show-source button. | ![Show source Source](/pldoc/res/source.png) |
tag/4 | Called from \tag(Name, Values) terms produced by doc_wiki.pl. | ![Show source Source](/pldoc/res/source.png) |
tags/3 | Emit the @tag tags of a description. | ![Show source Source](/pldoc/res/source.png) |
term/5 | Process the \term element as produced by doc_wiki.pl. | ![Show source Source](/pldoc/res/source.png) |
unquote_filespec/2 | Translate e.g. | ![Show source Source](/pldoc/res/source.png) |
zoom_button/4 | Add zoom in/out button to show/hide the private documentation. | ![Show source Source](/pldoc/res/source.png) |
doc_is_public_object/1 | Hook that allows objects to be displayed with the default public-only view. | |
doc_htmlsrc.pl -- HTML source pretty-printer![Show source Show source](/pldoc/res/source.png) |
source_to_html/3 | Colourise Prolog source as HTML. | ![Show source Source](/pldoc/res/source.png) |
doc_index.pl -- Create indexes![Show source Show source](/pldoc/res/source.png) |
dir_index/4 | Create an index for all Prolog files appearing in Dir or in any directory contained in Dir. | ![Show source Source](/pldoc/res/source.png) |
doc_file_href/2 | Create a /doc HREF from Path. | ![Show source Source](/pldoc/res/source.png) |
doc_for_dir/2 | Write summary index for all files in Dir to Out. | ![Show source Source](/pldoc/res/source.png) |
doc_links/4 | Provide overview links and search facilities. | ![Show source Source](/pldoc/res/source.png) |
file_index_header/4 | Create an entry in a summary-table for File. | ![Show source Source](/pldoc/res/source.png) |
object_summaries/5 | Create entries in a summary table for Objects. | ![Show source Source](/pldoc/res/source.png) |
places_menu/3 | Create a select menu with entries for all loaded directories. | ![Show source Source](/pldoc/res/source.png) |
source_directory/1 | True if Dir is a directory from which we have loaded Prolog sources. | ![Show source Source](/pldoc/res/source.png) |
doc_library.pl -- BIM compatibility layer![Show source Show source](/pldoc/res/source.png) |
doc_load_library/0 | Load the SWI-Prolog library, so we can access all comments from the library. | ![Show source Source](/pldoc/res/source.png) |
doc_man.pl -- Process SWI-Prolog HTML manuals![Show source Show source](/pldoc/res/source.png) |
man_content_tree/2 | Compute the content tree for a multi-file HTML document. | ![Show source Source](/pldoc/res/source.png) |
man_overview/3 | Provide a toplevel overview on the manual: the reference manual and the available packages. | ![Show source Source](/pldoc/res/source.png) |
man_packages_tree/1 | Tree is the content tree of all packages. | ![Show source Source](/pldoc/res/source.png) |
man_page/4 | Produce a Prolog manual page for Obj. | ![Show source Source](/pldoc/res/source.png) |
man_synopsis/4 | Give synopsis details for a fully specified predicate indicator and link this to the section. | ![Show source Source](/pldoc/res/source.png) |
doc_object_href/2 | Produce a HREF for section objects. | ![Show source Source](/pldoc/res/source.png) |
doc_object_link/4 | Provide the HTML to describe Obj for linking purposes. | ![Show source Source](/pldoc/res/source.png) |
doc_modes.pl -- Analyse PlDoc mode declarations![Show source Show source](/pldoc/res/source.png) |
compile_clause/2 | Add a clause to the compiled program. | ![Show source Source](/pldoc/res/source.png) |
compile_mode/2 | Compile a PlDoc mode declararion into a term mode(Head, Determinism) . | ![Show source Source](/pldoc/res/source.png) |
is_mode/1 | True if Head is a valid mode-term. | ![Show source Source](/pldoc/res/source.png) |
mode/2 | True if there is a mode-declaration for Head with Det. | ![Show source Source](/pldoc/res/source.png) |
mode_indicator/1 | Our defined argument-mode indicators. | ![Show source Source](/pldoc/res/source.png) |
modes_to_predicate_indicators/2 | Create a list of predicate indicators represented by Modes. | ![Show source Source](/pldoc/res/source.png) |
process_modes/6 | Process the formal header lines (upto the first blank line), returning the remaining lines and the names of the arguments used in the various header lines. | ![Show source Source](/pldoc/res/source.png) |
doc_pack.pl -- PlDoc for Prolog extension packs![Show source Show source](/pldoc/res/source.png) |
doc_pack/1 | Generate stand-alone documentation for the package Pack. | ![Show source Source](/pldoc/res/source.png) |
doc_process.pl -- Process source documentation![Show source Show source](/pldoc/res/source.png) |
comment_modes/2 | | ![Show source Source](/pldoc/res/source.png) |
doc_clean/1 | Clean documentation for Module. | ![Show source Source](/pldoc/res/source.png) |
doc_comment/4 | True if Comment is the comment describing object. | ![Show source Source](/pldoc/res/source.png) |
doc_file_has_comments/1 | True if we have loaded comments from Source. | ![Show source Source](/pldoc/res/source.png) |
doc_file_name/3 | Doc is the name of the file for documenting Source. | ![Show source Source](/pldoc/res/source.png) |
is_structured_comment/2 | True if Comment is a structured comment that should use Prefixes to extract the plain text using indented_lines/3. | ![Show source Source](/pldoc/res/source.png) |
parse_comment/3 | True when Comment is a structured comment and Parsed is its parsed representation. | ![Show source Source](/pldoc/res/source.png) |
process_comments/3 | Processes comments returned by read_term/3 using the comments option. | ![Show source Source](/pldoc/res/source.png) |
predicate_summary/2 | Provide predicate summaries to the XPCE class prolog_predicate , used by the IDE tools. | ![Show source Source](/pldoc/res/source.png) |
doc_register.pl![Show source Show source](/pldoc/res/source.png) |
doc_search.pl -- Search form and reply![Show source Show source](/pldoc/res/source.png) |
matching_object_table/4 | Show a list of matching objects, similar to a result-set from search. | ![Show source Source](/pldoc/res/source.png) |
search_form/3 | Create a search input field. | ![Show source Source](/pldoc/res/source.png) |
search_reply/4 | Generate a reply searching for For. | ![Show source Source](/pldoc/res/source.png) |
doc_util.pl -- PlDoc utilities![Show source Show source](/pldoc/res/source.png) |
atom_pi/2 | Translate an external predicate indicator representated as an atom into a predicate indicator term. | ![Show source Source](/pldoc/res/source.png) |
atom_to_object/2 | If Atom is `Name/Arity', decompose to Name and Arity. | ![Show source Source](/pldoc/res/source.png) |
ensure_slash_end/2 | Ensure Dir ends with a /. | ![Show source Source](/pldoc/res/source.png) |
expand_alias/2 | Translate an aliased path to a native path. | ![Show source Source](/pldoc/res/source.png) |
insert_alias/2 | Translate a native path to an aliased path. | ![Show source Source](/pldoc/res/source.png) |
normalise_white_space/3 | Text is input after deleting leading and trailing white space and mapping all internal white space to a single space. | ![Show source Source](/pldoc/res/source.png) |
doc_wiki.pl -- PlDoc wiki parser![Show source Show source](/pldoc/res/source.png) |
autolink_extension/2 | True if Ext is a filename extensions that create automatic links in the documentation. | ![Show source Source](/pldoc/res/source.png) |
autolink_file/2 | Files to which we automatically create links, regardless of the extension. | ![Show source Source](/pldoc/res/source.png) |
indented_lines/3 | Extract a list of lines without leading blanks or characters from Prefix from Text. | ![Show source Source](/pldoc/res/source.png) |
section_comment_header/3 | Processes /** <section> comments. | ![Show source Source](/pldoc/res/source.png) |
strip_leading_par/2 | Remove the leading paragraph for environments where a paragraph is not required. | ![Show source Source](/pldoc/res/source.png) |
summary_from_lines/2 | Produce a summary for Lines. | ![Show source Source](/pldoc/res/source.png) |
wiki_codes_to_dom/3 | Translate a plain text into a DOM term. | ![Show source Source](/pldoc/res/source.png) |
wiki_lines_to_dom/3 | Translate a Wiki text into an HTML term suitable for html//1 from the html_write library. | ![Show source Source](/pldoc/res/source.png) |
doc_wiki_face/4 | Hook that can be used to provide additional processing for additional inline wiki constructs. | |
url_expansion_hook/3 | This hook is called after recognising <Alias:Rest> , where Term is of the form Alias(Rest). | |
doc_words.pl -- Reason about Prolog jargon![Show source Show source](/pldoc/res/source.png) |
doc_related_word/3 | True when Related is a word that is related to Term. | ![Show source Source](/pldoc/res/source.png) |
prolog_identifier_part/1 | True if Part appears as part of a Prolog identifier from the documentation. | ![Show source Source](/pldoc/res/source.png) |
man_index.pl -- Index the HTML manuals![Show source Show source](/pldoc/res/source.png) |