docutils.writers.odf_odt.ODFTranslator Class Reference

Inheritance diagram for docutils.writers.odf_odt.ODFTranslator:

Collaboration diagram for docutils.writers.odf_odt.ODFTranslator:

Public Member Functions
	__init__ (self, document)
	get_str_stylesheet (self)
	retrieve_styles (self, extension)
	extract_table_styles (self, styles_str)
	get_property (self, stylenode)
	add_doc_title (self)
	find_first_text_p (self, el)
	attach_page_style (self, el)
	rststyle (self, name, parameters=())
	generate_content_element (self, root)
	setup_page (self)
	get_dom_stylesheet (self)
	setup_paper (self, root_el)
	add_header_footer (self, root_el)
	create_custom_headfoot (self, parent, text, style_name, automatic_styles)
	make_field_element (self, parent, text, style_name, automatic_styles)
	split_field_specifiers_iter (self, text)
	astext (self)
	content_astext (self)
	set_title (self, title)
	get_title (self)
	set_embedded_file_list (self, embedded_file_list)
	get_embedded_file_list (self)
	get_meta_dict (self)
	process_footnotes (self)
	append_child (self, tag, attrib=None, parent=None)
	append_p (self, style, text=None)
	append_pending_ids (self, el)
	set_current_element (self, el)
	set_to_parent (self)
	generate_labeled_block (self, node, label)
	generate_labeled_line (self, node, label)
	encode (self, text)
	dispatch_visit (self, node)
	handle_basic_atts (self, node)
	default_visit (self, node)
	default_departure (self, node)
	visit_Text (self, node)
	depart_Text (self, node)
	visit_address (self, node)
	depart_address (self, node)
	visit_author (self, node)
	depart_author (self, node)
	visit_authors (self, node)
	depart_authors (self, node)
	visit_contact (self, node)
	depart_contact (self, node)
	visit_copyright (self, node)
	depart_copyright (self, node)
	visit_date (self, node)
	depart_date (self, node)
	visit_organization (self, node)
	depart_organization (self, node)
	visit_status (self, node)
	depart_status (self, node)
	visit_revision (self, node)
	depart_revision (self, node)
	visit_version (self, node)
	depart_version (self, node)
	visit_attribution (self, node)
	depart_attribution (self, node)
	visit_block_quote (self, node)
	depart_block_quote (self, node)
	visit_bullet_list (self, node)
	depart_bullet_list (self, node)
	visit_caption (self, node)
	depart_caption (self, node)
	visit_comment (self, node)
	depart_comment (self, node)
	visit_compound (self, node)
	depart_compound (self, node)
	visit_container (self, node)
	depart_container (self, node)
	visit_decoration (self, node)
	depart_decoration (self, node)
	visit_definition_list (self, node)
	depart_definition_list (self, node)
	visit_definition_list_item (self, node)
	depart_definition_list_item (self, node)
	visit_term (self, node)
	depart_term (self, node)
	visit_definition (self, node)
	depart_definition (self, node)
	visit_classifier (self, node)
	depart_classifier (self, node)
	visit_document (self, node)
	depart_document (self, node)
	visit_docinfo (self, node)
	depart_docinfo (self, node)
	visit_emphasis (self, node)
	depart_emphasis (self, node)
	visit_enumerated_list (self, node)
	depart_enumerated_list (self, node)
	visit_list_item (self, node)
	depart_list_item (self, node)
	visit_header (self, node)
	depart_header (self, node)
	visit_footer (self, node)
	depart_footer (self, node)
	visit_field (self, node)
	depart_field (self, node)
	visit_field_list (self, node)
	depart_field_list (self, node)
	visit_field_name (self, node)
	depart_field_name (self, node)
	visit_field_body (self, node)
	depart_field_body (self, node)
	visit_figure (self, node)
	depart_figure (self, node)
	visit_footnote (self, node)
	depart_footnote (self, node)
	visit_footnote_reference (self, node)
	depart_footnote_reference (self, node)
	visit_citation (self, node)
	depart_citation (self, node)
	visit_citation_reference (self, node)
	depart_citation_reference (self, node)
	visit_label (self, node)
	depart_label (self, node)
	visit_generated (self, node)
	depart_generated (self, node)
	check_file_exists (self, path)
	visit_image (self, node)
	depart_image (self, node)
	get_image_width_height (self, node, attr)
	convert_to_cm (self, size)
	get_image_scale (self, node)
	get_image_scaled_width_height (self, node, source)
	get_page_width (self)
	generate_figure (self, node, source, destination, current_element)
	generate_image (self, node, source, destination, current_element, frame_attrs=None)
	is_in_table (self, node)
	visit_legend (self, node)
	depart_legend (self, node)
	visit_line_block (self, node)
	depart_line_block (self, node)
	visit_line (self, node)
	depart_line (self, node)
	visit_literal (self, node)
	depart_literal (self, node)
	visit_inline (self, node)
	depart_inline (self, node)
	fill_line (self, line)
	fill_func1 (self, matchobj)
	fill_func2 (self, matchobj)
	visit_literal_block (self, node)
	depart_literal_block (self, node)
	visit_math (self, node)
	depart_math (self, node)
	visit_math_block (self, node)
	depart_math_block (self, node)
	visit_meta (self, node)
	depart_meta (self, node)
	visit_option_list (self, node)
	depart_option_list (self, node)
	visit_option_list_item (self, node)
	depart_option_list_item (self, node)
	visit_option_group (self, node)
	depart_option_group (self, node)
	visit_option (self, node)
	depart_option (self, node)
	visit_option_string (self, node)
	depart_option_string (self, node)
	visit_option_argument (self, node)
	depart_option_argument (self, node)
	visit_description (self, node)
	depart_description (self, node)
	visit_paragraph (self, node)
	depart_paragraph (self, node)
	visit_problematic (self, node)
	depart_problematic (self, node)
	visit_raw (self, node)
	depart_raw (self, node)
	visit_reference (self, node)
	depart_reference (self, node)
	visit_rubric (self, node)
	depart_rubric (self, node)
	visit_section (self, node, move_ids=1)
	depart_section (self, node)
	visit_strong (self, node)
	depart_strong (self, node)
	visit_substitution_definition (self, node)
	depart_substitution_definition (self, node)
	visit_system_message (self, node)
	depart_system_message (self, node)
	get_table_style (self, node)
	visit_table (self, node)
	depart_table (self, node)
	visit_tgroup (self, node)
	depart_tgroup (self, node)
	visit_colspec (self, node)
	depart_colspec (self, node)
	visit_thead (self, node)
	depart_thead (self, node)
	visit_row (self, node)
	depart_row (self, node)
	visit_entry (self, node)
	depart_entry (self, node)
	visit_tbody (self, node)
	depart_tbody (self, node)
	visit_target (self, node)
	depart_target (self, node)
	visit_title (self, node, move_ids=1, title_type='title')
	depart_title (self, node)
	visit_subtitle (self, node, move_ids=1)
	depart_subtitle (self, node)
	visit_title_reference (self, node)
	depart_title_reference (self, node)
	generate_table_of_content_entry_template (self, el1)
	find_title_label (self, node, class_type, label_key)
	visit_topic (self, node)
	depart_topic (self, node)
	update_toc_page_numbers (self, el)
	update_toc_collect (self, el, level, collection)
	update_toc_add_numbers (self, collection)
	visit_transition (self, node)
	depart_transition (self, node)
	visit_warning (self, node)
	depart_warning (self, node)
	visit_attention (self, node)
	visit_caution (self, node)
	visit_danger (self, node)
	visit_error (self, node)
	visit_hint (self, node)
	visit_important (self, node)
	visit_note (self, node)
	visit_tip (self, node)
	visit_admonition (self, node)
	generate_admonition (self, node, label, title=None)
	visit_subscript (self, node)
	depart_subscript (self, node)
	visit_superscript (self, node)
	depart_superscript (self, node)
	visit_abbreviation (self, node)
	depart_abbreviation (self, node)
	visit_acronym (self, node)
	depart_acronym (self, node)
	visit_sidebar (self, node)
	depart_sidebar (self, node)
