Author: crossley Date: Thu Oct 31 06:01:51 2013 New Revision: 1537384 URL: http://svn.apache.org/r1537384 Log: Publish from forrestbot
Modified: forrest/site/docs_0_100/changes.html forrest/site/docs_0_100/changes.rss forrest/site/docs_0_100/changes.xml forrest/site/docs_0_100/faq.html forrest/site/docs_0_100/faq.xml forrest/site/docs_0_100/howto/howto-buildPlugin.html forrest/site/dtdx/document-v13.pdf forrest/site/dtdx/document-v20.pdf Modified: forrest/site/docs_0_100/changes.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/changes.html?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/changes.html (original) +++ forrest/site/docs_0_100/changes.html Thu Oct 31 06:01:51 2013 @@ -580,6 +580,17 @@ document.write("Last Published: " + docu <a href="../docs_0_100/upgrading_010.html">upgrading to v0.10-dev</a> Committed by DC.</li> <li> +<img class="icon" alt="add" src="../images/add.jpg"> + Linked to the Wayback Machine for older versions of documentation. + See <a href="../docs_0_100/faq.html">FAQ</a>. + Committed by DC.</li> +<li> +<img class="icon" alt="update" src="../images/update.jpg"> + Improved the + "<a href="../docs_0_100/howto/howto-buildPlugin.html">How to build a Plugin</a>" + document, regarding creating your own local plugins. + Committed by DC.</li> +<li> <img class="icon" alt="update" src="../images/update.jpg"> Improved documentation about configuring project entities file, and general tips for upgrading. Modified: forrest/site/docs_0_100/changes.rss URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/changes.rss?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/changes.rss (original) +++ forrest/site/docs_0_100/changes.rss Thu Oct 31 06:01:51 2013 @@ -64,6 +64,24 @@ upgrading to v0.10-dev </description></item> + <item><title>Apache Forrest docs update</title><link>http://forrest.apache.org//changes.html</link><description>docs update + by + DC + : + + Improved the + "How to build a Plugin" + document, regarding creating your own local plugins. + </description></item> + <item><title>Apache Forrest docs add</title><link>http://forrest.apache.org//changes.html</link><description>docs add + by + DC + : + + Linked to the Wayback Machine for older versions of documentation. + See FAQ. + </description></item> + <item><title>Apache Forrest code update (bug FOR-1240) </title><link>http://forrest.apache.org//changes.html</link><description>code update @@ -6756,6 +6774,21 @@ Added document to facilitate upgrading to v0.10-dev + </description></item><item><title>Apache Forrest docs update</title><link>http://forrest.apache.org//changes.html</link><description>docs update + by + DC + : + + Improved the + "How to build a Plugin" + document, regarding creating your own local plugins. + </description></item><item><title>Apache Forrest docs add</title><link>http://forrest.apache.org//changes.html</link><description>docs add + by + DC + : + + Linked to the Wayback Machine for older versions of documentation. + See FAQ. </description></item><item><title>Apache Forrest code update (bug FOR-1240) </title><link>http://forrest.apache.org//changes.html</link><description>code update Modified: forrest/site/docs_0_100/changes.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/changes.xml?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/changes.xml (original) +++ forrest/site/docs_0_100/changes.xml Thu Oct 31 06:01:51 2013 @@ -24,6 +24,13 @@ <!-- Please keep this action at the top --> Added document to facilitate <link href="site:upgrading_010">upgrading to v0.10-dev</link> + Committed by DC.</li><li><icon alt="add" src="../images/add.jpg"/> + Linked to the Wayback Machine for older versions of documentation. + See <link href="site:faq">FAQ</link>. + Committed by DC.</li><li><icon alt="update" src="../images/update.jpg"/> + Improved the + "<link href="site:buildPlugin">How to build a Plugin</link>" + document, regarding creating your own local plugins. Committed by DC.</li><li><icon alt="update" src="../images/update.jpg"/> Improved documentation about configuring project entities file, and general tips for upgrading. Modified: forrest/site/docs_0_100/faq.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/faq.html?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/faq.html (original) +++ forrest/site/docs_0_100/faq.html Thu Oct 31 06:01:51 2013 @@ -539,38 +539,41 @@ document.write("Last Published: " + docu <a href="#general">5. General</a> <ul class="minitoc"> <li> -<a href="#generating_menus">5.1. What is the relationship between site.xml and book.xml? </a> +<a href="#wayback">5.1. Where is documentation for older versions of Forrest? </a> </li> <li> -<a href="#docbook">5.2. How do I use DocBook as the XML documentation format? </a> +<a href="#generating_menus">5.2. What is the relationship between site.xml and book.xml? </a> </li> <li> -<a href="#version">5.3. How to report which version of Forrest is being used and the properties that are +<a href="#docbook">5.3. How do I use DocBook as the XML documentation format? </a> +</li> +<li> +<a href="#version">5.4. How to report which version of Forrest is being used and the properties that are set? </a> </li> <li> -<a href="#logs">5.4. Where are the log files to find more infomation about errors? </a> +<a href="#logs">5.5. Where are the log files to find more infomation about errors? </a> </li> <li> -<a href="#verbose-ant">5.5. How to filter or reduce the standard output messages? </a> +<a href="#verbose-ant">5.6. How to filter or reduce the standard output messages? </a> </li> <li> -<a href="#coloured-ant">5.6. How to enabled coloured standard output messages? </a> +<a href="#coloured-ant">5.7. How to enabled coloured standard output messages? </a> </li> <li> -<a href="#how_can_I_help">5.7. How to help? </a> +<a href="#how_can_I_help">5.8. How to help? </a> </li> <li> -<a href="#patch">5.8. How to contribute a patch? </a> +<a href="#patch">5.9. How to contribute a patch? </a> </li> <li> -<a href="#jobs">5.9. How can job positions be advertised? </a> +<a href="#jobs">5.10. How can job positions be advertised? </a> </li> <li> -<a href="#press">5.10. Is there a press kit? Who can journalists contact?</a> +<a href="#press">5.11. Is there a press kit? Who can journalists contact?</a> </li> <li> -<a href="#security">5.11. How to report a security issue?</a> +<a href="#security">5.12. How to report a security issue?</a> </li> </ul> </li> @@ -609,6 +612,10 @@ document.write("Last Published: " + docu forrest run'. Every hour the forrestbot generates a static version of this documentation on our <a href="http://forrest.zones.apache.org/">testing zone</a>. </p> +<p> + For older versions of Forrest see the explanation + <a href="#wayback">below</a>. + </p> <a name="requirements"></a> <h3 class="underlined_5">1.4. What are the system requirements for Forrest? </h3> <p> @@ -1776,8 +1783,27 @@ X [0] /docs_0_80/upgrading_08.ht <a name="general"></a> <h2 class="underlined_10">5. General</h2> <div class="section"> +<a name="wayback"></a> +<h3 class="underlined_5">5.1. Where is documentation for older versions of Forrest? </h3> +<p> + Each version of Forrest contains its own documentation, as explained + <a href="#docs">above</a>. + </p> +<p> + The Forrest website holds + <a href="../versions/index.html">documentation</a> + for only three versions of Forrest: the immediate past release, + the current release, and the in-development version. + </p> +<p> + Thanks to the <a href="http://archive.org/">Internet Archive</a>, + the Wayback Machine holds all past documentation. + For example, the 'Upgrading notes" for + <a href="https://web.archive.org/web/*/http://forrest.apache.org/docs_0_60/upgrading_06.html">v0.6</a> and + <a href="https://web.archive.org/web/*/http://forrest.apache.org/docs_0_70/upgrading_07.html">v0.7</a> versions. + </p> <a name="generating_menus"></a> -<h3 class="underlined_5">5.1. What is the relationship between site.xml and book.xml? </h3> +<h3 class="underlined_5">5.2. What is the relationship between site.xml and book.xml? </h3> <p> One <span class="codefrag">site.xml</span> file in your project root can replace all the book.xml files (one per directory) in your site. Internally, Forrest uses <span class="codefrag">site.xml</span> to @@ -1789,7 +1815,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="../docs_0_100/linking.html">Menus and Linking</a>. </p> <a name="docbook"></a> -<h3 class="underlined_5">5.2. How do I use DocBook as the XML documentation format? </h3> +<h3 class="underlined_5">5.3. How do I use DocBook as the XML documentation format? </h3> <p> There are two ways. Forrest has a <span class="codefrag">simplifiedDocbook</span> plugin which can transform the DocBook format into the Forrest "xdocs" @@ -1899,7 +1925,7 @@ X [0] /docs_0_80/upgrading_08.ht configuration guidance. </p> <a name="version"></a> -<h3 class="underlined_5">5.3. How to report which version of Forrest is being used and the properties that are +<h3 class="underlined_5">5.4. How to report which version of Forrest is being used and the properties that are set? </h3> <p> Do <span class="codefrag">'forrest -projecthelp'</span> or <span class="codefrag">'./build.sh'</span> to @@ -1934,7 +1960,7 @@ X [0] /docs_0_80/upgrading_08.ht system. </p> <a name="logs"></a> -<h3 class="underlined_5">5.4. Where are the log files to find more infomation about errors? </h3> +<h3 class="underlined_5">5.5. Where are the log files to find more infomation about errors? </h3> <p> The logfiles are at <span class="codefrag">build/webapp/WEB-INF/logs/</span> @@ -1956,7 +1982,7 @@ X [0] /docs_0_80/upgrading_08.ht the standard output. </p> <a name="verbose-ant"></a> -<h3 class="underlined_5">5.5. How to filter or reduce the standard output messages? </h3> +<h3 class="underlined_5">5.6. How to filter or reduce the standard output messages? </h3> <p> Where normally you would do <span class="codefrag">'forrest'</span> or <span class="codefrag">'forrest run'</span> etc. instead use @@ -1970,7 +1996,7 @@ X [0] /docs_0_80/upgrading_08.ht the standard output. </p> <a name="coloured-ant"></a> -<h3 class="underlined_5">5.6. How to enabled coloured standard output messages? </h3> +<h3 class="underlined_5">5.7. How to enabled coloured standard output messages? </h3> <p> Adding colour to the forrest output messages will greatly assist readability. @@ -1997,7 +2023,7 @@ X [0] /docs_0_80/upgrading_08.ht Note that not all terminals support ANSI color codes. </p> <a name="how_can_I_help"></a> -<h3 class="underlined_5">5.7. How to help? </h3> +<h3 class="underlined_5">5.8. How to help? </h3> <p> Join one of the Forrest project <a href="../mail-lists.html">mailing lists</a> and tell us what you would like to see improved. We @@ -2006,7 +2032,7 @@ X [0] /docs_0_80/upgrading_08.ht faults that are obvious to everyone else. Don't be shy! </p> <a name="patch"></a> -<h3 class="underlined_5">5.8. How to contribute a patch? </h3> +<h3 class="underlined_5">5.9. How to contribute a patch? </h3> <p> Please send all contributions via our <a href="../issues.html">issue tracker</a>. Here are notes about @@ -2020,7 +2046,7 @@ X [0] /docs_0_80/upgrading_08.ht in. </p> <a name="jobs"></a> -<h3 class="underlined_5">5.9. How can job positions be advertised? </h3> +<h3 class="underlined_5">5.10. How can job positions be advertised? </h3> <p> Employers can send notices about employment opportunities. There is a special jobs<AT>apache.org mailing list. You can also send these @@ -2037,7 +2063,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="http://apache.org/foundation/how-it-works/legal.html">ASF Development Process</a>. </p> <a name="press"></a> -<h3 class="underlined_5">5.10. Is there a press kit? Who can journalists contact?</h3> +<h3 class="underlined_5">5.11. Is there a press kit? Who can journalists contact?</h3> <p> Press enquiries should be co-ordinated through the ASF Public Relations Committee (PRC). See <a href="http://www.apache.org/foundation/contact.html">contact</a> information. @@ -2056,7 +2082,7 @@ X [0] /docs_0_80/upgrading_08.ht Unfortunately the logo is only available as PNG. </p> <a name="security"></a> -<h3 class="underlined_5">5.11. How to report a security issue?</h3> +<h3 class="underlined_5">5.12. How to report a security issue?</h3> <p> Security and vulnerability issues are co-ordinated through the <a href="http://www.apache.org/security/">ASF Security Team</a>. Modified: forrest/site/docs_0_100/faq.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/faq.xml?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/faq.xml (original) +++ forrest/site/docs_0_100/faq.xml Thu Oct 31 06:01:51 2013 @@ -39,6 +39,10 @@ forrest run'. Every hour the forrestbot generates a static version of this documentation on our <link href="site:zone">testing zone</link>. </p> + <p> + For older versions of Forrest see the explanation + <link href="#wayback">below</link>. + </p> </section><section id="requirements"><title>1.4. What are the system requirements for Forrest? </title> <p> Forrest includes everything necessary to build and run, except of @@ -1062,7 +1066,25 @@ X [0] /docs_0_80/upgrading_08.ht of Forrest we will attempt to deal with this issue (<link href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</link>). </p> - </section></section><section id="general"><title>5. General</title><section id="generating_menus"><title>5.1. What is the relationship between <code>site.xml</code> and <code>book.xml</code>? </title> + </section></section><section id="general"><title>5. General</title><section id="wayback"><title>5.1. Where is documentation for older versions of Forrest? </title> + <p> + Each version of Forrest contains its own documentation, as explained + <link href="#docs">above</link>. + </p> + <p> + The Forrest website holds + <link href="site:versions/overview">documentation</link> + for only three versions of Forrest: the immediate past release, + the current release, and the in-development version. + </p> + <p> + Thanks to the <link href="http://archive.org/">Internet Archive</link>, + the Wayback Machine holds all past documentation. + For example, the 'Upgrading notes" for + <link href="https://web.archive.org/web/*/http://forrest.apache.org/docs_0_60/upgrading_06.html">v0.6</link> and + <link href="https://web.archive.org/web/*/http://forrest.apache.org/docs_0_70/upgrading_07.html">v0.7</link> versions. + </p> + </section><section id="generating_menus"><title>5.2. What is the relationship between <code>site.xml</code> and <code>book.xml</code>? </title> <p> One <code>site.xml</code> file in your project root can replace all the book.xml files (one per directory) in your site. Internally, Forrest uses <code>site.xml</code> to @@ -1073,7 +1095,7 @@ X [0] /docs_0_80/upgrading_08.ht where <code>site.xml</code>-generated menus aren't appropriate. See <link href="site:linking">Menus and Linking</link>. </p> - </section><section id="docbook"><title>5.2. How do I use DocBook as the XML documentation format? </title> + </section><section id="docbook"><title>5.3. How do I use DocBook as the XML documentation format? </title> <p> There are two ways. Forrest has a <code>simplifiedDocbook</code> plugin which can transform the DocBook format into the Forrest "xdocs" @@ -1182,7 +1204,7 @@ X [0] /docs_0_80/upgrading_08.ht <link href="site:your-project/new_dtd">Using Forrest</link> for configuration guidance. </p> - </section><section id="version"><title>5.3. How to report which version of Forrest is being used and the properties that are + </section><section id="version"><title>5.4. How to report which version of Forrest is being used and the properties that are set? </title> <p> Do <code>'forrest -projecthelp'</code> or <code>'./build.sh'</code> to @@ -1209,7 +1231,7 @@ X [0] /docs_0_80/upgrading_08.ht See the documentation about the new <link href="site:properties">Properties</link> system. </p> - </section><section id="logs"><title>5.4. Where are the log files to find more infomation about errors? </title> + </section><section id="logs"><title>5.5. Where are the log files to find more infomation about errors? </title> <p> The logfiles are at <code>build/webapp/WEB-INF/logs/</code> </p> @@ -1229,7 +1251,7 @@ X [0] /docs_0_80/upgrading_08.ht Doing <code>'forrest -v'</code> will provide verbose build messages to the standard output. </p> - </section><section id="verbose-ant"><title>5.5. How to filter or reduce the standard output messages? </title> + </section><section id="verbose-ant"><title>5.6. How to filter or reduce the standard output messages? </title> <p> Where normally you would do <code>'forrest'</code> or <code>'forrest run'</code> etc. instead use @@ -1242,7 +1264,7 @@ X [0] /docs_0_80/upgrading_08.ht Doing <code>'forrest -v'</code> will provide very verbose build messages to the standard output. </p> - </section><section id="coloured-ant"><title>5.6. How to enabled coloured standard output messages? </title> + </section><section id="coloured-ant"><title>5.7. How to enabled coloured standard output messages? </title> <p> Adding colour to the forrest output messages will greatly assist readability. @@ -1264,7 +1286,7 @@ X [0] /docs_0_80/upgrading_08.ht <p> Note that not all terminals support ANSI color codes. </p> - </section><section id="how_can_I_help"><title>5.7. How to help? </title> + </section><section id="how_can_I_help"><title>5.8. How to help? </title> <p> Join one of the Forrest project <link href="site:mail-lists">mailing lists</link> and tell us what you would like to see improved. We @@ -1272,7 +1294,7 @@ X [0] /docs_0_80/upgrading_08.ht newcomers—often, close proximity blinds software developers to faults that are obvious to everyone else. Don't be shy! </p> - </section><section id="patch"><title>5.8. How to contribute a patch? </title> + </section><section id="patch"><title>5.9. How to contribute a patch? </title> <p> Please send all contributions via our <link href="site:bugs">issue tracker</link>. Here are notes about @@ -1285,7 +1307,7 @@ X [0] /docs_0_80/upgrading_08.ht <link href="site:bugs">issue tracker</link> before diving in. </p> - </section><section id="jobs"><title>5.9. How can job positions be advertised? </title> + </section><section id="jobs"><title>5.10. How can job positions be advertised? </title> <p> Employers can send notices about employment opportunities. There is a special jobs<AT>apache.org mailing list. You can also send these @@ -1301,7 +1323,7 @@ X [0] /docs_0_80/upgrading_08.ht resources. See <link href="http://apache.org/foundation/how-it-works/legal.html">ASF Development Process</link>. </p> - </section><section id="press"><title>5.10. Is there a press kit? Who can journalists contact?</title> + </section><section id="press"><title>5.11. Is there a press kit? Who can journalists contact?</title> <p> Press enquiries should be co-ordinated through the ASF Public Relations Committee (PRC). See <link href="http://www.apache.org/foundation/contact.html">contact</link> information. @@ -1319,7 +1341,7 @@ X [0] /docs_0_80/upgrading_08.ht are available. Unfortunately the logo is only available as PNG. </p> - </section><section id="security"><title>5.11. How to report a security issue?</title> + </section><section id="security"><title>5.12. How to report a security issue?</title> <p> Security and vulnerability issues are co-ordinated through the <link href="http://www.apache.org/security/">ASF Security Team</link>. Modified: forrest/site/docs_0_100/howto/howto-buildPlugin.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_100/howto/howto-buildPlugin.html?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== --- forrest/site/docs_0_100/howto/howto-buildPlugin.html (original) +++ forrest/site/docs_0_100/howto/howto-buildPlugin.html Thu Oct 31 06:01:51 2013 @@ -564,12 +564,22 @@ document.write("Last Published: " + docu $PROJECT_HOME/plugins. There are a couple of changes you now need to make to the newly copied build.xml file. Open up 'build.xml' for editing. You can change the project name value to something more - suitable.Find the property name for forrest.plugins.dir and change the - location to read + suitable. Find the property name for forrest.plugins.dir and change the + location to read: </p> <pre class="code">location="."</pre> +<a name="local-plugins-descriptor"></a> +<p id="local-plugins-descriptor"> + You will also need a local "Plugins Descriptor" file. + So copy $FORREST_HOME/plugins/plugins.xml to this local plugins directory. + Edit it to remove all of the "plugin" entries, and add your own ones. + Now need to declare this in the forrest properties. + Remember that each user can have a local forrest.properties file in their home directory. + Add the "forrest.plugins.descriptors" property by copying it from the forrest.properties file of a "seed-sample" project. + Append the full path-name for your local plugins descriptor file using the "file://" protocol. + </p> <p class="instruction"> - So, revised commands for $PROJECT_HOME/plugins: + So the revised commands for the $PROJECT_HOME/plugins space, to seed a new plugin: </p> <pre class="code"> cd [path_to_project_home]/plugins @@ -619,12 +629,20 @@ document.write("Last Published: " + docu <a name="skinconf"></a> <h5>src/documentation/skinconf.xml</h5> <p> - This configures the skin for your plugins documentation. + This configures the skin for your plugin's documentation. Note that it is a minimal file, as most content is centrally configured for all ASF plugins. - Over-ride some elements if needed, e.g. see the PDF output plugin. </p> <p> - If this is not and ASF-hosted plugin, then copy the skinconf.xml from a fresh + The "project-name" element was generated during the seedPlugin phase. + Now edit that to use a sensible short name, e.g. "Plugin: FooBar Output". + (This "project-name" is used to generate the default project logo banner.) + See other plugins for relevant examples. + </p> +<p> + Over-ride some other elements if needed, e.g. see the PDF output plugin. + </p> +<p> + If this is not an ASF-hosted plugin, then copy the skinconf.xml from a fresh 'forrest seed-sample' site instead. </p> <a name="doc"></a> @@ -642,6 +660,7 @@ document.write("Last Published: " + docu src/documentation/content/xdocs/images/project-logo.png and src/documentation/content/xdocs/favicon.ico + to the same place in your plugin. </p> <a name="edit-sitemap"></a> <h3 class="underlined_5">Edit the Plugin sitemap file(s)</h3> @@ -794,11 +813,15 @@ document.write("Last Published: " + docu <a name="explain-descriptor"></a> <h4>Explanation</h4> <p> - The files plugins/plugins.xml and - whiteboard/plugins/whiteboard-plugins.xml are the "Plugins Descriptor" + The files $FORREST_HOME/plugins/plugins.xml and + $FORREST_HOME/whiteboard/plugins/whiteboard-plugins.xml + are the core "Plugins Descriptor" files. Each plugin is described with its name, purpose, location, and version information. These descriptors are deployed to the forrest website. + (If you are developing local plugins then you will have declared + additional <a href="#local-plugins-descriptor">local plugins descriptor</a> + files.) </p> <p> Each plugin has a build.xml file which defines its version Modified: forrest/site/dtdx/document-v13.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.pdf?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/document-v20.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pdf?rev=1537384&r1=1537383&r2=1537384&view=diff ============================================================================== Binary files - no diff available.