The cl-docutils Reference Manual

Table of Contents

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

The cl-docutils Reference Manual

This is the cl-docutils Reference Manual, version 0.1.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:14:49 2018 GMT+0.


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

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.

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

2 Systems

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


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

2.1 docutils

Maintainer

Dr. John A.R. Williams

Author

Dr. John A.R. Williams

License

GPL v3

Description

Document utilities and Restructured text parser

Version

0.1.1

Dependencies
Source

docutils.asd (file)

Components

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

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)

Parent

docutils (system)

Location

languages/

Components

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

3.2 docutils/parsers

Dependencies
Parent

docutils (system)

Location

parsers/

Components

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

3.3 docutils/transforms

Dependencies
Parent

docutils (system)

Location

transforms/

Components

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

3.4 docutils/writers

Dependency

parsers (module)

Parent

docutils (system)

Location

writers/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 docutils.asd

Location

docutils.asd

Systems

docutils (system)


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

4.1.2 docutils/defpackage.lisp

Parent

docutils (system)

Location

defpackage.lisp

Packages

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

4.1.3 docutils/nodes.lisp

Dependencies
Parent

docutils (system)

Location

nodes.lisp

Exported Definitions
Internal Definitions

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

4.1.4 docutils/publisher.lisp

Dependencies
Parent

docutils (system)

Location

publisher.lisp

Exported Definitions
Internal Definitions

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

4.1.5 docutils/utilities.lisp

Dependency

defpackage.lisp (file)

Parent

docutils (system)

Location

utilities.lisp

Exported Definitions
Internal Definitions

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

4.1.6 docutils/report.lisp

Dependencies
Parent

docutils (system)

Location

report.lisp

Exported Definitions
Internal Definitions

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

4.1.7 docutils/languages/translate.lisp

Parent

languages (module)

Location

languages/translate.lisp

Exported Definitions
Internal Definitions

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

4.1.8 docutils/languages/en.lisp

Dependency

translate.lisp (file)

Parent

languages (module)

Location

languages/en.lisp


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

4.1.9 docutils/parsers/defpackage.lisp

Parent

parsers (module)

Location

parsers/defpackage.lisp

Packages

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

4.1.10 docutils/parsers/state-machine.lisp

Dependency

defpackage.lisp (file)

Parent

parsers (module)

Location

parsers/state-machine.lisp

Exported Definitions
Internal Definitions

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

4.1.11 docutils/parsers/inline.lisp

Dependency

defpackage.lisp (file)

Parent

parsers (module)

Location

parsers/inline.lisp

Internal Definitions

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

4.1.12 docutils/parsers/regexp.lisp

Dependency

defpackage.lisp (file)

Parent

parsers (module)

Location

parsers/regexp.lisp

Internal Definitions

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


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

4.1.13 docutils/parsers/tables.lisp

Dependency

defpackage.lisp (file)

Parent

parsers (module)

Location

parsers/tables.lisp

Exported Definitions
Internal Definitions

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

4.1.14 docutils/parsers/rst.lisp

Dependencies
Parent

parsers (module)

Location

parsers/rst.lisp

Exported Definitions
Internal Definitions

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

4.1.15 docutils/parsers/directives.lisp

Dependencies
Parent

parsers (module)

Location

parsers/directives.lisp

Exported Definitions
Internal Definitions

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

4.1.16 docutils/parsers/roles.lisp

Dependencies
Parent

parsers (module)

Location

parsers/roles.lisp

Exported Definitions

def-role (macro)

Internal Definitions

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

4.1.17 docutils/transforms/defpackage.lisp

Parent

transforms (module)

Location

transforms/defpackage.lisp

Internal Definitions

transform-condition (condition)


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

4.1.18 docutils/transforms/filter.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/filter.lisp

Exported Definitions

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

4.1.19 docutils/transforms/universal.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/universal.lisp

Exported Definitions
Internal Definitions

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

4.1.20 docutils/transforms/references.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/references.lisp

Exported Definitions
Internal Definitions

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

4.1.21 docutils/transforms/frontmatter.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/frontmatter.lisp

Exported Definitions
Internal Definitions

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

4.1.22 docutils/transforms/misc.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/misc.lisp

Exported Definitions

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

4.1.23 docutils/transforms/parts.lisp

Dependency

defpackage.lisp (file)

Parent

transforms (module)

Location

transforms/parts.lisp

Exported Definitions
Internal Definitions

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

4.1.24 docutils/writers/html.lisp

Parent

writers (module)

Location

writers/html.lisp

Packages

docutils.writer.html

Exported Definitions
Internal Definitions

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

4.1.25 docutils/writers/latex.lisp

Parent

writers (module)

Location

writers/latex.lisp

Packages

docutils.writer.latex

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 docutils.transform

Package containing standard docutils Node names

Source

defpackage.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.2 docutils

Document handling and structured text parsing

Source

defpackage.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

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

5.3 docutils.utilities

Common utilities used by several docutils components

