The codex Reference Manual

Exported Definitions

codex-error (condition)
format-name (method)
manifest-error (condition)
message (method)
message (method)
no-docstring (condition)
node (method)
system-name (method)
template-error (condition)
template-name (method)
unsupported-output-format (condition)

4.1.4 `codex/src/markup.lisp`

Dependency

error.lisp (file)

Parent

src (module)

Location

src/markup.lisp

Packages

codex.markup

Exported Definitions

*current-markup-format* (special variable)
parse-string (function)

4.1.5 `codex/src/manifest.lisp`

Dependency

markup.lisp (file)

Parent

src (module)

Location

src/manifest.lisp

Packages

codex.manifest
codex-manifest-user

Exported Definitions

*default-manifest-pathname* (special variable)
document (class)
document-authors (method)
document-output-format (method)
document-sources (method)
document-title (method)
html (class)
manifest (class)
manifest-documents (method)
manifest-markup-format (method)
manifest-systems (method)
multi-html (class)
output-format (class)
output-html-template (method)
output-html-template-options (method)
parse-manifest (function)
single-html (class)
system-manifest-pathname (function)

Internal Definitions

parse-document (function)
parse-output-format (function)
read-manifest (function)

4.1.6 `codex/src/macro.lisp`

Dependency

manifest.lisp (file)

Parent

src (module)

Location

src/macro.lisp

Packages

Exported Definitions

*index* (special variable)
cl-doc (class)
param (class)
spec (class)
with-package (class)

Internal Definitions

*current-package-name* (special variable)
+type-name-to-class-map+ (special variable)
check-node-docstring (function)
docstring-node (function)
expand-node (generic function)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
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 (method)
url-for-symbol (function)
write-to-code-node (function)

4.1.7 `codex/src/codex.lisp`

Dependency

macro.lisp (file)

Parent

src (module)

Location

src/codex.lisp

Packages

codex

Exported Definitions

*skip-undocumented* (special variable)
document (function)

Internal Definitions

*undocumented-list* (special variable)
build-document (function)
build-manifest (function)
copy-images (function)
load-document (function)
print-undocumented (function)
undocumented-handler (function)

4.1.8 `codex/src/quickstart.lisp`

Dependency

codex.lisp (file)

Parent

src (module)

Location

src/quickstart.lisp

Exported Definitions

quickstart (function)

Internal Definitions

+manifest-template+ (special variable)
+manual-template+ (special variable)
clean-author-name (function)

4.1.9 `codex-templates/templates/templates.lisp`

Parent

templates (module)

Location

templates/templates.lisp

Packages

Exported Definitions

*template-database* (special variable)
built-in-template (class)
codex-template (class)
find-template (function)

Internal Definitions

+templates-directory+ (special variable)
define-built-in-template (macro)
document-template (generic function)
document-template (method)
document-template (method)
gamma (class)
minima (class)
options (method)
output-directory (method)
section-template (generic function)
section-template (method)
section-template (method)
static-files (generic function)
static-files (method)
static-files (method)
static-output-directory (function)

4.2 Static

4.2.1 `codex-templates/templates/static/nodes.css`

Parent: static (module)
Location: templates/static/nodes.css

4.2.2 `codex-templates/templates/static/reset.css`

Parent: static (module)
Location: templates/static/reset.css

4.2.3 `codex-templates/templates/minima/base.html`

Parent: minima (module)
Location: templates/minima/base.html

4.2.4 `codex-templates/templates/minima/document.html`

Parent: minima (module)
Location: templates/minima/document.html

4.2.5 `codex-templates/templates/minima/section.html`

Parent: minima (module)
Location: templates/minima/section.html

4.2.6 `codex-templates/templates/minima/style.css`

Parent: minima (module)
Location: templates/minima/style.css

4.2.7 `codex-templates/templates/gamma/base.html`

Parent: gamma (module)
Location: templates/gamma/base.html

4.2.8 `codex-templates/templates/gamma/document.html`

Parent: gamma (module)
Location: templates/gamma/document.html

4.2.9 `codex-templates/templates/gamma/section.html`

