SF.net SVN: docutils:[9662 ] trunk/docutils/docs/ref/d octree.txt
milde--- via Docutils-checkins <[email protected]>
| Newsgroups | gmane.text.docutils.cvs |
|---|---|
| Message-ID | <[email protected]> |
Revision: 9662
http://sourceforge.net/p/docutils/code/9662
Author: milde
Date: 2024-04-27 17:52:53 +0000 (Sat, 27 Apr 2024)
Log Message:
-----------
Doctree documentation: fix `<topic>` details, reorder category lists.
According to the DTD, the topic title is optional while at least
one child (body) element is required (since at least 2002-04-20).
Change order of element category "details" list to improve readability.
Modified Paths:
--------------
trunk/docutils/docs/ref/doctree.txt
Modified: trunk/docutils/docs/ref/doctree.txt
===================================================================
--- trunk/docutils/docs/ref/doctree.txt 2024-04-27 17:52:41 UTC (rev 9661)
+++ trunk/docutils/docs/ref/doctree.txt 2024-04-27 17:52:53 UTC (rev 9662)
@@ -154,6 +154,7 @@
.. [#] `\<title>`_ is also a valid child of the generic `\<admonition>`_.
+
Decorative Elements
-------------------
@@ -180,8 +181,8 @@
`\<contact>`_, `\<copyright>`_, `\<date>`_,
`\<field>`_, `\<organization>`_, `\<revision>`_,
`\<status>`_, `\<version>`_
+:Docutils class: ``nodes.Bibliographic``
:Parameter entity: `%bibliographic.elements`_
-:Docutils class: ``nodes.Bibliographic``
.. _simple body elements:
@@ -213,11 +214,11 @@
`\<important>`_, `\<line_block>`_, `\<note>`_, `\<option_list>`_,
`\<system_message>`_, `\<table>`_, `\<tip>`_, `\<warning>`_
+:Docutils class: ``nodes.Body``
+
:Parameter entity: `%body.elements`_
-:Docutils class: ``nodes.Body``
-
Body Subelements
----------------
@@ -263,9 +264,9 @@
`\<literal>`_, `\<math>`_, `\<problematic>`_, `\<raw>`_, `\<reference>`_,
`\<strong>`_, `\<subscript>`_, `\<substitution_reference>`_,
`\<superscript>`_, `\<target>`_, `\<title_reference>`_
+:Docutils class: ``nodes.Inline``
:Parameter entity: `%inline.elements`_
-:Docutils class: ``nodes.Inline``
-------------------
@@ -3569,7 +3570,7 @@
:Parents: The following elements may contain <topic>:
`\<document>`_, `\<section>`_, `\<sidebar>`_
-:Children: <topic> elements begin with a `\<title>`_ and may contain
+:Children: <topic> elements may begin with a `\<title>`_ and contain
`body elements`_::
(title?, (%body.elements;)+)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.