Return-Path: Delivered-To: apmail-forrest-site-svn-archive@locus.apache.org Received: (qmail 44441 invoked from network); 23 Jan 2008 06:14:54 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 23 Jan 2008 06:14:54 -0000 Received: (qmail 60732 invoked by uid 500); 23 Jan 2008 06:14:44 -0000 Delivered-To: apmail-forrest-site-svn-archive@forrest.apache.org Received: (qmail 60691 invoked by uid 500); 23 Jan 2008 06:14:44 -0000 Mailing-List: contact site-svn-help@forrest.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@forrest.apache.org Delivered-To: mailing list site-svn@forrest.apache.org Received: (qmail 60682 invoked by uid 99); 23 Jan 2008 06:14:44 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 22 Jan 2008 22:14:44 -0800 X-ASF-Spam-Status: No, hits=-100.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Jan 2008 06:14:16 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id D3D5A1A9832; Tue, 22 Jan 2008 22:14:22 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r614430 - in /forrest/site: docs_0_90/faq.html docs_0_90/faq.pdf docs_0_90/faq.xml mirrors.html mirrors.pdf Date: Wed, 23 Jan 2008 06:14:22 -0000 To: site-svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080123061422.D3D5A1A9832@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: crossley Date: Tue Jan 22 22:14:21 2008 New Revision: 614430 URL: http://svn.apache.org/viewvc?rev=614430&view=rev Log: Publish from forrestbot Modified: forrest/site/docs_0_90/faq.html forrest/site/docs_0_90/faq.pdf forrest/site/docs_0_90/faq.xml forrest/site/mirrors.html forrest/site/mirrors.pdf Modified: forrest/site/docs_0_90/faq.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.html?rev=614430&r1=614429&r2=614430&view=diff ============================================================================== --- forrest/site/docs_0_90/faq.html (original) +++ forrest/site/docs_0_90/faq.html Tue Jan 22 22:14:21 2008 @@ -837,7 +837,9 @@

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

- Add the following entries to your site.xml file: + Add the following entries to your site.xml file. + Note that the href must be exactly "wholesite" or "site" which triggers + a special match in the sitemap to aggregate all documents. 

 
@@ -850,15 +852,25 @@

In this case the menu labeled "About" will have 2 new items: "Full - PDF" and "Full HTML". (See also How to - create a PDF document for each tab.) + PDF" and "Full HTML". +

+

+ See also How to + create a PDF document for each tab.

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

- +
+
Warning
+
+ There are many issues with the "wholesite" aggregation. Search the + issue tracker and mail lists. +
+
+

2.6. How do I insert page breaks into documents?

Page breaks do not make a great deal of sense in HTML documents @@ -887,7 +899,7 @@ margin-bottom: 0; page-break-after: always; } - +

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

@@ -895,14 +907,14 @@ $FORREST_HOME/main/webapp/skins/common/xslt/html/document-to-html.xsl and edit the "headers/authors" template.

- +

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

Handling of raw files was significantly changed in Forrest 0.7. See Upgrading to Apache Forrest 0.7 for all the details.

- +

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

Forrest uses Apache FOP @@ -941,7 +953,7 @@ Forrest. - +

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?

@@ -964,12 +976,12 @@ <map:redirect-to uri="manual/Introduction.html"/> </map:match> - +

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

See the tips.

- +

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

@@ -998,7 +1010,7 @@ - +

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

