docutils.writers.odf_odt.Writer Class Reference

Inheritance diagram for docutils.writers.odf_odt.Writer:

Collaboration diagram for docutils.writers.odf_odt.Writer:

Public Member Functions
	__init__ (self)
	translate (self)
	assemble_my_parts (self)
	update_stylesheet (self, stylesheet_root, language_code, region_code)
	write_zip_str (self, zfile, name, bytes, compress_type=zipfile.ZIP_DEFLATED)
	store_embedded_files (self, zfile)
	get_settings (self)
	get_stylesheet (self)
	copy_from_stylesheet (self, outzipfile)
	assemble_parts (self)
	create_manifest (self)
	create_meta (self)
Public Member Functions inherited from docutils.writers.Writer
	get_transforms (self)
	write (self, document, destination)
Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	translator_class
	settings
	visitor
	EXTENSION
	output
	MIME_TYPE
Public Attributes inherited from docutils.writers.Writer
	parts
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
str	MIME_TYPE = 'application/vnd.oasis.opendocument.text'
str	EXTENSION = '.odt'
tuple	supported = ('odt', )
str	default_stylesheet = 'styles' + EXTENSION
	default_stylesheet_path
str	default_template = 'template.txt'
	default_template_path
tuple	settings_spec
dict	settings_defaults
tuple	relative_path_settings = ('odf_config_file', 'stylesheet',)
str	config_section = 'odf_odt writer'
tuple	config_section_dependencies = ('writers',)
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.odf_odt.Writer.__init__

(

self

)

Reimplemented from docutils.writers.Writer.

Member Function Documentation

assemble_my_parts()

docutils.writers.odf_odt.Writer.assemble_my_parts

(

self

)

Assemble the `self.parts` dictionary.  Extend in subclasses.

assemble_parts()

docutils.writers.odf_odt.Writer.assemble_parts

(

self

)

Assemble the `self.parts` dictionary.  Extend in subclasses.

See <https://docutils.sourceforge.io/docs/api/publisher.html>.

Reimplemented from docutils.writers.Writer.

copy_from_stylesheet()

docutils.writers.odf_odt.Writer.copy_from_stylesheet	(		self,
			outzipfile
	)

Copy images, settings, etc from the stylesheet doc into target doc.

get_settings()

docutils.writers.odf_odt.Writer.get_settings

(

self

)

modeled after get_stylesheet

get_stylesheet()

docutils.writers.odf_odt.Writer.get_stylesheet

(

self

)

Get the stylesheet from the visitor.
Ask the visitor to setup the page.

translate()

docutils.writers.odf_odt.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.

update_stylesheet()

docutils.writers.odf_odt.Writer.update_stylesheet	(		self,
			stylesheet_root,
			language_code,
			region_code
	)

Update xml style sheet element with language and region/country.

Member Data Documentation

default_stylesheet_path

docutils.writers.odf_odt.Writer.default_stylesheet_path

static

Initial value:

=  utils.relative_path(
        os.path.join(os.getcwd(), 'dummy'),
        os.path.join(os.path.dirname(__file__), default_stylesheet))

default_template_path

docutils.writers.odf_odt.Writer.default_template_path

static

Initial value:

=  utils.relative_path(
        os.path.join(os.getcwd(), 'dummy'),
        os.path.join(os.path.dirname(__file__), default_template))

settings_defaults

dict docutils.writers.odf_odt.Writer.settings_defaults

static

Initial value:

=  {
        'output_encoding_error_handler': 'xmlcharrefreplace',
    }

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/writers/odf_odt/__init__.py