From 89e53679341875f1f6c54c93f7b2ce077f6d12b3 Mon Sep 17 00:00:00 2001 From: milde Date: Sat, 27 Apr 2024 17:52:53 +0000 Subject: [PATCH] Doctree documentation: fix `` details, reorder category lists. According to the DTD, the topic title is optional while at least one child (body) element is required (since at least 2002-04-20). Change order of element category "details" list to improve readability. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@9662 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- docutils/docs/ref/doctree.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docutils/docs/ref/doctree.txt b/docutils/docs/ref/doctree.txt index e709f41ef..d8fd2c451 100644 --- a/docutils/docs/ref/doctree.txt +++ b/docutils/docs/ref/doctree.txt @@ -154,6 +154,7 @@ specific `structural elements`_. [#]_ Their content model varies .. [#] `\`_ is also a valid child of the generic `\<admonition>`_. + Decorative Elements ------------------- @@ -180,8 +181,8 @@ the others are `simple elements`_ containing text and `inline elements`_. `\<contact>`_, `\<copyright>`_, `\<date>`_, `\<field>`_, `\<organization>`_, `\<revision>`_, `\<status>`_, `\<version>`_ -:Parameter entity: `%bibliographic.elements`_ :Docutils class: ``nodes.Bibliographic`` +:Parameter entity: `%bibliographic.elements`_ .. _simple body elements: @@ -213,10 +214,10 @@ subelements`_ or further body elements. `\<important>`_, `\<line_block>`_, `\<note>`_, `\<option_list>`_, `\<system_message>`_, `\<table>`_, `\<tip>`_, `\<warning>`_ -:Parameter entity: `%body.elements`_ - :Docutils class: ``nodes.Body`` +:Parameter entity: `%body.elements`_ + Body Subelements ---------------- @@ -263,9 +264,9 @@ text data, most inline elements may also contain further inline elements. `\<literal>`_, `\<math>`_, `\<problematic>`_, `\<raw>`_, `\<reference>`_, `\<strong>`_, `\<subscript>`_, `\<substitution_reference>`_, `\<superscript>`_, `\<target>`_, `\<title_reference>`_ +:Docutils class: ``nodes.Inline`` :Parameter entity: `%inline.elements`_ -:Docutils class: ``nodes.Inline`` ------------------- @@ -3569,7 +3570,7 @@ Details :Parents: The following elements may contain <topic>: `\<document>`_, `\<section>`_, `\<sidebar>`_ -:Children: <topic> elements begin with a `\<title>`_ and may contain +:Children: <topic> elements may begin with a `\<title>`_ and contain `body elements`_:: (title?, (%body.elements;)+) -- 2.11.4.GIT