The docutils Reference Manual

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

The docutils Reference Manual

This is the docutils Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:38:44 2022 GMT+0.

Table of Contents


1 Introduction

.. -*-RST-*-

=====================================
CL-DOCUTILS: Docutils for Common Lisp
=====================================

:Author:       Dr John A.R. Williams
:Contact:      J.A.R.Williams@jarw.org.uk
:created:      22 September 2009
:status:       Draft
:version:      0.1
:copyright:    © 2009 J.A.R. Williams
:Abstract:   |CDU| is a Common Lisp implementation of the Docutils text
  processing system for processing plaintext into presentational
  formats such as HTML and LaTeX. It is based upon the Python Docutils 
  reference implementation but uses Common Lisp idioms making it
  easier to extend and more flexible. As with the reference
  implementation it includes a parser for the `reStructured text`_
  plaintext markup syntax which is suitable for marking up
  documentation and for use as user markup for collaborative web
  sites. It is successfully used to support a
  higher education peer-review assessment and online tutorial system.

.. meta::
   :keywords: reStructuredText, Docutils, text, Common Lisp

.. contents:: Table of Contents

.. |CDU| replace:: CL-DOCUTILS
.. _restructured text: http://docutils.sourceforge.net/docs/ref/rst/
.. _Python: http://www.python.org/
.. _FlexiStreams: http://weitz.de/flexi-streams/

Download and Installation
=========================

|CDU| together with this documentation can be downloaded from
. The
current version is 0.1.1.

|CDU| comes with a system definition for `ASDF
`_ and is compiled and loaded in the usual
way. It depends upon `CL-DATA-FORMAT-VALIDATION
`_ and
``_. A git repository is
available at . It has
been developed and tested using SBCL but should be portable to any
ANSI-compliant implementation of Common Lisp.

|CDU| is made available under the terms of the GPL v3 license - see
 the file ``LICENSE.txt`` for details.

Support
=======

For questions, bug reports, feature requests, improvements, or patches
relating to this implementation please email .

See `reStructured text`_ for the wide range of documentation on the
restructured text syntax and `Docutils
`_ for information on the
reference implementation on which this is based.

Convenience Functions For Users
===============================

Although this is intended as a library for embedding in other
applications the following functions in the DOCUTILS package are
provided as examples suitable for direct use:

- function **read-rst** `input => document`

  Read and parse restructured text from an input (a stream, string or
  pathname) and return the parsed document object.

- function **write-html** `output document`

  Write the parsed document to output (a stream or pathname) in html
  format.

- function **write-latex** `output document`

  Write the parsed document to output (a stream or pathname) in LaTeX
  format.

API For Developers
==================

This documentation is in early stages and those wishing to use the
library are encouraged to read the documentation for the Python Docutils
implementation to get a flavour and examine the code here to determine
differences. The generic interface is largely defined and documented
in the file ``publisher.lisp`` which is a good place to start. Queries
to the author as mentioned under support are also welcome.

---------
Data Flow
---------

The following diagram shows the components and data flow::

               -----READER----
              /               \
             /                 \
 SOURCE ---> PARSE ---> TRANSFORM ---> WRITER ---> OUTPUT

------
Source
------

Specialised methods of the API are already provided for `stream`,
`pathname` and `string` source types. It is the responsibility of the
source and output streams to handle external character encodings.

- generic function **new-document** `source => document`

  Implementations of this should create a new document instance with
  the appropriate non-default document settings from source. 

  The default method loads no settings and the method specialised on
  pathname source will load settings from `*standard-config-files*`
  and `cl-docutils.conf` in the pathname directory.

- generic function **read-lines** `source => vector`

  Given a source, return a vector of the text lines from source for
  subsequent parsing.

- generic function **settings** `source => hash-table`

  Return a hash table of processing settings to be associated with
  documents with this source.

- function **register-settings-spec** `specifications =>  specifications`

  Register a list of setting specifications. Each entry corresponds to
  one setting and has the form `(name type default description)`
  where `name` is a keyword symbol used to look up that setting,
  `type` the data format validation type specification, `default` a
  default value to be used if unspecified and `description` a string
  description suitable for users. 

  Specifications are normally given in text files in internet header
  style with the setting name, followed by a colon, followed by the
  textual representation of the value. Continuation lines are supported.

-----
Parse
-----

- generic function **read-document** `source reader => document`

  Read a document from `source` using `reader` and using the
  transforms associated with this reader return a fully parsed
  and transformed document.


The following restructured text specific API is exported from package
``docutils.parser.rst``.

- class **rst-reader**

  Class name of the standard restructured text parser.