Public Member Functions inherited from docutils.nodes.NodeVisitor
	dispatch_departure (self, node)
	unknown_visit (self, node)
	unknown_departure (self, node)

Public Attributes
	settings
	language_code
	language
	format_map
	section_level
	section_count
	content_tree
	current_element
	automatic_styles
	body_text_element
	paragraph_style_stack
	list_style_stack
	table_count
	column_count
	trace_level
	optiontablestyles_generated
	field_name
	field_element
	title
	image_count
	image_style_count
	image_dict
	embedded_file_list
	syntaxhighlighting
	syntaxhighlight_lexer
	header_content
	footer_content
	in_header
	in_footer
	blockstyle
	in_table_of_contents
	table_of_content_index_body
	list_level
	def_list_level
	footnote_ref_dict
	footnote_list
	footnote_chars_idx
	footnote_level
	pending_ids
	in_paragraph
	found_doc_title
	bumped_list_level_stack
	meta_dict
	line_block_level
	line_indent_level
	citation_id
	style_index
	str_stylesheet
	str_stylesheetcontent
	dom_stylesheet
	table_styles
	in_citation
	inline_style_count_stack
	dom_stylesheetcontent
	save_footnote_current
	fill_func2
	current_table_style
	table_width
	in_thead
	save_current_element