Forrest by default assumes that the first page (home page) of your @@ -1034,7 +1046,7 @@

  • Don't forget to create that page and refer to it in your site.xml
    • - +

    2.14. How to use a different filename extension for output, e.g. *.php?

    Use the power of the Cocoon sitemaps. There is default handling for *.php (see main/webapp/sitemap.xmap) to map the 'php' extension to an internal request for "html". See more about PHP below. @@ -1042,7 +1054,7 @@

    Use the same internal re-direction technique for your special needs, e.g. copy that php match to your project sitemap and use ".htm" instead.

    - +

    2.15. How to generate pages ready for serving via PHP?

    Use the *.php filename extension (see above) @@ -1053,7 +1065,7 @@ "processing-instruction nodes in source are not always passed through to html output" whereby only PIs in certain body elements are handled.

    - +

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

    Use the numeric values for character entities. For example, rather @@ -1071,7 +1083,7 @@ Issue FOR-244.

    - +

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

    Yes, Forrest can process text in any language, so you can include: @@ -1145,7 +1157,7 @@ Alan Wood's Unicode resources.

    - +

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

    @@ -1155,7 +1167,7 @@ trademark symbol "My Project Name™". Avoid lengthy typing and potential spelling errors.

    - +

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

    By default Forrest does not clean its build directories in the project @@ -1169,7 +1181,7 @@ which include the Cocoon cache and the Cocoon logs). Doing 'forrest clean' will remove both sections.

    - +

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

    The i18n features of Forrest are still under development (as of 0.7) @@ -1185,7 +1197,7 @@ i18n Transformer. You can see an example of how it works in the above linked issue.

    - +

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

    To serve, for example a legacy HTML site, add something like the @@ -1231,7 +1243,7 @@ - +

    2.22. How to include additional Javascript and CSS files?

    Place various resources (e.g. javascript, css) into the "project @@ -1248,7 +1260,7 @@ forrest/main/webapp/resources.xmap Search for "javascript" then follow to the <map:resource name="skin-read"> section.

    - +

    2.23. How to show a Table Of Contents for the whole site?

    Every site has an automatically generated document at @@ -1272,10 +1284,10 @@ project.start-uri in the forrest.properties file.

    - +

    3. Technical

    - +

    3.1. Where is the Java code?

    Because we are based on Apache Cocoon, a lot of the functionality is @@ -1294,7 +1306,7 @@ Locationmap and Dispatcher. There is also Java code for some plugins with specialised purpose, e.g. PhotoGallery.

    - +

    3.2. How to enhance the responsiveness of the cache?

    Apache Cocoon has a sophisticated cache. When running Forrest in @@ -1319,7 +1331,7 @@ proxy server, e.g. Apache HTTP Server as a frontend. See CocoonAndApacheModProxy.

    - +

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

    @@ -1340,7 +1352,7 @@ ${user.home}/forrest.properties !

    - +

    3.4. How can I generate html-pages to show the Revision tag of CVS or SVN?

    If you have:<version>$Revision: 1.30 @@ -1357,7 +1369,7 @@ When using Subversion, remember to set the relevant svn:keywords properties.

    - +

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

    @@ -1416,7 +1428,7 @@ which explains how to include non-linked extra documents to the processing using the Cocoon CLI.

    - +

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

    @@ -1424,11 +1436,11 @@ cli.xconf Cocoon config file, and defining patterns for URLs to exclude.

    - +

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

    Certain patterns are claimed by the default sitemaps for special - processing. These reserved words include: site, changes, todo, + processing. These reserved words include: site, wholesite, changes, todo, faq, images, my-images, skinconf, community, howto

    @@ -1438,7 +1450,7 @@ of Forrest we will attempt to deal with this issue (FOR-217).

    - +

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

    @@ -1467,7 +1479,7 @@

  • Column 5 is the page size.
    • - +

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

    @@ -1481,7 +1493,7 @@ Cocoon FAQ.

    - +

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

    @@ -1497,7 +1509,7 @@ details see SVG resources.

    - +

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

    @@ -1505,24 +1517,24 @@ Using Catalog Entity Resolver for local DTDs.

    - +

    3.12. How to configure the Catalog Entity Resolver to use my own local project DTDs?

    See Using Forrest for configuration guidance.

    - +

    3.13. We need an additional system-wide catalog to share DTDs between projects

    See Using Forrest for configuration guidance.

    - +

    3.14. How to debug the Catalog Entity Resolver and local DTDs?

    See XML validation.

    - +

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

    There are default skins provided, which @@ -1536,7 +1548,7 @@ skins. Some projects may have special needs and can define their own skin.

    - +

    3.16. How do I enable XSP processing?

    First consider whether your needs would be better met by Cocoon @@ -1595,7 +1607,7 @@ AddingXSPToForrest Wiki page.

    - +

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

    Breadcrumbs begin with up to three URLs specified in @@ -1616,7 +1628,7 @@ there is no domain and so there will be no extra breadcrumbs, only the ones that are specified in skinconf.xml.

    - +

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

    @@ -1629,7 +1641,7 @@ do forrest run

    - +

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

    If you use an IDE like Eclipse and want to debug java code in Forrest @@ -1640,7 +1652,7 @@ forrest.properties file. Don't forget to ensure the property is uncommented in that file.

    - +

    3.20. How do I enable Cocoon's document checksum feature?

    Why might you want to do this? There is really no effect on Cocoon @@ -1669,10 +1681,10 @@ installation-wide cli.xconf file.

    - +

    4. Older version: 0.6

    - +

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

    Certain patterns are claimed by the default sitemaps for special @@ -1687,10 +1699,10 @@ (FOR-217).

    - +

    5. General

    - +

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

    One site.xml file in your project root can replace all the book.xml files @@ -1702,7 +1714,7 @@ where site.xml-generated menus aren't appropriate. See Menus and Linking.

    - +

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

    There are two ways. Forrest has a simplifiedDocbook @@ -1812,7 +1824,7 @@ Using Forrest for configuration guidance.

    - +

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

    @@ -1824,7 +1836,7 @@ forrest.properties file and 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?

    The logfiles are at build/webapp/WEB-INF/logs/ @@ -1846,7 +1858,7 @@ Doing 'forrest -v' will provide verbose build messages to the standard output.

    - +

    5.5. How to help?

    Join one of the Forrest project mailing @@ -1855,7 +1867,7 @@ 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?

    Please send all contributions via our issue @@ -1869,7 +1881,7 @@ issue tracker before diving in.

    - +

    5.7. How can job positions be advertised?

    Employers can send notices about employment opportunities. There is a @@ -1888,7 +1900,7 @@ (CCLA) with The Apache Software Foundation.

    - +

    5.8. Is there a press kit? Who can journalists contact?

    Press enquiries should be co-ordinated through the ASF Public Relations Committee (PRC). @@ -1904,7 +1916,7 @@ are available. Unfortunately the logo is only available as PNG.

    - +

    5.9. How to report a security issue?

    Security and vulnerability issues are co-ordinated through ASF Security. Modified: forrest/site/docs_0_90/faq.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.pdf?rev=614430&r1=614429&r2=614430&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_90/faq.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.xml?rev=614430&r1=614429&r2=614430&view=diff ============================================================================== --- forrest/site/docs_0_90/faq.xml (original) +++ forrest/site/docs_0_90/faq.xml Tue Jan 22 22:14:21 2008 @@ -261,7 +261,9 @@

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

    - Add the following entries to your site.xml file: + Add the following entries to your site.xml file. + Note that the href must be exactly "wholesite" or "site" which triggers + a special match in the sitemap to aggregate all documents.

    @@ -274,14 +276,21 @@

    In this case the menu labeled "About" will have 2 new items: "Full - PDF" and "Full HTML". (See also How to - create a PDF document for each tab.) + PDF" and "Full HTML". +

    +

    + See also How to + create a PDF document for each tab.

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

    + + There are many issues with the "wholesite" aggregation. Search the + issue tracker and mail lists. +
    2.6. How do I insert page breaks into documents?

    Page breaks do not make a great deal of sense in HTML documents @@ -781,7 +790,7 @@

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

    Certain patterns are claimed by the default sitemaps for special - processing. These reserved words include: site, changes, todo, + processing. These reserved words include: site, wholesite, changes, todo, faq, images, my-images, skinconf, community, howto

    Modified: forrest/site/mirrors.html URL: http://svn.apache.org/viewvc/forrest/site/mirrors.html?rev=614430&r1=614429&r2=614430&view=diff ============================================================================== --- forrest/site/mirrors.html (original) +++ forrest/site/mirrors.html Tue Jan 22 22:14:21 2008 @@ -202,9 +202,6 @@ Current official release (closest mirror site selected automatically)

  • -Current development and head SVN repository -
    • -
  • Archive of old releases
  • @@ -241,17 +238,12 @@
  • For Windows operating systems: apache-forrest-0.8.zip [PGP] [MD5]
    • - -

    Current development and head SVN repository

    -
    -

    Developers can use the latest Apache Forrest features, the source code is under version control with Subversion (read how to obtain your working copy).

    -
    - +

    Archive of old releases

    Older releases are available in the archive. Those releases are only provided as historical artefacts. We strongly recommend to not use those releases, but upgrade to the most recent release.

    - +

    Verify releases

    It is essential that you verify the integrity of the downloaded files using the PGP and MD5 signatures. MD5 verification ensures the file was not corrupted or tampered with. PGP verification ensures that the file came from a certain person.

    Modified: forrest/site/mirrors.pdf URL: http://svn.apache.org/viewvc/forrest/site/mirrors.pdf?rev=614430&r1=614429&r2=614430&view=diff ============================================================================== Binary files - no diff available.