[Docutils-checkins] SF.net SVN: docutils:[8727] trunk/docutils

[<mi...@us...>]

Revision: 8727
          http://sourceforge.net/p/docutils/code/8727
Author:   milde
Date:     2021-05-18 21:33:04 +0000 (Tue, 18 May 2021)
Log Message:
-----------
Small documentation update.

restructuredtext.txt:
  Clarify which elements may come before the docinfo.

Add missing classes in "transforms.universal" docstring.

Modified Paths:
--------------
    trunk/docutils/docs/ref/rst/restructuredtext.txt
    trunk/docutils/docutils/transforms/universal.py

Modified: trunk/docutils/docs/ref/rst/restructuredtext.txt
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.txt	2021-05-17 20:29:35 UTC (rev 8726)
+++ trunk/docutils/docs/ref/rst/restructuredtext.txt	2021-05-18 21:33:04 UTC (rev 8727)
@@ -905,12 +905,17 @@
 copyright_, date_, organization_, revision_, status_, topic_,
 version_.
 
-When a field list is the first non-comment element in a document
-(after the document title, if there is one), it may have its fields
+When a field list is the first element in a document
+(after the document title, if there is one) [#]_, it may have its fields
 transformed to document bibliographic data.  This bibliographic data
 corresponds to the front matter of a book, such as the title page and
 copyright page.
 
+.. [#] In additon to the document title and subtitle, also comments_,
+   `substitution definitions`_, `hyperlink targets`_, and "header",
+   "footer", "meta", and "raw" directives_ may be placed before the
+   bibliographic fields.
+
 Certain registered field names (listed below) are recognized and
 transformed to the corresponding doctree elements, most becoming child
 elements of the docinfo_ element.  No ordering is required of these
@@ -975,9 +980,9 @@
 
 `Bibliographic fields`_ recognized by the parser are normally checked
 for RCS [#]_ keywords and cleaned up [#]_.  RCS keywords may be
-entered into source files as "$keyword$", and once stored under RCS or
-CVS [#]_, they are expanded to "$keyword: expansion text $".  For
-example, a "Status" field will be transformed to a "status" element::
+entered into source files as "$keyword$", and once stored under RCS,
+CVS [#]_, or SVN [#]_, they are expanded to "$keyword: expansion text $".
+For example, a "Status" field will be transformed to a "status" element::
 
     :Status: $keyword: expansion text $
 
@@ -984,6 +989,7 @@
 .. [#] Revision Control System.
 .. [#] RCS keyword processing can be turned off (unimplemented).
 .. [#] Concurrent Versions System.  CVS uses the same keywords as RCS.
+.. [#] Subversion Versions System. Uses the same keywords as RCS.
 
 Processed, the "status" element's text will become simply "expansion
 text".  The dollar sign delimiters and leading RCS keyword name are

Modified: trunk/docutils/docutils/transforms/universal.py
===================================================================
--- trunk/docutils/docutils/transforms/universal.py	2021-05-17 20:29:35 UTC (rev 8726)
+++ trunk/docutils/docutils/transforms/universal.py	2021-05-18 21:33:04 UTC (rev 8727)
@@ -8,10 +8,15 @@
 Transforms needed by most or all documents:
 
 - `Decorations`: Generate a document's header & footer.
-- `Messages`: Placement of system messages stored in
-  `nodes.document.transform_messages`.
+- `ExposeInternals`: Expose internal attributes.
+- `Messages`: Placement of system messages generated after parsing.
+- `FilterMessages`: Remove system messages below verbosity threshold.
 - `TestMessages`: Like `Messages`, used on test runs.
-- `FinalReferences`: Resolve remaining references.
+- `StripComments`: Remove comment elements from the document tree.
+- `StripClassesAndElements`: Remove elements with classes
+  in `self.document.settings.strip_elements_with_classes`
+  and class values in `self.document.settings.strip_classes`.
+- `SmartQuotes`: Replace ASCII quotation marks with typographic form.
 """
 
 __docformat__ = 'reStructuredText'

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.