Author: crossley Date: Sat Jan 8 21:59:58 2011 New Revision: 1056815 URL: http://svn.apache.org/viewvc?rev=1056815&view=rev Log: Publish from forrestbot
Modified: forrest/site/docs_0_90/faq.html forrest/site/docs_0_90/faq.xml forrest/site/docs_0_90/howto/howto-buildPlugin.html forrest/site/dtdx/document-v13.pdf forrest/site/dtdx/document-v20.pdf forrest/site/forrest-issues.html forrest/site/gump.html Modified: forrest/site/docs_0_90/faq.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.html?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== --- forrest/site/docs_0_90/faq.html (original) +++ forrest/site/docs_0_90/faq.html Sat Jan 8 21:59:58 2011 @@ -730,21 +730,22 @@ error: datatype library "http://www.w3.o One workaround is to update your copy of the <a href="http://code.google.com/p/jing-trang/">Jing</a> jar at <span class="codefrag">$FORREST_HOME/lib/core/</span> - -</p> + +<br>Note: We know that Jing-20081028 works okay. + </p> <p> Another workaround is to edit the forrest.properties configuration file to expose the "forrest.validate.sitemap" property and set it to "false". Might need to do the same for the "forrest.validate.stylesheets" property. </p> -<a name="N100D5"></a><a name="winjava"></a> +<a name="N100D7"></a><a name="winjava"></a> <h3 class="underlined_5">1.11. Windows gets confused about which Java version to use.</h3> <p> Cough, yes!. See this <a href="http://mail-archives.apache.org/mod_mbox/forrest-user/200704.mbox/%3c462ca40f.5020...@rblasch.org%3e">explanation</a> on the Forrest mail lists. </p> -<a name="N100E1"></a><a name="maxmemory"></a> +<a name="N100E3"></a><a name="maxmemory"></a> <h3 class="underlined_5">1.12. How can I specify the amount of memory to be used by Java? </h3> <p> There are two ways to control this. If you get an OutOfMemoryError @@ -764,7 +765,7 @@ error: datatype library "http://www.w3.o forrest. The exact value you set it to is dependant on your JVM, but something like <span class="codefrag">ANT_OPTS=-Xmx500M</span> will probably work. </p> -<a name="N100FE"></a><a name="debug"></a> +<a name="N10100"></a><a name="debug"></a> <h3 class="underlined_5">1.13. How can I start forrest in Java debug mode? </h3> <p> The <span class="codefrag">forrest.jvmargs</span> property in the @@ -774,10 +775,10 @@ error: datatype library "http://www.w3.o </p> </div> -<a name="N1010F"></a><a name="content_faqs"></a> +<a name="N10111"></a><a name="content_faqs"></a> <h2 class="underlined_10">2. Content Creation</h2> <div class="section"> -<a name="N10113"></a><a name="edit-content"></a> +<a name="N10115"></a><a name="edit-content"></a> <h3 class="underlined_5">2.1. What tools can be used to edit the content?</h3> <p> If you are using the Apache Forrest XML @@ -799,7 +800,7 @@ error: datatype library "http://www.w3.o can use text editors or "html editors" such as the one provided with the Mozilla web browser. </p> -<a name="N1012D"></a><a name="site-xml"></a> +<a name="N1012F"></a><a name="site-xml"></a> <h3 class="underlined_5">2.2. How to use the site.xml configuration file for menus and linking. </h3> @@ -842,7 +843,7 @@ error: datatype library "http://www.w3.o <pre class="code"> <a href="site:docbook"> link to the DocBook FAQ in the Tech FAQs </pre> -<a name="N1015B"></a><a name="examples"></a> +<a name="N1015D"></a><a name="examples"></a> <h3 class="underlined_5">2.3. Where are examples of documents and site.xml and tabs.xml files? </h3> @@ -851,7 +852,7 @@ error: datatype library "http://www.w3.o website documents are included with the distribution (<span class="codefrag">cd forrest/site-author; forrest run</span>). </p> -<a name="N10166"></a><a name="crawler"></a> +<a name="N10168"></a><a name="crawler"></a> <h3 class="underlined_5">2.4. Help, one of my documents is not being rendered. </h3> @@ -870,7 +871,7 @@ error: datatype library "http://www.w3.o not follow and process off-site links. The new locationmap (0.8+) enables content to be drawn from remote sources. </p> -<a name="N10174"></a><a name="PDF-output"></a> +<a name="N10176"></a><a name="PDF-output"></a> <h3 class="underlined_5">2.5. How can I generate one pdf-file out of the whole site or selected pages of the site?</h3> <p> Add the following entries to your site.xml file. @@ -906,7 +907,7 @@ error: datatype library "http://www.w3.o issue tracker and mail lists. </div> </div> -<a name="N10194"></a><a name="pageBreaks"></a> +<a name="N10196"></a><a name="pageBreaks"></a> <h3 class="underlined_5">2.6. How do I insert page breaks into documents?</h3> <p> Page breaks do not make a great deal of sense in HTML documents @@ -935,7 +936,7 @@ error: datatype library "http://www.w3.o margin-bottom: 0; page-break-after: always; } </pre> -<a name="N101B2"></a><a name="clickable-email-address"></a> +<a name="N101B4"></a><a name="clickable-email-address"></a> <h3 class="underlined_5">2.7. How can I generate html-pages to show a 'clickable' email-address (of the author-element)?</h3> <p> @@ -943,14 +944,14 @@ error: datatype library "http://www.w3.o $FORREST_HOME/main/webapp/skins/common/xslt/html/document-to-html.xsl</span> and edit the "headers/authors" template. </p> -<a name="N101BD"></a><a name="link_raw"></a> +<a name="N101BF"></a><a name="link_raw"></a> <h3 class="underlined_5">2.8. How do I link to raw files such as config.txt and brochure.pdf? </h3> <p> Handling of raw files was significantly changed in Forrest 0.7. See <a href="../docs_0_70/upgrading_07.html#raw">Upgrading to Apache Forrest 0.7</a> for all the details. </p> -<a name="N101C9"></a><a name="pdf_images"></a> +<a name="N101CB"></a><a name="pdf_images"></a> <h3 class="underlined_5">2.9. Images don't display in PDFs. How do I fix this?</h3> <p> Forrest uses <a href="http://xml.apache.org/fop/">Apache FOP</a> @@ -989,7 +990,7 @@ error: datatype library "http://www.w3.o Forrest. </div> </div> -<a name="N101F8"></a><a name="tab-index"></a> +<a name="N101FA"></a><a name="tab-index"></a> <h3 class="underlined_5">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? </h3> <p> @@ -1012,12 +1013,12 @@ error: datatype library "http://www.w3.o <map:redirect-to uri="manual/Introduction.html"/> </map:match> </pre> -<a name="N10214"></a><a name="tab-site"></a> +<a name="N10216"></a><a name="tab-site"></a> <h3 class="underlined_5">2.11. I need help with the interaction between tabs.xml and site.xml </h3> <p> See the <a href="../docs_0_90/linking.html#tab-site">tips</a>. </p> -<a name="N10220"></a><a name="defaultFileName"></a> +<a name="N10222"></a><a name="defaultFileName"></a> <h3 class="underlined_5">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/ ? </h3> <p> @@ -1046,7 +1047,7 @@ error: datatype library "http://www.w3.o </li> </ol> -<a name="N10248"></a><a name="defaultStartPage"></a> +<a name="N1024A"></a><a name="defaultStartPage"></a> <h3 class="underlined_5">2.13. How can I use a start-up-page other than index.html? </h3> <p> Forrest by default assumes that the first page (home page) of your @@ -1082,7 +1083,7 @@ error: datatype library "http://www.w3.o <li>Don't forget to create that page and refer to it in your site.xml</li> </ol> -<a name="N1026C"></a><a name="output-filename-extension"></a> +<a name="N1026E"></a><a name="output-filename-extension"></a> <h3 class="underlined_5">2.14. How to use a different filename extension for output, e.g. *.php? </h3> <p> 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 <a href="#php">PHP</a> below. @@ -1090,7 +1091,7 @@ error: datatype library "http://www.w3.o <p> 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. </p> -<a name="N1027B"></a><a name="php"></a> +<a name="N1027D"></a><a name="php"></a> <h3 class="underlined_5">2.15. How to generate pages ready for serving via PHP? </h3> <p> Use the *.php filename extension (see <a href="#output-filename-extension">above</a>) @@ -1101,7 +1102,7 @@ error: datatype library "http://www.w3.o "processing-instruction nodes in source are not always passed through to html output" whereby only PIs in certain body elements are handled. </p> -<a name="N1028E"></a><a name="label-entity"></a> +<a name="N10290"></a><a name="label-entity"></a> <h3 class="underlined_5">2.16. How to use special characters in the labels of the site.xml file? </h3> <p> Use the numeric values for character entities. For example, rather @@ -1119,7 +1120,7 @@ error: datatype library "http://www.w3.o <a href="http://issues.apache.org/jira/browse/FOR-244">Issue FOR-244</a>. </p> -<a name="N102A7"></a><a name="encoding"></a> +<a name="N102A9"></a><a name="encoding"></a> <h3 class="underlined_5">2.17. Does Forrest handle accents for non-English languages?</h3> <p> Yes, Forrest can process text in any language, so you can include: @@ -1193,7 +1194,7 @@ error: datatype library "http://www.w3.o <a href="http://www.alanwood.net/unicode/">Alan Wood's Unicode resources</a>. </p> -<a name="N102F9"></a><a name="xml-entities"></a> +<a name="N102FB"></a><a name="xml-entities"></a> <h3 class="underlined_5">2.18. How to use XML entities, for example string replacement?</h3> <p> @@ -1205,7 +1206,7 @@ error: datatype library "http://www.w3.o trademark symbol "My Project Name™". Avoid lengthy typing and potential spelling errors. </p> -<a name="N10308"></a><a name="cleanSite"></a> +<a name="N1030A"></a><a name="cleanSite"></a> <h3 class="underlined_5">2.19. How to make Forrest clean up the project build directories? </h3> <p> By default Forrest does not clean its build directories in the project @@ -1219,7 +1220,7 @@ error: datatype library "http://www.w3.o which include the Cocoon cache and the Cocoon logs). Doing 'forrest clean' will remove both sections. </p> -<a name="N10313"></a><a name="i18n"></a> +<a name="N10315"></a><a name="i18n"></a> <h3 class="underlined_5">2.20. How can I internationalise (i18n) my content?</h3> <p> For example, navigation @@ -1234,7 +1235,7 @@ error: datatype library "http://www.w3.o <a href="http://cocoon.apache.org/2.1/userdocs/i18nTransformer.html">Cocoon i18n Transformer</a>. </p> -<a name="N10325"></a><a name="rawHTML"></a> +<a name="N10327"></a><a name="rawHTML"></a> <h3 class="underlined_5">2.21. How can I include HTML content that is not to be skinned by Forrest?</h3> <p> To serve, for example a legacy HTML site, add something like the @@ -1282,7 +1283,7 @@ error: datatype library "http://www.w3.o </li> </ol> -<a name="N10351"></a><a name="javascript"></a> +<a name="N10353"></a><a name="javascript"></a> <h3 class="underlined_5">2.22. How to include additional Javascript and CSS files?</h3> <p> Place various resources (e.g. javascript, css) into the "project @@ -1299,7 +1300,7 @@ error: datatype library "http://www.w3.o forrest/main/webapp/resources.xmap Search for "javascript" then follow to the <map:resource name="skin-read"> section. </p> -<a name="N1035F"></a><a name="linkmap"></a> +<a name="N10361"></a><a name="linkmap"></a> <h3 class="underlined_5">2.23. How to show a Table Of Contents for the whole site?</h3> <p> Every site has an automatically generated document at @@ -1323,10 +1324,10 @@ error: datatype library "http://www.w3.o project.start-uri in the forrest.properties file. </p> </div> -<a name="N1037D"></a><a name="technical"></a> +<a name="N1037F"></a><a name="technical"></a> <h2 class="underlined_10">3. Technical</h2> <div class="section"> -<a name="N10381"></a><a name="java-code"></a> +<a name="N10383"></a><a name="java-code"></a> <h3 class="underlined_5">3.1. Where is the Java code?</h3> <p> Because we are based on Apache Cocoon, a lot of the functionality is @@ -1345,7 +1346,7 @@ error: datatype library "http://www.w3.o Locationmap and Dispatcher. There is also Java code for some plugins with specialised purpose, e.g. PhotoGallery. </p> -<a name="N1038F"></a><a name="populate-cache"></a> +<a name="N10391"></a><a name="populate-cache"></a> <h3 class="underlined_5">3.2. How to enhance the responsiveness of the cache?</h3> <p> Apache Cocoon has a sophisticated cache. When running Forrest in @@ -1370,7 +1371,7 @@ error: datatype library "http://www.w3.o proxy server, e.g. Apache HTTP Server as a frontend. See <a href="http://wiki.apache.org/cocoon/ApacheModProxy">CocoonAndApacheModProxy</a>. </p> -<a name="N103A9"></a><a name="proxy_config"></a> +<a name="N103AB"></a><a name="proxy_config"></a> <h3 class="underlined_5">3.3. I'm behind a proxy and it's preventing Plugins from being downloaded, what should I do?</h3> <p> @@ -1391,7 +1392,7 @@ error: datatype library "http://www.w3.o <span class="codefrag">${user.home}/forrest.properties</span> ! </div> </div> -<a name="N103CD"></a><a name="CVS_revison_tags"></a> +<a name="N103CF"></a><a name="CVS_revison_tags"></a> <h3 class="underlined_5">3.4. How can I generate html-pages to show the Revision tag of CVS or SVN?</h3> <p> If you have:<span class="codefrag"><version>$Revision: 1.30 @@ -1408,7 +1409,7 @@ error: datatype library "http://www.w3.o When using Subversion, remember to set the relevant svn:keywords properties. </p> -<a name="N103E2"></a><a name="cli-xconf"></a> +<a name="N103E4"></a><a name="cli-xconf"></a> <h3 class="underlined_5">3.5. How to control the processing of URIs by Cocoon, e.g. exclude certain URIs, include other additional ones. </h3> <p> @@ -1467,7 +1468,7 @@ error: datatype library "http://www.w3.o which explains how to include non-linked extra documents to the processing using the Cocoon CLI. </p> -<a name="N10426"></a><a name="ignoring_javadocs"></a> +<a name="N10428"></a><a name="ignoring_javadocs"></a> <h3 class="underlined_5">3.6. How do I stop Forrest breaking on links to external files that may not exist, like javadocs? </h3> <p> @@ -1475,7 +1476,7 @@ error: datatype library "http://www.w3.o <span class="codefrag">cli.xconf</span> </a> Cocoon config file, and defining patterns for URLs to exclude. </p> -<a name="N10435"></a><a name="claimed_patterns"></a> +<a name="N10437"></a><a name="claimed_patterns"></a> <h3 class="underlined_5">3.7. Some of my files are not being processed because they use common filenames. </h3> <p> Certain patterns are claimed by the default sitemaps for special @@ -1489,7 +1490,7 @@ error: datatype library "http://www.w3.o of Forrest we will attempt to deal with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>). </p> -<a name="N10447"></a><a name="build_msg_a"></a> +<a name="N10449"></a><a name="build_msg_a"></a> <h3 class="underlined_5">3.8. What do the symbols and numbers mean when Forrest lists each document that it has built? </h3> <p> @@ -1518,7 +1519,7 @@ X [0] /docs_0_80/upgrading_08.ht <li>Column 5 is the page size.</li> </ul> -<a name="N10465"></a><a name="headless_operation"></a> +<a name="N10467"></a><a name="headless_operation"></a> <h3 class="underlined_5">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. </h3> <p> @@ -1532,7 +1533,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html">Cocoon FAQ</a>. </p> -<a name="N10481"></a><a name="project-logo-svg"></a> +<a name="N10483"></a><a name="project-logo-svg"></a> <h3 class="underlined_5">3.10. The project logo that is generated from SVG is truncating my project name. </h3> @@ -1548,7 +1549,7 @@ X [0] /docs_0_80/upgrading_08.ht details see <a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources. </p> -<a name="N10499"></a><a name="catalog"></a> +<a name="N1049B"></a><a name="catalog"></a> <h3 class="underlined_5">3.11. How do i configure my favourite XML editor or parser to find the local Forrest DTDs? </h3> <p> @@ -1556,24 +1557,24 @@ X [0] /docs_0_80/upgrading_08.ht <a href="../docs_0_90/catalog.html">Using Catalog Entity Resolver for local DTDs</a>. </p> -<a name="N104A5"></a><a name="project-dtd"></a> +<a name="N104A7"></a><a name="project-dtd"></a> <h3 class="underlined_5">3.12. How to configure the Catalog Entity Resolver to use my own local project DTDs?</h3> <p> See <a href="../docs_0_90/your-project.html#new_dtd">Using Forrest</a> for configuration guidance. </p> -<a name="N104B1"></a><a name="local-catalog"></a> +<a name="N104B3"></a><a name="local-catalog"></a> <h3 class="underlined_5">3.13. We need an additional system-wide catalog to share DTDs between projects</h3> <p> See <a href="../docs_0_90/validation.html#catalog">Using Forrest</a> for configuration guidance. </p> -<a name="N104BD"></a><a name="debug-catalog"></a> +<a name="N104BF"></a><a name="debug-catalog"></a> <h3 class="underlined_5">3.14. How to debug the Catalog Entity Resolver and local DTDs?</h3> <p> See <a href="../docs_0_90/validation.html#debug-catalog">XML validation</a>. </p> -<a name="N104C9"></a><a name="skin"></a> +<a name="N104CB"></a><a name="skin"></a> <h3 class="underlined_5">3.15. How to make the site look better and change its skin? </h3> <p> There are <a href="../docs_0_90/your-project.html#skins">default skins</a> provided, which @@ -1587,7 +1588,7 @@ X [0] /docs_0_80/upgrading_08.ht skins. Some projects may have special needs and can define their <a href="../docs_0_90/your-project.html#new_skin">own skin</a>. </p> -<a name="N104E0"></a><a name="xsp"></a> +<a name="N104E2"></a><a name="xsp"></a> <h3 class="underlined_5">3.16. How do I enable XSP processing?</h3> <p> First consider whether your needs would be better met by Cocoon @@ -1646,7 +1647,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a> Wiki page. </p> -<a name="N10517"></a><a name="breadcrumbs"></a> +<a name="N10519"></a><a name="breadcrumbs"></a> <h3 class="underlined_5">3.17. How do breadcrumbs work? Why don't they work locally?</h3> <p> Breadcrumbs begin with up to three URLs specified in @@ -1667,7 +1668,7 @@ X [0] /docs_0_80/upgrading_08.ht 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> -<a name="N1052C"></a><a name="run_port"></a> +<a name="N1052E"></a><a name="run_port"></a> <h3 class="underlined_5">3.18. How do I make forrest run listen on a different port?</h3> <p> @@ -1680,7 +1681,7 @@ X [0] /docs_0_80/upgrading_08.ht do <span class="codefrag">forrest run</span> </p> -<a name="N10540"></a><a name="debugging"></a> +<a name="N10542"></a><a name="debugging"></a> <h3 class="underlined_5">3.19. Can I run Forrest with Java debugging turned on?</h3> <p> If you use an IDE like Eclipse and want to debug java code in Forrest @@ -1691,7 +1692,7 @@ X [0] /docs_0_80/upgrading_08.ht <span class="codefrag">forrest.properties</span> file. Don't forget to ensure the property is uncommented in that file. </p> -<a name="N10551"></a><a name="checksums"></a> +<a name="N10553"></a><a name="checksums"></a> <h3 class="underlined_5">3.20. How do I enable Cocoon's document checksum feature?</h3> <p> Why might you want to do this? There is really no effect on Cocoon @@ -1719,7 +1720,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="#cli-xconf">Cocoon cli.xconf</a>) or use the default installation-wide cli.xconf file. </p> -<a name="N1056D"></a><a name="sitemap-entities"></a> +<a name="N1056F"></a><a name="sitemap-entities"></a> <h3 class="underlined_5">3.21. How to configure some Cocoon sitemap components, e.g. output html encoding or doctype?</h3> <p> The core Cocoon components are defined in the @@ -1743,10 +1744,10 @@ X [0] /docs_0_80/upgrading_08.ht Re-start Forrest. </p> </div> -<a name="N10587"></a><a name="old_faqs"></a> +<a name="N10589"></a><a name="old_faqs"></a> <h2 class="underlined_10">4. Older version: 0.6</h2> <div class="section"> -<a name="N1058B"></a><a name="old_claimed_patterns"></a> +<a name="N1058D"></a><a name="old_claimed_patterns"></a> <h3 class="underlined_5">4.1. Some of my files are not being processed because they use common filenames. </h3> <p> Certain patterns are claimed by the default sitemaps for special @@ -1761,10 +1762,10 @@ X [0] /docs_0_80/upgrading_08.ht (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>). </p> </div> -<a name="N1059D"></a><a name="general"></a> +<a name="N1059F"></a><a name="general"></a> <h2 class="underlined_10">5. General</h2> <div class="section"> -<a name="N105A1"></a><a name="generating_menus"></a> +<a name="N105A3"></a><a name="generating_menus"></a> <h3 class="underlined_5">5.1. What is the relationship between site.xml and book.xml? </h3> <p> One <span class="codefrag">site.xml</span> file in your project root can replace all the book.xml files @@ -1776,7 +1777,7 @@ X [0] /docs_0_80/upgrading_08.ht where <span class="codefrag">site.xml</span>-generated menus aren't appropriate. See <a href="../docs_0_90/linking.html">Menus and Linking</a>. </p> -<a name="N105BC"></a><a name="docbook"></a> +<a name="N105BE"></a><a name="docbook"></a> <h3 class="underlined_5">5.2. How do I use DocBook as the XML documentation format? </h3> <p> There are two ways. Forrest has a <span class="codefrag">simplifiedDocbook</span> @@ -1886,7 +1887,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="../docs_0_90/your-project.html#new_dtd">Using Forrest</a> for configuration guidance. </p> -<a name="N105F5"></a><a name="version"></a> +<a name="N105F7"></a><a name="version"></a> <h3 class="underlined_5">5.3. How to report which version of Forrest is being used and the properties that are set? </h3> <p> @@ -1898,7 +1899,7 @@ X [0] /docs_0_80/upgrading_08.ht forrest.properties file and watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages. </p> -<a name="N10609"></a><a name="logs"></a> +<a name="N1060B"></a><a name="logs"></a> <h3 class="underlined_5">5.4. Where are the log files to find more infomation about errors? </h3> <p> The logfiles are at <span class="codefrag">build/webapp/WEB-INF/logs/</span> @@ -1920,7 +1921,7 @@ X [0] /docs_0_80/upgrading_08.ht Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard output. </p> -<a name="N1062D"></a><a name="verbose-ant"></a> +<a name="N1062F"></a><a name="verbose-ant"></a> <h3 class="underlined_5">5.5. How to filter or reduce the standard output messages? </h3> <p> Where normally you would do @@ -1934,7 +1935,7 @@ X [0] /docs_0_80/upgrading_08.ht Doing <span class="codefrag">'forrest -v'</span> will provide very verbose build messages to the standard output. </p> -<a name="N10647"></a><a name="coloured-ant"></a> +<a name="N10649"></a><a name="coloured-ant"></a> <h3 class="underlined_5">5.6. How to enabled coloured standard output messages? </h3> <p> Adding colour to the forrest output messages will greatly assist @@ -1961,7 +1962,7 @@ X [0] /docs_0_80/upgrading_08.ht <p> Note that not all terminals support ANSI color codes. </p> -<a name="N10667"></a><a name="how_can_I_help"></a> +<a name="N10669"></a><a name="how_can_I_help"></a> <h3 class="underlined_5">5.7. How to help? </h3> <p> Join one of the Forrest project <a href="../mail-lists.html">mailing @@ -1970,7 +1971,7 @@ X [0] /docs_0_80/upgrading_08.ht newcomers—often, close proximity blinds software developers to faults that are obvious to everyone else. Don't be shy! </p> -<a name="N10673"></a><a name="patch"></a> +<a name="N10675"></a><a name="patch"></a> <h3 class="underlined_5">5.8. How to contribute a patch? </h3> <p> Please send all contributions via our <a href="../issues.html">issue @@ -1984,7 +1985,7 @@ X [0] /docs_0_80/upgrading_08.ht <a href="../issues.html">issue tracker</a> before diving in. </p> -<a name="N1068E"></a><a name="jobs"></a> +<a name="N10690"></a><a name="jobs"></a> <h3 class="underlined_5">5.9. How can job positions be advertised? </h3> <p> Employers can send notices about employment opportunities. There is a @@ -2003,7 +2004,7 @@ X [0] /docs_0_80/upgrading_08.ht (<a href="http://www.apache.org/licenses/">CCLA</a>) with The Apache Software Foundation. </p> -<a name="N106A1"></a><a name="press"></a> +<a name="N106A3"></a><a name="press"></a> <h3 class="underlined_5">5.10. Is there a press kit? Who can journalists contact?</h3> <p> Press enquiries should be co-ordinated through the ASF Public Relations Committee (PRC). @@ -2022,7 +2023,7 @@ X [0] /docs_0_80/upgrading_08.ht are available. Unfortunately the logo is only available as PNG. </p> -<a name="N106C4"></a><a name="security"></a> +<a name="N106C6"></a><a name="security"></a> <h3 class="underlined_5">5.11. How to report a security issue?</h3> <p> Security and vulnerability issues are co-ordinated through the Modified: forrest/site/docs_0_90/faq.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.xml?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== --- forrest/site/docs_0_90/faq.xml (original) +++ forrest/site/docs_0_90/faq.xml Sat Jan 8 21:59:58 2011 @@ -156,6 +156,7 @@ error: datatype library "http://www.w3.o One workaround is to update your copy of the <link href="http://code.google.com/p/jing-trang/">Jing</link> jar at <code>$FORREST_HOME/lib/core/</code> + <br/>Note: We know that Jing-20081028 works okay. </p> <p> Another workaround is to edit the forrest.properties configuration file Modified: forrest/site/docs_0_90/howto/howto-buildPlugin.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/howto/howto-buildPlugin.html?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== --- forrest/site/docs_0_90/howto/howto-buildPlugin.html (original) +++ forrest/site/docs_0_90/howto/howto-buildPlugin.html Sat Jan 8 21:59:58 2011 @@ -611,27 +611,31 @@ document.write("Last Published: " + docu <a name="N100D8"></a><a name="skinconf"></a> <h5>src/documentation/skinconf.xml</h5> <p> - This configures the skin for your plugins documentation. There are - some items that need to be configured in here, for example, the - copyright information. The file is heavily commented so probably - best to read through it, changing what you need to. + This configures the skin for your plugins documentation. + Note that it is a minimal file, as most content is centrally configured for all ASF plugins. + Over-ride some elements if needed, e.g. see the PDF output plugin. </p> -<a name="N100E2"></a><a name="doc"></a> +<p> + If this is not and ASF-hosted plugin, then copy the skinconf.xml from a fresh + 'forrest seed-sample' site instead. + </p> +<a name="N100E5"></a><a name="doc"></a> <h5>Documentation</h5> <p> It is also a good idea to start writing the documentation at this stage. The above process created a very simple plugin documentation site for you. All you have to do is add the content. </p> -<a name="N100EC"></a><a name="hosted"></a> +<a name="N100EF"></a><a name="hosted"></a> <h5>Style notes for plugins hosted at forrest.apache.org</h5> <p> - After seeding a new plugin, copy the configuration from an existing + After seeding a new plugin, copy some configuration from an existing plugin (e.g. org.apache.forrest.plugin.input.projectInfo). Copy - src/documentation/skinconf.xml (and edit to suit) and src/documentation/content/xdocs/images/project-logo.gif + and + src/documentation/content/xdocs/favicon.ico </p> -<a name="N100F8"></a><a name="edit-sitemap"></a> +<a name="N100FB"></a><a name="edit-sitemap"></a> <h3 class="underlined_5">Edit the Plugin sitemap file(s)</h3> <p> The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted at @@ -661,7 +665,7 @@ document.write("Last Published: " + docu <a href="../../mail-lists.html#forrest-dev">developer mailing list</a> a very good resource (check the archives before posting, please). </p> -<a name="N10125"></a><a name="components"></a> +<a name="N10128"></a><a name="components"></a> <h4>Components, Actions and Resources</h4> <p> If your plugin uses any components (i.e. generators, transformers or @@ -682,7 +686,7 @@ document.write("Last Published: " + docu <p> See the examples below for more details. </p> -<a name="N1014E"></a><a name="resources"></a> +<a name="N10151"></a><a name="resources"></a> <h3 class="underlined_5">Create the Necessary Resource Files</h3> <div class="fixme"> <div class="label">Fixme (open)</div> @@ -690,7 +694,7 @@ document.write("Last Published: " + docu Discuss the XSL files and other such resources </div> </div> -<a name="N10158"></a><a name="dtd-catalog"></a> +<a name="N1015B"></a><a name="dtd-catalog"></a> <h4>Entity catalog for DTDs and other resources</h4> <p> If the plugin uses non-core DTDs and other entities, then add them to @@ -699,7 +703,7 @@ document.write("Last Published: " + docu another plugin (e.g. "listLocations" has a simple example; "glossary" has a more complex example) and edit it to suit. </p> -<a name="N10166"></a><a name="samples"></a> +<a name="N10169"></a><a name="samples"></a> <h3 class="underlined_5">Create Samples in the Documentation</h3> <p> Plugin documentation should provide (as a minimum) an index page that @@ -713,7 +717,7 @@ document.write("Last Published: " + docu Try to provide a sample for all the major functions of your plugin and document any configuration that is available. </p> -<a name="N1017C"></a><a name="test"></a> +<a name="N1017F"></a><a name="test"></a> <h3 class="underlined_5">Testing a Plugin</h3> <p> Since your documentation for the plugin illustrates all of its @@ -750,7 +754,7 @@ document.write("Last Published: " + docu Ensure that your sitemaps are robust and handle matches for files in sub-directories, as well as those at the root level. </p> -<a name="N101AA"></a><a name="Testing+During+Development"></a> +<a name="N101AD"></a><a name="Testing+During+Development"></a> <h4>Testing During Development</h4> <p> In the current plugin system plugins are not used from their src @@ -777,9 +781,9 @@ document.write("Last Published: " + docu files in the <span class="codefrag">conf</span> directory you will, most likely, have to restart Forrest to see these changes. </p> -<a name="N101C4"></a><a name="release"></a> +<a name="N101C7"></a><a name="release"></a> <h3 class="underlined_5">Releasing a Plugin</h3> -<a name="N101CA"></a><a name="register"></a> +<a name="N101CD"></a><a name="register"></a> <h4>Register the Plugin with Apache Forrest</h4> <div class="fixme"> <div class="label">Fixme (open)</div> @@ -787,7 +791,7 @@ document.write("Last Published: " + docu Describe making a request of Forrest devs for inclusion </div> </div> -<a name="N101D5"></a><a name="deploy"></a> +<a name="N101D8"></a><a name="deploy"></a> <h4>Deploying the Plugin</h4> <p> To deploy the plugin so that others can use it, it must be made @@ -825,7 +829,7 @@ document.write("Last Published: " + docu cycle, but we feel the peace of mind is worth it. </div> </div> -<a name="N10207"></a><a name="descriptor"></a> +<a name="N1020A"></a><a name="descriptor"></a> <h4>Managing the plugins descriptors</h4> <p> The files plugins/plugins.xml and @@ -855,8 +859,6 @@ document.write("Last Published: " + docu <li>Review the docs and ensure any version numbers in text are "0.7"</li> -<li>Edit the skinconf.xml to ensure that all version numbers are "0.7", e.g. the MOTD.</li> - <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate. </li> <li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_70"</li> @@ -873,9 +875,6 @@ document.write("Last Published: " + docu <li>Review the docs and ensure any version numbers in text are "0.8"</li> -<li>Edit the skinconf.xml to ensure that all version numbers are - "0.8-dev", e.g. the MOTD.</li> - <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.8 and that the "version" is incremented. </li> @@ -885,7 +884,7 @@ document.write("Last Published: " + docu Start adding changes notes.</li> </ul> -<a name="N10246"></a><a name="experimental"></a> +<a name="N10243"></a><a name="experimental"></a> <h3 class="underlined_5">Experimental Functionality</h3> <div class="warning"> <div class="label">Warning</div> @@ -904,7 +903,7 @@ document.write("Last Published: " + docu <span class="codefrag">org.apache.forrest.internal.NoteTaking</span> plugin. </div> </div> -<a name="N10255"></a><a name="Locationmap"></a> +<a name="N10252"></a><a name="Locationmap"></a> <h4>Locationmap</h4> <p> Plugins can use the Forrest locationmap to expose resources to your @@ -916,7 +915,7 @@ document.write("Last Published: " + docu <a href="http://issues.apache.org/jira/browse/FOR-200">issue</a> for the status of locationmap development. </p> -<a name="N10269"></a><a name="Dispatcher"></a> +<a name="N10266"></a><a name="Dispatcher"></a> <h4>Dispatcher</h4> <p> Dispatcher (previous codename Forrest Views) is the collective name @@ -963,7 +962,7 @@ document.write("Last Published: " + docu locationmap which is generated when you seed a new plugin, but for now it must be done manually. </p> -<a name="N10289"></a><a name="Plugin+Properties"></a> +<a name="N10286"></a><a name="Plugin+Properties"></a> <h4>Plugin Properties</h4> <p> Plugins can define properties that each project can over-ride. For @@ -974,13 +973,13 @@ document.write("Last Published: " + docu <a href="http://issues.apache.org/jira/browse/FOR-588">issue</a> for the status of this new configuration system. </p> -<a name="N1029B"></a><a name="examples"></a> +<a name="N10298"></a><a name="examples"></a> <h3 class="underlined_5">Examples</h3> <p> This section will provide some example plugins to help illustrate the steps discussed above. </p> -<a name="N102A4"></a><a name="input"></a> +<a name="N102A1"></a><a name="input"></a> <h4>Input Plugin</h4> <div class="fixme"> <div class="label">Fixme (open)</div> @@ -988,7 +987,7 @@ document.write("Last Published: " + docu Discuss a simple example of an "input" plugin here. </div> </div> -<a name="N102AF"></a><a name="output"></a> +<a name="N102AC"></a><a name="output"></a> <h4>Output Plugin</h4> <div class="fixme"> <div class="label">Fixme (open)</div> @@ -996,7 +995,7 @@ document.write("Last Published: " + docu Discuss a simple example of an "output" plugin here. </div> </div> -<a name="N102BA"></a><a name="internal"></a> +<a name="N102B7"></a><a name="internal"></a> <h4>Internal Plugin</h4> <div class="fixme"> <div class="label">Fixme (open)</div> @@ -1004,7 +1003,7 @@ document.write("Last Published: " + docu Discuss a simple example of an "internal" plugin here. </div> </div> -<a name="N102C6"></a><a name="extension"></a> +<a name="N102C3"></a><a name="extension"></a> <h3 class="underlined_5">Further Reading</h3> <ul> @@ -1015,7 +1014,7 @@ document.write("Last Published: " + docu <a href="../../pluginDocs/plugins_0_90/">Plugins Documentation</a> for users</li> </ul> -<a name="N102DC"></a><a name="summarise"></a> +<a name="N102D9"></a><a name="summarise"></a> <h3 class="underlined_5">Summarise the Entire Process</h3> <div class="fixme"> <div class="label">Fixme (open)</div> Modified: forrest/site/dtdx/document-v13.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.pdf?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/document-v20.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pdf?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/forrest-issues.html URL: http://svn.apache.org/viewvc/forrest/site/forrest-issues.html?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== --- forrest/site/forrest-issues.html (original) +++ forrest/site/forrest-issues.html Sat Jan 8 21:59:58 2011 @@ -219,14 +219,14 @@ document.write("Last Published: " + docu <a href="#%5BFOR-1069%5D+add+notices+for+US+cryptographic+export+laws">[FOR-1069] add notices for US cryptographic export laws</a> </li> <li> -<a href="#%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly">[FOR-1187] upgraded PDF plugin was not deployed properly</a> -</li> -<li> <a href="#%5BFOR-644%5D+code-style+cleanup+for+xml+files">[FOR-644] code-style cleanup for xml files</a> </li> <li> <a href="#%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments">[FOR-922] update all docs that explain sitemap fragments</a> </li> +<li> +<a href="#%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly">[FOR-1187] upgraded PDF plugin was not deployed properly</a> +</li> </ul> </div> </div> @@ -306,15 +306,7 @@ Perhaps there some way that we can word- </p> <p>We need to investigate our SVN and add crypto notices as explained at <a href="http://www.apache.org/licenses/exports/">http://www.apache.org/licenses/exports/</a> and the legal-discuss mail list.</p> </div> -<a name="N10059"></a><a name="%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly"></a> -<h2 class="underlined_10">[FOR-1187] upgraded PDF plugin was not deployed properly</h2> -<div class="section"> -<p> -<a href="https://issues.apache.org:443/jira/browse/FOR-1187">https://issues.apache.org:443/jira/browse/FOR-1187</a> -</p> -<p>Around January 2008 the PDF plugin was upgraded, gaining functionality that was only relevant to forrest-0.9-dev. It was re-deployed without changing the version numbers in the plugin descriptor.</p> -</div> -<a name="N10065"></a><a name="%5BFOR-644%5D+code-style+cleanup+for+xml+files"></a> +<a name="N10059"></a><a name="%5BFOR-644%5D+code-style+cleanup+for+xml+files"></a> <h2 class="underlined_10">[FOR-644] code-style cleanup for xml files</h2> <div class="section"> <p> @@ -323,7 +315,7 @@ Perhaps there some way that we can word- <p>We have much inconsistent whitespace in all of our files. This is known to cause trouble in a collaborative environment. See discussion at: <a href="http://marc.theaimsgroup.com/?t=112450901100001">http://marc.theaimsgroup.com/?t=112450901100001</a> and <a href="http://marc.theaimsgroup.com/?t=112495618800002">http://marc.theaimsgroup.com/?t=112495618800002</a> and various linked discussions.<br/> </p> </div> -<a name="N10071"></a><a name="%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments"></a> +<a name="N10065"></a><a name="%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments"></a> <h2 class="underlined_10">[FOR-922] update all docs that explain sitemap fragments</h2> <div class="section"> <p> @@ -339,6 +331,14 @@ The sitemaps were recently updated to us <br/> These changes need to be reflected in the current docs.</p> </div> +<a name="N10071"></a><a name="%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly"></a> +<h2 class="underlined_10">[FOR-1187] upgraded PDF plugin was not deployed properly</h2> +<div class="section"> +<p> +<a href="https://issues.apache.org:443/jira/browse/FOR-1187">https://issues.apache.org:443/jira/browse/FOR-1187</a> +</p> +<p>Around January 2008 the PDF plugin was upgraded, gaining functionality that was only relevant to forrest-0.9-dev. It was re-deployed without changing the version numbers in the plugin descriptor.</p> +</div> </div> <!--+ |end content Modified: forrest/site/gump.html URL: http://svn.apache.org/viewvc/forrest/site/gump.html?rev=1056815&r1=1056814&r2=1056815&view=diff ============================================================================== --- forrest/site/gump.html (original) +++ forrest/site/gump.html Sat Jan 8 21:59:58 2011 @@ -328,13 +328,14 @@ document.write("Last Published: " + docu The results at separate Gump installations:<br> <span class="codefrag">vmgump.a.o</span> (Ubuntu Linux) | - <span class="codefrag">gump.zones.a.o</span> (FreeBSD) + <span class="codefrag">gump.zones.a.o</span> (FreeBSD) | + <span class="codefrag">adam.a.o</span> (Mac OS X Server) </p> <p> See <a href="http://gump.apache.org/#When+does+Gump+run?">notes</a> about when Gump operates, what platform, and what JVM version. </p> -<a name="N10060"></a><a name="forrest-core"></a> +<a name="N10063"></a><a name="forrest-core"></a> <h3 class="underlined_5">forrest-core</h3> <p> <strong>Status:</strong> Active</p> @@ -344,10 +345,11 @@ document.write("Last Published: " + docu <p> <a href="http://vmgump.apache.org/gump/public/forrest/forrest-core/">vmgump.a.o</a> | - <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-core/">gump.zones.a.o</a> + <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-core/">gump.zones.a.o</a> | + <a href="http://adam.apache.org/gump/forrest/forrest-core/">adam.a.o</a> </p> -<a name="N1007A"></a><a name="forrest-test-basic"></a> +<a name="N10081"></a><a name="forrest-test-basic"></a> <h3 class="underlined_5">forrest-test-basic</h3> <p> <strong>Status:</strong> Active</p> @@ -357,10 +359,11 @@ document.write("Last Published: " + docu <p> <a href="http://vmgump.apache.org/gump/public/forrest/forrest-test-basic/">vmgump.a.o</a> | - <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-test-basic/">gump.zones.a.o</a> + <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-test-basic/">gump.zones.a.o</a> | + <a href="http://adam.apache.org/gump/forrest/forrest-test-basic/">adam.a.o</a> </p> -<a name="N10094"></a><a name="forrest-test"></a> +<a name="N1009F"></a><a name="forrest-test"></a> <h3 class="underlined_5">forrest-test</h3> <p> <strong>Status:</strong> Active ... Needs attention</p> @@ -377,10 +380,11 @@ document.write("Last Published: " + docu <p> <a href="http://vmgump.apache.org/gump/public/forrest/forrest-test/">vmgump.a.o</a> | - <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-test/">gump.zones.a.o</a> + <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-test/">gump.zones.a.o</a> | + <a href="http://adam.apache.org/gump/forrest/forrest-test/">adam.a.o</a> </p> -<a name="N100B6"></a><a name="forrest-forrestbar"></a> +<a name="N100C5"></a><a name="forrest-forrestbar"></a> <h3 class="underlined_5">forrest-forrestbar</h3> <p> <strong>Status:</strong> Active</p> @@ -390,10 +394,11 @@ document.write("Last Published: " + docu <p> <a href="http://vmgump.apache.org/gump/public/forrest/forrest-forrestbar/">vmgump.a.o</a> | - <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-forrestbar/">gump.zones.a.o</a> + <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-forrestbar/">gump.zones.a.o</a> | + <a href="http://adam.apache.org/gump/forrest/forrest-forrestbar/">adam.a.o</a> </p> -<a name="N100D0"></a><a name="forrest-rat"></a> +<a name="N100E3"></a><a name="forrest-rat"></a> <h3 class="underlined_5">forrest-rat</h3> <p> <strong>Status:</strong> Active</p> @@ -404,7 +409,8 @@ document.write("Last Published: " + docu <p> <a href="http://vmgump.apache.org/gump/public/forrest/forrest-rat/">vmgump.a.o</a> | - <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-rat/">gump.zones.a.o</a> + <a href="http://gump.zones.apache.org/gump/public/forrest/forrest-rat/">gump.zones.a.o</a> | + <a href="http://adam.apache.org/gump/forrest/forrest-rat/">adam.a.o</a> </p> </div>