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 2006/04/19 08:01:04 UTC
svn commit: r395149 - in /forrest/site: ./ docs_0_80/
pluginDocs/plugins_0_80/
Author: crossley
Date: Tue Apr 18 23:01:02 2006
New Revision: 395149
URL: http://svn.apache.org/viewcvs?rev=395149&view=rev
Log:
Automatic publish from forrestbot
Modified:
forrest/site/doap.xml
forrest/site/docs_0_80/faq.html
forrest/site/docs_0_80/faq.pdf
forrest/site/docs_0_80/faq.xml
forrest/site/forrest-issues.html
forrest/site/forrest-issues.pdf
forrest/site/live-sites.html
forrest/site/live-sites.pdf
forrest/site/pluginDocs/plugins_0_80/usingPlugins.html
forrest/site/pluginDocs/plugins_0_80/usingPlugins.pdf
Modified: forrest/site/doap.xml
URL: http://svn.apache.org/viewcvs/forrest/site/doap.xml?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/doap.xml (original)
+++ forrest/site/doap.xml Tue Apr 18 23:01:02 2006
@@ -85,6 +85,9 @@
<doap:download-page
rdf:resource="http://forrest.apache.org/mirrors.cgi"/>
+ <doap:bug-database
+ rdf:resource="http://forrest.apache.org/issues.html"/>
+
<doap:mailing-list
rdf:resource="http://forrest.apache.org/mail-lists.html"/>
Modified: forrest/site/docs_0_80/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Tue Apr 18 23:01:02 2006
@@ -1186,8 +1186,13 @@
<p>You can configure the proxy in the <span class="codefrag">forrest.properties</span> file. Set the
<span class="codefrag">proxy.host</span> and <span class="codefrag">proxy.port</span> accordingly.</p>
<p>You can also cross an authenticated proxy by setting the <span class="codefrag">proxy.user</span> and <span class="codefrag">proxy.password</span> accordingly.</p>
+<div class="note">
+<div class="label">Generalise the proxy configuration</div>
+<div class="content">You certainly need to cross your proxy for every Forrest projects you have.
+ To avoid to edit every project <span class="codefrag">forrest.properties</span> files, you can do once in your <span class="codefrag">${user.home}/forrest.properties</span> !</div>
+</div>
</div>
-<a name="N1030C"></a><a name="CVS_revison_tags"></a>
+<a name="N10316"></a><a name="CVS_revison_tags"></a>
<h4 class="faq">3.2. How can I generate html-pages to show the revision tag of cvs?</h4>
<div align="right">
<a href="#CVS_revison_tags-menu">^</a>
@@ -1200,7 +1205,7 @@
<p>This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47
$</p>
</div>
-<a name="N1031E"></a><a name="cli-xconf"></a>
+<a name="N10328"></a><a name="cli-xconf"></a>
<h4 class="faq">3.3. How to control the processing of URIs by Cocoon, e.g. exclude certain URIs, include
other additional ones. </h4>
<div align="right">
@@ -1238,7 +1243,7 @@
<strong>foo/**</strong> to match that. </div>
</div>
</div>
-<a name="N1035B"></a><a name="ignoring_javadocs"></a>
+<a name="N10365"></a><a name="ignoring_javadocs"></a>
<h4 class="faq">3.4. How do I stop Forrest breaking on links to external files that may not exist, like
javadocs? </h4>
<div align="right">
@@ -1249,7 +1254,7 @@
<span class="codefrag">cli.xconf</span>
</a> Cocoon config file, and defining patterns for URLs to exclude. </p>
</div>
-<a name="N1036A"></a><a name="claimed_patterns"></a>
+<a name="N10374"></a><a name="claimed_patterns"></a>
<h4 class="faq">3.5. Some of my files are not being processed because they use common filenames. </h4>
<div align="right">
<a href="#claimed_patterns-menu">^</a>
@@ -1265,7 +1270,7 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N1037C"></a><a name="build_msg_a"></a>
+<a name="N10386"></a><a name="build_msg_a"></a>
<h4 class="faq">3.6. What do the symbols and numbers mean when Forrest lists each document that it has
built? </h4>
<div align="right">
@@ -1296,7 +1301,7 @@
</ul>
</div>
-<a name="N1039A"></a><a name="headless_operation"></a>
+<a name="N103A4"></a><a name="headless_operation"></a>
<h4 class="faq">3.7. When generating PNG images from SVG, I get an error: Can't connect to X11 window
server using ':0.0' as the value of the DISPLAY variable. </h4>
<div align="right">
@@ -1309,7 +1314,7 @@
<pre class="code">forrest -Dforrest.jvmargs=-Djava.awt.headless=true site</pre>
<p> See also <a href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html">Cocoon FAQ</a>. </p>
</div>
-<a name="N103B6"></a><a name="project-logo-svg"></a>
+<a name="N103C0"></a><a name="project-logo-svg"></a>
<h4 class="faq">3.8.
The project logo that is generated from SVG is truncating my project name.
</h4>
@@ -1329,7 +1334,7 @@
<a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources.
</p>
</div>
-<a name="N103CE"></a><a name="catalog"></a>
+<a name="N103D8"></a><a name="catalog"></a>
<h4 class="faq">3.9. How do i configure my favourite XML editor or parser to find the local Forrest
DTDs? </h4>
<div align="right">
@@ -1339,7 +1344,7 @@
<p> Notes are provided for various tools at <a href="../docs_0_80/catalog.html">Using Catalog Entity
Resolver for local DTDs</a>. </p>
</div>
-<a name="N103DA"></a><a name="skin"></a>
+<a name="N103E4"></a><a name="skin"></a>
<h4 class="faq">3.10. How to make the site look better and change its skin? </h4>
<div align="right">
<a href="#skin-menu">^</a>
@@ -1351,7 +1356,7 @@
<p> See notes about <a href="../docs_0_80/your-project.html#skins">configuration</a> of the skins.
Some projects may have special needs and can define their <a href="../docs_0_80/your-project.html#new_skin">own skin</a>. </p>
</div>
-<a name="N103F1"></a><a name="xsp"></a>
+<a name="N103FB"></a><a name="xsp"></a>
<h4 class="faq">3.11. How do I enable XSP processing?</h4>
<div align="right">
<a href="#xsp-menu">^</a>
@@ -1399,7 +1404,7 @@
</ol>
<p>See also the <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a> Wiki page.</p>
</div>
-<a name="N1042C"></a><a name="breadcrumbs"></a>
+<a name="N10436"></a><a name="breadcrumbs"></a>
<h4 class="faq">3.12. How do breadcrumbs work? Why don't they work locally?</h4>
<div align="right">
<a href="#breadcrumbs-menu">^</a>
@@ -1418,7 +1423,7 @@
are viewing the site locally, there is no domain and so there will be no extra
breadcrumbs, only the ones that are specified in <span class="codefrag">skinconf.xml</span>. </p>
</div>
-<a name="N10441"></a><a name="run_port"></a>
+<a name="N1044B"></a><a name="run_port"></a>
<h4 class="faq">3.13. How do I make forrest run listen on a different port?</h4>
<div align="right">
<a href="#run_port-menu">^</a>
@@ -1434,7 +1439,7 @@
</p>
</div>
-<a name="N10455"></a><a name="debugging"></a>
+<a name="N1045F"></a><a name="debugging"></a>
<h4 class="faq">3.14. Can I run Forrest with Java debugging turned on?</h4>
<div align="right">
<a href="#debugging-menu">^</a>
@@ -1446,7 +1451,7 @@
to the <span class="codefrag">forrest.jvmargs</span> property in the <span class="codefrag">forrest.properties</span>
file. Don't forget to ensure the property is uncommented in that file.</p>
</div>
-<a name="N10466"></a><a name="checksums"></a>
+<a name="N10470"></a><a name="checksums"></a>
<h4 class="faq">3.15. How do I enable Cocoon's document checksum feature?</h4>
<div align="right">
<a href="#checksums-menu">^</a>
@@ -1480,9 +1485,9 @@
installation-wide cli.xconf file.
</p>
</div>
-<a name="N10482"></a><a name="old_faqs"></a>
+<a name="N1048C"></a><a name="old_faqs"></a>
<h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N10486"></a><a name="old_claimed_patterns"></a>
+<a name="N10490"></a><a name="old_claimed_patterns"></a>
<h4 class="faq">4.1. Some of my files are not being processed because they use common filenames. </h4>
<div align="right">
<a href="#old_claimed_patterns-menu">^</a>
@@ -1498,9 +1503,9 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N10498"></a><a name="general"></a>
+<a name="N104A2"></a><a name="general"></a>
<h3 class="underlined_5">5. General</h3>
-<a name="N1049C"></a><a name="generating_menus"></a>
+<a name="N104A6"></a><a name="generating_menus"></a>
<h4 class="faq">5.1. What is the relationship between site.xml and book.xml? </h4>
<div align="right">
<a href="#generating_menus-menu">^</a>
@@ -1514,7 +1519,7 @@
<span class="codefrag">site.xml</span>-generated menus aren't appropriate. See <a href="../docs_0_80/linking.html">Menus and
Linking</a>. </p>
</div>
-<a name="N104B7"></a><a name="docbook"></a>
+<a name="N104C1"></a><a name="docbook"></a>
<h4 class="faq">5.2. How do I use DocBook as the XML documentation format? </h4>
<div align="right">
<a href="#docbook-menu">^</a>
@@ -1560,7 +1565,7 @@
different DTDs, then see <a href="../docs_0_80/your-project.html#new_dtd">Using Forrest</a> for
configuration guidance. </p>
</div>
-<a name="N104E5"></a><a name="version"></a>
+<a name="N104EF"></a><a name="version"></a>
<h4 class="faq">5.3. How to report which version of Forrest is being used and the properties that are
set? </h4>
<div align="right">
@@ -1573,7 +1578,7 @@
watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build
messages. </p>
</div>
-<a name="N104F9"></a><a name="logs"></a>
+<a name="N10503"></a><a name="logs"></a>
<h4 class="faq">5.4. Where are the log files to find more infomation about errors? </h4>
<div align="right">
<a href="#logs-menu">^</a>
@@ -1592,7 +1597,7 @@
<p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard
output. </p>
</div>
-<a name="N1051D"></a><a name="how_can_I_help"></a>
+<a name="N10527"></a><a name="how_can_I_help"></a>
<h4 class="faq">5.5. How to help? </h4>
<div align="right">
<a href="#how_can_I_help-menu">^</a>
@@ -1603,7 +1608,7 @@
particularly from newcomers—often, close proximity blinds software developers to
faults that are obvious to everyone else. Don't be shy! </p>
</div>
-<a name="N10529"></a><a name="patch"></a>
+<a name="N10533"></a><a name="patch"></a>
<h4 class="faq">5.6. How to contribute a patch? </h4>
<div align="right">
<a href="#patch-menu">^</a>
@@ -1614,7 +1619,7 @@
<p>More info about contributing can be found at the <a href="../contrib.html">Contributing
to Forrest</a> page. It is always a good idea to check the Forrest <a href="../issues.html">issue tracker</a> before diving in. </p>
</div>
-<a name="N10544"></a><a name="jobs"></a>
+<a name="N1054E"></a><a name="jobs"></a>
<h4 class="faq">5.7. How can job positions be advertised? </h4>
<div align="right">
<a href="#jobs-menu">^</a>
Modified: forrest/site/docs_0_80/faq.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.pdf?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.xml?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Tue Apr 18 23:01:02 2006
@@ -440,6 +440,8 @@
<p>You can configure the proxy in the <code>forrest.properties</code> file. Set the
<code>proxy.host</code> and <code>proxy.port</code> accordingly.</p>
<p>You can also cross an authenticated proxy by setting the <code>proxy.user</code> and <code>proxy.password</code> accordingly.</p>
+ <note label="Generalise the proxy configuration">You certainly need to cross your proxy for every Forrest projects you have.
+ To avoid to edit every project <code>forrest.properties</code> files, you can do once in your <code>${user.home}/forrest.properties</code> !</note>
</section><section id="CVS_revison_tags"><title>3.2. How can I generate html-pages to show the revision tag of cvs?</title>
<p>If you have:<code><version>$Revision: 1.30
$</version></code>The '1.30' will be extracted and
Modified: forrest/site/forrest-issues.html
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.html?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Tue Apr 18 23:01:02 2006
@@ -204,6 +204,9 @@
<a href="#%5BFOR-591%5D+MaxMemory+needs+increasing">[FOR-591] MaxMemory needs increasing</a>
</li>
<li>
+<a href="#%5BFOR-492%5D+Inconsistent+Line+Endings+in+generated+sites">[FOR-492] Inconsistent Line Endings in generated sites</a>
+</li>
+<li>
<a href="#%5BFOR-533%5D+Auto+Generate+plugins.xml+entry">[FOR-533] Auto Generate plugins.xml entry</a>
</li>
<li>
@@ -260,9 +263,6 @@
<li>
<a href="#%5BFOR-677%5D+leading+slash+in+gathered+URIs+causes+double+the+number+of+links+to+be+processed">[FOR-677] leading slash in gathered URIs causes double the number of links to be processed</a>
</li>
-<li>
-<a href="#%5BFOR-699%5D+Beginner+HowTos+for+installing+Forrest">[FOR-699] Beginner HowTos for installing Forrest</a>
-</li>
</ul>
</div>
<div class="note">
@@ -371,7 +371,45 @@
<br/>
(NB maxmemory has been increased in forrest.properties, if we resolve this issue it should be reduced again)</p>
</div>
-<a name="N1004D"></a><a name="%5BFOR-533%5D+Auto+Generate+plugins.xml+entry"></a>
+<a name="N1004D"></a><a name="%5BFOR-492%5D+Inconsistent+Line+Endings+in+generated+sites"></a>
+<h2 class="underlined_10">[FOR-492] Inconsistent Line Endings in generated sites</h2>
+<div class="section">
+<p>
+<a href="http://issues.apache.org/jira/browse/FOR-492">http://issues.apache.org/jira/browse/FOR-492</a>
+</p>
+<p>Sites generated by Forrest have inconsistent line endings when created on a Windows platform.
+<br/>
+
+<br/>
+I did a little testing, here's what I have discovered so far:
+<br/>
+&nbsp;
+<br/>
+- any file that is processed by XSLT has the line endings problem
+<br/>
+- on investigating one such file (index.html) I discovered that the generated comments from site2xhtml.xsl (such as breadtrail comment) have CRLF endings whilst most other lines have LF endings.
+<br/>
+&nbsp;
+<br/>
+I'm running on Windows, and get the same results whether I run under
+<br/>
+CYGWIN or DOS.
+<br/>
+&nbsp;
+<br/>
+To reproduce run &quot;forrest site&quot; in any site and check out the generated docs in build/site.
+<br/>
+
+<br/>
+This appears to a result of the XSLT transformations. xsl:comments retain the line endings contained in the XSL file, whilst other line endings are set to the environment default.
+<br/>
+
+<br/>
+Is there a way to tell the XSLT transformer what line endings to use?
+<br/>
+</p>
+</div>
+<a name="N10059"></a><a name="%5BFOR-533%5D+Auto+Generate+plugins.xml+entry"></a>
<h2 class="underlined_10">[FOR-533] Auto Generate plugins.xml entry</h2>
<div class="section">
<p>
@@ -387,7 +425,7 @@
<br/>
This change will require that the plugins.xml file be retrieved from the build directory rather than the plugins directory when building the plugin documentation pages. We will therefore need a fall back to retrieve this file from the network if it is not currently available - this can be done with the locationmap</p>
</div>
-<a name="N10059"></a><a name="%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode"></a>
+<a name="N10065"></a><a name="%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode"></a>
<h2 class="underlined_10">[FOR-735] Plugins are not correctly deployed in webapp mode</h2>
<div class="section">
<p>
@@ -403,7 +441,7 @@
<br/>
- the pdf links give an error &quot;Resource Not Found&quot;</p>
</div>
-<a name="N10065"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
+<a name="N10071"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
<h2 class="underlined_10">[FOR-711] Cache results from the Locationmap</h2>
<div class="section">
<p>
@@ -419,7 +457,7 @@
<br/>
If we test all locationmaps and find no result we should record that tere is no result in this hashmap. This will also be a good place to throw an exception so that Cocoon can better report such errors (see <a href="http://issues.apache.org/jira/browse/FOR-701" title="Missing locationmap entry gives poor error">FOR-701</a>)</p>
</div>
-<a name="N10071"></a><a name="%5BFOR-707%5D+Document+i18n+features+of+Forrest"></a>
+<a name="N1007D"></a><a name="%5BFOR-707%5D+Document+i18n+features+of+Forrest"></a>
<h2 class="underlined_10">[FOR-707] Document i18n features of Forrest</h2>
<div class="section">
<p>
@@ -439,7 +477,7 @@
<br/>
We could, at the very least use the locationmap to pull this content into our site [OT: I wonder if this could be a way to generate more documentation?)</p>
</div>
-<a name="N1007D"></a><a name="%5BFOR-388%5D+Use+plugins+in-place+if+src+available"></a>
+<a name="N10089"></a><a name="%5BFOR-388%5D+Use+plugins+in-place+if+src+available"></a>
<h2 class="underlined_10">[FOR-388] Use plugins in-place if src available</h2>
<div class="section">
<p>
@@ -455,7 +493,7 @@
<br/>
</p>
</div>
-<a name="N10089"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
+<a name="N10095"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
<h2 class="underlined_10">[FOR-742] trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo</h2>
<div class="section">
<p>
@@ -469,7 +507,7 @@
<br/>
<a href="http://marc.theaimsgroup.com/?t=113176328300002">http://marc.theaimsgroup.com/?t=113176328300002</a></p>
</div>
-<a name="N10095"></a><a name="%5BFOR-639%5D+define+terminology+for+the+various+aspects+of+Dispatcher"></a>
+<a name="N100A1"></a><a name="%5BFOR-639%5D+define+terminology+for+the+various+aspects+of+Dispatcher"></a>
<h2 class="underlined_10">[FOR-639] define terminology for the various aspects of Dispatcher</h2>
<div class="section">
<p>
@@ -481,7 +519,7 @@
<br/>
</p>
</div>
-<a name="N100A1"></a><a name="%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes"></a>
+<a name="N100AD"></a><a name="%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes"></a>
<h2 class="underlined_10">[FOR-241] character entities (e.g. ampersand) are expanded again for href or src attributes</h2>
<div class="section">
<p>
@@ -527,7 +565,7 @@
<br/>
the ampersand in the link href attribute is not.</p>
</div>
-<a name="N100AD"></a><a name="%5BFOR-211%5D+whole-site+html+and+pdf%3A+broken+ext+links"></a>
+<a name="N100B9"></a><a name="%5BFOR-211%5D+whole-site+html+and+pdf%3A+broken+ext+links"></a>
<h2 class="underlined_10">[FOR-211] whole-site html and pdf: broken ext links</h2>
<div class="section">
<p>
@@ -535,7 +573,7 @@
</p>
<p>In the the generated site.html all of the external links are broken (i.e. the href attributes are like ... error:#ext:forrest).</p>
</div>
-<a name="N100B9"></a><a name="%5BFOR-210%5D+whole-site+html+and+pdf%3A+broken+link+faq%2C+broken+image+links"></a>
+<a name="N100C5"></a><a name="%5BFOR-210%5D+whole-site+html+and+pdf%3A+broken+link+faq%2C+broken+image+links"></a>
<h2 class="underlined_10">[FOR-210] whole-site html and pdf: broken link faq, broken image links</h2>
<div class="section">
<p>
@@ -545,7 +583,7 @@
<br/>
</p>
</div>
-<a name="N100C5"></a><a name="%5BFOR-209%5D+First+level+selected+tab+is+not+highlighted+when+containing+2nd+level+tabs"></a>
+<a name="N100D1"></a><a name="%5BFOR-209%5D+First+level+selected+tab+is+not+highlighted+when+containing+2nd+level+tabs"></a>
<h2 class="underlined_10">[FOR-209] First level selected tab is not highlighted when containing 2nd level tabs</h2>
<div class="section">
<p>
@@ -559,7 +597,7 @@
<br/>
</p>
</div>
-<a name="N100D1"></a><a name="%5BFOR-203%5D+2nd+level+tabs+are+not+selected+appropriately"></a>
+<a name="N100DD"></a><a name="%5BFOR-203%5D+2nd+level+tabs+are+not+selected+appropriately"></a>
<h2 class="underlined_10">[FOR-203] 2nd level tabs are not selected appropriately</h2>
<div class="section">
<p>
@@ -581,7 +619,7 @@
<br/>
&nbsp;&nbsp;Lorenz Froihofer.</p>
</div>
-<a name="N100DD"></a><a name="%5BFOR-200%5D+Locationmap+for+Forrest+and+Users"></a>
+<a name="N100E9"></a><a name="%5BFOR-200%5D+Locationmap+for+Forrest+and+Users"></a>
<h2 class="underlined_10">[FOR-200] Locationmap for Forrest and Users</h2>
<div class="section">
<p>
@@ -593,7 +631,7 @@
<br/>
Beware that it will not work for raw files that are not linked, as this &quot;feature&quot; currently uses a fixed dir being being copied by Ant.</p>
</div>
-<a name="N100E9"></a><a name="%5BFOR-546%5D+Sitemap+reference+doc+should+be+updated+to+reflect+plugin+architecture"></a>
+<a name="N100F5"></a><a name="%5BFOR-546%5D+Sitemap+reference+doc+should+be+updated+to+reflect+plugin+architecture"></a>
<h2 class="underlined_10">[FOR-546] Sitemap reference doc should be updated to reflect plugin architecture</h2>
<div class="section">
<p>
@@ -625,7 +663,7 @@
<br/>
I found out about this because my sitemap uses the fo2pdf too (docbook to PDF), and had to add the serializer.</p>
</div>
-<a name="N100F5"></a><a name="%5BFOR-560%5D+Remove+duplicate+jars+from+eclipse+plugins"></a>
+<a name="N10101"></a><a name="%5BFOR-560%5D+Remove+duplicate+jars+from+eclipse+plugins"></a>
<h2 class="underlined_10">[FOR-560] Remove duplicate jars from eclipse plugins</h2>
<div class="section">
<p>
@@ -633,7 +671,7 @@
</p>
<p>tools/eclipse/plugins/org.apache.forrest.eclipse.servletEngine/lib contains some duplicate jars to those in the main Forrest trunk. We should find a way of reusing the jars from their existing location.</p>
</div>
-<a name="N10101"></a><a name="%5BFOR-562%5D+Update+Plugins+howto"></a>
+<a name="N1010D"></a><a name="%5BFOR-562%5D+Update+Plugins+howto"></a>
<h2 class="underlined_10">[FOR-562] Update Plugins howto</h2>
<div class="section">
<p>
@@ -661,7 +699,7 @@
<br/>
</p>
</div>
-<a name="N1010D"></a><a name="%5BFOR-726%5D+use+locationmap+in+all+of+the+plugins"></a>
+<a name="N10119"></a><a name="%5BFOR-726%5D+use+locationmap+in+all+of+the+plugins"></a>
<h2 class="underlined_10">[FOR-726] use locationmap in all of the plugins</h2>
<div class="section">
<p>
@@ -673,7 +711,7 @@
<br/>
(Perhaps we need Jira sub-tasks for each plugin.)</p>
</div>
-<a name="N10119"></a><a name="%5BFOR-721%5D+entries+without+labels+in+site.xml+are+now+being+crawled+and+generated"></a>
+<a name="N10125"></a><a name="%5BFOR-721%5D+entries+without+labels+in+site.xml+are+now+being+crawled+and+generated"></a>
<h2 class="underlined_10">[FOR-721] entries without labels in site.xml are now being crawled and generated</h2>
<div class="section">
<p>
@@ -685,7 +723,7 @@
<br/>
This is most likely a side-effect of the workaround for issue <a href="http://issues.apache.org/jira/browse/FOR-675" title="upgrading to commons-jxpath-1.2.jar causes failures with linkrewriter protocols site: etc.">FOR-675</a></p>
</div>
-<a name="N10125"></a><a name="%5BFOR-677%5D+leading+slash+in+gathered+URIs+causes+double+the+number+of+links+to+be+processed"></a>
+<a name="N10131"></a><a name="%5BFOR-677%5D+leading+slash+in+gathered+URIs+causes+double+the+number+of+links+to+be+processed"></a>
<h2 class="underlined_10">[FOR-677] leading slash in gathered URIs causes double the number of links to be processed</h2>
<div class="section">
<p>
@@ -704,14 +742,6 @@
<br/>
However, we do have a sitemap transformer to &quot;relativize&quot; and &quot;absolutize&quot; the links. Should it always trim the leading slash? Or are there cases where that should not happen, so cannot generalise?</p>
-</div>
-<a name="N10131"></a><a name="%5BFOR-699%5D+Beginner+HowTos+for+installing+Forrest"></a>
-<h2 class="underlined_10">[FOR-699] Beginner HowTos for installing Forrest</h2>
-<div class="section">
-<p>
-<a href="http://issues.apache.org/jira/browse/FOR-699">http://issues.apache.org/jira/browse/FOR-699</a>
-</p>
-<p>These are a whole group of HowTos that I wrote for my local users (probably a tutorial would be a better format). They are not complete, nor tidied at this point, but they cover a lot of basic step-by-step stuff specifically geared towards Linux with Gnome desktop and Windows XP. Figured I would put them out there so we can pull out bits we may want to use.</p>
</div>
</div>
<!--+
Modified: forrest/site/forrest-issues.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.pdf?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/live-sites.html
URL: http://svn.apache.org/viewcvs/forrest/site/live-sites.html?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/live-sites.html (original)
+++ forrest/site/live-sites.html Tue Apr 18 23:01:02 2006
@@ -472,13 +472,21 @@
<a href="http://www.solvkroken.no/ekat/produkter/HK_00/">Produktkatalog for Sølvkroken</a>
- biggest supplier of sports fishing equipment in Norway, with export all over the world.
</li>
+
+<li>
+<a href="http://www.apwebco.com">Design Patterns</a> - GoF Design Patterns Tutorial</li>
+
+<li>
+<a href="http://www.usefuldomains.co.uk">Generic Domain
+ Names</a> - Domain sales site specialising in industrial, business
+ and home themed generic domains.</li>
<!-- <li><link href=""></link></li> -->
</ul>
</div>
-<a name="N101A7"></a><a name="dispatcher"></a>
+<a name="N101B3"></a><a name="dispatcher"></a>
<h2 class="underlined_10">Sites using upcoming Dispatcher</h2>
<div class="section">
<p>The skinning system in versions of Forrest up to and including 0.7 was great,
Modified: forrest/site/live-sites.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/live-sites.pdf?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/pluginDocs/plugins_0_80/usingPlugins.html
URL: http://svn.apache.org/viewcvs/forrest/site/pluginDocs/plugins_0_80/usingPlugins.html?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/usingPlugins.html (original)
+++ forrest/site/pluginDocs/plugins_0_80/usingPlugins.html Tue Apr 18 23:01:02 2006
@@ -177,14 +177,14 @@
<li>
<a href="#sources">Where does Forrest look for Plugins sources ?</a>
</li>
+</ul>
+</li>
<li>
<a href="#local-deploy">Editing plugins sources to enhance functionality</a>
</li>
<li>
<a href="#no-plugins">Upgrading from a Version of Forrest Without Plugins</a>
</li>
-</ul>
-</li>
<li>
<a href="#conflict">Avoiding Plugin Conflicts</a>
</li>
@@ -209,17 +209,17 @@
<p>If you would like to have your own plugin added to this list then
contact the <a href="../../mail-lists.html">developer mailing list</a>.</p>
</div>
-
+
<a name="N1002B"></a><a name="install"></a>
<h2 class="underlined_10">How is a Plugin Installed?</h2>
<div class="section">
<a name="N10031"></a><a name="required"></a>
<h3 class="underlined_5">List of Plugins Needed by the Project</h3>
-<p>If a site requires one or more plugins then the site designer will
- have to list them in the <span class="codefrag">project.required.plugins</span> property
- in the projects <span class="codefrag">forrest.properties</span> file. When Forrest
- builds the site it will automatically discover the plugins and install
+<p>If a site requires one or more plugins then the site designer will
+ have to list them in the <span class="codefrag">project.required.plugins</span> property
+ in the projects <span class="codefrag">forrest.properties</span> file. When Forrest
+ builds the site it will automatically discover the plugins and install
them. In otherwords, the user needs do nothing.</p>
<p>For example,</p>
<pre class="code">project.required.plugins=org.apache.forrest.plugin.input.OpenOffice.org,org.apache.forrest.plugin.input.simplifiedDocbook</pre>
@@ -229,7 +229,7 @@
<div class="note">
<div class="label">Note</div>
<div class="content">By default a new forrest project has that property configured
- to include some plugins. Currently there is only one to generate
+ to include some plugins. Currently there is only one to generate
PDF output from your source documents.</div>
</div>
<a name="N1004E"></a><a name="version"></a>
@@ -237,26 +237,51 @@
<p>In the absence of a version number for the plugin (as is the case in the example above)
the most recent version that is applicabe to your release of Forrest will be used. This
may result in unexpected behaviour if a new version of the plugin has been released that
- is incompatible with your current site. To force Forrest into using a specific version of
+ is incompatible with your current site. To force Forrest into using a specific version of
a plugin you should add "-VERSION_NUMBER" to the end of the plugin name. For example,
to force forrest to use the 1.0 version of the OpenOffice.org plugin you would use
<span class="codefrag">org.apache.forrest.plugin.input.OpenOffice.org-1.0</span>. If you define a version of the
- plugin that does not exist then it will fall back to using the most recent version avialable.
- This feature is useful when
- developing a new site as you can quickly force a plugin upgrade by deleting all installed
+ plugin that does not exist then it will fall back to using the most recent version available.
+ This feature is useful when
+ developing a new site as you can quickly force a plugin upgrade by deleting all installed
plugins (use the command 'ant cleanPlugins'). However, this might result in the installation
of an in-development plugin, therefore in a production environment you should always specify
a known working version.</p>
<a name="N1005B"></a><a name="sources"></a>
<h3 class="underlined_5">Where does Forrest look for Plugins sources ?</h3>
+<p>Forrest uses a fall back mecanism to find the plugins to install for a project.</p>
+<p>For an unversionned plugin, Forrest tries to get it from :</p>
+<ol>
+
+<li>different local sources directories (<span class="codefrag">project.required.plugins.src</span> property)</li>
+
+<li>if not found : the remote site in the forrest version directory</li>
+
+<li>if not found : the remote site (with no forrest version directory)</li>
+
+</ol>
+<p>For a versionned plugin, Forrest tries to get :</p>
+<ol>
+
+<li>the versionned plugin from different local sources directories (<span class="codefrag">project.required.plugins.src</span> property)</li>
+
+<li>if not found : the versionned plugin from the remote site in the forrest version directory</li>
+
+<li>if not found : the unversionned plugin in different local sources directory (<span class="codefrag">project.required.plugins.src</span> property again)</li>
+
+<li>if not found : the unversionned plugin from the remote site in the forrest version directory</li>
+
+<li>if not found : the remote site (with no forrest version directory)</li>
+
+</ol>
<p>By default, forrest looks into the two following directories to find plugins sources : <span class="codefrag">${forrest.home}/plugins</span> and <span class="codefrag">${forrest.home}/whiteboard/plugins</span>.
- It is possible to add other sources locations by specifying the <span class="codefrag">project.required.plugins.src</span> property
+ It is possible to add other sources locations by specifying the <span class="codefrag">project.required.plugins.src</span> property
in the projects <span class="codefrag">forrest.properties</span> file.</p>
<p>For example,</p>
<pre class="code">project.required.plugins.src=${forrest.home}/plugins,${forrest.home}/whiteboard/plugins,${project.home}/plugins</pre>
<p>
will add the project specific directory <span class="codefrag">${project.home}/plugins</span> to the list of directories to search in.</p>
-<p>if sources are not found, forrest will try to get them from the Web. Forrest <em>knows</em> the plugins description with plugins descriptors files
+<p>If sources are not found, forrest will try to get them from the Web. Forrest <em>knows</em> the plugins description with plugins descriptors files
in which plugins are described as follows :</p>
<pre class="code"><plugin name="org.apache.forrest.plugin.output.pdf"
type="output"
@@ -265,68 +290,74 @@
url="http://forrest.apache.org/plugins/"
version="0.2">
<description>
- Enable Forrest documents to be output in PDF format.
+ Enable Forrest documents to be output in PDF format.
</description>
<forrestVersion>0.8</forrestVersion>
</plugin></pre>
<p>The url to download the different plugins is indicated in this file.</p>
<p>By default, forrest gets the two following plugins descriptors files : <span class="codefrag">http://forrest.apache.org/plugins/plugins.xml</span> and <span class="codefrag">http://forrest.apache.org/plugins/whiteboard-plugins.xml</span>.
- It is possible to add other plugins descriptors files by specifying the <span class="codefrag">forrest.plugins.descriptors</span> property
+ It is possible to add other plugins descriptors files by specifying the <span class="codefrag">forrest.plugins.descriptors</span> property
in the projects <span class="codefrag">forrest.properties</span> file.</p>
<p>For example,</p>
<pre class="code">forrest.plugins.descriptors=http://forrest.apache.org/plugins/plugins.xml,http://forrest.apache.org/plugins/whiteboard-plugins.xml,file:///${project.home}/plugins/plugins.xml</pre>
<p>
will add the project specific plugins descriptors file <span class="codefrag">file:///${project.home}/plugins/plugins.xml</span> to the list of descriptors.</p>
-<a name="N100A7"></a><a name="local-deploy"></a>
-<h3 class="underlined_5">Editing plugins sources to enhance functionality</h3>
+</div>
+
+<a name="N100D8"></a><a name="local-deploy"></a>
+<h2 class="underlined_10">Editing plugins sources to enhance functionality</h2>
+<div class="section">
<p>
- Until issue
- <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
- is fixed to enable the use of plugins in-place, any changes to
- sources need to be locally deployed.
- See <a href="#more">Further reading</a> for "How to build a Plugin".
- </p>
-<a name="N100B9"></a><a name="no-plugins"></a>
-<h3 class="underlined_5">Upgrading from a Version of Forrest Without Plugins</h3>
+ Until issue
+ <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
+ is fixed to enable the use of plugins in-place, any changes to
+ sources need to be locally deployed.
+ See <a href="#more">Further reading</a> for "How to build a Plugin".
+ </p>
+</div>
+
+<a name="N100EA"></a><a name="no-plugins"></a>
+<h2 class="underlined_10">Upgrading from a Version of Forrest Without Plugins</h2>
+<div class="section">
<p>The plugin functionality was introduced in version 0.7 of Forrest.
- At this time some of the functionality previously in Forrest was
- extracted into a plugin. However, we have not broken backward
- compatability with earlier versions. In the absence of a
- <span class="codefrag">project.required.plugins</span> property in the projects
- <span class="codefrag">forrest.properties</span> file all plugins that contain
- functionality previously part of Forrest itself will be loaded
- automatically. Unless you intend to use new functionality provided
- by a plugin you will not need to make any changes top your project.</p>
+ At this time some of the functionality previously in Forrest was
+ extracted into a plugin. However, we have not broken backward
+ compatability with earlier versions. In the absence of a
+ <span class="codefrag">project.required.plugins</span> property in the projects
+ <span class="codefrag">forrest.properties</span> file all plugins that contain
+ functionality previously part of Forrest itself will be loaded
+ automatically. Unless you intend to use new functionality provided
+ by a plugin you will not need to make any changes to your project.</p>
<p>If you do require additional plugin functionality, be sure to
- include all required plugins in the
- <span class="codefrag">project.required.plugins</span> property in the project's
- <span class="codefrag">forrest.properties</span>. You can view
- <span class="codefrag">main/webapp/default-forrest.properties</span>
- to see the names of plugins that provide previously core
- functionality.</p>
-<p>It is also worth noting that there is a small performance
- improvement if you remove plugins that are not in use. Therefore,
- if you do not use one or more of the plugins named in the
- <span class="codefrag">project.required.plugins</span> property of
- <span class="codefrag">main/webapp/default-forrest.properties</span>
- it is recomended that you override this value in your project's
- <span class="codefrag">forrest.properties</span> file.</p>
+ include all required plugins in the
+ <span class="codefrag">project.required.plugins</span> property in the project's
+ <span class="codefrag">forrest.properties</span>. You can view
+ <span class="codefrag">main/webapp/default-forrest.properties</span>
+ to see the names of plugins that provide previously core
+ functionality.</p>
+<p>It is also worth noting that there is a small performance
+ improvement if you remove plugins that are not in use. Therefore,
+ if you do not use one or more of the plugins named in the
+ <span class="codefrag">project.required.plugins</span> property of
+ <span class="codefrag">main/webapp/default-forrest.properties</span>
+ it is recomended that you override this value in your project's
+ <span class="codefrag">forrest.properties</span> file.</p>
</div>
+
-
-<a name="N100E2"></a><a name="conflict"></a>
+<a name="N10112"></a><a name="conflict"></a>
<h2 class="underlined_10">Avoiding Plugin Conflicts</h2>
<div class="section">
-<p>Clashes between plugins can occur. For example, the simplified-docbook
- and full docbook plugins may try and process the same files. In this
- instance the one that is mounted first will take precedence. Plugins
- are mounted in the order they appear in the
- <span class="codefrag">project.required.plugins</span> property, therefore the mounting
+<p>Clashes between plugins can occur. For example, the simplified-docbook
+ and full docbook plugins may try and process the same files. In this
+ instance the one that is mounted first will take precedence. Plugins
+ are mounted in the order they appear in the
+ <span class="codefrag">project.required.plugins</span> property, therefore the mounting
order and therefore processing precedence is under user control.</p>
</div>
+
-
-<a name="N100EF"></a><a name="more"></a>
+<a name="N1011F"></a><a name="more"></a>
<h2 class="underlined_10">Further Reading</h2>
<div class="section">
<ul>
Modified: forrest/site/pluginDocs/plugins_0_80/usingPlugins.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/pluginDocs/plugins_0_80/usingPlugins.pdf?rev=395149&r1=395148&r2=395149&view=diff
==============================================================================
Binary files - no diff available.