- macro **def-role** `((name textvar &rest argument-list) &body body)`

  Define a new interpreted 
  role element handler for role with canonical name `name`.
  `textvar` is the name of the variable holding the textual argument
  to be referenced in `body` and `argument-list` is as follows::

   lambda-list::= ({var | (var [[specializer] [default]])}*
                  [{{&content {var [[specializer] [default]]}}] )

  `body` is the list of forms which should return a `docutils:text`
  node instance to be substituted into the document 

- macro **def-directive** `((name parent &rest argument-list) &body body)`

  Define a new directive element handler with name `name`. Similar to
  ``def-role`` except the `body` is responsible for adding nodes to
  the `parent` node.


---------
Transform
---------

- generic function **transforms** `reader => list`

  Return a list of transform specifications (class names) to be
  applied by this reader after parsing.

- generic function **transform** `transform`

  Evaluate the given transform instance on its node.

- generic function **do-transforms** `transforms document => document`

  Apply a list of transformation to the document in priority order.


------
Writer
------

- class **writer**

  Base class for all writer instances.

- generic function **visit-node** `writer node`

  Process the node updating `writer` parts accordingly. Visiting a
  document node will clear all document parts first.
 
- generic function **write-document** `writer document destination`

  Use `writer` to visit the `document` and write all parts in order
  to `destination`

- generic function **write-part** `writer part destination`

  Write a given named document part from a `writer` to `destination`. 

- generic function **settings** `writer` => settings

  Return an alist of settings associated with this specific writer
  instance which will override the document settings during `writer`
  processing.

- macro **with-part** `((part-name) &body)` => result

  Specify dynamically the document part to be written to using
  `part-append` and `part-prepend`.

- function **part-append** `&rest values`

  function **part-prepend** `&rest values`

  These function append or prepend their arguments to the currently
  set part of the current writer. 

- class **docutils.writer.html:html-writer**

  The base class for writing a document out in html format. The
  provided file ``docutils.css`` provides an example style sheet for
  the generated documents.

- class **docutils.writer.latex:latex-writer**

  The base class for writing a document out in latex format. The
  provided file ``docutils.tex`` should be placed in the latex search
  path as it is required by the produced latex documents.

---------
Variables
---------

- variable **`*unknown-reference-resolvers*`**

  List of functions to try to resolve unknown references during
  the transformation process. This can usefully be set to, for
  example, check against a database of pages in a live online system and
  return the relevant reference into the document.

- variable **`*standard-config-files*`**

  List of pathnames to files to be parsed in order for document
  configuration settings. Defaults include ``/etc/cl-docutils.conf``
  and ``~/.cl-docutils.conf``. A pathname source will also check for
  ``cl-docutils.conf`` file in the same directory.

- variable **`*default-reader-package*`**

  Value to bind `*package*` to when reading lisp forms from the
  document.

- variable **`*evaluator*`**

  Name of function to use to evaluate lisp forms in evaluateable
  nodes/

- variable **`*evaluation-error-hook*`**

  Function to be called if there are errors when calling `*evaluator*`

Differences from Reference Implementation
=========================================

Character Sets
  This Common Lisp implementation uses standard Lisp string handling and
  the CL-PPCRE regular expression library. Character set translation on
  input and output is orthogonal to this processing and can be formed
  using the appropriate specialised stream libraries such as
  FlexiStreams_.

Nested Inline Elements
  This implementation supports nested inline elements (where they make
  sense) whereas the reference implementation did not.

Error Messages
  Error messages is handled differently in this implementation with the
  result that they may not be located in exactly the same position
  relative the cause as in the Python implementation.

Python Enhancement Proposals
  Parsing of Python Enhancement Proposals (PEPs) is not supported as
  these have significance only for the Python community, however PEP
  references are supported as to enable the use of the stand-alone
  test documents provided with the reference Python implementation.

Customisation
=============

A fundamental requirement and important feature of restructured text
is that it can easily be customised and extended for use in embedded
applications (particularly web applications) without changing the core
language. Restructured text was explicitly designed with this in
mind, however the Common Lisp implementation is quite different,
and more powerful in this regard than the reference Python
implementation.

Directives
 The major feature for language extension at the block level is by the
 use of the named directive explicit markup. New directives can be
 defined using the ``def-directive`` macro.

Roles
 Roles provide a means of implementing new inline elements. They are
 defined using the ``def-role`` macro.

Transformations
 Transformations are associated with the parser element. If you wish
 new transformations to be run, use a subclass of the parser which
 return the appropriate list of transformations.

-------------------
Additional Elements
-------------------

- role **math**

  This role allows the embedding of mathematical expressions using
  LaTeX syntax. An implict syntax, delimiting the argument with '$$' is
  also provided.

- directive **equation**

  This directive allows the embedding of equations in LaTeX format.

- role **eval**

  A role allowing the embedding of inline evaluateable expressions in
  Lisp syntax

- directive **evaluation**

  A directive allowing embedding of expressions to be evaluated -
  Currently only Lisp expressions are supported.

Acknowledgements
================

The many contributers to the original Docutils project on which this based
and the many examples of code made available by Common Lisp community
which have inspired and taught me. Particular mention should go to Edi
Weitz for making available the CL-PPCRE used here and the Flex-Streams
library which can be used to deal with external character coding issue.

2 Systems

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


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

2.1 docutils

Document utilities and Restructured text parser

Maintainer

Dr. John A.R. Williams

Author

Dr. John A.R. Williams

License

GPL v3

Version

0.1.1

Dependencies
  • cl-ppcre (system).
  • trivial-gray-streams (system).
  • data-format-validation (system).
Source

docutils.asd.

Child Components

3 Modules

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


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

3.1 docutils/languages

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

docutils (system).

Child Components

3.2 docutils/parsers

Dependencies
Source

docutils.asd.

Parent Component

docutils (system).

Child Components

3.3 docutils/transforms

Dependencies
Source

docutils.asd.

Parent Component

docutils (system).

Child Components

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

3.4 docutils/writers

Dependency

parsers (module).

Source

docutils.asd.

Parent Component

docutils (system).

Child Components

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   [Contents][Index]

4.1.1 docutils/docutils.asd

Source

docutils.asd.

Parent Component

docutils (system).

ASDF Systems

docutils.


4.1.2 docutils/defpackage.lisp

Source

docutils.asd.

Parent Component

docutils (system).

Packages

4.1.3 docutils/nodes.lisp

Dependencies
Source

docutils.asd.

Parent Component

docutils (system).

Public Interface
Internals

4.1.4 docutils/publisher.lisp

Dependencies
Source

docutils.asd.

Parent Component

docutils (system).

Public Interface
Internals

4.1.5 docutils/utilities.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

docutils (system).

Public Interface
Internals

4.1.6 docutils/report.lisp

Dependencies
Source

docutils.asd.

Parent Component

docutils (system).

Public Interface
Internals

4.1.7 docutils/languages/translate.lisp

Source

docutils.asd.

Parent Component

languages (module).

Public Interface
Internals

4.1.8 docutils/languages/en.lisp

Dependency

translate.lisp (file).

Source

docutils.asd.

Parent Component

languages (module).


4.1.9 docutils/parsers/defpackage.lisp

Source

docutils.asd.

Parent Component

parsers (module).

Packages

4.1.10 docutils/parsers/state-machine.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

parsers (module).

Public Interface
Internals

4.1.11 docutils/parsers/inline.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

parsers (module).

Internals

4.1.12 docutils/parsers/regexp.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

parsers (module).

Internals

define-recursive-element-parse-tree (macro).


4.1.13 docutils/parsers/tables.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

parsers (module).

Public Interface
Internals

4.1.14 docutils/parsers/rst.lisp

Dependencies
Source

docutils.asd.

Parent Component

parsers (module).

Public Interface
Internals

4.1.15 docutils/parsers/directives.lisp

Dependencies
Source

docutils.asd.

Parent Component

parsers (module).

Public Interface
Internals

4.1.16 docutils/parsers/roles.lisp

Dependencies
Source

docutils.asd.

Parent Component

parsers (module).

Public Interface

def-role (macro).

Internals

4.1.17 docutils/transforms/defpackage.lisp

Source

docutils.asd.

Parent Component

transforms (module).

Internals

transform-condition (condition).


4.1.18 docutils/transforms/filter.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface

4.1.19 docutils/transforms/universal.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface
Internals

4.1.20 docutils/transforms/references.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface
Internals

4.1.21 docutils/transforms/frontmatter.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface
Internals

4.1.22 docutils/transforms/misc.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface

4.1.23 docutils/transforms/parts.lisp

Dependency

defpackage.lisp (file).

Source

docutils.asd.

Parent Component

transforms (module).

Public Interface
Internals

4.1.24 docutils/writers/html.lisp

Source

docutils.asd.

Parent Component

writers (module).

Packages

docutils.writer.html.

Public Interface
Internals

4.1.25 docutils/writers/latex.lisp

Source

docutils.asd.

Parent Component

writers (module).

Packages

docutils.writer.latex.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 docutils.utilities

Common utilities used by several docutils components

Source

defpackage.lisp.

Use List
  • common-lisp.
  • trivial-gray-streams.
Used By List
Public Interface
Internals

5.2 docutils.parser.tables

CALS Table parser

Source

defpackage.lisp.

Use List
Used By List

docutils.parser.rst.

Public Interface
Internals

5.3 docutils.nodes

Package containing standard docutils Node names

Source

defpackage.lisp.

Used By List
Public Interface

5.4 docutils.writer.latex

Latex writer for docutils

Source

latex.lisp.

Use List
Public Interface
Internals

5.5 docutils.parser.rst

Restructured text parser for docutils

Source

defpackage.lisp.

Use List
Public Interface
Internals

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

5.6 docutils.transform

Package containing standard docutils Node names

Source

defpackage.lisp.

Use List
Public Interface
Internals

5.7 docutils

Document handling and structured text parsing

Source

defpackage.lisp.

Use List
Used By List
Public Interface
Internals

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

5.8 docutils.writer.html

HTML with CSS writer for docutils

Source

html.lisp.

Use List
Public Interface
Internals

5.9 docutils.parser

Library for docutils parsers

Source

defpackage.lisp.

Use List
Used By List

docutils.parser.rst.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.1 Special variables

Special Variable: *current-line-number*

Current line number - used for line in node creation

Package

docutils.

Source

report.lisp.

Special Variable: *default-reader-package*

The default package Lisp expressions in the document are to be read into

Package

docutils.

Source

nodes.lisp.

Special Variable: *document*

Document (root element) currently being operated on

Package

docutils.

Source

nodes.lisp.

Special Variable: *evaluation-error-hook*

Hook to call when there is an error in the evaluator

Package

docutils.

Source

nodes.lisp.

Special Variable: *evaluator*

Function to call when evaluating an evaluateable node

Package

docutils.

Source

nodes.lisp.

Special Variable: *language*

Default language for processing

Package

docutils.utilities.

Source

translate.lisp.

Special Variable: *language-directory*

Directory in which translation data is held. Each language has a file containing an a-list mapping translated form to a cannonical form

Package

docutils.utilities.

Source

translate.lisp.

Special Variable: *namespace*

Prefix namespace for ids

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: *unknown-reference-resolvers*

List of functions to try to resolve unknown references. Unknown references have a ’refname’ attribute which doesn’t correspond to any target in the document. Called when FinalCheckVisitor is unable to find a correct target. The list should contain functions which will try to resolve unknown references, with the following signature::

(defun reference_resolver(node)
"Returns boolean: true if resolved, false if not."
)

Package

docutils.

Source

publisher.lisp.

Special Variable: +wsp+

White space characters: Space, Tab, Return, Newline, Page, PageUp

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: +wsp-transitions+

Transitons for a wsp state machine

Package

docutils.parser.

Source

state-machine.lisp.


6.1.2 Macros

Macro: collate-nodes ((node root) test)
Package

docutils.

Source

nodes.lisp.

Macro: def-directive (name (nodevar &rest lambda-list) &body body)

Define a directive handler for directive named name. lambda-list is a directive lambda-list as follows
lambda-list::= ({var | (var [specializer])}* [&allow-spaces]
[&option {var | (var [specializer])}* ] [{{&content {var}}]
[{&parsed-content {var} [{kwargs}]] )

Package

docutils.parser.rst.

Source

directives.lisp.

Macro: def-role (name (textvar &rest lambda-list) &body body)

Define a role handler for role with cannonical name name. content and options will come from the role directive. lambda list is as follows lambda-list::= ({var | (var [[specializer] [default]])}*
[{{&content {var [[specializer] [default]]}}] )

Package

docutils.parser.rst.

Source

roles.lisp.

Macro: for ((var start stop) &body body)
Package

docutils.utilities.

Source

utilities.lisp.

Macro: when-bind ((var expr) &body body)

Bind VAR to VALUE of expression, execute body if true

Package

docutils.utilities.

Source

utilities.lisp.

Macro: while (test &body body)

Repeat body while test returns true

Package

docutils.utilities.

Source

utilities.lisp.

Macro: with-attributes ((key value node &key copy) &body body)

Interate body over the attributes of a node setting key and value in turn. If keyword copy is true, the iteration will be over a list of the attribute list may be modified during iteration, otherwise it may not.

Package

docutils.

Source

nodes.lisp.

Macro: with-block-indentation ((n os) &body body)
Package

docutils.utilities.

Source

utilities.lisp.

Macro: with-children ((node parent &key copy) &body body)

Exevute body over the children of a node
During execution of the body a catch tags is available for :skip-siblings which will terminate the iteration

Package

docutils.

Source

nodes.lisp.

Macro: with-nodes ((node root &key copy) &body body)

Traverse a node tree depth first executing body for side affects. The body is executed then children are traversed (if an element). During execution of the body catch tags are available for :skip-children and :skip-siblings to finish processing children of current node or children of parent node. Execution is inside
a nil block. Returns nil

Package

docutils.

Source

nodes.lisp.

Macro: with-part ((part-name) &body body)
Package

docutils.

Source

publisher.lisp.

Macro: with-reports-to-node ((node) &body body)
Package

docutils.

Source

report.lisp.


6.1.3 Ordinary functions

Function: abs-line-number (state-machine)
Package

docutils.parser.

Source

state-machine.lisp.

Function: abs-line-offset (state-machine)

Return Return line offset of current line, from beginning of file.

Package

docutils.parser.

Source

state-machine.lisp.

Function: add-backref (element id)
Package

docutils.

Source

nodes.lisp.

Function: add-states (state-machine state-classnames)

register state classes with this state engine

Package

docutils.parser.

Source

state-machine.lisp.

Function: add-transitions (state transitions)

Add a list of transitions to the start of the transition list.

Package

docutils.parser.

Source

state-machine.lisp.

Function: author-separators (&optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: babel (&optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: canonical-text (text &optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: convert-length-unit (size unit)
Package

docutils.utilities.

Source

utilities.lisp.

Function: copy-stream (from to &optional count)

Copy from input stream FROM into output stream TO upto COUNT bytes, or until end-of-file if COUNT is NIL

Package

docutils.utilities.

Source

utilities.lisp.

Function: current-line (state-machine &optional index)
Package

docutils.parser.

Source

state-machine.lisp.

Function: escape2null (string &key start end)

Return a string with escape-backslashes converted to nulls.

Package

docutils.utilities.

Source

utilities.lisp.

Function: external-targets (element)
Package

docutils.transform.

Source

references.lisp.

Function: find-file (pathname &key search-path)

Return the first complete pathname for an existing file found by merging pathname with each item in a search path in turn. Returns nil if not found

Package

docutils.utilities.

Source

utilities.lisp.

Function: footnotes (document)
Package

docutils.transform.

Source

references.lisp.

Function: get-indented (state-machine &key until-blank strip-indent first-indent block-indent strip-top)

Return an indented block and info.

Extract an indented block where the indent is known for all lines. Starting with the current line, extract the entire text block with at least ‘indent‘ indentation (which must be whitespace, except for the first line).

:Parameters:
- ‘block-indent‘: The number of indent columns/characters if the indent is known for all lines.
- first-indent: The indent where the indent is known for the first line and unknown for all other lines.
- ‘until_blank‘: Stop collecting at the first blank line if true (1).
- ‘strip_indent‘: Strip ‘indent‘ characters of indentation if true (1, default).
- ‘strip_top‘: Strip blank lines from the beginning of the block.

:Return:
- the indented block,
- its first line offset from BOF, and
- whether or not it finished with a blank line.
- then indent,

Package

docutils.parser.

Source

state-machine.lisp.

Function: get-text-block (state-machine &key flush-left start)

Return a contiguous block of text.

If ‘flush_left‘ is true, signal ‘UnexpectedIndentationError‘ if an indented line is encountered before the text block ends (with a blank line).

Package

docutils.parser.

Source

state-machine.lisp.

Function: goto-line (state abs-line-offset)

Jump to absolute line offset abs-line-offset, load and return it.

Package

docutils.parser.

Source

state-machine.lisp.

Function: ids (element)

Return mapping of ids to nodes in element.

Package

docutils.

Source

nodes.lisp.

Function: indent-level (line &key tab-size)

Returns the indentation level of the line, including tabs as expanded

Package

docutils.utilities.

Source

utilities.lisp.

Function: indented-block (lines &key start until-blank strip-indent block-indent first-indent)

Extract and return a vector of indented lines of text.

Collect all lines with indentation, determine the minimum indentation, remove the minimum indentation from all indented lines unless STRIP-INDENT is false, and return them. All lines up to but not including the first unindented line will be returned in a new vector.

Keyword arguments:
START: The index of the first line to examine.
UNTIL-BLANK: Stop collecting at the first blank line if true. STRIP-INDENT: Strip common leading indent if true (default). BLOCK-INDENT: The indent of the entire block, if known. FIRST-INDENT: The indent of the first line, if known.

Returns values:
a new vector of the indented lines with minimum indent removed
the amount of the indent
a boolean: did the indented block finish with a blank line or EOF?

Package

docutils.utilities.

Source

utilities.lisp.

Function: insert-lines (state-machine lines &optional offset)
Package

docutils.parser.

Source

state-machine.lisp.

Function: internal-targets (element)
Package

docutils.transform.

Source

references.lisp.

Function: is-prefix-p (subseq seq &key start test)

Return true if subseq is a prefix in seq

Package

docutils.utilities.

Source

utilities.lisp.

Function: is-suffix-p (subseq seq &key test)

Return true if subseq is a suffix in seq

Package

docutils.utilities.

Source

utilities.lisp.

Function: known-first-indent (state match)

Handle a known-indent text block (first line’s indent
known). Extend or override in subclasses. Recursively run the state machine for indented blocks

Package

docutils.parser.

Source

state-machine.lisp.

Function: known-indent (state match)

Handle a known-indent text block. Extend or override in subclasses. Recursively run the state machine for indented blocks

Package

docutils.parser.

Source

state-machine.lisp.

Function: last-char (stream)

Return last character written to the stream

Package

docutils.utilities.

Source

utilities.lisp.

Function: latex-double-quote-replacement (&optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: latex-quotes (&optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: length-unit (unit)
Package

docutils.utilities.

Source

utilities.lisp.

Function: line-blank-p (line)
Package

docutils.utilities.

Source

utilities.lisp.

Function: line-length (line)

Return length of line excluding trailing whitespace

Package

docutils.utilities.

Source

utilities.lisp.

Function: lstrip (string)
Package

docutils.utilities.

Source

utilities.lisp.

Function: make-id (string)

Make an ID from string that meets requirements of CSS and html 4.01

Package

docutils.utilities.

Source

utilities.lisp.

Function: make-name (name &key char-transform namespace)
Package

docutils.utilities.

Source

utilities.lisp.

Function: match (pattern string &key start end)
Package

docutils.parser.

Source

state-machine.lisp.

Reader: match-end (instance)
Writer: (setf match-end) (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Target Slot

end.

Function: match-group (match &optional n)

Return a new subsequence corresponding to match group n of match. If n is not specified returns entire match

Package

docutils.parser.

Source

state-machine.lisp.

Function: match-group-length (match n)

Return length of the subsequence corresponding to match group n of match

Package

docutils.parser.

Source

state-machine.lisp.

Reader: match-reg-ends (instance)
Writer: (setf match-reg-ends) (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Target Slot

reg-ends.

Reader: match-reg-starts (instance)
Writer: (setf match-reg-starts) (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Target Slot

reg-starts.

Reader: match-start (instance)
Writer: (setf match-start) (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Target Slot

start.

Reader: match-string (instance)
Writer: (setf match-string) (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Target Slot

string.

Function: matches (pattern string &key start end)
Package

docutils.parser.

Source

state-machine.lisp.

Function: named-node (element name)
Package

docutils.

Source

nodes.lisp.

Function: nameids (element &optional ids)

Mapping of names to unique id’s.

Package

docutils.

Source

nodes.lisp.

Function: next-line (state-machine &optional n)
Package

docutils.parser.

Source

state-machine.lisp.

Function: next-line-blank-p (state-machine)

TRUE if the next line is blank or non-existant.

Package

docutils.parser.

Source

state-machine.lisp.

Function: next-sibling (element)
Package

docutils.

Source

nodes.lisp.

Function: normalise-name (name)
Package

docutils.utilities.

Source

utilities.lisp.

Function: parse-table (parser-class-name block)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: part-append (&rest values)
Package

docutils.

Source

publisher.lisp.

Function: part-prepend (&rest values)
Package

docutils.

Source

publisher.lisp.

Function: prev-sibling (element)
Package

docutils.

Source

nodes.lisp.

Function: previous-line (state-machine &optional n)
Package

docutils.parser.

Source

state-machine.lisp.

Function: read-rst (input)
Package

docutils.

Source

rst.lisp.

Function: refids (element)

Mapping of ids to lists of referencing nodes.

Package

docutils.

Source

nodes.lisp.

Function: refnames (element)

Return mapping of names to lists of referencing nodes.

Package

docutils.

Source

nodes.lisp.

Function: register-settings-spec (new-spec)
Package

docutils.

Source

publisher.lisp.

Function: remove-transition (state name)

Remove a transition by ‘name‘

Package

docutils.parser.

Source

state-machine.lisp.

Function: report (level message &key node line source backrefs data)

Signals a report. Handlers will check settings to either halt processing or issue a report and return. If a system message has been added by handler, it is returned using the system-message restart

Package

docutils.

Source

report.lisp.

Function: rstrip (string)

Remove trailing white space from string

Package

docutils.utilities.

Source

utilities.lisp.

Function: section (writer &optional level)

Return the section name at the given level for the specific document class.

Package

docutils.nodes.

Source

latex.lisp.

Function: set-id (node &optional document ids)

This will set and return the id for a node.

Package

docutils.

Source

nodes.lisp.

Function: split-lines (string)

Return a vector of lines split from string

Package

docutils.utilities.

Source

utilities.lisp.

Function: state-correction (&optional lines)
Package

docutils.parser.

Source

rst.lisp.

Function: strip (string)

Remove prefixing and trailing white space from string

Package

docutils.utilities.

Source

utilities.lisp.

Function: transition-match (transition string)
Package

docutils.parser.

Source

state-machine.lisp.

Function: transition-name (transition)
Package

docutils.parser.

Source

state-machine.lisp.

Function: translated-text (text &optional language)
Package

docutils.utilities.

Source

translate.lisp.

Function: unescape (text &key restore-backslashes start end)

Return a string with nulls removed or restored to backslashes. Backslash-escaped spaces are also removed.

Package

docutils.utilities.

Source

utilities.lisp.

Function: unwrite-char (stream)

Removes last character from buffer and returns it if possible. If buffer was empty returns nil.

Package

docutils.utilities.

Source

utilities.lisp.

Function: whitespace-normalise-name (name)

Return and whitespace-normalized name.

Package

docutils.utilities.

Source

utilities.lisp.

Function: write-html (os document)
Package

docutils.

Source

html.lisp.

Function: write-latex (os document)
Package

docutils.

Source

latex.lisp.

Function: wsp-char-p (c)
Package

docutils.utilities.

Source

utilities.lisp.


6.1.4 Generic functions

Generic Function: add-child (parent child &optional index)

Add child as a child node of node, either inserting
it at position index or appending it to the end if no index is specified (default)

Package

docutils.

Source

nodes.lisp.

Methods
Method: add-child ((node text-element) (child system-message) &optional index)

Add system message to part of a text element

Method: add-child :after (node (child targetable) &optional index)
Method: add-child ((node text-element) (child string) &optional index)
Method: add-child ((node element) (children sequence) &optional index)

Append a set of children into a node

Method: add-child ((node element) (child node) &optional index)
Generic Function: add-class (node name)

Add class to given node

Package

docutils.

Source

nodes.lisp.

Methods
Method: add-class ((node element) (name string))
Generic Function: allowed-child-p (parent node &optional index)

Return true if node is allowed as a child of parent

Package

docutils.

Source

nodes.lisp.

Methods
Method: allowed-child-p ((parent meta) child &optional index)
Source

directives.lisp.

Method: allowed-child-p ((element element) (child image) &optional index)
Method: allowed-child-p ((element element) (child reference) &optional index)
Method: allowed-child-p ((parent element) (child raw) &optional index)
Method: allowed-child-p ((parent field) child &optional index)
Method: allowed-child-p ((element element) (child label) &optional index)
Method: allowed-child-p ((element element) (child target) &optional index)
Method: allowed-child-p ((parent field-list) child &optional index)
Method: allowed-child-p (parent (child structural) &optional index)
Method: allowed-child-p ((parent document) (child structural) &optional index)
Method: allowed-child-p ((parent section) (child structural) &optional index)
Method: allowed-child-p ((parent topic) (child structural) &optional index)
Method: allowed-child-p ((parent structural) (child topic) &optional index)
Method: allowed-child-p ((parent element) (child topic) &optional index)
Method: allowed-child-p ((element text-element) (child text-element) &optional index)
Method: allowed-child-p ((element text-element) (child text) &optional index)
Method: allowed-child-p ((element text-element) child &optional index)
Method: allowed-child-p ((element element) (child inline) &optional index)
Method: allowed-child-p ((element element) child &optional index)
Generic Function: apply-transition (state transition match)

Execute transition from state with match

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: apply-transition ((state rst-state) transition match)
Source

rst.lisp.

Method: apply-transition (state transition match)
Generic Function: as-sexp (element)

Return lisp s-exp representation of an element

Package

docutils.

Source

nodes.lisp.

Methods
Method: as-sexp ((node element))
Method: as-sexp ((node evaluateable))
Method: as-sexp ((node text))
Generic Function: as-text (element)

Return text representation of an element as a string

Package

docutils.

Source

nodes.lisp.

Methods
Method: as-text ((node image))
Method: as-text ((node system-message))
Method: as-text ((element option-argument))
Method: as-text ((node element))
Method: as-text ((node evaluateable))
Method: as-text ((node text))
Generic Function: (setf as-text) (element)

Set the text value of a node (if allowed)

Package

docutils.

Source

nodes.lisp.

Methods
Method: (setf as-text) ((node text))
Generic Function: attribute (node label)

Return an attribute of a node corresponding to label

Package

docutils.

Source

nodes.lisp.

Methods
Method: attribute ((node element) (label symbol))

Return an attribute corresponding to label

Generic Function: (setf attribute) (node label)

Set a named attribute of an element

Package

docutils.

Source

nodes.lisp.

Methods
Method: (setf attribute) ((element raw) (label (eql :format)))
Source

directives.lisp.

Method: (setf attribute) ((node element) (label symbol))

Set an attribute of an element

Generic Reader: backrefs (object)
Package

docutils.

Methods
Reader Method: backrefs ((backlinkable backlinkable))

automatically generated reader method

Source

nodes.lisp.

Target Slot

backrefs.

Generic Function: blank (state match)

Handle blank lines.

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: blank ((state quoted-literal-block) match)
Source

rst.lisp.

Method: blank ((state line) match)

Transition marker.

Source

rst.lisp.

Method: blank ((state specialized-text) match)
Source

rst.lisp.

Method: blank ((state text) match)

End of paragraph.

Source

rst.lisp.

Method: blank ((state line-block) match)
Source

rst.lisp.

Method: blank ((state rfc2822-list) match)
Source

rst.lisp.

Method: blank ((state wsp-state) match)

Handle blank lines. Does nothing. Override in subclasses.

Generic Function: blank-finish (object)
Package

docutils.parser.

Methods
Method: blank-finish (state)
Source

state-machine.lisp.

Reader Method: blank-finish ((wsp-state-machine wsp-state-machine))

Used to keep track of blank lines

Source

state-machine.lisp.

Target Slot

blank-finish.

Generic Writer: (setf blank-finish) (object)
Package

docutils.parser.

Methods
Writer Method: (setf blank-finish) ((wsp-state-machine wsp-state-machine))

Used to keep track of blank lines

Source

state-machine.lisp.

Target Slot

blank-finish.

Generic Function: bof (state)

Beginning of file transition

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: bof (state)
Generic Reader: caption (object)
Package

docutils.nodes.

Methods
Reader Method: caption ((latex-table latex-table))

automatically generated reader method

Source

latex.lisp.

Target Slot

caption.

Generic Function: child (parent index)

Return a child at position index

Package

docutils.

Source

nodes.lisp.

Methods
Method: child ((node element) (index integer))

Return a child at position index

Generic Function: copy-of-node (node)

Deep copy a node

Package

docutils.

Source

nodes.lisp.

Methods
Method: copy-of-node ((node evaluateable))
Method: copy-of-node ((node element))
Method: copy-of-node ((node string))
Method: copy-of-node ((node text))
Method: copy-of-node ((node node))
Method: copy-of-node (node)
Generic Reader: date (object)
Generic Writer: (setf date) (object)
Package

docutils.nodes.

Methods
Reader Method: date ((latex-writer latex-writer))
Writer Method: (setf date) ((latex-writer latex-writer))

Set date

Source

latex.lisp.

Target Slot

date.

Generic Function: docinfo (document)

Return the docinfo component of a document

Package

docutils.nodes.

Source

nodes.lisp.

Methods
Method: docinfo ((document document))
Generic Function: document (node)

Return the document root of the tree containing this node

Package

docutils.nodes.

Source

nodes.lisp.

Methods
Reader Method: document ((rst-state-machine rst-state-machine))

Top level Document Markup

Source

rst.lisp.

Target Slot

document.

Method: document ((node document))
Method: document ((node node))
Generic Writer: (setf document) (component)

Set the document to be processed and reset the component

Package

docutils.nodes.

Source

publisher.lisp.

Methods
Writer Method: (setf document) ((rst-state-machine rst-state-machine))

Top level Document Markup

Source

rst.lisp.

Target Slot

document.

Generic Function: eof (state)

End of file transition

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: eof ((state quoted-literal-block))
Source

rst.lisp.

Method: eof ((state line))
Source

rst.lisp.

Method: eof ((state definition))

Not a definition.

Source

rst.lisp.

Method: eof ((state specialized-text))
Source

rst.lisp.

Method: eof ((state text))
Source

rst.lisp.

Method: eof (state)
Generic Reader: error-data (condition)
Package

docutils.

Methods
Reader Method: error-data ((condition markup-condition))
Source

report.lisp.

Target Slot

data.

Generic Reader: error-level (condition)
Package

docutils.

Methods
Reader Method: error-level ((condition markup-condition))
Source

report.lisp.

Target Slot

level.

Generic Reader: error-line (condition)
Generic Writer: (setf error-line) (condition)
Package

docutils.

Methods
Reader Method: error-line ((condition markup-condition))
Writer Method: (setf error-line) ((condition markup-condition))
Source

report.lisp.

Target Slot

line.

Reader Method: error-line ((condition unexpected-indentation))
Source

state-machine.lisp.

Target Slot

line-number.

Generic Reader: error-message (condition)
Package

docutils.

Methods
Reader Method: error-message ((condition markup-condition))
Source

report.lisp.

Target Slot

message.

Generic Reader: error-node (condition)
Package

docutils.

Methods
Reader Method: error-node ((condition markup-condition))
Source

report.lisp.

Target Slot

node.

Generic Function: error-severity (entity)

Return the error-severity (0-10) for an entity

Package

docutils.

Source

report.lisp.

Methods
Method: error-severity ((c system-message))
Source

nodes.lisp.

Method: error-severity ((c symbol))
Method: error-severity ((c markup-condition))
Generic Reader: error-text-block (condition)
Package

docutils.

Methods
Reader Method: error-text-block ((condition insert-lines))
Source

state-machine.lisp.

Target Slot

text-block.

Reader Method: error-text-block ((condition unexpected-indentation))
Source

state-machine.lisp.

Target Slot

text-block.

Generic Function: evaluate (node)

Evaluate the node in current dynamic context, returning the result.

Package

docutils.

Source

nodes.lisp.

Methods
Method: evaluate ((node evaluateable))
Method: evaluate ((node element))
Method: evaluate (node)
Generic Reader: evaluation-language (object)
Package

docutils.

Methods
Reader Method: evaluation-language ((evaluateable evaluateable))

automatically generated reader method

Source

nodes.lisp.

Target Slot

language.

Generic Function: field-value (name field-list)

Return the field text for a specific field name

Package

docutils.

Source

nodes.lisp.

Methods
Method: field-value (name field-list)
Method: field-value (name (document document))
Generic Function: html-url (writer uri &rest args)

Resolve an external media reference to a url for
this writer on the basis of content-type and args. May be specialised to, for example, use a media server or automatically do conversions etc.

Package

docutils.writer.html.

Source

html.lisp.

Methods
Method: html-url ((writer html-writer) uri &rest args)
Generic Function: indent (state match)

Handle an indented text block. Extend or override
in subclasses. Recursively run the state machine for indented blocks

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: indent ((state quoted-literal-block) match)
Source

rst.lisp.

Method: indent ((state line) match)
Source

rst.lisp.

Method: indent ((state definition) match)

Definition list item.

Source

rst.lisp.

Method: indent ((state specialized-text) match)
Source

rst.lisp.

Method: indent ((state text) match)

Definition list item.

Source

rst.lisp.

Method: indent ((state body) match)

Block quote.

Source

rst.lisp.

Method: indent ((state wsp-state) match)

Handle an indented text block. Extend or override in subclasses. Recursively run the state machine for indented blocks

Generic Function: index (parent child)

Return the posiiton of child in element

Package

docutils.

Source

nodes.lisp.

Methods
Method: index ((node element) (child node))
Generic Reader: initial-state (object)
Package

docutils.parser.

Methods
Reader Method: initial-state ((state-machine state-machine))

the initial state name.

Source

state-machine.lisp.

Target Slot

initial-state.

Generic Reader: initial-transitions (object)
Package

docutils.parser.

Methods
Reader Method: initial-transitions ((state state))

The initial set of transitions for this state

Source

state-machine.lisp.

Target Slot

initial-transitions.

Generic Reader: input-lines (object)
Package

docutils.parser.

Methods
Reader Method: input-lines ((state-machine state-machine))

vector of input lines (without newlines)

Source

state-machine.lisp.

Target Slot

input-lines.

Generic Function: language (node)

Language for this node

Package

docutils.

Source

nodes.lisp.

Methods
Method: language ((node document))
Method: language ((node element))
Method: language ((node node))
Generic Reader: line (element)

The line number (1-based) of the beginning of this Node in ‘source‘.

Package

docutils.nodes.

Source

nodes.lisp.

Methods
Reader Method: line ((node node))

The line number (1-based) of the beginning of this Node in source.

Target Slot

line.

Generic Reader: line-offset (object)
Generic Writer: (setf line-offset) (object)
Package

docutils.parser.

Methods
Reader Method: line-offset ((state-machine state-machine))
Writer Method: (setf line-offset) ((state-machine state-machine))

Current input line offset from beginning of input-lines.

Source

state-machine.lisp.

Target Slot

line-offset.

Generic Function: make-node (node-type &rest attributes)

Make a node with given initialisers

Package

docutils.

Source

nodes.lisp.

Methods
Method: make-node ((node system-message) &rest message-args)
Method: make-node ((node text-element) &rest contents)
Method: make-node ((node element) &rest contents)
Method: make-node ((node (eql docutils.nodes:text)) &rest attributes)
Method: make-node ((node-type symbol) &rest contents)
Generic Function: namespace (id)
Package

docutils.utilities.

Source

utilities.lisp.

Methods
Method: namespace ((p pathname))
Source

rst.lisp.

Reader Method: namespace ((document document))

automatically generated reader method

Source

nodes.lisp.

Target Slot

namespace.

Method: namespace ((node node))
Source

nodes.lisp.

Method: namespace ((id string))

Return the namespace component of an id or nil if none. Returns other id component as second value

Generic Function: new-document (source)

Create and return a new empty document tree (root node).

Package

docutils.

Source

publisher.lisp.

Methods
Method: new-document (source)
Method: new-document ((source pathname))
Generic Function: no-match (state transitions)

Called when there is no match from ‘StateMachine.check_line()‘.

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: no-match ((state specialized-body) transitions)
Source

rst.lisp.

Method: no-match ((state rst-state) transitions)

This code should never be run.

Source

rst.lisp.

Method: no-match (state transitions)
Generic Reader: node (object)
Generic Writer: (setf node) (object)
Package

docutils.nodes.

Methods
Reader Method: node ((nested-state-machine nested-state-machine))
Writer Method: (setf node) ((nested-state-machine nested-state-machine))

Current node in document

Source

rst.lisp.

Target Slot

node.

Reader Method: node ((rst-state-machine rst-state-machine))
Writer Method: (setf node) ((rst-state-machine rst-state-machine))

Current node in document

Source

rst.lisp.

Target Slot

node.

Reader Method: node ((transform transform))

The node at which this transform is to start

Source

publisher.lisp.

Target Slot

node.

Generic Function: nop (state match)

A do nothing transition method.

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: nop (state match)
Generic Function: number-children (node)

Reutrn the number of children a node has

Package

docutils.

Source

nodes.lisp.

Methods
Method: number-children ((node element))
Generic Reader: output-format (object)
Package

docutils.

Methods
Reader Method: output-format ((evaluateable evaluateable))

Specifies what format the output is in (for writers).

Source

nodes.lisp.

Target Slot

output-format.

Generic Function: parent (node)

Back-reference to the Node immediately containing this Node.

Package

docutils.

Source

nodes.lisp.

Methods
Reader Method: parent ((rst-state rst-state))

parent node being processed

Source

rst.lisp.

Target Slot

parent.

Method: parent ((node document))
Reader Method: parent ((node node))

The parent of this node in the document tree

Target Slot

parent.

Generic Writer: (setf parent) (object)
Package

docutils.

Methods
Writer Method: (setf parent) ((rst-state rst-state))

parent node being processed

Source

rst.lisp.

Target Slot

parent.

Generic Reader: parts (object)
Package

docutils.

Methods
Reader Method: parts ((writer writer))

List of slot names for component parts in
the output. The writer should accumulate strings on each part using push.

Source

publisher.lisp.

Target Slot

parts.

Generic Function: read-document (source reader)

Create and read a new document using reader from source

Package

docutils.

Source

publisher.lisp.

Methods
Method: read-document :around (source (reader recursive-rst-reader))
Source

rst.lisp.

Method: read-document (source (reader metadata-reader))
Source

rst.lisp.

Method: read-document (source (reader rst-reader))
Source

rst.lisp.

Method: read-document :around (source (reader reader))
Generic Function: read-lines (entity)

Read and return a vector of lines from an entity for subsequent parsing

Package

docutils.utilities.

Source

utilities.lisp.

Methods
Method: read-lines ((source vector))
Method: read-lines ((source string))
Method: read-lines ((source pathname))
Method: read-lines ((is stream))
Generic Reader: referenced (object)
Package

docutils.

Methods
Reader Method: referenced ((targetable targetable))

automatically generated reader method

Source

nodes.lisp.

Target Slot

referenced.

Generic Writer: (setf referenced) (object)
Package

docutils.

Methods
Writer Method: (setf referenced) ((targetable targetable))

automatically generated writer method

Source

nodes.lisp.

Target Slot

referenced.

Generic Function: rem-attribute (node label)

Remove an attribute from a node

Package

docutils.

Source

nodes.lisp.

Methods
Method: rem-attribute ((node element) (label symbol))
Generic Function: rem-child (parent child-ref)

Remove a child element from parent

Package

docutils.

Source

nodes.lisp.

Methods
Method: rem-child ((node element) (item node))
Method: rem-child ((node element) (index integer))

Remove an child element at index

Generic Function: remove-node (node &optional index)

Remove a node

Package

docutils.

Source

nodes.lisp.

Methods
Method: remove-node ((node node) &optional index)
Generic Reader: resolved (object)
Package

docutils.

Methods
Reader Method: resolved ((resolvable resolvable))

automatically generated reader method

Source

nodes.lisp.

Target Slot

resolved.

Generic Writer: (setf resolved) (object)
Package

docutils.

Methods
Writer Method: (setf resolved) ((resolvable resolvable))

automatically generated writer method

Source

nodes.lisp.

Target Slot

resolved.

Generic Function: setting (name entity)

Return the value of given setting for entity

Package

docutils.

Source

publisher.lisp.

Methods
Method: setting ((name (eql :trim-footnote-reference-space)) entity)
Source

rst.lisp.

Method: setting ((name symbol) (hash hash-table))
Method: setting ((name symbol) (list list))
Method: setting ((name symbol) (document document))
Method: setting ((name symbol) (entity null))
Method: setting ((name symbol) (node node))
Method: setting ((name symbol) (writer writer))
Generic Function: (setf setting) (key element)

Set a setting value for an entity

Package

docutils.

Source

publisher.lisp.

Methods
Method: (setf setting) ((name symbol) (hash hash-table))
Method: (setf setting) ((name symbol) (document document))
Generic Function: settings (object)
Package

docutils.

Methods
Method: settings ((document-path pathname))
Source

publisher.lisp.

Reader Method: settings ((writer writer))

Overwritten setting affecting document writing

Source

publisher.lisp.

Target Slot

settings.

Method: settings (source)
Source

publisher.lisp.

Reader Method: settings ((document document))

Runtime settings data record.

Source

nodes.lisp.

Target Slot

settings.

Generic Function: (setf settings) (document)
Package

docutils.

Methods
Method: (setf settings) ((document document))
Source

nodes.lisp.

Generic Reader: state-machine (object)
Package

docutils.parser.

Methods
Reader Method: state-machine ((state state))

A reference to the controlling StateMachine object.

Source

state-machine.lisp.

Target Slot

state-machine.

Generic Function: state-machine-run (state-machine input-lines &key input-offset initial-state node match-titles document inliner &allow-other-keys)

Run state machine over input lines filling in document

Package

docutils.parser.

Source

state-machine.lisp.

Methods
Method: state-machine-run ((state-machine nested-state-machine) (input-lines vector) &key input-offset node match-titles &allow-other-keys)
Source

rst.lisp.

Method: state-machine-run ((state-machine rst-state-machine) (input-lines vector) &key document inliner node match-titles &allow-other-keys)
Source

rst.lisp.

Method: state-machine-run ((state-machine state-machine) (input-lines vector) &key input-offset initial-state &allow-other-keys)

Run the state machine on INPUT-LINES. Return results (a list).

INPUT-LINES: a list of strings without newlines. INPUT-OFFSET: the line offset of ‘input_lines‘ from the beginning of the data.
INPUT-SOURCE: name or path of source of INPUT_LINES.

Generic Function: substitute-node (new old &optional parent)

Substitute new node for and old node in document tree

Package

docutils.

Source

nodes.lisp.

Methods
Method: substitute-node ((new element) (index integer) &optional parent)

Substitute new element for old node at index of parent node

Method: substitute-node ((new node) (old node) &optional parent)

Substitute new node for old node in document tree

Generic Function: supports-format (writer format)

Returns true if given writer supports a specific format

Package

docutils.

Source

publisher.lisp.

Generic Function: title (entity)

Return the title for an entity

Package

docutils.nodes.

Source

nodes.lisp.

Methods
Reader Method: title ((latex-writer latex-writer))

automatically generated reader method

Source

latex.lisp.

Target Slot

title.

Method: title ((element element))
Generic Writer: (setf title) (object)
Package

docutils.nodes.

Methods
Writer Method: (setf title) ((latex-writer latex-writer))

automatically generated writer method

Source

latex.lisp.

Target Slot

title.

Generic Function: transform (transform)

Apply a given transform to its’ document node

Package

docutils.

Source

publisher.lisp.

Methods
Method: transform ((transform fignum))
Source

parts.lisp.

Method: transform ((transform sectnum))
Source

parts.lisp.

Method: transform ((transform contents))
Source

parts.lisp.

Method: transform ((transform evaluate-transform))
Source

misc.lisp.

Method: transform ((transform simple-transform))
Source

misc.lisp.

Method: transform ((transform class-attribute))
Source

misc.lisp.

Method: transform ((transform docinfo))
Source

frontmatter.lisp.

Method: transform ((transform doctitle))
Source

frontmatter.lisp.

Method: transform ((transform resolve-media))
Source

references.lisp.

Method: transform ((transform substitutions))
Source

references.lisp.

Method: transform ((transform footnotes))
Source

references.lisp.

Method: transform ((transform internal-targets))
Source

references.lisp.

Method: transform ((transform external-targets))
Source

references.lisp.

Method: transform ((transform indirect-hyperlinks))
Source

references.lisp.

Method: transform ((transform anonymous-hyperlinks))
Source

references.lisp.

Method: transform ((transform chained-targets))
Source

references.lisp.

Method: transform ((transform target-notes))
Source

references.lisp.

Method: transform ((transform final-checks))
Source

universal.lisp.

Method: transform ((transform filter-messages))
Source

universal.lisp.

Method: transform ((transform decorations))
Source

universal.lisp.

Method: transform ((filter filter))
Source

filter.lisp.

Method: transform ((f function))
Generic Function: transforms (reader)

Return a list of the default transforms class names to be applied after parsing

Package

docutils.

Source

publisher.lisp.

Methods
Method: transforms ((reader rst-reader))
Source

rst.lisp.

Method: transforms ((reader reader))

Default transforms for standard reader

Source

universal.lisp.

Generic Reader: transitions (object)
Generic Writer: (setf transitions) (object)
Package

docutils.parser.

Methods
Reader Method: transitions ((state state))
Writer Method: (setf transitions) ((state state))

List of transitions in order.

Source

state-machine.lisp.

Target Slot

transitions.

Generic Function: visit-node (writer entity)

Process entity for writer where entity is any entity in the document.

Package

docutils.

Source

publisher.lisp.

Methods
Method: visit-node ((writer latex-writer) (node evaluateable))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node version))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node transition))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node rubric))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node inline))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node topic))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node title))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node thead))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node term))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node tbody))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node target))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node tgroup))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node table))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node subtitle))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node substitution-reference))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node substitution-definition))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node strong))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node status))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node attribution))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node sidebar))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node section))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node revision))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node reference))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node raw))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node system-message))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node problematic))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node paragraph))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node organization))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node option-list-item))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node option-list))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node option-group))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node option-argument))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node option))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node meta))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node literal-block))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node literal))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node list-item))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node line-block))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node line))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node legend))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node image))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node header))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node label))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node footnote-reference))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node footnote))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node footer))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node figure))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node field-name))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node field-list))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node field-body))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node field))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node enumerated-list))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node row))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node entry))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node emphasis))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node doctest-block))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node docinfo))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node description))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node definition-list-item))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node definition-list))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node definition))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node date))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node copyright))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node contact))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node comment))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node colspec))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node classifier))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node citation-reference))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node citation))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node title-reference))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node caption))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node equation))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node math))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node subscript))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node superscript))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node bullet-list))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node block-quote))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node author))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node admonition))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (node address))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (text text))
Source

