Inheritance diagram for docutils.writers._html_base.HTMLTranslator:

Collaboration diagram for docutils.writers._html_base.HTMLTranslator:

Public Member Functions
	__init__ (self, document)

	astext (self)

	attval (self, text, whitespace=re.compile('[\n\r\t\v\f]'))

	cloak_email (self, addr)

	cloak_mailto (self, uri)

	encode (self, text)

	image_size (self, node)

	prepare_svg (self, node, imagedata, size_declaration)

	stylesheet_call (self, path, adjust_path=None)

	starttag (self, node, tagname, suffix='\n', empty=False, **attributes)

	emptytag (self, node, tagname, suffix='\n', **attributes)

	report_messages (self, node)

	set_class_on_child (self, node, class_, index=0)

	uri2imagepath (self, uri)

	visit_Text (self, node)

	depart_Text (self, node)

	visit_abbreviation (self, node)

	depart_abbreviation (self, node)

	visit_acronym (self, node)

	depart_acronym (self, node)

	visit_address (self, node)

	depart_address (self, node)

	visit_admonition (self, node)

	depart_admonition (self, node=None)

	visit_attribution (self, node)

	depart_attribution (self, node)

	visit_author (self, node)

	depart_author (self, node)

	visit_authors (self, node)

	depart_authors (self, node)

	visit_block_quote (self, node)

	depart_block_quote (self, node)

	check_simple_list (self, node)

	is_compactable (self, node)

	visit_bullet_list (self, node)

	depart_bullet_list (self, node)

	visit_caption (self, node)

	depart_caption (self, node)

	visit_citation (self, node)

	depart_citation (self, node)

	visit_citation_reference (self, node)

	depart_citation_reference (self, node)

	visit_classifier (self, node)

	depart_classifier (self, node)

	visit_colspec (self, node)

	depart_colspec (self, node)

	visit_comment (self, node, sub=re.compile('-(?=-)').sub)

	visit_compound (self, node)

	depart_compound (self, node)

	visit_container (self, node)

	depart_container (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_decoration (self, node)

	depart_decoration (self, node)

	visit_definition (self, node)

	depart_definition (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_description (self, node)

	depart_description (self, node)

	visit_docinfo (self, node)

	depart_docinfo (self, node)

	visit_docinfo_item (self, node, name, meta=True)

	depart_docinfo_item (self)

	visit_doctest_block (self, node)

	depart_doctest_block (self, node)

	visit_document (self, node)

	depart_document (self, node)

	visit_emphasis (self, node)

	depart_emphasis (self, node)

	visit_entry (self, node)

	depart_entry (self, node)

	visit_enumerated_list (self, node)

	depart_enumerated_list (self, node)

	visit_field_list (self, node)

	depart_field_list (self, node)

	visit_field (self, node)

	depart_field (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_footer (self, node)

	depart_footer (self, node)

	visit_footnote (self, node)

	depart_footnote (self, node)

	visit_footnote_reference (self, node)

	depart_footnote_reference (self, node)

	visit_generated (self, node)

	depart_generated (self, node)

	visit_header (self, node)

	depart_header (self, node)

	visit_image (self, node)

	depart_image (self, node)

	visit_inline (self, node)

	depart_inline (self, node)

	visit_label (self, node)

	depart_label (self, node)

	visit_legend (self, node)

	depart_legend (self, node)

	visit_line (self, node)

	depart_line (self, node)

	visit_line_block (self, node)

	depart_line_block (self, node)

	visit_list_item (self, node)

	depart_list_item (self, node)

	visit_literal (self, node)

	depart_literal (self, node)

	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 (self, node)

	depart_option (self, node)

	visit_option_argument (self, node)

	depart_option_argument (self, node)

	visit_option_group (self, node)

	depart_option_group (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_string (self, node)

	depart_option_string (self, node)

	visit_organization (self, node)

	depart_organization (self, node)

	visit_paragraph (self, node)

	depart_paragraph (self, node)

	visit_problematic (self, node)

	depart_problematic (self, node)

	visit_raw (self, node)

	visit_reference (self, node)

	depart_reference (self, node)

	visit_revision (self, node)

	depart_revision (self, node)

	visit_row (self, node)

	depart_row (self, node)

	visit_rubric (self, node)

	depart_rubric (self, node)

	visit_section (self, node)

	depart_section (self, node)

	visit_sidebar (self, node)

	depart_sidebar (self, node)

	visit_status (self, node)

	depart_status (self, node)

	visit_strong (self, node)

	depart_strong (self, node)

	visit_subscript (self, node)

	depart_subscript (self, node)

	visit_substitution_definition (self, node)

	visit_substitution_reference (self, node)

	visit_subtitle (self, node)

	depart_subtitle (self, node)

	visit_superscript (self, node)

	depart_superscript (self, node)

	visit_system_message (self, node)

	depart_system_message (self, node)

	visit_table (self, node)

	depart_table (self, node)

	visit_target (self, node)

	depart_target (self, node)

	visit_tbody (self, node)

	depart_tbody (self, node)

	visit_term (self, node)

	depart_term (self, node)

	visit_tgroup (self, node)

	depart_tgroup (self, node)

	visit_thead (self, node)

	depart_thead (self, node)

	section_title_tags (self, node)

	visit_title (self, node)

	depart_title (self, node)

	visit_title_reference (self, node)

	depart_title_reference (self, node)

	visit_topic (self, node)

	depart_topic (self, node)

	visit_transition (self, node)

	depart_transition (self, node)

	visit_version (self, node)

	depart_version (self, node)

	unimplemented_visit (self, node)

Public Member Functions inherited from docutils.nodes.NodeVisitor
	dispatch_visit (self, node)

	dispatch_departure (self, node)

	unknown_visit (self, node)

	unknown_departure (self, node)

Public Attributes
	settings

	language

	initial_header_level

	image_loading

	math_output

	math_options

	body

	body_prefix

	body_pre_docinfo

	body_suffix

	docinfo

	footer

	fragment

	head

	head_prefix

	header

	html_body

	html_head

	html_prolog

	html_subtitle

	html_title

	meta

	stylesheet

	title

	subtitle

	context

	section_level

	colspecs

	compact_p

	compact_simple

	compact_field_list

	in_docinfo

	in_sidebar

	in_document_title

	in_mailto

	author_in_authors

	math_header

	messages

	special_characters

	doctype

	documenttag_args

	mathjax_url

	content_type

Public Attributes inherited from docutils.nodes.NodeVisitor
	document

	optional

Static Public Attributes
str	doctype = '<!DOCTYPE html>\n'

str	doctype_mathml = doctype

tuple	head_prefix_template

str	content_type = '<meta charset="%s" />\n'

tuple	generator

dict	documenttag_args = {'tagname': 'div', 'CLASS': 'document'}

str	mathjax_script = '<script type="text/javascript" src="%s"></script>\n'

str	mathjax_url = 'file:/usr/share/javascript/mathjax/MathJax.js'

str	stylesheet_link = '<link rel="stylesheet" href="%s" type="text/css" />\n'

str	embedded_stylesheet = '<style type="text/css">\n\n%s\n</style>\n'

	words_and_spaces = re.compile(r'[^ \n]+\| +\|\n')

	in_word_wrap_point = re.compile(r'.+\W\W.+\|[-?].+')

str	lang_attribute = 'lang'

dict	special_characters

tuple	videotypes = ('video/mp4', 'video/webm', 'video/ogg')

dict	attribution_formats

dict	math_tags

Static Public Attributes inherited from docutils.nodes.NodeVisitor
tuple	optional = ('meta',)

Detailed Description

Generic Docutils to HTML translator.

See the `html4css1` and `html5_polyglot` writers for full featured
HTML writers.

.. IMPORTANT::
  The `visit_*` and `depart_*` methods use a
  heterogeneous stack, `self.context`.
  When subclassing, make sure to be consistent in its use!

  Examples for robust coding:

  a) Override both `visit_*` and `depart_*` methods, don't call the
     parent functions.

  b) Extend both and unconditionally call the parent functions::

       def visit_example(self, node):
           if foo:
               self.body.append('<div class="foo">')
           html4css1.HTMLTranslator.visit_example(self, node)

       def depart_example(self, node):
           html4css1.HTMLTranslator.depart_example(self, node)
           if foo:
               self.body.append('</div>')

  c) Extend both, calling the parent functions under the same
     conditions::

       def visit_example(self, node):
           if foo:
               self.body.append('<div class="foo">\n')
           else: # call the parent method
               _html_base.HTMLTranslator.visit_example(self, node)

       def depart_example(self, node):
           if foo:
               self.body.append('</div>\n')
           else: # call the parent method
               _html_base.HTMLTranslator.depart_example(self, node)

  d) Extend one method (call the parent), but don't otherwise use the
     `self.context` stack::

       def depart_example(self, node):
           _html_base.HTMLTranslator.depart_example(self, node)
           if foo:
               # implementation-specific code
               # that does not use `self.context`
               self.body.append('</div>\n')

  This way, changes in stack use will not bite you.

