module Synopsis.Formatters.DocBook.Markup.RST
class DocBookTranslator
DocBookTranslator-inheritance
Attributes Summary:
source code
source code
source code
source code
source code
source code
source code
source code
source code
source code
source code
Class attributes Summary:
source code
source code
source code
source code
Methods Summary:
  __init__(self, document)
references
source code
  astext(self)
references
source code
  encode(self, text)
references
source code
Encode special characters in `text` & return.
  encodeattr(self, text)
references
source code
references
source code
Replaces ``foonote_reference`` placeholders with ``footnote`` element content as DocBook and reST handle footnotes differently.
  attval(self, text, transtable = string.maketrans('\n\r\t\v\f', ' '))
references
source code
Cleanse, encode, and return attribute value text.
  starttag(self, node, tagname, suffix = '\n', infix = '', * * attributes)
references
source code
Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.
  emptytag(self, node, tagname, suffix = '\n', * * attributes)
references
source code
Construct and return an XML-compatible empty tag.
  visit_Text(self, node)
references
source code
  depart_Text(self, node)
references
source code
  visit_address(self, node)
references
source code
  depart_address(self, node)
references
source code
  visit_admonition(self, node, name = '')
references
source code
  depart_admonition(self, node = None)
references
source code
  visit_attention(self, node)
references
source code
  depart_attention(self, node)
references
source code
  visit_attribution(self, node)
references
source code
  depart_attribution(self, node)
references
source code
  visit_author(self, node)
references
source code
  visit_authors(self, node)
references
source code
  visit_block_quote(self, node)
references
source code
  depart_block_quote(self, node)
references
source code
  visit_bullet_list(self, node)
references
source code
  depart_bullet_list(self, node)
references
source code
  visit_caption(self, node)
references
source code
  depart_caption(self, node)
references
source code
  visit_caution(self, node)
references
source code
  depart_caution(self, node)
references
source code
  visit_citation(self, node)
references
source code
  depart_citation(self, node)
references
source code
  visit_citation_reference(self, node)
references
source code
references
source code
  visit_classifier(self, node)
references
source code
  depart_classifier(self, node)
references
source code
  visit_colspec(self, node)
references
source code
  depart_colspec(self, node)
references
source code
  visit_comment(self, node, sub = re.compile('-(?=-)').sub)
references
source code
Escape double-dashes in comment text.
  visit_contact(self, node)
references
source code
  visit_copyright(self, node)
references
source code
  visit_danger(self, node)
references
source code
  depart_danger(self, node)
references
source code
  visit_date(self, node)
references
source code
  visit_decoration(self, node)
references
source code
  depart_decoration(self, node)
references
source code
  visit_definition(self, node)
references
source code
  depart_definition(self, node)
references
source code
  visit_definition_list(self, node)
references
source code
  depart_definition_list(self, node)
references
source code
references
source code
references
source code
  visit_description(self, node)
references
source code
  depart_description(self, node)
references
source code
  visit_docinfo(self, node)
references
source code
Collects all docinfo elements for the document.
  depart_docinfo(self, node)
references
source code
  visit_doctest_block(self, node)
references
source code
  depart_doctest_block(self, node)
references
source code
  visit_document(self, node)
references
source code
  depart_document(self, node)
references
source code
  visit_emphasis(self, node)
references
source code
  depart_emphasis(self, node)
references
source code
  visit_entry(self, node)
references
source code
  depart_entry(self, node)
references
source code
  visit_enumerated_list(self, node)
references
source code
  depart_enumerated_list(self, node)
references
source code
  visit_error(self, node)
references
source code
  depart_error(self, node)
references
source code
  visit_field(self, node)
references
source code
  depart_field(self, node)
references
source code
  visit_field_argument(self, node)
references
source code
  depart_field_argument(self, node)
references
source code
  visit_field_body(self, node)
references
source code
  depart_field_body(self, node)
references
source code
  visit_field_list(self, node)
references
source code
  depart_field_list(self, node)
references
source code
  visit_field_name(self, node)
references
source code
  depart_field_name(self, node)
references
source code
  visit_figure(self, node)
references
source code
  depart_figure(self, node)
references
source code
  visit_footer(self, node)
references
source code
  depart_footer(self, node)
references
source code
  visit_footnote(self, node)
references
source code
  depart_footnote(self, node)
references
source code
  visit_footnote_reference(self, node)
references
source code
  visit_header(self, node)
references
source code
  depart_header(self, node)
references
source code
  visit_generated(self, node)
references
source code
  depart_generated(self, node)
references
source code
  visit_hint(self, node)
references
source code
  depart_hint(self, node)
references
source code
  visit_image(self, node)
references
source code
  depart_image(self, node)
references
source code
  visit_important(self, node)
references
source code
  depart_important(self, node)
