Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 70022 invoked from network); 29 Dec 2005 03:23:58 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 29 Dec 2005 03:23:58 -0000 Received: (qmail 13648 invoked by uid 500); 29 Dec 2005 03:23:57 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 13606 invoked by uid 500); 29 Dec 2005 03:23:57 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Forrest Developers List" List-Id: Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 13592 invoked by uid 99); 29 Dec 2005 03:23:56 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 28 Dec 2005 19:23:56 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Wed, 28 Dec 2005 19:23:55 -0800 Received: (qmail 69917 invoked by uid 65534); 29 Dec 2005 03:23:35 -0000 Message-ID: <20051229032335.69916.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit 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 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N 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 @@ - - - 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 @@

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 @@

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.

- Forrest can also be instructed to not process certain URIs - if you need to temporarily exclude then. Use the - Cocoon cli.xconf file. + Cocoon can be instructed via the + Cocoon cli.xconf 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. +

+

+ Cocoon can also be instructed to not process certain URIs + if you need to temporarily exclude then.

- +

1.6. When running ./build.sh in cygwin, I get an error: cygpath.exe: *** can't create title mutex, Win32 error 6.

@@ -616,7 +622,7 @@

This appears to be a bug in cygwin. Please use the .bat script instead.

- +

1.7. How can I specify the amount of memory to be used by Java?

^ @@ -634,7 +640,7 @@ value you set it to is dependant on your JVM, but something like ANT_OPTS=-Xmx500M will probably work.

- +

1.8. How can I start forrest in debug mode?

^ @@ -646,9 +652,9 @@

- +

2. Content Creation

- +

2.1. What tools can be used to edit the content?

^ @@ -664,7 +670,7 @@ you can use text editors or "html editors" such as the one provided with the Mozilla web browser.

- +

2.2. How to use the site.xml configuration file for menus and linking.

@@ -706,7 +712,7 @@

<a href="site:docbook"> link to the DocBook FAQ in the Tech FAQs
- +

2.3. Where are examples of documents and site.xml and tabs.xml files?

@@ -720,7 +726,7 @@ forrest run).

- +

2.4. How can I generate one pdf-file out of the whole site or selected pages of the site?

^ @@ -740,7 +746,7 @@

This assumes that you use the site.xml method for your site structure and navigation, rather than the old book.xml method.

- +

2.5. How do I insert page breaks into documents?

^ @@ -768,7 +774,7 @@ page-break-after: always; }
- +

2.6. How can I generate html-pages to show a 'clickable' email-address (of the author-element)?

@@ -779,7 +785,7 @@ $FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl and edit the "headers/authors" template.

- +

2.7. How do I link to raw files such as config.txt and brochure.pdf?

^ @@ -789,7 +795,7 @@ Upgrading to Apache Forrest 0.7 for all the details.

- +

2.8. Images don't display in PDFs. How do I fix this?

^ @@ -821,7 +827,7 @@
Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.
- +

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?

@@ -840,7 +846,7 @@ <map:redirect-to uri="manual/Introduction.html"/> </map:match>
- +

2.10. I need help with the interaction between tabs.xml and site.xml

^ @@ -850,7 +856,7 @@ See the tips.

- +

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/ ?

@@ -880,7 +886,7 @@
- +

2.12. How can I use a start-up-page other than index.html?

^ @@ -911,7 +917,7 @@
- +

2.13. How to use special characters in the labels of the site.xml file?

^ @@ -923,7 +929,7 @@

See the XHTML Character Entities and see more discussion at Issue FOR-244.

- +

2.14. Does Forrest handle accents for non-English languages?

^ @@ -970,7 +976,7 @@ Schlabach and Alan Wood's Unicode resources.

- +

2.15. How to use XML entities, for example string replacement?

@@ -986,7 +992,7 @@ Avoid lengthy typing and potential spelling errors.

- +

2.16. How to make Forrest clean up the project build directories?

^ @@ -1005,7 +1011,7 @@ Doing 'forrest clean' will remove both sections.

- +

2.17. How can I internationalise (i18n) my content?

^ @@ -1019,7 +1025,7 @@ by the Cocoon i18n Transformer. You can see an example of how it works in the above linked issue.

