summaryrefslogtreecommitdiff
path: root/sandbox/codeintro
diff options
context:
space:
mode:
authorjohnmulder <johnmulder@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2007-02-28 22:31:07 +0000
committerjohnmulder <johnmulder@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2007-02-28 22:31:07 +0000
commit43f950bbeb8767ea7f5415d5e437f9164f81fc82 (patch)
treee414a399531d0dc8ccbbe2e043047c1b7f8bcc7c /sandbox/codeintro
parentbcaad9ee80d52538ef28160ab77c2df07822ae19 (diff)
downloaddocutils-43f950bbeb8767ea7f5415d5e437f9164f81fc82.tar.gz
Added writer submodules
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4961 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'sandbox/codeintro')
-rw-r--r--sandbox/codeintro/codeintro.txt57
1 files changed, 44 insertions, 13 deletions
diff --git a/sandbox/codeintro/codeintro.txt b/sandbox/codeintro/codeintro.txt
index d6e8487d6..2d9304fd0 100644
--- a/sandbox/codeintro/codeintro.txt
+++ b/sandbox/codeintro/codeintro.txt
@@ -114,14 +114,14 @@ parsers
-------
This package contains Docutils parser modules.
-:null.py: A module containing a parser which does nothing. This is used
- when transforming from a pickled document tree to any form.
+ :null.py: A module containing a parser which does nothing. This is used
+ when transforming from a pickled document tree to any form.
-:rst: A subpackage containing the parser for reStructuredText. The
- reStructuredText parser is implemented as a state machine, examining
- its input one line at a time. To understand how the parser works,
- please first become familiar with the `docutils.statemachine` module,
- then see the `states` module.
+ :rst: A subpackage containing the parser for reStructuredText. The
+ reStructuredText parser is implemented as a state machine, examining
+ its input one line at a time. To understand how the parser works,
+ please first become familiar with the `docutils.statemachine` module,
+ then see the `states` module.
readers
-------
@@ -146,15 +146,47 @@ to Docutils components. Tree transforms serve a variety of purposes:
transforms may be used to construct (for example) indexes and tables
of contents.
-Each transform is an optional step that a Docutils Reader may choose to
-perform on the parsed document, depending on the input context. A Docutils
-Reader may also perform Reader-specific transforms before or after performing
-these standard transforms.
+Each transform is an optional step that a Docutils Reader may choose
+to perform on the parsed document, depending on the input context. A
+Docutils Reader may also perform Reader-specific transforms before or
+after performing these standard transforms.
writers
-------
This package contains Docutils Writer modules.
+Each writer module or package must export a subclass also called
+'Writer'. Each writer must support all standard node types listed in
+`docutils.nodes.node_class_names`. The `write()` method is the main
+entry point.
+
+In the subpackages, each writer is implemented in the `__init__.py` files.
+
+Subpackages in Writer:
+
+ :html4css1: Simple HyperText Markup Language document tree
+ Writer. The output conforms to the XHTML version
+ 1.0 Transitional DTD (*almost* strict). The output
+ contains a minimum of formatting information. The
+ cascading style sheet "html4css1.css" is required
+ for proper viewing with a modern graphical browser.
+
+ :latex2e: LaTeX2e document tree Writer.
+
+ :newlatex2e: LaTeX2e document tree Writer.
+
+ :pep_html: PEP HTML Writer.
+
+ :s5_html: S5/HTML Slideshow Writer.
+
+Modules in Writer:
+
+ :docutils_xml: Simple internal document tree Writer, writes Docutils XML.
+
+ :null: A do-nothing Writer.
+
+ :pseudoxml: Simple internal document tree Writer, writes indented pseudo-XML.
+
.. |---| unicode:: 8212 .. em-dash
:trim:
@@ -166,5 +198,4 @@ This package contains Docutils Writer modules.
sentence-end-double-space: t
fill-column: 78
End:
-
- \ No newline at end of file
+ \ No newline at end of file