[PythonReports-checkins] PythonReports/doc prt.txt,1.4,1.5

[alexander s. <a1...@us...>]

Update of /cvsroot/pythonreports/PythonReports/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25646

Modified Files:
	prt.txt 
Log Message:
group header and footer renamed to title and summary;
deprecate nested columns definitions

Index: prt.txt
===================================================================
RCS file: /cvsroot/pythonreports/PythonReports/doc/prt.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** prt.txt	7 Dec 2006 13:21:07 -0000	1.4
--- prt.txt	15 Dec 2006 08:26:35 -0000	1.5
***************
*** 4,11 ****
  
  :Version: 0.3.0
! :Date: 07-dec-2006
  
! .. TODO: variables iterated at start of section;
!          groups have title/summary instead of header/footer
  
  .. TODO: subreports, backgrounds, outline tags
--- 4,10 ----
  
  :Version: 0.3.0
! :Date: 15-dec-2006
  
! .. TODO: variables iterated at start of section
  
  .. TODO: subreports, backgrounds, outline tags
***************
*** 54,58 ****
  The `group`_ element contains one `group`_ or `detail`_ element and
  may contain a sequence of `style`_ elements and possible `columns`_,
! `header`_ and `footer`_ elements.
  
  Report template may contain only one `detail`_ section (innermost
--- 53,57 ----
  The `group`_ element contains one `group`_ or `detail`_ element and
  may contain a sequence of `style`_ elements and possible `columns`_,
! `title`_ and `summary`_ elements.
  
  Report template may contain only one `detail`_ section (innermost
***************
*** 466,474 ****
  ---------
  
! A child element of `layout`_ element containing a summary printed before
! report data.
  
! While `title`_ is processed, all ``*_COUNT`` values are set to zero
! (see `predefined variables`_.)
  
  Attributes:
--- 465,473 ----
  ---------
  
! A child element of `layout`_ or `group`_ element containing a summary
! printed before report data.
  
! While report `title`_ is processed, all ``*_COUNT`` values are set to
! zero (see `predefined variables`_.)
  
  Attributes:
***************
*** 477,482 ****
    Name            Req     Type      Description
  ================= ===== ========= ======================================
! ``swapheader``     O    boolean   If True, title section is printed
!                                   before the first page header.
  ================= ===== ========= ======================================
  
--- 476,483 ----
    Name            Req     Type      Description
  ================= ===== ========= ======================================
! ``swapheader``     O    boolean   When used in report title section,
!                                   value of True lets the title section
!                                   be printed before the first page
!                                   header.  Ignored for group titles.
  ================= ===== ========= ======================================
  
***************
*** 484,489 ****
  -----------
  
! A child element of `layout`_ element containing a summary printed after
! report data.
  
  Attributes:
--- 485,490 ----
  -----------
  
! A child element of `layout`_ or `group`_ element containing a summary
! printed after report data.
  
  Attributes:
***************
*** 492,497 ****
    Name            Req     Type      Description
  ================= ===== ========= ======================================
! ``swapfooter``     O    boolean   If True, the last page footer is
!                                   printed before the summary section
  ================= ===== ========= ======================================
  
--- 493,500 ----
    Name            Req     Type      Description
  ================= ===== ========= ======================================
! ``swapfooter``     O    boolean   When used in report summary section,
!                                   True means that the last page footer
!                                   is printed before the report summary.
!                                   Ignored for group summaries.
  ================= ===== ========= ======================================
  
***************
*** 499,510 ****
  ----------
  
! A child element of `layout`_, `columns`_ or `group`_ describing header
! layout for report page, column or group respectively.
  
  ``footer``
  ----------
  
! A child element of `layout`_, `columns`_ or `group`_ describing footer
! layout for report page, column or group respectively.
  
  ``layout``
--- 502,513 ----
  ----------
  
! A child element of `layout`_ or `columns`_ describing header layout
! for report page or column respectively.
  
  ``footer``
  ----------
  
! A child element of `layout`_ or `columns`_ describing footer layout
! for report page or column respectively.
  
  ``layout``
***************
*** 545,548 ****
--- 548,556 ----
  and `group`_ elements.
  
+ **Please note**: although it is possible to make nested column templates
+ (you may have `columns`_ in `layout`_ and then in data `group`_ and again
+ in a nested `group`_), that does not work well.  It is highly recommended
+ to have only one (or none) `columns`_ element per report template.
+ 
  Attributes: