protocol
lgtdocp
¶
Documenting tool protocol.
static
Compiling files for generating XML documentation: All source files must be compiled with the
source_data
flag turned on.xml_spec(Specification) option: XML documenting files specification format. Possible option values are
dtd
(DTD specification; default) andxsd
(XML Schema specification).xml_spec_reference(Reference) option: Reference to the XML specification file in XML documenting files. Possible values are
local
(default; DTD/XSD file in same folder as XML files),web
(logtalk.org website DTD/XSD file), andstandalone
(no reference to specification files).entity_xsl_file(File) option: XSLT file to use with generated XML documenting files. Default is
logtalk_entity_to_xml.xsl
, allowing the XML files to be viewed by opening them with a browser supporting XSLT (after running thelgt2xml.sh
script on the output directory).index_xsl_file(File) option: XSLT file to use with generated XML documenting files. Default is
logtalk_index_to_xml.xsl
, allowing the XML files to be viewed by opening them with a browser supporting XSLT (after running thelgt2xml.sh
script on the output directory).xml_docs_directory(Directory) option: Directory where the XML documenting files will be generated. The default value is
./xml_docs
, a sub-directory of the source files directory.bom(Boolean) option: Defines if a BOM should be added to the generated XML documenting files.
encoding(Encoding) option: Encoding to be used for the generated XML documenting files.
omit_path_prefixes(Prefixes) option: List of path prefixes (atoms) to omit when writing directory paths. The default value is to omit the home directory.
exclude_files(List) option: List of files to exclude when generating the XML documenting files.
exclude_paths(List) option: List of (relative) library paths to exclude when generating the XML documenting files.
exclude_entities(List) option: List of entities to exclude when generating the XML documenting files.
sort_predicates(Boolean) option: Sort entity predicates (default is
false
)Known issues: The most appropriated options may depends on the XSL processor you intend to use. Most XSL processors support DTDs but only some of them support XML Schemas. Some processors are buggy an may not work with the default option values.
Public predicates¶
rlibrary/2
¶
Creates XML documenting files for all entities in a library and its sub-libraries using the specified options.
static
rlibrary(Library,Options)
rlibrary(+atom,+list)
- one
rlibrary(tools,[xslfile('lgtmd.xsl')])
yes
rlibrary/1
¶
Creates XML documenting files for all entities in a library and its sub-libraries using default options.
static
rlibrary(Library)
rlibrary(+atom)
- one
lgt2xml
script)rlibrary(tools)
yes
library/2
¶
Creates XML documenting files for all entities in a library using the specified options.
static
library(Library,Options)
library(+atom,+list)
- one
library(library,[xslfile('logtalk_entity_to_pdf_a4.xsl')])
yes
library/1
¶
Creates XML documenting files for all entities in a library using default options.
static
library(Library)
library(+atom)
- one
rdirectory/2
¶
Creates XML documenting files for all entities in a directory and its sub-directories using the specified options.
static
rdirectory(Directory,Options)
rdirectory(+atom,+list)
- one
rdirectory('./tools',[xslfile('lgtmd.xsl')])
yes
rdirectory/1
¶
Creates XML documenting files for all entities in a directory and its sub-directories using default options.
static
rdirectory(Directory)
rdirectory(+atom)
- one
lgt2xml
script)rdirectory('./tools')
yes
directory/2
¶
Creates XML documenting files for all entities in a directory using the specified options.
static
directory(Directory,Options)
directory(+atom,+list)
- one
directory('.',[xslfile('logtalk_entity_to_pdf_a4.xsl')])
yes
directory/1
¶
Creates XML documenting files for all entities in a directory using default options.
static
directory(Directory)
directory(+atom)
- one
file/2
¶
Creates XML documenting files for all entities in a loaded source file using the specified options. The file can be given by name, basename, full path, or using library notation.
static
file(File,Options)
file(+atom,+list)
- one
file/1
¶
Creates XML documenting files for all entities in a loaded source file using default options. The file can be given by name, basename, full path, or using library notation.
static
file(File)
file(+atom)
- one
all/1
¶
Creates XML documenting files for all loaded entities using the specified options.
static
all(File)
all(+list)
- one
all/0
¶
Creates XML documenting files for all loaded entities using default options.
static
all
- one
option/2
¶
Returns, by backtracking, all options and their values.
static
option(Option,Value)
option(?atom,?nonvar)
- zero_or_more
set_option/2
¶
Sets an option value.
static
set_option(Option,Value)
set_option(+atom,+nonvar)
- zero_or_one
Protected predicates¶
(none)
Private predicates¶
(none)