latex.lisp.

Method: visit-node ((writer latex-writer) (document document))
Source

latex.lisp.

Method: visit-node ((table latex-table) (node colspec))
Source

latex.lisp.

Method: visit-node ((writer html-writer) (node evaluateable))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node version))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node transition))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node topic))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node title-reference))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node title))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node thead))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node tgroup))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node term))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node tbody))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node target))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node table))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node system-message))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node superscript))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node subtitle))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node substitution-definition))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node subscript))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node strong))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node status))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node sidebar))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node section))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node rubric))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node row))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node revision))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node reference))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node raw))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node problematic))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node paragraph))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node organization))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node option-string))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node option-list-item))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node option-list))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node option-argument))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node option-group))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node meta))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node literal-block))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node literal))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node list-item))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node line-block))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node line))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node legend))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node label))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node inline))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node image))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node equation))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node math))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node header))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node footnote-reference))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node footnote))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node footer))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node figure))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node field-name))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node field-list))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node field-body))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node field))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node enumerated-list))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node entry))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node emphasis))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node doctest-block))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node docinfo))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node description))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node definition-list))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node definition))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node date))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node copyright))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node contact))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node compound))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node comment))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node colspec))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node classifier))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node citation-reference))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node citation))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node caption))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node bullet-list))
Source

