summaryrefslogtreecommitdiff
path: root/docs/ref/transforms.txt
diff options
context:
space:
mode:
authorwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-08-17 13:59:12 +0000
committerwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-08-17 13:59:12 +0000
commita4bc0d09f3d1f633a5780976d1f913e083c9564a (patch)
tree1777475e88463b08438f0719be97cc087554eadd /docs/ref/transforms.txt
parent60c69f8cf97125135948a3d35b7698ee80921137 (diff)
parent2818db9a234cc37008c5f2bb0e821f9b1fa92de2 (diff)
downloaddocutils-0.3.9.tar.gz
re-added docutils-0.3.9 tag one level deeper (without web/ and sandboxes/)docutils-0.3.9
git-svn-id: http://svn.code.sf.net/p/docutils/code/tags/docutils-0.3.9@3815 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/ref/transforms.txt')
-rw-r--r--docs/ref/transforms.txt107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/ref/transforms.txt b/docs/ref/transforms.txt
new file mode 100644
index 000000000..079bedaaa
--- /dev/null
+++ b/docs/ref/transforms.txt
@@ -0,0 +1,107 @@
+=====================
+ Docutils Transforms
+=====================
+
+:Author: David Goodger
+:Contact: goodger@users.sourceforge.net
+:Revision: $Revision$
+:Date: $Date$
+:Copyright: This document has been placed in the public domain.
+
+
+.. contents::
+
+
+For background about transforms and the Transformer object, see `PEP
+258`_.
+
+.. _PEP 258: ../peps/pep-0258.html#transformer
+
+
+Transforms Listed in Priority Order
+===================================
+
+============================== ============================ ========
+Transform: module.Class Added By Priority
+============================== ============================ ========
+misc.class "class" (d/p) 210
+
+references.Substitutions standalone (r), pep (r) 220
+
+references.PropagateTargets standalone (r), pep (r) 260
+
+frontmatter.DocTitle standalone (r) 320
+
+frontmatter.DocInfo standalone (r) 340
+
+frontmatter.SectSubTitle standalone (r) 350
+
+peps.Headers pep (r) 360
+
+peps.Contents pep (r) 380
+
+references.AnonymousHyperlinks standalone (r), pep (r) 440
+
+references.IndirectHyperlinks standalone (r), pep (r) 460
+
+peps.TargetNotes pep (r) 520
+
+references.TargetNotes peps.TargetNotes (t/p) 0
+
+misc.CallBack peps.TargetNotes (t/p) 1
+
+references.TargetNotes "target-notes" (d/p) 540
+
+references.Footnotes standalone (r), pep (r) 620
+
+references.ExternalTargets standalone (r), pep (r) 640
+
+references.InternalTargets standalone (r), pep (r) 660
+
+parts.SectNum "sectnum" (d/p) 710
+
+parts.Contents "contents" (d/p), 720
+ peps.Contents (t/p)
+
+peps.PEPZero peps.Headers (t/p) 760
+
+components.Filter "meta" (d/p) 780
+
+universal.Decorations Transformer 820
+
+universal.FinalChecks Transformer 840
+
+universal.Messages Transformer 860
+
+universal.FilterMessages Transformer 870
+
+universal.TestMessages DocutilsTestSupport 880
+
+misc.CallBack n/a 990
+============================== ============================ ========
+
+Key:
+
+* (r): Reader
+* (d): Directive
+* (t): Transform
+* (/p): Via a "pending" node
+
+
+Transform Priority Range Categories
+===================================
+
+==== ==== ================================================
+ Priority
+---------- ------------------------------------------------
+From To Category
+==== ==== ================================================
+ 0 99 immediate execution (added by another transform)
+ 100 199 very early (non-standard)
+ 200 299 very early
+ 300 399 early
+ 400 699 main
+ 700 799 late
+ 800 899 very late
+ 900 999 very late (non-standard)
+==== ==== ================================================