release 0.22rc1 is out
engelbert gruber <[email protected]> Tue, 6 May 2025 19:29:17 +0200
| Newsgroups | gmane.text.docutils.user,gmane.text.docutils.devel |
|---|---|
| Message-ID | <CAHnbgBMmawb9vKn4j=Auc0CqUMbBF00wjAms3iOD6hQxZK76Sg@mail.gmail.com> |
--===============8762481345106385631==
Content-Type: multipart/alternative; boundary="000000000000683f7806347af5f4"
--000000000000683f7806347af5f4
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
hei everyone
please try and test.
Many changes for details see https://docutils.sourceforge.io/HISTORY.html
reStructuredText:
- Support `CSS3 units`_. This adds "ch", "rem", "vw", "vh", "vmin",
"vmax", and "Q" to the `supported length units`__. Note that some
output formats don't support all units.
- New option "figname" for the `"figure"`_ directive.
.. _CSS3 units: https://www.w3.org/TR/css-values-3/#lengths
__ docs/ref/rst/restructuredtext.html#length-units
Document Tree / Docutils DTD
- Allow multiple <term> elements in a `\<definition_list_item>`__
(third-party writers may need adaption).
- The first element in a <figure> may also be a <reference>
(with nested "clickable" <image>).
__ docs/ref/doctree.html#definition-list-item
Configuration changes
- Make MathML the default math_output_ for the "html5" writer.
- Change the default input_encoding_ from ``None`` (auto-detect) to
"utf-8".
- Drop short options ``-i`` and ``-o``.
Use the long equivalents ``--input-encoding`` and ``--output-encoding``=
.
(See `command line interface`_ for the rationale.)
- Rename configuration setting "output" to "output_path_".
- The manpage writer now recognizes the sections [writers] and
[manpage writer] with the new setting `text_references`_.
Output changes
LaTeX:
Don't wrap references with custom reference-label_ in a ``\hyperref``
command. The "hyperref" package generates hyperlinks for labels by
default, so there is no change in the PDF (except for "ref*").
Stop requiring "ifthen.sty". Replace use of
``\ifthenelse{\isundefined...`` with the eTeX primitive ``\ifdefined``=
.
HTML5:
Unitless image_ size measures__ are written as <img> "width" and
"hight" values instead of "style" rules. The current behaviour
is kept for values with units, so users may specify, e.g. ``:width:
50px`` instead of ``:width: 50`` to override CSS stylesheet rules.
__ docs/ref/doctree.html#measure
manpage:
Don't UPPERCASE section headings.
Handle hyperlink references (see text_references_).
null:
The "null" writer output changed from None to the empty string.
`publish_string()` now returns a `bytes` or `str` instance
for all writers (as documented).
New objects
`parsers.docutils_xml`
parser for `Docutils XML`_ (e.g., the output of the "xml" writer).
Provisional.
Try ``docutils --parser=3Dxml test/data/multiple-term-definitions.xml`=
`
or use the :parser: option of the `"include"`_ directive to include
an XML file in a rST document.
`nodes.Element.validate()`
Raise `nodes.ValidationError` if the element does not comply with
the `Docutils Document Model`_.
Provisional.
`writers.DoctreeTranslator`
Generic Docutils document tree translator base class with
`uri2path()` auxiliary method.
Provisional.
Removed objects
`core.Publisher.setup_option_parser()`
internal, obsolete,
`frontend.ConfigParser.get_section()`
obsoleted by the configparser's "Mapping Protocol Access",
`frontend.OptionParser.set_defaults_from_dict()`
obsolete,
`nodes.Element.set_class()`
obsolete, append to Element['classes'] directly,
`parsers.rst.directives.tables.CSVTable.decode_from_csv()`
not required with Python 3,
`parsers.rst.directives.tables.CSVTable.encode_from_csv()`
not required with Python 3,
`transforms.writer_aux.Compound`
not used since Dec 2010,
`utils.error_reporting`
obsolete in Python 3,
`utils.Reporter.set_conditions()`
obsolete, set attributes via configuration settings or directly.
Removed localisations
Mistranslations of the "admonition" directive name:
Use "advies" (af), "varsel" (da), "warnhinweis" (de), "aviso" (es),
"sciigo" (eo), "annonce" (fr), "avviso" (it), "advies" (nl),
"zauwa=C5=BCenie" (pl) (introduced in Docutils 0.21)
or the English name "admonition".
New files
``docutils/parsers/rst/include/html-roles.txt``
`Standard definition file`_ for additional roles matching HTML tags.
Removed files
``tools/rst2odt_prepstyles.py``
Obsoleted by `writers.odf_odt.prepstyles`.
``docutils/utils/roman.py``
Obsoleted by ``docutils/utils/_roman_numerals.py``
Bugfixes and improvements (see HISTORY_).
--000000000000683f7806347af5f4
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
<div dir=3D"ltr"><div>hei everyone</div><div><br></div><div>please try and =
test.</div><div><br></div><div>Many changes for details see <a href=3D"http=
s://docutils.sourceforge.io/HISTORY.html">https://docutils.sourceforge.io/H=
ISTORY.html</a></div><div><br></div><div><br>reStructuredText:<br>=C2=A0 - =
Support `CSS3 units`_. This adds "ch", "rem", "vw&=
quot;, "vh", "vmin",<br>=C2=A0 =C2=A0 "vmax",=
and "Q" to the `supported length units`__. Note that some<br>=C2=
=A0 =C2=A0 output formats don't support all units.<br><br>=C2=A0 - New =
option "figname" for the `"figure"`_ directive.<br><br>=
=C2=A0 .. _CSS3 units: <a href=3D"https://www.w3.org/TR/css-values-3/#lengt=
hs">https://www.w3.org/TR/css-values-3/#lengths</a><br>=C2=A0 __ docs/ref/r=
st/restructuredtext.html#length-units<br><br>Document Tree / Docutils DTD<b=
r>=C2=A0 - Allow multiple <term> elements in a `\<definition_list_=
item>`__<br>=C2=A0 =C2=A0 (third-party writers may need adaption).<br>=
=C2=A0 - The first element in a <figure> may also be a <reference&=
gt;<br>=C2=A0 =C2=A0 (with nested "clickable" <image>).<br>=
<br>=C2=A0 __ docs/ref/doctree.html#definition-list-item<br><br>Configurati=
on changes<br>=C2=A0 - Make MathML the default math_output_ for the "h=
tml5" writer.<br><br>=C2=A0 - Change the default input_encoding_ from =
``None`` (auto-detect) to "utf-8".<br><br>=C2=A0 - Drop short opt=
ions ``-i`` and ``-o``.<br>=C2=A0 =C2=A0 Use the long equivalents ``--input=
-encoding`` and ``--output-encoding``.<br>=C2=A0 =C2=A0 (See `command line =
interface`_ for the rationale.)<br><br>=C2=A0 - Rename configuration settin=
g "output" to "output_path_".<br><br>=C2=A0 - The manpa=
ge writer now recognizes the sections [writers] and<br>=C2=A0 =C2=A0 [manpa=
ge writer] with the new setting `text_references`_.<br><br>Output changes<b=
r>=C2=A0 LaTeX:<br>=C2=A0 =C2=A0 =C2=A0Don't wrap references with custo=
m reference-label_ in a ``\hyperref``<br>=C2=A0 =C2=A0 =C2=A0command. The &=
quot;hyperref" package generates hyperlinks for labels by<br>=C2=A0 =
=C2=A0 =C2=A0default, so there is no change in the PDF (except for "re=
f*").<br><br>=C2=A0 =C2=A0 =C2=A0Stop requiring "ifthen.sty"=
. Replace use of<br>=C2=A0 =C2=A0 =C2=A0``\ifthenelse{\isundefined...`` wit=
h the eTeX primitive ``\ifdefined``.<br><br>=C2=A0 HTML5:<br>=C2=A0 =C2=A0 =
=C2=A0Unitless image_ size measures__ are written as <img> "widt=
h" and<br>=C2=A0 =C2=A0 =C2=A0"hight" values instead of &quo=
t;style" rules.=C2=A0 The current behaviour<br>=C2=A0 =C2=A0 =C2=A0is =
kept for values with units, so users may specify, e.g. ``:width:<br>=C2=A0 =
=C2=A0 =C2=A050px`` instead of ``:width: 50`` to override CSS stylesheet ru=
les.<br><br>=C2=A0 =C2=A0 =C2=A0__ docs/ref/doctree.html#measure<br><br>=C2=
=A0 manpage:<br>=C2=A0 =C2=A0 =C2=A0Don't UPPERCASE section headings.<b=
r>=C2=A0 =C2=A0 =C2=A0Handle hyperlink references (see text_references_).<b=
r><br>=C2=A0 null:<br>=C2=A0 =C2=A0 =C2=A0The "null" writer outpu=
t changed from None to the empty string.<br><br>=C2=A0 =C2=A0 =C2=A0`publis=
h_string()` now returns a `bytes` or `str` instance<br>=C2=A0 =C2=A0 =C2=A0=
for all writers (as documented).<br><br>New objects<br>=C2=A0 `parsers.docu=
tils_xml`<br>=C2=A0 =C2=A0 =C2=A0parser for `Docutils XML`_ (e.g., the outp=
ut of the "xml" writer).<br>=C2=A0 =C2=A0 =C2=A0Provisional.<br><=
br>=C2=A0 =C2=A0 =C2=A0Try ``docutils --parser=3Dxml test/data/multiple-ter=
m-definitions.xml``<br>=C2=A0 =C2=A0 =C2=A0or use the :parser: option of th=
e `"include"`_ directive to include<br>=C2=A0 =C2=A0 =C2=A0an XML=
file in a rST document.<br><br>=C2=A0 `nodes.Element.validate()`<br>=C2=A0=
=C2=A0 =C2=A0Raise `nodes.ValidationError` if the element does not comply =
with<br>=C2=A0 =C2=A0 =C2=A0the `Docutils Document Model`_.<br>=C2=A0 =C2=
=A0 =C2=A0Provisional.<br><br>=C2=A0 `writers.DoctreeTranslator`<br>=C2=A0 =
=C2=A0 =C2=A0Generic Docutils document tree translator base class with<br>=
=C2=A0 =C2=A0 =C2=A0`uri2path()` auxiliary method.<br>=C2=A0 =C2=A0 =C2=A0P=
rovisional.<br><br>Removed objects<br>=C2=A0 `core.Publisher.setup_option_p=
arser()`<br>=C2=A0 =C2=A0 =C2=A0internal, obsolete,<br>=C2=A0 `frontend.Con=
figParser.get_section()`<br>=C2=A0 =C2=A0 =C2=A0obsoleted by the configpars=
er's "Mapping Protocol Access",<br>=C2=A0 `frontend.OptionPar=
ser.set_defaults_from_dict()`<br>=C2=A0 =C2=A0 =C2=A0obsolete,<br>=C2=A0 `n=
odes.Element.set_class()`<br>=C2=A0 =C2=A0 =C2=A0obsolete, append to Elemen=
t['classes'] directly,<br>=C2=A0 `parsers.rst.directives.tables.CSV=
Table.decode_from_csv()`<br>=C2=A0 =C2=A0 =C2=A0not required with Python=C2=
=A03,<br>=C2=A0 `parsers.rst.directives.tables.CSVTable.encode_from_csv()`<=
br>=C2=A0 =C2=A0 =C2=A0not required with Python=C2=A03,<br>=C2=A0 `transfor=
ms.writer_aux.Compound`<br>=C2=A0 =C2=A0 =C2=A0not used since Dec 2010,<br>=
=C2=A0 `utils.error_reporting`<br>=C2=A0 =C2=A0 =C2=A0obsolete in Python=C2=
=A03,<br>=C2=A0 `utils.Reporter.set_conditions()`<br>=C2=A0 =C2=A0 =C2=A0ob=
solete, set attributes via configuration settings or directly.<br><br>Remov=
ed localisations<br>=C2=A0 Mistranslations of the "admonition" di=
rective name:<br>=C2=A0 =C2=A0 =C2=A0Use "advies"=C2=A0(af), &quo=
t;varsel"=C2=A0(da), "warnhinweis"=C2=A0(de), "aviso&qu=
ot;=C2=A0(es),<br>=C2=A0 =C2=A0 =C2=A0"sciigo"=C2=A0(eo), "a=
nnonce"=C2=A0(fr), "avviso"=C2=A0(it), "advies"=C2=
=A0(nl),<br>=C2=A0 =C2=A0 =C2=A0"zauwa=C5=BCenie"=C2=A0(pl) (intr=
oduced in Docutils=C2=A00.21)<br>=C2=A0 =C2=A0 =C2=A0or the English name &q=
uot;admonition".<br><br>New files<br>=C2=A0 ``docutils/parsers/rst/inc=
lude/html-roles.txt``<br>=C2=A0 =C2=A0 =C2=A0`Standard definition file`_ fo=
r additional roles matching HTML tags.<br><br>Removed files<br>=C2=A0 ``too=
ls/rst2odt_prepstyles.py``<br>=C2=A0 =C2=A0 =C2=A0Obsoleted by `writers.odf=
_odt.prepstyles`.<br>=C2=A0 ``docutils/utils/roman.py``<br>=C2=A0 =C2=A0 =
=C2=A0Obsoleted by ``docutils/utils/_roman_numerals.py``<br><br>Bugfixes an=
d improvements (see HISTORY_).<br><br></div></div>
--000000000000683f7806347af5f4--
--===============8762481345106385631==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
--===============8762481345106385631==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline