docutils.writers.html5_polyglot.HTMLTranslator

class documentation

class HTMLTranslator(writers._html_base.HTMLTranslator):

View In Hierarchy

This writer generates polyglot markup: HTML5 that is also valid XML.

Safe subclassing: when overriding, treat visit_* and depart_* methods as a unit to prevent breaks due to internal changes. See the docstring of docutils.writers._html_base.HTMLTranslator for details and examples.

Method depart​_acronym Undocumented
Method depart​_authors Undocumented
Method depart​_caption Undocumented
Method depart​_container Undocumented
Method depart​_copyright Undocumented
Method depart​_date Undocumented
Method depart​_document Undocumented
Method depart​_figure Undocumented
Method depart​_footer Undocumented
Method depart​_header Undocumented
Method depart​_image Undocumented
Method depart​_inline Undocumented
Method depart​_legend Undocumented
Method depart​_literal Undocumented
Method depart​_meta Undocumented
Method depart​_organization Undocumented
Method depart​_section Undocumented
Method depart​_sidebar Undocumented
Method depart​_topic Undocumented
Method section​_title​_tags Undocumented
Method visit​_acronym Undocumented
Method visit​_authors Undocumented
Method visit​_caption Undocumented
Method visit​_container Undocumented
Method visit​_copyright Undocumented
Method visit​_date Undocumented
Method visit​_document Undocumented
Method visit​_figure Undocumented
Method visit​_footer Undocumented
Method visit​_header Undocumented
Method visit​_image Undocumented
Method visit​_inline Undocumented
Method visit​_legend Undocumented
Method visit​_literal Undocumented
Method visit​_meta Undocumented
Method visit​_organization Undocumented
Method visit​_section Undocumented
Method visit​_sidebar Undocumented
Method visit​_topic Undocumented
Class Variable supported​_block​_tags Undocumented
Class Variable supported​_inline​_tags Undocumented
Class Variable videotypes Undocumented
Class Variable viewport Undocumented
Instance Variable in​_sidebar Undocumented

Inherited from HTMLTranslator:

Method __init__ Undocumented
Method add​_meta Undocumented
Method astext Undocumented
Method attval Cleanse, HTML encode, and return attribute value text.
Method check​_simple​_list Check for a simple list that can be rendered compactly.
Method cloak​_email Try to hide the link text of a email link from harversters.
Method cloak​_mailto Try to hide a mailto: URL from harvesters.
Method depart​_abbreviation Undocumented
Method depart​_address Undocumented
Method depart​_admonition Undocumented
Method depart​_attribution Undocumented
Method depart​_author Undocumented
Method depart​_block​_quote Undocumented
Method depart​_bullet​_list Undocumented
Method depart​_citation Undocumented
Method depart​_citation​_reference Undocumented
Method depart​_classifier Undocumented
Method depart​_colspec Undocumented
Method depart​_compound Undocumented
Method depart​_contact 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​_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​_footnote Undocumented
Method depart​_footnote​_reference Undocumented
Method depart​_generated Undocumented
Method depart​_label Undocumented
Method depart​_line Undocumented
Method depart​_line​_block Undocumented
Method depart​_list​_item Undocumented
Method depart​_literal​_block Undocumented
Method depart​_math Undocumented
Method depart​_math​_block 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​_paragraph Undocumented
Method depart​_problematic Undocumented
Method depart​_reference Undocumented
Method depart​_revision Undocumented
Method depart​_row Undocumented
Method depart​_rubric 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​_transition Undocumented
Method depart​_version Undocumented
Method emptytag Construct and return an XML-compatible empty tag.
Method encode Encode special characters in text & return.
Method is​_compactable Undocumented
Method set​_class​_on​_child Set class class_ on the visible child no. index of node. Do nothing if node has fewer children than index.
Method starttag Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.
Method stylesheet​_call Return code to reference or embed stylesheet file path
Method unimplemented​_visit Undocumented
Method visit​_abbreviation Undocumented
Method visit​_address Undocumented
Method visit​_admonition Undocumented
Method visit​_attribution Undocumented
Method visit​_author Undocumented
Method visit​_block​_quote Undocumented
Method visit​_bullet​_list Undocumented
Method visit​_citation Undocumented
Method visit​_citation​_reference Undocumented
Method visit​_classifier Undocumented
Method visit​_colspec Undocumented
Method visit​_comment Escape double-dashes in comment text.
Method visit​_compound Undocumented
Method visit​_contact 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​_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​_footnote Undocumented
Method visit​_footnote​_reference Undocumented
Method visit​_generated Undocumented
Method visit​_label Undocumented
Method visit​_line Undocumented
Method visit​_line​_block Undocumented
Method visit​_list​_item Undocumented
Method visit​_literal​_block Undocumented
Method visit​_math Undocumented
Method visit​_math​_block Undocumented
Method visit​_option Undocumented
Method visit​_option​_argument Undocumented
Method visit​_option​_group Undocumented
Method visit​_option​_list Undocumented
Method visit​_option​_list​_item Undocumented
Method visit​_option​_string 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​_status Undocumented
Method visit​_strong Undocumented
Method visit​_subscript Undocumented
Method visit​_substitution​_definition Internal only.
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 Undocumented
Method visit_​Text Undocumented
Method visit​_tgroup Undocumented
Method visit​_thead Undocumented
Method visit​_title Undocumented
Method visit​_title​_reference Undocumented
Method visit​_transition Undocumented
Method visit​_version Undocumented
Class Variable attribution​_formats Undocumented
Class Variable content​_type Undocumented
Class Variable doctype Undocumented
Class Variable embedded​_stylesheet Undocumented
Class Variable generator Undocumented
Class Variable head​_prefix​_template Undocumented
Class Variable in​_word​_wrap​_point Undocumented
Class Variable lang​_attribute Undocumented
Class Variable math​_tags Undocumented
Class Variable mathjax​_script Undocumented
Class Variable special​_characters Character references for characters with a special meaning in HTML.
Class Variable stylesheet​_link Undocumented
Class Variable words​_and​_spaces Undocumented
Class Variable xml​_declaration Undocumented
Instance Variable author​_in​_authors Undocumented
Instance Variable body Undocumented
Instance Variable body​_pre​_docinfo Undocumented
Instance Variable body​_prefix Undocumented
Instance Variable body​_suffix Undocumented
Instance Variable colspecs Undocumented
Instance Variable compact​_field​_list Undocumented
Instance Variable compact​_p Undocumented
Instance Variable compact​_simple Undocumented
Instance Variable context Heterogeneous stack.
Instance Variable docinfo Undocumented
Instance Variable footer Undocumented
Instance Variable fragment Undocumented
Instance Variable head Undocumented
Instance Variable head​_prefix Undocumented
Instance Variable header Undocumented
Instance Variable html​_body Undocumented
Instance Variable html​_head Undocumented
Instance Variable html​_prolog Undocumented
Instance Variable html​_subtitle Undocumented
Instance Variable html​_title Undocumented
Instance Variable image​_loading Undocumented
Instance Variable in​_docinfo Undocumented
Instance Variable in​_document​_title Undocumented
Instance Variable in​_mailto Undocumented
Instance Variable initial​_header​_level Undocumented
Instance Variable language Undocumented
Instance Variable math​_header Undocumented
Instance Variable math​_output Undocumented
Instance Variable math​_output​_options Undocumented
Instance Variable mathjax​_url URL of the MathJax javascript library.
Instance Variable meta Undocumented
Instance Variable section​_level Undocumented
Instance Variable settings Undocumented
Instance Variable stylesheet Undocumented
Instance Variable subtitle Undocumented
Instance Variable title Undocumented

