Contents

• Introduction

  • The Blurb - What it is, and what it does

  • Concepts - Concepts behind WebMake's design

  • WebMake Operation - what happens when you run WebMake

  • How to Migrate to WebMake - how to write a WebMake file

  • Invoking Webmake - how to run WebMake

  • WebMake as a CMS - WebMake's content-management features, and shortcomings

  • Tips On Using WebMake - Some tips on using WebMake

  • Contributors to WebMake - Contributors to WebMake

• Tags and Their Attributes

  • The <webmake> Tag - the webmake section

  • The <include> Tag - include another file into the current WebMake file

  • The <use> Tag - use a WebMake plugin

  • The <content> Tag - one chunk of textual content

  • The <template> Tag - non-text content, such as HTML templates

  • The <contenttable> Tag - Define several small content items quickly, using a table

  • The <contents> Tag - load many chunks of content from one data source

  • The <templates> Tag - load many chunks of non-text content, such as HTML templates, from a data source

  • The <media> Tag - load many URLs from one data source

  • Data Sources - the protocols supported by <contents>, <templates> and <media>

  • The <for> Tag - iteration construct

  • The <out> Tag - an output file and URL

  • The <sitemap> Tag - generate a site map

  • The <navlinks> Tag - generate back and forward navigation links

  • The <breadcrumbs> Tag - generate a ''breadcrumb trail'' navigational aid

  • The <cache> Tag - tell WebMake where to keep its cache files

  • The <option> Tag - set options controlling WebMake behaviour

  • The <action> Tag - hook code into WebMake logic

  • Defining Tags - defining tags for use in content items

• Processing Logic

  • The Order of Processing - the order of processing

  • The <{set}> Directive - set a content chunk while inside another content chunk's scope

  • The <{perl}> Directives - embed arbitrary perl logic

  • Sorting Lists of Content Items - how, and where, it is done

  • Globs and Regexps - glob patterns, regular expressions and pattern matching

  • Scraped Templates - How to use scrape_xml() to generate multiple templates from a single HTML file

• Variable References

  • ${content_refs} - References to Content Chunks - references to content chunks

  • $(url_refs) - References to URLs - references to URLs

  • $[deferred_content refs] - Deferred Content References - deferred references to content chunks

• Meta Tags and Meta-Data

  • Metadata - meta-data for content items, and how to use it

  • The <wmmeta> Tag - defining meta-data inside the tagged content object

  • The <metatable> Tag - Attach metadata to another content item

  • The <metadefault> Tag - Specify default metadata to attach to content

  • The <attrdefault> Tag - Specify default attributes for content items

  • The <metaset> and <usemetaset> Tags - Define your own metadata names

• Magic Variables

  • The ${IMGSIZE} Magic Variable - automatically add image size information to an <img> tag

  • The $(TOP/) Magic Variable - a relative path to the top-level of the site, for URLs

  • The ${WebMake.*} Magic Variables - information about the environment WebMake is run in, such as the version of WebMake, the timestamp, the user who ran it, etc.

• Format Converters

  • The Text::EtText Format Converter - A simple plain-text format, easily converted to HTML (format: text/et)

  • The POD Format Converter - Perl ''plain old documentation'' support (format: text/pod)

  • The HTML Cleaner - the HTML cleaning filter

• Using WebMake.cgi

  • Using webmake.cgi - How to use WebMake as a CGI script

  • Installing webmake.cgi - How to install the WebMake CGI script in your web server

  • Setting up CVS and ssh for webmake.cgi HOWTO - A step-by-step guide to setting up version-control for your WebMake site

  • Using webmake.cgi - How to navigate and use the ''edit-in-browser'' interface

• Module Documentation

  • HTML::WebMake::Content - module documentation

  • HTML::WebMake::Main - module documentation

  • HTML::WebMake::PerlCodeLibrary - module documentation

• Manual Pages

  • webmake(1) - manual page

• Plugins and Libraries

  • csvtable_tag.wmk - define a HTML table using comma-separated values

  • download_tag.wmk - Tag for quick download links to files

  • dump_vars.wmk - dump all WebMake variables and content items

  • editbuttons.wmk - ''Edit'' buttons on rendered output

  • lang_tag.wmk - allow WebMake to support multi-language output

  • navtree.wmk - WebMake tag to generate an alternative per-page sitemap

  • rssbox.wmk - include RSS feeds into your documents

  • safe_tag.wmk - Tag to ''make safe'' WebMake, EtText or HTML data

  • sitetree.wmk - WebMake tag to generate a per-page sitemap

  • thumbnail_tag.wmk - Tag to create ''thumbnail'' links for photo albums

  • wwwtable_tag.wmk - easier HTML table generation using ''freetable''

  • xsl.wmk - apply an XSL stylesheet to XML data, using Sablotron