Source

defpackage.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

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

5.4 docutils.nodes

Package containing standard docutils Node names

Source

defpackage.lisp (file)

Used By List
Exported Definitions

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

5.5 docutils.parser.rst

Restructured text parser for docutils

Source

defpackage.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.6 docutils.parser.tables

CALS Table parser

Source

defpackage.lisp (file)

Use List
Used By List

docutils.parser.rst

Exported Definitions
Internal Definitions

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

5.7 docutils.parser

Library for docutils parsers

Source

defpackage.lisp (file)

Use List
Used By List

docutils.parser.rst

Exported Definitions
Internal Definitions

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

5.8 docutils.writer.html

HTML with CSS writer for docutils

Source

html.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.9 docutils.writer.latex

Latex writer for docutils

Source

latex.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *current-line-number*

Current line number - used for line in node creation

Package

docutils

Source

report.lisp (file)

Special Variable: *default-reader-package*

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

Package

docutils

Source

nodes.lisp (file)

Special Variable: *document*

Document (root element) currently being operated on

Package

docutils

Source

nodes.lisp (file)

Special Variable: *evaluation-error-hook*

Hook to call when there is an error in the evaluator

Package

docutils

Source

nodes.lisp (file)

Special Variable: *evaluator*

Function to call when evaluating an evaluateable node

Package

docutils

Source

nodes.lisp (file)

Special Variable: *language*

Default language for processing

Package

docutils.utilities

Source

translate.lisp (file)

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 (file)

Special Variable: *namespace*

Prefix namespace for ids

Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

Special Variable: +wsp+

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

Package

docutils.utilities

Source

utilities.lisp (file)

Special Variable: +wsp-transitions+

Transitons for a wsp state machine

Package

docutils.parser

Source

state-machine.lisp (file)


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

6.1.2 Macros

Macro: collate-nodes (NODE ROOT) TEST
Package

docutils

Source

nodes.lisp (file)

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 (file)

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 (file)

Macro: for (VAR START STOP) &body BODY
Package

docutils.utilities

Source

utilities.lisp (file)

Macro: when-bind (VAR EXPR) &body BODY

Bind VAR to VALUE of expression, execute body if true

Package

docutils.utilities

Source

utilities.lisp (file)

Macro: while TEST &body BODY

Repeat body while test returns true

Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

Macro: with-block-indentation (N OS) &body BODY
Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

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 (file)

Macro: with-part (PART-NAME) &body BODY
Package

docutils

Source

publisher.lisp (file)

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

docutils

Source

report.lisp (file)


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

6.1.3 Functions

Function: abs-line-number STATE-MACHINE
Package

docutils.parser

Source

state-machine.lisp (file)

Function: abs-line-offset STATE-MACHINE

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

Package

docutils.parser

Source

state-machine.lisp (file)

Function: add-backref ELEMENT ID
Package

docutils

Source

nodes.lisp (file)

Function: add-states STATE-MACHINE STATE-CLASSNAMES

register state classes with this state engine

Package

docutils.parser

Source

state-machine.lisp (file)

Function: add-transitions STATE TRANSITIONS

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

Package

docutils.parser

Source

state-machine.lisp (file)

Function: author-separators &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

Function: babel &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

Function: canonical-text TEXT &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

Function: convert-length-unit SIZE UNIT
Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

Function: current-line STATE-MACHINE &optional INDEX
Package

docutils.parser

Source

state-machine.lisp (file)

Function: escape2null STRING &key START END

Return a string with escape-backslashes converted to nulls.

Package

docutils.utilities

Source

utilities.lisp (file)

Function: external-targets ELEMENT
Package

docutils.transform

Source

references.lisp (file)

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 (file)

Function: footnotes DOCUMENT
Package

docutils.transform

Source

references.lisp (file)

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 (file)

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 (file)

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 (file)

Function: ids ELEMENT

Return mapping of ids to nodes in element.

Package

docutils

Source

nodes.lisp (file)

Function: indent-level LINE &key TAB-SIZE

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

Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

Function: insert-lines STATE-MACHINE LINES &optional OFFSET
Package

docutils.parser

Source

state-machine.lisp (file)

Function: internal-targets ELEMENT
Package

docutils.transform

Source

references.lisp (file)

Function: is-prefix-p SUBSEQ SEQ &key START TEST

Return true if subseq is a prefix in seq

Package

docutils.utilities

Source

utilities.lisp (file)

Function: is-suffix-p SUBSEQ SEQ &key TEST

Return true if subseq is a suffix in seq

Package

docutils.utilities

Source

utilities.lisp (file)

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 (file)

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 (file)

Function: last-char STREAM

Return last character written to the stream

Package

docutils.utilities

Source

utilities.lisp (file)

Function: latex-double-quote-replacement &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

Function: latex-quotes &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

Function: length-unit UNIT
Package

docutils.utilities

Source

utilities.lisp (file)

Function: line-blank-p LINE
Package

docutils.utilities

Source

utilities.lisp (file)

