pldoc

Prolog files

doc_access.plShow source
doc_colour.pl  -- Source colouring supportShow source
doc_html.pl  -- PlDoc HTML backendShow source
doc_htmlsrc.pl  -- HTML source pretty-printerShow source
source_to_html/3Colourise Prolog source as HTML.Source
doc_index.pl  -- Create indexesShow source
dir_index/4Create an index for all Prolog files appearing in Dir or in any directory contained in Dir.Source
doc_file_href/2Create a /doc HREF from Path.Source
doc_for_dir/2Write summary index for all files in Dir to Out.Source
doc_links/4Provide overview links and search facilities.Source
file_index_header/4Create an entry in a summary-table for File.Source
object_summaries/5Create entries in a summary table for Objects.Source
places_menu/3Create a select menu with entries for all loaded directories.Source
source_directory/1True if Dir is a directory from which we have loaded Prolog sources.Source
doc_man.pl  -- Process SWI-Prolog HTML manualsShow source
doc_modes.pl  -- Analyse PlDoc mode declarationsShow source
doc_pack.pl  -- PlDoc for Prolog extension packsShow source
doc_process.pl  -- Process source documentationShow source
doc_register.plShow source
doc_search.pl  -- Search form and replyShow source
matching_object_table/4Show a list of matching objects, similar to a result-set from search.Source
search_form/3Create a search input field.Source
search_reply/4Generate a reply searching for For.Source
doc_util.pl  -- PlDoc utilitiesShow source
doc_wiki.pl  -- PlDoc wiki parserShow source
autolink_extension/2True if Ext is a filename extensions that create automatic links in the documentation.Source
autolink_file/2Files to which we automatically create links, regardless of the extension.Source
indented_lines/3Extract a list of lines without leading blanks or characters from Prefix from Text.Source
section_comment_header/3Processes /** <section> comments.Source
strip_leading_par/2Remove the leading paragraph for environments where a paragraph is not required.Source
summary_from_lines/2Produce a summary for Lines.Source
wiki_codes_to_dom/3Translate a plain text into a DOM term.Source
wiki_lines_to_dom/3Translate a Wiki text into an HTML term suitable for html//1 from the html_write library.Source
doc_wiki_face/4Hook that can be used to provide additional processing for additional inline wiki constructs.
url_expansion_hook/3This hook is called after recognising <Alias:Rest>, where Term is of the form Alias(Rest).
doc_words.pl  -- Reason about Prolog jargonShow source
doc_related_word/3True when Related is a word that is related to Term.Source
prolog_identifier_part/1True if Part appears as part of a Prolog identifier from the documentation.Source
man_index.pl  -- Index the HTML manualsShow source
check_duplicate_ids/0Maintenance utility to check that we do not have duplicate section identifiers in the documentation.Source
clean_man_index/0Clean already loaded manual index.Source
current_man_object/1Source
doc_object_identifier/2True when Identifier is the name of DocObject.Source
index_man_directory/2Index the HTML directory Dir.Source
index_man_file/2Collect the documented objects from the SWI-Prolog manual file File.Source
man_object_property/2True when Property is a property of the given manual object.Source
manual_object/5True if Object is documented.Source
save_man_index/0Create swi('doc/manindex.db'), containing an index into the HTML manuals for use with help/1 and similar predicates.Source