The erudite Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The erudite Reference Manual

This is the erudite Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:12:02 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

ERUDITE

Quicklisp MIT License

Introduction

Erudite is a Literate Programming System for Common Lisp

Features

Quickstart

Write your embedded documentation in lisp comments (;; and #| … |# are supported). Use either erudite, latex or sphinx syntax, and produce output to one of them or markdown.

Example in the built-in erudite syntax:

#|
@title Erudite
@subtitle Literate Programming System for Common Lisp

@author Mariano Montone
@syntax erudite

@section Introduction

@ignore
|#
(in-package #:erudite)

#|
@end ignore

For a full example, see erudite.lisp.

Run make to build erudite command line if you want to run it from there, and then sudo make install to install.

Usage: erudite [-hvd] [+vd] [OPTIONS] FILES...

Erudite is a Literate Programming System for Common Lisp
  -h, --help                  Print this help and exit.
  --version                   Print Erudite version
  -(+)v, --verbose[=yes/no]   Run in verbose mode
                              Fallback: yes
                              Default: no
                              Environment: VERBOSE
  -(+)d, --debug[=on/off]     Turn debugging on or off.
                              Fallback: on
                              Default: off
                              Environment: DEBUG
  -(+)id, --implicit-doc[=yes/no] Treat all comments as documentation
                              Fallback: yes
                              Default: yes
  -(+)ic, --implicit-code[=yes/no] Include all code in documentation
                              Fallback: yes
                              Default: yes
  -o, --output=OUTPUT         The output file. If none is used, result is 
                              printed to stdout
  --output-type=OUTPUT-TYPE   The output type. One of 'latex', 
                              'sphinx','markdown'
                              Default: latex
  --syntax=SYNTAX             The syntax used in source files. One of 'erudite',
                              'latex', 'sphinx', 'markdown'
                              Default: erudite
  --author=AUTHOR             The author to appear in the document
  --title=TITLE               The document title

Or run it from lisp, using the erudite function described below.

To build erudite own documentation, run make under the doc directory:

make pdf
make sphinx-pdf
make sphinx-html
make markdown

Look at the doc directory for output examples.

Functions

erudite

(pathname files &rest args &key (output-type *output-type*)
          (syntax *syntax*) &allow-other-keys)

Processes literate lisp files and creates a document.

References


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 erudite

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Description

Literate Programming System for Common Lisp

Dependencies
Source

erudite.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 erudite/syntax

Dependency

commands.lisp (file)

Parent

erudite (system)

Location

syntax/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 erudite.asd

Location

erudite.asd

Systems

erudite (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 erudite/package.lisp

Parent

erudite (system)

Location

package.lisp

Packages

erudite


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 erudite/config.lisp

Dependency

package.lisp (file)

Parent

erudite (system)

Location

config.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 erudite/util.lisp

Dependency

config.lisp (file)

Parent

erudite (system)

Location

util.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 erudite/commands.lisp

Dependency

util.lisp (file)

Parent

erudite (system)

Location

commands.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 erudite/syntax/erudite.lisp

Parent

syntax (module)

Location

syntax/erudite.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 erudite/syntax/latex.lisp

Parent

syntax (module)

Location

syntax/latex.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 erudite/syntax/sphinx.lisp

Parent

syntax (module)

Location

syntax/sphinx.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 erudite/syntax/markdown.lisp

Parent

syntax (module)

Location

syntax/markdown.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 erudite/syntax/org.lisp

Parent

syntax (module)

Location

syntax/org.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.11 erudite/erudite.lisp

Dependency

syntax (module)

Parent

erudite (system)

Location

erudite.lisp

Exported Definitions

erudite (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 erudite

Erudite is a Literate Programming System for Common Lisp

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *catch-errors-p*
Package

erudite

Source

config.lisp (file)

Special Variable: *code-indexing*
Package

erudite

Source

config.lisp (file)

Special Variable: *debug*
Package

erudite

Source

config.lisp (file)

Special Variable: *erudite-package*
Package

erudite

Source

config.lisp (file)

Special Variable: *implicit-code*
Package

erudite

Source

config.lisp (file)

Special Variable: *implicit-doc*
Package

erudite

Source

config.lisp (file)

Special Variable: *output-type*
Package

erudite

Source

config.lisp (file)

Special Variable: *short-comments-prefix*
Package

erudite

Source

config.lisp (file)

Special Variable: *subtitle*
Package

erudite

Source

config.lisp (file)

Special Variable: *syntax*
Package

erudite

Source

config.lisp (file)

Special Variable: *title*
Package

erudite

Source

config.lisp (file)

Special Variable: *verbose*
Package

erudite

Source

config.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: erudite DESTINATION FILE-OR-FILES &rest ARGS &key OUTPUT-TYPE SYNTAX DEBUG VERBOSE CATCH-ERRORS-P CODE-INDEXING IMPLICIT-DOC IMPLICIT-CODE SHORT-COMMENTS-PREFIX &allow-other-keys

Processes literate lisp files and creates a document.

Args: - destination: If NIL, output is written to a string. If T, output is written to *standard-output*. If a pathname, then a file is created. Otherwise, a stream is expected. - files: Literate lisp files to compile
- args: All sort of options passed to the generation functions
- output-type: The kind of document to generate.
One of :latex, :sphinx
Default: :latex
- syntax: The kind of syntax used in the literate source files.
One of: :erudite, :latex, :org, :sphinx.
Default: :erudite

Package

erudite

Source

erudite.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *author*
Package

erudite

Source

config.lisp (file)

Special Variable: *chunks*
Package

erudite

Source

config.lisp (file)

Special Variable: *commands*
Package

erudite

Source

commands.lisp (file)

Special Variable: *current-extract*
Package

erudite

Source

commands.lisp (file)

Special Variable: *current-path*
Package

erudite

Source

config.lisp (file)

Special Variable: *erudite-syntax*
Package

erudite

Source

erudite.lisp (file)

Special Variable: *extracts*
Package

erudite

Source

commands.lisp (file)

Special Variable: *ignore*
Package

erudite

Source

commands.lisp (file)

Special Variable: *in-code-section*
Package

erudite

Source

commands.lisp (file)

Special Variable: *include-path*
Package

erudite

Source

erudite.lisp (file)

Special Variable: *latex-document-class*
Package

erudite

Source

erudite.lisp (file)

Special Variable: *latex-highlight-syntax*

Highlight syntax using LaTeX minted package: https://ctan.org/pkg/minted

Package

erudite

Source

erudite.lisp (file)

Special Variable: *output-condition*
Package

erudite

Source

commands.lisp (file)

Special Variable: *parsing-doc*
Package

erudite

Source

erudite.lisp (file)

Special Variable: *sphinx-indent*
Package

erudite

Source

sphinx.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: define-command NAME &body BODY
Package

erudite

Source

commands.lisp (file)

Macro: define-erudite-syntax NAME &body BODY
Package

erudite

Source

erudite.lisp (file)

Macro: with-destination (VAR DESTINATION) &body BODY
Package

erudite

Source

erudite.lisp (file)

Macro: with-error-handling (&optional CATCH-ERRORS-P) &body BODY
Package

erudite

Source

erudite.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: append-source-fragments FRAGMENTS

Append docs and code fragments

Package

erudite

Source

erudite.lisp (file)

Function: append-to-end THING LIST
Package

erudite

Source

util.lisp (file)

Function: call-with-destination DESTINATION FUNCTION
Package

erudite

Source

erudite.lisp (file)

Function: call-with-error-handling CATCH-ERRORS-P FUNCTION
Package

erudite

Source

erudite.lisp (file)

Function: escape-latex STR
Package

erudite

Source

erudite.lisp (file)

Function: expand-includes STREAM

Expand include directives

Package

erudite

Source

erudite.lisp (file)

Function: extract-chunks STRING

Splits a file source in docs and code

Package

erudite

Source

erudite.lisp (file)

Function: extract-indexes CODE
Package

erudite

Source

erudite.lisp (file)

Function: file-to-string PATHNAME
Package

erudite

Source

util.lisp (file)

Function: find-chunk CHUNK-NAME &key ERROR-P
Package

erudite

Source

commands.lisp (file)

Function: find-command NAME &optional ERROR-P
Package

erudite

Source

commands.lisp (file)

Function: find-extract EXTRACT-NAME &key ERROR-P
Package

erudite

Source

commands.lisp (file)

Function: find-matching-command LINE
Package

erudite

Source

commands.lisp (file)

Function: find-syntax NAME &optional ERROR-P
Package

erudite

Source

erudite.lisp (file)

Function: format-syntax DESTINATION SYNTAX
Package

erudite

Source

erudite.lisp (file)

Function: indent-code CODE

Code in sphinx has to be indented

Package

erudite

Source

erudite.lisp (file)

Function: latex-label STR
Package

erudite

Source

erudite.lisp (file)

Function: maybe-invoke-debugger CONDITION

This function is called whenever a condition CONDITION is signaled in Erudite.

Package

erudite

Source

erudite.lisp (file)

Function: parse-code LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-definition-type STR
Package

erudite

Source

erudite.lisp (file)

Function: parse-line LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-long-comment LINE STREAM

Parse a comment between #| and |#

Package

erudite

Source

erudite.lisp (file)

Function: parse-long-comment-explicit LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-long-comment-implicit LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-short-comment LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-short-comment-explicit LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: parse-short-comment-implicit LINE STREAM
Package

erudite

Source

erudite.lisp (file)

Function: post-process-output STR

Resolve chunk inserts and extract inserts after processing

Package

erudite

Source

erudite.lisp (file)

Function: process-fragments FRAGMENTS OUTPUT
Package

erudite

Source

erudite.lisp (file)

Function: process-string STRING
Package

erudite

Source

erudite.lisp (file)

Function: split-file-source STR

Splits a file source in docs and code

Package

erudite

Source

erudite.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: %format-syntax OUTPUT-TYPE SELECTOR STREAM SYNTAX
Package

erudite

Methods
Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql index)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql ref)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql label)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql link)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql italics)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql bold)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql emph)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql list-item)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql end-list)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql begin-list)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql end-code)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql begin-code)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql inline-verbatim)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql end-verbatim)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql begin-verbatim)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql subsubsection)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql subsection)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql org)) (SELECTOR (eql section)) STREAM SYNTAX
Source

