You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2005/04/11 17:12:22 UTC
svn commit: r160902 [25/28] - in forrest/site/0.6: ./ docs/ docs/images/
dtd/ entity/ howto/ images/ skin/ skin/css/ skin/images/ skin/scripts/ skins/
Added: forrest/site/0.6/howto/howto-asf-mirror.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-asf-mirror.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/howto/howto-asf-mirror.html (added)
+++ forrest/site/0.6/howto/howto-asf-mirror.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,363 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Generate an ASF mirrors page using interactive web form (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">How-To</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../howto/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-howto.html">Write a How-to</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Download mirror</div>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-pdf-tab.html">Create tab PDF</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="howto-asf-mirror.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<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 class="abstract">Use ihtml (interpreted html) to 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 past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</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="#ihtml">Add the mirrors.ihtml to xdocs directory</a>
+</li>
+<li>
+<a href="#menu">Add a menu entry for Download</a>
+</li>
+<li>
+<a href="#link">Cause the mirrors.ithml to be processed as an extra file</a>
+</li>
+<li>
+<a href="#forrest">Run 'forrest' to build your site</a>
+</li>
+<li>
+<a href="#explain">Explanation of the process</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+
+<header>
+
+<title>Generate an ASF mirrors page using interactive web form</title>
+
+
+<a name="N10016"></a><a name="Overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>Use ihtml (interpreted html) to include html form elements
+ into a forrest-generated html page. For example, this enables building
+ automated download mirror pages for ASF project websites.
+ </p>
+</div>
+
+
+<last-modified-content-date date="2004-07-19"></last-modified-content-date>
+
+</header>
+
+
+<a name="N10021"></a><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>Also anyone interested in the use of ihtml to embed html form
+ elements into a generated Forrest page.</li>
+
+</ul>
+</div>
+
+
+<a name="N10030"></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. The processed page
+ includes html "form" elements that are not included in the xdocs DTDs.
+ </p>
+<p>This process has many exciting applications, beyond the scope of
+ this document.
+ </p>
+</div>
+
+
+<a name="N1003C"></a><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="N10056"></a><a name="Steps"></a>
+<h2 class="underlined_10">Steps</h2>
+<div class="section">
+<a name="N1005B"></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>
+<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 class="external" href="http://svn.apache.org/repos/asf/forrest/trunk/src/documentation/content/mirrors.cgi">mirrors.cgi</a>)
+ </p>
+<a name="N10071"></a><a name="ihtml"></a>
+<h3 class="underlined_5">Add the mirrors.ihtml 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 class="external" href="http://svn.apache.org/repos/asf/forrest/trunk/src/documentation/content/xdocs/mirrors.ihtml">mirrors.html</a>
+ as a template and edit it to suit.)
+ </p>
+<a name="N10085"></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>
+<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="N10093"></a><a name="link"></a>
+<h3 class="underlined_5">Cause the mirrors.ithml 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 class="external" 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
+ <span class="codefrag">$FORREST_HOME/context/WEB-INF/cli.xconf</span> to your
+ <span class="codefrag">src/documentation/conf/</span> directory (or wherever
+ ${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="N100AE"></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
+ there. Run the '<span class="codefrag">forrest</span>' command. The mirrors.html page
+ will be generated with the skin applied.
+ </p>
+<a name="N100BB"></a><a name="explain"></a>
+<h3 class="underlined_5">Explanation of the process</h3>
+<p>Forrest automatically reads ihtml files and transforms the html source
+ to the forrest xdocs intermediate format. It mainly detects heading
+ elements (h1, h2, etc.) and converts them to "sections". The remainder
+ of the html elements are copied over as-is. With this technique the
+ html form elements are copied over to the output.
+ </p>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/howto/howto-asf-mirror.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/howto/howto-asf-mirror.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-asf-mirror.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/howto/howto-asf-mirror.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/howto/howto-howto.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-howto.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/howto/howto-howto.html (added)
+++ forrest/site/0.6/howto/howto-howto.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,469 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>How to write a How-To (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">How-To</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../howto/index.html">Overview</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Write a How-to</div>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-pdf-tab.html">Create tab PDF</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="howto-howto.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<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>How to write a How-To</h1>
+<div class="abstract">This How-To describes the steps necessary to write a How-To
+ document. Writing documentation is a valuable way to give back to the
+ community.</div>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</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="#overview">Write the Overview</a>
+</li>
+<li>
+<a href="#audience">Describe your Intended Audience</a>
+</li>
+<li>
+<a href="#purpose">State the Purpose</a>
+</li>
+<li>
+<a href="#prerequisites">List any Prerequisites</a>
+</li>
+<li>
+<a href="#steps">Describe the Steps of your How-To</a>
+</li>
+<li>
+<a href="#extension">Extend the Learning</a>
+</li>
+<li>
+<a href="#summarize">Summarize the Entire Process</a>
+</li>
+<li>
+<a href="#tips">Additional Tips or FAQs</a>
+</li>
+<li>
+<a href="#references">References</a>
+</li>
+<li>
+<a href="#contribute">Submit via the project issue tracker</a>
+</li>
+<li>
+<a href="#feedback">Get some feedback</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Extension">Extension</a>
+</li>
+<li>
+<a href="#Frequently Asked Questions">Frequently Asked Questions</a>
+<ul class="minitoc">
+<li>
+<a href="#What+is+the+difference+between+a+How-To+and+a%0A++++++tutorial%3F">What is the difference between a How-To and a
+ tutorial?</a>
+</li>
+<li>
+<a href="#What+spelling+convention+should+I+follow%3F">What spelling convention should I follow?</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Tips">Tips</a>
+<ul class="minitoc">
+<li>
+<a href="#tip-dtd">How-To dtd</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#References">References</a>
+</li>
+</ul>
+</div>
+
+<header>
+
+<title>How to write a How-To</title>
+
+
+<span class="version">0.3</span>
+
+ <a name="N1001C"></a><a name="Overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>This How-To describes the steps necessary to write a How-To
+ document. Writing documentation is a valuable way to give back to the
+ community.</p>
+</div>
+
+
+<last-modified-content-date date="2004-07-18"></last-modified-content-date>
+
+</header>
+
+
+<a name="N10027"></a><a name="Intended Audience"></a>
+<h2 class="underlined_10">Intended Audience</h2>
+<div class="section">
+<p>Users who are ready to share their knowledge and experiences with the
+ community.</p>
+</div>
+
+
+<a name="N10030"></a><a name="Purpose"></a>
+<h2 class="underlined_10">Purpose</h2>
+<div class="section">
+<p>These guidelines are based on successful how-to document structures
+ used by other open source projects with diverse author groups. Following
+ these tried and true guidelines will help to insure the effectiveness of
+ your work.</p>
+</div>
+
+
+<a name="N10039"></a><a name="Prerequisites"></a>
+<h2 class="underlined_10">Prerequisites</h2>
+<div class="section">
+<p>How-To authors should have:</p>
+<ul>
+
+<li>A unique How-To topic, related to using Forrest, which fulfills a
+ specific need. Check out existing How-Tos to find a niche for your work.
+ Consider posting your idea for the How-To to user mailing list, to make
+ sure another author's draft is not already in process.</li>
+
+
+<li>A sufficient ability in English to write the FAQ. However, we would
+ rather that you just make a start, as the community can help to
+ fine-tune the document.</li>
+
+
+<li>Copy this template document "howto-howto.xml" to be modified with
+ your own content as necessary.</li>
+
+
+<li>An understanding of the How-To document structure. Just use this
+ template document and you will be safe.
+ Make sure you run '<span class="codefrag">forrest validate-xdocs</span>' before
+ contributing your document.</li>
+
+</ul>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">See the <a href="../docs/howto-v13.dtdx.html">DTD documentation</a>
+ which explains the document structure.</div>
+</div>
+</div>
+
+
+<a name="N1005B"></a><a name="Steps"></a>
+<h2 class="underlined_10">Steps</h2>
+<div class="section">
+<p>Here is how to proceed.</p>
+<a name="N10063"></a><a name="overview"></a>
+<h3 class="underlined_5">Write the Overview</h3>
+<p>An overview helps potential readers to determine quickly if a
+ particular How-To matches their interests or needs. In a few sentences,
+ summarize the main points of your How-To. Make sure to include any
+ critical definitions which will help readers evaluate the utility of
+ your How-To. Consider writing the overview last, after you have
+ completed all other sections.</p>
+<a name="N1006D"></a><a name="audience"></a>
+<h3 class="underlined_5">Describe your Intended Audience</h3>
+<p>If your How-To is targetted at a specific audience, describe it here.
+ For example, potential readers will have different levels of skill using
+ Forrest. They will also bring different areas of expertise and
+ backgrounds to their How-To learning experience. When you clarify your
+ target audience up front, you will save all other readers time and
+ confusion.</p>
+<a name="N10077"></a><a name="purpose"></a>
+<h3 class="underlined_5">State the Purpose</h3>
+<p>State the purpose of your How-To. Explain how the reader will benefit
+ by reading it. Give your reader an incentive or two to continue.</p>
+<a name="N10081"></a><a name="prerequisites"></a>
+<h3 class="underlined_5">List any Prerequisites</h3>
+<p>Inform your reader about any required knowledge, configuration, or
+ resources they may need before stepping through your How-To. Assist them
+ in this preparation by linking to other useful resources on the Forrest
+ site or the web. Helping your readers to prepare increases the
+ likelihood that they will continue reading your How-To.</p>
+<a name="N1008B"></a><a name="steps"></a>
+<h3 class="underlined_5">Describe the Steps of your How-To</h3>
+<p>In a precise, step-by-step approach, walk your reader through the
+ process. Make sure your reader can reproduce your intended result by
+ following your exact steps. Make the learning process efficient by
+ supplying sample code snippets or configuration details as
+ necessary.</p>
+<a name="N10095"></a><a name="extension"></a>
+<h3 class="underlined_5">Extend the Learning</h3>
+<p>Provide your reader with a few real-world examples of how the
+ techniques or capabilities gained from your How-To could be applied.
+ Reward the reader for successfully completing the How-To with a few
+ ideas about how it will pay off.</p>
+<a name="N1009F"></a><a name="summarize"></a>
+<h3 class="underlined_5">Summarize the Entire Process</h3>
+<p>In a few sentences, remind the reader what they have just learned.
+ This helps to reinforce the main points of your How-To.</p>
+<a name="N100A9"></a><a name="tips"></a>
+<h3 class="underlined_5">Additional Tips or FAQs</h3>
+<p>In some cases, step-by-step instructions simply aren't enough. Use
+ this section to pass on any other tips or frequently asked questions.
+ Anticipating the needs of your readers will increase the overall success
+ of your writing effort.</p>
+<a name="N100B3"></a><a name="references"></a>
+<h3 class="underlined_5">References</h3>
+<p>Remember to acknowledge any third-party resources or individuals who
+ contributed to the development of your How-To. Consider providing links
+ for those motivated readers who want to learn more.</p>
+<a name="N100BD"></a><a name="contribute"></a>
+<h3 class="underlined_5">Submit via the project issue tracker</h3>
+<p>Create an attachment for your How-To document, and submit it via the
+ project <a class="external" href="http://issues.cocoondev.org/secure/BrowseProject.jspa?id=10000">issue tracker</a>.</p>
+<a name="N100CB"></a><a name="feedback"></a>
+<h3 class="underlined_5">Get some feedback</h3>
+<p>When the committers have added your document then it will be
+ available for everyone to to build upon and enhance. Feedback will
+ happen via the <a href="../mail-lists.html">mailing lists</a>.</p>
+</div>
+
+
+<a name="N100DA"></a><a name="Extension"></a>
+<h2 class="underlined_10">Extension</h2>
+<div class="section">
+<p>Solutions can be extended to cover many different problem domains. A
+ nearly unlimited number of potential How-To topics, from simple to
+ complex, are available right now, limited only by your imagination.</p>
+</div>
+
+
+<a name="N100E3"></a><a name="Frequently Asked Questions"></a>
+<h2 class="underlined_10">Frequently Asked Questions</h2>
+<div class="section">
+<a name="N100E8"></a><a name="What+is+the+difference+between+a+How-To+and+a%0A++++++tutorial%3F"></a>
+<h3 class="underlined_5">What is the difference between a How-To and a
+ tutorial?</h3>
+<answer>
+
+<p>The goal of a How-To is to help the reader to accomplish a specific
+ task with clear and consise instructions. While tutorials may contain
+ How-To-like instructions and content, they also include additional
+ background and conceptual content to help teach their readers higher
+ order concepts along the way. How-Tos are concerned about filling an
+ immediate, short-term need. Tutorials often provide long-term
+ knowledge which can be applied across a range of needs.</p>
+
+</answer>
+<a name="N100F2"></a><a name="What+spelling+convention+should+I+follow%3F"></a>
+<h3 class="underlined_5">What spelling convention should I follow?</h3>
+<answer>
+
+<p>Use whatever spelling convention (American, British, etc.) that is
+ most intuitive to you.</p>
+
+</answer>
+</div>
+
+
+<a name="N100FD"></a><a name="Tips"></a>
+<h2 class="underlined_10">Tips</h2>
+<div class="section">
+<a name="N10102"></a><a name="tip-dtd"></a>
+<h3 class="underlined_5">How-To dtd</h3>
+<p>The document structure is likely to change soon. Please note that
+ this HOWTO page is likely to change as well.</p>
+</div>
+
+
+<a name="N1010D"></a><a name="References"></a>
+<h2 class="underlined_10">References</h2>
+<div class="section">
+<p>This is not the first, nor will it be the last, How-To on writing
+ How-Tos. For other ideas and opinions on the matter, check out the
+ following sources.</p>
+<ul>
+
+<li>Joel D. Canfield's <a class="external" href="http://www.evolt.org/article/How_To_Write_A_How_To/9741/18250/index.html">How
+ to Write a How-To</a> on evolt.org.</li>
+
+
+<li>The Linux Documentation Project's <a class="external" href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</a>
+ index page provides many excellent How-To documents to inspire your
+ efforts.</li>
+
+</ul>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/howto/howto-howto.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/howto/howto-howto.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-howto.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/howto/howto-howto.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/howto/howto-pdf-tab.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-pdf-tab.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/howto/howto-pdf-tab.html (added)
+++ forrest/site/0.6/howto/howto-pdf-tab.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,486 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>How to create a PDF document for each tab (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">How-To</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../howto/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-howto.html">Write a How-to</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Create tab PDF</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="howto-pdf-tab.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<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>How to create a PDF document for each tab</h1>
+<div class="abstract">This How-To describes the generation of a PDF document for each
+ group of documents that is defined by a tab.
+ </div>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</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="#sitemap">Create your project's main sitemap.xmap</a>
+</li>
+<li>
+<a href="#aggregator">Create the aggregator sitemap pdf-tab.xmap</a>
+</li>
+<li>
+<a href="#workaround-202">Edit project sitemap.xmap</a>
+</li>
+<li>
+<a href="#mount">Edit project sitemap.xmap to mount pdf-tab.xmap</a>
+</li>
+<li>
+<a href="#edit-aggregator">Edit the file pdf-tab.xmap</a>
+</li>
+<li>
+<a href="#edit-site">Edit your site.xml</a>
+</li>
+<li>
+<a href="#explain">Explanation of the operation</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Feedback and further development of this How-To">Feedback and further development of this How-To</a>
+</li>
+</ul>
+</div>
+
+<header>
+
+<title>How to create a PDF document for each tab</title>
+
+<a name="N10016"></a><a name="Overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>This How-To describes the generation of a PDF document for each
+ group of documents that is defined by a tab.
+ </p>
+</div>
+
+<last-modified-content-date date="2004-07-19"></last-modified-content-date>
+
+</header>
+
+
+<a name="N10021"></a><a name="Intended Audience"></a>
+<h2 class="underlined_10">Intended Audience</h2>
+<div class="section">
+<p>
+ Users who need to generate one printable document aggregated from a
+ group of documents.
+ </p>
+</div>
+
+
+<a name="N1002A"></a><a name="Purpose"></a>
+<h2 class="underlined_10">Purpose</h2>
+<div class="section">
+<p>
+ By default Forrest generates a pdf file for each separate document of
+ your project.
+ As well you can create a pdf of the whole site. But sometimes it may
+ be necessary to generate a pdf file out of selected tab, i.e. only for
+ certain parts of the site.
+ </p>
+</div>
+
+
+<a name="N10033"></a><a name="Prerequisites"></a>
+<h2 class="underlined_10">Prerequisites</h2>
+<div class="section">
+<ul>
+
+<li>Understand how to create project-specific sitemaps by following the
+ <a href="../docs/your-project.html">Using Forrest</a> document.</li>
+
+</ul>
+</div>
+
+
+<a name="N10043"></a><a name="Steps"></a>
+<h2 class="underlined_10">Steps</h2>
+<div class="section">
+<p>The procedure outlined below will define a project
+ <span class="codefrag">sitemap.xmap</span> and create a new
+ <span class="codefrag">pdf-tab.xmap</span> based on the <span class="codefrag">aggregate.xmap</span>
+
+</p>
+<a name="N10054"></a><a name="sitemap"></a>
+<h3 class="underlined_5">Create your project's main sitemap.xmap</h3>
+<p>
+ Simply copy the sitemap.xmap from the Forrest sitemaps at
+ <span class="codefrag">${FORREST_HOME}/context/sitemap.xmap</span> into your
+ <span class="codefrag">src/documentation</span> directory (or wherever
+ ${project.sitemap-dir} points to).
+ </p>
+<a name="N10064"></a><a name="aggregator"></a>
+<h3 class="underlined_5">Create the aggregator sitemap pdf-tab.xmap</h3>
+<p>
+ Copy the aggregate.xmap from Forrest sitemaps into your
+ ${project.sitemap-dir} and rename it to pdf-tab.xmap
+ </p>
+<a name="N1006E"></a><a name="workaround-202"></a>
+<h3 class="underlined_5">Edit project sitemap.xmap</h3>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+ This is a workaround for Issue FOR-202
+ </div>
+</div>
+<p>
+ Edit the project <span class="codefrag">sitemap.xmap</span> to comment-out the match
+ for the sitemap like this:
+ </p>
+<pre class="code">
+<!--
+<map:pipeline internal-only="false">
+<map:select type="exists">
+ <map:when test="{project:sitemap}">
+ <map:mount uri-prefix="" src="{project:sitemap}" check-reload="yes" />
+ </map:when>
+</map:select>
+</map:pipeline
+-->
+ </pre>
+<a name="N10082"></a><a name="mount"></a>
+<h3 class="underlined_5">Edit project sitemap.xmap to mount pdf-tab.xmap</h3>
+<p>
+ Insert the following lines after the
+ <span class="codefrag"><map:match pattern="site.xml"></span>
+ pipeline in the section called "SOURCE FORMATS".
+ </p>
+<pre class="code">
+...
+<map:match pattern="pdf-tab.xml">
+ <map:mount uri-prefix="" src="pdf-tab.xmap" check-reload="yes" />
+</map:match>
+...
+ </pre>
+<a name="N10093"></a><a name="edit-aggregator"></a>
+<h3 class="underlined_5">Edit the file pdf-tab.xmap</h3>
+<p>
+ The <span class="codefrag"><map:match pattern="*.xml"></span> element
+ should look like the following:
+ </p>
+<pre class="code">
+<map:match pattern="*.xml">
+ <map:generate src="cocoon://abs-linkmap"/>
+ <map:transform type="xpath">
+ <map:parameter name="include" value="//*[@wholesite='true']"/>
+ <map:parameter name="exclude" value="//*[@wholesite='false']"/>
+ </map:transform>
+ <map:transform src="resources/stylesheets/site2book.xsl" />
+ <map:transform src="resources/stylesheets/aggregates/book2cinclude.xsl">
+ <map:parameter name="title"
+ value="{conf:project-name}: Still My Foo Site"/>
+ </map:transform>
+ <map:transform type="cinclude"/>
+ <map:transform src="resources/stylesheets/aggregates/doc2doc-uniqueids.xsl"/>
+ <map:transform src="resources/stylesheets/aggregates/docs2document.xsl"/>
+ <map:serialize type="xml"/>
+</map:match>
+ </pre>
+<a name="N100A6"></a><a name="edit-site"></a>
+<h3 class="underlined_5">Edit your site.xml</h3>
+<p>Add the following entry to your site.xml in the
+ <span class="codefrag"><about></span> element
+ </p>
+<pre class="code">...
+<whole_foosite href="pdf-tab.html" label="sub site" />
+ </pre>
+<p>
+ Your site.xml should look like this ...
+ </p>
+<pre class="code">...
+<about label="About">
+ <index label="Index" href="index.html" description="Welcome to MyProj"/>
+ <changes label="Changes" href="changes.html"
+ description="History of Changes" />
+ <todo label="Todo" href="todo.html" description="Todo List" />
+ <whole_foosite href="pdf-tab.html" label="pdf-tab" />
+</about>
+...
+ </pre>
+<p>
+ This allows you to link to it via a
+ <span class="codefrag"><link href="site:whole_foosite"></span>
+ reference.
+ </p>
+<p>Add to every element that should be included in the pdf-tab.pdf
+ the attribute <span class="codefrag">wholesite="true"</span>
+</p>
+<pre class="code">
+<sample-wiki label="Wiki page" href="wiki-sample.html"
+ description="wiki-sample" wholesite="true"/>
+ </pre>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">This attribute will be inherited by all children of the element.
+ Do not use it in the parent element that contains the
+ <span class="codefrag"><whole_foosite href="pdf-tab.html" label="pdf-tab" /></span>
+ as the child (will cause a <span class="codefrag">stack overflow</span> if you do)!!!
+ </div>
+</div>
+<a name="N100D6"></a><a name="explain"></a>
+<h3 class="underlined_5">Explanation of the operation</h3>
+<p>
+ Line 4 of our example
+ <br>
+
+<span class="codefrag"><map:parameter name="include" value="//*[@wholesite='true']"/></span>
+ looks at your site.xml and will match every element containing the
+ <span class="codefrag">wholesite="true"</span> attribute. For example, to use the "samples"
+ tab ...
+ </p>
+<pre class="code">
+...
+<samples label="Samples" href="samples/" tab="samples" wholesite="true">
+...
+</samples>
+...
+ </pre>
+<p>
+ It matches <strong>all</strong> of the elements that contain
+ <span class="codefrag">wholesite="true"</span>
+ (in our example <span class="codefrag"><samples></span>
+ and its "children") for the content of the pdf file to be generated.
+ </p>
+<pre class="code">
+<samples label="Samples" href="samples/" tab="samples" wholesite="true">
+ <sample2 label="Static content" href="sample2.html"
+ description="More Samples" wholesite='false'/>
+ <sample-wiki label="Wiki page" href="wiki-sample.html"
+ description="wiki-sample" />
+ <sample-ihtml label="ihtml page" href="ihtml-sample.html"
+ description="Test iHTML page" />
+</samples>
+ </pre>
+<p>
+ This example shows that you can as well exclude site(s) from the aggregation
+ by using the <span class="codefrag">wholesite="false"</span> attribute. This attribute will be as well inherited
+ by all children of the element.
+ </p>
+<p>
+ Line 8 defines the title of the pdf file by taking the content
+ of the project-name variable in
+ <span class="codefrag">skinconf.xml</span> and adding some funny text:
+ <br>
+
+<span class="codefrag"><map:parameter name="title" value="{conf:project-name}: Still My Foo Site"/></span>
+
+</p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+ In the original <span class="codefrag">aggregate.xmap</span> there is the line
+ <br>
+
+<span class="codefrag"><map:parameter name="ignore" value="{1}"/></span>
+
+<br>
+ just before the title definition
+ (<span class="codefrag"><map:parameter name="title" value=".../></span>).
+ Be sure to delete it or comment it out if you like to generate a
+ pdf-file for specific sites. You only need it for the generation of
+ one pdf-file for the whole project (this is what
+ <span class="codefrag">aggregate.xmap</span> usually does).
+ </div>
+</div>
+</div>
+
+
+<a name="N10121"></a><a name="Feedback and further development of this How-To"></a>
+<h2 class="underlined_10">Feedback and further development of this How-To</h2>
+<div class="section">
+<p>
+ Please provide feedback about this document via the
+ <a href="../mail-lists.html">mailing lists</a>.
+ </p>
+<p>
+ In the future, this ability will probably be incorporated into the
+ main Forrest process.
+ </p>
+<div class="frame fixme">
+<div class="label">Fixme (open)</div>
+<div class="content">
+ This document will need to be modified when Issue FOR-202 is solved.
+ </div>
+</div>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/howto/howto-pdf-tab.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/howto/howto-pdf-tab.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/howto-pdf-tab.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/howto/howto-pdf-tab.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/howto/index.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/index.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/howto/index.html (added)
+++ forrest/site/0.6/howto/index.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,204 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Overview of the How-To documents (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">How-To</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-howto.html">Write a How-to</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-asf-mirror.html">Download mirror</a>
+</div>
+<div class="menuitem">
+<a title="" href="../howto/howto-pdf-tab.html">Create tab PDF</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="index.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<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>Overview of the How-To documents</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+
+<ul>
+
+<li>
+<a href="../howto/howto-howto.html">How to write a How-To</a>
+ - Provides instructions about writing documents. Please copy this
+ file to serve as a template for your own document.
+ </li>
+
+<li>
+<a href="../howto/howto-asf-mirror.html">Generate an ASF mirrors page using interactive web form</a>
+ - Use ihtml (interpreted html) to include html form elements
+ into a forrest-generated html page. For example, this enables building
+ automated download mirror pages for ASF project websites.
+ </li>
+
+<li>
+<a href="../howto/howto-pdf-tab.html">How to create a PDF document for each tab</a>
+ - Describes the generation of a PDF document for each
+ group of documents that is defined by a tab.
+ </li>
+
+</ul>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/check/referer"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a><a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../skin/images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a><a href="http://cocoon.apache.org/"><img border="0" title="Built with Apache Cocoon" alt="Built with Apache Cocoon - logo" src="../images/built-with-cocoon.gif" style="width: 88px;height: 31px;"></a><a href="http://www.apache.org/foundation/thanks.html"><img border="0" title="thanks to ASF, thanks from ASF" alt="thanks to ASF, thanks from ASF - logo" src="../images/icon.png" style="width: 26px;height: 22px;"></a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/howto/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/howto/index.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/howto/index.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/howto/index.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/images/add.jpg
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/add.jpg?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/add.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: forrest/site/0.6/images/apache-forrest.png
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/apache-forrest.png?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/apache-forrest.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: forrest/site/0.6/images/built-with-cocoon.gif
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/built-with-cocoon.gif?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/built-with-cocoon.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: forrest/site/0.6/images/fix.jpg
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/fix.jpg?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/fix.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: forrest/site/0.6/images/hack.jpg
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/hack.jpg?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/hack.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: forrest/site/0.6/images/icon.png
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/icon.png?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/icon.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: forrest/site/0.6/images/instruction_arrow.png
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/instruction_arrow.png?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/instruction_arrow.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: forrest/site/0.6/images/project-logo.gif
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/project-logo.gif?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/project-logo.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: forrest/site/0.6/images/remove.jpg
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/remove.jpg?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/remove.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: forrest/site/0.6/images/rss.png
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/rss.png?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/rss.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: forrest/site/0.6/images/update.jpg
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/images/update.jpg?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/images/update.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: forrest/site/0.6/index.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/index.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/index.html (added)
+++ forrest/site/0.6/index.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,474 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Welcome to Apache Forrest (v0.6)</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li class="current">
+<a class="base-selected" href="index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="docs/index.html">O.6 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">About</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Index</div>
+</div>
+<div class="menuitem">
+<a title="" href="license.html">License</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/mirrors.cgi">Download</a>
+</div>
+<div class="menuitem">
+<a title="" href="who.html">Who we are</a>
+</div>
+<div class="menuitem">
+<a title="" href="faq.html">FAQs</a>
+</div>
+<div class="menuitem">
+<a title="" href="changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a title="" href="todo.html">Todo</a>
+</div>
+<div class="menuitem">
+<a title="" href="live-sites.html">Example sites</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Related projects</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="http://gump.apache.org/">Apache Gump</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://cocoon.apache.org/">Apache Cocoon</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://cocoon.apache.org/lenya/">Apache Lenya</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://xml.apache.org/">Apache XML</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://www.apache.org/~vgritsenko/stats/">Statistics</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="index.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<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>Welcome to Apache Forrest</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#User-friendly">User-friendly</a>
+</li>
+<li>
+<a href="#Powerful">Powerful</a>
+<ul class="minitoc">
+<li>
+<a href="#Static+or+Dynamic">Static or Dynamic</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#History">History</a>
+</li>
+<li>
+<a href="#status">Project status and website status</a>
+</li>
+<li>
+<a href="#news">News and events</a>
+</li>
+<li>
+<a href="#help">Help Wanted!</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="Introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>Apache Forrest is an XML standards-oriented documentation framework
+ based upon Apache Cocoon, providing XSLT stylesheets and schemas,
+ images and other resources. Forrest uses these to render the source
+ content into a website via command-line, robot, or dynamic
+ application.
+ </p>
+</div>
+
+
+<a name="N10017"></a><a name="User-friendly"></a>
+<h2 class="underlined_10">User-friendly</h2>
+<div class="section">
+<p>
+ Forrest is designed with the new user in mind. Much effort has gone
+ into making the process of generating a new site <strong>easy</strong> and
+ <strong>simple</strong>:
+ </p>
+<ul>
+
+<li>
+<strong>Step 1</strong>: Do <span class="codefrag">'forrest seed'</span> to populate
+ the directory with template site structure and contents.</li>
+
+<li>
+<strong>Step 2</strong>: Add content by editing docs in
+ task-specific, presentation-neutral XML.</li>
+
+<li>
+<strong>Step 3</strong>: Do <span class="codefrag">'forrest run'</span> then use
+ the web browser to immediately review
+ changes at <span class="codefrag">http://localhost:8888/</span>
+
+</li>
+
+<li>
+<strong>Step 4</strong>: Do <span class="codefrag">'forrest'</span> to generate the
+ complete website from the XML sources.
+ Various styles (known as skins) are available. Custom skins
+ can be developed.</li>
+
+<li>
+<strong>Step 5</strong>: For more information about installation
+ and use, see the
+ <a href="docs/your-project.html">Using Forrest</a> guide.
+ </li>
+
+</ul>
+<p>
+ Forrest's focus on low "startup cost" makes it ideal for rapid
+ development of small sites, where time and budget constraints do not
+ allow time-wasting HTML experiments. Of course, that same methodology
+ can scale up to large projects.
+ Your development team does not need Java experience, or even XML skills,
+ to use Forrest. The framework lets you concentrate on content and design.
+ </p>
+<p>
+ By <strong>separating content from
+ presentation</strong>, providing <strong>content templates</strong>
+ and <strong>pre-written skins</strong>, Forrest is unequalled at enabling
+ content producers to get their message out fast. This separation of
+ concerns makes Forrest excellent
+ to publish <strong>project documentation</strong> (notably software projects),
+ <strong>intranets</strong>, and <strong>home pages</strong>,
+ and anything else you can think of.
+ </p>
+</div>
+
+<a name="N1006B"></a><a name="Powerful"></a>
+<h2 class="underlined_10">Powerful</h2>
+<div class="section">
+<p>
+ Forrest is far from a quick and dirty solution however. Forrest is
+ built on one of the world's leading XML application frameworks,
+ <a class="external" href="http://cocoon.apache.org/2.1/">Apache Cocoon</a>, which provides advanced
+ users with extremely powerful publishing capabilities.
+ </p>
+<ul>
+
+<li>Multiple task-specific source XML formats can be used
+ (<a href="howto/">How-To</a>,
+ <a href="faq.html"><acronym title="Frequently Asked Questions">FAQ</acronym></a>,
+ <a href="changes.html">changelogs</a> and
+ <a href="todo.html">todo lists</a> supported natively).
+ Source formats include: Apache xdocs xml format, plain html
+ documents, some Wiki formats, a subset of DocBook, ...
+ </li>
+
+<li>Multiple output formats supported, for example HTML and PDF (using
+ <a class="external" href="http://xml.apache.org/fop/">Apache FOP</a>).
+ </li>
+
+<li>SVG to PNG rendering (using <a class="external" href="http://xml.apache.org/batik/">Apache
+ Batik</a>). Simply drop the SVG in the appropriate directory
+ and it will be rendered as PNG.</li>
+
+<li>
+ Transparent inclusion and aggregation of external content, like
+ <a href="changes.rss">RSS feeds</a>.
+ </li>
+
+<li>
+ Anything else possible with the
+ <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon sitemap</a>. Using database
+ queries, <a href="http://www.apache.org/~vgritsenko/stats/index.html">charting</a>, web services
+ integration; the possibilities are constantly growing as Cocoon grows.
+ See the <a class="external" href="http://cocoon.apache.org/2.1/features.html">Cocoon Features</a> list
+ for the full suite of capabilities.
+ </li>
+
+<li>
+ Based on Java, Forrest is platform-independent, making for a
+ documentation system that is just as portable as the XML data it
+ processes.
+ </li>
+
+</ul>
+<a name="N100B7"></a><a name="Static+or+Dynamic"></a>
+<h3 class="underlined_5">Static or Dynamic</h3>
+<p>
+ Unique amongst comparable documentation tools, Forrest generates
+ sites that can run both <strong>interactively</strong> as a dynamic
+ web application, or as statically rendered pages.
+ </p>
+<p>
+ This provides a path for site growth: start off small and static, and
+ if dynamic features (user login, forms processing, runtime data, site
+ search etc) are one day needed, these can be accommodated by switching
+ to webapp mode.
+ </p>
+<p>
+ Running as a webapp has a major advantage during development:
+ content can be written, and
+ then the rendered output viewed almost instantly in a web browser.
+ This <a href="docs/your-project.html#webapp">webapp technique</a>
+ enables Forrest's edit/review cycle to be faster than command-line
+ transformation tools.
+ </p>
+</div>
+
+
+<a name="N100CF"></a><a name="History"></a>
+<h2 class="underlined_10">History</h2>
+<div class="section">
+<p>Apache Forrest was started in January 2002, with the major use-case being to
+ create a consistent and efficient
+ <a class="external" href="http://xml.apache.org/">xml.apache.org</a> group of project
+ websites with a
+ uniform, lightweight, easy-to-navigate layout and structure. In
+ addition, Forrest was to be a Sourceforge-like project management
+ tool, complementing <a class="external" href="http://gump.apache.org/">Apache Gump</a> (hence
+ the name 'Forrest').
+ </p>
+<p>
+ The focus shifted for Apache Forrest to primarily be a generic documentation
+ tool capable of meeting many needs. Certain relevant project management
+ facilities are being added.
+ </p>
+</div>
+
+
+<a name="N100E4"></a><a name="status"></a>
+<h2 class="underlined_10">Project status and website status</h2>
+<div class="section">
+<p>Apache Forrest is currently progressing rapidly through a series of 0.x
+ releases. It is certainly usable now (despite not yet being version 1.x).
+ See the growing list of
+ <a href="live-sites.html">example sites</a> including
+ Many Apache sites.
+ </p>
+<p>
+ In general, prior to 1.0, ensuring quality of design will be considered
+ more important than retaining backwards-compatibility. Users
+ (particularly those with custom sitemaps and skins) should be aware that
+ this is evolving software, and read the release notes carefully before
+ upgrading. That said, we appreciate the commitment in time that
+ adopters make, and will not make capricious or undocumented
+ backwards-incompatible changes.
+ </p>
+<p>
+ The documentation on the Apache Forrest website relates to the current
+ head development version of the source repository. Whatever version
+ of Forrest that you are using, will provide the local documentation for
+ that specific version.
+ Do '<a href="build.html#run">forrest run</a>'
+ to view it.
+ The <a href="/">Apache Forrest website</a> is updated
+ manually as needed, while we develop the
+ <a href="docs/forrestbot.html">forrestbot</a> deployment facility.
+ <!-- FIXME: It is out-of-date.
+ which produces the
+ <link href="http://forrestbot.cocoondev.org/">automatically
+ generated</link> site.
+ -->
+ </p>
+</div>
+
+<a name="N10106"></a><a name="news"></a>
+<h2 class="underlined_10">News and events</h2>
+<div class="section">
+<ul>
+
+<li>The Forrest project has evolved to become a "top-level" Apache
+ project. We are making good progress towards the 0.6 release
+ which has many efficiency and usability improvements.
+ </li>
+
+<li>Apache Forrest 0.5 was released on 2003-09-13 - much faster, new flexible
+ tab and menu system, numerous skin improvements, support for a sub-set
+ of DocBook and Wiki source formats,
+ improved PDF output, eased maintenance of sitemaps, and more.
+ </li>
+
+</ul>
+</div>
+
+<a name="N10116"></a><a name="help"></a>
+<h2 class="underlined_10">Help Wanted!</h2>
+<div class="section">
+<p>
+ Apache Forrest is fairly new, and is in need of developers. If you know (or
+ want to learn) XML, Ant, HTML or CSS, then you are qualified to help!
+ </p>
+<p>
+ As with all Apache projects, Forrest is a meritocracy; the more you
+ put in, the more you get to define the project's future. See the
+ <a href="contrib.html">"contributing"</a> page for more
+ information.
+ </p>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/check/referer"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="skin/images/vcss.png" class="logoImage"></a><a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="skin/images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a><a href="http://cocoon.apache.org/"><img border="0" title="Built with Apache Cocoon" alt="Built with Apache Cocoon - logo" src="images/built-with-cocoon.gif" style="width: 88px;height: 31px;"></a><a href="http://www.apache.org/foundation/thanks.html"><img border="0" title="thanks to ASF, thanks from ASF" alt="thanks to ASF, thanks from ASF - logo" src="images/icon.png" style="width: 26px;height: 22px;"></a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/index.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/index.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/index.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf