| Constant summary | |
|---|---|
| +default-charset+ | "ISO-8859-1" |
| +html-doctype+ | "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">" |
| Class summary | |
|---|---|
| html | inherits from driver |
| Method summary | |
|---|---|
| charset | html |
| css-pathname | html |
| doc-formater | html |
| filter | html |
| find-inheritence-word | symbol-descriptor |
| href-title | symbol-descriptor |
| html-printable-type | symbol-descriptor |
| sort-predicate | html |
| toc-title | html |
| Function summary | |
|---|---|
| alphabetical-order | desc1 desc2 |
| copy-css | html-driver &key dest-dir |
| default-filter | desc |
| default-sort-predicate | desc1 desc2 |
| desc-sort | descs predicate &key key |
| filter-defmethod-with-defgeneric | desc |
| find-descs | desc-type descs |
| format-doc | symdesc html-driver strings |
| format-inheritence | structured-object-descriptor |
| get-defpackage-descriptor | meta-descriptors package-table |
| get-descriptors-by-package | html-driver mdescriptors package-table |
| get-initargs | initargs &optional (default-initargs '(:copy-css-into-output-dir :filter :sort-predicate :charset :table-of-contents-title :doc-formater :css-pathname)) |
| htmlify-doc | desc &key (doc-string (doc desc)) (purge-p t) html-driver |
| make-abc-index-entry | filename &key char-code non-alphabetic |
| make-class-summary | descs filter |
| make-constant-summary | descs filter |
| make-default-css-namestring | |
| make-footer | |
| make-function-summary | descs filter |
| make-html-doc | hdriver filenames &key (dest-dir ".") path-prefix |
| make-index-entry | meta-descriptors &key char-code non-alphabetic filter |
| make-indexes | dest-dir html-driver |
| make-navbar | &key index next prev name |
| make-summary | summary-title descs filter &key key |
| make-toc | html-driver dest-dir package-index-files |
| next | list index dest-dir &optional prefix |
| prev | list index dest-dir &optional prefix |
| resolve-link | symdesc strings |
| symbol-descriptor-weight | sym-desc-instance |
| toc-path-from | from dest-dir |
| write-index | filename dest-dir title html-driver meta-descriptors |
| Macro summary | |
|---|---|
| html-write | control-string &rest args |
| with-gensym | symbols &body body |
| with-html-description | (&key (divclass "defun") name arg-list type anchor) &body body |
| with-html-output | (output-stream) &body body |
| with-html-page | (os &key csshref content-type head-title nav-name index prev next) &body body |
| with-index-header | (index hdriver dest-dir title &key (head-title title)) &body body |
| with-tag | (tagname (&rest attributes) &optional (stream '*html-output-stream*)) &body body |
| html | inherits from driver | [Class] |
CLDOC XHTML 1.0 Strict driver.
Use the following options with extract-documentation to customize the produced output:
:toc-title (or null string): a string that will be used as a title in the table of contents. If not given then the toc title will be: Table of Contents.
:doc-formater (function): a designator for a function of two arguments. Its first arguments will be an html-driver instance and its second argument will be a list of string that represents each lines of the original documentation string. It is expected that this function will output the strings, using the html machinery.
The default doc-formater has some simple DWIM (Do What I Mean) capabilities. It recognizes both indent and empty-line paragraph breaks, bulleted lists, code sample, hyper link and sections (like in the Hyperspec). The default format-doc function delegates the DWIM capabilities to the doctree class.
:filter (or null function): a designator for a function of one argument. Its argument will be a symbol-descriptor object. The symbol-descriptor will be outputted if and only if this function returns NIL.
:sort-predicate (or null function): a designator for a function of two arguments that returns a generalized boolean.
Predicate should return true if and only if the first argument is strictly less than the second (in some appropriate sense). If the first argument is greater than or equal to the second (in the appropriate sense), then the predicate should return false.
:css-pathname (string): a string pathname designator for the css file to use in the generated documentation. The default one is the cludg.css file delivered with this driver.
:charset (string): a string designator for the charset of the generated documentation. The default one is: +default-charset+
:copy-css-into-output-dir (boolean): if you want the css file to be copied in the destination directory. This will allow your created documentation to be completely independent of your hard drive hierarchy. Otherwise relative reference to the given pathname will be generated. Default is set to T. And if :css-pathname is not specified the file delivered with CLDOC will simply be copied into the output directory (see :css-pathname).
All the options supported by the doctree class are supported when passed to the extract-documentation method.
To localise the automatic documentation , if your documentation strings are not in english, the default generation language, you have to modify the following variables:
*class-inheritence*
*condition-inheritence*
*struct-inheritence*
*slot-reader-control-string*
*slot-writer-control-string*
*slot-accessor-control-string*
*copier-control-string*
*predicate-control-string*
*printer-control-string*
*constructor-control-string*
| :string-parser-initargs | [Initarg] |
| :doc-formater | [Initarg] |
| :filter | [Initarg] |
| :sort-predicate | [Initarg] |
| :css-pathname | [Initarg] |
| :charset | [Initarg] |
| :copy-css-into-output-dir | [Initarg] |
| :table-of-contents-title | [Initarg] |
Defclass inheritence indication control string for automatic documentation.
This control string has no parameter.
Define-condition inheritence indication control string for automatic documentation. This control string has no parameter.
Defstruct include indication control string for automatic documentation.
This control string has no parameter.
Returns a string for the title attribute of an href.
Returns an HTML string that will be used to instead of the desc-type. If such a overload is not found the value returned by desc-type will be used.
Returns an HTML string that will be used to instead of the desc-type. If such a overload is not found the value returned by desc-type will be used.
Returns true if the given symbol-descriptor is not an external symbol of its package or if is a defmethod descriptor for which a defgeneric descriptor exists.
Returns true if the given symbol-descriptor is a defmethod descriptor and thus if the specified defmethod has a defgeneric.
Returns the weight, a valuation, used to sort the final documentation.
Sort such as stable-sort but non destructively the given list of descs.
Returns the relative pathanme to the next (aka 1+ index) element of list.
Returns the relative pathanme to previous (aka 1- index) element of list.
Returns true if the name of the first descriptor is lexicographicaly inferior to the name of the second descriptor.
Presents the given doc-string according to our html template.
doc-string (string): the documentation string to write.
purge-p (boolean): If T the documentation string will be purged of potentially dangerous character for HTML.
html-driver (driver): the html-driver to use.
Writes the table of contents. Returns the file truename of the table of contents.
Finds all the defpackage-descriptor and insert them in the package-table.
Finds all descriptors of each package and add them to their package entry of the package-table. Descriptors will be filtered according to the filter of the html-driver instance.
Creates package index files, global index and table of contents.
Returns the list of symbol descriptors that are of type desc-type.
Creates a summary table with the given descriptors. The created table will have two columns. The first one will present hyper link with the descriptor name and the second one the summary as returned by the :key function. Descriptor list will be filtered according to the filter function when provided. The :key argument is a designator for a function of one argument of type symbol-descriptor and returns a string.
Creates a summary table for defconstant descriptors if any.
Creates summary tables for defclass, define-condition and defstruct descriptors if any.
Creates summary tables for defun, defsetf, defmethod, defgeneric and defmacro descriptors if any.
Default documentation string formater. The Do What I Mean capabilities are delegated to the create-doctree-from-string method of the doctree protocol in coordination with with-tree-loop iterator to produced the final output.
Reads all files specified in filenames and extract their documentation using HTML as output. The extracted documentation will be written in a newly created file with the same name as the processed one. If dest-dir is specified then it will be used to construct the output pathname, otherwise the output pathname will be constructed using the one of the currently processed input file pruned from path-prefix.
Resolves the inheritence/inclusion of structured-object-descriptor in order to return an HTML string that describes the inheritence with hyper links.
Binds *html-output-stream* to the output-stream in order to use the html-write, with-tag, htmlify-doc and with-html-description macros without their output-stream optional argument.
Produces formatted output by outputting the characters of control-string and observing that a tilde introduces a directive. Most directives use one or more elements of args to create their output.
Writes the desired tag and its attributes to the given stream or the one binded on *html-output-stream*.
| with-html-page | (os &key csshref content-type head-title nav-name index prev next) &body body | [Macro] |
Binds *html-output-stream* to os as if binded by with-html-output and executes the body in inside the BODY tag. A simple implementation can be:
(with-tag (:html ())
(with-tag (:head ()) (do-header))
(with-tag (:body ()) ,@body))
Presents lisp forms according to our html documentation template.