Function: line-length LINE

Return length of line excluding trailing whitespace

Package

docutils.utilities

Source

utilities.lisp (file)

Function: lstrip STRING
Package

docutils.utilities

Source

utilities.lisp (file)

Function: make-id STRING

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

Package

docutils.utilities

Source

utilities.lisp (file)

Function: make-name NAME &key CHAR-TRANSFORM NAMESPACE
Package

docutils.utilities

Source

utilities.lisp (file)

Function: match PATTERN STRING &key START END
Package

docutils.parser

Source

state-machine.lisp (file)

Function: match-end INSTANCE
Function: (setf match-end) VALUE INSTANCE
Package

docutils.parser

Source

state-machine.lisp (file)

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 (file)

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 (file)

Function: match-reg-ends INSTANCE
Function: (setf match-reg-ends) VALUE INSTANCE
Package

docutils.parser

Source

state-machine.lisp (file)

Function: match-reg-starts INSTANCE
Function: (setf match-reg-starts) VALUE INSTANCE
Package

docutils.parser

Source

state-machine.lisp (file)

Function: match-start INSTANCE
Function: (setf match-start) VALUE INSTANCE
Package

docutils.parser

Source

state-machine.lisp (file)

Function: match-string INSTANCE
Function: (setf match-string) VALUE INSTANCE
Package

docutils.parser

Source

state-machine.lisp (file)

Function: matches PATTERN STRING &key START END
Package

docutils.parser

Source

state-machine.lisp (file)

Function: named-node ELEMENT NAME
Package

docutils

Source

nodes.lisp (file)

Function: nameids ELEMENT &optional IDS

Mapping of names to unique id’s.

Package

docutils

Source

nodes.lisp (file)

Function: next-line STATE-MACHINE &optional N
Package

docutils.parser

Source

state-machine.lisp (file)

Function: next-line-blank-p STATE-MACHINE

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

Package

docutils.parser

Source

state-machine.lisp (file)

Function: next-sibling ELEMENT
Package

docutils

Source

nodes.lisp (file)

Function: normalise-name NAME
Package

docutils.utilities

Source

utilities.lisp (file)

Function: parse-table PARSER-CLASS-NAME BLOCK
Package

docutils.parser.tables

Source

tables.lisp (file)

Function: part-append &rest VALUES
Package

docutils

Source

publisher.lisp (file)

Function: part-prepend &rest VALUES
Package

docutils

Source

publisher.lisp (file)

Function: prev-sibling ELEMENT
Package

docutils

Source

nodes.lisp (file)

Function: previous-line STATE-MACHINE &optional N
Package

docutils.parser

Source

state-machine.lisp (file)

Function: read-rst INPUT
Package

docutils

Source

rst.lisp (file)

Function: refids ELEMENT

Mapping of ids to lists of referencing nodes.

Package

docutils

Source

nodes.lisp (file)

Function: refnames ELEMENT

Return mapping of names to lists of referencing nodes.

Package

docutils

Source

nodes.lisp (file)

Function: register-settings-spec NEW-SPEC
Package

docutils

Source

publisher.lisp (file)

Function: remove-transition STATE NAME

Remove a transition by ‘name‘

Package

docutils.parser

Source

state-machine.lisp (file)

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 (file)

Function: rstrip STRING

Remove trailing white space from string

Package

docutils.utilities

Source

utilities.lisp (file)

Function: section WRITER &optional LEVEL

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

Package

docutils.nodes

Source

latex.lisp (file)

Function: set-id NODE &optional DOCUMENT IDS

This will set and return the id for a node.

Package

docutils

Source

nodes.lisp (file)

Function: split-lines STRING

Return a vector of lines split from string

Package

docutils.utilities

Source

utilities.lisp (file)

Function: state-correction &optional LINES
Package

docutils.parser

Source

rst.lisp (file)

Function: strip STRING

Remove prefixing and trailing white space from string

Package

docutils.utilities

Source

utilities.lisp (file)

Function: transition-match TRANSITION STRING
Package

docutils.parser

Source

state-machine.lisp (file)

Function: transition-name TRANSITION
Package

docutils.parser

Source

state-machine.lisp (file)

Function: translated-text TEXT &optional LANGUAGE
Package

docutils.utilities

Source

translate.lisp (file)

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 (file)

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 (file)

Function: whitespace-normalise-name NAME

Return and whitespace-normalized name.

Package

docutils.utilities

Source

utilities.lisp (file)

Function: write-html OS DOCUMENT
Package

docutils

Source

html.lisp (file)

Function: write-latex OS DOCUMENT
Package

docutils

Source

latex.lisp (file)

Function: wsp-char-p C
Package

docutils.utilities

Source

utilities.lisp (file)


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

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 (file)

Methods
Method: add-child (NODE text-element) (CHILD system-message) &optional INDEX

Add system message to part of a text element

Method: add-child NODE (CHILD targetable) &optional INDEX after
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 (file)

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 (file)

