Qucs-S S-parameter Viewer & RF Synthesis Tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
docutils.writers.html4css1.HTMLTranslator Class Reference
Inheritance diagram for docutils.writers.html4css1.HTMLTranslator:
Inheritance graph
[legend]
Collaboration diagram for docutils.writers.html4css1.HTMLTranslator:
Collaboration graph
[legend]

Public Member Functions

 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)
 
 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_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
 __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_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)
 
 depart_document (self, node)
 
 visit_emphasis (self, node)
 
 depart_emphasis (self, node)
 
 visit_figure (self, node)
 
 depart_figure (self, node)
 
 visit_footer (self, node)
 
 depart_footer (self, node)
 
 depart_generated (self, node)
 
 visit_header (self, node)
 
 depart_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)
 
 visit_section (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)
 
 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

 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

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',)
 

Detailed Description

The html4css1 writer has been optimized to produce visually compact
lists (less vertical whitespace).  HTML's mixed content models
allow list items to contain "<li><p>body elements</p></li>" or
"<li>just text</li>" or even "<li>text<p>and body
elements</p>combined</li>", each with different effects.  It would
be best to stick with strict body elements in list items, but they
affect vertical spacing in older browsers (although they really
shouldn't).
The html5_polyglot writer solves this using CSS2.

Here is an outline of the optimization:

- Check for and omit <p> tags in "simple" lists: list items
  contain either a single paragraph, a nested simple list, or a
  paragraph followed by a nested simple list.  This means that
  this list can be compact:

      - Item 1.
      - Item 2.

  But this list cannot be compact:

      - Item 1.

        This second paragraph forces space between list items.

      - Item 2.

- In non-list contexts, omit <p> tags on a paragraph if that
  paragraph is the only child of its parent (footnotes & citations
  are allowed a label first).

- Regardless of the above, in definitions, table cells, field bodies,
  option descriptions, and list items, mark the first child with
  'class="first"' and the last child with 'class="last"'.  The stylesheet
  sets the margins (top & bottom respectively) to 0 for these elements.

The ``no_compact_lists`` setting (``--no-compact-lists`` command-line
option) disables list whitespace optimization.

Member Function Documentation

◆ depart_address()

docutils.writers.html4css1.HTMLTranslator.depart_address (   self,
  node 
)

◆ depart_admonition()

docutils.writers.html4css1.HTMLTranslator.depart_admonition (   self,
  node = None 
)

◆ depart_author()

docutils.writers.html4css1.HTMLTranslator.depart_author (   self,
  node 
)

◆ depart_authors()

docutils.writers.html4css1.HTMLTranslator.depart_authors (   self,
  node 
)

◆ depart_citation()

docutils.writers.html4css1.HTMLTranslator.depart_citation (   self,
  node 
)

◆ depart_citation_reference()

docutils.writers.html4css1.HTMLTranslator.depart_citation_reference (   self,
  node 
)

◆ depart_classifier()

docutils.writers.html4css1.HTMLTranslator.depart_classifier (   self,
  node 
)

◆ depart_colspec()

docutils.writers.html4css1.HTMLTranslator.depart_colspec (   self,
  node 
)

◆ depart_compound()

docutils.writers.html4css1.HTMLTranslator.depart_compound (   self,
  node 
)

◆ depart_definition()

docutils.writers.html4css1.HTMLTranslator.depart_definition (   self,
  node 
)

◆ depart_definition_list()

docutils.writers.html4css1.HTMLTranslator.depart_definition_list (   self,
  node 
)

◆ depart_definition_list_item()

docutils.writers.html4css1.HTMLTranslator.depart_definition_list_item (   self,
  node 
)

◆ depart_description()

docutils.writers.html4css1.HTMLTranslator.depart_description (   self,
  node 
)

◆ depart_docinfo()

docutils.writers.html4css1.HTMLTranslator.depart_docinfo (   self,
  node 
)

◆ depart_docinfo_item()

docutils.writers.html4css1.HTMLTranslator.depart_docinfo_item (   self)

◆ depart_doctest_block()

docutils.writers.html4css1.HTMLTranslator.depart_doctest_block (   self,
  node 
)

◆ depart_entry()

docutils.writers.html4css1.HTMLTranslator.depart_entry (   self,
  node 
)

◆ depart_enumerated_list()

docutils.writers.html4css1.HTMLTranslator.depart_enumerated_list (   self,
  node 
)

◆ depart_field()

docutils.writers.html4css1.HTMLTranslator.depart_field (   self,
  node 
)

◆ depart_field_body()

docutils.writers.html4css1.HTMLTranslator.depart_field_body (   self,
  node 
)

◆ depart_field_list()

docutils.writers.html4css1.HTMLTranslator.depart_field_list (   self,
  node 
)

◆ depart_field_name()

docutils.writers.html4css1.HTMLTranslator.depart_field_name (   self,
  node 
)

◆ depart_footnote()

docutils.writers.html4css1.HTMLTranslator.depart_footnote (   self,
  node 
)

◆ depart_footnote_reference()

docutils.writers.html4css1.HTMLTranslator.depart_footnote_reference (   self,
  node 
)

◆ depart_image()

docutils.writers.html4css1.HTMLTranslator.depart_image (   self,
  node 
)

◆ depart_label()

docutils.writers.html4css1.HTMLTranslator.depart_label (   self,
  node 
)

◆ depart_list_item()

docutils.writers.html4css1.HTMLTranslator.depart_list_item (   self,
  node 
)

◆ depart_literal()

docutils.writers.html4css1.HTMLTranslator.depart_literal (   self,
  node 
)

◆ depart_literal_block()

docutils.writers.html4css1.HTMLTranslator.depart_literal_block (   self,
  node 
)

◆ depart_option_group()

docutils.writers.html4css1.HTMLTranslator.depart_option_group (   self,
  node 
)

◆ depart_option_list()

docutils.writers.html4css1.HTMLTranslator.depart_option_list (   self,
  node 
)

◆ depart_option_list_item()

docutils.writers.html4css1.HTMLTranslator.depart_option_list_item (   self,
  node 
)

◆ depart_paragraph()

docutils.writers.html4css1.HTMLTranslator.depart_paragraph (   self,
  node 
)

◆ depart_sidebar()

docutils.writers.html4css1.HTMLTranslator.depart_sidebar (   self,
  node 
)

◆ depart_subscript()

docutils.writers.html4css1.HTMLTranslator.depart_subscript (   self,
  node 
)

◆ depart_subtitle()

docutils.writers.html4css1.HTMLTranslator.depart_subtitle (   self,
  node 
)

◆ depart_superscript()

docutils.writers.html4css1.HTMLTranslator.depart_superscript (   self,
  node 
)

◆ depart_system_message()

docutils.writers.html4css1.HTMLTranslator.depart_system_message (   self,
  node 
)

◆ depart_table()

docutils.writers.html4css1.HTMLTranslator.depart_table (   self,
  node 
)

◆ depart_tbody()

docutils.writers.html4css1.HTMLTranslator.depart_tbody (   self,
  node 
)

◆ depart_term()

docutils.writers.html4css1.HTMLTranslator.depart_term (   self,
  node 
)

◆ depart_thead()

docutils.writers.html4css1.HTMLTranslator.depart_thead (   self,
  node 
)

◆ is_compactable()

docutils.writers.html4css1.HTMLTranslator.is_compactable (   self,
  node 
)

◆ section_title_tags()

docutils.writers.html4css1.HTMLTranslator.section_title_tags (   self,
  node 
)

◆ should_be_compact_paragraph()

docutils.writers.html4css1.HTMLTranslator.should_be_compact_paragraph (   self,
  node 
)
Determine if the <p> tags around paragraph ``node`` can be omitted.

◆ visit_address()

docutils.writers.html4css1.HTMLTranslator.visit_address (   self,
  node 
)

◆ visit_admonition()

docutils.writers.html4css1.HTMLTranslator.visit_admonition (   self,
  node 
)

◆ visit_author()

docutils.writers.html4css1.HTMLTranslator.visit_author (   self,
  node 
)

◆ visit_authors()

docutils.writers.html4css1.HTMLTranslator.visit_authors (   self,
  node 
)

◆ visit_citation()

docutils.writers.html4css1.HTMLTranslator.visit_citation (   self,
  node 
)

◆ visit_citation_reference()

docutils.writers.html4css1.HTMLTranslator.visit_citation_reference (   self,
  node 
)

◆ visit_classifier()

docutils.writers.html4css1.HTMLTranslator.visit_classifier (   self,
  node 
)

◆ visit_colspec()

docutils.writers.html4css1.HTMLTranslator.visit_colspec (   self,
  node 
)

◆ visit_compound()

docutils.writers.html4css1.HTMLTranslator.visit_compound (   self,
  node 
)

◆ visit_definition()

docutils.writers.html4css1.HTMLTranslator.visit_definition (   self,
  node 
)

◆ visit_definition_list()

docutils.writers.html4css1.HTMLTranslator.visit_definition_list (   self,
  node 
)

◆ visit_definition_list_item()

docutils.writers.html4css1.HTMLTranslator.visit_definition_list_item (   self,
  node 
)

◆ visit_description()

docutils.writers.html4css1.HTMLTranslator.visit_description (   self,
  node 
)

◆ visit_docinfo()

docutils.writers.html4css1.HTMLTranslator.visit_docinfo (   self,
  node 
)

◆ visit_docinfo_item()

docutils.writers.html4css1.HTMLTranslator.visit_docinfo_item (   self,
  node,
  name,
  meta = True 
)

◆ visit_doctest_block()

docutils.writers.html4css1.HTMLTranslator.visit_doctest_block (   self,
  node 
)

◆ visit_entry()

docutils.writers.html4css1.HTMLTranslator.visit_entry (   self,
  node 
)

◆ visit_enumerated_list()

docutils.writers.html4css1.HTMLTranslator.visit_enumerated_list (   self,
  node 
)
The 'start' attribute does not conform to HTML 4.01's strict.dtd, but
cannot be emulated in CSS1 (HTML 5 reincludes it).

Reimplemented from docutils.writers._html_base.HTMLTranslator.

◆ visit_field()

docutils.writers.html4css1.HTMLTranslator.visit_field (   self,
  node 
)

◆ visit_field_body()

docutils.writers.html4css1.HTMLTranslator.visit_field_body (   self,
  node 
)

◆ visit_field_list()

docutils.writers.html4css1.HTMLTranslator.visit_field_list (   self,
  node 
)

◆ visit_field_name()

docutils.writers.html4css1.HTMLTranslator.visit_field_name (   self,
  node 
)

◆ visit_footnote()

docutils.writers.html4css1.HTMLTranslator.visit_footnote (   self,
  node 
)

◆ visit_footnote_reference()

docutils.writers.html4css1.HTMLTranslator.visit_footnote_reference (   self,
  node 
)

◆ visit_generated()

docutils.writers.html4css1.HTMLTranslator.visit_generated (   self,
  node 
)

◆ visit_image()

docutils.writers.html4css1.HTMLTranslator.visit_image (   self,
  node 
)

◆ visit_label()

docutils.writers.html4css1.HTMLTranslator.visit_label (   self,
  node 
)

◆ visit_list_item()

docutils.writers.html4css1.HTMLTranslator.visit_list_item (   self,
  node 
)

◆ visit_literal()

docutils.writers.html4css1.HTMLTranslator.visit_literal (   self,
  node 
)

◆ visit_literal_block()

docutils.writers.html4css1.HTMLTranslator.visit_literal_block (   self,
  node 
)

◆ visit_option_group()

docutils.writers.html4css1.HTMLTranslator.visit_option_group (   self,
  node 
)

◆ visit_option_list()

docutils.writers.html4css1.HTMLTranslator.visit_option_list (   self,
  node 
)

◆ visit_option_list_item()

docutils.writers.html4css1.HTMLTranslator.visit_option_list_item (   self,
  node 
)

◆ visit_paragraph()

docutils.writers.html4css1.HTMLTranslator.visit_paragraph (   self,
  node 
)

◆ visit_sidebar()

docutils.writers.html4css1.HTMLTranslator.visit_sidebar (   self,
  node 
)

◆ visit_subscript()

docutils.writers.html4css1.HTMLTranslator.visit_subscript (   self,
  node 
)

◆ visit_subtitle()

docutils.writers.html4css1.HTMLTranslator.visit_subtitle (   self,
  node 
)

◆ visit_superscript()

docutils.writers.html4css1.HTMLTranslator.visit_superscript (   self,
  node 
)

◆ visit_system_message()

docutils.writers.html4css1.HTMLTranslator.visit_system_message (   self,
  node 
)

◆ visit_table()

docutils.writers.html4css1.HTMLTranslator.visit_table (   self,
  node 
)

◆ visit_tbody()

docutils.writers.html4css1.HTMLTranslator.visit_tbody (   self,
  node 
)

◆ visit_term()

docutils.writers.html4css1.HTMLTranslator.visit_term (   self,
  node 
)

◆ visit_thead()

docutils.writers.html4css1.HTMLTranslator.visit_thead (   self,
  node 
)

Member Data Documentation

◆ attribution_formats

dict docutils.writers.html4css1.HTMLTranslator.attribution_formats
static
Initial value:
= {'dash': ('&mdash;', ''),
'parentheses': ('(', ')'),
'parens': ('(', ')'),
'none': ('', '')}

◆ content_type

tuple docutils.writers.html4css1.HTMLTranslator.content_type
static
Initial value:
= ('<meta http-equiv="Content-Type"'
' content="text/html; charset=%s" />\n')

◆ content_type_mathml

tuple docutils.writers.html4css1.HTMLTranslator.content_type_mathml
static
Initial value:
= ('<meta http-equiv="Content-Type"'
' content="application/xhtml+xml; charset=%s" />\n')

◆ doctype

tuple docutils.writers.html4css1.HTMLTranslator.doctype
static
Initial value:
= (
'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'
' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n')

◆ object_image_types

dict docutils.writers.html4css1.HTMLTranslator.object_image_types
static
Initial value:
= {'.svg': 'image/svg+xml',
'.swf': 'application/x-shockwave-flash',
'.mp4': 'video/mp4',
'.webm': 'video/webm',
'.ogg': 'video/ogg',
}

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