transport_data.util.docutils.ODFTranslator

class transport_data.util.docutils.ODFTranslator(document)[source]

Bases: ODFTranslator

Translator from docutils DOM to OpenDocumentText

This subclass works around bugs and missing figures in the upstream class.

  • Tolerate a file path with “.xml” for the “stylesheet” setting.

  • Fix internal hyperlinks:

    • Write internal hyperlink targets as <text:bookmark> instead of <text:reference-mark>.

    • Write hyperlinks to internal targets as <text:a> instead of <text:reference-ref>. The latter does not allow to specify the text content of the reference. In this class, the reference text is as given in the docutils DOM source.

__init__(document) → None

Methods

__init__(document)

add_doc_title()

add_header_footer(root_el)

append_child(tag[, attrib, parent])

append_p(style[, text])

append_pending_ids(el)

astext()

attach_page_style(el)

Attach the default page style.

check_file_exists(path)

content_astext()

convert_to_cm(size)

Convert various units to centimeters.

create_custom_headfoot(parent, text, ...)

default_departure(node)

Override for generic, uniform traversals.

default_visit(node)

Override for generic, uniform traversals.

depart_Text(node)

depart_abbreviation(node)

depart_acks(node)

depart_acronym(node)

depart_address(node)

depart_admonition(node)

depart_attention(node)

depart_attribution(node)

depart_author(node)

depart_authors(node)

depart_autosummary_table(node)

depart_autosummary_toc(node)

depart_block_quote(node)

depart_bullet_list(node)

depart_caption(node)

depart_caution(node)

depart_centered(node)

depart_citation(node)

depart_citation_reference(node)

depart_classifier(node)

depart_colspec(node)

depart_comment(node)

depart_compact_paragraph(node)

depart_compound(node)

depart_contact(node)

depart_container(node)

depart_copyright(node)

depart_danger(node)

depart_date(node)

depart_decoration(node)

depart_definition(node)

depart_definition_list(node)

depart_definition_list_item(node)

depart_desc(node)

depart_desc_addname(node)

depart_desc_annotation(node)

depart_desc_content(node)

depart_desc_inline(node)

depart_desc_name(node)

depart_desc_optional(node)

depart_desc_parameter(node)

depart_desc_parameterlist(node)

depart_desc_returns(node)

depart_desc_sig_keyword(node)

depart_desc_sig_keyword_type(node)

depart_desc_sig_literal_char(node)

depart_desc_sig_literal_number(node)

depart_desc_sig_literal_string(node)

depart_desc_sig_name(node)

depart_desc_sig_operator(node)

depart_desc_sig_punctuation(node)

depart_desc_sig_space(node)

depart_desc_signature(node)

depart_desc_signature_line(node)

depart_desc_type(node)

depart_desc_type_parameter(node)

depart_desc_type_parameter_list(node)

depart_description(node)

depart_docinfo(node)

depart_doctest_block(node)

depart_document(node)

depart_download_reference(node)

depart_emphasis(node)

depart_entry(node)

depart_enumerated_list(node)

depart_error(node)

depart_field(node)

depart_field_body(node)

depart_field_list(node)

depart_field_name(node)

depart_figure(node)

depart_footer(node)

depart_footnote(node)

depart_footnote_reference(node)

depart_generated(node)

depart_glossary(node)

depart_header(node)

depart_highlightlang(node)

depart_hint(node)

depart_hlist(node)

depart_hlistcol(node)

depart_image(node)

depart_important(node)

depart_index(node)

depart_inline(node)

depart_label(node)

depart_legend(node)

depart_line(node)

depart_line_block(node)

depart_list_item(node)

depart_literal(node)

depart_literal_block(node)

depart_literal_emphasis(node)

depart_literal_strong(node)

depart_manpage(node)

depart_math(node)

depart_math_block(node)

depart_meta(node)

depart_note(node)

depart_number_reference(node)

depart_only(node)

depart_option(node)

depart_option_argument(node)

depart_option_group(node)

depart_option_list(node)

depart_option_list_item(node)

depart_option_string(node)