Public Attributes inherited from docutils.nodes.NodeVisitor
	document
	optional

Static Public Attributes
tuple	used_styles
	code_none
	code_field
	code_text
	field_pat = re.compile(r'%(..?)%')
list	footnote_chars
	visit_doctest_block = visit_literal_block
	depart_doctest_block = depart_literal_block
	depart_attention = depart_warning
	depart_caution = depart_warning
	depart_danger = depart_warning
	depart_error = depart_warning
	depart_hint = depart_warning
	depart_important = depart_warning
	depart_note = depart_warning
	depart_tip = depart_warning
	depart_admonition = depart_warning
Static Public Attributes inherited from docutils.nodes.NodeVisitor
tuple	optional = ('meta',)

Protected Member Functions
	_calculate_code_block_padding (self, line)
	_add_syntax_highlighting (self, insource, language)

Constructor & Destructor Documentation

__init__()

docutils.writers.odf_odt.ODFTranslator.__init__	(		self,
			document
	)

Reimplemented from docutils.nodes.NodeVisitor.

Member Function Documentation

attach_page_style()

docutils.writers.odf_odt.ODFTranslator.attach_page_style	(		self,
			el
	)

Attach the default page style.

Create an automatic-style that refers to the current style
of this element and that refers to the default page style.

convert_to_cm()

docutils.writers.odf_odt.ODFTranslator.convert_to_cm	(		self,
			size
	)

Convert various units to centimeters.

Note that a call to this method should be wrapped in:
    try: except ValueError:

default_departure()

docutils.writers.odf_odt.ODFTranslator.default_departure	(		self,
			node
	)

Override for generic, uniform traversals.

Reimplemented from docutils.nodes.GenericNodeVisitor.

default_visit()

docutils.writers.odf_odt.ODFTranslator.default_visit	(		self,
			node
	)

Override for generic, uniform traversals.

Reimplemented from docutils.nodes.GenericNodeVisitor.

dispatch_visit()

docutils.writers.odf_odt.ODFTranslator.dispatch_visit	(		self,
			node
	)

Override to catch basic attributes which many nodes have.

Reimplemented from docutils.nodes.NodeVisitor.

find_first_text_p()

docutils.writers.odf_odt.ODFTranslator.find_first_text_p	(		self,
			el
	)

Search the generated doc and return the first <text:p> element.

get_image_scaled_width_height()

docutils.writers.odf_odt.ODFTranslator.get_image_scaled_width_height	(		self,
			node,
			source
	)

Return the image size in centimeters adjusted by image attrs.

get_page_width()

docutils.writers.odf_odt.ODFTranslator.get_page_width

(

self

)

Return the document's page width in centimeters.

retrieve_styles()

docutils.writers.odf_odt.ODFTranslator.retrieve_styles	(		self,
			extension
	)

Retrieve the stylesheet from either a .xml file or from
a .odt (zip) file.  Return the content as a string.

rststyle()

docutils.writers.odf_odt.ODFTranslator.rststyle	(		self,
			name,
			parameters = ()
	)

Returns the style name to use for the given style.

If `parameters` is given `name` must contain a matching number of
``%`` and is used as a format expression with `parameters` as
the value.

Member Data Documentation

footnote_chars

list docutils.writers.odf_odt.ODFTranslator.footnote_chars

static

Initial value:

=  [
        '*', '**', '***',
        '++', '+++',
        '##', '###',
        '@@', '@@@',
    ]

---

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