summaryrefslogtreecommitdiff
path: root/docutils/docs/ref
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-06-19 14:01:03 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-06-19 14:01:03 +0000
commit1b56eb8a75ecf18990cfe7ce4a67d1db4bd331ac (patch)
tree4829de4b5df92fca1084eeaf0d6b3bc4f83dfd5c /docutils/docs/ref
parentdaebf5386e8f571a56039e5cb5043084089703f7 (diff)
downloaddocutils-1b56eb8a75ecf18990cfe7ce4a67d1db4bd331ac.tar.gz
Announce use of dpub-ARIA role "doc-footnote"
instead of ARIA role "note" for footnotes in Docutils 0.20. Cf. [bugs:#450]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9080 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
-rw-r--r--docutils/docs/ref/doctree.txt22
1 files changed, 12 insertions, 10 deletions
diff --git a/docutils/docs/ref/doctree.txt b/docutils/docs/ref/doctree.txt
index f16021629..14410a4ea 100644
--- a/docutils/docs/ref/doctree.txt
+++ b/docutils/docs/ref/doctree.txt
@@ -2263,23 +2263,25 @@ Details
The `DocBook "footnote"`_ element combines features of ``footnote``
and footnote_reference_.
+
+ The DPub ARIA role `"doc-footnote"`__ may be used to mark a (conforming__)
+ `HTML emulation`__ as "ancillary information, such as a citation or
+ commentary, that provides additional context to a referenced passage
+ of text".
- The `ARIA role "note"`__ may be used to mark a (conforming__)
- `HTML emulation`__ as "a section whose content is parenthetic or
- ancillary to the main content of the resource".
+ For collections of notes that occur at the end of a section, the
+ the DPub ARIA role `"doc-endnotes"`__ is more appropriate.
- Depending on the note's position, the `epub:type`__ *footnote* or
- *endnote* and the DPub ARIA role `"doc-footnote"`__ or
- `"doc-endnote"`__ may be applicable.
+ The corresponding types in the `EPUB 3 Structural Semantics
+ Vocabulary`__ are "footnote" and "endnote".
.. _DocBook "footnote": https://tdg.docbook.org/tdg/5.1/footnote.html
- __ https://www.w3.org/TR/wai-aria-1.1/#note
+ __ https://www.w3.org/TR/dpub-aria-1.0/#doc-footnote
__ https://www.w3.org/TR/html-aria/#docconformance
__ https://www.w3.org/TR/html51/
common-idioms-without-dedicated-elements.html#footnotes
- __ https://idpf.github.io/epub-vocabs/structure/#notes
- __ https://www.w3.org/TR/dpub-aria-1.0/#doc-footnote
- __ https://www.w3.org/TR/dpub-aria-1.0/#doc-endnote
+ __ https://www.w3.org/TR/dpub-aria-1.0/#doc-endnotes
+ __ https://www.w3.org/TR/epub-ssv-11/#notes
:Processing:
A ``footnote`` element should be set off from the rest of the