### Class FramesetDocument - A minimal document suitable for entering Framesets.

## SYNOPSIS

    import HTMLgen

    class FramesetDocument(BasicDocument)
      string __module__ = 'HTMLgen'
      def __str__(self)
      None alinkcolor = None
      None alinkcolor = None
      None alinkcolor = None
      None alinkcolor = None

      # Methods inherited by FramesetDocument from BasicDocument
      def __init__(self, *args, **kw)
      def append(self, *items)
      def append_file(self, filename, marker_function = None)
      def copy(self)
      def html_body_tag(self)
      def html_head(self)
      def prepend(self, *items)
      def write(self, filename = None)

## DESCRIPTION

Arguments are for contents NOT a document resource file.

### 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.

## Keyword Parameters

title
  string to be used as the document title.
base
  object of the Base class
meta
  object of the Meta class
cgi
  if non zero will issue a mime type of text/html
script
  a single or list of Script objects to be included in the <HEAD>

No <body> markup. Instead add Frameset(s) with the constructor or append method.

## SEE ALSO

HTMLgen

BasicDocument

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