|Did you know ...||Search Documentation:|
|library(doc_files): Create stand-alone documentation files|
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.
file(s). Options include
loaded(default) only documents files loaded into the Prolog image.
truedocuments all files.
true, recurse into subdirectories.
copy, copy the CSS file to created directories. Using
inline, include the CSS file into the created files. Currently, only the default
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
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_save(., [recursive(true)]).
docinside the pack. The index page consists of the content of
readme.txtin the main directory of the pack and an index of all files and their public predicates.