Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the ccldoc Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:55:43 2020 GMT+0.
• Introduction | What ccldoc is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
CCLDoc is a system for creating Lisp documentation. It uses S-expressions to represent document structure, markup, cross references, and contents. It has a small number of basic operators, supports macros for syntax extensions, and supports a simple syntax for embedding expressions in strings for added convenience.
The documentation for Clozure CL is written in CCLDoc.
To use CCLDoc to format the CCL documentation, follow these steps:
Now, start CCL, and do the following:
(load "home:quicklisp;setup")
(ql:quickload :ccldoc)
(defparameter *d* (ccldoc:load-document "ccl:doc;manual;ccl.ccldoc"))
(ccldoc::output-html *d* "/tmp/ccl.html" :stylesheet "ccl.css")
You can then view the generated ccl.html file in your browser. The generated HTML expects to use a style file named ccl.css in the same directory.
There is also a not-quite-complete LaTeX converter. To use it, do (output-latex *d* "ccl.tex")
and then process the ccl.tex file with xelatex to produce a PDF file. The version of xelatex that comes with MacTeX 2014 works.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The ccldoc system |
Clozure Associates and contributors
Apache License 2.0
create lisp documentation using s-expressions
ccldoc.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The ccldoc/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
ccldoc.asd
ccldoc (system)
Next: The ccldoc/utils․lisp file, Previous: The ccldoc․asd file, Up: Lisp files [Contents][Index]
Next: The ccldoc/representation․lisp file, Previous: The ccldoc/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
ccldoc (system)
utils.lisp
Next: The ccldoc/toplevel․lisp file, Previous: The ccldoc/utils․lisp file, Up: Lisp files [Contents][Index]
utils.lisp (file)
ccldoc (system)
representation.lisp
Next: The ccldoc/syntax․lisp file, Previous: The ccldoc/representation․lisp file, Up: Lisp files [Contents][Index]
representation.lisp (file)
ccldoc (system)
toplevel.lisp
Next: The ccldoc/output-docbook․lisp file, Previous: The ccldoc/toplevel․lisp file, Up: Lisp files [Contents][Index]
toplevel.lisp (file)
ccldoc (system)
syntax.lisp
Next: The ccldoc/output-tracwiki․lisp file, Previous: The ccldoc/syntax․lisp file, Up: Lisp files [Contents][Index]
syntax.lisp (file)
ccldoc (system)
output-docbook.lisp
output-docbook (function)
Next: The ccldoc/output-html․lisp file, Previous: The ccldoc/output-docbook․lisp file, Up: Lisp files [Contents][Index]
output-docbook.lisp (file)
ccldoc (system)
output-tracwiki.lisp
output-tracwiki (function)
Next: The ccldoc/output-latex․lisp file, Previous: The ccldoc/output-tracwiki․lisp file, Up: Lisp files [Contents][Index]
output-tracwiki.lisp (file)
ccldoc (system)
output-html.lisp
output-html (function)
Next: The ccldoc/output-ccldoc․lisp file, Previous: The ccldoc/output-html․lisp file, Up: Lisp files [Contents][Index]
output-html.lisp (file)
ccldoc (system)
output-latex.lisp
Previous: The ccldoc/output-latex․lisp file, Up: Lisp files [Contents][Index]
output-latex.lisp (file)
ccldoc (system)
output-ccldoc.lisp
output-ccldoc (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The ccldoc package |
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported structures | ||
• Exported classes | ||
• Exported types |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
utils.lisp (file)
toplevel.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
representation.lisp (file)
representation.lisp (file)
toplevel.lisp (file)
output-ccldoc.lisp (file)
output-docbook.lisp (file)
output-html.lisp (file)
output-tracwiki.lisp (file)
Next: Exported structures, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated writer method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
utils.lisp (file)
structure-object (structure)
(satisfies ccldoc::dspec-type-name-p)
t
dspec-type (function)
(setf dspec-type) (function)
dspec-name (function)
(setf dspec-name) (function)
Next: Exported types, Previous: Exported structures, Up: Exported definitions [Contents][Index]
representation.lisp (file)
standard-object (class)
(or null ccldoc:clause-object)
ccldoc::*parent-clause*
clause-parent (generic function)
(setf clause-parent) (generic function)
ccldoc::*source-form*
clause-source-form (generic function)
representation.lisp (file)
clause-object (class)
(or null ccldoc:clause)
clause-body (generic function)
(setf clause-body) (generic function)
representation.lisp (file)
clause-object (class)
vector
clause-items (generic function)
representation.lisp (file)
clause-object (class)
(or null ccldoc:clause)
:term
clause-term (generic function)
representation.lisp (file)
clause-object (class)
:title
clause-title (generic function)
representation.lisp (file)
clause-with-body (class)
representation.lisp (file)
ccldoc:clause
definition-display-name (generic function)
(setf definition-display-name) (generic function)
ccldoc:clause
definition-signature (generic function)
(setf definition-signature) (generic function)
(or null ccldoc:clause)
definition-summary (generic function)
(setf definition-summary) (generic function)
representation.lisp (file)
clause-object (class)
:message
clause-text (generic function)
representation.lisp (file)
section (class)
null
(make-hash-table :test (function equalp))
named-clauses (generic function)
(make-hash-table :test (function equal))
external-ids (generic function)
representation.lisp (file)
section (class)
representation.lisp (file)
representation.lisp (file)
section (class)
null
representation.lisp (file)
:class
(ccldoc::op-name :index)
default-operator (generic function)
representation.lisp (file)
clause-with-body (class)
term-item (class)
representation.lisp (file)
string
:url
link-url (generic function)
representation.lisp (file)
clause-with-items (class)
ccldoc:listing-type
:type
listing-type (generic function)
representation.lisp (file)
ccldoc:markup-type
:type
markup-type (generic function)
representation.lisp (file)
clause-object (class)
:name
clause-name (generic function)
(setf clause-name) (generic function)
string
clause-external-id (generic function)
(setf clause-external-id) (generic function)
representation.lisp (file)
clause-with-body (class)
representation.lisp (file)
clause-with-items (class)
representation.lisp (file)
:class
(ccldoc::op-name :defsection)
default-operator (generic function)
:package
representation.lisp (file)
representation.lisp (file)
:class
(ccldoc::op-name :item)
default-operator (generic function)
representation.lisp (file)
representation.lisp (file)
indexed-clause (class)
:class
(ccldoc::op-name :ref)
default-operator (generic function)
:default-body
xref-default-body (generic function)
ccldoc:named-clause
:target
xref-target (generic function)
Previous: Exported classes, Up: Exported definitions [Contents][Index]
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
utils.lisp (file)
output-ccldoc.lisp (file)
representation.lisp (file)
utils.lisp (file)
output-ccldoc.lisp (file)
output-tracwiki.lisp (file)
toplevel.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
utils.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
utils.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
utils.lisp (file)
output-tracwiki.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
toplevel.lisp (file)
utils.lisp (file)
representation.lisp (file)
representation.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
output-tracwiki.lisp (file)
representation.lisp (file)
utils.lisp (file)
syntax.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
output-html.lisp (file)
syntax.lisp (file)
output-ccldoc.lisp (file)
utils.lisp (file)
utils.lisp (file)
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
SYS:SRC;CODE;SEQ.LISP (not found)
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
SYS:SRC;CODE;SEQ.LISP (not found)
output-ccldoc.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
representation.lisp (file)
syntax.lisp (file)
toplevel.lisp (file)
syntax.lisp (file)
output-ccldoc.lisp (file)
utils.lisp (file)
output-docbook.lisp (file)
output-ccldoc.lisp (file)
utils.lisp (file)
output-html.lisp (file)
utils.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
representation.lisp (file)
representation.lisp (file)
toplevel.lisp (file)
syntax.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
output-ccldoc.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
output-latex.lisp (file)
utils.lisp (file)
syntax.lisp (file)
toplevel.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
utils.lisp (file)
toplevel.lisp (file)
utils.lisp (file)
output-ccldoc.lisp (file)
syntax.lisp (file)
syntax.lisp (file)
utils.lisp (file)
representation.lisp (file)
toplevel.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
utils.lisp (file)
representation.lisp (file)
representation.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-latex.lisp (file)
output-tracwiki.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
output-ccldoc.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
toplevel.lisp (file)
automatically generated reader method
representation.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
output-docbook.lisp (file)
representation.lisp (file)
automatically generated reader method
representation.lisp (file)
syntax.lisp (file)
automatically generated reader method
representation.lisp (file)
representation.lisp (file)
representation.lisp (file)
append (short method combination)
Options: :most-specific-first
syntax.lisp (file)
syntax.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-html.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-latex.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
output-tracwiki.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
representation.lisp (file)
clause-with-title (class)
text-block (class)
(or null string)
representation.lisp (file)
clause-with-body (class)
link (class)
ccldoc:clause
representation.lisp (file)
clause-reference-name (method)
string
representation.lisp (file)
clause-object (class)
inline-clause-p (method)
representation.lisp (file)
indexed-clause (class)
:class
(ccldoc::op-name :ref)
default-operator (generic function)
:default-body
clause-default-body (generic function)
:name
placeholder-target-name (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
A B C D E F G H I L M N O P R S T W X |
---|
Jump to: | %
(
A B C D E F G H I L M N O P R S T W X |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
B C D E I L M N P S T U |
---|
Jump to: | *
B C D E I L M N P S T U |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C D G I L M N P R S T X |
---|
Jump to: | C D G I L M N P R S T X |
---|