- +

2.18. How can I include HTML content that is not to be skinned by Forrest?

^ @@ -1060,7 +1066,7 @@
- +

2.19. How to include additional Javascript and CSS files?

^ @@ -1084,9 +1090,9 @@ <map:resource name="skin-read"> section.

- +

3. Technical

- +

3.1. I'm behind a proxy and it's preventing Plugins from being downloaded, what should I do?

@@ -1097,7 +1103,7 @@ proxy.host and proxy.port accordingly (the port will default to port 80).

- +

3.2. How can I generate html-pages to show the revision tag of cvs?

^ @@ -1110,7 +1116,7 @@

This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47 $

- +

3.3. How to control the processing of URIs by Cocoon, e.g. exclude certain URIs, include other additional ones.

@@ -1148,7 +1154,7 @@ foo/** to match that.
- +

3.4. How do I stop Forrest breaking on links to external files that may not exist, like javadocs?

@@ -1159,7 +1165,7 @@ cli.xconf Cocoon config file, and defining patterns for URLs to exclude.

- +

3.5. Some of my files are not being processed because they use common filenames.

^ @@ -1175,7 +1181,7 @@ with this issue (FOR-217).

- +

3.6. What do the symbols and numbers mean when Forrest lists each document that it has built?

@@ -1208,7 +1214,7 @@

- +

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.

@@ -1221,7 +1227,7 @@
forrest -Dforrest.jvmargs=-Djava.awt.headless=true site

See also Cocoon FAQ.

- +

3.8. The project logo that is generated from SVG is truncating my project name.

@@ -1241,7 +1247,7 @@ SVG resources.

- +

3.9. How do i configure my favourite XML editor or parser to find the local Forrest DTDs?

@@ -1251,7 +1257,7 @@

Notes are provided for various tools at Using Catalog Entity Resolver for local DTDs.

- +

3.10. How to make the site look better and change its skin?

^ @@ -1263,7 +1269,7 @@

See notes about configuration of the skins. Some projects may have special needs and can define their own skin.

- +

3.11. How do I enable XSP processing?

^ @@ -1311,7 +1317,7 @@

See also the AddingXSPToForrest Wiki page.

- +

3.12. How do breadcrumbs work? Why don't they work locally?

^ @@ -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 skinconf.xml.

- +

3.13. How do I make forrest run listen on a different port?

^ @@ -1346,7 +1352,7 @@

- +

3.14. Can I run Forrest with Java debugging turned on?

^ @@ -1358,9 +1364,9 @@ to the forrest.jvmargs property in the forrest.properties file. Don't forget to ensure the property is uncommented in that file.

- +

4. Older version: 0.6

- +

4.1. Some of my files are not being processed because they use common filenames.

^ @@ -1376,9 +1382,9 @@ with this issue (FOR-217).

- +

5. General

- +

5.1. What is the relationship between site.xml and book.xml?

^ @@ -1392,7 +1398,7 @@ site.xml-generated menus aren't appropriate. See Menus and Linking.

- +

5.2. How do I use DocBook as the XML documentation format?

^ @@ -1438,7 +1444,7 @@ different DTDs, then see Using Forrest for configuration guidance.

- +

5.3. How to report which version of Forrest is being used and the properties that are set?

@@ -1451,7 +1457,7 @@ watch the build messages. Doing 'forrest -v' will provide verbose build messages.

- +

5.4. Where are the log files to find more infomation about errors?

^ @@ -1470,7 +1476,7 @@

Doing 'forrest -v' will provide verbose build messages to the standard output.

- +

5.5. How to help?

^ @@ -1481,7 +1487,7 @@ particularly from newcomers—often, close proximity blinds software developers to faults that are obvious to everyone else. Don't be shy!

- +

5.6. How to contribute a patch?

^ 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 @@

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 @@

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.

- Forrest can also be instructed to not process certain URIs - if you need to temporarily exclude then. Use the - Cocoon cli.xconf file. + Cocoon can be instructed via the + Cocoon cli.xconf 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. +

+ +

+ Cocoon can also be instructed to not process certain URIs + if you need to temporarily exclude then.

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>.