html.lisp.

Method: visit-node ((g0 html-writer) (g1 block-quote))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node author))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node attribution))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node admonition))
Source

html.lisp.

Method: visit-node ((writer html-writer) (node address))
Source

html.lisp.

Method: visit-node ((g0 html-writer) (g1 acronym))
Source

html.lisp.

Method: visit-node ((g0 html-writer) (g1 abbreviation))
Source

html.lisp.

Method: visit-node ((writer html-writer) (text text))
Source

html.lisp.

Method: visit-node ((writer html-writer) (document document))
Source

html.lisp.

Method: visit-node (writer (node evaluateable))
Method: visit-node (writer (entity element))

By default visit children of an element. throw to :skip-siblings to not process further children

Method: visit-node :around (writer entity)
Method: visit-node :around ((writer writer) (document document))
Generic Function: write-document (writer document destination)

Write document out to destination using given writer

Package

docutils.

Source

publisher.lisp.

Methods
Method: write-document ((writer latex-writer) document (os stream))
Source

latex.lisp.

Method: write-document (writer document (os (eql string)))
Method: write-document ((writer writer) document (os stream))
Generic Function: write-part (writer part output-stream)

Write a document part from writer to an output stream.

Package

docutils.

Source

publisher.lisp.

Methods
Method: write-part ((writer latex-writer) (part (eql docutils.writer.latex::fragment)) (os stream))
Source

latex.lisp.

Method: write-part ((writer html-writer) (part (eql docutils.writer.html:fragment)) (os stream))
Source

html.lisp.

Method: write-part ((writer writer) (part symbol) (os stream))

6.1.5 Standalone methods

Method: close ((stream line-wrap-stream) &key abort)
Source

utilities.lisp.

Method: initialize-instance :after ((stream line-wrap-stream) &key line-length &allow-other-keys)
Source

utilities.lisp.

Method: initialize-instance :after ((parser table-parser) &key &allow-other-keys)
Source

tables.lisp.

Method: initialize-instance :after ((node text-element) &key text &allow-other-keys)
Source