depart_organization(node)

depart_paragraph(node)

depart_pending(node)

depart_pending_xref(node)

depart_problematic(node)

depart_production(node)

depart_productionlist(node)

depart_raw(node)

depart_reference(node)

depart_revision(node)

depart_row(node)

depart_rubric(node)

depart_section(node)

depart_seealso(node)

depart_sidebar(node)

depart_start_of_file(node)

depart_status(node)

depart_strong(node)

depart_subscript(node)

depart_substitution_definition(node)

depart_substitution_reference(node)

depart_subtitle(node)

depart_superscript(node)

depart_system_message(node)

depart_table(node)

depart_tabular_col_spec(node)

depart_target(node)

depart_tbody(node)

depart_term(node)

depart_tgroup(node)

depart_thead(node)

depart_tip(node)

depart_title(node)

depart_title_reference(node)

depart_toctree(node)

depart_todo_node(node)

depart_todolist(node)

depart_topic(node)

depart_transition(node)

depart_version(node)

depart_versionmodified(node)

depart_warning(node)

dispatch_departure(node)

Call self."depart_ + node class name" with node as parameter.

dispatch_visit(node)

Override to catch basic attributes which many nodes have.

encode(text)

extract_table_styles(styles_str)

fill_func1(matchobj)

fill_func2(matchobj)

fill_line(line)

find_first_text_p(el)

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

find_title_label(node, class_type, label_key)

generate_admonition(node, label[, title])

generate_content_element(root)

generate_figure(node, source, destination, ...)

generate_image(node, source, destination, ...)

generate_labeled_block(node, label)

generate_labeled_line(node, label)

generate_table_of_content_entry_template(el1)

get_dom_stylesheet()

get_embedded_file_list()

get_image_scale(node)

get_image_scaled_width_height(node, source)

Return the image size in centimeters adjusted by image attrs.

get_image_width_height(node, attr)

get_meta_dict()

get_page_width()

Return the document's page width in centimeters.

get_property(stylenode)

get_str_stylesheet()

get_table_style(node)

get_title()

handle_basic_atts(node)

is_in_table(node)

make_field_element(parent, text, style_name, ...)

process_footnotes()

retrieve_styles(extension)

Retrieve the stylesheet a file with extension either ".xml" or extension.

rststyle(name[, parameters])

Returns the style name to use for the given style.

set_current_element(el)

set_embedded_file_list(embedded_file_list)

set_title(title)

set_to_parent()

setup_page()

setup_paper(root_el)

split_field_specifiers_iter(text)

unknown_departure(node)

Called before exiting unknown Node types.

unknown_visit(node)

Called when entering unknown Node types.

update_toc_add_numbers(collection)

update_toc_collect(el, level, collection)

update_toc_page_numbers(el)

visit_Text(node)

visit_abbreviation(node)

visit_acks(node)

visit_acronym(node)

visit_address(node)

visit_admonition(node)

visit_attention(node)

visit_attribution(node)

visit_author(node)

visit_authors(node)

visit_autosummary_table(node)

visit_autosummary_toc(node)

visit_block_quote(node)

visit_bullet_list(node)

visit_caption(node)

visit_caution(node)

visit_centered(node)

visit_citation(node)

visit_citation_reference(node)

visit_classifier(node)

visit_colspec(node)

visit_comment(node)

visit_compact_paragraph(node)

visit_compound(node)

visit_contact(node)

visit_container(node)

visit_copyright(node)

visit_danger(node)

visit_date(node)

visit_decoration(node)

visit_definition(node)

visit_definition_list(node)

visit_definition_list_item(node)

visit_desc(node)

visit_desc_addname(node)

visit_desc_annotation(node)

visit_desc_content(node)

visit_desc_inline(node)

visit_desc_name(node)

visit_desc_optional(node)

visit_desc_parameter(node)

visit_desc_parameterlist(node)

visit_desc_returns(node)

visit_desc_sig_keyword(node)

visit_desc_sig_keyword_type(node)

visit_desc_sig_literal_char(node)

