Preformatted docco added
authorrgbecker
Thu, 24 Aug 2000 11:30:29 +0000
changeset 441 4b7abf4f9565
parent 440 dc4af79eda1c
child 442 e3eac15cddbd
Preformatted docco added
docs/userguide/ch6_tables.py
docs/userguide/genuserguide.py
--- a/docs/userguide/ch6_tables.py	Thu Aug 24 02:26:04 2000 +0000
+++ b/docs/userguide/ch6_tables.py	Thu Aug 24 11:30:29 2000 +0000
@@ -259,6 +259,34 @@
 """%I)
 
 heading1("""Other Useful $Flowables$""")
+heading2("""$Preformatted(text, style, bulletText = None, dedent=0)$""")
+disc("""
+Creates a preformatted paragraph which does no wrapping, line splitting or other manipulations.
+No $XML$ style tags are taken account of in the text.
+If dedent is non zero $dedent$ common leading
+spaces will be removed from the front of each line.
+""")
+heading2("""$XPreformatted(text, style, bulletText = None, dedent=0, frags=None)$""")
+disc("""
+This is a non rearranging form of the $Paragraph$ class; $XML$ tags are allowed in
+$text$ and have the same meanings as for the $Paragraph$ class.
+As for $Preformatted$, if dedent is non zero $dedent$ common leading
+spaces will be removed from the front of each line.
+""")
+EmbeddedCode("""
+from reportlab.lib.styles import getSampleStyleSheet
+stylesheet=getSampleStyleSheet()
+normalStyle = stylesheet['Normal']
+text='''
+   This is a non rearranging form of the <b>Paragraph</b> class;
+   <b><font color=red>XML</font></b> tags are allowed in <i>text</i> and have the same
+   meanings as for the <b>Paragraph</b> class.
+   As for <b>Preformatted</b>, if dedent is non zero <font color=red size=+1>dedent</font>
+   common leading spaces will be removed from the
+   front of each line.
+'''
+t=XPreformatted(text,normalStyle,dedent=3)
+""")
 heading2("""$Image(filename, width=None, height=None)$""")
 disc("""Create a flowable which will contain the image defined by the data in file $filename$.
 The default <b>PDF</b> image type <i>jpeg</i> is supported and if the <b>PIL</b> extension to <b>Python</b>
--- a/docs/userguide/genuserguide.py	Thu Aug 24 02:26:04 2000 +0000
+++ b/docs/userguide/genuserguide.py	Thu Aug 24 11:30:29 2000 +0000
@@ -32,6 +32,9 @@
 #
 ###############################################################################
 #   $Log: genuserguide.py,v $
+#   Revision 1.34  2000/08/24 11:30:29  rgbecker
+#   Preformatted docco added
+#
 #   Revision 1.33  2000/08/02 13:11:31  rgbecker
 #   Table cell updates
 #
@@ -135,7 +138,7 @@
 #   Revision 1.1  2000/06/17 02:57:56  aaron_watters
 #   initial checkin. user guide generation framework.
 #   
-__version__=''' $Id: genuserguide.py,v 1.33 2000/08/02 13:11:31 rgbecker Exp $ '''
+__version__=''' $Id: genuserguide.py,v 1.34 2000/08/24 11:30:29 rgbecker Exp $ '''
 
 
 __doc__ = """
@@ -155,7 +158,7 @@
 from reportlab.lib.pagesizes import letter
 from reportlab.platypus import Paragraph, Spacer, Preformatted,\
             PageBreak, CondPageBreak, Flowable, Table, TableStyle, \
-            NextPageTemplate, KeepTogether, Image
+            NextPageTemplate, KeepTogether, Image, XPreformatted
 from reportlab.lib.styles import ParagraphStyle
 from reportlab.lib import colors
 from reportlab.lib.sequencer import getSequencer