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/03/04 05:13:05 UTC
svn commit: r383021 - in /forrest/site: docs_0_70/faq.html docs_0_70/faq.pdf
docs_0_70/faq.xml docs_0_70/primer.pdf docs_0_80/faq.html docs_0_80/faq.pdf
docs_0_80/faq.xml forrest-issues.html forrest-issues.pdf
Author: crossley
Date: Fri Mar 3 20:13:03 2006
New Revision: 383021
URL: http://svn.apache.org/viewcvs?rev=383021&view=rev
Log:
Automatic publish from forrestbot
Modified:
forrest/site/docs_0_70/faq.html
forrest/site/docs_0_70/faq.pdf
forrest/site/docs_0_70/faq.xml
forrest/site/docs_0_70/primer.pdf
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
Modified: forrest/site/docs_0_70/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/faq.html?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
--- forrest/site/docs_0_70/faq.html (original)
+++ forrest/site/docs_0_70/faq.html Fri Mar 3 20:13:03 2006
@@ -319,26 +319,32 @@
<a href="#getting_started">1. Getting Started and Building Forrest</a>
<ul class="minitoc">
<li>
-<a href="#overview">1.1. Where can I read an overview about how to work with Forrest? </a>
+<a href="#faq">1.1. How to use these FAQs? </a>
</li>
<li>
-<a href="#requirements">1.2. What are the system requirements for Forrest? </a>
+<a href="#overview">1.2. Where can I read an overview about how to work with Forrest? </a>
</li>
<li>
-<a href="#cvs">1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </a>
+<a href="#requirements">1.3. What are the system requirements for Forrest? </a>
</li>
<li>
-<a href="#svn">1.4. How can I use SVN to keep up to date with the latest codebase? </a>
+<a href="#cvs">1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </a>
</li>
<li>
-<a href="#single-document">1.5. What is the best way to generate "standalone documents" using Forrest? </a>
+<a href="#svn">1.5. How can I use SVN to keep up to date with the latest codebase? </a>
</li>
<li>
-<a href="#cygwin_mutex_error">1.6. When running ./build.sh in cygwin, I get an error: cygpath.exe:
+<a href="#older-plugins">1.6. How to use older versions of specific plugins? </a>
+</li>
+<li>
+<a href="#single-document">1.7. What is the best way to generate "standalone documents" using Forrest? </a>
+</li>
+<li>
+<a href="#cygwin_mutex_error">1.8. When running ./build.sh in cygwin, I get an error: cygpath.exe:
*** can't create title mutex, Win32 error 6. </a>
</li>
<li>
-<a href="#maxmemory">1.7. How can I specify the amount of memory to be used by Java? </a>
+<a href="#maxmemory">1.9. How can I specify the amount of memory to be used by Java? </a>
</li>
</ul>
</li>
@@ -498,16 +504,27 @@
<div class="section">
<a name="N1000C"></a><a name="getting_started"></a>
<h3 class="underlined_5">1. Getting Started and Building Forrest</h3>
-<a name="N10010"></a><a name="overview"></a>
-<h4 class="faq">1.1. Where can I read an overview about how to work with Forrest? </h4>
+<a name="N10010"></a><a name="faq"></a>
+<h4 class="faq">1.1. How to use these FAQs? </h4>
+<div align="right">
+<a href="#faq-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+ There is no particular order to these FAQs. Use your browser's
+ "Find in this page" facility to search for keywords.
+ </p>
+</div>
+<a name="N10018"></a><a name="overview"></a>
+<h4 class="faq">1.2. Where can I read an overview about how to work with Forrest? </h4>
<div align="right">
<a href="#overview-menu">^</a>
</div>
<div style="margin-left: 15px">
<p> See the <a href="../docs_0_70/your-project.html">Using Forrest</a> guide. </p>
</div>
-<a name="N1001C"></a><a name="requirements"></a>
-<h4 class="faq">1.2. What are the system requirements for Forrest? </h4>
+<a name="N10024"></a><a name="requirements"></a>
+<h4 class="faq">1.3. What are the system requirements for Forrest? </h4>
<div align="right">
<a href="#requirements-menu">^</a>
</div>
@@ -522,8 +539,8 @@
with Subversion or use a source snapshot) then you need the full JDK.
</p>
</div>
-<a name="N10027"></a><a name="cvs"></a>
-<h4 class="faq">1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </h4>
+<a name="N1002F"></a><a name="cvs"></a>
+<h4 class="faq">1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </h4>
<div align="right">
<a href="#cvs-menu">^</a>
</div>
@@ -531,8 +548,8 @@
<p> Forrest switched from a CVS code repository to SVN (Subversion) code repository. The old
CVS repository is closed and not kept current. </p>
</div>
-<a name="N1002F"></a><a name="svn"></a>
-<h4 class="faq">1.4. How can I use SVN to keep up to date with the latest codebase? </h4>
+<a name="N10037"></a><a name="svn"></a>
+<h4 class="faq">1.5. How can I use SVN to keep up to date with the latest codebase? </h4>
<div align="right">
<a href="#svn-menu">^</a>
</div>
@@ -541,8 +558,38 @@
<p> The <a href="../docs_0_70/your-project.html">Using Forrest</a> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
</div>
-<a name="N10042"></a><a name="single-document"></a>
-<h4 class="faq">1.5. What is the best way to generate "standalone documents" using Forrest? </h4>
+<a name="N1004A"></a><a name="older-plugins"></a>
+<h4 class="faq">1.6. How to use older versions of specific plugins? </h4>
+<div align="right">
+<a href="#older-plugins-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+ Sometimes one does not want to use the most recent functionality
+ of a plugin and instead need to use an older version.
+ Information about changes to each plugin can be found in its
+ <a href="../pluginDocs/plugins_0_70/index.html">documentation</a>.
+ </p>
+<p>
+ In the forrest.properties file, specify the version of the plugin
+ that you require, e.g.
+ </p>
+<pre class="code">project.required.plugins=org.apache.forrest.plugin.input.PhotoGallery-0.1,...</pre>
+<p>
+ Users of Forrest-0.7 will need to do this for the projectInfo plugin
+ if you get the following error ...
+ </p>
+<pre class="code">Could not find component for role:
+ [org.apache.cocoon.components.modules.input.InputModule/lm]
+ (Key='org.apache.cocoon.components.modules.input.InputModule/</pre>
+<p>
+ ... then sorry, we mistakenly added new "locationmap" functionality
+ (due in version 0.8). So do this ...
+ </p>
+<pre class="code">project.required.plugins=org.apache.forrest.plugin.input.projectInfo-0.1,...</pre>
+</div>
+<a name="N1006B"></a><a name="single-document"></a>
+<h4 class="faq">1.7. What is the best way to generate "standalone documents" using Forrest? </h4>
<div align="right">
<a href="#single-document-menu">^</a>
</div>
@@ -551,8 +598,8 @@
<p> The <a href="../docs_0_70/your-project.html">Using Forrest</a> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
</div>
-<a name="N10051"></a><a name="cygwin_mutex_error"></a>
-<h4 class="faq">1.6. When running ./build.sh in cygwin, I get an error: cygpath.exe:
+<a name="N1007A"></a><a name="cygwin_mutex_error"></a>
+<h4 class="faq">1.8. When running ./build.sh in cygwin, I get an error: cygpath.exe:
*** can't create title mutex, Win32 error 6. </h4>
<div align="right">
<a href="#cygwin_mutex_error-menu">^</a>
@@ -561,8 +608,8 @@
<p> This <a href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
to be a bug in cygwin</a>. Please use the .bat script instead. </p>
</div>
-<a name="N10063"></a><a name="maxmemory"></a>
-<h4 class="faq">1.7. How can I specify the amount of memory to be used by Java? </h4>
+<a name="N1008C"></a><a name="maxmemory"></a>
+<h4 class="faq">1.9. How can I specify the amount of memory to be used by Java? </h4>
<div align="right">
<a href="#maxmemory-menu">^</a>
</div>
@@ -579,9 +626,9 @@
value you set it to is dependant on your JVM, but something like
<span class="codefrag">ANT_OPTS=-Xmx500M</span> will probably work. </p>
</div>
-<a name="N10080"></a><a name="content_faqs"></a>
+<a name="N100A9"></a><a name="content_faqs"></a>
<h3 class="underlined_5">2. Content Creation</h3>
-<a name="N10084"></a><a name="edit-content"></a>
+<a name="N100AD"></a><a name="edit-content"></a>
<h4 class="faq">2.1. What tools can be used to edit the content?</h4>
<div align="right">
<a href="#edit-content-menu">^</a>
@@ -597,7 +644,7 @@
you can use text editors or "html editors" such as the one provided with the Mozilla web
browser. </p>
</div>
-<a name="N1009E"></a><a name="site-xml"></a>
+<a name="N100C7"></a><a name="site-xml"></a>
<h4 class="faq">2.2.
How to use the site.xml configuration file for menus and linking.
</h4>
@@ -639,7 +686,7 @@
</p>
<pre class="code"><a href="site:v0.70//docbook"> link to the DocBook FAQ in the Tech FAQs</pre>
</div>
-<a name="N100CC"></a><a name="examples"></a>
+<a name="N100F5"></a><a name="examples"></a>
<h4 class="faq">2.3.
Where are examples of documents and site.xml and tabs.xml files?
</h4>
@@ -652,7 +699,7 @@
are included with the distribution (cd forrest/site-author; forrest run).
</p>
</div>
-<a name="N100D4"></a><a name="PDF-output"></a>
+<a name="N100FD"></a><a name="PDF-output"></a>
<h4 class="faq">2.4. How can I generate one pdf-file out of the whole site or selected pages of the site?</h4>
<div align="right">
<a href="#PDF-output-menu">^</a>
@@ -672,7 +719,7 @@
<p> This assumes that you use the <a href="../docs_0_70/linking.html">site.xml</a> method for your
site structure and navigation, rather than the old book.xml method. </p>
</div>
-<a name="N100EE"></a><a name="pageBreaks"></a>
+<a name="N10117"></a><a name="pageBreaks"></a>
<h4 class="faq">2.5. How do I insert page breaks into documents?</h4>
<div align="right">
<a href="#pageBreaks-menu">^</a>
@@ -693,7 +740,7 @@
<pre class="code"> .pageBreakBefore { margin-bottom: 0; page-break-before: always; } .pageBreakAfter {
margin-bottom: 0; page-break-after: always; } </pre>
</div>
-<a name="N1010C"></a><a name="clickable-email-address"></a>
+<a name="N10135"></a><a name="clickable-email-address"></a>
<h4 class="faq">2.6. How can I generate html-pages to show a 'clickable' email-address (of the
author-element)?</h4>
<div align="right">
@@ -704,7 +751,7 @@
$FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</span> and edit the
"headers/authors" template. </p>
</div>
-<a name="N10117"></a><a name="link_raw"></a>
+<a name="N10140"></a><a name="link_raw"></a>
<h4 class="faq">2.7. How do I link to raw files such as config.txt and brochure.pdf? </h4>
<div align="right">
<a href="#link_raw-menu">^</a>
@@ -714,7 +761,7 @@
<a href="../docs_0_70/upgrading_07.html#raw">Upgrading to Apache Forrest 0.7</a> for
all the details.</p>
</div>
-<a name="N10123"></a><a name="pdf_images"></a>
+<a name="N1014C"></a><a name="pdf_images"></a>
<h4 class="faq">2.8. Images don't display in PDFs. How do I fix this?</h4>
<div align="right">
<a href="#pdf_images-menu">^</a>
@@ -746,7 +793,7 @@
<div class="content">Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</div>
</div>
</div>
-<a name="N10150"></a><a name="tab-index"></a>
+<a name="N10179"></a><a name="tab-index"></a>
<h4 class="faq">2.9. The tab link in my site incorrectly assumes that 'index.html' is present in the
linked-to directory. How do I fix this? </h4>
<div align="right">
@@ -765,7 +812,7 @@
<map:redirect-to uri="manual/Introduction.html"/>
</map:match></pre>
</div>
-<a name="N1016C"></a><a name="tab-site"></a>
+<a name="N10195"></a><a name="tab-site"></a>
<h4 class="faq">2.10. I need help with the interaction between tabs.xml and site.xml </h4>
<div align="right">
<a href="#tab-site-menu">^</a>
@@ -775,7 +822,7 @@
See the <a href="../docs_0_70/linking.html#tab-site">tips</a>.
</p>
</div>
-<a name="N10178"></a><a name="defaultFileName"></a>
+<a name="N101A1"></a><a name="defaultFileName"></a>
<h4 class="faq">2.11. How can I change the default file name that Forrest will look for when I request a
URL like http://myserver or http://myserver/mydir/ ? </h4>
<div align="right">
@@ -805,7 +852,7 @@
</ol>
</div>
-<a name="N101A0"></a><a name="defaultStartPage"></a>
+<a name="N101C9"></a><a name="defaultStartPage"></a>
<h4 class="faq">2.12. How can I use a start-up-page other than index.html? </h4>
<div align="right">
<a href="#defaultStartPage-menu">^</a>
@@ -836,7 +883,7 @@
</ol>
</div>
-<a name="N101C4"></a><a name="label-entity"></a>
+<a name="N101ED"></a><a name="label-entity"></a>
<h4 class="faq">2.13. How to use special characters in the labels of the site.xml file? </h4>
<div align="right">
<a href="#label-entity-menu">^</a>
@@ -848,7 +895,7 @@
</p>
<p> See the <a href="http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_xhtml_character_entities">XHTML Character Entities</a> and see more discussion at <a href="http://issues.apache.org/jira/browse/FOR-244">Issue FOR-244</a>. </p>
</div>
-<a name="N101DD"></a><a name="encoding"></a>
+<a name="N10206"></a><a name="encoding"></a>
<h4 class="faq">2.14. Does Forrest handle accents for non-English languages?</h4>
<div align="right">
<a href="#encoding-menu">^</a>
@@ -895,7 +942,7 @@
Schlabach</a> and <a href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
resources</a>. </p>
</div>
-<a name="N1022F"></a><a name="cleanSite"></a>
+<a name="N10258"></a><a name="cleanSite"></a>
<h4 class="faq">2.15. How to make Forrest clean up the project build directories? </h4>
<div align="right">
<a href="#cleanSite-menu">^</a>
@@ -914,7 +961,7 @@
Doing 'forrest clean' will remove both sections.
</p>
</div>
-<a name="N1023A"></a><a name="i18n"></a>
+<a name="N10263"></a><a name="i18n"></a>
<h4 class="faq">2.16. How can I internationalise (i18n) my content?</h4>
<div align="right">
<a href="#i18n-menu">^</a>
@@ -928,7 +975,7 @@
by the <a href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html">Cocoon i18n
Transformer</a>. You can see an example of how it works in the above linked issue.</p>
</div>
-<a name="N1024D"></a><a name="rawTML"></a>
+<a name="N10276"></a><a name="rawTML"></a>
<h4 class="faq">2.17. How can I include HTML content that is not to be skinned by Forrest?</h4>
<div align="right">
<a href="#rawTML-menu">^</a>
@@ -967,9 +1014,9 @@
</ol>
</div>
-<a name="N10270"></a><a name="technical"></a>
+<a name="N10299"></a><a name="technical"></a>
<h3 class="underlined_5">3. Technical</h3>
-<a name="N10274"></a><a name="proxy_config"></a>
+<a name="N1029D"></a><a name="proxy_config"></a>
<h4 class="faq">3.1. I'm behind a proxy and it's preventing Plugins from being downloaded, what should I
do?</h4>
<div align="right">
@@ -980,7 +1027,7 @@
<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>
-<a name="N1028E"></a><a name="CVS_revison_tags"></a>
+<a name="N102B7"></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>
@@ -993,7 +1040,7 @@
<p>This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47
$</p>
</div>
-<a name="N102A0"></a><a name="cli-xconf"></a>
+<a name="N102C9"></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">
@@ -1031,7 +1078,7 @@
<strong>foo/**</strong> to match that. </div>
</div>
</div>
-<a name="N102DD"></a><a name="ignoring_javadocs"></a>
+<a name="N10306"></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">
@@ -1042,7 +1089,7 @@
<span class="codefrag">cli.xconf</span>
</a> Cocoon config file, and defining patterns for URLs to exclude. </p>
</div>
-<a name="N102EC"></a><a name="claimed_patterns"></a>
+<a name="N10315"></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>
@@ -1058,7 +1105,7 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N102FE"></a><a name="build_msg_a"></a>
+<a name="N10327"></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">
@@ -1091,7 +1138,7 @@
</p>
</div>
-<a name="N1031A"></a><a name="headless_operation"></a>
+<a name="N10343"></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">
@@ -1104,7 +1151,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="N10336"></a><a name="project-logo-svg"></a>
+<a name="N1035F"></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>
@@ -1124,7 +1171,7 @@
<a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources.
</p>
</div>
-<a name="N1034E"></a><a name="catalog"></a>
+<a name="N10377"></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">
@@ -1134,7 +1181,7 @@
<p> Notes are provided for various tools at <a href="../docs_0_70/catalog.html">Using Catalog Entity
Resolver for local DTDs</a>. </p>
</div>
-<a name="N1035A"></a><a name="skin"></a>
+<a name="N10383"></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>
@@ -1146,7 +1193,7 @@
<p> See notes about <a href="../docs_0_70/your-project.html#skins">configuration</a> of the skins.
Some projects may have special needs and can define their <a href="../docs_0_70/your-project.html#new_skin">own skin</a>. </p>
</div>
-<a name="N10371"></a><a name="xsp"></a>
+<a name="N1039A"></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>
@@ -1194,7 +1241,7 @@
</ol>
<p>See also the <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a> Wiki page.</p>
</div>
-<a name="N103AC"></a><a name="breadcrumbs"></a>
+<a name="N103D5"></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>
@@ -1213,7 +1260,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="N103C1"></a><a name="run_port"></a>
+<a name="N103EA"></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>
@@ -1229,9 +1276,9 @@
</p>
</div>
-<a name="N103D5"></a><a name="old_faqs"></a>
+<a name="N103FE"></a><a name="old_faqs"></a>
<h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N103D9"></a><a name="old_claimed_patterns"></a>
+<a name="N10402"></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>
@@ -1247,9 +1294,9 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N103EB"></a><a name="general"></a>
+<a name="N10414"></a><a name="general"></a>
<h3 class="underlined_5">5. General</h3>
-<a name="N103EF"></a><a name="generating_menus"></a>
+<a name="N10418"></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>
@@ -1263,7 +1310,7 @@
<span class="codefrag">site.xml</span>-generated menus aren't appropriate. See <a href="../docs_0_70/linking.html">Menus and
Linking</a>. </p>
</div>
-<a name="N1040A"></a><a name="docbook"></a>
+<a name="N10433"></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>
@@ -1309,7 +1356,7 @@
different DTDs, then see <a href="../docs_0_70/your-project.html#new_dtd">Using Forrest</a> for
configuration guidance. </p>
</div>
-<a name="N10438"></a><a name="version"></a>
+<a name="N10461"></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">
@@ -1322,7 +1369,7 @@
watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build
messages. </p>
</div>
-<a name="N1044C"></a><a name="logs"></a>
+<a name="N10475"></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>
@@ -1341,7 +1388,7 @@
<p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard
output. </p>
</div>
-<a name="N10470"></a><a name="how_can_I_help"></a>
+<a name="N10499"></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>
@@ -1352,7 +1399,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="N1047C"></a><a name="patch"></a>
+<a name="N104A5"></a><a name="patch"></a>
<h4 class="faq">5.6. How to contribute a patch? </h4>
<div align="right">
<a href="#patch-menu">^</a>
Modified: forrest/site/docs_0_70/faq.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/faq.pdf?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_70/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/faq.xml?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
--- forrest/site/docs_0_70/faq.xml (original)
+++ forrest/site/docs_0_70/faq.xml Fri Mar 3 20:13:03 2006
@@ -13,9 +13,14 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---><document><header><title>Frequently Asked Questions</title></header><body><section id="Questions"><title>Questions</title><section id="getting_started"><title>1. Getting Started and Building Forrest</title><section id="overview"><title>1.1. Where can I read an overview about how to work with Forrest? </title>
+--><document><header><title>Frequently Asked Questions</title></header><body><section id="Questions"><title>Questions</title><section id="getting_started"><title>1. Getting Started and Building Forrest</title><section id="faq"><title>1.1. How to use these FAQs? </title>
+ <p>
+ There is no particular order to these FAQs. Use your browser's
+ "Find in this page" facility to search for keywords.
+ </p>
+ </section><section id="overview"><title>1.2. Where can I read an overview about how to work with Forrest? </title>
<p> See the <link href="site:v0.70//your-project">Using Forrest</link> guide. </p>
- </section><section id="requirements"><title>1.2. What are the system requirements for Forrest? </title>
+ </section><section id="requirements"><title>1.3. What are the system requirements for Forrest? </title>
<p> Forrest includes everything necessary to build and run, except of course for Java. In
addition to all the Cocoon JARs, Forrest includes and uses its own version of Apache Ant.
</p>
@@ -25,22 +30,46 @@
If you intend to enhance and rebuild Forrest (or use the Forrest sources
with Subversion or use a source snapshot) then you need the full JDK.
</p>
- </section><section id="cvs"><title>1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </title>
+ </section><section id="cvs"><title>1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </title>
<p> Forrest switched from a CVS code repository to SVN (Subversion) code repository. The old
CVS repository is closed and not kept current. </p>
- </section><section id="svn"><title>1.4. How can I use SVN to keep up to date with the latest codebase? </title>
+ </section><section id="svn"><title>1.5. How can I use SVN to keep up to date with the latest codebase? </title>
<p> Follow these <link href="site:v0.70//build">Building Forrest</link> notes. </p>
<p> The <link href="site:v0.70//your-project">Using Forrest</link> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
- </section><section id="single-document"><title>1.5. What is the best way to generate "standalone documents" using Forrest? </title>
+ </section><section id="older-plugins"><title>1.6. How to use older versions of specific plugins? </title>
+ <p>
+ Sometimes one does not want to use the most recent functionality
+ of a plugin and instead need to use an older version.
+ Information about changes to each plugin can be found in its
+ <link href="site:v0.70//plugins/index">documentation</link>.
+ </p>
+ <p>
+ In the forrest.properties file, specify the version of the plugin
+ that you require, e.g.
+ </p>
+ <source xml:space="preserve">project.required.plugins=org.apache.forrest.plugin.input.PhotoGallery-0.1,...</source>
+ <p>
+ Users of Forrest-0.7 will need to do this for the projectInfo plugin
+ if you get the following error ...
+ </p>
+ <source xml:space="preserve">Could not find component for role:
+ [org.apache.cocoon.components.modules.input.InputModule/lm]
+ (Key='org.apache.cocoon.components.modules.input.InputModule/</source>
+ <p>
+ ... then sorry, we mistakenly added new "locationmap" functionality
+ (due in version 0.8). So do this ...
+ </p>
+ <source xml:space="preserve">project.required.plugins=org.apache.forrest.plugin.input.projectInfo-0.1,...</source>
+ </section><section id="single-document"><title>1.7. What is the best way to generate "standalone documents" using Forrest? </title>
<p> forrest site -Dproject.start-uri=myfile.pdf </p>
<p> The <link href="site:v0.70//your-project">Using Forrest</link> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
- </section><section id="cygwin_mutex_error"><title>1.6. When running <code>./build.sh</code> in cygwin, I get an error: <code>cygpath.exe:
+ </section><section id="cygwin_mutex_error"><title>1.8. When running <code>./build.sh</code> in cygwin, I get an error: <code>cygpath.exe:
*** can't create title mutex, Win32 error 6</code>. </title>
<p> This <link href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
to be a bug in cygwin</link>. Please use the .bat script instead. </p>
- </section><section id="maxmemory"><title>1.7. How can I specify the amount of memory to be used by Java? </title>
+ </section><section id="maxmemory"><title>1.9. How can I specify the amount of memory to be used by Java? </title>
<p> There are two ways to control this. If you get an OutOfMemoryError when Cocoon is
generating pages, see the first paragraph. If you get an OutOfMemoryError when outside of
Cocoon (e.g., copying raw files), see the second paragraph. </p>
Modified: forrest/site/docs_0_70/primer.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/primer.pdf?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Fri Mar 3 20:13:03 2006
@@ -328,29 +328,35 @@
<a href="#getting_started">1. Getting Started and Building Forrest</a>
<ul class="minitoc">
<li>
-<a href="#overview">1.1. Where can I read an overview about how to work with Forrest? </a>
+<a href="#faq">1.1. How to use these FAQs? </a>
</li>
<li>
-<a href="#requirements">1.2. What are the system requirements for Forrest? </a>
+<a href="#overview">1.2. Where can I read an overview about how to work with Forrest? </a>
</li>
<li>
-<a href="#cvs">1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </a>
+<a href="#requirements">1.3. What are the system requirements for Forrest? </a>
</li>
<li>
-<a href="#svn">1.4. How can I use SVN to keep up to date with the latest codebase? </a>
+<a href="#cvs">1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </a>
</li>
<li>
-<a href="#single-document">1.5. What is the best way to generate "standalone documents" using Forrest? </a>
+<a href="#svn">1.5. How can I use SVN to keep up to date with the latest codebase? </a>
</li>
<li>
-<a href="#cygwin_mutex_error">1.6. When running ./build.sh in cygwin, I get an error: cygpath.exe:
+<a href="#older-plugins">1.6. How to use older versions of specific plugins? </a>
+</li>
+<li>
+<a href="#single-document">1.7. What is the best way to generate "standalone documents" using Forrest? </a>
+</li>
+<li>
+<a href="#cygwin_mutex_error">1.8. When running ./build.sh in cygwin, I get an error: cygpath.exe:
*** can't create title mutex, Win32 error 6. </a>
</li>
<li>
-<a href="#maxmemory">1.7. How can I specify the amount of memory to be used by Java? </a>
+<a href="#maxmemory">1.9. How can I specify the amount of memory to be used by Java? </a>
</li>
<li>
-<a href="#debug">1.8. How can I start forrest in debug mode? </a>
+<a href="#debug">1.10. How can I start forrest in Java debug mode? </a>
</li>
</ul>
</li>
@@ -531,16 +537,27 @@
<div class="section">
<a name="N1000C"></a><a name="getting_started"></a>
<h3 class="underlined_5">1. Getting Started and Building Forrest</h3>
-<a name="N10010"></a><a name="overview"></a>
-<h4 class="faq">1.1. Where can I read an overview about how to work with Forrest? </h4>
+<a name="N10010"></a><a name="faq"></a>
+<h4 class="faq">1.1. How to use these FAQs? </h4>
+<div align="right">
+<a href="#faq-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+ There is no particular order to these FAQs. Use your browser's
+ "Find in this page" facility to search for keywords.
+ </p>
+</div>
+<a name="N10018"></a><a name="overview"></a>
+<h4 class="faq">1.2. Where can I read an overview about how to work with Forrest? </h4>
<div align="right">
<a href="#overview-menu">^</a>
</div>
<div style="margin-left: 15px">
<p> See the <a href="../docs_0_80/your-project.html">Using Forrest</a> guide. </p>
</div>
-<a name="N1001C"></a><a name="requirements"></a>
-<h4 class="faq">1.2. What are the system requirements for Forrest? </h4>
+<a name="N10024"></a><a name="requirements"></a>
+<h4 class="faq">1.3. What are the system requirements for Forrest? </h4>
<div align="right">
<a href="#requirements-menu">^</a>
</div>
@@ -555,8 +572,8 @@
with Subversion or use a source snapshot) then you need the full JDK.
</p>
</div>
-<a name="N10027"></a><a name="cvs"></a>
-<h4 class="faq">1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </h4>
+<a name="N1002F"></a><a name="cvs"></a>
+<h4 class="faq">1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </h4>
<div align="right">
<a href="#cvs-menu">^</a>
</div>
@@ -564,8 +581,8 @@
<p> Forrest switched from a CVS code repository to SVN (Subversion) code repository. The old
CVS repository is closed and not kept current. </p>
</div>
-<a name="N1002F"></a><a name="svn"></a>
-<h4 class="faq">1.4. How can I use SVN to keep up to date with the latest codebase? </h4>
+<a name="N10037"></a><a name="svn"></a>
+<h4 class="faq">1.5. How can I use SVN to keep up to date with the latest codebase? </h4>
<div align="right">
<a href="#svn-menu">^</a>
</div>
@@ -574,8 +591,38 @@
<p> The <a href="../docs_0_80/your-project.html">Using Forrest</a> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
</div>
-<a name="N10042"></a><a name="single-document"></a>
-<h4 class="faq">1.5. What is the best way to generate "standalone documents" using Forrest? </h4>
+<a name="N1004A"></a><a name="older-plugins"></a>
+<h4 class="faq">1.6. How to use older versions of specific plugins? </h4>
+<div align="right">
+<a href="#older-plugins-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+ Sometimes one does not want to use the most recent functionality
+ of a plugin and instead need to use an older version.
+ Information about changes to each plugin can be found in its
+ <a href="../pluginDocs/plugins_0_80/index.html">documentation</a>.
+ </p>
+<p>
+ In the forrest.properties file, specify the version of the plugin
+ that you require, e.g.
+ </p>
+<pre class="code">project.required.plugins=org.apache.forrest.plugin.input.PhotoGallery-0.1,...</pre>
+<p>
+ Users of Forrest-0.7 will need to do this for the projectInfo plugin
+ if you get the following error ...
+ </p>
+<pre class="code">Could not find component for role:
+ [org.apache.cocoon.components.modules.input.InputModule/lm]
+ (Key='org.apache.cocoon.components.modules.input.InputModule/</pre>
+<p>
+ ... then sorry, we mistakenly added new "locationmap" functionality
+ (due in version 0.8). So do this ...
+ </p>
+<pre class="code">project.required.plugins=org.apache.forrest.plugin.input.projectInfo-0.1,...</pre>
+</div>
+<a name="N1006B"></a><a name="single-document"></a>
+<h4 class="faq">1.7. What is the best way to generate "standalone documents" using Forrest? </h4>
<div align="right">
<a href="#single-document-menu">^</a>
</div>
@@ -612,8 +659,8 @@
if you need to temporarily exclude then.
</p>
</div>
-<a name="N1005E"></a><a name="cygwin_mutex_error"></a>
-<h4 class="faq">1.6. When running ./build.sh in cygwin, I get an error: cygpath.exe:
+<a name="N10087"></a><a name="cygwin_mutex_error"></a>
+<h4 class="faq">1.8. When running ./build.sh in cygwin, I get an error: cygpath.exe:
*** can't create title mutex, Win32 error 6. </h4>
<div align="right">
<a href="#cygwin_mutex_error-menu">^</a>
@@ -622,8 +669,8 @@
<p> This <a href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
to be a bug in cygwin</a>. Please use the .bat script instead. </p>
</div>
-<a name="N10070"></a><a name="maxmemory"></a>
-<h4 class="faq">1.7. How can I specify the amount of memory to be used by Java? </h4>
+<a name="N10099"></a><a name="maxmemory"></a>
+<h4 class="faq">1.9. How can I specify the amount of memory to be used by Java? </h4>
<div align="right">
<a href="#maxmemory-menu">^</a>
</div>
@@ -640,8 +687,8 @@
value you set it to is dependant on your JVM, but something like
<span class="codefrag">ANT_OPTS=-Xmx500M</span> will probably work. </p>
</div>
-<a name="N1008D"></a><a name="debug"></a>
-<h4 class="faq">1.8. How can I start forrest in debug mode? </h4>
+<a name="N100B6"></a><a name="debug"></a>
+<h4 class="faq">1.10. How can I start forrest in Java debug mode? </h4>
<div align="right">
<a href="#debug-menu">^</a>
</div>
@@ -652,9 +699,9 @@
</p>
</div>
-<a name="N1009E"></a><a name="content_faqs"></a>
+<a name="N100C7"></a><a name="content_faqs"></a>
<h3 class="underlined_5">2. Content Creation</h3>
-<a name="N100A2"></a><a name="edit-content"></a>
+<a name="N100CB"></a><a name="edit-content"></a>
<h4 class="faq">2.1. What tools can be used to edit the content?</h4>
<div align="right">
<a href="#edit-content-menu">^</a>
@@ -670,7 +717,7 @@
you can use text editors or "html editors" such as the one provided with the Mozilla web
browser. </p>
</div>
-<a name="N100BC"></a><a name="site-xml"></a>
+<a name="N100E5"></a><a name="site-xml"></a>
<h4 class="faq">2.2.
How to use the site.xml configuration file for menus and linking.
</h4>
@@ -712,7 +759,7 @@
</p>
<pre class="code"><a href="site:docbook"> link to the DocBook FAQ in the Tech FAQs</pre>
</div>
-<a name="N100EA"></a><a name="examples"></a>
+<a name="N10113"></a><a name="examples"></a>
<h4 class="faq">2.3.
Where are examples of documents and site.xml and tabs.xml files?
</h4>
@@ -726,7 +773,7 @@
forrest run</span>).
</p>
</div>
-<a name="N100F5"></a><a name="crawler"></a>
+<a name="N1011E"></a><a name="crawler"></a>
<h4 class="faq">2.4.
Help, one of my documents is not being rendered.
</h4>
@@ -751,7 +798,7 @@
</p>
</div>
-<a name="N10103"></a><a name="PDF-output"></a>
+<a name="N1012C"></a><a name="PDF-output"></a>
<h4 class="faq">2.5. How can I generate one pdf-file out of the whole site or selected pages of the site?</h4>
<div align="right">
<a href="#PDF-output-menu">^</a>
@@ -771,7 +818,7 @@
<p> This assumes that you use the <a href="../docs_0_80/linking.html">site.xml</a> method for your
site structure and navigation, rather than the old book.xml method. </p>
</div>
-<a name="N1011D"></a><a name="pageBreaks"></a>
+<a name="N10146"></a><a name="pageBreaks"></a>
<h4 class="faq">2.6. How do I insert page breaks into documents?</h4>
<div align="right">
<a href="#pageBreaks-menu">^</a>
@@ -799,7 +846,7 @@
page-break-after: always;
} </pre>
</div>
-<a name="N1013B"></a><a name="clickable-email-address"></a>
+<a name="N10164"></a><a name="clickable-email-address"></a>
<h4 class="faq">2.7. How can I generate html-pages to show a 'clickable' email-address (of the
author-element)?</h4>
<div align="right">
@@ -810,7 +857,7 @@
$FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</span> and edit the
"headers/authors" template. </p>
</div>
-<a name="N10146"></a><a name="link_raw"></a>
+<a name="N1016F"></a><a name="link_raw"></a>
<h4 class="faq">2.8. How do I link to raw files such as config.txt and brochure.pdf? </h4>
<div align="right">
<a href="#link_raw-menu">^</a>
@@ -820,7 +867,7 @@
<a href="../docs_0_70/upgrading_07.html#raw">Upgrading to Apache Forrest 0.7</a> for
all the details.</p>
</div>
-<a name="N10152"></a><a name="pdf_images"></a>
+<a name="N1017B"></a><a name="pdf_images"></a>
<h4 class="faq">2.9. Images don't display in PDFs. How do I fix this?</h4>
<div align="right">
<a href="#pdf_images-menu">^</a>
@@ -852,7 +899,7 @@
<div class="content">Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</div>
</div>
</div>
-<a name="N10182"></a><a name="tab-index"></a>
+<a name="N101AB"></a><a name="tab-index"></a>
<h4 class="faq">2.10. The tab link in my site incorrectly assumes that 'index.html' is present in the
linked-to directory. How do I fix this? </h4>
<div align="right">
@@ -871,7 +918,7 @@
<map:redirect-to uri="manual/Introduction.html"/>
</map:match></pre>
</div>
-<a name="N1019E"></a><a name="tab-site"></a>
+<a name="N101C7"></a><a name="tab-site"></a>
<h4 class="faq">2.11. I need help with the interaction between tabs.xml and site.xml </h4>
<div align="right">
<a href="#tab-site-menu">^</a>
@@ -881,7 +928,7 @@
See the <a href="../docs_0_80/linking.html#tab-site">tips</a>.
</p>
</div>
-<a name="N101AA"></a><a name="defaultFileName"></a>
+<a name="N101D3"></a><a name="defaultFileName"></a>
<h4 class="faq">2.12. How can I change the default file name that Forrest will look for when I request a
URL like http://myserver or http://myserver/mydir/ ? </h4>
<div align="right">
@@ -911,7 +958,7 @@
</ol>
</div>
-<a name="N101D2"></a><a name="defaultStartPage"></a>
+<a name="N101FB"></a><a name="defaultStartPage"></a>
<h4 class="faq">2.13. How can I use a start-up-page other than index.html? </h4>
<div align="right">
<a href="#defaultStartPage-menu">^</a>
@@ -942,7 +989,7 @@
</ol>
</div>
-<a name="N101F6"></a><a name="label-entity"></a>
+<a name="N1021F"></a><a name="label-entity"></a>
<h4 class="faq">2.14. How to use special characters in the labels of the site.xml file? </h4>
<div align="right">
<a href="#label-entity-menu">^</a>
@@ -954,7 +1001,7 @@
</p>
<p> See the <a href="http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_xhtml_character_entities">XHTML Character Entities</a> and see more discussion at <a href="http://issues.apache.org/jira/browse/FOR-244">Issue FOR-244</a>. </p>
</div>
-<a name="N1020F"></a><a name="encoding"></a>
+<a name="N10238"></a><a name="encoding"></a>
<h4 class="faq">2.15. Does Forrest handle accents for non-English languages?</h4>
<div align="right">
<a href="#encoding-menu">^</a>
@@ -1001,7 +1048,7 @@
Schlabach</a> and <a href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
resources</a>. </p>
</div>
-<a name="N10261"></a><a name="xml-entities"></a>
+<a name="N1028A"></a><a name="xml-entities"></a>
<h4 class="faq">2.16. How to use XML entities, for example string
replacement?</h4>
<div align="right">
@@ -1017,7 +1064,7 @@
Avoid lengthy typing and potential spelling errors.
</p>
</div>
-<a name="N1026C"></a><a name="cleanSite"></a>
+<a name="N10295"></a><a name="cleanSite"></a>
<h4 class="faq">2.17. How to make Forrest clean up the project build directories? </h4>
<div align="right">
<a href="#cleanSite-menu">^</a>
@@ -1036,7 +1083,7 @@
Doing 'forrest clean' will remove both sections.
</p>
</div>
-<a name="N10277"></a><a name="i18n"></a>
+<a name="N102A0"></a><a name="i18n"></a>
<h4 class="faq">2.18. How can I internationalise (i18n) my content?</h4>
<div align="right">
<a href="#i18n-menu">^</a>
@@ -1050,7 +1097,7 @@
by the <a href="http://cocoon.apache.org/2.1/userdocs/i18nTransformer.html">Cocoon i18n
Transformer</a>. You can see an example of how it works in the above linked issue.</p>
</div>
-<a name="N1028A"></a><a name="rawTML"></a>
+<a name="N102B3"></a><a name="rawTML"></a>
<h4 class="faq">2.19. How can I include HTML content that is not to be skinned by Forrest?</h4>
<div align="right">
<a href="#rawTML-menu">^</a>
@@ -1091,7 +1138,7 @@
</ol>
</div>
-<a name="N102B0"></a><a name="javascript"></a>
+<a name="N102D9"></a><a name="javascript"></a>
<h4 class="faq">2.20. How to include additional Javascript and CSS files?</h4>
<div align="right">
<a href="#javascript-menu">^</a>
@@ -1115,9 +1162,9 @@
<map:resource name="skin-read"> section.
</p>
</div>
-<a name="N102BE"></a><a name="technical"></a>
+<a name="N102E7"></a><a name="technical"></a>
<h3 class="underlined_5">3. Technical</h3>
-<a name="N102C2"></a><a name="proxy_config"></a>
+<a name="N102EB"></a><a name="proxy_config"></a>
<h4 class="faq">3.1. I'm behind a proxy and it's preventing Plugins from being downloaded, what should I
do?</h4>
<div align="right">
@@ -1128,7 +1175,7 @@
<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>
-<a name="N102DC"></a><a name="CVS_revison_tags"></a>
+<a name="N10305"></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>
@@ -1141,7 +1188,7 @@
<p>This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47
$</p>
</div>
-<a name="N102EE"></a><a name="cli-xconf"></a>
+<a name="N10317"></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">
@@ -1179,7 +1226,7 @@
<strong>foo/**</strong> to match that. </div>
</div>
</div>
-<a name="N1032B"></a><a name="ignoring_javadocs"></a>
+<a name="N10354"></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">
@@ -1190,7 +1237,7 @@
<span class="codefrag">cli.xconf</span>
</a> Cocoon config file, and defining patterns for URLs to exclude. </p>
</div>
-<a name="N1033A"></a><a name="claimed_patterns"></a>
+<a name="N10363"></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>
@@ -1206,7 +1253,7 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N1034C"></a><a name="build_msg_a"></a>
+<a name="N10375"></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">
@@ -1237,7 +1284,7 @@
</ul>
</div>
-<a name="N1036A"></a><a name="headless_operation"></a>
+<a name="N10393"></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">
@@ -1250,7 +1297,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="N10386"></a><a name="project-logo-svg"></a>
+<a name="N103AF"></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>
@@ -1270,7 +1317,7 @@
<a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources.
</p>
</div>
-<a name="N1039E"></a><a name="catalog"></a>
+<a name="N103C7"></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">
@@ -1280,7 +1327,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="N103AA"></a><a name="skin"></a>
+<a name="N103D3"></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>
@@ -1292,7 +1339,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="N103C1"></a><a name="xsp"></a>
+<a name="N103EA"></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>
@@ -1340,7 +1387,7 @@
</ol>
<p>See also the <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a> Wiki page.</p>
</div>
-<a name="N103FC"></a><a name="breadcrumbs"></a>
+<a name="N10425"></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>
@@ -1359,7 +1406,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="N10411"></a><a name="run_port"></a>
+<a name="N1043A"></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>
@@ -1375,7 +1422,7 @@
</p>
</div>
-<a name="N10425"></a><a name="debugging"></a>
+<a name="N1044E"></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>
@@ -1387,7 +1434,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="N10436"></a><a name="checksums"></a>
+<a name="N1045F"></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>
@@ -1421,9 +1468,9 @@
installation-wide cli.xconf file.
</p>
</div>
-<a name="N10452"></a><a name="old_faqs"></a>
+<a name="N1047B"></a><a name="old_faqs"></a>
<h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N10456"></a><a name="old_claimed_patterns"></a>
+<a name="N1047F"></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>
@@ -1439,9 +1486,9 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N10468"></a><a name="general"></a>
+<a name="N10491"></a><a name="general"></a>
<h3 class="underlined_5">5. General</h3>
-<a name="N1046C"></a><a name="generating_menus"></a>
+<a name="N10495"></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>
@@ -1455,7 +1502,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="N10487"></a><a name="docbook"></a>
+<a name="N104B0"></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>
@@ -1501,7 +1548,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="N104B5"></a><a name="version"></a>
+<a name="N104DE"></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">
@@ -1514,7 +1561,7 @@
watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build
messages. </p>
</div>
-<a name="N104C9"></a><a name="logs"></a>
+<a name="N104F2"></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>
@@ -1533,7 +1580,7 @@
<p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard
output. </p>
</div>
-<a name="N104ED"></a><a name="how_can_I_help"></a>
+<a name="N10516"></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>
@@ -1544,7 +1591,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="N104F9"></a><a name="patch"></a>
+<a name="N10522"></a><a name="patch"></a>
<h4 class="faq">5.6. How to contribute a patch? </h4>
<div align="right">
<a href="#patch-menu">^</a>
@@ -1555,7 +1602,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="N10514"></a><a name="jobs"></a>
+<a name="N1053D"></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=383021&r1=383020&r2=383021&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=383021&r1=383020&r2=383021&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Fri Mar 3 20:13:03 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="ISO-8859-1"?><!--
- Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ Copyright 2002-2006 The Apache Software Foundation or its licensors,
as applicable.
Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,9 +13,14 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---><document><header><title>Frequently Asked Questions</title></header><body><section id="Questions"><title>Questions</title><section id="getting_started"><title>1. Getting Started and Building Forrest</title><section id="overview"><title>1.1. Where can I read an overview about how to work with Forrest? </title>
+--><document><header><title>Frequently Asked Questions</title></header><body><section id="Questions"><title>Questions</title><section id="getting_started"><title>1. Getting Started and Building Forrest</title><section id="faq"><title>1.1. How to use these FAQs? </title>
+ <p>
+ There is no particular order to these FAQs. Use your browser's
+ "Find in this page" facility to search for keywords.
+ </p>
+ </section><section id="overview"><title>1.2. Where can I read an overview about how to work with Forrest? </title>
<p> See the <link href="site:v0.80//your-project">Using Forrest</link> guide. </p>
- </section><section id="requirements"><title>1.2. What are the system requirements for Forrest? </title>
+ </section><section id="requirements"><title>1.3. What are the system requirements for Forrest? </title>
<p> Forrest includes everything necessary to build and run, except of course for Java. In
addition to all the Cocoon JARs, Forrest includes and uses its own version of Apache Ant.
</p>
@@ -25,14 +30,38 @@
If you intend to enhance and rebuild Forrest (or use the Forrest sources
with Subversion or use a source snapshot) then you need the full JDK.
</p>
- </section><section id="cvs"><title>1.3. The old xml-forrest CVS code repository seems to be stale. What happened? </title>
+ </section><section id="cvs"><title>1.4. The old xml-forrest CVS code repository seems to be stale. What happened? </title>
<p> Forrest switched from a CVS code repository to SVN (Subversion) code repository. The old
CVS repository is closed and not kept current. </p>
- </section><section id="svn"><title>1.4. How can I use SVN to keep up to date with the latest codebase? </title>
+ </section><section id="svn"><title>1.5. How can I use SVN to keep up to date with the latest codebase? </title>
<p> Follow these <link href="site:v0.80//build">Building Forrest</link> notes. </p>
<p> The <link href="site:v0.80//your-project">Using Forrest</link> guide provides further
step-by-step assistance in getting started with Forrest for your project. </p>
- </section><section id="single-document"><title>1.5. What is the best way to generate "standalone documents" using Forrest? </title>
+ </section><section id="older-plugins"><title>1.6. How to use older versions of specific plugins? </title>
+ <p>
+ Sometimes one does not want to use the most recent functionality
+ of a plugin and instead need to use an older version.
+ Information about changes to each plugin can be found in its
+ <link href="site:v0.80//plugins/index">documentation</link>.
+ </p>
+ <p>
+ In the forrest.properties file, specify the version of the plugin
+ that you require, e.g.
+ </p>
+ <source xml:space="preserve">project.required.plugins=org.apache.forrest.plugin.input.PhotoGallery-0.1,...</source>
+ <p>
+ Users of Forrest-0.7 will need to do this for the projectInfo plugin
+ if you get the following error ...
+ </p>
+ <source xml:space="preserve">Could not find component for role:
+ [org.apache.cocoon.components.modules.input.InputModule/lm]
+ (Key='org.apache.cocoon.components.modules.input.InputModule/</source>
+ <p>
+ ... then sorry, we mistakenly added new "locationmap" functionality
+ (due in version 0.8). So do this ...
+ </p>
+ <source xml:space="preserve">project.required.plugins=org.apache.forrest.plugin.input.projectInfo-0.1,...</source>
+ </section><section id="single-document"><title>1.7. What is the best way to generate "standalone documents" using Forrest? </title>
<p>
There is a trick that can cut down your turnaround time
with building. In forrest.properties ...
@@ -69,11 +98,11 @@
Cocoon can also be instructed to not process certain URIs
if you need to temporarily exclude then.
</p>
- </section><section id="cygwin_mutex_error"><title>1.6. When running <code>./build.sh</code> in cygwin, I get an error: <code>cygpath.exe:
+ </section><section id="cygwin_mutex_error"><title>1.8. When running <code>./build.sh</code> in cygwin, I get an error: <code>cygpath.exe:
*** can't create title mutex, Win32 error 6</code>. </title>
<p> This <link href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
to be a bug in cygwin</link>. Please use the .bat script instead. </p>
- </section><section id="maxmemory"><title>1.7. How can I specify the amount of memory to be used by Java? </title>
+ </section><section id="maxmemory"><title>1.9. How can I specify the amount of memory to be used by Java? </title>
<p> There are two ways to control this. If you get an OutOfMemoryError when Cocoon is
generating pages, see the first paragraph. If you get an OutOfMemoryError when outside of
Cocoon (e.g., copying raw files), see the second paragraph. </p>
@@ -84,7 +113,7 @@
<p> Set the <code>ANT_OPTS</code> environment variable before you run forrest. The exact
value you set it to is dependant on your JVM, but something like
<code>ANT_OPTS=-Xmx500M</code> will probably work. </p>
- </section><section id="debug"><title>1.8. How can I start forrest in debug mode? </title>
+ </section><section id="debug"><title>1.10. How can I start forrest in Java debug mode? </title>
<p> The <code>forrest.jvmargs</code> property in the <code>forrest.properties</code> file
can be used to start forrest in debug mode on a specific port.
<code>forrest.jvmargs=-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n</code>
Modified: forrest/site/forrest-issues.html
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.html?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Fri Mar 3 20:13:03 2006
@@ -202,9 +202,6 @@
<a href="#%5BFOR-388%5D+Use+plugins+in-place+if+src+available">[FOR-388] Use plugins in-place if src available</a>
</li>
<li>
-<a href="#%5BFOR-533%5D+Auto+Generate+plugins.xml+entry">[FOR-533] Auto Generate plugins.xml entry</a>
-</li>
-<li>
<a href="#%5BFOR-707%5D+Document+i18n+features+of+Forrest">[FOR-707] Document i18n features of Forrest</a>
</li>
<li>
@@ -217,6 +214,9 @@
<a href="#%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode">[FOR-735] Plugins are not correctly deployed in webapp mode</a>
</li>
<li>
+<a href="#%5BFOR-533%5D+Auto+Generate+plugins.xml+entry">[FOR-533] Auto Generate plugins.xml entry</a>
+</li>
+<li>
<a href="#%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes">[FOR-241] character entities (e.g. ampersand) are expanded again for href or src attributes</a>
</li>
<li>
@@ -363,23 +363,7 @@
<br>
</p>
</div>
-<a name="N1004D"></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>
-<a href="http://issues.apache.org/jira/browse/FOR-533">http://issues.apache.org/jira/browse/FOR-533</a>
-</p>
-<p>The information in the plugins.xml file would be better kept in the plugin directory and added to the plugins.xml file when deployed. This would reduce the amount of duplication in the plugins config files.
-<br>
-
-<br>
-All the necessary values are now in the plugin build.xml file.
-<br>
-
-<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-707%5D+Document+i18n+features+of+Forrest"></a>
+<a name="N1004D"></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>
@@ -399,7 +383,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="N10065"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
+<a name="N10059"></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>
@@ -413,7 +397,7 @@
<br>
<a href="http://marc.theaimsgroup.com/?t=113176328300002">http://marc.theaimsgroup.com/?t=113176328300002</a></p>
</div>
-<a name="N10071"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
+<a name="N10065"></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>
@@ -429,7 +413,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 FOR-701)</p>
</div>
-<a name="N1007D"></a><a name="%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode"></a>
+<a name="N10071"></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>
@@ -444,6 +428,22 @@
- configure Tomcat to run the webapp (we did it by creating a context descriptor and put it onder Tomcat's config directory)
<br>
- the pdf links give an error &quot;Resource Not Found&quot;</p>
+</div>
+<a name="N1007D"></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>
+<a href="http://issues.apache.org/jira/browse/FOR-533">http://issues.apache.org/jira/browse/FOR-533</a>
+</p>
+<p>The information in the plugins.xml file would be better kept in the plugin directory and added to the plugins.xml file when deployed. This would reduce the amount of duplication in the plugins config files.
+<br>
+
+<br>
+All the necessary values are now in the plugin build.xml file.
+<br>
+
+<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="N10089"></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>
Modified: forrest/site/forrest-issues.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.pdf?rev=383021&r1=383020&r2=383021&view=diff
==============================================================================
Binary files - no diff available.