Inherited from NodeVisitor (via HTMLTranslator):

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 depart_acronym(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_acronym

Undocumented

def depart_authors(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_authors

Undocumented

def depart_caption(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_caption

Undocumented

def depart_container(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_container

Undocumented

def depart_copyright(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_copyright

Undocumented

def depart_date(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_date

Undocumented

def depart_document(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_document

Undocumented

def depart_figure(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_figure

Undocumented

def depart_footer(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_footer

Undocumented

def depart_header(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_header

Undocumented

def depart_image(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_image

Undocumented

def depart_inline(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_inline

Undocumented

def depart_legend(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_legend

Undocumented

def depart_literal(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_literal

Undocumented

def depart_meta(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_meta

Undocumented

def depart_organization(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_organization

Undocumented

def depart_section(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_section

Undocumented

def depart_sidebar(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_sidebar

Undocumented

def depart_topic(self, node):
overrides docutils.writers._html_base.HTMLTranslator.depart_topic

Undocumented

def section_title_tags(self, node):
overrides docutils.writers._html_base.HTMLTranslator.section_title_tags

Undocumented

def visit_acronym(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_acronym

Undocumented

def visit_authors(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_authors

Undocumented

def visit_caption(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_caption

Undocumented

def visit_container(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_container

Undocumented

def visit_copyright(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_copyright

Undocumented

def visit_date(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_date

Undocumented

def visit_document(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_document

Undocumented

def visit_figure(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_figure

Undocumented

def visit_footer(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_footer

Undocumented

def visit_header(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_header

Undocumented

def visit_image(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_image

Undocumented

def visit_inline(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_inline

Undocumented

def visit_legend(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_legend

Undocumented

def visit_literal(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_literal

Undocumented

def visit_meta(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_meta

Undocumented

def visit_organization(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_organization

Undocumented

def visit_section(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_section

Undocumented

def visit_sidebar(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_sidebar

Undocumented

def visit_topic(self, node):
overrides docutils.writers._html_base.HTMLTranslator.visit_topic

Undocumented

supported_block_tags =

Undocumented

supported_inline_tags =

Undocumented

videotypes: tuple[str, ...] =

Undocumented

viewport: str =

Undocumented

in_sidebar: bool =
overrides docutils.writers._html_base.HTMLTranslator.in_sidebar

Undocumented