summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-05-13 14:39:18 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-05-13 14:39:18 +0000
commit00a0cb9d95bf676ef65fd578dffc34f30cd5b36c (patch)
treef75f7328524146828bdacfeab97b24cc4f8b5912
parentb1a5fb0ec2431e34a186de6a0d1dc76159860fa4 (diff)
downloaddocutils-00a0cb9d95bf676ef65fd578dffc34f30cd5b36c.tar.gz
Documentation fix.
Fix internal links in "directives" doc. Add links to description of differences between html4css1 and html5 writers. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9385 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
-rw-r--r--docutils/docs/ref/rst/directives.txt10
-rw-r--r--docutils/docs/user/html.txt10
2 files changed, 15 insertions, 5 deletions
diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt
index 3cf29e3b7..ed2cc919e 100644
--- a/docutils/docs/ref/rst/directives.txt
+++ b/docutils/docs/ref/rst/directives.txt
@@ -361,7 +361,7 @@ In addition, the following options are recognized:
``figclass`` : space separated list of `class names`_
Set a `"classes"`_ attribute value on the figure element. See the
- class_ directive below.
+ `class directive`_ below.
.. _Python Imaging Library:
.. _Pillow: https://pypi.org/project/Pillow/
@@ -1100,7 +1100,7 @@ The following options are recognized:
``class`` : text_ (list of `class names`_)
Set a `"classes"`_ attribute value on the topic element. See the
- class_ directive below.
+ `class directive`_ below.
.. _sectnum:
@@ -1609,6 +1609,8 @@ and the common option class_.
.. _"raw" role: roles.html#raw
+.. _class directive:
+
Class
=====
@@ -1846,7 +1848,7 @@ base roles:
(``inline``, or element associated with a base class) when the
custom interpreted text role is used. If no directive options are
specified, a "class" option with the directive argument (role
- name) as the value is implied. See the class_ directive above.
+ name) as the value is implied. See the `class directive`_ above.
Specific base roles may support other options and/or directive
content. See the `reStructuredText Interpreted Text Roles`_ document
@@ -2023,7 +2025,7 @@ options:
``class`` : space separated list of `class names`_
Set a `"classes"`_ attribute value on the doctree element generated by
- the directive. See also the class_ directive.
+ the directive. See also the `class directive`_.
.. _name:
diff --git a/docutils/docs/user/html.txt b/docutils/docs/user/html.txt
index df151ae5e..b18a0da0e 100644
--- a/docutils/docs/user/html.txt
+++ b/docutils/docs/user/html.txt
@@ -101,6 +101,9 @@ html5
The ``html5_polyglot`` writer generates `polyglot HTML`_ [#]_ output, valid
XML [#safetext]_ that is compatible with `HTML5`_. New features and elements
are used if they are widely supported.
+See the `HTML5 test page`_ (and the sources `html5-features.txt`_ and
+`html5-text-level-tags.txt`_) for further differences to the html4css1_
+writer.
There is no hard-coded formatting information in the HTML document.
Correct rendering of elements not directly supported by HTML depends on a
@@ -114,7 +117,12 @@ New in Docutils 0.13
.. [#] see also `Benefits of polyglot XHTML5`_
.. [#safetext] The validity of raw HTML and custom stylesheets must be
ensured by the author.
-
+.. _HTML5 test page: https://docutils.sourceforge.io/test/functional/
+ expected/standalone_rst_html5.html#changes-to-the-html4css1-writer
+.. _html5-features.txt: https://docutils.sourceforge.io/test/functional/
+ input/data/html5-features.txt
+.. _html5-text-level-tags.txt: https://docutils.sourceforge.io/test/functional/
+ input/data/html5-text-level-tags.txt
.. _rst2html5.py: tools.html#rst2html5-py
.. _[html5 writer]: config.html#html5-writer
.. _minimal.css: ../../docutils/writers/html5_polyglot/minimal.css