forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r1068306 [18/22] - in /forrest/site: docs_0_100/ docs_0_100/howto/ docs_0_100/howto/cvs-ssh/ docs_0_100/howto/multi/ docs_0_100/images/ pluginDocs/plugins_0_100/ trash/ trash/docs_0_50/ trash/docs_0_70/
Date Tue, 08 Feb 2011 09:44:48 GMT
Added: forrest/site/docs_0_100/sitemap-ref.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/sitemap-ref.html?rev=1068306&view=auto
==============================================================================
--- forrest/site/docs_0_100/sitemap-ref.html (added)
+++ forrest/site/docs_0_100/sitemap-ref.html Tue Feb  8 09:44:46 2011
@@ -0,0 +1,1497 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.10-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Forrest Sitemap Reference (v0.10-dev)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache Software Foundation</a> &gt; <a href="http://forrest.apache.org/">Apache Forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="unselected" href="../contrib.html">Developers</a>
+</li>
+<li class="current">
+<a class="selected" href="../versions/index.html">Versioned Docs</a>
+</li>
+<li>
+<a class="unselected" href="../pluginDocs/index.html">Plugins</a>
+</li>
+<li>
+<a class="unselected" href="../tools/index.html">Tools</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs">
+<a class="unselected" href="../docs_0_90/index.html">0.90 (current)</a><a class="selected" href="../docs_0_100/index.html">0.100-dev (under development)</a><a class="unselected" href="../docs_0_80/index.html">0.80 (past)</a>
+</div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">0.100-dev</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../docs_0_100/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/your-project.html">Using Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">How-To</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.2', '../skin/')" id="menu_1.1.3.2Title" class="menutitle">Install Forrest</div>
+<div id="menu_1.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/build.html" title="Build and install the current                     unreleased version">Building Forrest from Source</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/upgrading_010.html">Upgrading to 0.10-dev</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.4', '../skin/')" id="menu_1.1.3.4Title" class="menutitle">Customize Forrest</div>
+<div id="menu_1.1.3.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/sitemap-explain.html">Sitemaps explained</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-custom-html-source.html">Custom html source</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-pdf-tab.html" title="Generate one pdf-document for all pages of a tab">Create tab PDF</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-corner-images.html">CSS corner SVG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.5', '../skin/')" id="menu_1.1.3.5Title" class="menutitle">Integrate Forrest with tools</div>
+<div id="menu_1.1.3.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-forrest-from-maven.html">Maven Integration</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/catalog.html">Using DTD Catalogs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.6', '../skin/')" id="menu_1.1.3.6Title" class="menutitle">Extend Forrest</div>
+<div id="menu_1.1.3.6" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-buildPlugin.html">Build a Plugin</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/skin-package.html">Package new Skins</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.8', '../skin/')" id="menu_1.1.3.8Title" class="menutitle">Adding Documentation</div>
+<div id="menu_1.1.3.8" class="menuitemgroup">
+<div class="menuitem">
+<a href="../howto-howto.html" title="Instructions for writing                 a new howto-document">Write a How-to</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.8.2', '../skin/')" id="menu_1.1.3.8.2Title" class="menutitle">Multipage HowTo</div>
+<div id="menu_1.1.3.8.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/howto-multi.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step1.html">Step 1</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step2.html">Step 2</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step3.html">Step 3</a>
+</div>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.5', '../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Background</div>
+<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../docs_0_100/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/searching.html">Search Options in Forrest</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/locationmap.html">Locationmap</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/properties.html">Properties system</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Sitemap Reference</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/skins.html" title="About default skins, their naming and features">Skins</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/status-themes.html">Dispatcher versus Skins</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/cap.html">Sourcetype Action</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/validation.html">XML validation and entity resolution</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/glossary.html">Glossary</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.8', '../skin/')" id="menu_1.1.8Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.8" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.8.1', '../skin/')" id="menu_1.1.8.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.8.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../dtdx/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.8.2', '../skin/')" id="menu_1.1.8.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.8.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../dtdx/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.9', '../skin/')" id="menu_1.1.9Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/dreams.html">Dream list</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+        This is documentation for development version v0.10-dev
+       (<a href="http://forrest.apache.org/versions/">More</a>)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2">
+<a href="http://www.apache.org/events/current-event.html"><img border="0" title="ApacheCon" alt="ApacheCon - logo" src="http://www.apache.org/events/current-event-125x125.png" style="width: 125px;height: 125px;"></a>
+</div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div class="trail">Font size: 
+	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">      
+	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Forrest Sitemap Reference</h1>
+<div id="front-matter">
+<div id="motd-area">
+        This is documentation for development version v0.10-dev
+       (<a href="http://forrest.apache.org/versions/">More</a>)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#getting_started">Getting started</a>
+</li>
+<li>
+<a href="#overview">Sitemap Overview</a>
+</li>
+<li>
+<a href="#source_pipelines">Source pipelines (**.xml)</a>
+<ul class="minitoc">
+<li>
+<a href="#forrest_xmap">forrest.xmap</a>
+</li>
+<li>
+<a href="#other_source">Other source pipelines</a>
+<ul class="minitoc">
+<li>
+<a href="#late_binding_pipelines">Late-binding pipelines</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#output_pipelines">Output pipelines</a>
+<ul class="minitoc">
+<li>
+<a href="#pdf">PDF output</a>
+</li>
+<li>
+<a href="#html">HTML output</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#intermediate_pipelines">Intermediate pipelines</a>
+<ul class="minitoc">
+<li>
+<a href="#body_pipeline">Page body</a>
+</li>
+<li>
+<a href="#menu_pipeline">Page menu</a>
+</li>
+<li>
+<a href="#tab_pipeline">Page tabs</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#resolvingResources">Resolving Resources</a>
+</li>
+<li>
+<a href="#menu_generation_impl">Menu XML generation</a>
+</li>
+<li>
+<a href="#linkrewriting_impl">Link rewriting</a>
+<ul class="minitoc">
+<li>
+<a href="#input_modules">Cocoon foundations: Input Modules</a>
+</li>
+<li>
+<a href="#implement_rewriting">Implementing "site:" rewriting</a>
+<ul class="minitoc">
+<li>
+<a href="#cocoon_xconf">cocoon.xconf</a>
+</li>
+<li>
+<a href="#sitemap">sitemap.xmap</a>
+</li>
+<li>
+<a href="#dynamic_linkmap">Dynamically generating a linkmap</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+    
+<p>
+      Technically, Forrest can be thought of as a
+      <a href="http://cocoon.apache.org/2.1/">Cocoon</a> distribution that has been stripped
+      down and optimized for people with simple site publishing needs. Central
+      to Cocoon, and hence Forrest, is the <strong>sitemap</strong>. The sitemap
+      defines the site's URI space (what pages are available), and how each page
+      is constructed. Understanding the sitemap is the key to understanding
+      Forrest.
+    </p>
+    
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+      We advise you to spend time to understand the Apache Cocoon sitemap. See
+      <a href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon sitemap</a> and
+      <a href="http://cocoon.apache.org/2.1/userdocs/concepts/">Cocoon concepts</a> and related
+      component documentation. It is also necessary to understand the "**" and
+      "*" pattern matching and replacements. See the email thread: "Re: explain
+      sitemap matches and pass parameters to transformers"
+      <a href="http://issues.apache.org/jira/browse/FOR-874">FOR-874</a>.
+    </div>
+</div>
+    
+<p>
+      This document provides an overview of the special sitemap which is used at
+      the core of Apache Forrest.
+    </p>
+    
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+      The example sitemap fragments might be out-of-date because since this
+      document was written, the core sitemaps in main/webapp/ have changed and
+      some of the specialised processing has moved to plugins. View your source
+      sitemaps when reading this document. (See
+      <a href="https://issues.apache.org/jira/browse/FOR-922">FOR-922</a>.)
+    </div>
+</div>
+    
+<a name="getting_started"></a>
+<h2 class="underlined_10">Getting started</h2>
+<div class="section">
+<p>
+        Forrest's sitemap comprises the multiple
+        $FORREST_HOME/main/webapp/*.xmap files. The main one is
+        <strong>sitemap.xmap</strong> which delegates to others, including to
+        sitemaps in the various
+        <a href="../pluginDocs/plugins_0_100/pluginInfrastructure.html">plugins</a>.
+      </p>
+<p>
+        You can add pre-processing sitemaps to your project
+        <span class="codefrag">src/documentation</span> directory (or wherever
+        <span class="codefrag">${project.sitemap-dir}</span> points to). Any match that is not
+        handled, passes through to be handled by the default Forrest sitemaps -
+        obviously extremely powerful. The capability is described in
+        "<a href="../docs_0_100/project-sitemap.html">Using project sitemaps</a>".
+      </p>
+<p>
+        Another way to experiment with the sitemap is to do '<span class="codefrag">forrest
+        run</span>' on a Forrest-using site. Making changes to the core
+        <span class="codefrag">*.xmap</span> files will now be immediately effective at
+        <span class="codefrag">http://localhost:8888/</span>
+      
+</p>
+</div>
+    
+<a name="overview"></a>
+<h2 class="underlined_10">Sitemap Overview</h2>
+<div class="section">
+<p>
+        Forrest's sitemap is divided both physically and logically. The most
+        obvious is the physical separation. There are a number of separate
+        *.xmap files, each defining pipelines for a functional area. Each *.xmap
+        file has its purpose documented in comments at the top. Here is a brief
+        overview of the files, in order of importance.
+      </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+        
+<tr>
+          
+<th colspan="1" rowspan="1"><strong>sitemap.xmap</strong>
+          </th>
+          <td colspan="1" rowspan="1">Primary sitemap file, which delegates responsibility for serving
+            certain URIs to the others (technically called sub-sitemaps).  More
+            about the structure of this file later.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">forrest.xmap</th>
+          <td colspan="1" rowspan="1">Sitemap defining Source pipelines, which generate the body section
+            of Forrest pages. All pipelines here deliver XML in Forrest's
+            intermediate "document-v13" format, regardless of originating source
+            or format.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">menu.xmap</th>
+          <td colspan="1" rowspan="1">Pipelines defining the XML that becomes the menu.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">linkmap.xmap</th>
+          <td colspan="1" rowspan="1">Defines a mapping from abstract ("site:index") to physical
+            ("index.html") links for the current page.  See 
+            <a href="../docs_0_100/linking.html">Menus and Linking</a> for a conceptual
+            overview, and the <a href="#linkrewriting_impl">Link
+              rewriting</a> section for technical details.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">resources.xmap</th>
+          <td colspan="1" rowspan="1">Serves "resource" files (images, CSS, Javascript).</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">raw.xmap</th>
+          <td colspan="1" rowspan="1">Serves files located in <span class="codefrag">src/documentation/content/xdocs</span>
+            that are not to be modified by Forrest.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">plugins.xmap</th>
+          <td colspan="1" rowspan="1">Provides access to the plugins descriptor files.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">aggregate.xmap</th>
+          <td colspan="1" rowspan="1">Generates a single page (HTML or PDF) containing all the content
+            for the site.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">faq.xmap</th>
+          <td colspan="1" rowspan="1">Processes FAQ documents.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">status.xmap</th>
+          <td colspan="1" rowspan="1">Generates <a href="../docs_0_100/changes.html">changes</a> and 
+          <a href="../todo.html">todo</a> pages from a single
+            <span class="codefrag">status.xml</span> in the project root.
+          </td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">issues.xmap</th>
+          <td colspan="1" rowspan="1">Generates a page of content from an RSS feed.  Used in Forrest to
+            generate a "current issues" list from JIRA.</td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">revisions.xmap</th>
+          <td colspan="1" rowspan="1">
+            Support for HOWTO documents that want "revisions".  Revisions are
+            XML snippets containing comments on the main XML file.  The main
+            pipeline here automatically appends a page's revisions to the
+            bottom.
+          </td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">dtd.xmap</th>
+          <td colspan="1" rowspan="1">A Source pipeline that generates XML from a DTD, using Andy
+            Clark's 
+            <a href="http://www.apache.org/~andyc/neko/doc/dtd/index.html">DTD
+              Parser</a>.  Useful for documenting DTD-based XML schemas, such
+            as <a href="../docs_0_100/../dtdx/dtd-docs.html">Forrest's own DTDs</a>.
+          </td>
+        
+</tr>
+        
+<tr>
+          
+<th colspan="1" rowspan="1">profiler.xmap</th>
+          <td colspan="1" rowspan="1">Defines the "profiler" pipeline. allowing pipelines to be benchmarked.</td>
+        
+</tr>
+      
+</table>
+</div>
+<!--
+    <section>
+      <title>Logical structure</title>
+      <p>There are a few major groups of sitemap pipelines</p>
+      <dl>
+        <dt>Content pipelines</dt>
+        <dd>These define the body (without menu and header) for HTML pages, and all the content of PDFs.</dd>
+        <dt>Menu pileines.
+      </dl>
+    </section>
+    -->
+    
+<a name="source_pipelines"></a>
+<h2 class="underlined_10">Source pipelines (**.xml)</h2>
+<div class="section">
+<p>
+        Most *.xmap files (forrest, aggregate, faq, status, issues, revisions,
+        dtd) define Source pipelines. Source pipelines define the content (body)
+        XML for site pages. The input XML format can be any format
+        (document-v13, Docbook, RSS, FAQ, Howto) and from any source (local or
+        remote). The output format is always Forrest's intermediate
+        "document-v13" format.
+      </p>
+<p>
+        Source pipelines always have a "<span class="codefrag">.xml</span>" extension. Thus,
+        <a href="index.xml">index.xml</a> gives you the XML source for the
+        index page. Likewise, <a href="faq.xml">faq.xml</a> gives you XML
+        for the FAQ (transformed from FAQ syntax), and
+        <a href="changes.xml">changes.xml</a> returns XML from the
+        status.xml file. Take any page, and replace its extension
+        (<span class="codefrag">.html</span> or <span class="codefrag">.pdf</span>) with <span class="codefrag">.xml</span> and
+        you'll have the Source XML.
+      </p>
+<p>
+        This is quite powerful, because we now have an abstraction layer, or
+        "virtual filesystem", on which the rest of Forrest's sitemap can build.
+        Subsequent layers don't need to care whether the XML was obtained
+        locally or remotely, or from what format. Wikis, RSS, FAQs and Docbook
+        files are all processed identically from here on.
+      </p>
+<pre class="code">
+                   (subsequent Forrest pipelines)
+                                 |
+--------+------------------------^------------------------------------------
+        |          STANDARD FORREST FORMAT (current document-v13)
+        +-----^-------^--------^------------^------^-----^-----^------^-----
+SOURCE        |       |        |            |      |     |     |      |
+FORMATS    doc-v11  doc-v13  doc-v20 ... Docbook  FAQ  Howto  Wiki  RSS  ??
+(*.xml)
+                        (in forrest.xmap, faq.xmap, etc)
+      </pre>
+<a name="forrest_xmap"></a>
+<h3 class="underlined_5">forrest.xmap</h3>
+<p>
+          Most of the usual Source pipelines are defined in
+          <span class="codefrag">forrest.xmap</span> which is the default (fallback) handler for
+          <span class="codefrag">**.xml</span> pages. The forrest.xmap uses the
+          <a href="../docs_0_100/cap.html">SourceTypeAction</a> to determine the type of
+          XML it is processing, and converts it to document-v13 if necessary.
+        </p>
+<p>
+          For instance, say we are rendering <a href="../howto-howto.html">a
+          Howto document</a> called "howto-howto.xml". It contains this
+          DOCTYPE declaration:
+        </p>
+<pre class="code">
+&lt;!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.3//EN"
+  "http://forrest.apache.org/dtd/howto-v13.dtd"&gt;</pre>
+<p>
+          The SourceTypeAction sees this, and applies this transform to get it
+          to document-v13:
+        </p>
+<pre class="code">
+
+          &lt;map:when test="howto-v13"&gt;
+            &lt;map:transform src="{forrest:forrest.stylesheets}/howto-to-document.xsl" /&gt;
+          &lt;/map:when&gt;
+          
+        </pre>
+<a name="other_source"></a>
+<h3 class="underlined_5">Other source pipelines</h3>
+<p>
+          As mentioned above, all non-core Source pipelines are distributed in
+          independent <span class="codefrag">*.xmap</span> files. There is a block of
+          <span class="codefrag">sitemap.xmap</span> which simply delegates certain requests to
+          these subsitemaps:
+        </p>
+<pre class="code">
+
+&lt;!-- Body content --&gt;
+      &lt;map:match pattern="**.xml"&gt;
+        &lt;map:match pattern="locationmap.xml"&gt;
+          &lt;map:generate src="{forrest:forrest.locationmap}" /&gt;
+          &lt;map:serialize type="xml"/&gt;
+        &lt;/map:match&gt;
+        &lt;map:match pattern="plugins.xml"&gt;
+          &lt;map:mount uri-prefix="" src="plugins.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+        &lt;map:match pattern="pluginDocs/plugins_(.*)/index(|\.source).xml" type="regexp"&gt;
+          &lt;map:mount uri-prefix="" src="plugins.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+        &lt;map:match pattern="linkmap.*"&gt;
+          &lt;map:mount uri-prefix="" src="linkmap.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+        &lt;map:match pattern="**faq.xml"&gt;
+          &lt;map:mount uri-prefix="" src="faq.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+        &lt;map:match pattern="community/**index.xml"&gt;
+          &lt;map:mount uri-prefix="" src="forrest.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;        ....
+        ....
+        </pre>
+<a name="late_binding_pipelines"></a>
+<h4>Late-binding pipelines</h4>
+<p>
+            One point of interest here is that the sub-sitemap is often not
+            specific about which URLs it handles, and relies on the caller (the
+            section listed above) to only pass relevant requests to it. We term
+            this "binding a URL" to a pipeline.
+          </p>
+<p>
+            For instance, the main pipeline in <span class="codefrag">faq.xmap</span> matches
+            <span class="codefrag">**.xml</span>, but only <span class="codefrag">**faq.xml</span> requests are
+            sent to it.
+          </p>
+<p>
+            This "late binding" is useful, because the whole URL space is
+            managed in <span class="codefrag">sitemap.xmap</span> and not spread over lots of
+            *.xmap files. For instance, say you wish all <span class="codefrag">*.xml</span>
+            inside a "<span class="codefrag">faq/</span>" directory to be processed as FAQs. Just
+            override <span class="codefrag">sitemap.xmap</span> and redefine the relevant source
+            matcher:
+          </p>
+<pre class="code">
+
+        &lt;map:match pattern="**faq.xml"&gt;
+          &lt;map:mount uri-prefix="" src="faq.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+          </pre>
+</div>
+    
+<a name="output_pipelines"></a>
+<h2 class="underlined_10">Output pipelines</h2>
+<div class="section">
+<p>
+        To recap, we now have a <span class="codefrag">*.xml</span> pipeline defined for each
+        page in the site, emitting standardized XML. These pipeline definitions
+        are located in various *.xmap files, notably forrest.xmap
+      </p>
+<p>
+        We now wish to render the XML from these pipelines to output formats
+        like HTML and PDF.
+      </p>
+<a name="pdf"></a>
+<h3 class="underlined_5">PDF output</h3>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+          PDF is now generated via the org.apache.forrest.plugin.output.pdf
+          plugin.
+        </div>
+</div>
+<p>
+          Easiest case first; PDFs don't require menus or headers, so we can
+          simply transform our intermediate format into XSL:FO, and from there
+          to PDF. This is done by the following matches in
+          <span class="codefrag">output.xmap</span> from the pdf plugin ...
+        </p>
+<pre class="code">
+
+        &lt;!-- Match requests for XSL:FO documents --&gt;
+        &lt;map:match type="regexp" pattern="^(.*?)([^/]*).fo$"&gt;
+            &lt;map:select type="exists"&gt;
+                &lt;map:when test="{lm:project.{1}{2}.fo}"&gt;
+                    &lt;map:generate src="{lm:project.{1}{2}.fo}"/&gt;
+                &lt;/map:when&gt;
+                &lt;map:otherwise&gt;
+                    &lt;map:aggregate element="site"&gt;
+                        &lt;map:part src="cocoon://module.properties.properties"/&gt;
+                        &lt;map:part src="cocoon://skinconf.xml"/&gt;
+                        &lt;map:part src="cocoon://{1}{2}.xml"/&gt;
+                    &lt;/map:aggregate&gt;
+                    &lt;map:transform type="xinclude"/&gt;
+                    &lt;map:transform type="<a href="#linkrewriting_impl">linkrewriter</a>" src="cocoon://{1}linkmap-{2}.fo"/&gt;
+                    &lt;map:transform src="{lm:pdf.transform.document.fo}"&gt;
+                        &lt;map:parameter name="imagesdir"  value="{properties:resources.images}/"/&gt;
+                        &lt;map:parameter name="xmlbasedir" value="{properties:content.xdocs}{1}"/&gt;
+                        &lt;map:parameter name="path"       value="{1}"/&gt;
+                    &lt;/map:transform&gt;
+                &lt;/map:otherwise&gt;
+            &lt;/map:select&gt;
+            &lt;map:serialize type="xml"/&gt;
+        &lt;/map:match&gt;
+
+        </pre>
+<p>
+          This section of the pipeline matches requests for XSL:FO
+          documents by using a regular expression match to break the
+          request into directory (.*?) and filename ([^/]*) parts. If
+          the XSL:FO document exists in the project (the
+          <span class="codefrag">exists</span> selector), it is used; otherwise, the
+          XSL:FO is generated:
+        </p>
+<ol>
+          
+<li>
+            The properties input module, skinconf and the <a href="#source_pipelines">source document</a> are
+            combined into an aggregate
+          </li>
+          
+<li>
+            XInclude elements are processed
+          </li>
+          
+<li>
+            Links are rewritten
+          </li>
+          
+<li>
+            The source as generated from the preceding steps is
+            transformed by the stylesheet with the locationmap hint
+            <span class="codefrag">pdf.transform.document.fo</span> and serialized as
+            the final XSL:FO document
+          </li>
+        
+</ol>
+<pre class="code">
+
+        &lt;!-- Match requests for PDF documents --&gt;
+        &lt;map:match type="regexp" pattern="^(.*?)([^/]*).pdf$"&gt;
+            &lt;map:select type="exists"&gt;
+                &lt;map:when test="{lm:project.{1}{2}.pdf}"&gt;
+                    &lt;map:read src="{lm:project.{1}{2}.pdf}"/&gt;
+                &lt;/map:when&gt;
+                &lt;map:when test="{lm:project.{1}{2}.fo}"&gt;
+                    &lt;map:generate src="{lm:project.{1}{2}.fo}"/&gt;
+                    &lt;map:transform type="i18n"&gt;
+                      &lt;map:parameter name="locale" value="{../locale}"/&gt;
+                    &lt;/map:transform&gt;
+                    &lt;map:serialize type="fo2pdf"/&gt;
+                &lt;/map:when&gt;
+                &lt;map:otherwise&gt;
+                    &lt;map:generate src="cocoon://{1}{2}.fo"/&gt;
+                    &lt;map:transform type="i18n"&gt;
+                      &lt;map:parameter name="locale" value="{../locale}"/&gt;
+                    &lt;/map:transform&gt;
+                    &lt;map:serialize type="fo2pdf"/&gt;
+                &lt;/map:otherwise&gt;
+            &lt;/map:select&gt;
+        &lt;/map:match&gt;
+
+        </pre>
+<p>
+          This next section of the pipeline matches requests for PDF
+          documents in a manner similar to the previous match for
+          XSL:FO documents. If the PDF document exists in the project,
+          it is passed directly to the client. If the XSL:FO document
+          exists for the requested PDF, the XSL:FO is serialized by
+          the fo2pdf serializer and passed to the client as PDF (after
+          i18n is handled by the i18n transformer). When neither PDF
+          nor XSL:FO exists, XSL:FO is generated by the match
+          described above, i18n elements are processed for the current
+          locale, and the result is serialized as PDF.
+        </p>
+<a name="html"></a>
+<h3 class="underlined_5">HTML output</h3>
+<p>
+          Generating HTML pages is more complicated, because we have to merge
+          the page body with a menu and tabs, and then add a header and footer.
+          Here is the <span class="codefrag">*.html</span> matcher in <span class="codefrag">sitemap.xmap</span>
+          ...
+        </p>
+<pre class="code">
+          
+          1   &lt;map:match pattern="*.html"&gt;
+          2     &lt;map:aggregate element="site"&gt;
+          3       &lt;map:part src="cocoon:/skinconf.xml"/&gt;
+          4       &lt;map:part src="cocoon:/build-info"/&gt;
+          5       &lt;map:part src="<a href="#tab_pipeline">cocoon:/tab-{0}</a>"/&gt;
+          6       &lt;map:part src="<a href="#menu_pipeline">cocoon:/menu-{0}</a>"/&gt;
+          7       &lt;map:part src="<a href="#body_pipeline">cocoon:/body-{0}</a>"/&gt;
+          8     &lt;/map:aggregate&gt;
+          9     &lt;map:call resource="skinit"&gt;
+          10      &lt;map:parameter name="type" value="transform.site.xhtml"/&gt;
+          11      &lt;map:parameter name="path" value="{0}"/&gt;
+          12    &lt;/map:call&gt;
+          13  &lt;/map:match&gt;
+          
+        </pre>
+<p>
+          So <a href="index.html">index.html</a> is formed by
+          aggregating <span class="codefrag">skinconf.xml</span>,
+          <span class="codefrag">build-info</span>, <a href="body-index.html">body-index.html</a> and <a href="menu-index.html">menu-index.html</a> and <a href="tab-index.html">tab-index.html</a> and then
+          applying the <span class="codefrag">site-to-xhtml.xsl</span> stylesheet to
+          the result.
+        </p>
+<p>
+          The conversion from <span class="codefrag">transform.site.xhtml</span> to
+          <span class="codefrag">site-to-xhtml.xsl</span> (line 10 above) is handled by
+          the locationmap in this fragment from
+          <span class="codefrag">locationmap-transforms.xml</span>:
+        </p>
+<pre class="code">
+          
+          &lt;match pattern="transform.*.*"&gt;
+            &lt;select&gt;
+              &lt;location src="{properties:skins-dir}{forrest:forrest.skin}/xslt/html/{1}-to-{2}.xsl" /&gt;
+              &lt;location src="{forrest:forrest.context}/skins/{forrest:forrest.skin}/xslt/html/{1}-to-{2}.xsl"/&gt;
+              &lt;location src="{forrest:forrest.context}/skins/common/xslt/html/{1}-to-{2}.xsl"/&gt;
+              &lt;location src="{forrest:forrest.stylesheets}/{1}-to-{2}.xsl"/&gt;
+            &lt;/select&gt;
+          &lt;/match&gt;
+          
+        </pre>
+<p>
+          There is a nearly identical matcher for HTML files in subdirectories:
+        </p>
+<pre class="code">
+          
+          &lt;map:match pattern="**/*.html"&gt;
+            &lt;map:aggregate element="site"&gt;
+              &lt;map:part src="cocoon:/skinconf.xml"/&gt;
+              &lt;map:part src="cocoon:/build-info"/&gt;
+              &lt;map:part src="<a href="#tab_pipeline">cocoon:/{1}/tab-{2}.html</a>"/&gt;
+              &lt;map:part src="<a href="#menu_pipeline">cocoon:/{1}/menu-{2}.html</a>"/&gt;
+              &lt;map:part src="<a href="#body_pipeline">cocoon:/{1}/body-{2}.html</a>"/&gt;
+            &lt;/map:aggregate&gt;
+            &lt;map:call resource="skinit"&gt;
+              &lt;map:parameter name="type" value="transform.site.xhtml"/&gt;
+              &lt;map:parameter name="path" value="{0}"/&gt;
+            &lt;/map:call&gt;
+          &lt;/map:match&gt;
+          
+        </pre>
+</div>
+    
+<a name="intermediate_pipelines"></a>
+<h2 class="underlined_10">Intermediate pipelines</h2>
+<div class="section">
+<a name="body_pipeline"></a>
+<h3 class="underlined_5">Page body</h3>
+<p>
+          Here is the matcher which generates the page body:
+        </p>
+<pre class="code">
+          
+          1   &lt;map:match pattern="**body-*.html"&gt;
+          2     &lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;
+          3     &lt;map:transform type="idgen"/&gt;
+          4     &lt;map:transform src="{lm:transform.xml.xml-xpointer-attributes}"/&gt;
+          5     &lt;map:transform type="xinclude"/&gt;
+          6     &lt;map:transform type="<a href="#linkrewriting_impl">linkrewriter</a>" src="cocoon:/{1}linkmap-{2}.html"/&gt;
+          7     &lt;map:transform src="{lm:transform.html.broken-links}" /&gt;
+          8     &lt;map:call resource="skinit"&gt;
+          9       &lt;map:parameter name="type" value="transform.xdoc.html"/&gt;
+          10      &lt;map:parameter name="path" value="{1}{2}.html"/&gt;
+          11      &lt;map:parameter name="notoc" value="false"/&gt;
+          12    &lt;/map:call&gt;
+          13  &lt;/map:match&gt;
+          
+        </pre>
+<ol>
+          
+<li>In our matcher pattern, {1} will be the directory (if any) and {2}
+            will be the filename.</li>
+          
+<li>First, we obtain XML content from a source pipeline</li>
+          
+<li>
+<p>
+              We then apply a custom-written
+              <span class="codefrag">IdGeneratorTransformer</span>, which ensures that every
+              &lt;section&gt; has an "id" attribute if one is not supplied, by
+              generating one from the &lt;title&gt; if necessary. For example,
+              &lt;idgen&gt; will transform:
+            </p>
+            
+<pre class="code">
+              &lt;section&gt;
+              &lt;title&gt;How to boil eggs&lt;/title&gt;
+              ...
+            </pre>
+            
+<p>
+              into:
+            </p>
+            
+<pre class="code">
+              &lt;section id="How+to+boil+eggs"&gt;
+              &lt;title&gt;How to boil eggs&lt;/title&gt;
+              ...
+            </pre>
+            
+<p>
+              Later, the <span class="codefrag">document-to-html.xsl</span> stylesheet
+              will create an &lt;a name&gt; element for every section,
+              allowing this section to be referred to as
+              <span class="codefrag">index.html#How+to+boil+eggs</span>. <span class="codefrag">document-to-html.xsl</span>
+              is looked up by the key <span class="codefrag">transform.xdoc.html</span>
+              in the locationmap in line 9 above. See
+              <span class="codefrag">locationmap-transforms.xml</span> for this match.
+            </p>
+          
+</li>
+          
+<li>We then expand XInclude elements.</li>
+          
+<li>and <a href="#linkrewriting_impl">rewrite links</a>..</li>
+          
+<li>and then finally apply the stylesheet that generates a fragment of
+            HTML (minus the outer elements like
+            &lt;html&gt; and &lt;body&gt;) suitable for merging with the menu and tabs.</li>
+        
+</ol>
+<a name="menu_pipeline"></a>
+<h3 class="underlined_5">Page menu</h3>
+<p>
+          In the <span class="codefrag">sitemap.xmap</span> file, the matcher generating HTML for
+          the menu is:
+        </p>
+<pre class="code">
+          
+          1   &lt;map:match pattern="**menu-*.html"&gt;
+          2     &lt;map:generate src="cocoon:/{1}book-{2}.html"/&gt;
+          3     &lt;map:transform type="<a href="#linkrewriting_impl">linkrewriter</a>" src="cocoon:/{1}linkmap-{2}.html"/&gt;
+          4     &lt;map:transform src="{lm:transform.html.broken-links}" /&gt;
+          5     &lt;map:call resource="skinit"&gt;
+          6       &lt;map:parameter name="type" value="transform.book.menu"/&gt;
+          7       &lt;map:parameter name="path" value="{1}{2}.html"/&gt;
+          8     &lt;/map:call&gt;
+          9     &lt;map:serialize type="xml"/&gt;
+          10  &lt;/map:match&gt;
+          
+        </pre>
+<p>
+          We get XML from a "book" pipeline,
+          <a href="#linkrewriting_impl">rewrite links</a>, and apply the
+          <span class="codefrag">book-to-menu.xsl</span> stylesheet to generate HTML.
+        </p>
+<p>
+          How the menu XML is actually generated (the *book-*.html pipeline) is
+          sufficiently complex to require a
+          <a href="#menu_generation_impl">section of its own</a>.
+        </p>
+<a name="tab_pipeline"></a>
+<h3 class="underlined_5">Page tabs</h3>
+<pre class="code">
+          
+          &lt;map:match pattern="**tab-*.html"&gt;
+            &lt;map:mount uri-prefix="" src="tabs.xmap" check-reload="yes" /&gt;
+          &lt;/map:match&gt;
+          
+        </pre>
+<p>
+          And the match from <span class="codefrag">tabs.xmap</span>:
+        </p>
+<pre class="code">
+          
+          1   &lt;map:match pattern="**tab-*.html"&gt;
+          2     &lt;map:generate src="{lm:project.tabs.xml}"/&gt;
+          3     &lt;map:transform type="xinclude"/&gt;
+          4     &lt;map:select type="config"&gt;
+          5       &lt;map:parameter name="value" value="{properties:forrest.i18n}"/&gt;
+          6       &lt;map:when test="true"&gt;
+          7         &lt;map:act type="locale"&gt;
+          8           &lt;map:transform src="{lm:transform.book.book-i18n}"/&gt;
+          9           &lt;map:transform type="i18n"&gt;
+          10            &lt;map:parameter name="locale" value="{locale}"/&gt;
+          11          &lt;/map:transform&gt;
+          12        &lt;/map:act&gt;
+          13      &lt;/map:when&gt;
+          14    &lt;/map:select&gt;
+          15    &lt;map:transform type="<a href="#linkrewriting_impl">linkrewriter</a>" src="cocoon:/{1}linkmap-{2}.html"/&gt;
+          16    &lt;map:call resource="skinit"&gt;
+          17      &lt;map:parameter name="type" value="transform.tab.menu"/&gt;
+          18      &lt;map:parameter name="path" value="{1}{2}.html"/&gt;
+          19    &lt;/map:call&gt;
+          20  &lt;/map:match&gt;
+          
+        </pre>
+<p>
+          All the smarts are in the <span class="codefrag">tab-to-menu.xsl</span>
+          stylesheet (resolved by the locationmap in line 17), which
+          needs to choose the correct tab based on the current path.
+          Currently, a "longest matching path" algorithm is
+          implemented. See the <span class="codefrag">tab-to-menu.xsl</span> stylesheet
+          for details.
+        </p>
+</div>
+    
+<a name="resolvingResources"></a>
+<h2 class="underlined_10">Resolving Resources</h2>
+<div class="section">
+<p>
+        Many resources are resolved by the locationmap. This allow us to provide
+        many alternative locations for a file without cluttering up the sitemap
+        with multiple processing paths. We use a strict naming convention to
+        help make the sitemaps more readable. This is described in the
+        <a href="../docs_0_100/locationmap.html#namingConvention">Locationmap</a>
+        documentation.
+      </p>
+</div>
+    
+<a name="menu_generation_impl"></a>
+<h2 class="underlined_10">Menu XML generation</h2>
+<div class="section">
+<p>
+        The "book" pipeline is defined in <span class="codefrag">sitemap.xmap</span> as:
+      </p>
+<pre class="code">
+        
+        &lt;map:match pattern="**book-*.html"&gt;
+          &lt;map:mount uri-prefix="" src="menu.xmap" check-reload="yes" /&gt;
+        &lt;/map:match&gt;
+        
+      </pre>
+<p>
+        Meaning that it is defined in the <span class="codefrag">menu.xmap</span> file. In there
+        we find the real definition, which is quite complicated, because there
+        are three supported menu systems (see <a href="../docs_0_100/linking.html">menus
+        and linking</a>). We will not go through the sitemap itself
+        (menu.xmap), but will instead describe the logical steps involved:
+      </p>
+<ol>
+        
+<li>Take site.xml and expand hrefs so that they are all
+          root-relative.</li>
+        
+<li>
+<p>
+            Depending on the <span class="codefrag">forrest.menu-scheme</span> property, we now
+            apply one of the two algorithms for choosing a set of menu links
+            (described in <a href="../docs_0_100/linking.html#menu_generation">menu
+            generation</a>):
+          </p>
+          
+<ul>
+            
+<li>
+<p>
+                For "@tab" menu generation, we first ensure each site.xml node
+                has a tab attribute (inherited from a parent if necessary), and
+                then pass through nodes whose tab attribute matches that of the
+                "current" node.
+              </p>
+              
+<p>
+                For example, say our current page's path is
+                <span class="codefrag">community/howto/index.html</span>. In
+                <span class="codefrag">site.xml</span> we look for the node with this
+                "<span class="codefrag">href</span>" and discover its "<span class="codefrag">tab</span>"
+                attribute value is "<span class="codefrag">howtos</span>". We then prune the
+                <span class="codefrag">site.xml</span>-derived content to contain only nodes with
+                <span class="codefrag">tab="howtos"</span>.
+              </p>
+              
+<p>
+                All this is done with XSLT, so the sitemap snippet does not
+                reveal this complexity:
+              </p>
+              
+<pre class="code">
+    
+    &lt;map:transform src="resources/stylesheets/site-to-site-normalizetabs.xsl" /&gt;
+    &lt;map:transform src="resources/stylesheets/site-to-site-selectnode.xsl"&gt;
+      &lt;map:parameter name="path" value="{1}{2}"/&gt;
+    &lt;/map:transform&gt;
+    
+              </pre>
+</li>
+            
+<li>
+<p>
+                For "directory" menu generation, we simply use an
+                <span class="codefrag">XPathTransformer</span> to include only pages in the
+                current page's directory, or below:
+              </p>
+              
+<pre class="code">
+
+&lt;map:transform type="xpath"&gt;
+  &lt;map:parameter name="include" value="//*[@href='{1}']" /&gt;
+&lt;/map:transform&gt;
+                
+              </pre>
+              
+<p>
+                Here, the "<span class="codefrag">{1}</span>" is the directory part of the
+                current page. So if our current page is
+                <span class="codefrag">community/howto/index.html</span> then "<span class="codefrag">{1}</span>"
+                will be <span class="codefrag">community/howto/</span> and the transformer will
+                include all nodes in that directory.
+              </p>
+</li>
+          
+</ul>
+          
+<p>
+            We now have a <span class="codefrag">site.xml</span> subset relevant to our current
+            page.
+          </p>
+</li>
+        
+<li>The "<span class="codefrag">href</span>" nodes in this are then made relative to the
+          current page.</li>
+        
+<li>The XML is then transformed into a legacy "<span class="codefrag">book.xml</span>"
+          format, for compatibility with existing stylesheets, and this XML
+          format is returned (hence the name of the matcher:
+          <span class="codefrag">**book-*.html</span>).</li>
+      
+</ol>
+</div>
+    
+<a name="linkrewriting_impl"></a>
+<h2 class="underlined_10">Link rewriting</h2>
+<div class="section">
+<p>
+        In numerous places in <span class="codefrag">sitemap.xmap</span> you will see the
+        "linkrewriter" transformer in action. For example:
+      </p>
+<pre class="code">
+&lt;map:transform type="linkrewriter" src="cocoon:/{1}linkmap-{2}.html"/&gt;
+      </pre>
+<p>
+        This statement is Cocoon's linking system in action. A full description
+        is provided in <a href="../docs_0_100/linking.html">Menus and Linking</a>. Here
+        we describe the implementation of linking.
+      </p>
+<a name="input_modules"></a>
+<h3 class="underlined_5">Cocoon foundations: Input Modules</h3>
+<p>
+          The implementation of <span class="codefrag">site:</span> linking is heavily based on
+          Cocoon <a href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html">Input Modules</a>, a
+          little-known but quite powerful aspect of Cocoon. Input Modules are
+          generic Components which simply allow you to look up a value with a
+          key. The value is generally dynamically generated, or obtained by
+          querying an underlying data source.
+        </p>
+<p>
+          In particular, Cocoon contains an <span class="codefrag">XMLFileModule</span>, which
+          lets one look up the value of an XML node, by interpreting the key as
+          an XPath expression. Cocoon also has a
+          <span class="codefrag">SimpleMappingMetaModule</span>, which allows the key to be
+          rewritten before it is used to look up a value.
+        </p>
+<p>
+          The idea for putting these together to rewrite "<span class="codefrag">site:</span>"
+          links was described in <a href="http://marc.theaimsgroup.com/?t=103992708800001&amp;r=1&amp;w=2">this
+          thread</a>. The idea is to write a Cocoon Transformer that triggers
+          on encountering &lt;link href="<span class="codefrag">scheme:address</span>"&gt;, and
+          interprets the <span class="codefrag">scheme:address</span> internal URI as
+          <span class="codefrag">inputmodule:key</span>. The transformer then uses the named
+          InputModule to look up the key value. The <span class="codefrag">scheme:address</span>
+          URI is then rewritten with the found value. This transformer was
+          implemented as
+          <a href="http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/transformation/LinkRewriterTransformer.html">LinkRewriterTransformer</a>,
+          currently distributed as a "block" in Cocoon 2.1
+          (see <a href="http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/transformation/LinkRewriterTransformer.html">API docs</a>).
+        </p>
+<a name="implement_rewriting"></a>
+<h3 class="underlined_5">Implementing "site:" rewriting</h3>
+<p>
+          Using the above components, "<span class="codefrag">site:</span>" URI rewriting is
+          accomplished as follows.
+        </p>
+<a name="cocoon_xconf"></a>
+<h4>cocoon.xconf</h4>
+<p>
+            First, we declare all the input modules we will be needing:
+          </p>
+<pre class="code">
+
+&lt;!-- For the site: scheme --&gt;
+&lt;component-instance
+  class="org.apache.cocoon.components.modules.input.XMLFileModule"
+  logger="core.modules.xml" name="linkmap"/&gt;
+
+&lt;!-- Links to URIs within the site --&gt;
+&lt;component-instance
+  class="org.apache.cocoon.components.modules.input.SimpleMappingMetaModule"
+  logger="core.modules.mapper" name="site"/&gt;
+
+&lt;!-- Links to external URIs, as distinct from 'site' URIs --&gt;
+&lt;component-instance
+  class="org.apache.cocoon.components.modules.input.SimpleMappingMetaModule"
+  logger="core.modules.mapper" name="ext"/&gt;
+
+          </pre>
+<ul>
+            
+<li>
+<strong>linkmap</strong> will provide access to the contents of
+              <span class="codefrag">site.xml</span>; for example, <span class="codefrag">linkmap:/site/about/index/@href</span>
+              would return the value "index.html".</li>
+            
+<li>
+<strong>site</strong> provides a "mask" over
+              <strong>linkmap</strong> such that <span class="codefrag">site:index</span> expands
+              to <span class="codefrag">linkmap:/site//index/@href</span>
+</li>
+            
+<li>
+<strong>ext</strong> provides another "mask" over
+              <strong>linkmap</strong>, such that <span class="codefrag">ext:ant</span> would
+              expand to <span class="codefrag">linkmap:/site/external-refs//ant/@href</span>
+</li>
+          
+</ul>
+<p>
+            However at the moment, we have only declared the input modules. They
+            will be configured in <span class="codefrag">sitemap.xmap</span> as described in the
+            next section.
+          </p>
+<a name="sitemap"></a>
+<h4>sitemap.xmap</h4>
+<p>
+            Now in the sitemap, we define the LinkRewriterTransformer, and
+            insert it into any pipelines which deal with user-editable XML
+            content:
+          </p>
+<pre class="code">
+
+....
+&lt;!-- Rewrites links, e.g. transforming
+     href="site:index" to href="../index.html"
+--&gt;
+&lt;map:transformer name="linkrewriter"
+  logger="sitemap.transformer.linkrewriter"
+  src="org.apache.cocoon.transformation.LinkRewriterTransformer"&gt;
+  &lt;link-attrs&gt;href src&lt;/link-attrs&gt;
+  &lt;schemes&gt;site ext&lt;/schemes&gt;
+
+  &lt;input-module name="site"&gt;
+    &lt;input-module name="linkmap"&gt;
+      &lt;file src="{src}" reloadable="false" /&gt;
+    &lt;/input-module&gt;
+    &lt;prefix&gt;/site//&lt;/prefix&gt;
+    &lt;suffix&gt;/@href&lt;/suffix&gt;
+  &lt;/input-module&gt;
+  &lt;input-module name="ext"&gt;
+    &lt;input-module name="linkmap"&gt;
+      &lt;file src="{src}" reloadable="false" /&gt;
+    &lt;/input-module&gt;
+    &lt;prefix&gt;/site/external-refs//&lt;/prefix&gt;
+    &lt;suffix&gt;/@href&lt;/suffix&gt;
+  &lt;/input-module&gt;
+&lt;/map:transformer&gt;
+....
+....
+&lt;map:match pattern="**body-*.html"&gt;
+  &lt;map:generate src="cocoon:/{1}{2}.xml"/&gt;
+  &lt;map:transform type="idgen"/&gt;
+  &lt;map:transform type="xinclude"/&gt;
+  &lt;map:transform type="linkrewriter" src="cocoon:/{1}linkmap-{2}.html"/&gt;
+  ...
+&lt;/map:match&gt;
+          </pre>
+<p>
+            As you can see, our three input modules are configured as part of
+            the LinkRewriterTransformer's configuration.
+          </p>
+<ul>
+            
+<li>
+<p>
+                Most deeply nested, we have:
+              </p>
+              
+<pre class="code">
+
+                &lt;input-module name="linkmap"&gt;
+                  &lt;file src="{src}" reloadable="false" /&gt;
+              &lt;/input-module&gt;
+              </pre>
+              
+<p>
+                The "<span class="codefrag">{src}</span>" text is expanded to the value of the
+                "<span class="codefrag">src</span>" attribute in the "<span class="codefrag">linkrewriter</span>"
+                instance, namely "<span class="codefrag">cocoon:/{1}linkmap-{2}.html</span>" Thus
+                the <span class="codefrag">linkmap</span> module reads dynamically generated XML
+                specific to the current request.
+              </p>
+</li>
+            
+<li>
+<p>
+                One level out, we configure the "<span class="codefrag">site</span>" and
+                "<span class="codefrag">ext</span>" input modules, to map onto our dynamically
+                configured "<span class="codefrag">linkmap</span>" module.
+              </p>
+</li>
+            
+<li>
+<p>
+                Then at the outermost level, we configure the
+                "<span class="codefrag">linkrewriter</span>" transformer. First we tell it which
+                attributes to consider rewriting:
+              </p>
+              
+<pre class="code">
+
+                &lt;link-attrs&gt;href src&lt;/link-attrs&gt;
+                &lt;schemes&gt;site ext&lt;/schemes&gt;
+              </pre>
+              
+<p>
+                So, "<span class="codefrag">href</span>" and "<span class="codefrag">src</span>" attributes
+                starting with "<span class="codefrag">site:</span>" or "<span class="codefrag">ext:</span>" are
+                rewritten.
+              </p>
+              
+<p>
+                By nesting the "<span class="codefrag">site</span>" and "<span class="codefrag">ext</span>" input
+                modules in the "<span class="codefrag">linkrewriter</span>" configuration, we
+                tell "<span class="codefrag">linkrewriter</span>" to use these two input modules
+                when rewriting links.
+              </p>
+</li>
+          
+</ul>
+<p>
+            The end result is that, for example, the source XML for the
+            <span class="codefrag">community/body-index.html</span> page has its links rewritten
+            by an XMLFileModule reading XML from
+            <span class="codefrag">cocoon:/community/linkmap-index.html</span>
+          
+</p>
+<a name="dynamic_linkmap"></a>
+<h4>Dynamically generating a linkmap</h4>
+<p>
+            Why do we need this "linkmap" pipeline generating dynamic XML from
+            <span class="codefrag">site.xml</span>, instead of just using <span class="codefrag">site.xml</span> directly? The reasons are described
+            in <a href="http://marc.theaimsgroup.com/?l=forrest-dev&amp;m=103444028129281&amp;w=2">the linkmap RT</a>: we need to
+            concatenate @hrefs and add dot-dots to the paths, depending on which
+            directory the linkee is in. This is done with the following
+            pipelines in <span class="codefrag">linkmap.xmap</span> ...
+          </p>
+<pre class="code">
+
+&lt;!-- site.xml with @href's appended to be context-relative. --&gt;
+&lt;map:match pattern="abs-linkmap"&gt;
+  &lt;map:generate src="content/xdocs/site.xml" /&gt;
+  &lt;map:transform src="resources/stylesheets/absolutize-linkmap.xsl" /&gt;
+  &lt;map:serialize type="xml" /&gt;
+&lt;/map:match&gt;
+
+&lt;!-- Linkmap for regular pages --&gt;
+&lt;map:match pattern="**linkmap-*"&gt;
+  &lt;map:generate src="cocoon://abs-linkmap" /&gt;
+  &lt;map:transform src="resources/stylesheets/relativize-linkmap.xsl"&gt;
+    &lt;map:parameter name="path" value="{1}{2}" /&gt;
+    &lt;map:parameter name="site-root" value="{conf:project-url}" /&gt;
+  &lt;/map:transform&gt;
+  &lt;map:serialize type="xml" /&gt;
+&lt;/map:match&gt;
+            
+          </pre>
+<p>
+            You can try these URIs out directly on a live Forrest to see what is
+            going on (for example, Forrest's own
+            <a href="../abs-linkmap">abs-linkmap</a>).
+          </p>
+</div>
+  
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2002-2011 <a href="http://www.apache.org/licenses/">The Apache Software Foundation. Licensed under Apache License 2.0</a>
+<br>
+    Apache Forrest, Forrest, Apache, the Apache feather logo, and the Apache Forrest
+    logos are trademarks of The Apache Software Foundation.
+  </div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Propchange: forrest/site/docs_0_100/sitemap-ref.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/site/docs_0_100/skin-package.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/skin-package.html?rev=1068306&view=auto
==============================================================================
--- forrest/site/docs_0_100/skin-package.html (added)
+++ forrest/site/docs_0_100/skin-package.html Tue Feb  8 09:44:46 2011
@@ -0,0 +1,404 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.10-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Skin packaging, provision, and use (v0.10-dev)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache Software Foundation</a> &gt; <a href="http://forrest.apache.org/">Apache Forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="unselected" href="../contrib.html">Developers</a>
+</li>
+<li class="current">
+<a class="selected" href="../versions/index.html">Versioned Docs</a>
+</li>
+<li>
+<a class="unselected" href="../pluginDocs/index.html">Plugins</a>
+</li>
+<li>
+<a class="unselected" href="../tools/index.html">Tools</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs">
+<a class="unselected" href="../docs_0_90/index.html">0.90 (current)</a><a class="selected" href="../docs_0_100/index.html">0.100-dev (under development)</a><a class="unselected" href="../docs_0_80/index.html">0.80 (past)</a>
+</div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">0.100-dev</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../docs_0_100/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/your-project.html">Using Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.3', '../skin/')" id="menu_selected_1.1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">How-To</div>
+<div id="menu_selected_1.1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../docs_0_100/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.2', '../skin/')" id="menu_1.1.3.2Title" class="menutitle">Install Forrest</div>
+<div id="menu_1.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/build.html" title="Build and install the current                     unreleased version">Building Forrest from Source</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/upgrading_010.html">Upgrading to 0.10-dev</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.4', '../skin/')" id="menu_1.1.3.4Title" class="menutitle">Customize Forrest</div>
+<div id="menu_1.1.3.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/sitemap-explain.html">Sitemaps explained</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-custom-html-source.html">Custom html source</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-pdf-tab.html" title="Generate one pdf-document for all pages of a tab">Create tab PDF</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-corner-images.html">CSS corner SVG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.5', '../skin/')" id="menu_1.1.3.5Title" class="menutitle">Integrate Forrest with tools</div>
+<div id="menu_1.1.3.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-forrest-from-maven.html">Maven Integration</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/catalog.html">Using DTD Catalogs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.3.6', '../skin/')" id="menu_selected_1.1.3.6Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Extend Forrest</div>
+<div id="menu_selected_1.1.3.6" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-buildPlugin.html">Build a Plugin</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Package new Skins</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.8', '../skin/')" id="menu_1.1.3.8Title" class="menutitle">Adding Documentation</div>
+<div id="menu_1.1.3.8" class="menuitemgroup">
+<div class="menuitem">
+<a href="../howto-howto.html" title="Instructions for writing                 a new howto-document">Write a How-to</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.8.2', '../skin/')" id="menu_1.1.3.8.2Title" class="menutitle">Multipage HowTo</div>
+<div id="menu_1.1.3.8.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/howto-multi.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step1.html">Step 1</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step2.html">Step 2</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/multi/step3.html">Step 3</a>
+</div>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Background</div>
+<div id="menu_1.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/searching.html">Search Options in Forrest</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/locationmap.html">Locationmap</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/properties.html">Properties system</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/skins.html" title="About default skins, their naming and features">Skins</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/status-themes.html">Dispatcher versus Skins</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/cap.html">Sourcetype Action</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/validation.html">XML validation and entity resolution</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/glossary.html">Glossary</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.8', '../skin/')" id="menu_1.1.8Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.8" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.8.1', '../skin/')" id="menu_1.1.8.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.8.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../dtdx/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.8.2', '../skin/')" id="menu_1.1.8.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.8.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../dtdx/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a href="../dtdx/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.9', '../skin/')" id="menu_1.1.9Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../docs_0_100/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/dreams.html">Dream list</a>
+</div>
+<div class="menuitem">
+<a href="../docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+        This is documentation for development version v0.10-dev
+       (<a href="http://forrest.apache.org/versions/">More</a>)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2">
+<a href="http://www.apache.org/events/current-event.html"><img border="0" title="ApacheCon" alt="ApacheCon - logo" src="http://www.apache.org/events/current-event-125x125.png" style="width: 125px;height: 125px;"></a>
+</div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div class="trail">Font size: 
+	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">      
+	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Skin packaging, provision, and use</h1>
+<h3>Automated distributed skin packages</h3>
+<div id="front-matter">
+<div id="motd-area">
+        This is documentation for development version v0.10-dev
+       (<a href="http://forrest.apache.org/versions/">More</a>)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#overview">Overview</a>
+</li>
+<li>
+<a href="#notes">Notes</a>
+</li>
+</ul>
+</div>
+</div>
+    
+<a name="overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>
+        Skins are standard zip archives with a *.zip extension. This enables
+        them to be unpacked and installed automatically.
+      </p>
+<p>
+        To publish a skin:
+      </p>
+<pre class="code">
+1 - forrest package-skin
+The skin package will be made in the skin dir, next to the custom skin.
+2 - place the file in a directory on a web server
+3 - ask forrest-dev to add the url and the skin name to the list of skins
+</pre>
+<p>
+        To use a custom skin with automatic download:
+      </p>
+<pre class="code">
+1 - set the skin property in forrest.properties to the name of the skin
+2 - forrest install-skin
+3 - forrest
+</pre>
+<p>
+        Currently there are two test skins: "testskin" and "testskin2"
+      </p>
+<p>
+        To see the names of the remote skins:
+      </p>
+<pre class="code">forrest available-skins</pre>
+</div>
+    
+<a name="notes"></a>
+<h2 class="underlined_10">Notes</h2>
+<div class="section">
+<p>
+        The skin will get blown away by the next 'build clean' in forrest. But
+        that is okay because it is so quick to go get another copy. Also it may
+        be preferable to get a fresh copy. If the user wanted to keep the skin
+        and perhaps enhance it, then they can copy it to their project.
+      </p>
+</div>
+  
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2002-2011 <a href="http://www.apache.org/licenses/">The Apache Software Foundation. Licensed under Apache License 2.0</a>
+<br>
+    Apache Forrest, Forrest, Apache, the Apache feather logo, and the Apache Forrest
+    logos are trademarks of The Apache Software Foundation.
+  </div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Propchange: forrest/site/docs_0_100/skin-package.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message