org.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql index)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql ref)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql label)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql link)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql italics)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql bold)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql emph)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql list-item)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql end-list)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql begin-list)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql end-code)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql begin-code)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql inline-verbatim)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql end-verbatim)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql begin-verbatim)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql subsubsection)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql subsection)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql markdown)) (SELECTOR (eql section)) STREAM SYNTAX
Source

markdown.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql index)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql ref)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql label)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql link)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql italics)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql bold)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql emph)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql list-item)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql end-list)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql begin-list)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql end-code)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql begin-code)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql inline-verbatim)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql end-verbatim)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql begin-verbatim)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql subsubsection)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql subsection)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql sphinx)) (SELECTOR (eql section)) STREAM SYNTAX
Source

sphinx.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql index)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql ref)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql label)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql link)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql italics)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql bold)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql emph)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql list-item)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql end-list)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql begin-list)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql end-code)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql begin-code)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql inline-verbatim)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql end-verbatim)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql begin-verbatim)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql subsubsection)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql subsection)) STREAM SYNTAX
Source

latex.lisp (file)

Method: %format-syntax (OUTPUT-TYPE (eql latex)) (SELECTOR (eql section)) STREAM SYNTAX
Source

