fixed typos.
authordinu_gherman
Tue, 18 Jul 2000 10:02:06 +0000
changeset 397 d2e12adb2496
parent 396 9e1229009952
child 398 40c0fb74579c
fixed typos.
docs/userguide/ch1_intro.py
docs/userguide/ch2_graphics.py
docs/userguide/ch3_pdffeatures.py
docs/userguide/ch4_platypus_concepts.py
--- a/docs/userguide/ch1_intro.py	Tue Jul 18 09:31:53 2000 +0000
+++ b/docs/userguide/ch1_intro.py	Tue Jul 18 10:02:06 2000 +0000
@@ -38,13 +38,13 @@
 todo("""
 Be warned! This document is in a <em>very</em> preliminary form.  We need
 your help to make sure it is complete and helpful.  Please send any
-feedback to our mailing list, reportlab-users@egroups.com.
+feedback to our user mailing list, reportlab-users@egroups.com.
 """)
 
 heading2("What is ReportLab?")
-disc("""ReportLab is a software library lets you directly create documents
-in Adobe's Portabe Document Format (PDF) using the Python programming
-language. """)
+disc("""ReportLab is a software library that lets you directly
+create documents in Adobe's Portabe Document Format (PDF) using
+the Python programming language. """)
 
 disc("""PDF is the global standard for electronic documents. It
 supports high-quality printing yet is totally portable across
@@ -53,13 +53,13 @@
 benefit from making PDF documents instead; these can be archived,
 emailed, placed on the web, or printed out the old-fashioned way.
 However, the PDF file format is a complex
-indexed binary format which is impossible to write directly.
+indexed binary format which is impossible to type directly.
 The PDF format specification is more than 600 pages long and
 PDF files must provide precise byte offsets -- a single extra
 character placed anywhere in a valid PDF document can render it
 invalid.
 Until now, most of the world's PDF documents have been produced
-by Adobe's Acrobat tools, which act as a 'print driver.
+by Adobe's Acrobat tools, which act as a 'print driver'.
 """)
 
 disc("""The ReportLab library directly creates PDF based on
@@ -155,7 +155,7 @@
 list("""$cd$ to ^reportlab/pdfgen/test^ and execute $testpdfen.py$,
 which will create a file 'testpdfgen.pdf'.""")
 disc(" ")
-disc("""If you have any problems, check the 'Detailed Instructions' section below""")
+disc("""If you have any problems, check the 'Detailed Instructions' section below.""")
 
 heading3("A note on available versions")
 disc("""The $reportlab$
@@ -172,7 +172,7 @@
 suite that all developers can run at any time.
 New modules and functions within the overall package may be in a state
 of flux, but stable features can be assumed to be stable.  If a bug is
-reported and fix, we assume people who need the fix in a hurry will
+reported and fixed, we assume people who need the fix in a hurry will
 get $current.zip$""")
 
 heading3("Instructions for novices: Windows")
@@ -255,14 +255,14 @@
 super user (system administrator) to do the work).""")
 
 list("""If you are building Python yourself, unpack the sources into a temporary directory using a tar command
-eg $tar xzvf py152.tgz$; this will create a subdirectory called Python-1.5.2
+e.g. $tar xzvf py152.tgz$; this will create a subdirectory called Python-1.5.2
 (or whatever) cd into this directory. Then read the file $README$! It contains the 
 latest information on how to install Python.""")
 
 list("""If your system has the gzip libz library installed
 check that the zlib extension will be installed by default by editing
 the file Modules/Setup.in and ensuring that (near line 405) the line
-containing zlib zlibmodule.c is uncommented ie has no hash '#' character at the
+containing zlib zlibmodule.c is uncommented i.e. has no hash '#' character at the
 beginning. You also need to decide if you will be installing in the default location
 (/usr/local/) or in some other place.
 The zlib module is needed if you want compressed PDF and for some images.""")
@@ -292,9 +292,9 @@
 list("""You should now be able to run python and execute the python statement
 """,doBullet=0)
 eg("""import reportlab""",after=0.1)
