spug.nml.docbook
index
/home/mmuller/w/spug/nml/docbook.py

#==============================================================================
#
#  $Id: docbook.py 865 2005-03-18 23:58:49Z mike $
#
#  Formatter to write an NML TextBlock to docbook XML.
#
#  Copyright (C) 2005 Michael A. Muller
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
#==============================================================================

 
Modules
       
re
string

 
Classes
       
nml.html.HTMLFormatter(nml.StdFormatter.StdFormatter)
nml.docbook.DocbookFormatter

 
class DocbookFormatter(nml.html.HTMLFormatter)
    An HTML Formatter formats TextBlock objects into DocBook XML.
 
 
Method resolution order:
DocbookFormatter
nml.html.HTMLFormatter
nml.StdFormatter.StdFormatter

Methods defined here:
__init__(self, out, tags=None)
Constructs an HTML formatted from an output stream.
 
parms:
   out::
      [file.write] output stream
   tags::
      [dict<string, string> or None] if specified, this is a mapping
      from tag markups to docbook element tags to be used for those
      markups.  Valid keys are: *underline*, *bold*, *italic* and
      *tele*.  The dictionary can include any subset of them.
format(self, block)
Formats the block as its XML equivalent.
formatAll(self, text)
Formats /text/ (an NML @TextBlock) as a complete HTML document.

Data and other attributes inherited from nml.html.HTMLFormatter:
maxLineWidth = 79
newline = 0
period = 3
periodrx = <_sre.SRE_Pattern object at 0x827c430>
punct = 1
punctrx = <_sre.SRE_Pattern object at 0x8278818>
word = 2
wordrx = <_sre.SRE_Pattern object at 0x821acd0>

Methods inherited from nml.StdFormatter.StdFormatter:
close(self)
Closes the formatting of the block, committing the contents of the
buffer.

Data and other attributes inherited from nml.StdFormatter.StdFormatter:
wsrx = <_sre.SRE_Pattern object at 0x821a800>

 
Data
        StringTypes = (<type 'str'>, <type 'unicode'>)