class documentation

class XeLaTeXTranslator(latex2e.LaTeXTranslator):

View In Hierarchy

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 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 length 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​_contents Write the table of contents.
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 between 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 has​_latex​_toc 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 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 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​_citations 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

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):
is_xetex: bool =