Modified: forrest/site/docs_0_90/faq.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/faq.xml?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/docs_0_90/faq.xml (original) +++ forrest/site/docs_0_90/faq.xml Thu Jan 13 03:32:05 2011 @@ -26,7 +26,7 @@ <p> You have a local copy of the main documentation with your version of Forrest. Do 'cd site-author; forrest run' and visit - http://localhost:8888/ in your browser. The most recent documentation + <code>http://localhost:8888/</code> in your browser. The most recent documentation is in SVN trunk which creates the forrest.apache.org website. </p> <p> @@ -129,8 +129,8 @@ forrest -Dproject.start-uri=live-sites.h </p> <p> Another useful technique is to use 'wget' or Apache Ant's Get task to - retrieve individual files, e.g. Do 'forrest run' and then 'wget - http://localhost:8888/index.pdf'. + retrieve individual files, e.g. Do 'forrest run' and then + <code>'wget http://localhost:8888/index.pdf'</code> </p> </section><section id="cygwin_mutex_error"><title>1.9. 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> @@ -1180,11 +1180,27 @@ X [0] /docs_0_80/upgrading_08.ht <p> Do <code>'forrest -projecthelp'</code> or <code>'./build.sh'</code> to find the version number. + Also when starting <code>'forrest'</code> or <code>'forrest run'</code> + the versions are reported for forrest, java, and ant. </p> <p> - To list the properties, add "forrest.echo=true" to your + To list the properties and other stuff, add "forrest.echo=true" to your forrest.properties file and watch the build messages. Doing - <code>'forrest -v'</code> will provide verbose build messages. + <code>'forrest -v'</code> will provide verbose build messages and other useful + information. + </p> + <p> + In <code>'forrest run'</code> mode, use the + <link href="site:forrestbar">Forrestbar</link> to see the build-info + and properties, or access them directly: + </p> + <ul> + <li><code>http://localhost:8888/build-info</code></li> + <li><code>http://localhost:8888/module.properties.properties</code></li> + </ul> + <p> + See the documentation about the new <link href="site:properties">Properties</link> + system. </p> </section><section id="logs"><title>5.4. Where are the log files to find more infomation about errors? </title> <p>
Modified: forrest/site/docs_0_90/properties.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/properties.html?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/docs_0_90/properties.html (original) +++ forrest/site/docs_0_90/properties.html Thu Jan 13 03:32:05 2011 @@ -354,6 +354,17 @@ document.write("Last Published: " + docu </div> <div class="fixme"> +<div class="label">Fixme ()</div> +<div class="content"> + The properties system needs more documentation. There is discussion in the + mail archives. + Also <a href="https://issues.apache.org/jira/browse/FOR-734";>FOR-734</a> + and <a href="https://issues.apache.org/jira/browse/FOR-588";>FOR-588</a> + etc. + </div> +</div> + +<div class="fixme"> <div class="label">Fixme (forrest-dev)</div> <div class="content"> There have been a proposal about the naming convention about the properties @@ -361,7 +372,7 @@ document.write("Last Published: " + docu </div> </div> -<a name="N10029"></a><a name="module"></a> +<a name="N10035"></a><a name="module"></a> <h2 class="underlined_10">ModuleGenerator</h2> <div class="section"> <p> Modified: forrest/site/docs_0_90/upgrading_09.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/upgrading_09.html?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/docs_0_90/upgrading_09.html (original) +++ forrest/site/docs_0_90/upgrading_09.html Thu Jan 13 03:32:05 2011 @@ -397,7 +397,10 @@ document.write("Last Published: " + docu important supporting products such as Apache Xerces and Apache Xalan, etc. </li> -<li>[Placeholder]</li> +<li> + The properties are supplemented by the new + <a href="../docs_0_90/properties.html">Properties</a> system. + </li> <li>Java 1.5</li> @@ -410,7 +413,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N10056"></a><a name="jdk15"></a> +<a name="N1005A"></a><a name="jdk15"></a> <h2 class="underlined_10">Java 1.5 (or newer) is required</h2> <div class="section"> <p> @@ -420,7 +423,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N10064"></a><a name="cocoon"></a> +<a name="N10068"></a><a name="cocoon"></a> <h2 class="underlined_10">Notes about Cocoon version</h2> <div class="section"> <p> @@ -457,7 +460,7 @@ document.write("Last Published: " + docu see the notes in the <span class="codefrag">$FORREST_HOME/etc/cocoon_upgrade</span> directory. </p> -<a name="N10080"></a><a name="cocoon-upgrade"></a> +<a name="N10084"></a><a name="cocoon-upgrade"></a> <h3 class="underlined_5">Cocoon upgrade issues</h3> <p> There are only two minor issues for those upgrading from the previous @@ -484,7 +487,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N1009A"></a><a name="missing-symbols"></a> +<a name="N1009E"></a><a name="missing-symbols"></a> <h2 class="underlined_10">Missing project symbols file in some projects</h2> <div class="section"> <p>Users of 0.8, and developers with older 0.9-dev, who based their sites on 'forrest seed-basic' rather than 'forrest seed-sample' will be affected by <a href="https://issues.apache.org/jira/browse/FOR-1075";>FOR-1075</a>. There was a partially implemented xml catalog with missing symbols file. @@ -511,7 +514,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N100C0"></a><a name="docs"></a> +<a name="N100C4"></a><a name="docs"></a> <h2 class="underlined_10">Notes about documentation</h2> <div class="section"> <p> @@ -527,11 +530,11 @@ document.write("Last Published: " + docu </p> </div> -<a name="N100D2"></a><a name="tips"></a> +<a name="N100D6"></a><a name="tips"></a> <h2 class="underlined_10">General upgrade tips</h2> <div class="section"> <p> - Synchronise your project's skinconf.xml and forrest.properties files. + Synchronise your project's skinconf.xml and forrest.properties files: </p> <p> Take advantage of the separation of concerns. In a new workspace, create @@ -543,7 +546,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N100E2"></a><a name="project-sitemap"></a> +<a name="N100E6"></a><a name="project-sitemap"></a> <h2 class="underlined_10">Remove project sitemap if not necessary</h2> <div class="section"> <p> @@ -558,7 +561,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N100F7"></a><a name="To+be+continued..."></a> +<a name="N100FB"></a><a name="To+be+continued..."></a> <h2 class="underlined_10">To be continued...</h2> <div class="section"> <p> Modified: forrest/site/dtdx/document-v13.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.pdf?rev=1058400&r1=1058399&r2=1058400&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=1058400&r1=1058399&r2=1058400&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=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/forrest-issues.html (original) +++ forrest/site/forrest-issues.html Thu Jan 13 03:32:05 2011 @@ -210,18 +210,12 @@ document.write("Last Published: " + docu <a href="#%5BFOR-1184%5D+using+unreleased+code+for+some+supporting+products">[FOR-1184] using unreleased code for some supporting products</a> </li> <li> -<a href="#%5BFOR-1104%5D+pdf+output+warnings+%22paragraph+overflows+the+available+area%22">[FOR-1104] pdf output warnings "paragraph overflows the available area"</a> -</li> -<li> <a href="#%5BFOR-1077%5D+new+CreationDate+causes+constant+differences+in+output+pdf+documents">[FOR-1077] new CreationDate causes constant differences in output pdf documents</a> </li> <li> <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-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> </ul> @@ -270,22 +264,7 @@ C) Remove any author tags.</p> </p> <p>After the last release, an issue was brought to our attention about using unreleased code from other projects.</p> </div> -<a name="N10035"></a><a name="%5BFOR-1104%5D+pdf+output+warnings+%22paragraph+overflows+the+available+area%22"></a> -<h2 class="underlined_10">[FOR-1104] pdf output warnings "paragraph overflows the available area"</h2> -<div class="section"> -<p> -<a href="https://issues.apache.org:443/jira/browse/FOR-1104";>https://issues.apache.org:443/jira/browse/FOR-1104</a> -</p> -<p>Warnings are issued such as the following from our &quot;site-author&quot;:<br/> -<br/> -WARN - Line 1 of a paragraph overflows the available area. (fo:block, &quot;project.required.plugins=org.apache.forrest.plugin.input.OpenOffice.o)<br/> -<br/> -These come from &quot;source&quot; elements with content that has lines that are too wide, e.g.<br/> -pluginDocs/plugins_0_90/usingPlugins.xml<br/> -<br/> -Perhaps there some way that we can word-wrap or break the long text lines.</p> -</div> -<a name="N10041"></a><a name="%5BFOR-1077%5D+new+CreationDate+causes+constant+differences+in+output+pdf+documents"></a> +<a name="N10035"></a><a name="%5BFOR-1077%5D+new+CreationDate+causes+constant+differences+in+output+pdf+documents"></a> <h2 class="underlined_10">[FOR-1077] new CreationDate causes constant differences in output pdf documents</h2> <div class="section"> <p> @@ -295,7 +274,7 @@ Perhaps there some way that we can word- <br/> </p> </div> -<a name="N1004D"></a><a name="%5BFOR-1069%5D+add+notices+for+US+cryptographic+export+laws"></a> +<a name="N10041"></a><a name="%5BFOR-1069%5D+add+notices+for+US+cryptographic+export+laws"></a> <h2 class="underlined_10">[FOR-1069] add notices for US cryptographic export laws</h2> <div class="section"> <p> @@ -303,16 +282,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-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> -<a href="https://issues.apache.org:443/jira/browse/FOR-644";>https://issues.apache.org:443/jira/browse/FOR-644</a> -</p> -<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="N10065"></a><a name="%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments"></a> +<a name="N1004D"></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> Modified: forrest/site/howto-dev.html URL: http://svn.apache.org/viewvc/forrest/site/howto-dev.html?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/howto-dev.html (original) +++ forrest/site/howto-dev.html Thu Jan 13 03:32:05 2011 @@ -784,16 +784,24 @@ $ svn merge -r 303:302 intermediate documents, such as "<span class="codefrag">http://localhost:8888/body-index.html</span>" which will return the intermediate processing of the body part of the - document, and + <span class="codefrag">/index.html</span> document, and "<span class="codefrag">http://localhost:8888/index.xml</span>" which will return the intermediate xml. </p> <p> The techniques described below help you to be aware of the intermediate processing steps. - The <a href="tools/forrestbar.html">ForrestBar</a> also provides access. </p> -<a name="N101CA"></a><a name="debug-cocoon-profiler"></a> +<p> + The <a href="tools/forrestbar.html">ForrestBar</a> also provides easy access + to various internal data to assist with both understanding how the + processing works and with debugging. + </p> +<p> + See also the <a href="docs_0_90/faq.html#version">FAQ</a> + which explains access to version and all "properties" information. + </p> +<a name="N101D7"></a><a name="debug-cocoon-profiler"></a> <h4>Using Cocoon sitemap profiler</h4> <p> Cocoon provides a simple profiler to analyse itself. This enables us @@ -823,7 +831,7 @@ $ svn merge -r 303:302 NOTE: Do not forget to turn off the profiler in <span class="codefrag">main/webapp/sitemap.xmap</span> when finished. </p> -<a name="N101E6"></a><a name="debug-sitemap-exec"></a> +<a name="N101F3"></a><a name="debug-sitemap-exec"></a> <h4>Using Cocoon sitemap execution logger</h4> <p> In main/webapp/WEB-INF/cocoon.xconf search for "sitemap @@ -836,7 +844,7 @@ $ svn merge -r 303:302 See <a href="https://issues.apache.org/jira/browse/FOR-1109";>FOR-1109</a> - Not available in Cocoon-2.1 </div> </div> -<a name="N101F8"></a><a name="debug-logtransformer"></a> +<a name="N10205"></a><a name="debug-logtransformer"></a> <h4>Using Cocoon LogTransformer</h4> <p> LogTransformers can be inserted in the sitemaps. This will write the @@ -871,7 +879,7 @@ $ svn merge -r 303:302 being taken through the sitemap. Add various LogTransformers with different filenames and see which one gets triggered. </p> -<a name="N1020F"></a><a name="debug-validation"></a> +<a name="N1021C"></a><a name="debug-validation"></a> <h4>Using Cocoon Validation Transformers</h4> <p> Validating Transformers can be inserted in the sitemaps to validate @@ -904,7 +912,7 @@ $ svn merge -r 303:302 See <a href="http://cocoon.zones.apache.org/demos/21branch/samples/blocks/validation/welcome";>Validation Block Samples</a> demos at the Cocoon zone. See <a href="http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/components/validation/Validator.html";>API</a> docs. </p> -<a name="N10240"></a><a name="validate-intermediate"></a> +<a name="N1024D"></a><a name="validate-intermediate"></a> <h4>Validate all intermediate xml content</h4> <p> Add a text file at <span class="codefrag">src/documentation/conf/uris.txt</span> @@ -921,7 +929,7 @@ $ svn merge -r 303:302 see the document <span class="codefrag">build/tmp/validation-reports.html</span> </p> -<a name="N10262"></a><a name="debug-java"></a> +<a name="N1026F"></a><a name="debug-java"></a> <h4>Java code</h4> <p> There are two ways to debug your java code. The first is through @@ -940,7 +948,7 @@ $ svn merge -r 303:302 in debug mode on a specific port. For example: </p> <pre class="code">forrest.jvmargs=-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n</pre> -<a name="N1027F"></a><a name="debug-links"></a> +<a name="N1028C"></a><a name="debug-links"></a> <h4>Finding broken internal links</h4> <p> Do 'forrest site' to produce the whole documentation set. Cocoon will @@ -961,7 +969,7 @@ $ svn merge -r 303:302 the correct name for the "site:..." value. Use the "localhost:8888/abs-menulinks" resource or via <a href="tools/forrestbar.html">ForrestBar</a>. </p> -<a name="N10297"></a><a name="tips-debug"></a> +<a name="N102A4"></a><a name="tips-debug"></a> <h4>Tips</h4> <ul> @@ -980,7 +988,7 @@ $ svn merge -r 303:302 provide a documentation patch. </div> </div> -<a name="N102A7"></a><a name="profile-yourkit"></a> +<a name="N102B4"></a><a name="profile-yourkit"></a> <h4>Profiling Forrest with YourKit</h4> <p> Assuming you have the YourKit software installed you simply need to do @@ -998,7 +1006,7 @@ $ svn merge -r 303:302 current filters - YourKit seems to filter out org.apache.* namespaces by default. </p> -<a name="N102B8"></a><a name="profile-netbeans"></a> +<a name="N102C5"></a><a name="profile-netbeans"></a> <h4>Profiling Forrest with Netbeans</h4> <p> Assuming you have the Netbeans IDE installed, you simply need to do a @@ -1016,13 +1024,13 @@ profilerinterface.dll=\C:\\*NetbeansHome Netbeans IDE with your Forrest project. Click Profile->Attach Profiler and make selections appropriate to what you are trying to achieve. </p> -<a name="N102CA"></a><a name="find"></a> +<a name="N102D7"></a><a name="find"></a> <h3 class="underlined_5">Finding the relevant sources</h3> <p> You will need to be able to find which sources, sitemaps, stylesheets are responsible for certain processing. </p> -<a name="N102D3"></a><a name="find-scenario-1"></a> +<a name="N102E0"></a><a name="find-scenario-1"></a> <h4>Scenario: How does i18n work</h4> <p> We will do a search for "i18n" to start with, then refine that after @@ -1065,7 +1073,7 @@ grep i18n *.*</pre> declared to use i18n, then further down the page the "skinit" pipeline uses the i18n transformer only if i18n is switched on. </p> -<a name="N102F5"></a><a name="tips-find"></a> +<a name="N10302"></a><a name="tips-find"></a> <h4>Tips</h4> <ul> @@ -1075,32 +1083,32 @@ grep i18n *.*</pre> </ul> </div> -<a name="N10305"></a><a name="faqs"></a> +<a name="N10312"></a><a name="faqs"></a> <h2 class="underlined_10">Frequently Asked Questions</h2> <div class="section"> -<a name="N10309"></a><a name="faq-general"></a> +<a name="N10316"></a><a name="faq-general"></a> <h3 class="underlined_5">1 General issues</h3> -<a name="N1030D"></a><a name="1.1+FAQ+1"></a> +<a name="N1031A"></a><a name="1.1+FAQ+1"></a> <h4>1.1 FAQ 1</h4> <p> #### </p> -<a name="N10315"></a><a name="faq-other"></a> +<a name="N10322"></a><a name="faq-other"></a> <h3 class="underlined_5">2 Other issues</h3> -<a name="N10319"></a><a name="2.1+FAQ+2.1"></a> +<a name="N10326"></a><a name="2.1+FAQ+2.1"></a> <h4>2.1 FAQ 2.1</h4> <p> ### </p> </div> -<a name="N10321"></a><a name="Tips"></a> +<a name="N1032E"></a><a name="Tips"></a> <h2 class="underlined_10">Tips</h2> <div class="section"> <p> This is a collection of general tips that do not fit in the sections above. </p> -<a name="N10329"></a><a name="tip-howto"></a> +<a name="N10336"></a><a name="tip-howto"></a> <h3 class="underlined_5">Explanations about howto topics on the mailing lists</h3> <p> Often there are useful discussions on the mailing lists which explain @@ -1109,7 +1117,7 @@ grep i18n *.*</pre> links to the email discussion. Later someone else can summarise. </p> </div> -<a name="N10333"></a><a name="References"></a> +<a name="N10340"></a><a name="References"></a> <h2 class="underlined_10">References</h2> <div class="section"> <p> Modified: forrest/site/tools/forrestbar.html URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbar.html?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== --- forrest/site/tools/forrestbar.html (original) +++ forrest/site/tools/forrestbar.html Thu Jan 13 03:32:05 2011 @@ -324,13 +324,7 @@ document.write("Last Published: " + docu </li> </ul> -<div class="fixme"> -<div class="label">Fixme (open)</div> -<div class="content"> - Need to re-enable access to localhost:8888/foo/bar.xml and localhost:8888/foo/bar.fo internal formats. - </div> -</div> -<a name="N100B4"></a><a name="Dispatcher+Dev+menu"></a> +<a name="N100B0"></a><a name="Dispatcher+Dev+menu"></a> <h3 class="underlined_5">Dispatcher Dev menu</h3> <div class="warning"> <div class="label">Warning</div> @@ -340,7 +334,7 @@ document.write("Last Published: " + docu The site needs to be enabled to use the Dispatcher. </div> </div> -<a name="N100C3"></a><a name="Internal+formats+section"></a> +<a name="N100BF"></a><a name="Internal+formats+section"></a> <h4>Internal formats section</h4> <p> These options give you direct access to dispatcher internal xml @@ -361,13 +355,13 @@ document.write("Last Published: " + docu These accesses are very interesting in development phase to display - in xml format - the content of any dispatcher page. </p> -<a name="N100DF"></a><a name="Structurer+section"></a> +<a name="N100DB"></a><a name="Structurer+section"></a> <h4>Structurer section</h4> <p> This option gives you direct access to the structurer which is in charge to generate the current page. </p> -<a name="N100E9"></a><a name="Contracts+section"></a> +<a name="N100E5"></a><a name="Contracts+section"></a> <h4>Contracts section</h4> <p> These options give you direct access to an automatically generated @@ -379,7 +373,7 @@ document.write("Last Published: " + docu contracts available whereas the <em>ls.contracts.project</em> only displays the list of contracts specific to the project. </p> -<a name="N100FD"></a><a name="Search+Archives+menu"></a> +<a name="N100F9"></a><a name="Search+Archives+menu"></a> <h3 class="underlined_5">Search Archives menu</h3> <p> This menu lets you search in different Forrest related archives or @@ -424,7 +418,7 @@ document.write("Last Published: " + docu Select "Subject" to obtain a "thread-and-focus" URL. </div> </div> -<a name="N10125"></a><a name="Search+Dispatcher+menu"></a> +<a name="N10121"></a><a name="Search+Dispatcher+menu"></a> <h3 class="underlined_5">Search Dispatcher menu</h3> <div class="warning"> <div class="label">Warning</div> @@ -446,7 +440,7 @@ document.write("Last Published: " + docu </p> </div> -<a name="N10142"></a><a name="configure"></a> +<a name="N1013E"></a><a name="configure"></a> <h2 class="underlined_10">Configuring the ForrestBar</h2> <div class="section"> <p> Modified: forrest/site/tools/forrestbar.xpi URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbar.xpi?rev=1058400&r1=1058399&r2=1058400&view=diff ============================================================================== Binary files - no diff available.
