docutils.transforms.references.IndirectHyperlinks

Package docutils :: Package transforms :: Module references :: Class IndirectHyperlinks

[show private | hide private]

Class IndirectHyperlinks

Transform --+
            |
           IndirectHyperlinks

Indirect external references:

<paragraph>
    <reference refname="indirect external">
        indirect external
<target id="id1" name="direct external"
    refuri="http://indirect">
<target id="id2" name="indirect external"
    refname="direct external">

The "refuri" attribute is migrated back to all indirect targets from the final direct target (i.e. a target not referring to another indirect target):

<paragraph>
    <reference refname="indirect external">
        indirect external
<target id="id1" name="direct external"
    refuri="http://indirect">
<target id="id2" name="indirect external"
    refuri="http://indirect">

Once the attribute is migrated, the preexisting "refname" attribute is dropped.

Indirect internal references:

<target id="id1" name="final target">
<paragraph>
    <reference refname="indirect internal">
        indirect internal
<target id="id2" name="indirect internal 2"
    refname="final target">
<target id="id3" name="indirect internal"
    refname="indirect internal 2">

Targets which indirectly refer to an internal target become one-hop indirect (their "refid" attributes are directly set to the internal target's "id"). References which indirectly refer to an internal target become direct internal references:

<target id="id1" name="final target">
<paragraph>
    <reference refid="id1">
        indirect internal
<target id="id2" name="indirect internal 2" refid="id1">
<target id="id3" name="indirect internal" refid="id1">

Method Summary
	`apply(self)` Override to apply the transform to the document tree.
	`circular_indirect_reference(self, target)`
	`indirect_target_error(self, target, explanation)`
	`nonexistent_indirect_target(self, target)`
	`resolve_indirect_references(self, target)`
	`resolve_indirect_target(self, target)`
Inherited from Transform
	`__init__(self, document, startnode)` Initial setup for in-place document transforms.

Class Variable Summary
`int`	`default_priority` = 460

Method Details

apply(self)

Override to apply the transform to the document tree.

Overrides:: docutils.transforms.Transform.apply (inherited documentation)

Class Variable Details

default_priority

Type:: int
Value:: 460

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

http://epydoc.sf.net