latex.lisp (file)

Generic Function: gen-doc OUTPUT-TYPE OUTPUT FILES &rest ARGS &key PRELUDE POSTLUDE SYNTAX TITLE SUBTITLE AUTHOR TEMPLATE-PATHNAME DOCUMENT-CLASS HIGHLIGHT-SYNTAX &allow-other-keys
Package

erudite

Source

erudite.lisp (file)

Methods
Method: gen-doc (OUTPUT-TYPE (eql org)) OUTPUT FILES &key PRELUDE POSTLUDE SYNTAX TITLE SUBTITLE AUTHOR &allow-other-keys

Generates Emacs org-mode document.

Args: - output: The output stream.
- files: .lisp files to compile.
- prelude: String (or pathname) to append before the document. - postlude: String (or pathname) to append after the document.

Method: gen-doc (OUTPUT-TYPE (eql markdown)) OUTPUT FILES &key PRELUDE POSTLUDE SYNTAX &allow-other-keys

Generates Markdown document.

Args: - output: The output stream.
- files: .lisp files to compile.
- prelude: String (or pathname) to append before the document. - postlude: String (or pathname) to append after the document.

Method: gen-doc (OUTPUT-TYPE (eql sphinx)) OUTPUT FILES &key PRELUDE POSTLUDE SYNTAX &allow-other-keys

