File: HTMLgen_overview.html

package info (click to toggle)
htmlgen 2.2.2-12.1
links: PTS
area: main
in suites: jessie, jessie-kfreebsd
size: 1,840 kB
ctags: 1,480
sloc: python: 4,518; makefile: 93
file content (166 lines) | stat: -rw-r--r-- 8,115 bytes
parent folder | download | duplicates (7)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>

<!-- This file generated using Python HTMLgen module. -->
<HEAD>
  <META NAME="GENERATOR" CONTENT="HTMLgen 2.2.2">
        <TITLE>Module HTMLgen - A class library for the generation of HTML documents.</TITLE>

 <LINK rel=stylesheet href="HTMLgen.css" type=text/css title="HTMLgen.css">
</HEAD>
<BODY BGCOLOR="#FFFFFF" BACKGROUND="../image/bg-dots.gif" TEXT="#000000" LINK="#EE0000" VLINK="#990000">
<span style="width: 60px"></span> 
<A HREF="HTMLcolors_overview.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<H3>Module HTMLgen - A class library for the generation of HTML documents.</H3>
<HR>

<H2>SYNOPSIS</H2>

<PRE># Classes
<A HREF="HTMLgen-AbstractTag.html">class AbstractTag</A>
<A HREF="HTMLgen-AbstractTagSingle.html">class AbstractTagSingle</A>
<A HREF="HTMLgen-Address.html">class Address(AbstractTag)</A>
<A HREF="HTMLgen-Area.html">class Area(AbstractTagSingle)</A>
<A HREF="HTMLgen-AutoStringTemplate.html">class AutoStringTemplate(StringTemplate)</A>
<A HREF="HTMLgen-AutoTemplateDocument.html">class AutoTemplateDocument(AutoStringTemplate)</A>
<A HREF="HTMLgen-BR.html">class BR(AbstractTagSingle)</A>
<A HREF="HTMLgen-Base.html">class Base(AbstractTagSingle)</A>
<A HREF="HTMLgen-BaseFont.html">class BaseFont(AbstractTagSingle)</A>
<A HREF="HTMLgen-BasicDocument.html">class BasicDocument</A>
<A HREF="HTMLgen-Big.html">class Big(AbstractTag)</A>
<A HREF="HTMLgen-Blockquote.html">class Blockquote(AbstractTag)</A>
<A HREF="HTMLgen-Caption.html">class Caption(AbstractTag)</A>
<A HREF="HTMLgen-Center.html">class Center(AbstractTag)</A>
<A HREF="HTMLgen-Cite.html">class Cite(AbstractTag)</A>
<A HREF="HTMLgen-Code.html">class Code(AbstractTag)</A>
<A HREF="HTMLgen-Comment.html">class Comment</A>
<A HREF="HTMLgen-Container.html">class Container</A>
<A HREF="HTMLgen-Define.html">class Define(AbstractTag)</A>
<A HREF="HTMLgen-DefinitionList.html">class DefinitionList(List)</A>
<A HREF="HTMLgen-Div.html">class Div(AbstractTag)</A>
<A HREF="HTMLgen-Embed.html">class Embed(AbstractTagSingle)</A>
<A HREF="HTMLgen-Emphasis.html">class Emphasis(AbstractTag)</A>
<A HREF="HTMLgen-Font.html">class Font(AbstractTag)</A>
<A HREF="HTMLgen-Form.html">class Form</A>
<A HREF="HTMLgen-Frame.html">class Frame(AbstractTag)</A>
<A HREF="HTMLgen-Frameset.html">class Frameset(AbstractTag)</A>
<A HREF="HTMLgen-FramesetDocument.html">class FramesetDocument(BasicDocument)</A>
<A HREF="HTMLgen-HR.html">class HR(AbstractTagSingle)</A>
<A HREF="HTMLgen-Heading.html">class Heading(AbstractTag)</A>
<A HREF="HTMLgen-Href.html">class Href</A>
<A HREF="HTMLgen-Image.html">class Image(AbstractTagSingle)</A>
<A HREF="HTMLgen-ImageBulletList.html">class ImageBulletList(List)</A>
<A HREF="HTMLgen-InitialCaps.html">class InitialCaps</A>
<A HREF="HTMLgen-Input.html">class Input</A>
<A HREF="HTMLgen-KBD.html">class KBD(AbstractTag)</A>
<A HREF="HTMLgen-List.html">class List(UserList)</A>
<A HREF="HTMLgen-MailTo.html">class MailTo</A>
<A HREF="HTMLgen-Map.html">class Map</A>
<A HREF="HTMLgen-Meta.html">class Meta</A>
<A HREF="HTMLgen-Name.html">class Name(Href)</A>
<A HREF="HTMLgen-NoFrames.html">class NoFrames(AbstractTag)</A>
<A HREF="HTMLgen-Nobr.html">class Nobr(AbstractTag)</A>
<A HREF="HTMLgen-NonBulletList.html">class NonBulletList(List)</A>
<A HREF="HTMLgen-OrderedList.html">class OrderedList(List)</A>
<A HREF="HTMLgen-P.html">class P</A>
<A HREF="HTMLgen-Paragraph.html">class Paragraph(AbstractTag)</A>
<A HREF="HTMLgen-Pre.html">class Pre(AbstractTag)</A>
<A HREF="HTMLgen-RawText.html">class RawText</A>
<A HREF="HTMLgen-Sample.html">class Sample(AbstractTag)</A>
<A HREF="HTMLgen-Script.html">class Script</A>
<A HREF="HTMLgen-Select.html">class Select(UserList)</A>
<A HREF="HTMLgen-SeriesDocument.html">class SeriesDocument(SimpleDocument)</A>
<A HREF="HTMLgen-SimpleDocument.html">class SimpleDocument(BasicDocument)</A>
<A HREF="HTMLgen-Small.html">class Small(AbstractTag)</A>
<A HREF="HTMLgen-Span.html">class Span(AbstractTag)</A>
<A HREF="HTMLgen-Strike.html">class Strike(AbstractTag)</A>
<A HREF="HTMLgen-StringTemplate.html">class StringTemplate</A>
<A HREF="HTMLgen-Strong.html">class Strong(AbstractTag)</A>
<A HREF="HTMLgen-Sub.html">class Sub(AbstractTag)</A>
<A HREF="HTMLgen-Sup.html">class Sup(AbstractTag)</A>
<A HREF="HTMLgen-TD.html">class TD(AbstractTag)</A>
<A HREF="HTMLgen-TH.html">class TH(AbstractTag)</A>
<A HREF="HTMLgen-TR.html">class TR(AbstractTag)</A>
<A HREF="HTMLgen-TT.html">class TT(AbstractTag)</A>
<A HREF="HTMLgen-Table.html">class Table</A>
<A HREF="HTMLgen-TableLite.html">class TableLite(AbstractTag)</A>
<A HREF="HTMLgen-TemplateDocument.html">class TemplateDocument(StringTemplate)</A>
<A HREF="HTMLgen-Text.html">class Text</A>
<A HREF="HTMLgen-Textarea.html">class Textarea</A>
<A HREF="HTMLgen-U.html">class U(AbstractTag)</A>
<A HREF="HTMLgen-URL.html">class URL</A>
<A HREF="HTMLgen-Var.html">class Var(AbstractTag)</A>
</PRE>

