summaryrefslogtreecommitdiff
path: root/docs/ref/transforms.txt
diff options
context:
space:
mode:
authorwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-01-09 20:44:25 +0000
committerwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-01-09 20:44:25 +0000
commitd77fdfef70e08114f57cbef5d91707df8717ea9f (patch)
tree49444e3486c0c333cb7b33dfa721296c08ee4ece /docs/ref/transforms.txt
parent53cd16ca6ca5f638cbe5956988e88f9339e355cf (diff)
parent3993c4097756e9885bcfbd07cb1cc1e4e95e50e4 (diff)
downloaddocutils-0.4.tar.gz
Release 0.4: tagging released revisiondocutils-0.4
git-svn-id: http://svn.code.sf.net/p/docutils/code/tags/docutils-0.4@4268 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/ref/transforms.txt')
-rw-r--r--docs/ref/transforms.txt116
1 files changed, 116 insertions, 0 deletions
diff --git a/docs/ref/transforms.txt b/docs/ref/transforms.txt
new file mode 100644
index 000000000..54446f8dd
--- /dev/null
+++ b/docs/ref/transforms.txt
@@ -0,0 +1,116 @@
+=====================
+ 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)
+
+universal.StripComments Reader (r) 740
+
+peps.PEPZero peps.Headers (t/p) 760
+
+components.Filter "meta" (d/p) 780
+
+writer_aux.Compound newlatex2e (w) 810
+
+universal.Decorations Reader (r) 820
+
+misc.Transitions standalone (r), pep (r) 830
+
+universal.ExposeInternals Reader (r) 840
+
+references.DanglingReferences standalone (r), pep (r) 850
+
+universal.Messages Writer (w) 860
+
+universal.FilterMessages Writer (w) 870
+
+universal.TestMessages DocutilsTestSupport 880
+
+misc.CallBack n/a 990
+============================== ============================ ========
+
+Key:
+
+* (r): Reader
+* (w): Writer
+* (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)
+==== ==== ================================================