Inheritance diagram for docutils.writers.s5_html.S5HTMLTranslator:

Collaboration diagram for docutils.writers.s5_html.S5HTMLTranslator:

Public Member Functions
	__init__ (self, *args)

	setup_theme (self)

	copy_theme (self)

	copy_file (self, name, source_dir, dest_dir)

	depart_document (self, node)

	depart_footer (self, node)

	depart_header (self, node)

	visit_section (self, node)

	visit_subtitle (self, node)

	visit_title (self, node)

Public Member Functions inherited from docutils.writers.html4css1.HTMLTranslator
	set_first_last (self, node)

	visit_address (self, node)

	depart_address (self, node)

	visit_admonition (self, node)

	depart_admonition (self, node=None)

	visit_author (self, node)

	depart_author (self, node)

	visit_authors (self, node)

	depart_authors (self, node)

	visit_colspec (self, node)

	depart_colspec (self, node)

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

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

	depart_entry (self, node)

	visit_enumerated_list (self, node)

	depart_enumerated_list (self, node)

	visit_field (self, node)

	depart_field (self, node)

	visit_field_body (self, node)

	depart_field_body (self, node)

	visit_field_list (self, node)

	depart_field_list (self, node)

	visit_field_name (self, node)

	depart_field_name (self, node)

	visit_footnote (self, node)

	footnote_backrefs (self, node)

	depart_footnote (self, node)

	visit_footnote_reference (self, node)

	depart_footnote_reference (self, node)

	visit_generated (self, node)

	visit_image (self, node)

	depart_image (self, node)

	visit_label (self, node)

	depart_label (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_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)

	should_be_compact_paragraph (self, node)

	visit_paragraph (self, node)

	depart_paragraph (self, node)

	visit_sidebar (self, node)

	depart_sidebar (self, node)

	visit_subscript (self, node)

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

	depart_tbody (self, node)

	visit_term (self, node)

	depart_term (self, node)

	visit_thead (self, node)

	depart_thead (self, node)

	section_title_tags (self, node)