Generates Sphinx document.

Args: - output: The output stream.
- files: .lisp files to compile.
- prelude: String (or pathname) to append before the Sphinx document. - postlude: String (or pathname) to append after the Sphinx document.

Method: gen-doc (OUTPUT-TYPE (eql latex)) OUTPUT FILES &key TITLE SUBTITLE AUTHOR TEMPLATE-PATHNAME SYNTAX DOCUMENT-CLASS HIGHLIGHT-SYNTAX &allow-other-keys

Generates a LaTeX document.

Args: - output: The output stream.
- files: The list of .lisp files to compile
- title: Document title.
- subtitle: Document subtitle.
- author: Author of the document
- template-pathname: A custom LaTeX template file. If none is specified, a default template is used.

Generic Function: match-command COMMAND LINE
Package

erudite

Source

commands.lisp (file)

Methods
Method: match-command (COMMAND (eql end-code)) LINE
Method: match-command (COMMAND (eql begin-code)) LINE
Method: match-command (COMMAND (eql end-if)) LINE
Method: match-command (COMMAND (eql else)) LINE
Method: match-command (COMMAND (eql if)) LINE
Method: match-command (COMMAND (eql end-when)) LINE
Method: match-command (COMMAND (eql when)) LINE
Method: match-command (COMMAND (eql end-ignore)) LINE
Method: match-command (COMMAND (eql ignore)) LINE
Method: match-command (COMMAND (eql insert)) LINE
Method: match-command (COMMAND (eql end-extract)) LINE
Method: match-command (COMMAND (eql extract)) LINE
Method: match-command (COMMAND (eql insert-chunk)) LINE
Method: match-command (COMMAND (eql short-comments-prefix)) LINE
Method: match-command (COMMAND (eql author)) LINE
Method: match-command (COMMAND (eql subtitle)) LINE
Method: match-command (COMMAND (eql title)) LINE
Method: match-command (COMMAND (eql package)) LINE
Method: match-command (COMMAND (eql code-indexing)) LINE
Method: match-command (COMMAND (eql output-type)) LINE
Method: match-command (COMMAND (eql syntax)) LINE
Generic Function: match-syntax COMMAND LINE
Package

erudite

Methods
Method: match-syntax (COMMAND (eql reference)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql index)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql label)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql link)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql inline-verbatim)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql italics)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql bold)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql emphasis)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql list-item)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql end-list)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql begin-list)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql end-code)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql begin-code)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql end-verbatim)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql begin-verbatim)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql subsubsection)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql subsection)) LINE
Source

erudite.lisp (file)

Method: match-syntax (COMMAND (eql section)) LINE
Source

erudite.lisp (file)

Generic Function: maybe-process-command LINE INPUT OUTPUT CONT
Package

erudite

Methods
Method: maybe-process-command LINE INPUT OUTPUT CONT

Process a top-level command

Source

erudite.lisp (file)

Method: maybe-process-command LINE INPUT OUTPUT CONT around
Source

commands.lisp (file)

Generic Function: process-command COMMAND LINE INPUT OUTPUT CONT
Package

erudite

Source

commands.lisp (file)

