Previous Next blank.gif blank.gif

Class BasicDocument - Base class to define an HTML document.


SYNOPSIS

import HTMLgen
class BasicDocument
  def __init__(self, *args, **kw)
  string __module__ = 'HTMLgen'
  def __str__(self)
  None alinkcolor = None
  def append(self, *items)
  def append_file(self, filename, marker_function = None)
  None alinkcolor = None
  None alinkcolor = None
  None alinkcolor = None
  def copy(self)
  def html_body_tag(self)
  def html_head(self)
  None alinkcolor = None
  def prepend(self, *items)
  None alinkcolor = None
  string attr_template = ''
  None alinkcolor = None
  def write(self, filename = None)

DESCRIPTION

Non-keyword arguments are taken as the initial contents for this object.

Keyword arguments: title -- HTML TITLE attribute for document bgcolor -- background color expressed in hex-triplet or names from HTMLcolors. background -- background image filename cgi -- flag to indicate if this is used in CGI context (1 if it is) textcolor -- color to use for normal text linkcolor -- color to use for hyperlinks vlinkcolor -- color to use for visited hyperlinks alinkcolor -- color to use when hyperlink is active

def append(self, *items)

Add content to the Document object.

Arg items can be plain text or objects; multiple arguments supported.

def append_file(self, filename, marker_function = None)

Add the contents of a file to the document.

filename
the filename of the file to be read [string]
marker_function
a callable object which the text read from the file will be passed through before being added to the document.

def copy(self)

Return a complete copy of the current Document object.

def html_body_tag(self)

Return BODY tag with attributes.

def html_head(self)

Generate the HEAD, TITLE and BODY tags.

def prepend(self, *items)

Add content to the beginning of the Document object.

Arg items can be plain text or objects; multiple arguments supported.

def write(self, filename = None)

Emit the Document HTML to a file or standard output.

In Unix you can use environment variables in filenames. Will print to stdout if no argument.

SEE ALSO

HTMLgen


Previous Next blank.gif blank.gif
Buzz.gif

Copyright © Robin Friedrich
All Rights Reserved
Comments to author: friedrich@pythonpros.com
Generated: Tue Apr 20, 1999