Author: crossley
Date: Thu Dec 29 16:35:30 2005
New Revision: 359950
URL: http://svn.apache.org/viewcvs?rev=359950&view=rev
Log:
Automatic publish from forrestbot
Modified:
forrest/site/abs-linkmap
forrest/site/abs-menulinks
forrest/site/docs_0_80/faq.html
forrest/site/docs_0_80/faq.pdf
forrest/site/docs_0_80/faq.xml
forrest/site/linkmap.html
forrest/site/menu-index.html
Modified: forrest/site/abs-linkmap
URL:
http://svn.apache.org/viewcvs/forrest/site/abs-linkmap?rev=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/abs-linkmap (original)
+++ forrest/site/abs-linkmap Thu Dec 29 16:35:30 2005
@@ -16,12 +16,12 @@
--><site label="Forrest" href="" tab="home">
<!-- General documentation that applies to all versions -->
-
<about label="About">
<index label="Index" href="index.html"/>
<license label="License" href="license.html"/>
<download label="Download" href="http://forrest.apache.org/mirrors.cgi"/>
- <download_html href="mirrors.html"/>
+ <download_html href="mirrors.html"/><!-- So that correct Tab is selected.
-->
+ <linkmap href="linkmap.html"/><!-- So that correct Tab is selected. -->
<who label="Who we are" href="who.html"/>
<events label="Events" href="events.html"/>
<flyer label="Flyer" href="flyer.html"/>
Modified: forrest/site/abs-menulinks
URL:
http://svn.apache.org/viewcvs/forrest/site/abs-menulinks?rev=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/abs-menulinks (original)
+++ forrest/site/abs-menulinks Thu Dec 29 16:35:30 2005
@@ -16,12 +16,12 @@
--><site tab="home" label="Forrest">
<!-- General documentation that applies to all versions -->
-
<about tab="home" label="About">
<index tab="home" label="Index" href="index.html"/>
<license tab="home" label="License" href="license.html"/>
<download tab="home" label="Download"
href="http://forrest.apache.org/mirrors.cgi"/>
- <download_html tab="home" href="mirrors.html"/>
+ <download_html tab="home" href="mirrors.html"/><!-- So that correct Tab is
selected. -->
+ <linkmap tab="home" href="linkmap.html"/><!-- So that correct Tab is
selected. -->
<who tab="home" label="Who we are" href="who.html"/>
<events tab="home" label="Events" href="events.html"/>
<flyer tab="home" label="Flyer" href="flyer.html"/>
Modified: forrest/site/docs_0_80/faq.html
URL:
http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Thu Dec 29 16:35:30 2005
@@ -382,56 +382,61 @@
</a>
</li>
<li>
-<a href="#PDF-output">2.4. How can I generate one pdf-file out of the whole
site or selected pages of the site?</a>
+<a href="#crawler">2.4.
+ Help, one of my documents is not being rendered.
+ </a>
+</li>
+<li>
+<a href="#PDF-output">2.5. How can I generate one pdf-file out of the whole
site or selected pages of the site?</a>
</li>
<li>
-<a href="#pageBreaks">2.5. How do I insert page breaks into documents?</a>
+<a href="#pageBreaks">2.6. How do I insert page breaks into documents?</a>
</li>
<li>
-<a href="#clickable-email-address">2.6. How can I generate html-pages to show
a 'clickable' email-address (of the
+<a href="#clickable-email-address">2.7. How can I generate html-pages to show
a 'clickable' email-address (of the
author-element)?</a>
</li>
<li>
-<a href="#link_raw">2.7. How do I link to raw files such as config.txt and
brochure.pdf? </a>
+<a href="#link_raw">2.8. How do I link to raw files such as config.txt and
brochure.pdf? </a>
</li>
<li>
-<a href="#pdf_images">2.8. Images don't display in PDFs. How do I fix this?</a>
+<a href="#pdf_images">2.9. Images don't display in PDFs. How do I fix this?</a>
</li>
<li>
-<a href="#tab-index">2.9. The tab link in my site incorrectly assumes that
'index.html' is present in the
+<a href="#tab-index">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? </a>
</li>
<li>
-<a href="#tab-site">2.10. I need help with the interaction between tabs.xml
and site.xml </a>
+<a href="#tab-site">2.11. I need help with the interaction between tabs.xml
and site.xml </a>
</li>
<li>
-<a href="#defaultFileName">2.11. How can I change the default file name that
Forrest will look for when I request a
+<a href="#defaultFileName">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/ ? </a>
</li>
<li>
-<a href="#defaultStartPage">2.12. How can I use a start-up-page other than
index.html? </a>
+<a href="#defaultStartPage">2.13. How can I use a start-up-page other than
index.html? </a>
</li>
<li>
-<a href="#label-entity">2.13. How to use special characters in the labels of
the site.xml file? </a>
+<a href="#label-entity">2.14. How to use special characters in the labels of
the site.xml file? </a>
</li>
<li>
-<a href="#encoding">2.14. Does Forrest handle accents for non-English
languages?</a>
+<a href="#encoding">2.15. Does Forrest handle accents for non-English
languages?</a>
</li>
<li>
-<a href="#xml-entities">2.15. How to use XML entities, for example string
+<a href="#xml-entities">2.16. How to use XML entities, for example string
replacement?</a>
</li>
<li>
-<a href="#cleanSite">2.16. How to make Forrest clean up the project build
directories? </a>
+<a href="#cleanSite">2.17. How to make Forrest clean up the project build
directories? </a>
</li>
<li>
-<a href="#i18n">2.17. How can I internationalise (i18n) my content?</a>
+<a href="#i18n">2.18. How can I internationalise (i18n) my content?</a>
</li>
<li>
-<a href="#rawTML">2.18. How can I include HTML content that is not to be
skinned by Forrest?</a>
+<a href="#rawTML">2.19. How can I include HTML content that is not to be
skinned by Forrest?</a>
</li>
<li>
-<a href="#javascript">2.19. How to include additional Javascript and CSS
files?</a>
+<a href="#javascript">2.20. How to include additional Javascript and CSS
files?</a>
</li>
</ul>
</li>
@@ -726,8 +731,33 @@
forrest run</span>).
</p>
</div>
-<a name="N100F5"></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>
+<a name="N100F5"></a><a name="crawler"></a>
+<h4 class="faq">2.4.
+ Help, one of my documents is not being rendered.
+ </h4>
+<div align="right">
+<a href="#crawler-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+ Did you make a link to it? Forrest does not find documents by
scanning
+ the filesystem to find the source documents. Rather it starts at one
+ document and crawls the links to find other documents to process.
+ </p>
+<p>
+ There are essentially two ways to create links. Via a site.xml file
to define the
+ navigation and menu structure, or via direct relative linking. See
the
+ to previous FAQs.
+ </p>
+<p>
+ Normally the source material will be local. The Forrest crawler does
not follow
+ and process off-site links. The new locationmap (0.8+) enables
content
+ to be drawn from remote sources.
+
+ </p>
+</div>
+<a name="N10103"></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>
</div>
@@ -746,8 +776,8 @@
<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="N1010F"></a><a name="pageBreaks"></a>
-<h4 class="faq">2.5. How do I insert page breaks into documents?</h4>
+<a name="N1011D"></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>
</div>
@@ -774,8 +804,8 @@
page-break-after: always;
} </pre>
</div>
-<a name="N1012D"></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
+<a name="N1013B"></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">
<a href="#clickable-email-address-menu">^</a>
@@ -785,8 +815,8 @@
$FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</span> and
edit the
"headers/authors" template. </p>
</div>
-<a name="N10138"></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>
+<a name="N10146"></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>
</div>
@@ -795,8 +825,8 @@
<a href="../docs_0_70/upgrading_07.html#raw">Upgrading to Apache
Forrest 0.7</a> for
all the details.</p>
</div>
-<a name="N10144"></a><a name="pdf_images"></a>
-<h4 class="faq">2.8. Images don't display in PDFs. How do I fix this?</h4>
+<a name="N10152"></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>
</div>
@@ -827,8 +857,8 @@
<div class="content">Due to Sun's licensing, we cannot redistribute Jimi or
JAI with Forrest.</div>
</div>
</div>
-<a name="N10174"></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
+<a name="N10182"></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">
<a href="#tab-index-menu">^</a>
@@ -846,8 +876,8 @@
<map:redirect-to uri="manual/Introduction.html"/>
</map:match></pre>
</div>
-<a name="N10190"></a><a name="tab-site"></a>
-<h4 class="faq">2.10. I need help with the interaction between tabs.xml and
site.xml </h4>
+<a name="N1019E"></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>
</div>
@@ -856,8 +886,8 @@
See the <a href="../docs_0_80/linking.html#tab-site">tips</a>.
</p>
</div>
-<a name="N1019C"></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
+<a name="N101AA"></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">
<a href="#defaultFileName-menu">^</a>
@@ -886,8 +916,8 @@
</ol>
</div>
-<a name="N101C4"></a><a name="defaultStartPage"></a>
-<h4 class="faq">2.12. How can I use a start-up-page other than index.html?
</h4>
+<a name="N101D2"></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>
</div>
@@ -917,8 +947,8 @@
</ol>
</div>
-<a name="N101E8"></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>
+<a name="N101F6"></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>
</div>
@@ -929,8 +959,8 @@
</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="N10201"></a><a name="encoding"></a>
-<h4 class="faq">2.14. Does Forrest handle accents for non-English
languages?</h4>
+<a name="N1020F"></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>
</div>
@@ -976,8 +1006,8 @@
Schlabach</a> and <a href="http://www.alanwood.net/unicode/";>Alan
Wood's Unicode
resources</a>. </p>
</div>
-<a name="N10253"></a><a name="xml-entities"></a>
-<h4 class="faq">2.15. How to use XML entities, for example string
+<a name="N10261"></a><a name="xml-entities"></a>
+<h4 class="faq">2.16. How to use XML entities, for example string
replacement?</h4>
<div align="right">
<a href="#xml-entities-menu">^</a>
@@ -992,8 +1022,8 @@
Avoid lengthy typing and potential spelling errors.
</p>
</div>
-<a name="N1025E"></a><a name="cleanSite"></a>
-<h4 class="faq">2.16. How to make Forrest clean up the project build
directories? </h4>
+<a name="N1026C"></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>
</div>
@@ -1011,8 +1041,8 @@
Doing 'forrest clean' will remove both sections.
</p>
</div>
-<a name="N10269"></a><a name="i18n"></a>
-<h4 class="faq">2.17. How can I internationalise (i18n) my content?</h4>
+<a name="N10277"></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>
</div>
@@ -1025,8 +1055,8 @@
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="N1027C"></a><a name="rawTML"></a>
-<h4 class="faq">2.18. How can I include HTML content that is not to be skinned
by Forrest?</h4>
+<a name="N1028A"></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>
</div>
@@ -1066,8 +1096,8 @@
</ol>
</div>
-<a name="N102A2"></a><a name="javascript"></a>
-<h4 class="faq">2.19. How to include additional Javascript and CSS files?</h4>
+<a name="N102B0"></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>
</div>
@@ -1090,9 +1120,9 @@
<map:resource name="skin-read"> section.
</p>
</div>
-<a name="N102B0"></a><a name="technical"></a>
+<a name="N102BE"></a><a name="technical"></a>
<h3 class="underlined_5">3. Technical</h3>
-<a name="N102B4"></a><a name="proxy_config"></a>
+<a name="N102C2"></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">
@@ -1103,7 +1133,7 @@
<span class="codefrag">proxy.host</span> and <span
class="codefrag">proxy.port</span> accordingly (the port will default
to port 80).</p>
</div>
-<a name="N102C5"></a><a name="CVS_revison_tags"></a>
+<a name="N102D3"></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>
@@ -1116,7 +1146,7 @@
<p>This technique could also be used for a modification date with $Date:
2004/01/15 08:52:47
$</p>
</div>
-<a name="N102D7"></a><a name="cli-xconf"></a>
+<a name="N102E5"></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">
@@ -1154,7 +1184,7 @@
<strong>foo/**</strong> to match that. </div>
</div>
</div>
-<a name="N10314"></a><a name="ignoring_javadocs"></a>
+<a name="N10322"></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">
@@ -1165,7 +1195,7 @@
<span class="codefrag">cli.xconf</span>
</a> Cocoon config file, and defining patterns for URLs to exclude.
</p>
</div>
-<a name="N10323"></a><a name="claimed_patterns"></a>
+<a name="N10331"></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>
@@ -1181,7 +1211,7 @@
with this issue (<a
href="http://issues.apache.org/jira/browse/FOR-217";>FOR-217</a>).
</p>
</div>
-<a name="N10335"></a><a name="build_msg_a"></a>
+<a name="N10343"></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">
@@ -1214,7 +1244,7 @@
</p>
</div>
-<a name="N10351"></a><a name="headless_operation"></a>
+<a name="N1035F"></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">
@@ -1227,7 +1257,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="N1036D"></a><a name="project-logo-svg"></a>
+<a name="N1037B"></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>
@@ -1247,7 +1277,7 @@
<a href="http://www.w3.org/Graphics/SVG/";>SVG</a> resources.
</p>
</div>
-<a name="N10385"></a><a name="catalog"></a>
+<a name="N10393"></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">
@@ -1257,7 +1287,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="N10391"></a><a name="skin"></a>
+<a name="N1039F"></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>
@@ -1269,7 +1299,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="N103A8"></a><a name="xsp"></a>
+<a name="N103B6"></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>
@@ -1317,7 +1347,7 @@
</ol>
<p>See also the <a
href="http://wiki.apache.org/cocoon/AddingXSPToForrest";>AddingXSPToForrest</a>
Wiki page.</p>
</div>
-<a name="N103E3"></a><a name="breadcrumbs"></a>
+<a name="N103F1"></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>
@@ -1336,7 +1366,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="N103F8"></a><a name="run_port"></a>
+<a name="N10406"></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>
@@ -1352,7 +1382,7 @@
</p>
</div>
-<a name="N1040C"></a><a name="debugging"></a>
+<a name="N1041A"></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>
@@ -1364,9 +1394,9 @@
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="N1041D"></a><a name="old_faqs"></a>
+<a name="N1042B"></a><a name="old_faqs"></a>
<h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N10421"></a><a name="old_claimed_patterns"></a>
+<a name="N1042F"></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>
@@ -1382,9 +1412,9 @@
with this issue (<a
href="http://issues.apache.org/jira/browse/FOR-217";>FOR-217</a>).
</p>
</div>
-<a name="N10433"></a><a name="general"></a>
+<a name="N10441"></a><a name="general"></a>
<h3 class="underlined_5">5. General</h3>
-<a name="N10437"></a><a name="generating_menus"></a>
+<a name="N10445"></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>
@@ -1398,7 +1428,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="N10452"></a><a name="docbook"></a>
+<a name="N10460"></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>
@@ -1444,7 +1474,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="N10480"></a><a name="version"></a>
+<a name="N1048E"></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">
@@ -1457,7 +1487,7 @@
watch the build messages. Doing <span class="codefrag">'forrest
-v'</span> will provide verbose build
messages. </p>
</div>
-<a name="N10494"></a><a name="logs"></a>
+<a name="N104A2"></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>
@@ -1476,7 +1506,7 @@
<p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose
build messages to the standard
output. </p>
</div>
-<a name="N104B8"></a><a name="how_can_I_help"></a>
+<a name="N104C6"></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>
@@ -1487,7 +1517,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="N104C4"></a><a name="patch"></a>
+<a name="N104D2"></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_80/faq.pdf
URL:
http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.pdf?rev=359950&r1=359949&r2=359950&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=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Thu Dec 29 16:35:30 2005
@@ -145,7 +145,26 @@
are included with the distribution (<code>cd forrest/site-author;
forrest run</code>).
</p>
- </section><section id="PDF-output"><title>2.4. How can I generate one
pdf-file out of the whole site or selected pages of the site?</title>
+ </section><section id="crawler"><title>2.4.
+ Help, one of my documents is not being rendered.
+ </title>
+ <p>
+ Did you make a link to it? Forrest does not find documents by
scanning
+ the filesystem to find the source documents. Rather it starts at one
+ document and crawls the links to find other documents to process.
+ </p>
+ <p>
+ There are essentially two ways to create links. Via a site.xml file
to define the
+ navigation and menu structure, or via direct relative linking. See
the
+ to previous FAQs.
+ </p>
+ <p>
+ Normally the source material will be local. The Forrest crawler does
not follow
+ and process off-site links. The new locationmap (0.8+) enables
content
+ to be drawn from remote sources.
+
+ </p>
+ </section><section id="PDF-output"><title>2.5. How can I generate one
pdf-file out of the whole site or selected pages of the site?</title>
<p>Add the following entries to your site.xml file:</p>
<source xml:space="preserve">
<about tab="home" label="About" href="">
@@ -159,7 +178,7 @@
tab</link>.) </p>
<p> This assumes that you use the <link
href="site:v0.80//linking">site.xml</link> method for your
site structure and navigation, rather than the old book.xml method.
</p>
- </section><section id="pageBreaks"><title>2.5. How do I insert page
breaks into documents?</title>
+ </section><section id="pageBreaks"><title>2.6. How do I insert page
breaks into documents?</title>
<p>Page breaks do not make a great deal of sense in HTML documents
intended for display on a
screen. However, PDF documents are intended for printing and
therefore page breaks can be
important.</p>
@@ -180,16 +199,16 @@
margin-bottom: 0;
page-break-after: always;
} </source>
- </section><section id="clickable-email-address"><title>2.6. How can I
generate html-pages to show a 'clickable' email-address (of the
+ </section><section id="clickable-email-address"><title>2.7. How can I
generate html-pages to show a 'clickable' email-address (of the
author-element)?</title>
<p>You would override <code>
$FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</code> and
edit the
"headers/authors" template. </p>
- </section><section id="link_raw"><title>2.7. How do I link to raw files
such as config.txt and brochure.pdf? </title>
+ </section><section id="link_raw"><title>2.8. How do I link to raw files
such as config.txt and brochure.pdf? </title>
<p>Handling of raw files was significantly changed in Forrest 0.7. See
<link href="site:v0.70//upgrading_07/raw">Upgrading to Apache
Forrest 0.7</link> for
all the details.</p>
- </section><section id="pdf_images"><title>2.8. Images don't display in
PDFs. How do I fix this?</title>
+ </section><section id="pdf_images"><title>2.9. Images don't display in
PDFs. How do I fix this?</title>
<p> Forrest uses <link href="http://xml.apache.org/fop/";>Apache
FOP</link> for rendering
PDFs. FOP cannot handle all image types natively, and requires
third-party jars to be
added. FOP natively handles BMP, GIF, JPG, TIFF and EPS (with a few
limitations). FOP can
@@ -206,7 +225,7 @@
<code>http://java.sun.com/products/java-media/jai</code>). For more
info, see <link href="http://xml.apache.org/fop/graphics.html#packages";>FOP
Graphics Packages</link>
</p>
<note>Due to Sun's licensing, we cannot redistribute Jimi or JAI with
Forrest.</note>
- </section><section id="tab-index"><title>2.9. The tab link in my site
incorrectly assumes that 'index.html' is present in the
+ </section><section id="tab-index"><title>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? </title>
<p> In <code>tabs.xml</code>, use @href instead of @dir, and omit the
trailing '/'. Which
file to serve is then a concern of the sitemap. For example, if the
"User Manual" tab
@@ -219,11 +238,11 @@
<map:match pattern="manual">
<map:redirect-to uri="manual/Introduction.html"/>
</map:match></source>
- </section><section id="tab-site"><title>2.10. I need help with the
interaction between tabs.xml and site.xml </title>
+ </section><section id="tab-site"><title>2.11. I need help with the
interaction between tabs.xml and site.xml </title>
<p>
See the <link href="site:v0.80//linking/tab-site">tips</link>.
</p>
- </section><section id="defaultFileName"><title>2.11. How can I change
the default file name that Forrest will look for when I request a
+ </section><section id="defaultFileName"><title>2.12. How can I change
the default file name that Forrest will look for when I request a
URL like <code>http://myserver</code> or
<code>http://myserver/mydir/</code> ? </title>
<p>To change the default file name from 'index.html' (default) to
'overview.html' you need to
make the following changes:</p>
@@ -241,7 +260,7 @@
</map:pipeline>
</source></li>
</ol>
- </section><section id="defaultStartPage"><title>2.12. How can I use a
start-up-page other than index.html? </title>
+ </section><section id="defaultStartPage"><title>2.13. How can I use a
start-up-page other than index.html? </title>
<p>Forrest by default assumes that the first page (home page) of your
site is named
index.html. Which is good because most web servers are configured to
look for index.html
when you call a url like http://myserver</p>
@@ -260,12 +279,12 @@
<li>Name the uri-attribute whatever you'd like your start page to
be.</li>
<li>Don't forget to create that page and refer to it in your
site.xml</li>
</ol>
- </section><section id="label-entity"><title>2.13. How to use special
characters in the labels of the site.xml file? </title>
+ </section><section id="label-entity"><title>2.14. How to use special
characters in the labels of the site.xml file? </title>
<p> Use the numeric values for character entities. For example, rather
than using
<code>&ouml;</code> use <code>&#246;</code>
</p>
<p> See the <link
href="http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_xhtml_character_entities";>XHTML
Character Entities</link> and see more discussion at <link
href="http://issues.apache.org/jira/browse/FOR-244";>Issue FOR-244</link>. </p>
- </section><section id="encoding"><title>2.14. Does Forrest handle
accents for non-English languages?</title>
+ </section><section id="encoding"><title>2.15. Does Forrest handle
accents for non-English languages?</title>
<p>Yes, Forrest can process text in any language, so you can
include:</p>
<ul>
<li>accents: á é í ó ú</li>
@@ -302,7 +321,7 @@
<p>Here are some references which explain further: <link
href="http://orixo.com/events/gt2004/bios.html#torsten";>GT2004 presentation by
Torsten
Schlabach</link> and <link
href="http://www.alanwood.net/unicode/";>Alan Wood's Unicode
resources</link>. </p>
- </section><section id="xml-entities"><title>2.15. How to use XML
entities, for example string
+ </section><section id="xml-entities"><title>2.16. How to use XML
entities, for example string
replacement?</title>
<p>
A set of symbols is available. See the demonstration
@@ -312,7 +331,7 @@
"My Project Name™".
Avoid lengthy typing and potential spelling errors.
</p>
- </section><section id="cleanSite"><title>2.16. How to make Forrest
clean up the project build directories? </title>
+ </section><section id="cleanSite"><title>2.17. How to make Forrest
clean up the project build directories? </title>
<p>
By default Forrest does not clean its build directories in the
project
workspaces. This enables Cocoon to use its disk cache to speed up
@@ -325,7 +344,7 @@
include the Cocoon cache and the Cocoon logs).
Doing 'forrest clean' will remove both sections.
</p>
- </section><section id="i18n"><title>2.17. How can I internationalise
(i18n) my content?</title>
+ </section><section id="i18n"><title>2.18. How can I internationalise
(i18n) my content?</title>
<p>The i18n features of Forrest are still under development (as of
0.7) however there are
some features available. For example, navigation menus can be i18n'd
(see fresh-site for an
example). Currently, <link
href="http://issues.apache.org/jira/browse/FOR-506";>work is underway</link> to
@@ -334,7 +353,7 @@
<p>All internationalistation of tokens in, for example, the skins and
the menus, is carried out
by the <link
href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html";>Cocoon
i18n
Transformer</link>. You can see an example of how it works in the
above linked issue.</p>
- </section><section id="rawTML"><title>2.18. How can I include HTML
content that is not to be skinned by Forrest?</title>
+ </section><section id="rawTML"><title>2.19. How can I include HTML
content that is not to be skinned by Forrest?</title>
<p>To serve, for example a legacy HTML site, add something like the
following
to your project's sitemap and place the source content at the
<code>src/documentation/content/xdocs/old_site/</code> directory.</p>
@@ -361,7 +380,7 @@
<li>forrest</li>
<li><link
href="http://localhost:8888/samples/linking.html#no-decoration";>Read the
doc</link></li>
</ol>
- </section><section id="javascript"><title>2.19. How to include
additional Javascript and CSS files?</title>
+ </section><section id="javascript"><title>2.20. How to include
additional Javascript and CSS files?</title>
<p>
Place various resources (e.g. javascript, css) into the
"project skins" directory. The default forrest.properties
Modified: forrest/site/linkmap.html
URL:
http://svn.apache.org/viewcvs/forrest/site/linkmap.html?rev=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/linkmap.html (original)
+++ forrest/site/linkmap.html Thu Dec 29 16:35:30 2005
@@ -60,8 +60,8 @@
|start Tabs
+-->
<ul id="tabs">
-<li>
-<a class="base-not-selected" href="index.html">Welcome</a>
+<li class="current">
+<a class="base-selected" href="index.html">Welcome</a>
</li>
<li>
<a class="base-not-selected" href="contrib.html">Project</a>
@@ -132,57 +132,9 @@
<a href="live-sites.html">Example sites</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title"
class="menutitle">Getting Involved</div>
+<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title"
class="menutitle">Related projects</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="contrib.html">Contributing</a>
-</div>
-<div class="menuitem">
-<a href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/";>Browse SVN</a>
-</div>
-<div class="menuitem">
-<a href="mail-lists.html">Mail lists</a>
-</div>
-<div class="menuitem">
-<a href="issues.html">Bugs and Issues</a>
-</div>
-<div class="menuitem">
-<a href="forrest-issues.html">Open Issues</a>
-</div>
-<div class="menuitem">
-<a href="gump.html">Gump Integration</a>
-</div>
-<div class="menuitem">
-<a href="guidelines.html">Project guidelines</a>
-</div>
-<div class="menuitem">
-<a href="committed.html">Being committed</a>
-</div>
-<div class="menuitem">
-<a href="forrest-friday.html" title="ForrestFriday monthly
get-together">ForrestFriday</a>
-</div>
-<div class="menuitem">
-<a href="zone.html" title="Notes for committers to manage
forrest.zones.apache.org">Zone notes</a>
-</div>
-<div onclick="SwitchMenu('menu_1.2.11', 'skin/')" id="menu_1.2.11Title"
class="menutitle">Planning notes</div>
-<div id="menu_1.2.11" class="menuitemgroup">
-<div class="menuitem">
-<a href="plan/index.html">Overview</a>
-</div>
-<div class="menuitem">
-<a href="plan/internal-xhtml.html">Internal XHTML</a>
-</div>
-</div>
-</div>
-<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title"
class="menutitle">Proposals</div>
-<div id="menu_1.3" class="menuitemgroup">
-<div class="menuitem">
-<a href="proposal-asf-forrestbot.html">ASF Forrestbot</a>
-</div>
-</div>
-<div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title"
class="menutitle">Related projects</div>
-<div id="menu_1.4" class="menuitemgroup">
-<div class="menuitem">
<a href="http://gump.apache.org/";>Apache Gump</a>
</div>
<div class="menuitem">
@@ -195,27 +147,6 @@
<a href="http://xml.apache.org/";>Apache XML</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title"
class="menutitle">Tools</div>
-<div id="menu_1.5" class="menuitemgroup">
-<div class="menuitem">
-<a href="tools/index.html">Index</a>
-</div>
-<div class="menuitem">
-<a href="tools/forrestbar.html">ForrestBar</a>
-</div>
-<div class="menuitem">
-<a href="tools/forrestbot.html">Forrestbot</a>
-</div>
-<div class="menuitem">
-<a href="tools/forrestbot-web-interface.html">Forrestbot Webapp</a>
-</div>
-<div class="menuitem">
-<a href="tools/eclipse.html">Eclipse Plugin</a>
-</div>
-<div class="menuitem">
-<a href="tools/xxe.html">XXE-Editor</a>
-</div>
-</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt=""
src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
@@ -260,7 +191,6 @@
<ul>
-
<ul>
<li>
@@ -285,6 +215,7 @@
<a
href="http://forrest.apache.org/mirrors.cgi";>Download</a> _________________________ <em>download</em>
</li>
</ul>
+
<ul>
Modified: forrest/site/menu-index.html
URL:
http://svn.apache.org/viewcvs/forrest/site/menu-index.html?rev=359950&r1=359949&r2=359950&view=diff
==============================================================================
--- forrest/site/menu-index.html (original)
+++ forrest/site/menu-index.html Thu Dec 29 16:35:30 2005
@@ -18,6 +18,7 @@
</li>
+
<li>
<a href="who.html">Who we are</a>
</li>
