#==============================================================================
#
#  $Id: html.py 1298 2008-04-21 18:34:36Z mike $
#
#  Formatter to write an NML TextBlock to html.
#
#  Copyright (C) 1998 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.
#
#  $Log: html.py,v $
#  Revision 1.13  2005/03/06 23:35:41  mike
#  Fixed html encoding func.
#
#  Revision 1.12  2005/03/06 17:30:22  mike
#  Added support for extracting and displaying a title (obtained from the first
#  header in the document)
#
#  Revision 1.11  2003/10/08 00:04:17  mike
#  Added table borders by default.
#
#  Revision 1.10  2002/04/28 19:09:29  mike
#  Added support for tables.
#
#  Revision 1.9  2000/02/18 01:34:05  mike
#  Fixed broken references.
#
#  Revision 1.8  1999/05/10 22:17:02  mike
#  Fixed 'code' keyword - should have been 'tele'
#
#  Revision 1.7  1999/02/03 01:49:57  mike
#  Fixed tabs and docstrings, added support for references and comments.
#
#  Revision 1.6  1998/12/03 13:08:40  mike
#  Cosmetic fix: added paragraph marker after definition item so that
#  graphical browsers format definition lists nicely.
#
#  Revision 1.5  1998/12/02 20:43:54  mike
#  Put a couple of extra newlines into some select places.
#
#  Revision 1.4  1998/11/11 00:13:54  mike
#  Fixed bug which caused special symbols after the beginning of a word to
#  go un-fixed.
#
#  Revision 1.3  1998/08/14 15:25:13  mike
#  System now correctly converts HTML special characters during output.
#
#  Revision 1.2  1998/06/14 00:42:38  mike
#  Added support for type 'n' - line break (newline).
#
#  Revision 1.1  1998/06/11 01:34:05  mike
#  Initial revision
#
#
#==============================================================================

Modules
		re string

Classes
		nml.StdFormatter.StdFormatter nml.html.HTMLFormatter   class HTMLFormatter(nml.StdFormatter.StdFormatter)     An HTML Formatter formats TextBlock objects into HTML.     Methods defined here: __init__(self, out) Constructs an HTML formatted from an output stream. format(self, block) Formats the block as its HTML equivalent. formatAll(self, text) Formats /text/ (an NML @TextBlock) as a complete HTML document. Data and other attributes defined here: 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>

Functions
		encode(text) Utility method to encode text as HTML (escaping the appropriate characters).  Returns the HTML encoded representation of /text/.   parms:    text::       [string]

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