nodes.lisp.

Method: initialize-instance :after ((document document) &key source-path &allow-other-keys)
Source

nodes.lisp.

Method: initialize-instance :after ((element element) &key children attributes &allow-other-keys)
Source

nodes.lisp.

Method: initialize-instance :after ((state rst-state) &key &allow-other-keys)
Source

rst.lisp.

Method: initialize-instance :after ((state state) &key &allow-other-keys)
Source

state-machine.lisp.

Method: print-object ((node field-name) stream)
Source

nodes.lisp.

Method: print-object ((node element) stream)
Source

nodes.lisp.

Method: print-object ((node node) stream)
Source

nodes.lisp.

Method: print-object ((node field) stream)
Source

nodes.lisp.

Method: print-object ((transform transform) stream)
Source

publisher.lisp.

Method: stream-clear-output ((stream line-wrap-stream))
Package

sb-gray.

Source

utilities.lisp.

Method: stream-finish-output ((stream line-wrap-stream))
Package

sb-gray.

Source

utilities.lisp.

Method: stream-force-output ((stream line-wrap-stream))
Package

sb-gray.

Source

utilities.lisp.

Reader Method: stream-line-column ((line-wrap-stream line-wrap-stream))

automatically generated reader method

Package

sb-gray.

Source

utilities.lisp.

Target Slot

stream-line-column.

Method: stream-start-line-p ((stream line-wrap-stream))
Package

sb-gray.

Source

utilities.lisp.

Method: stream-write-char ((stream line-wrap-stream) (c character))
Package

sb-gray.

Source

utilities.lisp.

Method: stream-write-char ((stream latex-output-stream) (c character))
Package

sb-gray.

Source

latex.lisp.


6.1.6 Conditions

Condition: insert-lines
Package

docutils.parser.

Source

state-machine.lisp.

Direct superclasses

condition.

Direct methods

error-text-block.

Direct slots
Slot: text-block
Initform

(quote nil)

Initargs

:text-block

Readers

error-text-block.

Writers

This slot is read-only.

Condition: markup-condition

An condition in the structured text markup. level
can be used by handlers to determine whether to ignore, print, record or abort parsing

Package

docutils.

Source

report.lisp.

Direct superclasses

docutils-condition.

Direct subclasses

table-condition.

Direct methods
Direct slots
Slot: node
Package

docutils.nodes.

Initform

(quote nil)

Initargs

:node

Readers

error-node.

Writers

This slot is read-only.

Slot: line
Package

docutils.nodes.

Initform

(quote nil)

Initargs

:line

Readers

error-line.

Writers

(setf error-line).

Slot: source
Initform

(quote nil)

Initargs

:source

Readers

error-source.

Writers

This slot is read-only.

Slot: level
Initform

(quote :warning)

Initargs

:level

Readers

error-level.

Writers

This slot is read-only.

Slot: data
Initform

(quote nil)

Initargs

:data

Readers

error-data.

Writers

This slot is read-only.

Slot: backrefs
Initform

(quote nil)

Initargs

:backrefs

Readers

error-backrefs.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

error-message.

Writers

This slot is read-only.

Condition: table-condition
Package

docutils.parser.tables.

Source

tables.lisp.

Direct superclasses

markup-condition.

Condition: unexpected-indentation
Package

docutils.parser.

Source

state-machine.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: line-number
Initform

(quote nil)

Initargs

:line

Readers

error-line.

Writers

This slot is read-only.

Slot: text-block
Initform

(quote nil)

Initargs

:text-block

Readers

error-text-block.

Writers

This slot is read-only.


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.7 Structures

Structure: match

Results of a transition match

Package

docutils.parser.

Source

state-machine.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: start
Initform

0

Readers

match-start.

Writers

(setf match-start).

Slot: end
Initform

0

Readers

match-end.

Writers

(setf match-end).

Slot: string
Package

common-lisp.

Readers

match-string.

Writers

(setf match-string).

Slot: reg-starts
Readers

match-reg-starts.

Writers

(setf match-reg-starts).

Slot: reg-ends
Readers

match-reg-ends.

Writers

(setf match-reg-ends).


Previous: , Up: Public Interface   [Contents][Index]

6.1.8 Classes

Class: abbreviation
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods

visit-node.

Class: abmonition
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

body.

Class: acronym
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods

visit-node.

Class: address
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: admonition
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

element.

Direct subclasses
Direct methods

Link anonymous references to targets

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority440
Class: attention
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: attribution
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: author
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: authors
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: backlinkable
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Direct methods

backrefs.

Direct slots
Slot: backrefs
Package

docutils.

Readers

backrefs.

Writers

This slot is read-only.

Class: bibliographic
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

predecorative.

Direct subclasses
Class: block-evaluation

Block evaluateable element

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: block-quote
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: body
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Class: bullet-list
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: caption
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: caution
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: chained-targets

Attributes "refuri" and "refname" are migrated from the final direct target up the chain of contiguous adjacent internal targets

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority420
Class: citation
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: citation-reference
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: class-attribute

Move class attribute of pending node to next non-comment element

Package

docutils.transform.

Source

misc.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority210
Class: classifier
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: colspec
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: comment
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: compound
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods

visit-node.

Class: contact
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: container
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: contents

Include or exclude elements - for use with pending elements

Package

docutils.transform.

Source

parts.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority720
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: danger
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: date
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: decoration
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: decorations

Populate a document’s decoration element (header, footer).

Package

docutils.transform.

Source

universal.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority820
Class: decorative
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Class: definition
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: definition-list
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: definition-list-item
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods

visit-node.

Class: description
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: docinfo
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: docinfo

Transform to create document bibliographic fields.

Package

docutils.transform.

Source

frontmatter.lisp.

Direct superclasses

transform.

Direct methods
Direct Default Initargs
InitargValue
:priority340
Direct slots
Slot: biblio-nodes
Initform

(quote (("author" . docutils.nodes:author) ("authors" . docutils.nodes:authors) ("organization" . docutils.nodes:organization) ("address" . docutils.nodes:address) ("contact" . docutils.nodes:contact) ("version" . docutils.nodes:version) ("revision" . docutils.nodes:revision) ("status" . docutils.nodes:status) ("date" . docutils.nodes:date) ("copyright" . docutils.nodes:copyright) ("dedication" . docutils.nodes:topic) ("abstract" . docutils.nodes:topic)))

Initargs

:biblio-nodes

Readers

biblio-nodes.

Writers

This slot is read-only.

Class: doctest-block
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: doctitle

Transform to promote document title and subtitle.

Package

docutils.transform.

Source

frontmatter.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority320
Class: document

The main document root element

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:line0
Direct slots
Slot: namespace
Package

docutils.utilities.

Initargs

:namespace

Readers

namespace.

Writers

This slot is read-only.

Slot: settings

Runtime settings data record.

Package

docutils.

Initform

(make-hash-table)

Initargs

:settings

Readers

settings.

Writers

This slot is read-only.

Slot: current-id

current id.

Package

docutils.

Initform

0

Initargs

:id-start

Readers

current-id.

Writers

(setf current-id).

Class: element

Abstract base to all specific elements containing attributes and child nodes.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

node.

Direct subclasses
Direct methods
Direct slots
Slot: children

List of child nodes (elements and/or ‘Text‘).

Package

docutils.

Slot: attributes

p-list of attributes associated with this node.

Package

docutils.

Initargs

:attributes

Class: emphasis
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: entry
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: enumerated-list
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: equation
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: error
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: evaluate-transform

Evaluate nodes cahcing result

Package

docutils.transform.

Source

misc.lisp.

Direct superclasses

transform.

Direct methods

transform.

Class: evaluateable

Base for nodes which can be evaluated

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

node.

Direct subclasses
Direct methods
Direct slots
Slot: language
Package

docutils.

Initform

:lisp

Initargs

:language

Readers

evaluation-language.

Writers

This slot is read-only.

Slot: output-format

Specifies what format the output is in (for writers).

Package

docutils.

Initargs

:format

Readers

output-format.

Writers

This slot is read-only.

Slot: expression

Read expression to be evaluated at some later time.

Package

docutils.

Initargs

:expression

Readers

expression.

Writers

This slot is read-only.

Slot: result

Cached result obtained from evaluating expression

Package

docutils.

Class: external-targets

replace :refname attribute with the direct :refuri attribute for external targets.

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority640
Class: field
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: field-body
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: field-list
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: field-name
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: fignum

Automatically assigns numbers to Figures, tables and equations.

Package

docutils.transform.

Source

parts.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority711
Class: figure
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: filter

Include or exclude elements - for use with pending elements

Package

docutils.transform.

Source

filter.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority780
Class: filter-messages

Remove system messages below verbosity threshold.

Package

docutils.transform.

Source

universal.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority870
Class: final-checks

Perform last-minute checks and transforms.

- Check for dangling references (incl. footnote & citation). - Check for illegal transitions, move transitions

Package

docutils.transform.

Source

universal.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority840
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: footnote
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: footnote-reference
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: footnotes

Assign numbers to autonumbered footnotes, and
resolve links to footnotes, citations, and their references.

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods
Direct Default Initargs
InitargValue
:priority620
Direct slots
Slot: autofootnote-labels
Readers

autofootnote-labels.

Writers

(setf autofootnote-labels).

Slot: symbols
Initform

"*†‡§¶#♤♡♢♧"

Initargs

:symbols

Readers

symbols.

Writers

This slot is read-only.

Class: general
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

body.

Direct subclasses
Class: generated
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Class: grid-table-parser

Parse a grid table using ‘parse()‘.

Here’s an example of a grid table::

+————————+————+———-+———-+
| Header row, column 1 | Header 2 | Header 3 | Header 4 | +========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 | +————————+————+———-+———-+
| body row 2 | Cells may span columns. | +————————+————+———————+
| body row 3 | Cells may | - Table cells | +————————+ span rows. | - contain |
| body row 4 | | - body elements. | +————————+————+———————+

Intersections use ’+’, row separators use ’-’ (except for one optional head/body row separator, which uses ’=’), and column separators use ’|’.

Passing the above table to the ‘parse()‘ method will result in the following data structure::

([24, 12, 10, 10],
[[(0, 0, 1, [’Header row, column 1’]),
(0, 0, 1, [’Header 2’]),
(0, 0, 1, [’Header 3’]),
(0, 0, 1, [’Header 4’])]],
[[(0, 0, 3, [’body row 1, column 1’]),
(0, 0, 3, [’column 2’]),
(0, 0, 3, [’column 3’]),
(0, 0, 3, [’column 4’])],
[(0, 0, 5, [’body row 2’]),
(0, 2, 5, [’Cells may span columns.’]),
None,
None],
[(0, 0, 7, [’body row 3’]),
(1, 0, 7, [’Cells may’, ’span rows.’, ”]),
(1, 1, 7, [’- Table cells’, ’- contain’, ’- body elements.’]), None],
[(0, 0, 9, [’body row 4’]), None, None, None]])

The first item is a list containing column widths (colspecs). The second item is a list of head rows, and the third is a list of body rows. Each row contains a list of cells. Each cell is either None (for a cell unused because of another cell’s span), or a tuple. A cell tuple contains four items: the number of extra rows used by the cell in a vertical span (morerows); the number of extra columns used by the cell in a horizontal span (morecols); the line offset of the first line of the cell contents; and the cell contents, a list of lines of text.

Package

docutils.parser.tables.

Source

tables.lisp.

Direct superclasses

table-parser.

Direct methods
Direct Default Initargs
InitargValue
:separator-pattern^\+=[=+]+=\+$
Direct slots
Slot: cells
Readers

cells.

Writers

(setf cells).

Slot: colseps
Initform

(quote (0))

Readers

colseps.

Writers

(setf colseps).

Slot: rowseps
Initform

(quote (0))

Readers

rowseps.

Writers

(setf rowseps).

Class: header
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: hint
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: html-writer

Docutils html writer

Package

docutils.writer.html.

Source

html.lisp.

Direct superclasses

writer.