<PRE># Functions
def compare_f2f(f1, f2)
def compare_s2f(s, f2)
<A HREF="HTMLgen-escape.html">def escape(text, replace=string.replace)</A>
<A HREF="HTMLgen-imgsize.html">def imgsize(path)</A>
<A HREF="HTMLgen-markup_re.html">def markup_re(text, rex=None, marker=None, collapse=0)</A>
<A HREF="HTMLgen-mpath.html">def mpath(path)</A>
<A HREF="HTMLgen-overlay_values.html">def overlay_values(obj, dict)</A>
<A HREF="HTMLgen-relpath.html">def relpath(path1, path2)</A>
</PRE>

<PRE># Variables
string CONTYPE = 'Content-Type: text/html\0 ...
string DOCTYPE = '&lt;!DOCTYPE HTML PUBLIC "-/ ...
int I_am_a_list = 1
string __file__ = '/usr/local/lib/python1.5/ ...
string __version__ = '2.2.2'
</PRE>

<H2>DESCRIPTION</H2>


<P>Each HTML tag type has a supporting class which is responsible for
emitting itself as valid HTML formatted text. An attempt is made to
provide classes for newer HTML 3.2 and proposed tag elements.  The
definitive reference for HTML tag elements can be found at
<A HREF="http://www.W3.org/TR/REC-html32.html">W3C</A>.  Also, I used the HTML book by Musciano and
Kennedy from <A HREF="http://www.oreilly.com/catalog/html3/index.html">O Reilly</A> (2nd. Ed.) as the guiding reference.</P>


<P>The Document classes are container objects which act as a focal point
to populate all the contents of a particular web page. It also can
enforce consistent document formating according to the guidelines from
the <A HREF="http://info.med.yale.edu/caim/manual/contents.html">Yale Web Style Manual</A>.</P>


<P>Features include customization of document template graphics / colors
through use of resource files, minimizing the need for modifying or
subclassing from the module source code. Support for tables, frames,
forms (persistent and otherwise) and client-side imagemaps are included.</P>


<P>A newer implementation for the Table support is now included,
TableLite().  In support of this there are new tag classes TD, TH, TR
and Caption.  These class instances can be assembled in any way to
populate the TableLite container object. </P>

<H2>SEE ALSO</H2>

<PRE><A HREF="UserList_overview.html">UserList</A>
<A HREF="copy_overview.html">copy</A>
<A HREF="os_overview.html">os</A>
<A HREF="re_overview.html">re</A>
<A HREF="string_overview.html">string</A>
<A HREF="time_overview.html">time</A>
</PRE>


<P><HR>
<span style="width: 60px"></span> 
<A HREF="HTMLcolors_overview.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<BR><IMG src="../image/Buzz.gif" height="51" width="56" alt="Buzz.gif" align="bottom">
<FONT SIZE="-1"><P>Copyright &#169 Robin Friedrich<BR>All Rights Reserved<BR>

Comments to author: <A HREF="mailto:&#102;rie&#100;ric&#104;@py&#116;hon&#112;ros&#46;com">friedrich@pythonpros.com</A><br>
Generated: Tue Apr 20, 1999 <BR><hr>
</FONT>
</BODY> </HTML>