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

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

Revision: 9619
          http://sourceforge.net/p/docutils/code/9619
Author:   milde
Date:     2024-04-09 15:18:31 +0000 (Tue, 09 Apr 2024)
Log Message:
-----------
Announce change to "refname" doctree element handling.

In Docutils 1.0, we will
keep case information of in "refname" attributes the Document Tree
and remove the "name" attribute of the `<reference>` element.

* As before, resolving cross-references for hyperlinks, footnotes, and citations ignores case.

* Custom "unknown_reference_resolvers" (added by 3rd party code, e.g., the MaoinMoin wiki)
  have access to the original casing of the reference name without the need for a separate attribute.

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

Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt	2024-04-09 13:50:34 UTC (rev 9618)
+++ trunk/docutils/RELEASE-NOTES.txt	2024-04-09 15:18:31 UTC (rev 9619)
@@ -46,6 +46,16 @@
     https://packaging.python.org/en/latest/specifications/entry-points/
 
 
+Document Tree / Docutils DTD
+----------------------------
+
+* Do not lowercase reference names in the `refname attribute`_
+  (matching hyperlinks, footnotes, and citations remains case insensitive),
+  and drop the ``name`` attribute from <reference> nodes
+  in Docutils 1.0.
+
+.. _refname attribute: docs/ref/doctree.html#refname
+
 `Input encoding`_
 -----------------
 

Modified: trunk/docutils/docs/ref/doctree.txt
===================================================================
--- trunk/docutils/docs/ref/doctree.txt	2024-04-09 13:50:34 UTC (rev 9618)
+++ trunk/docutils/docs/ref/doctree.txt	2024-04-09 15:18:31 UTC (rev 9619)
@@ -4143,18 +4143,19 @@
 ``name``
 =========
 
-Attribute type: `%refname.type;`_ or `NMTOKEN`_.
+Attribute type: `NMTOKEN`_ or `CDATA`_.
 Default value: none.
 
-The ``name`` attribute in the `\<reference>`_ element accepts
-`%refname.type;`_ values.
-Case is preserved (but ignored when resolving reference names).
-
 The ``name`` attribute in the `\<meta>`_ element accepts `NMTOKEN`_ values.
 The output format may limit valid values to a set of keywords
 (EnumeratedType_).
 
+The ``name`` attribute in the `\<reference>`_ element holds the
+`reference name`_ of the referenced element.  Whitespace is normalized
+but case is preserved.  The attribute will no longer be used with
+<reference> elements in Docutils 1.0.
 
+
 ``names``
 =========
 

Modified: trunk/docutils/docs/ref/docutils.dtd
===================================================================
--- trunk/docutils/docs/ref/docutils.dtd	2024-04-09 13:50:34 UTC (rev 9618)
+++ trunk/docutils/docs/ref/docutils.dtd	2024-04-09 15:18:31 UTC (rev 9619)
@@ -635,7 +635,8 @@
 <!ELEMENT math (#PCDATA)>
 <!ATTLIST math %basic.atts;>
 
-<!-- Can also be a body element, when it contains an "image" element. -->
+<!-- Can also be a body element, when it contains an "image" element.
+     "name" will be removed from the ATTLIST in Docutils 1.0 -->
 <!ELEMENT reference %text.model;>
 <!ATTLIST reference
     name      CDATA     #IMPLIED

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