forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r359698 - in /forrest/site: broken-links.xml docs_0_80/faq.html docs_0_80/faq.pdf docs_0_80/faq.xml
Date Thu, 29 Dec 2005 03:23:34 GMT
Author: crossley
Date: Wed Dec 28 19:23:21 2005
New Revision: 359698

URL: http://svn.apache.org/viewcvs?rev=359698&view=rev
Log:
Automatic publish from forrestbot

Modified:
    forrest/site/broken-links.xml
    forrest/site/docs_0_80/faq.html
    forrest/site/docs_0_80/faq.pdf
    forrest/site/docs_0_80/faq.xml

Modified: forrest/site/broken-links.xml
URL: http://svn.apache.org/viewcvs/forrest/site/broken-links.xml?rev=359698&r1=359697&r2=359698&view=diff
==============================================================================
--- forrest/site/broken-links.xml (original)
+++ forrest/site/broken-links.xml Wed Dec 28 19:23:21 2005
@@ -1,5 +1,2 @@
 <broken-links>
-  <link message="/svn/asf/forrest/site-author/./content/xdocs/images.docs_0_60/howto/bugzilla-patch/bugzilla-screen.gif
(No such file or directory)" uri="docs_0_60/howto/bugzilla-patch/my-images/bugzilla-screen.gif">
-    <referrer uri="docs_0_60/howto/bugzilla-patch/howto-bugzilla-patch.html"/>
-  </link>
 </broken-links>

Modified: forrest/site/docs_0_80/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=359698&r1=359697&r2=359698&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Wed Dec 28 19:23:21 2005
@@ -590,7 +590,7 @@
         </pre>
 <p>
           Uncomment that and set it to the specific page that
-          you want. Forest will build that page, then of course
+          you want. Forrest will build that page, then of course
           it will keep crawling links from there. It might be
           confined to a sub-directory, but depending on links
           could end up generating the whole site.
@@ -598,15 +598,21 @@
 <p>
           The main thing is that your page of interest is built first.
           You can terminate forrest with 'kill' or Ctrl-C after it
-          has built your page of interest.
+          has built your pages of interest.
         </p>
 <p>
-          Forrest can also be instructed to not process certain URIs
-          if you need to temporarily exclude then. Use the
-          <a href="#cli-xconf">Cocoon cli.xconf</a> file.
+          Cocoon can be instructed via the
+          <a href="#cli-xconf">Cocoon cli.xconf</a> file to not
+          follow links (see its "follow-links" parameter). So this will
+          build only the document that was specified. Be careful, if you
+          also usually build PDF pages, then they will not be built.
+        </p>
+<p>
+          Cocoon can also be instructed to not process certain URIs
+          if you need to temporarily exclude then.
         </p>
 </div>
-<a name="N1005B"></a><a name="cygwin_mutex_error"></a>
+<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:
           *** can't create title mutex, Win32 error 6. </h4>
 <div align="right">
@@ -616,7 +622,7 @@
 <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="N1006D"></a><a name="maxmemory"></a>
+<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>
 <div align="right">
 <a href="#maxmemory-menu">^</a>
@@ -634,7 +640,7 @@
           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="N1008A"></a><a name="debug"></a>
+<a name="N1008D"></a><a name="debug"></a>
 <h4 class="faq">1.8.  How can I start forrest in debug mode? </h4>
 <div align="right">
 <a href="#debug-menu">^</a>
@@ -646,9 +652,9 @@
         
 </p>
 </div>
-<a name="N1009B"></a><a name="content_faqs"></a>
+<a name="N1009E"></a><a name="content_faqs"></a>
 <h3 class="underlined_5">2. Content Creation</h3>
-<a name="N1009F"></a><a name="edit-content"></a>
+<a name="N100A2"></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>
@@ -664,7 +670,7 @@
           you can use text editors or "html editors" such as the one provided with the Mozilla
web
           browser. </p>
 </div>
-<a name="N100B9"></a><a name="site-xml"></a>
+<a name="N100BC"></a><a name="site-xml"></a>
 <h4 class="faq">2.2. 
         How to use the site.xml configuration file for menus and linking.
       </h4>
@@ -706,7 +712,7 @@
         </p>
 <pre class="code">&lt;a href="site:docbook"&gt; link to the DocBook FAQ in
the Tech FAQs</pre>
 </div>
-<a name="N100E7"></a><a name="examples"></a>
+<a name="N100EA"></a><a name="examples"></a>
 <h4 class="faq">2.3. 
         Where are examples of documents and site.xml and tabs.xml files?
       </h4>
@@ -720,7 +726,7 @@
             forrest run</span>).
         </p>
 </div>
-<a name="N100F2"></a><a name="PDF-output"></a>
+<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>
 <div align="right">
 <a href="#PDF-output-menu">^</a>
