Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[8631] trunk/docutils
|
From: <mi...@us...> - 2021-03-05 21:14:43
|
Revision: 8631
http://sourceforge.net/p/docutils/code/8631
Author: milde
Date: 2021-03-05 21:14:40 +0000 (Fri, 05 Mar 2021)
Log Message:
-----------
Small documentation updates and fixes.
Modified Paths:
--------------
trunk/docutils/HISTORY.txt
trunk/docutils/RELEASE-NOTES.txt
trunk/docutils/docs/api/publisher.txt
trunk/docutils/docs/dev/distributing.txt
trunk/docutils/docs/dev/todo.txt
trunk/docutils/docs/howto/security.txt
trunk/docutils/docs/ref/rst/directives.txt
trunk/docutils/docs/ref/rst/restructuredtext.txt
trunk/docutils/docs/user/config.txt
trunk/docutils/docs/user/html.txt
trunk/docutils/docs/user/manpage.txt
trunk/docutils/docs/user/odt.txt
trunk/docutils/docs/user/rst/cheatsheet.txt
trunk/docutils/docs/user/rst/demo.txt
trunk/docutils/docs/user/smartquotes.txt
trunk/docutils/docs/user/tools.txt
Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/HISTORY.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -21,16 +21,13 @@
* General
- - Fix bug #385: Import of language modules.
- - Use importlib.import_module() to programmatically import modules.
- - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
- Installing with ``setup.py`` now requires ``setuptools``.
Alternatively, install with `pip`_ (or "manually").
- - Apply patch for bug #399 Fixes in Korean translation.
+ - Use importlib.import_module() to programmatically import modules.
+ - Fix bug #385: Import of language modules.
.. _pip: https://pypi.org/project/pip/
-
* docutils/MANIFEST.in
- Exclude test outputs.
@@ -39,10 +36,11 @@
- VersionInfo: ValueError for invalid values, fix comparison to tuples.
-* docutils/languages/ar.py
- docutils/parsers/rst/languages/ar.py:
+* docutils/languages/
+ docutils/parsers/rst/languages/
- Apply patch # 177 Arabic mappings by Shahin.
+ - Apply patch for bug #399 Fixes in Korean translation.
* docutils/nodes.py
@@ -55,8 +53,8 @@
* docutils/parsers/recommonmark_wrapper.py
- - New file. An experimental wrapper to integrate the
- `recommonmark`__ Markdown parser for use with stock Docutils.
+ - New, experimental wrapper to integrate the
+ `recommonmark`__ Markdown parser for use with Docutils.
__ https://pypi.org/project/recommonmark/
@@ -67,7 +65,6 @@
* docutils/parsers/rst/directives/html.py
- Make "meta" elements available for "latex" and "odt".
- (Basic "odt" support exists, "latex" support is planned.)
* docutils/parsers/rst/directives/misc.py
@@ -89,7 +86,7 @@
- Implement feature request #40 `Option to embed images as data URI`.
-* docutils/writers/html5_polyglot/
+* docutils/writers/html5_polyglot/__init__.py
- Use the new semantic tags <main>, <section>, <header>,
<footer>, <aside>, <figure>, and <figcaption>.
@@ -106,11 +103,6 @@
Use <ins> and <del> if a matching class value
is found in `inline`, `literal`, or `container` elements.
- - ``minimal.css``:
- Move non-essential styling from to ``plain.css``.
- Support "captionbelow" class value for tables.
- Small fixes and tweaks.
-
* docutils/writers/html5_polyglot/responsive.css
- New optional stylesheet that adapts to different screen sizes.
@@ -124,7 +116,23 @@
* 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.
+
* docutils/writers/latex2e/__init__.py:
- Use LaTeX environments for admonitions and "class wrappers" for styling
@@ -138,6 +146,8 @@
__ 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.
Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/RELEASE-NOTES.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -94,7 +94,12 @@
* The generic command line front end ``docutils-cli.py`` allows the
free selection of reader, parser, and writer components.
+
+* New, experimental wrapper to integrate the
+ `recommonmark`__ Markdown parser for use with Docutils.
+ __ https://pypi.org/project/recommonmark/
+
* HTML writers: new option to embed images.
* HTML5 writer:
@@ -112,10 +117,10 @@
Use <ins> and <del> if a matching class value
is found in `inline`, `literal`, or `container` elements.
- - Wrap block-level image elements in <p> (except for figures).
- Move non-essential styling from ``minimal.css`` to ``plain.css``.
- Support numbered figures in ``plain.css``.
+ - New optional style ``responsive.css``, adapts to different screen
+ sizes.
+
.. _initial_header_level: docs/user/config.html#initial-header-level
__ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
Modified: trunk/docutils/docs/api/publisher.txt
===================================================================
--- trunk/docutils/docs/api/publisher.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/api/publisher.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -95,8 +95,7 @@
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 @@
``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,10 +254,10 @@
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`
@@ -264,12 +264,20 @@
``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
------------------------------------
Modified: trunk/docutils/docs/dev/distributing.txt
===================================================================
--- trunk/docutils/docs/dev/distributing.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/dev/distributing.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -33,7 +33,7 @@
* Docutils may optionally make use of the PIL (`Python Imaging
Library`_ or Pillow_). If PIL is present, it is automatically
- detected by Docutils.
+ detected by Docutils.
* Docutils recommends the `Pygments`_ syntax hightlighter. If available, it
is used for highlighting the content of `code directives`_ and roles as
@@ -40,10 +40,15 @@
well as included source code files (with the "code" option to the include_
directive).
+* Docutils can use the `recommonmark`_ parser to parse input in
+ the Markdown format (new in 0.17).
+
.. _Python Imaging Library:
https://en.wikipedia.org/wiki/Python_Imaging_Library
.. _Pillow: https://pypi.org/project/Pillow/
.. _Pygments: http://pygments.org/
+.. _recommonmark: https://pypi.org/project/recommonmark/
+
.. _code directives: ../ref/rst/directives.html#code
.. _include: ../ref/rst/directives.html#include
Modified: trunk/docutils/docs/dev/todo.txt
===================================================================
--- trunk/docutils/docs/dev/todo.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/dev/todo.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -211,10 +211,10 @@
* Perhaps the ``Component.supports`` method should deal with
individual features ("meta" etc.) instead of formats ("html" etc.)?
Currently, only the `<meta> node`_ requires the framework.
-
+
Do we need it at all? Or rather let the writers just ignore some
nodes (like we already do for "class" values)?
-
+
The current implementation of the framework also leads to bug
`bug #241`__ "doctree-based publishing != publish_string".
The "components.Filter" transform is run by publish_doctree(). When
@@ -221,9 +221,9 @@
filtering based on the output format, it should be run by
publish_from_doctree() instead because only then the writer is
known.
-
+
So we need to either remove or fix the framework.
-
+
__ https://sourceforge.net/p/docutils/bugs/241/
@@ -1211,16 +1211,16 @@
At what point should the extensions be substituted?
- Transforms_:
+ Transforms_:
Fits well in the `Reader → Transformer → Writer`__ processing framework.
-
+
* Filename/URL extension replacement can be done walking over the
Document tree transforming the document tree from a valid state
to another valid state.
-
+
* Writer-specific configuration is still possible in the
respective sections of the configuration_ file.
-
+
__ ../peps/pep-0258.html#id24
Pre- or post-processing:
@@ -2855,11 +2855,11 @@
* What about if we don't know which Reader and/or Writer we are
going to use? If the Reader/Writer is specified on the
command-line?
-
+
The dynamic_ front end ``tools/docutils-cli.py`` (new in 0.17) is an
implementation of concept d) below. It uses 2-stage argument parsing
via the `argparse` module's `partial parsing`_. It still needs some
- polishing.
+ polishing.
Perhaps have different types of front ends:
@@ -2882,8 +2882,8 @@
d) _`Dynamic`: Reader and/or Writer are specified by options, with
defaults if unspecified (e.g. ``publish --writer manpage
- [options]``).
-
+ [options]``).
+
Allow common options before subcommands, as in CVS? Or group all
options together? In the case of the `fully qualified`_
front ends, all the options will have to be grouped together
Modified: trunk/docutils/docs/howto/security.txt
===================================================================
--- trunk/docutils/docs/howto/security.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/howto/security.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -22,7 +22,7 @@
have been addressed. This document provides instructions to help you
secure the Docutils software in your applications.
-Docutils does not come in a through-the-web secure state, because this
+**Docutils does not come in a through-the-web secure state**, because this
would inconvenience ordinary users.
__ ../../FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
Modified: trunk/docutils/docs/ref/rst/directives.txt
===================================================================
--- trunk/docutils/docs/ref/rst/directives.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/ref/rst/directives.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -333,7 +333,7 @@
Set a `"classes"`_ attribute value on the figure element. See the
class_ directive below.
-.. _Python Imaging Library:
+.. _Python Imaging Library:
https://en.wikipedia.org/wiki/Python_Imaging_Library
.. _Pillow: https://pypi.org/project/Pillow/
@@ -1875,8 +1875,8 @@
.. note:: Data from some `bibliographic fields`_ is automatically
extracted and stored in META tags, too. However, Bibliographic
Fields are also visible in the document's screen rendering or
- printout.
-
+ printout.
+
For an "invisible" *document title*, see the `metadata document
title`_ directive below.
@@ -1988,7 +1988,7 @@
.. image:: bild.png
- New in Docutils 0.8.
+ (New in Docutils 0.8.)
.. _reference name:
Modified: trunk/docutils/docs/ref/rst/restructuredtext.txt
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/ref/rst/restructuredtext.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -461,10 +461,11 @@
the sections are then lifted up a level or two. See the `DocTitle
transform`_ for details.
-.. [#] The `title`_ configuration setting can set a document title that does
- not become part of the document body.
+.. [#] The `title configuration setting`__ and the `title directive`__
+ set a document title that does not become part of the document body.
-.. _title: ../../user/config.html#title
+ __ ../../user/config.html#title
+ __ directives.html#metadata-document-title
Sections
@@ -3176,6 +3177,7 @@
.. _colspec: ../doctree.html#colspec
.. _thead: ../doctree.html#thead
.. _tbody: ../doctree.html#tbody
+.. _title: ../doctree.html#title
.. _row: ../doctree.html#row
.. _entry: ../doctree.html#entry
.. _identifier key: ../doctree.html#identifier-keys
Modified: trunk/docutils/docs/user/config.txt
===================================================================
--- trunk/docutils/docs/user/config.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/config.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -710,7 +710,7 @@
language_code_, smartquotes_locales_, and the `pre-defined quote sets`__).
Also changes consecutive runs of hyphen-minus and full stops (``---``,
-``--``, ``...``) to em-dash, en-dash and ellipsis Unicode characters
+``--``, ``...``) to em-dash, en-dash, and ellipsis Unicode characters
respectively.
Supported values:
@@ -1573,12 +1573,11 @@
Default: "" (quoting of whitespace and special chars).
Option: ``--literal-block-env``.
-.. [#] A literal-block element, when processed by a Docutils writer might
- have it's origin in literal block following "::" or a
- ``.. parsed-literal::`` directive.
+.. [#] A literal-block element may originate from a `parsed literal`_.
+ A LaTeX verbatim environment is only usable it does not contain
+ inline elements.
- A LaTeX verbatim environment is only usable if there is no other
- markup contained in the literal-block.
+.. _parsed literal: ../ref/rst/directives.html#parsed-literal
reference_label
~~~~~~~~~~~~~~~
Modified: trunk/docutils/docs/user/html.txt
===================================================================
--- trunk/docutils/docs/user/html.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/html.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -108,7 +108,7 @@
.. [#] see also `Benefits of polyglot XHTML5`_
.. [#safetext] The validity of raw HTML and custom stylesheets must be
- ensured by the author (e.g. using `safe text content`_).
+ ensured by the author.
.. _rst2html5.py: tools.html#rst2html5-py
.. _[html5 writer]: config.html#html5-writer
@@ -118,48 +118,20 @@
.. _custom style sheets: ../howto/html-stylesheets.html
.. _viewable with any browser: http://www.anybrowser.org/campaign
.. _Benefits of polyglot XHTML5: http://xmlplease.com/xhtml/xhtml5polyglot/
-.. _safe text content:
- https://www.w3.org/TR/html-polyglot/#dfn-safe-text-content
HTML writers in the sandbox
---------------------------
-There are two more HTML writers in the sandbox_:
+.. _xhtml11:
+There are two more HTML writers in the sandbox_, the `xhtml11 writer`_
+and the `HTML writer for lightweight browsers`_ (_`html4trans`).
+
.. _sandbox: ../dev/policies.html#the-sandbox
-
-xhtml11
-~~~~~~~
-:aliases: xhtml, html4strict
-:front-end: rst2xhtml.py
-:config: `[xhtml11 writer]`
-
-`XHTML 1.1`_ is the latest version of the XML based `extensible
-Hypertext Markup Language` with an official DTD.
-
-The `xhtml11 writer`_ lives in the Docutils sandbox_ since 2008. The output
-conforms to the strict requirements of `XHTML 1.1`_.
-
.. _xhtml11 writer: ../../../sandbox/html4strict/README.html
-
-
-html4trans
-~~~~~~~~~~
-
-:front-end: rst2html_trans.py_
-
-The `HTML writer for lightweight browsers`_ lives in the Docutils sandbox
-(`sandbox/html4trans`_) since 2008. It removes the dependency on CSS. The
-output conforms to `XHTML 1 Transitional`_ and contains sufficient
-formatting information for rendering without style sheet. (Of course, this
-has some drawbacks_.)
-
.. _HTML writer for lightweight browsers:
../../../sandbox/html4trans/README.html
-.. _drawbacks: ../../../sandbox/html4trans/README.html#drawbacks
-.. _sandbox/html4trans: ../../../sandbox/html4trans
-.. _rst2html_trans.py: ../../../sandbox/html4trans/tools/rst2html_trans.py
Overview
@@ -166,7 +138,7 @@
--------
=============== =========== ============== ================= ===========
-name alias(es) `front-end`_ HTML version CSS version
+name aliases `front-end`_ HTML version CSS version
=============== =========== ============== ================= ===========
html4css1_ html4, rst2html4.py, `XHTML 1 `CSS 1`_
html_ rst2html.py Transitional`_
@@ -182,7 +154,7 @@
xhtml11_ xhtml, rst2xhtml.py `XHTML 1.1`_ `CSS 3`_
html4strict
-html4trans_ .. rst2html_trans `XHTML 1 no CSS
+html4trans_ .. rst2html_trans `XHTML 1 no CSS
Transitional`_ required
=============== =========== ============== ================= ===========
Modified: trunk/docutils/docs/user/manpage.txt
===================================================================
--- trunk/docutils/docs/user/manpage.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/manpage.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -1,5 +1,5 @@
==============================
- manpage writer for Docutils_
+ manpage writer for Docutils_
==============================
:Author: Engelbert Gruber
@@ -8,10 +8,13 @@
:Date: $Date$
:Copyright: This document has been placed in the public domain.
-This tries to explore the posibilities to generate man-pages from
+This writer explores the posibilities to generate man-pages from
reStructuredText. Man pages are the way for Unix systems to provide
help to the user. GNU does this with (TeX)info-pages.
+.. contents::
+
+
Module information
''''''''''''''''''
@@ -26,17 +29,17 @@
mandatory, see References_.
man pages look like::
-
+
man(1) Man Pager Utils man(1)
-
+
NAME
man - an interface to the on-line reference manuals
-
+
SYNOPSIS
man [-c|-w|-tZT device] [-adhu7V] [-m system[,...]] [-L locale]
-
+
in roff formatting::
-
+
.TH man 1 "14 May 2001" "2.3.19" "Manual pager utils"
.SH NAME
man \- an interface to the on-line reference manuals
@@ -46,9 +49,9 @@
.RB [\| \-c \||\| \-w \||\| \-tZT
.IR device \|]
-This means we have
+This means we have
-* a title "man"
+* a title "man"
* a subtitle "an interface to the on-line reference manuals"
* a manual section "1"
* a manual group "Manual pager utils"
@@ -65,7 +68,7 @@
Conventions
'''''''''''
-* man pages have a special structure and organization. From the manpage
+* man pages have a special structure and organization. From the manpage
to *man*::
The table below shows the section numbers of the manual followed by the
@@ -105,17 +108,17 @@
* new lines in general.
Consecutive blank lines are merged by the viewer but not on printouts.
- So one has to be cautious. This is most disturbing when printing
+ So one has to be cautious. This is most disturbing when printing
postscript.
.. NOTE::
1. Roff requests only work when at line start.
- 2. But consecutive blank lines are merged by the viewer but not on
+ 2. But consecutive blank lines are merged by the viewer but not on
printouts.
- So try the rule start new lines in ``visit_``-functions, but only if
- necessary. E.g. ``field-names`` are already on a new line because of
+ So try the rule start new lines in ``visit_``-functions, but only if
+ necessary. E.g. ``field-names`` are already on a new line because of
docutils structure.
* Indentation, left margin:
@@ -150,7 +153,7 @@
* How to write long syntax lines.
* Line ends around email or web addresses in texts.
How to distinguish something is inline or not ?
-
+
* Images and equations are discouraged.
* Lists in admonitions are not intended.
* Encoding declaration ``'\" t -*- coding: ISO-8859-1 -*-``
@@ -159,5 +162,5 @@
BUT if UTF-8 is declared tables are no longer processed.
* Input and output encoding are problematic at least.
-
+
.. _Docutils: http://docutils.sourceforge.net/
Modified: trunk/docutils/docs/user/odt.txt
===================================================================
--- trunk/docutils/docs/user/odt.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/odt.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -67,7 +67,8 @@
$ rst2odt.py -s -g python_comments.txt python_comments.odt
- $ rst2odt.py --source-url=odtwriter.txt --generator --stylesheet=/myconfigs/styles.odt odtwriter.txt odtwriter.odt
+ $ rst2odt.py --source-url=odtwriter.txt --generator \
+ --stylesheet=/myconfigs/styles.odt odtwriter.txt odtwriter.odt
Configuration file
@@ -744,7 +745,8 @@
using the ``--stylesheet`` option in order to include your
custom style definitions. For example::
- rst2odt.py --odf-config-file=mymappingfile.ini --stylesheet=mystyles.odt mydoc.txt mydoc.odt
+ rst2odt.py --odf-config-file=mymappingfile.ini \
+ --stylesheet=mystyles.odt mydoc.txt mydoc.odt
Classes
@@ -1013,15 +1015,20 @@
.. raw:: odt
- <text:p text:style-name="rststyle-textbody">Determining <text:span text:style-name="rststyle-emphasis">which</text:span> namespace a name is in is static. It can be
- determined by a lexical scan of the code. If a variable is assigned a
- value <text:span text:style-name="rststyle-emphasis">anywhere</text:span> in a scope (specifically within a function or method
- body), then that variable is local to that scope. If Python does not
- find a variable in the local scope, then it looks next in the global
- scope (also sometimes called the module scope) and then in the
- built-ins scope. But, the <text:span text:style-name="rststyle-inlineliteral">global</text:span> statement can be used to force
- Python to find and use a global variable (a variable defined at top
- level in a module) rather than create a local one.</text:p>
+ <text:p text:style-name="rststyle-textbody">Determining
+ <text:span text:style-name="rststyle-emphasis">which</text:span>
+ namespace a name is in is static. It can be determined by a
+ lexical scan of the code. If a variable is assigned a value
+ <text:span text:style-name="rststyle-emphasis">anywhere</text:span>
+ in a scope (specifically within a function or method body),
+ then that variable is local to that scope. If Python does
+ not find a variable in the local scope, then it looks next
+ in the global scope (also sometimes called the module scope)
+ and then in the built-ins scope. But, the
+ <text:span text:style-name="rststyle-inlineliteral">global</text:span>
+ statement can be used to force Python to find and use a global
+ variable (a variable defined at top level in a module) rather
+ than create a local one.</text:p>
The meta directive
Modified: trunk/docutils/docs/user/rst/cheatsheet.txt
===================================================================
--- trunk/docutils/docs/user/rst/cheatsheet.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/rst/cheatsheet.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -100,7 +100,7 @@
header, footer Create document decorations [0.3.8]
target-notes Create an explicit footnote for each external target
math Mathematical notation (input in LaTeX format)
-meta HTML-specific metadata
+meta Document metadata
include Read an external reST file as if it were inline
raw Non-reST data passed untouched to the Writer
replace Replacement text for substitution definitions
Modified: trunk/docutils/docs/user/rst/demo.txt
===================================================================
--- trunk/docutils/docs/user/rst/demo.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/rst/demo.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -517,6 +517,26 @@
This construct is called a *compound paragraph* and can be produced
with the "compound" directive.
+Meta
+````
+
+The `“meta” directive`__ is used to specify metadata to be stored in,
+e.g., HTML META tags or ODT file properties.
+
+.. hint::
+ Use a `viewport meta tag`__ to tell mobile browsers
+ to use the device-width as viewport.
+
+.. meta::
+ :keywords: reStructuredText, test, parser
+ :description lang=en: A test document, containing at least one
+ example of each reStructuredText construct.
+ :viewport: width=device-width, initial-scale=1
+
+__ https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata
+__ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
+
+
Substitution Definitions
------------------------
Modified: trunk/docutils/docs/user/smartquotes.txt
===================================================================
--- trunk/docutils/docs/user/smartquotes.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/smartquotes.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -88,6 +88,8 @@
[#x-altquot]_
There is built-in support for the following languages:\ [#smartquotes-locales]_
+.. class:: run-in
+
:af: .. class:: language-af
"'Afrikaans' quotes"
@@ -142,8 +144,7 @@
:en-uk-x-altquot: .. class:: language-en-uk-x-altquot
- "'British' alternative quotes"
- (swaps single and double quotes: ``"`` → ‘ and ``'`` → “)
+ "'British' alternative quotes" (swaps single and double quotes)
:eo: .. class:: language-eo
@@ -262,7 +263,7 @@
"'Dutch' alternative quotes"
-.. # 'nl-x-altquot2': u'””’’',
+ .. # 'nl-x-altquot2': u'””’’',
:pl: .. class:: language-pl
Modified: trunk/docutils/docs/user/tools.txt
===================================================================
--- trunk/docutils/docs/user/tools.txt 2021-03-05 21:14:20 UTC (rev 8630)
+++ trunk/docutils/docs/user/tools.txt 2021-03-05 21:14:40 UTC (rev 8631)
@@ -78,7 +78,7 @@
:Readers: Standalone, PEP
:Parser: reStructuredText
-:Writers: html_, pep_html_
+:Writers: html_, html5_, pep_html_
Use ``buildhtml.py`` to generate ``*.html`` from all the ``*.txt`` files
(including PEPs) in each <directory> given, and their subdirectories
@@ -178,7 +178,7 @@
:Reader: Standalone
:Parser: reStructuredText
-:Writer: _`html5` (html5_polyglot_)
+:Writer: html5_
The ``rst2html5.py`` front end reads standalone reStructuredText source
files and produces `HTML 5`_ output.
@@ -186,7 +186,7 @@
CSS style sheet. The provided style sheets ``minimal.css`` and ``plain.css``
define required and optional styling rules respectively.
-.. _html5_polyglot: html.html#html5-polyglot
+.. _html5: html.html#html5-polyglot
rstpep2html.py
--------------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