Methods
Method: process-command (COMMAND (eql end-code)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql begin-code)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql end-if)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql else)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql if)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql end-when)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql when)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql end-ignore)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql ignore)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql insert)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql end-extract)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql extract)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql insert-chunk)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql short-comments-prefix)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql author)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql subtitle)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql title)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql package)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql code-indexing)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql output-type)) LINE INPUT OUTPUT CONT
Method: process-command (COMMAND (eql syntax)) LINE INPUT OUTPUT CONT
Method: process-command COMMAND LINE INPUT OUTPUT CONT before
Generic Function: process-doc SYNTAX OUTPUT-TYPE LINE STREAM CONT
Package

erudite

Methods
Method: process-doc (SYNTAX (eql erudite)) OUTPUT-TYPE LINE STREAM CONT
Source

erudite.lisp (file)

Method: process-doc (SYNTAX (eql org)) OUTPUT-TYPE LINE STREAM CONT
Source

erudite.lisp (file)

Method: process-doc (SYNTAX (eql sphinx)) OUTPUT-TYPE LINE STREAM CONT
Source

erudite.lisp (file)

Method: process-doc (SYNTAX (eql latex)) OUTPUT-TYPE LINE STREAM CONT
Source

erudite.lisp (file)

Method: process-doc SYNTAX OUTPUT-TYPE LINE STREAM CONT around
Source

commands.lisp (file)

Generic Function: process-file-to-string PATHNAME
Package

erudite

Methods
Method: process-file-to-string PATHNAME after
Source

erudite.lisp (file)

Method: process-file-to-string PATHNAME before
Source

erudite.lisp (file)

Method: process-file-to-string (FILES cons)
Source

erudite.lisp (file)

Method: process-file-to-string (PATHNAME pathname)
Source

erudite.lisp (file)

Generic Function: process-fragment FRAGMENT-TYPE FRAGMENT OUTPUT CONT
Package

erudite

Source

erudite.lisp (file)

Methods
Method: process-fragment (TYPE (eql doc)) FRAGMENT OUTPUT CONT
Method: process-fragment (TYPE (eql code)) FRAGMENT OUTPUT CONT
Method: process-fragment (TYPE (eql code)) FRAGMENT OUTPUT CONT around
Source

commands.lisp (file)

Generic Function: process-syntax COMMAND LINE OUTPUT OUTPUT-TYPE
Package

erudite

Methods
Method: process-syntax (COMMAND (eql reference)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql index)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql label)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql link)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql inline-verbatim)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql italics)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql bold)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql emphasis)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql list-item)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql end-list)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql begin-list)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql end-code)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql begin-code)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql end-verbatim)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql begin-verbatim)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql subsubsection)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql subsection)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Method: process-syntax (COMMAND (eql section)) LINE OUTPUT OUTPUT-TYPE
Source

erudite.lisp (file)

Generic Function: write-chunk CHUNK-NAME CHUNK STREAM
Package

erudite

Methods
Method: write-chunk CHUNK-NAME CHUNK STREAM
Source

erudite.lisp (file)

Generic Function: write-chunk-name CHUNK-NAME STREAM
Package

erudite

Methods
Method: write-chunk-name CHUNK-NAME STREAM
Source

erudite.lisp (file)

Generic Function: write-code CODE STREAM OUTPUT-TYPE
Package

erudite

Methods
Method: write-code CODE STREAM (OUTPUT-TYPE (eql org))
Source

erudite.lisp (file)

Method: write-code CODE STREAM (OUTPUT-TYPE (eql markdown))
Source

erudite.lisp (file)

Method: write-code CODE STREAM (OUTPUT-TYPE (eql sphinx))
Source

erudite.lisp (file)

Method: write-code CODE STREAM (OUTPUT-TYPE (eql latex))
Source

erudite.lisp (file)

Generic Function: write-doc-line LINE OUTPUT OUTPUT-TYPE
Package

erudite

Methods
Method: write-doc-line LINE STREAM OUTPUT-TYPE
Source

erudite.lisp (file)

Method: write-doc-line LINE OUTPUT (OUTPUT-TYPE (eql sphinx)) before
Source

sphinx.lisp (file)

Generic Function: write-indexes INDEXES OUTPUT OUTPUT-TYPE
Package