visit_desc_sig_literal_number(node)

visit_desc_sig_literal_string(node)

visit_desc_sig_name(node)

visit_desc_sig_operator(node)

visit_desc_sig_punctuation(node)

visit_desc_sig_space(node)

visit_desc_signature(node)

visit_desc_signature_line(node)

visit_desc_type(node)

visit_desc_type_parameter(node)

visit_desc_type_parameter_list(node)

visit_description(node)

visit_docinfo(node)

visit_doctest_block(node)

visit_document(node)

visit_download_reference(node)

visit_emphasis(node)

visit_entry(node)

visit_enumerated_list(node)

visit_error(node)

visit_field(node)

visit_field_body(node)

visit_field_list(node)

visit_field_name(node)

visit_figure(node)

visit_footer(node)

visit_footnote(node)

visit_footnote_reference(node)

visit_generated(node)

visit_glossary(node)

visit_header(node)

visit_highlightlang(node)

visit_hint(node)

visit_hlist(node)

visit_hlistcol(node)

visit_image(node)

visit_important(node)

visit_index(node)

visit_inline(node)

visit_label(node)

visit_legend(node)

visit_line(node)

visit_line_block(node)

visit_list_item(node)

visit_literal(node)

visit_literal_block(node)

visit_literal_emphasis(node)

visit_literal_strong(node)

visit_manpage(node)

visit_math(node)

visit_math_block(node)

visit_meta(node)

visit_note(node)

visit_number_reference(node)

visit_only(node)

visit_option(node)

visit_option_argument(node)

visit_option_group(node)

visit_option_list(node)

visit_option_list_item(node)

visit_option_string(node)

visit_organization(node)

visit_paragraph(node)

visit_pending(node)

visit_pending_xref(node)

visit_problematic(node)

visit_production(node)

visit_productionlist(node)

visit_raw(node)

visit_reference(node)

visit_revision(node)

visit_row(node)

visit_rubric(node)

visit_section(node[, move_ids])

visit_seealso(node)

visit_sidebar(node)

visit_start_of_file(node)

visit_status(node)

visit_strong(node)

visit_subscript(node)

visit_substitution_definition(node)

visit_substitution_reference(node)

visit_subtitle(node[, move_ids])

visit_superscript(node)

visit_system_message(node)

visit_table(node)

visit_tabular_col_spec(node)

visit_target(node)

visit_tbody(node)

visit_term(node)

visit_tgroup(node)

visit_thead(node)

visit_tip(node)

visit_title(node[, move_ids, title_type])

visit_title_reference(node)

visit_toctree(node)

visit_todo_node(node)

visit_todolist(node)

visit_topic(node)

visit_transition(node)

visit_version(node)

visit_versionmodified(node)

visit_warning(node)

Attributes

code_field

code_none

code_text

field_pat

footnote_chars

optional

Tuple containing node class names (as strings).

used_styles

pending_ids

attach_page_style(el) → None

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(size)

Convert various units to centimeters.

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

try: except ValueError:

default_departure(node) → None

Override for generic, uniform traversals.

default_visit(node) → None

Override for generic, uniform traversals.

dispatch_departure(node) → None

Call self.”depart_ + node class name” with node as parameter. If the depart_... method does not exist, call self.unknown_departure.

dispatch_visit(node) → None

Override to catch basic attributes which many nodes have.

find_first_text_p(el)

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

get_image_scaled_width_height(node, source)

Return the image size in centimeters adjusted by image attrs.

get_page_width()

Return the document’s page width in centimeters.

optional = ('meta',)

Tuple containing node class names (as strings).

No exception will be raised if writers do not implement visit or departure functions for these node classes.

Used to ensure transitional compatibility with existing 3rd-party writers.

retrieve_styles(extension: str) → None

Retrieve the stylesheet a file with extension either “.xml” or extension.

Returns nothing.

rststyle(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.

unknown_departure(node) → None

Called before exiting unknown Node types.

Raise exception unless overridden.

unknown_visit(node) → None

Called when entering unknown Node types.

Raise an exception unless overridden.