diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2020-07-10 10:08:14 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2020-07-10 10:08:14 +0000 |
| commit | 3ef42b04a62fe9cfbf76103063930d5660b42d83 (patch) | |
| tree | 98974d1b134329d8fa9ca9cc860efc84759d0faf /docutils/docs/ref | |
| parent | 5f060bc323b47dad7d6d022daa231f34fcee9958 (diff) | |
| download | docutils-3ef42b04a62fe9cfbf76103063930d5660b42d83.tar.gz | |
Make the sidebar's "title" argument optional.
Feature request #69.
The analogous DocBook "sidebar" element's title is optional. too
(https://tdg.docbook.org/tdg/5.2/sidebar.html).
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8524 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
| -rw-r--r-- | docutils/docs/ref/doctree.txt | 6 | ||||
| -rw-r--r-- | docutils/docs/ref/docutils.dtd | 2 | ||||
| -rw-r--r-- | docutils/docs/ref/rst/directives.txt | 4 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docutils/docs/ref/doctree.txt b/docutils/docs/ref/doctree.txt index fcb94a735..257621d86 100644 --- a/docutils/docs/ref/doctree.txt +++ b/docutils/docs/ref/doctree.txt @@ -3765,7 +3765,7 @@ Details section_ :Children: - ``sidebar`` elements begin with a title_ and an optional subtitle_ + ``sidebar`` elements begin with optional title_ and subtitle_ and contain `body elements`_ and topic_ elements. :Analogues: @@ -3801,7 +3801,7 @@ Examples The `"sidebar" directive`_ is used to create a ``sidebar`` element. reStructuredText_ source:: - .. sidebar:: Title + .. sidebar:: Optional Title :subtitle: If Desired Body. @@ -3810,7 +3810,7 @@ Pseudo-XML_ fragment from simple parsing:: <sidebar> <title> - Title + Optional Title <subtitle> If Desired <paragraph> diff --git a/docutils/docs/ref/docutils.dtd b/docutils/docs/ref/docutils.dtd index 2ff2a7d6f..44c872cc2 100644 --- a/docutils/docs/ref/docutils.dtd +++ b/docutils/docs/ref/docutils.dtd @@ -350,7 +350,7 @@ Eventual replacement for docinfo? --> <!ELEMENT topic (title?, (%body.elements;)+)> <!ATTLIST topic %basic.atts;> -<!ELEMENT sidebar (title, subtitle?, (%body.elements; | topic)+)> +<!ELEMENT sidebar (title?, subtitle?, (%body.elements; | topic)+)> <!ATTLIST sidebar %basic.atts;> <!ELEMENT transition EMPTY> diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt index caac27f0d..5960e5dcb 100644 --- a/docutils/docs/ref/rst/directives.txt +++ b/docutils/docs/ref/rst/directives.txt @@ -373,7 +373,7 @@ Sidebar :Directive Type: "sidebar" :Doctree Element: sidebar_ -:Directive Arguments: One, required (sidebar title). +:Directive Arguments: One, optional (sidebar title). :Directive Options: Possible (see below). :Directive Content: Interpreted as the sidebar body. @@ -392,7 +392,7 @@ which may be followed by a subtitle option (see below); the next line must be blank. All subsequent lines make up the sidebar body, interpreted as body elements. For example:: - .. sidebar:: Sidebar Title + .. sidebar:: Optional Sidebar Title :subtitle: Optional Sidebar Subtitle Subsequent indented lines comprise |