Parent: gamma (module)
Location: templates/gamma/section.html

4.2.10 `codex-templates/templates/gamma/style.css`

Parent: gamma (module)
Location: templates/gamma/style.css

4.2.11 `codex-templates/templates/traditional/base.html`

Parent: traditional (module)
Location: /home/quickref/quicklisp/dists/quicklisp/software/codex-20181210-git/templates/traditional/base.html (not found)

4.2.12 `codex-templates/templates/traditional/document.html`

Parent: traditional (module)
Location: /home/quickref/quicklisp/dists/quicklisp/software/codex-20181210-git/templates/traditional/document.html (not found)

4.2.13 `codex-templates/templates/traditional/section.html`

Parent: traditional (module)
Location: /home/quickref/quicklisp/dists/quicklisp/software/codex-20181210-git/templates/traditional/section.html (not found)

4.2.14 `codex-templates/templates/traditional/style.css`

Parent: traditional (module)
Location: /home/quickref/quicklisp/dists/quicklisp/software/codex-20181210-git/templates/traditional/style.css (not found)

5 Packages

Packages are listed by definition order.

5.1 `codex.error`

Codex errors.

Source

error.lisp (file)

Use List

common-lisp

Exported Definitions

codex-error (condition)
format-name (generic function)
format-name (method)
manifest-error (condition)
message (generic function)
message (method)
message (method)
no-docstring (condition)
node (generic function)
node (method)
system-name (generic function)
system-name (method)
template-error (condition)
template-name (generic function)
template-name (method)
unsupported-output-format (condition)

5.2 `codex.markup`

Parsing files and docstrings.

Source

markup.lisp (file)

Use List

common-lisp

Exported Definitions

*current-markup-format* (special variable)
parse-string (function)

5.3 `codex.manifest`

Parsing Codex manifest files.

Source

manifest.lisp (file)

Use List

common-lisp

Used By List

codex-manifest-user

Exported Definitions

*default-manifest-pathname* (special variable)
document (class)
document-authors (generic function)
document-authors (method)
document-output-format (generic function)
document-output-format (method)
document-sources (generic function)
document-sources (method)
document-title (generic function)
document-title (method)
html (class)
manifest (class)
manifest-documents (generic function)
manifest-documents (method)
manifest-markup-format (generic function)
manifest-markup-format (method)
manifest-systems (generic function)
manifest-systems (method)
multi-html (class)
output-format (class)
output-html-template (generic function)
output-html-template (method)
output-html-template-options (generic function)
output-html-template-options (method)
parse-manifest (function)
single-html (class)
system-manifest-pathname (function)

Internal Definitions

parse-document (function)
parse-output-format (function)
read-manifest (function)

5.4 `codex-manifest-user`

The package in which Codex manifests are read.

Source

manifest.lisp (file)

Use List

codex.manifest
common-lisp

5.5 `codex.macro`

CommonDoc macros for Codex.

Source

macro.lisp (file)

Use List

common-lisp

Exported Definitions

*index* (special variable)
cl-doc (class)
param (class)
spec (class)
with-package (class)

Internal Definitions

*current-package-name* (special variable)
+type-name-to-class-map+ (special variable)
check-node-docstring (function)
docstring-node (function)
expand-node (generic function)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
expand-node (method)
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)
name-node (method)
no-method-found (function)
no-method-lambda-list (function)
no-such-type (function)
node-not-found (function)
package-macro-name (generic function)
package-macro-name (method)
url-for-symbol (function)
write-to-code-node (function)

5.6 `codex`

The main interface.

Source

codex.lisp (file)

Use List

common-lisp

Exported Definitions

*skip-undocumented* (special variable)
document (function)
quickstart (function)

Internal Definitions

*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)

5.7 `codex.tmpl`

Codex template definitions.

Source

templates.lisp (file)

Use List

trivial-types
common-lisp

Exported Definitions

*template-database* (special variable)
built-in-template (class)
codex-template (class)
find-template (function)

Internal Definitions