@@ -740,7 +746,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="N1010C"></a><a name="pageBreaks"></a>
+<a name="N1010F"></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>
@@ -768,7 +774,7 @@
             page-break-after: always; 
             } </pre>
 </div>
-<a name="N1012A"></a><a name="clickable-email-address"></a>
+<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
         author-element)?</h4>
 <div align="right">
@@ -779,7 +785,7 @@
             $FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</span>
and edit the
           "headers/authors" template. </p>
 </div>
-<a name="N10135"></a><a name="link_raw"></a>
+<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>
 <div align="right">
 <a href="#link_raw-menu">^</a>
@@ -789,7 +795,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="N10141"></a><a name="pdf_images"></a>
+<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>
 <div align="right">
 <a href="#pdf_images-menu">^</a>
@@ -821,7 +827,7 @@
 <div class="content">Due to Sun's licensing, we cannot redistribute Jimi or JAI with
Forrest.</div>
 </div>
 </div>
-<a name="N10171"></a><a name="tab-index"></a>
+<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
         linked-to directory. How do I fix this? </h4>
 <div align="right">
@@ -840,7 +846,7 @@
     &lt;map:redirect-to uri="manual/Introduction.html"/&gt;
   &lt;/map:match&gt;</pre>
 </div>
-<a name="N1018D"></a><a name="tab-site"></a>
+<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>
 <div align="right">
 <a href="#tab-site-menu">^</a>
@@ -850,7 +856,7 @@
           See the <a href="../docs_0_80/linking.html#tab-site">tips</a>.
         </p>
 </div>
-<a name="N10199"></a><a name="defaultFileName"></a>
+<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
         URL like http://myserver or http://myserver/mydir/ ? </h4>
 <div align="right">
@@ -880,7 +886,7 @@
         
 </ol>
 </div>
-<a name="N101C1"></a><a name="defaultStartPage"></a>
+<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>
 <div align="right">
 <a href="#defaultStartPage-menu">^</a>
@@ -911,7 +917,7 @@
         
 </ol>
 </div>
-<a name="N101E5"></a><a name="label-entity"></a>
+<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>
 <div align="right">
 <a href="#label-entity-menu">^</a>
@@ -923,7 +929,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="N101FE"></a><a name="encoding"></a>
+<a name="N10201"></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>
@@ -970,7 +976,7 @@
             Schlabach</a> and <a href="http://www.alanwood.net/unicode/">Alan
Wood's Unicode
             resources</a>. </p>
 </div>
-<a name="N10250"></a><a name="xml-entities"></a>
+<a name="N10253"></a><a name="xml-entities"></a>
 <h4 class="faq">2.15. How to use XML entities, for example string
         replacement?</h4>
 <div align="right">
@@ -986,7 +992,7 @@
           Avoid lengthy typing and potential spelling errors.
         </p>
 </div>
-<a name="N1025B"></a><a name="cleanSite"></a>
+<a name="N1025E"></a><a name="cleanSite"></a>
 <h4 class="faq">2.16.  How to make Forrest clean up the project build directories?
</h4>
 <div align="right">
 <a href="#cleanSite-menu">^</a>
@@ -1005,7 +1011,7 @@
         Doing 'forrest clean' will remove both sections.
         </p>
 </div>
-<a name="N10266"></a><a name="i18n"></a>
+<a name="N10269"></a><a name="i18n"></a>
 <h4 class="faq">2.17. How can I internationalise (i18n) my content?</h4>
 <div align="right">
 <a href="#i18n-menu">^</a>
@@ -1019,7 +1025,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="N10279"></a><a name="rawTML"></a>
+<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>
 <div align="right">
 <a href="#rawTML-menu">^</a>
@@ -1060,7 +1066,7 @@
         
 </ol>
 </div>
-<a name="N1029F"></a><a name="javascript"></a>
+<a name="N102A2"></a><a name="javascript"></a>
 <h4 class="faq">2.19. How to include additional Javascript and CSS files?</h4>
 <div align="right">
 <a href="#javascript-menu">^</a>
@@ -1084,9 +1090,9 @@
           &lt;map:resource name="skin-read"&gt; section.
         </p>
 </div>
-<a name="N102AD"></a><a name="technical"></a>
+<a name="N102B0"></a><a name="technical"></a>
 <h3 class="underlined_5">3. Technical</h3>
-<a name="N102B1"></a><a name="proxy_config"></a>
+<a name="N102B4"></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">
@@ -1097,7 +1103,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="N102C2"></a><a name="CVS_revison_tags"></a>
+<a name="N102C5"></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>
@@ -1110,7 +1116,7 @@
 <p>This technique could also be used for a modification date with $Date: 2004/01/15
08:52:47
           $</p>
 </div>
