开源软件构建与测试

Changes of Revision 9

_service:tar_scm:python-docutils.spec Changed

@@ -7,12 +7,12 @@
 to use, what-you-see-is-what-you-get plaintext markup language.
 
 Name:		python-docutils
-Version:	0.17.1
-Release:	3
+Version:	0.20
+Release:	1
 Summary:	Documentation Utilities Written in Python, for General- and Special-Purpose Use
 License:	Public Domain and BSD-2-Clause and Python and GPL-3.0-or-later
 URL:		http://docutils.sourceforge.net
-Source0:	https://files.pythonhosted.org/packages/4c/17/559b4d020f4b46e0287a2eddf2d8ebf76318fd3bd495f1625414b052fdc9/docutils-0.17.1.tar.gz
+Source0:	https://files.pythonhosted.org/packages/e6/a9/8ddfaa7a9414e42520e0041d1354ebda699e4eb1b47e2f1b6d8bda66aba6/docutils-0.20.tar.gz
 BuildArch:	noarch
 
 %description
@@ -23,6 +23,12 @@
 Requires:   python3-lxml
 Provides:	python-docutils = %{version}-%{release}
 BuildRequires:	python3-devel
+BuildRequires:  python3-devel
+BuildRequires:  python3-setuptools
+BuildRequires:  python3-pip
+BuildRequires:  python3-wheel
+BuildRequires:	python3-hatchling
+
 %description -n python3-docutils
 %{_description}
 
@@ -36,10 +42,10 @@
 %autosetup -n docutils-%{version}
 
 %build
-%py3_build
+%pyproject_build
 
 %install
-%py3_install
+%pyproject_install
 install -d -m755 %{buildroot}/%{_pkgdocdir}
 if  -d doc ; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
 if  -d docs ; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
@@ -74,6 +80,8 @@
 %files -n python3-docutils -f filelist.lst
 %dir %{python3_sitelib}/*
 %{_bindir}/rst*
+%{_bindir}/docutils
+%{python3_sitelib}/docutils
 
 %files help -f doclist.lst
 %{_docdir}/*
@@ -81,6 +89,9 @@
 %license COPYING.txt licenses/*.txt
 
 %changelog
+* Thu Jul 27 2023 zhuofeng <zhuofeng2@huawei.com> - 0.20-1
+- Update package to version 0.20
+
 * Sat Mar 4 2023 yanglongkang <yanglongkang@h-partners.com> - 0.17.1-3
 - add requires python3-lxml

_service:tar_scm:docutils-0.17.1.tar.gz/docs/api/cmdline-tool.txt Deleted

@@ -1,66 +0,0 @@
-===============================================
- Inside A Docutils Command-Line Front-End Tool
-===============================================
-
-:Author: David Goodger
-:Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
-:Revision: $Revision: 7302 $
-:Copyright: This document has been placed in the public domain.
-
-`The Docutils Publisher`_ class was set up to make building
-command-line tools easy.  All that's required is to choose components
-and supply settings for variations.  Let's take a look at a typical
-command-line front-end tool, ``tools/rst2html.py``, from top to
-bottom.
-
-On Unixish systems, it's best to make the file executable (``chmod +x
-file``), and supply an interpreter on the first line, the "shebang" or
-"hash-bang" line::
-
-    #!/usr/bin/env python
-
-Windows systems can be set up to associate the Python interpreter with
-the ``.py`` extension.
-
-Next are some comments providing metadata::
-
-    # $Id: cmdline-tool.txt 7302 2012-01-03 19:23:53Z grubert $
-    # Author: David Goodger <goodger@python.org>
-    # Copyright: This module has been placed in the public domain.
-
-The module docstring describes the purpose of the tool::
-
-    """
-    A minimal front end to the Docutils Publisher, producing HTML.
-    """
-
-This next block attempts to invoke locale support for
-internationalization services, specifically text encoding.  It's not
-supported on all platforms though, so it's forgiving::
-
-    try:
-        import locale
-        locale.setlocale(locale.LC_ALL, '')
-    except:
-        pass
-
-The real work will be done by the code that's imported here::
-
-    from docutils.core import publish_cmdline, default_description
-
-We construct a description of the tool, for command-line help::
-
-    description = ('Generates (X)HTML documents from standalone '
-                   'reStructuredText sources.  ' + default_description)
-
-Now we call the Publisher convenience function, which takes over.
-Most of its defaults are used ("standalone" Reader,
-"reStructuredText" Parser, etc.).  The HTML Writer is chosen by name,
-and a description for command-line help is passed in::
-
-    publish_cmdline(writer_name='html', description=description)
-
-That's it!  `The Docutils Publisher`_ takes care of the rest.
-
-.. _The Docutils Publisher: ./publisher.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/transforms.txt Deleted

@@ -1,207 +0,0 @@
-=====================
- Docutils Transforms
-=====================
-
-:Author: David Goodger
-:Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7530 $
-:Date: $Date: 2012-10-16 14:40:36 +0200 (Di, 16. Okt 2012) $
-:Copyright: This document has been placed in the public domain.
-
-
-.. contents::
-
-Transforms change the document tree in-place, add to the tree, or prune it.
-Transforms resolve references and footnote numbers, process interpreted
-text, and do other context-sensitive processing. Each transform is a
-subclass of ``docutils.tranforms.Transform``.
-
-There are `transforms added by components`_, others (e.g.
-``parts.Contents``) are added by the parser, if a corresponding directive is
-found in the document.
-
-To add a transform, components (objects inheriting from
-Docutils.Component like Readers, Parsers, Writers, Input, Output) overwrite
-the ``get_transforms()`` method of their base class. After the Reader has
-finished processing, the Publisher calls
-``Transformer.populate_from_components()`` with a list of components and all
-transforms returned by the component's ``get_transforms()`` method are
-stored in a `transformer object` attached to the document tree.
-
-
-For more about transforms and the Transformer object, see also `PEP
-258`_. (The ``default_transforms()`` attribute of component classes mentioned
-there is deprecated. Use the ``get_transforms()`` method instead.)
-
-.. _PEP 258: ../peps/pep-0258.html#transformer
-
-
-Transforms Listed in Priority Order
-===================================
-
-Transform classes each have a default_priority attribute which is used by
-the Transformer to apply transforms in order (low to high). The default
-priority can be overridden when adding transforms to the Transformer object.
-
-
-==============================  ============================  ========
-Transform: module.Class         Added By                      Priority
-==============================  ============================  ========
-misc.class                      "class" (d/p)                 210
-
-references.Substitutions        standalone (r), pep (r)       220
-
-references.PropagateTargets     standalone (r), pep (r)       260
-
-frontmatter.DocTitle            standalone (r)                320
-
-frontmatter.DocInfo             standalone (r)                340
-
-frontmatter.SectSubTitle        standalone (r)                350
-
-peps.Headers                    pep (r)                       360
-
-peps.Contents                   pep (r)                       380
-
-universal.StripClasses...       Writer (w)                    420
-
-references.AnonymousHyperlinks  standalone (r), pep (r)       440
-
-references.IndirectHyperlinks   standalone (r), pep (r)       460
-
-peps.TargetNotes                pep (r)                       520
-
-references.TargetNotes          peps.TargetNotes (t/p)        0
-
-misc.CallBack                   peps.TargetNotes (t/p)        1
-
-references.TargetNotes          "target-notes" (d/p)          540
-
-references.Footnotes            standalone (r), pep (r)       620
-
-references.ExternalTargets      standalone (r), pep (r)       640
-
-references.InternalTargets      standalone (r), pep (r)       660
-
-parts.SectNum                   "sectnum" (d/p)               710
-
-parts.Contents                  "contents" (d/p),             720
-                                peps.Contents (t/p)
-
-universal.StripComments         Reader (r)                    740
-
-peps.PEPZero                    peps.Headers (t/p)            760
-
-components.Filter               "meta" (d/p)                  780
-
-universal.Decorations           Reader (r)                    820
-
-misc.Transitions                standalone (r), pep (r)       830
-
-universal.ExposeInternals       Reader (r)                    840
-
-references.DanglingReferences   standalone (r), pep (r)       850
-
-universal.Messages              Writer (w)                    860
-
-universal.FilterMessages        Writer (w)                    870
-
-universal.SmartQuotes           Parser                        850
-
-universal.TestMessages          DocutilsTestSupport           880
-
-writer_aux.Compound             newlatex2e (w)                910
-
-writer_aux.Admonitions          html4css1 (w),                920
-                                latex2e (w)
-
-misc.CallBack                   n/a                           990
-==============================  ============================  ========
-
-Key:
-
-* (r): Reader
-* (w): Writer
-* (d): Directive
-* (t): Transform
-* (/p): Via a "pending" node
-
-
-Transform Priority Range Categories
-===================================
-
-====  ====  ================================================
- Priority
-----------  ------------------------------------------------
-From   To   Category
-====  ====  ================================================
-   0    99  immediate execution (added by another transform)
- 100   199  very early (non-standard)
- 200   299  very early
- 300   399  early
- 400   699  main
- 700   799  late
- 800   899  very late
- 900   999  very late (non-standard)
-====  ====  ================================================
-
-
-Transforms added by components
-===============================
-
-
-readers.Reader:
-  | universal.Decorations,
-  | universal.ExposeInternals,
-  | universal.StripComments
-
-readers.ReReader:
-  None
-
-readers.standalone.Reader:
-  | references.Substitutions,
-  | references.PropagateTargets,
-  | frontmatter.DocTitle,
-  | frontmatter.SectionSubTitle,
-  | frontmatter.DocInfo,
-  | references.AnonymousHyperlinks,
-  | references.IndirectHyperlinks,
-  | references.Footnotes,
-  | references.ExternalTargets,
-  | references.InternalTargets,
-  | references.DanglingReferences,
-  | misc.Transitions
-
-readers.pep.Reader:
-  | references.Substitutions,
-  | references.PropagateTargets,
-  | references.AnonymousHyperlinks,
-  | references.IndirectHyperlinks,
-  | references.Footnotes,
-  | references.ExternalTargets,
-  | references.InternalTargets,
-  | references.DanglingReferences,
-  | misc.Transitions,
-  | peps.Headers,
-  | peps.Contents,
-  | peps.TargetNotes
-
-parsers.rst.Parser
-  universal.SmartQuotes
-
-writers.Writer:
-  | universal.Messages,
-  | universal.FilterMessages,
-  | universal.StripClassesAndElements
-
-writers.UnfilteredWriter
-  None
-
-writers.latex2e.Writer
-  writer_aux.Admonitions
-
-writers.html4css1.Writer:
-  writer_aux.Admonitions
-
-writers.odf_odt.Writer:
-  removes references.DanglingReferences

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/blank.gif Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/iepngfix.htc Deleted

@@ -1,42 +0,0 @@
-<public:component>
-<public:attach event="onpropertychange" onevent="doFix()" />
-
-<script>
-
-// IE5.5+ PNG Alpha Fix v1.0 by Angus Turnbull http://www.twinhelix.com
-// Free usage permitted as long as this notice remains intact.
-
-// This must be a path to a blank image. That's all the configuration you need here.
-var blankImg = 'ui/default/blank.gif';
-
-var f = 'DXImageTransform.Microsoft.AlphaImageLoader';
-
-function filt(s, m) {
- if (filtersf) {
-  filtersf.enabled = s ? true : false;
-  if (s) with (filtersf) { src = s; sizingMethod = m }
- } else if (s) style.filter = 'progid:'+f+'(src="'+s+'",sizingMethod="'+m+'")';
-}
-
-function doFix() {
- if ((parseFloat(navigator.userAgent.match(/MSIE (\S+)/)1) < 5.5) ||
-  (event && !/(background|src)/.test(event.propertyName))) return;
-
- if (tagName == 'IMG') {
-  if ((/\.png$/i).test(src)) {
-   filt(src, 'image');  // was 'scale'
-   src = blankImg;
-  } else if (src.indexOf(blankImg) < 0) filt();
- } else if (style.backgroundImage) {
-  if (style.backgroundImage.match(/^url("'+(.*\.png))"'+$/i)) {
-   var s = RegExp.$1;
-   style.backgroundImage = '';
-   filt(s, 'crop');
-  } else filt();
- }
-}
-
-doFix();
-
-</script>
-</public:component>
\ No newline at end of file

_service:tar_scm:docutils-0.17.1.tar.gz/test/DocutilsTestSupport.py Deleted

@@ -1,864 +0,0 @@
-# $Id: DocutilsTestSupport.py 8683 2021-04-09 15:44:23Z milde $
-# Authors: David Goodger <goodger@python.org>;
-#          Garth Kidd <garth@deadlybloodyserious.com>
-# Copyright: This module has been placed in the public domain.
-
-"""
-Exports the following:
-
-:Modules:
-    - `statemachine` is 'docutils.statemachine'
-    - `nodes` is 'docutils.nodes'
-    - `urischemes` is 'docutils.utils.urischemes'
-    - `utils` is 'docutils.utils'
-    - `transforms` is 'docutils.transforms'
-    - `states` is 'docutils.parsers.rst.states'
-    - `tableparser` is 'docutils.parsers.rst.tableparser'
-
-:Classes:
-    - `StandardTestCase`
-    - `CustomTestCase`
-    - `CustomTestSuite`
-    - `TransformTestCase`
-    - `TransformTestSuite`
-    - `ParserTestCase`
-    - `ParserTestSuite`
-    - `ParserTransformTestCase`
-    - `PEPParserTestCase`
-    - `PEPParserTestSuite`
-    - `GridTableParserTestCase`
-    - `GridTableParserTestSuite`
-    - `SimpleTableParserTestCase`
-    - `SimpleTableParserTestSuite`
-    - `WriterPublishTestCase`
-    - `LatexWriterPublishTestCase`
-    - `PseudoXMLWriterPublishTestCase`
-    - `HtmlWriterPublishTestCase`
-    - `PublishTestSuite`
-    - `HtmlFragmentTestSuite`
-    - `DevNull` (output sink)
-"""
-from __future__ import print_function
-__docformat__ = 'reStructuredText'
-
-import sys
-import os
-import unittest
-import re
-import inspect
-import traceback
-import warnings
-from pprint import pformat
-
-testroot = os.path.abspath(os.path.dirname(__file__) or os.curdir)
-os.chdir(testroot)
-sys.path.insert(0, os.path.normpath(os.path.join(testroot, '..')))
-sys.path.append(os.path.normpath(os.path.join(testroot, '..', 'extras')))
-sys.path.insert(0, testroot)
-
-try:
-    import difflib
-    import package_unittest
-    import docutils
-    import docutils.core
-    from docutils import frontend, nodes, statemachine, utils
-    from docutils.utils import urischemes
-    from docutils.transforms import universal
-    from docutils.parsers import rst, recommonmark_wrapper
-    from docutils.parsers.rst import states, tableparser, roles, languages
-    from docutils.readers import standalone, pep
-    from docutils.statemachine import StringList, string2lines
-except ImportError:
-    # The importing module (usually __init__.py in one of the
-    # subdirectories) may catch ImportErrors in order to detect the
-    # absence of DocutilsTestSupport in sys.path.  Thus, ImportErrors
-    # resulting from problems with importing Docutils modules must
-    # caught here.
-    traceback.print_exc()
-    sys.exit(1)
-
-
-try:
-    import mypdb as pdb
-except:
-    import pdb
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
-# Hack to make repr(StringList) look like repr(list):
-StringList.__repr__ = StringList.__str__
-
-
-class DevNull(object):
-
-    """Output sink."""
-
-    def write(self, string):
-        pass
-
-    def close(self):
-        pass
-
-
-class StandardTestCase(unittest.TestCase):
-
-    """
-    Helper class, providing the same interface as unittest.TestCase,
-    but with useful setUp and comparison methods.
-    """
-
-    def setUp(self):
-        os.chdir(testroot)
-
-    def assertEqual(self, first, second, msg=None):
-        """Fail if the two objects are unequal as determined by the '=='
-           operator.
-        """
-        if not first == second:
-            raise self.failureException(
-                msg or '%s != %s' % _format_str(first, second))
-
-    def assertNotEqual(self, first, second, msg=None):
-        """Fail if the two objects are equal as determined by the '=='
-           operator.
-        """
-        if first == second:
-            raise self.failureException(
-                msg or '%s == %s' % _format_str(first, second))
-
-    # aliases for assertion methods, deprecated since Python 2.7
-
-    failUnlessEqual = assertEquals = assertEqual
-
-    assertNotEquals = failIfEqual = assertNotEqual
-
-
-class CustomTestCase(StandardTestCase):
-
-    """
-    Helper class, providing extended functionality over unittest.TestCase.
-
-    The methods assertEqual and assertNotEqual have been overwritten
-    to provide better support for multi-line strings.  Furthermore,
-    see the compare_output method and the parameter list of __init__.
-    """
-
-    compare = difflib.Differ().compare
-    """Comparison method shared by all subclasses."""
-
-    def __init__(self, method_name, input, expected, id,
-                 run_in_debugger=True, suite_settings=None):
-        """
-        Initialise the CustomTestCase.
-
-        Arguments:
-
-        method_name -- name of test method to run.
-        input -- input to the parser.
-        expected -- expected output from the parser.
-        id -- unique test identifier, used by the test framework.
-        run_in_debugger -- if true, run this test under the pdb debugger.
-        suite_settings -- settings overrides for this test suite.
-        """
-        self.id = id
-        self.input = input
-        self.expected = expected
-        self.run_in_debugger = run_in_debugger
-        self.suite_settings = suite_settings.copy() or {}
-
-        # Ring your mother.
-        unittest.TestCase.__init__(self, method_name)
-
-    def __str__(self):
-        """
-        Return string conversion. Overridden to give test id, in addition to
-        method name.
-        """
-        return '%s; %s' % (self.id, unittest.TestCase.__str__(self))
-
-    def __repr__(self):
-        return "<%s %s>" % (self.id, unittest.TestCase.__repr__(self))
-
-    def clear_roles(self):
-        # Language-specific roles and roles added by the
-        # "default-role" and "role" directives are currently stored
-        # globally in the roles._roles dictionary.  This workaround
-        # empties that dictionary.
-        roles._roles = {}
-
-    def setUp(self):
-        StandardTestCase.setUp(self)
-        self.clear_roles()
-
-    def compare_output(self, input, output, expected):
-        """`input`, `output`, and `expected` should all be strings."""
-        if isinstance(input, unicode):
-            input = input.encode('raw_unicode_escape')
-        if sys.version_info > (3, 0):
-            # API difference: Python 3's node.__str__ doesn't escape
-            #assert expected is None or isinstance(expected, unicode)
-            if isinstance(expected, bytes):
-                expected = expected.decode('utf-8')
-            if isinstance(output, bytes):
-                output = output.decode('utf-8')
-        else:
-            if isinstance(expected, unicode):
-                expected = expected.encode('raw_unicode_escape')
-            if isinstance(output, unicode):
-                output = output.encode('raw_unicode_escape')
-        # Normalize line endings:
-        if expected:
-            expected = '\n'.join(expected.splitlines())
-        if output:
-            output = '\n'.join(output.splitlines())
-        try:
-            self.assertEqual(output, expected)
-        except AssertionError as error:
-            print('\n%s\ninput:' % (self,), file=sys.stderr)
-            print(input, file=sys.stderr)
-            try:
-                comparison = ''.join(self.compare(expected.splitlines(1),
-                                                  output.splitlines(1)))
-                print('-: expected\n+: output', file=sys.stderr)
-                print(comparison, file=sys.stderr)
-            except AttributeError:      # expected or output not a string
-                # alternative output for non-strings:
-                print('expected: %r' % expected, file=sys.stderr)
-                print('output:   %r' % output, file=sys.stderr)
-            raise error
-
-
-class CustomTestSuite(unittest.TestSuite):
-
-    """
-    A collection of CustomTestCases.
-
-    Provides test suite ID generation and a method for adding test cases.
-    """
-
-    id = ''
-    """Identifier for the TestSuite. Prepended to the
-    TestCase identifiers to make identification easier."""
-
-    next_test_case_id = 0
-    """The next identifier to use for non-identified test cases."""
-
-    def __init__(self, tests=(), id=None, suite_settings=None):
-        """
-        Initialize the CustomTestSuite.
-
-        Arguments:
-
-        id -- identifier for the suite, prepended to test cases.
-        suite_settings -- settings overrides for this test suite.
-        """
-        unittest.TestSuite.__init__(self, tests)
-        self.suite_settings = suite_settings or {}
-        if id is None:
-            mypath = os.path.abspath(
-                sys.modulesCustomTestSuite.__module__.__file__)
-            outerframes = inspect.getouterframes(inspect.currentframe())
-            for outerframe in outerframes1::
-                if outerframe3 != '__init__':
-                    callerpath = outerframe1
-                    if callerpath is None:
-                        # It happens sometimes.  Why is a mystery.
-                        callerpath = os.getcwd()
-                    callerpath = os.path.abspath(callerpath)
-                    break
-            mydir, myname = os.path.split(mypath)
-            if not mydir:
-                mydir = os.curdir
-            if callerpath.startswith(mydir):
-                self.id = callerpathlen(mydir) + 1: # caller's module
-            else:
-                self.id = callerpath
-        else:
-            self.id = id
-
-    def addTestCase(self, test_case_class, method_name, input, expected,
-                    id=None, run_in_debugger=False, **kwargs):
-        """
-        Create a CustomTestCase in the CustomTestSuite.
-        Also return it, just in case.
-
-        Arguments:
-
-        test_case_class -- the CustomTestCase to add
-        method_name -- a string; CustomTestCase.method_name is the test
-        input -- input to the parser.
-        expected -- expected output from the parser.
-        id -- unique test identifier, used by the test framework.
-        run_in_debugger -- if true, run this test under the pdb debugger.
-        """
-        if id is None:                  # generate id if required
-            id = self.next_test_case_id
-            self.next_test_case_id += 1
-        # test identifier will become suiteid.testid
-        tcid = '%s: %s' % (self.id, id)
-        # suite_settings may be passed as a parameter;
-        # if not, set from attribute:
-        kwargs.setdefault('suite_settings', self.suite_settings)
-        # generate and add test case
-        tc = test_case_class(method_name, input, expected, tcid,
-                             run_in_debugger=run_in_debugger, **kwargs)
-        self.addTest(tc)
-        return tc
-
-    def generate_no_tests(self, *args, **kwargs):
-        pass
-
-
-class TransformTestCase(CustomTestCase):
-
-    """
-    Output checker for the transform.
-
-    Should probably be called TransformOutputChecker, but I can deal with
-    that later when/if someone comes up with a category of transform test
-    cases that have nothing to do with the input and output of the transform.
-    """
-
-    option_parser = frontend.OptionParser(components=(rst.Parser,))
-    settings = option_parser.get_default_values()
-    settings.report_level = 1
-    settings.halt_level = 5
-    settings.debug = package_unittest.debug
-    settings.warning_stream = DevNull()
-    unknown_reference_resolvers = ()
-
-    def __init__(self, *args, **kwargs):
-        self.transforms = kwargs'transforms'
-        """List of transforms to perform for this test case."""
-
-        self.parser = kwargs'parser'
-        """Input parser for this test case."""
-
-        del kwargs'transforms', kwargs'parser' # only wanted here
-        CustomTestCase.__init__(self, *args, **kwargs)
-
-    def supports(self, format):
-        return 1
-
-    def test_transforms(self):
-        if self.run_in_debugger:
-            pdb.set_trace()
-        settings = self.settings.copy()
-        settings.__dict__.update(self.suite_settings)
-        document = utils.new_document('test data', settings)
-        self.parser.parse(self.input, document)
-        # Don't do a ``populate_from_components()`` because that would
-        # enable the Transformer's default transforms.
-        document.transformer.add_transforms(self.transforms)
-        document.transformer.add_transform(universal.TestMessages)
-        document.transformer.components'writer' = self
-        document.transformer.apply_transforms()
-        output = document.pformat()
-        self.compare_output(self.input, output, self.expected)
-
-    def test_transforms_verbosely(self):
-        if self.run_in_debugger:
-            pdb.set_trace()
-        print('\n', self.id)
-        print('-' * 70)
-        print(self.input)
-        settings = self.settings.copy()
-        settings.__dict__.update(self.suite_settings)
-        document = utils.new_document('test data', settings)
-        self.parser.parse(self.input, document)
-        print('-' * 70)
-        print(document.pformat())
-        for transformClass in self.transforms:
-            transformClass(document).apply()
-        output = document.pformat()
-        print('-' * 70)
-        print(output)
-        self.compare_output(self.input, output, self.expected)
-
-
-class TransformTestSuite(CustomTestSuite):
-
-    """
-    A collection of TransformTestCases.
-
-    A TransformTestSuite instance manufactures TransformTestCases,
-    keeps track of them, and provides a shared test fixture (a-la
-    setUp and tearDown).
-    """
-
-    def __init__(self, parser, suite_settings=None):
-        self.parser = parser
-        """Parser shared by all test cases."""
-
-        CustomTestSuite.__init__(self, suite_settings=suite_settings)
-
-    def generateTests(self, dict, dictname='totest',
-                      testmethod='test_transforms'):
-        """
-        Stock the suite with test cases generated from a test data dictionary.
-
-        Each dictionary key (test type's name) maps to a tuple, whose
-        first item is a list of transform classes and whose second
-        item is a list of tests. Each test is a list: input, expected
-        output, optional modifier. The optional third entry, a
-        behavior modifier, can be 0 (temporarily disable this test) or
-        1 (run this test under the pdb debugger). Tests should be
-        self-documenting and not require external comments.
-        """
-        for name, (transforms, cases) in dict.items():
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case)==3:
-                    # TODO: (maybe) change the 3rd argument to a dict, so it
-                    # can handle more cases by keyword ('disable', 'debug',
-                    # 'settings'), here and in other generateTests methods.
-                    # But there's also the method that
-                    # HtmlPublishPartsTestSuite uses <DJG>
-                    if case2:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(
-                      TransformTestCase, testmethod,
-                      transforms=transforms, parser=self.parser,
-                      input=case0, expected=case1,
-                      id='%s%r%s' % (dictname, name, casenum),
-                      run_in_debugger=run_in_debugger)
-
-
-class ParserTestCase(CustomTestCase):
-
-    """
-    Output checker for the parser.
-
-    Should probably be called ParserOutputChecker, but I can deal with
-    that later when/if someone comes up with a category of parser test
-    cases that have nothing to do with the input and output of the parser.
-    """
-
-    parser = rst.Parser()
-    """Parser shared by all ParserTestCases."""
-
-    option_parser = frontend.OptionParser(components=(rst.Parser,))
-    settings = option_parser.get_default_values()
-    settings.report_level = 5
-    settings.halt_level = 5
-    settings.debug = package_unittest.debug
-
-    def test_parser(self):
-        if self.run_in_debugger:
-            pdb.set_trace()
-        settings = self.settings.copy()
-        settings.__dict__.update(self.suite_settings)
-        document = utils.new_document('test data', settings)
-        self.parser.parse(self.input, document)
-        output = document.pformat()
-        self.compare_output(self.input, output, self.expected)
-
-
-class ParserTestSuite(CustomTestSuite):
-
-    """
-    A collection of ParserTestCases.
-
-    A ParserTestSuite instance manufactures ParserTestCases,
-    keeps track of them, and provides a shared test fixture (a-la
-    setUp and tearDown).
-    """
-
-    test_case_class = ParserTestCase
-
-    def generateTests(self, dict, dictname='totest'):
-        """
-        Stock the suite with test cases generated from a test data dictionary.
-
-        Each dictionary key (test type name) maps to a list of tests. Each
-        test is a list: input, expected output, optional modifier. The
-        optional third entry, a behavior modifier, can be 0 (temporarily
-        disable this test) or 1 (run this test under the pdb debugger). Tests
-        should be self-documenting and not require external comments.
-        """
-        for name, cases in dict.items():
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case)==3:
-                    if case2:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(
-                      self.test_case_class, 'test_parser',
-                      input=case0, expected=case1,
-                      id='%s%r%s' % (dictname, name, casenum),
-                      run_in_debugger=run_in_debugger)
-
-
-class PEPParserTestCase(ParserTestCase):
-
-    """PEP-specific parser test case."""
-
-    parser = rst.Parser(rfc2822=True, inliner=rst.states.Inliner())
-    """Parser shared by all PEPParserTestCases."""
-
-    option_parser = frontend.OptionParser(components=(rst.Parser, pep.Reader))
-    settings = option_parser.get_default_values()
-    settings.report_level = 5
-    settings.halt_level = 5
-    settings.debug = package_unittest.debug
-
-
-class PEPParserTestSuite(ParserTestSuite):
-
-    """A collection of PEPParserTestCases."""
-
-    test_case_class = PEPParserTestCase
-
-
-class RecommonmarkParserTestCase(ParserTestCase):
-
-    """Recommonmark-specific parser test case."""
-
-    parser = recommonmark_wrapper.Parser()
-    """Parser shared by all RecommonmarkParserTestCases."""
-
-    option_parser = frontend.OptionParser(
-                        components=(recommonmark_wrapper.Parser,))
-    settings = option_parser.get_default_values()
-    settings.report_level = 5
-    settings.halt_level = 5
-    settings.debug = package_unittest.debug
-
-class RecommonmarkParserTestSuite(ParserTestSuite):
-
-    """A collection of RecommonmarkParserTestCases."""
-
-    test_case_class = RecommonmarkParserTestCase
-
-    def generateTests(self, dict, dictname='totest'):
-        if 'recommonmark' not in recommonmark_wrapper.Parser.supported:
-            return
-        # TODO: currently the tests are too version-specific
-        from recommonmark import __version__ as recommonmark_version
-        if recommonmark_version != '0.4.0':
-            return        
-        # suppress UserWarnings from recommonmark parser
-        warnings.filterwarnings('ignore', message='Unsupported.*type')
-        ParserTestSuite.generateTests(self, dict, dictname='totest')
-
-
-class GridTableParserTestCase(CustomTestCase):
-
-    parser = tableparser.GridTableParser()
-
-    def test_parse_table(self):
-        self.parser.setup(StringList(string2lines(self.input), 'test data'))
-        try:
-            self.parser.find_head_body_sep()
-            self.parser.parse_table()
-            output = self.parser.cells
-        except Exception as details:
-            output = '%s: %s' % (details.__class__.__name__, details)
-        self.compare_output(self.input, pformat(output) + '\n',
-                            pformat(self.expected) + '\n')
-
-    def test_parse(self):
-        try:
-            output = self.parser.parse(StringList(string2lines(self.input),
-                                                  'test data'))
-        except Exception as details:
-            output = '%s: %s' % (details.__class__.__name__, details)
-        self.compare_output(self.input, pformat(output) + '\n',
-                            pformat(self.expected) + '\n')
-
-
-class GridTableParserTestSuite(CustomTestSuite):
-
-    """
-    A collection of GridTableParserTestCases.
-
-    A GridTableParserTestSuite instance manufactures GridTableParserTestCases,
-    keeps track of them, and provides a shared test fixture (a-la setUp and
-    tearDown).
-    """
-
-    test_case_class = GridTableParserTestCase
-
-    def generateTests(self, dict, dictname='totest'):
-        """
-        Stock the suite with test cases generated from a test data dictionary.
-
-        Each dictionary key (test type name) maps to a list of tests. Each
-        test is a list: an input table, expected output from parse_table(),
-        expected output from parse(), optional modifier. The optional fourth
-        entry, a behavior modifier, can be 0 (temporarily disable this test)
-        or 1 (run this test under the pdb debugger). Tests should be
-        self-documenting and not require external comments.
-        """
-        for name, cases in dict.items():
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case) == 4:
-                    if case-1:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(self.test_case_class, 'test_parse_table',
-                                 input=case0, expected=case1,
-                                 id='%s%r%s' % (dictname, name, casenum),
-                                 run_in_debugger=run_in_debugger)
-                self.addTestCase(self.test_case_class, 'test_parse',
-                                 input=case0, expected=case2,
-                                 id='%s%r%s' % (dictname, name, casenum),
-                                 run_in_debugger=run_in_debugger)
-
-
-class SimpleTableParserTestCase(GridTableParserTestCase):
-
-    parser = tableparser.SimpleTableParser()
-
-
-class SimpleTableParserTestSuite(CustomTestSuite):
-
-    """
-    A collection of SimpleTableParserTestCases.
-    """
-
-    test_case_class = SimpleTableParserTestCase
-
-    def generateTests(self, dict, dictname='totest'):
-        """
-        Stock the suite with test cases generated from a test data dictionary.
-
-        Each dictionary key (test type name) maps to a list of tests. Each
-        test is a list: an input table, expected output from parse(), optional
-        modifier. The optional third entry, a behavior modifier, can be 0
-        (temporarily disable this test) or 1 (run this test under the pdb
-        debugger). Tests should be self-documenting and not require external
-        comments.
-        """
-        for name, cases in dict.items():
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case) == 3:
-                    if case-1:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(self.test_case_class, 'test_parse',
-                                 input=case0, expected=case1,
-                                 id='%s%r%s' % (dictname, name, casenum),
-                                 run_in_debugger=run_in_debugger)
-
-
-class WriterPublishTestCase(CustomTestCase, docutils.SettingsSpec):
-
-    """
-    Test case for publish.
-    """
-
-    settings_default_overrides = {'_disable_config': True,
-                                  'strict_visitor': True}
-    writer_name = '' # set in subclasses or constructor
-
-    def __init__(self, *args, **kwargs):
-        if 'writer_name' in kwargs:
-            self.writer_name = kwargs'writer_name'
-            del kwargs'writer_name'
-        CustomTestCase.__init__(self, *args, **kwargs)
-
-    def test_publish(self):
-        if self.run_in_debugger:
-            pdb.set_trace()
-        output = docutils.core.publish_string(
-              source=self.input,
-              reader_name='standalone',
-              parser_name='restructuredtext',
-              writer_name=self.writer_name,
-              settings_spec=self,
-              settings_overrides=self.suite_settings)
-        self.compare_output(self.input, output, self.expected)
-
-
-class PublishTestSuite(CustomTestSuite):
-
-    def __init__(self, writer_name, suite_settings=None):
-        """
-        `writer_name` is the name of the writer to use.
-        """
-        CustomTestSuite.__init__(self, suite_settings=suite_settings)
-        self.test_class = WriterPublishTestCase
-        self.writer_name = writer_name
-
-    def generateTests(self, dict, dictname='totest'):
-        for name, cases in dict.items():
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case)==3:
-                    if case2:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(
-                      self.test_class, 'test_publish',
-                      input=case0, expected=case1,
-                      id='%s%r%s' % (dictname, name, casenum),
-                      run_in_debugger=run_in_debugger,
-                      # Passed to constructor of self.test_class:
-                      writer_name=self.writer_name)
-
-
-class HtmlWriterPublishPartsTestCase(WriterPublishTestCase):
-
-    """
-    Test case for HTML writer via the publish_parts interface.
-    """
-
-    writer_name = 'html'
-
-    settings_default_overrides = \
-        WriterPublishTestCase.settings_default_overrides.copy()
-    settings_default_overrides'stylesheet' = ''
-
-    def test_publish(self):
-        if self.run_in_debugger:
-            pdb.set_trace()
-        parts = docutils.core.publish_parts(
-            source=self.input,
-            reader_name='standalone',
-            parser_name='restructuredtext',
-            writer_name=self.writer_name,
-            settings_spec=self,
-            settings_overrides=self.suite_settings)
-        output = self.format_output(parts)
-        # interpolate standard variables:
-        expected = self.expected % {'version': docutils.__version__}
-        self.compare_output(self.input, output, expected)
-
-    standard_content_type_template = ('<meta http-equiv="Content-Type"'
-                                      ' content="text/html; charset=%s" />\n')
-    standard_generator_template = (
-        '<meta name="generator"'
-        ' content="Docutils %s: http://docutils.sourceforge.net/" />\n')
-    standard_html_meta_value = (
-        standard_content_type_template
-        + standard_generator_template % docutils.__version__)
-    standard_meta_value = standard_html_meta_value % 'utf-8'
-    standard_html_prolog = """\
-<?xml version="1.0" encoding="%s" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-"""
-
-    def format_output(self, parts):
-        """Minimize & standardize the output."""
-        # remove redundant parts & uninteresting parts:
-        del parts'whole'
-        assert parts'body' == parts'fragment'
-        del parts'body'
-        del parts'body_pre_docinfo'
-        del parts'body_prefix'
-        del parts'body_suffix'
-        del parts'head'
-        del parts'head_prefix'
-        del parts'encoding'
-        del parts'version'
-        # remove standard portions:
-        parts'meta' = parts'meta'.replace(self.standard_meta_value, '')
-        parts'html_head' = parts'html_head'.replace(
-            self.standard_html_meta_value, '...')
-        parts'html_prolog' = parts'html_prolog'.replace(
-            self.standard_html_prolog, '')
-        output = 
-        for key in sorted(parts.keys()):
-            if not partskey:
-                continue
-            output.append("%r: '''%s'''"
-                          % (key, partskey))
-            if output-1.endswith("\n'''"):
-                output-1 = output-1:-4 + "\\n'''"
-        return '{' + ',\n '.join(output) + '}\n'
-
-
-class HtmlPublishPartsTestSuite(CustomTestSuite):
-
-    testcase_class = HtmlWriterPublishPartsTestCase
-
-    def generateTests(self, dict, dictname='totest'):
-        for name, (settings_overrides, cases) in dict.items():
-            settings = self.suite_settings.copy()
-            settings.update(settings_overrides)
-            for casenum in range(len(cases)):
-                case = casescasenum
-                run_in_debugger = False
-                if len(case)==3:
-                    if case2:
-                        run_in_debugger = True
-                    else:
-                        continue
-                self.addTestCase(self.testcase_class, 'test_publish',
-                                 input=case0, expected=case1,
-                                 id='%s%r%s' % (dictname, name, casenum),
-                                 run_in_debugger=run_in_debugger,
-                                 suite_settings=settings)
-
-
-def exception_data(func, *args, **kwds):
-    """
-    Execute `func(*args, **kwds)` and return the resulting exception, the
-    exception arguments, and the formatted exception string.
-    """
-    try:
-        func(*args, **kwds)
-    except Exception as detail:
-        return (detail, detail.args,
-                '%s: %s' % (detail.__class__.__name__, detail))
-
-
-def _format_str(*args):
-    r"""
-    Return a tuple containing representations of all args.
-
-    Same as map(repr, args) except that it returns multi-line
-    representations for strings containing newlines, e.g.::
-
-        '''\
-        foo  \n\
-        bar
-
-        baz'''
-
-    instead of::
-
-        'foo  \nbar\n\nbaz'
-
-    This is a helper function for CustomTestCase.
-    """
-    return_tuple = 
-    for i in args:
-        r = repr(i)
-        if ( (isinstance(i, bytes) or isinstance(i, unicode))
-             and '\n' in i):
-            stripped = ''
-            if isinstance(i, unicode) and r.startswith('u'):
-                stripped = r0
-                r = r1:
-            elif isinstance(i, bytes) and r.startswith('b'):
-                stripped = r0
-                r = r1:
-            # quote_char = "'" or '"'
-            quote_char = r0
-            assert quote_char in ("'", '"'), quote_char
-            assert r0 == r-1
-            r = r1:-1
-            r = (stripped + 3 * quote_char + '\\\n' +
-                 re.sub(r'(?<!\\)((\\\\)*)\\n', r'\1\n', r) +
-                 3 * quote_char)
-            r = re.sub(r' \n', r' \\n\\\n', r)
-        return_tuple.append(r)
-    return tuple(return_tuple)

_service:tar_scm:docutils-0.17.1.tar.gz/test/coverage.sh Deleted

@@ -1,49 +0,0 @@
-#!/bin/bash
-
-# $Id: coverage.sh 5539 2008-03-30 09:05:39Z wiemann $
-# Author: Lea Wiemann <LeWiemann@gmail.com>
-# Copyright: This script has been placed in the public domain.
-
-# Usage: ./coverage.sh project, module
-
-set -e
-# Resolve all symlinks in current path.
-cd -P .
-proj="${PWD##*/}"
-if test "$proj" == test; then
-    cd ..
-    proj="${PWD##*/}"
-fi
-if test "$1"; then
-    proj="$1"
-fi
-module="${2:-alltests.py}"
-module="${module#test/}"
-echo "Performing code coverage test for project \"$proj\", test module \"$module\"..."
-echo
-echo "Please be patient; coverage tracking slows test execution down by more"
-echo "than factor 10."
-echo
-cd test
-rm -rf cover
-mkdir -p cover
-python -u -m trace --count --coverdir=cover --missing "$module"
-cd ..
-echo
-echo
-echo Uncovered lines
-echo ===============
-echo
-(
-    find "$proj/" -name \*.py | while read i; do
-        i="${i%.py}"
-        test -f test/cover/"${i//\//.}".cover -o "${i##*/}" == Template || echo "${i//\//.}" "`cat "$i.py" | wc -l`"
-    done
-    cd test/cover
-    find . $ -name . -o ! -name "$proj".\* -exec rm {} \; $
-    for i in *.cover; do
-        sed 's/^>>>>>> $.*"""$/       \1/' < "$i" > "${i%.cover}"
-        rm "$i"
-    done
-    for i in *; do echo -n "$i "; grep -c '^>>>>>> ' "$i" || true; done
-) | grep -v ' 0$' | sort -nk 2

_service:tar_scm:docutils-0.17.1.tar.gz/test/data/config_error_handler.txt Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/math_output_mathml.xhtml Deleted

@@ -1,221 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-<meta charset="utf-8"/>
-<meta name="viewport" content="width=device-width, initial-scale=1" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-<title>Mathematics</title>
-<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
-<link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
-</head>
-<body>
-<main id="mathematics">
-<h1 class="title">Mathematics</h1>
-
-<p>Docutils supports inline math with the prefix or postfix <span class="docutils literal">:math:</span>
-role specificator, <math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mi>n</mi><mo>!</mo><mo>+</mo><mo>sin</mo><mo>(</mo><msubsup><mi>x</mi><mi>n</mi><mn>2</mn></msubsup><mo>)</mo></mrow></math> and <math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><msub><mi>A</mi><mtext>c</mtext></msub><mo>=</mo><mfrac>
-<mrow><mi>π</mi></mrow>
-<mrow><mn>4</mn></mrow></mfrac><msup><mi>d</mi><mn>2</mn></msup></mrow></math>, as well as displayed math via the
-<cite>math</cite> directive:</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mi>f</mi><mo>(</mo><mi>ϵ</mi><mo>)</mo><mo>=</mo><mfrac>
-<mrow><mn>1</mn></mrow>
-<mrow><mn>1</mn><mo>+</mo><mo>exp</mo><mfenced open="(" close=")">
-<mrow><mfrac>
-<mrow><mi>ε</mi></mrow>
-<mrow><msub><mi>k</mi><mtext>B</mtext></msub><mi>T</mi></mrow></mfrac></mrow></mfenced></mrow></mfrac></mtd></mtr></mtable></math>
-</div>
-<p>Content may start on the first line of the directive, e.g.</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mi>N</mi><mo>=</mo><mfrac>
-<mrow><mtext>number of apples</mtext></mrow>
-<mrow><mn>7</mn></mrow></mfrac></mtd></mtr></mtable></math>
-</div>
-<p>Equations can be labeled with a reference name using the <span class="docutils literal">:name:</span> option.
-See <a class="reference internal" href="#eq-m">eq:M</a> and <a class="reference internal" href="#eq-schrodinger">eq:schrödinger</a> below.</p>
-<p>The determinant of the matrix</p>
-<div id="eq-m">
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mstyle mathvariant="bold">
-<mrow><mi>M</mi></mrow></mstyle><mo>=</mo><mfenced open="(" close=")">
-<mrow>
-<mtable>
-<mtr>
-<mtd><mi>a</mi></mtd>
-<mtd><mi>b</mi></mtd></mtr>
-<mtr>
-<mtd><mi>c</mi></mtd>
-<mtd><mi>d</mi></mtd></mtr></mtable></mrow></mfenced></mtd></mtr></mtable></math>
-</div>
-<p>is <math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mo>|</mo><mstyle mathvariant="bold">
-<mrow><mi>M</mi></mrow></mstyle><mo>|</mo><mo>=</mo><mi>a</mi><mi>d</mi><mo>-</mo><mi>b</mi><mi>c</mi></mrow></math>.</p>
-<p>More than one display math block can be put in one math directive.
-For example, the following sum and integral with limits:</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><munderover><mo>∫</mo><mn>0</mn><mn>1</mn></munderover><msup><mi>x</mi><mi>n</mi></msup><mi>d</mi><mi>x</mi><mo>=</mo><mfrac>
-<mrow><mn>1</mn></mrow>
-<mrow><mi>n</mi><mo>+</mo><mn>1</mn></mrow></mfrac></mtd></mtr></mtable></math>
-</div>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><munderover><mo>∑</mo>
-<mrow><mi>n</mi><mo>=</mo><mn>1</mn></mrow><mi>m</mi></munderover><mi>n</mi><mo>=</mo><mfrac>
-<mrow><mi>m</mi><mo>(</mo><mi>m</mi><mo>+</mo><mn>1</mn><mo>)</mo></mrow>
-<mrow><mn>2</mn></mrow></mfrac></mtd></mtr></mtable></math>
-</div>
-<p>LaTeX-supported Unicode math symbols can be used in math roles and
-directives:</p>
-<p>The Schrödinger equation</p>
-<div id="eq-schrodinger">
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mi>i</mi><mi>ℏ</mi><mfrac>
-<mrow><mo>∂</mo></mrow>
-<mrow><mo>∂</mo><mi>t</mi></mrow></mfrac><mo>Ψ</mo><mo>=</mo><mover>
-<mrow><mi>H</mi></mrow><mo>^</mo></mover><mo>Ψ</mo><mo>,</mo></mtd></mtr></mtable></math>
-</div>
-<p>with the <em>wave function</em> <math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mo>Ψ</mo></mrow></math>, describes how the quantum state of a
-physical system changes in time.</p>
-<dl>
-<dt>Math-Accents:</dt>
-<dd><table class="colwidths-given borderless">
-<colgroup>
-<col style="width: 33%" />
-<col style="width: 33%" />
-<col style="width: 33%" />
-</colgroup>
-<tbody>
-<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>a</mi></mrow><mo>´</mo></mover></mrow></math>      <span class="docutils literal">\acute{a}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>t</mi></mrow><mo>˙</mo></mover></mrow></math>        <span class="docutils literal">\dot{t}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>γ</mi></mrow><mo>^</mo></mover></mrow></math>   <span class="docutils literal"><span class="pre">\hat{\gamma}</span></span></p></td>
-</tr>
-<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>a</mi></mrow><mo>`</mo></mover></mrow></math>      <span class="docutils literal">\grave{a}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>t</mi></mrow><mo>¨</mo></mover></mrow></math>       <span class="docutils literal">\ddot{t}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>α</mi></mrow><mo>˜</mo></mover></mrow></math> <span class="docutils literal"><span class="pre">\tilde{\alpha}</span></span></p></td>
-</tr>
-<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>x</mi></mrow><mo>˘</mo></mover></mrow></math>      <span class="docutils literal">\breve{x}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>t</mi></mrow><mo>⃛</mo></mover></mrow></math>      <span class="docutils literal">\dddot{t}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>ı</mi></mrow><mo>⃗</mo></mover></mrow></math>   <span class="docutils literal"><span class="pre">\vec{\imath}</span></span></p></td>
-</tr>
-<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>a</mi></mrow><mo>ˇ</mo></mover></mrow></math>      <span class="docutils literal">\check{a}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>a</mi></mrow><mo>¯</mo></mover></mrow></math>        <span class="docutils literal">\bar{a}</span></p></td>
-<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
-<mrow><mover>
-<mrow><mi>R</mi></mrow><mo>⃗</mo></mover></mrow></math>        <span class="docutils literal">\vec{R}</span></p></td>
-</tr>
-</tbody>
-</table>
-</dd>
-</dl>
-
-<p>Modulation Transfer Function:</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mtext>MTF</mtext><mo>=</mo><mfenced open="|" close="|">
-<mrow><mfrac>
-<mrow><mi>ℱ</mi><mo>{</mo><mi>s</mi><mo>(</mo><mi>x</mi><mo>)</mo><mo>}</mo></mrow>
-<mrow><mi>ℱ</mi><mo>{</mo><mi>s</mi><mo>(</mo><mi>x</mi><mo>)</mo><mo>}</mo><msub><mo>|</mo>
-<mrow><msub><mi>ω</mi>
-<mrow><mi>x</mi></mrow></msub><mo>=</mo><mn>0</mn></mrow></msub></mrow></mfrac></mrow></mfenced><mo>=</mo><mtext>abs</mtext><mfenced open="(" close=")">
-<mrow><mfrac>
-<mrow><munderover><mo>∫</mo>
-<mrow><mo>-</mo><mo>∞</mo></mrow>
-<mrow><mo>∞</mo></mrow></munderover><mi>s</mi><mo>(</mo><mi>x</mi><mo>)</mo><msup><mtext>e</mtext>
-<mrow><mtext>i</mtext><msub><mi>ω</mi>
-<mrow><mi>x</mi></mrow></msub><mi>x</mi></mrow></msup><mtext>d</mtext>
-<mrow><mi>x</mi></mrow></mrow>
-<mrow><munderover><mo>∫</mo>
-<mrow><mo>-</mo><mo>∞</mo></mrow>
-<mrow><mo>∞</mo></mrow></munderover><mi>s</mi><mo>(</mo><mi>x</mi><mo>)</mo><mtext>d</mtext>
-<mrow><mi>x</mi></mrow></mrow></mfrac></mrow></mfenced><mo>.</mo></mtd></mtr></mtable></math>
-</div>
-<p>Math split over two lines: If a double backslash is detected outside a
-<span class="docutils literal"><span class="pre">\begin{...}</span> <span class="pre">\end{...}</span></span> pair, the math code is wrapped in an <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a>
-<span class="docutils literal">align</span> environment:</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><msub><mi>s</mi>
-<mrow><mtext>out</mtext></mrow></msub><mo>(</mo><mi>x</mi><mo>)</mo></mtd>
-<mtd><mo>=</mo><msub><mi>s</mi>
-<mrow><mtext>in</mtext></mrow></msub><mo>(</mo><mi>x</mi><mo>'</mo><mo>)</mo><mo>*</mo><msub><mi>s</mi><mi>δ</mi></msub><mo>(</mo><mi>x</mi><mo>-</mo><mi>x</mi><mo>'</mo><mo>)</mo></mtd></mtr>
-<mtr>
-<mtd></mtd>
-<mtd><mo>=</mo><mo>∫</mo><msub><mi>s</mi>
-<mrow><mtext>in</mtext></mrow></msub><mo>(</mo><mi>x</mi><mo>'</mo><mo>)</mo><msub><mi>s</mi><mi>δ</mi></msub><mo>(</mo><mi>x</mi><mo>-</mo><mi>x</mi><mo>'</mo><mo>)</mo><mtext>d</mtext><mi>x</mi><mo>'</mo></mtd></mtr></mtable></math>
-</div>
-<p>Cases (&quot;manually&quot;, with <span class="docutils literal">matrix</span> environment):</p>
-<div>
-<math xmlns="http://www.w3.org/1998/Math/MathML" mode="display">
-<mtable>
-<mtr>
-<mtd><mtext>sgn</mtext><mo>(</mo><mi>x</mi><mo>)</mo><mo>=</mo><mfenced open="{" close="">
-<mrow>
-<mtable>
-<mtr>
-<mtd><mo>-</mo><mn>1</mn></mtd>
-<mtd><mi>x</mi><mo>&lt;</mo><mn>0</mn></mtd></mtr>
-<mtr>
-<mtd><mn>1</mn></mtd>
-<mtd><mi>x</mi><mo>&gt;</mo><mn>0</mn></mtd></mtr></mtable></mrow></mfenced></mtd></mtr></mtable></math>
-</div>
-<p>Cases with the <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a> <span class="docutils literal">cases</span> environment (not (yet) supported by
-HTML writers with <span class="docutils literal"><span class="pre">--math-output=MathML</span></span>):</p>
-<div class="system-message">
-<p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/math.txt</span>, line 108)</p>
-<p>
-Environment not supported! Supported environment: "matrix".</p>
-<pre class="literal-block">
-\mathrm{sgn}(x) = \begin{cases}
-                    -1 &amp; x&lt;0\\
-                     1 &amp; x&gt;0
-                  \end{cases}
-</pre>
-</div>
-</main>
-</body>
-</html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/blank.gif Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/iepngfix.htc Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/blank.gif Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/iepngfix.htc Deleted

@@ -1,42 +0,0 @@
-<public:component>
-<public:attach event="onpropertychange" onevent="doFix()" />
-
-<script>
-
-// IE5.5+ PNG Alpha Fix v1.0 by Angus Turnbull http://www.twinhelix.com
-// Free usage permitted as long as this notice remains intact.
-
-// This must be a path to a blank image. That's all the configuration you need here.
-var blankImg = 'ui/small-black/blank.gif';
-
-var f = 'DXImageTransform.Microsoft.AlphaImageLoader';
-
-function filt(s, m) {
- if (filtersf) {
-  filtersf.enabled = s ? true : false;
-  if (s) with (filtersf) { src = s; sizingMethod = m }
- } else if (s) style.filter = 'progid:'+f+'(src="'+s+'",sizingMethod="'+m+'")';
-}
-
-function doFix() {
- if ((parseFloat(navigator.userAgent.match(/MSIE (\S+)/)1) < 5.5) ||
-  (event && !/(background|src)/.test(event.propertyName))) return;
-
- if (tagName == 'IMG') {
-  if ((/\.png$/i).test(src)) {
-   filt(src, 'image');  // was 'scale'
-   src = blankImg;
-  } else if (src.indexOf(blankImg) < 0) filt();
- } else if (style.backgroundImage) {
-  if (style.backgroundImage.match(/^url("'+(.*\.png))"'+$/i)) {
-   var s = RegExp.$1;
-   style.backgroundImage = '';
-   filt(s, 'crop');
-  } else filt();
- }
-}
-
-doFix();
-
-</script>
-</public:component>
\ No newline at end of file

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/video.html Deleted

@@ -1,38 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-<meta charset="utf-8"/>
-<meta name="viewport" content="width=device-width, initial-scale=1" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-<title>Moving images (video)</title>
-<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
-<link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
-</head>
-<body>
-<main id="moving-images-video">
-<h1 class="title">Moving images (video)</h1>
-
-<p>If the URL given to <cite>images and figures</cite> hints to a video format
-supported by HTML 5 (MIME types 'video/mp4', 'video/webm', or
-'video/ogg'), the HTML5 writer will place it in a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video">video element</a>.</p>
-<video class="align-left" src="../../../docs/user/rst/images/pens.mp4" title="left-aligned test video">
-<a href="../../../docs/user/rst/images/pens.mp4">left-aligned test video</a>
-</video>
-<p>A class option value &quot;controls&quot; tells the browser to display controls
-for video playback.</p>
-<p>It is a good idea to include width and height attributes. If
-height and width are not set, the page might flicker while the video
-loads. According to the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video">HTML5 spec</a>, hight and width must be
-specified as pixel values.</p>
-<figure class="align-center">
-<video class="controls" controls="controls" src="../../../docs/user/rst/images/pens.mp4" title="../../../docs/user/rst/images/pens.mp4" width="30%">
-<a href="../../../docs/user/rst/images/pens.mp4">../../../docs/user/rst/images/pens.mp4</a>
-</video>
-<figcaption>
-<p>Simple test video in a centered figure</p>
-</figcaption>
-</figure>
-<p>A video like this <video src="../../../docs/user/rst/images/pens.mp4" title="testvideo" width="60"><a href="../../../docs/user/rst/images/pens.mp4">testvideo</a></video> can be included inline via substitution.</p>
-</main>
-</body>
-</html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/embed_images.txt Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/link_in_substitution.txt Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/_default.py Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/_standalone_rst_defaults.py Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/embed_images_html5.py Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/html5_video.py Deleted

_service:tar_scm:docutils-0.17.1.tar.gz/test/package_unittest.py Deleted

@@ -1,159 +0,0 @@
-#! /usr/bin/env python
-
-# $Id: package_unittest.py 8359 2019-08-26 16:45:33Z milde $
-# Author: Garth Kidd <garth@deadlybloodyserious.com>
-# Copyright: This module has been placed in the public domain.
-
-"""
-This module extends unittest.py with `loadTestModules()`, by loading multiple
-test modules from a directory.  Optionally, test packages are also loaded,
-recursively.
-"""
-from __future__ import print_function
-
-import sys
-import os
-import getopt
-import types
-import unittest
-import re
-
-
-# So that individual test modules can share a bit of state,
-# `package_unittest` acts as an intermediary for the following
-# variables:
-debug = False
-verbosity = 1
-
-USAGE = """\
-Usage: test_whatever options
-
-Options:
-  -h, --help       Show this message
-  -v, --verbose    Verbose output
-  -q, --quiet      Minimal output
-  -d, --debug      Debug mode
-"""
-
-def usageExit(msg=None):
-    """Print usage and exit."""
-    if msg:
-        print(msg)
-    print(USAGE)
-    sys.exit(2)
-
-def parseArgs(argv=sys.argv):
-    """Parse command line arguments and set TestFramework state.
-
-    State is to be acquired by test_* modules by a grotty hack:
-    ``from TestFramework import *``. For this stylistic
-    transgression, I expect to be first up against the wall
-    when the revolution comes. --Garth"""
-    global verbosity, debug
-    try:
-        options, args = getopt.getopt(argv1:, 'hHvqd',
-                                      'help', 'verbose', 'quiet', 'debug')
-        for opt, value in options:
-            if opt in ('-h', '-H', '--help'):
-                usageExit()
-            if opt in ('-q', '--quiet'):
-                verbosity = 0
-            if opt in ('-v', '--verbose'):
-                verbosity = 2
-            if opt in ('-d', '--debug'):
-                debug =1
-        if len(args) != 0:
-            usageExit("No command-line arguments supported yet.")
-    except getopt.error as msg:
-        usageExit(msg)
-
-def loadTestModules(path, name='', packages=None):
-    """
-    Return a test suite composed of all the tests from modules in a directory.
-
-    Search for modules in directory `path`, beginning with `name`. If
-    `packages` is true, search subdirectories (also beginning with `name`)
-    recursively.  Subdirectories must be Python packages; they must contain an
-    '__init__.py' module.
-    """
-    testLoader = unittest.defaultTestLoader
-    testSuite = unittest.TestSuite()
-    testModules = 
-    path = os.path.abspath(path)        # current working dir if `path` empty
-    paths = path
-    while paths:
-        p = paths.pop(0)
-        files = os.listdir(p)
-        for filename in files:
-            if filename.startswith(name):
-                fullpath = os.path.join(p, filename)
-                if filename.endswith('.py'):
-                    fullpath = fullpathlen(path)+1:
-                    testModules.append(path2mod(fullpath))
-                elif packages and os.path.isdir(fullpath) and \
-                      os.path.isfile(os.path.join(fullpath, '__init__.py')):
-                    paths.append(fullpath)
-    # Import modules and add their tests to the suite.
-    sys.path.insert(0, path)
-    for mod in testModules:
-        if debug:
-            print("importing %s" % mod, file=sys.stderr)
-        try:
-            module = import_module(mod)
-        except ImportError:
-            print("ERROR: Can't import %s, skipping its tests:" % mod, file=sys.stderr)
-            sys.excepthook(*sys.exc_info())
-        else:
-            # if there's a suite defined, incorporate its contents
-            try:
-                suite = getattr(module, 'suite')
-            except AttributeError:
-                # Look for individual tests
-                moduleTests = testLoader.loadTestsFromModule(module)
-                # unittest.TestSuite.addTests() doesn't work as advertised,
-                # as it can't load tests from another TestSuite, so we have
-                # to cheat:
-                testSuite.addTest(moduleTests)
-                continue
-            if isinstance(suite, types.FunctionType):
-                testSuite.addTest(suite())
-            elif isinstance(suite, unittest.TestSuite):
-                testSuite.addTest(suite)
-            else:
-                raise AssertionError("don't understand suite (%s)" % mod)
-    sys.path.pop(0)
-    return testSuite
-
-def path2mod(path):
-    """Convert a file path to a dotted module name."""
-    return path:-3.replace(os.sep, '.')
-
-def import_module(name):
-    """Import a dotted-path module name, and return the final component."""
-    mod = __import__(name)
-    components = name.split('.')
-    for comp in components1::
-        mod = getattr(mod, comp)
-    return mod
-
-def main(suite=None):
-    """
-    Shared `main` for any individual test_* file.
-
-    suite -- TestSuite to run. If not specified, look for any globally defined
-    tests and run them.
-    """
-    parseArgs()
-    if suite is None:
-        # Load any globally defined tests.
-        suite = unittest.defaultTestLoader.loadTestsFromModule(
-              __import__('__main__'))
-    if debug:
-        print("Debug: Suite=%s" % suite, file=sys.stderr)
-    testRunner = unittest.TextTestRunner(verbosity=verbosity)
-    # run suites (if we were called from test_all) or suite...
-    if isinstance(suite, type()):
-        for s in suite:
-            testRunner.run(s)
-    else:
-        return testRunner.run(suite)

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_command_line.py Deleted

@@ -1,49 +0,0 @@
-#! /usr/bin/env python
-# .. coding: utf-8
-# $Id: test_command_line.py 8367 2019-08-27 12:09:56Z milde $
-# Author: Günter Milde <milde@users.sourceforge.net>
-# Copyright: This module has been placed in the public domain.
-
-"""
-Test module for the command line.
-"""
-
-import unittest
-import sys, codecs
-import DocutilsTestSupport # must be imported before docutils
-import docutils.core
-
-# determine/guess the encoding of the standard input:
-try:
-    import locale # module missing in Jython
-    locale_encoding = locale.getlocale()1 or locale.getdefaultlocale()1
-except ImportError:
-    locale_encoding = None
-
-argv_encoding = locale_encoding or 'ascii'
-try:
-    codecs.lookup(argv_encoding)
-except LookupError:
-    argv_encoding = 'ascii'
-
-
-class CommandLineEncodingTests(unittest.TestCase):
-
-    def test_sys_argv_decoding(self):
-        if argv_encoding == 'ascii': # cannot test
-            return
-        sys.argv.append('--source-url=test.txt') # pure ASCII argument
-        if sys.version_info < (3, 0):
-            sys.argv.append(u'--title=Dornröschen'.encode(argv_encoding))
-        else:
-            sys.argv.append(u'--title=Dornröschen')
-        publisher = docutils.core.Publisher()
-        publisher.process_command_line()
-        self.assertEqual(publisher.settings.source_url, 'test.txt')
-        self.assertEqual(publisher.settings.title, u'Dornröschen')
-        sys.argv.pop() # --title
-        sys.argv.pop() # --source-url
-
-
-if __name__ == '__main__':
-    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/tools/quicktest.py Deleted

@@ -1,213 +0,0 @@
-#!/usr/bin/env python
-
-# $Id: quicktest.py 8346 2019-08-26 12:11:32Z milde $
-# Authors: Garth Kidd <garth@deadlybloodyserious.com>;
-#          David Goodger <goodger@python.org>
-# Copyright: This module has been placed in the public domain.
-
-from __future__ import print_function
-try:
-    import locale
-    locale.setlocale(locale.LC_ALL, '')
-except:
-    pass
-
-import sys
-import os
-import getopt
-import docutils
-from docutils.frontend import OptionParser
-from docutils.utils import new_document
-from docutils.parsers.rst import Parser
-
-
-usage_header = """\
-quicktest.py: Quickly test the reStructuredText parser.  This is not an
-interface to the full functionality of Docutils.  Use one of the ``rst2*.py``
-front-end tools instead.
-
-Usage::
-
-    quicktest.py options <source> <destination>
-
-``source`` is the name of the file to use as input (default is stdin).
-``destination`` is the name of the file to create as output (default is
-stdout).
-
-Options:
-"""
-
-options = ('pretty', 'p',
-            'output pretty pseudo-xml: no "&abc;" entities (default)'),
-           ('test', 't', 'output test-ready data (input & expected output, '
-            'ready to be copied to a parser test module)'),
-           ('rawxml', 'r', 'output raw XML'),
-           ('styledxml=', 's', 'output raw XML with XSL style sheet '
-            'reference (filename supplied in the option argument)'),
-           ('xml', 'x', 'output pretty XML (indented)'),
-           ('attributes', 'A', 'dump document attributes after processing'),
-           ('debug', 'd', 'debug mode (lots of output)'),
-           ('version', 'V', 'show Docutils version then exit'),
-           ('help', 'h', 'show help text then exit')
-"""See ``distutils.fancy_getopt.FancyGetopt.__init__`` for a description of
-the data structure: (long option, short option, description)."""
-
-def usage():
-    print(usage_header)
-    for longopt, shortopt, description in options:
-        if longopt-1: == '=':
-            opts = '-%s arg, --%sarg' % (shortopt, longopt)
-        else:
-            opts = '-%s, --%s' % (shortopt, longopt)
-        sys.stdout.write('%-15s' % opts)
-        if len(opts) > 14:
-            sys.stdout.write('%-16s' % '\n')
-        while len(description) > 60:
-            limit = description.rindex(' ', 0, 60)
-            print(description:limit.strip())
-            description = descriptionlimit + 1:
-            sys.stdout.write('%-15s' % ' ')
-        print(description)
-
-def _pretty(input, document, optargs):
-    return document.pformat()
-
-def _rawxml(input, document, optargs):
-    return document.asdom().toxml()
-
-def _styledxml(input, document, optargs):
-    docnode = document.asdom().childNodes0
-    return '%s\n%s\n%s' % (
-          '<?xml version="1.0" encoding="ISO-8859-1"?>',
-          '<?xml-stylesheet type="text/xsl" href="%s"?>'
-          % optargs'styledxml', docnode.toxml())
-
-def _prettyxml(input, document, optargs):
-    return document.asdom().toprettyxml('    ', '\n')
-
-def _test(input, document, optargs):
-    tq = '"""'
-    output = document.pformat()         # same as _pretty()
-    return """\
-    totest'change_this_test_name' = 
-%s\\
-%s
-%s,
-%s\\
-%s
-%s,
-
-""" % ( tq, escape(input.rstrip()), tq, tq, escape(output.rstrip()), tq )
-
-def escape(text):
-    """
-    Return `text` in triple-double-quoted Python string form.
-    """
-    text = text.replace('\\', '\\\\')   # escape backslashes
-    text = text.replace('"""', '""\\"') # break up triple-double-quotes
-    text = text.replace(' \n', ' \\n\\\n') # protect trailing whitespace
-    return text
-
-_outputFormatters = {
-    'rawxml': _rawxml,
-    'styledxml': _styledxml,
-    'xml': _prettyxml,
-    'pretty' : _pretty,
-    'test': _test
-    }
-
-def format(outputFormat, input, document, optargs):
-    formatter = _outputFormattersoutputFormat
-    return formatter(input, document, optargs)
-
-def getArgs():
-    if os.name == 'mac' and len(sys.argv) <= 1:
-        return macGetArgs()
-    else:
-        return posixGetArgs(sys.argv1:)
-
-def posixGetArgs(argv):
-    outputFormat = 'pretty'
-    # convert fancy_getopt style option list to getopt.getopt() arguments
-    shortopts = ''.join(option1 + ':' * (option0-1: == '=')
-                         for option in options if option1)
-    longopts = option0 for option in options if option0
-    try:
-        opts, args = getopt.getopt(argv, shortopts, longopts)
-    except getopt.GetoptError:
-        usage()
-        sys.exit(2)
-    optargs = {'debug': 0, 'attributes': 0}
-    for o, a in opts:
-        if o in '-h', '--help':
-            usage()
-            sys.exit()
-        elif o in '-V', '--version':
-            sys.stderr.write('quicktest.py (Docutils %s%s)\n' %
-                             (docutils.__version__,
-                              docutils.__version_details__ and
-                              ' %s'%docutils.__version_details__ or ''))
-            sys.exit()
-        elif o in '-r', '--rawxml':
-            outputFormat = 'rawxml'
-        elif o in '-s', '--styledxml':
-            outputFormat = 'styledxml'
-            optargs'styledxml' = a
-        elif o in '-x', '--xml':
-            outputFormat = 'xml'
-        elif o in '-p', '--pretty':
-            outputFormat = 'pretty'
-        elif o in '-t', '--test':
-            outputFormat = 'test'
-        elif o in '--attributes', '-A':
-            optargs'attributes' = 1
-        elif o in '-d', '--debug':
-            optargs'debug' = 1
-        else:
-            raise getopt.GetoptError("getopt should have saved us!")
-    if len(args) > 2:
-        print('Maximum 2 arguments allowed.')
-        usage()
-        sys.exit(1)
-    inputFile = sys.stdin
-    outputFile = sys.stdout
-    if args:
-        inputFile = open(args.pop(0))
-    if args:
-        outputFile = open(args.pop(0), 'w')
-    return inputFile, outputFile, outputFormat, optargs
-
-def macGetArgs():
-    import EasyDialogs
-    EasyDialogs.Message("""\
-Use the next dialog to build a command line:
-
-1. Choose an output format from the Option list
-2. Click Add
-3. Choose an input file: Add existing file...
-4. Save the output: Add new file...
-5. OK""")
-    optionlist = (longopt, description)
-                  for (longopt, shortopt, description) in options
-    argv = EasyDialogs.GetArgv(optionlist=optionlist, addfolder=0)
-    return posixGetArgs(argv)
-
-def main():
-    # process cmdline arguments:
-    inputFile, outputFile, outputFormat, optargs = getArgs()
-    settings = OptionParser(components=(Parser,)).get_default_values()
-    settings.debug = optargs'debug'
-    parser = Parser()
-    input = inputFile.read()
-    document = new_document(inputFile.name, settings)
-    parser.parse(input, document)
-    output = format(outputFormat, input, document, optargs)
-    outputFile.write(output)
-    if optargs'attributes':
-        import pprint
-        pprint.pprint(document.__dict__)
-
-
-if __name__ == '__main__':
-    sys.stderr = sys.stdout
-    main()

_service:tar_scm:docutils-0.17.1.tar.gz/BUGS.txt -> _service:tar_scm:docutils-0.20.tar.gz/BUGS.txt Changed

@@ -1,14 +1,16 @@
+.. include:: docs/header0.txt
+
 ================
  Docutils_ Bugs
 ================
 
 :Author: David Goodger; open to all Docutils developers
 :Contact: goodger@python.org
-:Date: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
-:Revision: $Revision: 8644 $
+:Date: $Date: 2022-11-29 00:55:25 +0100 (Di, 29. Nov 2022) $
+:Revision: $Revision: 9280 $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 
 Bugs in Docutils?!?  Yes, we do have a few.  Some are old-timers that
@@ -118,13 +120,13 @@
 __ http://svn.collab.net/viewcvs/svn/trunk/BUGS?view=markup
 
 .. _repository: docs/dev/repository.html
-.. _snapshot: http://docutils.sourceforge.net/#download
+.. _snapshot: https://docutils.sourceforge.io/#download
 .. _documentation: docs/
 .. _FAQ: FAQ.html
-.. _mailing list archives: http://docutils.sf.net/#mailing-lists
+.. _mailing list archives: https://docutils.sourceforge.io/#mailing-lists
 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 .. _SourceForge Bug Tracker:
-   http://sourceforge.net/p/docutils/bugs/
+   https://sourceforge.net/p/docutils/bugs/
 
 
 Known Bugs

_service:tar_scm:docutils-0.17.1.tar.gz/COPYING.txt -> _service:tar_scm:docutils-0.20.tar.gz/COPYING.txt Changed

@@ -1,17 +1,19 @@
+.. include:: docs/header0.txt
+
 ==================
  Copying Docutils
 ==================
 
 :Author: David Goodger
 :Contact: goodger@python.org
-:Date: $Date: 2020-09-04 18:52:11 +0200 (Fr, 04. Sep 2020) $
-:Web site: http://docutils.sourceforge.net/
+:Date: $Date: 2022-11-29 00:55:25 +0100 (Di, 29. Nov 2022) $
+:Web site: https://docutils.sourceforge.io/
 :Copyright: This document has been placed in the public domain.
 
 Most of the files included in this project have been placed in the
 public domain, and therefore have no license requirements and no
 restrictions on copying or usage; see the `Public Domain Dedication`_
-below.  There are a few exceptions_, listed below.
+below.  There are exceptions_, listed below.
 Files in the Sandbox_ are not distributed with Docutils releases and
 may have different license terms.
 
@@ -26,11 +28,11 @@
 below (the "Work") to the public domain.
 
 The primary repository for the Work is the Internet World Wide Web
-site <http://docutils.sourceforge.net/>.  The Work consists of the
+site <https://docutils.sourceforge.io/>.  The Work consists of the
 files within the "docutils" module of the Docutils project Subversion
-repository (Internet host docutils.svn.sourceforge.net, filesystem path
-/svnroot/docutils), whose Internet web interface is located at
-<http://docutils.svn.sourceforge.net/viewvc/docutils/>.  Files dedicated to the
+repository (http://svn.code.sf.net/p/docutils/code/),
+whose Internet web interface is located at
+<https://sourceforge.net/p/docutils/code>.  Files dedicated to the
 public domain may be identified by the inclusion, near the beginning
 of each file, of a declaration of the form::
 
@@ -70,66 +72,88 @@
 
 The exceptions to the `Public Domain Dedication`_ above are:
 
-* docutils/writers/s5_html/themes/default/iepngfix.htc:
-
-      IE5.5+ PNG Alpha Fix v1.0 by Angus Turnbull
-      <http://www.twinhelix.com>.  Free usage permitted as long as
-      this notice remains intact.
-
-* docutils/utils/math/__init__.py,
-  docutils/utils/math/latex2mathml.py,
-  docutils/writers/xetex/__init__.py,
-  docutils/utils/error_reporting.py,
-  docutils/test/transforms/test_smartquotes.py:
-
-  Copyright © Günter Milde.
-  Released under the terms of the `2-Clause BSD license`_
-  (`local copy <licenses/BSD-2-Clause.txt>`__).
-
 * docutils/utils/smartquotes.py
 
   Copyright © 2011 Günter Milde,
   based on `SmartyPants`_ © 2003 John Gruber
-  (released under a 3-Clause BSD license included in the file)
+  (released under a "revised" `BSD 3-Clause License`_ included in the file)
   and smartypants.py © 2004, 2007 Chad Miller.
-  Released under the terms of the `2-Clause BSD license`_
+  Released under the terms of the `BSD 2-Clause License`_
   (`local copy <licenses/BSD-2-Clause.txt>`__).
 
   .. _SmartyPants: http://daringfireball.net/projects/smartypants/
 
-* docutils/utils/math/math2html.py,
-  docutils/writers/html4css1/math.css
+* docutils/utils/math/latex2mathml.py
+
+  Copyright © Jens Jørgen Mortensen, Günter Milde.
+  Released under the terms of the `BSD 2-Clause License`_
+  (`local copy <licenses/BSD-2-Clause.txt>`__).
+
+* | docutils/utils/math/math2html.py,
+  | docutils/writers/html5_polyglot/math.css
 
-  Copyright © Alex Fernández
-  These files are part of eLyXer_, released under the `GNU
+  Copyright © 2009,2010 Alex Fernández; 2021 Günter Milde
+
+  These files were part of eLyXer_, released under the `GNU
   General Public License`_ version 3 or later. The author relicensed
-  them for Docutils under the terms of the `2-Clause BSD license`_
+  them for Docutils under the terms of the `BSD 2-Clause License`_
+  (`local copy <licenses/BSD-2-Clause.txt>`__).
+
+  .. _eLyXer: https://github.com/alexfernandez/elyxer
+
+* | docutils/__main__.py,
+  | docutils/parsers/commonmark_wrapper.py,
+  | docutils/parsers/recommonmark_wrapper.py,
+  | docutils/utils/error_reporting.py,
+  | docutils/utils/math/__init__.py,
+  | docutils/utils/math/latex2mathml.py,
+  | docutils/utils/math/tex2mathml_extern.py,
+  | docutils/utils/punctuation_chars.py,
+  | docutils/utils/smartquotes.py,
+  | docutils/writers/html5_polyglot/__init__.py,
+  | docutils/writers/html5_polyglot/\*.css,
+  | docutils/writers/latex2e/docutils.sty,
+  | docutils/writers/xetex/__init__.py,
+  | test/test_parsers/test_recommonmark/\*.py,
+  | test/test_parsers/test_rst/test_directives/test__init__.py,
+  | test/test_parsers/test_rst/test_directives/test_code_parsing.py,
+  | test/test_parsers/test_rst/test_line_length_limit_default.py,
+  | test/test_parsers/test_rst/test_line_length_limit.py,
+  | test/test_writers/test_latex2e_misc.py,
+  | test/transforms/test_smartquotes.py,
+  | tools/docutils-cli.py,
+  | tools/rst2html5.py
+
+  Copyright © Günter Milde.
+  Released under the terms of the `BSD 2-Clause License`_
   (`local copy <licenses/BSD-2-Clause.txt>`__).
 
-  .. _eLyXer: http://www.nongnu.org/elyxer/
+* docutils/utils/roman.py
 
-* docutils/utils/roman.py, copyright by Mark Pilgrim, released under the
+  copyright by Mark Pilgrim, released under the
   `Python 2.1.1 license`_ (`local copy`__).
 
   __ licenses/python-2-1-1.txt
 
-* tools/editors/emacs/rst.el, copyright by Free Software Foundation,
-  Inc., released under the `GNU General Public License`_ version 3 or
-  later (`local copy`__).
+* tools/editors/emacs/rst.el
+
+  copyright by Free Software Foundation, Inc.,
+  released under the `GNU General Public License`_ version 3 or later
+  (`local copy`__).
 
   __ licenses/gpl-3-0.txt
 
-The `2-Clause BSD license`_ and the Python licenses are OSI-approved_
-and GPL-compatible_.
+All used licenses are OSI-approved_ and GPL-compatible_.
 
 Plaintext versions of all the linked-to licenses are provided in the
 licenses_ directory.
 
-.. _sandbox: http://docutils.sourceforge.net/sandbox/README.html
+.. _sandbox: https://docutils.sourceforge.io/sandbox/README.html
 .. _licenses: licenses/
-.. _Python 2.1.1 license: http://www.python.org/2.1.1/license.html
-.. _GNU General Public License: http://www.gnu.org/copyleft/gpl.html
-.. _2-Clause BSD license: http://opensource.org/licenses/BSD-2-Clause
+.. _Python 2.1.1 license: https://docs.python.org/3/license.html
+.. _GNU General Public License: https://www.gnu.org/copyleft/gpl.html
+.. _BSD 2-Clause License: http://opensource.org/licenses/BSD-2-Clause
+.. _BSD 3-Clause License: https://opensource.org/licenses/BSD-3-Clause
 .. _OSI-approved: http://opensource.org/licenses/
 .. _license-list:
-.. _GPL-compatible: http://www.gnu.org/licenses/license-list.html
+.. _GPL-compatible: https://www.gnu.org/licenses/license-list.html

_service:tar_scm:docutils-0.17.1.tar.gz/FAQ.txt -> _service:tar_scm:docutils-0.20.tar.gz/FAQ.txt Changed

@@ -1,16 +1,14 @@
-.. -*- coding: utf-8 -*-
-
+.. include:: docs/header0.txt
 
 .. NOTE TO MAINTAINERS: Please add new questions to the end of their
    sections, so section/question numbers remain stable.
 
-
 ===========================================
  Docutils FAQ (Frequently Asked Questions)
 ===========================================
 
-:Date: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
-:Revision: $Revision: 8644 $
+:Date: $Date: 2022-11-29 00:55:25 +0100 (Di, 29. Nov 2022) $
+:Revision: $Revision: 9280 $
 :Web site: https://docutils.sourceforge.io/
 :Copyright: This document has been placed in the public domain.
 
@@ -19,8 +17,8 @@
 
 
 This is a work in progress.  If you are reading a local copy, the
-`master copy`_ might be newer.  This document uses are relative links;
-if they don't work, please use the `master copy`_.
+`master copy`_ might be newer.  This document uses relative links;
+if they don't work, please use the master copy.
 
 Please feel free to ask questions and/or provide answers; send email
 to the `Docutils-users`_ mailing list.  Project members should feel
@@ -54,20 +52,19 @@
 * a `test suite`_; and
 * documentation_.
 
-For an overview of the Docutils project implementation, see `PEP
-258`_, "Docutils Design Specification".
+For an overview of the Docutils project implementation,
+see :PEP:`258`, "Docutils Design Specification".
 
 Docutils is implemented in Python_.
 
 .. _Docutils: https://docutils.sourceforge.io/
 .. _PEPs (Python Enhancement Proposals):
-   http://www.python.org/peps/pep-0012.html
+   https://peps.python.org/pep-0012
 .. _can be used by client code: docs/api/publisher.html
 .. _front-end tools: docs/user/tools.html
 .. _test suite: docs/dev/testing.html
 .. _documentation: docs/index.html
-.. _PEP 258: http://www.python.org/peps/pep-0258.html
-.. _Python: http://www.python.org/
+.. _Python: https://www.python.org/
 
 
 Why is it called "Docutils"?
@@ -99,20 +96,17 @@
 UTILitieS", with emphasis on the first syllable.
 
 .. _An Introduction to reStructuredText: docs/ref/rst/introduction.html
-__ http://mail.python.org/pipermail/doc-sig/1999-December/000878.html
-__ http://mail.python.org/pipermail/doc-sig/2000-November/001252.html
-__ http://mail.python.org/pipermail/doc-sig/2000-November/001239.html
+__ https://mail.python.org/pipermail/doc-sig/1999-December/000878.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001252.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001239.html
 __ http://homepage.ntlworld.com/tibsnjoan/docutils/STpy.html
 
 
 Is there a GUI authoring environment for Docutils?
 --------------------------------------------------
 
-DocFactory_ is under development. See also the links to editors_
-supporting reStructuredText.
+See the links to editors_ supporting reStructuredText.
 
-.. _DocFactory:
-   http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
 .. _editors: docs/user/links.html#editors
 
 
@@ -122,9 +116,9 @@
 Docutils is mainly stable, with documented APIs and architecture
 subject to change after announcement and a transition period.
 
-We fix bugs as they are reported.  So the latest code from the
-repository_ (or the snapshots_) are almost always the most stable
-as well as the most featureful.
+We fix bugs as they are reported.  This means the code from the
+repository_ (or the snapshots_) is the most stable as well as the most
+featureful most of the time.
 
 
 What is the Docutils project release policy?
@@ -141,6 +135,25 @@
 .. _repository: docs/dev/repository.html
 
 
+How can I get a new feature into Docutils?
+------------------------------------------
+
+* Present your idea at the docutils-develop_ mailing list or file a
+  ticket at Docutils' `feature request tracker`_.
+  Convince the Docutils developers that this is a valuable addition.
+
+* Contribute_.
+
+* Be patient, and be persistent.  None of us are paid to do this,
+  it's all in our spare time, which is precious and rare.
+
+.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
+.. _extensions and related projects:
+   docs/dev/policies.html#extensions-and-related-projects
+.. _feature request tracker:
+    https://sourceforge.net/p/docutils/feature-requests/
+
+
 reStructuredText
 ================
 
@@ -191,21 +204,21 @@
 acronym for "Representational State Transfer".
 
 The abbreviations "reSTX" and "rSTX"/"rstx" should **not** be used;
-they overemphasize reStructuredText's precedessor, Zope's
+they overemphasize reStructuredText's predecessor, Zope's
 StructuredText.
 
-__ http://en.wikipedia.org/wiki/Representational_State_Transfer
+__ https://en.wikipedia.org/wiki/Representational_State_Transfer
 
 
 What's the standard filename extension for a reStructuredText file?
 -------------------------------------------------------------------
 
-It's ".txt".  Some people would like to use ".rest" or ".rst" or
-".restx", but why bother?  ReStructuredText source files are meant to
-be readable as plaintext, and most operating systems already associate
-".txt" with text files.  Using a specialized filename extension would
-require that users alter their OS settings, which is something that
-many users will not be willing or able to do.
+It's ".txt".  ReStructuredText source files are meant to be readable as
+plaintext, and most operating systems already associate ".txt" with text
+files.
+
+That said, we see an increasing number of projects settling on
+the extension ".rst".
 
 Also see `What's the official MIME type for reStructuredText data?`_
 
@@ -260,10 +273,10 @@
 
 For example, say you want an em-dash (XML character entity &mdash;,
 Unicode character U+2014) in your document: use a real em-dash.
-Insert concrete characters (e.g. type a *real* em-dash) into your
+Insert literal characters (e.g. type a *real* em-dash) into your
 input file, using whatever encoding suits your application, and tell
 Docutils the input encoding.  Docutils uses Unicode internally, so the
-em-dash character is a real em-dash internally.
+em-dash character is U+2014 internally.
 
 Emacs users should refer to the `Emacs Support for reStructuredText`__
 document.  Tips for other editors are welcome.
@@ -271,7 +284,8 @@
 __ tools/editors/emacs/README.html
 
 ReStructuredText has no character entity subsystem; it doesn't know
-anything about XML charents.  To Docutils, "&mdash;" in input text is
+anything about XML character entities.
+To Docutils, "&mdash;" in input text is
 7 discrete characters; no interpretation happens.  When writing HTML,
 the "&" is converted to "&amp;", so in the raw output you'd see
 "&amp;mdash;".  There's no difference in interpretation for text
@@ -279,26 +293,19 @@
 character entity interpretation in either case.
 
 If you can't use a Unicode-compatible encoding and must rely on 7-bit
-ASCII, there is a workaround.  New in Docutils 0.3.10 is a set of
-`Standard Substitution Definition Sets`_, which provide equivalents of
-XML & HTML character entity sets as substitution definitions.  For
-example, the Japanese yen currency symbol can be used as follows::
+ASCII, there is a workaround:
+`Standard Substitution Definition Sets`_ provide equivalents of
+XML & HTML character entity sets as substitution definitions. #_
+For example, the Japanese yen currency symbol can be used as follows::
 
     .. include:: <xhtml1-lat1.txt>
 
     |yen| 600 for a complete meal?  That's cheap!
 
-Thanks to David Priest for the original idea.
+.. # Thanks to David Priest for the original idea.
 
-If you insist on using XML-style charents, you'll have to implement a
-pre-processing system to convert to UTF-8 or something.  That
-introduces complications though; you can no longer *write* about
-charents naturally; instead of writing "&mdash;" you'd have to write
-"&amp;mdash;".
-
-For the common case of long dashes, you might also want to insert the
-following substitution definitons into your document (both of them are
-using the "unicode_" directive)::
+You can create custom `substitution definitions`_ in your document
+using the "unicode_" directive, e.g.::
 
     .. |--| unicode:: U+2013   .. en dash
     .. |---| unicode:: U+2014  .. em dash, trimming surrounding whitespace
@@ -316,12 +323,9 @@
 reStructuredText parser to trim the spaces.
 
 .. _Standard Substitution Definition Sets: docs/ref/rst/definitions.html
+.. _substitution definitions: docs/ref/rst/restructuredtext.html
+                              #substitution-definitions
 .. _unicode: docs/ref/rst/directives.html#unicode-character-codes
-.. _are available: https://docutils.sourceforge.io/tmp/charents/
-.. _tarball: https://docutils.sourceforge.io/tmp/charents.tgz
-.. _description and instructions:
-   https://docutils.sourceforge.io/tmp/charents/README.html
-.. _to-do list: docs/dev/todo.html
 
 
 How can I generate backticks using a Scandinavian keyboard?
@@ -405,7 +409,7 @@
 implied endorsement or recommendation, and in no particular order:
 
 * `Ian Bicking's experimental code
-  <http://docutils.sf.net/sandbox/ianb/wiki/Wiki.py>`__
+  <https://docutils.sourceforge.io/sandbox/ianb/wiki/Wiki.py>`__
 
 * `MoinMoin <http://moinmoin.wikiwikiweb.de/>`__ has some support;
   `here's a sample <http://moinmoin.wikiwikiweb.de/RestSample>`__
@@ -440,7 +444,7 @@
 order:
 
 * `Firedrop <http://www.voidspace.org.uk/python/firedrop2/>`__
-* `PyBloxsom <http://pyblosxom.sourceforge.net/>`__
+* `PyBloxsom <http://pyblosxom.github.io/>`__
 * `Lino WebMan <http://lino.sourceforge.net/webman.html>`__
 * `Pelican <http://blog.getpelican.com/>`__
   (also  listed `on PyPi <http://pypi.python.org/pypi/pelican>`__)
@@ -512,13 +516,13 @@
 
 Short answer: no.
 
-In reStructuredText, it would be impossible to unambigously mark up
+In reStructuredText, it would be impossible to unambiguously mark up
 and parse lists without blank lines before and after.  Deeply nested
 lists may look ugly with so many blank lines, but it's a price we pay
 for unambiguous markup.  Some other plaintext markup systems do not
 require blank lines in nested lists, but they have to compromise
 somehow, either accepting ambiguity or requiring extra complexity.
-For example, `Epytext <http://epydoc.sf.net/epytext.html#list>`__ does
+For example, `Epytext <http://epydoc.sourceforge.net/epytext.html#list>`__ does
 not require blank lines around lists, but it does require that lists
 be indented and that ambiguous cases be escaped.
 
@@ -526,8 +530,9 @@
 How can I include mathematical equations in documents?
 ------------------------------------------------------
 
-Use the `math directive`_ and `math role`_, available since Docutils 0.8.
+Use `LaTeX math syntax`_ in a `math directive`_ or `math role`_.
 
+.. _LaTeX math syntax: docs/ref/rst/mathematics.html
 .. _math directive: docs/ref/rst/directives.html#math
 .. _math role: docs/ref/rst/roles.html#math
 
@@ -555,7 +560,7 @@
       Here is an |emphasized hyperlink|_.
 
       .. |emphasized hyperlink| replace:: *emphasized hyperlink*
-      .. _emphasized hyperlink: http://example.org
+      .. _emphasized hyperlink: https://example.org
 
   It is not possible for just a portion of the replacement text to be
   a hyperlink; it's the entire replacement text or nothing.
@@ -572,7 +577,7 @@
       .. |stuff| raw:: html
 
          <em>emphasized text containing a
-         <a href="http://example.org">hyperlink</a> and
+         <a href="https://example.org">hyperlink</a> and
          <tt>inline literals</tt></em>
 
   Raw LaTeX is supported for LaTeX output, etc.
@@ -765,7 +770,7 @@
 a single base direction for the whole document (like Notepad, Vim and
 text boxes in Firefox).
 
-.. _Unicode Bidi Algorithm: http://www.unicode.org/reports/tr9/
+.. _Unicode Bidi Algorithm: https://www.unicode.org/reports/tr9/
 .. _geresh: http://www.typo.co.il/~mooffie/geresh/
 .. _translate: docs/howto/i18n.html
 
@@ -786,8 +791,8 @@
     incomplete practice_ (this is still a partial implementation - but
     sufficient for most needs).
 
-    .. _theory: http://cben-hacks.sf.net/bidi/hibidi.html
-    .. _practice: http://cben-hacks.sf.net/bidi/hibidi.html#practice
+    .. _theory: http://cben-hacks.sourceforge.net/bidi/hibidi.html
+    .. _practice: http://cben-hacks.sourceforge.net/bidi/hibidi.html#practice
 
 There is also an explicit way to set directions through CSS and
 classes in the HTML:
@@ -805,7 +810,7 @@
       pre {direction: ltr; unicode-bidi: embed; }
       /* Use this if you all your inline literals (``) are LTR */
       tt {direction: ltr; unicode-bidi: embed; }
-      /* Use this if you all your interpretted text (`) is LTR */
+      /* Use this if you all your interpreted text (`) is LTR */
       cite {direction: ltr; unicode-bidi: embed; }
 
       /* Allow manual direction override by class directive and roles */
@@ -862,22 +867,66 @@
 .. # The "x-" prefix means it's an unregistered MIME type.
 
 
+How can I mark up a TODO list?
+------------------------------
+
+You may use a field list with class argument and some CSS styling.
+For an example see `Docutils TODO lists`_ and its source todo-lists.txt_.
+
+.. _Docutils TODO lists: docs/user/todo-lists.html
+.. _todo-lists.txt: docs/user/todo-lists.txt
+
+
+How can I specify an image grid?
+--------------------------------
+
+In order to arrange images (or other content) in a grid,
+a borderless `list table`_ can be used. For example::
+
+    .. list-table::
+       :class: borderless
+     
+       * - .. image:: rst/images/title-scaling.svg
+         - .. image:: rst/images/biohazard.svg
+       * - .. image:: rst/images/biohazard.svg
+         - .. image:: rst/images/biohazard.svg
+    
+Use figures, if you want also captions::
+    
+    .. list-table:: 
+      :class: borderless
+    
+      * - .. figure:: rst/images/title-scaling.svg
+    
+            Figure 1/1
+    
+        - .. figure:: rst/images/biohazard.svg
+    
+            Figure 1/2
+
+.. _list table: docs/ref/rst/directives.html#list-table
+
+
 HTML Writer
 ===========
 
 What is the status of the HTML Writer?
 --------------------------------------
 
-The default HTML Writer module, ``docutils/writers/html4css1.py``, is
+The default HTML Writer module, `html4css1`_, is
 a proof-of-concept reference implementation.  While it is a complete
 implementation, some aspects of the HTML it produces may be outdated or
 incompatible with older browsers or specialized applications (such as
 web templating).
 
+The `html5 writer`_ generates semantic HTML output compatible with HTML5.
 For the full selection see `Docutils HTML writers`_
 
+.. _html4css1: docs/user/html.html#html4css1
+.. _HTML5 writer: docs/user/html.html#html5
 .. _Docutils HTML writers: docs/user/html.html
 
+
 What browsers are supported?
 ----------------------------
 
@@ -892,99 +941,117 @@
 Unexpected results from tools/rst2html.py: H1, H1 instead of H1, H2.  Why?
 --------------------------------------------------------------------------
 
-Here's the question in full:
-
-    I have this text::
-
-        Heading 1
-        =========
-
-        All my life, I wanted to be H1.
-
-        Heading 1.1
-        -----------
-
-        But along came H1, and so shouldn't I be H2?
-        No!  I'm H1!
-
-        Heading 1.1.1
-        *************
-
-        Yeah, imagine me, I'm stuck at H3!  No?!?
-
-    When I run it through tools/rst2html.py, I get unexpected results
-    (below).  I was expecting H1, H2, then H3; instead, I get H1, H1,
-    H2::
-
-        ...
-        <html lang="en">
-        <head>
-        ...
-        <title>Heading 1</title>
-        </head>
-        <body>
-        <div class="document" id="heading-1">
-        <h1 class="title">Heading 1</h1>                <-- first H1
-        <p>All my life, I wanted to be H1.</p>
-        <div class="section" id="heading-1-1">
-        <h1><a name="heading-1-1">Heading 1.1</a></h1>        <-- H1
-        <p>But along came H1, and so now I must be H2.</p>
-        <div class="section" id="heading-1-1-1">
-        <h2><a name="heading-1-1-1">Heading 1.1.1</a></h2>
-        <p>Yeah, imagine me, I'm stuck at H3!</p>
-        ...
-
-    What gives?
-
-Check the "class" attribute on the H1 tags, and you will see a
-difference.  The first H1 is actually ``<h1 class="title">``; this is
-the document title, and the default stylesheet renders it centered.
-There can also be an ``<h2 class="subtitle">`` for the document
-subtitle.
-
-If there's only one highest-level section title at the beginning of a
-document, it is treated specially, as the document title.  (Similarly, a
-lone second-highest-level section title may become the document
-subtitle.)  See `How can I indicate the document title?  Subtitle?`_ for
-details.  Rather than use a plain H1 for the document title, we use ``<h1
-class="title">`` so that we can use H1 again within the document.  Why
-do we do this?  HTML only has H1-H6, so by making H1 do double duty, we
-effectively reserve these tags to provide 6 levels of heading beyond the
-single document title.
-
-With "html4css1", HTML is being used for dumb formatting for nothing
-but final display. A stylesheet *is required*, and one is provided;
-see `Docutils HTML writers`_.  Of course, you're
-welcome to roll your own.  The default stylesheet provides rules to
-format ``<h1 class="title">`` and ``<h2 class="subtitle">``
-differently from ordinary ``<h1>`` and ``<h2>``::
-
-    h1.title {
-      text-align: center }
-
-    h2.subtitle {
-      text-align: center }
-
-If you don't want the top section heading to be interpreted as a
-title at all, disable the `doctitle_xform`_ setting
-(``--no-doc-title`` option).  This will interpret your document
-differently from the standard settings, which might not be a good
-idea.  If you don't like the reuse of the H1 in the HTML output, you
-can tweak the `initial_header_level`_ setting
-(``--initial-header-level`` option) -- but unless you match its value
-to your specific document, you might end up with bad HTML (e.g. H3
-without H2).
-
-.. _doctitle_xform: docs/user/config.html#doctitle-xform
-.. _initial_header_level: docs/user/config.html#initial-header-level
-
-(Thanks to Mark McEahern for the question and much of the answer.)
-
-.. note:: For the html5 writer, `initial_header_level`_ defaults to
-   ``2`` because this is what the `HTML5 standard`__ expects as
-   start value for headings nested in <section> elements.
-
-   __ https://www.w3.org/TR/html53/sections.html#headings-and-sections
+This only regards output from the `html4css1`_ writer.
+The `html5 writer`_ uses H1, H2, ...
+
+.. class:: details
+
+details
+    Here's the question in full:
+
+        I have this text::
+
+            Heading 1
+            =========
+
+            All my life, I wanted to be H1.
+
+            Heading 1.1
+            -----------
+
+            But along came H1, and so shouldn't I be H2?
+            No!  I'm H1!
+
+            Heading 1.1.1
+            *************
+
+            Yeah, imagine me, I'm stuck at H3!  No?!?
+
+        When I run it through tools/rst2html.py, I get unexpected results
+        (below).  I was expecting H1, H2, then H3; instead, I get H1, H1,
+        H2::
+
+            ...
+            <html lang="en">
+            <head>
+            ...
+            <title>Heading 1</title>
+            </head>
+            <body>
+            <div class="document" id="heading-1">
+            <h1 class="title">Heading 1</h1>                <-- first H1
+            <p>All my life, I wanted to be H1.</p>
+            <div class="section" id="heading-1-1">
+            <h1><a name="heading-1-1">Heading 1.1</a></h1>        <-- H1
+            <p>But along came H1, and so now I must be H2.</p>
+            <div class="section" id="heading-1-1-1">
+            <h2><a name="heading-1-1-1">Heading 1.1.1</a></h2>
+            <p>Yeah, imagine me, I'm stuck at H3!</p>
+            ...
+
+        What gives?
+
+    Check the "class" attribute on the H1 tags, and you will see a
+    difference.  The first H1 is actually ``<h1 class="title">``; this is
+    the document title, and the default stylesheet renders it centered.
+    There can also be an ``<h2 class="subtitle">`` for the document
+    subtitle.
+
+    If there's only one highest-level section title at the beginning of a
+    document, it is treated specially, as the document title.  (Similarly, a
+    lone second-highest-level section title may become the document
+    subtitle.)  See `How can I indicate the document title?  Subtitle?`_ for
+    details.  Rather than use a plain H1 for the document title, we use ``<h1
+    class="title">`` so that we can use H1 again within the document.  Why
+    do we do this?  HTML only has H1-H6, so by making H1 do double duty, we
+    effectively reserve these tags to provide 6 levels of heading beyond the
+    single document title.
+
+    With "html4css1", HTML is being used for dumb formatting for nothing
+    but final display. A stylesheet *is required*, and one is provided;
+    see `Docutils HTML writers`_.  Of course, you're
+    welcome to roll your own.  The default stylesheet provides rules to
+    format ``<h1 class="title">`` and ``<h2 class="subtitle">``
+    differently from ordinary ``<h1>`` and ``<h2>``::
+
+        h1.title {
+          text-align: center }
+
+        h2.subtitle {
+          text-align: center }
+
+    If you don't want the top section heading to be interpreted as a
+    title at all, disable the `doctitle_xform`_ setting
+    (``--no-doc-title`` option).  This will interpret your document
+    differently from the standard settings, which might not be a good
+    idea.  If you don't like the reuse of the H1 in the HTML output, you
+    can tweak the `initial_header_level`_ setting
+    (``--initial-header-level`` option) -- but unless you match its value
+    to your specific document, you might end up with bad HTML (e.g. H3
+    without H2).
+
+    .. _doctitle_xform: docs/user/config.html#doctitle-xform
+    .. _initial_header_level: docs/user/config.html#initial-header-level
+
+    (Thanks to Mark McEahern for the question and much of the answer.)
+
+    .. note:: For the `html5 writer`_, `initial_header_level`_ defaults to
+       ``2`` because this is what the `HTML5 standard`__ expects as
+       start value for headings nested in <section> elements.
+
+       .. Sectioning content elements are always considered subsections of
+          their nearest ancestor *sectioning root* #_ or their nearest
+          ancestor element of *sectioning content*  #_, whichever is nearest,
+          ...
+
+          .. # <blockquote>, <body>, <details>, <dialog>, <fieldset>,
+                 <figure>, <td>
+          .. # <article>, <aside>, <nav>, <section>
+
+          I.e., a top-level <section> is a subsection of <body>.
+
+       __ https://www.w3.org/TR/html53/sections.html#headings-and-sections
+
 
 
 How are lists formatted in HTML?
@@ -1072,26 +1139,21 @@
 * `Python Unicode Tutorial
   <http://www.reportlab.com/i18n/python_unicode_tutorial.html>`_
 
-* `Python Unicode Objects: Some Observations on Working With Non-ASCII
-  Character Sets <http://effbot.org/zone/unicode-objects.htm>`_
-
 The common case is with the default output encoding (UTF-8), when
 either numbered sections are used (via the "sectnum_" directive) or
-symbol-footnotes.  3 non-breaking spaces are inserted in each numbered
+symbol-footnotes.  Three non-breaking spaces are inserted in each numbered
 section title, between the generated number and the title text.  Most
 footnote symbols are not available in ASCII, nor are non-breaking
 spaces.  When encoded with UTF-8 and viewed with ordinary ASCII tools,
 these characters will appear to be multi-character garbage.
 
 You may have an decoding problem in your browser (or editor, etc.).
-The encoding of the output is set to "utf-8", but your browswer isn't
+The encoding of the output is set to UTF-8, but your browser isn't
 recognizing that.  You can either try to fix your browser (enable
 "UTF-8 character set", sometimes called "Unicode"), or choose a
-different encoding for the HTML output.  You can also try
+different `output-encoding`_.  You can also try
 ``--output-encoding=ascii:xmlcharrefreplace`` for HTML or XML, but not
-applicable to non-XMLish outputs (if using runtime
-settings/configuration files, use ``output_encoding=ascii`` and
-``output_encoding_error_handler=xmlcharrefreplace``).
+applicable to non-XMLish outputs.
 
 If you're generating document fragments, the "Content-Type" metadata
 (between the HTML ``<head>`` and ``</head>`` tags) must agree with the
@@ -1105,6 +1167,7 @@
     <?xml version="1.0" encoding="utf-8" ?>
 
 .. _sectnum: docs/ref/rst/directives.html#sectnum
+.. _output-encoding: docs/user/config.html#output-encoding
 
 
 How can I retrieve the body of the HTML document?
@@ -1129,7 +1192,7 @@
 
       <?xml version="1.0" encoding="utf-8" ?>
       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-       "http://www.w3.org/TR/xht ml1/DTD/xhtml1-transitional.dtd">
+       "https://www.w3.org/TR/xht ml1/DTD/xhtml1-transitional.dtd">
 
     But this is followed by::
 
@@ -1163,29 +1226,32 @@
 
 The Sphinx_ documentation generator includes an autodoc module.
 
-.. _Sphinx: http://sphinx.pocoo.org/index.html
+.. _Sphinx: http://www.sphinx-doc.org
 
 Version 2.0 of Ed Loper's `Epydoc <http://epydoc.sourceforge.net/>`_
 supports reStructuredText-format docstrings for HTML output.  Docutils
-0.3 or newer is required.  Development of a Docutils-specific
-auto-documentation tool will continue.  Epydoc works by importing
-Python modules to be documented, whereas the Docutils-specific tool,
-described above, will parse modules without importing them (as with
-`HappyDoc <http://happydoc.sourceforge.net/>`_, which doesn't support
-reStructuredText).
+0.3 or newer is required.
+
+Development of a Docutils-specific auto-documentation tool is suspended.
 
-The advantages of parsing over importing are security and flexibility;
-the disadvantage is complexity/difficulty.
+.. Epydoc works by importing
+   Python modules to be documented, whereas the Docutils-specific tool,
+   described above, will parse modules without importing them (as with
+   `HappyDoc <http://happydoc.sourceforge.net/>`_, which doesn't support
+   reStructuredText).
 
-* Security: untrusted code that shouldn't be executed can be parsed;
-  importing a module executes its top-level code.
-* Flexibility: comments and unofficial docstrings (those not supported
-  by Python syntax) can only be processed by parsing.
-* Complexity/difficulty: it's a lot harder to parse and analyze a
-  module than it is to ``import`` and analyze one.
+   The advantages of parsing over importing are security and flexibility;
+   the disadvantage is complexity/difficulty.
 
-For more details, please see "Docstring Extraction Rules" in `PEP
-258`_, item 3 ("How").
+   * Security: untrusted code that shouldn't be executed can be parsed;
+     importing a module executes its top-level code.
+   * Flexibility: comments and unofficial docstrings (those not supported
+     by Python syntax) can only be processed by parsing.
+   * Complexity/difficulty: it's a lot harder to parse and analyze a
+     module than it is to ``import`` and analyze one.
+
+   For more details, please see "Docstring Extraction Rules"
+   in :PEP:`258`, item 3 ("How").
 
 
 Miscellaneous
@@ -1200,6 +1266,49 @@
 simplicity and extensibility, and has been influenced by the needs of
 the reStructuredText markup.
 
+
+.. _contribute:
+
+How to make code contributions that are easily accepted
+-------------------------------------------------------
+
+* Follow the `Python coding conventions`_ and `documentation
+  conventions`_ in the Docutils Policies.
+  Ensure the addition works with all `supported Python versions`_.
+
+  Look at the Docutils sources to see how similar features are
+  implemented, learn to do it "the Docutils way".
+
+* Prepare tests_. Test cases are also examples and showcases for new
+  features.
+
+* Include documentation.
+
+* For larger changes, consider creating a `feature branch`_ in a
+  Docutils repository_ checkout. #_
+
+* Mail your patch to the Docutils-develop_ mailing list or attach it to the
+  relevant ticket at Docutils' `bug tracker`_ or `feature request tracker`_.
+  We accept patches created with diff, SVN, or Git.
+
+The developers will make sure that contributions fit nicely into Docutils.
+This might involve discussing (and compromising on) design and
+implementation details. It might also lead to the conclusion that the
+addition fits better in the `extensions and related projects`_.
+
+.. # Working with branches is much easier with Git_. You can get a Git
+   clone of the repository from http://repo.or.cz/w/docutils.git or with
+   git-svn.
+
+.. _Python coding conventions: docs/dev/policies.html#python-coding-conventions
+.. _documentation conventions: docs/dev/policies.html#documentation-conventions
+.. _tests: docs/dev/testing.html
+.. _supported Python versions: README.html#requirements
+.. _feature branch: docs/dev/policies.html#feature-branch
+.. _Git: http://git-scm.com/
+.. _bug tracker: https://sourceforge.net/p/docutils/bugs/
+
+
 &#xc;
 ..
    Local Variables:

_service:tar_scm:docutils-0.17.1.tar.gz/HISTORY.txt -> _service:tar_scm:docutils-0.20.tar.gz/HISTORY.txt Changed

@@ -1,4 +1,4 @@
-.. -*- coding: utf-8 -*-
+.. include:: docs/header0.txt
 
 ==================
  Docutils History
@@ -6,24 +6,537 @@
 
 :Author: David Goodger; open to all Docutils developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-04-17 14:41:26 +0200 (Sa, 17. Apr 2021) $
-:Revision: $Revision: 8705 $
+:Date: $Date: 2023-05-09 19:55:19 +0200 (Di, 09. Mai 2023) $
+:Revision: $Revision: 9374 $
 :Web site: https://docutils.sourceforge.io/
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
 
-Release 0.17.1 (2021-04-16)
+Release 0.20 (2023-05-09)
+=========================
+
+* General
+
+  - Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
+  - Support Python 3.11 (patch #198 by Hugo van Kemenade).
+
+* docutils/core.py
+
+  - New functions `rst2…()` for use as "console_scripts" `entry points`_.
+    (cf. `Future changes` in the RELEASE-NOTES_).
+
+* docutils/frontend.py
+
+  - New configuration setting "output_". Obsoletes the ``<destination>``
+    positional argument (cf. `Future changes` in the RELEASE-NOTES_).
+
+* docutils/languages/
+  docutils/parsers/rst/languages/
+
+  - Support Ukrainian. Patch by Dmytro Kazanzhy.
+
+* docutils/nodes.py
+
+  - Fix `previous_sibling()` method that led to invalid HTML in some cases
+    (cf. patch #195).
+  - Fix bug #463. Spurious comma in deprecation warning.
+
+* docutils/parsers/recommonmark_wrapper.py
+
+  - Improved mock Sphinx module.
+
+* docutils/transforms/__init__.py
+
+  - `Transformer.populate_from_components()` now silently ignores
+    components that are not instances of `docutils.TransformSpec`.
+
+* docutils/transforms/frontmatter.py
+
+  - Accept author names with initials like ``A. Einstein`` in the "author"
+    `bibliographic field`_ instead of rising an error
+    (generally, such names are `parsed as enumerated list`__).
+
+    .. _bibliographic field:
+        docs/ref/rst/restructuredtext.html#bibliographic-fields
+    __ docs/ref/rst/restructuredtext.html#enumerated-lists
+
+* docutils/transforms/references.py
+
+  - `DanglingReferences` ignores `citation_reference` nodes if the
+    "use_bibex" setting is active. (In this case, citations are provided
+    by LaTeX/BibTeX.) Fixes bug #384.
+
+* docutils/utils/__init__.py
+
+  - New utility function `xml_declaration()`.
+  - `DependencyList.add()` accepts `pathlib.Path` instances.
+  - `find_file_in_dirs()` now returns a POSIX path also on Windows;
+    `get_stylesheet_list()` no longer converts ``\`` to ``/``.
+
+* docutils/utils/math/latex2mathml.py
+
+  - Support "mod" notation for modulo operation / modulus arithmetic.
+
+* docutils/utils/math/tex2mathml_extern.py
+
+  - Support `Pandoc` as alternative LaTeX to MathML converter.
+    Patch by Ximin Luo.
+
+* docutils/writers/_html_base.py
+
+  - Refactoring of `HTMLTranslator` initialization and collecting of
+    document "parts". Adapt HTML writers importing `_html_base`.
+
+    Changes to the HTML output (no space character before closing tag of
+    XML declaration, order of metadata elements)
+    don't affect the HTML semantics, styling, and rendering.
+
+  - Wrap definition lists with "details" class argument in a <div>
+    with the "id" and "class" values of the list node.
+
+  - Use dpub-ARIA role "doc-footnote__" (instead of ARIA role "note")
+    for footnotes.
+
+    __ https://www.w3.org/TR/dpub-aria-1.1/#doc-footnote
+
+* docutils/writers/latex2e/__init__.py
+
+  - Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
+    (UTF-8 is the default encoding for LaTeX2e since 2018).
+  - Fix behaviour of the use_bibtex_ setting.
+  - Outsource parts of `depart_document()` to new auxiliary methods
+    `make_title()` and `append_bibliography()`.
+  - Ensure POSIX paths in stylesheet loading macros.
+
+* docutils/writers/latex2e/titlepage.tex
+
+  - Drop ``\usepackage{fixltx2e}`` from template.
+    (Obsolete since 2015 and dropped from other templates in Docutils 0.14.)
+
+* docutils/writers/manpage.py
+
+  - Do not output empty "manual" in ``.TH``.
+
+* docutils/writers/xetex/__init__.py
+
+  - Ignore settings in the latex2e writer configuration file section.
+    Place common settings in section latex writers.
+
+* setup.py
+
+  - Fix SetuptoolsDeprecationWarning: ``Installing '' as data is deprecated``
+    by adding data directories to package_data.packages list.
+
+* tox.ini
+
+  - Extracted flake8 configuration and moved to ``.flake8``.
+  - changedir to directory ``test`` to avoid path problems.
+
+* test/
+
+  - Refactored tests to use common `unittest` idioms.
+    Fixes errors when running the test suite with ``python -m unittest``
+    or external test frameworks, such as Pytest_.
+
+  .. _pytest: https://pypi.org/project/pytest/
+
+* test/coverage.sh
+
+  - Removed. Use the coverage.py_ project instead,
+    ``coverage run test/alltests.py`` and ``coverage report``.
+
+  .. _coverage.py: https://pypi.org/project/coverage/
+
+* tools/
+
+  - Moved ``quicktest.py`` to ``tools/dev/``.
+
+
+Release 0.19 (2022-07-05)
+=========================
+
+* General
+
+  - Dropped support for Python 2.7, 3.5, and 3.6. and removed compatibility
+    hacks from code and tests.
+  - Code cleanup,
+    check PEP 8 conformity with `flake8` (exceptions in file tox.ini).
+
+* docutils/__main__.py
+
+  - New module. Support for ``python -m docutils``.
+    Also used for the ``docutils`` console script `entry point`_.
+
+* docutils/core.py
+
+  - Let `Publisher.publish()` print info and prompt when waiting for input
+    from a terminal (cf. https://clig.dev/#interactivity).
+  - Respect `input_encoding_error_handler`_ setting when opening a source.
+
+* docutils/io.py
+
+  - New function `error_string()`
+    obsoletes `utils.error_reporting.ErrorString`.
+  - Class `ErrorOutput` moved here from `utils.error_reporting` module.
+  - Use "utf-8-sig" instead of Python's default encoding if the
+    `input_encoding`_ setting is None.
+  - Fix error when reading of UTF-16 encoded source without trailing newline.
+  - Suppress deprecation warning (fixes bug #464).
+
+* docutils/parsers/__init__.py
+
+  - Aliases "markdown" and "commonmark" point to "commonmark_wrapper".
+  - Alias for the "myst" parser (https://pypi.org/project/myst-docutils).
+  - Use absolute module names in `_parser_aliases` instead of two
+    import attempts. (Keeps details if the `recommonmark_wrapper` module
+    raises an `ImportError`.)
+  - Prepend parser name to `ImportError` if importing a parser class fails.
+
+* docutils/parsers/commonmark_wrapper.py
+
+  - New module for parsing CommonMark input. Selects a locally installed
+    3rd-party parser (`pycmark`, `myst`, or `recommonmark`).
+
+* docutils/parsers/recommonmark_wrapper.py
+
+  - Raise `ImportError`, if import of the upstream parser module fails.
+    If called from an `"include" directive`_,
+    the system-message now has source/line info.
+  - Adapt to and test with `recommonmark` versions 0.6.0 and 0.7.1.
+
+  .. _"include" directive: docs/ref/rst/directives.html#include
+
+* docutils/parsers/rst/__init__.py
+
+  - Update PEP base URL (fixes bug #445),
+    use "https:" scheme in RFC base URL.
+  - Add `reporter` to `Directive` class attributes.
+
+* docutils/parsers/rst/directives/__init__.py
+
+  - `parser_name()` keeps details if converting  `ImportError` to  `ValueError`.
+
+* docutils/parsers/rst/roles.py
+
+  - Don't use mutable default values for function arguments. Fixes bug #430.
+
+* docutils/transforms/universal.py
+
+  - Fix bug #435: invalid references in `problematic` nodes
+    with report_level=4.
+
+* docutils/utils/__init__.py
+
+  - `decode_path()` returns `str` instance instead of `nodes.reprunicode`.
+
+* docutils/utils/error_reporting.py
+
+  - Add deprecation warning.
+
+* docutils/writers/_html_base.py
+
+  - Add "html writers" to `config_section_dependencies`. Fixes bug #443.
+  - Write table column widths with 3 digits precision. Fixes bug #444.
+
+* docutils/writers/html5_polyglot/__init__.py
+
+  - Add space before "charset" meta tag closing sequence.
+  - Remove class value "controls" from an `image` node with video content
+    after converting it to a "control" attribute of the <video> tag.
+  - Wrap groups of footnotes in an ``<aside>`` for easier styling.
+
+* docutils/writers/pep_html/
+
+  - Use "https:" scheme in "python_home" URL default.
+  - Fix links in template.txt.
+
+* setup.py
+
+  - New ``docutils``" console script `entry point`_. Fixes bug #447.
+
+* test/alltests.py
+
+  - Always encode the log file ``alltests.out`` using "utf-8".
+
+* test/DocutilsTestSupport.py
+
+  - `exception_data()` now returns None if no exception was raised.
+  - `recommonmark_wrapper` only imported if upstream parser is present.
+
+* test/test_parsers/test_rst/test_directives/test_tables.py
+
+  - Fix bug #436: Null char valid in CSV since Python 3.11.
+
+* tools/docutils-cli.py
+
+  - Allow 3rd-party drop-in components for reader and parser, too.
+  - Fix help output.
+  - Actual code moved to docutils.__main__.py.
+
+* tools/rst2odt_prepstyles.py
+
+  - Options ``-h`` and ``--help`` print short usage message.
+
+.. _entry point:
+.. _entry points:
+    https://packaging.python.org/en/latest/specifications/entry-points/
+
+
+Release 0.18.1 (2021-11-23)
 ===========================
 
+* docutils/nodes.py
+
+  - `Node.traverse()` returns a list again to restore backwards
+    compatibility. Fixes bug #431.
+
+  - New method `Node.findall()`: like `Node.traverse()` but returns an
+    iterator. Obsoletes `Node.traverse()`.
+
+* docutils/utils/__init__.py
+
+  - Fix behaviour of `get_stylesheet_list()`: do not look up stylesheets
+    given as `stylesheet`_ setting. Cf. bug #434.
+
+* docutils/writers/_html_base.py
+
+  - Fix handling of ``footnote_backlinks == False`` (report Alan G Isaac).
+
+* docutils/writers/html5_polyglot/math.css
+
+  - Fix typo (bug #432).
+
+* docutils/writers/odf_odt/__init__.py
+
+  - Fix spurious output with Windows (bug #350).
+
+* test/test_error_reporting.py
+
+  - Fix a false positive (bug #434).
+
+
+Release 0.18 (2021-10-26)
+=========================
+
+* docutils/frontend.py
+  - Mark as provisional (will switch from using `optparse` to `argparse`).
+  - Remove hack for the now obsolete "mod_python" Apache module.
+  - New function `get_default_settings()`.
+
+* docutils/nodes.py
+
+  - Don't change a list while looping over it (in
+    `document.set_name_id_map()`). Thanks to Mickey Endito.
+
+* docutils/parsers/recommonmark_wrapper.py
+
+  - Test and update to work with `recommonmark` version 0.6.0.
+    Still provisional.
+
+    Unfortunately, recommonmark_ is `no longer maintained`__.
+
+    __ https://github.com/readthedocs/recommonmark/issues/221
+
+* docutils/parsers/rst/directives/misc.py
+
+  - Fix bug #424 Wrong circular inclusion detection.
+    Use a "magic" comment instead of line numbers
+    to keep a log of recursive inclusions.
+
+* docutils/parsers/rst/states.py
+
+  -  Use a "magic" comment to update the log of recursive inclusions.
+
+* docutils/writers/html5_polyglot/__init__.py
+
+  - New option `image_loading`_. Support "lazy" loading of images.
+    Obsoletes `embed_images`_.
+
+* docutils/writers/pseudoxml.py
+
+  - Fix spelling of setting `detailed`_.
+
+* tools/docutils-cli.py
+
+  - Read settings from standard configuration files.
+
+Fix spelling errors in documentation and docstrings.
+Thanks to Dimitri Papadopoulos.
+
+
+Release 0.18b1 (2021-10-05)
+===========================
+
+* docutils/frontend.py
+
+  - The default value for the `auto_id_prefix`_ setting changed to "%":
+    auto-generated IDs use the tag name as prefix.
+
+* docutils/nodes.py
+
+  - Make meta__ a standard Docutils doctree node. Writers may ignore
+    `meta` nodes if they are not supported by the output format.
+
+    __ docs/ref/doctree.html#meta
+
+  - document.make_id(): Do not strip leading number and hyphen characters
+    from `name` if the `id_prefix`_ setting is non-empty.
+
+  - `Node.traverse()` returns an iterator instead of a list.
+
+* docutils/parsers/rst/directives/html.py
+
+  - Removed. (Meta directive moved to ``misc.py``.)
+
+* docutils/parsers/rst/directives/misc.py
+
+  - `Meta` directive class (moved from html.py) inserts `meta`
+    (instead of `pending`) nodes.
+
+  - Add `class` option to `Raw` directive.
+
+* docutils/parsers/rst/directives/tables.py
+
+  - Unify behaviour of `"widths" option`_: check that the length of an
+    integer list equals the number of table columns also for the "table"
+    directive.
+
+* docutils/tools/math/math2html.py,
+  docutils/tools/math/tex2unicode.py,
+  docutils/writers/html5/math.css
+
+  - Fork from elyxer and remove code that is not required
+    for math conversion.
+  - Scale variable sized operators and big delimiters with CSS
+  - Support more commands, fix mapping of commands to Unicode characters
+    (cf. `LaTeX syntax for mathematics`_).
+  - Fix bug #244 Wrong subscript/superscript order.
+  - Don't use <tt> element (deprecated in HTML5).
+  - Use STIX fonts if available.
+
+  .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
+
+* docutils/parsers/rst/states.py
+
+  - Fix source location (line number) for attribution elements.
+    Patch by Mickey Endito.
+  - Add line, source, and rawsource internal attributes for blockquote
+    elements. Patch by Mickey Endito.
+
+* docutils/transforms/references.py
+
+  - Skip system_messages when propagating targets. Fixes bug #425.
+
+* docutils/utils/__init__.py
+
+  - Removed `unique_combinations()` (obsoleted by `itertools.combinations()`).
+
+* docutils/utils/latex2mathml.py
+
+  - Major update (fixes and support for additional commands and symbols).
+    Fixes bug #407.
+
+* docutils/writers/_html_base.py
+
+  - Write footnote brackets and field term colons to HTML, so that
+    they are present also without CSS and when copying text.
+    Adapt ``minimal.css``.
+
+  - Use semantic tags <aside> for footnote text, topics, admonitions,
+    and system-messages and <nav> for the table of contents. Use <div>
+    for citations.
+
+  - Only specify table column widths, if the `"widths" option`_ is set
+    and is not "auto" (fixes bug #426).
+    The `table_style`_ setting "colwidths-grid" restores the current default.
+
+    .. _"widths" option: docs/ref/rst/directives.html#column-widths
+
+  - Use ARIA roles to enable accessible HTML for abstract, dedication,
+    the table of contents, footnote, references, footnotes, citations,
+    and backlinks.
+
+  - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
+    for headings of deeply nested sections.
+
+  - Do not set classes "compound-first", "compound-middle", or
+    "compound-last" to elements nested in a compound.
+    Use class value "backrefs" instead of "fn-backref" for a span of
+    back-references.
+
+  - Do not write class values handled by the HTML writer ("colwidths-auto",
+    "colwidths-given", "colwidths-grid") to the output.
+
+  - Move space character between section number and heading into
+    "sectnum" span.
+
+  - Removed attribute `HTMLTranslator.topic_classes`
+
+  - Items of a definition list with class argument "details" are
+    converted to <details> disclosure elements.
+
+* docutils/writers/html4css1/__init__.py
+
+  - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
+    (details, aside, nav, ...) and attributes (role, aria-level).
+
+* docutils/writers/latex2e/__init__.py
+
+  - The setting `legacy_class_functions`_ now defaults to "False".
+    Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
+
+  - Apply patch #181 "Fix tocdepth when chapter/part in use" by
+    John Thorvald Wodder II.
+
+  - Fix newlines after/before `ids_to_labels()` (cf. patch #183).
+
+  - Refactor/revise ToC writing.
+
+  - Don't add ``\phantomsection`` to labels in math-blocks.
+
+  - Improve spacing and allow customization of Docutils-generated table
+    of contents.
+
+  - New algorithm for table column widths. Fixes bug #422.
+    New configuration setting `legacy_column_widths`_.
+
+    `Table.set_table_style()` arguments changed.
+
+    Only write "continued on next page..." if it fits
+    without making the table columns wider.
+
+    Table "width" option overrides conflicting "auto" column "widths".
+
+* docutils/writers/latex2e/docutils.sty
+
+  - Fix excessive padding above sidebar titles.
+
+* docutils/writers/pseudoxml.py
+
+  - Fix option `detailed`_ under Python 2.7.
+
+* docutils/writers/s5_html/themes/default
+
+  - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
+    ``blank.gif`` (fixes bug #169).
+
+* docutils/writers/manpage.py
+
+  - Fix: double quotes need to be escaped on macro invocation.
+    Done everywhere.
+
+
+Release 0.17.1 (2021-04-16)
+===========================
 
 * docutils/utils/math/latex2mathml.py
 
   - Fix bug #406 (MathML translation of ``\mathbf``).
 
-* docutils/writers/latex2e/__init__.py:
+* docutils/writers/latex2e/__init__.py
 
-  - Open "docutils.sty" with encoding set to "utf8".
+  - Open ``docutils.sty`` with encoding set to "utf-8".
     Fixes bug #414: error with Py3k when locale encoding is "ascii".
 
 * docutils/parsers/*.py, docutils/transforms/*.py
@@ -36,14 +549,15 @@
   - Apply patch #160: move macro defs above ``.TH``
     (thanks Willie and sorry for the delay).
 
+
 Release 0.17 (2021-04-03)
 =========================
 
 * General
 
-  - Installing with ``setup.py`` now requires ``setuptools``.
+  - Installing with ``setup.py`` now requires `setuptools`.
     Alternatively, install with `pip`_ (or "manually").
-  - Use importlib.import_module() to programmatically import modules.
+  - Use `importlib.import_module()` to programmatically import modules.
   - Fix bug #385: Import of language modules.
 
   .. _pip: https://pypi.org/project/pip/
@@ -54,7 +568,7 @@
 
 * docutils/__init__.py
 
-  - VersionInfo: ValueError for invalid values, fix comparison to tuples.
+  - VersionInfo:  `ValueError` for invalid values, fix comparison to tuples.
 
 * docutils/languages/
   docutils/parsers/rst/languages/
@@ -66,18 +580,18 @@
 
   - Apply patch #165 "Fix error when copying `system_message` node"
     by Takeshi KOMIYA.
-  - Apply version of patch #167 "Let document.set_id() register all
-    existing IDs" (thanks to Takeshi KOMIYA).
+  - Apply version of patch #167 "Let `document.set_id()` register all
+    existing IDs". Thanks to Takeshi KOMIYA.
   - Fix bug #410: Use a "property" function to recursively fetch
     `Node.document` value from parent node.
 
 * docutils/parsers/recommonmark_wrapper.py
 
   - New, **experimental** wrapper to integrate the
-    `recommonmark`__ Markdown parser for use with Docutils.
-    Currently only tested with recommonmark version 0.4.0.
+    `recommonmark`_ Markdown parser for use with Docutils.
+    Currently only tested with `recommonmark` version 0.4.0.
 
-    __ https://pypi.org/project/recommonmark/
+    .. _recommonmark: https://pypi.org/project/recommonmark/
 
 * docutils/parsers/rst/directives/body.py
 
@@ -85,7 +599,7 @@
 
 * docutils/parsers/rst/directives/html.py
 
-  - Make "meta" elements available for "latex" and "odt".
+  - Make `meta` elements available for "latex" and "odt" writers.
 
 * docutils/parsers/rst/directives/misc.py
 
@@ -93,7 +607,7 @@
 
 * 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
@@ -106,7 +620,7 @@
 
 * docutils/writers/html*
 
-  - Implement feature request #40 `Option to embed images as data URI`.
+  - Implement feature request #40 "Option to embed images as data URI".
 
 * docutils/writers/html5_polyglot/__init__.py
 
@@ -114,33 +628,36 @@
     <footer>, <aside>, <figure>, and <figcaption>.
     See ``minimal.css`` and ``plain.css`` for styling rule examples.
 
-    Change the `initial_header_level` setting default to "2", as browsers
+    Change the `initial_header_level`_ setting default to "2", as browsers
     use the `same style for <h1> and <h2> when nested in a <section\>`__.
 
     __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
 
   - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
-    <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
-    is found in `inline` and `literal` elements.
-    Use <ins> and <del> if a matching class value
+    <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
+    is found in `inline`__ and `literal`__ elements.
+    Use <ins> and <del> if a unique matching class value
     is found in `inline`, `literal`, or `container` elements.
     Use <small> for generated code line numbers.
 
+    __ docs/ref/doctree.html#inline
+    __ docs/ref/doctree.html#literal
+
   - Fix bug #398: properly close link tag to "schema.dcterms".
 
   - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
 
     __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
-    
+
   - Use <video> for images with video MIME types supported by HTML5.
 
 * docutils/writers/html5_polyglot/minimal.css
 
   - Move non-essential styling to ``plain.css``.
     Small fixes and tweaks.
-    
+
   - Support "captionbelow" class value for tables.
-  
+
   - Display code line numbers as pseudo-elements which are skipped
     when copying text from code blocks. Solves feature request #32.
 
@@ -152,14 +669,12 @@
 
   - New optional style that adapts to different screen sizes.
 
-* docutils/writers/latex2e/__init__.py:
+* docutils/writers/latex2e/__init__.py
 
   - Use LaTeX environments for admonitions and "class wrappers" for styling
     admonitions and titles if the new configuration setting
     `legacy_class_functions`_ is False.
 
-    .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
-
   - Remove backwards compatibility code for the deprecated
     `styling command`__ prefix ``\docutilsrole``.
 
@@ -173,8 +688,6 @@
   - The special value "auto" for the `graphicx_option`_ setting
     is no longer supported (it never worked for xetex/luatex).
 
-    .. _graphicx_option: docs/user/config.html#graphicx-option
-
   - Most helper commands and element definitions are now defined in the
     LaTeX package `docutils.sty`_ and only inserted in the document
     preamble if the `stylesheet`__ setting does not list "docutils".
@@ -191,12 +704,12 @@
   - 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.)
+  - Do not write Docutils-generated ToC, when ``use_latex_toc == 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
+  - Apply version of patch #176 "LaTeX writer: Append ``\leavevmode`` to
     non-docinfo field names" by John Thorvald Wodder II.
 
 * docutils/writers/manpage.py
@@ -204,19 +717,17 @@
   - Fix #394 fix missing new line after rubric.
   - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
   - Fix #126 manpage title with spaces.
-  - Fix #380 commandline option problem in sphinx.
+  - Fix #380 command line option problem in sphinx.
 
-* docutils/writers/odf_odt/__init__.py:
+* docutils/writers/odf_odt/__init__.py
 
   - Fix/improve metadata handling:
     fix "keyword" splitting,
     allow generic fields (stored as "Custom Properties").
 
-* docutils/writers/pseudoxml.py:
-
-  - New option `detailled`__.
+* docutils/writers/pseudoxml.py
 
-    __ docs/user/config.html#detailled
+  - New option `detailled`_.
 
 * test/DocutilsTestSupport.py
 
@@ -235,13 +746,13 @@
 
   - Dropped support for Python 2.6, 3.3 and 3.4
   - Docutils now supports Python 2.7 and Python 3.5+ natively
-    (without conversion by ``2to3``).
+    (without conversion by `2to3`).
   - Keep `backslash escapes`__ in the document tree. Backslash characters in
-    text are be represented by NULL characters in the ``text`` attribute of
+    text are be represented by NULL characters in the `text` attribute of
     Doctree nodes and removed in the writing stage by the node's
-    ``astext()`` method.
+    `astext()` method.
 
-  __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
+  __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
 
 * docutils/io.py
 
@@ -251,11 +762,9 @@
 
   - Speed up Node.next_node().
   - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
-  - Warn about Node.traverse() returning an iterator instead of a list
+  - Warn about `Node.traverse()` returning an iterator instead of a list
     in future.
 
-  .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
-
 * docutils/statemachine.py
 
   - Patch  158 : Speed up patterns by saving compiled versions (eric89gxl)
@@ -267,10 +776,10 @@
 
 * docutils/utils/__init__.py
 
-  - unescape() definition moved to `nodes` to avoid circular import
+  - `unescape()` definition moved to `nodes` to avoid circular import
     dependency. Fixes  366 .
 
-* docutils/writers/latex2e/__init__.py:
+* docutils/writers/latex2e/__init__.py
 
   - Fix topic subtitle.
   - Make "rubric" bold-italic and left aligned.
@@ -286,11 +795,11 @@
   - Apply fix for  287  comma after option is bold.
   - Apply fix for  289 , line starting with ``.`` in a text.
 
-* docutils/writers/odf_odt/__init__.py:
+* docutils/writers/odf_odt/__init__.py
 
   - Fix: ElementTree.getchildren deprecated warning
 
-* docutils/writers/xetex/__init__.py:
+* docutils/writers/xetex/__init__.py
 
   - Add "latex writers" to the `config_section_dependencies`.
 
@@ -304,24 +813,22 @@
   - Fix: 377 ResourceWarning: unclosed file python3.8
     Read defaults file with context.
 
-  - Set "auto_id_prefix" to "%" (expands to tag-names).
+  - Set `auto_id_prefix`_ to "%" (expands to tag-names).
     Results in descriptive links in HTML and more localized changes when
     editions to the input add or remove auto-ids.
 
-* test/test_io.py:
+* test/test_io.py
 
-  - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
+  - Apply patch #157: avoid test failure because of a `ResourceWarning`.
 
-* test/test_writers/test_odt.py:
+* test/test_writers/test_odt.py
 
-  - Fix  359 : Test suite failes on Python 3.8. odt xml sorting.
+  - Fix  359 : Test suite fails on Python 3.8. odt XML sorting.
     Use ElementTree instead of minidom.
 
 * tools/buildhtml.py
 
-  - New option `html-writer`_.
-
-  .. _html-writer: docs/user/config.html#html-writer
+  - New option `html_writer`_.
 
 
 Release 0.15.1 (2019-07-24)
@@ -340,7 +847,7 @@
   - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
   - Infrastructure automation.
 
-* docs/ref/rst/restructuredtext.txt:
+* docs/ref/rst/restructuredtext.txt
 
   - Document rST syntax change: Tokens like ``:this:example:`` are now valid
     field list names (instead of ordinary text).
@@ -348,52 +855,51 @@
 * docutils/io.py
 
   - Fix  348  Since Python 3.4, the 'U' universal newlines mode has been
-    deprecated (thanks to hugovk).
+    deprecated. Thanks to hugovk.
 
-*  docutils/languages/ko.py
-   docutils/parsers/rst/languages/ko.py:
+* docutils/languages/ko.py, docutils/parsers/rst/languages/ko.py
 
   - Apply  153  Korean mappings by Thomas Sungjin Kang.
 
 * docutils/nodes.py
 
-  - Fix  251  system_message.copy() TypeError.
-  - Element.copy() also copies `document`, `line`, and `source` attributes.
+  - Fix  251  `system_message.copy()`  `TypeError`.
+  - `Element.copy()` also copies `document`, `line`, and `source` attributes.
 
-* docutils/parsers/rst/__init__.py:
+* docutils/parsers/rst/__init__.py
 
   - Apply  152  reset `default role` at end of document.
 
-* docutils/parsers/rst/states.py:
+* docutils/parsers/rst/states.py
 
   - Allow embedded colons in field list field names.
 
-* docutils/parsers/rst/directives/html.py:
+* docutils/parsers/rst/directives/html.py
 
   - Fix bug #281: Remove escaping backslashes in meta directive content.
 
-* docutils/parsers/rst/directives/misc.py:
+* docutils/parsers/rst/directives/misc.py
 
   - Don't convert tabs to spaces, if `tab_width` is negative in
-    `include` directive with `code` option.
+    "include" directive with "code" option.
 
-* docutils/parsers/rst/directives/tables.py:
+* docutils/parsers/rst/directives/tables.py
 
   - Apply patch #121: Add "width" option for the table directives.
 
-* docutils/transforms/frontmatter.py:
+* docutils/transforms/frontmatter.py
 
   - Add field name as class argument to generic docinfo fields unconditionally.
 
-* docutils/transforms/references.py:
+* docutils/transforms/references.py
 
   - Fix bug #331: fixed the "trim" options of the "unicode" directive.
 
-* docutils/utils/__init__.py:
+* docutils/utils/__init__.py
 
-  - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
+  - Deprecate `unique_combination()` (obsoleted by `itertools.combination()`.
 
-* docutils/utils/smartquotes.py:
+* docutils/utils/smartquotes.py
 
   - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
 
@@ -406,18 +912,18 @@
 
   - Fix bug #358: Non-breaking space removed from fixed-width literal.
 
-* docutils/writers/latex2e/__init__.py:
+* docutils/writers/latex2e/__init__.py
 
   - Fix bug #323: spurious ``\phantomsection`` and whitespace in
     ``parts'title'``.
-  - Fix bug #324: Invalid LaTeX for table with empty multicolumn cell.
+  - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
   - Fixes to literal block handling.
 
 
 Release 0.14 (2017-08-03)
 =========================
 
-* docs/ref/docutils.dtd:
+* docs/ref/docutils.dtd
 
   - Enable validation of Docutils XML documents against the DTD:
 
@@ -429,49 +935,49 @@
 
   __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
 
-* docs/ref/rst/restructuredtext.txt:
+* docs/ref/rst/restructuredtext.txt
 
   - Added documentation for escaped whitespace in URI contexts.
   - Clarify use of Unicode character categories.
 
-* docutils/parsers/rst/states.py:
+* docutils/parsers/rst/states.py
 
   - Added functionality: escaped whitespace in URI contexts.
   - Consistent handling of all whitespace characters in inline markup
     recognition. Fixes  307  and  3402314  (now  173 ).
 
-* docutils/parsers/rst/directives/images.py:
+* docutils/parsers/rst/directives/images.py
 
   - Added support for escaped whitespace in URI contexts.
 
-* docutils/parsers/rst/directives/tables.py:
+* docutils/parsers/rst/directives/tables.py
 
-  - Rework patch  120  (revert change to ``Table.get_column_widths()``
+  - Rework patch  120  (revert change to Table.get_column_widths()
     that led to problems in an application with a custom table directive).
 
-* docutils/transforms/frontmatter.py:
+* docutils/transforms/frontmatter.py
 
   - Fix  320  Russian docinfo fields not recognized.
 
-* docutils/transforms/references.py:
+* docutils/transforms/references.py
 
   - Don't add a second ID to problematic references.
 
-* docutils/transforms/universal.py:
+* docutils/transforms/universal.py
 
-  Fix SmartQuotes: warn only once if language is unsupported,
+  Fix `SmartQuotes`: warn only once if language is unsupported,
   keep "rawsource" when "educating" quotes.
 
-* docutils/utils/__init__.py:
+* docutils/utils/__init__.py
 
-  - Added ``split_escaped_whitespace`` function, support for escaped
+  - Added `split_escaped_whitespac()` function, support for escaped
     whitespace in URI contexts.
 
-* docutils/utils/error_reporting.py:
+* docutils/utils/error_reporting.py
 
   - Fix  321  Import block might cause name error.
 
-* docutils/utils/smartquotes.py:
+* docutils/utils/smartquotes.py
 
   - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
   - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
@@ -480,44 +986,44 @@
   - Fix  317  Extra space inserted with French smartquotes.
   - Add command line interface for stand-alone use (requires 2.7).
 
-* docutils/writers/_html_base.py:
+* docutils/writers/_html_base.py
 
   - Provide default title in metadata (required by HTML5).
   - Fix  312  HTML writer generates invalid HTML if the table has two tags.
   - Fix  319  The MathJax CDN shut down on April 30, 2017. For security
     reasons, we don't use a third party public installation as default but
-    warn if math-output_ is set to MathJax without specifying a URL.
+    warn if `math_output`_ is set to MathJax without specifying a URL.
 
-* docutils/writers/html4css1/__init__.py:
+* docutils/writers/html4css1/__init__.py
 
   - Apply  125  HTML writer: respect automatic table column sizing.
 
-* docutils/writers/latex2e/__init__.py:
+* docutils/writers/latex2e/__init__.py
 
   - Handle class arguments for block-level elements by wrapping them
     in a "DUclass" environment. This replaces the special handling for
-    "epigraph" and "topic" elements.
+    `epigraph` and `topic` elements.
 
-* docutils/writers/manpage.py:
+* docutils/writers/manpage.py
 
   - Apply  141  Handling inline in manpage writer.
 
-* docutils/writers/odf_odt/__init__.py:
+* docutils/writers/odf_odt/__init__.py
 
-  - Command setting ``language`` now sets the default language
+  - Command line setting `language`_ now sets the default language
     of the generated ODF document.
   - The use of image directive options :width: (%), :scale:, etc now
     set the width/height/size of images in the generated ODF
     documents.
   - The heading/title of admonitions now reflects the language
-    specified by the ``language`` setting.
+    specified by the `language`_ setting.
   - Fixed  306  only first of multiple "image" directives with the same URL
     shown in output.
-  - Fixed  282  python3: AttributeError.
+  - Fixed  282  python3:  `AttributeError`.
 
 * tools/rst2html4.py: New front-end.
 
-* tools/dev/generate_punctuation_chars.py: New skript
+* tools/dev/generate_punctuation_chars.py: New script
   to test and update utils.punctuation_chars.
 
 
@@ -569,12 +1075,12 @@
 
 * docutils/utils/error_reporting.py
 
-  - Fix  130  support streams expectiong byte-strings in ErrorOutput.
+  - Fix  130  support streams expecting byte-strings in ErrorOutput.
 
 * docutils/utils/math/math2html.py
 
   - Add ``\colon`` macro, fix spacing around colons. Fixes  246 .
-  - New upstream version (additional macros, piecewise integrals and sums).
+  - New upstream version (additional macros, piece-wise integrals and sums).
 
 * docutils/writers/_html_base.py
 
@@ -592,7 +1098,7 @@
 
   - Add "docutils" to class values for "container" object to address  267 .
   - Apply patch  119  by Anatoly Techtonik: use absolute paths for
-    ``default_stylesheet_path`` and ``default_template_path``.
+    `default_stylesheet_path` and `default_template_path`.
   - Fix  266  creating labels/class values in description list items.
   - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
   - Fix footnotes with content that does not start with a paragraph.
@@ -604,14 +1110,14 @@
   - Fix  262  Use ``\linewidth`` instead of ``\textwidth`` for figures,
     admonitions and docinfo.
 
-  - Use absolute path for ``default_template_path``.
+  - Use absolute path for `default_template_path`.
 
   - Removed deprecated options ``--use-latex-footnotes`` and
     ``--figure-footnotes``.
 
   - Cleaner LaTeX code for enumerations and literal blocks.
 
-  - Use "hyperref" package together with "bookmark" (improved hyperlinking
+  - Use `hyperref` package together with `bookmark` (improved hyperlinking
     by the same author).
 
   - Fix  286  Empty column title cause invalid latex file.
@@ -627,7 +1133,7 @@
 
 * docutils/writers/xetex/__init__.py
 
-  - LuaLaTex compatibility: do not load "xunicode".
+  - LuaLaTex compatibility: do not load `xunicode` package.
 
 * tools/
 
@@ -637,12 +1143,12 @@
 
   - Test py26, py27, py33 and py34.
 
-    To use, install the ``tox`` package via pip or easy_install and use
+    To use, install the `tox` package via pip or easy_install and use
     tox from the project root directory.
 
-.. _polyglot: http://www.w3.org/TR/html-polyglot/
-.. _HTML 5: http://www.w3.org/TR/html5/
-.. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
+.. _polyglot: https://www.w3.org/TR/html-polyglot/
+.. _HTML 5: https://www.w3.org/TR/html5/
+.. _XHTML 1.0: https://www.w3.org/TR/xhtml1/
 
 
 Release 0.12 (2014-07-06)
@@ -654,7 +1160,7 @@
 
 * docutils/parsers/rst/directives/images.py
 
-  - Fix  258  figwidth="image" generates unitless width value.
+  - Fix  258  ``figwidth="image"`` generates unitless width value.
 
 * docutils/parsers/rst/states.py
 
@@ -670,7 +1176,7 @@
 * docutils/writers/latex2e/__init__.py
 
   - Fix  239  Latex writer glues paragraphs with figure floats.
-  - Apply  116  by Kirill Smelkov. Don't hardcode \large for subtitle.
+  - Apply  116  by Kirill Smelkov. Don't hard code \large for subtitle.
 
 * docutils/writers/odf_odt/__init__.py
 
@@ -682,25 +1188,26 @@
 
 * test/test_nodes.py
 
-  - Apply  115  respect fixed 2to3 string literal conversion behavior.
+  - Apply  115  respect fixed 2to3 string literal conversion behaviour.
+
 
 Release 0.11 (2013-07-22)
 =========================
 
 * General
 
-  - Apply  2714873  Fix for the overwritting of document attributes.
+  - Apply  2714873  Fix for the overwriting of document attributes.
   - Support embedded aliases within hyperlink references.
   - Fix  228  try local import of docutils components (reader, writer, parser,
     language module) before global search.
 
 * docutils/nodes.py
 
-  - Fix  3601607  node.__repr__() must return `str` instance.
+  - Fix  3601607  `node.__repr__()` must return `str` instance.
 
 * docutils/parsers/rst/directives/__init__.py
 
-  - Fix  3606028  ``assert`` is skipped with ``python -O``.
+  - Fix  3606028  `assert` is skipped with ``python -O``.
 
 * docutils/parsers/rst/directives/images.py
 
@@ -721,36 +1228,37 @@
 
 * docutils/utils/__init__.py
 
-  - Fix  3596884  exception importing ``docutils.io``.
+  - Fix  3596884  exception importing `docutils.io`.
 
 * docutils/writers/html4css1/__init__.py
 
   - Fix  3600051  for tables in a list, table cells are not compacted.
-  - New setting `stylesheet_dirs`: Comma-separated list of directories
+  - New setting `stylesheet_dirs`_: Comma-separated list of directories
     where stylesheets are found. Used by `stylesheet_path` when expanding
     relative path arguments.
-  - New default for math-output_: ``HTML math.css``.
+  - New default for `math_output`_: ``HTML math.css``.
   - Avoid repeated class declarations in html4css1 writer
     (modified version of patch  104 ).
 
-.. _math-output: docs/user/config.html#math-output
 
 * docutils/writers/latex2e/__init__.py
 
   - Drop the simple algorithm replacing straight double quotes with
     English typographic ones.
-    Activate the SmartQuotes_ transform if you want this feature.
+    Use the `smart_quotes`_ setting to activate this feature.
   - Fix literal use of babel shorthands (straight quote, tilde, ...).
-  - Fix  3603246  Bug in option "--graphicx-option=auto".
-  - New setting `stylesheet_dirs`.
+  - Fix  3603246  Bug in option ``--graphicx-option=auto``.
+  - New setting `stylesheet_dirs`__.
+
+    __ docs/user/config.html#stylesheet-dirs-latex-writers
 
-.. _SmartQuotes: docs/user/config.html#smart-quotes
 
 * docutils/writers/manpage.py
 
   - Fix 3607063 handle lines starting with a period.
   - Fix option separating comma was bold (thanks to Bill Morris).
 
+
 Release 0.10 (2012-12-16)
 =========================
 
@@ -763,7 +1271,7 @@
   - Fix 3559988 and 3560841 __import__ local writer, reader, languages
     and parsers for Python 2.7 up.
   - Fix import of PIL.Image.
-  - Change default of "syntax highlight" option to "long",
+  - Change default of `syntax_highlight`_ option to "long",
     basic syntax highlight styles for LaTeX and HTML.
 
 * docutils/io.py
@@ -775,7 +1283,7 @@
 
 * docutils/parsers/rst/directives/misc.py
 
-  - Fix  3546533  Unicode error with `date` directive.
+  - Fix  3546533  Unicode error with "date" directive.
 
 * docutils/transforms/universal.py
 
@@ -783,8 +1291,8 @@
 
 * docutils/utils/__init__.py
 
-  - normalize_language_tag() now returns `BCP 47`_ conformant tags
-    with subtags separated by ``-``.
+  - `normalize_language_tag()` now returns `BCP 47`_ conforming tags
+    with sub-tags separated by ``-``.
 
 * docutils/writers/html4css1/__init__.py
 
@@ -795,7 +1303,7 @@
 
 * docutils/writers/manpage.py
 
-  - Apply  3527401  addmonition's don't preserve indentation
+  - Apply  3527401  admonition's don't preserve indentation
   - Apply  3527397  Add indentation to literal blocks in manpage writer.
 
 * docutils/writers/xetex/__init__.py
@@ -805,12 +1313,12 @@
 
 * docutils/writers/s5_html/__init__.py
 
-  - Fix  3556388  Mathjax does not work with rst2s5.
+  - Fix  3556388  MathJax does not work with rst2s5.
 
-* docutils/writers/s5_html/docutils_xml.py
+* docutils/writers/docutils_xml.py
 
   - Fix  3552403  Prevent broken PyXML replacing stdlibs xml module.
-  - Fix/improve output with ``--indent`` option.
+  - Fix/improve output with `indents`_ setting.
 
 * setup.py
 
@@ -857,9 +1365,10 @@
 
 * test/alltests.py
 
-  - class `Tee`: catch UnicodeError when writing to "ascii" stream or
+  - class `Tee`: catch  `UnicodeError` when writing to "ascii" stream or
     file under Python 3.
 
+
 Release 0.9 (2012-05-02)
 ========================
 
@@ -872,8 +1381,8 @@
     via ``import PIL`` as starting with PIL 1.2,
     "PIL lives in the PIL namespace only" (announcement__).
 
-.. _Pygments: http://pygments.org/
-__ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
+.. _Pygments: https://pygments.org/
+__ https://mail.python.org/pipermail/image-sig/2011-January/006650.html
 
 * setup.py
 
@@ -882,36 +1391,30 @@
 
 * docutils/frontend.py
 
-  - Fix  3481980  Use os.getcwdu() in make_paths_absolute().
+  - Fix  3481980  Use `os.getcwdu()` in `make_paths_absolute()`.
 
 * docutils/io.py
 
   - Fix  3395948  (Work around encoding problems in Py3k).
   - `mode` argument for FileOutput avoids code replication in
     BinaryFileOutput.
-  - New exceptions InputError and OutputError for IO errors in
+  - New exceptions  `InputError` and  `OutputError` for IO errors in
     FileInput/FileOutput.
 
-* docutils/core.py:
+* docutils/core.py
 
   - No "hard" system exit on file IO errors: catch and report them in
     `Publisher.reportException` instead. Allows handling by a calling
-    application if the configuration setting `traceback` is True.
+    application if the configuration setting `traceback`_ is True.
 
 * docutils/utils.py -> docutils/utils/__init__.py
 
   - docutils.utils is now a package (providing a place for sub-modules)
 
-  .. note:: docutils/math, docutils/error_reporting.py, and
-     docutils/urischemes.py will move to the utils package in the next
-     release, too. See RELEASE-NOTES__
-
-     __ RELEASE-NOTES.html
-
-  - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
+  - DependencyList uses io.FileOutput and 'utf-8' encoding to prevent
     errors recording non-ASCII filenames (fixes  3434355 ).
 
-  - Fix relative_path() with source=None and `unicode` target.
+  - Fix `relative_path()` with source=None and `unicode` target.
 
 * docutils/parsers/rst/states.py
 
@@ -932,8 +1435,8 @@
   - Fix handling of missing stylesheets.
   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
     when suppressing LaTeX section numbering.
-  - Use ``\DUtitle`` for unsupported section levels
-  - Apply  3512791  do not compare string literals with "is"
+  - Use ``\DUtitle`` for unsupported section levels.
+  - Apply  3512791  do not compare string literals with "is".
 
 * docutils/writers/xetex/__init__.py
 
@@ -941,12 +1444,12 @@
 
 * docutils/writers/html4css1/__init__.py
 
-  - Change default for `math-output` setting to MathJax.
+  - Change default for `math_output`_ setting to MathJax.
   - Fix handling of missing stylesheets.
 
 * docutils/writers/docutils_xml.py
 
-  - Use the visitor pattern with default_visit()/default_depart() methods
+  - Use the visitor pattern with `default_visit()`/`default_depart()` methods
     instead of minidom to facilitate special handling of selected nodes.
   - Support raw XML (inserted as-is inside a <raw></raw> node).
 
@@ -954,6 +1457,7 @@
 
   - Do not emit comment line with trailing blank. Problematic for VCS.
 
+
 Release 0.8.1 (2011-08-30)
 ==========================
 
@@ -970,6 +1474,7 @@
 
   - Clean up Babel language setting. Restores Sphinx compatibility.
 
+
 Release 0.8 (2011-07-07)
 ========================
 
@@ -979,16 +1484,16 @@
   - If the specified language is not supported by Docutils,
     warn and fall back to English.
   - Math support: reStructuredText "math" role and directive,
-    ``math`` and ``math_block`` doctree elements.
+    `math` and `math_block` doctree elements.
   - Decode command line arguments with the locale's preferred encoding
     (to allow, e.g., ``--title=Dornröschen``).
-  - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
+  - Orphaned `python` reader and `newlatex2e` writer moved to the sandbox.
   - New sub-module `error_reporting`: handle encoding/decoding errors
     when reporting exceptions.
   - Some additions to the Docutils core are released under the 2-Clause BSD
     license, see COPYING_ for details.
 
-  .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
+  .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
   .. _COPYING: COPYING.html
 
 * reStructuredText:
@@ -999,13 +1504,13 @@
   - Directive content may start on the first line also when the directive
     type accepts options.
 
-* docs/dev/policies.txt:
+* docs/dev/policies.txt
 
   - Recommend the 2-Clause BSD license
     (http://opensource.org/licenses/BSD-2-Clause)
     for code that is kept under the author's copyright.
 
-* tools/buildhtml.py:
+* tools/buildhtml.py
 
   - Fix ``--local`` switch.
 
@@ -1015,19 +1520,19 @@
 
   - Set "lang" argument for objects with class argument
     "language-<language tag>".
-  - New setting "math-output" with support for HTML, MathML, and LaTeX.
+  - New setting `math_output`_ with support for HTML, MathML, and LaTeX.
 
 * docutils/writers/latex2e/__init__.py
 
-  - Fix  3043986  AttributeError using :local: with table of content.
+  - Fix  3043986   `AttributeError` using :local: with table of content.
   - Place title data in the document preamble.
   - Load `babel` package only if required.
   - Update list of supported languages.
-  - New config setting "hyperref-options".
+  - New config setting `hyperref_options`_.
     No hard-coded "unicode" hyperref option (clash with xetex).
   - Set language for custom roles, paragraphs, block-quotes, and
     line-quotes with class argument "language-<language tag>".
-  - Fix  3095603  wrong quotes output for russian and other languages.
+  - Fix  3095603  wrong quotes output for Russian and other languages.
   - Convert image URI to a local file path.
   - Apply  3148141  fix multicolumn support when a colspanning cell
     has more than one paragraph (Wolfgang Scherer).
@@ -1046,27 +1551,28 @@
   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
   - Fix: vertical space cleaning for option group ``.``.
 
-* tools/editors/emacs/rst.el:
+* tools/editors/emacs/rst.el
 
-  - Fix  3001100  does not handle spaces in filenames
-    (thanks to Jakub Wilk)
+  - Fix  3001100  does not handle spaces in filenames.
+    Thanks to Jakub Wilk.
 
-* docutils/utils.py:
+* docutils/utils.py
 
   - strip whitespace from stylesheet arguments
   - exclude combining chars from column_width()
     (partial fix for  2926161 )
 
-* docutils/parsers/rst/directives/misc.py:
+* docutils/parsers/rst/directives/misc.py
 
   - Fix  1830389  Replace not breaking on getting system_messages from
     nested_parse
 
-* docutils/io.py:
+* docutils/io.py
 
-  - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
+  - Do not ``close()`` `sys.stdin`, `sys.stdout`, or `sys.stderr`. Prevents
     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
 
+
 Release 0.7 (2010-07-07)
 ========================
 
@@ -1086,12 +1592,12 @@
 
 * docutils/utils.py
 
-  - Fix  2923723  let decode_path() tolerate path == None
+  - Fix  2923723  let `decode_path()` tolerate ``path == None``.
 
 * docutils/writers/html4css1/__init__.py
 
   - Support SVG and SWF images (thanks to Stefan Rank).
-  - Generate valid XHTML for centered images with targets.
+  - Generate valid XHTML for centred images with targets.
     Use CSS classes instead of "align" tags for image alignment.
 
 * docutils/writers/latex2e/__init__.py
@@ -1101,14 +1607,14 @@
   - Use the ``\url`` command for URLs (breaks long URLs instead of
     writing into the margin).
   - Preserve runs of spaces in `inline literals`__.
-  - Deprecate ``figure_footnotes`` setting.
-  - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
-  - New ``latex_preamble`` setting.
+  - Deprecate `figure_footnotes`_ setting.
+  - Rename `use_latex_footnotes`_ setting to `docutils_footnotes`_.
+  - New `latex_preamble`_ setting.
   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
   - Fix hyperlink targets (labels) for images, figures, and tables.
   - Apply  2961988  Load babel after inputenc and fontenc.
   - Apply  2961991  Call hyperref with unicode option.
-  - Drop the special `output_encoding`__ default ("latin-1").
+  - Drop the special `output_encoding`_ default ("latin-1").
     The Docutils wide default (usually "UTF-8") is used instead.
   - Render inline markup in document title and subtitle.
   - Fix numbering depth with LaTeX section numbering.
@@ -1116,8 +1622,6 @@
   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
 
 __ docs/ref/restructuredtext.html#inline-literals
-__ docs/user/config.html#docutils-footnotes
-__ docs/user/config.html#output_encoding
 
 * docutils/writers/manpage.py
 
@@ -1129,9 +1633,9 @@
 * docutils/nodes.py
 
   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
-    turkish locale.
+    Turkish locale.
 
-* setup.py:
+* setup.py
 
   - Python 3 support: copy test/ and tools/ to the build-dir
     and convert Python sources with 2to3.
@@ -1147,7 +1651,7 @@
 
     + Node.__nonzero__ returns True instead of 1.
     + use os.walk instead os.path.walk.
-    + minimize "types" module where possible.
+    + minimize `types` module where possible.
     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
     + Text nodes now subclass unicode rather than UserString
       (which is gone in python 3.0).
@@ -1157,8 +1661,8 @@
     + Drop extras/optparse.py and extras/textwrap.py
       (stdlib modules since 2.3).
 
-  - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
-  - Unix man page export: manpage writer moved from sandbox to Doctutils
+  - OpenOffice export: ODT writer moved from sandbox to Docutils core.
+  - Unix man page export: manpage writer moved from sandbox to Docutils
     core.
 
   - Apply  1719345  Galician translation
@@ -1168,12 +1672,12 @@
   - Fix  1692788  allow UTF-8 in style sheets.
   - Fix  2781629  support non-ASCII chars in file names.
   - Apply  2845002  let ``--no-raw`` disable raw *roles* too.
-  - Fix  2831643  by renaming DirectiveError.message to DirectiveError.msg
-  - Fix  2821266  --strict option works now like --halt=info.
-  - Fix  2788716  DirectiveError now correctly reports source and line.
+  - Fix  2831643  renaming `DirectiveError.message` to `DirectiveError.msg`
+  - Fix  2821266  ``--strict`` option works now like ``--halt=info``.
+  - Fix  2788716   `DirectiveError` now correctly reports source and line.
   - Fix  1627229  hyperlink references in substitutions.
 
-  - The "newlatex" writer is orphaned.
+  - The `newlatex` writer is orphaned.
 
 * reStructuredText:
 
@@ -1188,7 +1692,7 @@
 
 * docutils/nodes.py:
 
-  - Added ``Element.__contains__`` method, for the in-operator.
+  - Added `Element.__contains_()` method, for the in-operator.
 
 * docutils/parsers/rst/states.py:
 
@@ -1206,7 +1710,7 @@
 
 * docutils/utils.py:
 
-  - Add ``get_stylesheet_list`` function.
+  - Add `get_stylesheet_lis()` function.
   - Apply  2834836  print info at halt
 
 * docutils/transforms/universal.py:
@@ -1216,12 +1720,12 @@
 
 * docutils/writers/html4css1/__init__.py:
 
-  - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
+  - `stylesheet`_ and `stylesheet_path`_ settings support a comma
     separated list of stylesheets.
   - Address  1938891  Inline literal text creates "pre" span only when
     needed to prevent inter-word line wraps.
-  - Use `translate` method instead of repeated `replace` calls.
-  - Fix  1757105  New ``table-style`` option. Added to standard table
+  - Use `translate()` method instead of repeated `replace()` calls.
+  - Fix  1757105  New `table_style`_ setting. Added to standard table
     classes to allow CSS styling that does not interfere with other
     table-using constructs (field lists, citations, ...).
 
@@ -1231,18 +1735,18 @@
 
 * docutils/writers/latex2e/__init__.py:
 
-  - Add ``--embed-stylesheet`` option.
+  - Add `embed_stylesheet`_ setting.
   - Apply  1474017  image vertical alignment is reversed.
   - Apply  2051599  multi-page tables in latex writer (from pabigot).
   - Change: has_key for dictionaries (not Nodes) to in-operator.
   - Merge adjacent citations into one latex cite command.
-  - Failsave implementation of custom roles. LaTeX compilation now ignores
+  - Failsafe implementation of custom roles. LaTeX compilation now ignores
     unknown classes instead of aborting with an error.
   - Support custom roles based on standard roles.
-  - LaTeX packages can be used as ``--stylesheet`` arguments without
+  - LaTeX packages can be used as `stylesheet`_ arguments without
     restriction. (A style sheet is now referenced with the ``\usepackage``
     command, if it ends with ``.sty`` or has no extension.)
-  - Add ``bp`` to lenghts without unit (prevents LaTex errors).
+  - Add ``bp`` to lengths without unit (prevents LaTeX errors).
   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
     2005-02-04 as a configurable length unit).
@@ -1255,7 +1759,7 @@
   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
   - New custom environments and commands with optional "classes" argument.
   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
-  - Better conformance to Docutils specifications with ``--use-latex-toc``.
+  - Better conformance to Docutils specifications with `use_latex_toc`_.
     Support for LaTeX generated ToC also with unnumbered sections.
   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
     section numbering by LaTeX.
@@ -1271,14 +1775,14 @@
   - In the default template, load cmap.sty (fix text extraction in PDF) and
     fixltx2e.sty (LaTeX patches, \textsubscript).
   - Render doctest blocks as literal blocks (fixes  1586058 ).
-  - Use `translate` instead of repeated `replace` calls for text encoding.
+  - Use `translate()` instead of repeated `replace()` calls for text encoding.
   - Hyperlinked footnotes and support for symbol footnotes and
     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
   - Complete pairs of binary options
     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
   - New defaults:
-    - font-encoding: "T1" (formerly implicitely set by 'ae').
+    - font-encoding: "T1" (formerly implicitly set by 'ae').
     - use-latex-toc: true (ToC with page numbers).
     - use-latex-footnotes: true (no mixup with figures).
 
@@ -1290,6 +1794,7 @@
 
 * docutils/tools/rst2man.py
 
+
 Release 0.5 (2008-06-25)
 ========================
 
@@ -1304,11 +1809,8 @@
   - Configuration files are now assumed and required to be
     UTF-8-encoded.
   - Paths of applied configuration files are now recorded in the
-    runtime setting ``_config_files`` (accessible via
-    ``--dump-settings``).
-  - Added ``--strip-elements-with-class`` and ``--strip-class``
-    options (``strip_elements_with_classes`` and ``strip_classes``
-    settings).
+    runtime setting `_config_files`_ (accessible via `dump_settings`_).
+  - Added `strip_elements_with_classes`_ and `strip_classes`_ settings.
 
 * docutils/io.py:
 
@@ -1318,7 +1820,7 @@
 
 * docutils/nodes.py:
 
-  - Added ``document.__getstate__`` method, for pickling.
+  - Added `document.__getstate_()` method, for pickling.
 
 * docutils/parsers/rst/states.py:
 
@@ -1332,21 +1834,21 @@
     "⁃".
   - Added support for new object-oriented directive interface,
     retaining compatibility to the old functional interface.
-  - Added support for throwing ``DirectiveError``'s from within
+  - Added support for throwing `DirectiveError`'s from within
     directive code.
 
 * docutils/parsers/rst/__init__.py:
 
-  - Added ``Directive`` base class.
-  - Added ``DirectiveError`` base class.
-  - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
+  - Added `Directive` base class.
+  - Added `DirectiveError` base class.
+  - Fixed `file_insertion_enabled`_ & `raw_enabled`_ setting
     definitions.
 
 * docutils/parsers/directives/:
 
   - Refactored all reStructuredText directives to use the new
     object-oriented directive interface.  Errors are now (mostly)
-    thrown using the new ``DirectiveError`` class.
+    thrown using the new `DirectiveError` class.
 
 * docutils/parsers/directives/misc.py:
 
@@ -1355,15 +1857,15 @@
 
 * docutils/transforms/universal.py:
 
-  - Added ``StripClassesAndElements`` transform to remove from the
+  - Added `StripClassesAndElements` transform to remove from the
     document tree all elements with classes in
-    ``settings.strip_elements_with_classes`` and all "classes"
-    attribute values in ``self.document.settings.strip_classes``.
+    `strip_elements_with_classes`_ and all "classes"
+    attribute values in `strip_classes`_
 
 * docutils/transforms/writer_aux.py:
 
-  - Added ``Admonitions`` transform to transform specific admonitions
-    (like ``note``, ``warning``, etc.) into generic admonitions with a
+  - Added `Admonitions` transform to transform specific admonitions
+    (like "note", "warning", etc.) into generic admonitions with a
     localized title.
 
 * docutils/writers/html4css1/__init__.py:
@@ -1387,13 +1889,11 @@
 
 * docutils/writers/s5_html/__init__.py:
 
-  - Added ``view_mode`` & ``hidden_controls`` settings
-    (``--view-mode`` & ``--hidden-controls/--visible-controls``
-    options).
+  - Added `view_mode`_ & `hidden_controls`_ settings.
 
 * docutils/writers/latex2e/__init__.py:
 
-  - Add ``--literal-block-env``
+  - Add `literal_block_env`_.
   - Fix: escaping ``%`` in href urls.
   - Move usepackage hyperref after stylesheet inclusion.
   - Fix: scrartcl does not have chapter but scrreprt.
@@ -1414,17 +1914,17 @@
   - Use section commands down to subparagraph.
   - Put ensuremath around some latin1 chars.
   - Set ``usepackageutf8x{inputenc}`` for utf-8.
-  - New option ``--use-bibtex=style,db1,db2``.
-  - New option ``--reference-label`` to allow usage of LaTeX ref for
+  - New experimental setting `use_bibtex`_.
+  - New setting `reference_label`_ to allow usage of LaTeX ref for
     labels in section references.
   - Add a label after every section to support sectionnumbers as reference
     labels.
   - Fix: bug# 1605376 rst2latex: bad options group list
   - Remove inactive code for use_optionlist_for_option_list.
   - Remove latex comments from option_list output.
-  - Fix: bug# 1612270 double qoutes in italian literal.
+  - Fix: bug# 1612270 double quotes in italian literal.
   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
-  - Add option --use-latex-abstract.
+  - Add setting `use_latex_abstract`_.
   - Image width unit ``px`` is translated to ``pt``.
   - Add image height support.
   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
@@ -1449,8 +1949,8 @@
 
 * tools/buildhtml.py:
 
-  -- Added ``ignore`` setting to exclude a list of shell patterns
-     (default: ``.svn:CVS``).
+  - Add `ignore`_ setting to exclude a list of shell patterns
+    (default: ``.svn:CVS``).
 
 * tools/editors/emacs/rst.el:
 
@@ -1481,7 +1981,7 @@
 
   - Added ``__version_details__`` attribute to describe code source
     (repository/snapshot/release).
-  - Replaced ``default_transforms`` attribute of TransformSpec with
+  - Replaced ``default_transforms`` attribute of ``TransformSpec`` with
     ``get_transforms()`` method.
 
 * docutils/core.py:
@@ -1532,7 +2032,7 @@
 
 * docutils/parsers/rst/__init__.py:
 
-  - Added validator to tab_width setting, with test.  Closes SF bug
+  - Added validator to "tab_width" setting, with test.  Closes SF bug
     #1212515, report from Wu Wei.
 
 * docutils/parsers/rst/states.py:
@@ -1861,8 +2361,8 @@
 
 * docutils/readers/standalone.py:
 
-  - Added ``--section-subtitles`` and ``--no-section-subtitles``
-    options to activate or deactivate the SectSubTitle transform.
+  - Added ``section_subtitles`` setting to activate or deactivate the
+    ``SectSubTitle`` transform.
 
 * docutils/transforms/frontmatter.py:
 
@@ -1899,10 +2399,10 @@
 * docutils/writers/latex2e.py:
 
   - Fixed tables starting with more than one multirow cell.
-  - Improved --use-latex-docinfo so that organization/contact/address
+  - Improved ``--use-latex-docinfo`` so that organization/contact/address
     fields are lumped with the last author field and appear on the
     titlepage.
-  - Made sure the titlepage is always shown with --use-latex-docinfo,
+  - Made sure the titlepage is always shown with ``--use-latex-docinfo``,
     even if the document has no title.
   - Made sure that latex doesn't fill in today's date if no date field
     was given.
@@ -1936,9 +2436,9 @@
 
 * docutils/frontend.py:
 
-  - Added options: --input-encoding-error-handler,
-    --record-dependencies, --leave-footnote-reference-space,
-    --strict-visitor.
+  - Added options: ``--input-encoding-error-handler``,
+    ``--record-dependencies``, ``--leave-footnote-reference-space``,
+    ``--strict-visitor``.
   - Added command-line and config file support for "overrides" setting
     parameter.
 
@@ -2032,8 +2532,8 @@
   - "stylesheet" and "stylesheet_path" settings are now mutually
     exclusive.
   - Added support for the new line_block/line structure.
-  - --footnote-references now overrides
-    --trim-footnote-reference-space, if applicable.
+  - ``--footnote-references`` now overrides
+    ``--trim-footnote-reference-space``, if applicable.
   - Added support for ``compound`` elements.
   - Enabled multiple format names for "raw" directive.
   - ``<p>`` tags of a paragraph which is the only visible child of the
@@ -2056,10 +2556,10 @@
   - no newline after depart_term.
   - Added translations for some Unicode quotes.
   - Added option "font-encoding", made package AE the default.
-  - "stylesheet" and "stylesheet_path" settings are now mutually
+  - `stylesheet`_ and `stylesheet_path`_ settings are now mutually
     exclusive.
-  - --footnote-references now overrides
-    --trim-footnote-reference-space, if applicable.
+  - ``--footnote-references`` now overrides
+    ``--trim-footnote-reference-space``, if applicable.
   - The footnote label style now matches the footnote reference style
     ("brackets" or "superscript").
   - Added support for ``compound`` elements.
@@ -2127,10 +2627,7 @@
   - Moved ``spec/howto/`` to ``docs/howto``.
 
   In order to keep the CVS history of moved files, we supplied
-  SourceForge with a `script for modifying the Docutils CVS
-  repository`__.
-
-  __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
+  SourceForge with a script for modifying the Docutils CVS repository.
 
   After running the cleanup script:
 
@@ -2179,14 +2676,14 @@
 
 * docutils/frontend.py:
 
-  - Added help text for "--output-encoding-error-handler" and
-    "--error-encoding-error-handler".
-  - Renamed "--exit" to "--exit-status".
+  - Added help text for ``--output-encoding-error-handler`` and
+    ``--error-encoding-error-handler``.
+  - Renamed ``--exit`` to ``--exit-status``.
   - Simplified default-setting code.
 
 * docutils/parsers/rst/__init__.py:
 
-  - Added "--pep-base-url" and "--rfc-base-url" options.
+  - Added ``--pep-base-url`` and ``--rfc-base-url`` options.
 
 * docutils/parsers/rst/states.py:
 
@@ -2205,7 +2702,7 @@
 
 * docutils/writers/latex2e.py:
 
-  - Added "--table-style=(standard|booktabs|nolines)"
+  - Added ``--table-style=(standard|booktabs|nolines)``
   - figures get "here" option (LaTeX per default puts them at bottom),
     and figure content is centered.
   - Rowspan support for tables.
@@ -2215,7 +2712,7 @@
     width.
   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
   - A few unicode replacements, if output_encoding != utf
-  - Add "--graphicx-option".
+  - Add `graphicx_option`_ setting.
   - Indent literal-blocks.
   - Fix: omit ``\maketitle`` when there is no document title.
 
@@ -2288,7 +2785,7 @@
 
   - Catch system messages to stop tracebacks from parsing errors.
   - Catch exceptions during processing report & exit without
-    tracebacks, except when "--traceback" used.
+    tracebacks, except when ``--traceback`` used.
   - Reordered components for OptionParser; application comes last.
   - Added "config_section" parameter to several methods and functions,
     allowing front ends to easily specify their config file sections.
@@ -2300,8 +2797,7 @@
 
 * docutils/frontend.py:
 
-  - Added "--traceback" & "--no-traceback" options ("traceback"
-    setting).
+  - Added "traceback" setting.
   - Implemented support for config file reorganization:
     ``standard_config_files`` moved from ``ConfigParser`` to
     ``OptionParser``; added
@@ -2315,7 +2811,7 @@
     for list setting attributes.
   - Added support for new ``DOCUTILSCONFIG`` environment variable;
     thanks to Beni Cherniavsky.
-  - Added "--no-section-numbering" option.
+  - Added ``--no-section-numbering`` option.
 
 * docutils/io.py:
 
@@ -2366,7 +2862,7 @@
 * docutils/parsers/rst/states.py:
 
   - Updated ``RSTState.nested_parse`` for "include" in table cells.
-  - Allowed true em-dash character and "---" as block quote
+  - Allowed true em-dash character and "``---``" as block quote
     attribution marker.
   - Added support for <angle-bracketed> complex option arguments
     (option lists).
@@ -2505,7 +3001,7 @@
   - Added option ``--use-verbatim-when-possible``, to avoid
     problematic characters (eg, '~' in italian) in literal blocks.
   - It's now possible to use four section levels in the `book` and
-    `report` LaTeX classes.  The default `article` class still has
+    `report` LaTeX document classes.  The default `article` class still has
     three levels limit.
 
 * docs/config.txt: "Docutils Configuration Files", added to project.
@@ -2543,7 +3039,7 @@
 
 * tools/buildhtml.py:
 
-  - Added support for the "--prune" option.
+  - Added support for the ``--prune`` option.
   - Removed dependency on pep2html.py; plaintext PEPs no longer
     supported.
 
@@ -2599,7 +3095,7 @@
   - Bumped version to 0.2.1 to reflect changes to I/O classes.
   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
-  - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
+  - Bumped version to 0.2.3 because of the new ``--embed-stylesheet``
     option and its effect on the PEP template & writer.
   - Bumped version to 0.2.4 due to changes to the PEP template &
     stylesheet.
@@ -2626,8 +3122,8 @@
   - Added ``publish_file()`` and ``publish_string()``.
   - Factored ``Publisher.set_source()`` and ``.set_destination()``
     out of ``.set_io``.
-  - Added support for "--dump-pseudo-xml", "--dump-settings", and
-    "--dump-transforms" hidden options.
+  - Added support for ``--dump-pseudo-xml``, ``--dump-settings``, and
+    ``--dump-transforms`` hidden options.
   - Added ``Publisher.apply_transforms()`` method.
   - Added ``Publisher.set_components()`` method; support for
     ``publish_*()`` conveninece functions.
@@ -2639,28 +3135,28 @@
 * docutils/frontend.py:
 
   - Check for & exit on identical source & destination paths.
-  - Fixed bug with absolute paths & "--config".
+  - Fixed bug with absolute paths & ``--config``.
   - Set non-command-line defaults in ``OptionParser.__init__()``:
     ``_source`` & ``_destination``.
   - Distributed ``relative_path_settings`` to components; updated
     ``OptionParser.populate_from_components()`` to combine it all.
   - Require list of keys in ``make_paths_absolute`` (was implicit in
     global ``relative_path_settings``).
-  - Added "--expose-internal-attribute", "--dump-pseudo-xml",
-    "--dump-settings", and "--dump-transforms" hidden options.
+  - Added ``--expose-internal-attribute``, ``--dump-pseudo-xml``,
+    ``--dump-settings``, and ``--dump-transforms`` hidden options.
   - Removed nasty internals-fiddling ``ConfigParser.get_section``
     code, replaced with correct code.
   - Added validation functionality for config files.
-  - Added "--error-encoding" option/setting, "_disable_config"
+  - Added ``--error-encoding`` option/setting, "_disable_config"
     internal setting.
-  - Added encoding validation; updated "--input-encoding" and
-    "--output-encoding"; added "--error-encoding-error-handler" and
-    "--output-encoding-error-handler".
+  - Added encoding validation; updated ``--input-encoding`` and
+    ``--output-encoding``; added ``--error-encoding-error-handler`` and
+    ``--output-encoding-error-handler``.
   - Moved config file processing from docutils/core.py.
   - Updated ``OptionParser.populate_from_components`` to handle new
     ``SettingsSpec.settings_defaults`` dict.
   - Added support for "-" => stdin/stdout.
-  - Added "exit_level" setting ("--exit" option).
+  - Added "exit_level" setting (``--exit`` option).
 
 * docutils/io.py:
 
@@ -2784,8 +3280,8 @@
 
 * docutils/parser/rst/__init__.py:
 
-  - Added options: "--pep-references", "--rfc-references",
-    "--tab-width", "--trim-footnote-reference-space".
+  - Added options: ``--pep-references``, ``--rfc-references``,
+    ``--tab-width``, ``--trim-footnote-reference-space``.
 
 * docutils/parsers/rst/states.py:
 
@@ -2795,7 +3291,7 @@
     titles to begin with enumerators.
   - Converted system messages to use the new "line" attribute.
   - Fixed a substitution reference edge case.
-  - Added support for "--pep-references" and "--rfc-references"
+  - Added support for ``--pep-references`` and ``--rfc-references``
     options; reworked ``Inliner`` code to make customization easier.
   - Removed field argument parsing.
   - Added support for short section title over/underlines.
@@ -2834,7 +3330,7 @@
   - Implemented "superscript" and "subscript" interpreted text roles.
   - Added initial support for "abbreviation" and "acronym" roles;
     incomplete.
-  - Added support for "--trim-footnote-reference-space" option.
+  - Added support for ``--trim-footnote-reference-space`` option.
   - Optional space before colons in directives & hyperlink targets.
 
 * docutils/parsers/rst/tableparser.py:
@@ -2973,7 +3469,7 @@
 
 * docutils/transforms/universal.py:
 
-  - Added support for the "--expose-internal-attributes" option.
+  - Added support for the ``--expose-internal-attributes`` option.
   - Removed ``Pending`` transform classes & data.
 
 * docutils/writers/__init__.py:
@@ -2983,7 +3479,7 @@
 * docutils/writers/docutils-xml.py:
 
   - Added XML and doctype declarations.
-  - Added "--no-doctype" and "--no-xml-declaration" options.
+  - Added ``--no-doctype`` and ``--no-xml-declaration`` options.
 
 * docutils/writers/html4css1.py:
 
@@ -3004,12 +3500,12 @@
   - Added support for "line_block", "address" elements.
   - Improved backlinks (footnotes & system_messages).
   - Improved system_message output.
-  - Redefined "--stylesheet" as containing an invariant URL, used
-    verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
+  - Redefined ``--stylesheet`` as containing an invariant URL, used
+    verbatim.  Added ``--stylesheet-path``, interpreted w.r.t. the
     working directory.
-  - Added "--footnote-references" option (superscript or brackets).
-  - Added "--compact-lists" and "--no-compact-lists" options.
-  - Added "--embed-stylesheet" and "--link-stylesheet" options;
+  - Added ``--footnote-references`` option (superscript or brackets).
+  - Added ``--compact-lists`` and ``--no-compact-lists`` options.
+  - Added ``--embed-stylesheet`` and ``--link-stylesheet`` options;
     factored out ``HTMLTranslator.get_stylesheet_reference()``.
   - Improved field list rendering.
   - Added Docutils version to "generator" meta tag.
@@ -3021,7 +3517,7 @@
   - Removed "interpreted" element support.
   - Added support for "title_reference", "sidebar", "attribution",
     "rubric", and generic "admonition" elements.
-  - Added "--attribution" option.
+  - Added ``--attribution`` option.
   - Added support for "inline", "subscript", "superscript" elements.
   - Added initial support for "abbreviation" and "acronym";
     incomplete.
@@ -3031,18 +3527,18 @@
 
   - Added french.
   - Double quotes in literal blocks (special treatment for de/ngerman).
-  - Added '--hyperlink-color' option ('0' turns off coloring of links).
-  - Added  "--attribution" option.
+  - Added ``--hyperlink-color`` option ('0' turns off coloring of links).
+  - Added ``--attribution`` option.
   - Right align attributions.
 
 * docutils/writers/pep_html.py:
 
   - Parameterized output encoding in PEP template.
   - Reworked substitutions from ``locals()`` into ``subs`` dict.
-  - Redefined "--pep-stylesheet" as containing an invariant URL, used
-    verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
+  - Redefined ``--pep-stylesheet`` as containing an invariant URL, used
+    verbatim.  Added ``--pep-stylesheet-path``, interpreted w.r.t. the
     working directory.
-  - Added an override on the "--footnote-references" option.
+  - Added an override on the ``--footnote-references`` option.
   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
   - Added Docutils version to "generator" meta tag.
   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
@@ -3190,8 +3686,8 @@
 
 * tools/buildhtml.py:
 
-  - Added "--silent" option.
-  - Fixed bug with absolute paths & "--config".
+  - Added ``--silent`` option.
+  - Fixed bug with absolute paths & ``--config``.
   - Updated for new I/O classes.
   - Added some exception handling.
   - Separated publishers' setting defaults; prevents interference.
@@ -3199,7 +3695,7 @@
 
 * tools/pep-html-template:
 
-  - Allow for "--embed-stylesheet".
+  - Allow for ``--embed-stylesheet``.
   - Added Docutils version to "generator" meta tag.
   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
   - Conform to XHTML spec.
@@ -3218,7 +3714,7 @@
 
 * tools/quicktest.py:
 
-  - Added "-V"/"--version" option.
+  - Added ``-V``/``--version`` option.
 
 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
 
@@ -3297,7 +3793,7 @@
 
 * docutils/frontend.py: Added to project; support for front-end
   (command-line) scripts.  Option specifications may be augmented by
-  components.  Requires Optik (http://optik.sf.net/) for option
+  components.  Requires Optik (http://optik.sourceforge.net/) for option
   processing (installed locally as docutils/optik.py).
 
 * docutils/io.py: Added to project; uniform API for a variety of input
@@ -3430,7 +3926,7 @@
 
 * docutils/transforms/parts.py: Renamed from old components.py.
 
-  - Added filter for `Contents`, to use alt-text for inline images,
+  - Added filter for ``Contents``, to use alt-text for inline images,
     and to remove inline markup that doesn't make sense in the ToC.
   - Added "name" attribute to TOC topic depending on its title.
   - Added support for optional TOC backlinks.
@@ -3630,7 +4126,57 @@
   - Improved diagnostic system messages for missing blank lines.
   - Fixed substitution_reference bug.
 
-&#xc;
+.. References
+   ==========
+
+.. _RELEASE-NOTES: RELEASE-NOTES.html
+.. _`_config_files`: docs/user/config.html#config-files
+.. _auto_id_prefix: docs/user/config.html#auto-id-prefix
+.. _detailled:
+.. _detailed: docs/user/config.html#detailed
+.. _docutils_footnotes: docs/user/config.html#docutils-footnotes
+.. _dump_settings: docs/user/config.html#dump-settings
+.. _embed_images: docs/user/config.html#embed-images
+.. _embed_stylesheet: docs/user/config.html#embed-stylesheet
+.. _figure_footnotes: docs/user/config.html#figure-footnotes
+.. _file_insertion_enabled: docs/user/config.html#file-insertion-enabled
+.. _graphicx_option: docs/user/config.html#graphicx-option
+.. _hidden_controls: docs/user/config.html#hidden-controls
+.. _html_writer: docs/user/config.html#html-writer
+.. _hyperref_options: docs/user/config.html#hyperref-options
+.. _id_prefix: docs/user/config.html#id-prefix
+.. _ignore: docs/user/config.html#ignore
+.. _image_loading: docs/user/config.html#image-loading
+.. _indents: docs/user/config.html#indents
+.. _initial_header_level: docs/user/config.html#initial-header-level
+.. _input_encoding: docs/user/config.html#input-encoding
+.. _input_encoding_error_handler: docs/user/config.html#input-encoding-error-handler
+.. _language: docs/user/config.html#language
+.. _latex_preamble: docs/user/config.html#latex-preamble
+.. _legacy_class_functions: docs/user/config.html#legacy-class-functions
+.. _legacy_column_widths: docs/user/config.html#legacy-column-widths
+.. _literal_block_env: docs/user/config.html#literal-block-env
+.. _math_output: docs/user/config.html#math-output
+.. _output: docs/user/config.html#output
+.. _output_encoding: docs/user/config.html#output-encoding
+.. _raw_enabled: docs/user/config.html#raw-enabled
+.. _reference_label: docs/user/config.html#reference-label
+.. _smart_quotes: docs/user/config.html#smart-quotes
+.. _strip_classes: docs/user/config.html#strip-classes
+.. _strip_elements_with_classes: docs/user/config.html#strip-elements-with-classes
+.. _stylesheet: docs/user/config.html#stylesheet
+.. _stylesheet_dirs: docs/user/config.html#stylesheet-dirs
+.. _stylesheet_path: docs/user/config.html#stylesheet-path
+.. _syntax_highlight: docs/user/config.html#syntax-highlight
+.. _table_style: docs/user/config.html#table-style
+.. _traceback: docs/user/config.html#traceback
+.. _use_bibtex: docs/user/config.html#use-bibtex
+.. _use_latex_abstract: docs/user/config.html#use-latex-abstract
+.. _use_latex_footnotes: docs/user/config.html#use-latex-footnotes
+.. _use_latex_toc: docs/user/config.html#use-latex-toc
+.. _view_mode: docs/user/config.html#view-mode
+
+
 ..
    Local Variables:
    mode: indented-text

_service:tar_scm:docutils-0.17.1.tar.gz/MANIFEST.in -> _service:tar_scm:docutils-0.20.tar.gz/MANIFEST.in Changed

_service:tar_scm:docutils-0.17.1.tar.gz/PKG-INFO -> _service:tar_scm:docutils-0.20.tar.gz/PKG-INFO Changed

@@ -1,17 +1,13 @@
-Metadata-Version: 1.2
+Metadata-Version: 2.1
 Name: docutils
-Version: 0.17.1
+Version: 0.20
 Summary: Docutils -- Python Documentation Utilities
-Home-page: http://docutils.sourceforge.net/
+Home-page: https://docutils.sourceforge.io/
 Author: David Goodger
 Author-email: goodger@python.org
 Maintainer: docutils-develop list
 Maintainer-email: docutils-develop@lists.sourceforge.net
 License: public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt)
-Description: Docutils is a modular system for processing documentation
-        into useful formats, such as HTML, XML, and LaTeX.  For
-        input Docutils supports reStructuredText, an easy-to-read,
-        what-you-see-is-what-you-get plaintext markup syntax.
 Platform: OS-independent
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -24,14 +20,12 @@
 Classifier: License :: OSI Approved :: BSD License
 Classifier: License :: OSI Approved :: GNU General Public License (GPL)
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing
@@ -62,4 +56,12 @@
 Classifier: Natural Language :: Slovak
 Classifier: Natural Language :: Spanish
 Classifier: Natural Language :: Swedish
-Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
+Classifier: Natural Language :: Ukrainian
+Requires-Python: >=3.7
+License-File: COPYING.txt
+
+Docutils is a modular system for processing documentation
+into useful formats, such as HTML, XML, and LaTeX.  For
+input Docutils supports reStructuredText, an easy-to-read,
+what-you-see-is-what-you-get plaintext markup syntax.
+

_service:tar_scm:docutils-0.17.1.tar.gz/README.txt -> _service:tar_scm:docutils-0.20.tar.gz/README.txt Changed

@@ -1,11 +1,13 @@
-===============================
- README: Docutils 0.17.1
-===============================
+.. include:: docs/header0.txt
+
+=======================
+ README: Docutils 0.20
+=======================
 
 :Author: David Goodger
 :Contact: goodger@python.org
-:Date: $Date: 2021-04-17 14:41:26 +0200 (Sa, 17. Apr 2021) $
-:Web site: http://docutils.sourceforge.net/
+:Date: $Date: 2023-05-09 19:55:19 +0200 (Di, 09. Mai 2023) $
+:Web site: https://docutils.sourceforge.io/
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -16,34 +18,28 @@
 
 This is for those who want to get up & running quickly.
 
-1. Docutils requires Python, available from
-   http://www.python.org/.
-
-   See Requirements_ below for details.
+1. Docutils requires **Python**, available from
+   https://www.python.org/.
+   See Dependencies_ below for details.
 
 2. Install the latest stable release from PyPi with pip_::
 
-       python -m pip install docutils
+       pip install docutils
 
-   To install a pre-relase, append the option ``--pre``.
-   To install a `development version`_, follow the instructions in
-   section `Installation`_ below.
+   For alternatives and details, see section `Installation`_ below.
 
 3. Use the `front-end scripts`_ to convert reStructuredText documents.
    Try for example::
 
-       rst2html.py FAQ.txt FAQ.html         (Unix)
-       python tools/rst2html.py FAQ.txt FAQ.html  (Windows)
+       docutils FAQ.txt FAQ.html
 
    See Usage_ below for details.
 
-.. _pip: https://pypi.org/project/pip/
-
 
 Purpose
 =======
 
-The purpose of the Docutils project is to create a set of tools for
+The purpose of the Docutils project is to provide a set of tools for
 processing plaintext documentation into useful formats, such as HTML,
 LaTeX, troff (man pages), OpenOffice, and native XML.  Support for the
 following sources has been implemented:
@@ -52,7 +48,8 @@
 
 * `PEPs (Python Enhancement Proposals)`_.
 
-Support for the following sources is planned:
+Support for the following sources is planned or provided by
+`third party tools`_:
 
 * Inline documentation from Python modules and packages, extracted
   with namespace context.
@@ -67,23 +64,21 @@
 * And others as discovered.
 
 .. _PEPs (Python Enhancement Proposals):
-   http://www.python.org/peps/pep-0012.html
+   https://peps.python.org/pep-0012
+.. _third party tools: docs/user/links.html#related-applications
 
 
-Requirements
+Dependencies
 ============
 
 To run the code, Python_ must be installed.
+(Python is pre-installed with most Linux distributions.)
 
-* Docutils 0.16 and later supports Python 2.7 and 3.5+ natively.  #2to3_
-* Docutils 0.14 dropped Python 2.4, 2.5, 3.1 and 3.2 support.
-* Docutils 0.10 dropped Python 2.3 support.
-* From version 0.6, Docutils is compatible with Python 3. #2to3_
-* For Docutils 0.5, Python 2.2.1+ is required.
-* Up to Docutils 0.4, Python 2.1 is required.
+* Since version 0.19, Docutils requires Python 3.7 or later.
+* Docutils 0.16 to 0.18 require Python 2.7 or 3.5+.
+
+.. _Python: https://www.python.org/.
 
-.. #2to3 Up to version 0.15, the Docutils codebase was translated
-   "on-demand" using the 2to3 tool.
 
 Recommendations
 ---------------
@@ -91,152 +86,142 @@
 Docutils uses the following packages for enhanced functionality, if they
 are installed:
 
-* Installation_ is usually done with pip_ or setuptools_.
+* The recommended installer is pip_, setuptools_ works, too.
 
-* The `Python Imaging Library`_, or PIL, is used for some image
+* The `Python Imaging Library`_ (PIL) is used for some image
   manipulation operations.
 
 * The `Pygments`_ package provides syntax highlight of "code" directives
   and roles.
 
-* The `recommonmark`_ parser is used to parse input in Markdown format.
+* The `myst`_, `pycmark`_, or `recommonmark`_ parsers can be used to
+  parse input in "Markdown" (CommonMark_) format.
 
 The `Docutils Link List <docs/user/links.html>`__ records projects that
 users of Docutils and reStructuredText may find useful.
 
-.. _Python: http://www.python.org/.
+.. _pip: https://pypi.org/project/pip/
+.. _setuptools: https://pypi.org/project/setuptools/
 .. _Python Imaging Library: http://www.pythonware.com/products/pil/
 .. _Pygments: https://pypi.org/project/Pygments/
-.. _setuptools: https://pypi.org/project/setuptools/
+.. _myst: https://pypi.org/project/myst-docutils/
+.. _pycmark: https://pypi.org/project/pycmark/
 .. _recommonmark: https://github.com/rtfd/recommonmark
+.. _CommonMark: https://spec.commonmark.org/0.30/
 
 
-Development version
-===================
-
-While we are trying to follow a "release early & often" policy,
-features are added frequently.  Since the code in the repository_
-is usually in a bug-free state, we recommend using a current snapshot
-or a working copy.
-
-To get a _`snapshot`, go to the code page and click the download snapshot
-button:
-
-* Docutils code, documentation, front-end tools, and tests:
-  https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
-
-* Sandbox (experimental, contributed code):
-  https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
-
-To keep up to date on the latest developments, download fresh copies of the
-snapshots regularly or use a `working copy of the Docutils code repository`__.
-
-Continue with the `Installation`_ instructions below.
-
-.. _repository: docs/dev/repository.html
-__ docs/dev/repository.html#checking-out-the-repository
-
 Installation
 ============
 
-Steps to install Docutils from source:
+The `Python Packaging User Guide`_ gives details how to
+`use pip for installing`_.
 
-* Go to the directory containing the file ``setup.py``.
+* The simplest way is to install the latest *stable release* from PyPi::
 
-  A snapshot_ must be unpacked in a temporary directory (**not** directly in
-  Python's ``site-packages``) first.
+      pip install docutils
 
-* Run ``setup.py install``. #setup-requires-setuptools_
-  On Windows systems it may be sufficient to double-click ``install.py``.
+* To install a *pre-relase*, append the option ``--pre``.
 
-.. #setup-requires-setuptools ``setup.py`` requires the `setuptools`_
-   package. For a manual install see the options in `Setting up for Docutils
-   development`__.
+* To install a `development version`_ *from source*:
 
-   __ docs/dev/policies.html#setting-up-for-docutils-development
+  1. Open a shell
 
-Optional steps:
+  2. Go to the directory containing the file ``setup.py``.
 
-* `running the test suite`_
+  3. Install the package with **one** of the following commands::
 
-* `converting the documentation`_
+         pip install -e .  # editable install
+         pip install .     # regular install
+         python setup.py   # regular install with setuptools
 
-OS-specific installation instructions follow.
+  4. Optional steps:
 
+     * `Running the test suite`_
+     * `Converting the documentation`_
 
-GNU/Linux, BSDs, Unix, Mac OS X, etc.
--------------------------------------
+  See also the OS-specific installation instructions below and
+  the `Docutils version repository`_ documentation.
 
-1. Open a shell.
+* To install for a *specific Python version*, use this version in the
+  setup call, e.g. ::
 
-2. Go to the directory containing ``setup.py``::
+       python3.11 -m pip install docutils
 
-       cd <archive_directory_path>
+  If the python executable isn't on your path, you'll have to specify the
+  complete path, such as ``/usr/local/bin/python3.11``.
 
-3. Install the package (you may need root permissions to complete this
-   step)::
+  To install for different Python versions, repeat step 3 for every
+  required version. The last installed version will be used for the
+  ``docutils`` command line application.
 
-       su
-       (enter admin password)
-       python setup.py install
+.. _Python Packaging User Guide: https://packaging.python.org/en/latest/
+.. _use pip for installing:
+    https://packaging.python.org/en/latest/tutorials/installing-packages/
+    #use-pip-for-installing
+.. _"editable" install:
+    https://pip.pypa.io/en/stable/topics/local-project-installs/
+    #editable-installs
 
-   If the python executable isn't on your path, you'll have to specify
-   the complete path, such as ``/usr/local/bin/python``.
 
-   To install for a specific Python version, use this version in the
-   setup call, e.g. ::
+GNU/Linux, BSDs, Unix, Mac OS X, etc.
+-------------------------------------
 
-       python3.7 setup.py install
+* Use ``su`` or ``sudo`` for a system-wide
+  installation as ``root``, e.g.::
 
-   To install for different Python versions, repeat step 3 for every
-   required version. The last installed version will be used in the
-   `shebang line`_ of the ``rst2*.py`` wrapper scripts.
+      sudo pip install docutils
 
-   .. _shebang line: http://en.wikipedia.org/wiki/Shebang_%28Unix%29
 
 Windows
 -------
 
-Just double-click ``install.py``.  If this doesn't work, try the
-following:
+* The Python FAQ explains `how to run a Python program under Windows`__.
 
-1. Open a DOS Box (Command Shell, MS-DOS Prompt, or whatever they're
-   calling it these days).
+  __ https://docs.python.org/3/faq/windows.html
+     #how-do-i-run-a-python-program-under-windows
 
-2. Go to the directory created by expanding the archive::
+* Usually, pip_ is automatically installed if you are using Python
+  downloaded from https://python.org. If not, see the
+  `pip documentation <https://pip.pypa.io/en/stable/installation/>`__.
 
-       cd <archive_directory_path>
+* The command window should recognise the word ``py`` as an instruction to
+  start the interpreter, e.g.
 
-3. Install the package::
+       py -m pip install docutils
 
-       <path_to_python.exe>\python setup.py install
-
-   To install for a specific python version, specify the Python
-   executable for this version.
-
-   To install for different Python versions, repeat step 3 for every
-   required version.
+  If this does not work, you may have to specify the full path to the
+  Python executable.
 
 
 Usage
 =====
 
-There are many front-end tools in the unpacked "tools" subdirectory.
-Installation under Unix places copies in the PATH.
-You may want to begin with the "rst2html.py" front-end tool.  Most
-tools take up to two arguments, the source path and destination path,
-with STDIN and STDOUT being the defaults.  Use the ``--help`` option to
-the front-end tools for details on options and arguments.  See
-`Docutils Front-End Tools`_ for full documentation.
+Start the "docutils" command line application with::
+
+    docutils options <source> <destination>
 
-The package modules are continually growing and evolving.  The
-``docutils.statemachine`` module is usable independently.  It contains
-extensive inline documentation (in reStructuredText format of course).
+The default action is to convert a reStructuredText_ document to HTML5,
+for example::
+
+    docutils test.rst test.html
+
+Read the ``--help`` option output for details on options and arguments and
+`Docutils Front-End Tools`_ for the full documentation of the various tools.
+
+For programmatic use of the `docutils` Python package, read the
+`API Reference Material`_ and the source code.
+Remaining questions may be answered in the `Docutils Project
+Documentation`_ or the Docutils-users_ mailing list.
 
 Contributions are welcome!
 
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _front-end scripts:
 .. _Docutils Front-End Tools: docs/user/tools.html
+.. _API Reference Material: /docs/index.html
+                            #api-reference-material-for-client-developers
+.. _Docutils Project Documentation: /docs/index.html
+
 
 Project Files & Directories
 ===========================
@@ -291,28 +276,49 @@
   below.
 
 
+Development version
+===================
+
+While we are trying to follow a "release early & often" policy,
+features are added frequently.
+We recommend using a current snapshot or a working copy of the repository.
+
+Repository check-out:
+  To keep up to date on the latest developments,
+  use a `working copy`__ of the `Docutils version repository`_.
+
+Snapshots:
+  To get a repository _`snapshot`, go to
+  https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
+  and click the download snapshot button.
+
+  Unpack in a temporary directory,
+  **not** directly in Python's ``site-packages``.
+
+Continue with the `Installation`_ instructions below.
+
+__ docs/dev/repository.html#checking-out-the-repository
+.. _Docutils version repository: docs/dev/repository.html
+.. _sandbox: https://docutils.sourceforge.io/sandbox/README.html
+
+
 Converting the documentation
 ============================
 
 After unpacking and installing the Docutils package, the following
 shell commands will generate HTML for all included documentation::
 
-    cd <archive_directory_path>/tools
-    ./buildhtml.py ../
+    cd <archive_directory_path>
+    tools/buildhtml.py .
 
 On Windows systems, type::
 
-    cd <archive_directory_path>\tools
-    python buildhtml.py ..
+    cd <archive_directory_path>
+    py tools\buildhtml.py ..
 
 The final directory name of the ``<archive_directory_path>`` is
 "docutils" for snapshots.  For official releases, the directory may be
 called "docutils-X.Y.Z", where "X.Y.Z" is the release version.
-Alternatively::
-
-    cd <archive_directory_path>
-    tools/buildhtml.py --config=tools/docutils.conf          (Unix)
-    python tools\buildhtml.py --config=tools\docutils.conf   (Windows)
 
 Some files may generate system messages (warnings and errors).  The
 ``docs/user/rst/demo.txt`` file (under the archive directory) contains
@@ -339,35 +345,31 @@
 You should see a long line of periods, one for each test, and then a
 summary like this::
 
-    Ran 1111 tests in 24.653s
+    Ran 1744 tests in 5.859s
 
-    OK
-    Elapsed time: 26.189 seconds
+    OK (skipped=1)
+    Elapsed time: 6.235 seconds
 
 The number of tests will grow over time, and the times reported will
-depend on the computer running the tests.  The difference between the
-two times represents the time required to set up the tests (import
-modules, create data structures, etc.).
+depend on the computer running the tests.
+Some test are skipped, if optional dependencies (`recommendations`_)
+are missing.
+The difference between the two times represents the time required to set
+up the tests (import modules, create data structures, etc.).
+
+A copy of the test output is written to the file ``alltests.out``.
 
 If any of the tests fail, please `open a bug report`_ or `send an email`_
 (see `Bugs <BUGS.html>`_).
 Please include all relevant output, information about your operating
 system, Python version, and Docutils version.  To see the Docutils
-version, use one of the ``rst2*`` front ends or ``tools/quicktest.py``
-with the ``--version`` option, e.g.::
-
-    cd ../tools
-    ./quicktest.py --version
-
-Windows users type these commands::
+version, look at the test output or use ::
 
-    cd ..\tools
-    python quicktest.py --version
+    docutils --version
 
-
-.. _Docutils Testing: http://docutils.sourceforge.net/docs/dev/testing.html
+.. _Docutils Testing: https://docutils.sourceforge.io/docs/dev/testing.html
 .. _open a bug report:
-   http://sourceforge.net/p/docutils/bugs/
+   https://sourceforge.net/p/docutils/bugs/
 .. _send an email: mailto:docutils-users@lists.sourceforge.net
    ?subject=Test%20suite%20failure
 .. _web interface: https://sourceforge.net/p/docutils/mailman/
@@ -376,10 +378,18 @@
 Getting Help
 ============
 
-If you have questions or need assistance with Docutils or
+All documentation can be reached from the `Project Documentation
+Overview`_.
+
+The SourceForge `project page`_ has links to the tracker, mailing
+lists, and code repository.
+
+If you have further questions or need assistance with Docutils or
 reStructuredText, please post a message to the Docutils-users_ mailing
 list.
 
+.. _Project Documentation Overview: docs/index.html
+.. _project page: https://sourceforge.net/p/docutils
 .. _Docutils-users: docs/user/mailing-lists.html#docutils-users
 
 &#xc;

_service:tar_scm:docutils-0.17.1.tar.gz/RELEASE-NOTES.txt -> _service:tar_scm:docutils-0.20.tar.gz/RELEASE-NOTES.txt Changed

@@ -1,4 +1,4 @@
-.. -*- coding: utf-8 -*-
+.. include:: docs/header0.txt
 
 ========================
  Docutils Release Notes
@@ -6,13 +6,13 @@
 
 :Contact: grubert@users.sourceforge.net
 :Maintainer: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-04-17 14:41:26 +0200 (Sa, 17. Apr 2021) $
-:Revision: $Revision: 8705 $
+:Date: $Date: 2023-05-09 19:55:19 +0200 (Di, 09. Mai 2023) $
+:Revision: $Revision: 9374 $
 :Web site: https://docutils.sourceforge.io/
 :Copyright: This document has been placed in the public domain.
 
 
-This document summarizes the major changes in recent and upcoming releases.
+This document summarizes the major changes in previous and upcoming releases.
 For a more detailed list of changes, please see the Docutils `HISTORY`_.
 
 .. contents::
@@ -20,87 +20,413 @@
 Future changes
 ==============
 
-* `latex` writer: The default for the configuration setting
-  `legacy_class_functions`_ will change to "False". Adapt stylesheets
-  modifying ``\DUadmonition`` and/or ``\DUtitle`` or set to "True".
+Drop support for Python 3.7 and 3.8 in Docutils 0.21.
 
-* `html5` writer:
+Command line interface
+----------------------
 
-  - Use semantic tags <aside> for footnote text, citations, for topics
-    (except abstract), admonitions, and system messages, and <nav> for
-    the Table of Contents.
+* Docutils 0.21 will provide ``rst2*`` "console_scripts" `entry points`_
+  (without the ``.py`` extension) instead of installing the
+  ``rst2*.py`` `front end tools`_ in the binary PATH. #_
 
-  - Use <summary> and <details> tags for term and definition of a
-    definition list with class value "details".
+  You may use the ``docutils`` `generic command line front end tool`_
+  as a future-proof command, for example:
 
-  - Write footnote brackets and field term colons to HTML, so that
-    they are present also without CSS and when copying text.
-    Hide with CSS if required.
+  .. code:: diff
 
-  - Move attribution behind the blockquote to comply with
-    https://html.spec.whatwg.org/#the-blockquote-element.
+     - rst2latex.py --use-latex-abstract FAQ.txt > FAQ.tex
+     + docutils --writer=latex --use-latex-abstract FAQ.txt > FAQ.tex
 
-* `htm4css1` writer: Support the embed_images_ option.
+  Exceptions:
+    The auxiliary script ``rst2odt_prepstyles.py`` will become
+    available via ``python -m docutils.writers.odf_odt.prepstyles``.
 
-* `s5_html` writer: Remove the IE PNG Fix by Angus Turnbull. IE has
-  native PNG support since version 7.
+    The ``rstpep2html.py`` script will be retired.
+    Use ``docutils --reader=pep --writer=pep_html`` for a PEP preview
+    (the final rendering is done by a Sphinx-based build system,
+    cf. :PEP:`676`).
 
-* Make <meta> a standard Docutils doctree node.
+  .. # Some Linux distributions already use the short names.
 
-  The `meta directive`__ will insert <meta> instead of pending nodes.
-  Writers may ignore some or all <meta> elements if they are not
-  supported by the output format.
+* The _`command-line usage pattern` will change:
 
-  The ``transforms/components.Filter`` class will become obsolete by
-  this change and may be removed in future.
+  .. code:: diff
 
-  __ docs/ref/rst/directives.html#meta
+       - COMMAND OPTIONS SOURCE DESTINATION
+       + COMMAND OPTIONS SOURCE SOURCE2 ... >DESTINATION
 
-* ``Node.traverse()`` will return an iterator instead of a list.
+  * Remove short options ``-i`` and ``-o`` in Docutils 0.22.
+    Use the long equivalents ``--input-encoding`` and ``--output-encoding``.
 
-* Remove ``utils.unique_combinations``
-  (obsoleted by ``itertools.combinations``).
+  * Stop accepting the DESTINATION positional argument in Docutils 1.0.
+    Use output redirection or the option ``--output=DESTINATION``
+    (available since Docutils 0.20).
 
-* Eventually remove the "rawsource" attribute and argument from nodes.Text:
-  we store the null-escaped text in Text nodes since 0.16 so there is no
-  additional information in the rawsource.
+  * Accept more than one source document and the short option
+    ``-o`` for ``--output`` in Docutils 2.0
 
-* If the id_prefix_ setting is non-empty, leading number and hyphen characters
-  will not be stripped from a `reference name`_ during `identifier
-  normalization`_. This may change generated `identifier keys`.
+  For the rationale, see https://clig.dev/#arguments-and-flags.
 
-  Example: with ``--id-prefix="DU-"``, a section with title "34. May"
-  currently gets the identifier key ``DU-may`` and after the change the
-  identifier key ``DU-34-may``.
+.. _entry points:
+    https://packaging.python.org/en/latest/specifications/entry-points/
 
-* The default value for auto_id_prefix_ will change to "%". This means
-  auto-generated IDs will use the tag name as prefix. Set auto_id_prefix_ to
-  "id" if you want unchanged auto-IDs or to "%" if you want the new
-  feature already in 0.17.
 
-* The default HTML writer "html" with frontend ``rst2html.py`` may change
-  from "html4css1" to "html5".
+`Input encoding`_
+-----------------
 
-  Use ``get_writer_by_name('html')`` or the rst2html.py_ front end, if you
-  want the output to be up-to-date automatically.
+* Raise `UnicodeError` (instead of falling back to the locale encoding)
+  if decoding the source with the default encoding (UTF-8) fails and
+  Python is started in `UTF-8 mode`_. (Docutils 0.21)
 
-  Use the "html4" writer or ``rst2html4.py``, if you depend on
-  stability of the generated HTML code, e.g. because you use a custom
-  style sheet or post-processing that may break otherwise.
+  Raise `UnicodeError` (instead of falling back to "latin1") if both,
+  default and locale encoding, fail. (Docutils 0.21)
 
-.. _id_prefix: docs/user/config.html#id-prefix
-.. _auto_id_prefix: docs/user/config.html#auto-id-prefix
-.. _rst2html.py: docs/user/tools.html#rst2html-py
+* Only remove BOM (U+FEFF ZWNBSP at start of data), no other ZWNBSPs.
+  Only remove BOM with `input_encoding`_ values None, '', 'utf-8-sig',
+  'utf-16', and 'utf-32'. (Docutils 0.21)
+
+* Change the default input encoding from ``None`` (auto-detect) to
+  "utf-8" in Docutils 0.22.
+
+* Remove the input encoding auto-detection code in Docutils 1.0 or later.
+
+Writers
+-------
+
+* The `default HTML writer`__  will change in Docutils 2.0:
+
+  The rst2html_ front end and ``get_writer_by_name('html')`` select
+  "html4css1" now and will select "html5" in Docutils 2.0 and later.
+
+  - Use rst2html4_, ``docutils --writer=html4``, or
+    ``get_writer_by_name('html4')`` if you depend on stability of the
+    generated HTML code, e.g. because you use a custom style sheet or
+    post-processing that may break otherwise.
+  - Use rst2html5_, ``docutils`` or ``get_writer_by_name('html5')``
+    if you want a HTML5 document.
+
+  __ docs/user/html.html#html
+
+* "html5" writer:
+
+  - Stop setting the "footnote-reference" class value for footnote
+    references in Docutils 0.21.
+    Since 0.18, you can use the CSS selector
+    ``role="doc-noteref"`` instead of ``.footnote-reference``
+    (see minimal.css for examples).
+
+  - Move attribution behind the blockquote to comply with the `"living
+    standard"`__. (HTML5__ allows <cite> elements inside a blockquote.)
+
+    __ https://html.spec.whatwg.org/#the-blockquote-element
+    __ https://www.w3.org/TR/2014/REC-html5-20141028/grouping-content.html
+       #the-blockquote-element
+
+  - Change the default value for math_output_ to "MathML" in Docutils 0.22.
+
+  - Remove option ``--embed-images`` (obsoleted by "image_loading_")
+    in Docutils 2.0.
+
+* "latex2e" writer:
+
+  - Change default of use_latex_citations_ setting to True
+    in Docutils 1.0.
+
+  - Change default of legacy_column_widths_ setting to False
+    in Docutils 1.0.
+
+  - Remove ``use_verbatim_when_possible`` setting
+    (use literal_block_env_: verbatim) in Docutils 2.0.
+
+* "null" writer: output will change to the empty string in Docutils 0.22.
+
+Misc
+----
+
+* "csv-table_" directive:
+
+  - Use the same CSV format for the main CSV data and the :header: option
+    (as specified in the documentation since addition of "csv-table_")
+    in Docutils 0.21.
+
+  - Move `parsers.rst.directives.Table.process_header_option()` to
+    `parsers.rst.directives.CSVTable` in Docutils 0.21.
+
+  - Remove `parsers.rst.directives.CSVTable.HeaderDialect`
+    in Docutils 0.22.
+
+* Remove the compatibility hacks `nodes.reprunicode` and `nodes.ensure_str()`
+  in Docutils 0.21 or later. They are not required with Python 3.x.
+
+* Remove file ``install.py`` in Docutils 0.21.
+  See README.txt__ for alternatives.
+
+  __ README.html#installation
+
+* Remove the "rawsource" argument from `nodes.Text.__init__()`
+  in Docutils 2.0.
+
+* Drop support for `old-format configuration files`_ in Docutils 2.0.
+
+* Remove the ``--html-writer`` option of the `buildhtml.py`_ application
+  (obsoleted by the `"writer" setting`_ since Docutils 0.18)
+  in Docutils 2.0.
+
+* Revise the `String I/O`__ interface used by the `publish_string()`
+  and `publish_from_doctree()` publisher convenience functions.
+  (In Python 3, name and behaviour no longer match.)
+
+  __ docs/api/publisher.html#string-i-o
+
+* Move math format conversion from docutils/utils/math (called from
+  docutils/writers/_html_base.py) to a transform__.
+
+  __ docs/ref/transforms.html
+
+.. _front end tools: docs/user/tools.html
+.. _input encoding:
+.. _input_encoding: docs/user/config.html#input-encoding
+.. _math_output: docs/user/config.html#math-output
+.. _UTF-8 mode: https://docs.python.org/3/library/os.html#utf8-mode
+.. _image_loading: docs/user/config.html#image-loading
+.. _old-format configuration files:
+   docs/user/config.html#old-format-configuration-files
+.. _rst2html.py:
+.. _rst2html: docs/user/tools.html#rst2html
+.. _rst2html4: docs/user/tools.html#rst2html4
+.. _rst2html5: docs/user/tools.html#rst2html5
 .. _reference name: docs/ref/rst/restructuredtext.html#reference-names
+.. _literal_block_env: docs/user/config.html#literal-block-env
+.. _use_latex_citations: docs/user/config.html#use-latex-citations
+.. _buildhtml.py: docs/user/tools.html#buildhtml-py
+.. _csv-table: docs/ref/rst/directives.html#csv-table
+
+Release 0.20 (2023-05-04)
+=========================
+
+.. Note::
+
+   Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
+
+* General
+
+  - Support Python 3.11 (patch #198 by Hugo van Kemenade).
+
+* Output changes:
+
+  HTML5:
+    Use dpub-ARIA role "doc-footnote" (instead of ARIA role "note")
+    for footnotes.
+
+  LaTeX:
+    Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
+    (UTF-8 is the default encoding for LaTeX2e since 2018).
+
+* Configuration changes:
+
+  - Settings in the latex2e writer configuration file section
+    are now ignored by the "xetex" writer.
+    Place common settings in section `latex writers`_.
+
+    .. _latex writers: docs/user/config.html#latex-writers
+
+  - New command line setting output_. Obsoletes the ``<destination>``
+    positional argument (cf. `future changes`__).
+
+    __ `command-line usage pattern`_
+
+* `utils.find_file_in_dirs()` now returns a POSIX path also on Windows;
+  `utils.get_stylesheet_list()` no longer converts ``\`` to ``/``.
+
+* docutils/languages/
+  docutils/parsers/rst/languages/
+
+  - Support Ukrainian. Patch by Dmytro Kazanzhy.
+
+* test/coverage.sh
+
+  - Removed. Use the coverage.py_ project instead,
+    ``coverage run test/alltests.py`` and ``coverage report``.
+
+  .. _coverage.py: https://pypi.org/project/coverage/
+
+* tools/
+
+  - Moved ``quicktest.py`` to ``tools/dev/``.
+
+* Bugfixes and improvements (see HISTORY_).
+
+.. _output: docs/user/config.html#output
+
+
+Release 0.19 (2022-07-05)
+=========================
+
+(Release 0.19b1 (2022-06-21))
+
+* Drop support for Python 2.7, 3.5, and 3.6.
+
+* Output changes:
+
+  HTML5:
+    Wrap groups of footnotes in an ``<aside>`` for easier styling.
+
+    The CSS rule ``.footnote-list { display: contents; }`` can be used to
+    restore the behaviour of custom CSS styles.
+
+* After package installation, the CLI commands ``python -m docutils`` and
+  ``docutils`` start the `generic command line front end tool`_.
+
+  .. _generic command line front end tool:
+      docs/user/tools.html#generic-command-line-front-end
+
+* Support parsing "Markdown" input with 3rd party parsers
+  myst_, pycmark_, or recommonmark_.
+
+* The default values for the "pep-references", "rfc-base-url",
+  and "python-home" `configuration settings`_ now use the "https:" scheme.
+  The PEP-writer template's header is updated to fix links and
+  resemble the header of official PEPs.
+
+* Various bugfixes and improvements (see HISTORY_).
+
+.. _myst: https://pypi.org/project/myst-docutils
+.. _pycmark: https://pypi.org/project/pycmark/
+.. _recommonmark: https://pypi.org/project/recommonmark/
+.. _configuration settings: docs/user/config.html
+
+
+Release 0.18.1 (2021-12-23)
+===========================
+
+.. Note::
+
+   Docutils 0.18.1 is the last version supporting Python 2.7, 3.5, and 3.6.
+
+* ``nodes.Node.traverse()`` returns a list again to restore backwards
+  compatibility (fixes bug #431).
+  Use ``nodes.Node.findall()`` to get an iterator.
+
+* re-add module ``parsers.rst.directives.html``
+  (stub, emits deprecation warning and loads
+  "Meta" directive from its new place at ``parsers.rst.directives.misc``.)
+
+* Small bugfixes (see HISTORY_).
+
+
+Release 0.18 (2021-10-26)
+=========================
+
+* Output changes:
+
+  Identifiers:
+    - During `identifier normalization`_, leading number and hyphen
+      characters are no longer stripped from a `reference name`_, if the
+      id_prefix_ setting is non-empty.
+
+      Example:
+        with ``--id-prefix="DU-"``, a section with title "34. May"
+        currently gets the identifier key ``DU-may`` and after the
+        change the identifier key ``DU-34-may``.
+
+    - The default value for the auto_id_prefix_ setting changed to ``%``:
+      "use the tag name as prefix for auto-generated IDs".
+      Set auto_id_prefix_ to ``id`` for unchanged auto-IDs.
+
+  HTML5:
+    - Use the semantic tag <aside> for footnote text and citations, topics
+      (except abstract and toc), admonitions, and system messages.
+      Use <nav> for the Table of Contents.
+
+    - Make "auto" table column widths the default: Only specify column
+      widths, if the `"widths" option`_ is set and not "auto".
+      The table-style__ setting "colwidths-grid" restores the current default.
+
+      .. _"widths" option: __ docs/ref/rst/directives.html#table
+      __ docs/user/config.html#table-style
+
+    - Items of a definition list with class argument "details" are
+      converted to `details disclosure elements`_. Example::
+
+        ..class:: details
+
+        Summary
+          This additional information should be hidden.
+
+    - Do not add "compound-first", "compound-middle", or "compound-last" to
+      elements nested in a compound. Use child selector and ":first-child",
+      ":last-child" pseudo classes instead.
+
+    - Use class value "backrefs" instead of "fn-backref" for a span of
+      back-references.
+
+    - Write footnote brackets and field term colons to HTML, so that they
+      are present also without CSS and when copying text.
+
+    - Move space character between section number and heading into
+      "sectnum" span.
+
+  `math-output`_: html
+    - Support more commands, fix mapping of commands to Unicode characters.
+    - Scale variable sized operators and big delimiters with CSS.
+    - Don't use <tt> element (deprecated in HTML5).
+    - Use STIX fonts if available.
+
+  LaTeX:
+     `legacy_class_functions`_ setting default changed to "False",
+     admonitions are now environments.
+
+* New standard Docutils doctree node: <meta__>.
+
+* New configuration settings:
+
+  - latex writers legacy_column_widths_ and
+  - html5 writer image_loading_.
+
+* Removed files:
+  ``iepngfix.htc`` and ``blank.gif`` (IE 6 workaround for `s5_html`).
+
+* Removed sub-module:
+  ``parsers.rst.directives.html``
+  (reversed in release 0.18.1).
+
+* Removed function: utils.unique_combinations()
+  (obsoleted by itertools.combinations()).
+
+* Removed attributes:
+
+  - ``HTMLTranslator.topic_classes``: check ``node.parent.classes`` instead.
+  - ``nodes.Text.rawsource``: we store the null-escaped text in Text
+    nodes since 0.16 so there is no additional information in the
+    rawsource.
+
+* Major refactoring and fixes/additions in
+  ``docutils/utils/math/math2html.py`` and
+  ``docutils/utils/math/latex2mathml.py``
+  (mathematical notation in HTML, cf. `LaTeX syntax for mathematics`_).
+
+* nodes.Node.traverse() returns an iterator instead of a list
+  (reversed in release 0.18.1).
+
+* Various bugfixes and improvements (see HISTORY_).
+
+  Fix spelling errors in documentation and docstrings.
+  Thanks to Dimitri Papadopoulos.
+
+__ docs/ref/doctree.html#meta
 .. _identifier normalization:
    docs/ref/rst/directives.html#identifier-normalization
+.. _id_prefix: docs/user/config.html#id-prefix
+.. _auto_id_prefix: docs/user/config.html#auto-id-prefix
+.. _details disclosure elements:
+    https://www.w3.org/TR/html52/interactive-elements.html#the-details-element
+.. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
+.. _legacy_column_widths: docs/user/config.html#legacy-column-widths
 
 
 Release 0.17.1 (2021-04-16)
 ===========================
 
-(Release 0.17.1b.dev)
-
 * Bug fixes (for details see the Docutils `HISTORY`_).
 
 Release 0.17 (2021-04-03)
@@ -176,19 +502,15 @@
 Release 0.16 (2020-01-12)
 =========================
 
-.. Note::
-
-   Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
-
-   Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
-   without the use of the ``2to3`` tool.
+Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
+without the use of the ``2to3`` tool.
 
 * reStructuredText:
 
   - Keep `backslash escapes`__ in the document tree. This allows, e.g.,
     escaping of author-separators in `bibliographic fields`__.
 
-  __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
+  __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
   __ docs/ref/rst/restructuredtext.html#bibliographic-fields
 
 * LaTeX writer:
@@ -203,14 +525,16 @@
 
 * tools/buildhtml.py
 
-  - New option "--html-writer" allows to select "html__" (default),
-    "html4" or "html5".
+  - New option ``--html-writer`` allows to select "html" (default),
+    "html4" or "html5" (deprecated in favour of the `"writer" setting`_
+    in Docutils 0.18).
 
-  __ html: docs/user/html.html#html
+  .. _"writer" setting:
+     docs/user/config.html#writer-buildhtml-application
 
 * docutils/io.py
 
-  - Remove the `handle_io_errors` option from io.FileInput/Output.
+  - Remove the `handle_io_errors` argument from io.FileInput/Output.
 
 * docutils/nodes.py
 
@@ -224,13 +548,11 @@
 Release 0.15 (2019-07-20)
 =========================
 
-.. Note::
+Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5.
 
-   Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
-   3.1, and 3.2.
+.. Note::
 
-   Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
-   (cf. `Python 3 compatibility`_).
+   Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
 
 * reStructuredText:
 
@@ -245,6 +567,11 @@
 Release 0.14 (2017-08-03)
 =========================
 
+.. Note::
+
+   Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
+   3.1, and 3.2.
+
 * docutils/docs/ref/docutils.dtd:
 
   - Enable validation of Docutils XML documents against the DTD:
@@ -298,7 +625,7 @@
 
   - New HTML writer generating `HTML 5`_.
 
-  .. _HTML 5: http://www.w3.org/TR/html5/
+  .. _HTML 5: https://www.w3.org/TR/html5/
 
 * tools/
 
@@ -327,7 +654,7 @@
 
 * General
 
-  - Apply  2714873  Fix for the overwritting of document attributes.
+  - Apply  2714873  Fix for the overwriting of document attributes.
   - Support embedded aliases within hyperlink references.
   - Fix  228  try local import of docutils components (reader, writer, parser,
     language module) before global search.
@@ -373,12 +700,7 @@
 Release 0.10 (2012-12-16)
 =========================
 
-.. Note::
-
-   Docutils 0.9.x is the last version supporting Python 2.3.
-
-   Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
-   (cf. `Python 3 compatibility`_).
+Docutils 0.10 is compatible with Python versions from 2.4 to 3.2.
 
 * General:
 
@@ -398,7 +720,7 @@
 * docutils/io.py
 
   - FileInput/FileOutput: no system-exit on IOError.
-    The `handle_io_errors` option is ignored.
+    The `handle_io_errors` argument is ignored.
 
 * docutils/writers/html4css1/__init__.py
 
@@ -419,6 +741,10 @@
 Release 0.9.1 (2012-06-17)
 ==========================
 
+.. Note::
+
+   Docutils 0.9.1 is the last version supporting Python 2.3.
+
 * General:
 
   Several fixes for Python 3 usage.
@@ -443,7 +769,7 @@
     by Pygments_.
   - "code" option of the "include" directive.
 
-  .. _Pygments: http://pygments.org/
+  .. _Pygments: https://pygments.org/
 
   - Fix  3402314  allow non-ASCII whitespace, punctuation
     characters and "international" quotes around inline markup.
@@ -495,13 +821,13 @@
 * General:
 
   - Handle language codes according to `BCP 47`_.
-  - If the specified langauage is not supported by Docutils,
+  - If the specified language is not supported by Docutils,
     warn and fall back to English.
   - Math support: reStructuredText "math" role and directive,
     ``math`` and ``math_block`` doctree elements.
   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
 
-  .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
+  .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
 
 * reStructuredText:
 
@@ -590,12 +916,8 @@
 Release 0.6 (2009-10-11)
 ========================
 
-.. Note::
-
-   Docutils 0.5 is the last version supporting Python 2.2.
-
-   Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
-   and convertible to 3.1 code.
+Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
+and convertible to 3.1 code.
 
 .. note::
 
@@ -603,7 +925,7 @@
 
    The recommended way to generate PDF output is to use either the
    LaTeX2e writer or one of the alternatives listed at
-   http://docutils.sourceforge.net/docs/user/links.html#pdf.
+   https://docutils.sourceforge.io/docs/user/links.html#pdf.
 
 * reStructuredText:
 
@@ -625,7 +947,7 @@
 * LaTeX2e writer:
 
   - New defaults:
-    - font-encoding: "T1" (formerly implicitely set by 'ae').
+    - font-encoding: "T1" (formerly implicitly set by 'ae').
     - use-latex-toc: true (ToC with page numbers).
     - use-latex-footnotes: true (no mixup with figures).
     - Float placement defaults to "here definitely" (configurable).
@@ -659,6 +981,10 @@
 Release 0.5 (2008-06-25)
 ========================
 
+.. Note::
+
+   Docutils 0.5 is the last version supporting Python 2.2.
+
 Components:
 
 * HTML writer.
@@ -712,12 +1038,10 @@
 
 .. Note::
 
-   Docutils 0.4.x is the last version that will support Python 2.1.
-   Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
-   or later will be required.
+   Docutils 0.4 is the last version supporting Python 2.1.
 
-   Docutils 0.4.x is the last version that will make compromises in
-   its HTML output for Netscape Navigator 4.  Docutils 0.5 will
+   It is also the last version that will make compromises in
+   its HTML output for Netscape Navigator 4.  Docutils 0.5 will
    require more up-to-date browsers (the exact definition is to be
    determined).

_service:tar_scm:docutils-0.17.1.tar.gz/THANKS.txt -> _service:tar_scm:docutils-0.20.tar.gz/THANKS.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/TODO.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/docs/api/publisher.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/api/publisher.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ========================
  The Docutils Publisher
 ========================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
-:Revision: $Revision: 8631 $
+:Date: $Date: 2023-05-03 01:04:27 +0200 (Mi, 03. Mai 2023) $
+:Revision: $Revision: 9369 $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -14,126 +16,160 @@
 The ``docutils.core.Publisher`` class is the core of Docutils,
 managing all the processing and relationships between components.  See
 `PEP 258`_ for an overview of Docutils components.
-
-The ``docutils.core.publish_*`` convenience functions are the normal
-entry points for using Docutils as a library.
-
-See `Inside A Docutils Command-Line Front-End Tool`_ for an overview
-of a typical Docutils front-end tool, including how the Publisher
-class is used.
+Configuration is done via `runtime settings`_ assembled from several sources.
+The *Publisher convenience functions* are the normal entry points for
+using Docutils as a library.
 
 .. _PEP 258: ../peps/pep-0258.html
-.. _Inside A Docutils Command-Line Front-End Tool: ./cmdline-tool.html
 
 
 Publisher Convenience Functions
 ===============================
 
-Each of these functions set up a ``docutils.core.Publisher`` object,
-then call its ``publish`` method.  ``docutils.core.Publisher.publish``
-handles everything else.  There are several convenience functions in
-the ``docutils.core`` module:
+There are several convenience functions in the ``docutils.core`` module.
+Each of these functions sets up a `docutils.core.Publisher` object,
+then calls its ``publish()`` method.  ``docutils.core.Publisher.publish()``
+handles everything else.
 
-:_`publish_cmdline`: for command-line front-end tools, like
-  ``rst2html.py``.  There are several examples in the ``tools/``
-  directory.  A detailed analysis of one such tool is in `Inside A
-  Docutils Command-Line Front-End Tool`_
+See the module docstring, ``help(docutils.core)``, and the function
+docstrings, e.g., ``help(docutils.core.publish_string)``, for details and
+a description of the function arguments.
 
-:_`publish_file`: for programmatic use with file-like I/O.  In
-  addition to writing the encoded output to a file, also returns the
-  encoded output as a string.
+.. TODO: generate API documentation with Sphinx and add links to it.
 
-:_`publish_string`: for programmatic use with string I/O.  Returns
-  the encoded output as a string.
 
-:_`publish_parts`: for programmatic use with string input; returns a
-  dictionary of document parts.  Dictionary keys are the names of
-  parts, and values are Unicode strings; encoding is up to the client.
-  Useful when only portions of the processed document are desired.
-  See `publish_parts Details`_ below.
+publish_cmdline()
+-----------------
 
-  There are usage examples in the `docutils/examples.py`_ module.
+Function for command-line front-end tools, like ``rst2html.py`` or
+`"console_scripts" entry points`_ like `core.rst2html()` with file I/O.
+In addition to writing the output document to a file-like object, also
+returns it as `str` instance (rsp. `bytes` for binary output document
+formats).
 
-:_`publish_doctree`: for programmatic use with string input; returns a
-  Docutils document tree data structure (doctree).  The doctree can be
-  modified, pickled & unpickled, etc., and then reprocessed with
-  `publish_from_doctree`_.
+There are several examples in the ``tools/`` directory of the Docutils
+repository. A detailed analysis of one such tool is `Inside A Docutils
+Command-Line Front-End Tool`_.
 
-:_`publish_from_doctree`: for programmatic use to render from an
-  existing document tree data structure (doctree); returns the encoded
-  output as a string.
+.. _"console_scripts" entry points:
+    https://packaging.python.org/en/latest/specifications/entry-points/
+.. _Inside A Docutils Command-Line Front-End Tool: ../howto/cmdline-tool.html
 
-:_`publish_programmatically`: for custom programmatic use.  This
-  function implements common code and is used by ``publish_file``,
-  ``publish_string``, and ``publish_parts``.  It returns a 2-tuple:
-  the encoded string output and the Publisher object.
 
-.. _Inside A Docutils Command-Line Front-End Tool: ./cmdline-tool.html
-.. _docutils/examples.py: ../../docutils/examples.py
+publish_file()
+--------------
 
+For programmatic use with file I/O. In addition to writing the output
+document to a file-like object, also returns it as `str` instance
+(rsp. `bytes` for binary output document formats).
 
-Configuration
--------------
 
-To pass application-specific setting defaults to the Publisher
-convenience functions, use the ``settings_overrides`` parameter.  Pass
-a dictionary of setting names & values, like this::
+publish_string()
+----------------
 
-    overrides = {'input_encoding': 'ascii',
-                 'output_encoding': 'latin-1'}
-    output = publish_string(..., settings_overrides=overrides)
+For programmatic use with _`string I/O`:
 
-Settings from command-line options override configuration file
-settings, and they override application defaults.  For details, see
-`Docutils Runtime Settings`_.  See `Docutils Configuration Files`_ for
-details about individual settings.
+Input
+  can be a `str` or `bytes` instance.
+  `bytes` are decoded with input_encoding_.
 
-.. _Docutils Runtime Settings: ./runtime-settings.html
-.. _Docutils Configuration Files: ../user/tools.html
+Output
+  * is a `bytes` instance, if output_encoding_ is set to an encoding
+    registered with Python's "codecs_" module (default: "utf-8"),
+  * a `str` instance, if output_encoding_ is set to the special value
+    ``"unicode"``.
 
+.. Caution::
+   The "output_encoding" and "output_encoding_error_handler" `runtime
+   settings`_ may affect the content of the output document:
+   Some document formats contain an *encoding declaration*,
+   some formats use substitutions for non-encodable characters.
 
-Encodings
----------
+   Use `publish_parts()`_ to get a `str` instance of the output document
+   as well as the values of the output_encoding_ and
+   output_encoding_error_handler_ runtime settings.
 
-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`_.
+*This function is provisional* because in Python 3 the name and behaviour
+no longer match.
 
-.. _auto-symbol footnotes:
-   ../ref/rst/restructuredtext.html#auto-symbol-footnotes
-.. _"contents" directive:
-   ../ref/rst/directives.html#table-of-contents
+.. _codecs: https://docs.python.org/3/library/codecs.html
+
+
+publish_doctree()
+-----------------
+
+Parse string input (cf. `string I/O`_) into a `Docutils document tree`_ data
+structure (doctree). The doctree can be modified, pickled & unpickled,
+etc., and then reprocessed with `publish_from_doctree()`_.
+
+
+publish_from_doctree()
+----------------------
 
+Render from an existing `document tree`_ data structure (doctree).
+Returns the output document as a memory object (cf. `string I/O`_).
 
-``publish_parts`` Details
-=========================
+*This function is provisional* because in Python 3 the name and behaviour
+of the *string output* interface no longer match.
 
-The ``docutils.core.publish_parts`` convenience function returns a
-dictionary of document parts.  Dictionary keys are the names of parts,
-and values are Unicode strings.
 
+publish_programmatically()
+--------------------------
+
+Auxilliary function used by `publish_file()`_, `publish_string()`_,
+`publish_doctree()`_, and `publish_parts()`_.
+Applications should not need to call this function directly.
+
+.. _publish-parts-details:
+
+publish_parts()
+---------------
+
+For programmatic use with string input (cf. `string I/O`_).
+Returns a dictionary of document parts as `str` instances. #binary-output_
+Dictionary keys are the part names.
 Each Writer component may publish a different set of document parts,
-described below.  Not all writers implement all parts.
+described below.
+
+Example: post-process the output document with a custom function
+``post_process()`` before encoding with user-customizable encoding
+and errors ::
+
+       def publish_bytes_with_postprocessing(*args, **kwargs):
+           parts = publish_parts(*args, **kwargs)
+           out_str = post_process(parts'whole')
+           return out_str.encode(parts'encoding', parts'errors')
+
+There are more usage examples in the `docutils/examples.py`_ module.
+
+.. _docutils/examples.py: ../../docutils/examples.py
+.. _ODT: ../user/odt.html
 
 
 Parts Provided By All Writers
------------------------------
+`````````````````````````````
 
 _`encoding`
-    The output encoding setting.
+    The `output_encoding`_ setting.
+
+_`errors`
+    The `output_encoding_error_handler`_ setting.
 
 _`version`
     The version of Docutils used.
 
 _`whole`
-    ``parts'whole'`` contains the entire formatted document.
+    Contains the entire formatted document. #binary-output_
+
+    .. #binary-output Output documents in binary formats (e.g. ODT_)
+       are stored as a `bytes` instance.
 
 
 Parts Provided By the HTML Writers
-----------------------------------
+``````````````````````````````````
 
 HTML4 Writer
-````````````
+^^^^^^^^^^^^
 
 _`body`
     ``parts'body'`` is equivalent to parts'fragment_'.  It is
@@ -210,8 +246,8 @@
 _`html_head`
     ``parts'html_head'`` contains the HTML ``<head>`` content, less
     the stylesheet link and the ``<head>`` and ``</head>`` tags
-    themselves.  Since ``publish_parts`` returns Unicode strings and
-    does not know about the output encoding, the "Content-Type" meta
+    themselves.  Since `publish_parts()` returns `str` instances which
+    do not know about the output encoding, the "Content-Type" meta
     tag's "charset" value is left unresolved, as "%s"::
 
         <meta http-equiv="Content-Type" content="text/html; charset=%s" />
@@ -229,12 +265,12 @@
 
 _`html_subtitle`
     ``parts'html_subtitle'`` contains the document subtitle,
-    including the enclosing ``<h2 class="subtitle">`` & ``</h2>``
+    including the enclosing ``<h2 class="subtitle">`` and ``</h2>``
     tags.
 
 _`html_title`
     ``parts'html_title'`` contains the document title, including the
-    enclosing ``<h1 class="title">`` & ``</h1>`` tags.
+    enclosing ``<h1 class="title">`` and ``</h1>`` tags.
 
 _`meta`
     ``parts'meta'`` contains all ``<meta ... />`` tags.
@@ -245,43 +281,47 @@
 
 _`subtitle`
     ``parts'subtitle'`` contains the document subtitle text and any
-    inline markup.  It does not include the enclosing ``<h2>`` &
+    inline markup.  It does not include the enclosing ``<h2>`` and
     ``</h2>`` tags.
 
 _`title`
     ``parts'title'`` contains the document title text and any inline
-    markup.  It does not include the enclosing ``<h1>`` & ``</h1>``
+    markup.  It does not include the enclosing ``<h1>`` and ``</h1>``
     tags.
 
 
 PEP/HTML Writer
-```````````````
+^^^^^^^^^^^^^^^
 
 The PEP/HTML writer provides the same parts as the `HTML4 writer`_,
 plus the following:
 
 _`pepnum`
-    ``parts'pepnum'`` contains
+    ``parts'pepnum'`` contains the PEP number
+    (extracted from the `header preamble`__).
+
+    __ https://peps.python.org/pep-0001/#pep-header-preamble
 
 
 S5/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
-------------------------------------
+Parts Provided by the "LaTeX2e" and "XeTeX" Writers
+```````````````````````````````````````````````````
 
-See the template files for examples how these parts can be combined
+See the template files default.tex_, titlepage.tex_, titlingpage.tex_,
+and xelatex.tex_ for examples how these parts can be combined
 into a valid LaTeX document.
 
 abstract
@@ -346,7 +386,136 @@
 
 titledata
     ``parts'titledata`` contains the combined title data in
-    ``\title``, ``\author``, and ``\data`` macros.
+    ``\title``, ``\author``, and ``\date`` macros.
 
     With ``--use-latex-docinfo``, this includes the 'author',
     'organization', 'contact', 'address' and 'date' docinfo items.
+
+.. _default.tex:
+   https://docutils.sourceforge.io/docutils/writers/latex2e/default.tex
+.. _titlepage.tex:
+   https://docutils.sourceforge.io/docutils/writers/latex2e/titlepage.tex
+.. _titlingpage.tex:
+   https://docutils.sourceforge.io/docutils/writers/latex2e/titlingpage.tex
+.. _xelatex.tex:
+   https://docutils.sourceforge.io/docutils/writers/latex2e/xelatex.tex
+
+
+.. _runtime settings:
+
+Configuration
+=============
+
+Docutils is configured by *runtime settings* assembled from several
+sources:
+
+* *settings specifications* of the selected components (reader, parser,
+  writer),
+* the ``settings_overrides`` argument of the `Publisher convenience
+  functions`_ (see below),
+* *configuration files* (unless disabled), and
+* *command-line options* (if enabled).
+
+Docutils overlays default and explicitly specified values from these
+sources such that settings behave the way we want and expect them to
+behave. For details, see `Docutils Runtime Settings`_.
+The individual settings are described in `Docutils Configuration`_.
+
+To pass application-specific setting defaults to the Publisher
+convenience functions, use the ``settings_overrides`` parameter.  Pass
+a dictionary of setting names & values, like this::
+
+    app_defaults = {'input_encoding': 'ascii',
+                    'output_encoding': 'latin-1'}
+    output = publish_string(..., settings_overrides=app_defaults)
+
+Settings from command-line options override configuration file
+settings, and they override application defaults.
+
+See `Docutils Runtime Settings`_ or the docstring of
+`publish_programmatically()` for a description of all `configuration
+arguments`_ of the Publisher convenience functions.
+
+.. _configuration arguments: runtime-settings.html#convenience-functions
+
+
+Encodings
+=========
+
+.. important:: Details will change over the next Docutils versions.
+   See RELEASE-NOTES_
+
+The default **input encoding** is UTF-8. A different encoding can be
+specified with the `input_encoding`_ setting.
+
+The encoding of a reStructuredText source can also be given by a
+`Unicode byte order mark` (BOM_) or a "magic comment" #magic-comment_
+similar to :PEP:`263`. This makes the input encoding both *visible* and
+*changeable* on a per-source basis.
+
+If the encoding is unspecified and decoding with UTF-8 fails, the locale's
+`preferred encoding`_ is used as a fallback (if it maps to a valid codec
+and differs from UTF-8).
+
+The default behaviour differs from Python's `open()`:
+
+- The UTF-8 encoding is tried before the `preferred encoding`_.
+  (This is almost sure to fail if the actual source encoding differs.)
+- An `explicit encoding declaration` #magic-comment_ in the source
+  takes precedence over the `preferred encoding`_.
+- An optional BOM_ is removed from UTF-8 encoded sources.
+
+The default **output encoding** is UTF-8.
+A different encoding can be specified with the `output_encoding`_ setting.
+
+.. Caution:: Docutils may introduce non-ASCII text if you use
+   `auto-symbol footnotes`_ or the `"contents" directive`_.
+   In non-English documents, also auto-generated labels
+   may contain non-ASCII characters.
+
+.. #magic-comment A comment like ::
+
+     .. text encoding: <encoding name>
+
+   on the first or second line of a reStructuredText source
+   defines `<encoding name>` as the source's input encoding.
+
+   Examples: (using formats recognized by popular editors) ::
+
+       .. -*- mode: rst -*-
+          -*- coding: latin1 -*-
+
+   or::
+
+       .. vim: set fileencoding=cp737 :
+
+   More precisely, the first and second line are searched for the following
+   regular expression::
+
+       coding:=\s*(-\w.+)
+
+   The first group of this expression is then interpreted as encoding name.
+   If the first line matches the second line is ignored.
+
+   This feature is scheduled to be removed in Docutils 1.0.
+   See the `inspecting_codecs`_ package for a possible replacement.
+
+
+.. _Inside A Docutils Command-Line Front-End Tool: ../howto/cmdline-tool.html
+.. _RELEASE-NOTES: ../../RELEASE-NOTES.html#future-changes
+.. _input_encoding: ../user/config.html#input-encoding
+.. _preferred encoding:
+   https://docs.python.org/3/library/locale.html#locale.getpreferredencoding
+.. _BOM: https://docs.python.org/3/library/codecs.html#codecs.BOM
+.. _output_encoding: ../user/config.html#output-encoding
+.. _output_encoding_error_handler:
+   ../user/config.html#output-encoding-error-handler
+.. _auto-symbol footnotes:
+   ../ref/rst/restructuredtext.html#auto-symbol-footnotes
+.. _"contents" directive:
+   ../ref/rst/directives.html#table-of-contents
+.. _document tree:
+.. _Docutils document tree: ../ref/doctree.html
+.. _Docutils Runtime Settings: ./runtime-settings.html
+.. _Docutils Configuration: ../user/config.html
+.. _inspecting_codecs: https://codeberg.org/milde/inspecting-codecs

_service:tar_scm:docutils-0.17.1.tar.gz/docs/api/runtime-settings.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/api/runtime-settings.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ===========================
  Docutils Runtime Settings
 ===========================
 
-:Author: David Goodger
+:Author: David Goodger, Günter Milde
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
-:Revision: $Revision: 7302 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -15,178 +17,204 @@
 ============
 
 Docutils runtime settings are assembled from several sources:
-component settings specifications, application settings
-specifications, configuration files, and command-line options.
+
+* Settings specifications of the selected components_,
+* `configuration files`_ (if enabled), and
+* command-line options (if enabled).
+
 Docutils overlays default and explicitly specified values from these
 sources such that settings behave the way we want and expect them to
 behave.
 
-To understand how Docutils deals with runtime settings, the attributes
-and parameters involved must first be understood.  Begin with the the
-docstrings of the attributes of the ``docutils.SettingsSpec`` base
-class (in the ``docutils/__init__.py`` module):
-
-* ``settings_spec``
-* ``settings_defaults``
-* ``settings_default_overrides``
-* ``relative_path_settings``
-* ``config_section``
-* ``config_section_dependencies``
-
-Next, several _`convenience function parameters` are also significant
-(described in the ``docutils.core.publish_programmatically`` function
-docstring):
-
-* The ``settings`` parameter is a runtime settings
-  (``docutils.frontend.Values``) object which, if present, is assumed
-  to be complete (it must include all runtime settings).  Also, if the
-  ``settings`` parameter is present, no further runtime settings
-  processing is done.  In other words, the other parameters, described
-  below, will have no effect.
-
-* ``settings_spec``, a `docutils.SettingsSpec` subclass or object, is
-  treated like a fourth component (after the Parser, Reader, and
-  Writer).  In other words, it's the settings specification for the
-  "Application" itself.
-
-* ``settings_overrides`` is a dictionary which will override the
-  defaults of the components (from their settings specs).
-
-* ``config_section`` specifies the name of an application-specific
-  configuration file section.
-
-
-.. _command-line tools:
-
-Runtime Settings Processing for Command-Line Tools
-==================================================
-
-Following along with the actual code is recommended.  The
-``docutils/__init__.py``, ``docutils/core.py``, and
-``docutils.frontend.py`` modules are described.
-
-1. A command-line front-end tool imports and calls
-   ``docutils.core.publish_cmdline``.  The relevant `convenience
-   function parameters`_ are described above.
-
-2. ``docutils.core.publish_cmdline`` initializes a
-   ``docutils.core.Publisher`` object, then calls its ``publish``
-   method.
-
-3. The ``docutils.core.Publisher`` object's ``publish`` method checks
-   its ``settings`` attribute to see if it's defined.  If it is, no
-   further runtime settings processing is done.
-
-   If ``settings`` is not defined, ``self.process_command_line`` is
-   called with the following relevant arguments:
-
-   * ``settings_spec``
-   * ``config_section``
-   * ``settings_overrides`` (in the form of excess keyword
-     arguments, collected in the ``defaults`` parameter)
-
-4. ``self.process_command_line`` calls ``self.setup_option_parser``,
-   passing ``settings_spec``, ``config_section``, and ``defaults``.
-
-5. ``self.setup_option_parser`` checks its ``config_section``
-   parameter; if defined, it adds that config file section to
-   ``settings_spec`` (or to a new, empty ``docutils.SettingsSpec``
-   object), replacing anything defined earlier.  (See `Docutils
-   Configuration Files`_ for details.)  Then it instantiates a new
-   ``docutils.frontend.OptionParser`` object, passing the following
-   relevant arguments:
-
-   * ``components``: A tuple of ``docutils.SettingsSpec`` objects,
-     ``(self.parser, self.reader, self.writer, settings_spec)``
-   * ``defaults`` (originally from ``settings_overrides``)
-
-6. The ``docutils.frontend.OptionParser`` object's ``__init__`` method
-   calls ``self.populate_from_components`` with ``self.components``,
-   which consists of ``self`` prepended to the ``components`` tuple it
-   received.  ``self`` (``docutils.frontend.OptionParser``) defines
-   general Docutils settings.
-
-7. In ``self.populate_from_components``, for each component passed,
-   ``component.settings_spec`` is processed and
-   ``component.settings_defaults`` is applied.  Then, for each
-   component, ``component.settings_default_overrides`` is applied.
-   This two-loop process ensures that
-   ``component.settings_default_overrides`` can override the default
-   settings of any other component.
-
-8. Back in ``docutils.frontend.OptionParser.__init__``, the
-   ``defaults`` parameter (derived from the ``settings_overrides``
-   parameter of ``docutils.core.Publisher.publish``) is overlaid over
-   ``self.defaults``.  So ``settings_overrides`` has priority over all
-   ``SettingsSpec`` data.
-
-9. Next, ``docutils.frontend.OptionParser.__init__`` checks if
-   configuration files are enabled (its ``read_config_files``
-   parameter is true, and ``self.defaults'_disable_config'`` is
-   false).  If they are enabled (and normally, they are),
-   ``self.get_standard_config_settings`` is called.  This reads the
-   `docutils configuration files`_, and returns a dictionary of
-   settings.  This is then overlaid on ``self.defaults``.  So
-   configuration file settings have priority over all software-defined
-   defaults.
-
-10. Back in the ``docutils.core.Publisher`` object,
-    ``self.setup_option_parser`` returns the ``option_parser`` object
-    to its caller, ``self.process_command_line``.
-
-11. ``self.process_command_line`` calls ``option_parser.parse_args``,
-    which parses all command line options and returns a
-    ``docutils.frontend.Values`` object.  This is assigned to the
-    ``docutils.core.Publisher`` object's ``self.settings``.  So
-    command-line options have priority over configuration file
-    settings.
-
-    When ``option_parser.parse_args`` is called, the source and
-    destination command-line arguments are also parsed, and assigned
-    to the ``_source`` and ``_destination`` attributes of what becomes
-    the ``docutils.core.Publisher`` object's ``self.settings``.
-
-12. From ``docutils.core.Publisher.publish``, ``self.set_io`` is
-    called with no arguments.  If either ``self.source`` or
-    ``self.destination`` are not set, the corresponding
-    ``self.set_source`` and ``self.set_destination`` are called,
-    effectively with no arguments.
-
-13. ``self.set_source`` checks for a ``source_path`` parameter, and if
-    there is none (which is the case for command-line use), it is
-    taken from ``self.settings._source``.  ``self.source`` is set by
-    instantiating a ``self.source_class`` object.  For command-line
-    front-end tools, the default ``self.source_class`` is used,
-    ``docutils.io.FileInput``.
-
-14. ``self.set_destination`` does the same job for the destination
-    that ``self.set_source`` does for the source (the default
-    ``self.destination_class`` is ``docutils.io.FileOutput``).
-
-.. _Docutils Configuration Files: ../user/config.html
-
-
-Runtime Settings Processing From Applications
-=============================================
-
-Applications process runtime settings in a different way than
-`command-line tools`_ do.  Instead of calling ``publish_cmdline``, the
-application calls one of ``publish_file``, ``publish_string``, or
-``publish_parts``.  These in turn call ``publish_programmatically``,
-which implements a generic programmatic interface.  Although an
-application may also call ``publish_programmatically`` directly, it is
-not recommended (if it does seem to be necessary, please write to the
-Docutils-develop_ mailing list).
-
-``publish_programmatically`` accepts the same `convenience function
-parameters`_ as ``publish_cmdline``.  Where things differ is that
-programmatic use does no command-line processing.  Instead of calling
-``docutils.Publisher.process_command_line`` (as ``publish_cmdline``
-does, via ``docutils.Publisher.publish``),
-``docutils.Publisher.process_programmatic_settings`` is called to set
-up the runtime settings.
-
-.. copy & modify the list from command-line tools?
-
-
-.. _Docutils-develop: ../user/mailing-lists.html#docutils-develop
+
+Settings priority
+=================
+
+The sources are overlaid in the following order (later sources
+overwrite earlier ones):
+
+1. Defaults specified in the `settings_spec`__ and
+   `settings_defaults`__ attributes for each component_.
+
+   __ SettingsSpec.settings_spec_
+   __ SettingsSpec.settings_defaults_
+
+2. Defaults specified in the `settings_default_overrides`__ attribute
+   for each component_.
+
+   __ SettingsSpec.settings_default_overrides_
+
+3. Settings specified in the `settings_overrides`__ parameter of the
+   `convenience functions`_ resp. the `settings_overrides` attribute of
+   a `Publisher`_ instance.
+
+   __ `settings_overrides parameter`_
+
+4. Settings specified in `active sections`_ of the `configuration files`_
+   in the order described in `Configuration File Sections & Entries`_
+   (if enabled).
+
+5. Command line options (if enabled).
+
+For details see the ``docutils/__init__.py``, ``docutils/core.py``, and
+``docutils.frontend.py`` modules and the implementation description in
+`Runtime Settings Processing`_.
+
+
+.. _SettingsSpec:
+
+SettingsSpec base class
+=======================
+
+.. note::
+   Implementation details will change with the move to replace the
+   deprecated optparse_ module with argparse_.
+
+The `docutils.SettingsSpec` base class is inherited by Docutils
+components_ and `frontend.OptionParser`.
+It defines the following six **attributes**:
+
+.. _SettingsSpec.settings_spec:
+
+`settings_spec`
+   a sequence of
+
+   1. option group title (string or None)
+
+   2. description (string or None)
+
+   3. option tuples with
+
+      a) help text
+      b) options string(s)
+      c) dictionary with keyword arguments for `OptionParser.add_option()`_
+         and an optional "validator", a `frontend.validate_*()` function
+         that processes the values (e.g. convert to other data types).
+
+   For examples, see the source of ``frontend.OptionParser.settings_spec``
+   or the `settings_spec` attributes of the Docutils components_.
+
+   .. _SettingsSpec.settings_defaults:
+
+`settings_defaults`
+   for purely programmatic settings
+   (not accessible from command line and configuration files).
+
+   .. _SettingsSpec.settings_default_overrides:
+
+`settings_default_overrides`
+   to override defaults for settings
+   defined in other components' `setting_specs`.
+
+`relative_path_settings`
+   listing settings containing filesystem paths.
+
+   .. _active sections:
+
+`config_section`
+   the configuration file section specific to this
+   component.
+
+`config_section_dependencies`
+   lists configuration files sections
+   that should also be read (before the `config_section`).
+
+The last two attributes define which configuration file sections are
+"active". See also `Configuration File Sections & Entries`_.
+
+
+Glossary
+========
+
+.. _component:
+
+components
+----------
+
+Docutils front-ends and applications combine a selection of
+*components* of the `Docutils Project Model`_.
+
+All components inherit the `SettingsSpec`_ base class.
+This means that all instances of ``readers.Reader``, ``parsers.Parser``, and
+``writers.Writer`` are also instances of ``docutils.SettingsSpec``.
+
+For the determination of runtime settings, ``frontend.OptionParser`` and
+the `settings_spec parameter`_ in application settings specifications
+are treated as components as well.
+
+
+.. _convenience function:
+
+convenience functions
+---------------------
+
+Applications usually deploy Docutils by one of the
+`Publisher convenience functions`_.
+
+All convenience functions accept the following optional parameters:
+
+.. _settings parameter:
+
+`settings`
+  a ``frontend.Values`` instance.
+  If present, it must be complete.
+
+  No further runtime settings processing is done and the
+  following parameters have no effect.
+
+  .. _settings_spec parameter:
+
+`settings_spec`
+  a `SettingsSpec`_ subclass or instance containing the settings
+  specification for the "Application" itself.
+  The instance is added to the components_ (after the generic
+  settings, parser, reader, and writer).
+
+  .. _settings_overrides parameter:
+
+`settings_overrides`
+  a dictionary which is used to update the
+  defaults of the components' settings specifications.
+
+  .. _config_section parameter:
+
+`config_section`
+  the name of an application-specific
+  `configuration file section`_ for this application.
+
+  Can be specified instead of a `settings_spec` (a new SettingsSpec_
+  instance that just defines a configuration section will be created)
+  or in addition to a `settings_spec`
+  (overriding its `config_section` attribute).
+
+
+settings_spec
+-------------
+
+The name ``settings_spec`` may refer to
+
+a) an instance of the SettingsSpec_ class, or
+b) the data structure `SettingsSpec.settings_spec`_ which is used to
+   store settings details.
+
+
+.. References:
+
+.. _Publisher: publisher.html
+.. _Publisher convenience functions:
+    publisher.html#publisher-convenience-functions
+.. _front-end tools: ../user/tools.html
+.. _configuration files:
+.. _Docutils Configuration: ../user/config.html#configuration-files
+.. _configuration file section:
+.. _Configuration File Sections & Entries:
+    ../user/config.html#configuration-file-sections-entries
+.. _Docutils Project Model: ../peps/pep-0258.html#docutils-project-model
+.. _Reader: ../peps/pep-0258.html#reader
+.. _Runtime Settings Processing: ../dev/runtime-settings-processing.html
+
+.. _optparse: https://docs.python.org/dev/library/optparse.html
+.. _argparse: https://docs.python.org/dev/library/argparse.html
+.. _OptionParser.add_option():
+    https://docs.python.org/dev/library/optparse.html
+    #optparse.OptionParser.add_option

_service:tar_scm:docutils-0.20.tar.gz/docs/api/transforms.txt Added

@@ -0,0 +1,209 @@
+.. include:: ../header.txt
+
+=====================
+ Docutils Transforms
+=====================
+
+:Author: David Goodger
+:Contact: docutils-develop@lists.sourceforge.net
+:Revision: $Revision: 9259 $
+:Date: $Date: 2022-11-21 21:51:23 +0100 (Mo, 21. Nov 2022) $
+:Copyright: This document has been placed in the public domain.
+
+
+.. contents::
+
+Transforms change the document tree in-place, add to the tree, or prune it.
+Transforms resolve references and footnote numbers, process interpreted
+text, and do other context-sensitive processing. Each transform is a
+subclass of ``docutils.transforms.Transform``.
+
+There are `transforms added by components`_, others (e.g.
+``parts.Contents``) are added by the parser, if a corresponding directive is
+found in the document.
+
+To add a transform, components (objects inheriting from
+Docutils.Component like Readers, Parsers, Writers, Input, Output) overwrite
+the ``get_transforms()`` method of their base class. After the Reader has
+finished processing, the Publisher calls
+``Transformer.populate_from_components()`` with a list of components and all
+transforms returned by the component's ``get_transforms()`` method are
+stored in a `transformer object` attached to the document tree.
+
+
+For more about transforms and the Transformer object, see also `PEP
+258`_. (The ``default_transforms()`` attribute of component classes mentioned
+there is deprecated. Use the ``get_transforms()`` method instead.)
+
+.. _PEP 258: ../peps/pep-0258.html#transformer
+
+
+Transforms Listed in Priority Order
+===================================
+
+Transform classes each have a default_priority attribute which is used by
+the Transformer to apply transforms in order (low to high). The default
+priority can be overridden when adding transforms to the Transformer object.
+
+
+==============================  ============================  ========
+Transform: module.Class         Added By                      Priority
+==============================  ============================  ========
+misc.class                      "class" (d/p)                 210
+
+references.Substitutions        standalone (r), pep (r)       220
+
+references.PropagateTargets     standalone (r), pep (r)       260
+
+frontmatter.DocTitle            standalone (r)                320
+
+frontmatter.DocInfo             standalone (r)                340
+
+frontmatter.SectSubTitle        standalone (r)                350
+
+peps.Headers                    pep (r)                       360
+
+peps.Contents                   pep (r)                       380
+
+universal.StripClasses...       Writer (w)                    420
+
+references.AnonymousHyperlinks  standalone (r), pep (r)       440
+
+references.IndirectHyperlinks   standalone (r), pep (r)       460
+
+peps.TargetNotes                pep (r)                       520
+
+references.TargetNotes          peps.TargetNotes (t/p)        0
+
+misc.CallBack                   peps.TargetNotes (t/p)        1
+
+references.TargetNotes          "target-notes" (d/p)          540
+
+references.Footnotes            standalone (r), pep (r)       620
+
+references.ExternalTargets      standalone (r), pep (r)       640
+
+references.InternalTargets      standalone (r), pep (r)       660
+
+parts.SectNum                   "sectnum" (d/p)               710
+
+parts.Contents                  "contents" (d/p),             720
+                                peps.Contents (t/p)
+
+universal.StripComments         Reader (r)                    740
+
+peps.PEPZero                    peps.Headers (t/p)            760
+
+components.Filter               *not used*                    780
+
+universal.Decorations           Reader (r)                    820
+
+misc.Transitions                standalone (r), pep (r)       830
+
+universal.ExposeInternals       Reader (r)                    840
+
+references.DanglingReferences   standalone (r), pep (r)       850
+
+universal.SmartQuotes           Parser                        855
+
+universal.Messages              Writer (w)                    860
+
+universal.FilterMessages        Writer (w)                    870
+
+universal.TestMessages          DocutilsTestSupport           880
+
+writer_aux.Compound             *not used, to be removed*     910
+
+writer_aux.Admonitions          _html_base (w),               920
+                                latex2e (w)
+
+misc.CallBack                   n/a                           990
+==============================  ============================  ========
+
+Key:
+
+* (r): Reader
+* (w): Writer
+* (d): Directive
+* (t): Transform
+* (/p): Via a "pending" node
+
+
+Transform Priority Range Categories
+===================================
+
+====  ====  ================================================
+ Priority
+----------  ------------------------------------------------
+From   To   Category
+====  ====  ================================================
+   0    99  immediate execution (added by another transform)
+ 100   199  very early (non-standard)
+ 200   299  very early
+ 300   399  early
+ 400   699  main
+ 700   799  late
+ 800   899  very late
+ 900   999  very late (non-standard)
+====  ====  ================================================
+
+
+Transforms added by components
+===============================
+
+
+readers.Reader:
+  | universal.Decorations,
+  | universal.ExposeInternals,
+  | universal.StripComments
+
+readers.ReReader:
+  None
+
+readers.standalone.Reader:
+  | references.Substitutions,
+  | references.PropagateTargets,
+  | frontmatter.DocTitle,
+  | frontmatter.SectionSubTitle,
+  | frontmatter.DocInfo,
+  | references.AnonymousHyperlinks,
+  | references.IndirectHyperlinks,
+  | references.Footnotes,
+  | references.ExternalTargets,
+  | references.InternalTargets,
+  | references.DanglingReferences,
+  | misc.Transitions
+
+readers.pep.Reader:
+  | references.Substitutions,
+  | references.PropagateTargets,
+  | references.AnonymousHyperlinks,
+  | references.IndirectHyperlinks,
+  | references.Footnotes,
+  | references.ExternalTargets,
+  | references.InternalTargets,
+  | references.DanglingReferences,
+  | misc.Transitions,
+  | peps.Headers,
+  | peps.Contents,
+  | peps.TargetNotes
+
+parsers.rst.Parser
+  universal.SmartQuotes
+
+writers.Writer:
+  | universal.Messages,
+  | universal.FilterMessages,
+  | universal.StripClassesAndElements
+
+writers.UnfilteredWriter
+  None
+
+writers.latex2e.Writer
+  writer_aux.Admonitions
+
+writers._html_base.Writer:
+  writer_aux.Admonitions
+
+writers.odf_odt.Writer:
+  removes references.DanglingReferences

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/.release.txt.swp -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/.release.txt.swp Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/distributing.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/distributing.txt Changed

@@ -1,14 +1,16 @@
+.. include:: ../header.txt
+
 ===============================
  Docutils_ Distributor's Guide
 ===============================
 
 :Author: Lea Wiemann
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8631 $
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 .. contents::
 
@@ -20,7 +22,7 @@
 it.
 
 .. _Docutils-develop: ../user/mailing-lists.html#docutils-develop
-.. _release tarball: http://docutils.sourceforge.net/#download
+.. _release tarball: https://docutils.sourceforge.io/#download
 
 
 Dependencies
@@ -28,12 +30,12 @@
 
 Docutils has the following dependencies:
 
-* Python 2.7 or later is required.  Use ">= Python 2.7" in the
-  dependencies.
+* Python 3.7 or later is required.
+  Use ">= Python 3.7" in the dependencies.
 
 * 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
@@ -43,10 +45,10 @@
 * Docutils can use the `recommonmark`_ parser to parse input in
   the Markdown format (new in 0.17).
 
-.. _Python Imaging Library: 
+.. _Python Imaging Library:
     https://en.wikipedia.org/wiki/Python_Imaging_Library
 .. _Pillow: https://pypi.org/project/Pillow/
-.. _Pygments: http://pygments.org/
+.. _Pygments: https://pygments.org/
 .. _recommonmark: https://pypi.org/project/recommonmark/
 
 .. _code directives: ../ref/rst/directives.html#code
@@ -146,4 +148,4 @@
 
 For more information on testing, view the `Docutils Testing`_ page.
 
-.. _Docutils Testing: http://docutils.sourceforge.net/docs/dev/testing.html
+.. _Docutils Testing: https://docutils.sourceforge.io/docs/dev/testing.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/enthought-plan.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/enthought-plan.txt Changed

@@ -4,12 +4,12 @@
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
-:Revision: $Revision: 7302 $
+:Date: $Date: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $
+:Revision: $Revision: 8956 $
 :Copyright: 2004 by `Enthought, Inc. <http://www.enthought.com>`_
 :License: `Enthought License`_ (BSD-style)
 
-.. _Enthought License: http://docutils.sf.net/licenses/enthought.txt
+.. _Enthought License: https://docutils.sourceforge.io/licenses/enthought.txt
 
 This document should be read in conjunction with the `Enthought API
 Documentation Tool RFP`__ prepared by Janet Swisher.
@@ -55,7 +55,7 @@
 All that's left now is to actually do the work!
 
 .. _PyCon 2004: http://pycon.org/dc2004/
-.. _reStructuredText: http://docutils.sf.net/rst.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _SciPy: http://www.scipy.org/
 
 
@@ -72,7 +72,7 @@
    .. _Epydoc: http://epydoc.sourceforge.net/
    .. _HappyDoc: http://happydoc.sourceforge.net/
    .. _PEP 258:
-      http://docutils.sf.net/docs/peps/pep-0258.html#python-source-reader
+      https://docutils.sourceforge.io/docs/peps/pep-0258.html#python-source-reader
 
 2. Decide on a base platform.  The best way to achieve Enthought's
    goals in a reasonable time frame may be to extend Epydoc or
@@ -118,7 +118,7 @@
 This is in conjunction with the "Public Domain Dedication" section of
 COPYING.txt__.
 
-__ http://docutils.sourceforge.net/COPYING.html
+__ https://docutils.sourceforge.io/COPYING.html
 
 The code and documentation originating from Enthought funding will
 have Enthought's copyright and license declaration.  While I will try
@@ -156,7 +156,7 @@
 If another project is chosen as the base project, similar changes
 would be made to their files, subject to negotiation.
 
-__ http://docutils.sf.net/COPYING.html
+__ https://docutils.sourceforge.io/COPYING.html
 
 
 Proposed Changes to reStructuredText

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/enthought-rfp.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/enthought-rfp.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/hacking.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/hacking.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ==========================
  Docutils_ Hacker's Guide
 ==========================
 
 :Author: Lea Wiemann
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9255 $
+:Date: $Date: 2022-11-18 14:49:33 +0100 (Fr, 18. Nov 2022) $
 :Copyright: This document has been placed in the public domain.
 
 :Abstract: This is the introduction to Docutils for all persons who
@@ -15,8 +17,8 @@
     knowledge is certainly helpful (though not necessary, strictly
     speaking).
 
-.. _Docutils: http://docutils.sourceforge.net/
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _Docutils: https://docutils.sourceforge.io/
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _Docutils front-end tools: ../user/tools.html
 
 .. contents::
@@ -32,7 +34,7 @@
 
     My *favorite* language is Python_.
 
-    .. _Python: http://www.python.org/
+    .. _Python: https://www.python.org/
 
 Using the ``rst2html.py`` front-end tool, you would get an HTML output
 which looks like this::
@@ -40,7 +42,7 @@
     uninteresting HTML code removed
     <body>
     <div class="document">
-    <p>My <em>favorite</em> language is <a class="reference" href="http://www.python.org/">Python</a>.</p>
+    <p>My <em>favorite</em> language is <a class="reference" href="https://www.python.org/">Python</a>.</p>
     </div>
     </body>
     </html>
@@ -68,13 +70,20 @@
 
 The **Parser** analyzes the the input document and creates a **node
 tree** representation.  In this case we are using the
-**reStructuredText parser** (``docutils/parsers/rst/__init__.py``).
-To see what that node tree looks like, we call ``quicktest.py`` (which
-can be found in the ``tools/`` directory of the Docutils distribution)
-with our example file (``test.txt``) as first parameter (Windows users
-might need to type ``python quicktest.py test.txt``)::
+**reStructuredText parser**:
+
+.. code:: python
+
+    from docutils import frontend, utils
+    from docutils.parsers.rst import Parser
+    settings = frontend.get_default_settings(Parser)
+    with open('test.txt', encoding='utf-8') as file:
+        document = utils.new_document(file.name, settings)
+        Parser().parse(file.read(), document)
+
+Let us now examine the node tree.
+With ``print(document.pformat())`` we get::
 
-    $ quicktest.py test.txt
     <document source="test.txt">
         <paragraph>
             My
@@ -84,9 +93,7 @@
             <reference name="Python" refname="python">
                 Python
             .
-        <target ids="python" names="python" refuri="http://www.python.org/">
-
-Let us now examine the node tree:
+        <target ids="python" names="python" refuri="https://www.python.org/">
 
 The top-level node is ``document``.  It has a ``source`` attribute
 whose value is ``text.txt``.  There are two children: A ``paragraph``
@@ -101,12 +108,19 @@
 overview of the node class hierarchy, use epydoc (type ``epydoc
 nodes.py``) and look at the class hierarchy tree.
 
+.. tip:: While rst2pseudoxml_ shows the node tree after `transforming the
+   document`_, the script quicktest.py_ (in the ``tools/dev/`` directory
+   of the Docutils distribution) shows the direct result of parsing a
+   reStructuredText sample.
+
+.. _quicktest.py: https://docutils.sourceforge.io/tools/dev/quicktest.py
+
 
 Transforming the Document
 -------------------------
 
 In the node tree above, the ``reference`` node does not contain the
-target URI (``http://www.python.org/``) yet.
+target URI (``https://www.python.org/``) yet.
 
 Assigning the target URI (from the ``target`` node) to the
 ``reference`` node is *not* done by the parser (the parser only
@@ -116,15 +130,9 @@
 reference), it's done by the ``ExternalTargets`` transform in
 ``docutils/transforms/references.py``.
 
-In fact, there are quite a lot of Transforms, which do various useful
-things like creating the table of contents, applying substitution
-references or resolving auto-numbered footnotes.
-
 The Transforms are applied after parsing.  To see how the node tree
 has changed after applying the Transforms, we use the
-``rst2pseudoxml.py`` tool:
-
-.. parsed-literal::
+rst2pseudoxml_ tool #_::
 
     $ rst2pseudoxml.py test.txt
     <document source="test.txt">
@@ -133,10 +141,10 @@
             <emphasis>
                 favorite
              language is
-            <reference name="Python" **refuri="http://www.python.org/"**>
+            <reference name="Python" **refuri="https://www.python.org/"**>
                 Python
             .
-        <target ids="python" names="python" ``refuri="http://www.python.org/"``>
+        <target ids="python" names="python" ``refuri="https://www.python.org/"``>
 
 For our small test document, the only change is that the ``refname``
 attribute of the reference has been replaced by a ``refuri``
@@ -144,9 +152,17 @@
 
 While this does not look very exciting, transforms are a powerful tool
 to apply any kind of transformation on the node tree.
+In fact, there are quite a lot of Transforms, which do various useful
+things like creating the table of contents, applying substitution
+references or resolving auto-numbered footnotes. For details, see
+`Docutils Transforms`_.
+
+.. # You can also get a standard XML representation of the
+       node tree by using rst2xml_ instead of rst2pseudoxml_.
 
-By the way, you can also get a "real" XML representation of the node
-tree by using ``rst2xml.py`` instead of ``rst2pseudoxml.py``.
+.. _Docutils Transforms: ../api/transforms.html
+.. _rst2pseudoxml: ../user/tools.html#rst2pseudoxml
+.. _rst2xml: ../user/tools.html#rst2xml
 
 
 Writing the Document
@@ -160,17 +176,17 @@
 
     $ rst2html.py --link-stylesheet test.txt
     <?xml version="1.0" encoding="utf-8" ?>
-    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+    <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
     <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" />
+    <meta name="generator" content="Docutils 0.3.10: https://docutils.sourceforge.io/" />
     <title></title>
     <link rel="stylesheet" href="../docutils/writers/html4css1/html4css1.css" type="text/css" />
     </head>
     <body>
     <div class="document">
-    <p>My <em>favorite</em> language is <a class="reference" href="http://www.python.org/">Python</a>.</p>
+    <p>My <em>favorite</em> language is <a class="reference" href="https://www.python.org/">Python</a>.</p>
     </div>
     </body>
     </html>
@@ -247,10 +263,8 @@
 first, we are awaiting *your* feedback.  So please ask your questions
 on the Docutils-develop_ mailing list.
 
-
 .. _Docutils-develop: ../user/mailing-lists.html#docutils-develop
 
-
 .. |---| unicode:: 8212 .. em-dash
    :trim:

_service:tar_scm:docutils-0.20.tar.gz/docs/dev/packaging.txt Added

@@ -0,0 +1,50 @@
+=======================
+ Modernising Packaging
+=======================
+
+:Date: 2022-01-03
+
+Proposal
+========
+
+Adam Turner proposed `patch#186`_ on *Modernise packaging*
+
+  I had a go at modernising the packaging stack. setup.py based invocations
+  have been deprecated
+  (https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html), and
+  setuptools may remove them in the future.
+
+  This takes the opportunity to move to a PEP 621 based declarative config, and
+  also fixes a longstanding TODO item about providing script wappers for the
+  frontend tools on windows, by migrating them to entry points.
+
+  I've updated install and development docs with the new guidance, and updated
+  references to the frontend tools to remove .py, given they are now installed
+  as proper scripts.
+
+Patch commit summary from Adam's `pull request#1`_ ::
+
+    4a7ba6f Use flit and pyproject.toml
+    9e2f8bb Add `docutils-cli` entry point
+    84cf997 Use entry points for `rst*` tools
+    2986a9f Update docs for packaging changes
+    cdb96cd Deprecate `rst*` entry points in favour of `docutils-cli`
+    0535577 Update documentation to focus on `docutils-cli`
+
+Analysis
+========
+
+Use flit and pyproject.toml
+---------------------------
+
+Removes MANIFEST.in, install.py, setup.py and setup.cfg and adds pyproject.toml.
+
+Building of source and wheel distributions is then done with build or flit.
+flit can also replace twine for upload to pypi.
+
+Question: Who is using source distributions and relies on setup.py ?
+
+.. _patch#186: https://sourceforge.net/p/docutils/patches/186/
+.. _pull request#1: https://github.com/AA-Turner/docutils/pull/1/commits
+.. _using manifets in: https://packaging.python.org/en/latest/guides/using-manifest-in/
+

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/policies.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/policies.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ===========================
  Docutils Project Policies
 ===========================
 
 :Author: David Goodger; open to all Docutils developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-04-12 23:06:42 +0200 (Mo, 12. Apr 2021) $
-:Revision: $Revision: 8689 $
+:Date: $Date: 2023-01-10 09:58:28 +0100 (Di, 10. Jän 2023) $
+:Revision: $Revision: 9313 $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -48,67 +50,6 @@
    http://www.catb.org/~esr/writings/magic-cauldron/
 
 
-How to get a new feature into Docutils
-========================================
-
-Question:
-   I would very much like to have this new feature in the Docutils core.
-   What exactly do I have to do to make this possible?
-
-* Present your idea at the Docutils-develop_ mailing list,
-
-  +1  usually triggers a fast response,
-  -1  may be forgotten later,
-
-  and/or file a ticket at Docutils' `feature request tracker`_.
-
-  +1  there is a permanent record,
-  -1  it may stay forgotten among all the other feature requests.
-
-* Convince a Docutils developer that this is a valuable addition worth the
-  effort.
-
-* Contribute. The developers will make sure that the contribution fits
-  nicely into Docutils (cf. the `review criteria`_). This might involve
-  discussing (and compromising on) design and implementation details. It
-  might also lead to the conclusion that the addition fits better in the
-  `extensions and related projects`_.
-
-* Be patient, and be persistent.  None of us are paid to do this,
-  it's all in our spare time -- which is precious and rare.
-
-How to make code contributions that are easily accepted:
-
-* Have a look at the `Python coding conventions`_ and `documentation
-  conventions`_ below.
-
-* **Prepare test cases.** This vastly helps when integrating new code. Test
-  cases are also examples and showcases for new features. See `Docutils
-  Testing`_ for a description of the test suite in ``docutils/test/``.
-
-  Ensure the addition works with all `supported Python versions`__.
-
-  __ ../../README.html#requirements
-
-* Look at the Docutils sources to see how similar features are implemented,
-  learn to do it "the Docutils way".
-
-* Prepare a patch or an addition to the existing documentation.
-  Include links.
-
-* If you are familiar with version control, consider creating a `feature
-  branch`_ in a Docutils repository_ checkout. (Working with branches is
-  *much* easier with git_. You can get a git clone of the repository from
-  http://repo.or.cz/w/docutils.git or with git-svn.)
-
-.. _docutils-develop: ../user/mailing-lists.html#docutils-develop
-.. _feature request tracker:
-   http://sourceforge.net/p/docutils/feature-requests/
-
-.. _git: http://git-scm.com/
-.. _Docutils testing: testing.html
-
-
 Python Coding Conventions
 =========================
 
@@ -119,13 +60,13 @@
 conform to these conventions.
 
 The Docutils project shall follow the generic coding conventions as
-specified in the `Style Guide for Python Code`_ and `Docstring
-Conventions`_ PEPs, summarized, clarified, and extended as follows:
+specified in the `Style Guide for Python Code` (:PEP:`8`) and `Docstring
+Conventions` (:PEP:`257`), summarized, clarified, and extended as follows:
 
 * 4 spaces per indentation level.  No hard tabs.
 
-* Use only 7-bit ASCII, no 8-bit strings.  See `Docutils
-  Internationalization`_.
+* Use UTF-8 encoding (no encoding declaration).
+  Identifiers must use ASCII only.
 
 * No one-liner compound statements (i.e., no ``if x: return``: use two
   lines & indentation), except for degenerate class or method
@@ -158,9 +99,6 @@
 * Use 'single quotes' for string literals, and """triple double
   quotes""" for docstrings.
 
-.. _Style Guide for Python Code:
-   http://www.python.org/peps/pep-0008.html
-.. _Docstring Conventions: http://www.python.org/peps/pep-0257.html
 .. _Docutils Internationalization: ../howto/i18n.html#python-code
 
 
@@ -169,8 +107,7 @@
 
 * Docutils documentation is written using reStructuredText, of course.
 
-* Use 7-bit ASCII if at all possible, and Unicode substitutions when
-  necessary.
+* The encoding of the documentation files is UTF-8.
 
 * Use the following section title adornment styles::
 
@@ -208,7 +145,9 @@
 ========================
 
 The majority of the Docutils project code and documentation has been
-placed in the public domain.  Unless clearly and explicitly indicated
+placed in the public domain (see `Copying Docutils`_).
+
+Unless clearly and explicitly indicated
 otherwise, any patches (modifications to existing files) submitted to
 the project for inclusion (via Subversion, SourceForge trackers,
 mailing lists, or private email) are assumed to be in the public
@@ -227,35 +166,15 @@
   The license should be well known, simple and compatible with other
   open source software licenses. To keep the number of different
   licenses at a minimum, using the `2-Clause BSD license`_
-  is recommended.
-
-2-Clause BSD license
---------------------
-
-(also known as "Simplified" or `FreeBSD license`)
-
-  If you want a simple, permissive non-copyleft free software license, the
-  FreeBSD license is a reasonable choice. However, please don't call it a
-  “BSD” or “BSD-style” license, because that is likely to cause confusion
-  which could lead to use of the flawed original BSD license.
+  (`local copy`__) is recommended.
 
-  -- `Various Licenses and Comments about Them`_
+  .. Rationale:
+     + clear wording, structured text
+     + license used by the closely related Sphinx project
 
-Pros:
-  * clear wording, structured text
-  * license used by the closely related Sphinx project
-  * "2-Clause BSD license" is a non-ambiguous name, used by both, OSI and
-    GNU.
-
-References:
-  * https://www.freebsd.org/copyright/freebsd-license.html
-  * https://opensource.org/licenses/BSD-2-Clause
-  * https://spdx.org/licenses/BSD-2-Clause.html
-
-.. _Various Licenses and Comments about Them:
-   https://www.gnu.org/licenses/license-list.html
-.. _OSI Approved Licenses: https://www.opensource.org/licenses/category
-.. _SPDX Open Source License Registry: https://www.spdx.org/licenses/
+.. _Copying Docutils: ../../COPYING.html
+.. _2-Clause BSD license: http://opensource.org/licenses/BSD-2-Clause
+__ ../../licenses/BSD-2-Clause.txt
 
 
 .. _Subversion Repository:
@@ -304,12 +223,12 @@
 
 Feature additions and API changes will be done in **feature
 branches**.  Feature branches will not be managed in any way.
-Frequent small checkins are encouraged here.  Feature branches must be
+Frequent small check-ins are encouraged here.  Feature branches must be
 discussed on the `docutils-develop mailing list`_ and reviewed before
 being merged into the core.
 
 .. _docutils-develop mailing list:
-   http://lists.sourceforge.net/lists/listinfo/docutils-develop
+   https://lists.sourceforge.net/lists/listinfo/docutils-develop
 
 
 Review Criteria
@@ -336,6 +255,8 @@
 & brains sees the code before it enters the core.  In addition to the
 above, the general `Check-ins`_ policy (below) also applies.
 
+.. _Docutils testing: testing.html
+
 
 Check-ins
 ---------
@@ -348,7 +269,8 @@
 branches should always be kept in a stable state (usable and as
 problem-free as possible).  All changes to the Docutils core or
 maintenance branches must be in `good shape`_, usable_, documented_,
-tested_, and `reasonably complete`_.
+tested_, and `reasonably complete`_. Starting with version 1.0, they must
+also comply with the `backwards compatibility policy`_.
 
 * _`Good shape` means that the code is clean, readable, and free of
   junk code (unused legacy code; by analogy to "junk DNA").
@@ -429,8 +351,8 @@
     major number will be bumped to 1 when the project is
     feature-complete, and may be incremented later if there is a major
     change in the design or API.  When Docutils reaches version 1.0,
-    the major APIs will be considered frozen and backward
-    compatibility will become of paramount importance.
+    the major APIs will be considered frozen.
+    For details, see the `backwards compatibility policy`_.
 
 minor : non-negative integer
     Releases that change the minor number (x.y, e.g. 0.5) will be
@@ -536,7 +458,7 @@
 .. #dev Default active development state between releases.
 .. #skip These steps may be skipped.
 
-.. _PEP 440: https://www.python.org/dev/peps/pep-0440/
+.. _PEP 440: https://peps.python.org/pep-0440/
 
 Policy History
 --------------
@@ -557,6 +479,43 @@
   __ https://sourceforge.net/p/docutils/mailman/message/35903816/
 
 
+Backwards Compatibility Policy
+==============================
+
+.. note:: The backwards compatibility policy outlined below is a stub.
+
+Docutils' backwards compatibility policy follows the rules for Python in
+:PEP:`387`.
+
+* The scope of the public API is laid out at the start of the `backwards
+  compatibility rules`_.
+
+* The rules for `making incompatible changes`_ apply.
+
+A majority of projects depends on Docutils indirectly, via the Sphinx_
+document processor.
+
+* Sphinx developers should be given the chance to fix or work around a
+  DeprecationWarning_ in the Sphinx development version before a new
+  Docutils version is released. Otherwise, use a PendingDeprecationWarning_.
+
+Changes that may affect end-users (e.g. by requiring changes to the
+configuration file or potentially breaking custom style sheets) should be
+announced with a FutureWarning_.
+
+.. _backwards compatibility rules:
+   https://peps.python.org/pep-0387/#backwards-compatibility-rules
+.. _making incompatible changes:
+   https://peps.python.org/pep-0387/#making-incompatible-changes
+.. _Sphinx: https://www.sphinx-doc.org/
+.. _DeprecationWarning:
+   https://docs.python.org/3/library/exceptions.html#DeprecationWarning
+.. _PendingDeprecationWarning:
+   https://docs.python.org/3/library/exceptions.html#PendingDeprecationWarning
+.. _FutureWarning:
+   https://docs.python.org/3/library/exceptions.html#FutureWarning
+
+
 Snapshots
 =========
 
@@ -573,100 +532,29 @@
 
    TODO: do we have active maintenance branches?
    (the only branch looking like a maintenance branch is
-   http://sourceforge.net/p/docutils/code/HEAD/tree/branches/docutils-0.4)
+   https://sourceforge.net/p/docutils/code/HEAD/tree/branches/docutils-0.4)
 
 * `development branches`_, representing ongoing development efforts to bring
   new features into Docutils.
 
 .. _Docutils core:
-   http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils
+   https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils
 .. _development branches:
-   http://sourceforge.net/p/docutils/code/HEAD/tree/branches/
+   https://sourceforge.net/p/docutils/code/HEAD/tree/branches/
 
 
 Setting Up For Docutils Development
 ===================================
 
-When making changes to the code, testing is a must.  The code should
+When making changes to the code, testing_ is a must.  The code should
 be run to verify that it produces the expected results, and the entire
 test suite should be run too.  The modified Docutils code has to be
-accessible to Python for the tests to have any meaning.  There are several
-ways to keep the Docutils code accessible during development:
-
-1. Update your ``PYTHONPATH`` environment variable so that Python
-   picks up your local working copy of the code.
-
-   We'll assume that the `Docutils trunk`__ is checked out under your
-   ``~/projects/`` directory.
-
-   For the bash shell, add this to your ``~/.profile``::
-
-       PYTHONPATH=$HOME/projects/docutils/docutils
-       export PYTHONPATH
-
-   The first line points to the directory containing the ``docutils``
-   package.  The second line exports this environment variable.
-
-   You many also want to add the ``tools`` directory to your binary ``PATH``::
-
-       PATH=$PATH:$HOME/projects/docutils/docutils/tools
-       export PATH
-
-   __ repository.html
-
-2. Create a symlink to the docutils package directory somewhere in the
-   module serach path (``sys.path``), e.g., ::
-
-     ln -s ~/projects/docutils/docutils \
-          /usr/local/lib/python2.7/site-packages/
-
-   Alternatively, use a `path configuration file`__.
+accessible to Python for the tests to have any meaning.
+See `editable installs`_ for ways to keep the Docutils code
+accessible during development.
 
-   __ https://docs.python.org/library/site.html
-
-   You may also want to copy or link the front-end tools in
-   ``docutils/tools`` to a suitable place in your binary PATH, e.g., ::
-
-     ln -s ~/projects/docutils/docutils/tools/rst2html.py \
-           /usr/local/bin/rst2html
-
-3. Do an `editable install`__ with pip.
-
-   __ https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs
-
-4. Install in `development mode`__ with setuptools.
-
-   __ https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
-
-5. Before you run anything, every time you make a change, reinstall
-   Docutils::
-
-       python setup.py install
-
-   .. CAUTION::
-
-      This method is **not** recommended for day-to-day development;
-      it's too easy to forget.  Confusion inevitably ensues.
-
-      If you install Docutils this way, Python will always pick up the
-      last-installed copy of the code.  If you ever forget to
-      reinstall the "docutils" package, Python won't see your latest
-      changes.
-
-A useful addition to the ``docutils`` top-level directory in branches
-and alternate copies of the code is a ``set-PATHS`` file
-containing the following lines::
-
-    # source this file
-    export PYTHONPATH=$PWD:$PWD
-    export PATH=$PWD/tools:$PATH
-
-Open a shell for this branch, ``cd`` to the ``docutils`` top-level
-directory, and "source" this file.  For example, using the bash
-shell::
-
-    $ cd some-branch/docutils
-    $ . set-PATHS
+.. _testing: tested_
+.. _editable installs: repository.html#editable-installs
 
 
 Mailing Lists
@@ -678,12 +566,12 @@
 .. _Docutils mailing lists: ../user/mailing-lists.html
 
 
-The Wiki
-========
+.. The Wiki
+   ========
+
+   The development wiki at http://docutils.python-hosting.com/
+   is no longer active.
 
-There is a development wiki at http://docutils.python-hosting.com/ as
-a scratchpad for transient notes.  Please use the repository for
-permament document storage.
 
 Extensions and Related Projects
 ===============================
@@ -734,9 +622,9 @@
 completed.  Others, such as add-ons to Docutils or applications of
 Docutils, may graduate to become `parallel projects`_.
 
-.. _sandbox README: http://docutils.sf.net/sandbox/README.html
+.. _sandbox README: https://docutils.sourceforge.io/sandbox/README.html
 .. _sandbox directory:
-   http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
+   https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/
 
 
 .. _parallel project:
@@ -752,7 +640,7 @@
 An official parallel project will have its own directory beside (or
 parallel to) the main ``docutils`` directory in the Subversion
 repository.  It can have its own web page in the
-docutils.sourceforge.net domain, its own file releases and
+docutils.sourceforge.io domain, its own file releases and
 downloadable snapshots, and even a mailing list if that proves useful.
 However, an official parallel project has implications: it is expected
 to be maintained and continue to work with changes to the core
@@ -783,8 +671,8 @@
 `link list`_. If you want your project to appear there, drop a note at
 the Docutils-develop_ mailing list.
 
-.. _link list: http://docutils.sourceforge.net/docs/user/links.html
-
+.. _link list: https://docutils.sourceforge.io/docs/user/links.html
+.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
 
 &#xc;
 ..

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/pysource.dtd -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/pysource.dtd Changed

@@ -4,8 +4,8 @@
 ======================================================================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 8956 $
+:Date: $Date: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $
 :Copyright: This DTD has been placed in the public domain.
 :Filename: pysource.dtd
 
@@ -13,9 +13,9 @@
 below).
 
 More information about this DTD and the Docutils project can be found
-at http://docutils.sourceforge.net/.  The latest version of this DTD
+at https://docutils.sourceforge.io/.  The latest version of this DTD
 is available from
-http://docutils.sourceforge.net/docs/dev/pysource.dtd.
+https://docutils.sourceforge.io/docs/dev/pysource.dtd.
 
 The formal public identifier for this DTD is::
 
@@ -46,7 +46,7 @@
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This DTD extends the Docutils Generic DTD, available from
-http://docutils.sourceforge.net/docs/ref/docutils.dtd.
+https://docutils.sourceforge.io/docs/ref/docutils.dtd.
 -->
 
 <!ENTITY % docutils PUBLIC

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/pysource.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/pysource.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../header.txt
+
 ======================
  Python Source Reader
 ======================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 This document explores issues around extracting and processing
@@ -54,7 +56,7 @@
 
 I've had trouble reconciling the roles of input parser and output
 writer with the idea of modes ("readers" or "directors").  Does the
-mode govern the tranformation of the input, the output, or both?
+mode govern the transformation of the input, the output, or both?
 Perhaps the mode should be split into two.
 
 For example, say the source of our input is a Python module.  Our
@@ -121,6 +123,7 @@
 .. _pysource.dtd: pysource.dtd
 .. _docutils.dtd: ../ref/docutils.dtd
 
+
 &#xc;
 ..
    Local Variables:

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/release.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/release.txt Changed

@@ -1,14 +1,16 @@
+.. include:: ../header.txt
+
 =============================
  Docutils_ Release Procedure
 =============================
 
 :Authors: David Goodger; Lea Wiemann; open to all Docutils developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-04-09 22:04:06 +0200 (Fr, 09. Apr 2021) $
-:Revision: $Revision: 8686 $
+:Date: $Date: 2022-12-01 22:13:16 +0100 (Do, 01. Dez 2022) $
+:Revision: $Revision: 9291 $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.io/
+.. _Docutils: https://docutils.sourceforge.io/
 
 Releasing (post 2020)
 ---------------------
@@ -23,43 +25,35 @@
 
 * Change HISTORY.txt title ``Changes Since <previous release>`` to ``Release <version>``.
 
-* Set new version with ``sandbox/infrastructure/set_version.sh <version>``
+* Set new version (replace ``<version>`` with the new version indentifier
+  and ``<docutils-repository-root>`` with the dir containing
+  ``HISTORY.txt`` and ``RELEASE-NOTES.txt``)::
+
+      cd <docutils-repository-root>
+      ../sandbox/infrastructure/set_version.sh <version>
 
-  Check what was changed with version control system by ``set_version.sh``
+  Check what was changed by ``set_version.sh``.
 
   Run tests ::
 
     export PYTHONWARNINGS=default
-    python2 test/alltests.py
     python3 test/alltests.py
 
   or use tox.
-    
+  In case of errors, clearing ``docutils/__pycache__`` may help.
+
   ``export PYTHONWARNINGS=default`` prints DeprecationWarnings in python3.
 
-* Generate universal wheel and source-distribution::
+* Generate wheel and source-distribution::
 
     python3 setup.py sdist
-    python3 setup.py bdist_wheel --universal
+    python3 setup.py bdist_wheel
 
-* Upload universal wheel and source to test.pypi::
+* Upload wheel and source to test.pypi::
 
     python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
-  Wait some minutes to test in virtualenv ::
-
-    python2 -m virtualenv du2 ; cd du2
-    export PYTHONPATH= ; . bin/activate
-
-    python -m pip install --index-url https://test.pypi.org/simple/ --no-deps docutils
-
-    cp -Lr ../docutils-code/docutils/test .
-    python test/alltests.py
-
-    python -m pip uninstall docutils
-    deactivate ; cd .. ; rm -r du2
-
-  Test in venv ::
+  Test in venv. NOTE use --pre for prereleases::
 
     python3 -m venv du3 ; cd du3
     export PYTHONPATH= ; . bin/activate
@@ -74,55 +68,61 @@
 
 * Commit changes ... the changed version number.
 
-* tag 0.## (Note: only directory docutils is copied)::
+* tag #.# (Note: only directory docutils is copied)::
 
     svn copy svn+ssh://grubert@svn.code.sf.net/p/docutils/code/trunk/docutils \
-             svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-0.## \
-             -m "tagging release 0.##"
+             svn+ssh://grubert@svn.code.sf.net/p/docutils/code/tags/docutils-#.# \
+             -m "tagging release #.#"
+
+* Update your source directory.
+* Rebuild wheel and source-distribution ::
+
+    python3 setup.py sdist
+    python3 setup.py bdist_wheel
 
 * Now upload to pypi::
 
-    python3 -m twine upload  dist/docutils-0.##*
+    python3 -m twine upload  dist/docutils-#.#*
 
-  and test::
+* Remove previous package from local cache::
 
-    python3 -m venv du3 ; cd du3
-    export PYTHONPATH= ; . bin/activate
+    find .cache/pip/wheels -name docutils\*whl -exec rm -v -i {} \;
 
-    pip install --no-deps docutils
-    cp -Lr ../docutils-code/docutils/test .
-    python test/alltests.py
+* and test::
 
-    python2 -m virtualenv du2 ; cd du2
+    python3 -m venv du3 ; cd du3
     export PYTHONPATH= ; . bin/activate
 
     pip install --no-deps docutils
     cp -Lr ../docutils-code/docutils/test .
     python test/alltests.py
 
+    deactivate ; cd .. ; rm -r du3
+
 * Notify to docutils-developer and user.
 
-* upload source and generated html to sf-htdocs/0.## ::
+* upload source and generated html to sf-htdocs/#.# ::
 
     mkdir tmp1
     cd tmp1
-    tar xzvf ../dist/docutils-0.##.tar.gz
-    cd docutils-0.##/
+    tar xzvf ../dist/docutils-#.#.tar.gz
+    cd docutils-#.#/
     tools/buildhtml.py .
-    find . -name \*.pyc -exec rm {} \;
-    rm -rf docutils.egg-info
-    rsync -e ssh -r -t ./ web.sourceforge.net:/home/project-web/docutils/htdocs/0.##
+    find . -name \*.pyc -exec rm -v {} \;
+    find . -name __pycache__ -exec rmdir -v {} \;
+    rm -r docutils.egg-info
+    rsync -e ssh -r -t ./ web.sourceforge.net:/home/project-web/docutils/htdocs/#.#
 
 * Check web/index.txt for necessary corrections.
 * Run sandbox/infrastructure/docutils-update.local to update web-content.
 * Release to sourceforge.
 
-  - Upload tar.gz and 0.16 release notes to sourceforge.
-  - Select docutils-0.16.tar.gz as default for all OS.  
+  - Upload docutils-#.#.tar.gz and release notes to sourceforge.
+  - Select docutils-#.#.tar.gz as default for all OS.
 
-* set_version 0.##+1b.dev
-* test with py2 and py3
-* docutils/HISTORY.txt: add title "Changes Since 0.##"
+* set_version #.{#+1}b.dev
+* test with py3
+* docutils/HISTORY.txt: add title "Changes Since #.#"
 * run sandbox/infrastructure/docutils-update.local
 
 &#xc;

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/repository.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/repository.txt Changed

@@ -1,56 +1,54 @@
+.. include:: ../header.txt
+
 =====================================
- The Docutils_ Subversion Repository
+ The Docutils_ Version Repository
 =====================================
 
-:Author: Lea Wiemann
+:Author: Lea Wiemann, Docutils developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8539 $
-:Date: $Date: 2020-08-13 16:34:37 +0200 (Do, 13. Aug 2020) $
+:Revision: $Revision: 9290 $
+:Date: $Date: 2022-12-01 22:12:57 +0100 (Do, 01. Dez 2022) $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 .. admonition:: Quick Instructions
 
    To get a checkout of the Docutils source tree (with the
-   sandboxes), type ::
+   sandboxes) with SVN_, type ::
+
+       svn checkout https://svn.code.sf.net/p/docutils/code/trunk docutils-code
 
-       svn checkout http://svn.code.sf.net/p/docutils/code/trunk docutils-code
+   Users of Git_ can clone a mirror of the docutils repository with ::
 
+      git clone git://repo.or.cz/docutils.git
 
    If you are going to commit changes to the repository, please read
    the **whole document**, especially the section "`Information for
    Developers`_"!
 
-.. important::
-   As of 2013-03-13 the subversion urls have changed.
-
-Docutils uses a Subversion_ repository located at
+Docutils uses a Subversion_ (SVN) repository located at
 ``docutils.svn.sourceforge.net``.
-Subversion is exhaustively documented in the `Subversion Book`_ (svnbook).
 
 While Unix and Mac OS X users will probably prefer the standard
 Subversion command line interface, Windows user may want to try
 TortoiseSVN_, a convenient explorer extension.  The instructions apply
 analogously.
 
-There is a git_ mirror at http://repo.or.cz/docutils.git providing
-`web access`_ and the base for `creating a local git clone`_.
-
-and docutils trunk is cloned hourly to github :
-
-  https://github.com/live-clones/docutils/tree/master/docutils
+There is a Git_ mirror at http://repo.or.cz/docutils.git providing
+`web access`_ and the base for `creating a local Git clone`_.
+#github-mirrors_
 
 For the project policy on repository use (check-in requirements,
 branching, etc.), please see the `Docutils Project Policies`__.
 
 __ policies.html#subversion-repository
 
-.. _Subversion: http://subversion.tigris.org/
-.. _Subversion Book: http://svnbook.red-bean.com/
-.. _TortoiseSVN: http://tortoisesvn.tigris.org/
-.. _SourceForge.net: http://sourceforge.net/
-.. _git: http://git-scm.com/
+.. _SVN:
+.. _Subversion: https://subversion.apache.org/
+.. _TortoiseSVN: https://tortoisesvn.net/
+.. _SourceForge.net: https://sourceforge.net/
+.. _Git: http://git-scm.com/
 
 .. contents::
 
@@ -58,49 +56,63 @@
 Accessing the Repository
 ========================
 
-General Information
--------------------
-
 Web Access
-~~~~~~~~~~
+----------
 
 The repository can be browsed and examined via the web at
-http://sourceforge.net/p/docutils/code
+https://sourceforge.net/p/docutils/code.
 
-Alternatively, use the web interface of the git mirror at
-http://repo.or.cz/w/docutils.git.
+Alternatively, use the web interface at http://repo.or.cz/docutils.git.
+#github-mirrors_
 
+.. #github-mirrors There are also 3rd-party mirrors and forks at
+   GitHub, some of them orphaned. At the time of this writing (2021-11-03),
+   https://github.com/live-clones/docutils/tree/master/docutils
+   provides an hourly updated clone.
 
 Repository Access Methods
-~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------
 
-To get a checkout of the Docutils repository, first determine the root
-of the repository depending on your preferred protocol:
+To get a checkout, first determine the root of the repository depending
+on your preferred protocol:
 
 anonymous access: (read only)
-    ``http://svn.code.sf.net/p/docutils/code``
+    Subversion_: ``https://svn.code.sf.net/p/docutils/code``
+
+    Git_: ``git://repo.or.cz/docutils.git``
 
 `developer access`_: (read and write)
     ``svn+ssh://<USERNAME>@svn.code.sf.net/p/docutils/code``
 
-.. git clone: (read only)
-    ``git clone git://repo.or.cz/docutils.git``
-
 Checking Out the Repository
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------
+
+.. _creating a local Git clone:
+
+Git_ users can clone a mirror of the docutils repository with ::
+
+      git clone git://repo.or.cz/docutils.git
+
+and proceed according to the `Git documentation`_.
+Developer access (read and write) is possible with `git svn`_.
 
-To check out only the current main source tree of Docutils, type ::
+.. _Git documentation: https://git.wiki.kernel.org/index.php/GitDocumentation
+.. _git svn: https://git.wiki.kernel.org/index.php/Git-svn
+
+Subversion_ users can use the following commands
+(substitute your preferred repository root for ROOT):
+
+* To check out only the current main source tree of Docutils, type ::
 
     svn checkout ROOT/trunk/docutils
 
-(Substitute your preferred repository root for ROOT.)  To check out
-everything (main tree, sandboxes, web site, and parallel projects),
-type ::
+* To check out everything (main tree, sandboxes, web site, and parallel
+  projects), type ::
 
     svn checkout ROOT/trunk docutils
 
-This will create a working copy of the whole trunk in a new directory
-called ``docutils``.
+  This will create a working copy of the whole trunk in a new directory
+  called ``docutils``.
 
 Note that you probably do *not* want to check out the ROOT itself
 (without "/trunk"), because then you'd end up fetching the whole
@@ -112,29 +124,107 @@
     svn update
 
 Switching the Repository Root
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------
 
 If you changed your mind and want to use a different repository root,
 ``cd`` into your working copy and type::
 
     svn switch --relocate OLDROOT NEWROOT
 
-Creating a local git clone
-~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Users of git_ can clone a mirror of the docutils repository with ::
+Editable installs
+=================
+
+There are several ways to ensure that edits to the Docutils code are
+picked up by Python.
+
+We'll assume that the Docutils "trunk" is checked out under the
+``~/projects/`` directory.
+
+1. Do an `editable install`__ with pip_::
+
+     python3 -m pip install -e ~/projects/docutils/docutils
+
+   __ https://pip.pypa.io/en/stable/topics/local-project-installs/
+      #editable-installs
+
+2. Install "manually".
+
+   Ensure that the "docutils" package is in the module search path
+   (``sys.path``) by one of the following actions:
+
+   a) Set the ``PYTHONPATH`` environment variable.
 
-  git clone git://repo.or.cz/docutils.git
+      For the bash shell, add this to your ``~/.profile``::
 
-and proceed according to the `git documentation`_.
+         PYTHONPATH=$HOME/projects/docutils/docutils
+         export PYTHONPATH
 
-.. _git documentation: http://git-scm.com/documentation
+      The first line points to the directory containing the ``docutils``
+      package, the second line exports the environment variable.
+
+   b) Create a symlink to the docutils package directory somewhere in the
+      ``sys.path``, e.g., ::
+
+         ln -s ~/projects/docutils/docutils \
+               /usr/local/lib/python3.9/dist-packages/
+
+   c) Use a `path configuration file`__.
+
+      __ https://docs.python.org/library/site.html
+
+   Optionally, add some or all `front-end tools`_ to the binary search
+   path, e.g.:
+
+   a) add the ``tools`` directory to the ``PATH`` variable::
+
+         PATH=$PATH:$HOME/projects/docutils/docutils/tools
+         export PATH
+
+      or
+
+   b) link idividual front-end tools to a suitable place in the binary
+      path::
+
+         ln -s ~/projects/docutils/docutils/tools/docutils-cli.py \
+               /usr/local/bin/docutils
+
+3. Do a regular install. Repeat after any change. ::
+
+       ./setup.py install
+
+   .. CAUTION::
+
+      This method is **not** recommended for day-to-day development!
+
+      If you ever forget to reinstall the "docutils" package, Python
+      won't see your latest changes. Confusion inevitably ensues.
+
+Tip:
+  A useful addition to the ``docutils`` top-level directory in
+  *SVN branches* and *alternate copies* of the code is a ``set-PATHS``
+  shell script containing the following lines::
+
+      # source this file
+      export PYTHONPATH=$PWD:$PWD
+      export PATH=$PWD/tools:$PATH
+
+  Open a shell for this branch, ``cd`` to the ``docutils`` top-level
+  directory, and "source" this file.  For example, using the bash
+  shell::
+
+    $ cd some-branch/docutils
+    $ . set-PATHS
+
+.. _pip: https://pypi.org/project/pip/
+.. _setuptools: https://pypi.org/project/setuptools/
+.. _front-end tools: ../user/tools.html
 
 
 .. _developer access:
 
 Information for Developers
---------------------------
+==========================
 
 If you would like to have write access to the repository, register
 with SourceForge.net_ and send your SourceForge.net
@@ -142,15 +232,22 @@
 (Note that there may be a delay of several hours until you can commit
 changes to the repository.)
 
-Sourceforge subversion access is documented `here`__
+Sourceforge SVN access is documented `here`__
+
+__ https://sourceforge.net/p/forge/documentation/svn/
+
+
+Ensure any changes comply with the `Docutils Project Policies`_
+before `checking in`_,
 
-__ http://sourceforge.net/p/forge/documentation/svn/
+.. _Docutils Project Policies: policies.html
+.. _checking in: policies.html#check-ins
 
 
 Setting Up Your Subversion Client For Development
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------------
 
-Before commiting changes to the repository, please ensure that the
+Before committing changes to the repository, please ensure that the
 following lines are contained (and uncommented) in your local
 ~/.subversion/config file, so that new files are added with the
 correct properties set::

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/rst/alternatives.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/rst/alternatives.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../../header2.txt
+
 ==================================================
  A Record of reStructuredText Syntax Alternatives
 ==================================================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7383 $
-:Date: $Date: 2012-03-19 18:04:49 +0100 (Mo, 19. Mär 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 The following are ideas, alternatives, and justifications that were
@@ -30,9 +32,8 @@
 * `... Or Not To Do?`_: possible but questionable.  These probably
   won't be implemented, but you never know.
 
-.. _Setext: http://docutils.sourceforge.net/mirror/setext.html
-.. _StructuredText:
-   http://www.zope.org/DevHome/Members/jim/StructuredTextWiki/FrontPage
+.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
+.. _StructuredText: https://zopestructuredtext.readthedocs.org/
 .. _Problems with StructuredText: problems.html
 .. _reStructuredText Markup Specification:
    ../../ref/rst/restructuredtext.html
@@ -155,7 +156,7 @@
 would be no need for such a transformation for an XML-based markup
 syntax.
 
-.. _RFC822: http://www.rfc-editor.org/rfc/rfc822.txt
+.. _RFC822: https://www.rfc-editor.org/rfc/rfc822.txt
 
 
 Interpreted Text "Roles"
@@ -287,21 +288,21 @@
 
     Search the `Python DOC-SIG mailing list archives`{}_.
 
-    .. _: http://mail.python.org/pipermail/doc-sig/
+    .. _: https://mail.python.org/pipermail/doc-sig/
 
 The idea is sound and useful.  I suggested a "double underscore"
 syntax::
 
     Search the `Python DOC-SIG mailing list archives`__.
 
-    .. __: http://mail.python.org/pipermail/doc-sig/
+    .. __: https://mail.python.org/pipermail/doc-sig/
 
 But perhaps single underscores are okay?  The syntax looks better, but
 the hyperlink itself doesn't explicitly say "anonymous"::
 
     Search the `Python DOC-SIG mailing list archives`_.
 
-    .. _: http://mail.python.org/pipermail/doc-sig/
+    .. _: https://mail.python.org/pipermail/doc-sig/
 
 Mixing anonymous and named hyperlinks becomes confusing.  The order of
 targets is not significant for named hyperlinks, but it is for
@@ -513,7 +514,7 @@
    etc. names) into hyperlinks is a useful feature.  PyDoc recognizes
    identifiers heuristically, but it doesn't take much imagination to
    come up with counter-examples where PyDoc's heuristics would result
-   in embarassing failure.  I wanted to do it deterministically, and
+   in embarrassing failure.  I wanted to do it deterministically, and
    that called for syntax.  I called this construct "interpreted
    text".
 
@@ -696,7 +697,7 @@
        I had lunch with Jonathan_ today.  We talked about Zope_.
 
        .. _Jonathan: lj user=jhl
-       .. _Zope: http://www.zope.org/
+       .. _Zope: https://www.zope.dev/
 
    A problem with the proposed syntax is that URIs which look like
    simple reference names (alphanum plus ".", "-", "_") would be
@@ -706,7 +707,7 @@
        I had lunch with Jonathan_ today.  We talked about Zope_.
 
        .. _Jonathan: lj:: user=jhl
-       .. _Zope: http://www.zope.org/
+       .. _Zope: https://www.zope.dev/
 
    (``::`` after ``.. _Jonathan: lj``.)
 
@@ -748,7 +749,7 @@
 
     .. |biohazard| image:: biohazard.png
        height=20 width=20
-    .. _biohazard: http://www.cdc.gov/
+    .. _biohazard: https://www.cdc.gov/
 
 There have been several suggestions for the naming of these
 constructs, originally called "substitution references" and
@@ -829,16 +830,16 @@
       a `phrase reference`_.  Phrase references may even cross `line
       boundaries`_.
 
-      .. _reference: http://www.example.org/reference/
-      .. _phrase reference: http://www.example.org/phrase_reference/
-      .. _line boundaries: http://www.example.org/line_boundaries/
+      .. _reference: https://www.example.org/reference/
+      .. _phrase reference: https://www.example.org/phrase_reference/
+      .. _line boundaries: https://www.example.org/line_boundaries/
 
   + Advantages:
 
     - The plaintext is readable.
     - Each target may be reused multiple times (e.g., just write
       ``"reference_"`` again).
-    - No syncronized ordering of references and targets is necessary.
+    - No synchronized ordering of references and targets is necessary.
 
   + Disadvantages:
 
@@ -853,9 +854,9 @@
       `phrase reference`__.  Phrase references may even cross `line
       boundaries`__.
 
-      __ http://www.example.org/reference/
-      __ http://www.example.org/phrase_reference/
-      __ http://www.example.org/line_boundaries/
+      __ https://www.example.org/reference/
+      __ https://www.example.org/phrase_reference/
+      __ https://www.example.org/line_boundaries/
 
   + Advantages:
 
@@ -873,15 +874,15 @@
 
 * First, ``"reference text":URL``::
 
-      This is a "reference":http://www.example.org/reference/
+      This is a "reference":https://www.example.org/reference/
       of one word ("reference").  Here is a "phrase
-      reference":http://www.example.org/phrase_reference/.
+      reference":https://www.example.org/phrase_reference/.
 
-* Second, ``"reference text", http://example.com/absolute_URL``::
+* Second, ``"reference text", https://example.org/absolute_URL``::
 
-      This is a "reference", http://www.example.org/reference/
+      This is a "reference", https://www.example.org/reference/
       of one word ("reference").  Here is a "phrase reference",
-      http://www.example.org/phrase_reference/.
+      https://www.example.org/phrase_reference/.
 
 Both syntaxes share advantages and disadvantages:
 
@@ -905,14 +906,14 @@
 1. On 2002-06-28, Simon Budig proposed__ a new syntax for
    reStructuredText hyperlinks::
 
-       This is a reference_(http://www.example.org/reference/) of one
+       This is a reference_(https://www.example.org/reference/) of one
        word ("reference").  Here is a `phrase
-       reference`_(http://www.example.org/phrase_reference/).  Are
+       reference`_(https://www.example.org/phrase_reference/).  Are
        these examples, (single-underscore), named?  If so, `anonymous
-       references`__(http://www.example.org/anonymous/) using two
+       references`__(https://www.example.org/anonymous/) using two
        underscores would probably be preferable.
 
-   __ http://mail.python.org/pipermail/doc-sig/2002-June/002648.html
+   __ https://mail.python.org/pipermail/doc-sig/2002-June/002648.html
 
    The syntax, advantages, and disadvantages are similar to those of
    StructuredText.
@@ -953,13 +954,13 @@
    following compromise syntax::
 
        This is an anonymous reference__
-       __<http://www.example.org/reference/> of one word
+       __<https://www.example.org/reference/> of one word
        ("reference").  Here is a `phrase reference`__
-       __<http://www.example.org/phrase_reference/>.  `Named
-       references`_ _<http://www.example.org/anonymous/> use single
+       __<https://www.example.org/phrase_reference/>.  `Named
+       references`_ _<https://www.example.org/anonymous/> use single
        underscores.
 
-   __ http://mail.python.org/pipermail/doc-sig/2002-July/002670.html
+   __ https://mail.python.org/pipermail/doc-sig/2002-July/002670.html
 
    The syntax builds on that of the existing "inline internal
    targets": ``an _`inline internal target`.``
@@ -989,14 +990,14 @@
    target to appear later, such as after the end of the sentence::
 
        This is a named reference__ of one word ("reference").
-       __<http://www.example.org/reference/>  Here is a `phrase
-       reference`__.  __<http://www.example.org/phrase_reference/>
+       __<https://www.example.org/reference/>  Here is a `phrase
+       reference`__.  __<https://www.example.org/phrase_reference/>
 
    Problem: this could only work for one reference at a time
    (reference/target pairs must be proximate refA trgA refB trgB,
    not interleaved refA refB trgA trgB or nested refA refB trgB
    trgA).  This variation is too problematic; references and inline
-   external targets will have to be kept imediately adjacent (see (3)
+   external targets will have to be kept immediately adjacent (see (3)
    below).
 
    The ``"reference__ __<target>"`` syntax is actually for "anonymous
@@ -1030,9 +1031,9 @@
    Here's an alternative syntax embedding the target URL in the
    reference::
 
-       This is an anonymous `reference <http://www.example.org
+       This is an anonymous `reference <https://www.example.org
        /reference/>`__ of one word ("reference").  Here is a `phrase
-       reference <http://www.example.org/phrase_reference/>`__.
+       reference <https://www.example.org/phrase_reference/>`__.
 
    Advantages and disadvantages are similar to those in (2).
    Readability is still an issue, but the syntax is a bit less
@@ -1045,7 +1046,7 @@
    Problem: how to refer to a title like "HTML Anchors: <a>" (which
    ends with an HTML/SGML/XML tag)?  We could either require more
    syntax on the target (like ``"`reference text
-   __<http://example.com/>`__"``), or require the odd conflicting
+   __<https://example.org/>`__"``), or require the odd conflicting
    title to be escaped (like ``"`HTML Anchors: \<a>`__"``).  The
    latter seems preferable, and not too onerous.
 
@@ -1058,17 +1059,17 @@
 Other syntax variations have been proposed (by Brett Cannon and Benja
 Fallenstein)::
 
-    `phrase reference`->http://www.example.com
+    `phrase reference`->https://www.example.org
 
-    `phrase reference`@http://www.example.com
+    `phrase reference`@https://www.example.org
 
-    `phrase reference`__ ->http://www.example.com
+    `phrase reference`__ ->https://www.example.org
 
-    `phrase reference` -> http://www.example.com
+    `phrase reference` -> https://www.example.org
 
-    `phrase reference`__ -> http://www.example.com
+    `phrase reference`__ -> https://www.example.org
 
-    `phrase reference` <http://www.example.com>_
+    `phrase reference` <https://www.example.org>_
 
 None of these variations are clearly superior to #3 above.  Some have
 problems that exclude their use.
@@ -1086,7 +1087,7 @@
 
   To which I said, "So use anonymous hyperlinks."
 
-- Anonymous hyperlinks are difficult to maintain becuase the
+- Anonymous hyperlinks are difficult to maintain because the
   references and targets have to be kept in sync.
 
   "So keep the targets close to the references, grouped after each
@@ -1239,7 +1240,7 @@
 
 Solution 3 was chosen for incorporation into the document tree model.
 
-.. _HTML: http://www.w3.org/MarkUp/
+.. _HTML: https://www.w3.org/MarkUp/
 
 
 Syntax for Line Blocks
@@ -1278,7 +1279,7 @@
   (Awful, and arguably invalid, since in Japanese the word "haiku"
   contains three syllables not two.)
 
-  This idea was superceded by the rules for escaped whitespace, useful
+  This idea was superseded by the rules for escaped whitespace, useful
   for `character-level inline markup`_.
 
 * In a `2004-02-22 docutils-develop message`__, Jarno Elonen proposed
@@ -1288,7 +1289,7 @@
        | President, SuperDuper Corp.
        | jdoe@example.org
 
-  __ http://thread.gmane.org/gmane.text.docutils.devel/1187
+  __ https://thread.gmane.org/gmane.text.docutils.devel/1187
 
   This syntax is very natural.  However, these "plain lists" seem very
   similar to line blocks, and I see so little intrinsic "list-ness"
@@ -1807,7 +1808,7 @@
    auto-numbered lists be limited to begin with ordinal-1 ("1", "A",
    "a", "I", or "i")?
 
-   __ http://sourceforge.net/tracker/index.php?func=detail&aid=548802
+   __ https://sourceforge.net/tracker/index.php?func=detail&aid=548802
       &group_id=38414&atid=422032
 
 4. Alternative proposed by Tony Ibbs::
@@ -1886,7 +1887,7 @@
 .. _Inline markup recognition rules:
    ../../ref/rst/restructuredtext.html#inline-markup-recognition-rules
 .. _Unicode categories:
-   http://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
+   https://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
 
 
 -----------------
@@ -2006,23 +2007,23 @@
   - Current syntax (footnote syntax)::
 
         .. GVR2001 Python Documentation; van Rossum, Drake, et al.;
-           http://www.python.org/doc/
+           https://www.python.org/doc/
 
   - Possible new syntax::
 
         _GVR2001 Python Documentation; van Rossum, Drake, et al.;
-                   http://www.python.org/doc/
+                   https://www.python.org/doc/
 
         _DJG2002
             Docutils: Python Documentation Utilities project; Goodger
-            et al.; http://docutils.sourceforge.net/
+            et al.; https://docutils.sourceforge.io/
 
     Without the ".. " marker, subsequent lines would either have to
     align as in one of the above, or we'd have to allow loose
     alignment (I'd rather not)::
 
         _GVR2001 Python Documentation; van Rossum, Drake, et al.;
-            http://www.python.org/doc/
+            https://www.python.org/doc/
 
 I proposed adopting the "minimal" syntax for footnotes and footnote
 references, and adding citations and citation references to
@@ -2191,7 +2192,7 @@
 As described in the FAQ__, no special syntax or directive is needed
 for this application.
 
-__ http://docutils.sf.net/FAQ.html
+__ https://docutils.sourceforge.io/FAQ.html
    #how-can-i-mark-up-a-faq-or-other-list-of-questions-answers
 
 
@@ -2209,7 +2210,7 @@
 begat later arguments.  Below, the arguments are paraphrased "in
 quotes", with responses.
 
-__ http://thread.gmane.org/gmane.text.docutils.devel/1386
+__ https://thread.gmane.org/gmane.text.docutils.devel/1386
 
 1. References and targets take this form::
 
@@ -2339,7 +2340,7 @@
 
 7. "I'd prefer to see double-dot-space / command / double-colon as the
    standard Docutils markup-marker.  It's unusual enough to avoid
-   being accidently used.  Everything that starts with a double-dot
+   being accidentally used.  Everything that starts with a double-dot
    should end with a double-colon."
 
    That would increase the punctuation verbosity of some constructs
@@ -2407,9 +2408,9 @@
       inside what must be well thought out first though.
 
       .. _Ed Loper's 2001-03-21 post:
-         http://mail.python.org/pipermail/doc-sig/2001-March/001487.html
+         https://mail.python.org/pipermail/doc-sig/2001-March/001487.html
 
-      -- http://mail.python.org/pipermail/doc-sig/2001-October/002354.html
+      -- https://mail.python.org/pipermail/doc-sig/2001-October/002354.html
 
 * In a 2001-11-09 Doc-SIG post, I wrote:
 
@@ -2426,7 +2427,7 @@
       markup. The first algorithm ("first identify the outer inline
       markup as we do now, then recursively scan for nested inline
       markup") won't work; counterexamples were given in my `last post
-      <http://mail.python.org/pipermail/doc-sig/2001-November/002363.html>`__.
+      <https://mail.python.org/pipermail/doc-sig/2001-November/002363.html>`__.
 
       The second algorithm makes my head hurt::
 
@@ -2457,7 +2458,7 @@
       at least not now. If somebody codes up a consistent, working,
       general solution, I'll be happy to consider it.
 
-      -- http://mail.python.org/pipermail/doc-sig/2001-November/002388.html
+      -- https://mail.python.org/pipermail/doc-sig/2001-November/002388.html
 
 * In a `2003-05-06 Docutils-Users post`__ Paul Tremblay proposed a new
   syntax to allow for easier nesting.  It eventually evolved into
@@ -2468,7 +2469,7 @@
   The duplication with the existing interpreted text syntax is
   problematic though.
 
-  __ http://article.gmane.org/gmane.text.docutils.user/317
+  __ https://article.gmane.org/gmane.text.docutils.user/317
 
 * Could the parser be extended to parse nested interpreted text? ::
 
@@ -2481,7 +2482,7 @@
   ideas.  The implementation was flawed, however, by the change in
   semantics required for backslash escapes.
 
-  __ http://article.gmane.org/gmane.text.docutils.devel/795
+  __ https://article.gmane.org/gmane.text.docutils.devel/795
 
 * Docutils-develop threads between David Abrahams, David Goodger, and
   Mark Nodine (beginning 2004-01-16__ and 2004-01-19__) hashed out
@@ -2489,8 +2490,8 @@
   described below.  David Abrahams checked in code to the "nesting"
   branch of CVS, awaiting thorough review.
 
-  __ http://thread.gmane.org/gmane.text.docutils.devel/1102
-  __ http://thread.gmane.org/gmane.text.docutils.devel/1125
+  __ https://thread.gmane.org/gmane.text.docutils.devel/1102
+  __ https://thread.gmane.org/gmane.text.docutils.devel/1125
 
 It may be possible to accomplish nested inline markup in general with
 a more powerful inline markup parser.  There may be some issues, but
@@ -2704,11 +2705,11 @@
 follow-ups, here__ and here__).  Also `docutils-users, 2003-02-17`__
 and `beginning 2003-08-04`__.
 
-__ http://mail.python.org/pipermail/doc-sig/2001-April/001776.html
-__ http://mail.python.org/pipermail/doc-sig/2001-April/001789.html
-__ http://mail.python.org/pipermail/doc-sig/2001-April/001793.html
-__ http://sourceforge.net/mailarchive/message.php?msg_id=3838913
-__ http://sf.net/mailarchive/forum.php?thread_id=2957175&forum_id=11444
+__ https://mail.python.org/pipermail/doc-sig/2001-April/001776.html
+__ https://mail.python.org/pipermail/doc-sig/2001-April/001789.html
+__ https://mail.python.org/pipermail/doc-sig/2001-April/001793.html
+__ https://sourceforge.net/mailarchive/message.php?msg_id=3838913
+__ https://sf.net/mailarchive/forum.php?thread_id=2957175&forum_id=11444
 
 
 Sloppy Indentation of List Items
@@ -3016,9 +3017,9 @@
 entity set definition files have been defined`__ (`tarball`__).
 There's also `a description and instructions for use`__.
 
-__ http://docutils.sf.net/tmp/charents/
-__ http://docutils.sf.net/tmp/charents.tgz
-__ http://docutils.sf.net/tmp/charents/README.html
+__ https://docutils.sourceforge.io/tmp/charents/
+__ https://docutils.sourceforge.io/tmp/charents.tgz
+__ https://docutils.sourceforge.io/tmp/charents/README.html
 
 To allow for `character-level inline markup`_, a limited form of
 character processing has been added to the spec and parser: escaped
@@ -3202,7 +3203,6 @@
 .. _object references:
    ../todo.html#object-numbering-and-object-references
 
-
 &#xc;
 ..
    Local Variables:

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/rst/problems.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/rst/problems.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../../header2.txt
+
 ==============================
  Problems With StructuredText
 ==============================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 There are several problems, unresolved issues, and areas of
@@ -847,10 +849,9 @@
 text is separated from the link URI and the footnote, resulting in
 cleanly readable text.
 
-.. _StructuredText:
-   http://www.zope.org/DevHome/Members/jim/StructuredTextWiki/FrontPage
-.. _Setext: http://docutils.sourceforge.net/mirror/setext.html
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _StructuredText: https://zopestructuredtext.readthedocs.org/
+.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _detailed description:
    http://homepage.ntlworld.com/tibsnjoan/docutils/STNG-format.html
 .. _STMinus: http://www.cis.upenn.edu/~edloper/pydoc/stminus.html

_service:tar_scm:docutils-0.20.tar.gz/docs/dev/runtime-settings-processing.txt Added

@@ -0,0 +1,308 @@
+.. include:: ../header.txt
+
+=============================
+ Runtime Settings Processing
+=============================
+
+:Author: David Goodger, Günter Milde
+:Contact: docutils-develop@lists.sourceforge.net
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
+:Copyright: This document has been placed in the public domain.
+
+:Abstract: A detailled description of Docutil's settings processing
+           framework.
+
+.. contents::
+
+
+The ``docutils/__init__.py``, ``docutils/core.py``, and
+``docutils.frontend.py`` modules are described.
+Following along with the actual code is recommended.
+
+See `Docutils Runtime Settings`_ for a high-level description of the core
+API and `Docutils Configuration`_ for a description of the individual
+settings.
+
+.. note::
+   This document is informal.
+   It describes the state in Docutils 0.18.1.
+   Implementation details will change with the move to replace the
+   deprecated optparse_ module with argparse_.
+
+
+Settings priority
+=================
+
+Docutils overlays default and explicitly specified values from various
+sources such that settings behave the way we want and expect them to
+behave.
+
+The souces are overlaid in the following order (later sources
+overwrite earlier ones):
+
+1. Defaults specified in `settings_spec`__ and
+   `settings_defaults`__ attributes for each component_.
+   (details__)
+
+   __ ../api/runtime-settings.html#settingsspec-settings-spec
+   __ ../api/runtime-settings.html#settingsspec-settings-defaults
+   __ `OptionParser.populate_from_components()`_
+
+2. Defaults specified in `settings_default_overrides`__ attribute for
+   each component_.
+   (details__)
+
+   __ ../api/runtime-settings.html#settingsspec-settings-default-overrides
+   __ component.settings_default_overrides_
+
+3. Settings specified in the `settings_overrides parameter`_ of the
+   `convenience functions`_ rsp. the `settings_overrides` attribute of
+   a `core.Publisher` instance.
+   (details__)
+
+   __ OptionParser.defaults_
+
+4. If enabled, settings specified in `active sections`_ of the
+   `configuration files`_ in the order described in
+   `Configuration File Sections & Entries`_. (details__)
+
+   See also `Configuration File Sections & Entries`_.
+
+   __ `OptionParser.get_standard_config_settings()`_
+
+5. If enabled, command line arguments (details__).
+
+   __ `Publisher.process_command_line()`_
+
+
+Settings assigned to the `settings parameter`_ of the
+`convenience functions`_ or the ``Publisher.settings`` attribute
+are used **instead of** the above sources
+(see below for details for `command-line tools`__ and
+`other applications`__).
+
+__ `publisher.publish()`_
+__ `publisher.process_programmatic_settings()`_
+
+.. _command-line tools:
+
+Runtime settings processing for command-line tools
+==================================================
+
+The command-line `front-end tools`_ usually import and call
+the `convenience function`_ ``docutils.core.publish_cmdline()``.
+
+1. ``docutils.core.publish_cmdline()`` creates a `Publisher`_ instance::
+
+       publisher = core.Publisher(…, settings)
+
+   eventually sets the components_ from the respective names, and calls ::
+
+       publisher.publish(argv, …, settings_spec,
+                         settings_overrides, config_section, …)
+
+   .. _publisher.publish():
+
+2. If `publisher.settings` is None, ``publisher.publish()`` calls::
+
+       publisher.process_command_line(…,
+           settings_spec, config_section, **defaults)
+
+   with `defaults` taken from `publisher.settings_overrides`.
+
+   If `publisher.settings` is defined, steps 3 to 5 are skipped.
+
+3. ``publisher.process_command_line()`` calls::
+
+       optpar = publisher.setup_option_parser(…,
+                    settings_spec, config_section, **defaults)
+
+   .. _publisher.setup_option_parser():
+
+4. ``publisher.setup_option_parser()``
+
+   - merges the value of the `config_section parameter`_ into
+     `settings_spec` and
+
+   - creates an `OptionParser` instance ::
+
+        optpar = docutils.frontend.OptionParser(components, defaults)
+
+     with `components` the tuple of the `SettingsSpec`_ instances
+     ``(publisher.parser, publisher.reader, publisher.writer, settings_spec)``
+
+   .. _OptionParser.populate_from_components():
+
+5. The `OptionParser` instance prepends itself to the `components` tuple
+   and calls ``self.populate_from_components(components)``, which updates
+   the attribute ``self.defaults`` in two steps:
+
+   a) For each component passed, ``component.settings_spec`` is processed
+      and ``component.settings_defaults`` is applied.
+
+      .. _component.settings_default_overrides:
+
+   b) In a second loop, for each component
+      ``component.settings_default_overrides`` is applied. This way,
+      ``component.settings_default_overrides`` can override the default
+      settings of any other component.
+
+   .. _OptionParser.defaults:
+
+6. Back in ``OptionParser.__init__()``, ``self.defaults`` is updated with
+   the `defaults` argument passed to ``OptionParser(…)`` in step 5.
+
+   This means that the `settings_overrides` argument of the
+   `convenience functions`_ has priority over all
+   ``SettingsSpec.settings_spec`` defaults.
+
+   .. _OptionParser.get_standard_config_settings():
+
+7. If configuration files are enabled,
+   ``self.get_standard_config_settings()`` is called.
+
+   This reads the Docutils `configuration files`_, and returns a
+   dictionary of settings in `active sections`_ which is used to update
+   ``optpar.defaults``. So configuration file settings have priority over
+   all software-defined defaults.
+
+   .. _Publisher.process_command_line():
+
+8. ``publisher.process_command_line()`` calls ``optpar.parse_args()``.
+   The OptionParser parses all command line options and returns a
+   `docutils.frontend.Values` object.
+   This is assigned to ``publisher.settings``.
+   So command-line options have priority over configuration file
+   settings.
+
+9. The `<source>` and `<destination>` command-line arguments
+   are also parsed, and assigned to ``publisher.settings._source``
+   and ``publisher.settings._destination`` respectively.
+
+10. ``publisher.publish()`` calls ``publisher.set_io()`` with no arguments.
+    If either ``publisher.source`` or ``publisher.destination`` are not
+    set, the corresponding ``publisher.set_source()`` and
+    ``publisher.set_destination()`` are called:
+
+    ``publisher.set_source()``
+      checks for a ``source_path`` argument, and if there is none (which
+      is the case for command-line use), it is taken from
+      ``publisher.settings._source``.  ``publisher.source`` is set by
+      instantiating a ``publisher.source_class`` object.
+      For command-line front-end tools, the default
+      ``publisher.source_class`` (i.e. ``docutils.io.FileInput``)
+      is used.
+
+    ``publisher.set_destination()``
+      does the same job for the destination. (the default
+      ``publisher.destination_class`` is ``docutils.io.FileOutput``).
+
+    .. _accessing the runtime settings:
+
+11. ``publisher.publish()`` passes ``publisher.settings`` to the reader_
+    component's ``read()`` method.
+
+12. The reader component creates a new `document root node`__.
+    ``nodes.document.__init__()`` adds the settings to the internal
+    attributes.
+
+    __ ../ref/doctree.html#document
+
+    All components acting on the Document Tree are handed the
+    ``document`` root node and can access the runtime settings as
+    ``document.settings``.
+
+
+Runtime settings processing for other applications
+==================================================
+
+The `convenience functions`_ , ``core.publish_file()``,
+``core.publish_string()``, or ``core.publish_parts()`` do not parse the
+command line for settings.
+
+1. The convenience functions call the generic programmatic interface
+   function ``core.publish_programmatically()`` that creates a
+   `core.Publisher` instance ::
+
+       pub = core.Publisher(…, settings)
+
+   eventually sets the components_ from the respective names, and calls ::
+
+       publisher.process_programmatic_settings(
+           settings_spec, settings_overrides, config_section)
+
+   .. _publisher.process_programmatic_settings():
+
+2. If `publisher.settings` is None,
+   ``publisher.process_programmatic_settings()`` calls::
+
+       publisher.get_settings(settings_spec, config_section, **defaults)
+
+   with `defaults` taken from `publisher.settings_overrides`.
+
+   If `publisher.settings` is defined, the following steps are skipped.
+
+3. ``publisher.get_settings()`` calls::
+
+       optpar = publisher.setup_option_parser(…,
+                    settings_spec, config_section, **defaults)
+
+4. The OptionParser instance determines setting defaults
+   as described in `steps 4 to 7`__ in the previous section.
+
+   __ `publisher.setup_option_parser()`_
+
+5. Back in ``publisher.get_settings()``, the ``frontend.Values`` instance
+   returned by ``optpar.get_default_values()`` is stored in
+   ``publisher.settings``.
+
+6. ``publish_programmatically()`` continues with setting
+   ``publisher.source`` and ``publisher.destination``.
+
+7. Finally, ``publisher.publish()`` is called. As ``publisher.settings``
+   is not None, no further command line processing takes place.
+
+8. All components acting on the Document Tree are handed the
+   ``document`` root node and can access the runtime settings as
+   ``document.settings`` (cf. `steps 11 and 12`__ in the previous section).
+
+   __ `accessing the runtime settings`_
+
+
+.. References:
+
+.. _optparse: https://docs.python.org/dev/library/optparse.html
+.. _argparse: https://docs.python.org/dev/library/argparse.html
+
+.. _Docutils Runtime Settings:
+   ../api/runtime-settings.html
+.. _active sections:
+   ../api/runtime-settings.html#active-sections
+.. _SettingsSpec:
+   ../api/runtime-settings.html#settingsspec
+.. _component:
+.. _components:
+    ../api/runtime-settings.html#components
+.. _application settings specifications:
+.. _convenience function:
+.. _convenience functions:
+    ../api/runtime-settings.html#convenience-functions
+.. _settings_overrides parameter:
+    ../api/runtime-settings.html#settings-overrides-parameter
+.. _settings parameter:
+   ../api/runtime-settings.html#settings-parameter
+.. _config_section parameter:
+   ../api/runtime-settings.html#config-section-parameter
+
+.. _Publisher convenience functions:
+    ../api/publisher.html#publisher-convenience-functions
+.. _front-end tools: ../user/tools.html
+.. _configuration file:
+.. _configuration files:
+.. _Docutils Configuration: ../user/config.html#configuration-files
+.. _Configuration File Sections & Entries:
+    ../user/config.html#configuration-file-sections-entries
+.. _Docutils Project Model: ../peps/pep-0258.html#docutils-project-model
+.. _Publisher: ../peps/pep-0258.html#publisher
+.. _Reader: ../peps/pep-0258.html#reader

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/semantics.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/semantics.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../header.txt
+
 =====================
  Docstring Semantics
 =====================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 These are notes for a possible future PEP providing the final piece of
@@ -53,7 +55,7 @@
             default).
 
       :Return:
-          - a list of indented lines with mininum indent removed;
+          - a list of indented lines with minimum indent removed;
           - the amount of the indent;
           - whether or not the block finished with a blank line or at
             the end of `lines`.
@@ -101,13 +103,13 @@
   an attachment to his Doc-SIG post of 2001-05-30.
 
 
-.. _PEP 257: http://www.python.org/peps/pep-0257.html
+.. _PEP 257: https://peps.python.org/pep-0257
 .. _JavaDoc: http://java.sun.com/j2se/javadoc/
 .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/
 .. _Grouch: http://www.mems-exchange.org/software/grouch/
-.. _epydoc: http://epydoc.sf.net/
+.. _epydoc: http://epydoc.sourceforge.net/
 .. _iPhrase Python documentation conventions:
-   http://mail.python.org/pipermail/doc-sig/2001-May/001840.html
+   https://mail.python.org/pipermail/doc-sig/2001-May/001840.html
 
 &#xc;
 ..

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/testing.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/testing.txt Changed

@@ -1,14 +1,21 @@
+.. include:: ../header.txt
+
 ===================
  Docutils_ Testing
 ===================
 
 :Authors: Lea Wiemann <LeWiemann@gmail.com>;
-          David Goodger <goodger@python.org>
-:Revision: $Revision: 8491 $
-:Date: $Date: 2020-02-06 16:10:46 +0100 (Do, 06. Feb 2020) $
+          David Goodger <goodger@python.org>;
+          Docutils developers <docutils-developers@lists.sourceforge.net>
+:Revision: $Revision: 9308 $
+:Date: $Date: 2022-12-13 22:45:23 +0100 (Di, 13. Dez 2022) $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.net/
+:Abstract: This document describes how to run the Docutils test suite,
+           how the tests are organized and how to add new tests or modify
+           existing tests.
+
+.. _Docutils: https://docutils.sourceforge.io/
 
 .. contents::
 
@@ -16,89 +23,95 @@
 cases to the test suite.  Practise test-first programming; it's fun,
 it's addictive, and it works!
 
-This document describes how to run the Docutils test suite, how the
-tests are organized and how to add new tests or modify existing tests.
-
 
 Running the Test Suite
 ======================
 
 Before checking in any changes, run the entire Docutils test suite to
-be sure that you haven't broken anything.  From a shell::
+be sure that you haven't broken anything.  From a shell do::
 
     cd docutils/test
-    ./alltests.py
-
-You should run this with multiple Python versions. You can use ``tox`` for
-this purpose. To run tests against all supported versions of Python, run::
+    python -u alltests.py
 
-    tox
-
-To run against a specific version of Python, use the ``pyNN`` environment.
-For example::
-
-    tox -e py37
+Before `checking in`__ changes to the Docutils core, run the tests on
+all `supported Python versions`_ (see below for details).
+In a pinch, the edge cases should cover most of it.
 
+.. note::
+   The ``alltests.py`` test runner is based on the standard library's unittest_
+   framework.
+   Since Docutils 0.19, running ``python -m unittest`` and the pytest_
+   framework no longer result in spurious failures (cf. `bug #270`_).
+   However, there are differences in the reported number of tests
+   (``alltests.py`` also counts sub-tests).
+   In future, running the test suite may require pytest_.
 
-Python Versions
-===============
+__ policies.html#check-ins
+.. _unittest: https://docs.python.org/3/library/unittest.html
+.. _pytest: https://pypi.org/project/pytest
+.. _`bug #270`: https://sourceforge.net/p/docutils/bugs/270/
 
-A docutils release has a commitment to support a minimum version and beyond.
-Before a release is cut, tests must pass in all supported Python versions.
 
-Docutils 0.16 supports Python 2.7 and Python 3.5 or later.
+.. _Python versions:
 
-Therefore, you should install Python 2.7 as well as 3.5 up to the latest Python
-(3.7 at the time of this writing) and always run the tests on all of
-them (see `Testing across multiple python versions`_).
-In a pinch, the edge cases (2.7, and 3.7) should cover most of it.
+Testing across multiple Python versions
+---------------------------------------
 
-Good resources covering the differences between Python versions:
+A Docutils release has a commitment to support a minimum Python version
+and beyond (see dependencies__ in README.txt). Before a release is cut,
+tests must pass in all `supported versions`_. #_
 
-* `What's New in Python 2.7`__
-* `What's New in Python 3.5`__
-* `What's New in Python 3.6`__
-* `What's New in Python 3.7`__
-* `PEP 290 - Code Migration and Modernization`__
+__ ../../README.html#dependencies
 
-__ https://docs.python.org/whatsnew/2.7.html
-__ https://docs.python.org/3/whatsnew/3.5.html
-__ https://docs.python.org/3/whatsnew/3.6.html
-__ https://docs.python.org/3/whatsnew/3.7.html
-__ http://www.python.org/peps/pep-0290.html
+You can use `tox`_ to test with all supported versions in one go.
+From the shell::
 
-.. _Python Check-in Policies: http://www.python.org/dev/tools.html
-.. _sandbox directory:
-   http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/sandbox/
+    cd docutils
+    tox
 
+To test a specific version, use the ``pyNN`` environment. For example::
 
-Testing across multiple python versions
----------------------------------------
+    tox -e py37
 
 `pyenv`_ can be installed and configured (see `installing pyenv`_) to
-test multiple python versions::
+get multiple Python versions::
 
-    # assuming your system runs 2.7.x
-    pyenv install 3.5.7
-    pyenv install 3.6.9
-    pyenv install 3.7.3
-    pyenv global system 3.5.7 3.6.9 3.7.3
+    # assuming your system runs 3.9.x
+    pyenv install 3.7.12
+    pyenv install 3.8.12
+    pyenv install 3.10.1
+    pyenv global system 3.7.12 3.8.12 3.10.1 3.11.0
 
     # reset your shims
     rm -rf ~/.pyenv/shims && pyenv rehash
 
-This will give you ``python2.7`` and ``python3.5`` through ``python3.7``.
-You will also get ``pip2.7``, ``pip3.5``, etc.
+This will give you ``python3.7`` through ``python3.11``.
+Then run::
 
-To save time, you can use `tox`_. To install tox, run ``pip install tox``.
-Once installed, from shell::
+    python3.7 -u alltests.py
+    ...
+    python3.11 -u alltests.py
 
-    cd docutils
-    tox
+.. note::
+   When using the `Python launcher for Windows`__, specify the Python version
+   as option, e.g., ``py -3.9 -u alltests.py`` for Python 3.9.
+
+   .. cf. https://sourceforge.net/p/docutils/bugs/434/
+   __ https://docs.python.org/3/using/windows.html#python-launcher-for-windows
 
-.. _tox: https://tox.readthedocs.org/en/latest/
+
+.. # Good resources covering the differences between Python versions
+   are the `What's New` documents (`What's New in Python 3.11`__ and
+   similar).
+
+   __ https://docs.python.org/3/whatsnew/3.11.html
+
+
+.. _supported versions:
+.. _supported Python versions: ../../README.html#requirements
 .. _pyenv: https://github.com/yyuu/pyenv
 .. _installing pyenv: https://github.com/yyuu/pyenv#installation
+.. _tox: https://pypi.org/project/tox/
 
 
 Unit Tests
@@ -128,9 +141,9 @@
 using Python's ``unittest`` module.  For an example, please have a
 look at the following imaginary ``test_square.py``::
 
-    #! /usr/bin/env python
+    #! /usr/bin/env python3
 
-    # $Id: testing.txt 8491 2020-02-06 15:10:46Z milde $
+    # $Id: testing.txt 9308 2022-12-13 21:45:23Z milde $
     # Author: Your Name <your_email_address@example.org>
     # Copyright: This module has been placed in the public domain.
 
@@ -139,6 +152,11 @@
     """
 
     import unittest
+    if __name__ == '__main__':
+        # prepend the "docutils root" to the Python library path
+        # so we import the local `docutils` package.
+        sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
     import docutils.square
 
 
@@ -164,12 +182,15 @@
 
 .. Note::
 
-   Unit tests and functional test should generally set ::
+   Unit tests and functional test should generally disable configuration
+   files, setting the `_disable_config`__ setting to True ::
 
      settings_overrides'_disable_config' = True
 
    in order to be independent on the users local configuration.
 
+   __ ../user/config.html#disable-config
+
 .. _functional:
 
 Functional Tests
@@ -202,8 +223,6 @@
 
     - ``some_test.py``, for example.
 
-    - ``_default.py``, the `default configuration file`_.
-
 
 The Testing Process
 -------------------
@@ -234,14 +253,6 @@
 arbitrarily.  However, the file names in ``functional/output/`` *must*
 match the file names in ``functional/expected/``.
 
-If defined, ``_test_more`` must be a function with the following
-signature::
-
-    def _test_more(expected_dir, output_dir, test_case, parameters):
-
-This function is called from the test case to perform tests beyond the
-simple comparison of expected and actual output files.
-
 ``test_source`` and ``test_destination`` are removed from the
 namespace, as are all variables whose names begin with an underscore
 ("_").  The remaining names are passed as keyword arguments to
@@ -277,18 +288,7 @@
 
 .. # The validity of `Docutils XML` can be tested with
    ``xmllint <document-referencing-local-Docutils-DTD>.xml --valid --noout``.
-     
-   .. note: the ``--dtdvalid`` and ``--nonet`` options did not help override
+
+   .. note: the ``--dtdvalid`` and ``--nonet`` options do not help override
      a reference to the PUBLIC "docutils.dtd" if there is a local version
      on the system (e.g. /usr/share/xml/docutils/docutils.dtd in Debian).
-
-
-.. _default configuration file:
-
-The Default Configuration File
-------------------------------
-
-The file ``functional/tests/_default.py`` contains default settings.
-It is executed just before the actual configuration files, which has
-the same effect as if the contents of ``_default.py`` were prepended
-to every configuration file.

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/todo.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/todo.txt Changed

@@ -1,3 +1,5 @@
+.. include:: ../header.txt
+
 ======================
  Docutils_ To Do List
 ======================
@@ -5,11 +7,11 @@
 :Author: David Goodger (with input from many); open to all Docutils
          developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
-:Revision: $Revision: 8631 $
+:Date: $Date: 2022-11-02 23:39:16 +0100 (Mi, 02. Nov 2022) $
+:Revision: $Revision: 9201 $
 :Copyright: This document has been placed in the public domain.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 .. contents::
 
@@ -19,17 +21,7 @@
 require more thought and debate; they are potential to-do's.
 
 Many of these items are awaiting champions.  If you see something
-you'd like to tackle, please do!  If there's something you'd like to
-see done but are unable to implement it yourself, please consider
-donating to Docutils: |donate|
-
-.. |donate| image:: http://images.sourceforge.net/images/project-support.jpg
-   :target: http://sourceforge.net/donate/index.php?group_id=38414
-   :align: middle
-   :width: 88
-   :height: 32
-   :alt: Support the Docutils project!
-
+you'd like to tackle, please do!
 Please see also the Bugs_ document for a list of bugs in Docutils.
 
 .. _bugs: ../../BUGS.html
@@ -64,33 +56,82 @@
 * Plugin support.
 
 * Suitability for `Python module documentation
-  <http://docutils.sf.net/sandbox/README.html#documenting-python>`_.
+  <https://docutils.sourceforge.io/sandbox/README.html#documenting-python>`_.
+
+.. _Sphinx: http://www.sphinx-doc.org/
+
+Repository
+==========
+
+Move to a Git repository.
+
+* This is a long standing `feature request`__
+  (with pointers to Sphinx issues and discussion).
+
+  __ https://sourceforge.net/p/docutils/feature-requests/58/
+
+* From a `post by David Goodger`__
+
+    An absolute requirement, for me, is that such a change be complete.
+    We can't lose any data or have to refer to the old system as an
+    "archive". So all the SVN history, all branches, and the full sandbox
+    need to be converted at the same time.
+
+  __ https://sourceforge.net/p/docutils/mailman/message/31878077/
+
+Convert with reposurgeon_?
+
+  If you are doing a full import rather than gatewaying, reposurgeon is
+  probably what you want. It has been tested against a lot of large, old,
+  nasty repositories and is thus known to be robust in the presence of
+  repository malformations (a property regularly checked by a test suite
+  that is a rogue's gallery of Subversion botches).
+
+  -- `Git Wiki`__
+
+The comprehensive `Reposurgeon documentation`_ comes with
+`a guide to repository conversion`__
+as well as info about `reading Subversion repositories`__.
+Converting from an SVN dump file is faster than from a checkout.
+
+.. _reposurgeon: http://www.catb.org/esr/reposurgeon/
+.. _reposurgeon documentation:
+    http://www.catb.org/esr/reposurgeon/repository-editing.html
+__ https://git.wiki.kernel.org/index.php/
+   Interfaces,_frontends,_and_tools#Subversion
+__ http://www.catb.org/esr/reposurgeon/repository-editing.html#conversion   
+__ http://www.catb.org/esr/reposurgeon/repository-editing.html
+   #_reading_subversion_repositories   
+
+
+Adam Turner wrote a conversion Makefile and ``.lift`` scripts that
+downloads the repo from SF with rsync, converts it to a SVN mirror and
+finally to Git, splitting sandbox, prest, and web from docutils.
+
+
+Sourceforge supports multiple Git repositories per project, so we can
+switch the version control system independent of the decision on an
+eventual switch of the host.
+Cf. https://sourceforge.net/p/forge/documentation/Git/
 
-.. _Sphinx: http://sphinx.pocoo.org/
 
 General
 =======
 
-* Encoding of command line arguments can only be guessed:
+Miscellaneous
+-------------
+
+Code cleanup and modernization:
+  Use flake8_? See also the configuration in `<../../tox.ini>`__.
 
-  * try UTF-8/strict first, then try the locale's encoding with
-    strict error handling, then ASCII/replace?
+  Check and solve issue from  :PEP:`290` - Code Migration and Modernization.
+  (Covers issues up to Python 2.4, is there an equivalent for more recent
+  modernizations?)
 
-    UTF-8 is almost 100% safe to try first; false positives are rare,
-    The locale's encoding with strict error handling may be a
-    reasonable compromise, but any error would indicate that the
-    locale's encoding is inappropriate.  The only safe fallback is
-    ASCII/replace.
-
-  * Do not decode argv before option parsing but individual string
-    values?
-
-    +1  Allows for separate command-line vs. filesystem encodings,
-        respectively to keep file names encoded.
-    +1  Allows to configure command-line encoding in a config file,
-    -1  More complicated.
+  Ensure `backwards compatibility`_!
 
-  Cf. <http://thread.gmane.org/gmane.text.docutils.user/2890/focus=2957>.
+  .. _flake8: https://pypi.org/project/flake8/
+  .. _backwards compatibility: policies.html#backwards-compatibility-policy
 
 * Improve handling on Windows:
 
@@ -181,7 +222,7 @@
     for language-dependent features.
 
     Make this the default for output (as opposed to input)?
-    Throw an error with a helpfull message, e.g.
+    Throw an error with a helpful message, e.g.
 
       Default "contents" title for language %s missing, please specify
       an explicit title.
@@ -210,7 +251,7 @@
 
 * 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.
+  Currently, it is not used at all.
 
   Do we need it at all?  Or rather let the writers just ignore some
   nodes (like we already do for "class" values)?
@@ -337,7 +378,7 @@
 
 * Add testing for Docutils' front end tools?
 
-* Publisher: "Ordinary setup" shouldn't requre specific ordering; at
+* Publisher: "Ordinary setup" shouldn't require specific ordering; at
   the very least, there ought to be error checking higher up in the
   call chain.  Aahz
 
@@ -426,7 +467,7 @@
      http://thread.gmane.org/gmane.text.docutils.user/1112
 
 * Add a "disable_transforms" setting? Would allow for easy syntax
-  checking. Where ("null" writer, generic, parser(s), docutils-cli.py)?
+  checking. Where ("null" writer, generic, parser(s))?
   Cf. the `2004-02-18 "rest checking and source path"`_ thread.
 
 * Add a generic meta-stylesheet mechanism?  An external file could
@@ -525,7 +566,7 @@
   For example, top/bottom/side navigation bars for web pages.  Generic
   decorations?
 
-  Seems like a bad idea as long as it isn't independent from the ouput
+  Seems like a bad idea as long as it isn't independent from the output
   format (for example, navigation bars are only useful for web pages).
 
 * docutils_update: Check for a ``Makefile`` in a directory, and run
@@ -579,16 +620,17 @@
       .. figure:: image.png
          :name: figure name
 
-  Improve the mapping of "phrase references" to IDs/labels with
-  Literal transcription (i.e. ü -> ue, ß -> ss, å -> aa) instead of just
-  stripping the accents and other non-ASCII chars.
-  Use http://pypi.python.org/pypi/Unidecode?
+  Improve the mapping of "phrase references" to IDs/labels with Literal
+  transcription (i.e. ü -> ue, ß -> ss, å -> aa) instead of just
+  stripping the accents and other non-ASCII chars. See also the feature
+  request `allow more characters when transforming "names" to "ids"`__.
 
   A "table" directive has been implemented, supporting table titles.
 
   Perhaps the name could derive from the title/caption?
 
   .. _reference names: ../ref/rst/restructuredtext.html#reference-names
+  __ https://sourceforge.net/p/docutils/feature-requests/66/
 
 * We need syntax for object references.  Cf. `OpenOffice.org XML`_
   "reference fields":
@@ -624,18 +666,6 @@
 <http://www.loria.fr/~rougier/coding/article/rst2html.py>`__
 by Nicolas Rougier for a sample implementation.
 
-<meta> node
------------
-
-Up to 0.17, <meta> nodes are non-standard (not part of the Docutils
-document tree specification).
-
-The "Filter" transform removes "meta" nodes from the doctree unless the
-output format is "html" (rsp. "html", "latex", or "odt" since 0.17).
-
-Suggestion:
-  Make "meta" a generic directive and <meta> nodes standard nodes that
-  are kept in the doctree. Allow writers to ignore <meta> nodes.
 
 Documentation
 =============
@@ -656,8 +686,6 @@
 Developer Docs
 --------------
 
-* Complete `Docutils Runtime Settings <../api/runtime-settings.html>`_.
-
 * Improve the internal module documentation (docstrings in the code).
   Specific deficiencies listed below.
 
@@ -765,7 +793,7 @@
 
 * Should standalone strings also become (module/class) docstrings?
   Under what conditions?  We want to prevent arbitrary strings from
-  becomming docstrings of prior attribute assignments etc.  Assume
+  becoming docstrings of prior attribute assignments etc.  Assume
   that there must be no blank lines between attributes and attribute
   docstrings?  (Use lineno of NEWLINE token.)
 
@@ -929,7 +957,7 @@
 
 * Support generic hyperlink references to _`targets in other
   documents`?  Not in an HTML-centric way, though (it's trivial to say
-  ``http://www.example.com/doc#name``, and useless in non-HTML
+  ``https://www.example.org/doc#name``, and useless in non-HTML
   contexts).  XLink/XPointer?  ``.. baseref::``?  See Doc-SIG
   2001-08-10.
 
@@ -983,7 +1011,7 @@
   Appendix E ("Recommendations for Delimiting URI in Context") of `RFC
   2396`_.
 
-  .. _RFC 2396: http://www.rfc-editor.org/rfc/rfc2396.txt
+  .. _RFC 2396: https://www.rfc-editor.org/rfc/rfc2396.txt
 
 * Use the vertical spacing of the source text to determine the
   corresponding vertical spacing of the output?
@@ -1114,7 +1142,7 @@
   grid tables inside XML comments.
 
   .. _feature request 6:
-      http://sourceforge.net/p/docutils/feature-requests/6
+      https://sourceforge.net/p/docutils/feature-requests/6
   .. _list-table: ../ref/rst/directives.html#list-table
 
 
@@ -1131,7 +1159,7 @@
 
     Currently, `document.reporter` uses a state machine instance to
     determine the "source" and "line" info from
-    `statemachine.input_lines` if not given explicitely. Except for
+    `statemachine.input_lines` if not given explicitly. Except for
     special cases, the "line" argument is not needed because,
     `document.statemachine` keeps record of the current line number.
 
@@ -1143,7 +1171,7 @@
     too?  Add a set_info method?  To what?)
 
     The "source" (and line number in the source) can either be added
-    explicitely to the elements or determined from the “raw” line
+    explicitly to the elements or determined from the “raw” line
     number by `document.statemachine.get_source_and_line`.
 
   - Some line numbers in elements are not being set properly
@@ -1380,13 +1408,13 @@
 limited to):
 
 MathML_
-  Not for hand-written code but maybe usefull when pasted in (or included
+  Not for hand-written code but maybe useful when pasted in (or included
   from a file)
 
   For an overview of MathML implementations and tests, see, e.g.,
   the `mathweb wiki`_ or the `ConTeXT MathML page`_.
 
-  .. _MathML: http://www.w3.org/TR/MathML2/
+  .. _MathML: https://www.w3.org/TR/MathML2/
   .. _mathweb wiki: http://www.mathweb.org/wiki/MathML
   .. _ConTeXT MathML page: http://wiki.contextgarden.net/MathML
 
@@ -1420,7 +1448,7 @@
   .. _ASCIIMath tutorial:
      http://www.wjagray.co.uk/maths/ASCIIMathTutorial.html
   .. _ASCIIMathML: http://pypi.python.org/pypi/asciimathml/
-  .. _ASCIIMathPython: http://sourceforge.net/projects/asciimathpython/
+  .. _ASCIIMathPython: https://github.com/paulhtremblay/asciimathml
   __ http://fletcherpenney.net/multimarkdown/
 
 `Unicode Nearly Plain Text Encoding of Mathematics`_
@@ -1432,7 +1460,7 @@
    the Unicode Consortium.)
 
    .. _Unicode Nearly Plain Text Encoding of Mathematics:
-      http://www.unicode.org/notes/tn28/
+      https://www.unicode.org/notes/tn28/
 
 itex
   See `the culmination of a relevant discussion in 2003
@@ -1497,7 +1525,7 @@
     * the Unicode-Char <-> LaTeX mappings database unimathsymbols_
 
   __ http://msevior.livejournal.com/26377.html
-  .. _MathML: http://www.w3.org/TR/MathML2/
+  .. _MathML: https://www.w3.org/TR/MathML2/
   .. _ttm: http://hutchinson.belmont.ma.us/tth/mml/
   .. _TeX4ht: http://www.tug.org/applications/tex4ht/mn.html
   .. _MathToWeb:  http://www.mathtoweb.com/
@@ -1526,12 +1554,14 @@
   * TtH_ (C)
   * Hevea_ (Objective Caml)
   * `MathJax for Node`_
+  * KaTeX_
 
   __ http://www.cs.tut.fi/~jkorpela/math/
   __ http://www.zipcon.net/~swhite/docs/math/math.html
   .. _elyxer: http://elyxer.nongnu.org/
   .. _TtH: ttp://hutchinson.belmont.ma.us/tth/index.html
   .. _Hevea: http://para.inria.fr/~maranget/hevea/
+  .. _KaTeX: https://katex.org
 
 images
   (PNG or SVG) like e.g. Wikipedia.
@@ -1668,7 +1698,7 @@
     - Add support for inclusion by URL? ::
 
           .. include::
-             :url: http://www.example.org/inclusion.txt
+             :url: https://www.example.org/inclusion.txt
 
     - Strip blank lines from begin and end of a literal included file or
       file section. This would correspond to the way a literal block is
@@ -1726,7 +1756,7 @@
       "language by class attribute" does not change parsing (localized
       directives etc.), only supporting writers.
 
-    .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
+    .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
 
 
   - _`misc.settings`: Set any(?) Docutils runtime setting from within
@@ -1789,7 +1819,7 @@
 
     My first idea would be to add a set of conditional directives.
     Let's call them "writer-is" and "writer-is-not" for discussion
-    purposes (don't worry about implemention details).  We might
+    purposes (don't worry about implementation details).  We might
     have::
 
          .. writer-is:: text-only
@@ -2255,7 +2285,7 @@
   The advantage of the current way of doing things is that parse-time
   system messages don't require a transform; they're already in the
   document.  This is valuable for testing (unit tests,
-  tools/quicktest.py).  So if we do decide to make a change, I think
+  tools/dev/quicktest.py).  So if we do decide to make a change, I think
   the insertion of parse-time system messages ought to remain as-is
   and the Messages transform ought to move all parse-time system
   messages (remove from their originally inserted positions, insert in
@@ -2267,22 +2297,6 @@
 HTML Writer
 ===========
 
-* Make it easier to find out fragment names (#foo-bar) of ``_`inline
-  targets```.  Currently you have to either look at the source or
-  guess the fragment.
-
-  For example, we could add support for self-referencing targets
-  (i.e. inline targets would unobtrusively link to themselves, so
-  that you can just click them and then copy the address).  Or we
-  could add support for titles that display the fragment name (as in
-  <http://subversion.tigris.org/mailing-list-guidelines.html>; just
-  hover the paragraphs).
-
-  Either way it should be optional and deactivated by default.
-
-  This would be useful for documents like Docutils' bug list or to-do
-  list.
-
 * Make the _`list compacting` logic more generic: For example, allow
   for literal blocks or line blocks inside of compact list items.
 
@@ -2418,7 +2432,7 @@
 __ ../user/links.html#ePub
 .. _International Digital Publishing Forum: http://www.idpf.org/
 .. _electronic reading devices:
-   http://en.wikipedia.org/wiki/List_of_e-book_readers
+   https://en.wikipedia.org/wiki/List_of_e-book_readers
 
 
 LaTeX writer
@@ -2447,29 +2461,39 @@
 
 * Paragraph following field-list or table in compound is indented.
 
-  This is a problem with the current DUfieldlist definition and with
-  the use of "longtable" for tables.
-  See `LaTeX constructs and packages instead of re-implementations`_ for
-  alternatives.
+  This is a problem with the current DUfieldlist definition and with the
+  use of "longtable" for tables. See `other LaTeX constructs and packages
+  instead of re-implementations`_ for alternatives.
 
 
 Generate clean and configurable LaTeX source
 ----------------------------------------------
 
-* Check the generated source with package `nag`.
+Which packages do we want to use?
+
++ base and "recommended" packages
+
+  (packages that should be in a "reasonably sized and reasonably modern
+  LaTeX installation like the `texlive-latex-recommended` Debian package,
+  say):
+
++ No "fancy" or "exotic" requirements.
+
++ pointers to advanced packages and their use in the `latex writer
+  documentation`_.
 
 Configurable placement of figure and table floats
 `````````````````````````````````````````````````
 
 * Special class argument to individually place figures?
 
-  Either:
-
-    placement-<optional arg>  -> \figure<optional arg>{...}
+  Example::
 
-  e.g. ``.. class::  placement-htb``,
+    .. figure:: foo.pdf
+       :class: place-here-if-possible place-top place-bottom
 
-  or more verbose:
+  would be written as ``\figurehtb{...}`` with
+  the optional args:
 
   :H: place-here
   :h: place-here-if-possible
@@ -2477,120 +2501,78 @@
   :b: place-bottom
   :p: place-on-extra-page
 
-  e.g.: ``.. class:: place-here-if-possible place-top place-bottom``
-
-  Maybe support both variants?
-
-
-LaTeX constructs and packages instead of re-implementations
-```````````````````````````````````````````````````````````
-
-Which packages do we want to use?
-
-  + base and "recommended" packages
-
-    (packages that should be in a "reasonably sized and reasonably modern
-    LaTeX installation like the `texlive-latex-recommended` Debian package,
-    say):
-
-  + No "fancy" or "exotic" requirements.
-
-  + pointers to advanced packages and their use in the `latex writer
-    documentation`_.
-
-* footnotes
-
-  + True footnotes with LaTeX auto-numbering (as option ``--latex-footnotes``)
-    (also for target-footnotes):
+  Alternative: class value = "place-" + optional arg, e.g. ``:class:
+  place-htb``.
 
-    - attach footnote text to footnote-symobol node
-    - write \footnote{<footnote text>}
-    - consider cases where LaTeX does not support footnotes
-      (inside tables, headings, ...)?
-    - consider multiple footnote refs to common footnote text.
-
-    .. Quote:
-
-     If the symbol you want is not one of the ones listed, you'll need to
-     redefine ``\@fnsymbol`` and add it, e.g. perhaps like::
-
-      \def\@fnsymbol#1{\ifcase#1\hbox{}\or *\or \dagger\or \ddagger\or
-      \mathchar "278\or \mathchar "27B\or \|\or **\or \dagger\dagger \or
-      \ddagger\ddagger \or \mathchar"27C \else\@ctrerr\fi\relax}
-
-     which would allow \symbolfootnote10{footnote} to have a club as its
-     mark.
-
-  + document customization (links to how-to and packages):
+Footnotes
+`````````
 
-  .. Footnote packages:
++ True footnotes with LaTeX auto-numbering (as option ``--latex-footnotes``)
+  (also for target-footnotes):
+  Write ``\footnote{<footnote content>}`` at the place of the
+  ``<footnote_reference>`` node.
 
-     :footnote: texlive-latex-recommended % savenotes environment
-     :footmisc: texlive-latex-extra       % formatting options
-     :manyfoot: texlive-latex-extra
-     :bigfoot: texlive-latex-extra
-     :perpage: texlive-latex-extra
-     :ftnxtra: new on CTAN
-               fixes the issue of footnote inside \caption{},
-               tabular environment and \section{} like commands.
++ Open questions:
 
+  - Load hyperref_ with option "hyperfootnotes" and/or
+    package footnotebackref_ or leave this to the user?
 
-     German tutorial:
-     http://www2.informatik.hu-berlin.de/~ahamann/studies/footnotes.pdf
+  - Consider cases where LaTeX does not support footnotes
+    (inside tables__, headings__, caption, ...).
+    Use ftnxtra_, tabularx_, tabulary_, longtable_?
 
-  .. Footnote FAQs:
+    __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footintab
+    __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftnsect
 
-     `Footnotes whose texts are identical
-     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=repfootnote>`__
+  - Consider `multiple footnote refs to common footnote text`__.
 
-     * label per hand or use footmisc
+    KOMA-script classes and the KOMA scrextend_ package provide
+    ``\footref`` that can be used for additional references to a
+    ``\label``-ed footnote. Since 2021-05-01, ``\footref`` is provided
+    by the LaTeX core, too.
 
-     `More than one sequence of footnotes
-     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multfoot>`__
+    __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multfoot
 
-     * manyfoot, bigfoot
+  - Consider numbered vs. symbolic footnotes.
 
-     `Footnotes in tables
-     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footintab>`__
++ document customization (links to how-to and packages)
 
-     * `tabularx` and longtable allow footnotes.
-     * `footnote` provides a "savenotes" environment which collects all
-       footnotes and emits them at ``end{savenotes}``
+.. Footnote packages at CTAN (www.ctan.org/pkg/<packagename>):
 
-     `Footnotes in LaTeX section headings
-     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftnsect>`__
+   :footnote: provides a "savenotes" environment which collects all
+              footnotes and emits them at ``end{savenotes}``
+              (texlive-latex-recommended)
 
-     * Take advantage of the fact that the mandatory argument doesn't
-       move if the optional argument is present::
+   :ftnxtra_: fixes the issue of footnote inside \caption{},
+             tabular environment and \section{} like commands.
 
-           \sectiontitle {title\footnote{title ftnt}}
+   :footnotebackref_: bidirectional links to/from footnote mark to
+                      footnote text.
 
-     * Use the footmisc package, with package option stable - this modifies
-       footnotes so that they softly and silently vanish away if used in a
-       moving argument.
+.. Footnote Discussion:
 
-     * Use ftnxtra.
+   `German tutorial
+   <http://www2.informatik.hu-berlin.de/~ahamann/studies/footnotes.pdf>`__
 
-     `Footnotes numbered per page
-     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footnpp>`__
+   `wikibooks: footnote workarounds
+   <https://en.wikibooks.org/wiki/LaTeX/Footnotes_and_Margin_Notes#Common_problems_and_workarounds>`__
 
-     * perpage provides a general mechanism for resetting counters per page
-     * footmisc provides a package option perpage
+.. _footnotebackref: https://www.ctan.org/pkg/footnotebackref
+.. _ftnxtra: https://www.ctan.org/pkg/ftnxtra
+.. _hyperref: https://www.ctan.org/pkg/hyperref
+.. _longtable: https://www.ctan.org/pkg/longtable
+.. _scrextend: https://www.ctan.org/pkg/longtable
+.. _tabularx: https://www.ctan.org/pkg/tabularx
 
-* use `eqlist` or `enumitem` (texlive-latex-extra) for field-lists?
 
-* ``--use-latex-when-possible`` »super option« that would set the
-  following::
+Other LaTeX constructs and packages instead of re-implementations
+`````````````````````````````````````````````````````````````````
 
-      --no-section-numbering
-      --use-latex-toc
-      --use-latex-docinfo
-      --use-latex-abstract
-      --use-latex-footnotes
-      --use-latex-citations
+* Check the generated source with package `nag`.
 
-   ? (My preference is to default to use-latex-* whenever possible GM)
+* enumitem_ (texlive-latex-extra) for field-lists?
 
+.. _enumitem: https://www.ctan.org/pkg/enumitem
 
 Default layout
 --------------
@@ -2624,12 +2606,8 @@
      -  \\ % subtitle%
      +  \\0.5em % subtitle%
 
-.. _PSNFSS documentation:
-   http://mirror.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf
 .. _compound paragraph:
    ../ref/rst/directives.html#compound-paragraph
-.. _fixltx2e:
-   http://mirror.ctan.org/help/Catalogue/entries/fixltx2e.html
 
 Tables
 ``````
@@ -2642,8 +2620,7 @@
   + use tabularx column type ``X`` and let LaTeX decide width, or
   + use tabulary_?
 
-  .. _tabulary:
-     http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=tabulary
+  .. _tabulary: https://www.ctan.org/pkg/tabulary
 
 * From comp.text.tex (13. 4. 2011):
 
@@ -2751,22 +2728,6 @@
 
 .. _bibstuff: http://code.google.com/p/bibstuff/
 
-Allow choice between utf8 (standard) and utf8x (extended) encodings
-```````````````````````````````````````````````````````````````````
-
-* Allow the user to select *utf8* or *utf8x* LaTeX encoding. (Docutil's
-  output encoding becomes LaTeX's input encoding.)
-
-The `ucs` package provides extended support for UTF-8 encoding in LaTeX
-via the `inputenc`-option ``utf8x``.  It is, however, a non-standard
-extension and no longer developed.
-
-Ideas:
-  a) Python has 4 names for the UTF-8 encoding (``utf_8, U8, UTF, utf8``)
-     give a special meaning to one of the aliases,
-
-  b) scan "stylesheets" and "latex-preamble" options and use ``utf8x``
-     if it contains ``ucs``
 
 XeTeX writer
 ````````````
@@ -2805,7 +2766,7 @@
 
 The following fails::
 
-    \href{http://www.w3.org/XML/Schema^^dev}{\fragileURLi}
+    \href{https://www.w3.org/XML/Schema^^dev}{\fragileURLi}
 
 Use %-replacement like http://nowhere/url_with%28parens%29 ?
 
@@ -2839,7 +2800,7 @@
 and an external stylesheet:
 
     rstpep2html.py --add-stylesheet-path custom.css \
-        --add-stylesheet http://www.example.org/external.css ...
+        --add-stylesheet https://www.example.org/external.css ...
 
 This run will use only the second custom stylesheet:
 
@@ -2852,45 +2813,6 @@
 Front-End Tools
 ===============
 
-* 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.
-
-  Perhaps have different types of front ends:
-
-  a) _`Fully qualified`: Reader and Writer are hard-coded into the
-     front end (e.g. ``pep2html options``, ``pysource2pdf
-     options``).
-
-  b) _`Partially qualified`: Reader is hard-coded, and the Writer is
-     specified a sub-command (e.g. ``pep2 html options``,
-     ``pysource2 pdf options``).  The Writer is known before option
-     processing happens, allowing the OptionParser to be built
-     dynamically.  Alternatively, the Writer could be hard-coded and
-     the Reader specified as a sub-command (e.g. ``htmlfrom pep
-     options``).
-
-  c) _`Unqualified`: Reader and Writer are specified as subcommands
-     (e.g. ``publish pep html options``, ``publish pysource pdf
-     options``).  A single front end would be sufficient, but
-     probably only useful for testing purposes.
-
-  d) _`Dynamic`: Reader and/or Writer are specified by options, with
-     defaults if unspecified (e.g. ``publish --writer manpage
-     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
-  anyway, so there's no advantage (we can't use it to avoid
-  conflicts) to splitting common and component-specific options
-  apart.
-
 * Parameterize help text & defaults somehow?  Perhaps a callback?  Or
   initialize ``settings_spec`` in ``__init__`` or ``init_options``?
 
@@ -2901,12 +2823,22 @@
   directive should override the ``--no-section-numbering`` command
   line option then.
 
+* Implement the following suggestions from clig.dev?
+
+     Display output on success, but keep it brief.
+     provide a --quiet option to suppress all non-essential output.
+   
+     Consider chaining several args as input and use --output
+     (or redirection) for output.
+   
+     -- https://clig.dev/#help
+
 .. _partial parsing:
    https://docs.python.org/3/library/argparse.html#partial-parsing
 
-
 .. _configuration: ../user/config.html
-.. _transforms: ../ref/transforms.html
+.. _transforms: ../api/transforms.html
+
 
 &#xc;
 ..

_service:tar_scm:docutils-0.17.1.tar.gz/docs/dev/website.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/dev/website.txt Changed

@@ -1,15 +1,17 @@
+.. include:: ../header.txt
+
 ===================
  Docutils Web Site
 ===================
 
 :Author: David Goodger; open to all Docutils developers
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2017-07-05 16:33:33 +0200 (Mi, 05. Jul 2017) $
-:Revision: $Revision: 8133 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
 :Copyright: This document has been placed in the public domain.
 
-The Docutils web site, <http://docutils.sourceforge.net/>, is
-maintained by the ``docutils-update.local`` script, run by project 
+The Docutils web site, <https://docutils.sourceforge.io/>, is
+maintained by the ``docutils-update.local`` script, run by project
 maintainers on their local machines.  The script
 will process any .txt file which is newer than the corresponding .html
 file in the local copy of the project's web directory and upload the changes
@@ -17,7 +19,7 @@
 
 ..  .. old instructions, for cron job:
 
-    The Docutils web site, <http://docutils.sourceforge.net/>, is
+    The Docutils web site, <https://docutils.sourceforge.io/>, is
     maintained automatically by the ``docutils-update`` script, run as an
     hourly cron job on shell.berlios.de (by user "wiemann").  The script
     will process any .txt file which is newer than the corresponding .html
@@ -34,13 +36,13 @@
 The docutils-update.local__ script is located at
 ``sandbox/infrastructure/docutils-update.local``.
 
-__ http://docutils.sf.net/sandbox/infrastructure/docutils-update.local
+__ https://docutils.sourceforge.io/sandbox/infrastructure/docutils-update.local
 
 If you want to share files via the web, you can upload them using the
 uploaddocutils.sh__ script
 (``sandbox/infrastructure/uploaddocutils.sh``).
 
-__ http://docutils.sf.net/sandbox/infrastructure/uploaddocutils.sh
+__ https://docutils.sourceforge.io/sandbox/infrastructure/uploaddocutils.sh
 
 
 Setting Up
@@ -48,7 +50,7 @@
 
 (TBA)
 
-.. hint:: 
+.. hint::
   Anyone with checkin privileges can be a web-site maintainer. You need to
   set up the directories for a local website build.
 
@@ -92,10 +94,10 @@
 
 #. Remove to-be-generated HTML files from
    ``sandbox/infrastructure/htmlfiles.lst``.
-  
+
 #. Removing files and directories from SVN will not trigger their removal
    from the web site.  Files and directories must be manually removed from
-   sourceforge.net (under ``/home/project-web/docutils/htdocs/``). 
+   sourceforge.net (under ``/home/project-web/docutils/htdocs/``).
 
 &#xc;
 ..

_service:tar_scm:docutils-0.20.tar.gz/docs/header.txt Added

_service:tar_scm:docutils-0.20.tar.gz/docs/header0.txt Added

_service:tar_scm:docutils-0.20.tar.gz/docs/header2.txt Added

_service:tar_scm:docutils-0.20.tar.gz/docs/howto/cmdline-tool.txt Added

@@ -0,0 +1,68 @@
+.. include:: ../header.txt
+
+===============================================
+ Inside A Docutils Command-Line Front-End Tool
+===============================================
+
+:Author: David Goodger
+:Contact: docutils-develop@lists.sourceforge.net
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
+:Copyright: This document has been placed in the public domain.
+
+`The Docutils Publisher`_ class was set up to make building
+command-line tools easy.  All that's required is to choose components
+and supply settings for variations.  Let's take a look at a typical
+command-line front-end tool, ``tools/rst2html.py``, from top to
+bottom.
+
+On Unixish systems, it's best to make the file executable (``chmod +x
+file``), and supply an interpreter on the first line, the "shebang" or
+"hash-bang" line::
+
+    #!/usr/bin/env python
+
+Windows systems can be set up to associate the Python interpreter with
+the ``.py`` extension.
+
+Next are some comments providing metadata::
+
+    # $Id: cmdline-tool.txt 9051 2022-04-02 21:59:06Z milde $
+    # Author: David Goodger <goodger@python.org>
+    # Copyright: This module has been placed in the public domain.
+
+The module docstring describes the purpose of the tool::
+
+    """
+    A minimal front end to the Docutils Publisher, producing HTML.
+    """
+
+This next block attempts to invoke locale support for
+internationalization services, specifically text encoding.  It's not
+supported on all platforms though, so it's forgiving::
+
+    try:
+        import locale
+        locale.setlocale(locale.LC_ALL, '')
+    except:
+        pass
+
+The real work will be done by the code that's imported here::
+
+    from docutils.core import publish_cmdline, default_description
+
+We construct a description of the tool, for command-line help::
+
+    description = ('Generates (X)HTML documents from standalone '
+                   'reStructuredText sources.  ' + default_description)
+
+Now we call the Publisher convenience function, which takes over.
+Most of its defaults are used ("standalone" Reader,
+"reStructuredText" Parser, etc.).  The HTML Writer is chosen by name,
+and a description for command-line help is passed in::
+
+    publish_cmdline(writer_name='html', description=description)
+
+That's it!  `The Docutils Publisher`_ takes care of the rest.
+
+.. _The Docutils Publisher: ./publisher.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/howto/html-stylesheets.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/howto/html-stylesheets.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/howto/i18n.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/howto/i18n.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ================================
  Docutils_ Internationalization
 ================================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2020-01-26 22:23:42 +0100 (So, 26. Jän 2020) $
-:Revision: $Revision: 8467 $
+:Date: $Date: 2022-07-29 13:56:58 +0200 (Fr, 29. Jul 2022) $
+:Revision: $Revision: 9118 $
 :Copyright: This document has been placed in the public domain.
 
 
@@ -35,9 +37,9 @@
 .. # If anything in Docutils is insufficiently parameterized, it
    should be considered a bug.  Please report bugs to the Docutils
    project bug tracker on SourceForge at
-   http://sourceforge.net/p/docutils/bugs/
+   https://sourceforge.net/p/docutils/bugs/
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 .. _Introduction to i18n:
    http://www.debian.org/doc/manuals/intro-i18n/
 
@@ -65,8 +67,8 @@
 .. # Subtags are separated from primary tags by underscores instead
    of hyphens, to conform to Python naming rules.
 
-.. _language tags: http://www.w3.org/International/articles/language-tags/
-.. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
+.. _language tags: https://www.w3.org/International/articles/language-tags/
+.. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
 .. _ISO 639: http://www.loc.gov/standards/iso639-2/php/English_list.php
 .. _ISO 3166: http://www.iso.ch/iso/en/prods-services/iso3166ma/
    02iso-3166-code-lists/index.html
@@ -86,22 +88,22 @@
 ``labels``
     This is a mapping of node class names to language-dependent
     boilerplate label text.  The label text is used by Writer
-    components when they encounter document tree elements whose class
-    names are the mapping keys.
+    components when they encounter `document tree`_ elements whose
+    `class names`_ are the mapping keys.
 
-    The entry values (*not* the keys) should be translated to the
+    The entry **values** (*not* the keys) should be translated to the
     target language.
 
 ``bibliographic_fields``
     This is a mapping of language-dependent field names (converted to
     lower case) to canonical field names (keys of
     ``DocInfo.biblio_notes`` in ``docutils.transforms.frontmatter``).
-    It is used when transforming bibliographic fields.
+    It is used when transforming `bibliographic fields`_.
 
-    The keys should be translated to the target language.
+    The **keys** should be translated to the target language.
 
 ``author_separators``
-    This is a list of strings used to parse the 'Authors'
+    This is a list of strings used to parse the 'Authors_'
     bibliographic field.  They separate individual authors' names, and
     are tried in order (i.e., earlier items take priority, and the
     first item that matches wins).  The English-language module
@@ -110,6 +112,15 @@
 
     Most languages won't have to "translate" this list.
 
+.. _document tree:
+    ../ref/doctree.html
+.. _class names:
+    ../ref/doctree.html#element-reference
+.. _authors:
+    .. ref/doctree.html#authors
+.. _bibliographic fields:
+    ../ref/rst/restructuredtext.html#bibliographic-fields
+
 
 reStructuredText Language Module
 ================================
@@ -125,8 +136,9 @@
 ``directives``
     This is a mapping from language-dependent directive names to
     canonical directive names.  The canonical directive names are
-    registered in ``docutils/parsers/rst/directives/__init__.py``, in
-    ``_directive_registry``.
+    registered in ``docutils/parsers/rst/directives/__init__.py``,
+    in ``_directive_registry`` and documented in
+    `reStructuredText Directives`_.
 
     The keys should be translated to the target language.  Synonyms
     (multiple keys with the same values) are allowed; this is useful
@@ -134,14 +146,18 @@
 
 ``roles``
     This is a mapping language-dependent role names to canonical role
-    names for interpreted text.  The canonical directive names are
+    names for interpreted text.  The canonical role names are
     registered in ``docutils/parsers/rst/states.py``, in
-    ``Inliner._interpreted_roles`` (this may change).
+    ``Inliner._interpreted_roles`` (this may change) and documented
+    in `reStructuredText Interpreted Text Roles`_.
 
     The keys should be translated to the target language.  Synonyms
     (multiple keys with the same values) are allowed; this is useful
     for abbreviations.
 
+.. _reStructuredText Directives: ../ref/rst/directives.html
+.. _reStructuredText Interpreted Text Roles: ../ref/rst/roles.html
+
 
 Testing the Language Modules
 ============================
@@ -175,4 +191,4 @@
 language modules, feel free to submit them via the `SourceForge patch
 tracker`__.
 
-__ http://sourceforge.net/p/docutils/patches/
+__ https://sourceforge.net/p/docutils/patches/

_service:tar_scm:docutils-0.17.1.tar.gz/docs/howto/rst-directives.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/howto/rst-directives.txt Changed

@@ -1,14 +1,16 @@
+.. include:: ../header.txt
+
 =======================================
  Creating reStructuredText_ Directives
 =======================================
 
 :Authors: Dethe Elza, David Goodger, Lea Wiemann
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
-:Revision: $Revision: 7302 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
 :Copyright: This document has been placed in the public domain.
 
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 
 
 Directives are the primary extension mechanism of reStructuredText.
@@ -194,7 +196,7 @@
   of integers into a Python list of integers.  Raises ValueError for
   non-positive-integer values.
 
-- ``encoding``: Verfies the encoding argument by lookup.  Raises
+- ``encoding``: Verifies the encoding argument by lookup.  Raises
   ValueError for unknown encodings.
 
 A further utility function, ``choice``, is supplied to enable
@@ -377,7 +379,7 @@
     from docutils.parsers.rst import Directive
 
     def align(argument):
-        """Conversion function for the "align" option.""" 
+        """Conversion function for the "align" option."""
         return directives.choice(argument, ('left', 'center', 'right'))
 
     class Image(Directive):
@@ -426,5 +428,5 @@
 of the ``contents`` directive in
 docutils.parsers.rst.directives.parts__.
 
-.. _transform: ../ref/transforms.html
-__ http://docutils.sf.net/docutils/parsers/rst/directives/parts.py
+.. _transform: ../api/transforms.html
+__ https://docutils.sourceforge.io/docutils/parsers/rst/directives/parts.py

_service:tar_scm:docutils-0.17.1.tar.gz/docs/howto/rst-roles.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/howto/rst-roles.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ==================================================
  Creating reStructuredText Interpreted Text Roles
 ==================================================
 
 :Authors: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
-:Revision: $Revision: 7302 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
+:Revision: $Revision: 9051 $
 :Copyright: This document has been placed in the public domain.
 
 Interpreted text roles are an extension mechanism for inline markup in
@@ -33,10 +35,10 @@
 any additional processing required.  Its signature is as follows::
 
     def role_fn(name, rawtext, text, lineno, inliner,
-                options={}, content=):
+                options=None, content=None):
         code...
 
-    # Set function attributes for customization:
+    # Optional function attributes for customization:
     role_fn.options = ...
     role_fn.content = ...
 
@@ -46,13 +48,14 @@
 * ``name``: The local name of the interpreted role, the role name
   actually used in the document.
 
-* ``rawtext``: A string containing the enitre interpreted text input,
+* ``rawtext``: A string containing the entire interpreted text input,
   including the role and markup.  Return it as a ``problematic`` node
   linked to a system message if a problem is encountered.
 
 * ``text``: The interpreted text content.
 
-* ``lineno``: The line number where the interpreted text begins.
+* ``lineno``: The line number where the text block containing the
+  interpreted text begins.
 
 * ``inliner``: The ``docutils.parsers.rst.states.Inliner`` object that
   called role_fn.  It contains the several attributes useful for error
@@ -126,7 +129,7 @@
        roles.register_canonical_role(name, role_function)
 
    This code is normally placed immediately after the definition of
-   the role funtion.
+   the role function.
 
 2. Add an entry to the ``roles`` dictionary in
    ``docutils/parsers/rst/languages/en.py`` for the role, mapping the
@@ -187,10 +190,14 @@
 Here is the implementation of the role::
 
     def rfc_reference_role(role, rawtext, text, lineno, inliner,
-                           options={}, content=):
+                           options=None, content=None):
+        if "#" in text:
+            rfcnum, section = utils.unescape(text).split("#", 1)
+        else:
+            rfcnum, section  = utils.unescape(text), None
         try:
-            rfcnum = int(text)
-            if rfcnum <= 0:
+            rfcnum = int(rfcnum)
+            if rfcnum < 1:
                 raise ValueError
         except ValueError:
             msg = inliner.reporter.error(
@@ -200,8 +207,10 @@
             return prb, msg
         # Base URL mainly used by inliner.rfc_reference, so this is correct:
         ref = inliner.document.settings.rfc_base_url + inliner.rfc_url % rfcnum
-        set_classes(options)
-        node = nodes.reference(rawtext, 'RFC ' + utils.unescape(text), refuri=ref,
+        if section is not None:
+            ref += "#"+section
+        options = normalize_role_options(options)
+        node = nodes.reference(rawtext, 'RFC ' + str(rfcnum), refuri=ref,
                                **options)
         return node,

_service:tar_scm:docutils-0.17.1.tar.gz/docs/howto/security.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/howto/security.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/index.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/index.txt Changed

@@ -1,199 +1,210 @@
 ==========================================
- Docutils_ Project Documentation Overview
+ Docutils Project Documentation Overview
 ==========================================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Date: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
-:Revision: $Revision: 8644 $
+:Date: $Date: 2023-04-08 23:09:08 +0200 (Sa, 08. Apr 2023) $
+:Revision: $Revision: 9340 $
 :Copyright: This document has been placed in the public domain.
 
 The latest working documents may be accessed individually below, or
 from the ``docs`` directory of the `Docutils distribution`_.
 
-.. _Docutils: http://docutils.sourceforge.net/
-.. _Docutils distribution: http://docutils.sourceforge.net/#download
+.. _Docutils distribution: https://docutils.sourceforge.io/#download
 
-.. contents::
-
-
-Docutils Stakeholders
-=====================
-
-Docutils stakeholders can be categorized in several groups:
+.. header::
+   Docutils_ | Overview | About__ | Users__ | Reference__ | Developers__
 
-1. End-users: users of reStructuredText and the Docutils tools.
-   Although some are developers (e.g. Python developers utilizing
-   reStructuredText for docstrings in their source), many are not.
+.. _Docutils: https://docutils.sourceforge.io/
+__ `project fundamentals`_
+__ user_
+__ ref_
+__ howto_
 
-2. Client-developers: developers using Docutils as a library,
-   programmers developing *with* Docutils.
 
-3. Component-developers: those who implement application-specific
-   components, directives, and/or roles, separately from Docutils.
-
-4. Core-developers: developers of the Docutils codebase and
-   participants in the Docutils project community.
-
-5. Re-implementers: developers of alternate implementations of
-   Docutils.
-
-There's a lot of overlap between these groups.  Most (perhaps all)
-core-developers, component-developers, client-developers, and
-re-implementers are also end-users.  Core-developers are also
-client-developers, and may also be component-developers in other
-projects.  Component-developers are also client-developers.
+.. contents::
 
 
 Project Fundamentals
 ====================
 
-These files are for all Docutils stakeholders.  They are kept at the
+These files are for all `Docutils stakeholders`_.  They are kept at the
 top level of the Docutils project directory.
 
-:README.txt_: Project overview: quick-start, requirements,
-              installation, and usage.
-:COPYING.txt_: Conditions for Docutils redistribution, with links to
-               licenses.
-:FAQ.txt_: Docutils Frequently Asked Questions.  If you have a
+.. class:: narrow run-in
+
+:README_:  Project overview: quick-start, requirements,
+           installation, and usage.
+:COPYING_: Conditions for Docutils redistribution, with links to
+           licenses.
+:FAQ_:     Docutils Frequently Asked Questions.  If you have a
            question or issue, there's a good chance it's already
            answered here.
-:BUGS.txt_: A list of known bugs, and how to report a bug.
-:RELEASE-NOTES.txt_: Summary of the major changes in recent releases.
-:HISTORY.txt_: Detailed change history log.
-:THANKS.txt_: Acknowledgements.
-
-.. _README.txt: ../README.html
-.. _BUGS.txt: ../BUGS.html
-.. _COPYING.txt: ../COPYING.html
+:BUGS_:    A list of known bugs, and how to report a bug.
+:RELEASE-NOTES_: Summary of the major changes in recent releases and
+           notice of future incompatible changes.
+:HISTORY_: Detailed change history log.
+:THANKS_:  Acknowledgements.
+
+.. _README: ../README.html
+.. _BUGS: ../BUGS.html
+.. _COPYING: ../COPYING.html
 .. _Docutils FAQ:
-.. _FAQ.txt: ../FAQ.html
-.. _RELEASE-NOTES.txt: ../RELEASE-NOTES.html
-.. _HISTORY.txt: ../HISTORY.html
-.. _THANKS.txt: ../THANKS.html
+.. _FAQ: ../FAQ.html
+.. _RELEASE-NOTES: ../RELEASE-NOTES.html
+.. _HISTORY: ../HISTORY.html
+.. _THANKS: ../THANKS.html
 
 
-.. _user:
+.. _docutils stakeholders:
+.. class:: details
 
-``user/``: Introductory & Tutorial Material for End-Users
-=========================================================
+Docutils Stakeholders …
+    can be categorized in several groups:
 
-Docutils-general:
+    End-users:
+       users of reStructuredText and the Docutils tools.
+       Although some are developers (e.g. Python developers utilizing
+       reStructuredText for docstrings in their source), many are not.
 
-* `Docutils Front-End Tools <user/tools.html>`__
-* `Docutils Configuration <user/config.html>`__
-* `Docutils Mailing Lists <user/mailing-lists.html>`__
-* `Docutils Link List <user/links.html>`__
+    Client-developers:
+       developers using Docutils as a library,
+       programmers developing *with* Docutils.
 
-Writer-specific:
+    Component-developers:
+       those who implement application-specific components,
+       directives, and/or roles, separately from Docutils.
 
-* `Docutils HTML writers <user/html.html>`__
-* `Easy Slide Shows With reStructuredText & S5 <user/slide-shows.html>`__
-* `Docutils LaTeX Writer <user/latex.html>`__
-* `Docutils ODF/OpenOffice/odt Writer <user/odt.html>`__
+    Core-developers:
+       developers of the Docutils codebase and participants
+       in the Docutils project community.
 
-`reStructuredText <http://docutils.sourceforge.net/rst.html>`_:
+    Re-implementers:
+       developers of alternate implementations of Docutils.
 
-* `A ReStructuredText Primer <user/rst/quickstart.html>`__
-  (see also the `text source <user/rst/quickstart.txt>`__)
-* `Quick reStructuredText <user/rst/quickref.html>`__ (user reference)
-* `reStructuredText Cheat Sheet <user/rst/cheatsheet.txt>`__ (text
-  only; 1 page for syntax, 1 page directive & role reference)
-* `reStructuredText Demonstration <user/rst/demo.html>`_ (a
-  demonstration of most reStructuredText features; you can also have a
-  look at the `text source <user/rst/demo.txt>`__)
+    There's a lot of overlap between these groups.  Most (perhaps all)
+    core-developers, component-developers, client-developers, and
+    re-implementers are also end-users.  Core-developers are also
+    client-developers, and may also be component-developers in other
+    projects.  Component-developers are also client-developers.
 
-Editor support:
 
-* `Emacs support for reStructuredText <user/emacs.html>`_
+.. _user:
+
+Introductory & Tutorial Material for End-Users
+==============================================
+
+Docutils-general:
+  * `Docutils Front-End Tools <user/tools.html>`__
+  * `Docutils Configuration <user/config.html>`__
+  * `Docutils Mailing Lists <user/mailing-lists.html>`__
+  * `Docutils Link List <user/links.html>`__
+
+Writer-specific:
+  * `Docutils HTML Writers <user/html.html>`__
+  * `Easy Slide Shows With reStructuredText & S5 <user/slide-shows.html>`__
+  * `Docutils LaTeX Writer <user/latex.html>`__
+  * `Man Page Writer for Docutils <user/manpage.html>`__
+  * `Docutils ODF/OpenOffice/odt Writer <user/odt.html>`__
+
+`reStructuredText <https://docutils.sourceforge.io/rst.html>`_:
+  * `A ReStructuredText Primer <user/rst/quickstart.html>`__
+    (see also the `text source <user/rst/quickstart.txt>`__)
+  * `Quick reStructuredText <user/rst/quickref.html>`__ (user reference)
+  * `reStructuredText Cheat Sheet <user/rst/cheatsheet.txt>`__ (text
+    only; 1 page for syntax, 1 page directive & role reference)
+  * `Demonstration <user/rst/demo.html>`_
+    of most reStructuredText features
+    (see also the `text source <user/rst/demo.txt>`__)
+
+Editor support:
+  * `Emacs support for reStructuredText <user/emacs.html>`_
 
 
 .. _ref:
 
-``ref/``: Reference Material for All Groups
-===========================================
+Reference Material for All Groups
+=================================
 
 Many of these files began as developer specifications, but now that
 they're mature and used by end-users and client-developers, they have
 become reference material.  Successful specs evolve into refs.
 
 Docutils-general:
-
-* `The Docutils Document Tree <ref/doctree.html>`__ (incomplete)
-* `Docutils Transforms <ref/transforms.html>`__
-* `Docutils Generic DTD <ref/docutils.dtd>`__
-* `OASIS XML Exchange Table Model Declaration Module
-  <ref/soextblx.dtd>`__ (CALS tables DTD module)
-
-Although not in the "ref" directory, `PEP 258`_ is a must-read
-reference for any Docutils developer.
+  * `The Docutils Document Tree <ref/doctree.html>`__ (incomplete)
+  * `Docutils Generic DTD <ref/docutils.dtd>`__
+  * `OASIS XML Exchange Table Model Declaration Module
+    <ref/soextblx.dtd>`__ (CALS tables DTD module)
+  * `Docutils Design Specification`_ (PEP 258)
 
 reStructuredText_:
+  * `An Introduction to reStructuredText <ref/rst/introduction.html>`__
+    (includes the `Goals <ref/rst/introduction.html#goals>`__ and
+    `History <ref/rst/introduction.html#history>`__ of reStructuredText)
+  * `reStructuredText Markup Specification <ref/rst/restructuredtext.html>`__
+  * `reStructuredText Directives <ref/rst/directives.html>`__
+  * `reStructuredText Interpreted Text Roles <ref/rst/roles.html>`__
+  * `reStructuredText Standard Definition Files
+    <ref/rst/definitions.html>`_
+  * `LaTeX syntax for mathematics <ref/rst/mathematics.html>`__
+    (syntax used in "math" directive and role)
 
-* `An Introduction to reStructuredText <ref/rst/introduction.html>`__
-  (includes the `Goals <ref/rst/introduction.html#goals>`__ and
-  `History <ref/rst/introduction.html#history>`__ of reStructuredText)
-* `reStructuredText Markup Specification <ref/rst/restructuredtext.html>`__
-* `reStructuredText Directives <ref/rst/directives.html>`__
-* `reStructuredText Interpreted Text Roles <ref/rst/roles.html>`__
-* `reStructuredText Standard Definition Files
-  <ref/rst/definitions.html>`_
-
-Prehistoric:
-
-* `Setext Documents Mirror
-  <http://docutils.sourceforge.net/mirror/setext.html>`__
+.. _peps:
 
+Python Enhancement Proposals
+  * `PEP 256: Docstring Processing System Framework`__ is a high-level
+    generic proposal.  :PEP:`256` in the `master repository`_
+  * `PEP 257: Docstring Conventions`__ addresses docstring style and
+    touches on content.  :PEP:`257` in the `master repository`_
+  * `PEP 258: Docutils Design Specification`__ is an overview of the
+    architecture of Docutils.  It documents design issues and
+    implementation details.  :PEP:`258` in the `master repository`_
+  * `PEP 287: reStructuredText Docstring Format`__ proposes a standard
+    markup syntax.  :PEP:`287` in the `master repository`_
+
+  Please note that PEPs in the `master repository`_ developed
+  independent from the local versions after submission.
+
+  __ peps/pep-0256.html
+  __ peps/pep-0257.html
+  .. _PEP 258:
+  .. _Docutils Design Specification:
+  __ peps/pep-0258.html
+  __ peps/pep-0287.html
+  .. _master repository: https://peps.python.org
 
-.. _peps:
+Prehistoric:
+  `Setext Documents Mirror`__
 
-``peps/``: Python Enhancement Proposals
-=======================================
-
-* `PEP 256: Docstring Processing System Framework`__ is a high-level
-  generic proposal.  `PEP 256`__ in the `master repository`_
-* `PEP 257: Docstring Conventions`__ addresses docstring style and
-  touches on content.  `PEP 257`__ in the `master repository`_
-* `PEP 258: Docutils Design Specification`__ is an overview of the
-  architecture of Docutils.  It documents design issues and
-  implementation details.  `PEP 258`__ in the `master repository`_
-* `PEP 287: reStructuredText Docstring Format`__ proposes a standard
-  markup syntax.  `PEP 287`__ in the `master repository`_
-
-Please note that PEPs in the `master repository`_ may not be current,
-whereas the local versions are.
-
-__ peps/pep-0256.html
-__ http://www.python.org/peps/pep-0256.html
-__ peps/pep-0257.html
-__ http://www.python.org/peps/pep-0257.html
-.. _PEP 258:
-__ peps/pep-0258.html
-__ http://www.python.org/peps/pep-0258.html
-__ peps/pep-0287.html
-__ http://www.python.org/peps/pep-0287.html
-.. _master repository: http://www.python.org/peps/
+  __ https://docutils.sourceforge.io/mirror/setext.html
 
 
 .. _api:
 
-``api/``: API Reference Material for Client-Developers
-======================================================
+API Reference Material for Client-Developers
+============================================
 
-* `The Docutils Publisher <api/publisher.html>`__
-* `Inside A Docutils Command-Line Front-End Tool <api/cmdline-tool.html>`__
-* `Docutils Runtime Settings <api/runtime-settings.html>`__
-* (`Docutils Transforms <ref/transforms.html>`__ should be moved here)
+`The Docutils Publisher <api/publisher.html>`__
+  entry points for using Docutils as a library
+`Docutils Runtime Settings <api/runtime-settings.html>`__
+  configuration framework details
+`Docutils Transforms <api/transforms.html>`__
+  change the document tree in-place (resolve references, …)
 
-`PEP 258`_ is an overview of the architecture of Docutils.
+The `Docutils Design Specification`_ (PEP 258) is a must-read for any
+Docutils developer.
 
 
 .. _howto:
 
-``howto/``: Instructions for Developers
-=======================================
+Instructions for Developers
+===========================
+
+:Security: `Deploying Docutils Securely <howto/security.html>`__
 
-* **Security:** `Deploying Docutils Securely <howto/security.html>`__
+* `Inside A Docutils Command-Line Front-End Tool <howto/cmdline-tool.html>`__
+* `Runtime Settings Processing <dev/runtime-settings-processing.html>`__
 * `Writing HTML (CSS) Stylesheets for Docutils
   <howto/html-stylesheets.html>`__
 * `Docutils Internationalization <howto/i18n.html>`__
@@ -204,30 +215,28 @@
 
 .. _dev:
 
-``dev/``: Development Notes and Plans for Core-Developers
-=========================================================
+Development Notes and Plans for Core-Developers
+===============================================
 
 Docutils-general:
-
-* `Docutils Hacker's Guide <dev/hacking.html>`__
-* `Docutils Distributor's Guide <dev/distributing.html>`__
-* `Docutils To Do List <dev/todo.html>`__
-* `Docutils Project Policies <dev/policies.html>`__
-* `Docutils Web Site <dev/website.html>`__
-* `Docutils Release Procedure <dev/release.html>`__
-* `The Docutils Subversion Repository <dev/repository.html>`__
-* `Docutils Testing <dev/testing.html>`__
-* `Docstring Semantics <dev/semantics.html>`__ (incomplete)
-* `Python Source Reader <dev/pysource.html>`_ (incomplete)
-* `Docutils Python DTD <dev/pysource.dtd>`_ (experimental)
-* `Plan for Enthought API Documentation Tool <dev/enthought-plan.html>`_
-* `Enthought API Documentation Tool RFP <dev/enthought-rfp.html>`_
+  * `Docutils Hacker's Guide <dev/hacking.html>`__
+  * `Docutils Distributor's Guide <dev/distributing.html>`__
+  * `Docutils To Do List <dev/todo.html>`__
+  * `Docutils Project Policies <dev/policies.html>`__
+  * `Docutils Web Site <dev/website.html>`__
+  * `Docutils Release Procedure <dev/release.html>`__
+  * `The Docutils Subversion Repository <dev/repository.html>`__
+  * `Docutils Testing <dev/testing.html>`__
+  * `Docstring Semantics <dev/semantics.html>`__ (incomplete)
+  * `Python Source Reader <dev/pysource.html>`_ (incomplete)
+  * `Docutils Python DTD <dev/pysource.dtd>`_
+  * `Plan for Enthought API Documentation Tool <dev/enthought-plan.html>`_
+  * `Enthought API Documentation Tool RFP <dev/enthought-rfp.html>`_
 
 reStructuredText_:
-
-* `A Record of reStructuredText Syntax Alternatives
-  <dev/rst/alternatives.html>`__
-* `Problems With StructuredText <dev/rst/problems.html>`__
+  * `A Record of reStructuredText Syntax Alternatives
+    <dev/rst/alternatives.html>`__
+  * `Problems With StructuredText <dev/rst/problems.html>`__
 
 &#xc;
 ..

_service:tar_scm:docutils-0.17.1.tar.gz/docs/peps/pep-0256.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/peps/pep-0256.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/peps/pep-0257.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/peps/pep-0257.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/peps/pep-0258.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/peps/pep-0258.txt Changed

@@ -1,7 +1,7 @@
 PEP: 258
 Title: Docutils Design Specification
-Version: $Revision: 8644 $
-Last-Modified: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
+Version: $Revision: 8995 $
+Last-Modified: $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $
 Author: David Goodger <goodger@python.org>
 Discussions-To: <doc-sig@python.org>
 Status: Rejected
@@ -497,7 +497,7 @@
 Docutils processing.  See `Docutils Front-End Tools`_ for details.
 
 .. _Docutils Front-End Tools:
-   http://docutils.sourceforge.net/docs/user/tools.html
+   https://docutils.sourceforge.io/docs/user/tools.html
 
 
 Document Tree
@@ -836,17 +836,17 @@
    This would break "``from __future__ import``" statements introduced
    in Python 2.1 for multiple module docstrings (main docstring plus
    additional docstring(s)).  The Python Reference Manual specifies:
-   
+
        A future statement must appear near the top of the module.  The
        only lines that can appear before a future statement are:
-   
+
        * the module docstring (if any),
        * comments,
        * blank lines, and
        * other future statements.
-   
+
    Resolution?
-   
+
    1. Should we search for docstrings after a ``__future__``
       statement?  Very ugly.
 
@@ -978,13 +978,13 @@
    (http://www.python.org/peps/pep-0216.html)
 
 .. _docutils.dtd:
-   http://docutils.sourceforge.net/docs/ref/docutils.dtd
+   https://docutils.sourceforge.io/docs/ref/docutils.dtd
 
 .. _soextbl.dtd:
-   http://docutils.sourceforge.net/docs/ref/soextblx.dtd
+   https://docutils.sourceforge.io/docs/ref/soextblx.dtd
 
 .. _The Docutils Document Tree:
-   http://docutils.sourceforge.net/docs/ref/doctree.html
+   https://docutils.sourceforge.io/docs/ref/doctree.html
 
 .. _VMS error condition severity levels:
    http://www.openvms.compaq.com:8000/73final/5841/841pro_027.html
@@ -993,7 +993,7 @@
 .. _log4j project: http://logging.apache.org/log4j/docs/index.html
 
 .. _Docutils Python Source DTD:
-   http://docutils.sourceforge.net/docs/dev/pysource.dtd
+   https://docutils.sourceforge.io/docs/dev/pysource.dtd
 
 .. _ISO 639: http://www.loc.gov/standards/iso639-2/englangn.html
 
@@ -1006,7 +1006,7 @@
 ==================
 
 A SourceForge project has been set up for this work at
-http://docutils.sourceforge.net/.
+https://docutils.sourceforge.io/.
 
 
 ===========

_service:tar_scm:docutils-0.17.1.tar.gz/docs/peps/pep-0287.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/peps/pep-0287.txt Changed

@@ -1,7 +1,7 @@
 PEP: 287
 Title: reStructuredText Docstring Format
-Version: $Revision: 4564 $
-Last-Modified: $Date: 2006-05-21 22:44:42 +0200 (So, 21. Mai 2006) $
+Version: $Revision: 8956 $
+Last-Modified: $Date: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $
 Author: David Goodger <goodger@python.org>
 Discussions-To: <doc-sig@python.org>
 Status: Draft
@@ -513,7 +513,7 @@
    See `Section Structure via Indentation`__ in `Problems With
    StructuredText`_ for further elaboration.
 
-   __ http://docutils.sourceforge.net/docs/dev/rst/problems.html
+   __ https://docutils.sourceforge.io/docs/dev/rst/problems.html
       #section-structure-via-indentation
 
 4. Why use reStructuredText for PEPs?  What's wrong with the existing
@@ -741,7 +741,7 @@
 .. #PEP-216 PEP 216, Docstring Format, Zadka
    (http://www.python.org/peps/pep-0216.html)
 
-.. _reStructuredText markup: http://docutils.sourceforge.net/rst.html
+.. _reStructuredText markup: https://docutils.sourceforge.io/rst.html
 
 .. _Doc-SIG: http://www.python.org/sigs/doc-sig/
 
@@ -761,33 +761,33 @@
 
 .. _JavaDoc: http://java.sun.com/j2se/javadoc/
 
-.. _Setext: http://docutils.sourceforge.net/mirror/setext.html
+.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
 
 .. _StructuredText:
    http://www.zope.org/DevHome/Members/jim/StructuredTextWiki/FrontPage
 
 .. _A ReStructuredText Primer:
-   http://docutils.sourceforge.net/docs/user/rst/quickstart.html
+   https://docutils.sourceforge.io/docs/user/rst/quickstart.html
 
 .. _Quick reStructuredText:
-   http://docutils.sourceforge.net/docs/user/rst/quickref.html
+   https://docutils.sourceforge.io/docs/user/rst/quickref.html
 
 .. _An Introduction to reStructuredText:
-   http://docutils.sourceforge.net/docs/ref/rst/introduction.html
+   https://docutils.sourceforge.io/docs/ref/rst/introduction.html
 
 .. _reStructuredText Markup Specification:
-   http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
+   https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
 
 .. _reStructuredText Directives:
-   http://docutils.sourceforge.net/docs/ref/rst/directives.html
+   https://docutils.sourceforge.io/docs/ref/rst/directives.html
 
 .. _Problems with StructuredText:
-   http://docutils.sourceforge.net/docs/dev/rst/problems.html
+   https://docutils.sourceforge.io/docs/dev/rst/problems.html
 
 .. _A Record of reStructuredText Syntax Alternatives:
-   http://docutils.sourceforge.net/docs/dev/rst/alternatives.html
+   https://docutils.sourceforge.io/docs/dev/rst/alternatives.html
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 
 Copyright

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/doctree.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/doctree.txt Changed

@@ -1,3 +1,5 @@
+.. include:: ../header.txt
+
 ============================
  The Docutils Document Tree
 ============================
@@ -7,8 +9,8 @@
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8563 $
-:Date: $Date: 2020-09-10 23:43:54 +0200 (Do, 10. Sep 2020) $
+:Revision: $Revision: 9115 $
+:Date: $Date: 2022-07-28 19:06:24 +0200 (Do, 28. Jul 2022) $
 :Copyright: This document has been placed in the public domain.
 
 
@@ -36,13 +38,13 @@
 ReStructuredText Primer`_.  For complete technical details, see the
 `reStructuredText Markup Specification`_.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 .. _Docutils Generic DTD:
 .. _Docutils DTD:
 .. _docutils.dtd: docutils.dtd
 .. _Introducing the Extensible Markup Language (XML):
    http://xml.coverpages.org/xmlIntro.html
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _A ReStructuredText Primer: ../user/rst/quickstart.html
 .. _reStructuredText Markup Specification: rst/restructuredtext.html
 
@@ -92,6 +94,10 @@
 much looser HTML_ document model, where paragraphs and text data may
 occur at the same level.
 
+.. _HTML: https://www.w3.org/TR/html52/
+.. _DocBook: https://tdg.docbook.org/tdg/5.1/
+.. _XMLSpec: https://www.w3.org/XML/1998/06/xmlspec-report.htm
+
 
 Structural Elements
 ===================
@@ -111,7 +117,7 @@
 Simple structuctural subelements (title_, subtitle_) contain text
 data; the others are compound and do not directly contain text data.
 
-Category members: title_, subtitle_, decoration_, docinfo_,
+Category members: title_, subtitle_, decoration_, docinfo_, meta_,
 transition_
 
 
@@ -211,11 +217,6 @@
 substitution_reference_, superscript_, target_, title_reference_, raw_
 
 
-.. _HTML: http://www.w3.org/MarkUp/
-.. _DocBook: http://docbook.org/tdg/en/html/docbook.html
-.. _XMLSpec: http://www.w3.org/XML/1998/06/xmlspec-report.htm
-
-
 -------------------
  Element Reference
 -------------------
@@ -233,10 +234,6 @@
     `Element Hierarchy`_ above.  Some elements belong to more than one
     category.
 
-  - Parents: A list of elements which may contain the element.
-
-  - Children: A list of elements which may occur within the element.
-
   - Analogues: Describes analogous elements in well-known document
     models such as HTML_ or DocBook_.  Lists similarities and
     differences.
@@ -244,9 +241,10 @@
   - Processing: Lists formatting or rendering recommendations for the
     element.
 
-* Content Model:
+  - Parents: A list of elements which may contain the element.
 
-  The formal XML content model from the `Docutils DTD`_, followed by:
+  - Children: A list of elements which may occur within the element
+    followed by the formal XML content model from the `Docutils DTD`_.
 
   - Attributes: Describes (or refers to descriptions of) the possible
     values and semantics of each attribute.
@@ -294,32 +292,30 @@
 abbreviation being used in the document. An example of an abbreviation is 'St'
 being used instead of 'Street'.
 
+
 Details
 -------
 
 :Category:
     `Inline Elements`_
 
+:Analogues:
+    ``abbreviation`` is analogous to the HTML "abbr" element.
+
 :Parents:
-     All elements employing the %inline.elements; parameter entities in their
+     All elements employing the `%inline.elements;`_ parameter entity in their
      content models may contain ``abbreviation``.
 
 :Children:
     ``abbreviation`` elements may contain text data plus `inline elements`_.
 
-:Analogues:
-    ``abbreviation`` is analogous to the HTML "abbr" element.
-
-Content Model
--------------
-
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``abbreviation`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``abbreviation`` element contains only the `common attributes`_.
+
 
 Examples
 --------
@@ -357,12 +353,6 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    The following elements may contain ``address``: docinfo_, authors_
-
-:Children:
-    ``address`` elements contain text data plus `inline elements`_.
-
 :Analogues:
     ``address`` is analogous to the DocBook "address" element.
 
@@ -373,17 +363,19 @@
 
     See also docinfo_.
 
+:Parents:
+    The following elements may contain ``address``: docinfo_, authors_
 
-Content Model
--------------
+:Children:
+    ``address`` elements contain text data plus `inline elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``address`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus `xml:space`_.
+    The ``address`` element contains the `common attributes`_ plus
+    `xml:space`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -429,33 +421,29 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``admonition``.
-
-:Children:
-    ``admonition`` elements begin with a title_ and may contain one or
-    more `body elements`_.
-
 :Analogues:
     ``admonition`` has no direct analogues in common DTDs.  It can be
     emulated with primitives and type effects.
 
+    The specific admonitions caution_, note_, tip_, and warning_
+    are analogous to the respective DocBook elements.
+
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``admonition``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``admonition`` elements begin with a title_ and may contain one or
+    more `body elements`_. ::
 
-   (title_, (`%body.elements;`_)+)
+        (title_, (`%body.elements;`_)+)
 
 :Attributes:
-    The ``admonition`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``admonition`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -496,14 +484,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``attention``.
-
-:Children:
-    ``attention`` elements contain one or more `body elements`_.
-
 :Analogues:
     ``attention`` has no direct analogues in common DTDs.  It can be
     emulated with primitives and type effects.
@@ -513,16 +493,20 @@
     generated title "Attention!" (or similar).
 
 
-Content Model
--------------
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``attention``.
+
+:Children:
+    ``attention`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-   (`%body.elements;`_)+
+         (`%body.elements;`_)+
 
 :Attributes:
-    The ``attention`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``attention`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -562,29 +546,24 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    The following elements may contain ``author``: docinfo_, authors_
-
-:Children:
-    ``author`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``author`` is analogous to the DocBook "author" element.
 
 :Processing:
     See docinfo_.
 
+:Parents:
+    The following elements may contain ``author``: docinfo_, authors_
 
-Content Model
--------------
+:Children:
+    ``author`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``author`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``author`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -627,30 +606,23 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``authors``.
-
-:Children:
-    ``authors`` elements may contain the following elements: author_,
-    organization_, address_, contact_
-
 :Analogues:
     ``authors`` is analogous to the DocBook "authors" element.
 
 :Processing:
     See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``authors``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``authors`` elements may contain the following elements: author_,
+    organization_, address_, contact_::
 
-    ((author_, organization_?, address_?, contact_?)+)
+        ((author, organization?, address?, contact?)+)
 
 :Attributes:
-    The ``authors`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``authors`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -701,15 +673,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``block_quote``.
-
-:Children:
-    ``block_quote`` elements contain `body elements`_ followed by an
-    optional attribution_ element.
-
 :Analogues:
     ``block_quote`` is analogous to the "blockquote" element in both
     HTML and DocBook.
@@ -718,17 +681,21 @@
     ``block_quote`` elements serve to set their contents off from the
     main text, typically with indentation and/or other decoration.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``block_quote``.
 
-Content Model
--------------
+:Children:
+    ``block_quote`` elements contain `body elements`_ followed by an
+    optional attribution_ element.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-   ((`%body.elements;`_)+, attribution_?)
+         ((`%body.elements;`_)+, attribution?)
 
 :Attributes:
-    The ``block_quote`` element contains only the `common
-    attributes`_: ids_, names_, dupnames_, source_, and classes_.
+    The ``block_quote`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -772,14 +739,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``bullet_list``.
-
-:Children:
-    ``bullet_list`` elements contain one or more list_item_ elements.
-
 :Analogues:
     ``bullet_list`` is analogous to the HTML "ul" element and to the
     DocBook "itemizedlist" element.  HTML's "ul" is short for
@@ -792,17 +751,19 @@
     Each list item should begin a new vertical block, prefaced by a
     bullet/dingbat.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``bullet_list``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``bullet_list`` elements contain one or more list_item_ elements::
 
-    (list_item_ +)
+        (list_item_+)
 
 :Attributes:
     The ``bullet_list`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_), plus bullet_.
+    plus bullet_.
 
     ``bullet`` is used to record the style of bullet from the input
     data.  In documents processed from reStructuredText_, it contains
@@ -861,32 +822,29 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``caution``.
-
-:Children:
-    ``caution`` elements contain one or more `body elements`_.
-
 :Analogues:
-    ``caution`` is analogous to the DocBook "caution" element.
+    ``caution`` is analogous to the `DocBook "caution"`_ element.
 
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Caution" (or similar).
 
+.. _DocBook "caution": https://tdg.docbook.org/tdg/5.1/caution.html
 
-Content Model
--------------
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``caution``.
 
-.. parsed-literal::
+:Children:
+    ``caution`` elements contain one or more `body elements`_.
+
+     .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``caution`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``caution`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -934,12 +892,6 @@
 :Category:
     `Body Subelements`_ (simple)
 
-:Parents:
-    Only the definition_list_item_ element contains ``classifier``.
-
-:Children:
-    ``classifier`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``classifier`` has no direct analogues in common DTDs.  It can be
     emulated with primitives or type effects.
@@ -947,17 +899,18 @@
 :Processing:
     See definition_list_item_.
 
+:Parents:
+    Only the definition_list_item_ element contains ``classifier``.
 
-Content Model
--------------
+:Children:
+    ``classifier`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``classifier`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``classifier`` element contains only the `common attributes`_.
 
 
 Examples
@@ -994,12 +947,53 @@
 ``colspec``
 ===========
 
+Specifications for a column in a table_.
+
+
+Details
+-------
+
+:Category:
+    `Body Subelements`_ (simple)
+
+:Analogues:
+    ``colspec`` is based on the exchange-table-model_ and
+    analogous to the DocBook "colspec" element.
+
+:Processing:
+    The ``colspec`` element contains layout information for the parent
+    table_.
+
+:Parents:
+    Only the tgroup_ element contains ``colspec``.
+
+:Children:
+    ``colspec`` is an empty element and has no children.
+
 :Attributes:
-    The ``colspec`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus `stub`_.
+    The ``colspec`` element contains the optional "colnum", "colname",
+    "colwidth", "colsep", "rowsep", "align", "char", and "charoff"
+    attributes defined in the exchange-table-model_ plus the
+    `common attributes`_ and `stub`_.
 
+    Docutils uses only colwidth_ and stub_.
 
-`To be completed`_.
+    .. attention::
+
+       In contrast to the definition in the exchange-table-model_,
+       unitless values of the "colwidth" are interpreted as proportional
+       values, not fixed values with unit "pt".
+
+       .. The reference implementation `html4css2` converts column
+          widths values to percentages.
+
+       Future versions of Docutils may use the standard form
+       ``number*``, e.g., “5*” for 5 times the proportion.
+
+Examples
+--------
+
+See table_.
 
 
 ``comment``
@@ -1028,13 +1022,6 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    The following elements may contain ``contact``: docinfo_, authors_
-
-:Children:
-    ``contact`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``contact`` is analogous to the DocBook "email" element.  The HTML
     "address" element serves a similar purpose.
@@ -1042,17 +1029,19 @@
 :Processing:
     See docinfo_.
 
+:Parents:
+    The following elements may contain ``contact``: docinfo_, authors_
 
-Content Model
--------------
+:Children:
+    ``contact`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``contact`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``contact`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -1101,30 +1090,25 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``copyright``.
-
-:Children:
-    ``copyright`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``copyright`` is analogous to the DocBook "copyright" element.
 
 :Processing:
     See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``copyright``.
 
-Content Model
--------------
+:Children:
+    ``copyright`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``copyright`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``copyright`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -1169,14 +1153,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``danger``.
-
-:Children:
-    ``danger`` elements contain one or more `body elements`_.
-
 :Analogues:
     ``danger`` has no direct analogues in common DTDs.  It can be
     emulated with primitives and type effects.
@@ -1185,17 +1161,20 @@
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "!DANGER!" (or similar).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``danger``.
 
-Content Model
--------------
+:Children:
+    ``danger`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``danger`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``danger`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -1230,29 +1209,24 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``date``.
-
-:Children:
-    ``date`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``date`` is analogous to the DocBook "date" element.
 
 :Processing:
     Often used with the RCS/CVS keyword "Date".  See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``date``.
 
-Content Model
--------------
+:Children:
+    ``date`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    `%text.model;`_
+         `%text.model;`_
 
 :Attributes:
-    The ``date`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``date`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -1296,12 +1270,6 @@
 :Category:
     `Structural Subelements`_
 
-:Parents:
-    Only the document_ element contains ``decoration``.
-
-:Children:
-    ``decoration`` elements may contain `decorative elements`_.
-
 :Analogues:
     There are no direct analogies to ``decoration`` in HTML or in
     DocBook.  Equivalents are typically constructed from primitives
@@ -1310,20 +1278,21 @@
 :Processing:
     See the individual `decorative elements`_.
 
+:Parents:
+    Only the document_ element contains ``decoration``.
 
-Content Model
--------------
+:Children:
+    ``decoration`` elements may contain `decorative elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    (header_?, footer_?)
+         (header_?, footer_?)
 
 Although the content model doesn't specifically require contents, no
 empty ``decoration`` elements are ever created.
 
 :Attributes:
-    The ``decoration`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``decoration`` element contains only the `common attributes`_.
 
 
 Examples
@@ -1359,12 +1328,6 @@
 :Category:
     `Body Subelements`_ (compound)
 
-:Parents:
-    Only definition_list_item_ elements contain ``definition``.
-
-:Children:
-    ``definition`` elements may contain `body elements`_.
-
 :Analogues:
     ``definition`` is analogous to the HTML "dd" element and to the
     DocBook "listitem" element (inside a "variablelistentry" element).
@@ -1372,17 +1335,18 @@
 :Processing:
     See definition_list_item_.
 
+:Parents:
+    Only definition_list_item_ elements contain ``definition``.
 
-Content Model
--------------
+:Children:
+    ``definition`` elements contain `body elements`_.
 
-.. parsed-literal::
+     .. parsed-literal::
 
-    (`%body.elements;`_)+
+         (`%body.elements;`_)+
 
 :Attributes:
-    The ``definition`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``definition`` element contains only the `common attributes`_.
 
 
 Examples
@@ -1423,17 +1387,9 @@
 :Processing:
     See definition_list_item_.
 
-
-Content Model
--------------
-
-.. parsed-literal::
-
-    (definition_list_item_ +)
-
 :Attributes:
     The ``definition_list`` element contains only the `common
-    attributes`_: ids_, names_, dupnames_, source_, and classes_.
+    attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -1488,14 +1444,6 @@
 :Category:
     `Body Subelements`_ (compound)
 
-:Parents:
-    Only the definition_list_ element contains
-    ``definition_list_item``.
-
-:Children:
-    ``definition_list_item`` elements each contain a single term_,
-    an optional classifier_, and a definition_.
-
 :Analogues:
     ``definition_list_item`` is analogous to the DocBook
     "variablelistentry" element.
@@ -1505,17 +1453,19 @@
     term_.  They should be separated visually, typically by spaces
     plus a colon or dash.
 
+:Parents:
+    Only the definition_list_ element contains
+    ``definition_list_item``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``definition_list_item`` elements each contain a single term_,
+    an optional classifier_, and a definition_::
 
-    (term_, classifier_?, definition_)
+        (term, classifier?, definition)
 
 :Attributes:
     The ``definition_list_item`` element contains only the `common
-    attributes`_: ids_, names_, dupnames_, source_, and classes_.
+    attributes`_.
 
 
 Examples
@@ -1573,29 +1523,24 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_list_item_ element contains ``description``.
-
-:Children:
-    ``description`` elements may contain `body elements`_.
-
 :Analogues:
     ``description`` has no direct analogues in common DTDs.
 
 :Processing:
     See option_list_.
 
+:Parents:
+    Only the option_list_item_ element contains ``description``.
 
-Content Model
--------------
+:Children:
+    ``description`` elements may contain `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+       (`%body.elements;`_)+
 
 :Attributes:
-    The ``description`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``description`` element contains only the `common attributes`_.
 
 
 Examples
@@ -1607,10 +1552,11 @@
 ``docinfo``
 ===========
 
-The ``docinfo`` element is a container for document bibliographic
+The ``docinfo`` element is a container for displayed document bibliographic
 data, or meta-data (data about the document).  It corresponds to the
 front matter of a book, such as the title page and copyright page.
 
+See also the meta_ element (for "hidden" meta-data).
 
 Details
 -------
@@ -1618,12 +1564,6 @@
 :Category:
     `Structural Subelements`_
 
-:Parents:
-    Only the document_ element contains ``docinfo``.
-
-:Children:
-    ``docinfo`` elements contain `bibliographic elements`_.
-
 :Analogues:
     ``docinfo`` is analogous to DocBook "info" elements ("bookinfo"
     etc.).  There are no directly analogous HTML elements; the "meta"
@@ -1643,17 +1583,18 @@
 
     .. _RCS Keywords: rst/restructuredtext.html#rcs-keywords
 
+:Parents:
+    Only the document_ element contains ``docinfo``.
 
-Content Model
--------------
+:Children:
+    ``docinfo`` elements contain `bibliographic elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (`%bibliographic.elements;`_)+
+        (`%bibliographic.elements;`_)+
 
 :Attributes:
-    The ``docinfo`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``docinfo`` element contains only the `common attributes`_.
 
 
 Examples
@@ -1722,7 +1663,7 @@
 library.
 
 .. _doctest module:
-   http://www.python.org/doc/current/lib/module-doctest.html
+   https://docs.python.org/3/library/doctest.html
 
 
 Details
@@ -1731,15 +1672,6 @@
 :Category:
     `Simple Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``doctest_block``.
-
-:Children:
-    ``doctest_block`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``doctest_block`` is analogous to the HTML "pre" element and to
     the DocBook "programlisting" and "screen" elements.
@@ -1749,17 +1681,22 @@
     rendered in a monospaced typeface.  It is crucial that all
     whitespace and line breaks are preserved in the rendered form.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``doctest_block``.
 
-Content Model
--------------
+:Children:
+    ``doctest_block`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   `%text.model;`_
+       `%text.model;`_
 
 :Attributes:
     The ``doctest_block`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_), plus `xml:space`_.
+    plus `xml:space`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -1801,6 +1738,10 @@
 :Category:
     `Structural Elements`_
 
+:Analogues:
+    ``document`` is analogous to the HTML "html" element and to
+    several DocBook elements such as "book".
+
 :Parents:
     The ``document`` element has no parents.
 
@@ -1808,20 +1749,12 @@
     ``document`` elements may contain `structural subelements`_,
     `structural elements`_, and `body elements`_.
 
-:Analogues:
-    ``document`` is analogous to the HTML "html" element and to
-    several DocBook elements such as "book".
-
-
-Content Model
--------------
-
-.. parsed-literal::
+    .. parsed-literal::
 
-    ( (title_, subtitle_?)?,
-      decoration_?,
-      (docinfo_, transition_?)?,
-      `%structure.model;`_ )
+        ( (title_, subtitle_?)?,
+          decoration_?,
+          (docinfo_, transition_?)?,
+          `%structure.model;`_ )
 
 Depending on the source of the data and the stage of processing, the
 "document" may not initially contain a "title".  A document title is
@@ -1839,11 +1772,8 @@
 
 :Attributes:
     The ``document`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus an optional title__
-    attribute which stores the document title metadata.
-
-    __ `title (attribute)`_
-
+    names_, dupnames_, source_, and classes_), plus an optional
+    `title attribute`_ which stores the document title metadata.
 
 Examples
 --------
@@ -1899,15 +1829,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``enumerated_list``.
-
-:Children:
-    ``enumerated_list`` elements contain one or more list_item_
-    elements.
-
 :Analogues:
     ``enumerated_list`` is analogous to the HTML "ol" element and to
     the DocBook "orderedlist" element.
@@ -1916,17 +1837,20 @@
     Each list item should begin a new vertical block, prefaced by a
     enumeration marker (such as "1.").
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``enumerated_list``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``enumerated_list`` elements contain one or more list_item_
+    elements::
 
-    (list_item_ +)
+        (list_item+)
 
 :Attributes:
     The ``enumerated_list`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_), plus enumtype_,
+    plus enumtype_,
     prefix_, suffix_, and start_.
 
     ``enumtype`` is used to record the intended enumeration sequence,
@@ -2008,14 +1932,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``error``.
-
-:Children:
-    ``error`` elements contain one or more `body elements`_.
-
 :Analogues:
     ``error`` has no direct analogues in common DTDs.  It can be
     emulated with primitives and type effects.
@@ -2024,17 +1940,20 @@
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Error" (or similar).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``error``.
 
-Content Model
--------------
+:Children:
+    ``error`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+       (`%body.elements;`_)+
 
 :Attributes:
-    The ``error`` element contains only the `common attributes`_: ids_,
-    names_, dupnames_, source_, and classes_.
+    The ``error`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2069,31 +1988,24 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    The following elements may contain ``field``: docinfo_,
-    field_list_
-
-:Children:
-    Each ``field`` element contains one field_name_ and one
-    field_body_ element.
-
 :Analogues:
     ``field`` has no direct analogues in common DTDs.
 
 :Processing:
     See field_list_.
 
+:Parents:
+    The following elements may contain ``field``: docinfo_,
+    field_list_
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    Each ``field`` element contains one field_name_ and one
+    field_body_ element::
 
-   (field_name_, field_body_)
+        (field_name, field_body)
 
 :Attributes:
-    The ``field`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``field`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -2119,29 +2031,24 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the field_ element contains ``field_body``.
-
-:Children:
-    ``field_body`` elements may contain `body elements`_.
-
 :Analogues:
     ``field_body`` has no direct analogues in common DTDs.
 
 :Processing:
     See field_list_.
 
+:Parents:
+    Only the field_ element contains ``field_body``.
 
-Content Model
--------------
+:Children:
+    ``field_body`` elements may contain `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)*
+        (`%body.elements;`_)*
 
 :Attributes:
-    The ``field_body`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``field_body`` element contains only the `common attributes`_.
 
 
 Examples
@@ -2165,14 +2072,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``field_list``.
-
-:Children:
-    ``field_list`` elements contain one or more field_ elements.
-
 :Analogues:
     ``field_list`` has no direct analogues in common DTDs.  It can be
     emulated with primitives such as tables.
@@ -2184,17 +2083,18 @@
     special processing.  Such structures do not survive as field lists
     to be rendered.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``field_list``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``field_list`` elements contain one or more field_ elements. ::
 
-   (field_ +)
+        (field+)
 
 :Attributes:
-    The ``field_list`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``field_list`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2256,29 +2156,24 @@
 :Category:
     `Body Subelements`_ (simple)
 
-:Parents:
-    Only the field_ element contains ``field_name``.
-
-:Children:
-    ``field_name`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``field_name`` has no direct analogues in common DTDs.
 
 :Processing:
     See field_list_.
 
+:Parents:
+    Only the field_ element contains ``field_name``.
 
-Content Model
--------------
+:Children:
+    ``field_name`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``field_name`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``field_name`` element contains only the `common attributes`_.
 
 
 Examples
@@ -2309,29 +2204,24 @@
 :Category:
     `Decorative Elements`_
 
-:Parents:
-    Only the decoration_ element contains ``footer``.
-
-:Children:
-    ``footer`` elements may contain `body elements`_.
-
 :Analogues:
-    ``footer`` is analogous to the HTML5 "footer" element
+    ``footer`` is analogous to the HTML5 "footer" element.
     There are no direct analogies to ``footer`` in HTML4 or DocBook.
     Equivalents are typically constructed from primitives and/or
     generated by the processing system.
 
+:Parents:
+    Only the decoration_ element contains ``footer``.
 
-Content Model
--------------
+:Children:
+    ``footer`` elements may contain `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``footer`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``footer`` element contains only the `common attributes`_.
 
 
 Examples
@@ -2357,13 +2247,165 @@
 ``footnote``
 ============
 
-`To be completed`_.
+The ``footnote`` element is used for labeled notes_ that provide
+additional context to a passage of text (*footnotes* or *endnotes*).
+The corresponding footnote mark in running text is set by the
+`footnote_reference`_ element.
+
+.. _notes: https://en.wikipedia.org/wiki/Note_(typography)
+
+
+Details
+-------
+
+:Category:
+    `Compound Body Elements`_
+
+:Analogues:
+    ``footnote`` has no direct analogues in DocBook or HTML.
+
+    The `DocBook "footnote"`_ element combines features of ``footnote``
+    and footnote_reference_.
+
+    The DPub ARIA role `"doc-footnote"`__ may be used to mark a (conforming__)
+    `HTML emulation`__ as "ancillary information, such as a citation or
+    commentary, that provides additional context to a referenced passage
+    of text".
+
+    For collections of notes that occur at the end of a section, the
+    the DPub ARIA role `"doc-endnotes"`__ is more appropriate.
+
+    The corresponding types in the `EPUB 3 Structural Semantics
+    Vocabulary`__ are "footnote" and "endnote".
+
+    .. _DocBook "footnote": https://tdg.docbook.org/tdg/5.1/footnote.html
+    __ https://www.w3.org/TR/dpub-aria-1.0/#doc-footnote
+    __ https://www.w3.org/TR/html-aria/#docconformance
+    __ https://www.w3.org/TR/html51/
+       common-idioms-without-dedicated-elements.html#footnotes
+    __ https://www.w3.org/TR/dpub-aria-1.0/#doc-endnotes
+    __ https://www.w3.org/TR/epub-ssv-11/#notes
+
+:Processing:
+    A ``footnote`` element should be set off from the rest of the
+    document, e.g. with a border or using a smaller font size.
+
+    Footnotes may "float" to the bottom or margin of a page or a
+    dedicated section.
+
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``footnote``.
+
+:Children:
+    ``footnote`` elements begin with an optional label_
+    and contain `body elements`_.
+
+    .. parsed-literal::
+
+        (label?, (`%body.elements;`_)+)
+
+:Attributes:
+    The ``footnote`` element contains the `common attributes`_
+    plus auto_ and backrefs_.
+
+:Parameter Entities:
+    The `%body.elements;`_ parameter entity directly includes
+    ``footnote``.  The `%structure.model;`_ parameter entity indirectly
+    includes ``footnote``.
+
+
+Examples
+--------
+
+reStructuredText_ uses `explicit markup blocks`_ for footnotes::
+
+    .. 1 This is a footnote.
+
+Pseudo-XML_ fragment from simple parsing::
+
+    <footnote ids="id1" names="1">
+        <label>
+            1
+        <paragraph>
+            This is a footnote.
+
+.. _explicit markup blocks: rst/restructuredtext.html#explicit-markup-blocks
 
 
 ``footnote_reference``
 ======================
 
-`To be completed`_.
+The ``footnote_reference`` element is an inline element representing a
+cross reference to a footnote_ (a footnote mark).
+
+
+Details
+-------
+
+:Category:
+    `Inline Elements`_
+
+:Analogues:
+    The ``footnote_reference`` element resembles the `DocBook
+    "footnoteref"`_ element or the LaTeX ``\footnotemark`` command.
+
+    There is no equivalent in HTML. The ``<a>`` element can be used
+    to provide a link to the corresponding footnote.
+
+    .. _DocBook "footnoteref": https://tdg.docbook.org/tdg/5.1/footnoteref.html
+
+:Processing:
+    A ``footnote_reference`` should generate a mark matching the label_
+    of the referenced footnote. The mark is typically formatted as
+    superscript or enclosed i square brackets.
+
+:Parents:
+    All elements employing the `%inline.elements;`_ parameter entities in
+    their content models may contain ``footnote-reference``.
+
+:Children:
+    ``footnote_reference`` elements may contain text data. ::
+
+        (#PCDATA)
+
+:Attributes:
+    The ``footnote_reference`` element contains the `common attributes`_
+    plus auto_, refid_, and refname_.
+
+
+Examples
+--------
+
+reStructuredText source fragment::
+
+    #_ is an auto-numbered footnote reference.
+
+    .. # Auto-numbered footnote 1.
+
+Pseudo-XML_ fragment from simple parsing::
+
+    <paragraph>
+        <footnote_reference auto="1" ids="id1">
+         is an auto-numbered footnote reference.
+    <footnote auto="1" ids="id3">
+        <paragraph>
+            Auto-numbered footnote 1.
+
+The ``references.Footnotes`` Docutils transform_ resolves this to::
+
+    <paragraph>
+        <footnote_reference auto="1" ids="id1" refid="id2">
+            1
+         is an auto-numbered footnote reference.
+    <footnote auto="1" backrefs="id1" ids="id2" names="1">
+        <label>
+            1
+        <paragraph>
+            Auto-numbered footnote 1.
+
+.. _transform: api/.html
 
 
 ``generated``
@@ -2390,29 +2432,24 @@
 :Category:
     `Decorative Elements`_
 
-:Parents:
-    Only the decoration_ element contains ``header``.
-
-:Children:
-    ``header`` elements may contain `body elements`_.
-
 :Analogues:
-    ``header`` is analogous to the HTML5 "header" element
+    ``header`` is analogous to the HTML5 "header" element.
     There are no direct analogies to ``header`` in HTML4 or DocBook.
     Equivalents are typically constructed from primitives and/or
     generated by the processing system.
 
+:Parents:
+    Only the decoration_ element contains ``header``.
 
-Content Model
--------------
+:Children:
+    ``header`` elements may contain `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``header`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``header`` element contains only the `common attributes`_.
 
 
 Examples
@@ -2447,14 +2484,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``hint``.
-
-:Children:
-    ``hint`` elements contain one or more `body elements`_.
-
 :Analogues:
     ``hint`` has no direct analogues in common DTDs.  It can be
     emulated with primitives and type effects.
@@ -2463,17 +2492,20 @@
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Hint" (or similar).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``hint``.
 
-Content Model
--------------
+:Children:
+    ``hint`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``hint`` element contains only the `common attributes`_: ids_,
-    names_, dupnames_, source_, and classes_.
+    The ``hint`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2499,9 +2531,8 @@
 =========
 
 :Attributes:
-    The ``image`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus uri, alt, height_,
-    width_, and scale_.
+    The ``image`` element contains the `common attributes`_
+    plus uri, align_, alt, height_, width_, and scale_.
 
 `To be completed`_.
 
@@ -2522,32 +2553,29 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``important``.
-
-:Children:
-    ``important`` elements contain one or more `body elements`_.
-
 :Analogues:
-    ``important`` is analogous to the DocBook "important" element.
+    ``important`` is analogous to the `DocBook "important"`_ element.
 
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Important" (or similar).
 
+.. _DocBook "important": https://tdg.docbook.org/tdg/5.1/important.html
 
-Content Model
--------------
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``important``.
 
-.. parsed-literal::
+:Children:
+    ``important`` elements contain one or more `body elements`_.
+
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``important`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``important`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2588,7 +2616,64 @@
 ``inline``
 ==========
 
-`To be completed`_.
+The ``inline`` element is a generic inline container.
+
+Details
+-------
+
+:Category:
+    `Inline Elements`_
+
+:Analogues:
+    ``inline`` is analogous to the HTML "span" element.
+
+:Processing:
+    Writers typically pass the classes_ attribute to the output document
+    and leave styling to the backend or a custom stylesheet_. They may
+    also process the classes_ attribute and convert the ``inline``
+    element to a specific element or render the content distinctly
+    for specific class values. Moreover, writers may ignore the classes
+    attribute and render the content as ordinary text.
+
+:Parents:
+    All elements employing the `%inline.elements;`_ parameter entities in
+    their content models may contain ``inline``.
+
+:Children:
+    ``inline`` elements may contain text data plus `inline elements`_.
+
+    .. parsed-literal::
+
+        `%text.model;`_
+
+:Attributes:
+    The ``inline`` element contains the `common attributes`_.
+
+
+Examples
+--------
+
+`Custom interpreted text roles`_ create ``inline`` elements (unless they
+are based on a `standard role`_).
+
+reStructuredText source fragment::
+
+    .. role:: custom
+
+    An example of using :custom:`interpreted text`
+
+Pseudo-XML_ fragment from simple parsing::
+
+
+    <paragraph>
+        An example of using
+        <inline classes="custom">
+            interpreted text
+
+.. _stylesheet: ../user/config.html#stylesheet
+.. _custom interpreted text roles:
+   rst/directives.html#custom-interpreted-text-roles
+.. _standard role: rst/roles.html
 
 
 ``label``
@@ -2629,17 +2714,19 @@
 :Processing:
     See `line_block`_.
 
+:Parents:
+    All elements employing the `%inline.elements;`_ parameter entities in
+    their content models may contain ``inline``.
 
-Content Model
--------------
+:Children:
+    ``inline`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``line`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus `xml:space`_.
+    The ``line`` element contains the `common attributes`_.
 
 
 Examples
@@ -2665,15 +2752,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``line_block``.
-
-:Children:
-    ``line_block`` elements may contain line_ elements and nested
-    ``line_block`` elements.
-
 :Analogues:
     ``line_block`` is analogous to the DocBook "literallayout" element
     and to the HTML "pre" element (with modifications to typeface
@@ -2684,17 +2762,19 @@
     rendered in an ordinary text typeface.  It is crucial that leading
     whitespace and line breaks are preserved in the rendered form.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``line_block``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``line_block`` elements may contain line_ elements and nested
+    line_block_ elements. ::
 
-   (line_ | line_block_)+
+        (line | line_block)+
 
 :Attributes:
-    The ``line_block`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus `xml:space`_.
+    The ``line_block`` element contains the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2705,7 +2785,6 @@
 Examples
 --------
 
-reStructuredText uses a directive to indicate a ``line_block``.
 Example source::
 
     Take it away, Eric the Orchestra Leader!
@@ -2777,13 +2856,6 @@
 :Category:
     `Body Subelements`_ (compound)
 
-:Parents:
-    The bullet_list_ and enumerated_list_ elements contain
-    ``list_item``.
-
-:Children:
-    ``list_item`` elements may contain `body elements`_.
-
 :Analogues:
     ``list_item`` is analogous to the HTML "li" element and to the
     DocBook "listitem" element.
@@ -2791,17 +2863,19 @@
 :Processing:
     See bullet_list_ or enumerated_list_.
 
+:Parents:
+    The bullet_list_ and enumerated_list_ elements contain
+    ``list_item``.
 
-Content Model
--------------
+:Children:
+    ``list_item`` elements may contain `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (`%body.elements;`_)*
+        (`%body.elements;`_)*
 
 :Attributes:
-    The ``list_item`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``list_item`` element contains only the `common attributes`_.
 
 
 Examples
@@ -2858,15 +2932,6 @@
 :Category:
     `Simple Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``literal_block``.
-
-:Children:
-    ``literal_block`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``literal_block`` is analogous to the HTML "pre" element and to
     the DocBook "programlisting" and "screen" elements.
@@ -2876,17 +2941,22 @@
     typeface.  It is crucial that all whitespace and line breaks are
     preserved in the rendered form.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``literal_block``.
 
-Content Model
--------------
+:Children:
+    ``literal_block`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
     The ``literal_block`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_), plus `xml:space`_.
+    plus `xml:space`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -2931,13 +3001,6 @@
 :Category:
     `Inline Elements`_
 
-:Parents:
-    All elements employing the `%inline.elements;`_ parameter entities in
-    their content models may contain ``math``.
-
-:Children:
-    ``math`` elements may contain text data.
-
 :Analogues:
     ``math`` is analogous to a MathML "math" element or
     the LaTeX (``$ math $``) mode.
@@ -2945,16 +3008,19 @@
 :Processing:
     Rendered as mathematical notation.
 
-Content Model
--------------
+:Parents:
+    All elements employing the `%inline.elements;`_ parameter entities in
+    their content models may contain ``math``.
 
-.. parsed-literal::
+:Children:
+    ``math`` elements may contain text data.
 
-    `%text.model;`_
+    .. parsed-literal::
+
+        `%text.model;`_
 
 :Attributes:
-    The ``math`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_).
+    The ``math`` element contains the `common attributes`_.
 
 .. #latex-math For details of the supported mathematical language, see
    the `"math" directive`_
@@ -2979,32 +3045,79 @@
 :Category:
     `Simple Body Elements`_
 
+:Analogues:
+    ``math_block`` is analogous to a LaTeX "equation*" environment or
+    a MathML "math" element displayed as block-level element.
+
+:Processing:
+    Rendered in a block as mathematical notation, typically centered or with
+    indentation
+
 :Parents:
     All elements employing the `%body.elements;`_ or
     `%structure.model;`_ parameter entities in their content models
     may contain ``math_block``.
 
 :Children:
-    ``math_block`` elements may contain text data.
+    ``math_block`` elements may contain text data. ::
+
+        (#PCDATA)
+
+:Attributes:
+    The ``math`` element contains the `common attributes`_.
+
+``meta``
+========
+
+The ``meta`` element is a container for "hidden" document
+bibliographic data, or meta-data (data about the document).
+It corresponds to HTML META tags.
+
+See also the docinfo_ element for displayed meta-data.
+The document's `title attribute`_ stores the metadate document title.
+
+
+Details
+-------
+
+:Category:
+    `Structural Subelements`_
 
 :Analogues:
-    ``math_block`` is analogous to a LaTeX "equation*" environment or
-    a MathML "math" element displayed as block-level element.
+    ``meta`` is analogous to the HTML "meta" element
+    or the file properties in ODT or PDF documents.
 
 :Processing:
-    Rendered in a block as mathematical notation, typically centered or with
-    indentation
+    The ``meta`` element is stored as metadata if the export format
+    supports this. It is typically invisible and may be omitted from
+    the processed output.
 
-Content Model
--------------
+    Meta-data may also be extracted from docinfo_ children
+    or the document_ attributes (title).
 
-.. parsed-literal::
+:Parents:
+    Only the document_ element contains ``meta``.
 
-    (#PCDATA)
+:Children:
+    None.
 
-:Attributes:
-    The ``math`` element contains the `common attributes`_
-    (ids_, names_, dupnames_, source_, and classes_).
+
+Example
+-------
+
+The `"meta" directive`_ is used to create a ``meta`` element.
+reStructuredText_ source::
+
+    .. meta::
+       :description lang=en: An amusing story
+       :description lang=fr: Un histoire amusant
+
+Pseudo-XML_ fragment from simple parsing::
+
+    <meta content="An amusing story" lang="en" name="description">
+    <meta content="Un histoire amusant" lang="fr" name="description">
+
+.. _"meta" directive: rst/directives.html#meta
 
 
 ``note``
@@ -3023,32 +3136,30 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``note``.
-
-:Children:
-    ``note`` elements contain one or more `body elements`_.
-
 :Analogues:
-    ``note`` is analogous to the DocBook "note" element.
+    ``note`` is analogous to the `DocBook "note"`_ element.
+
+    .. _DocBook "note": https://tdg.docbook.org/tdg/5.1/note.html
 
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Note" (or similar).
 
 
-Content Model
--------------
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``note``.
 
-.. parsed-literal::
+:Children:
+    ``note`` elements contain one or more `body elements`_.
+
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``note`` element contains only the `common attributes`_: ids_,
-    names_, dupnames_, source_, and classes_.
+    The ``note`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -3085,30 +3196,23 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_group_ element contains ``option``.
-
-:Children:
-    Each ``option`` element contains one option_string_ and zero or
-    more option_argument_ elements.
-
 :Analogues:
     ``option`` has no direct analogues in common DTDs.
 
 :Processing:
     See option_list_.
 
+:Parents:
+    Only the option_group_ element contains ``option``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    Each ``option`` element contains one option_string_ and zero or
+    more option_argument_ elements. ::
 
-   (option_string_, option_argument_ \*)
+        (option_string, option_argument*)
 
 :Attributes:
-    The ``option`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``option`` element contains only the `common attributes`_.
 
 
 Examples
@@ -3130,12 +3234,6 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_ element contains ``option_argument``.
-
-:Children:
-    ``option_argument`` elements contain text data only.
-
 :Analogues:
     ``option_argument`` has no direct analogues in common DTDs.
 
@@ -3146,17 +3244,17 @@
     typically rendered in a monospaced typeface, possibly italicized
     or otherwise altered to indicate its placeholder nature.
 
+:Parents:
+    Only the option_ element contains ``option_argument``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``option_argument`` elements contain text data only. ::
 
-   (#PCDATA)
+        (#PCDATA)
 
 :Attributes:
-    The ``option_argument`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus delimiter_.
+    The ``option_argument`` element contains the `common attributes`_
+    plus delimiter_.
 
     ``delimiter`` contains the text preceding the ``option_argument``:
     either the text separating it from the option_string_ (typically
@@ -3183,17 +3281,6 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_list_item_ element contains ``option_group``.
-
-:Children:
-    ``option_group`` elements contain one or more option_ elements.
-
-    ``option_group`` is an empty element and has no children.
-
-    Each ``option_group`` element contains one _ and
-    one _ element.
-
 :Analogues:
     ``option_group`` has no direct analogues in common DTDs.
 
@@ -3201,18 +3288,16 @@
     Typically option_ elements within an ``option_group`` are joined
     together in a comma-separated list.
 
+:Parents:
+    Only the option_list_item_ element contains ``option_group``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``option_group`` elements contain one or more option_ elements. ::
 
-   (option_group_, description_)
+        (option+)
 
 :Attributes:
-    The ``option_group`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
-
+    The ``option_group`` element contains only the `common attributes`_.
 
 Examples
 --------
@@ -3234,15 +3319,6 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``option_list``.
-
-:Children:
-    ``option_list`` elements contain one or more option_list_item_
-    elements.
-
 :Analogues:
     ``option_list`` has no direct analogues in common DTDs.  It can be
     emulated with primitives such as tables.
@@ -3252,17 +3328,19 @@
     where the first column contains option strings and arguments, and
     the second column contains descriptions.
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``option_list``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``option_list`` elements contain one or more option_list_item_
+    elements. ::
 
-   (option_list_item_ +)
+        (option_list_item+)
 
 :Attributes:
-    The ``option_list`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``option_list`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -3325,30 +3403,23 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_list_ element contains ``option_list_item``.
-
-:Children:
-    Each ``option_list_item`` element contains one option_group_ and
-    one description_ element.
-
 :Analogues:
     ``option_list_item`` has no direct analogues in common DTDs.
 
 :Processing:
     See option_list_.
 
+:Parents:
+    Only the option_list_ element contains ``option_list_item``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    Each ``option_list_item`` element contains one option_group_ and
+    one description_ element. ::
 
-   (option_group_, description_)
+        (option_group, description)
 
 :Attributes:
-    The ``option_list_item`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``option_list_item`` element contains only the `common attributes`_.
 
 
 Examples
@@ -3370,12 +3441,6 @@
 :Category:
     `Body Subelements`_
 
-:Parents:
-    Only the option_ element contains ``option_string``.
-
-:Children:
-    ``option_string`` elements contain text data only.
-
 :Analogues:
     ``option_string`` has no direct analogues in common DTDs.
 
@@ -3383,17 +3448,16 @@
     The ``option_string`` text is typically rendered in a monospaced
     typeface.
 
+:Parents:
+    Only the option_ element contains ``option_string``.
 
-Content Model
--------------
-
-.. parsed-literal::
+:Children:
+    ``option_string`` elements contain text data only. ::
 
-   (#PCDATA)
+        (#PCDATA)
 
 :Attributes:
-    The ``option_string`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``option_string`` element contains only the `common attributes`_.
 
 
 Examples
@@ -3415,13 +3479,6 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``organization``.
-
-:Children:
-    ``organization`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``organization`` is analogous to the DocBook "orgname",
     "corpname", or "publishername" elements.
@@ -3429,17 +3486,19 @@
 :Processing:
     See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``organization``.
 
-Content Model
--------------
+:Children:
+    ``organization`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``organization`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``organization`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -3482,6 +3541,10 @@
 :Category:
     `Simple Body Elements`_
 
+:Analogues:
+    ``paragraph`` is analogous to the HTML "p" element and to the
+    DocBook "para" elements.
+
 :Parents:
     All elements employing the `%body.elements;`_ or
     `%structure.model;`_ parameter entities in their content models
@@ -3491,21 +3554,12 @@
     ``paragraph`` elements may contain text data plus `inline
     elements`_.
 
-:Analogues:
-    ``paragraph`` is analogous to the HTML "p" element and to the
-    DocBook "para" elements.
-
+    .. parsed-literal::
 
-Content Model
--------------
-
-.. parsed-literal::
-
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``paragraph`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``paragraph`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -3563,13 +3617,6 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``revision``.
-
-:Children:
-    ``revision`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``revision`` is analogous to but simpler than the DocBook
     "revision" element.  It closely matches the DocBook "revnumber"
@@ -3578,17 +3625,19 @@
 :Processing:
     Often used with the RCS/CVS keyword "Revision".  See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``revision``.
 
-Content Model
--------------
+:Children:
+    ``revision`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``revision`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``revision`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -3658,6 +3707,10 @@
 :Category:
     `Structural Elements`_
 
+:Analogues:
+    ``section`` is analogous to the recursive "section" elements in
+    DocBook and HTML5.
+
 :Parents:
     The following elements may contain ``section``: document_,
     section_
@@ -3666,25 +3719,15 @@
     ``section`` elements begin with a title_, and may contain `body
     elements`_ as well as transition_, topic_, and sidebar_ elements.
 
-:Analogues:
-    ``section`` is analogous to the recursive "section" elements in
-    DocBook and HTML5.
-
-
-Content Model
--------------
+    .. parsed-literal::
 
-.. parsed-literal::
-
-    (title_,
-     `%structure.model;`_)
+        (title_, `%structure.model;`_)
 
-See the `%structure.model;`_ parameter entity for details of the body
-of a ``section``.
+    See the `%structure.model;`_ parameter entity for details of the body
+    of a ``section``.
 
 :Attributes:
-    The ``section`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``section`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%section.elements;`_ parameter entity directly includes
@@ -3762,14 +3805,6 @@
 :Category:
     `Structural Elements`_
 
-:Parents:
-    The following elements may contain ``sidebar``: document_,
-    section_
-
-:Children:
-    ``sidebar`` elements begin with optional title_ and subtitle_
-    and contain `body elements`_ and topic_ elements.
-
 :Analogues:
     ``sidebar`` is analogous to the DocBook "sidebar" element.
 
@@ -3779,18 +3814,21 @@
     "float" to the side of the page and the document's main text flows
     around them.
 
+:Parents:
+    The following elements may contain ``sidebar``: document_,
+    section_
 
-Content Model
--------------
+:Children:
+    ``sidebar`` elements begin with optional title_ and subtitle_
+    and contain `body elements`_ and topic_ elements.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (title_, subtitle_?,
-     (`%body.elements;`_ | topic_)+)
+        (title, subtitle?,
+         (`%body.elements;`_ | topic)+)
 
 :Attributes:
-    The ``sidebar`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``sidebar`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%structure.model;`_ parameter entity directly includes
@@ -3834,29 +3872,24 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``status``.
-
-:Children:
-    ``status`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``status`` is analogous to the DocBook "status" element.
 
 :Processing:
     See docinfo_.
 
+:Parents:
+    Only the docinfo_ element contains ``status``.
 
-Content Model
--------------
+:Children:
+    ``status`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``status`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``status`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -3922,13 +3955,6 @@
 :Category:
     `Structural Subelements`_
 
-:Parents:
-    The document_ and sidebar_ elements may contain ``subtitle``.
-
-:Children:
-    ``subtitle`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``subtitle`` is analogous to HTML header elements ("h2" etc.) and
     to the DocBook "subtitle" element.
@@ -3936,17 +3962,19 @@
 :Processing:
     A document's subtitle is usually rendered smaller than its title_.
 
+:Parents:
+    The document_ and sidebar_ elements may contain ``subtitle``.
 
-Content Model
--------------
+:Children:
+    ``subtitle`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``subtitle`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``subtitle`` element contains only the `common attributes`_.
 
 
 Examples
@@ -3994,12 +4022,89 @@
 ``table``
 =========
 
-Docutils tables are based on the Exchange subset of the CALS-table model
-(OASIS Technical Memorandum 9901:1999 "XML Exchange Table Model DTD",
-http://www.oasis-open.org/html/tm9901.htm).
+The ``table`` element identifies a data arrangement with rows and columns.
 
-`To be completed`_.
+Docutils tables are based on the `Exchange subset of the CALS-table
+model` exchange-table-model_. #_
+
+.. # The interpretation of column widths in colspec_ differs from the
+   specification.
+
+Details
+-------
+
+:Category:
+    `Compound Body Elements`_
+
+:Analogues:
+    ``table`` is analogous to the HTML "table" element.
+
+:Processing:
+    Content is rendered in rows and columns.
+
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``table``.
+
+:Children:
+    ``table`` elements begin with an optional title_ (caption) and may
+    contain one or more `tgroup`_ elements. ::
+
+        (title?, tgroup+)
+
+:Attributes:
+    The ``table`` element contains the attributes frame, colsep, rowsep,
+    and pgwide defined in the exchange-table-model_, the
+    `common attributes`_, align_, and width_.
+
+:Parameter Entities:
+    The `%body.elements;`_ parameter entity directly includes
+    ``table``.  The `%structure.model;`_ parameter entity
+    indirectly includes ``table``.
+
+Examples
+--------
+
+In reStructuredText, tables can specified via the
+table__, csv-table_, or list-table_ directives or directly as
+`grid table`_ or `simple table`_, e.g. ::
+
+    ======== ====
+     bread   £2
+     butter  £30
+    ======== ====
+
+Pseudo-XML_ fragment from simple parsing::
+
+    <table>
+        <tgroup cols="2">
+            <colspec colwidth="8">
+            <colspec colwidth="4">
+            <tbody>
+                <row>
+                    <entry>
+                        <paragraph>
+                            bread
+                    <entry>
+                        <paragraph>
+                            £2
+                <row>
+                    <entry>
+                        <paragraph>
+                            butter
+                    <entry>
+                        <paragraph>
+                            £30
+
+__ rst/directives.html#table
+.. _csv-table: rst/directives.html#csv-table
+.. _list-table: rst/directives.html#list-table
+.. _grid table: rst/restructuredtext.html#grid-tables
+.. _simple table: rst/restructuredtext.html#simple-tables
 
+.. exchange-table-model `XML Exchange Table Model DTD`, OASIS Technical
+   Memorandum 9901:1999, http://www.oasis-open.org/html/tm9901.html.
 
 ``target``
 ==========
@@ -4026,12 +4131,6 @@
 :Category:
     `Body Subelements`_ (simple)
 
-:Parents:
-    Only the definition_list_item_ element contains ``term``.
-
-:Children:
-    ``term`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``term`` is analogous to the HTML "dt" element and to the DocBook
     "term" element.
@@ -4039,17 +4138,18 @@
 :Processing:
     See definition_list_item_.
 
+:Parents:
+    Only the definition_list_item_ element contains ``term``.
 
-Content Model
--------------
+:Children:
+    ``term`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``term`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``term`` element contains only the `common attributes`_.
 
 
 Examples
@@ -4062,6 +4162,12 @@
 ``tgroup``
 ==========
 
+See exchange-table-model_.
+.. parsed-literal::
+
+    (colspec_\*, thead_\?, tbody_)
+
+
 `To be completed`_.
 
 
@@ -4086,32 +4192,29 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``tip``.
-
-:Children:
-    ``tip`` elements contain one or more `body elements`_.
-
 :Analogues:
-    ``tip`` is analogous to the DocBook "tip" element.
+    ``tip`` is analogous to the `DocBook "tip"`_ element.
+
+  .. _DocBook "tip": https://tdg.docbook.org/tdg/5.1/tip.html
 
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Tip" (or similar).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``tip``.
 
-Content Model
--------------
+:Children:
+    ``tip`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``tip`` element contains only the `common attributes`_: ids_,
-    names_, dupnames_, source_, and classes_.
+    The ``tip`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes ``tip``.
@@ -4139,7 +4242,7 @@
 =========
 
 The ``title`` element stores the title of a document_, section_,
-topic_, sidebar_, or generic admonition_.
+sidebar_, table_, topic_, or generic admonition_.
 
 
 Details
@@ -4148,28 +4251,24 @@
 :Category:
     `Structural Subelements`_
 
-:Parents:
-    The following elements may contain ``title``: document_, section_,
-    topic_, sidebar_, admonition_
-
-:Children:
-    ``title`` elements may contain text data plus `inline elements`_.
-
 :Analogues:
     ``title`` is analogous to HTML "title" and header ("h1" etc.)
     elements, and to the DocBook "title" element.
 
+:Parents:
+    The following elements may contain ``title``: admonition_, document_,
+    section_, sidebar_, table_, topic_.
 
-Content Model
--------------
+:Children:
+    ``title`` elements may contain text data plus `inline elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``title`` element contains the `common attributes`_ (ids_,
-    names_, dupnames_, source_, and classes_), plus refid_ and auto_.
+    The ``title`` element contains the `common attributes`_
+    plus refid_ and auto_.
 
     ``refid`` is used as a backlink to a table of contents entry.
 
@@ -4218,14 +4317,6 @@
 :Category:
     `Structural Elements`_
 
-:Parents:
-    The following elements may contain ``topic``: document_, section_,
-    sidebar_
-
-:Children:
-    ``topic`` elements begin with a title_ and may contain `body
-    elements`_.
-
 :Analogues:
     ``topic`` is analogous to the DocBook "simplesect" element.
 
@@ -4233,18 +4324,20 @@
     A ``topic`` element should be set off from the rest of the
     document somehow, such as with indentation or a border.
 
+:Parents:
+    The following elements may contain ``topic``: document_, section_,
+    sidebar_
 
-Content Model
--------------
+:Children:
+    ``topic`` elements begin with a title_ and may contain `body
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    (title_?,
-     (`%body.elements;`_)+)
+        (title?, (`%body.elements;`_)+)
 
 :Attributes:
-    The ``topic`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``topic`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%structure.model;`_ parameter entity directly includes
@@ -4300,13 +4393,6 @@
 :Category:
     `Structural Subelements`_
 
-:Parents:
-    The following elements may contain ``transition``: document_,
-    section_
-
-:Children:
-    ``transition`` is an empty element and has no children.
-
 :Analogues:
     ``transition`` is analogous to the HTML "hr" element.
 
@@ -4317,19 +4403,15 @@
     often represented as a row of three well-spaced asterisks with
     vertical space above and below.
 
+:Parents:
+    The following elements may contain ``transition``: document_,
+    section_
 
-Content Model
--------------
-
-::
-
-    EMPTY
-
-The ``transition`` element has no content; it is a "point element".
+:Children:
+    The ``transition`` element has no content.
 
 :Attributes:
-    The ``transition`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``transition`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%structure.model;`_ parameter entity directly includes
@@ -4370,13 +4452,6 @@
 :Category:
     `Bibliographic Elements`_
 
-:Parents:
-    Only the docinfo_ element contains ``version``.
-
-:Children:
-    ``version`` elements may contain text data plus `inline
-    elements`_.
-
 :Analogues:
     ``version`` may be considered analogous to the DocBook "revision",
     "revnumber", or "biblioid" elements.
@@ -4385,17 +4460,19 @@
     Sometimes used with the RCS/CVS keyword "Revision".  See docinfo_
     and revision_.
 
+:Parents:
+    Only the docinfo_ element contains ``version``.
 
-Content Model
--------------
+:Children:
+    ``version`` elements may contain text data plus `inline
+    elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-    `%text.model;`_
+        `%text.model;`_
 
 :Attributes:
-    The ``version`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``version`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%bibliographic.elements;`_ parameter entity directly includes
@@ -4431,7 +4508,8 @@
 The ``warning`` element is an admonition, a distinctive and
 self-contained notice.  Also see the other admonition elements
 Docutils offers (in alphabetical order): attention_, caution_,
-danger_, error_, hint_, important_, note_, tip_.
+danger_, error_, hint_, important_, note_, tip_,
+and the generic admonition_.
 
 
 Details
@@ -4440,32 +4518,29 @@
 :Category:
     `Compound Body Elements`_
 
-:Parents:
-    All elements employing the `%body.elements;`_ or
-    `%structure.model;`_ parameter entities in their content models
-    may contain ``warning``.
-
-:Children:
-    ``warning`` elements contain one or more `body elements`_.
-
 :Analogues:
-    ``warning`` is analogous to the DocBook "warning" element.
+    ``warning`` is analogous to the `DocBook "warning"`_ element.
+
+    .. _DocBook "warning": https://tdg.docbook.org/tdg/5.1/warning.html
 
 :Processing:
     Rendered distinctly (inset and/or in a box, etc.), with the
     generated title "Warning" (or similar).
 
+:Parents:
+    All elements employing the `%body.elements;`_ or
+    `%structure.model;`_ parameter entities in their content models
+    may contain ``warning``.
 
-Content Model
--------------
+:Children:
+    ``warning`` elements contain one or more `body elements`_.
 
-.. parsed-literal::
+    .. parsed-literal::
 
-   (`%body.elements;`_)+
+        (`%body.elements;`_)+
 
 :Attributes:
-    The ``warning`` element contains only the `common attributes`_:
-    ids_, names_, dupnames_, source_, and classes_.
+    The ``warning`` element contains only the `common attributes`_.
 
 :Parameter Entities:
     The `%body.elements;`_ parameter entity directly includes
@@ -4537,9 +4612,7 @@
 _`number`
     The attribute value must be a number. Resolves to ``NMTOKEN``.
 
-    Used in the `start`_ and `scale`_ attributes.
-
-    .. also ltrim, rtrim
+    Used in the `level`_, `morecols`_, `scale`_, and `start`_ attributes.
 
 _`measure`
     A number which may be immediately followed by a unit or percent sign.
@@ -4611,7 +4684,7 @@
    `reference names`_ or from the auto_id_prefix_, prepending the id_prefix_
    and potentially appending numbers for disambiguation.
 
-   __ http://www.w3.org/TR/html401/types.html#type-name
+   __ https://www.w3.org/TR/html401/types.html#type-name
    __ https://www.w3.org/TR/html50/dom.html#the-id-attribute
    __ https://www.w3.org/TR/html-polyglot/#id-attribute
    __ https://tex.stackexchange.com/questions/18311/what-are-the-valid-names-as-labels
@@ -4645,10 +4718,18 @@
 .. contents:: :local:
               :depth: 1
 
-_`Common Attributes`: Through the `%basic.atts;`_ parameter entity,
-all elements contain the following attributes: ids_, names_ or dupnames_,
-source_, and classes_.
+_`Common Attributes`:
+    Through the `%basic.atts;`_ parameter entity, all elements support
+    the following attributes: ids_, names_ or dupnames_, source_, and
+    classes_.
+
+``align``
+=========
+
+Attribute type: `CDATA`_.  Default value: none (inherit).
 
+The ``align`` attribute is used in the figure_, image_, and table_ elements
+(via the `%align-h.att;`_ and `%align-hv.att;`_ parameter entities).
 
 ``anonymous``
 =============
@@ -4713,6 +4794,28 @@
 .. _"class" directive: rst/directives.html#class
 
 
+``colwidth``
+============
+
+Attribute type: `CDATA`_. Default value: "1*"
+
+Column width specification used in the colspec_ element.
+Defined in the exchange-table-model_.
+
+Either proportional measure of the form number*, e.g., “5*” for 5 times
+the proportion, or “*” (which is equivalent to “1*”); fixed measure,
+e.g., 2pt for 2 point, 3pi for 3 pica.
+
+The fixed unit values are case insensitive. The standard list of allowed
+unit values is “pt” (points), “cm” (centimeters), “mm” (millimeters),
+“pi” (picas), and “in” (inches). The default fixed unit should be
+interpreted as “pt” if neither a proportion nor a fixed unit is
+specified.
+
+.. important:: Currently, Docutils interprets unitless numbers as
+   proportions.
+
+
 ``delimiter``
 =============
 
@@ -4765,6 +4868,19 @@
    * Keep additional keys in `ids`
      or in the preceding target elements?
 
+``level``
+=========
+
+Attribute type: number_.  Default value: none.
+
+The ``level`` attribute is used in the system_message_ element.
+
+``morecols``
+============
+
+Attribute type: number_.  Default value: none.
+
+The ``morecols`` attribute is used in the table_ element.
 
 ``names``
 =========
@@ -4832,7 +4948,7 @@
 `%refname.att;`_ and `%reference.atts;`_ parameter entities).
 
 .. _indirect target: rst/restructuredtext.html#indirect-hyperlink-targets
-.. _transforms: transforms.html
+.. _transforms: api/.html
 
 
 ``refuri``
@@ -4861,7 +4977,7 @@
 
 The ``source`` attribute is used to store the path or URL to the
 source text that was used to produce the document tree.  It is one of
-the `common attributes`_, shared by all Docutils elements.
+the `common attributes`_, declared for all Docutils elements.
 
 
 ``start``
@@ -4878,7 +4994,8 @@
 Attribute type: `yesorno`_.  Default value: none.
 
 The ``stub`` attribute is used in the colspec_ element.
-
+It marks a table column containing "stubs" (row titles, on the left).
+See also the csv-table_ and list-table_ directives.
 
 ``suffix``
 ==========
@@ -4888,12 +5005,24 @@
 The ``suffix`` attribute is used in the enumerated_list_ element.
 
 
+.. _title attribute:
+
+``title``
+=========
+
+Attribute type: `CDATA`_.  Default value: none.
+
+The ``title`` attribute stores the title metadata of a document_.  This
+title is typically not part of the rendered document.  It may for
+example be used in HTML's ``title`` element.
+
+
 ``width``
 ==========
 
 Attribute type: measure_.  Default value: none.
 
-The ``width`` attribute is used in the image_ element.
+The ``width`` attribute is used in the figure_, image_, and table_ element.
 
 
 ``xml:space``
@@ -4911,18 +5040,6 @@
 instance.
 
 
-.. _title (attribute):
-
-``title``
-=========
-
-Attribute type: `CDATA`_.  Default value: none.
-
-The ``title`` attribute stores the title metadata of a document.  This
-title is typically not part of the rendered document.  It may for
-example be used in HTML's ``title`` element.
-
-
 ----------------------------
  Parameter Entity Reference
 ----------------------------
@@ -4938,6 +5055,31 @@
 whose names begin with "additional" are meant to allow easy extension
 by wrapper DTDs.
 
+``%align-h.att;``
+=================
+
+The ``%align-h.att;`` parameter entity contains the align_
+attribute for horizontal alignment.
+
+Entity definition::
+
+    align     (left | center | right) #IMPLIED
+
+The figure_ and table_ elements directly employ the
+``%align-h.att;`` parameter entity in their attribute lists.
+
+``%align-hv.att;``
+==================
+
+The ``%align-hv.att;`` parameter entity contains the align_
+attribute for horizontal and vertical alignment.
+
+Entity definition::
+
+    align     (top | middle | bottom | left | center | right) #IMPLIED
+
+The image_ element directly employs the ``%align-hv.att;`` parameter
+entity in its attribute list.
 
 ``%anonymous.att;``
 ===================
@@ -4945,11 +5087,9 @@
 The ``%anonymous.att;`` parameter entity contains the anonymous_
 attribute, used for unnamed hyperlinks.
 
-Entity definition:
-
-.. parsed-literal::
+Entity definition::
 
-    anonymous_ %yesorno; #IMPLIED
+    anonymous %yesorno; #IMPLIED
 
 The reference_ and target_ elements directly employ the
 ``%anonymous.att;`` parameter entity in their attribute lists.
@@ -4961,11 +5101,9 @@
 The ``%auto.att;`` parameter entity contains the auto_ attribute, used
 to indicate an automatically-numbered footnote or title.
 
-Entity definition:
-
-.. parsed-literal::
+Entity definition::
 
-    auto_     CDATA     #IMPLIED
+    auto     CDATA     #IMPLIED
 
 The footnote_, footnote_reference_, and title_ elements directly
 employ the ``%auto.att;`` parameter entity in their attribute lists.
@@ -4977,9 +5115,7 @@
 The ``%backrefs.att;`` parameter entity contains the backrefs_
 attribute, a space-separated list of id references, for backlinks.
 
-Entity definition:
-
-.. parsed-literal::
+Entity definition::
 
     backrefs_  %idrefs.type;    #IMPLIED
 
@@ -4990,8 +5126,7 @@
 ``%basic.atts;``
 ================
 
-The ``%basic.atts;`` parameter entity lists attributes common to all
-Docutils elements.  See `Common Attributes`_.
+The ``%basic.atts;`` parameter entity lists the `common attributes`_.
 
 Entity definition:
 
@@ -5042,13 +5177,13 @@
 .. parsed-literal::
 
     admonition_ | attention_ | block_quote_ | bullet_list_ | caution_
-    | citation_ | compound_ | comment_ | container_ | danger_ |
-      definition_list_ | doctest_block_ | enumerated_list_ | error_ |
-      field_list_ | figure_ | footnote_ | hint_ | image_ | important_
-      | line_block_ | literal_block_ | note_ | option_list_ |
-      paragraph_ | pending_ | raw_ reference_ | rubric_ |
-      substitution_definition_ | system_message_ | table_ | target_ |
-      tip_ | warning_ %additional.body.elements;
+    | citation_ | compound_ | comment_ | container_ | danger_
+    | definition_list_ | doctest_block_ | enumerated_list_ | error_
+    | field_list_ | figure_ | footnote_ | hint_ | image_ | important_
+    | line_block_ | literal_block_ | note_ | option_list_
+    | paragraph_ | pending_ | raw_ reference_ | rubric_
+    | substitution_definition_ | system_message_ | table_ | target_
+    | tip_ | warning_ %additional.body.elements;
 
 The ``%additional.body.elements;`` parameter entity can be used by
 wrapper DTDs to extend ``%body.elements;``.
@@ -5093,10 +5228,10 @@
 
 .. parsed-literal::
 
-    abbreviation_ | acronym_ | citation_reference_ | emphasis_ |
-    footnote_reference_ | generated_ | image_ | inline_ | literal_ |
-    problematic_ | raw_ | reference_ | strong_ | substitution_reference_ |
-    subscript_ | superscript_ | target_ | title_reference_
+    abbreviation_ | acronym_ | citation_reference_ | emphasis_
+    | footnote_reference_ | generated_ | image_ | inline_ | literal_
+    | problematic_ | raw_ | reference_ | strong_ | substitution_reference_
+    | subscript_ | superscript_ | target_ | title_reference_
     %additional.inline.elements;
 
 The ``%additional.inline.elements;`` parameter entity can be used by
@@ -5253,7 +5388,7 @@
 
    An additional restriction, which cannot be expressed in the language
    of DTDs, is imposed by software:
-   
+
    * A transition may not occur at the end of a document or section.
 
 The `%structure.model;`_ parameter entity is directly employed in the

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/docutils.dtd -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/docutils.dtd Changed

@@ -4,15 +4,15 @@
 ======================================================================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8524 $
-:Date: $Date: 2020-07-10 12:08:14 +0200 (Fr, 10. Jul 2020) $
+:Revision: $Revision: 8956 $
+:Date: $Date: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $
 :Copyright: This DTD has been placed in the public domain.
 :Filename: docutils.dtd
 
 More information about this DTD (document type definition) and the
-Docutils project can be found at http://docutils.sourceforge.net/.
+Docutils project can be found at https://docutils.sourceforge.io/.
 The latest version of this DTD is available from
-http://docutils.sourceforge.net/docs/ref/docutils.dtd.
+https://docutils.sourceforge.io/docs/ref/docutils.dtd.
 
 The formal public identifier for this DTD is::
 
@@ -253,6 +253,7 @@
 
 <!ELEMENT document
     ( (title, subtitle?)?,
+      meta?,
       decoration?,
       (docinfo, transition?)?,
       %structure.model; )>
@@ -281,7 +282,7 @@
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 -->
 
-
+
 <!ELEMENT docinfo (%bibliographic.elements;)+>
 <!ATTLIST docinfo %basic.atts;>
 
@@ -322,6 +323,10 @@
 <!ELEMENT copyright %text.model;>
 <!ATTLIST copyright %basic.atts;>
 
+
+<!ELEMENT meta (field_list+)>
+<!ATTLIST meta %basic.atts;>
+
 <!--
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     Decoration Elements

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/rst/definitions.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/definitions.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../../header2.txt
+
 ============================================
  reStructuredText Standard Definition Files
 ============================================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -84,7 +86,7 @@
 unicode.xml__, which is maintained as part of the MathML 2
 Recommentation XML source.
 
-__ http://www.w3.org/2003/entities/xml/
+__ https://www.w3.org/2003/entities/xml/
 
 ===================  =================================================
 Entity Set File      Description
@@ -165,7 +167,7 @@
 
 The "s5defs.txt_" standard definition file contains interpreted text
 roles (classes) and other definitions for documents destined to become
-`S5/HTML slide shows`_.  
+`S5/HTML slide shows`_.
 
 .. _s5defs.txt: ../../../docutils/parsers/rst/include/s5defs.txt
 .. _S5/HTML slide shows: ../../user/slide-shows.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/rst/directives.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/directives.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../../header2.txt
+
 =============================
  reStructuredText Directives
 =============================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8633 $
-:Date: $Date: 2021-03-09 13:54:13 +0100 (Di, 09. Mär 2021) $
+:Revision: $Revision: 9361 $
+:Date: $Date: 2023-04-21 01:04:43 +0200 (Fr, 21. Apr 2023) $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -49,16 +51,14 @@
  Admonitions
 -------------
 
-.. From Webster's Revised Unabridged Dictionary (1913) web1913:
-   Admonition
-      Gentle or friendly reproof; counseling against a fault or
-      error; expression of authoritative advice; friendly caution
-      or warning.
+Admonitions ("safety messages" or "hazard statements") can appear anywhere
+an ordinary body element can.  They contain arbitrary body elements.
+Typically, an admonition is rendered as an offset block in a document,
+sometimes outlined or shaded.
 
-      Syn: {Admonition}, {Reprehension}, {Reproof}.
+Docutils defines a `generic admonition`_ as well as a set of
+`specific admonitions`_.
 
-      Usage: Admonition is prospective, and relates to moral delinquencies;
-             its object is to prevent further transgression.
 
 .. _attention:
 .. _caution:
@@ -74,18 +74,23 @@
 ====================
 
 :Directive Types: "attention", "caution", "danger", "error", "hint",
-                  "important", "note", "tip", "warning", "admonition"
-:Doctree Elements: attention, caution, danger, error, hint, important,
-                   note, tip, warning, admonition_, title
+                  "important", "note", "tip", "warning"
+:Doctree Elements: `attention <../doctree.html#attention>`__,
+                   `caution <../doctree.html#caution>`__                        ,
+                   `danger <../doctree.html#danger>`__,
+                   `error <../doctree.html#error>`__,
+                   `hint <../doctree.html#hint>`__,
+                   `important <../doctree.html#important>`__,
+                   `note <../doctree.html#note>`__,
+                   `tip <../doctree.html#tip>`__,
+                   `warning <../doctree.html#warning>`__
+
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Interpreted as body elements.
 
-Admonitions are specially marked "topics" that can appear anywhere an
-ordinary body element can.  They contain arbitrary body elements.
-Typically, an admonition is rendered as an offset block in a document,
-sometimes outlined or shaded, with a title matching the admonition
-type.  For example::
+Specific admontions are rendered with a title matching the admonition type.
+For example::
 
     .. DANGER::
        Beware killer rabbits!
@@ -98,18 +103,6 @@
     | Beware killer rabbits! |
     +------------------------+
 
-The following admonition directives have been implemented:
-
-- attention
-- caution
-- danger
-- error
-- hint
-- important
-- note
-- tip
-- warning
-
 Any text immediately following the directive indicator (on the same
 line and/or indented on following lines) is interpreted as a directive
 block and is parsed for normal body elements.  For example, the
@@ -124,22 +117,24 @@
        - It includes this bullet list.
 
 
+.. _admonition:
+
 Generic Admonition
 ==================
 
 :Directive Type: "admonition"
-:Doctree Elements: admonition_, title
+:Doctree Elements: `admonition <../doctree.html#admonition>`__,
+                   `title <../doctree.html#title>`__
 :Directive Arguments: One, required (admonition title)
-:Directive Options: Possible, see below.
+:Directive Options: class_, name_
 :Directive Content: Interpreted as body elements.
 
 This is a generic, titled admonition.  The title may be anything the
 author desires.
 
 The author-supplied title is also used as a `"classes"`_ attribute value
-after being converted into a valid identifier form (down-cased;
-non-alphanumeric characters converted to single hyphens; "admonition-"
-prefixed).  For example, this admonition::
+after `identifier normalization`_ and adding the prefix "admonition-".
+For example, this admonition::
 
     .. admonition:: And, by the way...
 
@@ -154,29 +149,64 @@
             <paragraph>
                 You can make up your own admonition too.
 
-The `common options`_ are recognized:
-
-``class`` : text
-    Overrides the computed `"classes"`_ attribute value.
-
-``name`` : text
-  Add `text` to the `"names"`_ attribute of the admonition element.
+The class_ option overrides the generated `"classes"`_ attribute value.
 
 
 --------
  Images
 --------
 
-There are two image directives: "image" and "figure".
+There are two image directives: image_ and figure_.
+
+.. attention::
+
+  It is up to the author to ensure compatibility of the image data format
+  with the output format or user agent (LaTeX engine, `HTML browser`__).
+  The following, non exhaustive table provides an overview:
+
+  =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
+  ..          vector image  raster image                  moving image #_
+  ----------- ------------- ----------------------------- -----------------
+  ..          SVG    PDF    PNG   JPG   GIF   APNG  AVIF  WebM  MP4   OGG
+  =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
+  HTML4_      ✓ #_        ✓     ✓     ✓     (✓)   (✓)
+
+  HTML5_      ✓             ✓     ✓     ✓     ✓     ✓     ✓     ✓     ✓
+
+  LaTeX_ #_        ✓      ✓     ✓
+
+  ODT_        ✓      ✓      ✓     ✓     ✓
+  =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
+
+  .. # The `html5 writer`_ uses the ``<video>`` tag if the image URI
+         ends with an extension matching one of the listed video formats
+         (since Docutils 0.17).
+
+  .. # The html4 writer uses an ``<object>`` tag for SVG images
+         for better compatibility with older browsers.
+
+  .. # When compiling with ``pdflatex``, ``xelatex``, or ``lualatex``.
+         The original ``latex`` engine supports only the EPS image format.
+         Some build systems, e.g. rubber_ support additional formats
+         via on-the-fly image conversion.
+
+__ https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types
+.. _HTML4:
+.. _html4 writer: ../../user/html.html#html4css1
+.. _HTML5:
+.. _html5 writer: ../../user/html.html#html5-polyglot
+.. _LaTeX: ../../user/latex.html#image-inclusion
+.. _ODT: ../../user/odt.html
+.. _rubber: https://github.com/petrhosek/rubber
 
 
 Image
 =====
 
 :Directive Type: "image"
-:Doctree Element: image_
-:Directive Arguments: One, required (image URI).
-:Directive Options: Possible.
+:Doctree Element: `image <../doctree.html#image>`__
+:Directive Arguments: One, required (image URI_).
+:Directive Options: Possible (see below).
 :Directive Content: None.
 
 An "image" is a simple picture::
@@ -206,18 +236,18 @@
 
 The following options are recognized:
 
-``alt`` : text
+``alt`` : text_
     Alternate text: a short description of the image, displayed by
     applications that cannot display images, or spoken by applications
     for visually impaired users.
 
-``height`` : `length`_
+``height`` : length_
     The desired height of the image.
     Used to reserve space or scale the image vertically.  When the "scale"
     option is also specified, they are combined.  For example, a height of
     200px and a scale of 50 is equivalent to a height of 100px with no scale.
 
-``width`` : `length`_ or `percentage`_ of the current line width
+``width`` : length_ or percentage_ of the current line width
     The width of the image.
     Used to reserve space or scale the image horizontally.  As with "height"
     above, when the "scale" option is also specified, they are combined.
@@ -227,7 +257,7 @@
     no scaling.
 
     If no "height" or "width" options are specified, the `Python
-    Imaging Library`_ (PIL/Pillow_) may be used to determine them, if
+    Imaging Library` (PIL/Pillow_) may be used to determine them, if
     it is installed and the image file is available.
 
 ``align`` : "top", "middle", "bottom", "left", "center", or "right"
@@ -242,12 +272,12 @@
     text flow around it.  The specific behavior depends upon the
     browser or rendering software used.
 
-``target`` : text (URI or reference name)
+``target`` : URI_ or `reference name`_
     Makes the image into a hyperlink reference ("clickable").  The
     option argument may be a URI (relative or absolute), or a
     `reference name`_ with underscore suffix (e.g. ```a name`_``).
 
-and the common options `:class:`_ and `:name:`_.
+and the common options class_ and name_.
 
 
 Figure
@@ -255,8 +285,8 @@
 
 :Directive Type: "figure"
 :Doctree Elements: figure_, image_, caption_, legend_
-:Directive Arguments: One, required (image URI).
-:Directive Options: Possible.
+:Directive Arguments: One, required (image URI_).
+:Directive Options: Possible (see below).
 :Directive Content: Interpreted as the figure caption and an optional
                     legend.
 
@@ -329,12 +359,11 @@
         |wrap at this width.        |
         +---------------------------+
 
-``figclass`` : text
+``figclass`` : space separated list of `class names`_
     Set a `"classes"`_ attribute value on the figure element.  See the
     class_ directive below.
 
 .. _Python Imaging Library:
-    https://en.wikipedia.org/wiki/Python_Imaging_Library
 .. _Pillow: https://pypi.org/project/Pillow/
 
 
@@ -348,7 +377,7 @@
 :Directive Type: "topic"
 :Doctree Element: topic_
 :Directive Arguments: One, required (topic title).
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Interpreted as the topic body.
 
 A topic is like a block quote with a title, or a self-contained
@@ -401,10 +430,10 @@
 
 The following options are recognized:
 
-``subtitle`` : text
+``subtitle`` : text_
     The sidebar's subtitle.
 
-and the common options `:class:`_ and `:name:`_.
+and the common options class_ and name_.
 
 
 Line Block
@@ -420,7 +449,7 @@
 :Directive Type: "line-block"
 :Doctree Element: line_block_
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Becomes the body of the line block.
 
 The "line-block" directive constructs an element where line breaks and
@@ -445,7 +474,6 @@
             Love, Ewan.
 
 
-
 .. _parsed-literal:
 
 Parsed Literal Block
@@ -454,7 +482,7 @@
 :Directive Type: "parsed-literal"
 :Doctree Element: literal_block_
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Becomes the body of the literal block.
 
 Unlike an ordinary literal block, the "parsed-literal" directive
@@ -480,6 +508,7 @@
          (docinfo_, transition_?)?,
          `%structure.model;`_ )
 
+
 Code
 ====
 
@@ -490,8 +519,6 @@
 :Directive Content: Becomes the body of the literal block.
 :Configuration Setting: syntax_highlight_.
 
-(New in Docutils 0.9)
-
 The "code" directive constructs a literal block. If the code language is
 specified, the content is parsed by the Pygments_ syntax highlighter and
 tokens are stored in nested `inline elements`_ with class arguments
@@ -500,28 +527,28 @@
 `sandbox/stylesheets`__ for examples).
 
 The parsing can be turned off with the syntax_highlight_ configuration
-setting and command line option or by specifying the language as `:class:`_
+setting and command line option or by specifying the language as class_
 option instead of directive argument. This also avoids warnings
 when Pygments_ is not installed or the language is not in the
 `supported languages and markup formats`_.
 
 For inline code, use the `"code" role`_.
 
-__ http://pygments.org/docs/cmdline/#generating-styles
-__ http://docutils.sourceforge.net/sandbox/stylesheets/
-.. _Pygments: http://pygments.org/
+__ https://pygments.org/docs/cmdline/#generating-styles
+__ https://docutils.sourceforge.io/sandbox/stylesheets/
+.. _Pygments: https://pygments.org/
 .. _syntax_highlight: ../../user/config.html#syntax-highlight
-.. _supported languages and markup formats: http://pygments.org/languages/
+.. _supported languages and markup formats: https://pygments.org/languages/
 .. _"code" role: roles.html#code
 
 
 The following options are recognized:
 
-``number-lines`` : start line number
+``number-lines`` : integer_ (start line number, optional)
     Precede every line with a line number.
-    The optional argument is the number of the first line (defaut 1).
+    The optional argument is the number of the first line (default 1).
 
-and the common options `:class:`_ and `:name:`_.
+and the common options class_ and name_.
 
 Example::
   The content of the following directive ::
@@ -541,18 +568,15 @@
 :Directive Type: "math"
 :Doctree Element: math_block_
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Becomes the body of the math block.
                     (Content blocks separated by a blank line are put in
                     adjacent math blocks.)
 :Configuration Setting: math_output_
 
-(New in Docutils 0.8)
-
 The "math" directive inserts blocks with mathematical content
 (display formulas, equations) into the document. The input format is
-*LaTeX math syntax*\ #math-syntax_ with support for Unicode
-symbols, for example::
+`LaTeX math syntax`_ with support for Unicode symbols, for example::
 
   .. math::
 
@@ -563,25 +587,22 @@
 configuration setting (or the corresponding ``--math-output``
 command line option) select between alternative output formats with
 different subsets of supported elements. If a writer does not
-support math typesetting at all, the content is inserted verbatim.
-
-.. #math-syntax The supported LaTeX commands include AMS extensions
-   (see, e.g., the `Short Math Guide`_).
-
+support math typesetting, the content is inserted verbatim.
 
 For inline formulas, use the `"math" role`_.
 
-.. _Short Math Guide: http://tug.ctan.org/info/short-math-guide/short-math-guide.pdf
+.. _LaTeX math syntax: ../../ref/rst/mathematics.html
 .. _"math" role: roles.html#math
 .. _math_output: ../../user/config.html#math-output
 
+
 Rubric
 ======
 
 :Directive Type: "rubric"
 :Doctree Element: rubric_
 :Directive Arguments: One, required (rubric text).
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: None.
 
 ..
@@ -661,17 +682,17 @@
 See Epigraph_ above for an analogous example.
 
 
+.. compound:
+
 Compound Paragraph
 ==================
 
 :Directive Type: "compound"
-:Doctree Element: compound_
+:Doctree Element: `compound <../doctree.html#compound>`__
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
+:Directive Options: class_, name_
 :Directive Content: Interpreted as body elements.
 
-(New in Docutils 0.3.6)
-
 The "compound" directive is used to create a compound paragraph, which
 is a single logical paragraph containing multiple physical body
 elements such as simple paragraphs, literal blocks, tables, lists,
@@ -717,11 +738,9 @@
 :Directive Type: "container"
 :Doctree Element: `container <container element_>`__
 :Directive Arguments: One or more, optional (class names).
-:Directive Options: `:name:`_
+:Directive Options: name_
 :Directive Content: Interpreted as body elements.
 
-(New in Docutils 0.3.10)
-
 The "container" directive surrounds its contents (arbitrary body
 elements) with a generic block-level "container" element.  Combined
 with the optional "classes_" attribute argument(s), this is an
@@ -742,28 +761,27 @@
 application-specific purposes.
 
 
-
 --------
  Tables
 --------
 
-Formal tables need more structure than the reStructuredText syntax
-supplies.  Tables may be given titles with the table_ directive.
+Formal tables need more structure than the reStructuredText `table syntax`_
+supplies.  Tables may be given titles with the "table_" directive.
 Sometimes reStructuredText tables are inconvenient to write, or table
-data in a standard format is readily available.  The csv-table_
-directive supports CSV data.
+data in a standard format is readily available.  The "csv-table_"
+directive supports CSV #CSV_ data.
+
+.. _table syntax: restructuredtext.html#tables
 
 
 Table
 =====
 
 :Directive Type: "table"
-:Doctree Element: table_
+:Doctree Element: `table <../doctree.html#table>`__
 :Directive Arguments: One, optional (table title).
 :Directive Options: Possible (see below).
-:Directive Content: A normal reStructuredText table.
-
-(New in Docutils 0.3.1)
+:Directive Content: A normal `reStructuredText table`_.
 
 The "table" directive is used to associate a
 title with a table or specify options, e.g.::
@@ -781,27 +799,38 @@
 The following options are recognized:
 
 ``align`` : "left", "center", or "right"
-    The horizontal alignment of the table.
-    (New in Docutils 0.13)
+    The horizontal alignment of the table (new in Docutils 0.13).
+
+``width`` : length_ or percentage_
+    Sets the width of the table to the specified length or percentage
+    of the line width.  If omitted, the renderer determines the width
+    of the table based on its contents or the column ``widths``.
 
-``widths`` : "auto", "grid" or a list of integers
-    A comma- or space-separated list of column widths.
-    The default is the width of the input columns (in characters).
+    .. _column-widths:
 
-    The special values "auto" or "grid" may be used by writers to decide
-    whether to delegate the determination of column widths to the backend
+``widths`` : "auto", "grid", or a `list of integers`_
+    Explicitly set column widths.
+    Specifies relative widths if used with the ``width`` option.
+    Overrides a `table_style`_ setting or class value "colwidths-auto".
+    The default depends on the `table_style`_ configuration setting.
+
+    *"auto"* delegates the determination of column widths to the backend
     (LaTeX, the HTML browser, ...).
-    See also the `table_style`_ configuration option.
+    Default for the `html5 writer`_
 
-``width`` : `length`_ or `percentage`_ of the current line width
-    Forces the width of the table to the specified length or percentage
-    of the line width.  If omitted, the renderer determines the width
-    of the table based on its contents.
+    *"grid"* determines column widths from the widths of the input columns
+    (in characters).
+    Default for most writers.
 
-and the common options `:class:`_ and `:name:`_.
+    A *list of integers* is used instead of the input column widths.
+    Implies *"grid"*.
 
+Plus the common options class_ and name_.
+
+.. _reStructuredText table: restructuredtext.html#tables
 .. _table_style: ../../user/config.html#table-style
 
+
 .. _csv-table:
 
 CSV Table
@@ -811,21 +840,27 @@
 :Doctree Element: table_
 :Directive Arguments: One, optional (table title).
 :Directive Options: Possible (see below).
-:Directive Content: A CSV (comma-separated values) table.
+:Directive Content: A CSV (comma-separated values) table
+                    or (with the `file`_ or `url`_ options) None
 
 .. WARNING::
 
-   The "csv-table" directive's ":file:" and ":url:" options represent
-   a potential security holes.  They can be disabled with the
+   The "csv-table" directive's `file`_ and `url`_ options represent
+   potential security holes.  They can be disabled with the
    "file_insertion_enabled_" runtime setting.
 
-(New in Docutils 0.3.4)
-
 The "csv-table" directive is used to create a table from CSV
-(comma-separated values) data.  CSV is a common data format generated
-by spreadsheet applications and commercial databases.  The data may be
-internal (an integral part of the document) or external (a separate
-file).
+(comma-separated values) #CSV_ data. The data may be internal
+(an integral part of the document) or external (a separate file).
+
+* Block markup and inline markup within cells is supported.  Line ends
+  are recognized within quoted cells.
+
+* There is no support for checking that the number of columns in each
+  row is the same. The directive automatically adds empty entries at
+  the end of short rows.
+
+  .. Add "strict" option to verify input?
 
 Example::
 
@@ -834,101 +869,100 @@
        :widths: 15, 10, 30
 
        "Albatross", 2.99, "On a stick!"
-       "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be
-       crunchy, now would it?"
+       "Crunchy Frog", 1.49, "If we took the bones out,
+       it wouldn't be crunchy, now would it?"
        "Gannet Ripple", 1.99, "On a stick!"
 
-Block markup and inline markup within cells is supported.  Line ends
-are recognized within cells.
+The following options are recognized:
 
-Working limitations:
+``align`` : "left", "center", or "right"
+    The horizontal alignment of the table. (New in Docutils 0.13)
 
-* There is no support for checking that the number of columns in each
-  row is the same.  However, this directive supports CSV generators
-  that do not insert "empty" entries at the end of short rows, by
-  automatically adding empty entries.
+    .. _delimiter:
 
-  .. Add "strict" option to verify input?
+``delim`` : character_, "tab", or "space"
+    The character used to separate data fields.
+    The special values "tab" and "space" are converted to the respective
+    whitespace characters. #tab-expansion_
+    Defaults to ``,`` (comma).
 
-.. #whitespace-delim Whitespace delimiters are supported only for external
-   CSV files.
+``encoding`` : encoding_
+    The text encoding of the external CSV data (file or URL).
+    Defaults to the document's `input_encoding`_.
 
-.. #ASCII-char With Python 2, the valuess for the ``delimiter``,
-   ``quote``, and ``escape`` options must be ASCII characters. (The csv
-   module does not support Unicode and all non-ASCII characters are
-   encoded as multi-byte utf-8 string). This limitation does not exist
-   under Python 3.
+``escape`` : character_
+    A character used to escape the delimiter_ or quote_ characters from
+    the CSV parser. The default is no escape character -- fields may
+    contain delimiter or newline characers if they are quoted, two quote
+    characters stand for a literal one, e.g., ``"He said, ""Hi!"""``.
 
-The following options are recognized:
+    .. Caution:: Setting ``escape`` to ``\`` (backslash) interferes with
+       the reStructuredText `escaping mechanism`_ (applied after CSV
+       parsing). You will need two backslashes to escape reStructuredText
+       markup and four backslashes for a literal one.
 
-``widths`` : integer , integer... or "auto"
-    A comma- or space-separated list of relative column widths.  The
-    default is equal-width columns (100%/#columns).
+    .. _`file`:
 
-    The special value "auto" may be used by writers to decide
-    whether to delegate the determination of column widths to the backend
-    (LaTeX, the HTML browser, ...).
+``file`` : path_
+    The local filesystem path to a CSV data file.
 
-``width`` : `length`_ or `percentage`_ of the current line width
-    Forces the width of the table to the specified length or percentage
-    of the line width.  If omitted, the renderer determines the width
-    of the table based on its contents.
+``header`` : text_ (CSV data)
+    Supplemental data for the table header, added independently of and
+    before any ``header-rows`` from the main CSV data.  Must use the
+    same CSV format as the main CSV data.
 
-``header-rows`` : integer
+    .. Important:: Currently, the header option uses a hard-coded CSV
+       dialect with the backslash as escape character (interfering with
+       the reStructuredText `escaping mechanism`_). This will change to
+       the documented behaviour in Docutils 0.21.
+
+``header-rows`` : integer_
     The number of rows of CSV data to use in the table header.
     Defaults to 0.
 
-``stub-columns`` : integer
-    The number of table columns to use as stubs (row titles, on the
-    left).  Defaults to 0.
+``keepspace`` : flag_
+    Treat whitespace immediately following the delimiter as
+    significant.  The default is to ignore such whitespace.
 
-``header`` : CSV data
-    Supplemental data for the table header, added independently of and
-    before any ``header-rows`` from the main CSV data.  Must use the
-    same CSV format as the main CSV data.
+    .. _quote:
 
-``file`` : string (newlines removed)
-    The local filesystem path to a CSV data file.
+``quote`` : character_
+    The character used to quote fields containing special characters,
+    such as the delimiter_, quote, or new-line characters.
+    Defaults to ``"`` (quote).
+
+``stub-columns`` : integer_
+    The number of table columns to use as stubs (row titles, on the left).
+    Defaults to 0.
 
-``url`` : string (whitespace removed)
-    An Internet URL reference to a CSV data file.
+    .. _`url`:
 
-``encoding`` : name of text encoding
-    The text encoding of the external CSV data (file or URL).
-    Defaults to the document's encoding (if specified).
+``url`` : URI_
+    An Internet URI reference to a CSV data file.
 
-``delim`` : char | "tab" | "space" #whitespace-delim_
-    A one-character string\ #ASCII-char_ used to separate fields.
-    Defaults to ``,`` (comma).  May be specified as a Unicode code
-    point; see the unicode_ directive for syntax details.
+``widths`` : `list of integers`_ or "auto"
+    A list of relative column widths.
+    The default is equal-width columns (100%/#columns).
 
-``quote`` : char
-    A one-character string\ #ASCII-char_ used to quote elements
-    containing the delimiter or which start with the quote
-    character.  Defaults to ``"`` (quote).  May be specified as a
-    Unicode code point; see the unicode_ directive for syntax
-    details.
+    "auto" delegates the determination of column widths to the backend
+    (LaTeX, the HTML browser, ...).
 
-``keepspace`` : flag
-    Treat whitespace immediately following the delimiter as
-    significant.  The default is to ignore such whitespace.
+``width`` : length_ or percentage_
+    Sets the width of the table to the specified length or percentage
+    of the line width.  If omitted, the renderer determines the width
+    of the table based on its contents or the column ``widths``.
 
-``escape`` : char
-    A one-character\ #ASCII-char_ string used to escape the
-    delimiter or quote characters.  May be specified as a Unicode
-    code point; see the unicode_ directive for syntax details.  Used
-    when the delimiter is used in an unquoted field, or when quote
-    characters are used within a field.  The default is to double-up
-    the character, e.g. "He said, ""Hi!"""
+and the common options class_ and name_.
 
-    .. Add another possible value, "double", to explicitly indicate
-       the default case?
+.. #CSV CSV (comma separated values) is a common data format generated
+   by spreadsheet applications and commercial databases. Despite the
+   "comma" in its name, the field delimiter_ may be any Unicode character.
 
-``align`` : "left", "center", or "right"
-    The horizontal alignment of the table.
-    (New in Docutils 0.13)
+.. #tab-expansion Note, that tabs can be used as separator only in
+   external files because hard tabs the directive content are
+   `converted to spaces`__ before it reaches the CVS reader.
 
-and the common options `:class:`_ and `:name:`_.
+   __ restructuredtext.html#whitespace
 
 
 List Table
@@ -940,8 +974,8 @@
 :Directive Options: Possible (see below).
 :Directive Content: A uniform two-level bullet list.
 
-(New in Docutils 0.3.8.  This is an initial implementation; `further
-ideas`__ may be implemented in the future.)
+(This is an initial implementation; `further ideas`__ may be implemented
+in the future.)
 
 __ ../../dev/rst/alternatives.html#list-driven-tables
 
@@ -971,32 +1005,36 @@
 
 The following options are recognized:
 
-``widths`` : integer integer... or "auto"
-    A comma- or space-separated list of relative column widths.  The
-    default is equal-width columns (100%/#columns).
 
-    The special value "auto" may be used by writers to decide
-    whether to delegate the determination of column widths to the backend
-    (LaTeX, the HTML browser, ...).
-
-``width`` : `length`_ or `percentage`_ of the current line width
-    Forces the width of the table to the specified length or percentage
-    of the line width.  If omitted, the renderer determines the width
-    of the table based on its contents.
+``align`` : "left", "center", or "right"
+    The horizontal alignment of the table.
+    (New in Docutils 0.13)
 
-``header-rows`` : integer
+``header-rows`` : integer_
     The number of rows of list data to use in the table header.
     Defaults to 0.
 
-``stub-columns`` : integer
+``stub-columns`` : integer_
     The number of table columns to use as stubs (row titles, on the
     left).  Defaults to 0.
 
-``align`` : "left", "center", or "right"
-    The horizontal alignment of the table.
-    (New in Docutils 0.13)
+    .. _table width:
+
+``width`` : length_ or percentage_
+    Sets the width of the table to the specified length or percentage
+    of the line width.  If omitted, the renderer determines the width
+    of the table based on its contents or the column ``widths``.
 
-and the common options `:class:`_ and `:name:`_.
+    .. _column widths:
+
+``widths`` : `list of integers`_ or "auto"
+    A list of relative column widths.
+    The default is equal-width columns (100%/#columns).
+
+    "auto" delegates the determination of column widths to the backend
+    (LaTeX, the HTML browser, ...).
+
+and the common options class_ and name_.
 
 
 ----------------
@@ -1011,7 +1049,7 @@
 :Directive Type: "contents"
 :Doctree Elements: pending_, topic_
 :Directive Arguments: One, optional: title.
-:Directive Options: Possible.
+:Directive Options: Possible (see below).
 :Directive Content: None.
 
 The "contents" directive generates a table of contents (TOC) in a
@@ -1047,20 +1085,20 @@
 
 The following options are recognized:
 
-``depth`` : integer
+``depth`` : integer_
     The number of section levels that are collected in the table of
     contents.  The default is unlimited depth.
 
-``local`` : flag (empty)
+``local`` : flag_
     Generate a local table of contents.  Entries will only include
     subsections of the section in which the directive is given.  If no
     explicit title is given, the table of contents will not be titled.
 
 ``backlinks`` : "entry" or "top" or "none"
     Generate links from section headers back to the table of contents
-    entries, the table of contents itself, or generate no backlinks.
+    entries, the table of contents itself, or generate no back-links.
 
-``class`` : text
+``class`` : text_ (list of `class names`_)
     Set a `"classes"`_ attribute value on the topic element.  See the
     class_ directive below.
 
@@ -1074,7 +1112,7 @@
 :Directive Type: "sectnum" or "section-numbering" (synonyms)
 :Doctree Elements: pending_, generated_
 :Directive Arguments: None.
-:Directive Options: Possible.
+:Directive Options: Possible (see below).
 :Directive Content: None.
 :Configuration Setting: sectnum_xform_
 
@@ -1097,22 +1135,22 @@
 
 The following options are recognized:
 
-``depth`` : integer
+``depth`` : integer_
     The number of section levels that are numbered by this directive.
     The default is unlimited depth.
 
-``prefix`` : string
+``prefix`` : text_
     An arbitrary string that is prefixed to the automatically
     generated section numbers.  It may be something like "3.2.", which
     will produce "3.2.1", "3.2.2", "3.2.2.1", and so on.  Note that
     any separating punctuation (in the example, a period, ".") must be
     explicitly provided.  The default is no prefix.
 
-``suffix`` : string
+``suffix`` : text_
     An arbitrary string that is appended to the automatically
     generated section numbers.  The default is no suffix.
 
-``start`` : integer
+``start`` : integer_
     The value that will be used for the first section number.
     Combined with ``prefix``, this may be used to force the right
     numbering for a document split over several source files.  The
@@ -1133,8 +1171,6 @@
 :Directive Options: None.
 :Directive Content: Interpreted as body elements.
 
-(New in Docutils 0.3.8)
-
 The "header" and "footer" directives create document decorations,
 useful for page navigation, notes, time/datestamp, etc.  For example::
 
@@ -1166,7 +1202,7 @@
 enabled, the document footer is populated with processing information
 such as a datestamp, a link to `the Docutils website`_, etc.
 
-.. _the Docutils website: http://docutils.sourceforge.net
+.. _the Docutils website: https://docutils.sourceforge.io
 
 
 ------------
@@ -1181,8 +1217,8 @@
 :Directive Type: "target-notes"
 :Doctree Elements: pending_, footnote_, footnote_reference_
 :Directive Arguments: None.
-:Directive Options: `:class:`_, `:name:`_
-:Directive Options: Possible.
+:Directive Options: class_, name_
+:Directive Options: Possible (see below).
 :Directive Content: None.
 
 The "target-notes" directive creates a footnote for each external
@@ -1219,17 +1255,16 @@
 
 @@@
 
+.. ---------------
+    HTML-Specific
+   ---------------
 
----------------
- HTML-Specific
----------------
-
-Imagemap
-========
+   Imagemap
+   ========
 
-**NOT IMPLEMENTED YET**
+   **NOT IMPLEMENTED YET**
 
-Non-standard element: imagemap.
+   Non-standard element: imagemap.
 
 
 -----------------------------------------
@@ -1244,6 +1279,7 @@
 .. _substitution definitions:
 .. _substitution definition: restructuredtext.html#substitution-definitions
 
+
 .. _replace:
 
 Replacement Text
@@ -1272,7 +1308,7 @@
     I recommend you try |Python|_.
 
     .. |Python| replace:: Python, *the* best language around
-    .. _Python: http://www.python.org/
+    .. _Python: https://www.python.org/
 
 
 .. _unicode:
@@ -1284,7 +1320,7 @@
 :Doctree Element: Text
 :Directive Arguments: One or more, required (Unicode character codes,
                       optional text, and comments).
-:Directive Options: Possible.
+:Directive Options: Possible (see below).
 :Directive Content: None.
 
 The "unicode" directive converts Unicode character codes (numerical
@@ -1293,6 +1329,8 @@
 
 The arguments, separated by spaces, can be:
 
+.. _character code:
+
 * **character codes** as
 
   - decimal numbers or
@@ -1331,13 +1369,13 @@
 
 The following options are recognized:
 
-``ltrim`` : flag
+``ltrim`` : flag_
     Whitespace to the left of the substitution reference is removed.
 
-``rtrim`` : flag
+``rtrim`` : flag_
     Whitespace to the right of the substitution reference is removed.
 
-``trim`` : flag
+``trim`` : flag_
     Equivalent to ``ltrim`` plus ``rtrim``; whitespace on both sides
     of the substitution reference is removed.
 
@@ -1356,7 +1394,7 @@
 definitions only.
 
 The optional directive content is interpreted as the desired date
-format, using the same codes as Python's time.strftime function.  The
+format, using the same codes as Python's `time.strftime()`__ function.  The
 default format is "%Y-%m-%d" (ISO 8601 date), but time fields can also
 be used.  Examples::
 
@@ -1367,6 +1405,8 @@
 
     This document was generated on |date| at |time|.
 
+__ https://docs.python.org/3/library/time.html#time.strftime
+
 
 ---------------
  Miscellaneous
@@ -1380,8 +1420,8 @@
 :Directive Type: "include"
 :Doctree Elements: Depend on data being included
                    (literal_block_ with ``code`` or ``literal`` option).
-:Directive Arguments: One, required (path to the file to include).
-:Directive Options: Possible.
+:Directive Arguments: One, required (path_ to the file to include).
+:Directive Options: Possible (see below).
 :Directive Content: None.
 :Configuration Setting: file_insertion_enabled_
 
@@ -1430,70 +1470,70 @@
 
 The following options are recognized:
 
-``start-line`` : integer
+``start-line`` : integer_
     Only the content starting from this line will be included.
     (As usual in Python, the first line has index 0 and negative values
     count from the end.)
 
-``end-line`` : integer
+``end-line`` : integer_
     Only the content up to (but excluding) this line will be included.
 
-``start-after`` : text to find in the external data file
-    Only the content after the first occurrence of the specified text
-    will be included.
+``start-after`` : text_
+    Only the content after the first occurrence of the specified *text*
+    in the external data file will be included.
 
-``end-before`` : text to find in the external data file
-    Only the content before the first occurrence of the specified text
-    (but after any ``after`` text) will be included.
+``end-before`` : text_
+    Only the content before the first occurrence of the specified *text*
+    in the external data file (but after any ``start-after`` text)
+    will be included.
 
-``parser`` :  parser name
+``parser`` : text_ (parser name)
     Parse the included content with the specified parser.
     (New in Docutils 0.17)
 
-``literal`` : flag (empty)
+``literal`` : flag_
     The entire included text is inserted into the document as a single
     literal block.
 
-``code`` : formal language (optional)
+``code`` : text_ (formal language, optional)
     The argument and the included content are passed to
     the code_ directive (useful for program listings).
-    (New in Docutils 0.9)
 
-``number-lines`` : start line number
-    Precede every code line with a line number.
-    The optional argument is the number of the first line (defaut 1).
+``number-lines`` : integer_ (start line number, optional)
+    Precede every included line with a line number.
+    The optional argument is the number of the first line (default 1).
     Works only with ``code`` or ``literal``.
-    (New in Docutils 0.9)
 
-``encoding`` : name of text encoding
-    The text encoding of the external data file.  Defaults to the
-    document's input_encoding_.
+``encoding`` : encoding_
+    The text encoding of the external file.
+    Defaults to the document's input_encoding_.
 
     .. _input_encoding: ../../user/config.html#input-encoding
 
-``tab-width`` :  integer
+``tab-width`` : integer_
     Number of spaces for hard tab expansion.
     A negative value prevents expansion of hard tabs. Defaults to the
     tab_width_ configuration setting.
 
     .. _tab_width: ../../user/config.html#tab-width
 
-With ``code`` or ``literal`` the common options `:class:`_ and
-`:name:`_ are recognized as well.
+With ``code`` or ``literal`` the common options class_ and
+name_ are recognized as well.
 
 Combining ``start/end-line`` and ``start-after/end-before`` is possible. The
 text markers will be searched in the specified lines (further limiting the
 included content).
 
-.. _raw-directive:
+
+.. _raw:
 
 Raw Data Pass-Through
 =====================
 
 :Directive Type: "raw"
-:Doctree Element: raw_
+:Doctree Element: `raw <../doctree.html#raw>`__
 :Directive Arguments: One or more, required (output format types).
-:Directive Options: Possible.
+:Directive Options: Possible (see below).
 :Directive Content: Stored verbatim, uninterpreted.  None (empty) if a
                     "file" or "url" option given.
 :Configuration Setting: raw_enabled_
@@ -1501,8 +1541,9 @@
 .. WARNING::
 
    The "raw" directive represents a potential security hole.  It can
-   be disabled with the "raw_enabled_" or "file_insertion_enabled_"
-   runtime settings.
+   be disabled with the "raw_enabled_" runtime setting.
+   Insertion of external files can be disabled with the
+   "file_insertion_enabled_" runtime setting.
 
    .. _raw_enabled: ../../user/config.html#raw-enabled
 
@@ -1528,7 +1569,7 @@
 its format.
 
 For example, the following input would be passed untouched by an HTML
-Writer::
+writer::
 
     .. raw:: html
 
@@ -1553,20 +1594,20 @@
 
 The following options are recognized:
 
-``file`` : string (newlines removed)
+``file`` : path_
     The local filesystem path of a raw data file to be included.
 
-``url`` : string (whitespace removed)
-    An Internet URL reference to a raw data file to be included.
+``url`` : URI_
+    An Internet URI reference to a raw data file to be included.
 
-``encoding`` : name of text encoding
-    The text encoding of the external raw data (file or URL).
-    Defaults to the document's encoding (if specified).
+``encoding`` : encoding_
+    The text encoding of the external raw data (with ``file`` or ``url``).
+    Defaults to the main document's `input_encoding`_ (if specified).
 
-.. _"raw" role: roles.html#raw
+and the common option class_.
 
+.. _"raw" role: roles.html#raw
 
-.. _classes:
 
 Class
 =====
@@ -1685,7 +1726,7 @@
           hyphens ("-"), underscores ("_"), colons (":"), and periods
           (".").
 
-          -- http://www.w3.org/TR/html401/types.html#type-name
+          -- https://www.w3.org/TR/html401/types.html#type-name
 
     - The `CSS1 spec`_ defines identifiers based on the "name" token
       ("flex" tokenizer notation below; "latin1" and "escape" 8-bit
@@ -1714,8 +1755,9 @@
        __ https://www.w3.org/TR/CSS22/syndata.html
        __ https://www.w3.org/TR/css-syntax-3/#typedef-ident-token
 
-    .. _HTML 4.01 spec: http://www.w3.org/TR/html401/
-    .. _CSS1 spec: http://www.w3.org/TR/REC-CSS1
+    .. _HTML 4.01 spec: https://www.w3.org/TR/html401/
+    .. _CSS1 spec: https://www.w3.org/TR/REC-CSS1
+
 
 .. _role:
 
@@ -1729,8 +1771,6 @@
 :Directive Options: Possible (depends on base role).
 :Directive Content: depends on base role.
 
-(New in Docutils 0.3.2)
-
 The "role" directive dynamically creates a custom `interpreted text
 role`_ and registers it with the parser.  This means that after
 declaring a role like this::
@@ -1801,7 +1841,7 @@
 The following option is recognized by the "role" directive for most
 base roles:
 
-``class`` : text
+``class`` : space separated list of `class names`_
     Set the `"classes"`_ attribute value on the element produced
     (``inline``, or element associated with a base class) when the
     custom interpreted text role is used.  If no directive options are
@@ -1826,8 +1866,6 @@
 :Directive Options: None.
 :Directive Content: None.
 
-(New in Docutils 0.3.10)
-
 The "default-role" directive sets the default interpreted text role,
 the role that is used for interpreted text without an explicit role.
 For example, after setting the default role like this::
@@ -1858,11 +1896,13 @@
 parser is "title-reference".
 
 
+.. _meta:
+
 Metadata
 ========
 
 :Directive Type: "meta"
-:Doctree Element: pending_, meta (non-standard)
+:Doctree Element: `meta <../doctree.html#meta>`__
 :Directive Arguments: None.
 :Directive Options: None.
 :Directive Content: Must contain a flat field list.
@@ -1875,7 +1915,7 @@
 
 .. note:: Data from some `bibliographic fields`_ is automatically
    extracted and stored as metadata, too. However, Bibliographic
-   Fields are also visible in the document's screen rendering or
+   Fields are also displayed in the document's screen rendering or
    printout.
 
    For an "invisible" *document title*, see the `metadata document
@@ -1921,34 +1961,38 @@
     <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
+.. _hyperref: https://ctan.org/pkg/hyperref
 .. _bibliographic fields: restructuredtext.html#bibliographic-fields
 
 
+.. _title:
+
 Metadata Document Title
 =======================
 
 :Directive Type: "title"
-:Doctree Element: None.
+:Doctree Element: Sets the document's `title attribute`_.
 :Directive Arguments: One, required (the title text).
 :Directive Options: None.
 :Directive Content: None.
 
 The "title" directive specifies the document title as metadata, which
-does not become part of the document body.  It overrides a
-document-supplied title.  For example, in HTML output the metadata
-document title appears in the title bar of the browser window.
+does not become part of the document body. It overrides the
+document-supplied `document title`_ and the `"title" configuration
+setting`_. For example, in HTML output the metadata document title
+appears in the title bar of the browser window.
+
+.. _document title: restructuredtext.html#document-title
+.. _"title" configuration setting: ../../user/config.html#title
 
 
 Restructuredtext-Test-Directive
@@ -1966,6 +2010,7 @@
 followed by a literal block containing the rest of the directive
 block.
 
+
 --------------
 Common Options
 --------------
@@ -1974,12 +2019,15 @@
 options:
 
 .. _class-option:
+.. _class:
 
-_`:class:` : text
+``class`` : space separated list of `class names`_
     Set a `"classes"`_ attribute value on the doctree element generated by
     the directive. See also the class_ directive.
 
-_`:name:` : text
+    .. _name:
+
+``name`` : text_
     Add `text` to the `"names"`_ attribute of the doctree element generated
     by the directive. This allows `hyperlink references`_ to the element
     using `text` as `reference name`_.
@@ -1996,43 +2044,101 @@
 
       .. image:: bild.png
 
-    (New in Docutils 0.8.)
 
+-------------------------
+Common Option Value Types
+-------------------------
+
+*"keyword"*
+  recognized keywords.
+  Used without quotes in the reStructuredText source.
+
+  .. _character:
+
+*character*
+  single character.
+  May be specified as literal character or as Unicode `character code`_
+  (cf. the unicode_ directive).
+
+  .. _encoding:
+
+*encoding*
+  text encoding name.
+  Docutils looks it up in the list of registered codecs_
+  (see also `Standard Encodings`_).
+
+  .. _flag:
+
+*flag*
+  no value.
+
+  .. _integer:
+
+*integer*
+  integer number.
+  A _`list of integers` may be comma- or whitespace-separated.
+
+  .. _length:
+
+*length*
+  number followed by one of the supported `length units`_.
+
+  .. _path:
+
+*path*
+  local filesystem path. Newlines are removed.
+
+  .. _text:
+
+*text*
+  free text (with possible restrictions in parentheses).
+
+  .. _URI:
+
+*URI*
+  `Uniform Resource Identifier`_.
+  Whitespace is removed, cf. `External hyperlink targets`_.
+
+
+.. _codecs: https://docs.python.org/3/library/codecs.html
+.. _Standard Encodings:
+    https://docs.python.org/3/library/codecs.html#standard-encodings
+.. _Uniform Resource Identifier:
+    https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
 
-.. _reference name:
-.. _reference names: restructuredtext.html#reference-names
-.. _hyperlink target: restructuredtext.html#hyperlink-targets
-.. _hyperlink references: restructuredtext.html#hyperlink-references
-.. _class names: ../doctree.html#classnames-type
-.. _"classes": ../doctree.html#classes
-.. _identifier keys: ../doctree.html#ids-type
-.. _"ids": ../doctree.html#ids
-.. _"names": ../doctree.html#names
-.. _admonition: ../doctree.html#admonition
 .. _block_quote: ../doctree.html#block-quote
 .. _caption: ../doctree.html#caption
-.. _compound: ../doctree.html#compound
+.. _class names: ../doctree.html#classname
+.. _"classes":
+.. _classes: ../doctree.html#classes
 .. _container element: ../doctree.html#container
 .. _decoration: ../doctree.html#decoration
+.. _escaping mechanism: restructuredtext.html#escaping-mechanism
+.. _external hyperlink targets:
+    restructuredtext.html#external-hyperlink-targets
 .. _figure: ../doctree.html#figure
 .. _footnote: ../doctree.html#footnote
 .. _footnote_reference: ../doctree.html#footnote-reference
 .. _generated: ../doctree.html#generated
-.. _image: ../doctree.html#image
+.. _hyperlink references: restructuredtext.html#hyperlink-references
+.. _hyperlink target: restructuredtext.html#hyperlink-targets
+.. _identifier keys: ../doctree.html#ids-type
+.. _"ids": ../doctree.html#ids
 .. _inline elements: ../doctree.html#inline-elements
 .. _interpreted text role: roles.html
-.. _literal_block: ../doctree.html#literal-block
 .. _legend: ../doctree.html#legend
-.. _length: restructuredtext.html#length-units
+.. _length units: restructuredtext.html#length-units
 .. _line_block: ../doctree.html#line-block
+.. _literal_block: ../doctree.html#literal-block
 .. _math_block: ../doctree.html#math-block
+.. _"names": ../doctree.html#names
 .. _pending: ../doctree.html#pending
 .. _percentage: restructuredtext.html#percentage-units
-.. _raw: ../doctree.html#raw
+.. _reference name:
+.. _reference names: restructuredtext.html#reference-names
 .. _rubric: ../doctree.html#rubric
 .. _sidebar: ../doctree.html#sidebar
-.. _table: ../doctree.html#table
-.. _title: ../doctree.html#title
+.. _title attribute: ../doctree.html#title-attribute
 .. _topic: ../doctree.html#topic

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/rst/introduction.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/introduction.txt Changed

@@ -1,10 +1,12 @@
+.. include:: ../../header2.txt
+
 =====================================
  An Introduction to reStructuredText
 =====================================
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 7302 $
-:Date: $Date: 2012-01-03 20:23:53 +0100 (Di, 03. Jän 2012) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
@@ -27,13 +29,12 @@
 analysis of the `Problems With StructuredText`_.
 
 ReStructuredText's web page is
-http://docutils.sourceforge.net/rst.html.
+https://docutils.sourceforge.io/rst.html.
 
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _StructuredText:
-    http://www.zope.org/DevHome/Members/jim/StructuredTextWiki/FrontPage
-.. _Setext: http://docutils.sourceforge.net/mirror/setext.html
-.. _Docutils: http://docutils.sourceforge.net/
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _StructuredText: https://zopestructuredtext.readthedocs.org/
+.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
+.. _Docutils: https://docutils.sourceforge.io/
 .. _A ReStructuredText Primer: ../../user/rst/quickstart.html
 .. _Quick reStructuredText: ../../user/rst/quickref.html
 .. _reStructuredText Markup Specification: restructuredtext.html
@@ -144,7 +145,7 @@
 
     David Goodger (goodger@python.org), 2001-04-20
 
-.. _Doc-SIG: http://www.python.org/sigs/doc-sig/
+.. _Doc-SIG: https://www.python.org/sigs/doc-sig/
 
 
 History
@@ -179,7 +180,7 @@
 an exercise in frustration, as the complexity of the module had become
 overwhelming.
 
-In 2000, development on StructuredTextNG_ ("Next Generation") began at
+In 2000, development on StructuredTextNG ("Next Generation") began at
 `Zope Corporation`_ (then Digital Creations).  It seems to have many
 improvements, but still suffers from many of the problems of classic
 StructuredText.
@@ -218,9 +219,9 @@
 - `Problems With StructuredText`__
 - `reStructuredText: Revised Structured Text Specification`__
 
-__ http://mail.python.org/pipermail/doc-sig/2000-November/001239.html
-__ http://mail.python.org/pipermail/doc-sig/2000-November/001240.html
-__ http://mail.python.org/pipermail/doc-sig/2000-November/001241.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001239.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001240.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001241.html
 
 In March 2001 a flurry of activity on the Doc-SIG spurred me to
 further revise and refine my specification, the result of which you
@@ -269,10 +270,10 @@
    - `Python Extensions to the reStructuredText Markup
      Specification`__
 
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001858.html
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001859.html
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001860.html
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001861.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001858.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001859.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001860.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001861.html
 
 .. #peps-1 First drafts of the PEPs:
 
@@ -281,28 +282,26 @@
    - `PEP 257: Docstring Conventions`__
 
    Current working versions of the PEPs can be found in
-   http://docutils.sourceforge.net/docs/peps/, and official versions
+   https://docutils.sourceforge.io/docs/peps/, and official versions
    can be found in the `master PEP repository`_.
 
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001855.html
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001856.html
-   __ http://mail.python.org/pipermail/doc-sig/2001-June/001857.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001855.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001856.html
+   __ https://mail.python.org/pipermail/doc-sig/2001-June/001857.html
 
 
 .. _Zope Corporation: http://www.zope.com
-.. _ZOPE: http://www.zope.org
+.. _ZOPE: https://www.zope.dev
 .. _reStructuredText SourceForge project:
    http://structuredtext.sourceforge.net/
 .. _pythondoc: http://starship.python.net/crew/danilo/pythondoc/
-.. _StructuredTextNG:
-   http://www.zope.org/DevHome/Members/jim/StructuredTextWiki/StructuredTextNG
 .. _project history file: ../../../HISTORY.html
 .. _PEP 287: ../../peps/pep-0287.html
 .. _Docstring Processing System framework: ../../peps/pep-0256.html
 .. _comp.lang.python: news:comp.lang.python
-.. _Python-dev: http://mail.python.org/pipermail/python-dev/
+.. _Python-dev: https://mail.python.org/pipermail/python-dev/
 .. _Docstring Processing System: http://docstring.sourceforge.net/
-.. _master PEP repository: http://www.python.org/peps/
+.. _master PEP repository: https://peps.python.org/
 
 &#xc;
 ..

_service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/mathematics.txt Added

@@ -0,0 +1,1123 @@
+.. include:: ../../header2.txt
+
+============================
+LaTeX syntax for mathematics
+============================
+
+.. role:: m(math)
+.. default-role:: math
+.. |latex| replace:: L\ :sup:`A`\ T\ :sub:`E`\ X
+
+:abstract: Docutils supports mathematical content with a `"math"
+           directive`__ and `role`__. The input format is *LaTeX math
+           syntax*\ #math-syntax_ with support for literal Unicode symbols.
+
+.. sectnum::
+.. contents::
+
+__ https://docutils.sourceforge.io/docs/ref/rst/directives.html#math
+__ https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
+
+Inline formulas and displayed equations
+=======================================
+
+The **math role** can be used for inline mathematical expressions:
+``:math:`\psi(r) = \exp(-2r)``` will produce :m:`\psi(r)=\exp(-2r)`.
+Inside the backtics you can write anything you would write between dollar
+signs in a LaTeX document.  #math-syntax_
+ 
+.. tip::
+
+  If you put ``.. default-role:: math`` at the top of your
+  document, you can write ```x^2``` instead of the longer
+  version: ``:math:`x^2```.  You can also introduce an
+  abbreviation like this ``.. role:: m(math)``.  That will allow
+  you to write ``:m:`x^2``` or ```x^2`:m:``.
+
+
+The **math directive** is used for displayed equations. It corresponds to
+an ``equation*`` or ``align*`` environment in a LaTeX document. If you
+write::
+
+  .. math:: \psi(r) = e^{-2r}
+
+you will get:
+
+.. math:: \psi(r) = e^{-2r}
+
+A more complex example is the definition of the `Fourier transform`_::
+
+  .. math::
+     :name: Fourier transform
+
+     (\mathcal{F}f)(y)
+      = \frac{1}{\sqrt{2\pi}^{\ n}}
+        \int_{\mathbb{R}^n} f(x)\,
+        e^{-\mathrm{i} y \cdot x} \,\mathrm{d} x.
+
+which is rendered as:
+
+.. math::
+   :name: Fourier transform
+
+     (\mathcal{F}f)(y)
+      = \frac{1}{\sqrt{2\pi}^{\ n}}
+        \int_{\mathbb{R}^n} f(x)\,
+        e^{-\mathrm{i} y \cdot x} \,\mathrm{d} x.
+
+The ``:name:`` option puts a label on the equation that can be
+linked to by `hyperlink references`_.
+
+Displayed equations can use ``\\`` and ``&`` for line shifts and alignments::
+
+  .. math::
+
+   a &= (x + y)^2         &  b &= (x - y)^2 \\
+     &= x^2 + 2xy + y^2   &    &= x^2 - 2xy + y^2
+
+LaTeX output will wrap it in an ``align*`` environment.
+The result is:
+
+.. math::
+
+   a &= (x + y)^2         &  b &= (x - y)^2 \\
+     &= x^2 + 2xy + y^2   &    &= x^2 - 2xy + y^2
+
+
+.. #math-syntax The supported LaTeX commands include AMS extensions
+   (see, e.g., the `Short Math Guide`_). Some of the shown symbols
+   require the "amssymb" `LaTeX package`_ (or another package providing
+   the AMS symbol macros) when exported with the "latex" writer.
+
+   The support is limited to a subset of *LaTeX math* by the conversion
+   required for many output formats.  For HTML, the `math_output`_
+   configuration setting (or the corresponding ``--math-output`` command
+   line option) selects between alternative output formats with different
+   subsets of supported elements. If a writer does not support math
+   typesetting, the content is inserted verbatim.
+
+.. _hyperlink references:
+   ../ref/rst/restructuredtext.html#hyperlink-references
+.. _Short Math Guide:
+   https://mirrors.ctan.org/info/short-math-guide/short-math-guide.pdf
+.. _math_output:
+   https://docutils.sourceforge.io/docs/user/config.html#math-output
+.. _LaTeX package:
+   ../../user/latex.html#latex-document-classes-and-packages
+
+
+Mathematical symbols
+====================
+
+The following tables are adapted from the first edition of
+"The LaTeX Companion" (Goossens, Mittelbach, Samarin) and the
+AMS `Short Math Guide`_.
+
+
+Accents and embellishments
+--------------------------
+
+The "narrow" accents are intended for a single-letter base.
+
+.. class:: colwidths-auto
+
+  =========== =============  =========== =============  ============== ================
+  `\acute{x}` ``\acute{x}``  `\dot{t}`   ``\dot{t}``    `\hat{x}`      ``\hat{x}``
+  `\bar{v}`   ``\bar{v}``    `\ddot{t}`  ``\ddot{t}``   `\mathring{x}` ``\mathring{x}``
+  `\breve{x}` ``\breve{x}``  `\dddot{t}` ``\dddot{t}``  `\tilde{n}`    ``\tilde{n}``
+  `\check{x}` ``\check{x}``  `\grave{x}` ``\grave{x}``  `\vec{x}`      ``\vec{x}``
+  =========== =============  =========== =============  ============== ================
+
+When adding an accent to an i or j in math, dotless variants can be
+obtained with ``\imath`` and ``\jmath``: `\hat \imath`, `\vec{\jmath}`.
+
+For embellishments that span multiple symbols, use:
+
+.. class:: colwidths-auto
+
+  ========================== ============================  =========================== =============================
+  `\widetilde{gbi}`          ``\widetilde{gbi}``           `\widehat{gbi}`             ``\widehat{gbi}``
+  `\overline{gbi}`           ``\overline{gbi}``            `\underline{gbi}`           ``\underline{gbi}``
+  `\overbrace{gbi}`          ``\overbrace{gbi}``           `\underbrace{gbi}`          ``\underbrace{gbi}``
+  `\overleftarrow{gbi}`      ``\overleftarrow{gbi}``       `\underleftarrow{gbi}`      ``\underleftarrow{gbi}``
+  `\overrightarrow{gbi}`     ``\overrightarrow{gbi}``      `\underrightarrow{gbi}`     ``\underrightarrow{gbi}``
+  `\overleftrightarrow{gbi}` ``\overleftrightarrow{gbi}``  `\underleftrightarrow{gbi}` ``\underleftrightarrow{gbi}``
+  ========================== ============================  =========================== =============================
+
+
+Binary operators
+----------------
+.. class:: colwidths-auto
+
+  ================== ====================  ================= ===================  ================== ====================
+  `*`                ``*``                 `\circledast`     ``\circledast``      `\ominus`          ``\ominus``
+  `+`                ``+``                 `\circledcirc`    ``\circledcirc``     `\oplus`           ``\oplus``
+  `-`                ``-``                 `\circleddash`    ``\circleddash``     `\oslash`          ``\oslash``
+  `:`                ``:``                 `\cup`            ``\cup``             `\otimes`          ``\otimes``
+  `\Cap`             ``\Cap``              `\curlyvee`       ``\curlyvee``        `\pm`              ``\pm``
+  `\Cup`             ``\Cup``              `\curlywedge`     ``\curlywedge``      `\rightthreetimes` ``\rightthreetimes``
+  `\amalg`           ``\amalg``            `\dagger`         ``\dagger``          `\rtimes`          ``\rtimes``
+  `\ast`             ``\ast``              `\ddagger`        ``\ddagger``         `\setminus`        ``\setminus``
+  `\bigcirc`         ``\bigcirc``          `\diamond`        ``\diamond``         `\smallsetminus`   ``\smallsetminus``
+  `\bigtriangledown` ``\bigtriangledown``  `\div`            ``\div``             `\sqcap`           ``\sqcap``
+  `\bigtriangleup`   ``\bigtriangleup``    `\divideontimes`  ``\divideontimes``   `\sqcup`           ``\sqcup``
+  `\boxdot`          ``\boxdot``           `\dotplus`        ``\dotplus``         `\star`            ``\star``
+  `\boxminus`        ``\boxminus``         `\doublebarwedge` ``\doublebarwedge``  `\times`           ``\times``
+  `\boxplus`         ``\boxplus``          `\gtrdot`         ``\gtrdot``          `\triangleleft`    ``\triangleleft``
+  `\boxtimes`        ``\boxtimes``         `\intercal`       ``\intercal``        `\triangleright`   ``\triangleright``
+  `\bullet`          ``\bullet``           `\leftthreetimes` ``\leftthreetimes``  `\uplus`           ``\uplus``
+  `\cap`             ``\cap``              `\lessdot`        ``\lessdot``         `\vee`             ``\vee``
+  `\cdot`            ``\cdot``             `\ltimes`         ``\ltimes``          `\veebar`          ``\veebar``
+  `\centerdot`       ``\centerdot``        `\mp`             ``\mp``              `\wedge`           ``\wedge``
+  `\circ`            ``\circ``             `\odot`            ``\odot``           `\wr`              ``\wr``
+  ================== ====================  ================= ===================  ================== ====================
+
+
+Extensible delimiters
+---------------------
+Unless you indicate otherwise, delimiters in math formulas remain at the
+standard size regardless of the height of the enclosed material. To get
+adaptable sizes, use ``\left`` and ``\right`` prefixes, for example
+`g(A,B,Y) = f \left(A,B,X=h^{X}(Y)\right)` or
+
+.. math:: a_n = \left(\frac{1}{2}\right)^n
+
+Use ``.`` for "empty" delimiters:
+
+.. math:: A = \left . \frac{1}{1-n}\, \right |_{n=0}^\infty
+
+See also the commands for fixed `delimiter sizes`_ below.
+
+The following symbols extend when used with ``\left`` and ``\right``:
+
+Pairing delimiters
+~~~~~~~~~~~~~~~~~~
+.. class:: colwidths-auto
+
+  =============== =================   ========================= ===========================
+  `( )`           ``( )``             `\langle \rangle`         ``\langle \rangle``
+  ` `           `` ``             `\lceil  \rceil`          ``\lceil \rceil``
+  `\{ \}`         ``\{ \}``           `\lfloor \rfloor`         ``\lfloor \rfloor``
+  `\lvert \rvert` ``\lvert \rvert``   `\lgroup \rgroup`         ``\lgroup \rgroup``
+  `\lVert \rVert` ``\lVert \rVert``   `\lmoustache \rmoustache` ``\lmoustache \rmoustache``
+  =============== =================   ========================= ===========================
+
+
+Nonpairing delimiters
+~~~~~~~~~~~~~~~~~~~~~
+.. class:: colwidths-auto
+
+  ==== ======  ============ ==============  ============ ==============
+  `|`  ``|``   `\vert`      ``\vert``       `\arrowvert` ``\arrowvert``
+  `\|` ``\|``  `\Vert`      ``\Vert``       `\Arrowvert` ``\Arrowvert``
+  `/`  ``/``   `\backslash` ``\backslash``  `\bracevert` ``\bracevert``
+  ==== ======  ============ ==============  ============ ==============
+
+The use of ``|`` and ``\|`` for pairs of vertical bars may produce
+incorrect spacing, e.g., ``|k|=|-k|`` produces `|k| = |−k|` and
+``|\sin(x)|`` produces `|\sin(x)|`. The pairing delimiters, e.g.
+`\lvert -k\rvert` and `\lvert\sin(x)\rvert`, prevent this problem.
+
+
+Extensible vertical arrows
+--------------------------
+.. class:: colwidths-auto
+
+  ===============================  ======================================
+  `\uparrow`     ``\uparrow``      `\Uparrow`     ``\Uparrow``
+  `\downarrow`   ``\downarrow``    `\Downarrow`   ``\Downarrow``
+  `\updownarrow` ``\updownarrow``  `\Updownarrow` ``\Updownarrow``
+  ===============================  ======================================
+
+
+Functions (named operators)
+---------------------------
+.. class:: colwidths-auto
+
+  ========= ===========  ========= ===========  ============= ================
+  `\arccos` ``\arccos``  `\gcd`    ``\gcd``     `\Pr`         ``\Pr``
+  `\arcsin` ``\arcsin``  `\hom`    ``\hom``     `\projlim`    ``\projlim``
+  `\arctan` ``\arctan``  `\inf`    ``\inf``     `\sec`        ``\sec``
+  `\arg`    ``\arg``     `\injlim` ``\injlim``  `\sin`        ``\sin``
+  `\cos`    ``\cos``     `\ker`    ``\ker``     `\sinh`       ``\sinh``
+  `\cosh`   ``\cosh``    `\lg`     ``\lg``      `\sup`        ``\sup``
+  `\cot`    ``\cot``     `\lim`    ``\lim``     `\tan`        ``\tan``
+  `\coth`   ``\coth``    `\liminf` ``\liminf``  `\tanh`       ``\tanh``
+  `\csc`    ``\csc``     `\limsup` ``\limsup``  `\varlimsup`  ``\varlimsup``
+  `\deg`    ``\deg``     `\ln`     ``\ln``      `\varliminf`  ``\varliminf``
+  `\det`    ``\det``     `\log`    ``\log``     `\varprojlim` ``\varprojlim``
+  `\dim`    ``\dim``     `\max`    ``\max``     `\varinjlim`  ``\varinjlim``
+  `\exp`    ``\exp``     `\min`    ``\min``
+  ========= ===========  ========= ===========  ============= ================
+
+Named operators outside the above list can be typeset with
+``\operatorname{name}``, e.g.
+
+.. math:: \operatorname{sgn}(-3) = -1.
+
+.. TODO: \operatorname* for function name with limits.
+
+The ``\DeclareMathOperator`` command can only be used in the
+`LaTeX preamble`_.
+
+.. _LaTeX preamble: latex.html#latex-preamble
+
+
+Greek letters
+-------------
+
+Greek letters that have Latin look-alikes are rarely used in math
+formulas and not supported by LaTeX.
+
+.. class:: colwidths-auto
+
+  ========== ============  ========== ============  ========== ============  ============== ===============
+  `\Gamma`   ``\Gamma``    `\alpha`   ``\alpha``    `\mu`      ``\mu``       `\omega`       ``\omega``
+  `\Delta`   ``\Delta``    `\beta`    ``\beta``     `\nu`      ``\nu``       `\digamma`     ``\digamma``
+  `\Lambda`  ``\Lambda``   `\gamma`   ``\gamma``    `\xi`      ``\xi``       `\varepsilon`  ``\varepsilon``
+  `\Phi`     ``\Phi``      `\delta`   ``\delta``    `\pi`      ``\pi``       `\varkappa`    ``\varkappa``
+  `\Pi`      ``\Pi``       `\epsilon` ``\epsilon``  `\rho`     ``\rho``      `\varphi`      ``\varphi``
+  `\Psi`     ``\Psi``      `\zeta`    ``\zeta``     `\sigma`   ``\sigma``    `\varpi`       ``\varpi``
+  `\Sigma`   ``\Sigma``    `\eta`     ``\eta``      `\tau`     ``\tau``      `\varrho`      ``\varrho``
+  `\Theta`   ``\Theta``    `\theta`   ``\theta``    `\upsilon` ``\upsilon``  `\varsigma`    ``\varsigma``
+  `\Upsilon` ``\Upsilon``  `\iota`    ``\iota``     `\phi`     ``\phi``      `\vartheta`    ``\vartheta``
+  `\Xi`      ``\Xi``       `\kappa`   ``\kappa``    `\chi`     ``\chi``
+  `\Omega`   ``\Omega``    `\lambda`  ``\lambda``   `\psi`     ``\psi``
+  ========== ============  ========== ============  ========== ============  ============== ===============
+
+In LaTeX, the default font for capital Greek letters is upright/roman.
+*Italic* capital Greek letters can be obtained by loading a `package
+providing the "ISO" math style`__. They are used by default in MathML.
+
+Individual Greek italic capitals can also be achieved preceding the
+letter name with ``var`` like ``\varPhi``:
+`\varGamma\ \varDelta\ \varLambda\ \varPhi\ \varPi\ \varPsi\ \varSigma\
+\varTheta\ \varUpsilon\ \varXi\ \varOmega`
+
+
+__ https://mirrors.ctan.org/macros/latex/contrib/isomath/isomath.html#table-2
+
+
+Letterlike symbols
+------------------
+.. class:: colwidths-auto
+
+  ============= ===============  ========== ============  ========== ============  =========== =============
+  `\forall`     ``\forall``      `\aleph`   ``\aleph``    `\hbar`    ``\hbar``     `\ell`      ``\ell``
+  `\complement` ``\complement``  `\beth`    ``\beth``     `\hslash`  ``\hslash``   `\wp`       ``\wp``
+  `\exists`     ``\exists``      `\gimel`   ``\gimel``    `\Im`      ``\Im``       `\Re`       ``\Re``
+  `\Finv`       ``\Finv``        `\daleth`  ``\daleth``   `\imath`   ``\imath``    `\circledR` ``\circledR``
+  `\Game`       ``\Game``        `\partial` ``\partial``  `\jmath`   ``\jmath``    `\circledS` ``\circledS``
+  `\mho`        ``\mho``         `\eth`     ``\eth``      `\Bbbk`    ``\Bbbk``
+  ============= ===============  ========== ============  ========== ============  =========== =============
+
+
+Mathematical Alphabets
+----------------------
+
+Mathematical alphabets select a combination of font attributes (shape,
+weight, family) #_. They are intended for mathematical variables where
+style variations are important semantically.
+
+.. class:: colwidths-auto
+
+  ===============  ============================  ==========================
+  command          example                       result
+  ===============  ============================  ==========================
+  ``\mathbf``      ``\mathbf{r}^2=x^2+y^2+z^2``  `\mathbf{r}^2=x^2+y^2+z^2`
+  ``\mathbb``      ``\mathbb{R \subset C}``      `\mathbb{R \subset C}`
+  ``\mathcal``     ``\mathcal{F}f(x)``           `\mathcal{F}f(x)`
+  ``\mathfrak``    ``\mathfrak{a}``              `\mathfrak{a}`
+  ``\mathit``      ``\mathit{\Gamma}``           `\mathit{\Gamma}`
+  ``\mathrm``      ``s_\mathrm{out}``            `s_\mathrm{out}`
+  ``\mathsf``      ``\mathsf x``                 `\mathsf x`
+  ``\mathtt``      ``\mathtt{0.12}``             `\mathtt{0.12}`
+  ===============  ============================  ==========================
+
+.. # TeX’s *math alphabets* correspond to the `mathematical
+   alphanumeric symbols`__ block in Unicode and the "mathvariant" `style
+   attribute`__ in MathML.
+
+   __ https://en.wikipedia.org/wiki/Mathematical_Alphanumeric_Symbols
+   __ https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute
+
+Additional alphabets are defined in LaTeX packages, e.g.
+
+.. class:: colwidths-auto
+
+  ===========  =============  ======================
+  TeX command  LaTeX package  MathML "mathvariant"
+  ===========  =============  ======================
+  mathbfit     isomath_       bold-italic
+  mathsfit     isomath_       sans-serif-italic
+  mathsfbfit   isomath_       sans-serif-bold-italic
+  mathscr      mathrsfs_      script
+  ===========  =============  ======================
+.. _isomath: https://www.ctan.org/pkg/isomath
+.. _mathrsfs: https://www.ctan.org/pkg/mathrsfs
+
+This can be used to typeset vector symbols in bold italic
+in line with the International Standard ISO-80000-2.
+
+.. ``\mathbfit{r}^2=x^2+y^2+z^2`` becomes
+
+   .. math:: \mathbfit{r}^2=x^2+y^2+z^2.
+
+The package mathrsfs_ (and some drop-in replacements) define the ``\mathscr``
+macro that selects a differently shaped "script" alphabet.
+Compare `\mathscr{A, B, …, Z, a, b, …, z}`
+with `\mathcal{A, B, …, Z, a, b, …, z}`.
+
+
+In contrast to the math alphabet selectors, ``\boldsymbol`` only changes
+the *font weight*. In LaTeX, it can be used to get a bold version of any
+mathematical symbol (for other output formats, results are mixed):
+
+.. math::
+   \boldsymbol{\cos(x)\pm\alpha \approx 3\Gamma \quad \forall x\in\mathbb{R}}
+
+
+Miscellaneous symbols
+---------------------
+.. class:: colwidths-auto
+
+==================== ======================  ================ ==================  ================= ===================
+`\#`                 ``\#``                  `\clubsuit`      ``\clubsuit``       `\neg`            ``\neg``
+`\&`                 ``\&``                  `\diamondsuit`   ``\diamondsuit``    `\nexists`        ``\nexists``
+`\angle`             ``\angle``              `\emptyset`      ``\emptyset``       `\prime`          ``\prime``
+`\backprime`         ``\backprime``          `\exists`        ``\exists``         `\sharp`          ``\sharp``
+`\bigstar`           ``\bigstar``            `\flat`          ``\flat``           `\spadesuit`      ``\spadesuit``
+`\blacklozenge`      ``\blacklozenge``       `\forall`        ``\forall``         `\sphericalangle` ``\sphericalangle``
+`\blacksquare`       ``\blacksquare``        `\heartsuit`     ``\heartsuit``      `\square`         ``\square``
+`\blacktriangle`     ``\blacktriangle``      `\infty`         ``\infty``          `\surd`           ``\surd``
+`\blacktriangledown` ``\blacktriangledown``  `\lozenge`       ``\lozenge``        `\top`            ``\top``
+`\bot`               ``\bot``                `\measuredangle` ``\measuredangle``  `\triangle`       ``\triangle``
+`\diagdown`          ``\diagdown``           `\nabla`         ``\nabla``          `\triangledown`   ``\triangledown``
+`\diagup`            ``\diagup``             `\natural`       ``\natural``        `\varnothing`     ``\varnothing``
+==================== ======================  ================ ==================  ================= ===================
+
+
+Punctuation
+-----------
+.. class:: colwidths-auto
+
+=== =====  ======== ===============  ======== ==========
+`.` ``.``  `!`      ``!``            `\vdots` ``\vdots``
+`/` ``/``  `?`      ``?``            `\dotsb` ``\dotsb``
+`|` ``|``  `\colon` ``\colon`` #_  `\dotsc` ``\dotsc``
+`'` ``'``  `\cdots` ``\cdots``       `\dotsi` ``\dotsi``
+`;` ``;``  `\ddots` ``\ddots``       `\dotsm` ``\dotsm``
+`:` ``:``  `\ldots` ``\ldots``       `\dotso` ``\dotso``
+=== =====  ======== ===============  ======== ==========
+
+.. # Punctuation (not ratio):
+       Compare spacing in `a\colon b\to c` to `a:b = c`.
+
+
+Relation symbols
+----------------
+
+Arrows
+~~~~~~
+.. class:: colwidths-auto
+
+  ====================== ========================  ===================== =======================
+  `\circlearrowleft`     ``\circlearrowleft``      `\circlearrowright`   ``\circlearrowright``
+  `\curvearrowleft`      ``\curvearrowleft``       `\curvearrowright`    ``\curvearrowright``
+  `\hookleftarrow`       ``\hookleftarrow``        `\hookrightarrow`     ``\hookrightarrow``
+  `\leftarrow`           ``\leftarrow``            `\rightarrow`         ``\rightarrow``
+  `\Leftarrow`           ``\Leftarrow``            `\Rightarrow`         ``\Rightarrow``
+  `\leftarrowtail`       ``\leftarrowtail``        `\rightarrowtail`     ``\rightarrowtail``
+  `\leftharpoondown`     ``\leftharpoondown``      `\rightharpoondown`   ``\rightharpoondown``
+  `\leftharpoonup`       ``\leftharpoonup``        `\rightharpoonup`     ``\rightharpoonup``
+  `\leftleftarrows`      ``\leftleftarrows``       `\rightrightarrows`   ``\rightrightarrows``
+  `\leftrightarrow`      ``\leftrightarrow``       `\Leftrightarrow`     ``\Leftrightarrow``
+  `\leftrightarrows`     ``\leftrightarrows``      `\rightleftarrows`    ``\rightleftarrows``
+  `\leftrightharpoons`   ``\leftrightharpoons``    `\rightleftharpoons`  ``\rightleftharpoons``
+  `\leftrightsquigarrow` ``\leftrightsquigarrow``  `\rightsquigarrow`    ``\rightsquigarrow``
+  `\Lleftarrow`          ``\Lleftarrow``           `\Rrightarrow`        ``\Rrightarrow``
+  `\longleftarrow`       ``\longleftarrow``        `\longrightarrow`     ``\longrightarrow``
+  `\Longleftarrow`       ``\Longleftarrow``        `\Longrightarrow`     ``\Longrightarrow``
+  `\longleftrightarrow`  ``\longleftrightarrow``   `\Longleftrightarrow` ``\Longleftrightarrow``
+  `\looparrowleft`       ``\looparrowleft``        `\looparrowright`     ``\looparrowright``
+  `\Lsh`                 ``\Lsh``                  `\Rsh`                ``\Rsh``
+  `\mapsto`              ``\mapsto``               `\longmapsto`         ``\longmapsto``
+  `\multimap`            ``\multimap``
+  `\nleftarrow`          ``\nleftarrow``           `\nrightarrow`        ``\nrightarrow``
+  `\nLeftarrow`          ``\nLeftarrow``           `\nRightarrow`        ``\nRightarrow``
+  `\nleftrightarrow`     ``\nleftrightarrow``      `\nLeftrightarrow`    ``\nLeftrightarrow``
+  `\nwarrow`             ``\nwarrow``              `\nearrow`            ``\nearrow``
+  `\swarrow`             ``\swarrow``              `\searrow`            ``\searrow``
+  `\twoheadleftarrow`    ``\twoheadleftarrow``     `\twoheadrightarrow`  ``\twoheadrightarrow``
+  `\upharpoonleft`       ``\upharpoonleft``        `\upharpoonright`     ``\upharpoonright``
+  `\downharpoonleft`     ``\downharpoonleft``      `\downharpoonright`   ``\downharpoonright``
+  `\upuparrows`          ``\upuparrows``           `\downdownarrows`     ``\downdownarrows``
+  ====================== ========================  ===================== =======================
+
+Synonyms: `\gets` ``\gets``, `\to` ``\to``, `\restriction` ``\restriction``.
+
+Comparison
+~~~~~~~~~~
+
+.. class:: colwidths-auto
+
+================ ==================  ============= ===============  ============= ===============  =============== =================
+`<`              ``<``               `\geq`           ``\geq``      `\ll`         ``\ll``          `\prec`         ``\prec``
+`=`              ``=``               `\geqq`       ``\geqq``        `\lll`        ``\lll``         `\precapprox`   ``\precapprox``
+`>`              ``>``               `\geqslant`   ``\geqslant``    `\lnapprox`   ``\lnapprox``    `\preccurlyeq`  ``\preccurlyeq``
+`\approx`        ``\approx``         `\gg`         ``\gg``          `\lneq`       ``\lneq``        `\preceq`       ``\preceq``
+`\approxeq`      ``\approxeq``       `\ggg`        ``\ggg``         `\lneqq`      ``\lneqq``       `\precnapprox`  ``\precnapprox``
+`\asymp`         ``\asymp``          `\gnapprox`   ``\gnapprox``    `\lnsim`      ``\lnsim``       `\precneqq`     ``\precneqq``
+`\backsim`       ``\backsim``        `\gneq`       ``\gneq``        `\ncong`      ``\ncong``       `\precnsim`     ``\precnsim``
+`\backsimeq`     ``\backsimeq``      `\gneqq`      ``\gneqq``       `\neq`        ``\neq``         `\precsim`      ``\precsim``
+`\bumpeq`        ``\bumpeq``         `\gnsim`      ``\gnsim``       `\ngeq`       ``\ngeq``        `\risingdotseq` ``\risingdotseq``
+`\Bumpeq`        ``\Bumpeq``         `\gtrapprox`  ``\gtrapprox``   `\ngeqq`      ``\ngeqq``       `\sim`          ``\sim``
+`\circeq`        ``\circeq``         `\gtreqless`  ``\gtreqless``   `\ngeqslant`  ``\ngeqslant``   `\simeq`        ``\simeq``
+`\cong`          ``\cong``           `\gtreqqless` ``\gtreqqless``  `\ngtr`       ``\ngtr``        `\succ`         ``\succ``
+`\curlyeqprec`   ``\curlyeqprec``    `\gtrless`    ``\gtrless``     `\nleq`       ``\nleq``        `\succapprox`   ``\succapprox``
+`\curlyeqsucc`   ``\curlyeqsucc``    `\gtrsim`     ``\gtrsim``      `\nleqq`      ``\nleqq``       `\succcurlyeq`  ``\succcurlyeq``
+`\doteq`         ``\doteq``          `\leq`        ``\leq``         `\nleqslant`  ``\nleqslant``   `\succeq`       ``\succeq``
+`\doteqdot`      ``\doteqdot``       `\leqq`       ``\leqq``        `\nless`      ``\nless``       `\succnapprox`  ``\succnapprox``
+`\eqcirc`        ``\eqcirc``         `\leqslant`   ``\leqslant``    `\nprec`      ``\nprec``       `\succneqq`     ``\succneqq``
+`\eqsim`         ``\eqsim``          `\lessapprox` ``\lessapprox``  `\npreceq`    ``\npreceq``     `\succnsim`     ``\succnsim``
+`\eqslantgtr`    ``\eqslantgtr``     `\lesseqgtr`  ``\lesseqgtr``   `\nsim`       ``\nsim``        `\succsim`      ``\succsim``
+`\eqslantless`   ``\eqslantless``    `\lesseqqgtr` ``\lesseqqgtr``  `\nsucc`      ``\nsucc``       `\thickapprox`  ``\thickapprox``
+`\equiv`         ``\equiv``          `\lessgtr`    ``\lessgtr``     `\nsucceq`    ``\nsucceq``     `\thicksim`     ``\thicksim``
+`\fallingdotseq` ``\fallingdotseq``  `\lesssim`    ``\lesssim``                                    `\triangleq`    ``\triangleq``
+================ ==================  ============= ===============  ============= ===============  =============== =================
+
+The commands ``\lvertneqq`` and ``\gvertneqq`` are not supported by
+LateX2MathML, as there is no corresponding Unicode character.
+
+Synonyms: `\ne` ``\ne``, `\le` ``\le``, `\ge` ``\ge``,
+`\Doteq` ``\Doteq``, `\llless` ``\llless``, `\gggtr` ``\gggtr``.
+
+Symbols can be negated prepending ``\not``, e.g.
+`\not=` ``\not=``, `\not\equiv` ``\not\equiv``,
+`\not\gtrless` ``\not\gtrless``, `\not\lessgtr` ``\not\lessgtr``.
+
+Miscellaneous relations
+~~~~~~~~~~~~~~~~~~~~~~~
+.. class:: colwidths-auto
+
+  ===================== =======================  =================== =====================  =================== =====================
+  `\backepsilon`        ``\backepsilon``         `\ntrianglelefteq`  ``\ntrianglelefteq``   `\subseteq`         ``\subseteq``
+  `\because`            ``\because``             `\ntriangleright`   ``\ntriangleright``    `\subseteqq`        ``\subseteqq``
+  `\between`            ``\between``             `\ntrianglerighteq` ``\ntrianglerighteq``  `\subsetneq`        ``\subsetneq``
+  `\blacktriangleleft`  ``\blacktriangleleft``   `\nvdash`           ``\nvdash``            `\subsetneqq`       ``\subsetneqq``
+  `\blacktriangleright` ``\blacktriangleright``  `\nVdash`           ``\nVdash``            `\supset`           ``\supset``
+  `\bowtie`             ``\bowtie``              `\nvDash`           ``\nvDash``            `\Supset`           ``\Supset``
+  `\dashv`              ``\dashv``               `\nVDash`           ``\nVDash``            `\supseteq`         ``\supseteq``
+  `\frown`              ``\frown``               `\parallel`         ``\parallel``          `\supseteqq`        ``\supseteqq``
+  `\in`                 ``\in``                  `\perp`             ``\perp``              `\supsetneq`        ``\supsetneq``
+  `\mid`                ``\mid``                 `\pitchfork`        ``\pitchfork``         `\supsetneqq`       ``\supsetneqq``
+  `\models`             ``\models``              `\propto`           ``\propto``            `\therefore`        ``\therefore``
+  `\ni`                 ``\ni``                  `\shortmid`         ``\shortmid``          `\trianglelefteq`   ``\trianglelefteq``
+  `\nmid`               ``\nmid``                `\shortparallel`    ``\shortparallel``     `\trianglerighteq`  ``\trianglerighteq``
+  `\notin`              ``\notin``               `\smallfrown`       ``\smallfrown``        `\varpropto`        ``\varpropto``
+  `\nparallel`          ``\nparallel``           `\smallsmile`       ``\smallsmile``        `\vartriangle`      ``\vartriangle``
+  `\nshortmid`          ``\nshortmid``           `\smile`            ``\smile``             `\vartriangleleft`  ``\vartriangleleft``
+  `\nshortparallel`     ``\nshortparallel``      `\sqsubset`         ``\sqsubset``          `\vartriangleright` ``\vartriangleright``
+  `\nsubseteq`          ``\nsubseteq``           `\sqsubseteq`       ``\sqsubseteq``        `\vdash`            ``\vdash``
+  `\nsubseteqq`         ``\nsubseteqq``          `\sqsupset`         ``\sqsupset``          `\Vdash`            ``\Vdash``
+  `\nsupseteq`          ``\nsupseteq``           `\sqsupseteq`       ``\sqsupseteq``        `\vDash`            ``\vDash``
+  `\nsupseteqq`         ``\nsupseteqq``          `\subset`           ``\subset``            `\Vvdash`           ``\Vvdash``
+  `\ntriangleleft`      ``\ntriangleleft``       `\Subset`           ``\Subset``
+  ===================== =======================  =================== =====================  =================== =====================
+
+Synonyms: `\owns` ``\owns``.
+
+Symbols can be negated prepending ``\not``, e.g.
+`\not\in` ``\not\in``, `\not\ni` ``\not\ni``.
+
+The commands ``\varsubsetneq``, ``\varsubsetneqq``, ``\varsupsetneq``,
+and ``\varsupsetneqq`` are not supported by LateX2MathML, as there is no
+corresponding Unicode character.
+
+
+Variable-sized operators
+------------------------
+.. class:: colwidths-auto
+
+  =========================  =========================  =========================  ===========================
+  `\sum`      ``\sum``       `\prod`     ``\prod``      `\bigcap`   ``\bigcap``    `\bigodot`   ``\bigodot``
+  `\int`      ``\int``       `\coprod`   ``\coprod``    `\bigcup`   ``\bigcup``    `\bigoplus`  ``\bigoplus``
+  `\oint`     ``\oint``      `\bigwedge` ``\bigwedge``  `\biguplus` ``\biguplus``  `\bigotimes` ``\bigotimes``
+  `\smallint` ``\smallint``  `\bigvee`   ``\bigvee``    `\bigsqcup` ``\bigsqcup``
+  =========================  =========================  =========================  ===========================
+
+Larger symbols are used in displayed formulas, sum-like symbols have
+indices above/below the symbol (see also `scripts and limits`_):
+
+.. math:: \sum_{n=1}^N a_n \qquad
+          \int_0^1f(x)\,dx \qquad
+          \prod_{i=1}^{10} b_i \ldots
+
+
+Notations
+=========
+
+Top and bottom embellishments
+-----------------------------
+
+See `Accents and embellishments`_.
+
+
+Extensible arrows
+-----------------
+
+\xleftarrow and \xrightarrow produce arrows that extend automatically to
+accommodate unusually wide subscripts or superscripts. These commands
+take one optional argument (the subscript) and one mandatory argument
+(the superscript, possibly empty)::
+
+  A \xleftarrow{n+\mu-1} B \xrightarrowT{n\pm i-1} C
+
+results in
+
+.. math:: A \xleftarrow{n+\mu-1} B \xrightarrowT{n\pm i-1} C
+
+
+Affixing symbols to other symbols
+---------------------------------
+
+In addition to the standard `accents and embellishments`_, other symbols
+can be placed above or below a base symbol with the ``\overset`` and
+``\underset`` commands. The symbol is set in "scriptstyle" (smaller font
+size). For example, writing ``\overset{*}{X}`` becomes `\overset{*}{X}`
+and ``\underset{+}{M}`` becomes `\underset{+}{M}`.
+
+
+Matrices
+--------
+
+The ``matrix`` and ``cases`` environments can also contain ``\\`` and
+``&``::
+
+  .. math::
+     \left ( \begin{matrix} a & b \\ c & d \end{matrix}\right)
+
+Result:
+
+.. math::
+     \left ( \begin{matrix} a & b \\ c & d \end{matrix} \right)
+
+The environments ``pmatrix``, ``bmatrix``, ``Bmatrix``, ``vmatrix``, and
+``Vmatrix`` have (respectively) ( ),  , { }, \| \|, and `\Vert\ \Vert`
+delimiters built in, e.g.
+
+.. math:: \begin{pmatrix} a & b \\ c & d \end{pmatrix} \qquad
+          \begin{bmatrix} a & b \\ c & d \end{bmatrix} \qquad
+          \begin{Vmatrix} a & b \\ c & d \end{Vmatrix}
+
+To produce a small matrix suitable for use in text, there is a
+``smallmatrix`` environment
+`\bigl(\begin{smallmatrix} a & b \\ c & d \end{smallmatrix}\bigr)`
+that comes closer to fitting within a single text line than a normal
+matrix.
+
+
+For piecewise function definitions there is a ``cases`` environment:
+
+.. math:: \mathrm{sgn}(x) = \begin{cases}
+                                        -1 & x<0\\
+                              \phantom{-}1 & x>0
+                            \end{cases}
+
+
+Spacing commands
+----------------
+
+Horizontal spacing of elements can be controlled with the following
+commands:
+
+.. class:: colwidths-auto
+
+  ======================  ========  =====================  ===================
+  :m:`3\qquad 4`                    ``3\qquad 4``          = 2em
+  :m:`3\quad 4`                     ``3\quad 4``           = 1em
+  :m:`3~4`                ``3~4``   ``3\nobreakspace 4``
+  :m:`3\ 4`               ``3\ 4``                         escaped space
+  :m:`3\;4`               ``3\;4``  ``3\thickspace 4``
+  :m:`3\:4`               ``3\:4``  ``3\medspace 4``
+  :m:`3\,4`               ``3\,4``  ``3\thinspace 4``
+  :m:`3  4`               ``3  4``                         regular space #_
+  :m:`3\!4`               ``3\!4``  ``3\negthinspace 4``   negative space #_
+  :m:`3\negmedspace 4`              ``3\negmedspace 4``
+  :m:`3\negthickspace 4`            ``3\negthickspace 4``
+  `3\hspace{1ex}4`                  ``3\hspace{1ex}4``     custom length
+  `3\mspace{20mu}4`                 ``3\mspace{20mu}4``    custom length #_
+  ======================  ========  =====================  ===================
+
+.. # Whitespace characters are ignored in LaTeX math mode.
+.. # Negative spacing does not work with MathML (last tested in Firefox 102).
+.. # In LaTeX, the unit must be 'mu' (1 mu = 1/18em).
+
+There are also three commands that leave a space equal to the height and
+width of its argument. For example ``\phantom{XXX}`` results in space as
+wide and high as three X’s:
+
+.. math:: \frac{\phantom{XXX}+1}{XXX-1}
+
+The commands ``\hphantom`` and ``\vphantom`` insert space with the
+width or height of the argument. They are not supported with `math_output`_
+MathML.
+
+
+Modular arithmetic and modulo operation
+---------------------------------------
+
+The commands ``\bmod``, ``\pmod``, ``\mod``, and ``\pod`` deal with the
+special spacing conventions of the “mod” notation. #_
+
+.. class:: colwidths-auto
+
+  =========  ===========================  =========================
+  command    example                      result
+  =========  ===========================  =========================
+  ``\bmod``  ``\gcd(n,m \bmod n)``        `\gcd(n,m \bmod n)`
+  ``\pmod``  ``x\equiv y \pmod b``        `x\equiv y \pmod b`
+  ``\mod``   ``x\equiv y \mod c``         `x\equiv y \mod c`
+  ``\pod``   ``x\equiv y \pod d``         `x\equiv y \pod d`
+  ..         ``\operatorname{mod}(m,n)``  `\operatorname{mod}(m,n)`
+  =========  ===========================  =========================
+
+.. # Currently `not supported`__ by the "HTML" math_output_ option
+       of the HTML writer.
+
+__ https://sourceforge.net/p/docutils/feature-requests/93/
+
+
+Roots
+-----
+
+.. class:: colwidths-auto
+
+  =========  ====================  ==================
+  command    example               result
+  =========  ====================  ==================
+  ``\sqrt``  ``\sqrt{x^2-1}``      `\sqrt{x^2-1}`
+  ..         ``\sqrt3n{x^2-1}``  `\sqrt3n{x^2-1}`
+  ..         ``\sqrt\frac{1}{2}``  `\sqrt\frac{1}{2}`
+  =========  ====================  ==================
+
+
+Boxed formulas
+--------------
+
+The command ``\boxed`` puts a box around its argument:
+
+.. math:: \boxed{\eta \leq C(\delta(\eta) +\Lambda_M(0,\delta))}
+
+
+Fractions and related constructions
+===================================
+
+The ``\frac`` command takes two ar guments, numerator and denominator,
+and typesets them in normal fraction form. For example, ``U = \frac{R}{I}``
+produces `U = \frac{R}{I}`. Use ``\dfrac`` or ``\tfrac`` to
+force text style and display style respectively.
+
+.. math:: \frac{x+1}{x-1}  \quad
+          \dfrac{x+1}{x-1} \quad
+          \tfrac{x+1}{x-1}
+
+and in text: `\frac{x+1}{x-1}`, `\dfrac{x+1}{x-1}`, `\tfrac{x+1}{x-1}`.
+
+For binomial expressions such as `\binom{n}{k}`,
+there are ``\binom``, ``\dbinom`` and ``\tbinom`` commands::
+
+  2^k-\binom{k}{1}2^{k-1}+\binom{k}{2}2^{k-2}
+
+prints
+
+.. math::  2^k-\binom{k}{1}2^{k-1}+\binom{k}{2}2^{k-2}
+
+The ``\cfrac`` command for continued fractions uses displaystyle and
+padding for sub-fractions:
+
+.. math:: \frac{\pi}{4} = 1 + \cfrac{1^2}{
+                              2 + \cfrac{3^2}{
+                                  2 + \cfrac{5^2}{
+                                      2 + \cfrac{7^2}{2 + \cdots}
+                              }}}
+          \qquad \text{vs.}\qquad
+          \frac{\pi}{4} = 1 + \frac{1^2}{
+                              2 + \frac{3^2}{
+                                  2 + \frac{5^2}{
+                                      2 + \frac{7^2}{2 + \cdots}
+                              }}}
+
+The optional argument ``l`` or ``r`` for left or right placement of
+the numerator is `not supported by MathML Core`__:
+
+.. math::  \cfracl{x}{x-1} \quad
+           \cfrac{x}{x-1}    \quad
+           \cfracr{x}{x-1}
+
+__ https://github.com/w3c/mathml/issues/30
+
+
+Delimiter sizes
+===============
+
+Besides the automatic scaling of `extensible delimiters`_ with ``\left``
+and ``\right``, there are four commands to manually select delimiters of
+fixed size:
+
+.. class:: colwidths-auto
+
+  =========  ==============  ==============  ==============  ==============  ===============  ===============
+  Sizing     no              ``\left``       ``\bigl``       ``\Bigl``       ``\biggl``       ``\Biggl``
+  command                    ``\right``      ``\bigr``       ``\Bigr``       ``\biggr``       ``\Biggr``
+  ---------  --------------  --------------  --------------  --------------  ---------------  ---------------
+  Result     `\displaystyle  `\displaystyle  `\displaystyle  `\displaystyle  `\displaystyle   `\displaystyle
+             (b)             \left(b\right)  \bigl(b\bigr)   \Bigl(b\Bigr)   \biggl(b\biggr)  \Biggl(b\Biggr)
+             (\frac{c}{d})`  \left(\frac{c}  \bigl(\frac{c}  \Bigl(\frac{c}  \biggl(\frac{c}  \Biggl(\frac{c}
+                             {d}\right)`     {d}\bigr)`      {d}\Bigr)`      {d}\biggr)`      {d}\Biggr)`
+  =========  ==============  ==============  ==============  ==============  ===============  ===============
+
+There are two or three situations where the delimiter size is commonly
+adjusted using these commands:
+
+The first kind of adjustment is done for cumulative operators with
+limits, such as summation signs. With ``\left`` and ``\right`` the
+delimiters usually turn out larger than necessary, and using the ``Big``
+or ``bigg`` sizes instead gives better results:
+
+.. math::
+   \left\sum_i a_i\left\lvert\sum_j x_{ij}\right\rvert^p\right^{1/p}
+   \text{ versus }
+   \biggl\sum_i a_i\Bigl\lvert\sum_j x_{ij}\Bigr\rvert^p\biggr^{1/p}
+
+The second kind of situation is clustered pairs of delimiters, where
+\left and \right make them all the same size (because that is adequate to
+cover the encompassed material), but what you really want is to make some
+of the delimiters slightly larger to make the nesting easier to see.
+
+.. math:: \left((a_1 b_1) - (a_2 b_2)\right)
+          \left((a_2 b_1) + (a_1 b_2)\right)
+          \quad\text{versus}\quad
+          \bigl((a_1 b_1) - (a_2 b_2)\bigr)
+          \bigl((a_2 b_1) + (a_1 b_2)\bigr)
+
+The third kind of situation is a slightly oversize object in running
+text, such as `\left|\frac{b'}{d'}\right|` where the delimiters produced
+by ``\left`` and ``\right`` cause too much line spreading. #_ In that case
+``\bigl`` and ``\bigr`` can be used to produce delimiters that are larger
+than the base size but still able to fit within the normal line spacing:
+`\bigl|\frac{b'}{d'}\bigr|`.
+
+.. # With MathML, an example would be parentheses
+   around a ``smallmatrix`` environment
+   `\left(\begin{smallmatrix} a & b \\ c & d \end{smallmatrix}\right)`
+   vs. `\Bigl(\begin{smallmatrix} a & b \\ c & d \end{smallmatrix}\Bigr)`.
+
+
+Text
+====
+
+The main use of the command ``\text`` is for words or phrases in a
+display. It is similar to ``\mbox`` in its effects but, unlike ``\mbox``,
+automatically produces subscript-size text if used in a subscript,
+``k_{\text{B}}T`` becomes `k_{\text{B}}T`.
+
+Whitespace is kept inside the argument:
+
+.. Math:: f_{x_{i-1},x_i} \text{ is monotonic for }  i = 1,\,…,\,c+1
+
+
+The text may contain math commands wrapped in ``$`` signs, e.g.
+
+.. math:: (-1)^{n_i} = \begin{cases} -1 \quad \text{if $n_i$ is odd,} \\
+                                     +1 \quad \text{if $n_i$ is even.}
+                       \end{cases}
+
+.. TODO ignore {}, handle text-mode commands
+
+
+Integrals and sums
+==================
+
+The limits on integrals, sums, and similar symbols are placed either to
+the side of or above and below the base symbol, depending on convention
+and context. In inline formulas and fractions, the limits on sums, and
+similar symbols like
+
+.. math:: \lim_{n\to\infty} \sum_1^n \frac{1}{n}
+
+move to index positions: `\lim_{n\to\infty} \sum_1^n \frac{1}{n}`.
+
+
+Altering the placement of limits
+--------------------------------
+
+The commands ``\intop`` and ``\ointop`` produce integral signs with
+limits as in sums and similar: `\intop_0^1`, `\ointop_c` and
+
+.. math:: \intop_0^1 \quad \ointop_c
+             \quad \text{vs.} \quad
+          \int^1_0   \quad \oint_c
+
+The commands ``\limits`` and ``\nolimits`` override the default placement
+of the limits for any operator; ``\displaylimits`` forces standard
+positioning as for the \sum command. They should follow immediately after
+the operator to which they apply.
+
+Compare the same term with default positions, ``\limits``, and
+``\nolimits`` in inline and display mode: `\lim_{x\to0}f(x)`,
+`\lim\limits_{x\to0}f(x)`, `\lim\nolimits_{x\to0}f(x)`, vs.
+
+.. math:: \lim_{x\to0}f(x), \quad
+          \lim\limits_{x\to0}f(x) \quad
+          \lim\nolimits_{x\to0}f(x).
+
+.. TODO: \substack
+
+.. TODO: \sideset
+
+
+Changing the size of elements in a formula
+==========================================
+
+The declarations #_ ``\displaystyle``, ``\textstyle``,
+``\scriptstyle``, and ``\scriptscriptstyle``, select a symbol size and
+spacing that would be applied in (respectively) display math, inline
+math, first-order subscript, or second-order subscript, even when the
+current context would normally yield some other size.
+
+For example ``:math:`\displaystyle \sum_{n=0}^\infty
+\frac{1}{n}``` is printed as `\displaystyle \sum_{n=0}^\infty \frac{1}{n}`
+rather than `\sum_{n=0}^\infty \frac{1}{n}` and ::
+
+  \frac{\scriptstyle\sum_{n > 0} z^n}
+  {\displaystyle\prod_{1\leq k\leq n} (1-q^k)}
+
+yields
+
+.. math::
+
+  \frac{\scriptstyle\sum_{n > 0} z^n}
+  {\displaystyle\prod_{1\leq k\leq n} (1-q^k)}
+  \text{ instead of the default }
+  \frac{\sum_{n > 0} z^n}
+  {\prod_{1\leq k\leq n} (1-q^k)}.
+
+.. # "Declarations" are commands that affect processing of the current
+   "group". In particular, notice where the braces fall that delimit the
+   effect of the command: Right: ``{\displaystyle ...}`` Wrong:
+   ``\displaystyle{...}``.
+
+   With math_output_ MathML, the declaration must be the first element
+   after the opening bracket.
+
+
+Appendix
+========
+
+Tests
+-----
+
+Font changes
+~~~~~~~~~~~~
+
+Math alphabet macros change the default alphabet ("mathvariant" in
+MathML), leaving some symbols unchanged:
+
+:normal: `abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R`
+:mathrm: `\mathrm{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathit: `\mathit{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathsf: `\mathsf{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathbb: `\mathbb{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathbf: `\mathbf{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathcal: `\mathcal{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathscr: `\mathscr{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+
+Without additional packages, LaTeX supports "blackboard-bold" only for
+capital Latin letters.
+Unicode supports also small Latin letters, some Greek letters, and digits:
+`\mathbb{A \ldots Z a \ldots z} 
+\mathbb\Gamma \mathbb{\Pi} \mathbb {\Sigma} \mathbb\gamma \mathbb \pi
+\mathbb{0 \ldots 9}`.
+
+
+Inferred <mrow>s in MathML
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The elements <msqrt>, <mstyle>, <merror>, <mpadded>, <mphantom>, <menclose>,
+<mtd>, <mscarry>, and <math> treat their contents as a single inferred mrow
+formed from all their children.
+
+.. math:: a = \sqrt 2 + x,\quad
+          b = \sqrt{1+x^2},\quad
+          c = \sqrt\frac{\sin(x)}{23},
+
+inline: :math:`a = \sqrt 2 + x, b = \sqrt{1+x^2}, c = \sqrt\frac{\sin(x)}{23}`.
+
+
+Scripts and Limits
+~~~~~~~~~~~~~~~~~~
+
+Accents should be nearer to the base:
+`\bar a \overline a, \bar l \overline l, \bar i \overline i`,
+`\vec{r}` `\overrightarrow{r}`.
+
+Sub- and superscript may be given in any order:
+`x_i^j = x^j_i` and `\int_0^1 = \int^1_0`.
+
+Double exponent: `x^{10^4}`, `r_{T_\mathrm{in}}` and `x_i^{n^2}`.
+
+
+Nested groups
+~~~~~~~~~~~~~
+
+tex-token returns "{" for nested groups:
+
+.. math:: \text{das ist ein  {toller} text (unescaped \{ and \} is
+                ignored by LaTeX)}
+
+
+Big delimiters and symbols
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Compare automatic sizing with fixed sizes:
+
+.. math:  \left( \frac{\frac1x}{\frac{1}{n}}\right) &= \Biggl(\text{Bigg}\Biggr)\\
+
+
+.. math::
+  \left( 3                          \right)
+  \left( f(x)                       \right)
+  \left( \bar x                     \right)
+  \left( \overline x                \right)
+  \left( n_i                        \right) &= () \\
+  \left( \underline x               \right) &= \bigl(\text{big}\bigr)\\
+  \left( 3^2                        \right)
+  \left( \sqrt{3}                   \right)
+  \left( \sqrt{3^2}                 \right)
+  \left( \sum                       \right)
+  \left( \bigotimes                 \right)
+  \left( \prod                      \right) &= \Bigl(\text{Big}\Bigr)\\
+  \left( \frac{3  }{2}              \right)
+  \left( \frac{3^2}{2^4}            \right)
+  \binom{3  }{2}
+  \begin{pmatrix} a & b \\ c & d \end{pmatrix}
+  \left( \frac{1}{\sqrt 2}          \right)
+  \left( \int                       \right)
+  \left( \int_0                     \right)
+  \left( \int^1                     \right)
+  \left( \int_0^1                   \right) &= \biggl(\text{bigg}\biggr)\\
+  \left( \frac{\sqrt 2}{2}          \right)
+  \left( \sum_0                     \right)
+  \left( \sum^1                     \right)
+  \left( \sum_0^1                   \right)
+  \left( \frac{\frac1x}{\frac{1}{n}}\right) &= \Biggl(\text{Bigg}\Biggr)\\
+  \left( \intop_0                   \right)
+  \left( \intop^1                   \right)
+  \left( \intop_0^1                 \right)
+
+And in text:
+
+:`()`:                        `\left(3                          \right)
+                              \left( f(x)                       \right)
+                              \left( \bar x                     \right)
+                              \left( \overline x                \right)
+                              \left( n_i                        \right)
+                              \left( \sum                       \right)
+                              \left( \sum_0                     \right)
+                              \left( \prod                      \right)`
+
+
+:`\bigl(\text{big}\bigr)`:    `\left(\underline x               \right)
+                              \left( 3^2                        \right)
+                              \binom{3}{2}
+                              \left(\begin{smallmatrix} a & b \\
+                              c & d \end{smallmatrix}           \right)
+                              \left( \bigotimes                 \right)`
+
+:`\Bigl(\text{Big}\Bigr)`:    `\left(\sqrt{3}                   \right)
+                              \left( \sqrt{3^2}                 \right)
+                              \left( \frac{3}{2}                \right)
+                              \left( \frac{3^2}{2^4}            \right)
+                              \left( \frac{\sqrt 2}{2}          \right)
+                              \left( \int                       \right)
+                              \left( \int_0                     \right)
+                              \left( \int^1                     \right)
+                              \left( \int_0^1                   \right)
+                              \left( \sum^1                     \right)
+                              \left( \sum_0^1                   \right)
+                              \left( \frac{\frac1x}{\frac{1}{n}}\right)`
+
+
+
+
+
+Test ``\left``, ``\right``, and the  \bigl/\bigr, … size commands
+with all extensible delimiters.
+
+.. math::
+   \left.(b\right)\ \bigl(b\Bigr)\ \biggl(b\Biggr)
+   \quad
+   \left.b\right\ \biglb\Bigr\ \bigglb\Biggr
+   \quad
+   \left.\{b\right \} \ \bigl\{b\Bigr \} \ \biggl\{b\Biggr \}
+   \quad
+   \left.\langle b\right\rangle\ \bigl\langle b\Bigr\rangle\ \biggl\langle b\Biggr\rangle
+
+   \left.\lceil b\right\rceil\ \bigl\lceil b\Bigr\rceil\ \biggl\lceil b\Biggr\rceil
+   \quad
+   \left.\lfloor b\right\rfloor\ \bigl\lfloor b\Bigr\rfloor\ \biggl\lfloor b\Biggr\rfloor
+   \quad
+   \left.\lvert b\right\rvert\ \bigl\lvert b\Bigr\rvert\
+   \biggl\lvert b\Biggr\rvert
+   \quad
+   \left.\lVert b\right\rVert\ \bigl\lVert b\Bigr\rVert\
+   \biggl\lVert b\Biggr\rVert
+
+   \left.\lgroup b\right\rgroup\ \bigl\lgroup b\Bigr\rgroup\ \biggl\lgroup b\Biggr\rgroup
+   \quad
+   \left.\lmoustache b\right\rmoustache\ \bigl\lmoustache b\Bigr\rmoustache\ \biggl\lmoustache b\Biggr\rmoustache
+   \quad
+   \left./b\right\backslash\ \bigl/b\Bigr\backslash\ \biggl/b\Biggr\backslash
+
+   \left.|b\right\|\ \bigl|b\Bigr\|\ \biggl|b\Biggr\|
+   \quad
+   \left.\vert b\right\Vert\ \bigl\vert b\Bigr\Vert\ \biggl\vert b\Biggr\Vert
+   \quad
+   \left.\arrowvert b\right\Arrowvert\ \bigl\arrowvert b\Bigr\Arrowvert\ \biggl\arrowvert b\Biggr\Arrowvert
+   \quad
+   \left.\bracevert b\right\bracevert\ \bigl\bracevert b\Bigr\bracevert\ \biggl\bracevert b\Biggr\bracevert
+   \quad
+   \left.\vert b\right\Vert\ \bigl\vert b\Bigr\Vert\ \biggl\vert b\Biggr\Vert
+
+
+Variable-sized operators:
+
+Inline: `\int\ \iint\ \iiint\ \iiiint\ \idotsint \oint\ \smallint\
+\sum\ \prod\ \coprod\ \bigwedge\ \bigvee\ \bigcap\ \bigcup\ \biguplus\
+\bigsqcup\ \bigodot\ \bigoplus\ \bigotimes` and Display:
+
+.. math:: \int\ \iint\ \iiint\ \iiiint\ \idotsint\ \oint\ \smallint\
+   \sum\ \prod\ \coprod\ \bigwedge\ \bigvee\ \bigcap\ \bigcup\
+   \biguplus\ \bigsqcup\ \bigodot\ \bigoplus\ \bigotimes
+
+.. math:: \int_1 f\ \intop_1 f\ \iint_1 f\ \smallint_1 f\ \sum_1\
+   \prod_1\ \bigwedge_1\ \bigcap_1\ \biguplus_1\ \bigodot_1\ \int^N\
+   \intop^N\ \iiiint^N\ \oint^N\ \smallint^N\ \sum^N\ \coprod^N\
+   \bigvee^N\ \bigcup^N\ \bigsqcup^N\ \bigotimes^N
+
+.. math:: \int_1^N\ \intop_1^N\ \iint_1^N\ \iiint_1^N\ \iiiint_1^N\
+   \idotsint_1^N\ \oint_1^N\ \smallint_1^N\ \sum_1^N\ \prod_1^N\
+   \coprod_1^N\ \bigwedge_1^N\ \bigvee_1^N\ \bigcap_1^N\ \bigcup_1^N
+   \ \biguplus_1^N\ \bigsqcup_1^N\ \bigodot_1^N\ \bigoplus_1^N\
+   \bigotimes_1^N
+
+
+Text
+~~~~
+
+The text may contain non-ASCII characters: `n_\text{Stoß}`.
+
+Some text-mode LaTeX commands are supported with math_output_ "html".
+In other output formats, use literal Unicode: `\text{ç é è ë ê ñ ů ž ©}`
+to get the result of the accent macros
+`\text{\c{c} \'e \`e \"e \^e \~n \r{u} \v{z} \textcircled{c}}`.

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/rst/restructuredtext.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/restructuredtext.txt Changed

@@ -1,13 +1,15 @@
 .. -*- coding: utf-8 -*-
 
+.. include:: ../../header2.txt
+
 =======================================
  reStructuredText Markup Specification
 =======================================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8644 $
-:Date: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
+:Revision: $Revision: 9322 $
+:Date: $Date: 2023-01-17 16:40:43 +0100 (Di, 17. Jän 2023) $
 :Copyright: This document has been placed in the public domain.
 
 .. Note::
@@ -67,7 +69,7 @@
 
       Paragraphs contain text and may contain inline markup:
       *emphasis*, **strong emphasis**, `interpreted text`, ``inline
-      literals``, standalone hyperlinks (http://www.python.org),
+      literals``, standalone hyperlinks (https://www.python.org),
       external hyperlinks (Python_), internal cross-references
       (example_), footnote references (1_), citation references
       (CIT2002_), substitution references (|example|), and _`inline
@@ -187,7 +189,7 @@
 
   - `Hyperlink targets`_::
 
-        .. _Python: http://www.python.org
+        .. _Python: https://www.python.org
 
         .. _example:
 
@@ -330,47 +332,62 @@
         body on the same line as the marker.
 
 
+.. _escape:
+
 Escaping Mechanism
 ==================
 
 The character set universally available to plaintext documents, 7-bit
 ASCII, is limited.  No matter what characters are used for markup,
 they will already have multiple meanings in written text.  Therefore
-markup characters *will* sometimes appear in text **without being
-intended as markup**.  Any serious markup system requires an escaping
+markup characters will sometimes appear in text without being
+intended as markup.  Any serious markup system requires an escaping
 mechanism to override the default meaning of the characters used for
-the markup.  In reStructuredText we use the backslash, commonly used
+the markup.  In reStructuredText we use the *backslash*, commonly used
 as an escaping character in other domains.
 
-A backslash followed by any character (except whitespace characters
-in non-URI contexts)
-escapes that character.  The escaped character represents the
-character itself, and is prevented from playing a role in any markup
-interpretation.  The backslash is removed from the output.  A literal
-backslash is represented by two backslashes in a row (the first
-backslash "escapes" the second, preventing it being interpreted in an
-"escaping" role).
-
-In non-URI contexts,
-backslash-escaped whitespace characters are removed from the document.
-This allows for character-level `inline markup`_.
-
-In URIs, backslash-escaped whitespace represents a single space.
-
-There are two contexts in which backslashes have no special meaning:
-literal blocks and inline literals.  In these contexts, a single
-backslash represents a literal backslash, without having to double up.
-
-Please note that the reStructuredText specification and parser do not
-address the issue of the representation or extraction of text input
-(how and in what form the text actually *reaches* the parser).
-Backslashes and other characters may serve a character-escaping
-purpose in certain contexts and must be dealt with appropriately.  For
-example, Python uses backslashes in strings to escape certain
-characters, but not others.  The simplest solution when backslashes
-appear in Python docstrings is to use raw docstrings::
+A backslash (``\``) escapes the following character.
 
-    r"""This is a raw docstring.  Backslashes (\) are not touched."""
+* "Escaping" backslash characters are represented by NULL characters in
+  the `Document Tree`_ and removed from the output document by the
+  Docutils writers_.
+
+* Escaped non-white characters are prevented from playing a role in any
+  markup interpretation. The escaped character represents the character
+  itself. (A literal backslash can be specified by two backslashes in a
+  row -- the first backslash escapes the second. #caveat_)
+
+* Escaped whitespace characters are removed from the output document
+  together with the escaping backslash. This allows for `character-level
+  inline markup`_.
+
+  In `URI context` #uri-context_, backslash-escaped whitespace
+  represents a single space.
+
+Backslashes have no special meaning in `literal context` #literal-context_.
+Here, a single backslash represents a literal backslash, without having
+to double up. #caveat_
+
+.. #caveat Please note that the reStructuredText specification and
+   parser do not address the issue of the representation or extraction of
+   text input (how and in what form the text actually *reaches* the
+   parser). Backslashes and other characters may serve a
+   character-escaping purpose in certain contexts and must be dealt with
+   appropriately.  For example, Python uses backslashes in string
+   literals to escape certain characters. The simplest solution when
+   backslashes appear in Python docstrings is to use raw docstrings::
+
+     r"""This is a raw docstring.  Backslashes (\) are not touched."""
+
+.. #uri-context In contexts where Docutils expects a URI (the link
+   block of `external hyperlink targets`_ or the argument of an image_ or
+   figure_ directive), whitespace is ignored by default
+
+.. #literal-context In literal context (`literal blocks`_ and `inline
+   literals`_, content of the code_, math_, and raw_ directives, content
+   of the `"raw" role`_ and `custom roles`_ based on it),
+   reStructuredText markup characters lose their semantics so there is no
+   reason to escape them.
 
 .. _reference name:
 
@@ -398,7 +415,7 @@
 
     Want to learn about `my favorite programming language`_?
 
-    .. _my favorite programming language: http://www.python.org
+    .. _my favorite programming language: https://www.python.org
 
 Simple reference names may also optionally use backquotes.
 
@@ -424,10 +441,10 @@
 Hyperlinks_, footnotes_, and citations_ all share the same namespace
 for reference names.  The labels of citations (simple reference names)
 and manually-numbered footnotes (numbers) are entered into the same
-database as other hyperlink names.  This means that a footnote
-(defined as "``.. 1``") which can be referred to by a footnote
-reference (``1_``), can also be referred to by a plain hyperlink
-reference (1_).  Of course, each type of reference (hyperlink,
+database as other hyperlink names.  This means that a footnote_
+(defined as "``.. #note``") which can be referred to by a footnote
+reference (``#note_``), can also be referred to by a plain hyperlink
+reference (``note_``).  Of course, each type of reference (hyperlink,
 footnote, citation) may be processed and rendered differently.  Some
 care should be taken to avoid reference name conflicts.
 
@@ -461,9 +478,11 @@
 the sections are then lifted up a level or two.  See the `DocTitle
 transform`_ for details.
 
-.. # The `title configuration setting`__ and the `title directive`__
-   set a document title that does not become part of the document body.
+.. # The `"title" configuration setting`__ and the `"title"
+   directive`__ set the document's `title attribute`_ that does not
+   become part of the document body.
 
+   .. _title attribute: ../doctree.html#title-attribute
    __ ../../user/config.html#title
    __ directives.html#metadata-document-title
 
@@ -478,7 +497,7 @@
 matching "overlines" above the title.  An underline/overline is a
 single repeated punctuation character that begins in column 1 and
 forms a line extending at least as far as the right edge of the title
-text.  Specifically, an underline/overline character may be any
+text. #_  Specifically, an underline/overline character may be any
 non-alphanumeric printable 7-bit ASCII character #_.  When an
 overline is used, the length and character used must match the
 underline.  Underline-only adornment styles are distinct from
@@ -486,6 +505,10 @@
 be any number of levels of section titles, although some output
 formats may have limits (HTML has 6 levels).
 
+.. # The key is the visual length of the title in a mono-spaced font.
+   The adornment may need more or less characters than title, if the
+   title contains wide__ or combining__ characters.
+
 .. # The following are all valid section title adornment
    characters::
 
@@ -496,6 +519,9 @@
 
        = - ` : . ' " ~ ^ _ * + #
 
+__ https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms#In_Unicode
+__ https://en.wikipedia.org/wiki/Combining_character
+
 Rather than imposing a fixed number and order of section title
 adornment styles, the order enforced will be the order as encountered.
 The first style encountered will be an outermost title (like HTML H1),
@@ -738,11 +764,18 @@
 
     A. Einstein was a really smart dude.
 
-If a single-line paragraph begins with text identical to an enumerator
-("A.", "1.", "(b)", "I)", etc.), the first character will have to be
-escaped in order to have the line parsed as an ordinary paragraph::
-
-    \A. Einstein was a really smart dude.
+.. Caution:: 
+    If a single-line paragraph begins with text identical to an enumerator
+    ("A.", "1.", "(b)", "I)", etc.), the first character will have to be
+    escaped in order to have the line parsed as an ordinary paragraph::
+    
+        \A. Einstein was a really smart dude.
+        
+    Alternatively, you can escape the delimiter ::
+    
+        A\. Einstein was a really smart dude.
+        
+    or use a literal NO-BREAK SPACE after the initial.    
 
 Examples of nested enumerated lists::
 
@@ -769,14 +802,24 @@
 classifier_, definition_.
 
 Each definition list item contains a term, optional classifiers, and a
-definition.  A term is a simple one-line word or phrase.  Optional
-classifiers may follow the term on the same line, each after an inline
-" : " (space, colon, space).  A definition is a block indented
-relative to the term, and may contain multiple paragraphs and other
-body elements.  There may be no blank line between a term line and a
-definition block (this distinguishes definition lists from `block
-quotes`_).  Blank lines are required before the first and after the
-last definition list item, but are optional in-between.  For example::
+definition.
+
+* A `term` is a simple one-line word or phrase.  Escape_ a leading hyphen
+  to prevent recognition as an `option list`_ item.
+
+* Optional `classifiers` may follow the term on the same line, each after
+  an inline " : " (space, colon, space).  Inline markup is parsed in the
+  term line before the classifier delimiters are recognized.  A delimiter
+  will only be recognized if it appears outside of any inline markup.
+
+* A `definition` is a block indented relative to the term, and may
+  contain multiple paragraphs and other body elements.  There may be no
+  blank line between a term line and a definition block (this
+  distinguishes definition lists from `block quotes`_). Blank lines are
+  required before the first and after the last definition list item, but
+  are optional in-between.
+
+Example::
 
     term 1
         Definition 1.
@@ -792,9 +835,8 @@
     term 4 : classifier one : classifier two
         Definition 4.
 
-Inline markup is parsed in the term line before the classifier
-delimiter (" : ") is recognized.  The delimiter will only be
-recognized if it appears outside of any inline markup.
+    \-term 5
+        Without escaping, this would be an option list item.
 
 A definition list may be used in various ways, including:
 
@@ -892,12 +934,17 @@
 copyright_, date_, organization_, revision_, status_, topic_,
 version_.
 
-When a field list is the first non-comment element in a document
-(after the document title, if there is one), it may have its fields
+When a field list is the first element in a document
+(after the document title, if there is one) #_, it may have its fields
 transformed to document bibliographic data.  This bibliographic data
 corresponds to the front matter of a book, such as the title page and
 copyright page.
 
+.. # In addition to the document title and subtitle, also comments_,
+   `substitution definitions`_, `hyperlink targets`_, and "header",
+   "footer", "meta", and "raw" directives_ may be placed before the
+   bibliographic fields.
+
 Certain registered field names (listed below) are recognized and
 transformed to the corresponding doctree elements, most becoming child
 elements of the docinfo_ element.  No ordering is required of these
@@ -962,15 +1009,16 @@
 
 `Bibliographic fields`_ recognized by the parser are normally checked
 for RCS #_ keywords and cleaned up #_.  RCS keywords may be
-entered into source files as "$keyword$", and once stored under RCS or
-CVS #_, they are expanded to "$keyword: expansion text $".  For
-example, a "Status" field will be transformed to a "status" element::
+entered into source files as "$keyword$", and once stored under RCS,
+CVS #_, or SVN #_, they are expanded to "$keyword: expansion text $".
+For example, a "Status" field will be transformed to a "status" element::
 
     :Status: $keyword: expansion text $
 
 .. # Revision Control System.
 .. # RCS keyword processing can be turned off (unimplemented).
 .. # Concurrent Versions System.  CVS uses the same keywords as RCS.
+.. # Subversion Versions System. Uses the same keywords as RCS.
 
 Processed, the "status" element's text will become simply "expansion
 text".  The dollar sign delimiters and leading RCS keyword name are
@@ -980,6 +1028,7 @@
 bibliographic context (first non-comment construct in the document,
 after a document title if there is one).
 
+.. _option list:
 
 Option Lists
 ------------
@@ -987,8 +1036,8 @@
 Doctree elements: option_list_, option_list_item_, option_group_, option_,
 option_string_, option_argument_, description_.
 
-Option lists are two-column lists of command-line options and
-descriptions, documenting a program's options.  For example::
+Option lists map a program's command-line options to descriptions
+documenting them.  For example::
 
     -a         Output all.
     -b         Output both (this description is
@@ -1042,10 +1091,11 @@
 given, supported by notes about truncation if and when applicable.
 
 Options may be followed by an argument placeholder, whose role and
-syntax should be explained in the description text.  Either a space or
-an equals sign may be used as a delimiter between options and option
-argument placeholders; short options ("-" or "+" prefix only) may omit
-the delimiter.  Option arguments may take one of two forms:
+syntax should be explained in the description text.
+Either a space or an equals sign may be used as a delimiter between long
+options and option argument placeholders;
+short options ("-" or "+" prefix only) use a space or omit the delimiter.
+Option arguments may take one of two forms:
 
 - Begins with a letter (``a-zA-Z``) and subsequently consists of
   letters, numbers, underscores and hyphens (``a-zA-Z0-9_-``).
@@ -1057,8 +1107,9 @@
 description.  They must be separated by comma-space.
 
 There must be at least two spaces between the option(s) and the
-description.  The description may contain multiple body elements.  The
-first line after the option marker determines the indentation of the
+description (which can also start on the next line).  The description
+may contain multiple body elements.
+The first line after the option marker determines the indentation of the
 description.  As with other types of lists, blank lines are required
 before the first option list item and after the last, but are optional
 between option entries.
@@ -1859,7 +1910,7 @@
 
        .. _Python DOC-SIG mailing list archive:
        .. _archive:
-       .. _Doc-SIG: http://mail.python.org/pipermail/doc-sig/
+       .. _Doc-SIG: https://mail.python.org/pipermail/doc-sig/
 
    An inline form of internal hyperlink target is available; see
    `Inline Internal Targets`_.
@@ -1884,12 +1935,12 @@
 
        `Write to me`_ with your questions.
 
-       .. _Python: http://www.python.org
+       .. _Python: https://www.python.org
        .. _Write to me: jdoe@example.com
 
    After processing into HTML, the hyperlinks might be expressed as::
 
-       See the <a href="http://www.python.org">Python</a> home page
+       See the <a href="https://www.python.org">Python</a> home page
        for info.
 
        <a href="mailto:jdoe@example.com">Write to me</a> with your
@@ -1903,13 +1954,13 @@
    permitted to allow for line wrapping).  The following external
    hyperlink targets are equivalent::
 
-       .. _one-liner: http://docutils.sourceforge.net/rst.html
+       .. _one-liner: https://docutils.sourceforge.io/rst.html
 
-       .. _starts-on-this-line: http://
+       .. _starts-on-this-line: https://
           docutils.sourceforge.net/rst.html
 
        .. _entirely-below:
-          http://docutils.
+          https://docutils.
           sourceforge.net/rst.html
 
    Escaped whitespace is preserved as intentional spaces, e.g.::
@@ -2005,12 +2056,12 @@
 Anonymous targets begin with ".. __:"; no reference name is required
 or allowed::
 
-    .. __: http://www.python.org
+    .. __: https://www.python.org
 
 As a convenient alternative, anonymous targets may begin with "__"
 only::
 
-    __ http://www.python.org
+    __ https://www.python.org
 
 The reference name of the reference is not used to match the reference
 to its target.  Instead, the order of anonymous hyperlink references
@@ -2308,7 +2359,7 @@
         |RST| source readability.
 
         .. |RST| replace:: reStructuredText
-        .. _RST: http://docutils.sourceforge.net/rst.html
+        .. _RST: https://docutils.sourceforge.io/rst.html
 
     Note the trailing underscore in the first use of a substitution
     reference.  This indicates a reference to the corresponding
@@ -2508,10 +2559,10 @@
    Docutils 0.13 uses `Unicode version 5.2.0`_.
 
 .. _Unicode categories:
-   http://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
-.. _Unicode version 5.2.0: http://www.unicode.org/Public/5.2.0/
+   https://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
+.. _Unicode version 5.2.0: https://www.unicode.org/Public/5.2.0/
 .. _quotation marks in international usage:
-   http://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
+   https://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
 
 The inline markup recognition rules were devised to allow 90% of non-markup
 uses of "*", "`", "_", and "|" without escaping. For example, none of the
@@ -2720,9 +2771,10 @@
 rules above).  No markup interpretation (including backslash-escape
 interpretation) is done within inline literals.
 
-Line breaks are *not* preserved in inline literals.  Although a
-reStructuredText parser will preserve runs of spaces in its output,
-the final representation of the processed document is dependent on the
+Line breaks and sequences of whitespace characters
+are *not* protected in inline literals.
+Although a reStructuredText parser will preserve them in its output,
+the final representation of the processed document depends on the
 output formatter, thus the preservation of whitespace cannot be
 guaranteed.  If the preservation of line breaks and/or other
 whitespace is important, `literal blocks`_ should be used.
@@ -2775,7 +2827,7 @@
 Docutils 0.11) a hyperlink reference within angle brackets ("<...>")
 as follows::
 
-    See the `Python home page <http://www.python.org>`_ for info.
+    See the `Python home page <https://www.python.org>`_ for info.
 
     This `link <Python home page_>`_ is an alias to the link above.
 
@@ -2785,7 +2837,7 @@
 
     This link_ is an alias to the link above.
 
-    .. _Python home page: http://www.python.org
+    .. _Python home page: https://www.python.org
     .. _link: `Python home page`_
 
 The bracketed URI must be preceded by whitespace and be the last text
@@ -2797,16 +2849,16 @@
 anonymous, and the target cannot be referred to again.  These are
 "one-off" hyperlinks.  For example::
 
-    `RFC 2396 <http://www.rfc-editor.org/rfc/rfc2396.txt>`__ and `RFC
-    2732 <http://www.rfc-editor.org/rfc/rfc2732.txt>`__ together
+    `RFC 2396 <https://www.rfc-editor.org/rfc/rfc2396.txt>`__ and `RFC
+    2732 <https://www.rfc-editor.org/rfc/rfc2732.txt>`__ together
     define the syntax of URIs.
 
 Equivalent to::
 
     `RFC 2396`__ and `RFC 2732`__ together define the syntax of URIs.
 
-    __ http://www.rfc-editor.org/rfc/rfc2396.txt
-    __ http://www.rfc-editor.org/rfc/rfc2732.txt
+    __ https://www.rfc-editor.org/rfc/rfc2396.txt
+    __ https://www.rfc-editor.org/rfc/rfc2732.txt
 
 `Standalone hyperlinks`_ are treated as URIs, even if they end with an
 underscore like in the example of a Python function documentation::
@@ -2971,11 +3023,11 @@
 block is treated as a general external hyperlink with the URI itself
 as the link's text.  For example::
 
-    See http://www.python.org for info.
+    See https://www.python.org for info.
 
 would be marked up in HTML as::
 
-    See <a href="http://www.python.org">http://www.python.org</a> for
+    See <a href="https://www.python.org">https://www.python.org</a> for
     info.
 
 Two forms of URI are recognized:
@@ -2996,7 +3048,7 @@
      use slashes to separate hierarchical components of the path.
      Examples are web pages and FTP sites::
 
-         http://www.python.org
+         https://www.python.org
 
          ftp://ftp.python.org/pub/python
 
@@ -3068,9 +3120,9 @@
 specific documentation in the `user doc`__ for details.
 
 .. _length units in CSS2:
-   http://www.w3.org/TR/CSS2/syndata.html#length-units
+   https://www.w3.org/TR/CSS2/syndata.html#length-units
 .. _length units in CSS3:
-   http://www.w3.org/TR/css-values-3/#absolute-lengths
+   https://www.w3.org/TR/css-values-3/#absolute-lengths
 .. _How to configure the size of a pixel:
    ../../user/latex.html#size-of-a-pixel
 __ ../../user/
@@ -3094,32 +3146,41 @@
 258`_.
 
 
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _Docutils: http://docutils.sourceforge.net/
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Docutils: https://docutils.sourceforge.io/
 .. _Docutils Generic DTD: ../docutils.dtd
 .. _transforms:
-   http://docutils.sourceforge.net/docutils/transforms/
+   https://docutils.sourceforge.io/docutils/transforms/
 .. _Grouch: http://www.mems-exchange.org/software/grouch/
-.. _RFC822: http://www.rfc-editor.org/rfc/rfc822.txt
+.. _RFC822: https://www.rfc-editor.org/rfc/rfc822.txt
 .. _DocTitle transform:
 .. _DocInfo transform:
-   http://docutils.sourceforge.net/docutils/transforms/frontmatter.py
+   https://docutils.sourceforge.io/docutils/transforms/frontmatter.py
 .. _getopt.py:
-   http://www.python.org/doc/current/lib/module-getopt.html
+   https://docs.python.org/3/library/getopt.html
 .. _GNU libc getopt_long():
-   http://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html
+   https://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html
 .. _doctest module:
-   http://www.python.org/doc/current/lib/module-doctest.html
+   https://docs.python.org/3/library/doctest.html
 .. _Emacs table mode: http://table.sourceforge.net/
 .. _Official IANA Registry of URI Schemes:
    http://www.iana.org/assignments/uri-schemes
 .. _Retired Index of WWW Addressing Schemes:
-   http://www.w3.org/Addressing/schemes.html
-.. _World Wide Web Consortium: http://www.w3.org/
+   https://www.w3.org/Addressing/schemes.html
+.. _World Wide Web Consortium: https://www.w3.org/
 .. _HTML Techniques for Web Content Accessibility Guidelines:
-   http://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text
+   https://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text
+.. _RFC2396: https://www.rfc-editor.org/rfc/rfc2396.txt
+.. _RFC2732: https://www.rfc-editor.org/rfc/rfc2732.txt
+.. _Zope: http://www.zope.com/
+.. _PEP 258: ../../peps/pep-0258.html
+.. _writers: ../../peps/pep-0258.html#writers
+
 .. _reStructuredText Directives: directives.html
 .. _admonition: directives.html#admonitions
+.. _code: directives.html#code
+.. _math: directives.html#math
+.. _raw: directives.html#raw
 .. _figure: directives.html#figure
 .. _image: directives.html#image
 .. _meta: directives.html#metadata
@@ -3128,12 +3189,11 @@
 .. _table directive: directives.html#table
 .. _list table: directives.html#list-table
 .. _CSV table: directives.html#csv-table
+.. _custom roles: directives.html#role
 .. _reStructuredText Interpreted Text Roles: roles.html
-.. _RFC2396: http://www.rfc-editor.org/rfc/rfc2396.txt
-.. _RFC2732: http://www.rfc-editor.org/rfc/rfc2732.txt
-.. _Zope: http://www.zope.com/
-.. _PEP 258: ../../peps/pep-0258.html
+.. _"raw" role: roles.html#raw
 
+.. _Document Tree:
 .. _The Docutils Document Tree: ../doctree.html
 .. _"classes" attribute:  ../doctree.html#classes
 .. _topic: ../doctree.html#topic

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/rst/roles.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/rst/roles.txt Changed

@@ -1,15 +1,17 @@
+.. include:: ../../header2.txt
+
 =========================================
  reStructuredText Interpreted Text Roles
 =========================================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8588 $
-:Date: $Date: 2020-12-09 16:34:10 +0100 (Mi, 09. Dez 2020) $
+:Revision: $Revision: 9118 $
+:Date: $Date: 2022-07-29 13:56:58 +0200 (Fr, 29. Jul 2022) $
 :Copyright: This document has been placed in the public domain.
-
-This document describes the interpreted text roles implemented in the
-reference reStructuredText parser.
+:Abstract: 
+  This document describes the interpreted text roles implemented in the
+  reference reStructuredText parser.
 
 Interpreted text uses backquotes (`) around the text.  An explicit
 role marker may optionally appear before or after the text, delimited
@@ -64,51 +66,37 @@
  Standard Roles
 ----------------
 
-``:emphasis:``
-==============
 
-:Aliases: None
-:DTD Element: emphasis
+``:abbreviation:``
+==================
+
+:Aliases: ``:ab:``
+:DTD Element: abbreviation_
 :Customization:
     :Options: class_.
     :Content: None.
 
-Implements emphasis.  These are equivalent::
+An abbreviation used in the document.
+An example of an abbreviation is ‘St’ being used instead of ‘Street’.
 
-    *text*
-    :emphasis:`text`
 
+``:acronym:``
+==================
 
-``:literal:``
-==============
-
-:Aliases: None
-:DTD Element: literal
+:Aliases: ``:ac:``
+:DTD Element: acronym_
 :Customization:
     :Options: class_.
     :Content: None.
 
-Implements inline literal text.  These are equivalent::
-
-    ``text``
-    :literal:`text`
-
-Care must be taken with backslash-escapes though.  These are *not*
-equivalent::
-
-    ``text \ and \ backslashes``
-    :literal:`text \ and \ backslashes`
-
-The backslashes in the first line are preserved (and do nothing),
-whereas the backslashes in the second line escape the following
-spaces.
+An acronym.
 
 
 ``:code:``
 ==========
 
 :Aliases: None
-:DTD Element: literal
+:DTD Element: literal_
 :Customization:
     :Options: class_, language
     :Content: None.
@@ -137,15 +125,55 @@
     See `supported languages and markup formats`_ for recognized values.
 
 .. _code directive: directives.html#code
-.. _Pygments: http://pygments.org/
-.. _supported languages and markup formats: http://pygments.org/languages/
+.. _Pygments: https://pygments.org/
+.. _supported languages and markup formats: https://pygments.org/languages/
+
+
+``:emphasis:``
+==============
+
+:Aliases: None
+:DTD Element: emphasis_
+:Customization:
+    :Options: class_.
+    :Content: None.
+
+Implements emphasis.  These are equivalent::
+
+    *text*
+    :emphasis:`text`
+
+
+``:literal:``
+==============
+
+:Aliases: None
+:DTD Element: literal_
+:Customization:
+    :Options: class_.
+    :Content: None.
+
+Implements inline literal text.  These are equivalent::
+
+    ``text``
+    :literal:`text`
+
+Care must be taken with backslash-escapes though.  These are *not*
+equivalent::
+
+    ``text \ and \ backslashes``
+    :literal:`text \ and \ backslashes`
+
+The backslashes in the first line are preserved (and do nothing),
+whereas the backslashes in the second line escape the following
+spaces.
 
 
 ``:math:``
 ==========
 
 :Aliases: None
-:DTD Element: math
+:DTD Element: math_
 :Customization:
     :Options: class_
     :Content: None.
@@ -170,7 +198,7 @@
 ===================
 
 :Aliases: ``:PEP:``
-:DTD Element: reference
+:DTD Element: reference_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -185,14 +213,14 @@
 
     See `PEP 287`__ for more information about reStructuredText.
 
-    __ http://www.python.org/peps/pep-0287.html
+    __ https://peps.python.org/pep-0287
 
 
 ``:rfc-reference:``
 ===================
 
 :Aliases: ``:RFC:``
-:DTD Element: reference
+:DTD Element: reference_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -207,12 +235,12 @@
 
     See `RFC 2822`__ for information about email headers.
 
-    __ http://tools.ietf.org/html/rfc2822.html
+    __ https://tools.ietf.org/html/rfc2822.html
 
 .. # You can link to a specific section by saying
    ``:rfc:`number#anchor```. (New in Docutils 0.15.)
 
-   .. Warning:: The anchor (anything follwing a ``#``) is appended to
+   .. Warning:: The anchor (anything following a ``#``) is appended to
       the reference without any checks and not shown in the link text.
 
       It is recommended to use `hyperlink references`_ for
@@ -225,7 +253,7 @@
 ============
 
 :Aliases: None
-:DTD Element: strong
+:DTD Element: strong_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -240,7 +268,7 @@
 ===============
 
 :Aliases: ``:sub:``
-:DTD Element: subscript
+:DTD Element: subscript_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -276,7 +304,7 @@
 =================
 
 :Aliases: ``:sup:``
-:DTD Element: superscript
+:DTD Element: superscript_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -288,7 +316,7 @@
 =====================
 
 :Aliases: ``:title:``, ``:t:``.
-:DTD Element: title_reference
+:DTD Element: title_reference_
 :Customization:
     :Options: class_.
     :Content: None.
@@ -337,7 +365,7 @@
 =======
 
 :Aliases: None
-:DTD Element: raw
+:DTD Element: raw_
 :Customization:
     :Options: class_, format
     :Content: None
@@ -389,3 +417,17 @@
 
 ``format`` : text
     One or more space-separated output format names (Writer names).
+
+
+.. References
+
+.. _abbreviation: ../doctree.html#abbreviation
+.. _acronym: ../doctree.html#acronym
+.. _emphasis: ../doctree.html#emphasis
+.. _literal: ../doctree.html#literal
+.. _math: ../doctree.html#math
+.. _reference: ../doctree.html#reference
+.. _strong: ../doctree.html#strong
+.. _subscript: ../doctree.html#subscript
+.. _superscript: ../doctree.html#superscript
+.. _title_reference: ../doctree.html#title-reference

_service:tar_scm:docutils-0.17.1.tar.gz/docs/ref/soextblx.dtd -> _service:tar_scm:docutils-0.20.tar.gz/docs/ref/soextblx.dtd Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/config.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/config.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ========================
  Docutils Configuration
 ========================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8691 $
-:Date: $Date: 2021-04-13 16:49:37 +0200 (Di, 13. Apr 2021) $
+:Revision: $Revision: 9369 $
+:Date: $Date: 2023-05-03 01:04:27 +0200 (Mi, 03. Mai 2023) $
 :Copyright: This document has been placed in the public domain.
 
 .. sidebar:: Docutils Security for Web Applications
@@ -20,10 +22,12 @@
 Configuration Files
 -------------------
 
-Configuration files are used for persistent customization; they can be
-set once and take effect every time you use a front-end tool.
+Configuration files are used for persistent customization;
+they can be set once and take effect every time you use a component,
+e.g., via a `front-end tool`_.
 Configuration file settings override the built-in defaults, and
 command-line options override all.
+For the technicalities, see `Docutils Runtime Settings`_.
 
 By default, Docutils checks the following places for configuration
 files, in the following order:
@@ -83,7 +87,7 @@
 
 Configuration file entry names correspond to internal runtime
 settings.  Underscores ("_") and hyphens ("-") can be used
-interchangably in entry names; hyphens are automatically converted to
+interchangeably in entry names; hyphens are automatically converted to
 underscores.
 
 For on/off switch settings (_`booleans`), the following values are
@@ -96,8 +100,9 @@
 
 List values can be comma- or colon-delimited.
 
-strip_classes_, strip_elements_with_classes_, stylesheet, and
-stylesheet_path use the comma as delimiter,
+strip_classes_, strip_elements_with_classes_, smartquotes_locales_,
+stylesheet, stylesheet_dirs, stylesheet_path, legacy_class_functions_,
+and use_bibtex_ use the comma as delimiter,
 whitespace around list values is stripped. ::
 
     strip-classes: ham,eggs,
@@ -141,15 +146,18 @@
 following section.
 
 
+.. _configuration section:
+.. _configuration sections:
+
 -------------------------------------
 Configuration File Sections & Entries
 -------------------------------------
 
 Below are the Docutils runtime settings, listed by config file
-section.  Any setting may be specified in any section, but only
-settings from active sections will be used.  Sections correspond to
+section.  **Any setting may be specified in any section, but only
+settings from active sections will be used.**  Sections correspond to
 Docutils components (module name or alias; section names are always in
-lowercase letters).  Each `Docutils application`_ uses a specific set
+lowercase letters).  Each Docutils application_ uses a specific set
 of components; corresponding configuration file sections are applied
 when the application is used.  Configuration sections are applied in
 general-to-specific order, as follows:
@@ -157,8 +165,7 @@
 1. `general`_
 
 2. `parsers`_, parser dependencies, and the section specific to the
-   Parser used ("... parser").  Currently, only `restructuredtext
-   parser`_ is applicable.
+   Parser used ("... parser").
 
 3. `readers`_, reader dependencies, and the section specific to the
    Reader used ("... reader").  For example, `pep reader`_ depends
@@ -167,7 +174,7 @@
 4. `writers`_, writer family ("... writers"; if applicable),
    writer dependencies, and the section specific to the writer used
    ("... writer").  For example, `pep_html writer`_ depends
-   on `html4css1 writer`_.
+   on `html writers`_ and `html4css1 writer`_.
 
 5. `applications`_, application dependencies, and the section
    specific to the Application (front-end tool) in use
@@ -189,10 +196,11 @@
 Some knowledge of Python_ is assumed for some attributes.
 
 .. _ConfigParser.py:
-   http://www.python.org/doc/current/lib/module-ConfigParser.html
-.. _Python: http://www.python.org/
-.. _RFC 822: http://www.rfc-editor.org/rfc/rfc822.txt
-.. _Docutils application: tools.html
+   https://docs.python.org/3/library/configparser.html
+.. _Python: https://www.python.org/
+.. _RFC 822: https://www.rfc-editor.org/rfc/rfc822.txt
+.. _front-end tool:
+.. _application: tools.html
 
 
 general
@@ -210,19 +218,17 @@
 
 A trailing "%" is replaced with the tag name (new in Docutils 0.16).
 
-Default: "id" (`will change to "%" in future`__).
-Options: ``--auto-id-prefix`` (hidden, intended mainly for programmatic use).
+Default: "%" (changed in 0.18 from "id").
+Option: ``--auto-id-prefix`` (hidden, intended mainly for programmatic use).
 
 .. _identifier normalization:
    ../ref/rst/directives.html#identifier-normalization
-__ ../../RELEASE-NOTES.html#future-changes
 
 datestamp
 ---------
 
 Include a time/datestamp in the document footer.  Contains a
-format string for Python's ``time.strftime``.  See the `time
-module documentation`__.
+format string for Python's `time.strftime()`__.
 
 Default: None.
 Options: ``--date, -d, --time, -t, --no-datestamp``.
@@ -240,7 +246,7 @@
     # Disables datestamp; equivalent to --no-datestamp:
     datestamp:
 
-__ http://www.python.org/doc/current/lib/module-time.html
+__ https://docs.python.org/3/library/time.html#time.strftime
 
 debug
 -----
@@ -256,7 +262,7 @@
 document (``document.__dict__``) to stderr.
 
 Default: don't (None).
-Options: ``--dump-internals`` (hidden, for development use only).
+Option: ``--dump-internals`` (hidden, for development use only).
 
 dump_pseudo_xml
 ---------------
@@ -265,7 +271,7 @@
 the document to stderr.
 
 Default: don't (None).
-Options: ``--dump-pseudo-xml`` (hidden, for development use only).
+Option: ``--dump-pseudo-xml`` (hidden, for development use only).
 
 dump_settings
 -------------
@@ -273,7 +279,7 @@
 At the end of processing, write all Docutils settings to stderr.
 
 Default: don't (None).
-Options: ``--dump-settings`` (hidden, for development use only).
+Option: ``--dump-settings`` (hidden, for development use only).
 
 dump_transforms
 ---------------
@@ -282,7 +288,7 @@
 to the document to stderr.
 
 Default: don't (None).
-Options: ``--dump-transforms`` (hidden, for development use only).
+Option: ``--dump-transforms`` (hidden, for development use only).
 
 error_encoding
 --------------
@@ -294,8 +300,9 @@
 error_encoding_error_handler
 ----------------------------
 
-The error handler for unencodable characters in error output.  See
-output_encoding_error_handler_ for acceptable values.
+The error handler for unencodable characters in error output.
+Acceptable values are the `Error Handlers`_ of Python's "codecs" module.
+See also output_encoding_error_handler_.
 
 Default: "backslashreplace"
 Options: ``--error-encoding-error-handler, --error-encoding, -e``.
@@ -308,18 +315,18 @@
 exit.  Exit status is the maximum system message level plus 10 (11
 for INFO, etc.).
 
-Default: disabled (5).  Options: ``--exit-status``.
+Default: disabled (5).  Option: ``--exit-status``.
 
 expose_internals
 ----------------
 
-List_ of internal attribues to expose as external attributes (with
+List_ of internal attributes to expose as external attributes (with
 "internal:" namespace prefix).  To specify multiple attributes in
 configuration files, use colons to separate names; on the command
 line, the option may be used more than once.
 
 Default: don't (None).
-Options: ``--expose-internal-attribute`` (hidden, for development use only).
+Option: ``--expose-internal-attribute`` (hidden, for development use only).
 
 footnote_backlinks
 ------------------
@@ -344,6 +351,8 @@
 exceptions, halting execution immediately.  If `traceback`_ is set, the
 exception will propagate; otherwise, Docutils will exit.
 
+See also report_level_.
+
 Default: severe (4).  Options: ``--halt, --strict``.
 
 id_prefix
@@ -355,20 +364,25 @@
 See also auto_id_prefix_.
 
 Default: "" (empty).
-Options: ``--id-prefix`` (hidden, intended mainly for programmatic use).
+Option: ``--id-prefix`` (hidden, intended mainly for programmatic use).
 
 input_encoding
 --------------
 
-The text encoding for input.
+The text encoding for input (use the empty string to restore the default).
 
-Default: auto-detect (None).  Options: ``--input-encoding, -i``.
+Default: auto-detect_ (None). #_  Options: ``--input-encoding, -i``.
+
+.. # The default will change to "utf-8" in Docutils 0.22.
+
+.. _auto-detect: ../api/publisher.html#encodings
 
 input_encoding_error_handler
 ----------------------------
 
-The error handler for undecodable characters in the input. Acceptable
-values include:
+The error handler for undecodable characters in the input.
+Acceptable values are the `Error Handlers`_ of Python's "codecs" module,
+including:
 
 strict
     Raise an exception in case of an encoding error.
@@ -378,10 +392,6 @@
 ignore
     Ignore malformed data and continue without further notice.
 
-Acceptable values are the same as for the "error" parameter of
-Python's ``unicode`` function; other values may be defined in
-applications or in future versions of Python.
-
 Default: "strict".
 Options: ``--input-encoding-error-handler, --input-encoding, -i``.
 
@@ -410,18 +420,40 @@
 
 .. _class attribute: ../ref/doctree.html#classes
 
+
+output
+------
+
+The name of the output destination. Use ``-`` for stdout.
+
+Obsoletes the ``<destination>`` positional argument
+(cf. `Future changes`_ in the RELEASE-NOTES).
+
+Default: None (stdout). Option: ``--output``.
+
+New in Docutils 0.20.
+
+.. _Future changes: ../../RELEASE-NOTES.html#future-changes
+
 output_encoding
 ---------------
 
 The text encoding for output.
 
-Default: "UTF-8".  Options: ``--output-encoding, -o``.
+The "output_encoding" setting may also affect the content of the output
+(e.g. an encoding declaration in HTML or XML or the representation of
+characters as LaTeX macro vs. literal character).
+
+This setting is ignored by the `ODF/ODT Writer`_
+
+Default: "utf-8".  Options: ``--output-encoding``.
 
 output_encoding_error_handler
 -----------------------------
 
-The error handler for unencodable characters in the output. Acceptable
-values include:
+The error handler for unencodable characters in the output.
+Acceptable values are the `Error Handlers`_ of Python's "codecs" module,
+including:
 
 strict
     Raise an exception in case of an encoding error.
@@ -434,11 +466,7 @@
     Replace with the appropriate XML character reference, such as
     "``&#8224;``".
 backslashreplace
-    Replace with backslashed escape sequences, such as "``\u2020``".
-
-Acceptable values are the same as for the "error" parameter of
-Python's ``encode`` string method; other values may be defined in
-applications or in future versions of Python.
+    Replace with backslash escape sequences, such as "``\u2020``".
 
 Default: "strict".
 Options: ``--output-encoding-error-handler, --output-encoding, -o``.
@@ -448,8 +476,8 @@
 
 Path to a file where Docutils will write a list of files that were
 required to generate the output, e.g. included files or embedded
-stylesheets #dependencies_. #pwd_ The format is one path per
-line with forward slashes as separator, the encoding is ``utf8``.
+stylesheets. #dependencies_ #pwd_ The format is one path per
+line with forward slashes as separator, the encoding is UTF-8.
 
 Set to ``-`` in order to write dependencies to stdout.
 
@@ -459,10 +487,10 @@
   ham.html: ham.txt $(shell cat hamdeps.txt)
     rst2html.py --record-dependencies=hamdeps.txt ham.txt ham.html
 
-If the filesystem encoding differs from utf8, replace the ``cat``
+If the filesystem encoding differs from UTF-8, replace the ``cat``
 command with a call to a converter, e.g.::
 
-  $(shell iconv -f utf8 -t latin1 hamdeps.txt)
+  $(shell iconv -f utf-8 -t latin1 hamdeps.txt)
 
 Default: None.  Option: ``--record-dependencies``.
 
@@ -481,6 +509,8 @@
 4  severe
 5  none
 
+See also halt_level_.
+
 Default: warning (2).
 Options: ``--report, -r, --verbose, -v, --quiet, -q``.
 
@@ -559,14 +589,19 @@
 title
 -----
 
-The `document title`_ as metadata, which does not become part of the
-document body.  It overrides a document-supplied title.  For
-example, in HTML output the metadata document title appears in the
-title bar of the browser window.
+The `document title` as metadata which does not become part of the
+document body. Stored as the document's `title attribute`_.
+For example, in HTML output the metadata document title
+appears in the title bar of the browser window.
+
+This setting overrides a displayed `document title`_ and
+is overridden by a `"title" directive`_.
 
 Default: none.  Option: ``--title``.
 
+.. _title attribute: ../ref/doctree.html#title-attribute
 .. _document title: ../ref/rst/restructuredtext.html#document-title
+.. _"title" directive: ../ref/rst/directives.html#metadata-document-title
 
 toc_backlinks
 -------------
@@ -596,7 +631,7 @@
 
 Path to a file for the output of system messages (warnings). #pwd_
 
-Default: stderr (None).  Options: ``--warnings``.
+Default: stderr (None).  Option: ``--warnings``.
 
 
 parsers
@@ -607,8 +642,9 @@
 file_insertion_enabled
 ----------------------
 
-Enable or disable directives or directive that insert the contents of
-external files, such as "include_" or "raw_" with option "url".
+Enable or disable directives inserting the contents of
+external files, such as "include_" directive
+or the "raw_" and "csv-table_" directives with option "url" or "file".
 A "warning" system message (including the directive text) is inserted
 instead.  (See also raw_enabled_ for another security-relevant setting.)
 
@@ -617,6 +653,7 @@
 
 .. _include: ../ref/rst/directives.html#include
 .. _raw: ../ref/rst/directives.html#raw
+.. _csv-table: ../ref/rst/directives.html#csv-table
 
 line_length_limit
 -----------------
@@ -653,12 +690,12 @@
 requiring whitespace or punctuation around inline markup.
 
 Allows character level inline markup without escaped whithespace and is
-especially suited for langauges that do not use whitespace to separate words
+especially suited for languages that do not use whitespace to separate words
 (e.g. Japanese, Chinese).
 
 .. WARNING:: Potentially dangerous; use with caution.
 
-   When changing this setting to "True", inline markup charactes in
+   When changing this setting to "True", inline markup characters in
    URLs, names and formulas must be escaped to prevent recognition and
    possible errors. Examples::
 
@@ -678,13 +715,13 @@
 Recognize and link to standalone PEP references (like "PEP 258").
 
 Default: disabled (None); enabled (True) in PEP Reader.
-Options: ``--pep-references``.
+Option: ``--pep-references``.
 
 pep_base_url
 ~~~~~~~~~~~~
 Base URL for PEP references.
 
-Default: "http://www.python.org/peps/".
+Default: "https://peps.python.org/".
 Option: ``--pep-base-url``.
 
 pep_file_url_template
@@ -701,7 +738,7 @@
 Recognize and link to standalone RFC references (like "RFC 822").
 
 Default: disabled (None); enabled (True) in PEP Reader.
-Options: ``--rfc-references``.
+Option: ``--rfc-references``.
 
 rfc_base_url
 ~~~~~~~~~~~~
@@ -713,7 +750,7 @@
 smart_quotes
 ~~~~~~~~~~~~
 
-Activate the experimental SmartQuotes_ transform to
+Activate the SmartQuotes_ transform to
 change straight quotation marks to typographic form. `Quote characters`_
 are selected according to the language of the current block element (see
 language_code_, smartquotes_locales_, and the `pre-defined quote sets`__).
@@ -737,7 +774,7 @@
 .. _SmartQuotes: smartquotes.html
 __ smartquotes.html#localization
 .. _quote characters:
-   http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
+   https://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
 
 
 smartquotes_locales
@@ -783,17 +820,19 @@
 
 New in Docutils 0.9.
 
-.. _Pygments: http://pygments.org/
+.. _Pygments: https://pygments.org/
 .. _code: ../ref/rst/directives.html#code
 .. _Pygments-generated stylesheets:
-   http://pygments.org/docs/cmdline/#generating-styles
+   https://pygments.org/docs/cmdline/#generating-styles
 
 tab_width
 ~~~~~~~~~
 
-Number of spaces for hard tab expansion.
+Number of spaces for `hard tab expansion`_.
 
-Default: 8.  Options: ``--tab-width``.
+Default: 8.  Option: ``--tab-width``.
+
+.. _hard tab expansion: ../ref/rst/restructuredtext.html#whitespace
 
 trim_footnote_reference_space
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -808,12 +847,44 @@
    The footnote space is trimmed if the reference style is "superscript",
    and it is left if the reference style is "brackets".
 
-markdown parser
------------------
 
-Experimental, based on recommonmark_.
+.. _myst:
+
+myst parser
+-------------
+
+Provided by the 3rd party package `myst-docutils`_.
+See `MyST with Docutils`_ and its `Sphinx configuration options`_
+(some settings are not available with Docutils).
+
+.. _myst-docutils: https://pypi.org/project/myst-docutils/
+.. _MyST with Docutils:
+   https://myst-parser.readthedocs.io/en/latest/docutils.html
+.. _Sphinx configuration options:
+   https://myst-parser.readthedocs.io/en/latest/sphinx/reference.html#sphinx-config-options
+
+
+.. _pycmark:
+
+pycmark parser
+----------------
+
+Provided by the 3rd party package `pycmark`__.
+Currently no configuration settings.
+
+__ https://pypi.org/project/pycmark/
+
+
+.. _recommonmark:
+
+recommonmark parser
+---------------------
+
+Provisional, depends on (deprecated) 3rd-party package recommonmark__.
+Currently no configuration settings.
+
+__ https://pypi.org/project/recommonmark/
 
-.. _recommonmark: https://pypi.org/project/recommonmark/
 
 readers
 =========
@@ -845,8 +916,8 @@
 Enable or disable the promotion of the title of a lone subsection
 to a subtitle (docutils.transforms.frontmatter.SectSubTitle).
 
-Default: disabled (False).  Options: ``--section-subtitles,
---no-section-subtitles``.
+Default: disabled (False).
+Options: ``--section-subtitles, --no-section-subtitles``.
 
 
 pep reader
@@ -870,10 +941,6 @@
 
 .. Caution::
 
-   * In Python versions older than 2.7.3 and 3.2.3, the newlines_ and
-     indents_ options may adversely affect whitespace; use them only for
-     reading convenience (see http://bugs.python.org/issue4147).
-
    * The XML declaration carries text encoding information. If the encoding
      is not UTF-8 or ASCII and the XML declaration is missing, standard
      tools may be unable to read the generated XML.
@@ -908,7 +975,7 @@
 Generate XML with an XML declaration.
 See also `xml_declaration html writers`_.
 
-Default: do (True).  Options: ``--no-xml-declaration``.
+Default: do (True).  Option: ``--no-xml-declaration``.
 
 
 html writers
@@ -923,7 +990,7 @@
 prefix), "parentheses"/"parens", or "none".
 See also `attribution latex writers`_.
 
-Default: "dash".  Options: ``--attribution``.
+Default: "dash".  Option: ``--attribution``.
 
 
 cloak_email_addresses
@@ -950,9 +1017,9 @@
 compact_lists
 ~~~~~~~~~~~~~
 
-Remove extra vertical whitespace between items of bullet lists and
-enumerated lists, when list items are all "simple" (i.e., items
-each contain one paragraph and/or one "simple" sublist only).  The
+Remove extra vertical whitespace between items of `bullet lists`_ and
+`enumerated lists`_, when list items are all "simple" (i.e., items
+each contain one paragraph and/or one "simple" sub-list only).  The
 behaviour can be specified directly via "class" attributes (values
 "compact" and "open") in the document.
 
@@ -981,8 +1048,8 @@
 accessible during processing.
 See also `embed_stylesheet latex writers`_.
 
-Default: enabled.  Options: ``--embed-stylesheet,
---link-stylesheet``.
+Default: enabled.
+Options: ``--embed-stylesheet, --link-stylesheet``.
 
 
 .. _footnote_references setting:
@@ -1022,10 +1089,44 @@
   `stylesheet directory <stylesheet_dirs html writers_>`__)
 
   A `stylesheet_path <stylesheet_path html writers_>`__
-  can be appended after whitespace, the specified
-  stylesheet(s) will only be referenced or embedded, if required
+  can be appended after whitespace. The specified
+  stylesheet(s) will only be referenced or embedded if required
   (i.e. if there is mathematical content in the document).
 
+:MathML:
+  Embed math content as presentational MathML_.
+
+  Self-contained documents (no JavaScript, no external downloads).
+  MathML is part of the HTML5 standard #mathml-in-html4_ and
+  `supported by all major browsers`__ (since January 2023 also by Chrome).
+
+  .. #mathml-in-html4 
+    With the "html4css1" writer, the resulting HTML document does
+    not validate, as there is no DTD for `MathML + XHTML Transitional`.
+    However, MathML-enabled browsers will render it fine.
+
+  Docutil's latex2mathml converter supports a considerable
+  `subset of LaTeX math syntax`__.
+
+  An external converter can be appended after whitespace, e.g.,
+  ``--math-output="MathML blahtexml"``:
+
+  blahtexml_
+    Fast conversion, support for many symbols and environments, but no
+    "align" (or other equation-aligning) environment. (C++)
+
+  LaTeXML_
+    Comprehensive macro support but *very* slow. (Perl)
+
+  TtM_
+    No "matrix", "align" and  "cases" environments. Support may be removed.
+
+  Pandoc_
+    Comprehensive macro support, fast, but a large install size. (Haskell)
+
+  __ https://developer.mozilla.org/en-US/docs/Web/MathML#browser_compatibility
+  __ ../ref/rst/mathematics.html
+
 :MathJax:
   Format math for display with MathJax_, a JavaScript-based math rendering
   engine.
@@ -1035,7 +1136,7 @@
 
     Large set of `supported LaTeX math commands and constructs`__
 
-    __ http://docs.mathjax.org/en/latest/tex.html#supported-latex-commands
+    __ http://docs.mathjax.org/en/latest/input/tex/macros/index.html
 
   Con:
     Rendering requires JavaScript and an Internet connection or local
@@ -1058,7 +1159,7 @@
     installation. In that case, there is no need to install MathJax locally.
 
     Downside: Downloads JavaScript code from a third-party site --- opens
-    the door to cross-site scripting attacs!
+    the door to cross-site scripting attacks!
 
     Example: MathJax `getting started`__ documentation uses::
 
@@ -1075,51 +1176,25 @@
 
     This is the fallback if no URL is specified.
 
-:MathML:
-  Embed math content as presentational MathML_.
-
-  Pro:
-    The W3C recommendation for math on the web.
-
-    Self-contained documents (no JavaScript, no external downloads).
-
-  Con:
-    Docutil's latex2mathml converter supports only a small
-    subset of LaTeX syntax.
-
-    With the "html4css1" writer, the resulting HTML document does
-    not validate, as there is no DTD for `MathML + XHTML Transitional`.
-    However, MathML-enabled browsers will render it fine.
-
-  An external converter can be appended after whitespace, e.g.,
-  ``--math-output="MathML latexml"``:
-
-  blahtexml_
-    Fast conversion, support for many symbols and environments, but no
-    "align" (or other equation-aligning) environment. (C++)
-
-  LaTeXML_
-    Comprehensive macro support but very slow. (Perl)
-
-  TtM_
-    No "matrix", "align" and  "cases" environments. Support may be removed.
-
 :LaTeX:
   Include literal LaTeX code.
 
-  The failsave fallback.
+  The failsafe fallback.
 
 Default: HTML math.css.  Option: ``--math-output``.
 
-New in Docutils 0.8.
+| New in Docutils 0.8. 
+| The default for the HTML5 writer will change to
+  "MathML" in Docutils 0.22.
 
 .. _math directive: ../ref/rst/directives.html#math
 .. _MathJax: http://www.mathjax.org/
 .. _MathPlayer: http://www.dessci.com/en/products/mathplayer/
-.. _MathML: http://www.w3.org/TR/MathML/
+.. _MathML: https://www.w3.org/TR/MathML/
 .. _blahtexml: http://gva.noekeon.org/blahtexml/
 .. _LaTeXML: http://dlmf.nist.gov/LaTeXML/
 .. _TtM: http://hutchinson.belmont.ma.us/tth/mml/
+.. _Pandoc: https://pandoc.org/
 
 
 .. _stylesheet html writers:
@@ -1132,7 +1207,7 @@
 
 Overrides also stylesheet_path_. #override_
 
-Default: None.  Options: ``--stylesheet``.
+Default: None.  Option: ``--stylesheet``.
 
 
 .. _stylesheet_dirs html writers:
@@ -1151,7 +1226,7 @@
 Default: the working directory of the process at launch and the directory
 with default stylesheet files (writer and installation specific).
 Use the ``--help`` option to get the exact value.
-Option: ``--stylesheet-directories``.
+Option: ``--stylesheet-dirs``.
 
 
 .. _stylesheet_path:
@@ -1172,7 +1247,7 @@
 
 Default: writer dependent (see `html4css1 writer`_, `html5 writer`_,
 `pep_html writer`_).
-Options: ``--stylesheet-path``.
+Option: ``--stylesheet-path``.
 
 __ `embed_stylesheet html writers`_
 __ `stylesheet_dirs html writers`_
@@ -1186,25 +1261,33 @@
 Class value(s) added to all tables_.
 See also `table_style latex writers`_.
 
-The default CSS sylesheet defines:
+The default CSS sylesheets define:
 
   borderless
-    No borders around the table.
+    No borders around table cells.
+
+  align-left, align-center, align-right
+    Align table as indicated.
+
+The HTML5 stylesheets also define:
 
   booktabs
-    Lines above and below the table and a thin line after the head.
+    Only lines above and below the table and a thin line after the head.
 
-  align-left, align-center, align-right
-    Align the tables
+  captionbelow
+    Place the table caption below the table
+    (New in Docutils 0.17).
+
+In addition, the HTML writers support:
 
   colwidths-auto
-    Delegate the determination of table column widths to the backend
+    Delegate the determination of table column widths to the back-end
     (leave out the ``<colgroup>`` column specification).
-    See also the "widths" option of the `table directive`_.
+    Overridden by the "widths" option of the `table directive`_.
 
-  captionbelow
-    Place the table caption below the table
-    (only with the `HTML5 writer`_, new in 0.17).
+  colwidths-grid
+    Write column widths determined from the source to the HTML file.
+    Overridden by the "widths" option of the `table directive`_.
 
 Default: "".  Option: ``--table-style``.
 
@@ -1219,9 +1302,9 @@
 Path to template file, which must be encoded in UTF-8. #pwd_
 See also `template latex writers`_.
 
-Default: "template.txt" in the docutils/writers/html4css1/
-directory (installed automatically; for the exact machine-specific
-path, use the ``--help`` option).  Options: ``--template``.
+Default: "template.txt" in the writer's directory (installed automatically;
+for the exact machine-specific path, use the ``--help`` option).
+Option: ``--template``.
 
 
 .. _xml_declaration html writers:
@@ -1229,15 +1312,15 @@
 xml_declaration
 ~~~~~~~~~~~~~~~
 
-Generate XML with an XML declaration.
+Prepend an XML declaration.
 See also `xml_declaration docutils_xml writer`_.
 
 .. Caution:: The XML declaration carries text encoding information.  If the
    encoding is not UTF-8 or ASCII and the XML declaration is missing,
-   standard tools may be unable to read the generated XHTML.
-
-Default: do (True).  Options: ``--no-xml-declaration``.
+   standard XML tools may be unable to read the generated XHTML.
 
+Default: writer dependent.
+Options: ``--xml-declaration``, ``--no-xml-declaration``.
 
 
 html4css1 writer
@@ -1249,7 +1332,8 @@
 `configuration section`_.
 
 
-Writer specific defaults:
+Writer Specific Defaults
+""""""""""""""""""""""""
 
 `initial_header_level`_
   1 (for "<h1>")
@@ -1257,8 +1341,11 @@
 `stylesheet_path <stylesheet_path html writers_>`__:
   "html4css1.css"
 
+`xml_declaration <xml_declaration html writers_>`__
+  enabled (True)
+
 .. _HTML4/CSS1 Writer: html.html#html4css1
-.. _XHTML 1 Transitional: http://www.w3.org/TR/xhtml1/
+.. _XHTML 1 Transitional: https://www.w3.org/TR/xhtml1/
 
 
 field_name_limit
@@ -1289,35 +1376,64 @@
 It shares all settings defined in the `html writers`_
 `configuration section`_.
 
-Writer specific defaults:
+New in Docutils 0.13.
 
-`initial_header_level`_
-  2 (for "<h2>", cf. the `HTML5.3 Working Draft`__)
+.. _HTML5 Writer: html.html#html5-polyglot
+.. _HTML5: https://www.w3.org/TR/2014/REC-html5-20141028/
 
-`stylesheet_path <stylesheet_path html writers_>`__:
-  "minimal.css,plain.css"
+Writer Specific Defaults
+""""""""""""""""""""""""
 
-New in Docutils 0.13.
+`initial_header_level`_
+  2 (for "<h2>", cf. the "`The h1, h2, h3, h4, h5, and h6 elements`__"
+  in the HTML Standard)
 
-__  https://www.w3.org/TR/html53/sections.html#the-h1-h2-h3-h4-h5-and-h6-elements
-.. _HTML5 Writer: html.html#html5-polyglot
-.. _HTML5: http://www.w3.org/TR/html5/
+`stylesheet_path <stylesheet_path html writers_>`__:
+  "minimal.css, plain.css"
 
+__ https://html.spec.whatwg.org/multipage/sections.html
+   #the-h1,-h2,-h3,-h4,-h5,-and-h6-elements
 
 embed_images
 """"""""""""
 
-Embed images in the output HTML file. If the image can be read from
-the local file system and its MIME type can be determined, it is
-base64_ encoded and included as a `data URI`_.
+Deprecated. Obsoleted by image_loading_.
 
-Default: disabled (False).
-Options: ``--embed-images``, ``--link-images``
 
-New in Docutils 0.17.
+image_loading
+"""""""""""""
+
+Suggest at which point images should be loaded.
+
+:embed: If the image can be read from the local file system,
+        the image data is embedded into the HTML document.
+
+:link: Link to image in the HTML document (default).
+
+:lazy: Link to image. Specify the `lazy loading attribute`_ to defer
+       fetching the image.
+
+Default: "link". Option: ``--image-loading``.
+
+New in Docutils 0.18.
 
 .. _base64: https://en.wikipedia.org/wiki/Base64
 .. _data URI: https://en.wikipedia.org/wiki/Data_URI_scheme
+.. _lazy loading attribute: https://html.spec.whatwg.org/multipage/
+    urls-and-fetching.html#lazy-loading-attributes
+
+
+section_self_link
+"""""""""""""""""
+
+Append an empty anchor element with a ``href`` to the section to
+section headings. See ``responsive.css`` for an example how this can be
+styled to show a symbol allowing users to copy the section's URL.
+
+Default: disabled (False).
+Options: ``--section-self-link``, ``--no-section-self-link``.
+
+New in Docutils 0.18.
 
 
 pep_html writer
@@ -1327,7 +1443,8 @@
 all settings defined in the `html writers`_ and `html4css1 writer`_
 `configuration sections`_.
 
-Writer specific defaults:
+Writer Specific Defaults
+""""""""""""""""""""""""
 
 `initial_header_level`_
   1 (for "<h1>")
@@ -1352,13 +1469,13 @@
 
 Home URL prefix for PEPs.
 
-Default: current directory (".").  Options: ``--pep-home``.
+Default: current directory (".").  Option: ``--pep-home``.
 
 python_home
 """""""""""
 Python's home URL.
 
-Default: parent directory ("..").  Options: ``--python-home``.
+Default: parent directory ("..").  Option: ``--python-home``.
 
 
 s5_html writer
@@ -1368,7 +1485,8 @@
 all settings defined in the `html writers`_ and `html4css1 writer`_
 `configuration sections`_.
 
-Writer specific defaults:
+Writer Specific Defaults
+""""""""""""""""""""""""
 
 compact_lists_:
   disable compact lists.
@@ -1387,16 +1505,16 @@
 Auto-hide the presentation controls in slideshow mode, or or keep
 them visible at all times.
 
-Default: auto-hide (True).  Options: ``--hidden-controls``,
-``--visible-controls``.
+Default: auto-hide (True).
+Options: ``--hidden-controls``, ``--visible-controls``.
 
 current_slide
 """""""""""""
 
 Enable or disable the current slide indicator ("1/15").
 
-Default: disabled (None).  Options: ``--current-slide``,
-``--no-current-slide``.
+Default: disabled (None).
+Options: ``--current-slide``, ``--no-current-slide``.
 
 overwrite_theme_files
 """""""""""""""""""""
@@ -1405,8 +1523,8 @@
 ``ui/<theme>`` directory.  This has no effect if "theme_url_" is
 used.
 
-Default: keep existing theme files (None).  Options:
-``--keep-theme-files``, ``--overwrite-theme-files``.
+Default: keep existing theme files (None).
+Options: ``--keep-theme-files``, ``--overwrite-theme-files``.
 
 theme
 """""
@@ -1545,7 +1663,7 @@
 not "false", the expansion of ::
 
   'colorlinks=true,linkcolor=%s,urlcolor=%s' % (
-     hyperlink_color, self.hyperlink_color
+      hyperlink_color, hyperlink_color)
 
 is prepended.
 
@@ -1553,6 +1671,7 @@
 
 .. _hyperref TeX package: http://tug.org/applications/hyperref/
 
+
 latex_preamble
 ~~~~~~~~~~~~~~
 
@@ -1572,13 +1691,33 @@
 values are handled with wrappers and admonitions use the ``DUadmonition``
 environment. See `Generating LaTeX with Docutils`__ for details.
 
-Default: True (this will change to False in version 0.18).
+Default: False (since Docutils 0.18).
 Options: ``--legacy-class-functions``, ``--new-class-functions``.
 
 New in Docutils 0.17.
 
 __ latex.html#classes
 
+
+legacy_column_widths
+~~~~~~~~~~~~~~~~~~~~
+
+Use "legacy algorithm" or new algorithm to determine table column widths.
+
+The new algorithm limits the table width to the text width or specified
+table width and keeps the ratio of specified column widths.
+
+Custom table and/or column widths can be set with the respective options
+of the `table directive`_. See also `Generating LaTeX with Docutils`__.
+
+Default: True (will change to False in Docutils 1.0).
+Options: ``--legacy-column-widths``, ``--new-column-widths``.
+
+New in Docutils 0.18.
+
+__ latex.html#table-style
+
+
 literal_block_env
 ~~~~~~~~~~~~~~~~~
 
@@ -1593,14 +1732,16 @@
 
 .. _parsed literal: ../ref/rst/directives.html#parsed-literal
 
+
 reference_label
 ~~~~~~~~~~~~~~~
 
 Per default the latex-writer puts the reference title into
-hyperreferences. Specify "ref*" or "pageref*" to get the section
+hyper references. Specify "ref*" or "pageref*" to get the section
 number or the page number.
 
-Default: "" (use hyperreferences).  Option: ``--reference-label``.
+Default: "" (use hyper references).  Option: ``--reference-label``.
+
 section_enumerator_separator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1637,6 +1778,8 @@
 ~~~~~~~~~~
 
 A comma-separated list_ of style files.
+Used without path adaption (cf. `stylesheet_path latex writers`_).
+Under Windows, path separators are normalized to forward slashes (``/``).
 See also `stylesheet html writers`_.
 
 Overrides also stylesheet_path__. #override_
@@ -1673,7 +1816,7 @@
 Default: the working directory of the process at launch and the directory
 with default stylesheet files (writer and installation specific).
 Use the ``--help`` option to get the exact value.
-Option: ``--stylesheet-directories``.
+Option: ``--stylesheet-dirs``.
 
 
 .. _stylesheet_path latex writers:
@@ -1688,7 +1831,7 @@
 the output file.
 See also `stylesheet_path html writers`_.
 
-The stylesheet__  option is preferred for files in the `TeX input path`_.
+For files in the `TeX input path`_, the stylesheet__  option is recommended.
 
 Also overrides stylesheet__. #override_
 
@@ -1708,32 +1851,13 @@
 Specify the default style for tables_.
 See also `table_style html writers`_.
 
-Supported values:
-
-standard
-  Borders around all cells.
-booktabs
-  A line above and below the table and one after the head.
-borderless
-  No borders.
-
-align-left, align-center, align-right
-  Align tables.
-
-colwidths-auto, colwidths-given
-  Default value for column width determination by
-  LaTeX or Docutils.
-  Override with the `table directive`_'s :widths: option.
-
-  .. warning::
-
-    ``colwidths-auto`` is only suited for tables with simple cell content.
-
-    LaTeX puts the content of auto-sized columns on one line (merging
-    paragraphs) and may fail with complex content.
+Supported values: "booktabs", "borderless", "colwidths-auto", and "standard".
+See `Generating LaTeX with Docutils`__ for details.
 
 Default: "standard".  Option: ``--table-style``.
 
+__ latex.html#tables
+
 
 .. _template latex writers:
 
@@ -1744,15 +1868,18 @@
 See also `template html writers`_.
 
 Default: writer dependent (see `latex2e writer`_, `xetex writer`_).
-Options: ``--template``.
-
+Option: ``--template``.
 
 use_bibtex
 ~~~~~~~~~~
-Specify style and database for the experimental `BibTeX` support, for
-example::
 
-  --use-bibtex=mystyle,mydb1,mydb2
+Provisional, name, values, and behaviour may change in future versions
+or the option may be removed.
+
+A comma-separated list of style and database(s) for the experimental
+`BibTeX` support, for example::
+
+  --use-bibtex=unsrt,mydb1,mydb2
 
 Default: "" (don't use BibTeX).  Option ``--use-bibtex``.
 
@@ -1781,7 +1908,7 @@
 use_latex_toc
 ~~~~~~~~~~~~~
 
-To get pagenumbers in the `table of contents`_, it
+To get page numbers in the `table of contents`_, it
 must be generated by LaTeX. Usually latex must be run twice to get
 numbers correct.
 
@@ -1803,7 +1930,6 @@
 
 .. _LaTeX2e writer: latex.html#latex2e-writer
 .. _pdfTeX: https://www.tug.org/applications/pdftex/
-.. _configuration section: `Configuration File Sections & Entries`_
 
 
 Writer Specific Defaults
@@ -1840,14 +1966,12 @@
 xetex writer
 ~~~~~~~~~~~~~~
 
-The `XeTeX writer`_ generates a LaTeX source for compilation with `XeTeX or
-LuaTeX`_. It derives from the latex2e writer, and shares all settings
-defined in the `latex writers`_ and `latex2e writer`_ `configuration
-sections`_.
+The `XeTeX writer`_ generates a LaTeX source for compilation with `XeTeX
+or LuaTeX`_. It derives from the latex2e writer, and shares all settings
+defined in the `latex writers`_ `configuration section`_.
 
 .. _XeTeX writer: latex.html#xetex-writer
 .. _XeTeX or LuaTeX: https://texfaq.org/FAQ-xetex-luatex
-.. _configuration sections: `Configuration File Sections & Entries`_
 
 Writer Specific Defaults
 """"""""""""""""""""""""
@@ -1876,10 +2000,21 @@
   __ `template latex writers`_
 
 
+.. _ODF/ODT Writer:
+
 odf_odt writer
 ----------------
 
-The following command line options are specific to ``odtwriter``:
+The `ODF/ODT Writer`__ generates documents in the 
+OpenDocument_ Text format (.odt).
+
+The output_encoding_ setting is ignored, the output encoding is
+always "UTF-8".
+
+__
+.. _ODT Writer for Docutils: odt.html
+.. _OpenDocument: https://en.wikipedia.org/wiki/OpenDocument
+
 
 stylesheet
 ~~~~~~~~~~
@@ -1906,6 +2041,7 @@
 
 no-cloak-email-addresses
 ~~~~~~~~~~~~~~~~~~~~~~~~
+
 Do not obfuscate email addresses.
 
 table-border-thickness
@@ -1937,6 +2073,7 @@
 
 create-links
 ~~~~~~~~~~~~
+
 Create links.
 
 no-links
@@ -1988,18 +2125,16 @@
 time, etc" in the `Odt Writer for Docutils`_ document for
 details.
 
-.. _Odt Writer for Docutils: odt.html
-
 
 pseudoxml writer
 ------------------
 
-detailled
+detailed
 ~~~~~~~~~
 
 Pretty-print <#text> nodes.
 
-Default:  False.  Options: ``--detailled``.
+Default:  False.  Option: ``--detailed``.
 
 
 applications
@@ -2013,17 +2148,7 @@
 
 Do not process files, show files that would be processed.
 
-Default:  False.  Options: ``--dry-run``.
-
-html_writer
-~~~~~~~~~~~
-
-`HTML writer`_ version. One of "html", "html4", "html5".
-
-Default: "html" (use Docutils' default HTML writer).
-Options: ``--html-writer``
-
-.. _HTML writer: html.html
+Default:  False.  Option: ``--dry-run``.
 
 ignore
 ~~~~~~
@@ -2033,7 +2158,7 @@
 configuration files or on the command line); on the command line, the
 option may also be used more than once.
 
-Default: None.  Options: ``--ignore``.
+Default: None.  Option: ``--ignore``.
 
 prune
 ~~~~~
@@ -2043,7 +2168,7 @@
 on the command line); on the command line, the option may also be
 used more than once.
 
-Default: '.hg', '.bzr', '.git', '.svn', 'CVS'.  Options:
+Default: '.hg', '.bzr', '.git', '.svn', 'CVS'.  Option:
 ``--prune``.
 
 recurse
@@ -2059,13 +2184,65 @@
 Work silently (no progress messages).  Independent of
 "report_level".
 
-Default: show progress (None).  Options: ``--silent``.
+Default: show progress (None).  Option: ``--silent``.
+
+.. _html_writer:
+.. _writer buildhtml application:
 
+writer
+~~~~~~
+
+`HTML writer`_ version. One of "html", "html4", "html5".
+
+Default: "html" (use Docutils' default HTML writer).
+Option: ``--writer``
+
+New in 0.17. Obsoletes the ``html_writer`` option.
+
+.. _HTML writer: html.html
+
+
+docutils application
+--------------------------
+
+| New in 0.17. Config file support added in 0.18.
+| Renamed in 0.19 (the old name "docutils-cli application" is kept as alias).
+| Support for reader/parser import names added in 0.19.
+
+reader
+~~~~~~
+Reader component name.
+One of "standalone", "pep",
+or the import name of a drop-in reader module.
+
+Default: "standalone".
+Option: ``--reader``
+
+parser
+~~~~~~
+Parser component name.
+Either "rst" (default) or the import name of a drop-in parser module.
+
+Parsers for CommonMark_ known to work with Docutils include "pycmark_",
+"myst_", and "recommonmark_".
+
+Default: "rst".
+Option: ``--parser``
 
-docfactory application
-------------------------
+.. _CommonMark: https://spec.commonmark.org/0.30/
 
-(To be completed.)
+
+.. _writer docutils application:
+
+writer
+~~~~~~
+Writer component name.
+One of "html", "html4", "html5", "latex", "xelatex", "odt", "xml",
+"pseudoxml", "manpage", "pep_html", "s5", an alias,
+or the import name of a drop-in writer module.
+
+Default: "html5".
+Option: ``--writer``
 
 
 Other Settings
@@ -2089,7 +2266,7 @@
 interpreted relative to the config file's location (*not* relative
 to the current working directory).
 
-Default: None.  Options: ``--config``.
+Default: None.  Option: ``--config``.
 
 
 Internal Settings
@@ -2139,8 +2316,8 @@
 
 --------------------------------------------------------------------------
 
-.. _language tag: http://www.w3.org/International/articles/language-tags/
-.. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
+.. _language tag: https://www.w3.org/International/articles/language-tags/
+.. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
 .. _ISO 639: http://www.loc.gov/standards/iso639-2/php/English_list.php
 .. _ISO 3166: http://www.iso.ch/iso/en/prods-services/iso3166ma/
    02iso-3166-code-lists/index.html
@@ -2162,8 +2339,9 @@
 Formerly, Docutils configuration files contained a single "options"
 section only.  This was found to be inflexible, and in August 2003
 Docutils adopted the current component-based configuration file
-sections as described above.  Docutils will still recognize the old
-"options" section, but complains with a deprecation warning.
+sections as described above.
+Up to version 2.0, Docutils will still recognize the old "options"
+section, but complain with a deprecation warning.
 
 To convert existing config files, the easiest way is to change the
 section title: change "options" to "general".  Most settings
@@ -2185,6 +2363,8 @@
    ../ref/rst/restructuredtext.html#bibliographic-fields
 .. _block quote: ../ref/rst/restructuredtext.html#block-quotes
 .. _citations: ../ref/rst/restructuredtext.html#citations
+.. _bullet lists: ../ref/rst/restructuredtext.html#bullet-lists
+.. _Docutils Runtime Settings: ../api/runtime-settings.html
 .. _enumerated lists: ../ref/rst/restructuredtext.html#enumerated-lists
 .. _field lists: ../ref/rst/restructuredtext.html#field-lists
 .. _field names: ../ref/rst/restructuredtext.html#field-names
@@ -2195,5 +2375,7 @@
 .. _literal blocks: ../ref/rst/restructuredtext.html#literal-blocks
 .. _option lists: ../ref/rst/restructuredtext.html#option-lists
 .. _tables: ../ref/rst/restructuredtext.html#tables
-
 .. _table of contents: ../ref/rst/directives.html#contents
+
+.. _Error Handlers:
+   https://docs.python.org/3/library/codecs.html#error-handlers

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/emacs.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/emacs.txt Changed

@@ -1,5 +1,7 @@
 .. -*- coding: utf-8 -*-
 
+.. include:: ../header.txt
+
 ========================================
    Emacs Support for reStructuredText
 ========================================
@@ -89,7 +91,7 @@
 #. Download ``rst.el``
 
    Download the most recent published version of ``rst.el`` from
-   http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/tools/editors/emacs/rst.el
+   https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/tools/editors/emacs/rst.el
 
 #. Put ``rst.el`` to a directory in ``load-path``
 
@@ -589,12 +591,12 @@
   structures docutils will parse them into. You can use to run the
   active region through ``rst2pseudoxml.py`` and have the output
   automatically be displayed in a new buffer.
-  
+
 * ``rst-compile-pdf-preview`` (``C-c C-c C-p``)
 
   Convert the current document to PDF and launch a viewer on the
   results.
-  
+
 * ``rst-compile-slides-preview`` (``C-c C-c C-s``): Convert the
   current document to S5 slides and view in a web browser.
 
@@ -939,9 +941,9 @@
 Most of the code has been modified, enhanced and extended by Stefan
 Merten who also is the current maintainer of ``rst.el``.
 
-.. _Emacs: http://www.gnu.org/software/emacs/emacs.html
-.. _reStructuredText: http://docutils.sf.net/rst.html
-.. _Docutils: http://docutils.sf.net/
+.. _Emacs: https://www.gnu.org/software/emacs/emacs.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Docutils: https://docutils.sourceforge.io/
 
 &#xc;

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/html.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/html.txt Changed

@@ -1,3 +1,5 @@
+.. include:: ../header.txt
+
 =====================
 Docutils HTML writers
 =====================
@@ -7,11 +9,14 @@
 html
 ----
 
+:front-end: rst2html.py_
+
 `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.
@@ -66,7 +71,7 @@
 .. _rstpep2html.py: tools.html#rstpep2html-py
 .. _PEP-specific options:
 .. _pep_html writer: config.html#pep-html-writer
-.. _Python Enhancement Proposals: https://www.python.org/dev/peps/
+.. _Python Enhancement Proposals: https://peps.python.org/
 
 s5_html
 ~~~~~~~
@@ -86,10 +91,10 @@
 .. _theme: tools.html#themes
 
 
-html5_polyglot
---------------
+html5
+-----
 
-:aliases: html5
+:aliases: _`html5_polyglot`
 :front-end: rst2html5.py_
 :config: `html5 writer`_
 
@@ -98,11 +103,11 @@
 are used if they are widely supported.
 
 There is no hard-coded formatting information in the HTML document.
-Correct rendering of elements not directly supported by HTML depends
-on a CSS_ style sheet. The provided style sheet minimal.css_ defines
-required and styling rules, plain.css_ and responsive.css_ add
-optional rules for better legibility. Adaption of the layout is
-possible with `custom style sheets`_. #safetext_
+Correct rendering of elements not directly supported by HTML depends on a
+CSS_ style sheet. The provided style sheet minimal.css_ defines required
+styling rules; plain.css_ and responsive.css_ add optional rules for
+better legibility. Adaption of the layout is possible with `custom style
+sheets`_. #safetext_
 
 New in Docutils 0.13
 
@@ -120,43 +125,31 @@
 .. _Benefits of polyglot XHTML5: http://xmlplease.com/xhtml/xhtml5polyglot/
 
 
-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 writer: ../../../sandbox/html4strict/README.html
-.. _HTML writer for lightweight browsers:
-   ../../../sandbox/html4trans/README.html
-
-
 Overview
 --------
 
-=============== =========== ============== ================= ===========
-name            aliases     `front-end`_   HTML version      CSS version
-=============== =========== ============== ================= ===========
-html4css1_      html4,      rst2html4.py,  `XHTML 1          `CSS 1`_
-                html_       rst2html.py    Transitional`_
+================ =========== ============== ================= ===========
+name             aliases     `front-end`_   HTML version      CSS version
+================ =========== ============== ================= ===========
+html4css1_       html4,      rst2html4.py,  `XHTML 1          `CSS 1`_
+                 html_       rst2html.py    Transitional`_
 
-pep_html_       ..          rstpep2html.py `XHTML 1          `CSS 1`_
-                                           Transitional`_
+pep_html_        ..          rstpep2html.py `XHTML 1          `CSS 1`_
+                                            Transitional`_
 
-s5_html_        s5          rst2s5.py      `XHTML 1          `CSS 1`_
-                                           Transitional`_
+s5_html_         s5          rst2s5.py      `XHTML 1          `CSS 1`_
+                                            Transitional`_
 
-html5_polyglot_ html5       rst2html5.py   `HTML5`_          `CSS 3`_
+html5_polyglot_  html5       rst2html5.py   `HTML5`_          `CSS 3`_
 
-xhtml11_        xhtml,      rst2xhtml.py   `XHTML 1.1`_      `CSS 3`_
-                html4strict
+================ =========== ============== ================= ===========
 
-html4trans_     ..          rst2html_trans `XHTML 1          no CSS
-                                           Transitional`_    required
-=============== =========== ============== ================= ===========
+For additional alternatives, see the `Docutils link list`__ and the
+sandbox_.
+
+__ https://docutils.sourceforge.io/docs/user/links.html
+   #website-generators-and-html-variants
+.. _sandbox: ../dev/policies.html#the-sandbox
 
 
 References
@@ -165,32 +158,32 @@
 _`HTML5`
    `HTML5, A vocabulary and associated APIs for HTML and XHTML`,
    W3C Recommendation, 28 October 2014.
-   http://www.w3.org/TR/html5/
+   https://www.w3.org/TR/2014/REC-html5-20141028/
 
 _`XHTML 1.1`
    `XHTML™ 1.1 - Module-based XHTML - Second Edition`,
    W3C Recommendation, 23 November 2010.
-   http://www.w3.org/TR/xhtml11/
+   https://www.w3.org/TR/xhtml11/
 
 _`XHTML 1 Transitional`
    `Transitional version`_ of:
    `XHTML™ 1.0 The Extensible HyperText Markup Language (Second
    Edition)`, `A Reformulation of HTML 4 in XML 1.0`,
    W3C Recommendation, 26 January 2000, revised 1 August 2002.
-   http://www.w3.org/TR/xhtml1/
+   https://www.w3.org/TR/xhtml1/
 
 _`XHTML Basic`
    `XHTML™ Basic 1.1 - Second Edition`,
    W3C Recommendation, 23 November 2010.
-   http://www.w3.org/TR/xhtml-basic/
+   https://www.w3.org/TR/xhtml-basic/
 
 .. _transitional version:
-   http://www.w3.org/TR/xhtml1/#a_dtd_XHTML-1.0-Transitional
+   https://www.w3.org/TR/xhtml1/#a_dtd_XHTML-1.0-Transitional
 
 _`HTML 4.01 Transitional`
   Transitional version of:
   `HTML 4.01 Specification`, W3C Recommendation 24 December 1999.
-  http://www.w3.org/TR/html4/
+  https://www.w3.org/TR/html4/
 
 .. _`CSS 1`:
 
@@ -200,23 +193,23 @@
 
 _`CSS 2.1` `Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification`,
   W3C Recommendation 07 June 2011.
-  http://www.w3.org/TR/CSS21/
+  https://www.w3.org/TR/CSS21/
 
 _`CSS 3`:
   CSS Level 3 builds on CSS Level 2 module by module, using the CSS2.1
   specification as its core.
 
-  Specifications: http://www.w3.org/Style/CSS/specs.en.html
+  Specifications: https://www.w3.org/Style/CSS/specs.en.html
 
   Validator: http://jigsaw.w3.org/css-validator/
 
 .. other references
    ----------------
 
-.. _HTML Compatibility Guidelines: http://www.w3.org/TR/xhtml1/#guidelines
-.. _CSS: http://www.w3.org/TR/CSS/
-.. _CSS1 specification: http://www.w3.org/TR/2008/REC-CSS1-20080411/
-.. _polyglot HTML: http://www.w3.org/TR/html-polyglot/
+.. _HTML Compatibility Guidelines: https://www.w3.org/TR/xhtml1/#guidelines
+.. _CSS: https://www.w3.org/TR/CSS/
+.. _CSS1 specification: https://www.w3.org/TR/2008/REC-CSS1-20080411/
+.. _polyglot HTML: https://www.w3.org/TR/html-polyglot/
 
    .. Beware. This specification is no longer in active maintenance and the
       HTML Working Group does not intend to maintain it further.
@@ -247,57 +240,4 @@
   > formatting. This way, any user who wants to (e.g.) write reST for use with
   > Bootstrap can easily work around any naming conflicts.
 
-
-
-  Problems with html4css1 writer:
-
-  1. Limiting ourself to CSS Level 1 requires use of hard-coded HTML
-     formatting to get all rST objects mapped to HTML.
-     Hard-coded HTML formatting is considered bad practice.
-
-  2. Maths cannot be included in MathML format without rendering a
-     hmtl4css1-generated document invalid.
-
-     (XHTML 1.1. is the only member of the "HTML4 family" allowing embedding
-     of MathML. However, hard-coded HTML formatting prevents its use.)
-
-
-
-  Comparison of current HTML versions
-  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-  XHTML1.1
-  """"""""
-
-  +2 XML-based with official DTD
-     +1 allows processing with XML-tool-chain
-     +1 allows validating against the DTD
-
-  +1 writer exists (in sandbox) and in active use since 2008
-
-  -1 "old" format
-  -1 requires to work around restrictions lifted in HTML5
-     ("start" argument for enumerated lists, some tags in parsed literal)
-     which makes code and documents more complicated
-
-  HTML5
-  """""
-  +1 more recent
-  +1 simpler to write, less restrictions
-
-  +1 writer exists and in active use since 2015
-
-  +1 new page structure elements such as <main>, <section>, <article>,
-     <header>, <footer>, <aside>, <nav> and <figure>
-     provide better matches for the rst document model.
-
-  -1 new elements not yet supported by many browsers.
-
-  -2 no DTD
-     - no proper validation possible (there is an experimental validator)
-     - no standard interface to post-processing XML-tools
-
-  -1 two concurring definitions:
-     W3C standard and WHATWG "HTML Living Standard".
-
 .. _front-end: tools.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/latex.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/latex.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 ================================
  Generating LaTeX with Docutils
 ================================
 
-:Author: Engelbert Gruber, Guenter Milde
+:Author: Engelbert Gruber, Günter Milde
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8625 $
-:Date: $Date: 2021-02-19 00:09:23 +0100 (Fr, 19. Feb 2021) $
+:Revision: $Revision: 9124 $
+:Date: $Date: 2022-09-13 12:29:51 +0200 (Di, 13. Sep 2022) $
 :Copyright: This document has been placed in the public domain.
 :Abstract: This document covers topics specific to Docutils' LaTeX_ export.
 
@@ -19,7 +21,7 @@
 LaTeX__, is a document preparation system for high-quality typesetting. It
 is most often used for medium-to-large technical or scientific documents but
 it can be used for almost any form of publishing. There exists a wide
-selecton of `LaTeX Documentation on the net`_ and `books on LaTeX and
+selection of `LaTeX Documentation on the net`_ and `books on LaTeX and
 related topics`_. For an introduction to LaTeX see, e.g., `LaTeX2e for
 authors`_.
 
@@ -134,7 +136,7 @@
 
 _`xelatex` or _`lualatex`
   The `XeTeX`_ and LuaTeX_ engines work with input files in UTF-8 encoding
-  and system fonts. Export your document with the _`XeTeX writer` (writer
+  and system fonts. Export your document with the _`XeLaTeX writer` (writer
   name "``xetex``", frontend tool rst2xetex.py_).
 
 You may need to call latex two or three times to get internal references
@@ -174,8 +176,7 @@
 Run ``rst2latex.py --help`` to get a list of available options;
 see `Docutils Configuration`_ for details.
 
-.. _Docutils Configuration:
-   config.html
+.. _Docutils Configuration: config.html
 
 Classes
 -------
@@ -238,7 +239,7 @@
   or ::
 
     \makeatletter
-    \@namedef{DUadmonitionadmonition-test}{…}
+    \@namedef{DUCLASSadmonition-test}{…}
     \makeatother
 
 * Elements can have multiple class arguments. In contrast to HTML/CSS, the
@@ -251,13 +252,11 @@
     ``language-`` set the elements language property.
 
   * The table element recognizes some special class values. See section
-    table_.
-
-  * For "historical reasons", the special macros ``\DUadmonition`` and
-    ``\DUtitle`` are written with a comma separated list of class values as
-    optional argument if the legacy-class-functions_ setting is True.
+    `table style`_.
 
-    See the sections on admonitions_ and titles_ for customization examples.
+  * If the legacy-class-functions_ setting is True, the special macros
+    ``\DUadmonition`` and ``\DUtitle`` are written with a comma separated
+    list of class values as optional argument.
 
 .. _"classes" attribute: ../ref/doctree.html#classes
 .. _legacy-class-functions: config.html#legacy-class-functions
@@ -276,11 +275,11 @@
   standalone_rst_latex.tex_
 
 .. _standalone_rst_latex.txt:
-  https://sf.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/input/standalone_rst_latex.txt
+  https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/input/standalone_rst_latex.txt
 .. _tests/functional/input/data:
-  https://sf.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/input/data
+  https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/input/data
 .. _standalone_rst_latex.tex:
-   https://sf.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/expected/standalone_rst_latex.tex?format=raw
+   https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/test/functional/expected/standalone_rst_latex.tex
 
 
 .. _style sheet:
@@ -327,12 +326,9 @@
   There is a `repository of user-contributed style sheets`_ in the
   Docutils Sandbox_.
 
-.. _clsguide:
-   http://mirrors.ctan.org/macros/latex/base/clsguide.pdf
-.. _stylesheet:
-   config.html#stylesheet-latex-writers
-.. _embed-stylesheet:
-   config.html#embed-stylesheet-latex-writers
+.. _clsguide: https://mirrors.ctan.org/macros/latex/base/clsguide.pdf
+.. _stylesheet: config.html#stylesheet-latex-writers
+.. _embed-stylesheet: config.html#embed-stylesheet-latex-writers
 .. _repository of user-contributed style sheets:
    ../../../sandbox/stylesheets/
 .. _sandbox: ../../../sandbox/
@@ -360,12 +356,9 @@
                      \usepackage{mathptmx}          % Times
                      \usepackagescaled=.92{helvet}  % Helvetica
 
-.. _latex-preamble:
-   config.html#latex-preamble
-.. _PDF standard fonts:
-   http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts
-.. _Linux Libertine:
-   http://www.linuxlibertine.org/index.php?id=1&L=1
+.. _latex-preamble: config.html#latex-preamble
+.. _PDF standard fonts: https://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts
+.. _Linux Libertine: http://www.linuxlibertine.org
 
 
 Templates
@@ -381,7 +374,7 @@
   template_
 
 In addition to the 'default.tex' template, the latex writer directory
-contains the alternatives 'titlepage.tex' (separete title page) and
+contains the alternatives 'titlepage.tex' (separate title page) and
 'titlingpage.tex'" (separate title page with the `memoir`_
 `document class`_).
 
@@ -428,11 +421,8 @@
   * Defining a macro for a `custom role`_.
   * Forcing `page breaks`_.
 
-.. _raw directive:
-   ../ref/rst/directives.html#raw
-.. _math directive:
-   ../ref/rst/directives.html#math
-
+.. _raw directive: ../ref/rst/directives.html#raw
+.. _math directive: ../ref/rst/directives.html#math
 
 
 How to configure the ...
@@ -446,13 +436,10 @@
 
 __ ../ref/rst/directives.html#admonitions
 
-Command:
-  ``\DUadmonition`` (with legacy-class-functions_)
-
 Environment:
-  ``DUadmonition`` (with new-class-functions_)
+  ``DUadmonition``
 
-  .. _new-class-functions: legacy-class-functions_
+  (Command ``\DUadmonition`` with legacy-class-functions_.)
 
 Default:
   Typeset in a frame (90 % of text width).
@@ -462,49 +449,31 @@
 Example 1:
   A lighter layout without the frame::
 
-    \newcommand{\DUadmonition}2class-arg{%
-      % try \DUadmonition#1{#2}:
-      \ifcsname DUadmonition#1\endcsname%
-        \csname DUadmonition#1\endcsname{#2}%
-      \else
-        \begin{quote}
-          #2
-        \end{quote}
-      \fi
-    }
-
-  rsp with new-class-functions_::
-
     \newenvironment{DUadmonition}%
       {\begin{quote}}
       {\end{quote}}
 
-
 Example 2:
-  Print admonitions in the margin::
+  Print all admonitions in the margin::
 
-    \newcommand{\DUadmonition}2class-arg{\marginpar{#2}}
-
-  Make sure there is enough space to fit the note.
-  See also the marginnote_ package.
+    \usepackage{environ}
+    \NewEnviron{DUadmonition}{\marginpar{\BODY}}
 
 Example 3:
   Use the ``.. note::`` admonition for a margin note::
 
-    \newcommand{\DUadmonitionnote}1{\marginpar{#1}}
-
-  rsp with new-class-functions_ we re-define the environment in the
-  class-wrapper::
-
+    \usepackage{environ}
     \newcommand{\DUCLASSnote}{%
-      \renewcommand{\DUadmonition}{\marginpar}
-
-  Make sure there is enough space to fit the note.
+      \RenewEnviron{DUadmonition}{\marginpar{\BODY}}%
+      \renewcommand{\DUtitle}1{}% suppress title ("Note")
+    }
 
+.. caution:: Make sure there is enough space in the margin.
+   ``\marginpar`` fails in some places or with some content. See also the
+   environ_ and marginnote_ packages.
 
-.. _marginnote:
-   http://ctan.org/pkg/marginnote
-   http://ctan.org/pkg/marginnote
+.. _environ: https://ctan.org/pkg/environ
+.. _marginnote: https://ctan.org/pkg/marginnote
 
 
 .. _custom role:
@@ -579,14 +548,9 @@
 .. # Leave out the ``\makeatletter`` - ``\makeatother`` pair if the style
    sheet is a LaTeX package (``*.sty``).
 
-.. _role directive:
-   ../ref/rst/directives.html#role
-
-.. _text roles:
-   ../ref/rst/roles.html
-
-.. _class directive:
-   ../ref/rst/directives.html#class
+.. _role directive: ../ref/rst/directives.html#role
+.. _text roles: ../ref/rst/roles.html
+.. _class directive: ../ref/rst/directives.html#class
 
 definition lists
 ----------------
@@ -625,12 +589,9 @@
 Option:
   documentclass_
 
-.. _KOMA-script:
-   http://ctan.org/pkg/koma-script
-.. _memoir:
-   http://ctan.org/pkg/memoir
-.. _documentclass:
-   config.html#documentclass
+.. _KOMA-script: https://ctan.org/pkg/koma-script
+.. _memoir: https://ctan.org/pkg/memoir
+.. _documentclass: config.html#documentclass
 
 
 document info
@@ -656,10 +617,8 @@
 
 __ ../ref/rst/restructuredtext.html#bibliographic-fields
 
-.. _use-latex-docinfo:
-   config.html#use-latex-docinfo
-.. _use-latex-abstract:
-   config.html#use-latex-abstract
+.. _use-latex-docinfo: config.html#use-latex-docinfo
+.. _use-latex-abstract: config.html#use-latex-abstract
 
 
 document title
@@ -712,9 +671,7 @@
    The `KOMA-script`_ classes provide a similar environment under the name
    `labeling`.
 
-.. _enumitem:
-   http://ctan.org/pkg/enumitem
-
+.. _enumitem: https://ctan.org/pkg/enumitem
 __ ../ref/rst/restructuredtext.html#field-lists
 
 
@@ -736,10 +693,8 @@
     \usepackage{caption}
     \captionsetup{justification=raggedleft,singlelinecheck=false}
 
-.. _caption:
-   http://ctan.org/pkg/caption
-.. _chngcntr:
-   http://ctan.org/pkg/chngcntr
+.. _caption: https://ctan.org/pkg/caption
+.. _chngcntr: https://ctan.org/pkg/chngcntr
 __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=running-nos
 
 
@@ -777,10 +732,9 @@
         \floatplacement{figure}{tb}
 
 .. _figures: ../ref/rst/directives.html#figure
-.. _float:
-   http://ctan.org/pkg/float
-.. _float.pdf:
-   http://mirrors.ctan.org/macros/latex/contrib/float/float.pdf
+.. _float: https://ctan.org/pkg/float
+.. _float.pdf: https://mirrors.ctan.org/macros/latex/contrib/float/float.pdf
+
 
 .. _font setup:
 
@@ -803,7 +757,7 @@
   can use system fonts and provides access to the full feature set of
   modern OpenType_ fonts.
 
-.. _OpenType: http://en.wikipedia.org/wiki/OpenType
+.. _OpenType: https://en.wikipedia.org/wiki/OpenType
 
 The default font setup is done in the latex-preamble_:
 
@@ -878,7 +832,7 @@
       \setsansfont{DejaVu Sans}
       \setmonofontHyphenChar=None{DejaVu Sans Mono}
 
-.. _fontspec: http://ctan.org/pkg/fontspec
+.. _fontspec: https://ctan.org/pkg/fontspec
 .. _fontmatrix: http://fontmatrix.net/
 .. _DejaVu: http://dejavu-fonts.org/
 .. _documentoptions: config.html#documentoptions
@@ -1008,28 +962,21 @@
        which is part of, e.g., `TeX Live`_.
 
 
-.. _LaTeX Font Catalogue:
-   http://www.tug.dk/FontCatalogue/
-.. _Latin Modern:
-   http://ctan.org/pkg/lm
-.. _CM-Super:
-   http://ctan.org/pkg/cm-super
-.. _bera:
-   http://ctan.org/pkg/bera
+.. _LaTeX Font Catalogue: http://www.tug.dk/FontCatalogue/
+.. _Latin Modern: https://ctan.org/pkg/lm
+.. _CM-Super: https://ctan.org/pkg/cm-super
+.. _bera: https://ctan.org/pkg/bera
 .. _TeX Gyre: http://www.gust.org.pl/projects/e-foundry/tex-gyre
-.. _PSNFSS:
-   http://ctan.org/pkg/psnfss
+.. _PSNFSS: https://ctan.org/pkg/psnfss
 .. _Using common PostScript fonts with LaTeX:
-   http://mirrors.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf
+   https://mirrors.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf
 .. _TeX Live: http://tug.org/texlive/
-.. _txfonts:
-   http://ctan.org/pkg/txfonts
+.. _txfonts: https://ctan.org/pkg/txfonts
 .. _PDF Standard Font:
-   http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts
+   https://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts
 .. _testflow:
    http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/testflow.html
-.. _Good Libre Fonts:
-   http://typophile.com/node/18207
+.. _Good Libre Fonts: http://typophile.com/node/18207
 .. _25 Best Free Quality Fonts:
    http://www.alvit.de/blog/article/20-best-license-free-official-fonts
 .. _19 More Free Quality Fonts:
@@ -1069,12 +1016,9 @@
 
     --font-encoding=LGR,T1 --stylesheet=lmodern
 
-.. _encguide:
-   http://mirrors.ctan.org/macros/latex/base/encguide.pdf
-.. _font-encoding:
-   config.html#font-encoding
-.. _fontenc:
-   http://ctan.org/pkg/fontenc
+.. _encguide: https://mirrors.ctan.org/macros/latex/base/encguide.pdf
+.. _font-encoding: config.html#font-encoding
+.. _fontenc: https://ctan.org/pkg/fontenc
 
 
 font size
@@ -1084,8 +1028,7 @@
 ``--documentoptions=12``, use e.g. the document classes provided by
 extsizes_ for values other than 10,11,12.
 
-.. _extsizes:
-   http://ctan.org/pkg/extsizes
+.. _extsizes: https://ctan.org/pkg/extsizes
 
 
 footnotes
@@ -1148,10 +1091,8 @@
        \hangpara{\parindent}{1}#4%
      }
 
-.. _footmisc:
-   http://ctan.org/pkg/footmisc
-.. _hanging:
-   http://ctan.org/pkg/hanging
+.. _footmisc: https://ctan.org/pkg/footmisc
+.. _hanging: https://ctan.org/pkg/hanging
 
 
 hyphenation
@@ -1183,7 +1124,7 @@
 below). This will ignore options set with hyperlink-color_ and
 hyperref-options_.
 
-URLs are typeset with the "url" package (loaded implicitely by "hyperref").
+URLs are typeset with the "url" package (loaded implicitly by "hyperref").
 The font of URLs can be defined with the ``\urlstyle`` command. Valid
 arguments are
 
@@ -1202,10 +1143,8 @@
 
 See also `non-breaking hyperlinks`_.
 
-.. _hyperlink-color:
-   config.html#hyperlink-color
-.. _hyperref-options:
-   config.html#hyperref-options
+.. _hyperlink-color: config.html#hyperlink-color
+.. _hyperref-options: config.html#hyperref-options
 
 
 disable hyperlinks
@@ -1224,8 +1163,19 @@
   \usepackage{nohyperref,url}
   \urlstyle{same}
 
-.. _hyperref:
-   http://ctan.org/pkg/hyperref
+.. _hyperref: https://ctan.org/pkg/hyperref
+
+
+language
+--------
+
+The global document language can be set with the language-code_
+configuration setting. The language of text parts can be set adding the
+language tag prefixed by "language-" to an element's classes_
+attribute, e.g. ``language-el`` for a Greek text part.
+
+.. _language-code: config.html#language-code
+
 
 line blocks
 -----------
@@ -1239,7 +1189,7 @@
   ``\DUlineblockindent``: indentation of indented lineblock parts.
 
 Default:
-   2.5 times the font hight: ``2.5em``
+   2.5 times the font height: ``2.5em``
 
 Example:
   set to the paragraph indentation::
@@ -1315,10 +1265,9 @@
     \lstset{xleftmargin=-2em}
 
 __ ../ref/rst/restructuredtext.html#literal-blocks
-.. _literal-block-env:
-   config.html#literal-block-env
+.. _literal-block-env: config.html#literal-block-env
 .. _listings.pdf:
-   http://mirrors.ctan.org/macros/latex/contrib/listings/listings.pdf
+   https://mirrors.ctan.org/macros/latex/contrib/listings/listings.pdf
 
 
 lists
@@ -1445,14 +1394,12 @@
     \geometry{hmargin={3cm,0.8in},height=8in}
     \geometry{height=10in}.
 
-.. _typearea:
-   http://ctan.org/pkg/typearea
+.. _typearea: https://ctan.org/pkg/typearea
+.. _geometry: https://ctan.org/pkg/geometry
 .. _KOMA-Script Guide:
-   http://mirrors.ctan.org/macros/latex/contrib/koma-script/doc/scrguien.pdf
-.. _geometry:
-   http://ctan.org/pkg/geometry
+   https://mirrors.ctan.org/macros/latex/contrib/koma-script/doc/scrguien.pdf
 .. _geometry manual:
-   http://mirrors.ctan.org/macros/latex/contrib/geometry/geometry.pdf
+   https://mirrors.ctan.org/macros/latex/contrib/geometry/geometry.pdf
 
 
 page headers and footers
@@ -1490,10 +1437,9 @@
 
   See the `chappg documentation`_ for details.
 
-.. _chappg:
-   http://ctan.org/pkg/chappg
+.. _chappg: https://ctan.org/pkg/chappg
 .. _chappg documentation:
-   http://mirrors.ctan.org/macros/latex/contrib/chappg/chappg.pdf
+   https://mirrors.ctan.org/macros/latex/contrib/chappg/chappg.pdf
 
 
 paper size
@@ -1576,7 +1522,7 @@
 
 .. note::
   Class attribute values are ignored because the "classes_ wrapper"
-  interferes with LaTeX's formatting (spacing/indendation) of text following
+  interferes with LaTeX's formatting (spacing/indentation) of text following
   a section heading. Consider using a `topic element`_ or a container_.
 
 __ ../ref/rst/directives.html#rubric
@@ -1623,7 +1569,7 @@
 
   \setcounter{secnumdepth}{5}
 
-.. note:: The LaTeX name is 'secnumdepth' (whithout 't').
+.. note:: The LaTeX name is 'secnumdepth' (without 't').
 
 .. _sectnum directive: ../ref/rst/directives.html#sectnum
 .. _sectnum_xform: config.html#sectnum-xform
@@ -1653,7 +1599,7 @@
     \marginpar cannot be used, e.g., inside floats, footnotes, or in frames
     made with the framed package (see marginnote_).
 
-__ http://docutils.sf.net/docutils/docs/ref/rst/directives.html#sidebar
+__ https://docutils.sourceforge.io/docutils/docs/ref/rst/directives.html#sidebar
 
 size of a pixel
 ---------------
@@ -1677,61 +1623,57 @@
 
 .. # The `CSS length unit ``px```_ defaults to 1/96 inch.
 
-__ http://tex.stackexchange.com/questions/41370/
+__ https://tex.stackexchange.com/questions/41370/
    what-are-the-possible-dimensions-sizes-units-latex-understands
-.. _CSS length unit ``px``: http://www.w3.org/TR/css-values-3/#px
-.. _reference pixel: http://www.w3.org/TR/css-values-3/#reference-pixel
+.. _CSS length unit ``px``: https://www.w3.org/TR/css-values-3/#px
+.. _reference pixel: https://www.w3.org/TR/css-values-3/#reference-pixel
 
-table
------
+table style
+------------
 
-A pre-configured table style can be globally selected via the table-style_
+A pre-configured *table style* can be globally selected via the table_style_
 setting or set for individual tables via a `class directive`_ or the class
 option of the `table directive`_.
 
-.. _table-style: config.html#table-style-latex-writers
-.. _table directive: ../ref/rst/directives.html#table
+Supported values:
 
-topic element
--------------
+standard
+  Borders around all cells.
 
-A topic_ is like a block quote with a title, or a self-contained section
-with no subsections. Topics and rubrics can be used at places where a
-`section title`_ is not allowed (e.g. inside a directive).
+booktabs
+  A line above and below the table and one after the head.
 
-Example:
-  Use a standard paragraph for a topic::
+borderless
+  No borders around table cells.
 
-    \newcommand{\DUCLASStopic}{%
-      \renewenvironment{quote}{}{}%
-    }
+colwidths-auto
+  Column width determination by LaTeX.
+  Overridden by the `table directive`_'s "widths" option.
 
-.. _topic: ../ref/rst/directives.html#topic
-.. _section title: ../ref/rst/restructuredtext.html#sections
+  .. warning::
 
+    ``colwidths-auto`` is only suited for tables with simple cell content.
 
-titles
-------
+    LaTeX puts the content of auto-sized columns on one line (merging
+    paragraphs) and may fail with complex content.
 
-The titles of admonitions_, sidebar_, and `topic element`_ are defined with
-the ``\DUtitle`` command that also takes a "class" argument.
+.. eventually in future
 
-Example 1:
-  a centered and somewhat larger title for topcis::
+   align-left, align-center, align-right
+     Align tables.
 
-     \newcommand*{\DUtitletopic}1{\subsection*{\centering #1}
+By default, *column widths* are computed from the source column widths.
+The `legacy_column_widths`_ setting selects the conversion algorithm.
+Custom column widths can be set with the "widths" option of the `table
+directive`_.
 
-Example 2:
-  a right-pointing hand as title for the "attention" directive::
-
-    \usepackage{pifont}
-    \newcommand{\DUtitleattention}1{\ding{43}}
-
-  The title argument is "swallowed" by the command.
-  To have both, hand and title use::
+See also the section on problems with tables_ below.
 
-    \usepackage{pifont}
-    \newcommand{\DUtitleattention}1{\ding{43} #1}
+.. _new_column_widths:
+.. _legacy_column_widths: config.html#legacy-column-widths
+.. _table_style: config.html#table-style-latex-writers
+.. _"widths" option:
+.. _table directive: ../ref/rst/directives.html#table
 
 
 table of contents
@@ -1746,7 +1688,7 @@
 
 * The ToC is generated by LaTeX (via the ``\tableofcontents`` command).
 
-  The layout depends on the choosen document class and can be configured in
+  The layout depends on the chosen document class and can be configured in
   a custom `style sheet`_ (see e.g. the `KOMA-Script Guide`_ for the
   `KOMA-script`_ classes).
 
@@ -1769,10 +1711,9 @@
 
 .. _use-latex-toc: config.html#use-latex-toc
 .. _contents directive: ../ref/rst/directives.html#contents
-.. _minitoc:
-   http://ctan.org/pkg/minitoc
+.. _minitoc: https://ctan.org/pkg/minitoc
 .. _minitoc documentation:
-   http://mirrors.ctan.org/macros/latex/contrib/minitoc/minitoc.pdf
+   https://mirrors.ctan.org/macros/latex/contrib/minitoc/minitoc.pdf
 
 
 title reference role
@@ -1791,12 +1732,40 @@
 
     \newcommand{\DUroletitlereference}1{\texttt{\textbf{#1}}}
 
-.. _title reference:
-   ../ref/rst/roles.html#title-reference
+.. _title reference: ../ref/rst/roles.html#title-reference
 .. _default role:
    ../ref/rst/directives.html#setting-the-default-interpreted-text-role
-.. _interpreted text:
-   ../ref/rst/restructuredtext.html#interpreted-text
+.. _interpreted text: ../ref/rst/restructuredtext.html#interpreted-text
+
+
+titles
+------
+
+The titles of admonitions_, sidebar_, and `topic element`_ use
+the ``\DUtitle`` command.
+
+Example 1:
+  a centered and somewhat larger title for topcis::
+
+     \newcommand*{\DUCLASStopic}{
+       \renewcommand*{\DUtitle}1{\subsection*{\centering #1}
+     }
+
+Example 2:
+  a right-pointing hand as title for the "attention" directive::
+
+    \usepackage{pifont}
+    \newcommand*{\DUCLASSattention}{
+      \renewcommand*{\DUtitle}1{\ding{43}}
+    }
+
+  The title argument is "swallowed" by the command.
+  To have both, hand and title use::
+
+    \usepackage{pifont}
+    \newcommand*{\DUCLASSattention}{
+      \newcommand*{\DUtitle}1{\ding{43} #1}
+    }
 
 
 text encoding
@@ -1809,7 +1778,7 @@
     ``--output-encoding=OUTPUT-ENCODING``
 
 Default:
-  "utf8"
+  "utf-8"
 
 Example:
   Encode the LaTeX source file with the ISO `latin-1` (west european)
@@ -1818,7 +1787,7 @@
     --output-encoding=latin-1
 
 Note:
-  LaTeX comes with two options for UTF-8 support,
+  8-bit LaTeX comes with two options for UTF-8 support,
 
   :utf8:  by the standard `inputenc`_ package with only limited coverage
           (mainly accented characters).
@@ -1827,8 +1796,8 @@
           characters than does "utf8".  It is, however, a non-standard
           extension and no longer developed.
 
-  Currently (in version 0.6), "utf8" is used if the output-encoding is
-  any of "utf_8", "U8", "UTF", or "utf8".
+  Currently, the "latex2e" writer inserts ``\usepackageutf8{inputenc}``
+  into the LaTeX source if it is UTF-8 encoded.
 
 .. with utf8x:
    If LaTeX issues a Warning about unloaded/unknown characters adding ::
@@ -1839,10 +1808,26 @@
 
 .. _LaTeX Unicode: http://www.unruh.de/DniQ/latex/unicode/
 .. _output-encoding: config.html#output-encoding
-.. _inputenc:
-   http://ctan.org/pkg/inputenc
-.. _ucs:
-   http://ctan.org/pkg/unicode
+.. _inputenc: https://ctan.org/pkg/inputenc
+.. _ucs: https://ctan.org/pkg/unicode
+
+
+topic element
+-------------
+
+A topic_ is like a block quote with a title, or a self-contained section
+with no subsections. Topics and rubrics can be used at places where a
+`section title`_ is not allowed (e.g. inside a directive).
+
+Example:
+  Use a standard paragraph for a topic::
+
+    \newcommand{\DUCLASStopic}{%
+      \renewenvironment{quote}{}{}%
+    }
+
+.. _topic: ../ref/rst/directives.html#topic
+.. _section title: ../ref/rst/restructuredtext.html#sections
 
 
 transition element
@@ -1871,8 +1856,7 @@
 
     \newcommand*{\DUtransition}{\vspace{2ex}}
 
-__ http://docutils.sf.net/docutils/docs/ref/rst/restructuredtext.html#transitions
-
+__ https://docutils.sourceforge.io/docutils/docs/ref/rst/restructuredtext.html#transitions
 .. _transition-stars.sty: ../../../sandbox/stylesheets/transition-stars.sty
 
 
@@ -1896,7 +1880,7 @@
 ``````````````````````
 
   What I am looking for when I try Docutils is if the PDF files I can get
-  are of high quality. Unfortunaltely that never is the case.
+  are of high quality. Unfortunately that never is the case.
 
   So am I just stupid or is there a way to get really high quality pdf from
   Docutils?
@@ -1917,7 +1901,7 @@
 maybe far away from the footnote mark (see e.g. `<rst/demo.txt>`_).
 
 To get footnote mark and text at the same page, keep footnote mark and
-footnote text close together!
+footnote text close together.
 
 
 non-breaking hyperlinks
@@ -1945,9 +1929,7 @@
 
 See also the `Link text doesn’t break at end line`_ LaTeX FAQ entry.
 
-.. _breakurl:
-   http://ctan.org/pkg/breakurl
-
+.. _breakurl: https://ctan.org/pkg/breakurl
 .. _Link text doesn’t break at end line:
    http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breaklinks
 
@@ -1978,7 +1960,8 @@
 Images__ are included in LaTeX with the help of the `graphicx` package. The
 supported file formats depend on the used driver:
 
-* pdflatex_ and xelatex_ work with PNG, JPG, or PDF, but **not EPS**.
+* pdflatex_, lualatex, and xelatex_ work with PNG, JPG, or PDF,
+  but **not EPS**.
 * Standard latex_ can include **only EPS** graphics, no other format.
 * latex + dvipdfmx works with EPS and JPG (add 'dvipdfmx' to the
   documentoptions_ or graphicx-option_ setting
@@ -1999,12 +1982,11 @@
 
 __ ../ref/rst/directives.html#images
 .. _grfguide.pdf:
-   http://mirrors.ctan.org/macros/latex/required/graphics/grfguide.pdf
-.. _grffile: http://ctan.org/pkg/grffile
+   https://mirrors.ctan.org/macros/latex/required/graphics/grfguide.pdf
+.. _grffile: https://ctan.org/pkg/grffile
 .. _graphicx-option: config.html#graphicx-option
 
 
-
 Why are my images too big?
 ``````````````````````````
 
@@ -2017,7 +1999,7 @@
   pixel on a device with a pixel density of 96 DPI and a distance from the
   reader of an arm's length.
 
-  -- http://www.w3.org/TR/CSS2/syndata.html#length-units
+  -- https://www.w3.org/TR/CSS2/syndata.html#length-units
 
 This is why pixmap images without size specification or objects with a size
 specified in ``px`` tend to come too large in the PDF.
@@ -2026,6 +2008,7 @@
   Specify the image size in fixed units (``pt``, ``cm``, ``in``) or
   configure the `size of a pixel`_ (length unit px).
 
+
 Error ``illegal unit px``
 `````````````````````````
 
@@ -2040,6 +2023,7 @@
 specification. HTML/CSS will default to "px" while the `latexe2` writer
 will add the fallback unit "bp".
 
+
 Error ``Symbol \textcurrency not provided`` ...
 ```````````````````````````````````````````````
 
@@ -2058,22 +2042,38 @@
 
 to the document options or use a different font package.
 
+
+Warning: language … not supported
+`````````````````````````````````
+
+The "latex" writer uses the LaTeX package Babel_ and the "xetex" writer
+uses Polyglossia_ for language_ support (hyphenation rules, auto-text
+localisations and typographic rules). Polyglossia_ supports more
+languages, so switching to the "xetex_" writer may help.
+
+For short quotes or if language support is provided by the user via other
+`LaTeX document classes and packages`_, the warning can be ignored.
+
+.. _Babel: https://ctan.org/pkg/babel
+.. _Polyglossia: https://ctan.org/pkg/polyglossia
+
+
 Search and text extraction
 ``````````````````````````
 
-Search for text that contains characters outside the ASCII range (e.g.
-umlauts) might fail.  See font_ and `font encoding`_ (as well as
-`Searching PDF files`_ for background information).
+Search for text that contains characters outside the ASCII range might
+fail.  See font_ and `font encoding`_ (as well as `Searching PDF files`_
+for background information).
 
 It may help to load the `cmap` package (via `style sheets`_ or the custom
 `LaTeX preamble`_ (see also `Proper use of cmap and mmmap`_).
 
 .. _Searching PDF files:
    http://www.tex.ac.uk/cgi-bin/texfaq2html?label=srchpdf
-
 .. _Proper use of cmap and mmmap:
    https://tex.stackexchange.com/questions/64409/proper-use-of-cmap-and-mmap
 
+
 Unicode box drawing and block characters
 ````````````````````````````````````````
 
@@ -2089,11 +2089,10 @@
 Unfortunately, this defines only a subset of the characters
 (see pmboxdraw.pdf_ for a list).
 
-.. _pmboxdraw:
-   http://ctan.org/pkg/pmboxdraw
-
+.. _pmboxdraw: https://ctan.org/pkg/pmboxdraw
 .. _pmboxdraw.pdf:
-   http://mirrors.ctan.org/macros/latex/contrib/pmboxdraw/pmboxdraw.pdf
+   https://mirrors.ctan.org/macros/latex/contrib/pmboxdraw/pmboxdraw.pdf
+
 
 Bugs and open issues
 --------------------
@@ -2105,8 +2104,7 @@
 
 .. _Docutils TODO list: ../dev/todo.html#latex-writer
 .. _bugs: ../../BUGS.html
-.. _SourceForge Bug Tracker:
-   http://sf.net/tracker/?group_id=38414&atid=422030
+.. _SourceForge Bug Tracker: https://sourceforge.net/p/docutils/bugs/
 
 
 Footnotes and citations
@@ -2120,8 +2118,7 @@
 page foot.
 
 Workaround:
-  Select footnote and citation handling with the docutils-footnotes_ and
-  use-latex-citations_ options.
+  Select citation handling with the use_latex_citations_ option.
 
 If ``use-latex-citations`` is used, a bibliography is inserted right at
 the end of the document. *This should be customizable*.
@@ -2131,34 +2128,20 @@
 group, i.e. ``cite1_ cite2_`` results in ``\cite{cite1,cite2}``.
 The appearance in the output can be configured in a `style sheet`_.
 
-.. _docutils-footnotes: config.html#docutils-footnotes
-.. _use-latex-citations: config.html#use-latex-citations
+.. _use_latex_citations: config.html#use-latex-citations
 
 
 Tables
 ``````
 
-* reST-documents line length is assumed to be 80 characters. The
-  *tablewidth* is set relative to this value. If someone produces documents
-  with line length of 132 this will lead to suboptimal results.
+* Too wide tables (cf. `bug #422`_):
 
-  You may use the `:width:` option to manually set the table column widths.
-
-* Table: multicol cells are always left aligned.
+  Try the new_column_widths_ algorithm or use the `"widths" option`_ to
+  manually set the table column widths.
 
 * Table cells with both multirow and multicolumn are currently not possible.
 
-* literal-blocks in table cells:
-
-  - If verbatim or flushleft is used one gets vertical space above and below.
-  - This is bad for the topmost paragraph in a cell, therefore the writer
-    uses raggedright.
-  - Ragged right fails on followup paragraphs as the vertical space would be
-    missing.
-
-* ``--table-style=booktabs``, ``..class:: booktab``: `booktabs` version
-  1.00 does not work with `longtable`. This is solved in newer versions
-  (current is 2005/04/14 v1.61803).
+.. _bug #422: https://sourceforge.net/p/docutils/bugs/422/
 
 
 Figures
@@ -2171,8 +2154,7 @@
 * Wrapping text around figures is currently not supported. (Requires the
   `wrapfig`_ package.)
 
-.. _wrapfig:
-   http://ctan.org/pkg/wrapfig
+.. _wrapfig: https://ctan.org/pkg/wrapfig
 
 
 Miscellaneous

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/links.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/links.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 =====================
  Docutils_ Link List
 =====================
 
 :Author: Lea Wiemann, the Docutils team
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8644 $
-:Date: $Date: 2021-03-26 14:51:36 +0100 (Fr, 26. Mär 2021) $
+:Revision: $Revision: 9107 $
+:Date: $Date: 2022-07-06 15:59:57 +0200 (Mi, 06. Jul 2022) $
 :Copyright: This document has been placed in the public domain.
 
 .. title:: Docutils Links
@@ -20,7 +22,7 @@
 The most current version of this link list can always be found at
 https://docutils.sourceforge.io/docs/user/links.html.
 
-.. _Docutils: http://docutils.sourceforge.io/
+.. _Docutils: https://docutils.sourceforge.io/
 .. _Docutils Sandbox: https://docutils.sourceforge.io/sandbox/README.html
 
 
@@ -29,29 +31,33 @@
 
 Advanced text editors with reStructuredText support, IDEs, and docutils GUIs:
 
-* Emacs `rst mode <http://docutils.sf.net/tools/editors/emacs>`__.
+* Emacs `rst mode <https://docutils.sourceforge.io/tools/editors/emacs>`__.
 
-* `Vim <http://www.vim.org/index.php>`__:
+* `Vim <https://www.vim.org/index.php>`__:
 
   - `reStructuredText syntax highlighting mode
-    <http://www.vim.org/scripts/script.php?script_id=973>`__,
+    <https://www.vim.org/scripts/script.php?script_id=973>`__,
 
-  - `VST <http://www.vim.org/scripts/script.php?script_id=1334>`__ (Vim
+  - `VST <https://www.vim.org/scripts/script.php?script_id=1334>`__ (Vim
     reStructuredText) plugin for Vim7 with folding.
 
-  - `VOoM <http://www.vim.org/scripts/script.php?script_id=2657>`__
+  - `VOoM <https://www.vim.org/scripts/script.php?script_id=2657>`__
     plugin for Vim that emulates two-pane outliner with
     support for reStructuredText (since version 4.0b2).
 
   - `Riv: Take notes in rst <https://github.com/Rykka/riv.vim>`__ Vim
     plugin to take notes in reStructured text.
 
-* `JED <http://www.jedsoft.org/jed/>`__ programmers editor with
-  `rst mode <http://jedmodes.sf.net/mode/rst/>`__
+* `reStructuredText Language Support for Visual Studio Code`__
+
+  __ https://github.com/vscode-restructuredtext/vscode-restructuredtext
 
 * `reStructuredText editor plug-in for Eclipse`__
 
-  __ http://resteditor.sf.net/
+  __ http://resteditor.sourceforge.net/
+
+* `JED <https://www.jedsoft.org/jed/>`__ programmers editor with
+  `rst mode <httpss://jedmodes.sourceforge.io/mode/rst/>`__
 
 * Gnome's gedit offers syntax highlighting and a reST preview pane.
 
@@ -61,22 +67,27 @@
   .. _bittner @ github:  https://github.com/bittner/gedit-reST-plugin
   __ https://wiki.gnome.org/Apps/Gedit/ThirdPartyPlugins-v3.8
 
+
 * Gunnar Schwant's DocFactory_ is a wxPython GUI application for
   Docutils.
-  
+
   .. _DocFactory: https://docutils.sourceforge.io/sandbox/gschwant/docfactory/doc/
 
 * ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X.
 
   .. _ReSTedit: https://svn.red-bean.com/restedit/trunk/README.html
 
+* `ReText <https://pypi.org/project/ReText/>`_ is a simple but powerful
+  editor for Markdown and reStructuredText markup languages.
+  It is written in Python using PyQt libraries.
+
 * Leo_ is an outliner_, written in Python using PyQt. It can be used as IDE
   for literal programming, as a filing cabinet holding any kind of data and
   as `document editor`__ with outlines containing reStructuredText markup.
 
-  .. _Leo: http://leoeditor.com/
-  .. _outliner: http://en.wikipedia.org/wiki/Outliner
-  __ http://leoeditor.com/tutorial-rst3.html
+  .. _Leo: https://leoeditor.com/
+  .. _outliner: https://en.wikipedia.org/wiki/Outliner
+  __ https://leoeditor.com/tutorial-rst3.html
 
 * `NoTex <https://notex.ch>`_ is a browser-based reStructuredText editor
   with syntax highlighting and PDF/HTML export functionality using Sphinx.
@@ -96,7 +107,7 @@
 * `rst2pdf (reportlab)`__ is a tool to go directly from
   reStructuredText to PDF, via ReportLab__. No LaTeX installation
   is required.
-  
+
   __ https://pypi.org/project/rst2pdf/
   __ https://pypi.org/project/reportlab/
 
@@ -104,14 +115,14 @@
   producing LaTeX, compiling the LaTeX file, getting the produced
   output to the destination location and finally deleting all the
   messy temporary files that this process generates.
-  
+
   __ https://docutils.sourceforge.io/sandbox/blais/rst2pdf/
 
 * `rst2pdf (rubber)`__ is a front end for the generation of PDF
   documents from a reStructuredText source via LaTeX in one step
   cleaning up intermediate files. It uses the rubber__ Python wrapper
   for LaTeX and friends.
-  
+
   __ https://docutils.sourceforge.io/sandbox/rst2pdf/README.html
   __ https://launchpad.net/rubber
 
@@ -122,7 +133,7 @@
 * RinohType_ is a pure Python PDF Writer based on a document template and a
   style sheet (beta).
 
-  .. _RinohType: http://pypi.python.org/pypi/RinohType/0.2.1
+  .. _RinohType: https://pypi.python.org/pypi/RinohType
 
 website generators and HTML variants
 ````````````````````````````````````
@@ -133,33 +144,32 @@
 
   It can generate complete web sites (interlinked and indexed HTML pages),
   ePub, LaTeX, and others from a set of rST source files.
-  
+
   .. _Sphinx: https://www.sphinx-doc.org
   __ https://www.sphinx-doc.org/en/master/examples.html
 
 * The Nikola_ static site generator, uses reStructuredText by
   default.
 
-  .. _nikola:  http://getnikola.com/
+  .. _nikola:  https://getnikola.com/
 
 * Pelican_ is a static site generator (mainly for blogs). Articles/pages can
   be written in reStructuredText or Markdown_ format.
 
-  .. _pelican: http://docs.getpelican.com
+  .. _pelican: https://docs.getpelican.com
 
 * tinkerer_ is a static bloggin framework based on Sphinx_.
 
-  .. _tinkerer: http://tinkerer.me
+  .. _tinkerer: https://pypi.org/project/Tinkerer/
 
 * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation
   bars.
 
   .. _htmlnav: https://docutils.sourceforge.io/sandbox/gschwant/htmlnav/
 
-* rest2web_, by Michael Foord, is a tool for creating web sites with
-  reStructuredText.
-
-  .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
+* rest2web, by Michael Foord, is a tool for creating web sites with
+  reStructuredText. Development stalled, there is a fork at
+  https://gitlab.com/wavexx/rest2web
 
 * `html4trans <https://docutils.sourceforge.io/sandbox/html4trans/>`__
   produces XHTML conforming to the version 1.0 Transitional DTD that
@@ -187,7 +197,7 @@
 
 * Pandoc_ is a document converter that can write Markdown_,
   reStructuredText, HTML, LaTeX, RTF, DocBook XML, and S5.
-  
+
   .. _Pandoc: https://pandoc.org/
 
 * restxsl_ by Michael Alyn Miller, lets you transform reStructuredText
@@ -198,7 +208,7 @@
 * An `XSLT script`__ by Ladislav Lhotka enables reStructuredText annotations
   to be included in RELAG NG XML schemas.
 
-  __ http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
+  __ https://www.cesnet.cz/doc/techzpravy/2006/rngrest/
 
 * `DocBook Writer`_ by Oliver Rutherfurd.
 
@@ -208,7 +218,7 @@
   extracts information from reStructuredText documents and stores it
   in a database.  Python knowledge is required to write extractor
   functions and to retrieve the data from the database again.
-  
+
   .. _Nabu: https://github.com/blais/nabu
 
 * The `pickle writer`_ by Martin Blais pickles the document tree to a binary
@@ -225,7 +235,7 @@
 
 * For `confluence CMS`_ see https://github.com/netresearch/rst2confluence.
 
-  .. _confluence CMS: http://www.atlassian.com/software/confluence
+  .. _confluence CMS: https://www.atlassian.com/software/confluence
 
 * Deploying into wikis might be aided by deploy-rst_.
 
@@ -238,25 +248,25 @@
 Convert other formats to reStructuredText:
 
 * recommonmark_ is a Markdown_ (CommonMark_) parser for
-  docutils originally created by Luca Barbato. 
-  
-  Docutils "markdown" parser (new in Docutils 0.17) is a wrapper 
+  docutils originally created by Luca Barbato.
+
+  Docutils "markdown" parser (new in Docutils 0.17) is a wrapper
   around recommonmark.
-  
+
   .. _recommonmark: https://github.com/rtfd/recommonmark
-  .. _Markdown: http://daringfireball.net/projects/markdown/syntax>
-  .. _CommonMark: http://commonmark.org/
+  .. _Markdown: https://daringfireball.net/projects/markdown/syntax
+  .. _CommonMark: https://commonmark.org/
 
 
 * sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
-  files to reStructuredText.
+  files to reStructuredText. (link down)
 
-  .. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
+  .. _sxw2rest: https://twb.ath.cx/~twb/darcs/sxw2rest/
 
 * xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
   dumps of the document tree (e.g. created with rst2xml.py) back to
   reStructuredText.
-  
+
   .. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
 
 * xhtml2rest_, written by Antonios Christofides, is a simple utility
@@ -270,7 +280,7 @@
   .. _DashTable: https://github.com/gustavklopp/DashTable
 
 * Sphinx_ includes a `LaTeX to Rst converter
-  <http://svn.python.org/projects/doctools/converter/>`__ in its source code
+  <https://svn.python.org/projects/doctools/converter/>`__ in its source code
   (trimmed to importing the old Python docs).
 
 * Pandoc_ can read Markdown_ and (subsets of) HTML, and LaTeX and
@@ -282,7 +292,7 @@
 
   .. _PySource: https://docutils.sourceforge.io/sandbox/tibs/pysource/
   .. _pysource_reader: https://docutils.sourceforge.io/sandbox/davidg/pysource_reader/
-  .. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
+  .. _Python Source Reader: https://docutils.sourceforge.io/docs/dev/pysource.html
 
 
 Extensions
@@ -326,14 +336,30 @@
 
 * For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.
 
-* `Project Gutenberg`_ uses a customized version of Docutils with it's own
-  xetex- and nroff-writer and epub generator.
+* `Project Gutenberg`_ uses  Docutils for its "ebookmaker_"
+  xetex, nroff, and epub generator (with some `extensions to rST`__).
+
+  __ http://pgrst.pglaf.org/publish/181/181-h.html
+
+
+* Text-Restructured_ at CPAN is a set of modules to parse
+  reStructuredText documents and output them in various formats written
+  in Perl_.
+  Up to January 2021, the sources were stored in the Docutils repository_.
+  After long inactivity (the last commit was r6498__
+  2010-12-08), ``trunk/prest/`` was moved to the attic.
+
+  __ https://sourceforge.net/p/docutils/code/6498/
 
 .. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html
     #are-there-any-wikis-that-use-restructuredtext-syntax
-.. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html
+.. _FAQ entry about Blogs: https://docutils.sourceforge.io/FAQ.html
     #are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
 .. _Project Gutenberg: http://www.gutenberg.org
+.. _ebookmaker: https://pypi.org/project/ebookmaker/
+.. _Perl: https://www.perl.org
+.. _Text-Restructured: https://metacpan.org/dist/Text-Restructured
+.. _repository: ../dev/repository.html
 
 
 Tools
@@ -352,32 +378,32 @@
   rerender it. This is very convenient for previewing a document while
   you're editing it.
 
-  .. _restview: http://mg.pov.lt/restview/
+  .. _restview: https://mg.pov.lt/restview/
 
 
 Development
 ```````````
 
 * Sphinx_ extends the ReStructuredText syntax to better support the
-  documentation of Software (and other) *projects* (but other documents
+  documentation of Software projects (but other documents
   can be written with it too).
 
-  Since version 2.6, the `Python documentation`_ is based on
-  reStructuredText and Sphinx.
-  
-  .. _Python documentation: http://docs.python.org/
+* `Sphinx Extensions`_ allow automatic testing of code snippets,
+  inclusion of docstrings from Python modules (API docs), and more.
 
 * Trac_, a project management and bug/issue tracking system, supports
   `using reStructuredText
-  <http://trac.edgewall.org/wiki/WikiRestructuredText>`__ as an
+  <https://trac.edgewall.org/wiki/WikiRestructuredText>`__ as an
   alternative to wiki markup.
 
-  .. _Trac: http://trac.edgewall.org/
 
 * PyLit_ provides a bidirectional text <--> code converter for *literate
   programming with reStructuredText*.
 
-  .. _PyLit: http://repo.or.cz/pylit.git
+.. _Sphinx extensions: https://www.sphinx-doc.org/en/master/usage/extensions/
+.. _Python documentation: https://docs.python.org/
+.. _Trac: https://trac.edgewall.org/
+.. _PyLit: https://codeberg.org/milde/pylit
 
 
 CMS Systems
@@ -388,8 +414,8 @@
 * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope_"
   application that is complete and ready to install.
 
-.. _Plone: http://plone.org/
-.. _Zope: http://www.zope.org/
+.. _Plone: https://plone.org/
+.. _Zope: https://www.zope.dev/
 .. _ZReST: https://docutils.sourceforge.io/sandbox/richard/ZReST/
 
 
@@ -420,7 +446,7 @@
 
 * InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses
   reStructuredText for markup, although it renders only a subset of rst.
-  
+
   .. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide
   .. _Inkscape: http://inkscape.org/
 
@@ -430,4 +456,3 @@
   .. _rst2outline: https://docutils.sourceforge.io/sandbox/rst2outline/
 
 * Pandoc_ can also be used to produce slides
-

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/mailing-lists.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/mailing-lists.txt Changed

@@ -1,11 +1,13 @@
+.. include:: ../header.txt
+
 =========================
  Docutils_ Mailing Lists
 =========================
 
 :Author: Lea Wiemann
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8111 $
-:Date: $Date: 2017-06-10 22:35:01 +0200 (Sa, 10. Jun 2017) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :Copyright: This document has been placed in the public domain.
 
 
@@ -50,13 +52,6 @@
 
   __ `docutils-users mailing list`_
 
-.. * Using Gmane's `web interface`__.  To post a message, click "post" or
-  "followup" in the drop-down menu on the right.  (Gmane also has a
-  complete **archive** of the mailing list; use the search form at the
-  top of this page to search it.)
-
-  __ http://news.gmane.org/gmane.text.docutils.user
-
 * Use a newsreader with Gmane's `NNTP interface`__
   (gmane.text.docutils.user on news.gmane.org).
 
@@ -70,8 +65,8 @@
   receive copies CCs of any replies) or check for answers in the
   `Docutils-users Archives`_.
 
-The first time you post a message without being subscribed (also when
-posting via Gmane), you will receive an automatic response with the subject
+The first time you post a message without being subscribed
+you will receive an automatic response with the subject
 "Your message to Docutils-users awaits moderator approval"; this is done to
 prevent spam to the mailing lists.  Your message will usually be approved
 within a few hours.  To avoid duplicates, please do not resend your message
@@ -98,7 +93,7 @@
 
 __ `Docutils-develop mailing list`_
 __ nntp://news.gmane.org/gmane.text.docutils.devel
-__ http://sourceforge.net/mailarchive/forum.php?forum_name=docutils-develop
+__ https://sourceforge.net/mailarchive/forum.php?forum_name=docutils-develop
 
 Docutils-checkins
 -----------------
@@ -122,7 +117,7 @@
 
 __ `Docutils-checkins list`_
 __ nntp://news.gmane.org/gmane.text.docutils.cvs
-.. _list options: http://lists.sf.net/lists/options/docutils-checkins
+.. _list options: https://lists.sourceforge.net/lists/options/docutils-checkins
 
 Doc-SIG
 -------
@@ -140,18 +135,18 @@
 
 
 .. _Docutils-users mailing list:
-   http://lists.sourceforge.net/lists/listinfo/docutils-users
+   https://lists.sourceforge.net/lists/listinfo/docutils-users
 .. _Docutils-users Archives:
-   http://sourceforge.net/mailarchive/forum.php?forum_name=docutils-users
+   https://sourceforge.net/mailarchive/forum.php?forum_name=docutils-users
 .. _Docutils-develop mailing list:
-   http://lists.sourceforge.net/lists/listinfo/docutils-develop
+   https://lists.sourceforge.net/lists/listinfo/docutils-develop
 .. _Docutils-develop Archives:
-   http://sourceforge.net/mailarchive/forum.php?forum_name=docutils-develop
+   https://sourceforge.net/mailarchive/forum.php?forum_name=docutils-develop
 .. _Docutils-checkins list:
-   http://lists.sourceforge.net/lists/listinfo/docutils-checkins
+   https://lists.sourceforge.net/lists/listinfo/docutils-checkins
 .. _Doc-SIG:
-   http://mail.python.org/mailman/listinfo/doc-sig
+   https://mail.python.org/mailman/listinfo/doc-sig
 
 .. _Subversion repository: ../dev/repository.html
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/
 .. _FAQ: ../../FAQ.html

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/manpage.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/manpage.txt Changed

@@ -1,14 +1,16 @@
+.. include:: ../header.txt
+
 ==============================
  manpage writer for Docutils_
 ==============================
 
 :Author: Engelbert Gruber
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8631 $
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
+:Revision: $Revision: 9059 $
+:Date: $Date: 2022-05-30 18:54:24 +0200 (Mo, 30. Mai 2022) $
 :Copyright: This document has been placed in the public domain.
 
-This writer explores the posibilities to generate man-pages from
+This writer explores the possibilities 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.
 
@@ -20,10 +22,10 @@
 
 Unix man page belong into a numbered section, 1 is user commands, 8 contains
 administrator commands, the headlines of all manpages are collected into a
-database, queryable with the programm ``apropos``, therefore the headline
+database, queryable with the program ``apropos``, therefore the headline
 should contain a short text describing into which group this command belongs.
 
-These informations are collected from title, subtitle and the docinfo.
+That information is collected from the title, subtitle and docinfo.
 
 Also man pages have a defined set of sections, that are more or less
 mandatory, see References_.
@@ -63,7 +65,7 @@
 
 man pages from section 7, ``man`` and ``man-pages``.
 
-.. LMHT Linux Man Page Howto.
+.. LMHT `Linux Man Page Howto <https://tldp.org/HOWTO/Man-Page/>`__.
 
 Conventions
 '''''''''''
@@ -146,9 +148,11 @@
 * Tables are possible, via the external processor tbl, although one should
   avoid them.
 
-Open issues
-'''''''''''
+TODO - Open issues
+''''''''''''''''''
 
+* How to escape double quotes in macro arguments ?
+* Typeset URLs : ``man 7 man`` on linux says use ``.UR`` and ``.UE``.
 * How to typeset command/manpage names in text.
 * How to write long syntax lines.
 * Line ends around email or web addresses in texts.
@@ -163,4 +167,4 @@
 
 * Input and output encoding are problematic at least.
 
-.. _Docutils: http://docutils.sourceforge.net/
+.. _Docutils: https://docutils.sourceforge.io/

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/odt.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/odt.txt Changed

@@ -1,38 +1,32 @@
+.. include:: ../header.txt
+
 =======================
-Odt Writer for Docutils
+ODT Writer for Docutils
 =======================
 
 :Author: Dave Kuhlman
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8631 $
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
+:Revision: $Revision: 9345 $
+:Date: $Date: 2023-04-13 16:27:23 +0200 (Do, 13. Apr 2023) $
 :Copyright: This document has been placed in the public domain.
 
-:abstract: This document describes the Docutils odtwriter
-    (rst2odt.py).
+:abstract: This document describes the Docutils writer for
+           OpenDocument Text (.odt) documents.
 
 .. sectnum::
 
 .. contents::
 
 
-
 Introduction
 ============
 
-What it does -- ``rst2odt.py`` translates reST
-(reStructuredText) into a Open Document Format ``.odt`` file.  You
-can learn more about the ODF format here:
-
-- `OASIS Open Document Format for Office Applications
-  (OpenDocument) TC`_
+The Docutils front end rst2odt.py_ translates reStructuredText_ into an
+`OpenDocument Text`_ (.odt) file.
+OpenDocument files `can be opened by most modern office software`__.
+It is the native file format for LibreOffice_ Writer.
 
-- `Open Document at Wikipedia`_
-
-You should be able to open documents (.odt files) generated with
-``rst2odt.py`` in ``OpenOffice/oowriter``.
-
-You can learn more about Docutils and reST here: `Docutils`_
+__ https://en.wikipedia.org/wiki/OpenDocument#Software
 
 
 Requirements
@@ -56,7 +50,7 @@
 
 Run it from the command line as follows::
 
-    $ rst2odt.py myinput.txt myoutput.odt
+    $ rst2odt.py myinput.txt > myoutput.odt
 
 To see usage information and to learn about command line options
 that you can use, run the following::
@@ -65,26 +59,30 @@
 
 Examples::
 
-    $ rst2odt.py -s -g python_comments.txt python_comments.odt
+    $ 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
+        --stylesheet=/myconfigs/styles.odt odtwriter.txt > odtwriter.odt
 
 
 Configuration file
 ------------------
 
-The options described below can also be set in a configuration file.
-Use section ``odf_odt writer`` to set options specific to the
+The options described below can also be set in a `configuration file`_.
+Use section `odf_odt writer`_ to set options specific to the
 ``odtwriter``.  For example::
 
     odf_odt writer
     stylesheet: styles1.odt
 
-See the "Docutils Configuration" document for more information on
+See the `Docutils Configuration`_ document for more information on
 Docutils configuration files, including locations which are
 searched.
 
+.. _Docutils Configuration: config.html
+.. _configuration file: config.html#configuration-files
+.. _odf_odt writer: config.html#odf-odt-writer
+
 
 Command line options
 --------------------
@@ -717,8 +715,8 @@
    configuration file obeys the file format supported by the Python
    ConfigParser module:
    `ConfigParser -- Configuration file parser --
-   http://docs.python.org/lib/module-ConfigParser.html
-   <http://docs.python.org/lib/module-ConfigParser.html>`_.
+   https://docs.python.org/3/library/configparser.html
+   <https://docs.python.org/3/library/configparser.html>`_.
 
 2. In the "Formats" section of the configuration file, create one
    option (a name-value pair) for each custom style name that you
@@ -803,8 +801,8 @@
 
 For more on roles see:
 `Custom Interpreted Text Roles --
-http://docutils.sourceforge.net/docs/ref/rst/directives.html#custom-interpreted-text-roles
-<http://docutils.sourceforge.net/docs/ref/rst/directives.html#custom-interpreted-text-roles>`_.
+https://docutils.sourceforge.io/docs/ref/rst/directives.html#custom-interpreted-text-roles
+<https://docutils.sourceforge.io/docs/ref/rst/directives.html#custom-interpreted-text-roles>`_.
 
 **Note:** The ability to base a role on another existing role is
 *not* supported by ``odtwriter``.
@@ -1184,18 +1182,15 @@
 
 
 
-
+.. _rst2odt.py:
+    tools.html#rst2odt-py
+.. _reStructuredText:
+    ../ref/rst/restructuredtext.html
+.. _`OpenDocument Text`:
+    https://en.wikipedia.org/wiki/OpenDocument
+.. _LibreOffice:
+    https://libreoffice.org/
 .. _`Pygments`:
-    http://pygments.pocoo.org/
-
-.. _`Docutils`:
-    http://docutils.sourceforge.net/
-
+    https://pygments.org/
 .. _`Python Imaging Library`:
     https://en.wikipedia.org/wiki/Python_Imaging_Library
-
-.. _`Open Document at Wikipedia`:
-    http://en.wikipedia.org/wiki/OpenDocument
-
-.. _`OASIS Open Document Format for Office Applications (OpenDocument) TC`:
-    http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/cheatsheet.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/cheatsheet.txt Changed

@@ -1,10 +1,10 @@
 =====================================================
  The reStructuredText_ Cheat Sheet: Syntax Reminders
 =====================================================
-:Info: See <http://docutils.sf.net/rst.html> for introductory docs.
+:Info: See <https://docutils.sourceforge.io/rst.html> for introductory docs.
 :Author: David Goodger <goodger@python.org>
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
-:Revision: $Revision: 8631 $
+:Date: $Date: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $
+:Revision: $Revision: 8956 $
 :Description: This is a "docinfo block", or bibliographic field list
 
 .. NOTE:: If you are reading this as HTML, please read
@@ -52,10 +52,10 @@
 Footnote          .. 1 Manually numbered or # auto-numbered
                      (even #labelled) or * auto-symbol
 Citation          .. CIT2002 A citation.
-Hyperlink Target  .. _reStructuredText: http://docutils.sf.net/rst.html
+Hyperlink Target  .. _reStructuredText: https://docutils.sourceforge.io/rst.html
                   .. _indirect target: reStructuredText_
                   .. _internal target:
-Anonymous Target  __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html
+Anonymous Target  __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
 Directive ("::")  .. image:: images/biohazard.png
 Substitution Def  .. |substitution| replace:: like an inline directive
 Comment           .. is anything else
@@ -67,13 +67,13 @@
 =============
 *emphasis*; **strong emphasis**; `interpreted text`; `interpreted text
 with role`:emphasis:; ``inline literal text``; standalone hyperlink,
-http://docutils.sourceforge.net; named reference, reStructuredText_;
+https://docutils.sourceforge.io; named reference, reStructuredText_;
 `anonymous reference`__; footnote reference, 1_; citation reference,
 CIT2002_; |substitution|; _`inline internal target`.
 &#xc;
 Directive Quick Reference
 =========================
-See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info.
+See <https://docutils.sourceforge.io/docs/ref/rst/directives.html> for full info.
 
 ================  ============================================================
 Directive Name    Description (Docutils version added to, in brackets)
@@ -114,7 +114,7 @@
 
 Interpreted Text Role Quick Reference
 =====================================
-See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info.
+See <https://docutils.sourceforge.io/docs/ref/rst/roles.html> for full info.
 
 ================  ============================================================
 Role Name         Description

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/demo.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/demo.txt Changed

@@ -21,9 +21,9 @@
 :Contact: docutils-develop@lists.sourceforge.net
 :Authors: Me; Myself; I
 :organization: humankind
-:date: $Date: 2021-03-09 13:53:57 +0100 (Di, 09. Mär 2021) $
+:date: $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $
 :status: This is a "work in progress"
-:revision: $Revision: 8632 $
+:revision: $Revision: 8995 $
 :version: 1
 :copyright: This document has been placed in the public domain. You
             may do with it as you wish. You may copy, modify,
@@ -88,9 +88,9 @@
 
 Paragraphs contain text and may contain inline markup: *emphasis*,
 **strong emphasis**, ``inline literals``, standalone hyperlinks
-(http://www.python.org), external hyperlinks (Python_), internal
+(https://www.python.org), external hyperlinks (Python_), internal
 cross-references (example_), external hyperlinks with embedded URIs
-(`Python web site <http://www.python.org>`__), footnote references
+(`Python web site <https://www.python.org>`__), footnote references
 (manually numbered 1_, anonymous auto-numbered #_, labeled
 auto-numbered #label_, or symbolic *_), citation references
 (CIT2002_), substitution references (|example|), and _`inline
@@ -370,7 +370,7 @@
 Explicit external targets are interpolated into references such as
 "Python_".
 
-.. _Python: http://www.python.org/
+.. _Python: https://www.python.org
 
 Targets may be indirect and anonymous.  Thus `this phrase`__ may also
 refer to the Targets_ section.
@@ -401,7 +401,7 @@
 
 These are just a sample of the many reStructuredText Directives.  For
 others, please see
-http://docutils.sourceforge.net/docs/ref/rst/directives.html.
+https://docutils.sourceforge.io/docs/ref/rst/directives.html.
 
 Document Parts
 ``````````````
@@ -474,7 +474,7 @@
    :subtitle: Optional Subtitle
 
    This is a sidebar.  It is for text outside the flow of the main
-   text.  
+   text.
 
    .. rubric:: This is a rubric inside a sidebar
 
@@ -509,7 +509,7 @@
        Connecting... OK
        Transmitting data... OK
        Disconnecting... OK
-      
+
    and thus consists of a simple paragraph, a literal block, and
    another simple paragraph.  Nonetheless it is semantically *one*
    paragraph.
@@ -521,7 +521,7 @@
 ````
 
 The `“meta” directive`__ is used to specify metadata to be stored in,
-e.g., HTML META tags or ODT file properties.
+e.g., HTML META__ tags or ODT file properties.
 
 .. meta::
    :keywords: reStructuredText, test, parser

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/images/biohazard-scaling.svg -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/images/biohazard-scaling.svg Changed

@@ -1,95 +1,5 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   sodipodi:docname="biohazard-scaling.svg"
-   inkscape:version="0.47 r22583"
-   sodipodi:version="0.32"
-   id="svg24159"
-   viewBox="0 0 48 48" 
-   width="100%" 
-   height="100%"
-   version="1.0">
-  <title
-     id="title2837">Biohazard</title>
-  <metadata
-     id="metadata7">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title>Biohazard</dc:title>
-        <cc:license
-           rdf:resource="http://creativecommons.org/licenses/publicdomain/" />
-        <dc:description>Standalone biohazard symbol, with no border, background or descriptive text.</dc:description>
-        <dc:creator>
-          <cc:Agent>
-            <dc:title>Silsor</dc:title>
-          </cc:Agent>
-        </dc:creator>
-        <dc:identifier></dc:identifier>
-        <dc:source></dc:source>
-        <dc:relation>http://de.wikipedia.org/wiki/Datei:Biohazard_symbol.svg</dc:relation>
-        <dc:publisher>
-          <cc:Agent>
-            <dc:title>Wikipedia</dc:title>
-          </cc:Agent>
-        </dc:publisher>
-        <dc:contributor>
-          <cc:Agent>
-            <dc:title>Bastique, Andux, MarianSigler, GM</dc:title>
-          </cc:Agent>
-        </dc:contributor>
-      </cc:Work>
-      <cc:License
-         rdf:about="http://creativecommons.org/licenses/publicdomain/">
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#Reproduction" />
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#Distribution" />
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
-      </cc:License>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs5">
-    <inkscape:perspective
-       sodipodi:type="inkscape:persp3d"
-       inkscape:vp_x="0 : 178.13126 : 1"
-       inkscape:vp_y="0 : 1000 : 0"
-       inkscape:vp_z="376.4375 : 178.13126 : 1"
-       inkscape:persp3d-origin="188.21875 : 118.75417 : 1"
-       id="perspective2835" />
-  </defs>
-  <sodipodi:namedview
-     inkscape:current-layer="svg24159"
-     inkscape:window-y="33"
-     inkscape:window-x="0"
-     inkscape:cy="22.455418"
-     inkscape:cx="22.152639"
-     inkscape:zoom="8.9316693"
-     inkscape:window-height="771"
-     inkscape:window-width="993"
-     inkscape:pageshadow="2"
-     inkscape:pageopacity="0.0"
-     borderopacity="1.0"
-     bordercolor="#666666"
-     pagecolor="#ffffff"
-     id="base"
-     showgrid="false"
-     inkscape:window-maximized="0" />
-  <path
-     id="path7214"
-     style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;display:inline"
-     d="m 23.585163,1.377771 c -7.3e-5,1.1e-4 6.2e-5,0.0039 0,0.0039 0.0013,-3.54e-4 0.0026,-0.0032 0.0039,-0.0039 -4.78e-4,0 -0.0034,-2.3e-5 -0.0039,0 z m -0.293287,0.01173 c -0.0027,3.39e-4 -0.0051,0.0032 -0.0078,0.0039 0.01047,-6.47e-4 0.0208,-0.0032 0.0313,-0.0039 -0.0026,3.1e-5 -0.0053,-1.18e-4 -0.0078,0 -0.0057,2.6e-4 -0.01016,-6.94e-4 -0.01564,0 z m 1.4234,0.0078 c 0.02085,0.0016 0.04176,0.0023 0.06257,0.0039 -0.02047,-0.0016 -0.04204,-0.0032 -0.06257,-0.0039 z m 0.06257,0.0039 c 5.265987,0.418547 9.412454,4.8332343 9.412454,10.206258 0,5.470767 -4.303553,9.932781 -9.705743,10.210182 l 0,2.096004 c 1.474852,0.23317 2.604371,1.513993 2.604371,3.054059 0,0.376932 -0.06786,0.737393 -0.191614,1.071465 l 1.916125,1.106653 c 2.96118,-4.473042 8.935485,-5.932586 13.643543,-3.214395 4.696858,2.711739 6.431117,8.594706 4.062951,13.389373 3.25012,-6.325927 0.990037,-14.166586 -5.236079,-17.761246 -1.557783,-0.899383 -3.21756,-1.447302 -4.895883,-1.673666 0.642426,-1.566299 0.997159,-3.281384 0.997159,-5.079678 0,-7.1369497 -5.576639,-12.979536 -12.607284,-13.405009 z m -1.716682,0.0078 c -6.995507,0.462047 -12.536897,6.2854693 -12.536897,13.397187 0,1.7471 0.33392,3.416827 0.942418,4.946709 C 9.8382992,19.991498 8.2240722,20.533989 6.7115792,21.40722 0.52714555,24.977806 -1.7383295,32.735989 1.4168439,39.039434 -0.86121285,34.26773 0.88578585,28.463663 5.5423552,25.775186 10.280179,23.039814 16.295416,24.535893 19.236731,29.07561 l 1.849653,-1.06755 c -0.116245,-0.324958 -0.175968,-0.675422 -0.175968,-1.040177 0,-1.474684 1.033904,-2.7081 2.416653,-3.014963 l 0,-2.138998 c -5.354361,-0.327959 -9.604053,-4.769878 -9.604053,-10.206284 0,-5.3484377 4.106511,-9.745581 9.338141,-10.198436 z m 0.5983,12.857539 c -2.702513,0.06215 -5.1939,0.982199 -7.238239,2.479239 0.163319,0.241678 0.3388,0.475581 0.523995,0.699968 0.185211,0.224379 0.381018,0.43966 0.586572,0.64522 0.205552,0.205552 0.420838,0.401368 0.645233,0.586565 0.164974,0.136169 0.34173,0.258763 0.516174,0.383226 1.509041,-0.990801 3.316157,-1.571993 5.263466,-1.571993 1.947286,-8e-6 3.750506,0.581192 5.259545,1.571993 0.174446,-0.124463 0.351193,-0.247057 0.516176,-0.383226 0.22439,-0.185197 0.439673,-0.381013 0.645219,-0.586565 0.205567,-0.20556 0.401375,-0.420841 0.586578,-0.64522 0.185195,-0.224387 0.360669,-0.45829 0.523998,-0.699968 -2.118228,-1.551143 -4.716051,-2.479239 -7.531516,-2.479239 -0.06599,0 -0.133689,-7.88e-4 -0.199445,0 -0.0321,5.04e-4 -0.06572,-7.33e-4 -0.09775,0 z m -12.31791,11.277867 c -0.284223,2.610003 0.211199,5.323971 1.618924,7.76224 1.407734,2.438252 3.510158,4.228056 5.912592,5.286916 0.127648,-0.262284 0.242394,-0.532967 0.344121,-0.805556 0.101731,-0.272573 0.190676,-0.548209 0.265902,-0.828999 0.07525,-0.280797 0.139504,-0.565564 0.187704,-0.852481 0.03545,-0.210964 0.05374,-0.42411 0.07431,-0.637415 -1.612588,-0.811463 -3.018925,-2.087157 -3.992574,-3.773578 -0.973652,-1.686412 -1.374436,-3.539399 -1.270899,-5.341664 -0.194995,-0.08884 -0.390062,-0.179391 -0.590482,-0.254187 -0.272577,-0.10171 -0.548216,-0.190664 -0.829012,-0.265909 -0.280794,-0.07523 -0.565552,-0.135585 -0.852473,-0.183786 -0.286919,-0.04821 -0.577155,-0.08499 -0.868119,-0.105582 z m 25.316234,0.152498 c -0.290976,0.02064 -0.581196,0.05743 -0.868118,0.105592 -0.286924,0.04821 -0.571694,0.108551 -0.852489,0.183796 -0.28078,0.07523 -0.560331,0.164188 -0.832917,0.265916 -0.200416,0.07475 -0.391568,0.169238 -0.586562,0.258079 0.103529,1.802257 -0.297254,3.655268 -1.270904,5.341672 -0.973644,1.686405 -2.379987,2.958198 -3.992556,3.769663 0.02056,0.213296 0.03885,0.42645 0.07429,0.637406 0.0482,0.286925 0.108544,0.571684 0.183787,0.85249 0.07524,0.280789 0.164195,0.560349 0.265917,0.832913 0.10171,0.272598 0.21648,0.539357 0.344115,0.80165 2.402441,-1.05887 4.504863,-2.844756 5.91259,-5.283018 1.407749,-2.438268 1.907058,-5.156151 1.622843,-7.766155 z m -14.984836,3.300424 -1.861376,1.079286 c 2.393175,4.80097 0.67248,10.702448 -4.035564,13.420654 -4.684876,2.704807 -10.6285418,1.281437 -13.6044538,-3.140087 3.861645,5.950286 11.7584698,7.900842 17.9724108,4.31321 1.505271,-0.869071 2.775062,-1.989431 3.793133,-3.273026 1.038062,1.349323 2.351864,2.521178 3.918266,3.425539 6.220932,3.591652 14.127263,1.63317 17.98415,-4.332768 -2.970401,4.440658 -8.922715,5.877231 -13.616174,3.167461 -4.737818,-2.735388 -6.449511,-8.693465 -3.988659,-13.51059 L 26.29902,29.028617 c -0.565692,0.629844 -1.386768,1.028448 -2.299348,1.028448 -0.927577,0 -1.760299,-0.411791 -2.32672,-1.059736 z" />
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.0" viewBox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
+ <title>Biohazard</title>
+ <path d="m23.585 1.3778c-7.3e-5 1.1e-4 6.2e-5 0.0039 0 0.0039 0.0013-3.54e-4 0.0026-0.0032 0.0039-0.0039-4.78e-4 0-0.0034-2.3e-5 -0.0039 0zm-0.29329 0.01173c-0.0027 3.39e-4 -0.0051 0.0032-0.0078 0.0039 0.01047-6.47e-4 0.0208-0.0032 0.0313-0.0039-0.0026 3.1e-5 -0.0053-1.18e-4 -0.0078 0-0.0057 2.6e-4 -0.01016-6.94e-4 -0.01564 0zm1.4234 0.0078c0.02085 0.0016 0.04176 0.0023 0.06257 0.0039-0.02047-0.0016-0.04204-0.0032-0.06257-0.0039zm0.06257 0.0039c5.266 0.41855 9.4125 4.8332 9.4125 10.206 0 5.4708-4.3036 9.9328-9.7057 10.21v2.096c1.4749 0.23317 2.6044 1.514 2.6044 3.0541 0 0.37693-0.06786 0.73739-0.19161 1.0715l1.9161 1.1067c2.9612-4.473 8.9355-5.9326 13.644-3.2144 4.6969 2.7117 6.4311 8.5947 4.063 13.389 3.2501-6.3259 0.99004-14.167-5.2361-17.761-1.5578-0.89938-3.2176-1.4473-4.8959-1.6737 0.64243-1.5663 0.99716-3.2814 0.99716-5.0797 0-7.1369-5.5766-12.98-12.607-13.405zm-1.7167 0.0078c-6.9955 0.46205-12.537 6.2855-12.537 13.397 0 1.7471 0.33392 3.4168 0.94242 4.9467-1.6284 0.2386-3.2426 0.78109-4.7551 1.6543-6.1844 3.5706-8.4499 11.329-5.2947 17.632-2.2781-4.7717-0.53106-10.576 4.1255-13.264 4.7378-2.7354 10.753-1.2393 13.694 3.3004l1.8497-1.0676c-0.11624-0.32496-0.17597-0.67542-0.17597-1.0402 0-1.4747 1.0339-2.7081 2.4167-3.015v-2.139c-5.3544-0.32796-9.6041-4.7699-9.6041-10.206 0-5.3484 4.1065-9.7456 9.3381-10.198zm0.5983 12.858c-2.7025 0.06215-5.1939 0.9822-7.2382 2.4792 0.16332 0.24168 0.3388 0.47558 0.524 0.69997 0.18521 0.22438 0.38102 0.43966 0.58657 0.64522 0.20555 0.20555 0.42084 0.40137 0.64523 0.58656 0.16497 0.13617 0.34173 0.25876 0.51617 0.38323 1.509-0.9908 3.3162-1.572 5.2635-1.572 1.9473-8e-6 3.7505 0.58119 5.2595 1.572 0.17445-0.12446 0.35119-0.24706 0.51618-0.38323 0.22439-0.1852 0.43967-0.38101 0.64522-0.58656 0.20557-0.20556 0.40138-0.42084 0.58658-0.64522 0.1852-0.22439 0.36067-0.45829 0.524-0.69997-2.1182-1.5511-4.7161-2.4792-7.5315-2.4792-0.06599 0-0.13369-7.88e-4 -0.19944 0-0.0321 5.04e-4 -0.06572-7.33e-4 -0.09775 0zm-12.318 11.278c-0.28422 2.61 0.2112 5.324 1.6189 7.7622 1.4077 2.4383 3.5102 4.2281 5.9126 5.2869 0.12765-0.26228 0.24239-0.53297 0.34412-0.80556 0.10173-0.27257 0.19068-0.54821 0.2659-0.829 0.07525-0.2808 0.1395-0.56556 0.1877-0.85248 0.03545-0.21096 0.05374-0.42411 0.07431-0.63742-1.6126-0.81146-3.0189-2.0872-3.9926-3.7736-0.97365-1.6864-1.3744-3.5394-1.2709-5.3417-0.195-0.08884-0.39006-0.17939-0.59048-0.25419-0.27258-0.10171-0.54822-0.19066-0.82901-0.26591-0.28079-0.07523-0.56555-0.13558-0.85247-0.18379-0.28692-0.04821-0.57716-0.08499-0.86812-0.10558zm25.316 0.1525c-0.29098 0.02064-0.5812 0.05743-0.86812 0.10559-0.28692 0.04821-0.57169 0.10855-0.85249 0.1838-0.28078 0.07523-0.56033 0.16419-0.83292 0.26592-0.20042 0.07475-0.39157 0.16924-0.58656 0.25808 0.10353 1.8023-0.29725 3.6553-1.2709 5.3417-0.97364 1.6864-2.38 2.9582-3.9926 3.7697 0.02056 0.2133 0.03885 0.42645 0.07429 0.63741 0.0482 0.28692 0.10854 0.57168 0.18379 0.85249 0.07524 0.28079 0.1642 0.56035 0.26592 0.83291 0.10171 0.2726 0.21648 0.53936 0.34412 0.80165 2.4024-1.0589 4.5049-2.8448 5.9126-5.283 1.4077-2.4383 1.9071-5.1562 1.6228-7.7662zm-14.985 3.3004-1.8614 1.0793c2.3932 4.801 0.67248 10.702-4.0356 13.421-4.6849 2.7048-10.629 1.2814-13.604-3.1401 3.8616 5.9503 11.758 7.9008 17.972 4.3132 1.5053-0.86907 2.7751-1.9894 3.7931-3.273 1.0381 1.3493 2.3519 2.5212 3.9183 3.4255 6.2209 3.5917 14.127 1.6332 17.984-4.3328-2.9704 4.4407-8.9227 5.8772-13.616 3.1675-4.7378-2.7354-6.4495-8.6935-3.9887-13.511l-1.9357-1.1184c-0.56569 0.62984-1.3868 1.0284-2.2993 1.0284-0.92758 0-1.7603-0.41179-2.3267-1.0597z"/>
 </svg>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/images/biohazard.svg -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/images/biohazard.svg Changed

@@ -1,94 +1,5 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   sodipodi:docname="biohazard.svg"
-   inkscape:version="0.47 r22583"
-   sodipodi:version="0.32"
-   id="svg24159"
-   height="48"
-   width="48"
-   version="1.0">
-  <title
-     id="title2837">Biohazard</title>
-  <metadata
-     id="metadata7">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title>Biohazard</dc:title>
-        <cc:license
-           rdf:resource="http://creativecommons.org/licenses/publicdomain/" />
-        <dc:description>Standalone biohazard symbol, with no border, background or descriptive text.</dc:description>
-        <dc:creator>
-          <cc:Agent>
-            <dc:title>Silsor</dc:title>
-          </cc:Agent>
-        </dc:creator>
-        <dc:identifier></dc:identifier>
-        <dc:source></dc:source>
-        <dc:relation>http://de.wikipedia.org/wiki/Datei:Biohazard_symbol.svg</dc:relation>
-        <dc:publisher>
-          <cc:Agent>
-            <dc:title>Wikipedia</dc:title>
-          </cc:Agent>
-        </dc:publisher>
-        <dc:contributor>
-          <cc:Agent>
-            <dc:title>Bastique, Andux, MarianSigler, GM</dc:title>
-          </cc:Agent>
-        </dc:contributor>
-      </cc:Work>
-      <cc:License
-         rdf:about="http://creativecommons.org/licenses/publicdomain/">
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#Reproduction" />
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#Distribution" />
-        <cc:permits
-           rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
-      </cc:License>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs5">
-    <inkscape:perspective
-       sodipodi:type="inkscape:persp3d"
-       inkscape:vp_x="0 : 178.13126 : 1"
-       inkscape:vp_y="0 : 1000 : 0"
-       inkscape:vp_z="376.4375 : 178.13126 : 1"
-       inkscape:persp3d-origin="188.21875 : 118.75417 : 1"
-       id="perspective2835" />
-  </defs>
-  <sodipodi:namedview
-     inkscape:current-layer="svg24159"
-     inkscape:window-y="33"
-     inkscape:window-x="0"
-     inkscape:cy="22.455418"
-     inkscape:cx="22.152639"
-     inkscape:zoom="8.9316693"
-     inkscape:window-height="771"
-     inkscape:window-width="993"
-     inkscape:pageshadow="2"
-     inkscape:pageopacity="0.0"
-     borderopacity="1.0"
-     bordercolor="#666666"
-     pagecolor="#ffffff"
-     id="base"
-     showgrid="false"
-     inkscape:window-maximized="0" />
-  <path
-     id="path7214"
-     style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;display:inline"
-     d="m 23.585163,1.377771 c -7.3e-5,1.1e-4 6.2e-5,0.0039 0,0.0039 0.0013,-3.54e-4 0.0026,-0.0032 0.0039,-0.0039 -4.78e-4,0 -0.0034,-2.3e-5 -0.0039,0 z m -0.293287,0.01173 c -0.0027,3.39e-4 -0.0051,0.0032 -0.0078,0.0039 0.01047,-6.47e-4 0.0208,-0.0032 0.0313,-0.0039 -0.0026,3.1e-5 -0.0053,-1.18e-4 -0.0078,0 -0.0057,2.6e-4 -0.01016,-6.94e-4 -0.01564,0 z m 1.4234,0.0078 c 0.02085,0.0016 0.04176,0.0023 0.06257,0.0039 -0.02047,-0.0016 -0.04204,-0.0032 -0.06257,-0.0039 z m 0.06257,0.0039 c 5.265987,0.418547 9.412454,4.8332343 9.412454,10.206258 0,5.470767 -4.303553,9.932781 -9.705743,10.210182 l 0,2.096004 c 1.474852,0.23317 2.604371,1.513993 2.604371,3.054059 0,0.376932 -0.06786,0.737393 -0.191614,1.071465 l 1.916125,1.106653 c 2.96118,-4.473042 8.935485,-5.932586 13.643543,-3.214395 4.696858,2.711739 6.431117,8.594706 4.062951,13.389373 3.25012,-6.325927 0.990037,-14.166586 -5.236079,-17.761246 -1.557783,-0.899383 -3.21756,-1.447302 -4.895883,-1.673666 0.642426,-1.566299 0.997159,-3.281384 0.997159,-5.079678 0,-7.1369497 -5.576639,-12.979536 -12.607284,-13.405009 z m -1.716682,0.0078 c -6.995507,0.462047 -12.536897,6.2854693 -12.536897,13.397187 0,1.7471 0.33392,3.416827 0.942418,4.946709 C 9.8382992,19.991498 8.2240722,20.533989 6.7115792,21.40722 0.52714555,24.977806 -1.7383295,32.735989 1.4168439,39.039434 -0.86121285,34.26773 0.88578585,28.463663 5.5423552,25.775186 10.280179,23.039814 16.295416,24.535893 19.236731,29.07561 l 1.849653,-1.06755 c -0.116245,-0.324958 -0.175968,-0.675422 -0.175968,-1.040177 0,-1.474684 1.033904,-2.7081 2.416653,-3.014963 l 0,-2.138998 c -5.354361,-0.327959 -9.604053,-4.769878 -9.604053,-10.206284 0,-5.3484377 4.106511,-9.745581 9.338141,-10.198436 z m 0.5983,12.857539 c -2.702513,0.06215 -5.1939,0.982199 -7.238239,2.479239 0.163319,0.241678 0.3388,0.475581 0.523995,0.699968 0.185211,0.224379 0.381018,0.43966 0.586572,0.64522 0.205552,0.205552 0.420838,0.401368 0.645233,0.586565 0.164974,0.136169 0.34173,0.258763 0.516174,0.383226 1.509041,-0.990801 3.316157,-1.571993 5.263466,-1.571993 1.947286,-8e-6 3.750506,0.581192 5.259545,1.571993 0.174446,-0.124463 0.351193,-0.247057 0.516176,-0.383226 0.22439,-0.185197 0.439673,-0.381013 0.645219,-0.586565 0.205567,-0.20556 0.401375,-0.420841 0.586578,-0.64522 0.185195,-0.224387 0.360669,-0.45829 0.523998,-0.699968 -2.118228,-1.551143 -4.716051,-2.479239 -7.531516,-2.479239 -0.06599,0 -0.133689,-7.88e-4 -0.199445,0 -0.0321,5.04e-4 -0.06572,-7.33e-4 -0.09775,0 z m -12.31791,11.277867 c -0.284223,2.610003 0.211199,5.323971 1.618924,7.76224 1.407734,2.438252 3.510158,4.228056 5.912592,5.286916 0.127648,-0.262284 0.242394,-0.532967 0.344121,-0.805556 0.101731,-0.272573 0.190676,-0.548209 0.265902,-0.828999 0.07525,-0.280797 0.139504,-0.565564 0.187704,-0.852481 0.03545,-0.210964 0.05374,-0.42411 0.07431,-0.637415 -1.612588,-0.811463 -3.018925,-2.087157 -3.992574,-3.773578 -0.973652,-1.686412 -1.374436,-3.539399 -1.270899,-5.341664 -0.194995,-0.08884 -0.390062,-0.179391 -0.590482,-0.254187 -0.272577,-0.10171 -0.548216,-0.190664 -0.829012,-0.265909 -0.280794,-0.07523 -0.565552,-0.135585 -0.852473,-0.183786 -0.286919,-0.04821 -0.577155,-0.08499 -0.868119,-0.105582 z m 25.316234,0.152498 c -0.290976,0.02064 -0.581196,0.05743 -0.868118,0.105592 -0.286924,0.04821 -0.571694,0.108551 -0.852489,0.183796 -0.28078,0.07523 -0.560331,0.164188 -0.832917,0.265916 -0.200416,0.07475 -0.391568,0.169238 -0.586562,0.258079 0.103529,1.802257 -0.297254,3.655268 -1.270904,5.341672 -0.973644,1.686405 -2.379987,2.958198 -3.992556,3.769663 0.02056,0.213296 0.03885,0.42645 0.07429,0.637406 0.0482,0.286925 0.108544,0.571684 0.183787,0.85249 0.07524,0.280789 0.164195,0.560349 0.265917,0.832913 0.10171,0.272598 0.21648,0.539357 0.344115,0.80165 2.402441,-1.05887 4.504863,-2.844756 5.91259,-5.283018 1.407749,-2.438268 1.907058,-5.156151 1.622843,-7.766155 z m -14.984836,3.300424 -1.861376,1.079286 c 2.393175,4.80097 0.67248,10.702448 -4.035564,13.420654 -4.684876,2.704807 -10.6285418,1.281437 -13.6044538,-3.140087 3.861645,5.950286 11.7584698,7.900842 17.9724108,4.31321 1.505271,-0.869071 2.775062,-1.989431 3.793133,-3.273026 1.038062,1.349323 2.351864,2.521178 3.918266,3.425539 6.220932,3.591652 14.127263,1.63317 17.98415,-4.332768 -2.970401,4.440658 -8.922715,5.877231 -13.616174,3.167461 -4.737818,-2.735388 -6.449511,-8.693465 -3.988659,-13.51059 L 26.29902,29.028617 c -0.565692,0.629844 -1.386768,1.028448 -2.299348,1.028448 -0.927577,0 -1.760299,-0.411791 -2.32672,-1.059736 z" />
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.0" width="48" height="48" xmlns="http://www.w3.org/2000/svg">
+ <title>Biohazard</title>
+ <path d="m23.585 1.3778c-7.3e-5 1.1e-4 6.2e-5 0.0039 0 0.0039 0.0013-3.54e-4 0.0026-0.0032 0.0039-0.0039-4.78e-4 0-0.0034-2.3e-5 -0.0039 0zm-0.29329 0.01173c-0.0027 3.39e-4 -0.0051 0.0032-0.0078 0.0039 0.01047-6.47e-4 0.0208-0.0032 0.0313-0.0039-0.0026 3.1e-5 -0.0053-1.18e-4 -0.0078 0-0.0057 2.6e-4 -0.01016-6.94e-4 -0.01564 0zm1.4234 0.0078c0.02085 0.0016 0.04176 0.0023 0.06257 0.0039-0.02047-0.0016-0.04204-0.0032-0.06257-0.0039zm0.06257 0.0039c5.266 0.41855 9.4125 4.8332 9.4125 10.206 0 5.4708-4.3036 9.9328-9.7057 10.21v2.096c1.4749 0.23317 2.6044 1.514 2.6044 3.0541 0 0.37693-0.06786 0.73739-0.19161 1.0715l1.9161 1.1067c2.9612-4.473 8.9355-5.9326 13.644-3.2144 4.6969 2.7117 6.4311 8.5947 4.063 13.389 3.2501-6.3259 0.99004-14.167-5.2361-17.761-1.5578-0.89938-3.2176-1.4473-4.8959-1.6737 0.64243-1.5663 0.99716-3.2814 0.99716-5.0797 0-7.1369-5.5766-12.98-12.607-13.405zm-1.7167 0.0078c-6.9955 0.46205-12.537 6.2855-12.537 13.397 0 1.7471 0.33392 3.4168 0.94242 4.9467-1.6284 0.2386-3.2426 0.78109-4.7551 1.6543-6.1844 3.5706-8.4499 11.329-5.2947 17.632-2.2781-4.7717-0.53106-10.576 4.1255-13.264 4.7378-2.7354 10.753-1.2393 13.694 3.3004l1.8497-1.0676c-0.11624-0.32496-0.17597-0.67542-0.17597-1.0402 0-1.4747 1.0339-2.7081 2.4167-3.015v-2.139c-5.3544-0.32796-9.6041-4.7699-9.6041-10.206 0-5.3484 4.1065-9.7456 9.3381-10.198zm0.5983 12.858c-2.7025 0.06215-5.1939 0.9822-7.2382 2.4792 0.16332 0.24168 0.3388 0.47558 0.524 0.69997 0.18521 0.22438 0.38102 0.43966 0.58657 0.64522 0.20555 0.20555 0.42084 0.40137 0.64523 0.58656 0.16497 0.13617 0.34173 0.25876 0.51617 0.38323 1.509-0.9908 3.3162-1.572 5.2635-1.572 1.9473-8e-6 3.7505 0.58119 5.2595 1.572 0.17445-0.12446 0.35119-0.24706 0.51618-0.38323 0.22439-0.1852 0.43967-0.38101 0.64522-0.58656 0.20557-0.20556 0.40138-0.42084 0.58658-0.64522 0.1852-0.22439 0.36067-0.45829 0.524-0.69997-2.1182-1.5511-4.7161-2.4792-7.5315-2.4792-0.06599 0-0.13369-7.88e-4 -0.19944 0-0.0321 5.04e-4 -0.06572-7.33e-4 -0.09775 0zm-12.318 11.278c-0.28422 2.61 0.2112 5.324 1.6189 7.7622 1.4077 2.4383 3.5102 4.2281 5.9126 5.2869 0.12765-0.26228 0.24239-0.53297 0.34412-0.80556 0.10173-0.27257 0.19068-0.54821 0.2659-0.829 0.07525-0.2808 0.1395-0.56556 0.1877-0.85248 0.03545-0.21096 0.05374-0.42411 0.07431-0.63742-1.6126-0.81146-3.0189-2.0872-3.9926-3.7736-0.97365-1.6864-1.3744-3.5394-1.2709-5.3417-0.195-0.08884-0.39006-0.17939-0.59048-0.25419-0.27258-0.10171-0.54822-0.19066-0.82901-0.26591-0.28079-0.07523-0.56555-0.13558-0.85247-0.18379-0.28692-0.04821-0.57716-0.08499-0.86812-0.10558zm25.316 0.1525c-0.29098 0.02064-0.5812 0.05743-0.86812 0.10559-0.28692 0.04821-0.57169 0.10855-0.85249 0.1838-0.28078 0.07523-0.56033 0.16419-0.83292 0.26592-0.20042 0.07475-0.39157 0.16924-0.58656 0.25808 0.10353 1.8023-0.29725 3.6553-1.2709 5.3417-0.97364 1.6864-2.38 2.9582-3.9926 3.7697 0.02056 0.2133 0.03885 0.42645 0.07429 0.63741 0.0482 0.28692 0.10854 0.57168 0.18379 0.85249 0.07524 0.28079 0.1642 0.56035 0.26592 0.83291 0.10171 0.2726 0.21648 0.53936 0.34412 0.80165 2.4024-1.0589 4.5049-2.8448 5.9126-5.283 1.4077-2.4383 1.9071-5.1562 1.6228-7.7662zm-14.985 3.3004-1.8614 1.0793c2.3932 4.801 0.67248 10.702-4.0356 13.421-4.6849 2.7048-10.629 1.2814-13.604-3.1401 3.8616 5.9503 11.758 7.9008 17.972 4.3132 1.5053-0.86907 2.7751-1.9894 3.7931-3.273 1.0381 1.3493 2.3519 2.5212 3.9183 3.4255 6.2209 3.5917 14.127 1.6332 17.984-4.3328-2.9704 4.4407-8.9227 5.8772-13.616 3.1675-4.7378-2.7354-6.4495-8.6935-3.9887-13.511l-1.9357-1.1184c-0.56569 0.62984-1.3868 1.0284-2.2993 1.0284-0.92758 0-1.7603-0.41179-2.3267-1.0597z"/>
 </svg>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/images/title-scaling.svg -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/images/title-scaling.svg Changed

@@ -1,43 +1,11 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   id="svg2"
-   height="19.933594pt"
-   width="214.26941pt"
-   viewBox="0 0 285.69254 26.578126"
-   version="1.1">
-  <metadata
-     id="metadata8">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs6" />
-  <text
-     style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:34.41720963px;line-height:0%;font-family:TeXGyrePagella;-inkscape-font-specification:'TeXGyrePagella Italic';text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
-     xml:space="preserve"
-     id="text2818"
-     transform="scale(0.95603363,1.0459883)"
-     y="24.939034"
-     x="-0.3865214"><tspan
-       id="tspan2820"
-       y="24.939034"
-       x="-0.3865214"><tspan
-         style="font-family:'Times New Roman';-inkscape-font-specification:'Times New Roman'"
-         id="tspan2985">re</tspan><tspan
-         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:34.41720963px;line-height:100%;font-family:'Courier New';-inkscape-font-specification:'Courier New';text-align:start;writing-mode:lr-tb;text-anchor:start"
-         id="tspan2822">Structured</tspan><tspan
-         style="font-family:'Times New Roman';-inkscape-font-specification:'Times New Roman'"
-         id="tspan2989">Text</tspan></tspan></text>
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="203pt" height="24pt" version="1.1"
+   viewBox="0 0 232 24" xmlns="http://www.w3.org/2000/svg">
+ <text x="-2.25" y="24" fill="#000000"
+   font-family="Times New Roman, Liberation Serif, FreeSerif, serif"
+   font-size="32px" font-style="italic" letter-spacing="0px"
+   stroke-width="1px" word-spacing="0px"><tspan
+     x="-2.25" y="24">re<tspan
+     font-family="Helvetica, Liberation Sans, FreeSans, sans-serif"
+     font-style="normal">Structured</tspan>Text</tspan></text>
 </svg>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/images/title.svg -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/images/title.svg Changed

@@ -1,43 +1,11 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   id="svg2"
-   height="21.262499pt"
-   width="228.4207pt"
-   version="1.1">
-  <metadata
-     id="metadata8">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs6" />
-  <text
-     style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:36.711689px;line-height:0%;font-family:TeXGyrePagella;-inkscape-font-specification:'TeXGyrePagella Italic';text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1.0666666"
-     xml:space="preserve"
-     id="text2818"
-     transform="scale(0.95603363,1.0459883)"
-     y="26.601633"
-     x="-0.41228947"><tspan
-       style="stroke-width:1.0666666"
-       id="tspan2820"
-       y="26.601633"
-       x="-0.41228947"><tspan
-         style="font-family:'Times New Roman';-inkscape-font-specification:'Times New Roman';stroke-width:1.0666666"
-         id="tspan2985">re</tspan><tspan
-         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:36.711689px;line-height:100%;font-family:'Courier New';-inkscape-font-specification:'Courier New';text-align:start;writing-mode:lr-tb;text-anchor:start;stroke-width:1.0666666"
-         id="tspan2822">Structured</tspan><tspan
-         style="font-family:'Times New Roman';-inkscape-font-specification:'Times New Roman';stroke-width:1.0666666"
-         id="tspan2989">Text</tspan></tspan></text>
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="203pt" height="24pt" version="1.1"
+   xmlns="http://www.w3.org/2000/svg">
+ <text x="-2.25" y="24" fill="#000000"
+   font-family="Times New Roman, Liberation Serif, FreeSerif, serif"
+   font-size="32px" font-style="italic" letter-spacing="0px"
+   stroke-width="1px" word-spacing="0px"><tspan
+     x="-2.25" y="24">re<tspan
+     font-family="Helvetica, Liberation Sans, FreeSans, sans-serif"
+     font-style="normal">Structured</tspan>Text</tspan></text>
 </svg>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/quickref.html -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/quickref.html Changed

@@ -20,10 +20,10 @@
     
     
 
-    <p align="right"><em><a href="http://docutils.sourceforge.net/docs/user/rst/quickref.html"
-    >http://docutils.sourceforge.net/docs/user/rst/quickref.html</a></em>
+    <p align="right"><em><a href="https://docutils.sourceforge.io/docs/user/rst/quickref.html"
+    >https://docutils.sourceforge.io/docs/user/rst/quickref.html</a></em>
     <br><em>Being a cheat-sheet for reStructuredText</em>
-    <br><em>Updated $Date: 2019-09-30 13:36:39 +0200 (Mo, 30. Sep 2019) $</em>
+    <br><em>Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $</em>
 
     <blockquote>
       <p>Copyright: This document has been placed in the public domain.
@@ -31,7 +31,7 @@
 
 
     <p>The full details of the markup may be found on the
-      <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
+      <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a>
       page. This document is just intended as a reminder.
 
     <p>Links that look like "(<a href="#details">details</a>)" point
@@ -39,7 +39,7 @@
       href="../../ref/rst/restructuredtext.html">reStructuredText
       specification</a> document.  These are relative links; if they
       don't work, please use the <a
-      href="http://docutils.sourceforge.net/docs/user/rst/quickref.html"
+      href="https://docutils.sourceforge.io/docs/user/rst/quickref.html"
       >master "Quick reStructuredText"</a> document.
 
     <h2><a name="contents">Contents</a></h2>
@@ -143,7 +143,7 @@
     <tr valign="top">
       <td nowrap><samp>_`inline internal target`</samp>
       <td><a name="inline-internal-target">inline internal target</a>
-      <td>A crossreference target within text.
+      <td>A cross-reference target within text.
       See <a href="#hyperlink-targets">Hyperlink Targets</a>.
 
     <tr valign="top">
@@ -165,8 +165,8 @@
       <td>See <a href="#citations">Citations</a>.
 
     <tr valign="top">
-      <td nowrap><samp>http://docutils.sf.net/</samp>
-      <td><a href="http://docutils.sf.net/">http://docutils.sf.net/</a>
+      <td nowrap><samp>https://docutils.sourceforge.io/</samp>
+      <td><a href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a>
       <td>A standalone hyperlink.
 
     </table>
@@ -192,7 +192,7 @@
       <li>The end-string must be immediately preceded by non-whitespace.
       <li>The end-string must end a text block (end of document or
     followed by a blank line) or be immediately followed by whitespace
-    or any of&nbsp;<samp>' " . , : ; ! ? - )  } / \</samp> 
+    or any of&nbsp;<samp>' " . , : ; ! ? - )  } / \</samp>
     or&nbsp;<samp>&gt;</samp>.
       <li>If a start-string is immediately preceded by one of&nbsp;
     <samp>' " (  {</samp> or&nbsp;<samp>&lt;</samp>, it must not be
@@ -731,7 +731,7 @@
     </table>
 
     <p>"The <a
-    href="http://www.python.org/doc/current/lib/module-doctest.html">doctest</a>
+    href="https://docs.python.org/3/library/doctest.html">doctest</a>
     module searches a module's docstrings for text that looks like an
     interactive Python session, then executes all such sessions to
     verify they still work exactly as shown." (From the doctest docs.)
@@ -1069,12 +1069,12 @@
       <td rowspan="2">
         <samp>External&nbsp;hyperlinks,&nbsp;like&nbsp;Python_.</samp>
 
-        <p><samp>..&nbsp;_Python:&nbsp;http://www.python.org/</samp>
+        <p><samp>..&nbsp;_Python:&nbsp;https://www.python.org/</samp>
       <td>
         <table width="100%">
           <tr bgcolor="#99CCFF"><td><em>Fold-in form</em>
           <tr><td>External hyperlinks, like
-          <a href="http://www.python.org/">Python</a>.
+          <a href="https://www.python.org/">Python</a>.
         </table>
     <tr valign="top">
       <td>
@@ -1086,7 +1086,7 @@
           <p><table>
             <tr><td colspan="2"><hr>
             <tr><td><a name="labPython"><i>Python:</i></a>
-              <td> <a href="http://www.python.org/">http://www.python.org/</a>
+              <td> <a href="https://www.python.org/">https://www.python.org/</a>
           </table>
         </table>
     </table>
@@ -1117,9 +1117,9 @@
     <tr valign="top">
       <td rowspan="2">
         <samp>External&nbsp;hyperlinks,&nbsp;like&nbsp;`Python
-<br>&lt;http://www.python.org/&gt;`_.</samp>
+<br>&lt;https://www.python.org/&gt;`_.</samp>
       <td>External hyperlinks, like
-          <a href="http://www.python.org/">Python</a>.
+          <a href="https://www.python.org/">Python</a>.
     </table>
 
     <h4><a href="#contents" name="internal-hyperlink-targets" class="backref"
@@ -1134,11 +1134,11 @@
       <tbody>
 
     <tr valign="top">
-      <td rowspan="2"><samp>Internal&nbsp;crossreferences,&nbsp;like&nbsp;example_.</samp>
+      <td rowspan="2"><samp>Internal&nbsp;cross-references,&nbsp;like&nbsp;example_.</samp>
 
         <p><samp>..&nbsp;_example:</samp>
 
-        <p><samp>This&nbsp;is&nbsp;an&nbsp;example&nbsp;crossreference&nbsp;target.</samp>
+        <p><samp>This&nbsp;is&nbsp;an&nbsp;example&nbsp;cross-reference&nbsp;target.</samp>
       <td>
         <table width="100%">
           <tr bgcolor="#99CCFF"><td><em>Fold-in form</em>
@@ -1146,18 +1146,18 @@
           
           
           
-          <tr><td>Internal crossreferences, like <a href="#example-foldin">example</a>
+          <tr><td>Internal cross-references, like <a href="#example-foldin">example</a>
           <p><a name="example-foldin">This</a> is an example
-            crossreference target.
+            cross-reference target.
         </table>
     <tr valign="top">
       <td>
         <table width="100%">
           <tr><td bgcolor="#99CCFF"><em>Call-out form</em>
-          <tr><td>Internal crossreferences, like <a href="#example-callout">example</a>
+          <tr><td>Internal cross-references, like <a href="#example-callout">example</a>
 
           <p><a name="example-callout"><i>example:</i></a>
-            <br>This is an example crossreference target.
+            <br>This is an example cross-reference target.
         </table>
 
     </table>
@@ -1180,13 +1180,13 @@
         <samp>Python_&nbsp;is&nbsp;`my&nbsp;favourite
 <br>programming&nbsp;language`__.</samp>
 
-        <p><samp>..&nbsp;_Python:&nbsp;http://www.python.org/</samp>
+        <p><samp>..&nbsp;_Python:&nbsp;https://www.python.org/</samp>
 
         <p><samp>__&nbsp;Python_</samp>
 
       <td>
-        <p><a href="http://www.python.org/">Python</a> is
-        <a href="http://www.python.org/">my favourite
+        <p><a href="https://www.python.org/">Python</a> is
+        <a href="https://www.python.org/">my favourite
         programming language</a>.
 
     </table>
@@ -1222,11 +1222,11 @@
       <td>
         <samp>Titles&nbsp;are&nbsp;targets,&nbsp;too</samp>
         <br><samp>=======================</samp>
-        <br><samp>Implict&nbsp;references,&nbsp;like&nbsp;`Titles&nbsp;are</samp>
+        <br><samp>Implicit&nbsp;references,&nbsp;like&nbsp;`Titles&nbsp;are</samp>
         <br><samp>targets,&nbsp;too`_.</samp>
       <td>
         <font size="+2"><strong><a name="title">Titles are targets, too</a></strong></font>
-        <p>Implict references, like <a href="#title">Titles are
+        <p>Implicit references, like <a href="#title">Titles are
         targets, too</a>.
     </table>
 
@@ -1341,9 +1341,9 @@
     reStructuredText should <a
     href="mailto:docutils-users@lists.sourceforge.net" >post a
     message</a> to the <a
-    href="http://lists.sourceforge.net/lists/listinfo/docutils-users"
+    href="https://lists.sourceforge.net/lists/listinfo/docutils-users"
     >Docutils-Users mailing list</a>.  The <a
-    href="http://docutils.sourceforge.net/" >Docutils project web
+    href="https://docutils.sourceforge.io/" >Docutils project web
     site</a> has more information.
 
     <p><hr>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/rst/quickstart.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/rst/quickstart.txt Changed

@@ -1,8 +1,10 @@
+.. include:: ../../header2.txt
+
 A ReStructuredText Primer
 =========================
 
 :Author: Richard Jones
-:Version: $Revision: 5801 $
+:Version: $Revision: 9051 $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
@@ -16,7 +18,7 @@
 __
 .. _Quick reStructuredText: quickref.html
 .. _master quick reference:
-   http://docutils.sourceforge.net/docs/user/rst/quickref.html
+   https://docutils.sourceforge.io/docs/user/rst/quickref.html
 
 .. Note:: This document is an informal introduction to
    reStructuredText.  The `What Next?`_ section below has links to
@@ -396,9 +398,9 @@
 list.
 
 .. # If that relative link doesn't work, try the master document:
-   http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
+   https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html.
 
 .. _reStructuredText Markup Specification:
    ../../ref/rst/restructuredtext.html
 .. _Docutils-users: ../mailing-lists.html#docutils-users
-.. _Docutils project web site: http://docutils.sourceforge.net/
+.. _Docutils project web site: https://docutils.sourceforge.io/

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/slide-shows.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/slide-shows.txt Changed

@@ -5,7 +5,7 @@
 =================================
 
 :Authors: David Goodger & Chris Liechti
-:Date:    $Date: 2006-03-30 16:29:59 +0200 (Do, 30. Mär 2006) $
+:Date:    $Date: 2022-06-15 13:31:09 +0200 (Mi, 15. Jun 2022) $
 
 .. This document has been placed in the public domain.
 
@@ -18,7 +18,7 @@
    of the s5_html.py writer and the rst2s5.py front end.
 
    To view this document as a slide show see
-   http://docutils.sf.net/docs/user/slide-shows.s5.html (or `your
+   https://docutils.sourceforge.io/docs/user/slide-shows.s5.html (or `your
    local copy <slide-shows.s5.html>`__).
 
 .. contents::
@@ -54,8 +54,8 @@
    There is no support for the "header" directive in the themes
    included with Docutils.
 
-.. _Docutils: http://docutils.sourceforge.net/
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _Docutils: https://docutils.sourceforge.io/
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
 .. _S5: http://meyerweb.com/eric/tools/s5/
 .. _Firefox: http://www.mozilla.com/firefox/
 .. |bullet| unicode:: U+02022
@@ -80,7 +80,7 @@
    installed.  See the `Docutils README`__ file for installation
    instructions.
 
-   __ http://docutils.sourceforge.net/README.html
+   __ https://docutils.sourceforge.io/README.html
 
 * reStructuredText
 
@@ -474,19 +474,14 @@
 
   .. container:: handout
 
-     Themes from the `S5 tutorial`__ can be used.  These themes are in
-     the public domain and may be redistributed freely.
-
-     __ http://meyerweb.com/eric/tools/s5/s5blank.zip
-
      Sites with other S5 themes:
 
      * http://meyerweb.com/eric/tools/s5/themes/
      * http://mozilla.wikicities.com/wiki/Firefox_S5:Designs
      * http://lachy.id.au/dev/mozilla/firefox/s5/
      * http://www.openlight.com/Python-S5-Theme.tar.gz
-
-     S5 is becoming more popular every day.  Do a web search for "S5
+     
+     Do a web search for "S5
      theme" and you're bound to find plenty of choices.
 
 * "``--theme``" option.
@@ -645,12 +640,6 @@
      code also manages the fallback to Opera Show if you're using
      the Opera web browser.
 
-     Two files are included to support PNG transparency (alpha
-     channels) in Internet Explorer:
-
-     - iepngfix.htc
-     - blank.gif
-
 
 Making a Custom Theme
 =====================
@@ -665,7 +654,7 @@
 
 2. Copy ``ui/<base-theme>`` to ``ui/<new-theme>``.
 
-3. Edit the styles.
+3. Edit the styles (save in UTF-8 encoding).
 
    .. class:: handout
 
@@ -697,7 +686,7 @@
 
    Resources:
 
-   * W3C's `Learning CSS <http://www.w3.org/Style/CSS/learning>`__
+   * W3C's `Learning CSS <https://www.w3.org/Style/CSS/learning>`__
 
    * `Creating An S5 Theme <http://home.cogeco.ca/~ve3ll/s5themes.htm>`__
 
@@ -992,10 +981,10 @@
 .. class:: huge
 
    Further information:
-   http://docutils.sf.net
+   https://docutils.sourceforge.io
 
    Docutils users' mailing list:
-   docutils-users@lists.sf.net
+   docutils-users@lists.sourceforge.net
 
    `Any questions?`

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/smartquotes.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/smartquotes.txt Changed

@@ -1,3 +1,5 @@
+.. include:: ../header.txt
+
 =========================
 Smart Quotes for Docutils
 =========================
@@ -5,8 +7,8 @@
 :Author: Günter Milde,
          based on SmartyPants by John Gruber, Brad Choate, and Chad Miller
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8631 $
-:Date: $Date: 2021-03-05 22:14:40 +0100 (Fr, 05. Mär 2021) $
+:Revision: $Revision: 9051 $
+:Date: $Date: 2022-04-02 23:59:06 +0200 (Sa, 02. Apr 2022) $
 :License: Released under the terms of the `2-Clause BSD license`_
 :Abstract: This document describes the Docutils `smartquotes` module.
 
@@ -263,7 +265,7 @@
 
     "'Dutch' alternative quotes"
 
-    .. # 'nl-x-altquot2': u'””’’',
+    .. # 'nl-x-altquot2': '””’’',
 
 :pl: .. class:: language-pl
 
@@ -337,7 +339,7 @@
 
     "'Turkish' alternative quotes"
 
-.. 'tr-x-altquot2': u'“„‘‚', # antiquated?
+.. 'tr-x-altquot2': '“„‘‚', # antiquated?
 
 :uk: .. class:: language-uk
 
@@ -453,7 +455,7 @@
 
 .. _right single quotation mark:
     http://www.fileformat.info/info/unicode/char/2019/index.htm
-.. _Unicode: http://www.unicode.org/charts/PDF/U2000.pdf
+.. _Unicode: https://www.unicode.org/charts/PDF/U2000.pdf
 
 History
 =======

_service:tar_scm:docutils-0.20.tar.gz/docs/user/todo-lists.txt Added

@@ -0,0 +1,154 @@
+.. include:: ../header.txt
+
+===================
+Docutils TODO lists
+===================
+
+TODO lists allow you to create a list of items with checkboxes.
+In `extended Markdown`_, they are called `task lists`.
+
+Checkbox variants
+=================
+
+x ASCII-art checkbox.
+
+  ASCII space character and NBSP are smaller than the x.
+
+  The "figure space" has the correct width but is not easy to type.
+
+You may define substitutions for ballot box and checked ballot box or
+other suitable Unicode characters:
+
+.. |-| unicode:: U+2610
+.. |x| unicode:: U+2611
+.. |y| unicode:: U+1F5F9
+
+|-| U+2610 BALLOT BOX
+
+|x| U+2611 BALLOT BOX WITH CHECK
+
+|y| U+1F5F9 BALLOT BOX WITH BOLD CHECK
+
+List Markup
+===========
+
+Paragraphs
+----------
+
+|x| Simple *paragraphs* are easy for small lists with short values
+
+|-| but not well suited for complex TODO items.
+
+Line Blocks
+-----------
+
+| |x| Line blocks are rendered as "unstyled" lists.
+| |y| They don't need additional styling.
+| |-| However, you cannot nest block elements.
+
+
+Description Lists
+-----------------
+
+.. class:: description
+
+|x|
+    A *description list* works out of the box in HTML5 and XeTeX.
+
+|-|
+    It looks suboptimal in the rST source (definition list with class
+    value "description").
+
+x
+    Lists may use ASCII-art or substitutions.
+
+ 
+    All list markup variants require special styling based on a
+    preceding class__ directive.
+
+__ https://docutils.sourceforge.io/docs/ref/rst/directives.html#class
+
+Bullet Lists
+------------
+
+.. class:: todo
+
+- |x| bullet lists (similar to the Markdown_ for `task
+  lists`) can be styled accordingly.
+- |-| They don't look good in the rST source.
+- x Lists may use ASCII-art or substitutions.
+-   The "figure space" has the correct width.
+
+- |x| Another idea: use bullet lists with ``+`` and ``-`` markers.
+
+      + Clean and simple markup in the source.
+
+      - A new marker character starts a new list :-(
+
+      - Requires change to the writer: Pass the "bullet" attribute to
+        the output document (use `HTML5 "data-" attriibutes`__?).
+
+__ https://html.spec.whatwg.org/#embedding-custom-non-visible-data-with-the-data-*-attributes
+
+Field Lists
+-----------
+
+.. class:: todo
+
+:|x|: Compile this example with ``rst2html5.py``,
+:|y|: compare markup variants,
+:|-|: select the best.
+
+.. class:: todo monospace
+
+:x: ASCII-art checkbox.
+: : The "figure space" has the correct width.
+: : CSS styling can switch to monospace fonts for the ASCII-art boxes,
+      so an ASCII space character can be used.
+
+.. class:: todo monospace brackets
+
+:x: ASCII-art checkbox - brackets added by CSS.
+: : Simple rST source, easy typing.
+
+.. class:: todo monospace framed
+
+:x: checkbox border added by CSS.
+: : Simple rST source, easy typing.
+
+I recommend a field list with class argument and some CSS styling.
+
+
+.. _Markdown: https://www.markdownguide.org
+.. _extended Markdown: https://www.markdownguide.org/extended-syntax/
+
+
+.. ! The follwing CSS rules are included here as raw HTML to keep the
+     example compact. They compromise the HTML validity, as styling is not
+     allowed in the document body.
+     For production use, place CSS styling rules in a custom style sheet.
+
+.. raw:: html
+
+   <style type="text/css"></style>

_service:tar_scm:docutils-0.17.1.tar.gz/docs/user/tools.txt -> _service:tar_scm:docutils-0.20.tar.gz/docs/user/tools.txt Changed

@@ -1,51 +1,64 @@
+.. include:: ../header.txt
+
 ==========================
  Docutils Front-End Tools
 ==========================
 
 :Author: David Goodger
 :Contact: docutils-develop@lists.sourceforge.net
-:Revision: $Revision: 8645 $
-:Date: $Date: 2021-03-27 17:20:24 +0100 (Sa, 27. Mär 2021) $
+:Revision: $Revision: 9370 $
+:Date: $Date: 2023-05-03 13:01:03 +0200 (Mi, 03. Mai 2023) $
 :Copyright: This document has been placed in the public domain.
 
 .. contents::
 
-
 --------------
  Introduction
 --------------
 
-Once the Docutils package is unpacked, you will discover a "``tools``"
-directory containing several front ends for common Docutils
-processing.
-In addition to the all-purpose program docutils-cli.py_, Docutils has
-many small front ends, each specialized for a specific "Reader" (which
+In addition to the `generic command line front end`_, Docutils installs
+several small front ends, each specialized for a specific "Reader" (which
 knows how to interpret a file in context), a "Parser" (which
 understands the syntax of the text), and a "Writer" (which knows how
 to generate a specific data format).
 
-Most front ends have common options and the same command-line usage
+Most #_ front ends have common options and the same command-line usage
 pattern::
 
-    toolname options <source> <destination>
+    <toolname> options <source> <destination>
+
+See `the tools`_ below for concrete examples.
 
-(The exceptions are buildhtml.py_ and rstpep2html.py_.)  See
-rst2html.py_ for concrete examples.  Each tool has a "``--help``"
-option which lists the `command-line options`_ and arguments it
-supports.  Processing can also be customized with `configuration
-files`_.
+Each tool has a "``--help``" option which lists the
+`command-line options`_ and arguments it supports.
+Processing can also be customized with `configuration files`_.
 
 The two arguments, "source" and "destination", are optional.  If only
 one argument (source) is specified, the standard output (stdout) is
 used for the destination.  If no arguments are specified, the standard
 input (stdin) is used for the source.
 
+.. # The exceptions are buildhtml.py_ and rst2odt_prepstyles.py_.
+
+.. note::
+   Docutils front-end tool names, install details and the set of
+   auto-installed tools will change in Docutils 0.21.
+
+   The command line usage pattern will change over the next releases.
+
+   See `Future changes`_ in the RELEASE-NOTES.
+
+.. _future changes: ../../RELEASE-NOTES.html#future-changes
+
 
 Getting Help
 ============
 
 First, try the "``--help``" option each front-end tool has.
 
+Command line options and their corresponding configuration file entries
+are detailed in `Docutils Configuration`_.
+
 Users who have questions or need assistance with Docutils or
 reStructuredText should post a message to the Docutils-users_ mailing
 list.
@@ -60,57 +73,40 @@
 Generic Command Line Front End
 ==============================
 
-docutils-cli.py
----------------
-
-:Readers: Standalone, PEP
-:Parser: reStructuredText, Markdown (reCommonMark)
-:Writers: html_, html4css1_, html5_, pep_html_, s5_html_, 
-          latex__, xelatex_, xml_, odt_, Pseudo-XML_
-
-__ `Generating LaTeX with Docutils`_
-.. _Generating LaTeX with Docutils: latex.html
-
-
-HTML-Generating Tools
-=====================
+:CLI name: ``docutils``
+:Readers:  Standalone (default), PEP
+:Parsers:  reStructuredText (default), Markdown (requires 3rd party packages)
+:Writers:  html_, html4css1_, html5_ (default), latex2e_, manpage_,
+           odt_, pep_html_, pseudo-xml_, s5_html_, xelatex_, xml_,
+:Config_:  `docutils application`_
 
-buildhtml.py
-------------
+Since Docutils 0.19, you can start the generic front end like::
 
-:Readers: Standalone, PEP
-:Parser: reStructuredText
-:Writers: html_, html5_, pep_html_
+    docutils test.rst test.html
 
-Use ``buildhtml.py`` to generate ``*.html`` from all the ``*.txt`` files
-(including PEPs) in each <directory> given, and their subdirectories
-too.  (Use the ``--local`` option to skip subdirectories.)
+Alternatively, use Python's ``-m`` option, or the ``docutils-cli.py``
+script in the ``tools/`` directory.
 
-Usage::
+The generic front end allows combining "reader", "parser", and
+"writer" components from the Docutils package or 3rd party plug-ins.
+For example, to process a Markdown_ file "``test.md``" into
+Pseudo-XML_::
 
-    buildhtml.py options <directory> ...
+    docutils --parser=markdown --writer=pseudoxml test.md test.txt
 
-After unpacking the Docutils package, the following shell commands
-will generate HTML for all included documentation::
+Use the "--help" option together with the component-selection options
+to get the correct list of supported command-line options. Example::
 
-    cd docutils/tools
-    buildhtml.py ..
+    docutils --parser=markdown --writer=xml --help
 
-For official releases, the directory may be called "docutils-X.Y",
-where "X.Y" is the release version.  Alternatively::
+.. _Markdown: https://www.markdownguide.org/
+.. _docutils application: config.html#docutils-application
 
-    cd docutils
-    tools/buildhtml.py --config=tools/docutils.conf
 
-The current directory (and all subdirectories) is chosen by default if
-no directory is named.  Some files may generate system messages
-(docs/user/rst/demo.txt contains intentional errors); use the
-``--quiet`` option to suppress all warnings.  The ``--config`` option
-ensures that the correct settings are in place (a ``docutils.conf``
-`configuration file`_ in the current directory is picked up
-automatically).  Command-line options may be used to override config
-file settings or replace them altogether.
+HTML-Generating Tools
+=====================
 
+.. _rst2html:
 
 rst2html.py
 -----------
@@ -121,14 +117,19 @@
 
 `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.
 
-* Use `rst2html.py`, if you want the output to be up-to-date automatically.
+.. caution::
+   Use a specific front end like rst2html4.py_ or rst2html5.py_,
+   if you depend on stability of the generated HTML code
+   (e.g., because you use a custom style sheet or post-processing
+   that may break otherwise).
+
+.. _html: html.html#html
 
-* Use a specific front end, if you depend on stability of the
-  generated HTML code, e.g. because you use a custom style sheet or
-  post-processing that may break otherwise.
 
+.. _rst2html4:
 
 rst2html4.py
 ------------
@@ -160,21 +161,26 @@
 
 ``rst2html.py`` inserts into the generated HTML a cascading stylesheet
 (or a link to a stylesheet, when passing the "``--link-stylesheet``"
-option).  A stylesheet is required for proper rendering.  The default
-stylesheet (``docutils/writers/html4css1/html4css1.css``, located in
-the installation directory) is provided for basic use.  To use
-different stylesheet(s), specify the stylesheets' location(s)
-as comma-separated list with the "``--stylesheet``" (for a URL)
-or "``--stylesheet-path``" (for a local file) command-line option,
-or with `configuration file`_ settings (e.g. ``./docutils.conf``
-or ``~/.docutils``).  To experiment with styles, please see the
+option).  A stylesheet is required for proper rendering.
+The default stylesheet (``docutils/writers/html4css1/html4css1.css``,
+located in the installation directory) is provided for basic use.
+
+To use different stylesheet(s), specify the stylesheets' location(s) as
+comma-separated list with the "`-\-stylesheet`_"
+or "`-\-stylesheet-path`_" options.
+To experiment with styles, please see the
 `guide to writing HTML (CSS) stylesheets for Docutils`__.
 
-__ ../howto/html-stylesheets.html
+.. _XHTML 1.0 Transitional: https://www.w3.org/TR/xhtml1/
 .. _html4css1: html.html#html4css1
-.. _html: html.html#html
+.. _link-stylesheet: config.html#embed-stylesheet
+.. _--stylesheet: config.html#stylesheet
+.. _--stylesheet-path: config.html#stylesheet-path
+__ ../howto/html-stylesheets.html
 
 
+.. _rst2html5:
+
 rst2html5.py
 ------------
 
@@ -188,7 +194,9 @@
 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
+.. _HTML 5: https://www.w3.org/TR/html5/
+
 
 rstpep2html.py
 --------------
@@ -207,10 +215,18 @@
 For example, to process a PEP into HTML::
 
     cd <path-to-docutils>/docs/peps
-    rstpep2html.py pep-0287.txt pep-0287.html
+    ../../tools/rstpep2html.py pep-0287.txt pep-0287.html
+
+The same result can be achieved with the genric front end::
+
+    docutils --reader=pep --writer=pep_html pep-0287.txt pep-0287.html
+
+The rendering of published PEPs is done by a Sphinx-based build system
+(see :PEP:`676`).
 
 .. _pep_html: html.html#pep-html
 
+
 rst2s5.py
 ---------
 
@@ -318,10 +334,51 @@
 S5 <slide-shows.html>`_.
 
 
-.. _HTML 5: http://www.w3.org/TR/html5/
-.. _HTML 4.1: http://www.w3.org/TR/html401/
-.. _XHTML 1.0 Transitional: http://www.w3.org/TR/xhtml1/
-.. _XHTML 1.1: http://www.w3.org/TR/xhtml1/
+buildhtml.py
+------------
+
+:Readers: Standalone, PEP
+:Parser:  reStructuredText
+:Writers: html_, html5_, pep_html_
+:Config_: `buildhtml application`_
+
+The ``buildhtml.py`` script can be found in the ``/tools`` directory of
+the "docutils" source. It is not included in binary packages. #_
+
+Use ``buildhtml.py`` to generate ``*.html`` from all the ``*.txt`` files
+(including PEPs) in each <directory> given, and their subdirectories
+too.  (Use the ``--local`` option to skip subdirectories.)
+
+Usage::
+
+    buildhtml.py options <directory> ...
+
+After unpacking the Docutils source package, the following shell commands
+will generate HTML for all included documentation::
+
+    cd docutils/tools
+    buildhtml.py ..
+
+For official releases, the directory may be called "docutils-X.Y",
+where "X.Y" is the release version.  Alternatively::
+
+    cd docutils
+    tools/buildhtml.py --config=tools/docutils.conf
+
+The current directory (and all subdirectories) is chosen by default if
+no directory is named.  Some files may generate system messages
+(docs/user/rst/demo.txt contains intentional errors); use the
+``--quiet`` option to suppress all warnings.  The ``--config`` option
+ensures that the correct settings are in place (a ``docutils.conf``
+`configuration file`_ in the current directory is picked up
+automatically).  Command-line options may be used to override config
+file settings or replace them altogether.
+
+.. # The Debian package "python3-docutils" includes the script
+   under the name ``rst-builthtml``.
+
+.. _buildhtml application: config.html#buildhtml-application
+.. _configuration file: `configuration files`_
 
 
 LaTeX-Generating Tools
@@ -332,7 +389,7 @@
 
 :Reader: Standalone
 :Parser: reStructuredText
-:Writer: latex2e
+:Writer: latex2e_
 
 The ``rst2latex.py`` front end reads standalone reStructuredText
 source files and produces LaTeX_ output. For example, to process a
@@ -346,6 +403,10 @@
 
 For details see `Generating LaTeX with Docutils`_.
 
+.. _latex2e:
+.. _Generating LaTeX with Docutils: latex.html
+
+
 rst2xetex.py
 ------------
 
@@ -354,7 +415,7 @@
 :Writer: _`xelatex`
 
 The ``rst2xetex.py`` front end reads standalone reStructuredText source
-files and produces `LaTeX` output for processing with unicode-aware
+files and produces `LaTeX` output for processing with Unicode-aware
 TeX engines (`LuaTeX`_ or `XeTeX`_). For example, to process a
 reStructuredText file "``test.txt``" into LaTeX::
 
@@ -371,45 +432,61 @@
 .. _LuaTeX: https://en.wikipedia.org/wiki/LuaTeX
 
 
-XML-Generating Tools
-====================
+Man-Page-Generating Tools
+=========================
 
-rst2xml.py
+rst2man.py
 ----------
 
 :Reader: Standalone
 :Parser: reStructuredText
-:Writer: _`XML` (Docutils native)
+:Writer: manpage_
 
-The ``rst2xml.py`` front end produces Docutils-native XML output.
-This can be transformed with standard XML tools such as XSLT
-processors into arbitrary final forms. An example is the xml2rst_ processor
-in the Docutils sandbox.
+The ``rst2man.py`` front end reads standalone reStructuredText source
+files and produces troff_ sources for Unix man pages.
 
-.. _xml2rst: ../../../sandbox/xml2rst
+.. _manpage: manpage.html
+.. _troff: https://troff.org/
 
 
-ODF/OpenOffice-Generating Tools
-===============================
+OpenDocument-Generating Tools
+=============================
 
 rst2odt.py
 ----------
 
 :Reader: Standalone
 :Parser: reStructuredText
-:Writer: ODF/odt
+:Writer: odt_
 
 The ``rst2odt.py`` front end reads standalone reStructuredText
 source files and produces ODF/.odt files that can be read, edited,
-printed, etc with OpenOffice ``oowriter`` or LibreOffice.
-(http://www.openoffice.org/).  A stylesheet file is required.  A
+printed, etc with OpenOffice_ ``oowriter`` or LibreOffice_ ``lowriter``.
+A stylesheet file is required.  A
 stylesheet file is an OpenOffice .odt file containing definitions
-of the styles required for ``rst2odt.py``.  You can learn more
-about how to use ``rst2odt.py``, the styles used ``rst2odt.py``,
-etc from `Odt Writer for Docutils`_.
+of the styles required for ``rst2odt.py``.
+For details, see `Odt Writer for Docutils`_.
+
+.. _OpenOffice: https://www.openoffice.org/
+.. _LibreOffice: https://www.libreoffice.org/
+.. _odt:
+.. _Odt Writer for Docutils: odt.html
+
+rst2odt_prepstyles.py
+`````````````````````
+
+A helper tool to prepare a word-processor-generated STYLE_FILE.odt for
+use with the "odt" writer: #_ ::
+
+  rst2odt_prepstyles.py STYLE_FILE.odt
+
+See `Odt Writer for Docutils`__ for details.
+
+.. # The call pattern will change in Docutils 0.20, see
+       `Future changes`_ in the RELEASE-NOTES.
+
+__ odt.html#page-size
 
-.. _Odt Writer for Docutils:
-.. _odt: odt.html
 
 reStructuredText-Generating Tools
 =================================
@@ -421,6 +498,24 @@
 the XML (Docutils native) writer and the xml2rst_ processor.
 
 
+XML-Generating Tools
+====================
+
+rst2xml.py
+----------
+
+:Reader: Standalone
+:Parser: reStructuredText
+:Writer: _`XML` (Docutils native)
+
+The ``rst2xml.py`` front end produces Docutils-native XML output.
+This can be transformed with standard XML tools such as XSLT
+processors into arbitrary final forms. An example is the xml2rst_ processor
+in the Docutils sandbox.
+
+.. _xml2rst: ../../../sandbox/xml2rst
+
+
 Testing/Debugging Tools
 =======================
 
@@ -438,31 +533,18 @@
 attributes for any leftover "pending" elements are also given.
 
 
-quicktest.py
-------------
-
-:Reader: N/A
-:Parser: reStructuredText
-:Writer: N/A
-
-The ``quicktest.py`` tool is used for testing the reStructuredText
-parser.  It does not use a Docutils Reader or Writer or the standard
-Docutils command-line options.  Rather, it does its own I/O and calls
-the parser directly.  No transforms are applied to the parsed
-document.  Various forms output are possible:
-
-- Pretty-printed pseudo-XML (default)
-- Test data (Python list of input and pseudo-XML output strings;
-  useful for creating new test cases)
-- Pretty-printed native XML
-- Raw native XML (with or without a stylesheet reference)
-
-
-
 ---------------
  Customization
 ---------------
 
+Most front-end tools support the options/settings from the generic
+`configuration file sections`_ plus the sections of their components
+(reader, writer, parser). #_
+Some front-end tools also add application-specific settings.
+
+.. # The exception is rst2odt_prepstyles.py_.
+
+
 Command-Line Options
 ====================
 
@@ -470,10 +552,8 @@
 They take priority over configuration file settings.
 
 Use the "--help" option on each of the front ends to list the
-command-line options it supports.  
-
+command-line options it supports.
 
-.. _configuration file:
 
 Configuration Files
 ===================
@@ -482,9 +562,12 @@
 set once and take effect every time you use a front-end tool.
 
 Command-line options and their corresponding configuration file entry
-names are listed in the `Docutils Configuration Files`_ document.
+names are listed in the `Docutils Configuration`_ document.
 
-.. _Docutils Configuration Files: config.html
+.. _Docutils Configuration: config.html
+.. _Config:
+.. _configuration file sections:
+   config.html#configuration-file-sections-entries
 
 &#xc;
 ..

_service:tar_scm:docutils-0.17.1.tar.gz/docutils.egg-info/PKG-INFO -> _service:tar_scm:docutils-0.20.tar.gz/docutils.egg-info/PKG-INFO Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils.egg-info/SOURCES.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils.egg-info/SOURCES.txt Changed

@@ -7,30 +7,40 @@
 README.txt
 RELEASE-NOTES.txt
 THANKS.txt
+TODO.txt
 install.py
+manpage-URUE.txt
+math.txt
+mwe-test.txt
 setup.cfg
 setup.py
+docs/header.txt
+docs/header0.txt
+docs/header2.txt
 docs/index.txt
-docs/api/cmdline-tool.txt
 docs/api/publisher.txt
 docs/api/runtime-settings.txt
+docs/api/transforms.txt
 docs/dev/.release.txt.swp
 docs/dev/distributing.txt
 docs/dev/enthought-plan.txt
 docs/dev/enthought-rfp.txt
 docs/dev/hacking.txt
+docs/dev/packaging.txt
 docs/dev/policies.txt
 docs/dev/pysource.dtd
 docs/dev/pysource.txt
 docs/dev/release-old.txt
 docs/dev/release.txt
 docs/dev/repository.txt
+docs/dev/runtime-settings-processing.txt
 docs/dev/semantics.txt
 docs/dev/testing.txt
 docs/dev/todo.txt
 docs/dev/website.txt
 docs/dev/rst/alternatives.txt
 docs/dev/rst/problems.txt
+docs/howto/cmdline-tool.txt
 docs/howto/html-stylesheets.txt
 docs/howto/i18n.txt
 docs/howto/rst-directives.txt
@@ -43,10 +53,10 @@
 docs/ref/doctree.txt
 docs/ref/docutils.dtd
 docs/ref/soextblx.dtd
-docs/ref/transforms.txt
 docs/ref/rst/definitions.txt
 docs/ref/rst/directives.txt
 docs/ref/rst/introduction.txt
+docs/ref/rst/mathematics.txt
 docs/ref/rst/restructuredtext.txt
 docs/ref/rst/roles.txt
 docs/user/Makefile.docutils-update
@@ -60,6 +70,7 @@
 docs/user/odt.txt
 docs/user/slide-shows.txt
 docs/user/smartquotes.txt
+docs/user/todo-lists.txt
 docs/user/tools.txt
 docs/user/images/big-black.png
 docs/user/images/big-white.png
@@ -93,6 +104,7 @@
 docs/user/rst/images/title.png
 docs/user/rst/images/title.svg
 docutils/__init__.py
+docutils/__main__.py
 docutils/core.py
 docutils/docutils.conf
 docutils/examples.py
@@ -105,6 +117,7 @@
 docutils.egg-info/SOURCES.txt
 docutils.egg-info/dependency_links.html
 docutils.egg-info/dependency_links.txt
+docutils.egg-info/entry_points.txt
 docutils.egg-info/top_level.html
 docutils.egg-info/top_level.txt
 docutils/languages/__init__.py
@@ -133,9 +146,11 @@
 docutils/languages/ru.py
 docutils/languages/sk.py
 docutils/languages/sv.py
+docutils/languages/uk.py
 docutils/languages/zh_cn.py
 docutils/languages/zh_tw.py
 docutils/parsers/__init__.py
+docutils/parsers/commonmark_wrapper.py
 docutils/parsers/null.py
 docutils/parsers/recommonmark_wrapper.py
 docutils/parsers/rst/__init__.py
@@ -211,6 +226,7 @@
 docutils/parsers/rst/languages/ru.py
 docutils/parsers/rst/languages/sk.py
 docutils/parsers/rst/languages/sv.py
+docutils/parsers/rst/languages/uk.py
 docutils/parsers/rst/languages/zh_cn.py
 docutils/parsers/rst/languages/zh_tw.py
 docutils/readers/__init__.py
@@ -274,9 +290,7 @@
 docutils/writers/s5_html/themes/big-black/pretty.css
 docutils/writers/s5_html/themes/big-white/framing.css
 docutils/writers/s5_html/themes/big-white/pretty.css
-docutils/writers/s5_html/themes/default/blank.gif
 docutils/writers/s5_html/themes/default/framing.css
-docutils/writers/s5_html/themes/default/iepngfix.htc
 docutils/writers/s5_html/themes/default/opera.css
 docutils/writers/s5_html/themes/default/outline.css
 docutils/writers/s5_html/themes/default/pretty.css
@@ -297,17 +311,17 @@
 licenses/docutils.conf
 licenses/gpl-3-0.txt
 licenses/python-2-1-1.txt
-test/DocutilsTestSupport.py
+test/__init__.py
 test/alltests.py
-test/coverage.sh
+test/conftest.py
 test/docutils.conf
 test/local-parser.py
 test/local-reader.py
 test/local-writer.py
 test/local_dummy_lang.py
-test/package_unittest.py
+test/svn-commit.tmp
+test/test_CLI.py
 test/test__init__.py
-test/test_command_line.py
 test/test_dependencies.py
 test/test_error_reporting.py
 test/test_functional.py
@@ -323,10 +337,12 @@
 test/test_viewlist.py
 test/data/config_1.txt
 test/data/config_2.txt
-test/data/config_error_handler.txt
+test/data/config_encoding.txt
+test/data/config_encoding_2.txt
 test/data/config_list.txt
 test/data/config_list_2.txt
 test/data/config_old.txt
+test/data/config_syntax_error.txt
 test/data/csv_data.txt
 test/data/csv_dep.txt
 test/data/dependencies.txt
@@ -335,8 +351,15 @@
 test/data/ham.tex
 test/data/include.txt
 test/data/latin1.txt
+test/data/latin2.txt
 test/data/raw.txt
 test/data/stylesheet.txt
+test/data/utf-16-le-sig.txt
+test/data/utf-8-sig.txt
+test/data/utf8.txt
+test/data/help/docutils.txt
+test/data/help/rst2html.txt
+test/data/help/rst2latex.txt
 test/functional/README.txt
 test/functional/expected/compact_lists.html
 test/functional/expected/cyrillic.tex
@@ -357,8 +380,9 @@
 test/functional/expected/math_output_html.html
 test/functional/expected/math_output_latex.html
 test/functional/expected/math_output_mathjax.html
-test/functional/expected/math_output_mathml.xhtml
+test/functional/expected/math_output_mathml.html
 test/functional/expected/misc_rst_html4css1.html
+test/functional/expected/misc_rst_html5.html
 test/functional/expected/odt_basic.odt
 test/functional/expected/odt_classifier.odt
 test/functional/expected/odt_contents.odt
@@ -372,6 +396,7 @@
 test/functional/expected/odt_tables1.odt
 test/functional/expected/odt_unnested_class.odt
 test/functional/expected/pep_html.html
+test/functional/expected/rst_html5_tuftig.html
 test/functional/expected/standalone_rst_docutils_xml.xml
 test/functional/expected/standalone_rst_html4css1.html
 test/functional/expected/standalone_rst_html5.html
@@ -381,11 +406,8 @@
 test/functional/expected/standalone_rst_s5_html_1.html
 test/functional/expected/standalone_rst_s5_html_2.html
 test/functional/expected/standalone_rst_xetex.tex
-test/functional/expected/video.html
 test/functional/expected/xetex-cyrillic.tex
-test/functional/expected/ui/default/blank.gif
 test/functional/expected/ui/default/framing.css
-test/functional/expected/ui/default/iepngfix.htc
 test/functional/expected/ui/default/opera.css
 test/functional/expected/ui/default/outline.css
 test/functional/expected/ui/default/pretty.css
@@ -393,9 +415,7 @@
 test/functional/expected/ui/default/s5-core.css
 test/functional/expected/ui/default/slides.css
 test/functional/expected/ui/default/slides.js
-test/functional/expected/ui/small-black/blank.gif
 test/functional/expected/ui/small-black/framing.css
-test/functional/expected/ui/small-black/iepngfix.htc
 test/functional/expected/ui/small-black/opera.css
 test/functional/expected/ui/small-black/outline.css
 test/functional/expected/ui/small-black/pretty.css
@@ -406,7 +426,6 @@
 test/functional/input/compact_lists.txt
 test/functional/input/cyrillic.txt
 test/functional/input/dangerous.txt
-test/functional/input/embed_images.txt
 test/functional/input/field_list.txt
 test/functional/input/footnotes.txt
 test/functional/input/latex_babel.txt
@@ -414,7 +433,8 @@
 test/functional/input/latex_docinfo.txt
 test/functional/input/latex_leavevmode.txt
 test/functional/input/latex_literal_block.txt
-test/functional/input/link_in_substitution.txt
+test/functional/input/misc_rst_html4css1.txt
+test/functional/input/misc_rst_html5.txt
 test/functional/input/odt_basic.txt
 test/functional/input/odt_classifier.txt
 test/functional/input/odt_contents.txt
@@ -428,6 +448,7 @@
 test/functional/input/odt_tables1.txt
 test/functional/input/odt_unnested_class.txt
 test/functional/input/pep_html.txt
+test/functional/input/rst_html5_tuftig.txt
 test/functional/input/simple.txt
 test/functional/input/standalone_rst_docutils_xml.txt
 test/functional/input/standalone_rst_html4css1.txt
@@ -438,8 +459,10 @@
 test/functional/input/standalone_rst_s5_html.txt
 test/functional/input/standalone_rst_xetex.txt
 test/functional/input/data/classes_latex.txt
+test/functional/input/data/comprehensive-math-test.txt
 test/functional/input/data/custom_roles.txt
 test/functional/input/data/custom_roles_latex.txt
+test/functional/input/data/embed_images.txt
 test/functional/input/data/errors.txt
 test/functional/input/data/header_footer.txt
 test/functional/input/data/html4css1.css
@@ -455,6 +478,7 @@
 test/functional/input/data/nonalphanumeric.txt
 test/functional/input/data/option_lists.txt
 test/functional/input/data/plain.css
+test/functional/input/data/responsive.css
 test/functional/input/data/section_titles.txt
 test/functional/input/data/standard.txt
 test/functional/input/data/svg_images.txt
@@ -463,18 +487,15 @@
 test/functional/input/data/table_complex.txt
 test/functional/input/data/table_rowspan.txt
 test/functional/input/data/tables_latex.txt
+test/functional/input/data/tuftig.css
 test/functional/input/data/unicode.txt
 test/functional/input/data/urls.txt
 test/functional/input/data/video.txt
 test/functional/output/README.txt
-test/functional/tests/_default.py
-test/functional/tests/_standalone_rst_defaults.py
 test/functional/tests/compact_lists.py
 test/functional/tests/dangerous.py
-test/functional/tests/embed_images_html5.py
 test/functional/tests/field_name_limit.py
 test/functional/tests/footnotes_html5.py
-test/functional/tests/html5_video.py
 test/functional/tests/latex_babel.py
 test/functional/tests/latex_cornercases.py
 test/functional/tests/latex_cyrillic.py
@@ -491,10 +512,12 @@
 test/functional/tests/math_output_mathjax.py
 test/functional/tests/math_output_mathml.py
 test/functional/tests/misc_rst_html4css1.py
+test/functional/tests/misc_rst_html5.py
 test/functional/tests/pep_html.py
 test/functional/tests/standalone_rst_docutils_xml.py
 test/functional/tests/standalone_rst_html4css1.py
 test/functional/tests/standalone_rst_html5.py
+test/functional/tests/standalone_rst_html5_tuftig.py
 test/functional/tests/standalone_rst_latex.py
 test/functional/tests/standalone_rst_manpage.py
 test/functional/tests/standalone_rst_pseudoxml.py
@@ -544,10 +567,12 @@
 test/test_parsers/test_rst/test_outdenting.py
 test/test_parsers/test_rst/test_paragraphs.py
 test/test_parsers/test_rst/test_section_headers.py
+test/test_parsers/test_rst/test_source_line.py
 test/test_parsers/test_rst/test_substitutions.py
 test/test_parsers/test_rst/test_tables.py
 test/test_parsers/test_rst/test_targets.py
 test/test_parsers/test_rst/test_transitions.py
+test/test_parsers/test_rst/includes/include14.txt
 test/test_parsers/test_rst/includes/include9.txt
 test/test_parsers/test_rst/test_directives/__init__.py
 test/test_parsers/test_rst/test_directives/empty.txt
@@ -620,8 +645,10 @@
 test/test_transforms/test_doctitle.py
 test/test_transforms/test_expose_internals.py
 test/test_transforms/test_filter.py
+test/test_transforms/test_filter_messages.py
 test/test_transforms/test_footnotes.py
 test/test_transforms/test_hyperlinks.py
+test/test_transforms/test_hyperlinks_de.py
 test/test_transforms/test_messages.py
 test/test_transforms/test_peps.py
 test/test_transforms/test_sectnum.py
@@ -641,6 +668,7 @@
 test/test_writers/test_html4css1_template.py
 test/test_writers/test_html5_polyglot_misc.py
 test/test_writers/test_html5_polyglot_parts.py
+test/test_writers/test_html5_template.py
 test/test_writers/test_latex2e.py
 test/test_writers/test_latex2e_misc.py
 test/test_writers/test_manpage.py
@@ -651,7 +679,6 @@
 tools/buildhtml.py
 tools/docutils-cli.py
 tools/docutils.conf
-tools/quicktest.py
 tools/rst2html.py
 tools/rst2html4.py
 tools/rst2html5.py
@@ -668,6 +695,7 @@
 tools/dev/create_unimap.py
 tools/dev/generate_punctuation_chars.py
 tools/dev/profile_docutils.py
+tools/dev/quicktest.py
 tools/dev/unicode2rstsubs.py
 tools/editors/README.txt
 tools/editors/emacs/IDEAS.rst

_service:tar_scm:docutils-0.20.tar.gz/docutils.egg-info/entry_points.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8705 2021-04-17 12:41:26Z grubert $
+# $Id: __init__.py 9374 2023-05-09 17:55:19Z grubert $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -35,8 +35,8 @@
 - readers: Context-specific input handlers which understand the data
   source and manage a parser.
 
-- transforms: Modules used by readers and writers to modify DPS
-  doctrees.
+- transforms: Modules used by readers and writers to modify
+  the Docutils document tree.
 
 - utils: Contains the ``Reporter`` system warning class and miscellaneous
   utilities used by readers, writers, and transforms.
@@ -50,13 +50,11 @@
 - writers: Format-specific output translators.
 """
 
-import sys
 from collections import namedtuple
 
-
 __docformat__ = 'reStructuredText'
 
-__version__ = '0.17.1'
+__version__ = '0.20'
 """Docutils version identifier (complies with PEP 440)::
 
     major.minor.microreleaselevelserial.dev
@@ -64,11 +62,16 @@
 For version comparison operations, use `__version_info__` (see, below)
 rather than parsing the text of `__version__`.
 
-See 'Version Numbering' in docs/dev/policies.txt.
+https://docutils.sourceforge.io/docs/dev/policies.html#version-identification
+"""
+
+__version_details__ = ''
+"""Optional extra version details (e.g. 'snapshot 2005-05-29, r3410').
+
+For development and release status, use `__version__ and `__version_info__`.
 """
 
-# from functools import total_ordering
-# @total_ordering
+
 class VersionInfo(namedtuple('VersionInfo',
                              'major minor micro releaselevel serial release')):
 
@@ -81,13 +84,14 @@
         if releaselevel == 'final':
             if not release:
                 raise ValueError('releaselevel "final" must not be used '
-                             'with development versions (leads to wrong '
-                             'version ordering of the related __version__')
+                                 'with development versions (leads to wrong '
+                                 'version ordering of the related __version__')
+                # cf. https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering  # noqa
             if serial != 0:
                 raise ValueError('"serial" must be 0 for final releases')
 
-        return super(VersionInfo, cls).__new__(cls, major, minor, micro,
-                                               releaselevel, serial, release)
+        return super().__new__(cls, major, minor, micro,
+                               releaselevel, serial, release)
 
     def __lt__(self, other):
         if isinstance(other, tuple):
@@ -109,30 +113,26 @@
             other = VersionInfo(*other)
         return tuple.__ge__(self, other)
 
+
 __version_info__ = VersionInfo(
     major=0,
-    minor=17,
-    micro=1,
-    releaselevel='final', # one of 'alpha', 'beta', 'candidate', 'final'
-    # pre-release serial number (0 for final releases and active development):
-    serial=0,
-    release=True # True for official releases and pre-releases
+    minor=20,
+    micro=0,
+    releaselevel='final',  # one of 'alpha', 'beta', 'candidate', 'final'
+    serial=0,  # pre-release number (0 for final releases and snapshots)
+    release=True  # True for official releases and pre-releases
     )
-"""Comprehensive version information tuple. See 'Version Numbering' in
-docs/dev/policies.txt."""
+"""Comprehensive version information tuple.
 
-__version_details__ = 'release'
-"""Optional extra version details (e.g. 'snapshot 2005-05-29, r3410').
-(For development and release status see `__version_info__`.)
+https://docutils.sourceforge.io/docs/dev/policies.html#version-identification
 """
 
 
 class ApplicationError(Exception): pass
-
 class DataError(ApplicationError): pass
 
 
-class SettingsSpec(object):
+class SettingsSpec:
 
     """
     Runtime setting specification base class.
@@ -140,6 +140,17 @@
     SettingsSpec subclass objects used by `docutils.frontend.OptionParser`.
     """
 
+    # TODO: replace settings_specs with a new data structure
+    # Backwards compatiblity:
+    #   Drop-in components:
+    #   Sphinx supplies settings_spec in the current format in some places
+    #   Myst parser provides a settings_spec tuple
+    #
+    #   Sphinx reads a settings_spec in order to set a default value
+    #   in writers/html.py:59
+    #   https://github.com/sphinx-doc/sphinx/blob/4.x/sphinx/writers/html.py
+    #   This should be changed (before retiring the old format)
+    #   to use `settings_default_overrides` instead.
     settings_spec = ()
     """Runtime settings specification.  Override in subclasses.
 
@@ -186,7 +197,7 @@
 
     settings_default_overrides = None
     """A dictionary of auxiliary defaults, to override defaults for settings
-    defined in other components.  Override in subclasses."""
+    defined in other components' `setting_specs`.  Override in subclasses."""
 
     relative_path_settings = ()
     """Settings containing filesystem paths.  Override in subclasses.
@@ -206,18 +217,21 @@
 
 
 class TransformSpec:
-
     """
     Runtime transform specification base class.
 
-    TransformSpec subclass objects used by `docutils.transforms.Transformer`.
+    Provides the interface to register "transforms" and helper functions
+    to resolve references with a `docutils.transforms.Transformer`.
+
+    https://docutils.sourceforge.io/docs/ref/transforms.html
     """
 
     def get_transforms(self):
         """Transforms required by this class.  Override in subclasses."""
         if self.default_transforms != ():
             import warnings
-            warnings.warn('default_transforms attribute deprecated.\n'
+            warnings.warn('TransformSpec: the "default_transforms" attribute '
+                          'will be removed in Docutils 2.0.\n'
                           'Use get_transforms() method instead.',
                           DeprecationWarning)
             return list(self.default_transforms)
@@ -227,11 +241,13 @@
     default_transforms = ()
 
     unknown_reference_resolvers = ()
-    """List of functions to try to resolve unknown references.  Unknown
-    references have a 'refname' attribute which doesn't correspond to any
-    target in the document.  Called when the transforms in
-    `docutils.tranforms.references` are unable to find a correct target.  The
-    list should contain functions which will try to resolve unknown
+    """List of functions to try to resolve unknown references.
+
+    Unknown references have a 'refname' attribute which doesn't correspond
+    to any target in the document.  Called when the transforms in
+    `docutils.transforms.references` are unable to find a correct target.
+
+    The list should contain functions which will try to resolve unknown
     references, with the following signature::
 
         def reference_resolver(node):
@@ -248,7 +264,10 @@
 
         reference_resolver.priority = 100
 
-    Override in subclasses."""
+    This hook is provided for 3rd party extensions.
+    Example use case: the `MoinMoin - ReStructured Text Parser`
+    in ``sandbox/mmgilbe/rst.py``.
+    """
 
 
 class Component(SettingsSpec, TransformSpec):
@@ -260,7 +279,7 @@
     subclasses."""
 
     supported = ()
-    """Names for this component.  Override in subclasses."""
+    """Name and aliases for this component.  Override in subclasses."""
 
     def supports(self, format):
         """

_service:tar_scm:docutils-0.20.tar.gz/docutils/__main__.py Added

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# :Copyright: © 2020, 2022 Günter Milde.
+# :License: Released under the terms of the `2-Clause BSD license`_, in short:
+#
+#    Copying and distribution of this file, with or without modification,
+#    are permitted in any medium without royalty provided the copyright
+#    notice and this notice are preserved.
+#    This file is offered as-is, without any warranty.
+#
+# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+#
+# Revision: $Revision: 9107 $
+# Date: $Date: 2022-07-06 15:59:57 +0200 (Mi, 06. Jul 2022) $
+
+"""Generic command line interface for the `docutils` package.
+
+See also
+https://docs.python.org/3/library/__main__.html#main-py-in-python-packages
+"""
+
+import argparse
+import locale
+import sys
+
+import docutils
+from docutils.core import Publisher, publish_cmdline, default_description
+
+
+class CliSettingsSpec(docutils.SettingsSpec):
+    """Runtime settings & command-line options for the generic CLI.
+
+    Configurable reader, parser, and writer components.
+
+    The "--writer" default will change to 'html' in Docutils 2.0
+    when 'html' becomes an alias for the current value 'html5'.
+    """
+
+    settings_spec = (
+        'Docutils Application Options',
+        'Reader, writer, and parser settings influence the available options. '
+        '  Example: use `--help --writer=latex` to see LaTeX writer options. ',
+        # options: ('help text', <option strings>, {<keyword arguments>})
+        (('Reader name (currently: "%default").',
+          '--reader', {'default': 'standalone', 'metavar': '<reader>'}),
+         ('Parser name (currently: "%default").',
+          '--parser', {'default': 'rst', 'metavar': '<parser>'}),
+         ('Writer name (currently: "%default").',
+          '--writer', {'default': 'html5', 'metavar': '<writer>'}),
+         )
+    )
+    config_section = 'docutils application'
+    config_section_dependencies = ('docutils-cli application',  # back-compat
+                                   'applications')
+
+
+def main():
+    """Generic command line interface for the Docutils Publisher.
+    """
+    locale.setlocale(locale.LC_ALL, '')
+
+    description = ('Convert documents into useful formats.  '
+                   + default_description)
+
+    # Update component selection from config file(s)
+    components = Publisher().get_settings(settings_spec=CliSettingsSpec)
+
+    # Update component selection from command-line
+    argparser = argparse.ArgumentParser(add_help=False, allow_abbrev=False)
+    argparser.add_argument('--reader', default=components.reader)
+    argparser.add_argument('--parser', default=components.parser)
+    argparser.add_argument('--writer', default=components.writer)
+    # other options are parsed in a second pass via `publish_cmdline()`
+    (args, remainder) = argparser.parse_known_args()
+    # Ensure the current component selections are shown in help:
+    CliSettingsSpec.settings_default_overrides = args.__dict__
+
+    try:
+        publish_cmdline(reader_name=args.reader,
+                        parser_name=args.parser,
+                        writer_name=args.writer,
+                        settings_spec=CliSettingsSpec,
+                        description=description,
+                        argv=remainder)
+    except ImportError as error:
+        print('%s.' % error, file=sys.stderr)
+        if '--traceback' in remainder:
+            raise
+        else:
+            print('Use "--traceback" to show details.')
+
+
+if __name__ == '__main__':
+    if sys.argv0.endswith('__main__.py'):
+        # fix "usage" message
+        sys.argv0 = '%s -m docutils' % sys.executable
+    main()

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/core.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/core.py Changed

@@ -1,4 +1,4 @@
-# $Id: core.py 8367 2019-08-27 12:09:56Z milde $
+# $Id: core.py 9369 2023-05-02 23:04:27Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,22 +9,25 @@
 custom component objects first, and pass *them* to
 ``publish_*``/`Publisher`.  See `The Docutils Publisher`_.
 
-.. _The Docutils Publisher: http://docutils.sf.net/docs/api/publisher.html
+.. _The Docutils Publisher:
+    https://docutils.sourceforge.io/docs/api/publisher.html
 """
-from __future__ import print_function
 
 __docformat__ = 'reStructuredText'
 
-import sys
+import locale
 import pprint
-from docutils import __version__, __version_details__, SettingsSpec
-from docutils import frontend, io, utils, readers, writers
+import os
+import sys
+import warnings
+
+from docutils import (__version__, __version_details__, SettingsSpec,
+                      io, utils, readers, writers)
 from docutils.frontend import OptionParser
-from docutils.transforms import Transformer
-from docutils.utils.error_reporting import ErrorOutput, ErrorString
-import docutils.readers.doctree
+from docutils.readers import doctree
 
-class Publisher(object):
+
+class Publisher:
 
     """
     A facade encapsulating the high-level logic of a Docutils system.
@@ -36,8 +39,9 @@
                  settings=None):
         """
         Initial setup.  If any of `reader`, `parser`, or `writer` are not
-        specified, the corresponding ``set_...`` method should be called with
-        a component name (`set_reader` sets the parser as well).
+        specified, ``set_components()`` or the corresponding ``set_...()``
+        method should be called with component names
+        (`set_reader` sets the parser as well).
         """
 
         self.document = None
@@ -76,7 +80,7 @@
         """An object containing Docutils settings as instance attributes.
         Set by `self.process_command_line()` or `self.get_settings()`."""
 
-        self._stderr = ErrorOutput()
+        self._stderr = io.ErrorOutput()
 
     def set_reader(self, reader_name, parser, parser_name):
         """Set `self.reader` by name."""
@@ -102,6 +106,9 @@
     def setup_option_parser(self, usage=None, description=None,
                             settings_spec=None, config_section=None,
                             **defaults):
+        warnings.warn('Publisher.setup_option_parser is deprecated, '
+                      'and will be removed in Docutils 0.21.',
+                      DeprecationWarning, stacklevel=2)
         if config_section:
             if not settings_spec:
                 settings_spec = SettingsSpec()
@@ -109,23 +116,33 @@
             parts = config_section.split()
             if len(parts) > 1 and parts-1 == 'application':
                 settings_spec.config_section_dependencies = 'applications'
-        #@@@ Add self.source & self.destination to components in future?
-        option_parser = OptionParser(
+        # @@@ Add self.source & self.destination to components in future?
+        return OptionParser(
             components=(self.parser, self.reader, self.writer, settings_spec),
             defaults=defaults, read_config_files=True,
             usage=usage, description=description)
-        return option_parser
+
+    def _setup_settings_parser(self, *args, **kwargs):
+        # Provisional: will change (docutils.frontend.OptionParser will
+        # be replaced by a parser based on arparse.ArgumentParser)
+        # and may be removed later.
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            return self.setup_option_parser(*args, **kwargs)
 
     def get_settings(self, usage=None, description=None,
                      settings_spec=None, config_section=None, **defaults):
         """
-        Set and return default settings (overrides in `defaults` dict).
+        Return settings from components and config files.
 
-        Set components first (`self.set_reader` & `self.set_writer`).
-        Explicitly setting `self.settings` disables command line option
-        processing from `self.publish()`.
+        Please set components first (`self.set_reader` & `self.set_writer`).
+        Use keyword arguments to override component defaults
+        (before updating from configuration files).
+
+        Calling this function also sets `self.settings` which makes
+        `self.publish()` skip parsing command line options.
         """
-        option_parser = self.setup_option_parser(
+        option_parser = self._setup_settings_parser(
             usage, description, settings_spec, config_section, **defaults)
         self.settings = option_parser.get_default_values()
         return self.settings
@@ -134,7 +151,7 @@
                                       settings_overrides,
                                       config_section):
         if self.settings is None:
-            defaults = (settings_overrides or {}).copy()
+            defaults = settings_overrides.copy() if settings_overrides else {}
             # Propagate exceptions by default when used programmatically:
             defaults.setdefault('traceback', True)
             self.get_settings(settings_spec=settings_spec,
@@ -145,20 +162,17 @@
                              settings_spec=None, config_section=None,
                              **defaults):
         """
-        Pass an empty list to `argv` to avoid reading `sys.argv` (the
-        default).
+        Parse command line arguments and set ``self.settings``.
+
+        Pass an empty sequence to `argv` to avoid reading `sys.argv`
+        (the default behaviour).
 
         Set components first (`self.set_reader` & `self.set_writer`).
         """
-        option_parser = self.setup_option_parser(
+        option_parser = self._setup_settings_parser(
             usage, description, settings_spec, config_section, **defaults)
         if argv is None:
             argv = sys.argv1:
-            # converting to Unicode (Python 3 does this automatically):
-            if sys.version_info < (3, 0):
-                # TODO: make this failsafe and reversible?
-                argv_encoding = (frontend.locale_encoding or 'ascii')
-                argv = a.decode(argv_encoding) for a in argv
         self.settings = option_parser.parse_args(argv)
 
     def set_io(self, source_path=None, destination_path=None):
@@ -172,24 +186,26 @@
             source_path = self.settings._source
         else:
             self.settings._source = source_path
-        # Raise IOError instead of system exit with `tracback == True`
-        # TODO: change io.FileInput's default behaviour and remove this hack
-        try:
-            self.source = self.source_class(
-                source=source, source_path=source_path,
-                encoding=self.settings.input_encoding)
-        except TypeError:
-            self.source = self.source_class(
-                source=source, source_path=source_path,
-                encoding=self.settings.input_encoding)
+        self.source = self.source_class(
+            source=source, source_path=source_path,
+            encoding=self.settings.input_encoding,
+            error_handler=self.settings.input_encoding_error_handler)
 
     def set_destination(self, destination=None, destination_path=None):
         if destination_path is None:
-            destination_path = self.settings._destination
-        else:
-            self.settings._destination = destination_path
+            if (self.settings.output and self.settings._destination
+                and self.settings.output != self.settings._destination):
+                raise SystemExit('The positional argument <destination> is '
+                                 'obsoleted by the --output option.  '
+                                 'You cannot use them together.')
+            if self.settings.output == '-':      # means stdout
+                self.settings.output = None
+            destination_path = (self.settings.output
+                                or self.settings._destination)
+        self.settings._destination = destination_path
         self.destination = self.destination_class(
-            destination=destination, destination_path=destination_path,
+            destination=destination,
+            destination_path=destination_path,
             encoding=self.settings.output_encoding,
             error_handler=self.settings.output_encoding_error_handler)
 
@@ -214,18 +230,19 @@
                     argv, usage, description, settings_spec, config_section,
                     **(settings_overrides or {}))
             self.set_io()
+            self.prompt()
             self.document = self.reader.read(self.source, self.parser,
                                              self.settings)
             self.apply_transforms()
             output = self.writer.write(self.document, self.destination)
             self.writer.assemble_parts()
         except SystemExit as error:
-            exit = 1
+            exit = True
             exit_status = error.code
         except Exception as error:
             if not self.settings:       # exception too early to report nicely
                 raise
-            if self.settings.traceback: # Propagate exceptions?
+            if self.settings.traceback:  # Propagate exceptions?
                 self.debugging_dumps()
                 raise
             self.report_Exception(error)
@@ -263,33 +280,53 @@
             print(self.document.pformat().encode(
                 'raw_unicode_escape'), file=self._stderr)
 
+    def prompt(self):
+        """Print info and prompt when waiting for input from a terminal."""
+        try:
+            if not (self.source.isatty() and self._stderr.isatty()):
+                return
+        except AttributeError:
+            return
+        eot_key = 'Ctrl+Z' if os.name == 'nt' else 'Ctrl+D'
+        in_format = ''
+        out_format = 'useful formats'
+        try:
+            in_format = self.parser.supported0
+            out_format = self.writer.supported0
+        except (AttributeError, IndexError):
+            pass
+        print(f'Docutils {__version__} <https://docutils.sourceforge.io>\n'
+              f'converting "{in_format}" into "{out_format}".\n'
+              f'Call with option "--help" for more info.\n'
+              f'.. Waiting for source text (finish with {eot_key} '
+              'on an empty line):',
+              file=self._stderr)
+
     def report_Exception(self, error):
         if isinstance(error, utils.SystemMessage):
             self.report_SystemMessage(error)
         elif isinstance(error, UnicodeEncodeError):
             self.report_UnicodeError(error)
         elif isinstance(error, io.InputError):
-            self._stderr.write(u'Unable to open source file for reading:\n'
-                               u'  %s\n' % ErrorString(error))
+            self._stderr.write('Unable to open source file for reading:\n'
+                               '  %s\n' % io.error_string(error))
         elif isinstance(error, io.OutputError):
             self._stderr.write(
-                u'Unable to open destination file for writing:\n'
-                u'  %s\n' % ErrorString(error))
+                'Unable to open destination file for writing:\n'
+                '  %s\n' % io.error_string(error))
         else:
-            print(u'%s' % ErrorString(error), file=self._stderr)
-            print(("""\
+            print('%s' % io.error_string(error), file=self._stderr)
+            print(f"""\
 Exiting due to error.  Use "--traceback" to diagnose.
-Please report errors to <docutils-users@lists.sf.net>.
-Include "--traceback" output, Docutils version (%s%s),
-Python version (%s), your OS type & version, and the
-command line used.""" % (__version__,
-                         docutils.__version_details__ and
-                         ' %s'%docutils.__version_details__ or '',
-                         sys.version.split()0)), file=self._stderr)
+Please report errors to <docutils-users@lists.sourceforge.net>.
+Include "--traceback" output, Docutils version ({__version__}\
+{f' {__version_details__}' if __version_details__ else ''}),
+Python version ({sys.version.split()0}), your OS type & version, \
+and the command line used.""", file=self._stderr)
 
     def report_SystemMessage(self, error):
         print('Exiting due to level-%s (%s) system message.' % (
-            error.level, utils.Reporter.levelserror.level),
+                  error.level, utils.Reporter.levelserror.level),
               file=self._stderr)
 
     def report_UnicodeError(self, error):
@@ -311,23 +348,34 @@
             '\n'
             'Exiting due to error.  Use "--traceback" to diagnose.\n'
             'If the advice above doesn\'t eliminate the error,\n'
-            'please report it to <docutils-users@lists.sf.net>.\n'
+            'please report it to <docutils-users@lists.sourceforge.net>.\n'
             'Include "--traceback" output, Docutils version (%s),\n'
             'Python version (%s), your OS type & version, and the\n'
             'command line used.\n'
-            % (ErrorString(error),
+            % (io.error_string(error),
                self.settings.output_encoding,
                data.encode('ascii', 'xmlcharrefreplace'),
                data.encode('ascii', 'backslashreplace'),
                self.settings.output_encoding_error_handler,
                __version__, sys.version.split()0))
 
-default_usage = '%prog options <source> <destination>'
-default_description = ('Reads from <source> (default is stdin) and writes to '
-                       '<destination> (default is stdout).  See '
-                       '<http://docutils.sf.net/docs/user/config.html> for '
-                       'the full reference.')
 
+default_usage = '%prog options <source> <destination>'
+default_description = (
+    'Reads from <source> (default is stdin) '
+    'and writes to <destination> (default is stdout).  '
+    'See https://docutils.sourceforge.io/docs/user/config.html '
+    'for a detailed settings reference.')
+
+
+# TODO: or not to do?  cf. https://clig.dev/#help
+#
+# Display output on success, but keep it brief.
+# Provide a -q option to suppress all non-essential output.
+#
+# Chain several args as input and use --output or redirection for output:
+#   argparser.add_argument('source', nargs='+')
+#
 def publish_cmdline(reader=None, reader_name='standalone',
                     parser=None, parser_name='restructuredtext',
                     writer=None, writer_name='pseudoxml',
@@ -337,10 +385,11 @@
                     usage=default_usage, description=default_description):
     """
     Set up & run a `Publisher` for command-line-based file I/O (input and
-    output file paths taken automatically from the command line).  Return the
-    encoded string output also.
+    output file paths taken automatically from the command line).
+    Also return the output as `str` or `bytes` (for binary output document
+    formats).
 
-    Parameters: see `publish_programmatically` for the remainder.
+    Parameters: see `publish_programmatically()` for the remainder.
 
     - `argv`: Command-line argument list to use instead of ``sys.argv1:``.
     - `usage`: Usage string, output if there's a problem parsing the command
@@ -348,13 +397,14 @@
     - `description`: Program description, output for the "--help" option
       (along with command-line option descriptions).
     """
-    pub = Publisher(reader, parser, writer, settings=settings)
-    pub.set_components(reader_name, parser_name, writer_name)
-    output = pub.publish(
+    publisher = Publisher(reader, parser, writer, settings=settings)
+    publisher.set_components(reader_name, parser_name, writer_name)
+    output = publisher.publish(
         argv, usage, description, settings_spec, settings_overrides,
         config_section=config_section, enable_exit_status=enable_exit_status)
     return output
 
+
 def publish_file(source=None, source_path=None,
                  destination=None, destination_path=None,
                  reader=None, reader_name='standalone',
@@ -364,11 +414,12 @@
                  config_section=None, enable_exit_status=False):
     """
     Set up & run a `Publisher` for programmatic use with file-like I/O.
-    Return the encoded string output also.
+    Also return the output as `str` or `bytes` (for binary output document
+    formats).
 
-    Parameters: see `publish_programmatically`.
+    Parameters: see `publish_programmatically()`.
     """
-    output, pub = publish_programmatically(
+    output, publisher = publish_programmatically(
         source_class=io.FileInput, source=source, source_path=source_path,
         destination_class=io.FileOutput,
         destination=destination, destination_path=destination_path,
@@ -381,6 +432,7 @@
         enable_exit_status=enable_exit_status)
     return output
 
+
 def publish_string(source, source_path=None, destination_path=None,
                    reader=None, reader_name='standalone',
                    parser=None, parser_name='restructuredtext',
@@ -389,22 +441,23 @@
                    settings_overrides=None, config_section=None,
                    enable_exit_status=False):
     """
-    Set up & run a `Publisher` for programmatic use with string I/O.  Return
-    the encoded string or Unicode string output.
+    Set up & run a `Publisher` for programmatic use with string I/O.
 
-    For encoded string output, be sure to set the 'output_encoding' setting to
-    the desired encoding.  Set it to 'unicode' for unencoded Unicode string
-    output.  Here's one way::
+    Accepts a `bytes` or `str` instance as `source`.
 
-        publish_string(..., settings_overrides={'output_encoding': 'unicode'})
+    The output is encoded according to the `output_encoding`_ setting;
+    the return value is a `bytes` instance (unless `output_encoding`_ is
+    "unicode", cf. `docutils.io.StringOutput.write()`).
 
-    Similarly for Unicode string input (`source`)::
+    Parameters: see `publish_programmatically()`.
 
-        publish_string(..., settings_overrides={'input_encoding': 'unicode'})
+    This function is provisional because in Python 3 name and behaviour
+    no longer match.
 
-    Parameters: see `publish_programmatically`.
+    .. _output_encoding:
+        https://docutils.sourceforge.io/docs/user/config.html#output-encoding
     """
-    output, pub = publish_programmatically(
+    output, publisher = publish_programmatically(
         source_class=io.StringInput, source=source, source_path=source_path,
         destination_class=io.StringOutput,
         destination=None, destination_path=destination_path,
@@ -417,6 +470,7 @@
         enable_exit_status=enable_exit_status)
     return output
 
+
 def publish_parts(source, source_path=None, source_class=io.StringInput,
                   destination_path=None,
                   reader=None, reader_name='standalone',
@@ -427,18 +481,21 @@
                   enable_exit_status=False):
     """
     Set up & run a `Publisher`, and return a dictionary of document parts.
-    Dictionary keys are the names of parts, and values are Unicode strings;
-    encoding is up to the client.  For programmatic use with string I/O.
 
-    For encoded string input, be sure to set the 'input_encoding' setting to
-    the desired encoding.  Set it to 'unicode' for unencoded Unicode string
-    input.  Here's how::
+    Dictionary keys are the names of parts.
+    Dictionary values are `str` instances; encoding is up to the client,
+    e.g.::
 
-        publish_parts(..., settings_overrides={'input_encoding': 'unicode'})
+       parts = publish_parts(...)
+       body = parts'body'.encode(parts'encoding', parts'errors')
 
-    Parameters: see `publish_programmatically`.
+    See the `API documentation`__ for details on the provided parts.
+
+    Parameters: see `publish_programmatically()`.
+
+    __ https://docutils.sourceforge.io/docs/api/publisher.html#publish-parts
     """
-    output, pub = publish_programmatically(
+    output, publisher = publish_programmatically(
         source=source, source_path=source_path, source_class=source_class,
         destination_class=io.StringOutput,
         destination=None, destination_path=destination_path,
@@ -449,7 +506,8 @@
         settings_overrides=settings_overrides,
         config_section=config_section,
         enable_exit_status=enable_exit_status)
-    return pub.writer.parts
+    return publisher.writer.parts
+
 
 def publish_doctree(source, source_path=None,
                     source_class=io.StringInput,
@@ -459,28 +517,23 @@
                     settings_overrides=None, config_section=None,
                     enable_exit_status=False):
     """
-    Set up & run a `Publisher` for programmatic use with string I/O.
-    Return the document tree.
+    Set up & run a `Publisher` for programmatic use. Return a document tree.
 
-    For encoded string input, be sure to set the 'input_encoding' setting to
-    the desired encoding.  Set it to 'unicode' for unencoded Unicode string
-    input.  Here's one way::
-
-        publish_doctree(..., settings_overrides={'input_encoding': 'unicode'})
-
-    Parameters: see `publish_programmatically`.
+    Parameters: see `publish_programmatically()`.
     """
-    pub = Publisher(reader=reader, parser=parser, writer=None,
-                    settings=settings,
-                    source_class=source_class,
-                    destination_class=io.NullOutput)
-    pub.set_components(reader_name, parser_name, 'null')
-    pub.process_programmatic_settings(
-        settings_spec, settings_overrides, config_section)
-    pub.set_source(source, source_path)
-    pub.set_destination(None, None)
-    output = pub.publish(enable_exit_status=enable_exit_status)
-    return pub.document
+    _output, publisher = publish_programmatically(
+        source=source, source_path=source_path,
+        source_class=source_class,
+        destination=None, destination_path=None,
+        destination_class=io.NullOutput,
+        reader=reader, reader_name=reader_name,
+        parser=parser, parser_name=parser_name,
+        writer=None, writer_name='null',
+        settings=settings, settings_spec=settings_spec,
+        settings_overrides=settings_overrides, config_section=config_section,
+        enable_exit_status=enable_exit_status)
+    return publisher.document
+
 
 def publish_from_doctree(document, destination_path=None,
                          writer=None, writer_name='pseudoxml',
@@ -488,57 +541,59 @@
                          settings_overrides=None, config_section=None,
                          enable_exit_status=False):
     """
-    Set up & run a `Publisher` to render from an existing document
-    tree data structure, for programmatic use with string I/O.  Return
-    the encoded string output.
+    Set up & run a `Publisher` to render from an existing document tree
+    data structure. For programmatic use with string output
+    (`bytes` or `str`, cf. `publish_string()`).
 
-    Note that document.settings is overridden; if you want to use the settings
-    of the original `document`, pass settings=document.settings.
+    Note that ``document.settings`` is overridden; if you want to use the
+    settings of the original `document`, pass ``settings=document.settings``.
 
-    Also, new document.transformer and document.reporter objects are
+    Also, new `document.transformer` and `document.reporter` objects are
     generated.
 
-    For encoded string output, be sure to set the 'output_encoding' setting to
-    the desired encoding.  Set it to 'unicode' for unencoded Unicode string
-    output.  Here's one way::
-
-        publish_from_doctree(
-            ..., settings_overrides={'output_encoding': 'unicode'})
-
     Parameters: `document` is a `docutils.nodes.document` object, an existing
     document tree.
 
-    Other parameters: see `publish_programmatically`.
+    Other parameters: see `publish_programmatically()`.
+
+    This function is provisional because in Python 3 name and behaviour
+    of the `io.StringOutput` class no longer match.
     """
-    reader = docutils.readers.doctree.Reader(parser_name='null')
-    pub = Publisher(reader, None, writer,
-                    source=io.DocTreeInput(document),
-                    destination_class=io.StringOutput, settings=settings)
+    reader = doctree.Reader(parser_name='null')
+    publisher = Publisher(reader, None, writer,
+                          source=io.DocTreeInput(document),
+                          destination_class=io.StringOutput,
+                          settings=settings)
     if not writer and writer_name:
-        pub.set_writer(writer_name)
-    pub.process_programmatic_settings(
+        publisher.set_writer(writer_name)
+    publisher.process_programmatic_settings(
         settings_spec, settings_overrides, config_section)
-    pub.set_destination(None, destination_path)
-    return pub.publish(enable_exit_status=enable_exit_status)
+    publisher.set_destination(None, destination_path)
+    return publisher.publish(enable_exit_status=enable_exit_status)
+
 
 def publish_cmdline_to_binary(reader=None, reader_name='standalone',
-                    parser=None, parser_name='restructuredtext',
-                    writer=None, writer_name='pseudoxml',
-                    settings=None, settings_spec=None,
-                    settings_overrides=None, config_section=None,
-                    enable_exit_status=True, argv=None,
-                    usage=default_usage, description=default_description,
-                    destination=None, destination_class=io.BinaryFileOutput
-                    ):
+                              parser=None, parser_name='restructuredtext',
+                              writer=None, writer_name='pseudoxml',
+                              settings=None,
+                              settings_spec=None,
+                              settings_overrides=None,
+                              config_section=None,
+                              enable_exit_status=True,
+                              argv=None,
+                              usage=default_usage,
+                              description=default_description,
+                              destination=None,
+                              destination_class=io.BinaryFileOutput):
     """
     Set up & run a `Publisher` for command-line-based file I/O (input and
-    output file paths taken automatically from the command line).  Return the
-    encoded string output also.
+    output file paths taken automatically from the command line).
+    Also return the output as `bytes`.
 
     This is just like publish_cmdline, except that it uses
     io.BinaryFileOutput instead of io.FileOutput.
 
-    Parameters: see `publish_programmatically` for the remainder.
+    Parameters: see `publish_programmatically()` for the remainder.
 
     - `argv`: Command-line argument list to use instead of ``sys.argv1:``.
     - `usage`: Usage string, output if there's a problem parsing the command
@@ -546,14 +601,15 @@
     - `description`: Program description, output for the "--help" option
       (along with command-line option descriptions).
     """
-    pub = Publisher(reader, parser, writer, settings=settings,
-        destination_class=destination_class)
-    pub.set_components(reader_name, parser_name, writer_name)
-    output = pub.publish(
+    publisher = Publisher(reader, parser, writer, settings=settings,
+                          destination_class=destination_class)
+    publisher.set_components(reader_name, parser_name, writer_name)
+    output = publisher.publish(
         argv, usage, description, settings_spec, settings_overrides,
         config_section=config_section, enable_exit_status=enable_exit_status)
     return output
 
+
 def publish_programmatically(source_class, source, source_path,
                              destination_class, destination, destination_path,
                              reader, reader_name,
@@ -563,13 +619,15 @@
                              settings_overrides, config_section,
                              enable_exit_status):
     """
-    Set up & run a `Publisher` for custom programmatic use.  Return the
-    encoded string output and the Publisher object.
+    Set up & run a `Publisher` for custom programmatic use.
+
+    Return the output (as `str` or `bytes`, depending on `destination_class`,
+    writer, and the "output_encoding" setting) and the Publisher object.
 
     Applications should not need to call this function directly.  If it does
     seem to be necessary to call this function directly, please write to the
     Docutils-develop mailing list
-    <http://docutils.sf.net/docs/user/mailing-lists.html#docutils-develop>.
+    <https://docutils.sourceforge.io/docs/user/mailing-lists.html#docutils-develop>.
 
     Parameters:
 
@@ -583,18 +641,17 @@
         (`source_path` is opened).  If neither `source` nor
         `source_path` are supplied, `sys.stdin` is used.
 
-      - If `source_class` is `io.StringInput` **required**: The input
-        string, either an encoded 8-bit string (set the
-        'input_encoding' setting to the correct encoding) or a Unicode
-        string (set the 'input_encoding' setting to 'unicode').
+      - If `source_class` is `io.StringInput` **required**:
+        The input as either a `bytes` object (ensure the 'input_encoding'
+        setting matches its encoding) or a `str` object.
 
     * `source_path`: Type depends on `source_class`:
 
       - `io.FileInput`: Path to the input file, opened if no `source`
         supplied.
 
-      - `io.StringInput`: Optional.  Path to the file or object that produced
-        `source`.  Only used for diagnostic output.
+      - `io.StringInput`: Optional.  Path to the file or name of the
+        object that produced `source`.  Only used for diagnostic output.
 
     * `destination_class` **required**: The class for dynamically created
       destination objects.  Typically `io.FileOutput` or `io.StringOutput`.
@@ -654,13 +711,70 @@
 
     * `enable_exit_status`: Boolean; enable exit status at end of processing?
     """
-    pub = Publisher(reader, parser, writer, settings=settings,
-                    source_class=source_class,
-                    destination_class=destination_class)
-    pub.set_components(reader_name, parser_name, writer_name)
-    pub.process_programmatic_settings(
+    publisher = Publisher(reader, parser, writer, settings=settings,
+                          source_class=source_class,
+                          destination_class=destination_class)
+    publisher.set_components(reader_name, parser_name, writer_name)
+    publisher.process_programmatic_settings(
         settings_spec, settings_overrides, config_section)
-    pub.set_source(source, source_path)
-    pub.set_destination(destination, destination_path)
-    output = pub.publish(enable_exit_status=enable_exit_status)
-    return output, pub
+    publisher.set_source(source, source_path)
+    publisher.set_destination(destination, destination_path)
+    output = publisher.publish(enable_exit_status=enable_exit_status)
+    return output, publisher
+
+
+# "Entry points" with functionality of the "tools/rst2*.py" scripts
+# cf. https://packaging.python.org/en/latest/specifications/entry-points/
+
+def rst2something(writer, documenttype, doc_path=''):
+    # Helper function for the common parts of rst2...
+    #   writer:       writer name
+    #   documenttype: output document type
+    #   doc_path:     documentation path (relative to the documentation root)
+    description = (
+        f'Generate {documenttype} documents '
+        'from standalone reStructuredText sources '
+        f'<https://docutils.sourceforge.io/docs/{doc_path}>.  '
+        + default_description)
+    locale.setlocale(locale.LC_ALL, '')
+    publish_cmdline(writer_name=writer, description=description)
+
+
+def rst2html():
+    rst2something('html', 'HTML', 'user/html.html#html')
+
+
+def rst2html4():
+    rst2something('html4', 'XHTML 1.1', 'user/html.html#html4css1')
+
+
+def rst2html5():
+    rst2something('html5', 'HTML5', 'user/html.html#html5-polyglot')
+
+
+def rst2latex():
+    rst2something('latex', 'LaTeX', 'user/latex.html')
+
+
+def rst2man():
+    rst2something('manpage', 'Unix manual (troff)', 'user/manpage.html')
+
+
+def rst2odt():
+    rst2something('odt', 'OpenDocument text (ODT)', 'user/odt.html')
+
+
+def rst2pseudoxml():
+    rst2something('pseudoxml', 'pseudo-XML (test)', 'ref/doctree.html')
+
+
+def rst2s5():
+    rst2something('s5', 'S5 HTML slideshow', 'user/slide-shows.html')
+
+
+def rst2xetex():
+    rst2something('xetex', 'LaTeX (XeLaTeX/LuaLaTeX)', 'user/latex.html')
+
+
+def rst2xml():
+    rst2something('xml', 'Docutils-native XML', 'ref/doctree.html')

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/examples.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/examples.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/frontend.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/frontend.py Changed

@@ -1,56 +1,69 @@
-# $Id: frontend.py 8676 2021-04-08 16:36:09Z milde $
+# $Id: frontend.py 9328 2023-02-07 14:24:37Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Command-line and common processing for Docutils front-end tools.
 
+This module is provisional.
+Major changes will happen with the switch from the deprecated
+"optparse" module to "arparse".
+
+Applications should use the high-level API provided by `docutils.core`.
+See https://docutils.sourceforge.io/docs/api/runtime-settings.html.
+
 Exports the following classes:
 
 * `OptionParser`: Standard Docutils command-line processing.
+  Deprecated. Will be replaced by an ArgumentParser.
 * `Option`: Customized version of `optparse.Option`; validation support.
+  Deprecated. Will be removed.
 * `Values`: Runtime settings; objects are simple structs
   (``object.attribute``).  Supports cumulative list settings (attributes).
+  Deprecated. Will be removed.
 * `ConfigParser`: Standard Docutils config file processing.
+  Provisional. Details will change.
 
 Also exports the following functions:
 
-* Option callbacks: `store_multiple`, `read_config_file`.
-* Setting validators: `validate_encoding`,
-  `validate_encoding_error_handler`,
-  `validate_encoding_and_error_handler`,
-  `validate_boolean`, `validate_ternary`, `validate_threshold`,
-  `validate_colon_separated_list`,
-  `validate_comma_separated_list`,
-  `validate_dependency_file`.
-* `make_paths_absolute`.
-* SettingSpec manipulation: `filter_settings_spec`.
+Interface function:
+   `get_default_settings()`.  New in 0.19.
+
+Option callbacks:
+   `store_multiple()`, `read_config_file()`. Deprecated.
+
+Setting validators:
+  `validate_encoding()`, `validate_encoding_error_handler()`,
+  `validate_encoding_and_error_handler()`,
+  `validate_boolean()`, `validate_ternary()`,
+  `validate_nonnegative_int()`, `validate_threshold()`,
+  `validate_colon_separated_string_list()`,
+  `validate_comma_separated_list()`,
+  `validate_url_trailing_slash()`,
+  `validate_dependency_file()`,
+  `validate_strip_class()`
+  `validate_smartquotes_locales()`.
+
+  Provisional.
+
+Misc:
+  `make_paths_absolute()`, `filter_settings_spec()`. Provisional.
 """
 
 __docformat__ = 'reStructuredText'
 
+
+import codecs
+import configparser
+import optparse
+from optparse import SUPPRESS_HELP
 import os
 import os.path
 import sys
 import warnings
-import codecs
-import optparse
-from optparse import SUPPRESS_HELP
-if sys.version_info >= (3, 0):
-    from configparser import RawConfigParser
-    from os import getcwd
-else:
-    from ConfigParser import RawConfigParser
-    from os import getcwdu as getcwd
 
 import docutils
-import docutils.utils
-import docutils.nodes
-from docutils.utils.error_reporting import (locale_encoding, SafeString,
-                                            ErrorOutput, ErrorString)
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
+from docutils import io, utils
 
 
 def store_multiple(option, opt, value, parser, *args, **kwargs):
@@ -65,18 +78,22 @@
     for key, value in kwargs.items():
         setattr(parser.values, key, value)
 
+
 def read_config_file(option, opt, value, parser):
     """
     Read a configuration file during option processing.  (Option callback.)
     """
     try:
         new_settings = parser.get_config_file_settings(value)
-    except ValueError as error:
-        parser.error(error)
+    except ValueError as err:
+        parser.error(err)
     parser.values.update(new_settings, parser)
 
+
 def validate_encoding(setting, value, option_parser,
                       config_parser=None, config_section=None):
+    if value == '':
+        return None  # allow overwriting a config file value
     try:
         codecs.lookup(value)
     except LookupError:
@@ -84,6 +101,7 @@
                           % (setting, value))
     return value
 
+
 def validate_encoding_error_handler(setting, value, option_parser,
                                     config_parser=None, config_section=None):
     try:
@@ -96,6 +114,7 @@
             'the Python ``codecs`` module)' % value)
     return value
 
+
 def validate_encoding_and_error_handler(
     setting, value, option_parser, config_parser=None, config_section=None):
     """
@@ -118,6 +137,7 @@
                       config_parser, config_section)
     return encoding
 
+
 def validate_boolean(setting, value, option_parser,
                      config_parser=None, config_section=None):
     """Check/normalize boolean settings:
@@ -131,6 +151,7 @@
     except KeyError:
         raise LookupError('unknown boolean value: "%s"' % value)
 
+
 def validate_ternary(setting, value, option_parser,
                      config_parser=None, config_section=None):
     """Check/normalize three-value settings:
@@ -145,6 +166,7 @@
     except KeyError:
         return value
 
+
 def validate_nonnegative_int(setting, value, option_parser,
                              config_parser=None, config_section=None):
     value = int(value)
@@ -152,6 +174,7 @@
         raise ValueError('negative value; must be positive or zero')
     return value
 
+
 def validate_threshold(setting, value, option_parser,
                        config_parser=None, config_section=None):
     try:
@@ -162,6 +185,7 @@
         except (KeyError, AttributeError):
             raise LookupError('unknown threshold: %r.' % value)
 
+
 def validate_colon_separated_string_list(
     setting, value, option_parser, config_parser=None, config_section=None):
     if not isinstance(value, list):
@@ -171,21 +195,23 @@
         value.extend(last.split(':'))
     return value
 
+
 def validate_comma_separated_list(setting, value, option_parser,
-                                    config_parser=None, config_section=None):
+                                  config_parser=None, config_section=None):
     """Check/normalize list arguments (split at "," and strip whitespace).
     """
-    # `value` may be ``unicode``, ``str``, or a ``list`` (when  given as
+    # `value` may be ``bytes``, ``str``, or a ``list`` (when  given as
     # command line option and "action" is "append").
     if not isinstance(value, list):
         value = value
     # this function is called for every option added to `value`
     # -> split the last item and append the result:
     last = value.pop()
-    items = i.strip(u' \t\n') for i in last.split(u',') if i.strip(u' \t\n')
+    items = i.strip(' \t\n') for i in last.split(',') if i.strip(' \t\n')
     value.extend(items)
     return value
 
+
 def validate_url_trailing_slash(
     setting, value, option_parser, config_parser=None, config_section=None):
     if not value:
@@ -195,12 +221,15 @@
     else:
         return value + '/'
 
+
 def validate_dependency_file(setting, value, option_parser,
                              config_parser=None, config_section=None):
     try:
-        return docutils.utils.DependencyList(value)
-    except IOError:
-        return docutils.utils.DependencyList(None)
+        return utils.DependencyList(value)
+    except OSError:
+        # TODO: warn/info?
+        return utils.DependencyList(None)
+
 
 def validate_strip_class(setting, value, option_parser,
                          config_parser=None, config_section=None):
@@ -215,8 +244,9 @@
                              % (cls, normalized))
     return value
 
+
 def validate_smartquotes_locales(setting, value, option_parser,
-                         config_parser=None, config_section=None):
+                                 config_parser=None, config_section=None):
     """Check/normalize a comma separated list of smart quote definitions.
 
     Return a list of (language-tag, quotes) string tuples."""
@@ -235,7 +265,7 @@
             lc_quotes.append(item)
             continue
         except ValueError:
-            raise ValueError(u'Invalid value "%s".'
+            raise ValueError('Invalid value "%s".'
                              ' Format is "<language>:<quotes>".'
                              % item.encode('ascii', 'backslashreplace'))
         # parse colon separated string list:
@@ -245,11 +275,12 @@
             quotes = multichar_quotes
         elif len(quotes) != 4:
             raise ValueError('Invalid value "%s". Please specify 4 quotes\n'
-                '    (primary open/close; secondary open/close).'
+                             '    (primary open/close; secondary open/close).'
                              % item.encode('ascii', 'backslashreplace'))
         lc_quotes.append((lang, quotes))
     return lc_quotes
 
+
 def make_paths_absolute(pathdict, keys, base_path=None):
     """
     Interpret filesystem path settings relative to the `base_path` given.
@@ -258,8 +289,7 @@
     `OptionParser.relative_path_settings`.
     """
     if base_path is None:
-        base_path = getcwd() # type(base_path) == unicode
-        # to allow combining non-ASCII cwd with unicode values in `pathdict`
+        base_path = os.getcwd()
     for key in keys:
         if key in pathdict:
             value = pathdictkey
@@ -270,14 +300,16 @@
                 value = make_one_path_absolute(base_path, value)
             pathdictkey = value
 
+
 def make_one_path_absolute(base_path, path):
     return os.path.abspath(os.path.join(base_path, path))
 
+
 def filter_settings_spec(settings_spec, *exclude, **replace):
     """Return a copy of `settings_spec` excluding/replacing some settings.
 
-    `settings_spec` is a tuple of configuration settings with a structure
-    described for docutils.SettingsSpec.settings_spec.
+    `settings_spec` is a tuple of configuration settings
+    (cf. `docutils.SettingsSpec.settings_spec`).
 
     Optional positional arguments are names of to-be-excluded settings.
     Keyword arguments are option specification replacements.
@@ -291,8 +323,7 @@
             # opt_spec is ("<help>", <option strings>, {<keyword args>})
             opt_name = opt_string2:.replace('-', '_')
                         for opt_string in opt_spec1
-                            if opt_string.startswith('--')
-                       0
+                        if opt_string.startswith('--')0
             if opt_name in exclude:
                 continue
             if opt_name in replace.keys():
@@ -304,25 +335,29 @@
 
 
 class Values(optparse.Values):
+    """Storage for option values.
 
-    """
     Updates list attributes by extension rather than by replacement.
     Works in conjunction with the `OptionParser.lists` instance attribute.
+
+    Deprecated. Will be removed.
     """
 
     def __init__(self, *args, **kwargs):
-        optparse.Values.__init__(self, *args, **kwargs)
-        if (not hasattr(self, 'record_dependencies')
-            or self.record_dependencies is None):
-            # Set up dependency list, in case it is needed.
-            self.record_dependencies = docutils.utils.DependencyList()
+        warnings.warn('frontend.Values class will be removed '
+                      'in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)
+        if getattr(self, 'record_dependencies', None) is None:
+            # Set up dummy dependency list.
+            self.record_dependencies = utils.DependencyList()
 
     def update(self, other_dict, option_parser):
         if isinstance(other_dict, Values):
             other_dict = other_dict.__dict__
-        other_dict = other_dict.copy()
+        other_dict = dict(other_dict)  # also works with ConfigParser sections
         for setting in option_parser.lists.keys():
-            if (hasattr(self, setting) and setting in other_dict):
+            if hasattr(self, setting) and setting in other_dict:
                 value = getattr(self, setting)
                 if value:
                     value += other_dictsetting
@@ -331,10 +366,14 @@
 
     def copy(self):
         """Return a shallow copy of `self`."""
-        return self.__class__(defaults=self.__dict__)
-    
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            return self.__class__(defaults=self.__dict__)
+
     def setdefault(self, name, default):
-        """V.setdefault(n,d) -> getattr(V,n,d), also set D.n=d if n not in D or None.
+        """Return ``self.name`` or ``default``.
+
+        If ``self.name`` is unset, set ``self.name = default``.
         """
         if getattr(self, name, None) is None:
             setattr(self, name, default)
@@ -342,26 +381,36 @@
 
 
 class Option(optparse.Option):
+    """Add validation and override support to `optparse.Option`.
+
+    Deprecated. Will be removed.
+    """
 
     ATTRS = optparse.Option.ATTRS + 'validator', 'overrides'
 
+    def __init__(self, *args, **kwargs):
+        warnings.warn('The frontend.Option class will be removed '
+                      'in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)
+
     def process(self, opt, value, values, parser):
         """
         Call the validator function on applicable settings and
         evaluate the 'overrides' option.
         Extends `optparse.Option.process`.
         """
-        result = optparse.Option.process(self, opt, value, values, parser)
+        result = super().process(opt, value, values, parser)
         setting = self.dest
         if setting:
             if self.validator:
                 value = getattr(values, setting)
                 try:
                     new_value = self.validator(setting, value, parser)
-                except Exception as error:
+                except Exception as err:
                     raise optparse.OptionValueError(
                         'Error in option "%s":\n    %s'
-                        % (opt, ErrorString(error)))
+                        % (opt, io.error_string(err)))
                 setattr(values, setting, new_value)
             if self.overrides:
                 setattr(values, self.overrides, None)
@@ -369,23 +418,29 @@
 
 
 class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
-
     """
-    Parser for command-line and library use.  The `settings_spec`
-    specification here and in other Docutils components are merged to build
-    the set of command-line options and runtime settings for this process.
+    Settings parser for command-line and library use.
+
+    The `settings_spec` specification here and in other Docutils components
+    are merged to build the set of command-line options and runtime settings
+    for this process.
 
     Common settings (defined below) and component-specific settings must not
     conflict.  Short options are reserved for common settings, and components
-    are restrict to using long options.
+    are restricted to using long options.
+
+    Deprecated.
+    Will be replaced by a subclass of `argparse.ArgumentParser`.
     """
 
     standard_config_files = 
         '/etc/docutils.conf',           # system-wide
         './docutils.conf',              # project-specific
         '~/.docutils'                  # user-specific
-    """Docutils configuration files, using ConfigParser syntax.  Filenames
-    will be tilde-expanded later.  Later files override earlier ones."""
+    """Docutils configuration files, using ConfigParser syntax.
+
+    Filenames will be tilde-expanded later. Later files override earlier ones.
+    """
 
     threshold_choices = 'info 1 warning 2 error 3 severe 4 none 5'.split()
     """Possible inputs for for --report and --halt threshold values."""
@@ -393,20 +448,24 @@
     thresholds = {'info': 1, 'warning': 2, 'error': 3, 'severe': 4, 'none': 5}
     """Lookup table for --report and --halt threshold values."""
 
-    booleans={'1': True, 'on': True, 'yes': True, 'true': True,
-              '0': False, 'off': False, 'no': False, 'false': False, '': False}
+    booleans = {'1': True, 'on': True, 'yes': True, 'true': True, '0': False,
+                'off': False, 'no': False, 'false': False, '': False}
     """Lookup table for boolean configuration file settings."""
 
-    default_error_encoding = getattr(sys.stderr, 'encoding',
-                                     None) or locale_encoding or 'ascii'
+    default_error_encoding = (getattr(sys.stderr, 'encoding', None)
+                              or io._locale_encoding  # noqa
+                              or 'ascii')
 
     default_error_encoding_error_handler = 'backslashreplace'
 
     settings_spec = (
         'General Docutils Options',
         None,
-        (('Specify the document title as metadata.',
-          '--title', {}),
+        (('Output destination name. Obsoletes the <destination> '
+          'positional argument. Default: None (stdout).',
+          '--output', {'metavar': '<destination>'}),
+         ('Specify the document title as metadata.',
+          '--title', {'metavar': '<title>'}),
          ('Include a "Generated by Docutils" credit and link.',
           '--generator', '-g', {'action': 'store_true',
                                   'validator': validate_boolean}),
@@ -499,7 +558,8 @@
                               'default': 5, 'metavar': '<level>',
                               'validator': validate_threshold}),
          ('Enable debug-level system messages and diagnostics.',
-          '--debug', {'action': 'store_true', 'validator': validate_boolean}),
+          '--debug', {'action': 'store_true',
+                        'validator': validate_boolean}),
          ('Disable debug output.  (default)',
           '--no-debug', {'action': 'store_false', 'dest': 'debug'}),
          ('Send the output of system messages to <file>.',
@@ -510,7 +570,7 @@
          ('Disable Python tracebacks.  (default)',
           '--no-traceback', {'dest': 'traceback', 'action': 'store_false'}),
          ('Specify the encoding and optionally the '
-          'error handler of input text.  Default: <locale-dependent>:strict.',
+          'error handler of input text.  Default: <auto-detect>:strict.',
           '--input-encoding', '-i',
           {'metavar': '<name:handler>',
            'validator': validate_encoding_and_error_handler}),
@@ -519,7 +579,7 @@
           '--input-encoding-error-handler',
           {'default': 'strict', 'validator': validate_encoding_error_handler}),
          ('Specify the text encoding and optionally the error handler for '
-          'output.  Default: UTF-8:strict.',
+          'output.  Default: utf-8:strict.',
           '--output-encoding', '-o',
           {'metavar': '<name:handler>', 'default': 'utf-8',
            'validator': validate_encoding_and_error_handler}),
@@ -528,8 +588,8 @@
           '"xmlcharrefreplace", "backslashreplace".',
           '--output-encoding-error-handler',
           {'default': 'strict', 'validator': validate_encoding_error_handler}),
-         ('Specify text encoding and error handler for error output.  '
-          'Default: %s:%s.'
+         ('Specify text encoding and optionally error handler '
+          'for error output.  Default: %s:%s.'
           % (default_error_encoding, default_error_encoding_error_handler),
           '--error-encoding', '-e',
           {'metavar': '<name:handler>', 'default': default_error_encoding,
@@ -556,7 +616,7 @@
           '--help', '-h', {'action': 'help'}),
          # Typically not useful for non-programmatical use:
          (SUPPRESS_HELP, '--id-prefix', {'default': ''}),
-         (SUPPRESS_HELP, '--auto-id-prefix', {'default': 'id'}),
+         (SUPPRESS_HELP, '--auto-id-prefix', {'default': '%'}),
          # Hidden options, for development use only:
          (SUPPRESS_HELP, '--dump-settings', {'action': 'store_true'}),
          (SUPPRESS_HELP, '--dump-internals', {'action': 'store_true'}),
@@ -575,25 +635,27 @@
                          '_source': None,
                          '_destination': None,
                          '_config_files': None}
-    """Defaults for settings that don't have command-line option equivalents."""
+    """Defaults for settings without command-line option equivalents.
 
-    relative_path_settings = ('warning_stream',)
+    See https://docutils.sourceforge.io/docs/user/config.html#internal-settings
+    """
 
     config_section = 'general'
 
     version_template = ('%%prog (Docutils %s%s, Python %s, on %s)'
                         % (docutils.__version__,
-                           docutils.__version_details__ and
-                           ' %s'%docutils.__version_details__ or '',
+                           docutils.__version_details__
+                           and ' %s'%docutils.__version_details__ or '',
                            sys.version.split()0, sys.platform))
     """Default version message."""
 
-    def __init__(self, components=(), defaults=None, read_config_files=None,
+    def __init__(self, components=(), defaults=None, read_config_files=False,
                  *args, **kwargs):
-        """
+        """Set up OptionParser instance.
+
         `components` is a list of Docutils components each containing a
-        ``.settings_spec`` attribute.  `defaults` is a mapping of setting
-        default overrides.
+        ``.settings_spec`` attribute.
+        `defaults` is a mapping of setting default overrides.
         """
 
         self.lists = {}
@@ -602,27 +664,31 @@
         self.config_files = 
         """List of paths of applied configuration files."""
 
-        optparse.OptionParser.__init__(
-            self, option_class=Option, add_help_option=None,
-            formatter=optparse.TitledHelpFormatter(width=78),
-            *args, **kwargs)
+        self.relative_path_settings = 'warning_stream'  # will be modified
+
+        warnings.warn('The frontend.OptionParser class will be replaced '
+                      'by a subclass of argparse.ArgumentParser '
+                      'in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        super().__init__(option_class=Option, add_help_option=None,
+                         formatter=optparse.TitledHelpFormatter(width=78),
+                         *args, **kwargs)
         if not self.version:
             self.version = self.version_template
-        # Make an instance copy (it will be modified):
-        self.relative_path_settings = list(self.relative_path_settings)
-        self.components = (self,) + tuple(components)
+        self.components = (self, *components)
         self.populate_from_components(self.components)
-        self.set_defaults_from_dict(defaults or {})
+        self.defaults.update(defaults or {})
         if read_config_files and not self.defaults'_disable_config':
             try:
                 config_settings = self.get_standard_config_settings()
-            except ValueError as error:
-                self.error(SafeString(error))
-            self.set_defaults_from_dict(config_settings.__dict__)
+            except ValueError as err:
+                self.error(err)
+            self.defaults.update(config_settings.__dict__)
 
     def populate_from_components(self, components):
-        """
-        For each component, first populate from the `SettingsSpec.settings_spec`
+        """Collect settings specification from components.
+
+        For each component, populate from the `SettingsSpec.settings_spec`
         structure, then from the `SettingsSpec.settings_defaults` dictionary.
         After all components have been processed, check for and populate from
         each component's `SettingsSpec.settings_default_overrides` dictionary.
@@ -651,40 +717,32 @@
             if component and component.settings_default_overrides:
                 self.defaults.update(component.settings_default_overrides)
 
-    def get_standard_config_files(self):
+    @classmethod
+    def get_standard_config_files(cls):
         """Return list of config files, from environment or standard."""
-        try:
+        if 'DOCUTILSCONFIG' in os.environ:
             config_files = os.environ'DOCUTILSCONFIG'.split(os.pathsep)
-        except KeyError:
-            config_files = self.standard_config_files
-
-        # If 'HOME' is not set, expandvars() requires the 'pwd' module which is
-        # not available under certain environments, for example, within
-        # mod_python.  The publisher ends up in here, and we need to publish
-        # from within mod_python.  Therefore we need to avoid expanding when we
-        # are in those environments.
-        expand = os.path.expanduser
-        if 'HOME' not in os.environ:
-            try:
-                import pwd
-            except ImportError:
-                expand = lambda x: x
-        return expand(f) for f in config_files if f.strip()
+        else:
+            config_files = cls.standard_config_files
+        return os.path.expanduser(f) for f in config_files if f.strip()
 
     def get_standard_config_settings(self):
-        settings = Values()
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            settings = Values()
         for filename in self.get_standard_config_files():
             settings.update(self.get_config_file_settings(filename), self)
         return settings
 
     def get_config_file_settings(self, config_file):
         """Returns a dictionary containing appropriate config file settings."""
-        parser = ConfigParser()
-        parser.read(config_file, self)
-        self.config_files.extend(parser._files)
-        base_path = os.path.dirname(config_file)
-        applied = {}
-        settings = Values()
+        config_parser = ConfigParser()
+        # parse config file, add filename if found and successfully read.
+        applied = set()
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            self.config_files += config_parser.read(config_file, self)
+            settings = Values()
         for component in self.components:
             if not component:
                 continue
@@ -692,10 +750,12 @@
                             + (component.config_section,)):
                 if section in applied:
                     continue
-                appliedsection = 1
-                settings.update(parser.get_section(section), self)
-        make_paths_absolute(
-            settings.__dict__, self.relative_path_settings, base_path)
+                applied.add(section)
+                if config_parser.has_section(section):
+                    settings.update(config_parsersection, self)
+        make_paths_absolute(settings.__dict__,
+                            self.relative_path_settings,
+                            os.path.dirname(config_file))
         return settings.__dict__
 
     def check_values(self, values, args):
@@ -723,11 +783,14 @@
         return source, destination
 
     def set_defaults_from_dict(self, defaults):
+        # not used, deprecated, will be removed
         self.defaults.update(defaults)
 
     def get_default_values(self):
         """Needed to get custom `Values` instances."""
-        defaults = Values(self.defaults)
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            defaults = Values(self.defaults)
         defaults._config_files = self.config_files
         return defaults
 
@@ -748,59 +811,62 @@
         raise KeyError('No option with dest == %r.' % dest)
 
 
-class ConfigParser(RawConfigParser):
+class ConfigParser(configparser.RawConfigParser):
+    """Parser for Docutils configuration files.
+
+    See https://docutils.sourceforge.io/docs/user/config.html.
+
+    Option key normalization includes conversion of '-' to '_'.
+
+    Config file encoding is "utf-8". Encoding errors are reported
+    and the affected file(s) skipped.
+
+    This class is provisional and will change in future versions.
+    """
 
     old_settings = {
         'pep_stylesheet': ('pep_html writer', 'stylesheet'),
         'pep_stylesheet_path': ('pep_html writer', 'stylesheet_path'),
         'pep_template': ('pep_html writer', 'template')}
     """{old setting: (new section, new setting)} mapping, used by
-    `handle_old_config`, to convert settings from the old options section."""
+    `handle_old_config`, to convert settings from the old options section.
+    """
 
-    old_warning = """
-The "option" section is deprecated.  Support for old-format configuration
-files may be removed in a future Docutils release.  Please revise your
-configuration files.  See <http://docutils.sf.net/docs/user/config.html>,
-section "Old-Format Configuration Files".
-"""
+    old_warning = (
+        'The "option" section is deprecated.\n'
+        'Support for old-format configuration files will be removed in '
+        'Docutils 0.21 or later.  Please revise your configuration files.  '
+        'See <https://docutils.sourceforge.io/docs/user/config.html>, '
+        'section "Old-Format Configuration Files".')
 
     not_utf8_error = """\
 Unable to read configuration file "%s": content not encoded as UTF-8.
 Skipping "%s" configuration file.
 """
 
-    def __init__(self, *args, **kwargs):
-        RawConfigParser.__init__(self, *args, **kwargs)
-
-        self._files = 
-        """List of paths of configuration files read."""
-
-        self._stderr = ErrorOutput()
-        """Wrapper around sys.stderr catching en-/decoding errors"""
-
-    def read(self, filenames, option_parser):
-        if type(filenames) in (str, unicode):
+    def read(self, filenames, option_parser=None):
+        # Currently, if a `docutils.frontend.OptionParser` instance is
+        # supplied, setting values are validated.
+        if option_parser is not None:
+            warnings.warn('frontend.ConfigParser.read(): parameter '
+                          '"option_parser" will be removed '
+                          'in Docutils 0.21 or later.',
+                          DeprecationWarning, stacklevel=2)
+        read_ok = 
+        if isinstance(filenames, str):
             filenames = filenames
         for filename in filenames:
+            # Config files are UTF-8-encoded:
             try:
-                # Config files are UTF-8-encoded:
-                fp = codecs.open(filename, 'r', 'utf-8')
-            except IOError:
-                continue
-            try:
-                if sys.version_info < (3, 0):
-                    RawConfigParser.readfp(self, fp, filename)
-                else:
-                    RawConfigParser.read_file(self, fp, filename)
+                read_ok += super().read(filename, encoding='utf-8')
             except UnicodeDecodeError:
-                self._stderr.write(self.not_utf8_error % (filename, filename))
-                fp.close()
+                sys.stderr.write(self.not_utf8_error % (filename, filename))
                 continue
-            fp.close()
-            self._files.append(filename)
-            if self.has_section('options'):
+            if 'options' in self:
                 self.handle_old_config(filename)
-            self.validate_settings(filename, option_parser)
+            if option_parser is not None:
+                self.validate_settings(filename, option_parser)
+        return read_ok
 
     def handle_old_config(self, filename):
         warnings.warn_explicit(self.old_warning, ConfigDeprecationWarning,
@@ -837,34 +903,56 @@
                         new_value = option.validator(
                             setting, value, option_parser,
                             config_parser=self, config_section=section)
-                    except Exception as error:
-                        raise ValueError(
-                            'Error in config file "%s", section "%s":\n'
-                            '    %s\n'
-                            '        %s = %s'
-                            % (filename, section, ErrorString(error),
-                               setting, value))
+                    except Exception as err:
+                        raise ValueError(f'Error in config file "{filename}", '
+                                         f'section "{section}":\n'
+                                         f'    {io.error_string(err)}\n'
+                                         f'        {setting} = {value}')
                     self.set(section, setting, new_value)
                 if option.overrides:
                     self.set(section, option.overrides, None)
 
     def optionxform(self, optionstr):
         """
-        Transform '-' to '_' so the cmdline form of option names can be used.
+        Lowercase and transform '-' to '_'.
+
+        So the cmdline form of option names can be used in config files.
         """
         return optionstr.lower().replace('-', '_')
 
     def get_section(self, section):
         """
-        Return a given section as a dictionary (empty if the section
-        doesn't exist).
+        Return a given section as a dictionary.
+
+        Return empty dictionary if the section doesn't exist.
+
+        Deprecated. Use the configparser "Mapping Protocol Access" and
+        catch KeyError.
         """
-        section_dict = {}
-        if self.has_section(section):
-            for option in self.options(section):
-                section_dictoption = self.get(section, option)
-        return section_dict
+        warnings.warn('frontend.OptionParser.get_section() '
+                      'will be removed in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        try:
+            return dict(selfsection)
+        except KeyError:
+            return {}
 
 
-class ConfigDeprecationWarning(DeprecationWarning):
+class ConfigDeprecationWarning(FutureWarning):
     """Warning for deprecated configuration file features."""
+
+
+def get_default_settings(*components):
+    """Return default runtime settings for `components`.
+
+    Return a `frontend.Values` instance with defaults for generic Docutils
+    settings and settings from the `components` (`SettingsSpec` instances).
+
+    This corresponds to steps 1 and 2 in the `runtime settings priority`__.
+
+    __ https://docutils.sourceforge.io/docs/api/runtime-settings.html
+       #settings-priority
+    """
+    with warnings.catch_warnings():
+        warnings.filterwarnings('ignore', category=DeprecationWarning)
+        return OptionParser(components).get_default_values()

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/io.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/io.py Changed

@@ -1,4 +1,4 @@
-# $Id: io.py 8676 2021-04-08 16:36:09Z milde $
+# $Id: io.py 9369 2023-05-02 23:04:27Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -6,23 +6,51 @@
 I/O classes provide a uniform API for low-level input and output.  Subclasses
 exist for a variety of input/output mechanisms.
 """
-from __future__ import print_function
 
 __docformat__ = 'reStructuredText'
 
-import sys
+import codecs
+import locale
 import os
 import re
-import codecs
+import sys
+import warnings
+
 from docutils import TransformSpec
-from docutils.utils.error_reporting import locale_encoding, ErrorString, ErrorOutput
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
 
+# Guess the locale's preferred encoding.
+# If no valid guess can be made, _locale_encoding is set to `None`:
+#
+# TODO: check whether this is set correctly with every OS and Python version
+#       or whether front-end tools need to call `locale.setlocale()`
+#       before importing this module
+try:
+    # Return locale encoding also in UTF-8 mode
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore")
+        _locale_encoding = (locale.getlocale()1
+                            or locale.getdefaultlocale()1)
+        _locale_encoding = _locale_encoding.lower()
+except ValueError as error:  # OS X may set UTF-8 without language code
+    # See https://bugs.python.org/issue18378 fixed in 3.8
+    # and https://sourceforge.net/p/docutils/bugs/298/.
+    # Drop the special case after requiring Python >= 3.8
+    if "unknown locale: UTF-8" in error.args:
+        _locale_encoding = "utf-8"
+    else:
+        _locale_encoding = None
+except:  # noqa  any other problems determining the locale -> use None
+    _locale_encoding = None
+try:
+    codecs.lookup(_locale_encoding)
+except (LookupError, TypeError):
+    _locale_encoding = None
+
+
+class InputError(OSError): pass
+class OutputError(OSError): pass
 
-class InputError(IOError): pass
-class OutputError(IOError): pass
 
 def check_encoding(stream, encoding):
     """Test, whether the encoding of `stream` matches `encoding`.
@@ -40,10 +68,22 @@
         return None
 
 
-class Input(TransformSpec):
+def error_string(err):
+    """Return string representation of Exception `err`.
+    """
+    return f'{err.__class__.__name__}: {err}'
+
 
+class Input(TransformSpec):
     """
     Abstract base class for input wrappers.
+
+    Docutils input objects must provide a `read()` method that
+    returns the source, typically as `str` instance.
+
+    Inheriting `TransformSpec` allows input objects to add
+    "transforms" and "unknown_reference_resolvers" to the "Transformer".
+    (Optional for custom input objects since Docutils 0.19.)
     """
 
     component_type = 'input'
@@ -75,55 +115,78 @@
                                                   self.source_path)
 
     def read(self):
+        """Return input as `str`. Define in subclasses."""
         raise NotImplementedError
 
     def decode(self, data):
         """
-        Decode a string, `data`, heuristically.
-        Raise UnicodeError if unsuccessful.
+        Decode `data` if required.
+
+        Return Unicode `str` instances unchanged (nothing to decode).
 
+        If `self.encoding` is None, determine encoding from data
+        or try UTF-8, locale encoding, and (as last ressort) 'latin-1'.
         The client application should call ``locale.setlocale`` at the
         beginning of processing::
 
             locale.setlocale(locale.LC_ALL, '')
+
+        Raise UnicodeError if unsuccessful.
+
+        Provisional:
+          - Raise UnicodeError (instead of falling back to the locale
+            encoding) if decoding the source with the default encoding (UTF-8)
+            fails and Python is started in `UTF-8 mode`.
+
+            Raise UnicodeError (instead of falling back to "latin1") if both,
+            default and locale encoding, fail.
+
+          - Only remove BOM (U+FEFF ZWNBSP at start of data),
+            no other ZWNBSPs.
         """
         if self.encoding and self.encoding.lower() == 'unicode':
-            assert isinstance(data, unicode), (
-                'input encoding is "unicode" '
-                'but input is not a unicode object')
-        if isinstance(data, unicode):
-            # Accept unicode even if self.encoding != 'unicode'.
+            assert isinstance(data, str), ('input encoding is "unicode" '
+                                           'but `data` is no `str` instance')
+        if isinstance(data, str):
+            # nothing to decode
             return data
         if self.encoding:
             # We believe the user/application when the encoding is
             # explicitly given.
-            encodings = self.encoding
+            encoding_candidates = self.encoding
         else:
             data_encoding = self.determine_encoding_from_data(data)
             if data_encoding:
                 # If the data declares its encoding (explicitly or via a BOM),
                 # we believe it.
-                encodings = data_encoding
+                encoding_candidates = data_encoding
             else:
                 # Apply heuristics only if no encoding is explicitly given and
                 # no BOM found.  Start with UTF-8, because that only matches
                 # data that *IS* UTF-8:
-                encodings = 'utf-8', 'latin-1'
-                if locale_encoding:
-                    encodings.insert(1, locale_encoding)
-        for enc in encodings:
+                encoding_candidates = 'utf-8'
+                # TODO: use `locale.getpreferredlocale(do_setlocale=True)`
+                # to respect UTF-8 mode (API change).
+                # (Check if it is a valid encoding and not UTF-8)
+                if _locale_encoding and _locale_encoding != 'utf-8':
+                    encoding_candidates.append(_locale_encoding)
+                # TODO: don't fall back to 'latin-1' (API change).
+                encoding_candidates.append('latin-1')
+        for enc in encoding_candidates:
             try:
-                decoded = unicode(data, enc, self.error_handler)
+                decoded = str(data, enc, self.error_handler)
                 self.successful_encoding = enc
-                # Return decoded, removing BOMs.
-                return decoded.replace(u'\ufeff', u'')
+                # Return decoded, removing BOM and other ZWNBSPs.
+                # TODO: only remove BOM (ZWNBSP at start of data)
+                #       and only if 'self.encoding' is None. (API change)
+                return decoded.replace('\ufeff', '')
             except (UnicodeError, LookupError) as err:
-                error = err # in Python 3, the <exception instance> is
-                            # local to the except clause
+                # keep exception instance for use outside of the "for" loop.
+                error = err
         raise UnicodeError(
             'Unable to decode input data.  Tried the following encodings: '
-            '%s.\n(%s)' % (', '.join(repr(enc) for enc in encodings),
-                         ErrorString(error)))
+            f'{", ".join(repr(enc) for enc in encoding_candidates)}.\n'
+            f'({error_string(error)})')
 
     coding_slug = re.compile(br"coding:=\s*(-\w.+)")
     """Encoding declaration pattern."""
@@ -151,11 +214,24 @@
                 return match.group(1).decode('ascii')
         return None
 
+    def isatty(self):
+        """Return True, if the input source is connected to a TTY device."""
+        try:
+            return self.source.isatty()
+        except AttributeError:
+            return False
 
-class Output(TransformSpec):
 
+class Output(TransformSpec):
     """
     Abstract base class for output wrappers.
+
+    Docutils output objects must provide a `write()` method that
+    expects and handles one argument (the output).
+
+    Inheriting `TransformSpec` allows output objects to add
+    "transforms" and "unknown_reference_resolvers" to the "Transformer".
+    (Optional for custom output objects since Docutils 0.19.)
     """
 
     component_type = 'output'
@@ -184,22 +260,118 @@
                 % (self.__class__, self.destination, self.destination_path))
 
     def write(self, data):
-        """`data` is a Unicode string, to be encoded by `self.encode`."""
+        """Write `data`. Define in subclasses."""
         raise NotImplementedError
 
     def encode(self, data):
+        """
+        Encode and return `data`.
+
+        If `data` is a `bytes` instance, it is returned unchanged.
+        Otherwise it is encoded with `self.encoding`.
+
+        Provisional: If `self.encoding` is set to the pseudo encoding name
+        "unicode", `data` must be a `str` instance and is returned unchanged.
+        """
         if self.encoding and self.encoding.lower() == 'unicode':
-            assert isinstance(data, unicode), (
-                'the encoding given is "unicode" but the output is not '
-                'a Unicode string')
+            assert isinstance(data, str), ('output encoding is "unicode" '
+                                           'but `data` is no `str` instance')
             return data
-        if not isinstance(data, unicode):
+        if not isinstance(data, str):
             # Non-unicode (e.g. bytes) output.
             return data
         else:
             return data.encode(self.encoding, self.error_handler)
 
 
+class ErrorOutput:
+    """
+    Wrapper class for file-like error streams with
+    failsafe de- and encoding of `str`, `bytes`, `unicode` and
+    `Exception` instances.
+    """
+
+    def __init__(self, destination=None, encoding=None,
+                 encoding_errors='backslashreplace',
+                 decoding_errors='replace'):
+        """
+        :Parameters:
+            - `destination`: a file-like object,
+                        a string (path to a file),
+                        `None` (write to `sys.stderr`, default), or
+                        evaluating to `False` (write() requests are ignored).
+            - `encoding`: `destination` text encoding. Guessed if None.
+            - `encoding_errors`: how to treat encoding errors.
+        """
+        if destination is None:
+            destination = sys.stderr
+        elif not destination:
+            destination = False
+        # if `destination` is a file name, open it
+        elif isinstance(destination, str):
+            destination = open(destination, 'w')
+
+        self.destination = destination
+        """Where warning output is sent."""
+
+        self.encoding = (encoding or getattr(destination, 'encoding', None)
+                         or _locale_encoding or 'ascii')
+        """The output character encoding."""
+
+        self.encoding_errors = encoding_errors
+        """Encoding error handler."""
+
+        self.decoding_errors = decoding_errors
+        """Decoding error handler."""
+
+    def write(self, data):
+        """
+        Write `data` to self.destination. Ignore, if self.destination is False.
+
+        `data` can be a `bytes`, `str`, or `Exception` instance.
+        """
+        if not self.destination:
+            return
+        if isinstance(data, Exception):
+            data = str(data)
+        try:
+            self.destination.write(data)
+        except UnicodeEncodeError:
+            self.destination.write(data.encode(self.encoding,
+                                               self.encoding_errors))
+        except TypeError:
+            if isinstance(data, str):  # destination may expect bytes
+                self.destination.write(data.encode(self.encoding,
+                                                   self.encoding_errors))
+            elif self.destination in (sys.stderr, sys.stdout):
+                # write bytes to raw stream
+                self.destination.buffer.write(data)
+            else:
+                self.destination.write(str(data, self.encoding,
+                                           self.decoding_errors))
+
+    def close(self):
+        """
+        Close the error-output stream.
+
+        Ignored if the destination is` sys.stderr` or `sys.stdout` or has no
+        close() method.
+        """
+        if self.destination in (sys.stdout, sys.stderr):
+            return
+        try:
+            self.destination.close()
+        except AttributeError:
+            pass
+
+    def isatty(self):
+        """Return True, if the destination is connected to a TTY device."""
+        try:
+            return self.destination.isatty()
+        except AttributeError:
+            return False
+
+
 class FileInput(Input):
 
     """
@@ -207,8 +379,7 @@
     """
     def __init__(self, source=None, source_path=None,
                  encoding=None, error_handler='strict',
-                 autoclose=True,
-                 mode='r' if sys.version_info >= (3, 0) else 'rU'):
+                 autoclose=True, mode='r'):
         """
         :Parameters:
             - `source`: either a file-like object (which is read directly), or
@@ -219,8 +390,7 @@
             - `autoclose`: close automatically after read (except when
               `sys.stdin` is the source).
             - `mode`: how the file is to be opened (see standard function
-              `open`). The default 'rU' provides universal newline support
-              for text files with Python 2.x.
+              `open`). The default is read only ('r').
         """
         Input.__init__(self, source, source_path, encoding, error_handler)
         self.autoclose = autoclose
@@ -228,20 +398,15 @@
 
         if source is None:
             if source_path:
-                # Specify encoding in Python 3
-                if sys.version_info >= (3, 0):
-                    kwargs = {'encoding': self.encoding,
-                              'errors': self.error_handler}
-                else:
-                    kwargs = {}
                 try:
-                    self.source = open(source_path, mode, **kwargs)
-                except IOError as error:
+                    self.source = open(source_path, mode,
+                                       encoding=self.encoding or 'utf-8-sig',
+                                       errors=self.error_handler)
+                except OSError as error:
                     raise InputError(error.errno, error.strerror, source_path)
             else:
                 self.source = sys.stdin
-        elif (sys.version_info >= (3, 0) and
-              check_encoding(self.source, self.encoding) is False):
+        elif check_encoding(self.source, self.encoding) is False:
             # TODO: re-open, warn or raise error?
             raise UnicodeError('Encoding clash: encoding given is "%s" '
                                'but source is opened with encoding "%s".' %
@@ -257,27 +422,25 @@
         Read and decode a single file and return the data (Unicode string).
         """
         try:
-            if self.source is sys.stdin and sys.version_info >= (3, 0):
+            if self.source is sys.stdin:
                 # read as binary data to circumvent auto-decoding
                 data = self.source.buffer.read()
-                # normalize newlines
-                data = b'\n'.join(data.splitlines()) + b'\n'
             else:
                 data = self.source.read()
-        except (UnicodeError, LookupError) as err: # (in Py3k read() decodes)
+        except (UnicodeError, LookupError):
             if not self.encoding and self.source_path:
                 # re-read in binary mode and decode with heuristics
                 b_source = open(self.source_path, 'rb')
                 data = b_source.read()
                 b_source.close()
-                # normalize newlines
-                data = b'\n'.join(data.splitlines()) + b'\n'
             else:
                 raise
         finally:
             if self.autoclose:
                 self.close()
-        return self.decode(data)
+        data = self.decode(data)
+        # normalise newlines
+        return '\n'.join(data.splitlines()+'')
 
     def readlines(self):
         """
@@ -292,9 +455,9 @@
 
 class FileOutput(Output):
 
-    """
-    Output for single, simple file-like objects.
-    """
+    """Output for single, simple file-like objects."""
+
+    default_destination_path = '<file>'
 
     mode = 'w'
     """The mode argument for `open()`."""
@@ -325,6 +488,10 @@
                         encoding, error_handler)
         self.opened = True
         self.autoclose = autoclose
+        if handle_io_errors is not None:
+            warnings.warn('io.FileOutput: init argument "handle_io_errors" '
+                          'is ignored and will be removed in '
+                          'Docutils 2.0.', DeprecationWarning, stacklevel=2)
         if mode is not None:
             self.mode = mode
         self._stderr = ErrorOutput()
@@ -333,12 +500,12 @@
                 self.opened = False
             else:
                 self.destination = sys.stdout
-        elif (# destination is file-type object -> check mode:
+        elif (  # destination is file-type object -> check mode:
               mode and hasattr(self.destination, 'mode')
               and mode != self.destination.mode):
-                print('Warning: Destination mode "%s" differs from specified '
-                      'mode "%s"' % (self.destination.mode, mode),
-                      file=self._stderr)
+            print('Warning: Destination mode "%s" differs from specified '
+                  'mode "%s"' % (self.destination.mode, mode),
+                  file=self._stderr)
         if not destination_path:
             try:
                 self.destination_path = self.destination.name
@@ -346,53 +513,60 @@
                 pass
 
     def open(self):
-        # Specify encoding in Python 3.
-        if sys.version_info >= (3, 0) and 'b' not in self.mode:
+        # Specify encoding
+        if 'b' not in self.mode:
             kwargs = {'encoding': self.encoding,
                       'errors': self.error_handler}
         else:
             kwargs = {}
         try:
             self.destination = open(self.destination_path, self.mode, **kwargs)
-        except IOError as error:
+        except OSError as error:
             raise OutputError(error.errno, error.strerror,
                               self.destination_path)
         self.opened = True
 
     def write(self, data):
-        """Encode `data`, write it to a single file, and return it.
+        """Write `data` to a single file, also return it.
+
+        `data` can be a `str` or `bytes` instance.
+        If writing `bytes` fails, an attempt is made to write to
+        the low-level interface ``self.destination.buffer``.
+
+        If `data` is a `str` instance and `self.encoding` and
+        `self.destination.encoding` are  set to different values, `data`
+        is encoded to a `bytes` instance using `self.encoding`.
 
-        With Python 3 or binary output mode, `data` is returned unchanged,
-        except when specified encoding and output encoding differ.
+        Provisional: future versions may raise an error if `self.encoding`
+        and `self.destination.encoding` are set to different values.
         """
         if not self.opened:
             self.open()
-        if ('b' not in self.mode and sys.version_info < (3, 0)
-            or check_encoding(self.destination, self.encoding) is False
-           ):
+        if (isinstance(data, str)
+            and check_encoding(self.destination, self.encoding) is False):
+            if os.linesep != '\n':
+                data = data.replace('\n', os.linesep)  # fix endings
             data = self.encode(data)
-            if sys.version_info >= (3, 0) and os.linesep != '\n':
-                data = data.replace(b'\n', bytes(os.linesep, 'ascii')) # fix endings
 
         try:
             self.destination.write(data)
         except TypeError as err:
-            if sys.version_info >= (3, 0) and isinstance(data, bytes):
+            if isinstance(data, bytes):
                 try:
                     self.destination.buffer.write(data)
                 except AttributeError:
                     if check_encoding(self.destination,
                                       self.encoding) is False:
-                        raise ValueError('Encoding of %s (%s) differs \n'
-                            '  from specified encoding (%s)' %
-                            (self.destination_path or 'destination',
-                            self.destination.encoding, self.encoding))
+                        raise ValueError(
+                            f'Encoding of {self.destination_path} '
+                            f'({self.destination.encoding}) differs \n'
+                            f'  from specified encoding ({self.encoding})')
                     else:
                         raise err
         except (UnicodeError, LookupError) as err:
             raise UnicodeError(
                 'Unable to encode output data. output-encoding is: '
-                '%s.\n(%s)' % (self.encoding, ErrorString(err)))
+                f'{self.encoding}.\n({error_string(err)})')
         finally:
             if self.autoclose:
                 self.close()
@@ -409,60 +583,69 @@
     A version of docutils.io.FileOutput which writes to a binary file.
     """
     # Used by core.publish_cmdline_to_binary() which in turn is used by
-    # rst2odt (OpenOffice writer)
+    # tools/rst2odt.py but not by core.rst2odt().
     mode = 'wb'
 
 
 class StringInput(Input):
-
-    """
-    Direct string input.
-    """
+    """Input from a `str` or `bytes` instance."""
 
     default_source_path = '<string>'
 
     def read(self):
-        """Decode and return the source string."""
+        """Return the source as `str` instance.
+
+        Decode, if required (see `Input.decode`).
+        """
         return self.decode(self.source)
 
 
 class StringOutput(Output):
+    """Output to a `bytes` or `str` instance.
 
-    """
-    Direct string output.
+    Provisional.
     """
 
     default_destination_path = '<string>'
 
     def write(self, data):
-        """Encode `data`, store it in `self.destination`, and return it."""
+        """Store `data` in `self.destination`, and return it.
+
+        If `self.encoding` is set to the pseudo encoding name "unicode",
+        `data` must be a `str` instance and is stored/returned unchanged
+        (cf. `Output.encode`).
+
+        Otherwise, `data` can be a `bytes` or `str` instance and is
+        stored/returned as a `bytes` instance
+        (`str` data is encoded with `self.encode()`).
+
+        Attention: the `output_encoding`_ setting may affect the content
+        of the output (e.g. an encoding declaration in HTML or XML or the
+        representation of characters as LaTeX macro vs. literal character).
+        """
         self.destination = self.encode(data)
         return self.destination
 
 
 class NullInput(Input):
 
-    """
-    Degenerate input: read nothing.
-    """
+    """Degenerate input: read nothing."""
 
     default_source_path = 'null input'
 
     def read(self):
-        """Return a null string."""
-        return u''
+        """Return an empty string."""
+        return ''
 
 
 class NullOutput(Output):
 
-    """
-    Degenerate output: write nothing.
-    """
+    """Degenerate output: write nothing."""
 
     default_destination_path = 'null output'
 
     def write(self, data):
-        """Do nothing (don't even send data to the bit bucket)."""
+        """Do nothing, return None."""
         pass

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/__init__.py Changed

@@ -1,9 +1,9 @@
-# $Id: __init__.py 8467 2020-01-26 21:23:42Z milde $
+# $Id: __init__.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # Internationalization details are documented in
-# <http://docutils.sf.net/docs/howto/i18n.html>.
+# <https://docutils.sourceforge.io/docs/howto/i18n.html>.
 
 """
 This package contains modules for language-dependent features of Docutils.
@@ -11,13 +11,12 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
 from importlib import import_module
 
 from docutils.utils import normalize_language_tag
 
 
-class LanguageImporter(object):
+class LanguageImporter:
     """Import language modules.
 
     When called with a BCP 47 language tag, instances return a module
@@ -30,7 +29,7 @@
     warn_msg = ('Language "%s" not supported: '
                 'Docutils-generated text will be in English.')
     fallback = 'en'
-    # TODO: use a dummy module returning emtpy strings?, configurable?
+    # TODO: use a dummy module returning empty strings?, configurable?
 
     def __init__(self):
         self.cache = {}
@@ -44,10 +43,10 @@
                 self.check_content(module)
             except (ImportError, AttributeError):
                 if reporter and module:
-                    reporter.info('%s is no complete Docutils language module.'
-                                  %module)
+                    reporter.info(f'{module} is no complete '
+                                  'Docutils language module.')
                 elif reporter:
-                    reporter.info('Module "%s" not found.'%(package+name))
+                    reporter.info(f'Module "{package+name}" not found.')
                 continue
             break
         return module
@@ -65,7 +64,7 @@
         except KeyError:
             pass
         for tag in normalize_language_tag(language_code):
-            tag = tag.replace('-', '_') # '-' not valid in module names
+            tag = tag.replace('-', '_')  # '-' not valid in module names
             module = self.import_from_packages(tag, reporter)
             if module is not None:
                 break
@@ -75,7 +74,8 @@
             if self.fallback:
                 module = self.import_from_packages(self.fallback)
         if reporter and (language_code != 'en'):
-            reporter.info('Using %s for language "%s".'%(module, language_code))
+            reporter.info('Using %s for language "%s".'
+                          % (module, language_code))
         self.cachelanguage_code = module
         return module

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/af.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/af.py Changed

@@ -1,11 +1,11 @@
-# $Id: af.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: af.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Jannie Hofmeyr <jhsh@sun.ac.za>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Afrikaans-language mappings for language-dependent features of Docutils.
@@ -33,7 +33,7 @@
       'hint': 'Wenk',
       'important': 'Belangrik',
       'note': 'Nota',
-      'tip': 'Tip', # hint and tip both have the same translation: wenk
+      'tip': 'Tip',  # hint and tip both have the same translation: wenk
       'warning': 'Waarskuwing',
       'contents': 'Inhoud'}
 """Mapping of node class name to label text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/ar.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/ar.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/ca.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/ca.py Changed

@@ -1,11 +1,11 @@
-# $Id: ca.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: ca.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Ivan Vilata i Balaguer <ivan@selidor.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Catalan-language mappings for language-dependent features of Docutils.
@@ -15,44 +15,44 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'Autor',
-      'authors': u'Autors',
-      'organization': u'Organitzaci\u00F3',
-      'address': u'Adre\u00E7a',
-      'contact': u'Contacte',
-      'version': u'Versi\u00F3',
-      'revision': u'Revisi\u00F3',
-      'status': u'Estat',
-      'date': u'Data',
-      'copyright': u'Copyright',
-      'dedication': u'Dedicat\u00F2ria',
-      'abstract': u'Resum',
-      'attention': u'Atenci\u00F3!',
-      'caution': u'Compte!',
-      'danger': u'PERILL!',
-      'error': u'Error',
-      'hint': u'Suggeriment',
-      'important': u'Important',
-      'note': u'Nota',
-      'tip': u'Consell',
-      'warning': u'Av\u00EDs',
-      'contents': u'Contingut'}
+      'author': 'Autor',
+      'authors': 'Autors',
+      'organization': 'Organitzaci\u00F3',
+      'address': 'Adre\u00E7a',
+      'contact': 'Contacte',
+      'version': 'Versi\u00F3',
+      'revision': 'Revisi\u00F3',
+      'status': 'Estat',
+      'date': 'Data',
+      'copyright': 'Copyright',
+      'dedication': 'Dedicat\u00F2ria',
+      'abstract': 'Resum',
+      'attention': 'Atenci\u00F3!',
+      'caution': 'Compte!',
+      'danger': 'PERILL!',
+      'error': 'Error',
+      'hint': 'Suggeriment',
+      'important': 'Important',
+      'note': 'Nota',
+      'tip': 'Consell',
+      'warning': 'Av\u00EDs',
+      'contents': 'Contingut'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'autor': 'author',
-      u'autors': 'authors',
-      u'organitzaci\u00F3': 'organization',
-      u'adre\u00E7a': 'address',
-      u'contacte': 'contact',
-      u'versi\u00F3': 'version',
-      u'revisi\u00F3': 'revision',
-      u'estat': 'status',
-      u'data': 'date',
-      u'copyright': 'copyright',
-      u'dedicat\u00F2ria': 'dedication',
-      u'resum': 'abstract'}
+      'autor': 'author',
+      'autors': 'authors',
+      'organitzaci\u00F3': 'organization',
+      'adre\u00E7a': 'address',
+      'contacte': 'contact',
+      'versi\u00F3': 'version',
+      'revisi\u00F3': 'revision',
+      'estat': 'status',
+      'data': 'date',
+      'copyright': 'copyright',
+      'dedicat\u00F2ria': 'dedication',
+      'resum': 'abstract'}
 """Catalan (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/cs.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/cs.py Changed

@@ -1,11 +1,11 @@
-# $Id: cs.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: cs.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Marek Blaha <mb@dat.cz>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Czech-language mappings for language-dependent features of Docutils.
@@ -15,44 +15,44 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'Autor',
-      'authors': u'Auto\u0159i',
-      'organization': u'Organizace',
-      'address': u'Adresa',
-      'contact': u'Kontakt',
-      'version': u'Verze',
-      'revision': u'Revize',
-      'status': u'Stav',
-      'date': u'Datum',
-      'copyright': u'Copyright',
-      'dedication': u'V\u011Bnov\u00E1n\u00ED',
-      'abstract': u'Abstrakt',
-      'attention': u'Pozor!',
-      'caution': u'Opatrn\u011B!',
-      'danger': u'!NEBEZPE\u010C\u00CD!',
-      'error': u'Chyba',
-      'hint': u'Rada',
-      'important': u'D\u016Fle\u017Eit\u00E9',
-      'note': u'Pozn\u00E1mka',
-      'tip': u'Tip',
-      'warning': u'Varov\u00E1n\u00ED',
-      'contents': u'Obsah'}
+      'author': 'Autor',
+      'authors': 'Auto\u0159i',
+      'organization': 'Organizace',
+      'address': 'Adresa',
+      'contact': 'Kontakt',
+      'version': 'Verze',
+      'revision': 'Revize',
+      'status': 'Stav',
+      'date': 'Datum',
+      'copyright': 'Copyright',
+      'dedication': 'V\u011Bnov\u00E1n\u00ED',
+      'abstract': 'Abstrakt',
+      'attention': 'Pozor!',
+      'caution': 'Opatrn\u011B!',
+      'danger': '!NEBEZPE\u010C\u00CD!',
+      'error': 'Chyba',
+      'hint': 'Rada',
+      'important': 'D\u016Fle\u017Eit\u00E9',
+      'note': 'Pozn\u00E1mka',
+      'tip': 'Tip',
+      'warning': 'Varov\u00E1n\u00ED',
+      'contents': 'Obsah'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'autor': 'author',
-      u'auto\u0159i': 'authors',
-      u'organizace': 'organization',
-      u'adresa': 'address',
-      u'kontakt': 'contact',
-      u'verze': 'version',
-      u'revize': 'revision',
-      u'stav': 'status',
-      u'datum': 'date',
-      u'copyright': 'copyright',
-      u'v\u011Bnov\u00E1n\u00ED': 'dedication',
-      u'abstrakt': 'abstract'}
+      'autor': 'author',
+      'auto\u0159i': 'authors',
+      'organizace': 'organization',
+      'adresa': 'address',
+      'kontakt': 'contact',
+      'verze': 'version',
+      'revize': 'revision',
+      'stav': 'status',
+      'datum': 'date',
+      'copyright': 'copyright',
+      'v\u011Bnov\u00E1n\u00ED': 'dedication',
+      'abstrakt': 'abstract'}
 """Czech (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/da.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/da.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: da.py 7678 2013-07-03 09:57:36Z milde $
+# $Id: da.py 9030 2022-03-05 23:28:32Z milde $
 # Author: E D
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Danish-language mappings for language-dependent features of Docutils.
@@ -16,45 +15,45 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'Forfatter',
-      'authors': u'Forfattere',
-      'organization': u'Organisation',
-      'address': u'Adresse',
-      'contact': u'Kontakt',
-      'version': u'Version',
-      'revision': u'Revision',
-      'status': u'Status',
-      'date': u'Dato',
-      'copyright': u'Copyright',
-      'dedication': u'Dedikation',
-      'abstract': u'Resumé',
-      'attention': u'Giv agt!',
-      'caution': u'Pas på!',
-      'danger': u'!FARE!',
-      'error': u'Fejl',
-      'hint': u'Vink',
-      'important': u'Vigtigt',
-      'note': u'Bemærk',
-      'tip': u'Tips',
-      'warning': u'Advarsel',
-      'contents': u'Indhold'}
+      'author': 'Forfatter',
+      'authors': 'Forfattere',
+      'organization': 'Organisation',
+      'address': 'Adresse',
+      'contact': 'Kontakt',
+      'version': 'Version',
+      'revision': 'Revision',
+      'status': 'Status',
+      'date': 'Dato',
+      'copyright': 'Copyright',
+      'dedication': 'Dedikation',
+      'abstract': 'Resumé',
+      'attention': 'Giv agt!',
+      'caution': 'Pas på!',
+      'danger': '!FARE!',
+      'error': 'Fejl',
+      'hint': 'Vink',
+      'important': 'Vigtigt',
+      'note': 'Bemærk',
+      'tip': 'Tips',
+      'warning': 'Advarsel',
+      'contents': 'Indhold'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'forfatter': 'author',
-      u'forfattere': 'authors',
-      u'organisation': 'organization',
-      u'adresse': 'address',
-      u'kontakt': 'contact',
-      u'version': 'version',
-      u'revision': 'revision',
-      u'status': 'status',
-      u'dato': 'date',
-      u'copyright': 'copyright',
-      u'dedikation': 'dedication',
-      u'resume': 'abstract',
-      u'resumé': 'abstract'}
+      'forfatter': 'author',
+      'forfattere': 'authors',
+      'organisation': 'organization',
+      'adresse': 'address',
+      'kontakt': 'contact',
+      'version': 'version',
+      'revision': 'revision',
+      'status': 'status',
+      'dato': 'date',
+      'copyright': 'copyright',
+      'dedikation': 'dedication',
+      'resume': 'abstract',
+      'resumé': 'abstract'}
 """Danish (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/de.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/de.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/en.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/en.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/eo.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/eo.py Changed

@@ -1,11 +1,11 @@
-# $Id: eo.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: eo.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Marcelo Huerta San Martin <richieadler@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Esperanto-language mappings for language-dependent features of Docutils.
@@ -15,29 +15,29 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'A\u016dtoro',
-      'authors': u'A\u016dtoroj',
-      'organization': u'Organizo',
-      'address': u'Adreso',
-      'contact': u'Kontakto',
-      'version': u'Versio',
-      'revision': u'Revido',
-      'status': u'Stato',
-      'date': u'Dato',
-      # 'copyright': u'Kopirajto',
-      'copyright': u'A\u016dtorrajto',
-      'dedication': u'Dedi\u0109o',
-      'abstract': u'Resumo',
-      'attention': u'Atentu!',
-      'caution': u'Zorgu!',
-      'danger': u'DAN\u011cERO!',
-      'error': u'Eraro',
-      'hint': u'Spuro',
-      'important': u'Grava',
-      'note': u'Noto',
-      'tip': u'Helpeto',
-      'warning': u'Averto',
-      'contents': u'Enhavo'}
+      'author': 'A\u016dtoro',
+      'authors': 'A\u016dtoroj',
+      'organization': 'Organizo',
+      'address': 'Adreso',
+      'contact': 'Kontakto',
+      'version': 'Versio',
+      'revision': 'Revido',
+      'status': 'Stato',
+      'date': 'Dato',
+      # 'copyright': 'Kopirajto',
+      'copyright': 'A\u016dtorrajto',
+      'dedication': 'Dedi\u0109o',
+      'abstract': 'Resumo',
+      'attention': 'Atentu!',
+      'caution': 'Zorgu!',
+      'danger': 'DAN\u011cERO!',
+      'error': 'Eraro',
+      'hint': 'Spuro',
+      'important': 'Grava',
+      'note': 'Noto',
+      'tip': 'Helpeto',
+      'warning': 'Averto',
+      'contents': 'Enhavo'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/es.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/es.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: es.py 4572 2006-05-25 20:48:37Z richieadler $
+# $Id: es.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Marcelo Huerta San Martín <richieadler@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Spanish-language mappings for language-dependent features of Docutils.
@@ -15,43 +14,43 @@
 __docformat__ = 'reStructuredText'
 
 labels = {
-      'author': u'Autor',
-      'authors': u'Autores',
-      'organization': u'Organizaci\u00f3n',
-      'address': u'Direcci\u00f3n',
-      'contact': u'Contacto',
-      'version': u'Versi\u00f3n',
-      'revision': u'Revisi\u00f3n',
-      'status': u'Estado',
-      'date': u'Fecha',
-      'copyright': u'Copyright',
-      'dedication': u'Dedicatoria',
-      'abstract': u'Resumen',
-      'attention': u'\u00a1Atenci\u00f3n!',
-      'caution': u'\u00a1Precauci\u00f3n!',
-      'danger': u'\u00a1PELIGRO!',
-      'error': u'Error',
-      'hint': u'Sugerencia',
-      'important': u'Importante',
-      'note': u'Nota',
-      'tip': u'Consejo',
-      'warning': u'Advertencia',
-      'contents': u'Contenido'}
+      'author': 'Autor',
+      'authors': 'Autores',
+      'organization': 'Organizaci\u00f3n',
+      'address': 'Direcci\u00f3n',
+      'contact': 'Contacto',
+      'version': 'Versi\u00f3n',
+      'revision': 'Revisi\u00f3n',
+      'status': 'Estado',
+      'date': 'Fecha',
+      'copyright': 'Copyright',
+      'dedication': 'Dedicatoria',
+      'abstract': 'Resumen',
+      'attention': '\u00a1Atenci\u00f3n!',
+      'caution': '\u00a1Precauci\u00f3n!',
+      'danger': '\u00a1PELIGRO!',
+      'error': 'Error',
+      'hint': 'Sugerencia',
+      'important': 'Importante',
+      'note': 'Nota',
+      'tip': 'Consejo',
+      'warning': 'Advertencia',
+      'contents': 'Contenido'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
-      u'autor': 'author',
-      u'autores': 'authors',
-      u'organizaci\u00f3n': 'organization',
-      u'direcci\u00f3n': 'address',
-      u'contacto': 'contact',
-      u'versi\u00f3n': 'version',
-      u'revisi\u00f3n': 'revision',
-      u'estado': 'status',
-      u'fecha': 'date',
-      u'copyright': 'copyright',
-      u'dedicatoria': 'dedication',
-      u'resumen': 'abstract'}
+      'autor': 'author',
+      'autores': 'authors',
+      'organizaci\u00f3n': 'organization',
+      'direcci\u00f3n': 'address',
+      'contacto': 'contact',
+      'versi\u00f3n': 'version',
+      'revisi\u00f3n': 'revision',
+      'estado': 'status',
+      'fecha': 'date',
+      'copyright': 'copyright',
+      'dedicatoria': 'dedication',
+      'resumen': 'abstract'}
 """Spanish (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/fa.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/fa.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/fi.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/fi.py Changed

@@ -1,11 +1,11 @@
-# $Id: fi.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: fi.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Asko Soukka <asko.soukka@iki.fi>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Finnish-language mappings for language-dependent features of Docutils.
@@ -15,44 +15,44 @@
 
 labels = {
       # fixed: language-dependent
-      u'author': u'Tekij\u00e4',
-      u'authors': u'Tekij\u00e4t',
-      u'organization': u'Yhteis\u00f6',
-      u'address': u'Osoite',
-      u'contact': u'Yhteystiedot',
-      u'version': u'Versio',
-      u'revision': u'Vedos',
-      u'status': u'Tila',
-      u'date': u'P\u00e4iv\u00e4ys',
-      u'copyright': u'Tekij\u00e4noikeudet',
-      u'dedication': u'Omistuskirjoitus',
-      u'abstract': u'Tiivistelm\u00e4',
-      u'attention': u'Huomio!',
-      u'caution': u'Varo!',
-      u'danger': u'!VAARA!',
-      u'error': u'Virhe',
-      u'hint': u'Vihje',
-      u'important': u'T\u00e4rke\u00e4\u00e4',
-      u'note': u'Huomautus',
-      u'tip': u'Neuvo',
-      u'warning': u'Varoitus',
-      u'contents': u'Sis\u00e4llys'}
+      'author': 'Tekij\u00e4',
+      'authors': 'Tekij\u00e4t',
+      'organization': 'Yhteis\u00f6',
+      'address': 'Osoite',
+      'contact': 'Yhteystiedot',
+      'version': 'Versio',
+      'revision': 'Vedos',
+      'status': 'Tila',
+      'date': 'P\u00e4iv\u00e4ys',
+      'copyright': 'Tekij\u00e4noikeudet',
+      'dedication': 'Omistuskirjoitus',
+      'abstract': 'Tiivistelm\u00e4',
+      'attention': 'Huomio!',
+      'caution': 'Varo!',
+      'danger': '!VAARA!',
+      'error': 'Virhe',
+      'hint': 'Vihje',
+      'important': 'T\u00e4rke\u00e4\u00e4',
+      'note': 'Huomautus',
+      'tip': 'Neuvo',
+      'warning': 'Varoitus',
+      'contents': 'Sis\u00e4llys'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'tekij\u00e4': u'author',
-      u'tekij\u00e4t': u'authors',
-      u'yhteis\u00f6': u'organization',
-      u'osoite': u'address',
-      u'yhteystiedot': u'contact',
-      u'versio': u'version',
-      u'vedos': u'revision',
-      u'tila': u'status',
-      u'p\u00e4iv\u00e4ys': u'date',
-      u'tekij\u00e4noikeudet': u'copyright',
-      u'omistuskirjoitus': u'dedication',
-      u'tiivistelm\u00e4': u'abstract'}
+      'tekij\u00e4': 'author',
+      'tekij\u00e4t': 'authors',
+      'yhteis\u00f6': 'organization',
+      'osoite': 'address',
+      'yhteystiedot': 'contact',
+      'versio': 'version',
+      'vedos': 'revision',
+      'tila': 'status',
+      'p\u00e4iv\u00e4ys': 'date',
+      'tekij\u00e4noikeudet': 'copyright',
+      'omistuskirjoitus': 'dedication',
+      'tiivistelm\u00e4': 'abstract'}
 """Finnish (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/fr.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/fr.py Changed

@@ -1,11 +1,11 @@
-# $Id: fr.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: fr.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Stefane Fermigier <sf@fermigier.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 French-language mappings for language-dependent features of Docutils.
@@ -14,43 +14,43 @@
 __docformat__ = 'reStructuredText'
 
 labels = {
-      u'author': u'Auteur',
-      u'authors': u'Auteurs',
-      u'organization': u'Organisation',
-      u'address': u'Adresse',
-      u'contact': u'Contact',
-      u'version': u'Version',
-      u'revision': u'R\u00e9vision',
-      u'status': u'Statut',
-      u'date': u'Date',
-      u'copyright': u'Copyright',
-      u'dedication': u'D\u00e9dicace',
-      u'abstract': u'R\u00e9sum\u00e9',
-      u'attention': u'Attention!',
-      u'caution': u'Avertissement!',
-      u'danger': u'!DANGER!',
-      u'error': u'Erreur',
-      u'hint': u'Indication',
-      u'important': u'Important',
-      u'note': u'Note',
-      u'tip': u'Astuce',
-      u'warning': u'Avis',
-      u'contents': u'Sommaire'}
+      'author': 'Auteur',
+      'authors': 'Auteurs',
+      'organization': 'Organisation',
+      'address': 'Adresse',
+      'contact': 'Contact',
+      'version': 'Version',
+      'revision': 'R\u00e9vision',
+      'status': 'Statut',
+      'date': 'Date',
+      'copyright': 'Copyright',
+      'dedication': 'D\u00e9dicace',
+      'abstract': 'R\u00e9sum\u00e9',
+      'attention': 'Attention!',
+      'caution': 'Avertissement!',
+      'danger': '!DANGER!',
+      'error': 'Erreur',
+      'hint': 'Indication',
+      'important': 'Important',
+      'note': 'Note',
+      'tip': 'Astuce',
+      'warning': 'Avis',
+      'contents': 'Sommaire'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
-      u'auteur': u'author',
-      u'auteurs': u'authors',
-      u'organisation': u'organization',
-      u'adresse': u'address',
-      u'contact': u'contact',
-      u'version': u'version',
-      u'r\u00e9vision': u'revision',
-      u'statut': u'status',
-      u'date': u'date',
-      u'copyright': u'copyright',
-      u'd\u00e9dicace': u'dedication',
-      u'r\u00e9sum\u00e9': u'abstract'}
+      'auteur': 'author',
+      'auteurs': 'authors',
+      'organisation': 'organization',
+      'adresse': 'address',
+      'contact': 'contact',
+      'version': 'version',
+      'r\u00e9vision': 'revision',
+      'statut': 'status',
+      'date': 'date',
+      'copyright': 'copyright',
+      'd\u00e9dicace': 'dedication',
+      'r\u00e9sum\u00e9': 'abstract'}
 """French (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/gl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/gl.py Changed

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Author: David Goodger
 # Contact: goodger@users.sourceforge.net
 # Revision: $Revision: 2224 $
@@ -6,9 +5,9 @@
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Galician-language mappings for language-dependent features of Docutils.
@@ -18,44 +17,44 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'Autor',
-      'authors': u'Autores',
-      'organization': u'Organizaci\u00f3n',
-      'address': u'Enderezo',
-      'contact': u'Contacto',
-      'version': u'Versi\u00f3n',
-      'revision': u'Revisi\u00f3n',
-      'status': u'Estado',
-      'date': u'Data',
-      'copyright': u'Dereitos de copia',
-      'dedication': u'Dedicatoria',
-      'abstract': u'Abstract',
-      'attention': u'Atenci\u00f3n!',
-      'caution': u'Advertencia!',
-      'danger': u'PERIGO!',
-      'error': u'Erro',
-      'hint': u'Consello',
-      'important': u'Importante',
-      'note': u'Nota',
-      'tip': u'Suxesti\u00f3n',
-      'warning': u'Aviso',
-      'contents': u'Contido'}
+      'author': 'Autor',
+      'authors': 'Autores',
+      'organization': 'Organizaci\u00f3n',
+      'address': 'Enderezo',
+      'contact': 'Contacto',
+      'version': 'Versi\u00f3n',
+      'revision': 'Revisi\u00f3n',
+      'status': 'Estado',
+      'date': 'Data',
+      'copyright': 'Dereitos de copia',
+      'dedication': 'Dedicatoria',
+      'abstract': 'Abstract',
+      'attention': 'Atenci\u00f3n!',
+      'caution': 'Advertencia!',
+      'danger': 'PERIGO!',
+      'error': 'Erro',
+      'hint': 'Consello',
+      'important': 'Importante',
+      'note': 'Nota',
+      'tip': 'Suxesti\u00f3n',
+      'warning': 'Aviso',
+      'contents': 'Contido'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'autor': 'author',
-      u'autores': 'authors',
-      u'organizaci\u00f3n': 'organization',
-      u'enderezo': 'address',
-      u'contacto': 'contact',
-      u'versi\u00f3n': 'version',
-      u'revisi\u00f3n': 'revision',
-      u'estado': 'status',
-      u'data': 'date',
-      u'dereitos de copia': 'copyright',
-      u'dedicatoria': 'dedication',
-      u'abstract': 'abstract'}
+      'autor': 'author',
+      'autores': 'authors',
+      'organizaci\u00f3n': 'organization',
+      'enderezo': 'address',
+      'contacto': 'contact',
+      'versi\u00f3n': 'version',
+      'revisi\u00f3n': 'revision',
+      'estado': 'status',
+      'data': 'date',
+      'dereitos de copia': 'copyright',
+      'dedicatoria': 'dedication',
+      'abstract': 'abstract'}
 """Galician (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/he.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/he.py Changed

@@ -1,11 +1,11 @@
 # Author: Meir Kriheli
-# Id: $Id: he.py 4837 2006-12-26 09:59:41Z sfcben $
+# Id: $Id: he.py 9030 2022-03-05 23:28:32Z milde $
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Hebrew-language mappings for language-dependent features of Docutils.
@@ -15,44 +15,45 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'\u05de\u05d7\u05d1\u05e8',
-      'authors': u'\u05de\u05d7\u05d1\u05e8\u05d9',
-      'organization': u'\u05d0\u05e8\u05d2\u05d5\u05df',
-      'address': u'\u05db\u05ea\u05d5\u05d1\u05ea',
-      'contact':  u'\u05d0\u05d9\u05e9 \u05e7\u05e9\u05e8',
-      'version': u'\u05d2\u05e8\u05e1\u05d4',
-      'revision': u'\u05de\u05d4\u05d3\u05d5\u05e8\u05d4',
-      'status': u'\u05e1\u05d8\u05d8\u05d5\u05e1',
-      'date': u'\u05ea\u05d0\u05e8\u05d9\u05da',
-      'copyright': u'\u05d6\u05db\u05d5\u05d9\u05d5\u05ea \u05e9\u05de\u05d5\u05e8\u05d5\u05ea',
-      'dedication': u'\u05d4\u05e7\u05d3\u05e9\u05d4',
-      'abstract': u'\u05ea\u05e7\u05e6\u05d9\u05e8',
-      'attention': u'\u05ea\u05e9\u05d5\u05de\u05ea \u05dc\u05d1',
-      'caution': u'\u05d6\u05d4\u05d9\u05e8\u05d5\u05ea',
-      'danger': u'\u05e1\u05db\u05e0\u05d4',
-      'error': u'\u05e9\u05d2\u05d9\u05d0\u05d4' ,
-      'hint': u'\u05e8\u05de\u05d6',
-      'important': u'\u05d7\u05e9\u05d5\u05d1',
-      'note': u'\u05d4\u05e2\u05e8\u05d4',
-      'tip': u'\u05d8\u05d9\u05e4',
-      'warning': u'\u05d0\u05d6\u05d4\u05e8\u05d4',
-      'contents': u'\u05ea\u05d5\u05db\u05df'}
+      'author': '\u05de\u05d7\u05d1\u05e8',
+      'authors': '\u05de\u05d7\u05d1\u05e8\u05d9',
+      'organization': '\u05d0\u05e8\u05d2\u05d5\u05df',
+      'address': '\u05db\u05ea\u05d5\u05d1\u05ea',
+      'contact': '\u05d0\u05d9\u05e9 \u05e7\u05e9\u05e8',
+      'version': '\u05d2\u05e8\u05e1\u05d4',
+      'revision': '\u05de\u05d4\u05d3\u05d5\u05e8\u05d4',
+      'status': '\u05e1\u05d8\u05d8\u05d5\u05e1',
+      'date': '\u05ea\u05d0\u05e8\u05d9\u05da',
+      'copyright': ('\u05d6\u05db\u05d5\u05d9\u05d5\u05ea '
+                    '\u05e9\u05de\u05d5\u05e8\u05d5\u05ea'),
+      'dedication': '\u05d4\u05e7\u05d3\u05e9\u05d4',
+      'abstract': '\u05ea\u05e7\u05e6\u05d9\u05e8',
+      'attention': '\u05ea\u05e9\u05d5\u05de\u05ea \u05dc\u05d1',
+      'caution': '\u05d6\u05d4\u05d9\u05e8\u05d5\u05ea',
+      'danger': '\u05e1\u05db\u05e0\u05d4',
+      'error': '\u05e9\u05d2\u05d9\u05d0\u05d4',
+      'hint': '\u05e8\u05de\u05d6',
+      'important': '\u05d7\u05e9\u05d5\u05d1',
+      'note': '\u05d4\u05e2\u05e8\u05d4',
+      'tip': '\u05d8\u05d9\u05e4',
+      'warning': '\u05d0\u05d6\u05d4\u05e8\u05d4',
+      'contents': '\u05ea\u05d5\u05db\u05df'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'\u05de\u05d7\u05d1\u05e8': 'author',
-      u'\u05de\u05d7\u05d1\u05e8\u05d9': 'authors',
-      u'\u05d0\u05e8\u05d2\u05d5\u05df': 'organization',
-      u'\u05db\u05ea\u05d5\u05d1\u05ea': 'address',
-      u'\u05d0\u05d9\u05e9 \u05e7\u05e9\u05e8': 'contact',
-      u'\u05d2\u05e8\u05e1\u05d4': 'version',
-      u'\u05de\u05d4\u05d3\u05d5\u05e8\u05d4': 'revision',
-      u'\u05e1\u05d8\u05d8\u05d5\u05e1': 'status',
-      u'\u05ea\u05d0\u05e8\u05d9\u05da': 'date',
-      u'\u05d6\u05db\u05d5\u05d9\u05d5\u05ea \u05e9\u05de\u05d5\u05e8\u05d5\u05ea': 'copyright',
-      u'\u05d4\u05e7\u05d3\u05e9\u05d4': 'dedication',
-      u'\u05ea\u05e7\u05e6\u05d9\u05e8': 'abstract'}
+      '\u05de\u05d7\u05d1\u05e8': 'author',
+      '\u05de\u05d7\u05d1\u05e8\u05d9': 'authors',
+      '\u05d0\u05e8\u05d2\u05d5\u05df': 'organization',
+      '\u05db\u05ea\u05d5\u05d1\u05ea': 'address',
+      '\u05d0\u05d9\u05e9 \u05e7\u05e9\u05e8': 'contact',
+      '\u05d2\u05e8\u05e1\u05d4': 'version',
+      '\u05de\u05d4\u05d3\u05d5\u05e8\u05d4': 'revision',
+      '\u05e1\u05d8\u05d8\u05d5\u05e1': 'status',
+      '\u05ea\u05d0\u05e8\u05d9\u05da': 'date',
+      '\u05d6\u05db\u05d5\u05d9\u05d5\u05ea \u05e9\u05de\u05d5\u05e8\u05d5\u05ea': 'copyright',  # noqa:E501
+      '\u05d4\u05e7\u05d3\u05e9\u05d4': 'dedication',
+      '\u05ea\u05e7\u05e6\u05d9\u05e8': 'abstract'}
 """Hebrew to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/it.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/it.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/ja.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/ja.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: ja.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: ja.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Hisashi Morita <hisashim@kt.rim.or.jp>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Japanese-language mappings for language-dependent features of Docutils.
@@ -16,44 +15,44 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'著者',
-      'authors': u'著者',
-      'organization': u'組織',
-      'address': u'住所',
-      'contact': u'連絡先',
-      'version': u'バージョン',
-      'revision': u'リビジョン',
-      'status': u'ステータス',
-      'date': u'日付',
-      'copyright': u'著作権',
-      'dedication': u'献辞',
-      'abstract': u'概要',
-      'attention': u'注目!',
-      'caution': u'注意!',
-      'danger': u'!危険!',
-      'error': u'エラー',
-      'hint': u'ヒント',
-      'important': u'重要',
-      'note': u'備考',
-      'tip': u'通報',
-      'warning': u'警告',
-      'contents': u'目次'}
+      'author': '著者',
+      'authors': '著者',
+      'organization': '組織',
+      'address': '住所',
+      'contact': '連絡先',
+      'version': 'バージョン',
+      'revision': 'リビジョン',
+      'status': 'ステータス',
+      'date': '日付',
+      'copyright': '著作権',
+      'dedication': '献辞',
+      'abstract': '概要',
+      'attention': '注目!',
+      'caution': '注意!',
+      'danger': '!危険!',
+      'error': 'エラー',
+      'hint': 'ヒント',
+      'important': '重要',
+      'note': '備考',
+      'tip': '通報',
+      'warning': '警告',
+      'contents': '目次'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'著者': 'author',
-      u' n/a': 'authors',
-      u'組織': 'organization',
-      u'住所': 'address',
-      u'連絡先': 'contact',
-      u'バージョン': 'version',
-      u'リビジョン': 'revision',
-      u'ステータス': 'status',
-      u'日付': 'date',
-      u'著作権': 'copyright',
-      u'献辞': 'dedication',
-      u'概要': 'abstract'}
+      '著者': 'author',
+      ' n/a': 'authors',
+      '組織': 'organization',
+      '住所': 'address',
+      '連絡先': 'contact',
+      'バージョン': 'version',
+      'リビジョン': 'revision',
+      'ステータス': 'status',
+      '日付': 'date',
+      '著作権': 'copyright',
+      '献辞': 'dedication',
+      '概要': 'abstract'}
 """Japanese (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/ko.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/ko.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/lt.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/lt.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: lt.py 7911 2015-08-31 08:23:06Z milde $
+# $Id: lt.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Dalius Dobravolskas <dalius.do...@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Lithuanian language mappings for language-dependent features of Docutils.
@@ -23,20 +22,20 @@
       'contact': 'Kontaktas',
       'version': 'Versija',
       'revision': 'Revizija',
-      'status': u'Būsena',
+      'status': 'Būsena',
       'date': 'Data',
-      'copyright': u'Autoriaus teisės',
+      'copyright': 'Autoriaus teisės',
       'dedication': 'Dedikacija',
       'abstract': 'Santrauka',
-      'attention': u'Dėmesio!',
+      'attention': 'Dėmesio!',
       'caution': 'Atsargiai!',
       'danger': '!PAVOJINGA!',
       'error': 'Klaida',
-      'hint': u'Užuomina',
+      'hint': 'Užuomina',
       'important': 'Svarbu',
       'note': 'Pastaba',
       'tip': 'Patarimas',
-      'warning': u'Įspėjimas',
+      'warning': 'Įspėjimas',
       'contents': 'Turinys'}
 """Mapping of node class name to label text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/lv.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/lv.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/nl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/nl.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/pl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/pl.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/pt_br.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/pt_br.py Changed

@@ -1,59 +1,59 @@
-# $Id: pt_br.py 5567 2008-06-03 01:11:03Z goodger $
+# $Id: pt_br.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
-Brazilian Portuguese-language mappings for language-dependent features of Docutils.
+Brazilian Portuguese-language mappings for language-dependent features.
 """
 
 __docformat__ = 'reStructuredText'
 
 labels = {
       # fixed: language-dependent
-      'author': u'Autor',
-      'authors': u'Autores',
-      'organization': u'Organiza\u00E7\u00E3o',
-      'address': u'Endere\u00E7o',
-      'contact': u'Contato',
-      'version': u'Vers\u00E3o',
-      'revision': u'Revis\u00E3o',
-      'status': u'Estado',
-      'date': u'Data',
-      'copyright': u'Copyright',
-      'dedication': u'Dedicat\u00F3ria',
-      'abstract': u'Resumo',
-      'attention': u'Aten\u00E7\u00E3o!',
-      'caution': u'Cuidado!',
-      'danger': u'PERIGO!',
-      'error': u'Erro',
-      'hint': u'Sugest\u00E3o',
-      'important': u'Importante',
-      'note': u'Nota',
-      'tip': u'Dica',
-      'warning': u'Aviso',
-      'contents': u'Sum\u00E1rio'}
+      'author': 'Autor',
+      'authors': 'Autores',
+      'organization': 'Organiza\u00E7\u00E3o',
+      'address': 'Endere\u00E7o',
+      'contact': 'Contato',
+      'version': 'Vers\u00E3o',
+      'revision': 'Revis\u00E3o',
+      'status': 'Estado',
+      'date': 'Data',
+      'copyright': 'Copyright',
+      'dedication': 'Dedicat\u00F3ria',
+      'abstract': 'Resumo',
+      'attention': 'Aten\u00E7\u00E3o!',
+      'caution': 'Cuidado!',
+      'danger': 'PERIGO!',
+      'error': 'Erro',
+      'hint': 'Sugest\u00E3o',
+      'important': 'Importante',
+      'note': 'Nota',
+      'tip': 'Dica',
+      'warning': 'Aviso',
+      'contents': 'Sum\u00E1rio'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'autor': 'author',
-      u'autores': 'authors',
-      u'organiza\u00E7\u00E3o': 'organization',
-      u'endere\u00E7o': 'address',
-      u'contato': 'contact',
-      u'vers\u00E3o': 'version',
-      u'revis\u00E3o': 'revision',
-      u'estado': 'status',
-      u'data': 'date',
-      u'copyright': 'copyright',
-      u'dedicat\u00F3ria': 'dedication',
-      u'resumo': 'abstract'}
-"""Brazilian Portuguese (lowcased) to canonical name mapping for bibliographic fields."""
+      'autor': 'author',
+      'autores': 'authors',
+      'organiza\u00E7\u00E3o': 'organization',
+      'endere\u00E7o': 'address',
+      'contato': 'contact',
+      'vers\u00E3o': 'version',
+      'revis\u00E3o': 'revision',
+      'estado': 'status',
+      'data': 'date',
+      'copyright': 'copyright',
+      'dedicat\u00F3ria': 'dedication',
+      'resumo': 'abstract'}
+"""Brazilian Portuguese (lowcased) name mapping for bibliographic fields."""
 
 author_separators = ';', ','
 """List of separator strings for the 'Authors' bibliographic field. Tried in

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/ru.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/ru.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: ru.py 7125 2011-09-16 18:36:18Z milde $
+# $Id: ru.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Roman Suzi <rnd@onego.ru>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Russian-language mappings for language-dependent features of Docutils.
@@ -15,45 +14,45 @@
 __docformat__ = 'reStructuredText'
 
 labels = {
-      u'abstract': u'Аннотация',
-      u'address': u'Адрес',
-      u'attention': u'Внимание!',
-      u'author': u'Автор',
-      u'authors': u'Авторы',
-      u'caution': u'Осторожно!',
-      u'contact': u'Контакт',
-      u'contents': u'Содержание',
-      u'copyright': u'Права копирования',
-      u'danger': u'ОПАСНО!',
-      u'date': u'Дата',
-      u'dedication': u'Посвящение',
-      u'error': u'Ошибка',
-      u'hint': u'Совет',
-      u'important': u'Важно',
-      u'note': u'Примечание',
-      u'organization': u'Организация',
-      u'revision': u'Редакция',
-      u'status': u'Статус',
-      u'tip': u'Подсказка',
-      u'version': u'Версия',
-      u'warning': u'Предупреждение'}
+      'abstract': 'Аннотация',
+      'address': 'Адрес',
+      'attention': 'Внимание!',
+      'author': 'Автор',
+      'authors': 'Авторы',
+      'caution': 'Осторожно!',
+      'contact': 'Контакт',
+      'contents': 'Содержание',
+      'copyright': 'Права копирования',
+      'danger': 'ОПАСНО!',
+      'date': 'Дата',
+      'dedication': 'Посвящение',
+      'error': 'Ошибка',
+      'hint': 'Совет',
+      'important': 'Важно',
+      'note': 'Примечание',
+      'organization': 'Организация',
+      'revision': 'Редакция',
+      'status': 'Статус',
+      'tip': 'Подсказка',
+      'version': 'Версия',
+      'warning': 'Предупреждение'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
-      u'аннотация': u'abstract',
-      u'адрес': u'address',
-      u'автор': u'author',
-      u'авторы': u'authors',
-      u'контакт': u'contact',
-      u'права копирования': u'copyright',
-      u'дата': u'date',
-      u'посвящение': u'dedication',
-      u'организация': u'organization',
-      u'редакция': u'revision',
-      u'статус': u'status',
-      u'версия': u'version'}
+      'аннотация': 'abstract',
+      'адрес': 'address',
+      'автор': 'author',
+      'авторы': 'authors',
+      'контакт': 'contact',
+      'права копирования': 'copyright',
+      'дата': 'date',
+      'посвящение': 'dedication',
+      'организация': 'organization',
+      'редакция': 'revision',
+      'статус': 'status',
+      'версия': 'version'}
 """Russian (lowcased) to canonical name mapping for bibliographic fields."""
 
-author_separators =  ';', ','
+author_separators = ';', ','
 """List of separator strings for the 'Authors' bibliographic field. Tried in
 order."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/sk.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/sk.py Changed

@@ -1,11 +1,11 @@
-# $Id: sk.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: sk.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Miroslav Vasko <zemiak@zoznam.sk>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Slovak-language mappings for language-dependent features of Docutils.
@@ -14,43 +14,43 @@
 __docformat__ = 'reStructuredText'
 
 labels = {
-      'author': u'Autor',
-      'authors': u'Autori',
-      'organization': u'Organiz\u00E1cia',
-      'address': u'Adresa',
-      'contact': u'Kontakt',
-      'version': u'Verzia',
-      'revision': u'Rev\u00EDzia',
-      'status': u'Stav',
-      'date': u'D\u00E1tum',
-      'copyright': u'Copyright',
-      'dedication': u'Venovanie',
-      'abstract': u'Abstraktne',
-      'attention': u'Pozor!',
-      'caution': u'Opatrne!',
-      'danger': u'!NEBEZPE\u010cENSTVO!',
-      'error': u'Chyba',
-      'hint': u'Rada',
-      'important': u'D\u00F4le\u017Eit\u00E9',
-      'note': u'Pozn\u00E1mka',
-      'tip': u'Tip',
-      'warning': u'Varovanie',
-      'contents': u'Obsah'}
+      'author': 'Autor',
+      'authors': 'Autori',
+      'organization': 'Organiz\u00E1cia',
+      'address': 'Adresa',
+      'contact': 'Kontakt',
+      'version': 'Verzia',
+      'revision': 'Rev\u00EDzia',
+      'status': 'Stav',
+      'date': 'D\u00E1tum',
+      'copyright': 'Copyright',
+      'dedication': 'Venovanie',
+      'abstract': 'Abstraktne',
+      'attention': 'Pozor!',
+      'caution': 'Opatrne!',
+      'danger': '!NEBEZPE\u010cENSTVO!',
+      'error': 'Chyba',
+      'hint': 'Rada',
+      'important': 'D\u00F4le\u017Eit\u00E9',
+      'note': 'Pozn\u00E1mka',
+      'tip': 'Tip',
+      'warning': 'Varovanie',
+      'contents': 'Obsah'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
-      u'autor': 'author',
-      u'autori': 'authors',
-      u'organiz\u00E1cia': 'organization',
-      u'adresa': 'address',
-      u'kontakt': 'contact',
-      u'verzia': 'version',
-      u'rev\u00EDzia': 'revision',
-      u'stav': 'status',
-      u'd\u00E1tum': 'date',
-      u'copyright': 'copyright',
-      u'venovanie': 'dedication',
-      u'abstraktne': 'abstract'}
+      'autor': 'author',
+      'autori': 'authors',
+      'organiz\u00E1cia': 'organization',
+      'adresa': 'address',
+      'kontakt': 'contact',
+      'verzia': 'version',
+      'rev\u00EDzia': 'revision',
+      'stav': 'status',
+      'd\u00E1tum': 'date',
+      'copyright': 'copyright',
+      'venovanie': 'dedication',
+      'abstraktne': 'abstract'}
 """Slovak (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/sv.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/sv.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: sv.py 8006 2016-12-22 23:02:44Z milde $
+# $Id: sv.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Adam Chodorowski <chodorowski@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Swedish language mappings for language-dependent features of Docutils.
@@ -15,44 +14,44 @@
 __docformat__ = 'reStructuredText'
 
 labels = {
-    'author':       u'Författare',
-    'authors':      u'Författare',
-    'organization': u'Organisation',
-    'address':      u'Adress',
-    'contact':      u'Kontakt',
-    'version':      u'Version',
-    'revision':     u'Revision',
-    'status':       u'Status',
-    'date':         u'Datum',
-    'copyright':    u'Copyright',
-    'dedication':   u'Dedikation',
-    'abstract':     u'Sammanfattning',
-    'attention':    u'Observera!',
-    'caution':      u'Akta!', # 'Varning' already used for 'warning'
-    'danger':       u'FARA!',
-    'error':        u'Fel',
-    'hint':         u'Vink',
-    'important':    u'Viktigt',
-    'note':         u'Notera',
-    'tip':          u'Tips',
-    'warning':      u'Varning',
-    'contents':     u'Innehåll' }
+    'author': 'Författare',
+    'authors': 'Författare',
+    'organization': 'Organisation',
+    'address': 'Adress',
+    'contact': 'Kontakt',
+    'version': 'Version',
+    'revision': 'Revision',
+    'status': 'Status',
+    'date': 'Datum',
+    'copyright': 'Copyright',
+    'dedication': 'Dedikation',
+    'abstract': 'Sammanfattning',
+    'attention': 'Observera!',
+    'caution': 'Akta!',  # 'Varning' already used for 'warning'
+    'danger': 'FARA!',
+    'error': 'Fel',
+    'hint': 'Vink',
+    'important': 'Viktigt',
+    'note': 'Notera',
+    'tip': 'Tips',
+    'warning': 'Varning',
+    'contents': 'Innehåll'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
     # 'Author' and 'Authors' identical in Swedish; assume the plural:
-    u'författare': 'authors',
-    u' n/a':            'author',
-    u'organisation':    'organization',
-    u'adress':          'address',
-    u'kontakt':         'contact',
-    u'version':         'version',
-    u'revision':        'revision',
-    u'status':          'status',
-    u'datum':           'date',
-    u'copyright':       'copyright',
-    u'dedikation':      'dedication', 
-    u'sammanfattning':  'abstract' }
+    'författare': 'authors',
+    ' n/a': 'author',
+    'organisation': 'organization',
+    'adress': 'address',
+    'kontakt': 'contact',
+    'version': 'version',
+    'revision': 'revision',
+    'status': 'status',
+    'datum': 'date',
+    'copyright': 'copyright',
+    'dedikation': 'dedication',
+    'sammanfattning': 'abstract'}
 """Swedish (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ','

_service:tar_scm:docutils-0.20.tar.gz/docutils/languages/uk.py Added

@@ -0,0 +1,58 @@
+# $Id: uk.py 9114 2022-07-28 17:06:10Z milde $
+# Author: Dmytro Kazanzhy <dkazanzhy@gmail.com>
+# Copyright: This module has been placed in the public domain.
+
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
+"""
+Ukrainian-language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+labels = {
+      'abstract': 'Анотація',
+      'address': 'Адреса',
+      'attention': 'Увага!',
+      'author': 'Автор',
+      'authors': 'Автори',
+      'caution': 'Обережно!',
+      'contact': 'Контакт',
+      'contents': 'Зміст',
+      'copyright': 'Права копіювання',
+      'danger': 'НЕБЕЗПЕЧНО!',
+      'date': 'Дата',
+      'dedication': 'Посвячення',
+      'error': 'Помилка',
+      'hint': 'Порада',
+      'important': 'Важливо',
+      'note': 'Примітка',
+      'organization': 'Організація',
+      'revision': 'Редакція',
+      'status': 'Статус',
+      'tip': 'Підказка',
+      'version': 'Версія',
+      'warning': 'Попередження'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+      'анотація': 'abstract',
+      'адреса': 'address',
+      'автор': 'author',
+      'автори': 'authors',
+      'контакт': 'contact',
+      'права копіювання': 'copyright',
+      'дата': 'date',
+      'посвячення': 'dedication',
+      'організація': 'organization',
+      'редакція': 'revision',
+      'статус': 'status',
+      'версія': 'version'}
+"""Ukrainian (lowcased) to canonical name mapping for bibliographic fields."""
+
+author_separators = ';', ','
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/zh_cn.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/zh_cn.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: zh_cn.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: zh_cn.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Pan Junyong <panjy@zopechina.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Simplified Chinese language mappings for language-dependent features
@@ -17,51 +16,51 @@
 
 labels = {
       # fixed: language-dependent
-      'author': u'作者',
-      'authors': u'作者群',
-      'organization': u'组织',
-      'address': u'地址',
-      'contact': u'联系',
-      'version': u'版本',
-      'revision': u'修订',
-      'status': u'状态',
-      'date': u'日期',
-      'copyright': u'版权',
-      'dedication': u'献辞',
-      'abstract': u'摘要',
-      'attention': u'注意',
-      'caution': u'小心',
-      'danger': u'危险',
-      'error': u'错误',
-      'hint': u'提示',
-      'important': u'重要',
-      'note': u'注解',
-      'tip': u'技巧',
-      'warning': u'警告',
-      'contents': u'目录',
-} 
+      'author': '作者',
+      'authors': '作者群',
+      'organization': '组织',
+      'address': '地址',
+      'contact': '联系',
+      'version': '版本',
+      'revision': '修订',
+      'status': '状态',
+      'date': '日期',
+      'copyright': '版权',
+      'dedication': '献辞',
+      'abstract': '摘要',
+      'attention': '注意',
+      'caution': '小心',
+      'danger': '危险',
+      'error': '错误',
+      'hint': '提示',
+      'important': '重要',
+      'note': '注解',
+      'tip': '技巧',
+      'warning': '警告',
+      'contents': '目录',
+}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
-      u'作者': 'author',
-      u'作者群': 'authors',
-      u'组织': 'organization',
-      u'地址': 'address',
-      u'联系': 'contact',
-      u'版本': 'version',
-      u'修订': 'revision',
-      u'状态': 'status',
-      u'时间': 'date',
-      u'版权': 'copyright',
-      u'献辞': 'dedication',
-      u'摘要': 'abstract'}
+      '作者': 'author',
+      '作者群': 'authors',
+      '组织': 'organization',
+      '地址': 'address',
+      '联系': 'contact',
+      '版本': 'version',
+      '修订': 'revision',
+      '状态': 'status',
+      '时间': 'date',
+      '版权': 'copyright',
+      '献辞': 'dedication',
+      '摘要': 'abstract'}
 """Simplified Chinese to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ',',
-                     u'\uff1b', # '；'
-                     u'\uff0c', # '，'
-                     u'\u3001', # '、'
-                    
+                     '\uff1b',  # '；'
+                     '\uff0c',  # '，'
+                     '\u3001',  # '、'
+                     
 """List of separator strings for the 'Authors' bibliographic field. Tried in
 order."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/languages/zh_tw.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/languages/zh_tw.py Changed

@@ -1,44 +1,43 @@
-# -*- coding: utf-8 -*-
-# $Id: zh_tw.py 4564 2006-05-21 20:44:42Z wiemann $
+# $Id: zh_tw.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Joe YS Jaw <joeysj@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
-Traditional Chinese language mappings for language-dependent features of Docutils.
+Traditional Chinese language mappings for language-dependent features.
 """
 
 __docformat__ = 'reStructuredText'
 
 labels = {
       # fixed: language-dependent
-      'author': u'\u4f5c\u8005', # '作者' <-- Chinese word
-      'authors': u'\u4f5c\u8005\u7fa4', # '作者群',
-      'organization': u'\u7d44\u7e54', # '組織',
-      'address': u'\u5730\u5740', # '地址',
-      'contact': u'\u9023\u7d61', # '連絡',
-      'version': u'\u7248\u672c', # '版本',
-      'revision': u'\u4fee\u8a02', # '修訂',
-      'status': u'\u72c0\u614b', # '狀態',
-      'date': u'\u65e5\u671f', # '日期',
-      'copyright': u'\u7248\u6b0a', # '版權',
-      'dedication': u'\u984c\u737b', # '題獻',
-      'abstract': u'\u6458\u8981', # '摘要',
-      'attention': u'\u6ce8\u610f\uff01', # '注意！',
-      'caution': u'\u5c0f\u5fc3\uff01', # '小心！',
-      'danger': u'\uff01\u5371\u96aa\uff01', # '！危險！',
-      'error': u'\u932f\u8aa4', # '錯誤',
-      'hint': u'\u63d0\u793a', # '提示',
-      'important': u'\u91cd\u8981', # '注意！',
-      'note': u'\u8a3b\u91cb', # '註釋',
-      'tip': u'\u79d8\u8a23', # '秘訣',
-      'warning': u'\u8b66\u544a', # '警告',
-      'contents': u'\u76ee\u9304' # '目錄'
-} 
+      'author': '\u4f5c\u8005',  # '作者' <-- Chinese word
+      'authors': '\u4f5c\u8005\u7fa4',  # '作者群',
+      'organization': '\u7d44\u7e54',  # '組織',
+      'address': '\u5730\u5740',  # '地址',
+      'contact': '\u9023\u7d61',  # '連絡',
+      'version': '\u7248\u672c',  # '版本',
+      'revision': '\u4fee\u8a02',  # '修訂',
+      'status': '\u72c0\u614b',  # '狀態',
+      'date': '\u65e5\u671f',  # '日期',
+      'copyright': '\u7248\u6b0a',  # '版權',
+      'dedication': '\u984c\u737b',  # '題獻',
+      'abstract': '\u6458\u8981',  # '摘要',
+      'attention': '\u6ce8\u610f\uff01',  # '注意！',
+      'caution': '\u5c0f\u5fc3\uff01',  # '小心！',
+      'danger': '\uff01\u5371\u96aa\uff01',  # '！危險！',
+      'error': '\u932f\u8aa4',  # '錯誤',
+      'hint': '\u63d0\u793a',  # '提示',
+      'important': '\u91cd\u8981',  # '注意！',
+      'note': '\u8a3b\u91cb',  # '註釋',
+      'tip': '\u79d8\u8a23',  # '秘訣',
+      'warning': '\u8b66\u544a',  # '警告',
+      'contents': '\u76ee\u9304',  # '目錄'
+}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
@@ -58,9 +57,9 @@
 """Traditional Chinese to canonical name mapping for bibliographic fields."""
 
 author_separators = ';', ',',
-                     u'\uff1b', # '；'
-                     u'\uff0c', # '，'
-                     u'\u3001', # '、'
-                    
+                     '\uff1b',  # '；'
+                     '\uff0c',  # '，'
+                     '\u3001',  # '、'
+                     
 """List of separator strings for the 'Authors' bibliographic field. Tried in
 order."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/nodes.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/nodes.py Changed

@@ -1,4 +1,4 @@
-# $Id: nodes.py 8592 2020-12-15 23:06:26Z milde $
+# $Id: nodes.py 9310 2022-12-17 12:17:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -17,57 +17,27 @@
 ``isinstance(node, base_class)`` to determine the position of the node in the
 hierarchy.
 
-.. _DTD: http://docutils.sourceforge.net/docs/ref/docutils.dtd
+.. _DTD: https://docutils.sourceforge.io/docs/ref/docutils.dtd
 """
-from __future__ import print_function
-from collections import Counter
 
 __docformat__ = 'reStructuredText'
 
-import sys
-import os
+from collections import Counter
 import re
+import sys
 import warnings
 import unicodedata
+# import xml.dom.minidom as dom # -> conditional import in Node.asdom()
+#                                    and document.asdom()
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-    basestring = str  # noqa
-
-class _traversal_list(list):
-    # auxiliary class to report a FutureWarning
-    done = False
-    def _warning_decorator(fun):
-        msg = ("\n   The iterable returned by Node.traverse()"
-               "\n   will become an iterator instead of a list in "
-               "Docutils > 0.16.")
-        def wrapper(self, *args, **kwargs):
-            if not self.done:
-                warnings.warn(msg, FutureWarning, stacklevel=2)
-            self.done = True
-            return fun(self, *args, **kwargs)
-        return wrapper
-
-    __add__ = _warning_decorator(list.__add__)
-    __contains__ = _warning_decorator(list.__contains__)
-    __getitem__ = _warning_decorator(list.__getitem__)
-    __reversed__ = _warning_decorator(list.__reversed__)
-    __setitem__ = _warning_decorator(list.__setitem__)
-    append = _warning_decorator(list.append)
-    count = _warning_decorator(list.count)
-    extend = _warning_decorator(list.extend)
-    index = _warning_decorator(list.index)
-    insert = _warning_decorator(list.insert)
-    pop = _warning_decorator(list.pop)
-    reverse = _warning_decorator(list.reverse)
+# import docutils.transforms # -> conditional import in document.__init__()
 
 
 # ==============================
 #  Functional Node Base Classes
 # ==============================
 
-class Node(object):
-
+class Node:
     """Abstract base class of nodes in a document tree."""
 
     parent = None
@@ -83,8 +53,7 @@
 
     @property
     def document(self):
-        """
-        Return the `document` node at the root of the tree containing this Node.
+        """Return the `document` root node of the tree containing this Node.
         """
         try:
             return self._document or self.parent.document
@@ -101,20 +70,10 @@
         than a simple container.  Its boolean "truth" does not depend on
         having one or more subnodes in the doctree.
 
-        Use `len()` to check node length.  Use `None` to represent a boolean
-        false value.
+        Use `len()` to check node length.
         """
         return True
 
-    if sys.version_info < (3, 0):
-        __nonzero__ = __bool__
-
-    if sys.version_info < (3, 0):
-        # on 2.x, str(node) will be a byte string with Unicode
-        # characters > 255 escaped; on 3.x this is no longer necessary
-        def __str__(self):
-            return unicode(self).encode('raw_unicode_escape')
-
     def asdom(self, dom=None):
         """Return a DOM **fragment** representation of this Node."""
         if dom is None:
@@ -240,39 +199,55 @@
             visitor.dispatch_departure(self)
         return stop
 
-    def _fast_traverse(self, cls):
+    def _fast_findall(self, cls):
         """Return iterator that only supports instance checks."""
         if isinstance(self, cls):
             yield self
         for child in self.children:
-            for subnode in child._fast_traverse(cls):
-                yield subnode
+            yield from child._fast_findall(cls)
 
-    def _all_traverse(self):
+    def _superfast_findall(self):
         """Return iterator that doesn't check for a condition."""
+        # This is different from ``iter(self)`` implemented via
+        # __getitem__() and __len__() in the Element subclass,
+        # which yields only the direct children.
         yield self
         for child in self.children:
-            for subnode in child._all_traverse():
-                yield subnode
+            yield from child._superfast_findall()
 
     def traverse(self, condition=None, include_self=True, descend=True,
                  siblings=False, ascend=False):
+        """Return list of nodes following `self`.
+
+        For looping, Node.findall() is faster and more memory efficient.
         """
-        Return an iterable containing
+        # traverse() may be eventually removed:
+        warnings.warn('nodes.Node.traverse() is obsoleted by Node.findall().',
+                      PendingDeprecationWarning, stacklevel=2)
+        return list(self.findall(condition, include_self, descend,
+                                 siblings, ascend))
 
-        * self (if include_self is true)
-        * all descendants in tree traversal order (if descend is true)
-        * all siblings (if siblings is true) and their descendants (if
-          also descend is true)
-        * the siblings of the parent (if ascend is true) and their
-          descendants (if also descend is true), and so on
+    def findall(self, condition=None, include_self=True, descend=True,
+                siblings=False, ascend=False):
+        """
+        Return an iterator yielding nodes following `self`:
+
+        * self (if `include_self` is true)
+        * all descendants in tree traversal order (if `descend` is true)
+        * the following siblings (if `siblings` is true) and their
+          descendants (if also `descend` is true)
+        * the following siblings of the parent (if `ascend` is true) and
+          their descendants (if also `descend` is true), and so on.
 
-        If `condition` is not None, the iterable contains only nodes
+        If `condition` is not None, the iterator yields only nodes
         for which ``condition(node)`` is true.  If `condition` is a
         node class ``cls``, it is equivalent to a function consisting
         of ``return isinstance(node, cls)``.
 
-        If ascend is true, assume siblings to be true as well.
+        If `ascend` is true, assume `siblings` to be true as well.
+
+        If the tree structure is modified during iteration, the result
+        is undefined.
 
         For example, given the following tree::
 
@@ -284,62 +259,52 @@
                 <reference name="Baz" refid="baz">
                     Baz
 
-        Then list(emphasis.traverse()) equals ::
+        Then tuple(emphasis.traverse()) equals ::
 
-            <emphasis>, <strong>, <#text: Foo>, <#text: Bar>
+            (<emphasis>, <strong>, <#text: Foo>, <#text: Bar>)
 
-        and list(strong.traverse(ascend=True)) equals ::
+        and list(strong.traverse(ascend=True) equals ::
 
             <strong>, <#text: Foo>, <#text: Bar>, <reference>, <#text: Baz>
         """
-        # Although the documented API only promises an "iterable" as return
-        # value, the implementation returned a list up to v. 0.15. Some 3rd
-        # party code still relies on this (e.g. Sphinx as of 2019-09-07).
-        # Therefore, let's return a list until this is sorted out:
-        return _traversal_list(self._traverse(condition, include_self,
-                                   descend, siblings, ascend))
-
-    def _traverse(self, condition=None, include_self=True, descend=True,
-                  siblings=False, ascend=False):
-        """Return iterator over nodes following `self`. See `traverse()`."""
         if ascend:
-            siblings=True
+            siblings = True
         # Check for special argument combinations that allow using an
         # optimized version of traverse()
         if include_self and descend and not siblings:
             if condition is None:
-                for subnode in self._all_traverse():
-                    yield subnode
+                yield from self._superfast_findall()
                 return
             elif isinstance(condition, type):
-                for subnode in self._fast_traverse(condition):
-                    yield subnode
+                yield from self._fast_findall(condition)
                 return
         # Check if `condition` is a class (check for TypeType for Python
         # implementations that use only new-style classes, like PyPy).
         if isinstance(condition, type):
             node_class = condition
+
             def condition(node, node_class=node_class):
                 return isinstance(node, node_class)
 
-
         if include_self and (condition is None or condition(self)):
             yield self
         if descend and len(self.children):
             for child in self:
-                for subnode in child._traverse(condition=condition,
-                                    include_self=True, descend=True,
-                                    siblings=False, ascend=False):
-                    yield subnode
+                yield from child.findall(condition=condition,
+                                         include_self=True, descend=True,
+                                         siblings=False, ascend=False)
         if siblings or ascend:
             node = self
             while node.parent:
                 index = node.parent.index(node)
+                # extra check since Text nodes have value-equality
+                while node.parentindex is not node:
+                    index = node.parent.index(node, index + 1)
                 for sibling in node.parentindex+1::
-                    for subnode in sibling._traverse(condition=condition,
-                                        include_self=True, descend=descend,
-                                        siblings=False, ascend=False):
-                        yield subnode
+                    yield from sibling.findall(
+                        condition=condition,
+                        include_self=True, descend=descend,
+                        siblings=False, ascend=False)
                 if not ascend:
                     break
                 else:
@@ -348,39 +313,40 @@
     def next_node(self, condition=None, include_self=False, descend=True,
                   siblings=False, ascend=False):
         """
-        Return the first node in the iterable returned by traverse(),
+        Return the first node in the iterator returned by findall(),
         or None if the iterable is empty.
 
-        Parameter list is the same as of traverse.  Note that
-        include_self defaults to False, though.
+        Parameter list is the same as of traverse.  Note that `include_self`
+        defaults to False, though.
         """
-        node_iterator = self._traverse(condition, include_self,
-                                      descend, siblings, ascend)
         try:
-            return next(node_iterator)
+            return next(self.findall(condition, include_self,
+                                     descend, siblings, ascend))
         except StopIteration:
             return None
 
-if sys.version_info < (3, 0):
-    class reprunicode(unicode):
-        """
-        A unicode sub-class that removes the initial u from unicode's repr.
-        """
 
-        def __repr__(self):
-            return unicode.__repr__(self)1:
-else:
-    reprunicode = unicode
+class reprunicode(str):
+    """
+    Deprecated backwards compatibility stub. Use the standard `str` instead.
+    """
+    def __init__(self, s):
+        warnings.warn('nodes.reprunicode() is not required with Python 3'
+                      ' and will be removed in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        super().__init__()
 
 
 def ensure_str(s):
     """
-    Failsave conversion of `unicode` to `str`.
+    Deprecated backwards compatibility stub returning `s`.
     """
-    if sys.version_info < (3, 0) and isinstance(s, unicode):
-        return s.encode('ascii', 'backslashreplace')
+    warnings.warn('nodes.ensure_str() is not required with Python 3'
+                  ' and will be removed in Docutils 0.21 or later.',
+                  DeprecationWarning, stacklevel=2)
     return s
 
+
 # definition moved here from `utils` to avoid circular import dependency
 def unescape(text, restore_backslashes=False, respect_whitespace=False):
     """
@@ -396,12 +362,14 @@
         return text
 
 
-class Text(Node, reprunicode):
+class Text(Node, str):
 
     """
     Instances are terminal nodes (leaves) containing text only; no child
     nodes or attributes.  Initialize by passing a string to the constructor.
-    Access the text itself with the `astext` method.
+
+    Access the raw (null-escaped) text with ``str(<instance>)``
+    and unescaped text with ``<instance>.astext()``.
     """
 
     tagname = '#text'
@@ -409,58 +377,46 @@
     children = ()
     """Text nodes have no children, and cannot have children."""
 
-    if sys.version_info > (3, 0):
-        def __new__(cls, data, rawsource=None):
-            """Prevent the rawsource argument from propagating to str."""
-            if isinstance(data, bytes):
-                raise TypeError('expecting str data, not bytes')
-            return reprunicode.__new__(cls, data)
-    else:
-        def __new__(cls, data, rawsource=None):
-            """Prevent the rawsource argument from propagating to str."""
-            return reprunicode.__new__(cls, data)
-
-    def __init__(self, data, rawsource=''):
-        self.rawsource = rawsource
-        """The raw text from which this element was constructed."""
+    def __new__(cls, data, rawsource=None):
+        """Assert that `data` is not an array of bytes
+        and warn if the deprecated `rawsource` argument is used.
+        """
+        if isinstance(data, bytes):
+            raise TypeError('expecting str data, not bytes')
+        if rawsource is not None:
+            warnings.warn('nodes.Text: initialization argument "rawsource" '
+                          'is ignored and will be removed in Docutils 2.0.',
+                          DeprecationWarning, stacklevel=2)
+        return str.__new__(cls, data)
 
     def shortrepr(self, maxlen=18):
         data = self
         if len(data) > maxlen:
             data = data:maxlen-4 + ' ...'
-        return '<%s: %r>' % (self.tagname, reprunicode(data))
+        return '<%s: %r>' % (self.tagname, str(data))
 
     def __repr__(self):
         return self.shortrepr(maxlen=68)
 
     def _dom_node(self, domroot):
-        return domroot.createTextNode(unicode(self))
+        return domroot.createTextNode(str(self))
 
     def astext(self):
-        return reprunicode(unescape(self))
-
-    # Note about __unicode__: The implementation of __unicode__ here,
-    # and the one raising NotImplemented in the superclass Node had
-    # to be removed when changing Text to a subclass of unicode instead
-    # of UserString, since there is no way to delegate the __unicode__
-    # call to the superclass unicode:
-    # unicode itself does not have __unicode__ method to delegate to
-    # and calling unicode(self) or unicode.__new__ directly creates
-    # an infinite loop
+        return str(unescape(self))
 
     def copy(self):
-        return self.__class__(reprunicode(self), rawsource=self.rawsource)
+        return self.__class__(str(self))
 
     def deepcopy(self):
         return self.copy()
 
     def pformat(self, indent='    ', level=0):
         try:
-            if self.document.settings.detailled:
-                lines = '%s%s' % (indent * level, '<#text>')
-                         + indent*(level+1) + repr(line)
-                             for line in self.splitlines(keepends=True)
-                return '\n'.join(lines) + '\n'
+            if self.document.settings.detailed:
+                tag = '%s%s' % (indent*level, '<#text>')
+                lines = (indent*(level+1) + repr(line)
+                         for line in self.splitlines(True))
+                return '\n'.join((tag, *lines)) + '\n'
         except AttributeError:
             pass
         indent = indent * level
@@ -474,33 +430,46 @@
     # taken care of by UserString.
 
     def rstrip(self, chars=None):
-        return self.__class__(reprunicode.rstrip(self, chars), self.rawsource)
+        return self.__class__(str.rstrip(self, chars))
 
     def lstrip(self, chars=None):
-        return self.__class__(reprunicode.lstrip(self, chars), self.rawsource)
+        return self.__class__(str.lstrip(self, chars))
+
 
 class Element(Node):
 
     """
     `Element` is the superclass to all specific elements.
 
-    Elements contain attributes and child nodes.  Elements emulate
-    dictionaries for attributes, indexing by attribute name (a string).  To
-    set the attribute 'att' to 'value', do::
+    Elements contain attributes and child nodes.
+    They can be described as a cross between a list and a dictionary.
+
+    Elements emulate dictionaries for external #_ attributes, indexing by
+    attribute name (a string). To set the attribute 'att' to 'value', do::
 
         element'att' = 'value'
 
+    .. # External attributes correspond to the XML element attributes.
+       From its `Node` superclass, Element also inherits "internal"
+       class attributes that are accessed using the standard syntax, e.g.
+       ``element.parent``.
+
     There are two special attributes: 'ids' and 'names'.  Both are
-    lists of unique identifiers, and names serve as human interfaces
-    to IDs.  Names are case- and whitespace-normalized (see the
-    fully_normalize_name() function), and IDs conform to the regular
-    expression ``a-z(-?a-z0-9+)*`` (see the make_id() function).
+    lists of unique identifiers: 'ids' conform to the regular expression
+    ``a-z(-?a-z0-9+)*`` (see the make_id() function for rationale and
+    details). 'names' serve as user-friendly interfaces to IDs; they are
+    case- and whitespace-normalized (see the fully_normalize_name() function).
 
-    Elements also emulate lists for child nodes (element nodes and/or text
+    Elements emulate lists for child nodes (element nodes and/or text
     nodes), indexing by integer.  To get the first child node, use::
 
         element0
 
+    to iterate over the child nodes (without descending), use::
+
+        for child in element:
+            ...
+
     Elements may be constructed using the ``+=`` operator.  To add one new
     child node to element, do::
 
@@ -517,22 +486,22 @@
     """
 
     basic_attributes = ('ids', 'classes', 'names', 'dupnames')
-    """List attributes which are defined for every Element-derived class
+    """Tuple of attributes which are defined for every Element-derived class
     instance and can be safely transferred to a different node."""
 
     local_attributes = ('backrefs',)
-    """A list of class-specific attributes that should not be copied with the
+    """Tuple of class-specific attributes that should not be copied with the
     standard attributes when replacing a node.
 
     NOTE: Derived classes should override this value to prevent any of its
     attributes being copied by adding to the value in its parent class."""
 
     list_attributes = basic_attributes + local_attributes
-    """List attributes, automatically initialized to empty lists for
-    all nodes."""
+    """Tuple of attributes that are automatically initialized to empty lists
+    for all nodes."""
 
-    known_attributes = list_attributes + ('source', 'rawsource')
-    """List attributes that are known to the Element base class."""
+    known_attributes = list_attributes + ('source',)
+    """Tuple of attributes that are known to the Element base class."""
 
     tagname = None
     """The element generic identifier. If None, it is set as an instance
@@ -575,7 +544,7 @@
         element = domroot.createElement(self.tagname)
         for attribute, value in self.attlist():
             if isinstance(value, list):
-                value = ' '.join(serial_escape('%s' % (v,)) for v in value)
+                value = ' '.join(serial_escape('%s' % (v,)) for v in value)
             element.setAttribute(attribute, '%s' % value)
         for child in self.children:
             element.appendChild(child._dom_node(domroot))
@@ -590,28 +559,25 @@
                 break
         if self'names':
             return '<%s "%s": %s>' % (self.__class__.__name__,
-                '; '.join(ensure_str(n) for n in self'names'), data)
+                                      '; '.join(self'names'), data)
         else:
             return '<%s: %s>' % (self.__class__.__name__, data)
 
     def shortrepr(self):
         if self'names':
             return '<%s "%s"...>' % (self.__class__.__name__,
-                '; '.join(ensure_str(n) for n in self'names'))
+                                     '; '.join(self'names'))
         else:
             return '<%s...>' % self.tagname
 
-    def __unicode__(self):
+    def __str__(self):
         if self.children:
-            return u'%s%s%s' % (self.starttag(),
-                                ''.join(unicode(c) for c in self.children),
-                                self.endtag())
+            return '%s%s%s' % (self.starttag(),
+                               ''.join(str(c) for c in self.children),
+                               self.endtag())
         else:
             return self.emptytag()
 
-    if sys.version_info >= (3, 0):
-        __str__ = __unicode__
-
     def starttag(self, quoteattr=None):
         # the optional arg is used by the docutils_xml writer
         if quoteattr is None:
@@ -625,30 +591,29 @@
                 values = serial_escape('%s' % (v,)) for v in value
                 value = ' '.join(values)
             else:
-                value = unicode(value)
+                value = str(value)
             value = quoteattr(value)
-            parts.append(u'%s=%s' % (name, value))
-        return u'<%s>' % u' '.join(parts)
+            parts.append('%s=%s' % (name, value))
+        return '<%s>' % ' '.join(parts)
 
     def endtag(self):
         return '</%s>' % self.tagname
 
     def emptytag(self):
-        return u'<%s/>' % u' '.join(self.tagname +
-                                    '%s="%s"' % (n, v)
-                                     for n, v in self.attlist())
+        attributes = ('%s="%s"' % (n, v) for n, v in self.attlist())
+        return '<%s/>' % ' '.join((self.tagname, *attributes))
 
     def __len__(self):
         return len(self.children)
 
     def __contains__(self, key):
         # Test for both, children and attributes with operator ``in``.
-        if isinstance(key, basestring):
+        if isinstance(key, str):
             return key in self.attributes
         return key in self.children
 
     def __getitem__(self, key):
-        if isinstance(key, basestring):
+        if isinstance(key, str):
             return self.attributeskey
         elif isinstance(key, int):
             return self.childrenkey
@@ -660,7 +625,7 @@
                             'an attribute name string')
 
     def __setitem__(self, key, item):
-        if isinstance(key, basestring):
+        if isinstance(key, str):
             self.attributesstr(key) = item
         elif isinstance(key, int):
             self.setup_child(item)
@@ -675,7 +640,7 @@
                             'an attribute name string')
 
     def __delitem__(self, key):
-        if isinstance(key, basestring):
+        if isinstance(key, str):
             del self.attributeskey
         elif isinstance(key, int):
             del self.childrenkey
@@ -702,7 +667,7 @@
 
     def astext(self):
         return self.child_text_separator.join(
-              child.astext() for child in self.children)
+                   child.astext() for child in self.children)
 
     def non_default_attributes(self):
         atts = {}
@@ -712,8 +677,7 @@
         return atts
 
     def attlist(self):
-        attlist = sorted(self.non_default_attributes().items())
-        return attlist
+        return sorted(self.non_default_attributes().items())
 
     def get(self, key, failobj=None):
         return self.attributes.get(key, failobj)
@@ -766,8 +730,16 @@
     def remove(self, item):
         self.children.remove(item)
 
-    def index(self, item):
-        return self.children.index(item)
+    def index(self, item, start=0, stop=sys.maxsize):
+        return self.children.index(item, start, stop)
+
+    def previous_sibling(self):
+        """Return preceding sibling node or ``None``."""
+        try:
+            i = self.parent.index(self)
+        except (AttributeError):
+            return None
+        return self.parenti-1 if i > 0 else None
 
     def is_not_default(self, key):
         if selfkey ==  and key in self.list_attributes:
@@ -795,7 +767,7 @@
         """
         # List Concatenation
         for value in values:
-            if not value in selfattr:
+            if value not in selfattr:
                 selfattr.append(value)
 
     def coerce_append_attr_list(self, attr, value):
@@ -813,7 +785,7 @@
             value = value
         self.append_attr_list(attr, value)
 
-    def replace_attr(self, attr, value, force = True):
+    def replace_attr(self, attr, value, force=True):
         """
         If selfattr does not exist or force is True or omitted, set
         selfattr to value, otherwise do nothing.
@@ -822,7 +794,7 @@
         if force or self.get(attr) is None:
             selfattr = value
 
-    def copy_attr_convert(self, attr, value, replace = True):
+    def copy_attr_convert(self, attr, value, replace=True):
         """
         If attr is an attribute of self, set selfattr to
         selfattr, value, otherwise set selfattr to value.
@@ -872,8 +844,8 @@
         if self.get(attr) is not value:
             self.replace_attr(attr, value, replace)
 
-    def update_all_atts(self, dict_, update_fun = copy_attr_consistent,
-                        replace = True, and_source = False):
+    def update_all_atts(self, dict_, update_fun=copy_attr_consistent,
+                        replace=True, and_source=False):
         """
         Updates all attributes from node or dictionary `dict_`.
 
@@ -910,8 +882,8 @@
         for att in filter(filter_fun, dict_):
             update_fun(self, att, dict_att, replace)
 
-    def update_all_atts_consistantly(self, dict_, replace = True,
-                                     and_source = False):
+    def update_all_atts_consistantly(self, dict_, replace=True,
+                                     and_source=False):
         """
         Updates all attributes from node or dictionary `dict_`.
 
@@ -931,8 +903,8 @@
         self.update_all_atts(dict_, Element.copy_attr_consistent, replace,
                              and_source)
 
-    def update_all_atts_concatenating(self, dict_, replace = True,
-                                      and_source = False):
+    def update_all_atts_concatenating(self, dict_, replace=True,
+                                      and_source=False):
         """
         Updates all attributes from node or dictionary `dict_`.
 
@@ -955,8 +927,8 @@
         self.update_all_atts(dict_, Element.copy_attr_concatenate, replace,
                              and_source)
 
-    def update_all_atts_coercion(self, dict_, replace = True,
-                                 and_source = False):
+    def update_all_atts_coercion(self, dict_, replace=True,
+                                 and_source=False):
         """
         Updates all attributes from node or dictionary `dict_`.
 
@@ -980,7 +952,7 @@
         self.update_all_atts(dict_, Element.copy_attr_coerce, replace,
                              and_source)
 
-    def update_all_atts_convert(self, dict_, and_source = False):
+    def update_all_atts_convert(self, dict_, and_source=False):
         """
         Updates all attributes from node or dictionary `dict_`.
 
@@ -999,7 +971,7 @@
               on the value of update_fun.
         """
         self.update_all_atts(dict_, Element.copy_attr_convert,
-                             and_source = and_source)
+                             and_source=and_source)
 
     def clear(self):
         self.children = 
@@ -1077,9 +1049,9 @@
         return None
 
     def pformat(self, indent='    ', level=0):
-        return ''.join('%s%s\n' % (indent * level, self.starttag()) +
-                       child.pformat(indent, level+1)
-                        for child in self.children)
+        tagline = '%s%s\n' % (indent*level, self.starttag())
+        childreps = (c.pformat(indent, level+1) for c in self.children)
+        return ''.join((tagline, *childreps))
 
     def copy(self):
         obj = self.__class__(rawsource=self.rawsource, **self.attributes)
@@ -1095,8 +1067,9 @@
 
     def set_class(self, name):
         """Add a new class to the "classes" attribute."""
-        warnings.warn('docutils.nodes.Element.set_class deprecated; '
-                      "append to Element'classes' list attribute directly",
+        warnings.warn('docutils.nodes.Element.set_class() is deprecated; '
+                      ' and will be removed in Docutils 0.21 or later.'
+                      "Append to Element'classes' list attribute directly",
                       DeprecationWarning, stacklevel=2)
         assert ' ' not in name
         self'classes'.append(name.lower())
@@ -1157,7 +1130,7 @@
         if text != '':
             textnode = Text(text)
             Element.__init__(self, rawsource, textnode, *children,
-                              **attributes)
+                             **attributes)
         else:
             Element.__init__(self, rawsource, *children, **attributes)
 
@@ -1175,12 +1148,12 @@
 #  Mixins
 # ========
 
-class Resolvable(object):
+class Resolvable:
 
     resolved = 0
 
 
-class BackLinkable(object):
+class BackLinkable:
 
     def add_backref(self, refid):
         self'backrefs'.append(refid)
@@ -1190,19 +1163,19 @@
 #  Element Categories
 # ====================
 
-class Root(object):
+class Root:
     pass
 
 
-class Titular(object):
+class Titular:
     pass
 
 
-class PreBibliographic(object):
+class PreBibliographic:
     """Category of Node which may occur before Bibliographic Nodes."""
 
 
-class Bibliographic(object):
+class Bibliographic:
     pass
 
 
@@ -1210,11 +1183,11 @@
     pass
 
 
-class Structural(object):
+class Structural:
     pass
 
 
-class Body(object):
+class Body:
     pass
 
 
@@ -1237,11 +1210,11 @@
     """Internal elements that don't appear in output."""
 
 
-class Part(object):
+class Part:
     pass
 
 
-class Inline(object):
+class Inline:
     pass
 
 
@@ -1258,7 +1231,7 @@
     Required for MoinMoin/reST compatibility."""
 
 
-class Labeled(object):
+class Labeled:
     """Contains a `label` as its first element."""
 
 
@@ -1391,7 +1364,7 @@
                 self.ids.setdefault(id, node)
                 if self.idsid is not node:
                     msg = self.reporter.severe('Duplicate ID: "%s".' % id)
-                    if msgnode != None:
+                    if msgnode is not None:
                         msgnode += msg
             return id
         # generate and set id
@@ -1400,10 +1373,13 @@
         base_id = ''
         id = ''
         for name in node'names':
-            base_id = make_id(name)
+            if id_prefix:
+                # allow names starting with numbers if `id_prefix`
+                base_id = make_id('x'+name)1:
+            else:
+                base_id = make_id(name)
+            # TODO: normalize id-prefix? (would make code simpler)
             id = id_prefix + base_id
-            # TODO: allow names starting with numbers if `id_prefix`
-            # is non-empty:  id = make_id(id_prefix + name)
             if base_id and id not in self.ids:
                 break
         else:
@@ -1413,9 +1389,10 @@
                 prefix = id + '-'
             else:
                 prefix = id_prefix + auto_id_prefix
-                if  prefix.endswith('%'):
-                    prefix = '%s%s-' % (prefix:-1, suggested_prefix
-                                                or make_id(node.tagname))
+                if prefix.endswith('%'):
+                    prefix = '%s%s-' % (prefix:-1,
+                                        suggested_prefix
+                                        or make_id(node.tagname))
             while True:
                 self.id_counterprefix += 1
                 id = '%s%d' % (prefix, self.id_counterprefix)
@@ -1431,25 +1408,26 @@
         booleans representing hyperlink type (True==explicit,
         False==implicit).  This method updates the mappings.
 
-        The following state transition table shows how `self.nameids` ("ids")
-        and `self.nametypes` ("types") change with new input (a call to this
-        method), and what actions are performed ("implicit"-type system
-        messages are INFO/1, and "explicit"-type system messages are ERROR/3):
+        The following state transition table shows how `self.nameids` items
+        ("id") and `self.nametypes` items ("type") change with new input
+        (a call to this method), and what actions are performed
+        ("implicit"-type system messages are INFO/1, and
+        "explicit"-type system messages are ERROR/3):
 
         ====  =====  ========  ========  =======  ====  =====  =====
          Old State    Input          Action        New State   Notes
         -----------  --------  -----------------  -----------  -----
-        ids   types  new type  sys.msg.  dupname  ids   types
+        id    type   new type  sys.msg.  dupname  id    type
         ====  =====  ========  ========  =======  ====  =====  =====
         -     -      explicit  -         -        new   True
         -     -      implicit  -         -        new   False
-        None  False  explicit  -         -        new   True
+        -     False  explicit  -         -        new   True
         old   False  explicit  implicit  old      new   True
-        None  True   explicit  explicit  new      None  True
-        old   True   explicit  explicit  new,old  None  True   #_
-        None  False  implicit  implicit  new      None  False
-        old   False  implicit  implicit  new,old  None  False
-        None  True   implicit  implicit  new      None  True
+        -     True   explicit  explicit  new      -     True
+        old   True   explicit  explicit  new,old  -     True   #_
+        -     False  implicit  implicit  new      -     False
+        old   False  implicit  implicit  new,old  -     False
+        -     True   implicit  implicit  new      -     True
         old   True   implicit  implicit  new      old   True
         ====  =====  ========  ========  =======  ====  =====  =====
 
@@ -1457,9 +1435,10 @@
            both old and new targets are external and refer to identical URIs.
            The new target is invalidated regardless.
         """
-        for name in node'names':
+        for name in tuple(node'names'):
             if name in self.nameids:
                 self.set_duplicate_name_id(node, id, name, msgnode, explicit)
+                # attention: modifies node'names'
             else:
                 self.nameidsname = id
                 self.nametypesname = explicit
@@ -1475,9 +1454,9 @@
                     old_node = self.idsold_id
                     if 'refuri' in node:
                         refuri = node'refuri'
-                        if old_node'names' \
-                               and 'refuri' in old_node \
-                               and old_node'refuri' == refuri:
+                        if (old_node'names'
+                            and 'refuri' in old_node
+                            and old_node'refuri' == refuri):
                             level = 1   # just inform if refuri's identical
                     if level > 1:
                         dupname(old_node, name)
@@ -1485,7 +1464,7 @@
                 msg = self.reporter.system_message(
                     level, 'Duplicate explicit target name: "%s".' % name,
                     backrefs=id, base_node=node)
-                if msgnode != None:
+                if msgnode is not None:
                     msgnode += msg
                 dupname(node, name)
             else:
@@ -1503,7 +1482,7 @@
             msg = self.reporter.info(
                 'Duplicate implicit target name: "%s".' % name,
                 backrefs=id, base_node=node)
-            if msgnode != None:
+            if msgnode is not None:
                 msgnode += msg
 
     def has_name(self, name):
@@ -1512,7 +1491,7 @@
     # "note" here is an imperative verb: "take note of".
     def note_implicit_target(self, target, msgnode=None):
         id = self.set_id(target, msgnode)
-        self.set_name_id_map(target, id, msgnode, explicit=None)
+        self.set_name_id_map(target, id, msgnode, explicit=False)
 
     def note_explicit_target(self, target, msgnode=None):
         id = self.set_id(target, msgnode)
@@ -1569,9 +1548,9 @@
         name = whitespace_normalize_name(def_name)
         if name in self.substitution_defs:
             msg = self.reporter.error(
-                  'Duplicate substitution definition name: "%s".' % name,
-                  base_node=subdef)
-            if msgnode != None:
+                      'Duplicate substitution definition name: "%s".' % name,
+                      base_node=subdef)
+            if msgnode is not None:
                 msgnode += msg
             oldnode = self.substitution_defsname
             dupname(oldnode, name)
@@ -1601,7 +1580,7 @@
 
     def copy(self):
         obj = self.__class__(self.settings, self.reporter,
-                              **self.attributes)
+                             **self.attributes)
         obj.source = self.source
         obj.line = self.line
         return obj
@@ -1609,7 +1588,7 @@
     def get_decoration(self):
         if not self.decoration:
             self.decoration = decoration()
-            index = self.first_child_not_matching_class(Titular)
+            index = self.first_child_not_matching_class((Titular, meta))
             if index is None:
                 self.append(self.decoration)
             else:
@@ -1626,6 +1605,14 @@
 class rubric(Titular, TextElement): pass
 
 
+# ==================
+#  Meta-Data Element
+# ==================
+
+class meta(PreBibliographic, Element):
+    """Container for "invisible" bibliographic data, or meta-data."""
+
+
 # ========================
 #  Bibliographic Elements
 # ========================
@@ -1809,14 +1796,14 @@
             children = (p,) + children
         try:
             Element.__init__(self, rawsource, *children, **attributes)
-        except:
+        except:  # noqa  catchall
             print('system_message: children=%r' % (children,))
             raise
 
     def astext(self):
         line = self.get('line', '')
-        return u'%s:%s: (%s/%s) %s' % (self'source', line, self'type',
-                                       self'level', Element.astext(self))
+        return '%s:%s: (%s/%s) %s' % (self'source', line, self'type',
+                                      self'level', Element.astext(self))
 
 
 class pending(Special, Invisible, Element):
@@ -1859,19 +1846,19 @@
         """Detail data (dictionary) required by the pending operation."""
 
     def pformat(self, indent='    ', level=0):
-        internals = 
-              '.. internal attributes:',
-              '     .transform: %s.%s' % (self.transform.__module__,
-                                          self.transform.__name__),
-              '     .details:'
+        internals = '.. internal attributes:',
+                     '     .transform: %s.%s' % (self.transform.__module__,
+                                                 self.transform.__name__),
+                     '     .details:'
         details = sorted(self.details.items())
         for key, value in details:
             if isinstance(value, Node):
                 internals.append('%7s%s:' % ('', key))
                 internals.extend('%9s%s' % ('', line)
                                   for line in value.pformat().splitlines())
-            elif value and isinstance(value, list) \
-                  and isinstance(value0, Node):
+            elif (value
+                  and isinstance(value, list)
+                  and isinstance(value0, Node)):
                 internals.append('%7s%s:' % ('', key))
                 for v in value:
                     internals.extend('%9s%s' % ('', line)
@@ -1879,12 +1866,12 @@
             else:
                 internals.append('%7s%s: %r' % ('', key, value))
         return (Element.pformat(self, indent, level)
-                + ''.join(('    %s%s\n' % (indent * level, line))
-                           for line in internals))
+                + ''.join(('    %s%s\n' % (indent * level, line))
+                          for line in internals))
 
     def copy(self):
         obj = self.__class__(self.transform, self.details, self.rawsource,
-                              **self.attributes)
+                             **self.attributes)
         obj._document = self._document
         obj.source = self.source
         obj.line = self.line
@@ -1897,8 +1884,6 @@
     Raw data that is to be passed untouched to the Writer.
     """
 
-    pass
-
 
 # =================
 #  Inline Elements
@@ -1950,7 +1935,7 @@
     header hint
     image important inline
     label legend line line_block list_item literal literal_block
-    math math_block
+    math math_block meta
     note
     option option_argument option_group option_list option_list_item
         option_string organization
@@ -1965,7 +1950,7 @@
 """A list of names of all concrete Node subclasses."""
 
 
-class NodeVisitor(object):
+class NodeVisitor:
 
     """
     "Visitor" pattern GoF95_ abstract superclass implementation for
@@ -1981,9 +1966,9 @@
     "``depart_`` + node class name", resp.
 
     This is a base class for visitors whose ``visit_...`` & ``depart_...``
-    methods should be implemented for *all* node types encountered (such as
-    for `docutils.writers.Writer` subclasses).  Unimplemented methods will
-    raise exceptions.
+    methods must be implemented for *all* compulsory node types encountered
+    (such as for `docutils.writers.Writer` subclasses).
+    Unimplemented methods will raise exceptions (except for optional nodes).
 
     For sparse traversals, where only certain node types are of interest, use
     subclass `SparseNodeVisitor` instead.  When (mostly or entirely) uniform
@@ -1994,7 +1979,7 @@
        1995.
     """
 
-    optional = ()
+    optional = ('meta',)
     """
     Tuple containing node class names (as strings).
 
@@ -2039,8 +2024,8 @@
 
         Raise an exception unless overridden.
         """
-        if  (self.document.settings.strict_visitor
-             or node.__class__.__name__ not in self.optional):
+        if (self.document.settings.strict_visitor
+            or node.__class__.__name__ not in self.optional):
             raise NotImplementedError(
                 '%s visiting unknown node type: %s'
                 % (self.__class__, node.__class__.__name__))
@@ -2051,8 +2036,8 @@
 
         Raise exception unless overridden.
         """
-        if  (self.document.settings.strict_visitor
-             or node.__class__.__name__ not in self.optional):
+        if (self.document.settings.strict_visitor
+            or node.__class__.__name__ not in self.optional):
             raise NotImplementedError(
                 '%s departing unknown node type: %s'
                 % (self.__class__, node.__class__.__name__))
@@ -2094,15 +2079,19 @@
         """Override for generic, uniform traversals."""
         raise NotImplementedError
 
+
 def _call_default_visit(self, node):
     self.default_visit(node)
 
+
 def _call_default_departure(self, node):
     self.default_departure(node)
 
+
 def _nop(self, node):
     pass
 
+
 def _add_node_class_names(names):
     """Save typing with dynamic assignments:"""
     for _name in names:
@@ -2111,6 +2100,7 @@
         setattr(SparseNodeVisitor, 'visit_' + _name, _nop)
         setattr(SparseNodeVisitor, 'depart_' + _name, _nop)
 
+
 _add_node_class_names(node_class_names)
 
 
@@ -2150,8 +2140,6 @@
     the tree traversed.
     """
 
-    pass
-
 
 class SkipChildren(TreePruningException):
 
@@ -2160,8 +2148,6 @@
     siblings and ``depart_...`` method are not affected.
     """
 
-    pass
-
 
 class SkipSiblings(TreePruningException):
 
@@ -2170,8 +2156,6 @@
     current node's children and its ``depart_...`` method are not affected.
     """
 
-    pass
-
 
 class SkipNode(TreePruningException):
 
@@ -2180,8 +2164,6 @@
     node's ``depart_...`` method.
     """
 
-    pass
-
 
 class SkipDeparture(TreePruningException):
 
@@ -2190,8 +2172,6 @@
     children and siblings are not affected.
     """
 
-    pass
-
 
 class NodeFound(TreePruningException):
 
@@ -2201,21 +2181,17 @@
     code.
     """
 
-    pass
-
 
 class StopTraversal(TreePruningException):
 
     """
-    Stop the traversal alltogether.  The current node's ``depart_...`` method
+    Stop the traversal altogether.  The current node's ``depart_...`` method
     is not affected.  The parent nodes ``depart_...`` methods are also called
     as usual.  No other nodes are visited.  This is an alternative to
     NodeFound that does not cause exception handling to trickle up to the
     caller.
     """
 
-    pass
-
 
 def make_id(string):
     """
@@ -2249,68 +2225,68 @@
     "unicode", "latin1", or "escape" characters), this results in the
     ``a-z(-?a-z0-9+)*`` pattern.
 
-    .. _HTML 4.01 spec: http://www.w3.org/TR/html401
-    .. _CSS1 spec: http://www.w3.org/TR/REC-CSS1
+    .. _HTML 4.01 spec: https://www.w3.org/TR/html401
+    .. _CSS1 spec: https://www.w3.org/TR/REC-CSS1
     """
     id = string.lower()
-    if not isinstance(id, unicode):
-        id = id.decode()
     id = id.translate(_non_id_translate_digraphs)
     id = id.translate(_non_id_translate)
     # get rid of non-ascii characters.
     # 'ascii' lowercase to prevent problems with turkish locale.
-    id = unicodedata.normalize('NFKD', id).\
-         encode('ascii', 'ignore').decode('ascii')
+    id = unicodedata.normalize(
+            'NFKD', id).encode('ascii', 'ignore').decode('ascii')
     # shrink runs of whitespace and replace by hyphen
     id = _non_id_chars.sub('-', ' '.join(id.split()))
     id = _non_id_at_ends.sub('', id)
     return str(id)
 
+
 _non_id_chars = re.compile('^a-z0-9+')
 _non_id_at_ends = re.compile('^-0-9+|-+$')
 _non_id_translate = {
-    0x00f8: u'o',       # o with stroke
-    0x0111: u'd',       # d with stroke
-    0x0127: u'h',       # h with stroke
-    0x0131: u'i',       # dotless i
-    0x0142: u'l',       # l with stroke
-    0x0167: u't',       # t with stroke
-    0x0180: u'b',       # b with stroke
-    0x0183: u'b',       # b with topbar
-    0x0188: u'c',       # c with hook
-    0x018c: u'd',       # d with topbar
-    0x0192: u'f',       # f with hook
-    0x0199: u'k',       # k with hook
-    0x019a: u'l',       # l with bar
-    0x019e: u'n',       # n with long right leg
-    0x01a5: u'p',       # p with hook
-    0x01ab: u't',       # t with palatal hook
-    0x01ad: u't',       # t with hook
-    0x01b4: u'y',       # y with hook
-    0x01b6: u'z',       # z with stroke
-    0x01e5: u'g',       # g with stroke
-    0x0225: u'z',       # z with hook
-    0x0234: u'l',       # l with curl
-    0x0235: u'n',       # n with curl
-    0x0236: u't',       # t with curl
-    0x0237: u'j',       # dotless j
-    0x023c: u'c',       # c with stroke
-    0x023f: u's',       # s with swash tail
-    0x0240: u'z',       # z with swash tail
-    0x0247: u'e',       # e with stroke
-    0x0249: u'j',       # j with stroke
-    0x024b: u'q',       # q with hook tail
-    0x024d: u'r',       # r with stroke
-    0x024f: u'y',       # y with stroke
+    0x00f8: 'o',       # o with stroke
+    0x0111: 'd',       # d with stroke
+    0x0127: 'h',       # h with stroke
+    0x0131: 'i',       # dotless i
+    0x0142: 'l',       # l with stroke
+    0x0167: 't',       # t with stroke
+    0x0180: 'b',       # b with stroke
+    0x0183: 'b',       # b with topbar
+    0x0188: 'c',       # c with hook
+    0x018c: 'd',       # d with topbar
+    0x0192: 'f',       # f with hook
+    0x0199: 'k',       # k with hook
+    0x019a: 'l',       # l with bar
+    0x019e: 'n',       # n with long right leg
+    0x01a5: 'p',       # p with hook
+    0x01ab: 't',       # t with palatal hook
+    0x01ad: 't',       # t with hook
+    0x01b4: 'y',       # y with hook
+    0x01b6: 'z',       # z with stroke
+    0x01e5: 'g',       # g with stroke
+    0x0225: 'z',       # z with hook
+    0x0234: 'l',       # l with curl
+    0x0235: 'n',       # n with curl
+    0x0236: 't',       # t with curl
+    0x0237: 'j',       # dotless j
+    0x023c: 'c',       # c with stroke
+    0x023f: 's',       # s with swash tail
+    0x0240: 'z',       # z with swash tail
+    0x0247: 'e',       # e with stroke
+    0x0249: 'j',       # j with stroke
+    0x024b: 'q',       # q with hook tail
+    0x024d: 'r',       # r with stroke
+    0x024f: 'y',       # y with stroke
 }
 _non_id_translate_digraphs = {
-    0x00df: u'sz',      # ligature sz
-    0x00e6: u'ae',      # ae
-    0x0153: u'oe',      # ligature oe
-    0x0238: u'db',      # db digraph
-    0x0239: u'qp',      # qp digraph
+    0x00df: 'sz',      # ligature sz
+    0x00e6: 'ae',      # ae
+    0x0153: 'oe',      # ligature oe
+    0x0238: 'db',      # db digraph
+    0x0239: 'qp',      # qp digraph
 }
 
+
 def dupname(node, name):
     node'dupnames'.append(name)
     node'names'.remove(name)
@@ -2318,26 +2294,22 @@
     # don't want to throw unnecessary system_messages.
     node.referenced = 1
 
+
 def fully_normalize_name(name):
     """Return a case- and whitespace-normalized name."""
     return ' '.join(name.lower().split())
 
+
 def whitespace_normalize_name(name):
     """Return a whitespace-normalized name."""
     return ' '.join(name.split())
 
+
 def serial_escape(value):
     """Escape string values that are elements of a list, for serialization."""
     return value.replace('\\', r'\\').replace(' ', r'\ ')
 
+
 def pseudo_quoteattr(value):
     """Quote attributes for pseudo-xml"""
     return '"%s"' % value
-
-# &#xc;
-#
-# Local Variables:
-# indent-tabs-mode: nil
-# sentence-end-double-space: t
-# fill-column: 78
-# End:

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8671 2021-04-07 12:09:51Z milde $
+# $Id: __init__.py 9048 2022-03-29 21:50:15Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,7 +8,6 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
 from importlib import import_module
 
 from docutils import Component, frontend
@@ -40,7 +39,8 @@
           '--line-length-limit',
           {'metavar': '<length>', 'type': 'int', 'default': 10000,
            'validator': frontend.validate_nonnegative_int}),
-        ))
+         )
+        )
     component_type = 'parser'
     config_section = 'parsers'
 
@@ -64,22 +64,29 @@
             self.document.note_parse_message)
 
 
-_parser_aliases = {
-      'restructuredtext': 'rst',
-      'rest': 'rst',
-      'restx': 'rst',
-      'rtxt': 'rst',
-      'recommonmark': 'recommonmark_wrapper',
-      'commonmark': 'recommonmark_wrapper',
-      'markdown': 'recommonmark_wrapper'}
+_parser_aliases = {  # short names for known parsers
+                   'null': 'docutils.parsers.null',
+                   # reStructuredText
+                   'rst': 'docutils.parsers.rst',
+                   'restructuredtext': 'docutils.parsers.rst',
+                   'rest': 'docutils.parsers.rst',
+                   'restx': 'docutils.parsers.rst',
+                   'rtxt': 'docutils.parsers.rst',
+                   # 3rd-party Markdown parsers
+                   'recommonmark': 'docutils.parsers.recommonmark_wrapper',
+                   'myst': 'myst_parser.docutils_',
+                   # 'pycmark': works out of the box
+                   # dispatcher for 3rd-party Markdown parsers
+                   'commonmark': 'docutils.parsers.commonmark_wrapper',
+                   'markdown': 'docutils.parsers.commonmark_wrapper',
+                  }
+
 
 def get_parser_class(parser_name):
     """Return the Parser class from the `parser_name` module."""
-    parser_name = parser_name.lower()
-    if parser_name in _parser_aliases:
-        parser_name = _parser_aliasesparser_name
+    name = parser_name.lower()
     try:
-        module = import_module('docutils.parsers.'+parser_name)
-    except ImportError:
-        module = import_module(parser_name)
+        module = import_module(_parser_aliases.get(name, name))
+    except ImportError as err:
+        raise ImportError(f'Parser "{parser_name}" not found. {err}')
     return module.Parser

_service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/commonmark_wrapper.py Added

@@ -0,0 +1,56 @@
+#! /usr/bin/env python3
+# :Copyright: © 2022 Günter Milde.
+# :License: Released under the terms of the `2-Clause BSD license`_, in short:
+#
+#    Copying and distribution of this file, with or without modification,
+#    are permitted in any medium without royalty provided the copyright
+#    notice and this notice are preserved.
+#    This file is offered as-is, without any warranty.
+#
+# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+#
+# Revision: $Revision: 9048 $
+# Date: $Date: 2022-03-29 23:50:15 +0200 (Di, 29. Mär 2022) $
+"""
+An interface for parsing CommonMark input.
+
+Select a locally installed parser from the following 3rd-party
+parser packages:
+
+:pycmark:       https://pypi.org/project/pycmark/
+:myst:          https://pypi.org/project/pycmark/
+:recommonmark:  https://pypi.org/project/pycmark/ (unmaintained, deprecated)
+
+The first parser class that can be successfully imported is mapped to
+`commonmark_wrapper.Parser`.
+
+This module is provisional:
+the API is not settled and may change with any minor Docutils version.
+"""
+
+import docutils.parsers
+
+
+commonmark_parser_names = ('pycmark', 'myst', 'recommonmark')
+"""Names of compatible drop-in CommonMark parsers"""
+
+Parser = None
+parser_name = ''
+
+for name in commonmark_parser_names:
+    try:
+        Parser = docutils.parsers.get_parser_class(name)
+    except ImportError:
+        continue
+    parser_name = name
+    break
+
+if Parser is None:
+    raise ImportError(
+              'Parsing "CommonMark" requires one of the packages\n'
+              f'{commonmark_parser_names} available at https://pypi.org')
+
+if parser_name == 'myst':
+    if not Parser.settings_defaults:
+        Parser.settings_defaults = {}
+    Parser.settings_defaults'myst_commonmark_only' = True

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/recommonmark_wrapper.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/recommonmark_wrapper.py Changed

@@ -1,5 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf8 -*-
+#!/usr/bin/env python3
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -10,124 +9,139 @@
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 #
-# Revision: $Revision: 8683 $
-# Date: $Date: 2021-04-09 17:44:23 +0200 (Fr, 09. Apr 2021) $
+# Revision: $Revision: 9302 $
+# Date: $Date: 2022-12-02 18:14:05 +0100 (Fr, 02. Dez 2022) $
 """
-A parser for CommonMark MarkDown text using `recommonmark`__.
+A parser for CommonMark Markdown text using `recommonmark`__.
 
 __ https://pypi.org/project/recommonmark/
+
+.. important:: This module is provisional
+
+   * The "recommonmark" package is unmaintained and deprecated.
+     This wrapper module will be removed in a future Docutils version.
+
+   * The API is not settled and may change with any minor Docutils version.
 """
 
-import docutils.parsers
-from docutils import nodes, Component
+from docutils import Component
+from docutils import nodes
 
 try:
+    # If possible, import Sphinx's 'addnodes'
+    from sphinx import addnodes
+except ImportError:
+    # stub to prevent errors if Sphinx isn't installed
+    import sys
+    import types
+
+    class pending_xref(nodes.Inline, nodes.Element): ... # NoQA
+
+    sys.modules'sphinx' = sphinx = types.ModuleType('sphinx')
+    sphinx.addnodes = addnodes = types.SimpleNamespace()
+    addnodes.pending_xref = pending_xref
+try:
+    import recommonmark
     from recommonmark.parser import CommonMarkParser
-    # from recommonmark.transform import AutoStructify
 except ImportError as err:
-    CommonMarkParser = None
-    class Parser(docutils.parsers.Parser):
-        def parse(self, inputstring, document):
-            error = document.reporter.warning(
-                'Missing dependency: MarkDown input is processed by a 3rd '
-                'party parser but Python did not find the required module '
-                '"recommonmark" (https://pypi.org/project/recommonmark/).')
-            document.append(error)
-
-
-if CommonMarkParser:
-    class Parser(CommonMarkParser):
-        """MarkDown parser based on recommonmark."""
-        # TODO: settings for AutoStructify
-        # settings_spec = docutils.parsers.Parser.settings_spec + (
-        # see https://recommonmark.readthedocs.io/en/latest/#autostructify
-
-        supported = ('recommonmark', 'commonmark', 'markdown', 'md')
-        config_section = 'recommonmark parser'
-        config_section_dependencies = ('parsers',)
-
-        # def get_transforms(self):
-        #     return Component.get_transforms(self) + AutoStructify
-
-        def parse(self, inputstring, document):
-            """Use the upstream parser and clean up afterwards.
-            """
-            # check for exorbitantly long lines
-            for i, line in enumerate(inputstring.split('\n')):
-                if len(line) > document.settings.line_length_limit:
-                    error = document.reporter.error(
-                        'Line %d exceeds the line-length-limit.'%(i+1))
-                    document.append(error)
-                    return
-
-            # pass to upstream parser
-            try:
-                CommonMarkParser.parse(self, inputstring, document)
-            except Exception as err:
-                error = document.reporter.error('Parsing with "recommonmark" '
-                                                'returned the error:\n%s'%err)
+    raise ImportError(
+        'Parsing "recommonmark" Markdown flavour requires the\n'
+        '  package https://pypi.org/project/recommonmark.'
+    ) from err
+else:
+    if recommonmark.__version__ < '0.6.0':
+        raise ImportError('The installed version of "recommonmark" is too old.'
+                          ' Update with "pip install -U recommonmark".')
+
+
+# auxiliary function for `document.findall()`
+def is_literal(node):
+    return isinstance(node, (nodes.literal, nodes.literal_block))
+
+
+class Parser(CommonMarkParser):
+    """MarkDown parser based on recommonmark.
+
+    This parser is provisional:
+    the API is not settled and may change with any minor Docutils version.
+    """
+    supported = ('recommonmark', 'commonmark', 'markdown', 'md')
+    """Formats this parser supports."""
+
+    config_section = 'recommonmark parser'
+    config_section_dependencies = ('parsers',)
+
+    def get_transforms(self):
+        return Component.get_transforms(self)  # + AutoStructify
+
+    def parse(self, inputstring, document):
+        """Use the upstream parser and clean up afterwards.
+        """
+        # check for exorbitantly long lines
+        for i, line in enumerate(inputstring.split('\n')):
+            if len(line) > document.settings.line_length_limit:
+                error = document.reporter.error(
+                    'Line %d exceeds the line-length-limit.'%(i+1))
                 document.append(error)
+                return
+
+        # pass to upstream parser
+        try:
+            CommonMarkParser.parse(self, inputstring, document)
+        except Exception as err:
+            if document.settings.traceback:
+                raise err
+            error = document.reporter.error('Parsing with "recommonmark" '
+                                            'returned the error:\n%s'%err)
+            document.append(error)
 
-            # Post-Processing
-            # ---------------
-
-            # merge adjoining Text nodes:
-            for node in document.traverse(nodes.TextElement):
-                children = node.children
-                i = 0
-                while i+1 < len(children):
-                    if (isinstance(childreni, nodes.Text)
-                        and isinstance(childreni+1, nodes.Text)):
-                        childreni = nodes.Text(childreni+children.pop(i+1))
-                        childreni.parent = node
-                    else:
-                        i += 1
-
-            # add "code" class argument to inline literal (code spans)
-            for node in document.traverse(lambda n: isinstance(n,
-                                    (nodes.literal, nodes.literal_block))):
+        # Post-Processing
+        # ---------------
+
+        # merge adjoining Text nodes:
+        for node in document.findall(nodes.TextElement):
+            children = node.children
+            i = 0
+            while i+1 < len(children):
+                if (isinstance(childreni, nodes.Text)
+                    and isinstance(childreni+1, nodes.Text)):
+                    childreni = nodes.Text(childreni+children.pop(i+1))
+                    childreni.parent = node
+                else:
+                    i += 1
+
+        # add "code" class argument to literal elements (inline and block)
+        for node in document.findall(is_literal):
+            if 'code' not in node'classes':
                 node'classes'.append('code')
-            # move "language" argument to classes
-            for node in document.traverse(nodes.literal_block):
-                if 'language' in node.attributes:
-                    node'classes'.append(node'language')
-                    del node'language'
-
-            # remove empty target nodes
-            for node in document.traverse(nodes.target):
-                # remove empty name
-                node'names' = v for v in node'names' if v
-                if node.children or v for v in node.attributes.values() if v:
-                    continue
-                node.parent.remove(node)
-
-            # replace raw nodes if raw is not allowed
-            if not document.settings.raw_enabled:
-                for node in document.traverse(nodes.raw):
-                    warning = document.reporter.warning('Raw content disabled.')
-                    node.parent.replace(node, warning)
-
-            # fix section nodes
-            for node in document.traverse(nodes.section):
-                # remove spurious IDs (first may be from duplicate name)
-                if len(node'ids') > 1:
-                    node'ids'.pop()
-                # fix section levels
-                section_level = self.get_section_level(node)
-                if node'level' != section_level:
-                    warning = document.reporter.warning(
-                        'Title level inconsistent. Changing from %d to %d.'
-                        %(node'level', section_level),
-                        nodes.literal_block('', node0.astext()))
-                    node.insert(1, warning)
-                # remove non-standard attribute "level"
-                del node'level' # TODO: store the original md level somewhere
-
-        def get_section_level(self, node):
-            level = 1
-            while True:
-                node = node.parent
-                if isinstance(node, nodes.document):
-                    return level
-                if isinstance(node, nodes.section):
-                    level += 1
+        # move "language" argument to classes
+        for node in document.findall(nodes.literal_block):
+            if 'language' in node.attributes:
+                node'classes'.append(node'language')
+                del node'language'
+
+        # replace raw nodes if raw is not allowed
+        if not document.settings.raw_enabled:
+            for node in document.findall(nodes.raw):
+                warning = document.reporter.warning('Raw content disabled.')
+                node.parent.replace(node, warning)
+
+        # drop pending_xref (Sphinx cross reference extension)
+        for node in document.findall(addnodes.pending_xref):
+            reference = node.children0
+            if 'name' not in reference:
+                reference'name' = nodes.fully_normalize_name(
+                                                    reference.astext())
+            node.parent.replace(node, reference)
+
+    def visit_document(self, node):
+        """Dummy function to prevent spurious warnings.
+
+        cf. https://github.com/readthedocs/recommonmark/issues/177
+        """
+        pass
+
+    # Overwrite parent method with version that
+    # doesn't pass deprecated `rawsource` argument to nodes.Text:
+    def visit_text(self, mdnode):
+        self.current_node.append(nodes.Text(mdnode.literal))

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8671 2021-04-07 12:09:51Z milde $
+# $Id: __init__.py 9258 2022-11-21 14:51:43Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -73,7 +73,7 @@
 import docutils.parsers
 import docutils.statemachine
 from docutils.parsers.rst import roles, states
-from docutils import frontend, nodes, Component
+from docutils import frontend, nodes
 from docutils.transforms import universal
 
 
@@ -81,7 +81,7 @@
 
     """The reStructuredText parser."""
 
-    supported = ('restructuredtext', 'rst', 'rest', 'restx', 'rtxt', 'rstx')
+    supported = ('rst', 'restructuredtext', 'rest', 'restx', 'rtxt', 'rstx')
     """Aliases this parser supports."""
 
     settings_spec = docutils.parsers.Parser.settings_spec + (
@@ -91,9 +91,9 @@
           '--pep-references',
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
          ('Base URL for PEP references '
-          '(default "http://www.python.org/dev/peps/").',
+          '(default "https://peps.python.org/").',
           '--pep-base-url',
-          {'metavar': '<URL>', 'default': 'http://www.python.org/dev/peps/',
+          {'metavar': '<URL>', 'default': 'https://peps.python.org/',
            'validator': frontend.validate_url_trailing_slash}),
          ('Template for PEP file part of URL. (default "pep-%04d")',
           '--pep-file-url-template',
@@ -101,9 +101,10 @@
          ('Recognize and link to standalone RFC references (like "RFC 822").',
           '--rfc-references',
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
-         ('Base URL for RFC references (default "http://tools.ietf.org/html/").',
+         ('Base URL for RFC references '
+          '(default "https://tools.ietf.org/html/").',
           '--rfc-base-url',
-          {'metavar': '<URL>', 'default': 'http://tools.ietf.org/html/',
+          {'metavar': '<URL>', 'default': 'https://tools.ietf.org/html/',
            'validator': frontend.validate_url_trailing_slash}),
          ('Set number of spaces for tab expansion (default 8).',
           '--tab-width',
@@ -143,7 +144,8 @@
           '--character-level-inline-markup',
           {'action': 'store_true', 'default': False,
            'dest': 'character_level_inline_markup'}),
-        ))
+         )
+        )
 
     config_section = 'restructuredtext parser'
     config_section_dependencies = ('parsers',)
@@ -157,8 +159,7 @@
         self.inliner = inliner
 
     def get_transforms(self):
-        return Component.get_transforms(self) + 
-            universal.SmartQuotes
+        return super().get_transforms() + universal.SmartQuotes
 
     def parse(self, inputstring, document):
         """Parse `inputstring` and populate `document`, a document tree."""
@@ -205,7 +206,7 @@
         self.msg = message
 
 
-class Directive(object):
+class Directive:
 
     """
     Base class for reStructuredText directives.
@@ -263,15 +264,18 @@
     - ``lineno`` is the absolute line number of the first line
       of the directive.
 
-    - ``content_offset`` is the line offset of the first line of the content from
-      the beginning of the current input.  Used when initiating a nested parse.
+    - ``content_offset`` is the line offset of the first line
+      of the content from the beginning of the current input.
+      Used when initiating a nested parse.
 
     - ``block_text`` is a string containing the entire directive.
 
     - ``state`` is the state which called the directive function.
 
-    - ``state_machine`` is the state machine which controls the state which called
-      the directive function.
+    - ``state_machine`` is the state machine which controls the state
+      which called the directive function.
+
+    - ``reporter`` is the state machine's `reporter` instance.
 
     Directive functions return a list of nodes which will be inserted
     into the document tree at the point where the directive was
@@ -286,7 +290,7 @@
     substitution definition context, typically using code like this::
 
         if not isinstance(state, states.SubstitutionDef):
-            error = state_machine.reporter.error(
+            error = self.reporter.error(
                 'Invalid context: the "%s" directive can only be used '
                 'within a substitution definition.' % (name),
                 nodes.literal_block(block_text, block_text), line=lineno)
@@ -294,7 +298,7 @@
     """
 
     # There is a "Creating reStructuredText Directives" how-to at
-    # <http://docutils.sf.net/docs/howto/rst-directives.html>.  If you
+    # <https://docutils.sourceforge.io/docs/howto/rst-directives.html>.  If you
     # update this docstring, please update the how-to as well.
 
     required_arguments = 0
@@ -323,9 +327,10 @@
         self.block_text = block_text
         self.state = state
         self.state_machine = state_machine
+        self.reporter = state_machine.reporter
 
     def run(self):
-        raise NotImplementedError('Must override run() is subclass.')
+        raise NotImplementedError('Must override run() in subclass.')
 
     # Directive errors:
 
@@ -378,7 +383,7 @@
         if 'name' in self.options:
             name = nodes.fully_normalize_name(self.options.pop('name'))
             if 'name' in node:
-                del(node'name')
+                del node'name'
             node'names'.append(name)
             self.state.document.note_explicit_target(node, node)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8595 2020-12-15 23:06:58Z milde $
+# $Id: __init__.py 9356 2023-04-18 23:50:48Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -10,16 +10,12 @@
 
 import re
 import codecs
-import sys
 from importlib import import_module
 
 from docutils import nodes, parsers
-from docutils.utils import split_escaped_whitespace, escape2null, unescape
+from docutils.utils import split_escaped_whitespace, escape2null
 from docutils.parsers.rst.languages import en as _fallback_language_module
 
-if sys.version_info >= (3, 0):
-    unichr = chr  # noqa
-
 
 _directive_registry = {
       'attention': ('admonitions', 'Attention'),
@@ -44,7 +40,7 @@
       'pull-quote': ('body', 'PullQuote'),
       'compound': ('body', 'Compound'),
       'container': ('body', 'Container'),
-      #'questions': ('body', 'question_list'),
+      # 'questions': ('body', 'question_list'),
       'table': ('tables', 'RSTTable'),
       'csv-table': ('tables', 'CSVTable'),
       'list-table': ('tables', 'ListTable'),
@@ -54,11 +50,11 @@
       'sectnum': ('parts', 'Sectnum'),
       'header': ('parts', 'Header'),
       'footer': ('parts', 'Footer'),
-      #'footnotes': ('parts', 'footnotes'),
-      #'citations': ('parts', 'citations'),
+      # 'footnotes': ('parts', 'footnotes'),
+      # 'citations': ('parts', 'citations'),
       'target-notes': ('references', 'TargetNotes'),
-      'meta': ('html', 'Meta'),
-      #'imagemap': ('html', 'imagemap'),
+      'meta': ('misc', 'Meta'),
+      # 'imagemap': ('html', 'imagemap'),
       'raw': ('misc', 'Raw'),
       'include': ('misc', 'Include'),
       'replace': ('misc', 'Replace'),
@@ -68,7 +64,8 @@
       'default-role': ('misc', 'DefaultRole'),
       'title': ('misc', 'Title'),
       'date': ('misc', 'Date'),
-      'restructuredtext-test-directive': ('misc', 'TestDirective'),}
+      'restructuredtext-test-directive': ('misc', 'TestDirective'),
+      }
 """Mapping of directive name to (module name, class name).  The
 directive name is canonical & must be lowercase.  Language-dependent
 names are defined in the ``language`` subpackage."""
@@ -76,6 +73,7 @@
 _directives = {}
 """Cache of imported directives."""
 
+
 def directive(directive_name, language_module, document):
     """
     Locate and return a directive function from its language-dependent name.
@@ -134,6 +132,7 @@
         return None, messages
     return directive, messages
 
+
 def register_directive(name, directive):
     """
     Register a nonstandard application-defined directive function.
@@ -141,6 +140,7 @@
     """
     _directivesname = directive
 
+
 def flag(argument):
     """
     Check for a valid flag option (no argument) and return ``None``.
@@ -153,6 +153,7 @@
     else:
         return None
 
+
 def unchanged_required(argument):
     """
     Return the argument text, unchanged.
@@ -165,6 +166,7 @@
     else:
         return argument  # unchanged!
 
+
 def unchanged(argument):
     """
     Return the argument text, unchanged.
@@ -173,10 +175,11 @@
     No argument implies empty string ("").
     """
     if argument is None:
-        return u''
+        return ''
     else:
         return argument  # unchanged!
 
+
 def path(argument):
     """
     Return the path argument unwrapped (with newlines removed).
@@ -187,8 +190,8 @@
     if argument is None:
         raise ValueError('argument required but none supplied')
     else:
-        path = ''.join(s.strip() for s in argument.splitlines())
-        return path
+        return ''.join(s.strip() for s in argument.splitlines())
+
 
 def uri(argument):
     """
@@ -201,8 +204,9 @@
         raise ValueError('argument required but none supplied')
     else:
         parts = split_escaped_whitespace(escape2null(argument))
-        uri = ' '.join(''.join(unescape(part).split()) for part in parts)
-        return uri
+        return ' '.join(''.join(nodes.unescape(part).split())
+                        for part in parts)
+
 
 def nonnegative_int(argument):
     """
@@ -214,6 +218,7 @@
         raise ValueError('negative value; must be positive or zero')
     return value
 
+
 def percentage(argument):
     """
     Check for an integer percentage value with optional percent sign.
@@ -225,8 +230,10 @@
         pass
     return nonnegative_int(argument)
 
+
 length_units = 'em', 'ex', 'px', 'in', 'cm', 'mm', 'pt', 'pc'
 
+
 def get_measure(argument, units):
     """
     Check for a positive argument of one of the units and return a
@@ -242,12 +249,14 @@
     except (AttributeError, ValueError):
         raise ValueError(
             'not a positive measure of one of the following units:\n%s'
-            % ' '.join('"%s"' % i for i in units))
+            % ' '.join('"%s"' % i for i in units))
     return match.group(1) + match.group(2)
 
+
 def length_or_unitless(argument):
     return get_measure(argument, length_units + '')
 
+
 def length_or_percentage_or_unitless(argument, default=''):
     """
     Return normalized string of a length or percentage unit.
@@ -274,6 +283,7 @@
             # raise ValueError with list of valid units:
             return get_measure(argument, length_units + '%')
 
+
 def class_option(argument):
     """
     Convert the argument into a list of ID-compatible strings and return it.
@@ -292,9 +302,11 @@
         class_names.append(class_name)
     return class_names
 
+
 unicode_pattern = re.compile(
     r'(?:0x|x|\\x|U\+?|\\u)(0-9a-f+)$|&#x(0-9a-f+);$', re.IGNORECASE)
 
+
 def unicode_code(code):
     r"""
     Convert a Unicode character code to a Unicode character.
@@ -308,20 +320,21 @@
     """
     try:
         if code.isdigit():                  # decimal number
-            return unichr(int(code))
+            return chr(int(code))
         else:
             match = unicode_pattern.match(code)
             if match:                       # hex number
                 value = match.group(1) or match.group(2)
-                return unichr(int(value, 16))
+                return chr(int(value, 16))
             else:                           # other text
                 return code
     except OverflowError as detail:
         raise ValueError('code too large (%s)' % detail)
 
+
 def single_char_or_unicode(argument):
     """
-    A single character is returned as-is.  Unicode characters codes are
+    A single character is returned as-is.  Unicode character codes are
     converted as in `unicode_code`.  (Directive option conversion function.)
     """
     char = unicode_code(argument)
@@ -330,6 +343,7 @@
                          'a Unicode code' % char)
     return char
 
+
 def single_char_or_whitespace_or_unicode(argument):
     """
     As with `single_char_or_unicode`, but "tab" and "space" are also supported.
@@ -343,6 +357,7 @@
         char = single_char_or_unicode(argument)
     return char
 
+
 def positive_int(argument):
     """
     Converts the argument into an integer.  Raises ValueError for negative,
@@ -353,6 +368,7 @@
         raise ValueError('negative or zero value; must be positive')
     return value
 
+
 def positive_int_list(argument):
     """
     Converts a space- or comma-separated list of values into a Python list
@@ -367,9 +383,10 @@
         entries = argument.split()
     return positive_int(entry) for entry in entries
 
+
 def encoding(argument):
     """
-    Verfies the encoding argument by lookup.
+    Verifies the encoding argument by lookup.
     (Directive option conversion function.)
 
     Raises ValueError for unknown encodings.
@@ -380,6 +397,7 @@
         raise ValueError('unknown encoding: "%s"' % argument)
     return argument
 
+
 def choice(argument, values):
     """
     Directive option utility function, supplied to enable options whose
@@ -406,14 +424,16 @@
         raise ValueError('"%s" unknown; choose from %s'
                          % (argument, format_values(values)))
 
+
 def format_values(values):
-    return '%s, or "%s"' % (', '.join('"%s"' % s for s in values:-1),
+    return '%s, or "%s"' % (', '.join('"%s"' % s for s in values:-1),
                             values-1)
 
+
 def value_or(values, other):
     """
     Directive option conversion function.
-    
+
     The argument can be any of `values` or `argument_type`.
     """
     def auto_or_other(argument):
@@ -423,16 +443,18 @@
             return other(argument)
     return auto_or_other
 
+
 def parser_name(argument):
     """
     Return a docutils parser whose name matches the argument.
     (Directive option conversion function.)
 
     Return `None`, if the argument evaluates to `False`.
+    Raise `ValueError` if importing the parser module fails.
     """
     if not argument:
         return None
     try:
         return parsers.get_parser_class(argument)
-    except ImportError:
-        raise ValueError('Unknown parser name "%s".'%argument)
+    except ImportError as err:
+        raise ValueError(str(err))

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/admonitions.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/admonitions.py Changed

@@ -1,4 +1,4 @@
-# $Id: admonitions.py 7681 2013-07-12 07:52:27Z milde $
+# $Id: admonitions.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -10,7 +10,7 @@
 
 
 from docutils.parsers.rst import Directive
-from docutils.parsers.rst import states, directives
+from docutils.parsers.rst import directives
 from docutils.parsers.rst.roles import set_classes
 from docutils import nodes
 
@@ -40,9 +40,9 @@
                     self.state_machine.get_source_and_line(self.lineno))
             admonition_node += title
             admonition_node += messages
-            if not 'classes' in self.options:
-                admonition_node'classes' += 'admonition-' +
-                                               nodes.make_id(title_text)
+            if 'classes' not in self.options:
+                admonition_node'classes' += 'admonition-'
+                                               + nodes.make_id(title_text)
         self.state.nested_parse(self.content, self.content_offset,
                                 admonition_node)
         return admonition_node

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/body.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/body.py Changed

@@ -1,4 +1,4 @@
-# $Id: body.py 8596 2020-12-16 10:41:03Z milde $
+# $Id: body.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -38,14 +38,15 @@
         self.assert_has_content()
         if self.arguments:  # title (in sidebars optional)
             title_text = self.arguments0
-            textnodes, messages = self.state.inline_text(title_text, self.lineno)
+            textnodes, messages = self.state.inline_text(
+                                      title_text, self.lineno)
             titles = nodes.title(title_text, '', *textnodes)
             # Sidebar uses this code.
             if 'subtitle' in self.options:
                 textnodes, more_messages = self.state.inline_text(
                     self.options'subtitle', self.lineno)
                 titles.append(nodes.subtitle(self.options'subtitle', '',
-                                            *textnodes))
+                                             *textnodes))
                 messages.extend(more_messages)
         else:
             titles = 
@@ -136,8 +137,8 @@
     optional_arguments = 1
     option_spec = {'class': directives.class_option,
                    'name': directives.unchanged,
-                   'number-lines': directives.unchanged # integer or None
-                  }
+                   'number-lines': directives.unchanged  # integer or None
+                   }
     has_content = True
 
     def run(self):
@@ -155,12 +156,12 @@
 
         # set up lexical analyzer
         try:
-            tokens = Lexer(u'\n'.join(self.content), language,
+            tokens = Lexer('\n'.join(self.content), language,
                            self.state.document.settings.syntax_highlight)
         except LexerError as error:
             if self.state.document.settings.report_level > 2:
-                # don't report warnings -> insert without syntax highligt
-                tokens = Lexer(u'\n'.join(self.content), language, 'none')
+                # don't report warnings -> insert without syntax highlight
+                tokens = Lexer('\n'.join(self.content), language, 'none')
             else:
                 raise self.warning(error)
 
@@ -193,9 +194,10 @@
 class MathBlock(Directive):
 
     option_spec = {'class': directives.class_option,
-                   'name': directives.unchanged}
-                   ## TODO: Add Sphinx' ``mathbase.py`` option 'nowrap'?
+                   'name': directives.unchanged,
+                   # TODO: Add Sphinx' ``mathbase.py`` option 'nowrap'?
                    # 'nowrap': directives.flag,
+                   }
     has_content = True
 
     def run(self):

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/html.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/html.py Changed

@@ -1,88 +1,21 @@
-# $Id: html.py 8603 2021-01-08 15:24:32Z milde $
+# $Id: html.py 9062 2022-05-30 21:09:09Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
-Directives for typically HTML-specific constructs.
+Dummy module for backwards compatibility.
+
+This module is provisional: it will be removed in Docutils 2.0.
 """
 
 __docformat__ = 'reStructuredText'
 
-import sys
-from docutils import nodes, utils
-from docutils.parsers.rst import Directive
-from docutils.parsers.rst import states
-from docutils.transforms import components
-
-
-class MetaBody(states.SpecializedBody):
-
-    class meta(nodes.Special, nodes.PreBibliographic, nodes.Element):
-        """HTML-specific "meta" element."""
-        pass
-
-    def field_marker(self, match, context, next_state):
-        """Meta element."""
-        node, blank_finish = self.parsemeta(match)
-        self.parent += node
-        return , next_state, 
-
-    def parsemeta(self, match):
-        name = self.parse_field_marker(match)
-        name = utils.unescape(utils.escape2null(name))
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
-        node = self.meta()
-        pending = nodes.pending(components.Filter,
-                                {'component': 'writer',
-                                 'format': 'html,latex,odt',
-                                 'nodes': node})
-        node'content' = utils.unescape(utils.escape2null(
-                                            ' '.join(indented)))
-        if not indented:
-            line = self.state_machine.line
-            msg = self.reporter.info(
-                  'No content for meta tag "%s".' % name,
-                  nodes.literal_block(line, line))
-            return msg, blank_finish
-        tokens = name.split()
-        try:
-            attname, val = utils.extract_name_value(tokens0)0
-            nodeattname.lower() = val
-        except utils.NameValueError:
-            node'name' = tokens0
-        for token in tokens1::
-            try:
-                attname, val = utils.extract_name_value(token)0
-                nodeattname.lower() = val
-            except utils.NameValueError as detail:
-                line = self.state_machine.line
-                msg = self.reporter.error(
-                      'Error parsing meta tag attribute "%s": %s.'
-                      % (token, detail), nodes.literal_block(line, line))
-                return msg, blank_finish
-        self.document.note_pending(pending)
-        return pending, blank_finish
-
-
-class Meta(Directive):
-
-    has_content = True
+import warnings
 
-    SMkwargs = {'state_classes': (MetaBody,)}
+from docutils.parsers.rst.directives.misc import MetaBody, Meta  # noqa: F401
 
-    def run(self):
-        self.assert_has_content()
-        node = nodes.Element()
-        new_line_offset, blank_finish = self.state.nested_list_parse(
-            self.content, self.content_offset, node,
-            initial_state='MetaBody', blank_finish=True,
-            state_machine_kwargs=self.SMkwargs)
-        if (new_line_offset - self.content_offset) != len(self.content):
-            # incomplete parse of block?
-            error = self.state_machine.reporter.error(
-                'Invalid meta directive.',
-                nodes.literal_block(self.block_text, self.block_text),
-                line=self.lineno)
-            node += error
-        return node.children
+warnings.warn('The `docutils.parsers.rst.directive.html` module'
+              ' will be removed in Docutils 2.0.'
+              ' Since Docutils 0.18, the "Meta" node is defined in'
+              ' `docutils.parsers.rst.directives.misc`.',
+              DeprecationWarning, stacklevel=2)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/images.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/images.py Changed

@@ -1,4 +1,4 @@
-# $Id: images.py 8583 2020-12-01 10:53:27Z milde $
+# $Id: images.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,29 +8,23 @@
 
 __docformat__ = 'reStructuredText'
 
+from urllib.request import url2pathname
 
-import sys
-
-from docutils import nodes, utils
-from docutils.parsers.rst import Directive
-from docutils.parsers.rst import directives, states
-from docutils.nodes import fully_normalize_name, whitespace_normalize_name
-from docutils.parsers.rst.roles import set_classes
-
-try: # check for the Python Imaging Library
+try:  # check for the Python Imaging Library
     import PIL.Image
 except ImportError:
     try:  # sometimes PIL modules are put in PYTHONPATH's root
         import Image
-        class PIL(object): pass  # dummy wrapper
+        class PIL: pass  # noqa:E701  dummy wrapper
         PIL.Image = Image
     except ImportError:
         PIL = None
 
-if sys.version_info >= (3, 0):
-    from urllib.request import url2pathname
-else:
-    from urllib import url2pathname
+from docutils import nodes
+from docutils.nodes import fully_normalize_name, whitespace_normalize_name
+from docutils.parsers.rst import Directive
+from docutils.parsers.rst import directives, states
+from docutils.parsers.rst.roles import set_classes
 
 
 class Image(Directive):
@@ -134,15 +128,13 @@
             if PIL and self.state.document.settings.file_insertion_enabled:
                 imagepath = url2pathname(image_node'uri')
                 try:
-                    img = PIL.Image.open(
-                            imagepath.encode(sys.getfilesystemencoding()))
-                except (IOError, UnicodeEncodeError):
-                    pass # TODO: warn?
+                    with PIL.Image.open(imagepath) as img:
+                        figure_node'width' = '%dpx' % img.size0
+                except (OSError, UnicodeEncodeError):
+                    pass  # TODO: warn/info?
                 else:
                     self.state.document.settings.record_dependencies.add(
                         imagepath.replace('\\', '/'))
-                    figure_node'width' = '%dpx' % img.size0
-                    del img
         elif figwidth is not None:
             figure_node'width' = figwidth
         if figclasses:
@@ -161,7 +153,7 @@
                 figure_node += caption
             elif not (isinstance(first_node, nodes.comment)
                       and len(first_node) == 0):
-                error = self.state_machine.reporter.error(
+                error = self.reporter.error(
                       'Figure caption must be a paragraph or empty comment.',
                       nodes.literal_block(self.block_text, self.block_text),
                       line=self.lineno)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/misc.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/misc.py Changed

@@ -1,4 +1,4 @@
-# $Id: misc.py 8595 2020-12-15 23:06:58Z milde $
+# $Id: misc.py 9358 2023-04-19 23:31:13Z milde $
 # Authors: David Goodger <goodger@python.org>; Dethe Elza
 # Copyright: This module has been placed in the public domain.
 
@@ -6,19 +6,19 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
-import os.path
+from pathlib import Path
 import re
 import time
+from urllib.request import urlopen
+from urllib.error import URLError
+
 from docutils import io, nodes, statemachine, utils
-from docutils.utils.error_reporting import SafeString, ErrorString
-from docutils.utils.error_reporting import locale_encoding
 from docutils.parsers.rst import Directive, convert_directive_function
 from docutils.parsers.rst import directives, roles, states
 from docutils.parsers.rst.directives.body import CodeBlock, NumberLines
-from docutils.parsers.rst.roles import set_classes
 from docutils.transforms import misc
 
+
 class Include(Directive):
 
     """
@@ -29,6 +29,8 @@
     a part of the given file argument may be included by specifying
     start and end line or text to match before and/or after the text
     to be used.
+
+    https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment
     """
 
     required_arguments = 1
@@ -44,44 +46,46 @@
                    'start-after': directives.unchanged_required,
                    'end-before': directives.unchanged_required,
                    # ignored except for 'literal' or 'code':
-                   'number-lines': directives.unchanged, # integer or None
+                   'number-lines': directives.unchanged,  # integer or None
                    'class': directives.class_option,
                    'name': directives.unchanged}
 
-    standard_include_path = os.path.join(os.path.dirname(states.__file__),
-                                         'include')
+    standard_include_path = Path(states.__file__).parent / 'include'
 
     def run(self):
-        """Include a file as part of the content of this reST file."""
+        """Include a file as part of the content of this reST file.
+
+        Depending on the options, the file (or a clipping) is
+        converted to nodes and returned or inserted into the input stream.
+        """
         if not self.state.document.settings.file_insertion_enabled:
             raise self.warning('"%s" directive disabled.' % self.name)
-        source = self.state_machine.input_lines.source(
-            self.lineno - self.state_machine.input_offset - 1)
-        source_dir = os.path.dirname(os.path.abspath(source))
+        current_source = self.state.document.current_source
         path = directives.path(self.arguments0)
         if path.startswith('<') and path.endswith('>'):
-            path = os.path.join(self.standard_include_path, path1:-1)
-        path = os.path.normpath(os.path.join(source_dir, path))
-        path = utils.relative_path(None, path)
-        path = nodes.reprunicode(path)
+            _base = self.standard_include_path
+            path = path1:-1
+        else:
+            _base = Path(current_source).parent
+        path = utils.relative_path(None, _base/path)
         encoding = self.options.get(
             'encoding', self.state.document.settings.input_encoding)
-        e_handler=self.state.document.settings.input_encoding_error_handler
+        e_handler = self.state.document.settings.input_encoding_error_handler
         tab_width = self.options.get(
             'tab-width', self.state.document.settings.tab_width)
         try:
-            self.state.document.settings.record_dependencies.add(path)
             include_file = io.FileInput(source_path=path,
                                         encoding=encoding,
                                         error_handler=e_handler)
-        except UnicodeEncodeError as error:
-            raise self.severe(u'Problems with "%s" directive path:\n'
-                              'Cannot encode input file path "%s" '
-                              '(wrong locale?).' %
-                              (self.name, SafeString(path)))
-        except IOError as error:
-            raise self.severe(u'Problems with "%s" directive path:\n%s.' %
-                      (self.name, ErrorString(error)))
+        except UnicodeEncodeError:
+            raise self.severe(f'Problems with "{self.name}" directive path:\n'
+                              f'Cannot encode input file path "{path}" '
+                              '(wrong locale?).')
+        except OSError as error:
+            raise self.severe(f'Problems with "{self.name}" directive '
+                              f'path:\n{io.error_string(error)}.')
+        else:
+            self.state.document.settings.record_dependencies.add(path)
 
         # Get to-be-included content
         startline = self.options.get('start-line', None)
@@ -93,8 +97,8 @@
             else:
                 rawtext = include_file.read()
         except UnicodeError as error:
-            raise self.severe(u'Problem with "%s" directive:\n%s' %
-                              (self.name, ErrorString(error)))
+            raise self.severe(f'Problem with "{self.name}" directive:\n'
+                              + io.error_string(error))
         # start-after/end-before: no restrictions on newlines in match-text,
         # and no restrictions on matching inside lines vs. line boundaries
         after_text = self.options.get('start-after', None)
@@ -127,8 +131,9 @@
                 text = rawtext.expandtabs(tab_width)
             else:
                 text = rawtext
-            literal_block = nodes.literal_block(rawtext, source=path,
-                                    classes=self.options.get('class', ))
+            literal_block = nodes.literal_block(
+                                rawtext, source=path,
+                                classes=self.options.get('class', ))
             literal_block.line = 1
             self.add_name(literal_block)
             if 'number-lines' in self.options:
@@ -157,9 +162,9 @@
             if tab_width < 0:
                 include_lines = rawtext.splitlines()
             codeblock = CodeBlock(self.name,
-                                  self.options.pop('code'), # arguments
+                                  self.options.pop('code'),  # arguments
                                   self.options,
-                                  include_lines, # content
+                                  include_lines,  # content
                                   self.lineno,
                                   self.content_offset,
                                   self.block_text,
@@ -167,36 +172,37 @@
                                   self.state_machine)
             return codeblock.run()
 
+        # Prevent circular inclusion:
+        clip_options = (startline, endline, before_text, after_text)
+        include_log = self.state.document.include_log
+        # log entries are tuples (<source>, <clip-options>)
+        if not include_log:  # new document, initialize with document source
+            include_log.append((utils.relative_path(None, current_source),
+                                (None, None, None, None)))
+        if (path, clip_options) in include_log:
+            master_paths = (pth for (pth, opt) in reversed(include_log))
+            inclusion_chain = '\n> '.join((path, *master_paths))
+            raise self.warning('circular inclusion in "%s" directive:\n%s'
+                               % (self.name, inclusion_chain))
+
         if 'parser' in self.options:
-            parser = self.options'parser'()
-            # parse into a new (dummy) document
+            # parse into a dummy document and return created nodes
             document = utils.new_document(path, self.state.document.settings)
+            document.include_log = include_log + (path, clip_options)
+            parser = self.options'parser'()
             parser.parse('\n'.join(include_lines), document)
+            # clean up doctree and complete parsing
+            document.transformer.populate_from_components((parser,))
+            document.transformer.apply_transforms()
             return document.children
 
-        # include as rST source
+        # Include as rST source:
         #
-        # Prevent circular inclusion:
-        source = utils.relative_path(None, source)
-        clip_options = (startline, endline, before_text, after_text)
-        include_log = self.state.document.include_log
-        if not include_log: # new document:
-            # log entries: (<source>, <clip-options>, <insertion end index>)
-            include_log = (source, (None,None,None,None), sys.maxsize/2)
-        # cleanup: we may have passed the last inclusion(s):
-        include_log = entry for entry in include_log
-                       if entry2 >= self.lineno
-        if (path, clip_options) in (pth, opt)
-                                    for (pth, opt, e) in include_log:
-            raise self.warning('circular inclusion in "%s" directive: %s'
-                % (self.name, ' < '.join(path + pth for (pth, opt, e)
-                                                   in include_log::-1)))
-        # include as input
+        # mark end (cf. parsers.rst.states.Body.comment())
+        include_lines += '', '.. end of inclusion from "%s"' % path
         self.state_machine.insert_input(include_lines, path)
         # update include-log
-        include_log.append((path, clip_options, self.lineno))
-        self.state.document.include_log = (pth, opt, e+len(include_lines)+2)
-                                           for (pth, opt, e) in include_log
+        include_log.append((path, clip_options))
         return 
 
 
@@ -216,7 +222,8 @@
     final_argument_whitespace = True
     option_spec = {'file': directives.path,
                    'url': directives.uri,
-                   'encoding': directives.encoding}
+                   'encoding': directives.encoding,
+                   'class': directives.class_option}
     has_content = True
 
     def run(self):
@@ -228,7 +235,7 @@
         attributes = {'format': ' '.join(self.arguments0.lower().split())}
         encoding = self.options.get(
             'encoding', self.state.document.settings.input_encoding)
-        e_handler=self.state.document.settings.input_encoding_error_handler
+        e_handler = self.state.document.settings.input_encoding_error_handler
         if self.content:
             if 'file' in self.options or 'url' in self.options:
                 raise self.error(
@@ -240,57 +247,50 @@
                 raise self.error(
                     'The "file" and "url" options may not be simultaneously '
                     'specified for the "%s" directive.' % self.name)
-            source_dir = os.path.dirname(
-                os.path.abspath(self.state.document.current_source))
-            path = os.path.normpath(os.path.join(source_dir,
-                                                 self.options'file'))
-            path = utils.relative_path(None, path)
+            path = self.options'file'
+            _base = Path(self.state.document.current_source).parent
+            path = utils.relative_path(None, _base/path)
             try:
                 raw_file = io.FileInput(source_path=path,
                                         encoding=encoding,
                                         error_handler=e_handler)
+            except OSError as error:
+                raise self.severe(f'Problems with "{self.name}" directive '
+                                  f'path:\n{io.error_string(error)}.')
+            else:
                 # TODO: currently, raw input files are recorded as
                 # dependencies even if not used for the chosen output format.
                 self.state.document.settings.record_dependencies.add(path)
-            except IOError as error:
-                raise self.severe(u'Problems with "%s" directive path:\n%s.'
-                                  % (self.name, ErrorString(error)))
             try:
                 text = raw_file.read()
             except UnicodeError as error:
-                raise self.severe(u'Problem with "%s" directive:\n%s'
-                    % (self.name, ErrorString(error)))
+                raise self.severe(f'Problem with "{self.name}" directive:\n'
+                                  + io.error_string(error))
             attributes'source' = path
         elif 'url' in self.options:
             source = self.options'url'
-            # Do not import urllib2 at the top of the module because
-            # it may fail due to broken SSL dependencies, and it takes
-            # about 0.15 seconds to load.
-            if sys.version_info >= (3, 0):
-                from urllib.request import urlopen
-                from urllib.error import URLError
-            else:
-                from urllib2 import urlopen, URLError
             try:
                 raw_text = urlopen(source).read()
-            except (URLError, IOError, OSError) as error:
-                raise self.severe(u'Problems with "%s" directive URL "%s":\n%s.'
-                    % (self.name, self.options'url', ErrorString(error)))
+            except (URLError, OSError) as error:
+                raise self.severe(f'Problems with "{self.name}" directive URL '
+                                  f'"{self.options"url"}":\n'
+                                  f'{io.error_string(error)}.')
             raw_file = io.StringInput(source=raw_text, source_path=source,
                                       encoding=encoding,
                                       error_handler=e_handler)
             try:
                 text = raw_file.read()
             except UnicodeError as error:
-                raise self.severe(u'Problem with "%s" directive:\n%s'
-                                  % (self.name, ErrorString(error)))
+                raise self.severe(f'Problem with "{self.name}" directive:\n'
+                                  + io.error_string(error))
             attributes'source' = source
         else:
             # This will always fail because there is no content.
             self.assert_has_content()
-        raw_node = nodes.raw('', text, **attributes)
+        raw_node = nodes.raw('', text, classes=self.options.get('class', ),
+                             **attributes)
         (raw_node.source,
-        raw_node.line) = self.state_machine.get_source_and_line(self.lineno)
+         raw_node.line) = self.state_machine.get_source_and_line(self.lineno)
         return raw_node
 
 
@@ -319,13 +319,14 @@
                 messages.append(elem)
             else:
                 return 
-                    self.state_machine.reporter.error(
-                        'Error in "%s" directive: may contain a single paragraph '
-                        'only.' % (self.name), line=self.lineno) 
+                    self.reporter.error(
+                        f'Error in "{self.name}" directive: may contain '
+                        'a single paragraph only.', line=self.lineno)
         if node:
             return messages + node.children
         return messages
 
+
 class Unicode(Directive):
 
     r"""
@@ -364,8 +365,8 @@
             try:
                 decoded = directives.unicode_code(code)
             except ValueError as error:
-                raise self.error(u'Invalid character code: %s\n%s'
-                    % (code, ErrorString(error)))
+                raise self.error('Invalid character code: %s\n%s'
+                                 % (code, io.error_string(error)))
             element += nodes.Text(decoded)
         return element.children
 
@@ -445,12 +446,12 @@
             'supported (specified by "%r" role).' % (self.name, base_role))
         try:
             converted_role = convert_directive_function(base_role)
-            (arguments, options, content, content_offset) = (
-                self.state.parse_directive_block(
-                self.content1:, self.content_offset, converted_role,
-                option_presets={}))
+            (arguments, options, content, content_offset
+             ) = self.state.parse_directive_block(
+                    self.content1:, self.content_offset,
+                    converted_role, option_presets={})
         except states.MarkupError as detail:
-            error = self.state_machine.reporter.error(
+            error = self.reporter.error(
                 'Error in "%s" directive:\n%s.' % (self.name, detail),
                 nodes.literal_block(self.block_text, self.block_text),
                 line=self.lineno)
@@ -459,10 +460,11 @@
             try:
                 options'class' = directives.class_option(new_role_name)
             except ValueError as detail:
-                error = self.state_machine.reporter.error(
-                    u'Invalid argument for "%s" directive:\n%s.'
-                    % (self.name, SafeString(detail)), nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                error = self.reporter.error(
+                    'Invalid argument for "%s" directive:\n%s.'
+                    % (self.name, detail),
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 return messages + error
         role = roles.CustomRole(new_role_name, base_role, options, content)
         roles.register_local_role(new_role_name, role)
@@ -506,6 +508,74 @@
         return 
 
 
+class MetaBody(states.SpecializedBody):
+
+    def field_marker(self, match, context, next_state):
+        """Meta element."""
+        node, blank_finish = self.parsemeta(match)
+        self.parent += node
+        return , next_state, 
+
+    def parsemeta(self, match):
+        name = self.parse_field_marker(match)
+        name = nodes.unescape(utils.escape2null(name))
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
+        node = nodes.meta()
+        node'content' = nodes.unescape(utils.escape2null(
+                                            ' '.join(indented)))
+        if not indented:
+            line = self.state_machine.line
+            msg = self.reporter.info(
+                  'No content for meta tag "%s".' % name,
+                  nodes.literal_block(line, line))
+            return msg, blank_finish
+        tokens = name.split()
+        try:
+            attname, val = utils.extract_name_value(tokens0)0
+            nodeattname.lower() = val
+        except utils.NameValueError:
+            node'name' = tokens0
+        for token in tokens1::
+            try:
+                attname, val = utils.extract_name_value(token)0
+                nodeattname.lower() = val
+            except utils.NameValueError as detail:
+                line = self.state_machine.line
+                msg = self.reporter.error(
+                      'Error parsing meta tag attribute "%s": %s.'
+                      % (token, detail), nodes.literal_block(line, line))
+                return msg, blank_finish
+        return node, blank_finish
+
+
+class Meta(Directive):
+
+    has_content = True
+
+    SMkwargs = {'state_classes': (MetaBody,)}
+
+    def run(self):
+        self.assert_has_content()
+        node = nodes.Element()
+        new_line_offset, blank_finish = self.state.nested_list_parse(
+            self.content, self.content_offset, node,
+            initial_state='MetaBody', blank_finish=True,
+            state_machine_kwargs=self.SMkwargs)
+        if (new_line_offset - self.content_offset) != len(self.content):
+            # incomplete parse of block?
+            error = self.reporter.error(
+                'Invalid meta directive.',
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
+            node += error
+        # insert at begin of document
+        index = self.state.document.first_child_not_matching_class(
+                                        (nodes.Titular, nodes.meta)) or 0
+        self.state.documentindex:index = node.children
+        return 
+
+
 class Date(Directive):
 
     has_content = True
@@ -516,12 +586,6 @@
                 'Invalid context: the "%s" directive can only be used within '
                 'a substitution definition.' % self.name)
         format_str = '\n'.join(self.content) or '%Y-%m-%d'
-        if sys.version_info< (3, 0):
-            try:
-                format_str = format_str.encode(locale_encoding or 'utf-8')
-            except UnicodeEncodeError:
-                raise self.warning(u'Cannot encode date format string '
-                    u'with locale encoding "%s".' % locale_encoding)
         # @@@
         # Use timestamp from the `SOURCE_DATE_EPOCH`_ environment variable?
         # Pro: Docutils-generated documentation
@@ -539,14 +603,6 @@
         #                          time.gmtime(int(source_date_epoch)))
         # else:
         text = time.strftime(format_str)
-        if sys.version_info< (3, 0):
-            # `text` is a byte string that may contain non-ASCII characters:
-            try:
-                text = text.decode(locale_encoding or 'utf-8')
-            except UnicodeDecodeError:
-                text = text.decode(locale_encoding or 'utf-8', 'replace')
-                raise self.warning(u'Error decoding "%s"'
-                    u'with locale encoding "%s".' % (text, locale_encoding))
         return nodes.Text(text)
 
 
@@ -562,34 +618,13 @@
     def run(self):
         if self.content:
             text = '\n'.join(self.content)
-            info = self.state_machine.reporter.info(
+            info = self.reporter.info(
                 'Directive processed. Type="%s", arguments=%r, options=%r, '
                 'content:' % (self.name, self.arguments, self.options),
                 nodes.literal_block(text, text), line=self.lineno)
         else:
-            info = self.state_machine.reporter.info(
+            info = self.reporter.info(
                 'Directive processed. Type="%s", arguments=%r, options=%r, '
                 'content: None' % (self.name, self.arguments, self.options),
                 line=self.lineno)
         return info
-
-# Old-style, functional definition:
-#
-# def directive_test_function(name, arguments, options, content, lineno,
-#                             content_offset, block_text, state, state_machine):
-#     """This directive is useful only for testing purposes."""
-#     if content:
-#         text = '\n'.join(content)
-#         info = state_machine.reporter.info(
-#             'Directive processed. Type="%s", arguments=%r, options=%r, '
-#             'content:' % (name, arguments, options),
-#             nodes.literal_block(text, text), line=lineno)
-#     else:
-#         info = state_machine.reporter.info(
-#             'Directive processed. Type="%s", arguments=%r, options=%r, '
-#             'content: None' % (name, arguments, options), line=lineno)
-#     return info
-#
-# directive_test_function.arguments = (0, 1, 1)
-# directive_test_function.options = {'option': directives.unchanged_required}
-# directive_test_function.content = 1

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/parts.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/parts.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/directives/tables.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/directives/tables.py Changed

@@ -1,4 +1,4 @@
-# $Id: tables.py 8377 2019-08-27 19:49:45Z milde $
+# $Id: tables.py 9363 2023-04-24 16:37:37Z aa-turner $
 # Authors: David Goodger <goodger@python.org>; David Priest
 # Copyright: This module has been placed in the public domain.
 
@@ -9,15 +9,16 @@
 __docformat__ = 'reStructuredText'
 
 
-import sys
-import os.path
 import csv
+from pathlib import Path
+import warnings
 
 from docutils import io, nodes, statemachine, utils
-from docutils.utils.error_reporting import SafeString
 from docutils.utils import SystemMessagePropagation
 from docutils.parsers.rst import Directive
 from docutils.parsers.rst import directives
+from urllib.request import urlopen
+from urllib.error import URLError
 
 
 def align(argument):
@@ -54,45 +55,56 @@
         return title, messages
 
     def process_header_option(self):
+        # Provisional
+        # * Will move to CSVTable in Docutils 0.21
+        #   as it calls `self.HeaderDialect()` only defined in CSVTable.
+        # * Will change to use the same CSV dialect as the body to get in line
+        #   with the specification in ref/rst/directives.txt in Docutils 0.21.
         source = self.state_machine.get_source(self.lineno - 1)
         table_head = 
         max_header_cols = 0
         if 'header' in self.options:   # separate table header in option
+            with warnings.catch_warnings():
+                warnings.simplefilter('ignore')
+                header_dialect = self.HeaderDialect()
             rows, max_header_cols = self.parse_csv_data_into_rows(
-                self.options'header'.split('\n'), self.HeaderDialect(),
+                self.options'header'.split('\n'), header_dialect,
                 source)
             table_head.extend(rows)
         return table_head, max_header_cols
 
     def check_table_dimensions(self, rows, header_rows, stub_columns):
         if len(rows) < header_rows:
-            error = self.state_machine.reporter.error(
-                '%s header row(s) specified but only %s row(s) of data '
-                'supplied ("%s" directive).'
-                % (header_rows, len(rows), self.name), nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            error = self.reporter.error('%s header row(s) specified but '
+                'only %s row(s) of data supplied ("%s" directive).'
+                % (header_rows, len(rows), self.name),
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             raise SystemMessagePropagation(error)
         if len(rows) == header_rows > 0:
-            error = self.state_machine.reporter.error(
-                'Insufficient data supplied (%s row(s)); no data remaining '
-                'for table body, required by "%s" directive.'
-                % (len(rows), self.name), nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            error = self.reporter.error(
+                f'Insufficient data supplied ({len(rows)} row(s)); '
+                'no data remaining for table body, '
+                f'required by "{self.name}" directive.',
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             raise SystemMessagePropagation(error)
         for row in rows:
             if len(row) < stub_columns:
-                error = self.state_machine.reporter.error(
-                    '%s stub column(s) specified but only %s columns(s) of '
-                    'data supplied ("%s" directive).' %
-                    (stub_columns, len(row), self.name), nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                error = self.reporter.error(
+                    f'{stub_columns} stub column(s) specified '
+                    f'but only {len(row)} columns(s) of data supplied '
+                    f'("{self.name}" directive).',
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
             if len(row) == stub_columns > 0:
-                error = self.state_machine.reporter.error(
-                    'Insufficient data supplied (%s columns(s)); no data remaining '
-                    'for table body, required by "%s" directive.'
-                    % (len(row), self.name), nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                error = self.reporter.error(
+                    'Insufficient data supplied (%s columns(s)); '
+                    'no data remaining for table body, required '
+                    'by "%s" directive.' % (len(row), self.name),
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
 
     def set_table_width(self, table_node):
@@ -103,21 +115,22 @@
     def widths(self):
         return self.options.get('widths', '')
 
-    def get_column_widths(self, max_cols):
+    def get_column_widths(self, n_cols):
         if isinstance(self.widths, list):
-            if len(self.widths) != max_cols:
-                error = self.state_machine.reporter.error(
-                    '"%s" widths do not match the number of columns in table '
-                    '(%s).' % (self.name, max_cols), nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+            if len(self.widths) != n_cols:
+                # TODO: use last value for missing columns?
+                error = self.reporter.error('"%s" widths do not match the '
+                    'number of columns in table (%s).' % (self.name, n_cols),
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
             col_widths = self.widths
-        elif max_cols:
-            col_widths = 100 // max_cols * max_cols
+        elif n_cols:
+            col_widths = 100 // n_cols * n_cols
         else:
-            error = self.state_machine.reporter.error(
-                'No table data detected in CSV file.', nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            error = self.reporter.error('No table data detected in CSV file.',
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             raise SystemMessagePropagation(error)
         return col_widths
 
@@ -129,40 +142,46 @@
 
 
 class RSTTable(Table):
+    """
+    Class for the `"table" directive`__ for formal tables using rST syntax.
+
+    __ https://docutils.sourceforge.io/docs/ref/rst/directives.html
+    """
 
     def run(self):
         if not self.content:
-            warning = self.state_machine.reporter.warning(
-                'Content block expected for the "%s" directive; none found.'
-                % self.name, nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            warning = self.reporter.warning('Content block expected '
+                'for the "%s" directive; none found.' % self.name,
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             return warning
         title, messages = self.make_title()
         node = nodes.Element()          # anonymous container for parsing
         self.state.nested_parse(self.content, self.content_offset, node)
         if len(node) != 1 or not isinstance(node0, nodes.table):
-            error = self.state_machine.reporter.error(
-                'Error parsing content block for the "%s" directive: exactly '
-                'one table expected.' % self.name, nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            error = self.reporter.error('Error parsing content block for the '
+                '"%s" directive: exactly one table expected.' % self.name,
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             return error
         table_node = node0
         table_node'classes' += self.options.get('class', )
         self.set_table_width(table_node)
         if 'align' in self.options:
             table_node'align' = self.options.get('align')
-        tgroup = table_node0
         if isinstance(self.widths, list):
+            tgroup = table_node0
+            try:
+                col_widths = self.get_column_widths(tgroup"cols")
+            except SystemMessagePropagation as detail:
+                return detail.args0
             colspecs = child for child in tgroup.children
                         if child.tagname == 'colspec'
-            for colspec, col_width in zip(colspecs, self.widths):
+            for colspec, col_width in zip(colspecs, col_widths):
                 colspec'colwidth' = col_width
-        # @@@ the colwidths argument for <tgroup> is not part of the
-        # XML Exchange Table spec (https://www.oasis-open.org/specs/tm9901.htm)
-        # and hence violates the docutils.dtd.
         if self.widths == 'auto':
             table_node'classes' += 'colwidths-auto'
-        elif self.widths: # "grid" or list of integers
+        elif self.widths:  # "grid" or list of integers
             table_node'classes' += 'colwidths-given'
         self.add_name(table_node)
         if title:
@@ -191,7 +210,7 @@
                    # text field quote/unquote char:
                    'quote': directives.single_char_or_unicode,
                    # char used to escape delim & quote as-needed:
-                   'escape': directives.single_char_or_unicode,}
+                   'escape': directives.single_char_or_unicode}
 
     class DocutilsDialect(csv.Dialect):
 
@@ -207,21 +226,36 @@
 
         def __init__(self, options):
             if 'delim' in options:
-                self.delimiter = CSVTable.encode_for_csv(options'delim')
+                self.delimiter = options'delim'
             if 'keepspace' in options:
                 self.skipinitialspace = False
             if 'quote' in options:
-                self.quotechar = CSVTable.encode_for_csv(options'quote')
+                self.quotechar = options'quote'
             if 'escape' in options:
                 self.doublequote = False
-                self.escapechar = CSVTable.encode_for_csv(options'escape')
-            csv.Dialect.__init__(self)
-
+                self.escapechar = options'escape'
+            super().__init__()
 
     class HeaderDialect(csv.Dialect):
+        """
+        CSV dialect used for the "header" option data.
 
-        """CSV dialect to use for the "header" option data."""
-
+        Deprecated. Will be removed in Docutils 0.22.
+        """
+        # The separate HeaderDialect was introduced in revision 2294
+        # (2004-06-17) in the sandbox before the "csv-table" directive moved
+        # to the trunk in r2309. Discussion in docutils-devel around this time
+        # did not mention a rationale (part of the discussion was in private
+        # mail).
+        # This is in conflict with the documentation, which always said:
+        # ""
+        # and did not change in this aspect.
+        #
+        # Maybe it was intended to have similar escape rules for rST and CSV,
+        # however with the current implementation this means we need
+        # `\\` for rST markup and ``\\\\`` for a literal backslash
+        # in the "option" header but ``\`` and ``\\`` in the header-lines and
+        # table cells of the main CSV data.
         delimiter = ','
         quotechar = '"'
         escapechar = '\\'
@@ -231,20 +265,29 @@
         lineterminator = '\n'
         quoting = csv.QUOTE_MINIMAL
 
-    def check_requirements(self):
-        pass
+        def __init__(self):
+            warnings.warn('CSVTable.HeaderDialect will be removed '
+                          'in Docutils 0.22.',
+                          PendingDeprecationWarning, stacklevel=2)
+            super().__init__()
+
+    @staticmethod
+    def check_requirements():
+        warnings.warn('CSVTable.check_requirements()'
+                      ' is not required with Python 3'
+                      ' and will be removed in Docutils 0.22.',
+                      DeprecationWarning, stacklevel=2)
 
     def run(self):
         try:
             if (not self.state.document.settings.file_insertion_enabled
                 and ('file' in self.options
                      or 'url' in self.options)):
-                warning = self.state_machine.reporter.warning(
-                    'File and URL access deactivated; ignoring "%s" '
-                    'directive.' % self.name, nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                warning = self.reporter.warning('File and URL access '
+                    'deactivated; ignoring "%s" directive.' % self.name,
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 return warning
-            self.check_requirements()
             title, messages = self.make_title()
             csv_data, source = self.get_csv_data()
             table_head, max_header_cols = self.process_header_option()
@@ -263,12 +306,10 @@
             return detail.args0
         except csv.Error as detail:
             message = str(detail)
-            if sys.version_info < (3, 0) and '1-character string' in message:
-                message += '\nwith Python 2.x this must be an ASCII character.'
-            error = self.state_machine.reporter.error(
-                'Error with CSV data in "%s" directive:\n%s'
-                % (self.name, message), nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+            error = self.reporter.error('Error with CSV data'
+                ' in "%s" directive:\n%s' % (self.name, message),
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             return error
         table = (col_widths, table_head, table_body)
         table_node = self.state.build_table(table, self.content_offset,
@@ -289,106 +330,96 @@
         """
         encoding = self.options.get(
             'encoding', self.state.document.settings.input_encoding)
-        error_handler = self.state.document.settings.input_encoding_error_handler
+        error_handler = self.state.document.settings.input_encoding_error_handler  # noqa:E501
         if self.content:
             # CSV data is from directive content.
             if 'file' in self.options or 'url' in self.options:
-                error = self.state_machine.reporter.error(
-                    '"%s" directive may not both specify an external file and'
-                    ' have content.' % self.name, nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                error = self.reporter.error('"%s" directive may not both '
+                    'specify an external file and have content.' % self.name,
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
             source = self.content.source(0)
             csv_data = self.content
         elif 'file' in self.options:
             # CSV data is from an external file.
             if 'url' in self.options:
-                error = self.state_machine.reporter.error(
-                      'The "file" and "url" options may not be simultaneously'
-                      ' specified for the "%s" directive.' % self.name,
-                      nodes.literal_block(self.block_text, self.block_text),
-                      line=self.lineno)
+                error = self.reporter.error('The "file" and "url" options '
+                    'may not be simultaneously specified '
+                    'for the "%s" directive.' % self.name,
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
-            source_dir = os.path.dirname(
-                os.path.abspath(self.state.document.current_source))
-            source = os.path.normpath(os.path.join(source_dir,
-                                                   self.options'file'))
-            source = utils.relative_path(None, source)
+            source = self.options'file'
+            # resolve path to external file
+            _base = Path(self.state.document.current_source).parent
+            source = utils.relative_path(None, _base/source)
             try:
-                self.state.document.settings.record_dependencies.add(source)
                 csv_file = io.FileInput(source_path=source,
                                         encoding=encoding,
                                         error_handler=error_handler)
                 csv_data = csv_file.read().splitlines()
-            except IOError as error:
-                severe = self.state_machine.reporter.severe(
-                    u'Problems with "%s" directive path:\n%s.'
-                    % (self.name, SafeString(error)),
+            except OSError as error:
+                severe = self.reporter.severe(
+                    'Problems with "%s" directive path:\n%s.'
+                    % (self.name, error),
                     nodes.literal_block(self.block_text, self.block_text),
                     line=self.lineno)
                 raise SystemMessagePropagation(severe)
-        elif 'url' in self.options:
-            # CSV data is from a URL.
-            # Do not import urllib2 at the top of the module because
-            # it may fail due to broken SSL dependencies, and it takes
-            # about 0.15 seconds to load.
-            if sys.version_info >= (3, 0):
-                from urllib.request import urlopen
-                from urllib.error import URLError
             else:
-                from urllib2 import urlopen, URLError
-
+                self.state.document.settings.record_dependencies.add(source)
+        elif 'url' in self.options:
             source = self.options'url'
             try:
-                csv_text = urlopen(source).read()
-            except (URLError, IOError, OSError, ValueError) as error:
-                severe = self.state_machine.reporter.severe(
+                with urlopen(source) as response:
+                    csv_text = response.read()
+            except (URLError, OSError, ValueError) as error:
+                severe = self.reporter.severe(
                       'Problems with "%s" directive URL "%s":\n%s.'
-                      % (self.name, self.options'url', SafeString(error)),
+                      % (self.name, self.options'url', error),
                       nodes.literal_block(self.block_text, self.block_text),
                       line=self.lineno)
                 raise SystemMessagePropagation(severe)
             csv_file = io.StringInput(
                 source=csv_text, source_path=source, encoding=encoding,
-                error_handler=(self.state.document.settings.\
+                error_handler=(self.state.document.settings.
                                input_encoding_error_handler))
             csv_data = csv_file.read().splitlines()
         else:
-            error = self.state_machine.reporter.warning(
+            error = self.reporter.warning(
                 'The "%s" directive requires content; none supplied.'
-                % self.name, nodes.literal_block(
-                self.block_text, self.block_text), line=self.lineno)
+                % self.name,
+                nodes.literal_block(self.block_text, self.block_text),
+                line=self.lineno)
             raise SystemMessagePropagation(error)
         return csv_data, source
 
-    if sys.version_info < (3, 0):
-        # 2.x csv module doesn't do Unicode
-        def decode_from_csv(s):
-            return s.decode('utf-8')
-        def encode_for_csv(s):
-            return s.encode('utf-8')
-    else:
-        def decode_from_csv(s):
-            return s
-        def encode_for_csv(s):
-            return s
-    decode_from_csv = staticmethod(decode_from_csv)
-    encode_for_csv = staticmethod(encode_for_csv)
+    @staticmethod
+    def decode_from_csv(s):
+        warnings.warn('CSVTable.decode_from_csv()'
+                  ' is not required with Python 3'
+                  ' and will be removed in Docutils 0.21 or later.',
+                  DeprecationWarning, stacklevel=2)
+        return s
+
+    @staticmethod
+    def encode_for_csv(s):
+        warnings.warn('CSVTable.encode_from_csv()'
+                  ' is not required with Python 3'
+                  ' and will be removed in Docutils 0.21 or later.',
+                  DeprecationWarning, stacklevel=2)
+        return s
 
     def parse_csv_data_into_rows(self, csv_data, dialect, source):
-        # csv.py doesn't do Unicode; encode temporarily as UTF-8
-        csv_reader = csv.reader(self.encode_for_csv(line + '\n')
-                                 for line in csv_data,
+        csv_reader = csv.reader((line + '\n' for line in csv_data),
                                 dialect=dialect)
         rows = 
         max_cols = 0
         for row in csv_reader:
             row_data = 
             for cell in row:
-                # decode UTF-8 back to Unicode
-                cell_text = self.decode_from_csv(cell)
                 cell_data = (0, 0, 0, statemachine.StringList(
-                    cell_text.splitlines(), source=source))
+                    cell.splitlines(), source=source))
                 row_data.append(cell_data)
             rows.append(row_data)
             max_cols = max(max_cols, len(row))
@@ -400,7 +431,7 @@
     """
     Implement tables whose data is encoded as a uniform two-level bullet list.
     For further ideas, see
-    http://docutils.sf.net/docs/dev/rst/alternatives.html#list-driven-tables
+    https://docutils.sourceforge.io/docs/dev/rst/alternatives.html#list-driven-tables
     """
 
     option_spec = {'header-rows': directives.nonnegative_int,
@@ -414,8 +445,8 @@
 
     def run(self):
         if not self.content:
-            error = self.state_machine.reporter.error(
-                'The "%s" directive is empty; content required.' % self.name,
+            error = self.reporter.error('The "%s" directive is empty; '
+                'content required.' % self.name,
                 nodes.literal_block(self.block_text, self.block_text),
                 line=self.lineno)
             return error
@@ -444,7 +475,7 @@
 
     def check_list_content(self, node):
         if len(node) != 1 or not isinstance(node0, nodes.bullet_list):
-            error = self.state_machine.reporter.error(
+            error = self.reporter.error(
                 'Error parsing content block for the "%s" directive: '
                 'exactly one bullet list expected.' % self.name,
                 nodes.literal_block(self.block_text, self.block_text),
@@ -456,16 +487,17 @@
         for item_index in range(len(list_node)):
             item = list_nodeitem_index
             if len(item) != 1 or not isinstance(item0, nodes.bullet_list):
-                error = self.state_machine.reporter.error(
+                error = self.reporter.error(
                     'Error parsing content block for the "%s" directive: '
                     'two-level bullet list expected, but row %s does not '
                     'contain a second-level bullet list.'
-                    % (self.name, item_index + 1), nodes.literal_block(
-                    self.block_text, self.block_text), line=self.lineno)
+                    % (self.name, item_index + 1),
+                    nodes.literal_block(self.block_text, self.block_text),
+                    line=self.lineno)
                 raise SystemMessagePropagation(error)
             elif item_index:
                 if len(item0) != num_cols:
-                    error = self.state_machine.reporter.error(
+                    error = self.reporter.error(
                         'Error parsing content block for the "%s" directive: '
                         'uniform two-level bullet list expected, but row %s '
                         'does not contain the same number of items as row 1 '
@@ -479,11 +511,12 @@
         col_widths = self.get_column_widths(num_cols)
         return num_cols, col_widths
 
-    def build_table_from_list(self, table_data, col_widths, header_rows, stub_columns):
+    def build_table_from_list(self, table_data,
+                              col_widths, header_rows, stub_columns):
         table = nodes.table()
         if self.widths == 'auto':
             table'classes' += 'colwidths-auto'
-        elif self.widths: # "grid" or list of integers
+        elif self.widths:  # explicitly set column widths
             table'classes' += 'colwidths-given'
         tgroup = nodes.tgroup(cols=len(col_widths))
         table += tgroup

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/README.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/README.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamsa.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamsa.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamsb.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamsb.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamsc.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamsc.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamsn.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamsn.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamso.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamso.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isoamsr.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isoamsr.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isobox.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isobox.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isocyr1.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isocyr1.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isocyr2.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isocyr2.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isodia.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isodia.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isogrk1.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isogrk1.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isogrk2.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isogrk2.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isogrk3.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isogrk3.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isogrk4-wide.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isogrk4-wide.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isogrk4.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isogrk4.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isolat1.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isolat1.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isolat2.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isolat2.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomfrk-wide.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomfrk-wide.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomfrk.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomfrk.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomopf-wide.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomopf-wide.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomopf.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomopf.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomscr-wide.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomscr-wide.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isomscr.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isomscr.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isonum.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isonum.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isopub.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isopub.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/isotech.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/isotech.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/mmlalias.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/mmlalias.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/mmlextra-wide.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/mmlextra-wide.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/mmlextra.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/mmlextra.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/xhtml1-lat1.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/xhtml1-lat1.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/xhtml1-special.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/xhtml1-special.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/include/xhtml1-symbol.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/include/xhtml1-symbol.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/af.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/af.py Changed

@@ -1,11 +1,11 @@
-# $Id: af.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: af.py 9116 2022-07-28 17:06:51Z milde $
 # Author: Jannie Hofmeyr <jhsh@sun.ac.za>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Afrikaans-language mappings for language-dependent features of
@@ -24,9 +24,9 @@
       'wenk': 'hint',
       'belangrik': 'important',
       'nota': 'note',
-      'tip': 'tip', # hint and tip both have the same translation: wenk
+      'tip': 'tip',  # hint and tip both have the same translation: wenk
       'waarskuwing': 'warning',
-      'vermaning': 'admonition',
+      'vermaning': 'admonition',  # sic! Not used in this sense in rST.
       'kantstreep': 'sidebar',
       'onderwerp': 'topic',
       'lynblok': 'line-block',
@@ -36,22 +36,22 @@
       'epigraaf': 'epigraph',
       'hoogtepunte': 'highlights',
       'pull-quote (translation required)': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #'vrae': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'vrae': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
       'table (translation required)': 'table',
       'csv-table (translation required)': 'csv-table',
       'list-table (translation required)': 'list-table',
       'meta': 'meta',
-      #'beeldkaart': 'imagemap',
+      # 'beeldkaart': 'imagemap',
       'beeld': 'image',
       'figuur': 'figure',
       'insluiting': 'include',
       'rou': 'raw',
       'vervang': 'replace',
-      'unicode': 'unicode', # should this be translated? unikode
+      'unicode': 'unicode',  # should this be translated? unikode
       'datum': 'date',
       'klas': 'class',
       'role (translation required)': 'role',
@@ -60,10 +60,10 @@
       'inhoud': 'contents',
       'sectnum': 'sectnum',
       'section-numbering': 'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #'voetnote': 'footnotes',
-      #'aanhalings': 'citations',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'voetnote': 'footnotes',
+      # 'aanhalings': 'citations',
       'teikennotas': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Afrikaans name to registered (in directives/__init__.py) directive name
@@ -74,7 +74,7 @@
     'ab': 'abbreviation',
     'akroniem': 'acronym',
     'ac': 'acronym',
-    u'code (translation required)': 'code',
+    'code (translation required)': 'code',
     'indeks': 'index',
     'i': 'index',
     'voetskrif': 'subscript',
@@ -101,6 +101,7 @@
     'uri-verwysing': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'rou': 'raw',}
-"""Mapping of Afrikaans role names to canonical role names for interpreted text.
+    'rou': 'raw',
+    }
+"""Mapping of Afrikaans role names to canonical names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/ar.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/ar.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 # $Id: fa.py 4564 2016-08-10 11:48:42Z
 # Author: Shahin <me@5hah.in>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Arabic-language mappings for language-dependent features of
@@ -15,88 +14,86 @@
 
 __docformat__ = 'reStructuredText'
 
-
 directives = {
-      # language-dependent: fixed
-      u'تنبيه': u'attention',
-      u'احتیاط': u'caution',
-      u'كود': u'code',
-      u'كود': u'code',
-      u'كود': u'code',
-      u'خطر': u'danger',
-      u'خطأ': u'error',
-      u'تلميح': u'hint',
-      u'مهم': u'important',
-      u'ملاحظة': u'note',
-      u'نصيحة': u'tip',
-      u'تحذير': u'warning',
-      u'تذكير': u'admonition',
-      u'شريط-جانبي': u'sidebar',
-      u'موضوع': u'topic',
-      u'قالب-سطري': u'line-block',
-      u'لفظ-حرفي': u'parsed-literal',
-      u'معيار': u'rubric',
-      u'فكرة-الكتاب': u'epigraph',
-      u'تمييز': u'highlights',
-      u'نقل-قول': u'pull-quote',
-      u'ترکیب': u'compound',
-      u'وعاء': u'container',
-      #'questions': u'questions',
-      u'جدول': u'table',
-      u'جدول-csv': u'csv-table',
-      u'جدول-قوائم': u'list-table',
-      #'qa': u'questions',
-      #'faq': u'questions',
-      u'ميتا': u'meta',
-      u'رياضيات': u'math',
-      #'imagemap': u'imagemap',
-      u'صورة': u'image',
-      u'رسم-توضيحي': u'figure',
-      u'تضمين': u'include',
-      u'خام': u'raw',
-      u'تبديل': u'replace',
-      u'یونیکد': u'unicode',
-      u'تاریخ': u'date',
-      u'كائن': u'class',
-      u'قانون': u'role',
-      u'قانون-افتراضي': u'default-role',
-      u'عنوان': u'title',
-      u'المحتوى': u'contents',
-      u'رقم-الفصل': u'sectnum',
-      u'رقم-القسم': u'sectnum',
-      u'رأس-الصفحة': u'header',
-      u'هامش': u'footer',
-      #'footnotes': u'footnotes',
-      #'citations': u'citations',
-      u'': u'target-notes',
-    }
+    # language-dependent: fixed
+    'تنبيه': 'attention',
+    'احتیاط': 'caution',
+    'كود': 'code',
+    'خطر': 'danger',
+    'خطأ': 'error',
+    'تلميح': 'hint',
+    'مهم': 'important',
+    'ملاحظة': 'note',
+    'نصيحة': 'tip',
+    'تحذير': 'warning',
+    'تذكير': 'admonition',
+    'شريط-جانبي': 'sidebar',
+    'موضوع': 'topic',
+    'قالب-سطري': 'line-block',
+    'لفظ-حرفي': 'parsed-literal',
+    'معيار': 'rubric',
+    'فكرة-الكتاب': 'epigraph',
+    'تمييز': 'highlights',
+    'نقل-قول': 'pull-quote',
+    'ترکیب': 'compound',
+    'وعاء': 'container',
+    # 'questions': 'questions',
+    'جدول': 'table',
+    'جدول-csv': 'csv-table',
+    'جدول-قوائم': 'list-table',
+    # 'qa': 'questions',
+    # 'faq': 'questions',
+    'ميتا': 'meta',
+    'رياضيات': 'math',
+    # 'imagemap': 'imagemap',
+    'صورة': 'image',
+    'رسم-توضيحي': 'figure',
+    'تضمين': 'include',
+    'خام': 'raw',
+    'تبديل': 'replace',
+    'یونیکد': 'unicode',
+    'تاریخ': 'date',
+    'كائن': 'class',
+    'قانون': 'role',
+    'قانون-افتراضي': 'default-role',
+    'عنوان': 'title',
+    'المحتوى': 'contents',
+    'رقم-الفصل': 'sectnum',
+    'رقم-القسم': 'sectnum',
+    'رأس-الصفحة': 'header',
+    'هامش': 'footer',
+    # 'footnotes': 'footnotes',
+    # 'citations': 'citations',
+    '': 'target-notes',
+}
 """Arabic name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'اختصار': u'abbreviation',
-    u'اختزال': u'acronym',
-    u'كود': u'code',
-    u'فهرس': u'index',
-    u'خفض': u'subscript',
-    u'رفع': u'superscript',
-    u'عنوان-مرجع': u'title-reference',
-    u'مرجع-pep': u'pep-reference',
-    u'rfc-مرجع': u'rfc-reference',
-    u'تأكيد': u'emphasis',
-    u'عريض': u'strong',
-    u'لفظی': u'literal',
-    u'رياضيات': u'math',
-    u'مرجع-مسمى': u'named-reference',
-    u'مرجع-مجهول': u'anonymous-reference',
-    u'مرجع-هامشي': u'footnote-reference',
-    u'مرجع-منقول': u'citation-reference',
-    u'مرجع-معوض': u'substitution-reference',
-    u'هدف': u'target',
-    u'منبع-uri': u'uri-reference',
-    u'uri': u'uri-reference',
-    u'url': u'uri-reference',
-    u'خام': u'raw',}
+    'اختصار': 'abbreviation',
+    'اختزال': 'acronym',
+    'كود': 'code',
+    'فهرس': 'index',
+    'خفض': 'subscript',
+    'رفع': 'superscript',
+    'عنوان-مرجع': 'title-reference',
+    'مرجع-pep': 'pep-reference',
+    'rfc-مرجع': 'rfc-reference',
+    'تأكيد': 'emphasis',
+    'عريض': 'strong',
+    'لفظی': 'literal',
+    'رياضيات': 'math',
+    'مرجع-مسمى': 'named-reference',
+    'مرجع-مجهول': 'anonymous-reference',
+    'مرجع-هامشي': 'footnote-reference',
+    'مرجع-منقول': 'citation-reference',
+    'مرجع-معوض': 'substitution-reference',
+    'هدف': 'target',
+    'منبع-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'خام': 'raw',
+}
 """Mapping of Arabic role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/ca.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/ca.py Changed

@@ -1,11 +1,11 @@
-# $Id: ca.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: ca.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Ivan Vilata i Balaguer <ivan@selidor.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Catalan-language mappings for language-dependent features of
@@ -17,109 +17,110 @@
 
 directives = {
       # language-dependent: fixed
-      u'atenci\u00F3': 'attention',
-      u'compte': 'caution',
-      u'code (translation required)': 'code',
-      u'perill': 'danger',
-      u'error': 'error',
-      u'suggeriment': 'hint',
-      u'important': 'important',
-      u'nota': 'note',
-      u'consell': 'tip',
-      u'av\u00EDs': 'warning',
-      u'advertiment': 'admonition',
-      u'nota-al-marge': 'sidebar',
-      u'nota-marge': 'sidebar',
-      u'tema': 'topic',
-      u'bloc-de-l\u00EDnies': 'line-block',
-      u'bloc-l\u00EDnies': 'line-block',
-      u'literal-analitzat': 'parsed-literal',
-      u'r\u00FAbrica': 'rubric',
-      u'ep\u00EDgraf': 'epigraph',
-      u'sumari': 'highlights',
-      u'cita-destacada': 'pull-quote',
-      u'compost': 'compound',
-      u'container (translation required)': 'container',
-      #'questions': 'questions',
-      u'taula': 'table',
-      u'taula-csv': 'csv-table',
-      u'taula-llista': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'math (translation required)': 'math',
-      u'meta': 'meta',
-      #'imagemap': 'imagemap',
-      u'imatge': 'image',
-      u'figura': 'figure',
-      u'inclou': 'include',
-      u'incloure': 'include',
-      u'cru': 'raw',
-      u'reempla\u00E7a': 'replace',
-      u'reempla\u00E7ar': 'replace',
-      u'unicode': 'unicode',
-      u'data': 'date',
-      u'classe': 'class',
-      u'rol': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
-      u'contingut': 'contents',
-      u'numsec': 'sectnum',
-      u'numeraci\u00F3-de-seccions': 'sectnum',
-      u'numeraci\u00F3-seccions': 'sectnum',
-      u'cap\u00E7alera': 'header',
-      u'peu-de-p\u00E0gina': 'footer',
-      u'peu-p\u00E0gina': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'notes-amb-destinacions': 'target-notes',
-      u'notes-destinacions': 'target-notes',
-      u'directiva-de-prova-de-restructuredtext': 'restructuredtext-test-directive'}
+      'atenci\u00F3': 'attention',
+      'compte': 'caution',
+      'code (translation required)': 'code',
+      'perill': 'danger',
+      'error': 'error',
+      'suggeriment': 'hint',
+      'important': 'important',
+      'nota': 'note',
+      'consell': 'tip',
+      'av\u00EDs': 'warning',
+      'advertiment': 'admonition',
+      'nota-al-marge': 'sidebar',
+      'nota-marge': 'sidebar',
+      'tema': 'topic',
+      'bloc-de-l\u00EDnies': 'line-block',
+      'bloc-l\u00EDnies': 'line-block',
+      'literal-analitzat': 'parsed-literal',
+      'r\u00FAbrica': 'rubric',
+      'ep\u00EDgraf': 'epigraph',
+      'sumari': 'highlights',
+      'cita-destacada': 'pull-quote',
+      'compost': 'compound',
+      'container (translation required)': 'container',
+      # 'questions': 'questions',
+      'taula': 'table',
+      'taula-csv': 'csv-table',
+      'taula-llista': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'math (translation required)': 'math',
+      'meta': 'meta',
+      # 'imagemap': 'imagemap',
+      'imatge': 'image',
+      'figura': 'figure',
+      'inclou': 'include',
+      'incloure': 'include',
+      'cru': 'raw',
+      'reempla\u00E7a': 'replace',
+      'reempla\u00E7ar': 'replace',
+      'unicode': 'unicode',
+      'data': 'date',
+      'classe': 'class',
+      'rol': 'role',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
+      'contingut': 'contents',
+      'numsec': 'sectnum',
+      'numeraci\u00F3-de-seccions': 'sectnum',
+      'numeraci\u00F3-seccions': 'sectnum',
+      'cap\u00E7alera': 'header',
+      'peu-de-p\u00E0gina': 'footer',
+      'peu-p\u00E0gina': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'notes-amb-destinacions': 'target-notes',
+      'notes-destinacions': 'target-notes',
+      'directiva-de-prova-de-restructuredtext': 'restructuredtext-test-directive'}  # noqa:E501
 """Catalan name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'abreviatura': 'abbreviation',
-    u'abreviaci\u00F3': 'abbreviation',
-    u'abrev': 'abbreviation',
-    u'ab': 'abbreviation',
-    u'acr\u00F2nim': 'acronym',
-    u'ac': 'acronym',
-    u'code (translation required)': 'code',
-    u'\u00EDndex': 'index',
-    u'i': 'index',
-    u'sub\u00EDndex': 'subscript',
-    u'sub': 'subscript',
-    u'super\u00EDndex': 'superscript',
-    u'sup': 'superscript',
-    u'refer\u00E8ncia-a-t\u00EDtol': 'title-reference',
-    u'refer\u00E8ncia-t\u00EDtol': 'title-reference',
-    u't\u00EDtol': 'title-reference',
-    u't': 'title-reference',
-    u'refer\u00E8ncia-a-pep': 'pep-reference',
-    u'refer\u00E8ncia-pep': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'refer\u00E8ncia-a-rfc': 'rfc-reference',
-    u'refer\u00E8ncia-rfc': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'\u00E8mfasi': 'emphasis',
-    u'destacat': 'strong',
-    u'literal': 'literal',
-    u'math (translation required)': 'math',
-    u'refer\u00E8ncia-amb-nom': 'named-reference',
-    u'refer\u00E8ncia-nom': 'named-reference',
-    u'refer\u00E8ncia-an\u00F2nima': 'anonymous-reference',
-    u'refer\u00E8ncia-a-nota-al-peu': 'footnote-reference',
-    u'refer\u00E8ncia-nota-al-peu': 'footnote-reference',
-    u'refer\u00E8ncia-a-cita': 'citation-reference',
-    u'refer\u00E8ncia-cita': 'citation-reference',
-    u'refer\u00E8ncia-a-substituci\u00F3': 'substitution-reference',
-    u'refer\u00E8ncia-substituci\u00F3': 'substitution-reference',
-    u'destinaci\u00F3': 'target',
-    u'refer\u00E8ncia-a-uri': 'uri-reference',
-    u'refer\u00E8ncia-uri': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'cru': 'raw',}
+    'abreviatura': 'abbreviation',
+    'abreviaci\u00F3': 'abbreviation',
+    'abrev': 'abbreviation',
+    'ab': 'abbreviation',
+    'acr\u00F2nim': 'acronym',
+    'ac': 'acronym',
+    'code (translation required)': 'code',
+    '\u00EDndex': 'index',
+    'i': 'index',
+    'sub\u00EDndex': 'subscript',
+    'sub': 'subscript',
+    'super\u00EDndex': 'superscript',
+    'sup': 'superscript',
+    'refer\u00E8ncia-a-t\u00EDtol': 'title-reference',
+    'refer\u00E8ncia-t\u00EDtol': 'title-reference',
+    't\u00EDtol': 'title-reference',
+    't': 'title-reference',
+    'refer\u00E8ncia-a-pep': 'pep-reference',
+    'refer\u00E8ncia-pep': 'pep-reference',
+    'pep': 'pep-reference',
+    'refer\u00E8ncia-a-rfc': 'rfc-reference',
+    'refer\u00E8ncia-rfc': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    '\u00E8mfasi': 'emphasis',
+    'destacat': 'strong',
+    'literal': 'literal',
+    'math (translation required)': 'math',
+    'refer\u00E8ncia-amb-nom': 'named-reference',
+    'refer\u00E8ncia-nom': 'named-reference',
+    'refer\u00E8ncia-an\u00F2nima': 'anonymous-reference',
+    'refer\u00E8ncia-a-nota-al-peu': 'footnote-reference',
+    'refer\u00E8ncia-nota-al-peu': 'footnote-reference',
+    'refer\u00E8ncia-a-cita': 'citation-reference',
+    'refer\u00E8ncia-cita': 'citation-reference',
+    'refer\u00E8ncia-a-substituci\u00F3': 'substitution-reference',
+    'refer\u00E8ncia-substituci\u00F3': 'substitution-reference',
+    'destinaci\u00F3': 'target',
+    'refer\u00E8ncia-a-uri': 'uri-reference',
+    'refer\u00E8ncia-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'cru': 'raw',
+    }
 """Mapping of Catalan role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/cs.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/cs.py Changed

@@ -1,11 +1,11 @@
-# $Id: cs.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: cs.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Marek Blaha <mb@dat.cz>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Czech-language mappings for language-dependent features of
@@ -17,92 +17,94 @@
 
 directives = {
       # language-dependent: fixed
-      u'pozor': 'attention',
-      u'caution (translation required)': 'caution', # jak rozlisit caution a warning?
-      u'code (translation required)': 'code',
-      u'nebezpe\u010D\u00ED': 'danger',
-      u'chyba': 'error',
-      u'rada': 'hint',
-      u'd\u016Fle\u017Eit\u00E9': 'important',
-      u'pozn\u00E1mka': 'note',
-      u'tip (translation required)': 'tip',
-      u'varov\u00E1n\u00ED': 'warning',
-      u'admonition (translation required)': 'admonition',
-      u'sidebar (translation required)': 'sidebar',
-      u't\u00E9ma': 'topic',
-      u'line-block (translation required)': 'line-block',
-      u'parsed-literal (translation required)': 'parsed-literal',
-      u'odd\u00EDl': 'rubric',
-      u'moto': 'epigraph',
-      u'highlights (translation required)': 'highlights',
-      u'pull-quote (translation required)': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #'questions': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'table (translation required)': 'table',
-      u'csv-table (translation required)': 'csv-table',
-      u'list-table (translation required)': 'list-table',
-      u'math (translation required)': 'math',
-      u'meta (translation required)': 'meta',
-      #'imagemap': 'imagemap',
-      u'image (translation required)': 'image',   # obrazek
-      u'figure (translation required)': 'figure', # a tady?
-      u'include (translation required)': 'include',
-      u'raw (translation required)': 'raw',
-      u'replace (translation required)': 'replace',
-      u'unicode (translation required)': 'unicode',
-      u'datum': 'date',
-      u't\u0159\u00EDda': 'class',
-      u'role (translation required)': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
-      u'obsah': 'contents',
-      u'sectnum (translation required)': 'sectnum',
-      u'section-numbering (translation required)': 'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'target-notes (translation required)': 'target-notes',
-      u'restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      'pozor': 'attention',
+      # jak rozlisit caution a warning?
+      'caution (translation required)': 'caution',
+      'code (translation required)': 'code',
+      'nebezpe\u010D\u00ED': 'danger',
+      'chyba': 'error',
+      'rada': 'hint',
+      'd\u016Fle\u017Eit\u00E9': 'important',
+      'pozn\u00E1mka': 'note',
+      'tip (translation required)': 'tip',
+      'varov\u00E1n\u00ED': 'warning',
+      'admonition (translation required)': 'admonition',
+      'sidebar (translation required)': 'sidebar',
+      't\u00E9ma': 'topic',
+      'line-block (translation required)': 'line-block',
+      'parsed-literal (translation required)': 'parsed-literal',
+      'odd\u00EDl': 'rubric',
+      'moto': 'epigraph',
+      'highlights (translation required)': 'highlights',
+      'pull-quote (translation required)': 'pull-quote',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'questions': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'table (translation required)': 'table',
+      'csv-table (translation required)': 'csv-table',
+      'list-table (translation required)': 'list-table',
+      'math (translation required)': 'math',
+      'meta (translation required)': 'meta',
+      # 'imagemap': 'imagemap',
+      'image (translation required)': 'image',    # obrazek
+      'figure (translation required)': 'figure',  # a tady?
+      'include (translation required)': 'include',
+      'raw (translation required)': 'raw',
+      'replace (translation required)': 'replace',
+      'unicode (translation required)': 'unicode',
+      'datum': 'date',
+      't\u0159\u00EDda': 'class',
+      'role (translation required)': 'role',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
+      'obsah': 'contents',
+      'sectnum (translation required)': 'sectnum',
+      'section-numbering (translation required)': 'sectnum',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'target-notes (translation required)': 'target-notes',
+      'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Czech name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'abbreviation (translation required)': 'abbreviation',
-    u'ab (translation required)': 'abbreviation',
-    u'acronym (translation required)': 'acronym',
-    u'ac (translation required)': 'acronym',
-    u'code (translation required)': 'code',
-    u'index (translation required)': 'index',
-    u'i (translation required)': 'index',
-    u'subscript (translation required)': 'subscript',
-    u'sub (translation required)': 'subscript',
-    u'superscript (translation required)': 'superscript',
-    u'sup (translation required)': 'superscript',
-    u'title-reference (translation required)': 'title-reference',
-    u'title (translation required)': 'title-reference',
-    u't (translation required)': 'title-reference',
-    u'pep-reference (translation required)': 'pep-reference',
-    u'pep (translation required)': 'pep-reference',
-    u'rfc-reference (translation required)': 'rfc-reference',
-    u'rfc (translation required)': 'rfc-reference',
-    u'emphasis (translation required)': 'emphasis',
-    u'strong (translation required)': 'strong',
-    u'literal (translation required)': 'literal',
-    u'math (translation required)': 'math',
-    u'named-reference (translation required)': 'named-reference',
-    u'anonymous-reference (translation required)': 'anonymous-reference',
-    u'footnote-reference (translation required)': 'footnote-reference',
-    u'citation-reference (translation required)': 'citation-reference',
-    u'substitution-reference (translation required)': 'substitution-reference',
-    u'target (translation required)': 'target',
-    u'uri-reference (translation required)': 'uri-reference',
-    u'uri (translation required)': 'uri-reference',
-    u'url (translation required)': 'uri-reference',
-    u'raw (translation required)': 'raw',}
+    'abbreviation (translation required)': 'abbreviation',
+    'ab (translation required)': 'abbreviation',
+    'acronym (translation required)': 'acronym',
+    'ac (translation required)': 'acronym',
+    'code (translation required)': 'code',
+    'index (translation required)': 'index',
+    'i (translation required)': 'index',
+    'subscript (translation required)': 'subscript',
+    'sub (translation required)': 'subscript',
+    'superscript (translation required)': 'superscript',
+    'sup (translation required)': 'superscript',
+    'title-reference (translation required)': 'title-reference',
+    'title (translation required)': 'title-reference',
+    't (translation required)': 'title-reference',
+    'pep-reference (translation required)': 'pep-reference',
+    'pep (translation required)': 'pep-reference',
+    'rfc-reference (translation required)': 'rfc-reference',
+    'rfc (translation required)': 'rfc-reference',
+    'emphasis (translation required)': 'emphasis',
+    'strong (translation required)': 'strong',
+    'literal (translation required)': 'literal',
+    'math (translation required)': 'math',
+    'named-reference (translation required)': 'named-reference',
+    'anonymous-reference (translation required)': 'anonymous-reference',
+    'footnote-reference (translation required)': 'footnote-reference',
+    'citation-reference (translation required)': 'citation-reference',
+    'substitution-reference (translation required)': 'substitution-reference',
+    'target (translation required)': 'target',
+    'uri-reference (translation required)': 'uri-reference',
+    'uri (translation required)': 'uri-reference',
+    'url (translation required)': 'uri-reference',
+    'raw (translation required)': 'raw',
+    }
 """Mapping of Czech role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/da.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/da.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: da.py 7678 2013-07-03 09:57:36Z milde $
+# $Id: da.py 9116 2022-07-28 17:06:51Z milde $
 # Author: E D
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Danish-language mappings for language-dependent features of
@@ -18,96 +17,97 @@
 
 directives = {
       # language-dependent: fixed
-      u'giv agt': 'attention',
-      u'pas på': 'caution',
-      u'kode': 'code',
-      u'kode-blok': 'code',
-      u'kildekode': 'code',
-      u'fare': 'danger',
-      u'fejl': 'error',
-      u'vink': 'hint',
-      u'vigtigt': 'important',
-      u'bemærk': 'note',
-      u'tips': 'tip',
-      u'advarsel': 'warning',
-      u'formaning': 'admonition',
-      u'sidebjælke': 'sidebar',
-      u'emne': 'topic',
-      u'linje-blok': 'line-block',
-      u'linie-blok': 'line-block',
-      u'parset-literal': 'parsed-literal',
-      u'rubrik': 'rubric',
-      u'epigraf': 'epigraph',
-      u'fremhævninger': 'highlights',
-      u'pull-quote (translation required)': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #'questions': 'questions',
-      u'tabel': 'table',
-      u'csv-tabel': 'csv-table',
-      u'liste-tabel': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'meta': 'meta',
-      u'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'billede': 'image',
-      u'figur': 'figure',
-      u'inkludér': 'include',
-      u'inkluder': 'include',
-      u'rå': 'raw',
-      u'erstat': 'replace',
-      u'unicode': 'unicode',
-      u'dato': 'date',
-      u'klasse': 'class',
-      u'rolle': 'role',
-      u'forvalgt-rolle': 'default-role',
-      u'titel': 'title',
-      u'indhold': 'contents',
-      u'sektnum': 'sectnum',
-      u'sektions-nummerering': 'sectnum',
-      u'sidehovede': 'header',
-      u'sidefod': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'target-notes (translation required)': 'target-notes',
-      u'restructuredtext-test-direktiv': 'restructuredtext-test-directive'}
+      'giv agt': 'attention',
+      'pas på': 'caution',
+      'kode': 'code',
+      'kode-blok': 'code',
+      'kildekode': 'code',
+      'fare': 'danger',
+      'fejl': 'error',
+      'vink': 'hint',
+      'vigtigt': 'important',
+      'bemærk': 'note',
+      'tips': 'tip',
+      'advarsel': 'warning',
+      'formaning': 'admonition',  # sic! Not used in this sense in rST.
+      'sidebjælke': 'sidebar',
+      'emne': 'topic',
+      'linje-blok': 'line-block',
+      'linie-blok': 'line-block',
+      'parset-literal': 'parsed-literal',
+      'rubrik': 'rubric',
+      'epigraf': 'epigraph',
+      'fremhævninger': 'highlights',
+      'pull-quote (translation required)': 'pull-quote',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'questions': 'questions',
+      'tabel': 'table',
+      'csv-tabel': 'csv-table',
+      'liste-tabel': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'meta': 'meta',
+      'math (translation required)': 'math',
+      # 'imagemap': 'imagemap',
+      'billede': 'image',
+      'figur': 'figure',
+      'inkludér': 'include',
+      'inkluder': 'include',
+      'rå': 'raw',
+      'erstat': 'replace',
+      'unicode': 'unicode',
+      'dato': 'date',
+      'klasse': 'class',
+      'rolle': 'role',
+      'forvalgt-rolle': 'default-role',
+      'titel': 'title',
+      'indhold': 'contents',
+      'sektnum': 'sectnum',
+      'sektions-nummerering': 'sectnum',
+      'sidehovede': 'header',
+      'sidefod': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'target-notes (translation required)': 'target-notes',
+      'restructuredtext-test-direktiv': 'restructuredtext-test-directive'}
 """Danish name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'forkortelse': 'abbreviation',
-    u'fork': 'abbreviation',
-    u'akronym': 'acronym',
-    u'ac (translation required)': 'acronym',
-    u'kode': 'code',
-    u'indeks': 'index',
-    u'i': 'index',
-    u'subscript (translation required)': 'subscript',
-    u'sub (translation required)': 'subscript',
-    u'superscript (translation required)': 'superscript',
-    u'sup (translation required)': 'superscript',
-    u'titel-reference': 'title-reference',
-    u'titel': 'title-reference',
-    u't': 'title-reference',
-    u'pep-reference': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'rfc-reference': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'emfase': 'emphasis',
-    u'kraftig': 'strong',
-    u'literal': 'literal',
-    u'math (translation required)': 'math',
-    u'navngivet-reference': 'named-reference',
-    u'anonym-reference': 'anonymous-reference',
-    u'fodnote-reference': 'footnote-reference',
-    u'citation-reference (translation required)': 'citation-reference',
-    u'substitutions-reference': 'substitution-reference',
-    u'target (translation required)': 'target',
-    u'uri-reference': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'rå': 'raw',}
+    'forkortelse': 'abbreviation',
+    'fork': 'abbreviation',
+    'akronym': 'acronym',
+    'ac (translation required)': 'acronym',
+    'kode': 'code',
+    'indeks': 'index',
+    'i': 'index',
+    'subscript (translation required)': 'subscript',
+    'sub (translation required)': 'subscript',
+    'superscript (translation required)': 'superscript',
+    'sup (translation required)': 'superscript',
+    'titel-reference': 'title-reference',
+    'titel': 'title-reference',
+    't': 'title-reference',
+    'pep-reference': 'pep-reference',
+    'pep': 'pep-reference',
+    'rfc-reference': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    'emfase': 'emphasis',
+    'kraftig': 'strong',
+    'literal': 'literal',
+    'math (translation required)': 'math',
+    'navngivet-reference': 'named-reference',
+    'anonym-reference': 'anonymous-reference',
+    'fodnote-reference': 'footnote-reference',
+    'citation-reference (translation required)': 'citation-reference',
+    'substitutions-reference': 'substitution-reference',
+    'target (translation required)': 'target',
+    'uri-reference': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'rå': 'raw',
+    }
 """Mapping of Danish role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/de.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/de.py Changed

@@ -1,13 +1,12 @@
-# -*- coding: utf-8 -*-
-# $Id: de.py 8006 2016-12-22 23:02:44Z milde $
+# $Id: de.py 9120 2022-09-13 10:24:30Z milde $
 # Authors: Engelbert Gruber <grubert@users.sourceforge.net>;
 #          Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 German-language mappings for language-dependent features of
@@ -23,14 +22,15 @@
       'code': 'code',
       'gefahr': 'danger',
       'fehler': 'error',
-      'hinweis': 'hint',
+      'hinweis': 'hint',  # Wink
       'wichtig': 'important',
       'notiz': 'note',
       'tipp': 'tip',
       'warnung': 'warning',
-      'ermahnung': 'admonition',
+      'ermahnung': 'admonition',  # sic! Not used in this sense in rST.
+      # TODO: Rat(schlag), Empfehlung, Warnhinweis, ...?
       'kasten': 'sidebar',
-      'seitenkasten': 'sidebar', # kept for backwards compatibiltity
+      'seitenkasten': 'sidebar',  # kept for backwards compatibiltity
       'seitenleiste': 'sidebar',
       'thema': 'topic',
       'zeilenblock': 'line-block',
@@ -38,24 +38,25 @@
       'rubrik': 'rubric',
       'epigraph': 'epigraph',
       'highlights': 'highlights',
-      u'pull-quote': 'pull-quote', # commonly used in German too
-      u'seitenansprache': 'pull-quote', # cf. http://www.typografie.info/2/wiki.php?title=Seitenansprache
+      'pull-quote': 'pull-quote',  # commonly used in German too
+      'seitenansprache': 'pull-quote',
+      # cf. http://www.typografie.info/2/wiki.php?title=Seitenansprache
       'zusammengesetzt': 'compound',
       'verbund': 'compound',
-      u'container': 'container',
-      #'fragen': 'questions',
+      'container': 'container',
+      # 'fragen': 'questions',
       'tabelle': 'table',
       'csv-tabelle': 'csv-table',
       'listentabelle': 'list-table',
-      u'mathe': 'math',
-      u'formel': 'math',
+      'mathe': 'math',
+      'formel': 'math',
       'meta': 'meta',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'bild': 'image',
       'abbildung': 'figure',
-      u'unverändert': 'raw',
-      u'roh': 'raw',
-      u'einfügen': 'include',
+      'unverändert': 'raw',
+      'roh': 'raw',
+      'einfügen': 'include',
       'ersetzung': 'replace',
       'ersetzen': 'replace',
       'ersetze': 'replace',
@@ -63,43 +64,44 @@
       'datum': 'date',
       'klasse': 'class',
       'rolle': 'role',
-      u'standardrolle': 'default-role',
-      u'titel': 'title',
+      'standardrolle': 'default-role',
+      'titel': 'title',
       'inhalt': 'contents',
-      u'kapitelnummerierung': 'sectnum',
-      u'abschnittsnummerierung': 'sectnum',
-      u'linkziel-fußnoten': 'target-notes',
-      u'kopfzeilen': 'header',
-      u'fußzeilen': 'footer',
-      #u'fußfnoten': 'footnotes',
-      #'zitate': 'citations',
+      'kapitelnummerierung': 'sectnum',
+      'abschnittsnummerierung': 'sectnum',
+      'linkziel-fußnoten': 'target-notes',
+      'kopfzeilen': 'header',
+      'fußzeilen': 'footer',
+      # 'fußnoten': 'footnotes',
+      # 'zitate': 'citations',
       }
 """German name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
-      u'abkürzung': 'abbreviation',
+      'abkürzung': 'abbreviation',
       'akronym': 'acronym',
-      u'code': 'code',
+      'code': 'code',
       'index': 'index',
       'tiefgestellt': 'subscript',
       'hochgestellt': 'superscript',
       'titel-referenz': 'title-reference',
       'pep-referenz': 'pep-reference',
       'rfc-referenz': 'rfc-reference',
-      'betonung': 'emphasis', # for backwards compatibility
+      'betonung': 'emphasis',  # for backwards compatibility
       'betont': 'emphasis',
       'fett': 'strong',
-      u'wörtlich': 'literal',
-      u'mathe': 'math',
+      'wörtlich': 'literal',
+      'mathe': 'math',
       'benannte-referenz': 'named-reference',
       'unbenannte-referenz': 'anonymous-reference',
-      u'fußfnoten-referenz': 'footnote-reference',
+      'fußnoten-referenz': 'footnote-reference',
       'zitat-referenz': 'citation-reference',
       'ersetzungs-referenz': 'substitution-reference',
       'ziel': 'target',
       'uri-referenz': 'uri-reference',
-      u'unverändert': 'raw',
-      u'roh': 'raw',}
+      'unverändert': 'raw',
+      'roh': 'raw',
+      }
 """Mapping of German role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/en.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/en.py Changed

@@ -1,11 +1,11 @@
-# $Id: en.py 7179 2011-10-15 22:06:45Z milde $
+# $Id: en.py 9120 2022-09-13 10:24:30Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 English-language mappings for language-dependent features of
@@ -19,9 +19,6 @@
       # language-dependent: fixed
       'attention': 'attention',
       'caution': 'caution',
-      'code': 'code',
-      'code-block': 'code',
-      'sourcecode': 'code',
       'danger': 'danger',
       'error': 'error',
       'hint': 'hint',
@@ -29,26 +26,26 @@
       'note': 'note',
       'tip': 'tip',
       'warning': 'warning',
-      'admonition': 'admonition',
+      'admonition': 'admonition',  # advice/caveat/remark, not reprimand
       'sidebar': 'sidebar',
       'topic': 'topic',
       'line-block': 'line-block',
       'parsed-literal': 'parsed-literal',
+      'code': 'code',
+      'code-block': 'code',
+      'sourcecode': 'code',
+      'math': 'math',
       'rubric': 'rubric',
       'epigraph': 'epigraph',
       'highlights': 'highlights',
       'pull-quote': 'pull-quote',
       'compound': 'compound',
       'container': 'container',
-      #'questions': 'questions',
       'table': 'table',
       'csv-table': 'csv-table',
       'list-table': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
       'meta': 'meta',
-      'math': 'math',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'image': 'image',
       'figure': 'figure',
       'include': 'include',
@@ -65,12 +62,15 @@
       'section-numbering': 'sectnum',
       'header': 'header',
       'footer': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
       'target-notes': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
-"""English name to registered (in directives/__init__.py) directive name
-mapping."""
+"""Mapping of English directive name to registered directive names
+
+Cf. https://docutils.sourceforge.io/docs/ref/rst/directives.html
+and `_directive_registry` in ``directives/__init__.py``.
+"""
 
 roles = {
     # language-dependent: fixed
@@ -79,8 +79,14 @@
     'acronym': 'acronym',
     'ac': 'acronym',
     'code': 'code',
-    'index': 'index',
-    'i': 'index',
+    'emphasis': 'emphasis',
+    'literal': 'literal',
+    'math': 'math',
+    'pep-reference': 'pep-reference',
+    'pep': 'pep-reference',
+    'rfc-reference': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    'strong': 'strong',
     'subscript': 'subscript',
     'sub': 'subscript',
     'superscript': 'superscript',
@@ -88,23 +94,21 @@
     'title-reference': 'title-reference',
     'title': 'title-reference',
     't': 'title-reference',
-    'pep-reference': 'pep-reference',
-    'pep': 'pep-reference',
-    'rfc-reference': 'rfc-reference',
-    'rfc': 'rfc-reference',
-    'emphasis': 'emphasis',
-    'strong': 'strong',
-    'literal': 'literal',
-    'math': 'math',
-    'named-reference': 'named-reference',
+    'raw': 'raw',
+    # the following roles are not implemented in Docutils
+    'index': 'index',
+    'i': 'index',
     'anonymous-reference': 'anonymous-reference',
-    'footnote-reference': 'footnote-reference',
     'citation-reference': 'citation-reference',
+    'footnote-reference': 'footnote-reference',
+    'named-reference': 'named-reference',
     'substitution-reference': 'substitution-reference',
-    'target': 'target',
     'uri-reference': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'raw': 'raw',}
+    'target': 'target',
+    }
 """Mapping of English role names to canonical role names for interpreted text.
+
+Cf. https://docutils.sourceforge.io/docs/ref/rst/roles.html
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/eo.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/eo.py Changed

@@ -1,11 +1,11 @@
-# $Id: eo.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: eo.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Marcelo Huerta San Martin <richieadler@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Esperanto-language mappings for language-dependent features of
@@ -17,102 +17,102 @@
 
 directives = {
       # language-dependent: fixed
-      u'atentu': 'attention',
-      u'zorgu': 'caution',
-      u'code (translation required)': 'code',
-      u'dangxero': 'danger',
-      u'dan\u011dero': 'danger',
-      u'eraro': 'error',
-      u'spuro': 'hint',
-      u'grava': 'important',
-      u'noto': 'note',
-      u'helpeto': 'tip',
-      u'averto': 'warning',
-      u'admono': 'admonition',
-      u'flankteksto': 'sidebar',
-      u'temo': 'topic',
-      u'linea-bloko': 'line-block',
-      u'analizota-literalo': 'parsed-literal',
-      u'rubriko': 'rubric',
-      u'epigrafo': 'epigraph',
-      u'elstarajxoj': 'highlights',
-      u'elstara\u0135oj': 'highlights',
-      u'ekstera-citajxo': 'pull-quote',
-      u'ekstera-cita\u0135o': 'pull-quote',
-      u'kombinajxo': 'compound',
-      u'kombina\u0135o': 'compound',
-      u'tekstingo': 'container',
-      u'enhavilo': 'container',
-      #'questions': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'tabelo': 'table',
-      u'tabelo-vdk': 'csv-table', # "valoroj disigitaj per komoj"
-      u'tabelo-csv': 'csv-table',
-      u'tabelo-lista': 'list-table',
-      u'meta': 'meta',
+      'atentu': 'attention',
+      'zorgu': 'caution',
+      'code (translation required)': 'code',
+      'dangxero': 'danger',
+      'dan\u011dero': 'danger',
+      'eraro': 'error',
+      'spuro': 'hint',
+      'grava': 'important',
+      'noto': 'note',
+      'helpeto': 'tip',
+      'averto': 'warning',
+      'admono': 'admonition',
+      'flankteksto': 'sidebar',
+      'temo': 'topic',
+      'linea-bloko': 'line-block',
+      'analizota-literalo': 'parsed-literal',
+      'rubriko': 'rubric',
+      'epigrafo': 'epigraph',
+      'elstarajxoj': 'highlights',
+      'elstara\u0135oj': 'highlights',
+      'ekstera-citajxo': 'pull-quote',
+      'ekstera-cita\u0135o': 'pull-quote',
+      'kombinajxo': 'compound',
+      'kombina\u0135o': 'compound',
+      'tekstingo': 'container',
+      'enhavilo': 'container',
+      # 'questions': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'tabelo': 'table',
+      'tabelo-vdk': 'csv-table',  # "valoroj disigitaj per komoj"
+      'tabelo-csv': 'csv-table',
+      'tabelo-lista': 'list-table',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'bildo': 'image',
-      u'figuro': 'figure',
-      u'inkludi': 'include',
-      u'senanaliza': 'raw',
-      u'anstatauxi': 'replace',
-      u'anstata\u016di': 'replace',
-      u'unicode': 'unicode',
-      u'dato': 'date',
-      u'klaso': 'class',
-      u'rolo': 'role',
-      u'preterlasita-rolo': 'default-role',
-      u'titolo': 'title',
-      u'enhavo': 'contents',
-      u'seknum': 'sectnum',
-      u'sekcia-numerado': 'sectnum',
-      u'kapsekcio': 'header',
-      u'piedsekcio': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'celaj-notoj': 'target-notes',
-      u'restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      # 'imagemap': 'imagemap',
+      'bildo': 'image',
+      'figuro': 'figure',
+      'inkludi': 'include',
+      'senanaliza': 'raw',
+      'anstatauxi': 'replace',
+      'anstata\u016di': 'replace',
+      'unicode': 'unicode',
+      'dato': 'date',
+      'klaso': 'class',
+      'rolo': 'role',
+      'preterlasita-rolo': 'default-role',
+      'titolo': 'title',
+      'enhavo': 'contents',
+      'seknum': 'sectnum',
+      'sekcia-numerado': 'sectnum',
+      'kapsekcio': 'header',
+      'piedsekcio': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'celaj-notoj': 'target-notes',
+      'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Esperanto name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'mallongigo': 'abbreviation',
-    u'mall': 'abbreviation',
-    u'komenclitero': 'acronym',
-    u'kl': 'acronym',
-    u'code (translation required)': 'code',
-    u'indekso': 'index',
-    u'i': 'index',
-    u'subskribo': 'subscript',
-    u'sub': 'subscript',
-    u'supraskribo': 'superscript',
-    u'sup': 'superscript',
-    u'titola-referenco': 'title-reference',
-    u'titolo': 'title-reference',
-    u't': 'title-reference',
-    u'pep-referenco': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'rfc-referenco': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'emfazo': 'emphasis',
-    u'forta': 'strong',
-    u'litera': 'literal',
+    'mallongigo': 'abbreviation',
+    'mall': 'abbreviation',
+    'komenclitero': 'acronym',
+    'kl': 'acronym',
+    'code (translation required)': 'code',
+    'indekso': 'index',
+    'i': 'index',
+    'subskribo': 'subscript',
+    'sub': 'subscript',
+    'supraskribo': 'superscript',
+    'sup': 'superscript',
+    'titola-referenco': 'title-reference',
+    'titolo': 'title-reference',
+    't': 'title-reference',
+    'pep-referenco': 'pep-reference',
+    'pep': 'pep-reference',
+    'rfc-referenco': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    'emfazo': 'emphasis',
+    'forta': 'strong',
+    'litera': 'literal',
     'math (translation required)': 'math',
-    u'nomita-referenco': 'named-reference',
-    u'nenomita-referenco': 'anonymous-reference',
-    u'piednota-referenco': 'footnote-reference',
-    u'citajxo-referenco': 'citation-reference',
-    u'cita\u0135o-referenco': 'citation-reference',
-    u'anstatauxa-referenco': 'substitution-reference',
-    u'anstata\u016da-referenco': 'substitution-reference',
-    u'celo': 'target',
-    u'uri-referenco': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'senanaliza': 'raw',
+    'nomita-referenco': 'named-reference',
+    'nenomita-referenco': 'anonymous-reference',
+    'piednota-referenco': 'footnote-reference',
+    'citajxo-referenco': 'citation-reference',
+    'cita\u0135o-referenco': 'citation-reference',
+    'anstatauxa-referenco': 'substitution-reference',
+    'anstata\u016da-referenco': 'substitution-reference',
+    'celo': 'target',
+    'uri-referenco': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'senanaliza': 'raw',
 }
-"""Mapping of Esperanto role names to canonical role names for interpreted text.
+"""Mapping of Esperanto role names to canonical names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/es.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/es.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: es.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: es.py 9116 2022-07-28 17:06:51Z milde $
 # Author: Marcelo Huerta San Martín <richieadler@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Spanish-language mappings for language-dependent features of
@@ -15,111 +14,109 @@
 
 __docformat__ = 'reStructuredText'
 
-
 directives = {
-      u'atenci\u00f3n': 'attention',
-      u'atencion': 'attention',
-      u'precauci\u00f3n': 'caution',
-      u'code (translation required)': 'code',
-      u'precaucion': 'caution',
-      u'peligro': 'danger',
-      u'error': 'error',
-      u'sugerencia': 'hint',
-      u'importante': 'important',
-      u'nota': 'note',
-      u'consejo': 'tip',
-      u'advertencia': 'warning',
-      u'exhortacion': 'admonition',
-      u'exhortaci\u00f3n': 'admonition',
-      u'nota-al-margen': 'sidebar',
-      u'tema': 'topic',
-      u'bloque-de-lineas': 'line-block',
-      u'bloque-de-l\u00edneas': 'line-block',
-      u'literal-evaluado': 'parsed-literal',
-      u'firma': 'rubric',
-      u'ep\u00edgrafe': 'epigraph',
-      u'epigrafe': 'epigraph',
-      u'destacado': 'highlights',
-      u'cita-destacada': 'pull-quote',
-      u'combinacion': 'compound',
-      u'combinaci\u00f3n': 'compound',
-      u'contenedor': 'container',
-      #'questions': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'tabla': 'table',
-      u'tabla-vsc': 'csv-table',
-      u'tabla-csv': 'csv-table',
-      u'tabla-lista': 'list-table',
-      u'meta': 'meta',
+      'atenci\u00f3n': 'attention',
+      'atencion': 'attention',
+      'precauci\u00f3n': 'caution',
+      'code (translation required)': 'code',
+      'precaucion': 'caution',
+      'peligro': 'danger',
+      'error': 'error',
+      'sugerencia': 'hint',
+      'importante': 'important',
+      'nota': 'note',
+      'consejo': 'tip',
+      'advertencia': 'warning',
+      'exhortacion': 'admonition',  # sic! Not used in this sense in rST.
+      'exhortaci\u00f3n': 'admonition',
+      'nota-al-margen': 'sidebar',
+      'tema': 'topic',
+      'bloque-de-lineas': 'line-block',
+      'bloque-de-l\u00edneas': 'line-block',
+      'literal-evaluado': 'parsed-literal',
+      'firma': 'rubric',
+      'ep\u00edgrafe': 'epigraph',
+      'epigrafe': 'epigraph',
+      'destacado': 'highlights',
+      'cita-destacada': 'pull-quote',
+      'combinacion': 'compound',
+      'combinaci\u00f3n': 'compound',
+      'contenedor': 'container',
+      # 'questions': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'tabla': 'table',
+      'tabla-vsc': 'csv-table',
+      'tabla-csv': 'csv-table',
+      'tabla-lista': 'list-table',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'imagen': 'image',
-      u'figura': 'figure',
-      u'incluir': 'include',
-      u'sin-analisis': 'raw',
-      u'sin-an\u00e1lisis': 'raw',
-      u'reemplazar': 'replace',
-      u'unicode': 'unicode',
-      u'fecha': 'date',
-      u'clase': 'class',
-      u'rol': 'role',
-      u'rol-por-omision': 'default-role',
-      u'rol-por-omisi\u00f3n': 'default-role',
-      u'titulo': 'title',
-      u't\u00edtulo': 'title',
-      u'contenido': 'contents',
-      u'numseccion': 'sectnum',
-      u'numsecci\u00f3n': 'sectnum',
-      u'numeracion-seccion': 'sectnum',
-      u'numeraci\u00f3n-secci\u00f3n': 'sectnum',
-      u'notas-destino': 'target-notes',
-      u'cabecera': 'header',
-      u'pie': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      # 'imagemap': 'imagemap',
+      'imagen': 'image',
+      'figura': 'figure',
+      'incluir': 'include',
+      'sin-analisis': 'raw',
+      'sin-an\u00e1lisis': 'raw',
+      'reemplazar': 'replace',
+      'unicode': 'unicode',
+      'fecha': 'date',
+      'clase': 'class',
+      'rol': 'role',
+      'rol-por-omision': 'default-role',
+      'rol-por-omisi\u00f3n': 'default-role',
+      'titulo': 'title',
+      't\u00edtulo': 'title',
+      'contenido': 'contents',
+      'numseccion': 'sectnum',
+      'numsecci\u00f3n': 'sectnum',
+      'numeracion-seccion': 'sectnum',
+      'numeraci\u00f3n-secci\u00f3n': 'sectnum',
+      'notas-destino': 'target-notes',
+      'cabecera': 'header',
+      'pie': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Spanish name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
-    u'abreviatura': 'abbreviation',
-    u'ab': 'abbreviation',
-    u'acronimo': 'acronym',
-    u'acronimo': 'acronym',
-    u'ac': 'acronym',
-    u'code (translation required)': 'code',
-    u'indice': 'index',
-    u'i': 'index',
-    u'subindice': 'subscript',
-    u'sub\u00edndice': 'subscript',
-    u'superindice': 'superscript',
-    u'super\u00edndice': 'superscript',
-    u'referencia-titulo': 'title-reference',
-    u'titulo': 'title-reference',
-    u't': 'title-reference',
-    u'referencia-pep': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'referencia-rfc': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'enfasis': 'emphasis',
-    u'\u00e9nfasis': 'emphasis',
-    u'destacado': 'strong',
-    u'literal': 'literal',              # "literal" is also a word in Spanish :-)
-    u'math (translation required)': 'math',
-    u'referencia-con-nombre': 'named-reference',
-    u'referencia-anonima': 'anonymous-reference',
-    u'referencia-an\u00f3nima': 'anonymous-reference',
-    u'referencia-nota-al-pie': 'footnote-reference',
-    u'referencia-cita': 'citation-reference',
-    u'referencia-sustitucion': 'substitution-reference',
-    u'referencia-sustituci\u00f3n': 'substitution-reference',
-    u'destino': 'target',
-    u'referencia-uri': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'sin-analisis': 'raw',
-    u'sin-an\u00e1lisis': 'raw',
+    'abreviatura': 'abbreviation',
+    'ab': 'abbreviation',
+    'acronimo': 'acronym',
+    'ac': 'acronym',
+    'code (translation required)': 'code',
+    'indice': 'index',
+    'i': 'index',
+    'subindice': 'subscript',
+    'sub\u00edndice': 'subscript',
+    'superindice': 'superscript',
+    'super\u00edndice': 'superscript',
+    'referencia-titulo': 'title-reference',
+    'titulo': 'title-reference',
+    't': 'title-reference',
+    'referencia-pep': 'pep-reference',
+    'pep': 'pep-reference',
+    'referencia-rfc': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    'enfasis': 'emphasis',
+    '\u00e9nfasis': 'emphasis',
+    'destacado': 'strong',
+    'literal': 'literal',  # "literal" is also a word in Spanish :-)
+    'math (translation required)': 'math',
+    'referencia-con-nombre': 'named-reference',
+    'referencia-anonima': 'anonymous-reference',
+    'referencia-an\u00f3nima': 'anonymous-reference',
+    'referencia-nota-al-pie': 'footnote-reference',
+    'referencia-cita': 'citation-reference',
+    'referencia-sustitucion': 'substitution-reference',
+    'referencia-sustituci\u00f3n': 'substitution-reference',
+    'destino': 'target',
+    'referencia-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'sin-analisis': 'raw',
+    'sin-an\u00e1lisis': 'raw',
 }
 """Mapping of Spanish role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/fa.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/fa.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 # $Id: fa.py 4564 2016-08-10 11:48:42Z
 # Author: Shahin <me@5hah.in>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Persian-language mappings for language-dependent features of
@@ -17,86 +16,87 @@
 
 
 directives = {
-      # language-dependent: fixed
-      u'توجه': u'attention',
-      u'احتیاط': u'caution',
-      u'کد': u'code',
-      u'بلوک-کد': u'code',
-      u'کد-منبع': u'code',
-      u'خطر': u'danger',
-      u'خطا': u'error',
-      u'راهنما': u'hint',
-      u'مهم': u'important',
-      u'یادداشت': u'note',
-      u'نکته': u'tip',
-      u'اخطار': u'warning',
-      u'تذکر': u'admonition',
-      u'نوار-کناری': u'sidebar',
-      u'موضوع': u'topic',
-      u'بلوک-خط': u'line-block',
-      u'تلفظ-پردازش-شده': u'parsed-literal',
-      u'سر-فصل': u'rubric',
-      u'کتیبه': u'epigraph',
-      u'نکات-برجسته': u'highlights',
-      u'نقل-قول': u'pull-quote',
-      u'ترکیب': u'compound',
-      u'ظرف': u'container',
-      #'questions': u'questions',
-      u'جدول': u'table',
-      u'جدول-csv': u'csv-table',
-      u'جدول-لیست': u'list-table',
-      #'qa': u'questions',
-      #'faq': u'questions',
-      u'متا': u'meta',
-      u'ریاضی': u'math',
-      #'imagemap': u'imagemap',
-      u'تصویر': u'image',
-      u'شکل': u'figure',
-      u'شامل': u'include',
-      u'خام': u'raw',
-      u'جایگزین': u'replace',
-      u'یونیکد': u'unicode',
-      u'تاریخ': u'date',
-      u'کلاس': u'class',
-      u'قانون': u'role',
-      u'قانون-پیش‌فرض': u'default-role',
-      u'عنوان': u'title',
-      u'محتوا': u'contents',
-      u'شماره-فصل': u'sectnum',
-      u'شماره‌گذاری-فصل': u'sectnum',
-      u'سرآیند': u'header',
-      u'پاصفحه': u'footer',
-      #'footnotes': u'footnotes',
-      #'citations': u'citations',
-      u'یادداشت-هدف': u'target-notes',
-    }
+    # language-dependent: fixed
+    'توجه': 'attention',
+    'احتیاط': 'caution',
+    'کد': 'code',
+    'بلوک-کد': 'code',
+    'کد-منبع': 'code',
+    'خطر': 'danger',
+    'خطا': 'error',
+    'راهنما': 'hint',
+    'مهم': 'important',
+    'یادداشت': 'note',
+    'نکته': 'tip',
+    'اخطار': 'warning',
+    'تذکر': 'admonition',
+    'نوار-کناری': 'sidebar',
+    'موضوع': 'topic',
+    'بلوک-خط': 'line-block',
+    'تلفظ-پردازش-شده': 'parsed-literal',
+    'سر-فصل': 'rubric',
+    'کتیبه': 'epigraph',
+    'نکات-برجسته': 'highlights',
+    'نقل-قول': 'pull-quote',
+    'ترکیب': 'compound',
+    'ظرف': 'container',
+    # 'questions': 'questions',
+    'جدول': 'table',
+    'جدول-csv': 'csv-table',
+    'جدول-لیست': 'list-table',
+    # 'qa': 'questions',
+    # 'faq': 'questions',
+    'متا': 'meta',
+    'ریاضی': 'math',
+    # 'imagemap': 'imagemap',
+    'تصویر': 'image',
+    'شکل': 'figure',
+    'شامل': 'include',
+    'خام': 'raw',
+    'جایگزین': 'replace',
+    'یونیکد': 'unicode',
+    'تاریخ': 'date',
+    'کلاس': 'class',
+    'قانون': 'role',
+    'قانون-پیش‌فرض': 'default-role',
+    'عنوان': 'title',
+    'محتوا': 'contents',
+    'شماره-فصل': 'sectnum',
+    'شماره‌گذاری-فصل': 'sectnum',
+    'سرآیند': 'header',
+    'پاصفحه': 'footer',
+    # 'footnotes': 'footnotes',
+    # 'citations': 'citations',
+    'یادداشت-هدف': 'target-notes',
+}
 """Persian name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'مخفف': u'abbreviation',
-    u'سرنام': u'acronym',
-    u'کد': u'code',
-    u'شاخص': u'index',
-    u'زیرنویس': u'subscript',
-    u'بالانویس': u'superscript',
-    u'عنوان': u'title-reference',
-    u'نیرو': u'pep-reference',
-    u'rfc-reference (translation required)': u'rfc-reference',
-    u'تاکید': u'emphasis',
-    u'قوی': u'strong',
-    u'لفظی': u'literal',
-    u'ریاضی': u'math',
-    u'منبع-نام‌گذاری': u'named-reference',
-    u'منبع-ناشناس': u'anonymous-reference',
-    u'منبع-پانویس': u'footnote-reference',
-    u'منبع-نقل‌فول': u'citation-reference',
-    u'منبع-جایگزینی': u'substitution-reference',
-    u'هدف': u'target',
-    u'منبع-uri': u'uri-reference',
-    u'uri': u'uri-reference',
-    u'url': u'uri-reference',
-    u'خام': u'raw',}
+    'مخفف': 'abbreviation',
+    'سرنام': 'acronym',
+    'کد': 'code',
+    'شاخص': 'index',
+    'زیرنویس': 'subscript',
+    'بالانویس': 'superscript',
+    'عنوان': 'title-reference',
+    'نیرو': 'pep-reference',
+    'rfc-reference (translation required)': 'rfc-reference',
+    'تاکید': 'emphasis',
+    'قوی': 'strong',
+    'لفظی': 'literal',
+    'ریاضی': 'math',
+    'منبع-نام‌گذاری': 'named-reference',
+    'منبع-ناشناس': 'anonymous-reference',
+    'منبع-پانویس': 'footnote-reference',
+    'منبع-نقل‌فول': 'citation-reference',
+    'منبع-جایگزینی': 'substitution-reference',
+    'هدف': 'target',
+    'منبع-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'خام': 'raw',
+}
 """Mapping of Persian role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/fi.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/fi.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: fi.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: fi.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Asko Soukka <asko.soukka@iki.fi>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Finnish-language mappings for language-dependent features of
@@ -18,81 +17,82 @@
 
 directives = {
       # language-dependent: fixed
-      u'huomio': u'attention',
-      u'varo': u'caution',
-      u'code (translation required)': 'code',
-      u'vaara': u'danger',
-      u'virhe': u'error',
-      u'vihje': u'hint',
-      u't\u00e4rke\u00e4\u00e4': u'important',
-      u'huomautus': u'note',
-      u'neuvo': u'tip',
-      u'varoitus': u'warning',
-      u'kehotus': u'admonition',
-      u'sivupalkki': u'sidebar',
-      u'aihe': u'topic',
-      u'rivi': u'line-block',
-      u'tasalevyinen': u'parsed-literal',
-      u'ohje': u'rubric',
-      u'epigraafi': u'epigraph',
-      u'kohokohdat': u'highlights',
-      u'lainaus': u'pull-quote',
-      u'taulukko': u'table',
-      u'csv-taulukko': u'csv-table',
-      u'list-table (translation required)': 'list-table',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #u'kysymykset': u'questions',
-      u'meta': u'meta',
+      'huomio': 'attention',
+      'varo': 'caution',
+      'code (translation required)': 'code',
+      'vaara': 'danger',
+      'virhe': 'error',
+      'vihje': 'hint',
+      't\u00e4rke\u00e4\u00e4': 'important',
+      'huomautus': 'note',
+      'neuvo': 'tip',
+      'varoitus': 'warning',
+      'kehotus': 'admonition',
+      'sivupalkki': 'sidebar',
+      'aihe': 'topic',
+      'rivi': 'line-block',
+      'tasalevyinen': 'parsed-literal',
+      'ohje': 'rubric',
+      'epigraafi': 'epigraph',
+      'kohokohdat': 'highlights',
+      'lainaus': 'pull-quote',
+      'taulukko': 'table',
+      'csv-taulukko': 'csv-table',
+      'list-table (translation required)': 'list-table',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'kysymykset': 'questions',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #u'kuvakartta': u'imagemap',
-      u'kuva': u'image',
-      u'kaavio': u'figure',
-      u'sis\u00e4llyt\u00e4': u'include',
-      u'raaka': u'raw',
-      u'korvaa': u'replace',
-      u'unicode': u'unicode',
-      u'p\u00e4iv\u00e4ys': u'date',
-      u'luokka': u'class',
-      u'rooli': u'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
-      u'sis\u00e4llys': u'contents',
-      u'kappale': u'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #u'alaviitteet': u'footnotes',
-      #u'viitaukset': u'citations',
-      u'target-notes (translation required)': u'target-notes'}
+      # 'kuvakartta': 'imagemap',
+      'kuva': 'image',
+      'kaavio': 'figure',
+      'sis\u00e4llyt\u00e4': 'include',
+      'raaka': 'raw',
+      'korvaa': 'replace',
+      'unicode': 'unicode',
+      'p\u00e4iv\u00e4ys': 'date',
+      'luokka': 'class',
+      'rooli': 'role',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
+      'sis\u00e4llys': 'contents',
+      'kappale': 'sectnum',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'alaviitteet': 'footnotes',
+      # 'viitaukset': 'citations',
+      'target-notes (translation required)': 'target-notes'}
 """Finnish name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'lyhennys': u'abbreviation',
-    u'akronyymi': u'acronym',
-    u'kirjainsana': u'acronym',
-    u'code (translation required)': 'code',
-    u'hakemisto': u'index',
-    u'luettelo': u'index',
-    u'alaindeksi': u'subscript',
-    u'indeksi': u'subscript',
-    u'yl\u00e4indeksi': u'superscript',
-    u'title-reference (translation required)': u'title-reference',
-    u'title (translation required)': u'title-reference',
-    u'pep-reference (translation required)': u'pep-reference',
-    u'rfc-reference (translation required)': u'rfc-reference',
-    u'korostus': u'emphasis',
-    u'vahvistus': u'strong',
-    u'tasalevyinen': u'literal',
+    'lyhennys': 'abbreviation',
+    'akronyymi': 'acronym',
+    'kirjainsana': 'acronym',
+    'code (translation required)': 'code',
+    'hakemisto': 'index',
+    'luettelo': 'index',
+    'alaindeksi': 'subscript',
+    'indeksi': 'subscript',
+    'yl\u00e4indeksi': 'superscript',
+    'title-reference (translation required)': 'title-reference',
+    'title (translation required)': 'title-reference',
+    'pep-reference (translation required)': 'pep-reference',
+    'rfc-reference (translation required)': 'rfc-reference',
+    'korostus': 'emphasis',
+    'vahvistus': 'strong',
+    'tasalevyinen': 'literal',
     'math (translation required)': 'math',
-    u'named-reference (translation required)': u'named-reference',
-    u'anonymous-reference (translation required)': u'anonymous-reference',
-    u'footnote-reference (translation required)': u'footnote-reference',
-    u'citation-reference (translation required)': u'citation-reference',
-    u'substitution-reference (translation required)': u'substitution-reference',
-    u'kohde': u'target',
-    u'uri-reference (translation required)': u'uri-reference',
-    u'raw (translation required)': 'raw',}
+    'named-reference (translation required)': 'named-reference',
+    'anonymous-reference (translation required)': 'anonymous-reference',
+    'footnote-reference (translation required)': 'footnote-reference',
+    'citation-reference (translation required)': 'citation-reference',
+    'substitution-reference (translation required)': 'substitution-reference',
+    'kohde': 'target',
+    'uri-reference (translation required)': 'uri-reference',
+    'raw (translation required)': 'raw',
+    }
 """Mapping of Finnish role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/fr.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/fr.py Changed

@@ -1,11 +1,11 @@
-# $Id: fr.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: fr.py 9298 2022-12-02 14:12:34Z aa-turner $
 # Authors: David Goodger <goodger@python.org>; William Dode
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 French-language mappings for language-dependent features of
@@ -16,88 +16,90 @@
 
 
 directives = {
-      u'attention': 'attention',
-      u'pr\u00E9caution': 'caution',
-      u'code': 'code',
-      u'danger': 'danger',
-      u'erreur': 'error',
-      u'conseil': 'hint',
-      u'important': 'important',
-      u'note': 'note',
-      u'astuce': 'tip',
-      u'avertissement': 'warning',
-      u'admonition': 'admonition',
-      u'encadr\u00E9': 'sidebar',
-      u'sujet': 'topic',
-      u'bloc-textuel': 'line-block',
-      u'bloc-interpr\u00E9t\u00E9': 'parsed-literal',
-      u'code-interpr\u00E9t\u00E9': 'parsed-literal',
-      u'intertitre': 'rubric',
-      u'exergue': 'epigraph',
-      u'\u00E9pigraphe': 'epigraph',
-      u'chapeau': 'highlights',
-      u'accroche': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #u'questions': 'questions',
-      #u'qr': 'questions',
-      #u'faq': 'questions',
-      u'tableau': 'table',
-      u'csv-table (translation required)': 'csv-table',
-      u'list-table (translation required)': 'list-table',
-      u'm\u00E9ta': 'meta',
+      'attention': 'attention',
+      'précaution': 'caution',
+      'danger': 'danger',
+      'erreur': 'error',
+      'conseil': 'hint',
+      'important': 'important',
+      'note': 'note',
+      'astuce': 'tip',
+      'avertissement': 'warning',
+      'admonition': 'admonition',  # sic! Not used in this sense in rST.
+      'encadré': 'sidebar',
+      'sujet': 'topic',
+      'bloc-textuel': 'line-block',
+      'bloc-interprété': 'parsed-literal',
+      'code-interprété': 'parsed-literal',
+      'code': 'code',
       'math (translation required)': 'math',
-      #u'imagemap (translation required)': 'imagemap',
-      u'image': 'image',
-      u'figure': 'figure',
-      u'inclure': 'include',
-      u'brut': 'raw',
-      u'remplacer': 'replace',
-      u'remplace': 'replace',
-      u'unicode': 'unicode',
-      u'date': 'date',
-      u'classe': 'class',
-      u'role (translation required)': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'titre (translation required)': 'title',
-      u'sommaire': 'contents',
-      u'table-des-mati\u00E8res': 'contents',
-      u'sectnum': 'sectnum',
-      u'section-num\u00E9rot\u00E9e': 'sectnum',
-      u'liens': 'target-notes',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #u'footnotes (translation required)': 'footnotes',
-      #u'citations (translation required)': 'citations',
+      'intertitre': 'rubric',
+      'exergue': 'epigraph',
+      'épigraphe': 'epigraph',
+      'chapeau': 'highlights',
+      'accroche': 'pull-quote',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      'tableau': 'table',
+      'csv-table (translation required)': 'csv-table',
+      'list-table (translation required)': 'list-table',
+      'méta': 'meta',
+      # 'imagemap (translation required)': 'imagemap',
+      'image': 'image',
+      'figure': 'figure',
+      'inclure': 'include',
+      'brut': 'raw',
+      'remplacer': 'replace',
+      'remplace': 'replace',
+      'unicode': 'unicode',
+      'date': 'date',
+      'classe': 'class',
+      'role (translation required)': 'role',
+      'default-role (translation required)': 'default-role',
+      'titre (translation required)': 'title',
+      'sommaire': 'contents',
+      'table-des-matières': 'contents',
+      'sectnum': 'sectnum',
+      'section-numérotée': 'sectnum',
+      'liens': 'target-notes',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'footnotes (translation required)': 'footnotes',
+      # 'citations (translation required)': 'citations',
       }
-"""French name to registered (in directives/__init__.py) directive name
-mapping."""
+"""Mapping of French directive names to registered directive names
+
+Cf. https://docutils.sourceforge.io/docs/ref/rst/directives.html
+and `_directive_registry` in ``directives/__init__.py``.
+"""
 
 roles = {
-      u'abr\u00E9viation': 'abbreviation',
-      u'acronyme': 'acronym',
-      u'sigle': 'acronym',
-      u'code': 'code',
-      u'index': 'index',
-      u'indice': 'subscript',
-      u'ind': 'subscript',
-      u'exposant': 'superscript',
-      u'exp': 'superscript',
-      u'titre-r\u00E9f\u00E9rence': 'title-reference',
-      u'titre': 'title-reference',
-      u'pep-r\u00E9f\u00E9rence': 'pep-reference',
-      u'rfc-r\u00E9f\u00E9rence': 'rfc-reference',
-      u'emphase': 'emphasis',
-      u'fort': 'strong',
-      u'litt\u00E9ral': 'literal',
-    'math (translation required)': 'math',
-      u'nomm\u00E9e-r\u00E9f\u00E9rence': 'named-reference',
-      u'anonyme-r\u00E9f\u00E9rence': 'anonymous-reference',
-      u'note-r\u00E9f\u00E9rence': 'footnote-reference',
-      u'citation-r\u00E9f\u00E9rence': 'citation-reference',
-      u'substitution-r\u00E9f\u00E9rence': 'substitution-reference',
-      u'lien': 'target',
-      u'uri-r\u00E9f\u00E9rence': 'uri-reference',
-      u'brut': 'raw',}
+      'abréviation': 'abbreviation',
+      'acronyme': 'acronym',
+      'sigle': 'acronym',
+      'code': 'code',
+      'emphase': 'emphasis',
+      'littéral': 'literal',
+      'math (translation required)': 'math',
+      'pep-référence': 'pep-reference',
+      'rfc-référence': 'rfc-reference',
+      'fort': 'strong',
+      'indice': 'subscript',
+      'ind': 'subscript',
+      'exposant': 'superscript',
+      'exp': 'superscript',
+      'titre-référence': 'title-reference',
+      'titre': 'title-reference',
+      'brut': 'raw',
+      # the following roles are not implemented in Docutils
+      'index': 'index',
+      'nommée-référence': 'named-reference',
+      'anonyme-référence': 'anonymous-reference',
+      'note-référence': 'footnote-reference',
+      'citation-référence': 'citation-reference',
+      'substitution-référence': 'substitution-reference',
+      'lien': 'target',
+      'uri-référence': 'uri-reference',
+      }
 """Mapping of French role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/gl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/gl.py Changed

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Author: David Goodger
 # Contact: goodger@users.sourceforge.net
 # Revision: $Revision: 4229 $
@@ -6,9 +5,9 @@
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Galician-language mappings for language-dependent features of
@@ -20,92 +19,93 @@
 
 directives = {
       # language-dependent: fixed
-      u'atenci\u00f3n': 'attention',
-      u'advertencia': 'caution',
-      u'code (translation required)': 'code',
-      u'perigo': 'danger',
-      u'erro': 'error',
-      u'pista': 'hint',
-      u'importante': 'important',
-      u'nota': 'note',
-      u'consello': 'tip',
-      u'aviso': 'warning',
-      u'admonici\u00f3n': 'admonition',
-      u'barra lateral': 'sidebar',
-      u't\u00f3pico': 'topic',
-      u'bloque-li\u00f1a': 'line-block',
-      u'literal-analizado': 'parsed-literal',
-      u'r\u00fabrica': 'rubric',
-      u'ep\u00edgrafe': 'epigraph',
-      u'realzados': 'highlights',
-      u'coller-citaci\u00f3n': 'pull-quote',
-      u'compor': 'compound',
-      u'recipiente': 'container',
-      #'questions': 'questions',
-      u't\u00e1boa': 'table',
-      u't\u00e1boa-csv': 'csv-table',
-      u't\u00e1boa-listaxe': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'meta': 'meta',
+      'atenci\u00f3n': 'attention',
+      'advertencia': 'caution',
+      'code (translation required)': 'code',
+      'perigo': 'danger',
+      'erro': 'error',
+      'pista': 'hint',
+      'importante': 'important',
+      'nota': 'note',
+      'consello': 'tip',
+      'aviso': 'warning',
+      'admonici\u00f3n': 'admonition',
+      'barra lateral': 'sidebar',
+      't\u00f3pico': 'topic',
+      'bloque-li\u00f1a': 'line-block',
+      'literal-analizado': 'parsed-literal',
+      'r\u00fabrica': 'rubric',
+      'ep\u00edgrafe': 'epigraph',
+      'realzados': 'highlights',
+      'coller-citaci\u00f3n': 'pull-quote',
+      'compor': 'compound',
+      'recipiente': 'container',
+      # 'questions': 'questions',
+      't\u00e1boa': 'table',
+      't\u00e1boa-csv': 'csv-table',
+      't\u00e1boa-listaxe': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'imaxe': 'image',
-      u'figura': 'figure',
-      u'inclu\u00edr': 'include',
-      u'cru': 'raw',
-      u'substitu\u00edr': 'replace',
-      u'unicode': 'unicode',
-      u'data': 'date',
-      u'clase': 'class',
-      u'regra': 'role',
-      u'regra-predeterminada': 'default-role',
-      u't\u00edtulo': 'title',
-      u'contido': 'contents',
-      u'seccnum': 'sectnum',
-      u'secci\u00f3n-numerar': 'sectnum',
-      u'cabeceira': 'header',
-      u'p\u00e9 de p\u00e1xina': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'notas-destino': 'target-notes',
-      u'texto restruturado-proba-directiva': 'restructuredtext-test-directive'}
+      # 'imagemap': 'imagemap',
+      'imaxe': 'image',
+      'figura': 'figure',
+      'inclu\u00edr': 'include',
+      'cru': 'raw',
+      'substitu\u00edr': 'replace',
+      'unicode': 'unicode',
+      'data': 'date',
+      'clase': 'class',
+      'regra': 'role',
+      'regra-predeterminada': 'default-role',
+      't\u00edtulo': 'title',
+      'contido': 'contents',
+      'seccnum': 'sectnum',
+      'secci\u00f3n-numerar': 'sectnum',
+      'cabeceira': 'header',
+      'p\u00e9 de p\u00e1xina': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'notas-destino': 'target-notes',
+      'texto restruturado-proba-directiva': 'restructuredtext-test-directive'}
 """Galician name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'abreviatura': 'abbreviation',
-    u'ab': 'abbreviation',
-    u'acr\u00f3nimo': 'acronym',
-    u'ac': 'acronym',
-    u'code (translation required)': 'code',
-    u'\u00edndice': 'index',
-    u'i': 'index',
-    u'sub\u00edndice': 'subscript',
-    u'sub': 'subscript',
-    u'super\u00edndice': 'superscript',
-    u'sup': 'superscript',
-    u'referencia t\u00edtulo': 'title-reference',
-    u't\u00edtulo': 'title-reference',
-    u't': 'title-reference',
-    u'referencia-pep': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'referencia-rfc': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'\u00e9nfase': 'emphasis',
-    u'forte': 'strong',
-    u'literal': 'literal',
+    'abreviatura': 'abbreviation',
+    'ab': 'abbreviation',
+    'acr\u00f3nimo': 'acronym',
+    'ac': 'acronym',
+    'code (translation required)': 'code',
+    '\u00edndice': 'index',
+    'i': 'index',
+    'sub\u00edndice': 'subscript',
+    'sub': 'subscript',
+    'super\u00edndice': 'superscript',
+    'sup': 'superscript',
+    'referencia t\u00edtulo': 'title-reference',
+    't\u00edtulo': 'title-reference',
+    't': 'title-reference',
+    'referencia-pep': 'pep-reference',
+    'pep': 'pep-reference',
+    'referencia-rfc': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    '\u00e9nfase': 'emphasis',
+    'forte': 'strong',
+    'literal': 'literal',
     'math (translation required)': 'math',
-    u'referencia-nome': 'named-reference',
-    u'referencia-an\u00f3nimo': 'anonymous-reference',
-    u'referencia-nota ao p\u00e9': 'footnote-reference',
-    u'referencia-citaci\u00f3n': 'citation-reference',
-    u'referencia-substituci\u00f3n': 'substitution-reference',
-    u'destino': 'target',
-    u'referencia-uri': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'cru': 'raw',}
+    'referencia-nome': 'named-reference',
+    'referencia-an\u00f3nimo': 'anonymous-reference',
+    'referencia-nota ao p\u00e9': 'footnote-reference',
+    'referencia-citaci\u00f3n': 'citation-reference',
+    'referencia-substituci\u00f3n': 'substitution-reference',
+    'destino': 'target',
+    'referencia-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'cru': 'raw',
+    }
 """Mapping of Galician role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/he.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/he.py Changed

@@ -1,11 +1,11 @@
 # Author: Meir Kriheli
-# Id: $Id: he.py 7119 2011-09-02 13:00:23Z milde $
+# Id: $Id: he.py 9030 2022-03-05 23:28:32Z milde $
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 English-language mappings for language-dependent features of
@@ -17,16 +17,16 @@
 
 directives = {
       # language-dependent: fixed
-      u'\u05ea\u05e9\u05d5\u05de\u05ea \u05dc\u05d1': 'attention',
-      u'\u05d6\u05d4\u05d9\u05e8\u05d5\u05ea': 'caution',
-      u'code (translation required)': 'code',
-      u'\u05e1\u05db\u05e0\u05d4': 'danger',
-      u'\u05e9\u05d2\u05d9\u05d0\u05d4' : 'error',
-      u'\u05e8\u05de\u05d6': 'hint',
-      u'\u05d7\u05e9\u05d5\u05d1': 'important',
-      u'\u05d4\u05e2\u05e8\u05d4': 'note',
-      u'\u05d8\u05d9\u05e4': 'tip',
-      u'\u05d0\u05d6\u05d4\u05e8\u05d4': 'warning',
+      '\u05ea\u05e9\u05d5\u05de\u05ea \u05dc\u05d1': 'attention',
+      '\u05d6\u05d4\u05d9\u05e8\u05d5\u05ea': 'caution',
+      'code (translation required)': 'code',
+      '\u05e1\u05db\u05e0\u05d4': 'danger',
+      '\u05e9\u05d2\u05d9\u05d0\u05d4': 'error',
+      '\u05e8\u05de\u05d6': 'hint',
+      '\u05d7\u05e9\u05d5\u05d1': 'important',
+      '\u05d4\u05e2\u05e8\u05d4': 'note',
+      '\u05d8\u05d9\u05e4': 'tip',
+      '\u05d0\u05d6\u05d4\u05e8\u05d4': 'warning',
       'admonition': 'admonition',
       'sidebar': 'sidebar',
       'topic': 'topic',
@@ -38,33 +38,33 @@
       'pull-quote': 'pull-quote',
       'compound': 'compound',
       'container': 'container',
-      #'questions': 'questions',
+      # 'questions': 'questions',
       'table': 'table',
       'csv-table': 'csv-table',
       'list-table': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
       'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'\u05ea\u05de\u05d5\u05e0\u05d4': 'image',
+      # 'imagemap': 'imagemap',
+      '\u05ea\u05de\u05d5\u05e0\u05d4': 'image',
       'figure': 'figure',
       'include': 'include',
       'raw': 'raw',
       'replace': 'replace',
       'unicode': 'unicode',
       'date': 'date',
-       u'\u05e1\u05d2\u05e0\u05d5\u05df': 'class',
+      '\u05e1\u05d2\u05e0\u05d5\u05df': 'class',
       'role': 'role',
       'default-role': 'default-role',
       'title': 'title',
-      u'\u05ea\u05d5\u05db\u05df': 'contents',
+      '\u05ea\u05d5\u05db\u05df': 'contents',
       'sectnum': 'sectnum',
       'section-numbering': 'sectnum',
       'header': 'header',
       'footer': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
       'target-notes': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """English name to registered (in directives/__init__.py) directive name
@@ -76,12 +76,12 @@
     'ab': 'abbreviation',
     'acronym': 'acronym',
     'ac': 'acronym',
-    u'code (translation required)': 'code',
+    'code (translation required)': 'code',
     'index': 'index',
     'i': 'index',
-    u'\u05ea\u05d7\u05ea\u05d9': 'subscript',
+    '\u05ea\u05d7\u05ea\u05d9': 'subscript',
     'sub': 'subscript',
-    u'\u05e2\u05d9\u05dc\u05d9': 'superscript',
+    '\u05e2\u05d9\u05dc\u05d9': 'superscript',
     'sup': 'superscript',
     'title-reference': 'title-reference',
     'title': 'title-reference',
@@ -103,6 +103,7 @@
     'uri-reference': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'raw': 'raw',}
+    'raw': 'raw',
+    }
 """Mapping of English role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/it.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/it.py Changed

@@ -1,4 +1,4 @@
-# $Id: it.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: it.py 9116 2022-07-28 17:06:51Z milde $
 # Authors: Nicola Larosa <docutils@tekNico.net>;
 #          Lele Gaifax <lele@seldati.it>
 # Copyright: This module has been placed in the public domain.
@@ -27,7 +27,7 @@
       'nota': 'note',
       'consiglio': 'tip',
       'avvertenza': 'warning',
-      'ammonizione': 'admonition',
+      'ammonizione': 'admonition',  # sic! Not used in this sense in rST.
       'riquadro': 'sidebar',
       'argomento': 'topic',
       'blocco-di-righe': 'line-block',
@@ -37,16 +37,16 @@
       'punti-salienti': 'highlights',
       'estratto-evidenziato': 'pull-quote',
       'composito': 'compound',
-      u'container (translation required)': 'container',
-      #'questions': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
+      'container (translation required)': 'container',
+      # 'questions': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
       'tabella': 'table',
       'tabella-csv': 'csv-table',
       'tabella-elenco': 'list-table',
       'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'immagine': 'image',
       'figura': 'figure',
       'includi': 'include',
@@ -65,8 +65,8 @@
       'annota-riferimenti-esterni': 'target-notes',
       'intestazione': 'header',
       'piede-pagina': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Italian name to registered (in directives/__init__.py) directive name
 mapping."""
@@ -74,7 +74,7 @@
 roles = {
       'abbreviazione': 'abbreviation',
       'acronimo': 'acronym',
-      u'code (translation required)': 'code',
+      'code (translation required)': 'code',
       'indice': 'index',
       'deponente': 'subscript',
       'esponente': 'superscript',
@@ -84,7 +84,7 @@
       'enfasi': 'emphasis',
       'forte': 'strong',
       'letterale': 'literal',
-    'math (translation required)': 'math',
+      'math (translation required)': 'math',
       'riferimento-con-nome': 'named-reference',
       'riferimento-anonimo': 'anonymous-reference',
       'riferimento-nota': 'footnote-reference',
@@ -92,6 +92,7 @@
       'riferimento-sostituzione': 'substitution-reference',
       'destinazione': 'target',
       'riferimento-uri': 'uri-reference',
-      'grezzo': 'raw',}
+      'grezzo': 'raw',
+      }
 """Mapping of Italian role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/ja.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/ja.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: ja.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: ja.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Japanese-language mappings for language-dependent features of
@@ -20,100 +19,101 @@
 
 directives = {
     # language-dependent: fixed
-    u'注目': 'attention',
-    u'注意': 'caution',
-    u'code (translation required)': 'code',
-    u'危険': 'danger',
-    u'エラー': 'error',
-    u'ヒント': 'hint',
-    u'重要': 'important',
-    u'備考': 'note',
-    u'通報': 'tip',
-    u'警告': 'warning',
-    u'戒告': 'admonition',
-    u'サイドバー': 'sidebar',
-    u'トピック': 'topic',
-    u'ラインブロック': 'line-block',
-    u'パーズドリテラル': 'parsed-literal',
-    u'ルブリック': 'rubric',
-    u'エピグラフ': 'epigraph',
-    u'題言': 'epigraph',
-    u'ハイライト': 'highlights',
-    u'見所': 'highlights',
-    u'プルクオート': 'pull-quote',
-    u'合成': 'compound',
-    u'コンテナー': 'container',
-    u'容器': 'container',
-    u'表': 'table',
-    u'csv表': 'csv-table',
-    u'リスト表': 'list-table',
-    #u'質問': 'questions',
-    #u'問答': 'questions',
-    #u'faq': 'questions',
-    u'math (translation required)': 'math',
-    u'メタ': 'meta',
-    #u'イメージマプ': 'imagemap',
-    u'イメージ': 'image',
-    u'画像': 'image',
-    u'フィグア': 'figure',
-    u'図版': 'figure',
-    u'インクルード': 'include',
-    u'含む': 'include',
-    u'組み込み': 'include',
-    u'生': 'raw',
-    u'原': 'raw',
-    u'換える': 'replace',
-    u'取り換える': 'replace',
-    u'掛け替える': 'replace',
-    u'ユニコード': 'unicode',
-    u'日付': 'date',
-    u'クラス': 'class',
-    u'ロール': 'role',
-    u'役': 'role',
-    u'ディフォルトロール': 'default-role',
-    u'既定役': 'default-role',
-    u'タイトル': 'title',
-    u'題': 'title',                    # 題名　件名
-    u'目次': 'contents',
-    u'節数': 'sectnum',
-    u'ヘッダ': 'header',
-    u'フッタ': 'footer',
-    #u'脚注': 'footnotes',             # 脚註?
-    #u'サイテーション': 'citations',　　　# 出典　引証　引用
-    u'ターゲットノート': 'target-notes', # 的注　的脚注
+    '注目': 'attention',
+    '注意': 'caution',
+    'code (translation required)': 'code',
+    '危険': 'danger',
+    'エラー': 'error',
+    'ヒント': 'hint',
+    '重要': 'important',
+    '備考': 'note',
+    '通報': 'tip',
+    '警告': 'warning',
+    '戒告': 'admonition',
+    'サイドバー': 'sidebar',
+    'トピック': 'topic',
+    'ラインブロック': 'line-block',
+    'パーズドリテラル': 'parsed-literal',
+    'ルブリック': 'rubric',
+    'エピグラフ': 'epigraph',
+    '題言': 'epigraph',
+    'ハイライト': 'highlights',
+    '見所': 'highlights',
+    'プルクオート': 'pull-quote',
+    '合成': 'compound',
+    'コンテナー': 'container',
+    '容器': 'container',
+    '表': 'table',
+    'csv表': 'csv-table',
+    'リスト表': 'list-table',
+    # '質問': 'questions',
+    # '問答': 'questions',
+    # 'faq': 'questions',
+    'math (translation required)': 'math',
+    'メタ': 'meta',
+    # 'イメージマプ': 'imagemap',
+    'イメージ': 'image',
+    '画像': 'image',
+    'フィグア': 'figure',
+    '図版': 'figure',
+    'インクルード': 'include',
+    '含む': 'include',
+    '組み込み': 'include',
+    '生': 'raw',
+    '原': 'raw',
+    '換える': 'replace',
+    '取り換える': 'replace',
+    '掛け替える': 'replace',
+    'ユニコード': 'unicode',
+    '日付': 'date',
+    'クラス': 'class',
+    'ロール': 'role',
+    '役': 'role',
+    'ディフォルトロール': 'default-role',
+    '既定役': 'default-role',
+    'タイトル': 'title',
+    '題': 'title',                       # 題名　件名
+    '目次': 'contents',
+    '節数': 'sectnum',
+    'ヘッダ': 'header',
+    'フッタ': 'footer',
+    # '脚注': 'footnotes',                # 脚註?
+    # 'サイテーション': 'citations',　　　# 出典　引証　引用
+    'ターゲットノート': 'target-notes',  # 的注　的脚注
     }
 """Japanese name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'略': 'abbreviation',
-    u'頭字語': 'acronym',
-    u'code (translation required)': 'code',
-    u'インデックス': 'index',
-    u'索引': 'index',
-    u'添字': 'subscript',
-    u'下付': 'subscript',
-    u'下': 'subscript',
-    u'上付': 'superscript',
-    u'上': 'superscript',
-    u'題参照': 'title-reference',
-    u'pep参照': 'pep-reference',
-    u'rfc参照': 'rfc-reference',
-    u'強調': 'emphasis',
-    u'強い': 'strong',
-    u'リテラル': 'literal',
-    u'整形済み': 'literal',
-    u'math (translation required)': 'math',
-    u'名付参照': 'named-reference',
-    u'無名参照': 'anonymous-reference',
-    u'脚注参照': 'footnote-reference',
-    u'出典参照': 'citation-reference',
-    u'代入参照': 'substitution-reference',
-    u'的': 'target',
-    u'uri参照': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'生': 'raw',}
+    '略': 'abbreviation',
+    '頭字語': 'acronym',
+    'code (translation required)': 'code',
+    'インデックス': 'index',
+    '索引': 'index',
+    '添字': 'subscript',
+    '下付': 'subscript',
+    '下': 'subscript',
+    '上付': 'superscript',
+    '上': 'superscript',
+    '題参照': 'title-reference',
+    'pep参照': 'pep-reference',
+    'rfc参照': 'rfc-reference',
+    '強調': 'emphasis',
+    '強い': 'strong',
+    'リテラル': 'literal',
+    '整形済み': 'literal',
+    'math (translation required)': 'math',
+    '名付参照': 'named-reference',
+    '無名参照': 'anonymous-reference',
+    '脚注参照': 'footnote-reference',
+    '出典参照': 'citation-reference',
+    '代入参照': 'substitution-reference',
+    '的': 'target',
+    'uri参照': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    '生': 'raw',
+    }
 """Mapping of Japanese role names to canonical role names for interpreted
 text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/ko.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/ko.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: ko.py 8541 2020-08-22 22:16:25Z milde $
+# $Id: ko.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Thomas SJ Kang <thomas.kangsj@ujuc.kr>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Korean-language mappings for language-dependent features of
@@ -18,94 +17,95 @@
 
 directives = {
       # language-dependent: fixed
-      u'집중': 'attention',
-      u'주의': 'caution',
-      u'코드': 'code',
-      u'코드-블록': 'code',
-      u'소스코드': 'code',
-      u'위험': 'danger',
-      u'오류': 'error',
-      u'실마리': 'hint',
-      u'중요한': 'important',
-      u'비고': 'note',
-      u'팁': 'tip',
-      u'경고': 'warning',
-      u'권고': 'admonition',
-      u'사이드바': 'sidebar',
-      u'주제': 'topic',
-      u'라인-블록': 'line-block',
-      u'파싱된-리터럴': 'parsed-literal',
-      u'지시문': 'rubric',
-      u'제명': 'epigraph',
-      u'하이라이트': 'highlights',
-      u'발췌문': 'pull-quote',
-      u'합성어': 'compound',
-      u'컨테이너': 'container',
-      #u'질문': 'questions',
-      u'표': 'table',
-      u'csv-표': 'csv-table',
-      u'list-표': 'list-table',
-      #u'qa': 'questions',
-      #u'faq': 'questions',
-      u'메타': 'meta',
-      u'수학': 'math',
-      #u'이미지맵': 'imagemap',
-      u'이미지': 'image',
-      u'도표': 'figure',
-      u'포함': 'include',
+      '집중': 'attention',
+      '주의': 'caution',
+      '코드': 'code',
+      '코드-블록': 'code',
+      '소스코드': 'code',
+      '위험': 'danger',
+      '오류': 'error',
+      '실마리': 'hint',
+      '중요한': 'important',
+      '비고': 'note',
+      '팁': 'tip',
+      '경고': 'warning',
+      '권고': 'admonition',
+      '사이드바': 'sidebar',
+      '주제': 'topic',
+      '라인-블록': 'line-block',
+      '파싱된-리터럴': 'parsed-literal',
+      '지시문': 'rubric',
+      '제명': 'epigraph',
+      '하이라이트': 'highlights',
+      '발췌문': 'pull-quote',
+      '합성어': 'compound',
+      '컨테이너': 'container',
+      # '질문': 'questions',
+      '표': 'table',
+      'csv-표': 'csv-table',
+      'list-표': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      '메타': 'meta',
+      '수학': 'math',
+      # '이미지맵': 'imagemap',
+      '이미지': 'image',
+      '도표': 'figure',
+      '포함': 'include',
       'raw': 'raw',
-      u'대신하다': 'replace',
-      u'유니코드': 'unicode',
-      u'날짜': 'date',
-      u'클래스': 'class',
-      u'역할': 'role',
-      u'기본-역할': 'default-role',
-      u'제목': 'title',
-      u'내용': 'contents',
+      '대신하다': 'replace',
+      '유니코드': 'unicode',
+      '날짜': 'date',
+      '클래스': 'class',
+      '역할': 'role',
+      '기본-역할': 'default-role',
+      '제목': 'title',
+      '내용': 'contents',
       'sectnum': 'sectnum',
-      u'섹션-번호-매기기': 'sectnum',
-      u'머리말': 'header',
-      u'꼬리말': 'footer',
-      #u'긱주': 'footnotes',
-      #u'인용구': 'citations',
-      u'목표-노트': 'target-notes',
-      u'restructuredtext 테스트 지시어': 'restructuredtext-test-directive'}
+      '섹션-번호-매기기': 'sectnum',
+      '머리말': 'header',
+      '꼬리말': 'footer',
+      # '긱주': 'footnotes',
+      # '인용구': 'citations',
+      '목표-노트': 'target-notes',
+      'restructuredtext 테스트 지시어': 'restructuredtext-test-directive'}
 """Korean name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'약어': 'abbreviation',
-    u'ab': 'abbreviation',
-    u'두음문자': 'acronym',
-    u'ac': 'acronym',
-    u'코드': 'code',
-    u'색인': 'index',
-    u'i': 'index',
-    u'다리-글자': 'subscript',
-    u'sub': 'subscript',
-    u'어깨-글자': 'superscript',
-    u'sup': 'superscript',
-    u'제목-참조': 'title-reference',
-    u'제목': 'title-reference',
-    u't': 'title-reference',
-    u'pep-참조': 'pep-reference',
-    u'pep': 'pep-reference',
-    u'rfc-참조': 'rfc-reference',
-    u'rfc': 'rfc-reference',
-    u'강조': 'emphasis',
-    u'굵게': 'strong',
-    u'기울기': 'literal',
-    u'수학': 'math',
-    u'명명된-참조': 'named-reference',
-    u'익명-참조': 'anonymous-reference',
-    u'각주-참조': 'footnote-reference',
-    u'인용-참조': 'citation-reference',
-    u'대리-참조': 'substitution-reference',
-    u'대상': 'target',
-    u'uri-참조': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    'raw': 'raw',}
+    '약어': 'abbreviation',
+    'ab': 'abbreviation',
+    '두음문자': 'acronym',
+    'ac': 'acronym',
+    '코드': 'code',
+    '색인': 'index',
+    'i': 'index',
+    '다리-글자': 'subscript',
+    'sub': 'subscript',
+    '어깨-글자': 'superscript',
+    'sup': 'superscript',
+    '제목-참조': 'title-reference',
+    '제목': 'title-reference',
+    't': 'title-reference',
+    'pep-참조': 'pep-reference',
+    'pep': 'pep-reference',
+    'rfc-참조': 'rfc-reference',
+    'rfc': 'rfc-reference',
+    '강조': 'emphasis',
+    '굵게': 'strong',
+    '기울기': 'literal',
+    '수학': 'math',
+    '명명된-참조': 'named-reference',
+    '익명-참조': 'anonymous-reference',
+    '각주-참조': 'footnote-reference',
+    '인용-참조': 'citation-reference',
+    '대리-참조': 'substitution-reference',
+    '대상': 'target',
+    'uri-참조': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'raw': 'raw',
+    }
 """Mapping of Korean role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/lt.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/lt.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: lt.py 7668 2013-06-04 12:46:30Z milde $
+# $Id: lt.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Dalius Dobravolskas <dalius.do...@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Lithuanian-language mappings for language-dependent features of
@@ -18,56 +17,56 @@
 
 directives = {
       # language-dependent: fixed
-      u'dėmesio': 'attention',
-      u'atsargiai': 'caution',
-      u'code (translation required)': 'code',
-      u'pavojinga': 'danger',
-      u'klaida': 'error',
-      u'užuomina': 'hint',
-      u'svarbu': 'important',
-      u'pastaba': 'note',
-      u'patarimas': 'tip',
-      u'įspėjimas': 'warning',
-      u'perspėjimas': 'admonition',
-      u'šoninė-juosta': 'sidebar',
-      u'tema': 'topic',
-      u'linijinis-blokas': 'line-block',
-      u'išanalizuotas-literalas': 'parsed-literal',
-      u'rubrika': 'rubric',
-      u'epigrafas': 'epigraph',
-      u'pagridiniai-momentai': 'highlights',
-      u'atitraukta-citata': 'pull-quote',
-      u'sudėtinis-darinys': 'compound',
-      u'konteineris': 'container',
-      #'questions': 'questions',
-      u'lentelė': 'table',
-      u'csv-lentelė': 'csv-table',
-      u'sąrašo-lentelė': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'meta': 'meta',
-      u'matematika': 'math',
-      #'imagemap': 'imagemap',
-      u'paveiksliukas': 'image',
-      u'iliustracija': 'figure',
-      u'pridėti': 'include',
-      u'žalia': 'raw',
-      u'pakeisti': 'replace',
-      u'unikodas': 'unicode',
-      u'data': 'date',
-      u'klasė': 'class',
-      u'rolė': 'role',
-      u'numatytoji-rolė': 'default-role',
-      u'titulas': 'title',
-      u'turinys': 'contents',
-      u'seknum': 'sectnum',
-      u'sekcijos-numeravimas': 'sectnum',
-      u'antraštė': 'header',
-      u'poraštė': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'nutaikytos-pastaba': 'target-notes',
-      u'restructuredtext-testinė-direktyva': 'restructuredtext-test-directive'}
+      'dėmesio': 'attention',
+      'atsargiai': 'caution',
+      'code (translation required)': 'code',
+      'pavojinga': 'danger',
+      'klaida': 'error',
+      'užuomina': 'hint',
+      'svarbu': 'important',
+      'pastaba': 'note',
+      'patarimas': 'tip',
+      'įspėjimas': 'warning',
+      'perspėjimas': 'admonition',
+      'šoninė-juosta': 'sidebar',
+      'tema': 'topic',
+      'linijinis-blokas': 'line-block',
+      'išanalizuotas-literalas': 'parsed-literal',
+      'rubrika': 'rubric',
+      'epigrafas': 'epigraph',
+      'pagridiniai-momentai': 'highlights',
+      'atitraukta-citata': 'pull-quote',
+      'sudėtinis-darinys': 'compound',
+      'konteineris': 'container',
+      # 'questions': 'questions',
+      'lentelė': 'table',
+      'csv-lentelė': 'csv-table',
+      'sąrašo-lentelė': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'meta': 'meta',
+      'matematika': 'math',
+      # 'imagemap': 'imagemap',
+      'paveiksliukas': 'image',
+      'iliustracija': 'figure',
+      'pridėti': 'include',
+      'žalia': 'raw',
+      'pakeisti': 'replace',
+      'unikodas': 'unicode',
+      'data': 'date',
+      'klasė': 'class',
+      'rolė': 'role',
+      'numatytoji-rolė': 'default-role',
+      'titulas': 'title',
+      'turinys': 'contents',
+      'seknum': 'sectnum',
+      'sekcijos-numeravimas': 'sectnum',
+      'antraštė': 'header',
+      'poraštė': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'nutaikytos-pastaba': 'target-notes',
+      'restructuredtext-testinė-direktyva': 'restructuredtext-test-directive'}
 """Lithuanian name to registered (in directives/__init__.py) directive name
 mapping."""
 
@@ -77,33 +76,34 @@
     'sa': 'abbreviation',
     'akronimas': 'acronym',
     'ak': 'acronym',
-    u'code (translation required)': 'code',
+    'code (translation required)': 'code',
     'indeksas': 'index',
     'i': 'index',
-    u'apatinis-indeksas': 'subscript',
+    'apatinis-indeksas': 'subscript',
     'sub': 'subscript',
-    u'viršutinis-indeksas': 'superscript',
+    'viršutinis-indeksas': 'superscript',
     'sup': 'superscript',
-    u'antrašės-nuoroda': 'title-reference',
-    u'antraštė': 'title-reference',
+    'antrašės-nuoroda': 'title-reference',
+    'antraštė': 'title-reference',
     'a': 'title-reference',
     'pep-nuoroda': 'pep-reference',
     'pep': 'pep-reference',
     'rfc-nuoroda': 'rfc-reference',
     'rfc': 'rfc-reference',
-    u'paryškinimas': 'emphasis',
-    u'sustiprintas': 'strong',
-    u'literalas': 'literal',
-    u'matematika': 'math',
-    u'vardinė-nuoroda': 'named-reference',
-    u'anoniminė-nuoroda': 'anonymous-reference',
-    u'išnašos-nuoroda': 'footnote-reference',
-    u'citatos-nuoroda': 'citation-reference',
-    u'pakeitimo-nuoroda': 'substitution-reference',
-    u'taikinys': 'target',
-    u'uri-nuoroda': 'uri-reference',
+    'paryškinimas': 'emphasis',
+    'sustiprintas': 'strong',
+    'literalas': 'literal',
+    'matematika': 'math',
+    'vardinė-nuoroda': 'named-reference',
+    'anoniminė-nuoroda': 'anonymous-reference',
+    'išnašos-nuoroda': 'footnote-reference',
+    'citatos-nuoroda': 'citation-reference',
+    'pakeitimo-nuoroda': 'substitution-reference',
+    'taikinys': 'target',
+    'uri-nuoroda': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'žalia': 'raw',}
+    'žalia': 'raw',
+    }
 """Mapping of English role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/lv.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/lv.py Changed

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
-# $Id: lv.py 7975 2016-10-20 20:00:19Z milde $
+# $Id: lv.py 9030 2022-03-05 23:28:32Z milde $
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Latvian-language mappings for language-dependent features of
@@ -40,15 +39,15 @@
       'izvilkuma-citāts': 'pull-quote',
       'savienojums': 'compound',
       'konteiners': 'container',
-      #'questions': 'questions',
+      # 'questions': 'questions',
       'tabula': 'table',
       'csv-tabula': 'csv-table',
       'sarakstveida-tabula': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
       'meta': 'meta',
       'matemātika': 'math',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'attēls': 'image',
       'figūra': 'figure',
       'ietvert': 'include',
@@ -64,8 +63,8 @@
       'numurēt-sekcijas': 'sectnum',
       'galvene': 'header',
       'kājene': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
       'atsauces-apakšā': 'target-notes',
       'restructuredtext-testa-direktīva': 'restructuredtext-test-directive'}
 """English name to registered (in directives/__init__.py) directive name
@@ -103,6 +102,7 @@
     'atsauce-uz-uri': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'burtiski': 'raw',}
+    'burtiski': 'raw',
+    }
 """Mapping of English role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/nl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/nl.py Changed

@@ -1,11 +1,11 @@
-# $Id: nl.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: nl.py 9116 2022-07-28 17:06:51Z milde $
 # Author: Martijn Pieters <mjpieters@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Dutch-language mappings for language-dependent features of
@@ -27,7 +27,7 @@
       'opmerking': 'note',
       'tip': 'tip',
       'waarschuwing': 'warning',
-      'aanmaning': 'admonition',
+      'aanmaning': 'admonition',  # sic! Not used in this sense in rST.
       'katern': 'sidebar',
       'onderwerp': 'topic',
       'lijn-blok': 'line-block',
@@ -35,18 +35,18 @@
       'rubriek': 'rubric',
       'opschrift': 'epigraph',
       'hoogtepunten': 'highlights',
-      'pull-quote': 'pull-quote', # Dutch printers use the english term
+      'pull-quote': 'pull-quote',  # Dutch printers use the english term
       'samenstelling': 'compound',
       'verbinding': 'compound',
-      u'container (translation required)': 'container',
-      #'vragen': 'questions',
+      'container (translation required)': 'container',
+      # 'vragen': 'questions',
       'tabel': 'table',
       'csv-tabel': 'csv-table',
       'lijst-tabel': 'list-table',
-      #'veelgestelde-vragen': 'questions',
+      # 'veelgestelde-vragen': 'questions',
       'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'beeld': 'image',
       'figuur': 'figure',
       'opnemen': 'include',
@@ -57,16 +57,16 @@
       'datum': 'date',
       'klasse': 'class',
       'rol': 'role',
-      u'default-role (translation required)': 'default-role',
+      'default-role (translation required)': 'default-role',
       'title (translation required)': 'title',
       'inhoud': 'contents',
       'sectnum': 'sectnum',
       'sectie-nummering': 'sectnum',
       'hoofdstuk-nummering': 'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #'voetnoten': 'footnotes',
-      #'citaten': 'citations',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'voetnoten': 'footnotes',
+      # 'citaten': 'citations',
       'verwijzing-voetnoten': 'target-notes',
       'restructuredtext-test-instructie': 'restructuredtext-test-directive'}
 """Dutch name to registered (in directives/__init__.py) directive name
@@ -78,7 +78,7 @@
     # 'ab': 'abbreviation',
     'acroniem': 'acronym',
     'ac': 'acronym',
-    u'code (translation required)': 'code',
+    'code (translation required)': 'code',
     'index': 'index',
     'i': 'index',
     'inferieur': 'subscript',
@@ -107,6 +107,7 @@
     'uri-referentie': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'onbewerkt': 'raw',}
+    'onbewerkt': 'raw',
+    }
 """Mapping of Dutch role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/pl.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/pl.py Changed

@@ -3,9 +3,9 @@
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Polish-language mappings for language-dependent features of
@@ -17,86 +17,85 @@
 
 directives = {
       # language-dependent: fixed
-      u'uwaga': 'attention',
-      u'ostro\u017cnie': 'caution',
-      u'code (translation required)': 'code',
-      u'niebezpiecze\u0144stwo': 'danger',
-      u'b\u0142\u0105d': 'error',
-      u'wskaz\u00f3wka': 'hint',
-      u'wa\u017cne': 'important',
-      u'przypis': 'note',
-      u'rada': 'tip',
-      u'ostrze\u017cenie': 'warning',
-      u'upomnienie': 'admonition',
-      u'ramka': 'sidebar',
-      u'temat': 'topic',
-      u'blok-linii': 'line-block',
-      u'sparsowany-litera\u0142': 'parsed-literal',
-      u'rubryka': 'rubric',
-      u'epigraf': 'epigraph',
-      u'highlights': 'highlights',  # FIXME no polish equivalent?
-      u'pull-quote': 'pull-quote',  # FIXME no polish equivalent?
-      u'z\u0142o\u017cony': 'compound',
-      u'kontener': 'container',
-      #'questions': 'questions',
-      u'tabela': 'table',
-      u'tabela-csv': 'csv-table',
-      u'tabela-listowa': 'list-table',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'meta': 'meta',
+      'uwaga': 'attention',
+      'ostro\u017cnie': 'caution',
+      'code (translation required)': 'code',
+      'niebezpiecze\u0144stwo': 'danger',
+      'b\u0142\u0105d': 'error',
+      'wskaz\u00f3wka': 'hint',
+      'wa\u017cne': 'important',
+      'przypis': 'note',
+      'rada': 'tip',
+      'ostrze\u017cenie': 'warning',
+      'upomnienie': 'admonition',  # sic! Not used in this sense in rST.
+      # 'zauważenie': 'admonition',  # remark
+      'ramka': 'sidebar',
+      'temat': 'topic',
+      'blok-linii': 'line-block',
+      'sparsowany-litera\u0142': 'parsed-literal',
+      'rubryka': 'rubric',
+      'epigraf': 'epigraph',
+      'highlights': 'highlights',  # FIXME no polish equivalent?
+      'pull-quote': 'pull-quote',  # FIXME no polish equivalent?
+      'z\u0142o\u017cony': 'compound',
+      'kontener': 'container',
+      # 'questions': 'questions',
+      'tabela': 'table',
+      'tabela-csv': 'csv-table',
+      'tabela-listowa': 'list-table',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
-      u'obraz': 'image',
-      u'rycina': 'figure',
-      u'do\u0142\u0105cz': 'include',
-      u'surowe': 'raw',
-      u'zast\u0105p': 'replace',
-      u'unikod': 'unicode',
-      u'data': 'date',
-      u'klasa': 'class',
-      u'rola': 'role',
-      u'rola-domy\u015blna': 'default-role',
-      u'tytu\u0142': 'title',
-      u'tre\u015b\u0107': 'contents',
-      u'sectnum': 'sectnum',
-      u'numeracja-sekcji': 'sectnum',
-      u'nag\u0142\u00f3wek': 'header',
-      u'stopka': 'footer',
-      #'footnotes': 'footnotes',
-      #'citations': 'citations',
-      u'target-notes': 'target-notes',  # FIXME no polish equivalent?
-      u'restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      # 'imagemap': 'imagemap',
+      'obraz': 'image',
+      'rycina': 'figure',
+      'do\u0142\u0105cz': 'include',
+      'surowe': 'raw',
+      'zast\u0105p': 'replace',
+      'unikod': 'unicode',
+      'data': 'date',
+      'klasa': 'class',
+      'rola': 'role',
+      'rola-domy\u015blna': 'default-role',
+      'tytu\u0142': 'title',
+      'tre\u015b\u0107': 'contents',
+      'sectnum': 'sectnum',
+      'numeracja-sekcji': 'sectnum',
+      'nag\u0142\u00f3wek': 'header',
+      'stopka': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
+      'target-notes': 'target-notes',  # FIXME no polish equivalent?
+      'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Polish name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'skr\u00f3t': 'abbreviation',
-    u'akronim': 'acronym',
-    u'code (translation required)': 'code',
-    u'indeks': 'index',
-    u'indeks-dolny': 'subscript',
-    u'indeks-g\u00f3rny': 'superscript',
-    u'referencja-tytu\u0142': 'title-reference',
-    u'referencja-pep': 'pep-reference',
-    u'referencja-rfc': 'rfc-reference',
-    u'podkre\u015blenie': 'emphasis',
-    u'wyt\u0142uszczenie': 'strong',
-    u'dos\u0142ownie': 'literal',
+    'skr\u00f3t': 'abbreviation',
+    'akronim': 'acronym',
+    'code (translation required)': 'code',
+    'indeks': 'index',
+    'indeks-dolny': 'subscript',
+    'indeks-g\u00f3rny': 'superscript',
+    'referencja-tytu\u0142': 'title-reference',
+    'referencja-pep': 'pep-reference',
+    'referencja-rfc': 'rfc-reference',
+    'podkre\u015blenie': 'emphasis',
+    'wyt\u0142uszczenie': 'strong',
+    'dos\u0142ownie': 'literal',
     'math (translation required)': 'math',
-    u'referencja-nazwana': 'named-reference',
-    u'referencja-anonimowa': 'anonymous-reference',
-    u'referencja-przypis': 'footnote-reference',
-    u'referencja-cytat': 'citation-reference',
-    u'referencja-podstawienie': 'substitution-reference',
-    u'cel': 'target',
-    u'referencja-uri': 'uri-reference',
-    u'uri': 'uri-reference',
-    u'url': 'uri-reference',
-    u'surowe': 'raw',}
+    'referencja-nazwana': 'named-reference',
+    'referencja-anonimowa': 'anonymous-reference',
+    'referencja-przypis': 'footnote-reference',
+    'referencja-cytat': 'citation-reference',
+    'referencja-podstawienie': 'substitution-reference',
+    'cel': 'target',
+    'referencja-uri': 'uri-reference',
+    'uri': 'uri-reference',
+    'url': 'uri-reference',
+    'surowe': 'raw',
+    }
 """Mapping of Polish role names to canonical role names for interpreted text.
 """
-    
-
-

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/pt_br.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/pt_br.py Changed

@@ -1,11 +1,11 @@
-# $Id: pt_br.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: pt_br.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Brazilian Portuguese-language mappings for language-dependent features of
@@ -17,92 +17,93 @@
 
 directives = {
       # language-dependent: fixed
-      u'aten\u00E7\u00E3o': 'attention',
+      'aten\u00E7\u00E3o': 'attention',
       'cuidado': 'caution',
-      u'code (translation required)': 'code',
+      'code (translation required)': 'code',
       'perigo': 'danger',
       'erro': 'error',
-      u'sugest\u00E3o': 'hint',
+      'sugest\u00E3o': 'hint',
       'importante': 'important',
       'nota': 'note',
       'dica': 'tip',
       'aviso': 'warning',
-      u'exorta\u00E7\u00E3o': 'admonition',
+      'exorta\u00E7\u00E3o': 'admonition',
       'barra-lateral': 'sidebar',
-      u't\u00F3pico': 'topic',
+      't\u00F3pico': 'topic',
       'bloco-de-linhas': 'line-block',
       'literal-interpretado': 'parsed-literal',
       'rubrica': 'rubric',
-      u'ep\u00EDgrafo': 'epigraph',
+      'ep\u00EDgrafo': 'epigraph',
       'destaques': 'highlights',
-      u'cita\u00E7\u00E3o-destacada': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #'perguntas': 'questions',
-      #'qa': 'questions',
-      #'faq': 'questions',
-      u'table (translation required)': 'table',
-      u'csv-table (translation required)': 'csv-table',
-      u'list-table (translation required)': 'list-table',
+      'cita\u00E7\u00E3o-destacada': 'pull-quote',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'perguntas': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'table (translation required)': 'table',
+      'csv-table (translation required)': 'csv-table',
+      'list-table (translation required)': 'list-table',
       'meta': 'meta',
       'math (translation required)': 'math',
-      #'imagemap': 'imagemap',
+      # 'imagemap': 'imagemap',
       'imagem': 'image',
       'figura': 'figure',
-      u'inclus\u00E3o': 'include',
+      'inclus\u00E3o': 'include',
       'cru': 'raw',
-      u'substitui\u00E7\u00E3o': 'replace',
+      'substitui\u00E7\u00E3o': 'replace',
       'unicode': 'unicode',
       'data': 'date',
       'classe': 'class',
       'role (translation required)': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
-      u'\u00EDndice': 'contents',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
+      '\u00EDndice': 'contents',
       'numsec': 'sectnum',
-      u'numera\u00E7\u00E3o-de-se\u00E7\u00F5es': 'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #u'notas-de-rorap\u00E9': 'footnotes',
-      #u'cita\u00E7\u00F5es': 'citations',
-      u'links-no-rodap\u00E9': 'target-notes',
+      'numera\u00E7\u00E3o-de-se\u00E7\u00F5es': 'sectnum',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'notas-de-rorap\u00E9': 'footnotes',
+      # 'cita\u00E7\u00F5es': 'citations',
+      'links-no-rodap\u00E9': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Brazilian Portuguese name to registered (in directives/__init__.py)
 directive name mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'abbrevia\u00E7\u00E3o': 'abbreviation',
+    'abbrevia\u00E7\u00E3o': 'abbreviation',
     'ab': 'abbreviation',
-    u'acr\u00F4nimo': 'acronym',
+    'acr\u00F4nimo': 'acronym',
     'ac': 'acronym',
-    u'code (translation required)': 'code',
-    u'\u00EDndice-remissivo': 'index',
+    'code (translation required)': 'code',
+    '\u00EDndice-remissivo': 'index',
     'i': 'index',
     'subscrito': 'subscript',
     'sub': 'subscript',
     'sobrescrito': 'superscript',
     'sob': 'superscript',
-    u'refer\u00EAncia-a-t\u00EDtulo': 'title-reference',
-    u't\u00EDtulo': 'title-reference',
+    'refer\u00EAncia-a-t\u00EDtulo': 'title-reference',
+    't\u00EDtulo': 'title-reference',
     't': 'title-reference',
-    u'refer\u00EAncia-a-pep': 'pep-reference',
+    'refer\u00EAncia-a-pep': 'pep-reference',
     'pep': 'pep-reference',
-    u'refer\u00EAncia-a-rfc': 'rfc-reference',
+    'refer\u00EAncia-a-rfc': 'rfc-reference',
     'rfc': 'rfc-reference',
-    u'\u00EAnfase': 'emphasis',
+    '\u00EAnfase': 'emphasis',
     'forte': 'strong',
     'literal': 'literal',
-    'math (translation required)': 'math',               # translation required?
-    u'refer\u00EAncia-por-nome': 'named-reference',
-    u'refer\u00EAncia-an\u00F4nima': 'anonymous-reference',
-    u'refer\u00EAncia-a-nota-de-rodap\u00E9': 'footnote-reference',
-    u'refer\u00EAncia-a-cita\u00E7\u00E3o': 'citation-reference',
-    u'refer\u00EAncia-a-substitui\u00E7\u00E3o': 'substitution-reference',
+    'math (translation required)': 'math',  # translation required?
+    'refer\u00EAncia-por-nome': 'named-reference',
+    'refer\u00EAncia-an\u00F4nima': 'anonymous-reference',
+    'refer\u00EAncia-a-nota-de-rodap\u00E9': 'footnote-reference',
+    'refer\u00EAncia-a-cita\u00E7\u00E3o': 'citation-reference',
+    'refer\u00EAncia-a-substitui\u00E7\u00E3o': 'substitution-reference',
     'alvo': 'target',
-    u'refer\u00EAncia-a-uri': 'uri-reference',
+    'refer\u00EAncia-a-uri': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',
-    'cru': 'raw',}
+    'cru': 'raw',
+    }
 """Mapping of Brazilian Portuguese role names to canonical role names
 for interpreted text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/ru.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/ru.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: ru.py 7123 2011-09-12 08:28:31Z milde $
+# $Id: ru.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Roman Suzi <rnd@onego.ru>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Russian-language mappings for language-dependent features of
@@ -16,74 +15,76 @@
 __docformat__ = 'reStructuredText'
 
 directives = {
- u'блок-строк': u'line-block',
- u'meta': u'meta',
- u'математика': 'math',
- u'обработанный-литерал': u'parsed-literal',
- u'выделенная-цитата': u'pull-quote',
- u'код': 'code',
- u'compound (translation required)': 'compound',
- u'контейнер': 'container',
- u'таблица': 'table',
- u'csv-table (translation required)': 'csv-table',
- u'list-table (translation required)': 'list-table',
- u'сырой': u'raw',
- u'замена': u'replace',
- u'тестовая-директива-restructuredtext': u'restructuredtext-test-directive',
- u'целевые-сноски': u'target-notes',
- u'unicode': u'unicode',
- u'дата': u'date',
- u'боковая-полоса': u'sidebar',
- u'важно': u'important',
- u'включать': u'include',
- u'внимание': u'attention',
- u'выделение': u'highlights',
- u'замечание': u'admonition',
- u'изображение': u'image',
- u'класс': u'class',
- u'роль': 'role',
- u'default-role (translation required)': 'default-role',
- u'титул': 'title',
- u'номер-раздела': u'sectnum',
- u'нумерация-разделов': u'sectnum',
- u'опасно': u'danger',
- u'осторожно': u'caution',
- u'ошибка': u'error',
- u'подсказка': u'tip',
- u'предупреждение': u'warning',
- u'примечание': u'note',
- u'рисунок': u'figure',
- u'рубрика': u'rubric',
- u'совет': u'hint',
- u'содержание': u'contents',
- u'тема': u'topic',
- u'эпиграф': u'epigraph',
- u'header (translation required)': 'header',
- u'footer (translation required)': 'footer',}
+    'блок-строк': 'line-block',
+    'meta': 'meta',
+    'математика': 'math',
+    'обработанный-литерал': 'parsed-literal',
+    'выделенная-цитата': 'pull-quote',
+    'код': 'code',
+    'compound (translation required)': 'compound',
+    'контейнер': 'container',
+    'таблица': 'table',
+    'csv-table (translation required)': 'csv-table',
+    'list-table (translation required)': 'list-table',
+    'сырой': 'raw',
+    'замена': 'replace',
+    'тестовая-директива-restructuredtext': 'restructuredtext-test-directive',
+    'целевые-сноски': 'target-notes',
+    'unicode': 'unicode',
+    'дата': 'date',
+    'боковая-полоса': 'sidebar',
+    'важно': 'important',
+    'включать': 'include',
+    'внимание': 'attention',
+    'выделение': 'highlights',
+    'замечание': 'admonition',
+    'изображение': 'image',
+    'класс': 'class',
+    'роль': 'role',
+    'default-role (translation required)': 'default-role',
+    'титул': 'title',
+    'номер-раздела': 'sectnum',
+    'нумерация-разделов': 'sectnum',
+    'опасно': 'danger',
+    'осторожно': 'caution',
+    'ошибка': 'error',
+    'подсказка': 'tip',
+    'предупреждение': 'warning',
+    'примечание': 'note',
+    'рисунок': 'figure',
+    'рубрика': 'rubric',
+    'совет': 'hint',
+    'содержание': 'contents',
+    'тема': 'topic',
+    'эпиграф': 'epigraph',
+    'header (translation required)': 'header',
+    'footer (translation required)': 'footer',
+    }
 """Russian name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
- u'акроним': 'acronym',
- u'код': 'code',
- u'анонимная-ссылка': 'anonymous-reference',
- u'буквально': 'literal',
- u'математика': 'math',
- u'верхний-индекс': 'superscript',
- u'выделение': 'emphasis',
- u'именованная-ссылка': 'named-reference',
- u'индекс': 'index',
- u'нижний-индекс': 'subscript',
- u'сильное-выделение': 'strong',
- u'сокращение': 'abbreviation',
- u'ссылка-замена': 'substitution-reference',
- u'ссылка-на-pep': 'pep-reference',
- u'ссылка-на-rfc': 'rfc-reference',
- u'ссылка-на-uri': 'uri-reference',
- u'ссылка-на-заглавие': 'title-reference',
- u'ссылка-на-сноску': 'footnote-reference',
- u'цитатная-ссылка': 'citation-reference',
- u'цель': 'target',
- u'сырой': 'raw',}
+    'акроним': 'acronym',
+    'код': 'code',
+    'анонимная-ссылка': 'anonymous-reference',
+    'буквально': 'literal',
+    'математика': 'math',
+    'верхний-индекс': 'superscript',
+    'выделение': 'emphasis',
+    'именованная-ссылка': 'named-reference',
+    'индекс': 'index',
+    'нижний-индекс': 'subscript',
+    'сильное-выделение': 'strong',
+    'сокращение': 'abbreviation',
+    'ссылка-замена': 'substitution-reference',
+    'ссылка-на-pep': 'pep-reference',
+    'ссылка-на-rfc': 'rfc-reference',
+    'ссылка-на-uri': 'uri-reference',
+    'ссылка-на-заглавие': 'title-reference',
+    'ссылка-на-сноску': 'footnote-reference',
+    'цитатная-ссылка': 'citation-reference',
+    'цель': 'target',
+    'сырой': 'raw',
+    }
 """Mapping of Russian role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/sk.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/sk.py Changed

@@ -1,11 +1,11 @@
-# $Id: sk.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: sk.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Miroslav Vasko <zemiak@zoznam.sk>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Slovak-language mappings for language-dependent features of
@@ -16,80 +16,81 @@
 
 
 directives = {
-      u'pozor': 'attention',
-      u'opatrne': 'caution',
-      u'code (translation required)': 'code',
-      u'nebezpe\xe8enstvo': 'danger',
-      u'chyba': 'error',
-      u'rada': 'hint',
-      u'd\xf4le\x9eit\xe9': 'important',
-      u'pozn\xe1mka': 'note',
-      u'tip (translation required)': 'tip',
-      u'varovanie': 'warning',
-      u'admonition (translation required)': 'admonition',
-      u'sidebar (translation required)': 'sidebar',
-      u't\xe9ma': 'topic',
-      u'blok-riadkov': 'line-block',
-      u'parsed-literal': 'parsed-literal',
-      u'rubric (translation required)': 'rubric',
-      u'epigraph (translation required)': 'epigraph',
-      u'highlights (translation required)': 'highlights',
-      u'pull-quote (translation required)': 'pull-quote',
-      u'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #u'questions': 'questions',
-      #u'qa': 'questions',
-      #u'faq': 'questions',
-      u'table (translation required)': 'table',
-      u'csv-table (translation required)': 'csv-table',
-      u'list-table (translation required)': 'list-table',
-      u'meta': 'meta',
+      'pozor': 'attention',
+      'opatrne': 'caution',
+      'code (translation required)': 'code',
+      'nebezpe\xe8enstvo': 'danger',
+      'chyba': 'error',
+      'rada': 'hint',
+      'd\xf4le\x9eit\xe9': 'important',
+      'pozn\xe1mka': 'note',
+      'tip (translation required)': 'tip',
+      'varovanie': 'warning',
+      'admonition (translation required)': 'admonition',
+      'sidebar (translation required)': 'sidebar',
+      't\xe9ma': 'topic',
+      'blok-riadkov': 'line-block',
+      'parsed-literal': 'parsed-literal',
+      'rubric (translation required)': 'rubric',
+      'epigraph (translation required)': 'epigraph',
+      'highlights (translation required)': 'highlights',
+      'pull-quote (translation required)': 'pull-quote',
+      'compound (translation required)': 'compound',
+      'container (translation required)': 'container',
+      # 'questions': 'questions',
+      # 'qa': 'questions',
+      # 'faq': 'questions',
+      'table (translation required)': 'table',
+      'csv-table (translation required)': 'csv-table',
+      'list-table (translation required)': 'list-table',
+      'meta': 'meta',
       'math (translation required)': 'math',
-      #u'imagemap': 'imagemap',
-      u'obr\xe1zok': 'image',
-      u'tvar': 'figure',
-      u'vlo\x9ei\x9d': 'include',
-      u'raw (translation required)': 'raw',
-      u'nahradi\x9d': 'replace',
-      u'unicode': 'unicode',
-      u'd\u00E1tum': 'date',
-      u'class (translation required)': 'class',
-      u'role (translation required)': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
-      u'obsah': 'contents',
-      u'\xe8as\x9d': 'sectnum',
-      u'\xe8as\x9d-\xe8\xedslovanie': 'sectnum',
-      u'cie\xbeov\xe9-pozn\xe1mky': 'target-notes',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #u'footnotes': 'footnotes',
-      #u'citations': 'citations',
+      # 'imagemap': 'imagemap',
+      'obr\xe1zok': 'image',
+      'tvar': 'figure',
+      'vlo\x9ei\x9d': 'include',
+      'raw (translation required)': 'raw',
+      'nahradi\x9d': 'replace',
+      'unicode': 'unicode',
+      'd\u00E1tum': 'date',
+      'class (translation required)': 'class',
+      'role (translation required)': 'role',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
+      'obsah': 'contents',
+      '\xe8as\x9d': 'sectnum',
+      '\xe8as\x9d-\xe8\xedslovanie': 'sectnum',
+      'cie\xbeov\xe9-pozn\xe1mky': 'target-notes',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'footnotes': 'footnotes',
+      # 'citations': 'citations',
       }
 """Slovak name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
-      u'abbreviation (translation required)': 'abbreviation',
-      u'acronym (translation required)': 'acronym',
-      u'code (translation required)': 'code',
-      u'index (translation required)': 'index',
-      u'subscript (translation required)': 'subscript',
-      u'superscript (translation required)': 'superscript',
-      u'title-reference (translation required)': 'title-reference',
-      u'pep-reference (translation required)': 'pep-reference',
-      u'rfc-reference (translation required)': 'rfc-reference',
-      u'emphasis (translation required)': 'emphasis',
-      u'strong (translation required)': 'strong',
-      u'literal (translation required)': 'literal',
-    'math (translation required)': 'math',
-      u'named-reference (translation required)': 'named-reference',
-      u'anonymous-reference (translation required)': 'anonymous-reference',
-      u'footnote-reference (translation required)': 'footnote-reference',
-      u'citation-reference (translation required)': 'citation-reference',
-      u'substitution-reference (translation required)': 'substitution-reference',
-      u'target (translation required)': 'target',
-      u'uri-reference (translation required)': 'uri-reference',
-      u'raw (translation required)': 'raw',}
+      'abbreviation (translation required)': 'abbreviation',
+      'acronym (translation required)': 'acronym',
+      'code (translation required)': 'code',
+      'index (translation required)': 'index',
+      'subscript (translation required)': 'subscript',
+      'superscript (translation required)': 'superscript',
+      'title-reference (translation required)': 'title-reference',
+      'pep-reference (translation required)': 'pep-reference',
+      'rfc-reference (translation required)': 'rfc-reference',
+      'emphasis (translation required)': 'emphasis',
+      'strong (translation required)': 'strong',
+      'literal (translation required)': 'literal',
+      'math (translation required)': 'math',
+      'named-reference (translation required)': 'named-reference',
+      'anonymous-reference (translation required)': 'anonymous-reference',
+      'footnote-reference (translation required)': 'footnote-reference',
+      'citation-reference (translation required)': 'citation-reference',
+      'substitution-reference (translation required)': 'substitution-reference',  # noqa:E501
+      'target (translation required)': 'target',
+      'uri-reference (translation required)': 'uri-reference',
+      'raw (translation required)': 'raw',
+      }
 """Mapping of Slovak role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/sv.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/sv.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: sv.py 8012 2017-01-03 23:08:19Z milde $
+# $Id: sv.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Adam Chodorowski <chodorowski@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Swedish language mappings for language-dependent features of reStructuredText.
@@ -15,81 +14,83 @@
 __docformat__ = 'reStructuredText'
 
 directives = {
-      u'observera': 'attention',
-      u'akta': 'caution', # also 'försiktigt'
-      u'kod': 'code',
-      u'fara': 'danger',
-      u'fel': 'error',
-      u'vink': 'hint', # also 'hint'
-      u'viktigt': 'important',
-      u'notera': 'note',
-      u'tips': 'tip',
-      u'varning': 'warning',
-      u'anmärkning': 'admonition', # literal 'tillrättavisning', 'förmaning'
-      u'sidorad': 'sidebar',
-      u'ämne': 'topic',
-      u'tema': 'topic',
-      u'rad-block': 'line-block',
-      u'parsed-literal (translation required)': 'parsed-literal', # 'tolkad-bokstavlig'?
-      u'rubrik': 'rubric',
-      u'epigraf': 'epigraph',
-      u'höjdpunkter': 'highlights',
-      u'pull-quote (translation required)': 'pull-quote',
-      u'sammansatt': 'compound',
-      u'container': 'container',
-      # u'frågor': 'questions',
+      'observera': 'attention',
+      'akta': 'caution',  # also 'försiktigt'
+      'kod': 'code',
+      'fara': 'danger',
+      'fel': 'error',
+      'vink': 'hint',  # also 'hint'
+      'viktigt': 'important',
+      'notera': 'note',
+      'tips': 'tip',
+      'varning': 'warning',
+      'anmärkning': 'admonition',  # literal 'tillrättavisning', 'förmaning'
+      'sidorad': 'sidebar',
+      'ämne': 'topic',
+      'tema': 'topic',
+      'rad-block': 'line-block',
+      # 'tolkad-bokstavlig'?
+      'parsed-literal (translation required)': 'parsed-literal',
+      'rubrik': 'rubric',
+      'epigraf': 'epigraph',
+      'höjdpunkter': 'highlights',
+      'pull-quote (translation required)': 'pull-quote',
+      'sammansatt': 'compound',
+      'container': 'container',
+      # 'frågor': 'questions',
       # NOTE: A bit long, but recommended by http://www.nada.kth.se/dataterm/:
-      # u'frågor-och-svar': 'questions',
-      # u'vanliga-frågor': 'questions',
-      u'tabell': 'table',
-      u'csv-tabell': 'csv-table',
-      u'list-tabell': 'list-table',
-      u'meta': 'meta',
-      u'matematik': 'math',
-      # u'bildkarta': 'imagemap',   # FIXME: Translation might be too literal.
-      u'bild': 'image',
-      u'figur': 'figure',
-      u'inkludera': 'include',
-      u'rå': 'raw',
-      u'ersätta': 'replace',
-      u'unicode': 'unicode',
-      u'datum': 'date',
-      u'klass': 'class',
-      u'roll': 'role',
-      u'standardroll': 'default-role',
-      u'titel': 'title',
-      u'innehåll': 'contents',
-      u'sektionsnumrering': 'sectnum',
-      u'target-notes (translation required)': 'target-notes',
-      u'sidhuvud': 'header',
-      u'sidfot': 'footer',
-      # u'fotnoter': 'footnotes',
-      # u'citeringar': 'citations',
+      # 'frågor-och-svar': 'questions',
+      # 'vanliga-frågor': 'questions',
+      'tabell': 'table',
+      'csv-tabell': 'csv-table',
+      'list-tabell': 'list-table',
+      'meta': 'meta',
+      'matematik': 'math',
+      # 'bildkarta': 'imagemap',  # FIXME: Translation might be too literal.
+      'bild': 'image',
+      'figur': 'figure',
+      'inkludera': 'include',
+      'rå': 'raw',
+      'ersätta': 'replace',
+      'unicode': 'unicode',
+      'datum': 'date',
+      'klass': 'class',
+      'roll': 'role',
+      'standardroll': 'default-role',
+      'titel': 'title',
+      'innehåll': 'contents',
+      'sektionsnumrering': 'sectnum',
+      'target-notes (translation required)': 'target-notes',
+      'sidhuvud': 'header',
+      'sidfot': 'footer',
+      # 'fotnoter': 'footnotes',
+      # 'citeringar': 'citations',
       }
 """Swedish name to registered (in directives/__init__.py) directive name
 mapping."""
 
 roles = {
-      u'förkortning': 'abbreviation',
-      u'akronym': 'acronym',
-      u'kod': 'code',
-      u'index': 'index',
-      u'nedsänkt': 'subscript',
-      u'upphöjd': 'superscript',
-      u'titel-referens': 'title-reference',
-      u'pep-referens': 'pep-reference',
-      u'rfc-referens': 'rfc-reference',
-      u'betoning': 'emphasis',
-      u'stark': 'strong',
-      u'bokstavlig': 'literal', # also 'ordagranna'
-      u'matematik': 'math',
-      u'namngiven-referens': 'named-reference',
-      u'anonym-referens': 'anonymous-reference',
-      u'fotnot-referens': 'footnote-reference',
-      u'citat-referens': 'citation-reference',
-      u'ersättnings-referens': 'substitution-reference',
-      u'mål': 'target',
-      u'uri-referens': 'uri-reference',
-      u'rå': 'raw',}
+      'förkortning': 'abbreviation',
+      'akronym': 'acronym',
+      'kod': 'code',
+      'index': 'index',
+      'nedsänkt': 'subscript',
+      'upphöjd': 'superscript',
+      'titel-referens': 'title-reference',
+      'pep-referens': 'pep-reference',
+      'rfc-referens': 'rfc-reference',
+      'betoning': 'emphasis',
+      'stark': 'strong',
+      'bokstavlig': 'literal',  # also 'ordagranna'
+      'matematik': 'math',
+      'namngiven-referens': 'named-reference',
+      'anonym-referens': 'anonymous-reference',
+      'fotnot-referens': 'footnote-reference',
+      'citat-referens': 'citation-reference',
+      'ersättnings-referens': 'substitution-reference',
+      'mål': 'target',
+      'uri-referens': 'uri-reference',
+      'rå': 'raw',
+      }
 """Mapping of Swedish role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/uk.py Added

@@ -0,0 +1,91 @@
+# $Id: uk.py 9114 2022-07-28 17:06:10Z milde $
+# Author: Dmytro Kazanzhy <dkazanzhy@gmail.com>
+# Copyright: This module has been placed in the public domain.
+
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
+"""
+Ukrainian-language mappings for language-dependent features of
+reStructuredText.
+"""
+
+__docformat__ = 'reStructuredText'
+
+directives = {
+    'блок-строк': 'line-block',
+    'мета': 'meta',
+    'математика': 'math',
+    'оброблений-літерал': 'parsed-literal',
+    'виділена-цитата': 'pull-quote',
+    'код': 'code',
+    'складений абзац': 'compound',
+    'контейнер': 'container',
+    'таблиця': 'table',
+    'таблиця-csv': 'csv-table',
+    'таблиця-списків': 'list-table',
+    'сирий': 'raw',
+    'заміна': 'replace',
+    'тестова-директива-restructuredtext': 'restructuredtext-test-directive',
+    'цільові-виноски': 'target-notes',
+    'юнікод': 'unicode',
+    'дата': 'date',
+    'бічна-панель': 'sidebar',
+    'важливо': 'important',
+    'включати': 'include',
+    'увага': 'attention',
+    'виділення': 'highlights',
+    'зауваження': 'admonition',
+    'зображення': 'image',
+    'клас': 'class',
+    'роль': 'role',
+    'роль-за-замовчуванням': 'default-role',
+    'заголовок': 'title',
+    'номер-розділу': 'sectnum',
+    'нумерація-розділів': 'sectnum',
+    'небезпечно': 'danger',
+    'обережно': 'caution',
+    'помилка': 'error',
+    'підказка': 'tip',
+    'попередження': 'warning',
+    'примітка': 'note',
+    'малюнок': 'figure',
+    'рубрика': 'rubric',
+    'порада': 'hint',
+    'зміст': 'contents',
+    'тема': 'topic',
+    'епіграф': 'epigraph',
+    'верхній колонтитул': 'header',
+    'нижній колонтитул': 'footer',
+    }
+"""Ukrainian name to registered (in directives/__init__.py) directive name
+mapping."""
+
+roles = {
+    'акронім': 'acronym',
+    'код': 'code',
+    'анонімне-посилання': 'anonymous-reference',
+    'буквально': 'literal',
+    'математика': 'math',
+    'верхній-індекс': 'superscript',
+    'наголос': 'emphasis',
+    'іменоване-посилання': 'named-reference',
+    'індекс': 'index',
+    'нижній-індекс': 'subscript',
+    'жирне-накреслення': 'strong',
+    'скорочення': 'abbreviation',
+    'посилання-заміна': 'substitution-reference',
+    'посилання-на-pep': 'pep-reference',
+    'посилання-на-rfc': 'rfc-reference',
+    'посилання-на-uri': 'uri-reference',
+    'посилання-на-заголовок': 'title-reference',
+    'посилання-на-зноску': 'footnote-reference',
+    'посилання-на-цитату': 'citation-reference',
+    'ціль': 'target',
+    'сирий': 'raw',
+    }
+"""Mapping of Ukrainian role names to canonical role names
+for interpreted text.
+"""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/zh_cn.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/zh_cn.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: zh_cn.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: zh_cn.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Panjunyong <panjy@zopechina.com>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Simplified Chinese language mappings for language-dependent features of
@@ -18,87 +17,88 @@
 
 directives = {
       # language-dependent: fixed
-      u'注意': 'attention',
-      u'小心': 'caution',
-      u'code (translation required)': 'code',
-      u'危险': 'danger',
-      u'错误': 'error',
-      u'提示': 'hint',
-      u'重要': 'important',
-      u'注解': 'note',
-      u'技巧': 'tip',
-      u'警告': 'warning',
-      u'忠告': 'admonition',
-      u'侧框': 'sidebar',
-      u'主题': 'topic',
-      u'line-block (translation required)': 'line-block',
-      u'parsed-literal (translation required)': 'parsed-literal',
-      u'醒目': 'rubric',
-      u'铭文': 'epigraph',
-      u'要点': 'highlights',
-      u'pull-quote (translation required)': 'pull-quote',
-      u'复合': 'compound',
-      u'容器': 'container',
-      #u'questions (translation required)': 'questions',
-      u'表格': 'table',
-      u'csv表格': 'csv-table',
-      u'列表表格': 'list-table',
-      #u'qa (translation required)': 'questions',
-      #u'faq (translation required)': 'questions',
-      u'元数据': 'meta',
-      u'math (translation required)': 'math',
-      #u'imagemap (translation required)': 'imagemap',
-      u'图片': 'image',
-      u'图例': 'figure',
-      u'包含': 'include',
-      u'原文': 'raw',
-      u'代替': 'replace',
-      u'统一码': 'unicode',
-      u'日期': 'date',
-      u'类型': 'class',
-      u'角色': 'role',
-      u'默认角色': 'default-role',
-      u'标题': 'title',
-      u'目录': 'contents',
-      u'章节序号': 'sectnum',
-      u'题头': 'header',
-      u'页脚': 'footer',
-      #u'footnotes (translation required)': 'footnotes',
-      #u'citations (translation required)': 'citations',
-      u'target-notes (translation required)': 'target-notes',
-      u'restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      '注意': 'attention',
+      '小心': 'caution',
+      'code (translation required)': 'code',
+      '危险': 'danger',
+      '错误': 'error',
+      '提示': 'hint',
+      '重要': 'important',
+      '注解': 'note',
+      '技巧': 'tip',
+      '警告': 'warning',
+      '忠告': 'admonition',
+      '侧框': 'sidebar',
+      '主题': 'topic',
+      'line-block (translation required)': 'line-block',
+      'parsed-literal (translation required)': 'parsed-literal',
+      '醒目': 'rubric',
+      '铭文': 'epigraph',
+      '要点': 'highlights',
+      'pull-quote (translation required)': 'pull-quote',
+      '复合': 'compound',
+      '容器': 'container',
+      # 'questions (translation required)': 'questions',
+      '表格': 'table',
+      'csv表格': 'csv-table',
+      '列表表格': 'list-table',
+      # 'qa (translation required)': 'questions',
+      # 'faq (translation required)': 'questions',
+      '元数据': 'meta',
+      'math (translation required)': 'math',
+      # 'imagemap (translation required)': 'imagemap',
+      '图片': 'image',
+      '图例': 'figure',
+      '包含': 'include',
+      '原文': 'raw',
+      '代替': 'replace',
+      '统一码': 'unicode',
+      '日期': 'date',
+      '类型': 'class',
+      '角色': 'role',
+      '默认角色': 'default-role',
+      '标题': 'title',
+      '目录': 'contents',
+      '章节序号': 'sectnum',
+      '题头': 'header',
+      '页脚': 'footer',
+      # 'footnotes (translation required)': 'footnotes',
+      # 'citations (translation required)': 'citations',
+      'target-notes (translation required)': 'target-notes',
+      'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Simplified Chinese name to registered (in directives/__init__.py)
 directive name mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'缩写': 'abbreviation',
-    u'简称': 'acronym',
-    u'code (translation required)': 'code',
-    u'index (translation required)': 'index',
-    u'i (translation required)': 'index',
-    u'下标': 'subscript',
-    u'上标': 'superscript',
-    u'title-reference (translation required)': 'title-reference',
-    u'title (translation required)': 'title-reference',
-    u't (translation required)': 'title-reference',
-    u'pep-reference (translation required)': 'pep-reference',
-    u'pep (translation required)': 'pep-reference',
-    u'rfc-reference (translation required)': 'rfc-reference',
-    u'rfc (translation required)': 'rfc-reference',
-    u'强调': 'emphasis',
-    u'加粗': 'strong',
-    u'字面': 'literal',
-    u'math (translation required)': 'math',
-    u'named-reference (translation required)': 'named-reference',
-    u'anonymous-reference (translation required)': 'anonymous-reference',
-    u'footnote-reference (translation required)': 'footnote-reference',
-    u'citation-reference (translation required)': 'citation-reference',
-    u'substitution-reference (translation required)': 'substitution-reference',
-    u'target (translation required)': 'target',
-    u'uri-reference (translation required)': 'uri-reference',
-    u'uri (translation required)': 'uri-reference',
-    u'url (translation required)': 'uri-reference',
-    u'raw (translation required)': 'raw',}
+    '缩写': 'abbreviation',
+    '简称': 'acronym',
+    'code (translation required)': 'code',
+    'index (translation required)': 'index',
+    'i (translation required)': 'index',
+    '下标': 'subscript',
+    '上标': 'superscript',
+    'title-reference (translation required)': 'title-reference',
+    'title (translation required)': 'title-reference',
+    't (translation required)': 'title-reference',
+    'pep-reference (translation required)': 'pep-reference',
+    'pep (translation required)': 'pep-reference',
+    'rfc-reference (translation required)': 'rfc-reference',
+    'rfc (translation required)': 'rfc-reference',
+    '强调': 'emphasis',
+    '加粗': 'strong',
+    '字面': 'literal',
+    'math (translation required)': 'math',
+    'named-reference (translation required)': 'named-reference',
+    'anonymous-reference (translation required)': 'anonymous-reference',
+    'footnote-reference (translation required)': 'footnote-reference',
+    'citation-reference (translation required)': 'citation-reference',
+    'substitution-reference (translation required)': 'substitution-reference',
+    'target (translation required)': 'target',
+    'uri-reference (translation required)': 'uri-reference',
+    'uri (translation required)': 'uri-reference',
+    'url (translation required)': 'uri-reference',
+    'raw (translation required)': 'raw',
+    }
 """Mapping of Simplified Chinese role names to canonical role names
 for interpreted text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/languages/zh_tw.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/languages/zh_tw.py Changed

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
-# $Id: zh_tw.py 7119 2011-09-02 13:00:23Z milde $
+# $Id: zh_tw.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 Traditional Chinese language mappings for language-dependent features of
@@ -38,34 +37,34 @@
       'highlights (translation required)': 'highlights',
       'pull-quote (translation required)': 'pull-quote',
       'compound (translation required)': 'compound',
-      u'container (translation required)': 'container',
-      #'questions (translation required)': 'questions',
+      'container (translation required)': 'container',
+      # 'questions (translation required)': 'questions',
       'table (translation required)': 'table',
       'csv-table (translation required)': 'csv-table',
       'list-table (translation required)': 'list-table',
-      #'qa (translation required)': 'questions',
-      #'faq (translation required)': 'questions',
+      # 'qa (translation required)': 'questions',
+      # 'faq (translation required)': 'questions',
       'meta (translation required)': 'meta',
       'math (translation required)': 'math',
-      #'imagemap (translation required)': 'imagemap',
+      # 'imagemap (translation required)': 'imagemap',
       'image (translation required)': 'image',
       'figure (translation required)': 'figure',
       'include (translation required)': 'include',
       'raw (translation required)': 'raw',
       'replace (translation required)': 'replace',
       'unicode (translation required)': 'unicode',
-      u'日期': 'date',
+      '日期': 'date',
       'class (translation required)': 'class',
       'role (translation required)': 'role',
-      u'default-role (translation required)': 'default-role',
-      u'title (translation required)': 'title',
+      'default-role (translation required)': 'default-role',
+      'title (translation required)': 'title',
       'contents (translation required)': 'contents',
       'sectnum (translation required)': 'sectnum',
       'section-numbering (translation required)': 'sectnum',
-      u'header (translation required)': 'header',
-      u'footer (translation required)': 'footer',
-      #'footnotes (translation required)': 'footnotes',
-      #'citations (translation required)': 'citations',
+      'header (translation required)': 'header',
+      'footer (translation required)': 'footer',
+      # 'footnotes (translation required)': 'footnotes',
+      # 'citations (translation required)': 'citations',
       'target-notes (translation required)': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
 """Traditional Chinese name to registered (in directives/__init__.py)
@@ -77,7 +76,7 @@
     'ab (translation required)': 'abbreviation',
     'acronym (translation required)': 'acronym',
     'ac (translation required)': 'acronym',
-    u'code (translation required)': 'code',
+    'code (translation required)': 'code',
     'index (translation required)': 'index',
     'i (translation required)': 'index',
     'subscript (translation required)': 'subscript',
@@ -104,6 +103,7 @@
     'uri-reference (translation required)': 'uri-reference',
     'uri (translation required)': 'uri-reference',
     'url (translation required)': 'uri-reference',
-    'raw (translation required)': 'raw',}
+    'raw (translation required)': 'raw',
+    }
 """Mapping of Traditional Chinese role names to canonical role names for
 interpreted text."""

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/roles.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/roles.py Changed

@@ -1,16 +1,19 @@
-# $Id: roles.py 8571 2020-10-28 08:46:19Z milde $
+# $Id: roles.py 9037 2022-03-05 23:31:10Z milde $
 # Author: Edward Loper <edloper@gradient.cis.upenn.edu>
 # Copyright: This module has been placed in the public domain.
 
 """
 This module defines standard interpreted text role functions, a registry for
 interpreted text roles, and an API for adding to and retrieving from the
-registry.
+registry. See also `Creating reStructuredText Interpreted Text Roles`__.
+
+__ https://docutils.sourceforge.io/docs/ref/rst/roles.html
+
 
 The interface for interpreted role functions is as follows::
 
     def role_fn(name, rawtext, text, lineno, inliner,
-                options={}, content=):
+                options=None, content=None):
         code...
 
     # Set function attributes for customization:
@@ -29,7 +32,8 @@
 - ``text`` is the interpreted text content, with backslash escapes converted
   to nulls (``\x00``).
 
-- ``lineno`` is the line number where the interpreted text beings.
+- ``lineno`` is the line number where the text block containing the
+  interpreted text begins.
 
 - ``inliner`` is the Inliner object that called the role function.
   It defines the following useful attributes: ``reporter``,
@@ -72,31 +76,37 @@
 
 __docformat__ = 'reStructuredText'
 
-from docutils import nodes, utils
+
+from docutils import nodes
 from docutils.parsers.rst import directives
 from docutils.parsers.rst.languages import en as _fallback_language_module
 from docutils.utils.code_analyzer import Lexer, LexerError
 
 DEFAULT_INTERPRETED_ROLE = 'title-reference'
-"""
-The canonical name of the default interpreted role.  This role is used
-when no role is specified for a piece of interpreted text.
+"""The canonical name of the default interpreted role.
+
+This role is used when no role is specified for a piece of interpreted text.
 """
 
 _role_registry = {}
-"""Mapping of canonical role names to role functions.  Language-dependent role
-names are defined in the ``language`` subpackage."""
+"""Mapping of canonical role names to role functions.
+
+Language-dependent role names are defined in the ``language`` subpackage.
+"""
 
 _roles = {}
 """Mapping of local or language-dependent interpreted text role names to role
 functions."""
 
+
 def role(role_name, language_module, lineno, reporter):
     """
     Locate and return a role function from its language-dependent name, along
-    with a list of system messages.  If the role is not found in the current
-    language, check English.  Return a 2-tuple: role function (``None`` if the
-    named role cannot be found) and a list of system messages.
+    with a list of system messages.
+
+    If the role is not found in the current language, check English. Return a
+    2-tuple: role function (``None`` if the named role cannot be found) and a
+    list of system messages.
     """
     normname = role_name.lower()
     messages = 
@@ -140,8 +150,8 @@
         role_fn = _role_registrycanonicalname
         register_local_role(normname, role_fn)
         return role_fn, messages
-    else:
-        return None, messages # Error message will be generated by caller.
+    return None, messages  # Error message will be generated by caller.
+
 
 def register_canonical_role(name, role_fn):
     """
@@ -154,6 +164,7 @@
     set_implicit_options(role_fn)
     _role_registryname.lower() = role_fn
 
+
 def register_local_role(name, role_fn):
     """
     Register an interpreted text role by its local or language-dependent name.
@@ -165,6 +176,7 @@
     set_implicit_options(role_fn)
     _rolesname.lower() = role_fn
 
+
 def set_implicit_options(role_fn):
     """
     Add customization options to role functions, unless explicitly set or
@@ -175,17 +187,18 @@
     elif 'class' not in role_fn.options:
         role_fn.options'class' = directives.class_option
 
+
 def register_generic_role(canonical_name, node_class):
     """For roles which simply wrap a given `node_class` around the text."""
     role = GenericRole(canonical_name, node_class)
     register_canonical_role(canonical_name, role)
 
 
-class GenericRole(object):
-
+class GenericRole:
     """
-    Generic interpreted text role, where the interpreted text is simply
-    wrapped with the provided node class.
+    Generic interpreted text role.
+
+    The interpreted text is simply wrapped with the provided node class.
     """
 
     def __init__(self, role_name, node_class):
@@ -193,49 +206,47 @@
         self.node_class = node_class
 
     def __call__(self, role, rawtext, text, lineno, inliner,
-                 options={}, content=):
-        set_classes(options)
+                 options=None, content=None):
+        options = normalized_role_options(options)
         return self.node_class(rawtext, text, **options), 
 
 
-class CustomRole(object):
+class CustomRole:
+    """Wrapper for custom interpreted text roles."""
 
-    """
-    Wrapper for custom interpreted text roles.
-    """
-
-    def __init__(self, role_name, base_role, options={}, content=):
+    def __init__(self, role_name, base_role, options=None, content=None):
         self.name = role_name
         self.base_role = base_role
-        self.options = None
-        if hasattr(base_role, 'options'):
-            self.options = base_role.options
-        self.content = None
-        if hasattr(base_role, 'content'):
-            self.content = base_role.content
+        self.options = getattr(base_role, 'options', None)
+        self.content = getattr(base_role, 'content', None)
         self.supplied_options = options
         self.supplied_content = content
 
     def __call__(self, role, rawtext, text, lineno, inliner,
-                 options={}, content=):
-        opts = self.supplied_options.copy()
-        opts.update(options)
-        cont = list(self.supplied_content)
-        if cont and content:
-            cont += '\n'
-        cont.extend(content)
+                 options=None, content=None):
+        opts = normalized_role_options(self.supplied_options)
+        try:
+            opts.update(options)
+        except TypeError:  # options may be ``None``
+            pass
+        # pass concatenation of content from instance and call argument:
+        supplied_content = self.supplied_content or 
+        content = content or 
+        delimiter = '\n' if supplied_content and content else 
         return self.base_role(role, rawtext, text, lineno, inliner,
-                              options=opts, content=cont)
+                              options=opts,
+                              content=supplied_content+delimiter+content)
 
 
 def generic_custom_role(role, rawtext, text, lineno, inliner,
-                        options={}, content=):
-    """"""
+                        options=None, content=None):
+    """Base for custom roles if no other base role is specified."""
     # Once nested inline markup is implemented, this and other methods should
     # recursively call inliner.nested_parse().
-    set_classes(options)
+    options = normalized_role_options(options)
     return nodes.inline(rawtext, text, **options), 
 
+
 generic_custom_role.options = {'class': directives.class_option}
 
 
@@ -252,10 +263,12 @@
 register_generic_role('superscript', nodes.superscript)
 register_generic_role('title-reference', nodes.title_reference)
 
+
 def pep_reference_role(role, rawtext, text, lineno, inliner,
-                       options={}, content=):
+                       options=None, content=None):
+    options = normalized_role_options(options)
     try:
-        pepnum = int(utils.unescape(text))
+        pepnum = int(nodes.unescape(text))
         if pepnum < 0 or pepnum > 9999:
             raise ValueError
     except ValueError:
@@ -267,19 +280,20 @@
     # Base URL mainly used by inliner.pep_reference; so this is correct:
     ref = (inliner.document.settings.pep_base_url
            + inliner.document.settings.pep_file_url_template % pepnum)
-    set_classes(options)
-    return nodes.reference(rawtext, 'PEP ' + text, refuri=ref,
-                            **options), 
+    return nodes.reference(rawtext, 'PEP ' + text, refuri=ref, **options), 
+
 
 register_canonical_role('pep-reference', pep_reference_role)
 
+
 def rfc_reference_role(role, rawtext, text, lineno, inliner,
-                       options={}, content=):
+                       options=None, content=None):
+    options = normalized_role_options(options)
+    if "#" in text:
+        rfcnum, section = nodes.unescape(text).split("#", 1)
+    else:
+        rfcnum, section = nodes.unescape(text), None
     try:
-        if "#" in text:
-            rfcnum, section = utils.unescape(text).split("#", 1)
-        else:
-            rfcnum, section  = utils.unescape(text), None
         rfcnum = int(rfcnum)
         if rfcnum < 1:
             raise ValueError
@@ -292,15 +306,16 @@
     # Base URL mainly used by inliner.rfc_reference, so this is correct:
     ref = inliner.document.settings.rfc_base_url + inliner.rfc_url % rfcnum
     if section is not None:
-        ref += "#"+section
-    set_classes(options)
-    node = nodes.reference(rawtext, 'RFC ' + str(rfcnum), refuri=ref,
-                           **options)
+        ref += "#" + section
+    node = nodes.reference(rawtext, 'RFC '+str(rfcnum), refuri=ref, **options)
     return node, 
 
+
 register_canonical_role('rfc-reference', rfc_reference_role)
 
-def raw_role(role, rawtext, text, lineno, inliner, options={}, content=):
+
+def raw_role(role, rawtext, text, lineno, inliner, options=None, content=None):
+    options = normalized_role_options(options)
     if not inliner.document.settings.raw_enabled:
         msg = inliner.reporter.warning('raw (and derived) roles disabled')
         prb = inliner.problematic(rawtext, rawtext, msg)
@@ -313,17 +328,19 @@
             'an associated format.' % role, line=lineno)
         prb = inliner.problematic(rawtext, rawtext, msg)
         return prb, msg
-    set_classes(options)
-    node = nodes.raw(rawtext, utils.unescape(text, True), **options)
+    node = nodes.raw(rawtext, nodes.unescape(text, True), **options)
     node.source, node.line = inliner.reporter.get_source_and_line(lineno)
     return node, 
 
+
 raw_role.options = {'format': directives.unchanged}
 
 register_canonical_role('raw', raw_role)
 
-def code_role(role, rawtext, text, lineno, inliner, options={}, content=):
-    set_classes(options)
+
+def code_role(role, rawtext, text, lineno, inliner,
+              options=None, content=None):
+    options = normalized_role_options(options)
     language = options.get('language', '')
     classes = 'code'
     if 'classes' in options:
@@ -331,7 +348,7 @@
     if language and language not in classes:
         classes.append(language)
     try:
-        tokens = Lexer(utils.unescape(text, True), language,
+        tokens = Lexer(nodes.unescape(text, True), language,
                        inliner.document.settings.syntax_highlight)
     except LexerError as error:
         msg = inliner.reporter.warning(error)
@@ -346,34 +363,39 @@
             node += nodes.inline(value, value, classes=classes)
         else:
             # insert as Text to decrease the verbosity of the output
-            node += nodes.Text(value, value)
+            node += nodes.Text(value)
 
     return node, 
 
-code_role.options = {'class': directives.class_option,
-                     'language': directives.unchanged}
+
+code_role.options = {'language': directives.unchanged}
 
 register_canonical_role('code', code_role)
 
-def math_role(role, rawtext, text, lineno, inliner, options={}, content=):
-    set_classes(options)
-    i = rawtext.find('`')
-    text = rawtext.split('`')1
+
+def math_role(role, rawtext, text, lineno, inliner,
+              options=None, content=None):
+    options = normalized_role_options(options)
+    text = nodes.unescape(text, True)  # raw text without inline role markup
     node = nodes.math(rawtext, text, **options)
     return node, 
 
+
 register_canonical_role('math', math_role)
 
+
 ######################################################################
 # Register roles that are currently unimplemented.
 ######################################################################
 
-def unimplemented_role(role, rawtext, text, lineno, inliner, attributes={}):
+def unimplemented_role(role, rawtext, text, lineno, inliner,
+                       options=None, content=None):
     msg = inliner.reporter.error(
         'Interpreted text role "%s" not implemented.' % role, line=lineno)
     prb = inliner.problematic(rawtext, rawtext, msg)
     return prb, msg
 
+
 register_canonical_role('index', unimplemented_role)
 register_canonical_role('named-reference', unimplemented_role)
 register_canonical_role('anonymous-reference', unimplemented_role)
@@ -389,11 +411,29 @@
 
 
 def set_classes(options):
-    """
-    Auxiliary function to set options'classes' and delete
-    options'class'.
-    """
-    if 'class' in options:
+    """Deprecated. Obsoleted by ``normalized_role_options()``."""
+    # TODO: Change use in directives.py and uncomment.
+    # warnings.warn('The auxiliary function roles.set_classes() is obsoleted'
+    #     ' by roles.normalized_role_options() and will be removed'
+    #     ' in Docutils 0.21 or later', DeprecationWarning, stacklevel=2)
+    if options and 'class' in options:
         assert 'classes' not in options
         options'classes' = options'class'
         del options'class'
+
+
+def normalized_role_options(options):
+    """
+    Return normalized dictionary of role options.
+
+    * ``None`` is replaced by an empty dictionary.
+    * The key 'class' is renamed to 'classes'.
+    """
+    if options is None:
+        return {}
+    result = options.copy()
+    if 'class' in result:
+        assert 'classes' not in result
+        result'classes' = result'class'
+        del result'class'
+    return result

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/states.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/states.py Changed

@@ -1,4 +1,4 @@
-# $Id: states.py 8587 2020-12-09 15:33:58Z milde $
+# $Id: states.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -103,7 +103,6 @@
 __docformat__ = 'reStructuredText'
 
 
-import sys
 import re
 from types import FunctionType, MethodType
 
@@ -111,14 +110,14 @@
 from docutils import ApplicationError, DataError
 from docutils.statemachine import StateMachineWS, StateWS
 from docutils.nodes import fully_normalize_name as normalize_name
-from docutils.nodes import whitespace_normalize_name
+from docutils.nodes import unescape, whitespace_normalize_name
 import docutils.parsers.rst
 from docutils.parsers.rst import directives, languages, tableparser, roles
-from docutils.parsers.rst.languages import en as _fallback_language_module
-from docutils.utils import escape2null, unescape, column_width
+from docutils.utils import escape2null, column_width
 from docutils.utils import punctuation_chars, roman, urischemes
 from docutils.utils import split_escaped_whitespace
 
+
 class MarkupError(DataError): pass
 class UnknownInterpretedRoleError(DataError): pass
 class InterpretedRoleNotImplementedError(DataError): pass
@@ -126,7 +125,7 @@
 class MarkupMismatch(Exception): pass
 
 
-class Struct(object):
+class Struct:
 
     """Stores data attributes for dotted-attribute access."""
 
@@ -225,8 +224,7 @@
         self.parent = self.state_machine.node
         # enable the reporter to determine source and source-line
         if not hasattr(self.reporter, 'get_source_and_line'):
-            self.reporter.get_source_and_line = self.state_machine.get_source_and_line
-
+            self.reporter.get_source_and_line = self.state_machine.get_source_and_line  # noqa:E501
 
     def goto_line(self, abs_line_offset):
         """
@@ -328,7 +326,7 @@
 
     def check_subsection(self, source, style, lineno):
         """
-        Check for a valid subsection header.  Return 1 (true) or None (false).
+        Check for a valid subsection header.  Return True or False.
 
         When a new section is reached that isn't a subsection of the current
         section, back up the line count (use ``previous_line(-x)``), then
@@ -348,12 +346,12 @@
         try:                            # check for existing title style
             level = title_styles.index(style) + 1
         except ValueError:              # new title style
-            if len(title_styles) == memo.section_level: # new subsection
+            if len(title_styles) == memo.section_level:  # new subsection
                 title_styles.append(style)
-                return 1
+                return True
             else:                       # not at lowest level
                 self.parent += self.title_inconsistent(source, lineno)
-                return None
+                return False
         if level <= mylevel:            # sibling or supersection
             memo.section_level = level   # bubble up to parent section
             if len(style) == 2:
@@ -362,10 +360,10 @@
             self.state_machine.previous_line(len(style) + 1)
             raise EOFError              # let parent section re-evaluate
         if level == mylevel + 1:        # immediate subsection
-            return 1
+            return True
         else:                           # invalid subsection
             self.parent += self.title_inconsistent(source, lineno)
-            return None
+            return False
 
     def title_inconsistent(self, sourcetext, lineno):
         error = self.reporter.severe(
@@ -394,8 +392,8 @@
               self.state_machine.input_linesoffset:, input_offset=absoffset,
               node=section_node, match_titles=True)
         self.goto_line(newabsoffset)
-        if memo.section_level <= mylevel: # can't handle next section?
-            raise EOFError              # bubble up to supersection
+        if memo.section_level <= mylevel:  # can't handle next section?
+            raise EOFError                 # bubble up to supersection
         # reset section_level; next pass will detect it properly
         memo.section_level = mylevel
 
@@ -430,7 +428,7 @@
 
     def unindent_warning(self, node_name):
         # the actual problem is one line below the current line
-        lineno = self.state_machine.abs_line_number()+1
+        lineno = self.state_machine.abs_line_number() + 1
         return self.reporter.warning('%s ends without a blank line; '
                                      'unexpected unindent.' % node_name,
                                      line=lineno)
@@ -454,12 +452,12 @@
     or_group = '|'.join(part_strings)
     regexp = '%(prefix)s(?P<%(name)s>%(or_group)s)%(suffix)s' % locals()
     if compile:
-        return re.compile(regexp, re.UNICODE)
+        return re.compile(regexp)
     else:
         return regexp
 
 
-class Inliner(object):
+class Inliner:
 
     """
     Parse inline markup; call the `parse()` method.
@@ -473,13 +471,13 @@
     def init_customizations(self, settings):
         # lookahead and look-behind expressions for inline markup rules
         if getattr(settings, 'character_level_inline_markup', False):
-            start_string_prefix = u'(^|(?<!\x00))'
-            end_string_suffix = u''
+            start_string_prefix = '(^|(?<!\x00))'
+            end_string_suffix = ''
         else:
-            start_string_prefix = (u'(^|(?<=\\s|%s%s))' %
+            start_string_prefix = ('(^|(?<=\\s|%s%s))' %
                                    (punctuation_chars.openers,
                                     punctuation_chars.delimiters))
-            end_string_suffix = (u'($|(?=\\s|\x00%s%s%s))' %
+            end_string_suffix = ('($|(?=\\s|\x00%s%s%s))' %
                                  (punctuation_chars.closing_delimiters,
                                   punctuation_chars.delimiters,
                                   punctuation_chars.closers))
@@ -487,31 +485,33 @@
         args.update(vars(self.__class__))
 
         parts = ('initial_inline', start_string_prefix, '',
-           ('start', '', self.non_whitespace_after, # simple start-strings
+           
+            ('start', '', self.non_whitespace_after,  # simple start-strings
              r'\*\*',                # strong
               r'\*(?!\*)',            # emphasis but not strong
               r'``',                  # literal
               r'_`',                  # inline internal target
               r'\|(?!\|)'            # substitution reference
              ),
-            ('whole', '', end_string_suffix, # whole constructs
-             # reference name & end-string
+            ('whole', '', end_string_suffix,  # whole constructs
+               # reference name & end-string
               r'(?P<refname>%s)(?P<refend>__?)' % self.simplename,
               ('footnotelabel', r'\', r'(?P<fnend>\_)',
-               r'0-9+',               # manually numbered
-                r'\#(%s)?' % self.simplename, # auto-numbered (w/ label?)
-                r'\*',                   # auto-symbol
-                r'(?P<citationlabel>%s)' % self.simplename # citation reference
+               r'0-9+',                     # manually numbered
+                r'\#(%s)?' % self.simplename,  # auto-numbered (w/ label?)
+                r'\*',                         # auto-symbol
+                r'(?P<citationlabel>%s)' % self.simplename,  # citation ref
+                
                )
               
              ),
             ('backquote',             # interpreted text or phrase reference
-             '(?P<role>(:%s:)?)' % self.simplename, # optional role
+             '(?P<role>(:%s:)?)' % self.simplename,  # optional role
              self.non_whitespace_after,
              '`(?!`)'               # but not literal
              )
             
-           )
+        )
         self.start_string_prefix = start_string_prefix
         self.end_string_suffix = end_string_suffix
         self.parts = parts
@@ -519,9 +519,9 @@
         self.patterns = Struct(
           initial=build_regexp(parts),
           emphasis=re.compile(self.non_whitespace_escape_before
-                              + r'(\*)' + end_string_suffix, re.UNICODE),
+                              + r'(\*)' + end_string_suffix),
           strong=re.compile(self.non_whitespace_escape_before
-                            + r'(\*\*)' + end_string_suffix, re.UNICODE),
+                            + r'(\*\*)' + end_string_suffix),
           interpreted_or_phrase_ref=re.compile(
               r"""
               %(non_unescaped_whitespace_escape_before)s
@@ -533,7 +533,7 @@
                 )
               )
               %(end_string_suffix)s
-              """ % args, re.VERBOSE | re.UNICODE),
+              """ % args, re.VERBOSE),
           embedded_link=re.compile(
               r"""
               (
@@ -545,16 +545,16 @@
                 >                       # close bracket
               )
               $                         # end of string
-              """ % args, re.VERBOSE | re.UNICODE),
+              """ % args, re.VERBOSE),
           literal=re.compile(self.non_whitespace_before + '(``)'
-                             + end_string_suffix, re.UNICODE),
+                             + end_string_suffix),
           target=re.compile(self.non_whitespace_escape_before
-                            + r'(`)' + end_string_suffix, re.UNICODE),
+                            + r'(`)' + end_string_suffix),
           substitution_ref=re.compile(self.non_whitespace_escape_before
                                       + r'(\|_{0,2})'
-                                      + end_string_suffix, re.UNICODE),
+                                      + end_string_suffix),
           email=re.compile(self.email_pattern % args + '$',
-                           re.VERBOSE | re.UNICODE),
+                           re.VERBOSE),
           uri=re.compile(
                 (r"""
                 %(start_string_prefix)s
@@ -586,7 +586,7 @@
                   )
                 )
                 %(end_string_suffix)s
-                """) % args, re.VERBOSE | re.UNICODE),
+                """) % args, re.VERBOSE),
           pep=re.compile(
                 r"""
                 %(start_string_prefix)s
@@ -595,12 +595,12 @@
                 |
                   (PEP\s+(?P<pepnum2>\d+))      # reference by name
                 )
-                %(end_string_suffix)s""" % args, re.VERBOSE | re.UNICODE),
+                %(end_string_suffix)s""" % args, re.VERBOSE),
           rfc=re.compile(
                 r"""
                 %(start_string_prefix)s
                 (RFC(-|\s+)?(?P<rfcnum>\d+))
-                %(end_string_suffix)s""" % args, re.VERBOSE | re.UNICODE))
+                %(end_string_suffix)s""" % args, re.VERBOSE))
 
         self.implicit_dispatch.append((self.patterns.uri,
                                        self.standalone_uri))
@@ -626,6 +626,9 @@
         check it for validity.  If not found or invalid, generate a warning
         and ignore the start-string.  Implicit inline markup (e.g. standalone
         URIs) is found last.
+
+        :text: source string
+        :lineno: absolute line number (cf. statemachine.get_source_and_line())
         """
         self.reporter = memo.reporter
         self.document = memo.document
@@ -710,7 +713,7 @@
         matchstart = match.start('start')
         matchend = match.end('start')
         if self.quoted_start(match):
-            return (string:matchend, , stringmatchend:, , '')
+            return string:matchend, , stringmatchend:, , ''
         endmatch = end_pattern.search(stringmatchend:)
         if endmatch and endmatch.start(1):  # 1 or more chars
             text = endmatch.string:endmatch.start(1)
@@ -757,7 +760,7 @@
             role = role1:-1
             position = 'prefix'
         elif self.quoted_start(match):
-            return (string:matchend, , stringmatchend:, )
+            return string:matchend, , stringmatchend:, 
         endmatch = end_pattern.search(stringmatchend:)
         if endmatch and endmatch.start(1):  # 1 or more chars
             textend = matchend + endmatch.end()
@@ -800,15 +803,16 @@
     def phrase_ref(self, before, after, rawsource, escaped, text=None):
         # `text` is ignored (since 0.16)
         match = self.patterns.embedded_link.search(escaped)
-        if match: # embedded <URI> or <alias_>
+        if match:  # embedded <URI> or <alias_>
             text = escaped:match.start(0)
             unescaped = unescape(text)
             rawtext = unescape(text, True)
             aliastext = match.group(2)
             rawaliastext = unescape(aliastext, True)
             underscore_escaped = rawaliastext.endswith(r'\_')
-            if aliastext.endswith('_') and not (underscore_escaped
-                                        or self.patterns.uri.match(aliastext)):
+            if (aliastext.endswith('_')
+                and not (underscore_escaped
+                         or self.patterns.uri.match(aliastext))):
                 aliastype = 'name'
                 alias = normalize_name(unescape(aliastext:-1))
                 target = nodes.target(match.group(1), refname=alias)
@@ -846,7 +850,7 @@
         node_list = reference
 
         if rawsource-2: == '__':
-            if  target and (aliastype == 'name'):
+            if target and (aliastype == 'name'):
                 reference'refname' = alias
                 self.document.note_refname(reference)
                 # self.document.note_indirect_target(target) # required?
@@ -871,7 +875,6 @@
                 self.document.note_refname(reference)
         return before, node_list, after, 
 
-
     def adjust_uri(self, uri):
         match = self.patterns.email.match(uri)
         if match:
@@ -963,7 +966,7 @@
                 self.document.note_footnote_ref(refnode)
             if utils.get_trim_footnote_ref_space(self.document.settings):
                 before = before.rstrip()
-        return (before, refnode, remaining, )
+        return before, refnode, remaining, 
 
     def reference(self, match, lineno, anonymous=False):
         referencename = match.group('refname')
@@ -980,10 +983,10 @@
         string = match.string
         matchstart = match.start('whole')
         matchend = match.end('whole')
-        return (string:matchstart, referencenode, stringmatchend:, )
+        return string:matchstart, referencenode, stringmatchend:, 
 
     def anonymous_reference(self, match, lineno):
-        return self.reference(match, lineno, anonymous=1)
+        return self.reference(match, lineno, anonymous=True)
 
     def standalone_uri(self, match, lineno):
         if (not match.group('scheme')
@@ -1039,11 +1042,11 @@
                     # Must recurse on strings before *and* after the match;
                     # there may be multiple patterns.
                     return (self.implicit_inline(text:match.start(), lineno)
-                            + method(match, lineno) +
-                            self.implicit_inline(textmatch.end():, lineno))
+                            + method(match, lineno)
+                            + self.implicit_inline(textmatch.end():, lineno))
                 except MarkupMismatch:
                     pass
-        return nodes.Text(text, unescape(text, True))
+        return nodes.Text(text)
 
     dispatch = {'*': emphasis,
                 '**': strong,
@@ -1059,9 +1062,11 @@
 def _loweralpha_to_int(s, _zero=(ord('a')-1)):
     return ord(s) - _zero
 
+
 def _upperalpha_to_int(s, _zero=(ord('A')-1)):
     return ord(s) - _zero
 
+
 def _lowerroman_to_int(s):
     return roman.fromRoman(s.upper())
 
@@ -1084,12 +1089,12 @@
           'period': Struct(prefix='', suffix='.', start=0, end=-1)}
     enum.formats = enum.formatinfo.keys()
     enum.sequences = 'arabic', 'loweralpha', 'upperalpha',
-                      'lowerroman', 'upperroman' # ORDERED!
+                      'lowerroman', 'upperroman'  # ORDERED!
     enum.sequencepats = {'arabic': '0-9+',
                          'loweralpha': 'a-z',
                          'upperalpha': 'A-Z',
                          'lowerroman': 'ivxlcdm+',
-                         'upperroman': 'IVXLCDM+',}
+                         'upperroman': 'IVXLCDM+'}
     enum.converters = {'arabic': int,
                        'loweralpha': _loweralpha_to_int,
                        'upperalpha': _upperalpha_to_int,
@@ -1099,7 +1104,7 @@
     enum.sequenceregexps = {}
     for sequence in enum.sequences:
         enum.sequenceregexpssequence = re.compile(
-              enum.sequencepatssequence + '$', re.UNICODE)
+              enum.sequencepatssequence + '$')
 
     grid_table_top_pat = re.compile(r'\+--++-\+ *$')
     """Matches the top (& bottom) of a full table)."""
@@ -1132,7 +1137,7 @@
               pats'enum', re.escape(enum.formatinfoformat.suffix))
 
     patterns = {
-          'bullet': u'-+*\u2022\u2023\u2043( +|$)',
+          'bullet': '-+*\u2022\u2023\u2043( +|$)',
           'enumerator': r'(%(parens)s|%(rparen)s|%(period)s)( +|$)' % pats,
           'field_marker': r':(?!: )(^:\\|\\.|:(?!( `|$)))*(?<! ):( +|$)',
           'option_marker': r'%(option)s(, %(option)s)*(  +| ?$)' % pats,
@@ -1160,8 +1165,8 @@
 
     def indent(self, match, context, next_state):
         """Block quote."""
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_indented()
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_indented()
         elements = self.block_quote(indented, line_offset)
         self.parent += elements
         if not blank_finish:
@@ -1171,17 +1176,19 @@
     def block_quote(self, indented, line_offset):
         elements = 
         while indented:
+            blockquote = nodes.block_quote(rawsource='\n'.join(indented))
+            (blockquote.source, blockquote.line
+             ) = self.state_machine.get_source_and_line(line_offset+1)
             (blockquote_lines,
              attribution_lines,
              attribution_offset,
              indented,
              new_line_offset) = self.split_attribution(indented, line_offset)
-            blockquote = nodes.block_quote()
             self.nested_parse(blockquote_lines, line_offset, blockquote)
             elements.append(blockquote)
             if attribution_lines:
                 attribution, messages = self.parse_attribution(
-                    attribution_lines, attribution_offset)
+                    attribution_lines, line_offset+attribution_offset)
                 blockquote += attribution
                 elements += messages
             line_offset = new_line_offset
@@ -1191,8 +1198,7 @@
         return elements
 
     # U+2014 is an em-dash:
-    attribution_pattern = re.compile(u'(---?(?!-)|\u2014) *(?=^ \\n)',
-                                     re.UNICODE)
+    attribution_pattern = re.compile('(---?(?!-)|\u2014) *(?=^ \\n)')
 
     def split_attribution(self, indented, line_offset):
         """
@@ -1203,15 +1209,15 @@
         * Every line after that must have consistent indentation.
         * Attributions must be preceded by block quote content.
 
-        Return a tuple of: (block quote content lines, content offset,
-        attribution lines, attribution offset, remaining indented lines).
+        Return a tuple of: (block quote content lines, attribution lines,
+        attribution offset, remaining indented lines, remaining lines offset).
         """
         blank = None
         nonblank_seen = False
         for i in range(len(indented)):
             line = indentedi.rstrip()
             if line:
-                if nonblank_seen and blank == i - 1: # last line blank
+                if nonblank_seen and blank == i - 1:  # last line blank
                     match = self.attribution_pattern.match(line)
                     if match:
                         attribution_end, indent = self.check_attribution(
@@ -1227,7 +1233,7 @@
             else:
                 blank = i
         else:
-            return (indented, None, None, None, None)
+            return indented, None, None, None, None
 
     def check_attribution(self, indented, attribution_start):
         """
@@ -1251,7 +1257,7 @@
 
     def parse_attribution(self, indented, line_offset):
         text = '\n'.join(indented).rstrip()
-        lineno = self.state_machine.abs_line_number() + line_offset
+        lineno = 1 + line_offset  # line_offset is zero-based
         textnodes, messages = self.inline_text(text, lineno)
         node = nodes.attribution(text, '', *textnodes)
         node.source, node.line = self.state_machine.get_source_and_line(lineno)
@@ -1350,8 +1356,8 @@
                 break                   # yes; keep `format`
         else:                           # shouldn't happen
             raise ParserError('enumerator format not matched')
-        text = groupdictformatself.enum.formatinfoformat.start
-                                 :self.enum.formatinfoformat.end
+        text = groupdictformatself.enum.formatinfoformat.start     # noqa: E203,E501
+                                 : self.enum.formatinfoformat.end
         if text == '#':
             sequence = '#'
         elif expected_sequence:
@@ -1402,8 +1408,8 @@
         if result:
             next_enumerator, auto_enumerator = result
             try:
-                if ( next_line.startswith(next_enumerator) or
-                     next_line.startswith(auto_enumerator) ):
+                if (next_line.startswith(next_enumerator)
+                    or next_line.startswith(auto_enumerator)):
                     return 1
             except TypeError:
                 pass
@@ -1415,7 +1421,7 @@
         auto-enumerator ("#" instead of the regular enumerator).
 
         Return ``None`` for invalid (out of range) ordinals.
-        """ #"
+        """
         if sequence == '#':
             enumerator = '#'
         elif sequence == 'arabic':
@@ -1467,8 +1473,8 @@
         name = self.parse_field_marker(match)
         src, srcline = self.state_machine.get_source_and_line()
         lineno = self.state_machine.abs_line_number()
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         field_node = nodes.field()
         field_node.source = src
         field_node.line = srcline
@@ -1482,8 +1488,8 @@
 
     def parse_field_marker(self, match):
         """Extract & return field name from a field marker match."""
-        field = match.group()1:        # strip off leading ':'
-        field = field:field.rfind(':') # strip off trailing ':' etc.
+        field = match.group()1:         # strip off leading ':'
+        field = field:field.rfind(':')  # strip off trailing ':' etc.
         return field
 
     def parse_field_body(self, indented, offset, node):
@@ -1492,16 +1498,17 @@
     def option_marker(self, match, context, next_state):
         """Option list item."""
         optionlist = nodes.option_list()
-        (optionlist.source, optionlist.line) = self.state_machine.get_source_and_line()
+        (optionlist.source, optionlist.line
+         ) = self.state_machine.get_source_and_line()
         try:
             listitem, blank_finish = self.option_list_item(match)
         except MarkupError as error:
             # This shouldn't happen; pattern won't match.
-            msg = self.reporter.error(u'Invalid option list marker: %s' %
-                                      error)
+            msg = self.reporter.error('Invalid option list marker: %s'
+                                      % error)
             self.parent += msg
-            indented, indent, line_offset, blank_finish = \
-                  self.state_machine.get_first_known_indented(match.end())
+            (indented, indent, line_offset, blank_finish
+             ) = self.state_machine.get_first_known_indented(match.end())
             elements = self.block_quote(indented, line_offset)
             self.parent += elements
             if not blank_finish:
@@ -1523,8 +1530,8 @@
     def option_list_item(self, match):
         offset = self.state_machine.abs_line_offset()
         options = self.parse_option_marker(match)
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         if not indented:                # not an option list item
             self.goto_line(offset)
             raise statemachine.TransitionCorrection('text')
@@ -1614,13 +1621,13 @@
 
     def line_block_line(self, match, lineno):
         """Return one line element of a line_block."""
-        indented, indent, line_offset, blank_finish = \
-            self.state_machine.get_first_known_indented(match.end(),
-                                                        until_blank=True)
-        text = u'\n'.join(indented)
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end(),
+                                                         until_blank=True)
+        text = '\n'.join(indented)
         text_nodes, messages = self.inline_text(text, lineno)
         line = nodes.line(text, '', *text_nodes)
-        if match.string.rstrip() != '|': # not empty
+        if match.string.rstrip() != '|':  # not empty
             line.indent = len(match.group(1)) - 1
         return line, messages, blank_finish
 
@@ -1707,12 +1714,12 @@
         width = len(block0.strip())
         for i in range(len(block)):
             blocki = blocki.strip()
-            if blocki0 not in '+|': # check left edge
+            if blocki0 not in '+|':  # check left edge
                 blank_finish = 0
                 self.state_machine.previous_line(len(block) - i)
                 del blocki:
                 break
-        if not self.grid_table_top_pat.match(block-1): # find bottom
+        if not self.grid_table_top_pat.match(block-1):  # find bottom
             blank_finish = 0
             # from second-last to third line of table:
             for i in range(len(block) - 2, 1, -1):
@@ -1788,7 +1795,7 @@
         table = nodes.table()
         if widths == 'auto':
             table'classes' += 'colwidths-auto'
-        elif widths: # "grid" or list of integers
+        elif widths:  # "grid" or list of integers
             table'classes' += 'colwidths-given'
         tgroup = nodes.tgroup(cols=len(colwidths))
         table += tgroup
@@ -1827,7 +1834,6 @@
                                   node=entry)
         return row
 
-
     explicit = Struct()
     """Patterns and constants used for explicit markup recognition."""
 
@@ -1851,7 +1857,7 @@
                              ?            # optional space
                             :               # end of reference name
                             ( +|$)        # followed by whitespace
-                            """ % vars(Inliner), re.VERBOSE | re.UNICODE),
+                            """ % vars(Inliner), re.VERBOSE),
           reference=re.compile(r"""
                                (
                                  (?P<simple>%(simplename)s)_
@@ -1864,7 +1870,7 @@
                                                     # reference mark
                                )
                                $                  # end of string
-                               """ % vars(Inliner), re.VERBOSE | re.UNICODE),
+                               """ % vars(Inliner), re.VERBOSE),
           substitution=re.compile(r"""
                                   (
                                     (?! )          # first char. not space
@@ -1874,12 +1880,12 @@
                                   )
                                   ( +|$)           # followed by whitespace
                                   """ % vars(Inliner),
-                                  re.VERBOSE | re.UNICODE),)
+                                  re.VERBOSE),)
 
     def footnote(self, match):
         src, srcline = self.state_machine.get_source_and_line()
-        indented, indent, offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        (indented, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         label = match.group(1)
         name = normalize_name(label)
         footnote = nodes.footnote('\n'.join(indented))
@@ -1909,8 +1915,8 @@
 
     def citation(self, match):
         src, srcline = self.state_machine.get_source_and_line()
-        indented, indent, offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        (indented, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         label = match.group(1)
         name = normalize_name(label)
         citation = nodes.citation('\n'.join(indented))
@@ -1927,9 +1933,9 @@
     def hyperlink_target(self, match):
         pattern = self.explicit.patterns.target
         lineno = self.state_machine.abs_line_number()
-        block, indent, offset, blank_finish = \
-              self.state_machine.get_first_known_indented(
-              match.end(), until_blank=True, strip_indent=False)
+        (block, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(
+                 match.end(), until_blank=True, strip_indent=False)
         blocktext = match.string:match.end() + '\n'.join(block)
         block = escape2null(line) for line in block
         escaped = block0
@@ -1974,8 +1980,8 @@
             - 'refuri' and the URI
             - 'malformed' and a system_message node
         """
-        if block and block-1.strip()-1: == '_': # possible indirect target
-            reference = ' '.join(line.strip() for line in block)
+        if block and block-1.strip()-1: == '_':  # possible indirect target
+            reference = ' '.join(line.strip() for line in block)
             refname = self.is_reference(reference)
             if refname:
                 return 'refname', refname
@@ -2012,9 +2018,9 @@
     def substitution_def(self, match):
         pattern = self.explicit.patterns.substitution
         src, srcline = self.state_machine.get_source_and_line()
-        block, indent, offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end(),
-                                                          strip_indent=False)
+        (block, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end(),
+                                                         strip_indent=False)
         blocktext = (match.string:match.end() + '\n'.join(block))
         block.disconnect()
         escaped = escape2null(block0.rstrip())
@@ -2025,11 +2031,13 @@
                 break
             blockindex += 1
             try:
-                escaped = escaped + ' ' + escape2null(blockblockindex.strip())
+                escaped = escaped + ' ' + escape2null(
+                                              blockblockindex.strip())
             except IndexError:
                 raise MarkupError('malformed substitution definition.')
         del block:blockindex          # strip out the substitution marker
-        block0 = (block0.strip() + ' ')subdefmatch.end()-len(escaped)-1:-1
+        start = subdefmatch.end()-len(escaped)-1
+        block0 = (block0.strip() + ' ')start:-1
         if not block0:
             del block0
             offset += 1
@@ -2053,13 +2061,13 @@
               initial_state='SubstitutionDef', blank_finish=blank_finish)
         i = 0
         for node in substitution_node::
-            if not (isinstance(node, nodes.Inline) or
-                    isinstance(node, nodes.Text)):
+            if not (isinstance(node, nodes.Inline)
+                    or isinstance(node, nodes.Text)):
                 self.parent += substitution_nodei
                 del substitution_nodei
             else:
                 i += 1
-        for node in substitution_node.traverse(nodes.Element):
+        for node in substitution_node.findall(nodes.Element):
             if self.disallowed_inside_substitution_definitions(node):
                 pformat = nodes.literal_block('', node.pformat().rstrip())
                 msg = self.reporter.error(
@@ -2079,9 +2087,9 @@
         return substitution_node, blank_finish
 
     def disallowed_inside_substitution_definitions(self, node):
-        if (node'ids' or
-            isinstance(node, nodes.reference) and node.get('anonymous') or
-            isinstance(node, nodes.footnote_reference) and node.get('auto')):
+        if (node'ids'
+            or isinstance(node, nodes.reference) and node.get('anonymous')
+            or isinstance(node, nodes.footnote_reference) and node.get('auto')):  # noqa: E501
             return True
         else:
             return False
@@ -2124,11 +2132,11 @@
             directive = convert_directive_function(directive)
         lineno = self.state_machine.abs_line_number()
         initial_line_offset = self.state_machine.line_offset
-        indented, indent, line_offset, blank_finish \
-                  = self.state_machine.get_first_known_indented(match.end(),
-                                                                strip_top=0)
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end(),
+                                                         strip_top=0)
         block_text = '\n'.join(self.state_machine.input_lines
-            initial_line_offset : self.state_machine.line_offset + 1)
+            initial_line_offset : self.state_machine.line_offset + 1)  # noqa: E203,E501
         try:
             arguments, options, content, content_offset = (
                 self.parse_directive_block(indented, line_offset,
@@ -2202,7 +2210,7 @@
             arguments = 
         if content and not has_content:
             raise MarkupError('no content permitted')
-        return (arguments, options, content, content_offset)
+        return arguments, options, content, content_offset
 
     def parse_directive_options(self, option_presets, option_spec, arg_block):
         options = option_presets.copy()
@@ -2257,16 +2265,16 @@
         newline_offset, blank_finish = self.nested_list_parse(
               datalines, 0, node, initial_state='ExtensionOptions',
               blank_finish=True)
-        if newline_offset != len(datalines): # incomplete parse of block
+        if newline_offset != len(datalines):  # incomplete parse of block
             return 0, 'invalid option block'
         try:
             options = utils.extract_extension_options(node, option_spec)
         except KeyError as detail:
-            return 0, ('unknown option: "%s"' % detail.args0)
+            return 0, 'unknown option: "%s"' % detail.args0
         except (ValueError, TypeError) as detail:
-            return 0, ('invalid option value: %s' % ' '.join(detail.args))
+            return 0, 'invalid option value: %s' % ' '.join(detail.args)
         except utils.ExtensionOptionError as detail:
-            return 0, ('invalid option data: %s' % ' '.join(detail.args))
+            return 0, 'invalid option data: %s' % ' '.join(detail.args)
         if blank_finish:
             return 1, options
         else:
@@ -2274,20 +2282,25 @@
 
     def unknown_directive(self, type_name):
         lineno = self.state_machine.abs_line_number()
-        indented, indent, offset, blank_finish = \
-            self.state_machine.get_first_known_indented(0, strip_indent=False)
+        (indented, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(0, strip_indent=False)
         text = '\n'.join(indented)
-        error = self.reporter.error(
-              'Unknown directive type "%s".' % type_name,
-              nodes.literal_block(text, text), line=lineno)
+        error = self.reporter.error('Unknown directive type "%s".' % type_name,
+                                    nodes.literal_block(text, text),
+                                    line=lineno)
         return error, blank_finish
 
     def comment(self, match):
-        if not match.stringmatch.end():.strip() \
-              and self.state_machine.is_next_line_blank(): # an empty comment?
-            return nodes.comment(), 1 # "A tiny but practical wart."
-        indented, indent, offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        if self.state_machine.is_next_line_blank():
+            first_comment_line = match.stringmatch.end():
+            if not first_comment_line.strip():  # empty comment
+                return nodes.comment(), True  # "A tiny but practical wart."
+            if first_comment_line.startswith('end of inclusion from "'):
+                # cf. parsers.rst.directives.misc.Include
+                self.document.include_log.pop()
+                return , True
+        (indented, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         while indented and not indented-1.strip():
             indented.trim_end()
         text = '\n'.join(indented)
@@ -2309,25 +2322,25 @@
                       )
                       \
                       ( +|$)          # whitespace or end of line
-                      """ % Inliner.simplename, re.VERBOSE | re.UNICODE)),
+                      """ % Inliner.simplename, re.VERBOSE)),
           (citation,
            re.compile(r"""
                       \.\. +          # explicit markup start
                       \(%s)\          # citation label
                       ( +|$)          # whitespace or end of line
-                      """ % Inliner.simplename, re.VERBOSE | re.UNICODE)),
+                      """ % Inliner.simplename, re.VERBOSE)),
           (hyperlink_target,
            re.compile(r"""
                       \.\. +          # explicit markup start
                       _                 # target indicator
                       (?! |$)         # first char. not space or EOL
-                      """, re.VERBOSE | re.UNICODE)),
+                      """, re.VERBOSE)),
           (substitution_def,
            re.compile(r"""
                       \.\. +          # explicit markup start
                       \|                # substitution indicator
                       (?! |$)         # first char. not space or EOL
-                      """, re.VERBOSE | re.UNICODE)),
+                      """, re.VERBOSE)),
           (directive,
            re.compile(r"""
                       \.\. +          # explicit markup start
@@ -2335,7 +2348,7 @@
                        ?              # optional space
                       ::                # directive delimiter
                       ( +|$)          # whitespace or end of line
-                      """ % Inliner.simplename, re.VERBOSE | re.UNICODE))
+                      """ % Inliner.simplename, re.VERBOSE))
 
     def explicit_markup(self, match, context, next_state):
         """Footnotes, hyperlink targets, directives, comments."""
@@ -2385,9 +2398,9 @@
 
     def anonymous_target(self, match):
         lineno = self.state_machine.abs_line_number()
-        block, indent, offset, blank_finish \
-            = self.state_machine.get_first_known_indented(match.end(),
-                                                        until_blank=True)
+        (block, indent, offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end(),
+                                                         until_blank=True)
         blocktext = match.string:match.end() + '\n'.join(block)
         block = escape2null(line) for line in block
         target = self.make_target(block, blocktext, lineno, '')
@@ -2431,7 +2444,7 @@
     patterns'rfc2822' = r'!-9;-~+:( +|$)'
     initial_transitions = (name, 'Body')
                            for name in Body.initial_transitions
-    initial_transitions.insert(-1, ('rfc2822', 'Body')) # just before 'text'
+    initial_transitions.insert(-1, ('rfc2822', 'Body'))  # just before 'text'
 
     def rfc2822(self, match, context, next_state):
         """RFC2822-style field list item."""
@@ -2439,7 +2452,7 @@
         self.parent += fieldlist
         field, blank_finish = self.rfc2822_field(match)
         fieldlist += field
-        offset = self.state_machine.line_offset + 1   # next line
+        offset = self.state_machine.line_offset + 1  # next line
         newline_offset, blank_finish = self.nested_list_parse(
               self.state_machine.input_linesoffset:,
               input_offset=self.state_machine.abs_line_offset() + 1,
@@ -2453,9 +2466,9 @@
 
     def rfc2822_field(self, match):
         name = match.string:match.string.find(':')
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end(),
-                                                          until_blank=True)
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end(),
+                                                         until_blank=True)
         fieldnode = nodes.field()
         fieldnode += nodes.field_name(name, name)
         fieldbody = nodes.field_body('\n'.join(indented))
@@ -2492,7 +2505,7 @@
 
     def invalid_input(self, match=None, context=None, next_state=None):
         """Not a compound element member. Abort this state machine."""
-        self.state_machine.previous_line() # back up so parent SM can reassess
+        self.state_machine.previous_line()  # back up so parent SM can reassess
         raise EOFError
 
     indent = invalid_input
@@ -2542,11 +2555,11 @@
         """Enumerated list item."""
         format, sequence, text, ordinal = self.parse_enumerator(
               match, self.parent'enumtype')
-        if ( format != self.format
-             or (sequence != '#' and (sequence != self.parent'enumtype'
-                                      or self.auto
-                                      or ordinal != (self.lastordinal + 1)))
-             or not self.is_enumerated_list_item(ordinal, sequence, format)):
+        if (format != self.format
+            or (sequence != '#' and (sequence != self.parent'enumtype'
+                                     or self.auto
+                                     or ordinal != (self.lastordinal + 1)))
+            or not self.is_enumerated_list_item(ordinal, sequence, format)):
             # different enumeration: new list
             self.invalid_input()
         if sequence == '#':
@@ -2667,7 +2680,7 @@
 
     patterns = {
           'embedded_directive': re.compile(r'(%s)::( +|$)'
-                                           % Inliner.simplename, re.UNICODE),
+                                           % Inliner.simplename),
           'text': r''}
     initial_transitions = 'embedded_directive', 'text'
 
@@ -2699,7 +2712,7 @@
 
     def blank(self, match, context, next_state):
         """End of paragraph."""
-        # NOTE: self.paragraph returns  node, system_message(s) , literalnext
+        # NOTE: self.paragraph returns node, system_message(s), literalnext
         paragraph, literalnext = self.paragraph(
               context, self.state_machine.abs_line_number() - 1)
         self.parent += paragraph
@@ -2747,8 +2760,10 @@
                 raise statemachine.TransitionCorrection('text')
             else:
                 blocktext = context0 + '\n' + self.state_machine.line
-                msg = self.reporter.warning('Title underline too short.',
-                    nodes.literal_block(blocktext, blocktext), line=lineno)
+                msg = self.reporter.warning(
+                    'Title underline too short.',
+                    nodes.literal_block(blocktext, blocktext),
+                    line=lineno)
                 messages.append(msg)
         if not self.state_machine.match_titles:
             blocktext = context0 + '\n' + self.state_machine.line
@@ -2758,7 +2773,8 @@
             # if the error is in a table (try with test_tables.py)?
             # print("get_source_and_line", srcline)
             # print("abs_line_number", self.state_machine.abs_line_number())
-            msg = self.reporter.severe('Unexpected section title.',
+            msg = self.reporter.severe(
+                'Unexpected section title.',
                 nodes.literal_block(blocktext, blocktext),
                 source=src, line=srcline)
             self.parent += messages
@@ -2793,8 +2809,8 @@
 
     def literal_block(self):
         """Return a list of nodes."""
-        indented, indent, offset, blank_finish = \
-              self.state_machine.get_indented()
+        (indented, indent, offset, blank_finish
+         ) = self.state_machine.get_indented()
         while indented and not indented-1.strip():
             indented.trim_end()
         if not indented:
@@ -2821,8 +2837,8 @@
         return parent_node.children
 
     def definition_list_item(self, termline):
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_indented()
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_indented()
         itemnode = nodes.definition_list_item(
             '\n'.join(termline + list(indented)))
         lineno = self.state_machine.abs_line_number() - 1
@@ -2897,7 +2913,7 @@
 
     def eof(self, context):
         """Not a definition."""
-        self.state_machine.previous_line(2) # so parent SM can reassess
+        self.state_machine.previous_line(2)  # so parent SM can reassess
         return 
 
     def indent(self, match, context, next_state):
@@ -3073,8 +3089,8 @@
         else:
             self.parent += self.reporter.warning(
                 'Literal block expected; none found.',
-                line=self.state_machine.abs_line_number())
-                # src not available, because statemachine.input_lines is empty
+                line=self.state_machine.abs_line_number()
+                )  # src not available, statemachine.input_lines is empty
             self.state_machine.previous_line()
         self.parent += self.messages
         return 
@@ -3092,7 +3108,7 @@
         """Match arbitrary quote character on the first line only."""
         self.remove_transition('initial_quoted')
         quote = match.string0
-        pattern = re.compile(re.escape(quote), re.UNICODE)
+        pattern = re.compile(re.escape(quote))
         # New transition matches consistent quotes only:
         self.add_transition('quoted',
                             (pattern, self.quoted, self.__class__.__name__))
@@ -3108,7 +3124,7 @@
         if context:
             self.messages.append(
                 self.reporter.error('Inconsistent literal block quoting.',
-                                   line=self.state_machine.abs_line_number()))
+                                    line=self.state_machine.abs_line_number()))
             self.state_machine.previous_line()
         raise EOFError

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/parsers/rst/tableparser.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/parsers/rst/tableparser.py Changed

@@ -1,4 +1,4 @@
-# $Id: tableparser.py 8373 2019-08-27 12:11:30Z milde $
+# $Id: tableparser.py 9038 2022-03-05 23:31:46Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -36,11 +36,11 @@
     """
 
     def __init__(self, *args, **kwargs):
-            self.offset = kwargs.pop('offset', 0)
-            DataError.__init__(self, *args)
+        self.offset = kwargs.pop('offset', 0)
+        DataError.__init__(self, *args)
 
 
-class TableParser(object):
+class TableParser:
 
     """
     Abstract superclass for the common parts of the syntax-specific parsers.
@@ -65,8 +65,7 @@
         self.setup(block)
         self.find_head_body_sep()
         self.parse_table()
-        structure = self.structure_from_cells()
-        return structure
+        return self.structure_from_cells()
 
     def find_head_body_sep(self):
         """Look for a head/body row separator line; store the line index."""
@@ -170,8 +169,9 @@
         corners = (0, 0)
         while corners:
             top, left = corners.pop(0)
-            if top == self.bottom or left == self.right \
-                  or top <= self.doneleft:
+            if (top == self.bottom
+                or left == self.right
+                or top <= self.doneleft):
                 continue
             result = self.scan_cell(top, left)
             if not result:
@@ -209,8 +209,7 @@
     def scan_cell(self, top, left):
         """Starting at the top-left corner, start tracing out a cell."""
         assert self.blocktopleft == '+'
-        result = self.scan_right(top, left)
-        return result
+        return self.scan_right(top, left)
 
     def scan_right(self, top, left):
         """
@@ -295,7 +294,7 @@
         for i in range(len(colseps)):
             colindexcolsepsi = i    # column boundary -> col number map
         colspecs = (colsepsi - colsepsi - 1 - 1)
-                    for i in range(1, len(colseps)) # list of column widths
+                    for i in range(1, len(colseps))  # list of column widths
         # prepare an empty table with the correct number of rows & columns
         onerow = None for i in range(len(colseps) - 1)
         rows = onerow: for i in range(len(rowseps) - 1)
@@ -320,7 +319,7 @@
         else:
             headrows = 
             bodyrows = rows
-        return (colspecs, headrows, bodyrows)
+        return colspecs, headrows, bodyrows
 
 
 class SimpleTableParser(TableParser):
@@ -474,10 +473,8 @@
             return
         if spanline:
             columns = self.parse_columns(*spanline)
-            span_offset = spanline1
         else:
             columns = self.columns:
-            span_offset = start
         self.check_columns(lines, start, columns)
         row = self.init_row(columns, start)
         for i in range(len(columns)):
@@ -514,9 +511,9 @@
                     if new_end > main_end:
                         self.columns-1 = (main_start, new_end)
                 elif lineend:nextstart.strip():
-                    raise TableMarkupError('Text in column margin '
-                        'in table line %s.' % (first_line+offset+1),
-                        offset=first_line+offset)
+                    raise TableMarkupError('Text in column margin in table '
+                                           'line %s.' % (first_line+offset+1),
+                                           offset=first_line+offset)
                 offset += 1
         columns.pop()

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/readers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/readers/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8478 2020-01-30 12:29:29Z milde $
+# $Id: __init__.py 9258 2022-11-21 14:51:43Z milde $
 # Authors: David Goodger <goodger@python.org>; Ueli Schlaepfer
 # Copyright: This module has been placed in the public domain.
 
@@ -8,7 +8,6 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
 from importlib import import_module
 
 from docutils import utils, parsers, Component
@@ -31,10 +30,9 @@
     config_section = 'readers'
 
     def get_transforms(self):
-        return Component.get_transforms(self) + 
-            universal.Decorations,
-            universal.ExposeInternals,
-            universal.StripComments,
+        return super().get_transforms() + universal.Decorations,
+                                           universal.ExposeInternals,
+                                           universal.StripComments
 
     def __init__(self, parser=None, parser_name=None):
         """
@@ -80,8 +78,7 @@
 
     def new_document(self):
         """Create and return a new empty document tree (root node)."""
-        document = utils.new_document(self.source.source_path, self.settings)
-        return document
+        return utils.new_document(self.source.source_path, self.settings)
 
 
 class ReReader(Reader):
@@ -101,13 +98,16 @@
 
 _reader_aliases = {}
 
+
 def get_reader_class(reader_name):
     """Return the Reader class from the `reader_name` module."""
-    reader_name = reader_name.lower()
-    if reader_name in _reader_aliases:
-        reader_name = _reader_aliasesreader_name
+    name = reader_name.lower()
+    name = _reader_aliases.get(name, name)
     try:
-        module = import_module('docutils.readers.'+reader_name)
+        module = import_module('docutils.readers.'+name)
     except ImportError:
-        module = import_module(reader_name)
+        try:
+            module = import_module(name)
+        except ImportError as err:
+            raise ImportError(f'Reader "{reader_name}" not found. {err}')
     return module.Reader

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/readers/pep.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/readers/pep.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/readers/standalone.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/readers/standalone.py Changed

@@ -1,4 +1,4 @@
-# $Id: standalone.py 4802 2006-11-12 18:02:17Z goodger $
+# $Id: standalone.py 9258 2022-11-21 14:51:43Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,7 +9,6 @@
 __docformat__ = 'reStructuredText'
 
 
-import sys
 from docutils import frontend, readers
 from docutils.transforms import frontmatter, references, misc
 
@@ -23,7 +22,7 @@
     """A single document tree."""
 
     settings_spec = (
-        'Standalone Reader',
+        'Standalone Reader Options',
         None,
         (('Disable the promotion of a lone top-level section title to '
           'document title (and subsequent section title to document '
@@ -50,7 +49,7 @@
     config_section_dependencies = ('readers',)
 
     def get_transforms(self):
-        return readers.Reader.get_transforms(self) + 
+        return super().get_transforms() + 
             references.Substitutions,
             references.PropagateTargets,
             frontmatter.DocTitle,

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/statemachine.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/statemachine.py Changed

@@ -1,4 +1,4 @@
- # $Id: statemachine.py 8565 2020-09-14 10:26:03Z milde $
+# $Id: statemachine.py 9072 2022-06-15 11:31:09Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -92,7 +92,8 @@
    one-line strings. For example, to read text from a file called
    'inputfile'::
 
-       input_string = open('inputfile').read()
+       with open('inputfile', encoding='utf-8') as fp:
+           input_string = fp.read()
        input_lines = statemachine.string2lines(input_string)
 
 5. Run the state machine on the input text and collect the results, a list::
@@ -103,21 +104,17 @@
 
        sm.unlink()
 """
-from __future__ import print_function
 
 __docformat__ = 'restructuredtext'
 
 import sys
 import re
-import unicodedata
-from docutils import utils
-from docutils.utils.error_reporting import ErrorOutput
+from unicodedata import east_asian_width
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
+from docutils import utils
 
 
-class StateMachine(object):
+class StateMachine:
 
     """
     A finite state machine for text filters using regular expressions.
@@ -174,10 +171,6 @@
         line changes.  Observers are called with one argument, ``self``.
         Cleared at the end of `run()`."""
 
-        self._stderr = ErrorOutput()
-        """Wrapper around sys.stderr catching en-/decoding errors"""
-
-
     def unlink(self):
         """Remove circular references to objects no longer required."""
         for state in self.states.values():
@@ -216,14 +209,15 @@
         self.line_offset = -1
         self.current_state = initial_state or self.initial_state
         if self.debug:
-            print(u'\nStateMachine.run: input_lines (line_offset=%s):\n| %s'
-                  % (self.line_offset, u'\n| '.join(self.input_lines)), file=self._stderr)
+            print('\nStateMachine.run: input_lines (line_offset=%s):\n| %s'
+                  % (self.line_offset, '\n| '.join(self.input_lines)),
+                  file=sys.stderr)
         transitions = None
         results = 
         state = self.get_state()
         try:
             if self.debug:
-                print('\nStateMachine.run: bof transition', file=self._stderr)
+                print('\nStateMachine.run: bof transition', file=sys.stderr)
             context, result = state.bof(context)
             results.extend(result)
             while True:
@@ -233,30 +227,31 @@
                         if self.debug:
                             source, offset = self.input_lines.info(
                                 self.line_offset)
-                            print(u'\nStateMachine.run: line (source=%r, '
-                                  u'offset=%r):\n| %s'
-                                  % (source, offset, self.line), file=self._stderr)
+                            print(f'\nStateMachine.run: line '
+                                  f'(source={source!r}, offset={offset!r}):\n'
+                                  f'| {self.line}', file=sys.stderr)
                         context, next_state, result = self.check_line(
                             context, state, transitions)
                     except EOFError:
                         if self.debug:
                             print('\nStateMachine.run: %s.eof transition'
-                                  % state.__class__.__name__, file=self._stderr)
+                                  % state.__class__.__name__, file=sys.stderr)
                         result = state.eof(context)
                         results.extend(result)
                         break
                     else:
                         results.extend(result)
                 except TransitionCorrection as exception:
-                    self.previous_line() # back up for another try
+                    self.previous_line()  # back up for another try
                     transitions = (exception.args0,)
                     if self.debug:
                         print('\nStateMachine.run: TransitionCorrection to '
-                              'state "%s", transition %s.'
-                              % (state.__class__.__name__, transitions0), file=self._stderr)
+                              f'state "{state.__class__.__name__}", '
+                              f'transition {transitions0}.',
+                              file=sys.stderr)
                     continue
                 except StateCorrection as exception:
-                    self.previous_line() # back up for another try
+                    self.previous_line()  # back up for another try
                     next_state = exception.args0
                     if len(exception.args) == 1:
                         transitions = None
@@ -264,12 +259,12 @@
                         transitions = (exception.args1,)
                     if self.debug:
                         print('\nStateMachine.run: StateCorrection to state '
-                              '"%s", transition %s.'
-                              % (next_state, transitions0), file=self._stderr)
+                              f'"{next_state}", transition {transitions0}.',
+                              file=sys.stderr)
                 else:
                     transitions = None
                 state = self.get_state(next_state)
-        except:
+        except:  # noqa  catchall
             if self.debug:
                 self.error()
             raise
@@ -289,7 +284,7 @@
                 print('\nStateMachine.get_state: Changing state from '
                       '"%s" to "%s" (input line %s).'
                       % (self.current_state, next_state,
-                         self.abs_line_number()), file=self._stderr)
+                         self.abs_line_number()), file=sys.stderr)
             self.current_state = next_state
         try:
             return self.statesself.current_state
@@ -310,7 +305,7 @@
             self.notify_observers()
 
     def is_next_line_blank(self):
-        """Return 1 if the next line is blank or non-existant."""
+        """Return True if the next line is blank or non-existent."""
         try:
             return not self.input_linesself.line_offset + 1.strip()
         except IndexError:
@@ -375,16 +370,16 @@
         try:
             src, srcoffset = self.input_lines.info(offset)
             srcline = srcoffset + 1
-        except (TypeError):
+        except TypeError:
             # line is None if index is "Just past the end"
             src, srcline = self.get_source_and_line(offset + self.input_offset)
             return src, srcline + 1
-        except (IndexError):  # `offset` is off the list
+        except IndexError:  # `offset` is off the list
             src, srcline = None, None
             # raise AssertionError('cannot find line %d in %s lines' %
             #                      (offset, len(self.input_lines)))
             #                      # list(self.input_lines.lines())))
-        return (src, srcline)
+        return src, srcline
 
     def insert_input(self, input_lines, source):
         self.input_lines.insert(self.line_offset + 1, '',
@@ -411,7 +406,7 @@
             return block
         except UnexpectedIndentationError as err:
             block = err.args0
-            self.next_line(len(block) - 1) # advance to last line of block
+            self.next_line(len(block) - 1)  # advance to last line of block
             raise
 
     def check_line(self, context, state, transitions=None):
@@ -435,24 +430,23 @@
         value is returned.
         """
         if transitions is None:
-            transitions =  state.transition_order
-        state_correction = None
+            transitions = state.transition_order
         if self.debug:
             print('\nStateMachine.check_line: state="%s", transitions=%r.'
-                  % (state.__class__.__name__, transitions), file=self._stderr)
+                  % (state.__class__.__name__, transitions), file=sys.stderr)
         for name in transitions:
             pattern, method, next_state = state.transitionsname
             match = pattern.match(self.line)
             if match:
                 if self.debug:
                     print('\nStateMachine.check_line: Matched transition '
-                          '"%s" in state "%s".'
-                          % (name, state.__class__.__name__), file=self._stderr)
+                          f'"{name}" in state "{state.__class__.__name__}".',
+                          file=sys.stderr)
                 return method(match, context, next_state)
         else:
             if self.debug:
                 print('\nStateMachine.check_line: No match in state "%s".'
-                      % state.__class__.__name__, file=self._stderr)
+                      % state.__class__.__name__, file=sys.stderr)
             return state.no_match(context, transitions)
 
     def add_state(self, state_class):
@@ -484,10 +478,10 @@
     def error(self):
         """Report error details."""
         type, value, module, line, function = _exception_data()
-        print(u'%s: %s' % (type, value), file=self._stderr)
-        print('input line %s' % (self.abs_line_number()), file=self._stderr)
-        print((u'module %s, line %s, function %s' %
-                               (module, line, function)), file=self._stderr)
+        print('%s: %s' % (type, value), file=sys.stderr)
+        print('input line %s' % (self.abs_line_number()), file=sys.stderr)
+        print('module %s, line %s, function %s' % (module, line, function),
+              file=sys.stderr)
 
     def attach_observer(self, observer):
         """
@@ -508,7 +502,7 @@
             observer(*info)
 
 
-class State(object):
+class State:
 
     """
     State superclass. Contains a list of transitions, and transition methods.
@@ -520,7 +514,7 @@
       ``match.end()`` gives the end index.
     - A context object, whose meaning is application-defined (initial value
       ``None``). It can be used to store any information required by the state
-      machine, and the retured context is passed on to the next transition
+      machine, and the returned context is passed on to the next transition
       method unchanged.
     - The name of the next state, a string, taken from the transitions list;
       normally it is returned unchanged, but it may be altered by the
@@ -636,7 +630,7 @@
         """Make and add transitions listed in `self.initial_transitions`."""
         if self.initial_transitions:
             names, transitions = self.make_transitions(
-                  self.initial_transitions)
+                                     self.initial_transitions)
             self.add_transitions(names, transitions)
 
     def add_transitions(self, names, transitions):
@@ -680,7 +674,7 @@
         try:
             del self.transitionsname
             self.transition_order.remove(name)
-        except:
+        except:  # noqa  catchall
             raise UnknownTransitionError(name)
 
     def make_transition(self, name, next_state=None):
@@ -714,7 +708,7 @@
         except AttributeError:
             raise TransitionMethodNotFound(
                   '%s.%s' % (self.__class__.__name__, name))
-        return (pattern, method, next_state)
+        return pattern, method, next_state
 
     def make_transitions(self, name_list):
         """
@@ -724,11 +718,10 @@
         name string, or a 1- or 2-tuple (transition name, optional next state
         name).
         """
-        stringtype = type('')
         names = 
         transitions = {}
         for namestate in name_list:
-            if isinstance(namestate, stringtype):
+            if isinstance(namestate, str):
                 transitionsnamestate = self.make_transition(namestate)
                 names.append(namestate)
             else:
@@ -813,7 +806,7 @@
         indented, indent, blank_finish = self.input_lines.get_indented(
               self.line_offset, until_blank, strip_indent)
         if indented:
-            self.next_line(len(indented) - 1) # advance to last indented line
+            self.next_line(len(indented) - 1)  # advance to last indented line
         while indented and not indented0.strip():
             indented.trim_start()
             offset += 1
@@ -843,7 +836,7 @@
         indented, indent, blank_finish = self.input_lines.get_indented(
               self.line_offset, until_blank, strip_indent,
               block_indent=indent)
-        self.next_line(len(indented) - 1) # advance to last indented line
+        self.next_line(len(indented) - 1)  # advance to last indented line
         while indented and not indented0.strip():
             indented.trim_start()
             offset += 1
@@ -875,7 +868,7 @@
         indented, indent, blank_finish = self.input_lines.get_indented(
               self.line_offset, until_blank, strip_indent,
               first_indent=indent)
-        self.next_line(len(indented) - 1) # advance to last indented line
+        self.next_line(len(indented) - 1)  # advance to last indented line
         if strip_top:
             while indented and not indented0.strip():
                 indented.trim_start()
@@ -985,8 +978,8 @@
         Recursively run the registered state machine for indented blocks
         (`self.indent_sm`).
         """
-        indented, indent, line_offset, blank_finish = \
-              self.state_machine.get_indented()
+        (indented, indent, line_offset, blank_finish
+         ) = self.state_machine.get_indented()
         sm = self.indent_sm(debug=self.debug, **self.indent_sm_kwargs)
         results = sm.run(indented, input_offset=line_offset)
         return context, next_state, results
@@ -999,10 +992,10 @@
         blocks (`self.known_indent_sm`). The indent is the length of the
         match, ``match.end()``.
         """
-        indented, line_offset, blank_finish = \
-              self.state_machine.get_known_indented(match.end())
+        (indented, line_offset, blank_finish
+         ) = self.state_machine.get_known_indented(match.end())
         sm = self.known_indent_sm(debug=self.debug,
-                                 **self.known_indent_sm_kwargs)
+                                  **self.known_indent_sm_kwargs)
         results = sm.run(indented, input_offset=line_offset)
         return context, next_state, results
 
@@ -1016,15 +1009,15 @@
         blocks (`self.known_indent_sm`). The indent is the length of the
         match, ``match.end()``.
         """
-        indented, line_offset, blank_finish = \
-              self.state_machine.get_first_known_indented(match.end())
+        (indented, line_offset, blank_finish
+         ) = self.state_machine.get_first_known_indented(match.end())
         sm = self.known_indent_sm(debug=self.debug,
-                                 **self.known_indent_sm_kwargs)
+                                  **self.known_indent_sm_kwargs)
         results = sm.run(indented, input_offset=line_offset)
         return context, next_state, results
 
 
-class _SearchOverride(object):
+class _SearchOverride:
 
     """
     Mix-in class to override `StateMachine` regular expression behavior.
@@ -1057,7 +1050,7 @@
     pass
 
 
-class ViewList(object):
+class ViewList:
 
     """
     List with extended functionality: slices of ViewList objects are child
@@ -1108,21 +1101,14 @@
         return str(self.data)
 
     def __repr__(self):
-        return '%s(%s, items=%s)' % (self.__class__.__name__,
-                                     self.data, self.items)
-
-    def __lt__(self, other): return self.data <  self.__cast(other)
-    def __le__(self, other): return self.data <= self.__cast(other)
-    def __eq__(self, other): return self.data == self.__cast(other)
-    def __ne__(self, other): return self.data != self.__cast(other)
-    def __gt__(self, other): return self.data >  self.__cast(other)
-    def __ge__(self, other): return self.data >= self.__cast(other)
-
-    def __cmp__(self, other):
-        # from https://docs.python.org/3.0/whatsnew/3.0.html
-        mine = self.data
-        yours = self.__cast(other)
-        return (mine > yours) - (yours < mine)
+        return f'{self.__class__.__name__}({self.data}, items={self.items})'
+
+    def __lt__(self, other): return self.data < self.__cast(other)   # noqa
+    def __le__(self, other): return self.data <= self.__cast(other)  # noqa
+    def __eq__(self, other): return self.data == self.__cast(other)  # noqa
+    def __ne__(self, other): return self.data != self.__cast(other)  # noqa
+    def __gt__(self, other): return self.data > self.__cast(other)   # noqa
+    def __ge__(self, other): return self.data >= self.__cast(other)  # noqa
 
     def __cast(self, other):
         if isinstance(other, ViewList):
@@ -1130,8 +1116,11 @@
         else:
             return other
 
-    def __contains__(self, item): return item in self.data
-    def __len__(self): return len(self.data)
+    def __contains__(self, item):
+        return item in self.data
+
+    def __len__(self):
+        return len(self.data)
 
     # The __getitem__()/__setitem__() methods check whether the index
     # is a slice first, since indexing a native list with a slice object
@@ -1139,7 +1128,7 @@
 
     def __getitem__(self, i):
         if isinstance(i, slice):
-            assert i.step in (None, 1),  'cannot handle slice with stride'
+            assert i.step in (None, 1), 'cannot handle slice with stride'
             return self.__class__(self.datai.start:i.stop,
                                   items=self.itemsi.start:i.stop,
                                   parent=self, parent_offset=i.start or 0)
@@ -1155,8 +1144,9 @@
             self.itemsi.start:i.stop = item.items
             assert len(self.data) == len(self.items), 'data mismatch'
             if self.parent:
-                self.parent(i.start or 0) + self.parent_offset
-                            : (i.stop or len(self)) + self.parent_offset = item
+                k = (i.start or 0) + self.parent_offset
+                n = (i.stop or len(self)) + self.parent_offset
+                self.parentk:n = item
         else:
             self.datai = item
             if self.parent:
@@ -1173,8 +1163,9 @@
             del self.datai.start:i.stop
             del self.itemsi.start:i.stop
             if self.parent:
-                del self.parent(i.start or 0) + self.parent_offset
-                                : (i.stop or len(self)) + self.parent_offset
+                k = (i.start or 0) + self.parent_offset
+                n = (i.stop or len(self)) + self.parent_offset
+                del self.parentk:n
 
     def __add__(self, other):
         if isinstance(other, ViewList):
@@ -1279,8 +1270,11 @@
         index = self.index(item)
         del selfindex
 
-    def count(self, item): return self.data.count(item)
-    def index(self, item): return self.data.index(item)
+    def count(self, item):
+        return self.data.count(item)
+
+    def index(self, item):
+        return self.data.index(item)
 
     def reverse(self):
         self.data.reverse()
@@ -1318,7 +1312,7 @@
     def xitems(self):
         """Return iterator yielding (source, offset, value) tuples."""
         for (value, (source, offset)) in zip(self.data, self.items):
-            yield (source, offset, value)
+            yield source, offset, value
 
     def pprint(self):
         """Print the list in `grep` format (`source:offset:value` lines)"""
@@ -1378,7 +1372,7 @@
           - `first_indent`: The indent of the first line, if known.
 
         :Return:
-          - a StringList of indented lines with mininum indent removed;
+          - a StringList of indented lines with minimum indent removed;
           - the amount of the indent;
           - a boolean: did the indented block finish with a blank line or EOF?
         """
@@ -1442,18 +1436,17 @@
         return block
 
     def pad_double_width(self, pad_char):
-        """
-        Pad all double-width characters in self by appending `pad_char` to each.
+        """Pad all double-width characters in `self` appending `pad_char`.
+
         For East Asian language support.
         """
-        east_asian_width = unicodedata.east_asian_width
         for i in range(len(self.data)):
             line = self.datai
-            if isinstance(line, unicode):
+            if isinstance(line, str):
                 new = 
                 for char in line:
                     new.append(char)
-                    if east_asian_width(char) in 'WF': # 'W'ide & 'F'ull-width
+                    if east_asian_width(char) in 'WF':  # Wide & Full-width
                         new.append(pad_char)
                 self.datai = ''.join(new)
 
@@ -1491,6 +1484,7 @@
     transition name.
     """
 
+
 def string2lines(astring, tab_width=8, convert_whitespace=False,
                  whitespace=re.compile('\v\f')):
     """
@@ -1510,8 +1504,8 @@
     """
     if convert_whitespace:
         astring = whitespace.sub(' ', astring)
-    lines = s.expandtabs(tab_width).rstrip() for s in astring.splitlines()
-    return lines
+    return s.expandtabs(tab_width).rstrip() for s in astring.splitlines()
+
 
 def _exception_data():
     """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8358 2019-08-26 16:45:09Z milde $
+# $Id: __init__.py 9320 2023-01-17 15:40:15Z milde $
 # Authors: David Goodger <goodger@python.org>; Ueli Schlaepfer
 # Copyright: This module has been placed in the public domain.
 
@@ -27,14 +27,12 @@
 from docutils import languages, ApplicationError, TransformSpec
 
 
-class TransformError(ApplicationError): pass
+class TransformError(ApplicationError):
+    pass
 
 
-class Transform(object):
-
-    """
-    Docutils transform component abstract base class.
-    """
+class Transform:
+    """Docutils transform component abstract base class."""
 
     default_priority = None
     """Numerical priority of this transform, 0 through 999 (override)."""
@@ -62,10 +60,16 @@
 
 
 class Transformer(TransformSpec):
-
     """
-    Stores transforms (`Transform` classes) and applies them to document
-    trees.  Also keeps track of components by component type name.
+    Store "transforms" and apply them to the document tree.
+
+    Collect lists of `Transform` instances and "unknown_reference_resolvers"
+    from Docutils components (`TransformSpec` instances).
+    Apply collected "transforms" to the document tree.
+
+    Also keeps track of components by component type name.
+
+    https://docutils.sourceforge.io/docs/peps/pep-0258.html#transformer
     """
 
     def __init__(self, document):
@@ -75,7 +79,7 @@
         """
 
         self.unknown_reference_resolvers = 
-        """List of hook functions which assist in resolving references"""
+        """List of hook functions which assist in resolving references."""
 
         self.document = document
         """The `nodes.document` object this Transformer is attached to."""
@@ -83,12 +87,14 @@
         self.applied = 
         """Transforms already applied, in order."""
 
-        self.sorted = 0
+        self.sorted = False
         """Boolean: is `self.tranforms` sorted?"""
 
         self.components = {}
-        """Mapping of component type name to component object.  Set by
-        `self.populate_from_components()`."""
+        """Mapping of component type name to component object.
+
+        Set by `self.populate_from_components()`.
+        """
 
         self.serialno = 0
         """Internal serial number to keep track of the add order of
@@ -106,7 +112,7 @@
         priority_string = self.get_priority_string(priority)
         self.transforms.append(
             (priority_string, transform_class, None, kwargs))
-        self.sorted = 0
+        self.sorted = False
 
     def add_transforms(self, transform_list):
         """Store multiple transforms, with default priorities."""
@@ -115,7 +121,7 @@
                 transform_class.default_priority)
             self.transforms.append(
                 (priority_string, transform_class, None, {}))
-        self.sorted = 0
+        self.sorted = False
 
     def add_pending(self, pending, priority=None):
         """Store a transform with an associated `pending` node."""
@@ -125,7 +131,7 @@
         priority_string = self.get_priority_string(priority)
         self.transforms.append(
             (priority_string, transform_class, pending, {}))
-        self.sorted = 0
+        self.sorted = False
 
     def get_priority_string(self, priority):
         """
@@ -138,23 +144,28 @@
 
     def populate_from_components(self, components):
         """
-        Store each component's default transforms, with default priorities.
+        Store each component's default transforms and reference resolvers
+
+        Transforms are stored with default priorities for later sorting.
+        "Unknown reference resolvers" are sorted and stored.
+        Components that don't inherit from `TransformSpec` are ignored.
+
         Also, store components by type name in a mapping for later lookup.
         """
+        resolvers = 
         for component in components:
-            if component is None:
+            if not isinstance(component, TransformSpec):
                 continue
             self.add_transforms(component.get_transforms())
             self.componentscomponent.component_type = component
-        self.sorted = 0
-        # Set up all of the reference resolvers for this transformer. Each
-        # component of this transformer is able to register its own helper
-        # functions to help resolve references.
-        unknown_reference_resolvers = 
-        for i in components:
-            unknown_reference_resolvers.extend(i.unknown_reference_resolvers)
-        decorated_list = sorted((f.priority, f) for f in unknown_reference_resolvers)
-        self.unknown_reference_resolvers.extend(f1 for f in decorated_list)
+            resolvers.extend(component.unknown_reference_resolvers)
+        self.sorted = False  # sort transform list in self.apply_transforms()
+
+        # Sort and add helper functions to help resolve unknown references.
+        def keyfun(f):
+            return f.priority
+        resolvers.sort(key=keyfun)
+        self.unknown_reference_resolvers += resolvers
 
     def apply_transforms(self):
         """Apply all of the stored transforms, in priority order."""
@@ -162,10 +173,10 @@
             self.document.note_transform_message)
         while self.transforms:
             if not self.sorted:
-                # Unsorted initially, and whenever a transform is added.
-                self.transforms.sort()
-                self.transforms.reverse()
-                self.sorted = 1
+                # Unsorted initially, and whenever a transform is added
+                # (transforms may add other transforms).
+                self.transforms.sort(reverse=True)
+                self.sorted = True
             priority, transform_class, pending, kwargs = self.transforms.pop()
             transform = transform_class(self.document, startnode=pending)
             transform.apply(**kwargs)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/components.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/components.py Changed

@@ -1,4 +1,4 @@
-# $Id: components.py 8603 2021-01-08 15:24:32Z milde $
+# $Id: components.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -6,15 +6,9 @@
 Docutils component-related transforms.
 """
 
-__docformat__ = 'reStructuredText'
+from docutils.transforms import Transform
 
-import sys
-import os
-import re
-import time
-from docutils import nodes, utils
-from docutils import ApplicationError, DataError
-from docutils.transforms import Transform, TransformError
+__docformat__ = 'reStructuredText'
 
 
 class Filter(Transform):
@@ -32,19 +26,24 @@
     ``details'nodes'`` (a list of nodes); otherwise, the "pending" element
     is removed.
 
-    For example, the reStructuredText "meta" directive creates a "pending"
-    element containing a "meta" element (in ``pending.details'nodes'``).
-    Only writers (``pending.details'component' == 'writer'``) supporting the
-    "html", latex, or "odf" formats 
-    (``pending.details'format' == 'html,latex,odf'``) will include the
-    "meta" element; it will be deleted from the output of all other writers.
+    For example, up to version 0.17, the reStructuredText "meta"
+    directive created a "pending" element containing a "meta" element
+    (in ``pending.details'nodes'``).
+    Only writers (``pending.details'component' == 'writer'``)
+    supporting the "html", "latex", or "odf" formats
+    (``pending.details'format' == 'html,latex,odf'``) included the
+    "meta" element; it was deleted from the output of all other writers.
+
+    This transform is no longer used by Docutils, it may be removed in future.
     """
+    # TODO: clean up or keep this for 3rd party (or possible future) use?
+    # (GM 2021-05-18)
 
     default_priority = 780
 
     def apply(self):
         pending = self.startnode
-        component_type = pending.details'component' # 'reader' or 'writer'
+        component_type = pending.details'component'  # 'reader' or 'writer'
         formats = (pending.details'format').split(',')
         component = self.document.transformer.componentscomponent_type
         for format in formats:

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/frontmatter.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/frontmatter.py Changed

@@ -1,4 +1,4 @@
-# $Id: frontmatter.py 8671 2021-04-07 12:09:51Z milde $
+# $Id: frontmatter.py 9351 2023-04-17 20:26:33Z milde $
 # Author: David Goodger, Ueli Schlaepfer <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -22,16 +22,11 @@
 __docformat__ = 'reStructuredText'
 
 import re
-import sys
 
-from docutils import nodes, utils
+from docutils import nodes, parsers, utils
 from docutils.transforms import TransformError, Transform
 
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
 class TitlePromoter(Transform):
 
     """
@@ -70,7 +65,8 @@
         #       already exist in node with those in section.
         # NOTE: Remove `and_source` to NOT copy the 'source'
         #       attribute from section
-        node.update_all_atts_concatenating(section, replace=True, and_source=True)
+        node.update_all_atts_concatenating(section, replace=True,
+                                           and_source=True)
 
         # setup_child is called automatically for all nodes.
         node: = (section:1        # section title
@@ -111,7 +107,8 @@
         #       that already exist in node with those in section.
         # NOTE: Remove `and_source` to NOT copy the 'source'
         #       attribute from section.
-        subtitle.update_all_atts_concatenating(subsection, replace=True, and_source=True)
+        subtitle.update_all_atts_concatenating(subsection, replace=True,
+                                               and_source=True)
 
         # Transfer the contents of the subsection's title to the
         # subtitle:
@@ -220,7 +217,7 @@
     This transform also sets the document's metadata title
     (document'title').
 
-    .. _reStructuredText: http://docutils.sf.net/rst.html
+    .. _reStructuredText: https://docutils.sourceforge.io/rst.html
     """
 
     default_priority = 320
@@ -237,7 +234,8 @@
         if not self.document.hasattr('title'):
             if self.document.settings.title is not None:
                 self.document'title' = self.document.settings.title
-            elif len(self.document) and isinstance(self.document0, nodes.title):
+            elif len(self.document) and isinstance(self.document0,
+                                                   nodes.title):
                 self.document'title' = self.document0.astext()
 
     def apply(self):
@@ -281,10 +279,10 @@
     def apply(self):
         if not self.document.settings.setdefault('sectsubtitle_xform', True):
             return
-        for section in self.document._traverse(nodes.section):
+        for section in self.document.findall(nodes.section):
             # On our way through the node tree, we are modifying it
             # but only the not-yet-visited part, so that the iterator
-            # returned by _traverse() is not corrupted.
+            # returned by findall() is not corrupted.
             self.promote_subtitle(section)
 
 
@@ -359,9 +357,9 @@
       being expanded. Only the "RCSfile" keyword is stable; its
       expansion text changes only if the file name changes.)
 
-    .. _reStructuredText: http://docutils.sf.net/rst.html
+    .. _reStructuredText: https://docutils.sourceforge.io/rst.html
     .. _reStructuredText Markup Specification:
-       http://docutils.sf.net/docs/ref/rst/restructuredtext.html
+       https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
     """
 
     default_priority = 340
@@ -393,7 +391,7 @@
         candidate = documentindex
         if isinstance(candidate, nodes.field_list):
             biblioindex = document.first_child_not_matching_class(
-                  (nodes.Titular, nodes.Decorative))
+                  (nodes.Titular, nodes.Decorative, nodes.meta))
             nodelist = self.extract_bibliographic(candidate)
             del documentindex         # untransformed field list (candidate)
             documentbiblioindex:biblioindex = nodelist
@@ -427,7 +425,7 @@
                             base_node=field)
                         raise TransformError
                     title = nodes.title(name, labelscanonical)
-                    title0.rawsource =  labelscanonical
+                    title0.rawsource = labelscanonical
                     topicscanonical = biblioclass(
                         '', title, classes=canonical, *field1.children)
                 else:
@@ -453,30 +451,48 @@
     def check_empty_biblio_field(self, field, name):
         if len(field-1) < 1:
             field-1 += self.document.reporter.warning(
-                  'Cannot extract empty bibliographic field "%s".' % name,
+                  f'Cannot extract empty bibliographic field "{name}".',
                   base_node=field)
-            return None
-        return 1
+            return False
+        return True
 
     def check_compound_biblio_field(self, field, name):
-        if len(field-1) > 1:
-            field-1 += self.document.reporter.warning(
-                  'Cannot extract compound bibliographic field "%s".' % name,
-                  base_node=field)
-            return None
-        if not isinstance(field-10, nodes.paragraph):
-            field-1 += self.document.reporter.warning(
-                  'Cannot extract bibliographic field "%s" containing '
-                  'anything other than a single paragraph.' % name,
-                  base_node=field)
-            return None
-        return 1
+        # Check that the `field` body contains a single paragraph
+        # (i.e. it must *not* be a compound element).
+        f_body = field-1
+        if len(f_body) == 1 and isinstance(f_body0, nodes.paragraph):
+            return True
+        # Restore single author name with initial (E. Xampl) parsed as
+        # enumerated list
+        # https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists
+        if (isinstance(f_body0, nodes.enumerated_list)
+            and '\n' not in f_body.rawsource.strip()):
+            # parse into a dummy document and use created nodes
+            _document = utils.new_document('*DocInfo transform*',
+                                           field.document.settings)
+            parser = parsers.rst.Parser()
+            parser.parse('\\'+f_body.rawsource, _document)
+            if (len(_document.children) == 1
+                and isinstance(_document.children0, nodes.paragraph)):
+                f_body.children = _document.children
+                return True
+        # Check failed, add a warning
+        content = f'<{e.tagname}>' for e in f_body.children
+        if len(content) > 1:
+            content = '' + ', '.join(content) + ''
+        else:
+            content = 'a ' + content0
+        f_body += self.document.reporter.warning(
+                      f'Bibliographic field "{name}"\nmust contain '
+                      f'a single <paragraph>, not {content}.',
+                      base_node=field)
+        return False
 
     rcs_keyword_substitutions = 
           (re.compile(r'\$' r'Date: (\d\d\d\d)-/(\d\d)-/(\d\d) T\d:+'
                       r'^$* \$', re.IGNORECASE), r'\1-\2-\3'),
           (re.compile(r'\$' r'RCSfile: (.+),v \$', re.IGNORECASE), r'\1'),
-          (re.compile(r'\$a-zA-Z+: (.+) \$'), r'\1'),
+          (re.compile(r'\$a-zA-Z+: (.+) \$'), r'\1')
 
     def extract_authors(self, field, name, docinfo):
         try:
@@ -497,23 +513,26 @@
                 raise TransformError
         except TransformError:
             field-1 += self.document.reporter.warning(
-                  'Bibliographic field "%s" incompatible with extraction: '
-                  'it must contain either a single paragraph (with authors '
-                  'separated by one of "%s"), multiple paragraphs (one per '
-                  'author), or a bullet list with one paragraph (one author) '
-                  'per item.'
-                  % (name, ''.join(self.language.author_separators)),
-                  base_node=field)
+                f'Cannot extract "{name}" from bibliographic field:\n'
+                f'Bibliographic field "{name}" must contain either\n'
+                ' a single paragraph (with author names separated by one of '
+                f'"{"".join(self.language.author_separators)}"),\n'
+                ' multiple paragraphs (one per author),\n'
+                ' or a bullet list with one author name per item.\n'
+                'Note: Leading initials can cause (mis)recognizing names '
+                'as enumerated list.',
+                base_node=field)
             raise
 
     def authors_from_one_paragraph(self, field):
-        """Return list of Text nodes for authornames.
+        """Return list of Text nodes with author names in `field`.
 
-        The set of separators is locale dependent (default: ";"- or ",").
+        Author names must be separated by one of the "autor separators"
+        defined for the document language (default: ";" or ",").
         """
         # @@ keep original formatting? (e.g. ``:authors: A. Test, *et-al*``)
-        text = ''.join(unicode(node)
-                       for node in field1.traverse(nodes.Text))
+        text = ''.join(str(node)
+                       for node in field1.findall(nodes.Text))
         if not text:
             raise TransformError
         for authorsep in self.language.author_separators:
@@ -523,9 +542,7 @@
             if len(authornames) > 1:
                 break
         authornames = (name.strip() for name in authornames)
-        authors = nodes.Text(name, utils.unescape(name, True))
-                   for name in authornames if name
-        return authors
+        return nodes.Text(name) for name in authornames if name
 
     def authors_from_bullet_list(self, field):
         authors =

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/misc.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/misc.py Changed

@@ -1,4 +1,4 @@
-# $Id: misc.py 6314 2010-04-26 10:04:17Z milde $
+# $Id: misc.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,7 +9,7 @@
 __docformat__ = 'reStructuredText'
 
 from docutils import nodes
-from docutils.transforms import Transform, TransformError
+from docutils.transforms import Transform
 
 
 class CallBack(Transform):
@@ -49,8 +49,8 @@
             # Check for appropriate following siblings:
             for index in range(parent.index(child) + 1, len(parent)):
                 element = parentindex
-                if (isinstance(element, nodes.Invisible) or
-                    isinstance(element, nodes.system_message)):
+                if (isinstance(element, nodes.Invisible)
+                    or isinstance(element, nodes.system_message)):
                     continue
                 element'classes' += pending.details'class'
                 pending.parent.remove(pending)
@@ -94,19 +94,19 @@
     default_priority = 830
 
     def apply(self):
-        for node in self.document.traverse(nodes.transition):
+        for node in self.document.findall(nodes.transition):
             self.visit_transition(node)
 
     def visit_transition(self, node):
         index = node.parent.index(node)
         error = None
-        if (index == 0 or
-            isinstance(node.parent0, nodes.title) and
-            (index == 1 or
-             isinstance(node.parent1, nodes.subtitle) and
-             index == 2)):
-            assert (isinstance(node.parent, nodes.document) or
-                    isinstance(node.parent, nodes.section))
+        if (index == 0
+            or isinstance(node.parent0, nodes.title)
+            and (index == 1
+                 or isinstance(node.parent1, nodes.subtitle)
+                 and index == 2)):
+            assert (isinstance(node.parent, nodes.document)
+                    or isinstance(node.parent, nodes.section))
             error = self.document.reporter.error(
                 'Document or section may not begin with a transition.',
                 source=node.source, line=node.line)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/parts.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/parts.py Changed

@@ -1,4 +1,4 @@
-# $Id: parts.py 8671 2021-04-07 12:09:51Z milde $
+# $Id: parts.py 9038 2022-03-05 23:31:46Z milde $
 # Authors: David Goodger <goodger@python.org>; Ueli Schlaepfer; Dmitry Jemerov
 # Copyright: This module has been placed in the public domain.
 
@@ -9,10 +9,9 @@
 __docformat__ = 'reStructuredText'
 
 
-import re
 import sys
-from docutils import nodes, utils
-from docutils.transforms import TransformError, Transform
+from docutils import nodes
+from docutils.transforms import Transform
 
 
 class SectNum(Transform):
@@ -39,7 +38,7 @@
             if self.maxdepth is None:
                 self.maxdepth = sys.maxsize
             self.update_section_numbers(self.document)
-        else: # store details for eventual section numbering by the writer
+        else:  # store details for eventual section numbering by the writer
             self.document.settings.sectnum_depth = self.maxdepth
             self.document.settings.sectnum_start = self.startvalue
             self.document.settings.sectnum_prefix = self.prefix
@@ -58,7 +57,7 @@
                 # Use &nbsp; for spacing:
                 generated = nodes.generated(
                     '', (self.prefix + '.'.join(numbers) + self.suffix
-                         +  u'\u00a0' * 3),
+                         + '\u00a0' * 3),
                     classes='sectnum')
                 title.insert(0, generated)
                 title'auto' = 1
@@ -117,7 +116,6 @@
         level += 1
         sections = sect for sect in node if isinstance(sect, nodes.section)
         entries = 
-        autonum = 0
         depth = self.startnode.details.get('depth', sys.maxsize)
         for section in sections:
             title = section0
@@ -129,8 +127,8 @@
                                           suggested_prefix='toc-entry')
             entry = nodes.paragraph('', '', reference)
             item = nodes.list_item('', entry)
-            if ( self.backlinks in ('entry', 'top')
-                 and title.next_node(nodes.reference) is None):
+            if (self.backlinks in ('entry', 'top')
+                and title.next_node(nodes.reference) is None):
                 if self.backlinks == 'entry':
                     title'refid' = ref_id
                 elif self.backlinks == 'top':
@@ -141,7 +139,7 @@
             entries.append(item)
         if entries:
             contents = nodes.bullet_list('', *entries)
-            if auto:
+            if auto:  # auto-numbered sections
                 contents'classes'.append('auto-toc')
             return contents
         else:

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/peps.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/peps.py Changed

@@ -1,4 +1,4 @@
-# $Id: peps.py 8527 2020-07-14 16:41:15Z milde $
+# $Id: peps.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -13,13 +13,12 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
 import os
 import re
 import time
 from docutils import nodes, utils, languages
-from docutils import ApplicationError, DataError
-from docutils.transforms import Transform, TransformError
+from docutils import DataError
+from docutils.transforms import Transform
 from docutils.transforms import parts, references, misc
 
 
@@ -43,13 +42,13 @@
             # @@@ replace these DataErrors with proper system messages
             raise DataError('Document tree is empty.')
         header = self.document0
-        if not isinstance(header, nodes.field_list) or \
-              'rfc2822' not in header'classes':
+        if (not isinstance(header, nodes.field_list)
+            or 'rfc2822' not in header'classes'):
             raise DataError('Document does not begin with an RFC-2822 '
                             'header; it is not a PEP.')
         pep = None
         for field in header:
-            if field0.astext().lower() == 'pep': # should be the first field
+            if field0.astext().lower() == 'pep':  # should be the first field
                 value = field1.astext()
                 try:
                     pep = int(value)
@@ -123,7 +122,7 @@
                         refuri=(self.document.settings.pep_base_url
                                 + self.pep_url % pepno)))
                     newbody.append(space)
-                para: = newbody:-1 # drop trailing space
+                para: = newbody:-1  # drop trailing space
             elif name == 'last-modified':
                 utils.clean_rcs_keywords(para, self.rcs_keyword_substitutions)
                 if cvs_url:
@@ -218,7 +217,7 @@
     Special processing for PEP 0.
     """
 
-    default_priority =760
+    default_priority = 760
 
     def apply(self):
         visitor = PEPZeroSpecial(self.document)
@@ -281,6 +280,7 @@
                         'python-list@python.org',
                         'python-dev@python.org')
 
+
 def mask_email(ref, pepno=None):
     """
     Mask the email address in `ref` and return a replacement node.

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/references.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/references.py Changed

@@ -1,4 +1,4 @@
-# $Id: references.py 8565 2020-09-14 10:26:03Z milde $
+# $Id: references.py 9312 2022-12-19 20:43:08Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,10 +8,8 @@
 
 __docformat__ = 'reStructuredText'
 
-import sys
-import re
 from docutils import nodes, utils
-from docutils.transforms import TransformError, Transform
+from docutils.transforms import Transform
 
 
 class PropagateTargets(Transform):
@@ -40,49 +38,52 @@
     default_priority = 260
 
     def apply(self):
-        for target in self.document.traverse(nodes.target):
-            # Only block-level targets without reference (like ".. target:"):
-            if (isinstance(target.parent, nodes.TextElement) or
-                (target.hasattr('refid') or target.hasattr('refuri') or
-                 target.hasattr('refname'))):
+        for target in self.document.findall(nodes.target):
+            # Only block-level targets without reference (like ".. _target:"):
+            if (isinstance(target.parent, nodes.TextElement)
+                or (target.hasattr('refid') or target.hasattr('refuri')
+                    or target.hasattr('refname'))):
                 continue
             assert len(target) == 0, 'error: block-level target has children'
             next_node = target.next_node(ascend=True)
+            # skip system messages (may be removed by universal.FilterMessages)
+            while isinstance(next_node, nodes.system_message):
+                next_node = next_node.next_node(ascend=True, descend=False)
             # Do not move names and ids into Invisibles (we'd lose the
             # attributes) or different Targetables (e.g. footnotes).
-            if (next_node is not None and
-                ((not isinstance(next_node, nodes.Invisible) and
-                  not isinstance(next_node, nodes.Targetable)) or
-                 isinstance(next_node, nodes.target))):
-                next_node'ids'.extend(target'ids')
-                next_node'names'.extend(target'names')
-                # Set defaults for next_node.expect_referenced_by_name/id.
-                if not hasattr(next_node, 'expect_referenced_by_name'):
-                    next_node.expect_referenced_by_name = {}
-                if not hasattr(next_node, 'expect_referenced_by_id'):
-                    next_node.expect_referenced_by_id = {}
-                for id in target'ids':
-                    # Update IDs to node mapping.
-                    self.document.idsid = next_node
-                    # If next_node is referenced by id ``id``, this
-                    # target shall be marked as referenced.
-                    next_node.expect_referenced_by_idid = target
-                for name in target'names':
-                    next_node.expect_referenced_by_namename = target
-                # If there are any expect_referenced_by_... attributes
-                # in target set, copy them to next_node.
-                next_node.expect_referenced_by_name.update(
-                    getattr(target, 'expect_referenced_by_name', {}))
-                next_node.expect_referenced_by_id.update(
-                    getattr(target, 'expect_referenced_by_id', {}))
-                # Set refid to point to the first former ID of target
-                # which is now an ID of next_node.
-                target'refid' = target'ids'0
-                # Clear ids and names; they have been moved to
-                # next_node.
-                target'ids' = 
-                target'names' = 
-                self.document.note_refid(target)
+            if (next_node is None
+                or isinstance(next_node, (nodes.Invisible, nodes.Targetable))
+                and not isinstance(next_node, nodes.target)):
+                continue
+            next_node'ids'.extend(target'ids')
+            next_node'names'.extend(target'names')
+            # Set defaults for next_node.expect_referenced_by_name/id.
+            if not hasattr(next_node, 'expect_referenced_by_name'):
+                next_node.expect_referenced_by_name = {}
+            if not hasattr(next_node, 'expect_referenced_by_id'):
+                next_node.expect_referenced_by_id = {}
+            for id in target'ids':
+                # Update IDs to node mapping.
+                self.document.idsid = next_node
+                # If next_node is referenced by id ``id``, this
+                # target shall be marked as referenced.
+                next_node.expect_referenced_by_idid = target
+            for name in target'names':
+                next_node.expect_referenced_by_namename = target
+            # If there are any expect_referenced_by_... attributes
+            # in target set, copy them to next_node.
+            next_node.expect_referenced_by_name.update(
+                getattr(target, 'expect_referenced_by_name', {}))
+            next_node.expect_referenced_by_id.update(
+                getattr(target, 'expect_referenced_by_id', {}))
+            # Set refid to point to the first former ID of target
+            # which is now an ID of next_node.
+            target'refid' = target'ids'0
+            # Clear ids and names; they have been moved to
+            # next_node.
+            target'ids' = 
+            target'names' = 
+            self.document.note_refid(target)
 
 
 class AnonymousHyperlinks(Transform):
@@ -114,14 +115,13 @@
     def apply(self):
         anonymous_refs = 
         anonymous_targets = 
-        for node in self.document.traverse(nodes.reference):
+        for node in self.document.findall(nodes.reference):
             if node.get('anonymous'):
                 anonymous_refs.append(node)
-        for node in self.document.traverse(nodes.target):
+        for node in self.document.findall(nodes.target):
             if node.get('anonymous'):
                 anonymous_targets.append(node)
-        if len(anonymous_refs) \
-              != len(anonymous_targets):
+        if len(anonymous_refs) != len(anonymous_targets):
             msg = self.document.reporter.error(
                   'Anonymous hyperlink mismatch: %s references but %s '
                   'targets.\nSee "backrefs" attribute for IDs.'
@@ -228,15 +228,14 @@
                 return
         reftarget = self.document.idsreftarget_id
         reftarget.note_referenced_by(id=reftarget_id)
-        if isinstance(reftarget, nodes.target) \
-               and not reftarget.resolved and reftarget.hasattr('refname'):
+        if (isinstance(reftarget, nodes.target)
+            and not reftarget.resolved
+            and reftarget.hasattr('refname')):
             if hasattr(target, 'multiply_indirect'):
-                #and target.multiply_indirect):
-                #del target.multiply_indirect
                 self.circular_indirect_reference(target)
                 return
             target.multiply_indirect = 1
-            self.resolve_indirect_target(reftarget) # multiply indirect
+            self.resolve_indirect_target(reftarget)  # multiply indirect
             del target.multiply_indirect
         if reftarget.hasattr('refuri'):
             target'refuri' = reftarget'refuri'
@@ -350,7 +349,7 @@
     default_priority = 640
 
     def apply(self):
-        for target in self.document.traverse(nodes.target):
+        for target in self.document.findall(nodes.target):
             if target.hasattr('refuri'):
                 refuri = target'refuri'
                 for name in target'names':
@@ -370,7 +369,7 @@
     default_priority = 660
 
     def apply(self):
-        for target in self.document.traverse(nodes.target):
+        for target in self.document.findall(nodes.target):
             if not target.hasattr('refuri') and not target.hasattr('refid'):
                 self.resolve_reference_ids(target)
 
@@ -415,10 +414,10 @@
 
         <document>
             <paragraph>
-                A labeled autonumbered footnote referece:
+                A labeled autonumbered footnote reference:
                 <footnote_reference auto="1" id="id1" refname="footnote">
             <paragraph>
-                An unlabeled autonumbered footnote referece:
+                An unlabeled autonumbered footnote reference:
                 <footnote_reference auto="1" id="id2">
             <footnote auto="1" id="id3">
                 <paragraph>
@@ -437,11 +436,11 @@
 
         <document>
             <paragraph>
-                A labeled autonumbered footnote referece:
+                A labeled autonumbered footnote reference:
                 <footnote_reference auto="1" id="id1" refid="footnote">
                     2
             <paragraph>
-                An unlabeled autonumbered footnote referece:
+                An unlabeled autonumbered footnote reference:
                 <footnote_reference auto="1" id="id2" refid="id3">
                     1
             <footnote auto="1" id="id3" backrefs="id2">
@@ -475,17 +474,17 @@
           # Entries 1-4 and 6 below are from section 12.51 of
           # The Chicago Manual of Style, 14th edition.
           '*',                          # asterisk/star
-          u'\u2020',                    # dagger &dagger;
-          u'\u2021',                    # double dagger &Dagger;
-          u'\u00A7',                    # section mark &sect;
-          u'\u00B6',                    # paragraph mark (pilcrow) &para;
+          '\u2020',                    # † &dagger; dagger
+          '\u2021',                    # ‡ &Dagger; double dagger
+          '\u00A7',                    # § &sect; section mark
+          '\u00B6',                    # ¶ &para; paragraph mark (pilcrow)
                                         # (parallels '||' in CMoS)
           '#',                          # number sign
           # The entries below were chosen arbitrarily.
-          u'\u2660',                    # spade suit &spades;
-          u'\u2665',                    # heart suit &hearts;
-          u'\u2666',                    # diamond suit &diams;
-          u'\u2663',                    # club suit &clubs;
+          '\u2660',                    # ♠ &spades; spade suit
+          '\u2665',                    # ♡ &hearts; heart suit
+          '\u2666',                    # ♢ &diams; diamond suit
+          '\u2663',                    # ♣ &clubs; club suit
           
 
     def apply(self):
@@ -625,7 +624,8 @@
         note.resolved = 1
 
 
-class CircularSubstitutionDefinitionError(Exception): pass
+class CircularSubstitutionDefinitionError(Exception):
+    pass
 
 
 class Substitutions(Transform):
@@ -658,7 +658,7 @@
 
     default_priority = 220
     """The Substitutions transform has to be applied very early, before
-    `docutils.tranforms.frontmatter.DocTitle` and others."""
+    `docutils.transforms.frontmatter.DocTitle` and others."""
 
     def apply(self):
         defs = self.document.substitution_defs
@@ -667,7 +667,7 @@
         line_length_limit = getattr(self.document.settings,
                                     "line_length_limit", 10000)
 
-        subreflist = list(self.document.traverse(nodes.substitution_reference))
+        subreflist = list(self.document.findall(nodes.substitution_reference))
         for ref in subreflist:
             msg = ''
             refname = ref'refname'
@@ -685,7 +685,7 @@
                 if len(subdef.astext()) > line_length_limit:
                     msg = self.document.reporter.error(
                             'Substitution definition "%s" exceeds the'
-                            ' line-length-limit.' % (key))
+                            ' line-length-limit.' % key)
             if msg:
                 msgid = self.document.set_id(msg)
                 prb = nodes.problematic(
@@ -697,20 +697,20 @@
 
             parent = ref.parent
             index = parent.index(ref)
-            if  ('ltrim' in subdef.attributes
-                    or 'trim' in subdef.attributes):
+            if ('ltrim' in subdef.attributes
+                or 'trim' in subdef.attributes):
                 if index > 0 and isinstance(parentindex - 1,
                                             nodes.Text):
                     parentindex - 1 = parentindex - 1.rstrip()
-            if  ('rtrim' in subdef.attributes
-                    or 'trim' in subdef.attributes):
-                if  (len(parent) > index + 1
-                        and isinstance(parentindex + 1, nodes.Text)):
+            if ('rtrim' in subdef.attributes
+                or 'trim' in subdef.attributes):
+                if (len(parent) > index + 1
+                    and isinstance(parentindex + 1, nodes.Text)):
                     parentindex + 1 = parentindex + 1.lstrip()
             subdef_copy = subdef.deepcopy()
             try:
                 # Take care of nested substitution references:
-                for nested_ref in subdef_copy.traverse(
+                for nested_ref in subdef_copy.findall(
                         nodes.substitution_reference):
                     nested_name = normednested_ref'refname'.lower()
                     if nested_name in nested.setdefault(nested_name, ):
@@ -743,7 +743,7 @@
                     ref.replace_self(prb)
                 continue
             ref.replace_self(subdef_copy.children)
-            # register refname of the replacment node(s)
+            # register refname of the replacement node(s)
             # (needed for resolution of references)
             for node in subdef_copy.children:
                 if isinstance(node, nodes.Referential):
@@ -764,7 +764,6 @@
     """The TargetNotes transform has to be applied after `IndirectHyperlinks`
     but before `Footnotes`."""
 
-
     def __init__(self, document, startnode):
         Transform.__init__(self, document, startnode=startnode)
 
@@ -773,7 +772,7 @@
     def apply(self):
         notes = {}
         nodelist = 
-        for target in self.document.traverse(nodes.target):
+        for target in self.document.findall(nodes.target):
             # Only external targets.
             if not target.hasattr('refuri'):
                 continue
@@ -789,7 +788,7 @@
                 notestarget'refuri' = footnote
                 nodelist.append(footnote)
         # Take care of anonymous references.
-        for ref in self.document.traverse(nodes.reference):
+        for ref in self.document.findall(nodes.reference):
             if not ref.get('anonymous'):
                 continue
             if ref.hasattr('refuri'):
@@ -829,7 +828,8 @@
             reflist = refnode
             if not utils.get_trim_footnote_ref_space(self.document.settings):
                 if self.classes:
-                    reflist.insert(0, nodes.inline(text=' ', Classes=self.classes))
+                    reflist.insert(
+                        0, nodes.inline(text=' ', Classes=self.classes))
                 else:
                     reflist.insert(0, nodes.Text(' '))
             ref.parent.insert(index, reflist)
@@ -852,7 +852,7 @@
         self.document.walk(visitor)
         # *After* resolving all references, check for unreferenced
         # targets:
-        for target in self.document.traverse(nodes.target):
+        for target in self.document.findall(nodes.target):
             if not target.referenced:
                 if target.get('anonymous'):
                     # If we have unreferenced anonymous targets, there
@@ -893,13 +893,18 @@
                 if resolver_function(node):
                     break
             else:
+                if (getattr(self.document.settings, 'use_bibtex', False)
+                    and isinstance(node, nodes.citation_reference)):
+                    # targets added from BibTeX database by LaTeX
+                    node.resolved = True
+                    return
                 if refname in self.document.nameids:
                     msg = self.document.reporter.error(
                         'Duplicate target name, cannot be used as a unique '
                         'reference: "%s".' % (node'refname'), base_node=node)
                 else:
                     msg = self.document.reporter.error(
-                        'Unknown target name: "%s".' % (node'refname'),
+                        f'Unknown target name: "{node"refname"}".',
                         base_node=node)
                 msgid = self.document.set_id(msg)
                 prb = nodes.problematic(
@@ -914,6 +919,6 @@
             del node'refname'
             node'refid' = id
             self.document.idsid.note_referenced_by(id=id)
-            node.resolved = 1
+            node.resolved = True
 
     visit_footnote_reference = visit_citation_reference = visit_reference

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/universal.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/universal.py Changed

@@ -1,5 +1,4 @@
-# $Id: universal.py 8671 2021-04-07 12:09:51Z milde $
-# -*- coding: utf-8 -*-
+# $Id: universal.py 9320 2023-01-17 15:40:15Z milde $
 # Authors: David Goodger <goodger@python.org>; Ueli Schlaepfer; Günter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -8,26 +7,26 @@
 Transforms needed by most or all documents:
 
 - `Decorations`: Generate a document's header & footer.
-- `Messages`: Placement of system messages stored in
-  `nodes.document.transform_messages`.
+- `ExposeInternals`: Expose internal attributes.
+- `Messages`: Placement of system messages generated after parsing.
+- `FilterMessages`: Remove system messages below verbosity threshold.
 - `TestMessages`: Like `Messages`, used on test runs.
-- `FinalReferences`: Resolve remaining references.
+- `StripComments`: Remove comment elements from the document tree.
+- `StripClassesAndElements`: Remove elements with classes
+  in `self.document.settings.strip_elements_with_classes`
+  and class values in `self.document.settings.strip_classes`.
+- `SmartQuotes`: Replace ASCII quotation marks with typographic form.
 """
 
 __docformat__ = 'reStructuredText'
 
 import re
-import sys
 import time
 from docutils import nodes, utils
-from docutils.transforms import TransformError, Transform
+from docutils.transforms import Transform
 from docutils.utils import smartquotes
 
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
 class Decorations(Transform):
 
     """
@@ -59,11 +58,11 @@
         # See https://sourceforge.net/p/docutils/patches/132/
         # and https://reproducible-builds.org/specs/source-date-epoch/
         settings = self.document.settings
-        if settings.generator or settings.datestamp or settings.source_link \
-               or settings.source_url:
+        if (settings.generator or settings.datestamp
+            or settings.source_link or settings.source_url):
             text = 
-            if settings.source_link and settings._source \
-                   or settings.source_url:
+            if (settings.source_link and settings._source
+                or settings.source_url):
                 if settings.source_url:
                     source = settings.source_url
                 else:
@@ -79,11 +78,12 @@
             if settings.generator:
                 text.extend(
                     nodes.Text('Generated by '),
-                    nodes.reference('', 'Docutils', refuri=
-                                    'http://docutils.sourceforge.net/'),
+                    nodes.reference('', 'Docutils',
+                                    refuri='https://docutils.sourceforge.io/'),
                     nodes.Text(' from '),
-                    nodes.reference('', 'reStructuredText', refuri='http://'
-                                    'docutils.sourceforge.net/rst.html'),
+                    nodes.reference('', 'reStructuredText',
+                                    refuri='https://docutils.sourceforge.io/'
+                                    'rst.html'),
                     nodes.Text(' source.\n'))
             return nodes.paragraph('', '', *text)
         else:
@@ -103,7 +103,7 @@
 
     def apply(self):
         if self.document.settings.expose_internals:
-            for node in self.document.traverse(self.not_Text):
+            for node in self.document.findall(self.not_Text):
                 for att in self.document.settings.expose_internals:
                     value = getattr(node, att, None)
                     if value is not None:
@@ -120,33 +120,48 @@
     default_priority = 860
 
     def apply(self):
-        unfiltered = self.document.transform_messages
-        threshold = self.document.reporter.report_level
-        messages = 
-        for msg in unfiltered:
-            if msg'level' >= threshold and not msg.parent:
-                messages.append(msg)
-        if messages:
+        messages = self.document.transform_messages
+        loose_messages = msg for msg in messages if not msg.parent
+        if loose_messages:
             section = nodes.section(classes='system-messages')
             # @@@ get this from the language module?
             section += nodes.title('', 'Docutils System Messages')
-            section += messages
+            section += loose_messages
             self.document.transform_messages: = 
             self.document += section
 
 
+# TODO: fix bug #435:
+
+# Messages are filtered at a very late stage
+# This breaks the link from inline error messages to the corresponding
+# system message at the end of document.
+
 class FilterMessages(Transform):
 
     """
     Remove system messages below verbosity threshold.
+
+    Convert <problematic> nodes referencing removed messages to <Text>.
+    Remove "System Messages" section if empty.
     """
 
     default_priority = 870
 
     def apply(self):
-        for node in tuple(self.document.traverse(nodes.system_message)):
+        for node in tuple(self.document.findall(nodes.system_message)):
             if node'level' < self.document.reporter.report_level:
                 node.parent.remove(node)
+                try:  # also remove id-entry
+                    del self.document.idsnode'ids'0
+                except (IndexError):
+                    pass
+        for node in tuple(self.document.findall(nodes.problematic)):
+            if node'refid' not in self.document.ids:
+                node.parent.replace(node, nodes.Text(node.astext()))
+        for node in self.document.findall(nodes.section):
+            if "system-messages" in node'classes' and len(node) == 1:
+                node.parent.remove(node)
 
 
 class TestMessages(Transform):
@@ -157,6 +172,9 @@
     Used for testing purposes.
     """
 
+    # marker for pytest to ignore this class during test discovery
+    __test__ = False
+
     default_priority = 880
 
     def apply(self):
@@ -176,7 +194,7 @@
 
     def apply(self):
         if self.document.settings.strip_comments:
-            for node in tuple(self.document.traverse(nodes.comment)):
+            for node in tuple(self.document.findall(nodes.comment)):
                 node.parent.remove(node)
 
 
@@ -192,17 +210,17 @@
 
     def apply(self):
         if self.document.settings.strip_elements_with_classes:
-            self.strip_elements = set(
-                self.document.settings.strip_elements_with_classes)
+            self.strip_elements = {*self.document.settings
+                                   .strip_elements_with_classes}
             # Iterate over a tuple as removing the current node
-            # corrupts the iterator returned by `traverse`:
-            for node in tuple(self.document.traverse(self.check_classes)):
+            # corrupts the iterator returned by `iter`:
+            for node in tuple(self.document.findall(self.check_classes)):
                 node.parent.remove(node)
 
         if not self.document.settings.strip_classes:
             return
         strip_classes = self.document.settings.strip_classes
-        for node in self.document.traverse(nodes.Element):
+        for node in self.document.findall(nodes.Element):
             for class_value in strip_classes:
                 try:
                     node'classes'.remove(class_value)
@@ -226,7 +244,7 @@
     Also replace multiple dashes with em-dash/en-dash characters.
     """
 
-    default_priority = 850
+    default_priority = 855
 
     nodes_to_skip = (nodes.FixedTextElement, nodes.Special)
     """Do not apply "smartquotes" to instances of these block-level nodes."""
@@ -234,7 +252,7 @@
     literal_nodes = (nodes.FixedTextElement, nodes.Special,
                      nodes.image, nodes.literal, nodes.math,
                      nodes.raw, nodes.problematic)
-    """Do apply smartquotes to instances of these inline nodes."""
+    """Do not apply smartquotes to instances of these inline nodes."""
 
     smartquotes_action = 'qDe'
     """Setting to select smartquote transformations.
@@ -253,15 +271,16 @@
         for node in txtnodes:
             if (isinstance(node.parent, self.literal_nodes)
                 or isinstance(node.parent.parent, self.literal_nodes)):
-                yield ('literal', unicode(node))
+                yield 'literal', str(node)
             else:
                 # SmartQuotes uses backslash escapes instead of null-escapes
-                txt = re.sub('(?<=\x00)(-\\\'".`)', r'\\\1', unicode(node))
-                yield ('plain', txt)
+                # Insert backslashes before escaped "active" characters.
+                txt = re.sub('(?<=\x00)(-\\\'".`)', r'\\\1', str(node))
+                yield 'plain', txt
 
     def apply(self):
         smart_quotes = self.document.settings.setdefault('smart_quotes',
-                                                           False)
+                                                         False)
         if not smart_quotes:
             return
         try:
@@ -276,7 +295,7 @@
 
         # "Educate" quotes in normal text. Handle each block of text
         # (TextElement node) as a unit to keep context around inline nodes:
-        for node in self.document.traverse(nodes.TextElement):
+        for node in self.document.findall(nodes.TextElement):
             # skip preformatted text blocks and special elements:
             if isinstance(node, self.nodes_to_skip):
                 continue
@@ -285,7 +304,7 @@
                 continue
 
             # list of text nodes in the "text block":
-            txtnodes = txtnode for txtnode in node.traverse(nodes.Text)
+            txtnodes = txtnode for txtnode in node.findall(nodes.Text)
                         if not isinstance(txtnode.parent,
                                           nodes.option_string)
 
@@ -302,20 +321,21 @@
                 if tag in smartquotes.smartchars.quotes:
                     lang = tag
                     break
-            else: # language not supported: (keep ASCII quotes)
+            else:  # language not supported -- keep ASCII quotes
                 if lang not in self.unsupported_languages:
-                    self.document.reporter.warning('No smart quotes '
-                        'defined for language "%s".'%lang, base_node=node)
+                    self.document.reporter.warning(
+                        'No smart quotes defined for language "%s".' % lang,
+                        base_node=node)
                 self.unsupported_languages.add(lang)
                 lang = ''
 
             # Iterator educating quotes in plain text:
             # (see "utils/smartquotes.py" for the attribute setting)
-            teacher = smartquotes.educate_tokens(self.get_tokens(txtnodes),
-                                attr=self.smartquotes_action, language=lang)
+            teacher = smartquotes.educate_tokens(
+                self.get_tokens(txtnodes),
+                attr=self.smartquotes_action, language=lang)
 
             for txtnode, newtext in zip(txtnodes, teacher):
-                txtnode.parent.replace(txtnode, nodes.Text(newtext,
-                                       rawsource=txtnode.rawsource))
+                txtnode.parent.replace(txtnode, nodes.Text(newtext))
 
-        self.unsupported_languages = set() # reset
+        self.unsupported_languages.clear()

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/transforms/writer_aux.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/transforms/writer_aux.py Changed

@@ -1,4 +1,4 @@
-# $Id: writer_aux.py 7808 2015-02-27 17:03:32Z milde $
+# $Id: writer_aux.py 9037 2022-03-05 23:31:10Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -14,13 +14,18 @@
 
 __docformat__ = 'reStructuredText'
 
-from docutils import nodes, utils, languages
+import warnings
+
+from docutils import nodes, languages
 from docutils.transforms import Transform
 
 
 class Compound(Transform):
 
     """
+    .. warning:: This transform is not used by Docutils since Dec 2010
+                 and will be removed in Docutils 0.21 or later.
+
     Flatten all compound paragraphs.  For example, transform ::
 
         <compound>
@@ -37,8 +42,14 @@
 
     default_priority = 910
 
+    def __init__(self, document, startnode=None):
+        warnings.warn('docutils.transforms.writer_aux.Compound is deprecated'
+                      ' and will be removed in Docutils 0.21 or later.',
+                      DeprecationWarning, stacklevel=2)
+        super().__init__(document, startnode)
+
     def apply(self):
-        for compound in self.document.traverse(nodes.compound):
+        for compound in self.document.findall(nodes.compound):
             first_child = True
             for child in compound:
                 if first_child:
@@ -75,7 +86,7 @@
     def apply(self):
         language = languages.get_language(self.document.settings.language_code,
                                           self.document.reporter)
-        for node in self.document.traverse(nodes.Admonition):
+        for node in self.document.findall(nodes.Admonition):
             node_name = node.__class__.__name__
             # Set class, so that we know what node this admonition came from.
             node'classes'.append(node_name)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/__init__.py Changed

@@ -1,5 +1,4 @@
-# coding: utf-8
-# $Id: __init__.py 8672 2021-04-07 12:10:06Z milde $
+# $Id: __init__.py 9283 2022-11-28 23:55:57Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -12,18 +11,16 @@
 import sys
 import os
 import os.path
+from pathlib import PurePath, Path
 import re
 import itertools
 import warnings
 import unicodedata
-from docutils import ApplicationError, DataError, __version_info__
-from docutils import nodes
-from docutils.nodes import unescape
-import docutils.io
-from docutils.utils.error_reporting import ErrorOutput, SafeString
 
-if sys.version_info >= (3, 0):
-    unicode = str
+from docutils import ApplicationError, DataError, __version_info__
+from docutils import io, nodes
+# for backwards compatibility
+from docutils.nodes import unescape  # noqa: F401
 
 
 class SystemMessage(ApplicationError):
@@ -33,10 +30,11 @@
         self.level = level
 
 
-class SystemMessagePropagation(ApplicationError): pass
+class SystemMessagePropagation(ApplicationError):
+    pass
 
 
-class Reporter(object):
+class Reporter:
 
     """
     Info/warning/error reporter and ``system_message`` element generator.
@@ -112,8 +110,8 @@
         """The level at or above which `SystemMessage` exceptions
         will be raised, halting execution."""
 
-        if not isinstance(stream, ErrorOutput):
-            stream = ErrorOutput(stream, encoding, error_handler)
+        if not isinstance(stream, io.ErrorOutput):
+            stream = io.ErrorOutput(stream, encoding, error_handler)
 
         self.stream = stream
         """Where warning output is sent."""
@@ -130,13 +128,14 @@
 
     def set_conditions(self, category, report_level, halt_level,
                        stream=None, debug=False):
-        warnings.warn('docutils.utils.Reporter.set_conditions deprecated; '
-                      'set attributes via configuration settings or directly',
+        warnings.warn('docutils.utils.Reporter.set_conditions() deprecated; '
+                      'Will be removed in Docutils 0.21 or later. '
+                      'Set attributes via configuration settings or directly.',
                       DeprecationWarning, stacklevel=2)
         self.report_level = report_level
         self.halt_level = halt_level
-        if not isinstance(stream, ErrorOutput):
-            stream = ErrorOutput(stream, self.encoding, self.error_handler)
+        if not isinstance(stream, io.ErrorOutput):
+            stream = io.ErrorOutput(stream, self.encoding, self.error_handler)
         self.stream = stream
         self.debug_flag = debug
 
@@ -160,9 +159,9 @@
 
         Raise an exception or generate a warning if appropriate.
         """
-        # `message` can be a `string`, `unicode`, or `Exception` instance.
+        # `message` can be a `str` or `Exception` instance.
         if isinstance(message, Exception):
-            message = SafeString(message)
+            message = str(message)
 
         attributes = kwargs.copy()
         if 'base_node' in kwargs:
@@ -172,9 +171,10 @@
                 attributes.setdefault('source', source)
             if line is not None:
                 attributes.setdefault('line', line)
-                # assert source is not None, "node has line- but no source-argument"
-        if not 'source' in attributes: # 'line' is absolute line number
-            try: # look up (source, line-in-source)
+                # assert source is not None, "line- but no source-argument"
+        if 'source' not in attributes:
+            # 'line' is absolute line number
+            try:
                 source, line = self.get_source_and_line(attributes.get('line'))
             except AttributeError:
                 source, line = None, None
@@ -267,8 +267,8 @@
           missing data, bad quotes, etc.).
     """
     option_list = extract_options(field_list)
-    option_dict = assemble_option_dict(option_list, options_spec)
-    return option_dict
+    return assemble_option_dict(option_list, options_spec)
+
 
 def extract_options(field_list):
     """
@@ -292,8 +292,10 @@
         body = field1
         if len(body) == 0:
             data = None
-        elif len(body) > 1 or not isinstance(body0, nodes.paragraph) \
-              or len(body0) != 1 or not isinstance(body00, nodes.Text):
+        elif (len(body) > 1
+              or not isinstance(body0, nodes.paragraph)
+              or len(body0) != 1
+              or not isinstance(body00, nodes.Text)):
             raise BadOptionDataError(
                   'extension option field body may contain\n'
                   'a single paragraph only (option "%s")' % name)
@@ -302,6 +304,7 @@
         option_list.append((name, data))
     return option_list
 
+
 def assemble_option_dict(option_list, options_spec):
     """
     Return a mapping of option names to values.
@@ -340,26 +343,26 @@
 
 def decode_path(path):
     """
-    Ensure `path` is Unicode. Return `nodes.reprunicode` object.
+    Ensure `path` is Unicode. Return `str` instance.
 
-    Decode file/path string in a failsave manner if not already done.
+    Decode file/path string in a failsafe manner if not already done.
     """
-    # see also http://article.gmane.org/gmane.text.docutils.user/2905
-    if isinstance(path, unicode):
+    # TODO: is this still required with Python 3?
+    if isinstance(path, str):
         return path
     try:
         path = path.decode(sys.getfilesystemencoding(), 'strict')
-    except AttributeError: # default value None has no decode method
+    except AttributeError:  # default value None has no decode method
         if not path:
-            return nodes.reprunicode('')
-        raise ValueError('`path` value must be a String or ``None``, not %r'
-                         %path)
+            return ''
+        raise ValueError('`path` value must be a String or ``None``, '
+                         f'not {path!r}')
     except UnicodeDecodeError:
         try:
             path = path.decode('utf-8', 'strict')
         except UnicodeDecodeError:
             path = path.decode('ascii', 'replace')
-    return nodes.reprunicode(path)
+    return path
 
 
 def extract_name_value(line):
@@ -406,6 +409,7 @@
         attlist.append((attname.lower(), data))
     return attlist
 
+
 def new_reporter(source_path, settings):
     """
     Return a new Reporter object.
@@ -423,6 +427,7 @@
         error_handler=settings.error_encoding_error_handler)
     return reporter
 
+
 def new_document(source_path, settings=None):
     """
     Return a new empty document object.
@@ -433,23 +438,33 @@
         `settings` : optparse.Values object
             Runtime settings.  If none are provided, a default core set will
             be used.  If you will use the document object with any Docutils
-            components, you must provide their default settings as well.  For
-            example, if parsing rST, at least provide the rst-parser settings,
-            obtainable as follows::
+            components, you must provide their default settings as well.
+
+            For example, if parsing rST, at least provide the rst-parser
+            settings, obtainable as follows:
+
+            Defaults for parser component::
+
+                settings = docutils.frontend.get_default_settings(
+                               docutils.parsers.rst.Parser)
+
+            Defaults and configuration file customizations::
+
+                settings = docutils.core.Publisher(
+                    parser=docutils.parsers.rst.Parser).get_settings()
 
-                settings = docutils.frontend.OptionParser(
-                    components=(docutils.parsers.rst.Parser,)
-                    ).get_default_values()
     """
+    # Import at top of module would lead to circular dependency!
     from docutils import frontend
     if settings is None:
-        settings = frontend.OptionParser().get_default_values()
+        settings = frontend.get_default_settings()
     source_path = decode_path(source_path)
     reporter = new_reporter(source_path, settings)
     document = nodes.document(settings, reporter, source=source_path)
     document.note_source(source_path, -1)
     return document
 
+
 def clean_rcs_keywords(paragraph, keyword_substitutions):
     if len(paragraph) == 1 and isinstance(paragraph0, nodes.Text):
         textnode = paragraph0
@@ -459,14 +474,23 @@
                 paragraph0 = nodes.Text(pattern.sub(substitution, textnode))
                 return
 
+
 def relative_path(source, target):
     """
     Build and return a path to `target`, relative to `source` (both files).
 
-    If there is no common prefix, return the absolute path to `target`.
+    Differences to `os.relpath()`:
+
+    * Inverse argument order.
+    * `source` expects path to a FILE (while os.relpath expects a dir)!
+      (Add a "dummy" file name if `source` points to a directory.)
+    * Always use Posix path separator ("/") for the output.
+    * Use `os.sep` for parsing the input (ignored by `os.relpath()`).
+    * If there is no common prefix, return the absolute path to `target`.
+
     """
     source_parts = os.path.abspath(source or type(target)('dummy_file')
-                                  ).split(os.sep)
+                                   ).split(os.sep)
     target_parts = os.path.abspath(target).split(os.sep)
     # Check first 2 parts because '/dir'.split('/') == '', 'dir':
     if source_parts:2 != target_parts:2:
@@ -484,6 +508,7 @@
     parts = '..' * (len(source_parts) - 1) + target_parts
     return '/'.join(parts)
 
+
 def get_stylesheet_reference(settings, relative_to=None):
     """
     Retrieve a stylesheet reference from the settings object.
@@ -492,21 +517,26 @@
     enable specification of multiple stylesheets as a comma-separated
     list.
     """
+    warnings.warn('utils.get_stylesheet_reference()'
+                  ' is obsoleted by utils.get_stylesheet_list()'
+                  ' and will be removed in Docutils 2.0.',
+                  DeprecationWarning, stacklevel=2)
     if settings.stylesheet_path:
         assert not settings.stylesheet, (
             'stylesheet and stylesheet_path are mutually exclusive.')
-        if relative_to == None:
+        if relative_to is None:
             relative_to = settings._destination
         return relative_path(relative_to, settings.stylesheet_path)
     else:
         return settings.stylesheet
 
+
 # Return 'stylesheet' or 'stylesheet_path' arguments as list.
 #
 # The original settings arguments are kept unchanged: you can test
-# with e.g. ``if settings.stylesheet_path:``
+# with e.g. ``if settings.stylesheet_path: ...``.
 #
-# Differences to ``get_stylesheet_reference``:
+# Differences to the depracated `get_stylesheet_reference()`:
 # * return value is a list
 # * no re-writing of the path (and therefore no optional argument)
 #   (if required, use ``utils.relative_path(source, target)``
@@ -518,12 +548,15 @@
     assert not (settings.stylesheet and settings.stylesheet_path), (
             'stylesheet and stylesheet_path are mutually exclusive.')
     stylesheets = settings.stylesheet_path or settings.stylesheet or 
-    # programmatically set default can be string or unicode:
+    # programmatically set default may be string with comma separated list:
     if not isinstance(stylesheets, list):
         stylesheets = path.strip() for path in stylesheets.split(',')
-    # expand relative paths if found in stylesheet-dirs:
-    return find_file_in_dirs(path, settings.stylesheet_dirs)
-            for path in stylesheets
+    if settings.stylesheet_path:
+        # expand relative paths if found in stylesheet-dirs:
+        stylesheets = find_file_in_dirs(path, settings.stylesheet_dirs)
+                       for path in stylesheets
+    return stylesheets
+
 
 def find_file_in_dirs(path, dirs):
     """
@@ -531,17 +564,15 @@
 
     Return the first expansion that matches an existing file.
     """
-    if os.path.isabs(path):
-        return path
+    path = Path(path)
+    if path.is_absolute():
+        return path.as_posix()
     for d in dirs:
-        if d == '.':
-            f = path
-        else:
-            d = os.path.expanduser(d)
-            f = os.path.join(d, path)
-        if os.path.exists(f):
-            return f
-    return path
+        f = Path(d).expanduser() / path
+        if f.exists():
+            return f.as_posix()
+    return path.as_posix()
+
 
 def get_trim_footnote_ref_space(settings):
     """
@@ -557,6 +588,7 @@
     else:
         return settings.trim_footnote_reference_space
 
+
 def get_source_line(node):
     """
     Return the "source" and "line" attributes from the `node` given or from
@@ -568,6 +600,7 @@
         node = node.parent
     return None, None
 
+
 def escape2null(text):
     """Return a string with escape-backslashes converted to nulls."""
     parts = 
@@ -581,7 +614,6 @@
         parts.append('\x00' + textfound+1:found+2)
         start = found + 2               # skip character after escape
 
-# `unescape` definition moved to `nodes` to avoid circular import dependency.
 
 def split_escaped_whitespace(text):
     """
@@ -593,28 +625,27 @@
     # flatten list of lists of strings to list of strings:
     return list(itertools.chain(*strings))
 
+
 def strip_combining_chars(text):
-    if isinstance(text, str) and sys.version_info < (3, 0):
-        return text
-    return u''.join(c for c in text if not unicodedata.combining(c))
+    return ''.join(c for c in text if not unicodedata.combining(c))
+
 
 def find_combining_chars(text):
     """Return indices of all combining chars in  Unicode string `text`.
 
     >>> from docutils.utils import find_combining_chars
-    >>> find_combining_chars(u'A t̆ab̆lĕ')
+    >>> find_combining_chars('A t̆ab̆lĕ')
     3, 6, 9
 
     """
-    if isinstance(text, str) and sys.version_info < (3, 0):
-        return 
-    return i for i,c in enumerate(text) if unicodedata.combining(c)
+    return i for i, c in enumerate(text) if unicodedata.combining(c)
+
 
 def column_indices(text):
     """Indices of Unicode string `text` when skipping combining characters.
 
     >>> from docutils.utils import column_indices
-    >>> column_indices(u'A t̆ab̆lĕ')
+    >>> column_indices('A t̆ab̆lĕ')
     0, 1, 2, 4, 5, 7, 8
 
     """
@@ -625,42 +656,37 @@
         string_indicesindex = None
     return i for i in string_indices if i is not None
 
+
 east_asian_widths = {'W': 2,   # Wide
                      'F': 2,   # Full-width (wide)
                      'Na': 1,  # Narrow
                      'H': 1,   # Half-width (narrow)
                      'N': 1,   # Neutral (not East Asian, treated as narrow)
-                     'A': 1}   # Ambiguous (s/b wide in East Asian context,
-                               # narrow otherwise, but that doesn't work)
+                     'A': 1,   # Ambiguous (s/b wide in East Asian context,
+                     }         # narrow otherwise, but that doesn't work)
 """Mapping of result codes from `unicodedata.east_asian_widt()` to character
 column widths."""
 
+
 def column_width(text):
     """Return the column width of text.
 
     Correct ``len(text)`` for wide East Asian and combining Unicode chars.
     """
-    if isinstance(text, str) and sys.version_info < (3, 0):
-        return len(text)
-    width = sum(east_asian_widthsunicodedata.east_asian_width(c)
-                 for c in text)
+    width = sum(east_asian_widthsunicodedata.east_asian_width(c)
+                for c in text)
     # correction for combining chars:
     width -= len(find_combining_chars(text))
     return width
 
+
 def uniq(L):
-     r = 
-     for item in L:
-         if not item in r:
-             r.append(item)
-     return r
-
-def unique_combinations(items, n):
-    """Return `itertools.combinations`."""
-    warnings.warn('docutils.utils.unique_combinations is deprecated; '
-                  'use itertools.combinations directly.',
-                      DeprecationWarning, stacklevel=2)
-    return itertools.combinations(items, n)
+    r = 
+    for item in L:
+        if item not in r:
+            r.append(item)
+    return r
+
 
 def normalize_language_tag(tag):
     """Return a list of normalized combinations for a `BCP 47` language tag.
@@ -689,7 +715,20 @@
     return taglist
 
 
-class DependencyList(object):
+def xml_declaration(encoding=None):
+    """Return an XML text declaration.
+
+    Include an encoding declaration, if `encoding`
+    is not 'unicode', '', or None.
+    """
+    if encoding and encoding.lower() != 'unicode':
+        encoding_declaration = f' encoding="{encoding}"'
+    else:
+        encoding_declaration = ''
+    return f'<?xml version="1.0"{encoding_declaration}?>\n'
+
+
+class DependencyList:
 
     """
     List of dependencies, with file recording support.
@@ -698,15 +737,19 @@
     to explicitly call the close() method.
     """
 
-    def __init__(self, output_file=None, dependencies=):
+    def __init__(self, output_file=None, dependencies=()):
         """
         Initialize the dependency list, automatically setting the
         output file to `output_file` (see `set_output()`) and adding
         all supplied dependencies.
+
+        If output_file is None, no file output is done when calling add().
         """
-        self.set_output(output_file)
-        for i in dependencies:
-            self.add(i)
+        self.list = 
+        self.file = None
+        if output_file:
+            self.set_output(output_file)
+        self.add(*dependencies)
 
     def set_output(self, output_file):
         """
@@ -717,36 +760,34 @@
         immediately overwritten.
 
         If output_file is '-', the output will be written to stdout.
-        If it is None, no file output is done when calling add().
         """
-        self.list = 
         if output_file:
             if output_file == '-':
-                of = None
+                self.file = sys.stdout
             else:
-                of = output_file
-            self.file = docutils.io.FileOutput(destination_path=of,
-                                   encoding='utf8', autoclose=False)
-        else:
-            self.file = None
+                self.file = open(output_file, 'w', encoding='utf-8')
 
-    def add(self, *filenames):
+    def add(self, *paths):
         """
-        If the dependency `filename` has not already been added,
-        append it to self.list and print it to self.file if self.file
-        is not None.
+        Append `path` to `self.list` unless it is already there.
+
+        Also append to `self.file` unless it is already there
+        or `self.file is `None`.
         """
-        for filename in filenames:
-            if not filename in self.list:
-                self.list.append(filename)
+        for path in paths:
+            if isinstance(path, PurePath):
+                path = path.as_posix()  # use '/' as separator
+            if path not in self.list:
+                self.list.append(path)
                 if self.file is not None:
-                    self.file.write(filename+'\n')
+                    self.file.write(path+'\n')
 
     def close(self):
         """
         Close the output file.
         """
-        self.file.close()
+        if self.file is not sys.stdout:
+            self.file.close()
         self.file = None
 
     def __repr__(self):
@@ -758,10 +799,11 @@
 
 
 release_level_abbreviations = {
-    'alpha':     'a',
-    'beta':      'b',
+    'alpha': 'a',
+    'beta': 'b',
     'candidate': 'rc',
-    'final':     '',}
+    'final': ''}
+
 
 def version_identifier(version_info=None):
     """

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/code_analyzer.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/code_analyzer.py Changed

@@ -1,12 +1,9 @@
-#!/usr/bin/python
-# coding: utf-8
+# :Author: Georg Brandl; Lea Wiemann; Günter Milde
+# :Date: $Date: 2022-11-16 15:01:31 +0100 (Mi, 16. Nov 2022) $
+# :Copyright: This module has been placed in the public domain.
 
 """Lexical analysis of formal languages (i.e. code) using Pygments."""
 
-# :Author: Georg Brandl; Felix Wiemann; Günter Milde
-# :Date: $Date: 2021-01-03 22:05:13 +0100 (So, 03. Jän 2021) $
-# :Copyright: This module has been placed in the public domain.
-
 from docutils import ApplicationError
 try:
     import pygments
@@ -17,15 +14,17 @@
     with_pygments = False
 
 # Filter the following token types from the list of class arguments:
-unstyled_tokens = 'token', # Token (base token type)
-                   'text',  # Token.Text
-                   ''      # short name for Token and Text
+unstyled_tokens = 'token',  # Token (base token type)
+                   'text',   # Token.Text
+                   ''       # short name for Token and Text
 # (Add, e.g., Token.Punctuation with ``unstyled_tokens += 'punctuation'``.)
 
+
 class LexerError(ApplicationError):
     pass
 
-class Lexer(object):
+
+class Lexer:
     """Parse `code` lines and yield "classified" tokens.
 
     Arguments
@@ -58,12 +57,12 @@
             return
         if not with_pygments:
             raise LexerError('Cannot analyze code. '
-                                    'Pygments package not found.')
+                             'Pygments package not found.')
         try:
             self.lexer = get_lexer_by_name(self.language)
         except pygments.util.ClassNotFound:
             raise LexerError('Cannot analyze code. '
-                'No Pygments lexer found for "%s".' % language)
+                             'No Pygments lexer found for "%s".' % language)
         # self.lexer.add_filter('tokenmerge')
         # Since version 1.2. (released Jan 01, 2010) Pygments has a
         # TokenMergeFilter. # ``self.merge(tokens)`` in __iter__ could
@@ -83,30 +82,30 @@
             if ttype is lasttype:
                 lastval += value
             else:
-                yield(lasttype, lastval)
+                yield lasttype, lastval
                 (lasttype, lastval) = (ttype, value)
         if lastval.endswith('\n'):
             lastval = lastval:-1
         if lastval:
-            yield(lasttype, lastval)
+            yield lasttype, lastval
 
     def __iter__(self):
         """Parse self.code and yield "classified" tokens.
         """
         if self.lexer is None:
-            yield (, self.code)
+            yield , self.code
             return
         tokens = pygments.lex(self.code, self.lexer)
         for tokentype, value in self.merge(tokens):
-            if self.tokennames == 'long': # long CSS class args
+            if self.tokennames == 'long':  # long CSS class args
                 classes = str(tokentype).lower().split('.')
-            else: # short CSS class args
+            else:  # short CSS class args
                 classes = _get_ttype_class(tokentype)
             classes = cls for cls in classes if cls not in unstyled_tokens
-            yield (classes, value)
+            yield classes, value
 
 
-class NumberLines(object):
+class NumberLines:
     """Insert linenumber-tokens at the start of every code line.
 
     Arguments
@@ -117,7 +116,7 @@
 
     Iterating over an instance yields the tokens with a
     ``('ln', '<the line number>')`` token added for every code line.
-    Multi-line tokens are splitted."""
+    Multi-line tokens are split."""
 
     def __init__(self, tokens, startline, endline):
         self.tokens = tokens
@@ -127,11 +126,11 @@
 
     def __iter__(self):
         lineno = self.startline
-        yield ('ln', self.fmt_str % lineno)
+        yield 'ln', self.fmt_str % lineno
         for ttype, value in self.tokens:
             lines = value.split('\n')
             for line in lines:-1:
-                yield (ttype, line + '\n')
+                yield ttype, line + '\n'
                 lineno += 1
-                yield ('ln', self.fmt_str % lineno)
-            yield (ttype, lines-1)
+                yield 'ln', self.fmt_str % lineno
+            yield ttype, lines-1

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/error_reporting.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/error_reporting.py Changed

@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# :Id: $Id: error_reporting.py 8554 2020-09-04 16:52:11Z milde $
+#!/usr/bin/env python3
+# :Id: $Id: error_reporting.py 9078 2022-06-17 11:31:40Z milde $
 # :Copyright: © 2011 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -13,10 +11,21 @@
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 
 """
+Deprecated module to handle Exceptions across Python versions.
+
+.. warning::
+   This module is deprecated with the end of support for Python 2.7
+   and will be removed in Docutils 0.21 or later.
+
+   Replacements:
+     | SafeString  -> str
+     | ErrorString -> docutils.io.error_string()
+     | ErrorOutput -> docutils.io.ErrorOutput
+
 Error reporting should be safe from encoding/decoding errors.
 However, implicit conversions of strings and exceptions like
 
->>> u'%s world: %s' % ('H\xe4llo', Exception(u'H\xe4llo')
+>>> u'%s world: %s' % ('H\xe4llo', Exception(u'H\xe4llo'))
 
 fail in some Python versions:
 
@@ -35,41 +44,22 @@
 common exceptions.
 """
 
-import codecs
 import sys
+import warnings
 
-# Guess the locale's encoding.
-# If no valid guess can be made, locale_encoding is set to `None`:
-try:
-    import locale # module missing in Jython
-except ImportError:
-    locale_encoding = None
-else:
-    try:
-        locale_encoding = locale.getlocale()1 or locale.getdefaultlocale()1
-        # locale.getpreferredencoding(do_setlocale=True|False)
-        # has side-effects | might return a wrong guess.
-        # (cf. Update 1 in http://stackoverflow.com/questions/4082645/using-python-2-xs-locale-module-to-format-numbers-and-currency)
-    except ValueError as error: # OS X may set UTF-8 without language code
-        # see http://bugs.python.org/issue18378
-        # and https://sourceforge.net/p/docutils/bugs/298/
-        if "unknown locale: UTF-8" in error.args:
-            locale_encoding = "UTF-8"
-        else:
-            locale_encoding = None
-    except: # any other problems determining the locale -> use None
-        locale_encoding = None
-    try:
-        codecs.lookup(locale_encoding or '') # None -> ''
-    except LookupError:
-        locale_encoding = None
+from docutils.io import _locale_encoding as locale_encoding  # noqa
+
+warnings.warn('The `docutils.utils.error_reporting` module is deprecated '
+              'and will be removed in Docutils 0.21 or later.\n'
+              'Details with help("docutils.utils.error_reporting").',
+              DeprecationWarning, stacklevel=2)
 
 
 if sys.version_info >= (3, 0):
     unicode = str  # noqa
 
 
-class SafeString(object):
+class SafeString:
     """
     A wrapper providing robust conversion to `str` and `unicode`.
     """
@@ -77,19 +67,18 @@
     def __init__(self, data, encoding=None, encoding_errors='backslashreplace',
                  decoding_errors='replace'):
         self.data = data
-        self.encoding = (encoding or getattr(data, 'encoding', None) or
-                         locale_encoding or 'ascii')
+        self.encoding = (encoding or getattr(data, 'encoding', None)
+                         or locale_encoding or 'ascii')
         self.encoding_errors = encoding_errors
         self.decoding_errors = decoding_errors
 
-
     def __str__(self):
         try:
             return str(self.data)
         except UnicodeEncodeError:
             if isinstance(self.data, Exception):
                 args = str(SafeString(arg, self.encoding,
-                                        self.encoding_errors))
+                                       self.encoding_errors))
                         for arg in self.data.args
                 return ', '.join(args)
             if isinstance(self.data, unicode):
@@ -119,37 +108,40 @@
             return u
         except UnicodeError as error: # catch ..Encode.. and ..Decode.. errors
             if isinstance(self.data, EnvironmentError):
-                return  u"Errno %s %s: '%s'" % (self.data.errno,
+                return "Errno %s %s: '%s'" % (
+                    self.data.errno,
                     SafeString(self.data.strerror, self.encoding,
                                self.decoding_errors),
                     SafeString(self.data.filename, self.encoding,
                                self.decoding_errors))
             if isinstance(self.data, Exception):
-                args = unicode(SafeString(arg, self.encoding,
-                            decoding_errors=self.decoding_errors))
+                args = unicode(SafeString(
+                                    arg, self.encoding,
+                                    decoding_errors=self.decoding_errors))
                         for arg in self.data.args
                 return u', '.join(args)
             if isinstance(error, UnicodeDecodeError):
                 return unicode(self.data, self.encoding, self.decoding_errors)
             raise
 
+
 class ErrorString(SafeString):
     """
     Safely report exception type and message.
     """
     def __str__(self):
         return '%s: %s' % (self.data.__class__.__name__,
-                            super(ErrorString, self).__str__())
+                           super(ErrorString, self).__str__())
 
     def __unicode__(self):
         return u'%s: %s' % (self.data.__class__.__name__,
                             super(ErrorString, self).__unicode__())
 
 
-class ErrorOutput(object):
+class ErrorOutput:
     """
     Wrapper class for file-like error streams with
-    failsave de- and encoding of `str`, `bytes`, `unicode` and
+    failsafe de- and encoding of `str`, `bytes`, `unicode` and
     `Exception` instances.
     """
 
@@ -167,7 +159,7 @@
         """
         if stream is None:
             stream = sys.stderr
-        elif not(stream):
+        elif not stream:
             stream = False
         # if `stream` is a file name, open it
         elif isinstance(stream, str):
@@ -178,8 +170,8 @@
         self.stream = stream
         """Where warning output is sent."""
 
-        self.encoding = (encoding or getattr(stream, 'encoding', None) or
-                         locale_encoding or 'ascii')
+        self.encoding = (encoding or getattr(stream, 'encoding', None)
+                         or locale_encoding or 'ascii')
         """The output character encoding."""
 
         self.encoding_errors = encoding_errors
@@ -198,7 +190,8 @@
             return
         if isinstance(data, Exception):
             data = unicode(SafeString(data, self.encoding,
-                                  self.encoding_errors, self.decoding_errors))
+                                      self.encoding_errors,
+                                      self.decoding_errors))
         try:
             self.stream.write(data)
         except UnicodeEncodeError:

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/__init__.py Changed

@@ -1,4 +1,4 @@
-# :Id: $Id: __init__.py 8554 2020-09-04 16:52:11Z milde $
+# :Id: $Id: __init__.py 9026 2022-03-04 15:57:13Z milde $
 # :Author: Guenter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -19,12 +19,20 @@
 :latex2mathml: LaTeX math -> presentational MathML
 :unichar2tex:  Unicode character to LaTeX math translation table
 :tex2unichar:  LaTeX math to Unicode character translation dictionaries
-:tex2mathml_extern: Wrapper for TeX -> MathML command line converters
+:tex2mathml_extern: Wrapper for 3rd party TeX -> MathML converters
 """
 
 # helpers for Docutils math support
 # =================================
 
+
+def toplevel_code(code):
+    """Return string (LaTeX math) `code` with environments stripped out."""
+    chunks = code.split(r'\begin{')
+    return r'\begin{'.join(chunk.split(r'\end{')-1
+                           for chunk in chunks)
+
+
 def pick_math_environment(code, numbered=False):
     """Return the right math environment to display `code`.
 
@@ -35,11 +43,7 @@
     If `numbered` evaluates to ``False``, the "starred" versions are used
     to suppress numbering.
     """
-    # cut out environment content:
-    chunks = code.split(r'\begin{')
-    toplevel_code = ''.join(chunk.split(r'\end{')-1
-                             for chunk in chunks)
-    if toplevel_code.find(r'\\') >= 0:
+    if toplevel_code(code).find(r'\\') >= 0:
         env = 'align'
     else:
         env = 'equation'

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/latex2mathml.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/latex2mathml.py Changed

@@ -1,10 +1,7 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# :Id: $Id: latex2mathml.py 8675 2021-04-08 16:35:54Z milde $
-# :Copyright: © 2010 Günter Milde.
-#             Based on rst2mathml.py from the latex_math sandbox project
-#             © 2005 Jens Jørgen Mortensen
+# :Id: $Id: latex2mathml.py 9338 2023-04-08 21:08:47Z milde $
+# :Copyright: © 2005 Jens Jørgen Mortensen 1_
+#             © 2010, 2021 Günter Milde.
+#
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
 #    Copying and distribution of this file, with or without modification,
@@ -13,556 +10,1481 @@
 #    This file is offered as-is, without any warranty.
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+#
+# .. 1 the original `rst2mathml.py` in `sandbox/jensj/latex_math`
 
+"""Convert LaTex maths code into presentational MathML.
 
-"""Convert LaTex math code into presentational MathML"""
+This module is provisional:
+the API is not settled and may change with any minor Docutils version.
+"""
+
+# Usage:
+#
+# >>> from latex2mathml import *
 
-# Based on the `latex_math` sandbox project by Jens Jørgen Mortensen
+import re
+import unicodedata
 
-import docutils.utils.math.tex2unichar as tex2unichar
+from docutils.utils.math import tex2unichar, toplevel_code
 
-#        TeX      spacing    combining
-over = {'acute':    u'\u00B4', # u'\u0301',
-        'bar':      u'\u00AF', # u'\u0304',
-        'breve':    u'\u02D8', # u'\u0306',
-        'check':    u'\u02C7', # u'\u030C',
-        'dot':      u'\u02D9', # u'\u0307',
-        'ddot':     u'\u00A8', # u'\u0308',
-        'dddot':               u'\u20DB',
-        'grave':    u'`',      # u'\u0300',
-        'hat':      u'^',      # u'\u0302',
-        'mathring': u'\u02DA', # u'\u030A',
-        'overleftrightarrow':  u'\u20e1',
-        # 'overline':        # u'\u0305',
-        'tilde':    u'\u02DC', # u'\u0303',
-        'vec':               u'\u20D7'}
 
-Greek = { # Capital Greek letters: (upright in TeX style)
-    'Phi':u'\u03a6', 'Xi':u'\u039e', 'Sigma':u'\u03a3',
-    'Psi':u'\u03a8', 'Delta':u'\u0394', 'Theta':u'\u0398',
-    'Upsilon':u'\u03d2', 'Pi':u'\u03a0', 'Omega':u'\u03a9',
-    'Gamma':u'\u0393', 'Lambda':u'\u039b'}
+# Character data
+# --------------
+
+# LaTeX math macro to Unicode mappings.
+# Character categories.
+
+# identifiers -> <mi>
 
 letters = tex2unichar.mathalpha
+letters'hbar' = '\u210F'  # compatibility mapping to ℏ (\hslash).
+# (ħ LATIN SMALL LETTER H WITH STROKE is upright)
+
+# special case: Capital Greek letters: (upright in TeX style)
+greek_capitals = {
+    'Phi': '\u03a6', 'Xi': '\u039e', 'Sigma': '\u03a3',
+    'Psi': '\u03a8', 'Delta': '\u0394', 'Theta': '\u0398',
+    'Upsilon': '\u03d2', 'Pi': '\u03a0', 'Omega': '\u03a9',
+    'Gamma': '\u0393', 'Lambda': '\u039b'}
+
+# functions -> <mi>
+functions = {
+    # functions with a space in the name
+    'liminf': 'lim\u202finf',
+    'limsup': 'lim\u202fsup',
+    'injlim': 'inj\u202flim',
+    'projlim': 'proj\u202flim',
+    # embellished function names (see handle_cmd() below)
+    'varlimsup': 'lim',
+    'varliminf': 'lim',
+    'varprojlim': 'lim',
+    'varinjlim': 'lim',
+    # custom function name
+    'operatorname': None,
+}
+functions.update((name, name) for name in
+                 ('arccos', 'arcsin', 'arctan', 'arg',  'cos',
+                  'cosh',   'cot',    'coth',   'csc',  'deg',
+                  'det',    'dim',    'exp',    'gcd',  'hom',
+                  'ker',    'lg',     'ln',     'log',  'Pr',
+                  'sec',    'sin',    'sinh',   'tan',  'tanh'))
+# Function with limits: 'lim', 'sup', 'inf', 'max', 'min':
+# use <mo> to allow "movablelimits" attribute (see below).
+
+# modulo operator/arithmetic
+modulo_functions = {
+    # cmdname: (binary, named, parentheses, padding)
+    'bmod': (True,  True,  False, '0.278em'),  # a mod n
+    'pmod': (False, True,  True,  '0.444em'),  # a  (mod n)
+    'mod':  (False, True,  False, '0.667em'),  # a  mod n
+    'pod':  (False, False, True,  '0.444em'),  # a  (n)
+    }
+
+
+# math font selection -> <mi mathvariant=...> or <mstyle mathvariant=...>
+math_alphabets = {
+    # 'cmdname':  'mathvariant value'        # package
+    'boldsymbol': 'bold',
+    'mathbf':     'bold',
+    'mathit':     'italic',
+    'mathtt':     'monospace',
+    'mathrm':     'normal',
+    'mathsf':     'sans-serif',
+    'mathcal':    'script',
+    'mathbfit':   'bold-italic',             # isomath
+    'mathbb':     'double-struck',           # amssymb
+    'mathfrak':   'fraktur',                 # amssymb
+    'mathsfit':   'sans-serif-italic',       # isomath
+    'mathsfbfit': 'sans-serif-bold-italic',  # isomath
+    'mathscr':    'script',                  # mathrsfs
+    # unsupported: bold-fraktur
+    #              bold-script
+    #              bold-sans-serif
+}
+
+# operator, fence, or separator -> <mo>
+
+
+stretchables = {
+    # extensible delimiters allowed in left/right cmds
+    'backslash':   '\\',
+    'uparrow':     '\u2191',  # ↑ UPWARDS ARROW
+    'downarrow':   '\u2193',  # ↓ DOWNWARDS ARROW
+    'updownarrow': '\u2195',  # ↕ UP DOWN ARROW
+    'Uparrow':     '\u21d1',  # ⇑ UPWARDS DOUBLE ARROW
+    'Downarrow':   '\u21d3',  # ⇓ DOWNWARDS DOUBLE ARROW
+    'Updownarrow': '\u21d5',  # ⇕ UP DOWN DOUBLE ARROW
+    'lmoustache':  '\u23b0',  # ⎰ … CURLY BRACKET SECTION
+    'rmoustache':  '\u23b1',  # ⎱ … LEFT CURLY BRACKET SECTION
+    'arrowvert':   '\u23d0',  # ⏐ VERTICAL LINE EXTENSION
+    'bracevert':   '\u23aa',  # ⎪ CURLY BRACKET EXTENSION
+    'lvert':      '|',        # left  |
+    'lVert':      '\u2016',   # left  ‖
+    'rvert':      '|',        # right |
+    'rVert':      '\u2016',   # right ‖
+    'Arrowvert':  '\u2016',   # ‖
+}
+stretchables.update(tex2unichar.mathfence)
+stretchables.update(tex2unichar.mathopen)   # Braces
+stretchables.update(tex2unichar.mathclose)  # Braces
+
+# >>> print(' '.join(sorted(set(stretchables.values()))))
+#  \  { | } ‖ ↑ ↓ ↕ ⇑ ⇓ ⇕ ⌈ ⌉ ⌊ ⌋ ⌜ ⌝ ⌞ ⌟ ⎪ ⎰ ⎱ ⏐ ⟅ ⟆ ⟦ ⟧ ⟨ ⟩ ⟮ ⟯ ⦇ ⦈
+
+operators = {
+    # negated symbols without pre-composed Unicode character
+    'nleqq':      '\u2266\u0338',  # ≦̸
+    'ngeqq':      '\u2267\u0338',  # ≧̸
+    'nleqslant':  '\u2a7d\u0338',  # ⩽̸
+    'ngeqslant':  '\u2a7e\u0338',  # ⩾̸
+    'ngtrless':   '\u2277\u0338',  # txfonts
+    'nlessgtr':   '\u2276\u0338',  # txfonts
+    'nsubseteqq': '\u2AC5\u0338',  # ⫅̸
+    'nsupseteqq': '\u2AC6\u0338',  # ⫆̸
+    # compatibility definitions:
+    'centerdot': '\u2B1D',  # BLACK VERY SMALL SQUARE | mathbin
+    'varnothing': '\u2300',  # ⌀ DIAMETER SIGN | empty set
+    'varpropto': '\u221d',  # ∝ PROPORTIONAL TO | sans serif
+    'triangle': '\u25B3',  # WHITE UP-POINTING TRIANGLE | mathord
+    'triangledown': '\u25BD',  # WHITE DOWN-POINTING TRIANGLE | mathord
+    # alias commands:
+    'dotsb': '\u22ef',  # ⋯ with binary operators/relations
+    'dotsc': '\u2026',  # … with commas
+    'dotsi': '\u22ef',  # ⋯ with integrals
+    'dotsm': '\u22ef',  # ⋯ multiplication dots
+    'dotso': '\u2026',  # … other dots
+    # functions with movable limits (requires <mo>)
+    'lim': 'lim',
+    'sup': 'sup',
+    'inf': 'inf',
+    'max': 'max',
+    'min': 'min',
+}
+operators.update(tex2unichar.mathbin)    # Binary symbols
+operators.update(tex2unichar.mathrel)    # Relation symbols, arrow symbols
+operators.update(tex2unichar.mathord)    # Miscellaneous symbols
+operators.update(tex2unichar.mathpunct)  # Punctuation
+operators.update(tex2unichar.mathop)     # Variable-sized symbols
+operators.update(stretchables)
+
+
+# special cases
+
+thick_operators = {
+    # style='font-weight: bold;'
+    'thicksim':       '\u223C',  # ∼
+    'thickapprox':    '\u2248',  # ≈
+}
+
+small_operators = {
+    # mathsize='75%'
+    'shortmid':       '\u2223',  # ∣
+    'shortparallel':  '\u2225',  # ∥
+    'nshortmid':      '\u2224',  # ∤
+    'nshortparallel': '\u2226',  # ∦
+    'smallfrown':     '\u2322',  # ⌢ FROWN
+    'smallsmile':     '\u2323',  # ⌣ SMILE
+    'smallint':       '\u222b',  # ∫ INTEGRAL
+}
+
+# Operators and functions with limits above/below in display formulas
+# and in index position inline (movablelimits=True)
+movablelimits = ('bigcap', 'bigcup', 'bigodot', 'bigoplus', 'bigotimes',
+                 'bigsqcup', 'biguplus', 'bigvee', 'bigwedge',
+                 'coprod', 'intop', 'ointop', 'prod', 'sum',
+                 'lim', 'max', 'min', 'sup', 'inf')
+# Depending on settings, integrals may also be in this category.
+# (e.g. if "amsmath" is loaded with option "intlimits", see
+#  http://mirror.ctan.org/macros/latex/required/amsmath/amsldoc.pdf)
+# movablelimits.extend(('fint', 'iiiint', 'iiint', 'iint', 'int', 'oiint',
+#                       'oint', 'ointctrclockwise', 'sqint',
+#                       'varointclockwise',))
+
+# horizontal space -> <mspace>
+
+spaces = {'qquad':         '2em',        # two \quad
+          'quad':          '1em',        # 18 mu
+          'thickspace':    '0.2778em',   # 5mu = 5/18em
+          ';':             '0.2778em',   # 5mu thickspace
+          ' ':             '0.25em',     # inter word space
+          'medspace':      '0.2222em',   # 4mu = 2/9em
+          ':':             '0.2222em',   # 4mu medspace
+          'thinspace':     '0.1667em',   # 3mu = 1/6em
+          ',':             '0.1667em',   # 3mu thinspace
+          'negthinspace':  '-0.1667em',  # -3mu = -1/6em
+          '!':             '-0.1667em',  # negthinspace
+          'negmedspace':   '-0.2222em',  # -4mu = -2/9em
+          'negthickspace': '-0.2778em',  # -5mu = -5/18em
+          }
 
-special = tex2unichar.mathbin         # Binary symbols
-special.update(tex2unichar.mathrel)   # Relation symbols, arrow symbols
-special.update(tex2unichar.mathord)   # Miscellaneous symbols
-special.update(tex2unichar.mathop)    # Variable-sized symbols
-special.update(tex2unichar.mathopen)  # Braces
-special.update(tex2unichar.mathclose) # Braces
-special.update(tex2unichar.mathfence)
-
-sumintprod = ''.join(specialsymbol for symbol in
-                      'sum', 'int', 'oint', 'prod')
-
-functions = 'arccos', 'arcsin', 'arctan', 'arg', 'cos',  'cosh',
-             'cot',    'coth',   'csc',    'deg', 'det',  'dim',
-             'exp',    'gcd',    'hom',    'inf', 'ker',  'lg',
-             'lim',    'liminf', 'limsup', 'ln',  'log',  'max',
-             'min',    'Pr',     'sec',    'sin', 'sinh', 'sup',
-             'tan',    'tanh',
-             'injlim',  'varinjlim', 'varlimsup',
-             'projlim', 'varliminf', 'varprojlim'
-
-
-mathbb = {
-          'A': u'\U0001D538',
-          'B': u'\U0001D539',
-          'C': u'\u2102',
-          'D': u'\U0001D53B',
-          'E': u'\U0001D53C',
-          'F': u'\U0001D53D',
-          'G': u'\U0001D53E',
-          'H': u'\u210D',
-          'I': u'\U0001D540',
-          'J': u'\U0001D541',
-          'K': u'\U0001D542',
-          'L': u'\U0001D543',
-          'M': u'\U0001D544',
-          'N': u'\u2115',
-          'O': u'\U0001D546',
-          'P': u'\u2119',
-          'Q': u'\u211A',
-          'R': u'\u211D',
-          'S': u'\U0001D54A',
-          'T': u'\U0001D54B',
-          'U': u'\U0001D54C',
-          'V': u'\U0001D54D',
-          'W': u'\U0001D54E',
-          'X': u'\U0001D54F',
-          'Y': u'\U0001D550',
-          'Z': u'\u2124',
+# accents -> <mover stretchy="false">
+accents = {
+    # TeX:    (spacing, combining)
+    'acute':    ('´', '\u0301'),
+    'bar':      ('ˉ', '\u0304'),
+    'breve':    ('˘', '\u0306'),
+    'check':    ('ˇ', '\u030C'),
+    'dot':      ('˙', '\u0307'),
+    'ddot':     ('¨', '\u0308'),
+    'dddot':    ('⋯', '\u20DB'),
+    'grave':    ('`', '\u0300'),
+    'hat':      ('ˆ', '\u0302'),
+    'mathring': ('˚', '\u030A'),
+    'tilde':    ('˜', '\u0303'),  # tilde ~ or small tilde ˜?
+    'vec':      ('→', '\u20d7'),  # → too heavy, accents="false"
+    # TODO: ddddot
+}
+
+# limits etc. -> <mover> or <munder>
+over = {
+    # TeX:                  (char,     offset-correction/em)
+    'overbrace':            ('\u23DE', -0.2),  # DejaVu Math -0.6
+    'overleftarrow':        ('\u2190', -0.2),
+    'overleftrightarrow':   ('\u2194', -0.2),
+    'overline':             ('_',      -0.2),  # \u2012 does not stretch
+    'overrightarrow':       ('\u2192', -0.2),
+    'widehat':              ('^',      -0.5),
+    'widetilde':            ('~',      -0.3),
+}
+under = {'underbrace':          ('\u23DF',  0.1),  # DejaVu Math -0.7
+         'underleftarrow':      ('\u2190', -0.2),
+         'underleftrightarrow': ('\u2194', -0.2),
+         'underline':           ('_',      -0.8),
+         'underrightarrow':     ('\u2192', -0.2),
          }
 
-mathscr = {
-           'A': u'\U0001D49C',
-           'B': u'\u212C',     # bernoulli function
-           'C': u'\U0001D49E',
-           'D': u'\U0001D49F',
-           'E': u'\u2130',
-           'F': u'\u2131',
-           'G': u'\U0001D4A2',
-           'H': u'\u210B',     # hamiltonian
-           'I': u'\u2110',
-           'J': u'\U0001D4A5',
-           'K': u'\U0001D4A6',
-           'L': u'\u2112',     # lagrangian
-           'M': u'\u2133',     # physics m-matrix
-           'N': u'\U0001D4A9',
-           'O': u'\U0001D4AA',
-           'P': u'\U0001D4AB',
-           'Q': u'\U0001D4AC',
-           'R': u'\u211B',
-           'S': u'\U0001D4AE',
-           'T': u'\U0001D4AF',
-           'U': u'\U0001D4B0',
-           'V': u'\U0001D4B1',
-           'W': u'\U0001D4B2',
-           'X': u'\U0001D4B3',
-           'Y': u'\U0001D4B4',
-           'Z': u'\U0001D4B5',
-           'a': u'\U0001D4B6',
-           'b': u'\U0001D4B7',
-           'c': u'\U0001D4B8',
-           'd': u'\U0001D4B9',
-           'e': u'\u212F',
-           'f': u'\U0001D4BB',
-           'g': u'\u210A',
-           'h': u'\U0001D4BD',
-           'i': u'\U0001D4BE',
-           'j': u'\U0001D4BF',
-           'k': u'\U0001D4C0',
-           'l': u'\U0001D4C1',
-           'm': u'\U0001D4C2',
-           'n': u'\U0001D4C3',
-           'o': u'\u2134',     # order of
-           'p': u'\U0001D4C5',
-           'q': u'\U0001D4C6',
-           'r': u'\U0001D4C7',
-           's': u'\U0001D4C8',
-           't': u'\U0001D4C9',
-           'u': u'\U0001D4CA',
-           'v': u'\U0001D4CB',
-           'w': u'\U0001D4CC',
-           'x': u'\U0001D4CD',
-           'y': u'\U0001D4CE',
-           'z': u'\U0001D4CF',
+# Character translations
+# ----------------------
+# characters with preferred alternative in mathematical use
+# cf. https://www.w3.org/TR/MathML3/chapter7.html#chars.anomalous
+anomalous_chars = {'-': '\u2212',  # HYPHEN-MINUS -> MINUS SIGN
+                   ':': '\u2236',  # COLON -> RATIO
+                   '~': '\u00a0',  # NO-BREAK SPACE
+                   }
+
+# blackboard bold (Greek characters not working with "mathvariant" (Firefox 78)
+mathbb = {'Γ': '\u213E',    # ℾ
+          'Π': '\u213F',    # ℿ
+          'Σ': '\u2140',    # ⅀
+          'γ': '\u213D',    # ℽ
+          'π': '\u213C',    # ℼ
           }
 
-negatables = {'=': u'\u2260',
-              r'\in': u'\u2209',
-              r'\equiv': u'\u2262'}
+# Matrix environments
+matrices = {
+    # name:    fences
+    'matrix':  ('', ''),
+    'smallmatrix':  ('', ''),  # smaller, see begin_environment()!
+    'pmatrix': ('(', ')'),
+    'bmatrix': ('', ''),
+    'Bmatrix': ('{', '}'),
+    'vmatrix': ('|', '|'),
+    'Vmatrix': ('\u2016', '\u2016'),  # ‖
+    'cases':   ('{', ''),
+}
+
+layout_styles = {
+    'displaystyle':      {'displaystyle': True,  'scriptlevel': 0},
+    'textstyle':         {'displaystyle': False, 'scriptlevel': 0},
+    'scriptstyle':       {'displaystyle': False, 'scriptlevel': 1},
+    'scriptscriptstyle': {'displaystyle': False, 'scriptlevel': 2},
+    }
+# See also https://www.w3.org/TR/MathML3/chapter3.html#presm.scriptlevel
+
+fractions = {
+    # name:   style_attrs, frac_attrs
+    'frac':   ({}, {}),
+    'cfrac':  ({'displaystyle': True,  'scriptlevel': 0,
+                'CLASS': 'cfrac'}, {}),  # in LaTeX with padding
+    'dfrac':  (layout_styles'displaystyle', {}),
+    'tfrac':  (layout_styles'textstyle', {}),
+    'binom':  ({}, {'linethickness': 0}),
+    'dbinom': (layout_styles'displaystyle', {'linethickness': 0}),
+    'tbinom': (layout_styles'textstyle', {'linethickness': 0}),
+}
+
+delimiter_sizes = '', '1.2em', '1.623em', '2.047em', '2.470em'
+bigdelimiters = {'left':  0,
+                 'right': 0,
+                 'bigl':  1,
+                 'bigr':  1,
+                 'Bigl':  2,
+                 'Bigr':  2,
+                 'biggl': 3,
+                 'biggr': 3,
+                 'Biggl': 4,
+                 'Biggr': 4,
+                 }
+
+
+# MathML element classes
+# ----------------------
+
+class math:
+    """Base class for MathML elements and root of MathML trees."""
+
+    nchildren = None
+    """Expected number of children or None"""
+    # cf. https://www.w3.org/TR/MathML3/chapter3.html#id.3.1.3.2
+    parent = None
+    """Parent node in MathML DOM tree."""
+    _level = 0  # indentation level (static class variable)
+    xml_entities = {
+        # for invalid and invisible characters
+        ord('<'): '&lt;',
+        ord('>'): '&gt;',
+        ord('&'): '&amp;',
+        0x2061:   '&ApplyFunction;',
+    }
+    _boolstrings = {True: 'true', False: 'false'}
+    """String representation of boolean MathML attribute values."""
+
+    html_tagname = 'span'
+    """Tag name for HTML representation."""
+
+    def __init__(self, *children, **attributes):
+        """Set up node with `children` and `attributes`.
+
+        Attributes are downcased: Use CLASS to set "class" value.
+        >>> math(mn(3), CLASS='test')
+        math(mn(3), class='test')
+        >>> math(CLASS='test').toprettyxml()
+        '<math class="test">\n</math>'
+
+        """
+        self.children = 
+        self.extend(children)
 
-# LaTeX to MathML translation stuff:
-class math(object):
-    """Base class for MathML elements."""
+        self.attributes = {}
+        for key in attributes.keys():
+            # Use .lower() to allow argument `CLASS` for attribute `class`
+            # (Python keyword). MathML uses only lowercase attributes.
+            self.attributeskey.lower() = attributeskey
 
-    nchildren = 1000000
-    """Required number of children"""
+    def __repr__(self):
+        content = repr(item) for item in getattr(self, 'children', )
+        if hasattr(self, 'data'):
+            content.append(repr(self.data))
+        if isinstance(self, MathSchema) and self.switch:
+            content.append('switch=True')
+        content += "%s=%r"%(k, v) for k, v in self.attributes.items()
+                    if v is not None
 
-    def __init__(self, children=None, inline=None):
-        """math(children) -> MathML element
+        return self.__class__.__name__ + '(%s)' % ', '.join(content)
 
-        children can be one child or a list of children."""
+    def __len__(self):
+        return len(self.children)
 
-        self.children = 
-        if children is not None:
-            if isinstance(children, list):
-                for child in children:
-                    self.append(child)
-            else:
-                # Only one child:
-                self.append(children)
+    # emulate dictionary-like access to attributes
+    # see `docutils.nodes.Element` for dict/list interface
+    def __getitem__(self, key):
+        return self.attributeskey
 
-        if inline is not None:
-            self.inline = inline
+    def __setitem__(self, key, item):
+        self.attributeskey = item
 
-    def __repr__(self):
-        if hasattr(self, 'children'):
-            return self.__class__.__name__ + '(%s)' % \
-                   ','.join(repr(child) for child in self.children)
-        else:
-            return self.__class__.__name__
+    def get(self, *args, **kwargs):
+        return self.attributes.get(*args, **kwargs)
 
     def full(self):
-        """Room for more children?"""
-
-        return len(self.children) >= self.nchildren
+        """Return boolean indicating whether children may be appended."""
+        return (self.nchildren is not None
+                and len(self) >= self.nchildren)
 
     def append(self, child):
-        """append(child) -> element
-
-        Appends child and returns self if self is not full or first
-        non-full parent."""
+        """Append child and return self or first non-full parent.
 
-        assert not self.full()
+        If self is full, go up the tree and return first non-full node or
+        `None`.
+        """
+        if self.full():
+            raise SyntaxError('Node %s already full!' % self)
         self.children.append(child)
         child.parent = self
-        node = self
-        while node.full():
-            node = node.parent
-        return node
-
-    def delete_child(self):
-        """delete_child() -> child
-
-        Delete last child and return it."""
+        if self.full():
+            return self.close()
+        return self
 
-        child = self.children-1
-        del self.children-1
-        return child
+    def extend(self, children):
+        for child in children:
+            self.append(child)
+        return self
 
     def close(self):
-        """close() -> parent
-
-        Close element and return first non-full element."""
-
+        """Close element and return first non-full parent or None."""
         parent = self.parent
-        while parent.full():
+        while parent is not None and parent.full():
             parent = parent.parent
         return parent
 
-    def xml(self):
-        """xml() -> xml-string"""
+    def toprettyxml(self):
+        """Return XML representation of self as string."""
+        return ''.join(self._xml())
 
-        return self.xml_start() + self.xml_body() + self.xml_end()
+    def _xml(self, level=0):
+        return (self.xml_starttag()
+                + self._xml_body(level)
+                + '</%s>' % self.__class__.__name__)
 
-    def xml_start(self):
-        if not hasattr(self, 'inline'):
-            return '<%s>' % self.__class__.__name__
-        xmlns = 'http://www.w3.org/1998/Math/MathML'
-        if self.inline:
-            return '<math xmlns="%s">' % xmlns
-        else:
-            return '<math xmlns="%s" mode="display">' % xmlns
+    def xml_starttag(self):
+        attrs = ('%s="%s"' % (k, str(v).replace('True', 'true').replace('False', 'false'))
+                 for k, v in self.attributes.items()
+                 if v is not None)
+        return '<%s>' % ' '.join((self.__class__.__name__, *attrs))
 
-    def xml_end(self):
-        return '</%s>' % self.__class__.__name__
-
-    def xml_body(self):
+    def _xml_body(self, level=0):
         xml = 
         for child in self.children:
-            xml.extend(child.xml())
+            xml.extend('\n', '  ' * (level+1))
+            xml.extend(child._xml(level+1))
+        xml.extend('\n', '  ' * level)
         return xml
 
+    def is_block(self):
+        """Return true, if `self` or a parent has ``display='block'``."""
+        try:
+            return self'display' == 'block'
+        except KeyError:
+            try:
+                return self.parent.is_block()
+            except AttributeError:
+                return False
+
+# >>> n2 = math(mn(2))
+# >>> n2
+# math(mn(2))
+# >>> n2.toprettyxml()
+# '<math>\n  <mn>2</mn>\n</math>'
+# >>> len(n2)
+# 1
+# >>> eq3 = math(id='eq3', display='block')
+# >>> eq3
+# math(id='eq3', display='block')
+# >>> eq3.toprettyxml()
+# '<math id="eq3" display="block">\n</math>'
+# >>> len(eq3)
+# 0
+# >>> math(CLASS='bold').xml_starttag()
+# '<math class="bold">'
+# >>> n2.is_block()
+# False
+# >>> node = n2.append(mrow())
+# >>> node.is_block()
+# False
+# >>> eq3.is_block()
+# True
+# >>> node = eq3.append(mrow())
+# >>> node.is_block()
+# True
+
+
+class mtable(math): pass
+
+
+# >>> mt = mtable(displaystyle=True)
+# >>> mt
+# mtable(displaystyle=True)
+# >>> math(mt).toprettyxml()
+# '<math>\n  <mtable displaystyle="true">\n  </mtable>\n</math>'
+
 class mrow(math):
-    def xml_start(self):
-        return '\n<%s>' % self.__class__.__name__
+    """Group sub-expressions as a horizontal row."""
+
+    def close(self):
+        """Close element and return first non-full parent or None.
+
+        Remove <mrow>, if it is single child and the parent infers an mrow
+        or if it has only one child element.
+        """
+        parent = self.parent
+        if isinstance(parent, MathRowSchema) and parent.nchildren == 1:
+            parent.nchildren = len(parent.children)
+            parent.children = self.children
+            for child in self.children:
+                child.parent = parent
+            return parent.close()
+        if len(self) == 1:
+            try:
+                parent.childrenparent.children.index(self) = self.children0
+                self.children0.parent = parent
+            except (AttributeError, ValueError):
+                return self.children0
+        return super().close()
+
+# >>> mrow(displaystyle=False)
+# mrow(displaystyle=False)
+
+
+# The elements <msqrt>, <mstyle>, <merror>, <mpadded>, <mphantom>, <menclose>,
+# <mtd>, <mscarry>, and <math> treat their contents as a single inferred mrow
+# formed from all their children.
+class MathRowSchema(math):
+    """Base class for elements treating content as a single inferred mrow."""
+
+
+class mtr(MathRowSchema): pass
+class mtd(MathRowSchema): pass
+
+
+class menclose(MathRowSchema):
+    nchildren = 1  # \boxed expects one argument or a group
+
 
-class mtable(math):
-    def xml_start(self):
-        return '\n<%s>' % self.__class__.__name__
+class mphantom(MathRowSchema):
+    nchildren = 1  # \phantom expects one argument or a group
 
-class mtr(mrow): pass
-class mtd(mrow): pass
 
-class mx(math):
-    """Base class for mo, mi, and mn"""
+class msqrt(MathRowSchema):
+    nchildren = 1  # \sqrt expects one argument or a group
 
+
+class mstyle(MathRowSchema):
+    nchildren = 1  # \mathrm, ... expect one argument or a group
+
+
+class MathToken(math):
+    """Token Element: contains textual data instead of children.
+
+    Base class for mo, mi, and mn.
+    """
     nchildren = 0
-    def __init__(self, data):
+
+    def __init__(self, data, **attributes):
         self.data = data
+        super().__init__(**attributes)
 
-    def xml_body(self):
-        return self.data
+    def _xml_body(self, level=0):
+        return str(self.data).translate(self.xml_entities)
 
-class mo(mx):
-    translation = {'<': '&lt;', '>': '&gt;'}
-    def xml_body(self):
-        return self.translation.get(self.data, self.data)
 
-class mi(mx): pass
-class mn(mx): pass
+class mtext(MathToken): pass
+class mi(MathToken): pass
+class mo(MathToken): pass
+class mn(MathToken): pass
 
-class msub(math):
-    nchildren = 2
 
-class msup(math):
+# >>> mo('<')
+# mo('<')
+# >>> mo('<')._xml()
+# '<mo>', '&lt;', '</mo>'
+
+class MathSchema(math):
+    """Base class for schemata expecting 2 or more children.
+
+    The special attribute `switch` indicates that the last two child
+    elements are in reversed order and must be switched before XML-export.
+    """
+
     nchildren = 2
 
-class msqrt(math):
-    nchildren = 1
+    def __init__(self, *children, **kwargs):
+        self.switch = kwargs.pop('switch', False)
+        math.__init__(self, *children, **kwargs)
+
+    def append(self, child):
+        current_node = super().append(child)
+        # normalize order if full
+        if self.switch and self.full():
+            self.children-1, self.children-2 = self.children-2, self.children-1
+            self.switch = False
+        return current_node
+
+
+class msub(MathSchema): pass
+class msup(MathSchema): pass
+
+
+class msubsup(MathSchema):
+    nchildren = 3
 
-class mroot(math):
+
+# >>> msub(mi('x'), mo('-'))
+# msub(mi('x'), mo('-'))
+# >>> msubsup(mi('base'), mi('sub'), mi('super'))
+# msubsup(mi('base'), mi('sub'), mi('super'))
+# >>> msubsup(mi('base'), mi('super'), mi('sub'), switch=True)
+# msubsup(mi('base'), mi('sub'), mi('super'))
+
+class munder(msub): pass
+class mover(msup): pass
+
+
+# >>> munder(mi('lim'), mo('-'), accent=False)
+# munder(mi('lim'), mo('-'), accent=False)
+# >>> mu = munder(mo('-'), accent=False, switch=True)
+# >>> mu
+# munder(mo('-'), switch=True, accent=False)
+# >>> mu.append(mi('lim'))
+# >>> mu
+# munder(mi('lim'), mo('-'), accent=False)
+# >>> mu.append(mi('lim'))
+# Traceback (most recent call last):
+# SyntaxError: Node munder(mi('lim'), mo('-'), accent=False) already full!
+# >>> munder(mo('-'), mi('lim'), accent=False, switch=True).toprettyxml()
+# '<munder accent="false">\n  <mi>lim</mi>\n  <mo>-</mo>\n</munder>'
+
+class munderover(msubsup): pass
+
+
+class mroot(MathSchema):
     nchildren = 2
 
+
 class mfrac(math):
     nchildren = 2
 
-class msubsup(math):
-    nchildren = 3
-    def __init__(self, children=None, reversed=False):
-        self.reversed = reversed
-        math.__init__(self, children)
-
-    def xml(self):
-        if self.reversed:
-##            self.children1:3 = self.children2:0:-1
-            self.children1:3 = self.children2, self.children1
-            self.reversed = False
-        return math.xml(self)
-
-class mfenced(math):
-    translation = {'\\{': '{', '\\langle': u'\u2329',
-                   '\\}': '}', '\\rangle': u'\u232A',
-                   '.': ''}
-    def __init__(self, par):
-        self.openpar = par
-        math.__init__(self)
-
-    def xml_start(self):
-        open = self.translation.get(self.openpar, self.openpar)
-        close = self.translation.get(self.closepar, self.closepar)
-        return '<mfenced open="%s" close="%s">' % (open, close)
 
 class mspace(math):
     nchildren = 0
 
-class mstyle(math):
-    def __init__(self, children=None, nchildren=None, **kwargs):
-        if nchildren is not None:
-            self.nchildren = nchildren
-        math.__init__(self, children)
-        self.attrs = kwargs
 
-    def xml_start(self):
-        return '<mstyle ' + '%s="%s"' % item
-                               for item in self.attrs.items() + '>'
+# LaTeX to MathML translation
+# ---------------------------
 
-class mover(math):
-    nchildren = 2
-    def __init__(self, children=None, reversed=False):
-        self.reversed = reversed
-        math.__init__(self, children)
+# auxiliary functions
+# ~~~~~~~~~~~~~~~~~~~
 
-    def xml(self):
-        if self.reversed:
-            self.children.reverse()
-            self.reversed = False
-        return math.xml(self)
+def tex_cmdname(string):
+    """Return leading TeX command name and remainder of `string`.
 
-class munder(math):
-    nchildren = 2
+    >>> tex_cmdname('mymacro2') # up to first non-letter
+    ('mymacro', '2')
+    >>> tex_cmdname('name 2') # strip trailing whitespace
+    ('name', '2')
+    >>> tex_cmdname('_2') # single non-letter character
+    ('_', '2')
 
-class munderover(math):
-    nchildren = 3
-    def __init__(self, children=None):
-        math.__init__(self, children)
+    """
+    m = re.match(r'(a-zA-Z+) *(.*)', string)
+    if m is None:
+        m = re.match(r'(.?)(.*)', string)
+    return m.group(1), m.group(2)
 
-class mtext(math):
-    nchildren = 0
-    def __init__(self, text):
-        self.text = text
 
-    def xml_body(self):
-        return self.text
+# Test:
+#
+# >>> tex_cmdname('name_2') # first non-letter terminates
+# ('name', '_2')
+# >>> tex_cmdname(' next') # leading whitespace is returned
+# (' ', 'next')
+# >>> tex_cmdname('1 2') # whitespace after non-letter is kept
+# ('1', ' 2')
+# >>> tex_cmdname('') # empty string
+# ('', '')
 
-def parse_latex_math(string, inline=True):
-    """parse_latex_math(string ,inline) -> MathML-tree
 
-    Returns a MathML-tree parsed from string.  inline=True is for
-    inline math and inline=False is for displayed math.
+def tex_number(string):
+    """Return leading number literal and remainder of `string`.
 
-    tree is the whole tree and node is the current element."""
+    >>> tex_number('123.4')
+    ('123.4', '')
 
-    # Normalize white-space:
-    string = ' '.join(string.split())
+    """
+    m = re.match(r'(0-9.,*0-9+)(.*)', string)
+    if m is None:
+        return '', string
+    return m.group(1), m.group(2)
+
+
+# Test:
+#
+# >>> tex_number(' 23.4b') # leading whitespace -> no number
+# ('', ' 23.4b')
+# >>> tex_number('23,400/2') # comma separator included
+# ('23,400', '/2')
+# >>> tex_number('23. 4/2') # trailing separator not included
+# ('23', '. 4/2')
+# >>> tex_number('4, 2') # trailing separator not included
+# ('4', ', 2')
+# >>> tex_number('1 000.4')
+# ('1', ' 000.4')
+
+
+def tex_token(string):
+    """Return first simple TeX token and remainder of `string`.
+
+    >>> tex_token('\\command{without argument}')
+    ('\\command', '{without argument}')
+    >>> tex_token('or first character')
+    ('o', 'r first character')
+
+    """
+    m = re.match(r"""((?P<cmd>\\a-zA-Z+)\s* # TeX command, skip whitespace
+                      |(?P<chcmd>\\.)          # one-character TeX command
+                      |(?P<ch>.?))            # first character (or empty)
+                     (?P<remainder>.*$)    # remaining part of string
+                 """, string, re.VERBOSE)
+    cmd, chcmd, ch, remainder = m.group('cmd', 'chcmd', 'ch', 'remainder')
+    return cmd or chcmd or ch, remainder
+
+# Test:
+#
+# >>> tex_token('{opening bracket of group}')
+# ('{', 'opening bracket of group}')
+# >>> tex_token('\\skip whitespace after macro name')
+# ('\\skip', 'whitespace after macro name')
+# >>> tex_token('. but not after single char')
+# ('.', ' but not after single char')
+# >>> tex_token('') # empty string.
+# ('', '')
+# >>> tex_token('\{escaped bracket')
+# ('\\{', 'escaped bracket')
+
+
+def tex_group(string):
+    """Return first TeX group or token and remainder of `string`.
 
-    if inline:
-        node = mrow()
-        tree = math(node, inline=True)
+    >>> tex_group('{first group} returned without brackets')
+    ('first group', ' returned without brackets')
+
+    """
+    split_index = 0
+    nest_level = 0   # level of {{nested} groups}
+    escape = False   # the next character is escaped (\)
+
+    if not string.startswith('{'):
+        # special case: there is no group, return first token and remainder
+        return string:1, string1:
+    for c in string:
+        split_index += 1
+        if escape:
+            escape = False
+        elif c == '\\':
+            escape = True
+        elif c == '{':
+            nest_level += 1
+        elif c == '}':
+            nest_level -= 1
+        if nest_level == 0:
+            break
     else:
-        node = mtd()
-        tree = math(mtable(mtr(node)), inline=False)
+        raise SyntaxError('Group without closing bracket')
+    return string1:split_index-1, stringsplit_index:
+
+
+# >>> tex_group('{} empty group')
+# ('', ' empty group')
+# >>> tex_group('{group with {nested} group} ')
+# ('group with {nested} group', ' ')
+# >>> tex_group('{group with {nested group}} at the end')
+# ('group with {nested group}', ' at the end')
+# >>> tex_group('{{group} {with {{complex }nesting}} constructs}')
+# ('{group} {with {{complex }nesting}} constructs', '')
+# >>> tex_group('{group with \\{escaped\\} brackets}')
+# ('group with \\{escaped\\} brackets', '')
+# >>> tex_group('{group followed by closing bracket}} from outer group')
+# ('group followed by closing bracket', '} from outer group')
+# >>> tex_group('No group? Return first character.')
+# ('N', 'o group? Return first character.')
+# >>> tex_group(' {also whitespace}')
+# (' ', '{also whitespace}')
+
+
+def tex_token_or_group(string):
+    """Return first TeX group or token and remainder of `string`.
+
+    >>> tex_token_or_group('\\command{without argument}')
+    ('\\command', '{without argument}')
+    >>> tex_token_or_group('first character')
+    ('f', 'irst character')
+    >>> tex_token_or_group(' also whitespace')
+    (' ', 'also whitespace')
+    >>> tex_token_or_group('{first group} keep rest')
+    ('first group', ' keep rest')
+
+    """
+    arg, remainder = tex_token(string)
+    if arg == '{':
+        arg, remainder = tex_group(string.lstrip())
+    return arg, remainder
+
+# >>> tex_token_or_group('\{no group but left bracket')
+# ('\\{', 'no group but left bracket')
+
+
+def tex_optarg(string):
+    """Return optional argument and remainder.
+
+    >>> tex_optarg('optional argument returned without brackets')
+    ('optional argument', ' returned without brackets')
+    >>> tex_optarg('{empty string, if there is no optional arg}')
+    ('', '{empty string, if there is no optional arg}')
+
+    """
+    m = re.match(r"""\s*                            # leading whitespace
+                 $?P<optarg>(\\|^\\|\$*)\ # group without nested groups
+                 (?P<remainder>.*$)
+                 """, string, re.VERBOSE)
+    if m is None and not string.startswith(''):
+        return '', string
+    try:
+        return m.group('optarg'), m.group('remainder')
+    except AttributeError:
+        raise SyntaxError('Could not extract optional argument from %r' % string)
+
+# Test:
+# >>> tex_optarg(' optional argument after whitespace')
+# ('optional argument', ' after whitespace')
+# >>> tex_optarg('missing right bracket')
+# Traceback (most recent call last):
+# SyntaxError: Could not extract optional argument from 'missing right bracket'
+# >>> tex_optarg('group with nested group')
+# Traceback (most recent call last):
+# SyntaxError: Could not extract optional argument from 'group with nested group'
+
+
+def parse_latex_math(node, string):
+    """Append MathML conversion of `string` to `node` and return it.
+
+    >>> parse_latex_math(math(), r'\alpha')
+    math(mi('α'))
+    >>> parse_latex_math(mrow(), r'x_{n}')
+    mrow(msub(mi('x'), mi('n')))
+
+    """
+    # Normalize white-space:
+    string = ' '.join(string.split())
+    tree = node
 
     while len(string) > 0:
-        n = len(string)
-        c = string0
-        skip = 1  # number of characters consumed
-        if n > 1:
-            c2 = string1
-        else:
-            c2 = ''
+        # Take off first character:
+        c, string = string0, string1:
+
         if c == ' ':
-            pass
-        elif c == '\\':
-            if c2 in '{}':
-                node = node.append(mo(c2))
-                skip = 2
-            elif c2 == ' ':
-                node = node.append(mspace())
-                skip = 2
-            elif c2 == ',': # TODO: small space
-                node = node.append(mspace())
-                skip = 2
-            elif c2.isalpha():
-                # We have a LaTeX-name:
-                i = 2
-                while i < n and stringi.isalpha():
-                    i += 1
-                name = string1:i
-                node, skip = handle_keyword(name, node, stringi:)
-                skip += i
-            elif c2 == '\\':
-                # End of a row:
-                entry = mtd()
-                row = mtr(entry)
-                node.close().close().append(row)
-                node = entry
-                skip = 2
-            else:
-                raise SyntaxError(u'Syntax error: "%s%s"' % (c, c2))
+            continue  # whitespace is ignored in LaTeX math mode
+        if c == '\\':  # start of a LaTeX macro
+            cmdname, string = tex_cmdname(string)
+            node, string = handle_cmd(cmdname, node, string)
+        elif c in "_^":
+            node = handle_script_or_limit(node, c)
+        elif c == '{':
+            new_node = mrow()
+            node.append(new_node)
+            node = new_node
+        elif c == '}':
+            node = node.close()
+        elif c == '&':
+            new_node = mtd()
+            node.close().append(new_node)
+            node = new_node
         elif c.isalpha():
             node = node.append(mi(c))
         elif c.isdigit():
-            node = node.append(mn(c))
-        elif c in "+-*/=()|<>,.!?':;@":
+            number, string = tex_number(string)
+            node = node.append(mn(c+number))
+        elif c in anomalous_chars:
+            # characters with a special meaning in LaTeX math mode
+            # fix spacing before "unary" minus.
+            attributes = {}
+            if c == '-' and node.children:
+                previous_node = node.children-1
+                if (getattr(previous_node, 'data', '-') in '(='
+                    or previous_node.get('class') == 'mathopen'):
+                    attributes'form' = 'prefix'
+            node = node.append(mo(anomalous_charsc, **attributes))
+        elif c in "/()|":
+            node = node.append(mo(c, stretchy=False))
+        elif c in "+*=<>,.!?`';@":
             node = node.append(mo(c))
-        elif c == '_':
-            child = node.delete_child()
-            if isinstance(child, msup):
-                sub = msubsup(child.children, reversed=True)
-            elif isinstance(child, mo) and child.data in sumintprod:
-                sub = munder(child)
-            else:
-                sub = msub(child)
-            node.append(sub)
-            node = sub
-        elif c == '^':
-            child = node.delete_child()
-            if isinstance(child, msub):
-                sup = msubsup(child.children)
-            elif isinstance(child, mo) and child.data in sumintprod:
-                sup = mover(child)
-            elif (isinstance(child, munder) and
-                  child.children0.data in sumintprod):
-                sup = munderover(child.children)
-            else:
-                sup = msup(child)
-            node.append(sup)
-            node = sup
-        elif c == '{':
+        else:
+            raise SyntaxError('Unsupported character: "%s"' % c)
+    return tree
+
+# Test:
+
+# >>> print(parse_latex_math(math(), ''))
+# math()
+# >>> parse_latex_math(math(), ' \\sqrt{ \\alpha}')
+# math(msqrt(mi('α')))
+# >>> parse_latex_math(math(), '23.4x')
+# math(mn('23.4'), mi('x'))
+# >>> parse_latex_math(math(), '\\sqrt 2 \\ne 3')
+# math(msqrt(mn('2')), mo('≠'), mn('3'))
+# >>> parse_latex_math(math(), '\\sqrt{2 + 3} < 3')
+# math(msqrt(mn('2'), mo('+'), mn('3')), mo('<'), mn('3'))
+# >>> parse_latex_math(math(), '\\sqrt3{2 + 3}')
+# math(mroot(mrow(mn('2'), mo('+'), mn('3')), mn('3')))
+# >>> parse_latex_math(math(), '\max_x') # function takes limits
+# math(munder(mo('max', movablelimits=True), mi('x')))
+# >>> parse_latex_math(math(), 'x^j_i') # ensure correct order: base, sub, sup
+# math(msubsup(mi('x'), mi('i'), mi('j')))
+# >>> parse_latex_math(math(), '\int^j_i') # ensure correct order
+# math(msubsup(mo('∫'), mi('i'), mi('j')))
+# >>> parse_latex_math(math(), 'x_{\\alpha}')
+# math(msub(mi('x'), mi('α')))
+# >>> parse_latex_math(math(), 'x_\\text{in}')
+# math(msub(mi('x'), mtext('in')))
+
+
+def handle_cmd(name, node, string):  # noqa: C901 TODO make this less complex
+    """Process LaTeX command `name` followed by `string`.
+
+    Append result to `node`.
+    If needed, parse `string` for command argument.
+    Return new current node and remainder of `string`:
+
+    >>> handle_cmd('hbar', math(), r' \frac')
+    (math(mi('ℏ')), ' \\frac')
+    >>> handle_cmd('hspace', math(), r'{1ex} (x)')
+    (math(mspace(width='1ex')), ' (x)')
+
+    """
+
+    # Token elements
+    # ==============
+
+    # identifier  ->  <mi>
+
+    if name in letters:
+        new_node = mi(lettersname)
+        if name in greek_capitals:
+            # upright in "TeX style" but MathML sets them italic ("ISO style").
+            # CSS styling does not change the font style in Firefox 78.
+            # Use 'mathvariant="normal"'?
+            new_node'class' = 'capital-greek'
+        node = node.append(new_node)
+        return node, string
+
+    if name in functions:
+        # use <mi> followed by invisible function applicator character
+        # (see https://www.w3.org/TR/MathML3/chapter3.html#presm.mi)
+        if name == 'operatorname':
+            # custom function name, e.g. ``\operatorname{abs}(x)``
+            # TODO: \operatorname* -> with limits
+            arg, string = tex_token_or_group(string)
+            new_node = mi(arg, mathvariant='normal')
+        else:
+            new_node = mi(functionsname)
+        # embellished function names:
+        if name == 'varliminf':    # \underline\lim
+            new_node = munder(new_node, mo('_'))
+        elif name == 'varlimsup':  # \overline\lim
+            new_node = mover(new_node, mo('¯'), accent=False)
+        elif name == 'varprojlim':  # \underleftarrow\lim
+            new_node = munder(new_node, mo('\u2190'))
+        elif name == 'varinjlim':  # \underrightarrow\lim
+            new_node = munder(new_node, mo('\u2192'))
+
+        node = node.append(new_node)
+        # add ApplyFunction when appropriate (not \sin^2(x), say)
+        # cf. https://www.w3.org/TR/MathML3/chapter3.html#presm.mi
+        if string and string0 not in ('^', '_'):
+            node = node.append(mo('\u2061'))  # &ApplyFunction;
+        return node, string
+
+    if name in modulo_functions:
+        (binary, named, parentheses, padding) = modulo_functionsname
+        if binary:
+            node = node.append(mo('mod', lspace=padding, rspace=padding))
+            return node, string
+        # left padding
+        if node.is_block():
+            padding = '1em'
+        node = node.append(mspace(width=padding))
+        if parentheses:
+            node = node.append(mo('(', stretchy=False))
+        if named:
+            node = node.append(mi('mod'))
+            node = node.append(mspace(width='0.333em'))
+        arg, string = tex_token_or_group(string)
+        node = parse_latex_math(node, arg)
+        if parentheses:
+            node = node.append(mo(')', stretchy=False))
+        return node, string
+
+    if name in math_alphabets:
+        if name == 'boldsymbol':
+            attributes = {'class': 'boldsymbol'}
+        else:
+            attributes = {'mathvariant': math_alphabetsname}
+        if name == 'mathscr':
+            attributes'class' = 'mathscr'
+        # Check for single symbol (letter, name, or ⅀)
+        arg, remainder = tex_token_or_group(string)
+        if arg.startswith('\\'):
+            # convert single letters (so the isalpha() test below works).
+            # TODO: convert all LICRs in a group (\matrm{\mu\Omega})
+            arg = letters.get(arg1:, arg)
+        if name == 'mathbb':
+            # mathvariant="double-struck" is ignored for Greek letters
+            # (tested in Firefox 78). Use literal Unicode characters.
+            arg = mathbb.get(arg, arg)
+        if arg.isalpha() or arg == '\u2140':
+            node = node.append(mi(arg, **attributes))
+            return node, remainder
+        # Wrap in <style>
+        style = mstyle(**attributes)
+        node.append(style)
+        return style, string
+
+    # operator, fence, or separator  ->  <mo>
+
+    if name == 'colon':  # trailing punctuation, not binary relation
+        node = node.append(mo(':', form='postfix', lspace='0', rspace='0.28em'))
+        return node, string
+
+    if name == 'idotsint':
+        node = parse_latex_math(node, r'\int\dotsi\int')
+        return node, string
+
+    if name in thick_operators:
+        node = node.append(mo(thick_operatorsname, style='font-weight: bold'))
+        return node, string
+
+    if name in small_operators:
+        node = node.append(mo(small_operatorsname, mathsize='75%'))
+        return node, string
+
+    if name in operators:
+        attributes = {}
+        if name in movablelimits and string and string0 in ' _^':
+            attributes'movablelimits' = True
+        elif name in ('lvert', 'lVert'):
+            attributes'class' = 'mathopen'
+        node = node.append(mo(operatorsname, **attributes))
+        return node, string
+
+    if name in bigdelimiters:
+        delimiter_attributes = {}
+        size = delimiter_sizesbigdelimitersname
+        delimiter, string = tex_token_or_group(string)
+        if delimiter not in '()/|.':
+            try:
+                delimiter = stretchablesdelimiter.lstrip('\\')
+            except KeyError:
+                raise SyntaxError('Unsupported "\\%s" delimiter "%s"!'
+                                  % (name, delimiter))
+        if size:
+            delimiter_attributes'maxsize' = size
+            delimiter_attributes'minsize' = size
+            delimiter_attributes'symmetric' = True
+        if name == 'left' or name.endswith('l'):
             row = mrow()
             node.append(row)
             node = row
-        elif c == '}':
+        if delimiter != '.':  # '.' stands for "empty delimiter"
+            node.append(mo(delimiter, **delimiter_attributes))
+        if name == 'right' or name.endswith('r'):
             node = node.close()
-        elif c == '&':
-            entry = mtd()
-            node.close().append(entry)
-            node = entry
+        return node, string
+
+    if name == 'not':
+        arg, string = tex_token(string)
+        if arg == '{':
+            return node, '{\\not ' + string
+        if arg.startswith('\\'):  # LaTeX macro
+            try:
+                arg = operatorsarg1:
+            except KeyError:
+                raise SyntaxError('\\not: Cannot negate: "%s"!'%arg)
+        arg = unicodedata.normalize('NFC', arg+'\u0338')
+        node = node.append(mo(arg))
+        return node, string
+
+    # arbitrary text (usually comments)  ->  <mtext>
+    if name in ('text', 'mbox', 'textrm'):
+        arg, string = tex_token_or_group(string)
+        parts = arg.split('$')  # extract inline math
+        for i, part in enumerate(parts):
+            if i % 2 == 0:  # i is even
+                part = re.sub('(^ | $)', '\u00a0', part)
+                node = node.append(mtext(part))
+            else:
+                parse_latex_math(node, part)
+        return node, string
+
+    # horizontal space -> <mspace>
+    if name in spaces:
+        node = node.append(mspace(width='%s'%spacesname))
+        return node, string
+
+    if name in ('hspace', 'mspace'):
+        arg, string = tex_group(string)
+        if arg.endswith('mu'):
+            # unit "mu" (1mu=1/18em) not supported by MathML
+            arg = '%sem' % (float(arg:-2)/18)
+        node = node.append(mspace(width='%s'%arg))
+        return node, string
+
+    if name == 'phantom':
+        new_node = mphantom()
+        node.append(new_node)
+        return new_node, string
+
+    if name == 'boxed':
+        new_node = menclose(notation='box')
+        node.append(new_node)
+        return new_node, string
+
+    # Complex elements (Layout schemata)
+    # ==================================
+
+    if name == 'sqrt':
+        radix, string = tex_optarg(string)
+        if radix:
+            indexnode = mrow()
+            new_node = mroot(indexnode, switch=True)
+            parse_latex_math(indexnode, radix)
+            indexnode.close()
         else:
-            raise SyntaxError(u'Illegal character: "%s"' % c)
-        string = stringskip:
-    return tree
+            new_node = msqrt()
+        node.append(new_node)
+        return new_node, string
+
+    if name in fractions:
+        (style_atts, frac_atts) = fractionsname
+        if name == 'cfrac':
+            optarg, string = tex_optarg(string)
+            optargs = {'l': 'left', 'r': 'right'}
+            if optarg in optargs:
+                frac_atts = frac_atts.copy()
+                frac_atts'numalign' = optargsoptarg  # "numalign" is deprecated
+                frac_atts'class' = 'numalign-' + optargsoptarg
+        new_node = frac = mfrac(**frac_atts)
+        if name.endswith('binom'):
+            new_node = mrow(mo('('), new_node, mo(')'), CLASS='binom')
+            new_node.nchildren = 3
+        if style_atts:
+            new_node = mstyle(new_node, **style_atts)
+        node.append(new_node)
+        return frac, string
+
+    if name == '\\':  # end of a row
+        entry = mtd()
+        new_node = mtr(entry)
+        node.close().close().append(new_node)
+        return entry, string
+
+    if name in accents:
+        new_node = mover(mo(accentsname0, stretchy=False), switch=True)
+        if name == 'vec':
+            new_node.children0'accent' = False  # scale down arrow but drop i-dot
+        new_node.tex_cmd = name  # for HTML export
+        node.append(new_node)
+        return new_node, string
+
+    if name in over:
+        # set "accent" to False (otherwise dots on i and j are dropped)
+        # but to True on accent node get "textstyle" (full size) symbols on top
+        new_node = mover(mo(overname0, accent=True),
+                         switch=True, accent=False)
+        new_node.tex_cmd = name  # for HTML export
+        node.append(new_node)
+        return new_node, string
+
+    if name == 'overset':
+        new_node = mover(switch=True)
+        node.append(new_node)
+        return new_node, string
+
+    if name in under:
+        new_node = munder(mo(undername0), switch=True)
+        new_node.tex_cmd = name  # for HTML export
+        node.append(new_node)
+        return new_node, string
+
+    if name == 'underset':
+        new_node = munder(switch=True)
+        node.append(new_node)
+        return new_node, string
+
+    if name in ('xleftarrow', 'xrightarrow'):
+        subscript, string = tex_optarg(string)
+        base = mo(operators'long'+name1:)
+        if subscript:
+            new_node = munderover(base)
+            sub_node = parse_latex_math(mrow(), subscript)
+            if len(sub_node) == 1:
+                sub_node = sub_node.children0
+            new_node.append(sub_node)
+        else:
+            new_node = mover(base)
+        node.append(new_node)
+        return new_node, string
+
+    if name in layout_styles:  # 'displaystyle', 'textstyle', ...
+        new_node = mstyle(**layout_stylesname)
+        new_node.nchildren = None
+        if isinstance(node, mrow) and len(node) == 0:
+            # replace node with new_node
+            node.parent.childrennode.parent.children.index(node) = new_node
+            new_node.parent = node.parent
+        elif node.__class__.__name__ == 'math':
+            node.append(new_node)
+        else:
+            raise SyntaxError('Declaration "\\%s" must be first command '
+                              'in a group.' % name)
+        return new_node, string
 
+    if name.endswith('limits'):
+        arg, remainder = tex_token(string)
+        if arg in '_^':  # else ignore
+            string = remainder
+            node = handle_script_or_limit(node, arg, limits=name)
+        return node, string
+
+    # Environments
 
-def handle_keyword(name, node, string):
-    skip = 0
-    if len(string) > 0 and string0 == ' ':
-        string = string1:
-        skip = 1
     if name == 'begin':
-        if not string.startswith('{matrix}'):
-            raise SyntaxError(u'Environment not supported! '
-                              u'Supported environment: "matrix".')
-        skip += 8
-        entry = mtd()
-        table = mtable(mtr(entry))
-        node.append(table)
-        node = entry
-    elif name == 'end':
-        if not string.startswith('{matrix}'):
-            raise SyntaxError(u'Expected "\\end{matrix}"!')
-        skip += 8
-        node = node.close().close().close()
-    elif name in ('text', 'mathrm'):
-        if string0 != '{':
-            raise SyntaxError(u'Expected "\\text{...}"!')
-        i = string.find('}')
-        if i == -1:
-            raise SyntaxError(u'Expected "\\text{...}"!')
-        node = node.append(mtext(string1:i))
-        skip += i + 1
-    elif name == 'sqrt':
-        sqrt = msqrt()
-        node.append(sqrt)
-        node = sqrt
-    elif name == 'frac':
-        frac = mfrac()
-        node.append(frac)
-        node = frac
-    elif name == 'left':
-        for par in '(', '', '|', '\\{', '\\langle', '.':
-            if string.startswith(par):
-                break
+        return begin_environment(node, string)
+
+    if name == 'end':
+        return end_environment(node, string)
+
+    raise SyntaxError('Unknown LaTeX command: \\' + name)
+
+# >>> handle_cmd('left', math(), 'a\\right')
+# (mrow(mo('')), 'a\\right')
+# >>> handle_cmd('left', math(), '. a)') # empty \left
+# (mrow(), ' a)')
+# >>> handle_cmd('left', math(), '\\uparrow a)') # cmd
+# (mrow(mo('↑')), 'a)')
+# >>> handle_cmd('not', math(), '\\equiv \\alpha)') # cmd
+# (math(mo('≢')), '\\alpha)')
+# >>> handle_cmd('text', math(), '{ for } i>0') # group
+# (math(mtext('\xa0for\xa0')), ' i>0')
+# >>> handle_cmd('text', math(), '{B}T') # group
+# (math(mtext('B')), 'T')
+# >>> handle_cmd('text', math(), '{number of apples}}') # group
+# (math(mtext('number of apples')), '}')
+# >>> handle_cmd('text', math(), 'i \\sin(x)') # single char
+# (math(mtext('i')), ' \\sin(x)')
+# >>> handle_cmd('sin', math(), '(\\alpha)')
+# (math(mi('sin'), mo('\u2061')), '(\\alpha)')
+# >>> handle_cmd('sin', math(), ' \\alpha')
+# (math(mi('sin'), mo('\u2061')), ' \\alpha')
+# >>> handle_cmd('operatorname', math(), '{abs}(x)')
+# (math(mi('abs', mathvariant='normal'), mo('\u2061')), '(x)')
+# >>> handle_cmd('mathrm', math(), '\\alpha')
+# (math(mi('α', mathvariant='normal')), '')
+# >>> handle_cmd('mathrm', math(), '{out} = 3')
+# (math(mi('out', mathvariant='normal')), ' = 3')
+# >>> handle_cmd('overline', math(), '{981}')
+# (mover(mo('_', accent=True), switch=True, accent=False), '{981}')
+# >>> handle_cmd('bar', math(), '{x}')
+# (mover(mo('ˉ', stretchy=False), switch=True), '{x}')
+# >>> handle_cmd('xleftarrow', math(), r'\alpha{10}')
+# (munderover(mo('⟵'), mi('α')), '{10}')
+# >>> handle_cmd('xleftarrow', math(), r'\alpha=5{10}')
+# (munderover(mo('⟵'), mrow(mi('α'), mo('='), mn('5'))), '{10}')
+
+
+def handle_script_or_limit(node, c, limits=''):
+    """Append script or limit element to `node`."""
+    child = node.children.pop()
+    if limits == 'limits':
+        child'movablelimits' = False
+    elif (limits == 'movablelimits'
+          or getattr(child, 'data', '') in movablelimits):
+        child'movablelimits' = True
+
+    if c == '_':
+        if isinstance(child, mover):
+            new_node = munderover(*child.children, switch=True)
+        elif isinstance(child, msup):
+            new_node = msubsup(*child.children, switch=True)
+        elif (limits in ('limits', 'movablelimits')
+              or limits == '' and child.get('movablelimits', None)):
+            new_node = munder(child)
         else:
-            raise SyntaxError(u'Missing left-brace!')
-        fenced = mfenced(par)
-        node.append(fenced)
-        row = mrow()
-        fenced.append(row)
-        node = row
-        skip += len(par)
-    elif name == 'right':
-        for par in ')', '', '|', '\\}', '\\rangle', '.':
-            if string.startswith(par):
-                break
+            new_node = msub(child)
+    elif c == '^':
+        if isinstance(child, munder):
+            new_node = munderover(*child.children)
+        elif isinstance(child, msub):
+            new_node = msubsup(*child.children)
+        elif (limits in ('limits', 'movablelimits')
+              or limits == '' and child.get('movablelimits', None)):
+            new_node = mover(child)
         else:
-            raise SyntaxError(u'Missing right-brace!')
-        node = node.close()
-        node.closepar = par
-        node = node.close()
-        skip += len(par)
-    elif name == 'not':
-        for operator in negatables:
-            if string.startswith(operator):
-                break
-        else:
-            raise SyntaxError(u'Expected something to negate: "\\not ..."!')
-        node = node.append(mo(negatablesoperator))
-        skip += len(operator)
-    elif name == 'mathbf':
-        style = mstyle(nchildren=1, mathvariant='bold')
-        node.append(style)
-        node = style
-    elif name == 'mathbb':
-        if string0 != '{' or not string1.isupper() or string2 != '}':
-            raise SyntaxError(u'Expected something like "\\mathbb{A}"!')
-        node = node.append(mi(mathbbstring1))
-        skip += 3
-    elif name in ('mathscr', 'mathcal'):
-        if string0 != '{' or string2 != '}':
-            raise SyntaxError(u'Expected something like "\\mathscr{A}"!')
-        node = node.append(mi(mathscrstring1))
-        skip += 3
-    elif name == 'colon': # "normal" colon, not binary operator
-        node = node.append(mo(':')) # TODO: add ``lspace="0pt"``
-    elif name in Greek:   # Greek capitals (upright in "TeX style")
-        node = node.append(mo(Greekname))
-        # TODO: "ISO style" sets them italic. Could we use a class argument
-        # to enable styling via CSS?
-    elif name in letters:
-        node = node.append(mi(lettersname))
-    elif name in special:
-        node = node.append(mo(specialname))
-    elif name in functions:
-        node = node.append(mo(name))
-    elif name in over:
-        ovr = mover(mo(overname), reversed=True)
-        node.append(ovr)
-        node = ovr
+            new_node = msup(child)
+    node.append(new_node)
+    return new_node
+
+
+def begin_environment(node, string):
+    name, string = tex_group(string)
+    if name in matrices:
+        left_delimiter = matricesname0
+        attributes = {}
+        if left_delimiter:
+            wrapper = mrow(mo(left_delimiter))
+            if name == 'cases':
+                wrapper = mrow(mo(left_delimiter, rspace='0.17em'))
+                attributes'columnalign' = 'left'
+            node.append(wrapper)
+            node = wrapper
+        elif name == 'smallmatrix':
+            attributes'rowspacing' = '0.02em'
+            attributes'columnspacing' = '0.333em'
+            wrapper = mstyle(scriptlevel='1')
+            node.append(wrapper)
+            node = wrapper
+        # TODO: aligned, alignedat
+        # take an optional t, b or the default c
+        entry = mtd()
+        node.append(mtable(mtr(entry), **attributes))
+        node = entry
     else:
-        raise SyntaxError(u'Unknown LaTeX command: ' + name)
+        raise SyntaxError('Environment not supported!')
+    return node, string
+
+
+def end_environment(node, string):
+    name, string = tex_group(string)
+    if name in matrices:
+        node = node.close().close().close()  # close: mtd, mdr, mtable
+        right_delimiter = matricesname1
+        if right_delimiter:
+            node = node.append(mo(right_delimiter))
+            node = node.close()
+        elif name == 'cases':
+            node = node.close()
+    else:
+        raise SyntaxError('Environment not supported!')
+    return node, string
+
+
+# Return the number of "equation_columns" in `code_lines`. cf. "alignat"
+# in http://mirror.ctan.org/macros/latex/required/amsmath/amsldoc.pdf
+def tex_equation_columns(rows):
+    tabs = max(row.count('&') - row.count(r'\&') for row in rows)
+    if tabs == 0:
+        return 0
+    return int(tabs/2 + 1)
+
+# >>> tex_equation_columns('a = b')
+# 0
+# >>> tex_equation_columns('a &= b')
+# 1
+# >>> tex_equation_columns('a &= b & a \in S')
+# 2
+# >>> tex_equation_columns('a &= b & c &= d')
+# 2
+
+
+# Return dictionary with attributes to style an <mtable> as align environment:
+def align_attributes(rows):
+    atts = {'class': 'align',
+            'displaystyle': True}
+    tabs = max(row.count('&') - row.count(r'\&') for row in rows)
+    if tabs:
+        aligns = 'right', 'left' * tabs
+        spacing = '0', '2em' * tabs
+        atts'columnalign' = ' '.join(aligns:tabs+1)
+        atts'columnspacing' = ' '.join(spacing:tabs)
+    return atts
+
+# >>> align_attributes('a = b')
+# {'class': 'align', 'displaystyle': True}
+# >>> align_attributes('a &= b')
+# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left', 'columnspacing': '0'}
+# >>> align_attributes('a &= b & a \in S')
+# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right', 'columnspacing': '0 2em'}
+# >>> align_attributes('a &= b & c &= d')
+# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right left', 'columnspacing': '0 2em 0'}
 
-    return node, skip
 
 def tex2mathml(tex_math, inline=True):
     """Return string with MathML code corresponding to `tex_math`.
 
-    `inline`=True is for inline math and `inline`=False for displayed math.
+    Set `inline` to False for displayed math.
     """
-
-    mathml_tree = parse_latex_math(tex_math, inline=inline)
-    return ''.join(mathml_tree.xml())
+    # Set up tree
+    math_tree = math(xmlns='http://www.w3.org/1998/Math/MathML')
+    node = math_tree
+    if not inline:
+        math_tree'display' = 'block'
+        rows = toplevel_code(tex_math).split(r'\\')
+        if len(rows) > 1:
+            # emulate align* environment with a math table
+            node = mtd()
+            math_tree.append(mtable(mtr(node),
+                                    **align_attributes(rows)))
+    parse_latex_math(node, tex_math)
+    return math_tree.toprettyxml()
+
+# >>> print(tex2mathml('3'))
+# <math xmlns="http://www.w3.org/1998/Math/MathML">
+#   <mn>3</mn>
+# </math>
+# >>> print(tex2mathml('3', inline=False))
+# <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+#   <mn>3</mn>
+# </math>
+# >>> print(tex2mathml(r'a & b \\ c & d', inline=False))
+# <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+#   <mtable class="align" displaystyle="true" columnalign="right left" columnspacing="0">
+#     <mtr>
+#       <mtd>
+#         <mi>a</mi>
+#       </mtd>
+#       <mtd>
+#         <mi>b</mi>
+#       </mtd>
+#     </mtr>
+#     <mtr>
+#       <mtd>
+#         <mi>c</mi>
+#       </mtd>
+#       <mtd>
+#         <mi>d</mi>
+#       </mtd>
+#     </mtr>
+#   </mtable>
+# </math>
+# >>> print(tex2mathml(r'a \\ b', inline=False))
+# <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+#   <mtable class="align" displaystyle="true">
+#     <mtr>
+#       <mtd>
+#         <mi>a</mi>
+#       </mtd>
+#     </mtr>
+#     <mtr>
+#       <mtd>
+#         <mi>b</mi>
+#       </mtd>
+#     </mtr>
+#   </mtable>
+# </math>
+
+
+# TODO: look up more symbols from tr25, e.g.
+#
+#
+# Table 2.8 Using Vertical Line or Solidus Overlay
+#   some of the negated forms of mathematical relations that can only be
+#   encoded by using either U+0338 COMBINING LONG SOLIDUS OVERLAY or U+20D2
+#   COMBINING LONG VERTICAL LINE OVERLAY . (For issues with using 0338 in
+#   MathML, see Section 3.2.7, Combining Marks.
+#
+# Table 2.9 Variants of Mathematical Symbols using VS1?
+#
+# Sequence      Description
+# 0030 + VS1    DIGIT ZERO - short diagonal stroke form
+# 2205 + VS1    EMPTY SET - zero with long diagonal stroke overlay form
+# 2229 + VS1    INTERSECTION - with serifs
+# 222A + VS1    UNION - with serifs
+# 2268 + VS1    LESS-THAN BUT NOT EQUAL TO - with vertical stroke
+# 2269 + VS1    GREATER-THAN BUT NOT EQUAL TO - with vertical stroke
+# 2272 + VS1    LESS-THAN OR EQUIVALENT TO - following the slant of the lower leg
+# 2273 + VS1    GREATER-THAN OR EQUIVALENT TO - following the slant of the lower leg
+# 228A + VS1    SUBSET OF WITH NOT EQUAL TO - variant with stroke through bottom members
+# 228B + VS1    SUPERSET OF WITH NOT EQUAL TO - variant with stroke through bottom members
+# 2293 + VS1    SQUARE CAP - with serifs
+# 2294 + VS1    SQUARE CUP - with serifs
+# 2295 + VS1    CIRCLED PLUS - with white rim
+# 2297 + VS1    CIRCLED TIMES - with white rim
+# 229C + VS1    CIRCLED EQUALS - equal sign inside and touching the circle
+# 22DA + VS1    LESS-THAN slanted EQUAL TO OR GREATER-THAN
+# 22DB + VS1    GREATER-THAN slanted EQUAL TO OR LESS-THAN
+# 2A3C + VS1    INTERIOR PRODUCT - tall variant with narrow foot
+# 2A3D + VS1    RIGHTHAND INTERIOR PRODUCT - tall variant with narrow foot
+# 2A9D + VS1    SIMILAR OR LESS-THAN - following the slant of the upper leg
+# 2A9E + VS1    SIMILAR OR GREATER-THAN - following the slant of the upper leg
+# 2AAC + VS1    SMALLER THAN OR slanted EQUAL
+# 2AAD + VS1    LARGER THAN OR slanted EQUAL
+# 2ACB + VS1    SUBSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members
+# 2ACC + VS1    SUPERSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/math2html.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/math2html.py Changed

@@ -1,9 +1,7 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
+#! /usr/bin/env python3
 #   math2html: convert LaTeX equations to HTML output.
 #
-#   Copyright (C) 2009-2011 Alex Fernández
+#   Copyright (C) 2009-2011 Alex Fernández, 2021 Günter Milde
 #
 #   Released under the terms of the `2-Clause BSD license'_, in short:
 #   Copying and distribution of this file, with or without modification,
@@ -16,5368 +14,3158 @@
 #   Based on eLyXer: convert LyX source files to HTML output.
 #   http://alexfernandez.github.io/elyxer/
 
-# --end--
-# Alex 20101110
-# eLyXer standalone formula conversion to HTML.
-
-import codecs
-import datetime
-import gettext
-import io
-import os.path
+# Versions:
+# 1.2.5  2015-02-26  eLyXer standalone formula conversion to HTML.
+# 1.3    2021-06-02  Removed code for conversion of LyX files not
+#                    required for LaTeX math.
+#                    Support for more math commands from the AMS "math-guide".
+# 2.0    2021-12-31  Drop 2.7 compatibility code.
+
+import pathlib
 import sys
 import unicodedata
 
-if sys.version_info >= (3, 0):
-    from urllib.parse import quote_plus
-else:
-    from urllib import quote_plus
-
-
-if sys.version_info >= (3, 0):
-    unicode = str  #noqa
-    basestring = str  # noqa
-    file = io.IOBase  # noqa
-
-
-class Trace(object):
-  "A tracing class"
-
-  debugmode = False
-  quietmode = False
-  showlinesmode = False
-
-  prefix = None
-
-  def debug(cls, message):
-    "Show a debug message"
-    if not Trace.debugmode or Trace.quietmode:
-      return
-    Trace.show(message, sys.stdout)
-
-  def message(cls, message):
-    "Show a trace message"
-    if Trace.quietmode:
-      return
-    if Trace.prefix and Trace.showlinesmode:
-      message = Trace.prefix + message
-    Trace.show(message, sys.stdout)
-
-  def error(cls, message):
-    "Show an error message"
-    message = '* ' + message
-    if Trace.prefix and Trace.showlinesmode:
-      message = Trace.prefix + message
-    Trace.show(message, sys.stderr)
-
-  def fatal(cls, message):
-    "Show an error message and terminate"
-    Trace.error('FATAL: ' + message)
-    exit(-1)
-
-  def show(cls, message, channel):
-    "Show a message out of a channel"
-    if sys.version_info < (3, 0):
-      message = message.encode('utf-8')
-    channel.write(message + '\n')
-
-  debug = classmethod(debug)
-  message = classmethod(message)
-  error = classmethod(error)
-  fatal = classmethod(fatal)
-  show = classmethod(show)
-
-
-class BibStylesConfig(object):
-  "Configuration class from elyxer.config file"
-
-  abbrvnat = {
-      u'@article': u'$authors. $title. <i>$journal</i>,{ {$volume:}$pages,} $month $year.{ doi: $doi.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$surname($year)',
-      u'default': u'$authors. <i>$title</i>. $publisher, $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      }
-
-  alpha = {
-      u'@article': u'$authors. $title.{ <i>$journal</i>{, {$volume}{($number)}}{: $pages}{, $year}.}{ <a href="$url">$url</a>.}{ <a href="$filename">$filename</a>.}{ $note.}',
-      u'cite': u'$Sur$YY',
-      u'default': u'$authors. $title.{ <i>$journal</i>,} $year.{ <a href="$url">$url</a>.}{ <a href="$filename">$filename</a>.}{ $note.}',
-      }
-
-  authordate2 = {
-      u'@article': u'$authors. $year. $title. <i>$journal</i>, <b>$volume</b>($number), $pages.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@book': u'$authors. $year. <i>$title</i>. $publisher.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$surname, $year',
-      u'default': u'$authors. $year. <i>$title</i>. $publisher.{ URL <a href="$url">$url</a>.}{ $note.}',
-      }
-
-  default = {
-      u'@article': u'$authors: “$title”, <i>$journal</i>,{ pp. $pages,} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@book': u'{$authors: }<i>$title</i>{ ($editor, ed.)}.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@booklet': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@conference': u'$authors: “$title”, <i>$journal</i>,{ pp. $pages,} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@inbook': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@incollection': u'$authors: <i>$title</i>{ in <i>$booktitle</i>{ ($editor, ed.)}}.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@inproceedings': u'$authors: “$title”, <i>$booktitle</i>,{ pp. $pages,} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@manual': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@mastersthesis': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@misc': u'$authors: <i>$title</i>.{{ $publisher,}{ $howpublished,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@phdthesis': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@proceedings': u'$authors: “$title”, <i>$journal</i>,{ pp. $pages,} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@techreport': u'$authors: <i>$title</i>, $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@unpublished': u'$authors: “$title”, <i>$journal</i>, $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$index',
-      u'default': u'$authors: <i>$title</i>.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      }
-
-  defaulttags = {
-      u'YY': u'??', u'authors': u'', u'surname': u'',
-      }
-
-  ieeetr = {
-      u'@article': u'$authors, “$title”, <i>$journal</i>, vol. $volume, no. $number, pp. $pages, $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@book': u'$authors, <i>$title</i>. $publisher, $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$index',
-      u'default': u'$authors, “$title”. $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      }
-
-  plain = {
-      u'@article': u'$authors. $title.{ <i>$journal</i>{, {$volume}{($number)}}{:$pages}{, $year}.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@book': u'$authors. <i>$title</i>. $publisher,{ $month} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@incollection': u'$authors. $title.{ In <i>$booktitle</i> {($editor, ed.)}.} $publisher,{ $month} $year.{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'@inproceedings': u'$authors. $title. { <i>$booktitle</i>{, {$volume}{($number)}}{:$pages}{, $year}.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$index',
-      u'default': u'{$authors. }$title.{{ $publisher,} $year.}{ URL <a href="$url">$url</a>.}{ $note.}',
-      }
-
-  vancouver = {
-      u'@article': u'$authors. $title. <i>$journal</i>, $year{;{<b>$volume</b>}{($number)}{:$pages}}.{ URL: <a href="$url">$url</a>.}{ $note.}',
-      u'@book': u'$authors. $title. {$publisher, }$year.{ URL: <a href="$url">$url</a>.}{ $note.}',
-      u'cite': u'$index',
-      u'default': u'$authors. $title; {$publisher, }$year.{ $howpublished.}{ URL: <a href="$url">$url</a>.}{ $note.}',
-      }
-
-class BibTeXConfig(object):
-  "Configuration class from elyxer.config file"
-
-  replaced = {
-      u'--': u'—', u'..': u'.',
-      }
-
-class ContainerConfig(object):
-  "Configuration class from elyxer.config file"
-
-  endings = {
-      u'Align': u'\\end_layout', u'BarredText': u'\\bar',
-      u'BoldText': u'\\series', u'Cell': u'</cell',
-      u'ChangeDeleted': u'\\change_unchanged',
-      u'ChangeInserted': u'\\change_unchanged', u'ColorText': u'\\color',
-      u'EmphaticText': u'\\emph', u'Hfill': u'\\hfill', u'Inset': u'\\end_inset',
-      u'Layout': u'\\end_layout', u'LyXFooter': u'\\end_document',
-      u'LyXHeader': u'\\end_header', u'Row': u'</row', u'ShapedText': u'\\shape',
-      u'SizeText': u'\\size', u'StrikeOut': u'\\strikeout',
-      u'TextFamily': u'\\family', u'VersalitasText': u'\\noun',
-      }
-
-  extracttext = {
-      u'allowed': u'StringContainer', u'Constant', u'FormulaConstant',,
-      u'cloned': u'',,
-      u'extracted': u'PlainLayout', u'TaggedText', u'Align', u'Caption', u'TextFamily', u'EmphaticText', u'VersalitasText', u'BarredText', u'SizeText', u'ColorText', u'LangLine', u'Formula', u'Bracket', u'RawText', u'BibTag', u'FormulaNumber', u'AlphaCommand', u'EmptyCommand', u'OneParamFunction', u'SymbolFunction', u'TextFunction', u'FontFunction', u'CombiningFunction', u'DecoratingFunction', u'FormulaSymbol', u'BracketCommand', u'TeXCode',,
-      }
-
-  startendings = {
-      u'\\begin_deeper': u'\\end_deeper', u'\\begin_inset': u'\\end_inset',
-      u'\\begin_layout': u'\\end_layout',
-      }
-
-  starts = {
-      u'': u'StringContainer', u'#LyX': u'BlackBox', u'</lyxtabular': u'BlackBox',
-      u'<cell': u'Cell', u'<column': u'Column', u'<row': u'Row',
-      u'\\align': u'Align', u'\\bar': u'BarredText',
-      u'\\bar default': u'BlackBox', u'\\bar no': u'BlackBox',
-      u'\\begin_body': u'BlackBox', u'\\begin_deeper': u'DeeperList',
-      u'\\begin_document': u'BlackBox', u'\\begin_header': u'LyXHeader',
-      u'\\begin_inset Argument': u'ShortTitle',
-      u'\\begin_inset Box': u'BoxInset', u'\\begin_inset Branch': u'Branch',
-      u'\\begin_inset Caption': u'Caption',
-      u'\\begin_inset CommandInset bibitem': u'BiblioEntry',
-      u'\\begin_inset CommandInset bibtex': u'BibTeX',
-      u'\\begin_inset CommandInset citation': u'BiblioCitation',
-      u'\\begin_inset CommandInset href': u'URL',
-      u'\\begin_inset CommandInset include': u'IncludeInset',
-      u'\\begin_inset CommandInset index_print': u'PrintIndex',
-      u'\\begin_inset CommandInset label': u'Label',
-      u'\\begin_inset CommandInset line': u'LineInset',
-      u'\\begin_inset CommandInset nomencl_print': u'PrintNomenclature',
-      u'\\begin_inset CommandInset nomenclature': u'NomenclatureEntry',
-      u'\\begin_inset CommandInset ref': u'Reference',
-      u'\\begin_inset CommandInset toc': u'TableOfContents',
-      u'\\begin_inset ERT': u'ERT', u'\\begin_inset Flex': u'FlexInset',
-      u'\\begin_inset Flex Chunkref': u'NewfangledChunkRef',
-      u'\\begin_inset Flex Marginnote': u'SideNote',
-      u'\\begin_inset Flex Sidenote': u'SideNote',
-      u'\\begin_inset Flex URL': u'FlexURL', u'\\begin_inset Float': u'Float',
-      u'\\begin_inset FloatList': u'ListOf', u'\\begin_inset Foot': u'Footnote',
-      u'\\begin_inset Formula': u'Formula',
-      u'\\begin_inset FormulaMacro': u'FormulaMacro',
-      u'\\begin_inset Graphics': u'Image',
-      u'\\begin_inset Index': u'IndexReference',
-      u'\\begin_inset Info': u'InfoInset',
-      u'\\begin_inset LatexCommand bibitem': u'BiblioEntry',
-      u'\\begin_inset LatexCommand bibtex': u'BibTeX',
-      u'\\begin_inset LatexCommand cite': u'BiblioCitation',
-      u'\\begin_inset LatexCommand citealt': u'BiblioCitation',
-      u'\\begin_inset LatexCommand citep': u'BiblioCitation',
-      u'\\begin_inset LatexCommand citet': u'BiblioCitation',
-      u'\\begin_inset LatexCommand htmlurl': u'URL',
-      u'\\begin_inset LatexCommand index': u'IndexReference',
-      u'\\begin_inset LatexCommand label': u'Label',
-      u'\\begin_inset LatexCommand nomenclature': u'NomenclatureEntry',
-      u'\\begin_inset LatexCommand prettyref': u'Reference',
-      u'\\begin_inset LatexCommand printindex': u'PrintIndex',
-      u'\\begin_inset LatexCommand printnomenclature': u'PrintNomenclature',
-      u'\\begin_inset LatexCommand ref': u'Reference',
-      u'\\begin_inset LatexCommand tableofcontents': u'TableOfContents',
-      u'\\begin_inset LatexCommand url': u'URL',
-      u'\\begin_inset LatexCommand vref': u'Reference',
-      u'\\begin_inset Marginal': u'SideNote',
-      u'\\begin_inset Newline': u'NewlineInset',
-      u'\\begin_inset Newpage': u'NewPageInset', u'\\begin_inset Note': u'Note',
-      u'\\begin_inset OptArg': u'ShortTitle',
-      u'\\begin_inset Phantom': u'PhantomText',
-      u'\\begin_inset Quotes': u'QuoteContainer',
-      u'\\begin_inset Tabular': u'Table', u'\\begin_inset Text': u'InsetText',
-      u'\\begin_inset VSpace': u'VerticalSpace', u'\\begin_inset Wrap': u'Wrap',
-      u'\\begin_inset listings': u'Listing',
-      u'\\begin_inset script': u'ScriptInset', u'\\begin_inset space': u'Space',
-      u'\\begin_layout': u'Layout', u'\\begin_layout Abstract': u'Abstract',
-      u'\\begin_layout Author': u'Author',
-      u'\\begin_layout Bibliography': u'Bibliography',
-      u'\\begin_layout Chunk': u'NewfangledChunk',
-      u'\\begin_layout Description': u'Description',
-      u'\\begin_layout Enumerate': u'ListItem',
-      u'\\begin_layout Itemize': u'ListItem', u'\\begin_layout List': u'List',
-      u'\\begin_layout LyX-Code': u'LyXCode',
-      u'\\begin_layout Plain': u'PlainLayout',
-      u'\\begin_layout Standard': u'StandardLayout',
-      u'\\begin_layout Title': u'Title', u'\\begin_preamble': u'LyXPreamble',
-      u'\\change_deleted': u'ChangeDeleted',
-      u'\\change_inserted': u'ChangeInserted',
-      u'\\change_unchanged': u'BlackBox', u'\\color': u'ColorText',
-      u'\\color inherit': u'BlackBox', u'\\color none': u'BlackBox',
-      u'\\emph default': u'BlackBox', u'\\emph off': u'BlackBox',
-      u'\\emph on': u'EmphaticText', u'\\emph toggle': u'EmphaticText',
-      u'\\end_body': u'LyXFooter', u'\\family': u'TextFamily',
-      u'\\family default': u'BlackBox', u'\\family roman': u'BlackBox',
-      u'\\hfill': u'Hfill', u'\\labelwidthstring': u'BlackBox',
-      u'\\lang': u'LangLine', u'\\length': u'InsetLength',
-      u'\\lyxformat': u'LyXFormat', u'\\lyxline': u'LyXLine',
-      u'\\newline': u'Newline', u'\\newpage': u'NewPage',
-      u'\\noindent': u'BlackBox', u'\\noun default': u'BlackBox',
-      u'\\noun off': u'BlackBox', u'\\noun on': u'VersalitasText',
-      u'\\paragraph_spacing': u'BlackBox', u'\\series bold': u'BoldText',
-      u'\\series default': u'BlackBox', u'\\series medium': u'BlackBox',
-      u'\\shape': u'ShapedText', u'\\shape default': u'BlackBox',
-      u'\\shape up': u'BlackBox', u'\\size': u'SizeText',
-      u'\\size normal': u'BlackBox', u'\\start_of_appendix': u'StartAppendix',
-      u'\\strikeout default': u'BlackBox', u'\\strikeout on': u'StrikeOut',
-      }
-
-  string = {
-      u'startcommand': u'\\',
-      }
-
-  table = {
-      u'headers': u'<lyxtabular', u'<features',,
-      }
-
-class EscapeConfig(object):
-  "Configuration class from elyxer.config file"
-
-  chars = {
-      u'\n': u'', u' -- ': u' — ', u' --- ': u' — ', u'\'': u'’', u'`': u'‘',
-      }
-
-  commands = {
-      u'\\InsetSpace \\space{}': u' ', u'\\InsetSpace \\thinspace{}': u' ',
-      u'\\InsetSpace ~': u' ', u'\\SpecialChar \\-': u'',
-      u'\\SpecialChar \\@.': u'.', u'\\SpecialChar \\ldots{}': u'…',
-      u'\\SpecialChar \\menuseparator': u' ▷ ',
-      u'\\SpecialChar \\nobreakdash-': u'-', u'\\SpecialChar \\slash{}': u'/',
-      u'\\SpecialChar \\textcompwordmark{}': u'', u'\\backslash': u'\\',
-      }
-
-  entities = {
-      u'&': u'&amp;', u'<': u'&lt;', u'>': u'&gt;',
-      }
-
-  html = {
-      u'/>': u'>',
-      }
-
-  iso885915 = {
-      u' ': u'&nbsp;', u' ': u'&emsp;', u' ': u'&#8197;',
-      }
-
-  nonunicode = {
-      u' ': u' ',
-      }
-
-class FormulaConfig(object):
-  "Configuration class from elyxer.config file"
-
-  alphacommands = {
-      u'\\AA': u'Å', u'\\AE': u'Æ',
-      u'\\AmS': u'<span class="versalitas">AmS</span>', u'\\Angstroem': u'Å',
-      u'\\DH': u'Ð', u'\\Koppa': u'Ϟ', u'\\L': u'Ł', u'\\Micro': u'µ', u'\\O': u'Ø',
-      u'\\OE': u'Œ', u'\\Sampi': u'Ϡ', u'\\Stigma': u'Ϛ', u'\\TH': u'Þ',
-      u'\\aa': u'å', u'\\ae': u'æ', u'\\alpha': u'α', u'\\beta': u'β',
-      u'\\delta': u'δ', u'\\dh': u'ð', u'\\digamma': u'ϝ', u'\\epsilon': u'ϵ',
-      u'\\eta': u'η', u'\\eth': u'ð', u'\\gamma': u'γ', u'\\i': u'ı',
-      u'\\imath': u'ı', u'\\iota': u'ι', u'\\j': u'ȷ', u'\\jmath': u'ȷ',
-      u'\\kappa': u'κ', u'\\koppa': u'ϟ', u'\\l': u'ł', u'\\lambda': u'λ',
-      u'\\mu': u'μ', u'\\nu': u'ν', u'\\o': u'ø', u'\\oe': u'œ', u'\\omega': u'ω',
-      u'\\phi': u'φ', u'\\pi': u'π', u'\\psi': u'ψ', u'\\rho': u'ρ',
-      u'\\sampi': u'ϡ', u'\\sigma': u'σ', u'\\ss': u'ß', u'\\stigma': u'ϛ',
-      u'\\tau': u'τ', u'\\tcohm': u'Ω', u'\\textcrh': u'ħ', u'\\th': u'þ',
-      u'\\theta': u'θ', u'\\upsilon': u'υ', u'\\varDelta': u'∆',
-      u'\\varGamma': u'Γ', u'\\varLambda': u'Λ', u'\\varOmega': u'Ω',
-      u'\\varPhi': u'Φ', u'\\varPi': u'Π', u'\\varPsi': u'Ψ', u'\\varSigma': u'Σ',
-      u'\\varTheta': u'Θ', u'\\varUpsilon': u'Υ', u'\\varXi': u'Ξ',
-      u'\\varbeta': u'ϐ', u'\\varepsilon': u'ε', u'\\varkappa': u'ϰ',
-      u'\\varphi': u'φ', u'\\varpi': u'ϖ', u'\\varrho': u'ϱ', u'\\varsigma': u'ς',
-      u'\\vartheta': u'ϑ', u'\\xi': u'ξ', u'\\zeta': u'ζ',
-      }
-
-  array = {
-      u'begin': u'\\begin', u'cellseparator': u'&', u'end': u'\\end',
-      u'rowseparator': u'\\\\',
-      }
-
-  bigbrackets = {
-      u'(': u'⎛', u'⎜', u'⎝',, u')': u'⎞', u'⎟', u'⎠',, u'': u'⎡', u'⎢', u'⎣',,
-      u'': u'⎤', u'⎥', u'⎦',, u'{': u'⎧', u'⎪', u'⎨', u'⎩',, u'|': u'|',,
-      u'}': u'⎫', u'⎪', u'⎬', u'⎭',, u'∥': u'∥',,
-      }
-
-  bigsymbols = {
-      u'∑': u'⎲', u'⎳',, u'∫': u'⌠', u'⌡',,
-      }
-
-  bracketcommands = {
-      u'\\left': u'span class="symbol"',
-      u'\\left.': u'<span class="leftdot"></span>',
-      u'\\middle': u'span class="symbol"', u'\\right': u'span class="symbol"',
-      u'\\right.': u'<span class="rightdot"></span>',
-      }
-
-  combiningfunctions = {
-      u'\\"': u'̈', u'\\\'': u'́', u'\\^': u'̂', u'\\`': u'̀', u'\\acute': u'́',
-      u'\\bar': u'̄', u'\\breve': u'̆', u'\\c': u'̧', u'\\check': u'̌',
-      u'\\dddot': u'⃛', u'\\ddot': u'̈', u'\\dot': u'̇', u'\\grave': u'̀',
-      u'\\hat': u'̂', u'\\mathring': u'̊', u'\\overleftarrow': u'⃖',
-      u'\\overrightarrow': u'⃗', u'\\r': u'̊', u'\\s': u'̩',
-      u'\\textcircled': u'⃝', u'\\textsubring': u'̥', u'\\tilde': u'̃',
-      u'\\v': u'̌', u'\\vec': u'⃗', u'\\~': u'̃',
-      }
-
-  commands = {
-      u'\\ ': u' ', u'\\!': u'', u'\\#': u'#', u'\\$': u'$', u'\\%': u'%',
-      u'\\&': u'&', u'\\,': u' ', u'\\:': u' ', u'\\;': u' ', u'\\AC': u'∿',
-      u'\\APLcomment': u'⍝', u'\\APLdownarrowbox': u'⍗', u'\\APLinput': u'⍞',
-      u'\\APLinv': u'⌹', u'\\APLleftarrowbox': u'⍇', u'\\APLlog': u'⍟',
-      u'\\APLrightarrowbox': u'⍈', u'\\APLuparrowbox': u'⍐', u'\\Box': u'□',
-      u'\\Bumpeq': u'≎', u'\\CIRCLE': u'●', u'\\Cap': u'⋒',
-      u'\\CapitalDifferentialD': u'ⅅ', u'\\CheckedBox': u'☑', u'\\Circle': u'○',
-      u'\\Coloneqq': u'⩴', u'\\ComplexI': u'ⅈ', u'\\ComplexJ': u'ⅉ',
-      u'\\Corresponds': u'≙', u'\\Cup': u'⋓', u'\\Delta': u'Δ', u'\\Diamond': u'◇',
-      u'\\Diamondblack': u'◆', u'\\Diamonddot': u'⟐', u'\\DifferentialD': u'ⅆ',
-      u'\\Downarrow': u'⇓', u'\\EUR': u'€', u'\\Euler': u'ℇ',
-      u'\\ExponetialE': u'ⅇ', u'\\Finv': u'Ⅎ', u'\\Game': u'⅁', u'\\Gamma': u'Γ',
-      u'\\Im': u'ℑ', u'\\Join': u'⨝', u'\\LEFTCIRCLE': u'◖', u'\\LEFTcircle': u'◐',
-      u'\\LHD': u'◀', u'\\Lambda': u'Λ', u'\\Lbag': u'⟅', u'\\Leftarrow': u'⇐',
-      u'\\Lleftarrow': u'⇚', u'\\Longleftarrow': u'⟸',
-      u'\\Longleftrightarrow': u'⟺', u'\\Longrightarrow': u'⟹', u'\\Lparen': u'⦅',
-      u'\\Lsh': u'↰', u'\\Mapsfrom': u'⇐|', u'\\Mapsto': u'|⇒', u'\\Omega': u'Ω',
-      u'\\P': u'¶', u'\\Phi': u'Φ', u'\\Pi': u'Π', u'\\Pr': u'Pr', u'\\Psi': u'Ψ',
-      u'\\Qoppa': u'Ϙ', u'\\RHD': u'▶', u'\\RIGHTCIRCLE': u'◗',
-      u'\\RIGHTcircle': u'◑', u'\\Rbag': u'⟆', u'\\Re': u'ℜ', u'\\Rparen': u'⦆',
-      u'\\Rrightarrow': u'⇛', u'\\Rsh': u'↱', u'\\S': u'§', u'\\Sigma': u'Σ',
-      u'\\Square': u'☐', u'\\Subset': u'⋐', u'\\Sun': u'☉', u'\\Supset': u'⋑',
-      u'\\Theta': u'Θ', u'\\Uparrow': u'⇑', u'\\Updownarrow': u'⇕',
-      u'\\Upsilon': u'Υ', u'\\Vdash': u'⊩', u'\\Vert': u'∥', u'\\Vvdash': u'⊪',
-      u'\\XBox': u'☒', u'\\Xi': u'Ξ', u'\\Yup': u'⅄', u'\\\\': u'<br/>',
-      u'\\_': u'_', u'\\aleph': u'ℵ', u'\\amalg': u'∐', u'\\anchor': u'⚓',
-      u'\\angle': u'∠', u'\\aquarius': u'♒', u'\\arccos': u'arccos',
-      u'\\arcsin': u'arcsin', u'\\arctan': u'arctan', u'\\arg': u'arg',
-      u'\\aries': u'♈', u'\\arrowbullet': u'➢', u'\\ast': u'∗', u'\\asymp': u'≍',
-      u'\\backepsilon': u'∍', u'\\backprime': u'‵', u'\\backsimeq': u'⋍',
-      u'\\backslash': u'\\', u'\\ballotx': u'✗', u'\\barwedge': u'⊼',
-      u'\\because': u'∵', u'\\beth': u'ℶ', u'\\between': u'≬', u'\\bigcap': u'∩',
-      u'\\bigcirc': u'○', u'\\bigcup': u'∪', u'\\bigodot': u'⊙',
-      u'\\bigoplus': u'⊕', u'\\bigotimes': u'⊗', u'\\bigsqcup': u'⊔',
-      u'\\bigstar': u'★', u'\\bigtriangledown': u'▽', u'\\bigtriangleup': u'△',
-      u'\\biguplus': u'⊎', u'\\bigvee': u'∨', u'\\bigwedge': u'∧',
-      u'\\biohazard': u'☣', u'\\blacklozenge': u'⧫', u'\\blacksmiley': u'☻',
-      u'\\blacksquare': u'■', u'\\blacktriangle': u'▲',
-      u'\\blacktriangledown': u'▼', u'\\blacktriangleleft': u'◂',
-      u'\\blacktriangleright': u'▶', u'\\blacktriangleup': u'▴', u'\\bot': u'⊥',
-      u'\\bowtie': u'⋈', u'\\box': u'▫', u'\\boxast': u'⧆', u'\\boxbar': u'◫',
-      u'\\boxbox': u'⧈', u'\\boxbslash': u'⧅', u'\\boxcircle': u'⧇',
-      u'\\boxdot': u'⊡', u'\\boxminus': u'⊟', u'\\boxplus': u'⊞',
-      u'\\boxslash': u'⧄', u'\\boxtimes': u'⊠', u'\\bullet': u'•',
-      u'\\bumpeq': u'≏', u'\\cancer': u'♋', u'\\cap': u'∩', u'\\capricornus': u'♑',
-      u'\\cat': u'⁀', u'\\cdot': u'⋅', u'\\cdots': u'⋯', u'\\cent': u'¢',
-      u'\\centerdot': u'∙', u'\\checkmark': u'✓', u'\\chi': u'χ', u'\\circ': u'∘',
-      u'\\circeq': u'≗', u'\\circlearrowleft': u'↺', u'\\circlearrowright': u'↻',
-      u'\\circledR': u'®', u'\\circledast': u'⊛', u'\\circledbslash': u'⦸',
-      u'\\circledcirc': u'⊚', u'\\circleddash': u'⊝', u'\\circledgtr': u'⧁',
-      u'\\circledless': u'⧀', u'\\clubsuit': u'♣', u'\\colon': u': ', u'\\coloneqq': u'≔',
-      u'\\complement': u'∁', u'\\cong': u'≅', u'\\coprod': u'∐',
-      u'\\copyright': u'©', u'\\cos': u'cos', u'\\cosh': u'cosh', u'\\cot': u'cot',
-      u'\\coth': u'coth', u'\\csc': u'csc', u'\\cup': u'∪', u'\\curlyvee': u'⋎',
-      u'\\curlywedge': u'⋏', u'\\curvearrowleft': u'↶',
-      u'\\curvearrowright': u'↷', u'\\dag': u'†', u'\\dagger': u'†',
-      u'\\daleth': u'ℸ', u'\\dashleftarrow': u'⇠', u'\\dashv': u'⊣',
-      u'\\ddag': u'‡', u'\\ddagger': u'‡', u'\\ddots': u'⋱', u'\\deg': u'deg',
-      u'\\det': u'det', u'\\diagdown': u'╲', u'\\diagup': u'╱',
-      u'\\diameter': u'⌀', u'\\diamond': u'◇', u'\\diamondsuit': u'♦',
-      u'\\dim': u'dim', u'\\div': u'÷', u'\\divideontimes': u'⋇',
-      u'\\dotdiv': u'∸', u'\\doteq': u'≐', u'\\doteqdot': u'≑', u'\\dotplus': u'∔',
-      u'\\dots': u'…', u'\\doublebarwedge': u'⌆', u'\\downarrow': u'↓',
-      u'\\downdownarrows': u'⇊', u'\\downharpoonleft': u'⇃',
-      u'\\downharpoonright': u'⇂', u'\\dsub': u'⩤', u'\\earth': u'♁',
-      u'\\eighthnote': u'♪', u'\\ell': u'ℓ', u'\\emptyset': u'∅',
-      u'\\eqcirc': u'≖', u'\\eqcolon': u'≕', u'\\eqsim': u'≂', u'\\euro': u'€',
-      u'\\exists': u'∃', u'\\exp': u'exp', u'\\fallingdotseq': u'≒',
-      u'\\fcmp': u'⨾', u'\\female': u'♀', u'\\flat': u'♭', u'\\forall': u'∀',
-      u'\\fourth': u'⁗', u'\\frown': u'⌢', u'\\frownie': u'☹', u'\\gcd': u'gcd',
-      u'\\gemini': u'♊', u'\\geq)': u'≥', u'\\geqq': u'≧', u'\\geqslant': u'≥',
-      u'\\gets': u'←', u'\\gg': u'≫', u'\\ggg': u'⋙', u'\\gimel': u'ℷ',
-      u'\\gneqq': u'≩', u'\\gnsim': u'⋧', u'\\gtrdot': u'⋗', u'\\gtreqless': u'⋚',
-      u'\\gtreqqless': u'⪌', u'\\gtrless': u'≷', u'\\gtrsim': u'≳',
-      u'\\guillemotleft': u'«', u'\\guillemotright': u'»', u'\\hbar': u'ℏ',
-      u'\\heartsuit': u'♥', u'\\hfill': u'<span class="hfill"> </span>',
-      u'\\hom': u'hom', u'\\hookleftarrow': u'↩', u'\\hookrightarrow': u'↪',
-      u'\\hslash': u'ℏ', u'\\idotsint': u'<span class="bigsymbol">∫⋯∫</span>',
-      u'\\iiint': u'<span class="bigsymbol">∭</span>',
-      u'\\iint': u'<span class="bigsymbol">∬</span>', u'\\imath': u'ı',
-      u'\\inf': u'inf', u'\\infty': u'∞', u'\\intercal': u'⊺',
-      u'\\interleave': u'⫴', u'\\invamp': u'⅋', u'\\invneg': u'⌐',
-      u'\\jmath': u'ȷ', u'\\jupiter': u'♃', u'\\ker': u'ker', u'\\land': u'∧',
-      u'\\landupint': u'<span class="bigsymbol">∱</span>', u'\\lang': u'⟪',
-      u'\\langle': u'⟨', u'\\lblot': u'⦉', u'\\lbrace': u'{', u'\\lbrace)': u'{',
-      u'\\lbrack': u'', u'\\lceil': u'⌈', u'\\ldots': u'…', u'\\leadsto': u'⇝',
-      u'\\leftarrow)': u'←', u'\\leftarrowtail': u'↢', u'\\leftarrowtobar': u'⇤',
-      u'\\leftharpoondown': u'↽', u'\\leftharpoonup': u'↼',
-      u'\\leftleftarrows': u'⇇', u'\\leftleftharpoons': u'⥢', u'\\leftmoon': u'☾',
-      u'\\leftrightarrow': u'↔', u'\\leftrightarrows': u'⇆',
-      u'\\leftrightharpoons': u'⇋', u'\\leftthreetimes': u'⋋', u'\\leo': u'♌',
-      u'\\leq)': u'≤', u'\\leqq': u'≦', u'\\leqslant': u'≤', u'\\lessdot': u'⋖',
-      u'\\lesseqgtr': u'⋛', u'\\lesseqqgtr': u'⪋', u'\\lessgtr': u'≶',
-      u'\\lesssim': u'≲', u'\\lfloor': u'⌊', u'\\lg': u'lg', u'\\lgroup': u'⟮',
-      u'\\lhd': u'⊲', u'\\libra': u'♎', u'\\lightning': u'↯', u'\\limg': u'⦇',
-      u'\\liminf': u'liminf', u'\\limsup': u'limsup', u'\\ll': u'≪',
-      u'\\llbracket': u'⟦', u'\\llcorner': u'⌞', u'\\lll': u'⋘', u'\\ln': u'ln',
-      u'\\lneqq': u'≨', u'\\lnot': u'¬', u'\\lnsim': u'⋦', u'\\log': u'log',
-      u'\\longleftarrow': u'⟵', u'\\longleftrightarrow': u'⟷',
-      u'\\longmapsto': u'⟼', u'\\longrightarrow': u'⟶', u'\\looparrowleft': u'↫',
-      u'\\looparrowright': u'↬', u'\\lor': u'∨', u'\\lozenge': u'◊',
-      u'\\lrcorner': u'⌟', u'\\ltimes': u'⋉', u'\\lyxlock': u'', u'\\male': u'♂',
-      u'\\maltese': u'✠', u'\\mapsfrom': u'↤', u'\\mapsto': u'↦',
-      u'\\mathcircumflex': u'^', u'\\max': u'max', u'\\measuredangle': u'∡',
-      u'\\medbullet': u'⚫', u'\\medcirc': u'⚪', u'\\mercury': u'☿', u'\\mho': u'℧',
-      u'\\mid': u'∣', u'\\min': u'min', u'\\models': u'⊨', u'\\mp': u'∓',
-      u'\\multimap': u'⊸', u'\\nLeftarrow': u'⇍', u'\\nLeftrightarrow': u'⇎',
-      u'\\nRightarrow': u'⇏', u'\\nVDash': u'⊯', u'\\nabla': u'∇',
-      u'\\napprox': u'≉', u'\\natural': u'♮', u'\\ncong': u'≇', u'\\nearrow': u'↗',
-      u'\\neg': u'¬', u'\\neg)': u'¬', u'\\neptune': u'♆', u'\\nequiv': u'≢',
-      u'\\newline': u'<br/>', u'\\nexists': u'∄', u'\\ngeqslant': u'≱',
-      u'\\ngtr': u'≯', u'\\ngtrless': u'≹', u'\\ni': u'∋', u'\\ni)': u'∋',
-      u'\\nleftarrow': u'↚', u'\\nleftrightarrow': u'↮', u'\\nleqslant': u'≰',
-      u'\\nless': u'≮', u'\\nlessgtr': u'≸', u'\\nmid': u'∤', u'\\nolimits': u'',
-      u'\\nonumber': u'', u'\\not': u'¬', u'\\not<': u'≮', u'\\not=': u'≠',
-      u'\\not>': u'≯', u'\\notbackslash': u'⍀', u'\\notin': u'∉', u'\\notni': u'∌',
-      u'\\notslash': u'⌿', u'\\nparallel': u'∦', u'\\nprec': u'⊀',
-      u'\\nrightarrow': u'↛', u'\\nsim': u'≁', u'\\nsimeq': u'≄',
-      u'\\nsqsubset': u'⊏̸', u'\\nsubseteq': u'⊈', u'\\nsucc': u'⊁',
-      u'\\nsucccurlyeq': u'⋡', u'\\nsupset': u'⊅', u'\\nsupseteq': u'⊉',
-      u'\\ntriangleleft': u'⋪', u'\\ntrianglelefteq': u'⋬',
-      u'\\ntriangleright': u'⋫', u'\\ntrianglerighteq': u'⋭', u'\\nvDash': u'⊭',
-      u'\\nvdash': u'⊬', u'\\nwarrow': u'↖', u'\\odot': u'⊙',
-      u'\\officialeuro': u'€', u'\\oiiint': u'<span class="bigsymbol">∰</span>',
-      u'\\oiint': u'<span class="bigsymbol">∯</span>',
-      u'\\oint': u'<span class="bigsymbol">∮</span>',
-      u'\\ointclockwise': u'<span class="bigsymbol">∲</span>',
-      u'\\ointctrclockwise': u'<span class="bigsymbol">∳</span>',
-      u'\\ominus': u'⊖', u'\\oplus': u'⊕', u'\\oslash': u'⊘', u'\\otimes': u'⊗',
-      u'\\owns': u'∋', u'\\parallel': u'∥', u'\\partial': u'∂', u'\\pencil': u'✎',
-      u'\\perp': u'⊥', u'\\pisces': u'♓', u'\\pitchfork': u'⋔', u'\\pluto': u'♇',
-      u'\\pm': u'±', u'\\pointer': u'➪', u'\\pointright': u'☞', u'\\pounds': u'£',
-      u'\\prec': u'≺', u'\\preccurlyeq': u'≼', u'\\preceq': u'≼',
-      u'\\precsim': u'≾', u'\\prime': u'′', u'\\prompto': u'∝', u'\\qoppa': u'ϙ',
-      u'\\qquad': u'  ', u'\\quad': u' ', u'\\quarternote': u'♩',
-      u'\\radiation': u'☢', u'\\rang': u'⟫', u'\\rangle': u'⟩', u'\\rblot': u'⦊',
-      u'\\rbrace': u'}', u'\\rbrace)': u'}', u'\\rbrack': u'', u'\\rceil': u'⌉',
-      u'\\recycle': u'♻', u'\\rfloor': u'⌋', u'\\rgroup': u'⟯', u'\\rhd': u'⊳',
-      u'\\rightangle': u'∟', u'\\rightarrow)': u'→', u'\\rightarrowtail': u'↣',
-      u'\\rightarrowtobar': u'⇥', u'\\rightharpoondown': u'⇁',
-      u'\\rightharpoonup': u'⇀', u'\\rightharpooondown': u'⇁',
-      u'\\rightharpooonup': u'⇀', u'\\rightleftarrows': u'⇄',
-      u'\\rightleftharpoons': u'⇌', u'\\rightmoon': u'☽',
-      u'\\rightrightarrows': u'⇉', u'\\rightrightharpoons': u'⥤',
-      u'\\rightthreetimes': u'⋌', u'\\rimg': u'⦈', u'\\risingdotseq': u'≓',
-      u'\\rrbracket': u'⟧', u'\\rsub': u'⩥', u'\\rtimes': u'⋊',
-      u'\\sagittarius': u'♐', u'\\saturn': u'♄', u'\\scorpio': u'♏',
-      u'\\searrow': u'↘', u'\\sec': u'sec', u'\\second': u'″', u'\\setminus': u'∖',
-      u'\\sharp': u'♯', u'\\simeq': u'≃', u'\\sin': u'sin', u'\\sinh': u'sinh',
-      u'\\sixteenthnote': u'♬', u'\\skull': u'☠', u'\\slash': u'∕',
-      u'\\smallsetminus': u'∖', u'\\smalltriangledown': u'▿',
-      u'\\smalltriangleleft': u'◃', u'\\smalltriangleright': u'▹',
-      u'\\smalltriangleup': u'▵', u'\\smile': u'⌣', u'\\smiley': u'☺',
-      u'\\spadesuit': u'♠', u'\\spddot': u'¨', u'\\sphat': u'',
-      u'\\sphericalangle': u'∢', u'\\spot': u'⦁', u'\\sptilde': u'~',
-      u'\\sqcap': u'⊓', u'\\sqcup': u'⊔', u'\\sqsubset': u'⊏',
-      u'\\sqsubseteq': u'⊑', u'\\sqsupset': u'⊐', u'\\sqsupseteq': u'⊒',
-      u'\\square': u'□', u'\\sslash': u'⫽', u'\\star': u'⋆', u'\\steaming': u'☕',
-      u'\\subseteqq': u'⫅', u'\\subsetneqq': u'⫋', u'\\succ': u'≻',
-      u'\\succcurlyeq': u'≽', u'\\succeq': u'≽', u'\\succnsim': u'⋩',
-      u'\\succsim': u'≿', u'\\sun': u'☼', u'\\sup': u'sup', u'\\supseteqq': u'⫆',
-      u'\\supsetneqq': u'⫌', u'\\surd': u'√', u'\\swarrow': u'↙',
-      u'\\swords': u'⚔', u'\\talloblong': u'⫾', u'\\tan': u'tan',
-      u'\\tanh': u'tanh', u'\\taurus': u'♉', u'\\textasciicircum': u'^',
-      u'\\textasciitilde': u'~', u'\\textbackslash': u'\\',
-      u'\\textcopyright': u'©\'', u'\\textdegree': u'°', u'\\textellipsis': u'…',
-      u'\\textemdash': u'—', u'\\textendash': u'—', u'\\texteuro': u'€',
-      u'\\textgreater': u'>', u'\\textless': u'<', u'\\textordfeminine': u'ª',
-      u'\\textordmasculine': u'º', u'\\textquotedblleft': u'“',
-      u'\\textquotedblright': u'”', u'\\textquoteright': u'’',
-      u'\\textregistered': u'®', u'\\textrightarrow': u'→',
-      u'\\textsection': u'§', u'\\texttrademark': u'™',
-      u'\\texttwosuperior': u'²', u'\\textvisiblespace': u' ',
-      u'\\therefore': u'∴', u'\\third': u'‴', u'\\top': u'⊤', u'\\triangle': u'△',
-      u'\\triangleleft': u'⊲', u'\\trianglelefteq': u'⊴', u'\\triangleq': u'≜',
-      u'\\triangleright': u'▷', u'\\trianglerighteq': u'⊵',
-      u'\\twoheadleftarrow': u'↞', u'\\twoheadrightarrow': u'↠',
-      u'\\twonotes': u'♫', u'\\udot': u'⊍', u'\\ulcorner': u'⌜', u'\\unlhd': u'⊴',
-      u'\\unrhd': u'⊵', u'\\unrhl': u'⊵', u'\\uparrow': u'↑',
-      u'\\updownarrow': u'↕', u'\\upharpoonleft': u'↿', u'\\upharpoonright': u'↾',
-      u'\\uplus': u'⊎', u'\\upuparrows': u'⇈', u'\\uranus': u'♅',
-      u'\\urcorner': u'⌝', u'\\vDash': u'⊨', u'\\varclubsuit': u'♧',
-      u'\\vardiamondsuit': u'♦', u'\\varheartsuit': u'♥', u'\\varnothing': u'∅',
-      u'\\varspadesuit': u'♤', u'\\vdash': u'⊢', u'\\vdots': u'⋮', u'\\vee': u'∨',
-      u'\\vee)': u'∨', u'\\veebar': u'⊻', u'\\vert': u'∣', u'\\virgo': u'♍',
-      u'\\warning': u'⚠', u'\\wasylozenge': u'⌑', u'\\wedge': u'∧',
-      u'\\wedge)': u'∧', u'\\wp': u'℘', u'\\wr': u'≀', u'\\yen': u'¥',
-      u'\\yinyang': u'☯', u'\\{': u'{', u'\\|': u'∥', u'\\}': u'}',
-      }
-
-  decoratedcommand = {
-      }
-
-  decoratingfunctions = {
-      u'\\overleftarrow': u'⟵', u'\\overrightarrow': u'⟶', u'\\widehat': u'^',
-      }
-
-  endings = {
-      u'bracket': u'}', u'complex': u'\\', u'endafter': u'}',
-      u'endbefore': u'\\end{', u'squarebracket': u'',
-      }
-
-  environments = {
-      u'align': u'r', u'l',, u'eqnarray': u'r', u'c', u'l',,
-      u'gathered': u'l', u'l',,
-      }
-
-  fontfunctions = {
-      u'\\boldsymbol': u'b', u'\\mathbb': u'span class="blackboard"',
-      u'\\mathbb{A}': u'𝔸', u'\\mathbb{B}': u'𝔹', u'\\mathbb{C}': u'ℂ',
-      u'\\mathbb{D}': u'𝔻', u'\\mathbb{E}': u'𝔼', u'\\mathbb{F}': u'𝔽',
-      u'\\mathbb{G}': u'𝔾', u'\\mathbb{H}': u'ℍ', u'\\mathbb{J}': u'𝕁',
-      u'\\mathbb{K}': u'𝕂', u'\\mathbb{L}': u'𝕃', u'\\mathbb{N}': u'ℕ',
-      u'\\mathbb{O}': u'𝕆', u'\\mathbb{P}': u'ℙ', u'\\mathbb{Q}': u'ℚ',
-      u'\\mathbb{R}': u'ℝ', u'\\mathbb{S}': u'𝕊', u'\\mathbb{T}': u'𝕋',
-      u'\\mathbb{W}': u'𝕎', u'\\mathbb{Z}': u'ℤ', u'\\mathbf': u'b',
-      u'\\mathcal': u'span class="scriptfont"', u'\\mathcal{B}': u'ℬ',
-      u'\\mathcal{E}': u'ℰ', u'\\mathcal{F}': u'ℱ', u'\\mathcal{H}': u'ℋ',
-      u'\\mathcal{I}': u'ℐ', u'\\mathcal{L}': u'ℒ', u'\\mathcal{M}': u'ℳ',
-      u'\\mathcal{R}': u'ℛ', u'\\mathfrak': u'span class="fraktur"',
-      u'\\mathfrak{C}': u'ℭ', u'\\mathfrak{F}': u'𝔉', u'\\mathfrak{H}': u'ℌ',
-      u'\\mathfrak{I}': u'ℑ', u'\\mathfrak{R}': u'ℜ', u'\\mathfrak{Z}': u'ℨ',
-      u'\\mathit': u'i', u'\\mathring{A}': u'Å', u'\\mathring{U}': u'Ů',
-      u'\\mathring{a}': u'å', u'\\mathring{u}': u'ů', u'\\mathring{w}': u'ẘ',
-      u'\\mathring{y}': u'ẙ', u'\\mathrm': u'span class="mathrm"',
-      u'\\mathscr': u'span class="scriptfont"', u'\\mathscr{B}': u'ℬ',
-      u'\\mathscr{E}': u'ℰ', u'\\mathscr{F}': u'ℱ', u'\\mathscr{H}': u'ℋ',
-      u'\\mathscr{I}': u'ℐ', u'\\mathscr{L}': u'ℒ', u'\\mathscr{M}': u'ℳ',
-      u'\\mathscr{R}': u'ℛ', u'\\mathsf': u'span class="mathsf"',
-      u'\\mathtt': u'tt',
-      }
-
-  hybridfunctions = {
-      u'\\addcontentsline': u'{$p!}{$q!}{$r!}', u'f0{}', u'ignored',,
-      u'\\addtocontents': u'{$p!}{$q!}', u'f0{}', u'ignored',,
-      u'\\backmatter': u'', u'f0{}', u'ignored',,
-      u'\\binom': u'{$1}{$2}', u'f2{(}f0{f1{$1}f1{$2}}f2{)}', u'span class="binom"', u'span class="binomstack"', u'span class="bigsymbol"',,
-      u'\\boxed': u'{$1}', u'f0{$1}', u'span class="boxed"',,
-      u'\\cfrac': u'$p!{$1}{$2}', u'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', u'span class="fullfraction"', u'span class="numerator align-$p"', u'span class="denominator"', u'span class="ignored"',,
-      u'\\color': u'{$p!}{$1}', u'f0{$1}', u'span style="color: $p;"',,
-      u'\\colorbox': u'{$p!}{$1}', u'f0{$1}', u'span class="colorbox" style="background: $p;"',,
-      u'\\dbinom': u'{$1}{$2}', u'(f0{f1{f2{$1}}f1{f2{ }}f1{f2{$2}}})', u'span class="binomial"', u'span class="binomrow"', u'span class="binomcell"',,
-      u'\\dfrac': u'{$1}{$2}', u'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', u'span class="fullfraction"', u'span class="numerator"', u'span class="denominator"', u'span class="ignored"',,
-      u'\\displaystyle': u'{$1}', u'f0{$1}', u'span class="displaystyle"',,
-      u'\\fancyfoot': u'$p!{$q!}', u'f0{}', u'ignored',,
-      u'\\fancyhead': u'$p!{$q!}', u'f0{}', u'ignored',,
-      u'\\fbox': u'{$1}', u'f0{$1}', u'span class="fbox"',,
-      u'\\fboxrule': u'{$p!}', u'f0{}', u'ignored',,
-      u'\\fboxsep': u'{$p!}', u'f0{}', u'ignored',,
-      u'\\fcolorbox': u'{$p!}{$q!}{$1}', u'f0{$1}', u'span class="boxed" style="border-color: $p; background: $q;"',,
-      u'\\frac': u'{$1}{$2}', u'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', u'span class="fraction"', u'span class="numerator"', u'span class="denominator"', u'span class="ignored"',,
-      u'\\framebox': u'$p!$q!{$1}', u'f0{$1}', u'span class="framebox align-$q" style="width: $p;"',,
-      u'\\frontmatter': u'', u'f0{}', u'ignored',,
-      u'\\href': u'$o{$u!}{$t!}', u'f0{$t}', u'a href="$u"',,
-      u'\\hspace': u'{$p!}', u'f0{ }', u'span class="hspace" style="width: $p;"',,
-      u'\\leftroot': u'{$p!}', u'f0{ }', u'span class="leftroot" style="width: $p;px"',,
-      u'\\mainmatter': u'', u'f0{}', u'ignored',,
-      u'\\markboth': u'{$p!}{$q!}', u'f0{}', u'ignored',,
-      u'\\markright': u'{$p!}', u'f0{}', u'ignored',,
-      u'\\nicefrac': u'{$1}{$2}', u'f0{f1{$1}⁄f2{$2}}', u'span class="fraction"', u'sup class="numerator"', u'sub class="denominator"', u'span class="ignored"',,
-      u'\\parbox': u'$p!{$w!}{$1}', u'f0{1}', u'div class="Boxed" style="width: $w;"',,
-      u'\\raisebox': u'{$p!}{$1}', u'f0{$1.font}', u'span class="raisebox" style="vertical-align: $p;"',,
-      u'\\renewenvironment': u'{$1!}{$2!}{$3!}', u'',,
-      u'\\rule': u'$v!{$w!}{$h!}', u'f0/', u'hr class="line" style="width: $w; height: $h;"',,
-      u'\\scriptscriptstyle': u'{$1}', u'f0{$1}', u'span class="scriptscriptstyle"',,
-      u'\\scriptstyle': u'{$1}', u'f0{$1}', u'span class="scriptstyle"',,
-      u'\\sqrt': u'$0{$1}', u'f0{f1{$0}f2{√}f4{(}f3{$1}f4{)}}', u'span class="sqrt"', u'sup class="root"', u'span class="radical"', u'span class="root"', u'span class="ignored"',,
-      u'\\stackrel': u'{$1}{$2}', u'f0{f1{$1}f2{$2}}', u'span class="stackrel"', u'span class="upstackrel"', u'span class="downstackrel"',,
-      u'\\tbinom': u'{$1}{$2}', u'(f0{f1{f2{$1}}f1{f2{ }}f1{f2{$2}}})', u'span class="binomial"', u'span class="binomrow"', u'span class="binomcell"',,
-      u'\\textcolor': u'{$p!}{$1}', u'f0{$1}', u'span style="color: $p;"',,
-      u'\\textstyle': u'{$1}', u'f0{$1}', u'span class="textstyle"',,
-      u'\\thispagestyle': u'{$p!}', u'f0{}', u'ignored',,
-      u'\\unit': u'$0{$1}', u'$0f0{$1.font}', u'span class="unit"',,
-      u'\\unitfrac': u'$0{$1}{$2}', u'$0f0{f1{$1.font}⁄f2{$2.font}}', u'span class="fraction"', u'sup class="unit"', u'sub class="unit"',,
-      u'\\uproot': u'{$p!}', u'f0{ }', u'span class="uproot" style="width: $p;px"',,
-      u'\\url': u'{$u!}', u'f0{$u}', u'a href="$u"',,
-      u'\\vspace': u'{$p!}', u'f0{ }', u'span class="vspace" style="height: $p;"',,
-      }
-
-  hybridsizes = {
-      u'\\binom': u'$1+$2', u'\\cfrac': u'$1+$2', u'\\dbinom': u'$1+$2+1',
-      u'\\dfrac': u'$1+$2', u'\\frac': u'$1+$2', u'\\tbinom': u'$1+$2+1',
-      }
-
-  labelfunctions = {
-      u'\\label': u'a name="#"',
-      }
-
-  limitcommands = {
-      u'\\biginterleave': u'⫼', u'\\bigsqcap': u'⨅', u'\\fint': u'⨏',
-      u'\\iiiint': u'⨌', u'\\int': u'∫', u'\\intop': u'∫', u'\\lim': u'lim',
-      u'\\prod': u'∏', u'\\smallint': u'∫', u'\\sqint': u'⨖', u'\\sum': u'∑',
-      u'\\varointclockwise': u'∲', u'\\varprod': u'⨉', u'\\zcmp': u'⨟',
-      u'\\zhide': u'⧹', u'\\zpipe': u'⨠', u'\\zproject': u'⨡',
-      }
-
-  misccommands = {
-      u'\\limits': u'LimitPreviousCommand', u'\\newcommand': u'MacroDefinition',
-      u'\\renewcommand': u'MacroDefinition',
-      u'\\setcounter': u'SetCounterFunction', u'\\tag': u'FormulaTag',
-      u'\\tag*': u'FormulaTag', u'\\today': u'TodayCommand',
-      }
-
-  modified = {
-      u'\n': u'', u' ': u'', u'$': u'', u'&': u'	', u'\'': u'’', u'+': u' + ',
-      u',': u', ', u'-': u' − ', u'/': u' ⁄ ', u':': u' : ', u'<': u' &lt; ',
-      u'=': u' = ', u'>': u' &gt; ', u'@': u'', u'~': u'',
-      }
-
-  onefunctions = {
-      u'\\Big': u'span class="bigsymbol"', u'\\Bigg': u'span class="hugesymbol"',
-      u'\\bar': u'span class="bar"', u'\\begin{array}': u'span class="arraydef"',
-      u'\\big': u'span class="symbol"', u'\\bigg': u'span class="largesymbol"',
-      u'\\bigl': u'span class="bigsymbol"', u'\\bigr': u'span class="bigsymbol"',
-      u'\\centering': u'span class="align-center"',
-      u'\\ensuremath': u'span class="ensuremath"',
-      u'\\hphantom': u'span class="phantom"',
-      u'\\noindent': u'span class="noindent"',
-      u'\\overbrace': u'span class="overbrace"',
-      u'\\overline': u'span class="overline"',
-      u'\\phantom': u'span class="phantom"',
-      u'\\underbrace': u'span class="underbrace"', u'\\underline': u'u',
-      u'\\vphantom': u'span class="phantom"',
-      }
-
-  spacedcommands = {
-      u'\\Bot': u'⫫', u'\\Doteq': u'≑', u'\\DownArrowBar': u'⤓',
-      u'\\DownLeftTeeVector': u'⥞', u'\\DownLeftVectorBar': u'⥖',
-      u'\\DownRightTeeVector': u'⥟', u'\\DownRightVectorBar': u'⥗',
-      u'\\Equal': u'⩵', u'\\LeftArrowBar': u'⇤', u'\\LeftDownTeeVector': u'⥡',
-      u'\\LeftDownVectorBar': u'⥙', u'\\LeftTeeVector': u'⥚',
-      u'\\LeftTriangleBar': u'⧏', u'\\LeftUpTeeVector': u'⥠',
-      u'\\LeftUpVectorBar': u'⥘', u'\\LeftVectorBar': u'⥒',
-      u'\\Leftrightarrow': u'⇔', u'\\Longmapsfrom': u'⟽', u'\\Longmapsto': u'⟾',
-      u'\\MapsDown': u'↧', u'\\MapsUp': u'↥', u'\\Nearrow': u'⇗',
-      u'\\NestedGreaterGreater': u'⪢', u'\\NestedLessLess': u'⪡',
-      u'\\NotGreaterLess': u'≹', u'\\NotGreaterTilde': u'≵',
-      u'\\NotLessTilde': u'≴', u'\\Nwarrow': u'⇖', u'\\Proportion': u'∷',
-      u'\\RightArrowBar': u'⇥', u'\\RightDownTeeVector': u'⥝',
-      u'\\RightDownVectorBar': u'⥕', u'\\RightTeeVector': u'⥛',
-      u'\\RightTriangleBar': u'⧐', u'\\RightUpTeeVector': u'⥜',
-      u'\\RightUpVectorBar': u'⥔', u'\\RightVectorBar': u'⥓',
-      u'\\Rightarrow': u'⇒', u'\\Same': u'⩶', u'\\Searrow': u'⇘',
-      u'\\Swarrow': u'⇙', u'\\Top': u'⫪', u'\\UpArrowBar': u'⤒', u'\\VDash': u'⊫',
-      u'\\approx': u'≈', u'\\approxeq': u'≊', u'\\backsim': u'∽', u'\\barin': u'⋶',
-      u'\\barleftharpoon': u'⥫', u'\\barrightharpoon': u'⥭', u'\\bij': u'⤖',
-      u'\\coloneq': u'≔', u'\\corresponds': u'≙', u'\\curlyeqprec': u'⋞',
-      u'\\curlyeqsucc': u'⋟', u'\\dashrightarrow': u'⇢', u'\\dlsh': u'↲',
-      u'\\downdownharpoons': u'⥥', u'\\downuparrows': u'⇵',
-      u'\\downupharpoons': u'⥯', u'\\drsh': u'↳', u'\\eqslantgtr': u'⪖',
-      u'\\eqslantless': u'⪕', u'\\equiv': u'≡', u'\\ffun': u'⇻', u'\\finj': u'⤕',
-      u'\\ge': u'≥', u'\\geq': u'≥', u'\\ggcurly': u'⪼', u'\\gnapprox': u'⪊',
-      u'\\gneq': u'⪈', u'\\gtrapprox': u'⪆', u'\\hash': u'⋕', u'\\iddots': u'⋰',
-      u'\\implies': u' ⇒ ', u'\\in': u'∈', u'\\le': u'≤', u'\\leftarrow': u'←',
-      u'\\leftarrowtriangle': u'⇽', u'\\leftbarharpoon': u'⥪',
-      u'\\leftrightarrowtriangle': u'⇿', u'\\leftrightharpoon': u'⥊',
-      u'\\leftrightharpoondown': u'⥐', u'\\leftrightharpoonup': u'⥎',
-      u'\\leftrightsquigarrow': u'↭', u'\\leftslice': u'⪦',
-      u'\\leftsquigarrow': u'⇜', u'\\leftupdownharpoon': u'⥑', u'\\leq': u'≤',
-      u'\\lessapprox': u'⪅', u'\\llcurly': u'⪻', u'\\lnapprox': u'⪉',
-      u'\\lneq': u'⪇', u'\\longmapsfrom': u'⟻', u'\\multimapboth': u'⧟',
-      u'\\multimapdotbothA': u'⊶', u'\\multimapdotbothB': u'⊷',
-      u'\\multimapinv': u'⟜', u'\\nVdash': u'⊮', u'\\ne': u'≠', u'\\neq': u'≠',
-      u'\\ngeq': u'≱', u'\\nleq': u'≰', u'\\nni': u'∌', u'\\not\\in': u'∉',
-      u'\\notasymp': u'≭', u'\\npreceq': u'⋠', u'\\nsqsubseteq': u'⋢',
-      u'\\nsqsupseteq': u'⋣', u'\\nsubset': u'⊄', u'\\nsucceq': u'⋡',
-      u'\\pfun': u'⇸', u'\\pinj': u'⤔', u'\\precapprox': u'⪷', u'\\preceqq': u'⪳',
-      u'\\precnapprox': u'⪹', u'\\precnsim': u'⋨', u'\\propto': u'∝',
-      u'\\psur': u'⤀', u'\\rightarrow': u'→', u'\\rightarrowtriangle': u'⇾',
-      u'\\rightbarharpoon': u'⥬', u'\\rightleftharpoon': u'⥋',
-      u'\\rightslice': u'⪧', u'\\rightsquigarrow': u'⇝',
-      u'\\rightupdownharpoon': u'⥏', u'\\sim': u'~', u'\\strictfi': u'⥼',
-      u'\\strictif': u'⥽', u'\\subset': u'⊂', u'\\subseteq': u'⊆',
-      u'\\subsetneq': u'⊊', u'\\succapprox': u'⪸', u'\\succeqq': u'⪴',
-      u'\\succnapprox': u'⪺', u'\\supset': u'⊃', u'\\supseteq': u'⊇',
-      u'\\supsetneq': u'⊋', u'\\times': u'×', u'\\to': u'→',
-      u'\\updownarrows': u'⇅', u'\\updownharpoons': u'⥮', u'\\upupharpoons': u'⥣',
-      u'\\vartriangleleft': u'⊲', u'\\vartriangleright': u'⊳',
-      }
-
-  starts = {
-      u'beginafter': u'}', u'beginbefore': u'\\begin{', u'bracket': u'{',
-      u'command': u'\\', u'comment': u'%', u'complex': u'\\', u'simple': u'$',
-      u'squarebracket': u'', u'unnumbered': u'*',
-      }
-
-  symbolfunctions = {
-      u'^': u'sup', u'_': u'sub',
-      }
-
-  textfunctions = {
-      u'\\mbox': u'span class="mbox"', u'\\text': u'span class="text"',
-      u'\\textbf': u'b', u'\\textipa': u'span class="textipa"', u'\\textit': u'i',
-      u'\\textnormal': u'span class="textnormal"',
-      u'\\textrm': u'span class="textrm"',
-      u'\\textsc': u'span class="versalitas"',
-      u'\\textsf': u'span class="textsf"', u'\\textsl': u'i', u'\\texttt': u'tt',
-      u'\\textup': u'span class="normal"',
-      }
-
-  unmodified = {
-      u'characters': u'.', u'*', u'€', u'(', u')', u'', u'', u'·', u'!', u';', u'|', u'§', u'"',,
-      }
-
-  urls = {
-      u'googlecharts': u'http://chart.googleapis.com/chart?cht=tx&chl=',
-      }
-
-class GeneralConfig(object):
-  "Configuration class from elyxer.config file"
-
-  version = {
-      u'date': u'2015-02-26', u'lyxformat': u'413', u'number': u'1.2.5',
-      }
-
-class HeaderConfig(object):
-  "Configuration class from elyxer.config file"
-
-  parameters = {
-      u'beginpreamble': u'\\begin_preamble', u'branch': u'\\branch',
-      u'documentclass': u'\\textclass', u'endbranch': u'\\end_branch',
-      u'endpreamble': u'\\end_preamble', u'language': u'\\language',
-      u'lstset': u'\\lstset', u'outputchanges': u'\\output_changes',
-      u'paragraphseparation': u'\\paragraph_separation',
-      u'pdftitle': u'\\pdf_title', u'secnumdepth': u'\\secnumdepth',
-      u'tocdepth': u'\\tocdepth',
-      }
-
-  styles = {
-      u'article': u'article', u'aastex', u'aapaper', u'acmsiggraph', u'sigplanconf', u'achemso', u'amsart', u'apa', u'arab-article', u'armenian-article', u'article-beamer', u'chess', u'dtk', u'elsarticle', u'heb-article', u'IEEEtran', u'iopart', u'kluwer', u'scrarticle-beamer', u'scrartcl', u'extarticle', u'paper', u'mwart', u'revtex4', u'spie', u'svglobal3', u'ltugboat', u'agu-dtd', u'jgrga', u'agums', u'entcs', u'egs', u'ijmpc', u'ijmpd', u'singlecol-new', u'doublecol-new', u'isprs', u'tarticle', u'jsarticle', u'jarticle', u'jss', u'literate-article', u'siamltex', u'cl2emult', u'llncs', u'svglobal', u'svjog', u'svprobth',,
-      u'book': u'book', u'amsbook', u'scrbook', u'extbook', u'tufte-book', u'report', u'extreport', u'scrreprt', u'memoir', u'tbook', u'jsbook', u'jbook', u'mwbk', u'svmono', u'svmult', u'treport', u'jreport', u'mwrep',,
-      }
-
-class ImageConfig(object):
-  "Configuration class from elyxer.config file"
-
-  converters = {
-      u'imagemagick': u'convert -density $scale -define $format:use-cropbox=true "$input" "$output"',
-      u'inkscape': u'inkscape "$input" --export-png="$output"',
-      u'lyx': u'lyx -C "$input" "$output"',
-      }
-
-  cropboxformats = {
-      u'.eps': u'ps', u'.pdf': u'pdf', u'.ps': u'ps',
-      }
-
-  formats = {
-      u'default': u'.png', u'vector': u'.svg', u'.eps',,
-      }
-
-class LayoutConfig(object):
-  "Configuration class from elyxer.config file"
-
-  groupable = {
-      u'allowed': u'StringContainer', u'Constant', u'TaggedText', u'Align', u'TextFamily', u'EmphaticText', u'VersalitasText', u'BarredText', u'SizeText', u'ColorText', u'LangLine', u'Formula',,
-      }
-
-class NewfangleConfig(object):
-  "Configuration class from elyxer.config file"
-
-  constants = {
-      u'chunkref': u'chunkref{', u'endcommand': u'}', u'endmark': u'&gt;',
-      u'startcommand': u'\\', u'startmark': u'=&lt;',
-      }
-
-class NumberingConfig(object):
-  "Configuration class from elyxer.config file"
-
-  layouts = {
-      u'ordered': u'Chapter', u'Section', u'Subsection', u'Subsubsection', u'Paragraph',,
-      u'roman': u'Part', u'Book',,
-      }
-
-  sequence = {
-      u'symbols': u'*', u'**', u'†', u'‡', u'§', u'§§', u'¶', u'¶¶', u'#', u'##',,
-      }
-
-class StyleConfig(object):
-  "Configuration class from elyxer.config file"
-
-  hspaces = {
-      u'\\enskip{}': u' ', u'\\hfill{}': u'<span class="hfill"> </span>',
-      u'\\hspace*{\\fill}': u' ', u'\\hspace*{}': u'', u'\\hspace{}': u' ',
-      u'\\negthinspace{}': u'', u'\\qquad{}': u'  ', u'\\quad{}': u' ',
-      u'\\space{}': u' ', u'\\thinspace{}': u' ', u'~': u' ',
-      }
-
-  quotes = {
-      u'ald': u'»', u'als': u'›', u'ard': u'«', u'ars': u'‹', u'eld': u'&ldquo;',
-      u'els': u'&lsquo;', u'erd': u'&rdquo;', u'ers': u'&rsquo;', u'fld': u'«',
-      u'fls': u'‹', u'frd': u'»', u'frs': u'›', u'gld': u'„', u'gls': u'‚',
-      u'grd': u'“', u'grs': u'‘', u'pld': u'„', u'pls': u'‚', u'prd': u'”',
-      u'prs': u'’', u'sld': u'”', u'srd': u'”',
-      }
-
-  referenceformats = {
-      u'eqref': u'(@↕)', u'formatted': u'¶↕', u'nameref': u'$↕', u'pageref': u'#↕',
-      u'ref': u'@↕', u'vpageref': u'on-page#↕', u'vref': u'@on-page#↕',
-      }
-
-  size = {
-      u'ignoredtexts': u'col', u'text', u'line', u'page', u'theight', u'pheight',,
-      }
-
-  vspaces = {
-      u'bigskip': u'<div class="bigskip"> </div>',
-      u'defskip': u'<div class="defskip"> </div>',
-      u'medskip': u'<div class="medskip"> </div>',
-      u'smallskip': u'<div class="smallskip"> </div>',
-      u'vfill': u'<div class="vfill"> </div>',
-      }
-
-class TOCConfig(object):
-  "Configuration class from elyxer.config file"
-
-  extractplain = {
-      u'allowed': u'StringContainer', u'Constant', u'TaggedText', u'Align', u'TextFamily', u'EmphaticText', u'VersalitasText', u'BarredText', u'SizeText', u'ColorText', u'LangLine', u'Formula',,
-      u'cloned': u'',, u'extracted': u'',,
-      }
-
-  extracttitle = {
-      u'allowed': u'StringContainer', u'Constant', u'Space',,
-      u'cloned': u'TextFamily', u'EmphaticText', u'VersalitasText', u'BarredText', u'SizeText', u'ColorText', u'LangLine', u'Formula',,
-      u'extracted': u'PlainLayout', u'TaggedText', u'Align', u'Caption', u'StandardLayout', u'FlexInset',,
-      }
-
-class TagConfig(object):
-  "Configuration class from elyxer.config file"
-
-  barred = {
-      u'under': u'u',
-      }
-
-  family = {
-      u'sans': u'span class="sans"', u'typewriter': u'tt',
-      }
-
-  flex = {
-      u'CharStyle:Code': u'span class="code"',
-      u'CharStyle:MenuItem': u'span class="menuitem"',
-      u'Code': u'span class="code"', u'MenuItem': u'span class="menuitem"',
-      u'Noun': u'span class="noun"', u'Strong': u'span class="strong"',
-      }
-
-  group = {
-      u'layouts': u'Quotation', u'Quote',,
-      }
-
-  layouts = {
-      u'Center': u'div', u'Chapter': u'h?', u'Date': u'h2', u'Paragraph': u'div',
-      u'Part': u'h1', u'Quotation': u'blockquote', u'Quote': u'blockquote',
-      u'Section': u'h?', u'Subsection': u'h?', u'Subsubsection': u'h?',
-      }
-
-  listitems = {
-      u'Enumerate': u'ol', u'Itemize': u'ul',
-      }
-
-  notes = {
-      u'Comment': u'', u'Greyedout': u'span class="greyedout"', u'Note': u'',
-      }
-
-  script = {
-      u'subscript': u'sub', u'superscript': u'sup',
-      }
-
-  shaped = {
-      u'italic': u'i', u'slanted': u'i', u'smallcaps': u'span class="versalitas"',
-      }
-
-class TranslationConfig(object):
-  "Configuration class from elyxer.config file"
-
-  constants = {
-      u'Appendix': u'Appendix', u'Book': u'Book', u'Chapter': u'Chapter',
-      u'Paragraph': u'Paragraph', u'Part': u'Part', u'Section': u'Section',
-      u'Subsection': u'Subsection', u'Subsubsection': u'Subsubsection',
-      u'abstract': u'Abstract', u'bibliography': u'Bibliography',
-      u'figure': u'figure', u'float-algorithm': u'Algorithm ',
-      u'float-figure': u'Figure ', u'float-listing': u'Listing ',
-      u'float-table': u'Table ', u'float-tableau': u'Tableau ',
-      u'footnotes': u'Footnotes', u'generated-by': u'Document generated by ',
-      u'generated-on': u' on ', u'index': u'Index',
-      u'jsmath-enable': u'Please enable JavaScript on your browser.',
-      u'jsmath-requires': u' requires JavaScript to correctly process the mathematics on this page. ',
-      u'jsmath-warning': u'Warning: ', u'list-algorithm': u'List of Algorithms',
-      u'list-figure': u'List of Figures', u'list-table': u'List of Tables',
-      u'list-tableau': u'List of Tableaux', u'main-page': u'Main page',
-      u'next': u'Next', u'nomenclature': u'Nomenclature',
-      u'on-page': u' on page ', u'prev': u'Prev', u'references': u'References',
-      u'toc': u'Table of Contents', u'toc-for': u'Contents for ', u'up': u'Up',
-      }
-
-  languages = {
-      u'american': u'en', u'british': u'en', u'deutsch': u'de', u'dutch': u'nl',
-      u'english': u'en', u'french': u'fr', u'ngerman': u'de', u'russian': u'ru',
-      u'spanish': u'es',
-      }
-
-
-class CommandLineParser(object):
-  "A parser for runtime options"
-
-  def __init__(self, options):
-    self.options = options
-
-  def parseoptions(self, args):
-    "Parse command line options"
-    if len(args) == 0:
-      return None
-    while len(args) > 0 and args0.startswith('--'):
-      key, value = self.readoption(args)
-      if not key:
-        return 'Option ' + value + ' not recognized'
-      if not value:
-        return 'Option ' + key + ' needs a value'
-      setattr(self.options, key, value)
-    return None
-
-  def readoption(self, args):
-    "Read the key and value for an option"
-    arg = args02:
-    del args0
-    if '=' in arg:
-      key = self.readequalskey(arg, args)
-    else:
-      key = arg.replace('-', '')
-    if not hasattr(self.options, key):
-      return None, key
-    current = getattr(self.options, key)
-    if isinstance(current, bool):
-      return key, True
-    # read value
-    if len(args) == 0:
-      return key, None
-    if args0.startswith('"'):
-      initial = args0
-      del args0
-      return key, self.readquoted(args, initial)
-    value = args0.decode('utf-8')
-    del args0
-    if isinstance(current, list):
-      current.append(value)
-      return key, current
-    return key, value
-
-  def readquoted(self, args, initial):
-    "Read a value between quotes"
-    Trace.error('Oops')
-    value = initial1:
-    while len(args) > 0 and not args0.endswith('"') and not args0.startswith('--'):
-      Trace.error('Appending ' + args0)
-      value += ' ' + args0
-      del args0
-    if len(args) == 0 or args0.startswith('--'):
-      return None
-    value += ' ' + args0:-1
-    return value
-
-  def readequalskey(self, arg, args):
-    "Read a key using equals"
-    split = arg.split('=', 1)
-    key = split0
-    value = split1
-    args.insert(0, value)
-    return key
-
-
-class Options(object):
-  "A set of runtime options"
-
-  instance = None
-
-  location = None
-  nocopy = False
-  copyright = False
-  debug = False
-  quiet = False
-  version = False
-  hardversion = False
-  versiondate = False
-  html = False
-  help = False
-  showlines = True
-  unicode = False
-  iso885915 = False
-  css = 
-  favicon = ''
-  title = None
-  directory = None
-  destdirectory = None
-  toc = False
-  toctarget = ''
-  tocfor = None
-  forceformat = None
-  lyxformat = False
-  target = None
-  splitpart = None
-  memory = True
-  lowmem = False
-  nobib = False
-  converter = 'imagemagick'
-  raw = False
-  jsmath = None
-  mathjax = None
-  nofooter = False
-  simplemath = False
-  template = None
-  noconvert = False
-  notoclabels = False
-  letterfoot = True
-  numberfoot = False
-  symbolfoot = False
-  hoverfoot = True
-  marginfoot = False
-  endfoot = False
-  supfoot = True
-  alignfoot = False
-  footnotes = None
-  imageformat = None
-  copyimages = False
-  googlecharts = False
-  embedcss = 
-
-  branches = dict()
-
-  def parseoptions(self, args):
-    "Parse command line options"
-    Options.location = args0
-    del args0
-    parser = CommandLineParser(Options)
-    result = parser.parseoptions(args)
-    if result:
-      Trace.error(result)
-      self.usage()
-    self.processoptions()
-
-  def processoptions(self):
-    "Process all options parsed."
-    if Options.help:
-      self.usage()
-    if Options.version:
-      self.showversion()
-    if Options.hardversion:
-      self.showhardversion()
-    if Options.versiondate:
-      self.showversiondate()
-    if Options.lyxformat:
-      self.showlyxformat()
-    if Options.splitpart:
-      try:
-        Options.splitpart = int(Options.splitpart)
-        if Options.splitpart <= 0:
-          Trace.error('--splitpart requires a number bigger than zero')
-          self.usage()
-      except:
-        Trace.error('--splitpart needs a numeric argument, not ' + Options.splitpart)
-        self.usage()
-    if Options.lowmem or Options.toc or Options.tocfor:
-      Options.memory = False
-    self.parsefootnotes()
-    if Options.forceformat and not Options.imageformat:
-      Options.imageformat = Options.forceformat
-    if Options.imageformat == 'copy':
-      Options.copyimages = True
-    if Options.css == :
-      Options.css = 'http://elyxer.nongnu.org/lyx.css'
-    if Options.favicon == '':
-      pass # no default favicon
-    if Options.html:
-      Options.simplemath = True
-    if Options.toc and not Options.tocfor:
-      Trace.error('Option --toc is deprecated; use --tocfor "page" instead')
-      Options.tocfor = Options.toctarget
-    if Options.nocopy:
-      Trace.error('Option --nocopy is deprecated; it is no longer needed')
-    if Options.jsmath:
-      Trace.error('Option --jsmath is deprecated; use --mathjax instead')
-    # set in Trace if necessary
-    for param in dir(Trace):
-      if param.endswith('mode'):
-        setattr(Trace, param, getattr(self, param:-4))
-
-  def usage(self):
-    "Show correct usage"
-    Trace.error('Usage: ' + os.path.basename(Options.location) + ' options filein fileout')
-    Trace.error('Convert LyX input file "filein" to HTML file "fileout".')
-    Trace.error('If filein (or fileout) is not given use standard input (or output).')
-    Trace.error('Main program of the eLyXer package (http://elyxer.nongnu.org/).')
-    self.showoptions()
-
-  def parsefootnotes(self):
-    "Parse footnotes options."
-    if not Options.footnotes:
-      return
-    Options.marginfoot = False
-    Options.letterfoot = False
-    Options.hoverfoot = False
-    options = Options.footnotes.split(',')
-    for option in options:
-      footoption = option + 'foot'
-      if hasattr(Options, footoption):
-        setattr(Options, footoption, True)
-      else:
-        Trace.error('Unknown footnotes option: ' + option)
-    if not Options.endfoot and not Options.marginfoot and not Options.hoverfoot:
-      Options.hoverfoot = True
-    if not Options.numberfoot and not Options.symbolfoot:
-      Options.letterfoot = True
-
-  def showoptions(self):
-    "Show all possible options"
-    Trace.error('  Common options:')
-    Trace.error('    --help:                 show this online help')
-    Trace.error('    --quiet:                disables all runtime messages')
-    Trace.error('')
-    Trace.error('  Advanced options:')
-    Trace.error('    --debug:                enable debugging messages (for developers)')
-    Trace.error('    --version:              show version number and release date')
-    Trace.error('    --lyxformat:            return the highest LyX version supported')
-    Trace.error('  Options for HTML output:')
-    Trace.error('    --title "title":        set the generated page title')
-    Trace.error('    --css "file.css":       use a custom CSS file')
-    Trace.error('    --embedcss "file.css":  embed styles from a CSS file into the output')
-    Trace.error('    --favicon "icon.ico":   insert the specified favicon in the header.')
-    Trace.error('    --html:                 output HTML 4.0 instead of the default XHTML')
-    Trace.error('    --unicode:              full Unicode output')
-    Trace.error('    --iso885915:            output a document with ISO-8859-15 encoding')
-    Trace.error('    --nofooter:             remove the footer "generated by eLyXer"')
-    Trace.error('    --simplemath:           do not generate fancy math constructions')
-    Trace.error('  Options for image output:')
-    Trace.error('    --directory "img_dir":  look for images in the specified directory')
-    Trace.error('    --destdirectory "dest": put converted images into this directory')
-    Trace.error('    --imageformat ".ext":   image output format, or "copy" to copy images')
-    Trace.error('    --noconvert:            do not convert images, use in original locations')
-    Trace.error('    --converter "inkscape": use an alternative program to convert images')
-    Trace.error('  Options for footnote display:')
-    Trace.error('    --numberfoot:           mark footnotes with numbers instead of letters')
-    Trace.error('    --symbolfoot:           mark footnotes with symbols (*, **...)')
-    Trace.error('    --hoverfoot:            show footnotes as hovering text (default)')
-    Trace.error('    --marginfoot:           show footnotes on the page margin')
-    Trace.error('    --endfoot:              show footnotes at the end of the page')
-    Trace.error('    --supfoot:              use superscript for footnote markers (default)')
-    Trace.error('    --alignfoot:            use aligned text for footnote markers')
-    Trace.error('    --footnotes "options":  specify several comma-separated footnotes options')
-    Trace.error('      Available options are: "number", "symbol", "hover", "margin", "end",')
-    Trace.error('        "sup", "align"')
-    Trace.error('  Advanced output options:')
-    Trace.error('    --splitpart "depth":    split the resulting webpage at the given depth')
-    Trace.error('    --tocfor "page":        generate a TOC that points to the given page')
-    Trace.error('    --target "frame":       make all links point to the given frame')
-    Trace.error('    --notoclabels:          omit the part labels in the TOC, such as Chapter')
-    Trace.error('    --lowmem:               do the conversion on the fly (conserve memory)')
-    Trace.error('    --raw:                  generate HTML without header or footer.')
-    Trace.error('    --mathjax remote:       use MathJax remotely to display equations')
-    Trace.error('    --mathjax "URL":        use MathJax from the given URL to display equations')
-    Trace.error('    --googlecharts:         use Google Charts to generate formula images')
-    Trace.error('    --template "file":      use a template, put everything in ')
-    Trace.error('    --copyright:            add a copyright notice at the bottom')
-    Trace.error('  Deprecated options:')
-    Trace.error('    --toc:                  (deprecated) create a table of contents')
-    Trace.error('    --toctarget "page":     (deprecated) generate a TOC for the given page')
-    Trace.error('    --nocopy:               (deprecated) maintained for backwards compatibility')
-    Trace.error('    --jsmath "URL":         use jsMath from the given URL to display equations')
-    sys.exit()
-
-  def showversion(self):
-    "Return the current eLyXer version string"
-    string = 'eLyXer version ' + GeneralConfig.version'number'
-    string += ' (' + GeneralConfig.version'date' + ')'
-    Trace.error(string)
-    sys.exit()
-
-  def showhardversion(self):
-    "Return just the version string"
-    Trace.message(GeneralConfig.version'number')
-    sys.exit()
-
-  def showversiondate(self):
-    "Return just the version dte"
-    Trace.message(GeneralConfig.version'date')
-    sys.exit()
-
-  def showlyxformat(self):
-    "Return just the lyxformat parameter"
-    Trace.message(GeneralConfig.version'lyxformat')
-    sys.exit()
-
-class BranchOptions(object):
-  "A set of options for a branch"
-
-  def __init__(self, name):
-    self.name = name
-    self.options = {'color':'#ffffff'}
-
-  def set(self, key, value):
-    "Set a branch option"
-    if not key.startswith(ContainerConfig.string'startcommand'):
-      Trace.error('Invalid branch option ' + key)
-      return
-    key = key.replace(ContainerConfig.string'startcommand', '')
-    self.optionskey = value
-
-  def isselected(self):
-    "Return if the branch is selected"
-    if not 'selected' in self.options:
-      return False
-    return self.options'selected' == '1'
-
-  def __unicode__(self):
-    "String representation"
-    return 'options for ' + self.name + ': ' + unicode(self.options)
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class Cloner(object):
-  "An object used to clone other objects."
-
-  def clone(cls, original):
-    "Return an exact copy of an object."
-    "The original object must have an empty constructor."
-    return cls.create(original.__class__)
-
-  def create(cls, type):
-    "Create an object of a given class."
-    clone = type.__new__(type)
-    clone.__init__()
-    return clone
-
-  clone = classmethod(clone)
-  create = classmethod(create)
-
-class ContainerExtractor(object):
-  "A class to extract certain containers."
-
-  def __init__(self, config):
-    "The config parameter is a map containing three lists: allowed, copied and extracted."
-    "Each of the three is a list of class names for containers."
-    "Allowed containers are included as is into the result."
-    "Cloned containers are cloned and placed into the result."
-    "Extracted containers are looked into."
-    "All other containers are silently ignored."
-    self.allowed = config'allowed'
-    self.cloned = config'cloned'
-    self.extracted = config'extracted'
-
-  def extract(self, container):
-    "Extract a group of selected containers from elyxer.a container."
-    list = 
-    locate = lambda c: c.__class__.__name__ in self.allowed + self.cloned
-    recursive = lambda c: c.__class__.__name__ in self.extracted
-    process = lambda c: self.process(c, list)
-    container.recursivesearch(locate, recursive, process)
-    return list
-
-  def process(self, container, list):
-    "Add allowed containers, clone cloned containers and add the clone."
-    name = container.__class__.__name__
-    if name in self.allowed:
-      list.append(container)
-    elif name in self.cloned:
-      list.append(self.safeclone(container))
-    else:
-      Trace.error('Unknown container class ' + name)
-
-  def safeclone(self, container):
-    "Return a new container with contents only in a safe list, recursively."
-    clone = Cloner.clone(container)
-    clone.output = container.output
-    clone.contents = self.extract(container)
-    return clone
-
-
-
-
-
-
-class Parser(object):
-  "A generic parser"
-
-  def __init__(self):
-    self.begin = 0
-    self.parameters = dict()
-
-  def parseheader(self, reader):
-    "Parse the header"
-    header = reader.currentline().split()
-    reader.nextline()
-    self.begin = reader.linenumber
-    return header
-
-  def parseparameter(self, reader):
-    "Parse a parameter"
-    if reader.currentline().strip().startswith('<'):
-      key, value = self.parsexml(reader)
-      self.parameterskey = value
-      return
-    split = reader.currentline().strip().split(' ', 1)
-    reader.nextline()
-    if len(split) == 0:
-      return
-    key = split0
-    if len(split) == 1:
-      self.parameterskey = True
-      return
-    if not '"' in split1:
-      self.parameterskey = split1.strip()
-      return
-    doublesplit = split1.split('"')
-    self.parameterskey = doublesplit1
-
-  def parsexml(self, reader):
-    "Parse a parameter in xml form: <param attr1=value...>"
-    strip = reader.currentline().strip()
-    reader.nextline()
-    if not strip.endswith('>'):
-      Trace.error('XML parameter ' + strip + ' should be <...>')
-    split = strip1:-1.split()
-    if len(split) == 0:
-      Trace.error('Empty XML parameter <>')
-      return None, None
-    key = split0
-    del split0
-    if len(split) == 0:
-      return key, dict()
-    attrs = dict()
-    for attr in split:
-      if not '=' in attr:
-        Trace.error('Erroneous attribute for ' + key + ': ' + attr)
-        attr += '="0"'
-      parts = attr.split('=')
-      attrkey = parts0
-      value = parts1.split('"')1
-      attrsattrkey = value
-    return key, attrs
-
-  def parseending(self, reader, process):
-    "Parse until the current ending is found"
-    if not self.ending:
-      Trace.error('No ending for ' + unicode(self))
-      return
-    while not reader.currentline().startswith(self.ending):
-      process()
-
-  def parsecontainer(self, reader, contents):
-    container = self.factory.createcontainer(reader)
-    if container:
-      container.parent = self.parent
-      contents.append(container)
-
-  def __unicode__(self):
-    "Return a description"
-    return self.__class__.__name__ + ' (' + unicode(self.begin) + ')'
+from docutils.utils.math import tex2unichar
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
 
+__version__ = '1.3 (2021-06-02)'
 
-class LoneCommand(Parser):
-  "A parser for just one command line"
 
-  def parse(self, reader):
-    "Read nothing"
-    return 
+class Trace:
+    "A tracing class"
 
-class TextParser(Parser):
-  "A parser for a command and a bit of text"
+    debugmode = False
+    quietmode = False
+    showlinesmode = False
+
+    prefix = None
+
+    def debug(cls, message):
+        "Show a debug message"
+        if not Trace.debugmode or Trace.quietmode:
+            return
+        Trace.show(message, sys.stdout)
+
+    def message(cls, message):
+        "Show a trace message"
+        if Trace.quietmode:
+            return
+        if Trace.prefix and Trace.showlinesmode:
+            message = Trace.prefix + message
+        Trace.show(message, sys.stdout)
+
+    def error(cls, message):
+        "Show an error message"
+        message = '* ' + message
+        if Trace.prefix and Trace.showlinesmode:
+            message = Trace.prefix + message
+        Trace.show(message, sys.stderr)
+
+    def fatal(cls, message):
+        "Show an error message and terminate"
+        Trace.error('FATAL: ' + message)
+        exit(-1)
+
+    def show(cls, message, channel):
+        "Show a message out of a channel"
+        channel.write(message + '\n')
+
+    debug = classmethod(debug)
+    message = classmethod(message)
+    error = classmethod(error)
+    fatal = classmethod(fatal)
+    show = classmethod(show)
+
+
+class ContainerConfig:
+    "Configuration class from elyxer.config file"
+
+    extracttext = {
+        'allowed': 'FormulaConstant',
+        'extracted': 'AlphaCommand',
+                      'Bracket',
+                      'BracketCommand',
+                      'CombiningFunction',
+                      'EmptyCommand',
+                      'FontFunction',
+                      'Formula',
+                      'FormulaNumber',
+                      'FormulaSymbol',
+                      'OneParamFunction',
+                      'OversetFunction',
+                      'RawText',
+                      'SpacedCommand',
+                      'SymbolFunction',
+                      'TextFunction',
+                      'UndersetFunction',
+                      ,
+    }
+
+
+class EscapeConfig:
+    "Configuration class from elyxer.config file"
+
+    chars = {
+        '\n': '',
+        "'": '’',
+        '`': '‘',
+    }
+
+    entities = {
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+    }
+
+
+class FormulaConfig:
+    "Configuration class from elyxer.config file"
+
+    alphacommands = {
+        '\\AmS': '<span class="textsc">AmS</span>',
+        '\\AA':        'Å',
+        '\\AE':        'Æ',
+        '\\DH':        'Ð',
+        '\\L':         'Ł',
+        '\\O':         'Ø',
+        '\\OE':        'Œ',
+        '\\TH':        'Þ',
+        '\\aa':        'å',
+        '\\ae':        'æ',
+        '\\dh':        'ð',
+        '\\i':         'ı',
+        '\\j':         'ȷ',
+        '\\l':         'ł',
+        '\\o':         'ø',
+        '\\oe':        'œ',
+        '\\ss':        'ß',
+        '\\th':        'þ',
+    }
+    for key, value in tex2unichar.mathalpha.items():
+        alphacommands'\\'+key = value
+
+    array = {
+        'begin': r'\begin',
+        'cellseparator': '&',
+        'end': r'\end',
+        'rowseparator': r'\\',
+    }
+
+    bigbrackets = {'(': '⎛', '⎜', '⎝',
+                   ')': '⎞', '⎟', '⎠',
+                   '': '⎡', '⎢', '⎣',
+                   '': '⎤', '⎥', '⎦',
+                   '{': '⎧', '⎪', '⎨', '⎩',
+                   '}': '⎫', '⎪', '⎬', '⎭',
+                   # TODO: 2-row brackets with ⎰⎱ (\lmoustache \rmoustache)
+                   '|': '|',  # 007C VERTICAL LINE
+                   # '|': '⎮',  # 23AE INTEGRAL EXTENSION
+                   # '|': '⎪',  # 23AA CURLY BRACKET EXTENSION
+                   '‖': '‖',  # 2016 DOUBLE VERTICAL LINE
+                   # '∥': '∥',  # 2225 PARALLEL TO
+                   }
+
+    bracketcommands = {
+        '\\left': 'span class="stretchy"',
+        '\\left.': '<span class="leftdot"></span>',
+        '\\middle': 'span class="stretchy"',
+        '\\right': 'span class="stretchy"',
+        '\\right.': '<span class="rightdot"></span>',
+    }
+
+    combiningfunctions = {
+        "\\'":           '\u0301',  # x́
+        '\\"':           '\u0308',  # ẍ
+        '\\^':           '\u0302',  # x̂
+        '\\`':           '\u0300',  # x̀
+        '\\~':           '\u0303',  # x̃
+        '\\c':           '\u0327',  # x̧
+        '\\r':           '\u030a',  # x̊
+        '\\s':           '\u0329',  # x̩
+        '\\textcircled': '\u20dd',  # x⃝
+        '\\textsubring': '\u0325',  # x̥
+        '\\v':           '\u030c',  # x̌
+    }
+    for key, value in tex2unichar.mathaccent.items():
+        combiningfunctions'\\'+key = value
+
+    commands = {
+        '\\\\': '<br/>',
+        '\\\n': ' ',  # escaped whitespace
+        '\\\t': ' ',  # escaped whitespace
+        '\\centerdot': '\u2B1D',  # BLACK VERY SMALL SQUARE, mathbin
+        '\\colon': ': ',
+        '\\copyright': '©',
+        '\\dotminus': '∸',
+        '\\dots': '…',
+        '\\dotsb': '⋯',
+        '\\dotsc': '…',
+        '\\dotsi': '⋯',
+        '\\dotsm': '⋯',
+        '\\dotso': '…',
+        '\\euro': '€',
+        '\\guillemotleft': '«',
+        '\\guillemotright': '»',
+        '\\hbar': '<i>\u0127</i>',  # ħ LATIN SMALL LETTER H WITH STROKE
+        '\\lVert': '‖',
+        '\\Arrowvert':  '\u2016',  # ‖
+        '\\lvert': '|',
+        '\\newline': '<br/>',
+        '\\nobreakspace': ' ',
+        '\\nolimits': '',
+        '\\nonumber': '',
+        '\\qquad': '  ',
+        '\\rVert': '‖',
+        '\\rvert': '|',
+        '\\textasciicircum': '^',
+        '\\textasciitilde': '~',
+        '\\textbackslash': '\\',
+        '\\textcopyright': '©',
+        '\\textdegree': '°',
+        '\\textellipsis': '…',
+        '\\textemdash': '—',
+        '\\textendash': '—',
+        '\\texteuro': '€',
+        '\\textgreater': '>',
+        '\\textless': '<',
+        '\\textordfeminine': 'ª',
+        '\\textordmasculine': 'º',
+        '\\textquotedblleft': '“',
+        '\\textquotedblright': '”',
+        '\\textquoteright': '’',
+        '\\textregistered': '®',
+        '\\textrightarrow': '→',
+        '\\textsection': '§',
+        '\\texttrademark': '™',
+        '\\texttwosuperior': '²',
+        '\\textvisiblespace': ' ',
+        '\\thickspace': '<span class="thickspace"> </span>',  # 5/13 em
+        '\\;': '<span class="thickspace"> </span>',  # 5/13 em
+        '\\triangle': '\u25B3',  # WHITE UP-POINTING TRIANGLE, mathord
+        '\\triangledown': '\u25BD',  # WHITE DOWN-POINTING TRIANGLE, mathord
+        '\\varnothing': '\u2300',  # ⌀ DIAMETER SIGN
+        # functions
+        '\\Pr': 'Pr',
+        '\\arccos': 'arccos',
+        '\\arcsin': 'arcsin',
+        '\\arctan': 'arctan',
+        '\\arg': 'arg',
+        '\\cos': 'cos',
+        '\\cosh': 'cosh',
+        '\\cot': 'cot',
+        '\\coth': 'coth',
+        '\\csc': 'csc',
+        '\\deg': 'deg',
+        '\\det': 'det',
+        '\\dim': 'dim',
+        '\\exp': 'exp',
+        '\\gcd': 'gcd',
+        '\\hom': 'hom',
+        '\\injlim': 'inj lim',
+        '\\ker': 'ker',
+        '\\lg': 'lg',
+        '\\liminf': 'lim inf',
+        '\\limsup': 'lim sup',
+        '\\ln': 'ln',
+        '\\log': 'log',
+        '\\projlim': 'proj lim',
+        '\\sec': 'sec',
+        '\\sin': 'sin',
+        '\\sinh': 'sinh',
+        '\\tan': 'tan',
+        '\\tanh': 'tanh',
+    }
+    cmddict = {}
+    cmddict.update(tex2unichar.mathbin)  # TODO: spacing around binary operators
+    cmddict.update(tex2unichar.mathopen)
+    cmddict.update(tex2unichar.mathclose)
+    cmddict.update(tex2unichar.mathfence)
+    cmddict.update(tex2unichar.mathord)
+    cmddict.update(tex2unichar.mathpunct)
+    cmddict.update(tex2unichar.space)
+    commands.update(('\\' + key, value) for key, value in cmddict.items())
+
+    oversetfunctions = {
+        # math accents (cf. combiningfunctions)
+        # '\\acute':    '´',
+        '\\bar':      '‒',  # FIGURE DASH
+        # '\\breve':    '˘',
+        # '\\check':    'ˇ',
+        '\\dddot':    '<span class="smallsymbol">⋯</span>',
+        # '\\ddot':     '··', # ¨ too high
+        # '\\dot':      '·',
+        # '\\grave':    '`',
+        # '\\hat':      '^',
+        # '\\mathring': '˚',
+        # '\\tilde':    '~',
+        '\\vec':      '<span class="smallsymbol">→</span>',
+        # embellishments
+        '\\overleftarrow': '⟵',
+        '\\overleftrightarrow': '⟷',
+        '\\overrightarrow': '⟶',
+        '\\widehat': '^',
+        '\\widetilde': '～',
+    }
+
+    undersetfunctions = {
+        '\\underleftarrow': '⟵',
+        '\\underleftrightarrow': '⟷',
+        '\\underrightarrow': '⟶',
+    }
+
+    endings = {
+        'bracket': '}',
+        'complex': '\\',
+        'endafter': '}',
+        'endbefore': '\\end{',
+        'squarebracket': '',
+    }
+
+    environments = {
+        'align': 'r', 'l',
+        'eqnarray': 'r', 'c', 'l',
+        'gathered': 'l', 'l',
+        'smallmatrix': 'c', 'c',
+    }
+
+    fontfunctions = {
+        '\\boldsymbol': 'b', '\\mathbb': 'span class="blackboard"',
+        '\\mathbb{A}': '𝔸', '\\mathbb{B}': '𝔹', '\\mathbb{C}': 'ℂ',
+        '\\mathbb{D}': '𝔻', '\\mathbb{E}': '𝔼', '\\mathbb{F}': '𝔽',
+        '\\mathbb{G}': '𝔾', '\\mathbb{H}': 'ℍ', '\\mathbb{J}': '𝕁',
+        '\\mathbb{K}': '𝕂', '\\mathbb{L}': '𝕃', '\\mathbb{N}': 'ℕ',
+        '\\mathbb{O}': '𝕆', '\\mathbb{P}': 'ℙ', '\\mathbb{Q}': 'ℚ',
+        '\\mathbb{R}': 'ℝ', '\\mathbb{S}': '𝕊', '\\mathbb{T}': '𝕋',
+        '\\mathbb{W}': '𝕎', '\\mathbb{Z}': 'ℤ', '\\mathbf': 'b',
+        '\\mathcal': 'span class="scriptfont"',
+        '\\mathcal{B}': 'ℬ', '\\mathcal{E}': 'ℰ', '\\mathcal{F}':
+        'ℱ', '\\mathcal{H}': 'ℋ', '\\mathcal{I}': 'ℐ',
+        '\\mathcal{L}': 'ℒ', '\\mathcal{M}': 'ℳ', '\\mathcal{R}': 'ℛ',
+        '\\mathfrak': 'span class="fraktur"',
+        '\\mathfrak{C}': 'ℭ', '\\mathfrak{F}': '𝔉', '\\mathfrak{H}': 'ℌ',
+        '\\mathfrak{I}': 'ℑ', '\\mathfrak{R}': 'ℜ', '\\mathfrak{Z}': 'ℨ',
+        '\\mathit': 'i',
+        '\\mathring{A}': 'Å', '\\mathring{U}': 'Ů',
+        '\\mathring{a}': 'å', '\\mathring{u}': 'ů', '\\mathring{w}': 'ẘ',
+        '\\mathring{y}': 'ẙ',
+        '\\mathrm': 'span class="mathrm"',
+        '\\mathscr': 'span class="mathscr"',
+        '\\mathscr{B}': 'ℬ', '\\mathscr{E}': 'ℰ', '\\mathscr{F}': 'ℱ',
+        '\\mathscr{H}': 'ℋ', '\\mathscr{I}': 'ℐ', '\\mathscr{L}': 'ℒ',
+        '\\mathscr{M}': 'ℳ', '\\mathscr{R}': 'ℛ',
+        '\\mathsf': 'span class="mathsf"',
+        '\\mathtt': 'span class="mathtt"',
+        '\\operatorname': 'span class="mathrm"',
+    }
+
+    hybridfunctions = {
+        '\\addcontentsline': '{$p!}{$q!}{$r!}', 'f0{}', 'ignored',
+        '\\addtocontents': '{$p!}{$q!}', 'f0{}', 'ignored',
+        '\\backmatter': '', 'f0{}', 'ignored',
+        '\\binom': '{$1}{$2}', 'f2{(}f0{f1{$1}f1{$2}}f2{)}', 'span class="binom"', 'span class="binomstack"', 'span class="bigdelimiter size2"',
+        '\\boxed': '{$1}', 'f0{$1}', 'span class="boxed"',
+        '\\cfrac': '$p!{$1}{$2}', 'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', 'span class="fullfraction"', 'span class="numerator align-$p"', 'span class="denominator"', 'span class="ignored"',
+        '\\color': '{$p!}{$1}', 'f0{$1}', 'span style="color: $p;"',
+        '\\colorbox': '{$p!}{$1}', 'f0{$1}', 'span class="colorbox" style="background: $p;"',
+        '\\dbinom': '{$1}{$2}', '(f0{f1{f2{$1}}f1{f2{ }}f1{f2{$2}}})', 'span class="binomial"', 'span class="binomrow"', 'span class="binomcell"',
+        '\\dfrac': '{$1}{$2}', 'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', 'span class="fullfraction"', 'span class="numerator"', 'span class="denominator"', 'span class="ignored"',
+        '\\displaystyle': '{$1}', 'f0{$1}', 'span class="displaystyle"',
+        '\\fancyfoot': '$p!{$q!}', 'f0{}', 'ignored',
+        '\\fancyhead': '$p!{$q!}', 'f0{}', 'ignored',
+        '\\fbox': '{$1}', 'f0{$1}', 'span class="fbox"',
+        '\\fboxrule': '{$p!}', 'f0{}', 'ignored',
+        '\\fboxsep': '{$p!}', 'f0{}', 'ignored',
+        '\\fcolorbox': '{$p!}{$q!}{$1}', 'f0{$1}', 'span class="boxed" style="border-color: $p; background: $q;"',
+        '\\frac': '{$1}{$2}', 'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', 'span class="fraction"', 'span class="numerator"', 'span class="denominator"', 'span class="ignored"',
+        '\\framebox': '$p!$q!{$1}', 'f0{$1}', 'span class="framebox align-$q" style="width: $p;"',
+        '\\frontmatter': '', 'f0{}', 'ignored',
+        '\\href': '$o{$u!}{$t!}', 'f0{$t}', 'a href="$u"',
+        '\\hspace': '{$p!}', 'f0{ }', 'span class="hspace" style="width: $p;"',
+        '\\leftroot': '{$p!}', 'f0{ }', 'span class="leftroot" style="width: $p;px"',
+        # TODO: convert 1 mu to 1/18 em
+        # '\\mspace': '{$p!}', 'f0{ }', 'span class="hspace" style="width: $p;"',
+        '\\nicefrac': '{$1}{$2}', 'f0{f1{$1}⁄f2{$2}}', 'span class="fraction"', 'sup class="numerator"', 'sub class="denominator"', 'span class="ignored"',
+        '\\parbox': '$p!{$w!}{$1}', 'f0{1}', 'div class="Boxed" style="width: $w;"',
+        '\\raisebox': '{$p!}{$1}', 'f0{$1.font}', 'span class="raisebox" style="vertical-align: $p;"',
+        '\\renewenvironment': '{$1!}{$2!}{$3!}', '',
+        '\\rule': '$v!{$w!}{$h!}', 'f0/', 'hr class="line" style="width: $w; height: $h;"',
+        '\\scriptscriptstyle': '{$1}', 'f0{$1}', 'span class="scriptscriptstyle"',
+        '\\scriptstyle': '{$1}', 'f0{$1}', 'span class="scriptstyle"',
+        # TODO: increase √-size with argument (\frac in display mode, ...)
+        '\\sqrt': '$0{$1}', 'f0{f1{$0}f2{√}f4{(}f3{$1}f4{)}}', 'span class="sqrt"', 'sup class="root"', 'span class="radical"', 'span class="root"', 'span class="ignored"',
+        '\\stackrel': '{$1}{$2}', 'f0{f1{$1}f2{$2}}', 'span class="stackrel"', 'span class="upstackrel"', 'span class="downstackrel"',
+        '\\tbinom': '{$1}{$2}', '(f0{f1{f2{$1}}f1{f2{ }}f1{f2{$2}}})', 'span class="binomial"', 'span class="binomrow"', 'span class="binomcell"',
+        '\\tfrac':  '{$1}{$2}', 'f0{f3{(}f1{$1}f3{)/(}f2{$2}f3{)}}', 'span class="textfraction"', 'span class="numerator"', 'span class="denominator"', 'span class="ignored"',
+        '\\textcolor': '{$p!}{$1}', 'f0{$1}', 'span style="color: $p;"',
+        '\\textstyle': '{$1}', 'f0{$1}', 'span class="textstyle"',
+        '\\thispagestyle': '{$p!}', 'f0{}', 'ignored',
+        '\\unit': '$0{$1}', '$0f0{$1.font}', 'span class="unit"',
+        '\\unitfrac': '$0{$1}{$2}', '$0f0{f1{$1.font}⁄f2{$2.font}}', 'span class="fraction"', 'sup class="unit"', 'sub class="unit"',
+        '\\uproot': '{$p!}', 'f0{ }', 'span class="uproot" style="width: $p;px"',
+        '\\url': '{$u!}', 'f0{$u}', 'a href="$u"',
+        '\\vspace': '{$p!}', 'f0{ }', 'span class="vspace" style="height: $p;"',
+    }
+
+    hybridsizes = {
+        '\\binom': '$1+$2', '\\cfrac': '$1+$2', '\\dbinom': '$1+$2+1',
+        '\\dfrac': '$1+$2', '\\frac': '$1+$2', '\\tbinom': '$1+$2+1',
+    }
+
+    labelfunctions = {
+        '\\label': 'a name="#"',
+    }
+
+    limitcommands = {
+        '\\biginterleave': '⫼',
+        '\\inf': 'inf',
+        '\\lim': 'lim',
+        '\\max': 'max',
+        '\\min': 'min',
+        '\\sup': 'sup',
+        '\\ointop':    '<span class="bigoperator integral">∮</span>',
+        '\\bigcap':    '<span class="bigoperator">⋂</span>',
+        '\\bigcup':    '<span class="bigoperator">⋃</span>',
+        '\\bigodot':   '<span class="bigoperator">⨀</span>',
+        '\\bigoplus':  '<span class="bigoperator">⨁</span>',
+        '\\bigotimes': '<span class="bigoperator">⨂</span>',
+        '\\bigsqcap':  '<span class="bigoperator">⨅</span>',
+        '\\bigsqcup':  '<span class="bigoperator">⨆</span>',
+        '\\biguplus':  '<span class="bigoperator">⨄</span>',
+        '\\bigvee':    '<span class="bigoperator">⋁</span>',
+        '\\bigwedge':  '<span class="bigoperator">⋀</span>',
+        '\\coprod':    '<span class="bigoperator">∐</span>',
+        '\\intop':     '<span class="bigoperator integral">∫</span>',
+        '\\prod':      '<span class="bigoperator">∏</span>',
+        '\\sum':       '<span class="bigoperator">∑</span>',
+        '\\varprod':   '<span class="bigoperator">⨉</span>',
+        '\\zcmp': '⨟', '\\zhide': '⧹', '\\zpipe': '⨠', '\\zproject': '⨡',
+        # integrals have limits in index position with LaTeX default settings
+        # TODO: move to commands?
+        '\\int': '<span class="bigoperator integral">∫</span>',
+        '\\iint': '<span class="bigoperator integral">∬</span>',
+        '\\iiint': '<span class="bigoperator integral">∭</span>',
+        '\\iiiint': '<span class="bigoperator integral">⨌</span>',
+        '\\fint': '<span class="bigoperator integral">⨏</span>',
+        '\\idotsint': '<span class="bigoperator integral">∫⋯∫</span>',
+        '\\oint': '<span class="bigoperator integral">∮</span>',
+        '\\oiint': '<span class="bigoperator integral">∯</span>',
+        '\\oiiint': '<span class="bigoperator integral">∰</span>',
+        '\\ointclockwise': '<span class="bigoperator integral">∲</span>',
+        '\\ointctrclockwise': '<span class="bigoperator integral">∳</span>',
+        '\\smallint': '<span class="smallsymbol integral">∫</span>',
+        '\\sqint': '<span class="bigoperator integral">⨖</span>',
+        '\\varointclockwise': '<span class="bigoperator integral">∲</span>',
+    }
+
+    modified = {
+        '\n': '', ' ': '', '$': '', '&': '	', '\'': '’', '+': '\u2009+\u2009',
+        ',': ',\u2009', '-': '\u2009−\u2009', '/': '\u2009⁄\u2009', ':': ' : ', '<': '\u2009&lt;\u2009',
+        '=': '\u2009=\u2009', '>': '\u2009&gt;\u2009', '@': '', '~': '\u00a0',
+    }
+
+    onefunctions = {
+        '\\big': 'span class="bigdelimiter size1"',
+        '\\bigl': 'span class="bigdelimiter size1"',
+        '\\bigr': 'span class="bigdelimiter size1"',
+        '\\Big': 'span class="bigdelimiter size2"',
+        '\\Bigl': 'span class="bigdelimiter size2"',
+        '\\Bigr': 'span class="bigdelimiter size2"',
+        '\\bigg': 'span class="bigdelimiter size3"',
+        '\\biggl': 'span class="bigdelimiter size3"',
+        '\\biggr': 'span class="bigdelimiter size3"',
+        '\\Bigg': 'span class="bigdelimiter size4"',
+        '\\Biggl': 'span class="bigdelimiter size4"',
+        '\\Biggr': 'span class="bigdelimiter size4"',
+        # '\\bar': 'span class="bar"',
+        '\\begin{array}': 'span class="arraydef"',
+        '\\centering': 'span class="align-center"',
+        '\\ensuremath': 'span class="ensuremath"',
+        '\\hphantom': 'span class="phantom"',
+        '\\noindent': 'span class="noindent"',
+        '\\overbrace': 'span class="overbrace"',
+        '\\overline': 'span class="overline"',
+        '\\phantom': 'span class="phantom"',
+        '\\underbrace': 'span class="underbrace"',
+        '\\underline': '',
+        '\\vphantom': 'span class="phantom"',
+    }
+
+    # relations (put additional space before and after the symbol)
+    spacedcommands = {
+        # negated symbols without pre-composed Unicode character
+        '\\nleqq':      '\u2266\u0338',  # ≦̸
+        '\\ngeqq':      '\u2267\u0338',  # ≧̸
+        '\\nleqslant':  '\u2a7d\u0338',  # ⩽̸
+        '\\ngeqslant':  '\u2a7e\u0338',  # ⩾̸
+        '\\nsubseteqq': '\u2AC5\u0338',  # ⫅̸
+        '\\nsupseteqq': '\u2AC6\u0338',  # ⫆̸
+        '\\nsqsubset':  '\u2276\u228F',  # ⊏̸
+        # modified glyphs
+        '\\shortmid': '<span class="smallsymbol">∣</span>',
+        '\\shortparallel': '<span class="smallsymbol">∥</span>',
+        '\\nshortmid': '<span class="smallsymbol">∤</span>',
+        '\\nshortparallel': '<span class="smallsymbol">∦</span>',
+        '\\smallfrown': '<span class="smallsymbol">⌢</span>',
+        '\\smallsmile': '<span class="smallsymbol">⌣</span>',
+        '\\thickapprox': '<span class="boldsymbol">≈</span>',
+        '\\thicksim': '<span class="boldsymbol">∼</span>',
+        '\\varpropto': '<span class="mathsf">\u221d</span>',  # ∝ PROPORTIONAL TO
+    }
+    for key, value in tex2unichar.mathrel.items():
+        spacedcommands'\\'+key = value
+    starts = {
+        'beginafter': '}', 'beginbefore': '\\begin{', 'bracket': '{',
+        'command': '\\', 'comment': '%', 'complex': '\\', 'simple': '$',
+        'squarebracket': '', 'unnumbered': '*',
+    }
+
+    symbolfunctions = {
+        '^': 'sup', '_': 'sub',
+    }
+
+    textfunctions = {
+        '\\mbox': 'span class="mbox"',
+        '\\text': 'span class="text"',
+        '\\textbf': 'span class="textbf"',
+        '\\textit': 'span class="textit"',
+        '\\textnormal': 'span class="textnormal"',
+        '\\textrm': 'span class="textrm"',
+        '\\textsc': 'span class="textsc"',
+        '\\textsf': 'span class="textsf"',
+        '\\textsl': 'span class="textsl"',
+        '\\texttt': 'span class="texttt"',
+        '\\textup': 'span class="normal"',
+    }
+
+    unmodified = {
+        'characters': '.', '*', '€', '(', ')', '', '',
+                       '·', '!', ';', '|', '§', '"', '?',
+        }
+
+
+class CommandLineParser:
+    "A parser for runtime options"
+
+    def __init__(self, options):
+        self.options = options
+
+    def parseoptions(self, args):
+        "Parse command line options"
+        if len(args) == 0:
+            return None
+        while len(args) > 0 and args0.startswith('--'):
+            key, value = self.readoption(args)
+            if not key:
+                return 'Option ' + value + ' not recognized'
+            if not value:
+                return 'Option ' + key + ' needs a value'
+            setattr(self.options, key, value)
+        return None
 
-  stack = 
+    def readoption(self, args):
+        "Read the key and value for an option"
+        arg = args02:
+        del args0
+        if '=' in arg:
+            key = self.readequalskey(arg, args)
+        else:
+            key = arg.replace('-', '')
+        if not hasattr(self.options, key):
+            return None, key
+        current = getattr(self.options, key)
+        if isinstance(current, bool):
+            return key, True
+        # read value
+        if len(args) == 0:
+            return key, None
+        if args0.startswith('"'):
+            initial = args0
+            del args0
+            return key, self.readquoted(args, initial)
+        value = args0.decode('utf-8')
+        del args0
+        if isinstance(current, list):
+            current.append(value)
+            return key, current
+        return key, value
+
+    def readquoted(self, args, initial):
+        "Read a value between quotes"
+        Trace.error('Oops')
+        value = initial1:
+        while len(args) > 0 and not args0.endswith('"') and not args0.startswith('--'):
+            Trace.error('Appending ' + args0)
+            value += ' ' + args0
+            del args0
+        if len(args) == 0 or args0.startswith('--'):
+            return None
+        value += ' ' + args0:-1
+        return value
+
+    def readequalskey(self, arg, args):
+        "Read a key using equals"
+        split = arg.split('=', 1)
+        key = split0
+        value = split1
+        args.insert(0, value)
+        return key
+
+
+class Options:
+    "A set of runtime options"
+
+    location = None
+
+    debug = False
+    quiet = False
+    version = False
+    help = False
+    simplemath = False
+    showlines = True
+
+    branches = {}
+
+    def parseoptions(self, args):
+        "Parse command line options"
+        Options.location = args0
+        del args0
+        parser = CommandLineParser(Options)
+        result = parser.parseoptions(args)
+        if result:
+            Trace.error(result)
+            self.usage()
+        self.processoptions()
+
+    def processoptions(self):
+        "Process all options parsed."
+        if Options.help:
+            self.usage()
+        if Options.version:
+            self.showversion()
+        # set in Trace if necessary
+        for param in dir(Trace):
+            if param.endswith('mode'):
+                setattr(Trace, param, getattr(self, param:-4))
+
+    def usage(self):
+        "Show correct usage"
+        Trace.error(f'Usage: {pathlib.Path(Options.location).parent}'
+                    ' options "input string"')
+        Trace.error('Convert input string with LaTeX math to MathML')
+        self.showoptions()
+
+    def showoptions(self):
+        "Show all possible options"
+        Trace.error('    --help:                 show this online help')
+        Trace.error('    --quiet:                disables all runtime messages')
+        Trace.error('    --debug:                enable debugging messages (for developers)')
+        Trace.error('    --version:              show version number and release date')
+        Trace.error('    --simplemath:           do not generate fancy math constructions')
+        sys.exit()
+
+    def showversion(self):
+        "Return the current eLyXer version string"
+        Trace.error('math2html '+__version__)
+        sys.exit()
+
+
+class Cloner:
+    "An object used to clone other objects."
+
+    def clone(cls, original):
+        "Return an exact copy of an object."
+        "The original object must have an empty constructor."
+        return cls.create(original.__class__)
+
+    def create(cls, type):
+        "Create an object of a given class."
+        clone = type.__new__(type)
+        clone.__init__()
+        return clone
+
+    clone = classmethod(clone)
+    create = classmethod(create)
+
+
+class ContainerExtractor:
+    """A class to extract certain containers.
+
+    The config parameter is a map containing three lists:
+    allowed, copied and extracted.
+    Each of the three is a list of class names for containers.
+    Allowed containers are included as is into the result.
+    Cloned containers are cloned and placed into the result.
+    Extracted containers are looked into.
+    All other containers are silently ignored.
+    """
+
+    def __init__(self, config):
+        self.allowed = config'allowed'
+        self.extracted = config'extracted'
+
+    def extract(self, container):
+        "Extract a group of selected containers from a container."
+        list = 
+        locate = lambda c: c.__class__.__name__ in self.allowed
+        recursive = lambda c: c.__class__.__name__ in self.extracted
+        process = lambda c: self.process(c, list)
+        container.recursivesearch(locate, recursive, process)
+        return list
 
-  def __init__(self, container):
-    Parser.__init__(self)
-    self.ending = None
-    if container.__class__.__name__ in ContainerConfig.endings:
-      self.ending = ContainerConfig.endingscontainer.__class__.__name__
-    self.endings = 
-
-  def parse(self, reader):
-    "Parse lines as long as they are text"
-    TextParser.stack.append(self.ending)
-    self.endings = TextParser.stack + ContainerConfig.endings'Layout',
-        ContainerConfig.endings'Inset', self.ending
-    contents = 
-    while not self.isending(reader):
-      self.parsecontainer(reader, contents)
-    return contents
-
-  def isending(self, reader):
-    "Check if text is ending"
-    current = reader.currentline().split()
-    if len(current) == 0:
-      return False
-    if current0 in self.endings:
-      if current0 in TextParser.stack:
-        TextParser.stack.remove(current0)
-      else:
-        TextParser.stack = 
-      return True
-    return False
+    def process(self, container, list):
+        "Add allowed containers."
+        name = container.__class__.__name__
+        if name in self.allowed:
+            list.append(container)
+        else:
+            Trace.error('Unknown container class ' + name)
 
-class ExcludingParser(Parser):
-  "A parser that excludes the final line"
+    def safeclone(self, container):
+        "Return a new container with contents only in a safe list, recursively."
+        clone = Cloner.clone(container)
+        clone.output = container.output
+        clone.contents = self.extract(container)
+        return clone
+
+
+class Parser:
+    "A generic parser"
+
+    def __init__(self):
+        self.begin = 0
+        self.parameters = {}
+
+    def parseheader(self, reader):
+        "Parse the header"
+        header = reader.currentline().split()
+        reader.nextline()
+        self.begin = reader.linenumber
+        return header
+
+    def parseparameter(self, reader):
+        "Parse a parameter"
+        split = reader.currentline().strip().split(' ', 1)
+        reader.nextline()
+        if len(split) == 0:
+            return
+        key = split0
+        if len(split) == 1:
+            self.parameterskey = True
+            return
+        if '"' not in split1:
+            self.parameterskey = split1.strip()
+            return
+        doublesplit = split1.split('"')
+        self.parameterskey = doublesplit1
+
+    def parseending(self, reader, process):
+        "Parse until the current ending is found"
+        if not self.ending:
+            Trace.error('No ending for ' + str(self))
+            return
+        while not reader.currentline().startswith(self.ending):
+            process()
+
+    def parsecontainer(self, reader, contents):
+        container = self.factory.createcontainer(reader)
+        if container:
+            container.parent = self.parent
+            contents.append(container)
+
+    def __str__(self):
+        "Return a description"
+        return self.__class__.__name__ + ' (' + str(self.begin) + ')'
 
-  def parse(self, reader):
-    "Parse everything up to (and excluding) the final line"
-    contents = 
-    self.parseending(reader, lambda: self.parsecontainer(reader, contents))
-    return contents
 
-class BoundedParser(ExcludingParser):
-  "A parser bound by a final line"
+class LoneCommand(Parser):
+    "A parser for just one command line"
 
-  def parse(self, reader):
-    "Parse everything, including the final line"
-    contents = ExcludingParser.parse(self, reader)
-    # skip last line
-    reader.nextline()
-    return contents
+    def parse(self, reader):
+        "Read nothing"
+        return 
 
-class BoundedDummy(Parser):
-  "A bound parser that ignores everything"
 
-  def parse(self, reader):
-    "Parse the contents of the container"
-    self.parseending(reader, lambda: reader.nextline())
-    # skip last line
-    reader.nextline()
-    return 
+class TextParser(Parser):
+    "A parser for a command and a bit of text"
+
+    stack = 
+
+    def __init__(self, container):
+        Parser.__init__(self)
+        self.ending = None
+        if container.__class__.__name__ in ContainerConfig.endings:
+            self.ending = ContainerConfig.endingscontainer.__class__.__name__
+        self.endings = 
+
+    def parse(self, reader):
+        "Parse lines as long as they are text"
+        TextParser.stack.append(self.ending)
+        self.endings = TextParser.stack + ContainerConfig.endings'Layout',
+                                           ContainerConfig.endings'Inset',
+                                           self.ending
+        contents = 
+        while not self.isending(reader):
+            self.parsecontainer(reader, contents)
+        return contents
+
+    def isending(self, reader):
+        "Check if text is ending"
+        current = reader.currentline().split()
+        if len(current) == 0:
+            return False
+        if current0 in self.endings:
+            if current0 in TextParser.stack:
+                TextParser.stack.remove(current0)
+            else:
+                TextParser.stack = 
+            return True
+        return False
 
-class StringParser(Parser):
-  "Parses just a string"
 
-  def parseheader(self, reader):
-    "Do nothing, just take note"
-    self.begin = reader.linenumber + 1
-    return 
+class ExcludingParser(Parser):
+    "A parser that excludes the final line"
 
-  def parse(self, reader):
-    "Parse a single line"
-    contents = reader.currentline()
-    reader.nextline()
-    return contents
+    def parse(self, reader):
+        "Parse everything up to (and excluding) the final line"
+        contents = 
+        self.parseending(reader, lambda: self.parsecontainer(reader, contents))
+        return contents
 
-class InsetParser(BoundedParser):
-  "Parses a LyX inset"
 
-  def parse(self, reader):
-    "Parse inset parameters into a dictionary"
-    startcommand = ContainerConfig.string'startcommand'
-    while reader.currentline() != '' and not reader.currentline().startswith(startcommand):
-      self.parseparameter(reader)
-    return BoundedParser.parse(self, reader)
+class BoundedParser(ExcludingParser):
+    "A parser bound by a final line"
 
+    def parse(self, reader):
+        "Parse everything, including the final line"
+        contents = ExcludingParser.parse(self, reader)
+        # skip last line
+        reader.nextline()
+        return contents
 
 
+class BoundedDummy(Parser):
+    "A bound parser that ignores everything"
 
+    def parse(self, reader):
+        "Parse the contents of the container"
+        self.parseending(reader, lambda: reader.nextline())
+        # skip last line
+        reader.nextline()
+        return 
 
 
-class ContainerOutput(object):
-  "The generic HTML output for a container."
+class StringParser(Parser):
+    "Parses just a string"
 
-  def gethtml(self, container):
-    "Show an error."
-    Trace.error('gethtml() not implemented for ' + unicode(self))
+    def parseheader(self, reader):
+        "Do nothing, just take note"
+        self.begin = reader.linenumber + 1
+        return 
+
+    def parse(self, reader):
+        "Parse a single line"
+        contents = reader.currentline()
+        reader.nextline()
+        return contents
+
+
+class ContainerOutput:
+    "The generic HTML output for a container."
+
+    def gethtml(self, container):
+        "Show an error."
+        Trace.error('gethtml() not implemented for ' + str(self))
+
+    def isempty(self):
+        "Decide if the output is empty: by default, not empty."
+        return False
 
-  def isempty(self):
-    "Decide if the output is empty: by default, not empty."
-    return False
 
 class EmptyOutput(ContainerOutput):
 
-  def gethtml(self, container):
-    "Return empty HTML code."
-    return 
-
-  def isempty(self):
-    "This output is particularly empty."
-    return True
+    def gethtml(self, container):
+        "Return empty HTML code."
+        return 
+
+    def isempty(self):
+        "This output is particularly empty."
+        return True
+
 
 class FixedOutput(ContainerOutput):
-  "Fixed output"
+    "Fixed output"
+
+    def gethtml(self, container):
+        "Return constant HTML code"
+        return container.html
 
-  def gethtml(self, container):
-    "Return constant HTML code"
-    return container.html
 
 class ContentsOutput(ContainerOutput):
-  "Outputs the contents converted to HTML"
+    "Outputs the contents converted to HTML"
 
-  def gethtml(self, container):
-    "Return the HTML code"
-    html = 
-    if container.contents == None:
-      return html
-    for element in container.contents:
-      if not hasattr(element, 'gethtml'):
-        Trace.error('No html in ' + element.__class__.__name__ + ': ' + unicode(element))
+    def gethtml(self, container):
+        "Return the HTML code"
+        html = 
+        if container.contents is None:
+            return html
+        for element in container.contents:
+            if not hasattr(element, 'gethtml'):
+                Trace.error('No html in ' + element.__class__.__name__ + ': ' + str(element))
+                return html
+            html += element.gethtml()
         return html
-      html += element.gethtml()
-    return html
+
 
 class TaggedOutput(ContentsOutput):
-  "Outputs an HTML tag surrounding the contents."
+    "Outputs an HTML tag surrounding the contents."
+
+    tag = None
+    breaklines = False
+    empty = False
+
+    def settag(self, tag, breaklines=False, empty=False):
+        "Set the value for the tag and other attributes."
+        self.tag = tag
+        if breaklines:
+            self.breaklines = breaklines
+        if empty:
+            self.empty = empty
+        return self
+
+    def setbreaklines(self, breaklines):
+        "Set the value for breaklines."
+        self.breaklines = breaklines
+        return self
+
+    def gethtml(self, container):
+        "Return the HTML code."
+        if self.empty:
+            return self.selfclosing(container)
+        html = self.open(container)
+        html += ContentsOutput.gethtml(self, container)
+        html.append(self.close(container))
+        return html
+
+    def open(self, container):
+        "Get opening line."
+        if not self.checktag(container):
+            return ''
+        open = '<' + self.tag + '>'
+        if self.breaklines:
+            return open + '\n'
+        return open
+
+    def close(self, container):
+        "Get closing line."
+        if not self.checktag(container):
+            return ''
+        close = '</' + self.tag.split()0 + '>'
+        if self.breaklines:
+            return '\n' + close + '\n'
+        return close
+
+    def selfclosing(self, container):
+        "Get self-closing line."
+        if not self.checktag(container):
+            return ''
+        selfclosing = '<' + self.tag + '/>'
+        if self.breaklines:
+            return selfclosing + '\n'
+        return selfclosing
+
+    def checktag(self, container):
+        "Check that the tag is valid."
+        if not self.tag:
+            Trace.error('No tag in ' + str(container))
+            return False
+        if self.tag == '':
+            return False
+        return True
 
-  tag = None
-  breaklines = False
-  empty = False
-
-  def settag(self, tag, breaklines=False, empty=False):
-    "Set the value for the tag and other attributes."
-    self.tag = tag
-    if breaklines:
-      self.breaklines = breaklines
-    if empty:
-      self.empty = empty
-    return self
-
-  def setbreaklines(self, breaklines):
-    "Set the value for breaklines."
-    self.breaklines = breaklines
-    return self
-
-  def gethtml(self, container):
-    "Return the HTML code."
-    if self.empty:
-      return self.selfclosing(container)
-    html = self.open(container)
-    html += ContentsOutput.gethtml(self, container)
-    html.append(self.close(container))
-    return html
-
-  def open(self, container):
-    "Get opening line."
-    if not self.checktag(container):
-      return ''
-    open = '<' + self.tag + '>'
-    if self.breaklines:
-      return open + '\n'
-    return open
-
-  def close(self, container):
-    "Get closing line."
-    if not self.checktag(container):
-      return ''
-    close = '</' + self.tag.split()0 + '>'
-    if self.breaklines:
-      return '\n' + close + '\n'
-    return close
-
-  def selfclosing(self, container):
-    "Get self-closing line."
-    if not self.checktag(container):
-      return ''
-    selfclosing = '<' + self.tag + '/>'
-    if self.breaklines:
-      return selfclosing + '\n'
-    return selfclosing
-
-  def checktag(self, container):
-    "Check that the tag is valid."
-    if not self.tag:
-      Trace.error('No tag in ' + unicode(container))
-      return False
-    if self.tag == '':
-      return False
-    return True
 
 class FilteredOutput(ContentsOutput):
-  "Returns the output in the contents, but filtered:"
-  "some strings are replaced by others."
+    "Returns the output in the contents, but filtered:"
+    "some strings are replaced by others."
+
+    def __init__(self):
+        "Initialize the filters."
+        self.filters = 
+
+    def addfilter(self, original, replacement):
+        "Add a new filter: replace the original by the replacement."
+        self.filters.append((original, replacement))
+
+    def gethtml(self, container):
+        "Return the HTML code"
+        result = 
+        html = ContentsOutput.gethtml(self, container)
+        for line in html:
+            result.append(self.filter(line))
+        return result
+
+    def filter(self, line):
+        "Filter a single line with all available filters."
+        for original, replacement in self.filters:
+            if original in line:
+                line = line.replace(original, replacement)
+        return line
 
-  def __init__(self):
-    "Initialize the filters."
-    self.filters = 
-
-  def addfilter(self, original, replacement):
-    "Add a new filter: replace the original by the replacement."
-    self.filters.append((original, replacement))
-
-  def gethtml(self, container):
-    "Return the HTML code"
-    result = 
-    html = ContentsOutput.gethtml(self, container)
-    for line in html:
-      result.append(self.filter(line))
-    return result
-
-  def filter(self, line):
-    "Filter a single line with all available filters."
-    for original, replacement in self.filters:
-      if original in line:
-        line = line.replace(original, replacement)
-    return line
 
 class StringOutput(ContainerOutput):
-  "Returns a bare string as output"
+    "Returns a bare string as output"
 
-  def gethtml(self, container):
-    "Return a bare string"
-    return container.string
-
-
-class LineReader(object):
-  "Reads a file line by line"
-
-  def __init__(self, filename):
-    if isinstance(filename, file):
-      self.file = filename
-    else:
-      self.file = codecs.open(filename, 'rU', 'utf-8')
-    self.linenumber = 1
-    self.lastline = None
-    self.current = None
-    self.mustread = True
-    self.depleted = False
-    try:
-      self.readline()
-    except UnicodeDecodeError:
-      # try compressed file
-      import gzip
-      self.file = gzip.open(filename, 'rb')
-      self.readline()
-
-  def setstart(self, firstline):
-    "Set the first line to read."
-    for i in range(firstline):
-      self.file.readline()
-    self.linenumber = firstline
-
-  def setend(self, lastline):
-    "Set the last line to read."
-    self.lastline = lastline
-
-  def currentline(self):
-    "Get the current line"
-    if self.mustread:
-      self.readline()
-    return self.current
-
-  def nextline(self):
-    "Go to next line"
-    if self.depleted:
-      Trace.fatal('Read beyond file end')
-    self.mustread = True
-
-  def readline(self):
-    "Read a line from elyxer.file"
-    self.current = self.file.readline()
-    if not isinstance(self.file, codecs.StreamReaderWriter):
-      self.current = self.current.decode('utf-8')
-    if len(self.current) == 0:
-      self.depleted = True
-    self.current = self.current.rstrip('\n\r')
-    self.linenumber += 1
-    self.mustread = False
-    Trace.prefix = 'Line ' + unicode(self.linenumber) + ': '
-    if self.linenumber % 1000 == 0:
-      Trace.message('Parsing')
-
-  def finished(self):
-    "Find out if the file is finished"
-    if self.lastline and self.linenumber == self.lastline:
-      return True
-    if self.mustread:
-      self.readline()
-    return self.depleted
-
-  def close(self):
-    self.file.close()
-
-class LineWriter(object):
-  "Writes a file as a series of lists"
-
-  file = False
-
-  def __init__(self, filename):
-    if isinstance(filename, file):
-      self.file = filename
-      self.filename = None
-    else:
-      self.filename = filename
-
-  def write(self, strings):
-    "Write a list of strings"
-    for string in strings:
-      if not isinstance(string, basestring):
-        Trace.error('Not a string: ' + unicode(string) + ' in ' + unicode(strings))
-        return
-      self.writestring(string)
+    def gethtml(self, container):
+        "Return a bare string"
+        return container.string
 
-  def writestring(self, string):
-    "Write a string"
-    if not self.file:
-      self.file = codecs.open(self.filename, 'w', "utf-8")
-    if self.file == sys.stdout and sys.version_info < (3, 0):
-      string = string.encode('utf-8')
-    self.file.write(string)
-
-  def writeline(self, line):
-    "Write a line to file"
-    self.writestring(line + '\n')
-
-  def close(self):
-    self.file.close()
 
+class Globable:
+    """A bit of text which can be globbed (lumped together in bits).
+    Methods current(), skipcurrent(), checkfor() and isout() have to be
+    implemented by subclasses."""
 
+    leavepending = False
 
+    def __init__(self):
+        self.endinglist = EndingList()
 
+    def checkbytemark(self):
+        "Check for a Unicode byte mark and skip it."
+        if self.finished():
+            return
+        if ord(self.current()) == 0xfeff:
+            self.skipcurrent()
 
+    def isout(self):
+        "Find out if we are out of the position yet."
+        Trace.error('Unimplemented isout()')
+        return True
 
-class Globable(object):
-  """A bit of text which can be globbed (lumped together in bits).
-  Methods current(), skipcurrent(), checkfor() and isout() have to be
-  implemented by subclasses."""
-
-  leavepending = False
-
-  def __init__(self):
-    self.endinglist = EndingList()
-
-  def checkbytemark(self):
-    "Check for a Unicode byte mark and skip it."
-    if self.finished():
-      return
-    if ord(self.current()) == 0xfeff:
-      self.skipcurrent()
-
-  def isout(self):
-    "Find out if we are out of the position yet."
-    Trace.error('Unimplemented isout()')
-    return True
-
-  def current(self):
-    "Return the current character."
-    Trace.error('Unimplemented current()')
-    return ''
-
-  def checkfor(self, string):
-    "Check for the given string in the current position."
-    Trace.error('Unimplemented checkfor()')
-    return False
-
-  def finished(self):
-    "Find out if the current text has finished."
-    if self.isout():
-      if not self.leavepending:
-        self.endinglist.checkpending()
-      return True
-    return self.endinglist.checkin(self)
-
-  def skipcurrent(self):
-    "Return the current character and skip it."
-    Trace.error('Unimplemented skipcurrent()')
-    return ''
-
-  def glob(self, currentcheck):
-    "Glob a bit of text that satisfies a check on the current char."
-    glob = ''
-    while not self.finished() and currentcheck():
-      glob += self.skipcurrent()
-    return glob
-
-  def globalpha(self):
-    "Glob a bit of alpha text"
-    return self.glob(lambda: self.current().isalpha())
-
-  def globnumber(self):
-    "Glob a row of digits."
-    return self.glob(lambda: self.current().isdigit())
-
-  def isidentifier(self):
-    "Return if the current character is alphanumeric or _."
-    if self.current().isalnum() or self.current() == '_':
-      return True
-    return False
-
-  def globidentifier(self):
-    "Glob alphanumeric and _ symbols."
-    return self.glob(self.isidentifier)
-
-  def isvalue(self):
-    "Return if the current character is a value character:"
-    "not a bracket or a space."
-    if self.current().isspace():
-      return False
-    if self.current() in '{}()':
-      return False
-    return True
-
-  def globvalue(self):
-    "Glob a value: any symbols but brackets."
-    return self.glob(self.isvalue)
-
-  def skipspace(self):
-    "Skip all whitespace at current position."
-    return self.glob(lambda: self.current().isspace())
-
-  def globincluding(self, magicchar):
-    "Glob a bit of text up to (including) the magic char."
-    glob = self.glob(lambda: self.current() != magicchar) + magicchar
-    self.skip(magicchar)
-    return glob
-
-  def globexcluding(self, excluded):
-    "Glob a bit of text up until (excluding) any excluded character."
-    return self.glob(lambda: self.current() not in excluded)
-
-  def pushending(self, ending, optional = False):
-    "Push a new ending to the bottom"
-    self.endinglist.add(ending, optional)
-
-  def popending(self, expected = None):
-    "Pop the ending found at the current position"
-    if self.isout() and self.leavepending:
-      return expected
-    ending = self.endinglist.pop(self)
-    if expected and expected != ending:
-      Trace.error('Expected ending ' + expected + ', got ' + ending)
-    self.skip(ending)
-    return ending
-
-  def nextending(self):
-    "Return the next ending in the queue."
-    nextending = self.endinglist.findending(self)
-    if not nextending:
-      return None
-    return nextending.ending
-
-class EndingList(object):
-  "A list of position endings"
-
-  def __init__(self):
-    self.endings = 
-
-  def add(self, ending, optional = False):
-    "Add a new ending to the list"
-    self.endings.append(PositionEnding(ending, optional))
-
-  def pickpending(self, pos):
-    "Pick any pending endings from a parse position."
-    self.endings += pos.endinglist.endings
-
-  def checkin(self, pos):
-    "Search for an ending"
-    if self.findending(pos):
-      return True
-    return False
-
-  def pop(self, pos):
-    "Remove the ending at the current position"
-    if pos.isout():
-      Trace.error('No ending out of bounds')
-      return ''
-    ending = self.findending(pos)
-    if not ending:
-      Trace.error('No ending at ' + pos.current())
-      return ''
-    for each in reversed(self.endings):
-      self.endings.remove(each)
-      if each == ending:
-        return each.ending
-      elif not each.optional:
-        Trace.error('Removed non-optional ending ' + each)
-    Trace.error('No endings left')
-    return ''
-
-  def findending(self, pos):
-    "Find the ending at the current position"
-    if len(self.endings) == 0:
-      return None
-    for index, ending in enumerate(reversed(self.endings)):
-      if ending.checkin(pos):
+    def current(self):
+        "Return the current character."
+        Trace.error('Unimplemented current()')
+        return ''
+
+    def checkfor(self, string):
+        "Check for the given string in the current position."
+        Trace.error('Unimplemented checkfor()')
+        return False
+
+    def finished(self):
+        "Find out if the current text has finished."
+        if self.isout():
+            if not self.leavepending:
+                self.endinglist.checkpending()
+            return True
+        return self.endinglist.checkin(self)
+
+    def skipcurrent(self):
+        "Return the current character and skip it."
+        Trace.error('Unimplemented skipcurrent()')
+        return ''
+
+    def glob(self, currentcheck):
+        "Glob a bit of text that satisfies a check on the current char."
+        glob = ''
+        while not self.finished() and currentcheck():
+            glob += self.skipcurrent()
+        return glob
+
+    def globalpha(self):
+        "Glob a bit of alpha text"
+        return self.glob(lambda: self.current().isalpha())
+
+    def globnumber(self):
+        "Glob a row of digits."
+        return self.glob(lambda: self.current().isdigit())
+
+    def isidentifier(self):
+        "Return if the current character is alphanumeric or _."
+        if self.current().isalnum() or self.current() == '_':
+            return True
+        return False
+
+    def globidentifier(self):
+        "Glob alphanumeric and _ symbols."
+        return self.glob(self.isidentifier)
+
+    def isvalue(self):
+        "Return if the current character is a value character:"
+        "not a bracket or a space."
+        if self.current().isspace():
+            return False
+        if self.current() in '{}()':
+            return False
+        return True
+
+    def globvalue(self):
+        "Glob a value: any symbols but brackets."
+        return self.glob(self.isvalue)
+
+    def skipspace(self):
+        "Skip all whitespace at current position."
+        return self.glob(lambda: self.current().isspace())
+
+    def globincluding(self, magicchar):
+        "Glob a bit of text up to (including) the magic char."
+        glob = self.glob(lambda: self.current() != magicchar) + magicchar
+        self.skip(magicchar)
+        return glob
+
+    def globexcluding(self, excluded):
+        "Glob a bit of text up until (excluding) any excluded character."
+        return self.glob(lambda: self.current() not in excluded)
+
+    def pushending(self, ending, optional=False):
+        "Push a new ending to the bottom"
+        self.endinglist.add(ending, optional)
+
+    def popending(self, expected=None):
+        "Pop the ending found at the current position"
+        if self.isout() and self.leavepending:
+            return expected
+        ending = self.endinglist.pop(self)
+        if expected and expected != ending:
+            Trace.error('Expected ending ' + expected + ', got ' + ending)
+        self.skip(ending)
         return ending
-      if not ending.optional:
-        return None
-    return None
 
-  def checkpending(self):
-    "Check if there are any pending endings"
-    if len(self.endings) != 0:
-      Trace.error('Pending ' + unicode(self) + ' left open')
-
-  def __unicode__(self):
-    "Printable representation"
-    string = 'endings '
-    for ending in self.endings:
-      string += unicode(ending) + ','
-    if len(self.endings) > 0:
-      string = string:-1
-    return string + ''
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class PositionEnding(object):
-  "An ending for a parsing position"
-
-  def __init__(self, ending, optional):
-    self.ending = ending
-    self.optional = optional
-
-  def checkin(self, pos):
-    "Check for the ending"
-    return pos.checkfor(self.ending)
-
-  def __unicode__(self):
-    "Printable representation"
-    string = 'Ending ' + self.ending
-    if self.optional:
-      string += ' (optional)'
-    return string
+    def nextending(self):
+        "Return the next ending in the queue."
+        nextending = self.endinglist.findending(self)
+        if not nextending:
+            return None
+        return nextending.ending
+
+
+class EndingList:
+    "A list of position endings"
+
+    def __init__(self):
+        self.endings = 
+
+    def add(self, ending, optional=False):
+        "Add a new ending to the list"
+        self.endings.append(PositionEnding(ending, optional))
+
+    def pickpending(self, pos):
+        "Pick any pending endings from a parse position."
+        self.endings += pos.endinglist.endings
+
+    def checkin(self, pos):
+        "Search for an ending"
+        if self.findending(pos):
+            return True
+        return False
+
+    def pop(self, pos):
+        "Remove the ending at the current position"
+        if pos.isout():
+            Trace.error('No ending out of bounds')
+            return ''
+        ending = self.findending(pos)
+        if not ending:
+            Trace.error('No ending at ' + pos.current())
+            return ''
+        for each in reversed(self.endings):
+            self.endings.remove(each)
+            if each == ending:
+                return each.ending
+            elif not each.optional:
+                Trace.error('Removed non-optional ending ' + each)
+        Trace.error('No endings left')
+        return ''
+
+    def findending(self, pos):
+        "Find the ending at the current position"
+        if len(self.endings) == 0:
+            return None
+        for index, ending in enumerate(reversed(self.endings)):
+            if ending.checkin(pos):
+                return ending
+            if not ending.optional:
+                return None
+        return None
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def checkpending(self):
+        "Check if there are any pending endings"
+        if len(self.endings) != 0:
+            Trace.error('Pending ' + str(self) + ' left open')
+
+    def __str__(self):
+        "Printable representation"
+        string = 'endings '
+        for ending in self.endings:
+            string += str(ending) + ','
+        if len(self.endings) > 0:
+            string = string:-1
+        return string + ''
+
+
+class PositionEnding:
+    "An ending for a parsing position"
+
+    def __init__(self, ending, optional):
+        self.ending = ending
+        self.optional = optional
+
+    def checkin(self, pos):
+        "Check for the ending"
+        return pos.checkfor(self.ending)
+
+    def __str__(self):
+        "Printable representation"
+        string = 'Ending ' + self.ending
+        if self.optional:
+            string += ' (optional)'
+        return string
 
 
 class Position(Globable):
-  """A position in a text to parse.
-  Including those in Globable, functions to implement by subclasses are:
-  skip(), identifier(), extract(), isout() and current()."""
-
-  def __init__(self):
-    Globable.__init__(self)
-
-  def skip(self, string):
-    "Skip a string"
-    Trace.error('Unimplemented skip()')
-
-  def identifier(self):
-    "Return an identifier for the current position."
-    Trace.error('Unimplemented identifier()')
-    return 'Error'
-
-  def extract(self, length):
-    "Extract the next string of the given length, or None if not enough text,"
-    "without advancing the parse position."
-    Trace.error('Unimplemented extract()')
-    return None
-
-  def checkfor(self, string):
-    "Check for a string at the given position."
-    return string == self.extract(len(string))
-
-  def checkforlower(self, string):
-    "Check for a string in lower case."
-    extracted = self.extract(len(string))
-    if not extracted:
-      return False
-    return string.lower() == self.extract(len(string)).lower()
-
-  def skipcurrent(self):
-    "Return the current character and skip it."
-    current = self.current()
-    self.skip(current)
-    return current
-
-  def __next__(self):
-    "Advance the position and return the next character."
-    self.skipcurrent()
-    return self.current()
-
-  if sys.version_info < (3, 0):
-      next = __next__
-
-  def checkskip(self, string):
-    "Check for a string at the given position; if there, skip it"
-    if not self.checkfor(string):
-      return False
-    self.skip(string)
-    return True
-
-  def error(self, message):
-    "Show an error message and the position identifier."
-    Trace.error(message + ': ' + self.identifier())
+    """A position in a text to parse.
+    Including those in Globable, functions to implement by subclasses are:
+    skip(), identifier(), extract(), isout() and current()."""
+
+    def __init__(self):
+        Globable.__init__(self)
+
+    def skip(self, string):
+        "Skip a string"
+        Trace.error('Unimplemented skip()')
+
+    def identifier(self):
+        "Return an identifier for the current position."
+        Trace.error('Unimplemented identifier()')
+        return 'Error'
+
+    def extract(self, length):
+        "Extract the next string of the given length, or None if not enough text,"
+        "without advancing the parse position."
+        Trace.error('Unimplemented extract()')
+        return None
 
-class TextPosition(Position):
-  "A parse position based on a raw text."
+    def checkfor(self, string):
+        "Check for a string at the given position."
+        return string == self.extract(len(string))
+
+    def checkforlower(self, string):
+        "Check for a string in lower case."
+        extracted = self.extract(len(string))
+        if not extracted:
+            return False
+        return string.lower() == self.extract(len(string)).lower()
+
+    def skipcurrent(self):
+        "Return the current character and skip it."
+        current = self.current()
+        self.skip(current)
+        return current
+
+    def __next__(self):
+        "Advance the position and return the next character."
+        self.skipcurrent()
+        return self.current()
+
+    def checkskip(self, string):
+        "Check for a string at the given position; if there, skip it"
+        if not self.checkfor(string):
+            return False
+        self.skip(string)
+        return True
 
-  def __init__(self, text):
-    "Create the position from elyxer.some text."
-    Position.__init__(self)
-    self.pos = 0
-    self.text = text
-    self.checkbytemark()
-
-  def skip(self, string):
-    "Skip a string of characters."
-    self.pos += len(string)
-
-  def identifier(self):
-    "Return a sample of the remaining text."
-    length = 30
-    if self.pos + length > len(self.text):
-      length = len(self.text) - self.pos
-    return '*' + self.textself.pos:self.pos + length + '*'
-
-  def isout(self):
-    "Find out if we are out of the text yet."
-    return self.pos >= len(self.text)
-
-  def current(self):
-    "Return the current character, assuming we are not out."
-    return self.textself.pos
-
-  def extract(self, length):
-    "Extract the next string of the given length, or None if not enough text."
-    if self.pos + length > len(self.text):
-      return None
-    return self.textself.pos : self.pos + length
-
-class FilePosition(Position):
-  "A parse position based on an underlying file."
-
-  def __init__(self, filename):
-    "Create the position from a file."
-    Position.__init__(self)
-    self.reader = LineReader(filename)
-    self.pos = 0
-    self.checkbytemark()
-
-  def skip(self, string):
-    "Skip a string of characters."
-    length = len(string)
-    while self.pos + length > len(self.reader.currentline()):
-      length -= len(self.reader.currentline()) - self.pos + 1
-      self.nextline()
-    self.pos += length
-
-  def currentline(self):
-    "Get the current line of the underlying file."
-    return self.reader.currentline()
-
-  def nextline(self):
-    "Go to the next line."
-    self.reader.nextline()
-    self.pos = 0
-
-  def linenumber(self):
-    "Return the line number of the file."
-    return self.reader.linenumber + 1
-
-  def identifier(self):
-    "Return the current line and line number in the file."
-    before = self.reader.currentline():self.pos - 1
-    after = self.reader.currentline()self.pos:
-    return 'line ' + unicode(self.getlinenumber()) + ': ' + before + '*' + after
-
-  def isout(self):
-    "Find out if we are out of the text yet."
-    if self.pos > len(self.reader.currentline()):
-      if self.pos > len(self.reader.currentline()) + 1:
-        Trace.error('Out of the line ' + self.reader.currentline() + ': ' + unicode(self.pos))
-      self.nextline()
-    return self.reader.finished()
-
-  def current(self):
-    "Return the current character, assuming we are not out."
-    if self.pos == len(self.reader.currentline()):
-      return '\n'
-    if self.pos > len(self.reader.currentline()):
-      Trace.error('Out of the line ' + self.reader.currentline() + ': ' + unicode(self.pos))
-      return '*'
-    return self.reader.currentline()self.pos
-
-  def extract(self, length):
-    "Extract the next string of the given length, or None if not enough text."
-    if self.pos + length > len(self.reader.currentline()):
-      return None
-    return self.reader.currentline()self.pos : self.pos + length
-
-
-
-class Container(object):
-  "A container for text and objects in a lyx file"
-
-  partkey = None
-  parent = None
-  begin = None
-
-  def __init__(self):
-    self.contents = list()
-
-  def process(self):
-    "Process contents"
-    pass
-
-  def gethtml(self):
-    "Get the resulting HTML"
-    html = self.output.gethtml(self)
-    if isinstance(html, basestring):
-      Trace.error('Raw string ' + html)
-      html = html
-    return self.escapeall(html)
-
-  def escapeall(self, lines):
-    "Escape all lines in an array according to the output options."
-    result = 
-    for line in lines:
-      if Options.html:
-        line = self.escape(line, EscapeConfig.html)
-      if Options.iso885915:
-        line = self.escape(line, EscapeConfig.iso885915)
-        line = self.escapeentities(line)
-      elif not Options.unicode:
-        line = self.escape(line, EscapeConfig.nonunicode)
-      result.append(line)
-    return result
-
-  def escape(self, line, replacements = EscapeConfig.entities):
-    "Escape a line with replacements from elyxer.a map"
-    pieces = sorted(replacements.keys())
-    # do them in order
-    for piece in pieces:
-      if piece in line:
-        line = line.replace(piece, replacementspiece)
-    return line
-
-  def escapeentities(self, line):
-    "Escape all Unicode characters to HTML entities."
-    result = ''
-    pos = TextPosition(line)
-    while not pos.finished():
-      if ord(pos.current()) > 128:
-        codepoint = hex(ord(pos.current()))
-        if codepoint == '0xd835':
-          codepoint = hex(ord(next(pos)) + 0xf800)
-        result += '&#' + codepoint1: + ';'
-      else:
-        result += pos.current()
-      pos.skipcurrent()
-    return result
-
-  def searchall(self, type):
-    "Search for all embedded containers of a given type"
-    list = 
-    self.searchprocess(type, lambda container: list.append(container))
-    return list
-
-  def searchremove(self, type):
-    "Search for all containers of a type and remove them"
-    list = self.searchall(type)
-    for container in list:
-      container.parent.contents.remove(container)
-    return list
-
-  def searchprocess(self, type, process):
-    "Search for elements of a given type and process them"
-    self.locateprocess(lambda container: isinstance(container, type), process)
-
-  def locateprocess(self, locate, process):
-    "Search for all embedded containers and process them"
-    for container in self.contents:
-      container.locateprocess(locate, process)
-      if locate(container):
-        process(container)
-
-  def recursivesearch(self, locate, recursive, process):
-    "Perform a recursive search in the container."
-    for container in self.contents:
-      if recursive(container):
-        container.recursivesearch(locate, recursive, process)
-      if locate(container):
-        process(container)
+    def error(self, message):
+        "Show an error message and the position identifier."
+        Trace.error(message + ': ' + self.identifier())
 
-  def extracttext(self):
-    "Extract all text from elyxer.allowed containers."
-    result = ''
-    constants = ContainerExtractor(ContainerConfig.extracttext).extract(self)
-    for constant in constants:
-      result += constant.string
-    return result
-
-  def group(self, index, group, isingroup):
-    "Group some adjoining elements into a group"
-    if index >= len(self.contents):
-      return
-    if hasattr(self.contentsindex, 'grouped'):
-      return
-    while index < len(self.contents) and isingroup(self.contentsindex):
-      self.contentsindex.grouped = True
-      group.contents.append(self.contentsindex)
-      self.contents.pop(index)
-    self.contents.insert(index, group)
-
-  def remove(self, index):
-    "Remove a container but leave its contents"
-    container = self.contentsindex
-    self.contents.pop(index)
-    while len(container.contents) > 0:
-      self.contents.insert(index, container.contents.pop())
-
-  def tree(self, level = 0):
-    "Show in a tree"
-    Trace.debug("  " * level + unicode(self))
-    for container in self.contents:
-      container.tree(level + 1)
-
-  def getparameter(self, name):
-    "Get the value of a parameter, if present."
-    if not name in self.parameters:
-      return None
-    return self.parametersname
-
-  def getparameterlist(self, name):
-    "Get the value of a comma-separated parameter as a list."
-    paramtext = self.getparameter(name)
-    if not paramtext:
-      return 
-    return paramtext.split(',')
-
-  def hasemptyoutput(self):
-    "Check if the parent's output is empty."
-    current = self.parent
-    while current:
-      if current.output.isempty():
-        return True
-      current = current.parent
-    return False
 
-  def __unicode__(self):
-    "Get a description"
-    if not self.begin:
-      return self.__class__.__name__
-    return self.__class__.__name__ + '@' + unicode(self.begin)
+class TextPosition(Position):
+    "A parse position based on a raw text."
+
+    def __init__(self, text):
+        "Create the position from some text."
+        Position.__init__(self)
+        self.pos = 0
+        self.text = text
+        self.checkbytemark()
+
+    def skip(self, string):
+        "Skip a string of characters."
+        self.pos += len(string)
+
+    def identifier(self):
+        "Return a sample of the remaining text."
+        length = 30
+        if self.pos + length > len(self.text):
+            length = len(self.text) - self.pos
+        return '*' + self.textself.pos:self.pos + length + '*'
+
+    def isout(self):
+        "Find out if we are out of the text yet."
+        return self.pos >= len(self.text)
+
+    def current(self):
+        "Return the current character, assuming we are not out."
+        return self.textself.pos
+
+    def extract(self, length):
+        "Extract the next string of the given length, or None if not enough text."
+        if self.pos + length > len(self.text):
+            return None
+        return self.textself.pos : self.pos + length                 # noqa: E203
+
+
+class Container:
+    "A container for text and objects in a lyx file"
+
+    partkey = None
+    parent = None
+    begin = None
+
+    def __init__(self):
+        self.contents = list()
+
+    def process(self):
+        "Process contents"
+        pass
+
+    def gethtml(self):
+        "Get the resulting HTML"
+        html = self.output.gethtml(self)
+        if isinstance(html, str):
+            Trace.error('Raw string ' + html)
+            html = html
+        return html
+
+    def escape(self, line, replacements=EscapeConfig.entities):
+        "Escape a line with replacements from a map"
+        pieces = sorted(replacements.keys())
+        # do them in order
+        for piece in pieces:
+            if piece in line:
+                line = line.replace(piece, replacementspiece)
+        return line
+
+    def escapeentities(self, line):
+        "Escape all Unicode characters to HTML entities."
+        result = ''
+        pos = TextPosition(line)
+        while not pos.finished():
+            if ord(pos.current()) > 128:
+                codepoint = hex(ord(pos.current()))
+                if codepoint == '0xd835':
+                    codepoint = hex(ord(next(pos)) + 0xf800)
+                result += '&#' + codepoint1: + ';'
+            else:
+                result += pos.current()
+            pos.skipcurrent()
+        return result
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def searchall(self, type):
+        "Search for all embedded containers of a given type"
+        list = 
+        self.searchprocess(type, lambda container: list.append(container))
+        return list
+
+    def searchremove(self, type):
+        "Search for all containers of a type and remove them"
+        list = self.searchall(type)
+        for container in list:
+            container.parent.contents.remove(container)
+        return list
+
+    def searchprocess(self, type, process):
+        "Search for elements of a given type and process them"
+        self.locateprocess(lambda container: isinstance(container, type), process)
+
+    def locateprocess(self, locate, process):
+        "Search for all embedded containers and process them"
+        for container in self.contents:
+            container.locateprocess(locate, process)
+            if locate(container):
+                process(container)
+
+    def recursivesearch(self, locate, recursive, process):
+        "Perform a recursive search in the container."
+        for container in self.contents:
+            if recursive(container):
+                container.recursivesearch(locate, recursive, process)
+            if locate(container):
+                process(container)
+
+    def extracttext(self):
+        "Extract all text from allowed containers."
+        constants = ContainerExtractor(ContainerConfig.extracttext).extract(self)
+        return ''.join(constant.string for constant in constants)
+
+    def group(self, index, group, isingroup):
+        "Group some adjoining elements into a group"
+        if index >= len(self.contents):
+            return
+        if hasattr(self.contentsindex, 'grouped'):
+            return
+        while index < len(self.contents) and isingroup(self.contentsindex):
+            self.contentsindex.grouped = True
+            group.contents.append(self.contentsindex)
+            self.contents.pop(index)
+        self.contents.insert(index, group)
+
+    def remove(self, index):
+        "Remove a container but leave its contents"
+        container = self.contentsindex
+        self.contents.pop(index)
+        while len(container.contents) > 0:
+            self.contents.insert(index, container.contents.pop())
+
+    def tree(self, level=0):
+        "Show in a tree"
+        Trace.debug("  " * level + str(self))
+        for container in self.contents:
+            container.tree(level + 1)
+
+    def getparameter(self, name):
+        "Get the value of a parameter, if present."
+        if name not in self.parameters:
+            return None
+        return self.parametersname
+
+    def getparameterlist(self, name):
+        "Get the value of a comma-separated parameter as a list."
+        paramtext = self.getparameter(name)
+        if not paramtext:
+            return 
+        return paramtext.split(',')
+
+    def hasemptyoutput(self):
+        "Check if the parent's output is empty."
+        current = self.parent
+        while current:
+            if current.output.isempty():
+                return True
+            current = current.parent
+        return False
+
+    def __str__(self):
+        "Get a description"
+        if not self.begin:
+            return self.__class__.__name__
+        return self.__class__.__name__ + '@' + str(self.begin)
 
 
 class BlackBox(Container):
-  "A container that does not output anything"
+    "A container that does not output anything"
 
-  def __init__(self):
-    self.parser = LoneCommand()
-    self.output = EmptyOutput()
-    self.contents = 
-
-class LyXFormat(BlackBox):
-  "Read the lyxformat command"
-
-  def process(self):
-    "Show warning if version < 276"
-    version = int(self.header1)
-    if version < 276:
-      Trace.error('Warning: unsupported old format version ' + str(version))
-    if version > int(GeneralConfig.version'lyxformat'):
-      Trace.error('Warning: unsupported new format version ' + str(version))
+    def __init__(self):
+        self.parser = LoneCommand()
+        self.output = EmptyOutput()
+        self.contents = 
 
-class StringContainer(Container):
-  "A container for a single string"
 
-  parsed = None
+class StringContainer(Container):
+    "A container for a single string"
 
-  def __init__(self):
-    self.parser = StringParser()
-    self.output = StringOutput()
-    self.string = ''
-
-  def process(self):
-    "Replace special chars from elyxer.the contents."
-    if self.parsed:
-      self.string = self.replacespecial(self.parsed)
-      self.parsed = None
-
-  def replacespecial(self, line):
-    "Replace all special chars from elyxer.a line"
-    replaced = self.escape(line, EscapeConfig.entities)
-    replaced = self.changeline(replaced)
-    if ContainerConfig.string'startcommand' in replaced and len(replaced) > 1:
-      # unprocessed commands
-      if self.begin:
-        message = 'Unknown command at ' + unicode(self.begin) + ': '
-      else:
-        message = 'Unknown command: '
-      Trace.error(message + replaced.strip())
-    return replaced
-
-  def changeline(self, line):
-    line = self.escape(line, EscapeConfig.chars)
-    if not ContainerConfig.string'startcommand' in line:
-      return line
-    line = self.escape(line, EscapeConfig.commands)
-    return line
-
-  def extracttext(self):
-    "Return all text."
-    return self.string
-
-  def __unicode__(self):
-    "Return a printable representation."
-    result = 'StringContainer'
-    if self.begin:
-      result += '@' + unicode(self.begin)
-    ellipsis = '...'
-    if len(self.string.strip()) <= 15:
-      ellipsis = ''
-    return result + ' (' + self.string.strip():15 + ellipsis + ')'
+    parsed = None
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def __init__(self):
+        self.parser = StringParser()
+        self.output = StringOutput()
+        self.string = ''
+
+    def process(self):
+        "Replace special chars from the contents."
+        if self.parsed:
+            self.string = self.replacespecial(self.parsed)
+            self.parsed = None
+
+    def replacespecial(self, line):
+        "Replace all special chars from a line"
+        replaced = self.escape(line, EscapeConfig.entities)
+        replaced = self.changeline(replaced)
+        if ContainerConfig.string'startcommand' in replaced and len(replaced) > 1:
+            # unprocessed commands
+            if self.begin:
+                message = 'Unknown command at ' + str(self.begin) + ': '
+            else:
+                message = 'Unknown command: '
+            Trace.error(message + replaced.strip())
+        return replaced
+
+    def changeline(self, line):
+        return self.escape(line, EscapeConfig.chars)
+
+    def extracttext(self):
+        "Return all text."
+        return self.string
+
+    def __str__(self):
+        "Return a printable representation."
+        result = 'StringContainer'
+        if self.begin:
+            result += '@' + str(self.begin)
+        ellipsis = '...'
+        if len(self.string.strip()) <= 15:
+            ellipsis = ''
+        return result + ' (' + self.string.strip():15 + ellipsis + ')'
 
 
 class Constant(StringContainer):
-  "A constant string"
+    "A constant string"
 
-  def __init__(self, text):
-    self.contents = 
-    self.string = text
-    self.output = StringOutput()
-
-  def __unicode__(self):
-    return 'Constant: ' + self.string
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class TaggedText(Container):
-  "Text inside a tag"
-
-  output = None
-
-  def __init__(self):
-    self.parser = TextParser(self)
-    self.output = TaggedOutput()
-
-  def complete(self, contents, tag, breaklines=False):
-    "Complete the tagged text and return it"
-    self.contents = contents
-    self.output.tag = tag
-    self.output.breaklines = breaklines
-    return self
-
-  def constant(self, text, tag, breaklines=False):
-    "Complete the tagged text with a constant"
-    constant = Constant(text)
-    return self.complete(constant, tag, breaklines)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    if not hasattr(self.output, 'tag'):
-      return 'Emtpy tagged text'
-    if not self.output.tag:
-      return 'Tagged <unknown tag>'
-    return 'Tagged <' + self.output.tag + '>'
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class DocumentParameters(object):
-  "Global parameters for the document."
-
-  pdftitle = None
-  indentstandard = False
-  tocdepth = 10
-  startinglevel = 0
-  maxdepth = 10
-  language = None
-  bibliography = None
-  outputchanges = False
-  displaymode = False
+    def __init__(self, text):
+        self.contents = 
+        self.string = text
+        self.output = StringOutput()
 
+    def __str__(self):
+        return 'Constant: ' + self.string
 
 
+class DocumentParameters:
+    "Global parameters for the document."
 
+    displaymode = False
 
 
 class FormulaParser(Parser):
-  "Parses a formula"
+    "Parses a formula"
 
-  def parseheader(self, reader):
-    "See if the formula is inlined"
-    self.begin = reader.linenumber + 1
-    type = self.parsetype(reader)
-    if not type:
-      reader.nextline()
-      type = self.parsetype(reader)
-      if not type:
-        Trace.error('Unknown formula type in ' + reader.currentline().strip())
-        return 'unknown'
-    return type
-
-  def parsetype(self, reader):
-    "Get the formula type from the first line."
-    if reader.currentline().find(FormulaConfig.starts'simple') >= 0:
-      return 'inline'
-    if reader.currentline().find(FormulaConfig.starts'complex') >= 0:
-      return 'block'
-    if reader.currentline().find(FormulaConfig.starts'unnumbered') >= 0:
-      return 'block'
-    if reader.currentline().find(FormulaConfig.starts'beginbefore') >= 0:
-      return 'numbered'
-    return None
-
-  def parse(self, reader):
-    "Parse the formula until the end"
-    formula = self.parseformula(reader)
-    while not reader.currentline().startswith(self.ending):
-      stripped = reader.currentline().strip()
-      if len(stripped) > 0:
-        Trace.error('Unparsed formula line ' + stripped)
-      reader.nextline()
-    reader.nextline()
-    return formula
-
-  def parseformula(self, reader):
-    "Parse the formula contents"
-    simple = FormulaConfig.starts'simple'
-    if simple in reader.currentline():
-      rest = reader.currentline().split(simple, 1)1
-      if simple in rest:
-        # formula is $...$
-        return self.parsesingleliner(reader, simple, simple)
-      # formula is multiline $...$
-      return self.parsemultiliner(reader, simple, simple)
-    if FormulaConfig.starts'complex' in reader.currentline():
-      # formula of the form \...\
-      return self.parsemultiliner(reader, FormulaConfig.starts'complex',
-          FormulaConfig.endings'complex')
-    beginbefore = FormulaConfig.starts'beginbefore'
-    beginafter = FormulaConfig.starts'beginafter'
-    if beginbefore in reader.currentline():
-      if reader.currentline().strip().endswith(beginafter):
-        current = reader.currentline().strip()
-        endsplit = current.split(beginbefore)1.split(beginafter)
-        startpiece = beginbefore + endsplit0 + beginafter
-        endbefore = FormulaConfig.endings'endbefore'
-        endafter = FormulaConfig.endings'endafter'
-        endpiece = endbefore + endsplit0 + endafter
-        return startpiece + self.parsemultiliner(reader, startpiece, endpiece) + endpiece
-      Trace.error('Missing ' + beginafter + ' in ' + reader.currentline())
-      return ''
-    begincommand = FormulaConfig.starts'command'
-    beginbracket = FormulaConfig.starts'bracket'
-    if begincommand in reader.currentline() and beginbracket in reader.currentline():
-      endbracket = FormulaConfig.endings'bracket'
-      return self.parsemultiliner(reader, beginbracket, endbracket)
-    Trace.error('Formula beginning ' + reader.currentline() + ' is unknown')
-    return ''
-
-  def parsesingleliner(self, reader, start, ending):
-    "Parse a formula in one line"
-    line = reader.currentline().strip()
-    if not start in line:
-      Trace.error('Line ' + line + ' does not contain formula start ' + start)
-      return ''
-    if not line.endswith(ending):
-      Trace.error('Formula ' + line + ' does not end with ' + ending)
-      return ''
-    index = line.index(start)
-    rest = lineindex + len(start):-len(ending)
-    reader.nextline()
-    return rest
-
-  def parsemultiliner(self, reader, start, ending):
-    "Parse a formula in multiple lines"
-    formula = ''
-    line = reader.currentline()
-    if not start in line:
-      Trace.error('Line ' + line.strip() + ' does not contain formula start ' + start)
-      return ''
-    index = line.index(start)
-    line = lineindex + len(start):.strip()
-    while not line.endswith(ending):
-      formula += line + '\n'
-      reader.nextline()
-      line = reader.currentline()
-    formula += line:-len(ending)
-    reader.nextline()
-    return formula
-
-class MacroParser(FormulaParser):
-  "A parser for a formula macro."
-
-  def parseheader(self, reader):
-    "See if the formula is inlined"
-    self.begin = reader.linenumber + 1
-    return 'inline'
-
-  def parse(self, reader):
-    "Parse the formula until the end"
-    formula = self.parsemultiliner(reader, self.parent.start, self.ending)
-    reader.nextline()
-    return formula
+    def parseheader(self, reader):
+        "See if the formula is inlined"
+        self.begin = reader.linenumber + 1
+        type = self.parsetype(reader)
+        if not type:
+            reader.nextline()
+            type = self.parsetype(reader)
+            if not type:
+                Trace.error('Unknown formula type in ' + reader.currentline().strip())
+                return 'unknown'
+        return type
+
+    def parsetype(self, reader):
+        "Get the formula type from the first line."
+        if reader.currentline().find(FormulaConfig.starts'simple') >= 0:
+            return 'inline'
+        if reader.currentline().find(FormulaConfig.starts'complex') >= 0:
+            return 'block'
+        if reader.currentline().find(FormulaConfig.starts'unnumbered') >= 0:
+            return 'block'
+        if reader.currentline().find(FormulaConfig.starts'beginbefore') >= 0:
+            return 'numbered'
+        return None
+
+    def parse(self, reader):
+        "Parse the formula until the end"
+        formula = self.parseformula(reader)
+        while not reader.currentline().startswith(self.ending):
+            stripped = reader.currentline().strip()
+            if len(stripped) > 0:
+                Trace.error('Unparsed formula line ' + stripped)
+            reader.nextline()
+        reader.nextline()
+        return formula
+
+    def parseformula(self, reader):
+        "Parse the formula contents"
+        simple = FormulaConfig.starts'simple'
+        if simple in reader.currentline():
+            rest = reader.currentline().split(simple, 1)1
+            if simple in rest:
+                # formula is $...$
+                return self.parsesingleliner(reader, simple, simple)
+            # formula is multiline $...$
+            return self.parsemultiliner(reader, simple, simple)
+        if FormulaConfig.starts'complex' in reader.currentline():
+            # formula of the form \...\
+            return self.parsemultiliner(reader, FormulaConfig.starts'complex',
+                                        FormulaConfig.endings'complex')
+        beginbefore = FormulaConfig.starts'beginbefore'
+        beginafter = FormulaConfig.starts'beginafter'
+        if beginbefore in reader.currentline():
+            if reader.currentline().strip().endswith(beginafter):
+                current = reader.currentline().strip()
+                endsplit = current.split(beginbefore)1.split(beginafter)
+                startpiece = beginbefore + endsplit0 + beginafter
+                endbefore = FormulaConfig.endings'endbefore'
+                endafter = FormulaConfig.endings'endafter'
+                endpiece = endbefore + endsplit0 + endafter
+                return startpiece + self.parsemultiliner(reader, startpiece, endpiece) + endpiece
+            Trace.error('Missing ' + beginafter + ' in ' + reader.currentline())
+            return ''
+        begincommand = FormulaConfig.starts'command'
+        beginbracket = FormulaConfig.starts'bracket'
+        if begincommand in reader.currentline() and beginbracket in reader.currentline():
+            endbracket = FormulaConfig.endings'bracket'
+            return self.parsemultiliner(reader, beginbracket, endbracket)
+        Trace.error('Formula beginning ' + reader.currentline() + ' is unknown')
+        return ''
+
+    def parsesingleliner(self, reader, start, ending):
+        "Parse a formula in one line"
+        line = reader.currentline().strip()
+        if start not in line:
+            Trace.error('Line ' + line + ' does not contain formula start ' + start)
+            return ''
+        if not line.endswith(ending):
+            Trace.error('Formula ' + line + ' does not end with ' + ending)
+            return ''
+        index = line.index(start)
+        rest = lineindex + len(start):-len(ending)
+        reader.nextline()
+        return rest
+
+    def parsemultiliner(self, reader, start, ending):
+        "Parse a formula in multiple lines"
+        formula = ''
+        line = reader.currentline()
+        if start not in line:
+            Trace.error('Line ' + line.strip() + ' does not contain formula start ' + start)
+            return ''
+        index = line.index(start)
+        line = lineindex + len(start):.strip()
+        while not line.endswith(ending):
+            formula += line + '\n'
+            reader.nextline()
+            line = reader.currentline()
+        formula += line:-len(ending)
+        reader.nextline()
+        return formula
 
 
 class FormulaBit(Container):
-  "A bit of a formula"
+    "A bit of a formula"
 
-  type = None
-  size = 1
-  original = ''
-
-  def __init__(self):
-    "The formula bit type can be 'alpha', 'number', 'font'."
-    self.contents = 
-    self.output = ContentsOutput()
-
-  def setfactory(self, factory):
-    "Set the internal formula factory."
-    self.factory = factory
-    return self
-
-  def add(self, bit):
-    "Add any kind of formula bit already processed"
-    self.contents.append(bit)
-    self.original += bit.original
-    bit.parent = self
-
-  def skiporiginal(self, string, pos):
-    "Skip a string and add it to the original formula"
-    self.original += string
-    if not pos.checkskip(string):
-      Trace.error('String ' + string + ' not at ' + pos.identifier())
-
-  def computesize(self):
-    "Compute the size of the bit as the max of the sizes of all contents."
-    if len(self.contents) == 0:
-      return 1
-    self.size = max(element.size for element in self.contents)
-    return self.size
-
-  def clone(self):
-    "Return a copy of itself."
-    return self.factory.parseformula(self.original)
-
-  def __unicode__(self):
-    "Get a string representation"
-    return self.__class__.__name__ + ' read in ' + self.original
+    type = None
+    size = 1
+    original = ''
+
+    def __init__(self):
+        "The formula bit type can be 'alpha', 'number', 'font'."
+        self.contents = 
+        self.output = ContentsOutput()
+
+    def setfactory(self, factory):
+        "Set the internal formula factory."
+        self.factory = factory
+        return self
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def add(self, bit):
+        "Add any kind of formula bit already processed"
+        self.contents.append(bit)
+        self.original += bit.original
+        bit.parent = self
+
+    def skiporiginal(self, string, pos):
+        "Skip a string and add it to the original formula"
+        self.original += string
+        if not pos.checkskip(string):
+            Trace.error('String ' + string + ' not at ' + pos.identifier())
+
+    def computesize(self):
+        "Compute the size of the bit as the max of the sizes of all contents."
+        if len(self.contents) == 0:
+            return 1
+        self.size = max(element.size for element in self.contents)
+        return self.size
+
+    def clone(self):
+        "Return a copy of itself."
+        return self.factory.parseformula(self.original)
+
+    def __str__(self):
+        "Get a string representation"
+        return self.__class__.__name__ + ' read in ' + self.original
 
 
 class TaggedBit(FormulaBit):
-  "A tagged string in a formula"
+    "A tagged string in a formula"
 
-  def constant(self, constant, tag):
-    "Set the constant and the tag"
-    self.output = TaggedOutput().settag(tag)
-    self.add(FormulaConstant(constant))
-    return self
-
-  def complete(self, contents, tag, breaklines = False):
-    "Set the constant and the tag"
-    self.contents = contents
-    self.output = TaggedOutput().settag(tag, breaklines)
-    return self
-
-  def selfcomplete(self, tag):
-    "Set the self-closing tag, no contents (as in <hr/>)."
-    self.output = TaggedOutput().settag(tag, empty = True)
-    return self
+    def constant(self, constant, tag):
+        "Set the constant and the tag"
+        self.output = TaggedOutput().settag(tag)
+        self.add(FormulaConstant(constant))
+        return self
 
-class FormulaConstant(Constant):
-  "A constant string in a formula"
+    def complete(self, contents, tag, breaklines=False):
+        "Set the constant and the tag"
+        self.contents = contents
+        self.output = TaggedOutput().settag(tag, breaklines)
+        return self
 
-  def __init__(self, string):
-    "Set the constant string"
-    Constant.__init__(self, string)
-    self.original = string
-    self.size = 1
-    self.type = None
-
-  def computesize(self):
-    "Compute the size of the constant: always 1."
-    return self.size
-
-  def clone(self):
-    "Return a copy of itself."
-    return FormulaConstant(self.original)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    return 'Formula constant: ' + self.string
+    def selfcomplete(self, tag):
+        "Set the self-closing tag, no contents (as in <hr/>)."
+        self.output = TaggedOutput().settag(tag, empty=True)
+        return self
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+
+class FormulaConstant(Constant):
+    "A constant string in a formula"
+
+    def __init__(self, string):
+        "Set the constant string"
+        Constant.__init__(self, string)
+        self.original = string
+        self.size = 1
+        self.type = None
+
+    def computesize(self):
+        "Compute the size of the constant: always 1."
+        return self.size
+
+    def clone(self):
+        "Return a copy of itself."
+        return FormulaConstant(self.original)
+
+    def __str__(self):
+        "Return a printable representation."
+        return 'Formula constant: ' + self.string
 
 
 class RawText(FormulaBit):
-  "A bit of text inside a formula"
+    "A bit of text inside a formula"
+
+    def detect(self, pos):
+        "Detect a bit of raw text"
+        return pos.current().isalpha()
+
+    def parsebit(self, pos):
+        "Parse alphabetic text"
+        alpha = pos.globalpha()
+        self.add(FormulaConstant(alpha))
+        self.type = 'alpha'
 
-  def detect(self, pos):
-    "Detect a bit of raw text"
-    return pos.current().isalpha()
-
-  def parsebit(self, pos):
-    "Parse alphabetic text"
-    alpha = pos.globalpha()
-    self.add(FormulaConstant(alpha))
-    self.type = 'alpha'
 
 class FormulaSymbol(FormulaBit):
-  "A symbol inside a formula"
+    "A symbol inside a formula"
 
-  modified = FormulaConfig.modified
-  unmodified = FormulaConfig.unmodified'characters'
+    modified = FormulaConfig.modified
+    unmodified = FormulaConfig.unmodified'characters'
+
+    def detect(self, pos):
+        "Detect a symbol"
+        if pos.current() in FormulaSymbol.unmodified:
+            return True
+        if pos.current() in FormulaSymbol.modified:
+            return True
+        return False
+
+    def parsebit(self, pos):
+        "Parse the symbol"
+        if pos.current() in FormulaSymbol.unmodified:
+            self.addsymbol(pos.current(), pos)
+            return
+        if pos.current() in FormulaSymbol.modified:
+            self.addsymbol(FormulaSymbol.modifiedpos.current(), pos)
+            return
+        Trace.error('Symbol ' + pos.current() + ' not found')
+
+    def addsymbol(self, symbol, pos):
+        "Add a symbol"
+        self.skiporiginal(pos.current(), pos)
+        self.contents.append(FormulaConstant(symbol))
 
-  def detect(self, pos):
-    "Detect a symbol"
-    if pos.current() in FormulaSymbol.unmodified:
-      return True
-    if pos.current() in FormulaSymbol.modified:
-      return True
-    return False
-
-  def parsebit(self, pos):
-    "Parse the symbol"
-    if pos.current() in FormulaSymbol.unmodified:
-      self.addsymbol(pos.current(), pos)
-      return
-    if pos.current() in FormulaSymbol.modified:
-      self.addsymbol(FormulaSymbol.modifiedpos.current(), pos)
-      return
-    Trace.error('Symbol ' + pos.current() + ' not found')
-
-  def addsymbol(self, symbol, pos):
-    "Add a symbol"
-    self.skiporiginal(pos.current(), pos)
-    self.contents.append(FormulaConstant(symbol))
 
 class FormulaNumber(FormulaBit):
-  "A string of digits in a formula"
+    "A string of digits in a formula"
+
+    def detect(self, pos):
+        "Detect a digit"
+        return pos.current().isdigit()
+
+    def parsebit(self, pos):
+        "Parse a bunch of digits"
+        digits = pos.glob(lambda: pos.current().isdigit())
+        self.add(FormulaConstant(digits))
+        self.type = 'number'
 
-  def detect(self, pos):
-    "Detect a digit"
-    return pos.current().isdigit()
-
-  def parsebit(self, pos):
-    "Parse a bunch of digits"
-    digits = pos.glob(lambda: pos.current().isdigit())
-    self.add(FormulaConstant(digits))
-    self.type = 'number'
 
 class Comment(FormulaBit):
-  "A LaTeX comment: % to the end of the line."
+    "A LaTeX comment: % to the end of the line."
 
-  start = FormulaConfig.starts'comment'
+    start = FormulaConfig.starts'comment'
 
-  def detect(self, pos):
-    "Detect the %."
-    return pos.current() == self.start
+    def detect(self, pos):
+        "Detect the %."
+        return pos.current() == self.start
 
-  def parsebit(self, pos):
-    "Parse to the end of the line."
-    self.original += pos.globincluding('\n')
+    def parsebit(self, pos):
+        "Parse to the end of the line."
+        self.original += pos.globincluding('\n')
 
-class WhiteSpace(FormulaBit):
-  "Some white space inside a formula."
 
-  def detect(self, pos):
-    "Detect the white space."
-    return pos.current().isspace()
-
-  def parsebit(self, pos):
-    "Parse all whitespace."
-    self.original += pos.skipspace()
-
-  def __unicode__(self):
-    "Return a printable representation."
-    return 'Whitespace: *' + self.original + '*'
+class WhiteSpace(FormulaBit):
+    "Some white space inside a formula."
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def detect(self, pos):
+        "Detect the white space."
+        return pos.current().isspace()
+
+    def parsebit(self, pos):
+        "Parse all whitespace."
+        self.original += pos.skipspace()
+
+    def __str__(self):
+        "Return a printable representation."
+        return 'Whitespace: *' + self.original + '*'
 
 
 class Bracket(FormulaBit):
-  "A {} bracket inside a formula"
+    "A {} bracket inside a formula"
 
-  start = FormulaConfig.starts'bracket'
-  ending = FormulaConfig.endings'bracket'
+    start = FormulaConfig.starts'bracket'
+    ending = FormulaConfig.endings'bracket'
 
-  def __init__(self):
-    "Create a (possibly literal) new bracket"
-    FormulaBit.__init__(self)
-    self.inner = None
-
-  def detect(self, pos):
-    "Detect the start of a bracket"
-    return pos.checkfor(self.start)
-
-  def parsebit(self, pos):
-    "Parse the bracket"
-    self.parsecomplete(pos, self.innerformula)
-    return self
-
-  def parsetext(self, pos):
-    "Parse a text bracket"
-    self.parsecomplete(pos, self.innertext)
-    return self
-
-  def parseliteral(self, pos):
-    "Parse a literal bracket"
-    self.parsecomplete(pos, self.innerliteral)
-    return self
-
-  def parsecomplete(self, pos, innerparser):
-    "Parse the start and end marks"
-    if not pos.checkfor(self.start):
-      Trace.error('Bracket should start with ' + self.start + ' at ' + pos.identifier())
-      return None
-    self.skiporiginal(self.start, pos)
-    pos.pushending(self.ending)
-    innerparser(pos)
-    self.original += pos.popending(self.ending)
-    self.computesize()
-
-  def innerformula(self, pos):
-    "Parse a whole formula inside the bracket"
-    while not pos.finished():
-      self.add(self.factory.parseany(pos))
-
-  def innertext(self, pos):
-    "Parse some text inside the bracket, following textual rules."
-    specialchars = list(FormulaConfig.symbolfunctions.keys())
-    specialchars.append(FormulaConfig.starts'command')
-    specialchars.append(FormulaConfig.starts'bracket')
-    specialchars.append(Comment.start)
-    while not pos.finished():
-      if pos.current() in specialchars:
-        self.add(self.factory.parseany(pos))
-        if pos.checkskip(' '):
-          self.original += ' '
-      else:
-        self.add(FormulaConstant(pos.skipcurrent()))
-
-  def innerliteral(self, pos):
-    "Parse a literal inside the bracket, which does not generate HTML."
-    self.literal = ''
-    while not pos.finished() and not pos.current() == self.ending:
-      if pos.current() == self.start:
-        self.parseliteral(pos)
-      else:
-        self.literal += pos.skipcurrent()
-    self.original += self.literal
+    def __init__(self):
+        "Create a (possibly literal) new bracket"
+        FormulaBit.__init__(self)
+        self.inner = None
+
+    def detect(self, pos):
+        "Detect the start of a bracket"
+        return pos.checkfor(self.start)
+
+    def parsebit(self, pos):
+        "Parse the bracket"
+        self.parsecomplete(pos, self.innerformula)
+        return self
 
-class SquareBracket(Bracket):
-  "A  bracket inside a formula"
+    def parsetext(self, pos):
+        "Parse a text bracket"
+        self.parsecomplete(pos, self.innertext)
+        return self
 
-  start = FormulaConfig.starts'squarebracket'
-  ending = FormulaConfig.endings'squarebracket'
+    def parseliteral(self, pos):
+        "Parse a literal bracket"
+        self.parsecomplete(pos, self.innerliteral)
+        return self
+
+    def parsecomplete(self, pos, innerparser):
+        "Parse the start and end marks"
+        if not pos.checkfor(self.start):
+            Trace.error('Bracket should start with ' + self.start + ' at ' + pos.identifier())
+            return None
+        self.skiporiginal(self.start, pos)
+        pos.pushending(self.ending)
+        innerparser(pos)
+        self.original += pos.popending(self.ending)
+        self.computesize()
+
+    def innerformula(self, pos):
+        "Parse a whole formula inside the bracket"
+        while not pos.finished():
+            self.add(self.factory.parseany(pos))
+
+    def innertext(self, pos):
+        "Parse some text inside the bracket, following textual rules."
+        specialchars = list(FormulaConfig.symbolfunctions.keys())
+        specialchars.append(FormulaConfig.starts'command')
+        specialchars.append(FormulaConfig.starts'bracket')
+        specialchars.append(Comment.start)
+        while not pos.finished():
+            if pos.current() in specialchars:
+                self.add(self.factory.parseany(pos))
+                if pos.checkskip(' '):
+                    self.original += ' '
+            else:
+                self.add(FormulaConstant(pos.skipcurrent()))
+
+    def innerliteral(self, pos):
+        "Parse a literal inside the bracket, which does not generate HTML."
+        self.literal = ''
+        while not pos.finished() and not pos.current() == self.ending:
+            if pos.current() == self.start:
+                self.parseliteral(pos)
+            else:
+                self.literal += pos.skipcurrent()
+        self.original += self.literal
 
-  def clone(self):
-    "Return a new square bracket with the same contents."
-    bracket = SquareBracket()
-    bracket.contents = self.contents
-    return bracket
-
-
-class MathsProcessor(object):
-  "A processor for a maths construction inside the FormulaProcessor."
-
-  def process(self, contents, index):
-    "Process an element inside a formula."
-    Trace.error('Unimplemented process() in ' + unicode(self))
-
-  def __unicode__(self):
-    "Return a printable description."
-    return 'Maths processor ' + self.__class__.__name__
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class FormulaProcessor(object):
-  "A processor specifically for formulas."
-
-  processors = 
-
-  def process(self, bit):
-    "Process the contents of every formula bit, recursively."
-    self.processcontents(bit)
-    self.processinsides(bit)
-    self.traversewhole(bit)
-
-  def processcontents(self, bit):
-    "Process the contents of a formula bit."
-    if not isinstance(bit, FormulaBit):
-      return
-    bit.process()
-    for element in bit.contents:
-      self.processcontents(element)
-
-  def processinsides(self, bit):
-    "Process the insides (limits, brackets) in a formula bit."
-    if not isinstance(bit, FormulaBit):
-      return
-    for index, element in enumerate(bit.contents):
-      for processor in self.processors:
-        processor.process(bit.contents, index)
-      # continue with recursive processing
-      self.processinsides(element)
-
-  def traversewhole(self, formula):
-    "Traverse over the contents to alter variables and space units."
-    last = None
-    for bit, contents in self.traverse(formula):
-      if bit.type == 'alpha':
-        self.italicize(bit, contents)
-      elif bit.type == 'font' and last and last.type == 'number':
-        bit.contents.insert(0, FormulaConstant(u' '))
-      last = bit
-
-  def traverse(self, bit):
-    "Traverse a formula and yield a flattened structure of (bit, list) pairs."
-    for element in bit.contents:
-      if hasattr(element, 'type') and element.type:
-        yield (element, bit.contents)
-      elif isinstance(element, FormulaBit):
-        for pair in self.traverse(element):
-          yield pair
-
-  def italicize(self, bit, contents):
-    "Italicize the given bit of text."
-    index = contents.index(bit)
-    contentsindex = TaggedBit().complete(bit, 'i')
 
+class SquareBracket(Bracket):
+    "A  bracket inside a formula"
 
+    start = FormulaConfig.starts'squarebracket'
+    ending = FormulaConfig.endings'squarebracket'
+
+    def clone(self):
+        "Return a new square bracket with the same contents."
+        bracket = SquareBracket()
+        bracket.contents = self.contents
+        return bracket
+
+
+class MathsProcessor:
+    "A processor for a maths construction inside the FormulaProcessor."
+
+    def process(self, contents, index):
+        "Process an element inside a formula."
+        Trace.error('Unimplemented process() in ' + str(self))
+
+    def __str__(self):
+        "Return a printable description."
+        return 'Maths processor ' + self.__class__.__name__
+
+
+class FormulaProcessor:
+    "A processor specifically for formulas."
+
+    processors = 
+
+    def process(self, bit):
+        "Process the contents of every formula bit, recursively."
+        self.processcontents(bit)
+        self.processinsides(bit)
+        self.traversewhole(bit)
+
+    def processcontents(self, bit):
+        "Process the contents of a formula bit."
+        if not isinstance(bit, FormulaBit):
+            return
+        bit.process()
+        for element in bit.contents:
+            self.processcontents(element)
+
+    def processinsides(self, bit):
+        "Process the insides (limits, brackets) in a formula bit."
+        if not isinstance(bit, FormulaBit):
+            return
+        for index, element in enumerate(bit.contents):
+            for processor in self.processors:
+                processor.process(bit.contents, index)
+            # continue with recursive processing
+            self.processinsides(element)
+
+    def traversewhole(self, formula):
+        "Traverse over the contents to alter variables and space units."
+        last = None
+        for bit, contents in self.traverse(formula):
+            if bit.type == 'alpha':
+                self.italicize(bit, contents)
+            elif bit.type == 'font' and last and last.type == 'number':
+                bit.contents.insert(0, FormulaConstant('\u2009'))
+            last = bit
+
+    def traverse(self, bit):
+        "Traverse a formula and yield a flattened structure of (bit, list) pairs."
+        for element in bit.contents:
+            if hasattr(element, 'type') and element.type:
+                yield element, bit.contents
+            elif isinstance(element, FormulaBit):
+                yield from self.traverse(element)
+
+    def italicize(self, bit, contents):
+        "Italicize the given bit of text."
+        index = contents.index(bit)
+        contentsindex = TaggedBit().complete(bit, 'i')
 
 
 class Formula(Container):
-  "A LaTeX formula"
+    "A LaTeX formula"
 
-  def __init__(self):
-    self.parser = FormulaParser()
-    self.output = TaggedOutput().settag('span class="formula"')
-
-  def process(self):
-    "Convert the formula to tags"
-    if self.header0 == 'inline':
-      DocumentParameters.displaymode = False
-    else:
-      DocumentParameters.displaymode = True
-      self.output.settag('div class="formula"', True)
-    if Options.jsmath:
-      self.jsmath()
-    elif Options.mathjax:
-      self.mathjax()
-    elif Options.googlecharts:
-      self.googlecharts()
-    else:
-      self.classic()
-
-  def jsmath(self):
-    "Make the contents for jsMath."
-    if self.header0 != 'inline':
-      self.output = TaggedOutput().settag('div class="math"')
-    else:
-      self.output = TaggedOutput().settag('span class="math"')
-    self.contents = Constant(self.parsed)
-
-  def mathjax(self):
-    "Make the contents for MathJax."
-    self.output.tag = 'span class="MathJax_Preview"'
-    tag = 'script type="math/tex'
-    if self.header0 != 'inline':
-      tag += ';mode=display'
-    self.contents = TaggedText().constant(self.parsed, tag + '"', True)
-
-  def googlecharts(self):
-    "Make the contents using Google Charts http://code.google.com/apis/chart/."
-    url = FormulaConfig.urls'googlecharts' + quote_plus(self.parsed)
-    img = '<img class="chart" src="' + url + '" alt="' + self.parsed + '"/>'
-    self.contents = Constant(img)
-
-  def classic(self):
-    "Make the contents using classic output generation with XHTML and CSS."
-    whole = FormulaFactory().parseformula(self.parsed)
-    FormulaProcessor().process(whole)
-    whole.parent = self
-    self.contents = whole
+    def __init__(self):
+        self.parser = FormulaParser()
+        self.output = TaggedOutput().settag('span class="formula"')
+
+    def process(self):
+        "Convert the formula to tags"
+        if self.header0 == 'inline':
+            DocumentParameters.displaymode = False
+        else:
+            DocumentParameters.displaymode = True
+            self.output.settag('div class="formula"', True)
+        self.classic()
+
+    def classic(self):
+        "Make the contents using classic output generation with XHTML and CSS."
+        whole = FormulaFactory().parseformula(self.parsed)
+        FormulaProcessor().process(whole)
+        whole.parent = self
+        self.contents = whole
+
+    def parse(self, pos):
+        "Parse using a parse position instead of self.parser."
+        if pos.checkskip('$$'):
+            self.parsedollarblock(pos)
+        elif pos.checkskip('$'):
+            self.parsedollarinline(pos)
+        elif pos.checkskip('\$'):
+            self.parseinlineto(pos, '\$')
+        elif pos.checkskip('\\'):
+            self.parseblockto(pos, '\\')
+        else:
+            pos.error('Unparseable formula')
+        self.process()
+        return self
 
-  def parse(self, pos):
-    "Parse using a parse position instead of self.parser."
-    if pos.checkskip('$$'):
-      self.parsedollarblock(pos)
-    elif pos.checkskip('$'):
-      self.parsedollarinline(pos)
-    elif pos.checkskip('\$'):
-      self.parseinlineto(pos, '\$')
-    elif pos.checkskip('\\'):
-      self.parseblockto(pos, '\\')
-    else:
-      pos.error('Unparseable formula')
-    self.process()
-    return self
-
-  def parsedollarinline(self, pos):
-    "Parse a $...$ formula."
-    self.header = 'inline'
-    self.parsedollar(pos)
-
-  def parsedollarblock(self, pos):
-    "Parse a $$...$$ formula."
-    self.header = 'block'
-    self.parsedollar(pos)
-    if not pos.checkskip('$'):
-      pos.error('Formula should be $$...$$, but last $ is missing.')
-
-  def parsedollar(self, pos):
-    "Parse to the next $."
-    pos.pushending('$')
-    self.parsed = pos.globexcluding('$')
-    pos.popending('$')
-
-  def parseinlineto(self, pos, limit):
-    "Parse a \$...\$ formula."
-    self.header = 'inline'
-    self.parseupto(pos, limit)
-
-  def parseblockto(self, pos, limit):
-    "Parse a \\...\\ formula."
-    self.header = 'block'
-    self.parseupto(pos, limit)
-
-  def parseupto(self, pos, limit):
-    "Parse a formula that ends with the given command."
-    pos.pushending(limit)
-    self.parsed = pos.glob(lambda: True)
-    pos.popending(limit)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    if self.partkey and self.partkey.number:
-      return 'Formula (' + self.partkey.number + ')'
-    return 'Unnumbered formula'
+    def parsedollarinline(self, pos):
+        "Parse a $...$ formula."
+        self.header = 'inline'
+        self.parsedollar(pos)
+
+    def parsedollarblock(self, pos):
+        "Parse a $$...$$ formula."
+        self.header = 'block'
+        self.parsedollar(pos)
+        if not pos.checkskip('$'):
+            pos.error('Formula should be $$...$$, but last $ is missing.')
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def parsedollar(self, pos):
+        "Parse to the next $."
+        pos.pushending('$')
+        self.parsed = pos.globexcluding('$')
+        pos.popending('$')
+
+    def parseinlineto(self, pos, limit):
+        "Parse a \$...\$ formula."
+        self.header = 'inline'
+        self.parseupto(pos, limit)
+
+    def parseblockto(self, pos, limit):
+        "Parse a \\...\\ formula."
+        self.header = 'block'
+        self.parseupto(pos, limit)
+
+    def parseupto(self, pos, limit):
+        "Parse a formula that ends with the given command."
+        pos.pushending(limit)
+        self.parsed = pos.glob(lambda: True)
+        pos.popending(limit)
+
+    def __str__(self):
+        "Return a printable representation."
+        if self.partkey and self.partkey.number:
+            return 'Formula (' + self.partkey.number + ')'
+        return 'Unnumbered formula'
 
 
 class WholeFormula(FormulaBit):
-  "Parse a whole formula"
+    "Parse a whole formula"
 
-  def detect(self, pos):
-    "Not outside the formula is enough."
-    return not pos.finished()
-
-  def parsebit(self, pos):
-    "Parse with any formula bit"
-    while not pos.finished():
-      self.add(self.factory.parseany(pos))
-
-class FormulaFactory(object):
-  "Construct bits of formula"
-
-  # bit types will be appended later
-  types = FormulaSymbol, RawText, FormulaNumber, Bracket, Comment, WhiteSpace
-  skippedtypes = Comment, WhiteSpace
-  defining = False
-
-  def __init__(self):
-    "Initialize the map of instances."
-    self.instances = dict()
-
-  def detecttype(self, type, pos):
-    "Detect a bit of a given type."
-    if pos.finished():
-      return False
-    return self.instance(type).detect(pos)
-
-  def instance(self, type):
-    "Get an instance of the given type."
-    if not type in self.instances or not self.instancestype:
-      self.instancestype = self.create(type)
-    return self.instancestype
-
-  def create(self, type):
-    "Create a new formula bit of the given type."
-    return Cloner.create(type).setfactory(self)
-
-  def clearskipped(self, pos):
-    "Clear any skipped types."
-    while not pos.finished():
-      if not self.skipany(pos):
+    def detect(self, pos):
+        "Not outside the formula is enough."
+        return not pos.finished()
+
+    def parsebit(self, pos):
+        "Parse with any formula bit"
+        while not pos.finished():
+            self.add(self.factory.parseany(pos))
+
+
+class FormulaFactory:
+    "Construct bits of formula"
+
+    # bit types will be appended later
+    types = FormulaSymbol, RawText, FormulaNumber, Bracket, Comment, WhiteSpace
+    skippedtypes = Comment, WhiteSpace
+    defining = False
+
+    def __init__(self):
+        "Initialize the map of instances."
+        self.instances = {}
+
+    def detecttype(self, type, pos):
+        "Detect a bit of a given type."
+        if pos.finished():
+            return False
+        return self.instance(type).detect(pos)
+
+    def instance(self, type):
+        "Get an instance of the given type."
+        if type not in self.instances or not self.instancestype:
+            self.instancestype = self.create(type)
+        return self.instancestype
+
+    def create(self, type):
+        "Create a new formula bit of the given type."
+        return Cloner.create(type).setfactory(self)
+
+    def clearskipped(self, pos):
+        "Clear any skipped types."
+        while not pos.finished():
+            if not self.skipany(pos):
+                return
         return
-    return
-
-  def skipany(self, pos):
-    "Skip any skipped types."
-    for type in self.skippedtypes:
-      if self.instance(type).detect(pos):
-        return self.parsetype(type, pos)
-    return None
-
-  def parseany(self, pos):
-    "Parse any formula bit at the current location."
-    for type in self.types + self.skippedtypes:
-      if self.detecttype(type, pos):
-        return self.parsetype(type, pos)
-    Trace.error('Unrecognized formula at ' + pos.identifier())
-    return FormulaConstant(pos.skipcurrent())
-
-  def parsetype(self, type, pos):
-    "Parse the given type and return it."
-    bit = self.instance(type)
-    self.instancestype = None
-    returnedbit = bit.parsebit(pos)
-    if returnedbit:
-      return returnedbit.setfactory(self)
-    return bit
-
-  def parseformula(self, formula):
-    "Parse a string of text that contains a whole formula."
-    pos = TextPosition(formula)
-    whole = self.create(WholeFormula)
-    if whole.detect(pos):
-      whole.parsebit(pos)
-      return whole
-    # no formula found
-    if not pos.finished():
-      Trace.error('Unknown formula at: ' + pos.identifier())
-      whole.add(TaggedBit().constant(formula, 'span class="unknown"'))
-    return whole
-
-
-class Translator(object):
-  "Reads the configuration file and tries to find a translation."
-  "Otherwise falls back to the messages in the config file."
-
-  instance = None
-
-  def translate(cls, key):
-    "Get the translated message for a key."
-    return cls.instance.getmessage(key)
-
-  translate = classmethod(translate)
-
-  def __init__(self):
-    self.translation = None
-    self.first = True
-
-  def findtranslation(self):
-    "Find the translation for the document language."
-    self.langcodes = None
-    if not DocumentParameters.language:
-      Trace.error('No language in document')
-      return
-    if not DocumentParameters.language in TranslationConfig.languages:
-      Trace.error('Unknown language ' + DocumentParameters.language)
-      return
-    if TranslationConfig.languagesDocumentParameters.language == 'en':
-      return
-    langcodes = TranslationConfig.languagesDocumentParameters.language
-    try:
-      self.translation = gettext.translation('elyxer', None, langcodes)
-    except IOError:
-      Trace.error('No translation for ' + unicode(langcodes))
-
-  def getmessage(self, key):
-    "Get the translated message for the given key."
-    if self.first:
-      self.findtranslation()
-      self.first = False
-    message = self.getuntranslated(key)
-    if not self.translation:
-      return message
-    try:
-      message = self.translation.ugettext(message)
-    except IOError:
-      pass
-    return message
-
-  def getuntranslated(self, key):
-    "Get the untranslated message."
-    if not key in TranslationConfig.constants:
-      Trace.error('Cannot translate ' + key)
-      return key
-    return TranslationConfig.constantskey
-
-Translator.instance = Translator()
-
-
-
-class NumberCounter(object):
-  "A counter for numbers (by default)."
-  "The type can be changed to return letters, roman numbers..."
-
-  name = None
-  value = None
-  mode = None
-  master = None
-
-  letters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  symbols = NumberingConfig.sequence'symbols'
-  romannumerals = 
-      ('M', 1000), ('CM', 900), ('D', 500), ('CD', 400), ('C', 100),
-      ('XC', 90), ('L', 50), ('XL', 40), ('X', 10), ('IX', 9), ('V', 5),
-      ('IV', 4), ('I', 1)
-      
-
-  def __init__(self, name):
-    "Give a name to the counter."
-    self.name = name
-
-  def setmode(self, mode):
-    "Set the counter mode. Can be changed at runtime."
-    self.mode = mode
-    return self
-
-  def init(self, value):
-    "Set an initial value."
-    self.value = value
-
-  def gettext(self):
-    "Get the next value as a text string."
-    return unicode(self.value)
-
-  def getletter(self):
-    "Get the next value as a letter."
-    return self.getsequence(self.letters)
-
-  def getsymbol(self):
-    "Get the next value as a symbol."
-    return self.getsequence(self.symbols)
-
-  def getsequence(self, sequence):
-    "Get the next value from elyxer.a sequence."
-    return sequence(self.value - 1) % len(sequence)
-
-  def getroman(self):
-    "Get the next value as a roman number."
-    result = ''
-    number = self.value
-    for numeral, value in self.romannumerals:
-      if number >= value:
-        result += numeral * (number / value)
-        number = number % value
-    return result
-
-  def getvalue(self):
-    "Get the current value as configured in the current mode."
-    if not self.mode or self.mode in 'text', '1':
-      return self.gettext()
-    if self.mode == 'A':
-      return self.getletter()
-    if self.mode == 'a':
-      return self.getletter().lower()
-    if self.mode == 'I':
-      return self.getroman()
-    if self.mode == '*':
-      return self.getsymbol()
-    Trace.error('Unknown counter mode ' + self.mode)
-    return self.gettext()
-
-  def getnext(self):
-    "Increase the current value and get the next value as configured."
-    if not self.value:
-      self.value = 0
-    self.value += 1
-    return self.getvalue()
-
-  def reset(self):
-    "Reset the counter."
-    self.value = 0
-
-  def __unicode__(self):
-    "Return a printable representation."
-    result = 'Counter ' + self.name
-    if self.mode:
-      result += ' in mode ' + self.mode
-    return result
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class DependentCounter(NumberCounter):
-  "A counter which depends on another one (the master)."
-
-  def setmaster(self, master):
-    "Set the master counter."
-    self.master = master
-    self.last = self.master.getvalue()
-    return self
-
-  def getnext(self):
-    "Increase or, if the master counter has changed, restart."
-    if self.last != self.master.getvalue():
-      self.reset()
-    value = NumberCounter.getnext(self)
-    self.last = self.master.getvalue()
-    return value
-
-  def getvalue(self):
-    "Get the value of the combined counter: master.dependent."
-    return self.master.getvalue() + '.' + NumberCounter.getvalue(self)
-
-class NumberGenerator(object):
-  "A number generator for unique sequences and hierarchical structures. Used in:"
-  "  * ordered part numbers: Chapter 3, Section 5.3."
-  "  * unique part numbers: Footnote 15, Bibliography cite 15."
-  "  * chaptered part numbers: Figure 3.15, Equation (8.3)."
-  "  * unique roman part numbers: Part I, Book IV."
-
-  chaptered = None
-  generator = None
-
-  romanlayouts = x.lower() for x in NumberingConfig.layouts'roman'
-  orderedlayouts = x.lower() for x in NumberingConfig.layouts'ordered'
-
-  counters = dict()
-  appendix = None
-
-  def deasterisk(self, type):
-    "Remove the possible asterisk in a layout type."
-    return type.replace('*', '')
-
-  def isunique(self, type):
-    "Find out if the layout type corresponds to a unique part."
-    return self.isroman(type)
-
-  def isroman(self, type):
-    "Find out if the layout type should have roman numeration."
-    return self.deasterisk(type).lower() in self.romanlayouts
-
-  def isinordered(self, type):
-    "Find out if the layout type corresponds to an (un)ordered part."
-    return self.deasterisk(type).lower() in self.orderedlayouts
-
-  def isnumbered(self, type):
-    "Find out if the type for a layout corresponds to a numbered layout."
-    if '*' in type:
-      return False
-    if self.isroman(type):
-      return True
-    if not self.isinordered(type):
-      return False
-    if self.getlevel(type) > DocumentParameters.maxdepth:
-      return False
-    return True
-
-  def isunordered(self, type):
-    "Find out if the type contains an asterisk, basically."
-    return '*' in type
-
-  def getlevel(self, type):
-    "Get the level that corresponds to a layout type."
-    if self.isunique(type):
-      return 0
-    if not self.isinordered(type):
-      Trace.error('Unknown layout type ' + type)
-      return 0
-    type = self.deasterisk(type).lower()
-    level = self.orderedlayouts.index(type) + 1
-    return level - DocumentParameters.startinglevel
-
-  def getparttype(self, type):
-    "Obtain the type for the part: without the asterisk, "
-    "and switched to Appendix if necessary."
-    if NumberGenerator.appendix and self.getlevel(type) == 1:
-      return 'Appendix'
-    return self.deasterisk(type)
-
-  def generate(self, type):
-    "Generate a number for a layout type."
-    "Unique part types such as Part or Book generate roman numbers: Part I."
-    "Ordered part types return dot-separated tuples: Chapter 5, Subsection 2.3.5."
-    "Everything else generates unique numbers: Bibliography 1."
-    "Each invocation results in a new number."
-    return self.getcounter(type).getnext()
-
-  def getcounter(self, type):
-    "Get the counter for the given type."
-    type = type.lower()
-    if not type in self.counters:
-      self.counterstype = self.create(type)
-    return self.counterstype
-
-  def create(self, type):
-    "Create a counter for the given type."
-    if self.isnumbered(type) and self.getlevel(type) > 1:
-      index = self.orderedlayouts.index(type)
-      above = self.orderedlayoutsindex - 1
-      master = self.getcounter(above)
-      return self.createdependent(type, master)
-    counter = NumberCounter(type)
-    if self.isroman(type):
-      counter.setmode('I')
-    return counter
-
-  def getdependentcounter(self, type, master):
-    "Get (or create) a counter of the given type that depends on another."
-    if not type in self.counters or not self.counterstype.master:
-      self.counterstype = self.createdependent(type, master)
-    return self.counterstype
-
-  def createdependent(self, type, master):
-    "Create a dependent counter given the master."
-    return DependentCounter(type).setmaster(master)
-
-  def startappendix(self):
-    "Start appendices here."
-    firsttype = self.orderedlayoutsDocumentParameters.startinglevel
-    counter = self.getcounter(firsttype)
-    counter.setmode('A').reset()
-    NumberGenerator.appendix = True
-
-class ChapteredGenerator(NumberGenerator):
-  "Generate chaptered numbers, as in Chapter.Number."
-  "Used in equations, figures: Equation (5.3), figure 8.15."
-
-  def generate(self, type):
-    "Generate a number which goes with first-level numbers (chapters). "
-    "For the article classes a unique number is generated."
-    if DocumentParameters.startinglevel > 0:
-      return NumberGenerator.generator.generate(type)
-    chapter = self.getcounter('Chapter')
-    return self.getdependentcounter(type, chapter).getnext()
-
-
-NumberGenerator.chaptered = ChapteredGenerator()
-NumberGenerator.generator = NumberGenerator()
-
-
-
-
-
-
-class ContainerSize(object):
-  "The size of a container."
-
-  width = None
-  height = None
-  maxwidth = None
-  maxheight = None
-  scale = None
-
-  def set(self, width = None, height = None):
-    "Set the proper size with width and height."
-    self.setvalue('width', width)
-    self.setvalue('height', height)
-    return self
-
-  def setmax(self, maxwidth = None, maxheight = None):
-    "Set max width and/or height."
-    self.setvalue('maxwidth', maxwidth)
-    self.setvalue('maxheight', maxheight)
-    return self
-
-  def readparameters(self, container):
-    "Read some size parameters off a container."
-    self.setparameter(container, 'width')
-    self.setparameter(container, 'height')
-    self.setparameter(container, 'scale')
-    self.checkvalidheight(container)
-    return self
-
-  def setparameter(self, container, name):
-    "Read a size parameter off a container, and set it if present."
-    value = container.getparameter(name)
-    self.setvalue(name, value)
-
-  def setvalue(self, name, value):
-    "Set the value of a parameter name, only if it's valid."
-    value = self.processparameter(value)
-    if value:
-      setattr(self, name, value)
-
-  def checkvalidheight(self, container):
-    "Check if the height parameter is valid; otherwise erase it."
-    heightspecial = container.getparameter('height_special')
-    if self.height and self.extractnumber(self.height) == '1' and heightspecial == 'totalheight':
-      self.height = None
-
-  def processparameter(self, value):
-    "Do the full processing on a parameter."
-    if not value:
-      return None
-    if self.extractnumber(value) == '0':
-      return None
-    for ignored in StyleConfig.size'ignoredtexts':
-      if ignored in value:
-        value = value.replace(ignored, '')
-    return value
-
-  def extractnumber(self, text):
-    "Extract the first number in the given text."
-    result = ''
-    decimal = False
-    for char in text:
-      if char.isdigit():
-        result += char
-      elif char == '.' and not decimal:
-        result += char
-        decimal = True
-      else:
-        return result
-    return result
 
-  def checkimage(self, width, height):
-    "Check image dimensions, set them if possible."
-    if width:
-      self.maxwidth = unicode(width) + 'px'
-      if self.scale and not self.width:
-        self.width = self.scalevalue(width)
-    if height:
-      self.maxheight = unicode(height) + 'px'
-      if self.scale and not self.height:
-        self.height = self.scalevalue(height)
-    if self.width and not self.height:
-      self.height = 'auto'
-    if self.height and not self.width:
-      self.width = 'auto'
-
-  def scalevalue(self, value):
-    "Scale the value according to the image scale and return it as unicode."
-    scaled = value * int(self.scale) / 100
-    return unicode(int(scaled)) + 'px'
-
-  def removepercentwidth(self):
-    "Remove percent width if present, to set it at the figure level."
-    if not self.width:
-      return None
-    if not '%' in self.width:
-      return None
-    width = self.width
-    self.width = None
-    if self.height == 'auto':
-      self.height = None
-    return width
-
-  def addstyle(self, container):
-    "Add the proper style attribute to the output tag."
-    if not isinstance(container.output, TaggedOutput):
-      Trace.error('No tag to add style, in ' + unicode(container))
-    if not self.width and not self.height and not self.maxwidth and not self.maxheight:
-      # nothing to see here; move along
-      return
-    tag = ' style="'
-    tag += self.styleparameter('width')
-    tag += self.styleparameter('maxwidth')
-    tag += self.styleparameter('height')
-    tag += self.styleparameter('maxheight')
-    if tag-1 == ' ':
-      tag = tag:-1
-    tag += '"'
-    container.output.tag += tag
-
-  def styleparameter(self, name):
-    "Get the style for a single parameter."
-    value = getattr(self, name)
-    if value:
-      return name.replace('max', 'max-') + ': ' + value + '; '
-    return ''
-
-
-
-class QuoteContainer(Container):
-  "A container for a pretty quote"
-
-  def __init__(self):
-    self.parser = BoundedParser()
-    self.output = FixedOutput()
-
-  def process(self):
-    "Process contents"
-    self.type = self.header2
-    if not self.type in StyleConfig.quotes:
-      Trace.error('Quote type ' + self.type + ' not found')
-      self.html = '"'
-      return
-    self.html = StyleConfig.quotesself.type
-
-class LyXLine(Container):
-  "A Lyx line"
-
-  def __init__(self):
-    self.parser = LoneCommand()
-    self.output = FixedOutput()
-
-  def process(self):
-    self.html = '<hr class="line" />'
-
-class EmphaticText(TaggedText):
-  "Text with emphatic mode"
-
-  def process(self):
-    self.output.tag = 'i'
-
-class ShapedText(TaggedText):
-  "Text shaped (italic, slanted)"
-
-  def process(self):
-    self.type = self.header1
-    if not self.type in TagConfig.shaped:
-      Trace.error('Unrecognized shape ' + self.header1)
-      self.output.tag = 'span'
-      return
-    self.output.tag = TagConfig.shapedself.type
-
-class VersalitasText(TaggedText):
-  "Text in versalitas"
-
-  def process(self):
-    self.output.tag = 'span class="versalitas"'
-
-class ColorText(TaggedText):
-  "Colored text"
-
-  def process(self):
-    self.color = self.header1
-    self.output.tag = 'span class="' + self.color + '"'
-
-class SizeText(TaggedText):
-  "Sized text"
-
-  def process(self):
-    self.size = self.header1
-    self.output.tag = 'span class="' + self.size + '"'
-
-class BoldText(TaggedText):
-  "Bold text"
-
-  def process(self):
-    self.output.tag = 'b'
-
-class TextFamily(TaggedText):
-  "A bit of text from elyxer.a different family"
-
-  def process(self):
-    "Parse the type of family"
-    self.type = self.header1
-    if not self.type in TagConfig.family:
-      Trace.error('Unrecognized family ' + type)
-      self.output.tag = 'span'
-      return
-    self.output.tag = TagConfig.familyself.type
-
-class Hfill(TaggedText):
-  "Horizontall fill"
-
-  def process(self):
-    self.output.tag = 'span class="hfill"'
-
-class BarredText(TaggedText):
-  "Text with a bar somewhere"
-
-  def process(self):
-    "Parse the type of bar"
-    self.type = self.header1
-    if not self.type in TagConfig.barred:
-      Trace.error('Unknown bar type ' + self.type)
-      self.output.tag = 'span'
-      return
-    self.output.tag = TagConfig.barredself.type
-
-class LangLine(TaggedText):
-  "A line with language information"
-
-  def process(self):
-    "Only generate a span with lang info when the language is recognized."
-    lang = self.header1
-    if not lang in TranslationConfig.languages:
-      self.output = ContentsOutput()
-      return
-    isolang = TranslationConfig.languageslang
-    self.output = TaggedOutput().settag('span lang="' + isolang + '"', False)
-
-class InsetLength(BlackBox):
-  "A length measure inside an inset."
-
-  def process(self):
-    self.length = self.header1
-
-class Space(Container):
-  "A space of several types"
-
-  def __init__(self):
-    self.parser = InsetParser()
-    self.output = FixedOutput()
-
-  def process(self):
-    self.type = self.header2
-    if self.type not in StyleConfig.hspaces:
-      Trace.error('Unknown space type ' + self.type)
-      self.html = ' '
-      return
-    self.html = StyleConfig.hspacesself.type
-    length = self.getlength()
-    if not length:
-      return
-    self.output = TaggedOutput().settag('span class="hspace"', False)
-    ContainerSize().set(length).addstyle(self)
-
-  def getlength(self):
-    "Get the space length from elyxer.the contents or parameters."
-    if len(self.contents) == 0 or not isinstance(self.contents0, InsetLength):
-      return None
-    return self.contents0.length
-
-class VerticalSpace(Container):
-  "An inset that contains a vertical space."
-
-  def __init__(self):
-    self.parser = InsetParser()
-    self.output = FixedOutput()
-
-  def process(self):
-    "Set the correct tag"
-    self.type = self.header2
-    if self.type not in StyleConfig.vspaces:
-      self.output = TaggedOutput().settag('div class="vspace" style="height: ' + self.type + ';"', True)
-      return
-    self.html = StyleConfig.vspacesself.type
-
-class Align(Container):
-  "Bit of aligned text"
-
-  def __init__(self):
-    self.parser = ExcludingParser()
-    self.output = TaggedOutput().setbreaklines(True)
-
-  def process(self):
-    self.output.tag = 'div class="' + self.header1 + '"'
-
-class Newline(Container):
-  "A newline"
-
-  def __init__(self):
-    self.parser = LoneCommand()
-    self.output = FixedOutput()
-
-  def process(self):
-    "Process contents"
-    self.html = '<br/>\n'
-
-class NewPage(Newline):
-  "A new page"
-
-  def process(self):
-    "Process contents"
-    self.html = '<p><br/>\n</p>\n'
-
-class Separator(Container):
-  "A separator string which is not extracted by extracttext()."
-
-  def __init__(self, constant):
-    self.output = FixedOutput()
-    self.contents = 
-    self.html = constant
-
-class StrikeOut(TaggedText):
-  "Striken out text."
-
-  def process(self):
-    "Set the output tag to strike."
-    self.output.tag = 'strike'
-
-class StartAppendix(BlackBox):
-  "Mark to start an appendix here."
-  "From this point on, all chapters become appendices."
-
-  def process(self):
-    "Activate the special numbering scheme for appendices, using letters."
-    NumberGenerator.generator.startappendix()
-
-
-
-
-
-
-class Link(Container):
-  "A link to another part of the document"
-
-  anchor = None
-  url = None
-  type = None
-  page = None
-  target = None
-  destination = None
-  title = None
-
-  def __init__(self):
-    "Initialize the link, add target if configured."
-    self.contents = 
-    self.parser = InsetParser()
-    self.output = LinkOutput()
-    if Options.target:
-      self.target = Options.target
-
-  def complete(self, text, anchor = None, url = None, type = None, title = None):
-    "Complete the link."
-    self.contents = Constant(text)
-    if anchor:
-      self.anchor = anchor
-    if url:
-      self.url = url
-    if type:
-      self.type = type
-    if title:
-      self.title = title
-    return self
-
-  def computedestination(self):
-    "Use the destination link to fill in the destination URL."
-    if not self.destination:
-      return
-    self.url = ''
-    if self.destination.anchor:
-      self.url = '#' + self.destination.anchor
-    if self.destination.page:
-      self.url = self.destination.page + self.url
-
-  def setmutualdestination(self, destination):
-    "Set another link as destination, and set its destination to this one."
-    self.destination = destination
-    destination.destination = self
-
-  def __unicode__(self):
-    "Return a printable representation."
-    result = 'Link'
-    if self.anchor:
-      result += ' #' + self.anchor
-    if self.url:
-      result += ' to ' + self.url
-    return result
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class URL(Link):
-  "A clickable URL"
-
-  def process(self):
-    "Read URL from elyxer.parameters"
-    target = self.escape(self.getparameter('target'))
-    self.url = target
-    type = self.getparameter('type')
-    if type:
-      self.url = self.escape(type) + target
-    name = self.getparameter('name')
-    if not name:
-      name = target
-    self.contents = Constant(name)
-
-class FlexURL(URL):
-  "A flexible URL"
-
-  def process(self):
-    "Read URL from elyxer.contents"
-    self.url = self.extracttext()
-
-class LinkOutput(ContainerOutput):
-  "A link pointing to some destination"
-  "Or an anchor (destination)"
-
-  def gethtml(self, link):
-    "Get the HTML code for the link"
-    type = link.__class__.__name__
-    if link.type:
-      type = link.type
-    tag = 'a class="' + type + '"'
-    if link.anchor:
-      tag += ' name="' + link.anchor + '"'
-    if link.destination:
-      link.computedestination()
-    if link.url:
-      tag += ' href="' + link.url + '"'
-    if link.target:
-      tag += ' target="' + link.target + '"'
-    if link.title:
-      tag += ' title="' + link.title + '"'
-    return TaggedOutput().settag(tag).gethtml(link)
-
-
-
-
-
-class Postprocessor(object):
-  "Postprocess a container keeping some context"
-
-  stages = 
-
-  def __init__(self):
-    self.stages = StageDict(Postprocessor.stages, self)
-    self.current = None
-    self.last = None
-
-  def postprocess(self, next):
-    "Postprocess a container and its contents."
-    self.postrecursive(self.current)
-    result = self.postcurrent(next)
-    self.last = self.current
-    self.current = next
-    return result
-
-  def postrecursive(self, container):
-    "Postprocess the container contents recursively"
-    if not hasattr(container, 'contents'):
-      return
-    if len(container.contents) == 0:
-      return
-    if hasattr(container, 'postprocess'):
-      if not container.postprocess:
-        return
-    postprocessor = Postprocessor()
-    contents = 
-    for element in container.contents:
-      post = postprocessor.postprocess(element)
-      if post:
-        contents.append(post)
-    # two rounds to empty the pipeline
-    for i in range(2):
-      post = postprocessor.postprocess(None)
-      if post:
-        contents.append(post)
-    container.contents = contents
-
-  def postcurrent(self, next):
-    "Postprocess the current element taking into account next and last."
-    stage = self.stages.getstage(self.current)
-    if not stage:
-      return self.current
-    return stage.postprocess(self.last, self.current, next)
-
-class StageDict(object):
-  "A dictionary of stages corresponding to classes"
-
-  def __init__(self, classes, postprocessor):
-    "Instantiate an element from elyxer.each class and store as a dictionary"
-    instances = self.instantiate(classes, postprocessor)
-    self.stagedict = dict((x.processedclass, x) for x in instances)
-
-  def instantiate(self, classes, postprocessor):
-    "Instantiate an element from elyxer.each class"
-    stages = x.__new__(x) for x in classes
-    for element in stages:
-      element.__init__()
-      element.postprocessor = postprocessor
-    return stages
-
-  def getstage(self, element):
-    "Get the stage for a given element, if the type is in the dict"
-    if not element.__class__ in self.stagedict:
-      return None
-    return self.stagedictelement.__class__
-
-
-
-class Label(Link):
-  "A label to be referenced"
-
-  names = dict()
-  lastlayout = None
-
-  def __init__(self):
-    Link.__init__(self)
-    self.lastnumbered = None
-
-  def process(self):
-    "Process a label container."
-    key = self.getparameter('name')
-    self.create(' ', key)
-    self.lastnumbered = Label.lastlayout
-
-  def create(self, text, key, type = 'Label'):
-    "Create the label for a given key."
-    self.key = key
-    self.complete(text, anchor = key, type = type)
-    Label.nameskey = self
-    if key in Reference.references:
-      for reference in Reference.referenceskey:
-        reference.destination = self
-    return self
-
-  def findpartkey(self):
-    "Get the part key for the latest numbered container seen."
-    numbered = self.numbered(self)
-    if numbered and numbered.partkey:
-      return numbered.partkey
-    return ''
-
-  def numbered(self, container):
-    "Get the numbered container for the label."
-    if container.partkey:
-      return container
-    if not container.parent:
-      if self.lastnumbered:
-        return self.lastnumbered
-      return None
-    return self.numbered(container.parent)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    if not hasattr(self, 'key'):
-      return 'Unnamed label'
-    return 'Label ' + self.key
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-class Reference(Link):
-  "A reference to a label."
-
-  references = dict()
-  key = 'none'
-
-  def process(self):
-    "Read the reference and set the arrow."
-    self.key = self.getparameter('reference')
-    if self.key in Label.names:
-      self.direction = u'↑'
-      label = Label.namesself.key
-    else:
-      self.direction = u'↓'
-      label = Label().complete(' ', self.key, 'preref')
-    self.destination = label
-    self.formatcontents()
-    if not self.key in Reference.references:
-      Reference.referencesself.key = 
-    Reference.referencesself.key.append(self)
-
-  def formatcontents(self):
-    "Format the reference contents."
-    formatkey = self.getparameter('LatexCommand')
-    if not formatkey:
-      formatkey = 'ref'
-    self.formatted = u'↕'
-    if formatkey in StyleConfig.referenceformats:
-      self.formatted = StyleConfig.referenceformatsformatkey
-    else:
-      Trace.error('Unknown reference format ' + formatkey)
-    self.replace(u'↕', self.direction)
-    self.replace('#', '1')
-    self.replace('on-page', Translator.translate('on-page'))
-    partkey = self.destination.findpartkey()
-    # only if partkey and partkey.number are not null, send partkey.number
-    self.replace('@', partkey and partkey.number)
-    self.replace(u'¶', partkey and partkey.tocentry)
-    if not '$' in self.formatted or not partkey or not partkey.titlecontents:
-      # there is a $ left, but it should go away on preprocessing
-      self.contents = Constant(self.formatted)
-      return
-    pieces = self.formatted.split('$')
-    self.contents = Constant(pieces0)
-    for piece in pieces1::
-      self.contents += partkey.titlecontents
-      self.contents.append(Constant(piece))
-
-  def replace(self, key, value):
-    "Replace a key in the format template with a value."
-    if not key in self.formatted:
-      return
-    if not value:
-      value = ''
-    self.formatted = self.formatted.replace(key, value)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    return 'Reference ' + self.key
+    def skipany(self, pos):
+        "Skip any skipped types."
+        for type in self.skippedtypes:
+            if self.instance(type).detect(pos):
+                return self.parsetype(type, pos)
+        return None
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def parseany(self, pos):
+        "Parse any formula bit at the current location."
+        for type in self.types + self.skippedtypes:
+            if self.detecttype(type, pos):
+                return self.parsetype(type, pos)
+        Trace.error('Unrecognized formula at ' + pos.identifier())
+        return FormulaConstant(pos.skipcurrent())
+
+    def parsetype(self, type, pos):
+        "Parse the given type and return it."
+        bit = self.instance(type)
+        self.instancestype = None
+        returnedbit = bit.parsebit(pos)
+        if returnedbit:
+            return returnedbit.setfactory(self)
+        return bit
+
+    def parseformula(self, formula):
+        "Parse a string of text that contains a whole formula."
+        pos = TextPosition(formula)
+        whole = self.create(WholeFormula)
+        if whole.detect(pos):
+            whole.parsebit(pos)
+            return whole
+        # no formula found
+        if not pos.finished():
+            Trace.error('Unknown formula at: ' + pos.identifier())
+            whole.add(TaggedBit().constant(formula, 'span class="unknown"'))
+        return whole
 
 
 class FormulaCommand(FormulaBit):
-  "A LaTeX command inside a formula"
+    "A LaTeX command inside a formula"
 
-  types = 
-  start = FormulaConfig.starts'command'
-  commandmap = None
-
-  def detect(self, pos):
-    "Find the current command."
-    return pos.checkfor(FormulaCommand.start)
-
-  def parsebit(self, pos):
-    "Parse the command."
-    command = self.extractcommand(pos)
-    bit = self.parsewithcommand(command, pos)
-    if bit:
-      return bit
-    if command.startswith('\\up') or command.startswith('\\Up'):
-      upgreek = self.parseupgreek(command, pos)
-      if upgreek:
+    types = 
+    start = FormulaConfig.starts'command'
+    commandmap = None
+
+    def detect(self, pos):
+        "Find the current command."
+        return pos.checkfor(FormulaCommand.start)
+
+    def parsebit(self, pos):
+        "Parse the command."
+        command = self.extractcommand(pos)
+        bit = self.parsewithcommand(command, pos)
+        if bit:
+            return bit
+        if command.startswith('\\up') or command.startswith('\\Up'):
+            upgreek = self.parseupgreek(command, pos)
+            if upgreek:
+                return upgreek
+        if not self.factory.defining:
+            Trace.error('Unknown command ' + command)
+        self.output = TaggedOutput().settag('span class="unknown"')
+        self.add(FormulaConstant(command))
+        return None
+
+    def parsewithcommand(self, command, pos):
+        "Parse the command type once we have the command."
+        for type in FormulaCommand.types:
+            if command in type.commandmap:
+                return self.parsecommandtype(command, type, pos)
+        return None
+
+    def parsecommandtype(self, command, type, pos):
+        "Parse a given command type."
+        bit = self.factory.create(type)
+        bit.setcommand(command)
+        returned = bit.parsebit(pos)
+        if returned:
+            return returned
+        return bit
+
+    def extractcommand(self, pos):
+        "Extract the command from the current position."
+        if not pos.checkskip(FormulaCommand.start):
+            pos.error('Missing command start ' + FormulaCommand.start)
+            return
+        if pos.finished():
+            return self.emptycommand(pos)
+        if pos.current().isalpha():
+            # alpha command
+            command = FormulaCommand.start + pos.globalpha()
+            # skip mark of short command
+            pos.checkskip('*')
+            return command
+        # symbol command
+        return FormulaCommand.start + pos.skipcurrent()
+
+    def emptycommand(self, pos):
+        """Check for an empty command: look for command disguised as ending.
+        Special case against '{ \\{ \\} }' situation."""
+        command = ''
+        if not pos.isout():
+            ending = pos.nextending()
+            if ending and pos.checkskip(ending):
+                command = ending
+        return FormulaCommand.start + command
+
+    def parseupgreek(self, command, pos):
+        "Parse the Greek \\up command.."
+        if len(command) < 4:
+            return None
+        if command.startswith('\\up'):
+            upcommand = '\\' + command3:
+        elif pos.checkskip('\\Up'):
+            upcommand = '\\' + command3:4.upper() + command4:
+        else:
+            Trace.error('Impossible upgreek command: ' + command)
+            return
+        upgreek = self.parsewithcommand(upcommand, pos)
+        if upgreek:
+            upgreek.type = 'font'
         return upgreek
-    if not self.factory.defining:
-      Trace.error('Unknown command ' + command)
-    self.output = TaggedOutput().settag('span class="unknown"')
-    self.add(FormulaConstant(command))
-    return None
-
-  def parsewithcommand(self, command, pos):
-    "Parse the command type once we have the command."
-    for type in FormulaCommand.types:
-      if command in type.commandmap:
-        return self.parsecommandtype(command, type, pos)
-    return None
-
-  def parsecommandtype(self, command, type, pos):
-    "Parse a given command type."
-    bit = self.factory.create(type)
-    bit.setcommand(command)
-    returned = bit.parsebit(pos)
-    if returned:
-      return returned
-    return bit
-
-  def extractcommand(self, pos):
-    "Extract the command from elyxer.the current position."
-    if not pos.checkskip(FormulaCommand.start):
-      pos.error('Missing command start ' + FormulaCommand.start)
-      return
-    if pos.finished():
-      return self.emptycommand(pos)
-    if pos.current().isalpha():
-      # alpha command
-      command = FormulaCommand.start + pos.globalpha()
-      # skip mark of short command
-      pos.checkskip('*')
-      return command
-    # symbol command
-    return FormulaCommand.start + pos.skipcurrent()
-
-  def emptycommand(self, pos):
-    """Check for an empty command: look for command disguised as ending.
-    Special case against '{ \\{ \\} }' situation."""
-    command = ''
-    if not pos.isout():
-      ending = pos.nextending()
-      if ending and pos.checkskip(ending):
-        command = ending
-    return FormulaCommand.start + command
-
-  def parseupgreek(self, command, pos):
-    "Parse the Greek \\up command.."
-    if len(command) < 4:
-      return None
-    if command.startswith('\\up'):
-      upcommand = '\\' + command3:
-    elif pos.checkskip('\\Up'):
-      upcommand = '\\' + command3:4.upper() + command4:
-    else:
-      Trace.error('Impossible upgreek command: ' + command)
-      return
-    upgreek = self.parsewithcommand(upcommand, pos)
-    if upgreek:
-      upgreek.type = 'font'
-    return upgreek
+
 
 class CommandBit(FormulaCommand):
-  "A formula bit that includes a command"
+    "A formula bit that includes a command"
+
+    def setcommand(self, command):
+        "Set the command in the bit"
+        self.command = command
+        if self.commandmap:
+            self.original += command
+            self.translated = self.commandmapself.command
+
+    def parseparameter(self, pos):
+        "Parse a parameter at the current position"
+        self.factory.clearskipped(pos)
+        if pos.finished():
+            return None
+        parameter = self.factory.parseany(pos)
+        self.add(parameter)
+        return parameter
+
+    def parsesquare(self, pos):
+        "Parse a square bracket"
+        self.factory.clearskipped(pos)
+        if not self.factory.detecttype(SquareBracket, pos):
+            return None
+        bracket = self.factory.parsetype(SquareBracket, pos)
+        self.add(bracket)
+        return bracket
+
+    def parseliteral(self, pos):
+        "Parse a literal bracket."
+        self.factory.clearskipped(pos)
+        if not self.factory.detecttype(Bracket, pos):
+            if not pos.isvalue():
+                Trace.error('No literal parameter found at: ' + pos.identifier())
+                return None
+            return pos.globvalue()
+        bracket = Bracket().setfactory(self.factory)
+        self.add(bracket.parseliteral(pos))
+        return bracket.literal
+
+    def parsesquareliteral(self, pos):
+        "Parse a square bracket literally."
+        self.factory.clearskipped(pos)
+        if not self.factory.detecttype(SquareBracket, pos):
+            return None
+        bracket = SquareBracket().setfactory(self.factory)
+        self.add(bracket.parseliteral(pos))
+        return bracket.literal
+
+    def parsetext(self, pos):
+        "Parse a text parameter."
+        self.factory.clearskipped(pos)
+        if not self.factory.detecttype(Bracket, pos):
+            Trace.error('No text parameter for ' + self.command)
+            return None
+        bracket = Bracket().setfactory(self.factory).parsetext(pos)
+        self.add(bracket)
+        return bracket
 
-  def setcommand(self, command):
-    "Set the command in the bit"
-    self.command = command
-    if self.commandmap:
-      self.original += command
-      self.translated = self.commandmapself.command
-
-  def parseparameter(self, pos):
-    "Parse a parameter at the current position"
-    self.factory.clearskipped(pos)
-    if pos.finished():
-      return None
-    parameter = self.factory.parseany(pos)
-    self.add(parameter)
-    return parameter
-
-  def parsesquare(self, pos):
-    "Parse a square bracket"
-    self.factory.clearskipped(pos)
-    if not self.factory.detecttype(SquareBracket, pos):
-      return None
-    bracket = self.factory.parsetype(SquareBracket, pos)
-    self.add(bracket)
-    return bracket
-
-  def parseliteral(self, pos):
-    "Parse a literal bracket."
-    self.factory.clearskipped(pos)
-    if not self.factory.detecttype(Bracket, pos):
-      if not pos.isvalue():
-        Trace.error('No literal parameter found at: ' + pos.identifier())
-        return None
-      return pos.globvalue()
-    bracket = Bracket().setfactory(self.factory)
-    self.add(bracket.parseliteral(pos))
-    return bracket.literal
-
-  def parsesquareliteral(self, pos):
-    "Parse a square bracket literally."
-    self.factory.clearskipped(pos)
-    if not self.factory.detecttype(SquareBracket, pos):
-      return None
-    bracket = SquareBracket().setfactory(self.factory)
-    self.add(bracket.parseliteral(pos))
-    return bracket.literal
-
-  def parsetext(self, pos):
-    "Parse a text parameter."
-    self.factory.clearskipped(pos)
-    if not self.factory.detecttype(Bracket, pos):
-      Trace.error('No text parameter for ' + self.command)
-      return None
-    bracket = Bracket().setfactory(self.factory).parsetext(pos)
-    self.add(bracket)
-    return bracket
 
 class EmptyCommand(CommandBit):
-  "An empty command (without parameters)"
+    "An empty command (without parameters)"
 
-  commandmap = FormulaConfig.commands
+    commandmap = FormulaConfig.commands
+
+    def parsebit(self, pos):
+        "Parse a command without parameters"
+        self.contents = FormulaConstant(self.translated)
 
-  def parsebit(self, pos):
-    "Parse a command without parameters"
-    self.contents = FormulaConstant(self.translated)
 
 class SpacedCommand(CommandBit):
-  "An empty command which should have math spacing in formulas."
+    """An empty command which should have math spacing in formulas."""
+
+    commandmap = FormulaConfig.spacedcommands
 
-  commandmap = FormulaConfig.spacedcommands
+    def parsebit(self, pos):
+        "Place as contents the command translated and spaced."
+        # pad with MEDIUM MATHEMATICAL SPACE (4/18 em): too wide in STIX fonts :(
+        # self.contents = FormulaConstant('\u205f' + self.translated + '\u205f')
+        # pad with THIN SPACE (1/5 em)
+        self.contents = FormulaConstant('\u2009' + self.translated + '\u2009')
 
-  def parsebit(self, pos):
-    "Place as contents the command translated and spaced."
-    self.contents = FormulaConstant(u' ' + self.translated + u' ')
 
 class AlphaCommand(EmptyCommand):
-  "A command without paramters whose result is alphabetical"
+    """A command without parameters whose result is alphabetical."""
 
-  commandmap = FormulaConfig.alphacommands
+    commandmap = FormulaConfig.alphacommands
+    greek_capitals = ('\\Xi', '\\Theta', '\\Pi', '\\Sigma', '\\Gamma',
+                      '\\Lambda', '\\Phi', '\\Psi', '\\Delta',
+                      '\\Upsilon', '\\Omega')
+
+    def parsebit(self, pos):
+        "Parse the command and set type to alpha"
+        EmptyCommand.parsebit(self, pos)
+        if self.command not in self.greek_capitals:
+            # Greek Capital letters are upright in LaTeX default math-style.
+            # TODO: use italic, like in MathML and "iso" math-style?
+            self.type = 'alpha'
 
-  def parsebit(self, pos):
-    "Parse the command and set type to alpha"
-    EmptyCommand.parsebit(self, pos)
-    self.type = 'alpha'
 
 class OneParamFunction(CommandBit):
-  "A function of one parameter"
+    "A function of one parameter"
+
+    commandmap = FormulaConfig.onefunctions
+    simplified = False
 
-  commandmap = FormulaConfig.onefunctions
-  simplified = False
+    def parsebit(self, pos):
+        "Parse a function with one parameter"
+        self.output = TaggedOutput().settag(self.translated)
+        self.parseparameter(pos)
+        self.simplifyifpossible()
+
+    def simplifyifpossible(self):
+        "Try to simplify to a single character."
+        if self.original in self.commandmap:
+            self.output = FixedOutput()
+            self.html = self.commandmapself.original
+            self.simplified = True
 
-  def parsebit(self, pos):
-    "Parse a function with one parameter"
-    self.output = TaggedOutput().settag(self.translated)
-    self.parseparameter(pos)
-    self.simplifyifpossible()
-
-  def simplifyifpossible(self):
-    "Try to simplify to a single character."
-    if self.original in self.commandmap:
-      self.output = FixedOutput()
-      self.html = self.commandmapself.original
-      self.simplified = True
 
 class SymbolFunction(CommandBit):
-  "Find a function which is represented by a symbol (like _ or ^)"
+    "Find a function which is represented by a symbol (like _ or ^)"
 
-  commandmap = FormulaConfig.symbolfunctions
+    commandmap = FormulaConfig.symbolfunctions
+
+    def detect(self, pos):
+        "Find the symbol"
+        return pos.current() in SymbolFunction.commandmap
+
+    def parsebit(self, pos):
+        "Parse the symbol"
+        self.setcommand(pos.current())
+        pos.skip(self.command)
+        self.output = TaggedOutput().settag(self.translated)
+        self.parseparameter(pos)
 
-  def detect(self, pos):
-    "Find the symbol"
-    return pos.current() in SymbolFunction.commandmap
-
-  def parsebit(self, pos):
-    "Parse the symbol"
-    self.setcommand(pos.current())
-    pos.skip(self.command)
-    self.output = TaggedOutput().settag(self.translated)
-    self.parseparameter(pos)
 
 class TextFunction(CommandBit):
-  "A function where parameters are read as text."
+    "A function where parameters are read as text."
+
+    commandmap = FormulaConfig.textfunctions
 
-  commandmap = FormulaConfig.textfunctions
+    def parsebit(self, pos):
+        "Parse a text parameter"
+        self.output = TaggedOutput().settag(self.translated)
+        self.parsetext(pos)
+
+    def process(self):
+        "Set the type to font"
+        self.type = 'font'
 
-  def parsebit(self, pos):
-    "Parse a text parameter"
-    self.output = TaggedOutput().settag(self.translated)
-    self.parsetext(pos)
-
-  def process(self):
-    "Set the type to font"
-    self.type = 'font'
-
-class LabelFunction(CommandBit):
-  "A function that acts as a label"
-
-  commandmap = FormulaConfig.labelfunctions
-
-  def parsebit(self, pos):
-    "Parse a literal parameter"
-    self.key = self.parseliteral(pos)
-
-  def process(self):
-    "Add an anchor with the label contents."
-    self.type = 'font'
-    self.label = Label().create(' ', self.key, type = 'eqnumber')
-    self.contents = self.label
-    # store as a Label so we know it's been seen
-    Label.namesself.key = self.label
 
 class FontFunction(OneParamFunction):
-  "A function of one parameter that changes the font"
+    """A function of one parameter that changes the font."""
+    # TODO: keep letters italic with \boldsymbol.
 
-  commandmap = FormulaConfig.fontfunctions
+    commandmap = FormulaConfig.fontfunctions
+
+    def process(self):
+        "Simplify if possible using a single character."
+        self.type = 'font'
+        self.simplifyifpossible()
 
-  def process(self):
-    "Simplify if possible using a single character."
-    self.type = 'font'
-    self.simplifyifpossible()
 
 FormulaFactory.types += FormulaCommand, SymbolFunction
 FormulaCommand.types = 
-    AlphaCommand, EmptyCommand, OneParamFunction, FontFunction, LabelFunction,
-    TextFunction, SpacedCommand,
-    
-
-
-
-
+    AlphaCommand, EmptyCommand, OneParamFunction, FontFunction,
+    TextFunction, SpacedCommand
 
 
+class BigBracket:
+    "A big bracket generator."
 
+    def __init__(self, size, bracket, alignment='l'):
+        "Set the size and symbol for the bracket."
+        self.size = size
+        self.original = bracket
+        self.alignment = alignment
+        self.pieces = None
+        if bracket in FormulaConfig.bigbrackets:
+            self.pieces = FormulaConfig.bigbracketsbracket
+
+    def getpiece(self, index):
+        "Return the nth piece for the bracket."
+        function = getattr(self, 'getpiece' + str(len(self.pieces)))
+        return function(index)
+
+    def getpiece1(self, index):
+        "Return the only piece for a single-piece bracket."
+        return self.pieces0
+
+    def getpiece3(self, index):
+        "Get the nth piece for a 3-piece bracket: parenthesis or square bracket."
+        if index == 0:
+            return self.pieces0
+        if index == self.size - 1:
+            return self.pieces-1
+        return self.pieces1
+
+    def getpiece4(self, index):
+        "Get the nth piece for a 4-piece bracket: curly bracket."
+        if index == 0:
+            return self.pieces0
+        if index == self.size - 1:
+            return self.pieces3
+        if index == (self.size - 1)/2:
+            return self.pieces2
+        return self.pieces1
+
+    def getcell(self, index):
+        "Get the bracket piece as an array cell."
+        piece = self.getpiece(index)
+        span = 'span class="bracket align-' + self.alignment + '"'
+        return TaggedBit().constant(piece, span)
+
+    def getcontents(self):
+        "Get the bracket as an array or as a single bracket."
+        if self.size == 1 or not self.pieces:
+            return self.getsinglebracket()
+        rows = 
+        for index in range(self.size):
+            cell = self.getcell(index)
+            rows.append(TaggedBit().complete(cell, 'span class="arrayrow"'))
+        return TaggedBit().complete(rows, 'span class="array"')
+
+    def getsinglebracket(self):
+        "Return the bracket as a single sign."
+        if self.original == '.':
+            return TaggedBit().constant('', 'span class="emptydot"')
+        return TaggedBit().constant(self.original, 'span class="stretchy"')
 
 
+class FormulaEquation(CommandBit):
+    "A simple numbered equation."
 
+    piece = 'equation'
 
-
-class BigSymbol(object):
-  "A big symbol generator."
-
-  symbols = FormulaConfig.bigsymbols
-
-  def __init__(self, symbol):
-    "Create the big symbol."
-    self.symbol = symbol
-
-  def getpieces(self):
-    "Get an array with all pieces."
-    if not self.symbol in self.symbols:
-      return self.symbol
-    if self.smalllimit():
-      return self.symbol
-    return self.symbolsself.symbol
-
-  def smalllimit(self):
-    "Decide if the limit should be a small, one-line symbol."
-    if not DocumentParameters.displaymode:
-      return True
-    if len(self.symbolsself.symbol) == 1:
-      return True
-    return Options.simplemath
-
-class BigBracket(BigSymbol):
-  "A big bracket generator."
-
-  def __init__(self, size, bracket, alignment='l'):
-    "Set the size and symbol for the bracket."
-    self.size = size
-    self.original = bracket
-    self.alignment = alignment
-    self.pieces = None
-    if bracket in FormulaConfig.bigbrackets:
-      self.pieces = FormulaConfig.bigbracketsbracket
-
-  def getpiece(self, index):
-    "Return the nth piece for the bracket."
-    function = getattr(self, 'getpiece' + unicode(len(self.pieces)))
-    return function(index)
-
-  def getpiece1(self, index):
-    "Return the only piece for a single-piece bracket."
-    return self.pieces0
-
-  def getpiece3(self, index):
-    "Get the nth piece for a 3-piece bracket: parenthesis or square bracket."
-    if index == 0:
-      return self.pieces0
-    if index == self.size - 1:
-      return self.pieces-1
-    return self.pieces1
-
-  def getpiece4(self, index):
-    "Get the nth piece for a 4-piece bracket: curly bracket."
-    if index == 0:
-      return self.pieces0
-    if index == self.size - 1:
-      return self.pieces3
-    if index == (self.size - 1)/2:
-      return self.pieces2
-    return self.pieces1
-
-  def getcell(self, index):
-    "Get the bracket piece as an array cell."
-    piece = self.getpiece(index)
-    span = 'span class="bracket align-' + self.alignment + '"'
-    return TaggedBit().constant(piece, span)
-
-  def getcontents(self):
-    "Get the bracket as an array or as a single bracket."
-    if self.size == 1 or not self.pieces:
-      return self.getsinglebracket()
-    rows = 
-    for index in range(self.size):
-      cell = self.getcell(index)
-      rows.append(TaggedBit().complete(cell, 'span class="arrayrow"'))
-    return TaggedBit().complete(rows, 'span class="array"')
-
-  def getsinglebracket(self):
-    "Return the bracket as a single sign."
-    if self.original == '.':
-      return TaggedBit().constant('', 'span class="emptydot"')
-    return TaggedBit().constant(self.original, 'span class="symbol"')
-
-
-
+    def parsebit(self, pos):
+        "Parse the array"
+        self.output = ContentsOutput()
+        self.add(self.factory.parsetype(WholeFormula, pos))
 
 
+class FormulaCell(FormulaCommand):
+    "An array cell inside a row"
 
-class FormulaEquation(CommandBit):
-  "A simple numbered equation."
+    def setalignment(self, alignment):
+        self.alignment = alignment
+        self.output = TaggedOutput().settag('span class="arraycell align-'
+                                            + alignment + '"', True)
+        return self
 
-  piece = 'equation'
+    def parsebit(self, pos):
+        self.factory.clearskipped(pos)
+        if pos.finished():
+            return
+        self.add(self.factory.parsetype(WholeFormula, pos))
 
-  def parsebit(self, pos):
-    "Parse the array"
-    self.output = ContentsOutput()
-    self.add(self.factory.parsetype(WholeFormula, pos))
 
-class FormulaCell(FormulaCommand):
-  "An array cell inside a row"
+class FormulaRow(FormulaCommand):
+    "An array row inside an array"
 
-  def setalignment(self, alignment):
-    self.alignment = alignment
-    self.output = TaggedOutput().settag('span class="arraycell align-' + alignment +'"', True)
-    return self
-
-  def parsebit(self, pos):
-    self.factory.clearskipped(pos)
-    if pos.finished():
-      return
-    self.add(self.factory.parsetype(WholeFormula, pos))
+    cellseparator = FormulaConfig.array'cellseparator'
 
-class FormulaRow(FormulaCommand):
-  "An array row inside an array"
+    def setalignments(self, alignments):
+        self.alignments = alignments
+        self.output = TaggedOutput().settag('span class="arrayrow"', True)
+        return self
 
-  cellseparator = FormulaConfig.array'cellseparator'
+    def parsebit(self, pos):
+        "Parse a whole row"
+        index = 0
+        pos.pushending(self.cellseparator, optional=True)
+        while not pos.finished():
+            cell = self.createcell(index)
+            cell.parsebit(pos)
+            self.add(cell)
+            index += 1
+            pos.checkskip(self.cellseparator)
+        if len(self.contents) == 0:
+            self.output = EmptyOutput()
+
+    def createcell(self, index):
+        "Create the cell that corresponds to the given index."
+        alignment = self.alignmentsindex % len(self.alignments)
+        return self.factory.create(FormulaCell).setalignment(alignment)
 
-  def setalignments(self, alignments):
-    self.alignments = alignments
-    self.output = TaggedOutput().settag('span class="arrayrow"', True)
-    return self
-
-  def parsebit(self, pos):
-    "Parse a whole row"
-    index = 0
-    pos.pushending(self.cellseparator, optional=True)
-    while not pos.finished():
-      cell = self.createcell(index)
-      cell.parsebit(pos)
-      self.add(cell)
-      index += 1
-      pos.checkskip(self.cellseparator)
-    if len(self.contents) == 0:
-      self.output = EmptyOutput()
-
-  def createcell(self, index):
-    "Create the cell that corresponds to the given index."
-    alignment = self.alignmentsindex % len(self.alignments)
-    return self.factory.create(FormulaCell).setalignment(alignment)
 
 class MultiRowFormula(CommandBit):
-  "A formula with multiple rows."
+    "A formula with multiple rows."
 
-  def parserows(self, pos):
-    "Parse all rows, finish when no more row ends"
-    self.rows = 
-    first = True
-    for row in self.iteraterows(pos):
-      if first:
-        first = False
-      else:
-        # intersparse empty rows
-        self.addempty()
-      row.parsebit(pos)
-      self.addrow(row)
-    self.size = len(self.rows)
-
-  def iteraterows(self, pos):
-    "Iterate over all rows, end when no more row ends"
-    rowseparator = FormulaConfig.array'rowseparator'
-    while True:
-      pos.pushending(rowseparator, True)
-      row = self.factory.create(FormulaRow)
-      yield row.setalignments(self.alignments)
-      if pos.checkfor(rowseparator):
-        self.original += pos.popending(rowseparator)
-      else:
-        return
+    def parserows(self, pos):
+        "Parse all rows, finish when no more row ends"
+        self.rows = 
+        first = True
+        for row in self.iteraterows(pos):
+            if first:
+                first = False
+            else:
+                # intersparse empty rows
+                self.addempty()
+            row.parsebit(pos)
+            self.addrow(row)
+        self.size = len(self.rows)
+
+    def iteraterows(self, pos):
+        "Iterate over all rows, end when no more row ends"
+        rowseparator = FormulaConfig.array'rowseparator'
+        while True:
+            pos.pushending(rowseparator, True)
+            row = self.factory.create(FormulaRow)
+            yield row.setalignments(self.alignments)
+            if pos.checkfor(rowseparator):
+                self.original += pos.popending(rowseparator)
+            else:
+                return
+
+    def addempty(self):
+        "Add an empty row."
+        row = self.factory.create(FormulaRow).setalignments(self.alignments)
+        for index, originalcell in enumerate(self.rows-1.contents):
+            cell = row.createcell(index)
+            cell.add(FormulaConstant(' '))
+            row.add(cell)
+        self.addrow(row)
+
+    def addrow(self, row):
+        "Add a row to the contents and to the list of rows."
+        self.rows.append(row)
+        self.add(row)
 
-  def addempty(self):
-    "Add an empty row."
-    row = self.factory.create(FormulaRow).setalignments(self.alignments)
-    for index, originalcell in enumerate(self.rows-1.contents):
-      cell = row.createcell(index)
-      cell.add(FormulaConstant(u' '))
-      row.add(cell)
-    self.addrow(row)
-
-  def addrow(self, row):
-    "Add a row to the contents and to the list of rows."
-    self.rows.append(row)
-    self.add(row)
 
 class FormulaArray(MultiRowFormula):
-  "An array within a formula"
+    "An array within a formula"
 
-  piece = 'array'
+    piece = 'array'
+
+    def parsebit(self, pos):
+        "Parse the array"
+        self.output = TaggedOutput().settag('span class="array"', False)
+        self.parsealignments(pos)
+        self.parserows(pos)
+
+    def parsealignments(self, pos):
+        "Parse the different alignments"
+        # vertical
+        self.valign = 'c'
+        literal = self.parsesquareliteral(pos)
+        if literal:
+            self.valign = literal
+        # horizontal
+        literal = self.parseliteral(pos)
+        self.alignments = 
+        for s in literal:
+            self.alignments.append(s)
 
-  def parsebit(self, pos):
-    "Parse the array"
-    self.output = TaggedOutput().settag('span class="array"', False)
-    self.parsealignments(pos)
-    self.parserows(pos)
-
-  def parsealignments(self, pos):
-    "Parse the different alignments"
-    # vertical
-    self.valign = 'c'
-    literal = self.parsesquareliteral(pos)
-    if literal:
-      self.valign = literal
-    # horizontal
-    literal = self.parseliteral(pos)
-    self.alignments = 
-    for l in literal:
-      self.alignments.append(l)
 
 class FormulaMatrix(MultiRowFormula):
-  "A matrix (array with center alignment)."
+    "A matrix (array with center alignment)."
+
+    piece = 'matrix'
 
-  piece = 'matrix'
+    def parsebit(self, pos):
+        "Parse the matrix, set alignments to 'c'."
+        self.output = TaggedOutput().settag('span class="array"', False)
+        self.valign = 'c'
+        self.alignments = 'c'
+        self.parserows(pos)
 
-  def parsebit(self, pos):
-    "Parse the matrix, set alignments to 'c'."
-    self.output = TaggedOutput().settag('span class="array"', False)
-    self.valign = 'c'
-    self.alignments = 'c'
-    self.parserows(pos)
 
 class FormulaCases(MultiRowFormula):
-  "A cases statement"
+    "A cases statement"
 
-  piece = 'cases'
+    piece = 'cases'
+
+    def parsebit(self, pos):
+        "Parse the cases"
+        self.output = ContentsOutput()
+        self.alignments = 'l', 'l'
+        self.parserows(pos)
+        for row in self.contents:
+            for cell in row.contents:
+                cell.output.settag('span class="case align-l"', True)
+                cell.contents.append(FormulaConstant(' '))
+        array = TaggedBit().complete(self.contents, 'span class="bracketcases"', True)
+        brace = BigBracket(len(self.contents), '{', 'l')
+        self.contents = brace.getcontents() + array
 
-  def parsebit(self, pos):
-    "Parse the cases"
-    self.output = ContentsOutput()
-    self.alignments = 'l', 'l'
-    self.parserows(pos)
-    for row in self.contents:
-      for cell in row.contents:
-        cell.output.settag('span class="case align-l"', True)
-        cell.contents.append(FormulaConstant(u' '))
-    array = TaggedBit().complete(self.contents, 'span class="bracketcases"', True)
-    brace = BigBracket(len(self.contents), '{', 'l')
-    self.contents = brace.getcontents() + array
 
 class EquationEnvironment(MultiRowFormula):
-  "A \\begin{}...\\end equation environment with rows and cells."
+    "A \\begin{}...\\end equation environment with rows and cells."
+
+    def parsebit(self, pos):
+        "Parse the whole environment."
+        environment = self.piece.replace('*', '')
+        self.output = TaggedOutput().settag(
+                        'span class="environment %s"'%environment, False)
+        if environment in FormulaConfig.environments:
+            self.alignments = FormulaConfig.environmentsenvironment
+        else:
+            Trace.error('Unknown equation environment ' + self.piece)
+            # print in red
+            self.output = TaggedOutput().settag('span class="unknown"')
+            self.add(FormulaConstant('\\begin{%s} '%environment))
+
+            self.alignments = 'l'
+        self.parserows(pos)
 
-  def parsebit(self, pos):
-    "Parse the whole environment."
-    self.output = TaggedOutput().settag('span class="environment"', False)
-    environment = self.piece.replace('*', '')
-    if environment in FormulaConfig.environments:
-      self.alignments = FormulaConfig.environmentsenvironment
-    else:
-      Trace.error('Unknown equation environment ' + self.piece)
-      self.alignments = 'l'
-    self.parserows(pos)
 
 class BeginCommand(CommandBit):
-  "A \\begin{}...\\end command and what it entails (array, cases, aligned)"
+    "A \\begin{}...\\end command and what it entails (array, cases, aligned)"
 
-  commandmap = {FormulaConfig.array'begin':''}
+    commandmap = {FormulaConfig.array'begin': ''}
 
-  types = FormulaEquation, FormulaArray, FormulaCases, FormulaMatrix
+    types = FormulaEquation, FormulaArray, FormulaCases, FormulaMatrix
 
-  def parsebit(self, pos):
-    "Parse the begin command"
-    command = self.parseliteral(pos)
-    bit = self.findbit(command)
-    ending = FormulaConfig.array'end' + '{' + command + '}'
-    pos.pushending(ending)
-    bit.parsebit(pos)
-    self.add(bit)
-    self.original += pos.popending(ending)
-    self.size = bit.size
-
-  def findbit(self, piece):
-    "Find the command bit corresponding to the \\begin{piece}"
-    for type in BeginCommand.types:
-      if piece.replace('*', '') == type.piece:
-        return self.factory.create(type)
-    bit = self.factory.create(EquationEnvironment)
-    bit.piece = piece
-    return bit
+    def parsebit(self, pos):
+        "Parse the begin command"
+        command = self.parseliteral(pos)
+        bit = self.findbit(command)
+        ending = FormulaConfig.array'end' + '{' + command + '}'
+        pos.pushending(ending)
+        bit.parsebit(pos)
+        self.add(bit)
+        self.original += pos.popending(ending)
+        self.size = bit.size
+
+    def findbit(self, piece):
+        "Find the command bit corresponding to the \\begin{piece}"
+        for type in BeginCommand.types:
+            if piece.replace('*', '') == type.piece:
+                return self.factory.create(type)
+        bit = self.factory.create(EquationEnvironment)
+        bit.piece = piece
+        return bit
 
-FormulaCommand.types += BeginCommand
 
+FormulaCommand.types += BeginCommand
 
 
 class CombiningFunction(OneParamFunction):
 
-  commandmap = FormulaConfig.combiningfunctions
+    commandmap = FormulaConfig.combiningfunctions
 
-  def parsebit(self, pos):
-    "Parse a combining function."
-    self.type = 'alpha'
-    combining = self.translated
-    parameter = self.parsesingleparameter(pos)
-    if not parameter:
-      Trace.error('Empty parameter for combining function ' + self.command)
-    elif len(parameter.extracttext()) != 1:
-      Trace.error('Applying combining function ' + self.command + ' to invalid string "' + parameter.extracttext() + '"')
-    self.contents.append(Constant(combining))
-
-  def parsesingleparameter(self, pos):
-    "Parse a parameter, or a single letter."
-    self.factory.clearskipped(pos)
-    if pos.finished():
-      Trace.error('Error while parsing single parameter at ' + pos.identifier())
-      return None
-    if self.factory.detecttype(Bracket, pos) \
-        or self.factory.detecttype(FormulaCommand, pos):
-      return self.parseparameter(pos)
-    letter = FormulaConstant(pos.skipcurrent())
-    self.add(letter)
-    return letter
-
-class DecoratingFunction(OneParamFunction):
-  "A function that decorates some bit of text"
-
-  commandmap = FormulaConfig.decoratingfunctions
-
-  def parsebit(self, pos):
-    "Parse a decorating function"
-    self.type = 'alpha'
-    symbol = self.translated
-    self.symbol = TaggedBit().constant(symbol, 'span class="symbolover"')
-    self.parameter = self.parseparameter(pos)
-    self.output = TaggedOutput().settag('span class="withsymbol"')
-    self.contents.insert(0, self.symbol)
-    self.parameter.output = TaggedOutput().settag('span class="undersymbol"')
-    self.simplifyifpossible()
+    def parsebit(self, pos):
+        "Parse a combining function."
+        combining = self.translated
+        parameter = self.parsesingleparameter(pos)
+        if not parameter:
+            Trace.error('Missing parameter for combining function ' + self.command)
+            return
+        # Trace.message('apply %s to %r'%(self.command, parameter.extracttext()))
+        # parameter.tree()
+        if not isinstance(parameter, FormulaConstant):
+            try:
+                extractor = ContainerExtractor(ContainerConfig.extracttext)
+                parameter = extractor.extract(parameter)0
+            except IndexError:
+                Trace.error('No base character found for "%s".' % self.command)
+                return
+        # Trace.message('  basechar: %r' % parameter.string)
+        # Insert combining character after the first character:
+        if parameter.string.startswith('\u2009'):
+            i = 2  # skip padding by SpacedCommand and FormulaConfig.modified
+        else:
+            i = 1
+        parameter.string = parameter.string:i + combining + parameter.stringi:
+        # Use pre-composed characters if possible: \not{=} -> ≠, say.
+        parameter.string = unicodedata.normalize('NFC', parameter.string)
+
+    def parsesingleparameter(self, pos):
+        "Parse a parameter, or a single letter."
+        self.factory.clearskipped(pos)
+        if pos.finished():
+            return None
+        return self.parseparameter(pos)
+
+
+class OversetFunction(OneParamFunction):
+    "A function that decorates some bit of text with an overset."
+
+    commandmap = FormulaConfig.oversetfunctions
+
+    def parsebit(self, pos):
+        "Parse an overset-function"
+        symbol = self.translated
+        self.symbol = TaggedBit().constant(symbol, 'sup')
+        self.parameter = self.parseparameter(pos)
+        self.output = TaggedOutput().settag('span class="embellished"')
+        self.contents.insert(0, self.symbol)
+        self.parameter.output = TaggedOutput().settag('span class="base"')
+        self.simplifyifpossible()
+
+
+class UndersetFunction(OneParamFunction):
+    "A function that decorates some bit of text with an underset."
+
+    commandmap = FormulaConfig.undersetfunctions
+
+    def parsebit(self, pos):
+        "Parse an underset-function"
+        symbol = self.translated
+        self.symbol = TaggedBit().constant(symbol, 'sub')
+        self.parameter = self.parseparameter(pos)
+        self.output = TaggedOutput().settag('span class="embellished"')
+        self.contents.insert(0, self.symbol)
+        self.parameter.output = TaggedOutput().settag('span class="base"')
+        self.simplifyifpossible()
 
-class LimitCommand(EmptyCommand):
-  "A command which accepts limits above and below, in display mode."
 
-  commandmap = FormulaConfig.limitcommands
+class LimitCommand(EmptyCommand):
+    "A command which accepts limits above and below, in display mode."
 
-  def parsebit(self, pos):
-    "Parse a limit command."
-    pieces = BigSymbol(self.translated).getpieces()
-    self.output = TaggedOutput().settag('span class="limits"')
-    for piece in pieces:
-      self.contents.append(TaggedBit().constant(piece, 'span class="limit"'))
+    commandmap = FormulaConfig.limitcommands
 
-class LimitPreviousCommand(LimitCommand):
-  "A command to limit the previous command."
+    def parsebit(self, pos):
+        "Parse a limit command."
+        self.output = TaggedOutput().settag('span class="limits"')
+        symbol = self.translated
+        self.contents.append(TaggedBit().constant(symbol, 'span class="limit"'))
 
-  commandmap = None
 
-  def parsebit(self, pos):
-    "Do nothing."
-    self.output = TaggedOutput().settag('span class="limits"')
-    self.factory.clearskipped(pos)
+class LimitPreviousCommand(LimitCommand):
+    "A command to limit the previous command."
 
-  def __unicode__(self):
-    "Return a printable representation."
-    return 'Limit previous command'
+    commandmap = None
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
+    def parsebit(self, pos):
+        "Do nothing."
+        self.output = TaggedOutput().settag('span class="limits"')
+        self.factory.clearskipped(pos)
+
+    def __str__(self):
+        "Return a printable representation."
+        return 'Limit previous command'
 
 
 class LimitsProcessor(MathsProcessor):
-  "A processor for limits inside an element."
-
-  def process(self, contents, index):
-    "Process the limits for an element."
-    if Options.simplemath:
-      return
-    if self.checklimits(contents, index):
-      self.modifylimits(contents, index)
-    if self.checkscript(contents, index) and self.checkscript(contents, index + 1):
-      self.modifyscripts(contents, index)
-
-  def checklimits(self, contents, index):
-    "Check if the current position has a limits command."
-    if not DocumentParameters.displaymode:
-      return False
-    if self.checkcommand(contents, index + 1, LimitPreviousCommand):
-      self.limitsahead(contents, index)
-      return False
-    if not isinstance(contentsindex, LimitCommand):
-      return False
-    return self.checkscript(contents, index + 1)
-
-  def limitsahead(self, contents, index):
-    "Limit the current element based on the next."
-    contentsindex + 1.add(contentsindex.clone())
-    contentsindex.output = EmptyOutput()
-
-  def modifylimits(self, contents, index):
-    "Modify a limits commands so that the limits appear above and below."
-    limited = contentsindex
-    subscript = self.getlimit(contents, index + 1)
-    limited.contents.append(subscript)
-    if self.checkscript(contents, index + 1):
-      superscript = self.getlimit(contents, index  + 1)
-    else:
-      superscript = TaggedBit().constant(u' ', 'sup class="limit"')
-    limited.contents.insert(0, superscript)
-
-  def getlimit(self, contents, index):
-    "Get the limit for a limits command."
-    limit = self.getscript(contents, index)
-    limit.output.tag = limit.output.tag.replace('script', 'limit')
-    return limit
-
-  def modifyscripts(self, contents, index):
-    "Modify the super- and subscript to appear vertically aligned."
-    subscript = self.getscript(contents, index)
-    # subscript removed so instead of index + 1 we get index again
-    superscript = self.getscript(contents, index)
-    scripts = TaggedBit().complete(superscript, subscript, 'span class="scripts"')
-    contents.insert(index, scripts)
-
-  def checkscript(self, contents, index):
-    "Check if the current element is a sub- or superscript."
-    return self.checkcommand(contents, index, SymbolFunction)
-
-  def checkcommand(self, contents, index, type):
-    "Check for the given type as the current element."
-    if len(contents) <= index:
-      return False
-    return isinstance(contentsindex, type)
-
-  def getscript(self, contents, index):
-    "Get the sub- or superscript."
-    bit = contentsindex
-    bit.output.tag += ' class="script"'
-    del contentsindex
-    return bit
-
-class BracketCommand(OneParamFunction):
-  "A command which defines a bracket."
-
-  commandmap = FormulaConfig.bracketcommands
-
-  def parsebit(self, pos):
-    "Parse the bracket."
-    OneParamFunction.parsebit(self, pos)
-
-  def create(self, direction, character):
-    "Create the bracket for the given character."
-    self.original = character
-    self.command = '\\' + direction
-    self.contents = FormulaConstant(character)
-    return self
+    "A processor for limits inside an element."
 
-class BracketProcessor(MathsProcessor):
-  "A processor for bracket commands."
-
-  def process(self, contents, index):
-    "Convert the bracket using Unicode pieces, if possible."
-    if Options.simplemath:
-      return
-    if self.checkleft(contents, index):
-      return self.processleft(contents, index)
-
-  def processleft(self, contents, index):
-    "Process a left bracket."
-    rightindex = self.findright(contents, index + 1)
-    if not rightindex:
-      return
-    size = self.findmax(contents, index, rightindex)
-    self.resize(contentsindex, size)
-    self.resize(contentsrightindex, size)
-
-  def checkleft(self, contents, index):
-    "Check if the command at the given index is left."
-    return self.checkdirection(contentsindex, '\\left')
-
-  def checkright(self, contents, index):
-    "Check if the command at the given index is right."
-    return self.checkdirection(contentsindex, '\\right')
-
-  def checkdirection(self, bit, command):
-    "Check if the given bit is the desired bracket command."
-    if not isinstance(bit, BracketCommand):
-      return False
-    return bit.command == command
-
-  def findright(self, contents, index):
-    "Find the right bracket starting at the given index, or 0."
-    depth = 1
-    while index < len(contents):
-      if self.checkleft(contents, index):
-        depth += 1
-      if self.checkright(contents, index):
-        depth -= 1
-      if depth == 0:
-        return index
-      index += 1
-    return None
-
-  def findmax(self, contents, leftindex, rightindex):
-    "Find the max size of the contents between the two given indices."
-    sliced = contentsleftindex:rightindex
-    return max(element.size for element in sliced)
-
-  def resize(self, command, size):
-    "Resize a bracket command to the given size."
-    character = command.extracttext()
-    alignment = command.command.replace('\\', '')
-    bracket = BigBracket(size, character, alignment)
-    command.output = ContentsOutput()
-    command.contents = bracket.getcontents()
-
-class TodayCommand(EmptyCommand):
-  "Shows today's date."
-
-  commandmap = None
-
-  def parsebit(self, pos):
-    "Parse a command without parameters"
-    self.output = FixedOutput()
-    self.html = datetime.date.today().strftime('%b %d, %Y')
-
-
-FormulaCommand.types += 
-    DecoratingFunction, CombiningFunction, LimitCommand, BracketCommand,
-    
+    def process(self, contents, index):
+        "Process the limits for an element."
+        if Options.simplemath:
+            return
+        if self.checklimits(contents, index):
+            self.modifylimits(contents, index)
+        if self.checkscript(contents, index) and self.checkscript(contents, index + 1):
+            self.modifyscripts(contents, index)
+
+    def checklimits(self, contents, index):
+        "Check if the current position has a limits command."
+        # TODO: check for \limits macro
+        if not DocumentParameters.displaymode:
+            return False
+        if self.checkcommand(contents, index + 1, LimitPreviousCommand):
+            self.limitsahead(contents, index)
+            return False
+        if not isinstance(contentsindex, LimitCommand):
+            return False
+        return self.checkscript(contents, index + 1)
+
+    def limitsahead(self, contents, index):
+        "Limit the current element based on the next."
+        contentsindex + 1.add(contentsindex.clone())
+        contentsindex.output = EmptyOutput()
+
+    def modifylimits(self, contents, index):
+        "Modify a limits commands so that the limits appear above and below."
+        limited = contentsindex
+        subscript = self.getlimit(contents, index + 1)
+        if self.checkscript(contents, index + 1):
+            superscript = self.getlimit(contents, index + 1)
+        else:
+            superscript = TaggedBit().constant('\u2009', 'sup class="limit"')
+        # fix order if source is x^i
+        if subscript.command == '^':
+            superscript, subscript = subscript, superscript
+        limited.contents.append(subscript)
+        limited.contents.insert(0, superscript)
+
+    def getlimit(self, contents, index):
+        "Get the limit for a limits command."
+        limit = self.getscript(contents, index)
+        limit.output.tag = limit.output.tag.replace('script', 'limit')
+        return limit
+
+    def modifyscripts(self, contents, index):
+        "Modify the super- and subscript to appear vertically aligned."
+        subscript = self.getscript(contents, index)
+        # subscript removed so instead of index + 1 we get index again
+        superscript = self.getscript(contents, index)
+        # super-/subscript are reversed if source is x^i_j
+        if subscript.command == '^':
+            superscript, subscript = subscript, superscript
+        scripts = TaggedBit().complete(superscript, subscript, 'span class="scripts"')
+        contents.insert(index, scripts)
+
+    def checkscript(self, contents, index):
+        "Check if the current element is a sub- or superscript."
+        return self.checkcommand(contents, index, SymbolFunction)
+
+    def checkcommand(self, contents, index, type):
+        "Check for the given type as the current element."
+        if len(contents) <= index:
+            return False
+        return isinstance(contentsindex, type)
+
+    def getscript(self, contents, index):
+        "Get the sub- or superscript."
+        bit = contentsindex
+        bit.output.tag += ' class="script"'
+        del contentsindex
+        return bit
 
-FormulaProcessor.processors += 
-    LimitsProcessor(), BracketProcessor(),
-    
 
+class BracketCommand(OneParamFunction):
+    "A command which defines a bracket."
 
+    commandmap = FormulaConfig.bracketcommands
 
-class ParameterDefinition(object):
-  "The definition of a parameter in a hybrid function."
-  " parameters are optional, {} parameters are mandatory."
-  "Each parameter has a one-character name, like {$1} or {$p}."
-  "A parameter that ends in ! like {$p!} is a literal."
-  "Example: $1{$p!} reads an optional parameter $1 and a literal mandatory parameter p."
-
-  parambrackets = ('', ''), ('{', '}')
-
-  def __init__(self):
-    self.name = None
-    self.literal = False
-    self.optional = False
-    self.value = None
-    self.literalvalue = None
-
-  def parse(self, pos):
-    "Parse a parameter definition: $0, {$x}, {$1!}..."
-    for (opening, closing) in ParameterDefinition.parambrackets:
-      if pos.checkskip(opening):
-        if opening == '':
-          self.optional = True
-        if not pos.checkskip('$'):
-          Trace.error('Wrong parameter name, did you mean $' + pos.current() + '?')
-          return None
-        self.name = pos.skipcurrent()
-        if pos.checkskip('!'):
-          self.literal = True
-        if not pos.checkskip(closing):
-          Trace.error('Wrong parameter closing ' + pos.skipcurrent())
-          return None
+    def parsebit(self, pos):
+        "Parse the bracket."
+        OneParamFunction.parsebit(self, pos)
+
+    def create(self, direction, character):
+        "Create the bracket for the given character."
+        self.original = character
+        self.command = '\\' + direction
+        self.contents = FormulaConstant(character)
         return self
-    Trace.error('Wrong character in parameter template: ' + pos.skipcurrent())
-    return None
-
-  def read(self, pos, function):
-    "Read the parameter itself using the definition."
-    if self.literal:
-      if self.optional:
-        self.literalvalue = function.parsesquareliteral(pos)
-      else:
-        self.literalvalue = function.parseliteral(pos)
-      if self.literalvalue:
-        self.value = FormulaConstant(self.literalvalue)
-    elif self.optional:
-      self.value = function.parsesquare(pos)
-    else:
-      self.value = function.parseparameter(pos)
-
-  def __unicode__(self):
-    "Return a printable representation."
-    result = 'param ' + self.name
-    if self.value:
-      result += ': ' + unicode(self.value)
-    else:
-      result += ' (empty)'
-    return result
 
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
 
+class BracketProcessor(MathsProcessor):
+    "A processor for bracket commands."
 
-class ParameterFunction(CommandBit):
-  "A function with a variable number of parameters defined in a template."
-  "The parameters are defined as a parameter definition."
+    def process(self, contents, index):
+        "Convert the bracket using Unicode pieces, if possible."
+        if Options.simplemath:
+            return
+        if self.checkleft(contents, index):
+            return self.processleft(contents, index)
+
+    def processleft(self, contents, index):
+        "Process a left bracket."
+        rightindex = self.findright(contents, index + 1)
+        if not rightindex:
+            return
+        size = self.findmax(contents, index, rightindex)
+        self.resize(contentsindex, size)
+        self.resize(contentsrightindex, size)
+
+    def checkleft(self, contents, index):
+        "Check if the command at the given index is left."
+        return self.checkdirection(contentsindex, '\\left')
+
+    def checkright(self, contents, index):
+        "Check if the command at the given index is right."
+        return self.checkdirection(contentsindex, '\\right')
+
+    def checkdirection(self, bit, command):
+        "Check if the given bit is the desired bracket command."
+        if not isinstance(bit, BracketCommand):
+            return False
+        return bit.command == command
+
+    def findright(self, contents, index):
+        "Find the right bracket starting at the given index, or 0."
+        depth = 1
+        while index < len(contents):
+            if self.checkleft(contents, index):
+                depth += 1
+            if self.checkright(contents, index):
+                depth -= 1
+            if depth == 0:
+                return index
+            index += 1
+        return None
 
-  def readparams(self, readtemplate, pos):
-    "Read the params according to the template."
-    self.params = dict()
-    for paramdef in self.paramdefs(readtemplate):
-      paramdef.read(pos, self)
-      self.params'$' + paramdef.name = paramdef
-
-  def paramdefs(self, readtemplate):
-    "Read each param definition in the template"
-    pos = TextPosition(readtemplate)
-    while not pos.finished():
-      paramdef = ParameterDefinition().parse(pos)
-      if paramdef:
-        yield paramdef
-
-  def getparam(self, name):
-    "Get a parameter as parsed."
-    if not name in self.params:
-      return None
-    return self.paramsname
-
-  def getvalue(self, name):
-    "Get the value of a parameter."
-    return self.getparam(name).value
-
-  def getliteralvalue(self, name):
-    "Get the literal value of a parameter."
-    param = self.getparam(name)
-    if not param or not param.literalvalue:
-      return None
-    return param.literalvalue
+    def findmax(self, contents, leftindex, rightindex):
+        "Find the max size of the contents between the two given indices."
+        sliced = contentsleftindex:rightindex
+        return max(element.size for element in sliced)
+
+    def resize(self, command, size):
+        "Resize a bracket command to the given size."
+        character = command.extracttext()
+        alignment = command.command.replace('\\', '')
+        bracket = BigBracket(size, character, alignment)
+        command.output = ContentsOutput()
+        command.contents = bracket.getcontents()
 
-class HybridFunction(ParameterFunction):
-  """
-  A parameter function where the output is also defined using a template.
-  The template can use a number of functions; each function has an associated
-  tag.
-  Example: f0{$1},span class="fbox" defines a function f0 which corresponds
-  to a span of class fbox, yielding <span class="fbox">$1</span>.
-  Literal parameters can be used in tags definitions:
-    f0{$1},span style="color: $p;"
-  yields <span style="color: $p;">$1</span>, where $p is a literal parameter.
-  Sizes can be specified in hybridsizes, e.g. adding parameter sizes. By
-  default the resulting size is the max of all arguments. Sizes are used
-  to generate the right parameters.
-  A function followed by a single / is output as a self-closing XHTML tag:
-    f0/,hr
-  will generate <hr/>.
-  """
-
-  commandmap = FormulaConfig.hybridfunctions
-
-  def parsebit(self, pos):
-    "Parse a function with  and {} parameters"
-    readtemplate = self.translated0
-    writetemplate = self.translated1
-    self.readparams(readtemplate, pos)
-    self.contents = self.writeparams(writetemplate)
-    self.computehybridsize()
-
-  def writeparams(self, writetemplate):
-    "Write all params according to the template"
-    return self.writepos(TextPosition(writetemplate))
-
-  def writepos(self, pos):
-    "Write all params as read in the parse position."
-    result = 
-    while not pos.finished():
-      if pos.checkskip('$'):
-        param = self.writeparam(pos)
-        if param:
-          result.append(param)
-      elif pos.checkskip('f'):
-        function = self.writefunction(pos)
-        if function:
-          function.type = None
-          result.append(function)
-      elif pos.checkskip('('):
-        result.append(self.writebracket('left', '('))
-      elif pos.checkskip(')'):
-        result.append(self.writebracket('right', ')'))
-      else:
-        result.append(FormulaConstant(pos.skipcurrent()))
-    return result
-
-  def writeparam(self, pos):
-    "Write a single param of the form $0, $x..."
-    name = '$' + pos.skipcurrent()
-    if not name in self.params:
-      Trace.error('Unknown parameter ' + name)
-      return None
-    if not self.paramsname:
-      return None
-    if pos.checkskip('.'):
-      self.paramsname.value.type = pos.globalpha()
-    return self.paramsname.value
-
-  def writefunction(self, pos):
-    "Write a single function f0,...,fn."
-    tag = self.readtag(pos)
-    if not tag:
-      return None
-    if pos.checkskip('/'):
-      # self-closing XHTML tag, such as <hr/>
-      return TaggedBit().selfcomplete(tag)
-    if not pos.checkskip('{'):
-      Trace.error('Function should be defined in {}')
-      return None
-    pos.pushending('}')
-    contents = self.writepos(pos)
-    pos.popending()
-    if len(contents) == 0:
-      return None
-    return TaggedBit().complete(contents, tag)
-
-  def readtag(self, pos):
-    "Get the tag corresponding to the given index. Does parameter substitution."
-    if not pos.current().isdigit():
-      Trace.error('Function should be f0,...,f9: f' + pos.current())
-      return None
-    index = int(pos.skipcurrent())
-    if 2 + index > len(self.translated):
-      Trace.error('Function f' + unicode(index) + ' is not defined')
-      return None
-    tag = self.translated2 + index
-    if not '$' in tag:
-      return tag
-    for variable in self.params:
-      if variable in tag:
-        param = self.paramsvariable
-        if not param.literal:
-          Trace.error('Parameters in tag ' + tag + ' should be literal: {' + variable + '!}')
-          continue
-        if param.literalvalue:
-          value = param.literalvalue
-        else:
-          value = ''
-        tag = tag.replace(variable, value)
-    return tag
-
-  def writebracket(self, direction, character):
-    "Return a new bracket looking at the given direction."
-    return self.factory.create(BracketCommand).create(direction, character)
-
-  def computehybridsize(self):
-    "Compute the size of the hybrid function."
-    if not self.command in HybridSize.configsizes:
-      self.computesize()
-      return
-    self.size = HybridSize().getsize(self)
-    # set the size in all elements at first level
-    for element in self.contents:
-      element.size = self.size
-
-class HybridSize(object):
-  "The size associated with a hybrid function."
-
-  configsizes = FormulaConfig.hybridsizes
-
-  def getsize(self, function):
-    "Read the size for a function and parse it."
-    sizestring = self.configsizesfunction.command
-    for name in function.params:
-      if name in sizestring:
-        size = function.paramsname.value.computesize()
-        sizestring = sizestring.replace(name, unicode(size))
-    if '$' in sizestring:
-      Trace.error('Unconverted variable in hybrid size: ' + sizestring)
-      return 1
-    return eval(sizestring)
 
+FormulaCommand.types += OversetFunction, UndersetFunction,
+                         CombiningFunction, LimitCommand, BracketCommand
 
-FormulaCommand.types += HybridFunction
+FormulaProcessor.processors += 
+    LimitsProcessor(), BracketProcessor(),
+
 
 
+class ParameterDefinition:
+    "The definition of a parameter in a hybrid function."
+    " parameters are optional, {} parameters are mandatory."
+    "Each parameter has a one-character name, like {$1} or {$p}."
+    "A parameter that ends in ! like {$p!} is a literal."
+    "Example: $1{$p!} reads an optional parameter $1 and a literal mandatory parameter p."
+
+    parambrackets = ('', ''), ('{', '}')
+
+    def __init__(self):
+        self.name = None
+        self.literal = False
+        self.optional = False
+        self.value = None
+        self.literalvalue = None
+
+    def parse(self, pos):
+        "Parse a parameter definition: $0, {$x}, {$1!}..."
+        for (opening, closing) in ParameterDefinition.parambrackets:
+            if pos.checkskip(opening):
+                if opening == '':
+                    self.optional = True
+                if not pos.checkskip('$'):
+                    Trace.error('Wrong parameter name, did you mean $' + pos.current() + '?')
+                    return None
+                self.name = pos.skipcurrent()
+                if pos.checkskip('!'):
+                    self.literal = True
+                if not pos.checkskip(closing):
+                    Trace.error('Wrong parameter closing ' + pos.skipcurrent())
+                    return None
+                return self
+        Trace.error('Wrong character in parameter template: ' + pos.skipcurrent())
+        return None
 
+    def read(self, pos, function):
+        "Read the parameter itself using the definition."
+        if self.literal:
+            if self.optional:
+                self.literalvalue = function.parsesquareliteral(pos)
+            else:
+                self.literalvalue = function.parseliteral(pos)
+            if self.literalvalue:
+                self.value = FormulaConstant(self.literalvalue)
+        elif self.optional:
+            self.value = function.parsesquare(pos)
+        else:
+            self.value = function.parseparameter(pos)
 
+    def __str__(self):
+        "Return a printable representation."
+        result = 'param ' + self.name
+        if self.value:
+            result += ': ' + str(self.value)
+        else:
+            result += ' (empty)'
+        return result
 
 
+class ParameterFunction(CommandBit):
+    "A function with a variable number of parameters defined in a template."
+    "The parameters are defined as a parameter definition."
 
+    def readparams(self, readtemplate, pos):
+        "Read the params according to the template."
+        self.params = {}
+        for paramdef in self.paramdefs(readtemplate):
+            paramdef.read(pos, self)
+            self.params'$' + paramdef.name = paramdef
+
+    def paramdefs(self, readtemplate):
+        "Read each param definition in the template"
+        pos = TextPosition(readtemplate)
+        while not pos.finished():
+            paramdef = ParameterDefinition().parse(pos)
+            if paramdef:
+                yield paramdef
+
+    def getparam(self, name):
+        "Get a parameter as parsed."
+        if name not in self.params:
+            return None
+        return self.paramsname
+
+    def getvalue(self, name):
+        "Get the value of a parameter."
+        return self.getparam(name).value
+
+    def getliteralvalue(self, name):
+        "Get the literal value of a parameter."
+        param = self.getparam(name)
+        if not param or not param.literalvalue:
+            return None
+        return param.literalvalue
 
 
-class HeaderParser(Parser):
-  "Parses the LyX header"
+class HybridFunction(ParameterFunction):
+    """
+    A parameter function where the output is also defined using a template.
+    The template can use a number of functions; each function has an associated
+    tag.
+    Example: f0{$1},span class="fbox" defines a function f0 which corresponds
+    to a span of class fbox, yielding <span class="fbox">$1</span>.
+    Literal parameters can be used in tags definitions:
+      f0{$1},span style="color: $p;"
+    yields <span style="color: $p;">$1</span>, where $p is a literal parameter.
+    Sizes can be specified in hybridsizes, e.g. adding parameter sizes. By
+    default the resulting size is the max of all arguments. Sizes are used
+    to generate the right parameters.
+    A function followed by a single / is output as a self-closing XHTML tag:
+      f0/,hr
+    will generate <hr/>.
+    """
+
+    commandmap = FormulaConfig.hybridfunctions
+
+    def parsebit(self, pos):
+        "Parse a function with  and {} parameters"
+        readtemplate = self.translated0
+        writetemplate = self.translated1
+        self.readparams(readtemplate, pos)
+        self.contents = self.writeparams(writetemplate)
+        self.computehybridsize()
+
+    def writeparams(self, writetemplate):
+        "Write all params according to the template"
+        return self.writepos(TextPosition(writetemplate))
+
+    def writepos(self, pos):
+        "Write all params as read in the parse position."
+        result = 
+        while not pos.finished():
+            if pos.checkskip('$'):
+                param = self.writeparam(pos)
+                if param:
+                    result.append(param)
+            elif pos.checkskip('f'):
+                function = self.writefunction(pos)
+                if function:
+                    function.type = None
+                    result.append(function)
+            elif pos.checkskip('('):
+                result.append(self.writebracket('left', '('))
+            elif pos.checkskip(')'):
+                result.append(self.writebracket('right', ')'))
+            else:
+                result.append(FormulaConstant(pos.skipcurrent()))
+        return result
 
-  def parse(self, reader):
-    "Parse header parameters into a dictionary, return the preamble."
-    contents = 
-    self.parseending(reader, lambda: self.parseline(reader, contents))
-    # skip last line
-    reader.nextline()
-    return contents
-
-  def parseline(self, reader, contents):
-    "Parse a single line as a parameter or as a start"
-    line = reader.currentline()
-    if line.startswith(HeaderConfig.parameters'branch'):
-      self.parsebranch(reader)
-      return
-    elif line.startswith(HeaderConfig.parameters'lstset'):
-      LstParser().parselstset(reader)
-      return
-    elif line.startswith(HeaderConfig.parameters'beginpreamble'):
-      contents.append(self.factory.createcontainer(reader))
-      return
-    # no match
-    self.parseparameter(reader)
-
-  def parsebranch(self, reader):
-    "Parse all branch definitions."
-    branch = reader.currentline().split()1
-    reader.nextline()
-    subparser = HeaderParser().complete(HeaderConfig.parameters'endbranch')
-    subparser.parse(reader)
-    options = BranchOptions(branch)
-    for key in subparser.parameters:
-      options.set(key, subparser.parameterskey)
-    Options.branchesbranch = options
-
-  def complete(self, ending):
-    "Complete the parser with the given ending."
-    self.ending = ending
-    return self
-
-class PreambleParser(Parser):
-  "A parser for the LyX preamble."
-
-  preamble = 
-
-  def parse(self, reader):
-    "Parse the full preamble with all statements."
-    self.ending = HeaderConfig.parameters'endpreamble'
-    self.parseending(reader, lambda: self.parsepreambleline(reader))
-    return 
-
-  def parsepreambleline(self, reader):
-    "Parse a single preamble line."
-    PreambleParser.preamble.append(reader.currentline())
-    reader.nextline()
-
-class LstParser(object):
-  "Parse global and local lstparams."
-
-  globalparams = dict()
-
-  def parselstset(self, reader):
-    "Parse a declaration of lstparams in lstset."
-    paramtext = self.extractlstset(reader)
-    if not '{' in paramtext:
-      Trace.error('Missing opening bracket in lstset: ' + paramtext)
-      return
-    lefttext = paramtext.split('{')1
-    croppedtext = lefttext:-1
-    LstParser.globalparams = self.parselstparams(croppedtext)
-
-  def extractlstset(self, reader):
-    "Extract the global lstset parameters."
-    paramtext = ''
-    while not reader.finished():
-      paramtext += reader.currentline()
-      reader.nextline()
-      if paramtext.endswith('}'):
-        return paramtext
-    Trace.error('Could not find end of \\lstset settings; aborting')
-
-  def parsecontainer(self, container):
-    "Parse some lstparams from elyxer.a container."
-    container.lstparams = LstParser.globalparams.copy()
-    paramlist = container.getparameterlist('lstparams')
-    container.lstparams.update(self.parselstparams(paramlist))
-
-  def parselstparams(self, paramlist):
-    "Process a number of lstparams from elyxer.a list."
-    paramdict = dict()
-    for param in paramlist:
-      if not '=' in param:
-        if len(param.strip()) > 0:
-          Trace.error('Invalid listing parameter ' + param)
-      else:
-        key, value = param.split('=', 1)
-        paramdictkey = value
-    return paramdict
-
-
-
-
-class MacroDefinition(CommandBit):
-  "A function that defines a new command (a macro)."
-
-  macros = dict()
-
-  def parsebit(self, pos):
-    "Parse the function that defines the macro."
-    self.output = EmptyOutput()
-    self.parameternumber = 0
-    self.defaults = 
-    self.factory.defining = True
-    self.parseparameters(pos)
-    self.factory.defining = False
-    Trace.debug('New command ' + self.newcommand + ' (' + \
-        unicode(self.parameternumber) + ' parameters)')
-    self.macrosself.newcommand = self
-
-  def parseparameters(self, pos):
-    "Parse all optional parameters (number of parameters, default values)"
-    "and the mandatory definition."
-    self.newcommand = self.parsenewcommand(pos)
-    # parse number of parameters
-    literal = self.parsesquareliteral(pos)
-    if literal:
-      self.parameternumber = int(literal)
-    # parse all default values
-    bracket = self.parsesquare(pos)
-    while bracket:
-      self.defaults.append(bracket)
-      bracket = self.parsesquare(pos)
-    # parse mandatory definition
-    self.definition = self.parseparameter(pos)
-
-  def parsenewcommand(self, pos):
-    "Parse the name of the new command."
-    self.factory.clearskipped(pos)
-    if self.factory.detecttype(Bracket, pos):
-      return self.parseliteral(pos)
-    if self.factory.detecttype(FormulaCommand, pos):
-      return self.factory.create(FormulaCommand).extractcommand(pos)
-    Trace.error('Unknown formula bit in defining function at ' + pos.identifier())
-    return 'unknown'
-
-  def instantiate(self):
-    "Return an instance of the macro."
-    return self.definition.clone()
-
-class MacroParameter(FormulaBit):
-  "A parameter from elyxer.a macro."
-
-  def detect(self, pos):
-    "Find a macro parameter: #n."
-    return pos.checkfor('#')
-
-  def parsebit(self, pos):
-    "Parse the parameter: #n."
-    if not pos.checkskip('#'):
-      Trace.error('Missing parameter start #.')
-      return
-    self.number = int(pos.skipcurrent())
-    self.original = '#' + unicode(self.number)
-    self.contents = TaggedBit().constant('#' + unicode(self.number), 'span class="unknown"')
-
-class MacroFunction(CommandBit):
-  "A function that was defined using a macro."
-
-  commandmap = MacroDefinition.macros
-
-  def parsebit(self, pos):
-    "Parse a number of input parameters."
-    self.output = FilteredOutput()
-    self.values = 
-    macro = self.translated
-    self.parseparameters(pos, macro)
-    self.completemacro(macro)
-
-  def parseparameters(self, pos, macro):
-    "Parse as many parameters as are needed."
-    self.parseoptional(pos, list(macro.defaults))
-    self.parsemandatory(pos, macro.parameternumber - len(macro.defaults))
-    if len(self.values) < macro.parameternumber:
-      Trace.error('Missing parameters in macro ' + unicode(self))
-
-  def parseoptional(self, pos, defaults):
-    "Parse optional parameters."
-    optional = 
-    while self.factory.detecttype(SquareBracket, pos):
-      optional.append(self.parsesquare(pos))
-      if len(optional) > len(defaults):
-        break
-    for value in optional:
-      default = defaults.pop()
-      if len(value.contents) > 0:
-        self.values.append(value)
-      else:
-        self.values.append(default)
-    self.values += defaults
-
-  def parsemandatory(self, pos, number):
-    "Parse a number of mandatory parameters."
-    for index in range(number):
-      parameter = self.parsemacroparameter(pos, number - index)
-      if not parameter:
-        return
-      self.values.append(parameter)
+    def writeparam(self, pos):
+        "Write a single param of the form $0, $x..."
+        name = '$' + pos.skipcurrent()
+        if name not in self.params:
+            Trace.error('Unknown parameter ' + name)
+            return None
+        if not self.paramsname:
+            return None
+        if pos.checkskip('.'):
+            self.paramsname.value.type = pos.globalpha()
+        return self.paramsname.value
+
+    def writefunction(self, pos):
+        "Write a single function f0,...,fn."
+        tag = self.readtag(pos)
+        if not tag:
+            return None
+        if pos.checkskip('/'):
+            # self-closing XHTML tag, such as <hr/>
+            return TaggedBit().selfcomplete(tag)
+        if not pos.checkskip('{'):
+            Trace.error('Function should be defined in {}')
+            return None
+        pos.pushending('}')
+        contents = self.writepos(pos)
+        pos.popending()
+        if len(contents) == 0:
+            return None
+        return TaggedBit().complete(contents, tag)
+
+    def readtag(self, pos):
+        "Get the tag corresponding to the given index. Does parameter substitution."
+        if not pos.current().isdigit():
+            Trace.error('Function should be f0,...,f9: f' + pos.current())
+            return None
+        index = int(pos.skipcurrent())
+        if 2 + index > len(self.translated):
+            Trace.error('Function f' + str(index) + ' is not defined')
+            return None
+        tag = self.translated2 + index
+        if '$' not in tag:
+            return tag
+        for variable in self.params:
+            if variable in tag:
+                param = self.paramsvariable
+                if not param.literal:
+                    Trace.error('Parameters in tag ' + tag + ' should be literal: {' + variable + '!}')
+                    continue
+                if param.literalvalue:
+                    value = param.literalvalue
+                else:
+                    value = ''
+                tag = tag.replace(variable, value)
+        return tag
+
+    def writebracket(self, direction, character):
+        "Return a new bracket looking at the given direction."
+        return self.factory.create(BracketCommand).create(direction, character)
+
+    def computehybridsize(self):
+        "Compute the size of the hybrid function."
+        if self.command not in HybridSize.configsizes:
+            self.computesize()
+            return
+        self.size = HybridSize().getsize(self)
+        # set the size in all elements at first level
+        for element in self.contents:
+            element.size = self.size
+
+
+class HybridSize:
+    "The size associated with a hybrid function."
+
+    configsizes = FormulaConfig.hybridsizes
+
+    def getsize(self, function):
+        "Read the size for a function and parse it."
+        sizestring = self.configsizesfunction.command
+        for name in function.params:
+            if name in sizestring:
+                size = function.paramsname.value.computesize()
+                sizestring = sizestring.replace(name, str(size))
+        if '$' in sizestring:
+            Trace.error('Unconverted variable in hybrid size: ' + sizestring)
+            return 1
+        return eval(sizestring)
 
-  def parsemacroparameter(self, pos, remaining):
-    "Parse a macro parameter. Could be a bracket or a single letter."
-    "If there are just two values remaining and there is a running number,"
-    "parse as two separater numbers."
-    self.factory.clearskipped(pos)
-    if pos.finished():
-      return None
-    if self.factory.detecttype(FormulaNumber, pos):
-      return self.parsenumbers(pos, remaining)
-    return self.parseparameter(pos)
-
-  def parsenumbers(self, pos, remaining):
-    "Parse the remaining parameters as a running number."
-    "For example, 12 would be {1}{2}."
-    number = self.factory.parsetype(FormulaNumber, pos)
-    if not len(number.original) == remaining:
-      return number
-    for digit in number.original:
-      value = self.factory.create(FormulaNumber)
-      value.add(FormulaConstant(digit))
-      value.type = number
-      self.values.append(value)
-    return None
-
-  def completemacro(self, macro):
-    "Complete the macro with the parameters read."
-    self.contents = macro.instantiate()
-    replaced = False * len(self.values)
-    for parameter in self.searchall(MacroParameter):
-      index = parameter.number - 1
-      if index >= len(self.values):
-        Trace.error('Macro parameter index out of bounds: ' + unicode(index))
-        return
-      replacedindex = True
-      parameter.contents = self.valuesindex.clone()
-    for index in range(len(self.values)):
-      if not replacedindex:
-        self.addfilter(index, self.valuesindex)
-
-  def addfilter(self, index, value):
-    "Add a filter for the given parameter number and parameter value."
-    original = '#' + unicode(index + 1)
-    value = ''.join(self.values0.gethtml())
-    self.output.addfilter(original, value)
-
-class FormulaMacro(Formula):
-  "A math macro defined in an inset."
-
-  def __init__(self):
-    self.parser = MacroParser()
-    self.output = EmptyOutput()
-
-  def __unicode__(self):
-    "Return a printable representation."
-    return 'Math macro'
-
-  if sys.version_info >= (3, 0):
-    __str__ = __unicode__
-
-
-FormulaFactory.types +=  MacroParameter 
-
-FormulaCommand.types += 
-    MacroFunction,
-    
 
+FormulaCommand.types += HybridFunction
 
 
 def math2html(formula):
-  "Convert some TeX math to HTML."
-  factory = FormulaFactory()
-  whole = factory.parseformula(formula)
-  FormulaProcessor().process(whole)
-  whole.process()
-  return ''.join(whole.gethtml())
+    "Convert some TeX math to HTML."
+    factory = FormulaFactory()
+    whole = factory.parseformula(formula)
+    FormulaProcessor().process(whole)
+    whole.process()
+    return ''.join(whole.gethtml())
+
 
 def main():
-  "Main function, called if invoked from elyxer.the command line"
-  args = sys.argv
-  Options().parseoptions(args)
-  if len(args) != 1:
-    Trace.error('Usage: math2html.py escaped_string')
-    exit()
-  result = math2html(args0)
-  Trace.message(result)
+    "Main function, called if invoked from the command line"
+    args = sys.argv
+    Options().parseoptions(args)
+    if len(args) != 1:
+        Trace.error('Usage: math2html.py escaped_string')
+        exit()
+    result = math2html(args0)
+    Trace.message(result)
 
-if __name__ == '__main__':
-  main()
 
+if __name__ == '__main__':
+    main()

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/tex2mathml_extern.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/tex2mathml_extern.py Changed

@@ -1,7 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# :Id: $Id: tex2mathml_extern.py 8554 2020-09-04 16:52:11Z milde $
+# :Id: $Id: tex2mathml_extern.py 9250 2022-11-16 14:01:31Z milde $
 # :Copyright: © 2015 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -12,10 +9,12 @@
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 
-# Wrappers for TeX->MathML conversion by external tools
-# =====================================================
+"""Wrappers for TeX->MathML conversion by external tools
+
+This module is provisional:
+the API is not settled and may change with any minor Docutils version.
+"""
 
-from __future__ import print_function
 import subprocess
 
 document_template = r"""\documentclass{article}
@@ -25,24 +24,26 @@
 \end{document}
 """
 
+
 def latexml(math_code, reporter=None):
     """Convert LaTeX math code to MathML with LaTeXML_
 
     .. _LaTeXML: http://dlmf.nist.gov/LaTeXML/
     """
     p = subprocess.Popen('latexml',
-                             '-', # read from stdin
-                             # '--preload=amsmath',
-                             '--inputencoding=utf8',
-                            ,
-                            stdin=subprocess.PIPE,
-                            stdout=subprocess.PIPE,
-                            stderr=subprocess.PIPE,
-                            close_fds=True)
-    p.stdin.write((document_template % math_code).encode('utf8'))
+                          '-',  # read from stdin
+                          '--preload=amsfonts',
+                          '--preload=amsmath',
+                          '--inputencoding=utf8',
+                          ,
+                         stdin=subprocess.PIPE,
+                         stdout=subprocess.PIPE,
+                         stderr=subprocess.PIPE,
+                         close_fds=True)
+    p.stdin.write((document_template % math_code).encode('utf-8'))
     p.stdin.close()
     latexml_code = p.stdout.read()
-    latexml_err = p.stderr.read().decode('utf8')
+    latexml_err = p.stderr.read().decode('utf-8')
     if reporter and (latexml_err.find('Error') >= 0 or not latexml_code):
         reporter.error(latexml_err)
 
@@ -50,17 +51,17 @@
                                '-',
                                '--nonumbersections',
                                '--format=xhtml',
-                               # '--linelength=78', # experimental
+                               # '--linelength=78',  # experimental
                                '--'
-                              ,
+                               ,
                               stdin=subprocess.PIPE,
                               stdout=subprocess.PIPE,
                               stderr=subprocess.PIPE,
                               close_fds=True)
     post_p.stdin.write(latexml_code)
     post_p.stdin.close()
-    result = post_p.stdout.read().decode('utf8')
-    post_p_err = post_p.stderr.read().decode('utf8')
+    result = post_p.stdout.read().decode('utf-8')
+    post_p_err = post_p.stderr.read().decode('utf-8')
     if reporter and (post_p_err.find('Error') >= 0 or not result):
         reporter.error(post_p_err)
 
@@ -71,33 +72,34 @@
         raise SyntaxError(result)
     return result
 
+
 def ttm(math_code, reporter=None):
     """Convert LaTeX math code to MathML with TtM_
 
     .. _TtM: http://hutchinson.belmont.ma.us/tth/mml/
     """
     p = subprocess.Popen('ttm',
-                          # '-i', # italic font for equations. Default roman.
-                          '-u', # unicode character encoding. (Default iso-8859-1).
-                          '-r', # output raw MathML (no preamble or  postlude)
-                         ,
+                          # '-i',  # italic font for equations. Default roman.
+                          '-u',    # unicode encoding. (Default iso-8859-1).
+                          '-r',    # output raw MathML (no wrapper)
+                          ,
                          stdin=subprocess.PIPE,
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE,
                          close_fds=True)
-    p.stdin.write((document_template % math_code).encode('utf8'))
+    p.stdin.write((document_template % math_code).encode('utf-8'))
     p.stdin.close()
     result = p.stdout.read()
-    err = p.stderr.read().decode('utf8')
+    err = p.stderr.read().decode('utf-8')
     if err.find('**** Unknown') >= 0:
-        msg = '\n'.join(line for line in err.splitlines()
-                         if line.startswith('****'))
-        raise SyntaxError('\nMessage from external converter TtM:\n'+ msg)
+        msg = '\n'.join(line for line in err.splitlines()
+                        if line.startswith('****'))
+        raise SyntaxError('\nMessage from external converter TtM:\n'+msg)
     if reporter and err.find('**** Error') >= 0 or not result:
         reporter.error(err)
     start, end = result.find('<math'), result.find('</math>')+7
-    result = resultstart:end
-    return result
+    return resultstart:end
+
 
 def blahtexml(math_code, inline=True, reporter=None):
     """Convert LaTeX math code to MathML with blahtexml_
@@ -111,11 +113,11 @@
                '--other-encoding', 'raw',
                '--doctype-xhtml+mathml',
                '--annotate-TeX',
-              
+               
     if inline:
         mathmode_arg = ''
     else:
-        mathmode_arg = 'mode="display"'
+        mathmode_arg = ' display="block"'
         options.append('--displaymath')
 
     p = subprocess.Popen('blahtexml'+options,
@@ -123,14 +125,15 @@
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE,
                          close_fds=True)
-    p.stdin.write(math_code.encode('utf8'))
+    p.stdin.write(math_code.encode('utf-8'))
     p.stdin.close()
-    result = p.stdout.read().decode('utf8')
-    err = p.stderr.read().decode('utf8')
+    result = p.stdout.read().decode('utf-8')
+    err = p.stderr.read().decode('utf-8')
 
     if result.find('<error>') >= 0:
-        raise SyntaxError('\nMessage from external converter blahtexml:\n'
-                +resultresult.find('<message>')+9:result.find('</message>'))
+        msg = resultresult.find('<message>')+9:result.find('</message>')
+        raise SyntaxError('\nMessage from external converter blahtexml:\n%s'
+                          % msg)
     if reporter and (err.find('**** Error') >= 0 or not result):
         reporter.error(err)
     start, end = result.find('<markup>')+9, result.find('</markup>')
@@ -138,11 +141,45 @@
               '%s</math>\n') % (mathmode_arg, resultstart:end)
     return result
 
+
+def pandoc(math_code, reporter=None):
+    """Convert LaTeX math code to MathML with pandoc_
+
+    .. _pandoc: https://pandoc.org/
+    """
+    p = subprocess.Popen('pandoc',
+                          '--mathml',
+                          '--from=latex',
+                          ,
+                         stdin=subprocess.PIPE,
+                         stdout=subprocess.PIPE,
+                         stderr=subprocess.PIPE,
+                         close_fds=True)
+    p.stdin.write(math_code.encode('utf-8'))
+    p.stdin.close()
+    result = p.stdout.read().decode('utf-8')
+    err = p.stderr.read().decode('utf-8').strip()
+    x = p.wait()
+
+    if err:
+        if reporter:
+            reporter.error(err)
+        raise SyntaxError('\nError message from external converter pandoc:\n%s'
+                          % err)
+    if x != 0:
+        raise SyntaxError('\nError code from external converter pandoc:\n%s'
+                          % x)
+
+    start, end = result.find('<math'), result.find('</math>')+7
+    return resultstart:end
+
+
 # self-test
 
 if __name__ == "__main__":
-    example = (u'\\frac{\\partial \\sin^2(\\alpha)}{\\partial \\vec r}'
-               u'\\varpi \\, \\text{Grüße}')
-    # print(latexml(example).encode('utf8'))
-    # print(ttm(example))
-    print(blahtexml(example).encode('utf8'))
+    example = ('\\frac{\\partial \\sin^2(\\alpha)}{\\partial \\vec r}'
+               '\\varpi \\mathbb{R} \\, \\text{Grüße}')
+    # print(latexml('$'+example+'$'))
+    # print(ttm('$'+example.replace('\\mathbb{R}', '')+'$'))
+    print(blahtexml(example))
+    # print(pandoc('$'+example+'$'))

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/tex2unichar.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/tex2unichar.py Changed

@@ -1,662 +1,730 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python3
 
 # LaTeX math to Unicode symbols translation dictionaries.
 # Generated with ``write_tex2unichar.py`` from the data in
 # http://milde.users.sourceforge.net/LUCR/Math/
 
-# Includes commands from: wasysym, stmaryrd, mathdots, mathabx, esint, bbold, amsxtra, amsmath, amssymb, standard LaTeX
+# Includes commands from:
+#   standard LaTeX
+#   amssymb
+#   amsmath
+#   amsxtra
+#   bbold
+#   esint
+#   mathabx
+#   mathdots
+#   txfonts
+#   stmaryrd
+#   wasysym
 
 mathaccent = {
-    'acute': u'\u0301', # x́ COMBINING ACUTE ACCENT
-    'bar': u'\u0304', # x̄ COMBINING MACRON
-    'breve': u'\u0306', # x̆ COMBINING BREVE
-    'check': u'\u030c', # x̌ COMBINING CARON
-    'ddddot': u'\u20dc', # x⃜ COMBINING FOUR DOTS ABOVE
-    'dddot': u'\u20db', # x⃛ COMBINING THREE DOTS ABOVE
-    'ddot': u'\u0308', # ẍ COMBINING DIAERESIS
-    'dot': u'\u0307', # ẋ COMBINING DOT ABOVE
-    'grave': u'\u0300', # x̀ COMBINING GRAVE ACCENT
-    'hat': u'\u0302', # x̂ COMBINING CIRCUMFLEX ACCENT
-    'mathring': u'\u030a', # x̊ COMBINING RING ABOVE
-    'not': u'\u0338', # x̸ COMBINING LONG SOLIDUS OVERLAY
-    'overleftarrow': u'\u20d6', # x⃖ COMBINING LEFT ARROW ABOVE
-    'overleftrightarrow': u'\u20e1', # x⃡ COMBINING LEFT RIGHT ARROW ABOVE
-    'overline': u'\u0305', # x̅ COMBINING OVERLINE
-    'overrightarrow': u'\u20d7', # x⃗ COMBINING RIGHT ARROW ABOVE
-    'tilde': u'\u0303', # x̃ COMBINING TILDE
-    'underbar': u'\u0331', # x̱ COMBINING MACRON BELOW
-    'underleftarrow': u'\u20ee', # x⃮ COMBINING LEFT ARROW BELOW
-    'underline': u'\u0332', # x̲ COMBINING LOW LINE
-    'underrightarrow': u'\u20ef', # x⃯ COMBINING RIGHT ARROW BELOW
-    'vec': u'\u20d7', # x⃗ COMBINING RIGHT ARROW ABOVE
-    'widehat': u'\u0302', # x̂ COMBINING CIRCUMFLEX ACCENT
-    'widetilde': u'\u0303', # x̃ COMBINING TILDE
+    'acute': '\u0301',  #  ́ COMBINING ACUTE ACCENT
+    'bar': '\u0304',  #  ̄ COMBINING MACRON
+    'breve': '\u0306',  #  ̆ COMBINING BREVE
+    'check': '\u030c',  #  ̌ COMBINING CARON
+    'ddddot': '\u20dc',  #  ⃜ COMBINING FOUR DOTS ABOVE
+    'dddot': '\u20db',  #  ⃛ COMBINING THREE DOTS ABOVE
+    'ddot': '\u0308',  #  ̈ COMBINING DIAERESIS
+    'dot': '\u0307',  #  ̇ COMBINING DOT ABOVE
+    'grave': '\u0300',  #  ̀ COMBINING GRAVE ACCENT
+    'hat': '\u0302',  #  ̂ COMBINING CIRCUMFLEX ACCENT
+    'mathring': '\u030a',  #  ̊ COMBINING RING ABOVE
+    'not': '\u0338',  #  ̸ COMBINING LONG SOLIDUS OVERLAY
+    'overleftrightarrow': '\u20e1',  #  ⃡ COMBINING LEFT RIGHT ARROW ABOVE
+    'overline': '\u0305',  #  ̅ COMBINING OVERLINE
+    'tilde': '\u0303',  #  ̃ COMBINING TILDE
+    'underbar': '\u0331',  #  ̱ COMBINING MACRON BELOW
+    'underleftarrow': '\u20ee',  #  ⃮ COMBINING LEFT ARROW BELOW
+    'underline': '\u0332',  #  ̲ COMBINING LOW LINE
+    'underrightarrow': '\u20ef',  #  ⃯ COMBINING RIGHT ARROW BELOW
+    'vec': '\u20d7',  #  ⃗ COMBINING RIGHT ARROW ABOVE
     }
+
 mathalpha = {
-    'Bbbk': u'\U0001d55c', # 𝕜 MATHEMATICAL DOUBLE-STRUCK SMALL K
-    'Delta': u'\u0394', # Δ GREEK CAPITAL LETTER DELTA
-    'Gamma': u'\u0393', # Γ GREEK CAPITAL LETTER GAMMA
-    'Im': u'\u2111', # ℑ BLACK-LETTER CAPITAL I
-    'Lambda': u'\u039b', # Λ GREEK CAPITAL LETTER LAMDA
-    'Omega': u'\u03a9', # Ω GREEK CAPITAL LETTER OMEGA
-    'Phi': u'\u03a6', # Φ GREEK CAPITAL LETTER PHI
-    'Pi': u'\u03a0', # Π GREEK CAPITAL LETTER PI
-    'Psi': u'\u03a8', # Ψ GREEK CAPITAL LETTER PSI
-    'Re': u'\u211c', # ℜ BLACK-LETTER CAPITAL R
-    'Sigma': u'\u03a3', # Σ GREEK CAPITAL LETTER SIGMA
-    'Theta': u'\u0398', # Θ GREEK CAPITAL LETTER THETA
-    'Upsilon': u'\u03a5', # Υ GREEK CAPITAL LETTER UPSILON
-    'Xi': u'\u039e', # Ξ GREEK CAPITAL LETTER XI
-    'aleph': u'\u2135', # ℵ ALEF SYMBOL
-    'alpha': u'\u03b1', # α GREEK SMALL LETTER ALPHA
-    'beta': u'\u03b2', # β GREEK SMALL LETTER BETA
-    'beth': u'\u2136', # ℶ BET SYMBOL
-    'chi': u'\u03c7', # χ GREEK SMALL LETTER CHI
-    'daleth': u'\u2138', # ℸ DALET SYMBOL
-    'delta': u'\u03b4', # δ GREEK SMALL LETTER DELTA
-    'digamma': u'\u03dc', # Ϝ GREEK LETTER DIGAMMA
-    'ell': u'\u2113', # ℓ SCRIPT SMALL L
-    'epsilon': u'\u03f5', # ϵ GREEK LUNATE EPSILON SYMBOL
-    'eta': u'\u03b7', # η GREEK SMALL LETTER ETA
-    'eth': u'\xf0', # ð LATIN SMALL LETTER ETH
-    'gamma': u'\u03b3', # γ GREEK SMALL LETTER GAMMA
-    'gimel': u'\u2137', # ℷ GIMEL SYMBOL
-    'hbar': u'\u210f', # ℏ PLANCK CONSTANT OVER TWO PI
-    'hslash': u'\u210f', # ℏ PLANCK CONSTANT OVER TWO PI
-    'imath': u'\u0131', # ı LATIN SMALL LETTER DOTLESS I
-    'iota': u'\u03b9', # ι GREEK SMALL LETTER IOTA
-    'jmath': u'\u0237', # ȷ LATIN SMALL LETTER DOTLESS J
-    'kappa': u'\u03ba', # κ GREEK SMALL LETTER KAPPA
-    'lambda': u'\u03bb', # λ GREEK SMALL LETTER LAMDA
-    'mu': u'\u03bc', # μ GREEK SMALL LETTER MU
-    'nu': u'\u03bd', # ν GREEK SMALL LETTER NU
-    'omega': u'\u03c9', # ω GREEK SMALL LETTER OMEGA
-    'phi': u'\u03d5', # ϕ GREEK PHI SYMBOL
-    'pi': u'\u03c0', # π GREEK SMALL LETTER PI
-    'psi': u'\u03c8', # ψ GREEK SMALL LETTER PSI
-    'rho': u'\u03c1', # ρ GREEK SMALL LETTER RHO
-    'sigma': u'\u03c3', # σ GREEK SMALL LETTER SIGMA
-    'tau': u'\u03c4', # τ GREEK SMALL LETTER TAU
-    'theta': u'\u03b8', # θ GREEK SMALL LETTER THETA
-    'upsilon': u'\u03c5', # υ GREEK SMALL LETTER UPSILON
-    'varDelta': u'\U0001d6e5', # 𝛥 MATHEMATICAL ITALIC CAPITAL DELTA
-    'varGamma': u'\U0001d6e4', # 𝛤 MATHEMATICAL ITALIC CAPITAL GAMMA
-    'varLambda': u'\U0001d6ec', # 𝛬 MATHEMATICAL ITALIC CAPITAL LAMDA
-    'varOmega': u'\U0001d6fa', # 𝛺 MATHEMATICAL ITALIC CAPITAL OMEGA
-    'varPhi': u'\U0001d6f7', # 𝛷 MATHEMATICAL ITALIC CAPITAL PHI
-    'varPi': u'\U0001d6f1', # 𝛱 MATHEMATICAL ITALIC CAPITAL PI
-    'varPsi': u'\U0001d6f9', # 𝛹 MATHEMATICAL ITALIC CAPITAL PSI
-    'varSigma': u'\U0001d6f4', # 𝛴 MATHEMATICAL ITALIC CAPITAL SIGMA
-    'varTheta': u'\U0001d6e9', # 𝛩 MATHEMATICAL ITALIC CAPITAL THETA
-    'varUpsilon': u'\U0001d6f6', # 𝛶 MATHEMATICAL ITALIC CAPITAL UPSILON
-    'varXi': u'\U0001d6ef', # 𝛯 MATHEMATICAL ITALIC CAPITAL XI
-    'varepsilon': u'\u03b5', # ε GREEK SMALL LETTER EPSILON
-    'varkappa': u'\U0001d718', # 𝜘 MATHEMATICAL ITALIC KAPPA SYMBOL
-    'varphi': u'\u03c6', # φ GREEK SMALL LETTER PHI
-    'varpi': u'\u03d6', # ϖ GREEK PI SYMBOL
-    'varrho': u'\u03f1', # ϱ GREEK RHO SYMBOL
-    'varsigma': u'\u03c2', # ς GREEK SMALL LETTER FINAL SIGMA
-    'vartheta': u'\u03d1', # ϑ GREEK THETA SYMBOL
-    'wp': u'\u2118', # ℘ SCRIPT CAPITAL P
-    'xi': u'\u03be', # ξ GREEK SMALL LETTER XI
-    'zeta': u'\u03b6', # ζ GREEK SMALL LETTER ZETA
+    'Bbbk': '\U0001d55c',  # 𝕜 MATHEMATICAL DOUBLE-STRUCK SMALL K
+    'Delta': '\u0394',  # Δ GREEK CAPITAL LETTER DELTA
+    'Gamma': '\u0393',  # Γ GREEK CAPITAL LETTER GAMMA
+    'Im': '\u2111',  # ℑ BLACK-LETTER CAPITAL I
+    'Lambda': '\u039b',  # Λ GREEK CAPITAL LETTER LAMDA
+    'Omega': '\u03a9',  # Ω GREEK CAPITAL LETTER OMEGA
+    'Phi': '\u03a6',  # Φ GREEK CAPITAL LETTER PHI
+    'Pi': '\u03a0',  # Π GREEK CAPITAL LETTER PI
+    'Psi': '\u03a8',  # Ψ GREEK CAPITAL LETTER PSI
+    'Re': '\u211c',  # ℜ BLACK-LETTER CAPITAL R
+    'Sigma': '\u03a3',  # Σ GREEK CAPITAL LETTER SIGMA
+    'Theta': '\u0398',  # Θ GREEK CAPITAL LETTER THETA
+    'Upsilon': '\u03a5',  # Υ GREEK CAPITAL LETTER UPSILON
+    'Xi': '\u039e',  # Ξ GREEK CAPITAL LETTER XI
+    'aleph': '\u2135',  # ℵ ALEF SYMBOL
+    'alpha': '\u03b1',  # α GREEK SMALL LETTER ALPHA
+    'beta': '\u03b2',  # β GREEK SMALL LETTER BETA
+    'beth': '\u2136',  # ℶ BET SYMBOL
+    'chi': '\u03c7',  # χ GREEK SMALL LETTER CHI
+    'daleth': '\u2138',  # ℸ DALET SYMBOL
+    'delta': '\u03b4',  # δ GREEK SMALL LETTER DELTA
+    'digamma': '\u03dd',  # ϝ GREEK SMALL LETTER DIGAMMA
+    'ell': '\u2113',  # ℓ SCRIPT SMALL L
+    'epsilon': '\u03f5',  # ϵ GREEK LUNATE EPSILON SYMBOL
+    'eta': '\u03b7',  # η GREEK SMALL LETTER ETA
+    'eth': '\xf0',  # ð LATIN SMALL LETTER ETH
+    'gamma': '\u03b3',  # γ GREEK SMALL LETTER GAMMA
+    'gimel': '\u2137',  # ℷ GIMEL SYMBOL
+    'hslash': '\u210f',  # ℏ PLANCK CONSTANT OVER TWO PI
+    'imath': '\u0131',  # ı LATIN SMALL LETTER DOTLESS I
+    'iota': '\u03b9',  # ι GREEK SMALL LETTER IOTA
+    'jmath': '\u0237',  # ȷ LATIN SMALL LETTER DOTLESS J
+    'kappa': '\u03ba',  # κ GREEK SMALL LETTER KAPPA
+    'lambda': '\u03bb',  # λ GREEK SMALL LETTER LAMDA
+    'mu': '\u03bc',  # μ GREEK SMALL LETTER MU
+    'nu': '\u03bd',  # ν GREEK SMALL LETTER NU
+    'omega': '\u03c9',  # ω GREEK SMALL LETTER OMEGA
+    'phi': '\u03d5',  # ϕ GREEK PHI SYMBOL
+    'pi': '\u03c0',  # π GREEK SMALL LETTER PI
+    'psi': '\u03c8',  # ψ GREEK SMALL LETTER PSI
+    'rho': '\u03c1',  # ρ GREEK SMALL LETTER RHO
+    'sigma': '\u03c3',  # σ GREEK SMALL LETTER SIGMA
+    'tau': '\u03c4',  # τ GREEK SMALL LETTER TAU
+    'theta': '\u03b8',  # θ GREEK SMALL LETTER THETA
+    'upsilon': '\u03c5',  # υ GREEK SMALL LETTER UPSILON
+    'varDelta': '\U0001d6e5',  # 𝛥 MATHEMATICAL ITALIC CAPITAL DELTA
+    'varGamma': '\U0001d6e4',  # 𝛤 MATHEMATICAL ITALIC CAPITAL GAMMA
+    'varLambda': '\U0001d6ec',  # 𝛬 MATHEMATICAL ITALIC CAPITAL LAMDA
+    'varOmega': '\U0001d6fa',  # 𝛺 MATHEMATICAL ITALIC CAPITAL OMEGA
+    'varPhi': '\U0001d6f7',  # 𝛷 MATHEMATICAL ITALIC CAPITAL PHI
+    'varPi': '\U0001d6f1',  # 𝛱 MATHEMATICAL ITALIC CAPITAL PI
+    'varPsi': '\U0001d6f9',  # 𝛹 MATHEMATICAL ITALIC CAPITAL PSI
+    'varSigma': '\U0001d6f4',  # 𝛴 MATHEMATICAL ITALIC CAPITAL SIGMA
+    'varTheta': '\U0001d6e9',  # 𝛩 MATHEMATICAL ITALIC CAPITAL THETA
+    'varUpsilon': '\U0001d6f6',  # 𝛶 MATHEMATICAL ITALIC CAPITAL UPSILON
+    'varXi': '\U0001d6ef',  # 𝛯 MATHEMATICAL ITALIC CAPITAL XI
+    'varepsilon': '\u03b5',  # ε GREEK SMALL LETTER EPSILON
+    'varkappa': '\u03f0',  # ϰ GREEK KAPPA SYMBOL
+    'varphi': '\u03c6',  # φ GREEK SMALL LETTER PHI
+    'varpi': '\u03d6',  # ϖ GREEK PI SYMBOL
+    'varrho': '\u03f1',  # ϱ GREEK RHO SYMBOL
+    'varsigma': '\u03c2',  # ς GREEK SMALL LETTER FINAL SIGMA
+    'vartheta': '\u03d1',  # ϑ GREEK THETA SYMBOL
+    'wp': '\u2118',  # ℘ SCRIPT CAPITAL P
+    'xi': '\u03be',  # ξ GREEK SMALL LETTER XI
+    'zeta': '\u03b6',  # ζ GREEK SMALL LETTER ZETA
     }
+
 mathbin = {
-    'Cap': u'\u22d2', # ⋒ DOUBLE INTERSECTION
-    'Circle': u'\u25cb', # ○ WHITE CIRCLE
-    'Cup': u'\u22d3', # ⋓ DOUBLE UNION
-    'LHD': u'\u25c0', # ◀ BLACK LEFT-POINTING TRIANGLE
-    'RHD': u'\u25b6', # ▶ BLACK RIGHT-POINTING TRIANGLE
-    'amalg': u'\u2a3f', # ⨿ AMALGAMATION OR COPRODUCT
-    'ast': u'\u2217', # ∗ ASTERISK OPERATOR
-    'barwedge': u'\u22bc', # ⊼ NAND
-    'bigtriangledown': u'\u25bd', # ▽ WHITE DOWN-POINTING TRIANGLE
-    'bigtriangleup': u'\u25b3', # △ WHITE UP-POINTING TRIANGLE
-    'bindnasrepma': u'\u214b', # ⅋ TURNED AMPERSAND
-    'blacklozenge': u'\u29eb', # ⧫ BLACK LOZENGE
-    'blacktriangledown': u'\u25be', # ▾ BLACK DOWN-POINTING SMALL TRIANGLE
-    'blacktriangleleft': u'\u25c2', # ◂ BLACK LEFT-POINTING SMALL TRIANGLE
-    'blacktriangleright': u'\u25b8', # ▸ BLACK RIGHT-POINTING SMALL TRIANGLE
-    'blacktriangleup': u'\u25b4', # ▴ BLACK UP-POINTING SMALL TRIANGLE
-    'boxast': u'\u29c6', # ⧆ SQUARED ASTERISK
-    'boxbar': u'\u25eb', # ◫ WHITE SQUARE WITH VERTICAL BISECTING LINE
-    'boxbox': u'\u29c8', # ⧈ SQUARED SQUARE
-    'boxbslash': u'\u29c5', # ⧅ SQUARED FALLING DIAGONAL SLASH
-    'boxcircle': u'\u29c7', # ⧇ SQUARED SMALL CIRCLE
-    'boxdot': u'\u22a1', # ⊡ SQUARED DOT OPERATOR
-    'boxminus': u'\u229f', # ⊟ SQUARED MINUS
-    'boxplus': u'\u229e', # ⊞ SQUARED PLUS
-    'boxslash': u'\u29c4', # ⧄ SQUARED RISING DIAGONAL SLASH
-    'boxtimes': u'\u22a0', # ⊠ SQUARED TIMES
-    'bullet': u'\u2219', # ∙ BULLET OPERATOR
-    'cap': u'\u2229', # ∩ INTERSECTION
-    'cdot': u'\u22c5', # ⋅ DOT OPERATOR
-    'circ': u'\u2218', # ∘ RING OPERATOR
-    'circledast': u'\u229b', # ⊛ CIRCLED ASTERISK OPERATOR
-    'circledcirc': u'\u229a', # ⊚ CIRCLED RING OPERATOR
-    'circleddash': u'\u229d', # ⊝ CIRCLED DASH
-    'cup': u'\u222a', # ∪ UNION
-    'curlyvee': u'\u22ce', # ⋎ CURLY LOGICAL OR
-    'curlywedge': u'\u22cf', # ⋏ CURLY LOGICAL AND
-    'dagger': u'\u2020', # † DAGGER
-    'ddagger': u'\u2021', # ‡ DOUBLE DAGGER
-    'diamond': u'\u22c4', # ⋄ DIAMOND OPERATOR
-    'div': u'\xf7', # ÷ DIVISION SIGN
-    'divideontimes': u'\u22c7', # ⋇ DIVISION TIMES
-    'dotplus': u'\u2214', # ∔ DOT PLUS
-    'doublebarwedge': u'\u2a5e', # ⩞ LOGICAL AND WITH DOUBLE OVERBAR
-    'intercal': u'\u22ba', # ⊺ INTERCALATE
-    'interleave': u'\u2af4', # ⫴ TRIPLE VERTICAL BAR BINARY RELATION
-    'land': u'\u2227', # ∧ LOGICAL AND
-    'leftthreetimes': u'\u22cb', # ⋋ LEFT SEMIDIRECT PRODUCT
-    'lhd': u'\u25c1', # ◁ WHITE LEFT-POINTING TRIANGLE
-    'lor': u'\u2228', # ∨ LOGICAL OR
-    'ltimes': u'\u22c9', # ⋉ LEFT NORMAL FACTOR SEMIDIRECT PRODUCT
-    'mp': u'\u2213', # ∓ MINUS-OR-PLUS SIGN
-    'odot': u'\u2299', # ⊙ CIRCLED DOT OPERATOR
-    'ominus': u'\u2296', # ⊖ CIRCLED MINUS
-    'oplus': u'\u2295', # ⊕ CIRCLED PLUS
-    'oslash': u'\u2298', # ⊘ CIRCLED DIVISION SLASH
-    'otimes': u'\u2297', # ⊗ CIRCLED TIMES
-    'pm': u'\xb1', # ± PLUS-MINUS SIGN
-    'rhd': u'\u25b7', # ▷ WHITE RIGHT-POINTING TRIANGLE
-    'rightthreetimes': u'\u22cc', # ⋌ RIGHT SEMIDIRECT PRODUCT
-    'rtimes': u'\u22ca', # ⋊ RIGHT NORMAL FACTOR SEMIDIRECT PRODUCT
-    'setminus': u'\u29f5', # ⧵ REVERSE SOLIDUS OPERATOR
-    'slash': u'\u2215', # ∕ DIVISION SLASH
-    'smallsetminus': u'\u2216', # ∖ SET MINUS
-    'smalltriangledown': u'\u25bf', # ▿ WHITE DOWN-POINTING SMALL TRIANGLE
-    'smalltriangleleft': u'\u25c3', # ◃ WHITE LEFT-POINTING SMALL TRIANGLE
-    'smalltriangleright': u'\u25b9', # ▹ WHITE RIGHT-POINTING SMALL TRIANGLE
-    'smalltriangleup': u'\u25b5', # ▵ WHITE UP-POINTING SMALL TRIANGLE
-    'sqcap': u'\u2293', # ⊓ SQUARE CAP
-    'sqcup': u'\u2294', # ⊔ SQUARE CUP
-    'sslash': u'\u2afd', # ⫽ DOUBLE SOLIDUS OPERATOR
-    'star': u'\u22c6', # ⋆ STAR OPERATOR
-    'talloblong': u'\u2afe', # ⫾ WHITE VERTICAL BAR
-    'times': u'\xd7', # × MULTIPLICATION SIGN
-    'triangle': u'\u25b3', # △ WHITE UP-POINTING TRIANGLE
-    'triangledown': u'\u25bf', # ▿ WHITE DOWN-POINTING SMALL TRIANGLE
-    'triangleleft': u'\u25c3', # ◃ WHITE LEFT-POINTING SMALL TRIANGLE
-    'triangleright': u'\u25b9', # ▹ WHITE RIGHT-POINTING SMALL TRIANGLE
-    'uplus': u'\u228e', # ⊎ MULTISET UNION
-    'vartriangle': u'\u25b3', # △ WHITE UP-POINTING TRIANGLE
-    'vee': u'\u2228', # ∨ LOGICAL OR
-    'veebar': u'\u22bb', # ⊻ XOR
-    'wedge': u'\u2227', # ∧ LOGICAL AND
-    'wr': u'\u2240', # ≀ WREATH PRODUCT
+    'Cap': '\u22d2',  # ⋒ DOUBLE INTERSECTION
+    'Circle': '\u25cb',  # ○ WHITE CIRCLE
+    'Cup': '\u22d3',  # ⋓ DOUBLE UNION
+    'LHD': '\u25c0',  # ◀ BLACK LEFT-POINTING TRIANGLE
+    'RHD': '\u25b6',  # ▶ BLACK RIGHT-POINTING TRIANGLE
+    'amalg': '\u2a3f',  # ⨿ AMALGAMATION OR COPRODUCT
+    'ast': '\u2217',  # ∗ ASTERISK OPERATOR
+    'barwedge': '\u22bc',  # ⊼ NAND
+    'bigcirc': '\u25ef',  # ◯ LARGE CIRCLE
+    'bigtriangledown': '\u25bd',  # ▽ WHITE DOWN-POINTING TRIANGLE
+    'bigtriangleup': '\u25b3',  # △ WHITE UP-POINTING TRIANGLE
+    'bindnasrepma': '\u214b',  # ⅋ TURNED AMPERSAND
+    'blacklozenge': '\u29eb',  # ⧫ BLACK LOZENGE
+    'boxast': '\u29c6',  # ⧆ SQUARED ASTERISK
+    'boxbar': '\u25eb',  # ◫ WHITE SQUARE WITH VERTICAL BISECTING LINE
+    'boxbox': '\u29c8',  # ⧈ SQUARED SQUARE
+    'boxbslash': '\u29c5',  # ⧅ SQUARED FALLING DIAGONAL SLASH
+    'boxcircle': '\u29c7',  # ⧇ SQUARED SMALL CIRCLE
+    'boxdot': '\u22a1',  # ⊡ SQUARED DOT OPERATOR
+    'boxminus': '\u229f',  # ⊟ SQUARED MINUS
+    'boxplus': '\u229e',  # ⊞ SQUARED PLUS
+    'boxslash': '\u29c4',  # ⧄ SQUARED RISING DIAGONAL SLASH
+    'boxtimes': '\u22a0',  # ⊠ SQUARED TIMES
+    'bullet': '\u2022',  # • BULLET
+    'cap': '\u2229',  # ∩ INTERSECTION
+    'cdot': '\u22c5',  # ⋅ DOT OPERATOR
+    'circ': '\u2218',  # ∘ RING OPERATOR
+    'circledast': '\u229b',  # ⊛ CIRCLED ASTERISK OPERATOR
+    'circledbslash': '\u29b8',  # ⦸ CIRCLED REVERSE SOLIDUS
+    'circledcirc': '\u229a',  # ⊚ CIRCLED RING OPERATOR
+    'circleddash': '\u229d',  # ⊝ CIRCLED DASH
+    'circledgtr': '\u29c1',  # ⧁ CIRCLED GREATER-THAN
+    'circledless': '\u29c0',  # ⧀ CIRCLED LESS-THAN
+    'cup': '\u222a',  # ∪ UNION
+    'curlyvee': '\u22ce',  # ⋎ CURLY LOGICAL OR
+    'curlywedge': '\u22cf',  # ⋏ CURLY LOGICAL AND
+    'dagger': '\u2020',  # † DAGGER
+    'ddagger': '\u2021',  # ‡ DOUBLE DAGGER
+    'diamond': '\u22c4',  # ⋄ DIAMOND OPERATOR
+    'div': '\xf7',  # ÷ DIVISION SIGN
+    'divideontimes': '\u22c7',  # ⋇ DIVISION TIMES
+    'dotplus': '\u2214',  # ∔ DOT PLUS
+    'doublebarwedge': '\u2a5e',  # ⩞ LOGICAL AND WITH DOUBLE OVERBAR
+    'gtrdot': '\u22d7',  # ⋗ GREATER-THAN WITH DOT
+    'intercal': '\u22ba',  # ⊺ INTERCALATE
+    'interleave': '\u2af4',  # ⫴ TRIPLE VERTICAL BAR BINARY RELATION
+    'invamp': '\u214b',  # ⅋ TURNED AMPERSAND
+    'land': '\u2227',  # ∧ LOGICAL AND
+    'leftthreetimes': '\u22cb',  # ⋋ LEFT SEMIDIRECT PRODUCT
+    'lessdot': '\u22d6',  # ⋖ LESS-THAN WITH DOT
+    'lor': '\u2228',  # ∨ LOGICAL OR
+    'ltimes': '\u22c9',  # ⋉ LEFT NORMAL FACTOR SEMIDIRECT PRODUCT
+    'mp': '\u2213',  # ∓ MINUS-OR-PLUS SIGN
+    'odot': '\u2299',  # ⊙ CIRCLED DOT OPERATOR
+    'ominus': '\u2296',  # ⊖ CIRCLED MINUS
+    'oplus': '\u2295',  # ⊕ CIRCLED PLUS
+    'oslash': '\u2298',  # ⊘ CIRCLED DIVISION SLASH
+    'otimes': '\u2297',  # ⊗ CIRCLED TIMES
+    'pm': '\xb1',  # ± PLUS-MINUS SIGN
+    'rightthreetimes': '\u22cc',  # ⋌ RIGHT SEMIDIRECT PRODUCT
+    'rtimes': '\u22ca',  # ⋊ RIGHT NORMAL FACTOR SEMIDIRECT PRODUCT
+    'setminus': '\u29f5',  # ⧵ REVERSE SOLIDUS OPERATOR
+    'slash': '\u2215',  # ∕ DIVISION SLASH
+    'smallsetminus': '\u2216',  # ∖ SET MINUS
+    'smalltriangledown': '\u25bf',  # ▿ WHITE DOWN-POINTING SMALL TRIANGLE
+    'smalltriangleleft': '\u25c3',  # ◃ WHITE LEFT-POINTING SMALL TRIANGLE
+    'smalltriangleright': '\u25b9',  # ▹ WHITE RIGHT-POINTING SMALL TRIANGLE
+    'sqcap': '\u2293',  # ⊓ SQUARE CAP
+    'sqcup': '\u2294',  # ⊔ SQUARE CUP
+    'sslash': '\u2afd',  # ⫽ DOUBLE SOLIDUS OPERATOR
+    'star': '\u22c6',  # ⋆ STAR OPERATOR
+    'talloblong': '\u2afe',  # ⫾ WHITE VERTICAL BAR
+    'times': '\xd7',  # × MULTIPLICATION SIGN
+    'triangleleft': '\u25c3',  # ◃ WHITE LEFT-POINTING SMALL TRIANGLE
+    'triangleright': '\u25b9',  # ▹ WHITE RIGHT-POINTING SMALL TRIANGLE
+    'uplus': '\u228e',  # ⊎ MULTISET UNION
+    'vee': '\u2228',  # ∨ LOGICAL OR
+    'veebar': '\u22bb',  # ⊻ XOR
+    'wedge': '\u2227',  # ∧ LOGICAL AND
+    'wr': '\u2240',  # ≀ WREATH PRODUCT
     }
+
 mathclose = {
-    'Rbag': u'\u27c6', # ⟆ RIGHT S-SHAPED BAG DELIMITER
-    'lrcorner': u'\u231f', # ⌟ BOTTOM RIGHT CORNER
-    'rangle': u'\u27e9', # ⟩ MATHEMATICAL RIGHT ANGLE BRACKET
-    'rbag': u'\u27c6', # ⟆ RIGHT S-SHAPED BAG DELIMITER
-    'rbrace': u'}', # } RIGHT CURLY BRACKET
-    'rbrack': u'', #  RIGHT SQUARE BRACKET
-    'rceil': u'\u2309', # ⌉ RIGHT CEILING
-    'rfloor': u'\u230b', # ⌋ RIGHT FLOOR
-    'rgroup': u'\u27ef', # ⟯ MATHEMATICAL RIGHT FLATTENED PARENTHESIS
-    'rrbracket': u'\u27e7', # ⟧ MATHEMATICAL RIGHT WHITE SQUARE BRACKET
-    'rrparenthesis': u'\u2988', # ⦈ Z NOTATION RIGHT IMAGE BRACKET
-    'urcorner': u'\u231d', # ⌝ TOP RIGHT CORNER
-    '}': u'}', # } RIGHT CURLY BRACKET
+    'Rbag': '\u27c6',  # ⟆ RIGHT S-SHAPED BAG DELIMITER
+    'lrcorner': '\u231f',  # ⌟ BOTTOM RIGHT CORNER
+    'rangle': '\u27e9',  # ⟩ MATHEMATICAL RIGHT ANGLE BRACKET
+    'rbag': '\u27c6',  # ⟆ RIGHT S-SHAPED BAG DELIMITER
+    'rbrace': '}',  # } RIGHT CURLY BRACKET
+    'rbrack': '',  #  RIGHT SQUARE BRACKET
+    'rceil': '\u2309',  # ⌉ RIGHT CEILING
+    'rfloor': '\u230b',  # ⌋ RIGHT FLOOR
+    'rgroup': '\u27ef',  # ⟯ MATHEMATICAL RIGHT FLATTENED PARENTHESIS
+    'rrbracket': '\u27e7',  # ⟧ MATHEMATICAL RIGHT WHITE SQUARE BRACKET
+    'rrparenthesis': '\u2988',  # ⦈ Z NOTATION RIGHT IMAGE BRACKET
+    'urcorner': '\u231d',  # ⌝ TOP RIGHT CORNER
+    '}': '}',  # } RIGHT CURLY BRACKET
     }
+
 mathfence = {
-    'Vert': u'\u2016', # ‖ DOUBLE VERTICAL LINE
-    'vert': u'|', # | VERTICAL LINE
-    '|': u'\u2016', # ‖ DOUBLE VERTICAL LINE
+    'Vert': '\u2016',  # ‖ DOUBLE VERTICAL LINE
+    'vert': '|',  # | VERTICAL LINE
+    '|': '\u2016',  # ‖ DOUBLE VERTICAL LINE
     }
+
 mathop = {
-    'Join': u'\u2a1d', # ⨝ JOIN
-    'bigcap': u'\u22c2', # ⋂ N-ARY INTERSECTION
-    'bigcup': u'\u22c3', # ⋃ N-ARY UNION
-    'biginterleave': u'\u2afc', # ⫼ LARGE TRIPLE VERTICAL BAR OPERATOR
-    'bigodot': u'\u2a00', # ⨀ N-ARY CIRCLED DOT OPERATOR
-    'bigoplus': u'\u2a01', # ⨁ N-ARY CIRCLED PLUS OPERATOR
-    'bigotimes': u'\u2a02', # ⨂ N-ARY CIRCLED TIMES OPERATOR
-    'bigsqcup': u'\u2a06', # ⨆ N-ARY SQUARE UNION OPERATOR
-    'biguplus': u'\u2a04', # ⨄ N-ARY UNION OPERATOR WITH PLUS
-    'bigvee': u'\u22c1', # ⋁ N-ARY LOGICAL OR
-    'bigwedge': u'\u22c0', # ⋀ N-ARY LOGICAL AND
-    'coprod': u'\u2210', # ∐ N-ARY COPRODUCT
-    'fatsemi': u'\u2a1f', # ⨟ Z NOTATION SCHEMA COMPOSITION
-    'fint': u'\u2a0f', # ⨏ INTEGRAL AVERAGE WITH SLASH
-    'iiiint': u'\u2a0c', # ⨌ QUADRUPLE INTEGRAL OPERATOR
-    'iiint': u'\u222d', # ∭ TRIPLE INTEGRAL
-    'iint': u'\u222c', # ∬ DOUBLE INTEGRAL
-    'int': u'\u222b', # ∫ INTEGRAL
-    'oiint': u'\u222f', # ∯ SURFACE INTEGRAL
-    'oint': u'\u222e', # ∮ CONTOUR INTEGRAL
-    'ointctrclockwise': u'\u2233', # ∳ ANTICLOCKWISE CONTOUR INTEGRAL
-    'prod': u'\u220f', # ∏ N-ARY PRODUCT
-    'sqint': u'\u2a16', # ⨖ QUATERNION INTEGRAL OPERATOR
-    'sum': u'\u2211', # ∑ N-ARY SUMMATION
-    'varointclockwise': u'\u2232', # ∲ CLOCKWISE CONTOUR INTEGRAL
+    'bigcap': '\u22c2',  # ⋂ N-ARY INTERSECTION
+    'bigcup': '\u22c3',  # ⋃ N-ARY UNION
+    'biginterleave': '\u2afc',  # ⫼ LARGE TRIPLE VERTICAL BAR OPERATOR
+    'bigodot': '\u2a00',  # ⨀ N-ARY CIRCLED DOT OPERATOR
+    'bigoplus': '\u2a01',  # ⨁ N-ARY CIRCLED PLUS OPERATOR
+    'bigotimes': '\u2a02',  # ⨂ N-ARY CIRCLED TIMES OPERATOR
+    'bigsqcap': '\u2a05',  # ⨅ N-ARY SQUARE INTERSECTION OPERATOR
+    'bigsqcup': '\u2a06',  # ⨆ N-ARY SQUARE UNION OPERATOR
+    'biguplus': '\u2a04',  # ⨄ N-ARY UNION OPERATOR WITH PLUS
+    'bigvee': '\u22c1',  # ⋁ N-ARY LOGICAL OR
+    'bigwedge': '\u22c0',  # ⋀ N-ARY LOGICAL AND
+    'coprod': '\u2210',  # ∐ N-ARY COPRODUCT
+    'fatsemi': '\u2a1f',  # ⨟ Z NOTATION SCHEMA COMPOSITION
+    'fint': '\u2a0f',  # ⨏ INTEGRAL AVERAGE WITH SLASH
+    'iiiint': '\u2a0c',  # ⨌ QUADRUPLE INTEGRAL OPERATOR
+    'iiint': '\u222d',  # ∭ TRIPLE INTEGRAL
+    'iint': '\u222c',  # ∬ DOUBLE INTEGRAL
+    'int': '\u222b',  # ∫ INTEGRAL
+    'intop': '\u222b',  # ∫ INTEGRAL
+    'oiiint': '\u2230',  # ∰ VOLUME INTEGRAL
+    'oiint': '\u222f',  # ∯ SURFACE INTEGRAL
+    'oint': '\u222e',  # ∮ CONTOUR INTEGRAL
+    'ointctrclockwise': '\u2233',  # ∳ ANTICLOCKWISE CONTOUR INTEGRAL
+    'ointop': '\u222e',  # ∮ CONTOUR INTEGRAL
+    'prod': '\u220f',  # ∏ N-ARY PRODUCT
+    'sqint': '\u2a16',  # ⨖ QUATERNION INTEGRAL OPERATOR
+    'sum': '\u2211',  # ∑ N-ARY SUMMATION
+    'varointclockwise': '\u2232',  # ∲ CLOCKWISE CONTOUR INTEGRAL
+    'varprod': '\u2a09',  # ⨉ N-ARY TIMES OPERATOR
     }
+
 mathopen = {
-    'Lbag': u'\u27c5', # ⟅ LEFT S-SHAPED BAG DELIMITER
-    'langle': u'\u27e8', # ⟨ MATHEMATICAL LEFT ANGLE BRACKET
-    'lbag': u'\u27c5', # ⟅ LEFT S-SHAPED BAG DELIMITER
-    'lbrace': u'{', # { LEFT CURLY BRACKET
-    'lbrack': u'', #  LEFT SQUARE BRACKET
-    'lceil': u'\u2308', # ⌈ LEFT CEILING
-    'lfloor': u'\u230a', # ⌊ LEFT FLOOR
-    'lgroup': u'\u27ee', # ⟮ MATHEMATICAL LEFT FLATTENED PARENTHESIS
-    'llbracket': u'\u27e6', # ⟦ MATHEMATICAL LEFT WHITE SQUARE BRACKET
-    'llcorner': u'\u231e', # ⌞ BOTTOM LEFT CORNER
-    'llparenthesis': u'\u2987', # ⦇ Z NOTATION LEFT IMAGE BRACKET
-    'ulcorner': u'\u231c', # ⌜ TOP LEFT CORNER
-    '{': u'{', # { LEFT CURLY BRACKET
+    'Lbag': '\u27c5',  # ⟅ LEFT S-SHAPED BAG DELIMITER
+    'langle': '\u27e8',  # ⟨ MATHEMATICAL LEFT ANGLE BRACKET
+    'lbag': '\u27c5',  # ⟅ LEFT S-SHAPED BAG DELIMITER
+    'lbrace': '{',  # { LEFT CURLY BRACKET
+    'lbrack': '',  #  LEFT SQUARE BRACKET
+    'lceil': '\u2308',  # ⌈ LEFT CEILING
+    'lfloor': '\u230a',  # ⌊ LEFT FLOOR
+    'lgroup': '\u27ee',  # ⟮ MATHEMATICAL LEFT FLATTENED PARENTHESIS
+    'llbracket': '\u27e6',  # ⟦ MATHEMATICAL LEFT WHITE SQUARE BRACKET
+    'llcorner': '\u231e',  # ⌞ BOTTOM LEFT CORNER
+    'llparenthesis': '\u2987',  # ⦇ Z NOTATION LEFT IMAGE BRACKET
+    'ulcorner': '\u231c',  # ⌜ TOP LEFT CORNER
+    '{': '{',  # { LEFT CURLY BRACKET
     }
+
 mathord = {
-    '#': u'#', # # NUMBER SIGN
-    '$': u'$', # $ DOLLAR SIGN
-    '%': u'%', # % PERCENT SIGN
-    '&': u'&', # & AMPERSAND
-    'AC': u'\u223f', # ∿ SINE WAVE
-    'APLcomment': u'\u235d', # ⍝ APL FUNCTIONAL SYMBOL UP SHOE JOT
-    'APLdownarrowbox': u'\u2357', # ⍗ APL FUNCTIONAL SYMBOL QUAD DOWNWARDS ARROW
-    'APLinput': u'\u235e', # ⍞ APL FUNCTIONAL SYMBOL QUOTE QUAD
-    'APLinv': u'\u2339', # ⌹ APL FUNCTIONAL SYMBOL QUAD DIVIDE
-    'APLleftarrowbox': u'\u2347', # ⍇ APL FUNCTIONAL SYMBOL QUAD LEFTWARDS ARROW
-    'APLlog': u'\u235f', # ⍟ APL FUNCTIONAL SYMBOL CIRCLE STAR
-    'APLrightarrowbox': u'\u2348', # ⍈ APL FUNCTIONAL SYMBOL QUAD RIGHTWARDS ARROW
-    'APLuparrowbox': u'\u2350', # ⍐ APL FUNCTIONAL SYMBOL QUAD UPWARDS ARROW
-    'Aries': u'\u2648', # ♈ ARIES
-    'CIRCLE': u'\u25cf', # ● BLACK CIRCLE
-    'CheckedBox': u'\u2611', # ☑ BALLOT BOX WITH CHECK
-    'Diamond': u'\u25c7', # ◇ WHITE DIAMOND
-    'Finv': u'\u2132', # Ⅎ TURNED CAPITAL F
-    'Game': u'\u2141', # ⅁ TURNED SANS-SERIF CAPITAL G
-    'Gemini': u'\u264a', # ♊ GEMINI
-    'Jupiter': u'\u2643', # ♃ JUPITER
-    'LEFTCIRCLE': u'\u25d6', # ◖ LEFT HALF BLACK CIRCLE
-    'LEFTcircle': u'\u25d0', # ◐ CIRCLE WITH LEFT HALF BLACK
-    'Leo': u'\u264c', # ♌ LEO
-    'Libra': u'\u264e', # ♎ LIBRA
-    'Mars': u'\u2642', # ♂ MALE SIGN
-    'Mercury': u'\u263f', # ☿ MERCURY
-    'Neptune': u'\u2646', # ♆ NEPTUNE
-    'Pluto': u'\u2647', # ♇ PLUTO
-    'RIGHTCIRCLE': u'\u25d7', # ◗ RIGHT HALF BLACK CIRCLE
-    'RIGHTcircle': u'\u25d1', # ◑ CIRCLE WITH RIGHT HALF BLACK
-    'Saturn': u'\u2644', # ♄ SATURN
-    'Scorpio': u'\u264f', # ♏ SCORPIUS
-    'Square': u'\u2610', # ☐ BALLOT BOX
-    'Sun': u'\u2609', # ☉ SUN
-    'Taurus': u'\u2649', # ♉ TAURUS
-    'Uranus': u'\u2645', # ♅ URANUS
-    'Venus': u'\u2640', # ♀ FEMALE SIGN
-    'XBox': u'\u2612', # ☒ BALLOT BOX WITH X
-    'Yup': u'\u2144', # ⅄ TURNED SANS-SERIF CAPITAL Y
-    '_': u'_', # _ LOW LINE
-    'angle': u'\u2220', # ∠ ANGLE
-    'aquarius': u'\u2652', # ♒ AQUARIUS
-    'aries': u'\u2648', # ♈ ARIES
-    'ast': u'*', # * ASTERISK
-    'backepsilon': u'\u03f6', # ϶ GREEK REVERSED LUNATE EPSILON SYMBOL
-    'backprime': u'\u2035', # ‵ REVERSED PRIME
-    'backslash': u'\\', # \ REVERSE SOLIDUS
-    'because': u'\u2235', # ∵ BECAUSE
-    'bigstar': u'\u2605', # ★ BLACK STAR
-    'binampersand': u'&', # & AMPERSAND
-    'blacklozenge': u'\u2b27', # ⬧ BLACK MEDIUM LOZENGE
-    'blacksmiley': u'\u263b', # ☻ BLACK SMILING FACE
-    'blacksquare': u'\u25fc', # ◼ BLACK MEDIUM SQUARE
-    'bot': u'\u22a5', # ⊥ UP TACK
-    'boy': u'\u2642', # ♂ MALE SIGN
-    'cancer': u'\u264b', # ♋ CANCER
-    'capricornus': u'\u2651', # ♑ CAPRICORN
-    'cdots': u'\u22ef', # ⋯ MIDLINE HORIZONTAL ELLIPSIS
-    'cent': u'\xa2', # ¢ CENT SIGN
-    'centerdot': u'\u2b1d', # ⬝ BLACK VERY SMALL SQUARE
-    'checkmark': u'\u2713', # ✓ CHECK MARK
-    'circlearrowleft': u'\u21ba', # ↺ ANTICLOCKWISE OPEN CIRCLE ARROW
-    'circlearrowright': u'\u21bb', # ↻ CLOCKWISE OPEN CIRCLE ARROW
-    'circledR': u'\xae', # ® REGISTERED SIGN
-    'circledcirc': u'\u25ce', # ◎ BULLSEYE
-    'clubsuit': u'\u2663', # ♣ BLACK CLUB SUIT
-    'complement': u'\u2201', # ∁ COMPLEMENT
-    'dasharrow': u'\u21e2', # ⇢ RIGHTWARDS DASHED ARROW
-    'dashleftarrow': u'\u21e0', # ⇠ LEFTWARDS DASHED ARROW
-    'dashrightarrow': u'\u21e2', # ⇢ RIGHTWARDS DASHED ARROW
-    'diameter': u'\u2300', # ⌀ DIAMETER SIGN
-    'diamondsuit': u'\u2662', # ♢ WHITE DIAMOND SUIT
-    'earth': u'\u2641', # ♁ EARTH
-    'exists': u'\u2203', # ∃ THERE EXISTS
-    'female': u'\u2640', # ♀ FEMALE SIGN
-    'flat': u'\u266d', # ♭ MUSIC FLAT SIGN
-    'forall': u'\u2200', # ∀ FOR ALL
-    'fourth': u'\u2057', # ⁗ QUADRUPLE PRIME
-    'frownie': u'\u2639', # ☹ WHITE FROWNING FACE
-    'gemini': u'\u264a', # ♊ GEMINI
-    'girl': u'\u2640', # ♀ FEMALE SIGN
-    'heartsuit': u'\u2661', # ♡ WHITE HEART SUIT
-    'infty': u'\u221e', # ∞ INFINITY
-    'invneg': u'\u2310', # ⌐ REVERSED NOT SIGN
-    'jupiter': u'\u2643', # ♃ JUPITER
-    'ldots': u'\u2026', # … HORIZONTAL ELLIPSIS
-    'leftmoon': u'\u263e', # ☾ LAST QUARTER MOON
-    'leftturn': u'\u21ba', # ↺ ANTICLOCKWISE OPEN CIRCLE ARROW
-    'leo': u'\u264c', # ♌ LEO
-    'libra': u'\u264e', # ♎ LIBRA
-    'lnot': u'\xac', # ¬ NOT SIGN
-    'lozenge': u'\u25ca', # ◊ LOZENGE
-    'male': u'\u2642', # ♂ MALE SIGN
-    'maltese': u'\u2720', # ✠ MALTESE CROSS
-    'mathdollar': u'$', # $ DOLLAR SIGN
-    'measuredangle': u'\u2221', # ∡ MEASURED ANGLE
-    'mercury': u'\u263f', # ☿ MERCURY
-    'mho': u'\u2127', # ℧ INVERTED OHM SIGN
-    'nabla': u'\u2207', # ∇ NABLA
-    'natural': u'\u266e', # ♮ MUSIC NATURAL SIGN
-    'neg': u'\xac', # ¬ NOT SIGN
-    'neptune': u'\u2646', # ♆ NEPTUNE
-    'nexists': u'\u2204', # ∄ THERE DOES NOT EXIST
-    'notbackslash': u'\u2340', # ⍀ APL FUNCTIONAL SYMBOL BACKSLASH BAR
-    'partial': u'\u2202', # ∂ PARTIAL DIFFERENTIAL
-    'pisces': u'\u2653', # ♓ PISCES
-    'pluto': u'\u2647', # ♇ PLUTO
-    'pounds': u'\xa3', # £ POUND SIGN
-    'prime': u'\u2032', # ′ PRIME
-    'quarternote': u'\u2669', # ♩ QUARTER NOTE
-    'rightmoon': u'\u263d', # ☽ FIRST QUARTER MOON
-    'rightturn': u'\u21bb', # ↻ CLOCKWISE OPEN CIRCLE ARROW
-    'sagittarius': u'\u2650', # ♐ SAGITTARIUS
-    'saturn': u'\u2644', # ♄ SATURN
-    'scorpio': u'\u264f', # ♏ SCORPIUS
-    'second': u'\u2033', # ″ DOUBLE PRIME
-    'sharp': u'\u266f', # ♯ MUSIC SHARP SIGN
-    'sim': u'~', # ~ TILDE
-    'slash': u'/', # / SOLIDUS
-    'smiley': u'\u263a', # ☺ WHITE SMILING FACE
-    'spadesuit': u'\u2660', # ♠ BLACK SPADE SUIT
-    'spddot': u'\xa8', # ¨ DIAERESIS
-    'sphat': u'^', # ^ CIRCUMFLEX ACCENT
-    'sphericalangle': u'\u2222', # ∢ SPHERICAL ANGLE
-    'sptilde': u'~', # ~ TILDE
-    'square': u'\u25fb', # ◻ WHITE MEDIUM SQUARE
-    'sun': u'\u263c', # ☼ WHITE SUN WITH RAYS
-    'taurus': u'\u2649', # ♉ TAURUS
-    'therefore': u'\u2234', # ∴ THEREFORE
-    'third': u'\u2034', # ‴ TRIPLE PRIME
-    'top': u'\u22a4', # ⊤ DOWN TACK
-    'triangleleft': u'\u25c5', # ◅ WHITE LEFT-POINTING POINTER
-    'triangleright': u'\u25bb', # ▻ WHITE RIGHT-POINTING POINTER
-    'twonotes': u'\u266b', # ♫ BEAMED EIGHTH NOTES
-    'uranus': u'\u2645', # ♅ URANUS
-    'varEarth': u'\u2641', # ♁ EARTH
-    'varnothing': u'\u2205', # ∅ EMPTY SET
-    'virgo': u'\u264d', # ♍ VIRGO
-    'wasylozenge': u'\u2311', # ⌑ SQUARE LOZENGE
-    'wasytherefore': u'\u2234', # ∴ THEREFORE
-    'yen': u'\xa5', # ¥ YEN SIGN
+    '#': '#',  # # NUMBER SIGN
+    '$': '$',  # $ DOLLAR SIGN
+    '%': '%',  # % PERCENT SIGN
+    '&': '&',  # & AMPERSAND
+    'AC': '\u223f',  # ∿ SINE WAVE
+    'APLcomment': '\u235d',  # ⍝ APL FUNCTIONAL SYMBOL UP SHOE JOT
+    'APLdownarrowbox': '\u2357',  # ⍗ APL FUNCTIONAL SYMBOL QUAD DOWNWARDS ARROW
+    'APLinput': '\u235e',  # ⍞ APL FUNCTIONAL SYMBOL QUOTE QUAD
+    'APLinv': '\u2339',  # ⌹ APL FUNCTIONAL SYMBOL QUAD DIVIDE
+    'APLleftarrowbox': '\u2347',  # ⍇ APL FUNCTIONAL SYMBOL QUAD LEFTWARDS ARROW
+    'APLlog': '\u235f',  # ⍟ APL FUNCTIONAL SYMBOL CIRCLE STAR
+    'APLrightarrowbox': '\u2348',  # ⍈ APL FUNCTIONAL SYMBOL QUAD RIGHTWARDS ARROW
+    'APLuparrowbox': '\u2350',  # ⍐ APL FUNCTIONAL SYMBOL QUAD UPWARDS ARROW
+    'Aries': '\u2648',  # ♈ ARIES
+    'Box': '\u2b1c',  # ⬜ WHITE LARGE SQUARE
+    'CIRCLE': '\u25cf',  # ● BLACK CIRCLE
+    'CheckedBox': '\u2611',  # ☑ BALLOT BOX WITH CHECK
+    'Diamond': '\u25c7',  # ◇ WHITE DIAMOND
+    'Diamondblack': '\u25c6',  # ◆ BLACK DIAMOND
+    'Diamonddot': '\u27d0',  # ⟐ WHITE DIAMOND WITH CENTRED DOT
+    'Finv': '\u2132',  # Ⅎ TURNED CAPITAL F
+    'Game': '\u2141',  # ⅁ TURNED SANS-SERIF CAPITAL G
+    'Gemini': '\u264a',  # ♊ GEMINI
+    'Jupiter': '\u2643',  # ♃ JUPITER
+    'LEFTCIRCLE': '\u25d6',  # ◖ LEFT HALF BLACK CIRCLE
+    'LEFTcircle': '\u25d0',  # ◐ CIRCLE WITH LEFT HALF BLACK
+    'Leo': '\u264c',  # ♌ LEO
+    'Libra': '\u264e',  # ♎ LIBRA
+    'Mars': '\u2642',  # ♂ MALE SIGN
+    'Mercury': '\u263f',  # ☿ MERCURY
+    'Neptune': '\u2646',  # ♆ NEPTUNE
+    'P': '\xb6',  # ¶ PILCROW SIGN
+    'Pluto': '\u2647',  # ♇ PLUTO
+    'RIGHTCIRCLE': '\u25d7',  # ◗ RIGHT HALF BLACK CIRCLE
+    'RIGHTcircle': '\u25d1',  # ◑ CIRCLE WITH RIGHT HALF BLACK
+    'S': '\xa7',  # § SECTION SIGN
+    'Saturn': '\u2644',  # ♄ SATURN
+    'Scorpio': '\u264f',  # ♏ SCORPIUS
+    'Square': '\u2610',  # ☐ BALLOT BOX
+    'Sun': '\u2609',  # ☉ SUN
+    'Taurus': '\u2649',  # ♉ TAURUS
+    'Uranus': '\u2645',  # ♅ URANUS
+    'Venus': '\u2640',  # ♀ FEMALE SIGN
+    'XBox': '\u2612',  # ☒ BALLOT BOX WITH X
+    'Yup': '\u2144',  # ⅄ TURNED SANS-SERIF CAPITAL Y
+    '_': '_',  # _ LOW LINE
+    'angle': '\u2220',  # ∠ ANGLE
+    'aquarius': '\u2652',  # ♒ AQUARIUS
+    'aries': '\u2648',  # ♈ ARIES
+    'arrowvert': '\u23d0',  # ⏐ VERTICAL LINE EXTENSION
+    'backprime': '\u2035',  # ‵ REVERSED PRIME
+    'backslash': '\\',  # \ REVERSE SOLIDUS
+    'bigstar': '\u2605',  # ★ BLACK STAR
+    'blacksmiley': '\u263b',  # ☻ BLACK SMILING FACE
+    'blacksquare': '\u25fc',  # ◼ BLACK MEDIUM SQUARE
+    'blacktriangle': '\u25b4',  # ▴ BLACK UP-POINTING SMALL TRIANGLE
+    'blacktriangledown': '\u25be',  # ▾ BLACK DOWN-POINTING SMALL TRIANGLE
+    'blacktriangleup': '\u25b4',  # ▴ BLACK UP-POINTING SMALL TRIANGLE
+    'bot': '\u22a5',  # ⊥ UP TACK
+    'boy': '\u2642',  # ♂ MALE SIGN
+    'bracevert': '\u23aa',  # ⎪ CURLY BRACKET EXTENSION
+    'cancer': '\u264b',  # ♋ CANCER
+    'capricornus': '\u2651',  # ♑ CAPRICORN
+    'cdots': '\u22ef',  # ⋯ MIDLINE HORIZONTAL ELLIPSIS
+    'cent': '\xa2',  # ¢ CENT SIGN
+    'checkmark': '\u2713',  # ✓ CHECK MARK
+    'circledR': '\u24c7',  # Ⓡ CIRCLED LATIN CAPITAL LETTER R
+    'circledS': '\u24c8',  # Ⓢ CIRCLED LATIN CAPITAL LETTER S
+    'clubsuit': '\u2663',  # ♣ BLACK CLUB SUIT
+    'complement': '\u2201',  # ∁ COMPLEMENT
+    'diagdown': '\u27cd',  # ⟍ MATHEMATICAL FALLING DIAGONAL
+    'diagup': '\u27cb',  # ⟋ MATHEMATICAL RISING DIAGONAL
+    'diameter': '\u2300',  # ⌀ DIAMETER SIGN
+    'diamondsuit': '\u2662',  # ♢ WHITE DIAMOND SUIT
+    'earth': '\u2641',  # ♁ EARTH
+    'emptyset': '\u2205',  # ∅ EMPTY SET
+    'exists': '\u2203',  # ∃ THERE EXISTS
+    'female': '\u2640',  # ♀ FEMALE SIGN
+    'flat': '\u266d',  # ♭ MUSIC FLAT SIGN
+    'forall': '\u2200',  # ∀ FOR ALL
+    'fourth': '\u2057',  # ⁗ QUADRUPLE PRIME
+    'frownie': '\u2639',  # ☹ WHITE FROWNING FACE
+    'gemini': '\u264a',  # ♊ GEMINI
+    'girl': '\u2640',  # ♀ FEMALE SIGN
+    'heartsuit': '\u2661',  # ♡ WHITE HEART SUIT
+    'infty': '\u221e',  # ∞ INFINITY
+    'invdiameter': '\u2349',  # ⍉ APL FUNCTIONAL SYMBOL CIRCLE BACKSLASH
+    'invneg': '\u2310',  # ⌐ REVERSED NOT SIGN
+    'jupiter': '\u2643',  # ♃ JUPITER
+    'ldots': '\u2026',  # … HORIZONTAL ELLIPSIS
+    'leftmoon': '\u263e',  # ☾ LAST QUARTER MOON
+    'leo': '\u264c',  # ♌ LEO
+    'libra': '\u264e',  # ♎ LIBRA
+    'lmoustache': '\u23b0',  # ⎰ UPPER LEFT OR LOWER RIGHT CURLY BRACKET SECTION
+    'lnot': '\xac',  # ¬ NOT SIGN
+    'lozenge': '\u25ca',  # ◊ LOZENGE
+    'male': '\u2642',  # ♂ MALE SIGN
+    'maltese': '\u2720',  # ✠ MALTESE CROSS
+    'mathcent': '\xa2',  # ¢ CENT SIGN
+    'mathdollar': '$',  # $ DOLLAR SIGN
+    'mathsterling': '\xa3',  # £ POUND SIGN
+    'measuredangle': '\u2221',  # ∡ MEASURED ANGLE
+    'medbullet': '\u26ab',  # ⚫ MEDIUM BLACK CIRCLE
+    'medcirc': '\u26aa',  # ⚪ MEDIUM WHITE CIRCLE
+    'mercury': '\u263f',  # ☿ MERCURY
+    'mho': '\u2127',  # ℧ INVERTED OHM SIGN
+    'nabla': '\u2207',  # ∇ NABLA
+    'natural': '\u266e',  # ♮ MUSIC NATURAL SIGN
+    'neg': '\xac',  # ¬ NOT SIGN
+    'neptune': '\u2646',  # ♆ NEPTUNE
+    'nexists': '\u2204',  # ∄ THERE DOES NOT EXIST
+    'notbackslash': '\u2340',  # ⍀ APL FUNCTIONAL SYMBOL BACKSLASH BAR
+    'partial': '\u2202',  # ∂ PARTIAL DIFFERENTIAL
+    'pisces': '\u2653',  # ♓ PISCES
+    'pluto': '\u2647',  # ♇ PLUTO
+    'pounds': '\xa3',  # £ POUND SIGN
+    'prime': '\u2032',  # ′ PRIME
+    'quarternote': '\u2669',  # ♩ QUARTER NOTE
+    'rightmoon': '\u263d',  # ☽ FIRST QUARTER MOON
+    'rmoustache': '\u23b1',  # ⎱ UPPER RIGHT OR LOWER LEFT CURLY BRACKET SECTION
+    'sagittarius': '\u2650',  # ♐ SAGITTARIUS
+    'saturn': '\u2644',  # ♄ SATURN
+    'scorpio': '\u264f',  # ♏ SCORPIUS
+    'second': '\u2033',  # ″ DOUBLE PRIME
+    'sharp': '\u266f',  # ♯ MUSIC SHARP SIGN
+    'smiley': '\u263a',  # ☺ WHITE SMILING FACE
+    'spadesuit': '\u2660',  # ♠ BLACK SPADE SUIT
+    'spddot': '\xa8',  # ¨ DIAERESIS
+    'sphat': '^',  # ^ CIRCUMFLEX ACCENT
+    'sphericalangle': '\u2222',  # ∢ SPHERICAL ANGLE
+    'sptilde': '~',  # ~ TILDE
+    'square': '\u25fb',  # ◻ WHITE MEDIUM SQUARE
+    'sun': '\u263c',  # ☼ WHITE SUN WITH RAYS
+    'surd': '\u221a',  # √ SQUARE ROOT
+    'taurus': '\u2649',  # ♉ TAURUS
+    'third': '\u2034',  # ‴ TRIPLE PRIME
+    'top': '\u22a4',  # ⊤ DOWN TACK
+    'twonotes': '\u266b',  # ♫ BEAMED EIGHTH NOTES
+    'uranus': '\u2645',  # ♅ URANUS
+    'varEarth': '\u2641',  # ♁ EARTH
+    'varclubsuit': '\u2667',  # ♧ WHITE CLUB SUIT
+    'vardiamondsuit': '\u2666',  # ♦ BLACK DIAMOND SUIT
+    'varheartsuit': '\u2665',  # ♥ BLACK HEART SUIT
+    'varspadesuit': '\u2664',  # ♤ WHITE SPADE SUIT
+    'virgo': '\u264d',  # ♍ VIRGO
+    'wasylozenge': '\u2311',  # ⌑ SQUARE LOZENGE
+    'yen': '\xa5',  # ¥ YEN SIGN
     }
+
 mathover = {
-    'overbrace': u'\u23de', # ⏞ TOP CURLY BRACKET
-    'wideparen': u'\u23dc', # ⏜ TOP PARENTHESIS
+    'overbrace': '\u23de',  # ⏞ TOP CURLY BRACKET
+    'wideparen': '\u23dc',  # ⏜ TOP PARENTHESIS
+    }
+
+mathpunct = {
+    'ddots': '\u22f1',  # ⋱ DOWN RIGHT DIAGONAL ELLIPSIS
+    'vdots': '\u22ee',  # ⋮ VERTICAL ELLIPSIS
     }
+
 mathradical = {
-    'sqrt': u'\u221a', # √ SQUARE ROOT
-    'sqrt3': u'\u221b', # ∛ CUBE ROOT
-    'sqrt4': u'\u221c', # ∜ FOURTH ROOT
+    'sqrt3': '\u221b',  # ∛ CUBE ROOT
+    'sqrt4': '\u221c',  # ∜ FOURTH ROOT
     }
+
 mathrel = {
-    'Bumpeq': u'\u224e', # ≎ GEOMETRICALLY EQUIVALENT TO
-    'Doteq': u'\u2251', # ≑ GEOMETRICALLY EQUAL TO
-    'Downarrow': u'\u21d3', # ⇓ DOWNWARDS DOUBLE ARROW
-    'Leftarrow': u'\u21d0', # ⇐ LEFTWARDS DOUBLE ARROW
-    'Leftrightarrow': u'\u21d4', # ⇔ LEFT RIGHT DOUBLE ARROW
-    'Lleftarrow': u'\u21da', # ⇚ LEFTWARDS TRIPLE ARROW
-    'Longleftarrow': u'\u27f8', # ⟸ LONG LEFTWARDS DOUBLE ARROW
-    'Longleftrightarrow': u'\u27fa', # ⟺ LONG LEFT RIGHT DOUBLE ARROW
-    'Longmapsfrom': u'\u27fd', # ⟽ LONG LEFTWARDS DOUBLE ARROW FROM BAR
-    'Longmapsto': u'\u27fe', # ⟾ LONG RIGHTWARDS DOUBLE ARROW FROM BAR
-    'Longrightarrow': u'\u27f9', # ⟹ LONG RIGHTWARDS DOUBLE ARROW
-    'Lsh': u'\u21b0', # ↰ UPWARDS ARROW WITH TIP LEFTWARDS
-    'Mapsfrom': u'\u2906', # ⤆ LEFTWARDS DOUBLE ARROW FROM BAR
-    'Mapsto': u'\u2907', # ⤇ RIGHTWARDS DOUBLE ARROW FROM BAR
-    'Rightarrow': u'\u21d2', # ⇒ RIGHTWARDS DOUBLE ARROW
-    'Rrightarrow': u'\u21db', # ⇛ RIGHTWARDS TRIPLE ARROW
-    'Rsh': u'\u21b1', # ↱ UPWARDS ARROW WITH TIP RIGHTWARDS
-    'Subset': u'\u22d0', # ⋐ DOUBLE SUBSET
-    'Supset': u'\u22d1', # ⋑ DOUBLE SUPERSET
-    'Uparrow': u'\u21d1', # ⇑ UPWARDS DOUBLE ARROW
-    'Updownarrow': u'\u21d5', # ⇕ UP DOWN DOUBLE ARROW
-    'VDash': u'\u22ab', # ⊫ DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE
-    'Vdash': u'\u22a9', # ⊩ FORCES
-    'Vvdash': u'\u22aa', # ⊪ TRIPLE VERTICAL BAR RIGHT TURNSTILE
-    'apprge': u'\u2273', # ≳ GREATER-THAN OR EQUIVALENT TO
-    'apprle': u'\u2272', # ≲ LESS-THAN OR EQUIVALENT TO
-    'approx': u'\u2248', # ≈ ALMOST EQUAL TO
-    'approxeq': u'\u224a', # ≊ ALMOST EQUAL OR EQUAL TO
-    'asymp': u'\u224d', # ≍ EQUIVALENT TO
-    'backsim': u'\u223d', # ∽ REVERSED TILDE
-    'backsimeq': u'\u22cd', # ⋍ REVERSED TILDE EQUALS
-    'barin': u'\u22f6', # ⋶ ELEMENT OF WITH OVERBAR
-    'barleftharpoon': u'\u296b', # ⥫ LEFTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH
-    'barrightharpoon': u'\u296d', # ⥭ RIGHTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH
-    'between': u'\u226c', # ≬ BETWEEN
-    'bowtie': u'\u22c8', # ⋈ BOWTIE
-    'bumpeq': u'\u224f', # ≏ DIFFERENCE BETWEEN
-    'circeq': u'\u2257', # ≗ RING EQUAL TO
-    'coloneq': u'\u2254', # ≔ COLON EQUALS
-    'cong': u'\u2245', # ≅ APPROXIMATELY EQUAL TO
-    'corresponds': u'\u2259', # ≙ ESTIMATES
-    'curlyeqprec': u'\u22de', # ⋞ EQUAL TO OR PRECEDES
-    'curlyeqsucc': u'\u22df', # ⋟ EQUAL TO OR SUCCEEDS
-    'curvearrowleft': u'\u21b6', # ↶ ANTICLOCKWISE TOP SEMICIRCLE ARROW
-    'curvearrowright': u'\u21b7', # ↷ CLOCKWISE TOP SEMICIRCLE ARROW
-    'dashv': u'\u22a3', # ⊣ LEFT TACK
-    'ddots': u'\u22f1', # ⋱ DOWN RIGHT DIAGONAL ELLIPSIS
-    'dlsh': u'\u21b2', # ↲ DOWNWARDS ARROW WITH TIP LEFTWARDS
-    'doteq': u'\u2250', # ≐ APPROACHES THE LIMIT
-    'doteqdot': u'\u2251', # ≑ GEOMETRICALLY EQUAL TO
-    'downarrow': u'\u2193', # ↓ DOWNWARDS ARROW
-    'downdownarrows': u'\u21ca', # ⇊ DOWNWARDS PAIRED ARROWS
-    'downdownharpoons': u'\u2965', # ⥥ DOWNWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT
-    'downharpoonleft': u'\u21c3', # ⇃ DOWNWARDS HARPOON WITH BARB LEFTWARDS
-    'downharpoonright': u'\u21c2', # ⇂ DOWNWARDS HARPOON WITH BARB RIGHTWARDS
-    'downuparrows': u'\u21f5', # ⇵ DOWNWARDS ARROW LEFTWARDS OF UPWARDS ARROW
-    'downupharpoons': u'\u296f', # ⥯ DOWNWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT
-    'drsh': u'\u21b3', # ↳ DOWNWARDS ARROW WITH TIP RIGHTWARDS
-    'eqcirc': u'\u2256', # ≖ RING IN EQUAL TO
-    'eqcolon': u'\u2255', # ≕ EQUALS COLON
-    'eqsim': u'\u2242', # ≂ MINUS TILDE
-    'eqslantgtr': u'\u2a96', # ⪖ SLANTED EQUAL TO OR GREATER-THAN
-    'eqslantless': u'\u2a95', # ⪕ SLANTED EQUAL TO OR LESS-THAN
-    'equiv': u'\u2261', # ≡ IDENTICAL TO
-    'fallingdotseq': u'\u2252', # ≒ APPROXIMATELY EQUAL TO OR THE IMAGE OF
-    'frown': u'\u2322', # ⌢ FROWN
-    'ge': u'\u2265', # ≥ GREATER-THAN OR EQUAL TO
-    'geq': u'\u2265', # ≥ GREATER-THAN OR EQUAL TO
-    'geqq': u'\u2267', # ≧ GREATER-THAN OVER EQUAL TO
-    'geqslant': u'\u2a7e', # ⩾ GREATER-THAN OR SLANTED EQUAL TO
-    'gets': u'\u2190', # ← LEFTWARDS ARROW
-    'gg': u'\u226b', # ≫ MUCH GREATER-THAN
-    'ggcurly': u'\u2abc', # ⪼ DOUBLE SUCCEEDS
-    'ggg': u'\u22d9', # ⋙ VERY MUCH GREATER-THAN
-    'gnapprox': u'\u2a8a', # ⪊ GREATER-THAN AND NOT APPROXIMATE
-    'gneq': u'\u2a88', # ⪈ GREATER-THAN AND SINGLE-LINE NOT EQUAL TO
-    'gneqq': u'\u2269', # ≩ GREATER-THAN BUT NOT EQUAL TO
-    'gnsim': u'\u22e7', # ⋧ GREATER-THAN BUT NOT EQUIVALENT TO
-    'gtrapprox': u'\u2a86', # ⪆ GREATER-THAN OR APPROXIMATE
-    'gtrdot': u'\u22d7', # ⋗ GREATER-THAN WITH DOT
-    'gtreqless': u'\u22db', # ⋛ GREATER-THAN EQUAL TO OR LESS-THAN
-    'gtreqqless': u'\u2a8c', # ⪌ GREATER-THAN ABOVE DOUBLE-LINE EQUAL ABOVE LESS-THAN
-    'gtrless': u'\u2277', # ≷ GREATER-THAN OR LESS-THAN
-    'gtrsim': u'\u2273', # ≳ GREATER-THAN OR EQUIVALENT TO
-    'hash': u'\u22d5', # ⋕ EQUAL AND PARALLEL TO
-    'hookleftarrow': u'\u21a9', # ↩ LEFTWARDS ARROW WITH HOOK
-    'hookrightarrow': u'\u21aa', # ↪ RIGHTWARDS ARROW WITH HOOK
-    'iddots': u'\u22f0', # ⋰ UP RIGHT DIAGONAL ELLIPSIS
-    'impliedby': u'\u27f8', # ⟸ LONG LEFTWARDS DOUBLE ARROW
-    'implies': u'\u27f9', # ⟹ LONG RIGHTWARDS DOUBLE ARROW
-    'in': u'\u2208', # ∈ ELEMENT OF
-    'le': u'\u2264', # ≤ LESS-THAN OR EQUAL TO
-    'leftarrow': u'\u2190', # ← LEFTWARDS ARROW
-    'leftarrowtail': u'\u21a2', # ↢ LEFTWARDS ARROW WITH TAIL
-    'leftarrowtriangle': u'\u21fd', # ⇽ LEFTWARDS OPEN-HEADED ARROW
-    'leftbarharpoon': u'\u296a', # ⥪ LEFTWARDS HARPOON WITH BARB UP ABOVE LONG DASH
-    'leftharpoondown': u'\u21bd', # ↽ LEFTWARDS HARPOON WITH BARB DOWNWARDS
-    'leftharpoonup': u'\u21bc', # ↼ LEFTWARDS HARPOON WITH BARB UPWARDS
-    'leftleftarrows': u'\u21c7', # ⇇ LEFTWARDS PAIRED ARROWS
-    'leftleftharpoons': u'\u2962', # ⥢ LEFTWARDS HARPOON WITH BARB UP ABOVE LEFTWARDS HARPOON WITH BARB DOWN
-    'leftrightarrow': u'\u2194', # ↔ LEFT RIGHT ARROW
-    'leftrightarrows': u'\u21c6', # ⇆ LEFTWARDS ARROW OVER RIGHTWARDS ARROW
-    'leftrightarrowtriangle': u'\u21ff', # ⇿ LEFT RIGHT OPEN-HEADED ARROW
-    'leftrightharpoon': u'\u294a', # ⥊ LEFT BARB UP RIGHT BARB DOWN HARPOON
-    'leftrightharpoons': u'\u21cb', # ⇋ LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON
-    'leftrightsquigarrow': u'\u21ad', # ↭ LEFT RIGHT WAVE ARROW
-    'leftslice': u'\u2aa6', # ⪦ LESS-THAN CLOSED BY CURVE
-    'leftsquigarrow': u'\u21dc', # ⇜ LEFTWARDS SQUIGGLE ARROW
-    'leq': u'\u2264', # ≤ LESS-THAN OR EQUAL TO
-    'leqq': u'\u2266', # ≦ LESS-THAN OVER EQUAL TO
-    'leqslant': u'\u2a7d', # ⩽ LESS-THAN OR SLANTED EQUAL TO
-    'lessapprox': u'\u2a85', # ⪅ LESS-THAN OR APPROXIMATE
-    'lessdot': u'\u22d6', # ⋖ LESS-THAN WITH DOT
-    'lesseqgtr': u'\u22da', # ⋚ LESS-THAN EQUAL TO OR GREATER-THAN
-    'lesseqqgtr': u'\u2a8b', # ⪋ LESS-THAN ABOVE DOUBLE-LINE EQUAL ABOVE GREATER-THAN
-    'lessgtr': u'\u2276', # ≶ LESS-THAN OR GREATER-THAN
-    'lesssim': u'\u2272', # ≲ LESS-THAN OR EQUIVALENT TO
-    'lightning': u'\u21af', # ↯ DOWNWARDS ZIGZAG ARROW
-    'll': u'\u226a', # ≪ MUCH LESS-THAN
-    'llcurly': u'\u2abb', # ⪻ DOUBLE PRECEDES
-    'lll': u'\u22d8', # ⋘ VERY MUCH LESS-THAN
-    'lnapprox': u'\u2a89', # ⪉ LESS-THAN AND NOT APPROXIMATE
-    'lneq': u'\u2a87', # ⪇ LESS-THAN AND SINGLE-LINE NOT EQUAL TO
-    'lneqq': u'\u2268', # ≨ LESS-THAN BUT NOT EQUAL TO
-    'lnsim': u'\u22e6', # ⋦ LESS-THAN BUT NOT EQUIVALENT TO
-    'longleftarrow': u'\u27f5', # ⟵ LONG LEFTWARDS ARROW
-    'longleftrightarrow': u'\u27f7', # ⟷ LONG LEFT RIGHT ARROW
-    'longmapsfrom': u'\u27fb', # ⟻ LONG LEFTWARDS ARROW FROM BAR
-    'longmapsto': u'\u27fc', # ⟼ LONG RIGHTWARDS ARROW FROM BAR
-    'longrightarrow': u'\u27f6', # ⟶ LONG RIGHTWARDS ARROW
-    'looparrowleft': u'\u21ab', # ↫ LEFTWARDS ARROW WITH LOOP
-    'looparrowright': u'\u21ac', # ↬ RIGHTWARDS ARROW WITH LOOP
-    'mapsfrom': u'\u21a4', # ↤ LEFTWARDS ARROW FROM BAR
-    'mapsto': u'\u21a6', # ↦ RIGHTWARDS ARROW FROM BAR
-    'mid': u'\u2223', # ∣ DIVIDES
-    'models': u'\u22a7', # ⊧ MODELS
-    'multimap': u'\u22b8', # ⊸ MULTIMAP
-    'nLeftarrow': u'\u21cd', # ⇍ LEFTWARDS DOUBLE ARROW WITH STROKE
-    'nLeftrightarrow': u'\u21ce', # ⇎ LEFT RIGHT DOUBLE ARROW WITH STROKE
-    'nRightarrow': u'\u21cf', # ⇏ RIGHTWARDS DOUBLE ARROW WITH STROKE
-    'nVDash': u'\u22af', # ⊯ NEGATED DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE
-    'nVdash': u'\u22ae', # ⊮ DOES NOT FORCE
-    'ncong': u'\u2247', # ≇ NEITHER APPROXIMATELY NOR ACTUALLY EQUAL TO
-    'ne': u'\u2260', # ≠ NOT EQUAL TO
-    'nearrow': u'\u2197', # ↗ NORTH EAST ARROW
-    'neq': u'\u2260', # ≠ NOT EQUAL TO
-    'ngeq': u'\u2271', # ≱ NEITHER GREATER-THAN NOR EQUAL TO
-    'ngtr': u'\u226f', # ≯ NOT GREATER-THAN
-    'ni': u'\u220b', # ∋ CONTAINS AS MEMBER
-    'nleftarrow': u'\u219a', # ↚ LEFTWARDS ARROW WITH STROKE
-    'nleftrightarrow': u'\u21ae', # ↮ LEFT RIGHT ARROW WITH STROKE
-    'nleq': u'\u2270', # ≰ NEITHER LESS-THAN NOR EQUAL TO
-    'nless': u'\u226e', # ≮ NOT LESS-THAN
-    'nmid': u'\u2224', # ∤ DOES NOT DIVIDE
-    'notasymp': u'\u226d', # ≭ NOT EQUIVALENT TO
-    'notin': u'\u2209', # ∉ NOT AN ELEMENT OF
-    'notowner': u'\u220c', # ∌ DOES NOT CONTAIN AS MEMBER
-    'notslash': u'\u233f', # ⌿ APL FUNCTIONAL SYMBOL SLASH BAR
-    'nparallel': u'\u2226', # ∦ NOT PARALLEL TO
-    'nprec': u'\u2280', # ⊀ DOES NOT PRECEDE
-    'npreceq': u'\u22e0', # ⋠ DOES NOT PRECEDE OR EQUAL
-    'nrightarrow': u'\u219b', # ↛ RIGHTWARDS ARROW WITH STROKE
-    'nsim': u'\u2241', # ≁ NOT TILDE
-    'nsubseteq': u'\u2288', # ⊈ NEITHER A SUBSET OF NOR EQUAL TO
-    'nsucc': u'\u2281', # ⊁ DOES NOT SUCCEED
-    'nsucceq': u'\u22e1', # ⋡ DOES NOT SUCCEED OR EQUAL
-    'nsupseteq': u'\u2289', # ⊉ NEITHER A SUPERSET OF NOR EQUAL TO
-    'ntriangleleft': u'\u22ea', # ⋪ NOT NORMAL SUBGROUP OF
-    'ntrianglelefteq': u'\u22ec', # ⋬ NOT NORMAL SUBGROUP OF OR EQUAL TO
-    'ntriangleright': u'\u22eb', # ⋫ DOES NOT CONTAIN AS NORMAL SUBGROUP
-    'ntrianglerighteq': u'\u22ed', # ⋭ DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL
-    'nvDash': u'\u22ad', # ⊭ NOT TRUE
-    'nvdash': u'\u22ac', # ⊬ DOES NOT PROVE
-    'nwarrow': u'\u2196', # ↖ NORTH WEST ARROW
-    'owns': u'\u220b', # ∋ CONTAINS AS MEMBER
-    'parallel': u'\u2225', # ∥ PARALLEL TO
-    'perp': u'\u27c2', # ⟂ PERPENDICULAR
-    'pitchfork': u'\u22d4', # ⋔ PITCHFORK
-    'prec': u'\u227a', # ≺ PRECEDES
-    'precapprox': u'\u2ab7', # ⪷ PRECEDES ABOVE ALMOST EQUAL TO
-    'preccurlyeq': u'\u227c', # ≼ PRECEDES OR EQUAL TO
-    'preceq': u'\u2aaf', # ⪯ PRECEDES ABOVE SINGLE-LINE EQUALS SIGN
-    'precnapprox': u'\u2ab9', # ⪹ PRECEDES ABOVE NOT ALMOST EQUAL TO
-    'precnsim': u'\u22e8', # ⋨ PRECEDES BUT NOT EQUIVALENT TO
-    'precsim': u'\u227e', # ≾ PRECEDES OR EQUIVALENT TO
-    'propto': u'\u221d', # ∝ PROPORTIONAL TO
-    'restriction': u'\u21be', # ↾ UPWARDS HARPOON WITH BARB RIGHTWARDS
-    'rightarrow': u'\u2192', # → RIGHTWARDS ARROW
-    'rightarrowtail': u'\u21a3', # ↣ RIGHTWARDS ARROW WITH TAIL
-    'rightarrowtriangle': u'\u21fe', # ⇾ RIGHTWARDS OPEN-HEADED ARROW
-    'rightbarharpoon': u'\u296c', # ⥬ RIGHTWARDS HARPOON WITH BARB UP ABOVE LONG DASH
-    'rightharpoondown': u'\u21c1', # ⇁ RIGHTWARDS HARPOON WITH BARB DOWNWARDS
-    'rightharpoonup': u'\u21c0', # ⇀ RIGHTWARDS HARPOON WITH BARB UPWARDS
-    'rightleftarrows': u'\u21c4', # ⇄ RIGHTWARDS ARROW OVER LEFTWARDS ARROW
-    'rightleftharpoon': u'\u294b', # ⥋ LEFT BARB DOWN RIGHT BARB UP HARPOON
-    'rightleftharpoons': u'\u21cc', # ⇌ RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON
-    'rightrightarrows': u'\u21c9', # ⇉ RIGHTWARDS PAIRED ARROWS
-    'rightrightharpoons': u'\u2964', # ⥤ RIGHTWARDS HARPOON WITH BARB UP ABOVE RIGHTWARDS HARPOON WITH BARB DOWN
-    'rightslice': u'\u2aa7', # ⪧ GREATER-THAN CLOSED BY CURVE
-    'rightsquigarrow': u'\u21dd', # ⇝ RIGHTWARDS SQUIGGLE ARROW
-    'risingdotseq': u'\u2253', # ≓ IMAGE OF OR APPROXIMATELY EQUAL TO
-    'searrow': u'\u2198', # ↘ SOUTH EAST ARROW
-    'sim': u'\u223c', # ∼ TILDE OPERATOR
-    'simeq': u'\u2243', # ≃ ASYMPTOTICALLY EQUAL TO
-    'smallfrown': u'\u2322', # ⌢ FROWN
-    'smallsmile': u'\u2323', # ⌣ SMILE
-    'smile': u'\u2323', # ⌣ SMILE
-    'sqsubset': u'\u228f', # ⊏ SQUARE IMAGE OF
-    'sqsubseteq': u'\u2291', # ⊑ SQUARE IMAGE OF OR EQUAL TO
-    'sqsupset': u'\u2290', # ⊐ SQUARE ORIGINAL OF
-    'sqsupseteq': u'\u2292', # ⊒ SQUARE ORIGINAL OF OR EQUAL TO
-    'subset': u'\u2282', # ⊂ SUBSET OF
-    'subseteq': u'\u2286', # ⊆ SUBSET OF OR EQUAL TO
-    'subseteqq': u'\u2ac5', # ⫅ SUBSET OF ABOVE EQUALS SIGN
-    'subsetneq': u'\u228a', # ⊊ SUBSET OF WITH NOT EQUAL TO
-    'subsetneqq': u'\u2acb', # ⫋ SUBSET OF ABOVE NOT EQUAL TO
-    'succ': u'\u227b', # ≻ SUCCEEDS
-    'succapprox': u'\u2ab8', # ⪸ SUCCEEDS ABOVE ALMOST EQUAL TO
-    'succcurlyeq': u'\u227d', # ≽ SUCCEEDS OR EQUAL TO
-    'succeq': u'\u2ab0', # ⪰ SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN
-    'succnapprox': u'\u2aba', # ⪺ SUCCEEDS ABOVE NOT ALMOST EQUAL TO
-    'succnsim': u'\u22e9', # ⋩ SUCCEEDS BUT NOT EQUIVALENT TO
-    'succsim': u'\u227f', # ≿ SUCCEEDS OR EQUIVALENT TO
-    'supset': u'\u2283', # ⊃ SUPERSET OF
-    'supseteq': u'\u2287', # ⊇ SUPERSET OF OR EQUAL TO
-    'supseteqq': u'\u2ac6', # ⫆ SUPERSET OF ABOVE EQUALS SIGN
-    'supsetneq': u'\u228b', # ⊋ SUPERSET OF WITH NOT EQUAL TO
-    'supsetneqq': u'\u2acc', # ⫌ SUPERSET OF ABOVE NOT EQUAL TO
-    'swarrow': u'\u2199', # ↙ SOUTH WEST ARROW
-    'to': u'\u2192', # → RIGHTWARDS ARROW
-    'trianglelefteq': u'\u22b4', # ⊴ NORMAL SUBGROUP OF OR EQUAL TO
-    'triangleq': u'\u225c', # ≜ DELTA EQUAL TO
-    'trianglerighteq': u'\u22b5', # ⊵ CONTAINS AS NORMAL SUBGROUP OR EQUAL TO
-    'twoheadleftarrow': u'\u219e', # ↞ LEFTWARDS TWO HEADED ARROW
-    'twoheadrightarrow': u'\u21a0', # ↠ RIGHTWARDS TWO HEADED ARROW
-    'uparrow': u'\u2191', # ↑ UPWARDS ARROW
-    'updownarrow': u'\u2195', # ↕ UP DOWN ARROW
-    'updownarrows': u'\u21c5', # ⇅ UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW
-    'updownharpoons': u'\u296e', # ⥮ UPWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT
-    'upharpoonleft': u'\u21bf', # ↿ UPWARDS HARPOON WITH BARB LEFTWARDS
-    'upharpoonright': u'\u21be', # ↾ UPWARDS HARPOON WITH BARB RIGHTWARDS
-    'upuparrows': u'\u21c8', # ⇈ UPWARDS PAIRED ARROWS
-    'upupharpoons': u'\u2963', # ⥣ UPWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT
-    'vDash': u'\u22a8', # ⊨ TRUE
-    'varpropto': u'\u221d', # ∝ PROPORTIONAL TO
-    'vartriangleleft': u'\u22b2', # ⊲ NORMAL SUBGROUP OF
-    'vartriangleright': u'\u22b3', # ⊳ CONTAINS AS NORMAL SUBGROUP
-    'vdash': u'\u22a2', # ⊢ RIGHT TACK
-    'vdots': u'\u22ee', # ⋮ VERTICAL ELLIPSIS
+    'Bot': '\u2aeb',  # ⫫ DOUBLE UP TACK
+    'Bumpeq': '\u224e',  # ≎ GEOMETRICALLY EQUIVALENT TO
+    'Coloneqq': '\u2a74',  # ⩴ DOUBLE COLON EQUAL
+    'Doteq': '\u2251',  # ≑ GEOMETRICALLY EQUAL TO
+    'Downarrow': '\u21d3',  # ⇓ DOWNWARDS DOUBLE ARROW
+    'Leftarrow': '\u21d0',  # ⇐ LEFTWARDS DOUBLE ARROW
+    'Leftrightarrow': '\u21d4',  # ⇔ LEFT RIGHT DOUBLE ARROW
+    'Lleftarrow': '\u21da',  # ⇚ LEFTWARDS TRIPLE ARROW
+    'Longleftarrow': '\u27f8',  # ⟸ LONG LEFTWARDS DOUBLE ARROW
+    'Longleftrightarrow': '\u27fa',  # ⟺ LONG LEFT RIGHT DOUBLE ARROW
+    'Longmapsfrom': '\u27fd',  # ⟽ LONG LEFTWARDS DOUBLE ARROW FROM BAR
+    'Longmapsto': '\u27fe',  # ⟾ LONG RIGHTWARDS DOUBLE ARROW FROM BAR
+    'Longrightarrow': '\u27f9',  # ⟹ LONG RIGHTWARDS DOUBLE ARROW
+    'Lsh': '\u21b0',  # ↰ UPWARDS ARROW WITH TIP LEFTWARDS
+    'Mapsfrom': '\u2906',  # ⤆ LEFTWARDS DOUBLE ARROW FROM BAR
+    'Mapsto': '\u2907',  # ⤇ RIGHTWARDS DOUBLE ARROW FROM BAR
+    'Nearrow': '\u21d7',  # ⇗ NORTH EAST DOUBLE ARROW
+    'Nwarrow': '\u21d6',  # ⇖ NORTH WEST DOUBLE ARROW
+    'Perp': '\u2aeb',  # ⫫ DOUBLE UP TACK
+    'Rightarrow': '\u21d2',  # ⇒ RIGHTWARDS DOUBLE ARROW
+    'Rrightarrow': '\u21db',  # ⇛ RIGHTWARDS TRIPLE ARROW
+    'Rsh': '\u21b1',  # ↱ UPWARDS ARROW WITH TIP RIGHTWARDS
+    'Searrow': '\u21d8',  # ⇘ SOUTH EAST DOUBLE ARROW
+    'Subset': '\u22d0',  # ⋐ DOUBLE SUBSET
+    'Supset': '\u22d1',  # ⋑ DOUBLE SUPERSET
+    'Swarrow': '\u21d9',  # ⇙ SOUTH WEST DOUBLE ARROW
+    'Top': '\u2aea',  # ⫪ DOUBLE DOWN TACK
+    'Uparrow': '\u21d1',  # ⇑ UPWARDS DOUBLE ARROW
+    'Updownarrow': '\u21d5',  # ⇕ UP DOWN DOUBLE ARROW
+    'VDash': '\u22ab',  # ⊫ DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE
+    'Vdash': '\u22a9',  # ⊩ FORCES
+    'Vvdash': '\u22aa',  # ⊪ TRIPLE VERTICAL BAR RIGHT TURNSTILE
+    'apprge': '\u2273',  # ≳ GREATER-THAN OR EQUIVALENT TO
+    'apprle': '\u2272',  # ≲ LESS-THAN OR EQUIVALENT TO
+    'approx': '\u2248',  # ≈ ALMOST EQUAL TO
+    'approxeq': '\u224a',  # ≊ ALMOST EQUAL OR EQUAL TO
+    'asymp': '\u224d',  # ≍ EQUIVALENT TO
+    'backepsilon': '\u220d',  # ∍ SMALL CONTAINS AS MEMBER
+    'backsim': '\u223d',  # ∽ REVERSED TILDE
+    'backsimeq': '\u22cd',  # ⋍ REVERSED TILDE EQUALS
+    'barin': '\u22f6',  # ⋶ ELEMENT OF WITH OVERBAR
+    'barleftharpoon': '\u296b',  # ⥫ LEFTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH
+    'barrightharpoon': '\u296d',  # ⥭ RIGHTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH
+    'because': '\u2235',  # ∵ BECAUSE
+    'between': '\u226c',  # ≬ BETWEEN
+    'blacktriangleleft': '\u25c2',  # ◂ BLACK LEFT-POINTING SMALL TRIANGLE
+    'blacktriangleright': '\u25b8',  # ▸ BLACK RIGHT-POINTING SMALL TRIANGLE
+    'bowtie': '\u22c8',  # ⋈ BOWTIE
+    'bumpeq': '\u224f',  # ≏ DIFFERENCE BETWEEN
+    'circeq': '\u2257',  # ≗ RING EQUAL TO
+    'circlearrowleft': '\u21ba',  # ↺ ANTICLOCKWISE OPEN CIRCLE ARROW
+    'circlearrowright': '\u21bb',  # ↻ CLOCKWISE OPEN CIRCLE ARROW
+    'coloneq': '\u2254',  # ≔ COLON EQUALS
+    'coloneqq': '\u2254',  # ≔ COLON EQUALS
+    'cong': '\u2245',  # ≅ APPROXIMATELY EQUAL TO
+    'corresponds': '\u2259',  # ≙ ESTIMATES
+    'curlyeqprec': '\u22de',  # ⋞ EQUAL TO OR PRECEDES
+    'curlyeqsucc': '\u22df',  # ⋟ EQUAL TO OR SUCCEEDS
+    'curvearrowleft': '\u21b6',  # ↶ ANTICLOCKWISE TOP SEMICIRCLE ARROW
+    'curvearrowright': '\u21b7',  # ↷ CLOCKWISE TOP SEMICIRCLE ARROW
+    'dasharrow': '\u21e2',  # ⇢ RIGHTWARDS DASHED ARROW
+    'dashleftarrow': '\u21e0',  # ⇠ LEFTWARDS DASHED ARROW
+    'dashrightarrow': '\u21e2',  # ⇢ RIGHTWARDS DASHED ARROW
+    'dashv': '\u22a3',  # ⊣ LEFT TACK
+    'dlsh': '\u21b2',  # ↲ DOWNWARDS ARROW WITH TIP LEFTWARDS
+    'doteq': '\u2250',  # ≐ APPROACHES THE LIMIT
+    'doteqdot': '\u2251',  # ≑ GEOMETRICALLY EQUAL TO
+    'downarrow': '\u2193',  # ↓ DOWNWARDS ARROW
+    'downdownarrows': '\u21ca',  # ⇊ DOWNWARDS PAIRED ARROWS
+    'downdownharpoons': '\u2965',  # ⥥ DOWNWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT
+    'downharpoonleft': '\u21c3',  # ⇃ DOWNWARDS HARPOON WITH BARB LEFTWARDS
+    'downharpoonright': '\u21c2',  # ⇂ DOWNWARDS HARPOON WITH BARB RIGHTWARDS
+    'downuparrows': '\u21f5',  # ⇵ DOWNWARDS ARROW LEFTWARDS OF UPWARDS ARROW
+    'downupharpoons': '\u296f',  # ⥯ DOWNWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT
+    'drsh': '\u21b3',  # ↳ DOWNWARDS ARROW WITH TIP RIGHTWARDS
+    'eqcirc': '\u2256',  # ≖ RING IN EQUAL TO
+    'eqcolon': '\u2255',  # ≕ EQUALS COLON
+    'eqqcolon': '\u2255',  # ≕ EQUALS COLON
+    'eqsim': '\u2242',  # ≂ MINUS TILDE
+    'eqslantgtr': '\u2a96',  # ⪖ SLANTED EQUAL TO OR GREATER-THAN
+    'eqslantless': '\u2a95',  # ⪕ SLANTED EQUAL TO OR LESS-THAN
+    'equiv': '\u2261',  # ≡ IDENTICAL TO
+    'fallingdotseq': '\u2252',  # ≒ APPROXIMATELY EQUAL TO OR THE IMAGE OF
+    'frown': '\u2322',  # ⌢ FROWN
+    'ge': '\u2265',  # ≥ GREATER-THAN OR EQUAL TO
+    'geq': '\u2265',  # ≥ GREATER-THAN OR EQUAL TO
+    'geqq': '\u2267',  # ≧ GREATER-THAN OVER EQUAL TO
+    'geqslant': '\u2a7e',  # ⩾ GREATER-THAN OR SLANTED EQUAL TO
+    'gets': '\u2190',  # ← LEFTWARDS ARROW
+    'gg': '\u226b',  # ≫ MUCH GREATER-THAN
+    'ggcurly': '\u2abc',  # ⪼ DOUBLE SUCCEEDS
+    'ggg': '\u22d9',  # ⋙ VERY MUCH GREATER-THAN
+    'gggtr': '\u22d9',  # ⋙ VERY MUCH GREATER-THAN
+    'gnapprox': '\u2a8a',  # ⪊ GREATER-THAN AND NOT APPROXIMATE
+    'gneq': '\u2a88',  # ⪈ GREATER-THAN AND SINGLE-LINE NOT EQUAL TO
+    'gneqq': '\u2269',  # ≩ GREATER-THAN BUT NOT EQUAL TO
+    'gnsim': '\u22e7',  # ⋧ GREATER-THAN BUT NOT EQUIVALENT TO
+    'gtrapprox': '\u2a86',  # ⪆ GREATER-THAN OR APPROXIMATE
+    'gtreqless': '\u22db',  # ⋛ GREATER-THAN EQUAL TO OR LESS-THAN
+    'gtreqqless': '\u2a8c',  # ⪌ GREATER-THAN ABOVE DOUBLE-LINE EQUAL ABOVE LESS-THAN
+    'gtrless': '\u2277',  # ≷ GREATER-THAN OR LESS-THAN
+    'gtrsim': '\u2273',  # ≳ GREATER-THAN OR EQUIVALENT TO
+    'hash': '\u22d5',  # ⋕ EQUAL AND PARALLEL TO
+    'hookleftarrow': '\u21a9',  # ↩ LEFTWARDS ARROW WITH HOOK
+    'hookrightarrow': '\u21aa',  # ↪ RIGHTWARDS ARROW WITH HOOK
+    'iddots': '\u22f0',  # ⋰ UP RIGHT DIAGONAL ELLIPSIS
+    'impliedby': '\u27f8',  # ⟸ LONG LEFTWARDS DOUBLE ARROW
+    'implies': '\u27f9',  # ⟹ LONG RIGHTWARDS DOUBLE ARROW
+    'in': '\u2208',  # ∈ ELEMENT OF
+    'le': '\u2264',  # ≤ LESS-THAN OR EQUAL TO
+    'leadsto': '\u2933',  # ⤳ WAVE ARROW POINTING DIRECTLY RIGHT
+    'leftarrow': '\u2190',  # ← LEFTWARDS ARROW
+    'leftarrowtail': '\u21a2',  # ↢ LEFTWARDS ARROW WITH TAIL
+    'leftarrowtriangle': '\u21fd',  # ⇽ LEFTWARDS OPEN-HEADED ARROW
+    'leftbarharpoon': '\u296a',  # ⥪ LEFTWARDS HARPOON WITH BARB UP ABOVE LONG DASH
+    'leftharpoondown': '\u21bd',  # ↽ LEFTWARDS HARPOON WITH BARB DOWNWARDS
+    'leftharpoonup': '\u21bc',  # ↼ LEFTWARDS HARPOON WITH BARB UPWARDS
+    'leftleftarrows': '\u21c7',  # ⇇ LEFTWARDS PAIRED ARROWS
+    'leftleftharpoons': '\u2962',  # ⥢ LEFTWARDS HARPOON WITH BARB UP ABOVE LEFTWARDS HARPOON WITH BARB DOWN
+    'leftrightarrow': '\u2194',  # ↔ LEFT RIGHT ARROW
+    'leftrightarrows': '\u21c6',  # ⇆ LEFTWARDS ARROW OVER RIGHTWARDS ARROW
+    'leftrightarrowtriangle': '\u21ff',  # ⇿ LEFT RIGHT OPEN-HEADED ARROW
+    'leftrightharpoon': '\u294a',  # ⥊ LEFT BARB UP RIGHT BARB DOWN HARPOON
+    'leftrightharpoons': '\u21cb',  # ⇋ LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON
+    'leftrightsquigarrow': '\u21ad',  # ↭ LEFT RIGHT WAVE ARROW
+    'leftslice': '\u2aa6',  # ⪦ LESS-THAN CLOSED BY CURVE
+    'leftsquigarrow': '\u21dc',  # ⇜ LEFTWARDS SQUIGGLE ARROW
+    'leftturn': '\u21ba',  # ↺ ANTICLOCKWISE OPEN CIRCLE ARROW
+    'leq': '\u2264',  # ≤ LESS-THAN OR EQUAL TO
+    'leqq': '\u2266',  # ≦ LESS-THAN OVER EQUAL TO
+    'leqslant': '\u2a7d',  # ⩽ LESS-THAN OR SLANTED EQUAL TO
+    'lessapprox': '\u2a85',  # ⪅ LESS-THAN OR APPROXIMATE
+    'lesseqgtr': '\u22da',  # ⋚ LESS-THAN EQUAL TO OR GREATER-THAN
+    'lesseqqgtr': '\u2a8b',  # ⪋ LESS-THAN ABOVE DOUBLE-LINE EQUAL ABOVE GREATER-THAN
+    'lessgtr': '\u2276',  # ≶ LESS-THAN OR GREATER-THAN
+    'lesssim': '\u2272',  # ≲ LESS-THAN OR EQUIVALENT TO
+    'lhd': '\u22b2',  # ⊲ NORMAL SUBGROUP OF
+    'lightning': '\u21af',  # ↯ DOWNWARDS ZIGZAG ARROW
+    'll': '\u226a',  # ≪ MUCH LESS-THAN
+    'llcurly': '\u2abb',  # ⪻ DOUBLE PRECEDES
+    'lll': '\u22d8',  # ⋘ VERY MUCH LESS-THAN
+    'llless': '\u22d8',  # ⋘ VERY MUCH LESS-THAN
+    'lnapprox': '\u2a89',  # ⪉ LESS-THAN AND NOT APPROXIMATE
+    'lneq': '\u2a87',  # ⪇ LESS-THAN AND SINGLE-LINE NOT EQUAL TO
+    'lneqq': '\u2268',  # ≨ LESS-THAN BUT NOT EQUAL TO
+    'lnsim': '\u22e6',  # ⋦ LESS-THAN BUT NOT EQUIVALENT TO
+    'longleftarrow': '\u27f5',  # ⟵ LONG LEFTWARDS ARROW
+    'longleftrightarrow': '\u27f7',  # ⟷ LONG LEFT RIGHT ARROW
+    'longmapsfrom': '\u27fb',  # ⟻ LONG LEFTWARDS ARROW FROM BAR
+    'longmapsto': '\u27fc',  # ⟼ LONG RIGHTWARDS ARROW FROM BAR
+    'longrightarrow': '\u27f6',  # ⟶ LONG RIGHTWARDS ARROW
+    'looparrowleft': '\u21ab',  # ↫ LEFTWARDS ARROW WITH LOOP
+    'looparrowright': '\u21ac',  # ↬ RIGHTWARDS ARROW WITH LOOP
+    'lrtimes': '\u22c8',  # ⋈ BOWTIE
+    'mapsfrom': '\u21a4',  # ↤ LEFTWARDS ARROW FROM BAR
+    'mapsto': '\u21a6',  # ↦ RIGHTWARDS ARROW FROM BAR
+    'mid': '\u2223',  # ∣ DIVIDES
+    'models': '\u22a7',  # ⊧ MODELS
+    'multimap': '\u22b8',  # ⊸ MULTIMAP
+    'multimapboth': '\u29df',  # ⧟ DOUBLE-ENDED MULTIMAP
+    'multimapdotbothA': '\u22b6',  # ⊶ ORIGINAL OF
+    'multimapdotbothB': '\u22b7',  # ⊷ IMAGE OF
+    'multimapinv': '\u27dc',  # ⟜ LEFT MULTIMAP
+    'nLeftarrow': '\u21cd',  # ⇍ LEFTWARDS DOUBLE ARROW WITH STROKE
+    'nLeftrightarrow': '\u21ce',  # ⇎ LEFT RIGHT DOUBLE ARROW WITH STROKE
+    'nRightarrow': '\u21cf',  # ⇏ RIGHTWARDS DOUBLE ARROW WITH STROKE
+    'nVDash': '\u22af',  # ⊯ NEGATED DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE
+    'nVdash': '\u22ae',  # ⊮ DOES NOT FORCE
+    'ncong': '\u2247',  # ≇ NEITHER APPROXIMATELY NOR ACTUALLY EQUAL TO
+    'ne': '\u2260',  # ≠ NOT EQUAL TO
+    'nearrow': '\u2197',  # ↗ NORTH EAST ARROW
+    'neq': '\u2260',  # ≠ NOT EQUAL TO
+    'ngeq': '\u2271',  # ≱ NEITHER GREATER-THAN NOR EQUAL TO
+    'ngtr': '\u226f',  # ≯ NOT GREATER-THAN
+    'ngtrless': '\u2279',  # ≹ NEITHER GREATER-THAN NOR LESS-THAN
+    'ni': '\u220b',  # ∋ CONTAINS AS MEMBER
+    'nleftarrow': '\u219a',  # ↚ LEFTWARDS ARROW WITH STROKE
+    'nleftrightarrow': '\u21ae',  # ↮ LEFT RIGHT ARROW WITH STROKE
+    'nleq': '\u2270',  # ≰ NEITHER LESS-THAN NOR EQUAL TO
+    'nless': '\u226e',  # ≮ NOT LESS-THAN
+    'nlessgtr': '\u2278',  # ≸ NEITHER LESS-THAN NOR GREATER-THAN
+    'nmid': '\u2224',  # ∤ DOES NOT DIVIDE
+    'notasymp': '\u226d',  # ≭ NOT EQUIVALENT TO
+    'notin': '\u2209',  # ∉ NOT AN ELEMENT OF
+    'notni': '\u220c',  # ∌ DOES NOT CONTAIN AS MEMBER
+    'notowner': '\u220c',  # ∌ DOES NOT CONTAIN AS MEMBER
+    'notslash': '\u233f',  # ⌿ APL FUNCTIONAL SYMBOL SLASH BAR
+    'nparallel': '\u2226',  # ∦ NOT PARALLEL TO
+    'nprec': '\u2280',  # ⊀ DOES NOT PRECEDE
+    'npreceq': '\u22e0',  # ⋠ DOES NOT PRECEDE OR EQUAL
+    'nrightarrow': '\u219b',  # ↛ RIGHTWARDS ARROW WITH STROKE
+    'nsim': '\u2241',  # ≁ NOT TILDE
+    'nsimeq': '\u2244',  # ≄ NOT ASYMPTOTICALLY EQUAL TO
+    'nsubseteq': '\u2288',  # ⊈ NEITHER A SUBSET OF NOR EQUAL TO
+    'nsucc': '\u2281',  # ⊁ DOES NOT SUCCEED
+    'nsucceq': '\u22e1',  # ⋡ DOES NOT SUCCEED OR EQUAL
+    'nsupseteq': '\u2289',  # ⊉ NEITHER A SUPERSET OF NOR EQUAL TO
+    'ntriangleleft': '\u22ea',  # ⋪ NOT NORMAL SUBGROUP OF
+    'ntrianglelefteq': '\u22ec',  # ⋬ NOT NORMAL SUBGROUP OF OR EQUAL TO
+    'ntriangleright': '\u22eb',  # ⋫ DOES NOT CONTAIN AS NORMAL SUBGROUP
+    'ntrianglerighteq': '\u22ed',  # ⋭ DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL
+    'nvDash': '\u22ad',  # ⊭ NOT TRUE
+    'nvdash': '\u22ac',  # ⊬ DOES NOT PROVE
+    'nwarrow': '\u2196',  # ↖ NORTH WEST ARROW
+    'owns': '\u220b',  # ∋ CONTAINS AS MEMBER
+    'parallel': '\u2225',  # ∥ PARALLEL TO
+    'perp': '\u27c2',  # ⟂ PERPENDICULAR
+    'pitchfork': '\u22d4',  # ⋔ PITCHFORK
+    'prec': '\u227a',  # ≺ PRECEDES
+    'precapprox': '\u2ab7',  # ⪷ PRECEDES ABOVE ALMOST EQUAL TO
+    'preccurlyeq': '\u227c',  # ≼ PRECEDES OR EQUAL TO
+    'preceq': '\u2aaf',  # ⪯ PRECEDES ABOVE SINGLE-LINE EQUALS SIGN
+    'preceqq': '\u2ab3',  # ⪳ PRECEDES ABOVE EQUALS SIGN
+    'precnapprox': '\u2ab9',  # ⪹ PRECEDES ABOVE NOT ALMOST EQUAL TO
+    'precneqq': '\u2ab5',  # ⪵ PRECEDES ABOVE NOT EQUAL TO
+    'precnsim': '\u22e8',  # ⋨ PRECEDES BUT NOT EQUIVALENT TO
+    'precsim': '\u227e',  # ≾ PRECEDES OR EQUIVALENT TO
+    'propto': '\u221d',  # ∝ PROPORTIONAL TO
+    'restriction': '\u21be',  # ↾ UPWARDS HARPOON WITH BARB RIGHTWARDS
+    'rhd': '\u22b3',  # ⊳ CONTAINS AS NORMAL SUBGROUP
+    'rightarrow': '\u2192',  # → RIGHTWARDS ARROW
+    'rightarrowtail': '\u21a3',  # ↣ RIGHTWARDS ARROW WITH TAIL
+    'rightarrowtriangle': '\u21fe',  # ⇾ RIGHTWARDS OPEN-HEADED ARROW
+    'rightbarharpoon': '\u296c',  # ⥬ RIGHTWARDS HARPOON WITH BARB UP ABOVE LONG DASH
+    'rightharpoondown': '\u21c1',  # ⇁ RIGHTWARDS HARPOON WITH BARB DOWNWARDS
+    'rightharpoonup': '\u21c0',  # ⇀ RIGHTWARDS HARPOON WITH BARB UPWARDS
+    'rightleftarrows': '\u21c4',  # ⇄ RIGHTWARDS ARROW OVER LEFTWARDS ARROW
+    'rightleftharpoon': '\u294b',  # ⥋ LEFT BARB DOWN RIGHT BARB UP HARPOON
+    'rightleftharpoons': '\u21cc',  # ⇌ RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON
+    'rightrightarrows': '\u21c9',  # ⇉ RIGHTWARDS PAIRED ARROWS
+    'rightrightharpoons': '\u2964',  # ⥤ RIGHTWARDS HARPOON WITH BARB UP ABOVE RIGHTWARDS HARPOON WITH BARB DOWN
+    'rightslice': '\u2aa7',  # ⪧ GREATER-THAN CLOSED BY CURVE
+    'rightsquigarrow': '\u21dd',  # ⇝ RIGHTWARDS SQUIGGLE ARROW
+    'rightturn': '\u21bb',  # ↻ CLOCKWISE OPEN CIRCLE ARROW
+    'risingdotseq': '\u2253',  # ≓ IMAGE OF OR APPROXIMATELY EQUAL TO
+    'searrow': '\u2198',  # ↘ SOUTH EAST ARROW
+    'sim': '\u223c',  # ∼ TILDE OPERATOR
+    'simeq': '\u2243',  # ≃ ASYMPTOTICALLY EQUAL TO
+    'smile': '\u2323',  # ⌣ SMILE
+    'sqsubset': '\u228f',  # ⊏ SQUARE IMAGE OF
+    'sqsubseteq': '\u2291',  # ⊑ SQUARE IMAGE OF OR EQUAL TO
+    'sqsupset': '\u2290',  # ⊐ SQUARE ORIGINAL OF
+    'sqsupseteq': '\u2292',  # ⊒ SQUARE ORIGINAL OF OR EQUAL TO
+    'strictfi': '\u297c',  # ⥼ LEFT FISH TAIL
+    'strictif': '\u297d',  # ⥽ RIGHT FISH TAIL
+    'subset': '\u2282',  # ⊂ SUBSET OF
+    'subseteq': '\u2286',  # ⊆ SUBSET OF OR EQUAL TO
+    'subseteqq': '\u2ac5',  # ⫅ SUBSET OF ABOVE EQUALS SIGN
+    'subsetneq': '\u228a',  # ⊊ SUBSET OF WITH NOT EQUAL TO
+    'subsetneqq': '\u2acb',  # ⫋ SUBSET OF ABOVE NOT EQUAL TO
+    'succ': '\u227b',  # ≻ SUCCEEDS
+    'succapprox': '\u2ab8',  # ⪸ SUCCEEDS ABOVE ALMOST EQUAL TO
+    'succcurlyeq': '\u227d',  # ≽ SUCCEEDS OR EQUAL TO
+    'succeq': '\u2ab0',  # ⪰ SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN
+    'succeqq': '\u2ab4',  # ⪴ SUCCEEDS ABOVE EQUALS SIGN
+    'succnapprox': '\u2aba',  # ⪺ SUCCEEDS ABOVE NOT ALMOST EQUAL TO
+    'succneqq': '\u2ab6',  # ⪶ SUCCEEDS ABOVE NOT EQUAL TO
+    'succnsim': '\u22e9',  # ⋩ SUCCEEDS BUT NOT EQUIVALENT TO
+    'succsim': '\u227f',  # ≿ SUCCEEDS OR EQUIVALENT TO
+    'supset': '\u2283',  # ⊃ SUPERSET OF
+    'supseteq': '\u2287',  # ⊇ SUPERSET OF OR EQUAL TO
+    'supseteqq': '\u2ac6',  # ⫆ SUPERSET OF ABOVE EQUALS SIGN
+    'supsetneq': '\u228b',  # ⊋ SUPERSET OF WITH NOT EQUAL TO
+    'supsetneqq': '\u2acc',  # ⫌ SUPERSET OF ABOVE NOT EQUAL TO
+    'swarrow': '\u2199',  # ↙ SOUTH WEST ARROW
+    'therefore': '\u2234',  # ∴ THEREFORE
+    'to': '\u2192',  # → RIGHTWARDS ARROW
+    'trianglelefteq': '\u22b4',  # ⊴ NORMAL SUBGROUP OF OR EQUAL TO
+    'triangleq': '\u225c',  # ≜ DELTA EQUAL TO
+    'trianglerighteq': '\u22b5',  # ⊵ CONTAINS AS NORMAL SUBGROUP OR EQUAL TO
+    'twoheadleftarrow': '\u219e',  # ↞ LEFTWARDS TWO HEADED ARROW
+    'twoheadrightarrow': '\u21a0',  # ↠ RIGHTWARDS TWO HEADED ARROW
+    'uparrow': '\u2191',  # ↑ UPWARDS ARROW
+    'updownarrow': '\u2195',  # ↕ UP DOWN ARROW
+    'updownarrows': '\u21c5',  # ⇅ UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW
+    'updownharpoons': '\u296e',  # ⥮ UPWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT
+    'upharpoonleft': '\u21bf',  # ↿ UPWARDS HARPOON WITH BARB LEFTWARDS
+    'upharpoonright': '\u21be',  # ↾ UPWARDS HARPOON WITH BARB RIGHTWARDS
+    'upuparrows': '\u21c8',  # ⇈ UPWARDS PAIRED ARROWS
+    'upupharpoons': '\u2963',  # ⥣ UPWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT
+    'vDash': '\u22a8',  # ⊨ TRUE
+    'vartriangle': '\u25b5',  # ▵ WHITE UP-POINTING SMALL TRIANGLE
+    'vartriangleleft': '\u22b2',  # ⊲ NORMAL SUBGROUP OF
+    'vartriangleright': '\u22b3',  # ⊳ CONTAINS AS NORMAL SUBGROUP
+    'vdash': '\u22a2',  # ⊢ RIGHT TACK
+    'wasytherefore': '\u2234',  # ∴ THEREFORE
     }
+
 mathunder = {
-    'underbrace': u'\u23df', # ⏟ BOTTOM CURLY BRACKET
+    'underbrace': '\u23df',  # ⏟ BOTTOM CURLY BRACKET
     }
+
 space = {
-    ':': u'\u205f', #   MEDIUM MATHEMATICAL SPACE
-    'medspace': u'\u205f', #   MEDIUM MATHEMATICAL SPACE
-    'quad': u'\u2001', #   EM QUAD
+    ' ': ' ',  #   SPACE
+    ',': '\u2006',  #   SIX-PER-EM SPACE
+    ':': '\u205f',  #   MEDIUM MATHEMATICAL SPACE
+    'medspace': '\u205f',  #   MEDIUM MATHEMATICAL SPACE
+    'quad': '\u2001',  #   EM QUAD
+    'thinspace': '\u2006',  #   SIX-PER-EM SPACE
     }

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/math/unichar2tex.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/math/unichar2tex.py Changed

@@ -6,783 +6,803 @@
 # Includes commands from: standard LaTeX, amssymb, amsmath
 
 uni2tex_table = {
-160: u'~',
-163: u'\\pounds ',
-165: u'\\yen ',
-172: u'\\neg ',
-174: u'\\circledR ',
-177: u'\\pm ',
-215: u'\\times ',
-240: u'\\eth ',
-247: u'\\div ',
-305: u'\\imath ',
-567: u'\\jmath ',
-915: u'\\Gamma ',
-916: u'\\Delta ',
-920: u'\\Theta ',
-923: u'\\Lambda ',
-926: u'\\Xi ',
-928: u'\\Pi ',
-931: u'\\Sigma ',
-933: u'\\Upsilon ',
-934: u'\\Phi ',
-936: u'\\Psi ',
-937: u'\\Omega ',
-945: u'\\alpha ',
-946: u'\\beta ',
-947: u'\\gamma ',
-948: u'\\delta ',
-949: u'\\varepsilon ',
-950: u'\\zeta ',
-951: u'\\eta ',
-952: u'\\theta ',
-953: u'\\iota ',
-954: u'\\kappa ',
-955: u'\\lambda ',
-956: u'\\mu ',
-957: u'\\nu ',
-958: u'\\xi ',
-960: u'\\pi ',
-961: u'\\rho ',
-962: u'\\varsigma ',
-963: u'\\sigma ',
-964: u'\\tau ',
-965: u'\\upsilon ',
-966: u'\\varphi ',
-967: u'\\chi ',
-968: u'\\psi ',
-969: u'\\omega ',
-977: u'\\vartheta ',
-981: u'\\phi ',
-982: u'\\varpi ',
-989: u'\\digamma ',
-1014: u'\\backepsilon ',
-8193: u'\\quad ',
-8214: u'\\| ',
-8224: u'\\dagger ',
-8225: u'\\ddagger ',
-8230: u'\\ldots ',
-8242: u'\\prime ',
-8245: u'\\backprime ',
-8287: u'\\: ',
-8450: u'\\mathbb{C}',
-8459: u'\\mathcal{H}',
-8460: u'\\mathfrak{H}',
-8461: u'\\mathbb{H}',
-8463: u'\\hslash ',
-8464: u'\\mathcal{I}',
-8465: u'\\Im ',
-8466: u'\\mathcal{L}',
-8467: u'\\ell ',
-8469: u'\\mathbb{N}',
-8472: u'\\wp ',
-8473: u'\\mathbb{P}',
-8474: u'\\mathbb{Q}',
-8475: u'\\mathcal{R}',
-8476: u'\\Re ',
-8477: u'\\mathbb{R}',
-8484: u'\\mathbb{Z}',
-8487: u'\\mho ',
-8488: u'\\mathfrak{Z}',
-8492: u'\\mathcal{B}',
-8493: u'\\mathfrak{C}',
-8496: u'\\mathcal{E}',
-8497: u'\\mathcal{F}',
-8498: u'\\Finv ',
-8499: u'\\mathcal{M}',
-8501: u'\\aleph ',
-8502: u'\\beth ',
-8503: u'\\gimel ',
-8504: u'\\daleth ',
-8592: u'\\leftarrow ',
-8593: u'\\uparrow ',
-8594: u'\\rightarrow ',
-8595: u'\\downarrow ',
-8596: u'\\leftrightarrow ',
-8597: u'\\updownarrow ',
-8598: u'\\nwarrow ',
-8599: u'\\nearrow ',
-8600: u'\\searrow ',
-8601: u'\\swarrow ',
-8602: u'\\nleftarrow ',
-8603: u'\\nrightarrow ',
-8606: u'\\twoheadleftarrow ',
-8608: u'\\twoheadrightarrow ',
-8610: u'\\leftarrowtail ',
-8611: u'\\rightarrowtail ',
-8614: u'\\mapsto ',
-8617: u'\\hookleftarrow ',
-8618: u'\\hookrightarrow ',
-8619: u'\\looparrowleft ',
-8620: u'\\looparrowright ',
-8621: u'\\leftrightsquigarrow ',
-8622: u'\\nleftrightarrow ',
-8624: u'\\Lsh ',
-8625: u'\\Rsh ',
-8630: u'\\curvearrowleft ',
-8631: u'\\curvearrowright ',
-8634: u'\\circlearrowleft ',
-8635: u'\\circlearrowright ',
-8636: u'\\leftharpoonup ',
-8637: u'\\leftharpoondown ',
-8638: u'\\upharpoonright ',
-8639: u'\\upharpoonleft ',
-8640: u'\\rightharpoonup ',
-8641: u'\\rightharpoondown ',
-8642: u'\\downharpoonright ',
-8643: u'\\downharpoonleft ',
-8644: u'\\rightleftarrows ',
-8646: u'\\leftrightarrows ',
-8647: u'\\leftleftarrows ',
-8648: u'\\upuparrows ',
-8649: u'\\rightrightarrows ',
-8650: u'\\downdownarrows ',
-8651: u'\\leftrightharpoons ',
-8652: u'\\rightleftharpoons ',
-8653: u'\\nLeftarrow ',
-8654: u'\\nLeftrightarrow ',
-8655: u'\\nRightarrow ',
-8656: u'\\Leftarrow ',
-8657: u'\\Uparrow ',
-8658: u'\\Rightarrow ',
-8659: u'\\Downarrow ',
-8660: u'\\Leftrightarrow ',
-8661: u'\\Updownarrow ',
-8666: u'\\Lleftarrow ',
-8667: u'\\Rrightarrow ',
-8669: u'\\rightsquigarrow ',
-8672: u'\\dashleftarrow ',
-8674: u'\\dashrightarrow ',
-8704: u'\\forall ',
-8705: u'\\complement ',
-8706: u'\\partial ',
-8707: u'\\exists ',
-8708: u'\\nexists ',
-8709: u'\\varnothing ',
-8711: u'\\nabla ',
-8712: u'\\in ',
-8713: u'\\notin ',
-8715: u'\\ni ',
-8719: u'\\prod ',
-8720: u'\\coprod ',
-8721: u'\\sum ',
-8722: u'-',
-8723: u'\\mp ',
-8724: u'\\dotplus ',
-8725: u'\\slash ',
-8726: u'\\smallsetminus ',
-8727: u'\\ast ',
-8728: u'\\circ ',
-8729: u'\\bullet ',
-8730: u'\\sqrt ',
-8731: u'\\sqrt3 ',
-8732: u'\\sqrt4 ',
-8733: u'\\propto ',
-8734: u'\\infty ',
-8736: u'\\angle ',
-8737: u'\\measuredangle ',
-8738: u'\\sphericalangle ',
-8739: u'\\mid ',
-8740: u'\\nmid ',
-8741: u'\\parallel ',
-8742: u'\\nparallel ',
-8743: u'\\wedge ',
-8744: u'\\vee ',
-8745: u'\\cap ',
-8746: u'\\cup ',
-8747: u'\\int ',
-8748: u'\\iint ',
-8749: u'\\iiint ',
-8750: u'\\oint ',
-8756: u'\\therefore ',
-8757: u'\\because ',
-8758: u':',
-8764: u'\\sim ',
-8765: u'\\backsim ',
-8768: u'\\wr ',
-8769: u'\\nsim ',
-8770: u'\\eqsim ',
-8771: u'\\simeq ',
-8773: u'\\cong ',
-8775: u'\\ncong ',
-8776: u'\\approx ',
-8778: u'\\approxeq ',
-8781: u'\\asymp ',
-8782: u'\\Bumpeq ',
-8783: u'\\bumpeq ',
-8784: u'\\doteq ',
-8785: u'\\Doteq ',
-8786: u'\\fallingdotseq ',
-8787: u'\\risingdotseq ',
-8790: u'\\eqcirc ',
-8791: u'\\circeq ',
-8796: u'\\triangleq ',
-8800: u'\\neq ',
-8801: u'\\equiv ',
-8804: u'\\leq ',
-8805: u'\\geq ',
-8806: u'\\leqq ',
-8807: u'\\geqq ',
-8808: u'\\lneqq ',
-8809: u'\\gneqq ',
-8810: u'\\ll ',
-8811: u'\\gg ',
-8812: u'\\between ',
-8814: u'\\nless ',
-8815: u'\\ngtr ',
-8816: u'\\nleq ',
-8817: u'\\ngeq ',
-8818: u'\\lesssim ',
-8819: u'\\gtrsim ',
-8822: u'\\lessgtr ',
-8823: u'\\gtrless ',
-8826: u'\\prec ',
-8827: u'\\succ ',
-8828: u'\\preccurlyeq ',
-8829: u'\\succcurlyeq ',
-8830: u'\\precsim ',
-8831: u'\\succsim ',
-8832: u'\\nprec ',
-8833: u'\\nsucc ',
-8834: u'\\subset ',
-8835: u'\\supset ',
-8838: u'\\subseteq ',
-8839: u'\\supseteq ',
-8840: u'\\nsubseteq ',
-8841: u'\\nsupseteq ',
-8842: u'\\subsetneq ',
-8843: u'\\supsetneq ',
-8846: u'\\uplus ',
-8847: u'\\sqsubset ',
-8848: u'\\sqsupset ',
-8849: u'\\sqsubseteq ',
-8850: u'\\sqsupseteq ',
-8851: u'\\sqcap ',
-8852: u'\\sqcup ',
-8853: u'\\oplus ',
-8854: u'\\ominus ',
-8855: u'\\otimes ',
-8856: u'\\oslash ',
-8857: u'\\odot ',
-8858: u'\\circledcirc ',
-8859: u'\\circledast ',
-8861: u'\\circleddash ',
-8862: u'\\boxplus ',
-8863: u'\\boxminus ',
-8864: u'\\boxtimes ',
-8865: u'\\boxdot ',
-8866: u'\\vdash ',
-8867: u'\\dashv ',
-8868: u'\\top ',
-8869: u'\\bot ',
-8871: u'\\models ',
-8872: u'\\vDash ',
-8873: u'\\Vdash ',
-8874: u'\\Vvdash ',
-8876: u'\\nvdash ',
-8877: u'\\nvDash ',
-8878: u'\\nVdash ',
-8879: u'\\nVDash ',
-8882: u'\\vartriangleleft ',
-8883: u'\\vartriangleright ',
-8884: u'\\trianglelefteq ',
-8885: u'\\trianglerighteq ',
-8888: u'\\multimap ',
-8890: u'\\intercal ',
-8891: u'\\veebar ',
-8892: u'\\barwedge ',
-8896: u'\\bigwedge ',
-8897: u'\\bigvee ',
-8898: u'\\bigcap ',
-8899: u'\\bigcup ',
-8900: u'\\diamond ',
-8901: u'\\cdot ',
-8902: u'\\star ',
-8903: u'\\divideontimes ',
-8904: u'\\bowtie ',
-8905: u'\\ltimes ',
-8906: u'\\rtimes ',
-8907: u'\\leftthreetimes ',
-8908: u'\\rightthreetimes ',
-8909: u'\\backsimeq ',
-8910: u'\\curlyvee ',
-8911: u'\\curlywedge ',
-8912: u'\\Subset ',
-8913: u'\\Supset ',
-8914: u'\\Cap ',
-8915: u'\\Cup ',
-8916: u'\\pitchfork ',
-8918: u'\\lessdot ',
-8919: u'\\gtrdot ',
-8920: u'\\lll ',
-8921: u'\\ggg ',
-8922: u'\\lesseqgtr ',
-8923: u'\\gtreqless ',
-8926: u'\\curlyeqprec ',
-8927: u'\\curlyeqsucc ',
-8928: u'\\npreceq ',
-8929: u'\\nsucceq ',
-8934: u'\\lnsim ',
-8935: u'\\gnsim ',
-8936: u'\\precnsim ',
-8937: u'\\succnsim ',
-8938: u'\\ntriangleleft ',
-8939: u'\\ntriangleright ',
-8940: u'\\ntrianglelefteq ',
-8941: u'\\ntrianglerighteq ',
-8942: u'\\vdots ',
-8943: u'\\cdots ',
-8945: u'\\ddots ',
-8968: u'\\lceil ',
-8969: u'\\rceil ',
-8970: u'\\lfloor ',
-8971: u'\\rfloor ',
-8988: u'\\ulcorner ',
-8989: u'\\urcorner ',
-8990: u'\\llcorner ',
-8991: u'\\lrcorner ',
-8994: u'\\frown ',
-8995: u'\\smile ',
-9182: u'\\overbrace ',
-9183: u'\\underbrace ',
-9651: u'\\bigtriangleup ',
-9655: u'\\rhd ',
-9661: u'\\bigtriangledown ',
-9665: u'\\lhd ',
-9671: u'\\Diamond ',
-9674: u'\\lozenge ',
-9723: u'\\square ',
-9724: u'\\blacksquare ',
-9733: u'\\bigstar ',
-9824: u'\\spadesuit ',
-9825: u'\\heartsuit ',
-9826: u'\\diamondsuit ',
-9827: u'\\clubsuit ',
-9837: u'\\flat ',
-9838: u'\\natural ',
-9839: u'\\sharp ',
-10003: u'\\checkmark ',
-10016: u'\\maltese ',
-10178: u'\\perp ',
-10216: u'\\langle ',
-10217: u'\\rangle ',
-10222: u'\\lgroup ',
-10223: u'\\rgroup ',
-10229: u'\\longleftarrow ',
-10230: u'\\longrightarrow ',
-10231: u'\\longleftrightarrow ',
-10232: u'\\Longleftarrow ',
-10233: u'\\Longrightarrow ',
-10234: u'\\Longleftrightarrow ',
-10236: u'\\longmapsto ',
-10731: u'\\blacklozenge ',
-10741: u'\\setminus ',
-10752: u'\\bigodot ',
-10753: u'\\bigoplus ',
-10754: u'\\bigotimes ',
-10756: u'\\biguplus ',
-10758: u'\\bigsqcup ',
-10764: u'\\iiiint ',
-10781: u'\\Join ',
-10815: u'\\amalg ',
-10846: u'\\doublebarwedge ',
-10877: u'\\leqslant ',
-10878: u'\\geqslant ',
-10885: u'\\lessapprox ',
-10886: u'\\gtrapprox ',
-10887: u'\\lneq ',
-10888: u'\\gneq ',
-10889: u'\\lnapprox ',
-10890: u'\\gnapprox ',
-10891: u'\\lesseqqgtr ',
-10892: u'\\gtreqqless ',
-10901: u'\\eqslantless ',
-10902: u'\\eqslantgtr ',
-10927: u'\\preceq ',
-10928: u'\\succeq ',
-10935: u'\\precapprox ',
-10936: u'\\succapprox ',
-10937: u'\\precnapprox ',
-10938: u'\\succnapprox ',
-10949: u'\\subseteqq ',
-10950: u'\\supseteqq ',
-10955: u'\\subsetneqq ',
-10956: u'\\supsetneqq ',
-119808: u'\\mathbf{A}',
-119809: u'\\mathbf{B}',
-119810: u'\\mathbf{C}',
-119811: u'\\mathbf{D}',
-119812: u'\\mathbf{E}',
-119813: u'\\mathbf{F}',
-119814: u'\\mathbf{G}',
-119815: u'\\mathbf{H}',
-119816: u'\\mathbf{I}',
-119817: u'\\mathbf{J}',
-119818: u'\\mathbf{K}',
-119819: u'\\mathbf{L}',
-119820: u'\\mathbf{M}',
-119821: u'\\mathbf{N}',
-119822: u'\\mathbf{O}',
-119823: u'\\mathbf{P}',
-119824: u'\\mathbf{Q}',
-119825: u'\\mathbf{R}',
-119826: u'\\mathbf{S}',
-119827: u'\\mathbf{T}',
-119828: u'\\mathbf{U}',
-119829: u'\\mathbf{V}',
-119830: u'\\mathbf{W}',
-119831: u'\\mathbf{X}',
-119832: u'\\mathbf{Y}',
-119833: u'\\mathbf{Z}',
-119834: u'\\mathbf{a}',
-119835: u'\\mathbf{b}',
-119836: u'\\mathbf{c}',
-119837: u'\\mathbf{d}',
-119838: u'\\mathbf{e}',
-119839: u'\\mathbf{f}',
-119840: u'\\mathbf{g}',
-119841: u'\\mathbf{h}',
-119842: u'\\mathbf{i}',
-119843: u'\\mathbf{j}',
-119844: u'\\mathbf{k}',
-119845: u'\\mathbf{l}',
-119846: u'\\mathbf{m}',
-119847: u'\\mathbf{n}',
-119848: u'\\mathbf{o}',
-119849: u'\\mathbf{p}',
-119850: u'\\mathbf{q}',
-119851: u'\\mathbf{r}',
-119852: u'\\mathbf{s}',
-119853: u'\\mathbf{t}',
-119854: u'\\mathbf{u}',
-119855: u'\\mathbf{v}',
-119856: u'\\mathbf{w}',
-119857: u'\\mathbf{x}',
-119858: u'\\mathbf{y}',
-119859: u'\\mathbf{z}',
-119860: u'A',
-119861: u'B',
-119862: u'C',
-119863: u'D',
-119864: u'E',
-119865: u'F',
-119866: u'G',
-119867: u'H',
-119868: u'I',
-119869: u'J',
-119870: u'K',
-119871: u'L',
-119872: u'M',
-119873: u'N',
-119874: u'O',
-119875: u'P',
-119876: u'Q',
-119877: u'R',
-119878: u'S',
-119879: u'T',
-119880: u'U',
-119881: u'V',
-119882: u'W',
-119883: u'X',
-119884: u'Y',
-119885: u'Z',
-119886: u'a',
-119887: u'b',
-119888: u'c',
-119889: u'd',
-119890: u'e',
-119891: u'f',
-119892: u'g',
-119894: u'i',
-119895: u'j',
-119896: u'k',
-119897: u'l',
-119898: u'm',
-119899: u'n',
-119900: u'o',
-119901: u'p',
-119902: u'q',
-119903: u'r',
-119904: u's',
-119905: u't',
-119906: u'u',
-119907: u'v',
-119908: u'w',
-119909: u'x',
-119910: u'y',
-119911: u'z',
-119964: u'\\mathcal{A}',
-119966: u'\\mathcal{C}',
-119967: u'\\mathcal{D}',
-119970: u'\\mathcal{G}',
-119973: u'\\mathcal{J}',
-119974: u'\\mathcal{K}',
-119977: u'\\mathcal{N}',
-119978: u'\\mathcal{O}',
-119979: u'\\mathcal{P}',
-119980: u'\\mathcal{Q}',
-119982: u'\\mathcal{S}',
-119983: u'\\mathcal{T}',
-119984: u'\\mathcal{U}',
-119985: u'\\mathcal{V}',
-119986: u'\\mathcal{W}',
-119987: u'\\mathcal{X}',
-119988: u'\\mathcal{Y}',
-119989: u'\\mathcal{Z}',
-120068: u'\\mathfrak{A}',
-120069: u'\\mathfrak{B}',
-120071: u'\\mathfrak{D}',
-120072: u'\\mathfrak{E}',
-120073: u'\\mathfrak{F}',
-120074: u'\\mathfrak{G}',
-120077: u'\\mathfrak{J}',
-120078: u'\\mathfrak{K}',
-120079: u'\\mathfrak{L}',
-120080: u'\\mathfrak{M}',
-120081: u'\\mathfrak{N}',
-120082: u'\\mathfrak{O}',
-120083: u'\\mathfrak{P}',
-120084: u'\\mathfrak{Q}',
-120086: u'\\mathfrak{S}',
-120087: u'\\mathfrak{T}',
-120088: u'\\mathfrak{U}',
-120089: u'\\mathfrak{V}',
-120090: u'\\mathfrak{W}',
-120091: u'\\mathfrak{X}',
-120092: u'\\mathfrak{Y}',
-120094: u'\\mathfrak{a}',
-120095: u'\\mathfrak{b}',
-120096: u'\\mathfrak{c}',
-120097: u'\\mathfrak{d}',
-120098: u'\\mathfrak{e}',
-120099: u'\\mathfrak{f}',
-120100: u'\\mathfrak{g}',
-120101: u'\\mathfrak{h}',
-120102: u'\\mathfrak{i}',
-120103: u'\\mathfrak{j}',
-120104: u'\\mathfrak{k}',
-120105: u'\\mathfrak{l}',
-120106: u'\\mathfrak{m}',
-120107: u'\\mathfrak{n}',
-120108: u'\\mathfrak{o}',
-120109: u'\\mathfrak{p}',
-120110: u'\\mathfrak{q}',
-120111: u'\\mathfrak{r}',
-120112: u'\\mathfrak{s}',
-120113: u'\\mathfrak{t}',
-120114: u'\\mathfrak{u}',
-120115: u'\\mathfrak{v}',
-120116: u'\\mathfrak{w}',
-120117: u'\\mathfrak{x}',
-120118: u'\\mathfrak{y}',
-120119: u'\\mathfrak{z}',
-120120: u'\\mathbb{A}',
-120121: u'\\mathbb{B}',
-120123: u'\\mathbb{D}',
-120124: u'\\mathbb{E}',
-120125: u'\\mathbb{F}',
-120126: u'\\mathbb{G}',
-120128: u'\\mathbb{I}',
-120129: u'\\mathbb{J}',
-120130: u'\\mathbb{K}',
-120131: u'\\mathbb{L}',
-120132: u'\\mathbb{M}',
-120134: u'\\mathbb{O}',
-120138: u'\\mathbb{S}',
-120139: u'\\mathbb{T}',
-120140: u'\\mathbb{U}',
-120141: u'\\mathbb{V}',
-120142: u'\\mathbb{W}',
-120143: u'\\mathbb{X}',
-120144: u'\\mathbb{Y}',
-120156: u'\\Bbbk ',
-120224: u'\\mathsf{A}',
-120225: u'\\mathsf{B}',
-120226: u'\\mathsf{C}',
-120227: u'\\mathsf{D}',
-120228: u'\\mathsf{E}',
-120229: u'\\mathsf{F}',
-120230: u'\\mathsf{G}',
-120231: u'\\mathsf{H}',
-120232: u'\\mathsf{I}',
-120233: u'\\mathsf{J}',
-120234: u'\\mathsf{K}',
-120235: u'\\mathsf{L}',
-120236: u'\\mathsf{M}',
-120237: u'\\mathsf{N}',
-120238: u'\\mathsf{O}',
-120239: u'\\mathsf{P}',
-120240: u'\\mathsf{Q}',
-120241: u'\\mathsf{R}',
-120242: u'\\mathsf{S}',
-120243: u'\\mathsf{T}',
-120244: u'\\mathsf{U}',
-120245: u'\\mathsf{V}',
-120246: u'\\mathsf{W}',
-120247: u'\\mathsf{X}',
-120248: u'\\mathsf{Y}',
-120249: u'\\mathsf{Z}',
-120250: u'\\mathsf{a}',
-120251: u'\\mathsf{b}',
-120252: u'\\mathsf{c}',
-120253: u'\\mathsf{d}',
-120254: u'\\mathsf{e}',
-120255: u'\\mathsf{f}',
-120256: u'\\mathsf{g}',
-120257: u'\\mathsf{h}',
-120258: u'\\mathsf{i}',
-120259: u'\\mathsf{j}',
-120260: u'\\mathsf{k}',
-120261: u'\\mathsf{l}',
-120262: u'\\mathsf{m}',
-120263: u'\\mathsf{n}',
-120264: u'\\mathsf{o}',
-120265: u'\\mathsf{p}',
-120266: u'\\mathsf{q}',
-120267: u'\\mathsf{r}',
-120268: u'\\mathsf{s}',
-120269: u'\\mathsf{t}',
-120270: u'\\mathsf{u}',
-120271: u'\\mathsf{v}',
-120272: u'\\mathsf{w}',
-120273: u'\\mathsf{x}',
-120274: u'\\mathsf{y}',
-120275: u'\\mathsf{z}',
-120432: u'\\mathtt{A}',
-120433: u'\\mathtt{B}',
-120434: u'\\mathtt{C}',
-120435: u'\\mathtt{D}',
-120436: u'\\mathtt{E}',
-120437: u'\\mathtt{F}',
-120438: u'\\mathtt{G}',
-120439: u'\\mathtt{H}',
-120440: u'\\mathtt{I}',
-120441: u'\\mathtt{J}',
-120442: u'\\mathtt{K}',
-120443: u'\\mathtt{L}',
-120444: u'\\mathtt{M}',
-120445: u'\\mathtt{N}',
-120446: u'\\mathtt{O}',
-120447: u'\\mathtt{P}',
-120448: u'\\mathtt{Q}',
-120449: u'\\mathtt{R}',
-120450: u'\\mathtt{S}',
-120451: u'\\mathtt{T}',
-120452: u'\\mathtt{U}',
-120453: u'\\mathtt{V}',
-120454: u'\\mathtt{W}',
-120455: u'\\mathtt{X}',
-120456: u'\\mathtt{Y}',
-120457: u'\\mathtt{Z}',
-120458: u'\\mathtt{a}',
-120459: u'\\mathtt{b}',
-120460: u'\\mathtt{c}',
-120461: u'\\mathtt{d}',
-120462: u'\\mathtt{e}',
-120463: u'\\mathtt{f}',
-120464: u'\\mathtt{g}',
-120465: u'\\mathtt{h}',
-120466: u'\\mathtt{i}',
-120467: u'\\mathtt{j}',
-120468: u'\\mathtt{k}',
-120469: u'\\mathtt{l}',
-120470: u'\\mathtt{m}',
-120471: u'\\mathtt{n}',
-120472: u'\\mathtt{o}',
-120473: u'\\mathtt{p}',
-120474: u'\\mathtt{q}',
-120475: u'\\mathtt{r}',
-120476: u'\\mathtt{s}',
-120477: u'\\mathtt{t}',
-120478: u'\\mathtt{u}',
-120479: u'\\mathtt{v}',
-120480: u'\\mathtt{w}',
-120481: u'\\mathtt{x}',
-120482: u'\\mathtt{y}',
-120483: u'\\mathtt{z}',
-120484: u'\\imath ',
-120485: u'\\jmath ',
-120490: u'\\mathbf{\\Gamma}',
-120491: u'\\mathbf{\\Delta}',
-120495: u'\\mathbf{\\Theta}',
-120498: u'\\mathbf{\\Lambda}',
-120501: u'\\mathbf{\\Xi}',
-120503: u'\\mathbf{\\Pi}',
-120506: u'\\mathbf{\\Sigma}',
-120508: u'\\mathbf{\\Upsilon}',
-120509: u'\\mathbf{\\Phi}',
-120511: u'\\mathbf{\\Psi}',
-120512: u'\\mathbf{\\Omega}',
-120548: u'\\mathit{\\Gamma}',
-120549: u'\\mathit{\\Delta}',
-120553: u'\\mathit{\\Theta}',
-120556: u'\\mathit{\\Lambda}',
-120559: u'\\mathit{\\Xi}',
-120561: u'\\mathit{\\Pi}',
-120564: u'\\mathit{\\Sigma}',
-120566: u'\\mathit{\\Upsilon}',
-120567: u'\\mathit{\\Phi}',
-120569: u'\\mathit{\\Psi}',
-120570: u'\\mathit{\\Omega}',
-120572: u'\\alpha ',
-120573: u'\\beta ',
-120574: u'\\gamma ',
-120575: u'\\delta ',
-120576: u'\\varepsilon ',
-120577: u'\\zeta ',
-120578: u'\\eta ',
-120579: u'\\theta ',
-120580: u'\\iota ',
-120581: u'\\kappa ',
-120582: u'\\lambda ',
-120583: u'\\mu ',
-120584: u'\\nu ',
-120585: u'\\xi ',
-120587: u'\\pi ',
-120588: u'\\rho ',
-120589: u'\\varsigma ',
-120590: u'\\sigma ',
-120591: u'\\tau ',
-120592: u'\\upsilon ',
-120593: u'\\varphi ',
-120594: u'\\chi ',
-120595: u'\\psi ',
-120596: u'\\omega ',
-120597: u'\\partial ',
-120598: u'\\epsilon ',
-120599: u'\\vartheta ',
-120600: u'\\varkappa ',
-120601: u'\\phi ',
-120602: u'\\varrho ',
-120603: u'\\varpi ',
-120782: u'\\mathbf{0}',
-120783: u'\\mathbf{1}',
-120784: u'\\mathbf{2}',
-120785: u'\\mathbf{3}',
-120786: u'\\mathbf{4}',
-120787: u'\\mathbf{5}',
-120788: u'\\mathbf{6}',
-120789: u'\\mathbf{7}',
-120790: u'\\mathbf{8}',
-120791: u'\\mathbf{9}',
-120802: u'\\mathsf{0}',
-120803: u'\\mathsf{1}',
-120804: u'\\mathsf{2}',
-120805: u'\\mathsf{3}',
-120806: u'\\mathsf{4}',
-120807: u'\\mathsf{5}',
-120808: u'\\mathsf{6}',
-120809: u'\\mathsf{7}',
-120810: u'\\mathsf{8}',
-120811: u'\\mathsf{9}',
-120822: u'\\mathtt{0}',
-120823: u'\\mathtt{1}',
-120824: u'\\mathtt{2}',
-120825: u'\\mathtt{3}',
-120826: u'\\mathtt{4}',
-120827: u'\\mathtt{5}',
-120828: u'\\mathtt{6}',
-120829: u'\\mathtt{7}',
-120830: u'\\mathtt{8}',
-120831: u'\\mathtt{9}',
+0xa0: '~',
+0xa3: '\\pounds ',
+0xa5: '\\yen ',
+0xa7: '\\S ',
+0xac: '\\neg ',
+0xb1: '\\pm ',
+0xb6: '\\P ',
+0xd7: '\\times ',
+0xf0: '\\eth ',
+0xf7: '\\div ',
+0x131: '\\imath ',
+0x237: '\\jmath ',
+0x393: '\\Gamma ',
+0x394: '\\Delta ',
+0x398: '\\Theta ',
+0x39b: '\\Lambda ',
+0x39e: '\\Xi ',
+0x3a0: '\\Pi ',
+0x3a3: '\\Sigma ',
+0x3a5: '\\Upsilon ',
+0x3a6: '\\Phi ',
+0x3a8: '\\Psi ',
+0x3a9: '\\Omega ',
+0x3b1: '\\alpha ',
+0x3b2: '\\beta ',
+0x3b3: '\\gamma ',
+0x3b4: '\\delta ',
+0x3b5: '\\varepsilon ',
+0x3b6: '\\zeta ',
+0x3b7: '\\eta ',
+0x3b8: '\\theta ',
+0x3b9: '\\iota ',
+0x3ba: '\\kappa ',
+0x3bb: '\\lambda ',
+0x3bc: '\\mu ',
+0x3bd: '\\nu ',
+0x3be: '\\xi ',
+0x3c0: '\\pi ',
+0x3c1: '\\rho ',
+0x3c2: '\\varsigma ',
+0x3c3: '\\sigma ',
+0x3c4: '\\tau ',
+0x3c5: '\\upsilon ',
+0x3c6: '\\varphi ',
+0x3c7: '\\chi ',
+0x3c8: '\\psi ',
+0x3c9: '\\omega ',
+0x3d1: '\\vartheta ',
+0x3d5: '\\phi ',
+0x3d6: '\\varpi ',
+0x3dd: '\\digamma ',
+0x3f0: '\\varkappa ',
+0x3f1: '\\varrho ',
+0x3f5: '\\epsilon ',
+0x3f6: '\\backepsilon ',
+0x2001: '\\quad ',
+0x2003: '\\quad ',
+0x2006: '\\, ',
+0x2016: '\\| ',
+0x2020: '\\dagger ',
+0x2021: '\\ddagger ',
+0x2022: '\\bullet ',
+0x2026: '\\ldots ',
+0x2032: '\\prime ',
+0x2035: '\\backprime ',
+0x205f: '\\: ',
+0x2102: '\\mathbb{C}',
+0x210b: '\\mathcal{H}',
+0x210c: '\\mathfrak{H}',
+0x210d: '\\mathbb{H}',
+0x210f: '\\hslash ',
+0x2110: '\\mathcal{I}',
+0x2111: '\\Im ',
+0x2112: '\\mathcal{L}',
+0x2113: '\\ell ',
+0x2115: '\\mathbb{N}',
+0x2118: '\\wp ',
+0x2119: '\\mathbb{P}',
+0x211a: '\\mathbb{Q}',
+0x211b: '\\mathcal{R}',
+0x211c: '\\Re ',
+0x211d: '\\mathbb{R}',
+0x2124: '\\mathbb{Z}',
+0x2127: '\\mho ',
+0x2128: '\\mathfrak{Z}',
+0x212c: '\\mathcal{B}',
+0x212d: '\\mathfrak{C}',
+0x2130: '\\mathcal{E}',
+0x2131: '\\mathcal{F}',
+0x2132: '\\Finv ',
+0x2133: '\\mathcal{M}',
+0x2135: '\\aleph ',
+0x2136: '\\beth ',
+0x2137: '\\gimel ',
+0x2138: '\\daleth ',
+0x2190: '\\leftarrow ',
+0x2191: '\\uparrow ',
+0x2192: '\\rightarrow ',
+0x2193: '\\downarrow ',
+0x2194: '\\leftrightarrow ',
+0x2195: '\\updownarrow ',
+0x2196: '\\nwarrow ',
+0x2197: '\\nearrow ',
+0x2198: '\\searrow ',
+0x2199: '\\swarrow ',
+0x219a: '\\nleftarrow ',
+0x219b: '\\nrightarrow ',
+0x219e: '\\twoheadleftarrow ',
+0x21a0: '\\twoheadrightarrow ',
+0x21a2: '\\leftarrowtail ',
+0x21a3: '\\rightarrowtail ',
+0x21a6: '\\mapsto ',
+0x21a9: '\\hookleftarrow ',
+0x21aa: '\\hookrightarrow ',
+0x21ab: '\\looparrowleft ',
+0x21ac: '\\looparrowright ',
+0x21ad: '\\leftrightsquigarrow ',
+0x21ae: '\\nleftrightarrow ',
+0x21b0: '\\Lsh ',
+0x21b1: '\\Rsh ',
+0x21b6: '\\curvearrowleft ',
+0x21b7: '\\curvearrowright ',
+0x21ba: '\\circlearrowleft ',
+0x21bb: '\\circlearrowright ',
+0x21bc: '\\leftharpoonup ',
+0x21bd: '\\leftharpoondown ',
+0x21be: '\\upharpoonright ',
+0x21bf: '\\upharpoonleft ',
+0x21c0: '\\rightharpoonup ',
+0x21c1: '\\rightharpoondown ',
+0x21c2: '\\downharpoonright ',
+0x21c3: '\\downharpoonleft ',
+0x21c4: '\\rightleftarrows ',
+0x21c6: '\\leftrightarrows ',
+0x21c7: '\\leftleftarrows ',
+0x21c8: '\\upuparrows ',
+0x21c9: '\\rightrightarrows ',
+0x21ca: '\\downdownarrows ',
+0x21cb: '\\leftrightharpoons ',
+0x21cc: '\\rightleftharpoons ',
+0x21cd: '\\nLeftarrow ',
+0x21ce: '\\nLeftrightarrow ',
+0x21cf: '\\nRightarrow ',
+0x21d0: '\\Leftarrow ',
+0x21d1: '\\Uparrow ',
+0x21d2: '\\Rightarrow ',
+0x21d3: '\\Downarrow ',
+0x21d4: '\\Leftrightarrow ',
+0x21d5: '\\Updownarrow ',
+0x21da: '\\Lleftarrow ',
+0x21db: '\\Rrightarrow ',
+0x21dd: '\\rightsquigarrow ',
+0x21e0: '\\dashleftarrow ',
+0x21e2: '\\dashrightarrow ',
+0x2200: '\\forall ',
+0x2201: '\\complement ',
+0x2202: '\\partial ',
+0x2203: '\\exists ',
+0x2204: '\\nexists ',
+0x2205: '\\emptyset ',
+0x2207: '\\nabla ',
+0x2208: '\\in ',
+0x2209: '\\notin ',
+0x220b: '\\ni ',
+0x220f: '\\prod ',
+0x2210: '\\coprod ',
+0x2211: '\\sum ',
+0x2212: '-',
+0x2213: '\\mp ',
+0x2214: '\\dotplus ',
+0x2215: '\\slash ',
+0x2216: '\\smallsetminus ',
+0x2217: '\\ast ',
+0x2218: '\\circ ',
+0x2219: '\\bullet ',
+0x221a: '\\surd ',
+0x221b: '\\sqrt3 ',
+0x221c: '\\sqrt4 ',
+0x221d: '\\propto ',
+0x221e: '\\infty ',
+0x2220: '\\angle ',
+0x2221: '\\measuredangle ',
+0x2222: '\\sphericalangle ',
+0x2223: '\\mid ',
+0x2224: '\\nmid ',
+0x2225: '\\parallel ',
+0x2226: '\\nparallel ',
+0x2227: '\\wedge ',
+0x2228: '\\vee ',
+0x2229: '\\cap ',
+0x222a: '\\cup ',
+0x222b: '\\int ',
+0x222c: '\\iint ',
+0x222d: '\\iiint ',
+0x222e: '\\oint ',
+0x2234: '\\therefore ',
+0x2235: '\\because ',
+0x2236: ':',
+0x223c: '\\sim ',
+0x223d: '\\backsim ',
+0x2240: '\\wr ',
+0x2241: '\\nsim ',
+0x2242: '\\eqsim ',
+0x2243: '\\simeq ',
+0x2245: '\\cong ',
+0x2247: '\\ncong ',
+0x2248: '\\approx ',
+0x224a: '\\approxeq ',
+0x224d: '\\asymp ',
+0x224e: '\\Bumpeq ',
+0x224f: '\\bumpeq ',
+0x2250: '\\doteq ',
+0x2251: '\\Doteq ',
+0x2252: '\\fallingdotseq ',
+0x2253: '\\risingdotseq ',
+0x2256: '\\eqcirc ',
+0x2257: '\\circeq ',
+0x225c: '\\triangleq ',
+0x2260: '\\neq ',
+0x2261: '\\equiv ',
+0x2264: '\\leq ',
+0x2265: '\\geq ',
+0x2266: '\\leqq ',
+0x2267: '\\geqq ',
+0x2268: '\\lneqq ',
+0x2269: '\\gneqq ',
+0x226a: '\\ll ',
+0x226b: '\\gg ',
+0x226c: '\\between ',
+0x226e: '\\nless ',
+0x226f: '\\ngtr ',
+0x2270: '\\nleq ',
+0x2271: '\\ngeq ',
+0x2272: '\\lesssim ',
+0x2273: '\\gtrsim ',
+0x2276: '\\lessgtr ',
+0x2277: '\\gtrless ',
+0x227a: '\\prec ',
+0x227b: '\\succ ',
+0x227c: '\\preccurlyeq ',
+0x227d: '\\succcurlyeq ',
+0x227e: '\\precsim ',
+0x227f: '\\succsim ',
+0x2280: '\\nprec ',
+0x2281: '\\nsucc ',
+0x2282: '\\subset ',
+0x2283: '\\supset ',
+0x2286: '\\subseteq ',
+0x2287: '\\supseteq ',
+0x2288: '\\nsubseteq ',
+0x2289: '\\nsupseteq ',
+0x228a: '\\subsetneq ',
+0x228b: '\\supsetneq ',
+0x228e: '\\uplus ',
+0x228f: '\\sqsubset ',
+0x2290: '\\sqsupset ',
+0x2291: '\\sqsubseteq ',
+0x2292: '\\sqsupseteq ',
+0x2293: '\\sqcap ',
+0x2294: '\\sqcup ',
+0x2295: '\\oplus ',
+0x2296: '\\ominus ',
+0x2297: '\\otimes ',
+0x2298: '\\oslash ',
+0x2299: '\\odot ',
+0x229a: '\\circledcirc ',
+0x229b: '\\circledast ',
+0x229d: '\\circleddash ',
+0x229e: '\\boxplus ',
+0x229f: '\\boxminus ',
+0x22a0: '\\boxtimes ',
+0x22a1: '\\boxdot ',
+0x22a2: '\\vdash ',
+0x22a3: '\\dashv ',
+0x22a4: '\\top ',
+0x22a5: '\\bot ',
+0x22a7: '\\models ',
+0x22a8: '\\vDash ',
+0x22a9: '\\Vdash ',
+0x22aa: '\\Vvdash ',
+0x22ac: '\\nvdash ',
+0x22ad: '\\nvDash ',
+0x22ae: '\\nVdash ',
+0x22af: '\\nVDash ',
+0x22b2: '\\vartriangleleft ',
+0x22b3: '\\vartriangleright ',
+0x22b4: '\\trianglelefteq ',
+0x22b5: '\\trianglerighteq ',
+0x22b8: '\\multimap ',
+0x22ba: '\\intercal ',
+0x22bb: '\\veebar ',
+0x22bc: '\\barwedge ',
+0x22c0: '\\bigwedge ',
+0x22c1: '\\bigvee ',
+0x22c2: '\\bigcap ',
+0x22c3: '\\bigcup ',
+0x22c4: '\\diamond ',
+0x22c5: '\\cdot ',
+0x22c6: '\\star ',
+0x22c7: '\\divideontimes ',
+0x22c8: '\\bowtie ',
+0x22c9: '\\ltimes ',
+0x22ca: '\\rtimes ',
+0x22cb: '\\leftthreetimes ',
+0x22cc: '\\rightthreetimes ',
+0x22cd: '\\backsimeq ',
+0x22ce: '\\curlyvee ',
+0x22cf: '\\curlywedge ',
+0x22d0: '\\Subset ',
+0x22d1: '\\Supset ',
+0x22d2: '\\Cap ',
+0x22d3: '\\Cup ',
+0x22d4: '\\pitchfork ',
+0x22d6: '\\lessdot ',
+0x22d7: '\\gtrdot ',
+0x22d8: '\\lll ',
+0x22d9: '\\ggg ',
+0x22da: '\\lesseqgtr ',
+0x22db: '\\gtreqless ',
+0x22de: '\\curlyeqprec ',
+0x22df: '\\curlyeqsucc ',
+0x22e0: '\\npreceq ',
+0x22e1: '\\nsucceq ',
+0x22e6: '\\lnsim ',
+0x22e7: '\\gnsim ',
+0x22e8: '\\precnsim ',
+0x22e9: '\\succnsim ',
+0x22ea: '\\ntriangleleft ',
+0x22eb: '\\ntriangleright ',
+0x22ec: '\\ntrianglelefteq ',
+0x22ed: '\\ntrianglerighteq ',
+0x22ee: '\\vdots ',
+0x22ef: '\\cdots ',
+0x22f1: '\\ddots ',
+0x2308: '\\lceil ',
+0x2309: '\\rceil ',
+0x230a: '\\lfloor ',
+0x230b: '\\rfloor ',
+0x231c: '\\ulcorner ',
+0x231d: '\\urcorner ',
+0x231e: '\\llcorner ',
+0x231f: '\\lrcorner ',
+0x2322: '\\frown ',
+0x2323: '\\smile ',
+0x23aa: '\\bracevert ',
+0x23b0: '\\lmoustache ',
+0x23b1: '\\rmoustache ',
+0x23d0: '\\arrowvert ',
+0x23de: '\\overbrace ',
+0x23df: '\\underbrace ',
+0x24c7: '\\circledR ',
+0x24c8: '\\circledS ',
+0x25b2: '\\blacktriangle ',
+0x25b3: '\\bigtriangleup ',
+0x25b7: '\\triangleright ',
+0x25bc: '\\blacktriangledown ',
+0x25bd: '\\bigtriangledown ',
+0x25c1: '\\triangleleft ',
+0x25c7: '\\Diamond ',
+0x25ca: '\\lozenge ',
+0x25ef: '\\bigcirc ',
+0x25fb: '\\square ',
+0x25fc: '\\blacksquare ',
+0x2605: '\\bigstar ',
+0x2660: '\\spadesuit ',
+0x2661: '\\heartsuit ',
+0x2662: '\\diamondsuit ',
+0x2663: '\\clubsuit ',
+0x266d: '\\flat ',
+0x266e: '\\natural ',
+0x266f: '\\sharp ',
+0x2713: '\\checkmark ',
+0x2720: '\\maltese ',
+0x27c2: '\\perp ',
+0x27cb: '\\diagup ',
+0x27cd: '\\diagdown ',
+0x27e8: '\\langle ',
+0x27e9: '\\rangle ',
+0x27ee: '\\lgroup ',
+0x27ef: '\\rgroup ',
+0x27f5: '\\longleftarrow ',
+0x27f6: '\\longrightarrow ',
+0x27f7: '\\longleftrightarrow ',
+0x27f8: '\\Longleftarrow ',
+0x27f9: '\\Longrightarrow ',
+0x27fa: '\\Longleftrightarrow ',
+0x27fc: '\\longmapsto ',
+0x29eb: '\\blacklozenge ',
+0x29f5: '\\setminus ',
+0x2a00: '\\bigodot ',
+0x2a01: '\\bigoplus ',
+0x2a02: '\\bigotimes ',
+0x2a04: '\\biguplus ',
+0x2a06: '\\bigsqcup ',
+0x2a0c: '\\iiiint ',
+0x2a3f: '\\amalg ',
+0x2a5e: '\\doublebarwedge ',
+0x2a7d: '\\leqslant ',
+0x2a7e: '\\geqslant ',
+0x2a85: '\\lessapprox ',
+0x2a86: '\\gtrapprox ',
+0x2a87: '\\lneq ',
+0x2a88: '\\gneq ',
+0x2a89: '\\lnapprox ',
+0x2a8a: '\\gnapprox ',
+0x2a8b: '\\lesseqqgtr ',
+0x2a8c: '\\gtreqqless ',
+0x2a95: '\\eqslantless ',
+0x2a96: '\\eqslantgtr ',
+0x2aaf: '\\preceq ',
+0x2ab0: '\\succeq ',
+0x2ab5: '\\precneqq ',
+0x2ab6: '\\succneqq ',
+0x2ab7: '\\precapprox ',
+0x2ab8: '\\succapprox ',
+0x2ab9: '\\precnapprox ',
+0x2aba: '\\succnapprox ',
+0x2ac5: '\\subseteqq ',
+0x2ac6: '\\supseteqq ',
+0x2acb: '\\subsetneqq ',
+0x2acc: '\\supsetneqq ',
+0x2b1c: '\\Box ',
+0x1d400: '\\mathbf{A}',
+0x1d401: '\\mathbf{B}',
+0x1d402: '\\mathbf{C}',
+0x1d403: '\\mathbf{D}',
+0x1d404: '\\mathbf{E}',
+0x1d405: '\\mathbf{F}',
+0x1d406: '\\mathbf{G}',
+0x1d407: '\\mathbf{H}',
+0x1d408: '\\mathbf{I}',
+0x1d409: '\\mathbf{J}',
+0x1d40a: '\\mathbf{K}',
+0x1d40b: '\\mathbf{L}',
+0x1d40c: '\\mathbf{M}',
+0x1d40d: '\\mathbf{N}',
+0x1d40e: '\\mathbf{O}',
+0x1d40f: '\\mathbf{P}',
+0x1d410: '\\mathbf{Q}',
+0x1d411: '\\mathbf{R}',
+0x1d412: '\\mathbf{S}',
+0x1d413: '\\mathbf{T}',
+0x1d414: '\\mathbf{U}',
+0x1d415: '\\mathbf{V}',
+0x1d416: '\\mathbf{W}',
+0x1d417: '\\mathbf{X}',
+0x1d418: '\\mathbf{Y}',
+0x1d419: '\\mathbf{Z}',
+0x1d41a: '\\mathbf{a}',
+0x1d41b: '\\mathbf{b}',
+0x1d41c: '\\mathbf{c}',
+0x1d41d: '\\mathbf{d}',
+0x1d41e: '\\mathbf{e}',
+0x1d41f: '\\mathbf{f}',
+0x1d420: '\\mathbf{g}',
+0x1d421: '\\mathbf{h}',
+0x1d422: '\\mathbf{i}',
+0x1d423: '\\mathbf{j}',
+0x1d424: '\\mathbf{k}',
+0x1d425: '\\mathbf{l}',
+0x1d426: '\\mathbf{m}',
+0x1d427: '\\mathbf{n}',
+0x1d428: '\\mathbf{o}',
+0x1d429: '\\mathbf{p}',
+0x1d42a: '\\mathbf{q}',
+0x1d42b: '\\mathbf{r}',
+0x1d42c: '\\mathbf{s}',
+0x1d42d: '\\mathbf{t}',
+0x1d42e: '\\mathbf{u}',
+0x1d42f: '\\mathbf{v}',
+0x1d430: '\\mathbf{w}',
+0x1d431: '\\mathbf{x}',
+0x1d432: '\\mathbf{y}',
+0x1d433: '\\mathbf{z}',
+0x1d434: 'A',
+0x1d435: 'B',
+0x1d436: 'C',
+0x1d437: 'D',
+0x1d438: 'E',
+0x1d439: 'F',
+0x1d43a: 'G',
+0x1d43b: 'H',
+0x1d43c: 'I',
+0x1d43d: 'J',
+0x1d43e: 'K',
+0x1d43f: 'L',
+0x1d440: 'M',
+0x1d441: 'N',
+0x1d442: 'O',
+0x1d443: 'P',
+0x1d444: 'Q',
+0x1d445: 'R',
+0x1d446: 'S',
+0x1d447: 'T',
+0x1d448: 'U',
+0x1d449: 'V',
+0x1d44a: 'W',
+0x1d44b: 'X',
+0x1d44c: 'Y',
+0x1d44d: 'Z',
+0x1d44e: 'a',
+0x1d44f: 'b',
+0x1d450: 'c',
+0x1d451: 'd',
+0x1d452: 'e',
+0x1d453: 'f',
+0x1d454: 'g',
+0x1d456: 'i',
+0x1d457: 'j',
+0x1d458: 'k',
+0x1d459: 'l',
+0x1d45a: 'm',
+0x1d45b: 'n',
+0x1d45c: 'o',
+0x1d45d: 'p',
+0x1d45e: 'q',
+0x1d45f: 'r',
+0x1d460: 's',
+0x1d461: 't',
+0x1d462: 'u',
+0x1d463: 'v',
+0x1d464: 'w',
+0x1d465: 'x',
+0x1d466: 'y',
+0x1d467: 'z',
+0x1d49c: '\\mathcal{A}',
+0x1d49e: '\\mathcal{C}',
+0x1d49f: '\\mathcal{D}',
+0x1d4a2: '\\mathcal{G}',
+0x1d4a5: '\\mathcal{J}',
+0x1d4a6: '\\mathcal{K}',
+0x1d4a9: '\\mathcal{N}',
+0x1d4aa: '\\mathcal{O}',
+0x1d4ab: '\\mathcal{P}',
+0x1d4ac: '\\mathcal{Q}',
+0x1d4ae: '\\mathcal{S}',
+0x1d4af: '\\mathcal{T}',
+0x1d4b0: '\\mathcal{U}',
+0x1d4b1: '\\mathcal{V}',
+0x1d4b2: '\\mathcal{W}',
+0x1d4b3: '\\mathcal{X}',
+0x1d4b4: '\\mathcal{Y}',
+0x1d4b5: '\\mathcal{Z}',
+0x1d504: '\\mathfrak{A}',
+0x1d505: '\\mathfrak{B}',
+0x1d507: '\\mathfrak{D}',
+0x1d508: '\\mathfrak{E}',
+0x1d509: '\\mathfrak{F}',
+0x1d50a: '\\mathfrak{G}',
+0x1d50d: '\\mathfrak{J}',
+0x1d50e: '\\mathfrak{K}',
+0x1d50f: '\\mathfrak{L}',
+0x1d510: '\\mathfrak{M}',
+0x1d511: '\\mathfrak{N}',
+0x1d512: '\\mathfrak{O}',
+0x1d513: '\\mathfrak{P}',
+0x1d514: '\\mathfrak{Q}',
+0x1d516: '\\mathfrak{S}',
+0x1d517: '\\mathfrak{T}',
+0x1d518: '\\mathfrak{U}',
+0x1d519: '\\mathfrak{V}',
+0x1d51a: '\\mathfrak{W}',
+0x1d51b: '\\mathfrak{X}',
+0x1d51c: '\\mathfrak{Y}',
+0x1d51e: '\\mathfrak{a}',
+0x1d51f: '\\mathfrak{b}',
+0x1d520: '\\mathfrak{c}',
+0x1d521: '\\mathfrak{d}',
+0x1d522: '\\mathfrak{e}',
+0x1d523: '\\mathfrak{f}',
+0x1d524: '\\mathfrak{g}',
+0x1d525: '\\mathfrak{h}',
+0x1d526: '\\mathfrak{i}',
+0x1d527: '\\mathfrak{j}',
+0x1d528: '\\mathfrak{k}',
+0x1d529: '\\mathfrak{l}',
+0x1d52a: '\\mathfrak{m}',
+0x1d52b: '\\mathfrak{n}',
+0x1d52c: '\\mathfrak{o}',
+0x1d52d: '\\mathfrak{p}',
+0x1d52e: '\\mathfrak{q}',
+0x1d52f: '\\mathfrak{r}',
+0x1d530: '\\mathfrak{s}',
+0x1d531: '\\mathfrak{t}',
+0x1d532: '\\mathfrak{u}',
+0x1d533: '\\mathfrak{v}',
+0x1d534: '\\mathfrak{w}',
+0x1d535: '\\mathfrak{x}',
+0x1d536: '\\mathfrak{y}',
+0x1d537: '\\mathfrak{z}',
+0x1d538: '\\mathbb{A}',
+0x1d539: '\\mathbb{B}',
+0x1d53b: '\\mathbb{D}',
+0x1d53c: '\\mathbb{E}',
+0x1d53d: '\\mathbb{F}',
+0x1d53e: '\\mathbb{G}',
+0x1d540: '\\mathbb{I}',
+0x1d541: '\\mathbb{J}',
+0x1d542: '\\mathbb{K}',
+0x1d543: '\\mathbb{L}',
+0x1d544: '\\mathbb{M}',
+0x1d546: '\\mathbb{O}',
+0x1d54a: '\\mathbb{S}',
+0x1d54b: '\\mathbb{T}',
+0x1d54c: '\\mathbb{U}',
+0x1d54d: '\\mathbb{V}',
+0x1d54e: '\\mathbb{W}',
+0x1d54f: '\\mathbb{X}',
+0x1d550: '\\mathbb{Y}',
+0x1d55c: '\\Bbbk ',
+0x1d5a0: '\\mathsf{A}',
+0x1d5a1: '\\mathsf{B}',
+0x1d5a2: '\\mathsf{C}',
+0x1d5a3: '\\mathsf{D}',
+0x1d5a4: '\\mathsf{E}',
+0x1d5a5: '\\mathsf{F}',
+0x1d5a6: '\\mathsf{G}',
+0x1d5a7: '\\mathsf{H}',
+0x1d5a8: '\\mathsf{I}',
+0x1d5a9: '\\mathsf{J}',
+0x1d5aa: '\\mathsf{K}',
+0x1d5ab: '\\mathsf{L}',
+0x1d5ac: '\\mathsf{M}',
+0x1d5ad: '\\mathsf{N}',
+0x1d5ae: '\\mathsf{O}',
+0x1d5af: '\\mathsf{P}',
+0x1d5b0: '\\mathsf{Q}',
+0x1d5b1: '\\mathsf{R}',
+0x1d5b2: '\\mathsf{S}',
+0x1d5b3: '\\mathsf{T}',
+0x1d5b4: '\\mathsf{U}',
+0x1d5b5: '\\mathsf{V}',
+0x1d5b6: '\\mathsf{W}',
+0x1d5b7: '\\mathsf{X}',
+0x1d5b8: '\\mathsf{Y}',
+0x1d5b9: '\\mathsf{Z}',
+0x1d5ba: '\\mathsf{a}',
+0x1d5bb: '\\mathsf{b}',
+0x1d5bc: '\\mathsf{c}',
+0x1d5bd: '\\mathsf{d}',
+0x1d5be: '\\mathsf{e}',
+0x1d5bf: '\\mathsf{f}',
+0x1d5c0: '\\mathsf{g}',
+0x1d5c1: '\\mathsf{h}',
+0x1d5c2: '\\mathsf{i}',
+0x1d5c3: '\\mathsf{j}',
+0x1d5c4: '\\mathsf{k}',
+0x1d5c5: '\\mathsf{l}',
+0x1d5c6: '\\mathsf{m}',
+0x1d5c7: '\\mathsf{n}',
+0x1d5c8: '\\mathsf{o}',
+0x1d5c9: '\\mathsf{p}',
+0x1d5ca: '\\mathsf{q}',
+0x1d5cb: '\\mathsf{r}',
+0x1d5cc: '\\mathsf{s}',
+0x1d5cd: '\\mathsf{t}',
+0x1d5ce: '\\mathsf{u}',
+0x1d5cf: '\\mathsf{v}',
+0x1d5d0: '\\mathsf{w}',
+0x1d5d1: '\\mathsf{x}',
+0x1d5d2: '\\mathsf{y}',
+0x1d5d3: '\\mathsf{z}',
+0x1d670: '\\mathtt{A}',
+0x1d671: '\\mathtt{B}',
+0x1d672: '\\mathtt{C}',
+0x1d673: '\\mathtt{D}',
+0x1d674: '\\mathtt{E}',
+0x1d675: '\\mathtt{F}',
+0x1d676: '\\mathtt{G}',
+0x1d677: '\\mathtt{H}',
+0x1d678: '\\mathtt{I}',
+0x1d679: '\\mathtt{J}',
+0x1d67a: '\\mathtt{K}',
+0x1d67b: '\\mathtt{L}',
+0x1d67c: '\\mathtt{M}',
+0x1d67d: '\\mathtt{N}',
+0x1d67e: '\\mathtt{O}',
+0x1d67f: '\\mathtt{P}',
+0x1d680: '\\mathtt{Q}',
+0x1d681: '\\mathtt{R}',
+0x1d682: '\\mathtt{S}',
+0x1d683: '\\mathtt{T}',
+0x1d684: '\\mathtt{U}',
+0x1d685: '\\mathtt{V}',
+0x1d686: '\\mathtt{W}',
+0x1d687: '\\mathtt{X}',
+0x1d688: '\\mathtt{Y}',
+0x1d689: '\\mathtt{Z}',
+0x1d68a: '\\mathtt{a}',
+0x1d68b: '\\mathtt{b}',
+0x1d68c: '\\mathtt{c}',
+0x1d68d: '\\mathtt{d}',
+0x1d68e: '\\mathtt{e}',
+0x1d68f: '\\mathtt{f}',
+0x1d690: '\\mathtt{g}',
+0x1d691: '\\mathtt{h}',
+0x1d692: '\\mathtt{i}',
+0x1d693: '\\mathtt{j}',
+0x1d694: '\\mathtt{k}',
+0x1d695: '\\mathtt{l}',
+0x1d696: '\\mathtt{m}',
+0x1d697: '\\mathtt{n}',
+0x1d698: '\\mathtt{o}',
+0x1d699: '\\mathtt{p}',
+0x1d69a: '\\mathtt{q}',
+0x1d69b: '\\mathtt{r}',
+0x1d69c: '\\mathtt{s}',
+0x1d69d: '\\mathtt{t}',
+0x1d69e: '\\mathtt{u}',
+0x1d69f: '\\mathtt{v}',
+0x1d6a0: '\\mathtt{w}',
+0x1d6a1: '\\mathtt{x}',
+0x1d6a2: '\\mathtt{y}',
+0x1d6a3: '\\mathtt{z}',
+0x1d6a4: '\\imath ',
+0x1d6a5: '\\jmath ',
+0x1d6aa: '\\mathbf{\\Gamma}',
+0x1d6ab: '\\mathbf{\\Delta}',
+0x1d6af: '\\mathbf{\\Theta}',
+0x1d6b2: '\\mathbf{\\Lambda}',
+0x1d6b5: '\\mathbf{\\Xi}',
+0x1d6b7: '\\mathbf{\\Pi}',
+0x1d6ba: '\\mathbf{\\Sigma}',
+0x1d6bc: '\\mathbf{\\Upsilon}',
+0x1d6bd: '\\mathbf{\\Phi}',
+0x1d6bf: '\\mathbf{\\Psi}',
+0x1d6c0: '\\mathbf{\\Omega}',
+0x1d6e4: '\\mathit{\\Gamma}',
+0x1d6e5: '\\mathit{\\Delta}',
+0x1d6e9: '\\mathit{\\Theta}',
+0x1d6ec: '\\mathit{\\Lambda}',
+0x1d6ef: '\\mathit{\\Xi}',
+0x1d6f1: '\\mathit{\\Pi}',
+0x1d6f4: '\\mathit{\\Sigma}',
+0x1d6f6: '\\mathit{\\Upsilon}',
+0x1d6f7: '\\mathit{\\Phi}',
+0x1d6f9: '\\mathit{\\Psi}',
+0x1d6fa: '\\mathit{\\Omega}',
+0x1d6fc: '\\alpha ',
+0x1d6fd: '\\beta ',
+0x1d6fe: '\\gamma ',
+0x1d6ff: '\\delta ',
+0x1d700: '\\varepsilon ',
+0x1d701: '\\zeta ',
+0x1d702: '\\eta ',
+0x1d703: '\\theta ',
+0x1d704: '\\iota ',
+0x1d705: '\\kappa ',
+0x1d706: '\\lambda ',
+0x1d707: '\\mu ',
+0x1d708: '\\nu ',
+0x1d709: '\\xi ',
+0x1d70b: '\\pi ',
+0x1d70c: '\\rho ',
+0x1d70d: '\\varsigma ',
+0x1d70e: '\\sigma ',
+0x1d70f: '\\tau ',
+0x1d710: '\\upsilon ',
+0x1d711: '\\varphi ',
+0x1d712: '\\chi ',
+0x1d713: '\\psi ',
+0x1d714: '\\omega ',
+0x1d715: '\\partial ',
+0x1d716: '\\epsilon ',
+0x1d717: '\\vartheta ',
+0x1d718: '\\varkappa ',
+0x1d719: '\\phi ',
+0x1d71a: '\\varrho ',
+0x1d71b: '\\varpi ',
+0x1d7ce: '\\mathbf{0}',
+0x1d7cf: '\\mathbf{1}',
+0x1d7d0: '\\mathbf{2}',
+0x1d7d1: '\\mathbf{3}',
+0x1d7d2: '\\mathbf{4}',
+0x1d7d3: '\\mathbf{5}',
+0x1d7d4: '\\mathbf{6}',
+0x1d7d5: '\\mathbf{7}',
+0x1d7d6: '\\mathbf{8}',
+0x1d7d7: '\\mathbf{9}',
+0x1d7e2: '\\mathsf{0}',
+0x1d7e3: '\\mathsf{1}',
+0x1d7e4: '\\mathsf{2}',
+0x1d7e5: '\\mathsf{3}',
+0x1d7e6: '\\mathsf{4}',
+0x1d7e7: '\\mathsf{5}',
+0x1d7e8: '\\mathsf{6}',
+0x1d7e9: '\\mathsf{7}',
+0x1d7ea: '\\mathsf{8}',
+0x1d7eb: '\\mathsf{9}',
+0x1d7f6: '\\mathtt{0}',
+0x1d7f7: '\\mathtt{1}',
+0x1d7f8: '\\mathtt{2}',
+0x1d7f9: '\\mathtt{3}',
+0x1d7fa: '\\mathtt{4}',
+0x1d7fb: '\\mathtt{5}',
+0x1d7fc: '\\mathtt{6}',
+0x1d7fd: '\\mathtt{7}',
+0x1d7fe: '\\mathtt{8}',
+0x1d7ff: '\\mathtt{9}',
 }

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/punctuation_chars.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/punctuation_chars.py Changed

@@ -1,6 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# :Id: $Id: punctuation_chars.py 8554 2020-09-04 16:52:11Z milde $
+# :Id: $Id: punctuation_chars.py 9270 2022-11-24 20:28:03Z milde $
 # :Copyright: © 2011, 2017 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -15,9 +13,6 @@
 # ``docutils/tools/dev/generate_punctuation_chars.py``.
 # ::
 
-import sys, re
-import unicodedata
-
 """Docutils character category patterns.
 
    Patterns for the implementation of the `inline markup recognition rules`_
@@ -40,83 +35,89 @@
    "unicodedata" module of Python 2.7.13 (based on Unicode version 5.2.0).
 
    .. _inline markup recognition rules:
-      http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules
+      https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
+      #inline-markup-recognition-rules
 """
 
-openers = (u'"\'(<\\{\u0f3a\u0f3c\u169b\u2045\u207d\u208d\u2329\u2768'
-           u'\u276a\u276c\u276e\u2770\u2772\u2774\u27c5\u27e6\u27e8\u27ea'
-           u'\u27ec\u27ee\u2983\u2985\u2987\u2989\u298b\u298d\u298f\u2991'
-           u'\u2993\u2995\u2997\u29d8\u29da\u29fc\u2e22\u2e24\u2e26\u2e28'
-           u'\u3008\u300a\u300c\u300e\u3010\u3014\u3016\u3018\u301a\u301d'
-           u'\u301d\ufd3e\ufe17\ufe35\ufe37\ufe39\ufe3b\ufe3d\ufe3f\ufe41'
-           u'\ufe43\ufe47\ufe59\ufe5b\ufe5d\uff08\uff3b\uff5b\uff5f\uff62'
-           u'\xab\u2018\u201c\u2039\u2e02\u2e04\u2e09\u2e0c\u2e1c\u2e20'
-           u'\u201a\u201e\xbb\u2019\u201d\u203a\u2e03\u2e05\u2e0a\u2e0d'
-           u'\u2e1d\u2e21\u201b\u201f')
-closers = (u'"\')>\\}\u0f3b\u0f3d\u169c\u2046\u207e\u208e\u232a\u2769'
-           u'\u276b\u276d\u276f\u2771\u2773\u2775\u27c6\u27e7\u27e9\u27eb'
-           u'\u27ed\u27ef\u2984\u2986\u2988\u298a\u298c\u298e\u2990\u2992'
-           u'\u2994\u2996\u2998\u29d9\u29db\u29fd\u2e23\u2e25\u2e27\u2e29'
-           u'\u3009\u300b\u300d\u300f\u3011\u3015\u3017\u3019\u301b\u301e'
-           u'\u301f\ufd3f\ufe18\ufe36\ufe38\ufe3a\ufe3c\ufe3e\ufe40\ufe42'
-           u'\ufe44\ufe48\ufe5a\ufe5c\ufe5e\uff09\uff3d\uff5d\uff60\uff63'
-           u'\xbb\u2019\u201d\u203a\u2e03\u2e05\u2e0a\u2e0d\u2e1d\u2e21'
-           u'\u201b\u201f\xab\u2018\u201c\u2039\u2e02\u2e04\u2e09\u2e0c'
-           u'\u2e1c\u2e20\u201a\u201e')
-delimiters = (u'\\-/:\u058a\xa1\xb7\xbf\u037e\u0387\u055a-\u055f\u0589'
-              u'\u05be\u05c0\u05c3\u05c6\u05f3\u05f4\u0609\u060a\u060c'
-              u'\u060d\u061b\u061e\u061f\u066a-\u066d\u06d4\u0700-\u070d'
-              u'\u07f7-\u07f9\u0830-\u083e\u0964\u0965\u0970\u0df4\u0e4f'
-              u'\u0e5a\u0e5b\u0f04-\u0f12\u0f85\u0fd0-\u0fd4\u104a-\u104f'
-              u'\u10fb\u1361-\u1368\u1400\u166d\u166e\u16eb-\u16ed\u1735'
-              u'\u1736\u17d4-\u17d6\u17d8-\u17da\u1800-\u180a\u1944\u1945'
-              u'\u19de\u19df\u1a1e\u1a1f\u1aa0-\u1aa6\u1aa8-\u1aad\u1b5a-'
-              u'\u1b60\u1c3b-\u1c3f\u1c7e\u1c7f\u1cd3\u2010-\u2017\u2020-'
-              u'\u2027\u2030-\u2038\u203b-\u203e\u2041-\u2043\u2047-'
-              u'\u2051\u2053\u2055-\u205e\u2cf9-\u2cfc\u2cfe\u2cff\u2e00'
-              u'\u2e01\u2e06-\u2e08\u2e0b\u2e0e-\u2e1b\u2e1e\u2e1f\u2e2a-'
-              u'\u2e2e\u2e30\u2e31\u3001-\u3003\u301c\u3030\u303d\u30a0'
-              u'\u30fb\ua4fe\ua4ff\ua60d-\ua60f\ua673\ua67e\ua6f2-\ua6f7'
-              u'\ua874-\ua877\ua8ce\ua8cf\ua8f8-\ua8fa\ua92e\ua92f\ua95f'
-              u'\ua9c1-\ua9cd\ua9de\ua9df\uaa5c-\uaa5f\uaade\uaadf\uabeb'
-              u'\ufe10-\ufe16\ufe19\ufe30-\ufe32\ufe45\ufe46\ufe49-\ufe4c'
-              u'\ufe50-\ufe52\ufe54-\ufe58\ufe5f-\ufe61\ufe63\ufe68\ufe6a'
-              u'\ufe6b\uff01-\uff03\uff05-\uff07\uff0a\uff0c-\uff0f\uff1a'
-              u'\uff1b\uff1f\uff20\uff3c\uff61\uff64\uff65')
-if sys.maxunicode >= 0x10FFFF: # "wide" build
-    delimiters += (u'\U00010100\U00010101\U0001039f\U000103d0\U00010857'
-                   u'\U0001091f\U0001093f\U00010a50-\U00010a58\U00010a7f'
-                   u'\U00010b39-\U00010b3f\U000110bb\U000110bc\U000110be-'
-                   u'\U000110c1\U00012470-\U00012473')
-closing_delimiters = u'\\\\.,;!?'
+openers = (
+    '"\'(<\\{\u0f3a\u0f3c\u169b\u2045\u207d\u208d\u2329\u2768'
+    '\u276a\u276c\u276e\u2770\u2772\u2774\u27c5\u27e6\u27e8\u27ea'
+    '\u27ec\u27ee\u2983\u2985\u2987\u2989\u298b\u298d\u298f\u2991'
+    '\u2993\u2995\u2997\u29d8\u29da\u29fc\u2e22\u2e24\u2e26\u2e28'
+    '\u3008\u300a\u300c\u300e\u3010\u3014\u3016\u3018\u301a\u301d'
+    '\u301d\ufd3e\ufe17\ufe35\ufe37\ufe39\ufe3b\ufe3d\ufe3f\ufe41'
+    '\ufe43\ufe47\ufe59\ufe5b\ufe5d\uff08\uff3b\uff5b\uff5f\uff62'
+    '\xab\u2018\u201c\u2039\u2e02\u2e04\u2e09\u2e0c\u2e1c\u2e20'
+    '\u201a\u201e\xbb\u2019\u201d\u203a\u2e03\u2e05\u2e0a\u2e0d'
+    '\u2e1d\u2e21\u201b\u201f'
+    )
+closers = (
+    '"\')>\\}\u0f3b\u0f3d\u169c\u2046\u207e\u208e\u232a\u2769'
+    '\u276b\u276d\u276f\u2771\u2773\u2775\u27c6\u27e7\u27e9\u27eb'
+    '\u27ed\u27ef\u2984\u2986\u2988\u298a\u298c\u298e\u2990\u2992'
+    '\u2994\u2996\u2998\u29d9\u29db\u29fd\u2e23\u2e25\u2e27\u2e29'
+    '\u3009\u300b\u300d\u300f\u3011\u3015\u3017\u3019\u301b\u301e'
+    '\u301f\ufd3f\ufe18\ufe36\ufe38\ufe3a\ufe3c\ufe3e\ufe40\ufe42'
+    '\ufe44\ufe48\ufe5a\ufe5c\ufe5e\uff09\uff3d\uff5d\uff60\uff63'
+    '\xbb\u2019\u201d\u203a\u2e03\u2e05\u2e0a\u2e0d\u2e1d\u2e21'
+    '\u201b\u201f\xab\u2018\u201c\u2039\u2e02\u2e04\u2e09\u2e0c'
+    '\u2e1c\u2e20\u201a\u201e'
+    )
+delimiters = (
+    '\\-/:\u058a\xa1\xb7\xbf\u037e\u0387\u055a-\u055f\u0589'
+    '\u05be\u05c0\u05c3\u05c6\u05f3\u05f4\u0609\u060a\u060c'
+    '\u060d\u061b\u061e\u061f\u066a-\u066d\u06d4\u0700-\u070d'
+    '\u07f7-\u07f9\u0830-\u083e\u0964\u0965\u0970\u0df4\u0e4f'
+    '\u0e5a\u0e5b\u0f04-\u0f12\u0f85\u0fd0-\u0fd4\u104a-\u104f'
+    '\u10fb\u1361-\u1368\u1400\u166d\u166e\u16eb-\u16ed\u1735'
+    '\u1736\u17d4-\u17d6\u17d8-\u17da\u1800-\u180a\u1944\u1945'
+    '\u19de\u19df\u1a1e\u1a1f\u1aa0-\u1aa6\u1aa8-\u1aad\u1b5a-'
+    '\u1b60\u1c3b-\u1c3f\u1c7e\u1c7f\u1cd3\u2010-\u2017\u2020-'
+    '\u2027\u2030-\u2038\u203b-\u203e\u2041-\u2043\u2047-'
+    '\u2051\u2053\u2055-\u205e\u2cf9-\u2cfc\u2cfe\u2cff\u2e00'
+    '\u2e01\u2e06-\u2e08\u2e0b\u2e0e-\u2e1b\u2e1e\u2e1f\u2e2a-'
+    '\u2e2e\u2e30\u2e31\u3001-\u3003\u301c\u3030\u303d\u30a0'
+    '\u30fb\ua4fe\ua4ff\ua60d-\ua60f\ua673\ua67e\ua6f2-\ua6f7'
+    '\ua874-\ua877\ua8ce\ua8cf\ua8f8-\ua8fa\ua92e\ua92f\ua95f'
+    '\ua9c1-\ua9cd\ua9de\ua9df\uaa5c-\uaa5f\uaade\uaadf\uabeb'
+    '\ufe10-\ufe16\ufe19\ufe30-\ufe32\ufe45\ufe46\ufe49-\ufe4c'
+    '\ufe50-\ufe52\ufe54-\ufe58\ufe5f-\ufe61\ufe63\ufe68\ufe6a'
+    '\ufe6b\uff01-\uff03\uff05-\uff07\uff0a\uff0c-\uff0f\uff1a'
+    '\uff1b\uff1f\uff20\uff3c\uff61\uff64\uff65'
+    '\U00010100\U00010101\U0001039f\U000103d0\U00010857'
+    '\U0001091f\U0001093f\U00010a50-\U00010a58\U00010a7f'
+    '\U00010b39-\U00010b3f\U000110bb\U000110bc\U000110be-'
+    '\U000110c1\U00012470-\U00012473'
+    )
+closing_delimiters = r'\\.,;!?'
 
 
 # Matching open/close quotes
 # --------------------------
 
-quote_pairs = {# open char: matching closing characters # usage example
-               u'\xbb':   u'\xbb',         # » » Swedish
-               u'\u2018': u'\u201a',       # ‘ ‚ Albanian/Greek/Turkish
-               u'\u2019': u'\u2019',       # ’ ’ Swedish
-               u'\u201a': u'\u2018\u2019', # ‚ ‘ German ‚ ’ Polish
-               u'\u201c': u'\u201e',       # “ „ Albanian/Greek/Turkish
-               u'\u201e': u'\u201c\u201d', # „ “ German „ ” Polish
-               u'\u201d': u'\u201d',       # ” ” Swedish
-               u'\u203a': u'\u203a',       # › › Swedish
-              }
+# Matching open/close pairs are at the same position in
+# `punctuation_chars.openers` and `punctuation_chars.closers`.
+# Additional matches (due to different typographic conventions
+# in different languages) are stored in `quote_pairs`.
+
+quote_pairs = {
+    # open char: matching closing characters # use case
+    '\xbb': '\xbb',            # » » Swedish
+    '\u2018': '\u201a',        # ‘ ‚ Albanian/Greek/Turkish
+    '\u2019': '\u2019',        # ’ ’ Swedish
+    '\u201a': '\u2018\u2019',  # ‚ ‘ German, ‚ ’ Polish
+    '\u201c': '\u201e',        # “ „ Albanian/Greek/Turkish
+    '\u201e': '\u201c\u201d',  # „ “ German, „ ” Polish
+    '\u201d': '\u201d',        # ” ” Swedish
+    '\u203a': '\u203a',        # › › Swedish
+    }
 """Additional open/close quote pairs."""
 
-def match_chars(c1, c2):
-    """Test whether `c1` and `c2` are a matching open/close character pair.
 
-    Matching open/close pairs are at the same position in
-    `punctuation_chars.openers` and `punctuation_chars.closers`.
-    The pairing of open/close quotes is ambiguous due to  different
-    typographic conventions in different languages,
-    so we test for additional matches stored in `quote_pairs`.
-    """
+def match_chars(c1, c2):
+    """Test whether `c1` and `c2` are a matching open/close character pair."""
     try:
         i = openers.index(c1)
     except ValueError:  # c1 not in openers
         return False
-    return c2 == closersi or c2 in quote_pairs.get(c1, u'')
+    return c2 == closersi or c2 in quote_pairs.get(c1, '')

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/roman.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/roman.py Changed

@@ -16,13 +16,15 @@
 
 import re
 
-#Define exceptions
+
+# Define exceptions
 class RomanError(Exception): pass
 class OutOfRangeError(RomanError): pass
 class NotIntegerError(RomanError): pass
 class InvalidRomanNumeralError(RomanError): pass
 
-#Define digit mapping
+
+# Define digit mapping
 romanNumeralMap = (('M',  1000),
                    ('CM', 900),
                    ('D',  500),
@@ -37,6 +39,7 @@
                    ('IV', 4),
                    ('I',  1))
 
+
 def toRoman(n):
     """convert integer to Roman numeral"""
     if not (0 < n < 5000):
@@ -51,7 +54,8 @@
             n -= integer
     return result
 
-#Define pattern to detect valid Roman numerals
+
+# Define pattern to detect valid Roman numerals
 romanNumeralPattern = re.compile("""
     ^                   # beginning of string
     M{0,4}              # thousands - 0 to 4 M's
@@ -64,6 +68,7 @@
     $                   # end of string
     """, re.VERBOSE)
 
+
 def fromRoman(s):
     """convert Roman numeral to integer"""
     if not s:
@@ -79,4 +84,3 @@
             result += integer
             index += len(numeral)
     return result
-

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/smartquotes.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/smartquotes.py Changed

@@ -1,7 +1,5 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# :Id: $Id: smartquotes.py 8679 2021-04-09 11:58:10Z grubert $
+#!/usr/bin/python3
+# :Id: $Id: smartquotes.py 9335 2023-04-06 18:40:57Z milde $
 # :Copyright: © 2010 Günter Milde,
 #             original `SmartyPants`_: © 2003 John Gruber
 #             smartypants.py:          © 2004, 2007 Chad Miller
@@ -34,7 +32,7 @@
   characters, it works for any output format that supports Unicode.
 * Supports `language specific quote characters`__.
 
-__ http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
+__ https://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
 
 
 Authors
@@ -134,7 +132,7 @@
 .. _SmartyPants: http://daringfireball.net/projects/smartypants/
 .. _Movable Type: http://www.movabletype.org/
 .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
-.. _Docutils: http://docutils.sf.net/
+.. _Docutils: https://docutils.sourceforge.io/
 
 Description
 ===========
@@ -261,6 +259,9 @@
 Version History
 ===============
 
+1.9     2022-03-04
+        - Code cleanup. Require Python 3.
+
 1.8.1   2017-10-25
         - Use open quote after Unicode whitespace, ZWSP, and ZWNJ.
         - Code cleanup.
@@ -315,7 +316,10 @@
 1.5_1.0: Tue, 09 Mar 2004 08:08:35 -0500
         - Initial release
 """
-from __future__ import print_function
+
+import re
+import sys
+
 
 options = r"""
 Options
@@ -356,142 +360,141 @@
 
 :d:     Educates em-dashes.
 
-:D:     Educates em-dashes and en-dashes, using old-school typewriter shorthand:
-        (dash dash) for en-dashes, (dash dash dash) for em-dashes.
+:D:     Educates em-dashes and en-dashes, using old-school typewriter
+        shorthand: (dash dash) for en-dashes, (dash dash dash) for em-dashes.
 
 :i:     Educates em-dashes and en-dashes, using inverted old-school typewriter
         shorthand: (dash dash) for em-dashes, (dash dash dash) for en-dashes.
 
 :e:     Educates ellipses.
 
-:w:     Translates any instance of ``&quot;`` into a normal double-quote character.
-        This should be of no interest to most people, but of particular interest
-        to anyone who writes their posts using Dreamweaver, as Dreamweaver
-        inexplicably uses this entity to represent a literal double-quote
-        character. SmartyPants only educates normal quotes, not entities (because
-        ordinarily, entities are used for the explicit purpose of representing the
-        specific character they represent). The "w" option must be used in
-        conjunction with one (or both) of the other quote options ("q" or "b").
-        Thus, if you wish to apply all SmartyPants transformations (quotes, en-
-        and em-dashes, and ellipses) and also translate ``&quot;`` entities into
-        regular quotes so SmartyPants can educate them, you should pass the
-        following to the smarty_pants attribute:
+:w:     Translates any instance of ``&quot;`` into a normal double-quote
+        character. This should be of no interest to most people, but
+        of particular interest to anyone who writes their posts using
+        Dreamweaver, as Dreamweaver inexplicably uses this entity to represent
+        a literal double-quote character. SmartyPants only educates normal
+        quotes, not entities (because ordinarily, entities are used for
+        the explicit purpose of representing the specific character they
+        represent). The "w" option must be used in conjunction with one (or
+        both) of the other quote options ("q" or "b"). Thus, if you wish to
+        apply all SmartyPants transformations (quotes, en- and em-dashes, and
+        ellipses) and also translate ``&quot;`` entities into regular quotes
+        so SmartyPants can educate them, you should pass the following to the
+        smarty_pants attribute:
 """
 
 
-default_smartypants_attr = "1"
+class smartchars:
+    """Smart quotes and dashes"""
 
-
-import re, sys
-
-class smartchars(object):
-    """Smart quotes and dashes
-    """
-
-    endash   = u'–' # "&#8211;" EN DASH
-    emdash   = u'—' # "&#8212;" EM DASH
-    ellipsis = u'…' # "&#8230;" HORIZONTAL ELLIPSIS
-    apostrophe = u'’' # "&#8217;" RIGHT SINGLE QUOTATION MARK
+    endash = '–'      # "&#8211;" EN DASH
+    emdash = '—'      # "&#8212;" EM DASH
+    ellipsis = '…'    # "&#8230;" HORIZONTAL ELLIPSIS
+    apostrophe = '’'  # "&#8217;" RIGHT SINGLE QUOTATION MARK
 
     # quote characters (language-specific, set in __init__())
-    # 1 http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
-    # 2 http://de.wikipedia.org/wiki/Anf%C3%BChrungszeichen#Andere_Sprachen
-    # 3 https://fr.wikipedia.org/wiki/Guillemet
-    # 4 http://typographisme.net/post/Les-espaces-typographiques-et-le-web
-    # 5 http://www.btb.termiumplus.gc.ca/tpv2guides/guides/redac/index-fra.html
-    # 6 https://en.wikipedia.org/wiki/Hebrew_punctuation#Quotation_marks
-    # 7 http://www.tustep.uni-tuebingen.de/bi/bi00/bi001t1-anfuehrung.pdf
-    # 8 http://www.korrekturavdelingen.no/anforselstegn.htm
+    # https://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
+    # https://de.wikipedia.org/wiki/Anf%C3%BChrungszeichen#Andere_Sprachen
+    # https://fr.wikipedia.org/wiki/Guillemet
+    # https://typographisme.net/post/Les-espaces-typographiques-et-le-web
+    # https://www.btb.termiumplus.gc.ca/tpv2guides/guides/redac/index-fra.html
+    # https://en.wikipedia.org/wiki/Hebrew_punctuation#Quotation_marks
+    # 7 https://www.tustep.uni-tuebingen.de/bi/bi00/bi001t1-anfuehrung.pdf
+    # 8 https://www.korrekturavdelingen.no/anforselstegn.htm
     # 9 Typografisk håndbok. Oslo: Spartacus. 2000. s. 67. ISBN 8243001530.
-    # 10 http://www.typografi.org/sitat/sitatart.html
+    # 10 https://www.typografi.org/sitat/sitatart.html
+    # 11 https://mk.wikipedia.org/wiki/Правопис_и_правоговор_на_македонскиот_јазик  # noqa:E501
+    # 12 https://hrvatska-tipografija.com/polunavodnici/
+    # 13 https://pl.wikipedia.org/wiki/Cudzys%C5%82%C3%B3w
     #
     # See also configuration option "smartquote-locales".
-    quotes = {'af':           u'“”‘’',
-              'af-x-altquot': u'„”‚’',
-              'bg':           u'„“‚‘', # Bulgarian, https://bg.wikipedia.org/wiki/Кавички
-              'ca':           u'«»“”',
-              'ca-x-altquot': u'“”‘’',
-              'cs':           u'„“‚‘',
-              'cs-x-altquot': u'»«›‹',
-              'da':           u'»«›‹',
-              'da-x-altquot': u'„“‚‘',
-              # 'da-x-altquot2': u'””’’',
-              'de':           u'„“‚‘',
-              'de-x-altquot': u'»«›‹',
-              'de-ch':        u'«»‹›',
-              'el':           u'«»“”',
-              'en':           u'“”‘’',
-              'en-uk-x-altquot': u'‘’“”', # Attention: " → ‘ and ' → “ !
-              'eo':           u'“”‘’',
-              'es':           u'«»“”',
-              'es-x-altquot': u'“”‘’',
-              'et':           u'„“‚‘', # no secondary quote listed in
-              'et-x-altquot': u'«»‹›', # the sources above (wikipedia.org)
-              'eu':           u'«»‹›',
-              'fi':           u'””’’',
-              'fi-x-altquot': u'»»››',
-              'fr':           (u'« ', u' »', u'“', u'”'), # full no-break space
-              'fr-x-altquot': (u'« ', u' »', u'“', u'”'), # narrow no-break space
-              'fr-ch':        u'«»‹›',
-              'fr-ch-x-altquot': (u'« ',  u' »', u'‹ ', u' ›'), # narrow no-break space, http://typoguide.ch/
-              'gl':           u'«»“”',
-              'he':           u'”“»«', # Hebrew is RTL, test position:
-              'he-x-altquot': u'„”‚’', # low quotation marks are opening.
-              # 'he-x-altquot': u'“„‘‚', # RTL: low quotation marks opening
-              'hr':           u'„”‘’', # http://hrvatska-tipografija.com/polunavodnici/
-              'hr-x-altquot': u'»«›‹',
-              'hsb':          u'„“‚‘',
-              'hsb-x-altquot': u'»«›‹',
-              'hu':           u'„”«»',
-              'is':           u'„“‚‘',
-              'it':           u'«»“”',
-              'it-ch':        u'«»‹›',
-              'it-x-altquot': u'“”‘’',
-              # 'it-x-altquot2': u'“„‘‚', # 7 in headlines
-              'ja':           u'「」『』',
-              'ko':           u'“”‘’',
-              'lt':           u'„“‚‘',
-              'lv':           u'„“‚‘',
-              'mk':           u'„“‚‘', # Macedonian, https://mk.wikipedia.org/wiki/Правопис_и_правоговор_на_македонскиот_јазик
-              'nl':           u'“”‘’',
-              'nl-x-altquot': u'„”‚’',
-              # 'nl-x-altquot2': u'””’’',
-              'nb':           u'«»’’', # Norsk bokmål (canonical form 'no')
-              'nn':           u'«»’’', # Nynorsk 10
-              'nn-x-altquot': u'«»‘’', # 8, 10
-              # 'nn-x-altquot2': u'«»«»', # 9, 10
-              # 'nn-x-altquot3': u'„“‚‘', # 10
-              'no':           u'«»’’', # Norsk bokmål 10
-              'no-x-altquot': u'«»‘’', # 8, 10
-              # 'no-x-altquot2': u'«»«»', # 9, 10
-              # 'no-x-altquot3': u'„“‚‘', # 10
-              'pl':           u'„”«»',
-              'pl-x-altquot': u'«»‚’',
-              # 'pl-x-altquot2': u'„”‚’', # https://pl.wikipedia.org/wiki/Cudzys%C5%82%C3%B3w
-              'pt':           u'«»“”',
-              'pt-br':        u'“”‘’',
-              'ro':           u'„”«»',
-              'ru':           u'«»„“',
-              'sh':           u'„”‚’', # Serbo-Croatian
-              'sh-x-altquot': u'»«›‹',
-              'sk':           u'„“‚‘', # Slovak
-              'sk-x-altquot': u'»«›‹',
-              'sl':           u'„“‚‘', # Slovenian
-              'sl-x-altquot': u'»«›‹',
-              'sq':           u'«»‹›', # Albanian
-              'sq-x-altquot': u'“„‘‚',
-              'sr':           u'„”’’',
-              'sr-x-altquot': u'»«›‹',
-              'sv':           u'””’’',
-              'sv-x-altquot': u'»»››',
-              'tr':           u'“”‘’',
-              'tr-x-altquot': u'«»‹›',
-              # 'tr-x-altquot2': u'“„‘‚', # 7 antiquated?
-              'uk':           u'«»„“',
-              'uk-x-altquot': u'„“‚‘',
-              'zh-cn':        u'“”‘’',
-              'zh-tw':        u'「」『』',
-             }
+    quotes = {
+        'af':           '“”‘’',
+        'af-x-altquot': '„”‚’',
+        'bg':           '„“‚‘',  # https://bg.wikipedia.org/wiki/Кавички
+        'ca':           '«»“”',
+        'ca-x-altquot': '“”‘’',
+        'cs':           '„“‚‘',
+        'cs-x-altquot': '»«›‹',
+        'da':           '»«›‹',
+        'da-x-altquot': '„“‚‘',
+        # 'da-x-altquot2': '””’’',
+        'de':           '„“‚‘',
+        'de-x-altquot': '»«›‹',
+        'de-ch':        '«»‹›',
+        'el':           '«»“”',  # '«»‟”' https://hal.science/hal-02101618
+        'en':           '“”‘’',
+        'en-uk-x-altquot': '‘’“”',  # Attention: " → ‘ and ' → “ !
+        'eo':           '“”‘’',
+        'es':           '«»“”',
+        'es-x-altquot': '“”‘’',
+        'et':           '„“‚‘',  # no secondary quote listed in
+        'et-x-altquot': '«»‹›',  # the sources above (wikipedia.org)
+        'eu':           '«»‹›',
+        'fi':           '””’’',
+        'fi-x-altquot': '»»››',
+        'fr':           ('« ', ' »', '“', '”'),  # full no-break space
+        'fr-x-altquot': ('« ', ' »', '“', '”'),  # narrow no-break space
+        'fr-ch':        '«»‹›',                  # https://typoguide.ch/
+        'fr-ch-x-altquot': ('« ',  ' »', '‹ ', ' ›'),  # narrow no-break space  # noqa:E501
+        'gl':           '«»“”',
+        'he':           '”“»«',  # Hebrew is RTL, test position:
+        'he-x-altquot': '„”‚’',  # low quotation marks are opening.
+        # 'he-x-altquot': '“„‘‚',  # RTL: low quotation marks opening
+        'hr':           '„”‘’',  # Croatian 12
+        'hr-x-altquot': '»«›‹',
+        'hsb':          '„“‚‘',
+        'hsb-x-altquot': '»«›‹',
+        'hu':           '„”«»',
+        'is':           '„“‚‘',
+        'it':           '«»“”',
+        'it-ch':        '«»‹›',
+        'it-x-altquot': '“”‘’',
+        # 'it-x-altquot2': '“„‘‚',  # 7 in headlines
+        'ja':           '「」『』',
+        'ko':           '“”‘’',
+        'lt':           '„“‚‘',
+        'lv':           '„“‚‘',
+        'mk':           '„“‚‘',  # Macedonian 11
+        'nl':           '“”‘’',
+        'nl-x-altquot': '„”‚’',
+        # 'nl-x-altquot2': '””’’',
+        'nb':           '«»’’',     # Norsk bokmål (canonical form 'no')
+        'nn':           '«»’’',     # Nynorsk 10
+        'nn-x-altquot': '«»‘’',     # 8, 10
+        # 'nn-x-altquot2': '«»«»',  # 9, 10
+        # 'nn-x-altquot3': '„“‚‘',  # 10
+        'no':           '«»’’',     # Norsk bokmål 10
+        'no-x-altquot': '«»‘’',     # 8, 10
+        # 'no-x-altquot2': '«»«»',  # 9, 10
+        # 'no-x-altquot3': '„“‚‘',  # 10
+        'pl':           '„”«»',
+        'pl-x-altquot': '«»‚’',
+        # 'pl-x-altquot2': '„”‚’',  # 13
+        'pt':           '«»“”',
+        'pt-br':        '“”‘’',
+        'ro':           '„”«»',
+        'ru':           '«»„“',
+        'sh':           '„”‚’',  # Serbo-Croatian
+        'sh-x-altquot': '»«›‹',
+        'sk':           '„“‚‘',  # Slovak
+        'sk-x-altquot': '»«›‹',
+        'sl':           '„“‚‘',  # Slovenian
+        'sl-x-altquot': '»«›‹',
+        'sq':           '«»‹›',  # Albanian
+        'sq-x-altquot': '“„‘‚',
+        'sr':           '„”’’',
+        'sr-x-altquot': '»«›‹',
+        'sv':           '””’’',
+        'sv-x-altquot': '»»››',
+        'tr':           '“”‘’',
+        'tr-x-altquot': '«»‹›',
+        # 'tr-x-altquot2': '“„‘‚',  # 7 antiquated?
+        'uk':           '«»„“',
+        'uk-x-altquot': '„“‚‘',
+        'zh-cn':        '“”‘’',
+        'zh-tw':        '「」『』',
+        }
 
     def __init__(self, language='en'):
         self.language = language
@@ -499,20 +502,20 @@
             (self.opquote, self.cpquote,
              self.osquote, self.csquote) = self.quoteslanguage.lower()
         except KeyError:
-            self.opquote, self.cpquote, self.osquote, self.csquote = u'""\'\''
+            self.opquote, self.cpquote, self.osquote, self.csquote = '""\'\''
+
+
+default_smartypants_attr = '1'
 
 
 def smartyPants(text, attr=default_smartypants_attr, language='en'):
     """Main function for "traditional" use."""
 
-    return "".join(t for t in educate_tokens(tokenize(text),
-                                              attr, language))
+    return "".join(t for t in educate_tokens(tokenize(text), attr, language))
 
 
 def educate_tokens(text_tokens, attr=default_smartypants_attr, language='en'):
-    """Return iterator that "educates" the items of `text_tokens`.
-    """
-
+    """Return iterator that "educates" the items of `text_tokens`."""
     # Parse attributes:
     # 0 : do nothing
     # 1 : set all
@@ -535,43 +538,43 @@
     do_ellipses = False
     do_stupefy = False
 
-    # if attr == "0": # pass tokens unchanged (see below).
-    if attr == "1": # Do everything, turn all options on.
-        do_quotes    = True
+    # if attr == "0":  # pass tokens unchanged (see below).
+    if attr == '1':  # Do everything, turn all options on.
+        do_quotes = True
         do_backticks = True
-        do_dashes    = 1
-        do_ellipses  = True
-    elif attr == "2":
+        do_dashes = 1
+        do_ellipses = True
+    elif attr == '2':
         # Do everything, turn all options on, use old school dash shorthand.
-        do_quotes    = True
+        do_quotes = True
         do_backticks = True
-        do_dashes    = 2
-        do_ellipses  = True
-    elif attr == "3":
+        do_dashes = 2
+        do_ellipses = True
+    elif attr == '3':
         # Do everything, use inverted old school dash shorthand.
-        do_quotes    = True
+        do_quotes = True
         do_backticks = True
-        do_dashes    = 3
-        do_ellipses  = True
-    elif attr == "-1": # Special "stupefy" mode.
-        do_stupefy   = True
+        do_dashes = 3
+        do_ellipses = True
+    elif attr == '-1':  # Special "stupefy" mode.
+        do_stupefy = True
     else:
-        if "q" in attr: do_quotes = True
-        if "b" in attr: do_backticks = True
-        if "B" in attr: do_backticks = 2
-        if "d" in attr: do_dashes = 1
-        if "D" in attr: do_dashes = 2
-        if "i" in attr: do_dashes = 3
-        if "e" in attr: do_ellipses = True
-        if "w" in attr: convert_quot = True
-
-    prev_token_last_char = " "
+        if 'q' in attr: do_quotes = True     # noqa: E701
+        if 'b' in attr: do_backticks = True  # noqa: E701
+        if 'B' in attr: do_backticks = 2     # noqa: E701
+        if 'd' in attr: do_dashes = 1        # noqa: E701
+        if 'D' in attr: do_dashes = 2        # noqa: E701
+        if 'i' in attr: do_dashes = 3        # noqa: E701
+        if 'e' in attr: do_ellipses = True   # noqa: E701
+        if 'w' in attr: convert_quot = True  # noqa: E701
+
+    prev_token_last_char = ' '
     # Last character of the previous text token. Used as
     # context to curl leading quote characters correctly.
 
     for (ttype, text) in text_tokens:
 
-        # skip HTML and/or XML tags as well as emtpy text tokens
+        # skip HTML and/or XML tags as well as empty text tokens
         # without updating the last character
         if ttype == 'tag' or not text:
             yield text
@@ -583,12 +586,12 @@
             yield text
             continue
 
-        last_char = text-1: # Remember last char before processing.
+        last_char = text-1:  # Remember last char before processing.
 
         text = processEscapes(text)
 
         if convert_quot:
-            text = re.sub('&quot;', '"', text)
+            text = text.replace('&quot;', '"')
 
         if do_dashes == 1:
             text = educateDashes(text)
@@ -608,7 +611,7 @@
             text = educateSingleBackticks(text, language)
 
         if do_quotes:
-            # Replace plain quotes in context to prevent converstion to
+            # Replace plain quotes in context to prevent conversion to
             # 2-character sequence in French.
             context = prev_token_last_char.replace('"', ';').replace("'", ';')
             text = educateQuotes(context+text, language)1:
@@ -624,7 +627,6 @@
         yield text
 
 
-
 def educateQuotes(text, language='en'):
     """
     Parameter:  - text string (unicode or bytes).
@@ -636,13 +638,13 @@
     """
 
     smart = smartchars(language)
-    ch_classes = {'open': u'({', # opening braces
-                  'close': r'^\s', # everything except whitespace
-                  'punct': r"""-!"#\$\%'()*+,.\/:;<=>?\@\\\\\^_`{|}~""",
-                  'dash': u'-–—' # hyphen and em/en dashes
-                          + r'|&mndash;|&\#8211;|&\#8212;|&\#x20134;',
-                  'sep': u'\\s\u200B\u200C|&nbsp;', # Whitespace, ZWSP, ZWNJ
-                 }
+    ch_classes = {'open': '({',    # opening braces
+                  'close': r'^\s',  # everything except whitespace
+                  'punct': r"""-!" #\$\%'()*+,.\/:;<=>?\@\\\\\^_`{|}~""",
+                  'dash': '-–—'     # hyphen and em/en dashes
+                          r'|&mndash;|&\#8211;|&\#8212;|&\#x20134;',
+                  'sep': '\\s\u200B\u200C|&nbsp;',  # Whitespace, ZWSP, ZWNJ
+                  }
 
     # Special case if the very first character is a quote
     # followed by punctuation at a non-word-break. Use closing quotes.
@@ -652,8 +654,8 @@
 
     # Special case for adjacent quotes
     # like "'Quoted' words in a larger quote."
-    text = re.sub(r""""'(?=\w)""", smart.opquote+smart.osquote, text)
-    text = re.sub(r"""'"(?=\w)""", smart.osquote+smart.opquote, text)
+    text = re.sub('"\'(?=\\w)', smart.opquote+smart.osquote, text)
+    text = re.sub('\'"(?=\\w)', smart.osquote+smart.opquote, text)
 
     # Special case: "opening character" followed by quote,
     # optional punctuation and space like "", '(', or '-'.
@@ -663,45 +665,45 @@
                   r'\1%s'%smart.cpquote, text)
 
     # Special case for decade abbreviations (the '80s):
-    if language.startswith('en'): # TODO similar cases in other languages?
+    if language.startswith('en'):  # TODO similar cases in other languages?
         text = re.sub(r"'(?=\d{2}s)", smart.apostrophe, text)
 
     # Get most opening secondary quotes:
-    opening_secondary_quotes_regex = re.compile(u"""
+    opening_secondary_quotes_regex = re.compile("""
                     (# ?<=  # look behind fails: requires fixed-width pattern
                       %(sep)s     |  # a whitespace char, or
                       %(open)s    |  # opening brace, or
                       %(dash)s       # em/en-dash
                     )
-                    '                 # the quote
-                    (?=\\w|%(punct)s) # followed by a word character or punctuation
-                    """ % ch_classes, re.VERBOSE | re.UNICODE)
+                    '                  # the quote
+                    (?=\\w|%(punct)s)  # word character or punctuation
+                    """ % ch_classes, re.VERBOSE)
 
     text = opening_secondary_quotes_regex.sub(r'\1'+smart.osquote, text)
 
     # In many locales, secondary closing quotes are different from apostrophe:
     if smart.csquote != smart.apostrophe:
-        apostrophe_regex = re.compile(r"(?<=(\w|\d))'(?=\w)", re.UNICODE)
+        apostrophe_regex = re.compile(r"(?<=(\w|\d))'(?=\w)")
         text = apostrophe_regex.sub(smart.apostrophe, text)
     # TODO: keep track of quoting level to recognize apostrophe in, e.g.,
     # "Ich fass' es nicht."
 
-    closing_secondary_quotes_regex = re.compile(r"(?<!\s)'", re.UNICODE)
+    closing_secondary_quotes_regex = re.compile(r"(?<!\s)'")
     text = closing_secondary_quotes_regex.sub(smart.csquote, text)
 
     # Any remaining secondary quotes should be opening ones:
-    text = re.sub(r"""'""", smart.osquote, text)
+    text = text.replace(r"'", smart.osquote)
 
     # Get most opening primary quotes:
-    opening_primary_quotes_regex = re.compile(u"""
+    opening_primary_quotes_regex = re.compile("""
                     (
                       %(sep)s     |  # a whitespace char, or
                       %(open)s    |  # zero width separating char, or
                       %(dash)s       # em/en-dash
                     )
-                    "                 # the quote
-                    (?=\\w|%(punct)s) # followed by a word character or punctuation
-                    """ % ch_classes, re.VERBOSE | re.UNICODE)
+                    "                 # the quote, followed by
+                    (?=\\w|%(punct)s) # a word character or punctuation
+                    """ % ch_classes, re.VERBOSE)
 
     text = opening_primary_quotes_regex.sub(r'\1'+smart.opquote, text)
 
@@ -711,11 +713,11 @@
                     (?<!\s)" | # no whitespace before
                     "(?=\s)    # whitespace behind
                     )
-                    """, re.VERBOSE | re.UNICODE)
+                    """, re.VERBOSE)
     text = closing_primary_quotes_regex.sub(smart.cpquote, text)
 
     # Any remaining quotes should be opening ones.
-    text = re.sub(r'"', smart.opquote, text)
+    text = text.replace(r'"', smart.opquote)
 
     return text
 
@@ -730,8 +732,8 @@
     """
     smart = smartchars(language)
 
-    text = re.sub(r"""``""", smart.opquote, text)
-    text = re.sub(r"""''""", smart.cpquote, text)
+    text = text.replace(r'``', smart.opquote)
+    text = text.replace(r"''", smart.cpquote)
     return text
 
 
@@ -746,8 +748,8 @@
     """
     smart = smartchars(language)
 
-    text = re.sub(r"""`""", smart.osquote, text)
-    text = re.sub(r"""'""", smart.csquote, text)
+    text = text.replace(r'`', smart.osquote)
+    text = text.replace(r"'", smart.csquote)
     return text
 
 
@@ -758,8 +760,8 @@
                 an em-dash character.
     """
 
-    text = re.sub(r"""---""", smartchars.endash, text) # en  (yes, backwards)
-    text = re.sub(r"""--""", smartchars.emdash, text) # em (yes, backwards)
+    text = text.replace(r'---', smartchars.endash)  # en (yes, backwards)
+    text = text.replace(r'--', smartchars.emdash)   # em (yes, backwards)
     return text
 
 
@@ -771,8 +773,8 @@
                 an em-dash character.
     """
 
-    text = re.sub(r"""---""", smartchars.emdash, text)
-    text = re.sub(r"""--""", smartchars.endash, text)
+    text = text.replace(r'---', smartchars.emdash)
+    text = text.replace(r'--', smartchars.endash)
     return text
 
 
@@ -790,12 +792,11 @@
                 the shortcut should be shorter to type. (Thanks to Aaron
                 Swartz for the idea.)
     """
-    text = re.sub(r"""---""", smartchars.endash, text)    # em
-    text = re.sub(r"""--""", smartchars.emdash, text)    # en
+    text = text.replace(r'---', smartchars.endash)    # em
+    text = text.replace(r'--', smartchars.emdash)    # en
     return text
 
 
-
 def educateEllipses(text):
     """
     Parameter:  String (unicode or bytes).
@@ -806,8 +807,8 @@
     Example output: Huh&#8230;?
     """
 
-    text = re.sub(r"""\.\.\.""", smartchars.ellipsis, text)
-    text = re.sub(r"""\. \. \.""", smartchars.ellipsis, text)
+    text = text.replace(r'...', smartchars.ellipsis)
+    text = text.replace(r'. . .', smartchars.ellipsis)
     return text
 
 
@@ -822,16 +823,13 @@
     """
     smart = smartchars(language)
 
-    text = re.sub(smart.endash, "-", text)   # en-dash
-    text = re.sub(smart.emdash, "--", text)  # em-dash
-
-    text = re.sub(smart.osquote, "'", text)  # open secondary quote
-    text = re.sub(smart.csquote, "'", text)  # close secondary quote
-
-    text = re.sub(smart.opquote, '"', text)  # open primary quote
-    text = re.sub(smart.cpquote, '"', text)  # close primary quote
-
-    text = re.sub(smart.ellipsis, '...', text) # ellipsis
+    text = text.replace(smart.endash, "-")
+    text = text.replace(smart.emdash, "--")
+    text = text.replace(smart.osquote, "'")  # open secondary quote
+    text = text.replace(smart.csquote, "'")  # close secondary quote
+    text = text.replace(smart.opquote, '"')  # open primary quote
+    text = text.replace(smart.cpquote, '"')  # close primary quote
+    text = text.replace(smart.ellipsis, '...')
 
     return text
 
@@ -879,45 +877,30 @@
                 the second is the actual value.
 
     Based on the _tokenize() subroutine from Brad Choate's MTRegex plugin.
-        <http://www.bradchoate.com/past/mtregex.php>
     """
-
-    pos = 0
-    length = len(text)
-    # tokens = 
-
-    depth = 6
-    nested_tags = "|".join('(?:<(?:^<>', * depth) + (')*>)' * depth)
-    #match = r"""(?: <! ( -- .*? -- \s* )+ > ) |  # comments
-    #               (?: <\? .*? \?> ) |  # directives
-    #               %s  # nested tags       """ % (nested_tags,)
-    tag_soup = re.compile(r"""(^<*)(<^>*>)""")
-
+    tag_soup = re.compile(r'(^<*)(<^>*>)')
     token_match = tag_soup.search(text)
-
     previous_end = 0
+
     while token_match is not None:
         if token_match.group(1):
-            yield ('text', token_match.group(1))
-
-        yield ('tag', token_match.group(2))
-
+            yield 'text', token_match.group(1)
+        yield 'tag', token_match.group(2)
         previous_end = token_match.end()
         token_match = tag_soup.search(text, token_match.end())
 
     if previous_end < len(text):
-        yield ('text', textprevious_end:)
-
+        yield 'text', textprevious_end:
 
 
 if __name__ == "__main__":
 
     import itertools
+    import locale
     try:
-        import locale # module missing in Jython
-        locale.setlocale(locale.LC_ALL, '') # set to user defaults
-        defaultlanguage = locale.getdefaultlocale()0
-    except:
+        locale.setlocale(locale.LC_ALL, '')  # set to user defaults
+        defaultlanguage = locale.getlocale()0
+    except:  # noqa  catchall
         defaultlanguage = 'en'
 
     # Normalize and drop unsupported subtags:
@@ -929,7 +912,7 @@
     # find all combinations of subtags
     for n in range(len(_subtags), 0, -1):
         for tags in itertools.combinations(_subtags, n):
-            _tag = '-'.join((_basetag,)+tags)
+            _tag = '-'.join((_basetag, *tags))
             if _tag in smartchars.quotes:
                 defaultlanguage = _tag
                 break
@@ -939,18 +922,18 @@
             else:
                 defaultlanguage = 'en'
 
-
     import argparse
     parser = argparse.ArgumentParser(
-                description='Filter stdin making ASCII punctuation "smart".')
-    # parser.add_argument("text", help="text to be acted on")
+                description='Filter <input> making ASCII punctuation "smart".')
+    # TODO: require input arg or other means to print USAGE instead of waiting.
+    # parser.add_argument("input", help="Input stream, use '-' for stdin.")
     parser.add_argument("-a", "--action", default="1",
                         help="what to do with the input (see --actionhelp)")
-    parser.add_argument("-e", "--encoding", default="utf8",
+    parser.add_argument("-e", "--encoding", default="utf-8",
                         help="text encoding")
     parser.add_argument("-l", "--language", default=defaultlanguage,
                         help="text language (BCP47 tag), "
-                             "Default: %s"% defaultlanguage)
+                             f"Default: {defaultlanguage}")
     parser.add_argument("-q", "--alternative-quotes", action="store_true",
                         help="use alternative quote style")
     parser.add_argument("--doc", action="store_true",
@@ -981,15 +964,16 @@
         class TestSmartypantsAllAttributes(unittest.TestCase):
             # the default attribute is "1", which means "all".
             def test_dates(self):
-                self.assertEqual(smartyPants("1440-80's"), u"1440-80’s")
-                self.assertEqual(smartyPants("1440-'80s"), u"1440-’80s")
-                self.assertEqual(smartyPants("1440---'80s"), u"1440–’80s")
-                self.assertEqual(smartyPants("1960's"), u"1960’s")
-                self.assertEqual(smartyPants("one two '60s"), u"one two ’60s")
-                self.assertEqual(smartyPants("'60s"), u"’60s")
+                self.assertEqual(smartyPants("1440-80's"), "1440-80’s")
+                self.assertEqual(smartyPants("1440-'80s"), "1440-’80s")
+                self.assertEqual(smartyPants("1440---'80s"), "1440–’80s")
+                self.assertEqual(smartyPants("1960's"), "1960’s")
+                self.assertEqual(smartyPants("one two '60s"), "one two ’60s")
+                self.assertEqual(smartyPants("'60s"), "’60s")
 
             def test_educated_quotes(self):
-                self.assertEqual(smartyPants('"Isn\'t this fun?"'), u'“Isn’t this fun?”')
+                self.assertEqual(smartyPants('"Isn\'t this fun?"'),
+                                 '“Isn’t this fun?”')
 
             def test_html_tags(self):
                 text = '<a src="foo">more</a>'
@@ -1005,6 +989,5 @@
                 args.language = args.language.replace('-x-altquot', '')
             else:
                 args.language += '-x-altquot'
-        text = sys.stdin.read().decode(args.encoding)
-        print(smartyPants(text, attr=args.action,
-                          language=args.language).encode(args.encoding))
+        text = sys.stdin.read()
+        print(smartyPants(text, attr=args.action, language=args.language))

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/utils/urischemes.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/utils/urischemes.py Changed

@@ -1,4 +1,4 @@
-# $Id: urischemes.py 8376 2019-08-27 19:49:29Z milde $
+# $Id: urischemes.py 9315 2023-01-15 19:27:55Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -6,7 +6,7 @@
 `schemes` is a dictionary with lowercase URI addressing schemes as
 keys and descriptions as values. It was compiled from the index at
 http://www.iana.org/assignments/uri-schemes (revised 2005-11-28)
-and an older list at http://www.w3.org/Addressing/schemes.html.
+and an older list at https://www.w3.org/Addressing/schemes.html.
 """
 
 # Many values are blank and should be filled in with useful descriptions.
@@ -23,16 +23,16 @@
       'chttp': 'cached HTTP supported by RealPlayer',
       'cid': 'content identifier; RFC 2392',
       'crid': 'TV-Anytime Content Reference Identifier; RFC 4078',
-      'data': ('allows inclusion of small data items as "immediate" data; '
-               'RFC 2397'),
+      'data': 'allows inclusion of small data items as "immediate" data; '
+              'RFC 2397',
       'dav': 'Distributed Authoring and Versioning Protocol; RFC 2518',
       'dict': 'dictionary service protocol; RFC 2229',
       'dns': 'Domain Name System resources',
-      'eid': ('External ID; non-URL data; general escape mechanism to allow '
-              'access to information for applications that are too '
-              'specialized to justify their own schemes'),
-      'fax': ('a connection to a terminal that can handle telefaxes '
-              '(facsimiles); RFC 2806'),
+      'eid': 'External ID; non-URL data; general escape mechanism to allow '
+             'access to information for applications that are too '
+             'specialized to justify their own schemes',
+      'fax': 'a connection to a terminal that can handle telefaxes '
+             '(facsimiles); RFC 2806',
       'feed': 'NetNewsWire feed',
       'file': 'Host-specific file names; RFC 1738',
       'finger': '',
@@ -40,17 +40,18 @@
       'ftp': 'File Transfer Protocol; RFC 1738',
       'go': 'go; RFC 3368',
       'gopher': 'The Gopher Protocol',
-      'gsm-sms': ('Global System for Mobile Communications Short Message '
-                  'Service'),
-      'h323': ('video (audiovisual) communication on local area networks; '
-               'RFC 3508'),
-      'h324': ('video and audio communications over low bitrate connections '
-               'such as POTS modem connections'),
+      'gsm-sms': 'Global System for Mobile Communications Short Message '
+                 'Service',
+      'h323': 'video (audiovisual) communication on local area networks; '
+              'RFC 3508',
+      'h324': 'video and audio communications over low bitrate connections '
+              'such as POTS modem connections',
       'hdl': 'CNRI handle system',
       'hnews': 'an HTTP-tunneling variant of the NNTP news protocol',
       'http': 'Hypertext Transfer Protocol; RFC 2616',
       'https': 'HTTP over SSL; RFC 2818',
-      'hydra': 'SubEthaEdit URI.  See http://www.codingmonkeys.de/subethaedit.',
+      'hydra': 'SubEthaEdit URI. '
+               'See http://www.codingmonkeys.de/subethaedit.',
       'iioploc': 'Internet Inter-ORB Protocol Location?',
       'ilu': 'Inter-Language Unification',
       'im': 'Instant Messaging; RFC 3860',
@@ -62,8 +63,8 @@
       'iris.beep': 'iris.beep; RFC 3983',
       'iseek': 'See www.ambrosiasw.com;  a little util for OS X.',
       'jar': 'Java archive',
-      'javascript': ('JavaScript code; evaluates the expression after the '
-                     'colon'),
+      'javascript': 'JavaScript code; '
+                    'evaluates the expression after the colon',
       'jdbc': 'JDBC connection URI.',
       'ldap': 'Lightweight Directory Access Protocol',
       'lifn': '',
@@ -75,8 +76,8 @@
       'md5': '',
       'mid': 'message identifier; RFC 2392',
       'mocha': '',
-      'modem': ('a connection to a terminal that can handle incoming data '
-                'calls; RFC 2806'),
+      'modem': 'a connection to a terminal that can handle incoming data '
+               'calls; RFC 2806',
       'mtqp': 'Message Tracking Query Protocol; RFC 3887',
       'mupdate': 'Mailbox Update (MUPDATE) Protocol; RFC 3656',
       'news': 'USENET news; RFC 1738',
@@ -89,8 +90,8 @@
       'pres': 'Presence; RFC 3859',
       'printer': '',
       'prospero': 'Prospero Directory Service; RFC 4157',
-      'rdar': ('URLs found in Darwin source '
-                '(http://www.opensource.apple.com/darwinsource/).'),
+      'rdar': 'URLs found in Darwin source '
+              '(http://www.opensource.apple.com/darwinsource/).',
       'res': '',
       'rtsp': 'real time streaming protocol; RFC 2326',
       'rvp': '',
@@ -110,10 +111,10 @@
       't120': 'real time data conferencing (audiographics)',
       'tag': 'RFC 4151',
       'tcp': '',
-      'tel': ('a connection to a terminal that handles normal voice '
-              'telephone calls, a voice mailbox or another voice messaging '
-              'system or a service that can be operated using DTMF tones; '
-              'RFC 3966.'),
+      'tel': 'a connection to a terminal that handles normal voice '
+             'telephone calls, a voice mailbox or another voice messaging '
+             'system or a service that can be operated using DTMF tones; '
+             'RFC 3966.',
       'telephone': 'telephone',
       'telnet': 'Reference to interactive sessions; RFC 4248',
       'tftp': 'Trivial File Transfer Protocol; RFC 3617',
@@ -128,9 +129,10 @@
       'wais': 'Wide Area Information Servers; RFC 4156',
       'whodp': '',
       'whois++': 'Distributed directory service.',
-      'x-man-page': ('Opens man page in Terminal.app on OS X '
-                     '(see macosxhints.com)'),
+      'x-man-page': 'Opens man page in Terminal.app on OS X '
+                    '(see macosxhints.com)',
       'xmlrpc.beep': 'RFC 3529',
       'xmlrpc.beeps': 'RFC 3529',
       'z39.50r': 'Z39.50 Retrieval; RFC 2056',
-      'z39.50s': 'Z39.50 Session; RFC 2056',}
+      'z39.50s': 'Z39.50 Session; RFC 2056',
+      }

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8673 2021-04-07 17:57:27Z milde $
+# $Id: __init__.py 9368 2023-04-28 21:26:36Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,14 +8,13 @@
 
 __docformat__ = 'reStructuredText'
 
-import os.path
-import sys
 from importlib import import_module
 
 import docutils
 from docutils import languages, Component
 from docutils.transforms import universal
 
+
 class Writer(Component):
 
     """
@@ -32,32 +31,35 @@
     config_section = 'writers'
 
     def get_transforms(self):
-        return Component.get_transforms(self) + 
-            universal.Messages,
-            universal.FilterMessages,
-            universal.StripClassesAndElements,
+        return super().get_transforms() + universal.Messages,
+                                           universal.FilterMessages,
+                                           universal.StripClassesAndElements
 
     document = None
-    """The document to write (Docutils doctree); set by `write`."""
+    """The document to write (Docutils doctree); set by `write()`."""
 
     output = None
-    """Final translated form of `document` (Unicode string for text, binary
-    string for other forms); set by `translate`."""
+    """Final translated form of `document`
+
+    (`str` for text, `bytes` for binary formats); set by `translate()`.
+    """
 
     language = None
-    """Language module for the document; set by `write`."""
+    """Language module for the document; set by `write()`."""
 
     destination = None
     """`docutils.io` Output object; where to write the document.
-    Set by `write`."""
+
+    Set by `write()`.
+    """
 
     def __init__(self):
 
-        # Used by HTML and LaTeX writer for output fragments:
         self.parts = {}
         """Mapping of document part names to fragments of `self.output`.
-        Values are Unicode strings; encoding is up to the client.  The 'whole'
-        key should contain the entire document output.
+
+        See `Writer.assemble_parts()` below and
+        <https://docutils.sourceforge.io/docs/api/publisher.html>.
         """
 
     def write(self, document, destination):
@@ -76,8 +78,7 @@
             document.reporter)
         self.destination = destination
         self.translate()
-        output = self.destination.write(self.output)
-        return output
+        return self.destination.write(self.output)
 
     def translate(self):
         """
@@ -94,9 +95,14 @@
         raise NotImplementedError('subclass must override this method')
 
     def assemble_parts(self):
-        """Assemble the `self.parts` dictionary.  Extend in subclasses."""
+        """Assemble the `self.parts` dictionary.  Extend in subclasses.
+
+        See <https://docutils.sourceforge.io/docs/api/publisher.html>.
+        """
         self.parts'whole' = self.output
         self.parts'encoding' = self.document.settings.output_encoding
+        self.parts'errors' = (
+            self.document.settings.output_encoding_error_handler)
         self.parts'version' = docutils.__version__
 
 
@@ -128,26 +134,26 @@
       'xelatex': 'xetex',
       'luatex': 'xetex',
       'lualatex': 'xetex',
-      'odf': 'odf_odt',                   
-      'odt': 'odf_odt',                   
-      'ooffice': 'odf_odt',                   
-      'openoffice': 'odf_odt',                   
-      'libreoffice': 'odf_odt',                   
+      'odf': 'odf_odt',
+      'odt': 'odf_odt',
+      'ooffice': 'odf_odt',
+      'openoffice': 'odf_odt',
+      'libreoffice': 'odf_odt',
       'pprint': 'pseudoxml',
       'pformat': 'pseudoxml',
       'pdf': 'rlpdf',
       'xml': 'docutils_xml'}
 
+
 def get_writer_class(writer_name):
     """Return the Writer class from the `writer_name` module."""
-    writer_name = writer_name.lower()
-    if writer_name in _writer_aliases:
-        writer_name = _writer_aliaseswriter_name
+    name = writer_name.lower()
+    name = _writer_aliases.get(name, name)
     try:
-        module = import_module('docutils.writers.'+writer_name)
+        module = import_module('docutils.writers.'+name)
     except ImportError:
         try:
-            module = import_module(writer_name)
+            module = import_module(name)
         except ImportError as err:
-            raise ImportError('No writer named "%s".' % writer_name) 
+            raise ImportError(f'Writer "{writer_name}" not found. {err}')
     return module.Writer

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/_html_base.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/_html_base.py Changed

@@ -1,9 +1,8 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python3
 # :Author: David Goodger, Günter Milde
 #          Based on the html4css1 writer by David Goodger.
 # :Maintainer: docutils-develop@lists.sourceforge.net
-# :Revision: $Revision: 8644 $
+# :Revision: $Revision: 9292 $
 # :Date: $Date: 2005-06-28$
 # :Copyright: © 2016 David Goodger, Günter Milde
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
@@ -19,50 +18,123 @@
 
 import base64
 import mimetypes
-import os, os.path
+import os
+import os.path
 import re
-import sys
-
-try: # check for the Python Imaging Library
-    import PIL.Image
-except ImportError:
-    try:  # sometimes PIL modules are put in PYTHONPATH's root
-        import Image
-        class PIL(object): pass  # dummy wrapper
-        PIL.Image = Image
-    except ImportError:
-        PIL = None
+from urllib.request import unquote as unquote_url
+from urllib.request import url2pathname  # unquote and use local path sep
+import warnings
 
 import docutils
-from docutils import nodes, utils, writers, languages, io
-from docutils.utils.error_reporting import SafeString
+from docutils import frontend, languages, nodes, utils, writers
+from docutils.parsers.rst.directives import length_or_percentage_or_unitless
+from docutils.parsers.rst.directives.images import PIL
 from docutils.transforms import writer_aux
 from docutils.utils.math import (unichar2tex, pick_math_environment,
                                  math2html, latex2mathml, tex2mathml_extern)
 
-if sys.version_info >= (3, 0):
-    from urllib.request import url2pathname
-else:
-    from urllib import url2pathname
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
 
 class Writer(writers.Writer):
 
-    supported = ('html', 'xhtml') # update in subclass
+    supported = ('html', 'xhtml')  # update in subclass
     """Formats this writer supports."""
 
-    # default_stylesheets =  # set in subclass!
-    # default_stylesheet_dirs = '.' # set in subclass!
-    default_template = 'template.txt'
-    # default_template_path = ... # set in subclass!
-    # settings_spec = ... # set in subclass!
+    settings_spec = (
+        'HTML Writer Options',
+        None,
+        (('Specify the template file (UTF-8 encoded). '
+          '(default: writer dependent)',
+          '--template',
+          {'metavar': '<file>'}),
+         ('Comma separated list of stylesheet URLs. '
+          'Overrides previous --stylesheet and --stylesheet-path settings.',
+          '--stylesheet',
+          {'metavar': '<URL,URL,...>', 'overrides': 'stylesheet_path',
+           'validator': frontend.validate_comma_separated_list}),
+         ('Comma separated list of stylesheet paths. '
+          'Relative paths are expanded if a matching file is found in '
+          'the --stylesheet-dirs. With --link-stylesheet, '
+          'the path is rewritten relative to the output HTML file. '
+          '(default: writer dependent)',
+          '--stylesheet-path',
+          {'metavar': '<file,file,...>', 'overrides': 'stylesheet',
+           'validator': frontend.validate_comma_separated_list}),
+         ('Comma-separated list of directories where stylesheets are found. '
+          'Used by --stylesheet-path when expanding relative path arguments. '
+          '(default: writer dependent)',
+          '--stylesheet-dirs',
+          {'metavar': '<dir,dir,...>',
+           'validator': frontend.validate_comma_separated_list}),
+         ('Embed the stylesheet(s) in the output HTML file.  The stylesheet '
+          'files must be accessible during processing. (default)',
+          '--embed-stylesheet',
+          {'default': 1, 'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ('Link to the stylesheet(s) in the output HTML file. ',
+          '--link-stylesheet',
+          {'dest': 'embed_stylesheet', 'action': 'store_false'}),
+         ('Specify the initial header level. '
+          'Does not affect document title & subtitle (see --no-doc-title).'
+          '(default: writer dependent).',
+          '--initial-header-level',
+          {'choices': '1 2 3 4 5 6'.split(), 'default': '2',
+           'metavar': '<level>'}),
+         ('Format for footnote references: one of "superscript" or '
+          '"brackets". (default: "brackets")',
+          '--footnote-references',
+          {'choices': 'superscript', 'brackets', 'default': 'brackets',
+           'metavar': '<format>',
+           'overrides': 'trim_footnote_reference_space'}),
+         ('Format for block quote attributions: '
+          'one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". '
+          '(default: "dash")',
+          '--attribution',
+          {'choices': 'dash', 'parentheses', 'parens', 'none',
+           'default': 'dash', 'metavar': '<format>'}),
+         ('Remove extra vertical whitespace between items of "simple" bullet '
+          'lists and enumerated lists. (default)',
+          '--compact-lists',
+          {'default': True, 'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ('Disable compact simple bullet and enumerated lists.',
+          '--no-compact-lists',
+          {'dest': 'compact_lists', 'action': 'store_false'}),
+         ('Remove extra vertical whitespace between items of simple field '
+          'lists. (default)',
+          '--compact-field-lists',
+          {'default': True, 'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ('Disable compact simple field lists.',
+          '--no-compact-field-lists',
+          {'dest': 'compact_field_lists', 'action': 'store_false'}),
+         ('Added to standard table classes. '
+          'Defined styles: borderless, booktabs, '
+          'align-left, align-center, align-right, '
+          'colwidths-auto, colwidths-grid.',
+          '--table-style',
+          {'default': ''}),
+         ('Math output format (one of "MathML", "HTML", "MathJax", '
+          'or "LaTeX") and option(s). '
+          '(default: "HTML math.css")',
+          '--math-output',
+          {'default': 'HTML math.css'}),
+         ('Prepend an XML declaration. ',
+          '--xml-declaration',
+          {'default': False, 'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ('Omit the XML declaration.',
+          '--no-xml-declaration',
+          {'dest': 'xml_declaration', 'action': 'store_false'}),
+         ('Obfuscate email addresses to confuse harvesters while still '
+          'keeping email links usable with standards-compliant browsers.',
+          '--cloak-email-addresses',
+          {'action': 'store_true', 'validator': frontend.validate_boolean}),
+         )
+        )
 
     settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'}
 
-    # config_section = ... # set in subclass!
+    config_section = 'html base writer'  # overwrite in subclass
     config_section_dependencies = ('writers', 'html writers')
 
     visitor_attributes = (
@@ -73,7 +145,7 @@
         'html_body')
 
     def get_transforms(self):
-        return writers.Writer.get_transforms(self) + writer_aux.Admonitions
+        return super().get_transforms() + writer_aux.Admonitions
 
     def translate(self):
         self.visitor = visitor = self.translator_class(self.document)
@@ -83,9 +155,8 @@
         self.output = self.apply_template()
 
     def apply_template(self):
-        template_file = open(self.document.settings.template, 'rb')
-        template = unicode(template_file.read(), 'utf-8')
-        template_file.close()
+        with open(self.document.settings.template, encoding='utf-8') as fp:
+            template = fp.read()
         subs = self.interpolation_dict()
         return template % subs
 
@@ -162,15 +233,17 @@
       This way, changes in stack use will not bite you.
     """
 
-    xml_declaration = '<?xml version="1.0" encoding="%s" ?>\n'
     doctype = '<!DOCTYPE html>\n'
     doctype_mathml = doctype
 
     head_prefix_template = ('<html xmlns="http://www.w3.org/1999/xhtml"'
                             ' xml:lang="%(lang)s" lang="%(lang)s">\n<head>\n')
-    content_type = '<meta charset="%s"/>\n'
-    generator = ('<meta name="generator" content="Docutils %s: '
-                 'http://docutils.sourceforge.net/" />\n')
+    content_type = '<meta charset="%s" />\n'
+    generator = (
+        f'<meta name="generator" content="Docutils {docutils.__version__}: '
+        'https://docutils.sourceforge.io/" />\n')
+    # `starttag()` arguments for the main document (HTML5 uses <main>)
+    documenttag_args = {'tagname': 'div', 'CLASS': 'document'}
 
     # Template for the MathJax script in the header:
     mathjax_script = '<script type="text/javascript" src="%s"></script>\n'
@@ -184,7 +257,7 @@
     in the `math-output` setting appended to "mathjax".
     See `Docutils Configuration`__.
 
-    __ http://docutils.sourceforge.net/docs/user/config.html#math-output
+    __ https://docutils.sourceforge.io/docs/user/config.html#math-output
 
     The fallback tries a local MathJax installation at
     ``/usr/share/javascript/mathjax/MathJax.js``.
@@ -194,75 +267,94 @@
     embedded_stylesheet = '<style type="text/css">\n\n%s\n</style>\n'
     words_and_spaces = re.compile(r'^ \n+| +|\n')
     # wrap point inside word:
-    in_word_wrap_point = re.compile(r'.+\W\W.+|-?.+', re.U)
-    lang_attribute = 'lang' # name changes to 'xml:lang' in XHTML 1.1
-
-    special_characters = {ord('&'): u'&amp;',
-                          ord('<'): u'&lt;',
-                          ord('"'): u'&quot;',
-                          ord('>'): u'&gt;',
-                          ord('@'): u'&#64;', # may thwart address harvesters
-                         }
+    in_word_wrap_point = re.compile(r'.+\W\W.+|-?.+')
+    lang_attribute = 'lang'  # name changes to 'xml:lang' in XHTML 1.1
+
+    special_characters = {ord('&'): '&amp;',
+                          ord('<'): '&lt;',
+                          ord('"'): '&quot;',
+                          ord('>'): '&gt;',
+                          ord('@'): '&#64;',  # may thwart address harvesters
+                          }
     """Character references for characters with a special meaning in HTML."""
 
-
     def __init__(self, document):
         nodes.NodeVisitor.__init__(self, document)
+        # process settings
         self.settings = settings = document.settings
-        lcode = settings.language_code
-        self.language = languages.get_language(lcode, document.reporter)
-        self.meta = self.generator % docutils.__version__
-        self.head_prefix = 
-        self.html_prolog = 
-        if settings.xml_declaration:
-            self.head_prefix.append(self.xml_declaration
-                                    % settings.output_encoding)
-            # self.content_type = ""
-            # encoding not interpolated:
-            self.html_prolog.append(self.xml_declaration)
-        self.head = self.meta:
-        self.stylesheet = self.stylesheet_call(path)
-                           for path in utils.get_stylesheet_list(settings)
-        self.body_prefix = '</head>\n<body>\n'
-        # document title, subtitle display
-        self.body_pre_docinfo = 
-        # author, date, etc.
-        self.docinfo = 
-        self.body = 
-        self.fragment = 
-        self.body_suffix = '</body>\n</html>\n'
-        self.section_level = 0
+        self.language = languages.get_language(
+                            settings.language_code, document.reporter)
         self.initial_header_level = int(settings.initial_header_level)
-
+        # image_loading (only defined for HTML5 writer)
+        self.image_loading = getattr(settings, 'image_loading', None)
+        # legacy setting embed_images:
+        if getattr(settings, 'embed_images', None) is True:
+            warnings.warn('The configuration setting "embed_images" '
+                          'will be removed in Docutils 2.0. '
+                          'Use "image_loading: embed".',
+                          FutureWarning, stacklevel=8)
+            if self.image_loading is None:
+                self.image_loading = 'embed'
+        if getattr(settings, 'embed_images', None) is False:
+            warnings.warn('The configuration setting "embed_images" '
+                          'will be removed in Docutils 2.0. '
+                          'Use "image_loading: link".',
+                          FutureWarning, stacklevel=8)
+        if self.image_loading is None:
+            self.image_loading = 'link'  # default
         self.math_output = settings.math_output.split()
         self.math_output_options = self.math_output1:
         self.math_output = self.math_output0.lower()
 
+        # set up "parts" (cf. docs/api/publisher.html#publish-parts-details)
+        #
+        self.body =   # equivalent to `fragment`, ≠ `html_body`
+        self.body_prefix = '</head>\n<body>\n'  # + optional header
+        self.body_pre_docinfo =   # document heading (title and subtitle)
+        self.body_suffix = '</body>\n</html>\n'  # + optional footer
+        self.docinfo = 
+        self.footer = 
+        self.fragment =   # main content of the document ("naked" body)
+        self.head = 
+        self.head_prefix =   # everything up to and including <head>
+        self.header = 
+        self.html_body = 
+        self.html_head = self.content_type  # charset not interpolated
+        self.html_prolog = 
+        self.html_subtitle = 
+        self.html_title = 
+        self.meta = self.generator
+        self.stylesheet = self.stylesheet_call(path)
+                           for path in utils.get_stylesheet_list(settings)
+        self.title = 
+        self.subtitle = 
+        if settings.xml_declaration:
+            self.head_prefix.append(
+                utils.xml_declaration(settings.output_encoding))
+            self.html_prolog.append(
+                utils.xml_declaration('%s'))  # encoding not interpolated
+        if (settings.output_encoding
+            and settings.output_encoding.lower() != 'unicode'):
+            self.meta.insert(0, self.content_type % settings.output_encoding)
+
+        # bookkeeping attributes; reflect state of translator
+        #
         self.context = 
         """Heterogeneous stack.
 
         Used by visit_* and depart_* functions in conjunction with the tree
-        traversal. Make sure that the pops correspond to the pushes."""
-
-        self.topic_classes = 
+        traversal. Make sure that the pops correspond to the pushes.
+        """
+        self.section_level = 0
         self.colspecs = 
         self.compact_p = True
         self.compact_simple = False
         self.compact_field_list = False
         self.in_docinfo = False
         self.in_sidebar = False
-        self.in_footnote_list = False
-        self.title = 
-        self.subtitle = 
-        self.header = 
-        self.footer = 
-        self.html_head = self.content_type # charset not interpolated
-        self.html_title = 
-        self.html_subtitle = 
-        self.html_body = 
-        self.in_document_title = 0   # len(self.body) or 0
+        self.in_document_title = 0  # len(self.body) or 0
         self.in_mailto = False
-        self.author_in_authors = False # for html4css1
+        self.author_in_authors = False  # for html4css1
         self.math_header = 
 
     def astext(self):
@@ -276,7 +368,7 @@
         # Use only named entities known in both XML and HTML
         # other characters are automatically encoded "by number" if required.
         # @@@ A codec to do these and all other HTML entities would be nice.
-        text = unicode(text)
+        text = str(text)
         return text.translate(self.special_characters)
 
     def cloak_mailto(self, uri):
@@ -291,8 +383,7 @@
         # Surround at-signs and periods with <span> tags.  ("@" has
         # already been encoded to "&#64;" by the `encode` method.)
         addr = addr.replace('&#64;', '<span>&#64;</span>')
-        addr = addr.replace('.', '<span>&#46;</span>')
-        return addr
+        return addr.replace('.', '<span>&#46;</span>')
 
     def attval(self, text,
                whitespace=re.compile('\n\r\t\v\f')):
@@ -304,22 +395,24 @@
             encoded = encoded.replace('.', '&#46;')
         return encoded
 
-    def stylesheet_call(self, path):
+    def stylesheet_call(self, path, adjust_path=None):
         """Return code to reference or embed stylesheet file `path`"""
+        if adjust_path is None:
+            adjust_path = bool(self.settings.stylesheet_path)
         if self.settings.embed_stylesheet:
             try:
-                content = io.FileInput(source_path=path,
-                                       encoding='utf-8').read()
-                self.settings.record_dependencies.add(path)
-            except IOError as err:
-                msg = u"Cannot embed stylesheet '%r': %s." % (
-                                path, SafeString(err.strerror))
+                with open(path, encoding='utf-8') as f:
+                    content = f.read()
+            except OSError as err:
+                msg = f'Cannot embed stylesheet: {err}'
                 self.document.reporter.error(msg)
                 return '<--- %s --->\n' % msg
+            else:
+                self.settings.record_dependencies.add(path)
             return self.embedded_stylesheet % content
         # else link to style file:
-        if self.settings.stylesheet_path:
-            # adapt path relative to output (cf. config.html#stylesheet-path)
+        if adjust_path:
+            # rewrite path relative to output (cf. config.html#stylesheet-path)
             path = utils.relative_path(self.settings._destination, path)
         return self.stylesheet_link % self.encode(path)
 
@@ -331,10 +424,9 @@
         tagname = tagname.lower()
         prefix = 
         atts = {}
-        ids = 
         for (name, value) in attributes.items():
             attsname.lower() = value
-        classes = 
+        classes = atts.pop('classes', )
         languages = 
         # unify class arguments and move language specification
         for cls in node.get('classes', ) + atts.pop('class', '').split():
@@ -345,13 +437,15 @@
         if languages:
             # attribute name is 'lang' in XHTML 1.0 but 'xml:lang' in 1.1
             attsself.lang_attribute = languages0
+        # filter classes that are processed by the writer:
+        internal = ('colwidths-auto', 'colwidths-given', 'colwidths-grid')
+        if isinstance(node, nodes.table):
+            classes = cls for cls in classes if cls not in internal
         if classes:
             atts'class' = ' '.join(classes)
         assert 'id' not in atts
-        ids.extend(node.get('ids', ))
-        if 'ids' in atts:
-            ids.extend(atts'ids')
-            del atts'ids'
+        ids = node.get('ids', )
+        ids.extend(atts.pop('ids', ))
         if ids:
             atts'id' = ids0
             for id in ids1::
@@ -360,11 +454,9 @@
                 # may be targets inside of references, but nested "a"
                 # elements aren't allowed in XHTML (even if they do
                 # not all have a "href" attribute).
-                if empty or isinstance(node,
-                            (nodes.bullet_list, nodes.docinfo,
-                             nodes.definition_list, nodes.enumerated_list,
-                             nodes.field_list, nodes.option_list,
-                             nodes.table)):
+                if empty or isinstance(node, (nodes.Sequential,
+                                              nodes.docinfo,
+                                              nodes.table)):
                     # Insert target right in front of element.
                     prefix.append('<span id="%s"></span>' % id)
                 else:
@@ -378,12 +470,12 @@
             # value, but this isn't supported by XHTML.
             assert value is not None
             if isinstance(value, list):
-                values = unicode(v) for v in value
+                values = str(v) for v in value
                 parts.append('%s="%s"' % (name.lower(),
                                           self.attval(' '.join(values))))
             else:
                 parts.append('%s="%s"' % (name.lower(),
-                                          self.attval(unicode(value))))
+                                          self.attval(str(value))))
         if empty:
             infix = ' /'
         else:
@@ -433,20 +525,19 @@
     def visit_address(self, node):
         self.visit_docinfo_item(node, 'address', meta=False)
         self.body.append(self.starttag(node, 'pre',
-                                       suffix= '', CLASS='address'))
+                                       suffix='', CLASS='address'))
 
     def depart_address(self, node):
         self.body.append('\n</pre>\n')
         self.depart_docinfo_item()
 
     def visit_admonition(self, node):
-        node'classes'.insert(0, 'admonition')
-        self.body.append(self.starttag(node, 'div'))
+        self.body.append(self.starttag(node, 'aside', classes='admonition'))
 
     def depart_admonition(self, node=None):
-        self.body.append('</div>\n')
+        self.body.append('</aside>\n')
 
-    attribution_formats = {'dash': (u'\u2014', ''),
+    attribution_formats = {'dash': ('\u2014', ''),
                            'parentheses': ('(', ')'),
                            'parens': ('(', ')'),
                            'none': ('', '')}
@@ -461,7 +552,7 @@
         self.body.append(self.context.pop() + '</p>\n')
 
     def visit_author(self, node):
-        if not(isinstance(node.parent, nodes.authors)):
+        if not isinstance(node.parent, nodes.authors):
             self.visit_docinfo_item(node, 'author')
         self.body.append('<p>')
 
@@ -502,7 +593,7 @@
     # the end of this file).
 
     def is_compactable(self, node):
-        # explicite class arguments have precedence
+        # explicit class arguments have precedence
         if 'compact' in node'classes':
             return True
         if 'open' in node'classes':
@@ -515,8 +606,7 @@
             and not self.settings.compact_lists):
             return False
         # Table of Contents:
-        if (self.topic_classes == 'contents'):
-            # TODO: look in parent nodes, remove self.topic_classes?
+        if 'contents' in node.parent'classes':
             return True
         # check the list items:
         return self.check_simple_list(node)
@@ -541,24 +631,23 @@
     def depart_caption(self, node):
         self.body.append('</p>\n')
 
+    # Use semantic tag and DPub role (HTML4 uses a table)
     def visit_citation(self, node):
-        # Use definition list for bibliographic references.
-        # Join adjacent citation entries.
-        # TODO: use <aside>.
-        if not self.in_footnote_list:
-            listnode = node.copy()
-            listnode'ids' = 
-            self.body.append(self.starttag(listnode, 'dl', CLASS='citation'))
-            # self.body.append('<dl class="citation">\n')
-            self.in_footnote_list = True
+        # role 'doc-bibloentry' requires wrapping in an element with
+        # role 'list' and an element with role 'doc-bibliography'
+        # https://www.w3.org/TR/dpub-aria-1.0/#doc-biblioentry)
+        if not isinstance(node.previous_sibling(), type(node)):
+            self.body.append('<div role="list" class="citation-list">\n')
+        self.body.append(self.starttag(node, 'div', classes=node.tagname,
+                                       role="doc-biblioentry"))
 
     def depart_citation(self, node):
-        self.body.append('</dd>\n')
+        self.body.append('</div>\n')
         if not isinstance(node.next_node(descend=False, siblings=True),
-                          nodes.citation):
-            self.body.append('</dl>\n')
-            self.in_footnote_list = False
+                          type(node)):
+            self.body.append('</div>\n')
 
+    # Use DPub role (overwritten in HTML4)
     def visit_citation_reference(self, node):
         href = '#'
         if 'refid' in node:
@@ -567,13 +656,14 @@
             href += self.document.nameidsnode'refname'
         # else: # TODO system message (or already in the transform)?
         # 'Citation reference missing.'
-        self.body.append(self.starttag(
-            node, 'a', '', CLASS='citation-reference', href=href))
+        self.body.append(self.starttag(node, 'a', suffix='', href=href,
+                                       classes='citation-reference',
+                                       role='doc-biblioref'))
 
     def depart_citation_reference(self, node):
         self.body.append('</a>')
 
-     # classifier
+    # classifier
     # ----------
     # don't insert classifier-delimiter here (done by CSS)
 
@@ -594,15 +684,15 @@
                       nodes.colspec):
             return
         if 'colwidths-auto' in node.parent.parent'classes' or (
-            'colwidths-auto' in self.settings.table_style and
-            ('colwidths-given' not in node.parent.parent'classes')):
+            'colwidths-grid' not in self.settings.table_style
+            and 'colwidths-given' not in node.parent.parent'classes'):
             return
-        total_width = sum(node'colwidth' for node in self.colspecs)
         self.body.append(self.starttag(node, 'colgroup'))
+        total_width = sum(node'colwidth' for node in self.colspecs)
         for node in self.colspecs:
-            colwidth = int(node'colwidth' * 100.0 / total_width + 0.5)
+            colwidth = node'colwidth' / total_width
             self.body.append(self.emptytag(node, 'col',
-                                           style='width: %i%%' % colwidth))
+                                           style=f'width: {colwidth:.1%}'))
         self.body.append('</colgroup>\n')
 
     def visit_comment(self, node,
@@ -614,17 +704,13 @@
 
     def visit_compound(self, node):
         self.body.append(self.starttag(node, 'div', CLASS='compound'))
-        if len(node) > 1:
-            node0'classes'.append('compound-first')
-            node-1'classes'.append('compound-last')
-            for child in node1:-1:
-                child'classes'.append('compound-middle')
 
     def depart_compound(self, node):
         self.body.append('</div>\n')
 
     def visit_container(self, node):
-        self.body.append(self.starttag(node, 'div', CLASS='docutils container'))
+        self.body.append(self.starttag(node, 'div',
+                                       CLASS='docutils container'))
 
     def depart_container(self, node):
         self.body.append('</div>\n')
@@ -654,32 +740,40 @@
         pass
 
     def visit_definition(self, node):
-        self.body.append('</dt>\n')
-        self.body.append(self.starttag(node, 'dd', ''))
+        if 'details' in node.parent.parent'classes':
+            self.body.append('</summary>\n')
+        else:
+            self.body.append('</dt>\n')
+            self.body.append(self.starttag(node, 'dd', ''))
 
     def depart_definition(self, node):
-        self.body.append('</dd>\n')
+        if 'details' not in node.parent.parent'classes':
+            self.body.append('</dd>\n')
 
     def visit_definition_list(self, node):
-        classes = node.setdefault('classes', )
-        if self.is_compactable(node):
-            classes.append('simple')
-        self.body.append(self.starttag(node, 'dl'))
+        if 'details' in node'classes':
+            self.body.append(self.starttag(node, 'div'))
+        else:
+            classes = 'simple' if self.is_compactable(node) else 
+            self.body.append(self.starttag(node, 'dl', classes=classes))
 
     def depart_definition_list(self, node):
-        self.body.append('</dl>\n')
+        if 'details' in node'classes':
+            self.body.append('</div>\n')
+        else:
+            self.body.append('</dl>\n')
 
+    # Use a "details" disclosure element if parent has "class" arg "details".
     def visit_definition_list_item(self, node):
-        # pass class arguments, ids and names to definition term:
-        node.children0'classes' = (
-            node.get('classes', ) + node.children0.get('classes', ))
-        node.children0'ids' = (
-            node.get('ids', ) + node.children0.get('ids', ))
-        node.children0'names' = (
-            node.get('names', ) + node.children0.get('names', ))
+        if 'details' in node.parent'classes':
+            atts = {}
+            if "open" in node.parent'classes':
+                atts'open' = 'open'
+            self.body.append(self.starttag(node, 'details', **atts))
 
     def depart_definition_list_item(self, node):
-        pass
+        if 'details' in node.parent'classes':
+            self.body.append('</details>\n')
 
     def visit_description(self, node):
         self.body.append(self.starttag(node, 'dd', ''))
@@ -689,10 +783,10 @@
 
     def visit_docinfo(self, node):
         self.context.append(len(self.body))
-        classes = 'docinfo'
-        if (self.is_compactable(node)):
-            classes += ' simple'
-        self.body.append(self.starttag(node, 'dl', CLASS=classes))
+        classes = 'docinfo'
+        if self.is_compactable(node):
+            classes.append('simple')
+        self.body.append(self.starttag(node, 'dl', classes=classes))
 
     def depart_docinfo(self, node):
         self.body.append('</dl>\n')
@@ -702,11 +796,10 @@
 
     def visit_docinfo_item(self, node, name, meta=True):
         if meta:
-            meta_tag = '<meta name="%s" content="%s" />\n' \
-                       % (name, self.attval(node.astext()))
-            self.add_meta(meta_tag)
-        self.body.append('<dt class="%s">%s</dt>\n'
-                         % (name, self.language.labelsname))
+            self.meta.append(f'<meta name="{name}" '
+                             f'content="{self.attval(node.astext())}" />\n')
+        self.body.append(f'<dt class="{name}">{self.language.labelsname}'
+                         '<span class="colon">:</span></dt>\n')
         self.body.append(self.starttag(node, 'dd', '', CLASS=name))
 
     def depart_docinfo_item(self):
@@ -714,26 +807,25 @@
 
     def visit_doctest_block(self, node):
         self.body.append(self.starttag(node, 'pre', suffix='',
-                                       CLASS='code python doctest'))
+                                       classes='code', 'python', 'doctest'))
 
     def depart_doctest_block(self, node):
         self.body.append('\n</pre>\n')
 
     def visit_document(self, node):
-        title = (node.get('title', '') or os.path.basename(node'source')
-                 or 'docutils document without title')
-        self.head.append('<title>%s</title>\n' % self.encode(title))
+        title = (node.get('title') or os.path.basename(node'source')
+                 or 'untitled Docutils document')
+        self.head.append(f'<title>{self.encode(title)}</title>\n')
 
     def depart_document(self, node):
         self.head_prefix.extend(self.doctype,
                                  self.head_prefix_template %
                                  {'lang': self.settings.language_code})
         self.html_prolog.append(self.doctype)
-        self.meta.insert(0, self.content_type % self.settings.output_encoding)
-        self.head.insert(0, self.content_type % self.settings.output_encoding)
+        self.head = self.meta: + self.head
         if 'name="dcterms.' in ''.join(self.meta):
-            self.head.append(
-             '<link rel="schema.dcterms" href="http://purl.org/dc/terms/"/>')
+            self.head.append('<link rel="schema.dcterms"'
+                             ' href="http://purl.org/dc/terms/"/>')
         if self.math_header:
             if self.math_output == 'mathjax':
                 self.head.extend(self.math_header)
@@ -741,13 +833,13 @@
                 self.stylesheet.extend(self.math_header)
         # skip content-type meta tag with interpolated charset value:
         self.html_head.extend(self.head1:)
-        self.body_prefix.append(self.starttag(node, 'div', CLASS='document'))
-        self.body_suffix.insert(0, '</div>\n')
-        self.fragment.extend(self.body) # self.fragment is the "naked" body
+        self.body_prefix.append(self.starttag(node, **self.documenttag_args))
+        self.body_suffix.insert(0, f'</{self.documenttag_args"tagname"}>\n')
+        self.fragment.extend(self.body)  # self.fragment is the "naked" body
         self.html_body.extend(self.body_prefix1: + self.body_pre_docinfo
                               + self.docinfo + self.body
                               + self.body_suffix:-1)
-        assert not self.context, 'len(context) = %s' % len(self.context)
+        assert not self.context, f'len(context) = {len(self.context)}'
 
     def visit_emphasis(self, node):
         self.body.append(self.starttag(node, 'em', ''))
@@ -756,18 +848,16 @@
         self.body.append('</em>')
 
     def visit_entry(self, node):
-        atts = {'class': }
+        atts = {'classes': }
         if isinstance(node.parent.parent, nodes.thead):
-            atts'class'.append('head')
+            atts'classes'.append('head')
         if node.parent.parent.parent.stubsnode.parent.column:
             # "stubs" list is an attribute of the tgroup element
-            atts'class'.append('stub')
-        if atts'class':
+            atts'classes'.append('stub')
+        if atts'classes':
             tagname = 'th'
-            atts'class' = ' '.join(atts'class')
         else:
             tagname = 'td'
-            del atts'class'
         node.parent.column += 1
         if 'morerows' in node:
             atts'rowspan' = node'morerows' + 1
@@ -776,33 +866,40 @@
             node.parent.column += node'morecols'
         self.body.append(self.starttag(node, tagname, '', **atts))
         self.context.append('</%s>\n' % tagname.lower())
-        # TODO: why does the html4css1 writer insert an NBSP into empty cells?
-        # if len(node) == 0:              # empty cell
-        #     self.body.append('&#0160;') # no-break space
 
     def depart_entry(self, node):
         self.body.append(self.context.pop())
 
     def visit_enumerated_list(self, node):
-        atts = {}
+        atts = {'classes': }
         if 'start' in node:
             atts'start' = node'start'
         if 'enumtype' in node:
-            atts'class' = node'enumtype'
+            atts'classes'.append(node'enumtype')
         if self.is_compactable(node):
-            atts'class' = (atts.get('class', '') + ' simple').strip()
+            atts'classes'.append('simple')
         self.body.append(self.starttag(node, 'ol', **atts))
 
     def depart_enumerated_list(self, node):
         self.body.append('</ol>\n')
 
     def visit_field_list(self, node):
-        # Keep simple paragraphs in the field_body to enable CSS
-        # rule to start body on new line if the label is too long
-        classes = 'field-list'
-        if (self.is_compactable(node)):
-            classes += ' simple'
-        self.body.append(self.starttag(node, 'dl', CLASS=classes))
+        atts = {}
+        classes = node.setdefault('classes', )
+        for i, cls in enumerate(classes):
+            if cls.startswith('field-indent-'):
+                try:
+                    indent_length = length_or_percentage_or_unitless(
+                                                        cls13:, 'px')
+                except ValueError:
+                    break
+                atts'style' = '--field-indent: %s;' % indent_length
+                classes.pop(i)
+                break
+        classes.append('field-list')
+        if self.is_compactable(node):
+            classes.append('simple')
+        self.body.append(self.starttag(node, 'dl', **atts))
 
     def depart_field_list(self, node):
         self.body.append('</dl>\n')
@@ -814,17 +911,16 @@
         pass
 
     # as field is ignored, pass class arguments to field-name and field-body:
-
     def visit_field_name(self, node):
         self.body.append(self.starttag(node, 'dt', '',
-                                       CLASS=''.join(node.parent'classes')))
+                                       classes=node.parent'classes'))
 
     def depart_field_name(self, node):
-        self.body.append('</dt>\n')
+        self.body.append('<span class="colon">:</span></dt>\n')
 
     def visit_field_body(self, node):
         self.body.append(self.starttag(node, 'dd', '',
-                                       CLASS=''.join(node.parent'classes')))
+                                       classes=node.parent'classes'))
         # prevent misalignment of following content if the field is empty:
         if not node.children:
             self.body.append('<p></p>')
@@ -843,7 +939,6 @@
     def depart_figure(self, node):
         self.body.append('</div>\n')
 
-    # use HTML 5 <footer> element?
     def visit_footer(self, node):
         self.context.append(len(self.body))
 
@@ -857,41 +952,41 @@
         self.body_suffix:0 = footer
         del self.bodystart:
 
-    # TODO: use the new HTML5 element <aside> for footnote text
-    # (allows better styling with CSS, the current <dl> list styling
-    # with "float" interferes with sidebars).
     def visit_footnote(self, node):
-        if not self.in_footnote_list:
-            listnode = node.copy()
-            listnode'ids' = 
-            classes = 'footnote ' + self.settings.footnote_references
-            self.body.append(self.starttag(listnode, 'dl', CLASS=classes))
-            # self.body.append('<dl class="%s">\n'%classes)
-            self.in_footnote_list = True
+        # No native HTML element: use <aside> with ARIA role
+        # (html4css1 uses tables).
+        # Wrap groups of footnotes for easier styling.
+        label_style = self.settings.footnote_references  # brackets/superscript
+        if not isinstance(node.previous_sibling(), type(node)):
+            self.body.append(f'<aside class="footnote-list {label_style}">\n')
+        self.body.append(self.starttag(node, 'aside',
+                                       classes=node.tagname, label_style,
+                                       role="doc-footnote"))
 
     def depart_footnote(self, node):
-        self.body.append('</dd>\n')
+        self.body.append('</aside>\n')
         if not isinstance(node.next_node(descend=False, siblings=True),
-                          nodes.footnote):
-            self.body.append('</dl>\n')
-            self.in_footnote_list = False
+                          type(node)):
+            self.body.append('</aside>\n')
 
     def visit_footnote_reference(self, node):
         href = '#' + node'refid'
-        classes = 'footnote-reference ' + self.settings.footnote_references
-        self.body.append(self.starttag(node, 'a', '', #suffix,
-                                       CLASS=classes, href=href))
+        classes = 'footnote-reference', self.settings.footnote_references
+        self.body.append(self.starttag(node, 'a', suffix='', classes=classes,
+                                       role='doc-noteref', href=href))
+        self.body.append('<span class="fn-bracket"></span>')
 
     def depart_footnote_reference(self, node):
+        self.body.append('<span class="fn-bracket"></span>')
         self.body.append('</a>')
 
     # Docutils-generated text: put section numbers in a span for CSS styling:
     def visit_generated(self, node):
         if 'sectnum' in node'classes':
             # get section number (strip trailing no-break-spaces)
-            sectnum = node.astext().rstrip(u' ')
-            self.body.append('<span class="sectnum">%s</span> '
-                                    % self.encode(sectnum))
+            sectnum = node.astext().rstrip(' ')
+            self.body.append('<span class="sectnum">%s </span>'
+                             % self.encode(sectnum))
             # Content already processed:
             raise nodes.SkipNode
 
@@ -920,21 +1015,21 @@
         if 'height' in node:
             atts'height' = node'height'
         if 'scale' in node:
-            if (PIL and not ('width' in node and 'height' in node)
+            if (PIL and ('width' not in node or 'height' not in node)
                 and self.settings.file_insertion_enabled):
                 imagepath = url2pathname(uri)
                 try:
-                    img = PIL.Image.open(
-                            imagepath.encode(sys.getfilesystemencoding()))
-                except (IOError, UnicodeEncodeError):
-                    pass # TODO: warn?
+                    with PIL.Image.open(imagepath) as img:
+                        imgsize = img.size
+                except (OSError, UnicodeEncodeError):
+                    pass  # TODO: warn?
                 else:
                     self.settings.record_dependencies.add(
                         imagepath.replace('\\', '/'))
                     if 'width' not in atts:
-                        atts'width' = '%dpx' % img.size0
+                        atts'width' = '%dpx' % imgsize0
                     if 'height' not in atts:
-                        atts'height' = '%dpx' % img.size1
+                        atts'height' = '%dpx' % imgsize1
                     del img
             for att_name in 'width', 'height':
                 if att_name in atts:
@@ -953,9 +1048,9 @@
                 del attsatt_name
         if style:
             atts'style' = ' '.join(style)
-        if (isinstance(node.parent, nodes.TextElement) or
-            (isinstance(node.parent, nodes.reference) and
-             not isinstance(node.parent.parent, nodes.TextElement))):
+        if (isinstance(node.parent, nodes.TextElement)
+            or (isinstance(node.parent, nodes.reference)
+                and not isinstance(node.parent.parent, nodes.TextElement))):
             # Inline context or surrounded by <a>...</a>.
             suffix = ''
         else:
@@ -963,29 +1058,23 @@
         if 'align' in node:
             atts'class' = 'align-%s' % node'align'
         # Embed image file (embedded SVG or data URI):
-        if self.settings.embed_images or ('embed' in node):
-            err_msg = ''
-            if not mimetype:
-                err_msg = 'unknown MIME type'
-            if not self.settings.file_insertion_enabled:
-                err_msg = 'file insertion disabled.'
+        if self.image_loading == 'embed':
             try:
                 with open(url2pathname(uri), 'rb') as imagefile:
                     imagedata = imagefile.read()
-            except IOError as err:
-                err_msg = err.strerror
-            if err_msg:
+            except OSError as err:
                 self.document.reporter.error('Cannot embed image %r: %s'
-                                             %(uri, err_msg))
+                                             % (uri, err.strerror))
             else:
-                self.settings.record_dependencies.add(
-                                            uri.replace('\\', '/'))
+                self.settings.record_dependencies.add(unquote_url(uri))
                 # TODO: insert SVG as-is?
                 # if mimetype == 'image/svg+xml':
-                  # read/parse, apply arguments,
-                  # insert as <svg ....> ... </svg> # (about 1/3 less data)
+                # read/parse, apply arguments,
+                # insert as <svg ....> ... </svg> # (about 1/3 less data)
                 data64 = base64.b64encode(imagedata).decode()
-                uri = u'data:%s;base64,%s' % (mimetype, data64)
+                uri = 'data:%s;base64,%s' % (mimetype, data64)
+        elif self.image_loading == 'lazy':
+            atts'loading' = 'lazy'
         if mimetype == 'application/x-shockwave-flash':
             atts'type' = mimetype
             # do NOT use an empty tag: incorrect rendering in browsers
@@ -1007,32 +1096,27 @@
 
     # footnote and citation labels:
     def visit_label(self, node):
-        if (isinstance(node.parent, nodes.footnote)):
-            classes = self.settings.footnote_references
-        else:
-            classes = 'brackets'
-        # pass parent node to get id into starttag:
-        self.body.append(self.starttag(node.parent, 'dt', '', CLASS='label'))
-        self.body.append(self.starttag(node, 'span', '', CLASS=classes))
+        self.body.append('<span class="label">')
+        self.body.append('<span class="fn-bracket"></span>')
         # footnote/citation backrefs:
         if self.settings.footnote_backlinks:
-            backrefs = node.parent'backrefs'
+            backrefs = node.parent.get('backrefs', )
             if len(backrefs) == 1:
-                self.body.append('<a class="fn-backref" href="#%s">'
-                                 % backrefs0)
+                self.body.append('<a role="doc-backlink"'
+                                 ' href="#%s">' % backrefs0)
 
     def depart_label(self, node):
+        backrefs = 
         if self.settings.footnote_backlinks:
-            backrefs = node.parent'backrefs'
-            if len(backrefs) == 1:
-                self.body.append('</a>')
-        self.body.append('</span>')
-        if self.settings.footnote_backlinks and len(backrefs) > 1:
-            backlinks = '<a href="#%s">%s</a>' % (ref, i)
-                            for (i, ref) in enumerate(backrefs, 1)
-            self.body.append('<span class="fn-backref">(%s)</span>'
-                                % ','.join(backlinks))
-        self.body.append('</dt>\n<dd>')
+            backrefs = node.parent.get('backrefs', backrefs)
+        if len(backrefs) == 1:
+            self.body.append('</a>')
+        self.body.append('<span class="fn-bracket"></span></span>\n')
+        if len(backrefs) > 1:
+            backlinks = '<a role="doc-backlink" href="#%s">%s</a>' % (ref, i)
+                         for (i, ref) in enumerate(backrefs, 1)
+            self.body.append('<span class="backrefs">(%s)</span>\n'
+                             % ','.join(backlinks))
 
     def visit_legend(self, node):
         self.body.append(self.starttag(node, 'div', CLASS='legend'))
@@ -1063,16 +1147,15 @@
     # inline literal
     def visit_literal(self, node):
         # special case: "code" role
-        classes = node.get('classes', )
+        classes = node'classes'
         if 'code' in classes:
             # filter 'code' from class arguments
-            node'classes' = cls for cls in classes if cls != 'code'
+            classes.pop(classes.index('code'))
             self.body.append(self.starttag(node, 'code', ''))
             return
         self.body.append(
             self.starttag(node, 'span', '', CLASS='docutils literal'))
         text = node.astext()
-        # remove hard line breaks (except if in a parsed-literal block)
         if not isinstance(node.parent, nodes.literal_block):
             text = text.replace('\n', ' ')
         # Protect text like ``--an-option`` and the regular expression
@@ -1080,12 +1163,11 @@
         for token in self.words_and_spaces.findall(text):
             if token.strip() and self.in_word_wrap_point.search(token):
                 self.body.append('<span class="pre">%s</span>'
-                                    % self.encode(token))
+                                 % self.encode(token))
             else:
                 self.body.append(self.encode(token))
         self.body.append('</span>')
-        # Content already processed:
-        raise nodes.SkipNode
+        raise nodes.SkipNode  # content already processed
 
     def depart_literal(self, node):
         # skipped unless literal element is from "code" role:
@@ -1093,11 +1175,11 @@
 
     def visit_literal_block(self, node):
         self.body.append(self.starttag(node, 'pre', '', CLASS='literal-block'))
-        if 'code' in node.get('classes', ):
+        if 'code' in node'classes':
             self.body.append('<code>')
 
     def depart_literal_block(self, node):
-        if 'code' in node.get('classes', ):
+        if 'code' in node'classes':
             self.body.append('</code>')
         self.body.append('</pre>\n')
 
@@ -1106,11 +1188,12 @@
     # for the math-output: LaTeX and MathJax simply wrap the content,
     # HTML and MathML also convert the math_code.
     # HTML container
-    math_tags = {# math_output: (block, inline, class-arguments)
-                 'mathml':      ('div', '', ''),
-                 'html':        ('div', 'span', 'formula'),
-                 'mathjax':     ('div', 'span', 'math'),
-                 'latex':       ('pre', 'tt',   'math'),
+    math_tags = {
+                 # math_output: (block, inline, class-arguments)
+                 'html': ('div', 'span', 'formula'),
+                 'latex': ('pre', 'tt', 'math'),
+                 'mathml': ('div', '', ''),
+                 'mathjax': ('div', 'span', 'math'),
                 }
 
     def visit_math(self, node, math_env=''):
@@ -1118,28 +1201,30 @@
 
         if self.math_output not in self.math_tags:
             self.document.reporter.error(
-                'math-output format "%s" not supported '
-                'falling back to "latex"'% self.math_output)
+                f'math-output format "{self.math_output}" not supported '
+                'falling back to "latex"')
             self.math_output = 'latex'
         tag = self.math_tagsself.math_outputmath_env == ''
         clsarg = self.math_tagsself.math_output2
         # LaTeX container
-        wrappers = {# math_mode: (inline, block)
-                    'mathml':  ('$%s$',   u'\\begin{%s}\n%s\n\\end{%s}'),
-                    'html':    ('$%s$',   u'\\begin{%s}\n%s\n\\end{%s}'),
-                    'mathjax': (r'$%s$', u'\\begin{%s}\n%s\n\\end{%s}'),
-                    'latex':   (None,     None),
+        wrappers = {
+                    # math_mode: (inline, block)
+                    'html': ('$%s$', '\\begin{%s}\n%s\n\\end{%s}'),
+                    'latex': (None, None),
+                    'mathml': ('$%s$', '\\begin{%s}\n%s\n\\end{%s}'),
+                    'mathjax': (r'$%s$', '\\begin{%s}\n%s\n\\end{%s}'),
                    }
         wrapper = wrappersself.math_outputmath_env != ''
-        if self.math_output == 'mathml' and (not self.math_output_options or
-                                self.math_output_options0 == 'blahtexml'):
+        if (self.math_output == 'mathml'
+            and (not self.math_output_options
+                 or self.math_output_options0 == 'blahtexml')):
             wrapper = None
         # get and wrap content
         math_code = node.astext().translate(unichar2tex.uni2tex_table)
         if wrapper:
-            try: # wrapper with three "%s"
+            try:  # wrapper with three "%s"
                 math_code = wrapper % (math_env, math_code, math_env)
-            except TypeError: # wrapper with one "%s"
+            except TypeError:  # wrapper with one "%s"
                 math_code = wrapper % math_code
         # settings and conversion
         if self.math_output in ('latex', 'mathjax'):
@@ -1149,7 +1234,8 @@
                 self.mathjax_url = self.math_output_options0
             except IndexError:
                 self.document.reporter.warning('No MathJax URL specified, '
-                    'using local fallback (see config.html)')
+                                               'using local fallback '
+                                               '(see config.html)')
             # append configuration, if not already present in the URL:
             # input LaTeX with AMS, output common HTML
             if '?' not in self.mathjax_url:
@@ -1158,40 +1244,46 @@
         elif self.math_output == 'html':
             if self.math_output_options and not self.math_header:
                 self.math_header = self.stylesheet_call(
-                    utils.find_file_in_dirs(s, self.settings.stylesheet_dirs))
+                    utils.find_file_in_dirs(s, self.settings.stylesheet_dirs),
+                    adjust_path=True)
                     for s in self.math_output_options0.split(',')
             # TODO: fix display mode in matrices and fractions
             math2html.DocumentParameters.displaymode = (math_env != '')
             math_code = math2html.math2html(math_code)
         elif self.math_output == 'mathml':
-            if  'XHTML 1' in self.doctype:
+            if 'XHTML 1' in self.doctype:
                 self.doctype = self.doctype_mathml
                 self.content_type = self.content_type_mathml
             converter = ' '.join(self.math_output_options).lower()
             try:
                 if converter == 'latexml':
-                    math_code = tex2mathml_extern.latexml(math_code,
-                                                    self.document.reporter)
+                    math_code = tex2mathml_extern.latexml(
+                                    math_code, self.document.reporter)
                 elif converter == 'ttm':
-                    math_code = tex2mathml_extern.ttm(math_code,
-                                                    self.document.reporter)
+                    math_code = tex2mathml_extern.ttm(
+                                    math_code, self.document.reporter)
                 elif converter == 'blahtexml':
-                    math_code = tex2mathml_extern.blahtexml(math_code,
-                        inline=not(math_env),
-                        reporter=self.document.reporter)
+                    math_code = tex2mathml_extern.blahtexml(
+                                    math_code,
+                                    inline=(not math_env),
+                                    reporter=self.document.reporter)
+                elif converter == 'pandoc':
+                    math_code = tex2mathml_extern.pandoc(
+                                    math_code,
+                                    reporter=self.document.reporter)
                 elif not converter:
-                    math_code = latex2mathml.tex2mathml(math_code,
-                                                        inline=not(math_env))
+                    math_code = latex2mathml.tex2mathml(
+                                    math_code, inline=(not math_env))
                 else:
                     self.document.reporter.error('option "%s" not supported '
-                    'with math-output "MathML"')
+                                                 'with math-output "MathML"')
             except OSError:
-                    raise OSError('is "latexmlmath" in your PATH?')
+                raise OSError('is "latexmlmath" in your PATH?')
             except SyntaxError as err:
                 err_node = self.document.reporter.error(err, base_node=node)
                 self.visit_system_message(err_node)
                 self.body.append(self.starttag(node, 'p'))
-                self.body.append(u','.join(err.args))
+                self.body.append(','.join(err.args))
                 self.body.append('</p>\n')
                 self.body.append(self.starttag(node, 'pre',
                                                CLASS='literal-block'))
@@ -1205,7 +1297,7 @@
                                            suffix='\n'*bool(math_env),
                                            CLASS=clsarg))
         self.body.append(math_code)
-        if math_env: # block mode (equation, display)
+        if math_env:  # block mode (equation, display)
             self.body.append('\n')
         if tag:
             self.body.append('</%s>' % tag)
@@ -1215,28 +1307,24 @@
         raise nodes.SkipNode
 
     def depart_math(self, node):
-        pass # never reached
+        pass  # never reached
 
     def visit_math_block(self, node):
         math_env = pick_math_environment(node.astext())
         self.visit_math(node, math_env=math_env)
 
     def depart_math_block(self, node):
-        pass # never reached
+        pass  # never reached
 
     # Meta tags: 'lang' attribute replaced by 'xml:lang' in XHTML 1.1
     # HTML5/polyglot recommends using both
     def visit_meta(self, node):
-        meta = self.emptytag(node, 'meta', **node.non_default_attributes())
-        self.add_meta(meta)
+        self.meta.append(self.emptytag(node, 'meta',
+                                       **node.non_default_attributes()))
 
     def depart_meta(self, node):
         pass
 
-    def add_meta(self, tag):
-        self.meta.append(tag)
-        self.head.append(tag)
-
     def visit_option(self, node):
         self.body.append(self.starttag(node, 'span', '', CLASS='option'))
 
@@ -1290,9 +1378,9 @@
     #
     # The HTML4CSS1 writer does this to "produce
     # visually compact lists (less vertical whitespace)". This writer
-    # relies on CSS rules for"visual compactness".
+    # relies on CSS rules for visual compactness.
     #
-    # * In XHTML 1.1, e.g. a <blockquote> element may not contain
+    # * In XHTML 1.1, e.g., a <blockquote> element may not contain
     #   character data, so you cannot drop the <p> tags.
     # * Keeping simple paragraphs in the field_body enables a CSS
     #   rule to start the field-body on a new line if the label is too long
@@ -1305,8 +1393,8 @@
 
     def depart_paragraph(self, node):
         self.body.append('</p>')
-        if not (isinstance(node.parent, (nodes.list_item, nodes.entry)) and
-                (len(node.parent) == 1)):
+        if not (isinstance(node.parent, (nodes.list_item, nodes.entry))
+                and (len(node.parent) == 1)):
             self.body.append('\n')
 
     def visit_problematic(self, node):
@@ -1323,12 +1411,15 @@
 
     def visit_raw(self, node):
         if 'html' in node.get('format', '').split():
-            t = isinstance(node.parent, nodes.TextElement) and 'span' or 'div'
+            if isinstance(node.parent, nodes.TextElement):
+                tagname = 'span'
+            else:
+                tagname = 'div'
             if node'classes':
-                self.body.append(self.starttag(node, t, suffix=''))
+                self.body.append(self.starttag(node, tagname, suffix=''))
             self.body.append(node.astext())
             if node'classes':
-                self.body.append('</%s>' % t)
+                self.body.append('</%s>' % tagname)
         # Keep non-HTML raw text out of output:
         raise nodes.SkipNode
 
@@ -1336,8 +1427,8 @@
         atts = {'class': 'reference'}
         if 'refuri' in node:
             atts'href' = node'refuri'
-            if ( self.settings.cloak_email_addresses
-                 and atts'href'.startswith('mailto:')):
+            if (self.settings.cloak_email_addresses
+                and atts'href'.startswith('mailto:')):
                 atts'href' = self.cloak_mailto(atts'href')
                 self.in_mailto = True
             atts'class' += ' external'
@@ -1425,16 +1516,16 @@
     # h1–h6 elements must not be used to markup subheadings, subtitles,
     # alternative titles and taglines unless intended to be the heading for a
     # new section or subsection.
-    # -- http://www.w3.org/TR/html/sections.html#headings-and-sections
+    # -- http://www.w3.org/TR/html51/sections.html#headings-and-sections
     def visit_subtitle(self, node):
         if isinstance(node.parent, nodes.sidebar):
-            classes = 'sidebar-subtitle'
+            classes = 'sidebar-subtitle'
         elif isinstance(node.parent, nodes.document):
-            classes = 'subtitle'
-            self.in_document_title = len(self.body)+1
+            classes = 'subtitle'
+            self.in_document_title = len(self.body) + 1
         elif isinstance(node.parent, nodes.section):
-            classes = 'section-subtitle'
-        self.body.append(self.starttag(node, 'p', '', CLASS=classes))
+            classes = 'section-subtitle'
+        self.body.append(self.starttag(node, 'p', '', classes=classes))
 
     def depart_subtitle(self, node):
         self.body.append('</p>\n')
@@ -1452,7 +1543,7 @@
         self.body.append('</sup>')
 
     def visit_system_message(self, node):
-        self.body.append(self.starttag(node, 'div', CLASS='system-message'))
+        self.body.append(self.starttag(node, 'aside', CLASS='system-message'))
         self.body.append('<p class="system-message-title">')
         backref_text = ''
         if len(node'backrefs'):
@@ -1478,25 +1569,24 @@
                             self.encode(node'source'), line, backref_text))
 
     def depart_system_message(self, node):
-        self.body.append('</div>\n')
+        self.body.append('</aside>\n')
 
     def visit_table(self, node):
-        atts = {}
-        classes = cls.strip(u' \t\n')
-                   for cls in self.settings.table_style.split(',')
+        atts = {'classes': self.settings.table_style.replace(',', ' ').split()}
         if 'align' in node:
-            classes.append('align-%s' % node'align')
+            atts'classes'.append('align-%s' % node'align')
         if 'width' in node:
-            atts'style' = 'width: %s' % node'width'
-        tag = self.starttag(node, 'table', CLASS=' '.join(classes), **atts)
+            atts'style' = 'width: %s;' % node'width'
+        tag = self.starttag(node, 'table', **atts)
         self.body.append(tag)
 
     def depart_table(self, node):
         self.body.append('</table>\n')
 
     def visit_target(self, node):
-        if not ('refuri' in node or 'refid' in node
-                or 'refname' in node):
+        if ('refuri' not in node
+                and 'refid' not in node
+                and 'refname' not in node):
             self.body.append(self.starttag(node, 'span', '', CLASS='target'))
             self.context.append('</span>')
         else:
@@ -1513,13 +1603,17 @@
         self.body.append('</tbody>\n')
 
     def visit_term(self, node):
-        self.body.append(self.starttag(node, 'dt', ''))
+        if 'details' in node.parent.parent'classes':
+            self.body.append(self.starttag(node, 'summary', suffix=''))
+        else:
+            # The parent node (definition_list_item) is omitted in HTML.
+            self.body.append(self.starttag(node, 'dt', suffix='',
+                                           classes=node.parent'classes',
+                                           ids=node.parent'ids'))
 
     def depart_term(self, node):
-        """
-        Leave the end tag to `self.visit_definition()`, in case there's a
-        classifier.
-        """
+        # Leave the end tag to `self.visit_definition()`,
+        # in case there's a classifier.
         pass
 
     def visit_tgroup(self, node):
@@ -1535,15 +1629,35 @@
     def depart_thead(self, node):
         self.body.append('</thead>\n')
 
+    def section_title_tags(self, node):
+        atts = {}
+        h_level = self.section_level + self.initial_header_level - 1
+        # Only 6 heading levels have dedicated HTML tags.
+        tagname = 'h%i' % min(h_level, 6)
+        if h_level > 6:
+            atts'aria-level' = h_level
+        start_tag = self.starttag(node, tagname, '', **atts)
+        if node.hasattr('refid'):
+            atts = {}
+            atts'class' = 'toc-backref'
+            atts'role' = 'doc-backlink'  # HTML5 only
+            atts'href' = '#' + node'refid'
+            start_tag += self.starttag(nodes.reference(), 'a', '', **atts)
+            close_tag = '</a></%s>\n' % tagname
+        else:
+            close_tag = '</%s>\n' % tagname
+        return start_tag, close_tag
+
     def visit_title(self, node):
-        """Only 6 section levels are supported by HTML."""
         close_tag = '</p>\n'
         if isinstance(node.parent, nodes.topic):
+            # TODO: use role="heading" or <h1>? (HTML5 only)
             self.body.append(
-                  self.starttag(node, 'p', '', CLASS='topic-title'))
+                self.starttag(node, 'p', '', CLASS='topic-title'))
         elif isinstance(node.parent, nodes.sidebar):
+            # TODO: use role="heading" or <h1>? (HTML5 only)
             self.body.append(
-                  self.starttag(node, 'p', '', CLASS='sidebar-title'))
+                self.starttag(node, 'p', '', CLASS='sidebar-title'))
         elif isinstance(node.parent, nodes.Admonition):
             self.body.append(
                   self.starttag(node, 'p', '', CLASS='admonition-title'))
@@ -1557,22 +1671,9 @@
             self.in_document_title = len(self.body)
         else:
             assert isinstance(node.parent, nodes.section)
-            h_level = self.section_level + self.initial_header_level - 1
-            atts = {}
-            if (len(node.parent) >= 2 and
-                isinstance(node.parent1, nodes.subtitle)):
-                atts'CLASS' = 'with-subtitle'
-            self.body.append(
-                  self.starttag(node, 'h%s' % h_level, '', **atts))
-            atts = {}
-            if node.hasattr('refid'):
-                atts'class' = 'toc-backref'
-                atts'href' = '#' + node'refid'
-            if atts:
-                self.body.append(self.starttag({}, 'a', '', **atts))
-                close_tag = '</a></h%s>\n' % (h_level)
-            else:
-                close_tag = '</h%s>\n' % (h_level)
+            # Get correct heading and evt. backlink tags
+            start_tag, close_tag = self.section_title_tags(node)
+            self.body.append(start_tag)
         self.context.append(close_tag)
 
     def depart_title(self, node):
@@ -1592,11 +1693,9 @@
 
     def visit_topic(self, node):
         self.body.append(self.starttag(node, 'div', CLASS='topic'))
-        self.topic_classes = node'classes'
 
     def depart_topic(self, node):
         self.body.append('</div>\n')
-        self.topic_classes = 
 
     def visit_transition(self, node):
         self.body.append(self.emptytag(node, 'hr', CLASS='docutils'))
@@ -1633,9 +1732,9 @@
         children = child for child in node.children
                     if not isinstance(child, nodes.Invisible)
         if (children and isinstance(children0, nodes.paragraph)
-            and (isinstance(children-1, nodes.bullet_list) or
-                 isinstance(children-1, nodes.enumerated_list) or
-                 isinstance(children-1, nodes.field_list))):
+            and (isinstance(children-1, nodes.bullet_list)
+                 or isinstance(children-1, nodes.enumerated_list)
+                 or isinstance(children-1, nodes.field_list))):
             children.pop()
         if len(children) <= 1:
             return

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/docutils_xml.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/docutils_xml.py Changed

@@ -1,32 +1,24 @@
-# $Id: docutils_xml.py 8368 2019-08-27 12:10:14Z milde $
+# $Id: docutils_xml.py 9239 2022-11-13 16:14:59Z milde $
 # Author: David Goodger, Paul Tremblay, Guenter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
 
 """
 Simple document tree Writer, writes Docutils XML according to
-http://docutils.sourceforge.net/docs/ref/docutils.dtd.
+https://docutils.sourceforge.io/docs/ref/docutils.dtd.
 """
 
 __docformat__ = 'reStructuredText'
 
-import sys
+from io import StringIO
 import xml.sax.saxutils
 
 import docutils
-from docutils import frontend, writers, nodes
+from docutils import frontend, nodes, writers, utils
 
-if sys.version_info >= (3, 0):
-    from io import StringIO  # noqa
-else:
-    from StringIO import StringIO  # noqa
 
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
-class RawXmlError(docutils.ApplicationError): pass
+class RawXmlError(docutils.ApplicationError):
+    pass
 
 
 class Writer(writers.Writer):
@@ -41,7 +33,7 @@
           '--newlines',
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
          ('Generate XML with indents and newlines.',
-          '--indents', #@ TODO use integer value for number of spaces?
+          '--indents',  # TODO use integer value for number of spaces?
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
          ('Omit the XML declaration.  Use with caution.',
           '--no-xml-declaration',
@@ -72,9 +64,8 @@
 
 class XMLTranslator(nodes.GenericNodeVisitor):
 
-    xml_declaration = '<?xml version="1.0" encoding="%s"?>\n'
     # TODO: add stylesheet options similar to HTML and LaTeX writers?
-    #xml_stylesheet = '<?xml-stylesheet type="text/xsl" href="%s"?>\n'
+    # xml_stylesheet = '<?xml-stylesheet type="text/xsl" href="%s"?>\n'
     doctype = (
         '<!DOCTYPE document PUBLIC'
         ' "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML"'
@@ -82,7 +73,7 @@
     generator = '\n'
 
     xmlparser = xml.sax.make_parser()
-    """SAX parser instance to check/exctract raw XML."""
+    """SAX parser instance to check/extract raw XML."""
     xmlparser.setFeature(
         "http://xml.org/sax/features/external-general-entities", True)
 
@@ -100,29 +91,28 @@
             self.newline = '\n'
         if settings.indents:
             self.newline = '\n'
-            self.indent = '    ' #@ TODO make this configurable?
-        self.level = 0  # indentation level
-        self.in_simple = 0 # level of nesting inside mixed-content elements
-        self.fixed_text = 0 # level of nesting inside FixedText elements
+            self.indent = '    '  # TODO make this configurable?
+        self.level = 0       # indentation level
+        self.in_simple = 0   # level of nesting inside mixed-content elements
+        self.fixed_text = 0  # level of nesting inside FixedText elements
 
         # Output
         self.output = 
         if settings.xml_declaration:
-            self.output.append(
-                self.xml_declaration % settings.output_encoding)
+            self.output.append(utils.xml_declaration(settings.output_encoding))
         if settings.doctype_declaration:
             self.output.append(self.doctype)
         self.output.append(self.generator % docutils.__version__)
 
         # initialize XML parser
-        self.the_handle=TestXml()
+        self.the_handle = TestXml()
         self.xmlparser.setContentHandler(self.the_handle)
 
     # generic visit and depart methods
     # --------------------------------
 
     simple_nodes = (nodes.TextElement,
-                    nodes.image, nodes.colspec, nodes.transition) # empty elements
+                    nodes.image, nodes.colspec, nodes.transition)
 
     def default_visit(self, node):
         """Default node visit method."""
@@ -151,7 +141,6 @@
         if not self.in_simple:
             self.output.append(self.newline)
 
-
     # specific visit and depart methods
     # ---------------------------------
 
@@ -177,20 +166,18 @@
         self.output.append(xml_string)
         self.default_departure(node)  # or not?
         # Check validity of raw XML:
-        if isinstance(xml_string, unicode) and sys.version_info < (3, 0):
-            xml_string = xml_string.encode('utf8')
         try:
             self.xmlparser.parse(StringIO(xml_string))
-        except xml.sax._exceptions.SAXParseException as error:
+        except xml.sax._exceptions.SAXParseException:
             col_num = self.the_handle.locator.getColumnNumber()
-            line_num =  self.the_handle.locator.getLineNumber()
+            line_num = self.the_handle.locator.getLineNumber()
             srcline = node.line
             if not isinstance(node.parent, nodes.TextElement):
-                srcline += 2 # directive content start line
+                srcline += 2  # directive content start line
             msg = 'Invalid raw XML in column %d, line offset %d:\n%s' % (
                    col_num, line_num, node.astext())
             self.warn(msg, source=node.source, line=srcline+line_num-1)
-        raise nodes.SkipNode # content already processed
+        raise nodes.SkipNode  # content already processed
 
 
 class TestXml(xml.sax.handler.ContentHandler):

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html4css1/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html4css1/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8638 2021-03-20 23:47:07Z milde $
+# $Id: __init__.py 9282 2022-11-28 23:55:46Z milde $
 # Author: David Goodger
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -16,13 +16,12 @@
 
 import os.path
 import re
-import sys
-import docutils
-from docutils import frontend, nodes, writers, io
-from docutils.transforms import writer_aux
+
+from docutils import frontend, nodes, writers
 from docutils.writers import _html_base
 from docutils.writers._html_base import PIL, url2pathname
 
+
 class Writer(writers._html_base.Writer):
 
     supported = ('html', 'html4', 'html4css1', 'xhtml', 'xhtml10')
@@ -30,59 +29,55 @@
 
     default_stylesheets = 'html4css1.css'
     default_stylesheet_dirs = '.',
-        os.path.abspath(os.path.dirname(__file__)),
-        # for math.css
-        os.path.abspath(os.path.join(
-            os.path.dirname(os.path.dirname(__file__)), 'html5_polyglot'))
-       
-
-    default_template = 'template.txt'
-    default_template_path = os.path.join(
-        os.path.dirname(os.path.abspath(__file__)), default_template)
-
-    settings_spec = (
-        'HTML-Specific Options',
-        None,
-        (('Specify the template file (UTF-8 encoded).  Default is "%s".'
-          % default_template_path,
-          '--template',
-          {'default': default_template_path, 'metavar': '<file>'}),
-         ('Comma separated list of stylesheet URLs. '
-          'Overrides previous --stylesheet and --stylesheet-path settings.',
-          '--stylesheet',
-          {'metavar': '<URL,URL,...>', 'overrides': 'stylesheet_path',
-           'validator': frontend.validate_comma_separated_list}),
-         ('Comma separated list of stylesheet paths. '
-          'Relative paths are expanded if a matching file is found in '
-          'the --stylesheet-dirs. With --link-stylesheet, '
-          'the path is rewritten relative to the output HTML file. '
-          'Default: "%s"' % ','.join(default_stylesheets),
-          '--stylesheet-path',
-          {'metavar': '<file,file,...>', 'overrides': 'stylesheet',
-           'validator': frontend.validate_comma_separated_list,
-           'default': default_stylesheets}),
-         ('Embed the stylesheet(s) in the output HTML file.  The stylesheet '
-          'files must be accessible during processing. This is the default.',
-          '--embed-stylesheet',
-          {'default': 1, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Link to the stylesheet(s) in the output HTML file. '
-          'Default: embed stylesheets.',
-          '--link-stylesheet',
-          {'dest': 'embed_stylesheet', 'action': 'store_false'}),
-         ('Comma-separated list of directories where stylesheets are found. '
-          'Used by --stylesheet-path when expanding relative path arguments. '
-          'Default: "%s"' % default_stylesheet_dirs,
-          '--stylesheet-dirs',
-          {'metavar': '<dir,dir,...>',
-           'validator': frontend.validate_comma_separated_list,
-           'default': default_stylesheet_dirs}),
-         ('Specify the initial header level.  Default is 1 for "<h1>".  '
-          'Does not affect document title & subtitle (see --no-doc-title).',
-          '--initial-header-level',
-          {'choices': '1 2 3 4 5 6'.split(), 'default': '1',
-           'metavar': '<level>'}),
-         ('Specify the maximum width (in characters) for one-column field '
+                               os.path.abspath(os.path.dirname(__file__)),
+                               os.path.abspath(os.path.join(
+                                   os.path.dirname(os.path.dirname(__file__)),
+                                   'html5_polyglot'))  # for math.css
+                               
+    default_template = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), 'template.txt')
+
+    # use a copy of the parent spec with some modifications
+    settings_spec = frontend.filter_settings_spec(
+        writers._html_base.Writer.settings_spec,
+        template=(
+            'Template file. (UTF-8 encoded, default: "%s")' % default_template,
+            '--template',
+            {'default': default_template, 'metavar': '<file>'}),
+        stylesheet_path=(
+            'Comma separated list of stylesheet paths. '
+            'Relative paths are expanded if a matching file is found in '
+            'the --stylesheet-dirs. With --link-stylesheet, '
+            'the path is rewritten relative to the output HTML file. '
+            '(default: "%s")' % ','.join(default_stylesheets),
+            '--stylesheet-path',
+            {'metavar': '<file,file,...>', 'overrides': 'stylesheet',
+             'validator': frontend.validate_comma_separated_list,
+             'default': default_stylesheets}),
+        stylesheet_dirs=(
+            'Comma-separated list of directories where stylesheets are found. '
+            'Used by --stylesheet-path when expanding relative path '
+            'arguments. (default: "%s")' % ','.join(default_stylesheet_dirs),
+            '--stylesheet-dirs',
+            {'metavar': '<dir,dir,...>',
+             'validator': frontend.validate_comma_separated_list,
+             'default': default_stylesheet_dirs}),
+        initial_header_level=(
+            'Specify the initial header level. Does not affect document '
+            'title & subtitle (see --no-doc-title). (default: 1 for "<h1>")',
+            '--initial-header-level',
+            {'choices': '1 2 3 4 5 6'.split(), 'default': '1',
+             'metavar': '<level>'}),
+        xml_declaration=(
+            'Prepend an XML declaration (default). ',
+            '--xml-declaration',
+            {'default': True, 'action': 'store_true',
+             'validator': frontend.validate_boolean}),
+        )
+    settings_spec = settings_spec + (
+        'HTML4 Writer Options',
+        '',
+        (('Specify the maximum width (in characters) for one-column field '
           'names.  Longer field names will span an entire row of the table '
           'used to render the field list.  Default is 14 characters.  '
           'Use 0 for "no limit".',
@@ -96,58 +91,8 @@
           '--option-limit',
           {'default': 14, 'metavar': '<level>',
            'validator': frontend.validate_nonnegative_int}),
-         ('Format for footnote references: one of "superscript" or '
-          '"brackets".  Default is "brackets".',
-          '--footnote-references',
-          {'choices': 'superscript', 'brackets', 'default': 'brackets',
-           'metavar': '<format>',
-           'overrides': 'trim_footnote_reference_space'}),
-         ('Format for block quote attributions: one of "dash" (em-dash '
-          'prefix), "parentheses"/"parens", or "none".  Default is "dash".',
-          '--attribution',
-          {'choices': 'dash', 'parentheses', 'parens', 'none',
-           'default': 'dash', 'metavar': '<format>'}),
-         ('Remove extra vertical whitespace between items of "simple" bullet '
-          'lists and enumerated lists.  Default: enabled.',
-          '--compact-lists',
-          {'default': 1, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Disable compact simple bullet and enumerated lists.',
-          '--no-compact-lists',
-          {'dest': 'compact_lists', 'action': 'store_false'}),
-         ('Remove extra vertical whitespace between items of simple field '
-          'lists.  Default: enabled.',
-          '--compact-field-lists',
-          {'default': 1, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Disable compact simple field lists.',
-          '--no-compact-field-lists',
-          {'dest': 'compact_field_lists', 'action': 'store_false'}),
-         ('Embed images in the output HTML file, if the image '
-          'files are accessible during processing.',
-          '--embed-images',
-          {'default': 0, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Link to images in the output HTML file. '
-          'This is the default.',
-          '--link-images',
-          {'dest': 'embed_images', 'action': 'store_false'}),
-         ('Added to standard table classes. '
-          'Defined styles: "borderless". Default: ""',
-          '--table-style',
-          {'default': ''}),
-         ('Math output format, one of "MathML", "HTML", "MathJax" '
-          'or "LaTeX". Default: "HTML math.css"',
-          '--math-output',
-          {'default': 'HTML math.css'}),
-         ('Omit the XML declaration.  Use with caution.',
-          '--no-xml-declaration',
-          {'dest': 'xml_declaration', 'default': 1, 'action': 'store_false',
-           'validator': frontend.validate_boolean}),
-         ('Obfuscate email addresses to confuse harvesters while still '
-          'keeping email links usable with standards-compliant browsers.',
-          '--cloak-email-addresses',
-          {'action': 'store_true', 'validator': frontend.validate_boolean}),))
+         )
+        )
 
     config_section = 'html4css1 writer'
 
@@ -212,8 +157,8 @@
                            ' content="application/xhtml+xml; charset=%s" />\n')
 
     # encode also non-breaking space
-    special_characters = dict(_html_base.HTMLTranslator.special_characters)
-    special_characters0xa0 = u'&nbsp;'
+    special_characters = _html_base.HTMLTranslator.special_characters.copy()
+    special_characters0xa0 = '&nbsp;'
 
     # use character reference for dash (not valid in HTML5)
     attribution_formats = {'dash': ('&mdash;', ''),
@@ -231,6 +176,9 @@
         self.visit_docinfo_item(node, 'address', meta=False)
         self.body.append(self.starttag(node, 'pre', CLASS='address'))
 
+    def depart_address(self, node):
+        self.body.append('\n</pre>\n')
+        self.depart_docinfo_item()
 
     # ersatz for first/last pseudo-classes
     def visit_admonition(self, node):
@@ -238,6 +186,9 @@
         self.body.append(self.starttag(node, 'div'))
         self.set_first_last(node)
 
+    def depart_admonition(self, node=None):
+        self.body.append('</div>\n')
+
     # author, authors: use <br> instead of paragraphs
     def visit_author(self, node):
         if isinstance(node.parent, nodes.authors):
@@ -259,20 +210,20 @@
     def depart_authors(self, node):
         self.depart_docinfo_item()
 
-    # use "width" argument insted of "style: 'width'":
+    # use "width" argument instead of "style: 'width'":
     def visit_colspec(self, node):
         self.colspecs.append(node)
         # "stubs" list is an attribute of the tgroup element:
         node.parent.stubs.append(node.attributes.get('stub'))
-    #
+
     def depart_colspec(self, node):
         # write out <colgroup> when all colspecs are processed
         if isinstance(node.next_node(descend=False, siblings=True),
                       nodes.colspec):
             return
-        if 'colwidths-auto' in node.parent.parent'classes' or (
-            'colwidths-auto' in self.settings.table_style and
-            ('colwidths-given' not in node.parent.parent'classes')):
+        if ('colwidths-auto' in node.parent.parent'classes'
+            or ('colwidths-auto' in self.settings.table_style
+                and 'colwidths-given' not in node.parent.parent'classes')):
             return
         total_width = sum(node'colwidth' for node in self.colspecs)
         self.body.append(self.starttag(node, 'colgroup'))
@@ -290,7 +241,7 @@
                 or (self.settings.compact_lists
                     and 'open' not in node'classes'
                     and (self.compact_simple
-                         or self.topic_classes == 'contents'
+                         or 'contents' in node.parent'classes'
                          # TODO: self.in_contents
                          or self.check_simple_list(node))))
 
@@ -308,21 +259,61 @@
         self.body.append('</td></tr>\n'
                          '</tbody>\n</table>\n')
 
+    def visit_citation_reference(self, node):
+        href = '#'
+        if 'refid' in node:
+            href += node'refid'
+        elif 'refname' in node:
+            href += self.document.nameidsnode'refname'
+        self.body.append(self.starttag(node, 'a', suffix='', href=href,
+                                       classes='citation-reference'))
+
+    def depart_citation_reference(self, node):
+        self.body.append('</a>')
+
     # insert classifier-delimiter (not required with CSS2)
     def visit_classifier(self, node):
         self.body.append(' <span class="classifier-delimiter">:</span> ')
         self.body.append(self.starttag(node, 'span', '', CLASS='classifier'))
 
+    def depart_classifier(self, node):
+        self.body.append('</span>')
+
     # ersatz for first/last pseudo-classes
+    def visit_compound(self, node):
+        self.body.append(self.starttag(node, 'div', CLASS='compound'))
+        if len(node) > 1:
+            node0'classes'.append('compound-first')
+            node-1'classes'.append('compound-last')
+            for child in node1:-1:
+                child'classes'.append('compound-middle')
+
+    def depart_compound(self, node):
+        self.body.append('</div>\n')
+
+    # ersatz for first/last pseudo-classes, no special handling of "details"
     def visit_definition(self, node):
         self.body.append('</dt>\n')
         self.body.append(self.starttag(node, 'dd', ''))
         self.set_first_last(node)
 
-    # don't add "simple" class value
+    def depart_definition(self, node):
+        self.body.append('</dd>\n')
+
+    # don't add "simple" class value, no special handling of "details"
     def visit_definition_list(self, node):
         self.body.append(self.starttag(node, 'dl', CLASS='docutils'))
 
+    def depart_definition_list(self, node):
+        self.body.append('</dl>\n')
+
+    # no special handling of "details"
+    def visit_definition_list_item(self, node):
+        pass
+
+    def depart_definition_list_item(self, node):
+        pass
+
     # use a table for description lists
     def visit_description(self, node):
         self.body.append(self.starttag(node, 'td', ''))
@@ -353,7 +344,7 @@
         if meta:
             meta_tag = '<meta name="%s" content="%s" />\n' \
                        % (name, self.attval(node.astext()))
-            self.add_meta(meta_tag)
+            self.meta.append(meta_tag)
         self.body.append(self.starttag(node, 'tr', ''))
         self.body.append('<th class="docinfo-name">%s:</th>\n<td>'
                          % self.language.labelsname)
@@ -370,6 +361,9 @@
     def visit_doctest_block(self, node):
         self.body.append(self.starttag(node, 'pre', CLASS='doctest-block'))
 
+    def depart_doctest_block(self, node):
+        self.body.append('\n</pre>\n')
+
     # insert an NBSP into empty cells, ersatz for first/last
     def visit_entry(self, node):
         writers._html_base.HTMLTranslator.visit_entry(self, node)
@@ -377,6 +371,9 @@
             self.body.append('&nbsp;')
         self.set_first_last(node)
 
+    def depart_entry(self, node):
+        self.body.append(self.context.pop())
+
     # ersatz for first/last pseudo-classes
     def visit_enumerated_list(self, node):
         """
@@ -413,9 +410,9 @@
         self.body.append(self.starttag(node, 'td', '', CLASS='field-body'))
         self.set_class_on_child(node, 'first', 0)
         field = node.parent
-        if (self.compact_field_list or
-            isinstance(field.parent, nodes.docinfo) or
-            field.parent.index(field) == len(field.parent) - 1):
+        if (self.compact_field_list
+            or isinstance(field.parent, nodes.docinfo)
+            or field.parent.index(field) == len(field.parent) - 1):
             # If we are in a compact list, the docinfo, or if this is
             # the last field of the field list, do not add vertical
             # space after last element.
@@ -438,10 +435,10 @@
                 assert isinstance(field_body, nodes.field_body)
                 children = n for n in field_body
                             if not isinstance(n, nodes.Invisible)
-                if not (len(children) == 0 or
-                        len(children) == 1 and
-                        isinstance(children0,
-                                   (nodes.paragraph, nodes.line_block))):
+                if not (len(children) == 0
+                        or len(children) == 1
+                        and isinstance(children0,
+                                       (nodes.paragraph, nodes.line_block))):
                     self.compact_field_list = False
                     break
         self.body.append(self.starttag(node, 'table', frame='void',
@@ -461,8 +458,8 @@
             atts'class' = 'docinfo-name'
         else:
             atts'class' = 'field-name'
-        if ( self.settings.field_name_limit
-             and len(node.astext()) > self.settings.field_name_limit):
+        if (self.settings.field_name_limit
+            and len(node.astext()) > self.settings.field_name_limit):
             atts'colspan' = 2
             self.context.append('</tr>\n'
                                 + self.starttag(node.parent, 'tr', '',
@@ -516,7 +513,7 @@
         self.body.append('</td></tr>\n'
                          '</tbody>\n</table>\n')
 
-    # insert markers in text as pseudo-classes are not supported in CSS1:
+    # insert markers in text (pseudo-classes are not supported in CSS1):
     def visit_footnote_reference(self, node):
         href = '#' + node'refid'
         format = self.settings.footnote_references
@@ -544,8 +541,8 @@
     #   (SVG not supported by IE up to version 8,
     #   html4css1 strives for IE6 compatibility.)
     object_image_types = {'.svg': 'image/svg+xml',
-                         '.swf': 'application/x-shockwave-flash'}
-    #
+                          '.swf': 'application/x-shockwave-flash'}
+
     def visit_image(self, node):
         atts = {}
         uri = node'uri'
@@ -562,22 +559,21 @@
         if 'height' in node:
             atts'height' = node'height'
         if 'scale' in node:
-            if (PIL and not ('width' in node and 'height' in node)
+            if (PIL and ('width' not in node or 'height' not in node)
                 and self.settings.file_insertion_enabled):
                 imagepath = url2pathname(uri)
                 try:
-                    img = PIL.Image.open(
-                            imagepath.encode(sys.getfilesystemencoding()))
-                except (IOError, UnicodeEncodeError):
-                    pass # TODO: warn?
+                    with PIL.Image.open(imagepath) as img:
+                        img_size = img.size
+                except (OSError, UnicodeEncodeError):
+                    pass  # TODO: warn/info?
                 else:
                     self.settings.record_dependencies.add(
                         imagepath.replace('\\', '/'))
                     if 'width' not in atts:
-                        atts'width' = '%dpx' % img.size0
+                        atts'width' = '%dpx' % img_size0
                     if 'height' not in atts:
-                        atts'height' = '%dpx' % img.size1
-                    del img
+                        atts'height' = '%dpx' % img_size1
             for att_name in 'width', 'height':
                 if att_name in atts:
                     match = re.match(r'(0-9.+)(\S*)$', attsatt_name)
@@ -595,9 +591,9 @@
                 del attsatt_name
         if style:
             atts'style' = ' '.join(style)
-        if (isinstance(node.parent, nodes.TextElement) or
-            (isinstance(node.parent, nodes.reference) and
-             not isinstance(node.parent.parent, nodes.TextElement))):
+        if (isinstance(node.parent, nodes.TextElement)
+            or (isinstance(node.parent, nodes.reference)
+                and not isinstance(node.parent.parent, nodes.TextElement))):
             # Inline context or surrounded by <a>...</a>.
             suffix = ''
         else:
@@ -606,8 +602,8 @@
             atts'class' = 'align-%s' % node'align'
         if ext in self.object_image_types:
             # do NOT use an empty tag: incorrect rendering in browsers
-            self.body.append(self.starttag(node, 'object', '', **atts) +
-                             node.get('alt', uri) + '</object>' + suffix)
+            self.body.append(self.starttag(node, 'object', '', **atts)
+                             + node.get('alt', uri) + '</object>' + suffix)
         else:
             self.body.append(self.emptytag(node, 'img', suffix, **atts))
 
@@ -621,7 +617,7 @@
                                        CLASS='label'))
 
     def depart_label(self, node):
-        self.body.append('%s</td><td>%s' % (self.context.pop(), self.context.pop()))
+        self.body.append(f'{self.context.pop()}</td><td>{self.context.pop()}')
 
     # ersatz for first/last pseudo-classes
     def visit_list_item(self, node):
@@ -629,11 +625,14 @@
         if len(node):
             node0'classes'.append('first')
 
+    def depart_list_item(self, node):
+        self.body.append('</li>\n')
+
     # use <tt> (not supported by HTML5),
     # cater for limited styling options in CSS1 using hard-coded NBSPs
     def visit_literal(self, node):
         # special case: "code" role
-        classes = node.get('classes', )
+        classes = node'classes'
         if 'code' in classes:
             # filter 'code' from class arguments
             node'classes' = cls for cls in classes if cls != 'code'
@@ -661,19 +660,22 @@
         # Content already processed:
         raise nodes.SkipNode
 
-    # add newline after opening tag, don't use <code> for code
+    def depart_literal(self, node):
+        # skipped unless literal element is from "code" role:
+        self.body.append('</code>')
+
+    # add newline after wrapper tags, don't use <code> for code
     def visit_literal_block(self, node):
         self.body.append(self.starttag(node, 'pre', CLASS='literal-block'))
 
-    # add newline
     def depart_literal_block(self, node):
         self.body.append('\n</pre>\n')
 
     # use table for option list
     def visit_option_group(self, node):
         atts = {}
-        if ( self.settings.option_limit
-             and len(node.astext()) > self.settings.option_limit):
+        if (self.settings.option_limit
+            and len(node.astext()) > self.settings.option_limit):
             atts'colspan' = 2
             self.context.append('</tr>\n<tr><td>&nbsp;</td>')
         else:
@@ -711,17 +713,18 @@
         """
         Determine if the <p> tags around paragraph ``node`` can be omitted.
         """
-        if (isinstance(node.parent, nodes.document) or
-            isinstance(node.parent, nodes.compound)):
+        if (isinstance(node.parent, nodes.document)
+            or isinstance(node.parent, nodes.compound)):
             # Never compact paragraphs in document or compound.
             return False
         for key, value in node.attlist():
-            if (node.is_not_default(key) and
-                not (key == 'classes' and value in
-                     (, 'first', 'last', 'first', 'last'))):
+            if (node.is_not_default(key)
+                and not (key == 'classes'
+                         and value in (, 'first',
+                                       'last', 'first', 'last'))):
                 # Attribute which needs to survive.
                 return False
-        first = isinstance(node.parent0, nodes.label) # skip label
+        first = isinstance(node.parent0, nodes.label)  # skip label
         for child in node.parent.childrenfirst::
             # only first paragraph can be compact
             if isinstance(child, nodes.Invisible):
@@ -731,9 +734,9 @@
             return False
         parent_length = len(n for n in node.parent if not isinstance(
             n, (nodes.Invisible, nodes.label)))
-        if ( self.compact_simple
-             or self.compact_field_list
-             or self.compact_p and parent_length == 1):
+        if (self.compact_simple
+            or self.compact_field_list
+            or self.compact_p and parent_length == 1):
             return True
         return False
 
@@ -754,6 +757,10 @@
         self.set_first_last(node)
         self.in_sidebar = True
 
+    def depart_sidebar(self, node):
+        self.body.append('</div>\n')
+        self.in_sidebar = False
+
     # <sub> not allowed in <pre>
     def visit_subscript(self, node):
         if isinstance(node.parent, nodes.literal_block):
@@ -781,8 +788,8 @@
         elif isinstance(node.parent, nodes.section):
             tag = 'h%s' % (self.section_level + self.initial_header_level - 1)
             self.body.append(
-                self.starttag(node, tag, '', CLASS='section-subtitle') +
-                self.starttag({}, 'span', '', CLASS='section-subtitle'))
+                self.starttag(node, tag, '', CLASS='section-subtitle')
+                + self.starttag({}, 'span', '', CLASS='section-subtitle'))
             self.context.append('</span></%s>\n' % tag)
 
     def depart_subtitle(self, node):
@@ -835,6 +842,9 @@
                          % (node'type', node'level',
                             self.encode(node'source'), line, backref_text))
 
+    def depart_system_message(self, node):
+        self.body.append('</div>\n')
+
     # "hard coded" border setting
     def visit_table(self, node):
         self.context.append(self.compact_p)
@@ -855,17 +865,48 @@
     # hard-coded vertical alignment
     def visit_tbody(self, node):
         self.body.append(self.starttag(node, 'tbody', valign='top'))
-    #
+
     def depart_tbody(self, node):
         self.body.append('</tbody>\n')
 
+    # no special handling of "details" in definition list
+    def visit_term(self, node):
+        self.body.append(self.starttag(node, 'dt', '',
+                                       classes=node.parent'classes',
+                                       ids=node.parent'ids'))
+
+    def depart_term(self, node):
+        pass
+
     # hard-coded vertical alignment
     def visit_thead(self, node):
         self.body.append(self.starttag(node, 'thead', valign='bottom'))
-    #
+
     def depart_thead(self, node):
         self.body.append('</thead>\n')
 
+    # auxiliary method, called by visit_title()
+    # "with-subtitle" class, no ARIA roles
+    def section_title_tags(self, node):
+        classes = 
+        h_level = self.section_level + self.initial_header_level - 1
+        if (len(node.parent) >= 2
+            and isinstance(node.parent1, nodes.subtitle)):
+            classes.append('with-subtitle')
+        if h_level > 6:
+            classes.append('h%i' % h_level)
+        tagname = 'h%i' % min(h_level, 6)
+        start_tag = self.starttag(node, tagname, '', classes=classes)
+        if node.hasattr('refid'):
+            atts = {}
+            atts'class' = 'toc-backref'
+            atts'href' = '#' + node'refid'
+            start_tag += self.starttag({}, 'a', '', **atts)
+            close_tag = '</a></%s>\n' % tagname
+        else:
+            close_tag = '</%s>\n' % tagname
+        return start_tag, close_tag
+
 
 class SimpleListChecker(writers._html_base.SimpleListChecker):

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html4css1/html4css1.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html4css1/html4css1.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/__init__.py Changed

@@ -1,5 +1,4 @@
-# .. coding: utf-8
-# $Id: __init__.py 8639 2021-03-20 23:47:29Z milde $
+# $Id: __init__.py 9272 2022-11-24 20:28:40Z milde $
 # :Author: Günter Milde <milde@users.sf.net>
 #          Based on the html4css1 writer by David Goodger.
 # :Maintainer: docutils-develop@lists.sourceforge.net
@@ -28,127 +27,81 @@
 __docformat__ = 'reStructuredText'
 
 import mimetypes
-import os.path
+from pathlib import Path
 
-import docutils
-from docutils import frontend, nodes, writers, io
-from docutils.transforms import writer_aux
+from docutils import frontend, nodes
 from docutils.writers import _html_base
-from docutils.writers._html_base import PIL, url2pathname
 
-class Writer(writers._html_base.Writer):
 
-    supported = ('html', 'html5', 'html4', 'xhtml', 'xhtml10')
+class Writer(_html_base.Writer):
+
+    supported = ('html5', 'xhtml', 'html')
     """Formats this writer supports."""
 
     default_stylesheets = 'minimal.css', 'plain.css'
-    default_stylesheet_dirs = '.', os.path.abspath(os.path.dirname(__file__))
-
-    default_template = 'template.txt'
-    default_template_path = os.path.join(
-        os.path.dirname(os.path.abspath(__file__)), default_template)
-
-    settings_spec = (
-        'HTML-Specific Options',
-        None,
-        (('Specify the template file (UTF-8 encoded).  Default is "%s".'
-          % default_template_path,
-          '--template',
-          {'default': default_template_path, 'metavar': '<file>'}),
-         ('Comma separated list of stylesheet URLs. '
-          'Overrides previous --stylesheet and --stylesheet-path settings.',
-          '--stylesheet',
-          {'metavar': '<URL,URL,...>', 'overrides': 'stylesheet_path',
-           'validator': frontend.validate_comma_separated_list}),
-         ('Comma separated list of stylesheet paths. '
-          'Relative paths are expanded if a matching file is found in '
-          'the --stylesheet-dirs. With --link-stylesheet, '
-          'the path is rewritten relative to the output HTML file. '
-          'Default: "%s"' % ','.join(default_stylesheets),
-          '--stylesheet-path',
-          {'metavar': '<file,file,...>', 'overrides': 'stylesheet',
-           'validator': frontend.validate_comma_separated_list,
-           'default': default_stylesheets}),
-         ('Embed the stylesheet(s) in the output HTML file.  The stylesheet '
-          'files must be accessible during processing. This is the default.',
-          '--embed-stylesheet',
-          {'default': 1, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Link to the stylesheet(s) in the output HTML file. '
-          'Default: embed stylesheets.',
-          '--link-stylesheet',
-          {'dest': 'embed_stylesheet', 'action': 'store_false'}),
-         ('Comma-separated list of directories where stylesheets are found. '
-          'Used by --stylesheet-path when expanding relative path arguments. '
-          'Default: "%s"' % default_stylesheet_dirs,
-          '--stylesheet-dirs',
-          {'metavar': '<dir,dir,...>',
-           'validator': frontend.validate_comma_separated_list,
-           'default': default_stylesheet_dirs}),
-         ('Specify the initial header level.  Default is 2 for "<h2>".  '
-          'Does not affect document title & subtitle (see --no-doc-title).',
-          '--initial-header-level',
-          {'choices': '1 2 3 4 5 6'.split(), 'default': '2',
-           'metavar': '<level>'}),
-         ('Format for footnote references: one of "superscript" or '
-          '"brackets".  Default is "brackets".',
-          '--footnote-references',
-          {'choices': 'superscript', 'brackets', 'default': 'brackets',
-           'metavar': '<format>',
-           'overrides': 'trim_footnote_reference_space'}),
-         ('Format for block quote attributions: one of "dash" (em-dash '
-          'prefix), "parentheses"/"parens", or "none".  Default is "dash".',
-          '--attribution',
-          {'choices': 'dash', 'parentheses', 'parens', 'none',
-           'default': 'dash', 'metavar': '<format>'}),
-         ('Remove extra vertical whitespace between items of "simple" bullet '
-          'lists and enumerated lists.  Default: enabled.',
-          '--compact-lists',
-          {'default': True, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Disable compact simple bullet and enumerated lists.',
-          '--no-compact-lists',
-          {'dest': 'compact_lists', 'action': 'store_false'}),
-         ('Remove extra vertical whitespace between items of simple field '
-          'lists.  Default: enabled.',
-          '--compact-field-lists',
-          {'default': True, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Disable compact simple field lists.',
-          '--no-compact-field-lists',
-          {'dest': 'compact_field_lists', 'action': 'store_false'}),
-         ('Embed images in the output HTML file, if the image '
-          'files are accessible during processing.',
+    default_stylesheet_dirs = '.', str(Path(__file__).parent)
+    default_template = Path(__file__).parent / 'template.txt'
+
+    # use a copy of the parent spec with some modifications
+    settings_spec = frontend.filter_settings_spec(
+        _html_base.Writer.settings_spec,
+        template=(
+            f'Template file. (UTF-8 encoded, default: "{default_template}")',
+            '--template',
+            {'default': default_template, 'metavar': '<file>'}),
+        stylesheet_path=(
+            'Comma separated list of stylesheet paths. '
+            'Relative paths are expanded if a matching file is found in '
+            'the --stylesheet-dirs. With --link-stylesheet, '
+            'the path is rewritten relative to the output HTML file. '
+            '(default: "%s")' % ','.join(default_stylesheets),
+            '--stylesheet-path',
+            {'metavar': '<file,file,...>', 'overrides': 'stylesheet',
+             'validator': frontend.validate_comma_separated_list,
+             'default': default_stylesheets}),
+        stylesheet_dirs=(
+            'Comma-separated list of directories where stylesheets are found. '
+            'Used by --stylesheet-path when expanding relative path '
+            'arguments. (default: "%s")' % ','.join(default_stylesheet_dirs),
+            '--stylesheet-dirs',
+            {'metavar': '<dir,dir,...>',
+             'validator': frontend.validate_comma_separated_list,
+             'default': default_stylesheet_dirs}),
+        initial_header_level=(
+            'Specify the initial header level. Does not affect document '
+            'title & subtitle (see --no-doc-title). (default: 2 for "<h2>")',
+            '--initial-header-level',
+            {'choices': '1 2 3 4 5 6'.split(), 'default': '2',
+             'metavar': '<level>'}),
+        no_xml_declaration=(
+            'Omit the XML declaration.',
+            '--no-xml-declaration',
+            {'dest': 'xml_declaration', 'action': 'store_false'}),
+    )
+    settings_spec = settings_spec + (
+        'HTML5 Writer Options',
+        '',
+        ((frontend.SUPPRESS_HELP,  # Obsoleted by "--image-loading"
           '--embed-images',
-          {'default': 0, 'action': 'store_true',
+          {'action': 'store_true',
            'validator': frontend.validate_boolean}),
-         ('Link to images in the output HTML file. '
-          'This is the default.',
+         (frontend.SUPPRESS_HELP,  # Obsoleted by "--image-loading"
           '--link-images',
           {'dest': 'embed_images', 'action': 'store_false'}),
-         ('Added to standard table classes. '
-          'Defined styles: borderless, booktabs, '
-          'align-left, align-center, align-right, colwidths-auto. '
-          'Default: ""',
-          '--table-style',
-          {'default': ''}),
-         ('Math output format (one of "MathML", "HTML", "MathJax", '
-          'or "LaTeX") and option(s). '
-          'Default: "HTML math.css"',
-          '--math-output',
-          {'default': 'HTML math.css'}),
-         ('Prepend an XML declaration. (Thwarts HTML5 conformance.) '
-          'Default: False',
-          '--xml-declaration',
-          {'default': False, 'action': 'store_true',
-           'validator': frontend.validate_boolean}),
-         ('Omit the XML declaration.',
-          '--no-xml-declaration',
-          {'dest': 'xml_declaration', 'action': 'store_false'}),
-         ('Obfuscate email addresses to confuse harvesters while still '
-          'keeping email links usable with standards-compliant browsers.',
-          '--cloak-email-addresses',
-          {'action': 'store_true', 'validator': frontend.validate_boolean}),))
+         ('Suggest at which point images should be loaded: '
+          '"embed", "link" (default), or "lazy".',
+          '--image-loading',
+          {'choices': ('embed', 'link', 'lazy'),
+           # 'default': 'link'  # default set in _html_base.py
+           }),
+         ('Append a self-link to section headings.',
+          '--section-self-link',
+          {'default': 0, 'action': 'store_true'}),
+         ('Do not append a self-link to section headings. (default)',
+          '--no-section-self-link',
+          {'dest': 'section_self_link', 'action': 'store_false'}),
+         )
+        )
 
     config_section = 'html5 writer'
 
@@ -157,7 +110,7 @@
         self.translator_class = HTMLTranslator
 
 
-class HTMLTranslator(writers._html_base.HTMLTranslator):
+class HTMLTranslator(_html_base.HTMLTranslator):
     """
     This writer generates `polyglot markup`: HTML5 that is also valid XML.
 
@@ -167,9 +120,14 @@
     and examples.
     """
 
-    # meta tag to fix rendering in mobile browsers
-    viewport = ('<meta name="viewport" '
-                'content="width=device-width, initial-scale=1" />\n')
+    # self.starttag() arguments for the main document
+    documenttag_args = {'tagname': 'main'}
+
+    # add meta tag to fix rendering in mobile browsers
+    def __init__(self, document):
+        super().__init__(document)
+        self.meta.append('<meta name="viewport" '
+                         'content="width=device-width, initial-scale=1" />\n')
 
     # <acronym> tag obsolete in HTML5. Use the <abbr> tag instead.
     def visit_acronym(self, node):
@@ -184,8 +142,8 @@
     def visit_authors(self, node):
         self.visit_docinfo_item(node, 'authors', meta=False)
         for subnode in node:
-            self.add_meta('<meta name="author" content="%s" />\n' %
-                          self.attval(subnode.astext()))
+            self.meta.append('<meta name="author" content='
+                             f'"{self.attval(subnode.astext())}" />\n')
 
     def depart_authors(self, node):
         self.depart_docinfo_item()
@@ -201,11 +159,12 @@
         # <figcaption> is closed in depart_figure(), as legend may follow.
 
     # use HTML block-level tags if matching class value found
-    supported_block_tags = set(('ins', 'del'))
+    supported_block_tags = {'ins', 'del'}
+
     def visit_container(self, node):
         # If there is exactly one of the "supported block tags" in
         # the list of class values, use it as tag name:
-        classes = node.get('classes', )
+        classes = node'classes'
         tags = cls for cls in classes
                 if cls in self.supported_block_tags
         if len(tags) == 1:
@@ -217,15 +176,14 @@
                                        CLASS='docutils container'))
 
     def depart_container(self, node):
-        self.body.append('</%s>\n' % node.html5tagname)
-
+        self.body.append(f'</{node.html5tagname}>\n')
 
     # no standard meta tag name in HTML5, use dcterms.rights
     # see https://wiki.whatwg.org/wiki/MetaExtensions
     def visit_copyright(self, node):
         self.visit_docinfo_item(node, 'copyright', meta=False)
-        self.add_meta('<meta name="dcterms.rights" content="%s" />\n'
-                      % self.attval(node.astext()))
+        self.meta.append('<meta name="dcterms.rights" '
+                         f'content="{self.attval(node.astext())}" />\n')
 
     def depart_copyright(self, node):
         self.depart_docinfo_item()
@@ -233,51 +191,19 @@
     # no standard meta tag name in HTML5, use dcterms.date
     def visit_date(self, node):
         self.visit_docinfo_item(node, 'date', meta=False)
-        self.add_meta('<meta name="dcterms.date" content="%s" />\n'
-                      % self.attval(node.astext()))
+        self.meta.append('<meta name="dcterms.date" '
+                         f'content="{self.attval(node.astext())}" />\n')
 
     def depart_date(self, node):
         self.depart_docinfo_item()
 
-    def visit_document(self, node):
-        title = (node.get('title', '') or os.path.basename(node'source')
-                 or 'untitled Docutils document')
-        self.head.append('<title>%s</title>\n' % self.encode(title))
-
-    def depart_document(self, node):
-        self.head_prefix.extend(self.doctype,
-                                 self.head_prefix_template %
-                                 {'lang': self.settings.language_code})
-        self.html_prolog.append(self.doctype)
-        self.meta.insert(0, self.viewport)
-        self.head.insert(0, self.viewport)
-        self.meta.insert(0, self.content_type % self.settings.output_encoding)
-        self.head.insert(0, self.content_type % self.settings.output_encoding)
-        if 'name="dcterms.' in ''.join(self.meta):
-            self.head.append(
-             '<link rel="schema.dcterms" href="http://purl.org/dc/terms/"/>')
-        if self.math_header:
-            if self.math_output == 'mathjax':
-                self.head.extend(self.math_header)
-            else:
-                self.stylesheet.extend(self.math_header)
-        # skip content-type meta tag with interpolated charset value:
-        self.html_head.extend(self.head1:)
-        self.body_prefix.append(self.starttag(node, 'main'))
-        self.body_suffix.insert(0, '</main>\n')
-        self.fragment.extend(self.body) # self.fragment is the "naked" body
-        self.html_body.extend(self.body_prefix1: + self.body_pre_docinfo
-                              + self.docinfo + self.body
-                              + self.body_suffix:-1)
-        assert not self.context, 'len(context) = %s' % len(self.context)
-
     # use new HTML5 <figure> and <figcaption> elements
     def visit_figure(self, node):
         atts = {}
         if node.get('width'):
-            atts'style' = 'width: %s' % node'width'
+            atts'style' = f"width: {node'width'}"
         if node.get('align'):
-            atts'class' = "align-" + node'align'
+            atts'class' = f"align-{node'align'}"
         self.body.append(self.starttag(node, 'figure', **atts))
 
     def depart_figure(self, node):
@@ -293,7 +219,7 @@
         start = self.context.pop()
         footer = self.starttag(node, 'footer')
         footer.extend(self.bodystart:)
-        footer.append('\n</footer>\n')
+        footer.append('</footer>\n')
         self.footer.extend(footer)
         self.body_suffix:0 = footer
         del self.bodystart:
@@ -310,7 +236,7 @@
         self.body_prefix.extend(header)
         self.header.extend(header)
         del self.bodystart:
-        
+
     # MIME types supported by the HTML5 <video> element
     videotypes = ('video/mp4', 'video/webm', 'video/ogg')
 
@@ -319,48 +245,53 @@
         uri = node'uri'
         mimetype = mimetypes.guess_type(uri)0
         if mimetype not in self.videotypes:
-            return super(HTMLTranslator, self).visit_image(node)
+            return super().visit_image(node)
         # image size
         if 'width' in node:
             atts'width' = node'width'.replace('px', '')
         if 'height' in node:
             atts'height' = node'height'.replace('px', '')
         if 'align' in node:
-            atts'class' = 'align-%s' % node'align'
-        if 'controls' in node.get('classes', ):
+            atts'class' = f"align-{node'align'}"
+        if 'controls' in node'classes':
             atts'controls' = 'controls'
+            node'classes'.remove('controls')
         atts'title' = node.get('alt', uri)
-        
+        if getattr(self.settings, 'image_loading', None) == 'lazy':
+            atts'loading' = 'lazy'
         # No newline in inline context or if surrounded by <a>...</a>.
-        if (isinstance(node.parent, nodes.TextElement) or
-            (isinstance(node.parent, nodes.reference) and
-             not isinstance(node.parent.parent, nodes.TextElement))):
+        if (isinstance(node.parent, nodes.TextElement)
+            or (isinstance(node.parent, nodes.reference)
+                and not isinstance(node.parent.parent, nodes.TextElement))):
             suffix = ''
         else:
             suffix = '\n'
-        self.body.append('%s<a href="%s">%s</a>%s</video>%s'
-            % (self.starttag(node, 'video', suffix, src=uri, **atts),
-               uri, node.get('alt', uri), suffix, suffix))
+        fallback = node.get('alt', uri)
+        self.body.append(
+            self.starttag(node, "video", suffix, src=uri, **atts)
+            + f'<a href="{uri}">{fallback}</a>{suffix}</video>{suffix}')
 
     def depart_image(self, node):
         pass
 
     # use HTML text-level tags if matching class value found
-    supported_inline_tags = set(('code', 'kbd', 'dfn', 'samp', 'var',
-                                 'bdi', 'del', 'ins', 'mark', 'small',
-                                 'b', 'i', 'q', 's', 'u'))
+    supported_inline_tags = {'code', 'kbd', 'dfn', 'samp', 'var',
+                             'bdi', 'del', 'ins', 'mark', 'small',
+                             'b', 'i', 'q', 's', 'u'}
+
+    # Use `supported_inline_tags` if found in class values
     def visit_inline(self, node):
-        # Use `supported_inline_tags` if found in class values
-        classes = node.get('classes', )
+        classes = node'classes'
         tags = cls for cls in self.supported_inline_tags
                 if cls in classes
         if len(tags):
             node.html5tagname = tags0
             classes.remove(tags0)
-        elif (classes == 'ln' and isinstance(node.parent, nodes.literal_block)
-            and 'code' in node.parent.get('classes')):
+        elif (classes == 'ln'
+              and isinstance(node.parent, nodes.literal_block)
+              and 'code' in node.parent.get('classes')):
             if self.body-1 == '<code>':
-                del(self.body-1)
+                del self.body-1
             else:
                 self.body.append('</code>')
             node.html5tagname = 'small'
@@ -369,11 +300,11 @@
         self.body.append(self.starttag(node, node.html5tagname, ''))
 
     def depart_inline(self, node):
-        self.body.append('</%s>' % node.html5tagname)
+        self.body.append(f'</{node.html5tagname}>')
         if (node.html5tagname == 'small' and node.get('classes') == 'ln'
             and isinstance(node.parent, nodes.literal_block)):
-            self.body.append('<code data-lineno="%s">' % node.astext())
-        del(node.html5tagname)
+            self.body.append(f'<code data-lineno="{node.astext()}">')
+        del node.html5tagname
 
     # place inside HTML5 <figcaption> element (together with caption)
     def visit_legend(self, node):
@@ -387,7 +318,7 @@
 
     # use HTML text-level tags if matching class value found
     def visit_literal(self, node):
-        classes = node.get('classes', )
+        classes = node'classes'
         tags = cls for cls in self.supported_inline_tags
                 if cls in classes
         if len(tags):
@@ -408,11 +339,11 @@
         # ``+?(\d+(\.\d*)?|\.\d+)`` from bad line wrapping
         for token in self.words_and_spaces.findall(text):
             if token.strip() and self.in_word_wrap_point.search(token):
-                self.body.append('<span class="pre">%s</span>'
-                                    % self.encode(token))
+                self.body.append(
+                    f'<span class="pre">{self.encode(token)}</span>')
             else:
                 self.body.append(self.encode(token))
-        self.body.append('</%s>' % tagname)
+        self.body.append(f'</{tagname}>')
         # Content already processed:
         raise nodes.SkipNode
 
@@ -425,14 +356,16 @@
     def visit_meta(self, node):
         if node.hasattr('lang'):
             node'xml:lang' = node'lang'
-        meta = self.emptytag(node, 'meta', **node.non_default_attributes())
-        self.add_meta(meta)
+        self.meta.append(self.emptytag(node, 'meta',
+                                       **node.non_default_attributes()))
+
     def depart_meta(self, node):
         pass
 
     # no standard meta tag name in HTML5
     def visit_organization(self, node):
         self.visit_docinfo_item(node, 'organization', meta=False)
+
     def depart_organization(self, node):
         self.depart_docinfo_item()
 
@@ -456,16 +389,38 @@
         self.body.append('</aside>\n')
         self.in_sidebar = False
 
+    # Use new HTML5 element <aside> or <nav>
     # Add class value to <body>, if there is a ToC in the document
-    # (see responsive.css how this is used for sidebar navigation).
-    # TODO: use the new HTML5 element <aside>?
+    # (see responsive.css how this is used for a navigation sidebar).
     def visit_topic(self, node):
-        if ('contents' in node'classes'
-            and isinstance(node.parent, nodes.document)):
-            self.body_prefix0 = '</head>\n<body class="with-toc">\n'
-        self.body.append(self.starttag(node, 'div', CLASS='topic'))
-        self.topic_classes = node'classes' # TODO: remove?
+        atts = {'classes': 'topic'}
+        if 'contents' in node'classes':
+            node.html_tagname = 'nav'
+            del atts'classes'
+            if isinstance(node.parent, nodes.document):
+                atts'role' = 'doc-toc'
+                self.body_prefix0 = '</head>\n<body class="with-toc">\n'
+        elif 'abstract' in node'classes':
+            node.html_tagname = 'div'
+            atts'role' = 'doc-abstract'
+        elif 'dedication' in node'classes':
+            node.html_tagname = 'div'
+            atts'role' = 'doc-dedication'
+        else:
+            node.html_tagname = 'aside'
+        self.body.append(self.starttag(node, node.html_tagname, **atts))
 
     def depart_topic(self, node):
-        self.body.append('</div>\n')
-        self.topic_classes = 
+        self.body.append(f'</{node.html_tagname}>\n')
+        del node.html_tagname
+
+    # append self-link
+    def section_title_tags(self, node):
+        start_tag, close_tag = super().section_title_tags(node)
+        ids = node.parent'ids'
+        if (ids and getattr(self.settings, 'section_self_link', None)
+            and not isinstance(node.parent, nodes.document)):
+            self_link = ('<a class="self-link" title="link to this section"'
+                         f' href="#{ids0}"></a>')
+            close_tag = close_tag.replace('</h', self_link + '</h')
+        return start_tag, close_tag

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/math.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/math.css Changed

@@ -2,6 +2,7 @@
 *   math2html: convert LaTeX equations to HTML output.
 *
 *   Copyright (C) 2009,2010 Alex Fernández
+*                 2021      Günter Milde
 *
 *   Released under the terms of the `2-Clause BSD license'_, in short:
 *   Copying and distribution of this file, with or without modification,
@@ -13,16 +14,19 @@
 *
 *   Based on eLyXer: convert LyX source files to HTML output.
 *   http://elyxer.nongnu.org/
-*/
-/* --end--
+*
+*
 * CSS file for LaTeX formulas.
+*
+* References: http://www.zipcon.net/~swhite/docs/math/math.html
+*             http://www.cs.tut.fi/~jkorpela/math/
 */
 
 /* Formulas */
 .formula {
 	text-align: center;
-	font-family: "Droid Serif", "DejaVu Serif", "STIX", serif;
 	margin: 1.2em 0;
+	line-height: 1.4;
 }
 span.formula {
 	white-space: nowrap;
@@ -46,6 +50,9 @@
 span.ignored, span.arraydef {
 	display: none;
 }
+.phantom {
+	visibility: hidden;
+}
 .formula i {
 	letter-spacing: 0.1ex;
 }
@@ -62,73 +69,111 @@
 }
 
 /* Structures */
+span.hspace {
+	display: inline-block;
+}
 span.overline, span.bar {
 	text-decoration: overline;
 }
-.fraction, .fullfraction {
+.fraction, .fullfraction, .textfraction {
 	display: inline-block;
 	vertical-align: middle;
 	text-align: center;
 }
-.fraction .fraction {
+span.formula .fraction,
+.textfraction,
+span.smallmatrix {
 	font-size: 80%;
-	line-height: 100%;
+	line-height: 1;
 }
 span.numerator {
 	display: block;
+	line-height: 1;
 }
 span.denominator {
 	display: block;
+	line-height: 1;
 	padding: 0ex;
 	border-top: thin solid;
 }
+.formula sub, .formula sup {
+	font-size: 80%;
+}
 sup.numerator, sup.unit {
-	font-size: 70%;
 	vertical-align: 80%;
 }
 sub.denominator, sub.unit {
-	font-size: 70%;
 	vertical-align: -20%;
 }
+span.smallsymbol {
+	font-size: 75%;
+	line-height: 75%;
+}
+span.boldsymbol {
+	font-weight: bold;
+}
 span.sqrt {
 	display: inline-block;
 	vertical-align: middle;
 	padding: 0.1ex;
 }
 sup.root {
-	font-size: 70%;
 	position: relative;
 	left: 1.4ex;
 }
 span.radical {
 	display: inline-block;
 	padding: 0ex;
-	font-size: 150%;
+	/* font-size: 160%; for DejaVu, not required with STIX */
+	line-height: 100%;
 	vertical-align: top;
+	vertical-align: middle;
 }
+
 span.root {
 	display: inline-block;
 	border-top: thin solid;
 	padding: 0ex;
 	vertical-align: middle;
 }
-span.symbol {
-	line-height: 125%;
-	font-size: 125%;
+div.formula .bigoperator,
+.displaystyle .bigoperator,
+.displaystyle .bigoperator {
+	line-height: 120%;
+	font-size: 140%;
+	padding-right: 0.2ex;
 }
-span.bigsymbol {
-	line-height: 150%;
-	font-size: 150%;
+span.fraction .bigoperator,
+span.scriptstyle .bigoperator {
+	line-height: inherit;
+	font-size: inherit;
+	padding-right: 0;
+}
+span.bigdelimiter {
+	display: inline-block;
 }
-span.largesymbol {
-	font-size: 175%;
+span.bigdelimiter.size1 {
+	transform: scale(1, 1.2);
+	line-height: 1.2;
 }
-span.hugesymbol {
-	font-size: 200%;
+span.bigdelimiter.size2 {
+	transform: scale(1, 1.62);
+	line-height: 1.62%;
+
+}
+span.bigdelimiter.size3 {
+	transform: scale(1, 2.05);
+	line-height: 2.05%;
+}
+span.bigdelimiter.size4 {
+	transform: scale(1, 2.47);
+	line-height: 2.47%;
 }
+/* vertically stacked sub and superscript */
 span.scripts {
 	display: inline-table;
 	vertical-align: middle;
+	padding-right: 0.2ex;
 }
 .script {
 	display: table-row;
@@ -146,51 +191,42 @@
 sup.limit, sub.limit {
 	line-height: 100%;
 }
-span.symbolover {
-	display: inline-block;
-	text-align: center;
-	position: relative;
-	float: right;
-	right: 100%;
-	bottom: 0.5em;
-	width: 0px;
-}
-span.withsymbol {
+span.embellished,
+span.embellished > .base {
 	display: inline-block;
 }
-span.symbolunder {
+span.embellished > sup,
+span.embellished > sub {
 	display: inline-block;
-	text-align: center;
+	font-size: 100%;
 	position: relative;
-	float: right;
-	right: 80%;
-	top: 0.3em;
+	bottom: 0.3em;
 	width: 0px;
 }
+span.embellished > sub {
+	top: 0.4em;
+}
 
 /* Environments */
 span.array, span.bracketcases, span.binomial, span.environment {
 	display: inline-table;
 	text-align: center;
-	border-collapse: collapse;
-	margin: 0em;
 	vertical-align: middle;
 }
 span.arrayrow, span.binomrow {
 	display: table-row;
-	padding: 0ex;
-	border: 0ex;
+	padding: 0;
+	border: 0;
 }
 span.arraycell, span.bracket, span.case, span.binomcell, span.environmentcell {
 	display: table-cell;
 	padding: 0ex 0.2ex;
-	line-height: 99%;
+	line-height: 1; /* 99%; */
 	border: 0ex;
 }
-/*
-* CSS file for LaTeX formulas, extra stuff:
-* binomials, vertical braces, stackrel, fonts and colors.
-*/
+.environment.align > .arrayrow > .arraycell.align-l {
+	padding-right: 2em;
+}
 
 /* Inline binomials */
 span.binom {
@@ -233,19 +269,30 @@
 }
 
 /* Fonts */
+.formula {
+	font-family: STIX, "DejaVu Serif", "DejaVu Math TeX Gyre", serif;
+}
+span.radical,   /* ensure correct size of square-root sign */
+span.integral { /* upright integral signs for better alignment of indices */
+	font-family: "STIXIntegralsUp", STIX;
+	/* font-size: 115%; match apparent size with DejaVu */
+}
+span.bracket {
+  /* some "STIX" and "DejaVu Math TeX Gyre" bracket pieces don't fit */
+	font-family: "DejaVu Serif", serif;
+}
 span.mathsf, span.textsf {
-	font-style: normal;
 	font-family: sans-serif;
 }
 span.mathrm, span.textrm {
-	font-style: normal;
-	font-family: serif;
+	font-family: STIX, "DejaVu Serif", "DejaVu Math TeX Gyre", serif;
 }
-span.text, span.textnormal {
-	font-style: normal;
+span.mathtt, span.texttt {
+	font-family: monospace;
 }
-span.textipa {
-	color: #008080;
+span.text, span.textnormal,
+span.mathsf, span.mathtt, span.mathrm {
+	font-style: normal;
 }
 span.fraktur {
 	font-family: "Lucida Blackletter", eufm10, blackletter;
@@ -257,6 +304,16 @@
 	font-family: "Monotype Corsiva", "Apple Chancery", "URW Chancery L", cursive;
 	font-style: italic;
 }
+span.mathscr {
+  font-family: MathJax_Script, rsfs10,  cursive;
+  font-style: italic;
+}
+span.textsc {
+	font-variant: small-caps;
+}
+span.textsl {
+	font-style: oblique;
+}
 
 /* Colors */
 span.colorbox {
@@ -273,4 +330,3 @@
 	border: thin solid black;
 	padding: 5px;
 }
-

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/minimal.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/minimal.css Changed

@@ -1,8 +1,8 @@
 /* Minimal style sheet for the HTML output of Docutils.                    */
 /*                                                                         */
 /* :Author: Günter Milde, based on html4css1.css by David Goodger          */
-/* :Id: $Id: minimal.css 8642 2021-03-26 13:51:14Z milde $               */
-/* :Copyright: © 2015 Günter Milde.                                        */
+/* :Id: $Id: minimal.css 9079 2022-06-19 14:00:56Z milde $                                                               */
+/* :Copyright: © 2015, 2021 Günter Milde.                                  */
 /* :License: Released under the terms of the `2-Clause BSD license`_,      */
 /*    in short:                                                            */
 /*                                                                         */
@@ -14,11 +14,10 @@
 /*                                                                         */
 /* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
 
-/* This CSS2.1_ stylesheet defines rules for Docutils elements without    */
-/* HTML equivalent. It is required to make the document semantic visible. */
-/*                                                                        */
-/* .. _CSS2.1: http://www.w3.org/TR/CSS2                                  */
-/* .. _validates: http://jigsaw.w3.org/css-validator/validator$link       */
+/* This CSS3 stylesheet defines rules for Docutils elements without        */
+/* HTML equivalent. It is required to make the document semantics visible. */
+/*                                                                         */
+/* .. _validates: http://jigsaw.w3.org/css-validator/validator$link        */
 
 /* titles */
 p.topic-title,
@@ -43,8 +42,8 @@
 h1 + p.subtitle {
   font-size: 1.6em;
 }
-h2 + p.section-subtitle, a.toc-backref {
-  color: black;
+a.toc-backref {
+  color: inherit;
   text-decoration: none;
 }
 
@@ -76,13 +75,11 @@
 /* Nested Paragraphs */
 p:first-child { margin-top: 0; }
 p:last-child { margin-bottom: 0; }
-td > p, th > p { margin-bottom: 0; }
+details > p:last-child { margin-bottom: 1em; }
 
 /* Table of Contents */
-.topic.contents { margin: 0.5em 0; }
-.topic.contents ul.auto-toc {
+.contents ul.auto-toc { /* section numbers present */
   list-style-type: none;
-  padding-left: 1.5em;
 }
 
 /* Enumerated Lists */
@@ -101,17 +98,20 @@
 }
 /* Field Lists and similar */
 /* bold field name, content starts on the same line */
+dl.field-list,
+dl.option-list,
+dl.docinfo {
+  display: flow-root;
+}
 dl.field-list > dt,
 dl.option-list > dt,
-dl.docinfo > dt,
-dl.footnote > dt,
-dl.citation > dt {
+dl.docinfo > dt {
   font-weight: bold;
   clear: left;
   float: left;
   margin: 0;
   padding: 0;
-  padding-right: 0.5em;
+  padding-right: 0.2em;
 }
 /* Offset for field content (corresponds to the --field-name-limit option) */
 dl.field-list > dd,
@@ -119,6 +119,12 @@
 dl.docinfo > dd {
   margin-left:  9em; /* ca. 14 chars in the test examples, fit all Docinfo fields */
 }
+/* start nested lists on new line */
+dd > dl:first-child,
+dd > ul:first-child,
+dd > ol:first-child {
+  clear: left;
+}
 /* start field-body on a new line after long field names */
 dl.field-list > dd > *:first-child,
 dl.option-list > dd > *:first-child
@@ -127,11 +133,6 @@
   width: 100%;
   margin: 0;
 }
-/* field names followed by a colon */
-dl.field-list > dt:after,
-dl.docinfo > dt:after {
-  content: ":";
-}
 
 /* Bibliographic Fields (docinfo) */
 dl.docinfo pre.address {
@@ -145,23 +146,54 @@
 span.option { white-space: nowrap; }
 
 /* Footnotes and Citations  */
-dl.footnote.superscript > dd { margin-left: 1em; }
-dl.footnote.brackets > dd { margin-left: 2em; }
-dl.footnote > dt { font-weight: normal; }
-a.footnote-reference.brackets:before,
-dt.label > span.brackets:before { content: ""; }
-a.footnote-reference.brackets:after,
-dt.label > span.brackets:after { content: ""; }
-a.footnote-reference.superscript,
-dl.footnote.superscript > dt.label {
+
+.footnote, .citation { margin: 1em 0; } /* default paragraph skip (Firefox) */
+/* hanging indent */
+.citation { padding-left: 2em; }
+.footnote { padding-left: 1.7em; }
+.footnote.superscript { padding-left: 1.0em; }
+.citation > .label { margin-left: -2em; }
+.footnote > .label { margin-left: -1.7em; }
+.footnote.superscript > .label { margin-left: -1.0em; }
+
+.footnote > .label + *,
+.citation > .label + * {
+  display: inline-block;
+  margin-top: 0;
+  vertical-align: top;
+}
+.footnote > .backrefs + *,
+.citation > .backrefs + * {
+  margin-top: 0;
+}
+.footnote > .label + p, .footnote > .backrefs + p,
+.citation > .label + p, .citation > .backrefs + p {
+  display: inline;
+  vertical-align: inherit;
+}
+
+.backrefs { user-select: none; }
+.backrefs > a { font-style: italic; }
+
+/* superscript footnotes */
+arole="doc-noteref".superscript,
+.footnote.superscript > .label,
+.footnote.superscript > .backrefs {
   vertical-align: super;
-  font-size: small;
+  font-size: smaller;
+  line-height: 1;
+}
+arole="doc-noteref".superscript > .fn-bracket,
+.footnote.superscript > .label > .fn-bracket {
+  /* hide brackets in display but leave for copy/paste */
+  display: inline-block;
+  width: 0;
+  overflow: hidden;
 }
-dt.label > span.fn-backref {
-  margin-left: 0.2em;
-  font-weight: normal;
+role="doc-noteref".superscript + role="doc-noteref".superscript {
+  padding-left: 0.15em; /* separate consecutive footnote references */
+  /* TODO: unfortunately, "+" also selects with text between the references. */
 }
-dt.label > span.fn-backref > a { font-style: italic; }
 
 /* Alignment */
 .align-left   {
@@ -169,7 +201,6 @@
   margin-right: auto;
 }
 .align-center {
-  clear: both;
   text-align: center;
   margin-left: auto;
   margin-right: auto;
@@ -189,24 +220,14 @@
 }
 
 /* Text Blocks */
-blockquote,
-div.topic,
-aside.topic {
-  margin: 1em 2em;
-}
+.topic { margin: 1em 2em; }
 .sidebar,
 .admonition,
 .system-message {
-  border: thin solid;
   margin: 1em 2em;
+  border: thin solid;
   padding: 0.5em 1em;
 }
-.sidebar {
-  width: 30%;
-  max-width: 26em;
-  float: right;
-  clear: right;
-}
 div.line-block { display: block; }
 div.line-block div.line-block, pre { margin-left: 2em; }
 
@@ -246,7 +267,7 @@
 
 /* Images are block-level by default in Docutils */
 /* New HTML5 block elements: set display for older browsers */
-img, header, section, footer, aside, nav, main, article, figure, video {
+img, header, footer, main, aside, nav, section, figure, video, details {
   display: block;
 }
 /* inline images */

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/plain.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/plain.css Changed

@@ -2,7 +2,7 @@
 /* Rules for easy reading and pre-defined style variants.                  */
 /*                                                                         */
 /* :Author: Günter Milde, based on html4css1.css by David Goodger          */
-/* :Id: $Id: plain.css 8636 2021-03-19 00:23:33Z milde $                                                               */
+/* :Id: $Id: plain.css 9338 2023-04-08 21:08:47Z milde $                                                               */
 /* :Copyright: © 2015 Günter Milde.                                        */
 /* :License: Released under the terms of the `2-Clause BSD license`_,      */
 /*    in short:                                                            */
@@ -14,7 +14,7 @@
 /*    This file is offered as-is, without any warranty.                    */
 /*                                                                         */
 /* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
-/* .. _CSS3: http://www.w3.org/TR/CSS3                                     */
+/* .. _CSS3: https://www.w3.org/Style/CSS/                                 */
 
 
 /* Document Structure */
@@ -24,9 +24,10 @@
 body {
   margin: 0;
   background-color: #dbdbdb;
+  --field-indent: 9em; /* default indent of fields in field lists */
 }
 main, footer, header {
-  line-height:1.3;
+  line-height:1.6;
   /* avoid long lines --> better reading */
   /* optimum is 45…75 characters/line <http://webtypography.net/2.1.2> */
   /* OTOH: lines should not be too short because of missing hyphenation, */
@@ -44,6 +45,21 @@
   border: none;
 }
 
+/* Table of Contents */
+ul.auto-toc > li > p {
+  padding-left: 1em;
+  text-indent: -1em;
+}
+nav.contents ul {
+  padding-left: 1em;
+}
+main > nav.contents ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B29\ ';
+}
+main > nav.contents ul ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B1D\ ';
+}
+
 /* Transitions */
 hr.docutils {
   width: 80%;
@@ -55,49 +71,56 @@
 /* Paragraphs */
 
 /* vertical space (parskip) */
-p, ol, ul, dl, li, dd,
+p, ol, ul, dl, li,
 div.line-block,
-div.topic,
+.footnote, .citation,
+div > math,
 table {
   margin-top: 0.5em;
   margin-bottom: 0.5em;
 }
-p:first-child { margin-top: 0; }
-/* (:last-child is new in CSS 3) */
-p:last-child  { margin-bottom: 0; }
 
 h1, h2, h3, h4, h5, h6,
-dl > dd {
+dd, details > p:last-child {
   margin-bottom: 0.5em;
 }
 
 /* Lists */
 /* ===== */
 
-/* Separate list entries in compound lists */
-dl > dd, ol > li,
-
 /* Definition Lists */
 /* Indent lists nested in definition lists */
-/* (:only-child is new in CSS 3)           */
 dd > ul:only-child, dd > ol:only-child { padding-left: 1em; }
 
 /* Description Lists */
 /* styled like in most dictionaries, encyclopedias etc. */
+dl.description {
+  display: flow-root;
+}
 dl.description > dt {
   font-weight: bold;
   clear: left;
   float: left;
   margin: 0;
   padding: 0;
-  padding-right: 0.5em;
+  padding-right: 0.3em;
+}
+dl.description > dd:after {
+  display: table;
+  content: "";
+  clear: left; /* clearfix for empty descriptions */
 }
 
 /* Field Lists */
 
+dl.field-list > dd,
+dl.docinfo > dd {
+  margin-left: var(--field-indent); /* adapted in media queries or HTML */
+}
+
 /* example for custom field-name width */
 dl.field-list.narrow > dd {
-  margin-left: 5em;
+  --field-indent: 5em;
 }
 /* run-in: start field-body on same line after long field names */
 dl.field-list.run-in > dd p {
@@ -106,8 +129,8 @@
 
 /* Bibliographic Fields */
 
-/* generally, bibliographic fields use special definition list dl.docinfo */
-/* but dedication and abstract are placed into "topic" divs */
+/* generally, bibliographic fields use dl.docinfo */
+/* but dedication and abstract are placed into divs */
 div.abstract p.topic-title {
   text-align: center;
 }
@@ -120,6 +143,10 @@
   font-style: normal;
 }
 
+/* disclosures */
+details { padding-left: 1em; }
+summary { margin-left: -1em; }
+
 /* Text Blocks */
 /* =========== */
 
@@ -129,14 +156,10 @@
   font-family: monospace;
 }
 
-/* Block Quotes */
-blockquote > table,
-div.topic > table {
-  margin-top: 0;
-  margin-bottom: 0;
-}
+/* Block Quotes and Topics */
+bockquote { margin: 1em 2em; }
 blockquote p.attribution,
-div.topic p.attribution {
+.topic p.attribution {
   text-align: right;
   margin-left: 20%;
 }
@@ -176,10 +199,9 @@
 /* ----------------------- */
 
 /* line on the left */
-dl.footnote {
-  padding-left: 1ex;
-  border-left: solid;
-  border-left-width: thin;
+.footnote-list {
+  border-left: solid thin;
+  padding-left: 0.25em;
 }
 
 /* Directives */
@@ -233,16 +255,19 @@
 aside.sidebar {
   width: 30%;
   max-width: 26em;
+  float: right;
+  clear: right;
   margin-left: 1em;
-  margin-right: -2%;
-  background-color: #ffffee;
+  margin-right: -1%;
+  background-color: #fffffa;
 }
 
+
 /* Code */
 pre.code { padding: 0.7ex }
 pre.code, code { background-color: #eeeeee }
 /* basic highlighting: for a complete scheme, see */
-/* http://docutils.sourceforge.net/sandbox/stylesheets/ */
+/* https://docutils.sourceforge.io/sandbox/stylesheets/ */
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
 pre.code .literal.string, code .literal.string { color: #0C5404 }
@@ -251,7 +276,14 @@
 pre.code .inserted, code .inserted { background-color: #A3D289}
 
 /* Math */
-/* styled separately (see math.css for math-output=HTML) */
+/* for math-output=MathML (for math-output=HTML, see math.css) */
+math .boldsymbol {
+  font-weight: bold;
+}
+mstyle.mathscr, mi.mathscr {
+  font-family: STIX, XITSMathJax_Script, rsfs10,
+               "Asana Math", Garamond, cursive;
+}
 
 /* Epigraph           */
 /* Highlights         */
@@ -262,6 +294,8 @@
 /* Inline Markup */
 /* ============= */
 
+sup, sub { line-height: 0.8; } /* do not add leading for lines with sup/sub */
+
 /* Inline Literals                                          */
 /* possible values: normal, nowrap, pre, pre-wrap, pre-line */
 /*   span.docutils.literal { white-space: pre-wrap; }       */
@@ -274,6 +308,6 @@
 /* Internal Targets       */
 /*   span.target.internal */
 /* Footnote References    */
-/*   a.footnote-reference */
+/*   arole="doc-noteref" */
 /* Citation References    */
 /*   a.citation-reference */

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/responsive.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/responsive.css Changed

@@ -1,9 +1,9 @@
-/* CSS3_ style sheet for the output of Docutils HTML writers.              */
+/* CSS3_ style sheet for the output of Docutils HTML5 writer.  */
 /* Generic responsive design for all screen sizes.                         */
 /*                                                                         */
 /* :Author: Günter Milde                                                   */
 /*                                                                         */
-/* :Id: $Id: responsive.css 8642 2021-03-26 13:51:14Z milde $                                                               */
+/* :Id: $Id: responsive.css 9338 2023-04-08 21:08:47Z milde $                                                               */
 /* :Copyright: © 2021 Günter Milde.                                        */
 /* :License: Released under the terms of the `2-Clause BSD license`_,      */
 /*    in short:                                                            */
@@ -15,7 +15,12 @@
 /*    This file is offered as-is, without any warranty.                    */
 /*                                                                         */
 /* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
-/* .. _CSS3: http://www.w3.org/TR/CSS3                                     */
+/* .. _CSS3: https://www.w3.org/Style/CSS/                                 */
+
+/* Note:                                                                   */
+/* This style sheet is provisional:                                        */
+/* the API is not settled and may change with any minor Docutils version.  */
+
 
 
 /* General Settings */
@@ -40,27 +45,27 @@
   margin: auto;
   max-width: 100rem;
 }
+sup, sub { /* avoid additional inter-line space for lines with sup/sub */
+  line-height: 1;
+}
 
 /* Vertical Space (Parskip) */
 p, ol, ul, dl, li,
 div.line-block,
-div.topic,
+.topic,
+.footnote, .citation,
+div > math,
 table {
   margin-top: 0.5em;
   margin-bottom: 0.5em;
 }
 h1, h2, h3, h4, h5, h6,
-dl > dd {
+dl > dd, details > p:last-child {
   margin-bottom: 0.5em;
 }
-blockquote > table,
-div.topic > table {
-  margin-top: 0;
-  margin-bottom: 0;
-}
 
 /* Indented Blocks */
-blockquote, figure, div.topic {
+blockquote, figure, .topic {
   margin: 1em 2%;
   padding-left: 1em;
 }
@@ -72,13 +77,12 @@
 /* Object styling */
 /* ============== */
 
-footer, header,
-.sidebar, .marginal {
+footer, header {
   font-size: small;
 }
 
 /* Frontmatter */
-div.topic.dedication {
+div.dedication {
   padding: 0;
   margin: 1.4em 0;
   font-style: italic;
@@ -89,43 +93,37 @@
 }
 
 blockquote p.attribution,
-div.topic p.attribution {
+.topic p.attribution {
   text-align: right;
 }
 
 /* Table of Contents */
-nav.contents,
-div.topic.contents {
-  padding: 0;
-}
-ul.auto-toc > li > p {
+nav.contents ul {
   padding-left: 1em;
-  text-indent: -1em;
 }
-nav.contents ul,
-div.topic.contents ul {
+ul.auto-toc > li > p { /* hanging indent */
   padding-left: 1em;
+  text-indent: -1em;
 }
-main > div.topic.contents  ul:not(.auto-toc) {
+main > nav.contents  ul:not(.auto-toc) {
   list-style-type: square;
 }
-main > div.topic.contents  ul ul:not(.auto-toc) {
+main > nav.contents  ul ul:not(.auto-toc) {
   list-style-type: disc;
 }
-main > div.topic.contents  ul ul ul:not(.auto-toc) {
-  list-style-type: '\2023\ ';
-}
-main > div.topic.contents  ul ul ul ul:not(.auto-toc) {
+main > nav.contents  ul ul ul:not(.auto-toc) {
   list-style-type: '\2B29\ ';
 }
-main > div.topic.contents  ul ul ul ul ul:not(.auto-toc) {
-  list-style-type: '\00B7\ ';
+main > nav.contents  ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B1D\ ';
 }
-div.topic.contents ul > li::marker {
+main > nav.contents  ul ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B2A\ ';
+}
+nav.contents ul > li::marker {
   color: grey;
 }
 
-
 /* Transitions */
 hr {
   margin: 1em 10%;
@@ -148,35 +146,36 @@
   display: block;
 }
 /* "description style" like in most dictionaries, encyclopedias etc. */
+dl.description {
+  display: flow-root;
+}
 dl.description > dt {
   clear: left;
   float: left;
   margin: 0;
   padding: 0;
-  padding-right: 0.5em;
+  padding-right: 0.3em;
   font-weight: bold;
 }
 dl.description > dd:after {
-  display: block;
+  display: table;
   content: "";
-  clear: both;
+  clear: left; /* clearfix for empty descriptions */
 }
 /* start lists nested in description/field lists on new line */
 dd > dl:first-child,
 dd > ul:first-child,
 dd > ol:first-child {
-    clear: left;
+  clear: left;
 }
 
+/* disclosures */
+details { padding-left: 1em; }
+summary { margin-left: -1em; }
+
 /* Footnotes and Citations */
-/* TODO: use <aside> */
-dl.footnote {
+.footnote {
   font-size: small;
-  padding-left: 0.5em;
-  border-left: solid;
-  border-left-width: thin;
-}
-dt.label > span.fn-backref {
 }
 
 /* Images, Figures, and Tables */
@@ -244,8 +243,19 @@
 }
 
 /* Literal and Code */
+pre.literal-block, pre.doctest{
+  padding: 0.2em;
+  overflow-x: auto;
+}
+.literal-block, .doctest, span.literal {
+  background-color: #f6f9f8;
+}
+.system-message span.literal {
+  background-color: inherit;
+}
+
 /* basic highlighting: for a complete scheme, see */
-/* http://docutils.sourceforge.net/sandbox/stylesheets/ */
+/* https://docutils.sourceforge.io/sandbox/stylesheets/ */
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
 pre.code .literal.string, code .literal.string { color: #0C5404 }
@@ -255,27 +265,41 @@
 
 /* Hyperlink References */
 a {
-  text-decoration: none;
-  /* text-decoration-skip-ink: auto; !!nonstandard, default in modern browsers */
-}
-/* Wrap links at any place, if this is the only way to prevent overflow */
-a:link{
+  text-decoration: none; /* for chromium */
+  /* Wrap links at any place, if this is the only way to prevent overflow */
   overflow-wrap: break-word;
 }
 .contents a, a.toc-backref, a.citation-reference {
   overflow-wrap: inherit;
 }
-/* Undecorated Links */
-/* a.footnote-reference, a.fn-backref, .fn-backref a, */
+/* Undecorated Links (see also minimal.css) */
 /* a.citation-reference, */
-.citation a.fn-backref,
-.contents a, a.toc-backref {
+.citation a.fn-backref {
   color: inherit;
 }
-a:link:hover {
-  text-decoration: underline;}
-/* highlight the active ToC entry */
-.topic.contents :target {
+a:hover {
+  text-decoration: underline;
+}
+*:hover > a.toc-backref:after {
+  content: " \2191"; /* ↑ UPWARDS ARROW */
+  color: grey;
+}
+*:hover > a.self-link:after {
+  content: "\1F517"; /* LINK SYMBOL */
+  color: grey;
+  font-size: smaller;
+  margin-left: 0.2em;
+}
+/* highlight the target of the current URL */
+section:target > h2, section:target > h3, section:target > h4,
+section:target > h5, section:target > h6,
+.contents :target,
+.contents:target > .topic-title,
+role="doc-biblioentry":target > .label,
+role="doc-biblioref":target,
+role="note":target, /* Docutils 0.18 ... 0.19 */
+role="doc-footnote":target, /* Docutils >= 0.20 */
+role="doc-noteref":target {
   background-color: #d2e6ec;
 }
 
@@ -283,7 +307,6 @@
 /* Let content flow to the side of aligned images and figures */
 
 /* no floats around this elements */
-dl.footnote, dl.citation, /* errors with internal floats */
 footer, header, hr,
 h1, h2, h3 {
   clear: both;
@@ -319,13 +342,25 @@
   background-color: #efefea;
   margin: 0.5em var(--sidebar-margin-right) 0.5em 1em;
   padding: 0.5em;
+  padding-left: 0.7em;
   clear: right;
   float: right;
+  font-size: small;
 }
 .sidebar {
   width: 40%;
 }
 
+/* Math */
+/* for math-output=MathML (for math-output=HTML, see math.css) */
+math .boldsymbol {
+  font-weight: bold;
+}
+mstyle.mathscr, mi.mathscr {
+  font-family: STIX, XITSMathJax_Script, rsfs10,
+               "Asana Math", Garamond, cursive;
+}
+
 /* Adaptive page layout */
 /* ==================== */
 
@@ -372,7 +407,7 @@
     padding-left: min(22%, 22rem);
     padding-right: 7%;
   }
-  main > div.topic.contents { /* exclude local ToCs */
+  main > nav.contents { /* global ToC */
     position: fixed;
     top: 0;
     left: 0;
@@ -383,8 +418,12 @@
     padding: 1em 2% 0 2%;
     overflow: auto;
   }
-  main > div.topic.contents > * {
+  main > nav.contents > * {
     padding-left: 0;
+    line-height: 1.4;
+  }
+  main > nav.contents a {
+  color: inherit;
   }
 }

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/html5_polyglot/tuftig.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/html5_polyglot/tuftig.css Changed

@@ -5,7 +5,7 @@
 /*          based on tufte.css_ by Dave Liepmann                           */
 /*          and the tufte-latex_ package.                                  */
 /*                                                                         */
-/* :Id: $Id: tuftig.css 8636 2021-03-19 00:23:33Z milde $                                                               */
+/* :Id: $Id: tuftig.css 9319 2023-01-16 09:20:01Z milde $                                                               */
 /* :Copyright: © 2020 Günter Milde.                                        */
 /* :License: Released under the terms of the `2-Clause BSD license`_,      */
 /*    in short:                                                            */
@@ -17,7 +17,7 @@
 /*    This file is offered as-is, without any warranty.                    */
 /*                                                                         */
 /* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
-/* .. _CSS3: http://www.w3.org/TR/CSS3                                     */
+/* .. _CSS3: https://www.w3.org/Style/CSS/                                 */
 /* .. _tufte.css: https://edwardtufte.github.io/tufte-css/                 */
 /* .. _tufte-latex_: https://www.ctan.org/pkg/tufte-latex                  */
 
@@ -26,7 +26,7 @@
 /* ================ */
 
 body {
-  font-family: et-book, Palatino, Georgia, serif;
+  font-family: Georgia, serif;
   background-color: #fafaf6;
   font-size: 1.2em;
   line-height: 1.4;
@@ -45,13 +45,14 @@
 
 /* vertical space (parskip) */
 p, ol, ul, dl, li,
+h1, h2, h3, h4, h5, h6,
 div.line-block,
-div.topic,
+.topic,
+.footnote, .citation,
 table {
   margin-top: 0.5em;
   margin-bottom: 0.5em;
 }
-h1, h2, h3, h4, h5, h6,
 dl > dd {
   margin-bottom: 0.5em;
 }
@@ -62,15 +63,10 @@
 p:last-child {
   margin-bottom: 0;
 }
-blockquote > table,
-div.topic > table {
-  margin-top: 0;
-  margin-bottom: 0;
-}
 
 /* Indented Blocks */
 blockquote,
-div.topic {
+.topic {
   /* background-color: Honeydew; */
   margin: 0.5em 2%;
   padding-left: 1em;
@@ -114,8 +110,8 @@
   margin-bottom: 2em;
   font-size: 2.0em;
 }
-h2, h3, h4 {
-  margin-top: 2.0em;
+section {
+  margin-top: 2em;
 }
 h2, .contents > p.topic-title {
   font-size: 2.2em;
@@ -137,7 +133,7 @@
 }
 
 /* Dedication and Abstract */
-div.topic.dedication {
+div.dedication {
   padding: 0;
   margin-left: 0;
   font-style: italic;
@@ -150,12 +146,12 @@
 
 /* Attribution */
 blockquote p.attribution,
-div.topic p.attribution {
+.topic p.attribution {
   text-align: right;
 }
 
 /* Table of Contents */
-div.topic.contents {
+nav.contents {
   padding: 0;
   font-style: italic;
 }
@@ -163,7 +159,7 @@
   padding-left: 1em;
   text-indent: -1em;
 }
-div.topic.contents ul { 
+nav.contents ul {
   padding-left: 1em;
 }
 
@@ -177,7 +173,7 @@
 
 /* Lists */
 /* Less indent per level */
-ul, ol { 
+ul, ol {
   padding-left: 1.1em;
 }
 dd {
@@ -225,6 +221,18 @@
   clear: both;
 }
 
+/* Citation list (style as description list) */
+.citation-list,
+.footnote-list {
+  display: contents;
+}
+.citation {
+  padding-left: 1.5em;
+}
+.citation .label {
+  margin-left: -1.5em;
+}
+
 /* Images and Figures */
 img {
   display: block;
@@ -249,6 +257,9 @@
 figcaption {
   font-size: 0.8em;
 }
+.fullwidth > figcaption {
+  font-size: inherit;
+}
 figure.numbered > figcaption > p:before {
   counter-increment: figure;
   content: "Figure " counter(figure) ": ";
@@ -276,8 +287,7 @@
 }
 
 /* Admonitions and System Messages */
-.admonition,
-div.system-message {
+.admonition, .system-message {
   border-style: solid;
   border-color: silver;
   border-width: thin;
@@ -300,7 +310,7 @@
   overflow: auto;
 }
 /* basic highlighting: for a complete scheme, see */
-/* http://docutils.sourceforge.net/sandbox/stylesheets/ */
+/* https://docutils.sourceforge.io/sandbox/stylesheets/ */
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
 pre.code .literal.string, code .literal.string { color: #0C5404 }
@@ -324,14 +334,14 @@
 }
 /* undecorated links */
 .contents a:link, a.toc-backref:link, a.image-reference:link,
-a.footnote-reference:link, a.fn-backref:link, .fn-backref a:link,
+arole="doc-noteref":link, arole="doc-backlink":link, .backrefs a:link,
 a.citation-reference:link,
 ahref^="#system-message" {
   text-decoration: none;
 }
 a:link:hover {
   text-decoration: underline;
-}  
+}
 
 /* Block Alignment */
 /* Let content flow to the side of aligned images and figures */
@@ -388,12 +398,6 @@
 
 /* Margin Elements */
 /* see below for screen size dependent rules */
-aside.sidebar {
-  /* overwrite minimal.css */
-  width: auto;
-  max-width: 100%;
-  float: none;
-}
 aside.sidebar,
 .marginal,
 .admonition.marginal,
@@ -405,14 +409,14 @@
   padding: 0.5em;
   font-size: 0.8em;
 }
+aside.sidebar {
+  background-color: inherit;
+}
 figure.marginal > figcaption {
   font-size: 1em;
 }
-dl.footnote {
-  font-size: 0.8em;
-  padding-left: 1ex;
-  border-left: solid;
-  border-left-width: thin;
+.footnote {
+  font-size: smaller;
   overflow: auto;
 }
 
@@ -447,8 +451,8 @@
   /* use the same grid for main, all sections, and figures */
   main, section {
     display: grid;
-    grid-template-columns: content-start minmax(0, 6fr)
-    			   content-end 3fr end;
+    grid-template-columns: content minmax(0, 6fr)
+    			   margin 3fr end;
     grid-column-gap: calc(3em + 1%);
   }
   main > section, section > section {
@@ -463,12 +467,16 @@
   /* Main text elements */
   main > *, section > *,
   figure > img,
-  dl.footnote.align-left, /* override the placement in the margin */
-  dl.citation.align-left {
-    grid-column: content-start / content-end;
+  .footnote.align-left, /* override the placement in the margin */
+  .citation.align-left {
+    grid-column: content;
   }
-  dl.citation.align-left {
+  .citation.align-left {
     font-size: 1em;
+    padding-left: 1.5em;
+  }
+  .citation.align-left .label {
+    margin-left: -1.5em;
   }
   figure > img { /* indent */
     margin: 0.5em 2%;
@@ -478,18 +486,19 @@
   /* Margin Elements */
   /* Sidebar, Footnotes, Citations, Captions */
   aside.sidebar,
-  dl.footnote,
-  dl.citation,
+  .citation,
+  .footnote,
   figcaption,
   /* table > caption,  does not work :(*/
   .marginal,
   .admonition.marginal,
   .topic.marginal {
-    /* background-color: Lavender; */
-    grid-column: content-end / end;
+    /* color: red; */
+    grid-column: margin;
     width: auto;
     max-width: 55em;
     margin: 0.5em 0;
+    border: none;
     padding: 0;
     font-size: 0.8em;
     text-align: initial; /* overwrite align-* */
@@ -502,27 +511,28 @@
     display: block;
     margin: 0.5em 0;
   }
-  dl.footnote {
+  .citation,
+  .footnote {
     padding-left: 0;
-    border-left: none;
   }
-  dl.citation > dd,
-  dl.footnote.superscript > dd {
+  .citation .label,
+  .footnote .label {
     margin-left: 0;
   }
 
   /* Fullwidth Elements */
   h1.title, p.subtitle,
   dl.docinfo,
-  div.topic.abstract,
-  div.topic.dedication,
-  div.topic.contents,
-  div.system-message,
+  div.abstract,
+  div.dedication,
+  nav.contents,
+  aside.system-message,
   pre,
   .fullwidth,
-  .fullwidth img {
+  .fullwidth img,
+  .fullwidth figcaption {
     /* background-color: Linen; */
-    grid-column: content-start / end;
+    grid-column: content / end;
     margin-right: calc(10% - 3rem);
     max-width: 55em;
   }
@@ -534,7 +544,7 @@
   main, header, footer {
     padding-left: 30%;
   }
-  main > div.topic.contents {
+  main > nav.contents {
     position: fixed;
     top: 0;
     left: 0;
@@ -546,12 +556,12 @@
     padding: 5.5em 2%;
     overflow: auto;
   }
-  main > div.topic.contents > * {
+  main > nav.contents > * {
     padding-left: 0;
   }
 }
 
-/* wrap URLs */ 
+/* wrap URLs */
 /*   a:link {    */
 /*     white-space: normal; */
 /*     hyphens: none;	    */

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/__init__.py Changed

@@ -1,5 +1,4 @@
-# .. coding: utf-8
-# $Id: __init__.py 8676 2021-04-08 16:36:09Z milde $
+# $Id: __init__.py 9331 2023-03-25 17:54:40Z aa-turner $
 # Author: Engelbert Gruber, Günter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -13,30 +12,21 @@
 #
 # convention deactivate code by two # i.e. ##.
 
-import os
+from pathlib import Path
 import re
 import string
-import sys
-
-if sys.version_info < (3, 0):
-    from io import open
-    from urllib import url2pathname
-else:
-    from urllib.request import url2pathname
-
+from urllib.request import url2pathname
+import warnings
 try:
     import roman
 except ImportError:
     import docutils.utils.roman as roman
 
-import docutils
 from docutils import frontend, nodes, languages, writers, utils
-from docutils.utils.error_reporting import SafeString
 from docutils.transforms import writer_aux
 from docutils.utils.math import pick_math_environment, unichar2tex
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
+LATEX_WRITER_DIR = Path(__file__).parent
 
 
 class Writer(writers.Writer):
@@ -45,13 +35,14 @@
     """Formats this writer supports."""
 
     default_template = 'default.tex'
-    default_template_path = os.path.dirname(os.path.abspath(__file__))
-    default_preamble = '\n'.join(r'% PDF Standard Fonts',
-                                  r'\usepackage{mathptmx} % Times',
-                                  r'\usepackagescaled=.90{helvet}',
-                                  r'\usepackage{courier}')
-    table_style_values = ('standard', 'booktabs', 'nolines', 'borderless',
-                          'colwidths-auto', 'colwidths-given')
+    default_template_path = LATEX_WRITER_DIR
+    default_preamble = ('% PDF Standard Fonts\n'
+                        '\\usepackage{mathptmx} % Times\n'
+                        '\\usepackagescaled=.90{helvet}\n'
+                        '\\usepackage{courier}')
+    table_style_values =   # TODO: align-left, align-center, align-right, ??
+                          'booktabs', 'borderless', 'colwidths-auto',
+                          'nolines', 'standard'
 
     settings_spec = (
         'LaTeX-Specific Options',
@@ -71,10 +62,10 @@
            'overrides': 'trim_footnote_reference_space'}),
          ('Use \\cite command for citations. (future default)',
           '--use-latex-citations',
-          {'default': False, 'action': 'store_true',
+          {'default': None, 'action': 'store_true',
            'validator': frontend.validate_boolean}),
          ('Use figure floats for citations '
-          '(might get mixed with real figures). (current default)',
+          '(might get mixed with real figures). (provisional default)',
           '--figure-citations',
           {'dest': 'use_latex_citations', 'action': 'store_false',
            'validator': frontend.validate_boolean}),
@@ -178,10 +169,9 @@
           'Default: "" (fall back to "alltt").',
           '--literal-block-env',
           {'default': ''}),
-         ('When possible, use "verbatim" for literal-blocks. '
-          'Compatibility alias for "--literal-block-env=verbatim".',
+         ('Deprecated alias for "--literal-block-env=verbatim".',
           '--use-verbatim-when-possible',
-          {'default': False, 'action': 'store_true',
+          {'action': 'store_true',
            'validator': frontend.validate_boolean}),
          ('Table style. "standard" with horizontal and vertical lines, '
           '"booktabs" (LaTeX booktabs style) only horizontal lines '
@@ -209,33 +199,47 @@
           'number or the page number.',
           '--reference-label',
           {'default': ''}),
-         ('Specify style and database for bibtex, for example '
-          '"--use-bibtex=mystyle,mydb1,mydb2".',
+         ('Specify style and database(s) for bibtex, for example '
+          '"--use-bibtex=unsrt,mydb1,mydb2". Provisional!',
           '--use-bibtex',
-          {'default': ''}),
+          {'default': '',
+           'metavar': '<style,bibfile,bibfile,...>',
+           'validator': frontend.validate_comma_separated_list}),
          ('Use legacy functions with class value list for '
-          '\\DUtitle and \\DUadmonition (current default). ',
+          '\\DUtitle and \\DUadmonition.',
           '--legacy-class-functions',
-          {'default': True,
+          {'default': False,
            'action': 'store_true',
            'validator': frontend.validate_boolean}),
          ('Use \\DUrole and "DUclass" wrappers for class values. '
-          'Place admonition content in an environment (future default).',
+          'Place admonition content in an environment. (default)',
           '--new-class-functions',
           {'dest': 'legacy_class_functions',
            'action': 'store_false',
            'validator': frontend.validate_boolean}),
+         ('Use legacy algorithm to determine table column widths. '
+          '(provisional default)',
+          '--legacy-column-widths',
+          {'default': None,
+           'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ('Use new algorithm to determine table column widths. '
+          '(future default)',
+          '--new-column-widths',
+          {'dest': 'legacy_column_widths',
+           'action': 'store_false',
+           'validator': frontend.validate_boolean}),
          # TODO: implement "latex footnotes" alternative
          ('Footnotes with numbers/symbols by Docutils. (default) '
           '(The alternative, --latex-footnotes, is not implemented yet.)',
-           '--docutils-footnotes',
-           {'default': True,
-            'action': 'store_true',
-            'validator': frontend.validate_boolean}),
-        ),)
+          '--docutils-footnotes',
+          {'default': True,
+           'action': 'store_true',
+           'validator': frontend.validate_boolean}),
+         ),
+        )
 
-    settings_defaults = {'sectnum_depth': 0 # updated by SectNum transform
-                        }
+    settings_defaults = {'sectnum_depth': 0}  # updated by SectNum transform
     config_section = 'latex2e writer'
     config_section_dependencies = ('writers', 'latex writers')
 
@@ -252,13 +256,13 @@
         writers.Writer.__init__(self)
         self.translator_class = LaTeXTranslator
 
-    # Override parent method to add latex-specific transforms
     def get_transforms(self):
-       return writers.Writer.get_transforms(self) + 
-       # Convert specific admonitions to generic one
-       writer_aux.Admonitions,
-       # TODO: footnote collection transform
-       
+        # Override parent method to add latex-specific transforms
+        return super().get_transforms() + 
+                   # Convert specific admonitions to generic one
+                   writer_aux.Admonitions,
+                   # TODO: footnote collection transform
+                   
 
     def translate(self):
         visitor = self.translator_class(self.document)
@@ -267,17 +271,13 @@
         for part in self.visitor_attributes:
             setattr(self, part, getattr(visitor, part))
         # get template string from file
-        try:
-            template_file = open(self.document.settings.template,
-                                 encoding='utf8')
-        except IOError:
-            template_file = open(os.path.join(self.default_template_path,
-                    self.document.settings.template), encoding= 'utf8')
-        template = string.Template(template_file.read())
-        template_file.close()
+        templatepath = Path(self.document.settings.template)
+        if not templatepath.exists():
+            templatepath = self.default_template_path / templatepath
+        template = templatepath.read_text(encoding='utf-8')
         # fill template
-        self.assemble_parts() # create dictionary of parts
-        self.output = template.substitute(self.parts)
+        self.assemble_parts()  # create dictionary of parts
+        self.output = string.Template(template).substitute(self.parts)
 
     def assemble_parts(self):
         """Assemble the `self.parts` dictionary of output fragments."""
@@ -286,29 +286,29 @@
             lines = getattr(self, part)
             if part in self.head_parts:
                 if lines:
-                    lines.append('') # to get a trailing newline
+                    lines.append('')  # to get a trailing newline
                 self.partspart = '\n'.join(lines)
             else:
                 # body contains inline elements, so join without newline
                 self.partspart = ''.join(lines)
 
 
-class Babel(object):
+class Babel:
     """Language specifics for LaTeX."""
 
     # TeX (babel) language names:
     # ! not all of these are supported by Docutils!
     #
     # based on LyX' languages file with adaptions to `BCP 47`_
-    # (http://www.rfc-editor.org/rfc/bcp/bcp47.txt) and
+    # (https://www.rfc-editor.org/rfc/bcp/bcp47.txt) and
     # http://www.tug.org/TUGboat/Articles/tb29-3/tb93miklavec.pdf
     # * the key without subtags is the default
     # * case is ignored
-    # cf. http://docutils.sourceforge.net/docs/howto/i18n.html
-    #     http://www.w3.org/International/articles/language-tags/
+    # cf. https://docutils.sourceforge.io/docs/howto/i18n.html
+    #     https://www.w3.org/International/articles/language-tags/
     # and http://www.iana.org/assignments/language-subtag-registry
     language_codes = {
-        # code          TeX/Babel-name       comment
+        # code          TeX/Babel-name    comment
         'af':           'afrikaans',
         'ar':           'arabic',
         # 'be':           'belarusian',
@@ -319,14 +319,14 @@
         'cs':           'czech',
         'cy':           'welsh',
         'da':           'danish',
-        'de':           'ngerman', # new spelling (de_1996)
-        'de-1901':      'german', # old spelling
+        'de':           'ngerman',        # new spelling (de_1996)
+        'de-1901':      'german',         # old spelling
         'de-AT':        'naustrian',
         'de-AT-1901':   'austrian',
         'dsb':          'lowersorbian',
-        'el':           'greek', # monotonic (el-monoton)
+        'el':           'greek',          # monotonic (el-monoton)
         'el-polyton':   'polutonikogreek',
-        'en':           'english',  # TeX' default language
+        'en':           'english',        # TeX' default language
         'en-AU':        'australian',
         'en-CA':        'canadian',
         'en-GB':        'british',
@@ -340,16 +340,16 @@
         'fi':           'finnish',
         'fr':           'french',
         'fr-CA':        'canadien',
-        'ga':           'irish',    # Irish Gaelic
-        # 'grc':                    # Ancient Greek
-        'grc-ibycus':   'ibycus',   # Ibycus encoding
+        'ga':           'irish',          # Irish Gaelic
+        # 'grc':                          # Ancient Greek
+        'grc-ibycus':   'ibycus',         # Ibycus encoding
         'gl':           'galician',
         'he':           'hebrew',
         'hr':           'croatian',
         'hsb':          'uppersorbian',
         'hu':           'magyar',
         'ia':           'interlingua',
-        'id':           'bahasai',  # Bahasa (Indonesian)
+        'id':           'bahasai',        # Bahasa (Indonesian)
         'is':           'icelandic',
         'it':           'italian',
         'ja':           'japanese',
@@ -357,25 +357,25 @@
         'la':           'latin',
         'lt':           'lithuanian',
         'lv':           'latvian',
-        'mn':           'mongolian', # Mongolian, Cyrillic script (mn-cyrl)
-        'ms':           'bahasam',   # Bahasa (Malay)
-        'nb':           'norsk',     # Norwegian Bokmal
+        'mn':           'mongolian',      # Mongolian, Cyrillic (mn-cyrl)
+        'ms':           'bahasam',        # Bahasa (Malay)
+        'nb':           'norsk',          # Norwegian Bokmal
         'nl':           'dutch',
-        'nn':           'nynorsk',   # Norwegian Nynorsk
-        'no':           'norsk',     # Norwegian (Bokmal)
+        'nn':           'nynorsk',        # Norwegian Nynorsk
+        'no':           'norsk',          # Norwegian (Bokmal)
         'pl':           'polish',
         'pt':           'portuges',
         'pt-BR':        'brazil',
         'ro':           'romanian',
         'ru':           'russian',
-        'se':           'samin',     # North Sami
-        'sh-Cyrl':      'serbianc',  # Serbo-Croatian, Cyrillic script
-        'sh-Latn':      'serbian',   # Serbo-Croatian, Latin script see also 'hr'
+        'se':           'samin',          # North Sami
+        'sh-Cyrl':      'serbianc',       # Serbo-Croatian, Cyrillic
+        'sh-Latn':      'serbian',        # Serbo-Croatian, Latin (cf. 'hr')
         'sk':           'slovak',
         'sl':           'slovene',
         'sq':           'albanian',
-        'sr':           'serbianc',  # Serbian, Cyrillic script (contributed)
-        'sr-Latn':      'serbian',   # Serbian, Latin script
+        'sr':           'serbianc',       # Serbian, Cyrillic (contributed)
+        'sr-Latn':      'serbian',        # Serbian, Latin script
         'sv':           'swedish',
         # 'th':           'thai',
         'tr':           'turkish',
@@ -384,7 +384,7 @@
         # zh-Latn:      Chinese Pinyin
         }
     # normalize (downcase) keys
-    language_codes = dict((k.lower(), v) for (k, v) in language_codes.items())
+    language_codes = {k.lower(): v for k, v in language_codes.items()}
 
     warn_msg = 'Language "%s" not supported by LaTeX (babel)'
 
@@ -401,15 +401,16 @@
     #    ngerman, norsk, nynorsk, polish, portuges, russian, serbian, slovak,
     #    slovene, spanish, swedish, ukrainian, and uppersorbian --
     #    is escaped as ``\textquotedbl``.
-    active_chars = {# TeX/Babel-name:  active characters to deactivate
-                    # 'breton':        ':;!?' # ensure whitespace
+    active_chars = {
+                    # TeX/Babel-name:  active characters to deactivate
+                    # 'breton':        ':;!?'  # ensure whitespace
                     # 'esperanto':     '^',
                     # 'estonian':      '~"`',
-                    # 'french':        ':;!?' # ensure whitespace
-                    'galician':        '.<>', # also '~"'
-                    # 'magyar':        '`', # for special hyphenation cases
-                    'spanish':         '.<>', # old versions also '~'
-                    # 'turkish':       ':!=' # ensure whitespace
+                    # 'french':        ':;!?'  # ensure whitespace
+                    'galician':        '.<>',  # also '~"'
+                    # 'magyar':        '`',  # for special hyphenation cases
+                    'spanish':         '.<>',  # old versions also '~'
+                    # 'turkish':       ':!='  # ensure whitespace
                    }
 
     def __init__(self, language_code, reporter=None):
@@ -424,7 +425,7 @@
         self.setup = r'\usepackage%s{babel}' % ','.join(languages)
         # Deactivate "active characters"
         shorthands = 
-        for c in ''.join(self.active_chars.get(l, '') for l in languages):
+        for c in ''.join(self.active_chars.get(lng, '') for lng in languages):
             if c not in shorthands:
                 shorthands.append(c)
         if shorthands:
@@ -441,8 +442,8 @@
             self.setup.extend(r'\makeatletter',
                                r'  \addto\extrasbasque{\bbl@deactivate{~}}',
                                r'\makeatother')
-        if (languages-1 == 'english' and
-            'french' in self.otherlanguages.keys()):
+        if (languages-1 == 'english'
+            and 'french' in self.otherlanguages.keys()):
             self.setup += '% Prevent side-effects if French hyphenation '
                            'patterns are not loaded:',
                            r'\frenchbsetup{StandardLayout}',
@@ -477,8 +478,7 @@
     """
     def sortedkeys(self):
         """Return sorted list of keys"""
-        keys = sorted(self.keys())
-        return keys
+        return sorted(self.keys())
 
     def sortedvalues(self):
         """Return list of values sorted by keys"""
@@ -494,10 +494,11 @@
 #    \providelength and \provideenvironment commands.
 #    However, it is pretty non-standard (texlive-latex-extra).
 
-class PreambleCmds(object):
+class PreambleCmds:
     """Building blocks for the latex preamble."""
 
-# Requirements
+
+# Requirements and Setup
 
 PreambleCmds.color = r"""\usepackage{color}"""
 
@@ -518,6 +519,10 @@
 \setlength{\extrarowheight}{2pt}
 \newlength{\DUtablewidth} % internal use in tables"""
 
+PreambleCmds.table_columnwidth = (
+    r'\newcommand{\DUcolumnwidth}1'
+    r'{\dimexpr#1\DUtablewidth-2\tabcolsep\relax}')
+
 PreambleCmds.textcomp = r"""\usepackage{textcomp} % text symbol macros"""
 # TODO? Options force,almostfull prevent spurious error messages,
 # see de.comp.text.tex/2005-12/msg01855
@@ -557,6 +562,20 @@
   \fi
 }"""
 
+PreambleCmds.toc_list = r"""
+\providecommand*{\DUCLASScontents}{%
+  \renewenvironment{itemize}%
+    {\begin{list}{}{\setlength{\partopsep}{0pt}
+                    \setlength{\parsep}{0pt}}
+                   }%
+    {\end{list}}%
+}"""
+
+PreambleCmds.ttem = r"""
+% character width in monospaced font
+\newlength{\ttemwidth}
+\settowidth{\ttemwidth}{\ttfamily M}"""
+
 ## PreambleCmds.caption = r"""% configure caption layout
 ## \usepackage{caption}
 ## \captionsetup{singlelinecheck=false}% no exceptions for one-liners"""
@@ -565,16 +584,15 @@
 # Definitions from docutils.sty::
 
 def _read_block(fp):
-    block = next(fp) # first line (empty)
+    block = next(fp)  # first line (empty)
     for line in fp:
         if not line.strip():
             break
         block.append(line)
     return ''.join(block).rstrip()
 
-_du_sty = os.path.join(os.path.dirname(os.path.abspath(__file__)),
-                      'docutils.sty')
-with open(_du_sty, encoding='utf8') as fp:
+
+with open(LATEX_WRITER_DIR/'docutils.sty', encoding='utf-8') as fp:
     for line in fp:
         line = line.strip('% \n')
         if not line.endswith('::'):
@@ -594,170 +612,174 @@
 # -------------------
 # ::
 
-class CharMaps(object):
+class CharMaps:
     """LaTeX representations for active and Unicode characters."""
 
     # characters that need escaping even in `alltt` environments:
     alltt = {
-        ord('\\'): u'\\textbackslash{}',
-        ord('{'): u'\\{',
-        ord('}'): u'\\}',
+        ord('\\'): '\\textbackslash{}',
+        ord('{'): '\\{',
+        ord('}'): '\\}',
     }
     # characters that normally need escaping:
     special = {
-        ord('#'): u'\\#',
-        ord('$'): u'\\$',
-        ord('%'): u'\\%',
-        ord('&'): u'\\&',
-        ord('~'): u'\\textasciitilde{}',
-        ord('_'): u'\\_',
-        ord('^'): u'\\textasciicircum{}',
+        ord('#'): '\\#',
+        ord('$'): '\\$',
+        ord('%'): '\\%',
+        ord('&'): '\\&',
+        ord('~'): '\\textasciitilde{}',
+        ord('_'): '\\_',
+        ord('^'): '\\textasciicircum{}',
         # straight double quotes are 'active' in many languages
-        ord('"'): u'\\textquotedbl{}',
+        ord('"'): '\\textquotedbl{}',
         # Square brackets are ordinary chars and cannot be escaped with '\',
         # so we put them in a group '{}'. (Alternative: ensure that all
         # macros with optional arguments are terminated with {} and text
         # inside any optional argument is put in a group ``{text}``).
         # Commands with optional args inside an optional arg must be put in a
         # group, e.g. ``\item{\hyperreflabel{text}}``.
-        ord(''): u'{}',
-        ord(''): u'{}',
+        ord(''): '{}',
+        ord(''): '{}',
         # the soft hyphen is unknown in 8-bit text
         # and not properly handled by XeTeX
-        0x00AD: u'\\-', # SOFT HYPHEN
+        0x00AD: '\\-',  # SOFT HYPHEN
     }
     # Unicode chars that are not recognized by LaTeX's utf8 encoding
     unsupported_unicode = {
         # TODO: ensure white space also at the beginning of a line?
-        # 0x00A0: u'\\leavevmode\\nobreak\\vadjust{}~'
-        0x2000: u'\\enskip', # EN QUAD
-        0x2001: u'\\quad', # EM QUAD
-        0x2002: u'\\enskip', # EN SPACE
-        0x2003: u'\\quad', # EM SPACE
-        0x2008: u'\\,', # PUNCTUATION SPACE   
-        0x200b: u'\\hspace{0pt}', # ZERO WIDTH SPACE
-        0x202F: u'\\,', # NARROW NO-BREAK SPACE
-        # 0x02d8: u'\\\u{ }', # BREVE
-        0x2011: u'\\hbox{-}', # NON-BREAKING HYPHEN
-        0x212b: u'\\AA', # ANGSTROM SIGN
-        0x21d4: u'\\ensuremath{\\Leftrightarrow}',
+        # 0x00A0: '\\leavevmode\\nobreak\\vadjust{}~'
+        0x2000: '\\enskip',                        # EN QUAD
+        0x2001: '\\quad',                          # EM QUAD
+        0x2002: '\\enskip',                        # EN SPACE
+        0x2003: '\\quad',                          # EM SPACE
+        0x2008: '\\,',                             # PUNCTUATION SPACE
+        0x200b: '\\hspace{0pt}',                   # ZERO WIDTH SPACE
+        0x202F: '\\,',                             # NARROW NO-BREAK SPACE
+        # 0x02d8: '\\\u{ }',                       # BREVE
+        0x2011: '\\hbox{-}',                       # NON-BREAKING HYPHEN
+        0x212b: '\\AA',                            # ANGSTROM SIGN
+        0x21d4: '\\ensuremath{\\Leftrightarrow}',  # LEFT RIGHT DOUBLE ARROW
+        0x2260: '\\ensuremath{\\neq}',             # NOT EQUAL TO
+        0x2261: '\\ensuremath{\\equiv}',           # IDENTICAL TO
+        0x2264: '\\ensuremath{\\le}',              # LESS-THAN OR EQUAL TO
+        0x2265: '\\ensuremath{\\ge}',              # GREATER-THAN OR EQUAL TO
         # Docutils footnote symbols:
-        0x2660: u'\\ensuremath{\\spadesuit}',
-        0x2663: u'\\ensuremath{\\clubsuit}',
-        0xfb00: u'ff', # LATIN SMALL LIGATURE FF
-        0xfb01: u'fi', # LATIN SMALL LIGATURE FI
-        0xfb02: u'fl', # LATIN SMALL LIGATURE FL
-        0xfb03: u'ffi', # LATIN SMALL LIGATURE FFI
-        0xfb04: u'ffl', # LATIN SMALL LIGATURE FFL
+        0x2660: '\\ensuremath{\\spadesuit}',
+        0x2663: '\\ensuremath{\\clubsuit}',
+        0xfb00: 'ff',                              # LATIN SMALL LIGATURE FF
+        0xfb01: 'fi',                              # LATIN SMALL LIGATURE FI
+        0xfb02: 'fl',                              # LATIN SMALL LIGATURE FL
+        0xfb03: 'ffi',                             # LATIN SMALL LIGATURE FFI
+        0xfb04: 'ffl',                             # LATIN SMALL LIGATURE FFL
     }
     # Unicode chars that are recognized by LaTeX's utf8 encoding
     utf8_supported_unicode = {
-        0x00A0: u'~', # NO-BREAK SPACE
-        0x00AB: u'\\guillemotleft{}', # LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
-        0x00bb: u'\\guillemotright{}', # RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
-        0x200C: u'\\textcompwordmark{}', # ZERO WIDTH NON-JOINER
-        0x2013: u'\\textendash{}',
-        0x2014: u'\\textemdash{}',
-        0x2018: u'\\textquoteleft{}',
-        0x2019: u'\\textquoteright{}',
-        0x201A: u'\\quotesinglbase{}', # SINGLE LOW-9 QUOTATION MARK
-        0x201C: u'\\textquotedblleft{}',
-        0x201D: u'\\textquotedblright{}',
-        0x201E: u'\\quotedblbase{}', # DOUBLE LOW-9 QUOTATION MARK
-        0x2030: u'\\textperthousand{}',   # PER MILLE SIGN
-        0x2031: u'\\textpertenthousand{}', # PER TEN THOUSAND SIGN
-        0x2039: u'\\guilsinglleft{}',
-        0x203A: u'\\guilsinglright{}',
-        0x2423: u'\\textvisiblespace{}',  # OPEN BOX
-        0x2020: u'\\dag{}',
-        0x2021: u'\\ddag{}',
-        0x2026: u'\\dots{}',
-        0x2122: u'\\texttrademark{}',
+        0x00A0: '~',                   # NO-BREAK SPACE
+        0x00AB: '\\guillemotleft{}',   # LEFT-POINTING DOUBLE ANGLE QUOTATION
+        0x00bb: '\\guillemotright{}',  # RIGHT-POINTING DOUBLE ANGLE QUOTATION
+        0x200C: '\\textcompwordmark{}',  # ZERO WIDTH NON-JOINER
+        0x2013: '\\textendash{}',
+        0x2014: '\\textemdash{}',
+        0x2018: '\\textquoteleft{}',
+        0x2019: '\\textquoteright{}',
+        0x201A: '\\quotesinglbase{}',    # SINGLE LOW-9 QUOTATION MARK
+        0x201C: '\\textquotedblleft{}',
+        0x201D: '\\textquotedblright{}',
+        0x201E: '\\quotedblbase{}',      # DOUBLE LOW-9 QUOTATION MARK
+        0x2030: '\\textperthousand{}',   # PER MILLE SIGN
+        0x2031: '\\textpertenthousand{}',  # PER TEN THOUSAND SIGN
+        0x2039: '\\guilsinglleft{}',
+        0x203A: '\\guilsinglright{}',
+        0x2423: '\\textvisiblespace{}',  # OPEN BOX
+        0x2020: '\\dag{}',
+        0x2021: '\\ddag{}',
+        0x2026: '\\dots{}',
+        0x2122: '\\texttrademark{}',
     }
     # recognized with 'utf8', if textcomp is loaded
     textcomp = {
         # Latin-1 Supplement
-        0x00a2: u'\\textcent{}',          # ¢ CENT SIGN
-        0x00a4: u'\\textcurrency{}',      # ¤ CURRENCY SYMBOL
-        0x00a5: u'\\textyen{}',           # ¥ YEN SIGN
-        0x00a6: u'\\textbrokenbar{}',     # ¦ BROKEN BAR
-        0x00a7: u'\\textsection{}',       # § SECTION SIGN
-        0x00a8: u'\\textasciidieresis{}', # ¨ DIAERESIS
-        0x00a9: u'\\textcopyright{}',     # © COPYRIGHT SIGN
-        0x00aa: u'\\textordfeminine{}',   # ª FEMININE ORDINAL INDICATOR
-        0x00ac: u'\\textlnot{}',          # ¬ NOT SIGN
-        0x00ae: u'\\textregistered{}',    # ® REGISTERED SIGN
-        0x00af: u'\\textasciimacron{}',   # ¯ MACRON
-        0x00b0: u'\\textdegree{}',        # ° DEGREE SIGN
-        0x00b1: u'\\textpm{}',            # ± PLUS-MINUS SIGN
-        0x00b2: u'\\texttwosuperior{}',   # ² SUPERSCRIPT TWO
-        0x00b3: u'\\textthreesuperior{}', # ³ SUPERSCRIPT THREE
-        0x00b4: u'\\textasciiacute{}',    # ´ ACUTE ACCENT
-        0x00b5: u'\\textmu{}',            # µ MICRO SIGN
-        0x00b6: u'\\textparagraph{}',     # ¶ PILCROW SIGN # != \textpilcrow
-        0x00b9: u'\\textonesuperior{}',   # ¹ SUPERSCRIPT ONE
-        0x00ba: u'\\textordmasculine{}',  # º MASCULINE ORDINAL INDICATOR
-        0x00bc: u'\\textonequarter{}',    # 1/4 FRACTION
-        0x00bd: u'\\textonehalf{}',       # 1/2 FRACTION
-        0x00be: u'\\textthreequarters{}', # 3/4 FRACTION
-        0x00d7: u'\\texttimes{}',         # × MULTIPLICATION SIGN
-        0x00f7: u'\\textdiv{}',           # ÷ DIVISION SIGN
+        0x00a2: '\\textcent{}',              # ¢ CENT SIGN
+        0x00a4: '\\textcurrency{}',          # ¤ CURRENCY SYMBOL
+        0x00a5: '\\textyen{}',               # ¥ YEN SIGN
+        0x00a6: '\\textbrokenbar{}',         # ¦ BROKEN BAR
+        0x00a7: '\\textsection{}',           # § SECTION SIGN
+        0x00a8: '\\textasciidieresis{}',     # ¨ DIAERESIS
+        0x00a9: '\\textcopyright{}',         # © COPYRIGHT SIGN
+        0x00aa: '\\textordfeminine{}',       # ª FEMININE ORDINAL INDICATOR
+        0x00ac: '\\textlnot{}',              # ¬ NOT SIGN
+        0x00ae: '\\textregistered{}',        # ® REGISTERED SIGN
+        0x00af: '\\textasciimacron{}',       # ¯ MACRON
+        0x00b0: '\\textdegree{}',            # ° DEGREE SIGN
+        0x00b1: '\\textpm{}',                # ± PLUS-MINUS SIGN
+        0x00b2: '\\texttwosuperior{}',       # ² SUPERSCRIPT TWO
+        0x00b3: '\\textthreesuperior{}',     # ³ SUPERSCRIPT THREE
+        0x00b4: '\\textasciiacute{}',        # ´ ACUTE ACCENT
+        0x00b5: '\\textmu{}',                # µ MICRO SIGN
+        0x00b6: '\\textparagraph{}',         # ¶ PILCROW SIGN # != \textpilcrow
+        0x00b9: '\\textonesuperior{}',       # ¹ SUPERSCRIPT ONE
+        0x00ba: '\\textordmasculine{}',      # º MASCULINE ORDINAL INDICATOR
+        0x00bc: '\\textonequarter{}',        # 1/4 FRACTION
+        0x00bd: '\\textonehalf{}',           # 1/2 FRACTION
+        0x00be: '\\textthreequarters{}',     # 3/4 FRACTION
+        0x00d7: '\\texttimes{}',             # × MULTIPLICATION SIGN
+        0x00f7: '\\textdiv{}',               # ÷ DIVISION SIGN
         # others
-        0x0192: u'\\textflorin{}',        # LATIN SMALL LETTER F WITH HOOK
-        0x02b9: u'\\textasciiacute{}',    # MODIFIER LETTER PRIME
-        0x02ba: u'\\textacutedbl{}',      # MODIFIER LETTER DOUBLE PRIME
-        0x2016: u'\\textbardbl{}',        # DOUBLE VERTICAL LINE
-        0x2022: u'\\textbullet{}',        # BULLET
-        0x2032: u'\\textasciiacute{}',    # PRIME
-        0x2033: u'\\textacutedbl{}',      # DOUBLE PRIME
-        0x2035: u'\\textasciigrave{}',    # REVERSED PRIME
-        0x2036: u'\\textgravedbl{}',      # REVERSED DOUBLE PRIME
-        0x203b: u'\\textreferencemark{}', # REFERENCE MARK
-        0x203d: u'\\textinterrobang{}',   # INTERROBANG
-        0x2044: u'\\textfractionsolidus{}', # FRACTION SLASH
-        0x2045: u'\\textlquill{}',        # LEFT SQUARE BRACKET WITH QUILL
-        0x2046: u'\\textrquill{}',        # RIGHT SQUARE BRACKET WITH QUILL
-        0x2052: u'\\textdiscount{}',      # COMMERCIAL MINUS SIGN
-        0x20a1: u'\\textcolonmonetary{}', # COLON SIGN
-        0x20a3: u'\\textfrenchfranc{}',   # FRENCH FRANC SIGN
-        0x20a4: u'\\textlira{}',          # LIRA SIGN
-        0x20a6: u'\\textnaira{}',         # NAIRA SIGN
-        0x20a9: u'\\textwon{}',           # WON SIGN
-        0x20ab: u'\\textdong{}',          # DONG SIGN
-        0x20ac: u'\\texteuro{}',          # EURO SIGN
-        0x20b1: u'\\textpeso{}',          # PESO SIGN
-        0x20b2: u'\\textguarani{}',       # GUARANI SIGN
-        0x2103: u'\\textcelsius{}',       # DEGREE CELSIUS
-        0x2116: u'\\textnumero{}',        # NUMERO SIGN
-        0x2117: u'\\textcircledP{}',      # SOUND RECORDING COYRIGHT
-        0x211e: u'\\textrecipe{}',        # PRESCRIPTION TAKE
-        0x2120: u'\\textservicemark{}',   # SERVICE MARK
-        0x2122: u'\\texttrademark{}',     # TRADE MARK SIGN
-        0x2126: u'\\textohm{}',           # OHM SIGN
-        0x2127: u'\\textmho{}',           # INVERTED OHM SIGN
-        0x212e: u'\\textestimated{}',     # ESTIMATED SYMBOL
-        0x2190: u'\\textleftarrow{}',     # LEFTWARDS ARROW
-        0x2191: u'\\textuparrow{}',       # UPWARDS ARROW
-        0x2192: u'\\textrightarrow{}',    # RIGHTWARDS ARROW
-        0x2193: u'\\textdownarrow{}',     # DOWNWARDS ARROW
-        0x2212: u'\\textminus{}',         # MINUS SIGN
-        0x2217: u'\\textasteriskcentered{}', # ASTERISK OPERATOR
-        0x221a: u'\\textsurd{}',          # SQUARE ROOT
-        0x2422: u'\\textblank{}',         # BLANK SYMBOL
-        0x25e6: u'\\textopenbullet{}',    # WHITE BULLET
-        0x25ef: u'\\textbigcircle{}',     # LARGE CIRCLE
-        0x266a: u'\\textmusicalnote{}',   # EIGHTH NOTE
-        0x26ad: u'\\textmarried{}',       # MARRIAGE SYMBOL
-        0x26ae: u'\\textdivorced{}',      # DIVORCE SYMBOL
-        0x27e8: u'\\textlangle{}',        # MATHEMATICAL LEFT ANGLE BRACKET
-        0x27e9: u'\\textrangle{}',        # MATHEMATICAL RIGHT ANGLE BRACKET
+        0x0192: '\\textflorin{}',            # LATIN SMALL LETTER F WITH HOOK
+        0x02b9: '\\textasciiacute{}',        # MODIFIER LETTER PRIME
+        0x02ba: '\\textacutedbl{}',          # MODIFIER LETTER DOUBLE PRIME
+        0x2016: '\\textbardbl{}',            # DOUBLE VERTICAL LINE
+        0x2022: '\\textbullet{}',            # BULLET
+        0x2032: '\\textasciiacute{}',        # PRIME
+        0x2033: '\\textacutedbl{}',          # DOUBLE PRIME
+        0x2035: '\\textasciigrave{}',        # REVERSED PRIME
+        0x2036: '\\textgravedbl{}',          # REVERSED DOUBLE PRIME
+        0x203b: '\\textreferencemark{}',     # REFERENCE MARK
+        0x203d: '\\textinterrobang{}',       # INTERROBANG
+        0x2044: '\\textfractionsolidus{}',   # FRACTION SLASH
+        0x2045: '\\textlquill{}',            # LEFT SQUARE BRACKET WITH QUILL
+        0x2046: '\\textrquill{}',            # RIGHT SQUARE BRACKET WITH QUILL
+        0x2052: '\\textdiscount{}',          # COMMERCIAL MINUS SIGN
+        0x20a1: '\\textcolonmonetary{}',     # COLON SIGN
+        0x20a3: '\\textfrenchfranc{}',       # FRENCH FRANC SIGN
+        0x20a4: '\\textlira{}',              # LIRA SIGN
+        0x20a6: '\\textnaira{}',             # NAIRA SIGN
+        0x20a9: '\\textwon{}',               # WON SIGN
+        0x20ab: '\\textdong{}',              # DONG SIGN
+        0x20ac: '\\texteuro{}',              # EURO SIGN
+        0x20b1: '\\textpeso{}',              # PESO SIGN
+        0x20b2: '\\textguarani{}',           # GUARANI SIGN
+        0x2103: '\\textcelsius{}',           # DEGREE CELSIUS
+        0x2116: '\\textnumero{}',            # NUMERO SIGN
+        0x2117: '\\textcircledP{}',          # SOUND RECORDING COPYRIGHT
+        0x211e: '\\textrecipe{}',            # PRESCRIPTION TAKE
+        0x2120: '\\textservicemark{}',       # SERVICE MARK
+        0x2122: '\\texttrademark{}',         # TRADE MARK SIGN
+        0x2126: '\\textohm{}',               # OHM SIGN
+        0x2127: '\\textmho{}',               # INVERTED OHM SIGN
+        0x212e: '\\textestimated{}',         # ESTIMATED SYMBOL
+        0x2190: '\\textleftarrow{}',         # LEFTWARDS ARROW
+        0x2191: '\\textuparrow{}',           # UPWARDS ARROW
+        0x2192: '\\textrightarrow{}',        # RIGHTWARDS ARROW
+        0x2193: '\\textdownarrow{}',         # DOWNWARDS ARROW
+        0x2212: '\\textminus{}',             # MINUS SIGN
+        0x2217: '\\textasteriskcentered{}',  # ASTERISK OPERATOR
+        0x221a: '\\textsurd{}',              # SQUARE ROOT
+        0x2422: '\\textblank{}',             # BLANK SYMBOL
+        0x25e6: '\\textopenbullet{}',        # WHITE BULLET
+        0x25ef: '\\textbigcircle{}',         # LARGE CIRCLE
+        0x266a: '\\textmusicalnote{}',       # EIGHTH NOTE
+        0x26ad: '\\textmarried{}',           # MARRIAGE SYMBOL
+        0x26ae: '\\textdivorced{}',          # DIVORCE SYMBOL
+        0x27e8: '\\textlangle{}',            # MATHEMATICAL LEFT ANGLE BRACKET
+        0x27e9: '\\textrangle{}',            # MATHEMATICAL RIGHT ANGLE BRACKET
     }
     # Unicode chars that require a feature/package to render
     pifont = {
-        0x2665: u'\\ding{170}',     # black heartsuit
-        0x2666: u'\\ding{169}',     # black diamondsuit
-        0x2713: u'\\ding{51}',      # check mark
-        0x2717: u'\\ding{55}',      # check mark
+        0x2665: '\\ding{170}',               # black heartsuit
+        0x2666: '\\ding{169}',               # black diamondsuit
+        0x2713: '\\ding{51}',                # check mark
+        0x2717: '\\ding{55}',                # check mark
     }
     # TODO: greek alphabet ... ?
     # see also LaTeX codec
@@ -765,7 +787,7 @@
     # and unimap.py from TeXML
 
 
-class DocumentClass(object):
+class DocumentClass:
     """Details of a LaTeX document class."""
 
     def __init__(self, document_class, with_part=False):
@@ -790,12 +812,24 @@
         # unsupported levels
         return 'DUtitle'
 
+    def latex_section_depth(self, depth):
+        """
+        Return LaTeX equivalent of Docutils section level `depth`.
 
-class Table(object):
-    """Manage a table while traversing.
+        Given the value of the ``:depth:`` option of the "contents" or
+        "sectnum" directive, return the corresponding value for the
+        LaTeX ``tocdepth`` or ``secnumdepth`` counters.
+        """
+        depth = min(depth, len(self.sections))  # limit to supported levels
+        if 'chapter' in self.sections:
+            depth -= 1
+        if self.sections0 == 'part':
+            depth -= 1
+        return depth
 
-    Maybe change to a mixin defining the visit/departs, but then
-    class Table internal variables are in the Translator.
+
+class Table:
+    """Manage a table while traversing.
 
     Table style might be
 
@@ -805,18 +839,15 @@
     :nolines:    alias for borderless
 
     :colwidths-auto:  column widths determined by LaTeX
-    :colwidths-given: use colum widths from rST source
     """
     def __init__(self, translator, latex_type):
         self._translator = translator
         self._latex_type = latex_type
-        self._open = False
-        # miscellaneous attributes
-        self._attrs = {}
-        self._col_width = 
+        self.legacy_column_widths = False
+
+        self.close()
+        self._colwidths = 
         self._rowspan = 
-        self.stubs = 
-        self.colwidths_auto = False
         self._in_thead = 0
 
     def open(self):
@@ -824,7 +855,8 @@
         self._col_specs = 
         self.caption = 
         self._attrs = {}
-        self._in_head = False # maybe context with search
+        self._in_head = False  # maybe context with search
+
     def close(self):
         self._open = False
         self._col_specs = None
@@ -836,27 +868,32 @@
     def is_open(self):
         return self._open
 
-    def set_table_style(self, table_style, classes):
+    def set_table_style(self, node, settings):
+        self.legacy_column_widths = settings.legacy_column_widths
+        if 'align' in node:
+            self.set('align', node'align')
+        # TODO: elif 'align' in classes/settings.table-style:
+        #           self.set('align', ...)
         borders = cls.replace('nolines', 'borderless')
-                   for cls in table_style+classes
+                   for cls in ('standard'
+                               + settings.table_style
+                               + node'classes')
                    if cls in ('standard', 'booktabs', 'borderless', 'nolines')
-        try:
-            self.borders = borders-1
-        except IndexError:
-            self.borders = 'standard'
-        self.colwidths_auto = (('colwidths-auto' in classes
-                                and 'colwidths-given' not in table_style)
-                               or ('colwidths-auto' in table_style
-                                   and ('colwidths-given' not in classes)))
+        self.borders = borders-1
+        self.colwidths_auto = (('colwidths-auto' in node'classes'
+                                or 'colwidths-auto' in settings.table_style)
+                               and 'colwidths-given' not in node'classes'
+                               and 'width' not in node)
 
     def get_latex_type(self):
         if self._latex_type == 'longtable' and not self.caption:
             # do not advance the "table" counter (requires "ltcaption" package)
-            return('longtable*')
+            return 'longtable*'
         return self._latex_type
 
     def set(self, attr, value):
         self._attrsattr = value
+
     def get(self, attr):
         if attr in self._attrs:
             return self._attrsattr
@@ -877,12 +914,16 @@
         latex_type = self.get_latex_type()
         if align and latex_type not in ("longtable", "longtable*"):
             opening = r'\noindent\makebox\linewidth%s{%%' % (align,),
-                       r'\begin{%s}' % (latex_type,),
-                      
+                       r'\begin{%s}' % (latex_type,)
         else:
             opening = r'\begin{%s}%s' % (latex_type, align)
         if not self.colwidths_auto:
-            opening.insert(-1, r'\setlength{\DUtablewidth}{%s}%%'%width)
+            if self.borders == 'standard' and not self.legacy_column_widths:
+                opening.insert(-1, r'\setlength{\DUtablewidth}'
+                               r'{\dimexpr%s-%i\arrayrulewidth\relax}%%'
+                               % (width, len(self._col_specs)+1))
+            else:
+                opening.insert(-1, r'\setlength{\DUtablewidth}{%s}%%' % width)
         return '\n'.join(opening)
 
     def get_closing(self):
@@ -892,7 +933,8 @@
         # elif self.borders == 'standard':
         #     closing.append(r'\hline')
         closing.append(r'\end{%s}' % self.get_latex_type())
-        if self.get('align') and self.get_latex_type() not in ("longtable", "longtable*"):
+        if (self.get('align')
+            and self.get_latex_type() not in ("longtable", "longtable*")):
             closing.append('}')
         return '\n'.join(closing)
 
@@ -903,53 +945,66 @@
 
     def get_colspecs(self, node):
         """Return column specification for longtable.
-
-        Assumes reST line length being 80 characters.
-        Table width is hairy.
-
-        === ===
-        ABC DEF
-        === ===
-
-        usually gets to narrow, therefore we add 1 (fiddlefactor).
         """
         bar = self.get_vertical_bar()
-        self._rowspan= 0 * len(self._col_specs)
-        self._col_width = 
+        self._rowspan = 0 * len(self._col_specs)
         if self.colwidths_auto:
-            latex_table_spec = (bar+'l')*len(self._col_specs)
-            return latex_table_spec+bar
-        width = 80
-        total_width = 0.0
-        # first see if we get too wide.
-        for node in self._col_specs:
-            colwidth = float(node'colwidth'+1) / width
-            total_width += colwidth
-        # donot make it full linewidth
-        factor = 0.93
-        if total_width > 1.0:
-            factor /= total_width
-        latex_table_spec = ''
-        for node in self._col_specs:
-            colwidth = factor * float(node'colwidth'+1) / width
-            self._col_width.append(colwidth+0.005)
-            latex_table_spec += '%sp{%.3f\\DUtablewidth}' % (bar, colwidth+0.005)
-        return latex_table_spec+bar
+            self._colwidths = 
+            latex_colspecs = 'l' * len(self._col_specs)
+        elif self.legacy_column_widths:
+            # use old algorithm for backwards compatibility
+            width = 80  # assumed standard line length
+            factor = 0.93  # do not make it full linewidth
+            # first see if we get too wide.
+            total_width = sum(node'colwidth'+1 for node in self._col_specs)
+            if total_width > width:
+                factor *= width / total_width
+            self._colwidths = (factor * (node'colwidth'+1)/width)
+                               + 0.005 for node in self._col_specs
+            latex_colspecs = 'p{%.3f\\DUtablewidth}' % colwidth
+                              for colwidth in self._colwidths
+        else:
+            # No of characters corresponding to table width = 100%
+            #   Characters/line with LaTeX article, A4, Times, default margins
+            #   depends on character:  M: 40, A: 50, x: 70, i: 120.
+            norm_length = 40
+            # Allowance to prevent unpadded columns like
+            #   === ==
+            #   ABC DE
+            #   === ==
+            # getting too narrow:
+            if 'colwidths-given' not in node.parent.parent'classes':
+                allowance = 1
+            else:
+                allowance = 0  # "widths" option specified, use exact ratio
+            self._colwidths = (node'colwidth'+allowance)/norm_length
+                               for node in self._col_specs
+            total_width = sum(self._colwidths)
+            # Limit to 100%, force 100% if table width is specified:
+            if total_width > 1 or 'width' in node.parent.parent.attributes:
+                self._colwidths = colwidth/total_width
+                                   for colwidth in self._colwidths
+            latex_colspecs = 'p{\\DUcolumnwidth{%.3f}}' % colwidth
+                              for colwidth in self._colwidths
+        return bar + bar.join(latex_colspecs) + bar
 
     def get_column_width(self):
         """Return columnwidth for current cell (not multicell)."""
         try:
-            return '%.2f\\DUtablewidth' % self._col_widthself._cell_in_row
+            if self.legacy_column_widths:
+                return '%.2f\\DUtablewidth'%self._colwidthsself._cell_in_row
+            return '\\DUcolumnwidth{%.2f}'%self._colwidthsself._cell_in_row
         except IndexError:
             return '*'
 
     def get_multicolumn_width(self, start, len_):
         """Return sum of columnwidths for multicell."""
         try:
-            mc_width = sum(width
-                            for width in (self._col_widthstart + co
-                                           for co in range (len_)))
-            return 'p{%.2f\\DUtablewidth}' % mc_width
+            multicol_width = sum(self._colwidthsstart + co
+                                 for co in range(len_))
+            if self.legacy_column_widths:
+                return 'p{%.2f\\DUtablewidth}' % multicol_width
+            return 'p{\\DUcolumnwidth{%.3f}}' % multicol_width
         except IndexError:
             return 'l'
 
@@ -976,19 +1031,25 @@
 
     def depart_thead(self):
         a = 
-        #if self.borders == 'standard':
-        #    a.append('\\hline\n')
+        ## if self.borders == 'standard':
+        ##     a.append('\\hline\n')
         if self.borders == 'booktabs':
             a.append('\\midrule\n')
         if self._latex_type == 'longtable':
             if 1 == self._translator.thead_depth():
                 a.append('\\endfirsthead\n')
             else:
+                n_c = len(self._col_specs)
                 a.append('\\endhead\n')
-                a.append(r'\multicolumn{%d}{c}' % len(self._col_specs) +
-                         r'{\hfill ... continued on next page} \\')
-                a.append('\n\\endfoot\n\\endlastfoot\n')
-        # for longtable one could add firsthead, foot and lastfoot
+                # footer on all but last page (if it fits):
+                twidth = sum(node'colwidth'+2 for node in self._col_specs)
+                if twidth > 30 or (twidth > 12 and not self.colwidths_auto):
+                    a.append(r'\multicolumn{%d}{%s}'
+                             % (n_c, self.get_multicolumn_width(0, n_c))
+                             + r'{\raggedleft\ldots continued on next page}\\'
+                             + '\n')
+                a.append('\\endfoot\n\\endlastfoot\n')
+            # for longtable one could add firsthead, foot and lastfoot
         self._in_thead -= 1
         return a
 
@@ -999,13 +1060,13 @@
         res = ' \\\\\n'
         self._cell_in_row = None  # remove cell counter
         for i in range(len(self._rowspan)):
-            if (self._rowspani>0):
+            if self._rowspani > 0:
                 self._rowspani -= 1
 
         if self.borders == 'standard':
             rowspans = i+1 for i in range(len(self._rowspan))
-                        if (self._rowspani<=0)
-            if len(rowspans)==len(self._rowspan):
+                        if self._rowspani <= 0
+            if len(rowspans) == len(self._rowspan):
                 res.append('\\hline\n')
             else:
                 cline = ''
@@ -1014,7 +1075,7 @@
                 while True:
                     try:
                         c_start = rowspans.pop()
-                    except:
+                    except IndexError:
                         break
                     cline += '\\cline{%d-%d}\n' % (c_start, c_start)
                 res.append(cline)
@@ -1023,13 +1084,13 @@
     def set_rowspan(self, cell, value):
         try:
             self._rowspancell = value
-        except:
+        except IndexError:
             pass
 
     def get_rowspan(self, cell):
         try:
             return self._rowspancell
-        except:
+        except IndexError:
             return 0
 
     def get_entry_number(self):
@@ -1080,21 +1141,20 @@
     # Auxiliary variables
     # -------------------
 
-    has_latex_toc = False # is there a toc in the doc? (needed by minitoc)
-    is_toc_list = False   # is the current bullet_list a ToC?
+    has_latex_toc = False  # is there a toc in the doc? (needed by minitoc)
     section_level = 0
 
     # Flags to encode():
     # inside citation reference labels underscores dont need to be escaped
     inside_citation_reference_label = False
-    verbatim = False                   # do not encode
-    insert_non_breaking_blanks = False # replace blanks by "~"
-    insert_newline = False             # add latex newline commands
-    literal = False                    # literal text (block or inline)
-    alltt = False                      # inside `alltt` environment
+    verbatim = False                    # do not encode
+    insert_non_breaking_blanks = False  # replace blanks by "~"
+    insert_newline = False              # add latex newline commands
+    literal = False                     # literal text (block or inline)
+    alltt = False                       # inside `alltt` environment
 
     def __init__(self, document, babel_class=Babel):
-        nodes.NodeVisitor.__init__(self, document)
+        super().__init__(document)
         # Reporter
         # ~~~~~~~~
         self.warn = self.document.reporter.warning
@@ -1103,10 +1163,28 @@
         # Settings
         # ~~~~~~~~
         self.settings = settings = document.settings
+        # warn of deprecated settings and changing defaults:
+        if settings.use_latex_citations is None and not settings.use_bibtex:
+            settings.use_latex_citations = False
+            warnings.warn('The default for the setting "use_latex_citations" '
+                          'will change to "True" in Docutils 1.0.',
+                          FutureWarning, stacklevel=7)
+        if settings.legacy_column_widths is None:
+            settings.legacy_column_widths = True
+            warnings.warn('The default for the setting "legacy_column_widths" '
+                          'will change to "False" in Docutils 1.0.)',
+                          FutureWarning, stacklevel=7)
+        if settings.use_verbatim_when_possible is not None:
+            warnings.warn(
+                'The configuration setting "use_verbatim_when_possible" '
+                'will be removed in Docutils 2.0. '
+                'Use "literal_block_env: verbatim".',
+                FutureWarning, stacklevel=7)
+
         self.latex_encoding = self.to_latex_encoding(settings.output_encoding)
         self.use_latex_toc = settings.use_latex_toc
         self.use_latex_docinfo = settings.use_latex_docinfo
-        self._use_latex_citations = settings.use_latex_citations
+        self.use_latex_citations = settings.use_latex_citations
         self._reference_label = settings.reference_label
         self.hyperlink_color = settings.hyperlink_color
         self.compound_enumerators = settings.compound_enumerators
@@ -1125,53 +1203,48 @@
              none) = re.split(r'(\w+)(.*)', settings.literal_block_env)
         elif settings.use_verbatim_when_possible:
             self.literal_block_env = 'verbatim'
-        #
-        if self.settings.use_bibtex:
-            self.bibtex = self.settings.use_bibtex.split(',', 1)
-            # TODO avoid errors on not declared citations.
-        else:
-            self.bibtex = None
+
+        if settings.use_bibtex:
+            self.use_latex_citations = True
+        self.bibtex = settings.use_bibtex
         # language module for Docutils-generated text
         # (labels, bibliographic_fields, and author_separators)
         self.language_module = languages.get_language(settings.language_code,
-                                              document.reporter)
+                                                      document.reporter)
         self.babel = babel_class(settings.language_code, document.reporter)
         self.author_separator = self.language_module.author_separators0
-        d_options = self.settings.documentoptions
+        d_options = settings.documentoptions
         if self.babel.language not in ('english', ''):
             d_options.append(self.babel.language)
         self.documentoptions = ','.join(filter(None, d_options))
         self.d_class = DocumentClass(settings.documentclass,
                                      settings.use_part_section)
         # graphic package options:
-        if self.settings.graphicx_option == '':
+        if settings.graphicx_option == '':
             self.graphicx_package = r'\usepackage{graphicx}'
         else:
             self.graphicx_package = (r'\usepackage%s{graphicx}' %
-                                     self.settings.graphicx_option)
+                                     settings.graphicx_option)
         # footnotes: TODO: implement LaTeX footnotes
         self.docutils_footnotes = settings.docutils_footnotes
-        # @@ table_style: list of values from fixed set: warn?
-        # for s in self.settings.table_style:
-        #     if s not in Writer.table_style_values:
-        #         self.warn('Ignoring value "%s" in "table-style" setting.' %s)
 
         # Output collection stacks
         # ~~~~~~~~~~~~~~~~~~~~~~~~
 
         # Document parts
         self.head_prefix = r'\documentclass%s{%s}' %
-            (self.documentoptions, self.settings.documentclass)
-        self.requirements = SortableDict() # made a list in depart_document()
+                            (self.documentoptions,
+                             settings.documentclass)
+        self.requirements = SortableDict()  # made a list in depart_document()
         self.requirements'__static' = r'\usepackage{ifthen}'
         self.latex_preamble = settings.latex_preamble
-        self.fallbacks = SortableDict() # made a list in depart_document()
-        self.pdfsetup =  # PDF properties (hyperref package)
+        self.fallbacks = SortableDict()  # made a list in depart_document()
+        self.pdfsetup =   # PDF properties (hyperref package)
         self.title = 
         self.subtitle = 
-        self.titledata =  # \title, \author, \date
+        self.titledata =   # \title, \author, \date
         ## self.body_prefix = '\\begin{document}\n'
-        self.body_pre_docinfo =  # \maketitle
+        self.body_pre_docinfo =   # \maketitle
         self.docinfo = 
         self.dedication = 
         self.abstract = 
@@ -1213,7 +1286,7 @@
 
         self._bibitems = 
 
-        # object for a table while proccessing.
+        # object for a table while processing.
         self.table_stack = 
         self.active_table = Table(self, 'longtable')
 
@@ -1225,7 +1298,7 @@
         # ~~~~~~~~~~~~~~~~
         # Encodings:
         # Docutils' output-encoding => TeX input encoding
-        if self.latex_encoding != 'ascii':
+        if self.latex_encoding not in ('ascii', 'unicode', 'utf8'):
             self.requirements'_inputenc' = (r'\usepackage%s{inputenc}'
                                               % self.latex_encoding)
         # TeX font encoding
@@ -1243,9 +1316,9 @@
                     self.requirements'_textquotedbl' = (
                         r'\DeclareTextSymbolDefault{\textquotedbl}{T1}')
         # page layout with typearea (if there are relevant document options)
-        if (settings.documentclass.find('scr') == -1 and
-            (self.documentoptions.find('DIV') != -1 or
-             self.documentoptions.find('BCOR') != -1)):
+        if (settings.documentclass.find('scr') == -1
+            and (self.documentoptions.find('DIV') != -1
+                 or self.documentoptions.find('BCOR') != -1)):
             self.requirements'typearea' = r'\usepackage{typearea}'
 
         # Stylesheets
@@ -1254,15 +1327,14 @@
         stylesheet_list = utils.get_stylesheet_list(settings)
         self.fallback_stylesheet = 'docutils' in stylesheet_list
         if self.fallback_stylesheet:
-            stylesheet_list = sheet for sheet in stylesheet_list
-                               if sheet != 'docutils'
-            if self.settings.legacy_class_functions:
+            stylesheet_list.remove('docutils')
+            if settings.legacy_class_functions:
                 # docutils.sty is incompatible with legacy functions
                 self.fallback_stylesheet = False
             else:
                 # require a minimal version:
-                self.fallbacks'docutils.sty'
-                               = r'\usepackage{docutils}2020/08/28'
+                self.fallbacks'docutils.sty' = (
+                    r'\usepackage{docutils}2020/08/28')
 
         self.stylesheet = self.stylesheet_call(path)
                            for path in stylesheet_list
@@ -1271,22 +1343,20 @@
         if self.hyperlink_color in ('0', 'false', 'False', ''):
             self.hyperref_options = ''
         else:
-            self.hyperref_options = 'colorlinks=true,linkcolor=%s,urlcolor=%s' % (
-                                      self.hyperlink_color, self.hyperlink_color)
+            self.hyperref_options = ('colorlinks=true,'
+                                     f'linkcolor={self.hyperlink_color},'
+                                     f'urlcolor={self.hyperlink_color}')
         if settings.hyperref_options:
             self.hyperref_options += ',' + settings.hyperref_options
 
         # LaTeX Toc
         # include all supported sections in toc and PDF bookmarks
         # (or use documentclass-default (as currently))?
-        ## if self.use_latex_toc:
-        ##    self.requirements'tocdepth' = (r'\setcounter{tocdepth}{%d}' %
-        ##                                     len(self.d_class.sections))
 
         # Section numbering
-        if settings.sectnum_xform: # section numbering by Docutils
+        if settings.sectnum_xform:  # section numbering by Docutils
             PreambleCmds.secnumdepth = r'\setcounter{secnumdepth}{0}'
-        else: # section numbering by LaTeX:
+        else:  # section numbering by LaTeX:
             secnumdepth = settings.sectnum_depth
             # Possible values of settings.sectnum_depth:
             # None  "sectnum" directive without depth arg -> LaTeX default
@@ -1300,19 +1370,12 @@
             #        4  paragraph
             #        5  subparagraph
             if secnumdepth is not None:
-                # limit to supported levels
-                secnumdepth = min(secnumdepth, len(self.d_class.sections))
-                # adjust to document class and use_part_section settings
-                if 'chapter' in  self.d_class.sections:
-                    secnumdepth -= 1
-                if self.d_class.sections0 == 'part':
-                    secnumdepth -= 1
-                PreambleCmds.secnumdepth = \
-                    r'\setcounter{secnumdepth}{%d}' % secnumdepth
-
+                PreambleCmds.secnumdepth = (
+                    r'\setcounter{secnumdepth}{%d}'
+                    % self.d_class.latex_section_depth(secnumdepth))
             # start with specified number:
-            if (hasattr(settings, 'sectnum_start') and
-                settings.sectnum_start != 1):
+            if (hasattr(settings, 'sectnum_start')
+                and settings.sectnum_start != 1):
                 self.requirements'sectnum_start' = (
                     r'\setcounter{%s}{%d}' % (self.d_class.sections0,
                                               settings.sectnum_start-1))
@@ -1325,78 +1388,76 @@
 
     def stylesheet_call(self, path):
         """Return code to reference or embed stylesheet file `path`"""
+        path = Path(path)
         # is it a package (no extension or *.sty) or "normal" tex code:
-        (base, ext) = os.path.splitext(path)
-        is_package = ext in '.sty', ''
+        is_package = path.suffix in ('.sty', '')
         # Embed content of style file:
         if self.settings.embed_stylesheet:
             if is_package:
-                path = base + '.sty' # ensure extension
+                path = path.with_suffix('.sty')  # ensure extension
             try:
-                content = docutils.io.FileInput(source_path=path,
-                                       encoding='utf-8').read()
-                self.settings.record_dependencies.add(path)
-            except IOError as err:
-                msg = u'Cannot embed stylesheet %r:\n  %s.' % (
-                                path, SafeString(err.strerror))
+                content = path.read_text(encoding='utf-8')
+            except OSError as err:
+                msg = f'Cannot embed stylesheet:\n {err}'.replace('\\\\', '/')
                 self.document.reporter.error(msg)
                 return '% ' + msg.replace('\n', '\n% ')
+            else:
+                self.settings.record_dependencies.add(path.as_posix())
             if is_package:
-                content = '\n'.join(r'\makeatletter',
-                                     content,
-                                     r'\makeatother')
-            return '%% embedded stylesheet: %s\n%s' % (path, content)
+                # allow '@' in macro names:
+                content = (f'\\makeatletter\n{content}\n\\makeatother')
+            return (f'% embedded stylesheet: {path.as_posix()}\n'
+                    f'{content}')
         # Link to style file:
         if is_package:
-            path = base # drop extension
+            path = path.parent / path.stem  # drop extension
             cmd = r'\usepackage{%s}'
         else:
             cmd = r'\input{%s}'
         if self.settings.stylesheet_path:
             # adapt path relative to output (cf. config.html#stylesheet-path)
-            path = utils.relative_path(self.settings._destination, path)
-        return cmd % path
+            return cmd % utils.relative_path(self.settings._destination, path)
+        return cmd % path.as_posix()
 
     def to_latex_encoding(self, docutils_encoding):
         """Translate docutils encoding name into LaTeX's.
 
         Default method is remove "-" and "_" chars from docutils_encoding.
         """
-        tr = {  'iso-8859-1': 'latin1',     # west european
-                'iso-8859-2': 'latin2',     # east european
-                'iso-8859-3': 'latin3',     # esperanto, maltese
-                'iso-8859-4': 'latin4',     # north european, scandinavian, baltic
-                'iso-8859-5': 'iso88595',   # cyrillic (ISO)
-                'iso-8859-9': 'latin5',     # turkish
-                'iso-8859-15': 'latin9',    # latin9, update to latin1.
-                'mac_cyrillic': 'maccyr',   # cyrillic (on Mac)
-                'windows-1251': 'cp1251',   # cyrillic (on Windows)
-                'koi8-r': 'koi8-r',         # cyrillic (Russian)
-                'koi8-u': 'koi8-u',         # cyrillic (Ukrainian)
-                'windows-1250': 'cp1250',   #
-                'windows-1252': 'cp1252',   #
-                'us-ascii': 'ascii',        # ASCII (US)
-                # unmatched encodings
-                #'': 'applemac',
-                #'': 'ansinew',  # windows 3.1 ansi
-                #'': 'ascii',    # ASCII encoding for the range 32--127.
-                #'': 'cp437',    # dos latin us
-                #'': 'cp850',    # dos latin 1
-                #'': 'cp852',    # dos latin 2
-                #'': 'decmulti',
-                #'': 'latin10',
-                #'iso-8859-6': ''   # arabic
-                #'iso-8859-7': ''   # greek
-                #'iso-8859-8': ''   # hebrew
-                #'iso-8859-10': ''   # latin6, more complete iso-8859-4
-             }
-        encoding = docutils_encoding.lower()
+        tr = {'iso-8859-1': 'latin1',     # west european
+              'iso-8859-2': 'latin2',     # east european
+              'iso-8859-3': 'latin3',     # esperanto, maltese
+              'iso-8859-4': 'latin4',     # north european
+              'iso-8859-5': 'iso88595',   # cyrillic (ISO)
+              'iso-8859-9': 'latin5',     # turkish
+              'iso-8859-15': 'latin9',    # latin9, update to latin1.
+              'mac_cyrillic': 'maccyr',   # cyrillic (on Mac)
+              'windows-1251': 'cp1251',   # cyrillic (on Windows)
+              'koi8-r': 'koi8-r',         # cyrillic (Russian)
+              'koi8-u': 'koi8-u',         # cyrillic (Ukrainian)
+              'windows-1250': 'cp1250',   #
+              'windows-1252': 'cp1252',   #
+              'us-ascii': 'ascii',        # ASCII (US)
+              # unmatched encodings
+              # '': 'applemac',
+              # '': 'ansinew',  # windows 3.1 ansi
+              # '': 'ascii',    # ASCII encoding for the range 32--127.
+              # '': 'cp437',    # dos latin us
+              # '': 'cp850',    # dos latin 1
+              # '': 'cp852',    # dos latin 2
+              # '': 'decmulti',
+              # '': 'latin10',
+              # 'iso-8859-6': ''   # arabic
+              # 'iso-8859-7': ''   # greek
+              # 'iso-8859-8': ''   # hebrew
+              # 'iso-8859-10': ''  # latin6, more complete iso-8859-4
+              }
+        encoding = docutils_encoding.lower()  # normalize case
+        encoding = encoding.split(':')0     # strip the error handler
         if encoding in tr:
             return trencoding
-        # drop hyphen or low-line from "latin-1", "latin_1", "utf-8" and similar
-        encoding = encoding.replace('_', '').replace('-', '')
-        # strip the error handler
-        return encoding.split(':')0
+        # drop HYPHEN or LOW LINE from "latin_1", "utf-8" and similar
+        return encoding.replace('_', '').replace('-', '')
 
     def language_label(self, docutil_label):
         return self.language_module.labelsdocutil_label
@@ -1417,30 +1478,30 @@
             table.update(CharMaps.special)
         # keep the underscore in citation references
         if self.inside_citation_reference_label and not self.alltt:
-            del(tableord('_'))
+            del tableord('_')
         # Workarounds for OT1 font-encoding
         if self.font_encoding in 'OT1', '' and not self.is_xetex:
             # * out-of-order characters in cmtt
             if self.literal:
                 # replace underscore by underlined blank,
                 # because this has correct width.
-                tableord('_') = u'\\underline{~}'
+                tableord('_') = '\\underline{~}'
                 # the backslash doesn't work, so we use a mirrored slash.
                 # \reflectbox is provided by graphicx:
                 self.requirements'graphicx' = self.graphicx_package
-                tableord('\\') = u'\\reflectbox{/}'
+                tableord('\\') = '\\reflectbox{/}'
             # * ``< | >`` come out as different chars (except for cmtt):
             else:
-                tableord('|') = u'\\textbar{}'
-                tableord('<') = u'\\textless{}'
-                tableord('>') = u'\\textgreater{}'
+                tableord('|') = '\\textbar{}'
+                tableord('<') = '\\textless{}'
+                tableord('>') = '\\textgreater{}'
         if self.insert_non_breaking_blanks:
-            tableord(' ') = u'~'
+            tableord(' ') = '~'
             # tab chars may occur in included files (literal or code)
             # quick-and-dirty replacement with spaces
             # (for better results use `--literal-block-env=lstlisting`)
-            tableord('\t') = u'~' * self.settings.tab_width
-        # Unicode replacements for 8-bit tex engines (not required with XeTeX/LuaTeX):
+            tableord('\t') = '~' * self.settings.tab_width
+        # Unicode replacements for 8-bit tex engines (not required with XeTeX)
         if not self.is_xetex:
             if not self.latex_encoding.startswith('utf8'):
                 table.update(CharMaps.unsupported_unicode)
@@ -1459,11 +1520,11 @@
                       and cp in CharMaps.unsupported_unicode):
                     self.requirements'_inputenc'+str(cp) = (
                         '\\DeclareUnicodeCharacter{%04X}{%s}'
-                         % (cp, CharMaps.unsupported_unicodecp))
+                        % (cp, CharMaps.unsupported_unicodecp))
         text = text.translate(table)
 
         # Break up input ligatures e.g. '--' to '-{}-'.
-        if not self.is_xetex: # Not required with xetex/luatex
+        if not self.is_xetex:  # Not required with xetex/luatex
             separate_chars = '-'
             # In monospace-font, we also separate ',,', '``' and "''" and some
             # other characters which can't occur in non-literal text.
@@ -1507,21 +1568,24 @@
     def append_hypertargets(self, node):
         """Append hypertargets for all ids of `node`"""
         # hypertarget places the anchor at the target's baseline,
-        # so we raise it explicitely
-        self.out.append('%\n'.join('\\raisebox{1em}{\\hypertarget{%s}{}}' %
-                                    id for id in node'ids'))
+        # so we raise it explicitly
+        self.out.append('%\n'.join('\\raisebox{1em}{\\hypertarget{%s}{}}' %
+                                   id for id in node'ids'))
 
-    def ids_to_labels(self, node, set_anchor=True, protect=False):
+    def ids_to_labels(self, node, set_anchor=True, protect=False,
+                      newline=False):
         """Return list of label definitions for all ids of `node`
 
         If `set_anchor` is True, an anchor is set with \\phantomsection.
         If `protect` is True, the \\label cmd is made robust.
+        If `newline` is True, a newline is added if there are labels.
         """
-        labels = '\\label{%s}' % id for id in node.get('ids', )
-        if protect:
-            labels = '\\protect'+label for label in labels
+        prefix = '\\protect' if protect else ''
+        labels = prefix + '\\label{%s}' % id for id in node'ids'
         if set_anchor and labels:
             labels.insert(0, '\\phantomsection')
+        if newline and labels:
+            labels.append('\n')
         return labels
 
     def set_align_from_classes(self, node):
@@ -1545,14 +1609,15 @@
     def duclass_open(self, node):
         """Open a group and insert declarations for class values."""
         if not isinstance(node.parent, nodes.compound):
-             self.out.append('\n')
+            self.out.append('\n')
         for cls in node'classes':
             if cls.startswith('language-'):
                 language = self.babel.language_name(cls9:)
                 if language:
                     self.babel.otherlanguageslanguage = True
                     self.out.append('\\begin{selectlanguage}{%s}\n' % language)
-            elif isinstance(node, nodes.table) and cls in Writer.table_style_values:
+            elif (isinstance(node, nodes.table)
+                  and cls in Writer.table_style_values + 'colwidths-given'):
                 pass
             else:
                 if not self.fallback_stylesheet:
@@ -1566,7 +1631,8 @@
                 language = self.babel.language_name(cls9:)
                 if language:
                     self.out.append('\\end{selectlanguage}\n')
-            elif isinstance(node, nodes.table) and cls in Writer.table_style_values:
+            elif (isinstance(node, nodes.table)
+                  and cls in Writer.table_style_values + 'colwidths-given'):
                 pass
             else:
                 if not self.fallback_stylesheet:
@@ -1595,13 +1661,12 @@
                 break
         else:
             return ''
-        if isinstance(child, (nodes.image)):
-            return '\\leavevmode\n' # Images get an additional newline.
         if isinstance(child, (nodes.container, nodes.compound)):
             return self.term_postfix(child)
-        if not isinstance(child,
-                          (nodes.paragraph, nodes.math_block)):
-            return r'\leavevmode'
+        if isinstance(child, nodes.image):
+            return '\\leavevmode\n'  # Images get an additional newline.
+        if not isinstance(child, (nodes.paragraph, nodes.math_block)):
+            return '\\leavevmode'
         return ''
 
     # Visitor methods
@@ -1641,7 +1706,7 @@
             self.fallbacks'admonition' = PreambleCmds.admonition_legacy
             if 'error' in node'classes':
                 self.fallbacks'error' = PreambleCmds.error_legacy
-            self.out.append('\n\\DUadmonition%s{' % ','.join(node'classes'))
+            self.out.append('\n\\DUadmonition%s{'%','.join(node'classes'))
             return
         if not self.fallback_stylesheet:
             self.fallbacks'admonition' = PreambleCmds.admonition
@@ -1681,36 +1746,26 @@
 
     def visit_bullet_list(self, node):
         self.duclass_open(node)
-        if self.is_toc_list:
-            self.out.append('\\begin{list}{}{}')
-        else:
-            self.out.append('\\begin{itemize}')
+        self.out.append('\\begin{itemize}')
 
     def depart_bullet_list(self, node):
-        if self.is_toc_list:
-            self.out.append('\\end{list}\n')
-        else:
-            self.out.append('\\end{itemize}\n')
+        self.out.append('\\end{itemize}\n')
         self.duclass_close(node)
 
     def visit_superscript(self, node):
         self.out.append(r'\textsuperscript{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_superscript(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     def visit_subscript(self, node):
         self.out.append(r'\textsubscript{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_subscript(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     def visit_caption(self, node):
@@ -1723,24 +1778,22 @@
         if not self.fallback_stylesheet:
             self.fallbacks'titlereference' = PreambleCmds.titlereference
         self.out.append(r'\DUroletitlereference{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_title_reference(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     def visit_citation(self, node):
-        if self._use_latex_citations:
+        if self.use_latex_citations:
             self.push_output_collector()
         else:
-            ## self.requirements'~fnt_floats' = PreambleCmds.footnote_floats
+            # self.requirements'~fnt_floats' = PreambleCmds.footnote_floats
             self.out.append(r'\begin{figure}b')
             self.append_hypertargets(node)
 
     def depart_citation(self, node):
-        if self._use_latex_citations:
+        if self.use_latex_citations:
             # TODO: normalize label
             label = self.out0
             text = ''.join(self.out1:)
@@ -1750,7 +1803,9 @@
             self.out.append('\\end{figure}\n')
 
     def visit_citation_reference(self, node):
-        if self._use_latex_citations:
+        if self.bibtex:
+            self._bibitems.append(node.astext())
+        if self.use_latex_citations:
             if not self.inside_citation_reference_label:
                 self.out.append(r'\cite{')
                 self.inside_citation_reference_label = 1
@@ -1768,7 +1823,7 @@
 
     def depart_citation_reference(self, node):
         # TODO: normalize labels
-        if self._use_latex_citations:
+        if self.use_latex_citations:
             followup_citation = False
             # check for a following citation separated by a space or newline
             sibling = node.next_node(descend=False, siblings=True)
@@ -1776,7 +1831,7 @@
                 and sibling.astext() in (' ', '\n')):
                 sibling2 = sibling.next_node(descend=False, siblings=True)
                 if isinstance(sibling2, nodes.citation_reference):
-                        followup_citation = True
+                    followup_citation = True
             if followup_citation:
                 self.out.append(',')
             else:
@@ -1799,7 +1854,7 @@
 
     def visit_comment(self, node):
         if not isinstance(node.parent, nodes.compound):
-             self.out.append('\n')
+            self.out.append('\n')
         # Precede every line with a comment sign, wrap in newlines
         self.out.append('%% %s\n' % node.astext().replace('\n', '\n% '))
         raise nodes.SkipNode
@@ -1932,17 +1987,17 @@
 
     def visit_document(self, node):
         # titled document?
-        if (self.use_latex_docinfo or len(node) and
-            isinstance(node0, nodes.title)):
+        if (self.use_latex_docinfo or len(node)
+            and isinstance(node0, nodes.title)):
             protect = (self.settings.documentclass == 'memoir')
             self.title_labels += self.ids_to_labels(node, set_anchor=False,
                                                     protect=protect)
 
     def depart_document(self, node):
-        # Complete header with information gained from walkabout
+        # Complete "parts" with information gained from walkabout
         # * language setup
-        if (self.babel.otherlanguages or
-            self.babel.language not in ('', 'english')):
+        if (self.babel.otherlanguages
+            or self.babel.language not in ('', 'english')):
             self.requirements'babel' = self.babel()
         # * conditional requirements (before style sheet)
         self.requirements = self.requirements.sortedvalues()
@@ -1955,62 +2010,74 @@
             self.pdfinfo.append('  pdfauthor={%s}' % authors)
         if self.pdfinfo:
             self.pdfsetup += r'\hypersetup{' + self.pdfinfo + '}'
-        # Complete body
-        # * document title (with "use_latex_docinfo" also
-        #   'author', 'organization', 'contact', 'address' and 'date')
-        if self.title or (
-           self.use_latex_docinfo and (self.author_stack or self.date)):
-            # \title (empty \title prevents error with \maketitle)
-            title = ''.join(self.title)
-            if self.title:
-                title += self.title_labels
-            if self.subtitle:
-                title += r'\\',
-                          r'\DUdocumentsubtitle{%s}' % ''.join(self.subtitle)
-                          + self.subtitle_labels
-            self.titledata.append(r'\title{%s}' % '%\n  '.join(title))
-            # \author (empty \author prevents warning with \maketitle)
-            authors = '\\\\\n'.join(author_entry)
-                        for author_entry in self.author_stack
-            self.titledata.append(r'\author{%s}' %
-                                      ' \\and\n'.join(authors))
-            # \date (empty \date prevents defaulting to \today)
-            self.titledata.append(r'\date{%s}' % ', '.join(self.date))
-            # \maketitle in the body formats title with LaTeX
-            self.body_pre_docinfo.append('\\maketitle\n')
-
+        # * title (including author(s) and date if using "latex_docinfo")
+        if self.title or (self.use_latex_docinfo
+                          and (self.author_stack or self.date)):
+            self.make_title()  # see below
         # * bibliography
-        #   TODO insertion point of bibliography should be configurable.
-        if self._use_latex_citations and len(self._bibitems)>0:
-            if not self.bibtex:
-                widest_label = ''
-                for bi in self._bibitems:
-                    if len(widest_label)<len(bi0):
-                        widest_label = bi0
-                self.out.append('\n\\begin{thebibliography}{%s}\n' %
-                                 widest_label)
-                for bi in self._bibitems:
-                    # cite_key: underscores must not be escaped
-                    cite_key = bi0.replace(r'\_', '_')
-                    self.out.append('\\bibitem%s{%s}{%s}\n' %
-                                     (bi0, cite_key, bi1))
-                self.out.append('\\end{thebibliography}\n')
-            else:
-                self.out.append('\n\\bibliographystyle{%s}\n' %
-                                self.bibtex0)
-                self.out.append('\\bibliography{%s}\n' % self.bibtex1)
+        if self._bibitems:
+            self.append_bibliogaphy()  # see below
         # * make sure to generate a toc file if needed for local contents:
         if 'minitoc' in self.requirements and not self.has_latex_toc:
             self.out.append('\n\\faketableofcontents % for local ToCs\n')
 
+    def make_title(self):
+        # Auxiliary function called by `self.depart_document()`.
+        #
+        # Append ``\title``, ``\author``, and ``\date`` to "titledata".
+        # (We need all three, even if empty, to prevent errors
+        # and/or automatic display of the current date by \maketitle.)
+        # Append ``\maketitle`` to "body_pre_docinfo" parts.
+        #
+        # \title
+        title_arg = ''.join(self.title)  # ensure len == 1
+        if self.title:
+            title_arg += self.title_labels
+        if self.subtitle:
+            title_arg += r'\\',
+                          r'\DUdocumentsubtitle{%s}' % ''.join(self.subtitle),
+                           + self.subtitle_labels
+        self.titledata.append(r'\title{%s}' % '%\n  '.join(title_arg))
+        # \author
+        author_arg = '\\\\\n'.join(author_entry)
+                      for author_entry in self.author_stack
+        self.titledata.append(r'\author{%s}' %
+                              ' \\and\n'.join(author_arg))
+        # \date
+        self.titledata.append(r'\date{%s}' % ', '.join(self.date))
+        # \maketitle
+        # Must be in the document body. We add it to `body_pre_docinfo`
+        # to allow templates to put `titledata` into the document preamble.
+        self.body_pre_docinfo.append('\\maketitle\n')
+
+    def append_bibliogaphy(self):
+        # Add bibliography at end of document.
+        # TODO insertion point should be configurable.
+        # Auxiliary function called by `depart_document`.
+        if self.bibtex:
+            self.out.append('\n\\bibliographystyle{%s}\n' % self.bibtex0)
+            self.out.append('\\bibliography{%s}\n' % ','.join(self.bibtex1:))
+        elif self.use_latex_citations:
+            # TODO: insert citations at point of definition.
+            widest_label = ''
+            for bibitem in self._bibitems:
+                if len(widest_label) < len(bibitem0):
+                    widest_label = bibitem0
+            self.out.append('\n\\begin{thebibliography}{%s}\n' %
+                            widest_label)
+            for bibitem in self._bibitems:
+                # cite_key: underscores must not be escaped
+                cite_key = bibitem0.replace(r'\_', '_')
+                self.out.append('\\bibitem%s{%s}{%s}\n' %
+                                (bibitem0, cite_key, bibitem1))
+            self.out.append('\\end{thebibliography}\n')
+
     def visit_emphasis(self, node):
         self.out.append('\\emph{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_emphasis(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     # Append column delimiters and advance column counter,
@@ -2019,7 +2086,7 @@
         while self.active_table.get_rowspan(
                                 self.active_table.get_entry_number()):
             self.out.append(' & ')
-            self.active_table.visit_entry() # increment cell count
+            self.active_table.visit_entry()  # increment cell count
 
     def visit_entry(self, node):
         # cell separation
@@ -2030,8 +2097,9 @@
 
         # multirow, multicolumn
         if 'morerows' in node and 'morecols' in node:
-            raise NotImplementedError('Cells that '
-            'span multiple rows *and* columns currently not supported, sorry.')
+            raise NotImplementedError('Cells that span multiple rows *and* '
+                                      'columns currently not supported '
+                                      'by the LaTeX writer')
             # TODO: should be possible with LaTeX, see e.g.
             # http://texblog.org/2012/12/21/multi-column-and-multi-row-cells-in-latex-tables/
         # multirow in LaTeX simply will enlarge the cell over several rows
@@ -2053,11 +2121,11 @@
                 bar1 = ''
             mcols = node'morecols' + 1
             self.out.append('\\multicolumn{%d}{%s%s%s}{' %
-                    (mcols, bar1,
-                     self.active_table.get_multicolumn_width(
-                        self.active_table.get_entry_number(),
-                        mcols),
-                     self.active_table.get_vertical_bar()))
+                            (mcols,
+                             bar1,
+                             self.active_table.get_multicolumn_width(
+                                 self.active_table.get_entry_number(), mcols),
+                             self.active_table.get_vertical_bar()))
             self.context.append('}')
         else:
             self.context.append('')
@@ -2070,17 +2138,17 @@
         else:
             self.context.append('')
 
-        # if line ends with '{', mask line break to prevent spurious whitespace
+        # if line ends with '{', mask line break
         if (not self.active_table.colwidths_auto
             and self.out-1.endswith("{")
             and node.astext()):
-                self.out.append("%")
+            self.out.append("%")
 
-        self.active_table.visit_entry() # increment cell count
+        self.active_table.visit_entry()  # increment cell count
 
     def depart_entry(self, node):
-        self.out.append(self.context.pop()) # header / not header
-        self.out.append(self.context.pop()) # multirow/column
+        self.out.append(self.context.pop())  # header / not header
+        self.out.append(self.context.pop())  # multirow/column
         # insert extra "&"s, if following rows are spanned from above:
         self.insert_additional_table_colum_delimiters()
 
@@ -2093,42 +2161,41 @@
     def visit_enumerated_list(self, node):
         # enumeration styles:
         types = {'': '',
-                  'arabic':'arabic',
-                  'loweralpha':'alph',
-                  'upperalpha':'Alph',
-                  'lowerroman':'roman',
-                  'upperroman':'Roman'}
-        # the 4 default LaTeX enumeration labels: präfix, enumtype, suffix,
-        labels = ('',  'arabic', '.'), #  1.
-                  ('(', 'alph',   ')'), # (a)
-                  ('',  'roman',  '.'), #  i.
-                  ('',  'Alph',   '.') #  A.
+                 'arabic': 'arabic',
+                 'loweralpha': 'alph',
+                 'upperalpha': 'Alph',
+                 'lowerroman': 'roman',
+                 'upperroman': 'Roman'}
+        # default LaTeX enumeration labels:
+        default_labels = 
+                          # (präfix, enumtype, suffix)
+                          ('',  'arabic', '.'),  # 1.
+                          ('(', 'alph',   ')'),  # (a)
+                          ('',  'roman',  '.'),  # i.
+                          ('',  'Alph',   '.')  # A.
 
         prefix = ''
         if self.compound_enumerators:
             if (self.section_prefix_for_enumerators and self.section_level
                 and not self._enumeration_counters):
-                prefix = '.'.join(str(n) for n in
-                                   self._section_number:self.section_level
-                                 ) + self.section_enumerator_separator
+                prefix = '.'.join(str(n) for n in
+                                  self._section_number:self.section_level
+                                  ) + self.section_enumerator_separator
             if self._enumeration_counters:
                 prefix += self._enumeration_counters-1
-        # TODO: use LaTeX default for unspecified label-type?
-        #       (needs change of parser)
         prefix += node.get('prefix', '')
-        enumtype = typesnode.get('enumtype' '')
-        suffix = node.get('suffix', '')
+        enumtype = typesnode.get('enumtype', 'arabic')
+        suffix = node.get('suffix', '.')
 
-        enumeration_level = len(self._enumeration_counters)+1
-        counter_name = 'enum' + roman.toRoman(enumeration_level).lower()
+        enum_level = len(self._enumeration_counters)+1
+        counter_name = 'enum' + roman.toRoman(enum_level).lower()
         label = r'%s\%s{%s}%s' % (prefix, enumtype, counter_name, suffix)
         self._enumeration_counters.append(label)
 
         self.duclass_open(node)
-        if enumeration_level <= 4:
+        if enum_level <= 4:
             self.out.append('\\begin{enumerate}')
-            if (prefix, enumtype, suffix
-               ) != labelsenumeration_level-1:
+            if (prefix, enumtype, suffix) != default_labelsenum_level-1:
                 self.out.append('\n\\renewcommand{\\label%s}{%s}' %
                                 (counter_name, label))
         else:
@@ -2140,7 +2207,6 @@
             self.out.append('\n\\setcounter{%s}{%d}' %
                             (counter_name, node'start'-1))
 
-
     def depart_enumerated_list(self, node):
         if len(self._enumeration_counters) <= 4:
             self.out.append('\\end{enumerate}\n')
@@ -2203,8 +2269,7 @@
             self.out.append('\\begin{figure} %% align = "%s"\n' % alignment)
         else:
             self.out.append('\\begin{figure}\n')
-        if node.get('ids'):
-            self.out += self.ids_to_labels(node) + '\n'
+        self.out += self.ids_to_labels(node, newline=True)
 
     def depart_figure(self, node):
         self.out.append('\\end{figure}\n')
@@ -2223,7 +2288,7 @@
         try:
             backref = node'backrefs'0
         except IndexError:
-            backref = node'ids'0 # no backref, use self-ref instead
+            backref = node'ids'0  # no backref, use self-ref instead
         if self.docutils_footnotes:
             if not self.fallback_stylesheet:
                 self.fallbacks'footnotes' = PreambleCmds.footnotes
@@ -2234,8 +2299,8 @@
                             (node'ids'0, backref, self.encode(num)))
             if node'ids' == node'names':
                 self.out += self.ids_to_labels(node)
-            # mask newline to prevent spurious whitespace if paragraph follows:
-            if node1: and isinstance(node1, nodes.paragraph):
+            # prevent spurious whitespace if footnote starts with paragraph:
+            if len(node) > 1 and isinstance(node1, nodes.paragraph):
                 self.out.append('%')
         # TODO: "real" LaTeX \footnote{}s (see visit_footnotes_reference())
 
@@ -2249,15 +2314,14 @@
         elif 'refname' in node:
             href = self.document.nameidsnode'refname'
         # if not self.docutils_footnotes:
-            # TODO: insert footnote content at (or near) this place
-            # print("footnote-ref to", node'refid')
-            # footnotes = (self.document.footnotes +
-            #              self.document.autofootnotes +
-            #              self.document.symbol_footnotes)
-            # for footnote in footnotes:
-            #     # print(footnote'ids')
-            #     if node.get('refid', '') in footnote'ids':
-            #         print('matches', footnote'ids')
+        #     # TODO: insert footnote content at (or near) this place
+        #     #       see also docs/dev/todo.txt
+        #     try:
+        #         referenced_node = self.document.idsnode'refid'
+        #     except (AttributeError, KeyError):
+        #         self.document.reporter.error(
+        #             'unresolved footnote-reference %s' % node)
+        #     print('footnote-ref to %s' % referenced_node)
         format = self.settings.footnote_references
         if format == 'brackets':
             self.append_hypertargets(node)
@@ -2279,7 +2343,7 @@
             raise nodes.SkipNode
         else:
             assert isinstance(node.parent, nodes.citation)
-            if not self._use_latex_citations:
+            if not self.use_latex_citations:
                 self.out.append(bracket)
 
     def visit_label(self, node):
@@ -2306,11 +2370,14 @@
         self.pop_output_collector()
 
     def to_latex_length(self, length_str, pxunit=None):
-        """Convert `length_str` with rst lenght to LaTeX length
+        """Convert `length_str` with rst length to LaTeX length
         """
         if pxunit is not None:
-            sys.stderr.write('deprecation warning: LaTeXTranslator.to_latex_length()'
-                             ' option `pxunit` will be removed.')
+            warnings.warn(
+                'The optional argument `pxunit` '
+                'of LaTeXTranslator.to_latex_length() is ignored '
+                'and will be removed in Docutils 0.21 or later',
+                DeprecationWarning, stacklevel=2)
         match = re.match(r'(\d*\.?\d*)\s*(\S*)', length_str)
         if not match:
             return length_str
@@ -2337,7 +2404,7 @@
         # Convert image URI to a local file path
         imagepath = url2pathname(attrs'uri').replace('\\', '/')
         # alignment defaults:
-        if not 'align' in attrs:
+        if 'align' not in attrs:
             # Set default align of image in a figure to 'center'
             if isinstance(node.parent, nodes.figure):
                 attrs'align' = 'center'
@@ -2354,7 +2421,8 @@
             # block level images:
             'center': (r'\noindent\makebox\linewidthc{', '}'),
             'left':   (r'\noindent{', r'\hfill}'),
-            'right':  (r'\noindent{\hfill', '}'),}
+            'right':  (r'\noindent{\hfill', '}'),
+            }
         if 'align' in attrs:
             # TODO: warn or ignore non-applicable alignment settings?
             try:
@@ -2364,19 +2432,19 @@
             except KeyError:
                 pass                    # TODO: warn?
         if 'height' in attrs:
-            include_graphics_options.append('height=%s' %
-                            self.to_latex_length(attrs'height'))
+            include_graphics_options.append(
+                'height=%s' % self.to_latex_length(attrs'height'))
         if 'scale' in attrs:
-            include_graphics_options.append('scale=%f' %
-                                            (attrs'scale' / 100.0))
+            include_graphics_options.append(
+                'scale=%f' % (attrs'scale' / 100.0))
         if 'width' in attrs:
-            include_graphics_options.append('width=%s' %
-                            self.to_latex_length(attrs'width'))
-        if not (self.is_inline(node) or
-                isinstance(node.parent, (nodes.figure, nodes.compound))):
+            include_graphics_options.append(
+                'width=%s' % self.to_latex_length(attrs'width'))
+        if not (self.is_inline(node)
+                or isinstance(node.parent, (nodes.figure, nodes.compound))):
             pre.append('\n')
-        if not (self.is_inline(node) or
-                isinstance(node.parent, nodes.figure)):
+        if not (self.is_inline(node)
+                or isinstance(node.parent, nodes.figure)):
             post.append('\n')
         pre.reverse()
         self.out.extend(pre)
@@ -2387,10 +2455,9 @@
         self.out.extend(post)
 
     def depart_image(self, node):
-        if node.get('ids'):
-            self.out += self.ids_to_labels(node) + '\n'
+        self.out += self.ids_to_labels(node, newline=True)
 
-    def visit_inline(self, node): # <span>, i.e. custom roles
+    def visit_inline(self, node):  # <span>, i.e. custom roles
         for cls in node'classes':
             if cls.startswith('language-'):
                 language = self.babel.language_name(cls9:)
@@ -2426,7 +2493,7 @@
         self.set_align_from_classes(node)
         if isinstance(node.parent, nodes.line_block):
             self.out.append('\\item\n'
-                             '\\begin{DUlineblock}{\\DUlineblockindent}\n')
+                            '\\begin{DUlineblock}{\\DUlineblockindent}\n')
             # nested line-blocks cannot be given class arguments
         else:
             self.duclass_open(node)
@@ -2445,19 +2512,17 @@
 
     def visit_literal(self, node):
         self.literal = True
-        if ('code' in node'classes' and
-            self.settings.syntax_highlight != 'none'):
+        if ('code' in node'classes'
+            and self.settings.syntax_highlight != 'none'):
             self.requirements'color' = PreambleCmds.color
             if not self.fallback_stylesheet:
                 self.fallbacks'code' = PreambleCmds.highlight_rules
         self.out.append('\\texttt{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_literal(self, node):
         self.literal = False
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     # Literal blocks are used for '::'-prefixed literal-indented
@@ -2498,14 +2563,15 @@
         # TODO: fails if normal text precedes the literal block.
         #       Check parent node instead?
         _autowidth_table = _in_table and self.active_table.colwidths_auto
-        _use_env = _plaintext and not isinstance(node.parent,
-                    (nodes.footnote, nodes.admonition, nodes.system_message))
+        _no_env_nodes = (nodes.footnote, nodes.sidebar)
+        if self.settings.legacy_class_functions:
+            _no_env_nodes += (nodes.admonition, nodes.system_message)
+        _use_env = _plaintext and not isinstance(node.parent, _no_env_nodes)
         _use_listings = (literal_env == 'lstlisting') and _use_env
 
         # Labels and classes:
-        if node.get('ids'):
-            self.out += '\n' + self.ids_to_labels(node)
         self.duclass_open(node)
+        self.out += self.ids_to_labels(node, newline=True)
         # Highlight code?
         if (not _plaintext
             and 'code' in node'classes'
@@ -2517,11 +2583,9 @@
         if _in_table and _use_env and not _autowidth_table:
             # Wrap in minipage to prevent extra vertical space
             # with alltt and verbatim-like environments:
-            self.fallbacks'ttem' = '\n'.join('',
-                r'% character width in monospaced font',
-                r'\newlength{\ttemwidth}',
-                r'\settowidth{\ttemwidth}{\ttfamily M}')
-            self.out.append('\\begin{minipage}{%d\\ttemwidth}\n' %
+            self.fallbacks'ttem' = PreambleCmds.ttem
+            self.out.append(
+                '\\begin{minipage}{%d\\ttemwidth}\n' %
                 (max(len(line) for line in node.astext().split('\n'))))
             self.context.append('\n\\end{minipage}\n')
         elif not _in_table and not _use_listings:
@@ -2582,6 +2646,7 @@
             self.pdfinfo.append('  addtopdfproducer={%s},'%content)
         else:
             # generic interface (case sensitive!)
+            # TODO: filter irrelevant nodes ("http-equiv", ...)?
             self.pdfinfo.append('  pdfinfo={%s={%s}},'%(name, content))
 
     def depart_meta(self, node):
@@ -2589,37 +2654,35 @@
 
     def visit_math(self, node, math_env='$'):
         """math role"""
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
         self.requirements'amsmath' = r'\usepackage{amsmath}'
         math_code = node.astext().translate(unichar2tex.uni2tex_table)
-        if node.get('ids'):
-            math_code = '\n'.join(math_code + self.ids_to_labels(node))
         if math_env == '$':
             if self.alltt:
-                wrapper = u'\$%s\$'
+                wrapper = '\$', '\$'
             else:
-                wrapper = u'$%s$'
+                wrapper = '$', '$'
         else:
-            wrapper = u'\n'.join('%%',
-                                 r'\begin{%s}' % math_env,
-                                 '%s',
-                                 r'\end{%s}' % math_env)
-        self.out.append(wrapper % math_code)
-        if node'classes':
-            self.depart_inline(node)
+            labels = self.ids_to_labels(node, set_anchor=False, newline=True)
+            wrapper = '%%\n\\begin{%s}\n' % math_env,
+                       '\n',
+                       ''.join(labels),
+                       '\\end{%s}' % math_env
+        wrapper.insert(1, math_code)
+        self.out.extend(wrapper)
+        self.depart_inline(node)
         # Content already processed:
         raise nodes.SkipNode
 
     def depart_math(self, node):
-        pass # never reached
+        pass  # never reached
 
     def visit_math_block(self, node):
         math_env = pick_math_environment(node.astext())
         self.visit_math(node, math_env=math_env)
 
     def depart_math_block(self, node):
-        pass # never reached
+        pass  # never reached
 
     def visit_option(self, node):
         if self.context-1:
@@ -2631,7 +2694,7 @@
         self.context-1 += 1
 
     def visit_option_argument(self, node):
-        """Append the delimiter betweeen an option and its argument to body."""
+        """Append the delimiter between an option and its argument to body."""
         self.out.append(node.get('delimiter', ' '))
 
     def depart_option_argument(self, node):
@@ -2643,7 +2706,7 @@
         self.context.append(0)
 
     def depart_option_group(self, node):
-        self.context.pop() # the flag
+        self.context.pop()  # the flag
         self.out.append(' ')
 
     def visit_option_list(self, node):
@@ -2664,11 +2727,11 @@
         pass
 
     def visit_option_string(self, node):
-        ##self.out.append(self.starttag(node, 'span', '', CLASS='option'))
+        ## self.out.append(self.starttag(node, 'span', '', CLASS='option'))
         pass
 
     def depart_option_string(self, node):
-        ##self.out.append('</span>')
+        ## self.out.append('</span>')
         pass
 
     def visit_organization(self, node):
@@ -2684,8 +2747,8 @@
         # * is in a table with auto-width columns
         index = node.parent.index(node)
         if index == 0 and isinstance(node.parent,
-                (nodes.list_item, nodes.description,
-                 nodes.compound, nodes.container)):
+                                     (nodes.list_item, nodes.description,
+                                      nodes.compound, nodes.container)):
             pass
         elif (index > 0
               and isinstance(node.parent, nodes.compound)
@@ -2693,21 +2756,18 @@
                                  (nodes.paragraph, nodes.compound))):
             pass
         elif self.active_table.colwidths_auto:
-            if index == 1: # second paragraph
+            if index == 1:  # second paragraph
                 self.warn('LaTeX merges paragraphs in tables '
                           'with auto-sized columns!', base_node=node)
             if index > 0:
                 self.out.append('\n')
         else:
             self.out.append('\n')
-        if node.get('ids'):
-            self.out += self.ids_to_labels(node) + '\n'
-        if node'classes':
-            self.visit_inline(node)
+        self.out += self.ids_to_labels(node, newline=True)
+        self.visit_inline(node)
 
     def depart_paragraph(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         if not self.active_table.colwidths_auto:
             self.out.append('\n')
 
@@ -2721,19 +2781,18 @@
         self.out.append('}}')
 
     def visit_raw(self, node):
-        if not 'latex' in node.get('format', '').split():
+        if 'latex' not in node.get('format', '').split():
             raise nodes.SkipNode
-        if not self.is_inline(node):
+        if not (self.is_inline(node)
+                or isinstance(node.parent, nodes.compound)):
             self.out.append('\n')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
         # append "as-is" skipping any LaTeX-encoding
         self.verbatim = True
 
     def depart_raw(self, node):
         self.verbatim = False
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         if not self.is_inline(node):
             self.out.append('\n')
 
@@ -2751,13 +2810,13 @@
 
     def visit_reference(self, node):
         # We need to escape #, \, and % if we use the URL in a command.
-        special_chars = {ord('#'): u'\\#',
-                         ord('%'): u'\\%',
-                         ord('\\'): u'\\\\',
-                        }
+        special_chars = {ord('#'): '\\#',
+                         ord('%'): '\\%',
+                         ord('\\'): '\\\\',
+                         }
         # external reference (URL)
         if 'refuri' in node:
-            href = unicode(node'refuri').translate(special_chars)
+            href = str(node'refuri').translate(special_chars)
             # problematic chars double caret and unbalanced braces:
             if href.find('^^') != -1 or self.has_unbalanced_braces(href):
                 self.error(
@@ -2827,7 +2886,7 @@
         self.out.append('}\n')
         self.duclass_close(node)
 
-    attribution_formats = {'dash': (u'—', ''), # EM DASH
+    attribution_formats = {'dash': ('—', ''),  # EM DASH
                            'parentheses': ('(', ')'),
                            'parens': ('(', ')'),
                            'none': ('', '')}
@@ -2849,12 +2908,10 @@
 
     def visit_strong(self, node):
         self.out.append('\\textbf{')
-        if node'classes':
-            self.visit_inline(node)
+        self.visit_inline(node)
 
     def depart_strong(self, node):
-        if node'classes':
-            self.depart_inline(node)
+        self.depart_inline(node)
         self.out.append('}')
 
     def visit_substitution_definition(self, node):
@@ -2867,14 +2924,14 @@
         if isinstance(node.parent, nodes.document):
             self.push_output_collector(self.subtitle)
             if not self.fallback_stylesheet:
-                self.fallbacks'documentsubtitle' = PreambleCmds.documentsubtitle
+                self.fallbacks'documentsubtitle' = PreambleCmds.documentsubtitle  # noqa:E501
             protect = (self.settings.documentclass == 'memoir')
             self.subtitle_labels += self.ids_to_labels(node, set_anchor=False,
                                                        protect=protect)
         # section subtitle: "starred" (no number, not in ToC)
         elif isinstance(node.parent, nodes.section):
             self.out.append(r'\%s*{' %
-                             self.d_class.section(self.section_level + 1))
+                            self.d_class.section(self.section_level + 1))
         else:
             if not self.fallback_stylesheet:
                 self.fallbacks'subtitle' = PreambleCmds.subtitle
@@ -2904,8 +2961,8 @@
         except KeyError:
             line = ''
         self.out.append('}\n\n{\\color{red}%s/%s} in \\texttt{%s}%s\n' %
-                         (node'type', node'level',
-                          self.encode(node'source'), line))
+                        (node'type', node'level',
+                         self.encode(node'source'), line))
         if len(node'backrefs') == 1:
             self.out.append('\n\\hyperlink{%s}{' % node'backrefs'0)
             self.context.append('}')
@@ -2921,24 +2978,22 @@
     def visit_table(self, node):
         self.duclass_open(node)
         self.requirements'table' = PreambleCmds.table
+        if not self.settings.legacy_column_widths:
+            self.requirements'table1' = PreambleCmds.table_columnwidth
         if self.active_table.is_open():
             self.table_stack.append(self.active_table)
             # nesting longtable does not work (e.g. 2007-04-18)
-            # TODO: don't use a longtable or add \noindent before
-            #       the next paragraph, when in a "compound paragraph".
             self.active_table = Table(self, 'tabular')
         # A longtable moves before \paragraph and \subparagraph
         # section titles if it immediately follows them:
-        if (self.active_table._latex_type == 'longtable' and
-            isinstance(node.parent, nodes.section) and
-            node.parent.index(node) == 1 and
-            self.d_class.section(self.section_level).find('paragraph') != -1):
+        if (self.active_table._latex_type == 'longtable'
+            and isinstance(node.parent, nodes.section)
+            and node.parent.index(node) == 1
+            and self.d_class.section(
+                   self.section_level).find('paragraph') != -1):
             self.out.append('\\leavevmode')
         self.active_table.open()
-        self.active_table.set_table_style(self.settings.table_style,
-                                          node'classes')
-        if 'align' in node:
-            self.active_table.set('align', node'align')
+        self.active_table.set_table_style(node, self.settings)
         if self.active_table.borders == 'booktabs':
             self.requirements'booktabs' = r'\usepackage{booktabs}'
         self.push_output_collector()
@@ -2948,28 +3003,30 @@
         content = self.out
         self.pop_output_collector()
         try:
-            width = self.to_latex_length(node.attributes'width')
+            width = self.to_latex_length(node'width')
         except KeyError:
             width = r'\linewidth'
-        if isinstance(node.parent, nodes.compound):
-            self.out.append('\n')
+        # TODO: Don't use a longtable or add \noindent before
+        #       the next paragraph, when in a "compound paragraph".
+        #       Start a new line or a new paragraph?
+        #       if (isinstance(node.parent, nodes.compound)
+        #       and self._latex_type != 'longtable')?
         self.out.append(self.active_table.get_opening(width))
         self.out += content
         self.out.append(self.active_table.get_closing() + '\n')
         self.active_table.close()
-        if len(self.table_stack)>0:
+        if len(self.table_stack) > 0:
             self.active_table = self.table_stack.pop()
         # Insert hyperlabel after (long)table, as
         # other places (beginning, caption) result in LaTeX errors.
-        if node.get('ids'):
-            self.out += self.ids_to_labels(node, set_anchor=False) + '\n'
+        self.out += self.ids_to_labels(node, set_anchor=False, newline=True)
         self.duclass_close(node)
 
     def visit_target(self, node):
         # Skip indirect targets:
-        if ('refuri' in node       # external hyperlink
-            or 'refid' in node     # resolved internal link
-            or 'refname' in node): # unresolved internal link
+        if ('refuri' in node        # external hyperlink
+            or 'refid' in node      # resolved internal link
+            or 'refname' in node):  # unresolved internal link
             ## self.out.append('%% %s\n' % node)   # for debugging
             return
         self.out.append('%\n')
@@ -3012,7 +3069,8 @@
         pass
 
     _thead_depth = 0
-    def thead_depth (self):
+
+    def thead_depth(self):
         return self._thead_depth
 
     def visit_thead(self, node):
@@ -3039,9 +3097,9 @@
             self.pdfinfo.append('  pdftitle={%s},' %
                                 self.encode(node.astext()))
         # Topic titles (topic, admonition, sidebar)
-        elif (isinstance(node.parent, nodes.topic) or
-              isinstance(node.parent, nodes.admonition) or
-              isinstance(node.parent, nodes.sidebar)):
+        elif (isinstance(node.parent, nodes.topic)
+              or isinstance(node.parent, nodes.admonition)
+              or isinstance(node.parent, nodes.sidebar)):
             classes = node.parent'classes' or node.parent.tagname
             if self.settings.legacy_class_functions:
                 self.fallbacks'title' = PreambleCmds.title_legacy
@@ -3075,7 +3133,7 @@
                                     % roman.toRoman(level))
 
             # System messages heading in red:
-            if ('system-messages' in node.parent'classes'):
+            if 'system-messages' in node.parent'classes':
                 self.requirements'color' = PreambleCmds.color
                 section_title = self.encode(node.astext())
                 self.out.append(r'\%s%s{\color{red}' % (
@@ -3095,7 +3153,7 @@
             if (level > len(self.d_class.sections)
                 and not self.settings.legacy_class_functions):
                 self.context-1 += '\\end{DUclass}\n'
-            # MAYBE postfix paragraph and subparagraph with \leavemode to
+            # MAYBE postfix paragraph and subparagraph with \leavevmode to
             # ensure floats stay in the section and text starts on a new line.
 
     def depart_title(self, node):
@@ -3103,81 +3161,93 @@
         if isinstance(node.parent, (nodes.table, nodes.document)):
             self.pop_output_collector()
 
-    def minitoc(self, node, title, depth):
-        """Generate a local table of contents with LaTeX package minitoc"""
-        section_name = self.d_class.section(self.section_level)
-        # name-prefix for current section level
-        minitoc_names = {'part': 'part', 'chapter': 'mini'}
-        if 'chapter' not in self.d_class.sections:
-            minitoc_names'section' = 'sect'
-        try:
-            minitoc_name = minitoc_namessection_name
-        except KeyError: # minitoc only supports part- and toplevel
-            self.warn('Skipping local ToC at %s level.\n' % section_name +
-                      '  Feature not supported with option "use-latex-toc"',
-                      base_node=node)
+    def visit_contents(self, node):
+        """Write the table of contents.
+
+        Called from visit_topic() for "contents" topics.
+        """
+        # requirements/setup for local ToC with package "minitoc",
+        if self.use_latex_toc and 'local' in node'classes':
+            section_name = self.d_class.section(self.section_level)
+            # minitoc only supports "part" and toplevel sections
+            minitoc_names = {'part': 'part',
+                             'chapter': 'mini',
+                             'section': 'sect'}
+            if 'chapter' in self.d_class.sections:
+                del minitoc_names'section'
+            try:
+                mtc_name = minitoc_namessection_name
+            except KeyError:
+                self.warn('Skipping local ToC at "%s" level.\n'
+                          '  Feature not supported with option "use-latex-toc"'
+                          % section_name, base_node=node)
+                raise nodes.SkipNode
+
+        # labels and PDF bookmark (sidebar entry)
+        self.out.append('\n')  # start new paragraph
+        if node'names':  # don't add labels just for auto-ids
+            self.out += self.ids_to_labels(node, newline=True)
+        if (isinstance(node.next_node(), nodes.title)
+            and 'local' not in node'classes'
+            and self.settings.documentclass != 'memoir'):
+            self.out.append('\\pdfbookmark%d{%s}{%s}\n' %
+                            (self.section_level+1,
+                             node.next_node().astext(),
+                             node.get('ids', 'contents')0))
+
+        # Docutils generated contents list (no page numbers)
+        if not self.use_latex_toc:
+            self.fallbacks'toc-list' = PreambleCmds.toc_list
+            self.duclass_open(node)
             return
-        # Requirements/Setup
-        self.requirements'minitoc' = PreambleCmds.minitoc
-        self.requirements'minitoc-'+minitoc_name = (r'\do%stoc' %
-                                                      minitoc_name)
-        # depth: (Docutils defaults to unlimited depth)
+
+        # ToC by LaTeX
+        depth = node.get('depth', 0)
         maxdepth = len(self.d_class.sections)
-        self.requirements'minitoc-%s-depth' % minitoc_name = (
-            r'\mtcsetdepth{%stoc}{%d}' % (minitoc_name, maxdepth))
-        # Process 'depth' argument (!Docutils stores a relative depth while
-        # minitoc  expects an absolute depth!):
-        offset = {'sect': 1, 'mini': 0, 'part': 0}
-        if 'chapter' in self.d_class.sections:
-            offset'part' = -1
-        if depth:
-            self.out.append('\\setcounter{%stocdepth}{%d}' %
-                             (minitoc_name, depth + offsetminitoc_name))
-        # title:
-        self.out.append('\\mtcsettitle{%stoc}{%s}\n' % (minitoc_name, title))
-        # the toc-generating command:
-        self.out.append('\\%stoc\n' % minitoc_name)
+        if isinstance(node.next_node(), nodes.title):
+            title = self.encode(node0.astext())
+        else:
+            title = ''
+        if 'local' in node'classes':
+            # use the "minitoc" package
+            self.requirements'minitoc' = PreambleCmds.minitoc
+            self.requirements'minitoc-'+mtc_name = r'\do%stoc'%mtc_name
+            self.requirements'minitoc-%s-depth' % mtc_name = (
+                r'\mtcsetdepth{%stoc}{%d}' % (mtc_name, maxdepth))
+            # "depth" option: Docutils stores a relative depth while
+            # minitoc  expects an absolute depth!:
+            offset = {'sect': 1, 'mini': 0, 'part': 0}
+            if 'chapter' in self.d_class.sections:
+                offset'part' = -1
+            if depth:
+                self.out.append('\\setcounter{%stocdepth}{%d}' %
+                                (mtc_name, depth + offsetmtc_name))
+            # title:
+            self.out.append('\\mtcsettitle{%stoc}{%s}\n' % (mtc_name, title))
+            # the toc-generating command:
+            self.out.append('\\%stoc\n' % mtc_name)
+        else:
+            if depth:
+                self.out.append('\\setcounter{tocdepth}{%d}\n'
+                                % self.d_class.latex_section_depth(depth))
+            if title != 'Contents':
+                self.out.append('\\renewcommand{\\contentsname}{%s}\n' % title)
+            self.out.append('\\tableofcontents\n')
+            self.has_latex_toc = True
+        # ignore rest of node content
+        raise nodes.SkipNode
 
     def visit_topic(self, node):
         # Topic nodes can be generic topic, abstract, dedication, or ToC.
         # table of contents:
         if 'contents' in node'classes':
-            self.out.append('\n')
-            self.out += self.ids_to_labels(node)
-            # add contents to PDF bookmarks sidebar
-            if (isinstance(node.next_node(), nodes.title)
-                and self.settings.documentclass != 'memoir'):
-                self.out.append('\n\\pdfbookmark%d{%s}{%s}' %
-                                (self.section_level+1,
-                                 node.next_node().astext(),
-                                 node.get('ids', 'contents')0
-                                ))
-            if self.use_latex_toc:
-                title = ''
-                if isinstance(node.next_node(), nodes.title):
-                    title = self.encode(node.pop(0).astext())
-                depth = node.get('depth', 0)
-                if 'local' in node'classes':
-                    self.minitoc(node, title, depth)
-                    return
-                if depth:
-                    self.out.append('\\setcounter{tocdepth}{%d}\n' % depth)
-                if title != 'Contents':
-                    self.out.append('\n\\renewcommand{\\contentsname}{%s}' %
-                                    title)
-                self.out.append('\n\\tableofcontents\n')
-                self.has_latex_toc = True
-                # ignore rest of node content
-                raise nodes.SkipNode
-            else: # Docutils generated contents list
-                # set flag for visit_bullet_list() and visit_title()
-                self.is_toc_list = True
-        elif ('abstract' in node'classes' and
-              self.settings.use_latex_abstract):
+            self.visit_contents(node)
+        elif ('abstract' in node'classes'
+              and self.settings.use_latex_abstract):
             self.push_output_collector(self.abstract)
             self.out.append('\\begin{abstract}')
             if isinstance(node.next_node(), nodes.title):
-                node.pop(0) # LaTeX provides its own title
+                node.pop(0)  # LaTeX provides its own title
         else:
             # special topics:
             if 'abstract' in node'classes':
@@ -3195,14 +3265,15 @@
             self.visit_block_quote(node)
 
     def depart_topic(self, node):
-        self.is_toc_list = False
         if ('abstract' in node'classes'
-          and self.settings.use_latex_abstract):
+            and self.settings.use_latex_abstract):
             self.out.append('\\end{abstract}\n')
-        elif not 'contents' in node'classes':
+        elif 'contents' in node'classes':
+            self.duclass_close(node)
+        else:
             self.depart_block_quote(node)
-        if ('abstract' in node'classes' or
-            'dedication' in node'classes'):
+        if ('abstract' in node'classes'
+            or 'dedication' in node'classes'):
             self.pop_output_collector()
 
     def visit_transition(self, node):

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/default.tex -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/default.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/docutils.sty -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/docutils.sty Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/titlepage.tex -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/titlepage.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/titlingpage.tex -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/titlingpage.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/latex2e/xelatex.tex -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/latex2e/xelatex.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/manpage.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/manpage.py Changed

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-# $Id: manpage.py 8664 2021-04-04 18:48:10Z grubert $
+# $Id: manpage.py 9206 2022-11-03 10:52:43Z aa-turner $
 # Author: Engelbert Gruber <grubert@users.sourceforge.net>
 # Copyright: This module is put into the public domain.
 
@@ -45,12 +44,7 @@
 __docformat__ = 'reStructuredText'
 
 import re
-import sys
 
-if sys.version_info < (3, 0):
-    range = xrange  # NOQA: F821  # flake8 do not check undefined name
-
-import docutils
 from docutils import nodes, writers, languages
 try:
     import roman
@@ -94,6 +88,7 @@
 ..
 """)
 
+
 class Writer(writers.Writer):
 
     supported = ('manpage',)
@@ -112,17 +107,20 @@
         self.output = visitor.astext()
 
 
-class Table(object):
+class Table:
     def __init__(self):
         self._rows = 
         self._options = 'center'
         self._tab_char = '\t'
         self._coldefs = 
+
     def new_row(self):
         self._rows.append()
+
     def append_separator(self, separator):
         """Append the separator for table head."""
         self._rows.append(separator)
+
     def append_cell(self, cell_lines):
         """cell_lines is an array of lines"""
         start = 0
@@ -131,12 +129,14 @@
         self._rows-1.append(cell_linesstart:)
         if len(self._coldefs) < len(self._rows-1):
             self._coldefs.append('l')
+
     def _minimize_cell(self, cell_lines):
         """Remove leading and trailing blank and ``.sp`` lines"""
         while cell_lines and cell_lines0 in ('\n', '.sp\n'):
             del cell_lines0
         while cell_lines and cell_lines-1 in ('\n', '.sp\n'):
             del cell_lines-1
+
     def as_list(self):
         text = '.TS\n'
         text.append(' '.join(self._options) + ';\n')
@@ -159,6 +159,7 @@
         text.append('.TE\n')
         return text
 
+
 class Translator(nodes.NodeVisitor):
     """"""
 
@@ -216,7 +217,7 @@
         # Hopefully ``C`` courier too.
         self.defs = {
                 'indent': ('.INDENT %.1f\n', '.UNINDENT\n'),
-                'definition_list_item': ('.TP', ''),
+                'definition_list_item': ('.TP', ''),  # par. with hanging tag
                 'field_name': ('.TP\n.B ', '\n'),
                 'literal': ('\\fB', '\\fP'),
                 'literal_block': ('.sp\n.nf\n.ft C\n', '\n.ft P\n.fi\n'),
@@ -241,9 +242,8 @@
         """Return commented version of the passed text WITHOUT end of
         line/comment."""
         prefix = '.\\" '
-        out_text = ''.join(
-            (prefix + in_line + '\n')
-            for in_line in text.split('\n'))
+        out_text = ''.join((prefix + in_line + '\n')
+                            for in_line in text.split('\n'))
         return out_text
 
     def comment(self, text):
@@ -266,30 +266,32 @@
             if self.bodyi == '.sp\n':
                 if self.bodyi - 1:4 in ('.BI ', '.IP '):
                     self.bodyi = '.\n'
-                elif (self.bodyi - 1:3 == '.B ' and
-                    self.bodyi - 2:4 == '.TP\n'):
+                elif (self.bodyi - 1:3 == '.B '
+                      and self.bodyi - 2:4 == '.TP\n'):
                     self.bodyi = '.\n'
-                elif (self.bodyi - 1 == '\n' and
-                    not self.possibly_a_roff_command.match(self.bodyi - 2) and
-                    (self.bodyi - 3:7 == '.TP\n.B '
-                        or self.bodyi - 3:4 == '\n.B ')
-                     ):
+                elif (self.bodyi - 1 == '\n'
+                      and not self.possibly_a_roff_command.match(
+                                  self.bodyi - 2)
+                      and (self.bodyi - 3:7 == '.TP\n.B '
+                           or self.bodyi - 3:4 == '\n.B ')
+                      ):
                     self.bodyi = '.\n'
         return ''.join(self.head + self.body + self.foot)
 
     def deunicode(self, text):
-        text = text.replace(u'\xa0', '\\ ')
-        text = text.replace(u'\u2020', '\\(dg')
+        text = text.replace('\xa0', '\\ ')
+        text = text.replace('\u2020', '\\(dg')
         return text
 
     def visit_Text(self, node):
         text = node.astext()
         text = text.replace('\\', '\\e')
         replace_pairs = 
-            (u'-', u'\\-'),
-            (u'\'', u'\\(aq'),
-            (u'´', u"\\'"),
-            (u'`', u'\\(ga'),
+            ('-', '\\-'),
+            ('\'', '\\(aq'),
+            ('´', "\\'"),
+            ('`', '\\(ga'),
+            ('"', '\\(dq'),  # double quotes are a problem on macro lines
             
         for (in_char, out_markup) in replace_pairs:
             text = text.replace(in_char, out_markup)
@@ -306,7 +308,7 @@
         pass
 
     def list_start(self, node):
-        class EnumChar(object):
+        class EnumChar:
             enum_style = {
                     'bullet': '\\(bu',
                     'emdash': '\\(em',
@@ -352,11 +354,9 @@
                 else:
                     return "%d." % self._cnt
 
-            if sys.version_info < (3, 0):
-                next = __next__
-
             def get_width(self):
                 return self._indent
+
             def __repr__(self):
                 return 'enum_style-%s' % list(self._style)
 
@@ -375,11 +375,14 @@
         self._list_char.pop()
 
     def header(self):
-        tmpl = (".TH \"%(title_upper)s\" %(manual_section)s"
-                " \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n"
-                ".SH NAME\n"
-                "%(title)s \\- %(subtitle)s\n")
-        return tmpl % self._docinfo
+        th = (".TH \"%(title_upper)s\" %(manual_section)s"
+              " \"%(date)s\" \"%(version)s\"") % self._docinfo
+        if self._docinfo"manual_group":
+            th += " \"%(manual_group)s\"" % self._docinfo
+        th += "\n"
+        sh_tmpl = (".SH NAME\n"
+                   "%(title)s \\- %(subtitle)s\n")
+        return th + sh_tmpl % self._docinfo
 
     def append_header(self):
         """append header with .TH and .SH NAME"""
@@ -450,7 +453,7 @@
         pass
 
     def visit_block_quote(self, node):
-        # BUG/HACK: indent always uses the _last_ indention,
+        # BUG/HACK: indent always uses the _last_ indentation,
         # thus we need two of them.
         self.indent(BLOCKQOUTE_INDENT)
         self.indent(0)
@@ -591,7 +594,7 @@
     def depart_document(self, node):
         if self._docinfo'author':
             self.body.append('.SH AUTHOR\n%s\n'
-                    % ', '.join(self._docinfo'author'))
+                             % ', '.join(self._docinfo'author'))
         skip = ('author', 'copyright', 'date',
                 'manual_group', 'manual_section',
                 'subtitle',
@@ -605,7 +608,7 @@
                                     self._docinfoname,
                                     self.defs'indent'1,
                                     self.defs'indent'1))
-            elif not name in skip:
+            elif name not in skip:
                 if name in self._docinfo_names:
                     label = self._docinfo_namesname
                 else:
@@ -613,9 +616,8 @@
                 self.body.append("\n%s: %s\n" % (label, self._docinfoname))
         if self._docinfo'copyright':
             self.body.append('.SH COPYRIGHT\n%s\n'
-                    % self._docinfo'copyright')
-        self.body.append(self.comment(
-                        'Generated by docutils manpage writer.'))
+                             % self._docinfo'copyright')
+        self.body.append(self.comment('Generated by docutils manpage writer.'))
 
     def visit_emphasis(self, node):
         self.body.append(self.defs'emphasis'0)
@@ -626,11 +628,11 @@
     def visit_entry(self, node):
         # a cell in a table row
         if 'morerows' in node:
-            self.document.reporter.warning('"table row spanning" not supported',
-                    base_node=node)
+            self.document.reporter.warning(
+                '"table row spanning" not supported', base_node=node)
         if 'morecols' in node:
             self.document.reporter.warning(
-                    '"table cell spanning" not supported', base_node=node)
+                '"table cell spanning" not supported', base_node=node)
         self.context.append(len(self.body))
 
     def depart_entry(self, node):
@@ -691,7 +693,7 @@
 
     def visit_footer(self, node):
         self.document.reporter.warning('"footer" not supported',
-                base_node=node)
+                                       base_node=node)
 
     def depart_footer(self, node):
         pass
@@ -706,7 +708,7 @@
 
     def footnote_backrefs(self, node):
         self.document.reporter.warning('"footnote_backrefs" not supported',
-                base_node=node)
+                                       base_node=node)
 
     def visit_footnote_reference(self, node):
         self.body.append(''+self.deunicode(node.astext())+'')
@@ -752,7 +754,7 @@
 
     def visit_image(self, node):
         self.document.reporter.warning('"image" not supported',
-                base_node=node)
+                                       base_node=node)
         text = 
         if 'alt' in node.attributes:
             text.append(node.attributes'alt')
@@ -778,7 +780,7 @@
             or isinstance(node.parent, nodes.citation)):
             raise nodes.SkipNode
         self.document.reporter.warning('"unsupported "label"',
-                base_node=node)
+                                       base_node=node)
         self.body.append('')
 
     def depart_label(self, node):
@@ -832,7 +834,7 @@
         self.body.append(self.defs'literal'1)
 
     def visit_literal_block(self, node):
-        # BUG/HACK: indent always uses the _last_ indention,
+        # BUG/HACK: indent always uses the _last_ indentation,
         # thus we need two of them.
         self.indent(LITERAL_BLOCK_INDENT)
         self.indent(0)
@@ -847,7 +849,7 @@
 
     def visit_math(self, node):
         self.document.reporter.warning('"math" role not supported',
-                base_node=node)
+                                       base_node=node)
         self.visit_literal(node)
 
     def depart_math(self, node):
@@ -855,7 +857,7 @@
 
     def visit_math_block(self, node):
         self.document.reporter.warning('"math" directive not supported',
-                base_node=node)
+                                       base_node=node)
         self.visit_literal_block(node)
 
     def depart_math_block(self, node):
@@ -901,10 +903,10 @@
         # options without parameter bold only, .B, -v
         # options with parameter bold italic, .BI, -f file
         #
-        # we do not know if .B or .BI
-        self.context.append('.B ')          # blind guess. Add blank for spinx see docutils/bugs/380
-        self.context.append(len(self.body)) # to be able to insert later
-        self.context.append(0)              # option counter
+        # we do not know if .B or .BI, blind guess:
+        self.context.append('.B ')  # Add blank for sphinx (docutils/bugs/380)
+        self.context.append(len(self.body))  # to be able to insert later
+        self.context.append(0)               # option counter
 
     def depart_option_group(self, node):
         self.context.pop()  # the counter
@@ -935,7 +937,7 @@
         pass
 
     def visit_option_argument(self, node):
-        self.context-3 = '.BI' # bold/italic alternate
+        self.context-3 = '.BI'  # bold/italic alternate
         if node'delimiter' != ' ':
             self.body.append('\\fB%s ' % node'delimiter')
         elif self.bodylen(self.body)-1.endswith('='):
@@ -955,7 +957,7 @@
         pass
 
     def first_child(self, node):
-        first = isinstance(node.parent0, nodes.label) # skip label
+        first = isinstance(node.parent0, nodes.label)  # skip label
         for child in node.parent.childrenfirst::
             if isinstance(child, nodes.Invisible):
                 continue
@@ -997,6 +999,8 @@
         self.body.append(self.defs'reference'0)
 
     def depart_reference(self, node):
+        # TODO check node text is different from refuri
+        # self.body.append("\n'UR " + node'refuri' + "\n'UE\n")
         self.body.append(self.defs'reference'1)
 
     def visit_revision(self, node):
@@ -1032,8 +1036,8 @@
         raise nodes.SkipNode
 
     def visit_substitution_reference(self, node):
-        self.document.reporter.warning('"substitution_reference" not supported',
-                base_node=node)
+        self.document.reporter.warning(
+            '"substitution_reference" not supported', base_node=node)
 
     def visit_subtitle(self, node):
         if isinstance(node.parent, nodes.sidebar):
@@ -1049,11 +1053,10 @@
 
     def visit_system_message(self, node):
         # TODO add report_level
-        #if node'level' < self.document.reporter'writer'.report_level:
+        # if node'level' < self.document.reporter'writer'.report_level:
         #    Level is too low to display:
         #    raise nodes.SkipNode
         attr = {}
-        backref_text = ''
         if node.hasattr('id'):
             attr'name' = node'id'
         if node.hasattr('line'):
@@ -1122,7 +1125,7 @@
             self._docinfo'title_upper' = node.astext().upper()
             raise nodes.SkipNode
         elif self.section_level == 1:
-            self.body.append('.SH %s\n' % self.deunicode(node.astext().upper()))
+            self.body.append('.SH %s\n'%self.deunicode(node.astext().upper()))
             raise nodes.SkipNode
         else:
             self.body.append('.SS ')

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/null.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/null.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/odf_odt/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/odf_odt/__init__.py Changed

@@ -1,56 +1,41 @@
-# $Id: __init__.py 8605 2021-01-11 11:07:17Z milde $
+# $Id: __init__.py 9258 2022-11-21 14:51:43Z milde $
 # Author: Dave Kuhlman <dkuhlman@davekuhlman.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Open Document Format (ODF) Writer.
 
+This module is provisional:
+the API is not settled and may change with any minor Docutils version.
 """
-from __future__ import absolute_import
 
 __docformat__ = 'reStructuredText'
 
 
-import sys
+from configparser import ConfigParser
+import copy
+from io import StringIO
+import itertools
+import locale
 import os
 import os.path
+import re
+import subprocess
 import tempfile
-import zipfile
-from xml.etree import ElementTree as etree
-from xml.dom import minidom
 import time
-import re
-import copy
-import itertools
+from urllib.request import urlopen
+from urllib.error import HTTPError
 import weakref
-
-try:
-    import locale   # module missing in Jython
-except ImportError:
-    pass
+from xml.etree import ElementTree as etree
+from xml.dom import minidom
+import zipfile
 
 import docutils
 from docutils import frontend, nodes, utils, writers, languages
+from docutils.parsers.rst.directives.images import PIL  # optional
 from docutils.readers import standalone
 from docutils.transforms import references
 
-if sys.version_info >= (3, 0):
-    from configparser import ConfigParser
-    from io import StringIO
-    from urllib.request import urlopen
-    from urllib.error import HTTPError
-else:
-    from ConfigParser import ConfigParser
-    from StringIO import StringIO
-    from urllib2 import HTTPError
-    from urllib2 import urlopen
-
-
-VERSION = '1.0a'
-
-IMAGE_NAME_COUNTER = itertools.count()
-
-#
 # Import pygments and odtwriter pygments formatters if possible.
 try:
     import pygments
@@ -60,27 +45,18 @@
 except (ImportError, SyntaxError):
     pygments = None
 
-# check for the Python Imaging Library
-try:
-    import PIL.Image
-except ImportError:
-    try:  # sometimes PIL modules are put in PYTHONPATH's root
-        import Image
-
-        class PIL(object):
-            pass  # dummy wrapper
-        PIL.Image = Image
-    except ImportError:
-        PIL = None
-
-## import warnings
-## warnings.warn('importing IPShellEmbed', UserWarning)
-## from IPython.Shell import IPShellEmbed
-## args = '-pdb', '-pi1', 'In <\\#>: ', '-pi2', '   .\\D.: ',
-##         '-po', 'Out<\\#>: ', '-nosep'
-## ipshell = IPShellEmbed(args,
-##                        banner = 'Entering IPython.  Press Ctrl-D to exit.',
-##                        exit_msg = 'Leaving Interpreter, back to program.')
+# import warnings
+# warnings.warn('importing IPShellEmbed', UserWarning)
+# from IPython.Shell import IPShellEmbed
+# args = '-pdb', '-pi1', 'In <\\#>: ', '-pi2', '   .\\D.: ',
+#         '-po', 'Out<\\#>: ', '-nosep'
+# ipshell = IPShellEmbed(args,
+#                        banner = 'Entering IPython.  Press Ctrl-D to exit.',
+#                        exit_msg = 'Leaving Interpreter, back to program.')
+
+VERSION = '1.0a'
+
+IMAGE_NAME_COUNTER = itertools.count()
 
 
 #
@@ -126,7 +102,7 @@
 NAME_SPACE_1 = 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'
 
 CONTENT_NAMESPACE_DICT = CNSD = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
     'dc': 'http://purl.org/dc/elements/1.1/',
     'dom': 'http://www.w3.org/2001/xml-events',
@@ -155,7 +131,7 @@
 }
 
 STYLES_NAMESPACE_DICT = SNSD = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
     'dc': 'http://purl.org/dc/elements/1.1/',
     'dom': 'http://www.w3.org/2001/xml-events',
@@ -184,7 +160,7 @@
 }
 
 META_NAMESPACE_DICT = METNSD = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'dc': 'http://purl.org/dc/elements/1.1/',
     'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
     'office': NAME_SPACE_1,
@@ -196,7 +172,7 @@
 # does not support use of nsmap parameter on Element() and SubElement().
 
 CONTENT_NAMESPACE_ATTRIB = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'xmlns:chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
     'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
     'xmlns:dom': 'http://www.w3.org/2001/xml-events',
@@ -225,7 +201,7 @@
 }
 
 STYLES_NAMESPACE_ATTRIB = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'xmlns:chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
     'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
     'xmlns:dom': 'http://www.w3.org/2001/xml-events',
@@ -255,7 +231,7 @@
 }
 
 META_NAMESPACE_ATTRIB = {
-    #'office:version': '1.0',
+    # 'office:version': '1.0',
     'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
     'xmlns:meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
     'xmlns:office': NAME_SPACE_1,
@@ -277,8 +253,7 @@
     if attrib is None:
         attrib = {}
     tag, attrib = fix_ns(tag, attrib, nsdict)
-    el = _ElementInterfaceWrapper(tag, attrib)
-    return el
+    return _ElementInterfaceWrapper(tag, attrib)
 
 
 def SubElement(parent, tag, attrib=None, nsmap=None, nsdict=CNSD):
@@ -306,10 +281,7 @@
 
 def ToString(et):
     outstream = StringIO()
-    if sys.version_info >= (3, 0):
-        et.write(outstream, encoding="unicode")
-    else:
-        et.write(outstream)
+    et.write(outstream, encoding="unicode")
     s1 = outstream.getvalue()
     outstream.close()
     return s1
@@ -333,7 +305,7 @@
 #
 
 
-class TableStyle(object):
+class TableStyle:
     def __init__(self, border=None, backgroundcolor=None):
         self.border = border
         self.backgroundcolor = backgroundcolor
@@ -361,7 +333,7 @@
 #
 # Information about the indentation level for lists nested inside
 #   other contexts, e.g. dictionary lists.
-class ListLevel(object):
+class ListLevel:
     def __init__(self, level, sibling_level=True, nested_level=True):
         self.level = level
         self.sibling_level = sibling_level
@@ -705,8 +677,7 @@
         """Get the stylesheet from the visitor.
         Ask the visitor to setup the page.
         """
-        s1 = self.visitor.setup_page()
-        return s1
+        return self.visitor.setup_page()
 
     def copy_from_stylesheet(self, outzipfile):
         """Copy images, settings, etc from the stylesheet doc into target doc.
@@ -756,8 +727,7 @@
         }, nsdict=MANNSD)
         s1 = ToString(doc)
         doc = minidom.parseString(s1)
-        s1 = doc.toprettyxml('  ')
-        return s1
+        return doc.toprettyxml('  ')
 
     def create_meta(self):
         root = Element(
@@ -804,13 +774,13 @@
             elif prop == 'subject':
                 el1 = SubElement(root, 'dc:subject', nsdict=METNSD)
                 el1.text = value
-            else: # Store remaining properties as custom/user-defined
+            else:  # Store remaining properties as custom/user-defined
                 el1 = SubElement(root, 'meta:user-defined',
                                  attrib={'meta:name': prop}, nsdict=METNSD)
                 el1.text = value
         s1 = ToString(doc)
-        #doc = minidom.parseString(s1)
-        #s1 = doc.toprettyxml('  ')
+        # doc = minidom.parseString(s1)
+        # s1 = doc.toprettyxml('  ')
         return s1
 
 
@@ -875,7 +845,7 @@
     )
 
     def __init__(self, document):
-        #nodes.SparseNodeVisitor.__init__(self, document)
+        # nodes.SparseNodeVisitor.__init__(self, document)
         nodes.GenericNodeVisitor.__init__(self, document)
         self.settings = document.settings
         self.language_code = self.settings.language_code
@@ -891,10 +861,7 @@
                     self.document.reporter.warning(
                         'Style "%s" is not a style used by odtwriter.' % (
                             rststyle, ))
-                if sys.version_info >= (3, 0):
-                    self.format_maprststyle = format
-                else:
-                    self.format_maprststyle = format.decode('utf-8')
+                self.format_maprststyle = format
         self.section_level = 0
         self.section_count = 0
         # Create ElementTree content and styles documents.
@@ -969,9 +936,8 @@
         stylespath = self.settings.stylesheet
         ext = os.path.splitext(stylespath)1
         if ext == '.xml':
-            stylesfile = open(stylespath, 'r')
-            s1 = stylesfile.read()
-            stylesfile.close()
+            with open(stylespath, 'r', encoding='utf-8') as stylesfile:
+                s1 = stylesfile.read()
         elif ext == extension:
             zfile = zipfile.ZipFile(stylespath, 'r')
             s1 = zfile.read('styles.xml')
@@ -1042,9 +1008,7 @@
     def find_first_text_p(self, el):
         """Search the generated doc and return the first <text:p> element.
         """
-        if (
-                el.tag == 'text:p' or
-                el.tag == 'text:h'):
+        if el.tag == 'text:p' or el.tag == 'text:h':
             return el
         else:
             for child in el:
@@ -1080,34 +1044,32 @@
         the value.
         """
         name1 = name % parameters
-        stylename = self.format_map.get(name1, 'rststyle-%s' % name1)
-        return stylename
+        return self.format_map.get(name1, 'rststyle-%s' % name1)
 
     def generate_content_element(self, root):
         return SubElement(root, 'office:text')
 
     def setup_page(self):
         self.setup_paper(self.dom_stylesheet)
-        if (len(self.header_content) > 0 or
-                len(self.footer_content) > 0 or
-                self.settings.custom_header or
-                self.settings.custom_footer):
+        if (len(self.header_content) > 0
+            or len(self.footer_content) > 0
+            or self.settings.custom_header
+            or self.settings.custom_footer):
             self.add_header_footer(self.dom_stylesheet)
-        new_content = etree.tostring(self.dom_stylesheet)
-        return new_content
+        return etree.tostring(self.dom_stylesheet)
 
     def get_dom_stylesheet(self):
         return self.dom_stylesheet
 
     def setup_paper(self, root_el):
         try:
-            fin = os.popen("paperconf -s 2> /dev/null")
-            dimensions = fin.read().split()
-            w, h = (float(s) for s in dimensions)
-        except (IOError, ValueError):
+            dimensions = subprocess.check_output(('paperconf', '-s'),
+                                                 stderr=subprocess.STDOUT)
+            w, h = (float(s) for s in dimensions.split())
+        except (subprocess.CalledProcessError, FileNotFoundError, ValueError):
+            self.document.reporter.info(
+                'Cannot use `paperconf`, defaulting to Letter.')
             w, h = 612, 792     # default to Letter
-        finally:
-            fin.close()
 
         def walk(el):
             if el.tag == "{%s}page-layout-properties" % SNSD"style" and \
@@ -1209,12 +1171,12 @@
     def make_field_element(self, parent, text, style_name, automatic_styles):
         if text == 'p':
             el1 = SubElement(parent, 'text:page-number', attrib={
-                #'text:style-name': self.rststyle(style_name),
+                # 'text:style-name': self.rststyle(style_name),
                 'text:select-page': 'current',
             })
         elif text == 'P':
             el1 = SubElement(parent, 'text:page-count', attrib={
-                #'text:style-name': self.rststyle(style_name),
+                # 'text:style-name': self.rststyle(style_name),
             })
         elif text == 't1':
             self.style_index += 1
@@ -1463,20 +1425,19 @@
             if mo:
                 pos2 = mo.start()
                 if pos2 > pos1:
-                    yield (ODFTranslator.code_text, textpos1:pos2)
-                yield (ODFTranslator.code_field, mo.group(1))
+                    yield ODFTranslator.code_text, textpos1:pos2
+                yield ODFTranslator.code_field, mo.group(1)
                 pos1 = mo.end()
             else:
                 break
         trailing = textpos1:
         if trailing:
-            yield (ODFTranslator.code_text, trailing)
+            yield ODFTranslator.code_text, trailing
 
     def astext(self):
         root = self.content_tree.getroot()
         et = etree.ElementTree(root)
-        s1 = ToString(et)
-        return s1
+        return ToString(et)
 
     def content_astext(self):
         return self.astext()
@@ -1537,8 +1498,7 @@
     def append_child(self, tag, attrib=None, parent=None):
         if parent is None:
             parent = self.current_element
-        el = SubElement(parent, tag, attrib)
-        return el
+        return SubElement(parent, tag, attrib)
 
     def append_p(self, style, text=None):
         result = self.append_child('text:p', attrib={
@@ -1568,8 +1528,7 @@
             el, 'text:span',
             attrib={'text:style-name': self.rststyle('strong')})
         el1.text = label
-        el = self.append_p('blockindent')
-        return el
+        return self.append_p('blockindent')
 
     def generate_labeled_line(self, node, label):
         label = '%s:' % (self.language.labelslabel, )
@@ -1582,8 +1541,7 @@
         return el
 
     def encode(self, text):
-        text = text.replace('\n', " ")
-        return text
+        return text.replace('\n', " ")
 
     #
     # Visitor functions
@@ -1702,10 +1660,10 @@
 
     def visit_version(self, node):
         self.generate_labeled_line(node, 'version')
-        #self.set_current_element(el)
+        # self.set_current_element(el)
 
     def depart_version(self, node):
-        #self.set_to_parent()
+        # self.set_to_parent()
         pass
 
     def visit_attribution(self, node):
@@ -1789,7 +1747,6 @@
 
     def visit_caption(self, node):
         raise nodes.SkipChildren()
-        pass
 
     def depart_caption(self, node):
         pass
@@ -2304,30 +2261,31 @@
         dpi = (72, 72)
         if PIL is not None and source in self.image_dict:
             filename, destination = self.image_dictsource
-            imageobj = PIL.Image.open(filename, 'r')
-            dpi = imageobj.info.get('dpi', dpi)
+            with PIL.Image.open(filename, 'r') as img:
+                img_size = img.size
+                dpi = img.info.get('dpi', dpi)
             # dpi information can be (xdpi, ydpi) or xydpi
             try:
                 iter(dpi)
             except TypeError:
                 dpi = (dpi, dpi)
         else:
-            imageobj = None
+            img_size = None
         if width is None or height is None:
-            if imageobj is None:
+            if img_size is None:
                 raise RuntimeError(
                     'image size not fully specified and PIL not installed')
             if width is None:
-                width = imageobj.size0
+                width = img_size0
                 width = float(width) * 0.026        # convert px to cm
             if height is None:
-                height = imageobj.size1
+                height = img_size1
                 height = float(height) * 0.026      # convert px to cm
             if width_unit == '%':
                 factor = width
-                image_width = imageobj.size0
+                image_width = img_size0
                 image_width = float(image_width) * 0.026    # convert px to cm
-                image_height = imageobj.size1
+                image_height = img_size1
                 image_height = float(image_height) * 0.026  # convert px to cm
                 line_width = self.get_page_width()
                 width = factor * line_width
@@ -2358,9 +2316,9 @@
             margin_right = node.get(
                 '{urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0}'
                 'margin-right')
-            if (page_width is None or
-                    margin_left is None or
-                    margin_right is None):
+            if (page_width is None
+                or margin_left is None
+                or margin_right is None):
                 continue
             try:
                 page_width, _ = self.convert_to_cm(page_width)
@@ -2514,8 +2472,8 @@
                    attrib=attrib, nsdict=SNSD)
         draw_name = 'graphics%d' % next(IMAGE_NAME_COUNTER)
         # Add the content.
-        #el = SubElement(current_element, 'text:p',
-        #    attrib={'text:style-name': self.rststyle('textbody')})
+        # el = SubElement(current_element, 'text:p',
+        #     attrib={'text:style-name': self.rststyle('textbody')})
         attrib = {
             'draw:style-name': style_name,
             'draw:name': draw_name,
@@ -2632,23 +2590,19 @@
                 lambda name, parameters=():
                 self.rststyle(name, parameters),
                 escape_function=escape_cdata)
-        outsource = pygments.highlight(insource, lexer, fmtr)
-        return outsource
+        return pygments.highlight(insource, lexer, fmtr)
 
     def fill_line(self, line):
         line = FILL_PAT1.sub(self.fill_func1, line)
-        line = FILL_PAT2.sub(self.fill_func2, line)
-        return line
+        return FILL_PAT2.sub(self.fill_func2, line)
 
     def fill_func1(self, matchobj):
         spaces = matchobj.group(0)
-        repl = '<text:s text:c="%d"/>' % (len(spaces), )
-        return repl
+        return '<text:s text:c="%d"/>' % (len(spaces), )
 
     def fill_func2(self, matchobj):
         spaces = matchobj.group(0)
-        repl = ' <text:s text:c="%d"/>' % (len(spaces) - 1, )
-        return repl
+        return ' <text:s text:c="%d"/>' % (len(spaces) - 1, )
 
     def visit_literal_block(self, node):
         if len(self.paragraph_style_stack) > 1:
@@ -2658,12 +2612,7 @@
             wrapper1 = '<text:p text:style-name="%s">%%s</text:p>' % (
                 self.rststyle('codeblock'), )
         source = node.astext()
-        if (
-                pygments and
-                self.settings.add_syntax_highlighting
-                #and
-                #node.get('hilight', False)
-        ):
+        if (pygments and self.settings.add_syntax_highlighting):
             language = node.get('language', 'python')
             source = self._add_syntax_highlighting(source, language)
         else:
@@ -2884,11 +2833,11 @@
         self.in_paragraph = False
         self.set_to_parent()
         if self.in_header:
-            self.header_content.append( self.current_element-1 )
-            self.current_element.remove( self.current_element-1 )
+            self.header_content.append(self.current_element-1)
+            self.current_element.remove(self.current_element-1)
         elif self.in_footer:
-            self.footer_content.append( self.current_element-1 )
-            self.current_element.remove( self.current_element-1 )
+            self.footer_content.append(self.current_element-1)
+            self.current_element.remove(self.current_element-1)
 
     def visit_problematic(self, node):
         pass
@@ -2902,9 +2851,9 @@
             formatlist = formats.split()
             if 'odt' in formatlist:
                 rawstr = node.astext()
-                attrstr = ' '.join(
+                attrstr = ' '.join(
                     '%s="%s"' % (k, v, )
-                    for k, v in list(CONTENT_NAMESPACE_ATTRIB.items()))
+                    for k, v in list(CONTENT_NAMESPACE_ATTRIB.items()))
                 contentstr = '<stuff %s>%s</stuff>' % (attrstr, rawstr, )
                 contentstr = contentstr.encode("utf-8")
                 content = etree.fromstring(contentstr)
@@ -2927,13 +2876,12 @@
             pass
 
     def visit_reference(self, node):
-        #text = node.astext()
+        # text = node.astext()
         if self.settings.create_links:
             if 'refuri' in node:
                 href = node'refuri'
-                if (
-                        self.settings.cloak_email_addresses and
-                        href.startswith('mailto:')):
+                if (self.settings.cloak_email_addresses
+                    and href.startswith('mailto:')):
                     href = self.cloak_mailto(href)
                 el = self.append_child('text:a', attrib={
                     'xlink:href': '%s' % href,
@@ -2950,10 +2898,9 @@
             else:
                 self.document.reporter.warning(
                     'References must have "refuri" or "refid" attribute.')
-        if (
-                self.in_table_of_contents and
-                len(node.children) >= 1 and
-                isinstance(node.children0, docutils.nodes.generated)):
+        if (self.in_table_of_contents
+            and len(node.children) >= 1
+            and isinstance(node.children0, docutils.nodes.generated)):
             node.remove(node.children0)
 
     def depart_reference(self, node):
@@ -2969,8 +2916,8 @@
             if class1:
                 style_name = class1
         el = SubElement(self.current_element, 'text:h', attrib={
-            #'text:outline-level': '%d' % section_level,
-            #'text:style-name': 'Heading_20_%d' % section_level,
+            # 'text:outline-level': '%d' % section_level,
+            # 'text:style-name': 'Heading_20_%d' % section_level,
             'text:style-name': style_name,
         })
         text = node.astext()
@@ -3065,15 +3012,15 @@
         }, nsdict=SNSD)
         if table_style.backgroundcolor is None:
             SubElement(el1, 'style:table-properties', attrib={
-                #'style:width': '17.59cm',
-                #'table:align': 'margins',
+                # 'style:width': '17.59cm',
+                # 'table:align': 'margins',
                 'table:align': 'left',
                 'fo:margin-top': '0in',
                 'fo:margin-bottom': '0.10in',
             }, nsdict=SNSD)
         else:
             SubElement(el1, 'style:table-properties', attrib={
-                #'style:width': '17.59cm',
+                # 'style:width': '17.59cm',
                 'table:align': 'margins',
                 'fo:margin-top': '0in',
                 'fo:margin-bottom': '0.10in',
@@ -3204,9 +3151,9 @@
         #
         # I don't know how to implement targets in ODF.
         # How do we create a target in oowriter?  A cross-reference?
-        if not ('refuri' in node or
-                'refid' in node or
-                'refname' in node):
+        if ('refuri' not in node
+                and 'refid' not in node
+                and 'refname' not in node):
             pass
         else:
             pass
@@ -3227,16 +3174,16 @@
             el1 = self.append_child(
                 'text:h', attrib={
                     'text:outline-level': '%d' % section_level,
-                    #'text:style-name': 'Heading_20_%d' % section_level,
+                    # 'text:style-name': 'Heading_20_%d' % section_level,
                     'text:style-name': self.rststyle(
                         'heading%d', (section_level, )),
                 })
             self.append_pending_ids(el1)
             self.set_current_element(el1)
         elif isinstance(node.parent, docutils.nodes.document):
-            #    text = self.settings.title
-            #else:
-            #    text = node.astext()
+            # text = self.settings.title
+            # else:
+            #     text = node.astext()
             el1 = SubElement(self.current_element, 'text:p', attrib={
                 'text:style-name': self.rststyle(title_type),
             })
@@ -3247,9 +3194,8 @@
             self.set_current_element(el1)
 
     def depart_title(self, node):
-        if (
-                isinstance(node.parent, docutils.nodes.section) or
-                isinstance(node.parent, docutils.nodes.document)):
+        if (isinstance(node.parent, docutils.nodes.section)
+            or isinstance(node.parent, docutils.nodes.document)):
             self.set_to_parent()
 
     def visit_subtitle(self, node, move_ids=1):
@@ -3382,9 +3328,8 @@
 
     def update_toc_add_numbers(self, collection):
         for level, el1 in collection:
-            if (
-                    el1.tag == 'text:p' and
-                    el1.text != 'Table of Contents'):
+            if (el1.tag == 'text:p'
+                and el1.text != 'Table of Contents'):
                 el2 = SubElement(el1, 'text:tab')
                 el2.tail = '9999'
 
@@ -3516,8 +3461,7 @@
 class Reader(standalone.Reader):
 
     def get_transforms(self):
-        default = standalone.Reader.get_transforms(self)
-        if self.settings.create_links:
-            return default
-        return i for i in default
-                if i is not references.DanglingReferences
+        transforms = super().get_transforms()
+        if not self.settings.create_links:
+            transforms.remove(references.DanglingReferences)
+        return transforms

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/odf_odt/pygmentsformatter.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/odf_odt/pygmentsformatter.py Changed

@@ -1,4 +1,4 @@
-# $Id: pygmentsformatter.py 5853 2009-01-19 21:02:02Z dkuhlman $
+# $Id: pygmentsformatter.py 9015 2022-03-03 22:15:00Z milde $
 # Author: Dave Kuhlman <dkuhlman@rexx.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -19,7 +19,7 @@
         self.rststyle_function = rststyle_function
         self.escape_function = escape_function
 
-    def rststyle(self, name, parameters=( )):
+    def rststyle(self, name, parameters=()):
         return self.rststyle_function(name, parameters)
 
 
@@ -82,8 +82,8 @@
                 s1 = '<text:span text:style-name="%s">%s</text:span>' % \
                     (s2, value, )
             elif ttype in (tokenclass.Literal.String,
-                    tokenclass.Literal.String.Backtick,
-                    ):
+                           tokenclass.Literal.String.Backtick,
+                           ):
                 s2 = self.rststyle('codeblock-string')
                 s1 = '<text:span text:style-name="%s">%s</text:span>' % \
                     (s2, value, )

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/pep_html/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/pep_html/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8412 2019-11-06 18:15:21Z milde $
+# $Id: __init__.py 9037 2022-03-05 23:31:10Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,12 +9,10 @@
 __docformat__ = 'reStructuredText'
 
 
-import sys
 import os
 import os.path
-import codecs
-import docutils
-from docutils import frontend, nodes, utils, writers
+
+from docutils import frontend, nodes, utils
 from docutils.writers import html4css1
 
 
@@ -33,14 +31,14 @@
         os.path.join(os.path.dirname(__file__), default_template))
 
     settings_spec = html4css1.Writer.settings_spec + (
-        'PEP/HTML-Specific Options',
+        'PEP/HTML Writer Options',
         'For the PEP/HTML writer, the default value for the --stylesheet-path '
         'option is "%s", and the default value for --template is "%s". '
-        'See HTML-Specific Options above.'
+        'See HTML Writer Options above.'
         % (default_stylesheet_path, default_template_path),
-        (('Python\'s home URL.  Default is "http://www.python.org".',
+        (('Python\'s home URL.  Default is "https://www.python.org".',
           '--python-home',
-          {'default': 'http://www.python.org', 'metavar': '<URL>'}),
+          {'default': 'https://www.python.org', 'metavar': '<URL>'}),
          ('Home URL prefix for PEPs.  Default is "." (current directory).',
           '--pep-home',
           {'default': '.', 'metavar': '<URL>'}),
@@ -50,7 +48,7 @@
           {'action': 'store_true', 'validator': frontend.validate_boolean}),))
 
     settings_default_overrides = {'stylesheet_path': default_stylesheet_path,
-                                  'template': default_template_path,}
+                                  'template': default_template_path}
 
     relative_path_settings = ('template',)
 
@@ -102,4 +100,4 @@
     def depart_field_list(self, node):
         html4css1.HTMLTranslator.depart_field_list(self, node)
         if 'rfc2822' in node'classes':
-             self.body.append('<hr />\n')
+            self.body.append('<hr />\n')

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/pep_html/pep.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/pep_html/pep.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/pep_html/template.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/pep_html/template.txt Changed

@@ -1,29 +1,25 @@
-<?xml version="1.0" encoding="%(encoding)s" ?>
+<?xml version="1.0" encoding="%(encoding)s"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=%(encoding)s" />
-  <meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
-  <title>PEP %(pep)s -- %(title)s</title>
+  <meta name="generator" content="Docutils %(version)s: https://docutils.sourceforge.io/" />
+  <title>PEP %(pep)s - %(title)s</title>
   %(stylesheet)s
 </head>
 <body bgcolor="white">
-<table class="navigation" cellpadding="0" cellspacing="0"
-       width="100%%" border="0">
-<tr><td class="navicon" width="150" height="35">
-<a href="%(pyhome)s/" title="Python Home Page">
-<img src="%(pyhome)s/pics/PyBanner%(banner)03d.gif" alt="Python"
- border="0" width="150" height="35" /></a></td>
-<td class="textlinks" align="left">
-<b><a href="%(pyhome)s/">Python Home</a></b>
-<b><a href="%(pepindex)s/">PEP Index</a></b>
-<b><a href="%(pephome)s/pep-%(pepnum)s.txt">PEP Source</a></b>
-</td></tr></table>
+<div class="header">
+<strong>Python Enhancement Proposals</strong>
+| <a href="%(pyhome)s/">Python</a>
+&raquo; <a href="https://peps.python.org/pep-0000/">PEP Index</a>
+&raquo; PEP %(pep)s &ndash; %(title)s
+<hr class="header"/>
+</div>
 <div class="document">
 %(body)s
 %(body_suffix)s

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/pseudoxml.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/pseudoxml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/__init__.py Changed

@@ -1,4 +1,4 @@
-# $Id: __init__.py 8412 2019-11-06 18:15:21Z milde $
+# $Id: __init__.py 9240 2022-11-13 16:15:23Z milde $
 # Authors: Chris Liechti <cliechti@gmx.net>;
 #          David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
@@ -16,12 +16,12 @@
 import docutils
 from docutils import frontend, nodes, utils
 from docutils.writers import html4css1
-from docutils.parsers.rst import directives
 
 themes_dir_path = utils.relative_path(
     os.path.join(os.getcwd(), 'dummy'),
     os.path.join(os.path.dirname(__file__), 'themes'))
 
+
 def find_theme(name):
     # Where else to look for a theme?
     # Check working dir?  Destination dir?  Config dir?  Plugins dir?
@@ -143,7 +143,7 @@
     """Names of theme files directly linked to in the output HTML"""
 
     indirect_theme_files = (
-        's5-core.css', 'framing.css', 'pretty.css', 'blank.gif', 'iepngfix.htc')
+        's5-core.css', 'framing.css', 'pretty.css')
     """Names of files used indirectly; imported or used by files in
     `direct_theme_files`."""
 
@@ -152,7 +152,7 @@
 
     def __init__(self, *args):
         html4css1.HTMLTranslator.__init__(self, *args)
-        #insert S5-specific stylesheet and script stuff:
+        # insert S5-specific stylesheet and script stuff:
         self.theme_file_path = None
         self.setup_theme()
         view_mode = self.document.settings.view_mode
@@ -164,7 +164,7 @@
                                   'control_visibility': control_visibility})
         if not self.document.settings.current_slide:
             self.stylesheet.append(self.disable_current_slide)
-        self.add_meta('<meta name="version" content="S5 1.1" />\n')
+        self.meta.append('<meta name="version" content="S5 1.1" />\n')
         self.s5_footer = 
         self.s5_header = 
         self.section_count = 0
@@ -207,8 +207,8 @@
             for f in os.listdir(path):  # copy all files from each theme
                 if f == self.base_theme_file:
                     continue            # ... except the "__base__" file
-                if ( self.copy_file(f, path, dest)
-                     and f in self.required_theme_files):
+                if (self.copy_file(f, path, dest)
+                    and f in self.required_theme_files):
                     required_files_copiedf = 1
             if default:
                 break                   # "default" theme has no base theme
@@ -216,14 +216,14 @@
             base_theme_file = os.path.join(path, self.base_theme_file)
             # If it exists, read it and record the theme path:
             if os.path.isfile(base_theme_file):
-                with open(base_theme_file) as f:
+                with open(base_theme_file, encoding='utf-8') as f:
                     lines = f.readlines()
                 for line in lines:
                     line = line.strip()
                     if line and not line.startswith('#'):
                         path = find_theme(line)
-                        if path in theme_paths: # check for duplicates (cycles)
-                            path = None         # if found, use default base
+                        if path in theme_paths:  # check for duplicates/cycles
+                            path = None          # if found, use default base
                         else:
                             theme_paths.append(path)
                         break
@@ -242,7 +242,7 @@
                 required.remove(f)
             raise docutils.ApplicationError(
                 'Theme files not found: %s'
-                % ', '.join('%r' % f for f in required))
+                % ', '.join('%r' % f for f in required))
 
     files_to_skip_pattern = re.compile(r'~$|\.bak$|#$|\.cvsignore$')
 
@@ -264,15 +264,14 @@
             if os.path.exists(dest) and not settings.overwrite_theme_files:
                 settings.record_dependencies.add(dest)
             else:
-                src_file = open(source, 'rb')
-                src_data = src_file.read()
-                src_file.close()
-                dest_file = open(dest, 'wb')
-                dest_dir = dest_dir.replace(os.sep, '/')
-                dest_file.write(src_data.replace(b'ui/default',
-                    dest_dirdest_dir.rfind('ui/'):.encode(
-                    sys.getfilesystemencoding())))
-                dest_file.close()
+                with open(source, 'rb') as src_file:
+                    src_data = src_file.read()
+                with open(dest, 'wb') as dest_file:
+                    dest_dir = dest_dir.replace(os.sep, '/')
+                    dest_file.write(src_data.replace(
+                        b'ui/default',
+                        dest_dirdest_dir.rfind('ui/'):.encode(
+                            sys.getfilesystemencoding())))
                 settings.record_dependencies.add(source)
             return 1
         if os.path.isfile(dest):
@@ -283,8 +282,7 @@
                                  self.head_prefix_template %
                                  {'lang': self.settings.language_code})
         self.html_prolog.append(self.doctype)
-        self.meta.insert(0, self.content_type % self.settings.output_encoding)
-        self.head.insert(0, self.content_type % self.settings.output_encoding)
+        self.head = self.meta: + self.head
         if self.math_header:
             if self.math_output == 'mathjax':
                 self.head.extend(self.math_header)

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/README.txt -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/README.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/big-black/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/big-black/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/big-black/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/big-black/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/big-white/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/big-white/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/big-white/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/big-white/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/default/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/default/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/s5-core.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/default/s5-core.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/default/slides.js -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/default/slides.js Changed

@@ -1,5 +1,5 @@
 // S5 v1.1 slides.js -- released into the Public Domain
-// Modified for Docutils (http://docutils.sf.net) by David Goodger
+// Modified for Docutils (https://docutils.sourceforge.io) by David Goodger
 //
 // Please see http://www.meyerweb.com/eric/tools/s5/credits.html for
 // information about all the wonderful and talented contributors to this code!
@@ -66,7 +66,7 @@
 		var children = node.childNodes;
 		for (var i = 0; i < children.length; ++i) {
 			result += nodeValue(childreni);
-		}		
+		}
 	}
 	else if (node.nodeType == 3) {
 		result = node.nodeValue;
@@ -118,8 +118,8 @@
 		cs = document.currentSlide;
 		footer = document.footer.childNodes;
 	}
-	cs.innerHTML = '<span id="csHere">' + snum + '<\/span> ' + 
-		'<span id="csSep">\/<\/span> ' + 
+	cs.innerHTML = '<span id="csHere">' + snum + '<\/span> ' +
+		'<span id="csSep">\/<\/span> ' +
 		'<span id="csTotal">' + (smax-1) + '<\/span>';
 	if (snum == 0) {
 		vis = 'hidden';
@@ -129,7 +129,7 @@
 		if (footer_nodesi.nodeType == 1) {
 			footer_nodesi.style.visibility = vis;
 		}
-	}		
+	}
 }
 
 function go(step) {
@@ -305,7 +305,7 @@
 		target = window.event.srcElement;
 		e = window.event;
 	} else target = e.target;
-    if (target.href != null || hasValue(target.rel, 'external') || isParentOrSelf(target, 'controls') || isParentOrSelf(target,'embed') || isParentOrSelf(target, 'object')) return true; 
+    if (target.href != null || hasValue(target.rel, 'external') || isParentOrSelf(target, 'controls') || isParentOrSelf(target,'embed') || isParentOrSelf(target, 'object')) return true;
 	if (!e.which || e.which == 1) {
 		if (!incrementalssnum || incpos >= incrementalssnum.length) {
 			go(1);
@@ -466,7 +466,7 @@
 
 function getIncrementals(obj) {
 	var incrementals = new Array();
-	if (!obj) 
+	if (!obj)
 		return incrementals;
 	var children = obj.childNodes;
 	for (var i = 0; i < children.length; i++) {

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/medium-black/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/medium-black/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/medium-white/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/medium-white/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/medium-white/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/medium-white/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/small-black/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/small-black/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/small-white/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/small-white/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/s5_html/themes/small-white/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/s5_html/themes/small-white/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/docutils/writers/xetex/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/docutils/writers/xetex/__init__.py Changed

@@ -1,17 +1,15 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# :Author: Günter Milde <milde@users.sourceforge.net>
-# :Revision: $Revision: 8672 $
-# :Date: $Date: 2021-04-07 14:10:06 +0200 (Mi, 07. Apr 2021) $
+#!/usr/bin/env python3
+# :Author: Günter Milde <milde@users.sf.net>
+# :Revision: $Revision: 9293 $
+# :Date: $Date: 2022-12-01 22:13:54 +0100 (Do, 01. Dez 2022) $
 # :Copyright: © 2010 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
-# 
+#
 #    Copying and distribution of this file, with or without modification,
 #    are permitted in any medium without royalty provided the copyright
 #    notice and this notice are preserved.
 #    This file is offered as-is, without any warranty.
-# 
+#
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 
 """
@@ -24,46 +22,44 @@
 
 __docformat__ = 'reStructuredText'
 
-import os
-import os.path
-import re
-
-import docutils
-from docutils import frontend, nodes, utils, writers, languages
+from docutils import frontend
 from docutils.writers import latex2e
 
+
 class Writer(latex2e.Writer):
     """A writer for Unicode-aware LaTeX variants (XeTeX, LuaTeX)"""
 
-    supported = ('lxtex', 'xetex', 'xelatex', 'luatex', 'lualatex')
+    supported = ('latex', 'tex', 'xetex', 'xelatex', 'luatex', 'lualatex')
     """Formats this writer supports."""
 
     default_template = 'xelatex.tex'
-    default_preamble = '\n'.join(
-        r'% Linux Libertine (free, wide coverage, not only for Linux)',
-        r'\setmainfont{Linux Libertine O}',
-        r'\setsansfont{Linux Biolinum O}',
-        r'\setmonofontHyphenChar=None,Scale=MatchLowercase{DejaVu Sans Mono}',
-    )
+    default_preamble = """\
+% Linux Libertine (free, wide coverage, not only for Linux)
+\\setmainfont{Linux Libertine O}
+\\setsansfont{Linux Biolinum O}
+\\setmonofontHyphenChar=None,Scale=MatchLowercase{DejaVu Sans Mono}"""
 
     config_section = 'xetex writer'
-    config_section_dependencies = ('writers', 'latex writers',
-                                   'latex2e writer') # TODO: remove dependency on `latex2e writer`.
+    config_section_dependencies = ('writers', 'latex writers')
 
+    # use a copy of the parent spec with some modifications:
     settings_spec = frontend.filter_settings_spec(
         latex2e.Writer.settings_spec,
+        # removed settings
         'font_encoding',
+        # changed settings:
         template=('Template file. Default: "%s".' % default_template,
-          '--template', {'default': default_template, 'metavar': '<file>'}),
+                  '--template',
+                  {'default': default_template, 'metavar': '<file>'}),
         latex_preamble=('Customization by LaTeX code in the preamble. '
-          'Default: select "Linux Libertine" fonts.',
-          '--latex-preamble',
-          {'default': default_preamble}),
+                        'Default: select "Linux Libertine" fonts.',
+                        '--latex-preamble',
+                        {'default': default_preamble}),
         )
 
     def __init__(self):
         latex2e.Writer.__init__(self)
-        self.settings_defaults.update({'fontencoding': ''}) # use default (TU)
+        self.settings_defaults.update({'fontencoding': ''})  # use default (TU)
         self.translator_class = XeLaTeXTranslator
 
 
@@ -75,26 +71,27 @@
     language_codes = latex2e.Babel.language_codes.copy()
     # Additionally supported or differently named languages:
     language_codes.update({
-        # code          Polyglossia-name       comment
-        'cop':          'coptic',
-        'de':           'german', # new spelling (de_1996)
-        'de-1901':      'ogerman', # old spelling
-        'dv':           'divehi',  # Maldivian
-        'dsb':          'lsorbian',
-        'el-polyton':   'polygreek',
-        'fa':           'farsi',
-        'grc':          'ancientgreek',
-        'hsb':          'usorbian',
-        'sh-Cyrl':      'serbian', # Serbo-Croatian, Cyrillic script
-        'sh-Latn':      'croatian', # Serbo-Croatian, Latin script
-        'sq':           'albanian',
-        'sr':           'serbian', # Cyrillic script (sr-Cyrl)
-        'th':           'thai',
-        'vi':           'vietnamese',
-        # zh-Latn:      ???        #     Chinese Pinyin
+        # code        Polyglossia-name  comment
+        'cop':        'coptic',
+        'de':         'german',         # new spelling (de_1996)
+        'de-1901':    'ogerman',        # old spelling
+        'dv':         'divehi',         # Maldivian
+        'dsb':        'lsorbian',
+        'el-polyton': 'polygreek',
+        'fa':         'farsi',
+        'grc':        'ancientgreek',
+        'ko':         'korean',
+        'hsb':        'usorbian',
+        'sh-Cyrl':    'serbian',        # Serbo-Croatian, Cyrillic script
+        'sh-Latn':    'croatian',       # Serbo-Croatian, Latin script
+        'sq':         'albanian',
+        'sr':         'serbian',        # Cyrillic script (sr-Cyrl)
+        'th':         'thai',
+        'vi':         'vietnamese',
+        # zh-Latn:    ???               # Chinese Pinyin
         })
     # normalize (downcase) keys
-    language_codes = dict((k.lower(), v) for (k, v) in language_codes.items())
+    language_codes = {k.lower(): v for k, v in language_codes.items()}
 
     # Languages without Polyglossia support:
     for key in ('af',           # 'afrikaans',
@@ -108,8 +105,8 @@
                 'fr-CA',        # 'canadien',
                 'grc-ibycus',   # 'ibycus', (Greek Ibycus encoding)
                 'sr-Latn',      # 'serbian script=latin'
-               ):
-        del(language_codeskey.lower())
+                ):
+        del language_codeskey.lower()
 
     def __init__(self, language_code, reporter):
         self.language_code = language_code
@@ -121,7 +118,7 @@
         self.quotes = ('"', '"')
         # language dependent configuration:
         # double quotes are "active" in some languages (e.g. German).
-        self.literal_double_quote = u'"' # TODO: use \textquotedbl ?
+        self.literal_double_quote = '"'  # TODO: use \textquotedbl ?
 
     def __call__(self):
         setup = r'\usepackage{polyglossia}',

_service:tar_scm:docutils-0.17.1.tar.gz/install.py -> _service:tar_scm:docutils-0.20.tar.gz/install.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/licenses/gpl-3-0.txt -> _service:tar_scm:docutils-0.20.tar.gz/licenses/gpl-3-0.txt Changed

@@ -645,7 +645,7 @@
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,11 +664,11 @@
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/philosophy/why-not-lgpl.html>.

_service:tar_scm:docutils-0.17.1.tar.gz/licenses/python-2-1-1.txt -> _service:tar_scm:docutils-0.20.tar.gz/licenses/python-2-1-1.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/manpage-URUE.txt Added

_service:tar_scm:docutils-0.20.tar.gz/math.txt Added

@@ -0,0 +1,105 @@
+Mathematics
+-----------
+
+.. math:: N = \idotsint
+
+Docutils supports inline math with the prefix or postfix ``:math:``
+role specificator, :math:`n! + \sin(x_n^2)` and `A_\text{c} =
+\frac{\pi}{4} d^2`:math:, as well as displayed math via the
+`math` directive:
+
+.. math::
+
+   f(\epsilon) = \frac{1}{1 + \exp\left(\frac{\varepsilon}{k_\text{B}T}\right)}
+
+Content may start on the first line of the directive, e.g.
+
+.. math:: N = \frac{\text{number of apples}}{7}
+
+Equations can be labeled with a reference name using the ``:name:`` option.
+See `eq:M`_ and `eq:schrödinger`_ below.
+
+The determinant of the matrix
+
+.. math:: :name: eq:M
+
+   \mathbf{M} = \left(\begin{matrix}a&b\\c&d\end{matrix}\right)
+
+is :math:`|\mathbf{M}| = ad - bc`.
+
+More than one display math block can be put in one math directive.
+For example, the following sum and integral with limits:
+
+.. math::
+
+          \int_0^1 x^n dx = \frac{1}{n + 1}
+
+          \sum_{n=1}^m n = \frac{m(m+1)}{2}
+
+LaTeX-supported Unicode math symbols can be used in math roles and
+directives:
+
+The Schrödinger equation
+
+.. math:: :name: eq:schrödinger
+
+   i\hbar \frac{∂}{∂t}Ψ = \hat{H}Ψ,
+
+with the *wave function* :math:`Ψ`, describes how the quantum state of a
+physical system changes in time.
+
+Math-Accents:
+  .. list-table::
+     :class: borderless
+     :width: 100%
+
+     * - :math:`\acute{a}`      ``\acute{a}``
+       - :math:`\dot{t}`        ``\dot{t}``
+       - :math:`\hat{\gamma}`   ``\hat{\gamma}``
+
+     * - :math:`\grave{a}`      ``\grave{a}``
+       - :math:`\ddot{t}`       ``\ddot{t}``
+       - :math:`\tilde{\alpha}` ``\tilde{\alpha}``
+
+     * - :math:`\breve{x}`      ``\breve{x}``
+       - :math:`\dddot{t}`      ``\dddot{t}``
+       - :math:`\vec{\imath}`   ``\vec{\imath}``
+
+     * - :math:`\check{a}`      ``\check{a}``
+       - :math:`\bar{a}`        ``\bar{a}``
+       - :math:`\vec{R}`        ``\vec{R}``
+
+..
+       \widetilde{xxx}
+       \widehat{xxx}
+
+Modulation Transfer Function:
+
+.. math::
+
+ \text{MTF} = \left|\frac{\mathcal{F}\{s(x)\}}
+                         {\mathcal{F}\{ s(x)\} |_{ω_{x}=0}}\right|
+            = \mathrm{abs}\left(\frac
+                  {∫_{-∞}^{∞}s(x) \mathrm{e}^{\mathrm{i}ω_{x}x}\mathrm{d}{x}}
+                  {∫_{-∞}^{∞}s(x)\mathrm{d}{x}}
+              \right).
+
+Math split over two lines: If a double backslash is detected outside a
+``\begin{...} \end{...}`` pair, the math code is wrapped in an AMSmath_
+``align`` environment:
+
+.. math::
+
+   s_{\mathrm{out}}(x) & = s_{\mathrm{in}}(x') * s_δ(x-x') \\
+                       & = ∫ s_{\mathrm{in}}(x')s_δ(x-x')\mathrm{d}x'
+
+Cases with the AMSmath_ ``cases`` environment:
+
+.. math::
+
+   \mathrm{sgn}(x) = \begin{cases}
+                                -1 & x<0\\
+                       \phantom{-} 1 & x>0
+                     \end{cases}
+
+.. _AMSmath: ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf

_service:tar_scm:docutils-0.20.tar.gz/mwe-test.txt Added

@@ -0,0 +1,43 @@
+###
+mwe
+###
+a minimal example
+#################
+:Date: October 13, 2021
+:Manual section: 1
+:Manual group: Testing Docutils
+:Version: mwe 0.1.0
+
+Synopsis
+========
+| mwe **-aq** **-b** *file* **\--long-long** *which* *file \...*
+
+Description
+===========
+To find the common attributes of a variety of objects, it is necessary
+to begin, by surveying the *objects* themselves in the concrete. Let us
+therefore advert successively to the various modes of action, and
+arrangements of human affairs, which are classed, by universal or widely
+spread opinion, as Just or as Unjust. The things well known to excite
+the sentiments associated with those names, are of a very multifarious
+character. I shall pass them rapidly in review, without studying any
+particular arrangement.
+The previous line will have been spaced with two spaces.
+
+Options
+=======
+Its arguments are as follows:
+
+-a                         Do all.
+-q                         Be quiet.
+-b file                    Do everything to *file*.
+--long-meme which          Chooses the long named *which*.
+
+Environment
+===========
+mwe is not affected by environment variables.
+
+Exit status
+===========
+mwe exits 0 on success.
+

_service:tar_scm:docutils-0.17.1.tar.gz/setup.cfg -> _service:tar_scm:docutils-0.20.tar.gz/setup.cfg Changed

_service:tar_scm:docutils-0.17.1.tar.gz/setup.py -> _service:tar_scm:docutils-0.20.tar.gz/setup.py Changed

@@ -1,24 +1,26 @@
-#!/usr/bin/env python
-# $Id: setup.py 8705 2021-04-17 12:41:26Z grubert $
+#!/usr/bin/env python3
+# $Id: setup.py 9374 2023-05-09 17:55:19Z grubert $
 # Copyright: This file has been placed in the public domain.
 
-from __future__ import print_function
-
-import glob
-import os
 import sys
 
 try:
     from setuptools import setup
 except ImportError:
-    print('Error: The "setuptools" module, which is required for the')
-    print('  installation of Docutils, could not be found.\n')
-    print('  You may install  it with `python -m pip install setuptools`')
-    print('  or from a package called "python-setuptools" (or similar)')
-    print('  using your system\'s package manager.\n')
-    print('  Alternatively, install a release from PyPi with')
-    print('  `python -m pip install docutils`.')
-    
+    print("""\
+Error: The "setuptools" module, which is required for the
+  installation of Docutils, could not be found.
+
+  You may install  it with `python -m pip install setuptools`
+  or from a package called "python-setuptools" (or similar)
+  using your system\'s package manager.
+
+  Alternatively, install a release from PyPi with
+  `python -m pip install docutils`.'
+
+  If all this fails, try a "manual install".
+  https://docutils.sourceforge.io/docs/dev/repository.html#install-manually
+""")
     sys.exit(1)
 
 
@@ -30,17 +32,17 @@
 into useful formats, such as HTML, XML, and LaTeX.  For
 input Docutils supports reStructuredText, an easy-to-read,
 what-you-see-is-what-you-get plaintext markup syntax.""",  # wrap at col 60
-    'url': 'http://docutils.sourceforge.net/',
-    'version': '0.17.1',
+    'url': 'https://docutils.sourceforge.io/',
+    'version': '0.20',
     'author': 'David Goodger',
     'author_email': 'goodger@python.org',
     'maintainer': 'docutils-develop list',
     'maintainer_email': 'docutils-develop@lists.sourceforge.net',
     'license': 'public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt)',
     'platforms': 'OS-independent',
-    'python_requires': '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*',
+    'python_requires': '>=3.7',
     'include_package_data': True,
-    'exclude_package_data': {"": "docutils.conf"},                
+    'exclude_package_data': {"": "docutils.conf"},
     'package_dir': {
         'docutils': 'docutils',
         'docutils.tools': 'tools'
@@ -51,6 +53,7 @@
         'docutils.parsers',
         'docutils.parsers.rst',
         'docutils.parsers.rst.directives',
+        'docutils.parsers.rst.include',
         'docutils.parsers.rst.languages',
         'docutils.readers',
         'docutils.transforms',
@@ -61,10 +64,15 @@
         'docutils.writers.html5_polyglot',
         'docutils.writers.pep_html',
         'docutils.writers.s5_html',
+        'docutils.writers.s5_html.themes',
+        'docutils.writers.s5_html.themes.default',
         'docutils.writers.latex2e',
         'docutils.writers.xetex',
         'docutils.writers.odf_odt',
     ,
+    'entry_points': {
+        'console_scripts': 'docutils=docutils.__main__:main'
+    },
     'scripts': 
         'tools/rst2html.py',
         'tools/rst2html4.py',
@@ -91,14 +99,12 @@
         'License :: OSI Approved :: BSD License',
         'License :: OSI Approved :: GNU General Public License (GPL)',
         'Operating System :: OS Independent',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Documentation',
         'Topic :: Software Development :: Documentation',
         'Topic :: Text Processing',
@@ -129,6 +135,7 @@
         'Natural Language :: Slovak',
         'Natural Language :: Spanish',
         'Natural Language :: Swedish',
+        'Natural Language :: Ukrainian',
     ,
 }
 """Distutils setup parameters."""
@@ -136,8 +143,7 @@
 
 def do_setup():
     # Install data files properly.
-    dist = setup(**package_data)
-    return dist
+    return setup(**package_data)
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.20.tar.gz/test/__init__.py Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/alltests.py -> _service:tar_scm:docutils-0.20.tar.gz/test/alltests.py Changed

@@ -1,9 +1,9 @@
 #!/bin/sh
-''''exec python -u "$0" "$@" #'''
-from __future__ import print_function
+''''exec python3 -u "$0" "$@" #'''
 
-# $Id: alltests.py 8346 2019-08-26 12:11:32Z milde $
-# Author: David Goodger <goodger@python.org>
+# $Id: alltests.py 9294 2022-12-02 14:00:55Z aa-turner $
+# Author: David Goodger <goodger@python.org>,
+#         Garth Kidd <garth@deadlybloodyserious.com>
 # Copyright: This module has been placed in the public domain.
 
 __doc__ = """\
@@ -15,22 +15,31 @@
 import time
 # Start point for actual elapsed time, including imports
 # and setup outside of unittest.
-start = time.time()  # noqa
+start = time.time()
 
-import sys
-import atexit
-import os
-import platform
-import DocutilsTestSupport              # must be imported before docutils
-import docutils
+import atexit               # noqa: E402
+import os                   # noqa: E402
+from pathlib import Path    # noqa: E402
+import platform             # noqa: E402
+import sys                  # noqa: E402
 
+# Prepend the "docutils root" to the Python library path
+# so we import the local `docutils` package.
+# For Python < 3.9, we need `resolve()` to ensure an absolute path.
+# https://docs.python.org/3/whatsnew/3.9.html#other-language-changes
+DOCUTILS_ROOT = Path(__file__).resolve().parents1
+sys.path.insert(0, str(DOCUTILS_ROOT))
 
-class Tee(object):
+import docutils             # noqa: E402
+
+
+class Tee:
 
     """Write to a file and a stream (default: stdout) simultaneously."""
 
     def __init__(self, filename, stream=sys.__stdout__):
-        self.file = open(filename, 'w')
+        self.file = open(filename, 'w', encoding='utf-8',
+                         errors='backslashreplace')
         atexit.register(self.close)
         self.stream = stream
         self.encoding = getattr(stream, 'encoding', None)
@@ -42,13 +51,11 @@
     def write(self, string):
         try:
             self.stream.write(string)
-            if self.file:
-                self.file.write(string)
-        except UnicodeEncodeError:   # Py3k writing to "ascii" stream/file
-            string = string.encode('raw_unicode_escape').decode('ascii')
-            self.stream.write(string)
-            if self.file:
-                self.file.write(string)
+        except UnicodeEncodeError:
+            bstring = string.encode(self.encoding, errors='backslashreplace')
+            self.stream.write(bstring.decode())
+        if self.file:
+            self.file.write(string)
 
     def flush(self):
         self.stream.flush()
@@ -56,49 +63,33 @@
             self.file.flush()
 
 
-def pformat(suite):
-    step = 4
-    suitestr = repr(suite).replace('=<', '=\n<').replace(', ', ',\n')
-    indent = 0
-    output = 
-    for line in suitestr.splitlines():
-        output.append(' ' * indent + line)
-        if line-1: == '':
-            indent += step
-        else:
-            if line-5: == '>>,':
-                indent -= step * 2
-            elif line-3: == '>,':
-                indent -= step
-    return '\n'.join(output)
-
-
-def suite():
-    path, script = os.path.split(sys.argv0)
-    suite = package_unittest.loadTestModules(DocutilsTestSupport.testroot,
-                                             'test_', packages=1)
-    sys.stdout.flush()
-    return suite
-
-
 # must redirect stderr *before* first import of unittest
 sys.stdout = sys.stderr = Tee('alltests.out')
 
-import package_unittest  # noqa
+import unittest  # NoQA: E402
+
+
+class NumbersTestResult(unittest.TextTestResult):
+    """Result class that counts subTests."""
+    def addSubTest(self, test, subtest, error):
+        super().addSubTest(test, subtest, error)
+        self.testsRun += 1
+        if self.dots:
+            self.stream.write('.' if error is None else 'E')
+            self.stream.flush()
 
 
 if __name__ == '__main__':
-    suite = suite()
-    print('Testing Docutils %s with Python %s on %s at %s' % (
-        docutils.__version__, sys.version.split()0,
-        time.strftime('%Y-%m-%d'), time.strftime('%H:%M:%S')))
-    print('OS: %s %s %s (%s, %s)' % (
-        platform.system(), platform.release(), platform.version(),
-        sys.platform, platform.platform()))
-    print('Working directory: %s' % os.getcwd())
-    print('Docutils package: %s' % os.path.dirname(docutils.__file__))
+    suite = unittest.defaultTestLoader.discover(str(DOCUTILS_ROOT / 'test'))
+    print(f'Testing Docutils {docutils.__version__} '
+          f'with Python {sys.version.split()0} '
+          f'on {time.strftime("%Y-%m-%d at %H:%M:%S")}')
+    print(f'OS: {platform.system()} {platform.release()} {platform.version()} '
+          f'({sys.platform}, {platform.platform()})')
+    print(f'Working directory: {os.getcwd()}')
+    print(f'Docutils package: {os.path.dirname(docutils.__file__)}')
     sys.stdout.flush()
-    result = package_unittest.main(suite)
+    result = unittest.TextTestRunner(resultclass=NumbersTestResult).run(suite)
     finish = time.time()
-    print('Elapsed time: %.3f seconds' % (finish - start))
+    print(f'Elapsed time: {finish - start:.3f} seconds')
     sys.exit(not result.wasSuccessful())

_service:tar_scm:docutils-0.20.tar.gz/test/conftest.py Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/data/config_1.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/data/config_1.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/data/config_2.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/data/config_2.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/test/data/config_encoding.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/config_encoding_2.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/data/config_list.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/data/config_list.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/data/config_list_2.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/data/config_list_2.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/test/data/config_syntax_error.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/help Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/help/docutils.txt Added

@@ -0,0 +1,218 @@
+Usage
+=====
+  docutils options <source> <destination>
+
+Convert documents into useful formats.  Reads from <source> (default is stdin)
+and writes to <destination> (default is stdout).  See
+https://docutils.sourceforge.io/docs/user/config.html for a detailed settings
+reference.
+
+Options
+=======
+General Docutils Options
+------------------------
+--output=<destination>  Output destination name. Obsoletes the <destination>
+                        positional argument. Default: None (stdout).
+--title=<title>         Specify the document title as metadata.
+--generator, -g         Include a "Generated by Docutils" credit and link.
+--no-generator          Do not include a generator credit.
+--date, -d              Include the date at the end of the document (UTC).
+--time, -t              Include the time & date (UTC).
+--no-datestamp          Do not include a datestamp of any kind.
+--source-link, -s       Include a "View document source" link.
+--source-url=<URL>      Use <URL> for a source link; implies --source-link.
+--no-source-link        Do not include a "View document source" link.
+--toc-entry-backlinks   Link from section headers to TOC entries.  (default)
+--toc-top-backlinks     Link from section headers to the top of the TOC.
+--no-toc-backlinks      Disable backlinks to the table of contents.
+--footnote-backlinks    Link from footnotes/citations to references. (default)
+--no-footnote-backlinks
+                        Disable backlinks from footnotes and citations.
+--section-numbering     Enable section numbering by Docutils.  (default)
+--no-section-numbering  Disable section numbering by Docutils.
+--strip-comments        Remove comment elements from the document tree.
+--leave-comments        Leave comment elements in the document tree. (default)
+--strip-elements-with-class=<class>
+                        Remove all elements with classes="<class>" from the
+                        document tree. Warning: potentially dangerous; use
+                        with caution. (Multiple-use option.)
+--strip-class=<class>   Remove all classes="<class>" attributes from elements
+                        in the document tree. Warning: potentially dangerous;
+                        use with caution. (Multiple-use option.)
+--report=<level>, -r <level>
+                        Report system messages at or higher than <level>:
+                        "info" or "1", "warning"/"2" (default), "error"/"3",
+                        "severe"/"4", "none"/"5"
+--verbose, -v           Report all system messages.  (Same as "--report=1".)
+--quiet, -q             Report no system messages.  (Same as "--report=5".)
+--halt=<level>          Halt execution at system messages at or above <level>.
+                        Levels as in --report.  Default: 4 (severe).
+--strict                Halt at the slightest problem.  Same as "--halt=info".
+--exit-status=<level>   Enable a non-zero exit status for non-halting system
+                        messages at or above <level>.  Default: 5 (disabled).
+--debug                 Enable debug-level system messages and diagnostics.
+--no-debug              Disable debug output.  (default)
+--warnings=<file>       Send the output of system messages to <file>.
+--traceback             Enable Python tracebacks when Docutils is halted.
+--no-traceback          Disable Python tracebacks.  (default)
+--input-encoding=<name:handler>, -i <name:handler>
+                        Specify the encoding and optionally the error handler
+                        of input text.  Default: <auto-detect>:strict.
+--input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
+                        Specify the error handler for undecodable characters.
+                        Choices: "strict" (default), "ignore", and "replace".
+--output-encoding=<name:handler>, -o <name:handler>
+                        Specify the text encoding and optionally the error
+                        handler for output.  Default: utf-8:strict.
+--output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
+                        Specify error handler for unencodable output
+                        characters; "strict" (default), "ignore", "replace",
+                        "xmlcharrefreplace", "backslashreplace".
+--error-encoding=<name:handler>, -e <name:handler>
+                        Specify text encoding and optionally error handler for
+                        error output.  Default: utf-8:backslashreplace.
+--error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
+                        Specify the error handler for unencodable characters
+                        in error output.  Default: backslashreplace.
+--language=<name>, -l <name>
+                        Specify the language (as BCP 47 language tag).
+                        Default: en.
+--record-dependencies=<file>
+                        Write output file dependencies to <file>.
+--config=<file>         Read configuration settings from <file>, if it exists.
+--version, -V           Show this program's version number and exit.
+--help, -h              Show this help message and exit.
+
+Generic Parser Options
+----------------------
+--no-file-insertion     Disable directives that insert the contents of an
+                        external file; replaced with a "warning" system
+                        message.
+--file-insertion-enabled
+                        Enable directives that insert the contents of an
+                        external file. (default)
+--no-raw                Disable the "raw" directive; replaced with a "warning"
+                        system message.
+--raw-enabled           Enable the "raw" directive. (default)
+--line-length-limit=<length>
+                        Maximal number of characters in an input line. Default
+                        10 000.
+
+reStructuredText Parser Options
+-------------------------------
+--pep-references        Recognize and link to standalone PEP references (like
+                        "PEP 258").
+--pep-base-url=<URL>    Base URL for PEP references (default
+                        "https://peps.python.org/").
+--pep-file-url-template=<URL>
+                        Template for PEP file part of URL. (default
+                        "pep-%04d")
+--rfc-references        Recognize and link to standalone RFC references (like
+                        "RFC 822").
+--rfc-base-url=<URL>    Base URL for RFC references (default
+                        "https://tools.ietf.org/html/").
+--tab-width=<width>     Set number of spaces for tab expansion (default 8).
+--trim-footnote-reference-space
+                        Remove spaces before footnote references.
+--leave-footnote-reference-space
+                        Leave spaces before footnote references.
+--syntax-highlight=<format>
+                        Token name set for parsing code with Pygments: one of
+                        "long", "short", or "none" (no parsing). Default is
+                        "long".
+--smart-quotes=<yes/no/alt>
+                        Change straight quotation marks to typographic form:
+                        one of "yes", "no", "alternative" (default "no").
+--smartquotes-locales=<language:quotes,language:quotes,...>
+                        Characters to use as "smart quotes" for <language>.
+--word-level-inline-markup
+                        Inline markup recognized at word boundaries only
+                        (adjacent to punctuation or whitespace). Force
+                        character-level inline markup recognition with "\ "
+                        (backslash + space). Default.
+--character-level-inline-markup
+                        Inline markup recognized anywhere, regardless of
+                        surrounding characters. Backslash-escapes must be used
+                        to avoid unwanted markup recognition. Useful for East
+                        Asian languages. Experimental.
+
+Standalone Reader Options
+-------------------------
+--no-doc-title          Disable the promotion of a lone top-level section
+                        title to document title (and subsequent section title
+                        to document subtitle promotion; enabled by default).
+--no-doc-info           Disable the bibliographic field list transform
+                        (enabled by default).
+--section-subtitles     Activate the promotion of lone subsection titles to
+                        section subtitles (disabled by default).
+--no-section-subtitles  Deactivate the promotion of lone subsection titles.
+
+HTML Writer Options
+-------------------
+--template=<file>       Template file. (UTF-8 encoded, default: ...)
+--stylesheet=<URL,URL,...>
+                        Comma separated list of stylesheet URLs. Overrides
+                        previous --stylesheet and --stylesheet-path settings.
+--stylesheet-path=<file,file,...>
+                        Comma separated list of stylesheet paths. Relative
+                        paths are expanded if a matching file is found in the
+                        --stylesheet-dirs. With --link-stylesheet, the path is
+                        rewritten relative to the output HTML file. (default:
+                        "minimal.css,plain.css")
+--stylesheet-dirs=<dir,dir,...>
+                        Comma-separated list of directories where stylesheets
+                        are found. Used by --stylesheet-path when expanding
+                        relative path arguments. (default: ...)
+--embed-stylesheet      Embed the stylesheet(s) in the output HTML file.  The
+                        stylesheet files must be accessible during processing.
+                        (default)
+--link-stylesheet       Link to the stylesheet(s) in the output HTML file.
+--initial-header-level=<level>
+                        Specify the initial header level. Does not affect
+                        document title & subtitle (see --no-doc-title).
+                        (default: 2 for "<h2>")
+--footnote-references=<format>
+                        Format for footnote references: one of "superscript"
+                        or "brackets". (default: "brackets")
+--attribution=<format>  Format for block quote attributions: one of "dash"
+                        (em-dash prefix), "parentheses"/"parens", or "none".
+                        (default: "dash")
+--compact-lists         Remove extra vertical whitespace between items of
+                        "simple" bullet lists and enumerated lists. (default)
+--no-compact-lists      Disable compact simple bullet and enumerated lists.
+--compact-field-lists   Remove extra vertical whitespace between items of
+                        simple field lists. (default)
+--no-compact-field-lists
+                        Disable compact simple field lists.
+--table-style=TABLE_STYLE
+                        Added to standard table classes. Defined styles:
+                        borderless, booktabs, align-left, align-center, align-
+                        right, colwidths-auto, colwidths-grid.
+--math-output=MATH_OUTPUT
+                        Math output format (one of "MathML", "HTML",
+                        "MathJax", or "LaTeX") and option(s). (default: "HTML
+                        math.css")
+--xml-declaration       Prepend an XML declaration.
+--no-xml-declaration    Omit the XML declaration.
+--cloak-email-addresses
+                        Obfuscate email addresses to confuse harvesters while
+                        still keeping email links usable with standards-
+                        compliant browsers.
+
+HTML5 Writer Options
+--------------------
+--image-loading=IMAGE_LOADING
+                        Suggest at which point images should be loaded:
+                        "embed", "link" (default), or "lazy".
+--section-self-link     Append a self-link to section headings.
+--no-section-self-link  Do not append a self-link to section headings.
+                        (default)
+
+Docutils Application Options
+----------------------------
+Reader, writer, and parser settings influence the available options.
+Example: use `--help --writer=latex` to see LaTeX writer options.
+
+--reader=<reader>       Reader name (currently: "standalone").
+--parser=<parser>       Parser name (currently: "rst").
+--writer=<writer>       Writer name (currently: "html5").

_service:tar_scm:docutils-0.20.tar.gz/test/data/help/rst2html.txt Added

@@ -0,0 +1,213 @@
+Usage
+=====
+  rst2html options <source> <destination>
+
+Generate HTML documents from standalone reStructuredText sources
+<https://docutils.sourceforge.io/docs/user/html.html#html>.  Reads from
+<source> (default is stdin) and writes to <destination> (default is stdout).
+See https://docutils.sourceforge.io/docs/user/config.html for a detailed
+settings reference.
+
+Options
+=======
+General Docutils Options
+------------------------
+--output=<destination>  Output destination name. Obsoletes the <destination>
+                        positional argument. Default: None (stdout).
+--title=<title>         Specify the document title as metadata.
+--generator, -g         Include a "Generated by Docutils" credit and link.
+--no-generator          Do not include a generator credit.
+--date, -d              Include the date at the end of the document (UTC).
+--time, -t              Include the time & date (UTC).
+--no-datestamp          Do not include a datestamp of any kind.
+--source-link, -s       Include a "View document source" link.
+--source-url=<URL>      Use <URL> for a source link; implies --source-link.
+--no-source-link        Do not include a "View document source" link.
+--toc-entry-backlinks   Link from section headers to TOC entries.  (default)
+--toc-top-backlinks     Link from section headers to the top of the TOC.
+--no-toc-backlinks      Disable backlinks to the table of contents.
+--footnote-backlinks    Link from footnotes/citations to references. (default)
+--no-footnote-backlinks
+                        Disable backlinks from footnotes and citations.
+--section-numbering     Enable section numbering by Docutils.  (default)
+--no-section-numbering  Disable section numbering by Docutils.
+--strip-comments        Remove comment elements from the document tree.
+--leave-comments        Leave comment elements in the document tree. (default)
+--strip-elements-with-class=<class>
+                        Remove all elements with classes="<class>" from the
+                        document tree. Warning: potentially dangerous; use
+                        with caution. (Multiple-use option.)
+--strip-class=<class>   Remove all classes="<class>" attributes from elements
+                        in the document tree. Warning: potentially dangerous;
+                        use with caution. (Multiple-use option.)
+--report=<level>, -r <level>
+                        Report system messages at or higher than <level>:
+                        "info" or "1", "warning"/"2" (default), "error"/"3",
+                        "severe"/"4", "none"/"5"
+--verbose, -v           Report all system messages.  (Same as "--report=1".)
+--quiet, -q             Report no system messages.  (Same as "--report=5".)
+--halt=<level>          Halt execution at system messages at or above <level>.
+                        Levels as in --report.  Default: 4 (severe).
+--strict                Halt at the slightest problem.  Same as "--halt=info".
+--exit-status=<level>   Enable a non-zero exit status for non-halting system
+                        messages at or above <level>.  Default: 5 (disabled).
+--debug                 Enable debug-level system messages and diagnostics.
+--no-debug              Disable debug output.  (default)
+--warnings=<file>       Send the output of system messages to <file>.
+--traceback             Enable Python tracebacks when Docutils is halted.
+--no-traceback          Disable Python tracebacks.  (default)
+--input-encoding=<name:handler>, -i <name:handler>
+                        Specify the encoding and optionally the error handler
+                        of input text.  Default: <auto-detect>:strict.
+--input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
+                        Specify the error handler for undecodable characters.
+                        Choices: "strict" (default), "ignore", and "replace".
+--output-encoding=<name:handler>, -o <name:handler>
+                        Specify the text encoding and optionally the error
+                        handler for output.  Default: utf-8:strict.
+--output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
+                        Specify error handler for unencodable output
+                        characters; "strict" (default), "ignore", "replace",
+                        "xmlcharrefreplace", "backslashreplace".
+--error-encoding=<name:handler>, -e <name:handler>
+                        Specify text encoding and optionally error handler for
+                        error output.  Default: utf-8:backslashreplace.
+--error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
+                        Specify the error handler for unencodable characters
+                        in error output.  Default: backslashreplace.
+--language=<name>, -l <name>
+                        Specify the language (as BCP 47 language tag).
+                        Default: en.
+--record-dependencies=<file>
+                        Write output file dependencies to <file>.
+--config=<file>         Read configuration settings from <file>, if it exists.
+--version, -V           Show this program's version number and exit.
+--help, -h              Show this help message and exit.
+
+Generic Parser Options
+----------------------
+--no-file-insertion     Disable directives that insert the contents of an
+                        external file; replaced with a "warning" system
+                        message.
+--file-insertion-enabled
+                        Enable directives that insert the contents of an
+                        external file. (default)
+--no-raw                Disable the "raw" directive; replaced with a "warning"
+                        system message.
+--raw-enabled           Enable the "raw" directive. (default)
+--line-length-limit=<length>
+                        Maximal number of characters in an input line. Default
+                        10 000.
+
+reStructuredText Parser Options
+-------------------------------
+--pep-references        Recognize and link to standalone PEP references (like
+                        "PEP 258").
+--pep-base-url=<URL>    Base URL for PEP references (default
+                        "https://peps.python.org/").
+--pep-file-url-template=<URL>
+                        Template for PEP file part of URL. (default
+                        "pep-%04d")
+--rfc-references        Recognize and link to standalone RFC references (like
+                        "RFC 822").
+--rfc-base-url=<URL>    Base URL for RFC references (default
+                        "https://tools.ietf.org/html/").
+--tab-width=<width>     Set number of spaces for tab expansion (default 8).
+--trim-footnote-reference-space
+                        Remove spaces before footnote references.
+--leave-footnote-reference-space
+                        Leave spaces before footnote references.
+--syntax-highlight=<format>
+                        Token name set for parsing code with Pygments: one of
+                        "long", "short", or "none" (no parsing). Default is
+                        "long".
+--smart-quotes=<yes/no/alt>
+                        Change straight quotation marks to typographic form:
+                        one of "yes", "no", "alternative" (default "no").
+--smartquotes-locales=<language:quotes,language:quotes,...>
+                        Characters to use as "smart quotes" for <language>.
+--word-level-inline-markup
+                        Inline markup recognized at word boundaries only
+                        (adjacent to punctuation or whitespace). Force
+                        character-level inline markup recognition with "\ "
+                        (backslash + space). Default.
+--character-level-inline-markup
+                        Inline markup recognized anywhere, regardless of
+                        surrounding characters. Backslash-escapes must be used
+                        to avoid unwanted markup recognition. Useful for East
+                        Asian languages. Experimental.
+
+Standalone Reader Options
+-------------------------
+--no-doc-title          Disable the promotion of a lone top-level section
+                        title to document title (and subsequent section title
+                        to document subtitle promotion; enabled by default).
+--no-doc-info           Disable the bibliographic field list transform
+                        (enabled by default).
+--section-subtitles     Activate the promotion of lone subsection titles to
+                        section subtitles (disabled by default).
+--no-section-subtitles  Deactivate the promotion of lone subsection titles.
+
+HTML Writer Options
+-------------------
+--template=<file>       Template file. (UTF-8 encoded, default: ...)
+--stylesheet=<URL,URL,...>
+                        Comma separated list of stylesheet URLs. Overrides
+                        previous --stylesheet and --stylesheet-path settings.
+--stylesheet-path=<file,file,...>
+                        Comma separated list of stylesheet paths. Relative
+                        paths are expanded if a matching file is found in the
+                        --stylesheet-dirs. With --link-stylesheet, the path is
+                        rewritten relative to the output HTML file. (default:
+                        "html4css1.css")
+--stylesheet-dirs=<dir,dir,...>
+                        Comma-separated list of directories where stylesheets
+                        are found. Used by --stylesheet-path when expanding
+                        relative path arguments. (default: ...)
+--embed-stylesheet      Embed the stylesheet(s) in the output HTML file.  The
+                        stylesheet files must be accessible during processing.
+                        (default)
+--link-stylesheet       Link to the stylesheet(s) in the output HTML file.
+--initial-header-level=<level>
+                        Specify the initial header level. Does not affect
+                        document title & subtitle (see --no-doc-title).
+                        (default: 1 for "<h1>")
+--footnote-references=<format>
+                        Format for footnote references: one of "superscript"
+                        or "brackets". (default: "brackets")
+--attribution=<format>  Format for block quote attributions: one of "dash"
+                        (em-dash prefix), "parentheses"/"parens", or "none".
+                        (default: "dash")
+--compact-lists         Remove extra vertical whitespace between items of
+                        "simple" bullet lists and enumerated lists. (default)
+--no-compact-lists      Disable compact simple bullet and enumerated lists.
+--compact-field-lists   Remove extra vertical whitespace between items of
+                        simple field lists. (default)
+--no-compact-field-lists
+                        Disable compact simple field lists.
+--table-style=TABLE_STYLE
+                        Added to standard table classes. Defined styles:
+                        borderless, booktabs, align-left, align-center, align-
+                        right, colwidths-auto, colwidths-grid.
+--math-output=MATH_OUTPUT
+                        Math output format (one of "MathML", "HTML",
+                        "MathJax", or "LaTeX") and option(s). (default: "HTML
+                        math.css")
+--xml-declaration       Prepend an XML declaration (default).
+--no-xml-declaration    Omit the XML declaration.
+--cloak-email-addresses
+                        Obfuscate email addresses to confuse harvesters while
+                        still keeping email links usable with standards-
+                        compliant browsers.
+
+HTML4 Writer Options
+--------------------
+--field-name-limit=<level>
+                        Specify the maximum width (in characters) for one-
+                        column field names.  Longer field names will span an
+                        entire row of the table used to render the field list.
+                        Default is 14 characters.  Use 0 for "no limit".
+--option-limit=<level>  Specify the maximum width (in characters) for options
+                        in option lists.  Longer options will span an entire
+                        row of the table used to render the option list.
+                        Default is 14 characters.  Use 0 for "no limit".

_service:tar_scm:docutils-0.20.tar.gz/test/data/help/rst2latex.txt Added

@@ -0,0 +1,255 @@
+Usage
+=====
+  rst2latex options <source> <destination>
+
+Generate LaTeX documents from standalone reStructuredText sources
+<https://docutils.sourceforge.io/docs/user/latex.html>.  Reads from <source>
+(default is stdin) and writes to <destination> (default is stdout).  See
+https://docutils.sourceforge.io/docs/user/config.html for a detailed settings
+reference.
+
+Options
+=======
+General Docutils Options
+------------------------
+--output=<destination>  Output destination name. Obsoletes the <destination>
+                        positional argument. Default: None (stdout).
+--title=<title>         Specify the document title as metadata.
+--generator, -g         Include a "Generated by Docutils" credit and link.
+--no-generator          Do not include a generator credit.
+--date, -d              Include the date at the end of the document (UTC).
+--time, -t              Include the time & date (UTC).
+--no-datestamp          Do not include a datestamp of any kind.
+--source-link, -s       Include a "View document source" link.
+--source-url=<URL>      Use <URL> for a source link; implies --source-link.
+--no-source-link        Do not include a "View document source" link.
+--toc-entry-backlinks   Link from section headers to TOC entries.  (default)
+--toc-top-backlinks     Link from section headers to the top of the TOC.
+--no-toc-backlinks      Disable backlinks to the table of contents.
+--footnote-backlinks    Link from footnotes/citations to references. (default)
+--no-footnote-backlinks
+                        Disable backlinks from footnotes and citations.
+--section-numbering     Enable section numbering by Docutils.  (default)
+--no-section-numbering  Disable section numbering by Docutils.
+--strip-comments        Remove comment elements from the document tree.
+--leave-comments        Leave comment elements in the document tree. (default)
+--strip-elements-with-class=<class>
+                        Remove all elements with classes="<class>" from the
+                        document tree. Warning: potentially dangerous; use
+                        with caution. (Multiple-use option.)
+--strip-class=<class>   Remove all classes="<class>" attributes from elements
+                        in the document tree. Warning: potentially dangerous;
+                        use with caution. (Multiple-use option.)
+--report=<level>, -r <level>
+                        Report system messages at or higher than <level>:
+                        "info" or "1", "warning"/"2" (default), "error"/"3",
+                        "severe"/"4", "none"/"5"
+--verbose, -v           Report all system messages.  (Same as "--report=1".)
+--quiet, -q             Report no system messages.  (Same as "--report=5".)
+--halt=<level>          Halt execution at system messages at or above <level>.
+                        Levels as in --report.  Default: 4 (severe).
+--strict                Halt at the slightest problem.  Same as "--halt=info".
+--exit-status=<level>   Enable a non-zero exit status for non-halting system
+                        messages at or above <level>.  Default: 5 (disabled).
+--debug                 Enable debug-level system messages and diagnostics.
+--no-debug              Disable debug output.  (default)
+--warnings=<file>       Send the output of system messages to <file>.
+--traceback             Enable Python tracebacks when Docutils is halted.
+--no-traceback          Disable Python tracebacks.  (default)
+--input-encoding=<name:handler>, -i <name:handler>
+                        Specify the encoding and optionally the error handler
+                        of input text.  Default: <auto-detect>:strict.
+--input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
+                        Specify the error handler for undecodable characters.
+                        Choices: "strict" (default), "ignore", and "replace".
+--output-encoding=<name:handler>, -o <name:handler>
+                        Specify the text encoding and optionally the error
+                        handler for output.  Default: utf-8:strict.
+--output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
+                        Specify error handler for unencodable output
+                        characters; "strict" (default), "ignore", "replace",
+                        "xmlcharrefreplace", "backslashreplace".
+--error-encoding=<name:handler>, -e <name:handler>
+                        Specify text encoding and optionally error handler for
+                        error output.  Default: utf-8:backslashreplace.
+--error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
+                        Specify the error handler for unencodable characters
+                        in error output.  Default: backslashreplace.
+--language=<name>, -l <name>
+                        Specify the language (as BCP 47 language tag).
+                        Default: en.
+--record-dependencies=<file>
+                        Write output file dependencies to <file>.
+--config=<file>         Read configuration settings from <file>, if it exists.
+--version, -V           Show this program's version number and exit.
+--help, -h              Show this help message and exit.
+
+Generic Parser Options
+----------------------
+--no-file-insertion     Disable directives that insert the contents of an
+                        external file; replaced with a "warning" system
+                        message.
+--file-insertion-enabled
+                        Enable directives that insert the contents of an
+                        external file. (default)
+--no-raw                Disable the "raw" directive; replaced with a "warning"
+                        system message.
+--raw-enabled           Enable the "raw" directive. (default)
+--line-length-limit=<length>
+                        Maximal number of characters in an input line. Default
+                        10 000.
+
+reStructuredText Parser Options
+-------------------------------
+--pep-references        Recognize and link to standalone PEP references (like
+                        "PEP 258").
+--pep-base-url=<URL>    Base URL for PEP references (default
+                        "https://peps.python.org/").
+--pep-file-url-template=<URL>
+                        Template for PEP file part of URL. (default
+                        "pep-%04d")
+--rfc-references        Recognize and link to standalone RFC references (like
+                        "RFC 822").
+--rfc-base-url=<URL>    Base URL for RFC references (default
+                        "https://tools.ietf.org/html/").
+--tab-width=<width>     Set number of spaces for tab expansion (default 8).
+--trim-footnote-reference-space
+                        Remove spaces before footnote references.
+--leave-footnote-reference-space
+                        Leave spaces before footnote references.
+--syntax-highlight=<format>
+                        Token name set for parsing code with Pygments: one of
+                        "long", "short", or "none" (no parsing). Default is
+                        "long".
+--smart-quotes=<yes/no/alt>
+                        Change straight quotation marks to typographic form:
+                        one of "yes", "no", "alternative" (default "no").
+--smartquotes-locales=<language:quotes,language:quotes,...>
+                        Characters to use as "smart quotes" for <language>.
+--word-level-inline-markup
+                        Inline markup recognized at word boundaries only
+                        (adjacent to punctuation or whitespace). Force
+                        character-level inline markup recognition with "\ "
+                        (backslash + space). Default.
+--character-level-inline-markup
+                        Inline markup recognized anywhere, regardless of
+                        surrounding characters. Backslash-escapes must be used
+                        to avoid unwanted markup recognition. Useful for East
+                        Asian languages. Experimental.
+
+Standalone Reader Options
+-------------------------
+--no-doc-title          Disable the promotion of a lone top-level section
+                        title to document title (and subsequent section title
+                        to document subtitle promotion; enabled by default).
+--no-doc-info           Disable the bibliographic field list transform
+                        (enabled by default).
+--section-subtitles     Activate the promotion of lone subsection titles to
+                        section subtitles (disabled by default).
+--no-section-subtitles  Deactivate the promotion of lone subsection titles.
+
+LaTeX-Specific Options
+----------------------
+--documentclass=DOCUMENTCLASS
+                        Specify LaTeX documentclass.  Default: "article".
+--documentoptions=DOCUMENTOPTIONS
+                        Specify document options.  Multiple options can be
+                        given, separated by commas.  Default: "a4paper".
+--footnote-references=<format>
+                        Format for footnote references: one of "superscript"
+                        or "brackets".  Default: "superscript".
+--use-latex-citations   Use \cite command for citations. (future default)
+--figure-citations      Use figure floats for citations (might get mixed with
+                        real figures). (provisional default)
+--attribution=<format>  Format for block quote attributions: one of "dash"
+                        (em-dash prefix), "parentheses"/"parens", or "none".
+                        Default: "dash".
+--stylesheet=<file,file,...>
+                        Specify LaTeX packages/stylesheets. A style is
+                        referenced with "\usepackage" if extension is ".sty"
+                        or omitted and with "\input" else.  Overrides previous
+                        --stylesheet and --stylesheet-path settings.
+--stylesheet-path=<file,file,...>
+                        Comma separated list of LaTeX packages/stylesheets.
+                        Relative paths are expanded if a matching file is
+                        found in the --stylesheet-dirs. With --link-
+                        stylesheet, the path is rewritten relative to the
+                        output *.tex file.
+--link-stylesheet       Link to the stylesheet(s) in the output file.
+                        (default)
+--embed-stylesheet      Embed the stylesheet(s) in the output file.
+                        Stylesheets must be accessible during processing.
+--stylesheet-dirs=<dir,dir,...>
+                        Comma-separated list of directories where stylesheets
+                        are found. Used by --stylesheet-path when expanding
+                        relative path arguments. Default: ".".
+--latex-preamble=LATEX_PREAMBLE
+                        Customization by LaTeX code in the preamble. Default:
+                        select PDF standard fonts (Times, Helvetica, Courier).
+--template=<file>       Specify the template file. Default: "default.tex".
+--use-latex-toc         Table of contents by LaTeX. (default)
+--use-docutils-toc      Table of contents by Docutils (without page numbers).
+--use-part-section      Add parts on top of the section hierarchy.
+--use-docutils-docinfo  Attach author and date to the document info table.
+                        (default)
+--use-latex-docinfo     Attach author and date to the document title.
+--topic-abstract        Typeset abstract as topic. (default)
+--use-latex-abstract    Use LaTeX abstract environment for the document's
+                        abstract.
+--hyperlink-color=HYPERLINK_COLOR
+                        Color of any hyperlinks embedded in text. Default:
+                        "blue" (use "false" to disable).
+--hyperref-options=HYPERREF_OPTIONS
+                        Additional options to the "hyperref" package.
+--compound-enumerators  Enable compound enumerators for nested enumerated
+                        lists (e.g. "1.2.a.ii").
+--no-compound-enumerators
+                        Disable compound enumerators for nested enumerated
+                        lists. (default)
+--section-prefix-for-enumerators
+                        Enable section ("." subsection ...) prefixes for
+                        compound enumerators.  This has no effect without
+                        --compound-enumerators.
+--no-section-prefix-for-enumerators
+                        Disable section prefixes for compound enumerators.
+                        (default)
+--section-enumerator-separator=<char>
+                        Set the separator between section number and
+                        enumerator for compound enumerated lists.  Default:
+                        "-".
+--literal-block-env=LITERAL_BLOCK_ENV
+                        When possible, use the specified environment for
+                        literal-blocks. Default: "" (fall back to "alltt").
+--use-verbatim-when-possible
+                        Deprecated alias for "--literal-block-env=verbatim".
+--table-style=<format>  Table style. "standard" with horizontal and vertical
+                        lines, "booktabs" (LaTeX booktabs style) only
+                        horizontal lines above and below the table and below
+                        the header, or "borderless". Default: "standard"
+--graphicx-option=GRAPHICX_OPTION
+                        LaTeX graphicx package option. Possible values are
+                        "dvipdfmx", "dvips", "dvisvgm", "luatex", "pdftex",
+                        and "xetex".Default: "".
+--font-encoding=FONT_ENCODING
+                        LaTeX font encoding. Possible values are "", "T1"
+                        (default), "OT1", "LGR,T1" or any other combination of
+                        options to the `fontenc` package.
+--reference-label=REFERENCE_LABEL
+                        Per default the latex-writer puts the reference title
+                        into hyperreferences. Specify "ref*" or "pageref*" to
+                        get the section number or the page number.
+--use-bibtex=<style,bibfile,bibfile,...>
+                        Specify style and database(s) for bibtex, for example
+                        "--use-bibtex=unsrt,mydb1,mydb2". Provisional!
+--legacy-class-functions
+                        Use legacy functions with class value list for
+                        \DUtitle and \DUadmonition.
+--new-class-functions   Use \DUrole and "DUclass" wrappers for class values.
+                        Place admonition content in an environment. (default)
+--legacy-column-widths  Use legacy algorithm to determine table column widths.
+                        (provisional default)
+--new-column-widths     Use new algorithm to determine table column widths.
+                        (future default)
+--docutils-footnotes    Footnotes with numbers/symbols by Docutils. (default)
+                        (The alternative, --latex-footnotes, is not
+                        implemented yet.)

_service:tar_scm:docutils-0.20.tar.gz/test/data/latin2.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/utf-16-le-sig.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/utf-8-sig.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/data/utf8.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/compact_lists.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/compact_lists.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/cyrillic.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/cyrillic.tex Changed

@@ -1,9 +1,8 @@
 \documentclassa4paper,russian{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1,T2A{fontenc}
-\usepackageutf8{inputenc}
 \usepackageenglish,russian{babel}
 \setcounter{secnumdepth}{0}
 
@@ -18,12 +17,9 @@
 
 %%% Fallback definitions for Docutils-specific commands
 
-% titlereference standard role
-\providecommand*{\DUroletitlereference}1{\textsl{#1}}
-
 % hyperlinks:
 \ifthenelse{\isundefined{\hypersetup}}{
-  \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue,unicode=true{hyperref}
+  \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue{hyperref}
   \usepackage{bookmark}
   \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
 }{}
@@ -49,18 +45,14 @@
 \foreignlanguage{english}{first example: “Hello world”.}
 
 
-\section{Notes%
-  \label{notes}%
+\section{Примечания%
+  \label{section-2}%
 }
 
-\foreignlanguage{english}{This example tests rendering of Latin and Cyrillic characters by the LaTeX
-and XeTeX writers. Check the compiled PDF for garbage characters in text and
-bookmarks.}
+Этот документ испытивает изображение LaTeXом кириллических букв.
 
-\foreignlanguage{english}{To work around a problem with Cyrillic in PDF-bookmarks in \DUroletitlereference{hyperref}
-versions older than v6.79g 2009/11/20, the test caller \texttt{latex\_cyrillic.py}
-sets \texttt{hyperref\_options} to \texttt{'unicode=true'} while \texttt{xetex\_cyrillic.py}
-sets it to \texttt{'unicode=false'}. The recommended option for current
-(2011-08-24) hyperref versions is \texttt{'pdfencoding=auto'}.}
+\foreignlanguage{english}{This document tests the rendering of Latin and Cyrillic characters by the
+LaTeX and XeTeX writers. Check the compiled PDF for garbage characters in
+text and bookmarks.}
 
 \end{document}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/dangerous.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/dangerous.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/embed_images_html5.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/embed_images_html5.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/field_name_limit.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/field_name_limit.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/footnotes_html5.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/footnotes_html5.html Changed

@@ -1,66 +1,131 @@
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<meta charset="utf-8"/>
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 <title>Test footnote and citation rendering</title>
 <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
-<link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/responsive.css" type="text/css" />
 </head>
 <body>
 <main id="test-footnote-and-citation-rendering">
 <h1 class="title">Test footnote and citation rendering</h1>
 
-<p>Paragraphs may contain footnote references (manually numbered<a class="footnote-reference superscript" href="#footnote-1" id="footnote-reference-1">1</a>, anonymous auto-numbered<a class="footnote-reference superscript" href="#footnote-2" id="footnote-reference-2">3</a>, labeled auto-numbered<a class="footnote-reference superscript" href="#label" id="footnote-reference-3">2</a>, or
-symbolic<a class="footnote-reference superscript" href="#footnote-3" id="footnote-reference-4">*</a>) or citation references (<a class="citation-reference" href="#cit2002" id="citation-reference-1">CIT2002</a>, <a class="citation-reference" href="#du2015" id="citation-reference-2">DU2015</a>).</p>
-<dl class="footnote superscript">
-<dt class="label" id="footnote-1"><span class="superscript">1</span><span class="fn-backref">(<a href="#footnote-reference-1">1</a>,<a href="#footnote-reference-5">2</a>)</span></dt>
-<dd><p>A footnote contains body elements, consistently indented by at
+<p>Paragraphs may contain footnote references (manually numbered<a class="footnote-reference superscript" href="#footnote-1" id="footnote-reference-1" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a>, anonymous auto-numbered<a class="footnote-reference superscript" href="#footnote-2" id="footnote-reference-2" role="doc-noteref"><span class="fn-bracket"></span>3<span class="fn-bracket"></span></a>, labeled auto-numbered<a class="footnote-reference superscript" href="#label" id="footnote-reference-3" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a>, or
+symbolic<a class="footnote-reference superscript" href="#footnote-3" id="footnote-reference-4" role="doc-noteref"><span class="fn-bracket"></span>*<span class="fn-bracket"></span></a>) or citation references (<a class="citation-reference" href="#cit2002" id="citation-reference-1" role="doc-biblioref">CIT2002</a>, <a class="citation-reference" href="#du2015" id="citation-reference-2" role="doc-biblioref">DU2015</a>).</p>
+<aside class="footnote-list superscript">
+<aside class="footnote superscript" id="footnote-1" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-1">1</a>,<a role="doc-backlink" href="#footnote-reference-5">2</a>)</span>
+<p>A footnote contains body elements, consistently indented by at
 least 3 spaces.</p>
 <p>This is the footnote's second paragraph.</p>
-</dd>
-<dt class="label" id="label"><span class="superscript">2</span><span class="fn-backref">(<a href="#footnote-reference-3">1</a>,<a href="#footnote-reference-6">2</a>)</span></dt>
-<dd><p>Footnotes may be numbered, either manually (as in<a class="footnote-reference superscript" href="#footnote-1" id="footnote-reference-5">1</a>) or
+</aside>
+<aside class="footnote superscript" id="label" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-3">1</a>,<a role="doc-backlink" href="#footnote-reference-6">2</a>)</span>
+<p>Footnotes may be numbered, either manually (as in<a class="footnote-reference superscript" href="#footnote-1" id="footnote-reference-5" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a>) or
 automatically using a &quot;#&quot;-prefixed label.  This footnote has a
 label so it can be referred to from multiple places, both as a
-footnote reference (<a class="footnote-reference superscript" href="#label" id="footnote-reference-6">2</a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p>
-</dd>
-<dt class="label" id="footnote-2"><span class="superscript"><a class="fn-backref" href="#footnote-reference-2">3</a></span></dt>
-<dd><p>This footnote is numbered automatically and anonymously using a
+footnote reference (<a class="footnote-reference superscript" href="#label" id="footnote-reference-6" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p>
+</aside>
+<aside class="footnote superscript" id="footnote-2" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-2">3</a><span class="fn-bracket"></span></span>
+<p>This footnote is numbered automatically and anonymously using a
 label of &quot;#&quot; only.</p>
 <p>This is the second paragraph.</p>
 <p>And this is the third paragraph.</p>
-</dd>
-<dt class="label" id="footnote-3"><span class="superscript"><a class="fn-backref" href="#footnote-reference-4">*</a></span></dt>
-<dd><p>Footnotes may also use symbols, specified with a &quot;*&quot; label.
-Here's a reference to the next footnote:<a class="footnote-reference superscript" href="#footnote-4" id="footnote-reference-7">†</a>.</p>
-</dd>
-<dt class="label" id="footnote-4"><span class="superscript"><a class="fn-backref" href="#footnote-reference-7">†</a></span></dt>
-<dd><p>This footnote shows the next symbol in the sequence.</p>
-</dd>
-<dt class="label" id="footnote-5"><span class="superscript">4</span></dt>
-<dd><p>Here's an unreferenced footnote, with a reference to a
-nonexistent footnote:<a class="footnote-reference superscript" href="#footnote-6" id="footnote-reference-8">5</a>.</p>
-</dd>
-</dl>
+</aside>
+<aside class="footnote superscript" id="footnote-3" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-4">*</a><span class="fn-bracket"></span></span>
+<p>Footnotes may also use symbols, specified with a &quot;*&quot; label.
+Here's a reference to the next footnote:<a class="footnote-reference superscript" href="#footnote-4" id="footnote-reference-7" role="doc-noteref"><span class="fn-bracket"></span>†<span class="fn-bracket"></span></a>.</p>
+</aside>
+<aside class="footnote superscript" id="footnote-4" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-7">†</a><span class="fn-bracket"></span></span>
+<p>This footnote shows the next symbol in the sequence.</p>
+</aside>
+<aside class="footnote superscript" id="footnote-5" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>4<span class="fn-bracket"></span></span>
+<p>Here's an unreferenced footnote, with a reference to a
+nonexistent footnote:<a class="footnote-reference superscript" href="#footnote-6" id="footnote-reference-8" role="doc-noteref"><span class="fn-bracket"></span>5<span class="fn-bracket"></span></a>.</p>
+</aside>
+</aside>
 <section id="citations">
-<h2>Citations</h2>
-<dl class="citation">
-<dt class="label" id="cit2002"><span class="brackets">CIT2002</span><span class="fn-backref">(<a href="#citation-reference-1">1</a>,<a href="#citation-reference-3">2</a>)</span></dt>
-<dd><p>Citations are text-labeled footnotes. They may be
+<h2>Citations<a class="self-link" title="link to this section" href="#citations"></a></h2>
+<div role="list" class="citation-list">
+<div class="citation" id="cit2002" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>CIT2002<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#citation-reference-1">1</a>,<a role="doc-backlink" href="#citation-reference-3">2</a>)</span>
+<p>Citations are text-labeled footnotes. They may be
 rendered separately and differently from footnotes.</p>
+</div>
+<div class="citation" id="du2015" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#citation-reference-2">DU2015</a><span class="fn-bracket"></span></span>
+<p><cite>Example document</cite>, Hometown: 2015.</p>
+</div>
+</div>
+<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="citation-reference-3" role="doc-biblioref">CIT2002</a>.</p>
+<aside class="footnote-list superscript">
+<aside class="footnote superscript" id="footnote-6" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-8">5</a><span class="fn-bracket"></span></span>
+<p>this footnote is missing in the standard example document.</p>
+</aside>
+</aside>
+<p>Footnotes may contain block elements like lists<a class="footnote-reference superscript" href="#footnote-7" id="footnote-reference-9" role="doc-noteref"><span class="fn-bracket"></span>6<span class="fn-bracket"></span></a><a class="footnote-reference superscript" href="#list-note" id="footnote-reference-10" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a><a class="footnote-reference superscript" href="#footnote-8" id="footnote-reference-11" role="doc-noteref"><span class="fn-bracket"></span>8<span class="fn-bracket"></span></a>,
+admonitions<a class="footnote-reference superscript" href="#footnote-9" id="footnote-reference-12" role="doc-noteref"><span class="fn-bracket"></span>9<span class="fn-bracket"></span></a>, or tables<a class="footnote-reference superscript" href="#footnote-10" id="footnote-reference-13" role="doc-noteref"><span class="fn-bracket"></span>10<span class="fn-bracket"></span></a>.</p>
+<aside class="footnote-list superscript">
+<aside class="footnote superscript" id="footnote-7" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-9">6</a><span class="fn-bracket"></span></span>
+<ol class="arabic simple">
+<li><p>An ordered list</p></li>
+<li><p>in a footnote.</p></li>
+</ol>
+</aside>
+<aside class="footnote superscript" id="list-note" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-10">1</a>,<a role="doc-backlink" href="#footnote-reference-14">2</a>)</span>
+<ul class="simple">
+<li><p>An unordered list (bullet list)</p></li>
+<li><p>in a footnote.</p></li>
+</ul>
+<p>And a trailing paragraph.</p>
+</aside>
+<aside class="footnote superscript" id="footnote-8" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-11">8</a><span class="fn-bracket"></span></span>
+<dl class="field-list simple">
+<dt>Field<span class="colon">:</span></dt>
+<dd><p>list</p>
 </dd>
-<dt class="label" id="du2015"><span class="brackets"><a class="fn-backref" href="#citation-reference-2">DU2015</a></span></dt>
-<dd><p><cite>Example document</cite>, Hometown: 2015.</p>
-</dd>
-</dl>
-<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="citation-reference-3">CIT2002</a>.</p>
-<dl class="footnote superscript">
-<dt class="label" id="footnote-6"><span class="superscript"><a class="fn-backref" href="#footnote-reference-8">5</a></span></dt>
-<dd><p>this footnote is missing in the standard example document.</p>
+<dt>with<span class="colon">:</span></dt>
+<dd><p>2 items.</p>
 </dd>
 </dl>
+</aside>
+<aside class="footnote superscript" id="footnote-9" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-12">9</a><span class="fn-bracket"></span></span>
+<aside class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This is a note in a note.</p>
+</aside>
+</aside>
+<aside class="footnote superscript" id="footnote-10" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-13">10</a><span class="fn-bracket"></span></span>
+<table>
+<tbody>
+<tr><td><p>a</p></td>
+<td><p>table</p></td>
+</tr>
+<tr><td><p>in a</p></td>
+<td><p>footnote</p></td>
+</tr>
+</tbody>
+</table>
+</aside>
+</aside>
+<p>This<a class="footnote-reference superscript" href="#list-note" id="footnote-reference-14" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a> is a second reference to the footnote containing
+a bullet. list.</p>
 </section>
 </main>
 </body>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_babel.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_babel.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_cornercases.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_cornercases.tex Changed

@@ -1,16 +1,24 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
-\usepackage{booktabs}
+\DeclareUnicodeCharacter{21D4}{\ensuremath{\Leftrightarrow}}
+\DeclareUnicodeCharacter{2660}{\ensuremath{\spadesuit}}
+\DeclareUnicodeCharacter{2663}{\ensuremath{\clubsuit}}
+\usepackage{alltt}
+\usepackage{amsmath}
+\usepackage{float} % extended float configuration
+\floatplacement{figure}{H} % place figures here definitely
 \usepackage{graphicx}
 \usepackage{multirow}
+\usepackage{pifont}
 \setcounter{secnumdepth}{0}
 \usepackage{longtable,ltcaption,array}
 \setlength{\extrarowheight}{2pt}
 \newlength{\DUtablewidth} % internal use in tables
+\newcommand{\DUcolumnwidth}1{\dimexpr#1\DUtablewidth-2\tabcolsep\relax}
+\usepackage{textcomp} % text symbol macros
 
 %%% Custom LaTeX preamble
 % PDF Standard Fonts
@@ -22,6 +30,79 @@
 
 %%% Fallback definitions for Docutils-specific commands
 
+% class handling for environments (block-level elements)
+% \begin{DUclass}{spam} tries \DUCLASSspam and
+% \end{DUclass}{spam} tries \endDUCLASSspam
+\ifx\DUclass\undefined % poor man's "provideenvironment"
+ \newenvironment{DUclass}1%
+  {% "#1" does not work in end-part of environment.
+   \def\DocutilsClassFunctionName{DUCLASS#1}
+     \csname \DocutilsClassFunctionName \endcsname}%
+  {\csname end\DocutilsClassFunctionName \endcsname}%
+\fi
+
+% Provide a length variable and set default, if it is new
+\providecommand*{\DUprovidelength}2{
+  \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{}
+}
+
+% admonition environment (specially marked topic)
+\ifx\DUadmonition\undefined % poor man's "provideenvironment"
+ \newbox{\DUadmonitionbox}
+ \newenvironment{DUadmonition}%
+  {\begin{center}
+     \begin{lrbox}{\DUadmonitionbox}
+       \begin{minipage}{0.9\linewidth}
+  }%
+  {    \end{minipage}
+     \end{lrbox}
+     \fbox{\usebox{\DUadmonitionbox}}
+   \end{center}
+  }
+\fi
+
+% legend environment (in figures and formal tables)
+\ifthenelse{\isundefined{\DUlegend}}{
+  \newenvironment{DUlegend}{\small}{}
+}{}
+
+% line block environment
+\DUprovidelength{\DUlineblockindent}{2.5em}
+\ifthenelse{\isundefined{\DUlineblock}}{
+  \newenvironment{DUlineblock}1{%
+    \list{}{\setlength{\partopsep}{\parskip}
+            \addtolength{\partopsep}{\baselineskip}
+            \setlength{\topsep}{0pt}
+            \setlength{\itemsep}{0.15\baselineskip}
+            \setlength{\parsep}{0pt}
+            \setlength{\leftmargin}{#1}}
+    \raggedright
+  }
+  {\endlist}
+}{}
+
+% list of command line options
+\providecommand*{\DUoptionlistlabel}1{\bfseries #1 \hfill}
+\DUprovidelength{\DUoptionlistindent}{3cm}
+\ifthenelse{\isundefined{\DUoptionlist}}{
+  \newenvironment{DUoptionlist}{%
+    \list{}{\setlength{\labelwidth}{\DUoptionlistindent}
+            \setlength{\rightmargin}{1cm}
+            \setlength{\leftmargin}{\rightmargin}
+            \addtolength{\leftmargin}{\labelwidth}
+            \addtolength{\leftmargin}{\labelsep}
+            \renewcommand{\makelabel}{\DUoptionlistlabel}}
+  }
+  {\endlist}
+}{}
+
+% title for topics, admonitions, unsupported section levels, and sidebar
+\providecommand*{\DUtitle}1{%
+  \smallskip\noindent\textbf{#1}\smallskip}
+
+% titlereference standard role
+\providecommand*{\DUroletitlereference}1{\textsl{#1}}
+
 % transition (break / fancybreak / anonymous section)
 \providecommand*{\DUtransition}{%
   \hspace*{\fill}\hrulefill\hspace*{\fill}
@@ -35,19 +116,143 @@
   \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
 }{}
 \hypersetup{
-  pdftitle={Some Tests for the LaTeX Writer},
+  pdftitle={Additional Tests for the LaTeX Writer},
 }
 
 %%% Body
 \begin{document}
-\title{Some Tests for the LaTeX Writer%
-  \label{some-tests-for-the-latex-writer}}
+\title{Additional Tests for the LaTeX Writer%
+  \label{additional-tests-for-the-latex-writer}}
 \author{}
 \date{}
 \maketitle
 
-These tests contain unusual combinations of syntax elements which may cause
-trouble for the LaTeX writer but do not need to be tested with other writers.
+These tests contain syntax elements and combinations which may cause
+trouble for the LaTeX writer.
+
+\phantomsection\label{contents}
+\pdfbookmark1{Contents}{contents}
+\tableofcontents
+
+
+\section{Section heading levels%
+  \label{section-heading-levels}%
+}
+
+
+\section{Level 1%
+  \label{level-1}%
+}
+
+Nested sections
+
+
+\subsection{Level 2%
+  \label{level-2}%
+}
+
+reach at some level
+
+
+\subsubsection{Level 3%
+  \label{level-3}%
+}
+
+(depending on the document class and output format)
+
+
+\paragraph{level 4%
+  \label{level-4}%
+}
+
+a level
+
+
+\subparagraph{level 5%
+  \label{level-5}%
+}
+
+that is not supported by the output format.
+
+
+\begin{DUclass}{sectionVI}
+\DUtitle{level 6%
+  \label{level-6}%
+}
+\end{DUclass}
+
+Unsupported in LaTeX and HTML5
+(HTML5 reserves the 1st level for the document title).
+
+
+\begin{DUclass}{sectionVII}
+\DUtitle{level 7%
+  \label{level-7}%
+}
+\end{DUclass}
+
+Unsupported in HTML4.
+
+
+\begin{DUclass}{sectionVIII}
+\DUtitle{level 8%
+  \label{level-8}%
+}
+\end{DUclass}
+
+Unsupported in ODT.
+
+
+\section{Section titles with inline markup%
+  \label{section-titles-with-inline-markup}%
+  \label{references}%
+}
+
+
+\subsection{\emph{emphasized}, H\textsubscript{2}O, $x^2$, and \hyperrefreferences{references}%
+  \label{emphasized-h2o-x-2-and-references}%
+}
+
+
+\subsection{Substitutions work%
+  \label{substitutions-fail}%
+}
+
+Note, that the \textquotedbl{}reference name\textquotedbl{} for this section is derived from the
+content \emph{before} substitution. This may be exploited to get intelligible
+IDs after \href{https://docutils.sourceforge.io/docs/ref/rst/directives.html\#identifier-normalization}{identifier normalization} of the section's reference name.
+
+% This file is used by the standalone_rst_latex test.
+
+
+\section{Option lists%
+  \label{option-lists}%
+}
+
+The LaTeX-2e description environment is used for definition lists.
+The definition is continued on the same line as the term, this should
+not happen if an option-list is at the top of the definition.
+
+If the option list is not at the first element in the definition, it
+is contained in a quote
+
+\begin{quote}
+\begin{DUoptionlist}
+\item-{}-help  show help
+
+\item-v  verbose
+\end{DUoptionlist}
+\end{quote}
+
+\begin{description}
+\item{In a definition list:} \leavevmode
+\begin{DUoptionlist}
+\item-{}-help  show help
+
+\item-v  verbose
+\end{DUoptionlist}
+
+\end{description}
 
 
 \section{Block Quotes%
@@ -108,247 +313,302 @@
 \includegraphicswidth=1.000\linewidth{../../../docs/user/rst/images/title.png}
 
 
-\section{Rowspanning tables%
-  \label{rowspanning-tables}%
+\section{Tables%
+  \label{tables}%
 }
 
-Several rowspanning cells in a table.
+In contrast to HTML, LaTeX does not support line-breaks in tables with
+\textquotedbl{}automatic\textquotedbl{} column widths. Each cell has just one line, paragraphs are
+merged (the writer emits a warning).
 
-Problem:
+\begin{longtable}{|l|l|}
+\caption{problems with \textquotedbl{}auto\textquotedbl{} widths}\\
+\hline
+11 & first paragraph
+second paragraph \\
+\hline
+content
+with
+linebreak & 22 \\
+\hline
+\end{longtable}
 
-In LaTeX, \textquotedbl{}overwritten\textquotedbl{} cells need to be defined as empty cells.
+To provide for arbitrary cell content, the LaTeX writer defaults to
+specifying column widths computed from the source column widths. This
+works sufficiently in many cases:
 
-Docutils (similarily to HTML) uses is the \textquotedbl{}Exchange Table Model\textquotedbl{} (also known
-as CALS tables, see docs/ref/soextblx.dtd) which defines only the remaining
-cells in a row \textquotedbl{}affected\textquotedbl{} by multirow cells.
+\setlength{\DUtablewidth}{\dimexpr\linewidth-7\arrayrulewidth\relax}%
+\begin{longtable}{|p{\DUcolumnwidth{0.153}}|p{\DUcolumnwidth{0.208}}|p{\DUcolumnwidth{0.208}}|p{\DUcolumnwidth{0.125}}|p{\DUcolumnwidth{0.139}}|p{\DUcolumnwidth{0.167}}|}
+\caption{a table with multi-paragraph multi-column cells}\\
+\hline
 
-Therefore, visit\_entry() is only called for the remaining cells and the
-LaTeX writer needs bookkeeping to write out the required number of extra
-'\&'s.
+test
+ & 
+\textbf{bold hd}
+ & \multicolumn{3}{p{\DUcolumnwidth{0.472}}|}{%
+multicolumn 1
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.075\DUtablewidth}|p{0.133\DUtablewidth}|p{0.133\DUtablewidth}|p{0.086\DUtablewidth}|}
+With a second paragraph
+} & 
+\emph{emph hd}
+ \\
 \hline
+\multicolumn{2}{|p{\DUcolumnwidth{0.361}}|}{%
+multicolumn 2
 
-11
+With a second paragraph
+} & 
+cell
  & 
-12
+cell
  & 
-13
+cell
  & 
-14
+cell
  \\
 \hline
 
-21
- & \multirow{2}{0.13\DUtablewidth}{%
-2/3 2
-} & \multirow{3}{0.13\DUtablewidth}{%
-2…4 3
+cell
+ & \multicolumn{2}{p{\DUcolumnwidth{0.417}}|}{%
+multicolumn 3 (one line,
+but very very very very
+very looooong)
 } & 
-24
- \\
-\cline{1-1}
-\cline{4-4}
-
-31
- &  &  & 
-34
- \\
-\cline{1-1}
-\cline{2-2}
-\cline{4-4}
-
-41
+cell
  & 
-42
- &  & 
-14
+cell
+ & 
+cell
  \\
 \hline
-\end{longtable*}
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.098\DUtablewidth}|p{0.098\DUtablewidth}|p{0.063\DUtablewidth}|}
-\hline
 
-11
+cell
  & 
-12
+cell
  & 
-13
- \\
-\hline
-\multirow{2}{0.10\DUtablewidth}{%
-2/3 1
-} & \multirow{2}{0.10\DUtablewidth}{%
-2/3 2
-} & 
-23
- \\
-\cline{3-3}
- &  & 
-33
- \\
+cell
+ & \multicolumn{3}{p{\DUcolumnwidth{0.431}}|}{%
+Short multicolumn 4
+} \\
 \hline
-\end{longtable*}
+\end{longtable}
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.098\DUtablewidth}|p{0.063\DUtablewidth}|}
-\hline
+A problem with the source-derived column widths is that simple tables
+often use no padding while grid tables without padding look cramped:
 
-11
- & 
-12
- \\
+\setlength{\DUtablewidth}{\dimexpr\linewidth-5\arrayrulewidth\relax}%
+\begin{longtable}{|p{\DUcolumnwidth{0.100}}|p{\DUcolumnwidth{0.050}}|p{\DUcolumnwidth{0.050}}|p{\DUcolumnwidth{0.050}}|}
+\caption{simple table, not padded in the source}\\
 \hline
-\multirow{2}{0.10\DUtablewidth}{%
-2/3 1
-} & 
-22
- \\
-\cline{2-2}
- & 
-32
- \\
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
+} \\
 \hline
-\end{longtable*}
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.063\DUtablewidth}|p{0.110\DUtablewidth}|p{0.063\DUtablewidth}|}
+\endfirsthead
+\caption{simple table, not padded in the source (... continued)}\\
+\hline
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
+} \\
 \hline
+\endhead
+\multicolumn{4}{p{\DUcolumnwidth{0.250}}}{\raggedleft\ldots continued on next page}\\
+\endfoot
+\endlastfoot
 
-11
+100
  & 
-12
+2
  & 
-13
- \\
-\hline
-
-21
- & \multirow{2}{0.11\DUtablewidth}{%
-2/3 2
-} & 
-23
- \\
-\cline{1-1}
-\cline{3-3}
-
-31
- &  & 
-33
+3
+ & 
+4
  \\
 \hline
-\end{longtable*}
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.063\DUtablewidth}|p{0.110\DUtablewidth}|}
-\hline
 
-11
+EUR
+ & 
+b
  & 
-12
+c
+ & 
+d
  \\
 \hline
+\end{longtable}
 
-21
- & \multirow{2}{0.11\DUtablewidth}{%
-2/3 1
-} \\
-\cline{1-1}
-
-31
- &  \\
+\setlength{\DUtablewidth}{\dimexpr\linewidth-5\arrayrulewidth\relax}%
+\begin{longtable}{|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.100}}|p{\DUcolumnwidth{0.100}}|p{\DUcolumnwidth{0.100}}|}
+\caption{grid table, padded cells}\\
 \hline
-\end{longtable*}
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.063\DUtablewidth}|p{0.110\DUtablewidth}|}
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
+} \\
 \hline
-
-11
- & \multirow{2}{0.11\DUtablewidth}{%
-1/2 1
+\endfirsthead
+\caption{grid table, padded cells (... continued)}\\
+\hline
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
 } \\
-\cline{1-1}
-
-21
- &  \\
 \hline
+\endhead
+\multicolumn{4}{p{\DUcolumnwidth{0.450}}}{\raggedleft\ldots continued on next page}\\
+\endfoot
+\endlastfoot
 
-31
+100
+ & 
+2
  & 
-32
+3
+ & 
+4
  \\
 \hline
-\end{longtable*}
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.063\DUtablewidth}|p{0.156\DUtablewidth}|p{0.110\DUtablewidth}|}
+EUR
+ & 
+b
+ & 
+c
+ & 
+d
+ \\
 \hline
+\end{longtable}
 
-11
- & \multirow{2}{0.16\DUtablewidth}{%
-1/2 2
-} & \multirow{2}{0.11\DUtablewidth}{%
-1/2 3
-} \\
-\cline{1-1}
+For better typographic results, setting the \DUroletitlereference{width} and/or
+\DUroletitlereference{widths} options of the \href{https://docutils.sourceforge.io/docs/ref/rst/directives.html\#table}{table directive} is recommended.
 
-21
- &  &  \\
+\begin{longtable}{|l|l|l|l|}
+\caption{grid table, auto-width columns}\\
 \hline
-\end{longtable*}
+\textbf{A} & \textbf{B} & \textbf{C} & \textbf{D} \\
+\hline
+\endfirsthead
+\caption{grid table, auto-width columns (... continued)}\\
+\hline
+\textbf{A} & \textbf{B} & \textbf{C} & \textbf{D} \\
+\hline
+\endhead
+\endfoot
+\endlastfoot
+100 & 2 & 3 & 4 \\
+\hline
+EUR & b & c & d \\
+\hline
+\end{longtable}
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.098\DUtablewidth}|p{0.063\DUtablewidth}|p{0.110\DUtablewidth}|}
+\begin{longtable}{|l|l|}
+\caption{table with multi-row header and \textquotedbl{}auto\textquotedbl{} column-widths}\\
 \hline
-\multirow{2}{0.10\DUtablewidth}{%
-1/2 3
-} & 
-12
- & \multirow{2}{0.11\DUtablewidth}{%
-1/2 3
-} \\
+\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
 \cline{2-2}
- & 
-22
- &  \\
+ & \textbf{Description} \\
 \hline
-\end{longtable*}
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.098\DUtablewidth}|p{0.063\DUtablewidth}|}
+\endfirsthead
+\caption{table with multi-row header and \textquotedbl{}auto\textquotedbl{} column-widths (... continued)}\\
 \hline
-\multirow{2}{0.10\DUtablewidth}{%
-1/2 3
-} & 
-12
- \\
+\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
 \cline{2-2}
+ & \textbf{Description} \\
+\hline
+\endhead
+\multicolumn{2}{l}{\raggedleft\ldots continued on next page}\\
+\endfoot
+\endlastfoot
+\multicolumn{2}{|l|}{multi-column cell} \\
+\hline
+\end{longtable}
+
+The \DUroletitlereference{width} option overrides \textquotedbl{}auto\textquotedbl{} \DUroletitlereference{widths} as standard LaTeX tables
+don't have a global width setting:
+
+\setlength{\DUtablewidth}{\dimexpr0.600\linewidth-5\arrayrulewidth\relax}%
+\begin{longtable}{|p{\DUcolumnwidth{0.400}}|p{\DUcolumnwidth{0.200}}|p{\DUcolumnwidth{0.200}}|p{\DUcolumnwidth{0.200}}|}
+\caption{This table has \DUroletitlereference{widths} \textquotedbl{}auto\textquotedbl{} (ignored) and \DUroletitlereference{width} 60\%.}\\
+\hline
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
+} \\
+\hline
+\endfirsthead
+\caption{This table has \DUroletitlereference{widths} \textquotedbl{}auto\textquotedbl{} (ignored) and \DUroletitlereference{width} 60\%. (... continued)}\\
+\hline
+\textbf{%
+A
+} & \textbf{%
+B
+} & \textbf{%
+C
+} & \textbf{%
+D
+} \\
+\hline
+\endhead
+\multicolumn{4}{p{\DUcolumnwidth{1.000}}}{\raggedleft\ldots continued on next page}\\
+\endfoot
+\endlastfoot
+
+100
+ & 
+2
  & 
-22
+3
+ & 
+4
  \\
 \hline
 
-31
+EUR
+ & 
+b
+ & 
+c
  & 
-32
+d
  \\
 \hline
-\end{longtable*}
+\end{longtable}
 
 
-\section{Nested tables%
+\subsection{Nested tables%
   \label{nested-tables}%
 }
 
-TODO:
-Set alignment of nested tables without creating too much vertical space.
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.493\DUtablewidth}|p{0.214\DUtablewidth}|}
+\setlength{\DUtablewidth}{\dimexpr\linewidth-3\arrayrulewidth\relax}%
+\begin{longtable*}{|p{\DUcolumnwidth{0.700}}|p{\DUcolumnwidth{0.300}}|}
 \hline
 
 Lorem ipsum dolor sit amet, consectetur
@@ -357,24 +617,9 @@
  \\
 \hline
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\hline
-
-1
- & 
-2
- \\
-\hline
-\end{tabular}
- & 
-cell 1, 2
- \\
-\hline
-
-\noindent\makebox\linewidthl{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+\noindent\makebox\linewidthr{%
+\setlength{\DUtablewidth}{\dimexpr\linewidth-3\arrayrulewidth\relax}%
+\begin{tabular}{|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.150}}|}
 \hline
 
 1
@@ -389,9 +634,11 @@
  \\
 \hline
 
+table width depends on parent column
+
 \noindent\makebox\linewidthc{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+\setlength{\DUtablewidth}{\dimexpr\linewidth-3\arrayrulewidth\relax}%
+\begin{tabular}{|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.150}}|}
 \hline
 
 1
@@ -401,14 +648,13 @@
 \hline
 \end{tabular}
 }
+
+better use \textquotedbl{}auto\textquotedbl{} widths, see below
  & 
-cell 1, 2
- \\
-\hline
+same table
 
-\noindent\makebox\linewidthr{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+\setlength{\DUtablewidth}{\dimexpr\linewidth-3\arrayrulewidth\relax}%
+\begin{tabular}{|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.150}}|}
 \hline
 
 1
@@ -417,21 +663,15 @@
  \\
 \hline
 \end{tabular}
-}
- & 
-cell 1, 2
+
+in narrow column
  \\
 \hline
 
 \noindent\makebox\linewidthr{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+\begin{tabular}{|l|l|}
 \hline
-
-1
- & 
-2
- \\
+1 & 2 \\
 \hline
 \end{tabular}
 }
@@ -442,65 +682,314 @@
 
 \end{description}
  & 
-cell 2, 2
- \\
-\hline
- & 
 cell 3, 2
  \\
 \hline
 \end{longtable*}
 
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{p{0.493\DUtablewidth}p{0.214\DUtablewidth}}
-\toprule
 
-Lorem ipsum dolor sit amet, consectetur
- & 
-adipisicing elit
- \\
+\subsection{TODO%
+  \label{todo}%
+}
 
-\noindent\makebox\linewidthr{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+\begin{itemize}
+\item Tables with multi-paragraph multi-row cells currently fail due to a
+LaTeX limitation (see \url{https://sourceforge.net/p/docutils/bugs/225/}).
+
+\item Tweak vertical spacing in table cells containing multiple elements.
+\end{itemize}
+
+See also \texttt{test/functional/input/data/latex-problematic.txt}.
+
+
+\section{Monospaced non-alphanumeric characters%
+  \label{monospaced-non-alphanumeric-characters}%
+}
+
+These are all ASCII characters except a-zA-Z0-9 and space:
+
+\texttt{!!!\textquotedbl{}\textquotedbl{}\textquotedbl{}\#\#\#\$\$\$\%\%\%\&\&\&'{}'{}'((()))***+++,{},{},-{}-{}-...///:::}
+
+\texttt{;;;<{}<{}<===>{}>{}>???@@@{}{}{}\textbackslash{}\textbackslash{}\textbackslash{}{}{}{}\textasciicircum{}\textasciicircum{}\textasciicircum{}\_\_\_`{}`{}`\{\{\{|||\}\}\}\textasciitilde{}\textasciitilde{}\textasciitilde{}}
+
+\texttt{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
+
+The two lines of non-alphanumeric characters should both have the same
+width as the third line.
+
+
+\section{Non-ASCII characters%
+  \label{non-ascii-characters}%
+}
+
+\begin{longtable}{|l|l|}
+\caption{Punctuation and footnote symbols}\\
+\hline
+– & en-dash \\
+\hline
+— & em-dash \\
+\hline
+‘ & single turned comma quotation mark \\
+\hline
+’ & single comma quotation mark \\
+\hline
+‚ & low single comma quotation mark \\
+\hline
+“ & double turned comma quotation mark \\
+\hline
+” & double comma quotation mark \\
+\hline
+„ & low double comma quotation mark \\
+\hline
+† & dagger \\
 \hline
+‡ & double dagger \\
+\hline
+\ding{169} & black diamond suit \\
+\hline
+\ding{170} & black heart suit \\
+\hline
+♠ & black spade suit \\
+\hline
+♣ & black club suit \\
+\hline
+… & ellipsis \\
+\hline
+™ & trade mark sign \\
+\hline
+⇔ & left-right double arrow \\
+\hline
+\end{longtable}
 
-1
- & 
-2
- \\
+\begin{longtable}{|l|l|l|l|l|l|l|l|l|l|l|}
+\caption{The \DUroletitlereference{Latin-1 extended} Unicode block}\\
 \hline
-\end{tabular}
+
+% 
+ & 0 & 1 & 2 & 3 & 4 & 5 & 6 & 7 & 8 & 9 \\
+\hline
+160 &  & ¡ & ¢ & £ &  & ¥ & ¦ & § & ¨ & © \\
+\hline
+170 & ª & « & ¬ & \- & ® & ¯ & ° & ± & ² & ³ \\
+\hline
+180 & ´ & µ & ¶ & · & ¸ & ¹ & º & » & ¼ & ½ \\
+\hline
+190 & ¾ & ¿ & À & Á & Â & Ã & Ä & Å & Æ & Ç \\
+\hline
+200 & È & É & Ê & Ë & Ì & Í & Î & Ï & Ð & Ñ \\
+\hline
+210 & Ò & Ó & Ô & Õ & Ö & × & Ø & Ù & Ú & Û \\
+\hline
+220 & Ü & Ý & Þ & ß & à & á & â & ã & ä & å \\
+\hline
+230 & æ & ç & è & é & ê & ë & ì & í & î & ï \\
+\hline
+240 & ð & ñ & ò & ó & ô & õ & ö & ÷ & ø & ù \\
+\hline
+250 & ú & û & ü & ý & þ & ÿ &  &  &  &  \\
+\hline
+\end{longtable}
+
+\begin{itemize}
+\item The following line should not be wrapped, because it uses
+no-break spaces (\textbackslash{}u00a0):
+
+X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
+
+\item Line wrapping with/without breakpoints marked by soft hyphens
+(\textbackslash{}u00ad):
+
+pdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-sch
+
+pdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrisch
+\end{itemize}
+
+
+\section{Encoding special characters%
+  \label{encoding-special-characters}%
 }
- & 
-cell 1, 2
- \\
 
-\noindent\makebox\linewidthr{%
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{tabular}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
+The LaTeX Info pages list under \textquotedbl{}2.18 Special Characters\textquotedbl{}
+
+\begin{quote}
+The following characters play a special role in LaTeX and are called
+\textquotedbl{}special printing characters\textquotedbl{}, or simply \textquotedbl{}special characters\textquotedbl{}.
+
+\begin{quote}
+\# \$ \% \& \textasciitilde{} \_ \textasciicircum{} \textbackslash{} \{ \}
+\end{quote}
+\end{quote}
+
+The special chars verbatim:
+
+\begin{quote}
+\begin{alltt}
+# $ % & ~ _ ^ \textbackslash{} \{ \}
+\end{alltt}
+\end{quote}
+
+However also \emph{square brackets} {}{} need special care.
+
+\begin{quote}
+Commands with optional arguments (e.g. \texttt{\textbackslash{}item}) check
+if the token right after the macro name is an opening bracket.
+In that case the contents between that bracket and the following
+closing bracket on the same grouping level are taken as the
+optional argument. What makes this unintuitive is the fact that
+the square brackets aren't grouping characters themselves, so in
+your last example \texttt{\textbackslash{}item{}{}...{}{}} the optional argument consists of
+{}... (without the closing bracket).
+\end{quote}
+
+Compare the items in the following lists:
+
+\begin{itemize}
+\item simple item
+
+\item {}bracketed{} item
+\end{itemize}
+
+\begin{description}
+\item{simple} 
+description term
+
+\item{{}bracketed{}} 
+description term
+
+\end{description}
+
+The OT1 font-encoding differs from ASCII for the less-than, greater-than
+and bar characters (< | >) except for typewriter font \DUroletitlereference{cmtt}
+(\texttt{< | >}).
+
+
+\section{Hyperlinks and -targets%
+  \label{hyperlinks-and-targets}%
+}
+
+In LaTeX, we must set an explicit anchor (\texttt{\textbackslash{}phantomsection}) for a
+%
+\phantomsection\label{hypertarget-in-plain-text}hypertarget in plain text or in a figure but not in a longtable or
+caption:
+
+\setlength{\DUtablewidth}{\dimexpr\linewidth-4\arrayrulewidth\relax}%
+\begin{longtable}{|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.150}}|p{\DUcolumnwidth{0.150}}|}
+\caption{Table with %
+\label{hypertarget-in-table-title}hypertarget in table title.}\\
 \hline
 
-1
+False
  & 
-2
+True
+ & 
+None
  \\
 \hline
-\end{tabular}
+\end{longtable}
+\label{table-label}
+
+\begin{figure}
+\phantomsection\label{figure-label}
+\noindent\makebox\linewidthc{\includegraphics{../../../docs/user/rst/images/biohazard.png}}
+\caption{Figure with %
+\label{hypertarget-in-figure-caption}hypertarget in figure caption.}
+\begin{DUlegend}
+Legend with %
+\phantomsection\label{hypertarget-in-figure-legend}hypertarget in figure legend.
+\end{DUlegend}
+\end{figure}
+
+\includegraphics{../../../docs/user/rst/images/biohazard.png}
+\phantomsection\label{image-label}
+
+See \hyperrefhypertarget-in-plain-text{hypertarget in plain text},
+\hyperreftable-label{table label}, \hyperrefhypertarget-in-table-title{hypertarget in table title},
+\hyperreffigure-label{figure label}, \hyperrefhypertarget-in-figure-caption{hypertarget in figure caption},
+\hyperrefhypertarget-in-figure-legend{hypertarget in figure legend}, and
+\hyperrefimage-label{image label}.
+
+
+\section{External references%
+  \label{external-references}%
 }
 
+Long URLs should be wrapped in the PDF. This can be achieved with the
+\texttt{\textbackslash{}url} command which is used by the LaTeX writer whenever the content
+(name) of a reference node equals the link URL.
+
 \begin{description}
-\item{definition:} 
-list
+\item{Example:} 
+a long URL that should wrap in the output
+\url{https://docutils.sourceforge.io/docs/user/latex.html\#id79}
 
 \end{description}
- & 
-cell 2, 2
- \\
- & 
-cell 3, 2
- \\
-\bottomrule
-\end{longtable*}
+
+If the argument contains any \textquotedbl{}\%\textquotedbl{}, \textquotedbl{}\#\textquotedbl{}, or \textquotedbl{}\textasciicircum{}\textasciicircum{}\textquotedbl{}, or ends with \texttt{\textbackslash{}}, it can't
+be used in the argument to another command. The argument must not contain
+unbalanced braces.
+
+The characters \textasciicircum{}, \{, \}, and \texttt{\textbackslash{}} are invalid in a \textquotedbl{}http:\textquotedbl{} or \textquotedbl{}ftp:\textquotedbl{} URL
+and not recognized as part of it:
+
+\begin{DUlineblock}{0em}
+\item \url{http://www.example.org}/strange\textasciicircum{}\textasciicircum{}name
+\item \url{http://www.example.org}\textbackslash{}using\textbackslash{}DOS\textbackslash{}paths\textbackslash{}
+\item \url{http://www.example.org/XML}/strange\{n\}ame
+\end{DUlineblock}
+
+They can, however be used in paths and/or filenames.
+
+Handling by the LaTeX writer:
+
+\begin{itemize}
+\item \texttt{\#}, \texttt{\textbackslash{}} and \texttt{\%} are escaped:
+
+\begin{DUlineblock}{0em}
+\item \href{http://www.w3.org/XML/Schema\#dev}{URL with \#}
+\url{http://www.w3.org/XML/Schema\#dev}
+\item \href{http://www.w3.org/XML/Schema\%dev}{URL with \%}
+\url{http://example.org/Schema\%dev}
+\item \href{A:DOS\\path\\}{file with DOS path} \url{A:DOS\\path\\}
+\end{DUlineblock}
+
+\begin{DUclass}{note}
+\begin{DUadmonition}
+\DUtitle{Note}
+
+These URLs are typeset inside a LaTeX command without error.
+
+\begin{DUlineblock}{0em}
+\item \url{http://www.w3.org/XML/Schema\#dev}
+\item \url{http://example.org/Schema\%dev}
+\item \url{A:DOS\\path\\}
+\end{DUlineblock}
+\end{DUadmonition}
+\end{DUclass}
+\end{itemize}
+
+\begin{itemize}
+\item \texttt{\textasciicircum{}\textasciicircum{}} LaTeX's special syntax for characters results in \textquotedbl{}strange\textquotedbl{} replacements
+(both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}). The writer emits a warning.
+
+\href{../strange^^name}{file with \textasciicircum{}\textasciicircum{}}:
+\url{../strange^^name}
+
+\item Unbalanced braces, \{ or \}, will fail (both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}):
+
+\begin{quote}
+\begin{alltt}
+`file with \{ <../strange\{name>`__
+`<../strange\{name>`__
+\end{alltt}
+\end{quote}
+
+while balanced braces are suported:
+
+\begin{DUlineblock}{0em}
+\item \url{../strange{n}ame}
+\item \url{../st{r}ange{n}ame}
+\item \url{../{st{r}ange{n}ame}}
+\end{DUlineblock}
+\end{itemize}
 
 \end{document}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_docinfo.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_docinfo.tex Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_leavevmode.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_leavevmode.tex Changed

@@ -1,9 +1,8 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{alltt}
 \usepackage{amsmath}
 \usepackage{float} % extended float configuration
@@ -41,21 +40,25 @@
   \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{}
 }
 
-% abstract title
-\providecommand*{\DUtitleabstract}1{\centerline{\textbf{#1}}}
-
-% admonition (specially marked topic)
-\providecommand{\DUadmonition}2class-arg{%
-  % try \DUadmonition#1{#2}:
-  \ifcsname DUadmonition#1\endcsname%
-    \csname DUadmonition#1\endcsname{#2}%
-  \else
-    \begin{center}
-      \fbox{\parbox{0.9\linewidth}{#2}}
-    \end{center}
-  \fi
+\providecommand*{\DUCLASSabstract}{
+  \renewcommand{\DUtitle}1{\centerline{\textbf{##1}}}
 }
 
+% admonition environment (specially marked topic)
+\ifx\DUadmonition\undefined % poor man's "provideenvironment"
+ \newbox{\DUadmonitionbox}
+ \newenvironment{DUadmonition}%
+  {\begin{center}
+     \begin{lrbox}{\DUadmonitionbox}
+       \begin{minipage}{0.9\linewidth}
+  }%
+  {    \end{minipage}
+     \end{lrbox}
+     \fbox{\usebox{\DUadmonitionbox}}
+   \end{center}
+  }
+\fi
+
 % width of docinfo table
 \DUprovidelength{\DUdocinfowidth}{0.9\linewidth}
 
@@ -123,14 +126,8 @@
 \providecommand*{\DUrubric}1{\subsubsection*{\emph{#1}}}
 
 % title for topics, admonitions, unsupported section levels, and sidebar
-\providecommand*{\DUtitle}2class-arg{%
-  % call \DUtitle#1{#2} if it exists:
-  \ifcsname DUtitle#1\endcsname%
-    \csname DUtitle#1\endcsname{#2}%
-  \else
-    \smallskip\noindent\textbf{#2}\smallskip%
-  \fi
-}
+\providecommand*{\DUtitle}1{%
+  \smallskip\noindent\textbf{#1}\smallskip}
 
 % titlereference standard role
 \providecommand*{\DUroletitlereference}1{\textsl{#1}}
@@ -177,7 +174,7 @@
 
 \begin{DUclass}{abstract}
 \begin{quote}
-\DUtitleabstract{Abstract}
+\DUtitle{Abstract}
 
 Test that \texttt{\textbackslash{}leavevmode} is inserted after the term or field-name
 when required for correct placement of the item.
@@ -305,15 +302,17 @@
 \DUrubric{A Rubric}
 
 \item{Admonition} \leavevmode
-\DUadmonitionnote{
-\DUtitlenote{Note}
+\begin{DUclass}{note}
+\begin{DUadmonition}
+\DUtitle{Note}
 
 Admonitions need to be preceded by \texttt{\textbackslash{}leavevmode}.
 Otherwise, the term ends up centered above the admonition box.
 
 So do \emph{System Messages}, as they use the “DUadmonition”
 LaTeX environment.
-}
+\end{DUadmonition}
+\end{DUclass}
 
 \end{description}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_literal_block.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_literal_block.tex Changed

@@ -1,11 +1,11 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{alltt}
 \usepackage{amsmath}
+\usepackage{color}
 \usepackage{graphicx}
 \usepackage{longtable,ltcaption,array}
 \setlength{\extrarowheight}{2pt}
@@ -106,12 +106,22 @@
 A literal block in an admonition:
 
 \begin{quote}
-\ttfamily\raggedright
-\textbackslash{}sin\textasciicircum{}2~x
+\begin{alltt}
+\textbackslash{}sin^2 x
+\end{alltt}
 \end{quote}
 \end{DUadmonition}
 \end{DUclass}
 
+\DUsidebar{
+\DUtitle{Literal Block in a Sidebar}
+
+\begin{quote}
+\ttfamily\raggedright
+\textbackslash{}sin\textasciicircum{}2~x
+\end{quote}
+}
+
 Parsed literal block with inline markup and leading whitespace:
 
 \begin{quote}
@@ -126,8 +136,8 @@
 citation~references~(\hyperlink{cit2002}{CIT2002}),~and~more.\\
 ~\\
 ~~~Here~are~some~explicit~interpreted~text~roles:\\
-a~PEP~reference~(\href{http://www.python.org/dev/peps/pep-0287}{PEP~287}),\\
-an~RFC~reference~(\href{http://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
+a~PEP~reference~(\href{https://peps.python.org/pep-0287}{PEP~287}),\\
+an~RFC~reference~(\href{https://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
 an~abbreviation~(\DUrole{abbreviation}{abb.}),~an~acronym~(\DUrole{acronym}{reST}),\\
 code~(\texttt{\DUrole{code}{print~\textquotedbl{}hello~world\textquotedbl{}}}),\\
 maths~$\sin^2(x)$,\\

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_literal_block_fancyvrb.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_literal_block_fancyvrb.tex Changed

@@ -1,10 +1,10 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{amsmath}
+\usepackage{color}
 \usepackage{graphicx}
 \usepackage{fancyvrb}
 \usepackage{longtable,ltcaption,array}
@@ -106,12 +106,22 @@
 A literal block in an admonition:
 
 \begin{quote}
-\ttfamily\raggedright
-\textbackslash{}sin\textasciicircum{}2~x
+\begin{Verbatim}
+\sin^2 x
+\end{Verbatim}
 \end{quote}
 \end{DUadmonition}
 \end{DUclass}
 
+\DUsidebar{
+\DUtitle{Literal Block in a Sidebar}
+
+\begin{quote}
+\ttfamily\raggedright
+\textbackslash{}sin\textasciicircum{}2~x
+\end{quote}
+}
+
 Parsed literal block with inline markup and leading whitespace:
 
 \begin{quote}
@@ -126,8 +136,8 @@
 citation~references~(\hyperlink{cit2002}{CIT2002}),~and~more.\\
 ~\\
 ~~~Here~are~some~explicit~interpreted~text~roles:\\
-a~PEP~reference~(\href{http://www.python.org/dev/peps/pep-0287}{PEP~287}),\\
-an~RFC~reference~(\href{http://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
+a~PEP~reference~(\href{https://peps.python.org/pep-0287}{PEP~287}),\\
+an~RFC~reference~(\href{https://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
 an~abbreviation~(\DUrole{abbreviation}{abb.}),~an~acronym~(\DUrole{acronym}{reST}),\\
 code~(\texttt{\DUrole{code}{print~\textquotedbl{}hello~world\textquotedbl{}}}),\\
 maths~$\sin^2(x)$,\\

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_literal_block_listings.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_literal_block_listings.tex Changed

@@ -1,10 +1,10 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{amsmath}
+\usepackage{color}
 \usepackage{graphicx}
 \usepackage{listings}
 \lstset{xleftmargin=\leftmargin}
@@ -110,12 +110,20 @@
 
 A literal block in an admonition:
 
+\begin{lstlisting}
+\sin^2 x
+\end{lstlisting}
+\end{DUadmonition}
+\end{DUclass}
+
+\DUsidebar{
+\DUtitle{Literal Block in a Sidebar}
+
 \begin{quote}
 \ttfamily\raggedright
 \textbackslash{}sin\textasciicircum{}2~x
 \end{quote}
-\end{DUadmonition}
-\end{DUclass}
+}
 
 Parsed literal block with inline markup and leading whitespace:
 
@@ -131,8 +139,8 @@
 citation~references~(\hyperlink{cit2002}{CIT2002}),~and~more.\\
 ~\\
 ~~~Here~are~some~explicit~interpreted~text~roles:\\
-a~PEP~reference~(\href{http://www.python.org/dev/peps/pep-0287}{PEP~287}),\\
-an~RFC~reference~(\href{http://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
+a~PEP~reference~(\href{https://peps.python.org/pep-0287}{PEP~287}),\\
+an~RFC~reference~(\href{https://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
 an~abbreviation~(\DUrole{abbreviation}{abb.}),~an~acronym~(\DUrole{acronym}{reST}),\\
 code~(\texttt{\DUrole{code}{print~\textquotedbl{}hello~world\textquotedbl{}}}),\\
 maths~$\sin^2(x)$,\\

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_literal_block_verbatim.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_literal_block_verbatim.tex Changed

@@ -1,10 +1,10 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{amsmath}
+\usepackage{color}
 \usepackage{graphicx}
 \usepackage{longtable,ltcaption,array}
 \setlength{\extrarowheight}{2pt}
@@ -105,12 +105,22 @@
 A literal block in an admonition:
 
 \begin{quote}
-\ttfamily\raggedright
-\textbackslash{}sin\textasciicircum{}2~x
+\begin{verbatim}
+\sin^2 x
+\end{verbatim}
 \end{quote}
 \end{DUadmonition}
 \end{DUclass}
 
+\DUsidebar{
+\DUtitle{Literal Block in a Sidebar}
+
+\begin{quote}
+\ttfamily\raggedright
+\textbackslash{}sin\textasciicircum{}2~x
+\end{quote}
+}
+
 Parsed literal block with inline markup and leading whitespace:
 
 \begin{quote}
@@ -125,8 +135,8 @@
 citation~references~(\hyperlink{cit2002}{CIT2002}),~and~more.\\
 ~\\
 ~~~Here~are~some~explicit~interpreted~text~roles:\\
-a~PEP~reference~(\href{http://www.python.org/dev/peps/pep-0287}{PEP~287}),\\
-an~RFC~reference~(\href{http://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
+a~PEP~reference~(\href{https://peps.python.org/pep-0287}{PEP~287}),\\
+an~RFC~reference~(\href{https://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
 an~abbreviation~(\DUrole{abbreviation}{abb.}),~an~acronym~(\DUrole{acronym}{reST}),\\
 code~(\texttt{\DUrole{code}{print~\textquotedbl{}hello~world\textquotedbl{}}}),\\
 maths~$\sin^2(x)$,\\

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_literal_block_verbatimtab.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_literal_block_verbatimtab.tex Changed

@@ -1,10 +1,10 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackage{amsmath}
+\usepackage{color}
 \usepackage{graphicx}
 \usepackage{moreverb}
 \usepackage{longtable,ltcaption,array}
@@ -106,12 +106,22 @@
 A literal block in an admonition:
 
 \begin{quote}
-\ttfamily\raggedright
-\textbackslash{}sin\textasciicircum{}2~x
+\begin{verbatimtab}
+\sin^2 x
+\end{verbatimtab}
 \end{quote}
 \end{DUadmonition}
 \end{DUclass}
 
+\DUsidebar{
+\DUtitle{Literal Block in a Sidebar}
+
+\begin{quote}
+\ttfamily\raggedright
+\textbackslash{}sin\textasciicircum{}2~x
+\end{quote}
+}
+
 Parsed literal block with inline markup and leading whitespace:
 
 \begin{quote}
@@ -126,8 +136,8 @@
 citation~references~(\hyperlink{cit2002}{CIT2002}),~and~more.\\
 ~\\
 ~~~Here~are~some~explicit~interpreted~text~roles:\\
-a~PEP~reference~(\href{http://www.python.org/dev/peps/pep-0287}{PEP~287}),\\
-an~RFC~reference~(\href{http://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
+a~PEP~reference~(\href{https://peps.python.org/pep-0287}{PEP~287}),\\
+an~RFC~reference~(\href{https://tools.ietf.org/html/rfc2822.html}{RFC~2822}),\\
 an~abbreviation~(\DUrole{abbreviation}{abb.}),~an~acronym~(\DUrole{acronym}{reST}),\\
 code~(\texttt{\DUrole{code}{print~\textquotedbl{}hello~world\textquotedbl{}}}),\\
 maths~$\sin^2(x)$,\\

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/latex_memoir.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/latex_memoir.tex Changed

@@ -1,12 +1,8 @@
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \documentclassa4paper{memoir}
 
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
-\DeclareUnicodeCharacter{21D4}{\ensuremath{\Leftrightarrow}}
-\DeclareUnicodeCharacter{2660}{\ensuremath{\spadesuit}}
-\DeclareUnicodeCharacter{2663}{\ensuremath{\clubsuit}}
 \usepackage{alltt}
 \usepackage{amsmath}
 \usepackagebritish,french,ngerman,english{babel}
@@ -24,7 +20,6 @@
 \setlength{\extrarowheight}{2pt}
 \newlength{\DUtablewidth} % internal use in tables
 \usepackage{tabularx}
-\usepackage{textcomp} % text symbol macros
 
 %%% Custom LaTeX preamble
 % PDF Standard Fonts
@@ -349,8 +344,8 @@
 reference to the \hyperrefdoctitle{doctitle} and the \hyperrefsubtitle{subtitle}.
 
 The default role for interpreted text is \DUroletitlereference{Title Reference}.  Here are
-some explicit interpreted text roles: a PEP reference (\href{http://www.python.org/dev/peps/pep-0287}{PEP 287}); an
-RFC reference (\href{http://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
+some explicit interpreted text roles: a PEP reference (\href{https://peps.python.org/pep-0287}{PEP 287}); an
+RFC reference (\href{https://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
 (\DUrole{acronym}{reST}), code (\texttt{\DUrole{code}{print \textquotedbl{}hello world\textquotedbl{}}}); a \textsubscript{subscript};
 a \textsuperscript{superscript} and explicit roles for \DUroletitlereference{Docutils}'
 \emph{standard} \textbf{inline} \texttt{markup}.
@@ -808,7 +803,6 @@
   \label{directives}%
 }
 
-\phantomsection\label{contents}
 These are just a sample of the many reStructuredText Directives.  For
 others, please see \href{https://docutils.sourceforge.io/docs/ref/rst/directives.html}{reStructuredText Directives}\DUfootnotemark{footnote-reference-18}{footnote-10}{9}.
 
@@ -992,7 +986,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1029,7 +1023,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1066,7 +1060,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1096,7 +1090,6 @@
 \textbf{A} & \textbf{B} & \textbf{A or B} \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
 \endfoot
 \endlastfoot
 False & False & False \\
@@ -1252,10 +1245,6 @@
 \DUfootnotetext{footnote-11}{footnote-reference-19}{10}{%
 \url{https://docutils.sourceforge.io/docs/ref/rst/directives.html\#metadata}
 }
-%
-\DUfootnotetext{footnote-12}{footnote-reference-20}{11}{%
-\url{A:DOS\\path\\}
-}
 
 
 \subsection{2.14.7   Replacement Text%
@@ -1334,7 +1323,6 @@
 \begin{DUclass}{compound}
 Compound 7, tests the inclusion of various block-level
 elements in one logical paragraph. First a table,
-
 \setlength{\DUtablewidth}{\linewidth}%
 \begin{longtable*}{|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|}
 \hline
@@ -1585,7 +1573,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.24\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1653,7 +1641,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.68\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1713,7 +1701,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.49\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 \textbf{%
@@ -1824,7 +1812,6 @@
 %
 \begin{equation*}
 \mathbf{M} = \left(\begin{matrix}a&b\\c&d\end{matrix}\right)
-\phantomsection
 \label{eq-m}
 \end{equation*}
 is $|\mathbf{M}| = ad - bc$.
@@ -1845,7 +1832,6 @@
 %
 \begin{equation*}
 i\hbar \frac{\partial }{\partial t}\Psi  = \hat{H}\Psi ,
-\phantomsection
 \label{eq-schrodinger}
 \end{equation*}
 with the \emph{wave function} $\Psi $, describes how the quantum state of a
@@ -1853,7 +1839,7 @@
 
 \begin{description}
 \item{Math-Accents:} \leavevmode
-\setlength{\DUtablewidth}{\linewidth}%
+\setlength{\DUtablewidth}{1.000\linewidth}%
 \begin{longtable*}{p{0.315\DUtablewidth}p{0.315\DUtablewidth}p{0.315\DUtablewidth}}
 
 $\acute{a}$      \texttt{\textbackslash{}acute\{a\}}
@@ -1908,21 +1894,12 @@
 s_{\mathrm{out}}(x) & = s_{\mathrm{in}}(x') * s_\delta (x-x') \\
                     & = \int  s_{\mathrm{in}}(x')s_\delta (x-x')\mathrm{d}x'
 \end{align*}
-Cases (\textquotedbl{}manually\textquotedbl{}, with \texttt{matrix} environment):
-%
-\begin{equation*}
-\mathrm{sgn}(x) = \left\{\begin{matrix}
-                    -1 & x<0\\
-                    1 & x>0
-                  \end{matrix}\right.
-\end{equation*}
-Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment (not (yet) supported by
-HTML writers with \texttt{-{}-math-output=MathML}):
+Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment:
 %
 \begin{equation*}
 \mathrm{sgn}(x) = \begin{cases}
-                    -1 & x<0\\
-                     1 & x>0
+                             -1 & x<0\\
+                    \phantom{-} 1 & x>0
                   \end{cases}
 \end{equation*}
 
@@ -1931,7 +1908,8 @@
 }
 
 Test syntax elements which may cause trouble for the LaTeX writer but might
-not need to be tested with other writers (e.g. the HTML writer).
+not need to be tested with other writers. See also the
+\textquotedbl{}latex\_cornercases\textquotedbl{} test.
 
 
 \section{3.1   Custom Roles in LaTeX%
@@ -2077,786 +2055,7 @@
 \item Tel.: 0123/456789
 \end{DUlineblock}
 
-
-\section{3.3   More Tables%
-  \label{more-tables}%
-}
-
-A table with multi-paragraph multicolumn cells:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.133\DUtablewidth}|p{0.179\DUtablewidth}|p{0.179\DUtablewidth}|p{0.110\DUtablewidth}|p{0.121\DUtablewidth}|p{0.145\DUtablewidth}|}
-\hline
-
-test
- & 
-\textbf{bold hd}
- & \multicolumn{3}{p{0.41\DUtablewidth}|}{%
-multicolumn 1
-
-With a second paragraph
-} & 
-\emph{emph hd}
- \\
-\hline
-\multicolumn{2}{|p{0.31\DUtablewidth}|}{%
-multicolumn 2
-
-With a second paragraph
-} & 
-cell
- & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & \multicolumn{2}{p{0.36\DUtablewidth}|}{%
-multicolumn 3 (one line,
-but very very very very
-very looooong)
-} & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & 
-cell
- & 
-cell
- & \multicolumn{3}{p{0.38\DUtablewidth}|}{%
-Short multicolumn 4
-} \\
-\hline
-\end{longtable*}
-
-Tables with multi-paragraph multirow cells currently fail due to a LaTeX
-limitation (see \url{https://sourceforge.net/p/docutils/bugs/225/}).
-
-A table with multirow header and column-widths set by LaTeX:
-
-\begin{longtable*}{|l|l|}
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endfirsthead
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
-\endfoot
-\endlastfoot
-\multicolumn{2}{|l|}{multicollumn cell} \\
-\hline
-\end{longtable*}
-
-In a table with column-widths set by LaTeX, each cell has just one line.
-Paragraphs are merged (a warning is given).
-
-\begin{longtable*}{|l|l|}
-\hline
-11 & first paragraph
-second paragraph
-third paragraph \\
-\hline
-21 & 22 \\
-\hline
-\end{longtable*}
-
-% This file is used by the standalone_rst_latex test.
-
-
-\section{3.4   Option lists%
-  \label{option-lists-1}%
-}
-
-The LaTeX-2e description environment is used for definition lists.
-The definition is continued on the same line as the term, this should
-not happen if a option-list is at the top of the definition.
-
-If the option list is not at the first element in the definition, it
-is contained in a quote
-
-\begin{quote}
-\begin{DUoptionlist}
-\item-{}-help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-\end{quote}
-
-\begin{description}
-\item{In a definition list:} \leavevmode
-\begin{DUoptionlist}
-\item-{}-help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-
-\end{description}
-
-
-\section{3.5   Monospaced non-alphanumeric characters%
-  \label{monospaced-non-alphanumeric-characters}%
-}
-
-These are all ASCII characters except a-zA-Z0-9 and space:
-
-\texttt{!!!\textquotedbl{}\textquotedbl{}\textquotedbl{}\#\#\#\$\$\$\%\%\%\&\&\&'{}'{}'((()))***+++,{},{},-{}-{}-...///:::}
-
-\texttt{;;;<{}<{}<===>{}>{}>???@@@{}{}{}\textbackslash{}\textbackslash{}\textbackslash{}{}{}{}\textasciicircum{}\textasciicircum{}\textasciicircum{}\_\_\_`{}`{}`\{\{\{|||\}\}\}\textasciitilde{}\textasciitilde{}\textasciitilde{}}
-
-\texttt{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
-
-The two lines of non-alphanumeric characters should both have the same
-width as the third line.
-
-
-\section{3.6   Non-ASCII characters%
-  \label{non-ascii-characters}%
-}
-
-Punctuation and footnote symbols
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.028\DUtablewidth}|p{0.424\DUtablewidth}|}
-\hline
-
-–
- & 
-en-dash
- \\
-\hline
-
-—
- & 
-em-dash
- \\
-\hline
-
-‘
- & 
-single turned comma quotation mark
- \\
-\hline
-
-’
- & 
-single comma quotation mark
- \\
-\hline
-
-‚
- & 
-low single comma quotation mark
- \\
-\hline
-
-“
- & 
-double turned comma quotation mark
- \\
-\hline
-
-”
- & 
-double comma quotation mark
- \\
-\hline
-
-„
- & 
-low double comma quotation mark
- \\
-\hline
-
-†
- & 
-dagger
- \\
-\hline
-
-‡
- & 
-double dagger
- \\
-\hline
-
-\ding{169}
- & 
-black diamond suit
- \\
-\hline
-
-\ding{170}
- & 
-black heart suit
- \\
-\hline
-
-♠
- & 
-black spade suit
- \\
-\hline
-
-♣
- & 
-black club suit
- \\
-\hline
-
-…
- & 
-ellipsis
- \\
-\hline
-
-™
- & 
-trade mark sign
- \\
-\hline
-
-⇔
- & 
-left-right double arrow
- \\
-\hline
-\end{longtable*}
-
-The \DUroletitlereference{Latin-1 extended} Unicode block
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.051\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|}
-\hline
-
-% 
- & 
-0
- & 
-1
- & 
-2
- & 
-3
- & 
-4
- & 
-5
- & 
-6
- & 
-7
- & 
-8
- & 
-9
- \\
-\hline
-
-160
- &  & 
-¡
- & 
-¢
- & 
-£
- &  & 
-¥
- & 
-¦
- & 
-§
- & 
-¨
- & 
-©
- \\
-\hline
-
-170
- & 
-ª
- & 
-«
- & 
-¬
- & 
-\-
- & 
-®
- & 
-¯
- & 
-°
- & 
-±
- & 
-²
- & 
-³
- \\
-\hline
-
-180
- & 
-´
- & 
-µ
- & 
-¶
- & 
-·
- & 
-¸
- & 
-¹
- & 
-º
- & 
-»
- & 
-¼
- & 
-½
- \\
-\hline
-
-190
- & 
-¾
- & 
-¿
- & 
-À
- & 
-Á
- & 
-Â
- & 
-Ã
- & 
-Ä
- & 
-Å
- & 
-Æ
- & 
-Ç
- \\
-\hline
-
-200
- & 
-È
- & 
-É
- & 
-Ê
- & 
-Ë
- & 
-Ì
- & 
-Í
- & 
-Î
- & 
-Ï
- & 
-Ð
- & 
-Ñ
- \\
-\hline
-
-210
- & 
-Ò
- & 
-Ó
- & 
-Ô
- & 
-Õ
- & 
-Ö
- & 
-×
- & 
-Ø
- & 
-Ù
- & 
-Ú
- & 
-Û
- \\
-\hline
-
-220
- & 
-Ü
- & 
-Ý
- & 
-Þ
- & 
-ß
- & 
-à
- & 
-á
- & 
-â
- & 
-ã
- & 
-ä
- & 
-å
- \\
-\hline
-
-230
- & 
-æ
- & 
-ç
- & 
-è
- & 
-é
- & 
-ê
- & 
-ë
- & 
-ì
- & 
-í
- & 
-î
- & 
-ï
- \\
-\hline
-
-240
- & 
-ð
- & 
-ñ
- & 
-ò
- & 
-ó
- & 
-ô
- & 
-õ
- & 
-ö
- & 
-÷
- & 
-ø
- & 
-ù
- \\
-\hline
-
-250
- & 
-ú
- & 
-û
- & 
-ü
- & 
-ý
- & 
-þ
- & 
-ÿ
- &  &  &  &  \\
-\hline
-\end{longtable*}
-
-\begin{itemize}
-\item The following line should not be wrapped, because it uses
-no-break spaces (\textbackslash{}u00a0):
-
-X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
-
-\item Line wrapping with/without breakpoints marked by soft hyphens
-(\textbackslash{}u00ad):
-
-pdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-sch
-
-pdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrisch
-\end{itemize}
-
-
-\section{3.7   Encoding special chars%
-  \label{encoding-special-chars}%
-}
-
-The LaTeX Info pages lists under \textquotedbl{}2.18 Special Characters\textquotedbl{}
-
-\begin{quote}
-The following characters play a special role in LaTeX and are called
-\textquotedbl{}special printing characters\textquotedbl{}, or simply \textquotedbl{}special characters\textquotedbl{}.
-
-\begin{quote}
-\# \$ \% \& \textasciitilde{} \_ \textasciicircum{} \textbackslash{} \{ \}
-\end{quote}
-\end{quote}
-
-The special chars verbatim:
-
-\begin{quote}
-\begin{alltt}
-# $ % & ~ _ ^ \textbackslash{} \{ \}
-\end{alltt}
-\end{quote}
-
-However also \emph{square brackets} {}{} need special care.
-
-\begin{quote}
-Commands with optional arguments (e.g. \texttt{\textbackslash{}item}) check
-if the token right after the macro name is an opening bracket.
-In that case the contents between that bracket and the following
-closing bracket on the same grouping level are taken as the
-optional argument. What makes this unintuitive is the fact that
-the square brackets aren't grouping characters themselves, so in
-your last example \texttt{\textbackslash{}item{}{}...{}{}} the optional argument consists of
-{}... (without the closing bracket).
-\end{quote}
-
-Compare the items in the following lists:
-
-\begin{itemize}
-\item simple item
-
-\item {}bracketed{} item
-\end{itemize}
-
-\begin{description}
-\item{simple} 
-description term
-
-\item{{}bracketed{}} 
-description term
-
-\end{description}
-
-The OT1 font-encoding has different characters for the less-than,
-greater-than and bar, < | >, except for typewriter font \DUroletitlereference{cmtt}:
-
-\begin{quote}
-\begin{alltt}
-< | >
-\end{alltt}
-\end{quote}
-
-
-\section{3.8   Hyperlinks and -targets%
-  \label{hyperlinks-and-targets}%
-}
-
-In LaTeX, we must set an explicit anchor (\texttt{\textbackslash{}phantomsection}) for a
-%
-\phantomsection\label{hypertarget-in-plain-text}hypertarget in plain text or in a figure but not in a longtable or
-caption:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\caption{Table with %
-\label{hypertarget-in-table-title}hypertarget in table title.}\\
-\hline
-
-False
- & 
-True
- & 
-None
- \\
-\hline
-\end{longtable}
-\label{table-label}
-
-\begin{figure}
-\phantomsection\label{figure-label}
-\noindent\makebox\linewidthc{\includegraphics{../../../docs/user/rst/images/biohazard.png}}
-\caption{Figure with %
-\label{hypertarget-in-figure-caption}hypertarget in figure caption.}
-\begin{DUlegend}
-Legend with %
-\phantomsection\label{hypertarget-in-figure-legend}hypertarget in figure legend.
-\end{DUlegend}
-\end{figure}
-
-\includegraphics{../../../docs/user/rst/images/biohazard.png}
-\phantomsection\label{image-label}
-
-See \hyperrefhypertarget-in-plain-text{hypertarget in plain text},
-\hyperreftable-label{table label}, \hyperrefhypertarget-in-table-title{hypertarget in table title},
-\hyperreffigure-label{figure label}, \hyperrefhypertarget-in-figure-caption{hypertarget in figure caption},
-\hyperrefhypertarget-in-figure-legend{hypertarget in figure legend}, and
-\hyperrefimage-label{image label}.
-
-
-\section{3.9   External references%
-  \label{external-references}%
-}
-
-Long URLs should be wrapped in the PDF. This can be achieved with the
-\texttt{\textbackslash{}url} command which is used by the LaTeX writer whenever the content
-(name) of a reference node equals the link URL.
-
-\begin{description}
-\item{Example:} 
-a long URL that should wrap in the output
-\url{http://docutils.sourceforge.net/docs/user/latex.html\#id79}
-
-\end{description}
-
-If the argument contains any \textquotedbl{}\%\textquotedbl{}, \textquotedbl{}\#\textquotedbl{}, or \textquotedbl{}\textasciicircum{}\textasciicircum{}\textquotedbl{}, or ends with \texttt{\textbackslash{}}, it can't
-be used in the argument to another command. The argument must not contain
-unbalanced braces.
-
-The characters \textasciicircum{}, \{, \}, and \texttt{\textbackslash{}} are invalid in a \textquotedbl{}http:\textquotedbl{} or \textquotedbl{}ftp:\textquotedbl{} URL
-and not recognized as part of it:
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.example.org}/strange\textasciicircum{}\textasciicircum{}name
-\item \url{http://www.example.org}\textbackslash{}using\textbackslash{}DOS\textbackslash{}paths\textbackslash{}
-\item \url{http://www.example.org/XML}/strange\{n\}ame
-\end{DUlineblock}
-
-They can, however be used in paths and/or filenames.
-
-Handling by the LaTeX writer:
-
-\begin{itemize}
-\item \texttt{\#}, \texttt{\textbackslash{}} and \texttt{\%} are escaped:
-
-\begin{DUlineblock}{0em}
-\item \href{http://www.w3.org/XML/Schema\#dev}{URL with \#}
-\url{http://www.w3.org/XML/Schema\#dev}
-\item \href{http://www.w3.org/XML/Schema\%dev}{URL with \%}
-\url{http://example.org/Schema\%dev}
-\item \href{A:DOS\\path\\}{file with DOS path}\DUfootnotemark{footnote-reference-20}{footnote-12}{11} \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-21}{footnote-12}{11}
-\end{DUlineblock}
-
-\DUadmonitionnote{
-\DUtitlenote{Note}
-
-These URLs are typeset inside a LaTeX command without error.
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.w3.org/XML/Schema\#dev}
-\item \url{http://example.org/Schema\%dev}
-\item \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-22}{footnote-12}{11}
-\end{DUlineblock}
-}
-\end{itemize}
-
-\begin{itemize}
-\item \texttt{\textasciicircum{}\textasciicircum{}} LaTeX's special syntax for characters results in \textquotedbl{}strange\textquotedbl{} replacements
-(both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}). A warning is given.
-
-\href{../strange^^name}{file with \textasciicircum{}\textasciicircum{}}:
-\url{../strange^^name}
-
-\item Unbalanced braces, \{ or \}, will fail (both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}):
-
-\begin{quote}
-\begin{alltt}
-`file with \{ <../strange\{name>`__
-`<../strange\{name>`__
-\end{alltt}
-\end{quote}
-
-while balanced braces are suported:
-
-\begin{DUlineblock}{0em}
-\item \url{../strange{n}ame}
-\item \url{../st{r}ange{n}ame}
-\item \url{../{st{r}ange{n}ame}}
-\end{DUlineblock}
-\end{itemize}
-
-
-\section{3.10   Section titles with \hyperrefinline-markup{inline markup}%
-  \label{section-titles-with-inline-markup}%
-}
-
-
-\subsection{3.10.1   \emph{emphasized}, H\textsubscript{2}O and $x^2$%
-  \label{emphasized-h2o-and-x-2}%
-}
-
-
-\subsection{3.10.2   Substitutions work%
-  \label{substitutions-fail}%
-}
-
-
-\section{3.11   Deeply nested sections%
-  \label{deeply-nested-sections}%
-}
-
-In LaTeX and HTML,
-
-
-\subsection{3.11.1   Level 3%
-  \label{level-3}%
-}
-
-nested sections
-
-
-\subsubsection{3.11.1.1   level 4%
-  \label{level-4}%
-}
-
-reach at some level
-
-
-\paragraph{3.11.1.1.1   level 5%
-  \label{level-5}%
-}
-
-(depending on the document class)
-
-
-\subparagraph{3.11.1.1.1.1   level 6%
-  \label{level-6}%
-}
-
-an unsupported level.
-
-% unusual combinations (currently separately tested)
-% .. include:: data/latex_cornercases.txt
-
-% Preface for System Messages:
+% preface for System Messages:
 
 
 \chapter{4   Error Handling%

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/math_output_html.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/math_output_html.html Changed

@@ -1,9 +1,9 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
 <title>Mathematics</title>
 <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" />
 <link rel="stylesheet" href="../input/data/math.css" type="text/css" />
@@ -13,20 +13,20 @@
 <h1 class="title">Mathematics</h1>
 
 <p>Docutils supports inline math with the prefix or postfix <tt class="docutils literal">:math:</tt>
-role specificator, <span class="formula"><i>n</i>! + sin(<i>x</i><span class="scripts"><sup class="script">2</sup><sub class="script"><i>n</i></sub></span>)</span> and <span class="formula"><i>A</i><sub><span class="text">c</span></sub> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><i>π</i></span><span class="ignored">)/(</span><span class="denominator">4</span><span class="ignored">)</span></span><i>d</i><sup>2</sup></span>, as well as displayed math via the
+role specificator, <span class="formula"><i>n</i>! + sin(<i>x</i><span class="scripts"><sup class="script">2</sup><sub class="script"><i>n</i></sub></span>)</span> and <span class="formula"><i>A</i><sub><span class="text">c</span></sub> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><i>π</i></span><span class="ignored">)/(</span><span class="denominator">4</span><span class="ignored">)</span></span><i>d</i><sup>2</sup></span>, as well as displayed math via the
 <cite>math</cite> directive:</p>
 <div class="formula">
-<i>f</i>(<i>ϵ</i>) = <span class="fraction"><span class="ignored">(</span><span class="numerator">1</span><span class="ignored">)/(</span><span class="denominator">1 + exp<span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator"><i>ε</i></span><span class="ignored">)/(</span><span class="denominator"><i>k</i><sub><span class="text">B</span></sub><i>T</i></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">⎞</span></span><span class="arrayrow"><span class="bracket align-right">⎠</span></span></span></span><span class="ignored">)</span></span>
+<i>f</i>(<i>ϵ</i>) = <span class="fraction"><span class="ignored">(</span><span class="numerator">1</span><span class="ignored">)/(</span><span class="denominator">1 + exp<span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator"><i>ε</i></span><span class="ignored">)/(</span><span class="denominator"><i>k</i><sub><span class="text">B</span></sub><i>T</i></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">⎞</span></span><span class="arrayrow"><span class="bracket align-right">⎠</span></span></span></span><span class="ignored">)</span></span>
 </div>
 <p>Content may start on the first line of the directive, e.g.</p>
 <div class="formula">
-<i>N</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><span class="text">number of apples</span></span><span class="ignored">)/(</span><span class="denominator">7</span><span class="ignored">)</span></span>
+<i>N</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><span class="text">number of apples</span></span><span class="ignored">)/(</span><span class="denominator">7</span><span class="ignored">)</span></span>
 </div>
 <p>Equations can be labeled with a reference name using the <tt class="docutils literal">:name:</tt> option.
 See <a class="reference internal" href="#eq-m">eq:M</a> and <a class="reference internal" href="#eq-schrodinger">eq:schrödinger</a> below.</p>
 <p>The determinant of the matrix</p>
 <div class="formula" id="eq-m">
-<b>M</b> = <span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎜</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="array"><span class="arrayrow">
+<b>M</b> = <span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎜</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="array"><span class="arrayrow">
 <span class="arraycell align-c">
 <i>a</i>
 </span>
@@ -55,47 +55,47 @@
 </span>
 </span><span class="array"><span class="arrayrow"><span class="bracket align-right">⎞</span></span><span class="arrayrow"><span class="bracket align-right">⎟</span></span><span class="arrayrow"><span class="bracket align-right">⎠</span></span></span>
 </div>
-<p>is <span class="formula">|<b>M</b>| = <i>ad</i> − <i>bc</i></span>.</p>
+<p>is <span class="formula">|<b>M</b>| = <i>ad</i> − <i>bc</i></span>.</p>
 <p>More than one display math block can be put in one math directive.
 For example, the following sum and integral with limits:</p>
 <div class="formula">
-<span class="limits"><sup class="limit">1</sup><span class="limit">⌠</span><span class="limit">⌡</span><sub class="limit">0</sub></span><i>x</i><sup><i>n</i></sup><i>dx</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator">1</span><span class="ignored">)/(</span><span class="denominator"><i>n</i> + 1</span><span class="ignored">)</span></span>
+<span class="limits"><sup class="limit">1</sup><span class="limit"><span class="bigoperator integral">∫</span></span><sub class="limit">0</sub></span><i>x</i><sup><i>n</i></sup><i>dx</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator">1</span><span class="ignored">)/(</span><span class="denominator"><i>n</i> + 1</span><span class="ignored">)</span></span>
 </div>
 <div class="formula">
-<span class="limits"><sup class="limit"><i>m</i></sup><span class="limit">⎲</span><span class="limit">⎳</span><sub class="limit"><i>n</i> = 1</sub></span><i>n</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><i>m</i>(<i>m</i> + 1)</span><span class="ignored">)/(</span><span class="denominator">2</span><span class="ignored">)</span></span>
+<span class="limits"><sup class="limit"><i>m</i></sup><span class="limit"><span class="bigoperator">∑</span></span><sub class="limit"><i>n</i> = 1</sub></span><i>n</i> = <span class="fraction"><span class="ignored">(</span><span class="numerator"><i>m</i>(<i>m</i> + 1)</span><span class="ignored">)/(</span><span class="denominator">2</span><span class="ignored">)</span></span>
 </div>
 <p>LaTeX-supported Unicode math symbols can be used in math roles and
 directives:</p>
 <p>The Schrödinger equation</p>
 <div class="formula" id="eq-schrodinger">
-<i>i</i>ℏ<span class="fraction"><span class="ignored">(</span><span class="numerator">∂</span><span class="ignored">)/(</span><span class="denominator">∂<i>t</i></span><span class="ignored">)</span></span>Ψ = <i>Ĥ</i>Ψ, 
+<i>i</i><i>ħ</i><span class="fraction"><span class="ignored">(</span><span class="numerator">∂</span><span class="ignored">)/(</span><span class="denominator">∂<i>t</i></span><span class="ignored">)</span></span>Ψ = <i>Ĥ</i>Ψ, 
 </div>
 <p>with the <em>wave function</em> <span class="formula">Ψ</span>, describes how the quantum state of a
 physical system changes in time.</p>
 <dl class="docutils">
 <dt>Math-Accents:</dt>
-<dd><table border="1" class="colwidths-given borderless first last docutils">
+<dd><table border="1" class="borderless first last docutils" style="width: 100%">
 <colgroup>
 <col width="33%" />
 <col width="33%" />
 <col width="33%" />
 </colgroup>
 <tbody valign="top">
-<tr><td><span class="formula"><i>á</i></span>      <tt class="docutils literal">\acute{a}</tt></td>
-<td><span class="formula"><i>ṫ</i></span>        <tt class="docutils literal">\dot{t}</tt></td>
+<tr><td><span class="formula"><i>á</i></span>      <tt class="docutils literal">\acute{a}</tt></td>
+<td><span class="formula"><i>ṫ</i></span>        <tt class="docutils literal">\dot{t}</tt></td>
 <td><span class="formula"><i>γ̂</i></span>   <tt class="docutils literal"><span class="pre">\hat{\gamma}</span></tt></td>
 </tr>
-<tr><td><span class="formula"><i>à</i></span>      <tt class="docutils literal">\grave{a}</tt></td>
-<td><span class="formula"><i>ẗ</i></span>       <tt class="docutils literal">\ddot{t}</tt></td>
+<tr><td><span class="formula"><i>à</i></span>      <tt class="docutils literal">\grave{a}</tt></td>
+<td><span class="formula"><i>ẗ</i></span>       <tt class="docutils literal">\ddot{t}</tt></td>
 <td><span class="formula"><i>α̃</i></span> <tt class="docutils literal"><span class="pre">\tilde{\alpha}</span></tt></td>
 </tr>
 <tr><td><span class="formula"><i>x̆</i></span>      <tt class="docutils literal">\breve{x}</tt></td>
-<td><span class="formula"><i>t⃛</i></span>      <tt class="docutils literal">\dddot{t}</tt></td>
-<td><span class="formula"><i>ı⃗</i></span>   <tt class="docutils literal"><span class="pre">\vec{\imath}</span></tt></td>
+<td><span class="formula"><span class="embellished"><sup><span class="smallsymbol">⋯</span></sup><span class="base"><i>t</i></span></span></span>      <tt class="docutils literal">\dddot{t}</tt></td>
+<td><span class="formula"><span class="embellished"><sup><span class="smallsymbol">→</span></sup><span class="base"><i>ı</i></span></span></span>   <tt class="docutils literal"><span class="pre">\vec{\imath}</span></tt></td>
 </tr>
-<tr><td><span class="formula"><i>ǎ</i></span>      <tt class="docutils literal">\check{a}</tt></td>
-<td><span class="formula"><span class="bar"><i>a</i></span></span>        <tt class="docutils literal">\bar{a}</tt></td>
-<td><span class="formula"><i>R⃗</i></span>        <tt class="docutils literal">\vec{R}</tt></td>
+<tr><td><span class="formula"><i>ǎ</i></span>      <tt class="docutils literal">\check{a}</tt></td>
+<td><span class="formula"><span class="embellished"><sup>‒</sup><span class="base"><i>a</i></span></span></span>        <tt class="docutils literal">\bar{a}</tt></td>
+<td><span class="formula"><span class="embellished"><sup><span class="smallsymbol">→</span></sup><span class="base"><i>R</i></span></span></span>        <tt class="docutils literal">\vec{R}</tt></td>
 </tr>
 </tbody>
 </table>
@@ -105,18 +105,18 @@
 \widehat{xxx} -->
 <p>Modulation Transfer Function:</p>
 <div class="formula">
-<span class="text">MTF</span> = <span class="array"><span class="arrayrow"><span class="bracket align-left">|</span></span><span class="arrayrow"><span class="bracket align-left">|</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator">ℱ{<i>s</i>(<i>x</i>)}</span><span class="ignored">)/(</span><span class="denominator">ℱ{<i>s</i>(<i>x</i>)}|<sub><i>ω</i><sub><i>x</i></sub> = 0</sub></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">|</span></span><span class="arrayrow"><span class="bracket align-right">|</span></span></span> = <span class="mathrm"> abs</span><span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator"><span class="limits"><span class="limit">⌠</span><span class="limit">⌡</span></span><span class="scripts"><sup class="script">∞</sup><sub class="script"> − ∞</sub></span><i>s</i>(<i>x</i>)<span class="mathrm">e</span><sup><span class="mathrm">i</span><i>ω</i><sub><i>x</i></sub><i>x</i></sup><span class="mathrm">d</span><i>x</i></span><span class="ignored">)/(</span><span class="denominator"><span class="limits"><span class="limit">⌠</span><span class="limit">⌡</span></span><span class="scripts"><sup class="script">∞</sup><sub class="script"> − ∞</sub></span><i>s</i>(<i>x</i>)<span class="mathrm">d</span><i>x</i></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">⎞</span></span><span class="arrayrow"><span class="bracket align-right">⎠</span></span></span>.
+<span class="text">MTF</span> = <span class="array"><span class="arrayrow"><span class="bracket align-left">|</span></span><span class="arrayrow"><span class="bracket align-left">|</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator">ℱ{<i>s</i>(<i>x</i>)}</span><span class="ignored">)/(</span><span class="denominator">ℱ{<i>s</i>(<i>x</i>)}|<sub><i>ω</i><sub><i>x</i></sub> = 0</sub></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">|</span></span><span class="arrayrow"><span class="bracket align-right">|</span></span></span> = <span class="mathrm"> abs</span><span class="array"><span class="arrayrow"><span class="bracket align-left">⎛</span></span><span class="arrayrow"><span class="bracket align-left">⎝</span></span></span><span class="fraction"><span class="ignored">(</span><span class="numerator"><span class="limits"><span class="limit"><span class="bigoperator integral">∫</span></span></span><span class="scripts"><sup class="script">∞</sup><sub class="script"> − ∞</sub></span><i>s</i>(<i>x</i>)<span class="mathrm">e</span><sup><span class="mathrm">i</span><i>ω</i><sub><i>x</i></sub><i>x</i></sup><span class="mathrm">d</span><i>x</i></span><span class="ignored">)/(</span><span class="denominator"><span class="limits"><span class="limit"><span class="bigoperator integral">∫</span></span></span><span class="scripts"><sup class="script">∞</sup><sub class="script"> − ∞</sub></span><i>s</i>(<i>x</i>)<span class="mathrm">d</span><i>x</i></span><span class="ignored">)</span></span><span class="array"><span class="arrayrow"><span class="bracket align-right">⎞</span></span><span class="arrayrow"><span class="bracket align-right">⎠</span></span></span>.
 </div>
 <p>Math split over two lines: If a double backslash is detected outside a
 <tt class="docutils literal"><span class="pre">\begin{...}</span> <span class="pre">\end{...}</span></tt> pair, the math code is wrapped in an <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a>
 <tt class="docutils literal">align</tt> environment:</p>
 <div class="formula">
-<span class="environment"><span class="arrayrow">
+<span class="environment align"><span class="arrayrow">
 <span class="arraycell align-r">
 <i>s</i><sub><span class="mathrm">out</span></sub>(<i>x</i>)
 </span>
 <span class="arraycell align-l">
- = <i>s</i><sub><span class="mathrm">in</span></sub>(<i>x</i>’)*<i>s</i><sub><i>δ</i></sub>(<i>x</i> − <i>x</i>’)
+ = <i>s</i><sub><span class="mathrm">in</span></sub>(<i>x</i>’)*<i>s</i><sub><i>δ</i></sub>(<i>x</i> − <i>x</i>’)
 </span>
 
 </span>
@@ -134,53 +134,21 @@
 
 </span>
 <span class="arraycell align-l">
- = <span class="limits"><span class="limit">⌠</span><span class="limit">⌡</span></span><i>s</i><sub><span class="mathrm">in</span></sub>(<i>x</i>’)<i>s</i><sub><i>δ</i></sub>(<i>x</i> − <i>x</i>’)<span class="mathrm">d</span><i>x</i>’
+ = <span class="limits"><span class="limit"><span class="bigoperator integral">∫</span></span></span><i>s</i><sub><span class="mathrm">in</span></sub>(<i>x</i>’)<i>s</i><sub><i>δ</i></sub>(<i>x</i> − <i>x</i>’)<span class="mathrm">d</span><i>x</i>’
 </span>
 
 </span>
 </span>
 </div>
-<p>Cases (&quot;manually&quot;, with <tt class="docutils literal">matrix</tt> environment):</p>
+<p>Cases with the <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a> <tt class="docutils literal">cases</tt> environment:</p>
 <div class="formula">
-<span class="mathrm">sgn</span>(<i>x</i>) = <span class="array"><span class="arrayrow"><span class="bracket align-left">⎧</span></span><span class="arrayrow"><span class="bracket align-left">⎨</span></span><span class="arrayrow"><span class="bracket align-left">⎩</span></span></span><span class="array"><span class="arrayrow">
-<span class="arraycell align-c">
- − 1
-</span>
-<span class="arraycell align-c">
-<i>x</i> &lt; 0
-</span>
-
-</span>
-<span class="arrayrow">
-<span class="arraycell align-c">
- 
-</span>
-<span class="arraycell align-c">
- 
-</span>
-
-</span>
-<span class="arrayrow">
-<span class="arraycell align-c">
-1
-</span>
-<span class="arraycell align-c">
-<i>x</i> &gt; 0
-</span>
-
-</span>
-</span><span class="emptydot"></span>
-</div>
-<p>Cases with the <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a> <tt class="docutils literal">cases</tt> environment (not (yet) supported by
-HTML writers with <tt class="docutils literal"><span class="pre">--math-output=MathML</span></tt>):</p>
-<div class="formula">
-<span class="mathrm">sgn</span>(<i>x</i>) = <span class="array"><span class="arrayrow"><span class="bracket align-l">⎧</span></span><span class="arrayrow"><span class="bracket align-l">⎨</span></span><span class="arrayrow"><span class="bracket align-l">⎩</span></span></span><span class="bracketcases">
+<span class="mathrm">sgn</span>(<i>x</i>) = <span class="array"><span class="arrayrow"><span class="bracket align-l">⎧</span></span><span class="arrayrow"><span class="bracket align-l">⎨</span></span><span class="arrayrow"><span class="bracket align-l">⎩</span></span></span><span class="bracketcases">
 <span class="arrayrow">
 <span class="case align-l">
- − 1 
+ − 1 
 </span>
 <span class="case align-l">
-<i>x</i> &lt; 0 
+<i>x</i> &lt; 0 
 </span>
 
 </span>
@@ -195,10 +163,10 @@
 </span>
 <span class="arrayrow">
 <span class="case align-l">
-1 
+<span class="phantom"> − </span>1 
 </span>
 <span class="case align-l">
-<i>x</i> &gt; 0 
+<i>x</i> &gt; 0 
 </span>
 
 </span>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/math_output_latex.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/math_output_latex.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/math_output_mathjax.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/math_output_mathjax.html Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/math_output_mathml.html Added

@@ -0,0 +1,502 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>Mathematics</title>
+<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
+</head>
+<body>
+<main id="mathematics">
+<h1 class="title">Mathematics</h1>
+
+<p>Docutils supports inline math with the prefix or postfix <span class="docutils literal">:math:</span>
+role specificator, <math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mi>n</mi>
+  <mo>!</mo>
+  <mo>+</mo>
+  <mi>sin</mi>
+  <mo>&ApplyFunction;</mo>
+  <mo stretchy="false">(</mo>
+  <msubsup>
+    <mi>x</mi>
+    <mi>n</mi>
+    <mn>2</mn>
+  </msubsup>
+  <mo stretchy="false">)</mo>
+</math> and <math xmlns="http://www.w3.org/1998/Math/MathML">
+  <msub>
+    <mi>A</mi>
+    <mtext>c</mtext>
+  </msub>
+  <mo>=</mo>
+  <mfrac>
+    <mi>π</mi>
+    <mn>4</mn>
+  </mfrac>
+  <msup>
+    <mi>d</mi>
+    <mn>2</mn>
+  </msup>
+</math>, as well as displayed math via the
+<cite>math</cite> directive:</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mi>f</mi>
+  <mo stretchy="false">(</mo>
+  <mi>ϵ</mi>
+  <mo stretchy="false">)</mo>
+  <mo>=</mo>
+  <mfrac>
+    <mn>1</mn>
+    <mrow>
+      <mn>1</mn>
+      <mo>+</mo>
+      <mi>exp</mi>
+      <mo>&ApplyFunction;</mo>
+      <mrow>
+        <mo>(</mo>
+        <mfrac>
+          <mi>ε</mi>
+          <mrow>
+            <msub>
+              <mi>k</mi>
+              <mtext>B</mtext>
+            </msub>
+            <mi>T</mi>
+          </mrow>
+        </mfrac>
+        <mo>)</mo>
+      </mrow>
+    </mrow>
+  </mfrac>
+</math>
+</div>
+<p>Content may start on the first line of the directive, e.g.</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mi>N</mi>
+  <mo>=</mo>
+  <mfrac>
+    <mtext>number of apples</mtext>
+    <mn>7</mn>
+  </mfrac>
+</math>
+</div>
+<p>Equations can be labeled with a reference name using the <span class="docutils literal">:name:</span> option.
+See <a class="reference internal" href="#eq-m">eq:M</a> and <a class="reference internal" href="#eq-schrodinger">eq:schrödinger</a> below.</p>
+<p>The determinant of the matrix</p>
+<div id="eq-m">
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mi mathvariant="bold">M</mi>
+  <mo>=</mo>
+  <mrow>
+    <mo>(</mo>
+    <mtable>
+      <mtr>
+        <mtd>
+          <mi>a</mi>
+        </mtd>
+        <mtd>
+          <mi>b</mi>
+        </mtd>
+      </mtr>
+      <mtr>
+        <mtd>
+          <mi>c</mi>
+        </mtd>
+        <mtd>
+          <mi>d</mi>
+        </mtd>
+      </mtr>
+    </mtable>
+    <mo>)</mo>
+  </mrow>
+</math>
+</div>
+<p>is <math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mo stretchy="false">|</mo>
+  <mi mathvariant="bold">M</mi>
+  <mo stretchy="false">|</mo>
+  <mo>=</mo>
+  <mi>a</mi>
+  <mi>d</mi>
+  <mo>−</mo>
+  <mi>b</mi>
+  <mi>c</mi>
+</math>.</p>
+<p>More than one display math block can be put in one math directive.
+For example, the following sum and integral with limits:</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <msubsup>
+    <mo>∫</mo>
+    <mn>0</mn>
+    <mn>1</mn>
+  </msubsup>
+  <msup>
+    <mi>x</mi>
+    <mi>n</mi>
+  </msup>
+  <mi>d</mi>
+  <mi>x</mi>
+  <mo>=</mo>
+  <mfrac>
+    <mn>1</mn>
+    <mrow>
+      <mi>n</mi>
+      <mo>+</mo>
+      <mn>1</mn>
+    </mrow>
+  </mfrac>
+</math>
+</div>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <munderover>
+    <mo movablelimits="true">∑</mo>
+    <mrow>
+      <mi>n</mi>
+      <mo>=</mo>
+      <mn>1</mn>
+    </mrow>
+    <mi>m</mi>
+  </munderover>
+  <mi>n</mi>
+  <mo>=</mo>
+  <mfrac>
+    <mrow>
+      <mi>m</mi>
+      <mo stretchy="false">(</mo>
+      <mi>m</mi>
+      <mo>+</mo>
+      <mn>1</mn>
+      <mo stretchy="false">)</mo>
+    </mrow>
+    <mn>2</mn>
+  </mfrac>
+</math>
+</div>
+<p>LaTeX-supported Unicode math symbols can be used in math roles and
+directives:</p>
+<p>The Schrödinger equation</p>
+<div id="eq-schrodinger">
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mi>i</mi>
+  <mi>ℏ</mi>
+  <mfrac>
+    <mo>∂</mo>
+    <mrow>
+      <mo>∂</mo>
+      <mi>t</mi>
+    </mrow>
+  </mfrac>
+  <mi class="capital-greek">Ψ</mi>
+  <mo>=</mo>
+  <mover>
+    <mi>H</mi>
+    <mo stretchy="false">ˆ</mo>
+  </mover>
+  <mi class="capital-greek">Ψ</mi>
+  <mo>,</mo>
+</math>
+</div>
+<p>with the <em>wave function</em> <math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mi class="capital-greek">Ψ</mi>
+</math>, describes how the quantum state of a
+physical system changes in time.</p>
+<dl>
+<dt>Math-Accents:</dt>
+<dd><table class="borderless" style="width: 100%;">
+<tbody>
+<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>a</mi>
+    <mo stretchy="false">´</mo>
+  </mover>
+</math>      <span class="docutils literal">\acute{a}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>t</mi>
+    <mo stretchy="false">˙</mo>
+  </mover>
+</math>        <span class="docutils literal">\dot{t}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>γ</mi>
+    <mo stretchy="false">ˆ</mo>
+  </mover>
+</math>   <span class="docutils literal"><span class="pre">\hat{\gamma}</span></span></p></td>
+</tr>
+<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>a</mi>
+    <mo stretchy="false">`</mo>
+  </mover>
+</math>      <span class="docutils literal">\grave{a}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>t</mi>
+    <mo stretchy="false">¨</mo>
+  </mover>
+</math>       <span class="docutils literal">\ddot{t}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>α</mi>
+    <mo stretchy="false">˜</mo>
+  </mover>
+</math> <span class="docutils literal"><span class="pre">\tilde{\alpha}</span></span></p></td>
+</tr>
+<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>x</mi>
+    <mo stretchy="false">˘</mo>
+  </mover>
+</math>      <span class="docutils literal">\breve{x}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>t</mi>
+    <mo stretchy="false">⋯</mo>
+  </mover>
+</math>      <span class="docutils literal">\dddot{t}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>ı</mi>
+    <mo stretchy="false" accent="false">→</mo>
+  </mover>
+</math>   <span class="docutils literal"><span class="pre">\vec{\imath}</span></span></p></td>
+</tr>
+<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>a</mi>
+    <mo stretchy="false">ˇ</mo>
+  </mover>
+</math>      <span class="docutils literal">\check{a}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>a</mi>
+    <mo stretchy="false">ˉ</mo>
+  </mover>
+</math>        <span class="docutils literal">\bar{a}</span></p></td>
+<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
+  <mover>
+    <mi>R</mi>
+    <mo stretchy="false" accent="false">→</mo>
+  </mover>
+</math>        <span class="docutils literal">\vec{R}</span></p></td>
+</tr>
+</tbody>
+</table>
+</dd>
+</dl>
+
+<p>Modulation Transfer Function:</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mtext>MTF</mtext>
+  <mo>=</mo>
+  <mrow>
+    <mo>|</mo>
+    <mfrac>
+      <mrow>
+        <mi mathvariant="script">F</mi>
+        <mo>{</mo>
+        <mi>s</mi>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo stretchy="false">)</mo>
+        <mo>}</mo>
+      </mrow>
+      <mrow>
+        <mi mathvariant="script">F</mi>
+        <mo>{</mo>
+        <mi>s</mi>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo stretchy="false">)</mo>
+        <mo>}</mo>
+        <msub>
+          <mo stretchy="false">|</mo>
+          <mrow>
+            <msub>
+              <mi>ω</mi>
+              <mi>x</mi>
+            </msub>
+            <mo>=</mo>
+            <mn>0</mn>
+          </mrow>
+        </msub>
+      </mrow>
+    </mfrac>
+    <mo>|</mo>
+  </mrow>
+  <mo>=</mo>
+  <mi mathvariant="normal">abs</mi>
+  <mrow>
+    <mo>(</mo>
+    <mfrac>
+      <mrow>
+        <msubsup>
+          <mo>∫</mo>
+          <mrow>
+            <mo>−</mo>
+            <mo>∞</mo>
+          </mrow>
+          <mo>∞</mo>
+        </msubsup>
+        <mi>s</mi>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo stretchy="false">)</mo>
+        <msup>
+          <mi mathvariant="normal">e</mi>
+          <mrow>
+            <mi mathvariant="normal">i</mi>
+            <msub>
+              <mi>ω</mi>
+              <mi>x</mi>
+            </msub>
+            <mi>x</mi>
+          </mrow>
+        </msup>
+        <mi mathvariant="normal">d</mi>
+        <mi>x</mi>
+      </mrow>
+      <mrow>
+        <msubsup>
+          <mo>∫</mo>
+          <mrow>
+            <mo>−</mo>
+            <mo>∞</mo>
+          </mrow>
+          <mo>∞</mo>
+        </msubsup>
+        <mi>s</mi>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo stretchy="false">)</mo>
+        <mi mathvariant="normal">d</mi>
+        <mi>x</mi>
+      </mrow>
+    </mfrac>
+    <mo>)</mo>
+  </mrow>
+  <mo>.</mo>
+</math>
+</div>
+<p>Math split over two lines: If a double backslash is detected outside a
+<span class="docutils literal"><span class="pre">\begin{...}</span> <span class="pre">\end{...}</span></span> pair, the math code is wrapped in an <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a>
+<span class="docutils literal">align</span> environment:</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mtable class="align" displaystyle="true" columnalign="right left" columnspacing="0">
+    <mtr>
+      <mtd>
+        <msub>
+          <mi>s</mi>
+          <mi mathvariant="normal">out</mi>
+        </msub>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo stretchy="false">)</mo>
+      </mtd>
+      <mtd>
+        <mo>=</mo>
+        <msub>
+          <mi>s</mi>
+          <mi mathvariant="normal">in</mi>
+        </msub>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo>'</mo>
+        <mo stretchy="false">)</mo>
+        <mo>*</mo>
+        <msub>
+          <mi>s</mi>
+          <mi>δ</mi>
+        </msub>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo>−</mo>
+        <mi>x</mi>
+        <mo>'</mo>
+        <mo stretchy="false">)</mo>
+      </mtd>
+    </mtr>
+    <mtr>
+      <mtd>
+      </mtd>
+      <mtd>
+        <mo>=</mo>
+        <mo>∫</mo>
+        <msub>
+          <mi>s</mi>
+          <mi mathvariant="normal">in</mi>
+        </msub>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo>'</mo>
+        <mo stretchy="false">)</mo>
+        <msub>
+          <mi>s</mi>
+          <mi>δ</mi>
+        </msub>
+        <mo stretchy="false">(</mo>
+        <mi>x</mi>
+        <mo>−</mo>
+        <mi>x</mi>
+        <mo>'</mo>
+        <mo stretchy="false">)</mo>
+        <mi mathvariant="normal">d</mi>
+        <mi>x</mi>
+        <mo>'</mo>
+      </mtd>
+    </mtr>
+  </mtable>
+</math>
+</div>
+<p>Cases with the <a class="reference external" href="ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf">AMSmath</a> <span class="docutils literal">cases</span> environment:</p>
+<div>
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+  <mi mathvariant="normal">sgn</mi>
+  <mo stretchy="false">(</mo>
+  <mi>x</mi>
+  <mo stretchy="false">)</mo>
+  <mo>=</mo>
+  <mrow>
+    <mo rspace="0.17em">{</mo>
+    <mtable columnalign="left">
+      <mtr>
+        <mtd>
+          <mo>−</mo>
+          <mn>1</mn>
+        </mtd>
+        <mtd>
+          <mi>x</mi>
+          <mo>&lt;</mo>
+          <mn>0</mn>
+        </mtd>
+      </mtr>
+      <mtr>
+        <mtd>
+          <mphantom>
+            <mo>−</mo>
+          </mphantom>
+          <mn>1</mn>
+        </mtd>
+        <mtd>
+          <mi>x</mi>
+          <mo>&gt;</mo>
+          <mn>0</mn>
+        </mtd>
+      </mtr>
+    </mtable>
+  </mrow>
+</math>
+</div>
+</main>
+</body>
+</html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/misc_rst_html4css1.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/misc_rst_html4css1.html Changed

@@ -1,25 +1,66 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-<title>link_in_substitution.txt</title>
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+<title>Additional tests with html4css1</title>
 <link rel="stylesheet" href="foo&amp;bar.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/math.css" type="text/css" />
 </head>
 <body>
-<div class="document">
+<div class="document" id="additional-tests-with-html4css1">
+<h1 class="title">Additional tests with html4css1</h1>
 
-
-<p>Test the interaction of transforms.references.Substitutions and
-transforms.references.ExternalLinks.</p>
-<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> is cool!</p>
-<p>There is a preferred alternative:</p>
-<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> is cool!</p>
-<p>This only works for the case where the entire substitution is a
-reference, not when the reference is embedded as part of the
-substitution:</p>
-<p>unstructured <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> is uncool!</p>
+<div class="section" id="section-heading-levels">
+<h1>Section heading levels</h1>
+</div>
+<div class="section" id="level-1">
+<h1>Level 1</h1>
+<p>Nested sections</p>
+<div class="section" id="level-2">
+<h2>Level 2</h2>
+<p>reach at some level</p>
+<div class="section" id="level-3">
+<h3>Level 3</h3>
+<p>(depending on the document class and output format)</p>
+<div class="section" id="level-4">
+<h4>level 4</h4>
+<p>a level</p>
+<div class="section" id="level-5">
+<h5>level 5</h5>
+<p>that is not supported by the output format.</p>
+<div class="section" id="level-6">
+<h6>level 6</h6>
+<p>Unsupported in LaTeX and HTML5
+(HTML5 reserves the 1st level for the document title).</p>
+<div class="section" id="level-7">
+<h6 class="h7">level 7</h6>
+<p>Unsupported in HTML4.</p>
+<div class="section" id="level-8">
+<h6 class="h8">level 8</h6>
+<p>Unsupported in ODT.</p>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="section" id="section-titles-with-inline-markup">
+<span id="references"></span><h1>Section titles with inline markup</h1>
+<div class="section" id="emphasized-h2o-x-2-and-references">
+<h2><em>emphasized</em>, H<sub>2</sub>O, <span class="formula"><i>x</i><sup>2</sup></span>, and <a class="reference internal" href="#references">references</a></h2>
+</div>
+<div class="section" id="substitutions-fail">
+<h2>Substitutions work</h2>
+<p>Note, that the &quot;reference name&quot; for this section is derived from the
+content <em>before</em> substitution. This may be exploited to get intelligible
+IDs after <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization">identifier normalization</a> of the section's reference name.</p>
+</div>
+</div>
 </div>
 </body>
 </html>

_service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/misc_rst_html5.html Added

@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>Additional tests with HTML 5</title>
+<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/responsive.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/math.css" type="text/css" />
+</head>
+<body class="with-toc">
+<main id="additional-tests-with-html-5">
+<h1 class="title">Additional tests with HTML 5</h1>
+
+<nav class="contents" id="contents" role="doc-toc">
+<p class="topic-title">Contents</p>
+<ul class="simple">
+<li><p><a class="reference internal" href="#section-heading-levels" id="toc-entry-1">Section heading levels</a></p></li>
+<li><p><a class="reference internal" href="#level-1" id="toc-entry-2">Level 1</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-2" id="toc-entry-3">Level 2</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-3" id="toc-entry-4">Level 3</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-4" id="toc-entry-5">level 4</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-5" id="toc-entry-6">level 5</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-6" id="toc-entry-7">level 6</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-7" id="toc-entry-8">level 7</a></p>
+<ul>
+<li><p><a class="reference internal" href="#level-8" id="toc-entry-9">level 8</a></p></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li><p><a class="reference internal" href="#section-titles-with-inline-markup" id="toc-entry-10">Section titles with inline markup</a></p>
+<ul>
+<li><p><a class="reference internal" href="#emphasized-h2o-x-2-and-references" id="toc-entry-11"><em>emphasized</em>, H<sub>2</sub>O, <span class="formula"><i>x</i><sup>2</sup></span>, and references</a></p></li>
+<li><p><a class="reference internal" href="#substitutions-fail" id="toc-entry-12">Substitutions work</a></p></li>
+</ul>
+</li>
+<li><p><a class="reference internal" href="#embedded-images" id="toc-entry-13">Embedded Images</a></p></li>
+<li><p><a class="reference internal" href="#moving-images-video" id="toc-entry-14">Moving images (video)</a></p></li>
+</ul>
+</nav>
+<section id="section-heading-levels">
+<h2><a class="toc-backref" href="#contents" role="doc-backlink">Section heading levels</a><a class="self-link" title="link to this section" href="#section-heading-levels"></a></h2>
+</section>
+<section id="level-1">
+<h2><a class="toc-backref" href="#contents" role="doc-backlink">Level 1</a><a class="self-link" title="link to this section" href="#level-1"></a></h2>
+<p>Nested sections</p>
+<section id="level-2">
+<h3><a class="toc-backref" href="#contents" role="doc-backlink">Level 2</a><a class="self-link" title="link to this section" href="#level-2"></a></h3>
+<p>reach at some level</p>
+<section id="level-3">
+<h4><a class="toc-backref" href="#contents" role="doc-backlink">Level 3</a><a class="self-link" title="link to this section" href="#level-3"></a></h4>
+<p>(depending on the document class and output format)</p>
+<section id="level-4">
+<h5><a class="toc-backref" href="#contents" role="doc-backlink">level 4</a><a class="self-link" title="link to this section" href="#level-4"></a></h5>
+<p>a level</p>
+<section id="level-5">
+<h6><a class="toc-backref" href="#contents" role="doc-backlink">level 5</a><a class="self-link" title="link to this section" href="#level-5"></a></h6>
+<p>that is not supported by the output format.</p>
+<section id="level-6">
+<h6 aria-level="7"><a class="toc-backref" href="#contents" role="doc-backlink">level 6</a><a class="self-link" title="link to this section" href="#level-6"></a></h6>
+<p>Unsupported in LaTeX and HTML5
+(HTML5 reserves the 1st level for the document title).</p>
+<section id="level-7">
+<h6 aria-level="8"><a class="toc-backref" href="#contents" role="doc-backlink">level 7</a><a class="self-link" title="link to this section" href="#level-7"></a></h6>
+<p>Unsupported in HTML4.</p>
+<section id="level-8">
+<h6 aria-level="9"><a class="toc-backref" href="#contents" role="doc-backlink">level 8</a><a class="self-link" title="link to this section" href="#level-8"></a></h6>
+<p>Unsupported in ODT.</p>
+</section>
+</section>
+</section>
+</section>
+</section>
+</section>
+</section>
+</section>
+<section id="section-titles-with-inline-markup">
+<span id="references"></span><h2><a class="toc-backref" href="#contents" role="doc-backlink">Section titles with inline markup</a><a class="self-link" title="link to this section" href="#section-titles-with-inline-markup"></a></h2>
+<section id="emphasized-h2o-x-2-and-references">
+<h3><em>emphasized</em>, H<sub>2</sub>O, <span class="formula"><i>x</i><sup>2</sup></span>, and <a class="reference internal" href="#references">references</a><a class="self-link" title="link to this section" href="#emphasized-h2o-x-2-and-references"></a></h3>
+</section>
+<section id="substitutions-fail">
+<h3><a class="toc-backref" href="#contents" role="doc-backlink">Substitutions work</a><a class="self-link" title="link to this section" href="#substitutions-fail"></a></h3>
+<p>Note, that the “reference name” for this section is derived from the
+content <em>before</em> substitution. This may be exploited to get intelligible
+IDs after <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization">identifier normalization</a> of the section’s reference name.</p>
+</section>
+</section>
+<section id="embedded-images">
+<h2><a class="toc-backref" href="#contents" role="doc-backlink">Embedded Images</a><a class="self-link" title="link to this section" href="#embedded-images"></a></h2>
+<p>The “embed” flag tells Docutils that it should
+try to embed the image in the output document.</p>
+<p>If the image can be read from the local file system, it is <a class="reference external" href="https://en.wikipedia.org/wiki/Base64">base64</a>
+encoded and included as a <a class="reference external" href="https://en.wikipedia.org/wiki/Data_URI_scheme">data URI</a>.
+In future, SVG images may be directly inserted into HTML5.</p>
+<figure class="align-center">
+<img alt="biohazard" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABGdBTUEAANkE3LLaAgAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAZQTFRF////AAAAVcLTfgAAAAF0Uk5TAEDm2GYAAAA2SURBVHicYmBRYOAQYJCQYJC+wSBjAUL2fxjq6hgueTNM7AQh3g0MzAdAiP0BUBYAAAD//wMA4pkLDrFBDzUAAAAASUVORK5CYII=" />
+<figcaption>
+<p>Embedded image in a figure.</p>
+</figcaption>
+</figure>
+<p>Embedded inline image <img alt="inline-embedded" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABGdBTUEAANkE3LLaAgAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAZQTFRF////AAAAVcLTfgAAAAF0Uk5TAEDm2GYAAAA2SURBVHicYmBRYOAQYJCQYJC+wSBjAUL2fxjq6hgueTNM7AQh3g0MzAdAiP0BUBYAAAD//wMA4pkLDrFBDzUAAAAASUVORK5CYII=" style="height: 0.8em;" /> scaled to a height of 0.8 em.</p>
+</section>
+<section id="moving-images-video">
+<h2><a class="toc-backref" href="#contents" role="doc-backlink">Moving images (video)</a><a class="self-link" title="link to this section" href="#moving-images-video"></a></h2>
+<p>If the URL given to <cite>images and figures</cite> hints to a video format
+supported by HTML 5 (MIME types ‘video/mp4’, ‘video/webm’, or
+‘video/ogg’), the HTML5 writer will place it in a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video">video element</a>.</p>
+<video class="align-left" src="../../../docs/user/rst/images/pens.mp4" title="left-aligned test video">
+<a href="../../../docs/user/rst/images/pens.mp4">left-aligned test video</a>
+</video>
+<p>A class option value “controls” tells the browser to display controls
+for video playback.</p>
+<p>It is a good idea to include width and height attributes. If
+height and width are not set, the page might flicker while the video
+loads. According to the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video">HTML5 spec</a>, hight and width must be
+specified as pixel values.</p>
+<figure class="align-center">
+<video controls="controls" src="../../../docs/user/rst/images/pens.mp4" title="test video in a figure" width="200">
+<a href="../../../docs/user/rst/images/pens.mp4">test video in a figure</a>
+</video>
+<figcaption>
+<p>Simple test video in a centered figure</p>
+</figcaption>
+</figure>
+<p>A video like this <video src="../../../docs/user/rst/images/pens.mp4" title="rotating pens video" width="60"><a href="../../../docs/user/rst/images/pens.mp4">rotating pens video</a></video> can be included inline via substitution.</p>
+</section>
+</main>
+</body>
+</html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/odt_footnotes.odt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/odt_footnotes.odt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/pep_html.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/pep_html.html Changed

@@ -1,29 +1,25 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-  <title>PEP 100 -- Test PEP</title>
+  <meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+  <title>PEP 100 - Test PEP</title>
   <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" />
 </head>
 <body bgcolor="white">
-<table class="navigation" cellpadding="0" cellspacing="0"
-       width="100%" border="0">
-<tr><td class="navicon" width="150" height="35">
-<a href="http://www.python.org/" title="Python Home Page">
-<img src="http://www.python.org/pics/PyBanner000.gif" alt="Python"
- border="0" width="150" height="35" /></a></td>
-<td class="textlinks" align="left">
-<b><a href="http://www.python.org/">Python Home</a></b>
-<b><a href="http://www.python.org/dev/peps/">PEP Index</a></b>
-<b><a href="http://www.python.org/peps/pep-0100.txt">PEP Source</a></b>
-</td></tr></table>
+<div class="header">
+<strong>Python Enhancement Proposals</strong>
+| <a href="http://www.python.org/">Python</a>
+&raquo; <a href="https://peps.python.org/pep-0000/">PEP Index</a>
+&raquo; PEP 100 &ndash; Test PEP
+<hr class="header"/>
+</div>
 <div class="document">
 <table class="rfc2822 docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -45,7 +41,7 @@
 </tr>
 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
 </tr>
-<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="http://www.python.org/dev/peps/pep-0012">text/x-rst</a></td>
+<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="https://peps.python.org/pep-0012">text/x-rst</a></td>
 </tr>
 <tr class="field"><th class="field-name">Created:</th><td class="field-body">01-Jun-2001</td>
 </tr>

_service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/rst_html5_tuftig.html Added

@@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>Special Features of the tuftig.css Stylesheet</title>
+<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
+<link rel="stylesheet" href="../input/data/tuftig.css" type="text/css" />
+</head>
+<body>
+<main id="special-features-of-the-tuftig-css-stylesheet">
+<h1 class="title">Special Features of the <cite>tuftig.css</cite> Stylesheet</h1>
+
+<p><span class="docutils literal">tuftig.css</span> is a <a class="reference external" href="http://www.w3.org/TR/CSS3">CSS3</a> style sheet for the output of Docutils’
+HTML5 writer. The rules are inspired by <a class="citation-reference" href="#tufte-css" id="citation-reference-1" role="doc-biblioref">tufte.css</a> and
+<a class="citation-reference" href="#tufte-latex" id="citation-reference-2" role="doc-biblioref">tufte-latex</a> going back to Edward Tufte’s layout design.</p>
+<div role="list" class="citation-list">
+<div class="citation" id="tufte-css" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#citation-reference-1">tufte.css</a><span class="fn-bracket"></span></span>
+<p>Dave Liepmann, <cite>Tufte CSS</cite>,
+<a class="reference external" href="https://edwardtufte.github.io/tufte-css/">https://edwardtufte.github.io/tufte-css/</a>.</p>
+</div>
+<div class="citation" id="tufte-latex" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#citation-reference-2">tufte-latex</a><span class="fn-bracket"></span></span>
+<p>Bil Kleb, Bill Wood and Kevin Godby,
+<cite>A Tufte-Style Book</cite>,
+<a class="reference external" href="https://www.ctan.org/pkg/tufte-latex">https://www.ctan.org/pkg/tufte-latex</a>.</p>
+</div>
+</div>
+<section id="fullwidth-and-margin-objects">
+<h2>Fullwidth and Margin Objects</h2>
+<p class="fullwidth">Block elements (paragraphs, admonitions, topics, figures, tables, …)
+with the “fullwidth” class argument use full text width.</p>
+<table class="booktabs numbered captionbelow fullwidth">
+<caption>A fullwidth table with LaTeX math commands</caption>
+<tbody>
+<tr><td><p><cite>arccos</cite></p></td>
+<td><p><span class="docutils literal">\arccos</span></p></td>
+<td><p><cite>gcd</cite></p></td>
+<td><p><span class="docutils literal">\gcd</span></p></td>
+<td><p><cite>Pr</cite></p></td>
+<td><p><span class="docutils literal">\Pr</span></p></td>
+</tr>
+<tr><td><p><cite>arcsin</cite></p></td>
+<td><p><span class="docutils literal">\arcsin</span></p></td>
+<td><p><cite>hom</cite></p></td>
+<td><p><span class="docutils literal">\hom</span></p></td>
+<td><p><cite>projlim</cite></p></td>
+<td><p><span class="docutils literal">\projlim</span></p></td>
+</tr>
+</tbody>
+</table>
+<figure class="numbered fullwidth">
+<img alt="reStructuredText, the markup syntax" src="../../../docs/user/rst/images/title.svg" style="width: 90%; height: 1.5em;" />
+<figcaption>
+<p>A numbered fullwidth figure.</p>
+</figcaption>
+</figure>
+<p>Block elements (admonitions, figures, tables, …) with the
+“marginal” class argument are set in the right margin (if place permits).</p>
+<p class="marginal">An ordinary paragraph with the “marginal” class argument.</p>
+<p>Tight integration of graphics with text is central to Tufte’s work
+even when those graphics are ancillary to the main body of a text. In
+many of those cases, a margin figure may be most appropriate.</p>
+<figure class="marginal numbered">
+<img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 2em;" />
+<figcaption>
+<p>This is a marginal figure.</p>
+<div class="legend">
+<p>This is the legend.</p>
+</div>
+</figcaption>
+</figure>
+<p>To place an image in the margin, use a marginal figure without caption.</p>
+<figure class="marginal">
+<img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 2em;" />
+</figure>
+<p>Marginal objects are placed to the right of the preceding main text
+block.</p>
+<aside class="admonition marginal note">
+<p class="admonition-title">Note</p>
+<p>This is a “note” type admonition with a block-quote inside.</p>
+<blockquote>
+<p>This is a silly text that is only there to
+demonstrate line wrapping.</p>
+</blockquote>
+</aside>
+<p>By default, citations and footnotes are set in the margin.
+To have them in the main text area (like <a class="citation-reference" href="#testbook" id="citation-reference-3" role="doc-biblioref">Testbook</a> and <a class="citation-reference" href="#tb98" id="citation-reference-4" role="doc-biblioref">tb98</a> here),
+use the “align-left” class value.</p>
+<div role="list" class="citation-list">
+<div class="citation align-left" id="testbook" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#citation-reference-3">Testbook</a><span class="fn-bracket"></span></span>
+<p>John Ex Ample, <cite>How to test web pages</cite>, Ontario, 1978.</p>
+</div>
+<div class="citation align-left" id="tb98" lang="de" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#citation-reference-4">tb98</a><span class="fn-bracket"></span></span>
+<p>Horst Schramm, <cite>Docutils 0.5</cite>, in Testberichte III,
+Leipzig, 1998.</p>
+</div>
+</div>
+<table class="booktabs numbered captionbelow marginal">
+<caption>A marginal table</caption>
+<thead>
+<tr><th class="head"><p>A</p></th>
+<th class="head"><p>B</p></th>
+<th class="head"><p>A or B</p></th>
+</tr>
+</thead>
+<tbody>
+<tr><td><p>False</p></td>
+<td><p>False</p></td>
+<td><p>False</p></td>
+</tr>
+<tr><td><p>True</p></td>
+<td><p>False</p></td>
+<td><p>True</p></td>
+</tr>
+<tr><td><p>False</p></td>
+<td><p>True</p></td>
+<td><p>True</p></td>
+</tr>
+<tr><td><p>True</p></td>
+<td><p>True</p></td>
+<td><p>True</p></td>
+</tr>
+</tbody>
+</table>
+<aside class="footnote-list superscript">
+<aside class="footnote superscript align-left" id="not-in-margin" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></span>
+<p>The “align-left” class value ensures this footnote is set
+in the main text area.</p>
+</aside>
+</aside>
+</section>
+</main>
+<footer>
+<p><a class="reference external image-reference" href="http://www.w3.org/TR/html5/"><img alt="Conforms to HTML 5" src="http://www.w3.org/html/logo/badge/html5-badge-h-css3-semantics.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://validator.w3.org/check?uri=referer"><img alt="Check validity!" src="https://www.w3.org/Icons/ValidatorSuite/vs-blue-190.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://jigsaw.w3.org/css-validator/check/referer"><img alt="Valid CSS 2.1!" src="http://jigsaw.w3.org/css-validator/images/vcss" style="width: 88px; height: 31px;" /></a></p>
+</footer>
+</body>
+</html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_docutils_xml.xml -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_docutils_xml.xml Changed

@@ -1,9 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
-
+
 <document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_docutils_xml.txt" title="reStructuredText Test Document">
     <title>reStructuredText Test Document</title>
     <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">Examples of Syntax Constructs</subtitle>
+    <meta content="reStructuredText, test, parser" name="keywords">
+    </meta>
+    <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
+    </meta>
     <decoration>
         <header>
             <paragraph>Document header</paragraph>
@@ -251,8 +255,8 @@
                 <target anonymous="1" ids="target-1" refuri="http://www.python.org/"></target>
                 <target anonymous="1" ids="target-2" refuri="https://docutils.sourceforge.io/"></target>
                 <paragraph>The default role for interpreted text is <title_reference>Title Reference</title_reference>.  Here are
-                    some explicit interpreted text roles: a PEP reference (<reference refuri="http://www.python.org/dev/peps/pep-0287">PEP 287</reference>); an
-                    RFC reference (<reference refuri="http://tools.ietf.org/html/rfc2822.html">RFC 2822</reference>); an abbreviation (<abbreviation>abb.</abbreviation>), an acronym
+                    some explicit interpreted text roles: a PEP reference (<reference refuri="https://peps.python.org/pep-0287">PEP 287</reference>); an
+                    RFC reference (<reference refuri="https://tools.ietf.org/html/rfc2822.html">RFC 2822</reference>); an abbreviation (<abbreviation>abb.</abbreviation>), an acronym
                     (<acronym>reST</acronym>), code (<literal classes="code">print "hello world"</literal>); a <subscript>subscript</subscript>;
                     a <superscript>superscript</superscript> and explicit roles for <title_reference>Docutils</title_reference>'
                     <emphasis>standard</emphasis> <strong>inline</strong> <literal>markup</literal>.</paragraph>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_html4css1.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_html4css1.html Changed

@@ -1,17 +1,17 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-<title>reStructuredText Test Document</title>
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
+<meta content="reStructuredText, test, parser" name="keywords" />
+<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" />
 <meta name="author" content="David Goodger" />
 <meta name="authors" content="Me  Myself  I" />
 <meta name="organization" content="humankind" />
 <meta name="date" content="Now, or yesterday.  Or maybe even before yesterday." />
 <meta name="copyright" content="This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else's heart desires." />
-<meta content="reStructuredText, test, parser" name="keywords" />
-<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" />
+<title>reStructuredText Test Document</title>
 <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" />
 <link rel="stylesheet" href="../input/data/math.css" type="text/css" />
 </head>
@@ -185,8 +185,8 @@
 (generated by processing errors; this one is intentional).  Here is a
 reference to the <a class="reference internal" href="#doctitle">doctitle</a> and the <a class="reference internal" href="#subtitle">subtitle</a>.</p>
 <p>The default role for interpreted text is <cite>Title Reference</cite>.  Here are
-some explicit interpreted text roles: a PEP reference (<a class="reference external" href="http://www.python.org/dev/peps/pep-0287">PEP 287</a>); an
-RFC reference (<a class="reference external" href="http://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym
+some explicit interpreted text roles: a PEP reference (<a class="reference external" href="https://peps.python.org/pep-0287">PEP 287</a>); an
+RFC reference (<a class="reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym
 (<acronym>reST</acronym>), code (<code>print &quot;hello world&quot;</code>); a <sub>subscript</sub>;
 a <sup>superscript</sup> and explicit roles for <cite>Docutils</cite>'
 <em>standard</em> <strong>inline</strong> <tt class="docutils literal">markup</tt>.</p>
@@ -733,7 +733,7 @@
 <p>With the &quot;widths&quot; argument &quot;auto&quot; (or &quot;class&quot; value &quot;colwidths-auto&quot;),
 column widths are determined by the backend (if supported by the
 writer/backend).</p>
-<span id="target1"></span><table border="1" class="colwidths-auto docutils" id="target2">
+<span id="target1"></span><table border="1" class="docutils" id="target2">
 <thead valign="bottom">
 <tr><th class="head">A</th>
 <th class="head">B</th>
@@ -998,7 +998,7 @@
 
 Inline markup is supported, e.g. <em>emphasis</em>, <strong>strong</strong>, <tt class="docutils literal">literal
 text</tt>, <span class="subscript">sub-</span> and <span class="superscript">super</span>scripts,
-inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
+inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
 footnotes <a class="footnote-reference" href="#footnote-1" id="footnote-reference-9">1</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.
 </pre>
 </div>
@@ -1025,7 +1025,7 @@
 or as base for special code roles, e.g. the LaTeX code in the next
 paragraph.</p>
 <p>Docutils uses LaTeX syntax for math directives and roles:
-<code class="tex">\alpha = f(x)</code> prints <span class="formula"><i>α</i> = <i>f</i>(<i>x</i>)</span>.</p>
+<code class="tex">\alpha = f(x)</code> prints <span class="formula"><i>α</i> = <i>f</i>(<i>x</i>)</span>.</p>
 <p>The <tt class="docutils literal">:code:</tt> option of the <cite>include</cite> directive sets the included content
 as a code block, here the rst file <tt class="docutils literal">header_footer.txt</tt> with line numbers:</p>
 <pre class="code rst literal-block">
@@ -1193,7 +1193,7 @@
 <div class="section" id="list-tables">
 <h2><a class="toc-backref" href="#toc-entry-41">2.22&nbsp;&nbsp;&nbsp;List Tables</a></h2>
 <p>Here's a list table exercising all features:</p>
-<table border="1" class="colwidths-given test docutils" style="width: 95%">
+<table border="1" class="test docutils" style="width: 95%">
 <caption>list table with integral header</caption>
 <colgroup>
 <col width="26%" />
@@ -1222,7 +1222,7 @@
 </tr>
 </tbody>
 </table>
-<table border="1" class="colwidths-auto docutils align-center">
+<table border="1" class="docutils align-center">
 <caption>center aligned list table</caption>
 <tbody valign="top">
 <tr><td>Albatross</td>
@@ -1270,86 +1270,66 @@
 <div class="section" id="svg-images">
 <h2><a class="toc-backref" href="#toc-entry-43">2.24&nbsp;&nbsp;&nbsp;SVG Images</a></h2>
 <object class="align-left" data="../../../docs/user/rst/images/biohazard.svg" style="width: 48px; height: 48px;" type="image/svg+xml">../../../docs/user/rst/images/biohazard.svg</object>
-<p>Scalable vector graphics (SVG) images are the only standards-compliable way
-to include vector graphics in HTML documents. However, they are not
-supported by all backends/output formats. (E.g., LaTeX supports the
-PDF or Postscript formats for vector graphics instead.)</p>
-<p>Rendering behaviour varies, depending on</p>
-<ol class="loweralpha">
-<li><p class="first">The SVG image itself, e.g. fixed-size vs. scaling:</p>
-<pre class="literal-block">
-width=&quot;280&quot;              viewBox=&quot;0 0 280 27&quot;
-height=&quot;27&quot;              width=&quot;100%&quot;
-                         height=&quot;100%&quot;
-</pre>
-</li>
-<li><p class="first">The method used to put the image in the document.</p>
-<p>For HTML, there are several alternatives including:</p>
-<ul class="simple">
-<li>using the HTML <tt class="docutils literal">&lt;img&gt;</tt> tag (not for interactive/animated SVG),</li>
-<li>using the HTML <tt class="docutils literal">&lt;object&gt;</tt> tag,</li>
-<li>including within SVG using the SVG&nbsp;<tt class="docutils literal">&lt;image&gt;</tt> tag,</li>
-<li>embedd the SVG code within HTML (inlining).</li>
-</ul>
-<p>The <cite>html4css1</cite> writer uses <tt class="docutils literal">&lt;object&gt;</tt> tags, the <cite>html5</cite>
-writer uses <tt class="docutils literal">&lt;img&gt;</tt> tags.</p>
-
-</li>
-<li><p class="first">The viewing agent.</p>
+<p>Scalable vector graphics (SVG) images are the only standards-compatible
+way to include vector graphics in HTML documents. However, they are not
+supported by all backends/output formats (LaTeX, e.g., supports the PDF
+or Postscript formats for vector graphics instead). Rendering behaviour
+varies, depending on the SVG image itself, the method used to put the
+image in the document, and the viewing agent.</p>
 <p>All up-to-date HTML browsers support SVG, however not all do this fully
 and in the same manner. Many older versions, especially IE &lt; 9, have
-deficiencies or require plug-ins (i.e. don't support the <tt class="docutils literal">&lt;img&gt;</tt> tag).</p>
-</li>
-</ol>
+deficiencies or require plug-ins (i.e. don't support the <tt class="docutils literal">&lt;img&gt;</tt> tag).
+The <cite>html4css1</cite> writer includes SVG images using <tt class="docutils literal">&lt;object&gt;</tt> tags,
+the <cite>html5</cite> writer uses <tt class="docutils literal">&lt;img&gt;</tt> tags.</p>
 <p>If the image is wrapped in <tt class="docutils literal">&lt;object&gt;</tt> or <tt class="docutils literal">&lt;svg&gt;</tt> tags, it depends on the
-<tt class="docutils literal">viewBox</tt> declaration inside the images root <tt class="docutils literal">&lt;svg&gt;</tt> element whether an
+&quot;viewBox&quot; declaration inside the image's root <tt class="docutils literal">&lt;svg&gt;</tt> element whether an
 SVG image is scaled or clipped/padded. Images wrapped in <tt class="docutils literal">&lt;img&gt;</tt> are
 always scaled.</p>
 <ul>
 <li><object class="first align-right" data="../../../docs/user/rst/images/title-scaling.svg" style="width: 50%;" type="image/svg+xml">../../../docs/user/rst/images/title-scaling.svg</object>
-<p>A scaling image (scales with the browser window), occupying 50% of the line
-width. The <tt class="docutils literal">viewBox</tt> setting in the image file enables auto-scaling also in
-<tt class="docutils literal">&lt;object&gt;</tt> tags and embedded SVG (if width and hight are set to 100% in the
-SVG&nbsp;&lt;image&gt; tag).</p>
+<p>An image occupying 50% of the line width. The &quot;viewBox&quot; attribute in
+the image file enables auto-scaling also in <tt class="docutils literal">&lt;object&gt;</tt> tags and
+embedded SVG.</p>
 </li>
 <li><object class="first align-right" data="../../../docs/user/rst/images/title.svg" style="width: 50%; height: 15px;" type="image/svg+xml">../../../docs/user/rst/images/title.svg</object>
-<p>A fixed-size image in a box 50% wide and 15&nbsp;pixles high. This image is
-scaled, if wrapped in an <tt class="docutils literal">&lt;img&gt;</tt> tag but clipped in an <tt class="docutils literal">&lt;object&gt;</tt> tag
-or within SVG.</p>
+<p>An image without &quot;viewBox&quot; in a box 50% wide and 15&nbsp;pixles high.
+This image is scaled, if wrapped in an <tt class="docutils literal">&lt;img&gt;</tt> tag but clipped in
+an <tt class="docutils literal">&lt;object&gt;</tt> tag or within SVG.</p>
 </li>
 <li><object class="first align-right" data="../../../docs/user/rst/images/title-scaling.svg" style="width: 50%; height: 1.5em;" type="image/svg+xml">../../../docs/user/rst/images/title-scaling.svg</object>
-<p>A right aligned, scaling image 50% wide and 1.5 em high. (This SVG image
-keeps the aspect ratio.)</p>
+<p>A right aligned image with &quot;viewBox&quot;, 50% wide and 1.5 em high.
+(SVG images keep the aspect ratio unless the &quot;preserveAspectRatio&quot;
+attribute is <tt class="docutils literal">&quot;none&quot;</tt>.)</p>
 </li>
 <li><p class="first">An inline image <object data="../../../docs/user/rst/images/biohazard-scaling.svg" style="height: 0.8em;" type="image/svg+xml">inline-svg</object> scaled to a height of 0.8 em.</p>
 </li>
 <li><object class="first align-right" data="../../../docs/user/rst/images/biohazard-scaling.svg" style="height: 1em;" type="image/svg+xml">../../../docs/user/rst/images/biohazard-scaling.svg</object>
-<p>A scaling image 1 em high, right aligned:</p>
+<p>An image 1 em high, right aligned:</p>
 </li>
-<li><p class="first">A scaling image 5 mm x 5 mm, centered, with hyperlink reference:</p>
+<li><p class="first">An image 5 mm x 5 mm, centred, with hyperlink reference:</p>
 <a class="reference internal image-reference" href="#svg-images"><object class="align-center" data="../../../docs/user/rst/images/biohazard-scaling.svg" style="width: 5mm; height: 5mm;" type="image/svg+xml">../../../docs/user/rst/images/biohazard-scaling.svg</object></a>
 </li>
 <li><object class="first align-right" data="../../../docs/user/rst/images/biohazard.svg" style="width: 4cm; height: 2em;" type="image/svg+xml">../../../docs/user/rst/images/biohazard.svg</object>
-<p>A fixed-size image in a  4 cm x 2 em box.</p>
+<p>An image without &quot;viewBox&quot; in a  4 cm x 2 em box.</p>
 </li>
 </ul>
 <p>Older versions of <cite>webkit</cite> based browsers (chromium, safari, midori,
 konqueror) support the <tt class="docutils literal">&lt;img&gt;</tt> tag but don't display contained bitmap
-images in this case.</p>
+images.</p>
 <ul>
 <li><object class="first align-right" data="../../../docs/user/rst/images/biohazard-bitmap.svg" style="width: 3em;" type="image/svg+xml">../../../docs/user/rst/images/biohazard-bitmap.svg</object>
-<p>A small, fixed-size SVG image with embedded bitmap, The <tt class="docutils literal">:width:</tt> is
-set to 3&nbsp;em in the rST source. Does not scale if wrapped in <tt class="docutils literal">&lt;object&gt;</tt>
-tags.</p>
+<p>A small SVG image with embedded bitmap, The <tt class="docutils literal">:width:</tt> is set to 3&nbsp;em
+in the rST source. Does not scale if wrapped in <tt class="docutils literal">&lt;object&gt;</tt> tags
+because there is no &quot;viewBox&quot; attribute.</p>
 </li>
 <li><object class="first align-right" data="../../../docs/user/rst/images/biohazard-bitmap-scaling.svg" style="width: 3em;" type="image/svg+xml">../../../docs/user/rst/images/biohazard-bitmap-scaling.svg</object>
-<p>A scaling SVG image with embedded bitmap, 3&nbsp;em wide.</p>
+<p>An SVG image with embedded bitmap and &quot;viewBox&quot;, 3&nbsp;em wide.</p>
 </li>
 </ul>
 <p>SVG images can also be put in figures:</p>
 <blockquote>
 <div class="figure align-center">
-<object data="../../../docs/user/rst/images/title.svg" style="width: 290px; height: 28px;" type="image/svg+xml">reStructuredText, the markup syntax</object>
+<object data="../../../docs/user/rst/images/title-scaling.svg" style="width: 290px; height: 28px;" type="image/svg+xml">reStructuredText, the markup syntax</object>
 <p class="caption">SVG image in a figure.</p>
 </div>
 </blockquote>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_html5.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_html5.html Changed

@@ -1,18 +1,18 @@
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<meta charset="utf-8"/>
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20: https://docutils.sourceforge.io/" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
-<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
-<title>reStructuredText Test Document</title>
+<meta content="reStructuredText, test, parser" name="keywords" />
+<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" xml:lang="en" />
 <meta name="author" content="David Goodger" />
 <meta name="author" content="Me" />
 <meta name="author" content="Myself" />
 <meta name="author" content="I" />
 <meta name="dcterms.date" content="Now, or yesterday.  Or maybe even before yesterday." />
 <meta name="dcterms.rights" content="This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else's heart desires." />
-<meta content="reStructuredText, test, parser" name="keywords" />
-<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" xml:lang="en" />
+<title>reStructuredText Test Document</title>
 <link rel="schema.dcterms" href="http://purl.org/dc/terms/"/>
 <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
 <link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
@@ -27,32 +27,32 @@
 <h1 class="title">reStructuredText Test Document</h1>
 <p class="subtitle" id="examples-of-syntax-constructs"><span id="subtitle"></span>Examples of Syntax Constructs</p>
 <dl class="docinfo">
-<dt class="author">Author</dt>
+<dt class="author">Author<span class="colon">:</span></dt>
 <dd class="author"><p>David Goodger</p></dd>
-<dt class="address">Address</dt>
+<dt class="address">Address<span class="colon">:</span></dt>
 <dd class="address"><pre class="address">123 Example Street
 Example, EX  Canada
 A1B 2C3
 </pre>
 </dd>
-<dt class="contact">Contact</dt>
+<dt class="contact">Contact<span class="colon">:</span></dt>
 <dd class="contact"><a class="reference external" href="mailto:goodger&#64;python.org">goodger&#64;python.org</a></dd>
-<dt class="authors">Authors</dt>
+<dt class="authors">Authors<span class="colon">:</span></dt>
 <dd class="authors"><p>Me</p>
 <p>Myself</p>
 <p>I</p>
 </dd>
-<dt class="organization">Organization</dt>
+<dt class="organization">Organization<span class="colon">:</span></dt>
 <dd class="organization">humankind</dd>
-<dt class="date">Date</dt>
+<dt class="date">Date<span class="colon">:</span></dt>
 <dd class="date">Now, or yesterday.  Or maybe even <em>before</em> yesterday.</dd>
-<dt class="status">Status</dt>
+<dt class="status">Status<span class="colon">:</span></dt>
 <dd class="status">This is a &quot;work in progress&quot;</dd>
-<dt class="revision">Revision</dt>
+<dt class="revision">Revision<span class="colon">:</span></dt>
 <dd class="revision">is managed by a version control system.</dd>
-<dt class="version">Version</dt>
+<dt class="version">Version<span class="colon">:</span></dt>
 <dd class="version">1</dd>
-<dt class="copyright">Copyright</dt>
+<dt class="copyright">Copyright<span class="colon">:</span></dt>
 <dd class="copyright">This document has been placed in the public domain. You
 may do with it as you wish. You may copy, modify,
 redistribute, reattribute, sell, buy, rent, lease,
@@ -60,19 +60,19 @@
 incorporate, collate, fold, staple, or mutilate it, or do
 anything else to it that your or anyone else's heart
 desires.</dd>
-<dt class="field-name">field name</dt>
+<dt class="field-name">field name<span class="colon">:</span></dt>
 <dd class="field-name"><p>This is a &quot;generic bibliographic field&quot;.</p>
 </dd>
-<dt class="field-name-2">field name &quot;2&quot;</dt>
+<dt class="field-name-2">field name &quot;2&quot;<span class="colon">:</span></dt>
 <dd class="field-name-2"><p>Generic bibliographic fields may contain multiple body elements.</p>
 <p>Like this.</p>
 </dd>
 </dl>
-<div class="dedication topic">
+<div class="topic dedication" role="doc-dedication">
 <p class="topic-title">Dedication</p>
 <p>For Docutils users &amp; co-developers.</p>
 </div>
-<div class="abstract topic">
+<div class="topic abstract" role="doc-abstract">
 <p class="topic-title">Abstract</p>
 <p>This is a test document, containing at least one example of each
 reStructuredText construct.</p>
@@ -82,98 +82,99 @@
 
 
-<div class="contents topic" id="table-of-contents">
+<nav class="contents" id="table-of-contents" role="doc-toc">
 <p class="topic-title">Table of Contents</p>
 <ul class="auto-toc simple">
-<li><p><a class="reference internal" href="#structural-elements" id="toc-entry-1"><span class="sectnum">1</span> Structural Elements</a></p>
+<li><p><a class="reference internal" href="#structural-elements" id="toc-entry-1"><span class="sectnum">1 </span>Structural Elements</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#section-title" id="toc-entry-2"><span class="sectnum">1.1</span> Section Title</a></p></li>
-<li><p><a class="reference internal" href="#empty-section" id="toc-entry-3"><span class="sectnum">1.2</span> Empty Section</a></p></li>
-<li><p><a class="reference internal" href="#transitions" id="toc-entry-4"><span class="sectnum">1.3</span> Transitions</a></p></li>
+<li><p><a class="reference internal" href="#section-title" id="toc-entry-2"><span class="sectnum">1.1 </span>Section Title</a></p></li>
+<li><p><a class="reference internal" href="#empty-section" id="toc-entry-3"><span class="sectnum">1.2 </span>Empty Section</a></p></li>
+<li><p><a class="reference internal" href="#transitions" id="toc-entry-4"><span class="sectnum">1.3 </span>Transitions</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#body-elements" id="toc-entry-5"><span class="sectnum">2</span> Body Elements</a></p>
+<li><p><a class="reference internal" href="#body-elements" id="toc-entry-5"><span class="sectnum">2 </span>Body Elements</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#paragraphs" id="toc-entry-6"><span class="sectnum">2.1</span> Paragraphs</a></p>
+<li><p><a class="reference internal" href="#paragraphs" id="toc-entry-6"><span class="sectnum">2.1 </span>Paragraphs</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#inline-markup" id="toc-entry-7"><span class="sectnum">2.1.1</span> Inline Markup</a></p></li>
+<li><p><a class="reference internal" href="#inline-markup" id="toc-entry-7"><span class="sectnum">2.1.1 </span>Inline Markup</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#bullet-lists" id="toc-entry-8"><span class="sectnum">2.2</span> Bullet Lists</a></p></li>
-<li><p><a class="reference internal" href="#enumerated-lists" id="toc-entry-9"><span class="sectnum">2.3</span> Enumerated Lists</a></p></li>
-<li><p><a class="reference internal" href="#definition-lists" id="toc-entry-10"><span class="sectnum">2.4</span> Definition Lists</a></p></li>
-<li><p><a class="reference internal" href="#field-lists" id="toc-entry-11"><span class="sectnum">2.5</span> Field Lists</a></p></li>
-<li><p><a class="reference internal" href="#option-lists" id="toc-entry-12"><span class="sectnum">2.6</span> Option Lists</a></p></li>
-<li><p><a class="reference internal" href="#literal-blocks" id="toc-entry-13"><span class="sectnum">2.7</span> Literal Blocks</a></p></li>
-<li><p><a class="reference internal" href="#line-blocks" id="toc-entry-14"><span class="sectnum">2.8</span> Line Blocks</a></p></li>
-<li><p><a class="reference internal" href="#block-quotes" id="toc-entry-15"><span class="sectnum">2.9</span> Block Quotes</a></p></li>
-<li><p><a class="reference internal" href="#doctest-blocks" id="toc-entry-16"><span class="sectnum">2.10</span> Doctest Blocks</a></p></li>
-<li><p><a class="reference internal" href="#footnotes" id="toc-entry-17"><span class="sectnum">2.11</span> Footnotes</a></p></li>
-<li><p><a class="reference internal" href="#citations" id="toc-entry-18"><span class="sectnum">2.12</span> Citations</a></p></li>
-<li><p><a class="reference internal" href="#targets" id="toc-entry-19"><span class="sectnum">2.13</span> Targets</a></p>
+<li><p><a class="reference internal" href="#bullet-lists" id="toc-entry-8"><span class="sectnum">2.2 </span>Bullet Lists</a></p></li>
+<li><p><a class="reference internal" href="#enumerated-lists" id="toc-entry-9"><span class="sectnum">2.3 </span>Enumerated Lists</a></p></li>
+<li><p><a class="reference internal" href="#definition-lists" id="toc-entry-10"><span class="sectnum">2.4 </span>Definition Lists</a></p></li>
+<li><p><a class="reference internal" href="#field-lists" id="toc-entry-11"><span class="sectnum">2.5 </span>Field Lists</a></p></li>
+<li><p><a class="reference internal" href="#option-lists" id="toc-entry-12"><span class="sectnum">2.6 </span>Option Lists</a></p></li>
+<li><p><a class="reference internal" href="#literal-blocks" id="toc-entry-13"><span class="sectnum">2.7 </span>Literal Blocks</a></p></li>
+<li><p><a class="reference internal" href="#line-blocks" id="toc-entry-14"><span class="sectnum">2.8 </span>Line Blocks</a></p></li>
+<li><p><a class="reference internal" href="#block-quotes" id="toc-entry-15"><span class="sectnum">2.9 </span>Block Quotes</a></p></li>
+<li><p><a class="reference internal" href="#doctest-blocks" id="toc-entry-16"><span class="sectnum">2.10 </span>Doctest Blocks</a></p></li>
+<li><p><a class="reference internal" href="#footnotes" id="toc-entry-17"><span class="sectnum">2.11 </span>Footnotes</a></p></li>
+<li><p><a class="reference internal" href="#citations" id="toc-entry-18"><span class="sectnum">2.12 </span>Citations</a></p></li>
+<li><p><a class="reference internal" href="#targets" id="toc-entry-19"><span class="sectnum">2.13 </span>Targets</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#duplicate-target-names" id="toc-entry-20"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></p></li>
-<li><p><a class="reference internal" href="#duplicate-target-names-1" id="toc-entry-21"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></p></li>
+<li><p><a class="reference internal" href="#duplicate-target-names" id="toc-entry-20"><span class="sectnum">2.13.1 </span>Duplicate Target Names</a></p></li>
+<li><p><a class="reference internal" href="#duplicate-target-names-1" id="toc-entry-21"><span class="sectnum">2.13.2 </span>Duplicate Target Names</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#directives" id="toc-entry-22"><span class="sectnum">2.14</span> Directives</a></p>
+<li><p><a class="reference internal" href="#directives" id="toc-entry-22"><span class="sectnum">2.14 </span>Directives</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#document-parts" id="toc-entry-23"><span class="sectnum">2.14.1</span> Document Parts</a></p></li>
-<li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-24"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li>
-<li><p><a class="reference internal" href="#tables" id="toc-entry-25"><span class="sectnum">2.14.3</span> Tables</a></p></li>
-<li><p><a class="reference internal" href="#admonitions" id="toc-entry-26"><span class="sectnum">2.14.4</span> Admonitions</a></p></li>
-<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-27"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></p></li>
-<li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-28"><span class="sectnum">2.14.6</span> Target Footnotes</a></p></li>
-<li><p><a class="reference internal" href="#replacement-text" id="toc-entry-29"><span class="sectnum">2.14.7</span> Replacement Text</a></p></li>
-<li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-30"><span class="sectnum">2.14.8</span> Compound Paragraph</a></p></li>
-<li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-31"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></p></li>
-<li><p><a class="reference internal" href="#code" id="toc-entry-32"><span class="sectnum">2.14.10</span> Code</a></p></li>
-<li><p><a class="reference internal" href="#meta" id="toc-entry-33"><span class="sectnum">2.14.11</span> Meta</a></p></li>
+<li><p><a class="reference internal" href="#document-parts" id="toc-entry-23"><span class="sectnum">2.14.1 </span>Document Parts</a></p></li>
+<li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-24"><span class="sectnum">2.14.2 </span>Images and Figures</a></p></li>
+<li><p><a class="reference internal" href="#tables" id="toc-entry-25"><span class="sectnum">2.14.3 </span>Tables</a></p></li>
+<li><p><a class="reference internal" href="#admonitions" id="toc-entry-26"><span class="sectnum">2.14.4 </span>Admonitions</a></p></li>
+<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-27"><span class="sectnum">2.14.5 </span>Topics, Sidebars, and Rubrics</a></p></li>
+<li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-28"><span class="sectnum">2.14.6 </span>Target Footnotes</a></p></li>
+<li><p><a class="reference internal" href="#replacement-text" id="toc-entry-29"><span class="sectnum">2.14.7 </span>Replacement Text</a></p></li>
+<li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-30"><span class="sectnum">2.14.8 </span>Compound Paragraph</a></p></li>
+<li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-31"><span class="sectnum">2.14.9 </span>Parsed Literal Blocks</a></p></li>
+<li><p><a class="reference internal" href="#code" id="toc-entry-32"><span class="sectnum">2.14.10 </span>Code</a></p></li>
+<li><p><a class="reference internal" href="#meta" id="toc-entry-33"><span class="sectnum">2.14.11 </span>Meta</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#substitution-definitions" id="toc-entry-34"><span class="sectnum">2.15</span> Substitution Definitions</a></p></li>
-<li><p><a class="reference internal" href="#comments" id="toc-entry-35"><span class="sectnum">2.16</span> Comments</a></p></li>
-<li><p><a class="reference internal" href="#raw-text" id="toc-entry-36"><span class="sectnum">2.17</span> Raw text</a></p></li>
-<li><p><a class="reference internal" href="#container" id="toc-entry-37"><span class="sectnum">2.18</span> Container</a></p></li>
-<li><p><a class="reference internal" href="#colspanning-tables" id="toc-entry-38"><span class="sectnum">2.19</span> Colspanning tables</a></p></li>
-<li><p><a class="reference internal" href="#rowspanning-tables" id="toc-entry-39"><span class="sectnum">2.20</span> Rowspanning tables</a></p></li>
-<li><p><a class="reference internal" href="#complex-tables" id="toc-entry-40"><span class="sectnum">2.21</span> Complex tables</a></p></li>
-<li><p><a class="reference internal" href="#list-tables" id="toc-entry-41"><span class="sectnum">2.22</span> List Tables</a></p></li>
-<li><p><a class="reference internal" href="#custom-roles" id="toc-entry-42"><span class="sectnum">2.23</span> Custom Roles</a></p></li>
+<li><p><a class="reference internal" href="#substitution-definitions" id="toc-entry-34"><span class="sectnum">2.15 </span>Substitution Definitions</a></p></li>
+<li><p><a class="reference internal" href="#comments" id="toc-entry-35"><span class="sectnum">2.16 </span>Comments</a></p></li>
+<li><p><a class="reference internal" href="#raw-text" id="toc-entry-36"><span class="sectnum">2.17 </span>Raw text</a></p></li>
+<li><p><a class="reference internal" href="#container" id="toc-entry-37"><span class="sectnum">2.18 </span>Container</a></p></li>
+<li><p><a class="reference internal" href="#colspanning-tables" id="toc-entry-38"><span class="sectnum">2.19 </span>Colspanning tables</a></p></li>
+<li><p><a class="reference internal" href="#rowspanning-tables" id="toc-entry-39"><span class="sectnum">2.20 </span>Rowspanning tables</a></p></li>
+<li><p><a class="reference internal" href="#complex-tables" id="toc-entry-40"><span class="sectnum">2.21 </span>Complex tables</a></p></li>
+<li><p><a class="reference internal" href="#list-tables" id="toc-entry-41"><span class="sectnum">2.22 </span>List Tables</a></p></li>
+<li><p><a class="reference internal" href="#custom-roles" id="toc-entry-42"><span class="sectnum">2.23 </span>Custom Roles</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#changes-to-the-html4css1-writer" id="toc-entry-43"><span class="sectnum">3</span> Changes to the <cite>html4css1</cite> Writer</a></p>
+<li><p><a class="reference internal" href="#changes-to-the-html4css1-writer" id="toc-entry-43"><span class="sectnum">3 </span>Changes to the <cite>html4css1</cite> Writer</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#field-list-rendering" id="toc-entry-44"><span class="sectnum">3.1</span> Field List Rendering</a></p></li>
-<li><p><a class="reference internal" href="#styling-with-class-arguments" id="toc-entry-45"><span class="sectnum">3.2</span> Styling with Class Arguments</a></p>
+<li><p><a class="reference internal" href="#field-list-rendering" id="toc-entry-44"><span class="sectnum">3.1 </span>Field List Rendering</a></p></li>
+<li><p><a class="reference internal" href="#styling-with-class-arguments" id="toc-entry-45"><span class="sectnum">3.2 </span>Styling with Class Arguments</a></p>
 <ul class="auto-toc">
-<li><p><a class="reference internal" href="#description-lists" id="toc-entry-46"><span class="sectnum">3.2.1</span> Description Lists</a></p></li>
-<li><p><a class="reference internal" href="#field-list-variants" id="toc-entry-47"><span class="sectnum">3.2.2</span> Field List Variants</a></p></li>
-<li><p><a class="reference internal" href="#table-variants" id="toc-entry-48"><span class="sectnum">3.2.3</span> Table Variants</a></p></li>
-<li><p><a class="reference internal" href="#numbered-figures" id="toc-entry-49"><span class="sectnum">3.2.4</span> Numbered Figures</a></p></li>
+<li><p><a class="reference internal" href="#description-lists" id="toc-entry-46"><span class="sectnum">3.2.1 </span>Description Lists</a></p></li>
+<li><p><a class="reference internal" href="#details-disclosure-elements" id="toc-entry-47"><span class="sectnum">3.2.2 </span>Details disclosure elements</a></p></li>
+<li><p><a class="reference internal" href="#field-list-variants" id="toc-entry-48"><span class="sectnum">3.2.3 </span>Field List Variants</a></p></li>
+<li><p><a class="reference internal" href="#table-variants" id="toc-entry-49"><span class="sectnum">3.2.4 </span>Table Variants</a></p></li>
+<li><p><a class="reference internal" href="#numbered-figures" id="toc-entry-50"><span class="sectnum">3.2.5 </span>Numbered Figures</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#text-level-semantics" id="toc-entry-50"><span class="sectnum">3.3</span> Text-Level Semantics</a></p></li>
-<li><p><a class="reference internal" href="#indicating-edits" id="toc-entry-51"><span class="sectnum">3.4</span> Indicating Edits</a></p></li>
+<li><p><a class="reference internal" href="#text-level-semantics" id="toc-entry-51"><span class="sectnum">3.3 </span>Text-Level Semantics</a></p></li>
+<li><p><a class="reference internal" href="#indicating-edits" id="toc-entry-52"><span class="sectnum">3.4 </span>Indicating Edits</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#error-handling" id="toc-entry-52"><span class="sectnum">4</span> Error Handling</a></p></li>
+<li><p><a class="reference internal" href="#error-handling" id="toc-entry-53"><span class="sectnum">4 </span>Error Handling</a></p></li>
 </ul>
-</div>
+</nav>
 <section id="structural-elements">
-<h2><a class="toc-backref" href="#toc-entry-1"><span class="sectnum">1</span> Structural Elements</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-1" role="doc-backlink"><span class="sectnum">1 </span>Structural Elements</a></h2>
 <section id="section-title">
-<h3 class="with-subtitle"><a class="toc-backref" href="#toc-entry-2"><span class="sectnum">1.1</span> Section Title</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-2" role="doc-backlink"><span class="sectnum">1.1 </span>Section Title</a></h3>
 <p class="section-subtitle" id="section-subtitle">Section Subtitle</p>
 <p>Lone subsections are converted to a section subtitle by a transform
 activated with the <span class="docutils literal"><span class="pre">--section-subtitles</span></span> command line option or the
 <span class="docutils literal"><span class="pre">sectsubtitle-xform</span></span> configuration value.</p>
 </section>
 <section id="empty-section">
-<h3><a class="toc-backref" href="#toc-entry-3"><span class="sectnum">1.2</span> Empty Section</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-3" role="doc-backlink"><span class="sectnum">1.2 </span>Empty Section</a></h3>
 </section>
 <section id="transitions">
-<h3><a class="toc-backref" href="#toc-entry-4"><span class="sectnum">1.3</span> Transitions</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-4" role="doc-backlink"><span class="sectnum">1.3 </span>Transitions</a></h3>
 <p>Here's a transition:</p>
 <hr class="docutils" />
 <p>It divides the section.  Transitions may also occur between sections:</p>
@@ -181,20 +182,20 @@
 </section>
 <hr class="docutils" />
 <section id="body-elements">
-<h2><a class="toc-backref" href="#toc-entry-5"><span class="sectnum">2</span> Body Elements</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5" role="doc-backlink"><span class="sectnum">2 </span>Body Elements</a></h2>
 <section id="paragraphs">
-<h3><a class="toc-backref" href="#toc-entry-6"><span class="sectnum">2.1</span> Paragraphs</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-6" role="doc-backlink"><span class="sectnum">2.1 </span>Paragraphs</a></h3>
 <p>A paragraph.</p>
 <section id="inline-markup">
-<h4><a class="toc-backref" href="#toc-entry-7"><span class="sectnum">2.1.1</span> Inline Markup</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-7" role="doc-backlink"><span class="sectnum">2.1.1 </span>Inline Markup</a></h4>
 <p>Paragraphs contain text and may contain inline markup: <em>emphasis</em>,
 <strong>strong emphasis</strong>, <span class="docutils literal">inline literals</span>, standalone hyperlinks
-(<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-18">7</a>), internal
+(<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-18" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a>), internal
 cross-references (<a class="reference internal" href="#example">example</a>), external hyperlinks with embedded URIs
 (<a class="reference external" href="http://www.python.org">Python web site</a>), <a class="reference external" href="http://www.python.org/">anonymous hyperlink
-references</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-25">7</a> (<a class="reference external" href="https://docutils.sourceforge.io/">a second reference</a> <a class="footnote-reference brackets" href="#footnote-12" id="footnote-reference-26">12</a>), footnote references (manually
-numbered <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-1">1</a>, anonymous auto-numbered <a class="footnote-reference brackets" href="#footnote-2" id="footnote-reference-2">3</a>, labeled auto-numbered
-<a class="footnote-reference brackets" href="#label" id="footnote-reference-3">2</a>, or symbolic <a class="footnote-reference brackets" href="#footnote-3" id="footnote-reference-4">*</a>), citation references (see <a class="citation-reference" href="#cit2002" id="citation-reference-1">CIT2002</a>),
+references</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-26" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a> (<a class="reference external" href="https://docutils.sourceforge.io/">a second reference</a> <a class="footnote-reference brackets" href="#footnote-13" id="footnote-reference-27" role="doc-noteref"><span class="fn-bracket"></span>13<span class="fn-bracket"></span></a>), footnote references (manually
+numbered <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-1" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a>, anonymous auto-numbered <a class="footnote-reference brackets" href="#footnote-2" id="footnote-reference-2" role="doc-noteref"><span class="fn-bracket"></span>3<span class="fn-bracket"></span></a>, labeled auto-numbered
+<a class="footnote-reference brackets" href="#label" id="footnote-reference-3" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a>, or symbolic <a class="footnote-reference brackets" href="#footnote-3" id="footnote-reference-4" role="doc-noteref"><span class="fn-bracket"></span>*<span class="fn-bracket"></span></a>), citation references (see <a class="citation-reference" href="#cit2002" id="citation-reference-1" role="doc-biblioref">CIT2002</a>),
 substitution references (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" /> &amp;
 a <em>trimmed heart</em> <span class="docutils literal">(U+2665):</span>♥), and <span class="target" id="inline-hyperlink-targets">inline hyperlink targets</span>
 (see <a class="reference internal" href="#targets">Targets</a> below for a reference back to here).  Character-level
@@ -202,8 +203,8 @@
 (generated by processing errors; this one is intentional).  Here is a
 reference to the <a class="reference internal" href="#doctitle">doctitle</a> and the <a class="reference internal" href="#subtitle">subtitle</a>.</p>
 <p>The default role for interpreted text is <cite>Title Reference</cite>.  Here are
-some explicit interpreted text roles: a PEP reference (<a class="reference external" href="http://www.python.org/dev/peps/pep-0287">PEP 287</a>); an
-RFC reference (<a class="reference external" href="http://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym
+some explicit interpreted text roles: a PEP reference (<a class="reference external" href="https://peps.python.org/pep-0287">PEP 287</a>); an
+RFC reference (<a class="reference external" href="https://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym
 (<abbr>reST</abbr>), code (<code>print &quot;hello world&quot;</code>); a <sub>subscript</sub>;
 a <sup>superscript</sup> and explicit roles for <cite>Docutils</cite>'
 <em>standard</em> <strong>inline</strong> <span class="docutils literal">markup</span>.</p>
@@ -215,7 +216,7 @@
 </section>
 </section>
 <section id="bullet-lists">
-<h3><a class="toc-backref" href="#toc-entry-8"><span class="sectnum">2.2</span> Bullet Lists</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-8" role="doc-backlink"><span class="sectnum">2.2 </span>Bullet Lists</a></h3>
 <ul>
 <li><p>A bullet list</p>
 <ul class="simple">
@@ -242,7 +243,7 @@
 </ul>
 </section>
 <section id="enumerated-lists">
-<h3><a class="toc-backref" href="#toc-entry-9"><span class="sectnum">2.3</span> Enumerated Lists</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-9" role="doc-backlink"><span class="sectnum">2.3 </span>Enumerated Lists</a></h3>
 <ol class="arabic">
 <li><p>Arabic numerals.</p>
 <ol class="loweralpha simple">
@@ -278,7 +279,7 @@
 </ol>
 </section>
 <section id="definition-lists">
-<h3><a class="toc-backref" href="#toc-entry-10"><span class="sectnum">2.4</span> Definition Lists</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-10" role="doc-backlink"><span class="sectnum">2.4 </span>Definition Lists</a></h3>
 <dl>
 <dt>Term</dt>
 <dd><p>Definition</p>
@@ -296,19 +297,19 @@
 </dl>
 </section>
 <section id="field-lists">
-<h3><a class="toc-backref" href="#toc-entry-11"><span class="sectnum">2.5</span> Field Lists</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-11" role="doc-backlink"><span class="sectnum">2.5 </span>Field Lists</a></h3>
 <dl class="field-list">
-<dt>what</dt>
+<dt>what<span class="colon">:</span></dt>
 <dd><p>Field lists map field names to field bodies, like database
 records.  They are often part of an extension syntax.  They are
 an unambiguous variant of RFC 2822 fields.</p>
 </dd>
-<dt>how arg1 arg2</dt>
+<dt>how arg1 arg2<span class="colon">:</span></dt>
 <dd><p>The field marker is a colon, the field name, and a colon.</p>
 <p>The field body may contain one or more body elements, indented
 relative to the field marker.</p>
 </dd>
-<dt>credits</dt>
+<dt>credits<span class="colon">:</span></dt>
 <dd><p class="credits">This paragraph has the <cite>credits</cite> class set.  (This is actually not
 about credits but just for ensuring that the class attribute
 doesn't get stripped away.)</p>
@@ -316,7 +317,7 @@
 </dl>
 </section>
 <section id="option-lists">
-<h3><a class="toc-backref" href="#toc-entry-12"><span class="sectnum">2.6</span> Option Lists</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-12" role="doc-backlink"><span class="sectnum">2.6 </span>Option Lists</a></h3>
 <p>For listing command-line options:</p>
 <dl class="option-list">
 <dt><kbd><span class="option">-a</span></kbd></dt>
@@ -355,7 +356,7 @@
 description.</p>
 </section>
 <section id="literal-blocks">
-<h3><a class="toc-backref" href="#toc-entry-13"><span class="sectnum">2.7</span> Literal Blocks</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-13" role="doc-backlink"><span class="sectnum">2.7 </span>Literal Blocks</a></h3>
 <p>Literal blocks are indicated with a double-colon (&quot;::&quot;) at the end of
 the preceding paragraph (over there <span class="docutils literal"><span class="pre">--&gt;</span></span>).  They can be indented:</p>
 <pre class="literal-block">if literal_block:
@@ -368,7 +369,7 @@
 &gt; Why didn't I think of that?</pre>
 </section>
 <section id="line-blocks">
-<h3><a class="toc-backref" href="#toc-entry-14"><span class="sectnum">2.8</span> Line Blocks</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-14" role="doc-backlink"><span class="sectnum">2.8 </span>Line Blocks</a></h3>
 <p>This section tests line blocks.  Line blocks are body elements which
 consist of lines and other line blocks.  Nested line blocks cause
 indentation.</p>
@@ -442,7 +443,7 @@
 </div>
 </section>
 <section id="block-quotes">
-<h3><a class="toc-backref" href="#toc-entry-15"><span class="sectnum">2.9</span> Block Quotes</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-15" role="doc-backlink"><span class="sectnum">2.9 </span>Block Quotes</a></h3>
 <p>Block quotes consist of indented body elements:</p>
 <blockquote>
 <p>My theory by A. Elk.  Brackets Miss, brackets.  This theory goes
@@ -461,7 +462,7 @@
 </blockquote>
 </section>
 <section id="doctest-blocks">
-<h3><a class="toc-backref" href="#toc-entry-16"><span class="sectnum">2.10</span> Doctest Blocks</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-16" role="doc-backlink"><span class="sectnum">2.10 </span>Doctest Blocks</a></h3>
 <pre class="code python doctest">&gt;&gt;&gt; print 'Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;'
 Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;
 &gt;&gt;&gt; print '(cut and pasted from interactive Python sessions)'
@@ -469,102 +470,112 @@
 </pre>
 </section>
 <section id="footnotes">
-<h3><a class="toc-backref" href="#toc-entry-17"><span class="sectnum">2.11</span> Footnotes</a></h3>
-<dl class="footnote brackets">
-<dt class="label" id="footnote-1"><span class="brackets">1</span><span class="fn-backref">(<a href="#footnote-reference-1">1</a>,<a href="#footnote-reference-5">2</a>,<a href="#footnote-reference-9">3</a>)</span></dt>
-<dd><p>A footnote contains body elements, consistently indented by at
+<h3><a class="toc-backref" href="#toc-entry-17" role="doc-backlink"><span class="sectnum">2.11 </span>Footnotes</a></h3>
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="footnote-1" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-1">1</a>,<a role="doc-backlink" href="#footnote-reference-5">2</a>,<a role="doc-backlink" href="#footnote-reference-9">3</a>)</span>
+<p>A footnote contains body elements, consistently indented by at
 least 3 spaces.</p>
 <p>This is the footnote's second paragraph.</p>
-</dd>
-<dt class="label" id="label"><span class="brackets">2</span><span class="fn-backref">(<a href="#footnote-reference-3">1</a>,<a href="#footnote-reference-6">2</a>)</span></dt>
-<dd><p>Footnotes may be numbered, either manually (as in <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-5">1</a>) or
+</aside>
+<aside class="footnote brackets" id="label" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-3">1</a>,<a role="doc-backlink" href="#footnote-reference-6">2</a>)</span>
+<p>Footnotes may be numbered, either manually (as in <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-5" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a>) or
 automatically using a &quot;#&quot;-prefixed label.  This footnote has a
 label so it can be referred to from multiple places, both as a
-footnote reference (<a class="footnote-reference brackets" href="#label" id="footnote-reference-6">2</a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p>
-</dd>
-<dt class="label" id="footnote-2"><span class="brackets"><a class="fn-backref" href="#footnote-reference-2">3</a></span></dt>
-<dd><p>This footnote is numbered automatically and anonymously using a
+footnote reference (<a class="footnote-reference brackets" href="#label" id="footnote-reference-6" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p>
+</aside>
+<aside class="footnote brackets" id="footnote-2" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-2">3</a><span class="fn-bracket"></span></span>
+<p>This footnote is numbered automatically and anonymously using a
 label of &quot;#&quot; only.</p>
 <p>This is the second paragraph.</p>
 <p>And this is the third paragraph.</p>
-</dd>
-<dt class="label" id="footnote-3"><span class="brackets"><a class="fn-backref" href="#footnote-reference-4">*</a></span></dt>
-<dd><p>Footnotes may also use symbols, specified with a &quot;*&quot; label.
-Here's a reference to the next footnote: <a class="footnote-reference brackets" href="#footnote-4" id="footnote-reference-7">†</a>.</p>
-</dd>
-<dt class="label" id="footnote-4"><span class="brackets"><a class="fn-backref" href="#footnote-reference-7">†</a></span></dt>
-<dd><p>This footnote shows the next symbol in the sequence.</p>
-</dd>
-<dt class="label" id="footnote-5"><span class="brackets">4</span></dt>
-<dd><p>Here's an unreferenced footnote, with a reference to a
+</aside>
+<aside class="footnote brackets" id="footnote-3" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-4">*</a><span class="fn-bracket"></span></span>
+<p>Footnotes may also use symbols, specified with a &quot;*&quot; label.
+Here's a reference to the next footnote: <a class="footnote-reference brackets" href="#footnote-4" id="footnote-reference-7" role="doc-noteref"><span class="fn-bracket"></span>†<span class="fn-bracket"></span></a>.</p>
+</aside>
+<aside class="footnote brackets" id="footnote-4" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-7">†</a><span class="fn-bracket"></span></span>
+<p>This footnote shows the next symbol in the sequence.</p>
+</aside>
+<aside class="footnote brackets" id="footnote-5" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>4<span class="fn-bracket"></span></span>
+<p>Here's an unreferenced footnote, with a reference to a
 nonexistent footnote: <a href="#system-message-2"><span class="problematic" id="footnote-reference-8">5_</span></a>.</p>
-</dd>
-</dl>
+</aside>
+</aside>
 </section>
 <section id="citations">
-<h3><a class="toc-backref" href="#toc-entry-18"><span class="sectnum">2.12</span> Citations</a></h3>
-<dl class="citation">
-<dt class="label" id="cit2002"><span class="brackets">CIT2002</span><span class="fn-backref">(<a href="#citation-reference-1">1</a>,<a href="#citation-reference-2">2</a>)</span></dt>
-<dd><p>Citations are text-labeled footnotes. They may be
+<h3><a class="toc-backref" href="#toc-entry-18" role="doc-backlink"><span class="sectnum">2.12 </span>Citations</a></h3>
+<div role="list" class="citation-list">
+<div class="citation" id="cit2002" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>CIT2002<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#citation-reference-1">1</a>,<a role="doc-backlink" href="#citation-reference-2">2</a>)</span>
+<p>Citations are text-labeled footnotes. They may be
 rendered separately and differently from footnotes.</p>
-</dd>
-</dl>
-<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="citation-reference-2">CIT2002</a>, and a <a href="#system-message-3"><span class="problematic" id="citation-reference-3">nonexistent_</span></a>
+</div>
+</div>
+<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="citation-reference-2" role="doc-biblioref">CIT2002</a>, and a <a href="#system-message-3"><span class="problematic" id="citation-reference-3">nonexistent_</span></a>
 citation.</p>
 </section>
 <section id="targets">
-<span id="another-target"></span><h3><a class="toc-backref" href="#toc-entry-19"><span class="sectnum">2.13</span> Targets</a></h3>
+<span id="another-target"></span><h3><a class="toc-backref" href="#toc-entry-19" role="doc-backlink"><span class="sectnum">2.13 </span>Targets</a></h3>
 <p id="example">This paragraph is pointed to by the explicit &quot;example&quot; target. A
 reference can be found under <a class="reference internal" href="#inline-markup">Inline Markup</a>, above. <a class="reference internal" href="#inline-hyperlink-targets">Inline
 hyperlink targets</a> are also possible.</p>
 <p>Section headers are implicit targets, referred to by name. See
 <a class="reference internal" href="#targets">Targets</a>, which is a subsection of <a class="reference internal" href="#body-elements">Body Elements</a>.</p>
 <p>Explicit external targets are interpolated into references such as
-&quot;<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-19">7</a>&quot;.</p>
+&quot;<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-19" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a>&quot;.</p>
 <p>Targets may be indirect and anonymous.  Thus <a class="reference internal" href="#targets">this phrase</a> may also
 refer to the <a class="reference internal" href="#targets">Targets</a> section.</p>
 <p>Here's a <a href="#system-message-4"><span class="problematic" id="problematic-2">`hyperlink reference without a target`_</span></a>, which generates an
 error.</p>
 <section id="duplicate-target-names">
-<h4><a class="toc-backref" href="#toc-entry-20"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-20" role="doc-backlink"><span class="sectnum">2.13.1 </span>Duplicate Target Names</a></h4>
 <p>Duplicate names in section headers or other implicit targets will
 generate &quot;info&quot; (level-1) system messages.  Duplicate names in
 explicit targets will generate &quot;warning&quot; (level-2) system messages.</p>
 </section>
 <section id="duplicate-target-names-1">
-<h4><a class="toc-backref" href="#toc-entry-21"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-21" role="doc-backlink"><span class="sectnum">2.13.2 </span>Duplicate Target Names</a></h4>
 <p>Since there are two &quot;Duplicate Target Names&quot; section headers, we
 cannot uniquely refer to either of them by name.  If we try to (like
 this: <a href="#system-message-5"><span class="problematic" id="problematic-3">`Duplicate Target Names`_</span></a>), an error is generated.</p>
 </section>
 </section>
 <section id="directives">
-<h3><a class="toc-backref" href="#toc-entry-22"><span class="sectnum">2.14</span> Directives</a></h3>
-<div class="contents local topic" id="contents">
+<h3><a class="toc-backref" href="#toc-entry-22" role="doc-backlink"><span class="sectnum">2.14 </span>Directives</a></h3>
+<nav class="contents local" id="contents">
 <ul class="auto-toc simple">
-<li><p><a class="reference internal" href="#document-parts" id="toc-entry-53"><span class="sectnum">2.14.1</span> Document Parts</a></p></li>
-<li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-54"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li>
-<li><p><a class="reference internal" href="#tables" id="toc-entry-55"><span class="sectnum">2.14.3</span> Tables</a></p></li>
-<li><p><a class="reference internal" href="#admonitions" id="toc-entry-56"><span class="sectnum">2.14.4</span> Admonitions</a></p></li>
-<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-57"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></p></li>
-<li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-58"><span class="sectnum">2.14.6</span> Target Footnotes</a></p></li>
-<li><p><a class="reference internal" href="#replacement-text" id="toc-entry-59"><span class="sectnum">2.14.7</span> Replacement Text</a></p></li>
-<li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-60"><span class="sectnum">2.14.8</span> Compound Paragraph</a></p></li>
-<li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-61"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></p></li>
-<li><p><a class="reference internal" href="#code" id="toc-entry-62"><span class="sectnum">2.14.10</span> Code</a></p></li>
-<li><p><a class="reference internal" href="#meta" id="toc-entry-63"><span class="sectnum">2.14.11</span> Meta</a></p></li>
+<li><p><a class="reference internal" href="#document-parts" id="toc-entry-54"><span class="sectnum">2.14.1 </span>Document Parts</a></p></li>
+<li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-55"><span class="sectnum">2.14.2 </span>Images and Figures</a></p></li>
+<li><p><a class="reference internal" href="#tables" id="toc-entry-56"><span class="sectnum">2.14.3 </span>Tables</a></p></li>
+<li><p><a class="reference internal" href="#admonitions" id="toc-entry-57"><span class="sectnum">2.14.4 </span>Admonitions</a></p></li>
+<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-58"><span class="sectnum">2.14.5 </span>Topics, Sidebars, and Rubrics</a></p></li>
+<li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-59"><span class="sectnum">2.14.6 </span>Target Footnotes</a></p></li>
+<li><p><a class="reference internal" href="#replacement-text" id="toc-entry-60"><span class="sectnum">2.14.7 </span>Replacement Text</a></p></li>
+<li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-61"><span class="sectnum">2.14.8 </span>Compound Paragraph</a></p></li>
+<li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-62"><span class="sectnum">2.14.9 </span>Parsed Literal Blocks</a></p></li>
+<li><p><a class="reference internal" href="#code" id="toc-entry-63"><span class="sectnum">2.14.10 </span>Code</a></p></li>
+<li><p><a class="reference internal" href="#meta" id="toc-entry-64"><span class="sectnum">2.14.11 </span>Meta</a></p></li>
 </ul>
-</div>
+</nav>
 <p>These are just a sample of the many reStructuredText Directives.  For
-others, please see <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">reStructuredText Directives</a> <a class="footnote-reference brackets" href="#footnote-13" id="footnote-reference-27">13</a>.</p>
+others, please see <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">reStructuredText Directives</a> <a class="footnote-reference brackets" href="#footnote-14" id="footnote-reference-28" role="doc-noteref"><span class="fn-bracket"></span>14<span class="fn-bracket"></span></a>.</p>
 <section id="document-parts">
-<h4><a class="toc-backref" href="#toc-entry-53"><span class="sectnum">2.14.1</span> Document Parts</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-54" role="doc-backlink"><span class="sectnum">2.14.1 </span>Document Parts</a></h4>
 <p>An example of the &quot;contents&quot; directive can be seen above this section
 (a local, untitled table of <a class="reference internal" href="#contents">contents</a>) and at the beginning of the
 document (a document-wide <a class="reference internal" href="#table-of-contents">table of contents</a>).</p>
 </section>
 <section id="images-and-figures">
-<h4><a class="toc-backref" href="#toc-entry-54"><span class="sectnum">2.14.2</span> Images and Figures</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-55" role="doc-backlink"><span class="sectnum">2.14.2 </span>Images and Figures</a></h4>
 <p>An image directive (also clickable -- a hyperlink reference):</p>
 <a class="reference internal image-reference" href="#directives"><img alt="../../../docs/user/rst/images/title.png" class="class1 class2" src="../../../docs/user/rst/images/title.png" style="width: 70%;" /></a>
 <p>Image with multiple IDs:</p>
@@ -599,10 +610,6 @@
 <p>Plaintext markup syntax and parser system.</p>
 <div class="legend">
 <table>
-<colgroup>
-<col style="width: 20%" />
-<col style="width: 80%" />
-</colgroup>
 <tbody>
 <tr><td><p>re</p></td>
 <td><p>Revised, revisited, based on 're' module.</p></td>
@@ -662,15 +669,11 @@
 upon the style sheet and the browser or rendering software used.</p>
 </section>
 <section id="tables">
-<h4><a class="toc-backref" href="#toc-entry-55"><span class="sectnum">2.14.3</span> Tables</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-56" role="doc-backlink"><span class="sectnum">2.14.3 </span>Tables</a></h4>
 <p>Tables may be given titles and additional arguments with the <em>table</em>
 directive:</p>
 <table class="align-left">
 <caption>left-aligned table</caption>
-<colgroup>
-<col style="width: 50%" />
-<col style="width: 50%" />
-</colgroup>
 <thead>
 <tr><th class="head"><p>A</p></th>
 <th class="head"><p>not A</p></th>
@@ -687,10 +690,6 @@
 </table>
 <table class="align-center">
 <caption>center-aligned table</caption>
-<colgroup>
-<col style="width: 50%" />
-<col style="width: 50%" />
-</colgroup>
 <thead>
 <tr><th class="head"><p>A</p></th>
 <th class="head"><p>not A</p></th>
@@ -707,10 +706,6 @@
 </table>
 <table class="align-right">
 <caption>right-aligned table</caption>
-<colgroup>
-<col style="width: 50%" />
-<col style="width: 50%" />
-</colgroup>
 <thead>
 <tr><th class="head"><p>A</p></th>
 <th class="head"><p>not A</p></th>
@@ -728,7 +723,7 @@
 <p>With the &quot;widths&quot; argument &quot;auto&quot; (or &quot;class&quot; value &quot;colwidths-auto&quot;),
 column widths are determined by the backend (if supported by the
 writer/backend).</p>
-<span id="target1"></span><table class="colwidths-auto" id="target2">
+<span id="target1"></span><table id="target2">
 <thead>
 <tr><th class="head"><p>A</p></th>
 <th class="head"><p>B</p></th>
@@ -756,28 +751,28 @@
 </table>
 </section>
 <section id="admonitions">
-<h4><a class="toc-backref" href="#toc-entry-56"><span class="sectnum">2.14.4</span> Admonitions</a></h4>
-<div class="admonition attention">
+<h4><a class="toc-backref" href="#toc-entry-57" role="doc-backlink"><span class="sectnum">2.14.4 </span>Admonitions</a></h4>
+<aside class="admonition attention">
 <p class="admonition-title">Attention!</p>
 <p>Directives at large.</p>
-</div>
-<div class="admonition caution">
+</aside>
+<aside class="admonition caution">
 <p class="admonition-title">Caution!</p>
 <p>Don't take any wooden nickels.</p>
-</div>
-<div class="admonition danger">
+</aside>
+<aside class="admonition danger">
 <p class="admonition-title">!DANGER!</p>
 <p>Mad scientist at work!</p>
-</div>
-<div class="admonition error">
+</aside>
+<aside class="admonition error">
 <p class="admonition-title">Error</p>
 <p>Does not compute.</p>
-</div>
-<div class="admonition hint">
+</aside>
+<aside class="admonition hint">
 <p class="admonition-title">Hint</p>
 <p>It's bigger than a bread box.</p>
-</div>
-<div class="admonition important">
+</aside>
+<aside class="admonition important">
 <p class="admonition-title">Important</p>
 <ul class="simple">
 <li><p>Wash behind your ears.</p></li>
@@ -785,27 +780,27 @@
 <li><p>Call your mother.</p></li>
 <li><p>Back up your data.</p></li>
 </ul>
-</div>
-<div class="admonition note">
+</aside>
+<aside class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This is a note.</p>
-</div>
-<div class="admonition tip">
+</aside>
+<aside class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>15% if the service is good.</p>
-</div>
-<div class="admonition warning">
+</aside>
+<aside class="admonition warning">
 <p class="admonition-title">Warning</p>
 <p>Strong prose may provoke extreme mental exertion.
 Reader discretion is strongly advised.</p>
-</div>
-<div class="admonition admonition-and-by-the-way">
+</aside>
+<aside class="admonition admonition-and-by-the-way">
 <p class="admonition-title">And, by the way...</p>
 <p>You can make up your own admonition too.</p>
-</div>
+</aside>
 </section>
 <section id="topics-sidebars-and-rubrics">
-<h4><a class="toc-backref" href="#toc-entry-57"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-58" role="doc-backlink"><span class="sectnum">2.14.5 </span>Topics, Sidebars, and Rubrics</a></h4>
 <p><em>Sidebars</em> are like miniature, parallel documents.</p>
 <aside class="sidebar">
 <p class="sidebar-title">Optional Sidebar Title</p>
@@ -818,10 +813,10 @@
 </aside>
 <p>A <em>topic</em> is like a block quote with a title, or a self-contained section
 with no subsections.</p>
-<div class="topic">
+<aside class="topic">
 <p class="topic-title">Topic Title</p>
 <p>This is a topic.</p>
-</div>
+</aside>
 <p>A <em>rubric</em> is like an informal heading that doesn't correspond to the
 document's structure. It is typically highlighted in red (hence the name).</p>
 <p class="rubric">This is a rubric</p>
@@ -829,100 +824,112 @@
 allowed (e.g. inside a directive).</p>
 </section>
 <section id="target-footnotes">
-<h4><a class="toc-backref" href="#toc-entry-58"><span class="sectnum">2.14.6</span> Target Footnotes</a></h4>
-<dl class="footnote brackets">
-<dt class="label" id="footnote-7"><span class="brackets">7</span><span class="fn-backref">(<a href="#footnote-reference-18">1</a>,<a href="#footnote-reference-19">2</a>,<a href="#footnote-reference-20">3</a>,<a href="#footnote-reference-25">4</a>)</span></dt>
-<dd><p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p>
-</dd>
-<dt class="label" id="footnote-8"><span class="brackets"><a class="fn-backref" href="#footnote-reference-21">8</a></span></dt>
-<dd><p><a class="reference external" href="http://pygments.org/">http://pygments.org/</a></p>
-</dd>
-<dt class="label" id="footnote-9"><span class="brackets"><a class="fn-backref" href="#footnote-reference-22">9</a></span></dt>
-<dd><p><a class="reference external" href="http://docutils.sourceforge.net/docs/user/config.html#table-style">http://docutils.sourceforge.net/docs/user/config.html#table-style</a></p>
-</dd>
-<dt class="label" id="footnote-10"><span class="brackets"><a class="fn-backref" href="#footnote-reference-23">10</a></span></dt>
-<dd><p><a class="reference external" href="http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf">http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf</a></p>
-</dd>
-<dt class="label" id="footnote-11"><span class="brackets"><a class="fn-backref" href="#footnote-reference-24">11</a></span></dt>
-<dd><p><a class="reference external" href="http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text">http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text</a></p>
-</dd>
-<dt class="label" id="footnote-12"><span class="brackets"><a class="fn-backref" href="#footnote-reference-26">12</a></span></dt>
-<dd><p><a class="reference external" href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a></p>
-</dd>
-<dt class="label" id="footnote-13"><span class="brackets"><a class="fn-backref" href="#footnote-reference-27">13</a></span></dt>
-<dd><p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">https://docutils.sourceforge.io/docs/ref/rst/directives.html</a></p>
-</dd>
-<dt class="label" id="footnote-14"><span class="brackets"><a class="fn-backref" href="#footnote-reference-28">14</a></span></dt>
-<dd><p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata</a></p>
-</dd>
-<dt class="label" id="footnote-15"><span class="brackets"><a class="fn-backref" href="#footnote-reference-29">15</a></span></dt>
-<dd><p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag">https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag</a></p>
-</dd>
-<dt class="label" id="footnote-16"><span class="brackets"><a class="fn-backref" href="#footnote-reference-30">16</a></span></dt>
-<dd><p><a class="reference external" href="https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article">https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article</a></p>
-</dd>
-<dt class="label" id="footnote-17"><span class="brackets"><a class="fn-backref" href="#footnote-reference-31">17</a></span></dt>
-<dd><p><a class="reference external" href="https://html.spec.whatwg.org/#text-level-semantics">https://html.spec.whatwg.org/#text-level-semantics</a></p>
-</dd>
-<dt class="label" id="footnote-18"><span class="brackets"><a class="fn-backref" href="#footnote-reference-32">18</a></span></dt>
-<dd><p><a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">https://html.spec.whatwg.org/multipage/edits.html</a></p>
-</dd>
-</dl>
+<h4><a class="toc-backref" href="#toc-entry-59" role="doc-backlink"><span class="sectnum">2.14.6 </span>Target Footnotes</a></h4>
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="footnote-7" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-18">1</a>,<a role="doc-backlink" href="#footnote-reference-19">2</a>,<a role="doc-backlink" href="#footnote-reference-20">3</a>,<a role="doc-backlink" href="#footnote-reference-26">4</a>)</span>
+<p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-8" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-21">8</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="http://pygments.org/">http://pygments.org/</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-9" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-22">9</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://www.w3.org/TR/html52/interactive-elements.html#the-details-element">https://www.w3.org/TR/html52/interactive-elements.html#the-details-element</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-10" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-23">10</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://docutils.sourceforge.io/docs/user/config.html#table-style">https://docutils.sourceforge.io/docs/user/config.html#table-style</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-11" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-24">11</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf">http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-12" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-25">12</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://docutils.sourceforge.io/docs/dev/todo.html#interpreted-text">https://docutils.sourceforge.io/docs/dev/todo.html#interpreted-text</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-13" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-27">13</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-14" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-28">14</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">https://docutils.sourceforge.io/docs/ref/rst/directives.html</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-15" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-29">15</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-16" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-30">16</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag">https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-17" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-31">17</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article">https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-18" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-32">18</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://html.spec.whatwg.org/#text-level-semantics">https://html.spec.whatwg.org/#text-level-semantics</a></p>
+</aside>
+<aside class="footnote brackets" id="footnote-19" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span><a role="doc-backlink" href="#footnote-reference-33">19</a><span class="fn-bracket"></span></span>
+<p><a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">https://html.spec.whatwg.org/multipage/edits.html</a></p>
+</aside>
+</aside>
 </section>
 <section id="replacement-text">
-<h4><a class="toc-backref" href="#toc-entry-59"><span class="sectnum">2.14.7</span> Replacement Text</a></h4>
-<p>I recommend you try <a class="reference external" href="http://www.python.org/">Python, <em>the</em> best language around</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-20">7</a>.</p>
+<h4><a class="toc-backref" href="#toc-entry-60" role="doc-backlink"><span class="sectnum">2.14.7 </span>Replacement Text</a></h4>
+<p>I recommend you try <a class="reference external" href="http://www.python.org/">Python, <em>the</em> best language around</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-20" role="doc-noteref"><span class="fn-bracket"></span>7<span class="fn-bracket"></span></a>.</p>
 </section>
 <section id="compound-paragraph">
-<h4><a class="toc-backref" href="#toc-entry-60"><span class="sectnum">2.14.8</span> Compound Paragraph</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-61" role="doc-backlink"><span class="sectnum">2.14.8 </span>Compound Paragraph</a></h4>
 <p>The <em>compound</em> directive is used to create a &quot;compound paragraph&quot;, which
 is a single logical paragraph containing multiple physical body
 elements. For example:</p>
 <div class="compound">
-<p class="compound-first">The 'rm' command is very dangerous.  If you are logged
+<p>The 'rm' command is very dangerous.  If you are logged
 in as root and enter</p>
-<pre class="compound-middle literal-block">cd /
+<pre class="literal-block">cd /
 rm -rf *</pre>
-<p class="compound-last">you will erase the entire contents of your file system.</p>
+<p>you will erase the entire contents of your file system.</p>
 </div>
 <p>Test the handling and display of compound paragraphs:</p>
 <div class="some-class compound">
-<p class="compound-first">Compound 2, paragraph 1,</p>
-<p class="compound-middle">compound 2, paragraph 2,</p>
-<ul class="compound-middle simple">
+<p>Compound 2, paragraph 1,</p>
+<p>compound 2, paragraph 2,</p>
+<ul class="simple">
 <li><p>list item 1,</p></li>
 <li><p>list item 2,</p></li>
 </ul>
-<p class="compound-last">compound 2, paragraph 3.</p>
+<p>compound 2, paragraph 3.</p>
 </div>
 <div class="compound">
 <p>Compound 3, only consisting of one paragraph.</p>
 </div>
 <div class="compound">
-<pre class="compound-first literal-block">Compound 4.
+<pre class="literal-block">Compound 4.
 This one starts with a literal block.</pre>
-<p class="compound-last">Compound 4, paragraph following the literal block.</p>
+<p>Compound 4, paragraph following the literal block.</p>
 </div>
 <p>Now something <em>really</em> perverted -- a nested compound block.  This is
 just to test that it works at all; the results don't have to be
 meaningful.</p>
 <div class="compound">
-<p class="compound-first">Compound 5, block 1 (a paragraph).</p>
-<div class="compound-middle compound">
-<p class="compound-first">Compound 6 is block 2 in compound 5.</p>
-<p class="compound-last">Compound 6, another paragraph.</p>
+<p>Compound 5, block 1 (a paragraph).</p>
+<div class="compound">
+<p>Compound 6 is block 2 in compound 5.</p>
+<p>Compound 6, another paragraph.</p>
 </div>
-<p class="compound-last">Compound 5, block 3 (a paragraph).</p>
+<p>Compound 5, block 3 (a paragraph).</p>
 </div>
 <div class="compound">
-<p class="compound-first">Compound 7, tests the inclusion of various block-level
+<p>Compound 7, tests the inclusion of various block-level
 elements in one logical paragraph. First a table,</p>
-<table class="compound-middle">
-<colgroup>
-<col style="width: 33%" />
-<col style="width: 33%" />
-<col style="width: 33%" />
-</colgroup>
+<table>
 <tbody>
 <tr><td><p>Left cell, first
 paragraph.</p>
@@ -940,64 +947,64 @@
 </tr>
 </tbody>
 </table>
-<p class="compound-middle">followed by a paragraph. This physical paragraph is
+<p>followed by a paragraph. This physical paragraph is
 actually a continuation of the paragraph before the table. It is followed
 by</p>
-<blockquote class="compound-middle">
+<blockquote>
 <p>a quote and</p>
 </blockquote>
-<ol class="compound-middle arabic simple">
+<ol class="arabic simple">
 <li><p>an enumerated list,</p></li>
 </ol>
-<p class="compound-middle">a paragraph,</p>
-<dl class="compound-middle option-list">
+<p>a paragraph,</p>
+<dl class="option-list">
 <dt><kbd><span class="option">--an</span></kbd></dt>
 <dd><p>option list,</p>
 </dd>
 </dl>
-<p class="compound-middle">a paragraph,</p>
-<dl class="compound-middle field-list simple">
-<dt>a field</dt>
+<p>a paragraph,</p>
+<dl class="field-list simple">
+<dt>a field<span class="colon">:</span></dt>
 <dd><p>list,</p>
 </dd>
 </dl>
-<p class="compound-middle">a paragraph,</p>
-<dl class="compound-middle simple">
+<p>a paragraph,</p>
+<dl class="simple">
 <dt>a definition</dt>
 <dd><p>list,</p>
 </dd>
 </dl>
-<p class="compound-middle">a paragraph, an image:</p>
-<img alt="../../../docs/user/rst/images/biohazard.png" class="compound-middle" src="../../../docs/user/rst/images/biohazard.png" />
-<p class="compound-middle">a paragraph,</p>
-<div class="compound-middle line-block">
+<p>a paragraph, an image:</p>
+<img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" />
+<p>a paragraph,</p>
+<div class="line-block">
 <div class="line">a line</div>
 <div class="line">block,</div>
 </div>
-<p class="compound-middle">a paragraph followed by a comment,</p>
+<p>a paragraph followed by a comment,</p>
 
-<p class="compound-middle">a paragraph, a</p>
-<div class="admonition note compound-middle">
+<p>a paragraph, a</p>
+<aside class="admonition note">
 <p class="admonition-title">Note</p>
 <p>with content</p>
-</div>
-<p class="compound-last">and the final paragraph of the compound 7.</p>
+</aside>
+<p>and the final paragraph of the compound 7.</p>
 </div>
 </section>
 <section id="parsed-literal-blocks">
-<h4><a class="toc-backref" href="#toc-entry-61"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-62" role="doc-backlink"><span class="sectnum">2.14.9 </span>Parsed Literal Blocks</a></h4>
 <pre class="literal-block">This is a parsed literal block.
     This line is indented.  The next line is blank.
 
 Inline markup is supported, e.g. <em>emphasis</em>, <strong>strong</strong>, <span class="docutils literal">literal
 text</span>, <sub>sub-</sub> and <sup>super</sup>scripts,
-inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
-footnotes <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-9">1</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</pre>
+inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
+footnotes <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-9" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</pre>
 </section>
 <section id="code">
-<h4><a class="toc-backref" href="#toc-entry-62"><span class="sectnum">2.14.10</span> Code</a></h4>
+<h4><a class="toc-backref" href="#toc-entry-63" role="doc-backlink"><span class="sectnum">2.14.10 </span>Code</a></h4>
 <p>Blocks of source code can be set with the <cite>code</cite> directive. If the code
-language is specified, the content is parsed and tagged by the <a class="reference external" href="http://pygments.org/">Pygments</a> <a class="footnote-reference brackets" href="#footnote-8" id="footnote-reference-21">8</a>
+language is specified, the content is parsed and tagged by the <a class="reference external" href="http://pygments.org/">Pygments</a> <a class="footnote-reference brackets" href="#footnote-8" id="footnote-reference-21" role="doc-noteref"><span class="fn-bracket"></span>8<span class="fn-bracket"></span></a>
 syntax highlighter and can be formatted with a style sheet. (Code parsing
 is turned off using the <span class="docutils literal"><span class="pre">syntax-highlight</span></span> config setting in the test
 conversions in order to get identical results with/without installed
@@ -1013,26 +1020,26 @@
 or as base for special code roles, e.g. the LaTeX code in the next
 paragraph.</p>
 <p>Docutils uses LaTeX syntax for math directives and roles:
-<code class="tex">\alpha = f(x)</code> prints <span class="formula"><i>α</i> = <i>f</i>(<i>x</i>)</span>.</p>
+<code class="tex">\alpha = f(x)</code> prints <span class="formula"><i>α</i> = <i>f</i>(<i>x</i>)</span>.</p>
 <p>The <span class="docutils literal">:code:</span> option of the <cite>include</cite> directive sets the included content
 as a code block, here the rst file <span class="docutils literal">header_footer.txt</span> with line numbers:</p>
 <pre class="code rst literal-block"><small class="ln">1 </small><code data-lineno="1 ">.. header:: Document header
 </code><small class="ln">2 </small><code data-lineno="2 ">.. footer:: Document footer</code></pre>
 </section>
 <section id="meta">
-<h4><a class="toc-backref" href="#toc-entry-63"><span class="sectnum">2.14.11</span> Meta</a></h4>
-<p>The <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">“meta” directive</a> <a class="footnote-reference brackets" href="#footnote-14" id="footnote-reference-28">14</a> is used to specify metadata to be stored in,
+<h4><a class="toc-backref" href="#toc-entry-64" role="doc-backlink"><span class="sectnum">2.14.11 </span>Meta</a></h4>
+<p>The <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">“meta” directive</a> <a class="footnote-reference brackets" href="#footnote-15" id="footnote-reference-29" role="doc-noteref"><span class="fn-bracket"></span>15<span class="fn-bracket"></span></a> is used to specify metadata to be stored in,
 e.g., HTML META tags or ODT file properties.</p>
 </section>
 </section>
 <section id="substitution-definitions">
-<h3><a class="toc-backref" href="#toc-entry-34"><span class="sectnum">2.15</span> Substitution Definitions</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-34" role="doc-backlink"><span class="sectnum">2.15 </span>Substitution Definitions</a></h3>
 <p>An inline image (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" />) example:</p>
 <p>A Unicode example:</p>
 <p>(Substitution definitions are not visible in the HTML source.)</p>
 </section>
 <section id="comments">
-<h3><a class="toc-backref" href="#toc-entry-35"><span class="sectnum">2.16</span> Comments</a></h3>
+<h3><a class="toc-backref" href="#toc-entry-35" role="doc-backlink"><span class="sectnum">2.16 </span>Comments</a></h3>
 <p>Here's one:</p>
 
 </dd>
 <dt>data</dt>
-<dd><p>Machine-readable equivalent <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-12">6</a></p>
+<dd><p>Machine-readable equivalent <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-12" role="doc-noteref"><span class="fn-bracket"></span>6<span class="fn-bracket"></span></a></p>
 
 </dd>
 <dt>time</dt>
-<dd><p>Machine-readable equivalent of date- or time-related data <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-13">6</a></p>
+<dd><p>Machine-readable equivalent of date- or time-related data <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-13" role="doc-noteref"><span class="fn-bracket"></span>6<span class="fn-bracket"></span></a></p>
 
 </dd>
 <dt>code</dt>
@@ -1655,7 +1674,7 @@
 </blockquote>
 </dd>
 <dt>bdi</dt>
-<dd><p>Text directionality isolation <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-14">5</a></p>
+<dd><p>Text directionality isolation <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-14" role="doc-noteref"><span class="fn-bracket"></span>5<span class="fn-bracket"></span></a></p>
 <blockquote>
 <p>The recommended restaurant is <bdi>My Juice Café (At The Beach)</bdi>.</p>
 </blockquote>
@@ -1663,7 +1682,7 @@
 element.</p>
 </dd>
 <dt>bdo</dt>
-<dd><p>Text directionality formatting <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-15">6</a></p>
+<dd><p>Text directionality formatting <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-15" role="doc-noteref"><span class="fn-bracket"></span>6<span class="fn-bracket"></span></a></p>
 
 <p>Authors <em>must</em> specify the dir attribute on this element.</p>
@@ -1701,24 +1720,28 @@
 </blockquote>
 </dd>
 </dl>
-<dl class="footnote brackets">
-<dt class="label" id="attribute-optional"><span class="brackets">5</span><span class="fn-backref">(<a href="#footnote-reference-10">1</a>,<a href="#footnote-reference-14">2</a>,<a href="#footnote-reference-16">3</a>,<a href="#footnote-reference-17">4</a>)</span></dt>
-<dd><p>Would gain from support for attributes/arguments
-to inline roles. See <a class="reference external" href="http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text">TODO</a> <a class="footnote-reference brackets" href="#footnote-11" id="footnote-reference-24">11</a></p>
-</dd>
-<dt class="label" id="attribute-required"><span class="brackets">6</span><span class="fn-backref">(<a href="#footnote-reference-12">1</a>,<a href="#footnote-reference-13">2</a>,<a href="#footnote-reference-15">3</a>)</span></dt>
-<dd><p>Requires support for attributes to inline
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="attribute-optional" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>5<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-10">1</a>,<a role="doc-backlink" href="#footnote-reference-14">2</a>,<a role="doc-backlink" href="#footnote-reference-16">3</a>,<a role="doc-backlink" href="#footnote-reference-17">4</a>)</span>
+<p>Would gain from support for attributes/arguments
+to inline roles. See <a class="reference external" href="https://docutils.sourceforge.io/docs/dev/todo.html#interpreted-text">TODO</a> <a class="footnote-reference brackets" href="#footnote-12" id="footnote-reference-25" role="doc-noteref"><span class="fn-bracket"></span>12<span class="fn-bracket"></span></a></p>
+</aside>
+<aside class="footnote brackets" id="attribute-required" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>6<span class="fn-bracket"></span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#footnote-reference-12">1</a>,<a role="doc-backlink" href="#footnote-reference-13">2</a>,<a role="doc-backlink" href="#footnote-reference-15">3</a>)</span>
+<p>Requires support for attributes to inline
 roles to make sense.</p>
-</dd>
-</dl>
+</aside>
+</aside>
 </section>
 <section id="indicating-edits">
-<h3><a class="toc-backref" href="#toc-entry-51"><span class="sectnum">3.4</span> Indicating Edits</a></h3>
-<p>The <a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">HTML tags for representation of edits to the document</a> <a class="footnote-reference brackets" href="#footnote-18" id="footnote-reference-32">18</a> and their
+<h3><a class="toc-backref" href="#toc-entry-52" role="doc-backlink"><span class="sectnum">3.4 </span>Indicating Edits</a></h3>
+<p>The <a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">HTML tags for representation of edits to the document</a> <a class="footnote-reference brackets" href="#footnote-19" id="footnote-reference-33" role="doc-noteref"><span class="fn-bracket"></span>19<span class="fn-bracket"></span></a> and their
 reStructuredText equivalents are:</p>
 <dl class="description">
 <dt>ins</dt>
-<dd><p>Additions <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-16">5</a></p>
+<dd><p>Additions <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-16" role="doc-noteref"><span class="fn-bracket"></span>5<span class="fn-bracket"></span></a></p>
 <blockquote>
 <p>This text has &quot;always&quot; been here. <ins>This text has been inserted.</ins></p>
 <ins class="docutils container">
@@ -1727,7 +1750,7 @@
 </blockquote>
 </dd>
 <dt>del</dt>
-<dd><p>Removed content <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-17">5</a></p>
+<dd><p>Removed content <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-17" role="doc-noteref"><span class="fn-bracket"></span>5<span class="fn-bracket"></span></a></p>
 <blockquote>
 <p><del>This text has been deleted</del>, here is the rest of the paragraph.</p>
 <del class="docutils container">
@@ -1739,7 +1762,7 @@
 </section>
 </section>
 <section id="error-handling">
-<h2><a class="toc-backref" href="#toc-entry-52"><span class="sectnum">4</span> Error Handling</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-53" role="doc-backlink"><span class="sectnum">4 </span>Error Handling</a></h2>
 <p>Any errors caught during processing will generate system messages.</p>
 <p>There should be five messages in the following, auto-generated
 section, &quot;Docutils System Messages&quot;:</p>
@@ -1747,32 +1770,31 @@
 </section>
 <section class="system-messages">
 <h2>Docutils System Messages</h2>
-<div class="system-message" id="system-message-1">
+<aside class="system-message" id="system-message-1">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 99); <em><a href="#problematic-1">backlink</a></em></p>
 <p>Undefined substitution referenced: &quot;problematic&quot;.</p>
-</div>
-<div class="system-message" id="system-message-2">
+</aside>
+<aside class="system-message" id="system-message-2">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 387); <em><a href="#footnote-reference-8">backlink</a></em></p>
 <p>Unknown target name: &quot;5&quot;.</p>
-</div>
-<div class="system-message" id="system-message-3">
+</aside>
+<aside class="system-message" id="system-message-3">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 396); <em><a href="#citation-reference-3">backlink</a></em></p>
 <p>Unknown target name: &quot;nonexistent&quot;.</p>
-</div>
-<div class="system-message" id="system-message-4">
+</aside>
+<aside class="system-message" id="system-message-4">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 423); <em><a href="#problematic-2">backlink</a></em></p>
 <p>Unknown target name: &quot;hyperlink reference without a target&quot;.</p>
-</div>
-<div class="system-message" id="system-message-5">
+</aside>
+<aside class="system-message" id="system-message-5">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 436); <em><a href="#problematic-3">backlink</a></em></p>
 <p>Duplicate target name, cannot be used as a unique reference: &quot;duplicate target names&quot;.</p>
-</div>
+</aside>
 </section>
 </main>
 <footer>
 <p>Document footer</p>
 <p><a class="reference external image-reference" href="http://www.w3.org/TR/html5/"><img alt="Conforms to HTML 5" src="http://www.w3.org/html/logo/badge/html5-badge-h-css3-semantics.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://validator.w3.org/check?uri=referer"><img alt="Check validity!" src="https://www.w3.org/Icons/ValidatorSuite/vs-blue-190.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://jigsaw.w3.org/css-validator/check/referer"><img alt="Valid CSS 2.1!" src="http://jigsaw.w3.org/css-validator/images/vcss" style="width: 88px; height: 31px;" /></a></p>
-
 </footer>
 </body>
 </html>

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_latex.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_latex.tex Changed

@@ -1,12 +1,8 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 \usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
-\DeclareUnicodeCharacter{21D4}{\ensuremath{\Leftrightarrow}}
-\DeclareUnicodeCharacter{2660}{\ensuremath{\spadesuit}}
-\DeclareUnicodeCharacter{2663}{\ensuremath{\clubsuit}}
 \usepackage{alltt}
 \usepackage{amsmath}
 \usepackagebritish,french,ngerman,english{babel}
@@ -24,7 +20,6 @@
 \setlength{\extrarowheight}{2pt}
 \newlength{\DUtablewidth} % internal use in tables
 \usepackage{tabularx}
-\usepackage{textcomp} % text symbol macros
 
 %%% Custom LaTeX preamble
 % PDF Standard Fonts
@@ -52,21 +47,25 @@
   \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{}
 }
 
-% abstract title
-\providecommand*{\DUtitleabstract}1{\centerline{\textbf{#1}}}
-
-% admonition (specially marked topic)
-\providecommand{\DUadmonition}2class-arg{%
-  % try \DUadmonition#1{#2}:
-  \ifcsname DUadmonition#1\endcsname%
-    \csname DUadmonition#1\endcsname{#2}%
-  \else
-    \begin{center}
-      \fbox{\parbox{0.9\linewidth}{#2}}
-    \end{center}
-  \fi
+\providecommand*{\DUCLASSabstract}{
+  \renewcommand{\DUtitle}1{\centerline{\textbf{##1}}}
 }
 
+% admonition environment (specially marked topic)
+\ifx\DUadmonition\undefined % poor man's "provideenvironment"
+ \newbox{\DUadmonitionbox}
+ \newenvironment{DUadmonition}%
+  {\begin{center}
+     \begin{lrbox}{\DUadmonitionbox}
+       \begin{minipage}{0.9\linewidth}
+  }%
+  {    \end{minipage}
+     \end{lrbox}
+     \fbox{\usebox{\DUadmonitionbox}}
+   \end{center}
+  }
+\fi
+
 % special topic for dedications
 \providecommand*{\DUCLASSdedication}{%
   \renewenvironment{quote}{\begin{center}}{\end{center}}%
@@ -79,8 +78,7 @@
 \providecommand*{\DUdocumentsubtitle}1{{\large #1}}
 \newcounter{enumv}
 
-% error admonition title
-\providecommand*{\DUtitleerror}1{\DUtitle{\color{red}#1}}
+\providecommand*{\DUCLASSerror}{\color{red}}
 
 % field list environment (for separate configuration of `field lists`)
 \ifthenelse{\isundefined{\DUfieldlist}}{
@@ -161,14 +159,8 @@
 \providecommand*{\DUsubtitle}1{\par\emph{#1}\smallskip}
 
 % title for topics, admonitions, unsupported section levels, and sidebar
-\providecommand*{\DUtitle}2class-arg{%
-  % call \DUtitle#1{#2} if it exists:
-  \ifcsname DUtitle#1\endcsname%
-    \csname DUtitle#1\endcsname{#2}%
-  \else
-    \smallskip\noindent\textbf{#2}\smallskip%
-  \fi
-}
+\providecommand*{\DUtitle}1{%
+  \smallskip\noindent\textbf{#1}\smallskip}
 
 % titlereference standard role
 \providecommand*{\DUroletitlereference}1{\textsl{#1}}
@@ -254,7 +246,7 @@
 
 \begin{DUclass}{dedication}
 \begin{quote}
-\DUtitlededication{Dedication}
+\DUtitle{Dedication}
 
 For Docutils users \& co-developers.
 \end{quote}
@@ -262,7 +254,7 @@
 
 \begin{DUclass}{abstract}
 \begin{quote}
-\DUtitleabstract{Abstract}
+\DUtitle{Abstract}
 
 This is a test document, containing at least one example of each
 reStructuredText construct.
@@ -353,8 +345,8 @@
 reference to the \hyperrefdoctitle{doctitle} and the \hyperrefsubtitle{subtitle}.
 
 The default role for interpreted text is \DUroletitlereference{Title Reference}.  Here are
-some explicit interpreted text roles: a PEP reference (\href{http://www.python.org/dev/peps/pep-0287}{PEP 287}); an
-RFC reference (\href{http://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
+some explicit interpreted text roles: a PEP reference (\href{https://peps.python.org/pep-0287}{PEP 287}); an
+RFC reference (\href{https://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
 (\DUrole{acronym}{reST}), code (\texttt{\DUrole{code}{print \textquotedbl{}hello world\textquotedbl{}}}); a \textsubscript{subscript};
 a \textsuperscript{superscript} and explicit roles for \DUroletitlereference{Docutils}’
 \emph{standard} \textbf{inline} \texttt{markup}.
@@ -812,7 +804,6 @@
   \label{directives}%
 }
 
-\phantomsection\label{contents}
 These are just a sample of the many reStructuredText Directives.  For
 others, please see \href{https://docutils.sourceforge.io/docs/ref/rst/directives.html}{reStructuredText Directives}\DUfootnotemark{footnote-reference-18}{footnote-10}{9}.
 
@@ -996,7 +987,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1033,7 +1024,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1070,7 +1061,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1100,7 +1091,6 @@
 \textbf{A} & \textbf{B} & \textbf{A or B} \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
 \endfoot
 \endlastfoot
 False & False & False \\
@@ -1119,38 +1109,49 @@
   \label{admonitions}%
 }
 
-\DUadmonitionattention{
-\DUtitleattention{Attention!}
+\begin{DUclass}{attention}
+\begin{DUadmonition}
+\DUtitle{Attention!}
 
 Directives at large.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitioncaution{
-\DUtitlecaution{Caution!}
+\begin{DUclass}{caution}
+\begin{DUadmonition}
+\DUtitle{Caution!}
 
 Don’t take any wooden nickels.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitiondanger{
-\DUtitledanger{!DANGER!}
+\begin{DUclass}{danger}
+\begin{DUadmonition}
+\DUtitle{!DANGER!}
 
 Mad scientist at work!
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionerror{
-\DUtitleerror{Error}
+\begin{DUclass}{error}
+\begin{DUadmonition}
+\DUtitle{Error}
 
 Does not compute.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionhint{
-\DUtitlehint{Hint}
+\begin{DUclass}{hint}
+\begin{DUadmonition}
+\DUtitle{Hint}
 
 It’s bigger than a bread box.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionimportant{
-\DUtitleimportant{Important}
+\begin{DUclass}{important}
+\begin{DUadmonition}
+\DUtitle{Important}
 
 \begin{itemize}
 \item Wash behind your ears.
@@ -1161,32 +1162,41 @@
 
 \item Back up your data.
 \end{itemize}
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionnote{
-\DUtitlenote{Note}
+\begin{DUclass}{note}
+\begin{DUadmonition}
+\DUtitle{Note}
 
 This is a note.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitiontip{
-\DUtitletip{Tip}
+\begin{DUclass}{tip}
+\begin{DUadmonition}
+\DUtitle{Tip}
 
 15\% if the service is good.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionwarning{
-\DUtitlewarning{Warning}
+\begin{DUclass}{warning}
+\begin{DUadmonition}
+\DUtitle{Warning}
 
 Strong prose may provoke extreme mental exertion.
 Reader discretion is strongly advised.
-}
+\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionadmonition-and-by-the-way{
-\DUtitleadmonition-and-by-the-way{And, by the way…}
+\begin{DUclass}{admonition-and-by-the-way}
+\begin{DUadmonition}
+\DUtitle{And, by the way…}
 
 You can make up your own admonition too.
-}
+\end{DUadmonition}
+\end{DUclass}
 
 
 \subsubsection{2.14.5   Topics, Sidebars, and Rubrics%
@@ -1196,7 +1206,7 @@
 \emph{Sidebars} are like miniature, parallel documents.
 
 \DUsidebar{
-\DUtitlesidebar{Optional Sidebar Title}
+\DUtitle{Optional Sidebar Title}
 
 \DUsubtitle{Optional Subtitle}
 
@@ -1214,7 +1224,7 @@
 
 \begin{DUclass}{topic}
 \begin{quote}
-\DUtitletopic{Topic Title}
+\DUtitle{Topic Title}
 
 This is a topic.
 \end{quote}
@@ -1256,10 +1266,6 @@
 \DUfootnotetext{footnote-11}{footnote-reference-19}{10}{%
 \url{https://docutils.sourceforge.io/docs/ref/rst/directives.html\#metadata}
 }
-%
-\DUfootnotetext{footnote-12}{footnote-reference-20}{11}{%
-\url{A:DOS\\path\\}
-}
 
 
 \subsubsection{2.14.7   Replacement Text%
@@ -1338,7 +1344,6 @@
 \begin{DUclass}{compound}
 Compound 7, tests the inclusion of various block-level
 elements in one logical paragraph. First a table,
-
 \setlength{\DUtablewidth}{\linewidth}%
 \begin{longtable*}{|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|}
 \hline
@@ -1396,12 +1401,13 @@
 a paragraph followed by a comment,
 % this is a comment
 a paragraph, a
-
-\DUadmonitionnote{
-\DUtitlenote{Note}
+\begin{DUclass}{note}
+\begin{DUadmonition}
+\DUtitle{Note}
 
 with content
-}
+\end{DUadmonition}
+\end{DUclass}
 and the final paragraph of the compound 7.
 \end{DUclass}
 
@@ -1589,7 +1595,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.24\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1657,7 +1663,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.68\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1717,7 +1723,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.49\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 \textbf{%
@@ -1828,7 +1834,6 @@
 %
 \begin{equation*}
 \mathbf{M} = \left(\begin{matrix}a&b\\c&d\end{matrix}\right)
-\phantomsection
 \label{eq-m}
 \end{equation*}
 is $|\mathbf{M}| = ad - bc$.
@@ -1849,7 +1854,6 @@
 %
 \begin{equation*}
 i\hbar \frac{\partial }{\partial t}\Psi  = \hat{H}\Psi ,
-\phantomsection
 \label{eq-schrodinger}
 \end{equation*}
 with the \emph{wave function} $\Psi $, describes how the quantum state of a
@@ -1857,7 +1861,7 @@
 
 \begin{description}
 \item{Math-Accents:} \leavevmode
-\setlength{\DUtablewidth}{\linewidth}%
+\setlength{\DUtablewidth}{1.000\linewidth}%
 \begin{longtable*}{p{0.315\DUtablewidth}p{0.315\DUtablewidth}p{0.315\DUtablewidth}}
 
 $\acute{a}$      \texttt{\textbackslash{}acute\{a\}}
@@ -1912,21 +1916,12 @@
 s_{\mathrm{out}}(x) & = s_{\mathrm{in}}(x') * s_\delta (x-x') \\
                     & = \int  s_{\mathrm{in}}(x')s_\delta (x-x')\mathrm{d}x'
 \end{align*}
-Cases (“manually”, with \texttt{matrix} environment):
-%
-\begin{equation*}
-\mathrm{sgn}(x) = \left\{\begin{matrix}
-                    -1 & x<0\\
-                    1 & x>0
-                  \end{matrix}\right.
-\end{equation*}
-Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment (not (yet) supported by
-HTML writers with \texttt{-{}-math-output=MathML}):
+Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment:
 %
 \begin{equation*}
 \mathrm{sgn}(x) = \begin{cases}
-                    -1 & x<0\\
-                     1 & x>0
+                             -1 & x<0\\
+                    \phantom{-} 1 & x>0
                   \end{cases}
 \end{equation*}
 
@@ -1935,7 +1930,8 @@
 }
 
 Test syntax elements which may cause trouble for the LaTeX writer but might
-not need to be tested with other writers (e.g. the HTML writer).
+not need to be tested with other writers. See also the
+“latex\_cornercases” test.
 
 
 \subsection{3.1   Custom Roles in LaTeX%
@@ -2081,786 +2077,7 @@
 \item Tel.: 0123/456789
 \end{DUlineblock}
 
-
-\subsection{3.3   More Tables%
-  \label{more-tables}%
-}
-
-A table with multi-paragraph multicolumn cells:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.133\DUtablewidth}|p{0.179\DUtablewidth}|p{0.179\DUtablewidth}|p{0.110\DUtablewidth}|p{0.121\DUtablewidth}|p{0.145\DUtablewidth}|}
-\hline
-
-test
- & 
-\textbf{bold hd}
- & \multicolumn{3}{p{0.41\DUtablewidth}|}{%
-multicolumn 1
-
-With a second paragraph
-} & 
-\emph{emph hd}
- \\
-\hline
-\multicolumn{2}{|p{0.31\DUtablewidth}|}{%
-multicolumn 2
-
-With a second paragraph
-} & 
-cell
- & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & \multicolumn{2}{p{0.36\DUtablewidth}|}{%
-multicolumn 3 (one line,
-but very very very very
-very looooong)
-} & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & 
-cell
- & 
-cell
- & \multicolumn{3}{p{0.38\DUtablewidth}|}{%
-Short multicolumn 4
-} \\
-\hline
-\end{longtable*}
-
-Tables with multi-paragraph multirow cells currently fail due to a LaTeX
-limitation (see \url{https://sourceforge.net/p/docutils/bugs/225/}).
-
-A table with multirow header and column-widths set by LaTeX:
-
-\begin{longtable*}{|l|l|}
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endfirsthead
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
-\endfoot
-\endlastfoot
-\multicolumn{2}{|l|}{multicollumn cell} \\
-\hline
-\end{longtable*}
-
-In a table with column-widths set by LaTeX, each cell has just one line.
-Paragraphs are merged (a warning is given).
-
-\begin{longtable*}{|l|l|}
-\hline
-11 & first paragraph
-second paragraph
-third paragraph \\
-\hline
-21 & 22 \\
-\hline
-\end{longtable*}
-
-% This file is used by the standalone_rst_latex test.
-
-
-\subsection{3.4   Option lists%
-  \label{option-lists-1}%
-}
-
-The LaTeX-2e description environment is used for definition lists.
-The definition is continued on the same line as the term, this should
-not happen if a option-list is at the top of the definition.
-
-If the option list is not at the first element in the definition, it
-is contained in a quote
-
-\begin{quote}
-\begin{DUoptionlist}
-\item-{}-help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-\end{quote}
-
-\begin{description}
-\item{In a definition list:} \leavevmode
-\begin{DUoptionlist}
-\item-{}-help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-
-\end{description}
-
-
-\subsection{3.5   Monospaced non-alphanumeric characters%
-  \label{monospaced-non-alphanumeric-characters}%
-}
-
-These are all ASCII characters except a-zA-Z0-9 and space:
-
-\texttt{!!!\textquotedbl{}\textquotedbl{}\textquotedbl{}\#\#\#\$\$\$\%\%\%\&\&\&'{}'{}'((()))***+++,{},{},-{}-{}-...///:::}
-
-\texttt{;;;<{}<{}<===>{}>{}>???@@@{}{}{}\textbackslash{}\textbackslash{}\textbackslash{}{}{}{}\textasciicircum{}\textasciicircum{}\textasciicircum{}\_\_\_`{}`{}`\{\{\{|||\}\}\}\textasciitilde{}\textasciitilde{}\textasciitilde{}}
-
-\texttt{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
-
-The two lines of non-alphanumeric characters should both have the same
-width as the third line.
-
-
-\subsection{3.6   Non-ASCII characters%
-  \label{non-ascii-characters}%
-}
-
-Punctuation and footnote symbols
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.028\DUtablewidth}|p{0.424\DUtablewidth}|}
-\hline
-
-–
- & 
-en-dash
- \\
-\hline
-
-—
- & 
-em-dash
- \\
-\hline
-
-‘
- & 
-single turned comma quotation mark
- \\
-\hline
-
-’
- & 
-single comma quotation mark
- \\
-\hline
-
-‚
- & 
-low single comma quotation mark
- \\
-\hline
-
-“
- & 
-double turned comma quotation mark
- \\
-\hline
-
-”
- & 
-double comma quotation mark
- \\
-\hline
-
-„
- & 
-low double comma quotation mark
- \\
-\hline
-
-†
- & 
-dagger
- \\
-\hline
-
-‡
- & 
-double dagger
- \\
-\hline
-
-\ding{169}
- & 
-black diamond suit
- \\
-\hline
-
-\ding{170}
- & 
-black heart suit
- \\
-\hline
-
-♠
- & 
-black spade suit
- \\
-\hline
-
-♣
- & 
-black club suit
- \\
-\hline
-
-…
- & 
-ellipsis
- \\
-\hline
-
-™
- & 
-trade mark sign
- \\
-\hline
-
-⇔
- & 
-left-right double arrow
- \\
-\hline
-\end{longtable*}
-
-The \DUroletitlereference{Latin-1 extended} Unicode block
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.051\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|}
-\hline
-
-% 
- & 
-0
- & 
-1
- & 
-2
- & 
-3
- & 
-4
- & 
-5
- & 
-6
- & 
-7
- & 
-8
- & 
-9
- \\
-\hline
-
-160
- &  & 
-¡
- & 
-¢
- & 
-£
- &  & 
-¥
- & 
-¦
- & 
-§
- & 
-¨
- & 
-©
- \\
-\hline
-
-170
- & 
-ª
- & 
-«
- & 
-¬
- & 
-\-
- & 
-®
- & 
-¯
- & 
-°
- & 
-±
- & 
-²
- & 
-³
- \\
-\hline
-
-180
- & 
-´
- & 
-µ
- & 
-¶
- & 
-·
- & 
-¸
- & 
-¹
- & 
-º
- & 
-»
- & 
-¼
- & 
-½
- \\
-\hline
-
-190
- & 
-¾
- & 
-¿
- & 
-À
- & 
-Á
- & 
-Â
- & 
-Ã
- & 
-Ä
- & 
-Å
- & 
-Æ
- & 
-Ç
- \\
-\hline
-
-200
- & 
-È
- & 
-É
- & 
-Ê
- & 
-Ë
- & 
-Ì
- & 
-Í
- & 
-Î
- & 
-Ï
- & 
-Ð
- & 
-Ñ
- \\
-\hline
-
-210
- & 
-Ò
- & 
-Ó
- & 
-Ô
- & 
-Õ
- & 
-Ö
- & 
-×
- & 
-Ø
- & 
-Ù
- & 
-Ú
- & 
-Û
- \\
-\hline
-
-220
- & 
-Ü
- & 
-Ý
- & 
-Þ
- & 
-ß
- & 
-à
- & 
-á
- & 
-â
- & 
-ã
- & 
-ä
- & 
-å
- \\
-\hline
-
-230
- & 
-æ
- & 
-ç
- & 
-è
- & 
-é
- & 
-ê
- & 
-ë
- & 
-ì
- & 
-í
- & 
-î
- & 
-ï
- \\
-\hline
-
-240
- & 
-ð
- & 
-ñ
- & 
-ò
- & 
-ó
- & 
-ô
- & 
-õ
- & 
-ö
- & 
-÷
- & 
-ø
- & 
-ù
- \\
-\hline
-
-250
- & 
-ú
- & 
-û
- & 
-ü
- & 
-ý
- & 
-þ
- & 
-ÿ
- &  &  &  &  \\
-\hline
-\end{longtable*}
-
-\begin{itemize}
-\item The following line should not be wrapped, because it uses
-no-break spaces (\textbackslash{}u00a0):
-
-X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
-
-\item Line wrapping with/without breakpoints marked by soft hyphens
-(\textbackslash{}u00ad):
-
-pdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-sch
-
-pdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrisch
-\end{itemize}
-
-
-\subsection{3.7   Encoding special chars%
-  \label{encoding-special-chars}%
-}
-
-The LaTeX Info pages lists under “2.18 Special Characters”
-
-\begin{quote}
-The following characters play a special role in LaTeX and are called
-“special printing characters”, or simply “special characters”.
-
-\begin{quote}
-\# \$ \% \& \textasciitilde{} \_ \textasciicircum{} \textbackslash{} \{ \}
-\end{quote}
-\end{quote}
-
-The special chars verbatim:
-
-\begin{quote}
-\begin{alltt}
-# $ % & ~ _ ^ \textbackslash{} \{ \}
-\end{alltt}
-\end{quote}
-
-However also \emph{square brackets} {}{} need special care.
-
-\begin{quote}
-Commands with optional arguments (e.g. \texttt{\textbackslash{}item}) check
-if the token right after the macro name is an opening bracket.
-In that case the contents between that bracket and the following
-closing bracket on the same grouping level are taken as the
-optional argument. What makes this unintuitive is the fact that
-the square brackets aren’t grouping characters themselves, so in
-your last example \texttt{\textbackslash{}item{}{}...{}{}} the optional argument consists of
-{}… (without the closing bracket).
-\end{quote}
-
-Compare the items in the following lists:
-
-\begin{itemize}
-\item simple item
-
-\item {}bracketed{} item
-\end{itemize}
-
-\begin{description}
-\item{simple} 
-description term
-
-\item{{}bracketed{}} 
-description term
-
-\end{description}
-
-The OT1 font-encoding has different characters for the less-than,
-greater-than and bar, < | >, except for typewriter font \DUroletitlereference{cmtt}:
-
-\begin{quote}
-\begin{alltt}
-< | >
-\end{alltt}
-\end{quote}
-
-
-\subsection{3.8   Hyperlinks and -targets%
-  \label{hyperlinks-and-targets}%
-}
-
-In LaTeX, we must set an explicit anchor (\texttt{\textbackslash{}phantomsection}) for a
-%
-\phantomsection\label{hypertarget-in-plain-text}hypertarget in plain text or in a figure but not in a longtable or
-caption:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\caption{Table with %
-\label{hypertarget-in-table-title}hypertarget in table title.}\\
-\hline
-
-False
- & 
-True
- & 
-None
- \\
-\hline
-\end{longtable}
-\label{table-label}
-
-\begin{figure}
-\phantomsection\label{figure-label}
-\noindent\makebox\linewidthc{\includegraphics{../../../docs/user/rst/images/biohazard.png}}
-\caption{Figure with %
-\label{hypertarget-in-figure-caption}hypertarget in figure caption.}
-\begin{DUlegend}
-Legend with %
-\phantomsection\label{hypertarget-in-figure-legend}hypertarget in figure legend.
-\end{DUlegend}
-\end{figure}
-
-\includegraphics{../../../docs/user/rst/images/biohazard.png}
-\phantomsection\label{image-label}
-
-See \hyperrefhypertarget-in-plain-text{hypertarget in plain text},
-\hyperreftable-label{table label}, \hyperrefhypertarget-in-table-title{hypertarget in table title},
-\hyperreffigure-label{figure label}, \hyperrefhypertarget-in-figure-caption{hypertarget in figure caption},
-\hyperrefhypertarget-in-figure-legend{hypertarget in figure legend}, and
-\hyperrefimage-label{image label}.
-
-
-\subsection{3.9   External references%
-  \label{external-references}%
-}
-
-Long URLs should be wrapped in the PDF. This can be achieved with the
-\texttt{\textbackslash{}url} command which is used by the LaTeX writer whenever the content
-(name) of a reference node equals the link URL.
-
-\begin{description}
-\item{Example:} 
-a long URL that should wrap in the output
-\url{http://docutils.sourceforge.net/docs/user/latex.html\#id79}
-
-\end{description}
-
-If the argument contains any “\%”, “\#”, or “\textasciicircum{}\textasciicircum{}”, or ends with \texttt{\textbackslash{}}, it can’t
-be used in the argument to another command. The argument must not contain
-unbalanced braces.
-
-The characters \textasciicircum{}, \{, \}, and \texttt{\textbackslash{}} are invalid in a “http:” or “ftp:” URL
-and not recognized as part of it:
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.example.org}/strange\textasciicircum{}\textasciicircum{}name
-\item \url{http://www.example.org}\textbackslash{}using\textbackslash{}DOS\textbackslash{}paths\textbackslash{}
-\item \url{http://www.example.org/XML}/strange\{n\}ame
-\end{DUlineblock}
-
-They can, however be used in paths and/or filenames.
-
-Handling by the LaTeX writer:
-
-\begin{itemize}
-\item \texttt{\#}, \texttt{\textbackslash{}} and \texttt{\%} are escaped:
-
-\begin{DUlineblock}{0em}
-\item \href{http://www.w3.org/XML/Schema\#dev}{URL with \#}
-\url{http://www.w3.org/XML/Schema\#dev}
-\item \href{http://www.w3.org/XML/Schema\%dev}{URL with \%}
-\url{http://example.org/Schema\%dev}
-\item \href{A:DOS\\path\\}{file with DOS path}\DUfootnotemark{footnote-reference-20}{footnote-12}{11} \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-21}{footnote-12}{11}
-\end{DUlineblock}
-
-\DUadmonitionnote{
-\DUtitlenote{Note}
-
-These URLs are typeset inside a LaTeX command without error.
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.w3.org/XML/Schema\#dev}
-\item \url{http://example.org/Schema\%dev}
-\item \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-22}{footnote-12}{11}
-\end{DUlineblock}
-}
-\end{itemize}
-
-\begin{itemize}
-\item \texttt{\textasciicircum{}\textasciicircum{}} LaTeX’s special syntax for characters results in “strange” replacements
-(both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}). A warning is given.
-
-\href{../strange^^name}{file with \textasciicircum{}\textasciicircum{}}:
-\url{../strange^^name}
-
-\item Unbalanced braces, \{ or \}, will fail (both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}):
-
-\begin{quote}
-\begin{alltt}
-`file with \{ <../strange\{name>`__
-`<../strange\{name>`__
-\end{alltt}
-\end{quote}
-
-while balanced braces are suported:
-
-\begin{DUlineblock}{0em}
-\item \url{../strange{n}ame}
-\item \url{../st{r}ange{n}ame}
-\item \url{../{st{r}ange{n}ame}}
-\end{DUlineblock}
-\end{itemize}
-
-
-\subsection{3.10   Section titles with \hyperrefinline-markup{inline markup}%
-  \label{section-titles-with-inline-markup}%
-}
-
-
-\subsubsection{3.10.1   \emph{emphasized}, H\textsubscript{2}O and $x^2$%
-  \label{emphasized-h2o-and-x-2}%
-}
-
-
-\subsubsection{3.10.2   Substitutions work%
-  \label{substitutions-fail}%
-}
-
-
-\subsection{3.11   Deeply nested sections%
-  \label{deeply-nested-sections}%
-}
-
-In LaTeX and HTML,
-
-
-\subsubsection{3.11.1   Level 3%
-  \label{level-3}%
-}
-
-nested sections
-
-
-\paragraph{3.11.1.1   level 4%
-  \label{level-4}%
-}
-
-reach at some level
-
-
-\subparagraph{3.11.1.1.1   level 5%
-  \label{level-5}%
-}
-
-(depending on the document class)
-
-
-\DUtitlesectionVI{3.11.1.1.1.1   level 6%
-  \label{level-6}%
-}
-
-an unsupported level.
-
-% unusual combinations (currently separately tested)
-% .. include:: data/latex_cornercases.txt
-
-% Preface for System Messages:
+% preface for System Messages:
 
 
 \section{4   Error Handling%
@@ -2878,54 +2095,64 @@
 \sectionDocutils System Messages{\color{red}Docutils System Messages%
 }
 
-\DUadmonitionsystem-message{
-\DUtitlesystem-message{system-message
+\begin{DUclass}{system-message}
+\begin{DUadmonition}
+\DUtitle{system-message
 \raisebox{1em}{\hypertarget{system-message-1}{}}}
 
 {\color{red}ERROR/3} in \texttt{functional/input/data/standard.txt}, line~99
 
 \hyperlink{problematic-1}{
 Undefined substitution referenced: \textquotedbl{}problematic\textquotedbl{}.
-}}
+}\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionsystem-message{
-\DUtitlesystem-message{system-message
+\begin{DUclass}{system-message}
+\begin{DUadmonition}
+\DUtitle{system-message
 \raisebox{1em}{\hypertarget{system-message-2}{}}}
 
 {\color{red}ERROR/3} in \texttt{functional/input/data/standard.txt}, line~387
 
 \hyperlink{footnote-reference-8}{
 Unknown target name: \textquotedbl{}5\textquotedbl{}.
-}}
+}\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionsystem-message{
-\DUtitlesystem-message{system-message
+\begin{DUclass}{system-message}
+\begin{DUadmonition}
+\DUtitle{system-message
 \raisebox{1em}{\hypertarget{system-message-3}{}}}
 
 {\color{red}ERROR/3} in \texttt{functional/input/data/standard.txt}, line~396
 
 \hyperlink{citation-reference-3}{
 Unknown target name: \textquotedbl{}nonexistent\textquotedbl{}.
-}}
+}\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionsystem-message{
-\DUtitlesystem-message{system-message
+\begin{DUclass}{system-message}
+\begin{DUadmonition}
+\DUtitle{system-message
 \raisebox{1em}{\hypertarget{system-message-4}{}}}
 
 {\color{red}ERROR/3} in \texttt{functional/input/data/standard.txt}, line~423
 
 \hyperlink{problematic-2}{
 Unknown target name: \textquotedbl{}hyperlink reference without a target\textquotedbl{}.
-}}
+}\end{DUadmonition}
+\end{DUclass}
 
-\DUadmonitionsystem-message{
-\DUtitlesystem-message{system-message
+\begin{DUclass}{system-message}
+\begin{DUadmonition}
+\DUtitle{system-message
 \raisebox{1em}{\hypertarget{system-message-5}{}}}
 
 {\color{red}ERROR/3} in \texttt{functional/input/data/standard.txt}, line~436
 
 \hyperlink{problematic-3}{
 Duplicate target name, cannot be used as a unique reference: \textquotedbl{}duplicate target names\textquotedbl{}.
-}}
+}\end{DUadmonition}
+\end{DUclass}
 
 \end{document}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_pseudoxml.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_pseudoxml.txt Changed

@@ -3,6 +3,8 @@
         reStructuredText Test Document
     <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">
         Examples of Syntax Constructs
+    <meta content="reStructuredText, test, parser" name="keywords">
+    <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
     <decoration>
         <header>
             <paragraph>
@@ -503,11 +505,11 @@
                         Title Reference
                     .  Here are
                     some explicit interpreted text roles: a PEP reference (
-                    <reference refuri="http://www.python.org/dev/peps/pep-0287">
+                    <reference refuri="https://peps.python.org/pep-0287">
                         PEP 287
                     ); an
                     RFC reference (
-                    <reference refuri="http://tools.ietf.org/html/rfc2822.html">
+                    <reference refuri="https://tools.ietf.org/html/rfc2822.html">
                         RFC 2822
                     ); an abbreviation (
                     <abbreviation>
@@ -1995,8 +1997,6 @@
                         9
                      is used to specify metadata to be stored in,
                     e.g., HTML META tags or ODT file properties.
-                <meta content="reStructuredText, test, parser" name="keywords">
-                <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
                 <target anonymous="1" ids="target-6" refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">
         <section ids="substitution-definitions" names="substitution\ definitions">
             <title auto="1" refid="toc-entry-34">

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_s5_html_1.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_s5_html_1.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_s5_html_2.html -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_s5_html_2.html Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/standalone_rst_xetex.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/standalone_rst_xetex.tex Changed

@@ -1,5 +1,5 @@
 \documentclassa4paper{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 % rubber: set program xelatex
 \usepackage{fontspec}
 % \defaultfontfeatures{Scale=MatchLowercase}
@@ -39,6 +39,14 @@
 
 \DUprovidelength{\pdfpxdimen}{1bp}
 
+
+\providecommand*{\DUCLASScontents}{%
+  \renewenvironment{itemize}%
+    {\begin{list}{}{\setlength{\partopsep}{0pt}
+                    \setlength{\parsep}{0pt}}
+                   }%
+    {\end{list}}%
+}
 % hyperlinks:
 \ifthenelse{\isundefined{\hypersetup}}{
   \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue{hyperref}
@@ -47,6 +55,8 @@
 }{}
 \hypersetup{
   pdftitle={reStructuredText Test Document},
+  pdfkeywords={reStructuredText, test, parser},
+  pdfinfo={description={A test document, containing at least one example of each reStructuredText construct.}},
   pdfauthor={David Goodger;Me;Myself;I}
 }
 
@@ -140,8 +150,133 @@
 
 \phantomsection\label{table-of-contents}
 \pdfbookmark1{Table of Contents}{table-of-contents}
-\renewcommand{\contentsname}{Table of Contents}
-\tableofcontents
+
+\begin{DUclass}{contents}
+
+\DUtitle{Table of Contents}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefstructural-elements{1   Structural Elements}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefsection-title{1.1   Section Title}
+
+\item \hyperrefempty-section{1.2   Empty Section}
+
+\item \hyperreftransitions{1.3   Transitions}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperrefbody-elements{2   Body Elements}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefparagraphs{2.1   Paragraphs}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefinline-markup{2.1.1   Inline Markup}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperrefbullet-lists{2.2   Bullet Lists}
+
+\item \hyperrefenumerated-lists{2.3   Enumerated Lists}
+
+\item \hyperrefdefinition-lists{2.4   Definition Lists}
+
+\item \hyperreffield-lists{2.5   Field Lists}
+
+\item \hyperrefoption-lists{2.6   Option Lists}
+
+\item \hyperrefliteral-blocks{2.7   Literal Blocks}
+
+\item \hyperrefline-blocks{2.8   Line Blocks}
+
+\item \hyperrefblock-quotes{2.9   Block Quotes}
+
+\item \hyperrefdoctest-blocks{2.10   Doctest Blocks}
+
+\item \hyperreffootnotes{2.11   Footnotes}
+
+\item \hyperrefcitations{2.12   Citations}
+
+\item \hyperreftargets{2.13   Targets}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefduplicate-target-names{2.13.1   Duplicate Target Names}
+
+\item \hyperrefduplicate-target-names-1{2.13.2   Duplicate Target Names}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperrefdirectives{2.14   Directives}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefdocument-parts{2.14.1   Document Parts}
+
+\item \hyperrefimages-and-figures{2.14.2   Images and Figures}
+
+\item \hyperreftables{2.14.3   Tables}
+
+\item \hyperrefadmonitions{2.14.4   Admonitions}
+
+\item \hyperreftopics-sidebars-and-rubrics{2.14.5   Topics, Sidebars, and Rubrics}
+
+\item \hyperreftarget-footnotes{2.14.6   Target Footnotes}
+
+\item \hyperrefreplacement-text{2.14.7   Replacement Text}
+
+\item \hyperrefcompound-paragraph{2.14.8   Compound Paragraph}
+
+\item \hyperrefparsed-literal-blocks{2.14.9   Parsed Literal Blocks}
+
+\item \hyperrefcode{2.14.10   Code}
+
+\item \hyperrefmeta{2.14.11   Meta}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperrefsubstitution-definitions{2.15   Substitution Definitions}
+
+\item \hyperrefcomments{2.16   Comments}
+
+\item \hyperrefraw-text{2.17   Raw text}
+
+\item \hyperrefcontainer{2.18   Container}
+
+\item \hyperrefcolspanning-tables{2.19   Colspanning tables}
+
+\item \hyperrefrowspanning-tables{2.20   Rowspanning tables}
+
+\item \hyperreflist-tables{2.21   List Tables}
+
+\item \hyperrefcustom-roles{2.22   Custom Roles}
+
+\item \hyperrefmathematics{2.23   Mathematics}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperreftests-for-the-latex-writer{3   Tests for the LaTeX writer}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefcustom-roles-in-latex{3.1   Custom Roles in LaTeX}
+
+\item \hyperrefclass-handling{3.2   class handling}
+\end{itemize}
+\end{DUclass}
+
+\item \hyperreftests-for-the-xetex-writer{4   Tests for the XeTeX writer}
+
+\item \hyperreferror-handling{5   Error Handling}
+\end{itemize}
+\end{DUclass}
+\end{DUclass}
 
 
 \section{1   Structural Elements%
@@ -212,8 +347,8 @@
 reference to the \hyperrefdoctitle{doctitle} and the \hyperrefsubtitle{subtitle}.
 
 The default role for interpreted text is \DUroletitlereference{Title Reference}.  Here are
-some explicit interpreted text roles: a PEP reference (\href{http://www.python.org/dev/peps/pep-0287}{PEP 287}); an
-RFC reference (\href{http://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
+some explicit interpreted text roles: a PEP reference (\href{https://peps.python.org/pep-0287}{PEP 287}); an
+RFC reference (\href{https://tools.ietf.org/html/rfc2822.html}{RFC 2822}); an abbreviation (\DUrole{abbreviation}{abb.}), an acronym
 (\DUrole{acronym}{reST}), code (\texttt{\DUrole{code}{print \textquotedbl{}hello world\textquotedbl{}}}); a \textsubscript{subscript};
 a \textsuperscript{superscript} and explicit roles for \DUroletitlereference{Docutils}’
 \emph{standard} \textbf{inline} \texttt{markup}.
@@ -672,6 +807,38 @@
 }
 
 \phantomsection\label{contents}
+
+\begin{DUclass}{contents}
+\begin{DUclass}{local}
+
+\begin{DUclass}{auto-toc}
+\begin{itemize}
+\item \hyperrefdocument-parts{2.14.1   Document Parts}
+
+\item \hyperrefimages-and-figures{2.14.2   Images and Figures}
+
+\item \hyperreftables{2.14.3   Tables}
+
+\item \hyperrefadmonitions{2.14.4   Admonitions}
+
+\item \hyperreftopics-sidebars-and-rubrics{2.14.5   Topics, Sidebars, and Rubrics}
+
+\item \hyperreftarget-footnotes{2.14.6   Target Footnotes}
+
+\item \hyperrefreplacement-text{2.14.7   Replacement Text}
+
+\item \hyperrefcompound-paragraph{2.14.8   Compound Paragraph}
+
+\item \hyperrefparsed-literal-blocks{2.14.9   Parsed Literal Blocks}
+
+\item \hyperrefcode{2.14.10   Code}
+
+\item \hyperrefmeta{2.14.11   Meta}
+\end{itemize}
+\end{DUclass}
+\end{DUclass}
+\end{DUclass}
+
 These are just a sample of the many reStructuredText Directives.  For
 others, please see \href{https://docutils.sourceforge.io/docs/ref/rst/directives.html}{reStructuredText Directives}\DUfootnotemark{footnote-reference-19}{footnote-11}{10}.
 
@@ -855,7 +1022,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -892,7 +1059,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -929,7 +1096,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
+\multicolumn{2}{p{0.15\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -959,7 +1126,6 @@
 \textbf{A} & \textbf{B} & \textbf{A or B} \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
 \endfoot
 \endlastfoot
 False & False & False \\
@@ -1139,10 +1305,6 @@
 \DUfootnotetext{footnote-12}{footnote-reference-20}{11}{%
 \url{https://docutils.sourceforge.io/docs/ref/rst/directives.html\#metadata}
 }
-%
-\DUfootnotetext{footnote-13}{footnote-reference-21}{12}{%
-\url{A:DOS\\path\\}
-}
 
 
 \subsubsection{2.14.7   Replacement Text%
@@ -1221,7 +1383,6 @@
 \begin{DUclass}{compound}
 Compound 7, tests the inclusion of various block-level
 elements in one logical paragraph. First a table,
-
 \setlength{\DUtablewidth}{\linewidth}%
 \begin{longtable*}{|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|p{0.249\DUtablewidth}|}
 \hline
@@ -1473,7 +1634,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.24\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1541,7 +1702,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.68\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 
@@ -1601,7 +1762,7 @@
 } \\
 \hline
 \endhead
-\multicolumn{3}{c}{\hfill ... continued on next page} \\
+\multicolumn{3}{p{0.49\DUtablewidth}}{\raggedleft\ldots continued on next page}\\
 \endfoot
 \endlastfoot
 \textbf{%
@@ -1712,7 +1873,6 @@
 %
 \begin{equation*}
 \mathbf{M} = \left(\begin{matrix}a&b\\c&d\end{matrix}\right)
-\phantomsection
 \label{eq-m}
 \end{equation*}
 is $|\mathbf{M}| = ad - bc$.
@@ -1733,7 +1893,6 @@
 %
 \begin{equation*}
 i\hbar \frac{\partial }{\partial t}\Psi  = \hat{H}\Psi ,
-\phantomsection
 \label{eq-schrodinger}
 \end{equation*}
 with the \emph{wave function} $\Psi $, describes how the quantum state of a
@@ -1741,7 +1900,7 @@
 
 \begin{description}
 \item{Math-Accents:} \leavevmode
-\setlength{\DUtablewidth}{\linewidth}%
+\setlength{\DUtablewidth}{1.000\linewidth}%
 \begin{longtable*}{p{0.315\DUtablewidth}p{0.315\DUtablewidth}p{0.315\DUtablewidth}}
 
 $\acute{a}$      \texttt{\textbackslash{}acute\{a\}}
@@ -1796,21 +1955,12 @@
 s_{\mathrm{out}}(x) & = s_{\mathrm{in}}(x') * s_\delta (x-x') \\
                     & = \int  s_{\mathrm{in}}(x')s_\delta (x-x')\mathrm{d}x'
 \end{align*}
-Cases (“manually”, with \texttt{matrix} environment):
-%
-\begin{equation*}
-\mathrm{sgn}(x) = \left\{\begin{matrix}
-                    -1 & x<0\\
-                    1 & x>0
-                  \end{matrix}\right.
-\end{equation*}
-Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment (not (yet) supported by
-HTML writers with \texttt{--math-output=MathML}):
+Cases with the \href{ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf}{AMSmath}\DUfootnotemark{footnote-reference-15}{footnote-8}{7} \texttt{cases} environment:
 %
 \begin{equation*}
 \mathrm{sgn}(x) = \begin{cases}
-                    -1 & x<0\\
-                     1 & x>0
+                             -1 & x<0\\
+                    \phantom{-} 1 & x>0
                   \end{cases}
 \end{equation*}
 
@@ -1819,7 +1969,8 @@
 }
 
 Test syntax elements which may cause trouble for the LaTeX writer but might
-not need to be tested with other writers (e.g. the HTML writer).
+not need to be tested with other writers. See also the
+“latex\_cornercases” test.
 
 
 \subsection{3.1   Custom Roles in LaTeX%
@@ -1965,785 +2116,7 @@
 \item Tel.: 0123/456789
 \end{DUlineblock}
 
-
-\subsection{3.3   More Tables%
-  \label{more-tables}%
-}
-
-A table with multi-paragraph multicolumn cells:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.133\DUtablewidth}|p{0.179\DUtablewidth}|p{0.179\DUtablewidth}|p{0.110\DUtablewidth}|p{0.121\DUtablewidth}|p{0.145\DUtablewidth}|}
-\hline
-
-test
- & 
-\textbf{bold hd}
- & \multicolumn{3}{p{0.41\DUtablewidth}|}{%
-multicolumn 1
-
-With a second paragraph
-} & 
-\emph{emph hd}
- \\
-\hline
-\multicolumn{2}{|p{0.31\DUtablewidth}|}{%
-multicolumn 2
-
-With a second paragraph
-} & 
-cell
- & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & \multicolumn{2}{p{0.36\DUtablewidth}|}{%
-multicolumn 3 (one line,
-but very very very very
-very looooong)
-} & 
-cell
- & 
-cell
- & 
-cell
- \\
-\hline
-
-cell
- & 
-cell
- & 
-cell
- & \multicolumn{3}{p{0.38\DUtablewidth}|}{%
-Short multicolumn 4
-} \\
-\hline
-\end{longtable*}
-
-Tables with multi-paragraph multirow cells currently fail due to a LaTeX
-limitation (see \url{https://sourceforge.net/p/docutils/bugs/225/}).
-
-A table with multirow header and column-widths set by LaTeX:
-
-\begin{longtable*}{|l|l|}
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endfirsthead
-\hline
-\multirow{2}{*}{\textbf{XXX}} & \textbf{Variable Summary} \\
-\cline{2-2}
- & \textbf{Description} \\
-\hline
-\endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
-\endfoot
-\endlastfoot
-\multicolumn{2}{|l|}{multicollumn cell} \\
-\hline
-\end{longtable*}
-
-In a table with column-widths set by LaTeX, each cell has just one line.
-Paragraphs are merged (a warning is given).
-
-\begin{longtable*}{|l|l|}
-\hline
-11 & first paragraph
-second paragraph
-third paragraph \\
-\hline
-21 & 22 \\
-\hline
-\end{longtable*}
-
-% This file is used by the standalone_rst_latex test.
-
-
-\subsection{3.4   Option lists%
-  \label{option-lists-1}%
-}
-
-The LaTeX-2e description environment is used for definition lists.
-The definition is continued on the same line as the term, this should
-not happen if a option-list is at the top of the definition.
-
-If the option list is not at the first element in the definition, it
-is contained in a quote
-
-\begin{quote}
-\begin{DUoptionlist}
-\item--help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-\end{quote}
-
-\begin{description}
-\item{In a definition list:} \leavevmode
-\begin{DUoptionlist}
-\item--help  show help
-
-\item-v  verbose
-\end{DUoptionlist}
-
-\end{description}
-
-
-\subsection{3.5   Monospaced non-alphanumeric characters%
-  \label{monospaced-non-alphanumeric-characters}%
-}
-
-These are all ASCII characters except a-zA-Z0-9 and space:
-
-\texttt{!!!\textquotedbl{}\textquotedbl{}\textquotedbl{}\#\#\#\$\$\$\%\%\%\&\&\&'''((()))***+++,,,---...///:::}
-
-\texttt{;;;<<<===>>>???@@@{}{}{}\textbackslash{}\textbackslash{}\textbackslash{}{}{}{}\textasciicircum{}\textasciicircum{}\textasciicircum{}\_\_\_```\{\{\{|||\}\}\}\textasciitilde{}\textasciitilde{}\textasciitilde{}}
-
-\texttt{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
-
-The two lines of non-alphanumeric characters should both have the same
-width as the third line.
-
-
-\subsection{3.6   Non-ASCII characters%
-  \label{non-ascii-characters}%
-}
-
-Punctuation and footnote symbols
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.028\DUtablewidth}|p{0.424\DUtablewidth}|}
-\hline
-
-–
- & 
-en-dash
- \\
-\hline
-
-—
- & 
-em-dash
- \\
-\hline
-
-‘
- & 
-single turned comma quotation mark
- \\
-\hline
-
-’
- & 
-single comma quotation mark
- \\
-\hline
-
-‚
- & 
-low single comma quotation mark
- \\
-\hline
-
-“
- & 
-double turned comma quotation mark
- \\
-\hline
-
-”
- & 
-double comma quotation mark
- \\
-\hline
-
-„
- & 
-low double comma quotation mark
- \\
-\hline
-
-†
- & 
-dagger
- \\
-\hline
-
-‡
- & 
-double dagger
- \\
-\hline
-
-♦
- & 
-black diamond suit
- \\
-\hline
-
-♥
- & 
-black heart suit
- \\
-\hline
-
-♠
- & 
-black spade suit
- \\
-\hline
-
-♣
- & 
-black club suit
- \\
-\hline
-
-…
- & 
-ellipsis
- \\
-\hline
-
-™
- & 
-trade mark sign
- \\
-\hline
-
-⇔
- & 
-left-right double arrow
- \\
-\hline
-\end{longtable*}
-
-The \DUroletitlereference{Latin-1 extended} Unicode block
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.051\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|p{0.028\DUtablewidth}|}
-\hline
-
 % 
- & 
-0
- & 
-1
- & 
-2
- & 
-3
- & 
-4
- & 
-5
- & 
-6
- & 
-7
- & 
-8
- & 
-9
- \\
-\hline
-
-160
- &  & 
-¡
- & 
-¢
- & 
-£
- &  & 
-¥
- & 
-¦
- & 
-§
- & 
-¨
- & 
-©
- \\
-\hline
-
-170
- & 
-ª
- & 
-«
- & 
-¬
- & 
-\-
- & 
-®
- & 
-¯
- & 
-°
- & 
-±
- & 
-²
- & 
-³
- \\
-\hline
-
-180
- & 
-´
- & 
-µ
- & 
-¶
- & 
-·
- & 
-¸
- & 
-¹
- & 
-º
- & 
-»
- & 
-¼
- & 
-½
- \\
-\hline
-
-190
- & 
-¾
- & 
-¿
- & 
-À
- & 
-Á
- & 
-Â
- & 
-Ã
- & 
-Ä
- & 
-Å
- & 
-Æ
- & 
-Ç
- \\
-\hline
-
-200
- & 
-È
- & 
-É
- & 
-Ê
- & 
-Ë
- & 
-Ì
- & 
-Í
- & 
-Î
- & 
-Ï
- & 
-Ð
- & 
-Ñ
- \\
-\hline
-
-210
- & 
-Ò
- & 
-Ó
- & 
-Ô
- & 
-Õ
- & 
-Ö
- & 
-×
- & 
-Ø
- & 
-Ù
- & 
-Ú
- & 
-Û
- \\
-\hline
-
-220
- & 
-Ü
- & 
-Ý
- & 
-Þ
- & 
-ß
- & 
-à
- & 
-á
- & 
-â
- & 
-ã
- & 
-ä
- & 
-å
- \\
-\hline
-
-230
- & 
-æ
- & 
-ç
- & 
-è
- & 
-é
- & 
-ê
- & 
-ë
- & 
-ì
- & 
-í
- & 
-î
- & 
-ï
- \\
-\hline
-
-240
- & 
-ð
- & 
-ñ
- & 
-ò
- & 
-ó
- & 
-ô
- & 
-õ
- & 
-ö
- & 
-÷
- & 
-ø
- & 
-ù
- \\
-\hline
-
-250
- & 
-ú
- & 
-û
- & 
-ü
- & 
-ý
- & 
-þ
- & 
-ÿ
- &  &  &  &  \\
-\hline
-\end{longtable*}
-
-\begin{itemize}
-\item The following line should not be wrapped, because it uses
-no-break spaces (\textbackslash{}u00a0):
-
-X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
-
-\item Line wrapping with/without breakpoints marked by soft hyphens
-(\textbackslash{}u00ad):
-
-pdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-schpdn\-derd\-mdtd\-ri\-sch
-
-pdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrischpdnderdmdtdrisch
-\end{itemize}
-
-
-\subsection{3.7   Encoding special chars%
-  \label{encoding-special-chars}%
-}
-
-The LaTeX Info pages lists under “2.18 Special Characters”
-
-\begin{quote}
-The following characters play a special role in LaTeX and are called
-“special printing characters”, or simply “special characters”.
-
-\begin{quote}
-\# \$ \% \& \textasciitilde{} \_ \textasciicircum{} \textbackslash{} \{ \}
-\end{quote}
-\end{quote}
-
-The special chars verbatim:
-
-\begin{quote}
-\begin{alltt}
-# $ % & ~ _ ^ \textbackslash{} \{ \}
-\end{alltt}
-\end{quote}
-
-However also \emph{square brackets} {}{} need special care.
-
-\begin{quote}
-Commands with optional arguments (e.g. \texttt{\textbackslash{}item}) check
-if the token right after the macro name is an opening bracket.
-In that case the contents between that bracket and the following
-closing bracket on the same grouping level are taken as the
-optional argument. What makes this unintuitive is the fact that
-the square brackets aren’t grouping characters themselves, so in
-your last example \texttt{\textbackslash{}item{}{}...{}{}} the optional argument consists of
-{}… (without the closing bracket).
-\end{quote}
-
-Compare the items in the following lists:
-
-\begin{itemize}
-\item simple item
-
-\item {}bracketed{} item
-\end{itemize}
-
-\begin{description}
-\item{simple} 
-description term
-
-\item{{}bracketed{}} 
-description term
-
-\end{description}
-
-The OT1 font-encoding has different characters for the less-than,
-greater-than and bar, < | >, except for typewriter font \DUroletitlereference{cmtt}:
-
-\begin{quote}
-\begin{alltt}
-< | >
-\end{alltt}
-\end{quote}
-
-
-\subsection{3.8   Hyperlinks and -targets%
-  \label{hyperlinks-and-targets}%
-}
-
-In LaTeX, we must set an explicit anchor (\texttt{\textbackslash{}phantomsection}) for a
-%
-\phantomsection\label{hypertarget-in-plain-text}hypertarget in plain text or in a figure but not in a longtable or
-caption:
-
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\caption{Table with %
-\label{hypertarget-in-table-title}hypertarget in table title.}\\
-\hline
-
-False
- & 
-True
- & 
-None
- \\
-\hline
-\end{longtable}
-\label{table-label}
-
-\begin{figure}
-\phantomsection\label{figure-label}
-\noindent\makebox\linewidthc{\includegraphics{../../../docs/user/rst/images/biohazard.png}}
-\caption{Figure with %
-\label{hypertarget-in-figure-caption}hypertarget in figure caption.}
-\begin{DUlegend}
-Legend with %
-\phantomsection\label{hypertarget-in-figure-legend}hypertarget in figure legend.
-\end{DUlegend}
-\end{figure}
-
-\includegraphics{../../../docs/user/rst/images/biohazard.png}
-\phantomsection\label{image-label}
-
-See \hyperrefhypertarget-in-plain-text{hypertarget in plain text},
-\hyperreftable-label{table label}, \hyperrefhypertarget-in-table-title{hypertarget in table title},
-\hyperreffigure-label{figure label}, \hyperrefhypertarget-in-figure-caption{hypertarget in figure caption},
-\hyperrefhypertarget-in-figure-legend{hypertarget in figure legend}, and
-\hyperrefimage-label{image label}.
-
-
-\subsection{3.9   External references%
-  \label{external-references}%
-}
-
-Long URLs should be wrapped in the PDF. This can be achieved with the
-\texttt{\textbackslash{}url} command which is used by the LaTeX writer whenever the content
-(name) of a reference node equals the link URL.
-
-\begin{description}
-\item{Example:} 
-a long URL that should wrap in the output
-\url{http://docutils.sourceforge.net/docs/user/latex.html\#id79}
-
-\end{description}
-
-If the argument contains any “\%”, “\#”, or “\textasciicircum{}\textasciicircum{}”, or ends with \texttt{\textbackslash{}}, it can’t
-be used in the argument to another command. The argument must not contain
-unbalanced braces.
-
-The characters \textasciicircum{}, \{, \}, and \texttt{\textbackslash{}} are invalid in a “http:” or “ftp:” URL
-and not recognized as part of it:
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.example.org}/strange\textasciicircum{}\textasciicircum{}name
-\item \url{http://www.example.org}\textbackslash{}using\textbackslash{}DOS\textbackslash{}paths\textbackslash{}
-\item \url{http://www.example.org/XML}/strange\{n\}ame
-\end{DUlineblock}
-
-They can, however be used in paths and/or filenames.
-
-Handling by the LaTeX writer:
-
-\begin{itemize}
-\item \texttt{\#}, \texttt{\textbackslash{}} and \texttt{\%} are escaped:
-
-\begin{DUlineblock}{0em}
-\item \href{http://www.w3.org/XML/Schema\#dev}{URL with \#}
-\url{http://www.w3.org/XML/Schema\#dev}
-\item \href{http://www.w3.org/XML/Schema\%dev}{URL with \%}
-\url{http://example.org/Schema\%dev}
-\item \href{A:DOS\\path\\}{file with DOS path}\DUfootnotemark{footnote-reference-21}{footnote-13}{12} \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-22}{footnote-13}{12}
-\end{DUlineblock}
-
-\begin{DUclass}{note}
-\begin{DUadmonition}
-\DUtitle{Note}
-
-These URLs are typeset inside a LaTeX command without error.
-
-\begin{DUlineblock}{0em}
-\item \url{http://www.w3.org/XML/Schema\#dev}
-\item \url{http://example.org/Schema\%dev}
-\item \url{A:DOS\\path\\}\DUfootnotemark{footnote-reference-23}{footnote-13}{12}
-\end{DUlineblock}
-\end{DUadmonition}
-\end{DUclass}
-\end{itemize}
-
-\begin{itemize}
-\item \texttt{\textasciicircum{}\textasciicircum{}} LaTeX’s special syntax for characters results in “strange” replacements
-(both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}). A warning is given.
-
-\href{../strange^^name}{file with \textasciicircum{}\textasciicircum{}}:
-\url{../strange^^name}
-
-\item Unbalanced braces, \{ or \}, will fail (both with \texttt{\textbackslash{}href} and \texttt{\textbackslash{}url}):
-
-\begin{quote}
-\begin{alltt}
-`file with \{ <../strange\{name>`__
-`<../strange\{name>`__
-\end{alltt}
-\end{quote}
-
-while balanced braces are suported:
-
-\begin{DUlineblock}{0em}
-\item \url{../strange{n}ame}
-\item \url{../st{r}ange{n}ame}
-\item \url{../{st{r}ange{n}ame}}
-\end{DUlineblock}
-\end{itemize}
-
-
-\subsection{3.10   Section titles with \hyperrefinline-markup{inline markup}%
-  \label{section-titles-with-inline-markup}%
-}
-
-
-\subsubsection{3.10.1   \emph{emphasized}, H\textsubscript{2}O and $x^2$%
-  \label{emphasized-h2o-and-x-2}%
-}
-
-
-\subsubsection{3.10.2   Substitutions work%
-  \label{substitutions-fail}%
-}
-
-
-\subsection{3.11   Deeply nested sections%
-  \label{deeply-nested-sections}%
-}
-
-In LaTeX and HTML,
-
-
-\subsubsection{3.11.1   Level 3%
-  \label{level-3}%
-}
-
-nested sections
-
-
-\paragraph{3.11.1.1   level 4%
-  \label{level-4}%
-}
-
-reach at some level
-
-
-\subparagraph{3.11.1.1.1   level 5%
-  \label{level-5}%
-}
-
-(depending on the document class)
-
-
-\begin{DUclass}{sectionVI}
-\DUtitle{3.11.1.1.1.1   level 6%
-  \label{level-6}%
-}
-\end{DUclass}
-
-an unsupported level.
 
 
 \section{4   Tests for the XeTeX writer%
@@ -2757,10 +2130,10 @@
 Latviešu, Lietuvių, Македонски, Монгол, Nāhuatl, Português, Română,
 Русский, Slovenščina, Српски, Türkçe, Українська, Tiếng Việt, Volapük,
 Võro, ייִדיש , Žemaitėška.
-Currently, there is extended support for 28 languages in the
+There is extended support for more than 40 languages in the
 \href{http://ctan.org/pkg/polyglossia}{polyglossia}\DUfootnotemark{footnote-reference-16}{footnote-9}{8} package.
 
-% System Messages:
+% preface for System Messages:
 
 
 \section{5   Error Handling%

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/default/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/default/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/s5-core.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/default/s5-core.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/default/slides.js -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/default/slides.js Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/framing.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/small-black/framing.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/pretty.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/small-black/pretty.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/s5-core.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/small-black/s5-core.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/ui/small-black/slides.js -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/ui/small-black/slides.js Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/expected/xetex-cyrillic.tex -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/expected/xetex-cyrillic.tex Changed

@@ -1,5 +1,5 @@
 \documentclassa4paper,russian{article}
-% generated by Docutils <http://docutils.sourceforge.net/>
+% generated by Docutils <https://docutils.sourceforge.io/>
 % rubber: set program xelatex
 \usepackage{fontspec}
 % \defaultfontfeatures{Scale=MatchLowercase}
@@ -23,12 +23,9 @@
 %%% User specified packages and stylesheets
 
 %%% Fallback definitions for Docutils-specific commands
-
-% titlereference standard role
-\providecommand*{\DUroletitlereference}1{\textsl{#1}}
 % hyperlinks:
 \ifthenelse{\isundefined{\hypersetup}}{
-  \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue,unicode=false{hyperref}
+  \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue{hyperref}
   \usepackage{bookmark}
   \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
 }{}
@@ -55,18 +52,14 @@
 \foreignlanguage{english}{first example: “Hello world”.}
 
 
-\section{Notes%
-  \label{notes}%
+\section{Примечания%
+  \label{section-2}%
 }
 
-\foreignlanguage{english}{This example tests rendering of Latin and Cyrillic characters by the LaTeX
-and XeTeX writers. Check the compiled PDF for garbage characters in text and
-bookmarks.}
+Этот документ испытивает изображение LaTeXом кириллических букв.
 
-\foreignlanguage{english}{To work around a problem with Cyrillic in PDF-bookmarks in \DUroletitlereference{hyperref}
-versions older than v6.79g 2009/11/20, the test caller \texttt{latex\_cyrillic.py}
-sets \texttt{hyperref\_options} to \texttt{'unicode=true'} while \texttt{xetex\_cyrillic.py}
-sets it to \texttt{'unicode=false'}. The recommended option for current
-(2011-08-24) hyperref versions is \texttt{'pdfencoding=auto'}.}
+\foreignlanguage{english}{This document tests the rendering of Latin and Cyrillic characters by the
+LaTeX and XeTeX writers. Check the compiled PDF for garbage characters in
+text and bookmarks.}
 
 \end{document}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/compact_lists.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/compact_lists.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/cyrillic.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/cyrillic.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/classes_latex.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/classes_latex.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/comprehensive-math-test.txt Added

@@ -0,0 +1,527 @@
+==================================
+Using LaTeX syntax for mathematics
+==================================
+
+.. role:: m(math)
+.. default-role:: math
+.. |latex| replace:: L\ :sup:`A`\ T\ :sub:`E`\ X
+
+.. contents::
+
+
+Introduction
+============
+
+Since version 0.8, Docutils supports mathematical content with a `"math"
+directive`__ and `role`__.
+The input format is *LaTeX math syntax*\ #math-syntax_ with support for
+Unicode symbols.
+
+
+.. #math-syntax The supported LaTeX commands include AMS extensions
+   (see, e.g., the `Short Math Guide`_).
+
+   The support is limited to a subset of *LaTeX math* by the conversion
+   required for many output formats.  For HTML, the `math_output`_
+   configuration setting (or the corresponding ``--math-output`` command
+   line option) select between alternative output formats with different
+   subsets of supported elements. If a writer does not support math
+   typesetting at all, the content is inserted verbatim.
+
+__ https://docutils.sourceforge.io/docs/ref/rst/directives.html#math
+__ https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
+.. _Short Math Guide:
+   http://mirrors.ctan.org/info/short-math-guide/short-math-guide.pdf
+.. _math_output:
+   https://docutils.sourceforge.io/docs/user/config.html#math-output
+
+
+Role and directive
+==================
+
+The ``math`` role can be used for inline mathematical expressions:
+``:math:`\psi(r) = \exp(-2r)``` will produce :m:`\psi(r)=\exp(-2r)`.
+Inside the backtics you can write anything you would write between dollar
+signs in a LaTeX document.
+
+For producing displayed math (like an ``equation*`` environment in a
+LaTeX document) there is a ``math`` directive.  If you write::
+
+  .. math:: \psi(r) = e^{-2r}
+
+you will get:
+
+.. math:: \psi(r) = e^{-2r}
+
+A more complex example is the definition of the Fourier transform
+
+.. math::
+
+    (\mathcal{F}f)(y) =
+        \frac{1}{\sqrt{2\pi}^{\ n}}
+        \int_{\mathbb{R}^n} f(x)\,e^{-\mathrm{i} y \cdot x} \,\mathrm{d} x.
+
+
+.. tip::
+
+  If you put ``.. default-role:: math`` at the top of your
+  document, then you can write ```x^2``` instead of the longer
+  version: ``:math:`x^2```.  You can also introduce an
+  abreviation like this ``.. role:: m(math)``.  That will allow
+  you to write ``:m:`x^2``` or ```x^2`:m:``.
+
+
+Not *all* math syntax constructs work with every output format, but basic
+everyday-math should work.
+
+If a command or a special symbol is not desribed in this document, then
+it is probably not implemented in the internal LaTeX -> MathML converter.
+
+
+Commands
+========
+
+
+.. class:: colwidths-auto
+
+  =====================  ==============================  ============================
+  command                example                         result
+  =====================  ==============================  ============================
+  ``\sqrt``              ``\sqrt{x^2-1}``                `\sqrt{x^2-1}`
+  ``\frac``              ``\frac{1}{2}``                 `\frac{1}{2}`
+  ``\left``, ``\right``  ``\left(\frac{1}{2}\right)^n``  `\left(\frac{1}{2}\right)^n`
+  =====================  ==============================  ============================
+
+
+Environments
+============
+
+Displayed math can use ``\\`` and ``&`` for line shifts and alignments::
+
+  .. math::
+
+     a & = (x + y)^2 \\
+       & = x^2 + 2xy + y^2
+
+LaTeX output will wrap it in an ``align*`` environment.
+The result is:
+
+.. math::
+
+   a & = (x + y)^2 \\
+     & = x^2 + 2xy + y^2
+
+The ``matrix`` and ``cases`` environments can also contain ``\\`` and
+``&``::
+
+  .. math::
+
+    \left(\begin{matrix} a & b \\ c & d \end{matrix}\right)
+
+Result:
+
+.. math::
+
+  \left(\begin{matrix} a & b \\ c & d \end{matrix}\right)
+
+
+Mathematical symbols
+====================
+
+The following tables are adapted from the first edition of
+"The LaTeX Companion" (Goossens, Mittelbach, Samarin).
+
+Accents
+-------
+.. class:: colwidths-auto
+
+  =========== =============  =========== =============  ============== ================
+  `\acute{x}` ``\acute{x}``  `\dot{t}`   ``\dot{t}``    `\hat{H}`      ``\hat{H}``
+  `\bar{v}`   ``\bar{v}``    `\ddot{t}`  ``\ddot{t}``   `\mathring{x}` ``\mathring{x}``
+  `\breve{x}` ``\breve{x}``  `\dddot{t}` ``\dddot{t}``  `\tilde{n}`    ``\tilde{n}``
+  `\check{x}` ``\check{x}``  `\grave{x}` ``\grave{x}``  `\vec{x}`      ``\vec{x}``
+  =========== =============  =========== =============  ============== ================
+
+When adding an accent to an i or j in math, dotless variants can be
+obtained with ``\imath`` and ``\jmath``: `\bar \imath`, `\hat{\jmath}`
+(MathML drops the dot automatically).
+
+For adornment that span multiple symbols, see `top and bottom
+embellishments`_.
+
+Font switches
+-------------
+
+TeX’s *math alphabets* correspond to the
+:t:`mathematical alphanumeric symbols` block in Unicode and the
+"mathvariant" `style attribute`__ in MathML. They are “to be used for
+mathematical variables where style variations are important
+semantically”.
+
+__ https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute
+
+.. class:: colwidths-auto
+
+  ===============  ============================  ==========================
+  command          example                       result
+  ===============  ============================  ==========================
+  ``\mathbf``      ``\mathbf{r}^2=x^2+y^2+z^2``  `\mathbf{r}^2=x^2+y^2+z^2`
+  ``\mathbb``      ``\mathbb{R \subset C}``      `\mathbb{R \subset C}`
+  ``\mathcal``     ``\mathcal{F}f(x)``           `\mathcal{F}f(x)`
+  ``\mathfrak``    ``\mathfrak{a}``              `\mathfrak{a}`
+  ``\mathit``      ``\mathit{\Gamma}``           `\mathit{\Gamma}`
+  ``\mathrm``      ``s_\mathrm{out}``            `s_\mathrm{out}`
+  ``\mathsf``      ``\mathsf x``                 `\mathsf x`
+  ``\mathtt``      ``\mathtt{0.12}``             `\mathtt{0.12}`
+  ===============  ============================  ==========================
+
+Additional alphabets are defined in LaTeX packages, e.g.
+
+.. class:: colwidths-auto
+
+  ===========  =============  ======================
+  TeX command  LaTeX package  MathML "mathvariant"
+  ===========  =============  ======================
+  mathbfit     isomath_       bold-italic
+  mathsfit     isomath_       sans-serif-italic
+  mathsfbfit   isomath_       sans-serif-bold-italic
+  mathscr      mathrsfs_      script
+  ===========  =============  ======================
+.. _isomath: https://www.ctan.org/pkg/isomath
+.. _mathrsfs: https://www.ctan.org/pkg/mathrsfs
+
+This can be used to typeset vector symbols in **bold** *italic*
+in line with the International Standard ISO-80000-2.
+``\mathbfit{r}^2=x^2+y^2+z^2`` becomes
+
+.. math:: \mathbfit{r}^2=x^2+y^2+z^2.
+
+
+
+In contrast to the math alphabet selectors, ``\boldsymbol`` only changes
+the *font weight*. In LaTeX, it can be used to get a bold version of any
+mathematical symbol (for other output formats, results are mixed):
+
+.. math::
+     \boldsymbol{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}
+
+
+
+
+Arrows
+------
+.. class:: colwidths-auto
+
+  ===================== =======================  ===================== =======================
+  `\leftarrow`          ``\leftarrow``           `\Leftarrow`          ``\Leftarrow``
+  `\rightarrow`         ``\rightarrow``          `\Rightarrow`         ``\Rightarrow``
+  `\leftrightarrow`     ``\leftrightarrow``      `\Leftrightarrow`     ``\Leftrightarrow``
+  `\uparrow`            ``\uparrow``             `\Uparrow`            ``\Uparrow``
+  `\downarrow`          ``\downarrow``           `\Downarrow`          ``\Downarrow``
+  `\updownarrow`        ``\updownarrow``         `\Updownarrow`        ``\Updownarrow``
+
+  `\longleftarrow`      ``\longleftarrow``       `\Longleftarrow`      ``\Longleftarrow``
+  `\longrightarrow`     ``\longrightarrow``      `\Longrightarrow`     ``\Longrightarrow``
+  `\longleftrightarrow` ``\longleftrightarrow``  `\Longleftrightarrow` ``\Longleftrightarrow``
+
+  `\nearrow`            ``\nearrow``             `\leftharpoonup`      ``\leftharpoonup``
+  `\searrow`            ``\searrow``             `\rightharpoonup`     ``\rightharpoonup``
+  `\swarrow`            ``\swarrow``             `\leftharpoondown`    ``\leftharpoondown``
+  `\nwarrow`            ``\nwarrow``             `\rightharpoondown`   ``\rightharpoondown``
+
+  `\mapsto`             ``\mapsto``              `\hookleftarrow`      ``\hookleftarrow``
+  `\longmapsto`         ``\longmapsto``          `\hookrightarrow`     ``\hookrightarrow``
+  ===================== =======================  ===================== =======================
+
+
+Binary operators
+----------------
+.. class:: colwidths-auto
+
+  ================== ====================  ================= ===================  ================== ====================
+  `*`                ``*``                 `\circledast`     ``\circledast``      `\ominus`          ``\ominus``
+  `+`                ``+``                 `\circledcirc`    ``\circledcirc``     `\oplus`           ``\oplus``
+  `-`                ``-``                 `\circleddash`    ``\circleddash``     `\oslash`          ``\oslash``
+  `:`                ``:``                 `\cup`            ``\cup``             `\otimes`          ``\otimes``
+  `\Cap`             ``\Cap``              `\curlyvee`       ``\curlyvee``        `\pm`              ``\pm``
+  `\Cup`             ``\Cup``              `\curlywedge`     ``\curlywedge``      `\rightthreetimes` ``\rightthreetimes``
+  `\amalg`           ``\amalg``            `\dagger`         ``\dagger``          `\rtimes`          ``\rtimes``
+  `\ast`             ``\ast``              `\ddagger`        ``\ddagger``         `\setminus`        ``\setminus``
+  `\bigcirc`         ``\bigcirc``          `\diamond`        ``\diamond``         `\smallsetminus`   ``\smallsetminus``
+  `\bigtriangledown` ``\bigtriangledown``  `\div`            ``\div``             `\sqcap`           ``\sqcap``
+  `\bigtriangleup`   ``\bigtriangleup``    `\divideontimes`  ``\divideontimes``   `\sqcup`           ``\sqcup``
+  `\boxdot`          ``\boxdot``           `\dotplus`        ``\dotplus``         `\star`            ``\star``
+  `\boxminus`        ``\boxminus``         `\doublebarwedge` ``\doublebarwedge``  `\times`           ``\times``
+  `\boxplus`         ``\boxplus``          `\gtrdot`         ``\gtrdot``          `\triangleleft`    ``\triangleleft``
+  `\boxtimes`        ``\boxtimes``         `\intercal`       ``\intercal``        `\triangleright`   ``\triangleright``
+  `\bullet`          ``\bullet``           `\leftthreetimes` ``\leftthreetimes``  `\uplus`           ``\uplus``
+  `\cap`             ``\cap``              `\lessdot`        ``\lessdot``         `\vee`             ``\vee``
+  `\cdot`            ``\cdot``             `\ltimes`         ``\ltimes``          `\veebar`          ``\veebar``
+  `\centerdot`       ``\centerdot``        `\mp`             ``\mp``              `\wedge`           ``\wedge``
+  `\circ`            ``\circ``             `\odot`            ``\odot``           `\wr`              ``\wr``
+  ================== ====================  ================= ===================  ================== ====================
+
+
+Braces
+------
+.. class:: colwidths-auto
+
+  ============  ============  ============  ==============  ========================
+     `(` ``(``     `` ````     `|` ``|``     `\{` ``\{``     `\langle` ``\langle``
+     `)` ``)``     `` ````     `|` ``|``     `\}` ``\}``     `\rangle` ``\rangle``
+  ============  ============  ============  ==============  ========================
+
+
+Greek letters
+-------------
+.. class:: colwidths-auto
+
+  ========== ============  ========== ============  ========== ============  ============== ===============
+  `\Gamma`   ``\Gamma``    `\alpha`   ``\alpha``    `\mu`      ``\mu``       `\omega`       ``\omega``
+  `\Delta`   ``\Delta``    `\beta`    ``\beta``     `\nu`      ``\nu``       `\backepsilon` ``\backepsilon``
+  `\Lambda`  ``\Lambda``   `\gamma`   ``\gamma``    `\xi`      ``\xi``       `\digamma`     ``\digamma``
+  `\Omega`   ``\Omega``    `\delta`   ``\delta``    `\pi`      ``\pi``       `\varepsilon`  ``\varepsilon``
+  `\Phi`     ``\Phi``      `\epsilon` ``\epsilon``  `\rho`     ``\rho``      `\varkappa`    ``\varkappa``
+  `\Pi`      ``\Pi``       `\zeta`    ``\zeta``     `\sigma`   ``\sigma``    `\varphi`      ``\varphi``
+  `\Psi`     ``\Psi``      `\eta`     ``\eta``      `\tau`     ``\tau``      `\varpi`       ``\varpi``
+  `\Sigma`   ``\Sigma``    `\theta`   ``\theta``    `\upsilon` ``\upsilon``  `\varrho`      ``\varrho``
+  `\Theta`   ``\Theta``    `\iota`    ``\iota``     `\phi`     ``\phi``      `\varsigma`    ``\varsigma``
+  `\Upsilon` ``\Upsilon``  `\kappa`   ``\kappa``    `\chi`     ``\chi``      `\vartheta`    ``\vartheta``
+  `\Xi`      ``\Xi``       `\lambda`  ``\lambda``   `\psi`     ``\psi``
+  ========== ============  ========== ============  ========== ============  ============== ===============
+
+
+Letterlike symbols
+------------------
+.. class:: colwidths-auto
+
+======= ==========  ============= ===============  ========= ===========  ========== ============
+`\Im`   ``\Im``     `\forall`     ``\forall``      `\aleph`  ``\aleph``   `\eth`     ``\eth``
+`\Re`   ``\Re``     `\exists`     ``\exists``      `\beth`   ``\beth``    `\hbar`    ``\hbar``
+`\mho`  ``\mho``    `\complement` ``\complement``  `\gimel`  ``\gimel``   `\hslash`  ``\hslash``
+`\Bbbk` ``\Bbbk``   `\Finv`       ``\Finv``        `\daleth` ``\daleth``  `\imath`   ``\imath``
+`\ell`    ``\ell``  `\Game`       ``\Game``        `\nabla`  ``\nabla``   `\partial` ``\partial``
+`\wp`    ``\wp``
+======= ==========  ============= ===============  ========= ===========  ========== ============
+
+
+Miscellaneous symbols
+---------------------
+.. class:: colwidths-auto
+
+======== ===============  =========== =============  ============== ================  ========== ============
+`\angle` ``\angle``       `\emptyset` ``\emptyset``  `\clubsuit`    ``\clubsuit``     `\flat`    ``\flat``
+`\colon` ``\colon`` #_  `\infty`    ``\infty``     `\diamondsuit` ``\diamondsuit``  `\natural` ``\natural``
+`\cdots` ``\cdots``       `\neg`      ``\neg``       `\heartsuit`   ``\heartsuit``    `\sharp`   ``\sharp``
+`\ddots` ``\ddots``       `\bot`      ``\bot``       `\spadesuit`   ``\spadesuit``
+`\ddots` ``\ddots``       `\top`      ``\top``
+======== ===============  =========== =============  ============== ================  ========== ============
+
+.. # Punctuation (not ratio):
+       Compare spacing in `a\colon b\to c` and `a:b = c`.
+
+
+Named operators
+---------------
+.. class:: colwidths-auto
+
+  ========= ===========  ====== ========  ====== ========  ======= =========
+  `\arccos` ``\arccos``  `\csc` ``\csc``  `\ker` ``\ker``  `\sec`  ``\sec``
+  `\arcsin` ``\arcsin``  `\deg` ``\deg``  `\lg`  ``\lg``   `\sin`  ``\sin``
+  `\arctan` ``\arctan``  `\det` ``\det``  `\lim` ``\lim``  `\sinh` ``\sinh``
+  `\arg`    ``\arg``     `\dim` ``\dim``  `\ln`  ``\ln``   `\sup`  ``\sup``
+  `\cos`    ``\cos``     `\exp` ``\exp``  `\log` ``\log``  `\tan`  ``\tan``
+  `\cosh`   ``\cosh``    `\gcd` ``\gcd``  `\max` ``\max``  `\tanh` ``\tanh``
+  `\cot`    ``\cot``     `\hom` ``\hom``  `\min` ``\min``
+  `\coth`   ``\coth``    `\inf` ``\inf``  `\Pr`  ``\Pr``
+  ========= ===========  ====== ========  ====== ========  ======= =========
+
+Named operators outside the above list can be typeset with
+``\operatorname{name}``, e.g. `\operatorname{sgn}(-3) = -1`.
+
+
+Relation symbols
+----------------
+.. class:: colwidths-auto
+
+  ================================  ================================  ================================  ================================
+     `\Join` ``\Join``                 `\approx` ``\approx``             `\asymp` ``\asymp``               `\bowtie` ``\bowtie``
+     `\cong` ``\cong``                 `\dashv` ``\dashv``               `\doteq` ``\doteq``               `\equiv` ``\equiv``
+     `\frown` ``\frown``               `\ge` ``\ge``                     `\geq` ``\geq``                   `\gg` ``\gg``
+     `\in` ``\in``                     `\le` ``\le``                     `\leq` ``\leq``                   `\ll` ``\ll``
+     `\mid` ``\mid``                   `\models` ``\models``             `\neq` ``\neq``                   `\ni` ``\ni``
+     `\parallel` ``\parallel``         `\perp` ``\perp``                 `\prec` ``\prec``                 `\precsim` ``\precsim``
+     `\propto` ``\propto``             `\sim` ``\sim``                   `\simeq` ``\simeq``               `\smile` ``\smile``
+     `\sqsubset` ``\sqsubset``         `\sqsubseteq` ``\sqsubseteq``     `\sqsupset` ``\sqsupset``         `\sqsupseteq` ``\sqsupseteq``
+     `\subset` ``\subset``             `\subseteq` ``\subseteq``         `\succ` ``\succ``                 `\succsim` ``\succsim``
+     `\supset` ``\supset``             `\supseteq` ``\supseteq``         `\vdash` ``\vdash``
+  ================================  ================================  ================================  ================================
+
+negated relations
+.. class:: colwidths-auto
+
+  =============================  ===================
+  `\not\in`     ``\not\in``      `\not =` ``\not =``
+  `\not \equiv` ``\not \equiv``
+  =============================  ===================
+
+
+Variable-sized symbols
+----------------------
+.. class:: colwidths-auto
+
+  =================  ===========================  =========================  =========================  =====================
+  `\sum` ``\sum``    `\bigodot` ``\bigodot``      `\bigcap` ``\bigcap``      `\bigwedge` ``\bigwedge``  `\prod` ``\prod``
+  `\int` ``\int``    `\bigoplus` ``\bigoplus``    `\bigcup` ``\bigcup``      `\bigvee` ``\bigvee``      `\coprod` ``\coprod``
+  `\oint` ``\oint``  `\bigotimes` ``\bigotimes``  `\biguplus` ``\biguplus``
+  =================  ===========================  =========================  =========================  =====================
+
+Larger symbols are used in displayed formulas:
+
+.. math::
+
+   \sum\ \int\ \oint \bigcap \prod \ldots
+
+Extensible delimiters
+---------------------
+Unless you indicate otherwise, delimiters in math formulas remain at the
+standard size regardless of the height of the enclosed material. To get
+adaptable sizes, use ``\left`` and ``\right`` prefixes.
+
+.. math::
+
+   g(A,B,Y) = f \left(A,B,X=h^{X}(Y)\right)
+
+Use ``.`` for "empty" delimiters:
+
+.. math::
+
+   A = \left . \frac{1}{1-n}\, \right |_{n=0}^\infty
+
+
+Top and bottom embellishments
+-----------------------------
+
+Visually similar to accents_ but generally applied to multiple symbols.
+
+.. class:: colwidths-auto
+
+  ========================== ============================  =========================== =============================
+  `\widetilde{abi}`          ``\widetilde{abi}``           `\widehat{abi}`             ``\widehat{abi}``
+  `\overline{abi}`           ``\overline{abi}``            `\underline{abi}`           ``\underline{abi}``
+  `\overbrace{abi}`          ``\overbrace{abi}``           `\underbrace{abi}`          ``\underbrace{abi}``
+  `\overleftarrow{abi}`      ``\overleftarrow{abi}``       `\underleftarrow{abi}`      ``\underleftarrow{abi}``
+  `\overrightarrow{abi}`     ``\overrightarrow{abi}``      `\underrightarrow{abi}`     ``\underrightarrow{abi}``
+  `\overleftrightarrow{abi}` ``\overleftrightarrow{abi}``  `\underleftrightarrow{abi}` ``\underleftrightarrow{abi}``
+  ========================== ============================  =========================== =============================
+
+Extensible arrows
+-----------------
+
+TODO
+
+
+Text
+====
+
+The main use of the command ``\text`` is for words or phrases in a
+display. It is similar to ``\mbox`` in its effects but, unlike ``\mbox``,
+automatically produces subscript-size text if used in a subscript,
+``k_{\text{B}}T`` becomes `k_{\text{B}}T`.
+
+Whitespace is kept inside the argument:
+
+.. Math:: f_{x_{i-1},x_i} \text{ is monotonic for }  i = 1,\,…,\,c+1
+
+
+Currently, math in text is not supported by LaTeX2MathML.
+
+Horizontal space
+================
+
+.. class:: colwidths-auto
+
+  =================  ==================  =============
+  :m:`|\qquad|`      ``|\qquad|``        2 em
+  :m:`|\quad|`       ``|\quad|``         1 em
+  :m:`|\;|`          ``|\;|``            thick
+  :m:`|\ |`          ``|\ |``            standard
+  :m:`|\:|`          ``|\:|``            medium
+  :m:`|\,|`          ``|\,|``            thin
+  :m:`|  |`          ``|  |``            none
+  :m:`|\!|`          ``|\!|``            thin negative
+  `|\hspace{1ex}|`   ``|\hspace{1ex}|``  custom
+  =================  ==================  =============
+
+ToDo
+====
+
+internal LaTeX2MathML
+
+* Math inside text: ``n - 1 \text{if $n$ is odd}``.
+* Remove circular refs.
+* Decimal numbers.
+
+* Shorthands for combined named operators
+
+  ==========  ============  =============  ===============  ==================
+  `\liminf`   ``\liminf``   `\varliminf`   ``\varliminf``   `\underline{\lim}`
+  `\limsup`   ``\limsup``   `\varlimsup`   ``\varlimsup``   `\overline{\lim}`
+  `\injlim`   ``\injlim``   `varinjlim`    ``\varinjlim``
+  `\projlim`  ``\projlim``  `varprojlim`   ``\varprojlim``
+  ==========  ============  =============  ===============  ==================
+
+* Implement ``\circledS``? (in short-math-guide.pdf but not in mathematical Unicode characters)
+
+
+Tests
+==========
+
+Font changes
+------------
+
+Math alphabet macros change the default alphabet ("mathvariant" in
+MathML), leaving some symbols unchanged:
+
+:normal: `abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R`
+:mathrm: `\mathrm{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathit: `\mathit{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathsf: `\mathsf{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathbb: `\mathbb{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R}`
+:mathbf: `\mathbf{abs(x) \pm \alpha \approx 3 \Gamma  \quad \forall x \in R`
+
+Unicode supports the following blackboard-bold characters:
+`\mathbb{a \ldots z A \ldots Z 0 \ldots 9
+\mathbb\Gamma \mathbb{\Pi} \mathbb {\Sigma}\mathbb\gamma \mathbb\pi}`.
+
+The package mathrsfs_ (and some drop-in replacements) define the ``\mathscr``
+macro that selects a differently shaped "script" alphabet.
+Compare `\mathscr{A, B, …, Z, a, b, …, z}`
+with `\mathcal{A, B, …, Z, a, b, …, z}`.
+
+.. _rsfs: https://ctan.org/pkg/mathrsfs
+
+Inferred <mrow>s in MathML
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The elements <msqrt>, <mstyle>, <merror>, <mpadded>, <mphantom>, <menclose>,
+<mtd, mscarry>, and <math> treat their contents as a single inferred mrow
+formed from all their children.
+
+.. math:: a = \sqrt 2, b = \sqrt{1+x^2}, c = \sqrt\frac{sin(x)}{23}
+
+inline: :math:`a = \sqrt 2, b = \sqrt{1+x^2}, c = \sqrt\frac{sin(x)}{23}`.
+
+Accents vs. embellishments
+--------------------------
+
+MathML drops dots on "i" and "j" with accents:
+
+.. math:: \vec i \ne \overrightarrow i
+          \text{ and } \vec\lim \ne \overrightarrow\lim.
+
+Accents should be nearer to the base (in Firefox 78, it's vice versa!):
+
+.. math:: \vec a \vec l \ne \overrightarrow a \overrightarrow l
+
+          \bar a \bar l \ne \overline a \overline l

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/embed_images.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/html4css1.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/html4css1.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/html5-features.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/html5-features.txt Changed

@@ -96,12 +96,33 @@
     nested
       definition lists
 
+Details disclosure elements
+```````````````````````````
+
+Items of `definition lists`_ with class argument "details" are converted
+to `details`_ disclosure elements with the term becoming the "summary".
+
+.. _closed-details:
+.. class:: details
+
+A summary
+  with details only visible after user interaction.
+
+.. _open-details:
+.. class:: details open
+
+Another summary
+  with open details because the source list has the additional class
+  value "open".
+
+.. _details:
+   https://www.w3.org/TR/html52/interactive-elements.html#the-details-element
 
 Field List Variants
 ```````````````````
 
 For field lists, the "compact/open", "narrow" and "run-in" styles are defined
-in the style sheet ``plain.css``.
+in the style sheets ``plain.css`` and ``responsive.css``.
 
 *compact*
   .. class:: compact
@@ -133,6 +154,15 @@
        sticks into the field body and the field body starts on a
        new line (if not combined with `run-in`_).
 
+custom *field-indent*
+  .. class:: field-indent-3em
+
+  :Feature: Field body indented by custom amount.
+  :Use:     class value starting with ``field-indent-`` followed by
+            a valid lenght, e.g. ``field-indent-3em``.
+  :The writer:
+            will convert this class value to a ``style`` attribute setting.
+
 .. _`run-in`:
 
 *run-in*
@@ -175,7 +205,7 @@
   from the booktabs_ LaTeX package.
 
   .. _table-style:
-     http://docutils.sourceforge.net/docs/user/config.html#table-style
+     https://docutils.sourceforge.io/docs/user/config.html#table-style
   .. _booktabs:
      http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/html5-text-level-tags.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/html5-text-level-tags.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/hyperlinking.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/hyperlinking.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/latex-problematic.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/latex-problematic.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/latex_encoding.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/latex_encoding.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/math.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/math.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/math.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/math.txt Changed

@@ -49,7 +49,7 @@
 Math-Accents:
   .. list-table::
      :class: borderless
-     :widths: 26 26 26
+     :width: 100%
 
      * - :math:`\acute{a}`      ``\acute{a}``
        - :math:`\dot{t}`        ``\dot{t}``
@@ -91,23 +91,13 @@
    s_{\mathrm{out}}(x) & = s_{\mathrm{in}}(x') * s_δ(x-x') \\
                        & = ∫ s_{\mathrm{in}}(x')s_δ(x-x')\mathrm{d}x'
 
-Cases ("manually", with ``matrix`` environment):
-
-.. math::
-
-   \mathrm{sgn}(x) = \left\{\begin{matrix}
-                       -1 & x<0\\
-                       1 & x>0
-                     \end{matrix}\right.
-
-Cases with the AMSmath_ ``cases`` environment (not (yet) supported by
-HTML writers with ``--math-output=MathML``):
+Cases with the AMSmath_ ``cases`` environment:
 
 .. math::
 
    \mathrm{sgn}(x) = \begin{cases}
-                       -1 & x<0\\
-                        1 & x>0
+                                -1 & x<0\\
+                       \phantom{-} 1 & x>0
                      \end{cases}
 
 .. _AMSmath: ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/minimal.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/minimal.css Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/nonalphanumeric.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/nonalphanumeric.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/option_lists.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/option_lists.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/plain.css -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/plain.css Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/responsive.css Added

@@ -0,0 +1,496 @@
+/* CSS3_ style sheet for the output of Docutils HTML5 writer.  */
+/* Generic responsive design for all screen sizes.                         */
+/*                                                                         */
+/* :Author: Günter Milde                                                   */
+/*                                                                         */
+/* :Id: $Id: responsive.css 9338 2023-04-08 21:08:47Z milde $                                                               */
+/* :Copyright: © 2021 Günter Milde.                                        */
+/* :License: Released under the terms of the `2-Clause BSD license`_,      */
+/*    in short:                                                            */
+/*                                                                         */
+/*    Copying and distribution of this file, with or without modification, */
+/*    are permitted in any medium without royalty provided the copyright   */
+/*    notice and this notice are preserved.                                */
+/*                                                                         */
+/*    This file is offered as-is, without any warranty.                    */
+/*                                                                         */
+/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
+/* .. _CSS3: https://www.w3.org/Style/CSS/                                 */
+
+/* Note:                                                                   */
+/* This style sheet is provisional:                                        */
+/* the API is not settled and may change with any minor Docutils version.  */
+
+
+
+/* General Settings */
+/* ================ */
+
+
+* { box-sizing: border-box; }
+
+body {
+  background-color: #fafaf6;
+  margin: auto;
+  --field-indent: 6.6em; /* indent of fields in field lists */
+  --sidebar-margin-right: 0; /* adapted in media queries below */
+}
+main {
+  counter-reset: figure table;
+}
+body > * {
+  background-color: white;
+  line-height: 1.6;
+  padding: 0.5rem calc(29% - 7.2rem); /* go from 5% to 15% (8.15em/54em) */
+  margin: auto;
+  max-width: 100rem;
+}
+sup, sub { /* avoid additional inter-line space for lines with sup/sub */
+  line-height: 1;
+}
+
+/* Vertical Space (Parskip) */
+p, ol, ul, dl, li,
+div.line-block,
+.topic,
+.footnote, .citation,
+div > math,
+table {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+h1, h2, h3, h4, h5, h6,
+dl > dd, details > p:last-child {
+  margin-bottom: 0.5em;
+}
+
+/* Indented Blocks */
+blockquote, figure, .topic {
+  margin: 1em 2%;
+  padding-left: 1em;
+}
+div.line-block div.line-block,
+pre, dd, dl.option-list {
+  margin-left: calc(2% + 1em);
+}
+
+/* Object styling */
+/* ============== */
+
+footer, header {
+  font-size: small;
+}
+
+/* Frontmatter */
+div.dedication {
+  padding: 0;
+  margin: 1.4em 0;
+  font-style: italic;
+  font-size: large;
+}
+.dedication p.topic-title {
+  display: none;
+}
+
+blockquote p.attribution,
+.topic p.attribution {
+  text-align: right;
+}
+
+/* Table of Contents */
+nav.contents ul {
+  padding-left: 1em;
+}
+ul.auto-toc > li > p { /* hanging indent */
+  padding-left: 1em;
+  text-indent: -1em;
+}
+main > nav.contents  ul:not(.auto-toc) {
+  list-style-type: square;
+}
+main > nav.contents  ul ul:not(.auto-toc) {
+  list-style-type: disc;
+}
+main > nav.contents  ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B29\ ';
+}
+main > nav.contents  ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B1D\ ';
+}
+main > nav.contents  ul ul ul ul ul:not(.auto-toc) {
+  list-style-type: '\2B2A\ ';
+}
+nav.contents ul > li::marker {
+  color: grey;
+}
+
+/* Transitions */
+hr {
+  margin: 1em 10%;
+}
+
+/* Lists */
+
+ul, ol {
+  padding-left: 1.1em; /* indent by bullet width (Firefox, DejaVu fonts) */
+}
+dl.field-list > dd,
+dl.docinfo > dd {
+  margin-left: var(--field-indent); /* adapted in media queries or HTML */
+}
+dl.option-list > dd {
+  margin-left: 20%;
+}
+/* run-in: start field-body on same line after long field names */
+dl.field-list.run-in > dd p {
+  display: block;
+}
+/* "description style" like in most dictionaries, encyclopedias etc. */
+dl.description {
+  display: flow-root;
+}
+dl.description > dt {
+  clear: left;
+  float: left;
+  margin: 0;
+  padding: 0;
+  padding-right: 0.3em;
+  font-weight: bold;
+}
+dl.description > dd:after {
+  display: table;
+  content: "";
+  clear: left; /* clearfix for empty descriptions */
+}
+/* start lists nested in description/field lists on new line */
+dd > dl:first-child,
+dd > ul:first-child,
+dd > ol:first-child {
+  clear: left;
+}
+
+/* disclosures */
+details { padding-left: 1em; }
+summary { margin-left: -1em; }
+
+/* Footnotes and Citations */
+.footnote {
+  font-size: small;
+}
+
+/* Images, Figures, and Tables */
+img {
+  display: block;
+}
+p > img, p > a > img,
+figure > img, figure > a > img {
+  display: inline;
+}
+
+figcaption,
+table > caption {
+  /*   font-size: small; */
+  font-style: italic;
+}
+figcaption > .legend {
+  font-size: small;
+  font-style: initial;
+}
+figure.numbered > figcaption > p:before {
+  counter-increment: figure;
+  content: "Figure " counter(figure) ": ";
+  font-weight: bold;
+  font-style: initial;
+}
+
+table tr {
+  text-align: left;
+  vertical-align: baseline;
+}
+table.booktabs { /* "booktabs" style (no vertical lines) */
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+}
+table.booktabs * {
+  border: 0;
+}
+table.booktabs th {
+  border-bottom: thin solid;
+}
+table.numbered > caption:before {
+  counter-increment: table;
+  content: "Table " counter(table) ": ";
+  font-weight: bold;
+  font-style: initial;
+}
+
+/* Admonitions and System Messages */
+.admonition,
+div.system-message {
+  border: thin solid silver;
+  margin: 1em 2%;
+  padding: 0.5em 1em;
+}
+.caution p.admonition-title,
+.attention p.admonition-title,
+.danger p.admonition-title,
+.warning p.admonition-title,
+div.error {
+  color: maroon;
+}
+div.system-message > p > span.literal {
+  overflow-wrap: break-word;
+}
+
+/* Literal and Code */
+pre.literal-block, pre.doctest{
+  padding: 0.2em;
+  overflow-x: auto;
+}
+.literal-block, .doctest, span.literal {
+  background-color: #f6f9f8;
+}
+.system-message span.literal {
+  background-color: inherit;
+}
+
+/* basic highlighting: for a complete scheme, see */
+/* https://docutils.sourceforge.io/sandbox/stylesheets/ */
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+/* Hyperlink References */
+a {
+  text-decoration: none; /* for chromium */
+  /* Wrap links at any place, if this is the only way to prevent overflow */
+  overflow-wrap: break-word;
+}
+.contents a, a.toc-backref, a.citation-reference {
+  overflow-wrap: inherit;
+}
+/* Undecorated Links (see also minimal.css) */
+/* a.citation-reference, */
+.citation a.fn-backref {
+  color: inherit;
+}
+a:hover {
+  text-decoration: underline;
+}
+*:hover > a.toc-backref:after {
+  content: " \2191"; /* ↑ UPWARDS ARROW */
+  color: grey;
+}
+*:hover > a.self-link:after {
+  content: "\1F517"; /* LINK SYMBOL */
+  color: grey;
+  font-size: smaller;
+  margin-left: 0.2em;
+}
+/* highlight the target of the current URL */
+section:target > h2, section:target > h3, section:target > h4,
+section:target > h5, section:target > h6,
+.contents :target,
+.contents:target > .topic-title,
+role="doc-biblioentry":target > .label,
+role="doc-biblioref":target,
+role="note":target, /* Docutils 0.18 ... 0.19 */
+role="doc-footnote":target, /* Docutils >= 0.20 */
+role="doc-noteref":target {
+  background-color: #d2e6ec;
+}
+
+/* Block Alignment */
+/* Let content flow to the side of aligned images and figures */
+
+/* no floats around this elements */
+footer, header, hr,
+h1, h2, h3 {
+  clear: both;
+}
+
+img.align-left,
+video.align-left,
+figure.align-left,
+table.align-left {
+  margin-left: 0;
+  padding-left: 0;
+  margin-right: 0.5em;
+  clear: left;
+  float: left;
+}
+img.align-right,
+video.align-right,
+figure.align-right,
+table.align-right {
+  margin-left: 0.5em;
+  margin-right: 0;
+  clear: right;
+  float: right;
+}
+
+/* Margin Elements */
+/* see below for screen size dependent rules */
+.sidebar,
+.marginal,
+.admonition.marginal {
+  max-width: 40%;
+  border: none;
+  background-color: #efefea;
+  margin: 0.5em var(--sidebar-margin-right) 0.5em 1em;
+  padding: 0.5em;
+  padding-left: 0.7em;
+  clear: right;
+  float: right;
+  font-size: small;
+}
+.sidebar {
+  width: 40%;
+}
+
+/* Math */
+/* for math-output=MathML (for math-output=HTML, see math.css) */
+math .boldsymbol {
+  font-weight: bold;
+}
+mstyle.mathscr, mi.mathscr {
+  font-family: STIX, XITSMathJax_Script, rsfs10,
+               "Asana Math", Garamond, cursive;
+}
+
+/* Adaptive page layout */
+/* ==================== */
+
+@media (max-width: 30em) {
+  /* Smaller margins and no floating elements for small screens */
+  /* (main text less than 40 characters/line) */
+  body > * {
+    padding: 0.5rem 5%;
+    line-height: 1.4
+  }
+  .sidebar,
+  .marginal,
+  .admonition.marginal {
+    width: auto;
+    max-width: 100%;
+    float: none;
+  }
+  dl.option-list,
+  pre {
+    margin-left: 0;
+  }
+  body {
+    --field-indent: 4em;
+  }
+  dl.field-list.narrow, dl.docinfo, dl.option-list {
+    --field-indent: 2.4em;
+  }
+  pre, pre * {
+  font-size: 0.9em;
+  /* overflow: auto; */
+  }
+}
+
+@media (min-width: 54em) {
+  /* Move ToC to the left */
+  /* Main text width before: 70% ≙ 35em ≙ 75…95 chrs (Dejavu/Times) */
+  /*                  after:      ≳ 30em ≙ 54…70 chrs (Dejavu/Times) */
+  body.with-toc {
+    padding-left: 8%;
+  }
+  body.with-toc > * {
+    margin-left: 0;
+    padding-left: 22rem; /* fallback for webkit */
+    padding-left: min(22%, 22rem);
+    padding-right: 7%;
+  }
+  main > nav.contents { /* global ToC */
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: min(25%, 25em);
+    height: 100vh;
+    margin: 0;
+    background-color: #fafaf6;
+    padding: 1em 2% 0 2%;
+    overflow: auto;
+  }
+  main > nav.contents > * {
+    padding-left: 0;
+    line-height: 1.4;
+  }
+  main > nav.contents a {
+  color: inherit;
+  }
+}
+
+@media (min-width: 70em) {
+  body {
+    --field-indent: 9em;
+  }
+}
+
+@media (min-width: 77em) {
+  /* Move marginalia to 6rem from right border       */
+  /* .sidebar,                                       */
+  /* .marginal,                                      */
+  /* .admonition.marginal {                          */
+  /*   margin-right: calc(6rem - 15%);               */
+  /* }                                               */
+  /* BUG: margin is calculated for break point width */
+  /* workaround: variable + many breakpoints         */
+  body > * {
+    padding-left: 18%;
+    padding-right: 28%; /* fallback for webkit */
+    padding-right: min(28%, 28rem);
+    --sidebar-margin-right: -20rem;
+  }
+  /* limit main text to ~ 50em ≙ 85…100 characters DejaVu rsp. …120 Times */
+  body.with-toc > * {
+    padding-left: min(22%, 22rem);
+    padding-right: calc(78% - 50rem); /* fallback for webkit */
+    padding-right: min(78% - 50rem, 28rem);
+    --sidebar-margin-right: 0;
+  }
+}
+
+@media (min-width: 85em) {
+  body.with-toc > * {
+    --sidebar-margin-right: -9rem;
+  }
+}
+
+@media (min-width: 90em) {
+  /* move marginalia into the margin */
+  body > * {
+    padding-left: min(22%, 22rem);
+    --sidebar-margin-right: -23rem;
+  }
+  body.with-toc > * {
+    --sidebar-margin-right: -14rem;
+  }
+}
+
+@media (min-width: 99em) {
+  /* move marginalia out of main text area */
+  body.with-toc > * {
+    --sidebar-margin-right: -20rem;
+  }
+  body > *, body.with-toc > * { /* for webkit */
+    padding-left: 22rem;
+    padding-right: 28rem;
+  }
+  .admonition.marginal,
+  .marginal {
+    width: 40%; /* make marginal figures, ... "full width" */
+  }
+}
+
+@media (min-width: 104em) {
+  body.with-toc > * {
+    --sidebar-margin-right: -23rem;
+  }
+}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/section_titles.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/section_titles.txt Changed

@@ -1,28 +1,53 @@
-Section titles with `inline markup`_ 
-------------------------------------
+Section heading levels
+======================
 
-*emphasized*, H\ :sub:`2`\ O and :math:`x^2`
-````````````````````````````````````````````
-Substitutions |fail|
-````````````````````
-.. |fail| replace:: work
+Level 1
+=======
+Nested sections
 
-Deeply nested sections
-----------------------
-In LaTeX and HTML,
+Level 2
+-------
+reach at some level
 
 Level 3
 ```````
-nested sections
+(depending on the document class and output format)
 
 level 4
 ^^^^^^^
-reach at some level 
+a level
 
 level 5
-:::::::
-(depending on the document class)
++++++++
+that is not supported by the output format.
 
 level 6
-+++++++
-an unsupported level.
+:::::::
+Unsupported in LaTeX and HTML5
+(HTML5 reserves the 1st level for the document title).
+
+level 7
+#######
+Unsupported in HTML4.
+
+level 8
+<<<<<<<
+Unsupported in ODT.
+
+.. _references:
+
+Section titles with inline markup
+==================================
+
+*emphasized*, H\ :sub:`2`\ O, :math:`x^2`, and references_
+----------------------------------------------------------
+Substitutions |fail|
+--------------------
+.. |fail| replace:: work
+
+Note, that the "reference name" for this section is derived from the
+content *before* substitution. This may be exploited to get intelligible
+IDs after `identifier normalization`_ of the section's reference name.
+
+.. _identifier normalization: https://docutils.sourceforge.io/docs/ref/rst/
+                              directives.html#identifier-normalization

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/svg_images.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/svg_images.txt Changed

@@ -6,41 +6,22 @@
    :height: 48 px
    :align: left
 
-Scalable vector graphics (SVG) images are the only standards-compliable way
-to include vector graphics in HTML documents. However, they are not
-supported by all backends/output formats. (E.g., LaTeX supports the
-PDF or Postscript formats for vector graphics instead.)
+Scalable vector graphics (SVG) images are the only standards-compatible
+way to include vector graphics in HTML documents. However, they are not
+supported by all backends/output formats (LaTeX, e.g., supports the PDF
+or Postscript formats for vector graphics instead). Rendering behaviour
+varies, depending on the SVG image itself, the method used to put the
+image in the document, and the viewing agent.
 
-Rendering behaviour varies, depending on
+All up-to-date HTML browsers support SVG, however not all do this fully
+and in the same manner. Many older versions, especially IE < 9, have
+deficiencies or require plug-ins (i.e. don't support the ``<img>`` tag).
+The `html4css1` writer includes SVG images using ``<object>`` tags,
+the `html5` writer uses ``<img>`` tags.
 
-a) The SVG image itself, e.g. fixed-size vs. scaling::
 
-      width="280"              viewBox="0 0 280 27"
-      height="27"              width="100%"
-                               height="100%"
-
-b) The method used to put the image in the document.
-
-   For HTML, there are several alternatives including:
-
-   * using the HTML ``<img>`` tag (not for interactive/animated SVG),
-   * using the HTML ``<object>`` tag,
-   * including within SVG using the SVG ``<image>`` tag,
-   * embedd the SVG code within HTML (inlining).
-
-   The `html4css1` writer uses ``<object>`` tags, the `html5`
-   writer uses ``<img>`` tags.
-
-   .. cf. http://edutechwiki.unige.ch/en/Using_SVG_with_HTML5_tutorial
-
-c) The viewing agent.
-
-   All up-to-date HTML browsers support SVG, however not all do this fully
-   and in the same manner. Many older versions, especially IE < 9, have
-   deficiencies or require plug-ins (i.e. don't support the ``<img>`` tag).
-   
 If the image is wrapped in ``<object>`` or ``<svg>`` tags, it depends on the
-``viewBox`` declaration inside the images root ``<svg>`` element whether an
+"viewBox" declaration inside the image's root ``<svg>`` element whether an
 SVG image is scaled or clipped/padded. Images wrapped in ``<img>`` are
 always scaled.
 
@@ -48,28 +29,27 @@
      :width: 50%
      :align: right
 
-  A scaling image (scales with the browser window), occupying 50% of the line
-  width. The ``viewBox`` setting in the image file enables auto-scaling also in
-  ``<object>`` tags and embedded SVG (if width and hight are set to 100% in the
-  SVG <image> tag).
-
+  An image occupying 50% of the line width. The "viewBox" attribute in
+  the image file enables auto-scaling also in ``<object>`` tags and
+  embedded SVG.
 
 * .. image:: ../../../docs/user/rst/images/title.svg
      :width: 50%
      :height: 15 px
      :align: right
 
-  A fixed-size image in a box 50% wide and 15 pixles high. This image is
-  scaled, if wrapped in an ``<img>`` tag but clipped in an ``<object>`` tag
-  or within SVG.
+  An image without "viewBox" in a box 50% wide and 15 pixles high.
+  This image is scaled, if wrapped in an ``<img>`` tag but clipped in
+  an ``<object>`` tag or within SVG.
 
 * .. image:: ../../../docs/user/rst/images/title-scaling.svg
      :width: 50 %
      :height: 1.5 em
      :align: right
 
-  A right aligned, scaling image 50% wide and 1.5 em high. (This SVG image
-  keeps the aspect ratio.)
+  A right aligned image with "viewBox", 50% wide and 1.5 em high.
+  (SVG images keep the aspect ratio unless the "preserveAspectRatio"
+  attribute is ``"none"``.)
 
 * An inline image |inline-svg| scaled to a height of 0.8 em.
 
@@ -80,9 +60,9 @@
      :height: 1 em
      :align: right
 
-  A scaling image 1 em high, right aligned:
+  An image 1 em high, right aligned:
 
-* A scaling image 5 mm x 5 mm, centered, with hyperlink reference:
+* An image 5 mm x 5 mm, centred, with hyperlink reference:
 
   .. image:: ../../../docs/user/rst/images/biohazard-scaling.svg
      :target: `SVG Images`_
@@ -95,33 +75,33 @@
      :height: 2 em
      :align: right
 
-  A fixed-size image in a  4 cm x 2 em box.
+  An image without "viewBox" in a  4 cm x 2 em box.
 
 Older versions of `webkit` based browsers (chromium, safari, midori,
 konqueror) support the ``<img>`` tag but don't display contained bitmap
-images in this case.
+images.
 
 * .. image:: ../../../docs/user/rst/images/biohazard-bitmap.svg
      :width: 3em
      :align: right
 
-  A small, fixed-size SVG image with embedded bitmap, The ``:width:`` is 
-  set to 3 em in the rST source. Does not scale if wrapped in ``<object>``
-  tags.
+  A small SVG image with embedded bitmap, The ``:width:`` is set to 3 em
+  in the rST source. Does not scale if wrapped in ``<object>`` tags
+  because there is no "viewBox" attribute.
 
 
 * .. image:: ../../../docs/user/rst/images/biohazard-bitmap-scaling.svg
      :width: 3em
      :align: right
 
-  A scaling SVG image with embedded bitmap, 3 em wide.
+  An SVG image with embedded bitmap and "viewBox", 3 em wide.
 
 SVG images can also be put in figures:
 
-   .. figure:: ../../../docs/user/rst/images/title.svg
+   .. figure:: ../../../docs/user/rst/images/title-scaling.svg
       :alt: reStructuredText, the markup syntax
       :width:  290 px
       :height:  28 px
       :align: center
-   
+
       SVG image in a figure.

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/tables_latex.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/tables_latex.txt Changed

@@ -1,30 +1,83 @@
-More Tables
------------
-
-A table with multi-paragraph multicolumn cells:
-
-+----------+--------------+---------------------------------+-----------+
-| test     | **bold hd**  | multicolumn 1                   | *emph hd* |
-|          |              |                                 |           |
-|          |              | With a second paragraph         |           |
-+----------+--------------+--------------+--------+---------+-----------+
-| multicolumn 2           | cell         | cell   | cell    | cell      |
-|                         |              |        |         |           |
-| With a second paragraph |              |        |         |           |
-+----------+--------------+--------------+--------+---------+-----------+
-| cell     | multicolumn 3 (one line,    | cell   | cell    | cell      |
-|          | but very very very very     |        |         |           |
-|          | very looooong)              |        |         |           |
-+----------+--------------+--------------+--------+---------+-----------+
-| cell     | cell         | cell         | Short multicolumn 4          |
-+----------+--------------+--------------+------------------------------+
-
-Tables with multi-paragraph multirow cells currently fail due to a LaTeX
-limitation (see https://sourceforge.net/p/docutils/bugs/225/).
-
-A table with multirow header and column-widths set by LaTeX:
-
-.. table::
+Tables
+======
+
+In contrast to HTML, LaTeX does not support line-breaks in tables with
+"automatic" column widths. Each cell has just one line, paragraphs are
+merged (the writer emits a warning).
+
+.. table:: problems with "auto" widths
+   :widths: auto
+
+   +-----------+------------------+
+   | 11        | first paragraph  |
+   |           |                  |
+   |           | second paragraph |
+   +-----------+------------------+
+   | content   | 22               |
+   | with      |                  |
+   | linebreak |                  |
+   +-----------+------------------+
+
+To provide for arbitrary cell content, the LaTeX writer defaults to
+specifying column widths computed from the source column widths. This
+works sufficiently in many cases:
+
+.. table:: a table with multi-paragraph multi-column cells
+
+  +----------+--------------+---------------------------------+-----------+
+  | test     | **bold hd**  | multicolumn 1                   | *emph hd* |
+  |          |              |                                 |           |
+  |          |              | With a second paragraph         |           |
+  +----------+--------------+--------------+--------+---------+-----------+
+  | multicolumn 2           | cell         | cell   | cell    | cell      |
+  |                         |              |        |         |           |
+  | With a second paragraph |              |        |         |           |
+  +----------+--------------+--------------+--------+---------+-----------+
+  | cell     | multicolumn 3 (one line,    | cell   | cell    | cell      |
+  |          | but very very very very     |        |         |           |
+  |          | very looooong)              |        |         |           |
+  +----------+--------------+--------------+--------+---------+-----------+
+  | cell     | cell         | cell         | Short multicolumn 4          |
+  +----------+--------------+--------------+------------------------------+
+
+
+A problem with the source-derived column widths is that simple tables
+often use no padding while grid tables without padding look cramped:
+
+.. table:: simple table, not padded in the source
+
+   === = = =
+    A  B C D
+   === = = =
+   100 2 3 4
+   EUR b c d
+   === = = =
+
+.. table:: grid table, padded cells
+
+   +-----+---+---+---+
+   |  A  | B | C | D |
+   +=====+===+===+===+
+   | 100 | 2 | 3 | 4 |
+   +-----+---+---+---+
+   | EUR | b | c | d |
+   +-----+---+---+---+
+
+For better typographic results, setting the `width` and/or
+`widths` options of the `table directive`_ is recommended.
+
+.. table:: grid table, auto-width columns
+   :widths: auto
+
+   +-----+---+---+---+
+   |  A  | B | C | D |
+   +=====+===+===+===+
+   | 100 | 2 | 3 | 4 |
+   +-----+---+---+---+
+   | EUR | b | c | d |
+   +-----+---+---+---+
+
+.. table:: table with multi-row header and "auto" column-widths
    :widths: auto
 
    +------------+-------------------+
@@ -32,21 +85,70 @@
    |            +-------------------+
    |            | Description       |
    +============+===================+
-   | multicollumn cell              |
+   | multi-column cell              |
    +--------------------------------+
 
-In a table with column-widths set by LaTeX, each cell has just one line.
-Paragraphs are merged (a warning is given).
+The `width` option overrides "auto" `widths` as standard LaTeX tables
+don't have a global width setting:
 
-.. table::
+.. table:: This table has `widths` "auto" (ignored) and `width` 60%.
    :widths: auto
+   :width: 60%
 
-   +------------+-------------------+
-   | 11         | first paragraph   |
-   |            |                   |
-   |            | second paragraph  |
-   |            |                   |
-   |            | third paragraph   |
-   +------------+-------------------+
-   | 21         | 22                |
-   +------------+-------------------+
+   === = = =
+    A  B C D
+   === = = =
+   100 2 3 4
+   EUR b c d
+   === = = =
+
+.. _table directive:
+   https://docutils.sourceforge.io/docs/ref/rst/directives.html#table
+
+
+Nested tables
+-------------
+
++-----------------------------------------+-----------------+
+| Lorem ipsum dolor sit amet, consectetur | adipisicing elit|
++-----------------------------------------+-----------------+
+| .. table::                              | cell 1, 2       |
+|     :align: right                       |                 |
+|                                         |                 |
+|     +-----+-----+                       |                 |
+|     |  1  |  2  |                       |                 |
+|     +-----+-----+                       |                 |
++-----------------------------------------+-----------------+
+| table width depends on parent column    | same table      |
+|                                         |                 |
+| .. table::                              |                 |
+|     :align: center                      |                 |
+|                                         |                 |
+|     +-----+-----+                       | +-----+-----+   |
+|     |  1  |  2  |                       | |  1  |  2  |   |
+|     +-----+-----+                       | +-----+-----+   |
+|                                         |                 |
+| better use "auto" widths, see below     | in narrow column|
++-----------------------------------------+-----------------+
+| .. table::                              | cell 3, 2       |
+|     :align: right                       |                 |
+|     :widths: auto                       |                 |
+|                                         |                 |
+|     +-----+-----+                       |                 |
+|     |  1  |  2  |                       |                 |
+|     +-----+-----+                       |                 |
+|                                         |                 |
+| definition:                             |                 |
+|             list                        |                 |
++-----------------------------------------+-----------------+
+
+
+TODO
+----
+
+* Tables with multi-paragraph multi-row cells currently fail due to a
+  LaTeX limitation (see https://sourceforge.net/p/docutils/bugs/225/).
+
+* Tweak vertical spacing in table cells containing multiple elements.
+
+See also ``test/functional/input/data/latex-problematic.txt``.

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/tuftig.css Added

@@ -0,0 +1,568 @@
+/* CSS3_ style sheet for the output of Docutils HTML writers.              */
+/* Rules inspired by Edward Tufte's layout design.                         */
+/*                                                                         */
+/* :Author: Günter Milde                                                   */
+/*          based on tufte.css_ by Dave Liepmann                           */
+/*          and the tufte-latex_ package.                                  */
+/*                                                                         */
+/* :Id: $Id: tuftig.css 9319 2023-01-16 09:20:01Z milde $                                                               */
+/* :Copyright: © 2020 Günter Milde.                                        */
+/* :License: Released under the terms of the `2-Clause BSD license`_,      */
+/*    in short:                                                            */
+/*                                                                         */
+/*    Copying and distribution of this file, with or without modification, */
+/*    are permitted in any medium without royalty provided the copyright   */
+/*    notice and this notice are preserved.                                */
+/*                                                                         */
+/*    This file is offered as-is, without any warranty.                    */
+/*                                                                         */
+/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause     */
+/* .. _CSS3: https://www.w3.org/Style/CSS/                                 */
+/* .. _tufte.css: https://edwardtufte.github.io/tufte-css/                 */
+/* .. _tufte-latex_: https://www.ctan.org/pkg/tufte-latex                  */
+
+
+/* General Settings */
+/* ================ */
+
+body {
+  font-family: Georgia, serif;
+  background-color: #fafaf6;
+  font-size: 1.2em;
+  line-height: 1.4;
+  margin: auto;
+}
+main {
+  counter-reset: figure table;
+}
+main, header, footer {
+  padding: 0.5em 5%;
+  background-color: #fefef8;
+  max-width: 100rem;
+}
+
+/* Spacing */
+
+/* vertical space (parskip) */
+p, ol, ul, dl, li,
+h1, h2, h3, h4, h5, h6,
+div.line-block,
+.topic,
+.footnote, .citation,
+table {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+dl > dd {
+  margin-bottom: 0.5em;
+}
+/* exceptions */
+p:first-child {
+  margin-top: 0;
+}
+p:last-child {
+  margin-bottom: 0;
+}
+
+/* Indented Blocks */
+blockquote,
+.topic {
+  /* background-color: Honeydew; */
+  margin: 0.5em 2%;
+  padding-left: 1em;
+}
+div.line-block div.line-block,
+dl.option-list,
+figure > img,
+pre.literal-block, pre.math,
+pre.doctest-block, pre.code {
+  /* background-color: LightCyan; */
+  margin-left: calc(2% + 1em);
+}
+
+/* Object styling */
+/* ============== */
+
+footer, header {
+  font-size: smaller;
+}
+
+/* Titles and Headings */
+
+h2, h3, h4, p.subtitle, p.section-subtitle,
+p.topic-title, p.sidebar-title, p.sidebar-subtitle {
+  font-weight: normal;
+  font-style: italic;
+  text-align: left;
+}
+.sectnum {
+  font-style: normal;
+}
+
+h1.title {
+  text-align: left;
+  margin-top: 2.4em;
+  margin-bottom: 2em;
+  font-size: 2.4em;
+}
+h1 + p.subtitle {
+  margin-top: -2em;
+  margin-bottom: 2em;
+  font-size: 2.0em;
+}
+section {
+  margin-top: 2em;
+}
+h2, .contents > p.topic-title {
+  font-size: 2.2em;
+}
+h2 + p.section-subtitle {
+  font-size: 1.6em;
+}
+h3 {
+  font-size: 1.2em;
+}
+h3 + p.section-subtitle {
+  font-size: 1.1em;
+}
+h4 {
+  font-size: 1em;
+}
+p.section-subtitle {
+  font-size: 1em;
+}
+
+/* Dedication and Abstract */
+div.dedication {
+  padding: 0;
+  margin-left: 0;
+  font-style: italic;
+  font-size: 1.2em;
+}
+/* div.abstract p.topic-title, */
+div.dedication p.topic-title {
+  display: none;
+}
+
+/* Attribution */
+blockquote p.attribution,
+.topic p.attribution {
+  text-align: right;
+}
+
+/* Table of Contents */
+nav.contents {
+  padding: 0;
+  font-style: italic;
+}
+ul.auto-toc > li > p {
+  padding-left: 1em;
+  text-indent: -1em;
+}
+nav.contents ul {
+  padding-left: 1em;
+}
+
+
+/* Transitions */
+hr {
+  border: 0;
+  border-top: 1px solid #ccc;
+  margin: 1em 10%;
+}
+
+/* Lists */
+/* Less indent per level */
+ul, ol {
+  padding-left: 1.1em;
+}
+dd {
+  margin-left: 1.5em;
+}
+dd > dl:first-child,
+dd > ul:first-child,
+dd > ol:first-child {
+  /* lists nested in definition/description/field lists */
+  clear: left;
+}
+
+dl.field-list > dd,
+dl.docinfo > dd,
+dl.option-list > dd {
+  margin-left: 4em;
+}
+/* example for custom field-name width */
+dl.field-list.narrow > dd {
+  margin-left: 3em;
+}
+/* run-in: start field-body on same line after long field names */
+dl.field-list.run-in > dd p {
+  display: block;
+}
+/* italic field name */
+dl.description > dt,
+dl.field-list > dt,
+dl.docinfo > dt {
+  font-weight: normal;
+  font-style: italic;
+}
+
+/* "description style" like in most dictionaries, encyclopedias etc. */
+dl.description > dt {
+  clear: left;
+  float: left;
+  margin: 0;
+  padding: 0;
+  padding-right: 0.5em;
+}
+dl.description > dd:after {
+  display: block;
+  content: "";
+  clear: both;
+}
+
+/* Citation list (style as description list) */
+.citation-list,
+.footnote-list {
+  display: contents;
+}
+.citation {
+  padding-left: 1.5em;
+}
+.citation .label {
+  margin-left: -1.5em;
+}
+
+/* Images and Figures */
+img {
+  display: block;
+}
+p > img, p > a > img,
+figure > img, figure > a > img {
+  display: inline;
+}
+/* Caption to the left (if there is space) or below: */
+figure {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: flex-start;
+  margin: 0.5em 2%;
+  padding-left: 1em;
+}
+figure > img,
+figure.fullwidth > img {
+  margin: 0 0.5em 0.5em 0;
+  padding: 0;
+}
+figcaption {
+  font-size: 0.8em;
+}
+.fullwidth > figcaption {
+  font-size: inherit;
+}
+figure.numbered > figcaption > p:before {
+  counter-increment: figure;
+  content: "Figure " counter(figure) ": ";
+}
+
+/* Tables */
+table tr {
+  text-align: left;
+}
+/* th { vertical-align: bottom; } */
+/* "booktabs" style (no vertical lines) */
+table.booktabs {
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+}
+table.booktabs * {
+  border: 0;
+}
+table.booktabs th {
+  border-bottom: thin solid;
+}
+table.numbered > caption:before {
+  counter-increment: table;
+  content: "Table " counter(table) ": ";
+}
+
+/* Admonitions and System Messages */
+.admonition, .system-message {
+  border-style: solid;
+  border-color: silver;
+  border-width: thin;
+  margin: 1em 0;
+  padding: 0.5em;
+}
+.caution p.admonition-title,
+.attention p.admonition-title,
+.danger p.admonition-title,
+.warning p.admonition-title,
+div.error {
+  color: maroon;
+}
+
+/* Literal and Code */
+pre.literal-block, pre.doctest-block,
+pre.math, pre.code {
+  /* font-family: Consolas, "Liberation Mono", Menlo, monospace; */
+  /* font-size: 0.9em; */
+  overflow: auto;
+}
+/* basic highlighting: for a complete scheme, see */
+/* https://docutils.sourceforge.io/sandbox/stylesheets/ */
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+.sans {
+    font-family: "Gill Sans", "Gill Sans MT", Calibri, "Lucida Sans", "Noto Sans", sans-serif;
+    letter-spacing: .02em;
+}
+
+/* Hyperlink References */
+/* underline that clears descenders */
+a {
+  color: inherit;
+}
+a:link {
+  text-decoration: underline;
+  /* text-decoration-skip-ink: auto; nonstandard selector */
+}
+/* undecorated links */
+.contents a:link, a.toc-backref:link, a.image-reference:link,
+arole="doc-noteref":link, arole="doc-backlink":link, .backrefs a:link,
+a.citation-reference:link,
+ahref^="#system-message" {
+  text-decoration: none;
+}
+a:link:hover {
+  text-decoration: underline;
+}
+
+/* Block Alignment */
+/* Let content flow to the side of aligned images and figures */
+/* (does not work if the image/figure is a grid element). */
+
+/* no floats around this elements */
+footer, header,
+hr.docutils,
+h1, h2, h3, .contents > p.topic-title,
+.fullwidth {
+  clear: both;
+}
+
+img.align-left,
+figure.align-left,
+table.align-left {
+  margin-left: 0;
+  padding-left: 0;
+  padding-right: 0.5em;
+  clear: left;
+  float: left;
+}
+figure.align-left > img {
+  margin-left: 0;
+  padding-left: 0;
+}
+
+
+img.align-right {
+  padding-left: 0.5em;
+  clear: right;
+  float: right;
+}
+figure.align-right {
+  clear: right;
+  float: right;
+}
+figure.align-right > img {
+  justify-self: right;
+  padding: 0;
+}
+table.align-right {
+  margin-right: 2.5%;
+}
+
+figure.align-center {
+  align-content: center;
+  justify-content: center;
+}
+figure.align-center > img {
+  padding-left: 0;
+  justify-self: center;
+}
+
+/* Margin Elements */
+/* see below for screen size dependent rules */
+aside.sidebar,
+.marginal,
+.admonition.marginal,
+.topic.marginal {
+  background-color: #efefea;
+  box-sizing: border-box;
+  margin-left: 2%;
+  margin-right: 0;
+  padding: 0.5em;
+  font-size: 0.8em;
+}
+aside.sidebar {
+  background-color: inherit;
+}
+figure.marginal > figcaption {
+  font-size: 1em;
+}
+.footnote {
+  font-size: smaller;
+  overflow: auto;
+}
+
+/* Adaptive page layout */
+
+/* no floating for very small Screens */
+/* (main text up to ca. 40 characters/line) */
+@media (min-width: 35em) {
+  main, header, footer {
+    padding: 0.5em calc(15% - 3rem);
+    line-height: 1.6
+  }
+  aside.sidebar,
+  .marginal,
+  .admonition.marginal,
+  .topic.marginal {
+    max-width: 45%;
+    float: right;
+    clear: right;
+  }
+  dl.field-list > dd,
+  dl.docinfo > dd {
+    margin-left: 6em;
+  }
+  dl.option-list > dd {
+    margin-left: 6em;
+  }
+}
+
+/* 2 column layout with wide margin */
+@media (min-width: 65em) {
+  /* use the same grid for main, all sections, and figures */
+  main, section {
+    display: grid;
+    grid-template-columns: content minmax(0, 6fr)
+    			   margin 3fr end;
+    grid-column-gap: calc(3em + 1%);
+  }
+  main > section, section > section {
+    grid-column: 1 / end;
+  }
+  main, header, footer {
+    padding-right: 5%; /* less padding right of margin-column */
+  }
+  section > figure {
+    display: contents; /* to place caption in the margin */
+  }
+  /* Main text elements */
+  main > *, section > *,
+  figure > img,
+  .footnote.align-left, /* override the placement in the margin */
+  .citation.align-left {
+    grid-column: content;
+  }
+  .citation.align-left {
+    font-size: 1em;
+    padding-left: 1.5em;
+  }
+  .citation.align-left .label {
+    margin-left: -1.5em;
+  }
+  figure > img { /* indent */
+    margin: 0.5em 2%;
+    padding-left: 1em;
+  }
+
+  /* Margin Elements */
+  /* Sidebar, Footnotes, Citations, Captions */
+  aside.sidebar,
+  .citation,
+  .footnote,
+  figcaption,
+  /* table > caption,  does not work :(*/
+  .marginal,
+  .admonition.marginal,
+  .topic.marginal {
+    /* color: red; */
+    grid-column: margin;
+    width: auto;
+    max-width: 55em;
+    margin: 0.5em 0;
+    border: none;
+    padding: 0;
+    font-size: 0.8em;
+    text-align: initial; /* overwrite align-* */
+    background-color: inherit;
+  }
+  .admonition.marginal {
+    padding: 0.5em;
+  }
+  figure.marginal {
+    display: block;
+    margin: 0.5em 0;
+  }
+  .citation,
+  .footnote {
+    padding-left: 0;
+  }
+  .citation .label,
+  .footnote .label {
+    margin-left: 0;
+  }
+
+  /* Fullwidth Elements */
+  h1.title, p.subtitle,
+  dl.docinfo,
+  div.abstract,
+  div.dedication,
+  nav.contents,
+  aside.system-message,
+  pre,
+  .fullwidth,
+  .fullwidth img,
+  .fullwidth figcaption {
+    /* background-color: Linen; */
+    grid-column: content / end;
+    margin-right: calc(10% - 3rem);
+    max-width: 55em;
+  }
+}
+
+/* 3 column layout */
+
+@media (min-width: 100em) {
+  main, header, footer {
+    padding-left: 30%;
+  }
+  main > nav.contents {
+    position: fixed;
+    top: 0;
+    left: 0;
+    box-sizing: border-box;
+    width: 25%;
+    height: 100vh;
+    margin: 0;
+    background-color: #fafaf6;
+    padding: 5.5em 2%;
+    overflow: auto;
+  }
+  main > nav.contents > * {
+    padding-left: 0;
+  }
+}
+
+/* wrap URLs */
+/*   a:link {    */
+/*     white-space: normal; */
+/*     hyphens: none;	    */
+/*   }			    */

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/unicode.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/unicode.txt Changed

@@ -1,45 +1,46 @@
 Non-ASCII characters
---------------------
-
-Punctuation and footnote symbols
-
-= ===================================
-– en-dash
-— em-dash
-‘ single turned comma quotation mark
-’ single comma quotation mark
-‚ low single comma quotation mark
-“ double turned comma quotation mark
-” double comma quotation mark
-„ low double comma quotation mark
-† dagger
-‡ double dagger
-♦ black diamond suit
-♥ black heart suit
-♠ black spade suit
-♣ black club suit
-… ellipsis
-™ trade mark sign
-⇔ left-right double arrow
-= ===================================
-
-
-The `Latin-1 extended` Unicode block
-
-===  =  =  =  =  =  =  =  =  =  =
- ..  0  1  2  3  4  5  6  7  8  9
----  -  -  -  -  -  -  -  -  -  -
-160     ¡  ¢  £     ¥  ¦  §  ¨  ©
-170  ª  «  ¬    ®  ¯  °  ±  ²  ³
-180  ´  µ  ¶  ·  ¸  ¹  º  »  ¼  ½
-190  ¾  ¿  À  Á  Â  Ã  Ä  Å  Æ  Ç
-200  È  É  Ê  Ë  Ì  Í  Î  Ï  Ð  Ñ
-210  Ò  Ó  Ô  Õ  Ö  ×  Ø  Ù  Ú  Û
-220  Ü  Ý  Þ  ß  à  á  â  ã  ä  å
-230  æ  ç  è  é  ê  ë  ì  í  î  ï
-240  ð  ñ  ò  ó  ô  õ  ö  ÷  ø  ù
-250  ú  û  ü  ý  þ  ÿ
-===  =  =  =  =  =  =  =  =  =  =
+====================
+
+.. table:: Punctuation and footnote symbols
+   :widths: auto
+
+   = ===================================
+   – en-dash
+   — em-dash
+   ‘ single turned comma quotation mark
+   ’ single comma quotation mark
+   ‚ low single comma quotation mark
+   “ double turned comma quotation mark
+   ” double comma quotation mark
+   „ low double comma quotation mark
+   † dagger
+   ‡ double dagger
+   ♦ black diamond suit
+   ♥ black heart suit
+   ♠ black spade suit
+   ♣ black club suit
+   … ellipsis
+   ™ trade mark sign
+   ⇔ left-right double arrow
+   = ===================================
+
+.. table:: The `Latin-1 extended` Unicode block
+   :widths: auto
+
+   ===  =  =  =  =  =  =  =  =  =  =
+    ..  0  1  2  3  4  5  6  7  8  9
+   ---  -  -  -  -  -  -  -  -  -  -
+   160     ¡  ¢  £     ¥  ¦  §  ¨  ©
+   170  ª  «  ¬    ®  ¯  °  ±  ²  ³
+   180  ´  µ  ¶  ·  ¸  ¹  º  »  ¼  ½
+   190  ¾  ¿  À  Á  Â  Ã  Ä  Å  Æ  Ç
+   200  È  É  Ê  Ë  Ì  Í  Î  Ï  Ð  Ñ
+   210  Ò  Ó  Ô  Õ  Ö  ×  Ø  Ù  Ú  Û
+   220  Ü  Ý  Þ  ß  à  á  â  ã  ä  å
+   230  æ  ç  è  é  ê  ë  ì  í  î  ï
+   240  ð  ñ  ò  ó  ô  õ  ö  ÷  ø  ù
+   250  ú  û  ü  ý  þ  ÿ
+   ===  =  =  =  =  =  =  =  =  =  =
 
 * The following line should not be wrapped, because it uses
   no-break spaces (\\u00a0):

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/urls.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/urls.txt Changed

@@ -1,5 +1,5 @@
 External references
--------------------
+===================
 
 Long URLs should be wrapped in the PDF. This can be achieved with the
 ``\url`` command which is used by the LaTeX writer whenever the content
@@ -7,7 +7,7 @@
 
 Example:
   a long URL that should wrap in the output
-  http://docutils.sourceforge.net/docs/user/latex.html#id79
+  https://docutils.sourceforge.io/docs/user/latex.html#id79
 
 
 If the argument contains any "%", "#", or "^^", or ends with ``\``, it can't
@@ -16,7 +16,7 @@
 
 The characters ^, {, }, and ``\`` are invalid in a "http:" or "ftp:" URL
 and not recognized as part of it:
-  
+
 | http://www.example.org/strange^^name
 | http://www.example.org\\using\\DOS\\paths\\
 | http://www.example.org/XML/strange{n}ame
@@ -32,20 +32,20 @@
   | `URL with % <http://www.w3.org/XML/Schema%dev>`__
     http://example.org/Schema%dev
   | `file with DOS path`__ `A:DOS\\path\\`__
-  
+
   .. note:: These URLs are typeset inside a LaTeX command without error.
-  
+
     | http://www.w3.org/XML/Schema#dev
     | http://example.org/Schema%dev
     | `A:DOS\\path\\`__
 
-__  
-__  
+__
+__
 __ A:DOS\\path\\
 
 
 * ``^^`` LaTeX's special syntax for characters results in "strange" replacements
-  (both with ``\href`` and ``\url``). A warning is given.
+  (both with ``\href`` and ``\url``). The writer emits a warning.
 
   `file with ^^ <../strange^^name>`__:
   `<../strange^^name>`__
@@ -56,7 +56,7 @@
     `<../strange{name>`__
 
   while balanced braces are suported:
-  
+
   | `<../strange{n}ame>`__
   | `<../st{r}ange{n}ame>`__
   | `<../{st{r}ange{n}ame}>`__

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/data/video.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/data/video.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/footnotes.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/footnotes.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/latex_cornercases.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/latex_cornercases.txt Changed

@@ -1,11 +1,16 @@
-Some Tests for the LaTeX Writer
-===============================
+Additional Tests for the LaTeX Writer
+*************************************
 
-These tests contain unusual combinations of syntax elements which may cause
-trouble for the LaTeX writer but do not need to be tested with other writers.
+These tests contain syntax elements and combinations which may cause
+trouble for the LaTeX writer.
+
+.. contents::
+
+.. include:: data/section_titles.txt
+.. include:: data/option_lists.txt
 
 Block Quotes
-------------
+============
 
     This block quote comes directly after the section heading and is
     followed by a paragraph.
@@ -26,7 +31,7 @@
 
 
 More Block Quotes
------------------
+=================
 
     Block quote followed by a transition.
 
@@ -36,7 +41,7 @@
 
 
 Images
-------
+======
 
 Image with 20% width:
 
@@ -48,167 +53,9 @@
 .. image:: ../../../docs/user/rst/images/title.png
    :width: 100%
 
-
-Rowspanning tables
-------------------
-
-Several rowspanning cells in a table.
-
-Problem:
-
-In LaTeX, "overwritten" cells need to be defined as empty cells.
-
-Docutils (similarily to HTML) uses is the "Exchange Table Model" (also known
-as CALS tables, see docs/ref/soextblx.dtd) which defines only the remaining
-cells in a row "affected" by multirow cells.
-
-Therefore, visit_entry() is only called for the remaining cells and the
-LaTeX writer needs bookkeeping to write out the required number of extra
-'&'s.
-
-+-----+----------+----------+------+
-| 11  |       12 |       13 |  14  |
-+-----+----------+----------+------+
-| 21  | 2/3 2    |          |  24  |
-+-----+          |          +------+
-| 31  |          | 2…4 3    |  34  |
-+-----+----------+          +------+
-| 41  |       42 |          |  14  |
-+-----+----------+----------+------+
-
-+-------+-------+----+
-| 11    |    12 | 13 |
-+-------+-------+----+
-| 2/3 1 |       | 23 |
-|       |       +----+
-|       | 2/3 2 | 33 |
-+-------+-------+----+
-
-+-------+----+
-| 11    | 12 |
-+-------+----+
-| 2/3 1 | 22 |
-|       +----+
-|       | 32 |
-+-------+----+
-
-+----+--------+----+
-| 11 |    12  | 13 |
-+----+--------+----+
-| 21 | 2/3 2  | 23 |
-+----+        +----+
-| 31 |        | 33 |
-+----+--------+----+
-
-+----+--------+
-| 11 | 12     |
-+----+--------+
-| 21 | 2/3 1  |
-+----+        |
-| 31 |        |
-+----+--------+
-
-
-+----+--------+
-| 11 | 1/2 1  |
-+----+        |
-| 21 |        |
-+----+--------+
-| 31 | 32     |
-+----+--------+
-
-+----+------------+--------+
-| 11 | 1/2 2      |        |
-+----+            | 1/2 3  |
-| 21 |            |        |
-+----+------------+--------+
-
-+-------+----+--------+
-|       | 12 | 1/2 3  |
-| 1/2 3 +----+        |
-|       | 22 |        |
-+-------+----+--------+
-
-+-------+----+
-|       | 12 |
-| 1/2 3 +----+
-|       | 22 |
-+-------+----+
-| 31    | 32 |
-+-------+----+
-
-Nested tables
--------------
-
-TODO:
-Set alignment of nested tables without creating too much vertical space.
-
-+-----------------------------------------+-----------------+
-| Lorem ipsum dolor sit amet, consectetur | adipisicing elit|
-+-----------------------------------------+-----------------+
-| .. table::                              | cell 1, 2       |
-|                                         |                 |
-|     +-----+-----+                       |                 |
-|     |  1  |  2  |                       |                 |
-|     +-----+-----+                       |                 |
-+-----------------------------------------+-----------------+
-| .. table::                              | cell 1, 2       |
-|     :align: left                        |                 |
-|                                         |                 |
-|     +-----+-----+                       |                 |
-|     |  1  |  2  |                       |                 |
-|     +-----+-----+                       |                 |
-+-----------------------------------------+-----------------+
-| .. table::                              | cell 1, 2       |
-|     :align: center                      |                 |
-|                                         |                 |
-|     +-----+-----+                       |                 |
-|     |  1  |  2  |                       |                 |
-|     +-----+-----+                       |                 |
-+-----------------------------------------+-----------------+
-| .. table::                              | cell 1, 2       |
-|     :align: right                       |                 |
-|                                         |                 |
-|     +-----+-----+                       |                 |
-|     |  1  |  2  |                       |                 |
-|     +-----+-----+                       |                 |
-+-----------------------------------------+-----------------+
-| .. table::                              | cell 2, 2       |
-|     :align: right                       |                 |
-|                                         |                 |
-|     +-----+-----+                       |                 |
-|     |  1  |  2  |                       |                 |
-|     +-----+-----+                       |                 |
-|                                         |                 |
-| definition:                             |                 |
-|             list                        |                 |
-+-----------------------------------------+-----------------+
-|                                         |       cell 3, 2 |
-+-----------------------------------------+-----------------+
-
-.. table::
-  :class: booktabs
-
-  +-----------------------------------------+-----------------+
-  | Lorem ipsum dolor sit amet, consectetur | adipisicing elit|
-  +-----------------------------------------+-----------------+
-  | .. table::                              | cell 1, 2       |
-  |     :align: right                       |                 |
-  |                                         |                 |
-  |     +-----+-----+                       |                 |
-  |     |  1  |  2  |                       |                 |
-  |     +-----+-----+                       |                 |
-  +-----------------------------------------+-----------------+
-  | .. table::                              | cell 2, 2       |
-  |     :align: right                       |                 |
-  |                                         |                 |
-  |     +-----+-----+                       |                 |
-  |     |  1  |  2  |                       |                 |
-  |     +-----+-----+                       |                 |
-  |                                         |                 |
-  | definition:                             |                 |
-  |             list                        |                 |
-  +-----------------------------------------+-----------------+
-  |                                         |       cell 3, 2 |
-  +-----------------------------------------+-----------------+
-
+.. include:: data/tables_latex.txt
+.. include:: data/nonalphanumeric.txt
+.. include:: data/unicode.txt
+.. include:: data/latex_encoding.txt
+.. include:: data/hyperlinking.txt
+.. include:: data/urls.txt

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/latex_leavevmode.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/latex_leavevmode.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/latex_literal_block.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/latex_literal_block.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/misc_rst_html4css1.txt Added

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/misc_rst_html5.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_basic.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_basic.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_classifier.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_classifier.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_custom_headfoot.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_custom_headfoot.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_footnotes.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_footnotes.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_header_footer.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_header_footer.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/odt_literal_block.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/odt_literal_block.txt Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/input/rst_html5_tuftig.txt Added

@@ -0,0 +1,125 @@
+Special Features of the `tuftig.css` Stylesheet
+===============================================
+
+``tuftig.css`` is a CSS3_ style sheet for the output of Docutils'
+HTML5 writer. The rules are inspired by tufte.css_ and
+tufte-latex_ going back to Edward Tufte's layout design.
+
+.. tufte.css Dave Liepmann, `Tufte CSS`,
+   https://edwardtufte.github.io/tufte-css/.
+.. tufte-latex Bil Kleb, Bill Wood and Kevin Godby,
+                 `A Tufte-Style Book`,
+                 https://www.ctan.org/pkg/tufte-latex.
+
+.. _CSS3: http://www.w3.org/TR/CSS3
+
+
+Fullwidth and Margin Objects
+----------------------------
+
+.. class:: fullwidth
+
+Block elements (paragraphs, admonitions, topics, figures, tables, ...)
+with the "fullwidth" class argument use full text width.
+
+
+.. table:: A fullwidth table with LaTeX math commands
+  :class: numbered colwidths-auto fullwidth 
+
+  ========= ===========  ========= ===========  ============= ================
+  `\arccos` ``\arccos``  `\gcd`    ``\gcd``     `\Pr`         ``\Pr``
+  `\arcsin` ``\arcsin``  `\hom`    ``\hom``     `\projlim`    ``\projlim``
+  ========= ===========  ========= ===========  ============= ================
+
+.. figure:: ../../../docs/user/rst/images/title.svg
+   :alt: reStructuredText, the markup syntax
+   :width: 90%
+   :height: 1.5em
+   :figclass: numbered fullwidth
+
+   A numbered fullwidth figure.
+
+Block elements (admonitions, figures, tables, ...) with the
+"marginal" class argument are set in the right margin (if place permits).
+
+.. class:: marginal
+
+An ordinary paragraph with the "marginal" class argument.
+
+Tight integration of graphics with text is central to Tufte’s work
+even when those graphics are ancillary to the main body of a text. In
+many of those cases, a margin figure may be most appropriate.
+
+.. figure:: ../../../docs/user/rst/images/biohazard.png
+   :figclass: marginal numbered
+   :width: 2em
+
+   This is a marginal figure.
+
+   This is the legend.
+
+To place an image in the margin, use a marginal figure without caption.
+
+.. figure:: ../../../docs/user/rst/images/biohazard.png
+   :figclass: marginal
+   :width: 2em
+
+Marginal objects are placed to the right of the preceding main text
+block.
+
+.. Note:: This is a "note" type admonition with a block-quote inside.
+   :class: marginal
+
+      This is a silly text that is only there to
+      demonstrate line wrapping.
+
+By default, citations and footnotes are set in the margin.
+To have them in the main text area (like Testbook_ and tb98_ here),
+use the "align-left" class value.
+
+.. class:: align-left
+
+.. Testbook John Ex Ample, `How to test web pages`, Ontario, 1978.
+
+.. class:: align-left language-de
+
+.. tb98 Horst Schramm, `Docutils 0.5`, in Testberichte III,
+   Leipzig, 1998.
+
+.. table:: A marginal table
+   :widths: auto
+   :class: marginal
+
+   ======= ======= ==========
+   A       B       A or B
+   ======= ======= ==========
+   False   False   False
+   True    False   True
+   False   True    True
+   True    True    True
+   ======= ======= ==========
+
+.. class:: align-left
+
+.. #not-in-margin The "align-left" class value ensures this footnote is set
+   in the main text area.
+
+.. footer:: |HTML 5| |validator| |valid-CSS2|
+
+.. |HTML 5| image:: http://www.w3.org/html/logo/badge/html5-badge-h-css3-semantics.png
+   :height: 31
+   :width: 88
+   :alt: Conforms to HTML 5
+   :target: http://www.w3.org/TR/html5/
+
+.. |validator| image:: https://www.w3.org/Icons/ValidatorSuite/vs-blue-190.png
+   :height: 31
+   :width: 88
+   :alt: Check validity!
+   :target: http://validator.w3.org/check?uri=referer
+
+.. |valid-CSS2| image:: http://jigsaw.w3.org/css-validator/images/vcss
+   :height: 31
+   :width: 88
+   :alt: Valid CSS 2.1!
+   :target: http://jigsaw.w3.org/css-validator/check/referer

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/standalone_rst_latex.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/standalone_rst_latex.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/standalone_rst_manpage.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/standalone_rst_manpage.txt Changed

@@ -31,9 +31,9 @@
 * a goal, that is not met yet
 * a goal that might never be met, because only few constructs are
   used in man pages *and* because the common text file does not adhere
-  to man page requirements. 
-  
-  For example a unix man page belongs into a numbered section, 1 is 
+  to man page requirements.
+
+  For example a unix man page belongs into a numbered section, 1 is
   user commands, 8 contains administrator commands and the headlines
   of all manpages are collected into a database, queryable with the
   programm ``apropos``, therefore the headline should contain a short
@@ -59,7 +59,7 @@
 SEE ALSO
 ========
 
-`docutils <http://docutils.sourceforge.net>`__
+`docutils <https://docutils.sourceforge.io>`__
 `linux man page howto <http://tldp.org/HOWTO/Man-Page/>`__
 
 and ``man man`` also ``man 7 man``
@@ -67,12 +67,10 @@
 BUGS
 ====
 
-1. Format options are included as they are required. 
+1. Format options are included as they are required.
 2. bullet lists
 3. number lists
 4. math: The LaTeX source is shown, e.g. :math:`n! + \sin(x_n^2)`.
 
 
 Discussion is still open.
-
-

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/input/standalone_rst_xetex.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/input/standalone_rst_xetex.txt Changed

@@ -1,28 +1,5 @@
-.. include:: data/standard.txt
-.. currently not implemented in LaTeX:
-    .. include:: data/header_footer.txt
-.. include:: data/table_colspan.txt
-.. include:: data/table_rowspan.txt
-.. include:: data/list_table.txt
-.. include:: data/custom_roles.txt
-.. include:: data/math.txt
-
-Tests for the LaTeX writer
-==========================
-
-Test syntax elements which may cause trouble for the LaTeX writer but might
-not need to be tested with other writers (e.g. the HTML writer).
-
-.. include:: data/custom_roles_latex.txt
-.. include:: data/classes_latex.txt
-.. include:: data/tables_latex.txt
-.. include:: data/option_lists.txt
-.. include:: data/nonalphanumeric.txt
-.. include:: data/unicode.txt
-.. include:: data/latex_encoding.txt
-.. include:: data/hyperlinking.txt
-.. include:: data/urls.txt
-.. include:: data/section_titles.txt
+.. include:: standalone_rst_latex.txt
+   :end-before: preface for System Messages:
 
 Tests for the XeTeX writer
 ==========================
@@ -34,10 +11,10 @@
 Latviešu, Lietuvių, Македонски, Монгол, Nāhuatl, Português, Română,
 Русский, Slovenščina, Српски, Türkçe, Українська, Tiếng Việt, Volapük,
 Võro, ייִדיש , Žemaitėška.
-Currently, there is extended support for 28 languages in the
+There is extended support for more than 40 languages in the
 polyglossia_ package.
 
 .. _polyglossia: http://ctan.org/pkg/polyglossia
 
-.. System Messages:
+.. preface for System Messages:
 .. include:: data/errors.txt

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/compact_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/compact_lists.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/dangerous.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/dangerous.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/field_name_limit.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/field_name_limit.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/footnotes_html5.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/footnotes_html5.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_babel.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_babel.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_cornercases.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_cornercases.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_cyrillic.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_cyrillic.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_docinfo.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_docinfo.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_leavevmode.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_leavevmode.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_literal_block.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_literal_block.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_literal_block_fancyvrb.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_literal_block_fancyvrb.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_literal_block_listings.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_literal_block_listings.py Changed

@@ -1,19 +1,15 @@
-# Source and destination file names.
+# Source and destination file names
 test_source = "latex_literal_block.txt"
 test_destination = "latex_literal_block_listings.tex"
 
-# Keyword parameters passed to publish_file.
-reader_name = "standalone"
-parser_name = "rst"
+# Keyword parameters passed to publish_file()
 writer_name = "latex"
-
-# Extra setting we need
-settings_overrides'legacy_class_functions' = False
-settings_overrides'stylesheet' = 'docutils'
-settings_overrides'syntax_highlight' = 'none'
-
-settings_overrides'literal_block_env' = 'lstlisting'
-settings_overrides'latex_preamble' = r"""
+settings_overrides = {
+    'stylesheet': 'docutils',
+    'legacy_column_widths': True,
+    'use_latex_citations': False,
+    'literal_block_env': 'lstlisting',
+    'latex_preamble': r"""
 % PDF Standard Fonts
 \usepackage{mathptmx} % Times
 \usepackagescaled=.90{helvet}
@@ -21,4 +17,5 @@
 % LaTeX syntax highlight with "listings":
 \lstloadlanguages{LaTeXTeX} %  comma separated list of languages
 \newcommand{\DUCLASSlatex}{\lstset{language=LaTeXTeX}}
-"""
+""",
+}

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_literal_block_verbatim.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_literal_block_verbatim.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_literal_block_verbatimtab.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_literal_block_verbatimtab.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/latex_memoir.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/latex_memoir.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/math_output_html.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/math_output_html.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/math_output_latex.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/math_output_latex.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/math_output_mathjax.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/math_output_mathjax.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/math_output_mathml.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/math_output_mathml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/misc_rst_html4css1.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/misc_rst_html4css1.py Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/misc_rst_html5.py Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/pep_html.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/pep_html.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_docutils_xml.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_docutils_xml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_html4css1.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_html4css1.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_html5.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_html5.py Changed

_service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_html5_tuftig.py Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_latex.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_latex.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_manpage.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_manpage.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_pseudoxml.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_pseudoxml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_s5_html_1.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_s5_html_1.py Changed

@@ -1,60 +1,12 @@
-with open('functional/tests/_standalone_rst_defaults.py') as _f:
-    exec(_f.read())
-
 # Source and destination file names:
 test_source = 'standalone_rst_s5_html.txt'
 test_destination = 'standalone_rst_s5_html_1.html'
 
 # Keyword parameters passed to publish_file:
 writer_name = 's5_html'
-
-# Settings:
-settings_overrides'theme' = 'small-black'
-# local copy of default stylesheet:
-settings_overrides'stylesheet_path' = ( 
-    'functional/input/data/html4css1.css')
-
-
-# Extra functional tests.
-# Prefix all names with '_' to avoid confusing `docutils.core.publish_file`.
-
-import filecmp as _filecmp
-
-def _test_more(expected_dir, output_dir, test_case, parameters):
-    """Compare ``ui/<theme>`` directories."""
-    theme = settings_overrides.get('theme', 'default')
-    expected = '%s/%s/%s' % (expected_dir, 'ui', theme)
-    output = '%s/%s/%s' % (output_dir, 'ui', theme)
-    differences, uniques = _compare_directories(expected, output)
-    parts = 
-    if differences:
-        parts.append('The following files differ from the expected output:')
-        parts.extend(differences)
-        expected = path.replace('functional/output/', 'functional/expected/')
-                    for path in differences
-        parts.append('Please compare the expected and actual output files:')
-        parts.extend('  diff %s %s' % tup
-                      for tup in zip(expected, differences))
-        parts.append('If the actual output is correct, please replace the '
-                     'expected output files:')
-        parts.extend('  mv %s %s' % tup
-                      for tup in zip(differences, expected))
-        parts.append('and check them in to Subversion:')
-        parts.extend('  svn commit -m "<comment>" %s' % path
-                      for path in expected)
-    if uniques:
-        parts.append('The following paths are unique:')
-        parts.extend(uniques)
-    test_case.assertTrue(not parts, '\n'.join(parts))
-
-def _compare_directories(expected, output):
-    dircmp = _filecmp.dircmp(expected, output, '.svn', 'CVS')
-    differences = '%s/%s' % (output, name) for name in dircmp.diff_files
-    uniques = ('%s/%s' % (expected, name) for name in dircmp.left_only
-               + '%s/%s' % (output, name) for name in dircmp.right_only)
-    for subdir in dircmp.common_dirs:
-        diffs, uniqs = _compare_directories('%s/%s' % (expected, subdir),
-                                            '%s/%s' % (output, subdir))
-        differences.extend(diffs)
-        uniques.extend(uniqs)
-    return differences, uniques
+settings_overrides = {
+    'sectsubtitle_xform': True,
+    'theme': 'small-black',
+    # local copy of default stylesheet:
+    'stylesheet_path': 'functional/input/data/html4css1.css',
+    }

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_s5_html_2.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_s5_html_2.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/standalone_rst_xetex.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/standalone_rst_xetex.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/functional/tests/xetex_cyrillic.py -> _service:tar_scm:docutils-0.20.tar.gz/test/functional/tests/xetex_cyrillic.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/local-parser.py -> _service:tar_scm:docutils-0.20.tar.gz/test/local-parser.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/local-reader.py -> _service:tar_scm:docutils-0.20.tar.gz/test/local-reader.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/local-writer.py -> _service:tar_scm:docutils-0.20.tar.gz/test/local-writer.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/local_dummy_lang.py -> _service:tar_scm:docutils-0.20.tar.gz/test/local_dummy_lang.py Changed

@@ -1,11 +1,11 @@
-# $Id: local_dummy_lang.py 8452 2020-01-09 10:50:44Z milde $
+# $Id: local_dummy_lang.py 9030 2022-03-05 23:28:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 # New language mappings are welcome.  Before doing a new translation, please
-# read <http://docutils.sf.net/docs/howto/i18n.html>.  Two files must be
-# translated for each language: one in docutils/languages, the other in
-# docutils/parsers/rst/languages.
+# read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
+# Two files must be translated for each language: one in docutils/languages,
+# the other in docutils/parsers/rst/languages.
 
 """
 English-language mappings for language-dependent features of Docutils.
@@ -84,15 +84,15 @@
       'dummy-pull-quote': 'pull-quote',
       'dummy-compound': 'compound',
       'dummy-container': 'container',
-      #'dummy-questions': 'questions',
+      # 'dummy-questions': 'questions',
       'dummy-table': 'table',
       'dummy-csv-table': 'csv-table',
       'dummy-list-table': 'list-table',
-      #'dummy-qa': 'questions',
-      #'dummy-faq': 'questions',
+      # 'dummy-qa': 'questions',
+      # 'dummy-faq': 'questions',
       'dummy-meta': 'meta',
       'dummy-math': 'math',
-      #'dummy-imagemap': 'imagemap',
+      # 'dummy-imagemap': 'imagemap',
       'dummy-image': 'image',
       'dummy-figure': 'figure',
       'dummy-include': 'include',
@@ -109,10 +109,11 @@
       'dummy-section-numbering': 'sectnum',
       'dummy-header': 'header',
       'dummy-footer': 'footer',
-      #'dummy-footnotes': 'footnotes',
-      #'dummy-citations': 'citations',
+      # 'dummy-footnotes': 'footnotes',
+      # 'dummy-citations': 'citations',
       'dummy-target-notes': 'target-notes',
-      'dummy-restructuredtext-test-directive': 'restructuredtext-test-directive'}
+      'dummy-restructuredtext-test-directive': 'restructuredtext-test-directive',  # noqa: E501
+      }
 """English name to registered (in directives/__init__.py) directive name
 mapping."""
 
@@ -149,6 +150,6 @@
     'dummy uri-reference': 'uri-reference',
     'dummy uri': 'uri-reference',
     'dummy url': 'uri-reference',
-    'dummy raw': 'raw',}
+    'dummy raw': 'raw'}
 """Mapping of English role names to canonical role names for interpreted text.
 """

_service:tar_scm:docutils-0.20.tar.gz/test/svn-commit.tmp Added

_service:tar_scm:docutils-0.20.tar.gz/test/test_CLI.py Added

@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+# :Copyright: © 2022 Günter Milde.
+
+# :License: Released under the terms of the `2-Clause BSD license`_, in short:
+#
+#    Copying and distribution of this file, with or without modification,
+#    are permitted in any medium without royalty provided the copyright
+#    notice and this notice are preserved.
+#    This file is offered as-is, without any warranty.
+#
+# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+
+# :Id: $Id: test_CLI.py 9331 2023-03-25 17:54:40Z aa-turner $
+
+"""
+Test module for the command line interface.
+"""
+
+import difflib
+from io import StringIO
+import locale
+from pathlib import Path
+import os
+import re
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+from docutils import __main__, core
+
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = Path(__file__).parent / 'data'
+
+
+def print_mismatch(expected, output):
+    diff = ''.join(difflib.unified_diff(
+                       expected.splitlines(keepends=True),
+                       output.splitlines(keepends=True),
+                       'expected', 'output'))
+    raise AssertionError('Unexpected output:\n'+diff)
+
+
+class CliTests(unittest.TestCase):
+
+    def setUp(self):
+        # save state
+        self.orig_argv = sys.argv
+        self.orig_stdout = sys.stdout
+        os.environ'DOCUTILSCONFIG' = ''  # don't read config files
+        sys.stdout = StringIO()  # re-direct sys.stdout
+
+    def tearDown(self):
+        del os.environ'DOCUTILSCONFIG'
+        sys.stdout = self.orig_stdout
+        sys.argv = self.orig_argv
+        locale.setlocale(locale.LC_ALL, 'C')  # restore default (C) locale
+
+    def get_help_text(self, prog, entry_point):
+        # call entry_point function and collect help text
+        sys.argv = prog, '--help'
+        try:
+            entry_point()
+        except SystemExit:
+            pass
+        output = sys.stdout.getvalue()
+        # replace unpredictable paths (eventually wrapped)
+        output = re.sub(r'default:^)*/\\^)*\)', 'default: ...)',
+                        output, flags=re.DOTALL)
+        # normalise error encoding default
+        output = output.replace(
+            f'{core.OptionParser.default_error_encoding}:backslashreplace',
+            'utf-8:backslashreplace')
+        return output
+
+    def test_main_help(self):
+        # collect help text
+        output = self.get_help_text('docutils', __main__.main)
+
+        # compare to stored version
+        docutils_txt = os.path.join(DATA_ROOT, 'help/docutils.txt')
+        with open(docutils_txt, encoding='utf-8') as samplefile:
+            expected = samplefile.read()
+        if expected != output:
+            print_mismatch(expected, output)
+
+    def test_rst2html_help(self):
+        # collect help text
+        output = self.get_help_text('rst2html', core.rst2html)
+        # compare to stored version
+        rst2html_txt = os.path.join(DATA_ROOT, 'help/rst2html.txt')
+        with open(rst2html_txt, encoding='utf-8') as samplefile:
+            expected = samplefile.read()
+        if expected != output:
+            print_mismatch(expected, output)
+
+    def test_rst2latex_help(self):
+        # collect help text
+        output = self.get_help_text('rst2latex', core.rst2latex)
+        # compare to stored version
+        rst2latex_txt = os.path.join(DATA_ROOT, 'help/rst2latex.txt')
+        with open(rst2latex_txt, encoding='utf-8') as samplefile:
+            expected = samplefile.read()
+        if expected != output:
+            print_mismatch(expected, output)
+
+
+if __name__ == '__main__':
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test__init__.py Changed

@@ -1,7 +1,6 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-# $Id: test__init__.py 8468 2020-01-26 22:08:13Z milde $
-# Authors: Günter Milde <milde@users.sourceforge.net>,
+#! /usr/bin/env python3
+# $Id: test__init__.py 9291 2022-12-01 21:13:16Z milde $
+# Authors: Günter Milde <milde@users.sf.net>,
 #          David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,27 +8,29 @@
 Test module for the docutils' __init__.py.
 """
 
-import unittest
+from pathlib import Path
 import sys
-import DocutilsTestSupport              # must be imported before docutils
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
 import docutils
 import docutils.utils
 from docutils import VersionInfo
 
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
 class ApplicationErrorTests(unittest.TestCase):
 
     def test_message(self):
         err = docutils.ApplicationError('the message')
-        self.assertEqual(unicode(err), u'the message')
+        self.assertEqual(str(err), 'the message')
 
     def test_non_ASCII_message(self):
-        err = docutils.ApplicationError(u'\u0169')
-        self.assertEqual(unicode(err), u'\u0169')
+        err = docutils.ApplicationError('\u0169')
+        self.assertEqual(str(err), '\u0169')
 
 
 class VersionInfoTests(unittest.TestCase):
@@ -38,13 +39,13 @@
         # arguments may use keywords
         self.assertEqual(VersionInfo(0, 1, 2, 'beta', 3, False),
                          VersionInfo(major=0, minor=1, micro=2,
-                                     releaselevel='beta', serial=3, 
+                                     releaselevel='beta', serial=3,
                                      release=False))
         # check defaults:
         self.assertEqual(VersionInfo(),
                          VersionInfo(0, 0, 0, releaselevel='final',
                                      serial=0, release=True))
-        
+
     def test_VersionInfo_value_check(self):
         # releaselevel must be one of ('alpha', 'beta', 'candidate', 'final')
         with self.assertRaises(ValueError):
@@ -69,12 +70,11 @@
         self.assertEqual(type(docutils.__version_info__.serial), int)
         self.assertEqual(type(docutils.__version_info__.release), bool)
 
-
     def test__version__(self):
         """Test that __version__ is equivalent to __version_info__."""
         self.assertEqual(
             docutils.utils.version_identifier(docutils.__version_info__),
-            docutils.__version__)
+            docutils.__version__, f'{docutils.__version_info__} differs')
 
     def test_version_info_comparing(self):
         """Test comparing of __version_info__ instances."""
@@ -102,7 +102,7 @@
                         VersionInfo(0, 2, 0, 'beta', 0, False),
                         VersionInfo(0, 2, 0, 'beta', 0, True),
                         VersionInfo(0, 2, 0, 'final', 0, True),
-                       
+                        
         # transform to version strings
         versions = docutils.utils.version_identifier(vinfo)
                     for vinfo in versioninfos
@@ -115,9 +115,9 @@
         """Test comparing of __version_info__ instances to tuples."""
 
         # {<version string>: <version info>}
-        v01b =      VersionInfo(0, 1, 0, 'beta', 0, True)
-        v01 =       VersionInfo(0, 1, 0, 'final', 0, True)
-        v02b_dev =  VersionInfo(0, 2, 0, 'beta', 0, False)
+        v01b = VersionInfo(0, 1, 0, 'beta', 0, True)
+        v01 = VersionInfo(0, 1, 0, 'final', 0, True)
+        v02b_dev = VersionInfo(0, 2, 0, 'beta', 0, False)
 
         # compare to ordinary tuples:
         self.assertTrue(v01b < (0, 2))

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_dependencies.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_dependencies.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_dependencies.py 8357 2019-08-26 16:44:51Z milde $
+# $Id: test_dependencies.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,68 +8,90 @@
 Test module for the --record-dependencies option.
 """
 
-import csv
+from io import StringIO
+from pathlib import Path
 import os.path
+import sys
 import unittest
-import DocutilsTestSupport              # must be imported before docutils
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
 import docutils.core
 import docutils.utils
 import docutils.io
 from docutils.parsers.rst.directives.images import PIL
 
-# docutils.utils.DependencyList records POSIX paths,
-# i.e. "/" as a path separator even on Windows (not os.path.join).
-paths = {'include': u'data/include.txt',  # included rst file
-         'raw':     u'data/raw.txt',      # included raw "HTML file"
-         'scaled-image': u'../docs/user/rst/images/biohazard.png',
-         'figure-image': u'../docs/user/rst/images/title.png',
-         'stylesheet':   u'data/stylesheet.txt',
-        }
+TEST_ROOT = Path(__file__).parent  # ./test/ from the docutils root
+DATA_ROOT = TEST_ROOT / 'data'
+CWD = Path(os.getcwd())
+
+
+def relpath(path):
+    # docutils.utils.DependencyList records POSIX paths,
+    # i.e. "/" as a path separator even on Windows.
+    return os.path.relpath(path, CWD).replace('\\', '/')
+
+
+paths = {
+    'include': relpath(DATA_ROOT / 'include.txt'),  # included rst file
+    'raw': relpath(DATA_ROOT / 'raw.txt'),      # included raw "HTML file"
+    'stylesheet': relpath(DATA_ROOT / 'stylesheet.txt'),
+    # the "image" and "figure" directives expect a URI and use it literally
+    'scaled-image': '../docs/user/rst/images/biohazard.png',
+    'figure-image': '../docs/user/rst/images/title.png',
+}
+
+# avoid latex writer future warnings:
+latex_settings_overwrites = {'legacy_column_widths': False,
+                             'use_latex_citations': True}
 
 
 class RecordDependenciesTests(unittest.TestCase):
 
-    def get_record(self, **settings):
+    maxDiff = None
+
+    def get_record(self, **kwargs):
         recordfile = 'record.txt'
         recorder = docutils.utils.DependencyList(recordfile)
         # (Re) create the record file by running a conversion:
-        settings.setdefault('source_path',
-                            os.path.join('data', 'dependencies.txt'))
-        settings.setdefault('settings_overrides', {})
-        settings'settings_overrides'.update(_disable_config=True,
-                                              record_dependencies=recorder)
-        docutils.core.publish_file(destination=DocutilsTestSupport.DevNull(),
-                                   **settings)
+        kwargs.setdefault('source_path', str(DATA_ROOT/'dependencies.txt'))
+        kwargs.setdefault('settings_overrides', {})
+        kwargs'settings_overrides'.update(_disable_config=True,
+                                            record_dependencies=recorder)
+        output = docutils.core.publish_file(destination=StringIO(),  # ignored
+                                            **kwargs)
         recorder.close()
         # Read the record file:
-        record = docutils.io.FileInput(source_path=recordfile,
-                                       encoding='utf8')
-        return record.read().splitlines()
+        with open(recordfile, encoding='utf-8') as record:
+            return record.read().splitlines(), output
 
-    def test_dependencies(self):
+    def test_dependencies_xml(self):
         # Note: currently, raw input files are read (and hence recorded) while
         # parsing even if not used in the chosen output format.
         # This should change (see parsers/rst/directives/misc.py).
         keys = 'include', 'raw'
-        if PIL:
+        if PIL and TEST_ROOT == CWD:
             keys += 'figure-image'
         expected = pathskey for key in keys
-        record = sorted(self.get_record(writer_name='xml'))
+        record, output = self.get_record(writer_name='xml')
         # the order of the files is arbitrary
-        expected.sort()
-        self.assertEqual(record, expected)
+        self.assertEqual(sorted(record), sorted(expected))
 
     def test_dependencies_html(self):
         keys = 'include', 'raw'
-        if PIL:
+        if PIL and (TEST_ROOT == CWD):
             keys += 'figure-image', 'scaled-image'
         expected = pathskey for key in keys
         # stylesheets are tested separately in test_stylesheet_dependencies():
-        so = {'stylesheet_path': None, 'stylesheet': None}
-        record = sorted(self.get_record(writer_name='html', settings_overrides=so))
+        settings = {'stylesheet_path': None, 'stylesheet': None}
+        record, output = self.get_record(writer_name='html5',
+                                         settings_overrides=settings)
         # the order of the files is arbitrary
-        expected.sort()
-        self.assertEqual(record, expected)
+        self.assertEqual(sorted(record), sorted(expected),
+                         msg='output is:\n'+output)
 
     def test_dependencies_latex(self):
         # since 0.9, the latex writer records only really accessed files, too.
@@ -77,39 +99,50 @@
         # parsing even if not used in the chosen output format.
         # This should change (see parsers/rst/directives/misc.py).
         keys = 'include', 'raw'
-        if PIL:
+        if PIL and TEST_ROOT == CWD:
             keys += 'figure-image'
         expected = pathskey for key in keys
-        record = sorted(self.get_record(writer_name='latex'))
+        record, output = self.get_record(
+                            writer_name='latex',
+                            settings_overrides=latex_settings_overwrites)
         # the order of the files is arbitrary
-        expected.sort()
-        self.assertEqual(record, expected)
+        self.assertEqual(sorted(record), sorted(expected),
+                         msg='output is:\n'+output)
 
     def test_csv_dependencies(self):
-        csvsource = os.path.join('data', 'csv_dep.txt')
-        self.assertEqual(self.get_record(source_path=csvsource),
-                         'data/csv_data.txt')
+        csvsource = str(DATA_ROOT / 'csv_dep.txt')
+        record, output = self.get_record(source_path=csvsource)
+        self.assertEqual(record, relpath(DATA_ROOT / 'csv_data.txt'),
+                         msg='output is:\n'+output)
 
     def test_stylesheet_dependencies(self):
         stylesheet = paths'stylesheet'
-        so = {'stylesheet_path': paths'stylesheet',
-              'stylesheet': None}
-
-        so'embed_stylesheet' = False
-        record = self.get_record(writer_name='html', settings_overrides=so)
+        settings = {'stylesheet_path': paths'stylesheet',
+                    'stylesheet': None}
+        settings.update(latex_settings_overwrites)
+        settings'embed_stylesheet' = False
+        record, output = self.get_record(writer_name='html',
+                                         settings_overrides=settings)
         self.assertTrue(stylesheet not in record,
-                     '%r should not be in %r' % (stylesheet, record))
-        record = self.get_record(writer_name='latex', settings_overrides=so)
+                        f'{stylesheet!r} should not be in {record!r}')
+        record, output = self.get_record(writer_name='latex',
+                                         settings_overrides=settings)
         self.assertTrue(stylesheet not in record,
-                     '%r should not be in %r' % (stylesheet, record))
+                        f'{stylesheet!r} should not be in {record!r}')
 
-        so'embed_stylesheet' = True
-        record = self.get_record(writer_name='html', settings_overrides=so)
+        settings'embed_stylesheet' = True
+        record, output = self.get_record(writer_name='html',
+                                         settings_overrides=settings)
         self.assertTrue(stylesheet in record,
-                     '%r should be in %r' % (stylesheet, record))
-        record = self.get_record(writer_name='latex', settings_overrides=so)
+                        f'{stylesheet!r} should be in {record!r}')
+        settings'embed_stylesheet' = True
+        record, output = self.get_record(writer_name='latex',
+                                         settings_overrides=settings)
         self.assertTrue(stylesheet in record,
-                     '%r should be in %r' % (stylesheet, record))
+                        f'{stylesheet!r} should be in {record!r}')
+
+    def tearDown(self) -> None:
+        os.unlink("record.txt")
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_error_reporting.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_error_reporting.py Changed

@@ -1,7 +1,6 @@
-#! /usr/bin/env python
-# .. coding: utf-8
-# $Id: test_error_reporting.py 8367 2019-08-27 12:09:56Z milde $
-# Author: Günter Milde <milde@users.sourceforge.net>
+#! /usr/bin/env python3
+# $Id: test_error_reporting.py 9277 2022-11-26 23:15:13Z milde $
+# Author: Günter Milde <milde@users.sf.net>
 # Copyright: This module has been placed in the public domain.
 
 """
@@ -24,66 +23,32 @@
 
 unless the minimal required Python version has this problem fixed.
 """
-from __future__ import print_function
 
-import os
+from io import StringIO, BytesIO
+from pathlib import Path
 import sys
 import unittest
-from io import StringIO, BytesIO
+import warnings
 
-import DocutilsTestSupport              # must be imported before docutils
-from docutils import core, parsers, frontend, utils
-from docutils.utils.error_reporting import SafeString, ErrorString, ErrorOutput
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
 
+from docutils import frontend, utils
+import docutils.parsers.rst
+warnings.filterwarnings('ignore', category=DeprecationWarning,
+                        module='.*error_reporting')
+from docutils.utils.error_reporting import SafeString, ErrorString, ErrorOutput  # noqa: E402, E501
 
-oldlocale = None
-if sys.version_info < (3, 0):  # problems solved in py3k
-    try:
-        import locale  # module missing in Jython
-        oldlocale = locale.getlocale()
-    except ImportError:
-        print('cannot test error reporting with problematic locales,\n'
-              '`import locale` failed.')
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
-# locales confirmed to use non-ASCII chars in the IOError message
-# for a missing file (https://bugs.gentoo.org/show_bug.cgi?id=349101)
-# TODO: add more confirmed problematic locales
-problematic_locales = 'cs_CZ', 'cs_CZ.UTF8',
-                       'el_GR', 'el_GR.UTF-8',
-                       # 'fr_FR.UTF-8', # only OSError
-                       'ja_JP.UTF-8',
-                       'ru_RU', 'ru_RU.KOI8-R',
-                       'ru_RU.UTF-8',
-                       '',  # default locale: might be non-problematic
-                       
-
-if oldlocale is not None:
-    # find a supported problematic locale:
-    for testlocale in problematic_locales:
-        try:
-            locale.setlocale(locale.LC_ALL, testlocale)
-        except locale.Error:
-            testlocale = None
-        else:
-            break
-    locale.setlocale(locale.LC_ALL, oldlocale) # reset
-else:
-    testlocale = None
 
 class SafeStringTests(unittest.TestCase):
-    # the error message in EnvironmentError instances comes from the OS
-    # and in some locales (e.g. ru_RU), contains high bit chars.
-    # -> see the test in test_error_reporting.py
 
     # test data:
-    bs = b'\xfc'     # unicode(bs) fails, str(bs) in Python 3 return repr()
-    us = u'\xfc'       # bytes(us) fails; str(us) fails in Python 2
-    be = Exception(bs) # unicode(be) fails
-    ue = Exception(us) # bytes(ue) fails, str(ue) fails in Python 2;
+    bs = b'\xc3\xbc'   # str(bs) returns repr(bs)
+    us = u'\xfc'       # bytes(us) fails (requires encoding argument)
+    be = Exception(bs)
+    ue = Exception(us) # bytes(ue) fails
     # wrapped test data:
     wbs = SafeString(bs)
     wus = SafeString(us)
@@ -97,40 +62,35 @@
         us7 = u'foo'
         be7 = Exception(bs7)
         ue7 = Exception(us7)
-        self.assertEqual(str(42), str(SafeString(42)))
         self.assertEqual(str(bs7), str(SafeString(bs7)))
         self.assertEqual(str(us7), str(SafeString(us7)))
         self.assertEqual(str(be7), str(SafeString(be7)))
         self.assertEqual(str(ue7), str(SafeString(ue7)))
-        self.assertEqual(unicode(7), unicode(SafeString(7)))
-        self.assertEqual(unicode(bs7), unicode(SafeString(bs7)))
-        self.assertEqual(unicode(us7), unicode(SafeString(us7)))
-        self.assertEqual(unicode(be7), unicode(SafeString(be7)))
-        self.assertEqual(unicode(ue7), unicode(SafeString(ue7)))
 
     def test_ustr(self):
         """Test conversion to a unicode-string."""
         # unicode(self.bs) fails
-        self.assertEqual(unicode, type(unicode(self.wbs)))
-        self.assertEqual(unicode(self.us), unicode(self.wus))
+        self.assertEqual(str, type(str(self.wbs)))
+        self.assertEqual(str(self.us), str(self.wus))
         # unicode(self.be) fails
-        self.assertEqual(unicode, type(unicode(self.wbe)))
-        self.assertEqual(unicode, type(unicode(self.ue)))
-        self.assertEqual(unicode, type(unicode(self.wue)))
-        self.assertEqual(self.us, unicode(self.wue))
+        self.assertEqual(str, type(str(self.wbe)))
+        self.assertEqual(str, type(str(self.ue)))
+        self.assertEqual(str, type(str(self.wue)))
+        self.assertEqual(self.us, str(self.wue))
 
     def test_str(self):
-        """Test conversion to a string (bytes in Python 2, unicode in Python 3)."""
+        """Test conversion to a string
+
+        (bytes in Python 2, unicode in Python 3).
+        """
         self.assertEqual(str(self.bs), str(self.wbs))
-        self.assertEqual(str(self.be), str(self.be))
-        # str(us) fails in Python 2
-        self.assertEqual(str, type(str(self.wus)))
-        # str(ue) fails in Python 2
-        self.assertEqual(str, type(str(self.wue)))
+        self.assertEqual(str(self.be), str(self.wbe))
+        self.assertEqual(str(self.us), str(self.wus))
+        self.assertEqual(str(self.ue), str(self.wue))
 
 
 class ErrorStringTests(unittest.TestCase):
-    bs = b'\xfc'     # unicode(bs) fails, str(bs) in Python 3 return repr()
+    bs = b'\xc3\xbc' # unicode(bs) fails, str(bs) in Python 3 return repr()
     us = u'\xfc'     # bytes(us) fails; str(us) fails in Python 2
 
     def test_str(self):
@@ -143,11 +103,11 @@
 
     def test_unicode(self):
         self.assertEqual(u'Exception: spam',
-                         unicode(ErrorString(Exception(u'spam'))))
+                         str(ErrorString(Exception(u'spam'))))
         self.assertEqual(u'IndexError: '+self.us,
-                         unicode(ErrorString(IndexError(self.us))))
+                         str(ErrorString(IndexError(self.us))))
         self.assertEqual(u'ImportError: %s' % SafeString(self.bs),
-                         unicode(ErrorString(ImportError(self.bs))))
+                         str(ErrorString(ImportError(self.bs))))
 
 
 # ErrorOutput tests
@@ -156,10 +116,11 @@
 # Stub: Buffer with 'strict' auto-conversion of input to byte string:
 class BBuf(BytesIO):
     def write(self, data):
-        if isinstance(data, unicode):
+        if isinstance(data, str):
             data.encode('ascii', 'strict')
         super(BBuf, self).write(data)
 
+
 # Stub: Buffer expecting unicode string:
 class UBuf(StringIO):
     def write(self, data):
@@ -168,6 +129,7 @@
             raise TypeError('must be unicode, not bytes')
         super(UBuf, self).write(data)
 
+
 class ErrorOutputTests(unittest.TestCase):
     def test_defaults(self):
         e = ErrorOutput()
@@ -187,7 +149,7 @@
         e.write(AttributeError(u' e\xfc'))
         self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc e\\xfc')
         # encode with `encoding` attribute
-        e.encoding = 'utf8'
+        e.encoding = 'utf-8'
         e.write(u' u\xfc')
         self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc e\\xfc u\xc3\xbc')
 
@@ -196,7 +158,7 @@
         # decode of binary strings
         e = ErrorOutput(buf, encoding='ascii')
         e.write(b'b\xfc')
-        self.assertEqual(buf.getvalue(), u'b\ufffd') # use REPLACEMENT CHARACTER
+        self.assertEqual(buf.getvalue(), u'b\ufffd') # REPLACEMENT CHARACTER
         # write Unicode string and Exceptions with Unicode args
         e.write(u' u\xfc')
         self.assertEqual(buf.getvalue(), u'b\ufffd u\xfc')
@@ -208,7 +170,6 @@
         self.assertEqual(buf.getvalue(), u'b\ufffd u\xfc e\xfc b\xfc')
 
 
-
 class SafeStringTests_locale(unittest.TestCase):
     """
     Test docutils.SafeString with 'problematic' locales.
@@ -216,13 +177,11 @@
     The error message in `EnvironmentError` instances comes from the OS
     and in some locales (e.g. ru_RU), contains high bit chars.
     """
-    if testlocale:
-        locale.setlocale(locale.LC_ALL, testlocale)
     # test data:
-    bs = b'\xfc'
+    bs = b'\xc3\xbc'
     us = u'\xfc'
     try:
-        open(b'\xfc')
+        open(b'\xc3\xbc')
     except IOError as e: # in Python 3 the name for the exception instance
         bioe = e       # is local to the except clause
     try:
@@ -234,45 +193,35 @@
             open(u'\xfc'.encode(sys.getfilesystemencoding(), 'replace'))
         except IOError as e:
             uioe = e
-    try:
-        os.chdir(b'\xfc')
-    except OSError as e:
-        bose = e
-    try:
-        os.chdir(u'\xfc')
-    except OSError as e:
-        uose = e
-    except UnicodeEncodeError:
-        try:
-            os.chdir(u'\xfc'.encode(sys.getfilesystemencoding(), 'replace'))
-        except OSError as e:
-            uose = e
+    bose = FileNotFoundError(2, 'The system cannot find the file specified')
+    bose.filename = b'\xc3\xbc'
+    uose = FileNotFoundError(2, 'The system cannot find the file specified')
+    uose.filename = '\xfc'
     # wrapped test data:
     wbioe = SafeString(bioe)
     wuioe = SafeString(uioe)
     wbose = SafeString(bose)
     wuose = SafeString(uose)
-    # reset locale
-    if testlocale:
-        locale.setlocale(locale.LC_ALL, oldlocale)
 
     def test_ustr(self):
         """Test conversion to a unicode-string."""
         # unicode(bioe) fails with e.g. 'ru_RU.utf8' locale
-        self.assertEqual(unicode, type(unicode(self.wbioe)))
-        self.assertEqual(unicode, type(unicode(self.wuioe)))
-        self.assertEqual(unicode, type(unicode(self.wbose)))
-        self.assertEqual(unicode, type(unicode(self.wuose)))
+        self.assertEqual(str, type(str(self.wbioe)))
+        self.assertEqual(str, type(str(self.wuioe)))
+        self.assertEqual(str, type(str(self.wbose)))
+        self.assertEqual(str, type(str(self.wuose)))
 
     def test_str(self):
-        """Test conversion to a string (bytes in Python 2, unicode in Python 3)."""
+        """Test conversion to a string
+
+        (bytes in Python 2, unicode in Python 3).
+        """
         self.assertEqual(str(self.bioe), str(self.wbioe))
         self.assertEqual(str(self.uioe), str(self.wuioe))
         self.assertEqual(str(self.bose), str(self.wbose))
         self.assertEqual(str(self.uose), str(self.wuose))
 
 
-
 class ErrorReportingTests(unittest.TestCase):
     """
     Test cases where error reporting can go wrong.
@@ -284,26 +233,17 @@
     # These tests fail with a 'problematic locale',
     # Docutils revision < 7035, and Python 2:
 
-    parser = parsers.rst.Parser()
+    parser = docutils.parsers.rst.Parser()
     """Parser shared by all ParserTestCases."""
 
-    option_parser = frontend.OptionParser(components=(parsers.rst.Parser,))
-    settings = option_parser.get_default_values()
+    settings = frontend.get_default_settings(parser)
     settings.report_level = 1
     settings.halt_level = 1
     settings.warning_stream = ''
     document = utils.new_document('test data', settings)
 
-    def setUp(self):
-        if testlocale:
-            locale.setlocale(locale.LC_ALL, testlocale)
-
-    def tearDown(self):
-        if testlocale:
-            locale.setlocale(locale.LC_ALL, oldlocale)
-
     def test_include(self):
-        source = ('.. include:: bogus.txt')
+        source = '.. include:: bogus.txt'
         self.assertRaises(utils.SystemMessage,
                           self.parser.parse, source, self.document)
 
@@ -319,5 +259,6 @@
         self.assertRaises(utils.SystemMessage,
                           self.parser.parse, source, self.document)
 
+
 if __name__ == '__main__':
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_functional.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_functional.py Changed

@@ -1,197 +1,122 @@
-#!/usr/bin/env python
-
-# $Id: test_functional.py 8534 2020-08-10 09:47:47Z grubert $
+#!/usr/bin/env python3
+# $Id: test_functional.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Perform tests with the data in the functional/ directory.
 
-Read README.txt for details on how this is done.
+Please see the documentation on `functional testing`__ for details.
+
+__ ../../docs/dev/testing.html#functional
 """
-from __future__ import print_function
 
-import sys
-import os
-import os.path
+from pathlib import Path
 import shutil
+import sys
 import unittest
-import difflib
-import DocutilsTestSupport              # must be imported before docutils
-import docutils
-import docutils.core
-
-
-datadir = 'functional'
-"""The directory to store the data needed for the functional tests."""
-
-
-def join_path(*args):
-    return '/'.join(args) or '.'
-
-
-class FunctionalTestSuite(DocutilsTestSupport.CustomTestSuite):
-
-    """Test suite containing test cases for all config files."""
-
-    def __init__(self):
-        """Process all config files in functional/tests/."""
-        DocutilsTestSupport.CustomTestSuite.__init__(self)
-        os.chdir(DocutilsTestSupport.testroot)
-        self.clear_output_directory()
-        self.added = 0
-        for root, dirs, files in os.walk(join_path(datadir, 'tests')):
-            # Process all config files among `names` in `dirname`. A config
-            # file is a Python file (*.py) which sets several variables.
-            for name in files:
-                if name.endswith('.py') and not name.startswith('_'):
-                    config_file_full_path = join_path(root, name)
-                    self.addTestCase(FunctionalTestCase, 'test', None, None,
-                                     id=config_file_full_path,
-                                     configfile=config_file_full_path)
-                    self.added += 1
-        assert self.added, 'No functional tests found.'
-
-    def clear_output_directory(self):
-        files = os.listdir(os.path.join('functional', 'output'))
-        for f in files:
-            if f in ('README.txt', '.svn', 'CVS'):
-                continue                # don't touch the infrastructure
-            path = os.path.join('functional', 'output', f)
-            if os.path.isdir(path):
-                shutil.rmtree(path)
-            else:
-                os.remove(path)
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
 
-class FunctionalTestCase(DocutilsTestSupport.CustomTestCase):
+from docutils import core, SettingsSpec
 
-    """Test case for one config file."""
+FUNCTIONAL = Path('functional')
+EXPECTED = FUNCTIONAL / 'expected'
+INPUT = FUNCTIONAL / 'input'
+OUTPUT = FUNCTIONAL / 'output'
+TESTS = FUNCTIONAL / 'tests'
 
-    no_expected_template = """\
-Cannot find expected output at %(exp)s
-If the output in %(out)s
+NO_EXPECTED_TEMPLATE = """\
+Cannot find expected output at {exp}
+If the output in {out}
 is correct, move it to the expected/ dir and check it in:
 
-  mv %(out)s %(exp)s
-  svn add %(exp)s
-  svn commit -m "<comment>" %(exp)s"""
+  mv {out} {exp}
+  svn add {exp}
+  svn commit -m "<comment>" {exp}
+"""
 
-    expected_output_differs_template = """\
+EXPECTED_OUTPUT_DIFFERS_TEMPLATE = """\
 The expected and actual output differs.
 Please compare the expected and actual output files:
 
-  diff %(exp)s %(out)s\n'
+  diff {exp} {out}
 
 If the actual output is correct, please replace the
 expected output and check it in:
 
-  mv %(out)s %(exp)s
-  svn add %(exp)s
-  svn commit -m "<comment>" %(exp)s"""
-
-    def __init__(self, *args, **kwargs):
-        """Set self.configfile, pass arguments to parent __init__."""
-        self.configfile = kwargs'configfile'
-        del kwargs'configfile'
-        DocutilsTestSupport.CustomTestCase.__init__(self, *args, **kwargs)
-
-    def shortDescription(self):
-        return 'test_functional.py: ' + self.configfile
-
-    def test(self):
-        """Process self.configfile."""
-        os.chdir(DocutilsTestSupport.testroot)
-        # Keyword parameters for publish_file:
-        namespace = {}
-        # Initialize 'settings_overrides' for test settings scripts,
-        # and disable configuration files:
-        namespace'settings_overrides' = {'_disable_config': True}
-        # Read the variables set in the default config file and in
-        # the current config file into namespace:
-        with open(join_path(datadir, 'tests', '_default.py')) as f:
-            defaultpy = f.read()
-            exec(defaultpy, namespace)
-        with open(self.configfile) as f:
-            exec(f.read(), namespace)
-        # Check for required settings:
-        assert 'test_source' in namespace,\
-               "No 'test_source' supplied in " + self.configfile
-        assert 'test_destination' in namespace,\
-               "No 'test_destination' supplied in " + self.configfile
-        # Set source_path and destination_path if not given:
-        namespace.setdefault('source_path',
-                             join_path(datadir, 'input',
-                                       namespace'test_source'))
-        # Path for actual output:
-        namespace.setdefault('destination_path',
-                             join_path(datadir, 'output',
-                                       namespace'test_destination'))
-        # Path for expected output:
-        expected_path = join_path(datadir, 'expected',
-                                  namespace'test_destination')
-        # shallow copy of namespace to minimize:
-        params = namespace.copy()
-        # remove unneeded parameters:
-        del params'test_source'
-        del params'test_destination'
-        # Delete private stuff like params'__builtins__':
-        for key in list(params.keys()):
-            if key.startswith('_'):
-                del paramskey
-        # Get output (automatically written to the output/ directory
-        # by publish_file):
-        output = docutils.core.publish_file(**params)
-        # ensure output is unicode
-        output_encoding = params.get('output_encoding', 'utf-8')
-        if sys.version_info < (3, 0):
-            try:
-                output = output.decode(output_encoding)
-            except UnicodeDecodeError:
-                # failsafe
-                output = output.decode('latin1', 'replace')
-        # Normalize line endings:
-        output = '\n'.join(output.splitlines())
-        # Get the expected output *after* writing the actual output.
-        no_expected = self.no_expected_template % {
-            'exp': expected_path, 'out': params'destination_path'}
-        self.assertTrue(os.access(expected_path, os.R_OK), no_expected)
-        if sys.version_info < (3, 0):
-            f = open(expected_path, 'r')
-        else: # samples are UTF8 encoded. 'rb' leads to errors with Python 3!
-            f = open(expected_path, 'r', encoding='utf-8')
-        # Normalize line endings:
-        expected = '\n'.join(f.read().splitlines())
-        f.close()
-        if sys.version_info < (3, 0):
-            try:
-                expected = expected.decode(output_encoding)
-            except UnicodeDecodeError:
-                expected = expected.decode('latin1', 'replace')
-
-        diff = self.expected_output_differs_template % {
-            'exp': expected_path, 'out': params'destination_path'}
-        try:
-            self.assertEqual(output, expected, diff)
-        except AssertionError:
-            diff = ''.join(difflib.unified_diff(
-                expected.splitlines(True), output.splitlines(True),
-                expected_path, params'destination_path'))
-            if sys.version_info < (3, 0):
-                diff = diff.encode(sys.stderr.encoding or 'ascii', 'replace')
-            print('\n%s:' % (self,), file=sys.stderr)
-            print(diff, file=sys.stderr)
-            raise
-        # Execute optional function containing extra tests:
-        if '_test_more' in namespace:
-            namespace'_test_more'(join_path(datadir, 'expected'),
-                                    join_path(datadir, 'output'),
-                                    self, namespace)
-
-
-def suite():
-    return FunctionalTestSuite()
+  mv {out} {exp}
+  svn add {exp}
+  svn commit -m "<comment>" {exp}
+"""
+
+# Default settings for functional tests.
+# Override "factory defaults",
+# overridden by `settings_overrides` in the individual tests.
+# cf. docs/api/runtime-settings.html#settings-priority
+functional_tests_settings_spec = SettingsSpec()
+functional_tests_settings_spec.settings_default_overrides = {
+    '_disable_config': True,
+    'halt_level': 5,
+    'warning_stream': '',
+    'input_encoding': 'utf-8',  # skip auto-detection
+    'embed_stylesheet': False,
+    'syntax_highlight': 'none'  # avoid "Pygments not found" warning
+    }
+
+
+class FunctionalTests(unittest.TestCase):
+
+    """Test case for one config file."""
+    maxDiff = None
+
+    def setUp(self):
+        """Clear output directory."""
+        for entry in OUTPUT.rglob('*'):
+            if entry.is_dir():
+                shutil.rmtree(entry)
+            elif entry.name != 'README.txt':
+                entry.unlink()
+
+    def test_functional(self):
+        """Process test file."""
+        for test_file in TESTS.glob("*.py"):
+            with self.subTest(test_file=test_file.as_posix()):
+                namespace = {}
+                # Load variables from the current test file into the namespace
+                exec(test_file.read_text(encoding='utf-8'), namespace)
+                del namespace'__builtins__'  # clean-up
+
+                # Full source, generated output, and expected output paths
+                source_path = INPUT / namespace.pop('test_source')
+                destination_path = OUTPUT / namespace'test_destination'
+                expected_path = EXPECTED / namespace.pop('test_destination')
+
+                # Get output (automatically written to the output/ directory
+                # by publish_file):
+                output = core.publish_file(
+                    **namespace,
+                    source_path=source_path.as_posix(),
+                    destination_path=destination_path.as_posix(),
+                    settings_spec=functional_tests_settings_spec,
+                )
+
+                # Get the expected output *after* writing the actual output.
+                try:
+                    expected = expected_path.read_text(encoding='utf-8')
+                except OSError as err:
+                    raise OSError(NO_EXPECTED_TEMPLATE.format(
+                        exp=expected_path, out=destination_path)
+                    ) from err
+
+                self.assertEqual(output, expected,
+                                 EXPECTED_OUTPUT_DIFFERS_TEMPLATE.format(
+                                     exp=expected_path, out=destination_path)
+                                 )
 
 
 if __name__ == '__main__':
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_io.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_io.py Changed

@@ -1,161 +1,174 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_io.py 8367 2019-08-27 12:09:56Z milde $
+# $Id: test_io.py 9369 2023-05-02 23:04:27Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for io.py.
 """
+import os.path
+
+from io import StringIO, BytesIO
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+from docutils import io as du_io
+
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'data')
+
+
+# Stub: Buffer with 'strict' auto-conversion of input to byte string:
+class BBuf(BytesIO):
+    def write(self, data):
+        if isinstance(data, str):
+            data.encode('ascii', 'strict')
+        super().write(data)
+
+
+# Stub: Buffer expecting unicode string:
+class UBuf(StringIO):
+    def write(self, data):
+        # emulate Python 3 handling of stdout, stderr
+        if isinstance(data, bytes):
+            raise TypeError('must be unicode, not bytes')
+        super().write(data)
 
-import unittest, sys
-import DocutilsTestSupport              # must be imported before docutils
-from docutils import io
-from docutils.utils.error_reporting import locale_encoding
-from test_error_reporting import BBuf, UBuf
 
 class mock_stdout(UBuf):
-    encoding = 'utf8'
+    encoding = 'utf-8'
 
     def __init__(self):
         self.buffer = BBuf()
-        UBuf.__init__(self)
+        super().__init__()
+
 
 class HelperTests(unittest.TestCase):
 
     def test_check_encoding_true(self):
         """Return `True` if lookup returns the same codec"""
-        self.assertEqual(io.check_encoding(mock_stdout, 'utf8'), True)
-        self.assertEqual(io.check_encoding(mock_stdout, 'utf-8'), True)
-        self.assertEqual(io.check_encoding(mock_stdout, 'UTF-8'), True)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'utf-8'), True)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'utf_8'), True)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'utf8'), True)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'UTF-8'), True)
 
     def test_check_encoding_false(self):
         """Return `False` if lookup returns different codecs"""
-        self.assertEqual(io.check_encoding(mock_stdout, 'ascii'), False)
-        self.assertEqual(io.check_encoding(mock_stdout, 'latin-1'), False)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'ascii'), False)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'latin-1'), False)
 
     def test_check_encoding_none(self):
         """Cases where the comparison fails."""
         # stream.encoding is None:
-        self.assertEqual(io.check_encoding(io.FileInput(), 'ascii'), None)
+        self.assertEqual(du_io.check_encoding(du_io.FileInput(), 'ascii'),
+                         None)
         # stream.encoding does not exist:
-        self.assertEqual(io.check_encoding(BBuf, 'ascii'), None)
-        # encoding is None:
-        self.assertEqual(io.check_encoding(mock_stdout, None), None)
+        self.assertEqual(du_io.check_encoding(BBuf, 'ascii'), None)
+        # encoding is None or empty string:
+        self.assertEqual(du_io.check_encoding(mock_stdout, None), None)
+        self.assertEqual(du_io.check_encoding(mock_stdout, ''), None)
         # encoding is invalid
-        self.assertEqual(io.check_encoding(mock_stdout, 'UTF-9'), None)
+        self.assertEqual(du_io.check_encoding(mock_stdout, 'UTF-9'), None)
+
+    def test_error_string(self):
+        us = '\xfc'       # bytes(us) fails
+        bs = b'\xc3\xbc'  # str(bs) returns repr(bs)
+
+        self.assertEqual('Exception: spam',
+                         du_io.error_string(Exception('spam')))
+        self.assertEqual('IndexError: ' + str(bs),
+                         du_io.error_string(IndexError(bs)))
+        self.assertEqual('ImportError: %s' % us,
+                         du_io.error_string(ImportError(us)))
 
 
 class InputTests(unittest.TestCase):
 
     def test_bom(self):
-        input = io.StringInput(source=b'\xef\xbb\xbf foo \xef\xbb\xbf bar',
-                               encoding='utf8')
-        # Assert BOMs are gone.
-        self.assertEqual(input.read(), u' foo  bar')
-        # With unicode input:
-        input = io.StringInput(source=u'\ufeff foo \ufeff bar')
-        # Assert BOMs are still there.
-        self.assertEqual(input.read(), u'\ufeff foo \ufeff bar')
+        # Provisional:
+        input = du_io.StringInput(source=b'\xef\xbb\xbf foo \xef\xbb\xbf bar')
+        # Assert BOM is gone.
+        # TODO: only remove BOM (ZWNBSP at start of data)
+        self.assertEqual(input.read(), ' foo  bar')
+        # Unicode input is left unchanged:
+        input = du_io.StringInput(source='\ufeff foo \ufeff bar')
+        # Assert ZWNBSPs are still there.
+        self.assertEqual(input.read(), '\ufeff foo \ufeff bar')
 
     def test_coding_slug(self):
-        input = io.StringInput(source=b"""\
+        input = du_io.StringInput(source=b"""\
 .. -*- coding: ascii -*-
 data
 blah
 """)
-        data = input.read()
+        data = input.read()  # noqa: F841
         self.assertEqual(input.successful_encoding, 'ascii')
-        input = io.StringInput(source=b"""\
+        input = du_io.StringInput(source=b"""\
 #! python
 # -*- coding: ascii -*-
 print("hello world")
 """)
-        data = input.read()
+        data = input.read()  # noqa: F841
         self.assertEqual(input.successful_encoding, 'ascii')
-        input = io.StringInput(source=b"""\
+        input = du_io.StringInput(source=b"""\
 #! python
 # extraneous comment; prevents coding slug from being read
 # -*- coding: ascii -*-
 print("hello world")
 """)
-        data = input.read()
         self.assertNotEqual(input.successful_encoding, 'ascii')
 
     def test_bom_detection(self):
-        source = u'\ufeffdata\nblah\n'
-        input = io.StringInput(source=source.encode('utf-16-be'))
-        data = input.read()
-        self.assertEqual(input.successful_encoding, 'utf-16-be')
-        input = io.StringInput(source=source.encode('utf-16-le'))
-        data = input.read()
-        self.assertEqual(input.successful_encoding, 'utf-16-le')
-        input = io.StringInput(source=source.encode('utf-8'))
-        data = input.read()
-        self.assertEqual(input.successful_encoding, 'utf-8')
+        source = '\ufeffdata\nblah\n'
+        expected = 'data\nblah\n'
+        input = du_io.StringInput(source=source.encode('utf-16-be'))
+        self.assertEqual(input.read(), expected)
+        input = du_io.StringInput(source=source.encode('utf-16-le'))
+        self.assertEqual(input.read(), expected)
+        input = du_io.StringInput(source=source.encode('utf-8'))
+        self.assertEqual(input.read(), expected)
 
     def test_readlines(self):
-        input = io.FileInput(source_path='data/include.txt')
+        input = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'include.txt'))
         data = input.readlines()
-        self.assertEqual(data, u'Some include text.\n')
-
-    def test_heuristics_utf8(self):
-        # if no encoding is given, try decoding with utf8:
-        input = io.FileInput(source_path='functional/input/cyrillic.txt')
-        data = input.read()
-        if sys.version_info < (3, 0):
-            # in Py3k, the locale encoding is used without --input-encoding
-            # skipping the heuristic
-            self.assertEqual(input.successful_encoding, 'utf-8')
+        self.assertEqual(data, 'Some include text.\n')
 
     def test_heuristics_no_utf8(self):
-        # if no encoding is given and decoding with utf8 fails,
-        # use either the locale encoding (if specified) or latin-1:
-        if sys.version_info >= (3, 0) and locale_encoding != "utf8":
-            # in Py3k, the locale encoding is used without --input-encoding
-            # skipping the heuristic unless decoding fails.
-            return
-        probed_encodings = (locale_encoding, 'latin-1')
-        input = io.FileInput(source_path='data/latin1.txt')
+        # if no encoding is given and decoding with 'utf-8' fails,
+        # use either the locale encoding (if specified) or 'latin-1':
+        # Provisional: the second fallback 'latin-1' will be dropped
+        probed_encodings = (du_io._locale_encoding, 'latin-1')  # noqa
+        input = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'latin1.txt'))
         data = input.read()
         if input.successful_encoding not in probed_encodings:
             raise AssertionError(
                 "guessed encoding '%s' differs from probed encodings %r"
                 % (input.successful_encoding, probed_encodings))
         if input.successful_encoding == 'latin-1':
-            self.assertEqual(data, u'Gr\xfc\xdfe\n')
+            self.assertEqual(data, 'Gr\xfc\xdfe\n')
 
     def test_decode_unicode(self):
         # With the special value "unicode" or "Unicode":
-        uniinput = io.Input(encoding='unicode')
+        uniinput = du_io.Input(encoding='unicode')
         # keep unicode instances as-is
-        self.assertEqual(uniinput.decode(u'ja'), u'ja')
+        self.assertEqual(uniinput.decode('ja'), 'ja')
         # raise AssertionError if data is not an unicode string
         self.assertRaises(AssertionError, uniinput.decode, b'ja')
 
-    def test_deprecation_warning(self):
-        # Test deprecation warning of 'U' universal newlines mode.
-        # TODO remove with 3.4 support end
-
-        # Arrange
-        import warnings
-        with warnings.catch_warnings(record=True) as w:
-            # Cause all warnings to always be triggered
-            warnings.simplefilter("always", DeprecationWarning)
-
-            # Act
-            # Trigger a warning?
-            io.FileInput(source_path='data/include.txt').close()
-
-            # Assert
-            self.assertEqual(len(w), 0, "Expected no warnings, got %s" %
-                             list(v.category for v in w))
-
 
 class OutputTests(unittest.TestCase):
 
     bdata = b'\xfc'
-    udata = u'\xfc'
+    udata = '\xfc'
 
     def setUp(self):
         self.bdrain = BBuf()
@@ -166,53 +179,143 @@
         """Stub of sys.stdout under Python 3"""
 
     def test_write_unicode(self):
-        fo = io.FileOutput(destination=self.udrain, encoding='unicode',
-                           autoclose=False)
+        fo = du_io.FileOutput(destination=self.udrain, encoding='unicode',
+                              autoclose=False)
         fo.write(self.udata)
         self.assertEqual(self.udrain.getvalue(), self.udata)
 
     def test_write_utf8(self):
-        if sys.version_info >= (3, 0):
-            fo = io.FileOutput(destination=self.udrain, encoding='utf8',
-                               autoclose=False)
-            fo.write(self.udata)
-            self.assertEqual(self.udrain.getvalue(), self.udata)
-        else:
-            fo = io.FileOutput(destination=self.bdrain, encoding='utf8',
-                               autoclose=False)
-            fo.write(self.udata)
-            self.assertEqual(self.bdrain.getvalue(), self.udata.encode('utf8'))
+        fo = du_io.FileOutput(destination=self.udrain, encoding='utf-8',
+                              autoclose=False)
+        fo.write(self.udata)
+        self.assertEqual(self.udrain.getvalue(), self.udata)
+
+    def test_FileOutput_hande_io_errors_deprection_warning(self):
+        with self.assertWarnsRegex(DeprecationWarning,
+                                   '"handle_io_errors" is ignored'):
+            du_io.FileOutput(handle_io_errors=True)
 
     # With destination in binary mode, data must be binary string
     # and is written as-is:
     def test_write_bytes(self):
-        fo = io.FileOutput(destination=self.bdrain, encoding='utf8',
-                           mode='wb', autoclose=False)
+        fo = du_io.FileOutput(destination=self.bdrain, encoding='utf-8',
+                              mode='wb', autoclose=False)
         fo.write(self.bdata)
         self.assertEqual(self.bdrain.getvalue(), self.bdata)
 
-    # Test for Python 3 features:
-    if sys.version_info >= (3, 0):
-        def test_write_bytes_to_stdout(self):
-            # try writing data to `destination.buffer`, if data is
-            # instance of `bytes` and writing to `destination` fails:
-            fo = io.FileOutput(destination=self.mock_stdout)
-            fo.write(self.bdata)
-            self.assertEqual(self.mock_stdout.buffer.getvalue(),
-                             self.bdata)
-
-        def test_encoding_clash_resolved(self):
-            fo = io.FileOutput(destination=self.mock_stdout,
-                               encoding='latin1', autoclose=False)
-            fo.write(self.udata)
-            self.assertEqual(self.mock_stdout.buffer.getvalue(),
-                             self.udata.encode('latin1'))
-
-        def test_encoding_clash_nonresolvable(self):
-            del(self.mock_stdout.buffer)
-            fo = io.FileOutput(destination=self.mock_stdout,
-                               encoding='latin1', autoclose=False)
-            self.assertRaises(ValueError, fo.write, self.udata)
+    def test_write_bytes_to_stdout(self):
+        # try writing data to `destination.buffer`, if data is
+        # instance of `bytes` and writing to `destination` fails:
+        fo = du_io.FileOutput(destination=self.mock_stdout)
+        fo.write(self.bdata)
+        self.assertEqual(self.mock_stdout.buffer.getvalue(),
+                         self.bdata)
+
+    def test_encoding_clash_resolved(self):
+        fo = du_io.FileOutput(destination=self.mock_stdout,
+                              encoding='latin1', autoclose=False)
+        fo.write(self.udata)
+        self.assertEqual(self.mock_stdout.buffer.getvalue(),
+                         self.udata.encode('latin1'))
+
+    def test_encoding_clash_nonresolvable(self):
+        del self.mock_stdout.buffer
+        fo = du_io.FileOutput(destination=self.mock_stdout,
+                              encoding='latin1', autoclose=False)
+        self.assertRaises(ValueError, fo.write, self.udata)
+
+
+class ErrorOutputTests(unittest.TestCase):
+    def test_defaults(self):
+        e = du_io.ErrorOutput()
+        self.assertEqual(e.destination, sys.stderr)
+
+    def test_bbuf(self):
+        buf = BBuf()  # buffer storing byte string
+        e = du_io.ErrorOutput(buf, encoding='ascii')
+        # write byte-string as-is
+        e.write(b'b\xfc')
+        self.assertEqual(buf.getvalue(), b'b\xfc')
+        # encode unicode data with backslashescape fallback replacement:
+        e.write(' u\xfc')
+        self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc')
+        # handle Exceptions with Unicode string args
+        # unicode(Exception('e\xfc')) # fails in Python < 2.6
+        e.write(AttributeError(' e\xfc'))
+        self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc e\\xfc')
+        # encode with `encoding` attribute
+        e.encoding = 'utf-8'
+        e.write(' u\xfc')
+        self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc e\\xfc u\xc3\xbc')
+
+    def test_ubuf(self):
+        buf = UBuf()  # buffer only accepting unicode string
+        # decode of binary strings
+        e = du_io.ErrorOutput(buf, encoding='ascii')
+        e.write(b'b\xfc')
+        # use REPLACEMENT CHARACTER
+        self.assertEqual(buf.getvalue(), 'b\ufffd')
+        # write Unicode string and Exceptions with Unicode args
+        e.write(' u\xfc')
+        self.assertEqual(buf.getvalue(), 'b\ufffd u\xfc')
+        e.write(AttributeError(' e\xfc'))
+        self.assertEqual(buf.getvalue(), 'b\ufffd u\xfc e\xfc')
+        # decode with `encoding` attribute
+        e.encoding = 'latin1'
+        e.write(b' b\xfc')
+        self.assertEqual(buf.getvalue(), 'b\ufffd u\xfc e\xfc b\xfc')
+
+
+class FileInputTests(unittest.TestCase):
+
+    # test input encoding auto-detection:
+    #
+    # Up to Docutils 0.18, auto-detection was not used under Python 3
+    # unless reading a file with Python's default encoding failed
+
+    def test_bom_utf_8(self):
+        """Drop optional BOM from utf-8 encoded files.
+        """
+        source = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'utf-8-sig.txt'))
+        self.assertTrue(source.read().startswith('Grüße'))
+
+    def test_bom_utf_16(self):
+        """Drop BOM from utf-16 encoded files, use correct encoding.
+        """
+        # Assert correct decoding, BOM is gone.
+        source = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'utf-16-le-sig.txt'))
+        self.assertTrue(source.read().startswith('Grüße'))
+
+    def test_coding_slug(self):
+        """Use self-declared encoding.
+        """
+        source = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'latin2.txt'))
+        self.assertTrue(source.read().endswith('škoda\n'))
+
+    def test_fallback_utf8(self):
+        """Try 'utf-8', if encoding is not specified in the source."""
+        source = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'utf8.txt'))
+        self.assertEqual(source.read(), 'Grüße\n')
+
+    @unittest.skipIf(du_io._locale_encoding in (None, 'utf-8', 'utf8'),
+                     'locale encoding not set or UTF-8')
+    def test_fallback_no_utf8(self):
+        # if decoding with 'utf-8' fails, use the locale encoding
+        # (if not None) or 'latin-1'.
+        # provisional: behaviour details will change in future
+        # TODO: don't fall back to latin1
+        # TODO: use `locale.getpreferredlocale()` (honour UTF-8 mode)?
+        probed_encodings = (du_io._locale_encoding, 'latin-1')  # noqa
+        source = du_io.FileInput(
+            source_path=os.path.join(DATA_ROOT, 'latin1.txt'))
+        data = source.read()
+        self.assertTrue(source.successful_encoding in probed_encodings)
+        if source.successful_encoding in ('latin-1', 'iso8859-1'):
+            self.assertEqual(data, 'Grüße\n')
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_language.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_language.py Changed

@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_language.py 8372 2019-08-27 12:11:15Z milde $
+# $Id: test_language.py 9277 2022-11-26 23:15:13Z milde $
 # Authors: Engelbert Gruber <grubert@users.sourceforge.net>;
 #          David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
@@ -12,210 +12,109 @@
 that language.
 """
 
-import sys
+from pathlib import Path
 import os
 import re
-import DocutilsTestSupport              # must be imported before docutils
-import docutils.languages
-import docutils.parsers.rst.languages
-from docutils.parsers.rst import states, directives, roles
-import docutils.utils, docutils.frontend
-
-_settings = docutils.frontend.OptionParser().get_default_values()
-_reporter = docutils.utils.new_reporter('', _settings)
-
-reference_language = 'en'
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-
-
-class LanguageTestSuite(DocutilsTestSupport.CustomTestSuite):
-
-    language_module_pattern = re.compile(r'^(a-z{2,3}(_a-z{2,8})*)\.py$')
-
-    def __init__(self, languages=None):
-        DocutilsTestSupport.CustomTestSuite.__init__(self)
-        if languages:
-            self.languages = languages
-        else:
-            self.get_languages()
-
-    def get_languages(self):
-        """
-        Get installed language translations from docutils.languages and from
-        docutils.parsers.rst.languages.
-        """
-        languages = {}
-        for mod in (os.listdir(docutils.languages.__path__0)
-                    + os.listdir(docutils.parsers.rst.languages.__path__0)):
-            match = self.language_module_pattern.match(mod)
-            if match:
-                languagesmatch.group(1) = 1
-        self.languages = list(languages.keys())
-        # test language tag normalization:
-        self.languages += 'en_gb', 'en_US', 'en-CA', 'de-DE', 'de-AT-1901',
-                           'pt-BR', 'pt-foo-BR'
-        # test that locally created language files are also loaded.
-        # requires local_dummy_lang.py in test directory (testroot)
-        # The local_dummy_lang.py contains all the fields from both
-        # the docutils language tags and the parser.rst language tags
-        self.languages += 'local_dummy_lang'
-
-    def generateTests(self):
-        for language in self.languages:
-            for method in LanguageTestCase.test_methods:
-                self.addTestCase(LanguageTestCase, method, None, None,
-                                 id=language+'.py', language=language)
-
-
-class LanguageTestCase(DocutilsTestSupport.CustomTestCase):
-
-    test_methods = 'test_labels', 'test_bibliographic_fields',
-                    'test_directives', 'test_roles'
-    """Names of methods used to test each language."""
-
-    def __init__(self, *args, **kwargs):
-        self.ref = docutils.languages.get_language(reference_language,
-                                                   _reporter)
-        self.language = kwargs'language'
-        del kwargs'language'          # only wanted here
-        DocutilsTestSupport.CustomTestCase.__init__(self, *args, **kwargs)
-
-    def _xor(self, ref_dict, l_dict):
-        """
-        Returns entries that are only in one dictionary.
-        (missing_in_lang, more_than_in_ref).
-        """
-        missing  =    # in ref but not in l.
-        too_much =    # in l but not in ref.
-        for label in ref_dict.keys():
-            if label not in l_dict:
-                missing.append(label)
-        for label in l_dict.keys():
-            if label not in ref_dict:
-                too_much.append(label)
-        return (missing, too_much)
-
-    def _invert(self, adict):
-        """Return an inverted (keys & values swapped) dictionary."""
-        inverted = {}
-        for key, value in adict.items():
-            invertedvalue = key
-        return inverted
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+
+from docutils import frontend, languages, utils
+from docutils.parsers.rst import languages as rst_languages
+from docutils.parsers.rst.directives import _directive_registry  # NoQA
+from docutils.parsers.rst.roles import _role_registry  # NoQA
+
+LANGUAGE_MODULE_PATTERN = re.compile(r'^(a-z{2,3}(_a-z{2,8})*)\.py$')
+REPORTER = utils.new_reporter('', frontend.get_default_settings())
+REF = languages.get_language('en', REPORTER)
+
+
+def get_languages():
+    """
+    Get installed language translations from docutils.languages and from
+    docutils.parsers.rst.languages.
+    """
+    translations = set()
+    for mod in (os.listdir(languages.__path__0)
+                + os.listdir(rst_languages.__path__0)):
+        match = LANGUAGE_MODULE_PATTERN.match(mod)
+        if match:
+            translations.add(match.group(1))
+    language_list = list(translations)
+    # test language tag normalization:
+    language_list += 'en_gb', 'en_US', 'en-CA', 'de-DE', 'de-AT-1901',
+                      'pt-BR', 'pt-foo-BR'
+    # test that locally created language files are also loaded.
+    # requires local_dummy_lang.py in test directory (testroot)
+    # The local_dummy_lang.py contains all the fields from both
+    # the docutils language tags and the parser.rst language tags
+    language_list += 'test.local_dummy_lang'
+    return language_list
+
+
+class LanguageTestCase(unittest.TestCase):
+    maxDiff = None
 
     def test_labels(self):
-        try:
-            module = docutils.languages.get_language(self.language, _reporter)
-            if not module:
-                raise ImportError
-        except ImportError:
-            self.fail('No docutils.languages.%s module.' % self.language)
-        missed, unknown = self._xor(self.ref.labels, module.labels)
-        if missed or unknown:
-            self.fail('Module docutils.languages.%s.labels:\n'
-                      '    Missed: %s; Unknown: %s'
-                      % (self.language, str(missed), str(unknown)))
+        ref_labels = {*REF.labels}
+        for language in get_languages():
+            with self.subTest(id=f'{language}.py'):
+                try:
+                    module = languages.get_language(language, REPORTER)
+                except ImportError:
+                    mod = f'docutils.languages.{language}'
+                    raise AssertionError(f'No {mod} module.')
+                self.assertIsNotNone(module)
+                self.assertSetEqual({*module.labels}, ref_labels)
 
     def test_bibliographic_fields(self):
-        try:
-            module = docutils.languages.get_language(self.language, _reporter)
-            if not module:
-                raise ImportError
-        except ImportError:
-            self.fail('No docutils.languages.%s module.' % self.language)
-        missed, unknown = self._xor(
-            self._invert(self.ref.bibliographic_fields),
-            self._invert(module.bibliographic_fields))
-        if missed or unknown:
-            self.fail('Module docutils.languages.%s.bibliographic_fields:\n'
-                      '    Missed: %s; Unknown: %s'
-                      % (self.language, str(missed), str(unknown)))
+        ref_fields = {*REF.bibliographic_fields.values()}
+        for language in get_languages():
+            with self.subTest(id=f'{language}.py'):
+                try:
+                    module = languages.get_language(language, REPORTER)
+                except ImportError:
+                    mod = f'docutils.languages.{language}'
+                    raise AssertionError(f'No {mod} module.')
+                self.assertIsNotNone(module)
+                mod_fields = {*module.bibliographic_fields.values()}
+                self.assertSetEqual(mod_fields, ref_fields)
 
     def test_directives(self):
-        try:
-            module = docutils.parsers.rst.languages.get_language(
-                self.language)
-            if not module:
-                raise ImportError
-        except ImportError:
-            self.fail('No docutils.parsers.rst.languages.%s module.'
-                      % self.language)
-        failures = 
-        for d in module.directives.keys():
-            try:
-                func, msg = directives.directive(d, module, None)
-                if not func:
-                    failures.append('"%s": unknown directive' % d)
-            except Exception as error:
-                failures.append('"%s": %s' % (d, error))
-        inverted = self._invert(module.directives)
-        canonical = sorted(directives._directive_registry.keys())
-        canonical.remove('restructuredtext-test-directive')
-        for name in canonical:
-            if name not in inverted:
-                failures.append('"%s": translation missing' % name)
-        if failures:
-            text = ('Module docutils.parsers.rst.languages.%s:\n    %s'
-                    % (self.language, '\n    '.join(failures)))
-            if isinstance(text, unicode):
-                text = text.encode('raw_unicode_escape')
-            self.fail(text)
+        for language in get_languages():
+            with self.subTest(id=f'{language}.py'):
+                try:
+                    module = rst_languages.get_language(language)
+                except ImportError:
+                    mod = f'docutils.parsers.rst.languages.{language}'
+                    raise AssertionError(f'No {mod} module.')
+                self.assertIsNotNone(module)
+                for d in module.directives.values():
+                    self.assertIn(d, _directive_registry)
+                for name in _directive_registry:
+                    if name != 'restructuredtext-test-directive':
+                        self.assertIn(name, set(module.directives.values()))
 
     def test_roles(self):
-        try:
-            module = docutils.parsers.rst.languages.get_language(
-                self.language)
-            if not module:
-                raise ImportError
-            module.roles
-        except ImportError:
-            self.fail('No docutils.parsers.rst.languages.%s module.'
-                      % self.language)
-        except AttributeError:
-            self.fail('No "roles" mapping in docutils.parsers.rst.languages.'
-                      '%s module.' % self.language)
-        failures = 
-        for d in module.roles.values():
-            try:
-                method = roles._role_registryd
-                #if not method:
-                #    failures.append('"%s": unknown role' % d)
-            except KeyError as error:
-                failures.append('"%s": %s' % (d, error))
-        inverted = self._invert(module.roles)
-        canonical = sorted(roles._role_registry.keys())
-        canonical.remove('restructuredtext-unimplemented-role')
-        for name in canonical:
-            if name not in inverted:
-                failures.append('"%s": translation missing' % name)
-        if failures:
-            text = ('Module docutils.parsers.rst.languages.%s:\n    %s'
-                    % (self.language, '\n    '.join(failures)))
-            if isinstance(text, unicode):
-                text = text.encode('raw_unicode_escape')
-            self.fail(text)
-
-languages_to_test = 
-
-def suite():
-    s = LanguageTestSuite(languages_to_test)
-    s.generateTests()
-    return s
-
-def get_language_arguments():
-    while len(sys.argv) > 1:
-        last = sys.argv-1
-        if last.startswith('-'):
-            break
-        languages_to_test.append(last)
-        sys.argv.pop()
-    languages_to_test.reverse()
+        for language in get_languages():
+            with self.subTest(id=f'{language}.py'):
+                try:
+                    module = rst_languages.get_language(language)
+                except ImportError:
+                    mod = f'docutils.parsers.rst.languages.{language}'
+                    raise AssertionError(f'No {mod} module.')
+                self.assertIsNotNone(module)
+                for d in module.roles.values():
+                    self.assertIn(d, _role_registry)
+                for name in _role_registry:
+                    if name != 'restructuredtext-unimplemented-role':
+                        self.assertIn(name, set(module.roles.values()))
 
 
 if __name__ == '__main__':
-    get_language_arguments()
-    import unittest
-    unittest.main(defaultTest='suite')
-
-# vim: set et ts=4 ai :
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_nodes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_nodes.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_nodes.py 8501 2020-03-14 17:03:52Z milde $
+#! /usr/bin/env python3
+# $Id: test_nodes.py 9310 2022-12-17 12:17:32Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,23 +7,25 @@
 Test module for nodes.py.
 """
 
+from pathlib import Path
 import sys
 import unittest
 
-import DocutilsTestSupport              # must be imported before docutils
-from DocutilsTestSupport import nodes, utils
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
 
-debug = False
+from docutils import nodes, utils
 
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
+debug = False
 
 
 class TextTests(unittest.TestCase):
 
     def setUp(self):
         self.text = nodes.Text('Line 1.\nLine 2.')
-        self.unicode_text = nodes.Text(u'Möhren')
+        self.unicode_text = nodes.Text('Möhren')
         self.longtext = nodes.Text('Mary had a little lamb whose '
                                    'fleece was white as snow and '
                                    'everwhere that Mary went the '
@@ -34,50 +34,53 @@
     def test_repr(self):
         self.assertEqual(repr(self.text), r"<#text: 'Line 1.\nLine 2.'>")
         self.assertEqual(self.text.shortrepr(),
-                          r"<#text: 'Line 1.\nLine 2.'>")
-        self.assertEqual(nodes.reprunicode('foo'), u'foo')
-        if sys.version_info < (3, 0):
-            self.assertEqual(repr(self.unicode_text), r"<#text: 'M\xf6hren'>")
-        else:
-            self.assertEqual(repr(self.unicode_text), u"<#text: 'Möhren'>")
+                         r"<#text: 'Line 1.\nLine 2.'>")
+        self.assertEqual(repr(self.unicode_text), "<#text: 'Möhren'>")
 
     def test_str(self):
         self.assertEqual(str(self.text), 'Line 1.\nLine 2.')
 
     def test_unicode(self):
-        self.assertEqual(unicode(self.unicode_text), u'Möhren')
+        self.assertEqual(str(self.unicode_text), 'Möhren')
         self.assertEqual(str(self.unicode_text), 'M\xf6hren')
 
     def test_astext(self):
-        self.assertTrue(isinstance(self.text.astext(), unicode))
-        self.assertEqual(self.text.astext(), u'Line 1.\nLine 2.')
-        self.assertEqual(self.unicode_text.astext(), u'Möhren')
+        self.assertTrue(isinstance(self.text.astext(), str))
+        self.assertEqual(self.text.astext(), 'Line 1.\nLine 2.')
+        self.assertEqual(self.unicode_text.astext(), 'Möhren')
 
     def test_pformat(self):
-        self.assertTrue(isinstance(self.text.pformat(), unicode))
-        self.assertEqual(self.text.pformat(), u'Line 1.\nLine 2.\n')
+        self.assertTrue(isinstance(self.text.pformat(), str))
+        self.assertEqual(self.text.pformat(), 'Line 1.\nLine 2.\n')
 
     def test_strip(self):
-        text = nodes.Text(' was noch ', r' \was\ noch \\ ')
+        text = nodes.Text(' was noch ')
         stripped = text.lstrip().rstrip()
         stripped2 = text.lstrip(' wahn').rstrip(' wahn')
-        self.assertEqual(stripped, u'was noch')
-        self.assertEqual(stripped2, u's noc')
+        self.assertEqual(stripped, 'was noch')
+        self.assertEqual(stripped2, 's noc')
 
     def test_asciirestriction(self):
-        if sys.version_info < (3, 0):
-            self.assertRaises(UnicodeDecodeError, nodes.Text,
-                              b'hol%s' % chr(224))
-        else:
-            # no bytes at all allowed
-            self.assertRaises(TypeError, nodes.Text, b'hol')
+        # no bytes at all allowed
+        self.assertRaises(TypeError, nodes.Text, b'hol')
 
     def test_longrepr(self):
         self.assertEqual(repr(self.longtext), r"<#text: 'Mary had a "
-                          r"little lamb whose fleece was white as snow "
-                          r"and everwh ...'>")
+                         r"little lamb whose fleece was white as snow "
+                         r"and everwh ...'>")
         self.assertEqual(self.longtext.shortrepr(),
-                          r"<#text: 'Mary had a lit ...'>")
+                         r"<#text: 'Mary had a lit ...'>")
+
+    def test_comparison(self):
+        # Text nodes are compared by value
+        self.assertEqual(self.text, 'Line 1.\nLine 2.')
+        self.assertEqual(self.text, nodes.Text('Line 1.\nLine 2.'))
+
+    def test_Text_rawsource_deprection_warning(self):
+        with self.assertWarnsRegex(DeprecationWarning,
+                                   '"rawsource" is ignored'):
+            nodes.Text('content', rawsource='content')
+
 
 class ElementTests(unittest.TestCase):
 
@@ -96,31 +99,21 @@
         dom.unlink()
         self.assertEqual(element.pformat(), '<Element attr="1">\n')
         del element'attr'
-        element'mark' = u'\u2022'
+        element'mark' = '\u2022'
         self.assertEqual(repr(element), '<Element: >')
-        if sys.version_info < (3, 0):
-            self.assertEqual(str(element), '<Element mark="\\u2022"/>')
-        else:
-            self.assertEqual(str(element), u'<Element mark="\u2022"/>')
+        self.assertEqual(str(element), '<Element mark="\u2022"/>')
         dom = element.asdom()
-        self.assertEqual(dom.toxml(), u'<Element mark="\u2022"/>')
+        self.assertEqual(dom.toxml(), '<Element mark="\u2022"/>')
         dom.unlink()
-        element'names' = 'nobody', u'имя', u'näs'
-        if sys.version_info < (3, 0):
-            self.assertEqual(repr(element),
-                '<Element "nobody; \\u0438\\u043c\\u044f; n\\xe4s": >')
-        else:
-            self.assertEqual(repr(element), u'<Element "nobody; имя; näs": >')
+        element'names' = 'nobody', 'имя', 'näs'
+        self.assertEqual(repr(element), '<Element "nobody; имя; näs": >')
         self.assertTrue(isinstance(repr(element), str))
 
     def test_withtext(self):
         element = nodes.Element('text\nmore', nodes.Text('text\nmore'))
-        uelement = nodes.Element(u'grün', nodes.Text(u'grün'))
+        uelement = nodes.Element('grün', nodes.Text('grün'))
         self.assertEqual(repr(element), r"<Element: <#text: 'text\nmore'>>")
-        if sys.version_info < (3, 0):
-            self.assertEqual(repr(uelement), "<Element: <#text: 'gr\\xfcn'>>")
-        else:
-            self.assertEqual(repr(uelement), u"<Element: <#text: 'grün'>>")
+        self.assertEqual(repr(uelement), "<Element: <#text: 'grün'>>")
         self.assertTrue(isinstance(repr(uelement), str))
         self.assertEqual(str(element), '<Element>text\nmore</Element>')
         self.assertEqual(str(uelement), '<Element>gr\xfcn</Element>')
@@ -130,13 +123,39 @@
         element'attr' = '1'
         self.assertEqual(repr(element), r"<Element: <#text: 'text\nmore'>>")
         self.assertEqual(str(element),
-                          '<Element attr="1">text\nmore</Element>')
+                         '<Element attr="1">text\nmore</Element>')
         dom = element.asdom()
         self.assertEqual(dom.toxml(),
-                          '<Element attr="1">text\nmore</Element>')
+                         '<Element attr="1">text\nmore</Element>')
         dom.unlink()
         self.assertEqual(element.pformat(),
-                          '<Element attr="1">\n    text\n    more\n')
+                         '<Element attr="1">\n    text\n    more\n')
+
+    def test_index(self):
+        # Element.index() behaves like list.index() on the element's children
+        e = nodes.Element()
+        e += nodes.Element()
+        e += nodes.Text('sample')
+        e += nodes.Element()
+        e += nodes.Text('other sample')
+        e += nodes.Text('sample')
+        # return element's index for the first four children:
+        for i in range(4):
+            self.assertEqual(e.index(ei), i)
+        # Caution: mismatches are possible for Text nodes
+        # as they are compared by value (like `str` instances)
+        self.assertEqual(e.index(e4), 1)
+        self.assertEqual(e.index(e4, start=2), 4)
+
+    def test_previous_sibling(self):
+        e = nodes.Element()
+        c1 = nodes.Element()
+        c2 = nodes.Element()
+        e += c1, c2
+        # print(c1 == c2)
+        self.assertEqual(e.previous_sibling(), None)
+        self.assertEqual(c1.previous_sibling(), None)
+        self.assertEqual(c2.previous_sibling(), c1)
 
     def test_clear(self):
         element = nodes.Element()
@@ -163,7 +182,7 @@
         element'ids'.append('someid')
         self.assertEqual(element'ids', 'someid')
         self.assertEqual(element.non_default_attributes(),
-                          {'ids': 'someid'})
+                         {'ids': 'someid'})
         self.assertTrue(element.is_not_default('ids'))
 
     def test_update_basic_atts(self):
@@ -178,7 +197,7 @@
     def test_update_all_atts(self):
         # Note: Also tests is_not_list_attribute and is_not_known_attribute
         # and various helpers
-        ## Test for full attribute replacement
+        # Test for full attribute replacement
         element1 = nodes.Element(ids='foo', 'bar', parent_only='parent',
                                  all_nodes='mom')
         element2 = nodes.Element(ids='baz', 'qux', child_only='child',
@@ -205,7 +224,7 @@
         self.assertEqual(element1'ids', 'foo', 'bar', 'baz', 'qux')
         # 'parent_only' should remain unaffected.
         self.assertEqual(element1'parent_only', 'parent')
-        # 'all_nodes' is overwritten due to the second parameter default of True.
+        # 'all_nodes' is overwritten due to the second parameter default True.
         self.assertEqual(element1'all_nodes', 'dad')
         # 'child_only' should have been added.
         self.assertEqual(element1'child_only', 'child')
@@ -246,7 +265,7 @@
         # 'source' remains unset due to the third parameter default of False.
         self.assertEqual(element1.get('source'), None)
 
-        ## Test for List attribute merging
+        # Test for List attribute merging
         # Attribute Concatination
         element1 = nodes.Element(ss='a', sl='1', ls='I', ll='A')
         element2 = nodes.Element(ss='b', sl='2', ls='II', ll='B')
@@ -330,209 +349,196 @@
         self.assertEqual(len(parent), 5)
 
     def test_unicode(self):
-        node = nodes.Element(u'Möhren', nodes.Text(u'Möhren', u'Möhren'))
-        self.assertEqual(unicode(node), u'<Element>Möhren</Element>')
+        node = nodes.Element('Möhren', nodes.Text('Möhren'))
+        self.assertEqual(str(node), '<Element>Möhren</Element>')
 
+    def test_set_class_deprecation_warning(self):
+        node = nodes.Element('test node')
+        with self.assertWarns(DeprecationWarning):
+            node.set_class('parrot')
 
-class MiscTests(unittest.TestCase):
 
-    def test_reprunicode(self):
-        # return `unicode` instance
-        self.assertTrue(isinstance(nodes.reprunicode('foo'), unicode))
-        self.assertEqual(nodes.reprunicode('foo'), u'foo')
-        self.assertEqual(nodes.reprunicode(u'Möhre'), u'Möhre')
-        if sys.version_info < (3, 0): # strip leading "u" from representation
-            self.assertEqual(repr(nodes.reprunicode(u'Möhre')),
-                             repr(u'Möhre')1:)
-        else: # no change to `unicode` under Python 3k
-            self.assertEqual(repr(nodes.reprunicode(u'Möhre')), repr(u'Möhre'))
-
-    def test_ensure_str(self):
-        self.assertTrue(isinstance(nodes.ensure_str(u'über'), str))
-        self.assertEqual(nodes.ensure_str('over'), 'over')
-        if sys.version_info < (3, 0): # strip leading "u" from representation
-            self.assertEqual(nodes.ensure_str(u'über'), r'\xfcber')
-        else:
-            self.assertEqual(nodes.ensure_str(u'über'), r'über')
+class MiscTests(unittest.TestCase):
 
     def test_node_class_names(self):
         node_class_names = 
         for x in dir(nodes):
             c = getattr(nodes, x)
-            if isinstance(c, type) and \
-                   issubclass(c, nodes.Node) and len(c.__bases__) > 1:
+            if (isinstance(c, type)
+                and issubclass(c, nodes.Node)
+                and len(c.__bases__) > 1):
                 node_class_names.append(x)
         node_class_names.sort()
         nodes.node_class_names.sort()
         self.assertEqual(node_class_names, nodes.node_class_names)
 
-    ids = (u'a', 'a'), ('A', 'a'), ('', ''), ('a b \n c', 'a-b-c'),
+    ids = ('a', 'a'), ('A', 'a'), ('', ''), ('a b \n c', 'a-b-c'),
            ('a.b.c', 'a-b-c'), (' - a - b - c - ', 'a-b-c'), (' - ', ''),
-           (u'\u2020\u2066', ''), (u'a \xa7 b \u2020 c', 'a-b-c'),
+           ('\u2020\u2066', ''), ('a \xa7 b \u2020 c', 'a-b-c'),
            ('1', ''), ('1abc', 'abc'),
-          
+           
     ids_unicode_all = 
-            (u'\u00f8 o with stroke', 'o-o-with-stroke'),
-            (u'\u0111 d with stroke', 'd-d-with-stroke'),
-            (u'\u0127 h with stroke', 'h-h-with-stroke'),
-            (u'\u0131 dotless i', 'i-dotless-i'),
-            (u'\u0142 l with stroke', 'l-l-with-stroke'),
-            (u'\u0167 t with stroke', 't-t-with-stroke'),
-           # From Latin Extended-B
-            (u'\u0180 b with stroke', 'b-b-with-stroke'),
-            (u'\u0183 b with topbar', 'b-b-with-topbar'),
-            (u'\u0188 c with hook', 'c-c-with-hook'),
-            (u'\u018c d with topbar', 'd-d-with-topbar'),
-            (u'\u0192 f with hook', 'f-f-with-hook'),
-            (u'\u0199 k with hook', 'k-k-with-hook'),
-            (u'\u019a l with bar', 'l-l-with-bar'),
-            (u'\u019e n with long right leg', 'n-n-with-long-right-leg'),
-            (u'\u01a5 p with hook', 'p-p-with-hook'),
-            (u'\u01ab t with palatal hook', 't-t-with-palatal-hook'),
-            (u'\u01ad t with hook', 't-t-with-hook'),
-            (u'\u01b4 y with hook', 'y-y-with-hook'),
-            (u'\u01b6 z with stroke', 'z-z-with-stroke'),
-            (u'\u01e5 g with stroke', 'g-g-with-stroke'),
-            (u'\u0225 z with hook', 'z-z-with-hook'),
-            (u'\u0234 l with curl', 'l-l-with-curl'),
-            (u'\u0235 n with curl', 'n-n-with-curl'),
-            (u'\u0236 t with curl', 't-t-with-curl'),
-            (u'\u0237 dotless j', 'j-dotless-j'),
-            (u'\u023c c with stroke', 'c-c-with-stroke'),
-            (u'\u023f s with swash tail', 's-s-with-swash-tail'),
-            (u'\u0240 z with swash tail', 'z-z-with-swash-tail'),
-            (u'\u0247 e with stroke', 'e-e-with-stroke'),
-            (u'\u0249 j with stroke', 'j-j-with-stroke'),
-            (u'\u024b q with hook tail', 'q-q-with-hook-tail'),
-            (u'\u024d r with stroke', 'r-r-with-stroke'),
-            (u'\u024f y with stroke', 'y-y-with-stroke'),
-           # From Latin-1 Supplements
-            (u'\u00e0: a with grave', 'a-a-with-grave'),
-            (u'\u00e1 a with acute', 'a-a-with-acute'),
-            (u'\u00e2 a with circumflex', 'a-a-with-circumflex'),
-            (u'\u00e3 a with tilde', 'a-a-with-tilde'),
-            (u'\u00e4 a with diaeresis', 'a-a-with-diaeresis'),
-            (u'\u00e5 a with ring above', 'a-a-with-ring-above'),
-            (u'\u00e7 c with cedilla', 'c-c-with-cedilla'),
-            (u'\u00e8 e with grave', 'e-e-with-grave'),
-            (u'\u00e9 e with acute', 'e-e-with-acute'),
-            (u'\u00ea e with circumflex', 'e-e-with-circumflex'),
-            (u'\u00eb e with diaeresis', 'e-e-with-diaeresis'),
-            (u'\u00ec i with grave', 'i-i-with-grave'),
-            (u'\u00ed i with acute', 'i-i-with-acute'),
-            (u'\u00ee i with circumflex', 'i-i-with-circumflex'),
-            (u'\u00ef i with diaeresis', 'i-i-with-diaeresis'),
-            (u'\u00f1 n with tilde', 'n-n-with-tilde'),
-            (u'\u00f2 o with grave', 'o-o-with-grave'),
-            (u'\u00f3 o with acute', 'o-o-with-acute'),
-            (u'\u00f4 o with circumflex', 'o-o-with-circumflex'),
-            (u'\u00f5 o with tilde', 'o-o-with-tilde'),
-            (u'\u00f6 o with diaeresis', 'o-o-with-diaeresis'),
-            (u'\u00f9 u with grave', 'u-u-with-grave'),
-            (u'\u00fa u with acute', 'u-u-with-acute'),
-            (u'\u00fb u with circumflex', 'u-u-with-circumflex'),
-            (u'\u00fc u with diaeresis', 'u-u-with-diaeresis'),
-            (u'\u00fd y with acute', 'y-y-with-acute'),
-            (u'\u00ff y with diaeresis', 'y-y-with-diaeresis'),
-           # From Latin Extended-A
-            (u'\u0101 a with macron', 'a-a-with-macron'),
-            (u'\u0103 a with breve', 'a-a-with-breve'),
-            (u'\u0105 a with ogonek', 'a-a-with-ogonek'),
-            (u'\u0107 c with acute', 'c-c-with-acute'),
-            (u'\u0109 c with circumflex', 'c-c-with-circumflex'),
-            (u'\u010b c with dot above', 'c-c-with-dot-above'),
-            (u'\u010d c with caron', 'c-c-with-caron'),
-            (u'\u010f d with caron', 'd-d-with-caron'),
-            (u'\u0113 e with macron', 'e-e-with-macron'),
-            (u'\u0115 e with breve', 'e-e-with-breve'),
-            (u'\u0117 e with dot above', 'e-e-with-dot-above'),
-            (u'\u0119 e with ogonek', 'e-e-with-ogonek'),
-            (u'\u011b e with caron', 'e-e-with-caron'),
-            (u'\u011d g with circumflex', 'g-g-with-circumflex'),
-            (u'\u011f g with breve', 'g-g-with-breve'),
-            (u'\u0121 g with dot above', 'g-g-with-dot-above'),
-            (u'\u0123 g with cedilla', 'g-g-with-cedilla'),
-            (u'\u0125 h with circumflex', 'h-h-with-circumflex'),
-            (u'\u0129 i with tilde', 'i-i-with-tilde'),
-            (u'\u012b i with macron', 'i-i-with-macron'),
-            (u'\u012d i with breve', 'i-i-with-breve'),
-            (u'\u012f i with ogonek', 'i-i-with-ogonek'),
-            (u'\u0133 ligature ij', 'ij-ligature-ij'),
-            (u'\u0135 j with circumflex', 'j-j-with-circumflex'),
-            (u'\u0137 k with cedilla', 'k-k-with-cedilla'),
-            (u'\u013a l with acute', 'l-l-with-acute'),
-            (u'\u013c l with cedilla', 'l-l-with-cedilla'),
-            (u'\u013e l with caron', 'l-l-with-caron'),
-            (u'\u0140 l with middle dot', 'l-l-with-middle-dot'),
-            (u'\u0144 n with acute', 'n-n-with-acute'),
-            (u'\u0146 n with cedilla', 'n-n-with-cedilla'),
-            (u'\u0148 n with caron', 'n-n-with-caron'),
-            (u'\u014d o with macron', 'o-o-with-macron'),
-            (u'\u014f o with breve', 'o-o-with-breve'),
-            (u'\u0151 o with double acute', 'o-o-with-double-acute'),
-            (u'\u0155 r with acute', 'r-r-with-acute'),
-            (u'\u0157 r with cedilla', 'r-r-with-cedilla'),
-            (u'\u0159 r with caron', 'r-r-with-caron'),
-            (u'\u015b s with acute', 's-s-with-acute'),
-            (u'\u015d s with circumflex', 's-s-with-circumflex'),
-            (u'\u015f s with cedilla', 's-s-with-cedilla'),
-            (u'\u0161 s with caron', 's-s-with-caron'),
-            (u'\u0163 t with cedilla', 't-t-with-cedilla'),
-            (u'\u0165 t with caron', 't-t-with-caron'),
-            (u'\u0169 u with tilde', 'u-u-with-tilde'),
-            (u'\u016b u with macron', 'u-u-with-macron'),
-            (u'\u016d u with breve', 'u-u-with-breve'),
-            (u'\u016f u with ring above', 'u-u-with-ring-above'),
-            (u'\u0171 u with double acute', 'u-u-with-double-acute'),
-            (u'\u0173 u with ogonek', 'u-u-with-ogonek'),
-            (u'\u0175 w with circumflex', 'w-w-with-circumflex'),
-            (u'\u0177 y with circumflex', 'y-y-with-circumflex'),
-            (u'\u017a z with acute', 'z-z-with-acute'),
-            (u'\u017c z with dot above', 'z-z-with-dot-above'),
-            (u'\u017e z with caron', 'z-z-with-caron'),
-           # From Latin Extended-B
-            (u'\u01a1 o with horn', 'o-o-with-horn'),
-            (u'\u01b0 u with horn', 'u-u-with-horn'),
-            (u'\u01c6 dz with caron', 'dz-dz-with-caron'),
-            (u'\u01c9 lj', 'lj-lj'),
-            (u'\u01cc nj', 'nj-nj'),
-            (u'\u01ce a with caron', 'a-a-with-caron'),
-            (u'\u01d0 i with caron', 'i-i-with-caron'),
-            (u'\u01d2 o with caron', 'o-o-with-caron'),
-            (u'\u01d4 u with caron', 'u-u-with-caron'),
-            (u'\u01e7 g with caron', 'g-g-with-caron'),
-            (u'\u01e9 k with caron', 'k-k-with-caron'),
-            (u'\u01eb o with ogonek', 'o-o-with-ogonek'),
-            (u'\u01ed o with ogonek and macron', 'o-o-with-ogonek-and-macron'),
-            (u'\u01f0 j with caron', 'j-j-with-caron'),
-            (u'\u01f3 dz', 'dz-dz'),
-            (u'\u01f5 g with acute', 'g-g-with-acute'),
-            (u'\u01f9 n with grave', 'n-n-with-grave'),
-            (u'\u0201 a with double grave', 'a-a-with-double-grave'),
-            (u'\u0203 a with inverted breve', 'a-a-with-inverted-breve'),
-            (u'\u0205 e with double grave', 'e-e-with-double-grave'),
-            (u'\u0207 e with inverted breve', 'e-e-with-inverted-breve'),
-            (u'\u0209 i with double grave', 'i-i-with-double-grave'),
-            (u'\u020b i with inverted breve', 'i-i-with-inverted-breve'),
-            (u'\u020d o with double grave', 'o-o-with-double-grave'),
-            (u'\u020f o with inverted breve', 'o-o-with-inverted-breve'),
-            (u'\u0211 r with double grave', 'r-r-with-double-grave'),
-            (u'\u0213 r with inverted breve', 'r-r-with-inverted-breve'),
-            (u'\u0215 u with double grave', 'u-u-with-double-grave'),
-            (u'\u0217 u with inverted breve', 'u-u-with-inverted-breve'),
-            (u'\u0219 s with comma below', 's-s-with-comma-below'),
-            (u'\u021b t with comma below', 't-t-with-comma-below'),
-            (u'\u021f h with caron', 'h-h-with-caron'),
-            (u'\u0227 a with dot above', 'a-a-with-dot-above'),
-            (u'\u0229 e with cedilla', 'e-e-with-cedilla'),
-            (u'\u022f o with dot above', 'o-o-with-dot-above'),
-            (u'\u0233 y with macron', 'y-y-with-macron'),
-           # digraphs From Latin-1 Supplements
-            (u'\u00df: ligature sz', 'sz-ligature-sz'),
-            (u'\u00e6 ae', 'ae-ae'),
-            (u'\u0153 ligature oe', 'oe-ligature-oe'),
-            (u'\u0238 db digraph', 'db-db-digraph'),
-            (u'\u0239 qp digraph', 'qp-qp-digraph'),
+            ('\u00f8 o with stroke', 'o-o-with-stroke'),
+            ('\u0111 d with stroke', 'd-d-with-stroke'),
+            ('\u0127 h with stroke', 'h-h-with-stroke'),
+            ('\u0131 dotless i', 'i-dotless-i'),
+            ('\u0142 l with stroke', 'l-l-with-stroke'),
+            ('\u0167 t with stroke', 't-t-with-stroke'),
+            # From Latin Extended-B
+            ('\u0180 b with stroke', 'b-b-with-stroke'),
+            ('\u0183 b with topbar', 'b-b-with-topbar'),
+            ('\u0188 c with hook', 'c-c-with-hook'),
+            ('\u018c d with topbar', 'd-d-with-topbar'),
+            ('\u0192 f with hook', 'f-f-with-hook'),
+            ('\u0199 k with hook', 'k-k-with-hook'),
+            ('\u019a l with bar', 'l-l-with-bar'),
+            ('\u019e n with long right leg', 'n-n-with-long-right-leg'),
+            ('\u01a5 p with hook', 'p-p-with-hook'),
+            ('\u01ab t with palatal hook', 't-t-with-palatal-hook'),
+            ('\u01ad t with hook', 't-t-with-hook'),
+            ('\u01b4 y with hook', 'y-y-with-hook'),
+            ('\u01b6 z with stroke', 'z-z-with-stroke'),
+            ('\u01e5 g with stroke', 'g-g-with-stroke'),
+            ('\u0225 z with hook', 'z-z-with-hook'),
+            ('\u0234 l with curl', 'l-l-with-curl'),
+            ('\u0235 n with curl', 'n-n-with-curl'),
+            ('\u0236 t with curl', 't-t-with-curl'),
+            ('\u0237 dotless j', 'j-dotless-j'),
+            ('\u023c c with stroke', 'c-c-with-stroke'),
+            ('\u023f s with swash tail', 's-s-with-swash-tail'),
+            ('\u0240 z with swash tail', 'z-z-with-swash-tail'),
+            ('\u0247 e with stroke', 'e-e-with-stroke'),
+            ('\u0249 j with stroke', 'j-j-with-stroke'),
+            ('\u024b q with hook tail', 'q-q-with-hook-tail'),
+            ('\u024d r with stroke', 'r-r-with-stroke'),
+            ('\u024f y with stroke', 'y-y-with-stroke'),
+            # From Latin-1 Supplements
+            ('\u00e0: a with grave', 'a-a-with-grave'),
+            ('\u00e1 a with acute', 'a-a-with-acute'),
+            ('\u00e2 a with circumflex', 'a-a-with-circumflex'),
+            ('\u00e3 a with tilde', 'a-a-with-tilde'),
+            ('\u00e4 a with diaeresis', 'a-a-with-diaeresis'),
+            ('\u00e5 a with ring above', 'a-a-with-ring-above'),
+            ('\u00e7 c with cedilla', 'c-c-with-cedilla'),
+            ('\u00e8 e with grave', 'e-e-with-grave'),
+            ('\u00e9 e with acute', 'e-e-with-acute'),
+            ('\u00ea e with circumflex', 'e-e-with-circumflex'),
+            ('\u00eb e with diaeresis', 'e-e-with-diaeresis'),
+            ('\u00ec i with grave', 'i-i-with-grave'),
+            ('\u00ed i with acute', 'i-i-with-acute'),
+            ('\u00ee i with circumflex', 'i-i-with-circumflex'),
+            ('\u00ef i with diaeresis', 'i-i-with-diaeresis'),
+            ('\u00f1 n with tilde', 'n-n-with-tilde'),
+            ('\u00f2 o with grave', 'o-o-with-grave'),
+            ('\u00f3 o with acute', 'o-o-with-acute'),
+            ('\u00f4 o with circumflex', 'o-o-with-circumflex'),
+            ('\u00f5 o with tilde', 'o-o-with-tilde'),
+            ('\u00f6 o with diaeresis', 'o-o-with-diaeresis'),
+            ('\u00f9 u with grave', 'u-u-with-grave'),
+            ('\u00fa u with acute', 'u-u-with-acute'),
+            ('\u00fb u with circumflex', 'u-u-with-circumflex'),
+            ('\u00fc u with diaeresis', 'u-u-with-diaeresis'),
+            ('\u00fd y with acute', 'y-y-with-acute'),
+            ('\u00ff y with diaeresis', 'y-y-with-diaeresis'),
+            # From Latin Extended-A
+            ('\u0101 a with macron', 'a-a-with-macron'),
+            ('\u0103 a with breve', 'a-a-with-breve'),
+            ('\u0105 a with ogonek', 'a-a-with-ogonek'),
+            ('\u0107 c with acute', 'c-c-with-acute'),
+            ('\u0109 c with circumflex', 'c-c-with-circumflex'),
+            ('\u010b c with dot above', 'c-c-with-dot-above'),
+            ('\u010d c with caron', 'c-c-with-caron'),
+            ('\u010f d with caron', 'd-d-with-caron'),
+            ('\u0113 e with macron', 'e-e-with-macron'),
+            ('\u0115 e with breve', 'e-e-with-breve'),
+            ('\u0117 e with dot above', 'e-e-with-dot-above'),
+            ('\u0119 e with ogonek', 'e-e-with-ogonek'),
+            ('\u011b e with caron', 'e-e-with-caron'),
+            ('\u011d g with circumflex', 'g-g-with-circumflex'),
+            ('\u011f g with breve', 'g-g-with-breve'),
+            ('\u0121 g with dot above', 'g-g-with-dot-above'),
+            ('\u0123 g with cedilla', 'g-g-with-cedilla'),
+            ('\u0125 h with circumflex', 'h-h-with-circumflex'),
+            ('\u0129 i with tilde', 'i-i-with-tilde'),
+            ('\u012b i with macron', 'i-i-with-macron'),
+            ('\u012d i with breve', 'i-i-with-breve'),
+            ('\u012f i with ogonek', 'i-i-with-ogonek'),
+            ('\u0133 ligature ij', 'ij-ligature-ij'),
+            ('\u0135 j with circumflex', 'j-j-with-circumflex'),
+            ('\u0137 k with cedilla', 'k-k-with-cedilla'),
+            ('\u013a l with acute', 'l-l-with-acute'),
+            ('\u013c l with cedilla', 'l-l-with-cedilla'),
+            ('\u013e l with caron', 'l-l-with-caron'),
+            ('\u0140 l with middle dot', 'l-l-with-middle-dot'),
+            ('\u0144 n with acute', 'n-n-with-acute'),
+            ('\u0146 n with cedilla', 'n-n-with-cedilla'),
+            ('\u0148 n with caron', 'n-n-with-caron'),
+            ('\u014d o with macron', 'o-o-with-macron'),
+            ('\u014f o with breve', 'o-o-with-breve'),
+            ('\u0151 o with double acute', 'o-o-with-double-acute'),
+            ('\u0155 r with acute', 'r-r-with-acute'),
+            ('\u0157 r with cedilla', 'r-r-with-cedilla'),
+            ('\u0159 r with caron', 'r-r-with-caron'),
+            ('\u015b s with acute', 's-s-with-acute'),
+            ('\u015d s with circumflex', 's-s-with-circumflex'),
+            ('\u015f s with cedilla', 's-s-with-cedilla'),
+            ('\u0161 s with caron', 's-s-with-caron'),
+            ('\u0163 t with cedilla', 't-t-with-cedilla'),
+            ('\u0165 t with caron', 't-t-with-caron'),
+            ('\u0169 u with tilde', 'u-u-with-tilde'),
+            ('\u016b u with macron', 'u-u-with-macron'),
+            ('\u016d u with breve', 'u-u-with-breve'),
+            ('\u016f u with ring above', 'u-u-with-ring-above'),
+            ('\u0171 u with double acute', 'u-u-with-double-acute'),
+            ('\u0173 u with ogonek', 'u-u-with-ogonek'),
+            ('\u0175 w with circumflex', 'w-w-with-circumflex'),
+            ('\u0177 y with circumflex', 'y-y-with-circumflex'),
+            ('\u017a z with acute', 'z-z-with-acute'),
+            ('\u017c z with dot above', 'z-z-with-dot-above'),
+            ('\u017e z with caron', 'z-z-with-caron'),
+            # From Latin Extended-B
+            ('\u01a1 o with horn', 'o-o-with-horn'),
+            ('\u01b0 u with horn', 'u-u-with-horn'),
+            ('\u01c6 dz with caron', 'dz-dz-with-caron'),
+            ('\u01c9 lj', 'lj-lj'),
+            ('\u01cc nj', 'nj-nj'),
+            ('\u01ce a with caron', 'a-a-with-caron'),
+            ('\u01d0 i with caron', 'i-i-with-caron'),
+            ('\u01d2 o with caron', 'o-o-with-caron'),
+            ('\u01d4 u with caron', 'u-u-with-caron'),
+            ('\u01e7 g with caron', 'g-g-with-caron'),
+            ('\u01e9 k with caron', 'k-k-with-caron'),
+            ('\u01eb o with ogonek', 'o-o-with-ogonek'),
+            ('\u01ed o with ogonek and macron', 'o-o-with-ogonek-and-macron'),
+            ('\u01f0 j with caron', 'j-j-with-caron'),
+            ('\u01f3 dz', 'dz-dz'),
+            ('\u01f5 g with acute', 'g-g-with-acute'),
+            ('\u01f9 n with grave', 'n-n-with-grave'),
+            ('\u0201 a with double grave', 'a-a-with-double-grave'),
+            ('\u0203 a with inverted breve', 'a-a-with-inverted-breve'),
+            ('\u0205 e with double grave', 'e-e-with-double-grave'),
+            ('\u0207 e with inverted breve', 'e-e-with-inverted-breve'),
+            ('\u0209 i with double grave', 'i-i-with-double-grave'),
+            ('\u020b i with inverted breve', 'i-i-with-inverted-breve'),
+            ('\u020d o with double grave', 'o-o-with-double-grave'),
+            ('\u020f o with inverted breve', 'o-o-with-inverted-breve'),
+            ('\u0211 r with double grave', 'r-r-with-double-grave'),
+            ('\u0213 r with inverted breve', 'r-r-with-inverted-breve'),
+            ('\u0215 u with double grave', 'u-u-with-double-grave'),
+            ('\u0217 u with inverted breve', 'u-u-with-inverted-breve'),
+            ('\u0219 s with comma below', 's-s-with-comma-below'),
+            ('\u021b t with comma below', 't-t-with-comma-below'),
+            ('\u021f h with caron', 'h-h-with-caron'),
+            ('\u0227 a with dot above', 'a-a-with-dot-above'),
+            ('\u0229 e with cedilla', 'e-e-with-cedilla'),
+            ('\u022f o with dot above', 'o-o-with-dot-above'),
+            ('\u0233 y with macron', 'y-y-with-macron'),
+            # digraphs From Latin-1 Supplements
+            ('\u00df: ligature sz', 'sz-ligature-sz'),
+            ('\u00e6 ae', 'ae-ae'),
+            ('\u0153 ligature oe', 'oe-ligature-oe'),
+            ('\u0238 db digraph', 'db-db-digraph'),
+            ('\u0239 qp digraph', 'qp-qp-digraph'),
             
 
     def test_make_id(self):
@@ -543,9 +549,10 @@
             if expect != output:
                 failures.append("'%s' != '%s'" % (expect, output))
         if failures:
-            self.fail("%d failures in %d\n%s" % (len(failures), len(self.ids), "\n".join(failures)))
+            self.fail(f'{len(failures)} failures in {len(self.ids)} ids\n'
+                      + "\n".join(failures))
 
-    def test_traverse(self):
+    def test_findall(self):
         e = nodes.Element()
         e += nodes.Element()
         e0 += nodes.Element()
@@ -553,33 +560,51 @@
         e01 += nodes.Text('some text')
         e += nodes.Element()
         e += nodes.Element()
-        self.assertEqual(list(e.traverse()),
-                          e, e0, e00, e01, e010, e1, e2)
-        self.assertEqual(list(e.traverse(include_self=False)),
-                          e0, e00, e01, e010, e1, e2)
-        self.assertEqual(list(e.traverse(descend=False)),
-                          e)
-        self.assertEqual(list(e0.traverse(descend=False, ascend=True)),
-                          e0, e1, e2)
-        self.assertEqual(list(e00.traverse(descend=False, ascend=True)),
-                          e00, e01, e1, e2)
-        self.assertEqual(list(e00.traverse(descend=False, siblings=True)),
-                          e00, e01)
+        self.assertEqual(list(e.findall()),
+                         e, e0, e00, e01, e010, e1, e2)
+        self.assertEqual(list(e.findall(include_self=False)),
+                         e0, e00, e01, e010, e1, e2)
+        self.assertEqual(list(e.findall(descend=False)),
+                         e)
+        self.assertEqual(list(e0.findall(descend=False, ascend=True)),
+                         e0, e1, e2)
+        self.assertEqual(list(e00.findall(descend=False, ascend=True)),
+                         e00, e01, e1, e2)
+        self.assertEqual(list(e00.findall(descend=False, siblings=True)),
+                         e00, e01)
         self.testlist = e0:2
-        self.assertEqual(list(e.traverse(condition=self.not_in_testlist)),
-                          e, e00, e01, e010, e2)
+        self.assertEqual(list(e.findall(condition=self.not_in_testlist)),
+                         e, e00, e01, e010, e2)
         # Return siblings despite siblings=False because ascend is true.
-        self.assertEqual(list(e1.traverse(ascend=True, siblings=False)),
-                          e1, e2)
-        self.assertEqual(list(e0.traverse()),
-                          e0, e00, e01, e010)
+        self.assertEqual(list(e1.findall(ascend=True, siblings=False)),
+                         e1, e2)
+        self.assertEqual(list(e0.findall()),
+                         e0, e00, e01, e010)
         self.testlist = e00, e01
-        self.assertEqual(list(e0.traverse(condition=self.not_in_testlist)),
-                               e0, e010)
+        self.assertEqual(list(e0.findall(condition=self.not_in_testlist)),
+                         e0, e010)
         self.testlist.append(e010)
-        self.assertEqual(list(e0.traverse(condition=self.not_in_testlist)),
-                               e0)
-        self.assertEqual(list(e.traverse(nodes.TextElement)), e01)
+        self.assertEqual(list(e0.findall(condition=self.not_in_testlist)),
+                         e0)
+        self.assertEqual(list(e.findall(nodes.TextElement)), e01)
+
+    def test_findall_duplicate_texts(self):
+        e = nodes.Element()
+        e += nodes.TextElement()
+        e0 += nodes.Text('one')
+        e0 += nodes.Text('two')
+        e0 += nodes.Text('three')
+        e0 += nodes.Text('two')
+        e0 += nodes.Text('five')
+        full_list = list(e00.findall(siblings=True))
+        self.assertEqual(len(full_list), 5)
+        for i in range(5):
+            self.assertIs(full_listi, e0i)
+
+        partial_list = list(e03.findall(siblings=True))
+        self.assertEqual(len(partial_list), 2)
+        self.assertIs(partial_list0, e03)
+        self.assertIs(partial_list1, e04)
 
     def test_next_node(self):
         e = nodes.Element()
@@ -599,7 +624,7 @@
                    (e2, None)
         for node, next_node in compare:
             self.assertEqual(node.next_node(self.not_in_testlist, ascend=True),
-                              next_node)
+                             next_node)
         self.assertEqual(e00.next_node(ascend=True), e01)
         self.assertEqual(e2.next_node(), None)
 
@@ -676,21 +701,22 @@
     def setUp(self):
         self.document = utils.new_document('test')
         self.elements = nodes.Element(names='test'),
-                         nodes.section(), # Name empty
-                         nodes.section(names='Test'), # duplicate id
-                         nodes.footnote(names='2019-10-30'), # id empty
-                        
+                         nodes.section(),  # Name empty
+                         nodes.section(names='Test'),  # duplicate id
+                         nodes.footnote(names='2019-10-30'),  # id empty
+                         
 
     def test_set_id_default(self):
         # Default prefixes.
         for element in self.elements:
             self.document.set_id(element)
         ids = element'ids' for element in self.elements
-        self.assertEqual(ids, 'test', 'id1', 'id2', 'id3')
+        self.assertEqual(ids, 'test', 'section-1',
+                               'test-1', 'footnote-1')
 
     def test_set_id_custom(self):
         # Custom prefixes.
-        
+
         # Change settings.
         self.document.settings.id_prefix = 'P-'
         self.document.settings.auto_id_prefix = 'auto'
@@ -701,11 +727,11 @@
         self.assertEqual(ids, 'P-test',
                                'P-auto1',
                                'P-auto2',
-                               'P-auto3')
+                               'P-2019-10-30')
 
     def test_set_id_descriptive_auto_id(self):
         # Use name or tag-name for auto-id.
-        
+
         # Change setting.
         self.document.settings.auto_id_prefix = '%'
 
@@ -719,7 +745,7 @@
 
     def test_set_id_custom_descriptive_auto_id(self):
         # Custom prefixes and name or tag-name for auto-id.
-        
+
         # Change settings.
         self.document.settings.id_prefix = 'P:'
         self.document.settings.auto_id_prefix = 'a-%'
@@ -730,7 +756,24 @@
         self.assertEqual(ids, 'P:test',
                                'P:a-section-1',
                                'P:test-1',
-                               'P:a-footnote-1')
+                               'P:2019-10-30')
+
+
+class NodeVisitorTests(unittest.TestCase):
+    def setUp(self):
+        self.document = utils.new_document('test')
+        self.element = nodes.Element()
+        self.visitor = nodes.NodeVisitor(self.document)
+
+    def test_dispatch_visit_unknown(self):
+        # raise exception if no visit/depart methods are defined for node class
+        with self.assertRaises(NotImplementedError):
+            self.visitor.dispatch_visit(self.element)
+
+    def test_dispatch_visit_optional(self):
+        # silently skip nodes of a calss in tuple nodes.NodeVisitor.optional
+        rv = self.visitor.dispatch_visit(nodes.meta())
+        self.assertIsNone(rv)
 
 
 class MiscFunctionTests(unittest.TestCase):

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_get_parser_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_get_parser_class.py Changed

@@ -1,35 +1,58 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_get_parser_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_get_parser_class.py 9346 2023-04-13 18:48:20Z grubert $
 # Author: grubert abadger1999
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
 
-"""
-test get_parser_class
-"""
-from __future__ import absolute_import
+"""test `docutils.parsers.get_parser_class()`"""
 
-if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
-from docutils.parsers import get_parser_class
+from pathlib import Path
+import sys
+import unittest
+
+# Prepend the "docutils root" to the Python library path
+# so we import the local `docutils` and `test` packages.
+# ensure `test` package can be loaded also if not running as __main__
+# (required by ``python -m unittest``
+DOCUTILS_ROOT = Path(__file__).resolve().parents2
+if str(DOCUTILS_ROOT) not in sys.path:
+    sys.path.insert(0, str(DOCUTILS_ROOT))
+
+from docutils.core import publish_string       # noqa: E402
+from docutils.parsers import get_parser_class  # noqa: E402
+try:
+    md_parser_class = get_parser_class('recommonmark')
+except ImportError:
+    md_parser_class = None
 
-class GetParserClassTestCase(DocutilsTestSupport.StandardTestCase):
+
+class GetParserClassTestCase(unittest.TestCase):
 
     def test_registered_parser(self):
-        rdr = get_parser_class('rst')
+        get_parser_class('rst')
         # raises ImportError on failure
 
     def test_bogus_parser(self):
-        self.assertRaises(ImportError,
-                          get_parser_class, 'nope')
+        with self.assertRaises(ImportError):
+            get_parser_class('nope')
 
     def test_local_parser(self):
-        # requires local-parser.py in test directory (testroot)
-        wr = get_parser_class('local-parser')
+        # requires local-parser.py in "test root" directory
+        get_parser_class('test.local-parser')
+        # raises ImportError on failure
+
+
+@unittest.skipIf(md_parser_class is not None,
+                 'Optional "recommonmark" module found.')
+class RecommonmarkMissingTests(unittest.TestCase):
+
+    def test_missing_parser_message(self):
+        # match multiline message (?s) = re.DOTALL "." also matches newline
+        with self.assertRaisesRegex(ImportError,
+                                    '(?s)requires the.*package .*recommonmark'):
+            publish_string('test data', parser_name='recommonmark')
+
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()
-

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_parser.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_parser.py Changed

@@ -1,6 +1,5 @@
-#! /usr/bin/env python
-
-# $Id: test_parser.py 8367 2019-08-27 12:09:56Z milde $
+#! /usr/bin/env python3
+# $Id: test_parser.py 9308 2022-12-13 21:45:23Z milde $
 # Author: Stefan Rank <strank(AT)strank(DOT)info>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,10 +7,15 @@
 Tests for basic functionality of parser classes.
 """
 
+from pathlib import Path
 import sys
 import unittest
-import DocutilsTestSupport              # must be imported before docutils
-import docutils
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
 from docutils import parsers, utils, frontend
 
 
@@ -20,16 +24,10 @@
     def test_inputrestrictions(self):
         parser_class = parsers.get_parser_class('rst')
         parser = parser_class()
-        document = utils.new_document('test data', frontend.OptionParser(
-                    components=(parser, )).get_default_values())
-
-        if sys.version_info < (3, 0):
-            # supplying string input is supported, but only if ascii-decodable
-            self.assertRaises(UnicodeDecodeError,
-                              parser.parse, b'hol%s' % chr(224), document)
-        else:
-            # input must be unicode at all times
-            self.assertRaises(TypeError, parser.parse, b'hol', document)
+        document = utils.new_document('test data',
+                                      frontend.get_default_settings(parser))
+        # input must be unicode at all times
+        self.assertRaises(TypeError, parser.parse, b'hol', document)
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_block_quotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_block_quotes.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_bullet_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_bullet_lists.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_enumerated_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_enumerated_lists.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -13,16 +12,33 @@
 Test for enumerated lists in CommonMark parsers
 Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
+
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -381,5 +397,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_html_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_html_blocks.py Changed

@@ -1,6 +1,5 @@
 #! /usr/bin/env python3
-# -*- coding: utf-8 -*-
-# $Id: test_html_blocks.py 8594 2020-12-15 23:06:43Z milde $
+# $Id: test_html_blocks.py 9301 2022-12-02 17:13:54Z milde $
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,17 +13,33 @@
 Tests for HTML blocks in CommonMark parsers
 Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
 
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -65,30 +80,30 @@
 """,
 """\
 <document source="test data">
-    <paragraph>
-        <raw format="html" xml:space="preserve">
-            <a href="foo">
-        \n\
-        <emphasis>
-            bar
-        \n\
-        <raw format="html" xml:space="preserve">
-            </a>
-""",
-"""\
-*bar*
-*baz*
-""",
-"""\
-<document source="test data">
     <raw format="html" xml:space="preserve">
-        *bar*
-        *baz*
+        <a href="foo">
+        *bar*
+        </a>
 """,
+# In recommonmark 0.7.0, some raw blocks at paragraph start make the
+# paragraph a raw block :(
+# """\
+# *bar* (raw because of the comment tag at start of paragraph)
+# *baz*
+# """,
+# """\
+# <document source="test data">
+#     <paragraph>
+#         <raw format="html" xml:space="preserve">
+#             
+#         <emphasis>
+#             bar
+#     <paragraph>
+#         <emphasis>
+#             baz
+# """,
 
 
 
-
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_inline_markup.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_inline_markup.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,17 +13,32 @@
 Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
 """
 
-from __future__ import absolute_import
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
+
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -42,10 +56,10 @@
         <emphasis>
             also emphasis
 """,
-u"""\
+"""\
 Partially*emphasised*word.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Partially
@@ -192,10 +206,10 @@
         <literal classes="code">
             literal\\
 """,
-u"""\
+"""\
 l'``literal`` and l\u2019``literal`` with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -206,12 +220,12 @@
             literal
          with apostrophe
 """,
-u"""\
+"""\
 quoted '``literal``', quoted "``literal``",
 quoted \u2018``literal``\u2019, quoted \u201c``literal``\u201d,
 quoted \xab``literal``\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -233,12 +247,12 @@
             literal
         \xbb
 """,
-u"""\
+"""\
 ``'literal'`` with quotes, ``"literal"`` with quotes,
 ``\u2018literal\u2019`` with quotes, ``\u201cliteral\u201d`` with quotes,
 ``\xabliteral\xbb`` with quotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         <literal classes="code">
@@ -266,7 +280,7 @@
 <document source="test data">
     <paragraph>
         <literal classes="code">
-            literal
+            literal \n\
         no literal
     <paragraph>
         No warning for `standalone TeX quotes\' or other \n\
@@ -326,20 +340,21 @@
         <reference name="ref" refuri="/uri">
             ref
 """,
-"""\
-Inline image !foo *bar*foobar
-in a paragraph.
-
-FOOBAR: train.jpg "train & tracks"
-""",
-"""\
-<document source="test data">
-    <paragraph>
-        Inline image \n\
-        <image alt="foo " title="train & tracks" uri="train.jpg">
-        \n\
-        in a paragraph.
-""",
+# Fails with recommonmark 0.6.0:
+# """\
+# Inline image !foo *bar*
+# in a paragraph.
+#
+# foo *bar*: train.jpg "train & tracks"
+# """,
+# """\
+# <document source="test data">
+#     <paragraph>
+#         Inline image \n\
+#         <image alt="foo " title="train & tracks" uri="train.jpg">
+#         \n\
+#         in a paragraph.
+# """,
 """\
 phrase reference
 
@@ -351,12 +366,12 @@
         <reference name="phrase reference" refuri="/uri">
             phrase reference
 """,
-u"""\
+"""\
 No whitespace required around aphrase reference.
 
 phrase reference: /uri
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         No whitespace required around a
@@ -373,20 +388,20 @@
 """\
 <document source="test data">
     <paragraph>
-        <reference name="phrase referenceacross lines" refuri="/uri">
+        <reference name="phrase reference across lines" refuri="/uri">
             phrase reference
             across lines
 """,
 
 
-totest'appended_URIs' = 
+totest'appended_uris' = 
 """\
 anonymous reference(http://example.com)
 """,
 """\
 <document source="test data">
     <paragraph>
-        <reference name="anonymous reference" refuri="http://example.com">
+        <reference refuri="http://example.com">
             anonymous reference
 """,
 """\
@@ -399,16 +414,17 @@
         <image alt="a train" uri="train.jpg">
          more text.
 """,
-"""\
-Inline image !foo(/url "title") more text.
-""",
-"""\
-<document source="test data">
-    <paragraph>
-        Inline image \n\
-        <image alt="foo" title="title" uri="/url">
-         more text.
-""",
+# recommonmark 0.6.0 drops the "title"
+# """\
+# Inline image !foo(/url "title") more text.
+# """,
+# """\
+# <document source="test data">
+#     <paragraph>
+#         Inline image \n\
+#         <image alt="foo" title="title" uri="/url">
+#          more text.
+# """,
 """\
 URI must follow immediately
 (http://example.com)
@@ -434,7 +450,7 @@
 """,
 
 
-totest'standalone hyperlink' = 
+totest'standalone_hyperlink' = 
 """\
 CommonMark calls standalone hyperlinks
 like <http://example.com> "autolinks".
@@ -444,13 +460,13 @@
     <paragraph>
         CommonMark calls standalone hyperlinks
         like \n\
-        <reference name="http://example.com" refuri="http://example.com">
+        <reference refuri="http://example.com">
             http://example.com
          "autolinks".
 """,
 
 
-totest'raw HTML' = 
+totest'raw_html' = 
 """\
 foo <a href="uri"> bar
 """,
@@ -481,21 +497,25 @@
 """,
 """\
 Hard line breaks are not supported by Docutils.
-Not the soft line break preceded by two or more spaces,  \n\
-nor the more visible alternative,\\
-a backslash before the line ending.
+"recommonmark 0.6.0" converts both, invisible  \n\
+(two or more trailing spaces) nor visible\\
+(trailing backslash) to raw HTML.
 """,
 """\
 <document source="test data">
     <paragraph>
         Hard line breaks are not supported by Docutils.
-        Not the soft line break preceded by two or more spaces,\
-nor the more visible alternative,\
-a backslash before the line ending.
+        "recommonmark 0.6.0" converts both, invisible
+        <raw format="html" xml:space="preserve">
+            <br />
+        (two or more trailing spaces) nor visible
+        <raw format="html" xml:space="preserve">
+            <br />
+        (trailing backslash) to raw HTML.
 """,
 
 
-totest'markup recognition rules' = 
+totest'markup_recognition_rules' = 
 r"""
 Character-level m*a***r**`k`_u_p
 works except for underline.
@@ -517,5 +537,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_line_length_limit.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_line_length_limit.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,18 +13,35 @@
 Tests for inline markup in docutils/parsers/rst/states.py.
 Interpreted text tests are in a separate module, test_interpreted.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
 
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.line_length_limit = 80
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite(
-            suite_settings={'line_length_limit': 80})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -54,5 +70,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_line_length_limit_default.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_line_length_limit_default.py Changed

@@ -1,6 +1,5 @@
 #! /usr/bin/env python3
-# -*- coding: utf-8 -*-
-# $Id: test_line_length_limit_default.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_line_length_limit_default.py 9301 2022-12-02 17:13:54Z milde $
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -15,17 +14,34 @@
 Tests for inline markup in docutils/parsers/rst/states.py.
 Interpreted text tests are in a separate module, test_interpreted.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
 
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -54,5 +70,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_literal_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_literal_blocks.py Changed

@@ -1,6 +1,5 @@
 #! /usr/bin/env python3
-# -*- coding: utf-8 -*-
-# $Id: test_literal_blocks.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_literal_blocks.py 9301 2022-12-02 17:13:54Z milde $
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,17 +13,33 @@
 Tests for literal blocks in CommonMark parsers
 Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -142,7 +157,7 @@
 
       A wonky literal block.
     Literal line 2.
-  
+
       Literal line 3.
 """,
 """\
@@ -158,18 +173,18 @@
 """\
 A paragraph:
 ~~~
-  A fenced literal block.
+  A fenced code block.
 Literal line 2.
 
   Literal line 3.
-~~~  
+~~~
 """,
 """\
 <document source="test data">
     <paragraph>
         A paragraph:
     <literal_block classes="code" xml:space="preserve">
-          A fenced literal block.
+          A fenced code block.
         Literal line 2.
         \n\
           Literal line 3.
@@ -189,10 +204,22 @@
         A literal block (fenced code block)
         with *info string*.
 """,
+"""\
+~~~eval_rst
+Evaluating embedded rST blocks requires the AutoStructify component
+in recommonmark. Otherwise this is just a code block
+with class ``eval_rst``.
+~~~
+""",
+"""\
+<document source="test data">
+    <literal_block classes="code eval_rst" xml:space="preserve">
+        Evaluating embedded rST blocks requires the AutoStructify component
+        in recommonmark. Otherwise this is just a code block
+        with class ``eval_rst``.
+""",
 
 
 
-
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_misc.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_misc.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,24 +13,19 @@
 Various tests for the recommonmark parser.
 """
 
-from __future__ import absolute_import
+from pathlib import Path
 import sys
 import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport # must be imported before docutils
-from docutils import core, utils
-from docutils.core import publish_string
-from docutils.parsers import recommonmark_wrapper
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
 
-sample1 = """\
-Test unexpected section titles.
+from docutils.core import publish_string
+from docutils.parsers.rst import directives as rst_directives
+from docutils.parsers.recommonmark_wrapper import Parser
 
-* Title
-  =====
-  Paragraph.
-"""
 
 sample_with_html = """\
 A paragraph:
@@ -46,55 +40,34 @@
 Final paragraph.
 """
 
-skip_msg = 'optional module "recommonmark" not found'
 
-class reCommonMarkParserTests(unittest.TestCase):
+@unittest.skipIf(Parser is None, 'Optional "recommonmark" module not found.')
+class RecommonmarkParserTests(unittest.TestCase):
 
-    @unittest.skipUnless(recommonmark_wrapper.CommonMarkParser, skip_msg)
-    def test_parsing_error(self):
-        output = publish_string(sample1, parser_name='recommonmark',
-                                settings_overrides={'warning_stream': ''})
+    def test_parser_name(self):
+        # cf. ../test_rst/test_directives/test__init__.py
+        # this is used in the "include" directive's :parser: option.
+        self.assertIs(rst_directives.parser_name('recommonmark'), Parser)
 
-        self.assertIn(b'Parsing with "recommonmark" returned the error:',
-                      output)
-
-    @unittest.skipUnless(recommonmark_wrapper.CommonMarkParser, skip_msg)
     def test_raw_disabled(self):
-        output = publish_string(sample_with_html, parser_name='recommonmark',
-                                settings_overrides={'warning_stream': '',
-                                                    'raw_enabled': False})
+        output = publish_string(sample_with_html, parser=Parser(),
+                                settings_overrides={
+                                    'warning_stream': '',
+                                    'raw_enabled': False,
+                                    })
         self.assertNotIn(b'<raw>', output)
         self.assertIn(b'<system_message', output)
         self.assertIn(b'Raw content disabled.', output)
 
-    @unittest.skipUnless(recommonmark_wrapper.CommonMarkParser, skip_msg)
     def test_raw_disabled_inline(self):
-        output = publish_string('foo <a href="uri">', parser_name='recommonmark',
+        output = publish_string('foo <a href="uri">', parser=Parser(),
                                 settings_overrides={'warning_stream': '',
                                                     'raw_enabled': False,
-                                                   })
+                                                    })
         self.assertNotIn(b'<raw>', output)
         self.assertIn(b'<system_message', output)
         self.assertIn(b'Raw content disabled.', output)
 
 
-    @unittest.skipUnless(recommonmark_wrapper.CommonMarkParser, skip_msg)
-    def test_raw_disabled(self):
-        output = publish_string(sample_with_html, parser_name='recommonmark',
-                                settings_overrides={'warning_stream': '',
-                                                    'raw_enabled': False,
-                                                    'report_level': 3,
-                                                   })
-        self.assertNotIn(b'<raw>', output)
-        self.assertNotIn(b'<system_message', output)
-
-    @unittest.skipIf(recommonmark_wrapper.CommonMarkParser,
-                     'recommonmark_wrapper: parser found, fallback not used')
-    def test_fallback_parser(self):
-        output = publish_string(sample1, parser_name='recommonmark',
-                                settings_overrides={'warning_stream': ''})
-        self.assertIn(b'Python did not find the required module "recommonmark"',
-                      output)
-
 if __name__ == '__main__':
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_paragraphs.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_paragraphs.py Changed

@@ -1,23 +1,39 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_paragraphs.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_paragraphs.py 9301 2022-12-02 17:13:54Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
 
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -77,5 +93,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_section_headers.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_section_headers.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,17 +13,33 @@
 Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
 """
 
-from __future__ import absolute_import
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
 
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
+
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -34,8 +49,7 @@
 =========
 Paragraph.
 """,
-"""\
-<document source="test data">
+r"""<document source="test data">
     <section ids="the-title" names="the\ title">
         <title>
             The Title
@@ -47,8 +61,7 @@
 =====================
 Paragraph (no blank line required).
 """,
-"""\
-<document source="test data">
+r"""<document source="test data">
     <section ids="another-section-title" names="another\ section\ title">
         <title>
             Another Section Title
@@ -75,10 +88,10 @@
 """,
 # """\
 # Test unexpected section titles.
-# 
+#
 # * Title
 #   =====
-#   
+#
 #   Paragraph.
 # """,
 # """\
@@ -123,26 +136,25 @@
 -------
 Paragraph 4.
 """,
-"""\
-<document source="test data">
+r"""<document source="test data">
     <paragraph>
         Test return to existing, highest-level section (Title 3).
-    <section ids="title-1" names="title\\ 1">
+    <section ids="title-1" names="title\ 1">
         <title>
             Title 1
         <paragraph>
             Paragraph 1.
-        <section ids="title-2" names="title\\ 2">
+        <section ids="title-2" names="title\ 2">
             <title>
                 Title 2
             <paragraph>
                 Paragraph 2.
-    <section ids="title-3" names="title\\ 3">
+    <section ids="title-3" names="title\ 3">
         <title>
             Title 3
         <paragraph>
             Paragraph 3.
-        <section ids="title-4" names="title\\ 4">
+        <section ids="title-4" names="title\ 4">
             <title>
                 Title 4
             <paragraph>
@@ -161,45 +173,24 @@
 
 ### Title 5
 """,
-"""\
-<document source="test data">
+r"""<document source="test data">
     <paragraph>
         Test bad subsection order.
-    <section ids="title-1" names="title\\ 1">
+    <section ids="title-1" names="title\ 1">
         <title>
             Title 1
-        <system_message level="2" source="test data" type="WARNING">
-            <paragraph>
-                Title level inconsistent. Changing from 2 to 1.
-            <literal_block xml:space="preserve">
-                Title 1
-    <section ids="title-2" names="title\\ 2">
+    <section ids="title-2" names="title\ 2">
         <title>
             Title 2
-        <system_message level="2" source="test data" type="WARNING">
-            <paragraph>
-                Title level inconsistent. Changing from 2 to 1.
-            <literal_block xml:space="preserve">
-                Title 2
-    <section ids="title-3" names="title\\ 3">
+    <section ids="title-3" names="title\ 3">
         <title>
             Title 3
         <section ids="title-4" names="title\ 4">
             <title>
                 Title 4
-            <system_message level="2" source="test data" type="WARNING">
-                <paragraph>
-                    Title level inconsistent. Changing from 4 to 2.
-                <literal_block xml:space="preserve">
-                    Title 4
         <section ids="title-5" names="title\ 5">
             <title>
                 Title 5
-            <system_message level="2" source="test data" type="WARNING">
-                <paragraph>
-                    Title level inconsistent. Changing from 3 to 2.
-                <literal_block xml:space="preserve">
-                    Title 5
 """,
 """\
 Title containing *inline* ``markup``
@@ -264,5 +255,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_targets.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_targets.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_recommonmark/test_transitions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_recommonmark/test_transitions.py Changed

@@ -1,28 +1,44 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_transitions.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_transitions.py 9301 2022-12-02 17:13:54Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for transitions (`thematic breaks`).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.recommonmark_wrapper import Parser
+from docutils.utils import new_document
+
 
+class RecommonmarkParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.RecommonmarkParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
-# See DocutilsTestSupport.RecommonmarkParserTestSuite.generateTests for a
-# description of the 'totest' data structure.
+# Each dictionary key (test type name) maps to a list of tests. Each
+# test is a list: input, expected output.
 totest'transitions' = 
 """\
 Test transition markers.
@@ -70,21 +86,21 @@
 """,
 # """\
 # --------
-# 
+#
 # A section or document may not begin with a transition.
-# 
+#
 # The DTD specifies that two transitions may not
 # be adjacent:
-# 
+#
 # --------
-# 
+#
 # --------
-# 
+#
 # --------
-# 
+#
 # The DTD also specifies that a section or document
 # may not end with a transition.
-# 
+#
 # --------
 # """,
 # """\
@@ -204,7 +220,7 @@
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -314,5 +330,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/__init__.py Changed

_service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/includes/include14.txt Added

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_SimpleTableParser.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_SimpleTableParser.py Changed

@@ -1,23 +1,38 @@
-#! /usr/bin/env python
-# .. coding: utf-8
-
-# $Id: test_SimpleTableParser.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_SimpleTableParser.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.parsers.rst import tableparser
+from docutils.statemachine import StringList, string2lines
+
+
+class SimpleTableParserTestCase(unittest.TestCase):
+    def test_parse(self):
+        parser = tableparser.SimpleTableParser()
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                lines_input = StringList(string2lines(case_input), 'test data')
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    try:
+                        output = parser.parse(lines_input)
+                    except Exception as details:
+                        output = f'{details.__class__.__name__}: {details}'
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.SimpleTableParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -31,15 +46,15 @@
  ,
  0, 0, 1, 'A table with',
    0, 0, 1, 'two columns.'),
-u"""\
+"""\
 ============  ===============
 A tāble w̅ith  comb̲ining chars
 ============  ===============
 """,
 (12, 15,
  ,
- 0, 0, 1, u'A ta\u0304ble w\u0305ith',
-   0, 0, 1, u'comb\u0332ining chars'),
+ 0, 0, 1, 'A ta\u0304ble w\u0305ith',
+   0, 0, 1, 'comb\u0332ining chars'),
 """\
 ============  ============
 A table with  two columns
@@ -66,9 +81,9 @@
 ==========  ===========
 A table with four rows,
 -----------------------
-and two     columns.   
-First and   last rows     
-contain column spans.   
+and two     columns.
+First and   last rows
+contain column spans.
 =======================
 """,
 (10, 11,
@@ -97,10 +112,10 @@
 ===========  ================
 A table with two header rows,
 -----------------------------
-the first    with a span.    
+the first    with a span.
 ===========  ================
-Two body     rows,           
-the second with a span.      
+Two body     rows,
+the second with a span.
 =============================
 """,
 (11, 16,
@@ -147,5 +162,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_TableParser.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_TableParser.py Changed

@@ -1,23 +1,54 @@
-#! /usr/bin/env python
-# coding: utf-8
-
-# $Id: test_TableParser.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_TableParser.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.parsers.rst import tableparser
+from docutils.statemachine import StringList, string2lines
+
+
+class GridTableParserTestCase(unittest.TestCase):
+    def test_parse_table(self):
+        parser = tableparser.GridTableParser()
+        for name, cases in totest.items():
+            for casenum, case in enumerate(cases):
+                case_input, case_table, case_expected = case
+                lines_input = StringList(string2lines(case_input), 'test data')
+                parser.setup(lines_input)
+                try:
+                    parser.find_head_body_sep()
+                    parser.parse_table()
+                    output = parser.cells
+                except Exception as details:
+                    output = f'{details.__class__.__name__}: {details}'
+                self.assertEqual(output, case_table)
+
+    def test_parse(self):
+        parser = tableparser.GridTableParser()
+        for name, cases in totest.items():
+            for casenum, case in enumerate(cases):
+                case_input, case_table, case_expected = case
+                lines_input = StringList(string2lines(case_input), 'test data')
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    try:
+                        output = parser.parse(lines_input)
+                    except Exception as details:
+                        output = f'{details.__class__.__name__}: {details}'
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.GridTableParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -43,17 +74,17 @@
  (0, 0, 1, 'A table with'),
    (0, 0, 1, 'two columns.')),
 # Combining chars in grid tables still fail
-# u"""\
+# """\
 # +--------------+------------------+
 # | A tāble w̅ith | comb̲ining chars. |
 # +--------------+------------------+
 # """,
-# (0, 0, 2, 15, u'A table with'),
-#  (0, 15, 2, 30, u'combining chars.'),
+# (0, 0, 2, 15, 'A table with'),
+#  (0, 15, 2, 30, 'combining chars.'),
 # (14, 14,
 #  ,
-#  (0, 0, 1, u'A table with'),
-#    (0, 0, 1, u'combining chars.')),
+#  (0, 0, 1, 'A table with'),
+#    (0, 0, 1, 'combining chars.')),
 """\
 +--------------+-------------+
 | A table with | two columns |
@@ -217,5 +248,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_block_quotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_block_quotes.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_block_quotes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_block_quotes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -148,7 +166,7 @@
         <attribution>
             Attribution
 """,
-u"""\
+"""\
 Alternative: true em-dash.
 
    Block quote.
@@ -383,5 +401,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_bullet_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_bullet_lists.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_bullet_lists.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_bullet_lists.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -175,7 +193,7 @@
     <paragraph>
         empty item above, no blank line
 """,
-u"""\
+"""\
 Unicode bullets:
 
 \u2022 BULLET
@@ -184,7 +202,7 @@
 
 \u2043 HYPHEN BULLET
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Unicode bullets:
@@ -204,5 +222,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_character_level_inline_markup.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_character_level_inline_markup.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_character_level_inline_markup.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_character_level_inline_markup.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -11,16 +9,35 @@
 
 Experimental.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.character_level_inline_markup = True
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings={'character_level_inline_markup': True})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -72,13 +89,13 @@
         } (open/close pairs)
         <emphasis>
             emphasis
-        ., 
+        ., \n\
         <emphasis>
             emphasis
-        ,, 
+        ,, \n\
         <emphasis>
             emphasis
-        !, and 
+        !, and \n\
         <emphasis>
             emphasis
         (closing delimiters),
@@ -108,26 +125,26 @@
         but not
         (*), *, '*' or '"*"' ("quoted" start-string),
         *args or * (escaped; whitespace behind start-string),
-        or 
+        or \n\
         <emphasis>
             the* *stars* *inside
          (escaped; whitespace before end-string).
     <paragraph>
         However, '
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             *
         args' triggers a warning.
-    <system_message backrefs="id2" ids="id1" level="2" line="15" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="15" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
     <paragraph>
-        Also 
+        Also \n\
         <emphasis>
             this
-        <problematic ids="id4" refid="id3">
+        <problematic ids="problematic-2" refid="system-message-2">
             *
         .
-    <system_message backrefs="id4" ids="id3" level="2" line="17" source="test data" type="WARNING">
+    <system_message backrefs="problematic-2" ids="system-message-2" level="2" line="17" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
@@ -186,12 +203,12 @@
         Strong asterisk: \n\
         <strong>
             *
-        
+        \n\
         and
-        strong double asterisk: 
+        strong double asterisk: \n\
         <strong>
             **
-        
+        \n\
         require escaping with simple-inline-markup.
 """,
 
@@ -203,7 +220,7 @@
 """\
 <document source="test data">
     <paragraph>
-        With simple-inline-markup, this is 
+        With simple-inline-markup, this is \n\
         <literal>
             `interpreted text
         ` in backquotes!
@@ -214,10 +231,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             ``
         literal without closing backquotes
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline literal start-string without end-string.
 """,
@@ -269,7 +286,7 @@
 """,
 
 
-totest'embedded_URIs' = 
+totest'embedded_uris' = 
 r"""
 Escape chars in URIs:
 
@@ -308,7 +325,7 @@
     <paragraph>
         This isn't a _target; targets require backquotes.
     <paragraph>
-        With simple-inline-markup, 
+        With simple-inline-markup, \n\
         <target ids="this" names="this">
             this
         _ is a a target followed by an
@@ -328,20 +345,20 @@
 <document source="test data">
     <paragraph>
         Adjacent footnote refs are possible with simple-inline-markup:
-        <footnote_reference auto="*" ids="id1">
-        <footnote_reference auto="1" ids="id2" refname="label">
-         
-        <footnote_reference auto="1" ids="id3">
-        <footnote_reference ids="id4" refname="2">
+        <footnote_reference auto="*" ids="footnote-reference-1">
+        <footnote_reference auto="1" ids="footnote-reference-2" refname="label">
+         \n\
+        <footnote_reference auto="1" ids="footnote-reference-3">
+        <footnote_reference ids="footnote-reference-4" refname="2">
             2
-         
-        <footnote_reference ids="id5" refname="1">
+         \n\
+        <footnote_reference ids="footnote-reference-5" refname="1">
             1
-        <footnote_reference auto="*" ids="id6">
-    <footnote auto="1" ids="id7">
+        <footnote_reference auto="*" ids="footnote-reference-6">
+    <footnote auto="1" ids="footnote-1">
         <paragraph>
             test1
-    <footnote auto="*" ids="id8">
+    <footnote auto="*" ids="footnote-2">
         <paragraph>
             test2
 """,
@@ -356,9 +373,9 @@
 <document source="test data">
     <paragraph>
         Adjacent citation refs are possible with simple-inline-markup:
-        <citation_reference ids="id1" refname="citation">
+        <citation_reference ids="citation-reference-1" refname="citation">
             citation
-        <citation_reference ids="id2" refname="cit1">
+        <citation_reference ids="citation-reference-2" refname="cit1">
             CIT1
 """,
 
@@ -399,7 +416,7 @@
     <paragraph>
         <reference refuri="http://example.com/*content">
             http://example.com/*content
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             *
         /whatever
         <reference refuri="http://example.com/">
@@ -407,13 +424,13 @@
         <reference name="rST_for" refname="rst_for">
             rST_for
         all.html
-    <system_message backrefs="id2" ids="id1" level="2" line="8" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="8" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
 
 
-totest'markup recognition rules' = 
+totest'markup_recognition_rules' = 
 """\
 __This__ is an anonymous reference with simple-inline-markup.
 """,
@@ -445,11 +462,11 @@
         p
         with backslash-escaped whitespace, including newlines.
 """,
-u"""\
+"""\
 text-*separated*\u2010*by*\u2011*various*\u2012*dashes*\u2013*and*\u2014*hyphens*.
 \u00bf*punctuation*? \u00a1*examples*!\xa0*no-break-space*\xa0.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         text-
@@ -483,7 +500,7 @@
         \xa0.
 """,
 # Whitespace characters:
-u"""\
+"""\
 inline markup surrounded by various whitespace characters:
 *newline*
 or *space* or one of
@@ -506,7 +523,7 @@
 \u3000*IDEOGRAPHIC SPACE*\u3000,
 \u2028*LINE SEPARATOR*\u2028
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         inline markup surrounded by various whitespace characters:
@@ -589,7 +606,7 @@
         <emphasis>
             LINE SEPARATOR
 """,
-u"""\
+"""\
 no inline markup due to whitespace inside and behind: *
 newline
 *
@@ -612,7 +629,7 @@
 *\u3000IDEOGRAPHIC SPACE\u3000*
 *\u2028LINE SEPARATOR\u2028*
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         no inline markup due to whitespace inside and behind: *
@@ -637,9 +654,10 @@
         *\u3000IDEOGRAPHIC SPACE\u3000*
         *
         LINE SEPARATOR
-        *""",
+        *
+""",
 # « * » ‹ * › « * » ‹ * › « * » ‹ * › French,
-u"""\
+"""\
 "Quoted" markup start-string (matched openers & closers) -> no markup:
 
 '*' "*" (*) <*> * {*}
@@ -657,7 +675,7 @@
 
 But this is „*’ emphasized »*‹.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         "Quoted" markup start-string (matched openers & closers) -> no markup:
@@ -684,5 +702,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_citations.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_citations.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_citations.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_citations.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -156,7 +174,7 @@
             citation.withdot
         <paragraph>
             one dot
-    <citation ids="id1" names="citation-withdot">
+    <citation ids="citation-withdot-1" names="citation-withdot">
         <label>
             citation-withdot
         <paragraph>
@@ -181,5 +199,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_comments.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_comments.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_comments.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_comments.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -316,5 +334,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_definition_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_definition_lists.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_definition_lists.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_definition_lists.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -299,75 +317,75 @@
         <definition_list_item>
             <term>
                 Term \n\
-                <problematic ids="id2" refid="id1">
+                <problematic ids="problematic-1" refid="system-message-1">
                     `
                 with \n\
-                <problematic ids="id4" refid="id3">
+                <problematic ids="problematic-2" refid="system-message-2">
                     *
                 inline \n\
-                <problematic ids="id6" refid="id5">
+                <problematic ids="problematic-3" refid="system-message-3">
                     ``
                 text \n\
-                <problematic ids="id8" refid="id7">
+                <problematic ids="problematic-4" refid="system-message-4">
                     **
                 errors
             <classifier>
                 classifier \n\
-                <problematic ids="id10" refid="id9">
+                <problematic ids="problematic-5" refid="system-message-5">
                     `
                 with \n\
-                <problematic ids="id12" refid="id11">
+                <problematic ids="problematic-6" refid="system-message-6">
                     *
                 errors \n\
-                <problematic ids="id14" refid="id13">
+                <problematic ids="problematic-7" refid="system-message-7">
                     ``
                 too
             <definition>
-                <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline interpreted text or phrase reference start-string without end-string.
-                <system_message backrefs="id4" ids="id3" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-2" ids="system-message-2" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline emphasis start-string without end-string.
-                <system_message backrefs="id6" ids="id5" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-3" ids="system-message-3" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline literal start-string without end-string.
-                <system_message backrefs="id8" ids="id7" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-4" ids="system-message-4" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline strong start-string without end-string.
-                <system_message backrefs="id10" ids="id9" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-5" ids="system-message-5" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline interpreted text or phrase reference start-string without end-string.
-                <system_message backrefs="id12" ids="id11" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-6" ids="system-message-6" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline emphasis start-string without end-string.
-                <system_message backrefs="id14" ids="id13" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-7" ids="system-message-7" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline literal start-string without end-string.
                 <paragraph>
                     Definition \n\
-                    <problematic ids="id16" refid="id15">
+                    <problematic ids="problematic-8" refid="system-message-8">
                         `
                     with \n\
-                    <problematic ids="id18" refid="id17">
+                    <problematic ids="problematic-9" refid="system-message-9">
                         *
                     inline \n\
-                    <problematic ids="id20" refid="id19">
+                    <problematic ids="problematic-10" refid="system-message-10">
                         ``
                     text \n\
-                    <problematic ids="id22" refid="id21">
+                    <problematic ids="problematic-11" refid="system-message-11">
                         **
                     markup errors.
-                <system_message backrefs="id16" ids="id15" level="2" line="2" source="test data" type="WARNING">
+                <system_message backrefs="problematic-8" ids="system-message-8" level="2" line="2" source="test data" type="WARNING">
                     <paragraph>
                         Inline interpreted text or phrase reference start-string without end-string.
-                <system_message backrefs="id18" ids="id17" level="2" line="2" source="test data" type="WARNING">
+                <system_message backrefs="problematic-9" ids="system-message-9" level="2" line="2" source="test data" type="WARNING">
                     <paragraph>
                         Inline emphasis start-string without end-string.
-                <system_message backrefs="id20" ids="id19" level="2" line="2" source="test data" type="WARNING">
+                <system_message backrefs="problematic-10" ids="system-message-10" level="2" line="2" source="test data" type="WARNING">
                     <paragraph>
                         Inline literal start-string without end-string.
-                <system_message backrefs="id22" ids="id21" level="2" line="2" source="test data" type="WARNING">
+                <system_message backrefs="problematic-11" ids="system-message-11" level="2" line="2" source="test data" type="WARNING">
                     <paragraph>
                         Inline strong start-string without end-string.
 """,
@@ -430,5 +448,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/include.md -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/include.md Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/include10.txt -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/include10.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test__init__.py Changed

@@ -1,7 +1,6 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-# $Id: test__init__.py 8595 2020-12-15 23:06:58Z milde $
-# Author: Günter Milde <milde@users.sourceforge.net>,
+#! /usr/bin/env python3
+# $Id: test__init__.py 9277 2022-11-26 23:15:13Z milde $
+# Author: Günter Milde <milde@users.sf.net>,
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
 #    Copying and distribution of this file, with or without modification,
@@ -14,19 +13,21 @@
 Test module for `docutils.parsers.rst.directives`.
 """
 
-from __future__ import absolute_import
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
 
 import docutils
 import docutils.parsers.null
 from docutils.parsers.rst import directives
 
 
-
-class DirectiveOptionConversionTestCase(DocutilsTestSupport.StandardTestCase):
+class DirectiveOptionConversionTestCase(unittest.TestCase):
 
     def test_flag(self):
         # Raise error when there is an argument:
@@ -43,21 +44,17 @@
         self.assertTrue('something' == directives.unchanged('something'))
         self.assertEqual(3, directives.unchanged(3))
         self.assertEqual(3, directives.unchanged(3))
-        
-    # ... 13 more direcive option conversion functions.
+
+    # TODO: 13 more directive option conversion functions.
 
     def test_parser_name(self):
-        self.assertEqual(None, directives.parser_name(None))
-        self.assertEqual(docutils.parsers.null.Parser, 
-                         directives.parser_name('null'))
-        self.assertEqual(docutils.parsers.rst.Parser, 
-                         directives.parser_name('rst'))
-        self.assertEqual(docutils.parsers.recommonmark_wrapper.Parser, 
-                         directives.parser_name('markdown'))
+        self.assertEqual(directives.parser_name(None), None)
+        self.assertEqual(directives.parser_name('null'),
+                         docutils.parsers.null.Parser)
+        self.assertEqual(directives.parser_name('rst'),
+                         docutils.parsers.rst.Parser)
         self.assertRaises(ValueError, directives.parser_name, 'fantasy')
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()
-

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_admonitions.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_admonitions.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for admonitions.py directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -207,12 +225,11 @@
             1 argument(s) required, 0 supplied.
         <literal_block xml:space="preserve">
             .. admonition::
-            
+            \n\
                Generic admonitions require a title.
 """,
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions_de.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions_de.py Changed

@@ -1,23 +1,49 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_admonitions_de.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_admonitions_de.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for admonitions.py directives in German document.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser, directives, roles
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.language_code = 'de'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                # Language-specific roles and roles added by the
+                # "default-role" and "role" directives are currently stored
+                # globally in the roles._roles dictionary.
+                # Language-specific directives are currently stored
+                # globally in the directives._directives dictionary.
+                # This workaround empties these dictionaries.
+                directives._directives = {}
+                roles._roles = {}
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    settings = {'language_code': 'de'}
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings=settings)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -165,6 +191,10 @@
 """,
 """\
 <document source="test data">
+    <system_message level="1" line="1" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "admonition" in module "docutils.parsers.rst.languages.de".
+            Using English fallback for directive "admonition".
     <admonition classes="admonition-admonition">
         <title>
             Admonition
@@ -178,6 +208,10 @@
 """,
 """\
 <document source="test data">
+    <system_message level="1" line="1" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "admonition" in module "docutils.parsers.rst.languages.de".
+            Using English fallback for directive "admonition".
     <admonition classes="admonition-and-by-the-way">
         <title>
             And, by the way...
@@ -193,6 +227,10 @@
 """,
 """\
 <document source="test data">
+    <system_message level="1" line="1" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "admonition" in module "docutils.parsers.rst.languages.de".
+            Using English fallback for directive "admonition".
     <admonition classes="emergency" ids="reference-name" names="reference\\ name">
         <title>
             Admonition
@@ -206,18 +244,21 @@
 """,
 """\
 <document source="test data">
+    <system_message level="1" line="1" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "admonition" in module "docutils.parsers.rst.languages.de".
+            Using English fallback for directive "admonition".
     <system_message level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Error in "admonition" directive:
             1 argument(s) required, 0 supplied.
         <literal_block xml:space="preserve">
             .. admonition::
-            
+            \n\
                Generic admonitions require a title.
 """,
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py Changed

@@ -1,24 +1,44 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_admonitions_dummy_lang.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_admonitions_dummy_lang.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for admonition directives with local language module.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+
+    maxDiff = None
+
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.language_code = 'test.local-dummy-lang'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    settings = {'language_code': 'local-dummy-lang',
-                'report_level': 2} # warning (has no effect on test output is run as __main__).
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings=settings)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -33,6 +53,10 @@
     <attention>
         <paragraph>
             directive with silly localised name.
+    <system_message level="1" line="3" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "Attention" in module "test.local_dummy_lang".
+            Using English fallback for directive "Attention".
     <attention>
         <paragraph>
             English fallback (an INFO is written).
@@ -41,5 +65,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_block_quotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_block_quotes.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_block_quotes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_block_quotes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,16 +8,34 @@
 Tests for the block quote directives "epigraph", "highlights", and
 "pull-quote".
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 generic_tests = 
 """\
@@ -62,11 +80,10 @@
 
 totest = {}
 for block_quote_type in ('epigraph', 'highlights', 'pull-quote'):
-   totestblock_quote_type = 
-       text % {'type': block_quote_type} for text in pair
-       for pair in generic_tests
+    totestblock_quote_type = 
+        text % {'type': block_quote_type} for text in pair
+        for pair in generic_tests
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_class.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_class.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'class' directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -51,5 +69,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_code.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_code.py Changed

@@ -1,25 +1,53 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_code.py 8598 2021-01-03 21:05:04Z milde $
+# $Id: test_code.py 9355 2023-04-17 20:27:15Z milde $
 # Author: Guenter Milde
 # Copyright: This module has been placed in the public domain.
 
 """
 Test the 'code' directive in parsers/rst/directives/body.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import re
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 from docutils.utils.code_analyzer import with_pygments
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    if not with_pygments:
-        del(totest'code-parsing')
-    s.generateTests(totest)
-    return s
+if with_pygments:
+    import pygments
+    _pv = re.match(r'^(0-9+)\.(0-9*)', pygments.__version__)
+    PYGMENTS_2_14_PLUS = (int(_pv1), int(_pv2)) >= (2, 14)
+else:
+    PYGMENTS_2_14_PLUS = None
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        if not with_pygments:
+            del totest'code_parsing'
+
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.report_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -96,7 +124,7 @@
 """,
 
 
-totest'code-parsing' = 
+totest'code_parsing' = 
 """\
 .. code:: python3
   :class: testclass
@@ -144,6 +172,60 @@
             my_function
         <inline classes="punctuation">
             ():
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+             8 \n\
+        <inline classes="whitespace">
+                \n\
+        <inline classes="literal string doc">
+            \'\'\'Test the lexer.
+        <inline classes="ln">
+             9 \n\
+        <inline classes="literal string doc">
+                \'\'\'
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            10 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            11 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="comment single">
+            # and now for something completely different
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            12 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="name builtin">
+            print
+        <inline classes="punctuation">
+            (
+        <inline classes="literal number integer">
+            8
+        <inline classes="operator">
+            /
+        <inline classes="literal number integer">
+            2
+        <inline classes="punctuation">
+            )
+""" if PYGMENTS_2_14_PLUS else """\
+<document source="test data">
+    <literal_block classes="code python3 testclass" ids="my-function" names="my_function" xml:space="preserve">
+        <inline classes="ln">
+             7 \n\
+        <inline classes="keyword">
+            def
+         \n\
+        <inline classes="name function">
+            my_function
+        <inline classes="punctuation">
+            ():
         \n\
         <inline classes="ln">
              8 \n\
@@ -199,7 +281,8 @@
             }
          \n\
         <inline classes="comment">
-            % emphasize""",
+            % emphasize
+""",
 """\
 .. code:: rst
   :number-lines:
@@ -250,5 +333,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_code_long.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_code_long.py Changed

@@ -1,29 +1,49 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_code_long.py 8598 2021-01-03 21:05:04Z milde $
+# $Id: test_code_long.py 9355 2023-04-17 20:27:15Z milde $
 # Author: Guenter Milde
 # Copyright: This module has been placed in the public domain.
 
 """
 Test the 'code' directive in body.py with syntax_highlight = 'long'.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 from docutils.utils.code_analyzer import with_pygments
+from test.test_parsers.test_rst.test_directives.test_code \
+    import PYGMENTS_2_14_PLUS
+
+
+@unittest.skipUnless(with_pygments, 'needs Pygments')
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.syntax_highlight = 'long'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    settings = {'syntax_highlight':'long'}
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings=settings)
-    if with_pygments:
-        s.generateTests(totest)
-    return s
 
 totest = {}
 
-totest'code-parsing-long' = 
+totest'code_parsing_long' = 
 """\
 .. code:: python3
   :number-lines: 7
@@ -47,6 +67,60 @@
             my_function
         <inline classes="punctuation">
             ():
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+             8 \n\
+        <inline classes="whitespace">
+                \n\
+        <inline classes="literal string doc">
+            \'\'\'Test the lexer.
+        <inline classes="ln">
+             9 \n\
+        <inline classes="literal string doc">
+                \'\'\'
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            10 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            11 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="comment single">
+            # and now for something completely different
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            12 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="name builtin">
+            print
+        <inline classes="punctuation">
+            (
+        <inline classes="literal number integer">
+            8
+        <inline classes="operator">
+            /
+        <inline classes="literal number integer">
+            2
+        <inline classes="punctuation">
+            )
+""" if PYGMENTS_2_14_PLUS else """\
+<document source="test data">
+    <literal_block classes="code python3" xml:space="preserve">
+        <inline classes="ln">
+             7 \n\
+        <inline classes="keyword">
+            def
+         \n\
+        <inline classes="name function">
+            my_function
+        <inline classes="punctuation">
+            ():
         \n\
         <inline classes="ln">
              8 \n\
@@ -101,10 +175,10 @@
             }
          \n\
         <inline classes="comment">
-            % emphasize""",
+            % emphasize
+""",
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_code_none.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_code_none.py Changed

@@ -1,26 +1,45 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_code_none.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_code_none.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Guenter Milde
 # Copyright: This module has been placed in the public domain.
 
 """
 Test the 'code' directive in body.py with syntax_highlight = 'none'.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.syntax_highlight = 'none'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings={'syntax_highlight':'none'})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
-totest'code-parsing-none' = 
+totest'code_parsing_none' = 
 """\
 .. code::
 
@@ -78,5 +97,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_code_parsing.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_code_parsing.py Changed

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,13 +13,15 @@
 Various tests for the `pygments` code highlighter.
 """
 
-from __future__ import absolute_import
+from pathlib import Path
+import sys
 import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport # must be imported before docutils
-from docutils import core, utils
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
 from docutils.core import publish_string
 from docutils.utils.code_analyzer import with_pygments
 
@@ -33,8 +34,9 @@
    autoload("abc_mode", "abc");
 """
 
-class_arg = """\
-Unknown language "S-Lang".
+workaround = """\
+Workaround to silence warning: disable code parsing with
+"syntax highlight" setting or put code language in class argument:
 
 .. code::
    :class: s-lang
@@ -43,12 +45,12 @@
    autoload("abc_mode", "abc");
 """
 
-skip_msg = 'optional module "pygments" not found'
 settings = {'warning_stream': ''}
 
+
+@unittest.skipUnless(with_pygments, 'optional module "pygments" not found')
 class CodeParsingTests(unittest.TestCase):
 
-    @unittest.skipUnless(with_pygments, skip_msg)
     def test_lexer_error(self):
         output = publish_string(unknown_language, settings_overrides=settings)
         self.assertIn(b'<system_message level="2"', output)
@@ -56,9 +58,8 @@
                       b'No Pygments lexer found for "s-lang".', output)
         self.assertIn(b'<literal_block xml:space="preserve">', output)
 
-    @unittest.skipUnless(with_pygments, skip_msg)
     def test_lexer_error_workaround(self):
-        output = publish_string(class_arg, settings_overrides=settings)
+        output = publish_string(workaround, settings_overrides=settings)
         self.assertNotIn(b'<system_message', output)
         self.assertIn(b'<literal_block classes="code s-lang"', output)
         self.assertIn(b'autoload("abc_mode", "abc");', output)

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_compound.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_compound.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_compound.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_compound.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'compound' directive from body.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -102,5 +120,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_container.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_container.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_container.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_container.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'container' directive from body.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -79,7 +97,7 @@
 <document source="test data">
     <container ids="my-name" names="my\\ name">
         <paragraph>
-            The name argument allows hyperlinks to 
+            The name argument allows hyperlinks to \n\
             <reference name="my name" refname="my name">
                 my name
             .
@@ -88,5 +106,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_contents.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_contents.py Changed

@@ -1,22 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_contents.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_contents.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for parts.py contents directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+try:
+    int('two')
+except ValueError as detail:
+    invalid_literal = detail.args0
+else:
+    invalid_literal = ''
 
 totest = {}
 
@@ -87,7 +112,7 @@
         <title>
             <emphasis>
                 Table
-             of 
+             of \n\
             <literal>
                 Contents
         <pending>
@@ -158,7 +183,7 @@
         <literal_block xml:space="preserve">
             .. contents::
                :depth: two
-""" % DocutilsTestSupport.exception_data(int, "two")10,
+""" % invalid_literal,
 """\
 .. contents::
    :width: 2
@@ -238,5 +263,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_date.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_date.py Changed

@@ -1,25 +1,42 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_date.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_date.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the misc.py "date" directive.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
 import time
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.io import _locale_encoding  # noqa
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
-from docutils.utils.error_reporting import locale_encoding
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -61,18 +78,18 @@
 
 
 # some locales return non-ASCII characters for names of days or months
-if locale_encoding in 'utf8', 'utf-8', 'latin-1':
-    totest'decode date' = 
-    u"""\
-.. |date| date:: t\xc3glich
+# ensure the directive handles them correctly
+if _locale_encoding in ('utf-8', 'utf8', 'latin-1', 'iso-8859-1'):
+    totest'decode_date' = 
+    """\
+.. |date| date:: täglich
 """,
-    u"""\
+    """\
 <document source="test data">
     <substitution_definition names="date">
-        t\xc3glich
+        täglich
 """,
     
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_decorations.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_decorations.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_decorations.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_decorations.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the "header" & "footer" directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -87,5 +104,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_default_role.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_default_role.py Changed

@@ -1,27 +1,44 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_default_role.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_default_role.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "default-role" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
-totest'default-role' = 
+totest'default_role' = 
 """\
 .. default-role:: subscript
 
@@ -81,5 +98,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_figures.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_figures.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_figures.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_figures.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for images.py figure directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -137,7 +154,7 @@
         <literal_block xml:space="preserve">
             .. figure:: picture.png
                :align: top
-            
+            \n\
                A figure with wrong alignment.
 """,
 """\
@@ -293,5 +310,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_images.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_images.py Changed

@@ -1,25 +1,56 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_images.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_images.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for images.py image directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
-from docutils.nodes import reprunicode
+try:
+    int(None)
+except TypeError as detail:
+    int_none = detail.args0
+else:
+    int_none = ''
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+try:
+    int('fifty')
+except ValueError as detail:
+    invalid_literal = detail.args0
+else:
+    invalid_literal = ''
+
 
 totest = {}
 
@@ -222,7 +253,7 @@
         <literal_block xml:space="preserve">
             .. image:: picture.png
                :scale:
-""" % DocutilsTestSupport.exception_data(int, None)10,
+""" % int_none,
 """\
 .. image:: picture.png
    :height: 100
@@ -281,7 +312,7 @@
         <literal_block xml:space="preserve">
             .. image:: picture.png
                :scale: fifty
-""" % DocutilsTestSupport.exception_data(int, u"fifty")10,
+""" % invalid_literal,
 """\
 .. image:: picture.png
    :scale: 50
@@ -409,32 +440,32 @@
             .. |img| image:: picture.png
                :align: left
 """,
-u"""\
+"""\
 .. image:: picture.png
    :align: \xe4
 """,
-u"""\
+"""\
 <document source="test data">
     <system_message level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Error in "image" directive:
-            invalid option value: (option: "align"; value: %s)
+            invalid option value: (option: "align"; value: 'ä')
             "\xe4" unknown; choose from "top", "middle", "bottom", "left", "center", or "right".
         <literal_block xml:space="preserve">
             .. image:: picture.png
                :align: \xe4
-""" % repr(reprunicode(u'\xe4')),
+""",
 """
 .. image:: test.png
    :target: Uppercase_
 
-.. _Uppercase: http://docutils.sourceforge.net/
+.. _Uppercase: https://docutils.sourceforge.io/
 """,
 """\
 <document source="test data">
     <reference name="Uppercase" refname="uppercase">
         <image uri="test.png">
-    <target ids="uppercase" names="uppercase" refuri="http://docutils.sourceforge.net/">
+    <target ids="uppercase" names="uppercase" refuri="https://docutils.sourceforge.io/">
 """,
 r"""
 .. image:: path\ with\ spaces/name\ with\ spaces.png
@@ -450,5 +481,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_include.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_include.py Changed

@@ -1,44 +1,82 @@
-#! /usr/bin/env python
-
-# $Id: test_include.py 8670 2021-04-07 12:04:36Z milde $
+#! /usr/bin/env python3
+# $Id: test_include.py 9355 2023-04-17 20:27:15Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "include" directive.
 """
-from __future__ import absolute_import
 
+from pathlib import Path
 import os.path
+import unittest
 import sys
+
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
-from docutils.parsers.rst import states
-from docutils.parsers import recommonmark_wrapper
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils import parsers, utils
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 from docutils.utils.code_analyzer import with_pygments
+from test.test_parsers.test_rst.test_directives.test_code \
+    import PYGMENTS_2_14_PLUS
+
+
+TEST_ROOT = Path(__file__).resolve().parents3
+
+
+# optional 3rd-party markdown parser
+md_parser_name = 'recommonmark'
+try:  # check availability
+    md_parser_class = parsers.get_parser_class(md_parser_name)
+except ImportError:
+    md_parser_class = None
+
 
-if sys.version_info >= (3, 0):
-    unichr = chr  # noqa
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        # eventually skip optional parts:
+        if not with_pygments:
+            del totest'include_parsed_code'
+        if not md_parser_class:
+            del totest'include_markdown'
 
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+try:
+    chr(0x11111111)
+except ValueError as detail:
+    unichr_exception = f'{detail.__class__.__name__}: {detail}'
+else:
+    unichr_exception = ''
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    if not with_pygments:
-        del(totest'include-code')
-    s.generateTests(totest)
-    return s
 
 # prepend this directory (relative to the test root):
 def mydir(path):
-    return os.path.join('test_parsers/test_rst/test_directives/', path)
-# make `path` relative with utils.relative_path():
-def reldir(path):
-    return DocutilsTestSupport.utils.relative_path(None, path)
+    return os.path.relpath(
+        os.path.join(TEST_ROOT, 'test_parsers/test_rst/test_directives', path),
+        os.getcwd()).replace('\\', '/')
+
 
 include1 = mydir('include1.txt')
 include2 = mydir('include2.txt')
 include3 = mydir('include3.txt')
+include5 = mydir('includes/include5.txt')
 include6 = mydir('includes/more/include6.txt')
 include8 = mydir('include8.txt')
 include10 = mydir('include10.txt')
@@ -50,67 +88,44 @@
 include16 = mydir('includes/include16.txt')
 include_literal = mydir('include_literal.txt')
 include_md = mydir('include.md')
-utf_16_file = mydir('utf-16.csv')
-utf_16_error_str = ("UnicodeDecodeError: 'ascii' codec can't decode byte 0xfe "
+include = os.path.join(TEST_ROOT, 'data/include.txt')
+latin2 = os.path.join(TEST_ROOT, 'data/latin2.txt')
+utf_16_file = os.path.join(TEST_ROOT, 'data/utf-16-le-sig.txt')
+utf_16_error_str = ("UnicodeDecodeError: 'ascii' codec can't decode byte 0xff "
                     "in position 0: ordinal not in range(128)")
-if sys.version_info < (3, 0):
-    utf_16_error_str = ("UnicodeError: Unable to decode input data.  "
-                        "Tried the following encodings: 'ascii'.\n"
-                        "            (%s)" % utf_16_error_str)
-nonexistent = os.path.join(os.path.dirname(states.__file__),
-                           'include', 'nonexistent')
-nonexistent_rel = DocutilsTestSupport.utils.relative_path(
-    os.path.join(DocutilsTestSupport.testroot, 'dummy'), nonexistent)
+rst_states_dir = os.path.dirname(parsers.rst.states.__file__)
+# TODO fix case normalisation bug on Windows in utils.relative_path()
+# nonexistent = os.path.relpath(
+#     os.path.join(rst_states_dir, 'include', 'nonexistent'),
+#     os.getcwd()).replace('\\', '/')
+nonexistent = utils.relative_path(
+    os.path.join(os.getcwd(), 'dummy'),
+    os.path.join(rst_states_dir, 'include', 'nonexistent')
+)
 
 # Different error for path with 8bit chars with locale == C or None:
 try:
-    open(u'\u043c\u0438\u0440.txt')
+    open('\u043c\u0438\u0440.txt')
 except UnicodeEncodeError:
-    errstr_8bit_path = u"""\
+    errstr_8bit_path = """\
 Cannot encode input file path "\u043c\u0438\u0440.txt" (wrong locale?).\
 """
-except:
-    errstr_8bit_path = u"""\
+except FileNotFoundError:
+    errstr_8bit_path = """\
 InputError: Errno 2 No such file or directory: '\u043c\u0438\u0440.txt'.\
 """
 
-# Parsing with Markdown (recommonmark) is an optional feature depending
-# on 3rd-party modules:
-if recommonmark_wrapper.CommonMarkParser:
-    markdown_parsing_result = """\
-    <section ids="title-1" names="title\\ 1">
-        <title>
-            Title 1
-        <paragraph>
-            <emphasis>
-                emphasis
-             and \n\
-            <emphasis>
-                also emphasis
-        <paragraph>
-            No whitespace required around a
-            <reference name="phrase reference" refuri="/uri">
-                phrase reference
-            ."""
-else:
-    markdown_parsing_result = """\
-    <system_message level="2" source="test_parsers/test_rst/test_directives/include.md" type="WARNING">
-        <paragraph>
-            Missing dependency: MarkDown input is processed by a 3rd party parser but Python did not find the required module "recommonmark" (https://pypi.org/project/recommonmark/).\
-"""
-
-
 totest = {}
 
 totest'include' = 
-"""\
+f"""\
 Include Test
 ============
 
-.. include:: %s
+.. include:: {include1}
 
 A paragraph.
-""" % include1,
+""",
 """\
 <document source="test data">
     <section ids="include-test" names="include\\ test">
@@ -127,42 +142,42 @@
             <paragraph>
                 A paragraph.
 """,
-"""\
+f"""\
 Include Test
 ============
 
-.. include:: %s
+.. include:: {include1}
    :literal:
    :class: test
    :name: my name
 
 A paragraph.
-""" % include1,
-"""\
+""",
+f"""\
 <document source="test data">
     <section ids="include-test" names="include\\ test">
         <title>
             Include Test
-        <literal_block classes="test" ids="my-name" names="my\\ name" source="%s" xml:space="preserve">
+        <literal_block classes="test" ids="my-name" names="my\\ name" source="{include1}" xml:space="preserve">
             Inclusion 1
             -----------
             \n\
             This file is used by ``test_include.py``.
         <paragraph>
             A paragraph.
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Literal include, add line numbers
 
-.. include:: %s
+.. include:: {include1}
    :literal:
    :number-lines:
-""" % include1,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Literal include, add line numbers
-    <literal_block source="%s" xml:space="preserve">
+    <literal_block source="{include1}" xml:space="preserve">
         <inline classes="ln">
             1 \n\
         Inclusion 1
@@ -175,37 +190,37 @@
         <inline classes="ln">
             4 \n\
         This file is used by ``test_include.py``.
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Include code
 
-.. include:: %s
+.. include:: {include1}
    :code:
    :class: test
    :name: my name
-""" % include1,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Include code
-    <literal_block classes="code test" ids="my-name" names="my\\ name" source="%s" xml:space="preserve">
+    <literal_block classes="code test" ids="my-name" names="my\\ name" source="{include1}" xml:space="preserve">
         Inclusion 1
         -----------
         \n\
         This file is used by ``test_include.py``.
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Include code, add line numbers
 
-.. include:: %s
+.. include:: {include1}
    :code:
    :number-lines:
-""" % include1,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Include code, add line numbers
-    <literal_block classes="code" source="%s" xml:space="preserve">
+    <literal_block classes="code" source="{include1}" xml:space="preserve">
         <inline classes="ln">
             1 \n\
         Inclusion 1
@@ -218,32 +233,39 @@
         <inline classes="ln">
             4 \n\
         This file is used by ``test_include.py``.
-""" % reldir(include1),
-"""\
-Include markdown (recommonmark).
+""",
+f"""\
+Include with unknown parser.
 
-.. include:: %s
-   :parser: markdown
+.. include:: {include1}
+   :parser: sillyformat
 
 A paragraph.
-""" % include_md,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
-        Include markdown (recommonmark).
-%s
+        Include with unknown parser.
+    <system_message level="3" line="3" source="test data" type="ERROR">
+        <paragraph>
+            Error in "include" directive:
+            invalid option value: (option: "parser"; value: \'sillyformat\')
+            Parser "sillyformat" not found. No module named 'sillyformat'.
+        <literal_block xml:space="preserve">
+            .. include:: {include1}
+               :parser: sillyformat
     <paragraph>
         A paragraph.
-""" % markdown_parsing_result,
-"""\
+""",
+f"""\
 Let's test the parse context.
 
     This paragraph is in a block quote.
 
-    .. include:: %s
+    .. include:: {include2}
 
 The included paragraphs should also be in the block quote.
-""" % include2,
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -284,17 +306,17 @@
         <paragraph>
             A paragraph.
 """,
-"""\
+f"""\
 Include Test
 ============
 
-.. include:: %s
+.. include:: {include1}
 
-.. include:: %s
+.. include:: {include1}
 
 A paragraph.
-""" % (include1, include1),
-"""\
+""",
+f"""\
 <document source="test data">
     <section ids="include-test" names="include\\ test">
         <title>
@@ -303,37 +325,37 @@
             <title>
                 Inclusion 1
             <paragraph>
-                This file is used by 
+                This file is used by \n\
                 <literal>
                     test_include.py
                 .
-        <section dupnames="inclusion\\ 1" ids="id1">
+        <section dupnames="inclusion\\ 1" ids="inclusion-1-1">
             <title>
                 Inclusion 1
-            <system_message backrefs="id1" level="1" line="2" source="%s" type="INFO">
+            <system_message backrefs="inclusion-1-1" level="1" line="2" source="{include1}" type="INFO">
                 <paragraph>
                     Duplicate implicit target name: "inclusion 1".
             <paragraph>
-                This file is used by 
+                This file is used by \n\
                 <literal>
                     test_include.py
                 .
             <paragraph>
                 A paragraph.
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Include Test
 ============
 
-.. include:: %s
+.. include:: {include1}
 
 ----------
 
-.. include:: %s
+.. include:: {include1}
 
 A paragraph.
-""" % (include1, include1),
-"""\
+""",
+f"""\
 <document source="test data">
     <section ids="include-test" names="include\\ test">
         <title>
@@ -347,10 +369,10 @@
                     test_include.py
                 .
             <transition>
-        <section dupnames="inclusion\\ 1" ids="id1">
+        <section dupnames="inclusion\\ 1" ids="inclusion-1-1">
             <title>
                 Inclusion 1
-            <system_message backrefs="id1" level="1" line="2" source="%s" type="INFO">
+            <system_message backrefs="inclusion-1-1" level="1" line="2" source="{include1}" type="INFO">
                 <paragraph>
                     Duplicate implicit target name: "inclusion 1".
             <paragraph>
@@ -360,15 +382,15 @@
                 .
             <paragraph>
                 A paragraph.
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Recursive inclusions: adapt paths.
 
 In test data
 
-.. include:: %s
-""" % include3,
-"""\
+.. include:: {include3}
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Recursive inclusions: adapt paths.
@@ -384,9 +406,9 @@
         In includes/more/include6.txt
     <paragraph>
         In includes/sibling/include7.txt
-    <literal_block source="test_parsers/test_rst/test_directives/includes/include5.txt" xml:space="preserve">
+    <literal_block source="{include5}" xml:space="preserve">
         In includes/include5.txt
-        
+        \n\
         .. include:: more/include6.txt
     <table>
         <tgroup cols="2">
@@ -401,7 +423,48 @@
                         <paragraph>
                             includes/sibling/include7.txt
 """,
-"""\
+f"""\
+Recursive inclusion with specified parser.
+
+In test data
+
+.. include:: {include3}
+   :parser: rst
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        Recursive inclusion with specified parser.
+    <paragraph>
+        In test data
+    <paragraph>
+        In include3.txt
+    <paragraph>
+        In includes/include4.txt
+    <paragraph>
+        In includes/include5.txt
+    <paragraph>
+        In includes/more/include6.txt
+    <paragraph>
+        In includes/sibling/include7.txt
+    <literal_block source="{include5}" xml:space="preserve">
+        In includes/include5.txt
+        \n\
+        .. include:: more/include6.txt
+    <table>
+        <tgroup cols="2">
+            <colspec colwidth="50">
+            <colspec colwidth="50">
+            <tbody>
+                <row>
+                    <entry>
+                        <paragraph>
+                            In
+                    <entry>
+                        <paragraph>
+                            includes/sibling/include7.txt
+""",
+f"""\
 In test data
 
 Section
@@ -409,9 +472,9 @@
 
 (Section contents in nested parse; slice of input_lines ViewList.)
 
-.. include:: %s
-""" % include3,
-"""\
+.. include:: {include3}
+""",
+f"""\
 <document source="test data">
     <paragraph>
         In test data
@@ -430,9 +493,9 @@
             In includes/more/include6.txt
         <paragraph>
             In includes/sibling/include7.txt
-        <literal_block source="test_parsers/test_rst/test_directives/includes/include5.txt" xml:space="preserve">
+        <literal_block source="{include5}" xml:space="preserve">
             In includes/include5.txt
-            
+            \n\
             .. include:: more/include6.txt
         <table>
             <tgroup cols="2">
@@ -447,11 +510,11 @@
                             <paragraph>
                                 includes/sibling/include7.txt
 """,
-"""\
+f"""\
 Testing relative includes:
 
-.. include:: %s
-""" % include8,
+.. include:: {include8}
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -469,73 +532,95 @@
             test_include.py
         .
 """,
-"""\
+f"""\
 Encoding:
 
-.. include:: %s
+.. include:: {utf_16_file}
    :encoding: utf-16
-""" % reldir(utf_16_file),
-b"""\
+""",
+"""\
 <document source="test data">
     <paragraph>
         Encoding:
     <paragraph>
-        "Treat", "Quantity", "Description"
-        "Albatr\xb0\xdf", 2.99, "\xa1On a \\u03c3\\u03c4\\u03b9\\u03ba!"
-        "Crunchy Frog", 1.49, "If we took the b\xf6nes out, it wouldn\\u2019t be
-        crunchy, now would it?"
-        "Gannet Ripple", 1.99, "\xbfOn a \\u03c3\\u03c4\\u03b9\\u03ba?"
-""".decode('raw_unicode_escape'),
-"""\
+        Grüße
+""",
+f"""\
+Default encoding: auto-determine (here via BOM).
+
+.. include:: {utf_16_file}
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Default encoding: auto-determine (here via BOM).
+    <paragraph>
+        Grüße
+""",
+f"""\
+Default encoding: auto-determine (via encoding declaration).
+
+.. include:: {latin2}
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Default encoding: auto-determine (via encoding declaration).
+    <comment xml:space="preserve">
+        -*- encoding: latin2 -*-
+    <paragraph>
+        škoda
+""",
+f"""\
 Include file is UTF-16-encoded, and is not valid ASCII.
 
-.. include:: %s
+.. include:: {utf_16_file}
    :encoding: ascii
-""" % reldir(utf_16_file),
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Include file is UTF-16-encoded, and is not valid ASCII.
     <system_message level="4" line="3" source="test data" type="SEVERE">
         <paragraph>
             Problem with "include" directive:
-            %s
+            {utf_16_error_str}
         <literal_block xml:space="preserve">
-            .. include:: %s
+            .. include:: {utf_16_file}
                :encoding: ascii
-""" % (utf_16_error_str, reldir(utf_16_file)),
-u"""\
+""",
+"""\
 cyrillic filename:
 
 .. include:: \u043c\u0438\u0440.txt
 """,
-u"""\
+f"""\
 <document source="test data">
     <paragraph>
         cyrillic filename:
     <system_message level="4" line="3" source="test data" type="SEVERE">
         <paragraph>
             Problems with "include" directive path:
-            %s
+            {errstr_8bit_path}
         <literal_block xml:space="preserve">
             .. include:: \u043c\u0438\u0440.txt
-""" % errstr_8bit_path,
-"""\
+""",
+f"""\
 Testing errors in included file:
 
-.. include:: %s
-""" % include10,
-"""\
+.. include:: {include10}
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Testing errors in included file:
-    <system_message level="3" line="1" source="%(source)s" type="ERROR">
+    <system_message level="3" line="1" source="{include10}" type="ERROR">
         <paragraph>
             Invalid character code: 0x11111111
-            %(unichr_exception)s
+            {unichr_exception}
         <literal_block xml:space="preserve">
             unicode:: 0x11111111
-    <system_message level="2" line="1" source="%(source)s" type="WARNING">
+    <system_message level="2" line="1" source="{include10}" type="WARNING">
         <paragraph>
             Substitution definition "bad" empty or invalid.
         <literal_block xml:space="preserve">
@@ -546,50 +631,50 @@
         <block_quote>
             <paragraph>
                 indent
-        <system_message level="2" line="7" source="%(source)s" type="WARNING">
+        <system_message level="2" line="7" source="{include10}" type="WARNING">
             <paragraph>
                 Block quote ends without a blank line; unexpected unindent.
         <paragraph>
             error
-    <section dupnames="hi" ids="id1">
+    <section dupnames="hi" ids="hi-1">
         <title>
             hi
-        <system_message backrefs="id1" level="1" line="10" source="%(source)s" type="INFO">
+        <system_message backrefs="hi-1" level="1" line="10" source="{include10}" type="INFO">
             <paragraph>
                 Duplicate implicit target name: "hi".
-        <system_message level="4" line="12" source="%(source)s" type="SEVERE">
+        <system_message level="4" line="12" source="{include10}" type="SEVERE">
             <paragraph>
                 Problems with "include" directive path:
-                InputError: Errno 2 No such file or directory: '%(nonexistent)s'.
+                InputError: Errno 2 No such file or directory: '{nonexistent}'.
             <literal_block xml:space="preserve">
                 .. include:: <nonexistent>
-        <system_message level="3" line="14" source="%(source)s" type="ERROR">
+        <system_message level="3" line="14" source="{include10}" type="ERROR">
             <paragraph>
                 Content block expected for the "note" directive; none found.
             <literal_block xml:space="preserve">
                 .. note::
-        <system_message level="3" line="16" source="%(source)s" type="ERROR">
+        <system_message level="3" line="16" source="{include10}" type="ERROR">
             <paragraph>
                 Content block expected for the "admonition" directive; none found.
             <literal_block xml:space="preserve">
                 .. admonition::
                    without title
-        <system_message level="3" line="19" source="%(source)s" type="ERROR">
+        <system_message level="3" line="19" source="{include10}" type="ERROR">
             <paragraph>
                 Content block expected for the "epigraph" directive; none found.
             <literal_block xml:space="preserve">
                 .. epigraph::
-        <system_message level="3" line="21" source="%(source)s" type="ERROR">
+        <system_message level="3" line="21" source="{include10}" type="ERROR">
             <paragraph>
                 Content block expected for the "highlights" directive; none found.
             <literal_block xml:space="preserve">
                 .. highlights::
-        <system_message level="3" line="23" source="%(source)s" type="ERROR">
+        <system_message level="3" line="23" source="{include10}" type="ERROR">
             <paragraph>
                 Content block expected for the "pull-quote" directive; none found.
             <literal_block xml:space="preserve">
                 .. pull-quote::
-        <system_message level="3" line="25" source="%(source)s" type="ERROR">
+        <system_message level="3" line="25" source="{include10}" type="ERROR">
             <paragraph>
                 Invalid context: the "date" directive can only be used within a substitution definition.
             <literal_block xml:space="preserve">
@@ -597,24 +682,24 @@
         <paragraph>
             not a
             definition list:
-        <system_message level="3" line="29" source="%(source)s" type="ERROR">
+        <system_message level="3" line="29" source="{include10}" type="ERROR">
             <paragraph>
                 Unexpected indentation.
         <block_quote>
             <paragraph>
                 as a term may only be one line long.
-        <system_message level="3" line="31" source="%(source)s" type="ERROR">
+        <system_message level="3" line="31" source="{include10}" type="ERROR">
             <paragraph>
                 Error in "admonition" directive:
                 1 argument(s) required, 0 supplied.
             <literal_block xml:space="preserve">
                 .. admonition::
-                
+                \n\
                    without title and content following a blank line
     <section ids="section-underline-too-short" names="section\\ underline\\ too\\ short">
         <title>
             section underline too short
-        <system_message level="2" line="36" source="%(source)s" type="WARNING">
+        <system_message level="2" line="36" source="{include10}" type="WARNING">
             <paragraph>
                 Title underline too short.
             <literal_block xml:space="preserve">
@@ -640,29 +725,29 @@
                         <entry>
                             <paragraph>
                                 cell 4
-        <system_message level="2" line="43" source="%(source)s" type="WARNING">
+        <system_message level="2" line="43" source="{include10}" type="WARNING">
             <paragraph>
                 Blank line required after table.
         <paragraph>
             No blank line after table.
-        <system_message level="3" line="45" source="%(source)s" type="ERROR">
+        <system_message level="3" line="45" source="{include10}" type="ERROR">
             <paragraph>
                 Error in "unicode" directive:
                 1 argument(s) required, 0 supplied.
             <literal_block xml:space="preserve">
                 unicode::
-        <system_message level="2" line="45" source="%(source)s" type="WARNING">
+        <system_message level="2" line="45" source="{include10}" type="WARNING">
             <paragraph>
                 Substitution definition "empty" empty or invalid.
             <literal_block xml:space="preserve">
                 .. |empty| unicode::
-        <system_message level="3" line="47" source="%(source)s" type="ERROR">
+        <system_message level="3" line="47" source="{include10}" type="ERROR">
             <paragraph>
                 Error in "topic" directive:
                 1 argument(s) required, 0 supplied.
             <literal_block xml:space="preserve">
                 .. topic::
-        <system_message level="3" line="49" source="%(source)s" type="ERROR">
+        <system_message level="3" line="49" source="{include10}" type="ERROR">
             <paragraph>
                 Error in "rubric" directive:
                 1 argument(s) required, 0 supplied.
@@ -672,12 +757,12 @@
             A rubric has no content
         <comment xml:space="preserve">
             _`target: No matching backquote.
-        <system_message level="2" line="52" source="%(source)s" type="WARNING">
+        <system_message level="2" line="52" source="{include10}" type="WARNING">
             <paragraph>
                 malformed hyperlink target.
         <comment xml:space="preserve">
             __malformed: no good
-        <system_message level="2" line="53" source="%(source)s" type="WARNING">
+        <system_message level="2" line="53" source="{include10}" type="WARNING">
             <paragraph>
                 malformed hyperlink target.
         <definition_list>
@@ -685,64 +770,81 @@
                 <term>
                     A literal block::
                 <definition>
-                    <system_message level="1" line="57" source="%(source)s" type="INFO">
+                    <system_message level="1" line="57" source="{include10}" type="INFO">
                         <paragraph>
                             Blank line missing before literal block (after the "::")? Interpreted as a definition list item.
                     <paragraph>
                         with no blank line above.
         <literal_block xml:space="preserve">
             > A literal block.
-        <system_message level="3" line="61" source="%(source)s" type="ERROR">
+        <system_message level="3" line="61" source="{include10}" type="ERROR">
             <paragraph>
                 Inconsistent literal block quoting.
         <paragraph>
             $ with inconsistent quoting.
         <paragraph>
-            <problematic ids="id3" refid="id2">
+            <problematic ids="problematic-1" refid="system-message-1">
                 :unknown-role:`role`
-            
-            and 
-            <problematic ids="id5" refid="id4">
+            \n\
+            and \n\
+            <problematic ids="problematic-2" refid="system-message-2">
                 *
             unbalanced
-            <problematic ids="id7" refid="id6">
+            <problematic ids="problematic-3" refid="system-message-3">
                 `
             inline
-            <problematic ids="id9" refid="id8">
+            <problematic ids="problematic-4" refid="system-message-4">
                 **
             markup
-        <system_message level="1" line="63" source="%(source)s" type="INFO">
+        <system_message level="1" line="63" source="{include10}" type="INFO">
             <paragraph>
                 No role entry for "unknown-role" in module "docutils.parsers.rst.languages.en".
                 Trying "unknown-role" as canonical role name.
-        <system_message backrefs="id3" ids="id2" level="3" line="63" source="%(source)s" type="ERROR">
+        <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="63" source="{include10}" type="ERROR">
             <paragraph>
                 Unknown interpreted text role "unknown-role".
-        <system_message backrefs="id5" ids="id4" level="2" line="63" source="%(source)s" type="WARNING">
+        <system_message backrefs="problematic-2" ids="system-message-2" level="2" line="63" source="{include10}" type="WARNING">
             <paragraph>
                 Inline emphasis start-string without end-string.
-        <system_message backrefs="id7" ids="id6" level="2" line="63" source="%(source)s" type="WARNING">
+        <system_message backrefs="problematic-3" ids="system-message-3" level="2" line="63" source="{include10}" type="WARNING">
             <paragraph>
                 Inline interpreted text or phrase reference start-string without end-string.
-        <system_message backrefs="id9" ids="id8" level="2" line="63" source="%(source)s" type="WARNING">
+        <system_message backrefs="problematic-4" ids="system-message-4" level="2" line="63" source="{include10}" type="WARNING">
             <paragraph>
                 Inline strong start-string without end-string.
+        <block_quote>
+            <paragraph>
+                A block quote with \n\
+                <problematic ids="problematic-5" refid="system-message-5">
+                    *
+                inline warning
+            <system_message backrefs="problematic-5" ids="system-message-5" level="2" line="68" source="{include10}" type="WARNING">
+                <paragraph>
+                    Inline emphasis start-string without end-string.
+            <attribution>
+                attribution with \n\
+                <problematic ids="problematic-6" refid="system-message-6">
+                    *
+                inline warning
+        <system_message backrefs="problematic-6" ids="system-message-6" level="2" line="70" source="{include10}" type="WARNING">
+            <paragraph>
+                Inline emphasis start-string without end-string.
         <paragraph>
-            <problematic ids="id11" refid="id10">
+            <problematic ids="problematic-7" refid="system-message-7">
                 :PEP:`-1`
-        <system_message backrefs="id11" ids="id10" level="3" line="68" source="%(source)s" type="ERROR">
+        <system_message backrefs="problematic-7" ids="system-message-7" level="3" line="72" source="{include10}" type="ERROR">
             <paragraph>
                 PEP number must be a number from 0 to 9999; "-1" is invalid.
-        <system_message level="1" line="66" source="%(source)s" type="INFO">
+        <system_message level="1" line="70" source="{include10}" type="INFO">
             <paragraph>
                 No directive entry for "unknown" in module "docutils.parsers.rst.languages.en".
                 Trying "unknown" as canonical directive name.
-        <system_message level="3" line="70" source="%(source)s" type="ERROR">
+        <system_message level="3" line="74" source="{include10}" type="ERROR">
             <paragraph>
                 Unknown directive type "unknown".
             <literal_block xml:space="preserve">
-                .. unknown:: directive (info still reported with wrong line)
-        <system_message level="3" line="72" source="%(source)s" type="ERROR">
+                .. unknown:: directive (TODO: info still reported with wrong line)
+        <system_message level="3" line="76" source="{include10}" type="ERROR">
             <paragraph>
                 Malformed table.
                 No bottom table border found.
@@ -750,15 +852,14 @@
                 ==============  ======
                 A simple table  with
                 no bottom       border
-""" % {'source': reldir(include10), 'nonexistent': reldir(nonexistent),
-       'unichr_exception':
-       DocutilsTestSupport.exception_data(unichr, int("11111111", 16))2
-      },
-"""\
+                \n\
+                .. end of inclusion from "{include10}"
+""",
+f"""\
 Include file with whitespace in the path:
 
-.. include:: %s
-""" % reldir(include11),
+.. include:: {include11}
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -771,7 +872,7 @@
 
 .. include:: <isogrk4.txt>
 """,
-b"""\
+"""\
 <document source="test data">
     <paragraph>
         Standard include data file:
@@ -781,35 +882,35 @@
         Derived from the Unicode character mappings available from
         <http://www.w3.org/2003/entities/xml/>.
         Processed by unicode2rstsubs.py, part of Docutils:
-        <http://docutils.sourceforge.net>.
+        <https://docutils.sourceforge.io>.
     <substitution_definition names="b.Gammad">
-        \\u03dc
+        \u03dc
     <substitution_definition names="b.gammad">
-        \\u03dd
-""".decode('raw_unicode_escape'),
+        \u03dd
+""",
 """\
 Nonexistent standard include data file:
 
 .. include:: <nonexistent>
 """,
-"""\
+f"""\
 <document source="test data">
     <paragraph>
         Nonexistent standard include data file:
     <system_message level="4" line="3" source="test data" type="SEVERE">
         <paragraph>
             Problems with "include" directive path:
-            InputError: Errno 2 No such file or directory: '%s'.
+            InputError: Errno 2 No such file or directory: '{nonexistent}'.
         <literal_block xml:space="preserve">
             .. include:: <nonexistent>
-""" % nonexistent_rel,
-"""\
+""",
+f"""\
 Include start-line/end-line Test
 
-.. include:: %s
+.. include:: {include2}
    :start-line: 3
    :end-line: 4
-""" % include2,
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -817,16 +918,16 @@
     <paragraph>
         This file (include2.txt) is used by
 """,
-"""\
+f"""\
 Include start-line/end-line + start-after Test
 
-.. include:: %s
+.. include:: {include12}
    :start-line: 2
    :end-line: 5
    :start-after: here
 
 Text search is limited to the specified lines.
-""" % include12,
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -836,15 +937,15 @@
     <paragraph>
         Text search is limited to the specified lines.
 """,
-"""\
+f"""\
 Include start-after/end-before Test
 
-.. include:: %s
+.. include:: {include12}
    :start-after: .. start here
    :end-before: .. stop here
 
 A paragraph.
-""" % include12,
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -854,17 +955,17 @@
     <paragraph>
         A paragraph.
 """,
-"""\
+f"""\
 Include start-after/end-before Test, single option variant
 
-.. include:: %s
+.. include:: {include12}
    :end-before: .. start here
 
-.. include:: %s
+.. include:: {include12}
    :start-after: .. stop here
 
 A paragraph.
-""" % (include12, include12),
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -876,16 +977,16 @@
     <paragraph>
         A paragraph.
 """,
-"""\
+f"""\
 Include start-after/end-before multi-line test.
 
-.. include:: %s
+.. include:: {include13}
    :start-after: From: me
                  To: you
    :end-before: -------
                 -- mork of ork
 
-.. include:: %s
+.. include:: {include13}
    :start-after: From: me
                  To: you
    :end-before:
@@ -893,8 +994,8 @@
          -- mork of ork
 
 A paragraph.
-""" % (include13, include13),
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Include start-after/end-before multi-line test.
@@ -903,7 +1004,7 @@
             Problem with "end-before" option of "include" directive:
             Text not found.
         <literal_block xml:space="preserve">
-            .. include:: %s
+            .. include:: {include13}
                :start-after: From: me
                              To: you
                :end-before: -------
@@ -912,15 +1013,15 @@
         In include13.txt (between header and signature)
     <paragraph>
         A paragraph.
-""" % include13,
-"""\
+""",
+f"""\
 Error handling test; "end-before" error handling tested in previous test.
 
-.. include:: %s
+.. include:: {include13}
    :start-after: bad string
    :end-before: mork of ork
-""" % include13,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Error handling test; "end-before" error handling tested in previous test.
@@ -929,80 +1030,97 @@
             Problem with "start-after" option of "include" directive:
             Text not found.
         <literal_block xml:space="preserve">
-            .. include:: %s
+            .. include:: {include13}
                :start-after: bad string
                :end-before: mork of ork
-""" % include13,
-"""\
+""",
+f"""\
 TAB expansion with literal include:
 
-.. include:: %s
+.. include:: {include_literal}
    :literal:
-""" % include_literal,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         TAB expansion with literal include:
-    <literal_block source="%s" xml:space="preserve">
+    <literal_block source="{include_literal}" xml:space="preserve">
         Literal included this should **not** be *marked* `up`.
                 <- leading raw tab.
-        
+        \n\
         Newlines
         are
         normalized.
-""" % include_literal,
-"""\
+""",
+f"""\
 Custom TAB expansion with literal include:
 
-.. include:: %s
+.. include:: {include_literal}
    :literal:
    :tab-width: 2
-""" % include_literal,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Custom TAB expansion with literal include:
-    <literal_block source="%s" xml:space="preserve">
+    <literal_block source="{include_literal}" xml:space="preserve">
         Literal included this should **not** be *marked* `up`.
           <- leading raw tab.
-        
+        \n\
         Newlines
         are
         normalized.
-""" % include_literal,
-"""\
+""",
+f"""\
 No TAB expansion with literal include:
 
-.. include:: %s
+.. include:: {include_literal}
    :literal:
    :tab-width: -1
-""" % include_literal,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         No TAB expansion with literal include:
-    <literal_block source="%s" xml:space="preserve">
+    <literal_block source="{include_literal}" xml:space="preserve">
         Literal included this should **not** be *marked* `up`.
         \t<- leading raw tab.
-        
+        \n\
         Newlines
         are
         normalized.
-""" % include_literal,
+""",
 
 
-totest'include-code' = 
-"""\
+totest'include_parsed_code' = 
+f"""\
 Included code
 
-.. include:: %s
+.. include:: {include1}
    :code: rst
-""" % include1,
-"""\
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        Included code
+    <literal_block classes="code rst" source="{include1}" xml:space="preserve">
+        <inline classes="generic heading">
+            Inclusion 1
+        \n\
+        <inline classes="generic heading">
+            -----------
+        \n\
+        <inline classes="whitespace">
+            \n\
+        This file is used by \n\
+        <inline classes="literal string">
+            ``test_include.py``
+        .
+""" if PYGMENTS_2_14_PLUS else f"""\
 <document source="test data">
     <paragraph>
         Included code
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include1}" xml:space="preserve">
         <inline classes="generic heading">
             Inclusion 1
         \n\
@@ -1014,19 +1132,45 @@
         <inline classes="literal string">
             ``test_include.py``
         .
-""" % reldir(include1),
-"""\
+""",
+f"""\
 Included code
 
-.. include:: %s
+.. include:: {include1}
    :code: rst
    :number-lines:
-""" % include1,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Included code
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include1}" xml:space="preserve">
+        <inline classes="ln">
+            1 \n\
+        <inline classes="generic heading">
+            Inclusion 1
+        \n\
+        <inline classes="ln">
+            2 \n\
+        <inline classes="generic heading">
+            -----------
+        \n\
+        <inline classes="ln">
+            3 \n\
+        <inline classes="whitespace">
+            \n\
+        <inline classes="ln">
+            4 \n\
+        <inline classes="whitespace">
+        This file is used by \n\
+        <inline classes="literal string">
+            ``test_include.py``
+        .
+""" if PYGMENTS_2_14_PLUS else f"""\
+<document source="test data">
+    <paragraph>
+        Included code
+    <literal_block classes="code rst" source="{include1}" xml:space="preserve">
         <inline classes="ln">
             1 \n\
         <inline classes="generic heading">
@@ -1046,18 +1190,46 @@
         <inline classes="literal string">
             ``test_include.py``
         .
-""" % reldir(include1),
-"""\
+""",
+f"""\
 TAB expansion with included code:
 
-.. include:: %s
+.. include:: {include_literal}
    :code: rst
-""" % include_literal,
-"""\
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        TAB expansion with included code:
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
+        Literal included this should \n\
+        <inline classes="generic strong">
+            **not**
+         be \n\
+        <inline classes="generic emph">
+            *marked*
+         \n\
+        <inline classes="name variable">
+            `up`
+        .
+        <inline classes="whitespace">
+            \n\
+                <- leading raw tab.
+        <inline classes="whitespace">
+            \n\
+            \n\
+        Newlines
+        <inline classes="whitespace">
+            \n\
+        are
+        <inline classes="whitespace">
+            \n\
+        normalized.
+""" if PYGMENTS_2_14_PLUS else f"""\
 <document source="test data">
     <paragraph>
         TAB expansion with included code:
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
         Literal included this should \n\
         <inline classes="generic strong">
             **not**
@@ -1073,19 +1245,47 @@
         Newlines
         are
         normalized.
-""" % include_literal,
-"""\
+""",
+f"""\
 Custom TAB expansion with included code:
 
-.. include:: %s
+.. include:: {include_literal}
    :code: rst
    :tab-width: 2
-""" % include_literal,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Custom TAB expansion with included code:
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
+        Literal included this should \n\
+        <inline classes="generic strong">
+            **not**
+         be \n\
+        <inline classes="generic emph">
+            *marked*
+         \n\
+        <inline classes="name variable">
+            `up`
+        .
+        <inline classes="whitespace">
+            \n\
+          <- leading raw tab.
+        <inline classes="whitespace">
+            \n\
+            \n\
+        Newlines
+        <inline classes="whitespace">
+            \n\
+        are
+        <inline classes="whitespace">
+            \n\
+        normalized.
+""" if PYGMENTS_2_14_PLUS else f"""\
+<document source="test data">
+    <paragraph>
+        Custom TAB expansion with included code:
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
         Literal included this should \n\
         <inline classes="generic strong">
             **not**
@@ -1101,19 +1301,47 @@
         Newlines
         are
         normalized.
-""" % include_literal,
-"""\
+""",
+f"""\
 Custom TAB expansion with included code:
 
-.. include:: %s
+.. include:: {include_literal}
    :code: rst
    :tab-width: -1
-""" % include_literal,
-"""\
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        Custom TAB expansion with included code:
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
+        Literal included this should \n\
+        <inline classes="generic strong">
+            **not**
+         be \n\
+        <inline classes="generic emph">
+            *marked*
+         \n\
+        <inline classes="name variable">
+            `up`
+        .
+        <inline classes="whitespace">
+            \n\
+        \t<- leading raw tab.
+        <inline classes="whitespace">
+            \n\
+            \n\
+        Newlines
+        <inline classes="whitespace">
+            \n\
+        are
+        <inline classes="whitespace">
+            \n\
+        normalized.
+""" if PYGMENTS_2_14_PLUS else f"""\
 <document source="test data">
     <paragraph>
         Custom TAB expansion with included code:
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include_literal}" xml:space="preserve">
         Literal included this should \n\
         <inline classes="generic strong">
             **not**
@@ -1129,19 +1357,38 @@
         Newlines
         are
         normalized.
-""" % include_literal,
-"""\
+""",
+f"""\
 Including includes/include14.txt
 
-.. include:: %s
-""" % include14,
-"""\
+.. include:: {include14}
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Including includes/include14.txt
     <paragraph>
         Including more/include6.txt as rst-code from includes/include14.txt:
-    <literal_block classes="code rst" source="%s" xml:space="preserve">
+    <literal_block classes="code rst" source="{include6}" xml:space="preserve">
+        In includes/more/include6.txt
+        <inline classes="whitespace">
+            \n\
+            \n\
+        <inline classes="punctuation">
+            ..
+         \n\
+        <inline classes="operator word">
+            include
+        <inline classes="punctuation">
+            ::
+         ../sibling/include7.txt
+""" if PYGMENTS_2_14_PLUS else f"""\
+<document source="test data">
+    <paragraph>
+        Including includes/include14.txt
+    <paragraph>
+        Including more/include6.txt as rst-code from includes/include14.txt:
+    <literal_block classes="code rst" source="{include6}" xml:space="preserve">
         In includes/more/include6.txt
         \n\
         <inline classes="punctuation">
@@ -1152,13 +1399,13 @@
         <inline classes="punctuation">
             ::
          ../sibling/include7.txt
-""" % reldir(include6),
-"""\
+""",
+f"""\
 Circular inclusion
 
-.. include:: %s
-""" % include15,
-"""\
+.. include:: {include15}
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Circular inclusion
@@ -1166,24 +1413,27 @@
         File "include15.txt": example of rekursive inclusion.
     <paragraph>
         File "include16.txt": example of rekursive inclusion.
-    <system_message level="2" line="3" source="%s" type="WARNING">
+    <system_message level="2" line="3" source="{include16}" type="WARNING">
         <paragraph>
-            circular inclusion in "include" directive: %s < %s < %s < test data
+            circular inclusion in "include" directive:
+            {include15}
+            > {include16}
+            > {include15}
+            > test data
         <literal_block xml:space="preserve">
             .. include:: include15.txt
     <paragraph>
         No loop when clipping before the "include" directive:
     <paragraph>
         File "include15.txt": example of rekursive inclusion.
-""" % (reldir(include16), reldir(include15),
-       reldir(include16), reldir(include15)),
-"""\
+""",
+f"""\
 Circular inclusion with clipping.
 
-.. include:: %s
+.. include:: {include16}
    :start-line: 2
-""" % include16,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Circular inclusion with clipping.
@@ -1191,9 +1441,14 @@
         File "include15.txt": example of rekursive inclusion.
     <paragraph>
         File "include16.txt": example of rekursive inclusion.
-    <system_message level="2" line="3" source="%s" type="WARNING">
+    <system_message level="2" line="3" source="{include16}" type="WARNING">
         <paragraph>
-            circular inclusion in "include" directive: %s < %s < %s < %s < test data
+            circular inclusion in "include" directive:
+            {include15}
+            > {include16}
+            > {include15}
+            > {include16}
+            > test data
         <literal_block xml:space="preserve">
             .. include:: include15.txt
     <paragraph>
@@ -1204,10 +1459,95 @@
         No loop when clipping before the "include" directive:
     <paragraph>
         File "include15.txt": example of rekursive inclusion.
-""" % (reldir(include16), reldir(include15), reldir(include16),
-       reldir(include15), reldir(include16)),
+""",
+f"""\
+Circular inclusion with specified parser.
+
+.. include:: {include15}
+   :parser: rst
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        Circular inclusion with specified parser.
+    <paragraph>
+        File "include15.txt": example of rekursive inclusion.
+    <paragraph>
+        File "include16.txt": example of rekursive inclusion.
+    <system_message level="2" line="3" source="{include16}" type="WARNING">
+        <paragraph>
+            circular inclusion in "include" directive:
+            {include15}
+            > {include16}
+            > {include15}
+            > test data
+        <literal_block xml:space="preserve">
+            .. include:: include15.txt
+    <paragraph>
+        No loop when clipping before the "include" directive:
+    <paragraph>
+        File "include15.txt": example of rekursive inclusion.
+""",
+f"""\
+No circular inclusion.
+
+.. list-table::
+
+   * - .. include:: {include}
+     - .. include:: {include}
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        No circular inclusion.
+    <table>
+        <tgroup cols="2">
+            <colspec colwidth="50">
+            <colspec colwidth="50">
+            <tbody>
+                <row>
+                    <entry>
+                        <paragraph>
+                            Some include text.
+                    <entry>
+                        <paragraph>
+                            Some include text.
+""",
 
 
+# Parsing with Markdown is an optional feature depending on 3rd-party modules:
+totest'include_markdown' = 
+f"""\
+Include Markdown source.
+
+.. include:: {include_md}
+   :parser: {md_parser_name}
+
+A paragraph.
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Include Markdown source.
+    <section ids="title-1" names="title\\ 1">
+        <title>
+            Title 1
+        <paragraph>
+            <emphasis>
+                emphasis
+             and \n\
+            <emphasis>
+                also emphasis
+        <paragraph>
+            No whitespace required around a
+            <reference name="phrase reference" refuri="/uri">
+                phrase reference
+            .
+    <paragraph>
+        A paragraph.
+""",
+
+
+
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_line_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_line_blocks.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_math.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_math.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_math.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_math.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Guenter Milde <milde@users.sf.net>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'math' directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -76,12 +93,12 @@
 """,
 
 
-totest'content with blank line' = 
+totest'content_with_blank_line' = 
 """\
 .. math::
 
   1+1=2
-  
+
   E = mc^2
 """,
 """\
@@ -95,5 +112,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_meta.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_meta.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_meta.py 8603 2021-01-08 15:24:32Z milde $
+# $Id: test_meta.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for html meta directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -29,22 +46,8 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="The reStructuredText plaintext markup language" name="description">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="plaintext,markup language" name="keywords">
+    <meta content="The reStructuredText plaintext markup language" name="description">
+    <meta content="plaintext,markup language" name="keywords">
 """,
 """\
 .. meta::
@@ -53,22 +56,8 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="An amusing story" lang="en" name="description">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="Un histoire amusant" lang="fr" name="description">
+    <meta content="An amusing story" lang="en" name="description">
+    <meta content="Un histoire amusant" lang="fr" name="description">
 """,
 """\
 .. meta::
@@ -76,14 +65,7 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
+    <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
 """,
 """\
 .. meta::
@@ -92,14 +74,7 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content over multiple lines" name="name">
+    <meta content="content over multiple lines" name="name">
 """,
 """\
 Paragraph
@@ -109,16 +84,9 @@
 """,
 """\
 <document source="test data">
+    <meta content="content" name="name">
     <paragraph>
         Paragraph
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content" name="name">
 """,
 """\
 .. meta::
@@ -164,14 +132,7 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content" name="name">
+    <meta content="content" name="name">
     <system_message level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Invalid meta directive.
@@ -189,22 +150,8 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content" name="name">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content" name="name">
+    <meta content="content" name="name">
+    <meta content="content" name="name">
     <system_message level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Invalid meta directive.
@@ -234,26 +181,11 @@
 """,
 """\
 <document source="test data">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="escaped linebreak" name="name:with:colons">
-    <pending>
-        .. internal attributes:
-             .transform: docutils.transforms.components.Filter
-             .details:
-               component: 'writer'
-               format: 'html,latex,odt'
-               nodes:
-                 <meta content="content" name="unescaped:embedded:colons">
+    <meta content="escaped linebreak" name="name:with:colons">
+    <meta content="content" name="unescaped:embedded:colons">
 """,
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_parsed_literals.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_parsed_literals.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_parsed_literals.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_parsed_literals.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the body.py 'parsed-literal' directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -73,5 +90,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_raw.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_raw.py Changed

@@ -1,37 +1,55 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_raw.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_raw.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "raw" directive.
 """
-from __future__ import absolute_import
 
 import os.path
+from pathlib import Path
 import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..', '..'))
 
-mydir = 'test_parsers/test_rst/test_directives/'
-raw1 = os.path.join(mydir, 'raw1.txt')
-utf_16_file = os.path.join(mydir, 'utf-16.csv')
-utf_16_file_rel = DocutilsTestSupport.utils.relative_path(None, utf_16_file)
-utf_16_error_str = ("UnicodeDecodeError: 'ascii' codec can't decode byte 0xfe "
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+mydir = os.path.join(TEST_ROOT, 'test_parsers/test_rst/test_directives')
+raw1 = os.path.relpath(
+    os.path.join(mydir, 'raw1.txt'),
+    os.getcwd()).replace('\\', '/')
+utf_16_file = os.path.relpath(
+    os.path.join(TEST_ROOT, 'data/utf-16-le-sig.txt'),
+    os.getcwd()).replace('\\', '/')
+utf_16_error_str = ("UnicodeDecodeError: 'ascii' codec can't decode byte 0xff "
                     "in position 0: ordinal not in range(128)")
-if sys.version_info < (3, 0):
-    utf_16_error_str = ("UnicodeError: Unable to decode input data.  "
-                        "Tried the following encodings: 'ascii'.\n"
-                        "            (%s)" % utf_16_error_str)
 
 totest = {}
 
@@ -46,15 +64,15 @@
     <raw format="html" xml:space="preserve">
         <span>This is some plain old raw text.</span>
 """,
-"""\
+f"""\
 .. raw:: html
-   :file: %s
-""" % raw1,
-"""\
+   :file: {raw1}
+""",
+f"""\
 <document source="test data">
-    <raw format="html" source="%s" xml:space="preserve">
+    <raw format="html" source="{raw1}" xml:space="preserve">
         <p>This file is used by <tt>test_raw.py</tt>.</p>
-""" % DocutilsTestSupport.utils.relative_path(None, raw1),
+""",
 """\
 .. raw:: html
    :file: rawfile.html
@@ -84,12 +102,12 @@
         <literal_block xml:space="preserve">
             .. raw:: html
                :file: rawfile.html
-            
+            \n\
                <p>Can't have both content and file attribute.</p>
 """,
 r"""
 .. raw:: latex html
- 
+
    \ \sum_{n=1}^\infty \frac{1}{n} \text{ etc.} \
 """,
 """\
@@ -97,41 +115,50 @@
     <raw format="latex html" xml:space="preserve">
         \\ \\sum_{n=1}^\\infty \\frac{1}{n} \\text{ etc.} \\
 """,
-"""\
+f"""\
 .. raw:: html
-   :file: %s
+   :file: {utf_16_file}
    :encoding: utf-16
-""" % utf_16_file_rel,
-b"""\
+""",
+f"""\
 <document source="test data">
-    <raw format="html" source="%s" xml:space="preserve">
-        "Treat", "Quantity", "Description"
-        "Albatr\xb0\xdf", 2.99, "\xa1On a \\u03c3\\u03c4\\u03b9\\u03ba!"
-        "Crunchy Frog", 1.49, "If we took the b\xf6nes out, it wouldn\\u2019t be
-        crunchy, now would it?"
-        "Gannet Ripple", 1.99, "\xbfOn a \\u03c3\\u03c4\\u03b9\\u03ba?"
-""".decode('raw_unicode_escape') % utf_16_file_rel,
-"""\
+    <raw format="html" source="{utf_16_file}" xml:space="preserve">
+        Grüße
+""",
+f"""\
+Default encoding: auto-determine (here via BOM).
+
+.. raw:: html
+   :file: {utf_16_file}
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        Default encoding: auto-determine (here via BOM).
+    <raw format="html" source="{utf_16_file}" xml:space="preserve">
+        Grüße
+""",
+f"""\
 Raw input file is UTF-16-encoded, and is not valid ASCII.
 
 .. raw:: html
-   :file: %s
+   :file: {utf_16_file}
    :encoding: ascii
-""" % utf_16_file_rel,
-"""\
+""",
+f"""\
 <document source="test data">
     <paragraph>
         Raw input file is UTF-16-encoded, and is not valid ASCII.
     <system_message level="4" line="3" source="test data" type="SEVERE">
         <paragraph>
             Problem with "raw" directive:
-            %s
+            {utf_16_error_str}
         <literal_block xml:space="preserve">
             .. raw:: html
-               :file: %s
+               :file: {utf_16_file}
                :encoding: ascii
-""" % (utf_16_error_str, utf_16_file_rel),
-u"""\
+""",
+"""\
 .. raw:: html
    :encoding: utf-8
 
@@ -171,5 +198,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_replace.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_replace.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_replace.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_replace.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "replace" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -55,7 +72,7 @@
             Substitution definition "name" empty or invalid.
         <literal_block xml:space="preserve">
             .. |name| replace:: paragraph 1
-            
+            \n\
                                 paragraph 2
 """,
 """\
@@ -84,13 +101,13 @@
 """\
 <document source="test data">
     <substitution_definition names="Python">
-        Python, 
+        Python, \n\
         <emphasis>
             the
          best language around
     <target ids="python" names="python" refuri="http://www.python.org/">
     <paragraph>
-        I recommend you try 
+        I recommend you try \n\
         <reference refname="python">
             <substitution_reference refname="Python">
                 Python
@@ -101,20 +118,20 @@
 """,
 """\
 <document source="test data">
-    <system_message ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
-    <system_message ids="id3" level="2" line="1" source="test data" type="WARNING">
+    <system_message ids="system-message-2" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline strong start-string without end-string.
-    <system_message ids="id5" level="2" line="1" source="test data" type="WARNING">
+    <system_message ids="system-message-3" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline literal start-string without end-string.
     <system_message level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Substitution definition contains illegal element <problematic>:
         <literal_block xml:space="preserve">
-            <problematic ids="id2" refid="id1">
+            <problematic ids="problematic-1" refid="system-message-1">
                 *
         <literal_block xml:space="preserve">
             .. |name| replace::  *error in **inline ``markup
@@ -134,5 +151,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_replace_fr.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_replace_fr.py Changed

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
 # $Id: test_replace.py 4667 2006-07-12 21:40:56Z wiemann $
 # Author: David Goodger <goodger@python.org>
@@ -8,17 +8,35 @@
 Tests for misc.py "replace" directive.
 Test in french (not default/fallback language).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.language_code = 'fr'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings={'language_code':'fr'})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -67,10 +85,10 @@
         Le \n\
         <substitution_reference refname="Na+">
             Na+
-         est l\'ion sodium.""",
+         est l\'ion sodium.
+""",
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_role.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_role.py Changed

@@ -1,23 +1,45 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_role.py 8571 2020-10-28 08:46:19Z milde $
+# $Id: test_role.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "role" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser, roles
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                # Language-specific roles and roles added by the
+                # "default-role" and "role" directives are currently stored
+                # globally in the roles._roles dictionary.  This workaround
+                # empties that dictionary.
+                roles._roles = {}
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -64,15 +86,15 @@
 """\
 <document source="test data">
     <paragraph>
-        Must define 
-        <problematic ids="id2" refid="id1">
+        Must define \n\
+        <problematic ids="problematic-1" refid="system-message-1">
             :custom:`interpreted`
          before using it.
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
             No role entry for "custom" in module "docutils.parsers.rst.languages.en".
             Trying "custom" as canonical role name.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown interpreted text role "custom".
     <paragraph>
@@ -207,9 +229,9 @@
 """\
 <document source="test data">
     <paragraph>
-        Empty 
+        Empty \n\
         <inline classes="custom">
-         and empty 
+         and empty \n\
         <inline classes="special">
 """,
 """\
@@ -263,10 +285,10 @@
 <document source="test data">
     <paragraph>
         Can't use the \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :raw:`role`
          directly.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             No format (Writer name) is associated with this role: "raw".
             The "raw" role cannot be used directly.
@@ -276,5 +298,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_rubrics.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_rubrics.py Changed

@@ -1,22 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_rubrics.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_rubrics.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the "rubric" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -81,5 +99,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_sectnum.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_sectnum.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_sectnum.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_sectnum.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'sectnum' directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -54,5 +71,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_sidebars.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_sidebars.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_sidebars.py 8524 2020-07-10 10:08:14Z milde $
+# $Id: test_sidebars.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the "sidebar" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -100,5 +117,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_tables.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_tables.py Changed

@@ -1,70 +1,171 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_tables.py 8497 2020-03-03 20:45:54Z milde $
+# $Id: test_tables.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for tables.py directives.
 """
-from __future__ import absolute_import
 
 import os
-import sys
 import csv
 import platform
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
-from docutils.parsers.rst.directives import tables
-
-
-if sys.version_info >= (3, 0):
-    unicode = str  # noqa
-    unichr = chr  # noqa
-
-
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
-
-mydir = 'test_parsers/test_rst/test_directives/'
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..', '..'))
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+mydir = os.path.join(TEST_ROOT, 'test_parsers/test_rst/test_directives')
 utf_16_csv = os.path.join(mydir, 'utf-16.csv')
-utf_16_csv_rel = DocutilsTestSupport.utils.relative_path(None, utf_16_csv)
 empty_txt = os.path.join(mydir, 'empty.txt')
 
-unichr_exception = DocutilsTestSupport.exception_data(
-    unichr, int("9999999999999", 16))0
-if isinstance(unichr_exception, OverflowError):
-    unichr_exception_string = 'code too large (%s)' % unichr_exception
-else:
+try:
+    chr(0x9999999999999)
+except OverflowError as unichr_exception:
+    unichr_exception_string = f'code too large ({unichr_exception})'
+except Exception as unichr_exception:
     unichr_exception_string = str(unichr_exception)
+else:
+    unichr_exception_string = ''
 
-# some error messages changed in Python 3.3, CPython has backported to 2.7.4,
-# PyPy has not
 csv_eod_error_str = 'unexpected end of data'
-if sys.version_info < (2,7,4) or (platform.python_implementation() == 'PyPy'
-                                  and sys.version_info < (3,0)):
-    csv_eod_error_str = 'newline inside string'
 # pypy adds a line number
 if platform.python_implementation() == 'PyPy':
     csv_eod_error_str = 'line 1: ' + csv_eod_error_str
 csv_unknown_url = "'bogus.csv'"
-if sys.version_info < (3, 0):
-    csv_unknown_url = "bogus.csv"
 
 
-def null_bytes():
+try:
     with open(utf_16_csv, 'rb') as f:
         csv_data = f.read()
-    csv_data = unicode(csv_data, 'latin1').splitlines()
-    reader = csv.reader(tables.CSVTable.encode_for_csv(line + '\n')
-                         for line in csv_data)
+    csv_data = str(csv_data, 'latin1').splitlines()
+    reader = csv.reader(line + '\n' for line in csv_data)
     next(reader)
+except Exception as detail:
+    null_bytes_exception = detail
+else:
+    null_bytes_exception = None
+
+# Null bytes are valid in Python 3.11+:
+if null_bytes_exception is None:
+    bad_encoding_result = """\
+<document source="test data">
+    <table>
+        <title>
+            bad encoding
+        <tgroup cols="4">
+            <colspec colwidth="25">
+            <colspec colwidth="25">
+            <colspec colwidth="25">
+            <colspec colwidth="25">
+            <tbody>
+                <row>
+                    <entry>
+                        <paragraph>
+                            \xfe\xff"Treat"
+                    <entry>
+                        <paragraph>
+                            "Quantity"
+                    <entry>
+                        <paragraph>
+                            "Description"
+                    <entry>
+                <row>
+                    <entry>
+                        <paragraph>
+                            "Albatr\u00b0\u00df"
+                    <entry>
+                        <paragraph>
+                            2.99
+                    <entry>
+                        <paragraph>
+                            "\u00a1Ona\x03\xc3\x03\xc4\x03\xb9\x03\xba!"
+                    <entry>
+                <row>
+                    <entry>
+                        <paragraph>
+                            "CrunchyFrog"
+                    <entry>
+                        <paragraph>
+                            1.49
+                    <entry>
+                        <paragraph>
+                            "Ifwetooktheb\u00f6nesout
+                    <entry>
+                        <paragraph>
+                            itwouldn\x20\x19tbe
+                <row>
+                    <entry>
+                        <paragraph>
+                            crunchy
+                    <entry>
+                        <paragraph>
+                            nowwouldit?"
+                    <entry>
+                    <entry>
+                <row>
+                    <entry>
+                        <paragraph>
+                            "GannetRipple"
+                    <entry>
+                        <paragraph>
+                            1.99
+                    <entry>
+                        <paragraph>
+                            "\xbfOna\x03\xc3\x03\xc4\x03\xb9\x03\xba?"
+                    <entry>
+    <paragraph>
+        (7- and 8-bit text encoded as UTF-16 has lots of null/zero bytes.)
+"""
+else:
+    bad_encoding_result = """\
+<document source="test data">
+    <system_message level="3" line="1" source="test data" type="ERROR">
+        <paragraph>
+            Error with CSV data in "csv-table" directive:
+            %s
+        <literal_block xml:space="preserve">
+            .. csv-table:: bad encoding
+               :file: %s
+               :encoding: latin-1
+    <paragraph>
+        (7- and 8-bit text encoded as UTF-16 has lots of null/zero bytes.)
+""" % (null_bytes_exception, utf_16_csv)
 
-null_bytes_exception = DocutilsTestSupport.exception_data(null_bytes)0
+try:
+    int('y')
+except ValueError as detail:
+    invalid_literal = detail.args0
+else:
+    invalid_literal = ''
 
 totest = {}
 
@@ -155,7 +256,7 @@
     <table>
         <title>
             title with an \n\
-            <problematic ids="id2" refid="id1">
+            <problematic ids="problematic-1" refid="system-message-1">
                 *
             error
         <tgroup cols="2">
@@ -169,7 +270,7 @@
                     <entry>
                         <paragraph>
                             table
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
@@ -385,7 +486,7 @@
 """,
 
 
-totest'csv-table' = 
+totest'csv_table' = 
 """\
 .. csv-table:: inline with integral header
    :width: 80%
@@ -630,12 +731,12 @@
                     <entry>
                     <entry>
 """,
-u"""\
+"""\
 .. csv-table:: non-ASCII characters
 
    Heiz\xf6lr\xfccksto\xdfabd\xe4mpfung
 """,
-u"""\
+"""\
 <document source="test data">
     <table>
         <title>
@@ -766,7 +867,7 @@
     <table>
         <title>
             error in the \n\
-            <problematic ids="id2" refid="id1">
+            <problematic ids="problematic-1" refid="system-message-1">
                 *
             title
         <tgroup cols="3">
@@ -784,7 +885,7 @@
                     <entry>
                         <paragraph>
                             data
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
@@ -812,11 +913,11 @@
     <system_message level="4" line="1" source="test data" type="SEVERE">
         <paragraph>
             Problems with "csv-table" directive URL "bogus.csv":
-            unknown url type: %s.
+            unknown url type: 'bogus.csv'.
         <literal_block xml:space="preserve">
             .. csv-table:: bad URL
                :url: bogus.csv
-""" % csv_unknown_url,
+""",
 """\
 .. csv-table:: column mismatch
    :widths: 10,20
@@ -867,7 +968,7 @@
                :widths: 0 0 0
             \n\
                some, csv, data
-""" % DocutilsTestSupport.exception_data(int, u"y")10,
+""" % invalid_literal,
 """\
 .. csv-table:: good delimiter
    :delim: /
@@ -1031,26 +1132,15 @@
 
 (7- and 8-bit text encoded as UTF-16 has lots of null/zero bytes.)
 """ % utf_16_csv,
-"""\
-<document source="test data">
-    <system_message level="3" line="1" source="test data" type="ERROR">
-        <paragraph>
-            Error with CSV data in "csv-table" directive:
-            %s
-        <literal_block xml:space="preserve">
-            .. csv-table:: bad encoding
-               :file: %s
-               :encoding: latin-1
-    <paragraph>
-        (7- and 8-bit text encoded as UTF-16 has lots of null/zero bytes.)
-""" % (null_bytes_exception, utf_16_csv),
+bad_encoding_result
+,
 """\
 .. csv-table:: good encoding
    :file: %s
    :encoding: utf-16
    :header-rows: 1
 """ % utf_16_csv,
-u"""\
+"""\
 <document source="test data">
     <table>
         <title>
@@ -1104,6 +1194,64 @@
                             \u00bfOn a \u03c3\u03c4\u03b9\u03ba?
 """,
 """\
+.. csv-table:: auto encoding
+   :file: %s
+   :header-rows: 1
+""" % utf_16_csv,
+"""\
+<document source="test data">
+    <table>
+        <title>
+            auto encoding
+        <tgroup cols="3">
+            <colspec colwidth="33">
+            <colspec colwidth="33">
+            <colspec colwidth="33">
+            <thead>
+                <row>
+                    <entry>
+                        <paragraph>
+                            Treat
+                    <entry>
+                        <paragraph>
+                            Quantity
+                    <entry>
+                        <paragraph>
+                            Description
+            <tbody>
+                <row>
+                    <entry>
+                        <paragraph>
+                            Albatr\u00b0\u00df
+                    <entry>
+                        <paragraph>
+                            2.99
+                    <entry>
+                        <paragraph>
+                            \u00a1On a \u03c3\u03c4\u03b9\u03ba!
+                <row>
+                    <entry>
+                        <paragraph>
+                            Crunchy Frog
+                    <entry>
+                        <paragraph>
+                            1.49
+                    <entry>
+                        <paragraph>
+                            If we took the b\u00f6nes out, it wouldn\u2019t be
+                            crunchy, now would it?
+                <row>
+                    <entry>
+                        <paragraph>
+                            Gannet Ripple
+                    <entry>
+                        <paragraph>
+                            1.99
+                    <entry>
+                        <paragraph>
+                            \u00bfOn a \u03c3\u03c4\u03b9\u03ba?
+""",
+"""\
 .. csv-table:: no CSV data
    :file: %s
 """ % empty_txt,
@@ -1118,7 +1266,7 @@
 """ % empty_txt,
 
 
-totest'list-table' = 
+totest'list_table' = 
 """\
 .. list-table:: list table with integral header
    :widths: 10 20 30
@@ -1461,5 +1609,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_target_notes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_target_notes.py Changed

@@ -1,27 +1,44 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_target_notes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_target_notes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the target-notes directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
-totest'target-notes' = 
+totest'target_notes' = 
 """\
 .. target-notes::
 """,
@@ -44,7 +61,7 @@
                class: 'custom'
 """,
 """\
-.. target-notes:: 
+.. target-notes::
    :class: custom
    :name: targets
 """,
@@ -75,5 +92,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_test_directives.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_test_directives.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_test_directives.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_test_directives.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py test directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -206,5 +223,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_title.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_title.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_title.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_title.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the 'title' directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -32,5 +49,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_topics.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_topics.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_topics.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_topics.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the "topic" directive.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -253,5 +270,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_unicode.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_unicode.py Changed

@@ -1,36 +1,57 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_unicode.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_unicode.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for misc.py "unicode" directive.
 """
-from __future__ import absolute_import
 
+
+from pathlib import Path
 import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
-
-
-if sys.version_info >= (3, 0):
-    unichr = chr  # noqa
-
-
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+try:
+    chr(0x111111111111111111)
+except OverflowError as unichr_exception:
+    unichr_exception_string = f'code too large ({unichr_exception})'
+except Exception as unichr_exception:
+    unichr_exception_string = str(unichr_exception)
+else:
+    unichr_exception_string = ''
 
-unichr_exception = DocutilsTestSupport.exception_data(
-    unichr, int("111111111111111111", 16))0
-if isinstance(unichr_exception, OverflowError):
-    unichr_exception_string = 'code too large (%s)' % unichr_exception
+try:
+    chr(0x11111111)
+except Exception as detail:
+    invalid_char_code = f'{detail.__class__.__name__}: {detail}'
 else:
-    unichr_exception_string = str(unichr_exception)
+    invalid_char_code = ''
 
 totest = {}
 
@@ -45,7 +66,7 @@
 .. |bne| unicode:: U0003D U020E5
 .. |Omega| unicode:: U+003A9
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Insert an em-dash (
@@ -125,15 +146,15 @@
 .. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122
    .. with trademark sign
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Testing comments and extra text.
     <paragraph>
-        Copyright 
+        Copyright \n\
         <substitution_reference refname="copy">
             copy
-         2003, 
+         2003, \n\
         <substitution_reference refname="BogusMegaCorp (TM)">
             BogusMegaCorp (TM)
         .
@@ -171,11 +192,9 @@
             Substitution definition "too big for unicode" empty or invalid.
         <literal_block xml:space="preserve">
             .. |too big for unicode| unicode:: 0x11111111
-""" % (unichr_exception_string,
-       DocutilsTestSupport.exception_data(unichr, int("11111111", 16))2)
+""" % (unichr_exception_string, invalid_char_code)
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_directives/test_unknown.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_directives/test_unknown.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_unknown.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_unknown.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for unknown directives.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents4))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -65,5 +82,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_doctest_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_doctest_blocks.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_doctest_blocks.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_doctest_blocks.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -72,5 +89,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_east_asian_text.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_east_asian_text.py Changed

@@ -1,48 +1,56 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_east_asian_text.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_east_asian_text.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for East Asian text with double-width characters.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
 
-import unicodedata
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
-try:
-    east_asian_width = unicodedata.east_asian_width
-except AttributeError:
-    east_asian_width = None
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
-totest'double-width' = 
-u"""\
+totest'double_width' = 
+"""\
 タイトル1
 =========
 
 タイトル2
 ========
 """,
-u"""\
+"""\
 <document source="test data">
-    <section ids="id1" names="タイトル1">
+    <section ids="section-1" names="タイトル1">
         <title>
             タイトル1
-    <section ids="id2" names="タイトル2">
+    <section ids="section-2" names="タイトル2">
         <title>
             タイトル2
         <system_message level="2" line="5" source="test data" type="WARNING">
@@ -52,7 +60,7 @@
                 タイトル2
                 ========
 """,
-u"""
+"""
 +-----------------------+
 | * ヒョウ:ダイ1ギョウ  |
 | * ダイ2ギョウ         |
@@ -61,7 +69,7 @@
 | * ダイ2ギョウ         |
 +-----------------------+
 """,
-u"""\
+"""\
 <document source="test data">
     <table>
         <tgroup cols="1">
@@ -82,7 +90,7 @@
                             * ダイ1ギョウ
                             * ダイ2ギョウ
 """,
-u"""\
+"""\
 Complex spanning pattern (no edge knows all rows/cols):
 
 +--------+---------------------+
@@ -93,7 +101,7 @@
 | 南西・南セル          | セル |
 +-----------------------+------+
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Complex spanning pattern (no edge knows all rows/cols):
@@ -125,7 +133,7 @@
                         <paragraph>
                             南西・南セル
 """,
-u"""\
+"""\
 =========  =========
 ダイ1ラン  ダイ2ラン
 =========  =========
@@ -134,7 +142,7 @@
 ダイ1ラン ダイ2ラン
 ========  =========
 """,
-u"""\
+"""\
 <document source="test data">
     <table>
         <tgroup cols="2">
@@ -157,7 +165,7 @@
             ダイ1ラン ダイ2ラン
             ========  =========
 """,
-u"""\
+"""\
 Some ambiguous-width characters:
 
 = ===================================
@@ -167,12 +175,12 @@
 » right pointing guillemet
 – en-dash
 — em-dash
-‘ single turned comma quotation mark 
-’ single comma quotation mark 
-‚ low single comma quotation mark 
-“ double turned comma quotation mark 
-” double comma quotation mark 
-„ low double comma quotation mark 
+‘ single turned comma quotation mark
+’ single comma quotation mark
+‚ low single comma quotation mark
+“ double turned comma quotation mark
+” double comma quotation mark
+„ low double comma quotation mark
 † dagger
 ‡ double dagger
 … ellipsis
@@ -311,13 +319,12 @@
 """.decode('raw_unicode_escape'),
 
 '''
-u"""\
+"""\
 """,
-u"""\
+"""\
 """,
 '''
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_enumerated_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_enumerated_lists.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_enumerated_lists.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_enumerated_lists.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -652,7 +669,7 @@
             <paragraph>
                 Item 3.
 """,
-u"""\
+"""\
 A. Einstein was a great influence on
 B. Physicist, who was a colleague of
 C. Chemist.  They all worked in
@@ -906,5 +923,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_field_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_field_lists.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_field_lists.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_field_lists.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -446,11 +463,11 @@
         <field>
             <field_name>
                 Field name with \n\
-                <problematic ids="id2" refid="id1">
+                <problematic ids="problematic-1" refid="system-message-1">
                     *
                 bad inline markup
             <field_body>
-                <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+                <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
                         Inline emphasis start-string without end-string.
                 <paragraph>
@@ -661,7 +678,7 @@
                     works only when the role follows the text
         <field>
             <field_name>
-                a 
+                a \n\
                 <literal classes="code">
                     complex
                  field name
@@ -683,5 +700,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_footnotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_footnotes.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_footnotes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_footnotes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -27,7 +44,7 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
@@ -39,7 +56,7 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
@@ -55,13 +72,13 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             This is a footnote
             on multiple lines with more space.
-    <footnote ids="id2" names="2">
+    <footnote ids="footnote-2" names="2">
         <label>
             2
         <paragraph>
@@ -75,7 +92,7 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
@@ -89,7 +106,7 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
     <paragraph>
@@ -101,7 +118,7 @@
 """,
 """\
 <document source="test data">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
     <system_message level="2" line="2" source="test data" type="WARNING">
@@ -126,21 +143,21 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1">
+        <footnote_reference auto="1" ids="footnote-reference-1">
          is the first auto-numbered footnote reference.
-        <footnote_reference auto="1" ids="id2">
+        <footnote_reference auto="1" ids="footnote-reference-2">
          is the second auto-numbered footnote reference.
-    <footnote auto="1" ids="id3">
+    <footnote auto="1" ids="footnote-1">
         <paragraph>
             Auto-numbered footnote 1.
-    <footnote auto="1" ids="id4">
+    <footnote auto="1" ids="footnote-2">
         <paragraph>
             Auto-numbered footnote 2.
-    <footnote auto="1" ids="id5">
+    <footnote auto="1" ids="footnote-3">
         <paragraph>
             Auto-numbered footnote 3.
     <paragraph>
-        <footnote_reference auto="1" ids="id6">
+        <footnote_reference auto="1" ids="footnote-reference-3">
          is the third auto-numbered footnote reference.
 """,
 """\
@@ -160,7 +177,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refname="third">
+        <footnote_reference auto="1" ids="footnote-reference-1" refname="third">
          is a reference to the third auto-numbered footnote.
     <footnote auto="1" ids="first" names="first">
         <paragraph>
@@ -172,11 +189,11 @@
         <paragraph>
             Third auto-numbered footnote.
     <paragraph>
-        <footnote_reference auto="1" ids="id2" refname="second">
+        <footnote_reference auto="1" ids="footnote-reference-2" refname="second">
          is a reference to the second auto-numbered footnote.
-        <footnote_reference auto="1" ids="id3" refname="first">
+        <footnote_reference auto="1" ids="footnote-reference-3" refname="first">
          is a reference to the first auto-numbered footnote.
-        <footnote_reference auto="1" ids="id4" refname="third">
+        <footnote_reference auto="1" ids="footnote-reference-4" refname="third">
          is another reference to the third auto-numbered footnote.
     <paragraph>
         Here are some internal cross-references to the targets generated by
@@ -210,25 +227,25 @@
     <paragraph>
         Mixed anonymous and labelled auto-numbered footnotes:
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refname="four">
+        <footnote_reference auto="1" ids="footnote-reference-1" refname="four">
          should be 4, \n\
-        <footnote_reference auto="1" ids="id2">
+        <footnote_reference auto="1" ids="footnote-reference-2">
          should be 1,
-        <footnote_reference auto="1" ids="id3">
+        <footnote_reference auto="1" ids="footnote-reference-3">
          should be 3, \n\
-        <footnote_reference auto="1" ids="id4">
+        <footnote_reference auto="1" ids="footnote-reference-4">
          is one too many,
-        <footnote_reference auto="1" ids="id5" refname="two">
+        <footnote_reference auto="1" ids="footnote-reference-5" refname="two">
          should be 2, and \n\
-        <footnote_reference auto="1" ids="id6" refname="six">
+        <footnote_reference auto="1" ids="footnote-reference-6" refname="six">
          doesn't exist.
-    <footnote auto="1" ids="id7">
+    <footnote auto="1" ids="footnote-1">
         <paragraph>
             Auto-numbered footnote 1.
     <footnote auto="1" ids="two" names="two">
         <paragraph>
             Auto-numbered footnote 2.
-    <footnote auto="1" ids="id8">
+    <footnote auto="1" ids="footnote-2">
         <paragraph>
             Auto-numbered footnote 3.
     <footnote auto="1" ids="four" names="four">
@@ -237,8 +254,8 @@
     <footnote auto="1" dupnames="five" ids="five">
         <paragraph>
             Auto-numbered footnote 5.
-    <footnote auto="1" dupnames="five" ids="id9">
-        <system_message backrefs="id9" level="2" line="12" source="test data" type="WARNING">
+    <footnote auto="1" dupnames="five" ids="five-1">
+        <system_message backrefs="five-1" level="2" line="12" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "five".
         <paragraph>
@@ -267,36 +284,36 @@
         Mixed manually-numbered, anonymous auto-numbered,
         and labelled auto-numbered footnotes:
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refname="four">
+        <footnote_reference auto="1" ids="footnote-reference-1" refname="four">
          should be 4, \n\
-        <footnote_reference auto="1" ids="id2">
+        <footnote_reference auto="1" ids="footnote-reference-2">
          should be 2,
-        <footnote_reference ids="id3" refname="1">
+        <footnote_reference ids="footnote-reference-3" refname="1">
             1
          is 1, \n\
-        <footnote_reference ids="id4" refname="3">
+        <footnote_reference ids="footnote-reference-4" refname="3">
             3
          is 3,
-        <footnote_reference auto="1" ids="id5">
+        <footnote_reference auto="1" ids="footnote-reference-5">
          should be 6, \n\
-        <footnote_reference auto="1" ids="id6">
+        <footnote_reference auto="1" ids="footnote-reference-6">
          is one too many,
-        <footnote_reference auto="1" ids="id7" refname="five">
+        <footnote_reference auto="1" ids="footnote-reference-7" refname="five">
          should be 5, and \n\
-        <footnote_reference auto="1" ids="id8" refname="six">
+        <footnote_reference auto="1" ids="footnote-reference-8" refname="six">
          doesn't exist.
-    <footnote ids="id9" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             Manually-numbered footnote 1.
-    <footnote auto="1" ids="id10">
+    <footnote auto="1" ids="footnote-2">
         <paragraph>
             Auto-numbered footnote 2.
     <footnote auto="1" ids="four" names="four">
         <paragraph>
             Auto-numbered footnote 4.
-    <footnote ids="id11" names="3">
+    <footnote ids="footnote-3" names="3">
         <label>
             3
         <paragraph>
@@ -304,13 +321,13 @@
     <footnote auto="1" dupnames="five" ids="five">
         <paragraph>
             Auto-numbered footnote 5.
-    <footnote auto="1" dupnames="five" ids="id12">
-        <system_message backrefs="id12" level="2" line="14" source="test data" type="WARNING">
+    <footnote auto="1" dupnames="five" ids="five-1">
+        <system_message backrefs="five-1" level="2" line="14" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "five".
         <paragraph>
             Auto-numbered footnote 5 again (duplicate).
-    <footnote auto="1" ids="id13">
+    <footnote auto="1" ids="footnote-4">
         <paragraph>
             Auto-numbered footnote 6.
 """,
@@ -322,7 +339,7 @@
 """,
 """\
 <document source="test data">
-    <footnote auto="*" ids="id1">
+    <footnote auto="*" ids="footnote-1">
         <paragraph>
             This is an auto-symbol footnote.
 """,
@@ -330,5 +347,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_inline_markup.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_inline_markup.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_inline_markup.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_inline_markup.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,17 +7,34 @@
 Tests for inline markup in docutils/parsers/rst/states.py.
 Interpreted text tests are in a separate module, test_interpreted.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -33,11 +48,11 @@
         <emphasis>
             emphasis
 """,
-u"""\
+"""\
 l'*emphasis* with the *emphasis*' apostrophe.
 l\u2019*emphasis* with the *emphasis*\u2019 apostrophe.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l\'
@@ -72,10 +87,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             *
         emphasis without closing asterisk
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
@@ -146,10 +161,10 @@
          (escaped, whitespace before end-string).
     <paragraph>
         However, '
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             *
         args' will trigger a warning and may be problematic.
-    <system_message backrefs="id2" ids="id1" level="2" line="13" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="13" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
     <paragraph>
@@ -158,7 +173,7 @@
             this*
         ?
 """,
-u"""\
+"""\
 Quotes around inline markup:
 
 '*emphasis*' "*emphasis*" Straight,
@@ -173,7 +188,7 @@
 „*emphasis*” ‚*emphasis*’ Polish,
 „*emphasis*” »*emphasis*« ’*emphasis*’ Hungarian,
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Quotes around inline markup:
@@ -305,10 +320,10 @@
         <strong>
             strong
 """,
-u"""\
+"""\
 l'**strong** and l\u2019**strong** with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -319,12 +334,12 @@
             strong
          with apostrophe
 """,
-u"""\
+"""\
 quoted '**strong**', quoted "**strong**",
 quoted \u2018**strong**\u2019, quoted \u201c**strong**\u201d,
 quoted \xab**strong**\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -360,10 +375,10 @@
         ) but not (**) or '(** ' or x**2 or **kwargs or **
     <paragraph>
         (however, '
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             **
         kwargs' will trigger a warning and may be problematic)
-    <system_message backrefs="id2" ids="id1" level="2" line="4" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="4" source="test data" type="WARNING">
         <paragraph>
             Inline strong start-string without end-string.
 """,
@@ -389,10 +404,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             **
         strong without closing asterisks
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline strong start-string without end-string.
 """,
@@ -435,10 +450,10 @@
         <literal>
             literal\\
 """,
-u"""\
+"""\
 l'``literal`` and l\u2019``literal`` with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -449,12 +464,12 @@
             literal
          with apostrophe
 """,
-u"""\
+"""\
 quoted '``literal``', quoted "``literal``",
 quoted \u2018``literal``\u2019, quoted \u201c``literal``\u201d,
 quoted \xab``literal``\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -476,12 +491,12 @@
             literal
         \xbb
 """,
-u"""\
+"""\
 ``'literal'`` with quotes, ``"literal"`` with quotes,
 ``\u2018literal\u2019`` with quotes, ``\u201cliteral\u201d`` with quotes,
 ``\xabliteral\xbb`` with quotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         <literal>
@@ -514,11 +529,11 @@
          but not "``" or ``
     <paragraph>
         (however, \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             ``
         standalone TeX quotes'' will trigger a warning
         and may be problematic)
-    <system_message backrefs="id2" ids="id1" level="2" line="4" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="4" source="test data" type="WARNING">
         <paragraph>
             Inline literal start-string without end-string.
 """,
@@ -539,10 +554,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             ``
         literal without closing backquotes
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline literal start-string without end-string.
 """,
@@ -599,10 +614,10 @@
         <reference name="ref" refname="ref">
             ref
 """,
-u"""\
+"""\
 l'ref_ and l\u2019ref_ with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -613,14 +628,14 @@
             ref
          with apostrophe
 """,
-u"""\
+"""\
 quoted 'ref_', quoted "ref_",
 quoted \u2018ref_\u2019, quoted \u201cref_\u201d,
 quoted \xabref_\xbb,
 but not 'ref ref'_, "ref ref"_, \u2018ref ref\u2019_,
 \u201cref ref\u201d_, or \xabref ref\xbb_
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -653,10 +668,10 @@
         <reference anonymous="1" name="ref">
             ref
 """,
-u"""\
+"""\
 l'ref__ and l\u2019ref__ with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -667,14 +682,14 @@
             ref
          with apostrophe
 """,
-u"""\
+"""\
 quoted 'ref__', quoted "ref__",
 quoted \u2018ref__\u2019, quoted \u201cref__\u201d,
 quoted \xabref__\xbb,
 but not 'ref ref'__, "ref ref"__, \u2018ref ref\u2019__,
 \u201cref ref\u201d__, or \xabref ref\xbb__
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -734,10 +749,10 @@
         <reference name="phrase reference" refname="phrase reference">
             phrase reference
 """,
-u"""\
+"""\
 l'`phrase reference`_ and l\u2019`phrase reference`_ with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -748,13 +763,13 @@
             phrase reference
          with apostrophe
 """,
-u"""\
+"""\
 quoted '`phrase reference`_', quoted "`phrase reference`_",
 quoted \u2018`phrase reference`_\u2019,
 quoted \u201c`phrase reference`_\u201d,
 quoted \xab`phrase reference`_\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -777,13 +792,13 @@
             phrase reference
         \xbb
 """,
-u"""\
+"""\
 `'phrase reference'`_ with quotes, `"phrase reference"`_ with quotes,
 `\u2018phrase reference\u2019`_ with quotes,
 `\u201cphrase reference\u201d`_ with quotes,
 `\xabphrase reference\xbb`_ with quotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         <reference name="'phrase reference'" refname="'phrase reference'">
@@ -811,10 +826,10 @@
         <reference anonymous="1" name="anonymous reference">
             anonymous reference
 """,
-u"""\
+"""\
 l'`anonymous reference`__ and l\u2019`anonymous reference`__ with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -825,13 +840,13 @@
             anonymous reference
          with apostrophe
 """,
-u"""\
+"""\
 quoted '`anonymous reference`__', quoted "`anonymous reference`__",
 quoted \u2018`anonymous reference`__\u2019,
 quoted \u201c`anonymous reference`__\u201d,
 quoted \xab`anonymous reference`__\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -854,13 +869,13 @@
             anonymous reference
         \xbb
 """,
-u"""\
+"""\
 `'anonymous reference'`__ with quotes, `"anonymous reference"`__ with quotes,
 `\u2018anonymous reference\u2019`__ with quotes,
 `\u201canonymous reference\u201d`__ with quotes,
 `\xabanonymous reference\xbb`__ with quotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         <reference anonymous="1" name="'anonymous reference'">
@@ -909,9 +924,9 @@
     <paragraph>
         Invalid phrase reference:
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :role:`phrase reference`_
-    <system_message backrefs="id2" ids="id1" level="2" line="3" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="3" source="test data" type="WARNING">
         <paragraph>
             Mismatch: both interpreted text role prefix and reference suffix.
 """,
@@ -925,9 +940,9 @@
     <paragraph>
         Invalid phrase reference:
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `phrase reference`:role:_
-    <system_message backrefs="id2" ids="id1" level="2" line="3" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="3" source="test data" type="WARNING">
         <paragraph>
             Mismatch: both interpreted text role suffix and reference suffix.
 """,
@@ -937,13 +952,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `
         phrase \n\
         <reference name="reference" refname="reference">
             reference
          without closing backquote
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline interpreted text or phrase reference start-string without end-string.
 """,
@@ -953,19 +968,19 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `
         anonymous phrase \n\
         <reference anonymous="1" name="reference">
             reference
          without closing backquote
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline interpreted text or phrase reference start-string without end-string.
 """,
 
 
-totest'embedded_URIs' = 
+totest'embedded_uris' = 
 """\
 `phrase reference <http://example.com>`_
 """,
@@ -1180,7 +1195,7 @@
             embedded alias across lines
 """,
 """\
-`embedded alias with whitespace <alias 
+`embedded alias with whitespace <alias
 long  phrase_>`__
 """,
 """\
@@ -1260,10 +1275,10 @@
             Here is  a    TaRgeT
          with case and spacial difficulties.
 """,
-u"""\
+"""\
 l'_`target1` and l\u2019_`target2` with apostrophe
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         l'
@@ -1274,12 +1289,12 @@
             target2
          with apostrophe
 """,
-u"""\
+"""\
 quoted '_`target1`', quoted "_`target2`",
 quoted \u2018_`target3`\u2019, quoted \u201c_`target4`\u201d,
 quoted \xab_`target5`\xbb
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         quoted '
@@ -1301,12 +1316,12 @@
             target5
         \xbb
 """,
-u"""\
+"""\
 _`'target1'` with quotes, _`"target2"` with quotes,
 _`\u2018target3\u2019` with quotes, _`\u201ctarget4\u201d` with quotes,
 _`\xabtarget5\xbb` with quotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         <target ids="target1" names="'target1'">
@@ -1336,10 +1351,10 @@
         But this isn't a _target; targets require backquotes.
     <paragraph>
         And \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             _`
         this`_ is just plain confusing.
-    <system_message backrefs="id2" ids="id1" level="2" line="3" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="3" source="test data" type="WARNING">
         <paragraph>
             Inline target start-string without end-string.
 """,
@@ -1349,10 +1364,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             _`
         inline target without closing backquote
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline target start-string without end-string.
 """,
@@ -1365,7 +1380,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference ids="id1" refname="1">
+        <footnote_reference ids="footnote-reference-1" refname="1">
             1
 """,
 """\
@@ -1374,7 +1389,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1">
+        <footnote_reference auto="1" ids="footnote-reference-1">
 """,
 """\
 #label_
@@ -1382,7 +1397,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refname="label">
+        <footnote_reference auto="1" ids="footnote-reference-1" refname="label">
 """,
 """\
 *_
@@ -1390,7 +1405,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="*" ids="id1">
+        <footnote_reference auto="*" ids="footnote-reference-1">
 """,
 """\
 Adjacent footnote refs are not possible: *_#label_ #_2_ 1_*_
@@ -1409,7 +1424,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <citation_reference ids="id1" refname="citation">
+        <citation_reference ids="citation-reference-1" refname="citation">
             citation
 """,
 """\
@@ -1418,16 +1433,16 @@
 """\
 <document source="test data">
     <paragraph>
-        <citation_reference ids="id1" refname="citation">
+        <citation_reference ids="citation-reference-1" refname="citation">
             citation
          and \n\
-        <citation_reference ids="id2" refname="cit-ation">
+        <citation_reference ids="citation-reference-2" refname="cit-ation">
             cit-ation
          and \n\
-        <citation_reference ids="id3" refname="cit.ation">
+        <citation_reference ids="citation-reference-3" refname="cit.ation">
             cit.ation
          and \n\
-        <citation_reference ids="id4" refname="cit1">
+        <citation_reference ids="citation-reference-4" refname="cit1">
             CIT1
          but not CIT 1_
 """,
@@ -1491,10 +1506,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |
         substitution reference without closing verbar
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline substitution_reference start-string without end-string.
 """,
@@ -1506,6 +1521,23 @@
     <paragraph>
         first | then || and finally |||
 """,
+"""\
+Substitution reference with |mix|.
+
+.. |mix| replace:: text and hyperlink-reference_
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Substitution reference with \n\
+        <substitution_reference refname="mix">
+            mix
+        .
+    <substitution_definition names="mix">
+        text and \n\
+        <reference name="hyperlink-reference" refname="hyperlink-reference">
+            hyperlink-reference
+""",
 
 
 totest'standalone_hyperlink' = 
@@ -1656,7 +1688,7 @@
 """,
 
 
-totest'markup recognition rules' = 
+totest'markup_recognition_rules' = 
 """\
 __This__ should be left alone.
 """,
@@ -1685,11 +1717,11 @@
         p
         with backslash-escaped whitespace, including newlines.
 """,
-u"""\
+"""\
 text-*separated*\u2010*by*\u2011*various*\u2012*dashes*\u2013*and*\u2014*hyphens*.
 \u00bf*punctuation*? \u00a1*examples*!\u00a0*no-break-space*\u00a0.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         text-
@@ -1724,7 +1756,7 @@
 """,
 # Whitespace characters:
 #  \u180e*MONGOLIAN VOWEL SEPARATOR*\u180e,   fails in Python 2.6
-u"""\
+"""\
 text separated by
 *newline*
 or *space* or one of
@@ -1746,7 +1778,7 @@
 \u3000*IDEOGRAPHIC SPACE*\u3000,
 \u2028*LINE SEPARATOR*\u2028
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         text separated by
@@ -1825,13 +1857,13 @@
         <emphasis>
             LINE SEPARATOR
 """,
-u"""\
+"""\
 inline markup separated by non-ASCII whitespace
 \xa0**NO-BREAK SPACE**\xa0, \xa0``NO-BREAK SPACE``\xa0, \xa0`NO-BREAK SPACE`\xa0,
 \u2000**EN QUAD**\u2000, \u2000``EN QUAD``\u2000, \u2000`EN QUAD`\u2000,
 \u202f**NARROW NBSP**\u202f, \u202f``NARROW NBSP``\u202f, \u202f`NARROW NBSP`\u202f,
-""",                                      
-u"""\
+""",
+"""\
 <document source="test data">
     <paragraph>
         inline markup separated by non-ASCII whitespace
@@ -1866,7 +1898,7 @@
             NARROW NBSP
         \u202f,
 """,
-u"""\
+"""\
 no inline markup due to whitespace inside and behind: *
 newline
 *
@@ -1889,7 +1921,7 @@
 *\u3000IDEOGRAPHIC SPACE\u3000*
 *\u2028LINE SEPARATOR\u2028*
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         no inline markup due to whitespace inside and behind: *
@@ -1914,23 +1946,24 @@
         *\u3000IDEOGRAPHIC SPACE\u3000*
         *
         LINE SEPARATOR
-        *""",
-u"""\
+        *
+""",
+"""\
 no inline markup because of non-ASCII whitespace following /preceding the markup
 **\xa0NO-BREAK SPACE\xa0** ``\xa0NO-BREAK SPACE\xa0`` `\xa0NO-BREAK SPACE\xa0`
 **\u2000EN QUAD\u2000** ``\u2000EN QUAD\u2000`` `\u2000EN QUAD\u2000`
 **\u202fNARROW NBSP\u202f** ``\u202fNARROW NBSP\u202f`` `\u202fNARROW NBSP\u202f`
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         no inline markup because of non-ASCII whitespace following /preceding the markup
         **\xa0NO-BREAK SPACE\xa0** ``\xa0NO-BREAK SPACE\xa0`` `\xa0NO-BREAK SPACE\xa0`
         **\u2000EN QUAD\u2000** ``\u2000EN QUAD\u2000`` `\u2000EN QUAD\u2000`
-        **\u202fNARROW NBSP\u202f** ``\u202fNARROW NBSP\u202f`` `\u202fNARROW NBSP\u202f`\
+        **\u202fNARROW NBSP\u202f** ``\u202fNARROW NBSP\u202f`` `\u202fNARROW NBSP\u202f`
 """,
 # « * » ‹ * › « * » ‹ * › « * » ‹ * › French,
-u"""\
+"""\
 "Quoted" markup start-string (matched openers & closers) -> no markup:
 
 '*' "*" (*) <*> * {*}
@@ -1948,7 +1981,7 @@
 
 But this is „*’ emphasized »*‹.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         "Quoted" markup start-string (matched openers & closers) -> no markup:
@@ -1975,5 +2008,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_interpreted.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_interpreted.py Changed

@@ -1,26 +1,44 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_interpreted.py 8495 2020-03-03 20:32:40Z milde $
+# $Id: test_interpreted.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for interpreted text in docutils/parsers/rst/states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
 from docutils.utils.code_analyzer import with_pygments
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    if not with_pygments:
-        del(totest'code-parsing')
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        if not with_pygments:
+            del totest'code_parsing'
+
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -105,10 +123,10 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `
         interpreted without closing backquote
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline interpreted text or phrase reference start-string without end-string.
 """,
@@ -164,10 +182,10 @@
 <document source="test data">
     <paragraph>
         :title:
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `
          ` (trailing unquoted space)
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline interpreted text or phrase reference start-string without end-string.
 """,
@@ -236,7 +254,7 @@
 """,
 
 
-totest'code-parsing' = 
+totest'code_parsing' = 
 """\
 .. role:: tex(code)
    :language: latex
@@ -302,7 +320,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <reference refuri="http://www.python.org/dev/peps/pep-0000">
+        <reference refuri="https://peps.python.org/pep-0000">
             PEP 0
 """,
 """\
@@ -311,9 +329,9 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :PEP:`-1`
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             PEP number must be a number from 0 to 9999; "-1" is invalid.
 """,
@@ -323,7 +341,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <reference refuri="http://tools.ietf.org/html/rfc2822.html">
+        <reference refuri="https://tools.ietf.org/html/rfc2822.html">
             RFC 2822
 """,
 """\
@@ -332,9 +350,9 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :RFC:`0`
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             RFC number must be a number greater than or equal to 1; "0" is invalid.
 """,
@@ -344,7 +362,7 @@
 """\
 <document source="test data">
     <paragraph>
-        <reference refuri="http://tools.ietf.org/html/rfc2822.html#section1">
+        <reference refuri="https://tools.ietf.org/html/rfc2822.html#section1">
             RFC 2822
 """,
 
@@ -356,13 +374,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :role:`interpreted`
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
             No role entry for "role" in module "docutils.parsers.rst.languages.en".
             Trying "role" as canonical role name.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown interpreted text role "role".
 """,
@@ -372,13 +390,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             `interpreted`:role:
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
             No role entry for "role" in module "docutils.parsers.rst.languages.en".
             Trying "role" as canonical role name.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown interpreted text role "role".
 """,
@@ -388,9 +406,9 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :role:`interpreted`:role:
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Multiple roles in interpreted text (both prefix and suffix present; only one allowed).
 """,
@@ -400,13 +418,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :very.long-role_name:`interpreted`
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
             No role entry for "very.long-role_name" in module "docutils.parsers.rst.languages.en".
             Trying "very.long-role_name" as canonical role name.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown interpreted text role "very.long-role_name".
 """,
@@ -416,13 +434,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             :restructuredtext-unimplemented-role:`interpreted`
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
             No role entry for "restructuredtext-unimplemented-role" in module "docutils.parsers.rst.languages.en".
             Trying "restructuredtext-unimplemented-role" as canonical role name.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Interpreted text role "restructuredtext-unimplemented-role" not implemented.
 """,
@@ -430,5 +448,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_interpreted_fr.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_interpreted_fr.py Changed

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
 # $Id: test_interpreted.py 6424 2010-09-18 10:43:52Z smerten $
 # Author: David Goodger <goodger@python.org>
@@ -8,17 +8,40 @@
 Tests for interpreted text in docutils/parsers/rst/states.py.
 Test not default/fallback language french.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser, roles
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.language_code = 'fr'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                # Language-specific roles and roles added by the
+                # "default-role" and "role" directives are currently stored
+                # globally in the roles._roles dictionary.  This workaround
+                # empties that dictionary.
+                roles._roles = {}
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite(suite_settings={'language_code':'fr'})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -54,5 +77,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_line_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_line_blocks.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_line_blocks.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_line_blocks.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -248,16 +265,16 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |
         This is not
-        <problematic ids="id4" refid="id3">
+        <problematic ids="problematic-2" refid="system-message-2">
             |
         a line block
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline substitution_reference start-string without end-string.
-    <system_message backrefs="id4" ids="id3" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-2" ids="system-message-2" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline substitution_reference start-string without end-string.
     <line_block>
@@ -267,10 +284,10 @@
         <paragraph>
             Line block ends without a blank line.
     <paragraph>
-        <problematic ids="id6" refid="id5">
+        <problematic ids="problematic-3" refid="system-message-3">
             |
         incomplete line block.
-    <system_message backrefs="id6" ids="id5" level="2" line="5" source="test data" type="WARNING">
+    <system_message backrefs="problematic-3" ids="system-message-3" level="2" line="5" source="test data" type="WARNING">
         <paragraph>
             Inline substitution_reference start-string without end-string.
 """,
@@ -283,12 +300,12 @@
     <line_block>
         <line>
             Inline markup \n\
-            <problematic ids="id2" refid="id1">
+            <problematic ids="problematic-1" refid="system-message-1">
                 *
             may not
         <line>
             wrap* over several lines.
-    <system_message backrefs="id2" ids="id1" level="2" line="1" source="test data" type="WARNING">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="2" line="1" source="test data" type="WARNING">
         <paragraph>
             Inline emphasis start-string without end-string.
 """,
@@ -319,17 +336,16 @@
             <reference name="uff" refuri="test1">
                 uff
             <target dupnames="uff" ids="uff" refuri="test1">
-        <system_message backrefs="id1" level="2" line="3" source="test data" type="WARNING">
+        <system_message backrefs="uff-1" level="2" line="3" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "uff".
         <line>
             <reference name="uff" refuri="test2">
                 uff
-            <target dupnames="uff" ids="id1" refuri="test2">
+            <target dupnames="uff" ids="uff-1" refuri="test2">
 """,
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_line_length_limit.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_line_length_limit.py Changed

@@ -1,5 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf8 -*-
+#!/usr/bin/env python3
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,18 +13,41 @@
 Tests for inline markup in docutils/parsers/rst/states.py.
 Interpreted text tests are in a separate module, test_interpreted.py.
 """
-from __future__ import absolute_import
+
+import os.path
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..'))
+docutils_conf = os.path.relpath(
+    os.path.join(TEST_ROOT, 'docutils.conf'), os.getcwd()).replace('\\', '/')
 
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite(
-            suite_settings={'line_length_limit': 80})
-    s.generateTests(totest)
-    return s
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.line_length_limit = 80
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -50,25 +72,25 @@
         <paragraph>
             Line 2 exceeds the line-length-limit.
 """,
-"""\
+f"""\
 Include Test
 ============
 
-.. include:: docutils.conf
+.. include:: {docutils_conf}
    :literal:
 
 A paragraph.
 """,
-"""\
+f"""\
 <document source="test data">
     <section ids="include-test" names="include\\ test">
         <title>
             Include Test
         <system_message level="2" line="4" source="test data" type="WARNING">
             <paragraph>
-                "docutils.conf": line 5 exceeds the line-length-limit.
+                "{docutils_conf}": line 5 exceeds the line-length-limit.
             <literal_block xml:space="preserve">
-                .. include:: docutils.conf
+                .. include:: {docutils_conf}
                    :literal:
         <paragraph>
             A paragraph.
@@ -77,5 +99,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_line_length_limit_default.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_line_length_limit_default.py Changed

@@ -1,5 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf8 -*-
+#!/usr/bin/env python3
 # :Copyright: © 2020 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -14,17 +13,34 @@
 Tests for inline markup in docutils/parsers/rst/states.py.
 Interpreted text tests are in a separate module, test_interpreted.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -53,5 +69,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_literal_blocks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_literal_blocks.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_literal_blocks.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_literal_blocks.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -369,5 +386,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_option_lists.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_option_lists.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_option_lists.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_option_lists.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -771,5 +788,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_outdenting.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_outdenting.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_outdenting.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_outdenting.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -88,5 +105,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_paragraphs.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_paragraphs.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_paragraphs.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_paragraphs.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -87,5 +104,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_section_headers.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_section_headers.py Changed

@@ -1,24 +1,40 @@
-# -*- coding: utf-8 -*-
-#! /usr/bin/env python
-
-# $Id: test_section_headers.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_section_headers.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+from pathlib import Path
+import sys
+import unittest
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -127,13 +143,13 @@
         <paragraph>
             Test short underline.
 """,
-u"""\
+"""\
 à with combining varia
 ======================
 
 Do not count combining chars in title column width.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="a-with-combining-varia" names="a\u0300\\ with\\ combining\\ varia">
         <title>
@@ -807,17 +823,17 @@
         <paragraph>
             Possible incomplete section title.
             Treating the overline as ordinary text because it's so short.
-    <section dupnames="..." ids="id1">
+    <section dupnames="..." ids="section-1">
         <title>
             ...
         <system_message level="1" line="4" source="test data" type="INFO">
             <paragraph>
                 Possible incomplete section title.
                 Treating the overline as ordinary text because it's so short.
-        <section dupnames="..." ids="id2">
+        <section dupnames="..." ids="section-2">
             <title>
                 ...
-            <system_message backrefs="id2" level="1" line="5" source="test data" type="INFO">
+            <system_message backrefs="section-2" level="1" line="5" source="test data" type="INFO">
                 <paragraph>
                     Duplicate implicit target name: "...".
             <system_message level="1" line="7" source="test data" type="INFO">
@@ -828,10 +844,10 @@
         <paragraph>
             Possible incomplete section title.
             Treating the overline as ordinary text because it's so short.
-    <section dupnames="..." ids="id3">
+    <section dupnames="..." ids="section-3">
         <title>
             ...
-        <system_message backrefs="id3" level="1" line="8" source="test data" type="INFO">
+        <system_message backrefs="section-3" level="1" line="8" source="test data" type="INFO">
             <paragraph>
                 Duplicate implicit target name: "...".
         <paragraph>
@@ -912,5 +928,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_source_line.py Added

@@ -0,0 +1,237 @@
+#! /usr/bin/env python3
+# $Id: test_source_line.py 9277 2022-11-26 23:15:13Z milde $
+# Author: Günter Milde
+# Maintainer: docutils-develop@lists.sourceforge.net
+# :Copyright: 2021 Günter Milde,
+# :License: Released under the terms of the `2-Clause BSD license`_, in short:
+#
+#    Copying and distribution of this file, with or without modification,
+#    are permitted in any medium without royalty provided the copyright
+#    notice and this notice are preserved.
+#    This file is offered as-is, without any warranty.
+#
+# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+
+"""Test internal source and line attributes (for correct error reporting).
+
+This test is to ensure source and line numbers are correct.
+It does not fix behaviour regarding which nodes have source/line attributes,
+adding them to more nodes is regarded a compatible feature extension.
+"""
+
+# Requires the `universal.ExposeInternals` transform (tested in
+# ``test_transforms/test_expose_internals.py``)
+# to make internal attributes visible.
+
+import os
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.universal import ExposeInternals, TestMessages
+from docutils.utils import new_document
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..'))
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.expose_internals = 'line', 'source'
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+mydir = os.path.join(TEST_ROOT, 'test_parsers/test_rst')
+include14 = os.path.relpath(
+    os.path.join(mydir, 'includes/include14.txt'),
+    os.getcwd()).replace('\\', '/')
+totest = {}
+
+totest'transitions' = ((ExposeInternals,), 
+"""\
+Paragraph starting in line 1.
+With *inline* element in line 2.
+
+  Block quote in line 4
+
+  -- attribution
+     in line 6
+
+* bullet list in line 9
+* second item in line 10
+
+1. enumerated list in line 12
+""",
+"""\
+<document source="test data">
+    <paragraph internal:line="1" internal:source="test data">
+        Paragraph starting in line 1.
+        With \n\
+        <emphasis>
+            inline
+         element in line 2.
+    <block_quote internal:line="4" internal:source="test data">
+        <paragraph internal:line="4" internal:source="test data">
+            Block quote in line 4
+        <attribution internal:line="6" internal:source="test data">
+            attribution
+            in line 6
+    <bullet_list bullet="*" internal:line="9" internal:source="test data">
+        <list_item internal:source="test data">
+            <paragraph internal:line="9" internal:source="test data">
+                bullet list in line 9
+        <list_item internal:source="test data">
+            <paragraph internal:line="10" internal:source="test data">
+                second item in line 10
+    <enumerated_list enumtype="arabic" internal:line="12" internal:source="test data" prefix="" suffix=".">
+        <list_item internal:source="test data">
+            <paragraph internal:line="12" internal:source="test data">
+                enumerated list in line 12
+""",
+"""\
+Paragraph
+
+  Block quote in line 3
+
+  -- attribution in line 5
+""",
+"""\
+<document source="test data">
+    <paragraph internal:line="1" internal:source="test data">
+        Paragraph
+    <block_quote internal:line="3" internal:source="test data">
+        <paragraph internal:line="3" internal:source="test data">
+            Block quote in line 3
+        <attribution internal:line="5" internal:source="test data">
+            attribution in line 5
+""",
+"""\
+Paragraph
+
+  Block quote in line 3
+
+     nested block quote
+     in line 5
+
+       double nested quote in line 8
+
+       -- double-nested attribution in line 10
+
+     line 12
+
+     -- nested attribution in line 14
+
+  -- attribution in line 16
+""",
+"""\
+<document source="test data">
+    <paragraph internal:line="1" internal:source="test data">
+        Paragraph
+    <block_quote internal:line="3" internal:source="test data">
+        <paragraph internal:line="3" internal:source="test data">
+            Block quote in line 3
+        <block_quote internal:line="5" internal:source="test data">
+            <paragraph internal:line="5" internal:source="test data">
+                nested block quote
+                in line 5
+            <block_quote internal:line="8" internal:source="test data">
+                <paragraph internal:line="8" internal:source="test data">
+                    double nested quote in line 8
+                <attribution internal:line="10" internal:source="test data">
+                    double-nested attribution in line 10
+            <paragraph internal:line="12" internal:source="test data">
+                line 12
+            <attribution internal:line="14" internal:source="test data">
+                nested attribution in line 14
+        <attribution internal:line="16" internal:source="test data">
+            attribution in line 16
+""",
+"""\
+Paragraph
+
+.. include:: %s
+""" % include14,
+f"""\
+<document source="test data">
+    <paragraph internal:line="1" internal:source="test data">
+        Paragraph
+    <paragraph internal:line="1" internal:source="{include14}">
+        Paragraph starting in line 1.
+        With \n\
+        <emphasis>
+            inline
+         element in line 2.
+    <block_quote internal:line="4" internal:source="{include14}">
+        <paragraph internal:line="4" internal:source="{include14}">
+            Block quote in line 4
+        <attribution internal:line="6" internal:source="{include14}">
+            attribution
+            in line 6
+    <bullet_list bullet="*" internal:line="9" internal:source="{include14}">
+        <list_item internal:source="{include14}">
+            <paragraph internal:line="9" internal:source="{include14}">
+                bullet list in line 9
+        <list_item internal:source="{include14}">
+            <paragraph internal:line="10" internal:source="{include14}">
+                second item in line 10
+    <enumerated_list enumtype="arabic" internal:line="12" internal:source="{include14}" prefix="" suffix=".">
+        <list_item internal:source="{include14}">
+            <paragraph internal:line="12" internal:source="{include14}">
+                enumerated list in line 12
+""",
+"""\
+Paragraph
+
+  Block quote in line 3
+
+  -- attribution in line 5
+
+  Second block quote in line 7
+
+  -- attribution in line 9
+
+Final paragraph in line 11
+""",
+"""\
+<document source="test data">
+    <paragraph internal:line="1" internal:source="test data">
+        Paragraph
+    <block_quote internal:line="3" internal:source="test data">
+        <paragraph internal:line="3" internal:source="test data">
+            Block quote in line 3
+        <attribution internal:line="5" internal:source="test data">
+            attribution in line 5
+    <block_quote internal:line="7" internal:source="test data">
+        <paragraph internal:line="7" internal:source="test data">
+            Second block quote in line 7
+        <attribution internal:line="9" internal:source="test data">
+            attribution in line 9
+    <paragraph internal:line="11" internal:source="test data">
+        Final paragraph in line 11
+""",
+)
+
+
+if __name__ == '__main__':
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_substitutions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_substitutions.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_substitutions.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_substitutions.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -136,13 +153,13 @@
         <paragraph>
             Followed by a block quote.
 """,
-u"""\
+"""\
 Substitutions support case differences:
 
 .. |eacute| replace:: \u00E9
 .. |Eacute| replace:: \u00C9
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Substitutions support case differences:
@@ -288,7 +305,7 @@
         <paragraph>
             Substitution definition contains illegal element <footnote_reference>:
         <literal_block xml:space="preserve">
-            <footnote_reference auto="1" ids="id1">
+            <footnote_reference auto="1" ids="footnote-reference-1">
         <literal_block xml:space="preserve">
             .. |auto-numbered footnote| replace:: #_
 """,
@@ -296,5 +313,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_tables.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_tables.py Changed

@@ -1,27 +1,48 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_tables.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_tables.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
 
 import os
 
+from pathlib import Path
+import sys
+import unittest
+
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..'))
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
-mydir = 'test_parsers/test_rst/'
+mydir = os.path.join(TEST_ROOT, 'test_parsers/test_rst')
 include2 = os.path.join(mydir, 'test_directives/include2.txt')
 
 totest = {}
@@ -572,8 +593,8 @@
 | (The first cell of this table may expand                                     |
 | to accommodate long filesystem paths.)                                       |
 +------------------------------------------------------------------------------+
-""") % ('\n'.join('|    %-70s    |' % include2part * 70 : (part + 1) * 70
-                   for part in range(len(include2) // 70 + 1))),
+""") % ('\n'.join('|    %-70s    |' % include2part * 70 : (part + 1) * 70  # noqa: E203
+                  for part in range(len(include2) // 70 + 1))),
 """\
 <document source="test data">
     <table>
@@ -607,8 +628,8 @@
 Something afterwards.
 
 And more.
-""") % ('\n'.join('|    %-70s    |' % include2part * 70 : (part + 1) * 70
-                   for part in range(len(include2) // 70 + 1))),
+""") % ('\n'.join('|    %-70s    |' % include2part * 70 : (part + 1) * 70  # noqa: E203
+                  for part in range(len(include2) // 70 + 1))),
 """\
 <document source="test data">
     <paragraph>
@@ -1275,8 +1296,8 @@
 Note       The first row of this table may expand
            to accommodate long filesystem paths.
 =========  =====================================================================
-""" % ('\n'.join('              %-65s' % include2part * 65 : (part + 1) * 65
-                  for part in range(len(include2) // 65 + 1))),
+""" % ('\n'.join('              %-65s' % include2part * 65 : (part + 1) * 65  # noqa: E203
+                 for part in range(len(include2) // 65 + 1))),
 """\
 <document source="test data">
     <table>
@@ -1310,5 +1331,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_targets.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_targets.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_targets.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_targets.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for states.py.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
 
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -179,10 +196,10 @@
     <paragraph>
         Duplicate external targets (different URIs):
     <target dupnames="target" ids="target" refuri="first">
-    <system_message backrefs="id1" level="2" line="5" source="test data" type="WARNING">
+    <system_message backrefs="target-1" level="2" line="5" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "target".
-    <target dupnames="target" ids="id1" refuri="second">
+    <target dupnames="target" ids="target-1" refuri="second">
 """,
 """\
 Duplicate external targets (same URIs):
@@ -196,10 +213,10 @@
     <paragraph>
         Duplicate external targets (same URIs):
     <target ids="target" names="target" refuri="first">
-    <system_message backrefs="id1" level="1" line="5" source="test data" type="INFO">
+    <system_message backrefs="target-1" level="1" line="5" source="test data" type="INFO">
         <paragraph>
             Duplicate explicit target name: "target".
-    <target dupnames="target" ids="id1" refuri="first">
+    <target dupnames="target" ids="target-1" refuri="first">
 """,
 """\
 Duplicate implicit targets.
@@ -223,10 +240,10 @@
             Title
         <paragraph>
             Paragraph.
-    <section dupnames="title" ids="id1">
+    <section dupnames="title" ids="title-1">
         <title>
             Title
-        <system_message backrefs="id1" level="1" line="9" source="test data" type="INFO">
+        <system_message backrefs="title-1" level="1" line="9" source="test data" type="INFO">
             <paragraph>
                 Duplicate implicit target name: "title".
         <paragraph>
@@ -249,10 +266,10 @@
     <section dupnames="title" ids="title">
         <title>
             Title
-        <system_message backrefs="id1" level="1" line="6" source="test data" type="INFO">
+        <system_message backrefs="title-1" level="1" line="6" source="test data" type="INFO">
             <paragraph>
                 Duplicate implicit target name: "title".
-        <target ids="id1" names="title">
+        <target ids="title-1" names="title">
         <paragraph>
             Paragraph.
 """,
@@ -272,8 +289,8 @@
     <section dupnames="title" ids="title">
         <title>
             Title
-        <pending ids="id1" names="title">
-            <system_message backrefs="id1" level="1" line="4" source="test data" type="INFO">
+        <pending ids="title-1" names="title">
+            <system_message backrefs="title-1" level="1" line="4" source="test data" type="INFO">
                 <paragraph>
                     Duplicate implicit target name: "title".
             .. internal attributes:
@@ -302,16 +319,16 @@
     <target dupnames="title" ids="title">
     <paragraph>
         First.
-    <system_message backrefs="id1" level="2" line="7" source="test data" type="WARNING">
+    <system_message backrefs="title-1" level="2" line="7" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "title".
-    <target dupnames="title" ids="id1">
+    <target dupnames="title" ids="title-1">
     <paragraph>
         Second.
-    <system_message backrefs="id2" level="2" line="11" source="test data" type="WARNING">
+    <system_message backrefs="title-2" level="2" line="11" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "title".
-    <target dupnames="title" ids="id2">
+    <target dupnames="title" ids="title-2">
     <paragraph>
         Third.
 """,
@@ -333,9 +350,9 @@
     <target dupnames="title" ids="title">
     <paragraph>
         First.
-    <rubric dupnames="title" ids="id1">
+    <rubric dupnames="title" ids="title-1">
         this is a title too
-        <system_message backrefs="id1" level="2" line="9" source="test data" type="WARNING">
+        <system_message backrefs="title-1" level="2" line="9" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "title".
 """,
@@ -369,33 +386,33 @@
             Target
         <paragraph>
             Implicit section header target.
-        <citation dupnames="target" ids="id1">
+        <citation dupnames="target" ids="target-1">
             <label>
                 TARGET
-            <system_message backrefs="id1" level="1" line="8" source="test data" type="INFO">
+            <system_message backrefs="target-1" level="1" line="8" source="test data" type="INFO">
                 <paragraph>
                     Duplicate implicit target name: "target".
             <paragraph>
                 Citation target.
-        <footnote auto="1" dupnames="target" ids="id2">
-            <system_message backrefs="id2" level="2" line="10" source="test data" type="WARNING">
+        <footnote auto="1" dupnames="target" ids="target-2">
+            <system_message backrefs="target-2" level="2" line="10" source="test data" type="WARNING">
                 <paragraph>
                     Duplicate explicit target name: "target".
             <paragraph>
                 Autonumber-labeled footnote target.
-        <system_message backrefs="id3" level="2" line="12" source="test data" type="WARNING">
+        <system_message backrefs="target-3" level="2" line="12" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "target".
-        <target dupnames="target" ids="id3">
+        <target dupnames="target" ids="target-3">
         <paragraph>
             Explicit internal target.
-        <system_message backrefs="id4" level="2" line="16" source="test data" type="WARNING">
+        <system_message backrefs="target-4" level="2" line="16" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "target".
-        <target dupnames="target" ids="id4" refuri="Explicit_external_target">
-        <rubric dupnames="target" ids="id5">
+        <target dupnames="target" ids="target-4" refuri="Explicit_external_target">
+        <rubric dupnames="target" ids="target-5">
             directive with target
-            <system_message backrefs="id5" level="2" line="4" source="test data" type="WARNING">
+            <system_message backrefs="target-5" level="2" line="4" source="test data" type="WARNING">
                 <paragraph>
                     Duplicate explicit target name: "target".
 """,
@@ -435,7 +452,7 @@
 <document source="test data">
     <paragraph>
         Anonymous external hyperlink target:
-    <target anonymous="1" ids="id1" refuri="http://w3c.org/">
+    <target anonymous="1" ids="target-1" refuri="http://w3c.org/">
 """,
 """\
 Anonymous external hyperlink target:
@@ -446,7 +463,7 @@
 <document source="test data">
     <paragraph>
         Anonymous external hyperlink target:
-    <target anonymous="1" ids="id1" refuri="http://w3c.org/">
+    <target anonymous="1" ids="target-1" refuri="http://w3c.org/">
 """,
 """\
 Anonymous indirect hyperlink target:
@@ -457,7 +474,7 @@
 <document source="test data">
     <paragraph>
         Anonymous indirect hyperlink target:
-    <target anonymous="1" ids="id1" refname="reference">
+    <target anonymous="1" ids="target-1" refname="reference">
 """,
 """\
 Anonymous external hyperlink target, not indirect:
@@ -470,8 +487,8 @@
 <document source="test data">
     <paragraph>
         Anonymous external hyperlink target, not indirect:
-    <target anonymous="1" ids="id1" refuri="uri_">
-    <target anonymous="1" ids="id2" refuri="thisURIendswithanunderscore_">
+    <target anonymous="1" ids="target-1" refuri="uri_">
+    <target anonymous="1" ids="target-2" refuri="thisURIendswithanunderscore_">
 """,
 """\
 Anonymous indirect hyperlink targets:
@@ -484,8 +501,8 @@
 <document source="test data">
     <paragraph>
         Anonymous indirect hyperlink targets:
-    <target anonymous="1" ids="id1" refname="reference">
-    <target anonymous="1" ids="id2" refname="a very long reference">
+    <target anonymous="1" ids="target-1" refname="reference">
+    <target anonymous="1" ids="target-2" refname="a very long reference">
 """,
 """\
 Mixed anonymous & named indirect hyperlink targets:
@@ -506,9 +523,9 @@
 <document source="test data">
     <paragraph>
         Mixed anonymous & named indirect hyperlink targets:
-    <target anonymous="1" ids="id1" refname="reference">
-    <target anonymous="1" ids="id2" refname="reference">
-    <target anonymous="1" ids="id3" refname="reference">
+    <target anonymous="1" ids="target-1" refname="reference">
+    <target anonymous="1" ids="target-2" refname="reference">
+    <target anonymous="1" ids="target-3" refname="reference">
     <target ids="target1" names="target1" refname="reference">
     <system_message level="2" line="7" source="test data" type="WARNING">
         <paragraph>
@@ -516,9 +533,9 @@
     <paragraph>
         no blank line
     <target ids="target2" names="target2" refname="reference">
-    <target anonymous="1" ids="id4" refname="reference">
-    <target anonymous="1" ids="id5" refname="reference">
-    <target anonymous="1" ids="id6" refname="reference">
+    <target anonymous="1" ids="target-4" refname="reference">
+    <target anonymous="1" ids="target-5" refname="reference">
+    <target anonymous="1" ids="target-6" refname="reference">
     <system_message level="2" line="13" source="test data" type="WARNING">
         <paragraph>
             Explicit markup ends without a blank line; unexpected unindent.
@@ -537,5 +554,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_parsers/test_rst/test_transitions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_parsers/test_rst/test_transitions.py Changed

@@ -1,28 +1,46 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_transitions.py 8585 2020-12-01 11:38:25Z milde $
+# $Id: test_transitions.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for transition markers.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_parsers import DocutilsTestSupport
+from pathlib import Path
+import sys
+import unittest
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.utils import new_document
+
+
+class ParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.halt_level = 5
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.ParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
-# See DocutilsTestSupport.ParserTestSuite.generateTests for a
-# description of the 'totest' data structure.
+# Each dictionary key (test type name) maps to a list of tests. Each
+# test is a list: input, expected output.
 totest'transitions' = 
 """\
 Test transition markers.
@@ -206,7 +224,7 @@
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -316,5 +334,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_pickle.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_pickle.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_publisher.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_publisher.py Changed

@@ -1,25 +1,28 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_publisher.py 8369 2019-08-27 12:10:26Z milde $
+# $Id: test_publisher.py 9369 2023-05-02 23:04:27Z milde $
 # Author: Martin Blais <blais@furius.ca>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test the `Publisher` facade and the ``publish_*`` convenience functions.
 """
-
+import os.path
 import pickle
+from pathlib import Path
 import sys
+import unittest
 
-import DocutilsTestSupport              # must be imported before docutils
-import docutils
-from docutils import core, nodes, io
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
 
-if sys.version_info < (3, 0):
-    u_prefix = 'u'
-else:
-    u_prefix = b''
+import docutils
+from docutils import core, nodes
 
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'data')
 
 test_document = """\
 Test Document
@@ -27,68 +30,131 @@
 
 This is a test document with a broken reference: nonexistent_
 """
-pseudoxml_output = b"""\
+pseudoxml_output = """\
 <document ids="test-document" names="test\\ document" source="<string>" title="Test Document">
     <title>
         Test Document
     <paragraph>
         This is a test document with a broken reference: \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             nonexistent_
     <section classes="system-messages">
         <title>
             Docutils System Messages
-        <system_message backrefs="id2" ids="id1" level="3" line="4" source="<string>" type="ERROR">
+        <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="4" source="<string>" type="ERROR">
             <paragraph>
                 Unknown target name: "nonexistent".
 """
-exposed_pseudoxml_output = (b"""\
-<document ids="test-document" internal:refnames="{"""
-+ u_prefix
-+ b"""\'nonexistent\': <reference: <#text: \'nonexistent\'>>}" names="test\\ document" source="<string>" title="Test Document">
+exposed_pseudoxml_output = """\
+<document ids="test-document" internal:refnames="{'nonexistent': <reference: <#text: 'nonexistent'>>}" names="test\\ document" source="<string>" title="Test Document">
     <title>
         Test Document
     <paragraph>
         This is a test document with a broken reference: \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             nonexistent_
     <section classes="system-messages">
         <title>
             Docutils System Messages
-        <system_message backrefs="id2" ids="id1" level="3" line="4" source="<string>" type="ERROR">
+        <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="4" source="<string>" type="ERROR">
             <paragraph>
                 Unknown target name: "nonexistent".
-""") # % u_prefix # %-expansion not supported in bytes in 3.3 and 3.4
+"""
+
 
+class PublisherTests(unittest.TestCase):
 
-class PublisherTests(DocutilsTestSupport.StandardTestCase):
+    settings = {'_disable_config': True,
+                'datestamp': False}
 
     def test_input_error_handling(self):
         # core.publish_cmdline(argv='nonexisting/path')
         # exits with a short message, if `traceback` is False,
 
         # pass IOErrors to calling application if `traceback` is True
-        try:
+        with self.assertRaises(IOError):
             core.publish_cmdline(argv='nonexisting/path',
-                                       settings_overrides={'traceback': True})
-        except IOError as e:
-            self.assertTrue(isinstance(e, io.InputError))
-
+                                 settings_overrides={'traceback': True})
 
     def test_output_error_handling(self):
         # pass IOErrors to calling application if `traceback` is True
-        try:
-            core.publish_cmdline(argv='data/include.txt', 'nonexisting/path',
-                                       settings_overrides={'traceback': True})
-        except IOError as e:
-            self.assertTrue(isinstance(e, io.OutputError))
-
-
-class PublishDoctreeTestCase(DocutilsTestSupport.StandardTestCase, docutils.SettingsSpec):
+        with self.assertRaises(docutils.io.OutputError):
+            core.publish_cmdline(argv=os.path.join(DATA_ROOT, 'include.txt'),
+                                       'nonexisting/path',
+                                 settings_overrides={'traceback': True})
+
+    def test_set_destination(self):
+        # Exit if `_destination` and `output` settings conflict.
+        publisher = core.Publisher()
+        publisher.get_settings(output='out_name', _destination='out_name')
+        # no conflict if both have same value:
+        publisher.set_destination()
+        # no conflict if both are overridden:
+        publisher.set_destination(destination_path='winning_dest')
+        # ... also sets _destination to 'winning_dest' -> conflict
+        with self.assertRaises(SystemExit):
+            publisher.set_destination()
+
+    def test_destination_output_conflict(self):
+        # Exit if positional argument and --output option conflict.
+        settings = {'output': 'out_name'}
+        with self.assertRaises(SystemExit):
+            core.publish_cmdline(argv='-', 'dest_name',
+                                 settings_overrides=settings)
+
+    def test_publish_string_input_encoding(self):
+        """Test handling of encoded input."""
+        # Transparently decode `bytes` source (with "input_encoding" setting)
+        # default: auto-detect, fallback utf-8
+        # Output is encoded according to "output_encoding" setting.
+        settings = dict(self.settings)
+        source = 'test → me'
+        expected = ('<document source="<string>">\n'
+                    '    <paragraph>\n'
+                    '        test → me\n').encode('utf-8')
+        output = core.publish_string(source.encode('utf-16'),
+                                     settings_overrides=settings)
+        self.assertEqual(output, expected)
+
+        # encoding declaration in source
+        source = '.. encoding: latin1\n\nGrüße'
+        # don't encode output (return `str`)
+        settings'output_encoding' = 'unicode'
+        output = core.publish_string(source.encode('utf-16'),
+                                     settings_overrides=settings)
+        self.assertTrue(output.endswith('Grüße\n'))
+
+    def test_publish_string_output_encoding(self):
+        settings = dict(self.settings)
+        settings'output_encoding' = 'latin1'
+        settings'output_encoding_error_handler' = 'replace'
+        source = 'Grüß → dich'
+        expected = ('<document source="<string>">\n'
+                    '    <paragraph>\n'
+                    '        Grüß → dich\n')
+        # encode output, return `bytes`
+        output = bytes(core.publish_string(source,
+                                           settings_overrides=settings))
+        self.assertEqual(output, expected.encode('latin1', 'replace'))
+
+    def test_publish_string_output_encoding_odt(self):
+        """The ODT writer generates a zip archive, not a `str`.
+
+        TODO: return `str` with document as "flat XML" (.fodt).
+        """
+        settings = dict(self.settings)
+        settings'output_encoding' = 'unicode'
+        with self.assertRaises(AssertionError) as cm:
+            core.publish_string('test', writer_name='odt',
+                                settings_overrides=settings)
+        self.assertIn('`data` is no `str` instance', str(cm.exception))
+
+
+class PublishDoctreeTestCase(unittest.TestCase, docutils.SettingsSpec):
 
     settings_default_overrides = {
         '_disable_config': True,
-        'warning_stream': io.NullOutput()}
+        'warning_stream': docutils.io.NullOutput()}
 
     def test_publish_doctree(self):
         # Test `publish_doctree` and `publish_from_doctree`.
@@ -119,14 +185,15 @@
             settings_spec=self,
             settings_overrides={'expose_internals':
                                 'refnames', 'do_not_expose',
-                                'report_level': 1})
+                                'report_level': 1,
+                                'output_encoding': 'unicode'})
         self.assertEqual(output, exposed_pseudoxml_output)
 
         # Test publishing parts using document as the source.
         parts = core.publish_parts(
-           reader_name='doctree', source_class=io.DocTreeInput,
-           source=doctree, source_path='test', writer_name='html',
-           settings_spec=self)
+            reader_name='doctree', source_class=docutils.io.DocTreeInput,
+            source=doctree, source_path='test', writer_name='html',
+            settings_spec=self)
         self.assertTrue(isinstance(parts, dict))
 
     def test_publish_pickle(self):
@@ -161,12 +228,11 @@
         self.assertTrue(isinstance(doctree_zombie, nodes.document))
 
         # Write out the document:
-        output = core.publish_from_doctree(
-            doctree_zombie, writer_name='pseudoxml',
-            settings_spec=self)
-        self.assertEqual(output, pseudoxml_output)
+        output = core.publish_from_doctree(doctree_zombie,
+                                           writer_name='pseudoxml',
+                                           settings_spec=self)
+        self.assertEqual(output.decode(), pseudoxml_output)
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_readers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_readers/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_readers/test_get_reader_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_readers/test_get_reader_class.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_get_reader_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_get_reader_class.py 9277 2022-11-26 23:15:13Z milde $
 # Author: grubert abadger1999
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -8,28 +8,37 @@
 """
 test get_reader_class
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_readers import DocutilsTestSupport
-from docutils.readers import get_reader_class
+from pathlib import Path
+import sys
+import unittest
+
+# Prepend the "docutils root" to the Python library path
+# so we import the local `docutils` and `test` packages.
+# ensure `test` package can be loaded also if not running as __main__
+# (required by ``python -m unittest``
+DOCUTILS_ROOT = Path(__file__).resolve().parents2
+if str(DOCUTILS_ROOT) not in sys.path:
+    sys.path.insert(0, str(DOCUTILS_ROOT))
+
+from docutils.readers import get_reader_class  # noqa: E402
 
 
-class GetReaderClassTestCase(DocutilsTestSupport.StandardTestCase):
+class GetReaderClassTestCase(unittest.TestCase):
 
     def test_registered_reader(self):
-        rdr = get_reader_class('pep')
+        get_reader_class('pep')
         # raises ImportError on failure
 
     def test_bogus_reader(self):
-        self.assertRaises(ImportError,
-                          get_reader_class, 'nope')
+        with self.assertRaises(ImportError):
+            get_reader_class('nope')
 
     def test_local_reader(self):
-        # requires local-reader.py in test directory (testroot)
-        wr = get_reader_class('local-reader')
+        # requires local-reader.py in `test` package
+        get_reader_class('test.local-reader')
+        # raises ImportError on failure
+
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_readers/test_pep/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_readers/test_pep/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_readers/test_pep/test_inline_markup.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_readers/test_pep/test_inline_markup.py Changed

@@ -1,23 +1,40 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_inline_markup.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_inline_markup.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for inline markup in PEPs (readers/pep.py).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_readers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.parsers.rst.states import Inliner
+from docutils.readers.pep import Reader
+from docutils.utils import new_document
 
 
-def suite():
-    s = DocutilsTestSupport.PEPParserTestSuite()
-    s.generateTests(totest)
-    return s
+class PEPParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser(rfc2822=True, inliner=Inliner())
+        settings = get_default_settings(Parser, Reader)
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
 
 totest = {}
@@ -31,20 +48,20 @@
 <document source="test data">
     <paragraph>
         See \n\
-        <reference refuri="http://www.python.org/dev/peps/pep-0287">
+        <reference refuri="https://peps.python.org/pep-0287">
             PEP 287
          (
-        <reference refuri="http://www.python.org/dev/peps/pep-0287">
+        <reference refuri="https://peps.python.org/pep-0287">
             pep-0287.txt
         ),
         and \n\
-        <reference refuri="http://tools.ietf.org/html/rfc2822.html">
+        <reference refuri="https://tools.ietf.org/html/rfc2822.html">
             RFC 2822
          (which obsoletes \n\
-        <reference refuri="http://tools.ietf.org/html/rfc822.html">
+        <reference refuri="https://tools.ietf.org/html/rfc822.html">
             RFC822
          and \n\
-        <reference refuri="http://tools.ietf.org/html/rfc733.html">
+        <reference refuri="https://tools.ietf.org/html/rfc733.html">
             RFC-733
         ).
 """,
@@ -62,31 +79,31 @@
     <paragraph>
         References split across lines:
     <paragraph>
-        <reference refuri="http://www.python.org/dev/peps/pep-0287">
+        <reference refuri="https://peps.python.org/pep-0287">
             PEP
             287
     <paragraph>
-        <reference refuri="http://tools.ietf.org/html/rfc2822.html">
+        <reference refuri="https://tools.ietf.org/html/rfc2822.html">
             RFC
             2822
 """,
 """\
 Test PEP-specific implicit references before a URL:
 
-PEP 287 (http://www.python.org/dev/peps/pep-0287), RFC 2822.
+PEP 287 (https://peps.python.org/pep-0287), RFC 2822.
 """,
 """\
 <document source="test data">
     <paragraph>
         Test PEP-specific implicit references before a URL:
     <paragraph>
-        <reference refuri="http://www.python.org/dev/peps/pep-0287">
+        <reference refuri="https://peps.python.org/pep-0287">
             PEP 287
          (
-        <reference refuri="http://www.python.org/dev/peps/pep-0287">
-            http://www.python.org/dev/peps/pep-0287
+        <reference refuri="https://peps.python.org/pep-0287">
+            https://peps.python.org/pep-0287
         ), \n\
-        <reference refuri="http://tools.ietf.org/html/rfc2822.html">
+        <reference refuri="https://tools.ietf.org/html/rfc2822.html">
             RFC 2822
         .
 """,
@@ -97,7 +114,7 @@
 For *completeness*, _`let's` ``test`` **other** forms_
 |of| `inline markup` *_.
 
-.. * See http://docutils.sf.net/docs/ref/rst/restructuredtext.html.
+.. * See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html.
 """,
 """\
 <document source="test data">
@@ -124,18 +141,17 @@
         <title_reference>
             inline markup
          \n\
-        <footnote_reference auto="*" ids="id1">
+        <footnote_reference auto="*" ids="footnote-reference-1">
         .
-    <footnote auto="*" ids="id2">
+    <footnote auto="*" ids="footnote-1">
         <paragraph>
             See \n\
-            <reference refuri="http://docutils.sf.net/docs/ref/rst/restructuredtext.html">
-                http://docutils.sf.net/docs/ref/rst/restructuredtext.html
+            <reference refuri="https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html">
+                https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
             .
 """,
 
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_readers/test_pep/test_rfc2822.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_readers/test_pep/test_rfc2822.py Changed

@@ -1,23 +1,42 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_rfc2822.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_rfc2822.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for RFC-2822 headers in PEPs (readers/pep.py).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_readers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents3))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.parsers.rst.states import Inliner
+from docutils.readers.pep import Reader
+from docutils.utils import new_document
+
 
+class PEPParserTestCase(unittest.TestCase):
+    def test_parser(self):
+        parser = Parser(rfc2822=True, inliner=Inliner())
+        settings = get_default_settings(Parser, Reader)
+        settings.warning_stream = ''
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.PEPParserTestSuite()
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -289,5 +308,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_settings.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_settings.py Changed

@@ -1,98 +1,133 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_settings.py 8346 2019-08-26 12:11:32Z milde $
+#!/usr/bin/env python3
+# $Id: test_settings.py 9296 2022-12-02 14:08:52Z aa-turner $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests of runtime settings.
 """
-from __future__ import print_function
 
-import sys
 import os
 import difflib
-import pprint
 import warnings
+from pathlib import Path
+import sys
 import unittest
-import DocutilsTestSupport              # must be imported before docutils
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
 from docutils import frontend, utils
-from docutils.writers import html4css1, pep_html
+from docutils.writers import pep_html, html5_polyglot
 from docutils.parsers import rst
 
-
-warnings.filterwarnings(action='ignore',
-                        category=frontend.ConfigDeprecationWarning)
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = os.path.abspath(os.path.join(__file__, '..', 'data'))
 
 
 def fixpath(path):
-    return os.path.abspath(os.path.join(*(path.split('/'))))
+    return os.path.join(DATA_ROOT, path)
 
 
 class ConfigFileTests(unittest.TestCase):
 
-    config_files = {'old': fixpath('data/config_old.txt'),
-                    'one': fixpath('data/config_1.txt'),
-                    'two': fixpath('data/config_2.txt'),
-                    'list': fixpath('data/config_list.txt'),
-                    'list2': fixpath('data/config_list_2.txt'),
-                    'error': fixpath('data/config_error_handler.txt')}
-
+    config_files = {'old': fixpath('config_old.txt'),
+                    'one': fixpath('config_1.txt'),
+                    'two': fixpath('config_2.txt'),
+                    'list': fixpath('config_list.txt'),
+                    'list2': fixpath('config_list_2.txt'),
+                    'error': fixpath('config_encoding.txt'),
+                    'error2': fixpath('config_encoding_2.txt'),
+                    'syntax_error': fixpath('config_syntax_error.txt'),
+                    }
+
+    # expected settings after parsing the equally named config_file:
     settings = {
-        'old': {u'datestamp': u'%Y-%m-%d %H:%M UTC',
-                u'generator': True,
-                u'no_random': True,
-                u'python_home': u'http://www.python.org',
-                u'source_link': True,
+        'old': {'datestamp': '%Y-%m-%d %H:%M UTC',
+                'generator': True,
+                'no_random': True,
+                'python_home': 'http://www.python.org',
+                'source_link': True,
+                'stylesheet': None,
+                'stylesheet_path': 'stylesheets/pep.css',
+                'template': fixpath('pep-html-template'),
+                },
+        'one': {'datestamp': '%Y-%m-%d %H:%M UTC',
+                'generator': True,
+                'no_random': True,
+                'python_home': 'http://www.python.org',
+                'raw_enabled': False,
+                'record_dependencies': utils.DependencyList(),
+                'source_link': True,
                 'stylesheet': None,
-                u'stylesheet_path': u'stylesheets/pep.css',
-                'template': fixpath(u'data/pep-html-template')},
-        'one': {u'datestamp': u'%Y-%m-%d %H:%M UTC',
-                u'generator': True,
-                u'no_random': True,
-                u'python_home': u'http://www.python.org',
-                u'raw_enabled': False,
+                'stylesheet_path': 'stylesheets/pep.css',
+                'tab_width': 8,
+                'template': fixpath('pep-html-template'),
+                'trim_footnote_reference_space': True,
+                'output_encoding': 'ascii',
+                'output_encoding_error_handler': 'xmlcharrefreplace',
+                },
+        'two': {'footnote_references': 'superscript',
+                'generator': False,
                 'record_dependencies': utils.DependencyList(),
-                u'source_link': True,
                 'stylesheet': None,
-                u'stylesheet_path': u'stylesheets/pep.css',
-                u'tab_width': 8,
-                u'template': fixpath(u'data/pep-html-template'),
-                u'trim_footnote_reference_space': True,
-               },
-        'two': {u'footnote_references': u'superscript',
-                u'generator': False,
+                'stylesheet_path': 'test.css',
+                'trim_footnote_reference_space': None,
+                'output_encoding_error_handler': 'namereplace',
+                },
+        'two (html5)': {
+                # use defaults from html5_polyglot writer component
+                # ignore settings in html4css1 writer section,
+                'generator': True,
+                'raw_enabled': False,
                 'record_dependencies': utils.DependencyList(),
-                u'stylesheet': None,
-                u'stylesheet_path': u'test.css',
-                'trim_footnote_reference_space': None},
-        'list': {u'expose_internals': u'a', u'b', u'c', u'd', u'e',
-                 u'strip_classes': u'spam', u'pan', u'fun', u'parrot',
-                 u'strip_elements_with_classes': u'sugar', u'flour', u'milk',
-                                                  u'safran'},
-        'list2': {u'expose_internals': u'a', u'b', u'c', u'd', u'e', u'f',
-                  u'strip_classes': u'spam', u'pan', u'fun', u'parrot',
-                                     u'ham', u'eggs',
-                  u'strip_elements_with_classes': u'sugar', u'flour',
-                                                   u'milk', u'safran',
-                                                   u'eggs', u'salt'},
-        'error': {u'error_encoding': u'ascii',
-                  u'error_encoding_error_handler': u'strict'},
+                'source_link': False,
+                'tab_width': 8,
+                'trim_footnote_reference_space': True,
+                'output_encoding_error_handler': 'namereplace',
+                },
+        'list': {'expose_internals': 'a', 'b', 'c', 'd', 'e',
+                 'smartquotes_locales': ('de', '«»‹›'),
+                 'strip_classes': 'spam', 'pan', 'fun', 'parrot',
+                 'strip_elements_with_classes': 'sugar', 'flour', 'milk',
+                                                 'safran'
+                 },
+        'list2': {'expose_internals': 'a', 'b', 'c', 'd', 'e', 'f',
+                  'smartquotes_locales': ('de', '«»‹›'),
+                                          ('nl', '„”’’'),
+                                          ('cs', '»«›‹'),
+                                          ('fr', '« ', ' »', '‹ ', ' ›')
+                                          ,
+                  'strip_classes': 'spam', 'pan', 'fun', 'parrot',
+                                    'ham', 'eggs',
+                  'strip_elements_with_classes': 'sugar', 'flour', 'milk',
+                                                  'safran', 'eggs', 'salt',
+                  'stylesheet': 'style2.css', 'style3.css',
+                  'stylesheet_path': None,
+                  },
+        'error': {'error_encoding': 'ascii',
+                  'error_encoding_error_handler': 'strict'},
+        'error2': {'error_encoding': 'latin1'},
         }
 
     compare = difflib.Differ().compare
     """Comparison method shared by all tests."""
 
     def setUp(self):
+        warnings.filterwarnings('ignore',
+                                category=frontend.ConfigDeprecationWarning)
+        warnings.filterwarnings('ignore', category=DeprecationWarning)
         self.option_parser = frontend.OptionParser(
             components=(pep_html.Writer, rst.Parser), read_config_files=None)
 
     def files_settings(self, *names):
         settings = frontend.Values()
         for name in names:
-            settings.update(self.option_parser.get_config_file_settings(
-                self.config_filesname), self.option_parser)
+            cfs = self.option_parser.get_config_file_settings(
+                                                    self.config_filesname)
+            settings.update(cfs, self.option_parser)
         return settings.__dict__
 
     def expected_settings(self, *names):
@@ -103,28 +138,28 @@
 
     def compare_output(self, result, expected):
         """`result` and `expected` should both be dicts."""
-        self.assertTrue('record_dependencies' in result)
-        if 'record_dependencies' not in expected:
-            # Delete it if we don't want to test it.
-            del result'record_dependencies'
-        result = pprint.pformat(result) + '\n'
-        expected = pprint.pformat(expected) + '\n'
-        try:
-            self.assertEqual(result, expected)
-        except AssertionError:
-            print('\n%s\n' % (self,), file=sys.stderr)
-            print('-: expected\n+: result', file=sys.stderr)
-            print(''.join(self.compare(expected.splitlines(1),
-                                                     result.splitlines(1))), file=sys.stderr)
-            raise
+        self.assertIn('record_dependencies', result)
+        rd_result = result.pop('record_dependencies')
+        rd_expected = expected.pop('record_dependencies', None)
+        if rd_expected is not None:
+            self.assertEqual(str(rd_result), str(rd_expected))
+        self.assertEqual(result, expected)
 
     def test_nofiles(self):
         self.compare_output(self.files_settings(),
                             self.expected_settings())
 
     def test_old(self):
-        self.compare_output(self.files_settings('old'),
-                            self.expected_settings('old'))
+        with self.assertWarnsRegex(FutureWarning,
+                                   r'The "\option\" section is deprecated.'):
+            self.files_settings('old')
+
+    def test_syntax_error(self):
+        with self.assertRaisesRegex(
+                 ValueError,
+                 'Error in config file ".*config_syntax_error.txt", '
+                 r'section "\general\"'):
+            self.files_settings('syntax_error')
 
     def test_one(self):
         self.compare_output(self.files_settings('one'),
@@ -134,6 +169,15 @@
         self.compare_output(self.files_settings('one', 'two'),
                             self.expected_settings('one', 'two'))
 
+    def test_multiple_with_html5_writer(self):
+        # initialize option parser with different component set
+        self.option_parser = frontend.OptionParser(
+            components=(html5_polyglot.Writer, rst.Parser),
+            read_config_files=None)
+        # generator setting not changed by "config_2.txt":
+        self.compare_output(self.files_settings('one', 'two'),
+                            self.expected_settings('two (html5)'))
+
     def test_old_and_new(self):
         self.compare_output(self.files_settings('old', 'two'),
                             self.expected_settings('old', 'two'))
@@ -143,13 +187,20 @@
                             self.expected_settings('list'))
 
     def test_list2(self):
+        # setting `stylesheet` in 'list2' resets stylesheet_path to None
         self.compare_output(self.files_settings('list', 'list2'),
                             self.expected_settings('list2'))
 
-    def test_error_handler(self):
+    def test_encoding_error_handler(self):
+        # set error_encoding and error_encoding_error_handler (from affix)
         self.compare_output(self.files_settings('error'),
                             self.expected_settings('error'))
 
+    def test_encoding_error_handler2(self):
+        # second config file only changes encoding, not error_handler:
+        self.compare_output(self.files_settings('error', 'error2'),
+                            self.expected_settings('error', 'error2'))
+
 
 class ConfigEnvVarFileTests(ConfigFileTests):
 
@@ -172,23 +223,45 @@
     def tearDown(self):
         os.environ = self.orig_environ
 
+    def test_old(self):
+        pass  # don't repreat this test
+
+    @unittest.skipUnless(
+        os.name == 'posix',
+        'os.path.expanduser() does not use HOME on Windows (since 3.8)')
+    def test_get_standard_config_files(self):
+        os.environ'HOME' = '/home/parrot'
+        # TODO: set up mock home directory under Windows
+        self.assertEqual(self.option_parser.get_standard_config_files(),
+                         '/etc/docutils.conf',
+                          './docutils.conf',
+                          '/home/parrot/.docutils')
+        # split at ':', expand leading '~':
+        os.environ'DOCUTILSCONFIG' = ('/etc/docutils2.conf'
+                                        ':~/.config/docutils.conf')
+        self.assertEqual(self.option_parser.get_standard_config_files(),
+                         '/etc/docutils2.conf',
+                          '/home/parrot/.config/docutils.conf')
+
 
 class HelperFunctionsTests(unittest.TestCase):
 
-    pathdict = {'foo': 'hallo', 'ham': u'h\xE4m', 'spam': u'spam'}
+    pathdict = {'foo': 'hallo', 'ham': 'häm', 'spam': 'spam'}
     keys = 'foo', 'ham'
 
     def setUp(self):
-        self.option_parser = frontend.OptionParser(
-            components=(rst.Parser,), read_config_files=None)
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            self.option_parser = frontend.OptionParser(
+                components=(rst.Parser,), read_config_files=None)
 
     def test_make_paths_absolute(self):
         pathdict = self.pathdict.copy()
         frontend.make_paths_absolute(pathdict, self.keys, base_path='base')
         self.assertEqual(pathdict'foo', os.path.abspath('base/hallo'))
-        self.assertEqual(pathdict'ham', os.path.abspath(u'base/h\xE4m'))
+        self.assertEqual(pathdict'ham', os.path.abspath('base/häm'))
         # not touched, because key not in keys:
-        self.assertEqual(pathdict'spam', u'spam')
+        self.assertEqual(pathdict'spam', 'spam')
 
     def test_make_paths_absolute_cwd(self):
         # With base_path None, the cwd is used as base path.
@@ -196,61 +269,57 @@
         # os.getcwdu() is used and the converted path is a unicode instance:
         pathdict = self.pathdict.copy()
         frontend.make_paths_absolute(pathdict, self.keys)
-        self.assertEqual(pathdict'foo', os.path.abspath(u'hallo'))
-        self.assertEqual(pathdict'ham', os.path.abspath(u'h\xE4m'))
+        self.assertEqual(pathdict'foo', os.path.abspath('hallo'))
+        self.assertEqual(pathdict'ham', os.path.abspath('häm'))
         # not touched, because key not in keys:
-        self.assertEqual(pathdict'spam', u'spam')
+        self.assertEqual(pathdict'spam', 'spam')
 
     boolean_settings = (
-                (True, True ),
-                ('1', True ),
-                (u'on', True ),
-                ('yes', True ),
-                (u'true', True ),
-                (u'0', False ),
-                ('off', False ),
-                (u'no', False ),
-                ('false', False ),
+                (True, True),
+                ('1', True),
+                ('on', True),
+                ('yes', True),
+                ('true', True),
+                ('0', False),
+                ('off', False),
+                ('no', False),
+                ('false', False),
                )
+
     def test_validate_boolean(self):
         for t in self.boolean_settings:
             self.assertEqual(
                 frontend.validate_boolean(None, t0, self.option_parser),
-                             t1)
+                t1)
 
     def test_validate_ternary(self):
         tests = (
                  ('500V', '500V'),
-                 (u'parrot', u'parrot'),
+                 ('parrot', 'parrot'),
                 )
         for t in self.boolean_settings + tests:
             self.assertEqual(
                 frontend.validate_ternary(None, t0, self.option_parser),
-                             t1)
+                t1)
 
     def test_validate_colon_separated_string_list(self):
         tests = (
-                    (u'a', 'a', ),
-                    ('a', 'a', ),
-                    (u'a:b', 'a', 'b' ),
-                    ('a:b', 'a', 'b' ),
-                    (u'a',, 'a', ),
-                    (u'a', u'b:c', 'a', 'b', 'c' ),
+                    ('a', 'a'),
+                    ('a:b', 'a', 'b'),
+                    ('a', 'a'),
+                    ('a', 'b:c', 'a', 'b', 'c'),
                 )
         for t in tests:
-            self.assertEqual(
-                    frontend.validate_colon_separated_string_list(None, t0, None),
-                    t1)
+            self.assertEqual(frontend.validate_colon_separated_string_list(
+                                 None, t0, None),
+                             t1)
 
     def test_validate_comma_separated_list(self):
         tests = (
-                    (u'a', 'a', ),
-                    ('a', 'a', ),
-                    (u'a,b', 'a', 'b' ),
-                    ('a,b', 'a', 'b' ),
-                    (u'a',, 'a', ),
-                    (u'a', u'b,c', 'a', 'b', 'c' ),
-                    ('a', 'b,c', 'a', 'b', 'c' ),
+                    ('a', 'a'),
+                    ('a,b', 'a', 'b'),
+                    ('a', 'a'),
+                    ('a', 'b,c', 'a', 'b', 'c'),
                 )
         for t in tests:
             self.assertEqual(
@@ -259,10 +328,10 @@
 
     def test_validate_url_trailing_slash(self):
         tests = (
-                    ('', './' ),
-                    (None, './' ),
-                    (u'http://example.org', u'http://example.org/' ),
-                    ('http://example.org/', 'http://example.org/' ),
+                    ('', './'),
+                    (None, './'),
+                    ('http://example.org', 'http://example.org/'),
+                    ('http://example.org/', 'http://example.org/'),
                 )
         for t in tests:
             self.assertEqual(
@@ -271,18 +340,21 @@
 
     def test_validate_smartquotes_locales(self):
         tests = (
-                 ('en:ssvv', ('en', 'ssvv')),
-                 (u'sd:«»°°', (u'sd', u'«»°°')),
-                 (('sd', u'«»°°'), u'ds:°°«»', ('sd', u'«»°°'),
-                                                  ('ds', u'°°«»')),
-                 (u'frs:« : »:((:))', (u'frs', u'« ', u' »',
-                                                 u'((', u'))')),
-                )
+            ('en:ssvv', ('en', 'ssvv')),
+            ('sd:«»°°', ('sd', '«»°°')),
+            (('sd', '«»°°'), 'ds:°°«»', ('sd', '«»°°'), ('ds', '°°«»')),
+            ('frs:« : »:((:))', ('frs', '« ', ' »', '((', '))')),
+            )
         for t in tests:
             self.assertEqual(
                     frontend.validate_smartquotes_locales(None, t0, None),
                     t1)
 
+    def test_set_conditions_deprecation_warning(self):
+        reporter = utils.Reporter('test', 1, 4)
+        with self.assertWarnsRegex(DeprecationWarning,
+                                   'Set attributes via configuration '):
+            reporter.set_conditions('foo', 1, 4)  # trigger warning
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_statemachine.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_statemachine.py Changed

@@ -1,18 +1,24 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_statemachine.py 8372 2019-08-27 12:11:15Z milde $
+# $Id: test_statemachine.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for statemachine.py.
 """
-from __future__ import print_function
 
-import unittest
-import sys
+from pathlib import Path
 import re
-from DocutilsTestSupport import statemachine
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+from docutils import statemachine
 
 
 debug = False
@@ -57,47 +63,54 @@
     def bof(self, context):
         self.levelholder0 += 1
         self.level = self.levelholder0
-        if self.debug: print('StateMachine%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('StateMachine%s' % self.level, file=sys.stderr)
         return , 'StateMachine%s' % self.level
 
     def blank(self, match, context, next_state):
         result = 'blank%s' % self.level
-        if self.debug: print('blank%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('blank%s' % self.level, file=sys.stderr)
         if context and context-1 and context-1-2: == '::':
             result.extend(self.literalblock())
         return , None, result
 
     def indent(self, match, context, next_state):
-        if self.debug: print('indent%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('indent%s' % self.level, file=sys.stderr)
         context, next_state, result = statemachine.StateWS.indent(
               self, match, context, next_state)
         return context, next_state, 'indent%s' % self.level + result
 
     def known_indent(self, match, context, next_state):
-        if self.debug: print('known_indent%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('known_indent%s' % self.level, file=sys.stderr)
         context, next_state, result = statemachine.StateWS.known_indent(
               self, match, context, next_state)
         return context, next_state, 'known_indent%s' % self.level + result
 
     def bullet(self, match, context, next_state):
-        if self.debug: print('bullet%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('bullet%s' % self.level, file=sys.stderr)
         context, next_state, result \
-              = self.known_indent(match, context, next_state)
+            = self.known_indent(match, context, next_state)
         return , next_state, 'bullet%s' % self.level + result
 
     def text(self, match, context, next_state):
-        if self.debug: print('text%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('text%s' % self.level, file=sys.stderr)
         return match.string, next_state, 'text%s' % self.level
 
     def literalblock(self):
         indented, indent, offset, good = self.state_machine.get_indented()
-        if self.debug: print('literalblock%s(%s)' % (self.level,
-                                                                   indent), file=sys.stderr)
+        if self.debug:
+            print('literalblock%s(%s)' % (self.level, indent), file=sys.stderr)
         return 'literalblock%s(%s)' % (self.level, indent)
 
     def eof(self, context):
         self.levelholder0 -= 1
-        if self.debug: print('finished%s' % self.level, file=sys.stderr)
+        if self.debug:
+            print('finished%s' % self.level, file=sys.stderr)
         return 'finished%s' % self.level
 
 
@@ -111,8 +124,8 @@
     def test_add_state(self):
         self.sm.add_state(statemachine.State)
         self.assertTrue(len(self.sm.states) == 1)
-        self.assertRaises(statemachine.DuplicateStateError, self.sm.add_state,
-                          statemachine.State)
+        with self.assertRaises(statemachine.DuplicateStateError):
+            self.sm.add_state(statemachine.State)
         self.sm.add_state(statemachine.StateWS)
         self.assertTrue(len(self.sm.states) == 2)
 
@@ -123,12 +136,12 @@
     def test_get_state(self):
         self.assertRaises(statemachine.UnknownStateError, self.sm.get_state)
         self.sm.add_states((statemachine.State, statemachine.StateWS))
-        self.assertRaises(statemachine.UnknownStateError, self.sm.get_state,
-                          'unknownState')
+        with self.assertRaises(statemachine.UnknownStateError):
+            self.sm.get_state('unknownState')
         self.assertTrue(isinstance(self.sm.get_state('State'),
-                                statemachine.State))
+                                   statemachine.State))
         self.assertTrue(isinstance(self.sm.get_state('StateWS'),
-                                statemachine.State))
+                                   statemachine.State))
         self.assertEqual(self.sm.current_state, 'StateWS')
 
 
@@ -177,7 +190,7 @@
         self.assertEqual(indent, lbindent)
         self.assertEqual(indented, literalblock)
         self.assertEqual(offset, (len(para1) + len(item1) + len(item2)
-                                   - len(literalblock)))
+                                  - len(literalblock)))
         self.assertTrue(good)
 
     def test_get_text_block(self):
@@ -197,14 +210,14 @@
         textblock = self.sm.get_text_block(flush_left=1)
         self.assertEqual(textblock, testtext:1)
         self.sm.next_line(2)
-        self.assertRaises(statemachine.UnexpectedIndentationError,
-                          self.sm.get_text_block, flush_left=1)
+        with self.assertRaises(statemachine.UnexpectedIndentationError):
+            self.sm.get_text_block(flush_left=1)
 
     def test_run(self):
         self.assertEqual(self.sm.run(testtext), expected)
 
 
-class EmptyClass(object):
+class EmptyClass:
     pass
 
 
@@ -222,18 +235,17 @@
         self.assertEqual(len(self.state.transitions), 0)
         self.state.add_transitions('None', {'None': None})
         self.assertEqual(len(self.state.transitions), 1)
-        self.assertRaises(statemachine.UnknownTransitionError,
-                          self.state.add_transitions, 'bogus', {})
-        self.assertRaises(statemachine.DuplicateTransitionError,
-                          self.state.add_transitions, 'None',
-                          {'None': None})
+        with self.assertRaises(statemachine.UnknownTransitionError):
+            self.state.add_transitions('bogus', {})
+        with self.assertRaises(statemachine.DuplicateTransitionError):
+            self.state.add_transitions('None', {'None': None})
 
     def test_add_transition(self):
         self.assertEqual(len(self.state.transitions), 0)
         self.state.add_transition('None', None)
         self.assertEqual(len(self.state.transitions), 1)
-        self.assertRaises(statemachine.DuplicateTransitionError,
-                          self.state.add_transition, 'None', None)
+        with self.assertRaises(statemachine.DuplicateTransitionError):
+            self.state.add_transition('None', None)
 
     def test_remove_transition(self):
         self.assertEqual(len(self.state.transitions), 0)
@@ -241,31 +253,31 @@
         self.assertEqual(len(self.state.transitions), 1)
         self.state.remove_transition('None')
         self.assertEqual(len(self.state.transitions), 0)
-        self.assertRaises(statemachine.UnknownTransitionError,
-                          self.state.remove_transition, 'None')
+        with self.assertRaises(statemachine.UnknownTransitionError):
+            self.state.remove_transition('None')
 
     def test_make_transition(self):
         dummy = re.compile('dummy')
         self.assertEqual(self.state.make_transition('nop', 'bogus'),
-                          (dummy, self.state.nop, 'bogus'))
+                         (dummy, self.state.nop, 'bogus'))
         self.assertEqual(self.state.make_transition('nop'),
-                          (dummy, self.state.nop,
-                           self.state.__class__.__name__))
-        self.assertRaises(statemachine.TransitionPatternNotFound,
-                          self.state.make_transition, 'None')
-        self.assertRaises(statemachine.TransitionMethodNotFound,
-                          self.state.make_transition, 'bogus')
+                         (dummy, self.state.nop,
+                          self.state.__class__.__name__))
+        with self.assertRaises(statemachine.TransitionPatternNotFound):
+            self.state.make_transition('None')
+        with self.assertRaises(statemachine.TransitionMethodNotFound):
+            self.state.make_transition('bogus')
 
     def test_make_transitions(self):
         dummy = re.compile('dummy')
         self.assertEqual(self.state.make_transitions(('nop', 'nop2',
-                                                       ('nop3', 'bogus'))),
-                          ('nop', 'nop2', 'nop3',
-                           {'nop': (dummy, self.state.nop,
+                                                      ('nop3', 'bogus'))),
+                         ('nop', 'nop2', 'nop3',
+                          {'nop': (dummy, self.state.nop,
+                                   self.state.__class__.__name__),
+                           'nop2': (dummy, self.state.nop2,
                                     self.state.__class__.__name__),
-                            'nop2': (dummy, self.state.nop2,
-                                     self.state.__class__.__name__),
-                            'nop3': (dummy, self.state.nop3, 'bogus')}))
+                           'nop3': (dummy, self.state.nop3, 'bogus')}))
 
 
 class MiscTests(unittest.TestCase):
@@ -273,9 +285,10 @@
     s2l_string = "hello\tthere\thow are\tyou?\n\tI'm fine\tthanks.\n"
     s2l_expected = 'hello   there   how are you?',
                     "        I'm fine        thanks."
+
     def test_string2lines(self):
         self.assertEqual(statemachine.string2lines(self.s2l_string),
-                          self.s2l_expected)
+                         self.s2l_expected)
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test___init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test___init__.py Changed

@@ -1,28 +1,34 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test___init__.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test___init__.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for transforms/__init__.py.
 """
-from __future__ import absolute_import
 
+from pathlib import Path
+import sys
 import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
 from docutils import transforms, utils
 
 
 class TestTransform(transforms.Transform):
 
+    # marker for pytest to ignore this class during test discovery
+    __test__ = False
+
     default_priority = 100
 
     applied = 0
-    
+
     def apply(self, **kwargs):
         self.applied += 1
         assert kwargs == {'foo': 42}

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_class.py Changed

@@ -1,25 +1,46 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_class.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for `docutils.transforms.misc.ClassAttribute`.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.parsers.rst import Parser
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -188,5 +209,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_contents.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_contents.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_contents.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_contents.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,20 +8,41 @@
 Tests for `docutils.transforms.parts.Contents` (via
 `docutils.transforms.universal.LastReaderPending`).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import Substitutions
-from docutils.parsers.rst import Parser
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -53,26 +74,26 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="title-1">
+                    <reference ids="toc-entry-1" refid="title-1">
                         Title 1
                 <bullet_list>
                     <list_item>
                         <paragraph>
-                            <reference ids="id2" refid="title-2">
+                            <reference ids="toc-entry-2" refid="title-2">
                                 Title
                                  2
                         <bullet_list>
                             <list_item>
                                 <paragraph>
-                                    <reference ids="id3" refid="title-3">
+                                    <reference ids="toc-entry-3" refid="title-3">
                                         Title
                                          3
                     <list_item>
                         <paragraph>
-                            <reference ids="id4" refid="title-4">
+                            <reference ids="toc-entry-4" refid="title-4">
                                 Title 4
     <section ids="title-1" names="title\\ 1">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Title 1
         <paragraph>
             Paragraph 1.
@@ -84,14 +105,14 @@
             <paragraph>
                 Paragraph 2.
             <section ids="title-3" names="title\\ 3">
-                <title refid="id3">
+                <title refid="toc-entry-3">
                     <target ids="title" names="title">
                         Title
                      3
                 <paragraph>
                     Paragraph 3.
         <section ids="title-4" names="title\\ 4">
-            <title refid="id4">
+            <title refid="toc-entry-4">
                 Title 4
             <paragraph>
                 Paragraph 4.
@@ -115,20 +136,20 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="title-1">
+                    <reference ids="toc-entry-1" refid="title-1">
                         Title 1
                 <bullet_list>
                     <list_item>
                         <paragraph>
-                            <reference ids="id2" refid="title-2">
+                            <reference ids="toc-entry-2" refid="title-2">
                                 Title 2
     <section ids="title-1" names="title\\ 1">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Title 1
         <paragraph>
             Paragraph 1.
         <section ids="title-2" names="title\\ 2">
-            <title refid="id2">
+            <title refid="toc-entry-2">
                 Title 2
             <paragraph>
                 Paragraph 2.
@@ -154,19 +175,19 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="title-1">
+                    <reference ids="toc-entry-1" refid="title-1">
                         Title 1
             <list_item>
                 <paragraph>
-                    <reference ids="id2" refid="title-2">
+                    <reference ids="toc-entry-2" refid="title-2">
                         Title 2
     <section ids="title-1" names="title\\ 1">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Title 1
         <paragraph>
             Paragraph 1.
     <section ids="title-2" names="title\\ 2">
-        <title refid="id2">
+        <title refid="toc-entry-2">
             <image alt="Title 2" uri="title2.png">
         <paragraph>
             Paragraph 2.
@@ -201,24 +222,24 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="title-1">
+                    <reference ids="toc-entry-1" refid="title-1">
                         Title 1
                 <bullet_list>
                     <list_item>
                         <paragraph>
-                            <reference ids="id2" refid="title-2">
+                            <reference ids="toc-entry-2" refid="title-2">
                                 Title 2
                     <list_item>
                         <paragraph>
-                            <reference ids="id3" refid="title-4">
+                            <reference ids="toc-entry-3" refid="title-4">
                                 Title 4
     <section ids="title-1" names="title\\ 1">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Title 1
         <paragraph>
             Paragraph 1.
         <section ids="title-2" names="title\\ 2">
-            <title refid="id2">
+            <title refid="toc-entry-2">
                 Title 2
             <paragraph>
                 Paragraph 2.
@@ -228,7 +249,7 @@
                 <paragraph>
                     Paragraph 3.
         <section ids="title-4" names="title\\ 4">
-            <title refid="id3">
+            <title refid="toc-entry-3">
                 Title 4
             <paragraph>
                 Paragraph 4.
@@ -263,31 +284,31 @@
             <bullet_list>
                 <list_item>
                     <paragraph>
-                        <reference ids="id1" refid="title-2">
+                        <reference ids="toc-entry-1" refid="title-2">
                             Title 2
                     <bullet_list>
                         <list_item>
                             <paragraph>
-                                <reference ids="id2" refid="title-3">
+                                <reference ids="toc-entry-2" refid="title-3">
                                     Title 3
                 <list_item>
                     <paragraph>
-                        <reference ids="id3" refid="title-4">
+                        <reference ids="toc-entry-3" refid="title-4">
                             Title 4
         <paragraph>
             Paragraph 1.
         <section ids="title-2" names="title\\ 2">
-            <title refid="id1">
+            <title refid="toc-entry-1">
                 Title 2
             <paragraph>
                 Paragraph 2.
             <section ids="title-3" names="title\\ 3">
-                <title refid="id2">
+                <title refid="toc-entry-2">
                     Title 3
                 <paragraph>
                     Paragraph 3.
         <section ids="title-4" names="title\\ 4">
-            <title refid="id3">
+            <title refid="toc-entry-3">
                 Title 4
             <paragraph>
                 Paragraph 4.
@@ -308,12 +329,12 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="section">
+                    <reference ids="toc-entry-1" refid="section">
                         Section
     <paragraph>
         Test duplicate name "Contents".
     <section ids="section" names="section">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Section
         <paragraph>
             Paragraph.
@@ -334,7 +355,7 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="section">
+                    <reference ids="toc-entry-1" refid="section">
                         Section
     <section ids="section" names="section">
         <title refid="contents">
@@ -358,7 +379,7 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="section">
+                    <reference ids="toc-entry-1" refid="section">
                         Section
     <section ids="section" names="section">
         <title>
@@ -409,20 +430,20 @@
                 <bullet_list>
                     <list_item>
                         <paragraph>
-                            <reference ids="id1" refid="title-2">
+                            <reference ids="toc-entry-1" refid="title-2">
                                 Title 2
                         <bullet_list>
                             <list_item>
                                 <paragraph>
-                                    <reference ids="id2" refid="title-3">
+                                    <reference ids="toc-entry-2" refid="title-3">
                                         Title 3
         <section ids="title-2" names="title\\ 2">
-            <title refid="id1">
+            <title refid="toc-entry-1">
                 Title 2
             <paragraph>
                 Paragraph 2.
             <section ids="title-3" names="title\\ 3">
-                <title refid="id2">
+                <title refid="toc-entry-2">
                     Title 3
                 <paragraph>
                     Paragraph 3.
@@ -431,5 +452,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_docinfo.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_docinfo.py Changed

@@ -1,33 +1,65 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# $Id: test_docinfo.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_docinfo.py 9351 2023-04-17 20:26:33Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.frontmatter.DocInfo.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.frontmatter import DocInfo
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.frontmatter import DocInfo
+from docutils.transforms.universal import FilterMessages, TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
 
-def suite():
+    maxDiff = None
+    settings = get_default_settings(Parser)
+    settings.warning_stream = ''
     parser = Parser()
-    settings = {'language_code': 'en'}
-    s = DocutilsTestSupport.TransformTestSuite(
-        parser, suite_settings=settings)
-    s.generateTests(totest)
-    settings'language_code' = 'de'
-    s.generateTests(totest_de)
-    settings'language_code' = 'ru'
-    s.generateTests(totest_ru)
-    return s
+
+    def check_output(self, samples, settings):
+        # yield (output, expected) for each test sample
+        for key, (transforms, cases) in samples.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'samples{key!r}{casenum}'):
+                    document = new_document('test data', settings)
+                    self.parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    # Filter INFOs with increased priority so that
+                    # messages added by `TestMessages` are filtered, too:
+                    document.transformer.add_transform(FilterMessages, 890)
+                    document.transformer.apply_transforms()
+                    self.assertEqual(document.pformat(), case_expected)
+
+    def test_transforms(self):
+        self.check_output(totest, self.settings)
+
+    def test_transforms_de(self):
+        settings = self.settings.copy()
+        settings.language_code = 'de'
+        self.check_output(totest_de, settings)
+
+    def test_transforms_ru(self):
+        settings = self.settings.copy()
+        settings.language_code = 'ru'
+        self.check_output(totest_ru, settings)
+
 
 totest = {}
 totest_de = {}
@@ -42,16 +74,21 @@
 
     It is automatically moved to the end of the other bibliographic elements.
 
-:Author: Me
+:Author: E. *Xample*
+
 :Version: 1
+
 :Date: 2001-08-11
+
 :Parameter i: integer
 """,
 """\
 <document source="test data">
     <docinfo>
         <author>
-            Me
+            E. \n\
+            <emphasis>
+                Xample
         <version>
             1
         <date>
@@ -146,7 +183,8 @@
                             must be a paragraph
                 <system_message level="2" line="1" source="test data" type="WARNING">
                     <paragraph>
-                        Cannot extract bibliographic field "Author" containing anything other than a single paragraph.
+                        Bibliographic field "Author"
+                        must contain a single <paragraph>, not a <bullet_list>.
         <status>
             a \n\
             <emphasis>
@@ -162,7 +200,8 @@
                     paragraph.
                 <system_message level="2" line="3" source="test data" type="WARNING">
                     <paragraph>
-                        Cannot extract compound bibliographic field "Date".
+                        Bibliographic field "Date"
+                        must contain a single <paragraph>, not <paragraph>, <paragraph>.
         <field classes="version">
             <field_name>
                 Version
@@ -319,7 +358,12 @@
                             Shaw
                 <system_message level="2" line="3" source="test data" type="WARNING">
                     <paragraph>
-                        Bibliographic field "Authors" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of ";,"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item.
+                        Cannot extract "Authors" from bibliographic field:
+                        Bibliographic field "Authors" must contain either
+                         a single paragraph (with author names separated by one of ";,"),
+                         multiple paragraphs (one per author),
+                         or a bullet list with one author name per item.
+                        Note: Leading initials can cause (mis)recognizing names as enumerated list.
         <field classes="authors">
             <field_name>
                 Authors
@@ -329,7 +373,12 @@
                     <list_item>
                 <system_message level="2" line="6" source="test data" type="WARNING">
                     <paragraph>
-                        Bibliographic field "Authors" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of ";,"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item.
+                        Cannot extract "Authors" from bibliographic field:
+                        Bibliographic field "Authors" must contain either
+                         a single paragraph (with author names separated by one of ";,"),
+                         multiple paragraphs (one per author),
+                         or a bullet list with one author name per item.
+                        Note: Leading initials can cause (mis)recognizing names as enumerated list.
         <field classes="authors">
             <field_name>
                 Authors
@@ -342,7 +391,12 @@
                     Two
                 <system_message level="2" line="10" source="test data" type="WARNING">
                     <paragraph>
-                        Bibliographic field "Authors" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of ";,"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item.
+                        Cannot extract "Authors" from bibliographic field:
+                        Bibliographic field "Authors" must contain either
+                         a single paragraph (with author names separated by one of ";,"),
+                         multiple paragraphs (one per author),
+                         or a bullet list with one author name per item.
+                        Note: Leading initials can cause (mis)recognizing names as enumerated list.
         <field classes="authors">
             <field_name>
                 Authors
@@ -355,12 +409,17 @@
                             Two
                 <system_message level="2" line="15" source="test data" type="WARNING">
                     <paragraph>
-                        Bibliographic field "Authors" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of ";,"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item.
+                        Cannot extract "Authors" from bibliographic field:
+                        Bibliographic field "Authors" must contain either
+                         a single paragraph (with author names separated by one of ";,"),
+                         multiple paragraphs (one per author),
+                         or a bullet list with one author name per item.
+                        Note: Leading initials can cause (mis)recognizing names as enumerated list.
 """,
 """\
 .. RCS keyword extraction.
 
-:Status: (some text) $""" + """RCSfile: test_docinfo.py,v $ (more text) 
+:Status: (some text) $""" + """RCSfile: test_docinfo.py,v $ (more text)
 :Date: (some text) $""" + """Date: 2002/10/08 01:34:23 $ (more text)
 :Date: (some text) $""" + """Date: 2005-03-26T16:21:28.693201Z $ (more text)
 :Version: (some text) $""" + """Revision: 1.1 $ (more text)
@@ -381,8 +440,8 @@
 """,
 )
 
-totest_de'bibliographic_field_lists' = ((DocInfo,), 
-u"""\
+totest_de'bibliographic_field_lists_de' = ((DocInfo,), 
+"""\
 .. Bibliographic element extraction for a German document.
 
 :Zusammenfassung: Abstract 1.
@@ -394,7 +453,7 @@
 :Datum: 2001-08-11
 :Parameter i: integer
 """,
-u"""\
+"""\
 <document source="test data">
     <docinfo>
         <author>
@@ -422,10 +481,11 @@
             Abstract 1.
     <comment xml:space="preserve">
         Bibliographic element extraction for a German document.
-""",)
+"""
+)
 
-totest_ru'bibliographic_field_lists' = ((DocInfo,), 
-u"""\
+totest_ru'bibliographic_field_lists_ru' = ((DocInfo,), 
+"""\
 .. Bibliographic element extraction for a Russian document.
 
 :аннотация: Abstract 1.
@@ -437,7 +497,7 @@
 :дата: 2001-08-11
 :Parameter i: integer
 """,
-u"""\
+"""\
 <document source="test data">
     <docinfo>
         <author>
@@ -465,9 +525,9 @@
             Abstract 1.
     <comment xml:space="preserve">
         Bibliographic element extraction for a Russian document.
-""",)
+"""
+)
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_doctitle.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_doctitle.py Changed

@@ -1,20 +1,28 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_doctitle.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_doctitle.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.frontmatter.DocTitle.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.frontmatter import DocTitle, SectionSubTitle
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser, Directive
 from docutils.parsers.rst.directives import register_directive
+from docutils.transforms.frontmatter import DocTitle, SectionSubTitle
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
 
 
 # dummy directive to test attribute merging:
@@ -22,7 +30,7 @@
     required_arguments = 0
     optional_arguments = 0
     final_argument_whitespace = True
-    option_spec = { }
+    option_spec = {}
     has_content = False
 
     def run(self):
@@ -30,13 +38,29 @@
         document'names'.append('Name')
         return 
 
-register_directive('add-name-to-title', AddNameToDocumentTitle)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
+class TransformTestCase(unittest.TestCase):
+
+    maxDiff = None
+
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        register_directive('add-name-to-title', AddNameToDocumentTitle)
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
 
 totest = {}
 
@@ -263,5 +287,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_expose_internals.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_expose_internals.py Changed

@@ -1,28 +1,46 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_expose_internals.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_expose_internals.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for universal.ExposeInternals transform.
 """
-from __future__ import absolute_import
 
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
-from docutils.transforms.universal import ExposeInternals
-from docutils.parsers.rst import Parser
-
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(
-        parser, suite_settings={'expose_internals': 'rawsource', 'source'})
-    s.generateTests(totest)
-    return s
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.universal import ExposeInternals, TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.expose_internals = 'rawsource', 'source'
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
 
 totest = {}
@@ -40,5 +58,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_filter.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_filter.py Changed

@@ -1,25 +1,46 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_filter.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_filter.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.components.Filter.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.parsers.rst import Parser
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -38,5 +59,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_filter_messages.py Added

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+
+# $Id: test_filter_messages.py 9277 2022-11-26 23:15:13Z milde $
+# :Copyright: © 2021 Günter Milde.
+# :Maintainer: docutils-develop@lists.sourceforge.net
+# :License: Released under the terms of the `2-Clause BSD license`_, in short:
+#
+#    Copying and distribution of this file, with or without modification,
+#    are permitted in any medium without royalty provided the copyright
+#    notice and this notice are preserved.
+#    This file is offered as-is, without any warranty.
+#
+# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
+
+"""
+Tests for docutils.transforms.universal.FilterMessages.
+"""
+
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import Messages, FilterMessages, TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.report_level = 5
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+totest = {}
+
+totest'system_message_sections' = ((Substitutions, Messages, FilterMessages), 
+"""\
+.. unknown-directive:: block markup is filtered without trace.
+""",
+"""\
+<document source="test data">
+""",
+"""\
+Invalid *inline markup is restored to text.
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Invalid \n\
+        *
+        inline markup is restored to text.
+""",
+"""\
+This |unknown substitution| will generate a system message, thanks to
+the "Substitutions" transform. The "Messages" transform will
+generate a "System Messages" section and the "FilterMessages" transform
+will remove it.
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        This \n\
+        |unknown substitution|
+         will generate a system message, thanks to
+        the "Substitutions" transform. The "Messages" transform will
+        generate a "System Messages" section and the "FilterMessages" transform
+        will remove it.
+""",
+)
+
+
+if __name__ == '__main__':
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_footnotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_footnotes.py Changed

@@ -1,26 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_footnotes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_footnotes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.references.Footnotes.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import Footnotes
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.references import Footnotes
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -33,9 +54,9 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refid="autolabel">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="autolabel">
             1
-    <footnote auto="1" backrefs="id1" ids="autolabel" names="autolabel">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="autolabel" names="autolabel">
         <label>
             1
         <paragraph>
@@ -50,9 +71,9 @@
 <document source="test data">
     <paragraph>
         autonumber: \n\
-        <footnote_reference auto="1" ids="id1" refid="id2">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="footnote-1">
             1
-    <footnote auto="1" backrefs="id1" ids="id2" names="1">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
@@ -71,29 +92,29 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refid="id3">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="footnote-1">
             1
          is the first auto-numbered footnote reference.
-        <footnote_reference auto="1" ids="id2" refid="id4">
+        <footnote_reference auto="1" ids="footnote-reference-2" refid="footnote-2">
             2
          is the second auto-numbered footnote reference.
-    <footnote auto="1" backrefs="id1" ids="id3" names="1">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             Auto-numbered footnote 1.
-    <footnote auto="1" backrefs="id2" ids="id4" names="2">
+    <footnote auto="1" backrefs="footnote-reference-2" ids="footnote-2" names="2">
         <label>
             2
         <paragraph>
             Auto-numbered footnote 2.
-    <footnote auto="1" backrefs="id6" ids="id5" names="3">
+    <footnote auto="1" backrefs="footnote-reference-3" ids="footnote-3" names="3">
         <label>
             3
         <paragraph>
             Auto-numbered footnote 3.
     <paragraph>
-        <footnote_reference auto="1" ids="id6" refid="id5">
+        <footnote_reference auto="1" ids="footnote-reference-3" refid="footnote-3">
             3
          is the third auto-numbered footnote reference.
 """,
@@ -114,32 +135,32 @@
 """\
 <document source="test data">
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refid="third">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="third">
             3
          is a reference to the third auto-numbered footnote.
-    <footnote auto="1" backrefs="id3" ids="first" names="first">
+    <footnote auto="1" backrefs="footnote-reference-3" ids="first" names="first">
         <label>
             1
         <paragraph>
             First auto-numbered footnote.
-    <footnote auto="1" backrefs="id2" ids="second" names="second">
+    <footnote auto="1" backrefs="footnote-reference-2" ids="second" names="second">
         <label>
             2
         <paragraph>
             Second auto-numbered footnote.
-    <footnote auto="1" backrefs="id1 id4" ids="third" names="third">
+    <footnote auto="1" backrefs="footnote-reference-1 footnote-reference-4" ids="third" names="third">
         <label>
             3
         <paragraph>
             Third auto-numbered footnote.
     <paragraph>
-        <footnote_reference auto="1" ids="id2" refid="second">
+        <footnote_reference auto="1" ids="footnote-reference-2" refid="second">
             2
          is a reference to the second auto-numbered footnote.
-        <footnote_reference auto="1" ids="id3" refid="first">
+        <footnote_reference auto="1" ids="footnote-reference-3" refid="first">
             1
          is a reference to the first auto-numbered footnote.
-        <footnote_reference auto="1" ids="id4" refid="third">
+        <footnote_reference auto="1" ids="footnote-reference-4" refid="third">
             3
          is another reference to the third auto-numbered footnote.
     <paragraph>
@@ -174,39 +195,39 @@
     <paragraph>
         Mixed anonymous and labelled auto-numbered footnotes:
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refid="four">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="four">
             4
          should be 4, \n\
-        <footnote_reference auto="1" ids="id2" refid="id7">
+        <footnote_reference auto="1" ids="footnote-reference-2" refid="footnote-1">
             1
          should be 1,
-        <footnote_reference auto="1" ids="id3" refid="id8">
+        <footnote_reference auto="1" ids="footnote-reference-3" refid="footnote-2">
             3
          should be 3, \n\
-        <problematic ids="id11 id4" refid="id10">
+        <problematic ids="problematic-1 footnote-reference-4" refid="system-message-1">
             #_
          is one too many,
-        <footnote_reference auto="1" ids="id5" refid="two">
+        <footnote_reference auto="1" ids="footnote-reference-5" refid="two">
             2
          should be 2, and \n\
-        <footnote_reference auto="1" ids="id6" refname="six">
+        <footnote_reference auto="1" ids="footnote-reference-6" refname="six">
          doesn't exist.
-    <footnote auto="1" backrefs="id2" ids="id7" names="1">
+    <footnote auto="1" backrefs="footnote-reference-2" ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             Auto-numbered footnote 1.
-    <footnote auto="1" backrefs="id5" ids="two" names="two">
+    <footnote auto="1" backrefs="footnote-reference-5" ids="two" names="two">
         <label>
             2
         <paragraph>
             Auto-numbered footnote 2.
-    <footnote auto="1" backrefs="id3" ids="id8" names="3">
+    <footnote auto="1" backrefs="footnote-reference-3" ids="footnote-2" names="3">
         <label>
             3
         <paragraph>
             Auto-numbered footnote 3.
-    <footnote auto="1" backrefs="id1" ids="four" names="four">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="four" names="four">
         <label>
             4
         <paragraph>
@@ -216,15 +237,15 @@
             5
         <paragraph>
             Auto-numbered footnote 5.
-    <footnote auto="1" dupnames="five" ids="id9">
+    <footnote auto="1" dupnames="five" ids="five-1">
         <label>
             6
-        <system_message backrefs="id9" level="2" line="12" source="test data" type="WARNING">
+        <system_message backrefs="five-1" level="2" line="12" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "five".
         <paragraph>
             Auto-numbered footnote 5 again (duplicate).
-    <system_message backrefs="id11" ids="id10" level="3" line="3" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="3" source="test data" type="ERROR">
         <paragraph>
             Too many autonumbered footnote references: only 2 corresponding footnotes available.
 """,
@@ -239,12 +260,12 @@
 <document source="test data">
     <paragraph>
         Mixed auto-numbered and manual footnotes:
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             manually numbered
-    <footnote auto="1" ids="id2" names="2">
+    <footnote auto="1" ids="footnote-2" names="2">
         <label>
             2
         <paragraph>
@@ -269,20 +290,20 @@
 <document source="test data">
     <paragraph>
         A labeled autonumbered footnote referece: \n\
-        <footnote_reference auto="1" ids="id1" refid="footnote">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="footnote">
             2
         .
     <paragraph>
         An unlabeled autonumbered footnote referece: \n\
-        <footnote_reference auto="1" ids="id2" refid="id3">
+        <footnote_reference auto="1" ids="footnote-reference-2" refid="footnote-1">
             1
         .
-    <footnote auto="1" backrefs="id2" ids="id3" names="1">
+    <footnote auto="1" backrefs="footnote-reference-2" ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             Unlabeled autonumbered footnote.
-    <footnote auto="1" backrefs="id1" ids="footnote" names="footnote">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="footnote" names="footnote">
         <label>
             2
         <paragraph>
@@ -313,44 +334,44 @@
         Mixed manually-numbered, anonymous auto-numbered,
         and labelled auto-numbered footnotes:
     <paragraph>
-        <footnote_reference auto="1" ids="id1" refid="four">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="four">
             4
          should be 4, \n\
-        <footnote_reference auto="1" ids="id2" refid="id10">
+        <footnote_reference auto="1" ids="footnote-reference-2" refid="footnote-2">
             2
          should be 2,
-        <footnote_reference ids="id3" refid="id9">
+        <footnote_reference ids="footnote-reference-3" refid="footnote-1">
             1
          is 1, \n\
-        <footnote_reference ids="id4" refid="id11">
+        <footnote_reference ids="footnote-reference-4" refid="footnote-3">
             3
          is 3,
-        <footnote_reference auto="1" ids="id5" refid="id12">
+        <footnote_reference auto="1" ids="footnote-reference-5" refid="footnote-4">
             6
          should be 6, \n\
-        <problematic ids="id15 id6" refid="id14">
+        <problematic ids="problematic-1 footnote-reference-6" refid="system-message-1">
             #_
          is one too many,
-        <footnote_reference auto="1" ids="id7" refname="five">
+        <footnote_reference auto="1" ids="footnote-reference-7" refname="five">
          should be 5, and \n\
-        <footnote_reference auto="1" ids="id8" refname="eight">
+        <footnote_reference auto="1" ids="footnote-reference-8" refname="eight">
          doesn't exist.
-    <footnote backrefs="id3" ids="id9" names="1">
+    <footnote backrefs="footnote-reference-3" ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
             Manually-numbered footnote 1.
-    <footnote auto="1" backrefs="id2" ids="id10" names="2">
+    <footnote auto="1" backrefs="footnote-reference-2" ids="footnote-2" names="2">
         <label>
             2
         <paragraph>
             Auto-numbered footnote 2.
-    <footnote auto="1" backrefs="id1" ids="four" names="four">
+    <footnote auto="1" backrefs="footnote-reference-1" ids="four" names="four">
         <label>
             4
         <paragraph>
             Auto-numbered footnote 4.
-    <footnote backrefs="id4" ids="id11" names="3">
+    <footnote backrefs="footnote-reference-4" ids="footnote-3" names="3">
         <label>
             3
         <paragraph>
@@ -360,20 +381,20 @@
             5
         <paragraph>
             Auto-numbered footnote 5.
-    <footnote auto="1" backrefs="id5" ids="id12" names="6">
+    <footnote auto="1" backrefs="footnote-reference-5" ids="footnote-4" names="6">
         <label>
             6
         <paragraph>
             Auto-numbered footnote 6.
-    <footnote auto="1" dupnames="five" ids="id13">
+    <footnote auto="1" dupnames="five" ids="five-1">
         <label>
             7
-        <system_message backrefs="id13" level="2" line="15" source="test data" type="WARNING">
+        <system_message backrefs="five-1" level="2" line="15" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "five".
         <paragraph>
             Auto-numbered footnote 5 again (duplicate).
-    <system_message backrefs="id15" ids="id14" level="3" line="4" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="4" source="test data" type="ERROR">
         <paragraph>
             Too many autonumbered footnote references: only 2 corresponding footnotes available.
 """,
@@ -386,10 +407,10 @@
 <document source="test data">
     <paragraph>
         Referencing a footnote by symbol \n\
-        <footnote_reference auto="*" ids="id1" refid="id2">
+        <footnote_reference auto="*" ids="footnote-reference-1" refid="footnote-1">
             *
         .
-    <footnote auto="*" backrefs="id1" ids="id2">
+    <footnote auto="*" backrefs="footnote-reference-1" ids="footnote-1">
         <label>
             *
         <paragraph>
@@ -412,102 +433,102 @@
 .. * Auto-symbol footnote 11.
 .. * Auto-symbol footnote 12.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         A sequence of symbol footnote references:
-        <footnote_reference auto="*" ids="id1" refid="id13">
+        <footnote_reference auto="*" ids="footnote-reference-1" refid="footnote-1">
             *
          \n\
-        <footnote_reference auto="*" ids="id2" refid="id14">
+        <footnote_reference auto="*" ids="footnote-reference-2" refid="footnote-2">
             \u2020
          \n\
-        <footnote_reference auto="*" ids="id3" refid="id15">
+        <footnote_reference auto="*" ids="footnote-reference-3" refid="footnote-3">
             \u2021
          \n\
-        <footnote_reference auto="*" ids="id4" refid="id16">
+        <footnote_reference auto="*" ids="footnote-reference-4" refid="footnote-4">
             \u00A7
          \n\
-        <footnote_reference auto="*" ids="id5" refid="id17">
+        <footnote_reference auto="*" ids="footnote-reference-5" refid="footnote-5">
             \u00B6
          \n\
-        <footnote_reference auto="*" ids="id6" refid="id18">
+        <footnote_reference auto="*" ids="footnote-reference-6" refid="footnote-6">
             #
          \n\
-        <footnote_reference auto="*" ids="id7" refid="id19">
+        <footnote_reference auto="*" ids="footnote-reference-7" refid="footnote-7">
             \u2660
          \n\
-        <footnote_reference auto="*" ids="id8" refid="id20">
+        <footnote_reference auto="*" ids="footnote-reference-8" refid="footnote-8">
             \u2665
          \n\
-        <footnote_reference auto="*" ids="id9" refid="id21">
+        <footnote_reference auto="*" ids="footnote-reference-9" refid="footnote-9">
             \u2666
          \n\
-        <footnote_reference auto="*" ids="id10" refid="id22">
+        <footnote_reference auto="*" ids="footnote-reference-10" refid="footnote-10">
             \u2663
          \n\
-        <footnote_reference auto="*" ids="id11" refid="id23">
+        <footnote_reference auto="*" ids="footnote-reference-11" refid="footnote-11">
             **
          \n\
-        <footnote_reference auto="*" ids="id12" refid="id24">
+        <footnote_reference auto="*" ids="footnote-reference-12" refid="footnote-12">
             \u2020\u2020
         .
-    <footnote auto="*" backrefs="id1" ids="id13">
+    <footnote auto="*" backrefs="footnote-reference-1" ids="footnote-1">
         <label>
             *
         <paragraph>
             Auto-symbol footnote 1.
-    <footnote auto="*" backrefs="id2" ids="id14">
+    <footnote auto="*" backrefs="footnote-reference-2" ids="footnote-2">
         <label>
             \u2020
         <paragraph>
             Auto-symbol footnote 2.
-    <footnote auto="*" backrefs="id3" ids="id15">
+    <footnote auto="*" backrefs="footnote-reference-3" ids="footnote-3">
         <label>
             \u2021
         <paragraph>
             Auto-symbol footnote 3.
-    <footnote auto="*" backrefs="id4" ids="id16">
+    <footnote auto="*" backrefs="footnote-reference-4" ids="footnote-4">
         <label>
             \u00A7
         <paragraph>
             Auto-symbol footnote 4.
-    <footnote auto="*" backrefs="id5" ids="id17">
+    <footnote auto="*" backrefs="footnote-reference-5" ids="footnote-5">
         <label>
             \u00B6
         <paragraph>
             Auto-symbol footnote 5.
-    <footnote auto="*" backrefs="id6" ids="id18">
+    <footnote auto="*" backrefs="footnote-reference-6" ids="footnote-6">
         <label>
             #
         <paragraph>
             Auto-symbol footnote 6.
-    <footnote auto="*" backrefs="id7" ids="id19">
+    <footnote auto="*" backrefs="footnote-reference-7" ids="footnote-7">
         <label>
             \u2660
         <paragraph>
             Auto-symbol footnote 7.
-    <footnote auto="*" backrefs="id8" ids="id20">
+    <footnote auto="*" backrefs="footnote-reference-8" ids="footnote-8">
         <label>
             \u2665
         <paragraph>
             Auto-symbol footnote 8.
-    <footnote auto="*" backrefs="id9" ids="id21">
+    <footnote auto="*" backrefs="footnote-reference-9" ids="footnote-9">
         <label>
             \u2666
         <paragraph>
             Auto-symbol footnote 9.
-    <footnote auto="*" backrefs="id10" ids="id22">
+    <footnote auto="*" backrefs="footnote-reference-10" ids="footnote-10">
         <label>
             \u2663
         <paragraph>
             Auto-symbol footnote 10.
-    <footnote auto="*" backrefs="id11" ids="id23">
+    <footnote auto="*" backrefs="footnote-reference-11" ids="footnote-11">
         <label>
             **
         <paragraph>
             Auto-symbol footnote 11.
-    <footnote auto="*" backrefs="id12" ids="id24">
+    <footnote auto="*" backrefs="footnote-reference-12" ids="footnote-12">
         <label>
             \u2020\u2020
         <paragraph>
@@ -524,15 +545,15 @@
 <document source="test data">
     <paragraph>
         Duplicate manual footnote labels:
-    <footnote dupnames="1" ids="id1">
+    <footnote dupnames="1" ids="footnote-1">
         <label>
             1
         <paragraph>
             Footnote.
-    <footnote dupnames="1" ids="id2">
+    <footnote dupnames="1" ids="footnote-2">
         <label>
             1
-        <system_message backrefs="id2" level="2" line="5" source="test data" type="WARNING">
+        <system_message backrefs="footnote-2" level="2" line="5" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "1".
         <paragraph>
@@ -542,5 +563,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_hyperlinks.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_hyperlinks.py Changed

@@ -1,28 +1,49 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_hyperlinks.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_hyperlinks.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.references.Hyperlinks.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
 from docutils.transforms.references import PropagateTargets, \
      AnonymousHyperlinks, IndirectHyperlinks, ExternalTargets, \
      InternalTargets, DanglingReferences
-from docutils.parsers.rst import Parser
-
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -30,9 +51,8 @@
 # target/reference, direct/indirect, internal/external, and named/anonymous,
 # plus embedded URIs.
 totest'exhaustive_hyperlinks' = ((PropagateTargets, AnonymousHyperlinks,
-                                    IndirectHyperlinks,
-                                    ExternalTargets, InternalTargets,
-                                    DanglingReferences), 
+                                    IndirectHyperlinks, ExternalTargets,
+                                    InternalTargets, DanglingReferences), 
 """\
 direct_ external
 
@@ -141,13 +161,13 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             circular_
          indirect reference
     <target ids="circular" names="circular" refid="circular">
-    <problematic ids="id3 indirect" names="indirect" refid="id1">
+    <problematic ids="problematic-2 indirect" names="indirect" refid="system-message-1">
         .. _indirect: circular_
-    <system_message backrefs="id2 id3" ids="id1" level="3" line="3" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1 problematic-2" ids="system-message-1" level="3" line="3" source="test data" type="ERROR">
         <paragraph>
             Indirect hyperlink target "circular" (id="circular") refers to target "indirect", forming a circular reference.
 """,
@@ -173,25 +193,25 @@
             Implicit
         <paragraph>
             Duplicate implicit targets.
-    <section dupnames="implicit" ids="id1">
+    <section dupnames="implicit" ids="implicit-1">
         <title>
             Implicit
-        <system_message backrefs="id1" level="1" line="7" source="test data" type="INFO">
+        <system_message backrefs="implicit-1" level="1" line="7" source="test data" type="INFO">
             <paragraph>
                 Duplicate implicit target name: "implicit".
         <paragraph>
-            <problematic ids="id3" refid="id2">
+            <problematic ids="problematic-1" refid="system-message-1">
                 indirect_
              internal
         <target ids="indirect" names="indirect" refname="implicit">
         <paragraph>
-            Direct internal reference: 
-            <problematic ids="id5" refid="id4">
+            Direct internal reference: \n\
+            <problematic ids="problematic-2" refid="system-message-2">
                 Implicit_
-    <system_message backrefs="id3" ids="id2" level="3" line="11" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="11" source="test data" type="ERROR">
         <paragraph>
             Indirect hyperlink target "indirect" (id="indirect") refers to target "implicit", which is a duplicate, and cannot be used as a unique reference.
-    <system_message backrefs="id5" ids="id4" level="3" line="13" source="test data" type="ERROR">
+    <system_message backrefs="problematic-2" ids="system-message-2" level="3" line="13" source="test data" type="ERROR">
         <paragraph>
             Duplicate target name, cannot be used as a unique reference: "implicit".
 """,
@@ -205,7 +225,7 @@
     <paragraph>
         <reference anonymous="1" name="direct external" refuri="http://direct">
             direct external
-    <target anonymous="1" ids="id1" refuri="http://direct">
+    <target anonymous="1" ids="target-1" refuri="http://direct">
 """,
 """\
 `indirect external`__
@@ -218,7 +238,7 @@
     <paragraph>
         <reference anonymous="1" name="indirect external" refuri="http://indirect">
             indirect external
-    <target anonymous="1" ids="id1" refuri="http://indirect">
+    <target anonymous="1" ids="target-1" refuri="http://indirect">
     <target ids="xtarget" names="xtarget" refuri="http://indirect">
 """,
 """\
@@ -228,9 +248,9 @@
 """,
 """\
 <document source="test data">
-    <target anonymous="1" refid="id1">
-    <paragraph ids="id1">
-        <reference anonymous="1" name="direct internal" refid="id1">
+    <target anonymous="1" refid="target-1">
+    <paragraph ids="target-1">
+        <reference anonymous="1" name="direct internal" refid="target-1">
             direct internal
 """,
 """\
@@ -246,7 +266,7 @@
     <paragraph ids="ztarget" names="ztarget">
         <reference anonymous="1" name="indirect internal" refid="ztarget">
             indirect internal
-    <target anonymous="1" ids="id1" refid="ztarget">
+    <target anonymous="1" ids="target-1" refid="ztarget">
 """,
 """\
 .. _ztarget:
@@ -266,19 +286,19 @@
     <target dupnames="ztarget" refid="ztarget">
     <paragraph ids="ztarget">
         First
-    <system_message backrefs="id1" level="2" line="5" source="test data" type="WARNING">
+    <system_message backrefs="ztarget-1" level="2" line="5" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "ztarget".
-    <target dupnames="ztarget" refid="id1">
-    <paragraph ids="id1">
+    <target dupnames="ztarget" refid="ztarget-1">
+    <paragraph ids="ztarget-1">
         Second
     <paragraph>
-        <problematic ids="id4" refid="id3">
+        <problematic ids="problematic-1" refid="system-message-1">
             `indirect internal`__
-    <target anonymous="1" ids="id2" refname="ztarget">
-    <system_message backrefs="id4" ids="id3" level="3" line="11" source="test data" type="ERROR">
+    <target anonymous="1" ids="target-1" refname="ztarget">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="11" source="test data" type="ERROR">
         <paragraph>
-            Indirect hyperlink target (id="id2") refers to target "ztarget", which is a duplicate, and cannot be used as a unique reference.
+            Indirect hyperlink target (id="target-1") refers to target "ztarget", which is a duplicate, and cannot be used as a unique reference.
 """,
 """\
 The next anonymous hyperlink reference is parsed (and discarded) at
@@ -308,7 +328,7 @@
     <paragraph>
         <reference anonymous="1" name="hyperlink" refuri="URL">
             hyperlink
-    <target anonymous="1" ids="id1" refuri="URL">
+    <target anonymous="1" ids="target-1" refuri="URL">
 """,
 """\
 An `embedded uri <http://direct>`_.
@@ -383,19 +403,19 @@
 <document source="test data">
     <paragraph>
         An \n\
-        <problematic ids="id3" refid="id2">
+        <problematic ids="problematic-1" refid="system-message-2">
             `embedded alias <alias_>`_
         <target names="embedded\\ alias" refname="alias">
          with unknown reference.
-    <system_message ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Indirect hyperlink target "embedded alias"  refers to target "alias", which does not exist.
-    <system_message backrefs="id3" ids="id2" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-2" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown target name: "alias".
     <system_message level="1" line="1" source="test data" type="INFO">
         <paragraph>
-            Hyperlink target "embedded alias" is not referenced.\
+            Hyperlink target "embedded alias" is not referenced.
 """,
 """\
 An embedded URI with trailing underline:
@@ -445,7 +465,7 @@
 """\
 <document source="test data">
     <target ids="target" names="target">
-    <footnote ids="id1" names="1">
+    <footnote ids="footnote-1" names="1">
         <label>
             1
         <paragraph>
@@ -530,7 +550,7 @@
 """\
 <document source="test data">
     <target refid="chained">
-    <target anonymous="1" ids="id1 chained" names="chained" refuri="http://anonymous">
+    <target anonymous="1" ids="target-1 chained" names="chained" refuri="http://anonymous">
     <paragraph>
         <reference anonymous="1" name="Anonymous" refuri="http://anonymous">
             Anonymous
@@ -704,13 +724,13 @@
 """,
 """\
 <document source="test data">
-    <target anonymous="1" ids="id1" refuri="http://full">
-    <target anonymous="1" refid="id2">
-    <target anonymous="1" ids="id3 id2" refuri="http://simplified">
+    <target anonymous="1" ids="target-1" refuri="http://full">
+    <target anonymous="1" refid="target-2">
+    <target anonymous="1" ids="target-3 target-2" refuri="http://simplified">
     <target ids="external" names="external" refuri="http://indirect.external">
-    <target anonymous="1" ids="id4" refuri="http://indirect.external">
-    <target anonymous="1" refid="id5">
-    <paragraph ids="id5">
+    <target anonymous="1" ids="target-4" refuri="http://indirect.external">
+    <target anonymous="1" refid="target-5">
+    <paragraph ids="target-5">
         <reference anonymous="1" name="Full syntax anonymous external hyperlink reference" refuri="http://full">
             Full syntax anonymous external hyperlink reference
         ,
@@ -723,7 +743,7 @@
         <reference anonymous="1" name="indirect anonymous hyperlink reference" refuri="http://indirect.external">
             indirect anonymous hyperlink reference
         ,
-        <reference anonymous="1" name="internal anonymous hyperlink reference" refid="id5">
+        <reference anonymous="1" name="internal anonymous hyperlink reference" refid="target-5">
             internal anonymous hyperlink reference
         .
 """,
@@ -738,15 +758,15 @@
 <document source="test data">
     <paragraph>
         Duplicate external \n\
-        <problematic ids="id3" refid="id2">
+        <problematic ids="problematic-1" refid="system-message-1">
             target_
         's (different URIs):
     <target dupnames="target" ids="target" refuri="first">
-    <system_message backrefs="id1" level="2" line="5" source="test data" type="WARNING">
+    <system_message backrefs="target-1" level="2" line="5" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "target".
-    <target dupnames="target" ids="id1" refuri="second">
-    <system_message backrefs="id3" ids="id2" level="3" line="1" source="test data" type="ERROR">
+    <target dupnames="target" ids="target-1" refuri="second">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Duplicate target name, cannot be used as a unique reference: "target".
 """,
@@ -762,10 +782,10 @@
     <paragraph>
         Duplicate external targets (different URIs) without reference:
     <target dupnames="target" ids="target" refuri="first">
-    <system_message backrefs="id1" level="2" line="5" source="test data" type="WARNING">
+    <system_message backrefs="target-1" level="2" line="5" source="test data" type="WARNING">
         <paragraph>
             Duplicate explicit target name: "target".
-    <target dupnames="target" ids="id1" refuri="second">
+    <target dupnames="target" ids="target-1" refuri="second">
 """,
 """\
 Several__ anonymous__ hyperlinks__, but not enough targets.
@@ -775,17 +795,17 @@
 """\
 <document source="test data">
     <paragraph>
-        <problematic ids="id3" refid="id2">
+        <problematic ids="problematic-1" refid="system-message-1">
             Several__
          \n\
-        <problematic ids="id4" refid="id2">
+        <problematic ids="problematic-2" refid="system-message-1">
             anonymous__
          \n\
-        <problematic ids="id5" refid="id2">
+        <problematic ids="problematic-3" refid="system-message-1">
             hyperlinks__
         , but not enough targets.
-    <target anonymous="1" ids="id1" refuri="http://example.org">
-    <system_message backrefs="id3 id4 id5" ids="id2" level="3" source="test data" type="ERROR">
+    <target anonymous="1" ids="target-1" refuri="http://example.org">
+    <system_message backrefs="problematic-1 problematic-2 problematic-3" ids="system-message-1" level="3" source="test data" type="ERROR">
         <paragraph>
             Anonymous hyperlink mismatch: 3 references but 1 targets.
             See "backrefs" attribute for IDs.
@@ -833,14 +853,14 @@
         <bullet_list>
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="section">
+                    <reference ids="toc-entry-1" refid="section">
                         Section
     <target ids="indirect-reference-to-the-table-of-contents" names="indirect\\ reference\\ to\\ the\\ table\\ of\\ contents" refid="table-of-contents">
     <section ids="section" names="section">
-        <title refid="id1">
+        <title refid="toc-entry-1">
             Section
         <paragraph>
-            Testing an 
+            Testing an \n\
             <reference name="indirect reference to the table of contents" refid="table-of-contents">
                 indirect reference to the table of contents
             .
@@ -896,10 +916,10 @@
 <document source="test data">
     <paragraph>
         Unknown \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             reference_
         .
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Unknown target name: "reference".
 """,
@@ -914,23 +934,23 @@
 <document source="test data">
     <paragraph>
         Duplicate manual footnote labels, with reference (
-        <problematic ids="id1" refid="id4">
+        <problematic ids="footnote-reference-1" refid="system-message-1">
             1_
         ):
-    <footnote dupnames="1" ids="id2">
+    <footnote dupnames="1" ids="footnote-1">
         <label>
             1
         <paragraph>
             Footnote.
-    <footnote dupnames="1" ids="id3">
+    <footnote dupnames="1" ids="footnote-2">
         <label>
             1
-        <system_message backrefs="id3" level="2" line="5" source="test data" type="WARNING">
+        <system_message backrefs="footnote-2" level="2" line="5" source="test data" type="WARNING">
             <paragraph>
                 Duplicate explicit target name: "1".
         <paragraph>
             Footnote.
-    <system_message backrefs="id1" ids="id4" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="footnote-reference-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Duplicate target name, cannot be used as a unique reference: "1".
 """,
@@ -938,5 +958,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_hyperlinks_de.py Added

@@ -0,0 +1,96 @@
+#! /usr/bin/env python3
+
+# $Id: test_hyperlinks_de.py 9277 2022-11-26 23:15:13Z milde $
+# Author: David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+Tests for docutils.transforms.references.Hyperlinks with non-English language.
+"""
+
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
+from docutils.languages import de, get_language
+from docutils.parsers.rst import directives, Parser
+from docutils.transforms.references import (
+         PropagateTargets, AnonymousHyperlinks, IndirectHyperlinks,
+         ExternalTargets, InternalTargets, DanglingReferences)
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def setUp(self):
+        """
+        The "info" system-messages for directive fallbacks are only generated
+        once (the name -> directive mapping is cached in
+        ``docutils.parsers.rst.directives._directives``), so we need to reset
+        the cache before running this test.
+
+        See also https://sourceforge.net/p/docutils/feature-requests/71/
+        """
+        directives._directives.clear()
+        get_language.cache.clear()
+
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.language_code = 'de'
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+
+totest = {}
+
+totest'hyperlinks' = ((PropagateTargets, AnonymousHyperlinks,
+                         IndirectHyperlinks, ExternalTargets,
+                         InternalTargets, DanglingReferences), 
+
+"""\
+Target_ should propagate past the system_message to set "id" on note.
+
+.. _target:
+.. note:: Kurznotiz
+   :name: mynote
+""",
+f"""\
+<document source="test data">
+    <paragraph>
+        <reference name="Target" refid="target">
+            Target
+         should propagate past the system_message to set "id" on note.
+    <target refid="target">
+    <system_message level="1" line="4" source="test data" type="INFO">
+        <paragraph>
+            No directive entry for "note" in module "docutils.parsers.rst.languages.de".
+            Using English fallback for directive "note".
+    <note ids="mynote target" names="mynote target">
+        <paragraph>
+            Kurznotiz
+    <system_message level="1" source="test data" type="INFO">
+        <paragraph>
+            Using {de} for language "de".
+""",
+)
+
+if __name__ == '__main__':
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_messages.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_messages.py Changed

@@ -1,27 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_messages.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_messages.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.universal.Messages.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.universal import Messages
-from docutils.transforms.references import Substitutions
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import Messages, TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -38,7 +58,7 @@
 <document source="test data">
     <paragraph>
         This \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |unknown substitution|
          will generate a system message, thanks to
         the \n\
@@ -55,7 +75,7 @@
     <section classes="system-messages">
         <title>
             Docutils System Messages
-        <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+        <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
             <paragraph>
                 Undefined substitution referenced: "unknown substitution".
 """,
@@ -63,5 +83,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_peps.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_peps.py Changed

@@ -1,26 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_peps.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_peps.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.peps.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.peps import TargetNotes
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.peps import TargetNotes
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -48,14 +69,14 @@
         <reference name="reference" refname="reference">
             reference
          \n\
-        <footnote_reference auto="1" ids="id3" refname="TARGET_NOTE: id2">
+        <footnote_reference auto="1" ids="footnote-reference-1" refname="TARGET_NOTE: footnote-1">
         .
         A "References" section should be generated.
     <target ids="reference" names="reference" refuri="http://www.example.org">
-    <section ids="id1">
+    <section ids="section-1">
         <title>
             References
-        <footnote auto="1" ids="id2" names="TARGET_NOTE:\\ id2">
+        <footnote auto="1" ids="footnote-1" names="TARGET_NOTE:\\ footnote-1">
             <paragraph>
                 <reference refuri="http://www.example.org">
                     http://www.example.org
@@ -63,7 +84,5 @@
 )
 
 
-
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_sectnum.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_sectnum.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_sectnum.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_sectnum.py 9277 2022-11-26 23:15:13Z milde $
 # Authors: David Goodger <goodger@python.org>; Dmitry Jemerov
 # Copyright: This module has been placed in the public domain.
 
@@ -8,20 +8,41 @@
 Tests for `docutils.transforms.parts.SectNum` (via
 `docutils.transforms.universal.LastReaderPending`).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import Substitutions
-from docutils.parsers.rst import Parser
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -45,7 +66,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="title-1" names="title\\ 1">
         <title auto="1">
@@ -83,7 +104,7 @@
 ==============
 Paragraph 1.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="bold-title" names="bold\\ title">
         <title auto="1">
@@ -113,7 +134,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="title-1" names="title\\ 1">
         <title auto="1">
@@ -162,7 +183,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <topic classes="contents" ids="contents" names="contents">
         <title>
@@ -170,49 +191,49 @@
         <bullet_list classes="auto-toc">
             <list_item>
                 <paragraph>
-                    <reference ids="id1" refid="title-1">
+                    <reference ids="toc-entry-1" refid="title-1">
                         <generated classes="sectnum">
                             1\u00a0\u00a0\u00a0
                         Title 1
                 <bullet_list classes="auto-toc">
                     <list_item>
                         <paragraph>
-                            <reference ids="id2" refid="title-2">
+                            <reference ids="toc-entry-2" refid="title-2">
                                 <generated classes="sectnum">
                                     1.1\u00a0\u00a0\u00a0
                                 Title 2
                         <bullet_list>
                             <list_item>
                                 <paragraph>
-                                    <reference ids="id3" refid="title-3">
+                                    <reference ids="toc-entry-3" refid="title-3">
                                         Title 3
                     <list_item>
                         <paragraph>
-                            <reference ids="id4" refid="title-4">
+                            <reference ids="toc-entry-4" refid="title-4">
                                 <generated classes="sectnum">
                                     1.2\u00a0\u00a0\u00a0
                                 Title 4
     <section ids="title-1" names="title\\ 1">
-        <title auto="1" refid="id1">
+        <title auto="1" refid="toc-entry-1">
             <generated classes="sectnum">
                 1\u00a0\u00a0\u00a0
             Title 1
         <paragraph>
             Paragraph 1.
         <section ids="title-2" names="title\\ 2">
-            <title auto="1" refid="id2">
+            <title auto="1" refid="toc-entry-2">
                 <generated classes="sectnum">
                     1.1\u00a0\u00a0\u00a0
                 Title 2
             <paragraph>
                 Paragraph 2.
             <section ids="title-3" names="title\\ 3">
-                <title refid="id3">
+                <title refid="toc-entry-3">
                     Title 3
                 <paragraph>
                     Paragraph 3.
         <section ids="title-4" names="title\\ 4">
-            <title auto="1" refid="id4">
+            <title auto="1" refid="toc-entry-4">
                 <generated classes="sectnum">
                     1.2\u00a0\u00a0\u00a0
                 Title 4
@@ -239,7 +260,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="title-1" names="title\\ 1">
         <title auto="1">
@@ -273,7 +294,7 @@
 """\
 .. sectnum::
    :start: 3
-   
+   \n\
 Title 1
 =======
 Paragraph 1.
@@ -290,7 +311,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="title-1" names="title\\ 1">
         <title auto="1">
@@ -326,7 +347,7 @@
    :prefix: (5.9.
    :suffix: )
    :start: 3
-   
+   \n\
 Title 1
 =======
 Paragraph 1.
@@ -343,7 +364,7 @@
 -------
 Paragraph 4.
 """,
-u"""\
+"""\
 <document source="test data">
     <section ids="title-1" names="title\\ 1">
         <title auto="1">
@@ -378,5 +399,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_smartquotes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_smartquotes.py Changed

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# $Id: test_smartquotes.py 8554 2020-09-04 16:52:11Z milde $
-#
+# $Id: test_smartquotes.py 9321 2023-01-17 15:40:27Z milde $
 # :Copyright: © 2011 Günter Milde.
 # :Maintainer: docutils-develop@lists.sourceforge.net
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
@@ -16,31 +14,88 @@
 """
 Test module for universal.SmartQuotes transform.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport  # before importing docutils!
-from docutils.transforms.universal import SmartQuotes
-from docutils.parsers.rst import Parser
+from pathlib import Path
+import sys
+import unittest
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
-def suite():
-    parser = Parser()
-    settings = {'smart_quotes': True,
-                'trim_footnote_ref_space': True,
-                'report': 2} # TODO: why is this ignored when running as main?
-    s = DocutilsTestSupport.TransformTestSuite(
-        parser, suite_settings=settings)
-    s.generateTests(totest)
-    settings'language_code' = 'de'
-    s.generateTests(totest_de)
-    settings'smart_quotes' = 'alternative'
-    s.generateTests(totest_de_alt)
-    settings'smart_quotes' = True
-    settings'smartquotes_locales' = ('de', u'«»()'), ('nl', u'„”’’')
-    s.generateTests(totest_locales)
-    return s
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.universal import (SmartQuotes, FilterMessages,
+                                           TestMessages)
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.smart_quotes = True
+        settings.trim_footnote_ref_space = True
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+        settings.language_code = 'de'
+        for name, (transforms, cases) in totest_de.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_de{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    # Filter with increased priority: call later, so that
+                    # messages added by `TestMessages` are filtered, too.
+                    document.transformer.add_transform(FilterMessages, 890)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+        settings.smart_quotes = 'alternative'
+        for name, (transforms, cases) in totest_de_alt.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_de_alt{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
+
+        settings.smart_quotes = True
+        settings.smartquotes_locales = ('de', '«»()'), ('nl', '„”’’')
+        for name, (transforms, cases) in totest_locales.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_locales{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
 
 totest = {}
@@ -54,7 +109,7 @@
 "'nested' smart" quotes
 -- and ---also long--- dashes.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Test “smart quotes”, ‘secondary smart quotes’,
@@ -63,7 +118,7 @@
 """,
 r"""Escaped \"ASCII quotes\" and \'secondary ASCII quotes\'.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Escaped "ASCII quotes" and 'secondary ASCII quotes'.
@@ -88,10 +143,10 @@
    f'(x) = df(x)/dx
 
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
-        Do not “educate” quotes 
+        Do not “educate” quotes \n\
         <literal>
             inside "literal" text
          and
@@ -101,10 +156,10 @@
         Keep quotes straight in code and math:
         <literal classes="code">
             print "hello"
-         
+         \n\
         <literal classes="code python">
             print("hello")
-         
+         \n\
         <math>
             1' 12"
         .
@@ -113,7 +168,7 @@
     <math_block xml:space="preserve">
         f'(x) = df(x)/dx
 """,
-u"""\
+"""\
 Closing quotes, if preceded by
 wor"d char's
 or punctuation:"a",'a';'a' (TODO: opening quotes if followed by word-char?).
@@ -138,7 +193,7 @@
 "-", "–", "—", "(", "a", "{"
 '-', '–', '—', '((', '', '{'
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Closing quotes, if preceded by
@@ -176,7 +231,7 @@
 Do not drop characters from intra-word inline markup like
 *re*\\ ``Structured``\\ *Text*.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Quotes and inline-elements:
@@ -213,7 +268,7 @@
             Structured
         <emphasis>
             Text
-        .\
+        .
 """,
 """\
 Do not convert context-character at inline-tag boundaries
@@ -230,7 +285,7 @@
   Do not drop characters from intra-word inline markup like
   *re*\\ ``Structured``\\ *Text*.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Do not convert context-character at inline-tag boundaries
@@ -264,7 +319,7 @@
         ), (
         <literal>
             'string'
-        ), 
+        ), \n\
         <emphasis>
             «\u202fbetont\u202f»
         , «\u202f
@@ -307,7 +362,7 @@
 
 .. * and footnotes
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Docutils escape mechanism uses the backslash:
@@ -335,7 +390,7 @@
         .
     <paragraph>
         Test around inline elements:
-        <footnote_reference auto="*" ids="id1">
+        <footnote_reference auto="*" ids="footnote-reference-1">
     <paragraph>
         <emphasis>
             emphasized
@@ -355,7 +410,7 @@
             O and \n\
             <math>
                 x^2
-        <footnote auto="*" ids="id2">
+        <footnote auto="*" ids="footnote-1">
             <paragraph>
                 and footnotes
 """,
@@ -397,7 +452,7 @@
 
 Alternative German "smart quotes" and 'secondary smart quotes'.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph classes="language-de">
         German „smart quotes“ and ‚secondary smart quotes‘.
@@ -422,7 +477,7 @@
 
 English "smart quotes" and 'secondary smart quotes'.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         German „smart quotes“ and ‚secondary smart quotes‘.
@@ -446,7 +501,7 @@
 
 Romanian "smart quotes" and 'secondary' smart quotes.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Alternative German »smart quotes« and ›secondary smart quotes‹.
@@ -468,7 +523,7 @@
 
 Dutch "smart quotes" and 's Gravenhage (leading apostrophe).
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         German «smart quotes» and (secondary smart quotes).
@@ -479,5 +534,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_strip_comments.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_strip_comments.py Changed

@@ -1,27 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_strip_comments.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_strip_comments.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.universal.StripComments.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.universal import StripComments
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.universal import StripComments, TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.strip_comments = True
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(
-        parser, suite_settings={'strip_comments': 1})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -48,5 +68,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_strip_elements_with_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_strip_elements_with_class.py Changed

@@ -1,27 +1,48 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_strip_elements_with_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_strip_elements_with_class.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Guenter Milde <milde@users.sf.net>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.universal.StripClassesAndElements.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
-from docutils.transforms.universal import StripClassesAndElements
+from docutils.transforms.universal import StripClassesAndElements, TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.strip_elements_with_classes = 'spam', 'no-ham'
+        settings.strip_classes = 'spam', 'noise'
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser,
-            suite_settings={'strip_elements_with_classes': 'spam', 'no-ham',
-                            'strip_classes': 'spam', 'noise'})
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -39,9 +60,9 @@
 
 .. code::
    :class: spam
-   
+   \n\
    print("spam")
-   
+   \n\
 .. image:: spam.jpg
    :class: spam
 
@@ -60,5 +81,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_substitution_expansion_length_limit.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_substitution_expansion_length_limit.py Changed

@@ -1,27 +1,48 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_substitution_expansion_length_limit.py 8565 2020-09-14 10:26:03Z milde $
+# $Id: test_substitution_expansion_length_limit.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.references.Substitutions.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import Substitutions
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        settings.line_length_limit = 80
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser,
-                suite_settings={'line_length_limit': 80})
-    s.generateTests(totest)
-    return s
 
 # pseudoxml representation of the substitution definition content:
 a = '        lol'
@@ -56,10 +77,10 @@
     <paragraph>
         lol
          \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |c|
          continuation text
-    <system_message backrefs="id2" ids="id1" level="3" line="9" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="9" source="test data" type="ERROR">
         <paragraph>
             Substitution definition "c" exceeds the line-length-limit.
 """.format(b, c),
@@ -67,5 +88,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_substitutions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_substitutions.py Changed

@@ -1,26 +1,47 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_substitutions.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_substitutions.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for docutils.transforms.references.Substitutions.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import Substitutions
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.references import Substitutions
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -46,14 +67,14 @@
 <document source="test data">
     <paragraph>
         Here's an \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |unknown|
          substitution.
-    <system_message backrefs="id2" ids="id1" level="3" line="1" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
         <paragraph>
             Undefined substitution referenced: "unknown".
 """,
-u"""\
+"""\
 Substitutions support case differences:
 
 .. |eacute| replace:: \u00E9
@@ -61,7 +82,7 @@
 
 |Eacute|\\t\\ |eacute|, and even |EACUTE|.
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Substitutions support case differences:
@@ -77,7 +98,7 @@
         \u00C9
         .
 """,
-u"""\
+"""\
 Indirect substitution definitions with multiple references:
 
 |substitute| my coke for gin
@@ -87,7 +108,7 @@
 .. |substitute| replace:: |replace|
 .. |replace| replace:: swap
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Indirect substitution definitions with multiple references:
@@ -113,7 +134,7 @@
 
 .. Note:: Note that |.| matches *exactly* one character
 """,
-u"""\
+"""\
 <document source="test data">
     <substitution_definition names="l">
         \xab
@@ -205,31 +226,49 @@
             .. |sub| replace:: |indirect1|
     <paragraph>
         Use \n\
-        <problematic ids="id8" refid="id7">
+        <problematic ids="problematic-4" refid="system-message-4">
             |Sub|
          and \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |indirect1|
          and \n\
-        <problematic ids="id4" refid="id3">
+        <problematic ids="problematic-2" refid="system-message-2">
             |sub|
          again (and \n\
-        <problematic ids="id6" refid="id5">
+        <problematic ids="problematic-3" refid="system-message-3">
             |sub|
          one more time).
-    <system_message backrefs="id2" ids="id1" level="3" line="5" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="5" source="test data" type="ERROR">
         <paragraph>
             Circular substitution definition referenced: "indirect1".
-    <system_message backrefs="id4" ids="id3" level="3" line="5" source="test data" type="ERROR">
+    <system_message backrefs="problematic-2" ids="system-message-2" level="3" line="5" source="test data" type="ERROR">
         <paragraph>
             Circular substitution definition referenced: "sub".
-    <system_message backrefs="id6" ids="id5" level="3" line="5" source="test data" type="ERROR">
+    <system_message backrefs="problematic-3" ids="system-message-3" level="3" line="5" source="test data" type="ERROR">
         <paragraph>
             Circular substitution definition referenced: "sub".
-    <system_message backrefs="id8" ids="id7" level="3" line="5" source="test data" type="ERROR">
+    <system_message backrefs="problematic-4" ids="system-message-4" level="3" line="5" source="test data" type="ERROR">
         <paragraph>
             Circular substitution definition referenced: "Sub".
 """,
+"""\
+Substitution reference with |reference-in-content|.
+
+.. |reference-in-content| replace:: text and hyperlink-reference_
+""",
+"""\
+<document source="test data">
+    <paragraph>
+        Substitution reference with \n\
+        text and \n\
+        <reference name="hyperlink-reference" refname="hyperlink-reference">
+            hyperlink-reference
+        .
+    <substitution_definition names="reference-in-content">
+        text and \n\
+        <reference name="hyperlink-reference" refname="hyperlink-reference">
+            hyperlink-reference
+""",
 )
 
 totest'unicode' = ((Substitutions,), 
@@ -243,7 +282,7 @@
 .. |bne| unicode:: U0003D U020E5
 .. |Omega| unicode:: U+003A9
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Insert an em-dash (
@@ -280,7 +319,7 @@
 .. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122
    .. with trademark sign
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Testing comments and extra text.
@@ -308,7 +347,7 @@
 .. |rarrow| unicode:: U+2192
    :rtrim:
 """,
-u"""\
+"""\
 <document source="test data">
     <paragraph>
         Insert an em-dash
@@ -347,9 +386,9 @@
             .. |target| replace:: _`target`
     <paragraph>
         Make sure this substitution definition is not registered: \n\
-        <problematic ids="id2" refid="id1">
+        <problematic ids="problematic-1" refid="system-message-1">
             |target|
-    <system_message backrefs="id2" ids="id1" level="3" line="5" source="test data" type="ERROR">
+    <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="5" source="test data" type="ERROR">
         <paragraph>
             Undefined substitution referenced: "target".
 """,
@@ -357,5 +396,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_target_notes.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_target_notes.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_target_notes.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_target_notes.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,22 +8,43 @@
 Tests for `docutils.transforms.references.TargetNotes` (via
 `docutils.transforms.universal.LastReaderPending`).
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport
-from docutils.transforms.references import PropagateTargets, \
-     AnonymousHyperlinks, IndirectHyperlinks, ExternalTargets, \
-     InternalTargets, DanglingReferences, Footnotes
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser
+from docutils.transforms.references import (PropagateTargets, AnonymousHyperlinks,
+                                            IndirectHyperlinks, ExternalTargets,
+                                            InternalTargets, DanglingReferences)
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
 
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -47,9 +68,9 @@
         <reference name="target" refuri="http://example.org">
             target
          \n\
-        <footnote_reference auto="1" ids="id2" refid="id1">
+        <footnote_reference auto="1" ids="footnote-reference-1" refid="footnote-1">
         .
-    <footnote auto="1" ids="id1" names="TARGET_NOTE:\\ id1">
+    <footnote auto="1" ids="footnote-1" names="TARGET_NOTE:\\ footnote-1">
         <paragraph>
             <reference refuri="http://example.org">
                 http://example.org
@@ -70,9 +91,9 @@
             target
         <inline classes="custom">
              \n\
-        <footnote_reference auto="1" classes="custom" ids="id2" refid="id1">
+        <footnote_reference auto="1" classes="custom" ids="footnote-reference-1" refid="footnote-1">
         .
-    <footnote auto="1" ids="id1" names="TARGET_NOTE:\\ id1">
+    <footnote auto="1" ids="footnote-1" names="TARGET_NOTE:\\ footnote-1">
         <paragraph>
             <reference refuri="http://example.org">
                 http://example.org
@@ -81,5 +102,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_transitions.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_transitions.py Changed

@@ -1,26 +1,46 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_transitions.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_transitions.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for misc.Transitions transform.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
-from docutils.transforms.misc import Transitions
-from docutils.parsers.rst import Parser
+from pathlib import Path
+import sys
+import unittest
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms.misc import Transitions
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
 
 totest = {}
@@ -175,7 +195,7 @@
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
@@ -306,5 +326,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_transforms/test_writer_aux.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_transforms/test_writer_aux.py Changed

@@ -1,57 +1,50 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_writer_aux.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_writer_aux.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test module for writer_aux transforms.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
-from docutils.transforms import writer_aux
-from docutils.parsers.rst import Parser
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
 
-def suite():
-    parser = Parser()
-    s = DocutilsTestSupport.TransformTestSuite(parser)
-    s.generateTests(totest)
-    return s
+from docutils.frontend import get_default_settings
+from docutils.parsers.rst import Parser
+from docutils.transforms import writer_aux
+from docutils.transforms.universal import TestMessages
+from docutils.utils import new_document
+
+
+class TransformTestCase(unittest.TestCase):
+    def test_transforms(self):
+        parser = Parser()
+        settings = get_default_settings(Parser)
+        settings.warning_stream = ''
+        for name, (transforms, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    document = new_document('test data', settings.copy())
+                    parser.parse(case_input, document)
+                    # Don't do a ``populate_from_components()`` because that
+                    # would enable the Transformer's default transforms.
+                    document.transformer.add_transforms(transforms)
+                    document.transformer.add_transform(TestMessages)
+                    document.transformer.apply_transforms()
+                    output = document.pformat()
+                    self.assertEqual(output, case_expected)
 
 
 totest = {}
 
-totest'compound' = ((writer_aux.Compound,), 
-"""\
-.. class:: compound
-
-.. compound::
-
-   .. class:: paragraph1
-
-   Paragraph 1.
-
-   .. class:: paragraph2
-
-   Paragraph 2.
-
-       Block quote.
-""",
-"""\
-<document source="test data">
-    <paragraph classes="paragraph1 compound">
-        Paragraph 1.
-    <paragraph classes="paragraph2 continued">
-        Paragraph 2.
-    <block_quote classes="continued">
-        <paragraph>
-            Block quote.
-""",
-)
-
 totest'admonitions' = ((writer_aux.Admonitions,), 
 """\
 .. note::
@@ -87,5 +80,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_traversals.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_traversals.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_traversals.py 7463 2012-06-22 19:49:51Z milde $
+# $Id: test_traversals.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Martin Blais <blais@furius.ca>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,12 +8,17 @@
 Test module for traversals.
 """
 
+from pathlib import Path
+import sys
 import unittest
-import DocutilsTestSupport              # must be imported before docutils
-from docutils import nodes, core, io, utils, writers
-from docutils.writers.null import Writer as NullWriter
-import docutils
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+import docutils
+from docutils import core, nodes, writers
 
 
 stop_traversal_input = '''
@@ -23,7 +28,7 @@
 
 Happily, happily going by train.
 
-.. attention:: Attention, attention.  This is a public annoucement.  
+.. attention:: Attention, attention.  This is a public annoucement.
                You must get off the train now.
 
 KaZoom! Train crashes.
@@ -32,6 +37,7 @@
 
 '''
 
+
 class AttentiveVisitor(nodes.SparseNodeVisitor):
 
     def visit_attention(self, node):
@@ -41,6 +47,7 @@
         raise RuntimeError("It's too late for attention, "
                            "more discipline is needed!.")
 
+
 class AttentiveWriter(writers.Writer):
 
     def translate(self):
@@ -50,6 +57,7 @@
         self.document.walkabout(visitor)
         self.document.walk(visitor)
 
+
 class StopTraversalTests(unittest.TestCase, docutils.SettingsSpec):
 
     """
@@ -58,19 +66,18 @@
     """
     def test_stop_traversal(self):
         # Load some document tree in memory.
-        doctree = docutils.core.publish_doctree(
+        doctree = core.publish_doctree(
             source=stop_traversal_input,
             reader_name='standalone',
             parser_name='restructuredtext',
             settings_spec=self)
         self.assertTrue(isinstance(doctree, nodes.document))
 
-        parts = docutils.core.publish_parts(
-           reader_name='doctree', source_class=docutils.io.DocTreeInput,
-           source=doctree, source_path='test',
-           writer=AttentiveWriter())
+        core.publish_parts(
+            reader_name='doctree', source_class=docutils.io.DocTreeInput,
+            source=doctree, source_path='test',
+            writer=AttentiveWriter())
 
 
 if __name__ == '__main__':
     unittest.main()
-

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_utils.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_utils.py Changed

@@ -1,7 +1,6 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
+#! /usr/bin/env python3
 
-# $Id: test_utils.py 8529 2020-07-18 14:43:20Z milde $
+# $Id: test_utils.py 9323 2023-01-17 17:20:12Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -9,17 +8,21 @@
 Test module for utils/__init__.py.
 """
 
+from io import StringIO
 import os
+from pathlib import Path
 import sys
 import unittest
 
-from DocutilsTestSupport import docutils, utils, nodes
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+import docutils
+from docutils import utils, nodes
 
-if sys.version_info >= (3, 0):
-    from io import StringIO
-    unicode = str
-else:
-    from StringIO import StringIO
+TEST_ROOT = Path(__file__).parent  # ./test/ from the docutils root
 
 
 class ReporterTests(unittest.TestCase):
@@ -39,7 +42,7 @@
         debug output
 """)
         self.assertEqual(self.stream.getvalue(),
-                          'test data:: (DEBUG/0) debug output\n')
+                         'test data:: (DEBUG/0) debug output\n')
 
     def test_level1(self):
         sw = self.reporter.system_message(1, 'a little reminder')
@@ -58,7 +61,7 @@
         a warning
 """)
         self.assertEqual(self.stream.getvalue(),
-                          'test data:: (WARNING/2) a warning\n')
+                         'test data:: (WARNING/2) a warning\n')
 
     def test_level3(self):
         sw = self.reporter.system_message(3, 'an error')
@@ -68,18 +71,18 @@
         an error
 """)
         self.assertEqual(self.stream.getvalue(),
-                          'test data:: (ERROR/3) an error\n')
+                         'test data:: (ERROR/3) an error\n')
 
     def test_level4(self):
-        self.assertRaises(utils.SystemMessage, self.reporter.system_message, 4,
-                          'a severe error, raises an exception')
+        with self.assertRaises(utils.SystemMessage):
+            self.reporter.system_message(
+                4, 'a severe error, raises an exception')
         self.assertEqual(self.stream.getvalue(), 'test data:: (SEVERE/4) '
-                          'a severe error, raises an exception\n')
-
+                         'a severe error, raises an exception\n')
 
     def test_unicode_message(self):
-        sw = self.reporter.system_message(0, u'mesidʒ')
-        self.assertEqual(sw.pformat(), u"""\
+        sw = self.reporter.system_message(0, 'mesidʒ')
+        self.assertEqual(sw.pformat(), """\
 <system_message level="0" source="test data" type="DEBUG">
     <paragraph>
         mesidʒ
@@ -90,15 +93,16 @@
         unicode(<exception instance>) uses __str__
         and hence fails with unicode message"""
         try:
-            raise Exception(u'mesidʒ')
+            raise Exception('mesidʒ')
         except Exception as err:
             sw = self.reporter.system_message(0, err)
-            self.assertEqual(sw.pformat(), u"""\
+            self.assertEqual(sw.pformat(), """\
 <system_message level="0" source="test data" type="DEBUG">
     <paragraph>
         mesidʒ
 """)
 
+
 class QuietReporterTests(unittest.TestCase):
 
     stream = StringIO()
@@ -154,25 +158,23 @@
 class NameValueTests(unittest.TestCase):
 
     def test_extract_name_value(self):
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          '=hello')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello=')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello="')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello="something')
-        self.assertRaises(utils.NameValueError, utils.extract_name_value,
-                          'hello="something"else')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('hello')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('=hello')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('hello=')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('hello="')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('hello="something')
+        with self.assertRaises(utils.NameValueError):
+            utils.extract_name_value('hello="something"else')
         output = utils.extract_name_value(
               """att1=val1 att2=val2 att3="value number '3'" att4=val4""")
         self.assertEqual(output, ('att1', 'val1'), ('att2', 'val2'),
-                                   ('att3', "value number '3'"),
-                                   ('att4', 'val4'))
+                                  ('att3', "value number '3'"),
+                                  ('att4', 'val4'))
 
 
 class ExtensionOptionTests(unittest.TestCase):
@@ -186,11 +188,11 @@
               utils.assemble_option_dict(input, self.optionspec),
               {'a': 1, 'bbb': 2.0, 'cdef': ('hol%s' % chr(224))})
         input = utils.extract_name_value('a=1 b=2.0 c=hol%s' % chr(224))
-        self.assertRaises(KeyError, utils.assemble_option_dict,
-                          input, self.optionspec)
+        with self.assertRaises(KeyError):
+            utils.assemble_option_dict(input, self.optionspec)
         input = utils.extract_name_value('a=1 bbb=two cdef=hol%s' % chr(224))
-        self.assertRaises(ValueError, utils.assemble_option_dict,
-                          input, self.optionspec)
+        with self.assertRaises(ValueError):
+            utils.assemble_option_dict(input, self.optionspec)
 
     def test_extract_extension_options(self):
         field_list = nodes.field_list()
@@ -202,40 +204,37 @@
               nodes.field_body('', nodes.paragraph('', '2.0')))
         field_list += nodes.field(
               '', nodes.field_name('', 'cdef'),
-              nodes.field_body('', nodes.paragraph('', u'hol\u00e0')))
+              nodes.field_body('', nodes.paragraph('', 'hol\u00e0')))
         field_list += nodes.field(
               '', nodes.field_name('', 'empty'), nodes.field_body())
         self.assertEqual(
               utils.extract_extension_options(field_list, self.optionspec),
               {'a': 1, 'bbb': 2.0,
-               'cdef': u'hol\u00e0',
+               'cdef': 'hol\u00e0',
                'empty': None})
-        self.assertRaises(KeyError, utils.extract_extension_options,
-                          field_list, {})
+        with self.assertRaises(KeyError):
+            utils.extract_extension_options(field_list, {})
         field_list += nodes.field(
               '', nodes.field_name('', 'cdef'),
               nodes.field_body('', nodes.paragraph('', 'one'),
                                nodes.paragraph('', 'two')))
-        self.assertRaises(utils.BadOptionDataError,
-                          utils.extract_extension_options,
-                          field_list, self.optionspec)
+        with self.assertRaises(utils.BadOptionDataError):
+            utils.extract_extension_options(field_list, self.optionspec)
         field_list-1 = nodes.field(
               '', nodes.field_name('', 'cdef bad'),
               nodes.field_body('', nodes.paragraph('', 'no arguments')))
-        self.assertRaises(utils.BadOptionError,
-                          utils.extract_extension_options,
-                          field_list, self.optionspec)
+        with self.assertRaises(utils.BadOptionError):
+            utils.extract_extension_options(field_list, self.optionspec)
         field_list-1 = nodes.field(
               '', nodes.field_name('', 'cdef'),
               nodes.field_body('', nodes.paragraph('', 'duplicate')))
-        self.assertRaises(utils.DuplicateOptionError,
-                          utils.extract_extension_options,
-                          field_list, self.optionspec)
+        with self.assertRaises(utils.DuplicateOptionError):
+            utils.extract_extension_options(field_list, self.optionspec)
         field_list-2 = nodes.field(
               '', nodes.field_name('', 'unkown'),
               nodes.field_body('', nodes.paragraph('', 'unknown')))
-        self.assertRaises(KeyError, utils.extract_extension_options,
-                          field_list, self.optionspec)
+        with self.assertRaises(KeyError):
+            utils.extract_extension_options(field_list, self.optionspec)
 
 
 class HelperFunctionTests(unittest.TestCase):
@@ -275,32 +274,55 @@
                          'grc-ibycus-x-altquot', 'grc-ibycus',
                           'grc-x-altquot', 'grc')
 
+    def test_xml_declaration(self):
+        # default is no encoding declaration
+        self.assertEqual(utils.xml_declaration(), '<?xml version="1.0"?>\n')
+        # if an encoding is passed, declare it
+        self.assertEqual(utils.xml_declaration('ISO-8859-2'),
+                         '<?xml version="1.0" encoding="ISO-8859-2"?>\n')
+        # ignore pseudo encoding name "unicode" introduced by
+        # `docutils.io.Output.encode()`
+        self.assertEqual(utils.xml_declaration('Unicode'),
+                         '<?xml version="1.0"?>\n')
+        # ... non-regarding case
+        self.assertEqual(utils.xml_declaration('UNICODE'),
+                         '<?xml version="1.0"?>\n')
+        # allow %s for later interpolation
+        # (used for part 'html_prolog', cf. docs/api/publisher.html)
+        self.assertEqual(utils.xml_declaration('%s'),
+                         '<?xml version="1.0" encoding="%s"?>\n')
+
     def test_column_width(self):
-        self.assertEqual(utils.column_width(u'de'), 2)
-        self.assertEqual(utils.column_width(u'dâ'), 2) # pre-composed
-        self.assertEqual(utils.column_width(u'dâ'), 2) # combining
+        self.assertEqual(utils.column_width('de'), 2)
+        self.assertEqual(utils.column_width('dâ'), 2)  # pre-composed
+        self.assertEqual(utils.column_width('dâ'), 2)  # combining
 
     def test_decode_path(self):
-        strpath = utils.decode_path('späm')
-        unipath = utils.decode_path(u'späm')
+        try:
+            bytes_filename = 'späm'.encode(sys.getfilesystemencoding())
+        except UnicodeEncodeError:
+            bytes_filename = b'spam'
+        bytespath = utils.decode_path(bytes_filename)
+        unipath = utils.decode_path('späm')
         defaultpath = utils.decode_path(None)
-        self.assertEqual(strpath, u'späm')
-        self.assertEqual(unipath, u'späm')
-        self.assertEqual(defaultpath, u'')
-        self.assertTrue(isinstance(strpath, nodes.reprunicode))
-        self.assertTrue(isinstance(unipath, unicode))
-        self.assertTrue(isinstance(defaultpath, unicode))
+        if bytes_filename != b'spam':  # skip if ä cannot be encoded
+            self.assertEqual(bytespath, 'späm')
+        self.assertEqual(unipath, 'späm')
+        self.assertEqual(defaultpath, '')
+        self.assertTrue(isinstance(bytespath, str))
+        self.assertTrue(isinstance(unipath, str))
+        self.assertTrue(isinstance(defaultpath, str))
         self.assertRaises(ValueError, utils.decode_path, 13)
 
     def test_relative_path(self):
         # Build and return a path to `target`, relative to `source`:
         # Use '/' as path sep in result.
         self.assertEqual(utils.relative_path('spam', 'spam'), '')
-        source = os.path.join('h\xE4m', 'spam', 'fileA')
-        target = os.path.join('h\xE4m', 'spam', 'fileB')
+        source = os.path.join('häm', 'spam', 'fileA')
+        target = os.path.join('häm', 'spam', 'fileB')
         self.assertEqual(utils.relative_path(source, target), 'fileB')
-        source = os.path.join('h\xE4m', 'spam', 'fileA')
-        target = os.path.join('h\xE4m', 'fileB')
+        source = os.path.join('häm', 'spam', 'fileA')
+        target = os.path.join('häm', 'fileB')
         self.assertEqual(utils.relative_path(source, target), '../fileB')
         # if source is None, default to the cwd:
         target = os.path.join('eggs', 'fileB')
@@ -312,30 +334,33 @@
         # self.assertEqual(utils.relative_path(source, target),
         #                  os.path.abspath('fileB'))
         # Correctly process unicode instances:
-        self.assertEqual(utils.relative_path(u'spam', u'spam'), u'')
-        source = os.path.join(u'h\xE4m', u'spam', u'fileA')
-        target = os.path.join(u'h\xE4m', u'spam', u'fileB')
-        self.assertEqual(utils.relative_path(source, target), u'fileB')
-        source = os.path.join(u'h\xE4m', u'spam', u'fileA')
-        target = os.path.join(u'h\xE4m', u'fileB')
-        self.assertEqual(utils.relative_path(source, target), u'../fileB')
+        self.assertEqual(utils.relative_path('spam', 'spam'), '')
+        source = os.path.join('häm', 'spam', 'fileA')
+        target = os.path.join('häm', 'spam', 'fileB')
+        self.assertEqual(utils.relative_path(source, target), 'fileB')
+        source = os.path.join('häm', 'spam', 'fileA')
+        target = os.path.join('häm', 'fileB')
+        self.assertEqual(utils.relative_path(source, target), '../fileB')
         # if source is None, default to the cwd:
-        target = os.path.join(u'eggs', u'fileB')
-        self.assertEqual(utils.relative_path(None, target), u'eggs/fileB')
+        target = os.path.join('eggs', 'fileB')
+        self.assertEqual(utils.relative_path(None, target), 'eggs/fileB')
 
     def test_find_file_in_dirs(self):
         # Search for file `path` in the sequence of directories `dirs`.
         # Return the first expansion that matches an existing file.
-        dirs = ('nonex', '.', '..')
-        found = utils.find_file_in_dirs('HISTORY.txt', dirs)
-        # returns
-        # '..\\HISTORY.txt' on windows
-        # '../HISTORY.txt' on other platforms
-        # 'HISTORY.txt' if not called from docutils directory.
-        self.assertTrue(found.startswith('..'), 'HISTORY.txt not found in "..".')
+        dirs = (os.path.join(TEST_ROOT, 'nonex'),
+                TEST_ROOT,
+                os.path.join(TEST_ROOT, '..'))
+        result = utils.find_file_in_dirs('alltests.py', dirs)
+        expected = os.path.join(TEST_ROOT, 'alltests.py').replace('\\', '/')
+        self.assertEqual(result, expected)
+        result = utils.find_file_in_dirs('HISTORY.txt', dirs)
+        expected = (TEST_ROOT / '..' / 'HISTORY.txt').as_posix()
+        self.assertEqual(result, expected)
+        # normalize for second check
+        self.assertTrue(os.path.relpath(result, TEST_ROOT).startswith('..'),
+                        'HISTORY.txt not found in "..".')
         # Return `path` if the file exists in the cwd or if there is no match
-        self.assertEqual(utils.find_file_in_dirs('alltests.py', dirs),
-                         'alltests.py')
         self.assertEqual(utils.find_file_in_dirs('gibts/nicht.txt', dirs),
                          'gibts/nicht.txt')
 
@@ -354,7 +379,37 @@
         self.assertEqual(unescaped, self.unescaped)
         restored = utils.unescape(self.nulled, restore_backslashes=True)
         self.assertEqual(restored, self.escaped)
-  
+
+
+class StylesheetFunctionTests(unittest.TestCase):
+
+    stylesheet_dirs = TEST_ROOT, os.path.join(TEST_ROOT, 'data')
+
+    def test_get_stylesheet_list_stylesheet_path(self):
+        # look for stylesheets in stylesheet_dirs
+        self.stylesheet = None
+        self.stylesheet_path = 'ham.css, missing.css'
+
+        ham_css = os.path.join(TEST_ROOT, 'data', 'ham.css').replace('\\', '/')
+        self.assertEqual(utils.get_stylesheet_list(self),
+                         ham_css, 'missing.css')
+
+    def test_get_stylesheet_list_stylesheet(self):
+        # use stylesheet paths verbatim
+        self.stylesheet = 'ham.css, missing.css'
+        self.stylesheet_path = None
+
+        self.assertEqual(utils.get_stylesheet_list(self),
+                         'ham.css', 'missing.css')
+
+    def test_get_stylesheet_list_conflict(self):
+        # settings "stylesheet_path" and "stylesheet"
+        # must not be used together
+        self.stylesheet = 'ham.css, missing.css'
+        self.stylesheet_path = 'man.css, miss2.css'
+        with self.assertRaises(AssertionError):
+            utils.get_stylesheet_list(self)
+
 
 if __name__ == '__main__':
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_viewlist.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_viewlist.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_viewlist.py 8346 2019-08-26 12:11:32Z milde $
+# $Id: test_viewlist.py 9277 2022-11-26 23:15:13Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -8,8 +8,16 @@
 Test module for the ViewList class from statemachine.py.
 """
 
+from pathlib import Path
+import sys
 import unittest
-from DocutilsTestSupport import statemachine
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents1))
+
+from docutils import statemachine
 
 
 class ViewListTests(unittest.TestCase):
@@ -37,7 +45,7 @@
         self.assertEqual(self.b, self.b_list)
         self.assertEqual(self.c, self.c_list)
         self.assertEqual(len(self.a), len(self.a_list))
-        self.assertTrue('d' in self.a) # __contains__
+        self.assertTrue('d' in self.a)  # __contains__
         self.assertEqual(value for value in self.a, self.a_list)
         # get and set values
         self.assertEqual(self.a2, self.a_list2)
@@ -54,7 +62,7 @@
         self.assertEqual(repr(self.a), "ViewList(%s, items=%s)" %
                          (repr(self.a_list), repr(self.a.items)))
         # `del` also deletes meta-data:
-        del(self.c1)
+        del self.c1
         self.assertEqual(list(self.c.xitems()),
                          ('c', 0, 'X'), ('c', 2, 'Z'))
         # operators with extended behaviour
@@ -190,9 +198,8 @@
       literal
            block"""
 
-
     def setUp(self):
-        self.a_list = self.text.splitlines(1)
+        self.a_list = self.text.splitlines(True)
         self.a = statemachine.StringList(self.a_list, 'a')
 
     def test_trim_left(self):
@@ -202,11 +209,11 @@
 
     def test_get_indented(self):
         self.assertEqual(self.a.get_indented(),
-                          (, 0, 0))
+                         (, 0, 0))
         block = statemachine.StringList(
             statemachine.string2lines(self.indented_string))
         self.assertEqual(block.get_indented(),
-                          (s6: for s in block, 6, 1))
+                         (s6: for s in block, 6, 1))
 
 
 if __name__ == '__main__':

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/__init__.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/__init__.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_docutils_xml.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_docutils_xml.py Changed

@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_docutils_xml.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_docutils_xml.py 9341 2023-04-11 22:22:50Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -13,48 +13,42 @@
    ``<empty></empty>`` vs. ``<empty/>``. The sample strings in this test
    module mirrors the current behaviour of the docutils_xml writer.
 """
-from __future__ import absolute_import
 
-import sys
 
-if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport # before importing docutils!
+import unittest
+
 import docutils
 import docutils.core
 
-if sys.version_info >= (3, 0):
-    from io import StringIO
-else:
-    from StringIO import StringIO
+from io import StringIO
 
 # sample strings
 # --------------
 
-source = u"""\
+source = """\
 Test
 
 ----------
 
 Test. \xe4\xf6\xfc\u20ac"""
 
-xmldecl = u"""<?xml version="1.0" encoding="iso-8859-1"?>
+xmldecl = """<?xml version="1.0" encoding="iso-8859-1"?>
 """
 
-doctypedecl = u"""\
+doctypedecl = """\
 <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net\
 //DTD Docutils Generic//EN//XML"\
  "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
 """
 
-generatedby = u'\n' % docutils.__version__
+generatedby = '\n' % docutils.__version__
 
-bodynormal = u"""\
+bodynormal = """\
 <document source="&lt;string&gt;"><paragraph>Test</paragraph>\
 <transition></transition><paragraph>Test. \xe4\xf6\xfc&#8364;</paragraph>\
 </document>"""
 
-bodynewlines = u"""\
+bodynewlines = """\
 <document source="&lt;string&gt;">
 <paragraph>Test</paragraph>
 <transition></transition>
@@ -62,7 +56,7 @@
 </document>
 """
 
-bodyindents = u"""\
+bodyindents = """\
 <document source="&lt;string&gt;">
     <paragraph>Test</paragraph>
     <transition></transition>
@@ -73,7 +67,7 @@
 # raw XML
 # """""""
 
-raw_xml_source = u"""\
+raw_xml_source = """\
 .. raw:: xml
 
    <root>
@@ -89,7 +83,7 @@
 :xml:`<test>inline raw XML</test>`.
 """
 
-raw_xml = u"""\
+raw_xml = """\
 <document source="&lt;string&gt;">
 <raw format="xml" xml:space="preserve"><root>
  <child>Test \xe4\xf6\xfc&#8364;</child>
@@ -102,7 +96,7 @@
 </document>
 """
 
-invalid_raw_xml_source = u"""\
+invalid_raw_xml_source = """\
 .. raw:: xml
 
    <root>
@@ -115,7 +109,7 @@
 :xml:`<test>inline raw XML&lt;/test>`.
 """
 
-invalid_raw_xml = u"""\
+invalid_raw_xml = """\
 <document source="&lt;string&gt;">
 <raw format="xml" xml:space="preserve"><root>
  <child>Test \xe4\xf6\xfc\u20ac</child>
@@ -127,17 +121,19 @@
 
 
 def publish_xml(settings, source):
-    return docutils.core.publish_string(source=source.encode('utf8'),
-                                        reader_name='standalone',
-                                        writer_name='docutils_xml',
-                                        settings_overrides=settings)
+    return docutils.core.publish_string(source=source,
+                                       reader_name='standalone',
+                                       writer_name='docutils_xml',
+                                       settings_overrides=settings)
+
 
 # XML Test Case
 # -------------
 
-class DocutilsXMLTestCase(DocutilsTestSupport.StandardTestCase):
 
-    settings = {'input_encoding': 'utf8',
+class DocutilsXMLTestCase(unittest.TestCase):
+
+    settings = {'input_encoding': 'utf-8',
                 'output_encoding': 'iso-8859-1',
                 '_disable_config': True,
                 'indents': False,
@@ -151,7 +147,7 @@
         settings'newlines' = False
         for settings'xml_declaration' in True, False:
             for settings'doctype_declaration' in True, False:
-                expected = u''
+                expected = ''
                 if settings'xml_declaration':
                     expected += xmldecl
                 if settings'doctype_declaration':
@@ -189,22 +185,21 @@
                     + invalid_raw_xml).encode('latin1', 'xmlcharrefreplace')
         self.assertEqual(result, expected)
         warnings.seek(0)
-        self.assertEqual(warnings.readlines(),
-            u'<string>:5: '
-             u'(WARNING/2) Invalid raw XML in column 2, line offset 3:\n',
-             u'<root>\n',
-             u' <child>Test \xe4\xf6\xfc\u20ac</child>\n',
-             u'</mismatch>\n',
-             u'<string>:10: '
-             u'(WARNING/2) Invalid raw XML in column 30, line offset 1:\n',
-             u'<test>inline raw XML&lt;/test>\n')
-        # abort with SystemMessage if halt_level is "info":
-        settings'halt_level' = 2
+        self.assertEqual(
+            warnings.readlines(),
+            '<string>:5: '
+             '(WARNING/2) Invalid raw XML in column 2, line offset 3:\n',
+             '<root>\n',
+             ' <child>Test \xe4\xf6\xfc\u20ac</child>\n',
+             '</mismatch>\n',
+             '<string>:10: '
+             '(WARNING/2) Invalid raw XML in column 30, line offset 1:\n',
+             '<test>inline raw XML&lt;/test>\n')
+        settings'halt_level' = 2  # convert info messages to exceptions
         settings'warning_stream' = ''
-        self.assertRaises(docutils.utils.SystemMessage,
-                          publish_xml, settings, invalid_raw_xml_source)
+        with self.assertRaises(docutils.utils.SystemMessage):
+            publish_xml(settings, invalid_raw_xml_source)
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_get_writer_class.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_get_writer_class.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_get_writer_class.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_get_writer_class.py 9277 2022-11-26 23:15:13Z milde $
 # Author: grubert
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -8,30 +8,37 @@
 """
 test get_writer_class
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
-from docutils.writers import get_writer_class
+from pathlib import Path
+import sys
+import unittest
+
+# Prepend the "docutils root" to the Python library path
+# so we import the local `docutils` and `test` packages.
+# Ensure `test` package can be loaded also if not running as __main__
+# (required by ``python -m unittest``
+DOCUTILS_ROOT = Path(__file__).resolve().parents2
+if str(DOCUTILS_ROOT) not in sys.path:
+    sys.path.insert(0, str(DOCUTILS_ROOT))
+
+from docutils.writers import get_writer_class  # noqa: E402
 
 
-class GetWriterClassTestCase(DocutilsTestSupport.StandardTestCase):
-    #tests = ( ('manpage', 1), ('nope', 0), ('dummy-writer', 1))
+class GetWriterClassTestCase(unittest.TestCase):
 
     def test_registered_writer(self):
-        wr = get_writer_class('manpage')
+        get_writer_class('manpage')
         # raises ImportError on failure
 
     def test_bogus_writer(self):
-        self.assertRaises(ImportError,
-                          get_writer_class, 'nope')
+        with self.assertRaises(ImportError):
+            get_writer_class('nope')
 
     def test_local_writer(self):
-        # requires local-writer.py in test directory (testroot)
-        wr = get_writer_class('local-writer')
+        # imports local-writer.py from the test package (added above)
+        get_writer_class('test.local-writer')
+        # raises ImportError on failure
+
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()
-

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_html4css1_misc.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html4css1_misc.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# coding: utf-8
-
-# $Id: test_html4css1_misc.py 8356 2019-08-26 16:44:19Z milde $
+#! /usr/bin/env python3
+# $Id: test_html4css1_misc.py 9369 2023-05-02 23:04:27Z milde $
 # Authors: Lea Wiemann, Dmitry Shachnev, Günter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -9,36 +7,46 @@
 """
 Miscellaneous HTML writer tests.
 """
-from __future__ import absolute_import
 
 import os
+import unittest
 
-from .__init__ import DocutilsTestSupport
 from docutils import core
 
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..'))
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = os.path.join(TEST_ROOT, 'data')
+
+
+def relpath(*parts):
+    return os.path.relpath(os.path.join(*parts), os.getcwd()).replace('\\', '/')
 
-class EncodingTestCase(DocutilsTestSupport.StandardTestCase):
+
+class EncodingTestCase(unittest.TestCase):
 
     def test_xmlcharrefreplace(self):
         # Test that xmlcharrefreplace is the default output encoding
         # error handler.
-        settings_overrides={
+        settings_overrides = {
             'output_encoding': 'latin1',
             'stylesheet': '',
-            '_disable_config': True,}
-        result = core.publish_string(
-            u'EUR = \u20ac', writer_name='html4css1',
-            settings_overrides=settings_overrides)
+            '_disable_config': True,
+            }
+        result = bytes(core.publish_string(
+            'EUR = \u20ac', writer_name='html4css1',
+            settings_overrides=settings_overrides))
         # Encoding a euro sign with latin1 doesn't work, so the
         # xmlcharrefreplace handler is used.
         self.assertIn(b'EUR = &#8364;', result)
 
-class MovingArgsTestCase(DocutilsTestSupport.StandardTestCase):
 
-    settings_overrides={'stylesheet_path': '',
-                        # 'embed_stylesheet': False,
-                        '_disable_config': True,
-                       }
+class MovingArgsTestCase(unittest.TestCase):
+
+    mys = {'stylesheet_path': '',
+           # 'embed_stylesheet': False,
+           '_disable_config': True,
+           }
 
     def test_definition_list_item_classes(self):
         # Do not drop class arguments for the definition list item.
@@ -53,7 +61,7 @@
   second def
 """
         result = core.publish_string(data, writer_name='html4css1',
-                            settings_overrides=self.settings_overrides)
+                                     settings_overrides=self.mys)
         self.assertIn(b'<dt class="for the second item">second term:</dt>',
                       result)
 
@@ -70,74 +78,84 @@
   second def
 """
         result = core.publish_string(data, writer_name='html4css1',
-                            settings_overrides=self.settings_overrides)
+                                     settings_overrides=self.mys)
         self.assertIn(b'<dt id="second-item">second term:</dt>',
                       result)
 
 
-class SettingsTestCase(DocutilsTestSupport.StandardTestCase):
+ham_css = relpath(DATA_ROOT, 'ham.css')
+
+
+class SettingsTestCase(unittest.TestCase):
     data = 'test'
 
     def test_default_stylesheet(self):
         # default style sheet, embedded
-        mysettings = {'_disable_config': True,}
+        mys = {'_disable_config': True}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('Default cascading style sheet '
                       'for the HTML output of Docutils.', styles)
 
     def test_default_stylesheet_linked(self):
         # default style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
 
     def test_math_stylesheet_linked(self):
         # default + math style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_path': 'html4css1.css, math.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_path': 'html4css1.css, math.css'}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
         self.assertIn('docutils/writers/html5_polyglot/math.css', styles)
 
     def test_custom_stylesheet_linked(self):
         # default + custom style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_path': 'html4css1.css, '
-                                         'data/ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_path': 'html4css1.css, '
+               'data/ham.css'}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
         self.assertIn('href="data/ham.css"', styles)
 
     def test_custom_stylesheet_dir(self):
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_dirs': ('../docutils/writers/html4css1/',
-                                          'data'),
-                      'stylesheet_path': 'html4css1.css, ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_dirs': (
+                   os.path.join(TEST_ROOT, '../docutils/writers/html4css1/'),
+                   DATA_ROOT),
+               'stylesheet_path': 'html4css1.css, ham.css'}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
-        if os.path.isdir('../docutils/writers/html4css1/'):
+                                    settings_overrides=mys)'stylesheet'
+        if os.path.isdir(os.path.join(TEST_ROOT, '../docutils/writers/html4css1/')):
             self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
-        self.assertIn('href="data/ham.css"', styles)
+        self.assertIn(f'href="{ham_css}"', styles)
 
     def test_custom_stylesheet_dir_embedded(self):
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': True,
-                      'stylesheet_dirs': ('../docutils/writers/html4css1/',
-                                          'data'),
-                      'stylesheet_path': 'ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': True,
+               'stylesheet_dirs': (
+                   os.path.join(TEST_ROOT, '../docutils/writers/html4css1/'),
+                   DATA_ROOT),
+               'stylesheet_path': 'ham.css'}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('dl.docutils dd {\n  margin-bottom: 0.5em }', styles)
 
-class MathTestCase(DocutilsTestSupport.StandardTestCase):
+
+html4css1_css = relpath(TEST_ROOT, 'functional/input/data/html4css1.css')
+math_css = relpath(TEST_ROOT, 'functional/input/data/math.css')
+
+
+class MathTestCase(unittest.TestCase):
 
     """Attention: This class tests the current implementation of maths support
     which is open to change in future Docutils releases. """
@@ -145,64 +163,63 @@
     mathjax_script = '<script type="text/javascript" src="%s">'
     default_mathjax_url = ('file:/usr/share/javascript/mathjax/MathJax.js'
                            '?config=TeX-AMS_CHTML')
-    custom_mathjax_url = ('/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML')
+    custom_mathjax_url = '/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
     data = ':math:`42`'
 
     def test_math_output_default(self):
         # HTML with math.css stylesheet (since 0.11)
-        mysettings = {'_disable_config': True,}
+        mys = {'_disable_config': True}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('convert LaTeX equations to HTML output.', styles)
 
     def test_math_output_mathjax(self):
         # Explicitly specifying math_output=MathJax, case insensitively
         # use default MathJax URL
-        mysettings = {'_disable_config': True,
-                      'report_level': 3,
-                      'math_output': 'MathJax'}
+        mys = {'_disable_config': True,
+               'report_level': 3,
+               'math_output': 'MathJax'}
         head = core.publish_parts(self.data, writer_name='html4css1',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         self.assertIn(self.mathjax_script % self.default_mathjax_url, head)
 
     def test_math_output_mathjax_custom(self):
         # Customizing MathJax URL
-        mysettings = {'_disable_config': True,
-                      'math_output':
-                      'mathjax %s' % self.custom_mathjax_url}
+        mys = {'_disable_config': True,
+               'math_output':
+               'mathjax %s' % self.custom_mathjax_url}
         head = core.publish_parts(self.data, writer_name='html4css1',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         self.assertIn(self.mathjax_script % self.custom_mathjax_url, head)
 
     def test_math_output_html(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'HTML'}
+        mys = {'_disable_config': True,
+               'math_output': 'HTML'}
         head = core.publish_parts(self.data, writer_name='html4css1',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         # There should be no MathJax script when math_output is not MathJax
         self.assertNotIn('MathJax.js', head)
 
     def test_math_output_html_stylesheet(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'HTML math.css,custom/style.css',
-                      'stylesheet_dirs': ('.', 'functional/input/data'),
-                      'embed_stylesheet': False}
+        mys = {'_disable_config': True,
+               'math_output': 'HTML math.css,custom/style.css',
+               'stylesheet_dirs': (
+                   TEST_ROOT,
+                   os.path.join(TEST_ROOT, 'functional/input/data')),
+               'embed_stylesheet': False}
         styles = core.publish_parts(self.data, writer_name='html4css1',
-            settings_overrides=mysettings)'stylesheet'
-        self.assertEqual(u"""\
-<link rel="stylesheet" href="functional/input/data/html4css1.css" type="text/css" />
-<link rel="stylesheet" href="functional/input/data/math.css" type="text/css" />
+                                    settings_overrides=mys)'stylesheet'
+        self.assertEqual(f"""\
+<link rel="stylesheet" href="{html4css1_css}" type="text/css" />
+<link rel="stylesheet" href="{math_css}" type="text/css" />
 <link rel="stylesheet" href="custom/style.css" type="text/css" />
 """, styles)
 
     def test_math_output_mathjax_no_math(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'MathJax'}
         # There should be no math script when text does not contain math
         head = core.publish_parts('No math.', writer_name='html4css1')'head'
         self.assertNotIn('MathJax', head)
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_html4css1_parts.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html4css1_parts.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_html4css1_parts.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_html4css1_parts.py 9368 2023-04-28 21:26:36Z milde $
 # Author: reggie dugard <reggie@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
@@ -11,105 +11,159 @@
 dictionaries (redundant), along with 'meta' and 'stylesheet' entries with
 standard values, and any entries with empty values.
 """
-from __future__ import absolute_import
-
-if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
-from docutils import core
 
+from pathlib import Path
+import sys
+import unittest
 
-def suite():
-    s = DocutilsTestSupport.HtmlPublishPartsTestSuite()
-    s.generateTests(totest)
-    return s
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+import docutils
+import docutils.core
+
+
+class Html4WriterPublishPartsTestCase(unittest.TestCase):
+
+    """
+    Test case for HTML writer via the publish_parts interface.
+    """
+
+    def test_publish(self):
+        writer_name = 'html4'
+        for name, (settings_overrides, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    parts = docutils.core.publish_parts(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                            'stylesheet': '',
+                            **settings_overrides,
+                        }
+                    )
+                    self.assertEqual(self.format_output(parts), case_expected)
+
+    standard_content_type_template = ('<meta http-equiv="Content-Type"'
+                                      ' content="text/html; charset=%s" />\n')
+    standard_generator_template = (
+        '<meta name="generator"'
+        f' content="Docutils {docutils.__version__}: '
+        f'https://docutils.sourceforge.io/" />\n')
+    standard_html_meta_value = (
+        standard_content_type_template
+        + standard_generator_template)
+    standard_meta_value = standard_html_meta_value % 'utf-8'
+    standard_html_prolog = (
+        '<?xml version="1.0" encoding="%s"?>\n'
+        '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" '
+        '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n')
+
+    def format_output(self, parts):
+        """Minimize & standardize the output."""
+        # remove redundant parts & uninteresting parts:
+        del parts'whole'
+        assert parts'body' == parts'fragment'
+        del parts'body'
+        del parts'body_pre_docinfo'
+        del parts'body_prefix'
+        del parts'body_suffix'
+        del parts'head'
+        del parts'head_prefix'
+        del parts'encoding'
+        del parts'errors'
+        del parts'version'
+        # remove standard portions:
+        parts'meta' = parts'meta'.replace(self.standard_meta_value, '')
+        parts'html_head' = parts'html_head'.replace(
+            self.standard_html_meta_value, '...')
+        parts'html_prolog' = parts'html_prolog'.replace(
+            self.standard_html_prolog, '')
+        return {k: v for k, v in parts.items() if v}
 
 
 totest = {}
 
-totest'Title promotion' = ({'stylesheet_path': '',
-                              'embed_stylesheet': 0}, 
+totest'title_promotion' = ({'stylesheet_path': '',
+                              'embed_stylesheet': False}, 
 """\
 Simple String
 """,
-"""\
-{'fragment': '''<p>Simple String</p>\\n''',
+{'fragment': '''<p>Simple String</p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with *markup*
 """,
-"""\
-{'fragment': '''<p>Simple String with <em>markup</em></p>\\n''',
+{'fragment': '''<p>Simple String with <em>markup</em></p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String with <em>markup</em></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with an even simpler ``inline literal``
 """,
-"""\
-{'fragment': '''<p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>\\n''',
+{'fragment': '''<p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple ``inline\xA0literal`` with NBSP
 """,
-"""\
-{'fragment': '''<p>Simple <tt class="docutils literal">inline&nbsp;literal</tt> with NBSP</p>\\n''',
+{'fragment': '''<p>Simple <tt class="docutils literal">inline&nbsp;literal</tt> with NBSP</p>\n''',
  'html_body': '''<div class="document">
 <p>Simple <tt class="docutils literal">inline&nbsp;literal</tt> with NBSP</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `anonymous reference`__
 
 __ http://www.test.com/test_url
 """,
-"""\
-{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\\n''',
+{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\n''',
  'html_body': '''<div class="document">
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 One paragraph.
 
 Two paragraphs.
 """,
-"""\
 {'fragment': '''<p>One paragraph.</p>
-<p>Two paragraphs.</p>\\n''',
+<p>Two paragraphs.</p>\n''',
  'html_body': '''<div class="document">
 <p>One paragraph.</p>
 <p>Two paragraphs.</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `named reference`_ with stuff in between the
 reference and the target.
 
 .. _`named reference`: http://www.test.com/test_url
 """,
-"""\
 {'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
-reference and the target.</p>\\n''',
+reference and the target.</p>\n''',
  'html_body': '''<div class="document">
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
 reference and the target.</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 +++++
 Title
@@ -130,7 +184,6 @@
 
 And even more stuff
 """,
-"""\
 {'fragment': '''<p>Some stuff</p>
 <div class="section" id="section">
 <h1>Section</h1>
@@ -139,7 +192,7 @@
 <h2>Another Section</h2>
 <p>And even more stuff</p>
 </div>
-</div>\\n''',
+</div>\n''',
  'html_body': '''<div class="document" id="title">
 <h1 class="title">Title</h1>
 <h2 class="subtitle" id="subtitle">Subtitle</h2>
@@ -152,13 +205,13 @@
 <p>And even more stuff</p>
 </div>
 </div>
-</div>\\n''',
- 'html_head': '''...<title>Title</title>\\n''',
- 'html_subtitle': '''<h2 class="subtitle" id="subtitle">Subtitle</h2>\\n''',
- 'html_title': '''<h1 class="title">Title</h1>\\n''',
+</div>\n''',
+ 'html_head': '''...<title>Title</title>\n''',
+ 'html_subtitle': '''<h2 class="subtitle" id="subtitle">Subtitle</h2>\n''',
+ 'html_title': '''<h1 class="title">Title</h1>\n''',
  'subtitle': '''Subtitle''',
- 'title': '''Title'''}
-""",
+ 'title': '''Title'''
+},
 """\
 +++++
 Title
@@ -168,7 +221,6 @@
 
 Some stuff
 """,
-"""\
 {'docinfo': '''<table class="docinfo" frame="void" rules="none">
 <col class="docinfo-name" />
 <col class="docinfo-content" />
@@ -176,8 +228,8 @@
 <tr><th class="docinfo-name">Author:</th>
 <td>me</td></tr>
 </tbody>
-</table>\\n''',
- 'fragment': '''<p>Some stuff</p>\\n''',
+</table>\n''',
+ 'fragment': '''<p>Some stuff</p>\n''',
  'html_body': '''<div class="document" id="title">
 <h1 class="title">Title</h1>
 <table class="docinfo" frame="void" rules="none">
@@ -189,75 +241,70 @@
 </tbody>
 </table>
 <p>Some stuff</p>
-</div>\\n''',
- 'html_head': '''...<title>Title</title>
-<meta name="author" content="me" />\\n''',
- 'html_title': '''<h1 class="title">Title</h1>\\n''',
- 'meta': '''<meta name="author" content="me" />\\n''',
- 'title': '''Title'''}
-"""
+</div>\n''',
+ 'html_head': '''...<meta name="author" content="me" />
+<title>Title</title>\n''',
+ 'html_title': '''<h1 class="title">Title</h1>\n''',
+ 'meta': '''<meta name="author" content="me" />\n''',
+ 'title': '''Title'''
+}
 )
 
-totest'No title promotion' = ({'doctitle_xform' : 0,
+totest'no_title_promotion' = ({'doctitle_xform': False,
                                  'stylesheet_path': '',
-                                 'embed_stylesheet': 0}, 
+                                 'embed_stylesheet': False}, 
 """\
 Simple String
 """,
-"""\
-{'fragment': '''<p>Simple String</p>\\n''',
+{'fragment': '''<p>Simple String</p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with *markup*
 """,
-"""\
-{'fragment': '''<p>Simple String with <em>markup</em></p>\\n''',
+{'fragment': '''<p>Simple String with <em>markup</em></p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String with <em>markup</em></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with an even simpler ``inline literal``
 """,
-"""\
-{'fragment': '''<p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>\\n''',
+{'fragment': '''<p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>\n''',
  'html_body': '''<div class="document">
 <p>Simple String with an even simpler <tt class="docutils literal">inline literal</tt></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `anonymous reference`__
 
 __ http://www.test.com/test_url
 """,
-"""\
-{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\\n''',
+{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\n''',
  'html_body': '''<div class="document">
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `named reference`_ with stuff in between the
 reference and the target.
 
 .. _`named reference`: http://www.test.com/test_url
 """,
-"""\
 {'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
-reference and the target.</p>\\n''',
+reference and the target.</p>\n''',
  'html_body': '''<div class="document">
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
 reference and the target.</p>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 +++++
 Title
@@ -278,7 +325,6 @@
 
 And even more stuff
 """,
-"""\
 {'fragment': '''<div class="section" id="title">
 <h1>Title</h1>
 <div class="section" id="not-a-subtitle">
@@ -293,7 +339,7 @@
 </div>
 </div>
 </div>
-</div>\\n''',
+</div>\n''',
  'html_body': '''<div class="document">
 <div class="section" id="title">
 <h1>Title</h1>
@@ -310,26 +356,25 @@
 </div>
 </div>
 </div>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 * bullet
 * list
 """,
-"""\
 {'fragment': '''<ul class="simple">
 <li>bullet</li>
 <li>list</li>
-</ul>\\n''',
+</ul>\n''',
  'html_body': '''<div class="document">
 <ul class="simple">
 <li>bullet</li>
 <li>list</li>
 </ul>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. table::
    :align: right
@@ -340,11 +385,10 @@
    |  3  |  4  |
    +-----+-----+
 """,
-"""\
 {'fragment': '''<table border="1" class="docutils align-right">
 <colgroup>
-<col width="50%%" />
-<col width="50%%" />
+<col width="50%" />
+<col width="50%" />
 </colgroup>
 <tbody valign="top">
 <tr><td>1</td>
@@ -354,12 +398,12 @@
 <td>4</td>
 </tr>
 </tbody>
-</table>\\n''',
+</table>\n''',
  'html_body': '''<div class="document">
 <table border="1" class="docutils align-right">
 <colgroup>
-<col width="50%%" />
-<col width="50%%" />
+<col width="50%" />
+<col width="50%" />
 </colgroup>
 <tbody valign="top">
 <tr><td>1</td>
@@ -370,9 +414,9 @@
 </tr>
 </tbody>
 </table>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Not a docinfo.
 
@@ -383,7 +427,6 @@
 :simple:
 :field: list
 """,
-"""\
 {'fragment': '''<p>Not a docinfo.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -399,7 +442,7 @@
 <tr class="field"><th class="field-name">field:</th><td class="field-body">list</td>
 </tr>
 </tbody>
-</table>\\n''',
+</table>\n''',
  'html_body': '''<div class="document">
 <p>Not a docinfo.</p>
 <table class="docutils field-list" frame="void" rules="none">
@@ -417,16 +460,15 @@
 </tr>
 </tbody>
 </table>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Not a docinfo.
 
 :This is: a
 :simple field list with loooong field: names
 """,
-"""\
 {'fragment': '''<p>Not a docinfo.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -438,7 +480,7 @@
 <tr class="field"><td>&nbsp;</td><td class="field-body">names</td>
 </tr>
 </tbody>
-</table>\\n''',
+</table>\n''',
  'html_body': '''<div class="document">
 <p>Not a docinfo.</p>
 <table class="docutils field-list" frame="void" rules="none">
@@ -452,12 +494,11 @@
 </tr>
 </tbody>
 </table>
-</div>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</div>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 )
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_html4css1_template.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html4css1_template.py Changed

@@ -1,36 +1,58 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_html4css1_template.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_html4css1_template.py 9369 2023-05-02 23:04:27Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the HTML writer.
 """
-from __future__ import absolute_import
 
+from pathlib import Path
 import os
 import platform
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+import docutils
+from docutils.core import publish_string
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..'))
+
+
+class WriterPublishTestCase(unittest.TestCase):
+    # maxDiff = None
+    def test_publish(self):
+        writer_name = 'html4'
+        template_path = os.path.join(TEST_ROOT, 'data', 'full-template.txt')
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                            'template': template_path,
+                            'stylesheet_path': '/test.css',
+                            'embed_stylesheet': False,
+                        }).decode()
+                    self.assertEqual(output, case_expected)
 
 
-def suite():
-    settings = {'template': os.path.join(DocutilsTestSupport.testroot,
-                                         'data', 'full-template.txt'),
-                'stylesheet_path': '/test.css',
-                'embed_stylesheet': 0,}
-    s = DocutilsTestSupport.PublishTestSuite('html', suite_settings=settings)
-    s.generateTests(totest)
-    return s
-
 if platform.system() == "Windows":
-    drive_prefix = "C:"
+    drive_prefix = os.path.splitdrive(os.getcwd())0
 else:
     drive_prefix = ""
 
+
 totest = {}
 
 totest'template' = 
@@ -51,8 +73,8 @@
 
 Some text.
 """,
-r'''head_prefix = """\
-<?xml version="1.0" encoding="utf-8" ?>
+fr'''head_prefix = """\
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>"""
@@ -60,13 +82,13 @@
 
 head = """\
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
-<title>Document Title</title>
-<meta name="author" content="Me" />"""
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
 
 
 stylesheet = """\
-<link rel="stylesheet" href="%(drive)s/test.css" type="text/css" />"""
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />"""
 
 
 body_prefix = """\
@@ -109,7 +131,7 @@
 
 
 head_prefix = """\
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>"""
@@ -117,13 +139,13 @@
 
 head = """\
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
-<title>Document Title</title>
-<meta name="author" content="Me" />"""
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
 
 
 stylesheet = """\
-<link rel="stylesheet" href="%(drive)s/test.css" type="text/css" />"""
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />"""
 
 
 body_prefix = """\
@@ -186,7 +208,7 @@
 
 meta = """\
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
 <meta name="author" content="Me" />"""
 
 
@@ -198,15 +220,15 @@
 
 
 html_prolog = """\
-<?xml version="1.0" encoding="%%s" ?>
+<?xml version="1.0" encoding="%s"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">"""
 
 
 html_head = """\
-<meta http-equiv="Content-Type" content="text/html; charset=%%s" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
-<title>Document Title</title>
-<meta name="author" content="Me" />"""
+<meta http-equiv="Content-Type" content="text/html; charset=%s" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
 
 
 html_title = """\
@@ -238,11 +260,8 @@
 <hr class="footer" />
 footer text
 </div>"""
-''' % {'version': DocutilsTestSupport.docutils.__version__,
-        'drive': drive_prefix,
-    }
+'''
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_html5_polyglot_misc.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html5_polyglot_misc.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# coding: utf-8
-
-# $Id: test_html5_polyglot_misc.py 8481 2020-01-31 08:17:24Z milde $
+#! /usr/bin/env python3
+# $Id: test_html5_polyglot_misc.py 9369 2023-05-02 23:04:27Z milde $
 # Authors: Lea Wiemann, Dmitry Shachnev, Günter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # Copyright: This module has been placed in the public domain.
@@ -9,38 +7,52 @@
 """
 Miscellaneous HTML writer tests.
 """
-from __future__ import absolute_import
 
 import os
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
 from docutils import core
 
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..'))
+# DATA_ROOT is ./test/data/ from the docutils root
+DATA_ROOT = os.path.join(TEST_ROOT, 'data')
+
+
+def relpath(*parts):
+    return os.path.relpath(os.path.join(*parts), os.getcwd()).replace('\\', '/')
 
-class EncodingTestCase(DocutilsTestSupport.StandardTestCase):
+
+class EncodingTestCase(unittest.TestCase):
 
     def test_xmlcharrefreplace(self):
         # Test that xmlcharrefreplace is the default output encoding
         # error handler.
-        settings_overrides={
+        settings_overrides = {
             'output_encoding': 'latin1',
             'stylesheet': '',
-            '_disable_config': True,}
+            '_disable_config': True}
         result = core.publish_string(
-            u'EUR = \u20ac', writer_name='html5_polyglot',
+            'EUR = \u20ac', writer_name='html5_polyglot',
             settings_overrides=settings_overrides)
         # Encoding a euro sign with latin1 doesn't work, so the
         # xmlcharrefreplace handler is used.
         self.assertIn(b'EUR = &#8364;', result)
 
-class MovingArgsTestCase(DocutilsTestSupport.StandardTestCase):
 
-    settings_overrides={'stylesheet_path': '',
-                        # 'embed_stylesheet': False,
-                        '_disable_config': True,
-                       }
+class MovingArgsTestCase(unittest.TestCase):
+
+    mys = {'stylesheet_path': '',
+           # 'embed_stylesheet': False,
+           '_disable_config': True,
+           }
 
     def test_definition_list_item_classes(self):
         # Do not drop class arguments for the definition list item.
@@ -55,8 +67,8 @@
   second def
 """
         result = core.publish_string(data, writer_name='html5_polyglot',
-                            settings_overrides=self.settings_overrides)
-        self.assertIn(b'<dt class="for the second item">second term:</dt>',
+                                     settings_overrides=self.mys).decode()
+        self.assertIn('<dt class="for the second item">second term:</dt>',
                       result)
 
     def test_definition_list_item_name(self):
@@ -72,74 +84,96 @@
   second def
 """
         result = core.publish_string(data, writer_name='html5_polyglot',
-                            settings_overrides=self.settings_overrides)
-        self.assertIn(b'<dt id="second-item">second term:</dt>',
+                                     settings_overrides=self.mys).decode()
+        self.assertIn('<dt id="second-item">second term:</dt>',
                       result)
 
 
-class SettingsTestCase(DocutilsTestSupport.StandardTestCase):
+ham_css = relpath(DATA_ROOT, 'ham.css')
+
+
+class SettingsTestCase(unittest.TestCase):
     data = 'test'
 
     def test_default_stylesheet(self):
         # default style sheet, embedded
-        mysettings = {'_disable_config': True,}
+        mys = {'_disable_config': True}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('Minimal style sheet '
                       'for the HTML output of Docutils.', styles)
 
     def test_default_stylesheet_linked(self):
         # default style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html5_polyglot/minimal.css', styles)
 
     def test_math_stylesheet_linked(self):
         # default + math style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_path': 'minimal.css, math.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_path': 'minimal.css, math.css'}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html5_polyglot/minimal.css', styles)
         self.assertIn('docutils/writers/html5_polyglot/math.css', styles)
 
     def test_custom_stylesheet_linked(self):
         # default + custom style sheet, linked
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_path': 'minimal.css, '
-                                         'data/ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_path': 'minimal.css, '
+               'data/ham.css'}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('docutils/writers/html5_polyglot/minimal.css', styles)
         self.assertIn('href="data/ham.css"', styles)
 
     def test_custom_stylesheet_dir(self):
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': False,
-                      'stylesheet_dirs': ('../docutils/writers/html5_polyglot/',
-                                          'data'),
-                      'stylesheet_path': 'minimal.css, ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': False,
+               'stylesheet_dirs': (
+                   os.path.join(TEST_ROOT, '../docutils/writers/html5_polyglot/'),
+                   DATA_ROOT),
+               'stylesheet_path': 'minimal.css, ham.css'}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
-        if os.path.isdir('../docutils/writers/html5_polyglot/'):
+                                    settings_overrides=mys)'stylesheet'
+        if os.path.isdir(os.path.join(TEST_ROOT, '../docutils/writers/html5_polyglot/')):
             self.assertIn('docutils/writers/html5_polyglot/minimal.css', styles)
-        self.assertIn('href="data/ham.css"', styles)
+        self.assertIn(f'href="{ham_css}"', styles)
 
     def test_custom_stylesheet_dir_embedded(self):
-        mysettings = {'_disable_config': True,
-                      'embed_stylesheet': True,
-                      'stylesheet_dirs': ('../docutils/writers/html5_polyglot/',
-                                          'data'),
-                      'stylesheet_path': 'ham.css'}
+        mys = {'_disable_config': True,
+               'embed_stylesheet': True,
+               'stylesheet_dirs': (
+                   os.path.join(TEST_ROOT, '../docutils/writers/html5_polyglot/'),
+                   DATA_ROOT),
+               'stylesheet_path': 'ham.css'}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('dl.docutils dd {\n  margin-bottom: 0.5em }', styles)
 
-class MathTestCase(DocutilsTestSupport.StandardTestCase):
+    def test_future_warnings(self):
+        """Warn about deprecated setting name."""
+        my_settings = {'_disable_config': True,
+                       'embed_images': False,
+                       'output_encoding': 'unicode',
+                       }
+        with self.assertWarnsRegex(FutureWarning,
+                                   '"embed_images" will be removed'):
+            core.publish_string('warnings test', writer_name='html5',
+                                settings_overrides=my_settings)
+
+
+minimal_css = relpath(TEST_ROOT, 'functional/input/data/minimal.css')
+plain_css = relpath(TEST_ROOT, 'functional/input/data/plain.css')
+math_css = relpath(TEST_ROOT, 'functional/input/data/math.css')
+
+
+class MathTestCase(unittest.TestCase):
 
     """Attention: This class tests the current implementation of maths support
     which is open to change in future Docutils releases. """
@@ -147,65 +181,64 @@
     mathjax_script = '<script type="text/javascript" src="%s">'
     default_mathjax_url = ('file:/usr/share/javascript/mathjax/MathJax.js'
                            '?config=TeX-AMS_CHTML')
-    custom_mathjax_url = ('/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML')
+    custom_mathjax_url = '/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
     data = ':math:`42`'
 
     def test_math_output_default(self):
         # HTML with math.css stylesheet (since 0.11)
-        mysettings = {'_disable_config': True,}
+        mys = {'_disable_config': True}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-                                  settings_overrides=mysettings)'stylesheet'
+                                    settings_overrides=mys)'stylesheet'
         self.assertIn('convert LaTeX equations to HTML output.', styles)
 
     def test_math_output_mathjax(self):
         # Explicitly specifying math_output=MathJax, case insensitively
         # use default MathJax URL
-        mysettings = {'_disable_config': True,
-                      'report_level': 3,
-                      'math_output': 'MathJax'}
+        mys = {'_disable_config': True,
+               'report_level': 3,
+               'math_output': 'MathJax'}
         head = core.publish_parts(self.data, writer_name='html5_polyglot',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         self.assertIn(self.mathjax_script % self.default_mathjax_url, head)
 
     def test_math_output_mathjax_custom(self):
         # Customizing MathJax URL
-        mysettings = {'_disable_config': True,
-                      'math_output':
-                      'mathjax %s' % self.custom_mathjax_url}
+        mys = {'_disable_config': True,
+               'math_output':
+               'mathjax %s' % self.custom_mathjax_url}
         head = core.publish_parts(self.data, writer_name='html5_polyglot',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         self.assertIn(self.mathjax_script % self.custom_mathjax_url, head)
 
     def test_math_output_html(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'HTML'}
+        mys = {'_disable_config': True,
+               'math_output': 'HTML'}
         head = core.publish_parts(self.data, writer_name='html5_polyglot',
-            settings_overrides=mysettings)'head'
+                                  settings_overrides=mys)'head'
         # There should be no MathJax script when math_output is not MathJax
         self.assertNotIn('MathJax.js', head)
 
     def test_math_output_html_stylesheet(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'HTML math.css,custom/style.css',
-                      'stylesheet_dirs': ('.', 'functional/input/data'),
-                      'embed_stylesheet': False}
+        mys = {'_disable_config': True,
+               'math_output': 'HTML math.css,custom/style.css',
+               'stylesheet_dirs': (
+                   TEST_ROOT,
+                   os.path.join(TEST_ROOT, 'functional/input/data')),
+               'embed_stylesheet': False}
         styles = core.publish_parts(self.data, writer_name='html5_polyglot',
-            settings_overrides=mysettings)'stylesheet'
-        self.assertEqual(u"""\
-<link rel="stylesheet" href="functional/input/data/minimal.css" type="text/css" />
-<link rel="stylesheet" href="functional/input/data/plain.css" type="text/css" />
-<link rel="stylesheet" href="functional/input/data/math.css" type="text/css" />
+                                    settings_overrides=mys)'stylesheet'
+        self.assertEqual(f"""\
+<link rel="stylesheet" href="{minimal_css}" type="text/css" />
+<link rel="stylesheet" href="{plain_css}" type="text/css" />
+<link rel="stylesheet" href="{math_css}" type="text/css" />
 <link rel="stylesheet" href="custom/style.css" type="text/css" />
 """, styles)
 
     def test_math_output_mathjax_no_math(self):
-        mysettings = {'_disable_config': True,
-                      'math_output': 'MathJax'}
         # There should be no math script when text does not contain math
         head = core.publish_parts('No math.', writer_name='html5_polyglot')'head'
         self.assertNotIn('MathJax', head)
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_html5_polyglot_parts.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html5_polyglot_parts.py Changed

@@ -1,6 +1,6 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_html5_polyglot_parts.py 8632 2021-03-09 12:53:57Z milde $
+# $Id: test_html5_polyglot_parts.py 9368 2023-04-28 21:26:36Z milde $
 # Author: reggie dugard <reggie@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
@@ -11,118 +11,165 @@
 dictionaries (redundant), along with 'meta' and 'stylesheet' entries with
 standard values, and any entries with empty values.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport  # before importing docutils!
-from DocutilsTestSupport import (HtmlWriterPublishPartsTestCase,
-                                 HtmlPublishPartsTestSuite)
-from docutils import core, __version__
-
-
-class Html5WriterPublishPartsTestCase(HtmlWriterPublishPartsTestCase):
-    """Test case for HTML5 writer via the publish_parts interface."""
+from pathlib import Path
+import sys
+import unittest
 
-    writer_name = 'html5'
-    standard_content_type_template = ('<meta charset="%s"/>\n')
-    standard_generator_template = ('<meta name="generator"'
-        ' content="Docutils %s: http://docutils.sourceforge.net/" />\n')
-    standard_viewport_template = ('<meta name="viewport"'
-        ' content="width=device-width, initial-scale=1" />\n')
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+import docutils
+import docutils.core
+
+
+class Html5WriterPublishPartsTestCase(unittest.TestCase):
+    """Test case for HTML writer via the publish_parts interface."""
+
+    # maxDiff = None
+
+    def test_publish(self):
+        writer_name = 'html5'
+        for name, (settings_overrides, cases) in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    parts = docutils.core.publish_parts(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                            'stylesheet': '',
+                            'section_self_link': True,
+                            **settings_overrides,
+                        }
+                    )
+                    self.assertEqual(self.format_output(parts), case_expected)
+
+    standard_content_type_template = '<meta charset="%s" />\n'
+    standard_generator_template = '<meta name="generator"' \
+        f' content="Docutils {docutils.__version__}: ' \
+        'https://docutils.sourceforge.io/" />\n'
+    standard_viewport_template = '<meta name="viewport"' \
+        ' content="width=device-width, initial-scale=1" />\n'
 
     standard_html_meta_value = (standard_content_type_template
-                                + standard_viewport_template
-                                + standard_generator_template % __version__)
+                                + standard_generator_template
+                                + standard_viewport_template)
     standard_meta_value = standard_html_meta_value % 'utf-8'
     standard_html_prolog = '<!DOCTYPE html>\n'
 
-class Html5PublishPartsTestSuite(HtmlPublishPartsTestSuite):
-
-    testcase_class = Html5WriterPublishPartsTestCase
-
-
-def suite():
-    s = Html5PublishPartsTestSuite()
-    s.generateTests(totest)
-    return s
+    def format_output(self, parts):
+        """Minimize & standardize the output."""
+        # remove redundant parts & uninteresting parts:
+        del parts'whole'
+        assert parts'body' == parts'fragment'
+        del parts'body'
+        del parts'body_pre_docinfo'
+        del parts'body_prefix'
+        del parts'body_suffix'
+        del parts'head'
+        del parts'head_prefix'
+        del parts'encoding'
+        del parts'errors'
+        del parts'version'
+        # remove standard portions:
+        parts'meta' = parts'meta'.replace(self.standard_meta_value, '')
+        parts'html_head' = parts'html_head'.replace(
+            self.standard_html_meta_value, '...')
+        parts'html_prolog' = parts'html_prolog'.replace(
+            self.standard_html_prolog, '')
+        return {k: v for k, v in parts.items() if v}
 
 
 totest = {}
 
-totest'Title promotion' = ({'stylesheet_path': '',
-                              'embed_stylesheet': 0}, 
+totest'standard' = ({'stylesheet_path': '',
+                     'embed_stylesheet': False}, 
 """\
 Simple String
 """,
-"""\
-{'fragment': '''<p>Simple String</p>\\n''',
+{'fragment': '''<p>Simple String</p>\n''',
  'html_body': '''<main>
 <p>Simple String</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with *markup*
 """,
-"""\
-{'fragment': '''<p>Simple String with <em>markup</em></p>\\n''',
+{'fragment': '''<p>Simple String with <em>markup</em></p>\n''',
  'html_body': '''<main>
 <p>Simple String with <em>markup</em></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with an even simpler ``inline literal``
 """,
-"""\
-{'fragment': '''<p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>\\n''',
+{'fragment': '''<p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>\n''',
  'html_body': '''<main>
 <p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `anonymous reference`__
 
 __ http://www.test.com/test_url
 """,
-"""\
-{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\\n''',
+{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\n''',
  'html_body': '''<main>
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 One paragraph.
 
 Two paragraphs.
 """,
-"""\
 {'fragment': '''<p>One paragraph.</p>
-<p>Two paragraphs.</p>\\n''',
+<p>Two paragraphs.</p>\n''',
  'html_body': '''<main>
 <p>One paragraph.</p>
 <p>Two paragraphs.</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `named reference`_ with stuff in between the
 reference and the target.
 
 .. _`named reference`: http://www.test.com/test_url
 """,
-"""\
 {'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
-reference and the target.</p>\\n''',
+reference and the target.</p>\n''',
  'html_body': '''<main>
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
 reference and the target.</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+""".. CIT2022 A citation.""",
+{'fragment': '''<div role="list" class="citation-list">
+<div class="citation" id="cit2022" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>CIT2022<span class="fn-bracket"></span></span>
+<p>A citation.</p>
+</div>
+</div>\n''',
+ 'html_body': '''<main>
+<div role="list" class="citation-list">
+<div class="citation" id="cit2022" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>CIT2022<span class="fn-bracket"></span></span>
+<p>A citation.</p>
+</div>
+</div>
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 +++++
 Title
@@ -143,35 +190,34 @@
 
 And even more stuff
 """,
-"""\
 {'fragment': '''<p>Some stuff</p>
 <section id="section">
-<h2>Section</h2>
+<h2>Section<a class="self-link" title="link to this section" href="#section"></a></h2>
 <p>Some more stuff</p>
 <section id="another-section">
-<h3>Another Section</h3>
+<h3>Another Section<a class="self-link" title="link to this section" href="#another-section"></a></h3>
 <p>And even more stuff</p>
 </section>
-</section>\\n''',
+</section>\n''',
  'html_body': '''<main id="title">
 <h1 class="title">Title</h1>
 <p class="subtitle" id="subtitle">Subtitle</p>
 <p>Some stuff</p>
 <section id="section">
-<h2>Section</h2>
+<h2>Section<a class="self-link" title="link to this section" href="#section"></a></h2>
 <p>Some more stuff</p>
 <section id="another-section">
-<h3>Another Section</h3>
+<h3>Another Section<a class="self-link" title="link to this section" href="#another-section"></a></h3>
 <p>And even more stuff</p>
 </section>
 </section>
-</main>\\n''',
- 'html_head': '''...<title>Title</title>\\n''',
- 'html_subtitle': '''<p class="subtitle" id="subtitle">Subtitle</p>\\n''',
- 'html_title': '''<h1 class="title">Title</h1>\\n''',
+</main>\n''',
+ 'html_head': '''...<title>Title</title>\n''',
+ 'html_subtitle': '''<p class="subtitle" id="subtitle">Subtitle</p>\n''',
+ 'html_title': '''<h1 class="title">Title</h1>\n''',
  'subtitle': '''Subtitle''',
- 'title': '''Title'''}
-""",
+ 'title': '''Title'''
+},
 """\
 +++++
 Title
@@ -181,88 +227,82 @@
 
 Some stuff
 """,
-"""\
 {'docinfo': '''<dl class="docinfo simple">
-<dt class="author">Author</dt>
+<dt class="author">Author<span class="colon">:</span></dt>
 <dd class="author"><p>me</p></dd>
-</dl>\\n''',
- 'fragment': '''<p>Some stuff</p>\\n''',
+</dl>\n''',
+ 'fragment': '''<p>Some stuff</p>\n''',
  'html_body': '''<main id="title">
 <h1 class="title">Title</h1>
 <dl class="docinfo simple">
-<dt class="author">Author</dt>
+<dt class="author">Author<span class="colon">:</span></dt>
 <dd class="author"><p>me</p></dd>
 </dl>
 <p>Some stuff</p>
-</main>\\n''',
- 'html_head': '''...<title>Title</title>
-<meta name="author" content="me" />\\n''',
- 'html_title': '''<h1 class="title">Title</h1>\\n''',
- 'meta': '''<meta name="author" content="me" />\\n''',
- 'title': '''Title'''}
-"""
+</main>\n''',
+ 'html_head': '''...<meta name="author" content="me" />
+<title>Title</title>\n''',
+ 'html_title': '''<h1 class="title">Title</h1>\n''',
+ 'meta': '''<meta name="author" content="me" />\n''',
+ 'title': '''Title'''
+}
 )
 
-totest'No title promotion' = ({'doctitle_xform' : 0,
+totest'no_title_promotion' = ({'doctitle_xform': False,
                                  'stylesheet_path': '',
-                                 'embed_stylesheet': 0}, 
+                                 'embed_stylesheet': False}, 
 """\
 Simple String
 """,
-"""\
-{'fragment': '''<p>Simple String</p>\\n''',
+{'fragment': '''<p>Simple String</p>\n''',
  'html_body': '''<main>
 <p>Simple String</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with *markup*
 """,
-"""\
-{'fragment': '''<p>Simple String with <em>markup</em></p>\\n''',
+{'fragment': '''<p>Simple String with <em>markup</em></p>\n''',
  'html_body': '''<main>
 <p>Simple String with <em>markup</em></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Simple String with an even simpler ``inline literal``
 """,
-"""\
-{'fragment': '''<p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>\\n''',
+{'fragment': '''<p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>\n''',
  'html_body': '''<main>
 <p>Simple String with an even simpler <span class="docutils literal">inline literal</span></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `anonymous reference`__
 
 __ http://www.test.com/test_url
 """,
-"""\
-{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\\n''',
+{'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>\n''',
  'html_body': '''<main>
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">anonymous reference</a></p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 A simple `named reference`_ with stuff in between the
 reference and the target.
 
 .. _`named reference`: http://www.test.com/test_url
 """,
-"""\
 {'fragment': '''<p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
-reference and the target.</p>\\n''',
+reference and the target.</p>\n''',
  'html_body': '''<main>
 <p>A simple <a class="reference external" href="http://www.test.com/test_url">named reference</a> with stuff in between the
 reference and the target.</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 +++++
 Title
@@ -283,58 +323,56 @@
 
 And even more stuff
 """,
-"""\
 {'fragment': '''<section id="title">
-<h2>Title</h2>
+<h2>Title<a class="self-link" title="link to this section" href="#title"></a></h2>
 <section id="not-a-subtitle">
-<h3>Not A Subtitle</h3>
+<h3>Not A Subtitle<a class="self-link" title="link to this section" href="#not-a-subtitle"></a></h3>
 <p>Some stuff</p>
 <section id="section">
-<h4>Section</h4>
+<h4>Section<a class="self-link" title="link to this section" href="#section"></a></h4>
 <p>Some more stuff</p>
 <section id="another-section">
-<h5>Another Section</h5>
+<h5>Another Section<a class="self-link" title="link to this section" href="#another-section"></a></h5>
 <p>And even more stuff</p>
 </section>
 </section>
 </section>
-</section>\\n''',
+</section>\n''',
  'html_body': '''<main>
 <section id="title">
-<h2>Title</h2>
+<h2>Title<a class="self-link" title="link to this section" href="#title"></a></h2>
 <section id="not-a-subtitle">
-<h3>Not A Subtitle</h3>
+<h3>Not A Subtitle<a class="self-link" title="link to this section" href="#not-a-subtitle"></a></h3>
 <p>Some stuff</p>
 <section id="section">
-<h4>Section</h4>
+<h4>Section<a class="self-link" title="link to this section" href="#section"></a></h4>
 <p>Some more stuff</p>
 <section id="another-section">
-<h5>Another Section</h5>
+<h5>Another Section<a class="self-link" title="link to this section" href="#another-section"></a></h5>
 <p>And even more stuff</p>
 </section>
 </section>
 </section>
 </section>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 * bullet
 * list
 """,
-"""\
 {'fragment': '''<ul class="simple">
 <li><p>bullet</p></li>
 <li><p>list</p></li>
-</ul>\\n''',
+</ul>\n''',
  'html_body': '''<main>
 <ul class="simple">
 <li><p>bullet</p></li>
 <li><p>list</p></li>
 </ul>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. table::
    :align: right
@@ -345,12 +383,7 @@
    |  3  |  4  |
    +-----+-----+
 """,
-"""\
 {'fragment': '''<table class="align-right">
-<colgroup>
-<col style="width: 50%%" />
-<col style="width: 50%%" />
-</colgroup>
 <tbody>
 <tr><td><p>1</p></td>
 <td><p>2</p></td>
@@ -359,13 +392,9 @@
 <td><p>4</p></td>
 </tr>
 </tbody>
-</table>\\n''',
+</table>\n''',
  'html_body': '''<main>
 <table class="align-right">
-<colgroup>
-<col style="width: 50%%" />
-<col style="width: 50%%" />
-</colgroup>
 <tbody>
 <tr><td><p>1</p></td>
 <td><p>2</p></td>
@@ -375,9 +404,9 @@
 </tr>
 </tbody>
 </table>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Not a docinfo.
 
@@ -388,68 +417,129 @@
 :simple:
 :field: list
 """,
-"""\
 {'fragment': '''<p>Not a docinfo.</p>
 <dl class="field-list simple">
-<dt>This</dt>
+<dt>This<span class="colon">:</span></dt>
 <dd><p id="target">is</p>
 </dd>
-<dt>a</dt>
+<dt>a<span class="colon">:</span></dt>
 <dd><p></p></dd>
-<dt>simple</dt>
+<dt>simple<span class="colon">:</span></dt>
 <dd><p></p></dd>
-<dt>field</dt>
+<dt>field<span class="colon">:</span></dt>
 <dd><p>list</p>
 </dd>
-</dl>\\n''',
+</dl>\n''',
  'html_body': '''<main>
 <p>Not a docinfo.</p>
 <dl class="field-list simple">
-<dt>This</dt>
+<dt>This<span class="colon">:</span></dt>
 <dd><p id="target">is</p>
 </dd>
-<dt>a</dt>
+<dt>a<span class="colon">:</span></dt>
 <dd><p></p></dd>
-<dt>simple</dt>
+<dt>simple<span class="colon">:</span></dt>
 <dd><p></p></dd>
-<dt>field</dt>
+<dt>field<span class="colon">:</span></dt>
 <dd><p>list</p>
 </dd>
 </dl>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 Not a docinfo.
 
 :This is: a
 :simple field list with loooong field: names
 """,
-"""\
 {'fragment': '''\
 <p>Not a docinfo.</p>
 <dl class="field-list simple">
-<dt>This is</dt>
+<dt>This is<span class="colon">:</span></dt>
 <dd><p>a</p>
 </dd>
-<dt>simple field list with loooong field</dt>
+<dt>simple field list with loooong field<span class="colon">:</span></dt>
 <dd><p>names</p>
 </dd>
-</dl>\\n''',
+</dl>\n''',
  'html_body': '''\
 <main>
 <p>Not a docinfo.</p>
 <dl class="field-list simple">
-<dt>This is</dt>
+<dt>This is<span class="colon">:</span></dt>
 <dd><p>a</p>
 </dd>
-<dt>simple field list with loooong field</dt>
+<dt>simple field list with loooong field<span class="colon">:</span></dt>
 <dd><p>names</p>
 </dd>
 </dl>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+"""\
+Not a docinfo.
+
+.. class:: field-indent-200
+
+:This: is a
+:simple: field list with custom indent.
+""",
+{'fragment': '''<p>Not a docinfo.</p>
+<dl class="field-list simple" style="--field-indent: 200px;">
+<dt>This<span class="colon">:</span></dt>
+<dd><p>is a</p>
+</dd>
+<dt>simple<span class="colon">:</span></dt>
+<dd><p>field list with custom indent.</p>
+</dd>
+</dl>\n''',
+ 'html_body': '''<main>
+<p>Not a docinfo.</p>
+<dl class="field-list simple" style="--field-indent: 200px;">
+<dt>This<span class="colon">:</span></dt>
+<dd><p>is a</p>
+</dd>
+<dt>simple<span class="colon">:</span></dt>
+<dd><p>field list with custom indent.</p>
+</dd>
+</dl>
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+"""\
+Not a docinfo.
+
+.. class:: field-indent-200uf
+
+:This: is a
+:simple: field list without custom indent,
+         because the unit "uf" is invalid.
+""",
+{'fragment': '''<p>Not a docinfo.</p>
+<dl class="field-indent-200uf field-list simple">
+<dt>This<span class="colon">:</span></dt>
+<dd><p>is a</p>
+</dd>
+<dt>simple<span class="colon">:</span></dt>
+<dd><p>field list without custom indent,
+because the unit &quot;uf&quot; is invalid.</p>
+</dd>
+</dl>\n''',
+ 'html_body': '''<main>
+<p>Not a docinfo.</p>
+<dl class="field-indent-200uf field-list simple">
+<dt>This<span class="colon">:</span></dt>
+<dd><p>is a</p>
+</dd>
+<dt>simple<span class="colon">:</span></dt>
+<dd><p>field list without custom indent,
+because the unit &quot;uf&quot; is invalid.</p>
+</dd>
+</dl>
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. figure:: dummy.png
 
@@ -459,7 +549,6 @@
 
    The legend's second paragraph.
 """,
-"""\
 {'fragment': '''\
 <figure>
 <img alt="dummy.png" src="dummy.png" />
@@ -470,7 +559,7 @@
 <p>The legend's second paragraph.</p>
 </div>
 </figcaption>
-</figure>\\n''',
+</figure>\n''',
  'html_body': '''\
 <main>
 <figure>
@@ -483,22 +572,21 @@
 </div>
 </figcaption>
 </figure>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. figure:: dummy.png
 
    The figure's caption, no legend.
 """,
-"""\
 {'fragment': '''\
 <figure>
 <img alt="dummy.png" src="dummy.png" />
 <figcaption>
 <p>The figure's caption, no legend.</p>
 </figcaption>
-</figure>\\n''',
+</figure>\n''',
  'html_body': '''\
 <main>
 <figure>
@@ -507,9 +595,9 @@
 <p>The figure's caption, no legend.</p>
 </figcaption>
 </figure>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. figure:: dummy.png
 
@@ -517,7 +605,6 @@
 
    A legend without caption.
 """,
-"""\
 {'fragment': '''\
 <figure>
 <img alt="dummy.png" src="dummy.png" />
@@ -526,7 +613,7 @@
 <p>A legend without caption.</p>
 </div>
 </figcaption>
-</figure>\\n''',
+</figure>\n''',
  'html_body': '''\
 <main>
 <figure>
@@ -537,32 +624,130 @@
 </div>
 </figcaption>
 </figure>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
-)
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
 """\
 .. figure:: dummy.png
 
 No caption nor legend.
 """,
-"""\
 {'fragment': '''\
 <figure>
 <img alt="dummy.png" src="dummy.png" />
 </figure>
-<p>No caption nor legend.</p>\\n''',
+<p>No caption nor legend.</p>\n''',
  'html_body': '''\
 <main>
 <figure>
 <img alt="dummy.png" src="dummy.png" />
 </figure>
 <p>No caption nor legend.</p>
-</main>\\n''',
- 'html_head': '''...<title>&lt;string&gt;</title>\\n'''}
-""",
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+)
+
+
+totest'lazy_loading' = ({'image_loading': 'lazy',
+                           'stylesheet_path': '',
+                           'embed_stylesheet': False}, 
+
+"""\
+.. image:: dummy.png
+""",
+{'fragment': '''\
+<img alt="dummy.png" loading="lazy" src="dummy.png" />\n''',
+ 'html_body': '''\
+<main>
+<img alt="dummy.png" loading="lazy" src="dummy.png" />
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+"""\
+.. figure:: dummy.png
+""",
+{'fragment': '''\
+<figure>
+<img alt="dummy.png" loading="lazy" src="dummy.png" />
+</figure>\n''',
+ 'html_body': '''\
+<main>
+<figure>
+<img alt="dummy.png" loading="lazy" src="dummy.png" />
+</figure>
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+)
+
+
+totest'no_backlinks' = ({'footnote_backlinks': False,
+                           'stylesheet_path': '',
+                           'embed_stylesheet': False}, 
+
+"""\
+Two footnotes #f1_ #f2_ and two citations once_ twice_.
+
+The latter are referenced a second time #f2_ twice_.
+
+.. #f1 referenced once
+.. #f2 referenced twice
+.. once citation referenced once
+.. twice citation referenced twice
+""",
+{'fragment': '''\
+<p>Two footnotes <a class="footnote-reference brackets" href="#f1" id="footnote-reference-1" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a> <a class="footnote-reference brackets" href="#f2" id="footnote-reference-2" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a> and two citations <a class="citation-reference" href="#once" id="citation-reference-1" role="doc-biblioref">once</a> <a class="citation-reference" href="#twice" id="citation-reference-2" role="doc-biblioref">twice</a>.</p>
+<p>The latter are referenced a second time <a class="footnote-reference brackets" href="#f2" id="footnote-reference-3" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a> <a class="citation-reference" href="#twice" id="citation-reference-3" role="doc-biblioref">twice</a>.</p>
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="f1" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></span>
+<p>referenced once</p>
+</aside>
+<aside class="footnote brackets" id="f2" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></span>
+<p>referenced twice</p>
+</aside>
+</aside>
+<div role="list" class="citation-list">
+<div class="citation" id="once" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>once<span class="fn-bracket"></span></span>
+<p>citation referenced once</p>
+</div>
+<div class="citation" id="twice" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>twice<span class="fn-bracket"></span></span>
+<p>citation referenced twice</p>
+</div>
+</div>\n''',
+ 'html_body': '''\
+<main>
+<p>Two footnotes <a class="footnote-reference brackets" href="#f1" id="footnote-reference-1" role="doc-noteref"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></a> <a class="footnote-reference brackets" href="#f2" id="footnote-reference-2" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a> and two citations <a class="citation-reference" href="#once" id="citation-reference-1" role="doc-biblioref">once</a> <a class="citation-reference" href="#twice" id="citation-reference-2" role="doc-biblioref">twice</a>.</p>
+<p>The latter are referenced a second time <a class="footnote-reference brackets" href="#f2" id="footnote-reference-3" role="doc-noteref"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></a> <a class="citation-reference" href="#twice" id="citation-reference-3" role="doc-biblioref">twice</a>.</p>
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="f1" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>1<span class="fn-bracket"></span></span>
+<p>referenced once</p>
+</aside>
+<aside class="footnote brackets" id="f2" role="doc-footnote">
+<span class="label"><span class="fn-bracket"></span>2<span class="fn-bracket"></span></span>
+<p>referenced twice</p>
+</aside>
+</aside>
+<div role="list" class="citation-list">
+<div class="citation" id="once" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>once<span class="fn-bracket"></span></span>
+<p>citation referenced once</p>
+</div>
+<div class="citation" id="twice" role="doc-biblioentry">
+<span class="label"><span class="fn-bracket"></span>twice<span class="fn-bracket"></span></span>
+<p>citation referenced twice</p>
+</div>
+</div>
+</main>\n''',
+ 'html_head': '''...<title>&lt;string&gt;</title>\n'''
+},
+)
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_html5_template.py Added

@@ -0,0 +1,252 @@
+#!/usr/bin/env python3
+
+# $Id: test_html5_template.py 9369 2023-05-02 23:04:27Z milde $
+# Author: David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+Tests for the HTML writer.
+"""
+
+import os
+import platform
+from pathlib import Path
+import sys
+import unittest
+
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+import docutils
+from docutils.core import publish_string
+
+# TEST_ROOT is ./test/ from the docutils root
+TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..'))
+
+
+class WriterPublishTestCase(unittest.TestCase):
+    # maxDiff = None
+    def test_publish(self):
+        writer_name = 'html5'
+        template_path = os.path.join(TEST_ROOT, 'data', 'full-template.txt')
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                            'template': template_path,
+                            'stylesheet_path': '/test.css',
+                            'embed_stylesheet': False,
+                        }).decode()
+                    self.assertEqual(output, case_expected)
+
+
+if platform.system() == "Windows":
+    drive_prefix = os.path.splitdrive(os.getcwd())0
+else:
+    drive_prefix = ""
+
+
+totest = {}
+
+totest'template' = 
+"""\
+================
+ Document Title
+================
+----------
+ Subtitle
+----------
+
+:Author: Me
+
+.. footer:: footer text
+
+Section
+=======
+
+Some text.
+""",
+fr'''head_prefix = """\
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>"""
+
+
+head = """\
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
+
+
+stylesheet = """\
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />"""
+
+
+body_prefix = """\
+</head>
+<body>
+<main id="document-title">"""
+
+
+body_pre_docinfo = """\
+<h1 class="title">Document Title</h1>
+<p class="subtitle" id="subtitle">Subtitle</p>"""
+
+
+docinfo = """\
+<dl class="docinfo simple">
+<dt class="author">Author<span class="colon">:</span></dt>
+<dd class="author"><p>Me</p></dd>
+</dl>"""
+
+
+body = """\
+<section id="section">
+<h2>Section</h2>
+<p>Some text.</p>
+</section>"""
+
+
+body_suffix = """\
+</main>
+<footer>
+<p>footer text</p>
+</footer>
+</body>
+</html>"""
+
+
+head_prefix = """\
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>"""
+
+
+head = """\
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
+
+
+stylesheet = """\
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />"""
+
+
+body_prefix = """\
+</head>
+<body>
+<main id="document-title">"""
+
+
+body_pre_docinfo = """\
+<h1 class="title">Document Title</h1>
+<p class="subtitle" id="subtitle">Subtitle</p>"""
+
+
+docinfo = """\
+<dl class="docinfo simple">
+<dt class="author">Author<span class="colon">:</span></dt>
+<dd class="author"><p>Me</p></dd>
+</dl>"""
+
+
+body = """\
+<section id="section">
+<h2>Section</h2>
+<p>Some text.</p>
+</section>"""
+
+
+body_suffix = """\
+</main>
+<footer>
+<p>footer text</p>
+</footer>
+</body>
+</html>"""
+
+
+title = """\
+Document Title"""
+
+
+subtitle = """\
+Subtitle"""
+
+
+header = """\
+"""
+
+
+footer = """\
+<footer>
+<p>footer text</p>
+</footer>"""
+
+
+meta = """\
+<meta charset="utf-8" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<meta name="author" content="Me" />"""
+
+
+fragment = """\
+<section id="section">
+<h2>Section</h2>
+<p>Some text.</p>
+</section>"""
+
+
+html_prolog = """\
+<!DOCTYPE html>"""
+
+
+html_head = """\
+<meta charset="%s" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<meta name="author" content="Me" />
+<title>Document Title</title>"""
+
+
+html_title = """\
+<h1 class="title">Document Title</h1>"""
+
+
+html_subtitle = """\
+<p class="subtitle" id="subtitle">Subtitle</p>"""
+
+
+html_body = """\
+<main id="document-title">
+<h1 class="title">Document Title</h1>
+<p class="subtitle" id="subtitle">Subtitle</p>
+<dl class="docinfo simple">
+<dt class="author">Author<span class="colon">:</span></dt>
+<dd class="author"><p>Me</p></dd>
+</dl>
+<section id="section">
+<h2>Section</h2>
+<p>Some text.</p>
+</section>
+</main>
+<footer>
+<p>footer text</p>
+</footer>"""
+'''
+
+
+if __name__ == '__main__':
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_latex2e.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_latex2e.py Changed

@@ -1,47 +1,170 @@
-# -*- coding: utf-8 -*-
-#! /usr/bin/env python
-
-# $Id: test_latex2e.py 8577 2020-11-25 23:06:44Z milde $
+#! /usr/bin/env python3
+# $Id: test_latex2e.py 9369 2023-05-02 23:04:27Z milde $
 # Author: engelbert gruber <grubert@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for latex2e writer.
 """
-from __future__ import absolute_import
 
+import os
+from pathlib import Path
 import string
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_transforms import DocutilsTestSupport  # before importing docutils!
-
-
-def suite():
-    settings = {'use_latex_toc': False}
-    s = DocutilsTestSupport.PublishTestSuite('latex', suite_settings=settings)
-    s.generateTests(totest)
-    settings'use_latex_toc' = True
-    s.generateTests(totest_latex_toc)
-    settings'use_latex_toc' = False
-    settings'sectnum_xform' = False
-    s.generateTests(totest_latex_sectnum)
-    settings'sectnum_xform' = True
-    settings'use_latex_citations' = True
-    s.generateTests(totest_latex_citations)
-    settings'table_style' = 'colwidths-auto'
-    s.generateTests(totest_table_style_auto)
-    settings'table_style' = 'booktabs'
-    s.generateTests(totest_table_style_booktabs)
-    settings'stylesheet_path' = 'data/spam,data/ham.tex'
-    s.generateTests(totest_stylesheet)
-    settings'embed_stylesheet' = True
-    settings'warning_stream' = ''
-    s.generateTests(totest_stylesheet_embed)
-    return s
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.core import publish_string
+
+# DATA_ROOT is ./test/data from the docutils root
+DATA_ROOT = Path(__file__).resolve().parents1 / 'data'
+spam = os.path.relpath(DATA_ROOT/'spam').replace('\\', '/')
+ham = os.path.relpath(DATA_ROOT/'ham.tex').replace('\\', '/')
+
+
+class WriterPublishTestCase(unittest.TestCase):
+
+    maxDiff = None
+    writer_name = 'latex'
+    settings = {
+        '_disable_config': True,
+        'strict_visitor': True,
+        # Explicit set current default to avoid latex writer future warnings:
+        'use_latex_citations': False,
+        'legacy_column_widths': True,
+        }
+
+    def test_defaults(self):
+        for name, cases in samples_default.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_default{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=self.settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_docutils_toc(self):
+        settings = self.settings.copy()
+        settings'use_latex_toc' = False
+        for name, cases in samples_docutils_toc.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_docutils_toc{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_book(self):
+        settings = self.settings.copy()
+        settings'documentclass' = 'book'
+        for name, cases in samples_book.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_book{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_latex_sectnum(self):
+        settings = self.settings.copy()
+        settings'use_latex_toc' = False
+        settings'sectnum_xform' = False
+        for name, cases in samples_latex_sectnum.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(
+                        id=f'samples_latex_sectnum{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_latex_citations(self):
+        settings = self.settings.copy()
+        settings'use_latex_citations' = True
+        for name, cases in samples_latex_citations.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(
+                        id=f'samples_latex_citations{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_table_style_auto(self):
+        settings = self.settings.copy()
+        settings'table_style' = 'colwidths-auto'
+        for name, cases in samples_table_style_auto.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(
+                        id=f'samples_table_style_auto{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_booktabs(self):
+        settings = self.settings.copy()
+        settings'table_style' = 'booktabs'
+        for name, cases in samples_table_style_booktabs.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_booktabs{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_link_stylesheet(self):
+        settings = self.settings.copy()
+        settings'stylesheet_path' = f'{spam},{ham}'
+        for name, cases in samples_stylesheet.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_link_stylesheet{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_embed_embed_stylesheet(self):
+        settings = self.settings.copy()
+        settings'stylesheet_path' = f'{spam},{ham}'
+        settings'embed_stylesheet' = True
+        settings'warning_stream' = ''
+        for name, cases in samples_stylesheet_embed.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_embed_stylesheet{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
+    def test_bibtex(self):
+        settings = self.settings.copy()
+        settings'use_bibtex' = 'alpha', 'xampl'
+        for name, cases in samples_bibtex.items():
+            for casenum, (rst_input, expected) in enumerate(cases):
+                with self.subTest(id=f'samples_bibtex{name!r}{casenum}'):
+                    output = publish_string(source=rst_input,
+                                            writer_name=self.writer_name,
+                                            settings_overrides=settings)
+                    output = output.decode()
+                    self.assertEqual(output, expected)
+
 
 head_template = string.Template(
-r"""$head_prefix% generated by Docutils <http://docutils.sourceforge.net/>
+r"""$head_prefix% generated by Docutils <https://docutils.sourceforge.io/>
 \usepackage{cmap} % fix search and cut-and-paste in Acrobat
 $requirements
 %%% Custom LaTeX preamble
@@ -55,24 +178,23 @@
 $titledata""")
 
 parts = dict(
-head_prefix = r"""\documentclassa4paper{article}
+head_prefix=r"""\documentclassa4paper{article}
 """,
-requirements = r"""\usepackage{ifthen}
+requirements=r"""\usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 """,
-latex_preamble = r"""% PDF Standard Fonts
+latex_preamble=r"""% PDF Standard Fonts
 \usepackage{mathptmx} % Times
 \usepackagescaled=.90{helvet}
 \usepackage{courier}
 """,
-longtable = r"""\usepackage{longtable,ltcaption,array}
+longtable=r"""\usepackage{longtable,ltcaption,array}
 \setlength{\extrarowheight}{2pt}
 \newlength{\DUtablewidth} % internal use in tables
 """,
-stylesheet = '',
-fallbacks =  '',
-fallbacks_highlight = r"""
+stylesheet='',
+fallbacks='',
+fallbacks_highlight=r"""
 % basic code highlight:
 \providecommand*\DUrolecomment1{\textcolorrgb{0.40,0.40,0.40}{#1}}
 \providecommand*\DUroledeleted1{\textcolorrgb{0.40,0.40,0.40}{#1}}
@@ -88,7 +210,7 @@
   \fi%
 }
 """,
-pdfsetup = r"""
+pdfsetup=r"""
 % hyperlinks:
 \ifthenelse{\isundefined{\hypersetup}}{
   \usepackagecolorlinks=true,linkcolor=blue,urlcolor=blue{hyperref}
@@ -96,38 +218,38 @@
   \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
 }{}
 """,
-titledata = '')
+titledata='')
 
 head = head_template.substitute(parts)
 
 head_table = head_template.substitute(
-    dict(parts, requirements = parts'requirements' + parts'longtable'))
+    dict(parts, requirements=parts'requirements' + parts'longtable'))
 
 head_booktabs = head_template.substitute(
     dict(parts, requirements=parts'requirements'
          + '\\usepackage{booktabs}\n' + parts'longtable'))
 
 head_textcomp = head_template.substitute(
-    dict(parts, requirements = parts'requirements' +
-r"""\usepackage{textcomp} % text symbol macros
-"""))
+    dict(parts, requirements=parts'requirements'
+         + '\\usepackage{textcomp} % text symbol macros\n'))
 
 head_alltt = head_template.substitute(
-    dict(parts, requirements = parts'requirements' +
-r"""\usepackage{alltt}
-"""))
+    dict(parts, requirements=parts'requirements'
+         + '\\usepackage{alltt}\n'))
 
 
-totest = {}
-totest_latex_toc = {}
-totest_latex_sectnum = {}
-totest_latex_citations = {}
-totest_stylesheet = {}
-totest_stylesheet_embed = {}
-totest_table_style_auto = {}
-totest_table_style_booktabs = {}
+samples_default = {}
+samples_docutils_toc = {}
+samples_book = {}
+samples_latex_sectnum = {}
+samples_latex_citations = {}
+samples_stylesheet = {}
+samples_stylesheet_embed = {}
+samples_table_style_auto = {}
+samples_table_style_booktabs = {}
+samples_bibtex = {}
 
-totest'url_chars' = 
+samples_default'url_chars' = 
 "http://nowhere/url_with%28parens%29",
 head + r"""
 \url{http://nowhere/url_with\%28parens\%29}
@@ -136,7 +258,7 @@
 """,
 
 
-totest'textcomp' = 
+samples_default'textcomp' = 
 "2 µm is just 2/1000000 m",
 head_textcomp + r"""
 2 µm is just 2/1000000 m
@@ -145,12 +267,11 @@
 """,
 
 
-totest'spanish quote' = 
+samples_default'spanish_quote' = 
 ".. role:: language-es\n\nUnd damit :language-es:`basta`!",
-head_template.substitute(dict(parts, requirements =
-r"""\usepackage{ifthen}
+head_template.substitute(dict(parts,
+requirements=r"""\usepackage{ifthen}
 \usepackageT1{fontenc}
-\usepackageutf8{inputenc}
 \usepackagespanish,english{babel}
 \AtBeginDocument{\shorthandoff{.<>}}
 """)) + r"""
@@ -160,19 +281,19 @@
 """,
 
 
-totest'code role' = 
-":code:`x=1`",
-head_template.substitute(dict(parts, requirements = parts'requirements'+
-r"""\usepackage{color}
-""", fallbacks = parts'fallbacks_highlight')) + r"""
+samples_default'code_role' = 
+':code:`x=1`',
+head_template.substitute(dict(parts, requirements=parts'requirements'
+                              + '\\usepackage{color}\n',
+                              fallbacks=parts'fallbacks_highlight'))
++ r"""
 \texttt{\DUrole{code}{x=1}}
 
 \end{document}
 """,
 
 
-totest'table_of_contents' = 
-# input
+samples_docutils_toc'table_of_contents' = 
 """\
 .. contents:: Table of Contents
 
@@ -184,31 +305,48 @@
 -------
 Paragraph 2.
 """,
-## # expected output
+# expected output
 head_template.substitute(dict(parts,
     requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n',
     fallbacks=r"""
+% class handling for environments (block-level elements)
+% \begin{DUclass}{spam} tries \DUCLASSspam and
+% \end{DUclass}{spam} tries \endDUCLASSspam
+\ifx\DUclass\undefined % poor man's "provideenvironment"
+ \newenvironment{DUclass}1%
+  {% "#1" does not work in end-part of environment.
+   \def\DocutilsClassFunctionName{DUCLASS#1}
+     \csname \DocutilsClassFunctionName \endcsname}%
+  {\csname end\DocutilsClassFunctionName \endcsname}%
+\fi
+
 % title for topics, admonitions, unsupported section levels, and sidebar
-\providecommand*{\DUtitle}2class-arg{%
-  % call \DUtitle#1{#2} if it exists:
-  \ifcsname DUtitle#1\endcsname%
-    \csname DUtitle#1\endcsname{#2}%
-  \else
-    \smallskip\noindent\textbf{#2}\smallskip%
-  \fi
+\providecommand*{\DUtitle}1{%
+  \smallskip\noindent\textbf{#1}\smallskip}
+
+\providecommand*{\DUCLASScontents}{%
+  \renewenvironment{itemize}%
+    {\begin{list}{}{\setlength{\partopsep}{0pt}
+                    \setlength{\parsep}{0pt}}
+                   }%
+    {\end{list}}%
 }
 """)) + r"""
 \phantomsection\label{table-of-contents}
 \pdfbookmark1{Table of Contents}{table-of-contents}
-\DUtitlecontents{Table of Contents}
 
-\begin{list}{}{}
+\begin{DUclass}{contents}
+
+\DUtitle{Table of Contents}
+
+\begin{itemize}
 \item \hyperreftitle-1{Title 1}
 
-\begin{list}{}{}
+\begin{itemize}
 \item \hyperreftitle-2{Title 2}
-\end{list}
-\end{list}
+\end{itemize}
+\end{itemize}
+\end{DUclass}
 
 
 \section{Title 1%
@@ -228,8 +366,7 @@
 """,
 
 
-totest'footnote text' = 
-# input
+samples_default'footnote_text' = 
 """\
 .. 1 paragraph
 
@@ -237,7 +374,7 @@
 
 .. 3 1. enumeration
 """,
-## # expected output
+# expected output
 head_template.substitute(dict(parts,
     fallbacks=r"""
 % numerical or symbol footnotes with hyperlinks and backlinks
@@ -254,13 +391,13 @@
   \endgroup%
 }
 """)) + r"""%
-\DUfootnotetext{id1}{id1}{1}{%
+\DUfootnotetext{footnote-1}{footnote-1}{1}{%
 paragraph
 }
 %
-\DUfootnotetext{id2}{id2}{2}{}
+\DUfootnotetext{footnote-2}{footnote-2}{2}{}
 %
-\DUfootnotetext{id3}{id3}{3}{
+\DUfootnotetext{footnote-3}{footnote-3}{3}{
 \begin{enumerate}
 \item enumeration
 \end{enumerate}
@@ -270,15 +407,14 @@
 """,
 
 
-totest_latex_toc'no_sectnum' = 
-# input
+samples_default'no_sectnum' = 
 """\
 .. contents::
 
 first section
 -------------
 """,
-## # expected output
+# expected output
 head_template.substitute(dict(parts,
     requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n'
 )) + r"""
@@ -295,8 +431,7 @@
 """,
 
 
-totest_latex_toc'sectnum' = 
-# input
+samples_default'sectnum' = 
 """\
 .. contents::
 .. sectnum::
@@ -304,7 +439,7 @@
 first section
 -------------
 """,
-## # expected output
+# expected output
 head_template.substitute(dict(parts,
     requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n'
 )) + r"""
@@ -321,19 +456,71 @@
 """,
 
 
+samples_default'depth' = 
+"""\
+.. contents::
+    :depth: 1
+
+first section
+-------------
+""",
+# expected output
+head_template.substitute(dict(parts,
+    requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n'
+)) + r"""
+\phantomsection\label{contents}
+\pdfbookmark1{Contents}{contents}
+\setcounter{tocdepth}{1}
+\tableofcontents
+
+
+\section{first section%
+  \label{first-section}%
+}
 
-totest_latex_sectnum'no_sectnum' = 
-# input
+\end{document}
+""",
+
+
+samples_book'depth' = 
+"""\
+.. contents::
+    :depth: 1
+
+first chapter
+-------------
+""",
+# expected output
+head_template.substitute(dict(parts,
+    head_prefix=r"""\documentclassa4paper{book}
+""",
+    requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n'
+)) + r"""
+\phantomsection\label{contents}
+\pdfbookmark1{Contents}{contents}
+\setcounter{tocdepth}{0}
+\tableofcontents
+
+
+\chapter{first chapter%
+  \label{first-chapter}%
+}
+
+\end{document}
+""",
+
+
+
+samples_latex_sectnum'no_sectnum' = 
 """\
 some text
 
 first section
 -------------
 """,
-## # expected output
-head_template.substitute(dict(parts, requirements = parts'requirements' +
-r"""\setcounter{secnumdepth}{0}
-""")) + r"""
+# expected output
+head_template.substitute(dict(parts, requirements=parts'requirements'
+                              + '\\setcounter{secnumdepth}{0}\n')) + r"""
 some text
 
 
@@ -345,8 +532,7 @@
 """,
 
 
-totest_latex_sectnum'sectnum' = 
-# input
+samples_latex_sectnum'sectnum' = 
 """\
 .. sectnum::
 
@@ -355,7 +541,7 @@
 first section
 -------------
 """,
-## # expected output
+# expected output
 head_template.substitute(dict(parts,
     requirements=parts'requirements' + '\\setcounter{secnumdepth}{0}\n'
 )) + r"""
@@ -370,15 +556,14 @@
 """,
 
 
-totest_latex_citations'citations_with_underscore' = 
-# input
+samples_latex_citations'citations_with_underscore' = 
 """\
 Just a test citation my_cite2006_.
 
 .. my_cite2006
    The underscore is mishandled.
 """,
-## # expected output
+# expected output
 head + r"""
 Just a test citation \cite{my_cite2006}.
 
@@ -393,8 +578,7 @@
 
 
 
-totest_latex_citations'adjacent_citations' = 
-# input
+samples_latex_citations'adjacent_citations' = 
 """\
 Two non-citations: MeYou2007_YouMe2007_.
 
@@ -432,8 +616,7 @@
 
 
 
-totest'enumerated_lists' = 
-# input
+samples_default'enumerated_lists' = 
 """\
 1. Item 1.
 2. Second to the previous item this one will explain
@@ -485,8 +668,7 @@
 # as active character (e.g. de (ngerman)).
 
 
-totest'table_caption' = 
-# input
+samples_default'table_caption' = 
 """\
 .. table:: Foo
 
@@ -511,7 +693,7 @@
 """,
 
 
-totest'table_styles' = 
+samples_default'table_styles' = 
 """\
 .. table::
    :class: borderless
@@ -522,22 +704,22 @@
    |  3  |  4  |
    +-----+-----+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{p{0.075\DUtablewidth}p{0.075\DUtablewidth}}
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{p{0.075\\DUtablewidth}p{0.075\\DUtablewidth}}
 
 1
- & 
+ & \n\
 2
- \\
+ \\\\
 
 3
- & 
+ & \n\
 4
- \\
-\end{longtable*}
+ \\\\
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 """\
 .. table::
@@ -547,19 +729,19 @@
    |  1  |2|
    +-----+-+
 """,
-head_booktabs + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{p{0.075\DUtablewidth}p{0.028\DUtablewidth}}
-\toprule
+head_booktabs + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{p{0.075\\DUtablewidth}p{0.028\\DUtablewidth}}
+\\toprule
 
 1
- & 
+ & \n\
 2
- \\
-\bottomrule
-\end{longtable*}
+ \\\\
+\\bottomrule
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 """\
 .. table::
@@ -603,23 +785,23 @@
    |  1  |  2  |
    +-----+-----+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.191\DUtablewidth}|p{0.365\DUtablewidth}|}
-\hline
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{|p{0.191\\DUtablewidth}|p{0.365\\DUtablewidth}|}
+\\hline
 
 1
- & 
+ & \n\
 2
- \\
-\hline
-\end{longtable*}
+ \\\\
+\\hline
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 
 
-totest_table_style_booktabs'table_styles' = 
+samples_table_style_booktabs'table_styles' = 
 # borderless overrides "booktabs" table_style
 """\
 .. table::
@@ -631,22 +813,22 @@
    |  3  |  4  |
    +-----+-----+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{p{0.075\DUtablewidth}p{0.075\DUtablewidth}}
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{p{0.075\\DUtablewidth}p{0.075\\DUtablewidth}}
 
 1
- & 
+ & \n\
 2
- \\
+ \\\\
 
 3
- & 
+ & \n\
 4
- \\
-\end{longtable*}
+ \\\\
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 """\
 .. table::
@@ -673,22 +855,22 @@
    |  1  |  2  |
    +-----+-----+
 """,
-head_booktabs + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{p{0.191\DUtablewidth}p{0.365\DUtablewidth}}
-\toprule
+head_booktabs + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{p{0.191\\DUtablewidth}p{0.365\\DUtablewidth}}
+\\toprule
 
 1
- & 
+ & \n\
 2
- \\
-\bottomrule
-\end{longtable*}
+ \\\\
+\\bottomrule
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 
-totest_table_style_auto'table_styles' = 
+samples_table_style_auto'table_styles' = 
 """\
 .. table::
    :class: borderless
@@ -733,24 +915,23 @@
    |  1  |  2  |
    +-----+-----+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.191\DUtablewidth}|p{0.365\DUtablewidth}|}
-\hline
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{|p{0.191\\DUtablewidth}|p{0.365\\DUtablewidth}|}
+\\hline
 
 1
- & 
+ & \n\
 2
- \\
-\hline
-\end{longtable*}
+ \\\\
+\\hline
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 
 
-totest'table_align' = 
-# input
+samples_default'table_align' = 
 """\
 .. table::
    :align: right
@@ -759,23 +940,23 @@
    |  1  |  2  |
    +-----+-----+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}r{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\hline
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}r{|p{0.075\\DUtablewidth}|p{0.075\\DUtablewidth}|}
+\\hline
 
 1
- & 
+ & \n\
 2
- \\
-\hline
-\end{longtable*}
+ \\\\
+\\hline
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 
 
-totest'table_empty_cells' = 
+samples_default'table_empty_cells' = 
 """\
 ===== ======
 Title
@@ -783,33 +964,33 @@
 entry value1
 ===== ======
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.075\DUtablewidth}|p{0.086\DUtablewidth}|}
-\hline
-\textbf{%
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{|p{0.075\\DUtablewidth}|p{0.086\\DUtablewidth}|}
+\\hline
+\\textbf{%
 Title
-} &  \\
-\hline
-\endfirsthead
-\hline
-\textbf{%
+} &  \\\\
+\\hline
+\\endfirsthead
+\\hline
+\\textbf{%
 Title
-} &  \\
-\hline
-\endhead
-\multicolumn{2}{c}{\hfill ... continued on next page} \\
-\endfoot
-\endlastfoot
+} &  \\\\
+\\hline
+\\endhead
+\\multicolumn{2}{p{0.16\\DUtablewidth}}{\\raggedleft\\ldots continued on next page}\\\\
+\\endfoot
+\\endlastfoot
 
 entry
- & 
+ & \n\
 value1
- \\
-\hline
-\end{longtable*}
+ \\\\
+\\hline
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 """\
 +----+----+
@@ -818,25 +999,25 @@
 |         |
 +---------+
 """,
-head_table + r"""
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.063\DUtablewidth}|p{0.063\DUtablewidth}|}
-\hline
+head_table + """
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{|p{0.063\\DUtablewidth}|p{0.063\\DUtablewidth}|}
+\\hline
 
 c3
- & 
+ & \n\
 c4
- \\
-\hline
-\multicolumn{2}{|p{0.13\DUtablewidth}|}{} \\
-\hline
-\end{longtable*}
+ \\\\
+\\hline
+\\multicolumn{2}{|p{0.13\\DUtablewidth}|}{} \\\\
+\\hline
+\\end{longtable*}
 
-\end{document}
+\\end{document}
 """,
 
 
-totest'table_nonstandard_class' = 
+samples_default'table_nonstandard_class' = 
 """\
 .. table::
    :class: my-class
@@ -850,8 +1031,8 @@
 head_template.substitute(
     dict(
         parts,
-        requirements = parts'requirements' + parts'longtable',
-        fallbacks = r"""
+        requirements=parts'requirements' + parts'longtable',
+        fallbacks=r"""
 % class handling for environments (block-level elements)
 % \begin{DUclass}{spam} tries \DUCLASSspam and
 % \end{DUclass}{spam} tries \endDUCLASSspam
@@ -864,35 +1045,34 @@
 \fi
 """
     )
-) + r"""
-\begin{DUclass}{my-class}
-\setlength{\DUtablewidth}{\linewidth}%
-\begin{longtable*}{|p{0.075\DUtablewidth}|p{0.075\DUtablewidth}|}
-\hline
+) + """
+\\begin{DUclass}{my-class}
+\\setlength{\\DUtablewidth}{\\linewidth}%
+\\begin{longtable*}{|p{0.075\\DUtablewidth}|p{0.075\\DUtablewidth}|}
+\\hline
 
 1
- & 
+ & \n\
 2
- \\
-\hline
+ \\\\
+\\hline
 
 3
- & 
+ & \n\
 4
- \\
-\hline
-\end{longtable*}
-\end{DUclass}
+ \\\\
+\\hline
+\\end{longtable*}
+\\end{DUclass}
 
-\end{document}
+\\end{document}
 """,
 
 
 # The "" needs to be protected (otherwise it will be seen as an
 # option to "\\", "\item", etc. ).
 
-totest'bracket_protection' = 
-# input
+samples_default'bracket_protection' = 
 """
 * no option to this item
 """,
@@ -905,8 +1085,7 @@
 """,
 
 
-totest'literal_block' = 
-# input
+samples_default'literal_block' = 
 """\
 Test special characters {  \\\\  } in literal block::
 
@@ -929,7 +1108,7 @@
 """,
 
 
-totest'raw' = 
+samples_default'raw' = 
 r""".. raw:: latex
 
    $E=mc^2$
@@ -953,9 +1132,42 @@
 
 \end{document}
 """,
+r""".. compound::
+
+  Compound paragraph
+
+  .. raw:: LaTeX
+
+     raw LaTeX block
+
+  compound paragraph continuation.
+""",
+head_template.substitute(
+    dict(parts,
+         fallbacks=r"""
+% class handling for environments (block-level elements)
+% \begin{DUclass}{spam} tries \DUCLASSspam and
+% \end{DUclass}{spam} tries \endDUCLASSspam
+\ifx\DUclass\undefined % poor man's "provideenvironment"
+ \newenvironment{DUclass}1%
+  {% "#1" does not work in end-part of environment.
+   \def\DocutilsClassFunctionName{DUCLASS#1}
+     \csname \DocutilsClassFunctionName \endcsname}%
+  {\csname end\DocutilsClassFunctionName \endcsname}%
+\fi
+""")
+) + r"""
+\begin{DUclass}{compound}
+Compound paragraph
+raw LaTeX block
+compound paragraph continuation.
+\end{DUclass}
+
+\end{document}
+""",
 
 
-totest'title_with_inline_markup' = 
+samples_default'title_with_inline_markup' = 
 """\
 This is the *Title*
 ===================
@@ -997,26 +1209,24 @@
 """,
 
 
-totest_stylesheet'two-styles' = 
-# input
+samples_stylesheet'two-styles' = 
 """two stylesheet links in the header""",
-head_template.substitute(dict(parts, stylesheet =
-r"""\usepackage{data/spam}
-\input{data/ham.tex}
-""")) + r"""
+head_template.substitute(dict(parts,
+stylesheet=r"""\usepackage{%s}
+\input{%s}
+""" % (spam, ham))) + r"""
 two stylesheet links in the header
 
 \end{document}
 """,
 
 
-totest_stylesheet_embed'two-styles' = 
-# input
+samples_stylesheet_embed'two-styles' = 
 """two stylesheets embedded in the header""",
-head_template.substitute(dict(parts, stylesheet =
-r"""% Cannot embed stylesheet 'data/spam.sty':
-%   No such file or directory.
-% embedded stylesheet: data/ham.tex
+head_template.substitute(dict(parts,
+stylesheet=r"""% Cannot embed stylesheet:
+%  Errno 2 No such file or directory: '""" + spam + r""".sty'
+% embedded stylesheet: """ + ham + r"""
 \newcommand{\ham}{wonderful ham}
 
 """)) + r"""
@@ -1026,6 +1236,28 @@
 """,
 
 
+samples_bibtex'alpha' = 
+"""\
+Just a test citation book-full_.
+""",
+head + r"""
+Just a test citation \cite{book-full}.
+
+\bibliographystyle{alpha}
+\bibliography{xampl}
+
+\end{document}
+""",
+"""\
+No bibliography if there is no citation.
+""",
+head + r"""
+No bibliography if there is no citation.
+
+\end{document}
+""",
+
+
+
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_latex2e_misc.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_latex2e_misc.py Changed

@@ -1,7 +1,5 @@
-#! /usr/bin/env python
-# coding: utf-8
-
-# $Id: test_latex2e_misc.py 8582 2020-12-01 09:38:02Z milde $
+#! /usr/bin/env python3
+# $Id: test_latex2e_misc.py 9368 2023-04-28 21:26:36Z milde $
 # Author: Günter Milde
 # Maintainer: docutils-develop@lists.sourceforge.net
 # :Copyright: 2020 Günter Milde,
@@ -17,13 +15,9 @@
 """
 Miscellaneous LaTeX writer tests.
 """
-from __future__ import absolute_import
 
-import os
+import unittest
 
-if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
 from docutils import core
 
 contents_test_input = """\
@@ -37,23 +31,78 @@
 
 """
 
-class TocTestCase(DocutilsTestSupport.StandardTestCase):
+
+class PublishTestCase(unittest.TestCase):
+
+    settings = {'_disable_config': True,
+                # avoid latex writer future warnings:
+                'use_latex_citations': False,
+                'legacy_column_widths': True,
+                }
 
     def test_publish_from_doctree(self):
-        """Ignore the Docutils-generated ToC, when ``use_latex_toc``
-        is True. (This did happen when publishing from a doctree.)
+        """Ignore the Docutils-generated ToC when ``use_latex_toc`` is True.
+
+        (This did happen when publishing from a doctree.)
         """
-        settings_overrides={'output_encoding': 'unicode',
-                            '_disable_config': True,}
+        settings = self.settings.copy()
+        settings'output_encoding' = 'unicode'
         doctree = core.publish_doctree(contents_test_input,
-                                       settings_overrides=settings_overrides)
+                                       settings_overrides=settings)
         result = core.publish_from_doctree(doctree,
-                                     writer_name='latex',
-                                     settings_overrides=settings_overrides)
+                                           writer_name='latex',
+                                           settings_overrides=settings)
         self.assertNotIn(r'\item \hyperreffoo{foo}', result)
         # self.assertIn(r'\tableofcontents', result)
 
+    def test_publish_parts(self):
+        """Check for the presence of documented parts.
+        """
+        parts = core.publish_parts(contents_test_input,
+                                   writer_name='latex',
+                                   settings_overrides=self.settings)
+        documented_parts = 
+            'abstract',
+            'body',
+            'body_pre_docinfo',
+            'dedication',
+            'docinfo',
+            'encoding',
+            'errors',
+            'fallbacks',
+            'head_prefix',
+            'latex_preamble',
+            'pdfsetup',
+            'requirements',
+            'stylesheet',
+            'subtitle',
+            'title',
+            'titledata',
+            'version',
+            'whole'
+            
+        self.assertEqual(sorted(parts.keys()), documented_parts)
+
+
+class WarningsTestCase(unittest.TestCase):
+
+    def test_future_warnings(self):
+        """Warn about changing defaults."""
+        # Warn only if not set (uncommenting should make test fail):
+        settings = {'_disable_config': True,
+                    # 'use_latex_citations': False,
+                    # 'legacy_column_widths': True,
+                    'output_encoding': 'unicode',
+                    }
+        with self.assertWarnsRegex(FutureWarning,
+                                   '"legacy_column_widths" will change'):
+            core.publish_string('warnings test', writer_name='latex',
+                                settings_overrides=settings)
+        with self.assertWarnsRegex(FutureWarning,
+                                   '"use_latex_citations" will change'):
+            core.publish_string('warnings test', writer_name='latex',
+                                settings_overrides=settings)
+
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_manpage.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_manpage.py Changed

@@ -1,24 +1,39 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 
-# $Id: test_latex2e.py 6003 2009-06-27 20:44:09Z milde $
 # Author: engelbert gruber <grubert@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for manpage writer.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.core import publish_string
 
 
-def suite():
-    settings = {}
-    s = DocutilsTestSupport.PublishTestSuite('manpage', suite_settings=settings)
-    s.generateTests(totest)
-    return s
+class WriterPublishTestCase(unittest.TestCase):
+    def test_publish(self):
+        writer_name = 'manpage'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                        }).decode()
+                    self.assertEqual(output, case_expected)
+
 
 indend_macros = r""".
 .nr rst2man-indent-level 0
@@ -52,14 +67,13 @@
 totest = {}
 
 totest'blank' = 
-        "", 
+        "",
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH ""  "" "" ""
+""" + indend_macros + """.TH ""  "" ""
 .SH NAME
- \- 
-.\" Generated by docutils manpage writer.
+ \\- \n\
+.\\" Generated by docutils manpage writer.
 .
 """,
         r"""Hello, world.
@@ -71,25 +85,24 @@
 """,
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH "HELLO, WORLD."  "" "" ""
+""" + indend_macros + """.TH "HELLO, WORLD."  "" ""
 .SH NAME
-Hello, world. \- 
+Hello, world. \\- \n\
 .sp
-\fBWARNING:\fP
+\\fBWARNING:\\fP
 .INDENT 0.0
 .INDENT 3.5
-This broke docutils\-sphinx.
+This broke docutils\\-sphinx.
 .UNINDENT
 .UNINDENT
-.\" Generated by docutils manpage writer.
+.\\" Generated by docutils manpage writer.
 .
 """,
     
 
 totest'simple' = 
         """\
-========        
+========
  simple
 ========
 
@@ -136,7 +149,7 @@
    * bullet list
    * bull and list
 
-.. admonition:: homegrown 
+.. admonition:: homegrown
 
    something important
 
@@ -144,11 +157,10 @@
 
 and . in a line and at line start
 .in a paragraph
-""", 
+""",
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH "SIMPLE" 1 "2009-08-05" "0.1" "text processing"
+""" + indend_macros + r""".TH "SIMPLE" 1 "2009-08-05" "0.1" "text processing"
 .SH NAME
 simple \- The way to go
 .SH SYNOPSIS
@@ -224,12 +236,11 @@
            1     2
           abc   so
         ====== =====
-""", 
+""",
 '''\
 .\\" Man page generated from reStructuredText.
 .
-'''+indend_macros+
-'''.TH ""  "" "" ""
+''' + indend_macros + '''.TH ""  "" ""
 .SH NAME
  \\- \n\
 .INDENT 0.0
@@ -282,12 +293,11 @@
 
 
    bla bla bla
-""", 
+""",
         """\
 .\\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-""".TH ""  "" "" ""
+""" + indend_macros + """.TH ""  "" ""
 .SH NAME
  \\- \n\
 optin group with dot as group item
@@ -317,7 +327,8 @@
 bla bla bla
 .UNINDENT
 .\\" Generated by docutils manpage writer.
-.""",
+.
+""",
     
 
 totest'definitionlist' = 
@@ -339,16 +350,14 @@
     Description of Term 1 Description of Term 1 Description of Term 1
     Description of Term 1 Description of Term 1
 
-""", 
+""",
 '''\
 .\\" Man page generated from reStructuredText.
 .
-'''+indend_macros+
-'''.TH "DEFINITION LIST TEST"  "" "" ""
+''' + indend_macros + '''.TH "DEFINITION LIST TEST"  "" ""
 .SH NAME
 Definition List Test \\- \n\
-'''+
-'''.SS Abstract
+''' + '''.SS Abstract
 .sp
 Docinfo is required.
 .SH SECTION
@@ -362,7 +371,8 @@
 Description of Term 1 Description of Term 1
 .UNINDENT
 .\\" Generated by docutils manpage writer.
-.''',
+.
+''',
     
 
 totest'cmdlineoptions' = 
@@ -370,29 +380,28 @@
   -h, --help                 show this help
   --output FILE, -o FILE     output filename
   -i DEVICE, --input DEVICE  input device
-""", 
+""",
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH ""  "" "" ""
+""" + indend_macros + """.TH ""  "" ""
 .SH NAME
- \- 
+ \\- \n\
 .INDENT 0.0
 .TP
 .B optional arguments:
 .INDENT 7.0
 .TP
-.B  \-h\fP,\fB  \-\-help
+.B  \\-h\\fP,\\fB  \\-\\-help
 show this help
 .TP
-.BI \-\-output \ FILE\fR,\fB \ \-o \ FILE
+.BI \\-\\-output \\ FILE\\fR,\\fB \\ \\-o \\ FILE
 output filename
 .TP
-.BI \-i \ DEVICE\fR,\fB \ \-\-input \ DEVICE
+.BI \\-i \\ DEVICE\\fR,\\fB \\ \\-\\-input \\ DEVICE
 input device
 .UNINDENT
 .UNINDENT
-.\" Generated by docutils manpage writer.
+.\\" Generated by docutils manpage writer.
 .
 """,
     
@@ -403,14 +412,13 @@
 """,
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH ""  "" "" ""
+""" + indend_macros + """.TH ""  "" ""
 .SH NAME
- \- 
+ \\- \n\
 .IP docutils 5
 blah blah blah
 .IP empty_citation 5
-.\" Generated by docutils manpage writer.
+.\\" Generated by docutils manpage writer.
 .
 """,
     
@@ -423,17 +431,67 @@
 """,
         r""".\" Man page generated from reStructuredText.
 .
-"""+indend_macros+
-r""".TH ""  "" "" ""
+""" + indend_macros + """.TH ""  "" ""
 .SH NAME
- \- 
+ \\- \n\
 some rubric
 .INDENT 0.0
-.IP \(bu 2
+.IP \\(bu 2
 followed by
-.IP \(bu 2
+.IP \\(bu 2
 a list
 .UNINDENT
+.\\" Generated by docutils manpage writer.
+.
+""",
+    
+
+totest'double_quote' = 
+        """in "defintion list"
+    double quotes must be escaped on macro invocations.
+
+They are "escaped" anywhere.
+""",
+        r""".\" Man page generated from reStructuredText.
+.
+""" + indend_macros + """.TH ""  "" ""
+.SH NAME
+ \\- \n\
+.INDENT 0.0
+.TP
+.B in \\(dqdefintion list\\(dq
+double quotes must be escaped on macro invocations.
+.UNINDENT
+.sp
+They are \\(dqescaped\\(dq anywhere.
+.\\" Generated by docutils manpage writer.
+.
+""",
+    
+
+totest'man_header' = 
+        """
+============
+ page title
+============
+
+in short
+--------
+
+:Manual section: 3
+:Manual group: the books
+:Version: 0.0
+:Date: 3/Nov/2022
+
+Test title, docinfo to man page header.
+""",
+        r""".\" Man page generated from reStructuredText.
+.
+""" + indend_macros + r""".TH "PAGE TITLE" 3 "3/Nov/2022" "0.0" "the books"
+.SH NAME
+page title \- in short
+.sp
+Test title, docinfo to man page header.
 .\" Generated by docutils manpage writer.
 .
 """,
@@ -441,5 +499,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_null.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_null.py Changed

@@ -1,23 +1,43 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_null.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_null.py 9277 2022-11-26 23:15:13Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test for Null writer.
 """
-from __future__ import absolute_import
 
-if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+from pathlib import Path
+import sys
+import unittest
 
+if __name__ == '__main__':
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.core import publish_string
+
+
+class WriterPublishTestCase(unittest.TestCase):
+    def test_publish(self):
+        writer_name = 'null'
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                        },
+                    )
+                    if isinstance(output, bytes):
+                        output = output.decode('utf-8')
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.PublishTestSuite('null')
-    s.generateTests(totest)
-    return s
 
 totest = {}
 
@@ -29,5 +49,4 @@
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_odt.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_odt.py Changed

@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_odt.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_odt.py 9339 2023-04-08 21:08:59Z milde $
 # Author: Dave Kuhlman <dkuhlman@rexx.com>
 # Copyright: This module has been placed in the public domain.
 
@@ -29,40 +29,47 @@
 5. If any other tests fail, that's a possible regression.
 
 """
-from __future__ import absolute_import
 
+from io import BytesIO
+from pathlib import Path
 import os
-import zipfile
+import sys
+import unittest
 import xml.etree.ElementTree as etree
-from io import BytesIO
+import zipfile
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
 import docutils
 import docutils.core
 
+# FUNCTIONAL_ROOT is ./test/functional/ from the docutils root
+FUNCTIONAL_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', 'functional'))
+
 #
 # Globals
-TEMP_FILE_PATH = 'functional/output/'
-INPUT_PATH = 'functional/input/'
-EXPECTED_PATH = 'functional/expected/'
+TEMP_FILE_PATH = os.path.join(FUNCTIONAL_ROOT, 'output')
+INPUT_PATH = os.path.join(FUNCTIONAL_ROOT, 'input')
+EXPECTED_PATH = os.path.join(FUNCTIONAL_ROOT, 'expected')
 
 
-class DocutilsOdtTestCase(DocutilsTestSupport.StandardTestCase):
+class DocutilsOdtTestCase(unittest.TestCase):
 
-    def process_test(self, input_filename, expected_filename, 
-            save_output_name=None, settings_overrides=None):
+    def process_test(self, input_filename, expected_filename,
+                     save_output_name=None, settings_overrides=None):
         # Test that xmlcharrefreplace is the default output encoding
         # error handler.
-        input_file = open(INPUT_PATH + input_filename, 'rb')
-        expected_file = open(EXPECTED_PATH + expected_filename, 'rb')
+        input_file = open(os.path.join(INPUT_PATH, input_filename), 'rb')
+        expected_file = open(os.path.join(EXPECTED_PATH, expected_filename), 'rb')
         input = input_file.read()
         expected = expected_file.read()
         input_file.close()
         expected_file.close()
         if settings_overrides is None:
-            settings_overrides={}
+            settings_overrides = {}
             settings_overrides'_disable_config' = True
             settings_overrides'language_code' = 'en-US'
 
@@ -71,11 +78,11 @@
             reader_name='standalone',
             writer_name='odf_odt',
             settings_overrides=settings_overrides)
-##         msg = 'file length not equal: expected length: %d  actual length: %d' % (
-##             len(expected), len(result), )
-##         self.assertEqual(str(len(result)), str(len(expected)))
+        # msg = 'file length not equal: expected length: %d  actual length: %d' % (
+        #           len(expected), len(result), )
+        # self.assertEqual(str(len(result)), str(len(expected)))
         if save_output_name:
-            filename = '%s%s%s' % (TEMP_FILE_PATH, os.sep, save_output_name,)
+            filename = os.path.join(TEMP_FILE_PATH, save_output_name)
             outfile = open(filename, 'wb')
             outfile.write(result)
             outfile.close()
@@ -87,7 +94,7 @@
 
     def reorder_attributes(self, root):
         """
-        Make attribute order independent of python version. 
+        Make attribute order independent of python version.
         python3.8 is different to previous.
         """
         for el in root.iter():
@@ -106,21 +113,8 @@
         content1 = zfile.read(filename)
         doc = etree.fromstring(content1)
         self.reorder_attributes(doc)
-        #content2 = doc.toprettyxml(indent='  ')
-        content2 = etree.tostring(doc)
-        return content2
-
-    def assertEqual(self, first, second, msg=None):
-        if msg is None:
-            msg2 = msg
-        else:
-            sep = '+' * 60
-            msg1 = '\n%s\nresult:\n%s\n%s\nexpected:\n%s\n%s' % (
-                sep, first, sep, second, sep, )
-            #msg2 = '%s\n%s' % (msg1, msg, )
-            msg2 = '%s' % (msg, )
-        DocutilsTestSupport.StandardTestCase.assertEqual(self,
-            first, second, msg2)
+        # return doc.toprettyxml(indent='  ')
+        return etree.tostring(doc)
 
     #
     # Unit test methods
@@ -132,27 +126,22 @@
 
     def test_odt_basic(self):
         self.process_test('odt_basic.txt', 'odt_basic.odt',
-            save_output_name='odt_basic.odt'
-            )
+                          save_output_name='odt_basic.odt')
 
     def test_odt_nested_class(self):
         self.process_test('odt_nested_class.txt',
                           'odt_nested_class.odt',
-                          save_output_name='odt_nested_class.odt'
-        )
+                          save_output_name='odt_nested_class.odt')
         self.process_test('odt_unnested_class.txt',
                           'odt_unnested_class.odt',
-                          save_output_name='odt_unnested_class.odt'
-        )
+                          save_output_name='odt_unnested_class.odt')
         self.process_test('odt_no_class.txt',
                           'odt_no_class.odt',
-                          save_output_name='odt_no_class.odt'
-        )
+                          save_output_name='odt_no_class.odt')
 
     def test_odt_tables1(self):
         self.process_test('odt_tables1.txt', 'odt_tables1.odt',
-            save_output_name='odt_tables1.odt'
-            )
+                          save_output_name='odt_tables1.odt')
 
     def test_odt_custom_headfoot(self):
         settings_overrides = {
@@ -161,14 +150,12 @@
             'language_code': 'en-US',
             }
         self.process_test('odt_custom_headfoot.txt', 'odt_custom_headfoot.odt',
-            settings_overrides=settings_overrides,
-            save_output_name='odt_custom_headfoot.odt'
-            )
+                          settings_overrides=settings_overrides,
+                          save_output_name='odt_custom_headfoot.odt')
 
     def test_odt_header_footer(self):
         self.process_test('odt_header_footer.txt', 'odt_header_footer.odt',
-            save_output_name='odt_header_footer.odt'
-            )
+                          save_output_name='odt_header_footer.odt')
 
     def test_odt_literal_block(self):
         self.process_test('odt_literal_block.txt', 'odt_literal_block.odt')
@@ -181,12 +168,11 @@
 
     def test_odt_footnotes(self):
         self.process_test('odt_footnotes.txt', 'odt_footnotes.odt',
-            save_output_name='odt_footnotes.odt'
-            )
+                          save_output_name='odt_footnotes.odt')
+
     def test_odt_raw(self):
         self.process_test('odt_raw.txt', 'odt_raw.odt',
-            save_output_name='odt_raw.odt'
-            )
+                          save_output_name='odt_raw.odt')
 
     #
     # Template for new tests.
@@ -194,13 +180,11 @@
     #   functional/expected/odt_xxxx.odt
     # Replace all xxxx with name of your test.
     #
-##     def test_odt_xxxx(self):
-##         self.process_test('odt_xxxx.txt', 'odt_xxxx.odt')
-
+    # def test_odt_xxxx(self):
+    #     self.process_test('odt_xxxx.txt', 'odt_xxxx.odt')
 
 # -----------------------------------------------------------------
 
 
 if __name__ == '__main__':
-    import unittest
     unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_pseudoxml.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_pseudoxml.py Changed

@@ -1,34 +1,69 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_pseudoxml.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_pseudoxml.py 9369 2023-05-02 23:04:27Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This module has been placed in the public domain.
 
 """
 Test for pseudo-XML writer.
 """
-from __future__ import absolute_import
+
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+from docutils.core import publish_string
+
+
+class WriterPublishTestCase(unittest.TestCase):
+    maxDiff = None
+
+    def test_publish(self):
+        writer_name = 'pseudoxml'
 
+        for name, cases in totest.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                        }).decode()
+                    self.assertEqual(output, case_expected)
+
+        for name, cases in totest_detailed.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_detailed{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides={
+                            '_disable_config': True,
+                            'strict_visitor': True,
+                            'detailed': True,
+                        }).decode()
+                    self.assertEqual(output, case_expected)
 
-def suite():
-    s = DocutilsTestSupport.PublishTestSuite('pseudoxml')
-    s.generateTests(totest)
-    return s
 
 totest = {}
+totest_detailed = {}
 
 totest'basic' = 
 # input
-"""\
+r"""
 This is a paragraph.
 
 ----------
 
-This is another paragraph.
+This is a paragraph
+with \escaped \characters.
 
 A Section
 ---------
@@ -42,7 +77,8 @@
         This is a paragraph.
     <transition>
     <paragraph>
-        This is another paragraph.
+        This is a paragraph
+        with escaped characters.
     <section ids="a-section" names="a\\ section">
         <title>
             A Section
@@ -51,6 +87,29 @@
 """
 
 
+totest_detailed'basic' = 
+# input
+totest'basic'00,
+# output
+"""\
+<document source="<string>">
+    <paragraph>
+        <#text>
+            'This is a paragraph.'
+    <transition>
+    <paragraph>
+        <#text>
+            'This is a paragraph\\n'
+            'with \\x00escaped \\x00characters.'
+    <section ids="a-section" names="a\\ section">
+        <title>
+            <#text>
+                'A Section'
+        <paragraph>
+            <#text>
+                'Foo.'
+"""
+
+
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/test/test_writers/test_s5.py -> _service:tar_scm:docutils-0.20.tar.gz/test/test_writers/test_s5.py Changed

@@ -1,38 +1,65 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_s5.py 8481 2020-01-31 08:17:24Z milde $
+# $Id: test_s5.py 9369 2023-05-02 23:04:27Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
 """
 Tests for the S5/HTML writer.
 """
-from __future__ import absolute_import
 
 import os
 import platform
+from pathlib import Path
+import sys
+import unittest
 
 if __name__ == '__main__':
-    import __init__
-from test_writers import DocutilsTestSupport
+    # prepend the "docutils root" to the Python library path
+    # so we import the local `docutils` package.
+    sys.path.insert(0, str(Path(__file__).resolve().parents2))
+
+import docutils
+from docutils.core import publish_string
+
+
+class WriterPublishTestCase(unittest.TestCase):
+    def test_publish(self):
+        writer_name = 's5'
+        settings = {
+            '_disable_config': True,
+            'strict_visitor': True,
+            'stylesheet_path': '/test.css',
+            'embed_stylesheet': False,
+        }
+        for name, cases in totest_1.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_1{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides=settings.copy()
+                        ).decode()
+                    self.assertEqual(output, case_expected)
+
+        settings'hidden_controls' = False
+        settings'view_mode' = 'outline'
+        for name, cases in totest_2.items():
+            for casenum, (case_input, case_expected) in enumerate(cases):
+                with self.subTest(id=f'totest_2{name!r}{casenum}'):
+                    output = publish_string(
+                        source=case_input,
+                        writer_name=writer_name,
+                        settings_overrides=settings.copy()
+                        ).decode()
+                    self.assertEqual(output, case_expected)
 
 
-def suite():
-    settings = {'stylesheet_path': '/test.css',
-                'embed_stylesheet': 0,}
-    s = DocutilsTestSupport.PublishTestSuite('s5', suite_settings=settings)
-    s.generateTests(totest_1)
-    settings'hidden_controls' = 0
-    settings'view_mode' = 'outline'
-    s.generateTests(totest_2)
-    return s
-
-interpolations = {
-        'version': DocutilsTestSupport.docutils.__version__,
-        'drive': '', }
-
 if platform.system() == "Windows":
-    interpolations'drive' = "C:"
+    drive_prefix = os.path.splitdrive(os.getcwd())0
+else:
+    drive_prefix = ""
+
 
 totest_1 = {}
 totest_2 = {}
@@ -50,16 +77,16 @@
 
 Slide text.
 """,
-"""\
-<?xml version="1.0" encoding="utf-8" ?>
+f"""\
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
 <meta name="version" content="S5 1.1" />
 <title>Show Title</title>
-<link rel="stylesheet" href="%(drive)s/test.css" type="text/css" />
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />
 
 <meta name="defaultView" content="slideshow" />
 <meta name="controlVis" content="hidden" />
@@ -75,7 +102,7 @@
       type="text/css" media="projection" id="operaFix" />
 
 <style type="text/css">
-#currentSlide {display: none;}
+#currentSlide {{display: none;}}
 </style>
 </head>
 <body>
@@ -104,7 +131,7 @@
 </div>
 </body>
 </html>
-""" % interpolations
+"""
 
 
 totest_2'settings' = 
@@ -115,16 +142,16 @@
 
 We're just checking the settings
 """,
-"""\
-<?xml version="1.0" encoding="utf-8" ?>
+f"""\
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils %(version)s: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils {docutils.__version__}: https://docutils.sourceforge.io/" />
 <meta name="version" content="S5 1.1" />
 <title>Bogus Slide Show</title>
-<link rel="stylesheet" href="%(drive)s/test.css" type="text/css" />
+<link rel="stylesheet" href="{drive_prefix}/test.css" type="text/css" />
 
 <meta name="defaultView" content="outline" />
 <meta name="controlVis" content="visible" />
@@ -140,7 +167,7 @@
       type="text/css" media="projection" id="operaFix" />
 
 <style type="text/css">
-#currentSlide {display: none;}
+#currentSlide {{display: none;}}
 </style>
 </head>
 <body>
@@ -164,9 +191,8 @@
 </div>
 </body>
 </html>
-""" % interpolations
+"""
 
 
 if __name__ == '__main__':
-    import unittest
-    unittest.main(defaultTest='suite')
+    unittest.main()

_service:tar_scm:docutils-0.17.1.tar.gz/tools/buildhtml.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/buildhtml.py Changed

@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: buildhtml.py 8643 2021-03-26 13:51:21Z milde $
+# $Id: buildhtml.py 9329 2023-02-07 14:24:46Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This module has been placed in the public domain.
 
@@ -18,18 +18,18 @@
 try:
     import locale
     locale.setlocale(locale.LC_ALL, '')
-except:
+except Exception:
     pass
 
-import sys
+from fnmatch import fnmatch
 import os
 import os.path
-import copy
-from fnmatch import fnmatch
+import sys
+import warnings
+
 import docutils
-from docutils import ApplicationError
-from docutils import core, frontend, utils
-from docutils.utils.error_reporting import ErrorOutput, ErrorString
+import docutils.io
+from docutils import core, frontend, utils, ApplicationError
 from docutils.parsers import rst
 from docutils.readers import standalone, pep
 from docutils.writers import html4css1, html5_polyglot, pep_html
@@ -44,7 +44,7 @@
 class SettingsSpec(docutils.SettingsSpec):
 
     """
-    Runtime settings & command-line options for the front end.
+    Runtime settings & command-line options for the "buildhtml" front end.
     """
 
     prune_default = '.hg', '.bzr', '.git', '.svn', 'CVS'
@@ -68,7 +68,7 @@
           '--prune',
           {'metavar': '<directory>', 'action': 'append',
            'validator': frontend.validate_colon_separated_string_list,
-           'default': prune_default,}),
+           'default': prune_default}),
          ('Recursively ignore files matching any of the given '
           'wildcard (shell globbing) patterns (separated by colons).',
           '--ignore',
@@ -80,12 +80,12 @@
           '--writer',
           {'metavar': '<writer>',
            'choices': 'html', 'html4', 'html5',
-           'default': 'html'}),
-         ('Obsoleted by "--writer".',
+           # 'default': 'html' (set below)
+           }),
+         (frontend.SUPPRESS_HELP,  # Obsoleted by "--writer"
           '--html-writer',
-          {'dest': 'writer',
-           'metavar': '<writer>',
-           'choices': 'html', 'html4', 'html5',}),
+          {'metavar': '<writer>',
+           'choices': 'html', 'html4', 'html5'}),
          ('Work silently (no progress messages).  Independent of "--quiet".',
           '--silent',
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
@@ -105,20 +105,17 @@
     """
 
     def check_values(self, values, args):
-        frontend.OptionParser.check_values(self, values, args)
+        super().check_values(values, args)
         values._source = None
         return values
 
     def check_args(self, args):
-        source = destination = None
-        if args:
-            self.values._directories = args
-        else:
-            self.values._directories = os.getcwd()
-        return source, destination
+        self.values._directories = args or os.getcwd()
+        # backwards compatibility:
+        return None, None
 
 
-class Struct(object):
+class Struct:
 
     """Stores data attributes for dotted-attribute access."""
 
@@ -126,20 +123,20 @@
         self.__dict__.update(keywordargs)
 
 
-class Builder(object):
+class Builder:
 
     def __init__(self):
         self.publishers = {
             '': Struct(components=(pep.Reader, rst.Parser, pep_html.Writer,
                                    SettingsSpec)),
             'html4': Struct(components=(rst.Parser, standalone.Reader,
-                                       html4css1.Writer, SettingsSpec),
-                           reader_name='standalone',
-                           writer_name='html4'),
+                                        html4css1.Writer, SettingsSpec),
+                            reader_name='standalone',
+                            writer_name='html4'),
             'html5': Struct(components=(rst.Parser, standalone.Reader,
-                                       html5_polyglot.Writer, SettingsSpec),
-                           reader_name='standalone',
-                           writer_name='html5'),
+                                        html5_polyglot.Writer, SettingsSpec),
+                            reader_name='standalone',
+                            writer_name='html5'),
             'PEPs': Struct(components=(rst.Parser, pep.Reader,
                                        pep_html.Writer, SettingsSpec),
                            reader_name='pep',
@@ -162,19 +159,31 @@
         config file settings and command-line options by
         `self.get_settings()`.
         """
-        for name, publisher in self.publishers.items():
-            option_parser = OptionParser(
-                components=publisher.components, read_config_files=1,
-                usage=usage, description=description)
-            publisher.option_parser = option_parser
-            publisher.setting_defaults = option_parser.get_default_values()
-            frontend.make_paths_absolute(publisher.setting_defaults.__dict__,
-                                         option_parser.relative_path_settings)
-            publisher.config_settings = (
-                option_parser.get_standard_config_settings())
-        self.settings_spec = self.publishers''.option_parser.parse_args(
-            values=frontend.Values())   # no defaults; just the cmdline opts
-        self.initial_settings = self.get_settings('')
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            for name, publisher in self.publishers.items():
+                option_parser = OptionParser(
+                    components=publisher.components, read_config_files=True,
+                    usage=usage, description=description)
+                publisher.option_parser = option_parser
+                publisher.setting_defaults = option_parser.get_default_values()
+                frontend.make_paths_absolute(
+                    publisher.setting_defaults.__dict__,
+                    option_parser.relative_path_settings)
+                publisher.config_settings = (
+                    option_parser.get_standard_config_settings())
+            self.settings_spec = self.publishers''.option_parser.parse_args(
+                values=frontend.Values())  # no defaults; just the cmdline opts
+            self.initial_settings = self.get_settings('')
+
+        if self.initial_settings.html_writer is not None:
+            warnings.warn('The configuration setting "html_writer" '
+                          'will be removed in Docutils 2.0. '
+                          'Use setting "writer" instead.',
+                          FutureWarning, stacklevel=5)
+        if self.initial_settings.writer is None:
+            self.initial_settings.writer = (self.initial_settings.html_writer
+                                            or 'html')
 
     def get_settings(self, publisher_name, directory=None):
         """
@@ -185,7 +194,9 @@
         Assumes the current directory has been set.
         """
         publisher = self.publisherspublisher_name
-        settings = frontend.Values(publisher.setting_defaults.__dict__)
+        with warnings.catch_warnings():
+            warnings.filterwarnings('ignore', category=DeprecationWarning)
+            settings = frontend.Values(publisher.setting_defaults.__dict__)
         settings.update(publisher.config_settings, publisher.option_parser)
         if directory:
             local_config = publisher.option_parser.get_config_file_settings(
@@ -215,7 +226,7 @@
 
     def visit(self, directory, names, subdirectories):
         settings = self.get_settings('', directory)
-        errout = ErrorOutput(encoding=settings.error_encoding)
+        errout = docutils.io.ErrorOutput(encoding=settings.error_encoding)
         if settings.prune and (os.path.abspath(directory) in settings.prune):
             errout.write('/// ...Skipping directory (pruned): %s\n' %
                          directory)
@@ -242,24 +253,23 @@
         else:
             publisher = self.initial_settings.writer
         settings = self.get_settings(publisher, directory)
-        errout = ErrorOutput(encoding=settings.error_encoding)
+        errout = docutils.io.ErrorOutput(encoding=settings.error_encoding)
         pub_struct = self.publisherspublisher
         settings._source = os.path.normpath(os.path.join(directory, name))
-        settings._destination = settings._source:-4+'.html'
+        settings._destination = settings._source:-4 + '.html'
         if not self.initial_settings.silent:
             errout.write('    ::: Processing: %s\n' % name)
             sys.stderr.flush()
-        try:
-            if not settings.dry_run:
+        if not settings.dry_run:
+            try:
                 core.publish_file(source_path=settings._source,
-                              destination_path=settings._destination,
-                              reader_name=pub_struct.reader_name,
-                              parser_name='restructuredtext',
-                              writer_name=pub_struct.writer_name,
-                              settings=settings)
-        except ApplicationError:
-            error = sys.exc_info()1  # get exception in Python 3.x
-            errout.write('        %s\n' % ErrorString(error))
+                                  destination_path=settings._destination,
+                                  reader_name=pub_struct.reader_name,
+                                  parser_name='restructuredtext',
+                                  writer_name=pub_struct.writer_name,
+                                  settings=settings)
+            except ApplicationError as err:
+                errout.write(f'        {type(err).__name__}: {err}\n')
 
 
 if __name__ == "__main__":

_service:tar_scm:docutils-0.17.1.tar.gz/tools/dev/create_unimap.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/dev/create_unimap.py Changed

@@ -1,36 +1,24 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: create_unimap.py 8367 2019-08-27 12:09:56Z milde $
+# $Id: create_unimap.py 9030 2022-03-05 23:28:32Z milde $
 # Author: Lea Wiemann <LeWiemann@gmail.com>
 # Copyright: This file has been placed in the public domain.
 
 # Call: create_unimap.py < unicode.xml > unicode_latex.py
 #
 # Get unicode.xml from
-# <http://www.w3.org/2003/entities/xml/unicode.xml>.
+# <https://www.w3.org/2003/entities/xml/unicode.xml>.
 
-from __future__ import print_function
 from xml.dom import minidom
 import sys
 import pprint
 
-if sys.version_info >= (3, 0):
-    unicode = str  #noqa
-else:
-    bytes = str  # noqa
-    chr = unichr  # noqa
-
-
-def w(s):
-    if sys.version_info >= (3, 0) and isinstance(s, unicode):
-        s = s.encode('utf8')
-    sys.stdout.write(s)
 
 text_map = {}
 math_map = {}
 
 
-class Visitor(object):
+class Visitor:
     """Node visitor for contents of unicode.xml."""
 
     def visit_character(self, node):
@@ -51,6 +39,7 @@
                 else:
                     text_mapchr(int(code)) = '{%s}' % latex_code
 
+
 def call_visitor(node, visitor=Visitor()):
     if isinstance(node, minidom.Text):
         name = 'Text'
@@ -63,6 +52,7 @@
     if hasattr(visitor, 'depart_' + name):
         getattr(visitor, 'depart_' + name)(node)
 
+
 document = minidom.parse(sys.stdin)
 call_visitor(document)
 
@@ -77,10 +67,10 @@
 print('')
 print('# This is a mapping of Unicode characters to LaTeX equivalents.')
 print('# The information has been extracted from')
-print('# <http://www.w3.org/2003/entities/xml/unicode.xml>, written by')
+print('# <https://www.w3.org/2003/entities/xml/unicode.xml>, written by')
 print('# David Carlisle and Sebastian Rahtz.')
 print('#')
 print('# The extraction has been done by the "create_unimap.py" script')
-print('# located at <http://docutils.sf.net/tools/dev/create_unimap.py>.')
+print('# located at <https://docutils.sourceforge.io/tools/dev/create_unimap.py>.')  # noqa:501
 print('')
 print('unicode_map = %s' % pprint.pformat(unicode_map, indent=0))

_service:tar_scm:docutils-0.17.1.tar.gz/tools/dev/generate_punctuation_chars.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/dev/generate_punctuation_chars.py Changed

@@ -1,6 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# :Copyright: © 2011, 2017 Günter Milde.
+#!/usr/bin/env python3
+# :Copyright: © 2011, 2017, 2022 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
 #    Copying and distribution of this file, with or without modification,
@@ -10,50 +9,39 @@
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 
-# :Id: $Id: generate_punctuation_chars.py 8554 2020-09-04 16:52:11Z milde $
+# :Id: $Id: generate_punctuation_chars.py 9270 2022-11-24 20:28:03Z milde $
 #
 # ::
 
-"""(Re)generate the utils.punctuation_chars module."""
+"""(Re)generate the utils.punctuation_chars module.
 
-# (re)generate the utils.punctuation_chars module
-# ===============================================
-#
-# The category of some characters can change with the development of the
-# Unicode standard. This tool checks the patterns in `utils.punctuation_chars`
-# against a re-calculation based on the "unicodedata" stdlib module
-# which may give different results for different Python versions.
-#
-# Updating the module with changed `unicode_punctuation_categories` (due to
-# a new Python or Unicode standard version is an API cange (may render valid
-# rST documents invalid). It should only be done for "feature releases" and
-# requires also updating the specification of `inline markup recognition
-# rules`_ in ../../docs/ref/rst/restructuredtext.txt.
-#
-# .. _inline markup recognition rules:
-#     ../../docs/ref/rst/restructuredtext.html#inline-markup
+The category of some characters can change with the development of the
+Unicode standard. This tool checks the patterns in `utils.punctuation_chars`
+against a re-calculation based on the "unicodedata" stdlib module
+which may give different results for different Python versions.
 
-from __future__ import print_function
+.. admonition:: API change
+
+   Updating the module with changed `unicode_punctuation_categories`
+   (due to a new Python or Unicode standard version is an API change
+   (may render valid rST documents invalid). It should only be done for
+   "feature releases" and requires also updating the specification of
+   `inline markup recognition rules`_.
+
+   .. _inline markup recognition rules:
+      https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
+      #inline-markup-recognition-rules
+"""
 
 import sys
 import unicodedata
 
-if sys.version_info >= (3, 0):
-    unichr = chr  # unichr not available in Py3k
-else:
-    import codecs
-    sys.stdout = codecs.getwriter('UTF-8')(sys.stdout)
-
 
 # Template for utils.punctuation_chars
 # ------------------------------------
-#
-# Problem: ``ur`` prefix fails with Py 3.5 ::
 
-module_template = u'''#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# :Id: $Id: generate_punctuation_chars.py 8554 2020-09-04 16:52:11Z milde $
-# :Copyright: © 2011, 2017 Günter Milde.
+module_template = r'''# :Id: $Id: generate_punctuation_chars.py 9270 2022-11-24 20:28:03Z milde $
+# :Copyright: © 2011, 2017, 2022 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
 #    Copying and distribution of this file, with or without modification,
@@ -67,9 +55,6 @@
 # ``docutils/tools/dev/generate_punctuation_chars.py``.
 # ::
 
-import sys, re
-import unicodedata
-
 """Docutils character category patterns.
 
    Patterns for the implementation of the `inline markup recognition rules`_
@@ -92,46 +77,47 @@
    "unicodedata" module of Python %(python_version)s (based on Unicode version %(unidata_version)s).
 
    .. _inline markup recognition rules:
-      http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules
+      https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
+      #inline-markup-recognition-rules
 """
 
 %(openers)s
 %(closers)s
 %(delimiters)s
-if sys.maxunicode >= 0x10FFFF: # "wide" build
-%(delimiters_wide)s
-closing_delimiters = u'\\\\\\\\.,;!?'
+closing_delimiters = r'\\.,;!?'
 
 
 # Matching open/close quotes
 # --------------------------
 
-quote_pairs = {# open char: matching closing characters # usage example
-               u'\\xbb':   u'\\xbb',         # » » Swedish
-               u'\\u2018': u'\\u201a',       # ‘ ‚ Albanian/Greek/Turkish
-               u'\\u2019': u'\\u2019',       # ’ ’ Swedish
-               u'\\u201a': u'\\u2018\\u2019', # ‚ ‘ German ‚ ’ Polish
-               u'\\u201c': u'\\u201e',       # “ „ Albanian/Greek/Turkish
-               u'\\u201e': u'\\u201c\\u201d', # „ “ German „ ” Polish
-               u'\\u201d': u'\\u201d',       # ” ” Swedish
-               u'\\u203a': u'\\u203a',       # › › Swedish
-              }
+# Matching open/close pairs are at the same position in
+# `punctuation_chars.openers` and `punctuation_chars.closers`.
+# Additional matches (due to different typographic conventions
+# in different languages) are stored in `quote_pairs`.
+
+quote_pairs = {
+    # open char: matching closing characters  # use case
+    '\xbb': '\xbb',            # » » Swedish
+    '\u2018': '\u201a',        # ‘ ‚ Albanian/Greek/Turkish
+    '\u2019': '\u2019',        # ’ ’ Swedish
+    '\u201a': '\u2018\u2019',  # ‚ ‘ German, ‚ ’ Polish
+    '\u201c': '\u201e',        # “ „ Albanian/Greek/Turkish
+    '\u201e': '\u201c\u201d',  # „ “ German, „ ” Polish
+    '\u201d': '\u201d',        # ” ” Swedish
+    '\u203a': '\u203a',        # › › Swedish
+    '\u301d': '\u301f'         # 〝 〟 CJK punctuation
+    '\u2e42': '\u201F',        # ⹂ ‟ Old Hungarian (right to left)
+    }
 """Additional open/close quote pairs."""
 
-def match_chars(c1, c2):
-    """Test whether `c1` and `c2` are a matching open/close character pair.
 
-    Matching open/close pairs are at the same position in
-    `punctuation_chars.openers` and `punctuation_chars.closers`.
-    The pairing of open/close quotes is ambiguous due to  different
-    typographic conventions in different languages,
-    so we test for additional matches stored in `quote_pairs`.
-    """
+def match_chars(c1, c2):
+    """Test whether `c1` and `c2` are a matching open/close character pair."""
     try:
         i = openers.index(c1)
     except ValueError:  # c1 not in openers
         return False
-    return c2 == closersi or c2 in quote_pairs.get(c1, u'')\
+    return c2 == closersi or c2 in quote_pairs.get(c1, '')
 '''
 
 
@@ -142,17 +128,16 @@
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 # For details about Unicode categories, see
-# http://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
+# https://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
 # ::
 
 unicode_punctuation_categories = {
-    # 'Pc': 'Connector', # not used in Docutils inline markup recognition
-    'Pd': 'Dash',
-    'Ps': 'Open',
-    'Pe': 'Close',
-    'Pi': 'Initial quote', # may behave like Ps or Pe depending on usage
-    'Pf': 'Final quote', # may behave like Ps or Pe depending on usage
-    'Po': 'Other'
+    'Pd': 'dash',
+    'Ps': 'open',
+    'Pe': 'close',
+    'Pi': 'initial quote',  # may behave like Ps or Pe depending on language
+    'Pf': 'final quote',    # may behave like Ps or Pe depending on language
+    'Po': 'other'
     }
 """Unicode character categories for punctuation"""
 
@@ -162,29 +147,20 @@
 #
 # ::
 
-def unicode_charlists(categories, cp_min=0, cp_max=None):
+def unicode_charlists(categories, cp_min=0, cp_max=sys.maxunicode):
     """Return dictionary of Unicode character lists.
 
     For each of the `catagories`, an item contains a list with all Unicode
     characters with `cp_min` <= code-point <= `cp_max` that belong to
     the category.
-
-    The default values check every code-point supported by Python
-    (`sys.maxint` is 0x10FFFF in a "wide" build and 0xFFFF in a "narrow"
-    build, i.e. ucs4 and ucs2 respectively).
     """
-    # Determine highest code point with one of the given categories
-    # (may shorten the search time considerably if there are many
-    # categories with not too high characters):
-    if cp_max is None:
-        cp_max = max(x for x in range(sys.maxunicode+1)
-                    if unicodedata.category(unichr(x)) in categories)
-        # print(cp_max) # => 74867 for unicode_punctuation_categories
-    charlists = {}
-    for cat in categories:
-        charlistscat = unichr(x) for x in range(cp_min, cp_max+1)
-                            if unicodedata.category(unichr(x)) == cat
-    return charlists
+    char_lists = {cat:  for cat in categories}
+    for i in range(cp_min, cp_max+1):
+        chr_i = chr(i)
+        cat_i = unicodedata.category(chr_i)
+        if cat_i in char_lists:
+            char_listscat_i.append(chr_i)
+    return char_lists
 
 
 # Character categories in Docutils
@@ -201,7 +177,7 @@
     recognition rules`_.
     """
 
-    cp_min = 160 # ASCII chars have special rules for backwards compatibility
+    cp_min = 160  # ASCII chars have special rules for backwards compatibility
     ucharlists = unicode_charlists(unicode_punctuation_categories, cp_min)
     """Strings of characters in Unicode punctuation character categories"""
 
@@ -210,23 +186,41 @@
     # Rearange the lists to ensure matching characters at the same
     # index position.
 
-    # low quotation marks are also used as closers (e.g. in Greek)
-    # move them to category Pi:
-    ucharlists'Ps'.remove(u'‚') # 201A  SINGLE LOW-9 QUOTATION MARK
-    ucharlists'Ps'.remove(u'„') # 201E  DOUBLE LOW-9 QUOTATION MARK
-    ucharlists'Pi' += u'‚', u'„'
-
-    ucharlists'Pi'.remove(u'‛') # 201B  SINGLE HIGH-REVERSED-9 QUOTATION MARK
-    ucharlists'Pi'.remove(u'‟') # 201F  DOUBLE HIGH-REVERSED-9 QUOTATION MARK
-    ucharlists'Pf' += u'‛', u'‟'
-
-    # 301F  LOW DOUBLE PRIME QUOTATION MARK misses the opening pendant:
-    ucharlists'Ps'.insert(ucharlists'Pe'.index(u'\u301f'), u'\u301d')
-
-    # print(u''.join(ucharlists'Ps').encode('utf8')
-    # print(u''.join(ucharlists'Pe').encode('utf8')
-    # print(u''.join(ucharlists'Pi').encode('utf8')
-    # print(u''.join(ucharlists'Pf').encode('utf8')
+    # LOW-9 QUOTATION MARKs are categorized as Ps (open) without matching Pe.
+    # They are used as initial quotes in German and final quotes in Greek.
+    # Remove them to get balanced Ps/Pe pairs.
+    ucharlists'Ps'.remove('‚')  # 201A  SINGLE LOW-9 QUOTATION MARK
+    ucharlists'Ps'.remove('„')  # 201E  DOUBLE LOW-9 QUOTATION MARK
+    #
+    # HIGH-REVERSED-9 QUOTATION MARKs are categorized as Pi (initial quote)
+    # without matching Pf (final quote).
+    # Insert the LOW-9 QUOTATION MARKs at the "empty slots" in Pf.
+    ucharlists'Pf'.insert(ucharlists'Pi'.index('‛'), '‚')
+    ucharlists'Pf'.insert(ucharlists'Pi'.index('‟'), '„')
+
+    # '⹂' 2E42 DOUBLE LOW-REVERSED-9 QUOTATION MARK
+    # is categorized as Ps (open) without matching Pe (close).
+    # It is used in Old Hungarian (written right to left) as quoting character
+    # matching DOUBLE HIGH-REVERSED-9 QUOTATION MARK.
+    # https://www.unicode.org/L2/L2012/12168r-n4268r-oldhungarian.pdf#page=26
+    #
+    # '⹂' 301F LOW DOUBLE PRIME QUOTATION MARK
+    # is categorized as Pe (close) without matching Ps (open).
+    # Move to the place matching  2E42:
+    ucharlists'Pe'.remove('\u301f')
+    ucharlists'Pe'.insert(ucharlists'Ps'.index('⹂'), '\u301f')
+
+    # check for balanced lists:
+    if len(ucharlists'Ps') != len(ucharlists'Pe'):
+        print('Missmatch between "Open" and "Close" categories')
+        print(''.join(ucharlists'Ps'))
+        print(''.join(ucharlists'Pe'))
+        raise AssertionError
+    if len(ucharlists'Pi') != len(ucharlists'Pf'):
+        print('Missmatch between "initial quote" and "final quote" categories')
+        print(''.join(ucharlists'Pi'))
+        print(''.join(ucharlists'Pf'))
+        raise AssertionError
 
     # The Docutils character categories
     # ---------------------------------
@@ -236,87 +230,90 @@
     # recognition rules`_)
 
     # allowed before markup if there is a matching closer
-    openers = u'"\'(<\\{'
+    openers = '"\'(<\\{'
     for category in ('Ps', 'Pi', 'Pf'):
         openers.extend(ucharlistscategory)
 
     # allowed after markup if there is a matching opener
-    closers = u'"\')>\\}'
+    closers = '"\')>\\}'
     for category in ('Pe', 'Pf', 'Pi'):
         closers.extend(ucharlistscategory)
 
     # non-matching, allowed on both sides
-    delimiters = u'\\-/:'
+    delimiters = r'\-/:'
     for category in ('Pd', 'Po'):
         delimiters.extend(ucharlistscategory)
 
     # non-matching, after markup
     closing_delimiters = r'\\.,;!?'
 
-    return u''.join(chars) for chars in (openers, closers, delimiters,
-                                            closing_delimiters)
+    return ''.join(chars) for chars in (openers, closers, delimiters,
+                                         closing_delimiters)
 
-def separate_wide_chars(s):
-    """Return (s1,s2) with characters above 0xFFFF in s2"""
-    maxunicode_narrow = 0xFFFF
-    l1 = ch for ch in s if ord(ch) <= maxunicode_narrow
-    l2 = ch for ch in s if ord(ch) > maxunicode_narrow
-    return ''.join(l1), ''.join(l2)
 
 def mark_intervals(s):
     """Return s with shortcut notation for runs of consecutive characters
 
     Sort string and replace 'cdef' by 'c-f' and similar.
     """
-    l =
-    s = sorted(ord(ch) for ch in s)
+    lst = 
+    s = sorted(ord(ch) for ch in s)
     for n in s:
         try:
-            if l-1-1+1 == n:
-                l-1.append(n)
+            if lst-1-1 + 1 == n:
+                lst-1.append(n)
             else:
-                l.append(n)
+                lst.append(n)
         except IndexError:
-            l.append(n)
+            lst.append(n)
 
-    l2 = 
-    for i in l:
-        i = unichr(n) for n in i
+    lst2 = 
+    for i in lst:
+        i = chr(n) for n in i
         if len(i) > 2:
-            i = i0, u'-', i-1
-        l2.extend(i)
+            i = i0, '-', i-1
+        lst2.extend(i)
+
+    return ''.join(lst2)
 
-    return ''.join(l2)
 
-def wrap_string(s, startstring= "(u'",
-                    endstring = "')", wrap=67):
+def wrap_string(s, startstring="(", endstring="    )", wrap=71):
     """Line-wrap a unicode string literal definition."""
+    s = s.encode('unicode-escape').decode()
     c = len(startstring)
-    contstring = "'\n" + ' ' * (len(startstring)-2) + "u'"
-    l = startstring
+    left_indent = ' '*(c - len(startstring.lstrip(' ')))
+    line_start_string = f"\n    {left_indent}'"
+    cont_string = f"'{line_start_string}"
+    lst = startstring, line_start_string
     for ch in s.replace("'", r"\'"):
         c += 1
         if ch == '\\' and c > wrap:
             c = len(startstring)
-            ch = contstring + ch
-        l.append(ch)
-    l.append(endstring)
-    return ''.join(l)
+            lst.append(cont_string)
+        lst.append(ch)
+    lst.append(f"'\n{left_indent}{endstring}")
+    return ''.join(lst)
 
 
 def print_differences(old, new, name):
     """List characters missing in old/new."""
     if old != new:
-        print('new %s:' % name)
-        for c in new:
-            if c not in old:
-                print('  %04x'%ord(c), unicodedata.name(c))
-        print('removed %s:' % name)
-        for c in old:
-            if c not in new:
-                print('  %04x'%ord(c), unicodedata.name(c))
+        print(f'"{name}" changed')
+        if '-' in old or '-' in new:
+            print('-', old)
+            print('+', new)
+        else:
+            for c in new:
+                if c not in old:
+                    print('+ %04x'%ord(c), c, unicodedata.name(c))
+            for c in old:
+                if c not in new:
+                    print('- %04x'%ord(c), c, unicodedata.name(c))
+        return True
     else:
-        print('%s unchanged' % name)
+        print(f'"{name}" unchanged')
+        return False
+
 
 # Output
 # ------
@@ -329,6 +326,8 @@
     parser = argparse.ArgumentParser(description=__doc__)
     parser.add_argument('-t', '--test', action="store_true",
                         help='test for changed character categories')
+    parser.add_argument('--pairs', action="store_true",
+                        help='show openers/closers in human readable form')
     args = parser.parse_args()
 
 # (Re)create character patterns
@@ -338,57 +337,51 @@
 
     (o, c, d, cd) = character_category_patterns()
 
-# Characters in the upper plane require a "wide" build::
-
-    o, o_wide = separate_wide_chars(o)
-    c, c_wide = separate_wide_chars(c)
-    d, d_wide = separate_wide_chars(d)
-
 # delimiters: sort and use shortcut for intervals (saves ~150 characters)
 # (`openers` and `closers` must be verbose and keep order
 # because they are also used in `match_chars()`)::
 
     d = d:5 + mark_intervals(d5:)
-    d_wide = mark_intervals(d_wide)
 
 
 # Test: compare module content with re-generated definitions
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# ::
-
-    if args.test:
-
+#
 # Import the punctuation_chars module from the source
 # or Py3k build path for local Python modules::
 
-        if sys.version_info < (3, 0):
-            sys.path.insert(0, '../../docutils')
-        else:
-            sys.path.insert(0, '../../build/lib')
+    if args.test:
+
+        sys.path.insert(0, '../../docutils')
 
-        from docutils.utils.punctuation_chars import (openers, closers,
-                                          delimiters, closing_delimiters)
+        from docutils.utils.punctuation_chars import (
+                 openers, closers, delimiters, closing_delimiters)
 
         print('Check for differences between the current `punctuation_chars`'
               ' module\n and a regeneration based on Unicode version %s:'
               % unicodedata.unidata_version)
 
-        print_differences(openers, o, 'openers')
-        if o_wide:
-            if sys.version_info < (3, 0):
-                print('+ openers-wide = ur"""%s"""' % o_wide.encode('utf8'))
-            else:
-                print('+ openers-wide = r"""%s"""' % o_wide.encode('utf8'))
-        print_differences(closers, c, 'closers')
-        if c_wide:
-            if sys.version_info < (3, 0):
-                print('+ closers-wide = ur"""%s"""' % c_wide.encode('utf8'))
-            else:
-                print('+ closers-wide = r"""%s"""' % c_wide.encode('utf8'))
-
-        print_differences(delimiters, d + d_wide, 'delimiters')
+        delta_o = print_differences(openers, o, 'openers')
+        delta_c = print_differences(closers, c, 'closers')
+        print_differences(delimiters, d, 'delimiters')
         print_differences(closing_delimiters, cd, 'closing_delimiters')
 
+        if delta_o or delta_c:
+            print('\nChanges in "openers" and/or "closers",'
+                  '\nCheck open/close pairs with option "--pairs"!')
+        sys.exit()
+
+
+# Print debugging output
+# ~~~~~~~~~~~~~~~~~~~~~~
+#
+# Print comparison of `openers` and `closers` in human readable form
+# to allow checking for matching pairs.
+
+    if args.pairs:
+        for o_i, c_i in zip(o, c):
+            print(o_i, c_i,
+                  unicodedata.name(o_i), '\t', unicodedata.name(c_i))
         sys.exit()
 
 # Print re-generation of the punctuation_chars module
@@ -400,17 +393,11 @@
 # Replacements::
 
     substitutions = {
-        'python_version': '.'.join(str(s) for s in sys.version_info:3),
+        'python_version': sys.version.split()0,
         'unidata_version': unicodedata.unidata_version,
-        'openers': wrap_string(o.encode('unicode-escape').decode(),
-                               startstring="openers = (u'"),
-        'closers': wrap_string(c.encode('unicode-escape').decode(),
-                               startstring="closers = (u'"),
-        'delimiters': wrap_string(d.encode('unicode-escape').decode(),
-                                  startstring="delimiters = (u'"),
-        'delimiters_wide': wrap_string(
-                            d_wide.encode('unicode-escape').decode(),
-                            startstring="    delimiters += (u'")
+        'openers': wrap_string(o, startstring="openers = ("),
+        'closers': wrap_string(c, startstring="closers = ("),
+        'delimiters': wrap_string(d, startstring="delimiters = ("),
         }
 
-    print(module_template % substitutions)
+    print(module_template % substitutions, end='')

_service:tar_scm:docutils-0.17.1.tar.gz/tools/dev/profile_docutils.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/dev/profile_docutils.py Changed

_service:tar_scm:docutils-0.20.tar.gz/tools/dev/quicktest.py Added

@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+
+# $Id: quicktest.py 9201 2022-11-02 22:39:16Z aa-turner $
+# Authors: Garth Kidd <garth@deadlybloodyserious.com>;
+#          David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+The ``quicktest.py`` tool is used for testing the reStructuredText
+parser.  It does not use a Docutils Reader or Writer or the standard
+Docutils command-line options.  Rather, it does its own I/O and calls
+the parser directly.  No transforms are applied to the parsed
+document.  Possible output forms output include:
+
+--pretty  Pretty-printed pseudo-XML (default)
+
+--test    Test data (Python list of input and pseudo-XML output strings;
+          useful for creating new test cases)
+--xml     Pretty-printed native XML
+--rawxml  Raw native XML (with or without a stylesheet reference)
+--help    Usage hint and complete list of supported options.
+
+.. Caution:: ``quicktest.py`` uses Python's default encoding.
+   Input and output encoding depend on UTF-8 mode,
+   Python version, locale setting, and operating system
+   (cf. :PEP:`540`, :PEP:`538`, :PEP:`597`, and :PEP:`686`).
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except Exception:
+    pass
+
+import sys
+import getopt
+import docutils
+from docutils import frontend
+from docutils.utils import new_document
+from docutils.parsers.rst import Parser
+
+
+usage_header = """\
+quicktest.py: Quickly test the reStructuredText parser.  This is not an
+interface to the full functionality of Docutils.  Use one of the ``rst2*.py``
+front-end tools instead.
+
+Usage::
+
+    quicktest.py options <source> <destination>
+
+``source`` is the name of the file to use as input (default is stdin).
+``destination`` is the name of the file to create as output (default is
+stdout).
+
+Options:
+"""
+
+options = ('pretty', 'p',
+            'output pretty pseudo-xml: no "&abc;" entities (default)'),
+           ('test', 't', 'output test-ready data (input & expected output, '
+            'ready to be copied to a parser test module)'),
+           ('rawxml', 'r', 'output raw XML'),
+           ('styledxml=', 's', 'output raw XML with XSL style sheet '
+            'reference (filename supplied in the option argument)'),
+           ('xml', 'x', 'output pretty XML (indented)'),
+           ('attributes', 'A', 'dump document attributes after processing'),
+           ('debug', 'd', 'debug mode (lots of output)'),
+           ('version', 'V', 'show Docutils version then exit'),
+           ('help', 'h', 'show help text then exit')
+"""See ``distutils.fancy_getopt.FancyGetopt.__init__`` for a description of
+the data structure: (long option, short option, description)."""
+
+
+def usage():
+    print(usage_header)
+    for longopt, shortopt, description in options:
+        if longopt-1: == '=':
+            opts = '-%s arg, --%sarg' % (shortopt, longopt)
+        else:
+            opts = '-%s, --%s' % (shortopt, longopt)
+        sys.stdout.write('%-15s' % opts)
+        if len(opts) > 14:
+            sys.stdout.write('%-16s' % '\n')
+        while len(description) > 60:
+            limit = description.rindex(' ', 0, 60)
+            print(description:limit.strip())
+            description = descriptionlimit + 1:
+            sys.stdout.write('%-15s' % ' ')
+        print(description)
+
+
+def _pretty(input, document, optargs):
+    return document.pformat()
+
+
+def _rawxml(input, document, optargs):
+    return document.asdom().toxml()
+
+
+def _styledxml(input, document, optargs):
+    docnode = document.asdom().childNodes0
+    return '\n'.join(('<?xml version="1.0" encoding="ISO-8859-1"?>',
+                      '<?xml-stylesheet type="text/xsl" href="%s"?>'
+                      % optargs'styledxml',
+                      docnode.toxml()))
+
+
+def _prettyxml(input, document, optargs):
+    return document.asdom().toprettyxml('    ', '\n')
+
+
+def _test(input, document, optargs):
+    tq = '"""'
+    output = document.pformat()         # same as _pretty()
+    return """\
+    totest'change_this_test_name' = 
+%s\\
+%s
+%s,
+%s\\
+%s
+%s,
+
+""" % (tq, escape(input.rstrip()), tq, tq, escape(output.rstrip()), tq)
+
+
+def escape(text):
+    """
+    Return `text` in triple-double-quoted Python string form.
+    """
+    text = text.replace('\\', '\\\\')       # escape backslashes
+    text = text.replace('"""', '""\\"')     # break up triple-double-quotes
+    text = text.replace(' \n', ' \\n\\\n')  # protect trailing whitespace
+    return text
+
+
+_outputFormatters = {
+    'rawxml': _rawxml,
+    'styledxml': _styledxml,
+    'xml': _prettyxml,
+    'pretty': _pretty,
+    'test': _test}
+
+
+def format(outputFormat, input, document, optargs):
+    formatter = _outputFormattersoutputFormat
+    return formatter(input, document, optargs)
+
+
+def posixGetArgs(argv):
+    outputFormat = 'pretty'
+    # convert fancy_getopt style option list to getopt.getopt() arguments
+    shortopts = ''.join(option1 + ':' * (option0-1: == '=')
+                        for option in options if option1)
+    longopts = option0 for option in options if option0
+    try:
+        opts, args = getopt.getopt(argv, shortopts, longopts)
+    except getopt.GetoptError:
+        usage()
+        sys.exit(2)
+    optargs = {'debug': 0, 'attributes': 0}
+    for o, a in opts:
+        if o in '-h', '--help':
+            usage()
+            sys.exit()
+        elif o in '-V', '--version':
+            sys.stderr.write('quicktest.py (Docutils %s%s)\n' %
+                             (docutils.__version__,
+                              docutils.__version_details__
+                              and ' %s'%docutils.__version_details__ or ''))
+            sys.exit()
+        elif o in '-r', '--rawxml':
+            outputFormat = 'rawxml'
+        elif o in '-s', '--styledxml':
+            outputFormat = 'styledxml'
+            optargs'styledxml' = a
+        elif o in '-x', '--xml':
+            outputFormat = 'xml'
+        elif o in '-p', '--pretty':
+            outputFormat = 'pretty'
+        elif o in '-t', '--test':
+            outputFormat = 'test'
+        elif o in '--attributes', '-A':
+            optargs'attributes' = 1
+        elif o in '-d', '--debug':
+            optargs'debug' = 1
+        else:
+            raise getopt.GetoptError("getopt should have saved us!")
+    if len(args) > 2:
+        print('Maximum 2 arguments allowed.')
+        usage()
+        sys.exit(1)
+    inputFile = sys.stdin
+    outputFile = sys.stdout
+    if args:
+        inputFile = open(args.pop(0))
+    if args:
+        outputFile = open(args.pop(0), 'w')
+    return inputFile, outputFile, outputFormat, optargs
+
+
+def main():
+    # process cmdline arguments:
+    inputFile, outputFile, outputFormat, optargs = posixGetArgs(sys.argv1:)
+    settings = frontend.get_default_settings(Parser)
+    settings.debug = optargs'debug'
+    parser = Parser()
+    input = inputFile.read()
+    document = new_document(inputFile.name, settings)
+    parser.parse(input, document)
+    output = format(outputFormat, input, document, optargs)
+    outputFile.write(output)
+    if optargs'attributes':
+        import pprint
+        pprint.pprint(document.__dict__)
+
+
+if __name__ == '__main__':
+    sys.stderr = sys.stdout
+    main()

_service:tar_scm:docutils-0.17.1.tar.gz/tools/dev/unicode2rstsubs.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/dev/unicode2rstsubs.py Changed

@@ -1,6 +1,5 @@
-#! /usr/bin/env python
-
-# $Id: unicode2rstsubs.py 8367 2019-08-27 12:09:56Z milde $
+#! /usr/bin/env python3
+# $Id: unicode2rstsubs.py 9072 2022-06-15 11:31:09Z milde $
 # Author: David Goodger <goodger@python.org>
 # Copyright: This program has been placed in the public domain.
 
@@ -17,25 +16,25 @@
 
 The input file, unicode.xml, is maintained as part of the MathML 2
 Recommentation XML source, and is available from
-<http://www.w3.org/2003/entities/xml/>.
+<https://www.w3.org/2003/entities/xml/>.
 """
-from __future__ import print_function
 
 import sys
 import os
-import optparse
 import re
 from xml.parsers.expat import ParserCreate
 
 
 usage_msg = """Usage: %s unicode.xml\n"""
 
+
 def usage(prog, status=0, msg=None):
     sys.stderr.write(usage_msg % prog)
     if msg:
         sys.stderr.write(msg + '\n')
     sys.exit(status)
 
+
 def main(argv=None):
     if argv is None:
         argv = sys.argv
@@ -48,19 +47,17 @@
         inpath = 'unicode.xml'
     if not os.path.isfile(inpath):
         usage(argv0, 1, 'No such file: "%s".' % inpath)
-    if sys.version_info >= (3, 0):
-        infile = open(inpath, mode='rb')
-    else:
-        infile = open(inpath)
+    infile = open(inpath, mode='rb')
     process(infile)
 
+
 def process(infile):
     grouper = CharacterEntitySetExtractor(infile)
     grouper.group()
     grouper.write_sets()
 
 
-class CharacterEntitySetExtractor(object):
+class CharacterEntitySetExtractor:
 
     """
     Extracts character entity information from unicode.xml file, groups it by
@@ -73,9 +70,9 @@
     header = """\
 .. This data file has been placed in the public domain.
 .. Derived from the Unicode character mappings available from
-   <http://www.w3.org/2003/entities/xml/>.
+   <https://www.w3.org/2003/entities/xml/>.
    Processed by unicode2rstsubs.py, part of Docutils:
-   <http://docutils.sourceforge.net>.
+   <https://docutils.sourceforge.io>.
 """
 
     def __init__(self, infile):
@@ -138,9 +135,9 @@
             return
         entity = attributes'id'
         assert (entity not in self.setsset
-                or self.setssetentity == self.charid), \
-                ('sets%r%r == %r (!= %r)'
-                 % (set, entity, self.setssetentity, self.charid))
+                or self.setssetentity == self.charid
+                ), ('sets%r%r == %r (!= %r)'
+                    % (set, entity, self.setssetentity, self.charid))
         self.setssetentity = self.charid
 
     def description_data(self, data):
@@ -172,11 +169,11 @@
             outname = set_name + '-wide.txt'
         else:
             outname = set_name + '.txt'
-        outfile = open(outname, 'w')
+        outfile = open(outname, 'w', encoding='ascii')
         print('writing file "%s"' % outname)
         outfile.write(self.header + '\n')
         set = self.setsset_name
-        entities = sorted((e.lower(), e) for e in set.keys())
+        entities = sorted((e.lower(), e) for e in set.keys())
         longest = 0
         for _, entity_name in entities:
             longest = max(longest, len(entity_name))
@@ -194,7 +191,7 @@
             for code in charid1:.split('-'):
                 if int(code, 16) > 0xFFFF:
                     return 1            # wide-Unicode character
-        codes = ' '.join('U+%s' % code for code in charid1:.split('-'))
+        codes = ' '.join('U+%s' % code for code in charid1:.split('-'))
         outfile.write('.. %-*s unicode:: %s .. %s\n'
                       % (longest + 2, '|' + entity_name + '|',
                          codes, self.descriptionscharid))

_service:tar_scm:docutils-0.17.1.tar.gz/tools/docutils-cli.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/docutils-cli.py Changed

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
-# -*- coding: utf8 -*-
-# :Copyright: © 2020 Günter Milde.
+# :Copyright: © 2022 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
 #    Copying and distribution of this file, with or without modification,
@@ -10,63 +9,16 @@
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 #
-# Revision: $Revision: 8673 $
-# Date: $Date: 2021-04-07 19:57:27 +0200 (Mi, 07. Apr 2021) $
+# Revision: $Revision: 9061 $
+# Date: $Date: 2022-05-30 18:54:46 +0200 (Mo, 30. Mai 2022) $
 
-"""
-A generic front end to the Docutils Publisher.
-"""
-
-try:
-    import locale # module missing in Jython
-    locale.setlocale(locale.LC_ALL, '')
-except locale.Error:
-    pass
-
-import argparse
-import sys
-
-from docutils.core import publish_cmdline, default_description
-from docutils.utils import SystemMessage
-
-description = u'Generate documents from reStructuredText or Markdown sources.'
-              
-epilog = (u'Currently, the component selection cannot be specified in the '
-          u'configuration file. '
-          u'The availability of some options depends on the selected '
-          u'components, the list below adapts to your selection.'
-         )
-
-parser = argparse.ArgumentParser(add_help=False, 
-                description=description, epilog=epilog,
-                formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-parser.add_argument('--reader', choices=('standalone', 'pep'),
-                    help=u'Reader name.',
-                    default='standalone')
-parser.add_argument('--parser', choices=('markdown', 'rst'),
-                    help=u'Parser name.',
-                    default='rst')
-parser.add_argument('--writer', 
-                    # choices=('html', 'html4', 'html5', 'latex', 'xelatex',
-                    #          'odt', 'xml', 'pseudoxml', 'manpage',
-                    #          'pep_html', 's5_html'),
-                    help=u'Writer name.',
-                    default='html5')
-
-(args, remainder) = parser.parse_known_args()
+"""Generic command line interface for the `docutils` package.
 
+Deprecated:
+Call `docutils` (generated in the binary PATH during package installation)
+or `python3 -m docutils` to get the generic Docutils CLI.
+"""
 
-if '-h' in sys.argv or '--help' in sys.argv:
-    print(parser.format_help())
-    print('')
+from docutils import __main__
 
-try:
-    publish_cmdline(reader_name=args.reader,
-                    parser_name=args.parser,
-                    writer_name=args.writer, 
-                    description=default_description,
-                    argv=remainder)
-except ImportError as error:
-    print(parser.format_help())
-    print('ImportError:', error)
+__main__.main()

_service:tar_scm:docutils-0.17.1.tar.gz/tools/docutils.conf -> _service:tar_scm:docutils-0.20.tar.gz/tools/docutils.conf Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/editors/README.txt -> _service:tar_scm:docutils-0.20.tar.gz/tools/editors/README.txt Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/editors/emacs/IDEAS.rst -> _service:tar_scm:docutils-0.20.tar.gz/tools/editors/emacs/IDEAS.rst Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/editors/emacs/README.txt -> _service:tar_scm:docutils-0.20.tar.gz/tools/editors/emacs/README.txt Changed

@@ -4,7 +4,7 @@
  Emacs Support Files
 =====================
 
-:Date: $Date: 2008-11-26 19:07:47 +0100 (Mi, 26. Nov 2008) $
+:Date: $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $
 
 This directory contains the following Emacs lisp package files:
 
@@ -15,7 +15,7 @@
   * Table-of-contents mode and insertion (M. Blais);
   * Font-lock syntax highlighting (S. Merten);
   * Some handy editing functions (D. Goodger).
-  * Some functions for converting rest documents from within emacs (M. Blais).  
+  * Some functions for converting rest documents from within emacs (M. Blais).
 
 * `<tests/>`_ subdirectory: automated tests for some of the features in rst.el.
   Please make sure the tests pass if you change the LISP code.  Just type "make"
@@ -27,4 +27,4 @@
 For setup and usage details, see `Emacs Support for reStructuredText
 <../../../docs/user/emacs.html>`_.
 
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html

_service:tar_scm:docutils-0.17.1.tar.gz/tools/editors/emacs/rst.el -> _service:tar_scm:docutils-0.20.tar.gz/tools/editors/emacs/rst.el Changed

@@ -48,10 +48,10 @@
 ;; the contents of this package and how to use it.
 ;;
 ;; For more information about reStructuredText, see
-;; http://docutils.sourceforge.net/rst.html
+;; https://docutils.sourceforge.io/rst.html
 ;;
 ;; For full details on how to use the contents of this file, see
-;; http://docutils.sourceforge.net/docs/user/emacs.html
+;; https://docutils.sourceforge.io/docs/user/emacs.html
 ;;
 ;; There are a number of convenient key bindings provided by rst-mode.  For the
 ;; bindings, try C-c C-h when in rst-mode.  There are also many variables that
@@ -81,7 +81,7 @@
 ;;   (require 'rst)
 ;;
 ;; If you are using `.txt' as a standard extension for reST files as
-;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
+;; https://docutils.sourceforge.io/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
 ;; provides to set the major mode automatically.  For instance you may use::
 ;;
@@ -258,12 +258,12 @@
 ;; Use LastChanged... to really get information from SVN.
 (defconst rst-svn-rev
   (rst-extract-version "\\$" "LastChangedRevision: " "0-9+" " "
-		       "$LastChangedRevision: 8015 $")
+		       "$LastChangedRevision: 8956 $")
   "The SVN revision of this file.
 SVN revision is the upstream (docutils) revision.")
 (defconst rst-svn-timestamp
   (rst-extract-version "\\$" "LastChangedDate: " ".+?+" " "
-		       "$LastChangedDate: 2017-01-08 10:54:35 +0100 (So, 08. Jän 2017) $")
+		       "$LastChangedDate: 2022-01-20 11:11:44 +0100 (Do, 20. Jän 2022) $")
   "The SVN time stamp of this file.")
 
 ;; Maintained by the release process.
@@ -273,7 +273,7 @@
   "Official version of the package.")
 (defconst rst-official-cvs-rev
   (rst-extract-version "%$" "Revision: " "0-9+\$?:\\.0-9+\$+" " "
-		       "$Revision: 8015 $")
+		       "$Revision: 8956 $")
   "CVS revision of this file in the official version.")
 
 (defconst rst-version
@@ -315,7 +315,7 @@
 (defgroup rst nil "Support for reStructuredText documents."
   :group 'text
   :version "23.1"
-  :link '(url-link "http://docutils.sourceforge.net/rst.html"))
+  :link '(url-link "https://docutils.sourceforge.io/rst.html"))
 
 &#xc;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -1006,7 +1006,7 @@
 respectively.  They may be nil if the respective thing is missing.
 BEG-TXT is the beginning of the title line or the transition and
 must be given.  The end of the line is used as the end point.  TXT
-is the title text or nil.  If TXT is given the indendation of the
+is the title text or nil.  If TXT is given the indentation of the
 line containing BEG-TXT is used as indentation.  Match group 0 is
 derived from the remaining information."
   (cl-check-type beg-txt integer-or-marker)
@@ -3863,7 +3863,7 @@
 
 (defvar rst-font-lock-keywords
   ;; The reST-links in the comments below all relate to sections in
-  ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
+  ;; https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html.
   `(;; FIXME: Block markup is not recognized in blocks after explicit markup
     ;;        start.

_service:tar_scm:docutils-0.17.1.tar.gz/tools/editors/emacs/tests/comment.el -> _service:tar_scm:docutils-0.20.tar.gz/tools/editors/emacs/tests/comment.el Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2html.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2html.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2html4.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2html4.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2html5.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2html5.py Changed

@@ -1,5 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf8 -*-
+#!/usr/bin/env python3
 # :Copyright: © 2015 Günter Milde.
 # :License: Released under the terms of the `2-Clause BSD license`_, in short:
 #
@@ -10,8 +9,8 @@
 #
 # .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
 #
-# Revision: $Revision: 8567 $
-# Date: $Date: 2020-09-30 13:57:21 +0200 (Mi, 30. Sep 2020) $
+# Revision: $Revision: 9021 $
+# Date: $Date: 2022-03-04 16:54:22 +0100 (Fr, 04. Mär 2022) $
 
 """
 A minimal front end to the Docutils Publisher, producing HTML 5 documents.
@@ -20,15 +19,15 @@
 """
 
 try:
-    import locale # module missing in Jython
+    import locale  # module missing in Jython
     locale.setlocale(locale.LC_ALL, '')
 except locale.Error:
     pass
 
 from docutils.core import publish_cmdline, default_description
 
-description = (u'Generates HTML5 documents from standalone '
-               u'reStructuredText sources.\n'
+description = ('Generates HTML5 documents from standalone '
+               'reStructuredText sources.\n'
                + default_description)
 
 publish_cmdline(writer_name='html5', description=description)

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2latex.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2latex.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2man.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2man.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2odt.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2odt.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2odt_prepstyles.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2odt_prepstyles.py Changed

@@ -1,19 +1,20 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: rst2odt_prepstyles.py 8346 2019-08-26 12:11:32Z milde $
+# $Id: rst2odt_prepstyles.py 9365 2023-04-26 12:57:44Z milde $
 # Author: Dave Kuhlman <dkuhlman@rexx.com>
 # Copyright: This module has been placed in the public domain.
 
 """
-Fix a word-processor-generated styles.odt for odtwriter use: Drop page size
-specifications from styles.xml in STYLE_FILE.odt.
+Adapt a word-processor-generated styles.odt for odtwriter use:
+
+Drop page size specifications from styles.xml in STYLE_FILE.odt.
+See https://docutils.sourceforge.io/docs/user/odt.html#page-size
 """
 
 # Author: Michael Schutte <michi@uiae.at>
 
-from __future__ import print_function
+from xml.etree import ElementTree as etree
 
-from lxml import etree
 import sys
 import zipfile
 from tempfile import mkstemp
@@ -29,22 +30,32 @@
 def prepstyle(filename):
 
     zin = zipfile.ZipFile(filename)
-    styles = zin.read("styles.xml")
-
-    root = etree.fromstring(styles)
-    for el in root.xpath("//style:page-layout-properties",
-                         namespaces=NAMESPACES):
-        for attr in el.attrib:
+    styles = zin.open("styles.xml")
+
+    root = None
+    # some extra effort to preserve namespace prefixes
+    for event, elem in etree.iterparse(styles, events=("start", "start-ns")):
+        if event == "start-ns":
+            etree.register_namespace(elem0, elem1)
+        elif event == "start":
+            if root is None:
+                root = elem
+
+    styles.close()
+
+    for el in root.findall(".//style:page-layout-properties",
+                           namespaces=NAMESPACES):
+        for attr in list(el.attrib):
             if attr.startswith("{%s}" % NAMESPACES"fo"):
                 del el.attribattr
 
     tempname = mkstemp()
-    zout = zipfile.ZipFile(os.fdopen(tempname0, "w"), "w",
+    zout = zipfile.ZipFile(os.fdopen(tempname0, "wb"), "w",
                            zipfile.ZIP_DEFLATED)
 
     for item in zin.infolist():
         if item.filename == "styles.xml":
-            zout.writestr(item, etree.tostring(root))
+            zout.writestr(item, etree.tostring(root, encoding="UTF-8"))
         else:
             zout.writestr(item, zin.read(item.filename))
 
@@ -55,7 +66,7 @@
 
 def main():
     args = sys.argv1:
-    if len(args) != 1:
+    if len(args) != 1 or args0 in ('-h', '--help'):
         print(__doc__, file=sys.stderr)
         print("Usage: %s STYLE_FILE.odt\n" % sys.argv0, file=sys.stderr)
         sys.exit(1)

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2pseudoxml.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2pseudoxml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2s5.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2s5.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2xetex.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2xetex.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rst2xml.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rst2xml.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/rstpep2html.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/rstpep2html.py Changed

_service:tar_scm:docutils-0.17.1.tar.gz/tools/test/test_buildhtml.py -> _service:tar_scm:docutils-0.20.tar.gz/tools/test/test_buildhtml.py Changed

@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
-# $Id: test_buildhtml.py 8500 2020-03-03 20:53:38Z milde $
+# $Id: test_buildhtml.py 9072 2022-06-15 11:31:09Z milde $
 # Author: engelbert gruber <grubert@users.sourceforge.net>
 # Copyright: This module has been placed in the public domain.
 
@@ -33,6 +33,7 @@
                     os.path.dirname(__file__) or os.curdir,
                     '..', 'buildhtml.py'))
 
+
 def process_and_return_filelist(options):
     dirs = 
     files = 
@@ -54,39 +55,40 @@
     cin.close()
     cout.close()
     p.wait()
-    return (dirs, files)
+    return dirs, files
+
 
 class BuildHtmlTests(unittest.TestCase):
-    tree = ( "_tmp_test_tree",
-             "_tmp_test_tree/one.txt",
-             "_tmp_test_tree/two.txt",
-             "_tmp_test_tree/dir1",
-             "_tmp_test_tree/dir1/one.txt",
-             "_tmp_test_tree/dir1/two.txt",
-             "_tmp_test_tree/dir2",
-             "_tmp_test_tree/dir2/one.txt",
-             "_tmp_test_tree/dir2/two.txt",
-             "_tmp_test_tree/dir2/sub",
-             "_tmp_test_tree/dir2/sub/one.txt",
-             "_tmp_test_tree/dir2/sub/two.txt",
-             )
+    tree = ("_tmp_test_tree",
+            "_tmp_test_tree/one.txt",
+            "_tmp_test_tree/two.txt",
+            "_tmp_test_tree/dir1",
+            "_tmp_test_tree/dir1/one.txt",
+            "_tmp_test_tree/dir1/two.txt",
+            "_tmp_test_tree/dir2",
+            "_tmp_test_tree/dir2/one.txt",
+            "_tmp_test_tree/dir2/two.txt",
+            "_tmp_test_tree/dir2/sub",
+            "_tmp_test_tree/dir2/sub/one.txt",
+            "_tmp_test_tree/dir2/sub/two.txt",
+            )
 
     def setUp(self):
         self.root = tempfile.mkdtemp()
 
         for s in self.tree:
             s = os.path.join(self.root, s)
-            if not "." in s:
+            if "." not in s:
                 os.mkdir(s)
             else:
-                fd_s = open(s, "w")
+                fd_s = open(s, "w", encoding='utf-8')
                 fd_s.write("dummy")
                 fd_s.close()
 
     def tearDown(self):
         for i in range(len(self.tree) - 1, -1, -1):
             s = os.path.join(self.root, self.treei)
-            if not "." in s:
+            if "." not in s:
                 os.rmdir(s)
             else:
                 os.remove(s)
@@ -94,14 +96,15 @@
 
     def test_1(self):
         opts = "--dry-run", self.root
-        dirs, files = process_and_return_filelist( opts )
+        dirs, files = process_and_return_filelist(opts)
         self.assertEqual(files.count("one.txt"), 4)
 
     def test_local(self):
         opts = "--dry-run", "--local", self.root
-        dirs, files = process_and_return_filelist( opts )
-        self.assertEqual( len(dirs), 1)
-        self.assertEqual( files, )
+        dirs, files = process_and_return_filelist(opts)
+        self.assertEqual(len(dirs), 1)
+        self.assertEqual(files, )
+
 
 if __name__ == '__main__':
     unittest.main()