summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-09-29 13:10:07 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-09-29 13:10:07 +0000
commit4c16652c99cfc1ba8ec7dd2697d606972a98e952 (patch)
tree9a3043f137d80d172c8d19e73d756245f91d2db3 /docs/ref
parent56141f49a0dff5ef21cd29e00479f41c4efd88db (diff)
downloaddocutils-4c16652c99cfc1ba8ec7dd2697d606972a98e952.tar.gz
Added support for "class" directive content.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@3912 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/rst/directives.txt26
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/ref/rst/directives.txt b/docs/ref/rst/directives.txt
index f67ea4532..88bcbf570 100644
--- a/docs/ref/rst/directives.txt
+++ b/docs/ref/rst/directives.txt
@@ -1391,14 +1391,16 @@ Class
:Directive Arguments: One or more, required (class names / attribute
values).
:Directive Options: None.
-:Directive Content: None.
+:Directive Content: Optional. If present, it is interpreted as body
+ elements.
-The "class" directive sets a "class" attribute value on the first
-immediately following non-comment element [#]_. For details of the
-"class" attribute, see `its entry`__ in `The Docutils Document Tree`_.
-The directive argument consists of one or more space-separated class
-names, which are converted to lowercase and all non-alphanumeric
-characters are converted to hyphens. (For the rationale, see below.)
+The "class" directive sets the "class" attribute value on its content
+or on the first immediately following non-comment element [#]_. For
+details of the "class" attribute, see `its entry`__ in `The Docutils
+Document Tree`_. The directive argument consists of one or more
+space-separated class names, which are converted to lowercase and all
+non-alphanumeric characters are converted to hyphens. (For the
+rationale, see below.)
__ ../doctree.html#class
@@ -1415,6 +1417,12 @@ Examples::
This is an ordinary paragraph.
+ .. class:: multiple
+
+ First paragraph.
+
+ Second paragraph.
+
The text above is parsed and transformed into this doctree fragment::
<paragraph class="special">
@@ -1424,6 +1432,10 @@ The text above is parsed and transformed into this doctree fragment::
An Exceptional Section
<paragraph>
This is an ordinary paragraph.
+ <paragraph class="multiple">
+ First paragraph.
+ <paragraph class="multiple">
+ Second paragraph.
.. [#] To set a "class" attribute value on a block quote, the "class"
directive must be followed by an empty comment::