SF.net SVN: docutils:[9780 ] trunk/docutils

milde--- via Docutils-checkins <[email protected]>
Newsgroups gmane.text.docutils.cvs
Message-ID <[email protected]>
Revision: 9780
          http://sourceforge.net/p/docutils/code/9780
Author:   milde
Date:     2024-07-28 10:50:12 +0000 (Sun, 28 Jul 2024)
Log Message:
-----------
Announce change to `<footnote>` Doctree element content definition.

The first child, `<label>` will become mandatory to match the
definition/documentation/implementation of footnotes in the
reStructuredText parser and the definition of the `<citation>`
element.

Cf. [bugs:#489]

Modified Paths:
--------------
    trunk/docutils/RELEASE-NOTES.txt
    trunk/docutils/docs/ref/doctree.txt

Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt	2024-07-28 10:50:05 UTC (rev 9779)
+++ trunk/docutils/RELEASE-NOTES.txt	2024-07-28 10:50:12 UTC (rev 9780)
@@ -51,8 +51,11 @@
   in Docutils 1.0.
 
 * Use the ``%tbl.table.att`` parameter entity instead of ``%bodyatt``
-  to customize the <table> element's attribute list in Docutils 1.0.
+  to customize the <table> element's attribute list in Docutils 1.0.
 
+* The <footnote> element's first child (<label>) will become mandatory
+  in Docutils 1.0.
+
 .. _refname attribute: docs/ref/doctree.html#refname
 
 Writers

Modified: trunk/docutils/docs/ref/doctree.txt
===================================================================
--- trunk/docutils/docs/ref/doctree.txt	2024-07-28 10:50:05 UTC (rev 9779)
+++ trunk/docutils/docs/ref/doctree.txt	2024-07-28 10:50:12 UTC (rev 9780)
@@ -1992,7 +1992,7 @@
              `%structure.model`_ parameter entities in their content models
              may contain <footnote>.
 
-:Children:   <footnote> elements begin with an optional `\<label>`_
+:Children:   <footnote> elements begin with an optional [#]_ `\<label>`_
              and contain `body elements`_. ::
 
                  (label?, (%body.elements;)+)
@@ -2004,6 +2004,8 @@
              directly includes <footnote>.  The `%structure.model`_
              parameter entity indirectly includes <footnote>.
 
+.. [#] The footnote label will become mandatory in Docutils 1.0.
+
 Examples
 --------
 

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



_______________________________________________
Docutils-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/docutils-checkins
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.