docutils.writers.xetex.XeLaTeXTranslator

class documentation

class XeLaTeXTranslator(latex2e.LaTeXTranslator): (source)

Constructor: XeLaTeXTranslator(document)

Generate code for LaTeX using Unicode fonts (XeLaTex or LuaLaTeX).

See the docstring of docutils.writers._html_base.HTMLTranslator for notes on and examples of safe subclassing.

Method	`__init__`	Undocumented
Instance Variable	`is_xetex`	Undocumented

Inherited from LaTeXTranslator:

Method	`append_hypertargets`	Append hypertargets for all ids of `node`
Method	`attval`	Cleanse, encode, and return attribute value text.
Method	`depart_abbreviation`	Undocumented
Method	`depart_acronym`	Undocumented
Method	`depart_address`	Undocumented
Method	`depart_admonition`	Undocumented
Method	`depart_attribution`	Undocumented
Method	`depart_author`	Undocumented
Method	`depart_authors`	Undocumented
Method	`depart_block_quote`	Undocumented
Method	`depart_bullet_list`	Undocumented
Method	`depart_caption`	Undocumented
Method	`depart_citation`	Undocumented
Method	`depart_citation_reference`	Undocumented
Method	`depart_classifier`	Undocumented
Method	`depart_colspec`	Undocumented
Method	`depart_comment`	Undocumented
Method	`depart_compound`	Undocumented
Method	`depart_contact`	Undocumented
Method	`depart_container`	Undocumented
Method	`depart_copyright`	Undocumented
Method	`depart_date`	Undocumented
Method	`depart_decoration`	Undocumented
Method	`depart_definition`	Undocumented
Method	`depart_definition_list`	Undocumented
Method	`depart_definition_list_item`	Undocumented
Method	`depart_description`	Undocumented
Method	`depart_docinfo`	Undocumented
Method	`depart_docinfo_item`	Undocumented
Method	`depart_doctest_block`	Undocumented
Method	`depart_document`	Undocumented
Method	`depart_emphasis`	Undocumented
Method	`depart_entry`	Undocumented
Method	`depart_enumerated_list`	Undocumented
Method	`depart_field`	Undocumented
Method	`depart_field_body`	Undocumented
Method	`depart_field_list`	Undocumented
Method	`depart_field_name`	Undocumented
Method	`depart_figure`	Undocumented
Method	`depart_footer`	Undocumented
Method	`depart_footnote`	Undocumented
Method	`depart_footnote_reference`	Undocumented
Method	`depart_generated`	Undocumented
Method	`depart_header`	Undocumented
Method	`depart_image`	Undocumented
Method	`depart_inline`	Undocumented
Method	`depart_label`	Undocumented
Method	`depart_legend`	Undocumented
Method	`depart_line`	Undocumented
Method	`depart_line_block`	Undocumented
Method	`depart_list_item`	Undocumented
Method	`depart_literal`	Undocumented
Method	`depart_literal_block`	Undocumented
Method	`depart_math`	Undocumented
Method	`depart_math_block`	Undocumented
Method	`depart_meta`	Undocumented
Method	`depart_option`	Undocumented
Method	`depart_option_argument`	Undocumented
Method	`depart_option_group`	Undocumented
Method	`depart_option_list`	Undocumented
Method	`depart_option_list_item`	Undocumented
Method	`depart_option_string`	Undocumented
Method	`depart_organization`	Undocumented
Method	`depart_paragraph`	Undocumented
Method	`depart_problematic`	Undocumented
Method	`depart_raw`	Undocumented
Method	`depart_reference`	Undocumented
Method	`depart_revision`	Undocumented
Method	`depart_row`	Undocumented
Method	`depart_rubric`	Undocumented
Method	`depart_section`	Undocumented
Method	`depart_sidebar`	Undocumented
Method	`depart_status`	Undocumented
Method	`depart_strong`	Undocumented
Method	`depart_subscript`	Undocumented
Method	`depart_subtitle`	Undocumented
Method	`depart_superscript`	Undocumented
Method	`depart_system_message`	Undocumented
Method	`depart_table`	Undocumented
Method	`depart_target`	Undocumented
Method	`depart_tbody`	Undocumented
Method	`depart_term`	Undocumented
Method	`depart_Text`	Undocumented
Method	`depart_tgroup`	Undocumented
Method	`depart_thead`	Undocumented
Method	`depart_title`	Undocumented
Method	`depart_title_reference`	Undocumented
Method	`depart_topic`	Undocumented
Method	`depart_transition`	Undocumented
Method	`depart_version`	Undocumented
Method	`duclass_close`	Close a group of class declarations.
Method	`duclass_open`	Open a group and insert declarations for class values.
Method	`encode`	Return text with 'problematic' characters escaped.
Method	`has_unbalanced_braces`	Test whether there are unmatched '{' or '}' characters.
Method	`ids_to_labels`	Return list of label definitions for all ids of `node`
Method	`insert_additional_table_colum_delimiters`	Undocumented
Method	`insert_align_declaration`	Undocumented
Method	`is_inline`	Check whether a node represents an inline or block-level element
Method	`is_plaintext`	Check whether a node can be typeset verbatim
Method	`label_delim`	Undocumented
Method	`language_label`	Undocumented
Method	`minitoc`	Generate a local table of contents with LaTeX package minitoc
Method	`pop_output_collector`	Undocumented
Method	`push_output_collector`	Undocumented
Method	`set_align_from_classes`	Convert `align-*` class arguments into alignment args.
Method	`stylesheet_call`	Return code to reference or embed stylesheet file `path`
Method	`term_postfix`	Return LaTeX code required between term or field name and content.
Method	`thead_depth`	Undocumented
Method	`to_latex_encoding`	Translate docutils encoding name into LaTeX's.
Method	`to_latex_length`	Convert `length_str` with rst lenght to LaTeX length
Method	`unimplemented_visit`	Undocumented
Method	`visit_abbreviation`	Undocumented
Method	`visit_acronym`	Undocumented
Method	`visit_address`	Undocumented
Method	`visit_admonition`	Undocumented
Method	`visit_attribution`	Undocumented
Method	`visit_author`	Undocumented
Method	`visit_authors`	Undocumented
Method	`visit_block_quote`	Undocumented
Method	`visit_bullet_list`	Undocumented
Method	`visit_caption`	Undocumented
Method	`visit_citation`	Undocumented
Method	`visit_citation_reference`	Undocumented
Method	`visit_classifier`	Undocumented
Method	`visit_colspec`	Undocumented
Method	`visit_comment`	Undocumented
Method	`visit_compound`	Undocumented
Method	`visit_contact`	Undocumented
Method	`visit_container`	Undocumented
Method	`visit_copyright`	Undocumented
Method	`visit_date`	Undocumented
Method	`visit_decoration`	Undocumented
Method	`visit_definition`	Undocumented
Method	`visit_definition_list`	Undocumented
Method	`visit_definition_list_item`	Undocumented
Method	`visit_description`	Undocumented
Method	`visit_docinfo`	Undocumented
Method	`visit_docinfo_item`	Undocumented
Method	`visit_doctest_block`	Undocumented
Method	`visit_document`	Undocumented
Method	`visit_emphasis`	Undocumented
Method	`visit_entry`	Undocumented
Method	`visit_enumerated_list`	Undocumented
Method	`visit_field`	Undocumented
Method	`visit_field_body`	Undocumented
Method	`visit_field_list`	Undocumented
Method	`visit_field_name`	Undocumented
Method	`visit_figure`	Undocumented
Method	`visit_footer`	Undocumented
Method	`visit_footnote`	Undocumented
Method	`visit_footnote_reference`	Undocumented
Method	`visit_generated`	Undocumented
Method	`visit_header`	Undocumented
Method	`visit_image`	Undocumented
Method	`visit_inline`	Undocumented
Method	`visit_label`	footnote or citation label: in brackets or as superscript
Method	`visit_legend`	Undocumented
Method	`visit_line`	Undocumented
Method	`visit_line_block`	Undocumented
Method	`visit_list_item`	Undocumented
Method	`visit_literal`	Undocumented
Method	`visit_literal_block`	Render a literal block.
Method	`visit_math`	math role
Method	`visit_math_block`	Undocumented
Method	`visit_meta`	Undocumented
Method	`visit_option`	Undocumented
Method	`visit_option_argument`	Append the delimiter betweeen an option and its argument to body.
Method	`visit_option_group`	Undocumented
Method	`visit_option_list`	Undocumented
Method	`visit_option_list_item`	Undocumented
Method	`visit_option_string`	Undocumented
Method	`visit_organization`	Undocumented
Method	`visit_paragraph`	Undocumented
Method	`visit_problematic`	Undocumented
Method	`visit_raw`	Undocumented
Method	`visit_reference`	Undocumented
Method	`visit_revision`	Undocumented
Method	`visit_row`	Undocumented
Method	`visit_rubric`	Undocumented
Method	`visit_section`	Undocumented
Method	`visit_sidebar`	Undocumented
Method	`visit_status`	Undocumented
Method	`visit_strong`	Undocumented
Method	`visit_subscript`	Undocumented
Method	`visit_substitution_definition`	Undocumented
Method	`visit_substitution_reference`	Undocumented
Method	`visit_subtitle`	Undocumented
Method	`visit_superscript`	Undocumented
Method	`visit_system_message`	Undocumented
Method	`visit_table`	Undocumented
Method	`visit_target`	Undocumented
Method	`visit_tbody`	Undocumented
Method	`visit_term`	definition list term
Method	`visit_Text`	Undocumented
Method	`visit_tgroup`	Undocumented
Method	`visit_thead`	Undocumented
Method	`visit_title`	Append section and other titles.
Method	`visit_title_reference`	Undocumented
Method	`visit_topic`	Undocumented
Method	`visit_transition`	Undocumented
Method	`visit_version`	Undocumented
Class Variable	`attribution_formats`	Undocumented
Class Variable	`section_level`	Undocumented
Instance Variable	`abstract`	Undocumented
Instance Variable	`active_table`	Undocumented
Instance Variable	`alltt`	Undocumented
Instance Variable	`author_separator`	Undocumented
Instance Variable	`author_stack`	Undocumented
Instance Variable	`babel`	Undocumented
Instance Variable	`bibtex`	Undocumented
Instance Variable	`body`	Undocumented
Instance Variable	`body_pre_docinfo`	Undocumented
Instance Variable	`compound_enumerators`	Undocumented
Instance Variable	`context`	Heterogeneous stack.
Instance Variable	`d_class`	Undocumented
Instance Variable	`date`	Undocumented
Instance Variable	`dedication`	Undocumented
Instance Variable	`docinfo`	Undocumented
Instance Variable	`documentoptions`	Undocumented
Instance Variable	`docutils_footnotes`	Undocumented
Instance Variable	`error`	Undocumented
Instance Variable	`fallback_stylesheet`	Undocumented
Instance Variable	`fallbacks`	Undocumented
Instance Variable	`font_encoding`	Undocumented
Instance Variable	`graphicx_package`	Undocumented
Instance Variable	`has_latex_toc`	Undocumented
Instance Variable	`head_prefix`	Undocumented
Instance Variable	`hyperlink_color`	Undocumented
Instance Variable	`hyperref_options`	Undocumented
Instance Variable	`insert_newline`	Undocumented
Instance Variable	`insert_non_breaking_blanks`	Undocumented
Instance Variable	`inside_citation_reference_label`	Undocumented
Instance Variable	`is_toc_list`	Undocumented
Instance Variable	`language_module`	Undocumented
Instance Variable	`latex_encoding`	Undocumented
Instance Variable	`latex_preamble`	Undocumented
Instance Variable	`literal`	Undocumented
Instance Variable	`literal_block_env`	Undocumented
Instance Variable	`literal_block_options`	Undocumented
Instance Variable	`out`	Undocumented
Instance Variable	`out_stack`	Undocumented
Instance Variable	`pdfauthor`	Undocumented
Instance Variable	`pdfinfo`	Undocumented
Instance Variable	`pdfsetup`	Undocumented
Instance Variable	`requirements`	Undocumented
Instance Variable	`section_enumerator_separator`	Undocumented
Instance Variable	`section_prefix_for_enumerators`	Undocumented
Instance Variable	`settings`	Undocumented
Instance Variable	`stylesheet`	Undocumented
Instance Variable	`subtitle`	Undocumented
Instance Variable	`subtitle_labels`	Undocumented
Instance Variable	`table_stack`	Undocumented
Instance Variable	`title`	Undocumented
Instance Variable	`title_labels`	Undocumented
Instance Variable	`titledata`	Undocumented
Instance Variable	`use_latex_docinfo`	Undocumented
Instance Variable	`use_latex_toc`	Undocumented
Instance Variable	`verbatim`	Undocumented
Instance Variable	`warn`	Undocumented
Class Variable	`_thead_depth`	Undocumented
Instance Variable	`_bibitems`	Undocumented
Instance Variable	`_enumeration_counters`	Undocumented
Instance Variable	`_max_enumeration_counters`	Undocumented
Instance Variable	`_reference_label`	Undocumented
Instance Variable	`_section_number`	Undocumented
Instance Variable	`_use_latex_citations`	Undocumented

Inherited from NodeVisitor (via LaTeXTranslator):

Method	`dispatch_departure`	Call self."`depart_` + node class name" with `node` as parameter. If the `depart_...` method does not exist, call self.unknown_departure.
Method	`dispatch_visit`	Call self."`visit_` + node class name" with `node` as parameter. If the `visit_...` method does not exist, call self.unknown_visit.
Method	`unknown_departure`	Called before exiting unknown `Node` types.
Method	`unknown_visit`	Called when entering unknown `Node` types.
Class Variable	`optional`	Tuple containing node class names (as strings).
Instance Variable	`document`	Undocumented

def __init__(self, document): (source) ¶

overrides docutils.writers.latex2e.LaTeXTranslator.__init__

Undocumented

is_xetex: bool = (source) ¶

overrides docutils.writers.latex2e.LaTeXTranslator.is_xetex

Undocumented