references
source code
  visit_interpreted(self, node)
references
source code
  depart_interpreted(self, node)
references
source code
  visit_label(self, node)
references
source code
  depart_label(self, node)
references
source code
  visit_legend(self, node)
references
source code
  depart_legend(self, node)
references
source code
  visit_line_block(self, node)
references
source code
  depart_line_block(self, node)
references
source code
  visit_list_item(self, node)
references
source code
  depart_list_item(self, node)
references
source code
  visit_literal(self, node)
references
source code
  depart_literal(self, node)
references
source code
  visit_literal_block(self, node)
references
source code
  depart_literal_block(self, node)
references
source code
  visit_note(self, node)
references
source code
  depart_note(self, node)
references
source code
  visit_option(self, node)
references
source code
  depart_option(self, node)
references
source code
  visit_option_argument(self, node)
references
source code
  depart_option_argument(self, node)
references
source code
  visit_option_group(self, node)
references
source code
  depart_option_group(self, node)
references
source code
  visit_option_list(self, node)
references
source code
  depart_option_list(self, node)
references
source code
  visit_option_list_item(self, node)
references
source code
  depart_option_list_item(self, node)
references
source code
  visit_option_string(self, node)
references
source code
  depart_option_string(self, node)
references
source code
  visit_organization(self, node)
references
source code
  visit_paragraph(self, node)
references
source code
  depart_paragraph(self, node)
references
source code
  visit_raw(self, node)
references
source code
  visit_reference(self, node)
references
source code
  depart_reference(self, node)
references
source code
  visit_revision(self, node)
references
source code
  visit_row(self, node)
references
source code
  depart_row(self, node)
references
source code
  visit_rubric(self, node)
references
source code
  depart_rubric(self, node)
references
source code
  visit_section(self, node)
references
source code
  depart_section(self, node)
references
source code
  visit_sidebar(self, node)
references
source code
  depart_sidebar(self, node)
references
source code
  visit_status(self, node)
references
source code
  visit_strong(self, node)
references
source code
  depart_strong(self, node)
references
source code
  visit_subscript(self, node)
references
source code
  depart_subscript(self, node)
references
source code
references
source code
references
source code
  visit_subtitle(self, node)
references
source code
  depart_subtitle(self, node)
references
source code
  visit_superscript(self, node)
references
source code
  depart_superscript(self, node)
references
source code
  visit_table(self, node)
references
source code
  depart_table(self, node)
references
source code
  visit_target(self, node)
references
source code
  depart_target(self, node)
references
source code
  visit_tbody(self, node)
references
source code
  depart_tbody(self, node)
references
source code
  visit_term(self, node)
references
source code
  depart_term(self, node)
references
source code
  visit_tgroup(self, node)
references
source code
  depart_tgroup(self, node)
references
source code
  visit_thead(self, node)
references
source code
  depart_thead(self, node)
references
source code
  visit_tip(self, node)
references
source code
  depart_tip(self, node)
references
source code
  visit_title(self, node)
references
source code
  depart_title(self, node)
references
source code
  visit_title_reference(self, node)
references
source code
  depart_title_reference(self, node)
references
source code
  visit_topic(self, node)
references
source code
  depart_topic(self, node)
references
source code
  visit_transition(self, node)
references
source code
  depart_transition(self, node)
references
source code
  visit_version(self, node)
references
source code
  visit_warning(self, node)
references
source code
  depart_warning(self, node)
references
source code
  unimplemented_visit(self, node)
references
source code
Methods Details:
  encode(self, text)
references
source code
Encode special characters in `text` & return.
  encodeattr(self, text)
references
source code
Encode attributes characters > 128 as &#XXX;
references
source code
Replaces ``foonote_reference`` placeholders with ``footnote`` element content as DocBook and reST handle footnotes differently. DocBook defines footnotes inline, whereas they may be anywere in reST. This function replaces the first instance of a ``footnote_reference`` with the ``footnote`` element itself, and later references of the same a footnote with ``footnoteref`` elements.
  attval(self, text, transtable = string.maketrans('\n\r\t\v\f', ' '))
references
source code
Cleanse, encode, and return attribute value text.
  starttag(self, node, tagname, suffix = '\n', infix = '', * * attributes)
references
source code
Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.
  emptytag(self, node, tagname, suffix = '\n', * * attributes)
references
source code
Construct and return an XML-compatible empty tag.
  visit_comment(self, node, sub = re.compile('-(?=-)').sub)
references
source code
Escape double-dashes in comment text.
  visit_docinfo(self, node)
references
source code
Collects all docinfo elements for the document. Since reST's bibliography elements don't map very cleanly to DocBook, rather than maintain state and check dependencies within the different visitor fuctions all processing of bibliography elements is dont within this function. .. NOTE:: Skips processing of all child nodes as everything should be collected here.