-list("""
-If you want to use images you should certainly consider getting &amp; installing the Python Imaging Library
-from <font color=blue>http://www.pythonware.com/products/pil</font>.
+list("""If you want to use images you should certainly consider
+getting &amp; installing the Python Imaging Library from
+<font color=blue>http://www.pythonware.com/products/pil</font>.
 """)
 
 heading3("Instructions for Python novices: Mac")
@@ -309,8 +309,8 @@
 as much as any other Open Source project.  There are many
 ways in which you can help:""")
 
-bullet("""General feedback on the core A.P.I. Does it work for you?
-are there any rough edges?  Does anything feel clunky and awkward?""")
+bullet("""General feedback on the core API. Does it work for you?
+Are there any rough edges?  Does anything feel clunky and awkward?""")
 
 bullet("""New objects to put in reports, or useful utilities for the library.
 We have an open standard for report objects, so if you have written a nice
--- a/docs/userguide/ch2_graphics.py	Tue Jul 18 09:31:53 2000 +0000
+++ b/docs/userguide/ch2_graphics.py	Tue Jul 18 10:02:06 2000 +0000
@@ -646,7 +646,7 @@
 
 disc("""
 The $fonts$ function lists the fonts that are always available.
-These don;t need to be stored in a PDF document, since they
+These don't need to be stored in a PDF document, since they
 are guaranteed to be present in Acrobat Reader.
 """)
 
@@ -809,7 +809,7 @@
 
 disc("""Just as textobjects are designed for the dedicated presentation
 of text, path objects are designed for the dedicated construction of
-graphical figures.  When path objects are drawn onto a $canvas$ they are
+graphical figures.  When path objects are drawn onto a $canvas$ they
 are drawn as one figure (like a rectangle) and the mode of drawing
 for the entire figure can be adjusted: the lines of the figure can
 be drawn (stroked) or not; the interior of the figure can be filled or
--- a/docs/userguide/ch3_pdffeatures.py	Tue Jul 18 09:31:53 2000 +0000
+++ b/docs/userguide/ch3_pdffeatures.py	Tue Jul 18 10:02:06 2000 +0000
@@ -92,7 +92,7 @@
 
 disc("""
 defines horizontal location on the currently drawn page with the identifier
-$Meaning_of_life$.  And the invocation
+$Meaning_of_life$.  And the invocation (???)
 """)
 
 eg("""
@@ -183,7 +183,7 @@
  
 disc("""
 These methods have no automatically seen visible effect on the document.
-They add internal annotations to the document.  These annotations can may be
+They add internal annotations to the document.  These annotations can be
 viewed using the "Document Info" menu item of the browser and they also can
 be used as a simple standard way of providing basic information about the
 document to archiving software which need not parse the entire
--- a/docs/userguide/ch4_platypus_concepts.py	Tue Jul 18 09:31:53 2000 +0000
+++ b/docs/userguide/ch4_platypus_concepts.py	Tue Jul 18 10:02:06 2000 +0000
@@ -18,7 +18,7 @@
 
 disc("""
 The design of Platypus seeks to separate "high level" layout decisions
-from the document content as much as possible.  Thus, for example paragraphs
+from the document content as much as possible.  Thus, for example, paragraphs
 are constructed using paragraph styles and pages are constructed
 using page templates with the intention that hundreds of
 documents with thousands of pages can be reformatted to different
@@ -28,7 +28,7 @@
 
 
 disc("""
-The overall design of PLATYPUS can be thought of has having
+The overall design of Platypus can be thought of has having
 several layers, top down, these are""")
 
 disc("<b>$DocTemplates$</b> the outermost container for the document;")
@@ -38,7 +38,7 @@
 disc("<b>$Frames$</b> specifications of regions in pages that can contain flowing text or graphics.")
  
 disc("""<b>$Flowables$</b> text or graphic elements that should be "flowed 
-   into the document (ie things like images, paragraphs and tables, but not things
+   into the document (i.e. things like images, paragraphs and tables, but not things
    like page footers or fixed page graphics).""")
    
 disc("""<b>$pdfgen.Canvas$</b> the lowest level which ultimately receives the painting of the
@@ -55,7 +55,7 @@
 
 disc("""
 $DocTemplates$ contain one or more $PageTemplates$ each of which contain one or more
-$Frames$. $Flowables$ are things which can be <i>flowed</i> into a $Frame$ eg
+$Frames$. $Flowables$ are things which can be <i>flowed</i> into a $Frame$ e.g.
 a $Paragraph$ or a $Table$.
 """)
 
@@ -76,7 +76,7 @@
 
 disc("""
 A Platypus story consists of a sequence of basic elements called $Flowables$
-and these elements drive the data driven platypus formatting engine.
+and these elements drive the data driven Platypus formatting engine.
 To modify the behavior of the engine
 a special kind of flowable, $ActionFlowables$, tell the layout engine to,
 for example, skip to the next
@@ -111,7 +111,7 @@
 eg(examples.platypusgo)
 
 disc("""
-Finally we create a story and build the document.
+Finally, we create a story and build the document.
 Note that we are using a "canned" document template here which
 comes pre-built with page templates.  We are also using a pre-built
 paragraph style.  We are only using two types of flowables here
@@ -130,7 +130,7 @@
 heading2("$Flowables$")
 disc("""
 $Flowables$ are things which can be drawn and which have $wrap$, $draw$ and perhaps $split$ methods.
-$Flowable$ is an abstract base class for things to be drawn an instance knows its size
+$Flowable$ is an abstract base class for things to be drawn and an instance knows its size
 and draws in its own coordinate system (this requires the base API to provide an absolute coordinate
 system when the $Flowable.draw$ method is called). To get an instance use $f=Flowable()$.
 """)
@@ -171,7 +171,7 @@
 The $Flowable$ class does not implement $draw$.
 The calling code should ensure that the flowable has an attribute $canv$
 which is the $pdfgen.Canvas$ which should be drawn to an that the $Canvas$
-is in an appropriate state (as regards translations rotations etc). Normally
+is in an appropriate state (as regards translations rotations, etc). Normally
 this method will only be called internally by the $drawOn$ method. Derived classes
 must implement this method.
 """)
@@ -210,31 +210,31 @@
 	Flowable.getSpaceBefore(self):
 """)
 disc("""These methods return how much space should follow or precede
-the flowable. The space doesn't belong to the flowable itself ie the flowable's
+the flowable. The space doesn't belong to the flowable itself i.e. the flowable's
 $draw$ method shouldn't consider it when rendering. Controlling programs
 will use the values returned in determining how much space is required by
 a particular flowable in context.
 """)
 
 disc("""The chapters which follow will cover the most important
-specific types of flowables - Paragraphs and Tables""")
+specific types of flowables: Paragraphs and Tables.""")
 
 
 heading2("Frames")
 disc("""
 $Frames$ are active containers which are themselves contained in $PageTemplates$.
 $Frames$ have a location and size and maintain a concept of remaining drawable
-space.
+space. The command
 """)
 
 eg("""
 	Frame(x1, y1, width,height, leftPadding=6, bottomPadding=6,
 			rightPadding=6, topPadding=6, id=None, showBoundary=0)
 """)
-disc("""Creates a $Frame$ instance with lower left hand corner at coordinate $(x1,y1)$
+disc("""creates a $Frame$ instance with lower left hand corner at coordinate $(x1,y1)$
 (relative to the canvas at use time) and with dimensions $width$ x $height$. The $Padding$
 arguments are positive quantities used to reduce the space available for drawing.
-The $id$ argument is an identifier for use at runtime eg 'LeftColumn' or 'Rightcolumn' etc.
+The $id$ argument is an identifier for use at runtime e.g. 'LeftColumn' or 'RightColumn' etc.
 If the $showBoundary$ argument is non-zero then the boundary of the frame will get drawn
 at run time (this is useful sometimes).
 """)
@@ -242,21 +242,21 @@
 eg("""
 	Frame.addFromList(drawlist, canvas)
 """)
-disc("""Consumes $Flowables$ from the front of $drawlist$ until the
+disc("""consumes $Flowables$ from the front of $drawlist$ until the
 	frame is full.	If it cannot fit one object, raises
 	an exception.""")
 
 eg("""
 	Frame.split(flowable,canv)
 """)
-disc('''Ask the flowable to split using up the available space and return
+disc('''Asks the flowable to split using up the available space and return
 the list of flowables.
 ''')
 
 eg("""
 	Frame.drawBoundary(canvas)
 """)
-disc("draw the frame boundary as a rectangle (primarily for debugging).")
+disc("draws the frame boundary as a rectangle (primarily for debugging).")
 heading3("Using $Frames$")
 disc("""
 $Frames$ can be used directly with canvases and flowables to create documents.
@@ -313,7 +313,7 @@
 """)
 
 disc("""
-Creates a document template suitable for creating a basic document. It comes with quite a lot
+creates a document template suitable for creating a basic document. It comes with quite a lot
 of internal machinery, but no default page templates. The required $filename$ can be a string,
 the name of a file to  receive the created <b>PDF</b> document; alternatively it
 can be an object which has a $write$ method such as a $StringIO$ or $file$ or $socket$.
@@ -322,7 +322,7 @@
 disc("""
 The allowed arguments should be self explanatory, but $showBoundary$ controls whether or
 not $Frame$ boundaries are drawn which can be useful for debugging purposes. The
-$allowSplitting$ argument determines whether the builtin methods shoudl try to <i>split</i>
+$allowSplitting$ argument determines whether the builtin methods should try to <i>split</i>
 individual $Flowables$ across $Frames$. The $_pageBreakQuick$ argument determines whether
 an attempt to do a page break should try to end all the frames on the page or not, before ending
 the page.
@@ -343,11 +343,11 @@
     BaseDocTemplate.build(self, flowables, filename=None, canvasmaker=canvas.Canvas)
 """)
 disc("""
-This is the main method which is of interst to the application
+This is the main method which is of interest to the application
 programmer. Assuming that the document instance is correctly set up the 
 $build$ method takes the <i>story</i> in the shape of the list of flowables
 (the $flowables$ argument) and loops through the list forcing the flowables
-one at a time thhrough the formatting machinery. Effectively this causes
+one at a time through the formatting machinery. Effectively this causes
 the $BaseDocTemplate$ instance to issue calls to the instance $handle_XXX$ methods
 to process the various events.
 """)
@@ -393,7 +393,7 @@
 		processing, and immediately before the
 		beforeDrawPage method of the current page
 		template. It could be used to reset page specific
-        information holders.""")
+		information holders.""")
 
 eg("""
     BaseDocTemplate.filterFlowables(self,flowables)
@@ -415,7 +415,7 @@
 disc("""
 These methods constitute the greater part of the layout engine. Programmers shouldn't
 have to call or override these methods directly unless they are trying to modify the layout engine.
-Of course the experienced programmer who wants to intervene at a particular event, $XXX$,
+Of course, the experienced programmer who wants to intervene at a particular event, $XXX$,
 which does not correspond to one of the virtual methods can always override and
 call the base method from the drived class version. We make this easy by providing
 a base class synonym for each of the handler methods with the same name prefixed by an underscore '_'.
@@ -474,7 +474,7 @@
 """)
 heading3("$PageTemplates$")
 disc("""
-The $PageTemplate class$ is a container class with fairly minimal semantics. Each instance
+The $PageTemplate$ class is a container class with fairly minimal semantics. Each instance
 contains a list of $Frames$ and has methods which should be called at the start and end
 of each page.
 """)
@@ -483,7 +483,7 @@
 is used to initialize an instance, the $frames$ argument should be a list of $Frames$
 whilst the optional $onPage$ and $onPageEnd$ arguments are callables which should have signature
 $def XXX(canvas,document)$ where $canvas$ and $document$
-are the canvas and document being drawn. These routines are intended to be used to paint non-flowing (ie standard)
+are the canvas and document being drawn. These routines are intended to be used to paint non-flowing (i.e. standard)
 parts of pages. These attribute functions are exactly parallel to the pure virtual methods
 $PageTemplate.beforPage$ and $PageTemplate.afterPage$ which have signature
 $beforPage(self,canvas,document)$. The methods allow class derivation to be used to define