
doc_pack.pl -- PlDoc for Prolog extension packs
This module profiles PlDoc support specific to Prolog extension packs.
It extends the PlDoc web-browser with the ability to lists the installed
packs and provide an overview of a pack, whether loaded or not. The
predicate doc_pack/1 can be used to generate stand-alone HTML
documentation for a pack.
pldoc_pack(+Request)[private]- HTTP handler that handles /pack/ in the PlDoc server. Without an
additional path, it lists the installed packs. With an
additional package name, it lists the content of a pack and
finally, /pack/<pack>/<file> can be used to get documentation or
the source of a pack file.
pack_table(+Options)// is det[private]- Generate a table with installed packages
list_pack(+Pack, +PackFile, +Request)[private]- List a directory or file in a pack
doc_pack(+Pack)- Generate stand-alone documentation for the package Pack. The
documentation is generated in a directory
doc
inside the pack.
The index page consists of the content of readme
or
readme.txt
in the main directory of the pack and an index of
all files and their public predicates.