summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-06-14 16:09:29 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-06-14 16:09:29 +0000
commit34cefeef7b44bd4d9448c9c72137e380a31ae1b8 (patch)
tree7bbb29b91efd669901389ca9f47e17bd0d89ebce /docutils/docs/user
parent7874929593e353f6f9dd51a10f6696754bdef370 (diff)
downloaddocutils-34cefeef7b44bd4d9448c9c72137e380a31ae1b8.tar.gz
Document planned switch of the default HTML writer in Docutils 2.0.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9071 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/html.txt13
-rw-r--r--docutils/docs/user/tools.txt5
2 files changed, 10 insertions, 8 deletions
diff --git a/docutils/docs/user/html.txt b/docutils/docs/user/html.txt
index d5099c10a..0ec334de5 100644
--- a/docutils/docs/user/html.txt
+++ b/docutils/docs/user/html.txt
@@ -10,10 +10,11 @@ html
----
`html` is an alias for the default Docutils HTML writer.
-Currently, `html` is mapped to html4css1_.
-The target may change with the development of HTML, browsers, Docutils, and
-the web.
+The default may change with the development of HTML, browsers, Docutils,
+and the web.
+Currently, `html` is mapped to html4css1_, it will become an alias for
+html5_ in Docutils 2.0.
* Use ``get_writer_by_name('html')`` or the rst2html.py_ front end, if you
want the output to be up-to-date automatically.
@@ -88,10 +89,10 @@ S5_, the “Simple Standards-based Slide Show System” by Eric Meyer. See
.. _theme: tools.html#themes
-html5_polyglot
---------------
+html5
+-----
-:aliases: html5
+:aliases: _`html5_polyglot`
:front-end: rst2html5.py_
:config: `[html5 writer]`_
diff --git a/docutils/docs/user/tools.txt b/docutils/docs/user/tools.txt
index 12dffa0fb..5577fd8e3 100644
--- a/docutils/docs/user/tools.txt
+++ b/docutils/docs/user/tools.txt
@@ -156,7 +156,8 @@ rst2html.py
`rst2html.py` is the front-end for the default Docutils HTML writer.
The default writer may change with the development of HTML, browsers,
-Docutils, and the web. Currently, it is html4css1_.
+Docutils, and the web.
+The current default is html4css1_, it will change to html5_ in Docutils 2.0.
.. caution::
Use a specific front end like rst2html4.py_ or rst2html5.py_,
@@ -223,7 +224,7 @@ Correct rendering of elements not directly supported by HTML depends on a
CSS style sheet. The provided style sheets ``minimal.css`` and ``plain.css``
define required and optional styling rules respectively.
-.. _html5: html.html#html5-polyglot
+.. _html5: html.html#html5
rstpep2html.py
--------------