Content-type: text/html prolog

prolog

doc-init.pl
doc_http.pl
doc_browser/0Open user's default browser on the documentation server.
doc_server/1Start a documentation server in the current Prolog process.
doc_latex.pl
doc_latex/3Process one or more objects, writing the LaTeX output to OutFile.
latex_for_file/3Generate a LaTeX description of all commented predicates in File, writing the LaTeX text to the stream Out.
latex_for_predicates/3Generate LaTeX for a list of predicate indicators.
latex_for_wiki_file/3Write a LaTeX translation of a Wiki file to the steam Out.
init.pl
pldoc.pl
doc_collect/1Switch collecting comments true/false.
pldoc_loading/0True if we are loading the PlDoc libraries.
doc_access.pl
host_access_options/2Filter the authorization options from AllOptions, leaving the remaining options in NoAuthOptions.
doc_colour.pl
colour_fragments/2Create a list of colour fragments from In.
prolog_src_style/2True if Style is the style to use for displaying an element with the given classification.
doc_files.pl
doc_save/2Save documentation for FileOrDir to file(s).
doc_html.pl
object_href/2HREF is the URL to access Object.
file//1Create a link to another filename if the file exists.
predref//1Create a reference to a predicate.
doc_file_objects/5Extracts relevant information for FileSpec from the PlDoc database.
doc_for_file/2Write documentation for File as HTML.
doc_for_wiki_file/2Write HTML for the File containing wiki data.
doc_hide_private/3Remove the private objects from Objs according to Options.
doc_page_dom/3Create the complete HTML DOM from the Title and Body.
doc_tag_title/2Title is the name to use for Tag in the generated documentation.
doc_write_html/3Write HTML for the documentation page DOM using Title to Out.
existing_linked_file/2True if File is a path to an existing file relative to the current file.
is_op_type/2True if Atom is an operator of Type.
is_pi/1True if Term is a predicate indicator.
module_info/3Add options module(Name), public(Exports) to OtherOptions if File is a module file.
pred_anchor_name/3Create an HTML anchor name from Head.
print_html_head/1Print the DOCTYPE line.
private/2True if Obj is not exported from Options.
edit_button//2Create an edit button for File.
file_header//2Create the file header.
include//3Inline FileName.
object_edit_button//2Create a button for editing Object.
object_page//2Generate an HTML page describing Obj.
object_ref//2Create a hyperlink to Object.
object_source_button//2Create a button for showing the source of Object.
objects//2Emit the documentation body.
pred_edit_button//2Create a button for editing the given predicate.
source_button//2Add show-source button.
tags//1Emit the @tag tags of a description.
term//2Process the \term element as produced by doc_wiki.pl.
doc_htmlsrc.pl
write_source_css/0Create a style-sheet from the style-declarations in doc_colour.pl and the element declaration above.
source_to_html/3Colourise Prolog source as HTML.
doc_index.pl
doc_file_href/2Create a /doc HREF from Path.
doc_for_dir/2Write summary index for all files in Dir to Out.
source_directory/1True if Dir is a directory from which we have loaded Prolog sources.
dir_index//2Create an index for all Prolog files appearing in Dir or in any directory contained in Dir.
doc_links//2Provide overview links and search facilities.
file_index_header//2Create an entry in a summary-table for File.
object_summaries//3Create entries in a summary table for Objects.
doc_man.pl
clean_man_index/0Clean already loaded manual index.
index_man_directory/2Index the HTML directory Dir.
index_man_file/2Collect the documented objects from the SWI-Prolog manual file File.
man_overview//1Provide a toplevel overview on the manual: the reference manual and the available packages.
man_page//2Produce a Prolog manual page for Obj.
doc_modes.pl
compile_clause/2Add a clause to the compiled program.
is_mode/1True if Head is a valid mode-term.
mode/2True if there is a mode-declaration for Head with Det.
mode_indicator/1Our defined argument-mode indicators.
modes_to_predicate_indicators/2Create a list of predicate indicators represented by Modes.
process_modes/6Process 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.
store_modes/2Assert modes into the database with the given position.
doc_process.pl
doc_comment/4True if Comment is the comment describing object.
doc_file_name/3Doc is the name of the file for documenting Source.
is_structured_comment/2True if Comment is a structured comment that should use Prefixes to extract the plain text using indented_lines/3.
process_comments/3Processes comments returned by using the comments option.
read_structured_comments/2Read the structured comments from file.
doc_register.pl
doc_search.pl
search_form//1Create a search input field.
search_reply//2Generate a reply searching for For.
doc_util.pl
ensure_slash_end/2Ensure Dir ends with a /.
expand_alias/2Translate an aliased path to a native path.
insert_alias/2Translate a native path to an aliased path.
doc_wiki.pl
autolink_file/2Files to which we automatically create links, regardless of the extension.
indented_lines/3Extract a list of lines without leading blanks or characters from Prefix from Text.
section_comment_header/3Processes /** <section> comments.
strip_leading_par/2Remove the leading paragraph for environments where a paragraph is not required.
summary_from_lines/2Produce a summary for Lines.
wiki_codes_to_dom/3Translate a plain text into a DOM term.
wiki_lines_to_dom/3Translate a Wiki text into an HTML term suitable for html//1 from the html_write library.
normalise_white_space//1Text is input after deleting leading and trailing white space and mapping all internal white space to a single space.