This is the docutils Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:09:12 2024 GMT+0.
docutils/docutils.asddocutils/defpackage.lispdocutils/nodes.lispdocutils/publisher.lispdocutils/utilities.lispdocutils/report.lispdocutils/languages/translate.lispdocutils/languages/en.lispdocutils/parsers/defpackage.lispdocutils/parsers/state-machine.lispdocutils/parsers/inline.lispdocutils/parsers/regexp.lispdocutils/parsers/tables.lispdocutils/parsers/rst.lispdocutils/parsers/directives.lispdocutils/parsers/roles.lispdocutils/transforms/defpackage.lispdocutils/transforms/filter.lispdocutils/transforms/universal.lispdocutils/transforms/references.lispdocutils/transforms/frontmatter.lispdocutils/transforms/misc.lispdocutils/transforms/parts.lispdocutils/writers/html.lispdocutils/writers/latex.lispThe main system appears first, followed by any subsystem dependency.
docutilsDocument utilities and Restructured text parser
Dr. John A.R. Williams
Dr. John A.R. Williams
GPL v3
0.1.1
cl-ppcre (system).
trivial-gray-streams (system).
data-format-validation (system).
defpackage.lisp (file).
nodes.lisp (file).
publisher.lisp (file).
utilities.lisp (file).
report.lisp (file).
languages (module).
parsers (module).
transforms (module).
writers (module).
Modules are listed depth-first from the system components tree.
docutils/languagesdefpackage.lisp (file).
docutils (system).
translate.lisp (file).
en.lisp (file).
docutils/parserspublisher.lisp (file).
nodes.lisp (file).
utilities.lisp (file).
report.lisp (file).
transforms (module).
languages (module).
docutils (system).
defpackage.lisp (file).
state-machine.lisp (file).
inline.lisp (file).
regexp.lisp (file).
tables.lisp (file).
rst.lisp (file).
directives.lisp (file).
roles.lisp (file).
docutils/transformsnodes.lisp (file).
utilities.lisp (file).
publisher.lisp (file).
report.lisp (file).
languages (module).
docutils (system).
defpackage.lisp (file).
filter.lisp (file).
universal.lisp (file).
references.lisp (file).
frontmatter.lisp (file).
misc.lisp (file).
parts.lisp (file).
docutils/writersparsers (module).
docutils (system).
html.lisp (file).
latex.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
docutils/docutils.asddocutils/defpackage.lispdocutils/nodes.lispdocutils/publisher.lispdocutils/utilities.lispdocutils/report.lispdocutils/languages/translate.lispdocutils/languages/en.lispdocutils/parsers/defpackage.lispdocutils/parsers/state-machine.lispdocutils/parsers/inline.lispdocutils/parsers/regexp.lispdocutils/parsers/tables.lispdocutils/parsers/rst.lispdocutils/parsers/directives.lispdocutils/parsers/roles.lispdocutils/transforms/defpackage.lispdocutils/transforms/filter.lispdocutils/transforms/universal.lispdocutils/transforms/references.lispdocutils/transforms/frontmatter.lispdocutils/transforms/misc.lispdocutils/transforms/parts.lispdocutils/writers/html.lispdocutils/writers/latex.lispdocutils/nodes.lispdefpackage.lisp (file).
report.lisp (file).
utilities.lisp (file).
languages (module).
docutils (system).
*default-reader-package* (special variable).
*document* (special variable).
*evaluation-error-hook* (special variable).
*evaluator* (special variable).
abbreviation (class).
abmonition (class).
acronym (class).
add-backref (function).
add-child (generic function).
add-class (generic function).
address (class).
admonition (class).
allowed-child-p (generic function).
as-sexp (generic function).
as-text (generic function).
(setf as-text) (generic function).
attention (class).
attribute (generic function).
(setf attribute) (generic function).
attribution (class).
author (class).
authors (class).
backlinkable (class).
backrefs (reader method).
bibliographic (class).
block-evaluation (class).
block-quote (class).
body (class).
bullet-list (class).
caption (class).
caution (class).
child (generic function).
citation (class).
citation-reference (class).
classifier (class).
collate-nodes (macro).
colspec (class).
comment (class).
compound (class).
contact (class).
container (class).
copy-of-node (generic function).
copyright (class).
danger (class).
date (class).
decoration (class).
decorative (class).
definition (class).
definition-list (class).
definition-list-item (class).
description (class).
docinfo (generic function).
docinfo (class).
doctest-block (class).
document (generic function).
document (class).
element (class).
emphasis (class).
entry (class).
enumerated-list (class).
equation (class).
error (class).
error-severity (method).
evaluate (generic function).
evaluateable (class).
evaluation-language (reader method).
field (class).
field-body (class).
field-list (class).
field-name (class).
field-value (generic function).
figure (class).
footer (class).
footnote (class).
footnote-reference (class).
general (class).
generated (class).
header (class).
hint (class).
ids (function).
image (class).
important (class).
index (generic function).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
inline (class).
inline-evaluation (class).
invisible (class).
label (class).
language (generic function).
legend (class).
line (generic reader).
line (class).
line-block (class).
list-item (class).
literal (class).
literal-block (class).
make-node (generic function).
math (class).
named-node (function).
nameids (function).
namespace (reader method).
namespace (method).
next-sibling (function).
node (class).
note (class).
number-children (generic function).
option (class).
option-argument (class).
option-group (class).
option-list (class).
option-list-item (class).
option-string (class).
organization (class).
output-format (reader method).
paragraph (class).
parent (generic function).
part (class).
pending (class).
prebibliographic (class).
predecorative (class).
prev-sibling (function).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
problematic (class).
raw (class).
reference (class).
referenced (reader method).
(setf referenced) (writer method).
referential (class).
refids (function).
refnames (function).
rem-attribute (generic function).
rem-child (generic function).
remove-node (generic function).
resolvable (class).
resolved (reader method).
(setf resolved) (writer method).
revision (class).
root (class).
row (class).
rubric (class).
section (class).
sequential (class).
set-id (function).
settings (reader method).
(setf settings) (method).
sidebar (class).
special (class).
status (class).
strong (class).
structural (class).
subscript (class).
substitute-node (generic function).
substitution-definition (class).
substitution-reference (class).
subtitle (class).
superscript (class).
system-message (class).
table (class).
target (class).
targetable (class).
tbody (class).
term (class).
text (class).
text-element (class).
tgroup (class).
thead (class).
tip (class).
title (generic function).
title (class).
title-reference (class).
titular (class).
topic (class).
transition (class).
version (class).
warning (class).
with-attributes (macro).
with-children (macro).
with-nodes (macro).
abstract (generic function).
child-text-separator (generic function).
cmp (generic function).
current-id (reader method).
(setf current-id) (writer method).
expression (reader method).
fixed-text-element (class).
implicit-target-p (generic function).
labeled (class).
move-children (function).
set-duplicate-name-id (function).
setup-child (generic function).
tagname (generic function).
docutils/publisher.lispdefpackage.lisp (file).
nodes.lisp (file).
docutils (system).
*unknown-reference-resolvers* (special variable).
(setf document) (generic writer).
new-document (generic function).
node (reader method).
part-append (function).
part-prepend (function).
parts (reader method).
print-object (method).
read-document (generic function).
reader (class).
register-settings-spec (function).
setting (generic function).
(setf setting) (generic function).
settings (method).
settings (reader method).
settings (method).
supports-format (generic function).
transform (generic function).
transform (class).
transforms (generic function).
visit-node (generic function).
with-part (macro).
write-document (generic function).
write-part (generic function).
writer (class).
*config-files-read* (special variable).
*current-writer* (special variable).
*current-writer-part* (special variable).
*pending-transforms* (special variable).
*revision* (special variable).
*settings-spec* (special variable).
*standard-config-files* (special variable).
*transform-counter* (special variable).
add-transform (function).
do-transforms (generic function).
handle-transform-condition (function).
order (method).
order (reader method).
priority (method).
priority (reader method).
read-settings (function).
resolve-dependancy (generic function).
transform-cmp (function).
docutils/utilities.lispdefpackage.lisp (file).
docutils (system).
*namespace* (special variable).
+wsp+ (special variable).
close (method).
convert-length-unit (function).
copy-stream (function).
escape2null (function).
find-file (function).
for (macro).
indent-level (function).
indented-block (function).
initialize-instance (method).
is-prefix-p (function).
is-suffix-p (function).
last-char (function).
length-unit (function).
line-blank-p (function).
line-length (function).
line-wrap-stream (class).
lstrip (function).
make-id (function).
make-name (function).
namespace (generic function).
normalise-name (function).
read-lines (generic function).
rstrip (function).
split-lines (function).
stream-clear-output (method).
stream-finish-output (method).
stream-force-output (method).
stream-line-column (reader method).
stream-start-line-p (method).
stream-write-char (method).
strip (function).
unescape (function).
unwrite-char (function).
when-bind (macro).
while (macro).
whitespace-normalise-name (function).
with-block-indentation (macro).
wsp-char-p (function).
*length-units* (special variable).
*namespace-delimiter* (special variable).
*search-path* (special variable).
*tab-size* (special variable).
do-vector (macro).
indentation-character (reader method).
indentation-level (reader method).
(setf indentation-level) (method).
join-strings (function).
line-break-test (reader method).
line-buffer-of (reader method).
lines-left-trim (function).
nsubvector (function).
stream-line-length (function).
stream-of (reader method).
wsp (type).
docutils/report.lispdefpackage.lisp (file).
utilities.lisp (file).
docutils (system).
*current-line-number* (special variable).
error-data (reader method).
error-level (reader method).
error-line (reader method).
(setf error-line) (writer method).
error-message (reader method).
error-node (reader method).
error-severity (generic function).
markup-condition (condition).
report (function).
with-reports-to-node (macro).
*system-message-destination* (special variable).
+error-levels+ (special variable).
docutils-condition (condition).
error-backrefs (reader method).
error-source (reader method).
docutils/languages/translate.lisplanguages (module).
*language* (special variable).
*language-directory* (special variable).
author-separators (function).
babel (function).
canonical-text (function).
latex-double-quote-replacement (function).
latex-quotes (function).
translated-text (function).
*translations* (special variable).
copy-translation (function).
get-translation (function).
make-translation (function).
parse-translations (function).
translation (structure).
translation-canonical (reader).
(setf translation-canonical) (writer).
translation-p (function).
translation-translated (reader).
(setf translation-translated) (writer).
docutils/languages/en.lisptranslate.lisp (file).
languages (module).
docutils/parsers/state-machine.lispdefpackage.lisp (file).
parsers (module).
+wsp-transitions+ (special variable).
abs-line-number (function).
abs-line-offset (function).
add-states (function).
add-transitions (function).
apply-transition (generic function).
blank (generic function).
blank-finish (method).
blank-finish (reader method).
(setf blank-finish) (writer method).
bof (generic function).
current-line (function).
eof (generic function).
error-line (reader method).
error-text-block (reader method).
error-text-block (reader method).
get-indented (function).
get-text-block (function).
goto-line (function).
indent (generic function).
initial-state (reader method).
initial-transitions (reader method).
initialize-instance (method).
input-lines (reader method).
insert-lines (function).
insert-lines (condition).
known-first-indent (function).
known-indent (function).
line-offset (reader method).
(setf line-offset) (writer method).
match (function).
match (structure).
match-end (reader).
(setf match-end) (writer).
match-group (function).
match-group-length (function).
match-reg-ends (reader).
(setf match-reg-ends) (writer).
match-reg-starts (reader).
(setf match-reg-starts) (writer).
match-start (reader).
(setf match-start) (writer).
match-string (reader).
(setf match-string) (writer).
matches (function).
next-line (function).
next-line-blank-p (function).
no-match (generic function).
nop (generic function).
previous-line (function).
remove-transition (function).
state (class).
state-machine (reader method).
state-machine (class).
state-machine-run (generic function).
transition-match (function).
transition-name (function).
transitions (reader method).
(setf transitions) (writer method).
unexpected-indentation (condition).
wsp-state (class).
wsp-state-machine (class).
*goto-line-hooks* (special variable).
*scan-cache* (special variable).
*state-change-hooks* (special variable).
at-bof (function).
at-eof (function).
check-line (function).
copy-match (function).
current-state (reader method).
(setf current-state) (function).
get-state (function).
input-offset (reader method).
make-indent-state-machine (function).
make-known-indent-state-machine (function).
make-match (function).
make-nested-state-machine (generic function).
match-p (function).
states (reader method).
(setf states) (writer method).
transition-function (function).
transition-next-state (function).
transition-pattern (function).
docutils/parsers/inline.lispdefpackage.lisp (file).
parsers (module).
add-attributes (function).
closers (special variable).
define-inline-element-parse-tree (macro).
emphasis (function).
footnote-reference (function).
internal-target (function).
interpreted (function).
literal (function).
make-inline-nodes (macro).
math (function).
not-quoted (function).
openers (special variable).
parse-inline (function).
parse-role (generic function).
quoted-pattern (function).
reference (function).
rst-patterns (special variable).
strong (function).
substitution-reference (function).
uri (function).
docutils/parsers/regexp.lispdefpackage.lisp (file).
parsers (module).
define-recursive-element-parse-tree (macro).
docutils/parsers/tables.lispdefpackage.lisp (file).
parsers (module).
grid-table-parser (class).
initialize-instance (method).
parse-table (function).
table-condition (condition).
bottom (function).
cells (reader method).
(setf cells) (writer method).
check-parse-complete (function).
colseps (reader method).
(setf colseps) (writer method).
do-parse-table (function).
done (reader method).
get-2d-block (function).
head-body-sep (reader method).
mark-done (function).
right (function).
rowseps (reader method).
(setf rowseps) (writer method).
scan-cell (function).
scan-down (function).
scan-left (function).
scan-right (function).
scan-up (function).
structure-from-cells (function).
table-parser (class).
text-block (reader method).
docutils/parsers/rst.lispdefpackage.lisp (file).
inline.lisp (file).
regexp.lisp (file).
state-machine.lisp (file).
tables.lisp (file).
parsers (module).
apply-transition (method).
blank (method).
blank (method).
blank (method).
blank (method).
blank (method).
blank (method).
document (reader method).
(setf document) (writer method).
eof (method).
eof (method).
eof (method).
eof (method).
eof (method).
indent (method).
indent (method).
indent (method).
indent (method).
indent (method).
indent (method).
initialize-instance (method).
namespace (method).
no-match (method).
no-match (method).
node (reader method).
node (reader method).
(setf node) (writer method).
(setf node) (writer method).
parent (reader method).
(setf parent) (writer method).
read-document (method).
read-document (method).
read-document (method).
read-rst (function).
rst-reader (class).
setting (method).
state-correction (function).
state-machine-run (method).
state-machine-run (method).
transforms (method).
*context* (special variable).
*directives* (special variable).
*rst-state-classes* (special variable).
*section-bubble-up-kludge* (special variable).
*section-level* (special variable).
*title-styles* (special variable).
+enum-scanner+ (special variable).
+enumerated-lists+ (special variable).
+explicit-reference-scanner+ (special variable).
+explicit-substitution-scanner+ (special variable).
+explicit-target-scanner+ (special variable).
+roman-numeral-map+ (special variable).
+rst-transitions+ (special variable).
add-field (function).
add-table-rows (function).
add-target (function).
anonymous (generic function).
anonymous-target (function).
bare-literal-block (function).
block-quote (function).
body (class).
build-table (function).
build-table-row (function).
bullet (generic function).
bullet-list (class).
check-attribution (function).
check-subsection (function).
citation (function).
comment (function).
context (reader method).
(setf context) (writer method).
definition (class).
definition-list (class).
definition-list-item (function).
directive (function).
doctest (generic function).
embedded-directive (generic function).
enum-args (function).
enum-matcher (function).
enumerated-list (class).
enumerator (generic function).
explicit (class).
explicit-construct (function).
explicit-constructs (special variable).
explicit-list (function).
explicit-markup (generic function).
extension-options (class).
extract-extension-options (function).
field-list (class).
field-marker (generic function).
footnote (function).
from-roman (function).
get-directive (generic function).
(setf get-directive) (generic function).
grid-table-top (generic function).
grid-table-top-pattern (special variable).
hyperlink-target (function).
initial-lineno (reader method).
(setf initial-lineno) (writer method).
initial-quoted (generic function).
inline-text (function).
insert-metadata (function).
insert-subsection (generic function).
invalid-specialised-input (function).
is-enumerated-list-item (function).
is-reference (function).
isolate-grid-table (function).
isolate-simple-table (function).
lastordinal (reader method).
(setf lastordinal) (writer method).
line (generic function).
line (class).
line-block (generic function).
line-block (class).
line-block-line (function).
list-format (reader method).
(setf list-format) (writer method).
list-item (generic function).
literal-block (function).
make-enumerator (function).
make-node (macro).
make-target (function).
malformed-table (function).
match-titles (reader method).
match-titles (reader method).
(setf match-titles) (writer method).
(setf match-titles) (writer method).
metadata-reader (class).
nest-line-block-lines (function).
nested-parse (function).
nested-state-machine (class).
new-subsection (function).
option-list (class).
option-list-item (function).
option-marker (generic function).
paragraph (function).
parse-attribution (function).
parse-directive-block (function).
parse-extension-options (function).
parse-field-body (generic function).
parse-option-marker (function).
parse-target (function).
quoted (function).
quoted-literal-block (function).
quoted-literal-block (class).
recursive-rst-reader (class).
rfc2822 (generic function).
rfc2822-body (class).
rfc2822-field (function).
rfc2822-list (class).
rst-state (class).
rst-state-machine (class).
section (function).
select-rst-transitions (function).
short-overline (function).
simple-table-top (generic function).
simple-table-top-pattern (special variable).
specialized-body (class).
specialized-text (class).
subsections (generic function).
substitution-def (function).
substitution-def (class).
table-top (function).
term (function).
text (generic function).
text (class).
title (generic function).
to-roman (function).
underline (generic function).
unindent-warning (function).
docutils/parsers/directives.lisprst.lisp (file).
inline.lisp (file).
roles.lisp (file).
parsers (module).
allowed-child-p (method).
(setf attribute) (method).
def-directive (macro).
meta (class).
copy-directive (function).
def-admonition (macro).
directive (structure).
directive-allow-spaces-p (reader).
(setf directive-allow-spaces-p) (writer).
directive-arguments (reader).
(setf directive-arguments) (writer).
directive-content-p (reader).
(setf directive-content-p) (writer).
directive-function (reader).
(setf directive-function) (writer).
directive-name (reader).
(setf directive-name) (writer).
directive-options (reader).
(setf directive-options) (writer).
directive-p (function).
extract-name-value (function).
field-marker (method).
make-directive (function).
make-image-nodes (function).
meta-body (class).
topic (function).
docutils/parsers/roles.lisprst.lisp (file).
inline.lisp (file).
parsers (module).
def-role (macro).
*default-interpreted-role* (special variable).
*interpreted-roles* (special variable).
*pep-url* (special variable).
*rfc-url* (special variable).
custom-role (class).
def-generic-role (macro).
generic-custom-role (class).
parse-role (method).
parse-role (method).
parse-role (method).
parse-role (method).
parse-role (method).
role (class).
standard-role (class).
docutils/transforms/defpackage.lisptransforms (module).
transform-condition (condition).
docutils/transforms/filter.lispdefpackage.lisp (file).
transforms (module).
docutils/transforms/universal.lispdefpackage.lisp (file).
transforms (module).
decorations (class).
filter-messages (class).
final-checks (class).
transform (method).
transform (method).
transform (method).
transforms (method).
final-check-reference (function).
final-check-transition (function).
generate-footer (generic function).
generate-header (generic function).
relative-path (function).
docutils/transforms/references.lispdefpackage.lisp (file).
transforms (module).
anonymous-hyperlinks (class).
chained-targets (class).
external-targets (function).
external-targets (class).
footnotes (function).
footnotes (class).
indirect-hyperlinks (class).
internal-targets (function).
internal-targets (class).
resolve-media (class).
substitutions (class).
target-notes (class).
transform (method).
transform (method).
transform (method).
transform (method).
transform (method).
transform (method).
transform (method).
transform (method).
transform (method).
anonymous-references (function).
anonymous-targets (function).
autofootnote-labels (reader method).
(setf autofootnote-labels) (writer method).
autofootnote-refs (function).
autofootnotes (function).
citation-refs (function).
citations (function).
footnote-refs (function).
indirect-targets (function).
make-target-footnote (function).
number-footnote-references (function).
number-footnotes (function).
resolve-footnotes-and-citations (function).
resolve-indirect-references (function).
resolve-indirect-target (function).
resolve-references (function).
substitution-defs (function).
substitution-refs (function).
symbol-footnote-refs (function).
symbol-footnotes (function).
symbolise-footnotes (function).
symbols (reader method).
docutils/transforms/frontmatter.lispdefpackage.lisp (file).
transforms (module).
*rcs-keyword-substitutions* (special variable).
authors-from-bullet-list (function).
authors-from-paragraph (function).
authors-from-paragraphs (function).
biblio-nodes (reader method).
candidate-node (function).
check-compound-biblio-field (function).
check-empty-biblio-field (function).
clean-rcs-keywords (function).
extract-authors (function).
extract-bibliographic (function).
first-child-not-type (function).
promote-document-subtitle (function).
promote-document-title (function).
rem-children (function).
docutils/transforms/misc.lispdefpackage.lisp (file).
transforms (module).
class-attribute (class).
evaluate-transform (class).
simple-transform (class).
transform (method).
transform (method).
transform (method).
docutils/transforms/parts.lispdefpackage.lisp (file).
transforms (module).
copy-contents-title (function).
number-figures (function).
docutils/writers/html.lispwriters (module).
html-url (generic function).
html-writer (class).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
write-html (function).
write-part (method).
*compact-p* (special variable).
*compact-simple* (special variable).
*in-sidebar* (special variable).
*section-level* (special variable).
*topic-class* (special variable).
add-docinfo-item (macro).
attval (function).
def-simple-node (macro).
empty-tag (function).
encode (function).
image-div-atts (function).
is-named-tag (function).
math-out (function).
parents (function).
set-first-last (function).
should-be-compact-p (function).
simple-list-p (function).
start-tag (function).
topic-class (function).
words-and-spaces (function).
docutils/writers/latex.lispwriters (module).
caption (reader method).
date (reader method).
(setf date) (writer method).
latex-output-stream (class).
latex-writer (class).
section (function).
stream-write-char (method).
title (reader method).
(setf title) (writer method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
visit-node (method).
write-document (method).
write-latex (function).
write-part (method).
active-table (reader method).
attval (function).
author-stack (reader method).
(setf author-stack) (writer method).
bookmark (function).
class-sections (reader method).
close-table (function).
closing (function).
col-specs (function).
collect-parts (macro).
column-width (function).
depart-row (function).
dependencies (reader method).
(setf dependencies) (writer method).
double-quotes-in-tt (function).
encode (function).
ensure-table-preamble (function).
entry-number (reader method).
enumeration-counters (reader method).
(setf enumeration-counters) (writer method).
latex-length (function).
latex-table (class).
latex-type (reader method).
literal-block-stack (reader method).
(setf literal-block-stack) (writer method).
max-enum-depth (reader method).
(setf max-enum-depth) (writer method).
metadata (reader method).
mode (function).
open-p (reader method).
(setf open-p) (writer method).
open-table (function).
opening (function).
quote-quotes (function).
rowspan (function).
(setf rowspan) (function).
section-numbers (reader method).
(setf section-numbers) (writer method).
table-style (reader method).
to-latex-encoding (function).
used-packages (function).
vertical-bar (function).
visit-docinfo-item (macro).
visit-entry (function).
visit-row (function).
visit-thead (function).
with-modes (macro).
Packages are listed by definition order.
docutils.transformdocutilsdocutils.utilitiesdocutils.parser.tablesdocutils.parserdocutils.parser.rstdocutils.writer.htmldocutils.writer.latexdocutils.nodesdocutils.transformPackage containing standard docutils Node names
common-lisp.
docutils.
docutils.utilities.
anonymous-hyperlinks (class).
chained-targets (class).
class-attribute (class).
contents (class).
decorations (class).
docinfo (class).
doctitle (class).
evaluate-transform (class).
external-targets (function).
external-targets (class).
fignum (class).
filter (class).
filter-messages (class).
final-checks (class).
footnotes (function).
footnotes (class).
indirect-hyperlinks (class).
internal-targets (function).
internal-targets (class).
resolve-media (class).
sectnum (class).
simple-transform (class).
substitutions (class).
target-notes (class).
*rcs-keyword-substitutions* (special variable).
anonymous-references (function).
anonymous-targets (function).
authors-from-bullet-list (function).
authors-from-paragraph (function).
authors-from-paragraphs (function).
autofootnote-labels (generic reader).
(setf autofootnote-labels) (generic writer).
autofootnote-refs (function).
autofootnotes (function).
biblio-nodes (generic reader).
candidate-node (function).
check-compound-biblio-field (function).
check-empty-biblio-field (function).
citation-refs (function).
citations (function).
clean-rcs-keywords (function).
copy-contents-title (function).
extract-authors (function).
extract-bibliographic (function).
final-check-reference (function).
final-check-transition (function).
first-child-not-type (function).
footnote-refs (function).
generate-footer (generic function).
generate-header (generic function).
indirect-targets (function).
make-target-footnote (function).
number-figures (function).
number-footnote-references (function).
number-footnotes (function).
promote-document-subtitle (function).
promote-document-title (function).
relative-path (function).
rem-children (function).
resolve-footnotes-and-citations (function).
resolve-indirect-references (function).
resolve-indirect-target (function).
resolve-references (function).
substitution-defs (function).
substitution-refs (function).
symbol-footnote-refs (function).
symbol-footnotes (function).
symbolise-footnotes (function).
symbols (generic reader).
transform-condition (condition).
docutilsDocument handling and structured text parsing
common-lisp.
data-format-validation.
docutils.nodes.
docutils.utilities.
*current-line-number* (special variable).
*default-reader-package* (special variable).
*document* (special variable).
*evaluation-error-hook* (special variable).
*evaluator* (special variable).
*unknown-reference-resolvers* (special variable).
add-backref (function).
add-child (generic function).
add-class (generic function).
allowed-child-p (generic function).
as-sexp (generic function).
as-text (generic function).
(setf as-text) (generic function).
attribute (generic function).
(setf attribute) (generic function).
backrefs (generic reader).
backrefs (slot).
child (generic function).
collate-nodes (macro).
copy-of-node (generic function).
error-data (generic reader).
error-level (generic reader).
error-line (generic reader).
(setf error-line) (generic writer).
error-message (generic reader).
error-node (generic reader).
error-severity (generic function).
error-text-block (generic reader).
evaluate (generic function).
evaluation-language (generic reader).
field-value (generic function).
ids (function).
index (generic function).
language (generic function).
language (slot).
make-node (generic function).
markup-condition (condition).
named-node (function).
nameids (function).
new-document (generic function).
next-sibling (function).
number-children (generic function).
output-format (generic reader).
output-format (slot).
parent (generic function).
(setf parent) (generic writer).
parent (slot).
parent (slot).
part-append (function).
part-prepend (function).
parts (generic reader).
prev-sibling (function).
read-document (generic function).
read-rst (function).
reader (class).
referenced (generic reader).
(setf referenced) (generic writer).
referenced (slot).
refids (function).
refnames (function).
register-settings-spec (function).
rem-attribute (generic function).
rem-child (generic function).
remove-node (generic function).
report (function).
resolved (generic reader).
(setf resolved) (generic writer).
resolved (slot).
set-id (function).
setting (generic function).
(setf setting) (generic function).
settings (generic function).
(setf settings) (generic function).
settings (slot).
substitute-node (generic function).
supports-format (generic function).
transform (generic function).
transform (class).
transforms (generic function).
visit-node (generic function).
with-attributes (macro).
with-children (macro).
with-nodes (macro).
with-part (macro).
with-reports-to-node (macro).
write-document (generic function).
write-html (function).
write-latex (function).
write-part (generic function).
writer (class).
*config-files-read* (special variable).
*current-writer* (special variable).
*current-writer-part* (special variable).
*pending-transforms* (special variable).
*revision* (special variable).
*settings-spec* (special variable).
*standard-config-files* (special variable).
*system-message-destination* (special variable).
*transform-counter* (special variable).
+error-levels+ (special variable).
abstract (generic function).
add-transform (function).
attributes (slot).
child-text-separator (generic function).
children (slot).
cmp (generic function).
current-id (generic reader).
(setf current-id) (generic writer).
current-id (slot).
do-transforms (generic function).
docutils-condition (condition).
error-backrefs (generic reader).
error-source (generic reader).
expression (generic reader).
expression (slot).
fixed-text-element (class).
handle-transform-condition (function).
implicit-target-p (generic function).
indent (slot).
labeled (class).
move-children (function).
order (generic function).
priority (generic function).
read-settings (function).
resolve-dependancy (generic function).
result (slot).
set-duplicate-name-id (function).
setup-child (generic function).
tagname (generic function).
transform-cmp (function).
docutils.utilitiesCommon utilities used by several docutils components
common-lisp.
trivial-gray-streams.
*language* (special variable).
*language-directory* (special variable).
*namespace* (special variable).
+wsp+ (special variable).
author-separators (function).
babel (function).
canonical-text (function).
convert-length-unit (function).
copy-stream (function).
escape2null (function).
find-file (function).
for (macro).
indent-level (function).
indented-block (function).
is-prefix-p (function).
is-suffix-p (function).
last-char (function).
latex-double-quote-replacement (function).
latex-quotes (function).
length-unit (function).
line-blank-p (function).
line-length (function).
line-wrap-stream (class).
lstrip (function).
make-id (function).
make-name (function).
namespace (generic function).
namespace (slot).
normalise-name (function).
read-lines (generic function).
rstrip (function).
split-lines (function).
strip (function).
translated-text (function).
unescape (function).
unwrite-char (function).
when-bind (macro).
while (macro).
whitespace-normalise-name (function).
with-block-indentation (macro).
wsp-char-p (function).
*length-units* (special variable).
*namespace-delimiter* (special variable).
*search-path* (special variable).
*tab-size* (special variable).
*translations* (special variable).
copy-translation (function).
do-vector (macro).
get-translation (function).
indentation-character (generic reader).
indentation-level (generic reader).
(setf indentation-level) (generic function).
join-strings (function).
line-break-test (generic reader).
line-buffer-of (generic reader).
lines-left-trim (function).
make-translation (function).
nsubvector (function).
parse-translations (function).
stream-line-length (function).
stream-of (generic reader).
translation (structure).
translation-canonical (reader).
(setf translation-canonical) (writer).
translation-p (function).
translation-translated (reader).
(setf translation-translated) (writer).
wsp (type).
docutils.parser.tablesCALS Table parser
common-lisp.
docutils.
docutils.utilities.
grid-table-parser (class).
parse-table (function).
table-condition (condition).
bottom (function).
cells (generic reader).
(setf cells) (generic writer).
check-parse-complete (function).
colseps (generic reader).
(setf colseps) (generic writer).
do-parse-table (function).
done (generic reader).
get-2d-block (function).
head-body-sep (generic reader).
mark-done (function).
right (function).
rowseps (generic reader).
(setf rowseps) (generic writer).
scan-cell (function).
scan-down (function).
scan-left (function).
scan-right (function).
scan-up (function).
structure-from-cells (function).
table-parser (class).
text-block (generic reader).
docutils.parserLibrary for docutils parsers
common-lisp.
docutils.
docutils.utilities.
+wsp-transitions+ (special variable).
abs-line-number (function).
abs-line-offset (function).
add-states (function).
add-transitions (function).
apply-transition (generic function).
blank (generic function).
blank-finish (generic function).
(setf blank-finish) (generic writer).
bof (generic function).
current-line (function).
eof (generic function).
get-indented (function).
get-text-block (function).
goto-line (function).
indent (generic function).
initial-state (generic reader).
initial-transitions (generic reader).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
initial-transitions (slot).
input-lines (generic reader).
insert-lines (function).
insert-lines (condition).
known-first-indent (function).
known-indent (function).
line-offset (generic reader).
(setf line-offset) (generic writer).
match (function).
match (structure).
match-end (reader).
(setf match-end) (writer).
match-group (function).
match-group-length (function).
match-reg-ends (reader).
(setf match-reg-ends) (writer).
match-reg-starts (reader).
(setf match-reg-starts) (writer).
match-start (reader).
(setf match-start) (writer).
match-string (reader).
(setf match-string) (writer).
matches (function).
next-line (function).
next-line-blank-p (function).
no-match (generic function).
nop (generic function).
previous-line (function).
remove-transition (function).
state (class).
state-correction (function).
state-machine (generic reader).
state-machine (class).
state-machine-run (generic function).
transition-match (function).
transition-name (function).
transitions (generic reader).
(setf transitions) (generic writer).
unexpected-indentation (condition).
wsp-state (class).
wsp-state-machine (class).
*goto-line-hooks* (special variable).
*scan-cache* (special variable).
*state-change-hooks* (special variable).
at-bof (function).
at-eof (function).
check-line (function).
copy-match (function).
current-state (generic reader).
(setf current-state) (function).
get-state (function).
input-offset (generic reader).
make-indent-state-machine (function).
make-known-indent-state-machine (function).
make-match (function).
make-nested-state-machine (generic function).
match-p (function).
states (generic reader).
(setf states) (generic writer).
transition-function (function).
transition-next-state (function).
transition-pattern (function).
docutils.parser.rstRestructured text parser for docutils
common-lisp.
data-format-validation.
docutils.
docutils.parser.
docutils.parser.tables.
docutils.utilities.
def-directive (macro).
def-role (macro).
rst-reader (class).
*context* (special variable).
*default-interpreted-role* (special variable).
*directives* (special variable).
*interpreted-roles* (special variable).
*pep-url* (special variable).
*rfc-url* (special variable).
*rst-state-classes* (special variable).
*section-bubble-up-kludge* (special variable).
*section-level* (special variable).
*title-styles* (special variable).
+enum-scanner+ (special variable).
+enumerated-lists+ (special variable).
+explicit-reference-scanner+ (special variable).
+explicit-substitution-scanner+ (special variable).
+explicit-target-scanner+ (special variable).
+roman-numeral-map+ (special variable).
+rst-transitions+ (special variable).
add-attributes (function).
add-field (function).
add-table-rows (function).
add-target (function).
anonymous (generic function).
anonymous-target (function).
bare-literal-block (function).
block-quote (function).
body (class).
build-table (function).
build-table-row (function).
bullet (generic function).
bullet-list (class).
check-attribution (function).
check-subsection (function).
citation (function).
closers (special variable).
comment (function).
context (generic reader).
(setf context) (generic writer).
copy-directive (function).
custom-role (class).
def-admonition (macro).
def-generic-role (macro).
define-inline-element-parse-tree (macro).
define-recursive-element-parse-tree (macro).
definition (class).
definition-list (class).
definition-list-item (function).
directive (function).
directive (structure).
directive-allow-spaces-p (reader).
(setf directive-allow-spaces-p) (writer).
directive-arguments (reader).
(setf directive-arguments) (writer).
directive-content-p (reader).
(setf directive-content-p) (writer).
directive-function (reader).
(setf directive-function) (writer).
directive-name (reader).
(setf directive-name) (writer).
directive-options (reader).
(setf directive-options) (writer).
directive-p (function).
doctest (generic function).
embedded-directive (generic function).
emphasis (function).
enum-args (function).
enum-matcher (function).
enumerated-list (class).
enumerator (generic function).
explicit (class).
explicit-construct (function).
explicit-constructs (special variable).
explicit-list (function).
explicit-markup (generic function).
extension-options (class).
extract-extension-options (function).
extract-name-value (function).
field-list (class).
field-marker (generic function).
footnote (function).
footnote-reference (function).
from-roman (function).
generic-custom-role (class).
get-directive (generic function).
(setf get-directive) (generic function).
grid-table-top (generic function).
grid-table-top-pattern (special variable).
hyperlink-target (function).
initial-lineno (generic reader).
(setf initial-lineno) (generic writer).
initial-quoted (generic function).
inline-text (function).
insert-metadata (function).
insert-subsection (generic function).
internal-target (function).
interpreted (function).
invalid-specialised-input (function).
is-enumerated-list-item (function).
is-reference (function).
isolate-grid-table (function).
isolate-simple-table (function).
lastordinal (generic reader).
(setf lastordinal) (generic writer).
line (generic function).
line (class).
line-block (generic function).
line-block (class).
line-block-line (function).
list-format (generic reader).
(setf list-format) (generic writer).
list-item (generic function).
literal (function).
literal-block (function).
make-directive (function).
make-enumerator (function).
make-image-nodes (function).
make-inline-nodes (macro).
make-node (macro).
make-target (function).
malformed-table (function).
match-titles (generic reader).
(setf match-titles) (generic writer).
math (function).
meta-body (class).
metadata-reader (class).
nest-line-block-lines (function).
nested-parse (function).
nested-state-machine (class).
new-subsection (function).
not-quoted (function).
openers (special variable).
option-list (class).
option-list-item (function).
option-marker (generic function).
paragraph (function).
parse-attribution (function).
parse-directive-block (function).
parse-extension-options (function).
parse-field-body (generic function).
parse-inline (function).
parse-option-marker (function).
parse-role (generic function).
parse-target (function).
quoted (function).
quoted-literal-block (function).
quoted-literal-block (class).
quoted-pattern (function).
recursive-rst-reader (class).
reference (function).
rfc2822 (generic function).
rfc2822-body (class).
rfc2822-field (function).
rfc2822-list (class).
role (class).
rst-patterns (special variable).
rst-state (class).
rst-state-machine (class).
section (function).
select-rst-transitions (function).
short-overline (function).
simple-table-top (generic function).
simple-table-top-pattern (special variable).
specialized-body (class).
specialized-text (class).
standard-role (class).
strong (function).
subsections (generic function).
substitution-def (function).
substitution-def (class).
substitution-reference (function).
table-top (function).
term (function).
text (generic function).
text (class).
title (generic function).
to-roman (function).
topic (function).
underline (generic function).
unindent-warning (function).
uri (function).
docutils.writer.htmlHTML with CSS writer for docutils
common-lisp.
docutils.
docutils.nodes.
docutils.utilities.
html-url (generic function).
html-writer (class).
*compact-p* (special variable).
*compact-simple* (special variable).
*in-sidebar* (special variable).
*section-level* (special variable).
*topic-class* (special variable).
add-docinfo-item (macro).
attval (function).
def-simple-node (macro).
empty-tag (function).
encode (function).
image-div-atts (function).
is-named-tag (function).
math-out (function).
parents (function).
set-first-last (function).
should-be-compact-p (function).
simple-list-p (function).
start-tag (function).
topic-class (function).
words-and-spaces (function).
docutils.writer.latexLatex writer for docutils
cl-ppcre.
common-lisp.
docutils.
docutils.nodes.
docutils.utilities.
trivial-gray-streams.
latex-output-stream (class).
latex-writer (class).
active-table (generic reader).
attval (function).
author-stack (generic reader).
(setf author-stack) (generic writer).
bookmark (function).
class-sections (generic reader).
close-table (function).
closing (function).
col-specs (function).
collect-parts (macro).
column-width (function).
depart-row (function).
dependencies (generic reader).
(setf dependencies) (generic writer).
double-quotes-in-tt (function).
encode (function).
ensure-table-preamble (function).
entry-number (generic reader).
enumeration-counters (generic reader).
(setf enumeration-counters) (generic writer).
latex-length (function).
latex-table (class).
latex-type (generic reader).
literal-block-stack (generic reader).
(setf literal-block-stack) (generic writer).
max-enum-depth (generic reader).
(setf max-enum-depth) (generic writer).
metadata (generic reader).
mode (function).
open-p (generic reader).
(setf open-p) (generic writer).
open-table (function).
opening (function).
quote-quotes (function).
rowspan (function).
(setf rowspan) (function).
section-numbers (generic reader).
(setf section-numbers) (generic writer).
table-style (generic reader).
to-latex-encoding (function).
used-packages (function).
vertical-bar (function).
visit-docinfo-item (macro).
visit-entry (function).
visit-row (function).
visit-thead (function).
with-modes (macro).
docutils.nodesPackage containing standard docutils Node names
abbreviation (class).
abmonition (class).
acronym (class).
address (class).
admonition (class).
attention (class).
attribution (class).
author (class).
authors (class).
backlinkable (class).
bibliographic (class).
block-evaluation (class).
block-quote (class).
body (slot).
body (slot).
body (class).
bullet-list (class).
caption (slot).
caption (generic reader).
caption (class).
caution (class).
citation (class).
citation-reference (class).
classifier (class).
colspec (class).
comment (class).
compound (class).
contact (class).
container (class).
copyright (class).
danger (class).
date (slot).
date (generic reader).
(setf date) (generic writer).
date (class).
decoration (class).
decorative (class).
definition (class).
definition-list (class).
definition-list-item (class).
description (class).
docinfo (slot).
docinfo (slot).
docinfo (generic function).
docinfo (class).
doctest-block (class).
document (slot).
document (generic function).
(setf document) (generic writer).
document (class).
element (class).
emphasis (class).
entry (class).
enumerated-list (class).
equation (class).
error (class).
evaluateable (class).
field (class).
field-body (class).
field-list (class).
field-name (class).
figure (class).
footer (slot).
footer (slot).
footer (class).
footnote (class).
footnote-reference (class).
general (class).
generated (class).
header (class).
hint (class).
image (class).
important (class).
inline (class).
inline-evaluation (class).
invisible (class).
label (class).
legend (class).
line (slot).
line (generic reader).
line (class).
line-block (class).
list-item (class).
literal (class).
literal-block (class).
math (class).
meta (class).
node (slot).
node (slot).
node (slot).
node (slot).
node (generic reader).
(setf node) (generic writer).
node (class).
note (class).
option (class).
option-argument (class).
option-group (class).
option-list (class).
option-list-item (class).
option-string (class).
organization (class).
paragraph (class).
part (class).
pending (class).
prebibliographic (class).
predecorative (class).
problematic (class).
raw (class).
reference (class).
referential (class).
resolvable (class).
revision (class).
root (class).
row (class).
rubric (class).
section (function).
section (class).
sequential (class).
sidebar (class).
special (class).
status (class).
strong (class).
structural (class).
subscript (class).
substitution-definition (class).
substitution-reference (class).
subtitle (class).
superscript (class).
system-message (class).
table (class).
target (class).
targetable (class).
tbody (class).
term (class).
text (class).
text-element (class).
tgroup (class).
thead (class).
tip (class).
title (slot).
title (generic function).
(setf title) (generic writer).
title (class).
title-reference (class).
titular (class).
topic (class).
transition (class).
version (class).
warning (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Current line number - used for line in node creation
The default package Lisp expressions in the document are to be read into
Document (root element) currently being operated on
Hook to call when there is an error in the evaluator
Function to call when evaluating an evaluateable node
Default language for processing
Directory in which translation data is held. Each language has a file containing an a-list mapping translated form to a cannonical form
Prefix namespace for ids
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."
)
White space characters: Space, Tab, Return, Newline, Page, PageUp
Transitons for a wsp state machine
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}]] )
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]]}}] )
Bind VAR to VALUE of expression, execute body if true
Repeat body while test returns true
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.
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
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
Return Return line offset of current line, from beginning of file.
register state classes with this state engine
Add a list of transitions to the start of the transition list.
Copy from input stream FROM into output stream TO upto COUNT bytes, or until end-of-file if COUNT is NIL
Return a string with escape-backslashes converted to nulls.
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
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,
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).
Jump to absolute line offset abs-line-offset, load and return it.
Return mapping of ids to nodes in element.
Returns the indentation level of the line, including tabs as expanded
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?
Return true if subseq is a prefix in seq
Return true if subseq is a suffix in seq
Handle a known-indent text block (first line’s indent
known). Extend or override in subclasses. Recursively run the state
machine for indented blocks
Handle a known-indent text block. Extend or override in subclasses. Recursively run the state machine for indented blocks
Return last character written to the stream
Return length of line excluding trailing whitespace
Make an ID from string that meets requirements of CSS and html 4.01
end.
Return a new subsequence corresponding to match group n of match. If n is not specified returns entire match
Return length of the subsequence corresponding to match group n of match
Mapping of names to unique id’s.
TRUE if the next line is blank or non-existant.
Mapping of ids to lists of referencing nodes.
Return mapping of names to lists of referencing nodes.
Remove a transition by ‘name‘
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
Remove trailing white space from string
Return the section name at the given level for the specific document class.
This will set and return the id for a node.
Return a vector of lines split from string
Remove prefixing and trailing white space from string
Return a string with nulls removed or restored to backslashes. Backslash-escaped spaces are also removed.
Removes last character from buffer and returns it if possible. If buffer was empty returns nil.
Return and whitespace-normalized name.
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)
text-element) (child system-message) &optional index) ¶Add system message to part of a text element
targetable) &optional index) ¶text-element) (child string) &optional index) ¶Add class to given node
Return true if node is allowed as a child of parent
field-list) child &optional index) ¶structural) &optional index) ¶document) (child structural) &optional index) ¶section) (child structural) &optional index) ¶topic) (child structural) &optional index) ¶structural) (child topic) &optional index) ¶text-element) (child text-element) &optional index) ¶text-element) (child text) &optional index) ¶text-element) child &optional index) ¶Execute transition from state with match
Return lisp s-exp representation of an element
evaluateable)) ¶Return text representation of an element as a string
system-message)) ¶option-argument)) ¶evaluateable)) ¶Set the text value of a node (if allowed)
Return an attribute of a node corresponding to label
Set a named attribute of an element
backlinkable)) ¶automatically generated reader method
Handle blank lines.
quoted-literal-block) match) ¶specialized-text) match) ¶line-block) match) ¶rfc2822-list) match) ¶wsp-state-machine)) ¶Used to keep track of blank lines
wsp-state-machine)) ¶Used to keep track of blank lines
Beginning of file transition
latex-table)) ¶automatically generated reader method
Return a child at position index
Deep copy a node
latex-writer)) ¶latex-writer)) ¶Set date
date.
Return the docinfo component of a document
Return the document root of the tree containing this node
rst-state-machine)) ¶Top level Document Markup
Set the document to be processed and reset the component
rst-state-machine)) ¶Top level Document Markup
End of file transition
quoted-literal-block)) ¶definition)) ¶Not a definition.
specialized-text)) ¶markup-condition)) ¶data.
markup-condition)) ¶markup-condition)) ¶markup-condition)) ¶line.
unexpected-indentation)) ¶markup-condition)) ¶markup-condition)) ¶node.
Return the error-severity (0-10) for an entity
system-message)) ¶symbol)) ¶markup-condition)) ¶insert-lines)) ¶unexpected-indentation)) ¶Evaluate the node in current dynamic context, returning the result.
evaluateable)) ¶evaluateable)) ¶automatically generated reader method
Return the field text for a specific field name
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.
html-writer) uri &rest args) ¶Handle an indented text block. Extend or override
in subclasses. Recursively run the state machine for indented blocks
quoted-literal-block) match) ¶definition) match) ¶Definition list item.
specialized-text) match) ¶Return the posiiton of child in element
state-machine)) ¶the initial state name.
state-machine)) ¶vector of input lines (without newlines)
Language for this node
The line number (1-based) of the beginning of this Node in ‘source‘.
state-machine)) ¶state-machine)) ¶Current input line offset from beginning of input-lines.
Make a node with given initialisers
system-message) &rest message-args) ¶text-element) &rest contents) ¶(eql docutils.nodes:text)) &rest attributes) ¶symbol) &rest contents) ¶document)) ¶automatically generated reader method
string)) ¶Return the namespace component of an id or nil if none. Returns other id component as second value
Create and return a new empty document tree (root node).
Called when there is no match from ‘StateMachine.check_line()‘.
specialized-body) transitions) ¶nested-state-machine)) ¶nested-state-machine)) ¶Current node in document
rst-state-machine)) ¶rst-state-machine)) ¶Current node in document
A do nothing transition method.
Reutrn the number of children a node has
evaluateable)) ¶Specifies what format the output is in (for writers).
Back-reference to the Node immediately containing this Node.
Create and read a new document using reader from source
recursive-rst-reader)) ¶metadata-reader)) ¶rst-reader)) ¶Read and return a vector of lines from an entity for subsequent parsing
targetable)) ¶automatically generated reader method
targetable)) ¶automatically generated writer method
Remove an attribute from a node
Remove a child element from parent
Remove a node
resolvable)) ¶automatically generated reader method
resolvable)) ¶automatically generated writer method
Return the value of given setting for entity
Set a setting value for an entity
symbol) (hash hash-table)) ¶pathname)) ¶writer)) ¶Overwritten setting affecting document writing
Run state machine over input lines filling in document
nested-state-machine) (input-lines vector) &key input-offset node match-titles &allow-other-keys) ¶rst-state-machine) (input-lines vector) &key document inliner node match-titles &allow-other-keys) ¶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.
Substitute new node for and old node in document tree
Returns true if given writer supports a specific format
Return the title for an entity
latex-writer)) ¶automatically generated reader method
latex-writer)) ¶automatically generated writer method
Apply a given transform to its’ document node
evaluate-transform)) ¶simple-transform)) ¶class-attribute)) ¶resolve-media)) ¶substitutions)) ¶internal-targets)) ¶external-targets)) ¶indirect-hyperlinks)) ¶anonymous-hyperlinks)) ¶chained-targets)) ¶target-notes)) ¶final-checks)) ¶filter-messages)) ¶decorations)) ¶function)) ¶Return a list of the default transforms class names to be applied after parsing
rst-reader)) ¶Process entity for writer where entity is any entity in the document.
latex-writer) (node evaluateable)) ¶latex-writer) (node version)) ¶latex-writer) (node transition)) ¶latex-writer) (node rubric)) ¶latex-writer) (node inline)) ¶latex-writer) (node topic)) ¶latex-writer) (node title)) ¶latex-writer) (node thead)) ¶latex-writer) (node term)) ¶latex-writer) (node tbody)) ¶latex-writer) (node target)) ¶latex-writer) (node tgroup)) ¶latex-writer) (node table)) ¶latex-writer) (node subtitle)) ¶latex-writer) (node substitution-reference)) ¶latex-writer) (node substitution-definition)) ¶latex-writer) (node strong)) ¶latex-writer) (node status)) ¶latex-writer) (node attribution)) ¶latex-writer) (node sidebar)) ¶latex-writer) (node section)) ¶latex-writer) (node revision)) ¶latex-writer) (node reference)) ¶latex-writer) (node raw)) ¶latex-writer) (node system-message)) ¶latex-writer) (node problematic)) ¶latex-writer) (node paragraph)) ¶latex-writer) (node organization)) ¶latex-writer) (node option-list-item)) ¶latex-writer) (node option-list)) ¶latex-writer) (node option-group)) ¶latex-writer) (node option-argument)) ¶latex-writer) (node option)) ¶latex-writer) (node meta)) ¶latex-writer) (node literal-block)) ¶latex-writer) (node literal)) ¶latex-writer) (node list-item)) ¶latex-writer) (node line-block)) ¶latex-writer) (node line)) ¶latex-writer) (node legend)) ¶latex-writer) (node image)) ¶latex-writer) (node header)) ¶latex-writer) (node label)) ¶latex-writer) (node footnote-reference)) ¶latex-writer) (node footnote)) ¶latex-writer) (node footer)) ¶latex-writer) (node figure)) ¶latex-writer) (node field-name)) ¶latex-writer) (node field-list)) ¶latex-writer) (node field-body)) ¶latex-writer) (node field)) ¶latex-writer) (node enumerated-list)) ¶latex-writer) (node row)) ¶latex-writer) (node entry)) ¶latex-writer) (node emphasis)) ¶latex-writer) (node doctest-block)) ¶latex-writer) (node docinfo)) ¶latex-writer) (node description)) ¶latex-writer) (node definition-list-item)) ¶latex-writer) (node definition-list)) ¶latex-writer) (node definition)) ¶latex-writer) (node date)) ¶latex-writer) (node copyright)) ¶latex-writer) (node contact)) ¶latex-writer) (node comment)) ¶latex-writer) (node colspec)) ¶latex-writer) (node classifier)) ¶latex-writer) (node citation-reference)) ¶latex-writer) (node citation)) ¶latex-writer) (node title-reference)) ¶latex-writer) (node caption)) ¶latex-writer) (node equation)) ¶latex-writer) (node math)) ¶latex-writer) (node subscript)) ¶latex-writer) (node superscript)) ¶latex-writer) (node bullet-list)) ¶latex-writer) (node block-quote)) ¶latex-writer) (node author)) ¶latex-writer) (node admonition)) ¶latex-writer) (node address)) ¶latex-writer) (text text)) ¶latex-writer) (document document)) ¶latex-table) (node colspec)) ¶html-writer) (node evaluateable)) ¶html-writer) (node version)) ¶html-writer) (node transition)) ¶html-writer) (node topic)) ¶html-writer) (node title-reference)) ¶html-writer) (node title)) ¶html-writer) (node thead)) ¶html-writer) (node tgroup)) ¶html-writer) (node term)) ¶html-writer) (node tbody)) ¶html-writer) (node target)) ¶html-writer) (node table)) ¶html-writer) (node system-message)) ¶html-writer) (node superscript)) ¶html-writer) (node subtitle)) ¶html-writer) (node substitution-definition)) ¶html-writer) (node subscript)) ¶html-writer) (node strong)) ¶html-writer) (node status)) ¶html-writer) (node sidebar)) ¶html-writer) (node section)) ¶html-writer) (node rubric)) ¶html-writer) (node row)) ¶html-writer) (node revision)) ¶html-writer) (node reference)) ¶html-writer) (node raw)) ¶html-writer) (node problematic)) ¶html-writer) (node paragraph)) ¶html-writer) (node organization)) ¶html-writer) (node option-string)) ¶html-writer) (node option-list-item)) ¶html-writer) (node option-list)) ¶html-writer) (node option-argument)) ¶html-writer) (node option-group)) ¶html-writer) (node meta)) ¶html-writer) (node literal-block)) ¶html-writer) (node literal)) ¶html-writer) (node list-item)) ¶html-writer) (node line-block)) ¶html-writer) (node line)) ¶html-writer) (node legend)) ¶html-writer) (node label)) ¶html-writer) (node inline)) ¶html-writer) (node image)) ¶html-writer) (node equation)) ¶html-writer) (node math)) ¶html-writer) (node header)) ¶html-writer) (node footnote-reference)) ¶html-writer) (node footnote)) ¶html-writer) (node footer)) ¶html-writer) (node figure)) ¶html-writer) (node field-name)) ¶html-writer) (node field-list)) ¶html-writer) (node field-body)) ¶html-writer) (node field)) ¶html-writer) (node enumerated-list)) ¶html-writer) (node entry)) ¶html-writer) (node emphasis)) ¶html-writer) (node doctest-block)) ¶html-writer) (node docinfo)) ¶html-writer) (node description)) ¶html-writer) (node definition-list)) ¶html-writer) (node definition)) ¶html-writer) (node date)) ¶html-writer) (node copyright)) ¶html-writer) (node contact)) ¶html-writer) (node compound)) ¶html-writer) (node comment)) ¶html-writer) (node colspec)) ¶html-writer) (node classifier)) ¶html-writer) (node citation-reference)) ¶html-writer) (node citation)) ¶html-writer) (node caption)) ¶html-writer) (node bullet-list)) ¶html-writer) (g1 block-quote)) ¶html-writer) (node author)) ¶html-writer) (node attribution)) ¶html-writer) (node admonition)) ¶html-writer) (node address)) ¶html-writer) (g1 acronym)) ¶html-writer) (g1 abbreviation)) ¶html-writer) (text text)) ¶html-writer) (document document)) ¶evaluateable)) ¶element)) ¶By default visit children of an element. throw to :skip-siblings to not process further children
Write document out to destination using given writer
latex-writer) document (os stream)) ¶(eql string))) ¶Write a document part from writer to an output stream.
latex-writer) (part (eql docutils.writer.latex::fragment)) (os stream)) ¶html-writer) (part (eql docutils.writer.html:fragment)) (os stream)) ¶line-wrap-stream) &key abort) ¶line-wrap-stream) &key line-length &allow-other-keys) ¶table-parser) &key &allow-other-keys) ¶text-element) &key text &allow-other-keys) ¶element) &key children attributes &allow-other-keys) ¶document) &key source-path &allow-other-keys) ¶field-name) stream) ¶line-wrap-stream)) ¶sb-gray.
line-wrap-stream)) ¶sb-gray.
line-wrap-stream)) ¶sb-gray.
line-wrap-stream)) ¶automatically generated reader method
sb-gray.
line-wrap-stream)) ¶sb-gray.
line-wrap-stream) (c character)) ¶sb-gray.
latex-output-stream) (c character)) ¶sb-gray.
condition.
(quote nil)
:text-block
This slot is read-only.
An condition in the structured text markup. level
can be used by handlers to determine whether to ignore, print, record or abort
parsing
(quote nil)
:node
This slot is read-only.
(quote nil)
:line
(quote nil)
:source
This slot is read-only.
(quote :warning)
:level
This slot is read-only.
(quote nil)
:data
This slot is read-only.
(quote nil)
:backrefs
This slot is read-only.
(quote nil)
:message
This slot is read-only.
Results of a transition match
Link anonymous references to targets
| Initarg | Value |
|---|---|
:priority | 440 |
Block evaluateable element
Attributes "refuri" and "refname" are migrated from the final direct target up the chain of contiguous adjacent internal targets
| Initarg | Value |
|---|---|
:priority | 420 |
Move class attribute of pending node to next non-comment element
| Initarg | Value |
|---|---|
:priority | 210 |
Include or exclude elements - for use with pending elements
| Initarg | Value |
|---|---|
:priority | 720 |
Populate a document’s decoration element (header, footer).
| Initarg | Value |
|---|---|
:priority | 820 |
Transform to create document bibliographic fields.
| Initarg | Value |
|---|---|
:priority | 340 |
(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)))
:biblio-nodes
This slot is read-only.
Transform to promote document title and subtitle.
| Initarg | Value |
|---|---|
:priority | 320 |
The main document root element
| Initarg | Value |
|---|---|
:line | 0 |
:namespace
This slot is read-only.
Runtime settings data record.
current id.
0
:id-start
Abstract base to all specific elements containing attributes and child nodes.
node.
admonition.
attention.
authors.
block-evaluation.
block-quote.
bullet-list.
caution.
citation.
colspec.
compound.
container.
danger.
decoration.
definition.
definition-list.
definition-list-item.
description.
docinfo.
document.
entry.
enumerated-list.
error.
field.
field-body.
field-list.
figure.
footer.
footnote.
header.
hint.
important.
legend.
line-block.
list-item.
meta.
note.
option.
option-group.
option-list.
option-list-item.
pending.
row.
section.
sidebar.
system-message.
table.
tbody.
text-element.
tgroup.
thead.
tip.
topic.
transition.
warning.
add-child.
add-child.
add-class.
allowed-child-p.
allowed-child-p.
allowed-child-p.
allowed-child-p.
allowed-child-p.
allowed-child-p.
allowed-child-p.
allowed-child-p.
as-sexp.
as-text.
(setf attribute).
attribute.
child.
child-text-separator.
copy-of-node.
evaluate.
index.
initialize-instance.
language.
make-node.
number-children.
print-object.
rem-attribute.
rem-child.
rem-child.
setup-child.
substitute-node.
title.
visit-node.
Evaluate nodes cahcing result
Base for nodes which can be evaluated
node.
:lisp
:language
This slot is read-only.
Specifies what format the output is in (for writers).
:format
This slot is read-only.
Read expression to be evaluated at some later time.
:expression
This slot is read-only.
replace :refname attribute with the direct :refuri attribute for external targets.
| Initarg | Value |
|---|---|
:priority | 640 |
Automatically assigns numbers to Figures, tables and equations.
| Initarg | Value |
|---|---|
:priority | 711 |
Include or exclude elements - for use with pending elements
| Initarg | Value |
|---|---|
:priority | 780 |
Remove system messages below verbosity threshold.
| Initarg | Value |
|---|---|
:priority | 870 |
Perform last-minute checks and transforms.
- Check for dangling references (incl. footnote & citation). - Check for illegal transitions, move transitions
| Initarg | Value |
|---|---|
:priority | 840 |
Assign numbers to autonumbered footnotes, and
resolve links to footnotes, citations, and their references.
| Initarg | Value |
|---|---|
:priority | 620 |
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.
Docutils html writer
html-url.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
write-part.
| Initarg | Value |
|---|---|
: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>))) |
Specify a stylesheet. If a URL put link in output
HTML file, if a pathname embed stylesheet in output HTML
"docutils.css"
:stylesheet
""
process internal and external indirect hyperlinks
| Initarg | Value |
|---|---|
:priority | 460 |
Inline evaluateable element
replace :refname attribute with the direct :refid attribute for internal targets.
| Initarg | Value |
|---|---|
:priority | 660 |
Internal elements that don’t appear in output.
Stream to help format latex out correctly - uses line wrapping, removes multiple spaces (including ~)
Docutils latex writer
active-table.
(setf author-stack).
author-stack.
class-sections.
(setf date).
date.
(setf dependencies).
dependencies.
(setf enumeration-counters).
enumeration-counters.
(setf literal-block-stack).
literal-block-stack.
(setf max-enum-depth).
max-enum-depth.
metadata.
(setf section-numbers).
section-numbers.
(setf title).
title.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
visit-node.
write-document.
write-part.
| Initarg | Value |
|---|---|
:parts | (quote (head-prefix pdfinfo pdfauthor head body-prefix docinfo body footer body-suffix)) |
(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")))
This slot is read-only.
This slot is read-only.
""
List of author information
List of Modes currently active e.g. :literal :mathmode :literal-block
Nested literal blocks
List of dependencie uris
Stack of nested section numbers
Stack of enumeration counters
Maximum enumeration counter depth so far
0
docinfo metadata for Latex and pdfinfo
(make-hash-table)
This slot is read-only.
A simple line-wrapping stream filter
fundamental-character-output-stream.
trivial-gray-stream-mixin.
sb-gray.
0
This slot is read-only.
Current indentation level
0
:indentation-level
This slot is read-only.
#\
This slot is read-only.
Actual stream being written to - must be capable of writing characters using write-char
common-lisp.
:stream
This slot is read-only.
Function returns true if character can be used as line break
(function docutils.utilities:wsp-char-p)
This slot is read-only.
This slot is read-only.
Abstract base class of nodes in a document tree
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.
Category of Node which may occur before Bibliographic Nodes.
Category of Node which may occur before Decorative Nodes.
Raw data that is to be passed untouched to the Writer.
Base classes to produce a document from input
a-list of overwriding reading and parsing settings
:settings
Resolve media dependancies
| Initarg | Value |
|---|---|
:priority | 850 |
The ReStructured text parser
Automatically assigns numbers to the titles of document sections.
| Initarg | Value |
|---|---|
:priority | 710 |
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.
A simple transform which calls the closure with the node
common-lisp.
:function
Special internal body elements.
body.
State superclass.
A reference to the controlling StateMachine object.
:state-machine
This slot is read-only.
The initial set of transitions for this state
:class
This slot is read-only.
List of transitions in order.
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.
vector of input lines (without newlines)
:input-lines
This slot is read-only.
a list of allowed state classe names.
:states
the initial state name.
:initial-state
This slot is read-only.
the current state.
This slot is read-only.
Offset of input-lines from the beginning of the file.
0
:input-offset
This slot is read-only.
Current input line offset from beginning of input-lines.
-1
Replace substitution-references with the
contents of the corresponding substitution-definitions.
| Initarg | Value |
|---|---|
:priority | 220 |
Creates a footnote for each external target in the text, and corresponding footnote references after each reference.
| Initarg | Value |
|---|---|
:priority | 540 |
Instances are terminal nodes (leaves) containing text only; no child nodes or attributes.
An element which directly contains text.
Its children are all ‘Text‘ or ‘TextElement‘ subclass nodes
address.
attribution.
author.
caption.
classifier.
contact.
copyright.
date.
equation.
field-name.
fixed-text-element.
inline.
inline-evaluation.
label.
line.
option-argument.
option-string.
organization.
paragraph.
revision.
rubric.
status.
substitution-definition.
subtitle.
target.
term.
title.
version.
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.
Docutils transform component abstract base class.
anonymous-hyperlinks.
chained-targets.
class-attribute.
contents.
decorations.
docinfo.
doctitle.
evaluate-transform.
external-targets.
fignum.
filter.
filter-messages.
final-checks.
footnotes.
indirect-hyperlinks.
internal-targets.
resolve-media.
sectnum.
simple-transform.
substitutions.
target-notes.
Numerical priority of this transform, 0 through 999.
500
:priority
This slot is read-only.
(incf docutils::*transform-counter*)
This slot is read-only.
Base Class for writing a document
List of slot names for component parts in
the output. The writer should accumulate strings on each part using
push.
:parts
This slot is read-only.
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‘.
:class
docutils.parser:+wsp-transitions+
state-machine subclass specialized for whitespace recognition
Used to keep track of blank lines
t
List of configuration files already read.
Context passed to text state
Writer currently processing document
current destination writer slot
The canonical name of the default interpreted role. This role is used when no role is specified for a piece of interpreted text.
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
A list of functions called when state machine moves to another line. Functions take two functions, the state machine and the absolute line offset
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
Conversion from various units to inches
Characters used as a delimiter for id namespace component
(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.
set of State classes used with ‘rst-state-machine
List of paths to search for dependencies in addition to those specified in settings
Current section level - index in styles
Hash of of configuration parameters
List of standard docutils configuration files
A list of functions called when state is changed. Called with state machine and the new state object
Destination node for any system messages
The amount of space that a tab is equivalent to
List of title styles in order
Used to ensure transforms of the same priority maintain their order
Hash table mapping language name to languages
Regex for matching against 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
Matches an element that is recursive i.e. uses a greedy match
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.
Helper macro for docinfo items
Return a list of external targets in a document in order of occurance
True if the input is at or before beginning-of-file.
True if the input is at or past end-of-file.
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)
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.
Return col-specs for longtable
A directive block
name.
Encode special characters in ‘text‘ & return encoded 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:
Given a match returned from enum-matcher return the format, sequence,ordinal and text parameters
pattern matcher for enumerated lists - determins format,type and count
Create a nested state machine for a series of explicit markup constructs (including anonymous hyperlink targets).
Given a field list return an alist of names and values
Return a list of (:name value) from a line of the form name=value
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.
Returns first child of node not of type type
Convert roman numeral to integer
Return new state class object
Deal with transform errors, adding system message to messages node
Helper function can be called to insert field data into a document
Not a compound element member. Abort this state machine.
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.
Return a new string by joining together the STRINGS, separating each string with a SEPARATOR character or string
Return one line element of a line_block.
Trim ‘length‘ characters off the beginning of each line,
from index ‘start‘ to ‘end‘. No whitespace-checking is done on the
trimmed text.
Return a list of nodes.
Return true if writer is in any of the checklist modes
Move the children from one node to another. Returns the list of children in to-element
Create a new StateMachine rooted at ‘node‘ and run it over the input ‘block‘.
Return a parse tree expression for expr not quoted
Returns a displaced array on array of element from start to end (default length array)
Assign numbers to autonumbered footnote references.
Assign numbers to autonumbered footnotes.
For labeled autonumbered footnotes, copy the number over to
corresponding footnote references.
Return a paragraph node & a boolean: literal-block next?
Parse a directive block made up of arguments, keyword options and content
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.
Return a list of ‘node.option‘ and ‘node.option_argument‘ objects, parsed from an option marker match.
Determine the type of reference of a target.
Returns two values
- :refname and the indirect reference name or
- :refuri and the URI
Match consistent quotes on subsequent lines.
Return a parse tree expression for a quoted expression quoted
Remove children from node and return them as a list
Look for the bottom-right corner of the cell, making note of all row boundaries.
Noting column boundaries, look for the bottom-left corner of the cell. It must line up with the starting point.
Look for the top-right corner of the cell, and make note of all column boundaries (’+’).
Noting row boundaries, see if we can return to the starting point.
Check for a valid subsection and create one if it checks out.
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.
Determine if the <p> tags around paragraph “node“ can be omitted.
Return hashtable of substitution definitions in a document
Return a hashtable of lists of substitution refs keyed by name
Add symbols indexes to ’[*]’-style footnotes and references.
Translate docutils encoding name into latex’s.
Default fallback method is remove "-" and "_" chars from docutils_encoding.
convert integer to Roman numeral
Transforms compared by priority and order in which created
Return the abstract of an entity
latex-writer)) ¶automatically generated reader method
latex-writer)) ¶latex-writer)) ¶List of author information
bullet-list) match) ¶Bullet list item.
grid-table-parser)) ¶automatically generated reader method
grid-table-parser)) ¶automatically generated writer method
Return separator for child nodes in as-text
option-list-item)) ¶option-group)) ¶latex-writer)) ¶automatically generated reader method
Comparison function for ordering sequences of entities
grid-table-parser)) ¶automatically generated reader method
grid-table-parser)) ¶automatically generated writer method
quoted-literal-block)) ¶automatically generated reader method
quoted-literal-block)) ¶automatically generated writer method
state-machine)) ¶the current state.
latex-writer)) ¶latex-writer)) ¶List of dependencie uris
Apply the transformations to this document in
order. Any system messages are added into a dedicated section at the
end of the document
list) document) ¶table-parser)) ¶automatically generated reader method
done.
substitution-def) match) ¶latex-table)) ¶automatically generated reader method
latex-writer)) ¶latex-writer)) ¶Stack of enumeration counters
Parse an enumerated list item
enumerated-list) match) ¶Enumerated list item.
markup-condition)) ¶markup-condition)) ¶explicit) match) ¶Footnotes, hyperlink targets, directives, comments.
definition-list) match) ¶evaluateable)) ¶Read expression to be evaluated at some later time.
field-list) match) ¶Generate the header and add to document
Given a directive name and a directives entity
return the directive function. This is implemented as a generic
function so that the directives can be stored in a class ’shadowing’
the main rst directives hash.
hash-table)) ¶Given a directive name and a directives entity
return the directive function. This is implemented as a generic
function so that the directives can be stored in a class ’shadowing’
the main rst directives hash.
hash-table)) ¶table-parser)) ¶Index of head body separator
Return true if an implicit target
line-wrap-stream)) ¶automatically generated reader method
line-wrap-stream)) ¶Current indentation level
line-wrap-stream)) ¶quoted-literal-block)) ¶automatically generated reader method
quoted-literal-block)) ¶automatically generated writer method
quoted-literal-block) match) ¶Match arbitrary quote character on the first line only.
state-machine)) ¶Offset of input-lines from the beginning of the file.
Called for each subsection to insert appropriate nodes into a parent node. By default inserts a section entity with given title.
enumerated-list)) ¶automatically generated reader method
enumerated-list)) ¶automatically generated writer method
latex-table)) ¶automatically generated reader method
Section title overline or transition marker.
line-block) match) ¶New line of line block.
line-wrap-stream)) ¶Function returns true if character can be used as line break
line-wrap-stream)) ¶automatically generated reader method
enumerated-list)) ¶automatically generated reader method
enumerated-list)) ¶automatically generated writer method
latex-writer)) ¶latex-writer)) ¶Nested literal blocks
Created a nested state machine to parse nested document structures.
nested-state-machine)) ¶automatically generated reader method
rst-state-machine)) ¶automatically generated reader method
nested-state-machine)) ¶automatically generated writer method
rst-state-machine)) ¶automatically generated writer method
latex-writer)) ¶latex-writer)) ¶Maximum enumeration counter depth so far
latex-writer)) ¶docinfo metadata for Latex and pdfinfo
latex-table)) ¶automatically generated reader method
open.
latex-table)) ¶automatically generated writer method
open.
option-list) match) ¶extension-options) indented offset node) ¶Override ‘Body.parse_field_body‘ for simpler parsing.
Apply given role to text, returning a list of markup elements to be inserted in place
generic-custom-role) text &optional option-values content) ¶custom-role) text &optional option-values content) ¶standard-role) text &optional option-values content) ¶(eql nil)) text &optional option-values content) ¶string) text &optional option-values content) ¶Return full path corresponding to uri in a node
RFC2822-style field list item.
rfc2822-list) match) ¶Second and subsequent RFC2822-style field_list fields.
rfc2822-body) match) ¶grid-table-parser)) ¶automatically generated reader method
grid-table-parser)) ¶automatically generated writer method
latex-writer)) ¶latex-writer)) ¶Stack of nested section numbers
Setup up a child after adding to (arent at index
state-machine)) ¶state-machine)) ¶a list of allowed state classe names.
line-wrap-stream)) ¶Actual stream being written to - must be capable of writing characters using write-char
Return an ordered list of subsection sources for a source
latex-table)) ¶automatically generated reader method
The element generic identifier.
quoted-literal-block) match) ¶specialized-text) match) ¶substitution-def) match) ¶definition-list) match) ¶Definition lists.
table-parser)) ¶Block of text to be parser
Return the subsection title for a source
specialized-text) match) ¶condition.
condition.
Directive Specification
structure-object.
""
t
common-lisp.
Generic classifier of the first line of a block.
:class
docutils.parser.rst::+rst-transitions+
Second and subsequent bullet_list list_items.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser:blank) (quote docutils.parser.rst::bullet))
Second line of potential definition-list-item.
Second and subsequent definition_list_items.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::explicit-markup) (quote docutils.parser.rst::text))
Second and subsequent enumerated-list listitems.
0
:ordinal
:format
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser:blank) (quote docutils.parser.rst::enumerator))
Second and subsequent explicit markup construct.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::explicit-markup))
Second and subsequent field_list fields.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::field-marker))
An element which directly contains preformatted text.
(quote ((:class class)))
:options
Contains a ‘label‘ as its first element.
Manage a table while traversing.
Maybe change to a mixin defining the visit/departs, but then
class Table internal variables are in the Translator.
"longtable"
:latex-type
This slot is read-only.
"booktabs"
:table-style
This slot is read-only.
common-lisp.
This slot is read-only.
This slot is read-only.
Second line of over- & underlined section title or transition marker.
t
Second and subsequent lines of a line_block.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::line-block) (quote docutils.parser:blank))
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::field-marker))
An rst reader which reads only title and docinfo
:title-only-p
StateMachine run from within other StateMachine runs, to parse nested document structures.
Second and subsequent field_list fields.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::option-marker))
Nested parse handler for quoted (unindented) literal blocks. Special-purpose. Not for inclusion in ‘state_classes‘.
:class
(append docutils.parser:+wsp-transitions+ (sb-int:quasiquote ((docutils.parser.rst::initial-quoted docutils.parser.rst::nonalphanum7bit) (docutils.parser.rst::text #s(sb-impl::comma :expr (function (lambda (docutils.parser.rst::s &key (docutils.parser.rst::start 0) (docutils.parser.rst::end (length docutils.parser.rst::s))) (values docutils.parser.rst::start docutils.parser.rst::end))) :kind 0)))))
-1
:initial-line
A reader which will recursively read from an entity
and recurse down through subsections, reading them in turn
RFC2822 headers are only valid as the first
constructs in documents. As soon as anything else appears, the ‘Body‘
state should take over.
body.
:class
(mapcan (function (lambda (docutils.parser.rst::transition) (sb-int:quasiquote (#s(sb-impl::comma :expr (when (eql (docutils.parser:transition-name docutils.parser.rst::transition) :text) (quote ((docutils.parser.rst::rfc2822 "([!-9;-~]+):( +|$)'" docutils.parser.rst::body)))) :kind 2) #s(sb-impl::comma :expr (list (first docutils.parser.rst::transition) (second docutils.parser.rst::transition) (quote docutils.parser.rst::body)) :kind 0))))) docutils.parser.rst::+rst-transitions+)
Second and subsequent field_list fields.
:class
(docutils.parser.rst::select-rst-transitions (quote docutils.parser.rst::rfc2822-body))
Associated methods used by all State subclasses.
parent node being processed
reStructuredText’s master StateMachine.
| Initarg | Value |
|---|---|
:initial-state | (quote body) |
:states | *rst-state-classes* |
Top level Document Markup
t
Superclass for second and subsequent compound element members. Compound
elements are lists and list-like constructs.
All transition methods are disabled (redefined as ‘invalid_input‘).
Override individual methods in subclasses to re-enable.
For example, once an initial bullet list item, say, is recognized, the ‘BulletList‘ subclass takes over, with a "bullet_list" node as its container. Upon encountering the initial bullet list item, ‘Body.bullet‘ calls its “self.nested_list_parse“ (‘RSTState.nested_list_parse‘), which starts up a nested parsing session with ‘BulletList‘ as the initial state. Only the “bullet“ transition method is enabled in ‘BulletList‘; as long as only bullet list items are encountered, they are parsed and inserted into the container. The first construct which is *not* a bullet list item triggers the ‘invalid_input‘ method, which ends the nested parse and closes the container. ‘BulletList‘ needs to recognize input that is invalid in the context of a bullet list, which means everything *other than* bullet list items, so it inherits the transition list created in ‘Body‘.
Superclass for second and subsequent lines of Text-variants.
text.
Parser for the contents of a substitution_definition element.
body.
:class
(sb-int:quasiquote ((docutils.parser.rst::embedded-directive (:sequence (:register docutils.parser.rst::simplename) "::" (:alternation (:greedy-repetition 1 nil #\ ) :end-anchor))) (docutils.parser.rst::text (function (lambda (docutils.parser.rst::a) docutils.parser.rst::a)))))
Abstract superclass for the common parts of the syntax-specific parsers.
Block of text to be parser
:block
This slot is read-only.
:separator-pattern
Index of head body separator
This slot is read-only.
Classifier of second line of a text block. Could be a paragraph, a definition list item, or a title.
:class
(sb-int:quasiquote (#s(sb-impl::comma :expr docutils.parser:+wsp-transitions+ :kind 2) (docutils.parser.rst::underline docutils.parser.rst::line docutils.parser.rst::body) (docutils.parser.rst::text #s(sb-impl::comma :expr (function (lambda (docutils.parser.rst::s &key (docutils.parser.rst::start 0) (docutils.parser.rst::end (length docutils.parser.rst::s))) (values docutils.parser.rst::start docutils.parser.rst::end))) :kind 0) docutils.parser.rst::body)))
| Jump to: | (
A B C D E F G H I J K L M N O P Q R S T U V W |
|---|
| Jump to: | (
A B C D E F G H I J K L M N O P Q R S T U V W |
|---|
| Jump to: | *
+
A B C D E F G H I L M N O P R S T |
|---|
| Jump to: | *
+
A B C D E F G H I L M N O P R S T |
|---|
| Jump to: | A B C D E F G H I L M N O P Q R S T U V W |
|---|
| Jump to: | A B C D E F G H I L M N O P Q R S T U V W |
|---|