+templates-directory+ (special variable)
define-built-in-template (macro)
document-template (generic function)
document-template (method)
document-template (method)
gamma (class)
minima (class)
options (generic function)
options (method)
output-directory (generic function)
output-directory (method)
section-template (generic function)
section-template (method)
section-template (method)
static-files (generic function)
static-files (method)
static-files (method)
static-output-directory (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *current-markup-format*

The name of the markup format that will be used to parse docstrings and files. This is a keyword that is passed to Pandocl.

Package: codex.markup
Source: markup.lisp (file)

Special Variable: *default-manifest-pathname*

The pathname of the Codex manifest in a system.

Package: codex.manifest
Source: manifest.lisp (file)

Special Variable: *index*

The current Docparser index.

Package: codex.macro
Source: macro.lisp (file)

Special Variable: *skip-undocumented*

If this variable is not NIL, do not call a debugger when undocumented node is found.

Package: codex
Source: codex.lisp (file)

Special Variable: *template-database*

A hash table of table names (Keywords) to template classes.

Package: codex.tmpl
Source: templates.lisp (file)

6.1.2 Functions

Function: document SYSTEM-NAME &key SKIP-UNDOCUMENTED MANIFEST-PATH

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")

Package: codex
Source: codex.lisp (file)

Function: find-template TEMPLATE-NAME

Find a template by name.

Package: codex.tmpl
Source: templates.lisp (file)

Function: parse-manifest PATHNAME

Parse a manifest from a pathname.

Package: codex.manifest
Source: manifest.lisp (file)

Function: parse-string STRING

Parse a docstring into a documentation node using the current markup format.

Package: codex.markup
Source: markup.lisp (file)

Function: quickstart SYSTEM-NAME

Create a documentation folder, manifest, and a sample file for the given system.

Package: codex
Source: quickstart.lisp (file)

Function: system-manifest-pathname SYSTEM-NAME &key MANIFEST-PATH

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")

Package: codex.manifest
Source: manifest.lisp (file)

6.1.3 Generic functions

Generic Function: document-authors OBJECT

Package

Methods

Method: document-authors (DOCUMENT document)

A list of the document’s authors.

Source: manifest.lisp (file)

Generic Function: document-output-format OBJECT

Package

Methods

Method: document-output-format (DOCUMENT document)

The document’s output format.

Source: manifest.lisp (file)

Generic Function: document-sources OBJECT

Package

Methods

Method: document-sources (DOCUMENT document)

A list of pathnames to source files to build the document from.

Source: manifest.lisp (file)

Generic Function: document-title OBJECT

Package

Methods

Method: document-title (DOCUMENT document)

The document’s title.

Source: manifest.lisp (file)

Generic Function: format-name CONDITION

Package

Methods

Method: format-name (CONDITION unsupported-output-format)

Source: error.lisp (file)

Generic Function: manifest-documents OBJECT

Package

Methods

Method: manifest-documents (MANIFEST manifest)

A list of documents.

Source: manifest.lisp (file)

Generic Function: manifest-markup-format OBJECT

Package

Methods

Method: manifest-markup-format (MANIFEST manifest)

The markup format used in docstrings.

Source: manifest.lisp (file)

Generic Function: manifest-systems OBJECT

Package

Methods

Method: manifest-systems (MANIFEST manifest)

A list of systems to document.

Source: manifest.lisp (file)

Generic Function: message CONDITION

Package

Methods

Method: message (CONDITION template-error)

Source: error.lisp (file)

Method: message (CONDITION manifest-error)

Source: error.lisp (file)

Generic Function: node CONDITION

Package

Methods

Method: node (CONDITION no-docstring)

Source: error.lisp (file)

Generic Function: output-html-template OBJECT

Package

Methods

Method: output-html-template (HTML html)

The name of the HTML template.

Source: manifest.lisp (file)

Generic Function: output-html-template-options OBJECT

Package

Methods

Method: output-html-template-options (HTML html)

A property list of template initargs.

Source: manifest.lisp (file)

Generic Function: system-name CONDITION

Package

Methods

Method: system-name (CONDITION manifest-error)

Source: error.lisp (file)

Generic Function: template-name CONDITION

Package

Methods

Method: template-name (CONDITION template-error)

Source: error.lisp (file)

6.1.4 Conditions

Condition: codex-error ()

The base class of all Codex errors.

Package

Source

error.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses

manifest-error (condition)
unsupported-output-format (condition)
template-error (condition)
no-docstring (condition)

Condition: manifest-error ()

Signalled when there is an error parsing a manifest file.

Package

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

message (method)
system-name (method)

Direct slots

Slot: system-name

The name of the system.

Initargs: :system-name
Readers: system-name (generic function)

Slot: message

The error message.

Initargs: :message
Readers: message (generic function)

Condition: no-docstring ()

Signalled when a node has no docstring.

Package

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

node (method)

Direct slots

Slot: node

The node without docstring.

Initargs: :node
Readers: node (generic function)

Condition: template-error ()

Signalled by errors related to templates.

Package

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

message (method)
template-name (method)

Direct slots

Slot: template-name

The template name.

Initargs: :template-name
Readers: template-name (generic function)

Slot: message

The error message.

Initargs: :message
Readers: message (generic function)

Condition: unsupported-output-format ()

Signalled when Codex doesn’t know the output format a document specifies.

Package

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

format-name (method)

Direct slots

Slot: format-name

The name of the output format.

Initargs: :format-name
Readers: format-name (generic function)

6.1.5 Classes

Class: built-in-template ()

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.

Package

Source

templates.lisp (file)

Direct superclasses

codex-template (class)

Direct subclasses

minima (class)
gamma (class)

Direct methods

render-section (method)
render (method)

Class: cl-doc ()

Insert documentation of a node.

Package: codex.macro
Source: macro.lisp (file)
Direct superclasses: macro-node (class)
Direct methods: expand-macro (method)

Class: codex-template ()

Codex templates.

Package

Source

templates.lisp (file)

Direct superclasses

template (class)

Direct subclasses

built-in-template (class)

Direct methods

initialize-instance (method)
options (method)
output-directory (method)

Direct slots

Slot: output-directory

The directory where the output will be produced.

Type: pathname
Initargs: :output-directory
Readers: output-directory (generic function)

Slot: options

A plist of template options.

Type: trivial-types:property-list
Initargs: :options
Readers: options (generic function)

Class: document ()

A Codex document. Project manifests can define multiple documents, e.g. a manual, a tutorial, an advanced manual.

Package

Source

manifest.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

document-sources (method)
document-output-format (method)
document-authors (method)
document-title (method)

Direct slots

Slot: document-title

The document’s title.

Type: string
Initargs: :title
Readers: document-title (generic function)

Slot: document-authors

A list of the document’s authors.

Type: (trivial-types:proper-list string)
Initargs: :authors
Readers: document-authors (generic function)

Slot: output-format

The document’s output format.

Type: codex.manifest:output-format
Initargs: :output-format
Readers: document-output-format (generic function)

Slot: document-sources

A list of pathnames to source files to build the document from.

Type: (trivial-types:proper-list pathname)
Initargs: :sources
Readers: document-sources (generic function)

Class: html ()

The base class of HTML formats.

Package

Source

manifest.lisp (file)

Direct superclasses

output-format (class)

Direct subclasses

single-html (class)
multi-html (class)

Direct methods

output-html-template-options (method)
output-html-template (method)

Direct slots

Slot: html-template

The name of the HTML template.

Type: keyword
Initargs: :template-name
Readers: output-html-template (generic function)

Slot: template-options

A property list of template initargs.

Type: trivial-types:property-list
Initargs: :template-options
Readers: output-html-template-options (generic function)

Class: manifest ()

Manifest options.

Package

Source

manifest.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

manifest-documents (method)
manifest-systems (method)
manifest-markup-format (method)

Direct slots

Slot: markup-format

The markup format used in docstrings.

Type: keyword
Initargs: :markup-format
Readers: manifest-markup-format (generic function)

Slot: systems

A list of systems to document.

Type: (trivial-types:proper-list keyword)
Initargs: :systems
Readers: manifest-systems (generic function)

Slot: documents

A list of documents.

Type: (trivial-types:proper-list codex.manifest:document)
Initargs: :documents
Readers: manifest-documents (generic function)

Class: multi-html ()

Multi-file HTML output.

Package: codex.manifest
Source: manifest.lisp (file)
Direct superclasses: html (class)

Class: output-format ()

The base class of all output formats.

Package: codex.manifest
Source: manifest.lisp (file)
Direct superclasses: standard-object (class)
Direct subclasses: html (class)

Class: param ()

An argument of an operator.

Package: codex.macro
Source: macro.lisp (file)
Direct superclasses: macro-node (class)
Direct methods: expand-macro (method)

Class: single-html ()

Single-file HTML output.

Package: codex.manifest
Source: manifest.lisp (file)
Direct superclasses: html (class)

Class: spec ()

Add a link to the Common Lisp HyperSpec.

Package: codex.macro
Source: macro.lisp (file)
Direct superclasses: macro-node (class)
Direct methods: expand-macro (method)

Class: with-package ()

Set the current package to use in the body.

Package

Source

macro.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)
package-macro-name (method)

