Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 2046c0127bacbf33c5fb22c054051ae6 > files > 6

ht2html-2.0-18.mga5.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<!-- THIS PAGE IS AUTOMATICALLY GENERATED.  DO NOT EDIT. -->
<!-- Fri Apr  5 00:01:40 2002 -->
<!-- USING HT2HTML 2.0 -->
<!-- SEE http://ht2html.sf.net -->
<!-- User-specified headers:
Title: The components of a web page generated by ht2html

-->

<head>
<title>The components of a web page generated by ht2html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="HT2HTML/2.0">
<style type="text/css">
body { margin: 0px; }
</style>
</head>
<body bgcolor="#ffffff" text="#000000"
      marginwidth="0" marginheight="0"
      link="#0000bb"  vlink="#551a8b"
      alink="#ff0000">
<!-- start of page table -->
<table width="100%" border="0" cellspacing="0" cellpadding="0">
<!-- start of banner row -->
<tr>
<!-- start of corner cells -->
<td width="150" valign="middle" bgcolor="#4fa445" class="corner">

<center>
    <a href="index.html">
    <img alt="ht2html" border="0"
         src="ht2html.png"></a></center> </td>
<td width="15" bgcolor="#89aaaa">&nbsp;&nbsp;</td><!--spacer-->
<!-- end of corner cells -->
<!-- start of banner -->
<td width="90%" bgcolor="#89aaaa" class="banner">
<!-- start of site links table -->
<table width="100%" border="0"
cellspacing="0" cellpadding="0"
       bgcolor="#ffffff">
<tr>
    <td bgcolor="#89aaaa">
<a href="index.html">Home</a>
    </td>
    <td bgcolor="#89aaaa">
<a href="http://www.python.org/">Python.Org</a>
    </td>
    <td bgcolor="#89aaaa">
<a href="http://barry.wooz.org/">Barry's home page</a>
    </td>
    <td bgcolor="#89aaaa">
<a href="http://sf.net/projects/ht2html">ht2html @ SourceForge</a>
    </td>
</tr>
</table><!-- end of site links table -->

</td><!-- end of banner -->
</tr><!-- end of banner row -->
<tr><!-- start of sidebar/body row -->
<!-- start of sidebar cells -->
<td width="150" valign="top" bgcolor="#89aaaa" class="sidebar">
<!-- start of sidebar table -->
<table width="100%" border="0" cellspacing="0" cellpadding="3"
       bgcolor="#ffffff">
<tr><td bgcolor="#238e68"><b><font color="#ffffff">
Subsections
</font></b></td></tr>
<tr><td bgcolor="#89aaaa">
<a href="index.html">Introduction</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<b>Web&nbsp;page&nbsp;components</b>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="bugs.html">Bugs&nbsp;and&nbsp;Peculiarities</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="docstring.html">Usage</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="style.html">Using Stylesheets</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="examples.html">Examples</a>
</td></tr>
<tr><td bgcolor="#89aaaa">&nbsp;
<tr><td bgcolor="#238e68"><b><font color="#ffffff">
ht2html sites
</font></b></td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://barry.wooz.org/">Barry's&nbsp;home&nbsp;page</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://www.python.org/">Python.Org</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://www.jython.org/">Jython.Org</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://www.list.org/">GNU&nbsp;Mailman</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://tmda.sf.net/">TMDA</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://acvalbonne.online.fr/">Cycling&nbsp;Club</a>
</td></tr>
<tr><td bgcolor="#89aaaa">&nbsp;
<tr><td bgcolor="#238e68"><b><font color="#ffffff">
Email me
</font></b></td></tr>
<tr><td bgcolor="#89aaaa">
<a href="mailto:barry@python.org">Barry A. Warsaw</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
&nbsp;
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://www.python.org/">
<center>
    <img alt="[Python Powered]" border="0"
         src="PythonPoweredSmall.png"></center>
</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
&nbsp;
</td></tr>
<tr><td bgcolor="#89aaaa">
&copy; 1999-2002
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="http://www.python.org/psf/">Python Software Foundation</a>
</td></tr>
<tr><td bgcolor="#89aaaa">
<hr>
</td></tr>
<tr><td bgcolor="#89aaaa">
<a href="components.ht">[page source]</a>
</td></tr>
</table><!-- end of sidebar table -->

</td>
<td width="15">&nbsp;&nbsp;</td><!--spacer-->
<!-- end of sidebar cell -->
<!-- start of body cell -->
<td valign="top" width="90%" class="body"><br>
<h3>The components of a web page generated by ht2html</h3>

<h4>Layouts</h4>

