• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

10.4 library(doc_files): Create stand-alone documentation files
All Application Manual Name SummaryHelp

  • Documentation
    • Reference manual
    • Packages
      • SWI-Prolog Source Documentation Version 2
        • Running the documentation system
          • library(doc_files): Create stand-alone documentation files
            • doc_save/2
Availability::- use_module(library(doc_files)).(can be autoloaded)
Sourcedoc_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.
include_reexported(+Boolean)
When true (default false), include predicates that are re-exported from this module into the documentation of the module.
ClioPatria (version V3.1.1-51-ga0b30a5)