erudite

Source

erudite.lisp (file)

Methods
Method: write-indexes INDEXES OUTPUT (OUTPUT-TYPE (eql org))
Method: write-indexes INDEXES OUTPUT (OUTPUT-TYPE (eql markdown))
Method: write-indexes INDEXES OUTPUT (OUTPUT-TYPE (eql sphinx))
Method: write-indexes INDEXES OUTPUT (OUTPUT-TYPE (eql latex))

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   E   F   L   M  
Index Entry  Section

E
erudite.asd: The erudite․asd file
erudite/commands.lisp: The erudite/commands․lisp file
erudite/config.lisp: The erudite/config․lisp file
erudite/erudite.lisp: The erudite/erudite․lisp file
erudite/package.lisp: The erudite/package․lisp file
erudite/syntax: The erudite/syntax module
erudite/syntax/erudite.lisp: The erudite/syntax/erudite․lisp file
erudite/syntax/latex.lisp: The erudite/syntax/latex․lisp file
erudite/syntax/markdown.lisp: The erudite/syntax/markdown․lisp file
erudite/syntax/org.lisp: The erudite/syntax/org․lisp file
erudite/syntax/sphinx.lisp: The erudite/syntax/sphinx․lisp file
erudite/util.lisp: The erudite/util․lisp file

F
File, Lisp, erudite.asd: The erudite․asd file
File, Lisp, erudite/commands.lisp: The erudite/commands․lisp file
File, Lisp, erudite/config.lisp: The erudite/config․lisp file
File, Lisp, erudite/erudite.lisp: The erudite/erudite․lisp file
File, Lisp, erudite/package.lisp: The erudite/package․lisp file
File, Lisp, erudite/syntax/erudite.lisp: The erudite/syntax/erudite․lisp file
File, Lisp, erudite/syntax/latex.lisp: The erudite/syntax/latex․lisp file
File, Lisp, erudite/syntax/markdown.lisp: The erudite/syntax/markdown․lisp file
File, Lisp, erudite/syntax/org.lisp: The erudite/syntax/org․lisp file
File, Lisp, erudite/syntax/sphinx.lisp: The erudite/syntax/sphinx․lisp file
File, Lisp, erudite/util.lisp: The erudite/util․lisp file

L
Lisp File, erudite.asd: The erudite․asd file
Lisp File, erudite/commands.lisp: The erudite/commands․lisp file
Lisp File, erudite/config.lisp: The erudite/config․lisp file
Lisp File, erudite/erudite.lisp: The erudite/erudite․lisp file
Lisp File, erudite/package.lisp: The erudite/package․lisp file
Lisp File, erudite/syntax/erudite.lisp: The erudite/syntax/erudite․lisp file
Lisp File, erudite/syntax/latex.lisp: The erudite/syntax/latex․lisp file
Lisp File, erudite/syntax/markdown.lisp: The erudite/syntax/markdown․lisp file
Lisp File, erudite/syntax/org.lisp: The erudite/syntax/org․lisp file
Lisp File, erudite/syntax/sphinx.lisp: The erudite/syntax/sphinx․lisp file
Lisp File, erudite/util.lisp: The erudite/util․lisp file

M
Module, erudite/syntax: The erudite/syntax module

Jump to:   E   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
A   C   D   E   F   G   I   L   M   P   S   W  
Index Entry  Section

%
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions
%format-syntax: Internal generic functions

A
append-source-fragments: Internal functions
append-to-end: Internal functions

C
call-with-destination: Internal functions
call-with-error-handling: Internal functions

D
define-command: Internal macros
define-erudite-syntax: Internal macros

E
erudite: Exported functions
escape-latex: Internal functions
expand-includes: Internal functions
extract-chunks: Internal functions
extract-indexes: Internal functions