Constructor & Destructor Documentation

◆ init()

docutils.writers._html_base.HTMLTranslator.__init__	(	self,
		document
	)

Reimplemented from docutils.nodes.NodeVisitor.

Member Function Documentation

◆ attval()

docutils.writers._html_base.HTMLTranslator.attval	(	self,
		text,
		whitespace = `re.compile('[\n\r\t\v\f]')`
	)

Cleanse, HTML encode, and return attribute value text.

◆ check_simple_list()

docutils.writers._html_base.HTMLTranslator.check_simple_list	(	self,
		node
	)

Check for a simple list that can be rendered compactly.

◆ cloak_email()

docutils.writers._html_base.HTMLTranslator.cloak_email	(	self,
		addr
	)

Try to hide the link text of a email link from harversters.

◆ cloak_mailto()

docutils.writers._html_base.HTMLTranslator.cloak_mailto	(	self,
		uri
	)

Try to hide a mailto: URL from harvesters.

◆ emptytag()

docutils.writers._html_base.HTMLTranslator.emptytag	(		self,
			node,
			tagname,
			suffix = `'\n'`,
		**	attributes
	)

Construct and return an XML-compatible empty tag.

◆ encode()

docutils.writers._html_base.HTMLTranslator.encode	(	self,
		text
	)

