- To be done
- Generate a predicate index?
Create stand-alone documentation from a bundle of source-files.
Typical use of the PlDoc package is to run it as a web-server from the
project in progress, providing search and guaranteed consistency with
the loaded version. Creating stand-alone files as provided by this file
can be useful for printing or distribution.
- 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)]).
