<?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 <navlinks> 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="sitemap.html">Back</a> | <a href="breadcrumbs.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 <navlinks> Tag</h1><p>
A common site structure strategy is to provide <em>Back</em>, <em>Forward</em> and
<em>Up</em> links between pages. This is especially frequent in papers or
manuals, and (as you can see above) is used in this documentation.
WebMake supports this using the <<a href="navlinks.html">navlinks</a>> tag.
</p>
<p>
To use this, first define a <a href="sitemap.html">sitemap</a>. This tells WebMake how to order the page
hierarchy, and which pages to include.
</p>
<p>
Next, define 3 templates, one for <em>previous</em>, one for <em>next</em> and one
for <em>up</em> links. These should contain references to <strong>${url}</strong>
(note: <em>not</em> <strong>$(url)</strong>), which will be replaced with the URL for
the next, previous, or parent content item, whichever is applicable for the
direction in question.
</p>
<p>
Also, references to <strong>${name}</strong> will be expanded to the name of the
content item in that direction, allowing you to retrieve <a href="metadata.html">metadata</a> for that
content like so: <strong>$[${name}.title]</strong> .
</p>
<p>
You can also add templates to be used when there is no <em>previous</em>,
<em>next</em> or <em>up</em> content item; for example, the "top" page of a site has
no <em>up</em> content item. These are strictly optional though.
</p>
<p>
Then add a <strong><<a href="navlinks.html">navlinks</a>></strong> tag to the WebMake file as follows.
</p>
<p>
<pre>
<navlinks name=<em>mynavlinks</em> map=<em>sitemapname</em>
up=<em>uptemplatename</em>
next=<em>nexttemplatename</em>
prev=<em>prevtemplatename</em>
noup=<em>nouptemplatename</em>
nonext=<em>nonexttemplatename</em>
noprev=<em>noprevtemplatename</em>>
<em>content text</em>
</navlinks>
</pre>
</p>
<p>
The content text acts just like a normal content item, but references to
<strong>${nexttext}</strong>, <strong>${prevtext}</strong> or <strong>${uptext}</strong>
will be replaced with the appropriate template; e.g. <strong>${uptext}</strong>
will be replaced by either <strong>${<em>uptemplatename</em>}</strong> or
<strong>${<em>nouptemplatename</em>}</strong> depending on if this is the top page or
not.
</p>
<p>
You can then add references to <strong>$[<em>mynavlinks</em>]</strong> in
other content items, and the navigation links will be inserted.
</p>
<blockquote>
<em>Note:</em> <a href="navlinks.html">navlinks</a> content items <em>must</em> be included as a deferred
reference!
</blockquote>
<a name="Attribute_Reference" id="Attribute_Reference"><h1>Attribute Reference</h1></a><p>
These are the attributes accepted by the <strong><<a href="navlinks.html">navlinks</a>></strong> tag.
</p>
<dl>
<dt>
<em>name</em>
</dt>
<dd>
the name of the navigation-links content item.
Required.
</dd>
<dt>
<em>map</em>
</dt>
<dd>
the name of the <a href="sitemap.html">sitemap</a> used to determine page
ordering. Required.
</dd>
<dt>
<em>up</em>
</dt>
<dd>
the name of the template used to draw <em>Up</em>
links. Required.
</dd>
<dt>
<em>next</em>
</dt>
<dd>
the name of the template used to draw <em>Next</em>
links. Required.
</dd>
<dt>
<em>prev</em>
</dt>
<dd>
the name of the template used to draw <em>Prev</em>
links. Required.
</dd>
<dt>
<em>noup</em>
</dt>
<dd>
the name of the template used when there is
no <em>Up</em> link, ie. for the page at the top level of the
site. Optional -- the default is an empty string.
</dd>
<dt>
<em>nonext</em>
</dt>
<dd>
the name of the template used when there is
no <em>Next</em> link, ie. the last page in the site.
Optional -- the default is an empty string.
</dd>
<dt>
<em>noprev</em>
</dt>
<dd>
<p>
the name of the template used when there is
no <em>Prev</em> link, ie. for the first page in the site.
Optional -- the default is an empty string.
</p>
</dd>
</dl>
<a name="Example" id="Example"><h2>Example</h2></a><p>
This will generate an extremely simple set of <a href> links, no frills.
The <a href="sitemap.html">sitemap</a> it uses isn't detailed here; see the <a href="sitemap.html">sitemap documentation</a> for details on how to make a site map.
</p>
<p>
<pre>
<template name=up><a href=${url}>Up</a></template>
<template name=next><a href=${url}>Next</a></template>
<template name=prev><a href=${url}>Prev</a></template>
<navlinks name=<em>name</em> map=<em>sitemapname</em> up=up next=next prev=prev>
${prevtext} | ${uptext} | ${nexttext}
</navlinks>
</pre>
</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="sitemap.html">Back</a> | <a href="breadcrumbs.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>
