<?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: The <out> Tag
</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="for.html">Back</a> | <a href="sitemap.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>The <out> Tag</h1><p>
The <out> tag is used to generate output. Surprise!
</p>
<p>
It has one required attribute -- <em>file</em>, which defines the output file
generated by this section. In addition it has some optional attributes, as
follows:
</p>
<dl>
<dt>
<em>name</em>
</dt>
<dd>
<p>
which is used to substitute in that section's URL address, by
inserting it in other sections or out tags in a <a href="url_refs.html">URL reference</a>, like
so: $(out_foo) .
</p>
</dd>
</dl>
<p>
More optional attributes are as follows. These ones also pick up defaults
from the <a href="attrdefault.html"><attrdefault></a> tag.
</p>
<dl>
<dt>
<em>format</em>
</dt>
<dd>
which defines the format the output is expected in
(MIME-style). The default is <strong>text/html</strong>.
</dd>
<dt>
<em>clean</em>
</dt>
<dd>
specifies which features of the <a href="cleaner.html">HTML cleaner</a>
to use. The <a href="cleaner.html">HTML cleaner</a> is a powerful filter which can polish grotty,
messy HTML into fully-standards-compliant glory. The default value
is <strong>all</strong>.
</dd>
<dt>
<em>ismainurl</em>
</dt>
<dd>
<p>
Whether this output file should be used as a "main
URL" for any content items used within it, to support <a href="wmmeta.html">the <em>url</em> magic
metadatum</a>. If you plan to have multiple output styles for
your content, be sure to set "ismainurl=false" on the pages which use
"alternative" styles. The default value is <strong>true</strong>.
</p>
</dd>
</dl>
<p>
Perl code can also access out URLs using the <a href="PerlCodeLibrary.pm.html"><code>get_url()</code></a> function.
</p>
<p>
The production of multiple out files that are more-or-less identical can be
automated using the <a href="for.html"><for></a> tag.
</p>
<a name="Output_and_Dependencies" id="Output_and_Dependencies"><h3>Output and Dependencies</h3></a><p>
Out files will not be generated if the resulting text has not changed from the
previous run, or if the content sections it depends on have not changed.
</p>
<p>
The latter functionality is accomplished by caching the modification dates of
each file from which content was read to generate the output file. If:
</p>
<ol type="1">
<li>
the output file exists,
</li>
<li>
none of the files are newer than they were last time the output
file was written,
</li>
<li>
none of them are newer than the output file itself, and
</li>
<li>
none of the content items contain dynamic content, such as Perl
code or sitemaps,
</li>
</ol>
<p>
then it does not need to be rebuilt.
</p>
<blockquote>
<em>Note:</em> the <code>-r</code> switch to webmake, or the <code>risky_fast_rebuild</code>
option to the <code>HTML::WebMake::Main</code> constructor, indicates that
WebMake can take some risks when rebuilding. If this is on, then
step 4. from the list above is ignored.
</blockquote>
<a name="Example" id="Example"><h2>Example</h2></a><p>
<!--etsafe-->
<pre>
<out name="index" file="index.html">
${header}
${index_text}
${footer}
</out>
</pre><!--/etsafe-->
</p>
</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="for.html">Back</a> | <a href="sitemap.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>
