docutils.writers.Writer

Package docutils :: Package writers :: Class Writer |
[show private | hide private]
[frames | no frames]

## Class Writer

     SettingsSpec --+
                    |
    TransformSpec --+
                    |
            Component --+
                        |
                       Writer

Known Subclasses:
  `_DocumentPseudoWriter`

Abstract base class for docutils Writers.

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`.

Call `write()` to process a document.

Method Summary
| ``__init__`(self)` Initialize the Writer instance.
| ``translate`(self)` Override to do final document tree translation.
| `write(self, document, destination)`
Inherited from `Component`: `supports`

Class Variable Summary
`str` | `component_type` = `'writer'`
`NoneType` | `destination` = None
`NoneType` | `document` = None
`NoneType` | `language` = None
Inherited from `Component`: `supported` Inherited from `SettingsSpec`: `relative_path_settings`, `settings_default_overrides`, `settings_defaults`, `settings_spec` Inherited from `TransformSpec`: `default_transforms`

Method Details

### __init__(self) (Constructor) Initialize the Writer instance.

### translate(self) Override to do final document tree translation. This is usually done with a `docutils.nodes.NodeVisitor` subclass, in combination with a call to `docutils.nodes.Node.walk()` or `docutils.nodes.Node.walkabout()`. The `NodeVisitor` subclass must support all standard elements (listed in `docutils.nodes.node_class_names`) and possibly non-standard elements used by the current Reader as well.

Class Variable Details

    ### component_type Type: `str` Value:
        'writer'

    ### destination Type: `NoneType` Value:
        None

    ### document Type: `NoneType` Value:
        None

    ### language Type: `NoneType` Value:
        None

Generated by Epydoc 2.1 on Sat Mar 20 17:46:14 2004 | http://epydoc.sf.net