Encode special characters in `text` & return.

◆ set_class_on_child()

docutils.writers._html_base.HTMLTranslator.set_class_on_child	(	self,
		node,
		class_,
		index = `0`
	)

Set class `class_` on the visible child no. index of `node`.
Do nothing if node has fewer children than `index`.

◆ starttag()

docutils.writers._html_base.HTMLTranslator.starttag	(		self,
			node,
			tagname,
			suffix = `'\n'`,
			empty = `False`,
		**	attributes
	)

Construct and return a start tag given a node (id & class attributes
are extracted), tag name, and optional attributes.

◆ stylesheet_call()

docutils.writers._html_base.HTMLTranslator.stylesheet_call	(	self,
		path,
		adjust_path = `None`
	)

Return code to reference or embed stylesheet file `path`

Reimplemented in myst_parser.parsers.docutils_.SimpleTranslator.

◆ uri2imagepath()

docutils.writers._html_base.HTMLTranslator.uri2imagepath	(	self,
		uri
	)

Get filesystem path corresponding to an URI.

The image directive expects an image URI. Some writers require the
corresponding image path to read the image size from the file or to
embed the image in the output.

Absolute URIs consider the "root_prefix" setting.

In order to work in the output document, relative image URIs relate
to the output directory. For access by the writer, the corresponding
image path must be relative to the current working directory.

Provisional: the function's location, interface and behaviour
may change without advance warning.

◆ visit_comment()

docutils.writers._html_base.HTMLTranslator.visit_comment	(	self,
		node,
		sub = `re.compile('-(?=-)').sub`
	)

Escape double-dashes in comment text.

◆ visit_enumerated_list()

docutils.writers._html_base.HTMLTranslator.visit_enumerated_list	(	self,
		node
	)

Reimplemented in docutils.writers.html4css1.HTMLTranslator.

◆ visit_substitution_definition()

docutils.writers._html_base.HTMLTranslator.visit_substitution_definition	(	self,
		node
	)

Internal only.

Member Data Documentation

◆ attribution_formats

dict docutils.writers._html_base.HTMLTranslator.attribution_formats

static

Initial value:

=  {'dash': ('\u2014', ''),
                           'parentheses': ('(', ')'),
                           'parens': ('(', ')'),
                           'none': ('', '')}

◆ generator

tuple docutils.writers._html_base.HTMLTranslator.generator

static

Initial value:

=  (
        f'<meta name="generator" content="Docutils {docutils.__version__}: '
        'https://docutils.sourceforge.io/" />\n')

◆ head_prefix_template

tuple docutils.writers._html_base.HTMLTranslator.head_prefix_template

static

Initial value:

= ('<html xmlns="http://www.w3.org/1999/xhtml"'

' xml:lang="%(lang)s" lang="%(lang)s">\n<head>\n')

◆ math_tags

dict docutils.writers._html_base.HTMLTranslator.math_tags

static

Initial value:

=  {  # format: (inline, block, [class arguments])
                 'html': ('span', 'div', ['formula']),
                 'latex': ('tt', 'pre', ['math']),
                 'mathjax': ('span', 'div', ['math']),
                 'mathml': ('', 'div', []),
                 'problematic': ('span', 'pre', ['math', 'problematic']),
                 }

◆ special_characters

dict docutils.writers._html_base.HTMLTranslator.special_characters

static

Initial value:

=  {ord('&'): '&amp;',
                          ord('<'): '&lt;',
                          ord('"'): '&quot;',
                          ord('>'): '&gt;',
                          ord('@'): '&#64;',  # may thwart address harvesters
                          }

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/docutils/writers/_html_base.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ attval()

◆ check_simple_list()

◆ cloak_email()

◆ cloak_mailto()

◆ emptytag()

◆ encode()

◆ set_class_on_child()

◆ starttag()

◆ stylesheet_call()

◆ uri2imagepath()

◆ visit_comment()

◆ visit_enumerated_list()

◆ visit_substitution_definition()

Member Data Documentation

◆ attribution_formats

◆ generator

◆ head_prefix_template

◆ math_tags

◆ special_characters

◆ init()