Methods
Method: allowed-child-p (PARENT meta) CHILD &optional INDEX
Source

directives.lisp (file)

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 (file)

Methods
Method: apply-transition (STATE rst-state) TRANSITION MATCH
Source

rst.lisp (file)

Method: apply-transition STATE TRANSITION MATCH
Generic Function: as-sexp ELEMENT

Return lisp s-exp representation of an element

Package

docutils

Source

nodes.lisp (file)

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 (file)

Writer

(setf as-text) (generic function)

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) VALUE ELEMENT

Set the text value of a node (if allowed)

Package

docutils

Source

nodes.lisp (file)

Reader

as-text (generic function)

Generic Function: attribute NODE LABEL

Return an attribute of a node corresponding to label

Package

docutils

Source

nodes.lisp (file)

Writer

(setf attribute) (generic function)

Methods
Method: attribute (NODE element) (LABEL symbol)

Return an attribute corresponding to label

Generic Function: (setf attribute) VALUE NODE LABEL

Set a named attribute of an element

Package

docutils

Source

nodes.lisp (file)

Reader

attribute (generic function)

Methods
Method: (setf attribute) VALUE (NODE element) (LABEL symbol)

Set an attribute of an element

Method: (setf attribute) FORMAT (ELEMENT raw) (LABEL (eql format))
Source

directives.lisp (file)

Generic Function: backrefs OBJECT
Package

docutils

Methods
Method: backrefs (BACKLINKABLE backlinkable)

automatically generated reader method

Source

nodes.lisp (file)

Generic Function: blank STATE MATCH

Handle blank lines.

Package

docutils.parser

Source

state-machine.lisp (file)

Methods
Method: blank (STATE quoted-literal-block) MATCH
Source

rst.lisp (file)

Method: blank (STATE line) MATCH

Transition marker.

Source

rst.lisp (file)

Method: blank (STATE specialized-text) MATCH
Source

rst.lisp (file)

Method: blank (STATE text) MATCH

End of paragraph.

Source

rst.lisp (file)

Method: blank (STATE line-block) MATCH
Source

rst.lisp (file)

Method: blank (STATE rfc2822-list) MATCH
Source

rst.lisp (file)

Method: blank (STATE wsp-state) MATCH

Handle blank lines. Does nothing. Override in subclasses.

Generic Function: blank-finish OBJECT
Generic Function: (setf blank-finish) NEW-VALUE OBJECT
Package

docutils.parser

Methods
Method: blank-finish STATE
Source

state-machine.lisp (file)

Method: blank-finish (WSP-STATE-MACHINE wsp-state-machine)
Method: (setf blank-finish) NEW-VALUE (WSP-STATE-MACHINE wsp-state-machine)

Used to keep track of blank lines

Source

state-machine.lisp (file)

Generic Function: bof STATE

Beginning of file transition

Package

docutils.parser

Source

state-machine.lisp (file)

Methods
Method: bof STATE
Generic Function: caption OBJECT
Package

docutils.nodes

Methods
Method: caption (LATEX-TABLE latex-table)

automatically generated reader method

Source

latex.lisp (file)

Generic Function: child PARENT INDEX

Return a child at position index

Package

docutils

Source

nodes.lisp (file)

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 (file)

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 Function: date OBJECT
Generic Function: (setf date) NEW-VALUE OBJECT
Package

docutils.nodes

Methods
Method: date (LATEX-WRITER latex-writer)
Method: (setf date) NEW-VALUE (LATEX-WRITER latex-writer)

Set date

Source

latex.lisp (file)

Generic Function: docinfo DOCUMENT

Return the docinfo component of a document

Package

docutils.nodes

Source

nodes.lisp (file)

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 (file)

Writer

(setf document) (generic function)

Methods
Method: document (RST-STATE-MACHINE rst-state-machine)

Top level Document Markup

Source

rst.lisp (file)

Method: document (NODE document)
Method: document (NODE node)
Generic Function: (setf document) DOCUMENT COMPONENT

Set the document to be processed and reset the component

Package

docutils.nodes

Source

publisher.lisp (file)

Reader

document (generic function)

Methods
Method: (setf document) NEW-VALUE (RST-STATE-MACHINE rst-state-machine)

Top level Document Markup

Source

rst.lisp (file)

Generic Function: eof STATE

End of file transition

Package

docutils.parser

Source

state-machine.lisp (file)

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

rst.lisp (file)

Method: eof (STATE line)
Source

rst.lisp (file)

Method: eof (STATE definition)

Not a definition.

Source

rst.lisp (file)

Method: eof (STATE specialized-text)
Source

rst.lisp (file)

Method: eof (STATE text)
Source

rst.lisp (file)

Method: eof STATE
Generic Function: error-data CONDITION
Package

docutils

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

report.lisp (file)

Generic Function: error-level CONDITION
Package

docutils

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

report.lisp (file)

Generic Function: error-line CONDITION
Generic Function: (setf error-line) NEW-VALUE CONDITION
Package

