Inheritance diagram for docutils.writers.docutils_xml.Writer:

Collaboration diagram for docutils.writers.docutils_xml.Writer:

Public Member Functions
	__init__ (self)

	translate (self)

Public Member Functions inherited from docutils.writers.Writer
	get_transforms (self)

	write (self, document, destination)

	assemble_parts (self)

Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	translator_class

	visitor

Public Attributes inherited from docutils.writers.Writer
	parts

Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
tuple	supported = ('xml',)

tuple	settings_spec

dict	settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'}

str	config_section = 'docutils_xml writer'

tuple	config_section_dependencies = ('writers',)

	output = None

Static Public Attributes inherited from docutils.writers.Writer
str	component_type = 'writer'

str	config_section = 'writers'

	document = None

	output = None

	language = None

	destination = None

Static Public Attributes inherited from docutils.Component
	component_type = None

tuple	supported = ()

Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()

	settings_defaults = None

	settings_default_overrides = None

tuple	relative_path_settings = ()

	config_section = None

	config_section_dependencies = None

Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()

tuple	unknown_reference_resolvers = ()

Constructor & Destructor Documentation

◆ init()

docutils.writers.docutils_xml.Writer.__init__ ( self )

Reimplemented from docutils.writers.Writer.

Member Function Documentation

◆ translate()

docutils.writers.docutils_xml.Writer.translate ( self )

Do final translation of `self.document` into `self.output`.  Called
from `write`.  Override in subclasses.

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.

Reimplemented from docutils.writers.Writer.

Member Data Documentation

◆ settings_spec

tuple docutils.writers.docutils_xml.Writer.settings_spec

static

Initial value:

=  (
        '"Docutils XML" Writer Options',
        None,
        (('Generate XML with newlines before and after tags.',
          ['--newlines'],
          {'action': 'store_true', 'validator': frontend.validate_boolean}),
         ('Generate XML with indents and newlines.',
          ['--indents'],  # TODO use integer value for number of spaces?
          {'action': 'store_true', 'validator': frontend.validate_boolean}),
         ('Omit the XML declaration.  Use with caution.',
          ['--no-xml-declaration'],
          {'dest': 'xml_declaration', 'default': 1, 'action': 'store_false',
           'validator': frontend.validate_boolean}),
         ('Omit the DOCTYPE declaration.',
          ['--no-doctype'],
          {'dest': 'doctype_declaration', 'default': 1,
           'action': 'store_false', 'validator': frontend.validate_boolean}),))

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/docutils/writers/docutils_xml.py

Public Member Functions

Public Attributes