[Docutils-checkins] r6880 - in trunk/sandbox/paultremblay/docs/rst: attribute_sets.rst howto.rst

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Author: paultremblay
Date: 2011-02-17 16:41:26 +0100 (Thu, 17 Feb 2011)
New Revision: 6880

Modified:
   trunk/sandbox/paultremblay/docs/rst/attribute_sets.rst
   trunk/sandbox/paultremblay/docs/rst/howto.rst
Log:
Documentation for new attriute sets, and for dedication and title
parts.


Modified: trunk/sandbox/paultremblay/docs/rst/attribute_sets.rst
===================================================================

--- trunk/sandbox/paultremblay/docs/rst/attribute_sets.rst	2011-02-17 15:40:30 UTC (rev 6879)
+++ trunk/sandbox/paultremblay/docs/rst/attribute_sets.rst	2011-02-17 15:41:26 UTC (rev 6880)
@@ -310,42 +310,38 @@
 between the label (such as "Version", and the labels' value (such
 as "1.2").
 
-bibliographic-fields-front-list-block
--------------------------------------
+bibliographic-fields-list-item
+------------------------------
 
-:fo: list-block
+:fo: fo:list-item
 
-:docutils: docinfo
+:docutils:
+         docinfo/author|docinfo/authors|docinfo/organization|etc.
 
-:inherits: bibliographic-fields-list-block
-
 :defaults:
 
-     break-after: page
+     space-before: 12pt
 
-The attribute set has a single default attribute,
-'break-after="page"', and inherits the rest of the properties
-from bibliographic-fields-list-block. It is applied *only* when
-the bibliographic-fields is located in the front section. If you
-did not wish for a page break, create this attribute set with no
-attributes.
+For each item (author, authors, organization, contact, address,
+version, date, copyright, custom field) in the bibliograhic
+fields. Use the 'space-after' attribute to control the spacing
+between each item.
 
-bibliographic-fields-list-item
-------------------------------
+bibliographic-fields-first-list-item
+------------------------------------
 
 :fo: fo:list-item
 
 :docutils:
          docinfo/author|docinfo/authors|docinfo/organization|etc.
 
+:inherits: bibliographic-fields-list-item
+
 :defaults:
 
-     space-before: 12pt
+     space-before: 0pt
 
-For the each item (author, authors, organization, contact,
-address, version, date, copyright, custom field) in the
-bibliograhic fields. Use the 'space-after' attribute to control
-the spacing between each item.
+Same as above, but sets the space before to 0pt.
 
 bibliographic-fields-list-item-label
 ------------------------------------
@@ -406,6 +402,20 @@
 field. Use the 'space-after' attribute to control the spacing
 between a multi-paragraph description.
 
+bibliographic-first-fields-block
+--------------------------------
+
+:fo: fo:block
+
+:docutils:
+         docinfo/author|docinfo/authors|docinfo/organization|etc.
+
+:inherits: bibliographic-fields-block
+
+:defaults:
+
+Same as above, but for the first such paragraph.
+
 address-value-block
 -------------------
 
@@ -438,8 +448,6 @@
 
 :defaults:
 
-     break-after: page
-
 Formats the dedication text, including the title and subsequent
 paragraphs, by wrapping them in a block.
 
@@ -452,8 +460,6 @@
 
 :defaults:
 
-     break-after: page
-
 Formats the abstract text, including the title and subsequent
 paragraphs, by wrapping them in a block.
 
@@ -504,6 +510,21 @@
 
 Formats the paragraphs of the dedication.
 
+dedication-first-paragraph-block
+--------------------------------
+
+:fo: fo:block
+
+:docutils: topic[@classes = "dedication"]/paragraph
+
+:inherits: dedication-paragraph-block
+
+:defaults:
+
+     space-before: 0pt
+
+Formats the first paragraph of the dedication.
+
 abstract-paragraph-block
 ------------------------
 