docutils

Methods
Method: error-line (CONDITION unexpected-indentation)
Source

state-machine.lisp (file)

Method: error-line (CONDITION markup-condition)
Method: (setf error-line) NEW-VALUE (CONDITION markup-condition)
Source

report.lisp (file)

Generic Function: error-message CONDITION
Package

docutils

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

report.lisp (file)

Generic Function: error-node CONDITION
Package

docutils

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

report.lisp (file)

Generic Function: error-severity ENTITY

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

Package

docutils

Source

report.lisp (file)

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

nodes.lisp (file)

Method: error-severity (C symbol)
Method: error-severity (C markup-condition)
Generic Function: error-text-block CONDITION
Package

docutils

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

state-machine.lisp (file)

Method: error-text-block (CONDITION unexpected-indentation)
Source

state-machine.lisp (file)

Generic Function: evaluate NODE

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

Package

docutils

Source

nodes.lisp (file)

Methods
Method: evaluate (NODE evaluateable)
Method: evaluate (NODE element)
Method: evaluate NODE
Generic Function: evaluation-language OBJECT
Package

docutils

Methods
Method: evaluation-language (EVALUATEABLE evaluateable)

automatically generated reader method

Source

nodes.lisp (file)

Generic Function: field-value NAME FIELD-LIST

Return the field text for a specific field name

Package

docutils

Source

nodes.lisp (file)

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 (file)

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 (file)

Methods
Method: indent (STATE quoted-literal-block) MATCH
Source

rst.lisp (file)

Method: indent (STATE line) MATCH
Source

rst.lisp (file)

Method: indent (STATE definition) MATCH

Definition list item.

Source

rst.lisp (file)

Method: indent (STATE specialized-text) MATCH
Source

rst.lisp (file)

Method: indent (STATE text) MATCH

Definition list item.

Source

rst.lisp (file)

Method: indent (STATE body) MATCH

Block quote.

Source

rst.lisp (file)

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 (file)

Methods
Method: index (NODE element) (CHILD node)
Generic Function: initial-state OBJECT
Package

docutils.parser

Methods
Method: initial-state (STATE-MACHINE state-machine)

the initial state name.

Source

state-machine.lisp (file)

Generic Function: initial-transitions OBJECT
Package

docutils.parser

Methods
Method: initial-transitions (STATE state)

The initial set of transitions for this state

Source

state-machine.lisp (file)

Generic Function: input-lines OBJECT
Package

docutils.parser

Methods
Method: input-lines (STATE-MACHINE state-machine)

vector of input lines (without newlines)

Source

state-machine.lisp (file)

Generic Function: language NODE

Language for this node

Package

docutils

Source

nodes.lisp (file)

Methods
Method: language (NODE document)
Method: language (NODE element)
Method: language (NODE node)
Generic Function: line ELEMENT

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

Package

docutils.nodes

Source

nodes.lisp (file)

Methods
Method: line (NODE node)

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

Generic Function: line-offset OBJECT
Generic Function: (setf line-offset) NEW-VALUE OBJECT
Package

docutils.parser

Methods
Method: line-offset (STATE-MACHINE state-machine)
Method: (setf line-offset) NEW-VALUE (STATE-MACHINE state-machine)

Current input line offset from beginning of input-lines.

Source

state-machine.lisp (file)

Generic Function: make-node NODE-TYPE &rest ATTRIBUTES

Make a node with given initialisers

Package

docutils

Source

nodes.lisp (file)

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 text)) &rest ATTRIBUTES
Method: make-node (NODE-TYPE symbol) &rest CONTENTS
Generic Function: namespace ID
Package

docutils.utilities

Source

utilities.lisp (file)

Methods
Method: namespace (P pathname)
Source

rst.lisp (file)

Method: namespace (DOCUMENT document)

automatically generated reader method

Source

nodes.lisp (file)

Method: namespace (NODE node)
Source

nodes.lisp (file)

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 (file)

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 (file)

Methods
Method: no-match (STATE specialized-body) TRANSITIONS
Source

rst.lisp (file)

Method: no-match (STATE rst-state) TRANSITIONS

This code should never be run.

Source

rst.lisp (file)

Method: no-match STATE TRANSITIONS
Generic Function: node OBJECT
Generic Function: (setf node) NEW-VALUE OBJECT
Package

docutils.nodes

Methods
Method: node (NESTED-STATE-MACHINE nested-state-machine)
Method: (setf node) NEW-VALUE (NESTED-STATE-MACHINE nested-state-machine)

Current node in document

Source

rst.lisp (file)

Method: node (RST-STATE-MACHINE rst-state-machine)
Method: (setf node) NEW-VALUE (RST-STATE-MACHINE rst-state-machine)

Current node in document

Source

rst.lisp (file)

Method: node (TRANSFORM transform)

The node at which this transform is to start

Source

publisher.lisp (file)

Generic Function: nop STATE MATCH

A do nothing transition method.

Package

