summaryrefslogtreecommitdiff
path: root/docutils/docs/ref
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-05-02 03:59:11 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-05-02 03:59:11 +0000
commit2c538aadf7c69b356bf1c0e7930d8c2cbc1cbda3 (patch)
tree76b2bdab1b0c2b66f054f698f7732c11f2374deb /docutils/docs/ref
parent52e2cee972ee99c5ef43f4b0190e7218eef4d166 (diff)
downloaddocutils-2c538aadf7c69b356bf1c0e7930d8c2cbc1cbda3.tar.gz
added ``line`` element; corrected ``line_block`` details
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3282 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
-rw-r--r--docutils/docs/ref/doctree.txt163
1 files changed, 114 insertions, 49 deletions
diff --git a/docutils/docs/ref/doctree.txt b/docutils/docs/ref/doctree.txt
index 2ae37b9f5..f432ed1f6 100644
--- a/docutils/docs/ref/doctree.txt
+++ b/docutils/docs/ref/doctree.txt
@@ -161,9 +161,8 @@ Simple body elements are empty or directly contain text data. Those
that contain text data may also contain inline elements. Such
elements therefore have a "mixed content model".
-Category members: comment_, doctest_block_, image_, line_block_,
-literal_block_, paragraph_, pending_, raw_, rubric_,
-substitution_definition_, target_
+Category members: comment_, doctest_block_, image_, literal_block_,
+paragraph_, pending_, raw_, rubric_, substitution_definition_, target_
Compound Body Elements
@@ -175,8 +174,8 @@ and further body elements. They do not directly contain text data.
Category members: admonition_, attention_, block_quote_, bullet_list_,
caution_, citation_, compound_, danger_, definition_list_,
enumerated_list_, error_, field_list_, figure_, footnote_, hint_,
-important_, note_, option_list_, system_message_, table_, tip_,
-warning_
+important_, line_block, note_, option_list_, system_message_, table_,
+tip_, warning_
Body Subelements
@@ -190,7 +189,8 @@ always occur within specific parent elements, never at the body
element level (beside paragraphs, etc.).
Category members (simple): attribution_, caption_, classifier_,
-colspec_, field_name_, label_, option_argument_, option_string_, term_
+colspec_, field_name_, label_, line_, option_argument_,
+option_string_, term_
Category members (compound): definition_, definition_list_item_,
description_, entry_, field_, field_body_, legend_, list_item_,
@@ -305,7 +305,8 @@ its writing.
The ``address`` element holds the surface mailing address information
for the author (individual or group) of the document, or a third-party
contact address. Its structure is identical to that of the
-line_block_ element: whitespace is significant, especially newlines.
+literal_block_ element: whitespace is significant, especially
+newlines.
Details
@@ -324,9 +325,9 @@ Details
``address`` is analogous to the DocBook "address" element.
:Processing:
- As with the line_block_ element, newlines and other whitespace is
- significant and must be preserved. However, a monospaced typeface
- need not be used.
+ As with the literal_block_ element, newlines and other whitespace
+ is significant and must be preserved. However, a monospaced
+ typeface need not be used.
See also docinfo_.
@@ -2538,21 +2539,67 @@ Pseudo-XML_ fragment from simple parsing::
`To be completed`_.
+``line``
+========
+
+The ``line`` element contains a single line of text, part of a
+`line_block`_.
+
+
+Details
+-------
+
+:Category:
+ `Body Subelements`_ (simple)
+
+:Parents:
+ Only the `line_block`_ element contains ``line``.
+
+:Children:
+ ``line`` elements may contain text data plus `inline elements`_.
+
+:Analogues:
+ ``line`` has no direct analogues in common DTDs. It can be
+ emulated with primitives or type effects.
+
+:Processing:
+ See `line_block`_.
+
+
+Content Model
+-------------
+
+.. parsed-literal::
+
+ `%text.model;`_
+
+:Attributes:
+ The ``line`` element contains the `common attributes`_ (id_,
+ name_, dupname_, source_, and class_), plus `xml:space`_.
+
+
+Examples
+--------
+
+See `line_block`_.
+
+
``line_block``
==============
-The ``line_block`` element contains a block of text where line breaks
-and whitespace are significant and must be preserved. ``line_block``
-elements are commonly used for verse and addresses. See `line_block`_
-for an alternative useful for program listings and interactive
-computer sessions.
+The ``line_block`` element contains a sequence of lines and nested
+line blocks. Line breaks (implied between elements) and leading
+whitespace (indicated by nesting) is significant and must be
+preserved. ``line_block`` elements are commonly used for verse and
+addresses. See `literal_block`_ for an alternative useful for program
+listings and interactive computer sessions.
Details
-------
:Category:
- `Simple Body Elements`_
+ `Compound Body Elements`_
:Parents:
All elements employing the `%body.elements;`_ or
@@ -2560,8 +2607,8 @@ Details
may contain ``line_block``.
:Children:
- ``line_block`` elements may contain text data plus `inline
- elements`_.
+ ``line_block`` elements may contain line_ elements and nested
+ ``line_block`` elements.
:Analogues:
``line_block`` is analogous to the DocBook "literallayout" element
@@ -2570,7 +2617,7 @@ Details
:Processing:
Unline ``literal_block``, ``line_block`` elements are typically
- rendered in an ordinary text typeface. It is crucial that all
+ rendered in an ordinary text typeface. It is crucial that leading
whitespace and line breaks are preserved in the rendered form.
@@ -2579,7 +2626,7 @@ Content Model
.. parsed-literal::
- `%text.model;`_
+ (line_ | line_block_)+
:Attributes:
The ``line_block`` element contains the `common attributes`_ (id_,
@@ -2599,40 +2646,58 @@ Example source::
Take it away, Eric the Orchestra Leader!
- .. line-block::
-
- A one, two, a one two three four
-
- Half a bee, philosophically,
- must, *ipso facto*, half not be.
- But half the bee has got to be,
- *vis a vis* its entity. D'you see?
-
- But can a bee be said to be
- or not to be an entire bee,
- when half the bee is not a bee,
- due to some ancient injury?
-
- Singing...
+ | A one, two, a one two three four
+ |
+ | Half a bee, philosophically,
+ | must, *ipso facto*, half not be.
+ | But half the bee has got to be,
+ | *vis a vis* its entity. D'you see?
+ |
+ | But can a bee be said to be
+ | or not to be an entire bee,
+ | when half the bee is not a bee,
+ | due to some ancient injury?
+ |
+ | Singing...
Pseudo-XML_ fragment from simple parsing::
<paragraph>
Take it away, Eric the Orchestra Leader!
- <line_block xml:space="preserve">
- A one, two, a one two three four
-
- Half a bee, philosophically,
- must, <emphasis>ipso facto</emphasis>, half not be.
- But half the bee has got to be,
- <emphasis>vis a vis</emphasis>its entity. D'you see?
-
- But can a bee be said to be
- or not to be an entire bee,
- when half the bee is not a bee,
- due to some ancient injury?
-
- Singing...
+ <line_block>
+ <line>
+ A one, two, a one two three four
+ <line>
+ <line>
+ Half a bee, philosophically,
+ <line_block>
+ <line>
+ must,
+ <emphasis>
+ ipso facto
+ , half not be.
+ <line>
+ But half the bee has got to be,
+ <line_block>
+ <line>
+ <emphasis>
+ vis a vis
+ its entity. D'you see?
+ <line>
+ <line>
+ But can a bee be said to be
+ <line_block>
+ <line>
+ or not to be an entire bee,
+ <line_block>
+ <line>
+ when half the bee is not a bee,
+ <line_block>
+ <line>
+ due to some ancient injury?
+ <line>
+ <line>
+ Singing...
``list_item``