doc_access.pl |
host_access_options/2 | Filter the authorization options from AllOptions, leaving the remaining options in NoAuthOptions. |  |
doc_colour.pl -- Source colouring support |
colour_fragments/2 | Create a list of colour fragments from In. |  |
doc_html.pl -- PlDoc HTML backend |
cite/3 | Emit citations. |  |
doc_file_objects/5 | Extracts relevant information for FileSpec from the PlDoc database. |  |
doc_for_file/2 | HTTP handler that writes documentation for File as HTML. |  |
doc_for_wiki_file/2 | Write HTML for the File containing wiki data. |  |
doc_hide_private/3 | Remove the private objects from Objs according to Options. |  |
doc_page_dom/3 | Create the complete HTML DOM from the Title and Body. |  |
doc_resources/3 | Include required resources (CSS, JS) into the output. |  |
doc_tag_title/2 | Title is the name to use for Tag in the generated documentation. |  |
doc_write_html/3 | Write HTML for the documentation page DOM using Title to Out. |  |
edit_button/4 | Create an edit button for File. |  |
ensure_doc_objects/1 | Ensure we have documentation about File. |  |
existing_linked_file/2 | True if File is a path to an existing file relative to the current file. |  |
file/3 | Create a link to another filename if the file exists. |  |
file/4 | Create a link to another filename if the file exists. |  |
file_header/4 | Create the file header. |  |
flagref/3 | Reference to a Prolog flag. |  |
include/5 | Inline FileName. |  |
is_op_type/2 | True if Atom is an operator of Type. |  |
is_pi/1 | True if Term is a predicate indicator. |  |
mode_anchor_name/2 | Get the anchor name for a mode. |  |
module_info/3 | Add options module(Name) , public(Exports) to OtherOptions if File is a module file. |  |
multifile/2 | True if Obj is a multifile predicate. |  |
nopredref/3 | Result of name/arity , non-linking predicate indicator. |  |
object_edit_button/4 | Create a button for editing Object. |  |
object_footer/4 | Call the hook doc_object_footer//2. |  |
object_href/2 | HREF is the URL to access Object. |  |
object_name/4 | HTML description of documented Obj. |  |
object_page/4 | Generate an HTML page describing Obj. |  |
object_page_footer/4 | Call the hook doc_object_page_footer//2. |  |
object_ref/4 | Create a hyperlink to Object. |  |
object_source_button/4 | Create a button for showing the source of Object. |  |
object_synopsis/4 | Provide additional information about Obj. |  |
object_tree/5 | Render a tree of objects used for navigation. |  |
objects/4 | Emit the documentation body. |  |
pred_anchor_name/3 | Create an HTML anchor name from Head. |  |
pred_dt/5 | Emit the predicate header. |  |
pred_edit_button/4 | Create a button for editing the given predicate. |  |
predref/3 | Create a reference to a predicate. |  |
predref/4 | Create a reference to a predicate. |  |
print_html_head/1 | Print the DOCTYPE line. |  |
private/2 | True if Obj is not exported from Options. |  |
source_button/4 | Add show-source button. |  |
tag/4 | Called from \tag(Name, Values) terms produced by doc_wiki.pl. |  |
tags/3 | Emit the @tag tags of a description. |  |
term/5 | Process the \term element as produced by doc_wiki.pl. |  |
unquote_filespec/2 | Translate e.g. |  |
zoom_button/4 | Add zoom in/out button to show/hide the private documentation. |  |
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 |
source_to_html/3 | Colourise Prolog source as HTML. |  |
doc_index.pl -- Create indexes |
dir_index/4 | Create an index for all Prolog files appearing in Dir or in any directory contained in Dir. |  |
doc_file_href/2 | Create a /doc HREF from Path. |  |
doc_for_dir/2 | Write summary index for all files in Dir to Out. |  |
doc_links/4 | Provide overview links and search facilities. |  |
file_index_header/4 | Create an entry in a summary-table for File. |  |
object_summaries/5 | Create entries in a summary table for Objects. |  |
places_menu/3 | Create a select menu with entries for all loaded directories. |  |
source_directory/1 | True if Dir is a directory from which we have loaded Prolog sources. |  |
doc_library.pl -- BIM compatibility layer |
doc_man.pl -- Process SWI-Prolog HTML manuals |
man_content_tree/2 | Compute the content tree for a multi-file HTML document. |  |
man_overview/3 | Provide a toplevel overview on the manual: the reference manual and the available packages. |  |
man_packages_tree/1 | Tree is the content tree of all packages. |  |
man_page/4 | Produce a Prolog manual page for Obj. |  |
man_synopsis/4 | Give synopsis details for a fully specified predicate indicator and link this to the section. |  |
doc_object_href/2 | Produce a HREF for section objects. |  |
doc_object_link/4 | Provide the HTML to describe Obj for linking purposes. |  |
doc_modes.pl -- Analyse PlDoc mode declarations |
compile_clause/2 | Add a clause to the compiled program. |  |
compile_mode/2 | Compile a PlDoc mode declararion into a term mode(Head, Determinism) . |  |
is_mode/1 | True if Head is a valid mode-term. |  |
mode/2 | True if there is a mode-declaration for Head with Det. |  |
mode_indicator/1 | Our defined argument-mode indicators. |  |
modes_to_predicate_indicators/2 | Create a list of predicate indicators represented by Modes. |  |
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. |  |
doc_pack.pl -- PlDoc for Prolog extension packs |
doc_pack/1 | Generate stand-alone documentation for the package Pack. |  |
doc_process.pl -- Process source documentation |
doc_register.pl |
comment_hook/3 | Hook called by the compiler and cross-referencer. |  |
doc_search.pl -- Search form and reply |
matching_object_table/4 | Show a list of matching objects, similar to a result-set from search. |  |
search_form/3 | Create a search input field. |  |
search_reply/4 | Generate a reply searching for For. |  |
doc_util.pl -- PlDoc utilities |
doc_wiki.pl -- PlDoc wiki parser |
autolink_extension/2 | True if Ext is a filename extensions that create automatic links in the documentation. |  |
autolink_file/2 | Files to which we automatically create links, regardless of the extension. |  |
indented_lines/3 | Extract a list of lines without leading blanks or characters from Prefix from Text. |  |
section_comment_header/3 | Processes /** <section> comments. |  |
strip_leading_par/2 | Remove the leading paragraph for environments where a paragraph is not required. |  |
summary_from_lines/2 | Produce a summary for Lines. |  |
wiki_codes_to_dom/3 | Translate a plain text into a DOM term. |  |
wiki_lines_to_dom/3 | Translate a Wiki text into an HTML term suitable for html//1 from the html_write library. |  |
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 |
doc_related_word/3 | True when Related is a word that is related to Term. |  |
prolog_identifier_part/1 | True if Part appears as part of a Prolog identifier from the documentation. |  |
man_index.pl -- Index the HTML manuals |
check_duplicate_ids/0 | Maintenance utility to check that we do not have duplicate section identifiers in the documentation. |  |
clean_man_index/0 | Clean already loaded manual index. |  |
current_man_object/1 | |  |
doc_object_identifier/2 | True when Identifier is the name of DocObject. |  |
index_man_directory/2 | Index the HTML directory Dir. |  |
index_man_file/2 | Collect the documented objects from the SWI-Prolog manual file File. |  |
man_object_property/2 | True when Property is a property of the given manual object. |  |
manual_object/5 | True if Object is documented. |  |
save_man_index/0 | Create swi('doc/manindex.db'), containing an index into the HTML manuals for use with help/1 and similar predicates. |  |