docutils.transforms.references.ChainedTargetResolver

Package docutils :: Package transforms :: Module references :: Class ChainedTargetResolver

[show private | hide private]

Class ChainedTargetResolver

  NodeVisitor --+    
                |    
SparseNodeVisitor --+
                    |
                   ChainedTargetResolver

Copy reference attributes up the length of a hyperlink target chain.

"Chained targets" are multiple adjacent internal hyperlink targets which "point to" an external or indirect target. After the transform, all chained targets will effectively point to the same place.

Given the following document as input:

<document>
    <target id="a" name="a">
    <target id="b" name="b">
    <target id="c" name="c" refuri="http://chained.external.targets">
    <target id="d" name="d">
    <paragraph>
        I'm known as "d".
    <target id="e" name="e">
    <target id="id1">
    <target id="f" name="f" refname="d">

ChainedTargetResolver(document).walk() will transform the above into:

<document>
    <target id="a" name="a" refuri="http://chained.external.targets">
    <target id="b" name="b" refuri="http://chained.external.targets">
    <target id="c" name="c" refuri="http://chained.external.targets">
    <target id="d" name="d">
    <paragraph>
        I'm known as "d".
    <target id="e" name="e" refname="d">
    <target id="id1" refname="d">
    <target id="f" name="f" refname="d">

Method Summary
	`unknown_visit(self, node)` Called when entering unknown `Node` types.
	`visit_target(self, node)`