Public Member Functions inherited from docutils.writers._html_base.HTMLTranslator
	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_attribution (self, node)

	depart_attribution (self, node)

	visit_block_quote (self, node)

	depart_block_quote (self, node)

	check_simple_list (self, node)

	visit_bullet_list (self, node)

	depart_bullet_list (self, node)

	visit_caption (self, node)

	depart_caption (self, node)

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

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

	visit_emphasis (self, node)

	depart_emphasis (self, node)

	visit_figure (self, node)

	depart_figure (self, node)

	visit_footer (self, node)

	depart_generated (self, node)

	visit_header (self, node)

	visit_inline (self, node)

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

	depart_option_string (self, node)

	visit_organization (self, node)

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

	depart_section (self, node)

	visit_status (self, node)

	depart_status (self, node)

	visit_strong (self, node)

	depart_strong (self, node)

	visit_substitution_definition (self, node)

	visit_substitution_reference (self, node)

	visit_target (self, node)

	depart_target (self, node)

	visit_tgroup (self, node)

	depart_tgroup (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
	theme_file_path

	disable_current_slide

	s5_footer

	s5_header

	section_count

	theme_files_copied

	required_theme_files

	doctype

	head

	math_output

	math_header

	body

Public Attributes inherited from docutils.writers.html4css1.HTMLTranslator
	author_in_authors

	body

	in_docinfo

	docinfo

	compact_simple

	compact_p

	compact_field_list

	in_sidebar

	in_document_title

	subtitle

Public Attributes inherited from docutils.writers._html_base.HTMLTranslator
	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	s5_stylesheet_template

str	disable_current_slide

str	layout_template

str	default_theme = 'default'

str	base_theme_file = '__base__'

tuple	direct_theme_files

tuple	indirect_theme_files

tuple	required_theme_files = indirect_theme_files + direct_theme_files

	files_to_skip_pattern = re.compile(r'~$\|\.bak$\|#$\|\.cvsignore$')

Static Public Attributes inherited from docutils.writers.html4css1.HTMLTranslator
tuple	doctype

tuple	content_type

tuple	content_type_mathml

	special_characters = _html_base.HTMLTranslator.special_characters.copy()

dict	attribution_formats

dict	object_image_types

Static Public Attributes inherited from docutils.writers._html_base.HTMLTranslator
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',)

Constructor & Destructor Documentation

◆ init()

docutils.writers.s5_html.S5HTMLTranslator.__init__	(		self,
		*	args
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

Member Function Documentation

◆ copy_file()

docutils.writers.s5_html.S5HTMLTranslator.copy_file	(	self,
		name,
		source_dir,
		dest_dir
	)

Copy file `name` from `source_dir` to `dest_dir`.
Return True if the file exists in either `source_dir` or `dest_dir`.

◆ copy_theme()

docutils.writers.s5_html.S5HTMLTranslator.copy_theme ( self )

Locate & copy theme files.

A theme may be explicitly based on another theme via a '__base__'
file.  The default base theme is 'default'.  Files are accumulated
from the specified theme, any base themes, and 'default'.

◆ depart_document()

docutils.writers.s5_html.S5HTMLTranslator.depart_document	(	self,
		node
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

◆ depart_footer()

docutils.writers.s5_html.S5HTMLTranslator.depart_footer	(	self,
		node
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

◆ depart_header()

docutils.writers.s5_html.S5HTMLTranslator.depart_header	(	self,
		node
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

◆ visit_section()

docutils.writers.s5_html.S5HTMLTranslator.visit_section	(	self,
		node
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

◆ visit_subtitle()

docutils.writers.s5_html.S5HTMLTranslator.visit_subtitle	(	self,
		node
	)

Reimplemented from docutils.writers.html4css1.HTMLTranslator.

◆ visit_title()

docutils.writers.s5_html.S5HTMLTranslator.visit_title	(	self,
		node
	)

Reimplemented from docutils.writers._html_base.HTMLTranslator.

Member Data Documentation

◆ direct_theme_files

tuple docutils.writers.s5_html.S5HTMLTranslator.direct_theme_files

static

Initial value:

= (

'slides.css', 'outline.css', 'print.css', 'opera.css', 'slides.js')

◆ disable_current_slide

str docutils.writers.s5_html.S5HTMLTranslator.disable_current_slide

static

Initial value:

=  """
<style type="text/css">
#currentSlide {display: none;}
</style>\n"""

◆ indirect_theme_files

tuple docutils.writers.s5_html.S5HTMLTranslator.indirect_theme_files

static

Initial value:

= (

's5-core.css', 'framing.css', 'pretty.css')

◆ layout_template

str docutils.writers.s5_html.S5HTMLTranslator.layout_template

static

Initial value:

=  """\
<div class="layout">
<div id="controls"></div>
<div id="currentSlide"></div>
<div id="header">
%(header)s
</div>
<div id="footer">
%(title)s%(footer)s
</div>
</div>\n"""

◆ s5_stylesheet_template

str docutils.writers.s5_html.S5HTMLTranslator.s5_stylesheet_template

static

Initial value:

=  """\
<!-- configuration parameters -->
<meta name="defaultView" content="%(view_mode)s" />
<meta name="controlVis" content="%(control_visibility)s" />
<!-- style sheet links -->
<script src="%(path)s/slides.js" type="text/javascript"></script>
<link rel="stylesheet" href="%(path)s/slides.css"
      type="text/css" media="projection" id="slideProj" />
<link rel="stylesheet" href="%(path)s/outline.css"
      type="text/css" media="screen" id="outlineStyle" />
<link rel="stylesheet" href="%(path)s/print.css"
      type="text/css" media="print" id="slidePrint" />
<link rel="stylesheet" href="%(path)s/opera.css"
      type="text/css" media="projection" id="operaFix" />\n"""

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ copy_file()

◆ copy_theme()

◆ depart_document()

◆ depart_footer()

◆ depart_header()

◆ visit_section()

◆ visit_subtitle()

◆ visit_title()

Member Data Documentation

◆ direct_theme_files

◆ disable_current_slide

◆ indirect_theme_files

◆ layout_template

◆ s5_stylesheet_template

◆ init()