-<a name="N102D4"></a><a name="cli-xconf"></a>
+<a name="N102D7"></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">
@@ -1148,7 +1154,7 @@
           <strong>foo/**</strong> to match that. </div>
 </div>
 </div>
-<a name="N10311"></a><a name="ignoring_javadocs"></a>
+<a name="N10314"></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">
@@ -1159,7 +1165,7 @@
             <span class="codefrag">cli.xconf</span>
           </a> Cocoon config file, and defining patterns for URLs to exclude. </p>
 </div>
-<a name="N10320"></a><a name="claimed_patterns"></a>
+<a name="N10323"></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>
@@ -1175,7 +1181,7 @@
           with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
         </p>
 </div>
-<a name="N10332"></a><a name="build_msg_a"></a>
+<a name="N10335"></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">
@@ -1208,7 +1214,7 @@
       
 </p>
 </div>
-<a name="N1034E"></a><a name="headless_operation"></a>
+<a name="N10351"></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">
@@ -1221,7 +1227,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="N1036A"></a><a name="project-logo-svg"></a>
+<a name="N1036D"></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>
@@ -1241,7 +1247,7 @@
           <a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources.
         </p>
 </div>
-<a name="N10382"></a><a name="catalog"></a>
+<a name="N10385"></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">
@@ -1251,7 +1257,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="N1038E"></a><a name="skin"></a>
+<a name="N10391"></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>
@@ -1263,7 +1269,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="N103A5"></a><a name="xsp"></a>
+<a name="N103A8"></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>
@@ -1311,7 +1317,7 @@
 </ol>
 <p>See also the <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a>
Wiki page.</p>
 </div>
-<a name="N103E0"></a><a name="breadcrumbs"></a>
+<a name="N103E3"></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>
@@ -1330,7 +1336,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="N103F5"></a><a name="run_port"></a>
+<a name="N103F8"></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>
@@ -1346,7 +1352,7 @@
         
 </p>
 </div>
-<a name="N10409"></a><a name="debugging"></a>
+<a name="N1040C"></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>
@@ -1358,9 +1364,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="N1041A"></a><a name="old_faqs"></a>
+<a name="N1041D"></a><a name="old_faqs"></a>
 <h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N1041E"></a><a name="old_claimed_patterns"></a>
+<a name="N10421"></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>
@@ -1376,9 +1382,9 @@
           with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
         </p>
 </div>
-<a name="N10430"></a><a name="general"></a>
+<a name="N10433"></a><a name="general"></a>
 <h3 class="underlined_5">5. General</h3>
-<a name="N10434"></a><a name="generating_menus"></a>
+<a name="N10437"></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>
@@ -1392,7 +1398,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="N1044F"></a><a name="docbook"></a>
+<a name="N10452"></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>
@@ -1438,7 +1444,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="N1047D"></a><a name="version"></a>
+<a name="N10480"></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">
@@ -1451,7 +1457,7 @@
           watch the build messages. Doing <span class="codefrag">'forrest -v'</span>
will provide verbose build
           messages. </p>
 </div>
-<a name="N10491"></a><a name="logs"></a>
+<a name="N10494"></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>
@@ -1470,7 +1476,7 @@
 <p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose
build messages to the standard
           output. </p>
 </div>
-<a name="N104B5"></a><a name="how_can_I_help"></a>
+<a name="N104B8"></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>
@@ -1481,7 +1487,7 @@
           particularly from newcomers&mdash;often, close proximity blinds software developers
to
           faults that are obvious to everyone else. Don't be shy! </p>
 </div>
-<a name="N104C1"></a><a name="patch"></a>
+<a name="N104C4"></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=359698&r1=359697&r2=359698&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=359698&r1=359697&r2=359698&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Wed Dec 28 19:23:21 2005
@@ -45,7 +45,7 @@
 
         <p>
           Uncomment that and set it to the specific page that
-          you want. Forest will build that page, then of course
+          you want. Forrest will build that page, then of course
           it will keep crawling links from there. It might be
           confined to a sub-directory, but depending on links
           could end up generating the whole site.
@@ -54,13 +54,20 @@
         <p>
           The main thing is that your page of interest is built first.
           You can terminate forrest with 'kill' or Ctrl-C after it
-          has built your page of interest.
+          has built your pages of interest.
         </p>
 
         <p>
-          Forrest can also be instructed to not process certain URIs
-          if you need to temporarily exclude then. Use the
-          <link href="#cli-xconf">Cocoon cli.xconf</link> file.
+          Cocoon can be instructed via the
+          <link href="#cli-xconf">Cocoon cli.xconf</link> file to not
+          follow links (see its "follow-links" parameter). So this will
+          build only the document that was specified. Be careful, if you
+          also usually build PDF pages, then they will not be built.
+        </p>
+
+        <p>
+          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:
           *** can't create title mutex, Win32 error 6</code>. </title>



Mime
View raw message