Inherited from SparseNodeVisitor
	`depart_abbreviation(self, node)`
	`depart_acronym(self, node)`
	`depart_address(self, node)`
	`depart_admonition(self, node)`
	`depart_attention(self, node)`
	`depart_attribution(self, node)`
	`depart_author(self, node)`
	`depart_authors(self, node)`
	`depart_block_quote(self, node)`
	`depart_bullet_list(self, node)`
	`depart_caption(self, node)`
	`depart_caution(self, node)`
	`depart_citation(self, node)`
	`depart_citation_reference(self, node)`
	`depart_classifier(self, node)`
	`depart_colspec(self, node)`
	`depart_comment(self, node)`
	`depart_contact(self, node)`
	`depart_copyright(self, node)`
	`depart_danger(self, node)`
	`depart_date(self, node)`
	`depart_decoration(self, node)`
	`depart_definition(self, node)`
	`depart_definition_list(self, node)`
	`depart_definition_list_item(self, node)`
	`depart_description(self, node)`
	`depart_docinfo(self, node)`
	`depart_doctest_block(self, node)`
	`depart_document(self, node)`
	`depart_emphasis(self, node)`
	`depart_entry(self, node)`
	`depart_enumerated_list(self, node)`
	`depart_error(self, node)`
	`depart_field(self, node)`
	`depart_field_body(self, node)`
	`depart_field_list(self, node)`
	`depart_field_name(self, node)`
	`depart_figure(self, node)`
	`depart_footer(self, node)`
	`depart_footnote(self, node)`
	`depart_footnote_reference(self, node)`
	`depart_generated(self, node)`
	`depart_header(self, node)`
	`depart_hint(self, node)`
	`depart_image(self, node)`
	`depart_important(self, node)`
	`depart_inline(self, node)`
	`depart_label(self, node)`
	`depart_legend(self, node)`
	`depart_line_block(self, node)`
	`depart_list_item(self, node)`
	`depart_literal(self, node)`
	`depart_literal_block(self, node)`
	`depart_note(self, node)`
	`depart_option(self, node)`
	`depart_option_argument(self, node)`
	`depart_option_group(self, node)`
	`depart_option_list(self, node)`
	`depart_option_list_item(self, node)`
	`depart_option_string(self, node)`
	`depart_organization(self, node)`
	`depart_paragraph(self, node)`
	`depart_pending(self, node)`
	`depart_problematic(self, node)`
	`depart_raw(self, node)`
	`depart_reference(self, node)`
	`depart_revision(self, node)`
	`depart_row(self, node)`
	`depart_rubric(self, node)`
	`depart_section(self, node)`
	`depart_sidebar(self, node)`
	`depart_status(self, node)`
	`depart_strong(self, node)`
	`depart_subscript(self, node)`
	`depart_substitution_definition(self, node)`
	`depart_substitution_reference(self, node)`
	`depart_subtitle(self, node)`
	`depart_superscript(self, node)`
	`depart_system_message(self, node)`
	`depart_table(self, node)`
	`depart_target(self, node)`
	`depart_tbody(self, node)`
	`depart_term(self, node)`
	`depart_Text(self, node)`
	`depart_tgroup(self, node)`
	`depart_thead(self, node)`
	`depart_tip(self, node)`
	`depart_title(self, node)`
	`depart_title_reference(self, node)`
	`depart_topic(self, node)`
	`depart_transition(self, node)`
	`depart_version(self, node)`
	`depart_warning(self, node)`
	`visit_abbreviation(self, node)`
	`visit_acronym(self, node)`
	`visit_address(self, node)`
	`visit_admonition(self, node)`
	`visit_attention(self, node)`
	`visit_attribution(self, node)`
	`visit_author(self, node)`
	`visit_authors(self, node)`
	`visit_block_quote(self, node)`
	`visit_bullet_list(self, node)`
	`visit_caption(self, node)`
	`visit_caution(self, node)`
	`visit_citation(self, node)`
	`visit_citation_reference(self, node)`
	`visit_classifier(self, node)`
	`visit_colspec(self, node)`
	`visit_comment(self, node)`
	`visit_contact(self, node)`
	`visit_copyright(self, node)`
	`visit_danger(self, node)`
	`visit_date(self, node)`
	`visit_decoration(self, node)`
	`visit_definition(self, node)`
	`visit_definition_list(self, node)`
	`visit_definition_list_item(self, node)`
	`visit_description(self, node)`
	`visit_docinfo(self, node)`
	`visit_doctest_block(self, node)`
	`visit_document(self, node)`
	`visit_emphasis(self, node)`
	`visit_entry(self, node)`
	`visit_enumerated_list(self, node)`
	`visit_error(self, node)`
	`visit_field(self, node)`
	`visit_field_body(self, node)`
	`visit_field_list(self, node)`
	`visit_field_name(self, node)`
	`visit_figure(self, node)`
	`visit_footer(self, node)`
	`visit_footnote(self, node)`
	`visit_footnote_reference(self, node)`
	`visit_generated(self, node)`
	`visit_header(self, node)`
	`visit_hint(self, node)`
	`visit_image(self, node)`
	`visit_important(self, node)`
	`visit_inline(self, node)`
	`visit_label(self, node)`
	`visit_legend(self, node)`
	`visit_line_block(self, node)`
	`visit_list_item(self, node)`
	`visit_literal(self, node)`
	`visit_literal_block(self, node)`
	`visit_note(self, node)`
	`visit_option(self, node)`
	`visit_option_argument(self, node)`
	`visit_option_group(self, node)`
	`visit_option_list(self, node)`
	`visit_option_list_item(self, node)`
	`visit_option_string(self, node)`
	`visit_organization(self, node)`
	`visit_paragraph(self, node)`
	`visit_pending(self, node)`
	`visit_problematic(self, node)`
	`visit_raw(self, node)`
	`visit_reference(self, node)`
	`visit_revision(self, node)`
	`visit_row(self, node)`
	`visit_rubric(self, node)`
	`visit_section(self, node)`
	`visit_sidebar(self, node)`
	`visit_status(self, node)`
	`visit_strong(self, node)`
	`visit_subscript(self, node)`
	`visit_substitution_definition(self, node)`
	`visit_substitution_reference(self, node)`
	`visit_subtitle(self, node)`
	`visit_superscript(self, node)`
	`visit_system_message(self, node)`
	`visit_table(self, node)`
	`visit_tbody(self, node)`
	`visit_term(self, node)`
	`visit_Text(self, node)`
	`visit_tgroup(self, node)`
	`visit_thead(self, node)`
	`visit_tip(self, node)`
	`visit_title(self, node)`
	`visit_title_reference(self, node)`
	`visit_topic(self, node)`
	`visit_transition(self, node)`
	`visit_version(self, node)`
	`visit_warning(self, node)`
Inherited from NodeVisitor
	`__init__(self, document)`
	`unknown_departure(self, node)` Called before exiting unknown `Node` types.

Method Details

unknown_visit(self, node)

Called when entering unknown Node types.

Raise an exception unless overridden.

Overrides:: docutils.nodes.NodeVisitor.unknown_visit (inherited documentation)

Generated by Epydoc 2.0 on Tue Jul 22 05:30:18 2003

http://epydoc.sf.net