F
file-to-string: Internal functions
find-chunk: Internal functions
find-command: Internal functions
find-extract: Internal functions
find-matching-command: Internal functions
find-syntax: Internal functions
format-syntax: Internal functions
Function, append-source-fragments: Internal functions
Function, append-to-end: Internal functions
Function, call-with-destination: Internal functions
Function, call-with-error-handling: Internal functions
Function, erudite: Exported functions
Function, escape-latex: Internal functions
Function, expand-includes: Internal functions
Function, extract-chunks: Internal functions
Function, extract-indexes: Internal functions
Function, file-to-string: Internal functions
Function, find-chunk: Internal functions
Function, find-command: Internal functions
Function, find-extract: Internal functions
Function, find-matching-command: Internal functions
Function, find-syntax: Internal functions
Function, format-syntax: Internal functions
Function, indent-code: Internal functions
Function, latex-label: Internal functions
Function, maybe-invoke-debugger: Internal functions
Function, parse-code: Internal functions
Function, parse-definition-type: Internal functions
Function, parse-line: Internal functions
Function, parse-long-comment: Internal functions
Function, parse-long-comment-explicit: Internal functions
Function, parse-long-comment-implicit: Internal functions
Function, parse-short-comment: Internal functions
Function, parse-short-comment-explicit: Internal functions
Function, parse-short-comment-implicit: Internal functions
Function, post-process-output: Internal functions
Function, process-fragments: Internal functions
Function, process-string: Internal functions
Function, split-file-source: Internal functions

G
gen-doc: Internal generic functions
gen-doc: Internal generic functions
gen-doc: Internal generic functions
gen-doc: Internal generic functions
gen-doc: Internal generic functions
Generic Function, %format-syntax: Internal generic functions
Generic Function, gen-doc: Internal generic functions
Generic Function, match-command: Internal generic functions
Generic Function, match-syntax: Internal generic functions
Generic Function, maybe-process-command: Internal generic functions
Generic Function, process-command: Internal generic functions
Generic Function, process-doc: Internal generic functions
Generic Function, process-file-to-string: Internal generic functions
Generic Function, process-fragment: Internal generic functions
Generic Function, process-syntax: Internal generic functions
Generic Function, write-chunk: Internal generic functions
Generic Function, write-chunk-name: Internal generic functions
Generic Function, write-code: Internal generic functions
Generic Function, write-doc-line: Internal generic functions
Generic Function, write-indexes: Internal generic functions

I
indent-code: Internal functions

L
latex-label: Internal functions

M
Macro, define-command: Internal macros
Macro, define-erudite-syntax: Internal macros
Macro, with-destination: Internal macros
Macro, with-error-handling: Internal macros
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-command: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
match-syntax: Internal generic functions
maybe-invoke-debugger: Internal functions
maybe-process-command: Internal generic functions
maybe-process-command: Internal generic functions
maybe-process-command: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, %format-syntax: Internal generic functions
Method, gen-doc: Internal generic functions
Method, gen-doc: Internal generic functions
Method, gen-doc: Internal generic functions
Method, gen-doc: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-command: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, match-syntax: Internal generic functions
Method, maybe-process-command: Internal generic functions
Method, maybe-process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-command: Internal generic functions
Method, process-doc: Internal generic functions
Method, process-doc: Internal generic functions
Method, process-doc: Internal generic functions
Method, process-doc: Internal generic functions
Method, process-doc: Internal generic functions
Method, process-file-to-string: Internal generic functions
Method, process-file-to-string: Internal generic functions
Method, process-file-to-string: Internal generic functions
Method, process-file-to-string: Internal generic functions
Method, process-fragment: Internal generic functions
Method, process-fragment: Internal generic functions
Method, process-fragment: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, process-syntax: Internal generic functions
Method, write-chunk: Internal generic functions
Method, write-chunk-name: Internal generic functions
Method, write-code: Internal generic functions
Method, write-code: Internal generic functions
Method, write-code: Internal generic functions
Method, write-code: Internal generic functions
Method, write-doc-line: Internal generic functions
Method, write-doc-line: Internal generic functions
Method, write-indexes: Internal generic functions
Method, write-indexes: Internal generic functions
Method, write-indexes: Internal generic functions
Method, write-indexes: Internal generic functions

