summaryrefslogtreecommitdiff
path: root/docutils
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-09 12:54:13 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-09 12:54:13 +0000
commit5c3b677b4a8d596e73541dc85d6809207242589f (patch)
treef0e6a0c2e123717f85a40e5849c993c50f5d5a95 /docutils
parentd8b162c12527422e33fdc3e21b34c2d6c69fc2b7 (diff)
downloaddocutils-5c3b677b4a8d596e73541dc85d6809207242589f.tar.gz
Small documentation updates and fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8633 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils')
-rw-r--r--docutils/HISTORY.txt43
-rw-r--r--docutils/RELEASE-NOTES.txt8
-rw-r--r--docutils/docs/ref/rst/directives.txt16
3 files changed, 32 insertions, 35 deletions
diff --git a/docutils/HISTORY.txt b/docutils/HISTORY.txt
index f0d7b21ac..b861ef1da 100644
--- a/docutils/HISTORY.txt
+++ b/docutils/HISTORY.txt
@@ -36,11 +36,11 @@ Version 0.17b1
- VersionInfo: ValueError for invalid values, fix comparison to tuples.
-* docutils/languages/
+* docutils/languages/
docutils/parsers/rst/languages/
- Apply patch # 177 Arabic mappings by Shahin.
- - Apply patch for bug #399 Fixes in Korean translation.
+ - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
* docutils/nodes.py
@@ -72,7 +72,8 @@ Version 0.17b1
* docutils/parsers/rst/roles.py
- - Apply patch #174 Lowercase new role names on registration
+ - Apply patch #174 `Lowercase new role names on registration`
+ by John Thorvald Wodder II.
* docutils/utils/smartquotes.py
@@ -102,14 +103,12 @@ Version 0.17b1
is found in `inline` and `literal` elements.
Use <ins> and <del> if a matching class value
is found in `inline`, `literal`, or `container` elements.
-
- - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
- __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
+ - Fix bug #398: properly close link tag to "schema.dcterms".
-* docutils/writers/html5_polyglot/responsive.css
+ - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
- - New optional stylesheet that adapts to different screen sizes.
+ __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
* docutils/writers/html5_polyglot/minimal.css
@@ -120,22 +119,10 @@ Version 0.17b1
* docutils/writers/html5_polyglot/plain.css
- Support numbered figures.
- - Fix bug #398: properly close link tag to "schema.dcterms".
* docutils/writers/html5_polyglot/responsive.css
- - New optional stylesheet for better readability on different
- screens.
-
-* docutils/writers/html5_polyglot/minimal.css
-
- - Move non-essential styling from to ``plain.css``.
- Support "captionbelow" class value for tables.
- Small fixes and tweaks.
-
-* docutils/writers/html5_polyglot/plain.css
-
- - Support numbered figures.
+ - New optional style that adapts to different screen sizes.
* docutils/writers/latex2e/__init__.py:
@@ -151,9 +138,9 @@ Version 0.17b1
__ docs/user/latex.html#custom-interpreted-text-roles
- Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
-
+
- Support the `memoir` LaTeX document class.
- Fixes bugs #390, #391, and #392.
+ Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
- The special value "auto" for the `graphicx_option`_ setting
is no longer supported (it never worked for xetex/luatex).
@@ -173,14 +160,14 @@ Version 0.17b1
- Fix bug #408 "Incorrect assert in latex writer
for multiple citation references".
- - Apply patch #175 "Fix alignment of nested tables",
- additional fixes to table alignment.
+ - Apply patch #175 "Fix alignment of nested tables"
+ by John Thorvald Wodder II. Additional fixes to table alignment.
- Do not write Docutils-generated ToC, when ``use_latex_toc``
is True. (This did happen when publishing from a doctree.)
-
+
- Set PDF document properties from "meta" directive content.
-
+
- Apply version of patch #176 "LaTeX writer: Append \leavevmode to
non-docinfo field names" by John Thorvald Wodder II.
@@ -194,7 +181,7 @@ Version 0.17b1
* docutils/writers/odf_odt/__init__.py:
- Fix/improve metadata handling:
- fix "keyword" splitting,
+ fix "keyword" splitting,
allow generic fields (stored as "Custom Properties").
* docutils/writers/pseudoxml.py:
diff --git a/docutils/RELEASE-NOTES.txt b/docutils/RELEASE-NOTES.txt
index feb8af170..0a3141c35 100644
--- a/docutils/RELEASE-NOTES.txt
+++ b/docutils/RELEASE-NOTES.txt
@@ -26,13 +26,15 @@ Future changes
and/or ``\DUtitle`` or set to "True".
* `html5` writer:
- Use <blockquote> instead of <div> tags for topics and admonitions,
- <aside> instad of <dl> for footnote text and citations,
+ Use <aside> instad of <dl> for footnote text and citations
and <nav> instead of <div> for the Table of Contents.
Use <summary> and <details> tags for term and definition of a
definition list with class value "details".
-
+
+ Move attribution behind the blockquote to comply with
+ https://html.spec.whatwg.org/#the-blockquote-element.
+
* `s5_html` writer:
Remove the IE PNG Fix by Angus Turnbull. IE has native PNG
support since version 7.
diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt
index 353e85436..b38493529 100644
--- a/docutils/docs/ref/rst/directives.txt
+++ b/docutils/docs/ref/rst/directives.txt
@@ -1868,12 +1868,13 @@ Metadata
:Directive Content: Must contain a flat field list.
The "meta" directive is used to specify metadata\ [#]_ to be stored
-in, e.g., HTML META tags or as ODT file properties. If the output
-format does not support "invisible" metadata, it is silently
-dropped by the writer.
+in, e.g., `HTML meta elements`_ or as `ODT file properties`_. The
+LaTeX writer passes it to the ``pdfinfo`` option of the hyperref_
+package. If an output format does not support "invisible" metadata,
+content is silently dropped by the writer.
.. note:: Data from some `bibliographic fields`_ is automatically
- extracted and stored in META tags, too. However, Bibliographic
+ extracted and stored as metadata, too. However, Bibliographic
Fields are also visible in the document's screen rendering or
printout.
@@ -1920,11 +1921,18 @@ HTML equivalent::
<meta http-equiv="Content-Type"
content="text/html; charset=ISO-8859-1">
+
.. [#] "Metadata" is data about data, in this case data about the
document. Metadata is, e.g., used to describe and classify web
pages in the World Wide Web, in a form that is easy for search
engines to extract and collate.
+
+.. _HTML meta elements:
+ https://html.spec.whatwg.org/multipage/semantics.html#the-meta-element
+.. _ODT file properties:
+ https://en.wikipedia.org/wiki/OpenDocument_technical_specification#Metadata
+.. _hyperref: http://ctan.org/pkg/hyperref
.. _bibliographic fields: restructuredtext.html#bibliographic-fields