[Docutils-checkins] SF.net SVN: docutils:[8801] trunk/docutils

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 8801
          http://sourceforge.net/p/docutils/code/8801
Author:   milde
Date:     2021-07-12 21:24:09 +0000 (Mon, 12 Jul 2021)
Log Message:
-----------
Small documentation fixes and additions.

Modified Paths:
--------------
    trunk/docutils/COPYING.txt
    trunk/docutils/FAQ.txt
    trunk/docutils/HISTORY.txt
    trunk/docutils/docs/dev/todo.txt
    trunk/docutils/docs/index.txt
    trunk/docutils/docs/ref/doctree.txt
    trunk/docutils/docutils/transforms/references.py

Modified: trunk/docutils/COPYING.txt
===================================================================

--- trunk/docutils/COPYING.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/COPYING.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -87,7 +87,7 @@
   test/transforms/test_smartquotes.py
   tools/docutils-cli.py
   tools/rst2html5.py
-  
+
   Copyright © Günter Milde.
   Released under the terms of the `2-Clause BSD license`_
   (`local copy <licenses/BSD-2-Clause.txt>`__).
@@ -129,7 +129,7 @@
 
 * tools/editors/emacs/rst.el
 
-  copyright by Free Software Foundation, Inc., 
+  copyright by Free Software Foundation, Inc.,
   released under the `GNU General Public License`_ version 3 or later
   (`local copy`__).
 

Modified: trunk/docutils/FAQ.txt
===================================================================
--- trunk/docutils/FAQ.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/FAQ.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -983,16 +983,16 @@
 .. 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> 
-      
+      .. [#] <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

Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/HISTORY.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -229,12 +229,15 @@
     __ 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.

Modified: trunk/docutils/docs/dev/todo.txt
===================================================================
--- trunk/docutils/docs/dev/todo.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/docs/dev/todo.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -579,10 +579,10 @@
       .. 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.
 
@@ -589,6 +589,7 @@
   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":

Modified: trunk/docutils/docs/index.txt
===================================================================
--- trunk/docutils/docs/index.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/docs/index.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -138,7 +138,7 @@
 * `reStructuredText Interpreted Text Roles <ref/rst/roles.html>`__
 * `reStructuredText Standard Definition Files
   <ref/rst/definitions.html>`_
-* `LaTeX syntax for mathematics <ref/rst/mathematics.html>`__ 
+* `LaTeX syntax for mathematics <ref/rst/mathematics.html>`__
   (syntax used in "math" directive and role)
 
 Prehistoric:

Modified: trunk/docutils/docs/ref/doctree.txt
===================================================================
--- trunk/docutils/docs/ref/doctree.txt	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/docs/ref/doctree.txt	2021-07-12 21:24:09 UTC (rev 8801)
@@ -2449,8 +2449,8 @@
 ``footnote_reference``
 ======================
 
-The ``footnote_reference`` element represents a cross reference to a
-footnote_ in running text (a footnote mark).
+The ``footnote_reference`` element is an inline element representing a
+cross reference to a footnote_ (a footnote mark).
 
 
 Details
@@ -2751,9 +2751,71 @@
 ``inline``
 ==========
 
-`To be completed`_.
+The ``inline`` element is a generic inline container.
 
+Details
+-------
 
+:Category:
+    `Inline Elements`_
+
+: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`_.
+
+: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.
+
+
+Content Model
+-------------
+
+.. parsed-literal::
+
+    `%text.model;`_
+
+:Attributes:
+    The ``inline`` element contains the `common attributes`_
+    (ids_, names_, dupnames_, source_, and classes_).
+
+
+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``
 =========
 

Modified: trunk/docutils/docutils/transforms/references.py
===================================================================
--- trunk/docutils/docutils/transforms/references.py	2021-07-12 21:23:58 UTC (rev 8800)
+++ trunk/docutils/docutils/transforms/references.py	2021-07-12 21:24:09 UTC (rev 8801)
@@ -1,3 +1,4 @@
+# .. coding: utf-8
 # $Id$
 # Author: David Goodger <go...@py...>
 # Copyright: This module has been placed in the public domain.
@@ -475,17 +476,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;
+          u'\u2020',                    # † &dagger; dagger
+          u'\u2021',                    # ‡ &Dagger; double dagger
+          u'\u00A7',                    # § &sect; section mark
+          u'\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;
+          u'\u2660',                    # ♠ &spades; spade suit
+          u'\u2665',                    # ♡ &hearts; heart suit
+          u'\u2666',                    # ♢ &diams; diamond suit
+          u'\u2663',                    # ♣ &clubs; club suit
           ]
 
     def apply(self):

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.