<p>A Web page is divided into 5 parts: <a href="#banner">banner</a>,
<a href="#corner">corner</a>, <a href="#sidebar">sidebar</a>, 
<a href="#body">body</a>, and <a href="#continuation">continuation</a>.  
ht2html lets you control which of these parts
are included, and you control what goes in each of these parts.
Here's a picture:

<pre>
+-----------+-------------------------------------------------+
|           |                                                 |
|  corner   |                   banner                        |
|           |                                                 |
+-----------+-------------------------------------------------+
|           |                                                 |
|  sidebar  |                   body                          |
|           |                                                 |
|           |                                                 |
|           |                                                 |
|           |                                                 |
|           |                                                 |
|           |                                                 |
|    ...    |                   ...                           |
+-----------+-------------------------------------------------+
|                                                             |
|                       continuation                          |
|                                                             |
|                                                             |
|                                                             |
|                           ...                               |
+-------------------------------------------------------------+
</pre>

<p>Normally the corner, banner, sidebar, and body are each placed into
cells of a table.  This table is closed just before the continuation.

<p>You can omit any of these 5 elements; by default there is no
continuation, so you have to do something explicit to include that 
on the page.  Without the continuation, the sidebar will extend to 
the bottom of the page.

<p>If you omit the banner, you do not get a corner.  In that case you
should put any corner HTML in the first cell of the
<a href="#sidebar">sidebar</a>.
If you have no sidebar, the table will actually
be closed after the banner and both the body and continuation will be
outside the table, at the full width of the page.

<h4><a name="banner">Banner</a></h4>

<p>The banner can contain any html you want, but the 
<a href="http://www.python.org/">python.org</a> site
uses this area to provide links for top level topic areas that we
want to be accessible from any page.  We call these <em>site links</em>.
ht2html provides a class called <tt>Banner</tt> which automatically lays
out a specified set of links into rows and columns (by default 4)
for the banner area.

<p><tt>Banner</tt>'s constructor takes two arguments, a list of links
and the number of columns to use for layout.
Links are inserted from left to right, top to bottom, in their own 
nested table.  As many rows as needed are used so that all the
links are displayed.  The last row may contain some empty cells if 
the number of links isn't a multiple of columns.

<p>Each element of the list argument must be a tuple of the form
<tt>(URL, LTEXT [, EXTRA])</tt>, where URL is either a string or
<tt>None</tt>.  If
URL is a string, it is used in an anchor tag wrapped around the
LTEXT.  If the URL is <tt>None</tt>, then LTEXT is not hyperlinked, but
inserted into the cell verbatim.  EXTRA is optional and if
provided, can be arbitrary html, which gets written after the
hyperlinked LTEXT.

<h4><a name="corner">Corner</a></h4>

<p>Again, the corner can contain any html, but usually this contains
a logo for the site which links to the site's home page.  You
manage this explicitly though, so you can do anything you want
with this area.

<h4><a name="sidebar">Sidebar</a></h4>

<p>Usually the sidebar is used for a table of contents for the
subdirectory the page is in.  ht2html provides a class called
<tt>Sidebar</tt> which manages a table of contents for this area.

<p><tt>Sidebar</tt> takes one argument in its constructor: a list of
links similar to that used by the <a name="banner"><tt>Banner</tt></a> 
class.  Each element of this
list can be either a string or a tuple.  If it's a tuple, it has
the same semantics as with the <tt>Banner</tt> class.  If the element
is a string, then it's interpreted as a table-of-contents section
header and it is displayed (non-hyperlinked) in reverse video.

<h4><a name="body">Body</a></h4>

<p>This contains the meat of your web page.  You write all this stuff
and ht2html just sticks it in the right place in the page's table.
The body can contain nested tables, or any other html, and this
usually ends up looking as you expect (but see the
<a href="bugs.html">Bugs and peculiarities</a> section).

<h4><a name="continuation">Continuation</a></h4>

<p>For long pages, you may not want to have a sidebar that extends to 
the bottom of the web page.  Maybe part of your text looks better
if it extended to the full width of the page.  You specify the
separation between the body and the continuation text by including 
a special comment in your <tt>.ht</tt> file:

<blockquote>
&lt;!--table-stop--&gt;
</blockquote>

<p>The mark must look exactly like this (don't put any spaces in the
angle brackets).  Put this where you'd like the continuation html to
start.  You can't span forms or tables across this mark because ht2html
substitutes row and table end tags for this special marker.

</td><!-- end of body cell -->
</tr><!-- end of sidebar/body row -->
</table><!-- end of page table -->
</body></html>