Mailing List Archive: svn commit: r1068306 [10/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

Added: forrest/site/docs_0_100/glossary.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/glossary.html?rev=1068306&view=auto
==============================================================================
--- forrest/site/docs_0_100/glossary.html (added)
+++ forrest/site/docs_0_100/glossary.html Tue Feb 8 09:44:46 2011
@@ -0,0 +1,988 @@
+<!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 Glossary (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">
+
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://forrest.apache.org/">Apache Forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+
+<div class="header">
+
+<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>
+
+
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+
+
+<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"> 
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+
+
+<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>
+
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+
+<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>
+
+<script type="text/javascript"></script>
+</div>
+
+<div class="breadtrail">
+
+  
+ </div>
+
+
+<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_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="menupage">
+<div class="menupagetitle">Glossary</div>
+</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>
+
+<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>
+
+
+<div id="content">
+<div class="trail">Font size:
+  <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+  <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+  <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Forrest Glossary</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="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#a">A</a>
+</li>
+<li>
+<a href="#c">C</a>
+</li>
+<li>
+<a href="#d">D</a>
+</li>
+<li>
+<a href="#g">G</a>
+</li>
+<li>
+<a href="#i">I</a>
+</li>
+<li>
+<a href="#l">L</a>
+</li>
+<li>
+<a href="#p">P</a>
+</li>
+<li>
+<a href="#r">R</a>
+</li>
+<li>
+<a href="#s">S</a>
+</li>
+<li>
+<a href="#t">T</a>
+</li>
+<li>
+<a href="#x">X</a>
+</li>
+</ul>
+</div>
+</div>
+<a name="Introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>
+ This is a glossary of terms and their definitions for the Apache Forrest
+ project. Some plugins also have a glossary, for example
+ <a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/dispatcher-glossary.html">Dispatcher</a>.
+ </p>
+</div>
+<a name="a"></a>
+<h2 class="underlined_10">A</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="AddContent"></a><td class="term" id="AddContent">Add content to this Glossary</td><td class="definitions">
+<p>
+ 1. This glossary is incomplete, please help where you can by adding definitions to
+ existing items where needed. Also, add new Items to the glossary as
+ appropriate.<br>
+
+</p>
+</td><td class="notes"></td>
+</tr>
+<tr>
+<a name="acronyms-mail"></a><td class="term" id="acronyms-mail">Abbreviations in electronic mail</td><td class="definitions">
+<p>
+ 1. Abbreviations and acronyms are often used as shorthand in email, e.g. AFAIK "As Far As I Know", IMO "In My Opinion".
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>See Apache Cocoon
+ <a href="http://wiki.apache.org/cocoon/AbbreviationsInMails">Abbreviations In Mails</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="ASF"></a><td class="term" id="ASF">The Apache Software Foundation (ASF)</td><td class="definitions">
+<p>
+ 1. <a href="http://apache.org/">The Apache Software Foundation</a> is the home of Apache
+ Forrest.
+ The ASF is a non-profit charity, membership-based corporation.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="http://apache.org/foundation/">Foundation website</a>
+
+</li>
+
+<li>
+
+<a href="http://apache.org/foundation/faq.html">Foundation FAQ</a>
+
+</li>
+
+<li>
+
+<a href="http://apache.org/foundation/how-it-works.html">How it works</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="c"></a>
+<h2 class="underlined_10">C</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="CSS"></a><td class="term" id="CSS">Cascading Style Sheets (CSS)</td><td class="definitions">
+<p>
+ 1. A simple mechanism for adding style (e.g. fonts, colors, spacing) to Web
+ documents. Source:
+ <a href="http://www.w3.org/Style/CSS/">W3C</a>.<br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>See
+ <a href="http://www.w3.org/Style/CSS/">W3C</a>
+
+</li>
+
+<li>See
+ <a href="http://www.csszengarden.com/">css Zen Garden</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="d"></a>
+<h2 class="underlined_10">D</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="dispatcher"></a><td class="term" id="dispatcher">Dispatcher</td><td class="definitions">
+<p>
+ 1.
+ The aim of the "Dispatcher" concept is to provide a flexible framework for
+ creating site and page specific layout.
+ See the Dispatcher documentation and the Dispatcher Glossary for specific terminology.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher plugin documentation</a>
+
+</li>
+
+<li>
+
+<a href="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/dispatcher-glossary.html">Dispatcher glossary</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_100/status-themes.html">Status of themes: Skins and Dispatcher</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="g"></a>
+<h2 class="underlined_10">G</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="generator"></a><td class="term" id="generator">Generator</td><td class="definitions">
+<p>
+ 1.
+ A Generator is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> begins with a Generator. Its job
+ is to generate XML content as SAX events and initialize the pipeline processing.
+ The default generator is the "File Generator" which reads an xml document
+ from the local file system or from any url.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="i"></a>
+<h2 class="underlined_10">I</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="internal-xml"></a><td class="term" id="internal-xml">Internal document format</td><td class="definitions">
+<p>
+ 1.
+ Forrest's <em>internal</em> document format (defined by an XML-grammar).
+ This format is the common denominator for all things going into or coming
+ out of Forrest's core processing. All input-plugins will translate their
+ supported documents into this format, all output-plugins will create the
+ output by transforming this format into something else.
+ Currently Forrest uses "xdoc" <a href="../docs_0_100/../dtdx/document-v13.dtdx.html">document-v13-dtd</a>
+ as its internal format (see definition of <a href="#xdoc">xdoc</a> below).
+ We plan to later use a set of xhtml2 as the internal format.
+ <br>
+
+</p>
+</td><td class="notes"></td>
+</tr>
+</table>
+</div>
+<a name="l"></a>
+<h2 class="underlined_10">L</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="linkmap"></a><td class="term" id="linkmap">Linkmap</td><td class="definitions">
+<p>
+ 1.
+ The "linkmap" is an internal resource that transforms the
+ <a href="#site-xml">site.xml</a> navigation and linking configuration
+ file into a table-of-contents. Every site has one at localhost:8888/linkmap.html
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+ For example, Forrest's <a href="../linkmap.html">Table of Contents</a>.
+ </li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="locationmap"></a><td class="term" id="locationmap">Locationmap</td><td class="definitions">
+<p>
+ 1.
+ Locationmaps define the mapping from requests to locations,
+ which enables content and resources to be located at various
+ different sources. The advantage of this is that the URL seen
+ by the user need bear no relation to the location of the source
+ document, thus Forrest can separate the client URL space from
+ the source document URL space. Thus, using the locationmap
+ it is possible to pull together documents from many different
+ locations into a single uniform site. In addition, since the
+ user URL space is now unconnected to the source URL space it is
+ possible to move source documents without breaking any existing
+ user links. There are various core locationmaps in the main/webapp
+ directory, each plugin can utilise locationmaps, and projects can
+ manage their resources with a project-specific locationmap.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/locationmap.html">Locationmap</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="p"></a>
+<h2 class="underlined_10">P</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="pipeline"></a><td class="term" id="pipeline">Pipeline</td><td class="definitions">
+<p>
+ 1.
+ The Cocoon <a href="#sitemap">Sitemaps</a> have one or more pipelines
+ which handle the processing of various pieces of xml content.
+ Each pipeline begins with a
+ <a href="#generator">Generator</a>, continues with zero or more
+ <a href="#transformer">Transformers</a>, and ends with a
+ <a href="#serializer">Serializer</a>.
+ Aggregation enables building a hierarchy of pipelines.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="plugins"></a><td class="term" id="plugins">Plugins</td><td class="definitions">
+<p>
+ 1.
+ A Forrest Plugin is a set of resources and configuration files that extend the functionality of Forrest.
+ Plugins are a way of extending Forrest to satisfy site-specific needs.
+ The core of Forrest handles certain processing via the
+ <a href="#sitemap">sitemaps</a> in main/webapp/*.xmap files.
+ The main sitemap mounts a plugin sitemap from each declared plugin.
+ For example an input plugin might handle projectInfo source documents
+ to convert them into the <a href="#internal-xml">internal document format</a>
+ for further processing, while an output plugin would concern itself
+ with generating output PDF documents. Nice <a href="#SoC">Separation of Concerns</a>.
+ If no plugin is found to handle a certain document type, then processing falls back to the core.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_100/index.html">Plugins index</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_100/usingPlugins.html">Extending Forrest with Plugins</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_100/pluginInfrastructure.html">Plugin infrastructure</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="r"></a>
+<h2 class="underlined_10">R</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="ReleaseCandidate"></a><td class="term" id="ReleaseCandidate">Release Candidate</td><td class="definitions">
+<p>
+ 1. A temporary Forrest package built from trunk during the <a href="../procedures/release/How_to_release.html">release process</a> to be tested and evaluated.<br>
+
+</p>
+</td><td class="notes"></td>
+</tr>
+</table>
+</div>
+<a name="s"></a>
+<h2 class="underlined_10">S</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="SoC"></a><td class="term" id="SoC">Separation of Concerns (SoC)</td><td class="definitions">
+<p>
+ 1. Different people, different skills, different purposes different code. Each can
+ concentrate on their separate, but well-integrated, area of concern.<br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+<a href="http://cocoon.apache.org/2.1/introduction.html#Separation+of+Concerns+(SoC)">
+ Introducing Apache Cocoon</a>
+
+</li>
+
+<li>
+<a href="http://excalibur.apache.org/developing/introduction.html#Separation_of_Concerns">
+ Apache Excalibur Introduction and Overview</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="serializer"></a><td class="term" id="serializer">Serializer</td><td class="definitions">
+<p>
+ 1.
+ A Serializer is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> ends with a Serializer. Its job
+ is to transform SAX events into binary or character streams for final
+ client consumption. One example (the default) is the "HTML Serializer"
+ which serializes xml content to html. The Serializer can have parameters
+ to configure its behaviour, e.g. to specify the document type declaration.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="sitemap"></a><td class="term" id="sitemap">Sitemap</td><td class="definitions">
+<p>
+ 1.
+ Cocoon Sitemaps (usually a filename ending with *.xmap)
+ is the system to enable Apache Cocoon to know how to process
+ different types of input and output.
+ Note that many other environments use the term "sitemap" to refer to
+ "a map of the site" which is what <a href="#site-xml">site.xml</a> can be considered to be.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_100/project-sitemap.html">Using project sitemaps</a>
+
+</li>
+
+<li>
+
+<a href="../pluginDocs/plugins_0_100/pluginInfrastructure.html">Plugins infrastructure</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="site-xml"></a><td class="term" id="site-xml">site.xml</td><td class="definitions">
+<p>
+ 1.
+ The site.xml is the menu navigation and linking configuration file.
+ Don't get confused with <a href="#sitemap">sitemap</a> defined above.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/linking.html">Menus and linking</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="skins"></a><td class="term" id="skins">Skins</td><td class="definitions">
+<p>
+ 1.
+ "Skins" are one method of providing alternatives for creating the
+ layout and look-and-feel of the set of documents.
+ Forrest provides one primary skin called <em>pelt</em>.
+ See the definition of <a href="#dispatcher">Dispatcher</a>
+ for another method.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/your-project.html#skins">Using Forrest: Skins</a>
+
+</li>
+
+<li>
+
+<a href="../docs_0_100/status-themes.html">Status of themes: Skins and Dispatcher</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+<tr>
+<a name="svn"></a><td class="term" id="svn">Subversion (SVN)</td><td class="definitions">
+<p>
+ 1.
+ Subversion, also known as SVN, is the version control system used by all Apache projects.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../svn.html">Version control</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="t"></a>
+<h2 class="underlined_10">T</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="transformer"></a><td class="term" id="transformer">Transformer</td><td class="definitions">
+<p>
+ 1.
+ A Transformer is a Cocoon <a href="#sitemap">sitemap</a> component.
+ Each <a href="#pipeline">pipeline</a> has zero or more Transformers. Its job
+ is to transform SAX events into other SAX events.
+ The default transformer is the "XSLT Transformer" which uses an XSLT
+ stylesheet to transform xml content. The Transformer can have parameters
+ to configure its behaviour or pass data to the stylesheet.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+
+<a href="../docs_0_100/sitemap-ref.html">Sitemap Reference</a> and the Cocoon documents linked from there.
+ </li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+<a name="x"></a>
+<h2 class="underlined_10">X</h2>
+<div class="section">
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Term</th><th>Definitions</th><th>Notes</th>
+</tr>
+<tr>
+<a name="xdoc"></a><td class="term" id="xdoc">xdoc</td><td class="definitions">
+<p>
+ 1. "xdoc" is an xml documentation stucture that started life at some other ASF
+ projects. Apache Forrest adopted it and enhanced it to be similar to xhtml2. "xdoc" is
+ currently the <a href="#internal-xml">internal xml structure</a>
+ of Forrest (someday will be xhtml2). "xdocs" can be
+ used as an input source format.
+ <br>
+
+</p>
+</td><td class="notes">
+<ul>
+
+<li>
+<a href="../docs_0_100/../dtdx/dtd-docs.html">Reference docs</a>
+
+</li>
+
+<li>
+<a href="../docs_0_100/../dtdx/document-v20.html">Sample xdoc</a>
+
+</li>
+
+</ul>
+</td>
+</tr>
+</table>
+</div>
+</div>
+
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+
+<div class="lastmodified">
+<script type="text/javascript"></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 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>
+
+</div>
+</body>
+</html>

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

Added: forrest/site/docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html?rev=1068306&view=auto
==============================================================================
--- forrest/site/docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html (added)
+++ forrest/site/docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html Tue Feb 8 09:44:46 2011
@@ -0,0 +1,479 @@
+<!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>CVS through SSH (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">
+
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://forrest.apache.org/">Apache Forrest</a><script src="../../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+
+<div class="header">
+
+<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>
+
+
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../../../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+
+
+<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"> 
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+
+
+<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>
+
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+
+<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>
+
+<script type="text/javascript"></script>
+</div>
+
+<div class="breadtrail">
+
+  
+ </div>
+
+
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../../../skin/')" id="menu_1.1Title" class="menutitle">How-To Samples</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs_0_100/howto/index.html">Overview</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../../../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Committers</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">CVS through SSH</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>
+
+<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>
+
+
+<div id="content">
+<div class="trail">Font size:
+  <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+  <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+  <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>CVS through SSH</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 class="abstract">
+ This How-To describes the steps necessary to configure an SSH enabled CVS
+ connection. It is recommended to configure an SSH enabled CVS connection
+ to work with Apache code repositories.
+ </div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Intended-audience">Intended audience</a>
+</li>
+<li>
+<a href="#Purpose">Purpose</a>
+</li>
+<li>
+<a href="#Prerequisites">Prerequisites</a>
+</li>
+<li>
+<a href="#Steps">Steps</a>
+<ul class="minitoc">
+<li>
+<a href="#Terms">Terms</a>
+</li>
+<li>
+<a href="#Setting+up+domain+users">Setting up domain users</a>
+</li>
+<li>
+<a href="#ssh_access">Setting up SSH access</a>
+</li>
+<li>
+<a href="#Setting+up+passphrase+access">Setting up passphrase access</a>
+</li>
+<li>
+<a href="#Getting+the+project+from+CVS">Getting the project from CVS</a>
+</li>
+<li>
+<a href="#How+to+setup+WinCVS">How to setup WinCVS</a>
+</li>
+<li>
+<a href="#References">References</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<a name="Intended-audience"></a>
+<h2 class="underlined_10">Intended audience</h2>
+<div class="section">
+<p>
+ This How-to is aimed at developers who have been granted committer access
+ to CVS repositories for particular projects.
+ </p>
+</div>
+<a name="Purpose"></a>
+<h2 class="underlined_10">Purpose</h2>
+<div class="section">
+<p>
+ Using SSH to access CVS repositories is recommended for security reasons.
+ By configuring CVS to work with remote repository using private/public SSH
+ keys you'll be able to run CVS commands without a need to enter your
+ password every time you need access to CVS through SSH.
+ </p>
+</div>
+<a name="Prerequisites"></a>
+<h2 class="underlined_10">Prerequisites</h2>
+<div class="section">
+<ul>
+
+<li>Account on the local machine.</li>
+
+<li>Commiter access to the project(s). <em>This also imply having account on the CVS host machine.</em>
+</li>
+
+<li>Cygwin - a Unix environment for Windows systems. You can get it <a href="http://www.redhat.com/software/tools/cygwin/">here</a>. <em>Not required for Linux/*nix users.</em>
+</li>
+
+<li>A CVS GUI application (for Windows users only), e.g. WinCVS. <em>It is not required, but can be very useful.</em>
+</li>
+
+</ul>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ If you are behind a firewall check that you can communicate through the 22
+ port. For anonymous access you will need 2401 one.
+ </div>
+</div>
+</div>
+<a name="Steps"></a>
+<h2 class="underlined_10">Steps</h2>
+<div class="section">
+<p>
+ How to proceed.
+ </p>
+<a name="Terms"></a>
+<h3 class="underlined_5">Terms</h3>
+<dl>
+
+<dt>SSH</dt>
+
+<dd>Secure Shell. See <a href="http://www.openssh.org">OpenSSH</a>
+</dd>
+
+<dt>CVS</dt>
+
+<dd>Concurrent Version System See <a href="http://www.cvshome.org">CVS Home Page</a>
+</dd>
+
+</dl>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+
+<strong>$</strong> represents local, <strong>%</strong> remote machine.
+ </div>
+</div>
+<a name="Setting+up+domain+users"></a>
+<h3 class="underlined_5">Setting up domain users</h3>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ This step is necessary only for Windows users. Linux users can happily
+ skip this section and pass to <a href="#ssh_access">Setting up SSH
+ access</a> section
+ </div>
+</div>
+<p>
+ If you are a domain user then you should be added to Cygwin users list
+ (See <span class="codefrag">[cygwin-dir]/etc/passwd</span>).
+ </p>
+<ul>
+
+<li>Start Cygwin, then enter following commands:</li>
+
+</ul>
+<pre class="code">
+$ whoami
+administrator
+$ mkgroup -d > /etc/group
+$ mkpasswd -d | grep 'userxxx' >> /etc/passwd
+$ exit
+ </pre>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ Replace 'userxxx' by your account name
+ </div>
+</div>
+<ul>
+
+<li>Start Cygwin/shell again and check that everything's Ok:</li>
+
+</ul>
+<pre class="code">
+$ whoami
+userxxx
+ </pre>
+<a name="ssh_access"></a>
+<h3 class="underlined_5">Setting up SSH access</h3>
+<p>
+ Start Cygwin/shell, then enter:
+ </p>
+<pre class="code">
+$ ssh-user-config
+ Shall I create an SSH1 RSA identity file for you? (yes/no) no
+ Shall I create an SSH2 RSA identity file for you? (yes/no) (yes/no) no
+ Shall I create an SSH2 DSA identity file for you? (yes/no) (yes/no) yes
+ Generating /home/userxxx/.ssh/id_dsa
+ Enter passphrase (empty for no passphrase):
+ Enter same passphrase again:
+ Do you want to use this identity to login to this machine? (yes/no) yes
+ Adding to /home/userxxx/.ssh/authorized_keys2
+
+ Configuration finished. Have fun!
+ </pre>
+<p>
+ Now you have configured SSH on your machine. Next you have to setup
+ access to the CVS machine.
+ </p>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+ Having an empty passphrase isn't recommended for security reasons. See
+ <span class="codefrag">ssh-agent</span> documentation on how to configure automatic
+ passphrase retaining.
+ </div>
+</div>
+<a name="Setting+up+passphrase+access"></a>
+<h3 class="underlined_5">Setting up passphrase access</h3>
+<p>
+ Perform the following:
+ </p>
+<pre class="code">
+$ scp ~/.ssh/id_dsa.pub userxxx@cvs.apache.org:.
+$ ssh -l userxxx -L 2401:localhost:2401 cvs.apache.org
+% mkdir ~/.ssh
+% chmod 700 ~/.ssh
+% cat ~/id_dsa.pub >> ~/.ssh/authorized_keys2
+% rm ~/id_dsa.pub
+% chmod 600 ~/.ssh/*
+% exit
+ </pre>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ Note, that the account name on CVS machine can differ from your local
+ account name.
+ </div>
+</div>
+<p>
+ Check that your configuration is correct:
+ </p>
+<pre class="code">
+$ ssh userxxx@cvs.apache.org
+ </pre>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ If this command doesn't work then it can mean that you have an old
+ version of SSH. In this case try <span class="codefrag">ssh -l userxxx
+ cvs.apache.org</span>. Run <span class="codefrag">ssh --help</span> to get all available
+ options.
+ </div>
+</div>
+<p>
+ If now you are logged in to the to the CVS machine without entering the
+ password then everything's Ok.
+ </p>
+<a name="Getting+the+project+from+CVS"></a>
+<h3 class="underlined_5">Getting the project from CVS</h3>
+<p>
+ Now you are ready to get a project from CVS using SSH connection.
+ </p>
+<p>
+ E.g. how it is done using Cygwin/shell
+ </p>
+<pre class="code">
+$ export CVS_RSH=/bin/ssh
+$ cvs -d :ext:userxxx@cvs.apache.org:/home/cvs co xml-cocoon2
+ </pre>
+<a name="How+to+setup+WinCVS"></a>
+<h3 class="underlined_5">How to setup WinCVS</h3>
+<ul>
+
+<li>Add ssh.exe directory to your system PATH environment variable. Say: <br>
+<span class="codefrag">C:\>set PATH=%PATH%;C:\cygwin\bin</span>
+</li>
+
+<li>Add <span class="codefrag">CVS_RSH=ssh</span> environment variable</li>
+
+</ul>
+<p>
+ Start WinCVS, then:
+ </p>
+<ul>
+
+<li>From the main menu select <strong>Admin</strong>
+</li>
+
+<li>Then select <strong>Preferences</strong>
+</li>
+
+<li>In the dialog that comes up: <br>
+ Set the CVSROOT to <span class="codefrag">userxxx@cvs.apache.org:/home/cvs</span>
+</li>
+
+<li>Set the Authentication to SSH Server</li>
+
+<li>Click Ok</li>
+
+</ul>
+<a name="References"></a>
+<h3 class="underlined_5">References</h3>
+<p>
+ You can find more on CVS, SSH and WinCVS here:
+ </p>
+<ul>
+
+<li>
+<a href="http://www.cvshome.org">CVS Home Page</a>
+</li>
+
+<li>
+<a href="http://www.openssh.org">OpenSSH</a>
+</li>
+
+<li>
+<a href="http://www.redhat.com/software/tools/cygwin/">Cygwin Home Page</a>
+</li>
+
+<li>
+<a href="http://odin.himinbi.org/wincvs-over-ssh/">WinCVS over SSH</a>
+</li>
+
+</ul>
+</div>
+<span class="version">1.0</span>
+</div>
+
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+
+<div class="lastmodified">
+<script type="text/javascript"></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 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>
+
+</div>
+</body>
+</html>

Propchange: forrest/site/docs_0_100/howto/cvs-ssh/howto-cvs-ssh.html
------------------------------------------------------------------------------
svn:eol-style = native

Added: forrest/site/docs_0_100/howto/howto-asf-mirror.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/howto/howto-asf-mirror.html?rev=1068306&view=auto
==============================================================================
--- forrest/site/docs_0_100/howto/howto-asf-mirror.html (added)
+++ forrest/site/docs_0_100/howto/howto-asf-mirror.html Tue Feb 8 09:44:46 2011
@@ -0,0 +1,560 @@
+<!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>Generate an ASF mirrors page using interactive web form (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">
+
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://forrest.apache.org/">Apache Forrest</a><script src="../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+
+<div class="header">
+
+<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>
+
+
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+
+
+<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"> 
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+
+
+<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>
+
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+
+<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>
+
+<script type="text/javascript"></script>
+</div>
+
+<div class="breadtrail">
+
+  
+ </div>
+
+
+<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_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="menupage">
+<div class="menupagetitle">Download mirror</div>
+</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>
+
+<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>
+
+
+<div id="content">
+<div class="trail">Font size:
+  <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+  <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+  <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Generate an ASF mirrors page using interactive web form</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 class="abstract">
+ Include html form elements into a forrest-generated html page. For
+ example, this enables building automated download mirror pages for ASF
+ project websites.
+ </div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Intended-Audience">Intended Audience</a>
+</li>
+<li>
+<a href="#Purpose">Purpose</a>
+</li>
+<li>
+<a href="#Prerequisites">Prerequisites</a>
+</li>
+<li>
+<a href="#Steps">Steps</a>
+<ul class="minitoc">
+<li>
+<a href="#cgi">Add the mirrors.cgi as a raw file</a>
+</li>
+<li>
+<a href="#html">Add the mirrors.html to xdocs directory</a>
+</li>
+<li>
+<a href="#menu">Add a menu entry for Download</a>
+</li>
+<li>
+<a href="#link">Cause the mirrors.html to be processed as an extra file</a>
+</li>
+<li>
+<a href="#exclude">Exclude mirrors CGI token URIs from processing</a>
+</li>
+<li>
+<a href="#forrest">Run 'forrest' to build your site</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<a name="Intended-Audience"></a>
+<h2 class="underlined_10">Intended Audience</h2>
+<div class="section">
+<ul>
+
+<li>Any Apache project that uses Forrest to generate their website
+ will need to have a mirrors page.</li>
+
+<li>Anyone interested in the use of embedding html form
+ elements into a generated Forrest page.</li>
+
+<li>Anyone needing to add extra documents to the processing.</li>
+
+</ul>
+</div>
+<a name="Purpose"></a>
+<h2 class="underlined_10">Purpose</h2>
+<div class="section">
+<p>
+ All Apache projects use dynamically generated download pages which
+ determine the closest mirror and provide an interactive list of the
+ current alternative mirrors. This HowTo describes the procedure to
+ generate the template page that is utilised by the mirrors.cgi script.
+ </p>
+<p>
+ The mirrors.cgi and mirrors.html are "extra" documents, i.e. have no links
+ from anywhere in the site. So we explain how to process additional files.
+ </p>
+</div>
+<a name="Prerequisites"></a>
+<h2 class="underlined_10">Prerequisites</h2>
+<div class="section">
+<ul>
+
+<li>Followed the documentation about
+ <a href="http://www.apache.org/~bodewig/mirror.html">Making your
+ downloads mirrorable</a> and
+ <a href="http://www.apache.org/dev/mirrors.html">Apache Mirroring Information</a>
+ .
+ </li>
+
+<li>Established your ASF distribution space as described.</li>
+
+<li>Already building your project website with Forrest.</li>
+
+</ul>
+</div>
+<a name="Steps"></a>
+<h2 class="underlined_10">Steps</h2>
+<div class="section">
+<p>
+ See the example for the Apache Forrest website. The following files are involved:
+ </p>
+<pre class="code">
+$FORREST_HOME/site-author/content/xdocs/site.xml (search for "mirrors")
+$FORREST_HOME/site-author/content/xdocs/mirrors.html
+$FORREST_HOME/site-author/content/mirrors.cgi
+$FORREST_HOME/site-author/conf/cli.xconf (search for "mirrors")
+$FORREST_HOME/site-author/forrest.properties (search for "project.configfile")</pre>
+<a name="cgi"></a>
+<h3 class="underlined_5">Add the mirrors.cgi as a raw file</h3>
+<p>
+ As explained in the mirrors document, there will be a two-line CGI
+ wrapper script at the top-level of your website called
+ <span class="codefrag">mirrors.cgi</span>
+
+</p>
+<p>
+ Utilising the Forrest concept of raw un-processed content, add the file
+ as <span class="codefrag">src/documentation/mirrors.cgi</span> (copy the Forrest
+ project's
+ <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/mirrors.cgi">mirrors.cgi</a>)
+ </p>
+<a name="html"></a>
+<h3 class="underlined_5">Add the mirrors.html to xdocs directory</h3>
+<p>
+ This file contains the html content of your mirror page, including the
+ html form elements which drive the mirror selection. It also contains
+ the specific tokens that are interpreted by the mirrors.cgi script to
+ add the list of mirrors and select the closest.
+ </p>
+<p>
+ Add the file as <span class="codefrag">src/documentation/xdocs/mirrors.html</span> (Use
+ the Forrest project's
+ <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/mirrors.html">mirrors.html</a>
+ as a template and edit it to suit.)
+ </p>
+<p>
+ Note that the special tokens (e.g. [if-any http] [for http]) need to be
+ encompassed by xml comments.
+ </p>
+<a name="menu"></a>
+<h3 class="underlined_5">Add a menu entry for Download</h3>
+<p>
+ Add an entry to your site.xml navigation. For example ...
+ </p>
+<pre class="code">
+
+ <about label="About">
+ <index label="Index" href="index.html"/>
+ <license label="License" href="license.html"/>
+ <download label="Download" href="http://forrest.apache.org/mirrors.cgi"/>
+ <download_html href="mirrors.html"/>
+ ...
+ </pre>
+<a name="link"></a>
+<h3 class="underlined_5">Cause the mirrors.html to be processed as an extra file</h3>
+<p>
+ Forrest gathers the links that are to be crawled, by reading site.xml
+ and by finding any other internal links in the actual documents. There
+ is no link to mirrors.html because it is an extra file that needs to be
+ generated and skinned, but not linked in any way.
+ </p>
+<p>
+ The Cocoon command-line interface
+ (<a href="http://cocoon.apache.org/2.1/userdocs/offline/">CLI</a>)
+ to the rescue. Add the following entry to your project's cli.xconf file.
+ See the FAQ about adding and configuring a project-based
+ <a href="../../docs_0_100/faq.html#cli-xconf">cli.xconf</a>
+
+</p>
+<pre class="code">
+
+<uris name="mirrors" follow-links="false">
+ <uri type="append" src="mirrors.html"/>
+</uris>
+ </pre>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ Due to Issue
+ <a href="http://issues.apache.org/jira/browse/FOR-480">FOR-480</a>
+ the generated mirrors.html will end up in forrest/main/site/mirrors.html
+ rather than in the project's build directory. So use the following workaround
+ in your cli.xconf file ...
+ </div>
+</div>
+<p>
+ This example comes from $FORREST_HOME/site-author/conf/cli.xconf file.
+ The path is relative to $FORREST_HOME/main/webapp/ directory. A full
+ pathname should also work.
+ </p>
+<pre class="code">
+
+<uris name="mirrors" follow-links="false">
+ <uri type="append" src="mirrors.html"
+ dest="../../site-author/build/site">
+ </uri>
+</uris>
+ </pre>
+<a name="exclude"></a>
+<h3 class="underlined_5">Exclude mirrors CGI token URIs from processing</h3>
+<p>
+ The mirrors.html has special URIs which are processed by the mirrors CGI script.
+ These URIs need to be excluded from processing by Cocoon. Add the following
+ entries to your conf/cli.xconf ...
+ </p>
+<pre class="code">
+
+
+<exclude pattern="[preferred]/**"/>
+<exclude pattern="[location]"/>
+ </pre>
+<a name="forrest"></a>
+<h3 class="underlined_5">Run 'forrest' to build your site</h3>
+<p>
+ That is all that you need to do, Forrest will take care of it from
+ there. Run the '<span class="codefrag">forrest site</span>' command, or forrestbot.
+ The mirrors.html page will be generated with the skin applied.
+ </p>
+</div>
+</div>
+
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+
+<div class="lastmodified">
+<script type="text/javascript"></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 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>
+
+</div>
+</body>
+</html>

Propchange: forrest/site/docs_0_100/howto/howto-asf-mirror.html
------------------------------------------------------------------------------
svn:eol-style = native