You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-svn@forrest.apache.org by cr...@apache.org on 2007/04/18 10:36:26 UTC
svn commit: r529915 [7/20] - in /forrest/site: ./ docs_0_70/
docs_0_70/howto/ docs_0_70/howto/cvs-ssh/ docs_0_70/howto/multi/ docs_0_80/
docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ dtdx/
plan/ pluginDocs/ pluginDocs/plugins_0_70/ p...
Modified: forrest/site/docs_0_70/howto/forrest.xmap.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/forrest.xmap.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/forrest.xmap.html (original)
+++ forrest/site/docs_0_70/howto/forrest.xmap.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
<meta name="Forrest-skin-name" content="pelt">
<meta name="generator" content="">
<title>Annotated forrest.xmap (v0.7)</title>
@@ -99,7 +99,7 @@
|breadtrail
+-->
<div class="breadtrail">
-
+
</div>
<!--+
@@ -115,6 +115,9 @@
<a href="../../index.html" title="Welcome and introduction">About Forrest</a>
</div>
<div class="menuitem">
+<a href="../../linkmap.html" title="Table of Contents for all Forrest documentation">Documentation ToC</a>
+</div>
+<div class="menuitem">
<a href="http://forrest.apache.org/mirrors.cgi" title="Download a release from your nearest mirror or get the latest from SVN">Download</a>
</div>
<div class="menuitem">
@@ -280,9 +283,393 @@
<a href="../../tools/xxe.html">XXE-Editor</a>
</div>
</div>
+<div onclick="SwitchMenu('menu_1.8', '../../skin/')" id="menu_1.8Title" class="menutitle">Documentation in development</div>
+<div id="menu_1.8" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.8.1', '../../skin/')" id="menu_1.8.1Title" class="menutitle">0.90-dev</div>
+<div id="menu_1.8.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/your-project.html">Using Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3', '../../skin/')" id="menu_1.8.1.3Title" class="menutitle">How-To</div>
+<div id="menu_1.8.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3.2', '../../skin/')" id="menu_1.8.1.3.2Title" class="menutitle">Install Forrest</div>
+<div id="menu_1.8.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/build.html" title="Build and install the current unreleased version">Building Forrest from Source</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/upgrading_09.html">Upgrading to 0.9</a>
+</div>
+<div class="menuitem">
+<a href="">Use Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3.5', '../../skin/')" id="menu_1.8.1.3.5Title" class="menutitle">Customize Forrest</div>
+<div id="menu_1.8.1.3.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/sitemap-explain.html">Sitemaps explained</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/howto-custom-html-source.html">Custom html source</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/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_90/howto/howto-corner-images.html">CSS corner SVG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3.6', '../../skin/')" id="menu_1.8.1.3.6Title" class="menutitle">Integrate Forrest with tools</div>
+<div id="menu_1.8.1.3.6" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/howto/howto-forrest-from-maven.html">Maven Integration</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/catalog.html">Using DTD Catalogs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3.7', '../../skin/')" id="menu_1.8.1.3.7Title" class="menutitle">Extend Forrest</div>
+<div id="menu_1.8.1.3.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/howto/howto-buildPlugin.html">Build a Plugin</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/skin-package.html">Package new Skins</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.3.9', '../../skin/')" id="menu_1.8.1.3.9Title" class="menutitle">Adding Documentation</div>
+<div id="menu_1.8.1.3.9" 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.8.1.3.9.2', '../../skin/')" id="menu_1.8.1.3.9.2Title" class="menutitle">Multipage HowTo</div>
+<div id="menu_1.8.1.3.9.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/howto/multi/howto-multi.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/multi/step1.html">Step 1</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/multi/step2.html">Step 2</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/multi/step3.html">Step 3</a>
+</div>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.5', '../../skin/')" id="menu_1.8.1.5Title" class="menutitle">Background</div>
+<div id="menu_1.8.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/searching.html">Search Options in Forrest</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/locationmap.html">Locationmap</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/skins.html" title="About default skins, their naming and features">Skins</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/status-themes.html">Dispatcher versus Skins</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/cap.html">Sourcetype Action</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/validation.html">XML validation and entity resolution</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/glossary.html">Glossary</a>
+</div>
+<div onclick="SwitchMenu('menu_1.8.1.8', '../../skin/')" id="menu_1.8.1.8Title" class="menutitle">Reference docs</div>
+<div id="menu_1.8.1.8" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.8.1.8.1', '../../skin/')" id="menu_1.8.1.8.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.8.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.8.1.8.2', '../../skin/')" id="menu_1.8.1.8.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.8.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.8.1.9', '../../skin/')" id="menu_1.8.1.9Title" class="menutitle">Older Docs</div>
+<div id="menu_1.8.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_90/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/dreams.html">Dream list</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.8.2', '../../skin/')" id="menu_1.8.2Title" class="menutitle">0.90 Plugins</div>
+<div id="menu_1.8.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_90/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_90/usingPlugins.html">Using Plugins</a>
+</div>
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.9', '../../skin/')" id="menu_1.9Title" class="menutitle">Documentation current</div>
+<div id="menu_1.9" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.9.1', '../../skin/')" id="menu_1.9.1Title" class="menutitle">0.80-dev</div>
+<div id="menu_1.9.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/your-project.html">Using Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3', '../../skin/')" id="menu_1.9.1.3Title" class="menutitle">How-To</div>
+<div id="menu_1.9.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3.2', '../../skin/')" id="menu_1.9.1.3.2Title" class="menutitle">Install Forrest</div>
+<div id="menu_1.9.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/build.html" title="Build and install the current unreleased version">Building Forrest from Source</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/upgrading_08.html">Upgrading to 0.8</a>
+</div>
+<div class="menuitem">
+<a href="">Use Forrest</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3.5', '../../skin/')" id="menu_1.9.1.3.5Title" class="menutitle">Customize Forrest</div>
+<div id="menu_1.9.1.3.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/sitemap-explain.html">Sitemaps explained</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/howto-custom-html-source.html">Custom html source</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/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_80/howto/howto-corner-images.html">CSS corner SVG</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3.6', '../../skin/')" id="menu_1.9.1.3.6Title" class="menutitle">Integrate Forrest with tools</div>
+<div id="menu_1.9.1.3.6" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/howto/howto-forrest-from-maven.html">Maven Integration</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_90/catalog.html">Using DTD Catalogs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3.7', '../../skin/')" id="menu_1.9.1.3.7Title" class="menutitle">Extend Forrest</div>
+<div id="menu_1.9.1.3.7" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/howto/howto-buildPlugin.html">Build a Plugin</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/skin-package.html">Package new Skins</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.3.9', '../../skin/')" id="menu_1.9.1.3.9Title" class="menutitle">Adding Documentation</div>
+<div id="menu_1.9.1.3.9" 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.9.1.3.9.2', '../../skin/')" id="menu_1.9.1.3.9.2Title" class="menutitle">Multipage HowTo</div>
+<div id="menu_1.9.1.3.9.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/howto/multi/howto-multi.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/multi/step1.html">Step 1</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/multi/step2.html">Step 2</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/multi/step3.html">Step 3</a>
+</div>
+</div>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/faq.html">FAQs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.5', '../../skin/')" id="menu_1.9.1.5Title" class="menutitle">Background</div>
+<div id="menu_1.9.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/searching.html">Search Options in Forrest</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/locationmap.html">Locationmap</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/skins.html" title="About default skins, their naming and features">Skins</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/status-themes.html">Dispatcher versus Skins</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/cap.html">Sourcetype Action</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/validation.html">XML validation and entity resolution</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/glossary.html">Glossary</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.1.8', '../../skin/')" id="menu_1.9.1.8Title" class="menutitle">Reference docs</div>
+<div id="menu_1.9.1.8" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.9.1.8.1', '../../skin/')" id="menu_1.9.1.8.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.9.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.9.1.8.2', '../../skin/')" id="menu_1.9.1.8.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.9.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.9.1.9', '../../skin/')" id="menu_1.9.1.9Title" class="menutitle">Older Docs</div>
+<div id="menu_1.9.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../docs_0_80/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/dreams.html">Dream list</a>
+</div>
+<div class="menuitem">
+<a href="../../docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.9.2', '../../skin/')" id="menu_1.9.2Title" class="menutitle">0.80 Plugins</div>
+<div id="menu_1.9.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_80/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_80/usingPlugins.html">Using Plugins</a>
+</div>
+<div class="menuitem">
+<a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+</div>
+</div>
<div id="credit">
<hr>
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<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>
@@ -311,7 +698,7 @@
</div>
<h1>Annotated forrest.xmap</h1>
<div id="motd-area">
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<a href="http://forrest.apache.org/versions/">More</a>)</div>
<div id="minitoc-area">
<ul class="minitoc">
@@ -549,7 +936,8 @@
</map:select>
</map:act>
</map:resource>
-</pre>
+
+ </pre>
<a name="N10016"></a><a name="Definition+of+File-Resolver-Resource"></a>
<h3 class="underlined_5">Definition of File-Resolver-Resource</h3>
<pre>
@@ -617,7 +1005,8 @@
<!-- ============================================================ -->
<!-- SOURCE FORMATS -->
<!-- ============================================================ -->
-</pre>
+
+ </pre>
<a name="N1001C"></a><a name="Second+Match+for+%27**.xml%27"></a>
<h3 class="underlined_5">Second Match for '**.xml'</h3>
<pre>
@@ -642,7 +1031,8 @@
</map:pipeline>
</map:pipelines>
</map:sitemap>
-</pre>
+
+ </pre>
</div>
</div>
<!--+
Modified: forrest/site/docs_0_70/howto/howto-asf-mirror.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-asf-mirror.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-asf-mirror.html (original)
+++ forrest/site/docs_0_70/howto/howto-asf-mirror.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
<meta name="Forrest-skin-name" content="pelt">
<title>Generate an ASF mirrors page using interactive web form (v0.7)</title>
<link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
|start Subtabs
+-->
<div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
</div>
<!--+
|end Endtabs
@@ -100,7 +100,7 @@
|breadtrail
+-->
<div class="breadtrail">
-
+
</div>
<!--+
@@ -283,7 +283,7 @@
</div>
<div id="credit">
<hr>
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<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>
@@ -311,12 +311,13 @@
<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 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 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="motd-area">
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<a href="http://forrest.apache.org/versions/">More</a>)</div>
<div id="minitoc-area">
<ul class="minitoc">
@@ -366,26 +367,26 @@
<div class="warning">
<div class="label">Warning</div>
<div class="content">
-Due to issue
-<a href="http://issues.apache.org/jira/browse/FOR-555">FOR-555</a>
-the html comments that the CGI script depends upon are stripped before
-the output stage. You need to manually add those comments.
-This is fixed in forrest_07_branch of SVN.
-</div>
+ Due to issue
+ <a href="http://issues.apache.org/jira/browse/FOR-555">FOR-555</a>
+ the html comments that the CGI script depends upon are stripped before the
+ output stage. You need to manually add those comments. This is fixed in
+ forrest_07_branch of SVN.
+ </div>
</div>
</div>
<a name="N10025"></a><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>
+ 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>
+ 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="N10030"></a><a name="Prerequisites"></a>
@@ -411,51 +412,60 @@
<div class="section">
<a name="N1004E"></a><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>
+ 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
+<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="N10064"></a><a name="html"></a>
+<a name="N10065"></a><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>
+ 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
+ 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.
+ Note that the special tokens (e.g. [if-any http] [for http]) need to be
+ encompassed by xml comments.
</p>
-<a name="N1007B"></a><a name="menu"></a>
+<a name="N1007C"></a><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>
+ 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"/><!-- so the page is part of a tab -->
- ...</pre>
-<a name="N10089"></a><a name="link"></a>
+ ...
+ </pre>
+<a name="N1008A"></a><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>
+ 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
+<p>
+ The Cocoon command-line interface
(<a href="http://cocoon.apache.org/2.1/userdocs/offline/">CLI</a>)
to the rescue. Add an entry to your project's cli.xconf by copying the
default one from
@@ -464,10 +474,12 @@
${forrest.conf-dir} points). Add the following entry ...
</p>
<pre class="code">
+
<uris name="mirrors" follow-links="false">
<uri type="append" src="mirrors.html"/>
-</uris></pre>
-<a name="N100A4"></a><a name="forrest"></a>
+</uris>
+ </pre>
+<a name="N100A5"></a><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
@@ -477,11 +489,11 @@
<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 mirror.html will end up in forrest/main/site/mirrors.html
-rather than in the project's build directory.
-</div>
+ Due to Issue
+ <a href="http://issues.apache.org/jira/browse/FOR-480">FOR-480</a>,
+ the generated mirror.html will end up in forrest/main/site/mirrors.html
+ rather than in the project's build directory.
+ </div>
</div>
</div>
</div>
Modified: forrest/site/docs_0_70/howto/howto-asf-mirror.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-asf-mirror.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_70/howto/howto-buildPlugin.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-buildPlugin.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-buildPlugin.html (original)
+++ forrest/site/docs_0_70/howto/howto-buildPlugin.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
<meta name="Forrest-skin-name" content="pelt">
<title>How to Build a Plugin (v0.7)</title>
<link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
|start Subtabs
+-->
<div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
</div>
<!--+
|end Endtabs
@@ -100,7 +100,7 @@
|breadtrail
+-->
<div class="breadtrail">
-
+
</div>
<!--+
@@ -283,7 +283,7 @@
</div>
<div id="credit">
<hr>
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<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>
@@ -311,15 +311,17 @@
<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
</div>
<h1>How to Build a Plugin</h1>
-<div class="abstract">This How-To describes the steps necessary to build a plugin for
- Forrest. Forrest uses plugins to add new input formats, output formats
- and to change its default behaviour. Since plugins are downloaded when
- needed and can be hosted at any location, plugin code can be developed
- independently of Apache Forrest. This how-to describes each of the major
- steps in creating a plugin and then works through some examples of
- plugin creation in order to illustrate the materials.</div>
+<div class="abstract">
+ This How-To describes the steps necessary to build a plugin for Forrest.
+ Forrest uses plugins to add new input formats, output formats and to
+ change its default behaviour. Since plugins are downloaded when needed and
+ can be hosted at any location, plugin code can be developed independently
+ of Apache Forrest. This how-to describes each of the major steps in
+ creating a plugin and then works through some examples of plugin creation
+ in order to illustrate the materials.
+ </div>
<div id="motd-area">
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<a href="http://forrest.apache.org/versions/">More</a>)</div>
<div id="minitoc-area">
<ul class="minitoc">
@@ -404,32 +406,42 @@
<a name="N10013"></a><a name="Intended Audience"></a>
<h2 class="underlined_10">Intended Audience</h2>
<div class="section">
-<p>Users needing to add additional input formats or output formats or
- to change the operation of the Forrest internals.</p>
+<p>
+ Users needing to add additional input formats or output formats or to
+ change the operation of the Forrest internals.
+ </p>
<div class="warning">
<div class="label">Warning</div>
-<div class="content">The Plugin Infrastructure is still at an early stage of design
- and implementation, consequently this How-To <em>may</em> be out of date
- and/or incomplete. If you are having problems with any of the steps
- described, please ask for help on the developers mailing list (and then
- provide patches for this document).</div>
+<div class="content">
+ The Plugin Infrastructure is still at an early stage of design and
+ implementation, consequently this How-To <em>may</em> be out of date
+ and/or incomplete. If you are having problems with any of the steps
+ described, please ask for help on the developers mailing list (and then
+ provide patches for this document).
+ </div>
</div>
<div class="warning">
<div class="label">Warning</div>
-<div class="content">Please make sure that you are using forrest 0.7 if you want use
- plugins. Forrest 0.6 will not work!!!</div>
+<div class="content">
+ Please make sure that you are using forrest 0.7 if you want use plugins.
+ Forrest 0.6 will not work!!!
+ </div>
</div>
</div>
<a name="N10024"></a><a name="Purpose"></a>
<h2 class="underlined_10">Purpose</h2>
<div class="section">
-<p>This How-To will illustrate how to build a plugin, publish a plugin
- and configure a Forrest project to use their plugin.</p>
+<p>
+ This How-To will illustrate how to build a plugin, publish a plugin and
+ configure a Forrest project to use their plugin.
+ </p>
</div>
<a name="N1002C"></a><a name="Prerequisites"></a>
<h2 class="underlined_10">Prerequisites</h2>
<div class="section">
-<p>Plugin developers should have:</p>
+<p>
+ Plugin developers should have:
+ </p>
<ul>
<li>a basic knowledge of XML, XSLT and Cocoon pipelines</li>
@@ -437,8 +449,7 @@
<li>a clear use-case for extending Forrest</li>
<li>read
- <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a>
-
+ <a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin Infrastructure</a>
</li>
<li>verified with the Apache Forrest developer community that the
@@ -446,276 +457,351 @@
</ul>
</div>
-<a name="N10047"></a><a name="Steps"></a>
+<a name="N10046"></a><a name="Steps"></a>
<h2 class="underlined_10">Steps</h2>
<div class="section">
-<p>Here is how to proceed.</p>
-<a name="N1004F"></a><a name="typeOfPlugin"></a>
+<p>
+ Here is how to proceed.
+ </p>
+<a name="N1004E"></a><a name="typeOfPlugin"></a>
<h3 class="underlined_5">Type of Plugin</h3>
-<p>There are three types of plugin, each with a clear purpose, you
- must first decide which
- <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">type of plugin</a>
- you need to build.</p>
-<a name="N1005D"></a><a name="ant"></a>
+<p>
+ There are three types of plugin, each with a clear purpose, you must
+ first decide which <a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">type of
+ plugin</a> you need to build.
+ </p>
+<a name="N1005C"></a><a name="ant"></a>
<h3 class="underlined_5">Make ant available on the command-line</h3>
<p>
The following instructions rely heavily on
- <a href="http://ant.apache.org/">Apache Ant</a>
- to automate some steps in the process. Since ant
- is distributed as part of Forrest, all you need to do
- is add the ant executable directory to your system path. The
- name of this directory is <span class="codefrag">tools/ant/bin</span>
- in your Forrest program directory.
- (Alternatively you can prefix all calls to ant in
- the following instructions with the full path of the ant binary directory.)
+ <a href="http://ant.apache.org/">Apache Ant</a> to automate some steps
+ in the process. Since ant is distributed as part of Forrest, all you
+ need to do is add the ant executable directory to your system path. The
+ name of this directory is <span class="codefrag">tools/ant/bin</span> in your Forrest
+ program directory. (Alternatively you can prefix all calls to ant in the
+ following instructions with the full path of the ant binary directory.)
Also clear the ANT_HOME environment variable.
</p>
<p>
- If instead you really want to use your own version of Ant,
- then you will need to copy
- forrest/lib/core/xml-commons-resolver.jar
- to $ANT_HOME/lib directory, otherwise your plugins will go across
- the network to get the DTDs on every parse.
+ If instead you really want to use your own version of Ant, then you will
+ need to copy forrest/lib/core/xml-commons-resolver.jar to $ANT_HOME/lib
+ directory, otherwise your plugins will go across the network to get the
+ DTDs on every parse.
</p>
-<a name="N10071"></a><a name="seed"></a>
+<a name="N10070"></a><a name="seed"></a>
<h3 class="underlined_5">Seed a New Plugin</h3>
-<p>Regardless of the type of plugin you are building, the directory
- structure is almost identical, as are most of the requried
- configuration files. In this How-To we will assume that you are creating a
- plugin in the Forrest source tree. All plugins are developed in the
- <span class="codefrag">forrest/plugins</span> directory.</p>
-<p class="instruction">Run the following set of commands:</p>
+<p>
+ Regardless of the type of plugin you are building, the directory
+ structure is almost identical, as are most of the requried configuration
+ files. In this How-To we will assume that you are creating a plugin in
+ the Forrest source tree. All plugins are developed in the
+ <span class="codefrag">forrest/plugins</span> directory.
+ </p>
+<p class="instruction">
+ Run the following set of commands:
+ </p>
<pre class="code">
cd [path_to_forrest]/plugins
ant seedPlugin
</pre>
-<p>The above ant target will ask you the name of the plugin and will
- build a minimal plugin directory structure and configuration. You will
- need to customise these files to build your plugin.</p>
+<p>
+ The above ant target will ask you the name of the plugin and will build
+ a minimal plugin directory structure and configuration. You will need to
+ customise these files to build your plugin.
+ </p>
<div class="note">
<div class="label">Note</div>
-<div class="content">Although you can name your project anything you like we do have
- some <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">naming
- conventions</a> that we recommend you follow. Plugins intended to be
- held at forrest.apache.org must follow the naming convention.</div>
+<div class="content">
+ Although you can name your project anything you like we do have some
+ <a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">naming conventions</a> that we
+ recommend you follow. Plugins intended to be held at forrest.apache.org
+ must follow the naming convention.
+ </div>
</div>
<div class="note">
<div class="label">Note</div>
-<div class="content">If you plan on building your plugin elsewhere you can copy the
- <span class="codefrag">build.xml</span> build file to your own plugin work directory and
- use it there.</div>
-</div>
-<p>See
- <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin
- Infrastructure</a> for more information about the plugin
- directory structure and configuration files.</p>
-<a name="N1009C"></a><a name="edit-template"></a>
+<div class="content">
+ If you plan on building your plugin elsewhere you can copy the
+ <span class="codefrag">build.xml</span> build file to your own plugin work directory and
+ use it there.
+ </div>
+</div>
+<p>
+ See <a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin Infrastructure</a> for
+ more information about the plugin directory structure and configuration
+ files.
+ </p>
+<a name="N1009B"></a><a name="edit-template"></a>
<h4>Edit the Plugin Template</h4>
-<p>You now have a skeleton plugin project. However, it doesn't do
- anything useful yet. Now is a good time to edit some of the files
- provided.</p>
+<p>
+ You now have a skeleton plugin project. However, it doesn't do
+ anything useful yet. Now is a good time to edit some of the files
+ provided.
+ </p>
<div class="note">
<div class="label">Note</div>
<div class="content">
- For plugins intended to be held at forrest.apache.org please
- adjust the skinconf.xml etc to be in accordance with the other
- forrest plugins. See <a href="#hosted">notes</a> below.
+ For plugins intended to be held at forrest.apache.org please adjust
+ the skinconf.xml etc to be in accordance with the other forrest
+ plugins. See <a href="#hosted">notes</a> below.
</div>
</div>
-<p>Here are some general notes:</p>
-<a name="N100AF"></a><a name="status"></a>
+<p>
+ Here are some general notes:
+ </p>
+<a name="N100AE"></a><a name="status"></a>
<h5>status.xml</h5>
-<p>This file is used to track changes to the plugin
- project and to manage lists of things that still need to be done.
- At this stage you should correct the <span class="codefrag">person</span> entry
- near the top of the file. It is also a good idea to add a few key
- milestones in the task list towards the bottom of the file.</p>
-<p>As you work on the plugin you should record all major changes in
- this file so that it can then be used as a changelog for your
- plugin.</p>
-<a name="N100BF"></a><a name="forrest-properties"></a>
+<p>
+ This file is used to track changes to the plugin project and to
+ manage lists of things that still need to be done. At this stage you
+ should correct the <span class="codefrag">person</span> entry near the top of the
+ file. It is also a good idea to add a few key milestones in the task
+ list towards the bottom of the file.
+ </p>
+<p>
+ As you work on the plugin you should record all major changes in
+ this file so that it can then be used as a changelog for your
+ plugin.
+ </p>
+<a name="N100BE"></a><a name="forrest-properties"></a>
<h5>forrest.properties</h5>
-<p>This file defines many configuration parameters for Forrest. It
- does not need to be customised in most cases. However, see
- for more details.</p>
-<a name="N100C9"></a><a name="skinconf"></a>
+<p>
+ This file defines many configuration parameters for Forrest. It does
+ not need to be customised in most cases. However, see for more
+ details.
+ </p>
+<a name="N100C8"></a><a name="skinconf"></a>
<h5>src/documentation/skinconf.xml</h5>
-<p>This configures the skin for your plugins documentation. There
- are some items that need to be configured in here, for example, the
- copyright information. The file is heavily commented so probably
- best to read through it, changing what you need to.</p>
-<a name="N100D3"></a><a name="doc"></a>
+<p>
+ This configures the skin for your plugins documentation. There are
+ some items that need to be configured in here, for example, the
+ copyright information. The file is heavily commented so probably
+ best to read through it, changing what you need to.
+ </p>
+<a name="N100D2"></a><a name="doc"></a>
<h5>Documentation</h5>
-<p>It is also a good idea to start writing the documentation at this
- stage. The above process created a very simple plugin documentation
- site for you. All you have to do is add the content.</p>
-<a name="N100DD"></a><a name="hosted"></a>
+<p>
+ It is also a good idea to start writing the documentation at this
+ stage. The above process created a very simple plugin documentation
+ site for you. All you have to do is add the content.
+ </p>
+<a name="N100DC"></a><a name="hosted"></a>
<h5>Style notes for plugins hosted at forrest.apapche.org</h5>
<p>
- After seeding a new plugin, copy the configuration from an
- exisiting plugin (e.g. org.apache.forrest.plugin.input.projectInfo).
- Copy src/documentation/skinconf.xml and
+ After seeding a new plugin, copy the configuration from an exisiting
+ plugin (e.g. org.apache.forrest.plugin.input.projectInfo). Copy
+ src/documentation/skinconf.xml and
src/documentation/content/xdocs/images/project-logo.gif
</p>
-<a name="N100E9"></a><a name="edit-sitemap"></a>
+<a name="N100E8"></a><a name="edit-sitemap"></a>
<h3 class="underlined_5">Edit the Plugin sitemap file(s)</h3>
-<p>The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted
- at a strategic place in the Forrest pipeline. It is in this file
- that you will instruct Forrest how to operate. An input plugin
- must provide a <span class="codefrag">input.xmap</span> file, an output plugin
- must provide a <span class="codefrag">output.xmap</span> file, whilst an internal
- plugin provides a <span class="codefrag">internal.xmap</span> file. In addition, an
- input plugin may provide a <span class="codefrag">resources.xmap</span> file to
- allow the plugin to handle items such as JavaScript files.</p>
-<p>It is beyond the scope of this How-To to give details about how to
- build your plugins XMap. See the
- <a href="../../docs_0_70/sitemap-ref.html">Sitemap Reference</a> for general
- information. See also
- <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a>
- for some hints and tips on creating plugin sitemaps. In addition, as with
- all development work on Forrest, you will find
- the <a href="../../mail-lists.html#forrest-dev">developer mailing list</a>
- a very good resource (check the archives before posting, please).</p>
-<a name="N10110"></a><a name="components"></a>
+<p>
+ The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted at
+ a strategic place in the Forrest pipeline. It is in this file that you
+ will instruct Forrest how to operate. An input plugin must provide a
+ <span class="codefrag">input.xmap</span> file, an output plugin must provide a
+ <span class="codefrag">output.xmap</span> file, whilst an internal plugin provides a
+ <span class="codefrag">internal.xmap</span> file. In addition, an input plugin may
+ provide a <span class="codefrag">resources.xmap</span> file to allow the plugin to handle
+ items such as JavaScript files.
+ </p>
+<p>
+ It is beyond the scope of this How-To to give details about how to build
+ your plugins XMap. See the
+ <a href="../../docs_0_70/sitemap-ref.html">Sitemap
+ Reference</a> for general information. See also
+ <a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin Infrastructure</a> for some
+ hints and tips on creating plugin sitemaps. In addition, as with all
+ development work on Forrest, you will find the
+ <a href="../../mail-lists.html#forrest-dev">developer mailing list</a> a very
+ good resource (check the archives before posting, please).
+ </p>
+<a name="N1010F"></a><a name="components"></a>
<h4>Components, Actions and Resources</h4>
-<p>If your plugin uses any components (i.e. generators, transformers or
- serializers), actions or resources they must
- be defined in either the xmap for this plugin or one of its parents. The parents
- of an <span class="codefrag">input.xmap</span> are <span class="codefrag">sitemap.xmap</span> and
- <span class="codefrag">forrest.xmap</span>, whilst the parent of both
- <span class="codefrag">output.xmap</span> and <span class="codefrag">internal.xmap</span> are
- <span class="codefrag">sitemap.xmap</span>
+<p>
+ If your plugin uses any components (i.e. generators, transformers or
+ serializers), actions or resources they must be defined in either the
+ xmap for this plugin or one of its parents. The parents of an
+ <span class="codefrag">input.xmap</span> are <span class="codefrag">sitemap.xmap</span> and
+ <span class="codefrag">forrest.xmap</span>, whilst the parent of both
+ <span class="codefrag">output.xmap</span> and <span class="codefrag">internal.xmap</span> are
+ <span class="codefrag">sitemap.xmap</span>
+
</p>
-<p>If you want to use the realpath where the sitemap.xmap of your plugin
- resides then you need to use
- <span class="codefrag">{forrest:forrest.plugins}/PLUGIN_NAME</span> instead of <span class="codefrag">{realpath:/}</span>.
+<p>
+ If you want to use the realpath where the sitemap.xmap of your plugin
+ resides then you need to use
+ <span class="codefrag">{forrest:forrest.plugins}/PLUGIN_NAME</span> instead of
+ <span class="codefrag">{realpath:/}</span>.
+ </p>
+<p>
+ See the examples below for more details.
</p>
-<p>See the examples below for more details.</p>
<a name="N10138"></a><a name="resources"></a>
<h3 class="underlined_5">Create the Necessary Resource Files</h3>
<div class="fixme">
<div class="label">Fixme (rdg)</div>
-<div class="content">Discuss the XSL files and other such resources</div>
+<div class="content">
+ Discuss the XSL files and other such resources
+ </div>
</div>
<a name="N10143"></a><a name="samples"></a>
<h3 class="underlined_5">Create Samples in the Documentation</h3>
-<p>Plugin documentation should provide (as a minimum) an
- index page that provides an overview and a set of samples that demonstrate
- the functionality of the plugin. Typically these samples will be
- provided in a <span class="codefrag">samples</span> subdirectory in the plugin
- documentation and will be referenced from both <span class="codefrag">site.xml</span>
- and <span class="codefrag">tabs.xml</span> configuration files.</p>
-<p>Try to provide a sample for all the major functions of your plugin
- and document any configuration that is available.</p>
+<p>
+ Plugin documentation should provide (as a minimum) an index page that
+ provides an overview and a set of samples that demonstrate the
+ functionality of the plugin. Typically these samples will be provided in
+ a <span class="codefrag">samples</span> subdirectory in the plugin documentation and will
+ be referenced from both <span class="codefrag">site.xml</span> and <span class="codefrag">tabs.xml</span>
+ configuration files.
+ </p>
+<p>
+ Try to provide a sample for all the major functions of your plugin and
+ document any configuration that is available.
+ </p>
<a name="N10159"></a><a name="test"></a>
<h3 class="underlined_5">Testing a Plugin</h3>
-<p>Since your documentation for the plugin illustrates all of its
- functionality, you can use that site for testing the plugin. However, you
- must first deploy in your local install of Forrest. Each plugin contains
- a buildfile that includes a <span class="codefrag">test</span> target. This target, by
- default, builds the documentation for your plugin.</p>
-<p class="instruction">Run the command <span class="codefrag">ant test</span> in
- the plugins directory.</p>
-<p>Of course, the build should complete without errors.</p>
+<p>
+ Since your documentation for the plugin illustrates all of its
+ functionality, you can use that site for testing the plugin. However,
+ you must first deploy in your local install of Forrest. Each plugin
+ contains a buildfile that includes a <span class="codefrag">test</span> target. This
+ target, by default, builds the documentation for your plugin.
+ </p>
+<p class="instruction">
+ Run the command <span class="codefrag">ant test</span> in the plugins directory.
+ </p>
+<p>
+ Of course, the build should complete without errors.
+ </p>
<div class="note">
<div class="label">Note</div>
-<div class="content">You can also use <span class="codefrag">forrest run</span> to interactively examine
- your documentation (point your browser at
- <a href="http://localhost:8888">http://localhost:8888</a>).</div>
-</div>
-<p>It is also a really good idea to build proper tests for your
- plugins using a suitable testing framework, for example,
- <a href="http://webtest.canoo.com/">WebTest</a>. We recommend that you
- extend the <span class="codefrag">test</span> target in your plugins build file because
- this target is also used when performing integration tests on Forrest.
- In addition, we recommend that you use the samples in your documentation
- for your tests, this way you are documenting your plugin at the same time
- as writing your tests.</p>
-<p>Ensure that your sitemaps are robust and handle matches for files
- in sub-directories, as well as those at the root level.</p>
+<div class="content">
+ You can also use <span class="codefrag">forrest run</span> to interactively examine your
+ documentation (point your browser at
+ <a href="http://localhost:8888">http://localhost:8888</a>).
+ </div>
+</div>
+<p>
+ It is also a really good idea to build proper tests for your plugins
+ using a suitable testing framework, for example,
+ <a href="http://webtest.canoo.com/">WebTest</a>. We recommend that you
+ extend the <span class="codefrag">test</span> target in your plugins build file because
+ this target is also used when performing integration tests on Forrest.
+ In addition, we recommend that you use the samples in your documentation
+ for your tests, this way you are documenting your plugin at the same
+ time as writing your tests.
+ </p>
+<p>
+ Ensure that your sitemaps are robust and handle matches for files in
+ sub-directories, as well as those at the root level.
+ </p>
<a name="N10187"></a><a name="release"></a>
<h3 class="underlined_5">Releasing a Plugin</h3>
<a name="N1018D"></a><a name="register"></a>
<h4>Register the Plugin with Apache Forrest</h4>
<div class="fixme">
<div class="label">Fixme (rdg)</div>
-<div class="content">Describe the plugins.xml file</div>
+<div class="content">
+ Describe the plugins.xml file
+ </div>
</div>
<div class="fixme">
<div class="label">Fixme (rdg)</div>
-<div class="content">Describe making a request of Forrest devs for
- inclusion</div>
+<div class="content">
+ Describe making a request of Forrest devs for inclusion
+ </div>
</div>
<a name="N1019C"></a><a name="deploy"></a>
<h4>Deploying the Plugin</h4>
-<p>To deploy the plugin so that others can use it, it must be made
- available as a zip from the URL indicated in the
- <span class="codefrag">plugins.xml</span> file. The plugins build file provides targets
- to assist with this task.</p>
-<p class="instruction">To deploy a plugin simply run the command
- <span class="codefrag">ant deploy</span> from within the plugin directory.</p>
-<p>This command will, by default, deploy to the Apache Forrest web site.
- In order to do this you need commit access to Forrest. If you want to
- deploy your plugin to a different location you
- can build the zip of your plugin with <span class="codefrag">ant dist</span>
- and then copy the zip file from <span class="codefrag">build/dist</span> to wherever
- you intend to host the plugin.</p>
+<p>
+ To deploy the plugin so that others can use it, it must be made
+ available as a zip from the URL indicated in the
+ <span class="codefrag">plugins.xml</span> file. The plugins build file provides targets
+ to assist with this task.
+ </p>
+<p class="instruction">
+ To deploy a plugin simply run the command <span class="codefrag">ant deploy</span> from
+ within the plugin directory.
+ </p>
+<p>
+ This command will, by default, deploy to the Apache Forrest web site.
+ In order to do this you need commit access to Forrest. If you want to
+ deploy your plugin to a different location you can build the zip of
+ your plugin with <span class="codefrag">ant dist</span> and then copy the zip file from
+ <span class="codefrag">build/dist</span> to wherever you intend to host the plugin.
+ </p>
<div class="note">
<div class="label">Note</div>
-<div class="content">Running this command on any plugin will also deploy any
- changes to the <span class="codefrag">plugins.xml</span> file. If you are deploying to
- your own website you will have to request changes to the
- <span class="codefrag">plugins.xml</span> and ask the Forrest committers to publish the new
- document.</div>
+<div class="content">
+ Running this command on any plugin will also deploy any changes to the
+ <span class="codefrag">plugins.xml</span> file. If you are deploying to your own
+ website you will have to request changes to the
+ <span class="codefrag">plugins.xml</span> and ask the Forrest committers to publish the
+ new document.
+ </div>
</div>
<div class="warning">
<div class="label">Warning</div>
-<div class="content">Running the <span class="codefrag">deploy</span> or <span class="codefrag">dist</span> targets
- will always run the <span class="codefrag">test</span> target first. This is to ensure
- that your only deploy working plugins. This adds a little time to
- the deploy cycle, but we feel the peace of mind is worth it.</div>
+<div class="content">
+ Running the <span class="codefrag">deploy</span> or <span class="codefrag">dist</span> targets will
+ always run the <span class="codefrag">test</span> target first. This is to ensure that
+ your only deploy working plugins. This adds a little time to the
+ deploy cycle, but we feel the peace of mind is worth it.
+ </div>
</div>
<a name="N101CF"></a><a name="examples"></a>
<h3 class="underlined_5">Examples</h3>
-<p>This section will provide some example plugins to help illustrate the
- steps discussed above.</p>
+<p>
+ This section will provide some example plugins to help illustrate the
+ steps discussed above.
+ </p>
<a name="N101D8"></a><a name="input"></a>
<h4>Input Plugin</h4>
<div class="fixme">
<div class="label">Fixme (RDG)</div>
-<div class="content">Discuss OpenOffice.org plugin here</div>
+<div class="content">
+ Discuss OpenOffice.org plugin here
+ </div>
</div>
<a name="N101E3"></a><a name="output"></a>
<h4>Output Plugin</h4>
<div class="fixme">
<div class="label">Fixme (RDG)</div>
-<div class="content">Discuss s5 plugin here</div>
+<div class="content">
+ Discuss s5 plugin here
+ </div>
</div>
<a name="N101EE"></a><a name="internal"></a>
<h4>Internal Plugin</h4>
<div class="fixme">
<div class="label">Fixme (RDG)</div>
-<div class="content">Discuss IMSManifest plugin here</div>
+<div class="content">
+ Discuss IMSManifest plugin here
+ </div>
</div>
<a name="N101FA"></a><a name="extension"></a>
<h3 class="underlined_5">Further Reading</h3>
<ul>
<li>
-<a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastrucuture Documentation</a> for Developers</li>
+<a href="../../pluginDocs/plugins_0_90/pluginInfrastructure.html">Plugin Infrastrucuture Documentation</a> for Developers</li>
<li>
-<a href="../../pluginDocs/plugins_0_80/">Plugins Documentation</a> for users</li>
+<a href="../../pluginDocs/plugins_0_90/">Plugins Documentation</a> for users</li>
</ul>
<a name="N10210"></a><a name="summarise"></a>
<h3 class="underlined_5">Summarise the Entire Process</h3>
<div class="fixme">
<div class="label">Fixme (rdg)</div>
-<div class="content">In a few sentences, remind the reader what they have just learned.
- This helps to reinforce the main points of your How-To.</div>
+<div class="content">
+ In a few sentences, remind the reader what they have just learned. This
+ helps to reinforce the main points of your How-To.
+ </div>
</div>
</div>
+<span class="version">0.1</span>
</div>
<!--+
|end content
Modified: forrest/site/docs_0_70/howto/howto-buildPlugin.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-buildPlugin.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_70/howto/howto-corner-images.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-corner-images.html?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
--- forrest/site/docs_0_70/howto/howto-corner-images.html (original)
+++ forrest/site/docs_0_70/howto/howto-corner-images.html Wed Apr 18 01:36:14 2007
@@ -3,7 +3,7 @@
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-version" content="0.9-dev">
<meta name="Forrest-skin-name" content="pelt">
<title>How to modify the color of generated corner images (v0.7)</title>
<link type="text/css" href="../../skin/basic.css" rel="stylesheet">
@@ -87,7 +87,7 @@
|start Subtabs
+-->
<div id="level2tabs">
-<a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a>
+<a class="unselected" href="../../docs_0_80/index.html">0.80 (current)</a><a class="unselected" href="../../docs_0_90/index.html">0.90-dev (under development)</a><a class="selected" href="../../docs_0_70/index.html">0.70 (past)</a>
</div>
<!--+
|end Endtabs
@@ -100,7 +100,7 @@
|breadtrail
+-->
<div class="breadtrail">
-
+
</div>
<!--+
@@ -283,7 +283,7 @@
</div>
<div id="credit">
<hr>
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<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>
@@ -312,11 +312,11 @@
</div>
<h1>How to modify the color of generated corner images</h1>
<div class="abstract">
- This How-To describes how to modify the corner images that appear in
- the menu and tabs of the skins.
- </div>
+ This How-To describes how to modify the corner images that appear in the
+ menu and tabs of the skins.
+ </div>
<div id="motd-area">
- This is documentation for current version v0.7
+ This is documentation for past version v0.7
(<a href="http://forrest.apache.org/versions/">More</a>)</div>
<div id="minitoc-area">
<ul class="minitoc">
@@ -352,12 +352,12 @@
<h2 class="underlined_10">Intended Audience</h2>
<div class="section">
<p>
- Users who want to change the colors of the corner images in the
- output html documents.
+ Users who want to change the colors of the corner images in the output
+ html documents.
</p>
<p>
- This explanation is also useful for skin developers to understand
- the corner image generation process.
+ This explanation is also useful for skin developers to understand the
+ corner image generation process.
</p>
</div>
<a name="N1001B"></a><a name="Purpose"></a>
@@ -365,9 +365,9 @@
<div class="section">
<p>
Forrest renders the corner images through
- <a href="http://www.w3.org/TR/SVG/">Scalable Vector Graphics (SVG)</a>.
- It may be necessary to change the color of
- the corner images to be suitable for your own skin colors.
+ <a href="http://www.w3.org/TR/SVG/">Scalable Vector Graphics (SVG)</a>. It
+ may be necessary to change the color of the corner images to be suitable
+ for your own skin colors.
</p>
</div>
<a name="N10027"></a><a name="Prerequisites"></a>
@@ -389,15 +389,15 @@
<div class="section">
<p>
The procedure outlined below provides an understanding of how corner
- images are named (the contract) and then shows how to define new
- colors for these images by modifying the
+ images are named (the contract) and then shows how to define new colors
+ for these images by modifying the
<span class="codefrag">src/documentation/skinconf.xml</span> of a project.
</p>
<a name="N10048"></a><a name="css-files"></a>
<h3 class="underlined_5">Understand how corner images are named (the contract)</h3>
<p>
- The corner images are referenced in some .css files of the
- above-named skins; for example, in screen.css of the pelt skin:
+ The corner images are referenced in some .css files of the above-named
+ skins; for example, in screen.css of the pelt skin:
</p>
<pre class="code">
/*Example from screen.css of pelt*/
@@ -413,8 +413,8 @@
...
</pre>
<p>
- The naming follows a contract which is described below. In general,
- the naming looks like:
+ The naming follows a contract which is described below. In general, the
+ naming looks like:
</p>
<pre class="code">
images/{$name}-{$v-orientation}-{$h-orientation}-{$size}-1{$backgroundColor}-2{$strokeColor}-3{$foregroundColor}
@@ -427,8 +427,8 @@
(<span class="codefrag">-1{$backgroundColor}-2{$strokeColor}-3{$foregroundColor}</span>)
identifies the coloring of each portion of the image. The input
parameter for the second part comes from the color profile of
- <span class="codefrag">src/documentation/skinconf.xml</span>. The second part is
- easily identifiable through the numbering 1-2-3.
+ <span class="codefrag">src/documentation/skinconf.xml</span>. The second part is easily
+ identifiable through the numbering 1-2-3.
</p>
<p>
Let us get into details:
@@ -442,9 +442,7 @@
<dd>
Path to the xslt that creates the corner.
<br>
-
<span class="codefrag">images/ = {$FORREST_HOME}/main/webapp/skins/common/images/</span>
-
</dd>
<dt>
@@ -456,23 +454,18 @@
<ul>
<li>
-
<span class="codefrag">rc.svg.xslt</span>: handles rounded corners
</li>
<li>
-
<span class="codefrag">dc.svg.xslt</span>: handles diagonal 45-degree corners
</li>
</ul>
-
<span class="codefrag">name = [rc|dc]</span>
<br>
-
-<em>e.g.</em> <span class="codefrag">rc</span>
-
+<em>e.g.</em><span class="codefrag">rc</span>
</dd>
<dt>
@@ -482,13 +475,10 @@
<dd>
Vertical orientation of the corner images (top or bottom).
<br>
-
<span class="codefrag">v-orientation = [t|b]</span>
<br>
-
-<em>e.g.</em> <span class="codefrag">t</span>
-
+<em>e.g.</em><span class="codefrag">t</span>
</dd>
<dt>
@@ -498,13 +488,10 @@
<dd>
Horizontal orientation of the corner images (left or right).
<br>
-
<span class="codefrag">h-orientation = [l|r]</span>
<br>
-
-<em>e.g.</em> <span class="codefrag">r</span>
-
+<em>e.g.</em><span class="codefrag">r</span>
</dd>
<dt>
@@ -514,13 +501,10 @@
<dd>
Pixels size of the width <strong>and</strong> height of the corner image.
<br>
-
<span class="codefrag">size=x</span>
<br>
-
-<em>e.g.</em> <span class="codefrag">5</span>
-
+<em>e.g.</em><span class="codefrag">5</span>
</dd>
<dt>
@@ -531,9 +515,7 @@
Any <span class="codefrag"><color name=""/></span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
attribute will be applied).
<br>
-
-<em>e.g.</em> <span class="codefrag">header</span>
-
+<em>e.g.</em><span class="codefrag">header</span>
</dd>
<dt>
@@ -544,9 +526,7 @@
Any <span class="codefrag"><color name=""/></span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
attribute will be applied).
<br>
-
-<em>e.g.</em> <span class="codefrag">searchbox</span>
-
+<em>e.g.</em><span class="codefrag">searchbox</span>
</dd>
<dt>
@@ -557,21 +537,19 @@
Any <span class="codefrag"><color name=""/></span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
attribute will be applied).
<br>
-
-<em>e.g.</em> <span class="codefrag">searchbox</span>
-
+<em>e.g.</em><span class="codefrag">searchbox</span>
</dd>
</dl>
-<a name="N10123"></a><a name="skinconfig"></a>
+<a name="N10106"></a><a name="skinconfig"></a>
<h3 class="underlined_5">Modifying the skinconf.xml of your project</h3>
<p>
- modifying the <span class="codefrag">skinconf.xml</span> of your project (by
- default you find it at <span class="codefrag">[project-dir]/src/documentation/</span>).
+ modifying the <span class="codefrag">skinconf.xml</span> of your project (by default you
+ find it at <span class="codefrag">[project-dir]/src/documentation/</span>).
</p>
<p>
- Starting about line 155 you find a <span class="codefrag"><colors></span>
- ... <span class="codefrag"></colors></span> element with content commented-out:
+ Starting about line 155 you find a <span class="codefrag"><colors></span> ...
+ <span class="codefrag"></colors></span> element with content commented-out:
</p>
<pre class="code">
<colors>
@@ -593,10 +571,10 @@
</colors>
</pre>
<p>
- To modify the colors of the corner images, you can either define
- your own <span class="codefrag"><color name=.../></span> elements or uncomment
- one of the existing <span class="codefrag"><color name=.../></span> elements
- and adjust the color value to your needs.
+ To modify the colors of the corner images, you can either define your
+ own <span class="codefrag"><color name=.../></span> elements or uncomment one of
+ the existing <span class="codefrag"><color name=.../></span> elements and adjust
+ the color value to your needs.
</p>
<p>
@@ -607,8 +585,9 @@
<color name="tab-selected" value="#FF0000"/>
</pre>
<p>
- This affects all corner images whose <span class="codefrag">{$backgroundColor}</span>, <span class="codefrag">{$strokeColor}</span> or
- <span class="codefrag">{$foregroundColor}</span> is set to <span class="codefrag">tab-selected</span>.
+ This affects all corner images whose <span class="codefrag">{$backgroundColor}</span>,
+ <span class="codefrag">{$strokeColor}</span> or <span class="codefrag">{$foregroundColor}</span> is set to
+ <span class="codefrag">tab-selected</span>.
<br>
For example, in <span class="codefrag">screen.css</span> (of the "pelt" skin) you find:
</p>
@@ -621,15 +600,14 @@
</pre>
<p>
Now the stroke color (<span class="codefrag">-2tab-selected</span>) and the foreground
- color (<span class="codefrag">-3tab-selected</span>) are set to red (remember: we
- defined <span class="codefrag">#FF0000</span> as the "color" value of
- <span class="codefrag">tab-selected</span>).
+ color (<span class="codefrag">-3tab-selected</span>) are set to red (remember: we defined
+ <span class="codefrag">#FF0000</span> as the "color" value of <span class="codefrag">tab-selected</span>).
</p>
-<a name="N1017A"></a><a name="css_modify"></a>
+<a name="N1015D"></a><a name="css_modify"></a>
<h3 class="underlined_5">Modifying .css files</h3>
<p>
- In addition to the modification of <span class="codefrag">skinconf.xml</span>
- you can also modify the respective .css file of your skin.
+ In addition to the modification of <span class="codefrag">skinconf.xml</span> you can
+ also modify the respective .css file of your skin.
</p>
<p>
Here's another example:
@@ -654,13 +632,13 @@
</colors>
</pre>
<p>
- Here we have created our own color tags (in the .css file) and
- defined the respective values for them (in <span class="codefrag">skinconf.xml</span>).
- Now you have color images with a red background and a green
- foreground. Horrible, isn't it?
+ Here we have created our own color tags (in the .css file) and defined
+ the respective values for them (in <span class="codefrag">skinconf.xml</span>). Now you
+ have color images with a red background and a green foreground.
+ Horrible, isn't it?
</p>
</div>
-<a name="N101AA"></a><a name="Feedback"></a>
+<a name="N1018D"></a><a name="Feedback"></a>
<h2 class="underlined_10">Feedback</h2>
<div class="section">
<p>
Modified: forrest/site/docs_0_70/howto/howto-corner-images.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_70/howto/howto-corner-images.pdf?view=diff&rev=529915&r1=529914&r2=529915
==============================================================================
Binary files - no diff available.