Direct slots

Slot: name

The package’s name.

Type: string
Readers: package-macro-name (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *current-package-name*

The name of the current package. Set by the with-package macro.

Package: codex.macro
Source: macro.lisp (file)

Special Variable: *undocumented-list*

List of undocumented nodes

Package: codex
Source: codex.lisp (file)

Special Variable: +manifest-template+

Package: codex
Source: quickstart.lisp (file)

Special Variable: +manual-template+

Package: codex
Source: quickstart.lisp (file)

Special Variable: +templates-directory+

Package: codex.tmpl
Source: templates.lisp (file)

Special Variable: +type-name-to-class-map+

Associate the string names of Docparser classes to the corresponding docparser class names.

Package: codex.macro
Source: macro.lisp (file)

6.2.2 Macros

Macro: define-built-in-template NAME &key DOCUMENT-TEMPLATE SECTION-TEMPLATE STATIC-FILES DOCUMENTATION

Package: codex.tmpl
Source: templates.lisp (file)

6.2.3 Functions

Function: build-document DOCUMENT DIRECTORY

Build a document.

Package: codex
Source: codex.lisp (file)

Function: build-manifest MANIFEST DIRECTORY

Build a manifest. Return a list of nodes which do not have a docstring.

Package: codex
Source: codex.lisp (file)

Function: check-node-docstring NODE

Check and return the node’s docstring.
If there is none, codex.error:no-docstring condition is signalled.

Package: codex.macro
Source: macro.lisp (file)

Function: clean-author-name AUTHOR

Package: codex
Source: quickstart.lisp (file)

Function: copy-images DOCUMENT DIRECTORY

Copy all the images from a CommonDoc document.

Package: codex
Source: codex.lisp (file)

Function: docstring-node NODE

Create a node representing a node’s docstring.

Package: codex.macro
Source: macro.lisp (file)

Function: expand-operator-node NODE CLASS-NAME

Expand a generic operator node. Called by more specific methods.

Package: codex.macro
Source: macro.lisp (file)

Function: expand-record-node CLASS NODE

Package: codex.macro
Source: macro.lisp (file)

Function: find-node TYPE SYMBOL REST

Package: codex.macro
Source: macro.lisp (file)

Function: find-node-type-by-name NAME

Package: codex.macro
Source: macro.lisp (file)

Function: list-to-code-node CLASS LIST

Package: codex.macro
Source: macro.lisp (file)

Function: load-document DOCUMENT DIRECTORY

Load a CommonDoc document from the sources of a Codex document.

Package: codex
Source: codex.lisp (file)

Function: make-class-metadata CLASS

Create metadata for HTML classes.

Package: codex.macro
Source: macro.lisp (file)

Function: make-doc-node CLASSES &rest CHILDREN

Package: codex.macro
Source: macro.lisp (file)

Function: no-method-found NAME LAMBDA-LIST

Package: codex.macro
Source: macro.lisp (file)

Function: no-method-lambda-list NAME

Package: codex.macro
Source: macro.lisp (file)

Function: no-such-type NAME

Package: codex.macro
Source: macro.lisp (file)

Function: node-not-found SYMBOL

Package: codex.macro
Source: macro.lisp (file)

Function: parse-document DOCUMENT-PLIST

Parse a manifest’s document plist into a document object.

Package: codex.manifest
Source: manifest.lisp (file)

Function: parse-output-format PLIST

Create an instance of an output-format class from a plist.

Package: codex.manifest
Source: manifest.lisp (file)

Function: print-undocumented UNDOCUMENTED

Package: codex
Source: codex.lisp (file)

Function: read-manifest PATHNAME

Read a manifest file into an S-expression using the :codex-manifest-user package.

Package: codex.manifest
Source: manifest.lisp (file)

Function: static-output-directory BUILT-IN-TEMPLATE

Package: codex.tmpl
Source: templates.lisp (file)

Function: undocumented-handler C

Handle undocumented nodes

Package: codex
Source: codex.lisp (file)

Function: url-for-symbol SYMBOL-NAME

Return the Hyperspec or l1sp.org URL for a symbol in the CL package.

Package: codex.macro
Source: macro.lisp (file)

Function: write-to-code-node CLASS OBJ

Package: codex.macro
Source: macro.lisp (file)

6.2.4 Generic functions

Generic Function: document-template TEMPLATE

Package

Source

templates.lisp (file)

Methods

Method: document-template (TEMPLATE gamma)

Method: document-template (TEMPLATE minima)

Generic Function: expand-node NODE

Turn a Docparser node into a CommonDoc one.

Package

Source

macro.lisp (file)

Methods

Method: expand-node NODE: When expanding an unsupported node, rather than generate an error, simply create an error message.

Method: expand-node (NODE type-node): Expand a type node.

Method: expand-node (NODE documentation-node): Backup method when someone has created a subclass of documentation-node that’s not explicitly supported by this.

Method: expand-node (NODE variable-node): Expand a variable node.

Method: expand-node (NODE condition-node): Expand a condition definition node.

Method: expand-node (NODE class-node): Expand a class definition node.

Method: expand-node (NODE struct-node): Expand a structure definition node.

Method: expand-node (NODE class-slot-node): Expand a class slot node.

Method: expand-node (NODE struct-slot-node): Expand a structure slot node. This doesn’t have any docstrings.

Method: expand-node (NODE operator-node): Backup method when someone has created a subclass of operator-node that’s not explicitly supported by this method.

Method: expand-node (NODE method-node): Expand a method node.

Method: expand-node (NODE generic-function-node): Expand a generic function node.

Method: expand-node (NODE macro-node): Expand a macro node.

Method: expand-node (NODE function-node): Expand a function node.

Generic Function: name-node NODE

Package

Methods

Method: name-node NODE

Create a node representing the name of a node. If it is a setf operation, "setf " is automatically prepended before the name text.

Source: macro.lisp (file)

Generic Function: options OBJECT

Package

Methods

Method: options (CODEX-TEMPLATE codex-template)

A plist of template options.

Source: templates.lisp (file)

Generic Function: output-directory OBJECT

Package

Methods

Method: output-directory (CODEX-TEMPLATE codex-template)

The directory where the output will be produced.

Source: templates.lisp (file)

Generic Function: package-macro-name OBJECT

Package

Methods

Method: package-macro-name (WITH-PACKAGE with-package)

The package’s name.

Source: macro.lisp (file)

Generic Function: section-template TEMPLATE

Package

Source

templates.lisp (file)

Methods

Method: section-template (TEMPLATE gamma)

Method: section-template (TEMPLATE minima)

Generic Function: static-files TEMPLATE

Package

Source

templates.lisp (file)

Methods

Method: static-files (TEMPLATE gamma)

Method: static-files (TEMPLATE minima)

6.2.5 Classes

Class: gamma ()

Modern template.

Package

Source

templates.lisp (file)

Direct superclasses

built-in-template (class)

Direct methods

static-files (method)
section-template (method)
document-template (method)

Class: minima ()

Minimalist template.

Package