docutils.parser

Source

state-machine.lisp (file)

Methods
Method: nop STATE MATCH
Generic Function: number-children NODE

Reutrn the number of children a node has

Package

docutils

Source

nodes.lisp (file)

Methods
Method: number-children (NODE element)
Generic Function: output-format OBJECT
Package

docutils

Methods
Method: output-format (EVALUATEABLE evaluateable)

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

Source

nodes.lisp (file)

Generic Function: parent NODE

Back-reference to the Node immediately containing this Node.

Package

docutils

Source

nodes.lisp (file)

Writer

(setf parent) (generic function)

Methods
Method: parent (RST-STATE rst-state)

parent node being processed

Source

rst.lisp (file)

Method: parent (NODE document)
Method: parent (NODE node)

The parent of this node in the document tree

Generic Function: (setf parent) NEW-VALUE OBJECT
Package

docutils

Reader

parent (generic function)

Methods
Method: (setf parent) NEW-VALUE (RST-STATE rst-state)

parent node being processed

Source

rst.lisp (file)

Generic Function: parts OBJECT
Package

docutils

Methods
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 (file)

Generic Function: read-document SOURCE READER

Create and read a new document using reader from source

Package

docutils

Source

publisher.lisp (file)

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

rst.lisp (file)

Method: read-document SOURCE (READER metadata-reader)
Source

rst.lisp (file)

Method: read-document SOURCE (READER rst-reader)
Source

rst.lisp (file)

Method: read-document SOURCE (READER reader) around
Generic Function: read-lines ENTITY

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

Package

docutils.utilities

Source

utilities.lisp (file)

Methods
Method: read-lines (SOURCE vector)
Method: read-lines (SOURCE string)
Method: read-lines (SOURCE pathname)
Method: read-lines (IS stream)
Generic Function: referenced OBJECT
Generic Function: (setf referenced) NEW-VALUE OBJECT
Package

docutils

Methods
Method: referenced (TARGETABLE targetable)

automatically generated reader method

Source

nodes.lisp (file)

Method: (setf referenced) NEW-VALUE (TARGETABLE targetable)

automatically generated writer method

Source

nodes.lisp (file)

Generic Function: rem-attribute NODE LABEL

Remove an attribute from a node

Package

docutils

Source

nodes.lisp (file)

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 (file)

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 (file)

Methods
Method: remove-node (NODE node) &optional INDEX
Generic Function: resolved OBJECT
Generic Function: (setf resolved) NEW-VALUE OBJECT
Package

docutils

Methods
Method: resolved (RESOLVABLE resolvable)

automatically generated reader method

Source

nodes.lisp (file)

Method: (setf resolved) NEW-VALUE (RESOLVABLE resolvable)

automatically generated writer method

Source

nodes.lisp (file)

Generic Function: setting NAME ENTITY

Return the value of given setting for entity

Package

docutils

Source

publisher.lisp (file)

Writer

(setf setting) (generic function)

Methods
Method: setting (NAME (eql trim-footnote-reference-space)) ENTITY
Source

rst.lisp (file)

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) VALUE KEY ELEMENT

Set a setting value for an entity

Package

docutils

Source

publisher.lisp (file)

Reader

setting (generic function)

Methods
Method: (setf setting) VALUE (NAME symbol) (HASH hash-table)
Method: (setf setting) VALUE (NAME symbol) (DOCUMENT document)
Generic Function: settings OBJECT
Generic Function: (setf settings) VALUE DOCUMENT
Package

docutils

Methods
Method: settings (DOCUMENT-PATH pathname)
Source

publisher.lisp (file)

Method: settings (WRITER writer)

Overwritten setting affecting document writing

Source

publisher.lisp (file)

Method: settings SOURCE
Source

publisher.lisp (file)

Method: settings (DOCUMENT document)

Runtime settings data record.

Source

nodes.lisp (file)

Method: (setf settings) (VALUE list) (DOCUMENT document)
Source

nodes.lisp (file)

Generic Function: state-machine OBJECT
Package

docutils.parser

Methods
Method: state-machine (STATE state)

A reference to the controlling StateMachine object.

Source

state-machine.lisp (file)

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 (file)

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 (file)

Method: state-machine-run (STATE-MACHINE rst-state-machine) (INPUT-LINES vector) &key DOCUMENT INLINER NODE MATCH-TITLES &allow-other-keys
Source

rst.lisp (file)

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 (file)

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 (file)

Generic Function: title ENTITY

Return the title for an entity

Package

docutils.nodes

Source

nodes.lisp (file)

Writer

(setf title) (generic function)

Methods
Method: title (LATEX-WRITER latex-writer)

automatically generated reader method

Source

latex.lisp (file)

Method: title (ELEMENT element)
Generic Function: (setf title) NEW-VALUE OBJECT
Package

docutils.nodes

Reader

title (generic function)

Methods
Method: (setf title) NEW-VALUE (LATEX-WRITER latex-writer)

automatically generated writer method