Direct methods
Direct Default Initargs
InitargValue
:parts(quote ((head-prefix <!doctype html public "-//w3c//dtd xhtml 1.0 transitional//en" "http://www.w3.org/tr/xhtml1/dtd/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> ) head (body-prefix </head> <body> ) body-pre-docinfo docinfo body footer (body-suffix </body> </html>)))
Direct slots
Slot: stylesheet

Specify a stylesheet. If a URL put link in output
HTML file, if a pathname embed stylesheet in output HTML

Initform

"docutils.css"

Initargs

:stylesheet

Slot: head-prefix
Slot: head
Slot: body-prefix
Slot: body-pre-docinfo
Slot: docinfo
Package

docutils.nodes.

Slot: body
Package

docutils.nodes.

Package

docutils.nodes.

Slot: body-suffix
Slot: topic-class
Initform

""

Class: image
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: important
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

process internal and external indirect hyperlinks

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority460
Class: inline
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

text-element.

Direct subclasses
Direct methods
Class: inline-evaluation

Inline evaluateable element

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: internal-targets

replace :refname attribute with the direct :refid attribute for internal targets.

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority660
Class: invisible

Internal elements that don’t appear in output.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

prebibliographic.

Direct subclasses
Class: label
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: latex-output-stream

Stream to help format latex out correctly - uses line wrapping, removes multiple spaces (including ~)

Package

docutils.writer.latex.

Source

latex.lisp.

Direct superclasses

line-wrap-stream.

Direct methods

stream-write-char.

Class: latex-writer

Docutils latex writer

Package

docutils.writer.latex.

Source

latex.lisp.

Direct superclasses

writer.

Direct methods
Direct Default Initargs
InitargValue
:parts(quote (head-prefix pdfinfo pdfauthor head body-prefix docinfo body footer body-suffix))
Direct slots
Slot: class-sections
Initform

(quote (("book" "chapter" "section" "subsection" "subsubsection" "paragraph" "subparagraph") ("scrbook" "chapter" "section" "subsection" "subsubsection" "paragraph" "subparagraph") ("report" "chapter" "section" "subsection" "subsubsection" "paragraph" "subparagraph") ("scrreprt" "chapter" "section" "subsection" "subsubsection" "paragraph" "subparagraph") ("article" "section" "subsection" "subsubsection" "paragraph" "subparagraph") ("scrartcl" "section" "subsection" "subsubsection" "paragraph" "subparagraph")))

Readers

class-sections.

Writers

This slot is read-only.

Slot: active-table
Readers

active-table.

Writers

This slot is read-only.

Slot: topic-class
Slot: title
Package

docutils.nodes.

Initform

""

Readers

title.

Writers

(setf title).

Slot: date

Set date

Package

docutils.nodes.

Readers

date.

Writers

(setf date).

Slot: author-stack

List of author information

Readers

author-stack.

Writers

(setf author-stack).

Slot: mode

List of Modes currently active e.g. :literal :mathmode :literal-block

Slot: literal-block-stack

Nested literal blocks

Readers

literal-block-stack.

Writers

(setf literal-block-stack).

Slot: dependencies

List of dependencie uris

Readers

dependencies.

Writers

(setf dependencies).

Slot: section-numbers

Stack of nested section numbers

Readers

section-numbers.

Writers

(setf section-numbers).

Slot: enumeration-counters

Stack of enumeration counters

Readers

enumeration-counters.

Writers

(setf enumeration-counters).

Slot: max-enum-depth

Maximum enumeration counter depth so far

Initform

0

Readers

max-enum-depth.

Writers

(setf max-enum-depth).

Slot: metadata

docinfo metadata for Latex and pdfinfo

Initform

(make-hash-table)

Readers

metadata.

Writers

This slot is read-only.

Slot: head-prefix
Slot: pdfinfo
Slot: pdfauthor
Slot: head
Slot: body-prefix
Slot: docinfo
Package

docutils.nodes.

Slot: body
Package

docutils.nodes.

Slot: body-suffix
Slot: bibitems
Package

docutils.nodes.

Slot: tmp-parts
Class: legend
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: line
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: indent
Package

docutils.

Class: line-block
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: line-wrap-stream

A simple line-wrapping stream filter

Package

docutils.utilities.

Source

utilities.lisp.

Direct superclasses
  • fundamental-character-output-stream.
  • trivial-gray-stream-mixin.
Direct subclasses

latex-output-stream.

Direct methods
Direct slots
Slot: stream-line-column
Package

sb-gray.

Initform

0

Readers

stream-line-column.

Writers

This slot is read-only.

Slot: indentation-level

Current indentation level

Initform

0

Initargs

:indentation-level

Readers

indentation-level.

Writers

This slot is read-only.

Slot: indentation-character
Initform

#\

Readers

indentation-character.

Writers

This slot is read-only.

Slot: stream

Actual stream being written to - must be capable of writing characters using write-char

Package

common-lisp.

Initargs

:stream

Readers

stream-of.

Writers

This slot is read-only.

Slot: line-break-test

Function returns true if character can be used as line break

Initform

(function docutils.utilities:wsp-char-p)

Readers

line-break-test.

Writers

This slot is read-only.

Slot: line-buffer
Readers

line-buffer-of.

Writers

This slot is read-only.

Class: list-item
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: literal
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: literal-block
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: math
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: meta
Package

docutils.nodes.

Source

directives.lisp.

Direct superclasses
Direct methods
Class: node

Abstract base class of nodes in a document tree

Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: line

The line number (1-based) of the beginning of this Node in source.

Initform

docutils:*current-line-number*

Initargs

:line

Readers

line.

Writers

This slot is read-only.

Slot: parent

The parent of this node in the document tree

Package

docutils.

Readers

parent.

Writers

This slot is read-only.

Class: note
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: option
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: option-argument
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: option-group
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: option-list
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: option-list-item
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: option-string
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods

visit-node.

Class: organization
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: paragraph
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: part
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Class: pending

The ’pending’ element is used to encapsulate a pending operation: the operation (transform), the point at which to apply it, and any data it requires.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: prebibliographic

Category of Node which may occur before Bibliographic Nodes.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

predecorative.

Direct subclasses
Class: predecorative

Category of Node which may occur before Decorative Nodes.

Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Class: problematic
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: raw

Raw data that is to be passed untouched to the Writer.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: reader

Base classes to produce a document from input

Package

docutils.

Source

publisher.lisp.

Direct subclasses

rst-reader.

Direct methods
Direct slots
Slot: settings

a-list of overwriding reading and parsing settings

Initargs

:settings

Class: reference
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: referential
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

resolvable.

Direct subclasses
Class: resolvable
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: resolved
Package

docutils.

Readers

resolved.

Writers

(setf resolved).

Class: resolve-media

Resolve media dependancies

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority850
Class: revision
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: root
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses

document.

Class: row
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: rst-reader

The ReStructured text parser

Package

docutils.parser.rst.

Source

rst.lisp.

Direct superclasses

reader.

Direct subclasses
Direct methods
Class: rubric
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: section
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: sectnum

Automatically assigns numbers to the titles of document sections.

Package

docutils.transform.

Source

parts.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority710
Class: sequential
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

body.

Direct subclasses
Class: sidebar

Sidebars are like miniature, parallel documents
that occur inside other documents, providing related or reference material. A sidebar is typically offset by a border and ’floats’ to the side of the page; the document’s main text may flow around it. Sidebars can also be likened to super-footnotes; their content is outside of the flow of the document’s main text.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: simple-transform

A simple transform which calls the closure with the node

Package

docutils.transform.

Source

misc.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct slots
Slot: function
Package

common-lisp.

Initargs

:function

Class: special

Special internal body elements.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

body.

Direct subclasses
Class: state

State superclass.

Package

docutils.parser.

Source

state-machine.lisp.

Direct subclasses

wsp-state.

Direct methods
Direct slots
Slot: state-machine

A reference to the controlling StateMachine object.

Initargs

:state-machine

Readers

state-machine.

Writers

This slot is read-only.

Slot: initial-transitions

The initial set of transitions for this state

Allocation

:class

Readers

initial-transitions.

Writers

This slot is read-only.

Slot: transitions

List of transitions in order.

Readers

transitions.

Writers

(setf transitions).

Class: state-machine

A finite state machine for text filters using matching functions

The input is provided in the form of a list of one-line strings (no newlines) which may be modified. States are subclasses of the ‘State‘ class. Transitions consist of regular expression patterns and transition methods, and are defined in each state.

The state machine is started with the ‘run()‘ method, which returns the results of processing in a list.

Package

docutils.parser.

Source

state-machine.lisp.

Direct subclasses

wsp-state-machine.

Direct methods
Direct slots
Slot: input-lines

vector of input lines (without newlines)

Initargs

:input-lines

Readers

input-lines.

Writers

This slot is read-only.

Slot: states

a list of allowed state classe names.

Initargs

:states

Readers

states.

Writers

(setf states).

Slot: initial-state

the initial state name.

Initargs

:initial-state

Readers

initial-state.

Writers

This slot is read-only.

Slot: current-state

the current state.

Readers

current-state.

Writers

This slot is read-only.

Slot: input-offset

Offset of input-lines from the beginning of the file.

Initform

0

Initargs

:input-offset

Readers

input-offset.

Writers

This slot is read-only.

Slot: line-offset

Current input line offset from beginning of input-lines.

Initform

-1

Readers

line-offset.

Writers

(setf line-offset).

Class: status
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: strong
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: structural
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Direct methods
Class: subscript
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: substitution-definition
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: substitution-reference
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods

visit-node.

Class: substitutions

Replace substitution-references with the
contents of the corresponding substitution-definitions.

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority220
Class: subtitle
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: superscript
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: system-message
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: table
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: target
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: target-notes

Creates a footnote for each external target in the text, and corresponding footnote references after each reference.

Package

docutils.transform.

Source

references.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority540
Class: targetable
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

resolvable.

Direct subclasses
Direct methods
Direct slots
Slot: referenced
Package

docutils.

Readers

referenced.

Writers

(setf referenced).

Class: tbody
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: term
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: text

Instances are terminal nodes (leaves) containing text only; no child nodes or attributes.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

node.

Direct methods
Direct slots
Slot: text
Initform

""

Initargs

:text

Class: text-element

An element which directly contains text.
Its children are all ‘Text‘ or ‘TextElement‘ subclass nodes

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

element.

Direct subclasses
Direct methods
Class: tgroup
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: thead
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: tip
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: title
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: title-reference
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses

inline.

Direct methods
Class: titular
Package

docutils.nodes.

Source

nodes.lisp.

Direct subclasses
Class: topic

Topics are terminal, ’leaf’ mini-sections, like
block quotes with titles, or textual figures. A topic is just like a section, except that it has no subsections, and it doesn’t have to conform to section placement rules.

Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: transform

Docutils transform component abstract base class.

Package

docutils.

Source

publisher.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: priority

Numerical priority of this transform, 0 through 999.

Initform

500

Initargs

:priority

Readers

priority.

Writers

This slot is read-only.

Slot: order
Initform

(incf docutils::*transform-counter*)

Readers

order.

Writers

This slot is read-only.

Slot: node

The node at which this transform is to start

Package

docutils.nodes.

Initargs

:node

Readers

node.

Writers

This slot is read-only.

Class: transition
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: version
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Direct methods
Class: warning
Package

docutils.nodes.

Source

nodes.lisp.

Direct superclasses
Class: writer

Base Class for writing a document

Package

docutils.

Source

publisher.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: parts

List of slot names for component parts in
the output. The writer should accumulate strings on each part using push.

Initargs

:parts

Readers

parts.

Writers

This slot is read-only.

Slot: settings

Overwritten setting affecting document writing

Initargs

:settings

Readers

settings.

Writers

This slot is read-only.

Class: wsp-state

State superclass specialized for
whitespace (blank lines & indents).

Use this class with ‘StateMachineWS‘. The transitions ’blank’ (for blank lines) and ’indent’ (for indented text blocks) are added automatically, before any other transitions. The transition method ‘blank()‘ handles blank lines and ‘indent()‘ handles nested indented blocks. Indented blocks trigger a new state machine to be created by ‘indent()‘ and run. The class of the state machine to be created is in ‘indent_sm‘, and the constructor keyword arguments are in the dictionary ‘indent_sm_kwargs‘.

Package

docutils.parser.

Source

state-machine.lisp.

Direct superclasses

state.

Direct subclasses

rst-state.

Direct methods
Direct slots
Slot: initial-transitions
Allocation

:class

Initform

docutils.parser:+wsp-transitions+

Class: wsp-state-machine

state-machine subclass specialized for whitespace recognition

Package

docutils.parser.

Source

state-machine.lisp.

Direct superclasses

state-machine.

Direct subclasses
Direct methods
Direct slots
Slot: blank-finish

Used to keep track of blank lines

Initform

t

Readers

blank-finish.

Writers

(setf blank-finish).


6.2 Internals


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

6.2.1 Special variables

Special Variable: *compact-p*
Package

docutils.writer.html.

Source

html.lisp.

Special Variable: *compact-simple*
Package

docutils.writer.html.

Source

html.lisp.

Special Variable: *config-files-read*

List of configuration files already read.

Package

docutils.

Source

publisher.lisp.

Special Variable: *context*

Context passed to text state

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *current-writer*

Writer currently processing document

Package

docutils.

Source

publisher.lisp.

Special Variable: *current-writer-part*

current destination writer slot

Package

docutils.

Source

publisher.lisp.

Special Variable: *default-interpreted-role*

The canonical name of the default interpreted role. This role is used when no role is specified for a piece of interpreted text.

Package

docutils.parser.rst.

Source

roles.lisp.

Special Variable: *directives*

Mapping of directive types to directive functions which take four arguments, an argument string, an a-list of options, an unparsed content block and a callback to parse the content block

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *goto-line-hooks*

A list of functions called when state machine moves to another line. Functions take two functions, the state machine and the absolute line offset

Package

docutils.parser.

Source

state-machine.lisp.

Special Variable: *in-sidebar*
Package

docutils.writer.html.

Source

html.lisp.

Special Variable: *interpreted-roles*

Mapping of roles to role functions which take the interpretate text content and an alist of directive options to be interprated by the role function

Package

docutils.parser.rst.

Source

roles.lisp.

Special Variable: *length-units*

Conversion from various units to inches

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: *namespace-delimiter*

Characters used as a delimiter for id namespace component

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: *pending-transforms*
Package

docutils.

Source

publisher.lisp.

Special Variable: *pep-url*
Package

docutils.parser.rst.

Source

roles.lisp.

Special Variable: *rcs-keyword-substitutions*
Package

docutils.transform.

Source

frontmatter.lisp.

Special Variable: *revision*

(major minor micro) version number. The micro number is bumped for API changes, for new functionality, and for interim project releases. The minor number is bumped whenever there is a significant project release. The major number will be bumped when the project is feature-complete, and perhaps if there is a major change in the design.

Package

docutils.

Source

publisher.lisp.

Special Variable: *rfc-url*
Package

docutils.parser.rst.

Source

roles.lisp.

Special Variable: *rst-state-classes*

set of State classes used with ‘rst-state-machine

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *scan-cache*
Package

docutils.parser.

Source

state-machine.lisp.

Special Variable: *search-path*

List of paths to search for dependencies in addition to those specified in settings

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: *section-bubble-up-kludge*
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *section-level*

Current section level - index in styles

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *section-level*
Package

docutils.writer.html.

Source

html.lisp.

Special Variable: *settings-spec*

Hash of of configuration parameters

Package

docutils.

Source

publisher.lisp.

Special Variable: *standard-config-files*

List of standard docutils configuration files

Package

docutils.

Source

publisher.lisp.

Special Variable: *state-change-hooks*

A list of functions called when state is changed. Called with state machine and the new state object

Package

docutils.parser.

Source

state-machine.lisp.

Special Variable: *system-message-destination*

Destination node for any system messages

Package

docutils.

Source

report.lisp.

Special Variable: *tab-size*

The amount of space that a tab is equivalent to

Package

docutils.utilities.

Source

utilities.lisp.

Special Variable: *title-styles*

List of title styles in order

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: *topic-class*
Package

docutils.writer.html.

Source

html.lisp.

Special Variable: *transform-counter*

Used to ensure transforms of the same priority maintain their order

Package

docutils.

Source

publisher.lisp.

Special Variable: *translations*

Hash table mapping language name to languages

Package

docutils.utilities.

Source

translate.lisp.

Special Variable: +enum-scanner+

Regex for matching against enumerated lists.

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +enumerated-lists+

List of enumerated list types. For each we have its label, regex fragment, function to convert to ordinal, function to convert from ordinal and the type value to be given in html

Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +error-levels+
Package

docutils.

Source

report.lisp.

Special Variable: +explicit-reference-scanner+
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +explicit-substitution-scanner+
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +explicit-target-scanner+
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +roman-numeral-map+
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: +rst-transitions+
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: closers
Package

docutils.parser.rst.

Source

inline.lisp.

Special Variable: explicit-constructs
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: grid-table-top-pattern
Package

docutils.parser.rst.

Source

rst.lisp.

Special Variable: openers
Package

docutils.parser.rst.

Source

inline.lisp.

Special Variable: rst-patterns
Package

docutils.parser.rst.

Source

inline.lisp.

Special Variable: simple-table-top-pattern
Package

docutils.parser.rst.

Source

rst.lisp.


6.2.2 Macros

Macro: add-docinfo-item ((writer node name &key meta) &body body)
Package

docutils.writer.html.

Source

html.lisp.

Macro: collect-parts (&body body)
Package

docutils.writer.latex.

Source

latex.lisp.

Macro: def-admonition (name &optional node-class)
Package

docutils.parser.rst.

Source

directives.lisp.

Macro: def-generic-role (name)
Package

docutils.parser.rst.

Source

roles.lisp.

Macro: def-simple-node (nodetype tagname &optional attributes &key suffix)
Package

docutils.writer.html.

Source

html.lisp.

Macro: define-inline-element-parse-tree (name start &optional end middle)
Package

docutils.parser.rst.

Source

inline.lisp.

Macro: define-recursive-element-parse-tree (name start &optional end)

Matches an element that is recursive i.e. uses a greedy match

Package

docutils.parser.rst.

Source

regexp.lisp.

Macro: do-vector ((element vector &key counter start end) &body body)

Iterate over the elements of a vector. Aon each iteration element is bound to the current element and counter to the index of this element. start and end may be used to specify the range of indexes to be iterated over.

Package

docutils.utilities.

Source

utilities.lisp.

Macro: make-inline-nodes (type attributes &optional children)
Package

docutils.parser.rst.

Source

inline.lisp.

Macro: make-node (type &rest arguments)
Package

docutils.parser.rst.

Source

rst.lisp.

Macro: visit-docinfo-item (writer node name)

Helper macro for docinfo items

Package

docutils.writer.latex.

Source

latex.lisp.

Macro: with-modes ((writer &rest modes) &body body)
Package

docutils.writer.latex.

Source

latex.lisp.


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

6.2.3 Ordinary functions

Function: add-attributes (node attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: add-field (parent state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: add-table-rows (state parent array tableline)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: add-target (targetname refuri target lineno)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: add-transform (transform)
Package

docutils.

Source

publisher.lisp.

Function: anonymous-references (element)

Return a list of external targets in a document in order of occurance

Package

docutils.transform.

Source

references.lisp.

Function: anonymous-target (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: anonymous-targets (element)
Package

docutils.transform.

Source

references.lisp.

Function: at-bof (state-machine)

True if the input is at or before beginning-of-file.

Package

docutils.parser.

Source

state-machine.lisp.

Function: at-eof (state-machine)

True if the input is at or past end-of-file.

Package

docutils.parser.

Source

state-machine.lisp.

Function: attval (writer string)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: attval (string)
Package

docutils.writer.html.

Source

html.lisp.

Function: authors-from-bullet-list (list)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: authors-from-paragraph (paragraph)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: authors-from-paragraphs (value)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: autofootnote-refs (document)
Package

docutils.transform.

Source

references.lisp.

Function: autofootnotes (document)
Package

docutils.transform.

Source

references.lisp.

Function: bare-literal-block (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: block-quote (state indented line-offset)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: bookmark (writer node)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: bottom (text-block)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: build-table (state tabledata tableline)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: build-table-row (state rowdata tableline)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: candidate-node (document)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: check-attribution (indented line-offset)

Check for an attribution in the last contiguous block of ‘indented‘. * First line after last blank line must begin with ’–’ (etc.). * Every line after that must have consistent indentation. Return 2 values:
(block quote lines, attribution lines, attribution offset)

Package

docutils.parser.rst.

Source

rst.lisp.

Function: check-compound-biblio-field (field name)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: check-empty-biblio-field (field name)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: check-line (state-machine state &optional transitions)
Package

docutils.parser.

Source

state-machine.lisp.

Function: check-parse-complete (parser)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: check-subsection (state style source lineno)

Check for a valid subsection header.

When a new section is reached that isn’t a subsection of the current section, back up the line count (use “previous_line(-x)“), then terminate-state-machine so the
calling StateMachine can re-examine the title. This will work its way back up the calling chain until the correct section level is reached.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: citation (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: citation-refs (document)
Package

docutils.transform.

Source

references.lisp.

Function: citations (document)
Package

docutils.transform.

Source

references.lisp.

Function: clean-rcs-keywords (paragraph &optional substitutions)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: close-table (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: closing (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: col-specs (table)

Return col-specs for longtable

Package

docutils.writer.latex.

Source

latex.lisp.

Function: column-width (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: comment (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: copy-contents-title (destination title)
Package

docutils.transform.

Source

parts.lisp.

Function: copy-directive (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Function: copy-match (instance)
Package

docutils.parser.

Source

state-machine.lisp.

Function: copy-translation (instance)
Package

docutils.utilities.

Source

translate.lisp.

Function: (setf current-state) (state-machine)
Package

docutils.parser.

Source

state-machine.lisp.

Function: definition-list-item (state termline)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: depart-row (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: directive (state match)

A directive block

Package

docutils.parser.rst.

Source

rst.lisp.

Reader: directive-allow-spaces-p (instance)
Writer: (setf directive-allow-spaces-p) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

allow-spaces-p.

Reader: directive-arguments (instance)
Writer: (setf directive-arguments) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

arguments.

Reader: directive-content-p (instance)
Writer: (setf directive-content-p) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

content-p.

Reader: directive-function (instance)
Writer: (setf directive-function) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

function.

Reader: directive-name (instance)
Writer: (setf directive-name) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

name.

Reader: directive-options (instance)
Writer: (setf directive-options) (instance)
Package

docutils.parser.rst.

Source

directives.lisp.

Target Slot

options.

Function: directive-p (object)
Package

docutils.parser.rst.

Source

directives.lisp.

Function: do-parse-table (parser)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: double-quotes-in-tt (text)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: emphasis (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: empty-tag (node tagname &optional attributes)
Package

docutils.writer.html.

Source

html.lisp.

Function: encode (writer string)

Encode special characters in ‘text‘ & return encoded string.
# $ % & ~ _ ^ { }
Escaping with a backslash does not help with backslashes, ~ and ^. < > are only available in math-mode or tt font. (really ?) $ starts math- mode.\begin{thebibliography}{%s}
AND quotes:

Package

docutils.writer.latex.

Source

latex.lisp.

Function: encode (string)

Encode special characters in ‘text‘ & return encoded string.

Package

docutils.writer.html.

Source

html.lisp.

Function: ensure-table-preamble (writer)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: enum-args (match)

Given a match returned from enum-matcher return the format, sequence,ordinal and text parameters

Package

docutils.parser.rst.

Source

rst.lisp.

Function: enum-matcher (string &key start end)

pattern matcher for enumerated lists - determins format,type and count

Package

docutils.parser.rst.

Source

rst.lisp.

Function: explicit-construct (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: explicit-list (state)

Create a nested state machine for a series of explicit markup constructs (including anonymous hyperlink targets).

Package

docutils.parser.rst.

Source

rst.lisp.

Function: extract-authors (field name docinfo)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: extract-bibliographic (field-list biblio-nodes)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: extract-extension-options (field-list)

Given a field list return an alist of names and values

Package

docutils.parser.rst.

Source

rst.lisp.

Function: extract-name-value (line)

Return a list of (:name value) from a line of the form name=value

Package

docutils.parser.rst.

Source

directives.lisp.

Function: final-check-reference (node nameids)
Package

docutils.transform.

Source

universal.lisp.

Function: final-check-transition (node)

Move transitions at the end of sections up the tree. Complain on transitions after a title, at the beginning or end of the document, and after another transition.

Package

docutils.transform.

Source

universal.lisp.

Function: first-child-not-type (node type)

Returns first child of node not of type type

Package

docutils.transform.

Source

frontmatter.lisp.

Function: footnote (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: footnote-reference (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: footnote-refs (document)
Package

docutils.transform.

Source

references.lisp.

Function: from-roman (s)

Convert roman numeral to integer

Package

docutils.parser.rst.

Source

rst.lisp.

Function: get-2d-block (text top left bottom right &key strip-indent)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: get-state (state-machine &optional next-state)

Return new state class object

Package

docutils.parser.

Source

state-machine.lisp.

Function: get-translation (language)
Package

docutils.utilities.

Source

translate.lisp.

Function: handle-transform-condition (e document)

Deal with transform errors, adding system message to messages node

Package

docutils.

Source

publisher.lisp.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: image-div-atts (node)
Package

docutils.writer.html.

Source

html.lisp.

Function: indirect-targets (document)
Package

docutils.transform.

Source

references.lisp.

Function: inline-text (text lineno)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: insert-metadata (metadata parent-node)

Helper function can be called to insert field data into a document

Package

docutils.parser.rst.

Source

rst.lisp.

Function: internal-target (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: interpreted (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: invalid-specialised-input (state match)

Not a compound element member. Abort this state machine.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: is-enumerated-list-item (state ordinal sequence format)

Check validity based on the ordinal value and the second line. Return true if the ordinal is valid and the second line is blank, indented, or starts with the next enumerator.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: is-named-tag (tagname)
Package

docutils.writer.html.

Source

html.lisp.

Function: is-reference (reference)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: isolate-grid-table (state)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: isolate-simple-table (state)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: join-strings (strings &optional separator)

Return a new string by joining together the STRINGS, separating each string with a SEPARATOR character or string

Package

docutils.utilities.

Source

utilities.lisp.

Function: latex-length (size)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: line-block-line (state match lineno)

Return one line element of a line_block.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: lines-left-trim (lines length &key start end)

Trim ‘length‘ characters off the beginning of each line,
from index ‘start‘ to ‘end‘. No whitespace-checking is done on the trimmed text.

Package

docutils.utilities.

Source

utilities.lisp.

Function: literal (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: literal-block (state)

Return a list of nodes.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: make-directive (&key name arguments allow-spaces-p options content-p function)
Package

docutils.parser.rst.

Source

directives.lisp.

Function: make-enumerator (ordinal sequence format)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: make-image-nodes (uri alt height width scale align target class angle)
Package

docutils.parser.rst.

Source

directives.lisp.

Function: make-indent-state-machine (state)
Package

docutils.parser.

Source

state-machine.lisp.

Function: make-known-indent-state-machine (state)
Package

docutils.parser.

Source

state-machine.lisp.

Function: make-match (&key start end string reg-starts reg-ends)
Package

docutils.parser.

Source

state-machine.lisp.

Function: make-target (text-block lineno target-name)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: make-target-footnote (document target refs notes)
Package

docutils.transform.

Source

references.lisp.

Function: make-translation (&key translated canonical)
Package

docutils.utilities.

Source

translate.lisp.

Function: malformed-table (state block &optional detail)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: mark-done (done top left bottom right)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: match-p (object)
Package

docutils.parser.

Source

state-machine.lisp.

Function: math (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: math-out (writer text)
Package

docutils.writer.html.

Source

html.lisp.

Function: mode (checklist writer)

Return true if writer is in any of the checklist modes

Package

docutils.writer.latex.

Source

latex.lisp.

Function: move-children (from-element to-element)

Move the children from one node to another. Returns the list of children in to-element

Package

docutils.

Source

nodes.lisp.

Function: nest-line-block-lines (line-block)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: nested-parse (state block input-offset node &key match-titles states initial-state)

Create a new StateMachine rooted at ‘node‘ and run it over the input ‘block‘.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: new-subsection (state title lineno)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: not-quoted (&rest expr)

Return a parse tree expression for expr not quoted

Package

docutils.parser.rst.

Source

inline.lisp.

Function: nsubvector (array start &optional end)

Returns a displaced array on array of element from start to end (default length array)

Package

docutils.utilities.

Source

utilities.lisp.

Function: number-figures (document &key figlabel eqnlabel)
Package

docutils.transform.

Source

parts.lisp.

Function: number-footnote-references (transform &optional nameids ids)

Assign numbers to autonumbered footnote references.

Package

docutils.transform.

Source

references.lisp.

Function: number-footnotes (transform startnum)

Assign numbers to autonumbered footnotes.
For labeled autonumbered footnotes, copy the number over to corresponding footnote references.

Package

docutils.transform.

Source

references.lisp.

Function: open-table (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: opening (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: option-list-item (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: paragraph (lines lineno)

Return a paragraph node & a boolean: literal-block next?

Package

docutils.parser.rst.

Source

rst.lisp.

Function: parents (node)
Package

docutils.writer.html.

Source

html.lisp.

Function: parse-attribution (state indented line-offset)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: parse-directive-block (directive state indented line-offset)

Parse a directive block made up of arguments, keyword options and content

Package

docutils.parser.rst.

Source

rst.lisp.

Function: parse-extension-options (state datalines)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: parse-inline (patterns string &key line start end language)

Parse a string for inline patterns. Return a list of inline markup elements and system messages. Patterns is a list of patterns to be applied in turn. Each pattern can either be a symbol naming both the parse-tree synonym and a function or a cons of a regular expression pattern and a function.

The pattern functions are called with two arguments, the match corresponding to the regexp match and a list of remaining patterns to be applied recursively. They should return a list of inline elements to be inserted.

The :start and :end keyword arguments have their usual meanings.

Package

docutils.parser.rst.

Source

inline.lisp.

Function: parse-option-marker (match)

Return a list of ‘node.option‘ and ‘node.option_argument‘ objects, parsed from an option marker match.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: parse-target (text-block)

Determine the type of reference of a target.
Returns two values
- :refname and the indirect reference name or - :refuri and the URI

Package

docutils.parser.rst.

Source

rst.lisp.

Function: parse-translations (entries)
Package

docutils.utilities.

Source

translate.lisp.

Function: promote-document-subtitle (document)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: promote-document-title (document)
Package

docutils.transform.

Source

frontmatter.lisp.

Function: quote-quotes (text)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: quoted (state match)

Match consistent quotes on subsequent lines.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: quoted-literal-block (state)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: quoted-pattern (&rest expr)

Return a parse tree expression for a quoted expression quoted

Package

docutils.parser.rst.

Source

inline.lisp.

Function: read-settings (fname &optional settings)
Package

docutils.

Source

publisher.lisp.

Function: reference (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: relative-path (source destination)
Package

docutils.transform.

Source

universal.lisp.

Function: rem-children (node)

Remove children from node and return them as a list

Package

docutils.transform.

Source

frontmatter.lisp.

Function: resolve-footnotes-and-citations (document)
Package

docutils.transform.

Source

references.lisp.

Function: resolve-indirect-references (target &optional refnames refids)
Package

docutils.transform.

Source

references.lisp.

Function: resolve-indirect-target (target &optional nameids ids refnames refids)
Package

docutils.transform.

Source

references.lisp.

Function: resolve-references (notes refs)
Package

docutils.transform.

Source

references.lisp.

Function: rfc2822-field (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: right (text-block)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: rowspan (table cell)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: (setf rowspan) (table cell)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: scan-cell (parser top left)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: scan-down (text-block top left right)

Look for the bottom-right corner of the cell, making note of all row boundaries.

Package

docutils.parser.tables.

Source

tables.lisp.

Function: scan-left (text-block top left bottom right)

Noting column boundaries, look for the bottom-left corner of the cell. It must line up with the starting point.

Package

docutils.parser.tables.

Source

tables.lisp.

Function: scan-right (text-block top left)

Look for the top-right corner of the cell, and make note of all column boundaries (’+’).

Package

docutils.parser.tables.

Source

tables.lisp.

Function: scan-up (text-block top left bottom)

Noting row boundaries, see if we can return to the starting point.

Package

docutils.parser.tables.

Source

tables.lisp.

Function: section (state title source style lineno)

Check for a valid subsection and create one if it checks out.

Package

docutils.parser.rst.

Source

rst.lisp.

Function: select-rst-transitions (&rest rest)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: set-duplicate-name-id (ids nameids nametypes node)

The following state transition table shows how ‘self.nameids‘ wand ‘self.nametypes‘change with new input and what actions are performed:

==== ===== ======== ======== ======= ==== ===== =====
Old State Input Action New State Notes ———– ——– —————– ———– —–
ids types new type sys.msg. dupname ids types
==== ===== ======== ======== ======= ==== ===== =====
– – explicit – – new True
– – implicit – – new False
None False explicit – – new True
old False explicit implicit old new True
None True explicit explicit new None True
old True explicit explicit new,old None True [#]_
None False implicit implicit new None False
old False implicit implicit new,old None False
None True implicit implicit new None True
old True implicit implicit new old True
==== ===== ======== ======== ======= ==== ===== =====

.. [#] Do not clear the name-to-id map or invalidate the old target if both old and new targets are external and refer to identical URIs. The new target is invalidated regardless.

Package

docutils.

Source

nodes.lisp.

Function: set-first-last (node)
Package

docutils.writer.html.

Source

html.lisp.

Function: short-overline (state lineno &optional lines)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: should-be-compact-p (node)

Determine if the <p> tags around paragraph “node“ can be omitted.

Package

docutils.writer.html.

Source

html.lisp.

Function: simple-list-p (node)
Package

docutils.writer.html.

Source

html.lisp.

Function: start-tag (node tagname &optional attributes infix)
Package

docutils.writer.html.

Source

html.lisp.

Function: stream-line-length (stream)
Package

docutils.utilities.

Source

utilities.lisp.

Function: strong (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: structure-from-cells (parser)
Package

docutils.parser.tables.

Source

tables.lisp.

Function: substitution-def (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: substitution-defs (element)

Return hashtable of substitution definitions in a document

Package

docutils.transform.

Source

references.lisp.

Function: substitution-reference (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: substitution-refs (element)

Return a hashtable of lists of substitution refs keyed by name

Package

docutils.transform.

Source

references.lisp.

Function: symbol-footnote-refs (document)
Package

docutils.transform.

Source

references.lisp.

Function: symbol-footnotes (document)
Package

docutils.transform.

Source

references.lisp.

Function: symbolise-footnotes (transform)

Add symbols indexes to ’[*]’-style footnotes and references.

Package

docutils.transform.

Source

references.lisp.

Function: table-top (state isolator parser)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: term (termline lineno)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: to-latex-encoding (encoding)

Translate docutils encoding name into latex’s.
Default fallback method is remove "-" and "_" chars from docutils_encoding.

Package

docutils.writer.latex.

Source

latex.lisp.

Function: to-roman (n)

convert integer to Roman numeral

Package

docutils.parser.rst.

Source

rst.lisp.

Function: topic (name parent title subtitle class content parser &optional nodeclass)
Package

docutils.parser.rst.

Source

directives.lisp.

Function: topic-class (node)
Package

docutils.writer.html.

Source

html.lisp.

Function: transform-cmp (a b)

Transforms compared by priority and order in which created

Package

docutils.

Source

publisher.lisp.

Function: transition-function (transition)
Package

docutils.parser.

Source

state-machine.lisp.

Function: transition-next-state (transition)
Package

docutils.parser.

Source

state-machine.lisp.

Function: transition-pattern (transition)
Package

docutils.parser.

Source

state-machine.lisp.

Reader: translation-canonical (instance)
Writer: (setf translation-canonical) (instance)
Package

docutils.utilities.

Source

translate.lisp.

Target Slot

canonical.

Function: translation-p (object)
Package

docutils.utilities.

Source

translate.lisp.

Reader: translation-translated (instance)
Writer: (setf translation-translated) (instance)
Package

docutils.utilities.

Source

translate.lisp.

Target Slot

translated.

Function: unindent-warning (state node-name)
Package

docutils.parser.rst.

Source

rst.lisp.

Function: uri (match &rest attributes)
Package

docutils.parser.rst.

Source

inline.lisp.

Function: used-packages (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: vertical-bar (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: visit-entry (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: visit-row (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: visit-thead (table)
Package

docutils.writer.latex.

Source

latex.lisp.

Function: words-and-spaces (text)
Package

docutils.writer.html.

Source

html.lisp.


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

6.2.4 Generic functions

Generic Function: abstract (entity)

Return the abstract of an entity

Package

docutils.

Source

nodes.lisp.

Methods
Method: abstract ((document document))
Generic Reader: active-table (object)
Package

docutils.writer.latex.

Methods
Reader Method: active-table ((latex-writer latex-writer))

automatically generated reader method

Source

latex.lisp.

Target Slot

active-table.

Generic Function: anonymous (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: anonymous ((state explicit) match)

Anonymous hyperlink targets.

Method: anonymous (state match)
Generic Reader: author-stack (object)
Generic Writer: (setf author-stack) (object)
Package

docutils.writer.latex.

Methods
Reader Method: author-stack ((latex-writer latex-writer))
Writer Method: (setf author-stack) ((latex-writer latex-writer))

List of author information

Source

latex.lisp.

Target Slot

author-stack.

Generic Reader: autofootnote-labels (object)
Package

docutils.transform.

Methods
Reader Method: autofootnote-labels ((footnotes footnotes))

automatically generated reader method

Source

references.lisp.

Target Slot

autofootnote-labels.

Generic Writer: (setf autofootnote-labels) (object)
Package

docutils.transform.

Methods
Writer Method: (setf autofootnote-labels) ((footnotes footnotes))

automatically generated writer method

Source

references.lisp.

Target Slot

autofootnote-labels.

Generic Reader: biblio-nodes (object)
Package

docutils.transform.

Methods
Reader Method: biblio-nodes ((docinfo docinfo))

automatically generated reader method

Source

frontmatter.lisp.

Target Slot

biblio-nodes.

Generic Function: bullet (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: bullet ((state bullet-list) match)

Bullet list item.

Method: bullet ((state body) match)

Bullet list item.

Generic Reader: cells (object)
Package

docutils.parser.tables.

Methods
Reader Method: cells ((grid-table-parser grid-table-parser))

automatically generated reader method

Source

tables.lisp.

Target Slot

cells.

Generic Writer: (setf cells) (object)
Package

docutils.parser.tables.

Methods
Writer Method: (setf cells) ((grid-table-parser grid-table-parser))

automatically generated writer method

Source

tables.lisp.

Target Slot

cells.

Generic Function: child-text-separator (element)

Return separator for child nodes in as-text

Package

docutils.

Source

nodes.lisp.

Methods
Method: child-text-separator ((element option-list-item))
Method: child-text-separator ((element option-group))
Method: child-text-separator ((element option))
Method: child-text-separator ((element element))
Generic Reader: class-sections (object)
Package

docutils.writer.latex.

Methods
Reader Method: class-sections ((latex-writer latex-writer))

automatically generated reader method

Source

latex.lisp.

Target Slot

class-sections.

Generic Function: cmp (a b)

Comparison function for ordering sequences of entities

Package

docutils.

Source

nodes.lisp.

Generic Reader: colseps (object)
Package

docutils.parser.tables.

Methods
Reader Method: colseps ((grid-table-parser grid-table-parser))

automatically generated reader method

Source

tables.lisp.

Target Slot

colseps.

Generic Writer: (setf colseps) (object)
Package

docutils.parser.tables.

Methods
Writer Method: (setf colseps) ((grid-table-parser grid-table-parser))

automatically generated writer method

Source

tables.lisp.

Target Slot

colseps.

Generic Reader: context (object)
Package

docutils.parser.rst.

Methods
Reader Method: context ((quoted-literal-block quoted-literal-block))

automatically generated reader method

Source

rst.lisp.

Target Slot

context.

Generic Writer: (setf context) (object)
Package

docutils.parser.rst.

Methods
Writer Method: (setf context) ((quoted-literal-block quoted-literal-block))

automatically generated writer method

Source

rst.lisp.

Target Slot

context.

Generic Reader: current-id (object)
Generic Writer: (setf current-id) (object)
Package

docutils.

Methods
Reader Method: current-id ((document document))
Writer Method: (setf current-id) ((document document))

current id.

Source

nodes.lisp.

Target Slot

current-id.

Generic Reader: current-state (object)
Package

docutils.parser.

Methods
Reader Method: current-state ((state-machine state-machine))

the current state.

Source

state-machine.lisp.

Target Slot

current-state.

Generic Reader: dependencies (object)
Generic Writer: (setf dependencies) (object)
Package

docutils.writer.latex.

Methods
Reader Method: dependencies ((latex-writer latex-writer))
Writer Method: (setf dependencies) ((latex-writer latex-writer))

List of dependencie uris

Source

latex.lisp.

Target Slot

dependencies.

Generic Function: do-transforms (transforms document)

Apply the transformations to this document in
order. Any system messages are added into a dedicated section at the end of the document

Package

docutils.

Source

publisher.lisp.

Methods
Method: do-transforms ((transforms list) document)
Generic Function: doctest (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: doctest ((state body) match)
Generic Reader: done (object)
Package

docutils.parser.tables.

Methods
Reader Method: done ((table-parser table-parser))

automatically generated reader method

Source

tables.lisp.

Target Slot

done.

Generic Function: embedded-directive (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: embedded-directive ((state substitution-def) match)
Generic Reader: entry-number (object)
Package

docutils.writer.latex.

Methods
Reader Method: entry-number ((latex-table latex-table))

automatically generated reader method

Source

latex.lisp.

Target Slot

cell-in-row.

Generic Reader: enumeration-counters (object)
Generic Writer: (setf enumeration-counters) (object)
Package

docutils.writer.latex.

Methods
Reader Method: enumeration-counters ((latex-writer latex-writer))
Writer Method: (setf enumeration-counters) ((latex-writer latex-writer))

Stack of enumeration counters

Source

latex.lisp.

Target Slot

enumeration-counters.

Generic Function: enumerator (state match)

Parse an enumerated list item

Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: enumerator ((state enumerated-list) match)

Enumerated list item.

Method: enumerator ((state body) match)
Generic Reader: error-backrefs (condition)
Package

docutils.

Methods
Reader Method: error-backrefs ((condition markup-condition))
Source

report.lisp.

Target Slot

backrefs.

Generic Reader: error-source (condition)
Package

docutils.

Methods
Reader Method: error-source ((condition markup-condition))
Source

report.lisp.

Target Slot

source.

Generic Function: explicit-markup (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: explicit-markup ((state explicit) match)

Footnotes, hyperlink targets, directives, comments.

Method: explicit-markup ((state definition-list) match)
Method: explicit-markup (state match)
Generic Reader: expression (object)
Package

docutils.

Methods
Reader Method: expression ((evaluateable evaluateable))

Read expression to be evaluated at some later time.

Source

nodes.lisp.

Target Slot

expression.

Generic Function: field-marker (state match)
Package

docutils.parser.rst.

Source

rst.lisp.

Methods
Method: field-marker ((state meta-body) match)
Source

directives.lisp.

Method: field-marker ((state field-list) match)
Method: field-marker ((state body) match)