summaryrefslogtreecommitdiff
path: root/docutils/docs/api
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-05 21:14:40 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-05 21:14:40 +0000
commit0e0d1fa82e4c03cbdbc07d7bb2071ebab67f82db (patch)
treeb156dedb2db9386d17a51c25f339af69f5e6091b /docutils/docs/api
parent738ea899577f07bbcc96ba58c180331975fdd115 (diff)
downloaddocutils-0e0d1fa82e4c03cbdbc07d7bb2071ebab67f82db.tar.gz
Small documentation updates and fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8631 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
-rw-r--r--docutils/docs/api/publisher.txt30
1 files changed, 19 insertions, 11 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt
index cd63ef168..a747c60ee 100644
--- a/docutils/docs/api/publisher.txt
+++ b/docutils/docs/api/publisher.txt
@@ -95,8 +95,7 @@ details about individual settings.
Encodings
---------
-The default output encoding of Docutils is UTF-8. If you have any
-non-ASCII in your input text, you may have to do a bit more setup.
+The default output encoding of Docutils is UTF-8.
Docutils may introduce some non-ASCII text if you use
`auto-symbol footnotes`_ or the `"contents" directive`_.
@@ -130,10 +129,11 @@ _`whole`
``parts['whole']`` contains the entire formatted document.
-.. _HTML writer:
+Parts Provided By the HTML Writers
+----------------------------------
-Parts Provided By the HTML Writer
----------------------------------
+HTML4 Writer
+````````````
_`body`
``parts['body']`` is equivalent to parts['fragment_']. It is
@@ -254,20 +254,28 @@ _`title`
tags.
-Parts Provided by the PEP/HTML Writer
-`````````````````````````````````````
+PEP/HTML Writer
+```````````````
-The PEP/HTML writer provides the same parts as the `HTML writer`_,
+The PEP/HTML writer provides the same parts as the `HTML4 writer`_,
plus the following:
_`pepnum`
``parts['pepnum']`` contains
-Parts Provided by the S5/HTML Writer
-````````````````````````````````````
+S5/HTML Writer
+``````````````
-The S5/HTML writer provides the same parts as the `HTML writer`_.
+The S5/HTML writer provides the same parts as the `HTML4 writer`_.
+
+
+HTML5 Writer
+````````````
+
+The HTML5 writer provides the same parts as the `HTML4 writer`_.
+However, it uses semantic HTML5 elements for the document, header and
+footer.
Parts Provided by the LaTeX2e Writer