Source

latex.lisp (file)

Generic Function: transform TRANSFORM

Apply a given transform to its’ document node

Package

docutils

Source

publisher.lisp (file)

Methods
Method: transform (TRANSFORM fignum)
Source

parts.lisp (file)

Method: transform (TRANSFORM sectnum)
Source

parts.lisp (file)

Method: transform (TRANSFORM contents)
Source

parts.lisp (file)

Method: transform (TRANSFORM evaluate-transform)
Source

misc.lisp (file)

Method: transform (TRANSFORM simple-transform)
Source

misc.lisp (file)

Method: transform (TRANSFORM class-attribute)
Source

misc.lisp (file)

Method: transform (TRANSFORM docinfo)
Source

frontmatter.lisp (file)

Method: transform (TRANSFORM doctitle)
Source

frontmatter.lisp (file)

Method: transform (TRANSFORM resolve-media)
Source

references.lisp (file)

Method: transform (TRANSFORM substitutions)
Source

references.lisp (file)

Method: transform (TRANSFORM footnotes)
Source

references.lisp (file)

Method: transform (TRANSFORM internal-targets)
Source

references.lisp (file)

Method: transform (TRANSFORM external-targets)
Source

references.lisp (file)

Method: transform (TRANSFORM indirect-hyperlinks)
Source

references.lisp (file)

Method: transform (TRANSFORM anonymous-hyperlinks)
Source

references.lisp (file)

Method: transform (TRANSFORM chained-targets)
Source

references.lisp (file)

Method: transform (TRANSFORM target-notes)
Source

references.lisp (file)

Method: transform (TRANSFORM final-checks)
Source

universal.lisp (file)

Method: transform (TRANSFORM filter-messages)
Source

universal.lisp (file)

Method: transform (TRANSFORM decorations)
Source

universal.lisp (file)

Method: transform (FILTER filter)
Source

filter.lisp (file)

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 (file)

Methods
Method: transforms (READER rst-reader)
Source

rst.lisp (file)

Method: transforms (READER reader)

Default transforms for standard reader

Source

universal.lisp (file)

Generic Function: transitions OBJECT
Generic Function: (setf transitions) NEW-VALUE OBJECT
Package

docutils.parser

Methods
Method: transitions (STATE state)
Method: (setf transitions) NEW-VALUE (STATE state)

List of transitions in order.

Source

state-machine.lisp (file)

Generic Function: visit-node WRITER ENTITY

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

Package

docutils

Source

publisher.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

latex.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

Method: visit-node (G0 html-writer) (G1 block-quote)
Source

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

Method: visit-node (G0 html-writer) (G1 acronym)
Source

html.lisp (file)

Method: visit-node (G0 html-writer) (G1 abbreviation)
Source

html.lisp (file)

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

html.lisp (file)

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

html.lisp (file)

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 WRITER ENTITY around
Method: visit-node (WRITER writer) (DOCUMENT document) around
Generic Function: write-document WRITER DOCUMENT DESTINATION

Write document out to destination using given writer

Package

docutils

Source

publisher.lisp (file)

Methods
Method: write-document (WRITER latex-writer) DOCUMENT (OS stream)
Source

latex.lisp (file)

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 (file)

Methods
Method: write-part (WRITER latex-writer) (PART (eql fragment)) (OS stream)
Source

latex.lisp (file)

Method: write-part (WRITER html-writer) (PART (eql fragment)) (OS stream)
Source

html.lisp (file)

Method: write-part (WRITER writer) (PART symbol) (OS stream)

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

6.1.5 Conditions

Condition: insert-lines ()
Package

docutils.parser

Source

state-machine.lisp (file)

Direct superclasses

condition (condition)

Direct methods

error-text-block (method)

Direct slots
Slot: text-block
Initargs

:text-block

Initform

(quote nil)

Readers

error-text-block (generic function)

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 (file)

Direct superclasses

docutils-condition (condition)

Direct subclasses

table-condition (condition)

Direct methods
Direct slots
Slot: node
Initargs

:node

Initform

(quote nil)

Readers

error-node (generic function)

Slot: line
Initargs

:line

Initform

(quote nil)

Readers

error-line (generic function)

Writers

(setf error-line) (generic function)

Slot: source
Initargs

:source

Initform

(quote nil)

Readers

error-source (generic function)

Slot: level
Initargs

:level

Initform

(quote :warning)

Readers

error-level (generic function)

Slot: data
Initargs

:data

Initform

(quote nil)

Readers

error-data (generic function)

Slot: backrefs
Initargs

:backrefs

Initform

(quote nil)

Readers

error-backrefs (generic function)

Slot: message
Initargs

:message

Initform

(quote nil)

Readers

error-message (generic function)

Condition: table-condition ()
Package

docutils.parser.tables

Source

tables.lisp (file)

Direct superclasses

markup-condition (condition)

Condition: unexpected-indentation ()
Package

docutils.parser

Source

state-machine.lisp (file)