@@ -513,10 +534,25 @@
 
 :defaults:
 
-     space-after: 12pt
+     space-before: 12pt
 
 Formats the paragraphs of the abstract.
 
+abstract-first-paragraph-block
+------------------------------
+
+:fo: fo:block
+
+:docutils: topic[@classes = "abstract"]/paragraph
+
+:inherits: abstract-paragraph-block
+
+:defaults:
+
+     space-before: 0pt
+
+Formats the first paragraph of the abstract.
+
 Header and Footer Attribute Sets
 ================================
 

Modified: trunk/sandbox/paultremblay/docs/rst/howto.rst
===================================================================
--- trunk/sandbox/paultremblay/docs/rst/howto.rst	2011-02-17 15:40:30 UTC (rev 6879)
+++ trunk/sandbox/paultremblay/docs/rst/howto.rst	2011-02-17 15:41:26 UTC (rev 6880)
@@ -619,7 +619,16 @@
  bibliographic-fields.right-indent = 20pt
  bibliographic-fields.background-color = grey
 
+Putting the bibliographic fields on its own page
+++++++++++++++++++++++++++++++++++++++++++++++++++
 
+::
+
+ bibliographic-fields.page-break-before = true
+ # or, depending on your layout
+ bibliographic-fields.page-break-after = true
+
+
 To format space between items
 ++++++++++++++++++++++++++++++
 
@@ -670,3 +679,99 @@
   bibliographic-fields.revision-text = revision
   bibliographic-fields.date-text = date
 
+Formatting the text of the field
++++++++++++++++++++++++++++++++++++
+
+Use the ``'bibliographic-fields-text'`` identifier::
+
+ bibliographic-fields-text.font-weight=bold
+
+Formatting the text for individual paragraphs
++++++++++++++++++++++++++++++++++++++++++++++
+
+For fields that have more than one paragraph, use the ``'bibliographic-fields-paragraph'``
+identifier. This identifier can take any block property::
+
+ bibliographic-fields-paragraph.space-before = 12pt
+
+Note that using the ``'space-before'`` property has the same effect as
+controlling the space between each paragraph, without putting unwated space
+before the first paragraph. 
+
+Formatting the dedication
+--------------------------
+
+Creating a dedication
++++++++++++++++++++++++
+
+::
+
+ :Dedication: I dedicate this thesis to my good friend John, who
+   stood by me for many years while I struggled ...
+
+Putting dedication on its own page
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+::
+
+ dedication.page-break-before = true
+ # or, depending on your layout
+ dedication.page-break-after = true
+
+Formatting the title
++++++++++++++++++++++++
+
+Use the ``'dedication-title'`` identifier, which can take any block property::
+
+ dedication-title.alignment = center
+ dedication-title.font-size = 24pt
+
+Formatting the paragraphs
+++++++++++++++++++++++++++
+
+Use the ``'dedication-paragraph'`` identifier, which can take any block property::
+
+ dedication-paragraph.font-size = 10pt
+ dedication-paragraph.alignment = right
+ dedication-paragraph.font-style = italic
+
+
+Formatting the abstract
+--------------------------
+
+Creating a abstract
++++++++++++++++++++++++
+
+::
+
+
+ :Abstract: Just an example of bibliograhic fields.
+  This continues on.
+
+Putting abstract on its own page
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+::
+
+ abstract.page-break-before = true
+ # or, depending on your layout
+ abstract.page-break-after = true
+
+Formatting the title
++++++++++++++++++++++++
+
+Use the ``'abstract-title'`` identifier, which can take any block property::
+
+ abstract-title.alignment = center
+ abstract-title.font-size = 24pt
+
+Formatting the paragraphs
+++++++++++++++++++++++++++
+
+Use the ``'abstract-paragraph'`` identifier, which can take any block property::
+
+ abstract-paragraph.font-size = 10pt
+ abstract-paragraph.alignment = right
+ abstract-paragraph.font-style = italic
+
+



