From: David G. <go...@us...> - 2004-10-20 14:07:24
|
Update of /cvsroot/docutils/docutils/docs/ref/rst In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7373/docs/ref/rst Modified Files: directives.txt Log Message: added "compound" directive docs Index: directives.txt =================================================================== RCS file: /cvsroot/docutils/docutils/docs/ref/rst/directives.txt,v retrieving revision 1.61 retrieving revision 1.62 diff -u -d -r1.61 -r1.62 --- directives.txt 5 Oct 2004 01:21:54 -0000 1.61 +++ directives.txt 20 Oct 2004 14:07:12 -0000 1.62 @@ -567,6 +567,56 @@ See Epigraph_ above for an analogous example. +.. _compound: + +Compound Paragraph +================== + +:Directive Type: "compound" +:Doctree Element: compound +:Directive Arguments: None. +:Directive Options: Possible. +:Directive Content: Interpreted as body elements. + +(New in Docutils 0.3.6) + +The "compound" directive is used to create a compound paragraph, which +is a single logical paragraph containing multiple physical body +elements such as simple paragraphs, literal blocks, tables, lists, +etc., instead of directly containing text and inline elements. For +example:: + + .. compound:: + + The 'rm' command is very dangerous. If you are logged + in as root and enter these commands :: + + cd / + rm -rf * + + you will erase the entire contents of your file system. + +In the example above, a literal block is "embedded" within a sentence +that begins in one physical paragraph and ends in another. A compound +paragraph + +Compound paragraphs are typically rendered as multiple distinct text +blocks, with the possibility of variations to emphasize their logical +unity: + +* If paragraphs are rendered with a first-line indent, only the first + physical paragraph of a compound paragraph should have that indent + -- second and further physical paragraphs should omit the indents; +* vertical spacing between physical elements may be reduced; +* and so on. + +The following option is recognized: + +``class`` : text + Set a "class" attribute value on the compound element. See the + class_ directive below. + + -------- Tables -------- |