Direct superclasses

condition (condition)

Direct methods
Direct slots
Slot: line-number
Initargs

:line

Initform

(quote nil)

Readers

error-line (generic function)

Slot: text-block
Initargs

:text-block

Initform

(quote nil)

Readers

error-text-block (generic function)


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

6.1.6 Structures

Structure: match ()

Results of a transition match

Package

docutils.parser

Source

state-machine.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: start
Initform

0

Readers

match-start (function)

Writers

(setf match-start) (function)

Slot: end
Initform

0

Readers

match-end (function)

Writers

(setf match-end) (function)

Slot: string
Readers

match-string (function)

Writers

(setf match-string) (function)

Slot: reg-starts
Readers

match-reg-starts (function)

Writers

(setf match-reg-starts) (function)

Slot: reg-ends
Readers

match-reg-ends (function)

Writers

(setf match-reg-ends) (function)


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

6.1.7 Classes

Class: abbreviation ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

inline (class)

Direct methods

visit-node (method)

Class: abmonition ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

body (class)

Class: acronym ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

inline (class)

Direct methods

visit-node (method)

Class: address ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: admonition ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

element (class)

Direct subclasses
Direct methods
Class: anonymous-hyperlinks ()

Link anonymous references to targets

Package

docutils.transform

Source

references.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority440
Class: attention ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: attribution ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: author ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: authors ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: backlinkable ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods

backrefs (method)

Direct slots
Slot: backrefs
Readers

backrefs (generic function)

Class: bibliographic ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

predecorative (class)

Direct subclasses
Class: block-evaluation ()

Block evaluateable element

Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: block-quote ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: body ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: bullet-list ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: caption ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: caution ()
Package

docutils.nodes

Source

nodes.lisp (file)

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 (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority420
Class: citation ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: citation-reference ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: class-attribute ()

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

Package

docutils.transform

Source

misc.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority210
Class: classifier ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: colspec ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: comment ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: compound ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods

visit-node (method)

Class: contact ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: container ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: contents ()

Include or exclude elements - for use with pending elements

Package

docutils.transform

Source

parts.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority720
Class: copyright ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: danger ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: date ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: decoration ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: decorations ()

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

Package

docutils.transform

Source

universal.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority820
Class: decorative ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: definition ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: definition-list ()
Package

docutils.nodes

Source

nodes.lisp (file)

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

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods

visit-node (method)

Class: description ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: docinfo ()

Transform to create document bibliographic fields.

Package

docutils.transform

Source

frontmatter.lisp (file)

Direct superclasses

transform (class)

Direct methods
Direct slots
Slot: biblio-nodes
Initargs

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

Readers

biblio-nodes (generic function)

Direct Default Initargs
InitargValue
:priority340
Class: docinfo ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: doctest-block ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: doctitle ()

Transform to promote document title and subtitle.

Package

docutils.transform

Source

frontmatter.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority320
Class: document ()

The main document root element

Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: namespace
Initargs

:namespace

Readers

namespace (generic function)

Slot: settings

Runtime settings data record.

Initargs

:settings

Initform

(make-hash-table)

Readers

settings (generic function)

Slot: current-id

current id.

Initargs

:id-start

Initform

0

Readers

current-id (generic function)

Writers

(setf current-id) (generic function)

Direct Default Initargs
InitargValue
:line0
Class: element ()

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

Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

node (class)

Direct subclasses
Direct methods
Direct slots
Slot: children

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

Slot: attributes

p-list of attributes associated with this node.

Initargs

:attributes

Class: emphasis ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

inline (class)

Direct methods
Class: entry ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: enumerated-list ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: equation ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: error ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Class: evaluate-transform ()

Evaluate nodes cahcing result

Package

docutils.transform

Source

misc.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Class: evaluateable ()

Base for nodes which can be evaluated

Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses

node (class)

Direct subclasses
Direct methods
Direct slots
Slot: language
Initargs

:language

Initform

:lisp

Readers

evaluation-language (generic function)

Slot: output-format

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

Initargs

:format

Readers

output-format (generic function)

Slot: expression

Read expression to be evaluated at some later time.

Initargs

:expression

Readers

expression (generic function)

Slot: result

Cached result obtained from evaluating expression

Class: external-targets ()

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

Package

docutils.transform

Source

references.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority640
Class: field ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: field-body ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: field-list ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: field-name ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: fignum ()

Automatically assigns numbers to Figures, tables and equations.

Package

docutils.transform

Source

parts.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority711
Class: figure ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: filter ()

Include or exclude elements - for use with pending elements

Package

docutils.transform

Source

filter.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority780
Class: filter-messages ()

Remove system messages below verbosity threshold.

Package

docutils.transform

Source

universal.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

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 (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Direct Default Initargs
InitargValue
:priority840
Class: footer ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: footnote ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods
Class: footnote-reference ()
Package

docutils.nodes

Source

nodes.lisp (file)

Direct superclasses
Direct methods