<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<title>
WebMake: Documentation: HTML::WebMake::Main
</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta name="generator" content="WebMake/2.3" />
<style type="text/css">
body {
background-color: #ffffff;
color: #000000;
line-height: 110%;
margin-left: 10px;
margin-right: 10px;
}
p, table, td, th {
font-family: verdana,lucida,helvetica,sans-serif;
font-size: 11px;
line-height: 110%;
}
pre {
margin-left: 3%;
white-space: pre;
}
code, samp, pre, p pre {
font-family: "lucida console", "Courier New", courier, "fixed-width", monospace;
font-weight: bold;
}
H1 {
font-size: 150%; font-family: Garamond, "Book Antiqua",Times,serif;
background: #FFCC66; text-align: center;
padding: 0.5em 1em 0.5em 1em; border-width: 1px;
border-color: black; border-style: solid; line-height: 120%;
}
H2 {
font-size: 125%; font-family: Garamond, "Book Antiqua",Times,serif;
background: #FFDD77; text-align: center;
padding: 0.5em 1em 0.5em 1em; border-width: 1px;
border-color: black; border-style: solid; line-height: 100%;
}
H3 {
font-size: 100%; font-family: Garamond, "Book Antiqua",Times,serif;
background: #FFEE88; text-align: center;
padding: 0.5em 1em 0.5em 1em; border-width: 1px;
border-color: black; border-style: solid;
}
H4 { font-size: 75%; font-family: Garamond, "Book Antiqua",Times,serif; }
H5 { font-size: 50%; font-family: Garamond, "Book Antiqua",Times,serif; }
H6 { font-size: 25%; font-family: Garamond, "Book Antiqua",Times,serif; }
A:link {
font-weight: bold;
color: #004000;
text-decoration: underline;
}
A:visited {
font-weight: bold;
color: #008000;
text-decoration: underline;
}
A:active {
font-weight: bold;
color: #800000;
text-decoration: underline;
}
dt {
font-size: medium;
font-weight: bold;
padding-top: 8px; padding-bottom: 8px;
}
dd {
padding-top: 8px; padding-bottom: 8px;
}
</style>
</head>
<body bgcolor="#ffffff" text="#000000" link="#3300cc" vlink="#660066">
<!-- font tag for compat with non-CSS browsers -->
<font face="lucida,verdana,sans-serif">
<div align="center">
<img src="images/WebMakeTitle.png" alt="WebMake" width="500" height="122" />
</div>
<table width="100%">
<tr>
<td valign="top">
<strong><a href="http://webmake.taint.org/">WebMake</a>
Documentation</strong> (version 2.3)
</td>
<td valign="top">
<div align="right">
[ <a href="Content.pm.html">Back</a> | <a href="PerlCodeLibrary.pm.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In One</a> ]
</div>
</td>
</tr>
</table>
<!-- yes, it's that Mozilla black-border code again ;) -->
<!-- stolen from www.mozilla.org via rc3.org -->
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td bgcolor="#aaaaaa">
<table border="0" cellspacing="4" cellpadding="4" width="100%">
<tr>
<td bgcolor="#ffffff">
<table border="0" cellspacing="4" cellpadding="4" width="100%">
<tr>
<td>
<h1>HTML::WebMake::Main</h1><a name="__index__"></a><!-- INDEX BEGIN -->
<ul>
<li>
<a href="#name">NAME</a>
</li>
<li>
<a href="#synopsis">SYNOPSIS</a>
</li>
<li>
<a href="#description">DESCRIPTION</a>
</li>
<li>
<a href="#methods">METHODS</a>
</li>
<li>
<a href="#more documentation">MORE DOCUMENTATION</a>
</li>
<li>
<a href="#see also">SEE ALSO</a>
</li>
<li>
<a href="#author">AUTHOR</a>
</li>
<li>
<a href="#copyright">COPYRIGHT</a>
</li>
<li>
<a href="#availability">AVAILABILITY</a>
</li>
</ul>
<!-- INDEX END -->
<hr />
<h1><a name="name">NAME</a></h1><p>
HTML::WebMake - a simple web site management system, allowing an entire site to
be created from a set of text and markup files and one WebMake file.
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1><pre>
my $f = new HTML::WebMake::Main ();
$f->readfile ($filename);
$f->make();
my $failures = $f->finish();
exit $failures;</pre><hr />
<h1><a name="description">DESCRIPTION</a></h1><p>
WebMake is a simple web site management system, allowing an entire site to be
created from a set of text and markup files and one WebMake file.
</p>
<p>
It requires no dynamic scripting capabilities on the server; WebMake sites can
be deployed to a plain old FTP site without any problems.
</p>
<p>
It allows the separation of responsibilities between the content editors, the
HTML page designers, and the site architect; only the site architect needs to
edit the WebMake file itself, or know perl or WebMake code.
</p>
<p>
A multi-level website can be generated entirely from 1 or more WebMake files
containing content, links to content files, perl code (if needed), and output
instructions. Since the file-to-page mapping no longer applies, and since
elements of pages can be loaded from different files, this means that standard
file access permissions can be used to restrict editing by role.
</p>
<p>
Since WebMake is written in perl, it is not limited to command-line invocation;
using the <code>HTML::WebMake::Main</code> module directly allows WebMake to be run from
other Perl scripts, or even mod_perl (WebMake uses <code>use strict</code> throughout,
and temporary globals are used only where strictly necessary).
</p>
<hr />
<h1><a name="methods">METHODS</a></h1><dl>
<dt>
<strong><a name="item_Main">$f = new HTML::WebMake::Main({ ... })</a></strong><br />
</dt>
<dd>
Constructs a new <code>HTML::WebMake::Main</code> object. You may pass the following
attribute-value pairs to the constructor.
<dl>
</dd>
<dt>
<strong><a name="item_force_output">force_output</a></strong><br />
</dt>
<dd>
Force output. Normally if a file is already up to date, it is not modified.
This will force the file to be re-made.
</dd>
<dt>
<strong><a name="item_force_cache_rebuild">force_cache_rebuild</a></strong><br />
</dt>
<dd>
Force the cached metadata and dependency data for the site to be rebuilt.
Normally this is used to speed up partial rebuilds of the site. This
option implies <a href="#item_force_output"><code>force_output</code></a>.
</dd>
<dt>
<strong><a name="item_risky_fast_rebuild">risky_fast_rebuild</a></strong><br />
</dt>
<dd>
Run more quickly, but take more risks. Normally, dynamic content, such as Perl
sections, sitemaps, or navigation links, are always considered to be in need of
rebuilding, as mapping their dependencies is often very difficult or
impossible. This switch forces them to be ignored for dependency-tracking
purposes, and so an output file that depends on them will not be rebuilt unless
a normal content item on that page changes.
</dd>
<dt>
<strong><a name="item_base_href">base_href</a></strong><br />
</dt>
<dd>
Rewrite links to be absolute URLs based at this URL. By default, links are
specified as relative wherever possible.
</dd>
<dt>
<strong><a name="item_base_dir">base_dir</a></strong><br />
</dt>
<dd>
Generate output, and look for support files (images etc.), relative to this
directory.
</dd>
<dt>
<strong><a name="item_paranoid">paranoid</a></strong><br />
</dt>
<dd>
Paranoid mode; do not allow perl code evaluation or accesses to directories
above the WebMake file.
</dd>
<dt>
<strong><a name="item_debug">debug</a></strong><br />
</dt>
<dd>
Debug mode; more output.
</dd>
</dl>
</dd>
<dt>
<strong><a name="item_set_option">$f->set_option ($optname, $optval);</a></strong><br />
</dt>
<dd>
Set a WebMake option. Currently supported options are:
</dd>
<dt>
<strong><a name="item_readfile">$f->readfile ($filename)</a></strong><br />
</dt>
<dd>
Read and parse the given WebMake file.
</dd>
<dt>
<strong><a name="item_readstring">$f->readstring ($string)</a></strong><br />
</dt>
<dd>
Read and parse the given WebMake configuration (as a string).
</dd>
<dt>
<strong><a name="item_get_content">$str = $f->get_content ($name);</a></strong><br />
</dt>
<dd>
Get the item of content named <code>$name</code>. Equivalent to a $ {content_reference},
and equivalent to the same method in <code>HTML::WebMake::PerlCodeLibrary</code>.
</dd>
<dt>
<strong><a name="item_make">$f->make (@fnames)</a></strong><br />
</dt>
<dd>
Make either the files named by $fnames (or all outputs if $fname is not
supplied), based on the WebMake files read earlier.
</dd>
<dt>
<strong><a name="item_make_to_string">$pagetext = $f->make_to_string ($fname)</a></strong><br />
</dt>
<dd>
Make the file named by $fname, and output its text to STDOUT, based on the
WebMake files read earlier.
</dd>
<dt>
<strong><a name="item_can_build">$ok = $f->can_build($fname);</a></strong><br />
</dt>
<dd>
Returns 1 if WebMake can build the named file, 0 otherwise.
</dd>
<dt>
<strong><a name="item_finish">$num_failures = $f->finish();</a></strong><br />
</dt>
<dd>
Finish with a WebMake object and dispose of its internal open files etc.
Returns the number of serious failure conditions that occurred (files that
could not be created, etc.).
</dd>
</dl>
<hr />
<h1><a name="more documentation">MORE DOCUMENTATION</a></h1><p>
See also <a href="http://webmake.taint.org/">http://webmake.taint.org/</a> for more information.
</p>
<hr />
<h1><a name="see also">SEE ALSO</a></h1><p>
<code>webmake</code> <code>ettext2html</code> <code>ethtml2text</code> <code>HTML::WebMake</code> <code>Text::EtText::EtText2HTML</code> <code>Text::EtText::EtHTML2Text</code>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1><p>
Justin Mason <jm /at/ jmason.org>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1><p>
WebMake is distributed under the terms of the GNU Public License.
</p>
<hr />
<h1><a name="availability">AVAILABILITY</a></h1><p>
The latest version of this library is likely to be available from CPAN
as well as:
</p>
<pre>
<a href="http://webmake.taint.org/">http://webmake.taint.org/</A></pre>
</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
<table width="100%">
<tr>
<td valign="top">
<strong><a href="http://webmake.taint.org/">WebMake</a>
Documentation</strong> (version 2.3)
</td>
<td valign="top">
<div align="right">
[ <a href="Content.pm.html">Back</a> | <a href="PerlCodeLibrary.pm.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In One</a> ]
</div>
</td>
</tr>
</table>
<div align="right">
<a href="http://webmake.taint.org/"> <img src="images/BuiltWithWebMake.png" alt="Built With WebMake" border="0" width="88" height="31" /></a>
</div>
</font>
</body>
</html>
