/usr/lib/swipl/library/doc_files.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • settings.pl -- Setting management
      • error.pl -- Error generating support
      • broadcast.pl -- Event service
      • debug.pl -- Print debug messages and test assertions
      • lists.pl -- List Manipulation
      • pairs.pl -- Operations on key-value lists
      • option.pl -- Option list processing
      • arithmetic.pl -- Extensible arithmetic
      • pldoc.pl -- Process source documentation
      • apply.pl -- Apply predicates on a list
      • operators.pl -- Manage operators
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • time.pl -- Time and alarm library
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • zip.pl -- Access resource ZIP archives
      • uri.pl -- Process URIs
      • socket.pl -- Network socket (TCP and UDP) library
      • thread_pool.pl -- Resource bounded thread management
      • rbtrees.pl -- Red black trees
      • gensym.pl -- Generate unique symbols
      • readutil.pl -- Read utilities
      • url.pl -- Analysing and constructing URL
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • iostream.pl -- Utilities to deal with streams
      • dialect.pl -- Support multiple Prolog dialects
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • ordsets.pl -- Ordered set manipulation
      • oset.pl -- Ordered set manipulation
      • record.pl -- Access compound arguments by name
      • filesex.pl -- Extended operations on files
      • charsio.pl -- I/O on Lists of Character Codes
      • sandbox.pl -- Sandboxed Prolog code
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • when.pl -- Conditional coroutining
      • modules.pl -- Module utility predicates
      • term_to_json.pl
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • solution_sequences.pl -- Modify solution sequences
      • nb_set.pl -- Non-backtrackable sets
      • terms.pl -- Term manipulation
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • sha.pl -- SHA secure hashes
      • random.pl -- Random numbers
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • listing.pl -- List programs and pretty print clauses
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_clause.pl -- Get detailed source-information about a clause
      • occurs.pl -- Finding and counting sub-terms
      • yall.pl -- Lambda expressions
      • prolog_stream.pl -- A stream with Prolog callbacks
      • process.pl -- Create processes and redirect I/O
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • predicate_options.pl -- Access and analyse predicate options
      • lazy_lists.pl -- Lazy list handling
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • doc_http.pl -- Documentation server
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • git.pl -- Run GIT commands
      • crypt.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • unix.pl -- Unix specific operations
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • dicts.pl -- Dict utilities
      • dif.pl -- The dif/2 constraint
      • varnumbers.pl -- Utilities for numbered terms
      • shell.pl -- Elementary shell commands
      • uid.pl -- User and group management on Unix systems
      • syslog.pl -- Unix syslog interface
      • main.pl -- Provide entry point for scripts
      • base32.pl -- Base32 encoding and decoding
      • backcomp.pl -- Backward compatibility
      • system.pl -- System utilities
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • sort.pl
      • statistics.pl -- Get information about resource usage
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_config.pl -- Provide configuration information
      • qsave.pl -- Save current program as a state or executable
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • check.pl -- Consistency checking
      • rdf_parser.pl
      • rewrite.pl
      • quintus.pl -- Quintus compatibility
      • sgml_write.pl -- XML/SGML writer module
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rdf.pl
      • rdf_triple.pl -- Create triples from intermediate representation
      • xsdp_types.pl -- XML-Schema primitive types
      • thread.pl -- High level thread primitives
      • readline.pl -- GNU readline interface
      • c14n2.pl -- C14n2 canonical XML documents
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • double_metaphone.pl -- Phonetic string matching
      • archive.pl -- Access several archive formats
      • threadutil.pl -- Interactive thread utilities
      • pwp.pl -- Prolog Well-formed Pages
      • edit.pl -- Editor interface
      • make.pl -- Reload modified source files
      • explain.pl -- Describe Prolog Terms
      • files.pl
      • help.pl -- Text based manual
      • isub.pl -- isub: a string similarity measure
      • table.pl
      • odbc.pl
      • unicode.pl -- Unicode string handling
      • plunit.pl -- Unit Testing
      • prolog_stack.pl -- Examine the Prolog stack
      • xmldsig.pl -- XML Digital signature
      • xmlenc.pl -- XML encryption library
      • protobufs.pl -- Google's Protocol Buffers
      • streampool.pl -- Input multiplexing
      • paxos.pl -- A Replicated Data Store
      • editline.pl -- BSD libedit based command line editing
      • console_input.pl
      • doc_latex.pl -- PlDoc LaTeX backend
      • cgi.pl -- Read CGI parameters
      • optparse.pl -- command line parsing
      • doc_files.pl -- Create stand-alone documentation files
        • doc_save/2
      • writef.pl -- Old-style formatted write
      • udp_broadcast.pl -- A UDP broadcast proxy
      • rlimit.pl
      • test_cover.pl -- Clause cover analysis
 doc_save(+FileOrDir, +Options)
Save documentation for FileOrDir to file(s). Options include
format(+Format)
Currently only supports html.
doc_root(+Dir)
Save output to the given directory. Default is to save the documentation for a file in the same directory as the file and for a directory in a subdirectory doc.
title(+Title)
Title is an atom that provides the HTML title of the main (index) page. Only meaningful when generating documentation for a directory.
man_server(+RootURL)
Root of a manual server used for references to built-in predicates. Default is http://www.swi-prolog.org/pldoc/
index_file(+Base)
Filename for directory indices. Default is index.
if Condition
What to do with files in a directory. loaded (default) only documents files loaded into the Prolog image. true documents all files.
recursive(+Bool)
If true, recurse into subdirectories.
css(+Mode)
If copy, copy the CSS file to created directories. Using inline, include the CSS file into the created files. Currently, only the default copy is supported.

The typical use-case is to document the Prolog files that belong to a project in the current directory. To do this load the Prolog files and run the goal below. This creates a sub-directory doc with an index file index.html. It replicates the directory structure of the source directory, creating an HTML file for each Prolog file and an index file for each sub-directory. A copy of the required CSS and image resources is copied to the doc directory.

?- doc_save(., [recursive(true)]).