This is the codex Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Apr 15 04:45:40 2025 GMT+0.
codex-templates/templates/static/nodes.csscodex-templates/templates/static/reset.csscodex-templates/templates/minima/base.htmlcodex-templates/templates/minima/document.htmlcodex-templates/templates/minima/section.htmlcodex-templates/templates/minima/style.csscodex-templates/templates/gamma/base.htmlcodex-templates/templates/gamma/document.htmlcodex-templates/templates/gamma/section.htmlcodex-templates/templates/gamma/style.csscodex-templates/templates/traditional/base.htmlcodex-templates/templates/traditional/document.htmlcodex-templates/templates/traditional/section.htmlcodex-templates/templates/traditional/style.cssThe main system appears first, followed by any subsystem dependency.
codexA documentation system for Common Lisp.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:CommonDoc/codex.git)
MIT
# Codex
[](https://travis-ci.org/CommonDoc/codex)
[](https://coveralls.io/r/CommonDoc/codex?branch=master)
A documentation system for Common Lisp.
# Overview
**Codex** generates documentation. You just write docstrings as usual, only
using [Scriba][scriba] syntax, append a couple of extra files (A few tutorials
and what have you), and Codex creates beautiful online documentation, and in the
near future, PDF manuals.
See the [documentation][docs]
# License
Copyright (c) 2014-2015 Fernando Borretti
Licensed under the MIT License.
[scriba]: https://github.com/CommonDoc/scriba
[docs]: http://commondoc.github.io/codex/docs/overview.html
0.2
docparser (system).
common-doc (system).
common-doc-contrib (system).
pandocl (system).
codex-templates (system).
cl-slug (system).
cl-ppcre (system).
alexandria (system).
src (module).
codex-templatesTemplates for Codex.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
MIT
0.1
common-html (system).
djula (system).
cl-fad (system).
trivial-types (system).
templates (module).
Modules are listed depth-first from the system components tree.
codex/srccodex-templates/templatescodex-templates/templates/staticcodex-templates/templates/minimacodex-templates/templates/gammacodex-templates/templates/traditionalcodex/srccodex (system).
error.lisp (file).
markup.lisp (file).
manifest.lisp (file).
macro.lisp (file).
codex.lisp (file).
quickstart.lisp (file).
codex-templates/templatescodex-templates (system).
templates.lisp (file).
static (module).
minima (module).
gamma (module).
traditional (module).
codex-templates/templates/statictemplates.lisp (file).
templates (module).
codex-templates/templates/minimastatic (module).
templates (module).
base.html (file).
document.html (file).
section.html (file).
style.css (file).
codex-templates/templates/gammaminima (module).
templates (module).
base.html (file).
document.html (file).
section.html (file).
style.css (file).
codex-templates/templates/traditionalgamma (module).
templates (module).
base.html (file).
document.html (file).
section.html (file).
style.css (file).
Files are sorted by type and then listed depth-first from the systems components trees.
codex/codex.asdcodex-templates/codex-templates.asdcodex/src/error.lispcodex/src/markup.lispcodex/src/manifest.lispcodex/src/macro.lispcodex/src/codex.lispcodex/src/quickstart.lispcodex-templates/templates/templates.lispcodex-templates/codex-templates.asdcodex-templates (system).
codex/src/error.lispsrc (module).
codex-error (condition).
format-name (reader method).
manifest-error (condition).
message (reader method).
message (reader method).
no-docstring (condition).
node (reader method).
system-name (reader method).
template-error (condition).
template-name (reader method).
unsupported-output-format (condition).
codex/src/markup.lisperror.lisp (file).
src (module).
*current-markup-format* (special variable).
parse-string (function).
codex/src/manifest.lispmarkup.lisp (file).
src (module).
*default-manifest-pathname* (special variable).
document (class).
document-authors (reader method).
document-output-format (reader method).
document-sources (reader method).
document-title (reader method).
html (class).
manifest (class).
manifest-documents (reader method).
manifest-markup-format (reader method).
manifest-systems (reader method).
multi-html (class).
output-format (class).
output-html-template (reader method).
output-html-template-options (reader method).
parse-manifest (function).
single-html (class).
system-manifest-pathname (function).
parse-document (function).
parse-output-format (function).
read-manifest (function).
codex/src/macro.lispmanifest.lisp (file).
src (module).
*index* (special variable).
cl-doc (class).
expand-macro (method).
expand-macro (method).
expand-macro (method).
expand-macro (method).
param (class).
spec (class).
with-package (class).
*current-package-name* (special variable).
+type-name-to-class-map+ (special variable).
check-node-docstring (function).
docstring-node (function).
expand-node (generic function).
expand-operator-node (function).
expand-record-node (function).
find-node (function).
find-node-type-by-name (function).
list-to-code-node (function).
make-class-metadata (function).
make-doc-node (function).
name-node (method).
no-method-found (function).
no-method-lambda-list (function).
no-such-type (function).
node-not-found (function).
package-macro-name (reader method).
slot-exists-and-bound-p (function).
url-for-symbol (function).
write-to-code-node (function).
codex/src/codex.lispmacro.lisp (file).
src (module).
*skip-undocumented* (special variable).
document (function).
*undocumented-list* (special variable).
build-document (function).
build-manifest (function).
copy-images (function).
load-document (function).
print-undocumented (function).
undocumented-handler (function).
codex/src/quickstart.lispcodex.lisp (file).
src (module).
quickstart (function).
+manifest-template+ (special variable).
+manual-template+ (special variable).
clean-author-name (function).
codex-templates/templates/templates.lisptemplates (module).
*template-database* (special variable).
built-in-template (class).
codex-template (class).
find-template (function).
initialize-instance (method).
render (method).
render-section (method).
+templates-directory+ (special variable).
append-mathjax-fonts (function).
define-built-in-template (macro).
document-template (generic function).
gamma (class).
minima (class).
options (reader method).
output-directory (reader method).
section-template (generic function).
static-files (generic function).
static-output-directory (function).
template-pathname (function).
codex-templates/templates/static/nodes.csscodex-templates/templates/static/reset.csscodex-templates/templates/minima/base.htmlcodex-templates/templates/minima/document.htmlcodex-templates/templates/minima/section.htmlcodex-templates/templates/minima/style.csscodex-templates/templates/gamma/base.htmlcodex-templates/templates/gamma/document.htmlcodex-templates/templates/gamma/section.htmlcodex-templates/templates/gamma/style.csscodex-templates/templates/traditional/base.htmlcodex-templates/templates/traditional/document.htmlcodex-templates/templates/traditional/section.htmlcodex-templates/templates/traditional/style.csscodex-templates/templates/traditional/base.htmltraditional (module).
codex-templates/templates/traditional/document.htmltraditional (module).
codex-templates/templates/traditional/section.htmltraditional (module).
codex-templates/templates/traditional/style.csstraditional (module).
Packages are listed by definition order.
codex.manifestParsing Codex manifest files.
common-lisp.
*default-manifest-pathname* (special variable).
document (class).
document-authors (generic reader).
document-output-format (generic reader).
document-sources (generic reader).
document-title (generic reader).
html (class).
manifest (class).
manifest-documents (generic reader).
manifest-markup-format (generic reader).
manifest-systems (generic reader).
multi-html (class).
output-format (class).
output-html-template (generic reader).
output-html-template-options (generic reader).
parse-manifest (function).
single-html (class).
system-manifest-pathname (function).
parse-document (function).
parse-output-format (function).
read-manifest (function).
codex.macroCommonDoc macros for Codex.
common-lisp.
*index* (special variable).
cl-doc (class).
param (class).
spec (class).
with-package (class).
*current-package-name* (special variable).
+type-name-to-class-map+ (special variable).
check-node-docstring (function).
docstring-node (function).
expand-node (generic function).
expand-operator-node (function).
expand-record-node (function).
find-node (function).
find-node-type-by-name (function).
list-to-code-node (function).
make-class-metadata (function).
make-doc-node (function).
name-node (generic function).
no-method-found (function).
no-method-lambda-list (function).
no-such-type (function).
node-not-found (function).
package-macro-name (generic reader).
slot-exists-and-bound-p (function).
url-for-symbol (function).
write-to-code-node (function).
codex.markupParsing files and docstrings.
common-lisp.
*current-markup-format* (special variable).
parse-string (function).
codex.errorCodex errors.
common-lisp.
codex-error (condition).
format-name (generic reader).
manifest-error (condition).
message (generic reader).
no-docstring (condition).
node (generic reader).
system-name (generic reader).
template-error (condition).
template-name (generic reader).
unsupported-output-format (condition).
codex-manifest-userThe package in which Codex manifests are read.
codex.manifest.
common-lisp.
codexThe main interface.
common-lisp.
*skip-undocumented* (special variable).
document (function).
quickstart (function).
*undocumented-list* (special variable).
+manifest-template+ (special variable).
+manual-template+ (special variable).
build-document (function).
build-manifest (function).
clean-author-name (function).
copy-images (function).
load-document (function).
print-undocumented (function).
undocumented-handler (function).
codex.tmplCodex template definitions.
common-lisp.
trivial-types.
*template-database* (special variable).
built-in-template (class).
codex-template (class).
find-template (function).
+templates-directory+ (special variable).
append-mathjax-fonts (function).
define-built-in-template (macro).
document-template (generic function).
gamma (class).
minima (class).
options (generic reader).
output-directory (generic reader).
section-template (generic function).
static-files (generic function).
static-output-directory (function).
template-pathname (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The name of the markup format that will be used to parse docstrings and files. This is a keyword that is passed to Pandocl.
The pathname of the Codex manifest in a system.
The current Docparser index.
If this variable is not NIL, do not call a debugger when undocumented node is found.
A hash table of table names (Keywords) to template classes.
Generate documentation for a system. @c(skip-undocumented) overrides @c(*skip-undocumented*) @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")
Find a template by name.
Parse a manifest from a pathname.
Parse a docstring into a documentation node using the current markup format.
Create a documentation folder, manifest, and a sample file for the given system.
Return the absolute pathname to a system’s Codex manifest. @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")
unsupported-output-format)) ¶template-error)) ¶manifest-error)) ¶no-docstring)) ¶node.
manifest-error)) ¶template-error)) ¶with-package)) ¶common-doc.macro.
codex-template) &key) ¶Copy the template’s static files to the output directory
built-in-template) (document document) content-string) ¶Render a built-in document template.
common-html.template.
built-in-template) (document document) (section section) content-string) ¶Render a built-in section template.
common-html.template.
The base class of all Codex errors.
condition.
Signalled when there is an error parsing a manifest file.
The name of the system.
:system-name
This slot is read-only.
Signalled when a node has no docstring.
node.
Signalled by errors related to templates.
The template name.
:template-name
This slot is read-only.
Signalled when Codex doesn’t know the output format a document specifies.
The name of the output format.
:format-name
This slot is read-only.
A convenience subclass for Codex built-in templates. These
slots are not built into the default codex-template class, since users might
define their own templates without using this machinery.
Insert documentation of a node.
macro-node.
Codex templates.
template.
The directory where the output will be produced.
pathname
:output-directory
This slot is read-only.
A Codex document. Project manifests can define multiple documents, e.g. a manual, a tutorial, an advanced manual.
The document’s title.
string
:title
This slot is read-only.
A list of the document’s authors.
(trivial-types:proper-list string)
:authors
This slot is read-only.
The document’s output format.
codex.manifest:output-format
:output-format
This slot is read-only.
A list of pathnames to source files to build the document from.
(trivial-types:proper-list pathname)
:sources
This slot is read-only.
The base class of HTML formats.
The name of the HTML template.
keyword
:template-name
This slot is read-only.
A property list of template initargs.
trivial-types:property-list
:template-options
This slot is read-only.
Manifest options.
The markup format used in docstrings.
keyword
:markup-format
This slot is read-only.
A list of systems to document.
(trivial-types:proper-list keyword)
:systems
This slot is read-only.
A list of documents.
(trivial-types:proper-list codex.manifest:document)
:documents
This slot is read-only.
An argument of an operator.
macro-node.
Add a link to the Common Lisp HyperSpec.
macro-node.
Set the current package to use in the body.
macro-node.
The package’s name.
string
This slot is read-only.
The name of the current package. Set by the with-package macro.
List of undocumented nodes
Associate the string names of Docparser classes to the corresponding docparser class names.
Build a document.
Build a manifest. Return a list of nodes which do not have a docstring.
Check and return the node’s docstring.
If there is none, codex.error:no-docstring condition is signalled.
Copy all the images from a CommonDoc document.
Create a node representing a node’s docstring.
Expand a generic operator node. Called by more specific methods.
Load a CommonDoc document from the sources of a Codex document.
Create metadata for HTML classes.
Parse a manifest’s document plist into a document object.
Create an instance of an output-format class from a plist.
Read a manifest file into an S-expression using the :codex-manifest-user package.
Get a pathname of a file in templates directory.
Handle undocumented nodes
Return the Hyperspec or l1sp.org URL for a symbol in the CL package.
Turn a Docparser node into a CommonDoc one.
When expanding an unsupported node, rather than generate an error, simply create an error message.
type-node)) ¶Expand a type node.
documentation-node)) ¶Backup method when someone has created a subclass of documentation-node that’s not explicitly supported by this.
variable-node)) ¶Expand a variable node.
condition-node)) ¶Expand a condition definition node.
class-node)) ¶Expand a class definition node.
struct-node)) ¶Expand a structure definition node.
class-slot-node)) ¶Expand a class slot node.
struct-slot-node)) ¶Expand a structure slot node. This doesn’t have any docstrings.
operator-node)) ¶Backup method when someone has created a subclass of operator-node that’s not explicitly supported by this method.
method-node)) ¶Expand a method node.
generic-function-node)) ¶Expand a generic function node.
macro-node)) ¶Expand a macro node.
function-node)) ¶Expand a function node.
Create a node representing the name of a node. If it is a setf operation, "setf " is automatically prepended before the name text.
codex-template)) ¶A plist of template options.
codex-template)) ¶The directory where the output will be produced.
with-package)) ¶The package’s name.
name.
| Jump to: | A B C D E F G I L M N O P Q R S T U W |
|---|
| Jump to: | A B C D E F G I L M N O P Q R S T U W |
|---|
| Jump to: | *
+
D F H M N O S T |
|---|
| Jump to: | *
+
D F H M N O S T |
|---|
| Jump to: | B C D E F G H M N O P Q R S T U W |
|---|
| Jump to: | B C D E F G H M N O P Q R S T U W |
|---|