P
parse-code: Internal functions
parse-definition-type: Internal functions
parse-line: Internal functions
parse-long-comment: Internal functions
parse-long-comment-explicit: Internal functions
parse-long-comment-implicit: Internal functions
parse-short-comment: Internal functions
parse-short-comment-explicit: Internal functions
parse-short-comment-implicit: Internal functions
post-process-output: Internal functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-command: Internal generic functions
process-doc: Internal generic functions
process-doc: Internal generic functions
process-doc: Internal generic functions
process-doc: Internal generic functions
process-doc: Internal generic functions
process-doc: Internal generic functions
process-file-to-string: Internal generic functions
process-file-to-string: Internal generic functions
process-file-to-string: Internal generic functions
process-file-to-string: Internal generic functions
process-file-to-string: Internal generic functions
process-fragment: Internal generic functions
process-fragment: Internal generic functions
process-fragment: Internal generic functions
process-fragment: Internal generic functions
process-fragments: Internal functions
process-string: Internal functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions
process-syntax: Internal generic functions

S
split-file-source: Internal functions

W
with-destination: Internal macros
with-error-handling: Internal macros
write-chunk: Internal generic functions
write-chunk: Internal generic functions
write-chunk-name: Internal generic functions
write-chunk-name: Internal generic functions
write-code: Internal generic functions
write-code: Internal generic functions
write-code: Internal generic functions
write-code: Internal generic functions
write-code: Internal generic functions
write-doc-line: Internal generic functions
write-doc-line: Internal generic functions
write-doc-line: Internal generic functions
write-indexes: Internal generic functions
write-indexes: Internal generic functions
write-indexes: Internal generic functions
write-indexes: Internal generic functions
write-indexes: Internal generic functions

Jump to:   %  
A   C   D   E   F   G   I   L   M   P   S   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*author*: Internal special variables
*catch-errors-p*: Exported special variables
*chunks*: Internal special variables
*code-indexing*: Exported special variables
*commands*: Internal special variables
*current-extract*: Internal special variables
*current-path*: Internal special variables
*debug*: Exported special variables
*erudite-package*: Exported special variables
*erudite-syntax*: Internal special variables
*extracts*: Internal special variables
*ignore*: Internal special variables
*implicit-code*: Exported special variables
*implicit-doc*: Exported special variables
*in-code-section*: Internal special variables
*include-path*: Internal special variables
*latex-document-class*: Internal special variables
*latex-highlight-syntax*: Internal special variables
*output-condition*: Internal special variables
*output-type*: Exported special variables
*parsing-doc*: Internal special variables
*short-comments-prefix*: Exported special variables
*sphinx-indent*: Internal special variables
*subtitle*: Exported special variables
*syntax*: Exported special variables
*title*: Exported special variables
*verbose*: Exported special variables

S
Special Variable, *author*: Internal special variables
Special Variable, *catch-errors-p*: Exported special variables
Special Variable, *chunks*: Internal special variables
Special Variable, *code-indexing*: Exported special variables
Special Variable, *commands*: Internal special variables
Special Variable, *current-extract*: Internal special variables
Special Variable, *current-path*: Internal special variables
Special Variable, *debug*: Exported special variables
Special Variable, *erudite-package*: Exported special variables
Special Variable, *erudite-syntax*: Internal special variables
Special Variable, *extracts*: Internal special variables
Special Variable, *ignore*: Internal special variables
Special Variable, *implicit-code*: Exported special variables
Special Variable, *implicit-doc*: Exported special variables
Special Variable, *in-code-section*: Internal special variables
Special Variable, *include-path*: Internal special variables
Special Variable, *latex-document-class*: Internal special variables
Special Variable, *latex-highlight-syntax*: Internal special variables
Special Variable, *output-condition*: Internal special variables
Special Variable, *output-type*: Exported special variables
Special Variable, *parsing-doc*: Internal special variables
Special Variable, *short-comments-prefix*: Exported special variables
Special Variable, *sphinx-indent*: Internal special variables
Special Variable, *subtitle*: Exported special variables
Special Variable, *syntax*: Exported special variables
Special Variable, *title*: Exported special variables
Special Variable, *verbose*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   E   P   S  
Index Entry  Section

E
erudite: The erudite system
erudite: The erudite package

P
Package, erudite: The erudite package

S
System, erudite: The erudite system

Jump to:   E   P   S