forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r465453 - in /forrest/site: docs_0_80/your-project.html docs_0_80/your-project.pdf forrest-issues.html forrest-issues.pdf
Date Thu, 19 Oct 2006 02:46:23 GMT
Author: crossley
Date: Wed Oct 18 19:46:20 2006
New Revision: 465453

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

Modified:
    forrest/site/docs_0_80/your-project.html
    forrest/site/docs_0_80/your-project.pdf
    forrest/site/forrest-issues.html
    forrest/site/forrest-issues.pdf

Modified: forrest/site/docs_0_80/your-project.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/your-project.html?view=diff&rev=465453&r1=465452&r2=465453
==============================================================================
--- forrest/site/docs_0_80/your-project.html (original)
+++ forrest/site/docs_0_80/your-project.html Wed Oct 18 19:46:20 2006
@@ -448,14 +448,19 @@
 <a name="N1002B"></a><a name="Setting+up+the+Environment"></a>
 <h3 class="underlined_5">Setting up the Environment</h3>
 <p>
-       After downloading and extracting forrest, you need to add environment variables.
+       After downloading and extracting Forrest, you need to add environment variables.
+       The reason for this is so that the 'forrest' command is available everywhere and it
can
+       locate its home directory and resources.
+       It is beyond the scope of Forrest to explain how to manage your operating system.
Some tips are listed below and this
+       <a href="http://mail-archives.apache.org/mod_mbox/forrest-user/200610.mbox/%3ceab855560610181625u6e49b49at7df6c0c5e6812c74@mail.gmail.com%3e">message</a>
+       explains further and provides other tips about using Windows.
        </p>
-<a name="N10034"></a><a name="In+Unix%2FLinux%3A"></a>
+<a name="N10038"></a><a name="In+Unix%2FLinux%3A"></a>
 <h4>In Unix/Linux:</h4>
 <p class="instruction">change directory to the top-level of the forrest distribution
and do ...</p>
 <p class="instruction">~/apache-forrest-0.7$ export FORREST_HOME=`pwd`</p>
 <p class="instruction">~/apache-forrest-0.7$ export PATH=$PATH:$FORREST_HOME/bin</p>
-<a name="N10046"></a><a name="Permanently+Setting+The+Environment+Variables+for+Linux%2FUnix"></a>
+<a name="N1004A"></a><a name="Permanently+Setting+The+Environment+Variables+for+Linux%2FUnix"></a>
 <h5>Permanently Setting The Environment Variables for Linux/Unix</h5>
 <p>Export only changes the variables during that terminal session for that 
            user, this is useful for testing. To permanently add the variable edit either

@@ -468,14 +473,14 @@
       PATH=$PATH:$FORREST_HOME/bin
       export PATH
           </pre>
-<a name="N1005B"></a><a name="Windows+2000"></a>
+<a name="N1005F"></a><a name="Windows+2000"></a>
 <h4>Windows 2000</h4>
 <p class="instruction">Go to "My Computer", "Properties", "Advanced", "Environment
Variables"</p>
 <p class="instruction">add a new variable <span class="codefrag">FORREST_HOME</span>
as <span class="codefrag">C:\full\path\to\apache-forrest-0.7</span>
 </p>
 <p class="instruction">edit <span class="codefrag">PATH</span> as <span
class="codefrag">%PATH%;%FORREST_HOME%\bin</span>
 </p>
-<a name="N10078"></a><a name="In+Windows+XP%3A"></a>
+<a name="N1007C"></a><a name="In+Windows+XP%3A"></a>
 <h4>In Windows XP:</h4>
 <p class="instruction">Go to "My Computer", "Properties", "Advanced", "Environment
Variables"</p>
 <p class="instruction">Create a New variable with name: FORREST_HOME value: C:\full\path\to\apache-forrest-0.7</p>
@@ -483,7 +488,7 @@
 </div>
    
    
-<a name="N1008D"></a><a name="The+%27forrest%27+Command"></a>
+<a name="N10091"></a><a name="The+%27forrest%27+Command"></a>
 <h2 class="underlined_10">The 'forrest' Command</h2>
 <div class="section">
 <p>
@@ -543,7 +548,7 @@
 </div>
 
     
-<a name="N1009E"></a><a name="seeding_new"></a>
+<a name="N100A2"></a><a name="seeding_new"></a>
 <h2 class="underlined_10">Seeding a new project</h2>
 <div class="section">
 <p>
@@ -707,7 +712,7 @@
       </p>
 </div>
     
-<a name="N100E2"></a><a name="seeding_existing"></a>
+<a name="N100E6"></a><a name="seeding_existing"></a>
 <h2 class="underlined_10">Seeding an existing project</h2>
 <div class="section">
 <p>
@@ -727,7 +732,7 @@
       </p>
 </div>
     
-<a name="N100F6"></a><a name="customizing"></a>
+<a name="N100FA"></a><a name="customizing"></a>
 <h2 class="underlined_10">Customizing your project</h2>
 <div class="section">
 <p>
@@ -735,7 +740,7 @@
         to your project's needs. Here we will deal with configuring the skin, and
         changing the project layout.
       </p>
-<a name="N100FF"></a><a name="skinconf.xml"></a>
+<a name="N10103"></a><a name="skinconf.xml"></a>
 <h3 class="underlined_5">Configuring the Forrest skin: skinconf.xml</h3>
 <p>
           Most Forrest skins can be customized through a single XML file,
@@ -912,7 +917,7 @@
           Having edited this file (and ensured it is valid XML), re-run the 'forrest'
           command in the site root, and the site would be updated.
         </p>
-<a name="N1011C"></a><a name="Changing_the_layout"></a>
+<a name="N10120"></a><a name="Changing_the_layout"></a>
 <h3 class="underlined_5">Changing the layout: forrest.properties</h3>
 <p>
           Forrest allows you to place files anywhere you want in your
@@ -992,7 +997,7 @@
 </div>
 
     
-<a name="N1015B"></a><a name="adding_content"></a>
+<a name="N1015F"></a><a name="adding_content"></a>
 <h2 class="underlined_10">Adding content</h2>
 <div class="section">
 <p>
@@ -1000,7 +1005,7 @@
         <span class="codefrag">src/documentation/content/xdocs</span>
       
 </p>
-<a name="N10167"></a><a name="site.xml"></a>
+<a name="N1016B"></a><a name="site.xml"></a>
 <h3 class="underlined_5">site.xml</h3>
 <p>
           When adding a new xml document, you would add an entry to the project's
@@ -1009,7 +1014,7 @@
           xdocs for an example.  More detailed info about site.xml is provided in 
           the document <a href="../docs_0_80/linking.html">Menus and Linking</a>.
         </p>
-<a name="N10178"></a><a name="tabs.xml"></a>
+<a name="N1017C"></a><a name="tabs.xml"></a>
 <h3 class="underlined_5">tabs.xml</h3>
 <p>
           The <span class="codefrag">tabs.xml</span> file is used to produce
the 'tabs'.
@@ -1039,7 +1044,7 @@
     &lt;tab label="Xerces" href="http://xml.apache.org/xerces"/&gt;
   &lt;/tab&gt;
 </pre>
-<a name="N101A3"></a><a name="images"></a>
+<a name="N101A7"></a><a name="images"></a>
 <h3 class="underlined_5">Images</h3>
 <p>
           Images usually go in the <span class="codefrag">resources/images/</span>
directory.
@@ -1051,7 +1056,7 @@
 </div>
 
     
-<a name="N101B7"></a><a name="sitemap.xmap"></a>
+<a name="N101BB"></a><a name="sitemap.xmap"></a>
 <h2 class="underlined_10">Advanced customizations: sitemap.xmap</h2>
 <div class="section">
 <p>
@@ -1124,7 +1129,7 @@
         default sitemap.
       </div>
 </div>
-<a name="N1021F"></a><a name="adding_new_content_type"></a>
+<a name="N10223"></a><a name="adding_new_content_type"></a>
 <h3 class="underlined_5">Example: Adding a new content type</h3>
 <p>
           There are two methods for detecting types of documents
@@ -1272,7 +1277,7 @@
             will handle the aggregation with navigation menus etc. and will
             apply the normal skin.
           </p>
-<a name="N1026B"></a><a name="new_dtd"></a>
+<a name="N1026F"></a><a name="new_dtd"></a>
 <h4>Registering a new DTD</h4>
 <p>
                  By default, Forrest requires that all XML files be valid, i.e.
@@ -1303,7 +1308,7 @@
                  for the complete description for those steps.
                </div>
 </div>
-<a name="N10293"></a><a name="adding_new_content_type_2"></a>
+<a name="N10297"></a><a name="adding_new_content_type_2"></a>
 <h3 class="underlined_5">Example: Adding a new content type (advanced)</h3>
 <p>
               The simple user sitemap in the previous example is fine for
@@ -1384,7 +1389,7 @@
               can be used, because the project sitemap is the first sitemap
               to be consulted.
             </p>
-<a name="N102BC"></a><a name="integrating_rss"></a>
+<a name="N102C0"></a><a name="integrating_rss"></a>
 <h3 class="underlined_5">Example: integrating external RSS content</h3>
 <p>Similar to the previous example, we can integrate RSS into our
               site simply by providing a match in our project sitemap.xmap ...
@@ -1417,7 +1422,7 @@
 </div>
 
       
-<a name="N102D7"></a><a name="skins"></a>
+<a name="N102DB"></a><a name="skins"></a>
 <h2 class="underlined_10">Forrest skins</h2>
 <div class="section">
 <p>
@@ -1441,7 +1446,7 @@
           many capabilities so that extra skins are not needed.
         </div>
 </div>
-<a name="N102F3"></a><a name="skin-configuration"></a>
+<a name="N102F7"></a><a name="skin-configuration"></a>
 <h3 class="underlined_5">Configuration of skins</h3>
 <p>
           All configuration is done via your project
@@ -1449,7 +1454,7 @@
           It contains many comments to describe each capability.
           Please read those, there is no point repeating here.
           </p>
-<a name="N10300"></a><a name="new_skin"></a>
+<a name="N10304"></a><a name="new_skin"></a>
 <h3 class="underlined_5">Defining a new skin</h3>
 <p>Consider discussing your needs on the mailing lists. There may
           be planned enhancements to the core skins. Also consider contributing
@@ -1523,7 +1528,7 @@
 </div>
 
     
-<a name="N10347"></a><a name="webapp"></a>
+<a name="N1034B"></a><a name="webapp"></a>
 <h2 class="underlined_10">Interactive Forrest: faster turnaround when developing your
docs</h2>
 <div class="section">
 <p>
@@ -1537,7 +1542,7 @@
         a "live" Forrest webapp instance, the Forrest-based documentation
         development can be faster and easier than with comparable tools.
       </p>
-<a name="N10358"></a><a name="forrest_run"></a>
+<a name="N1035C"></a><a name="forrest_run"></a>
 <h3 class="underlined_5">Running as a webapp</h3>
 <p>
           Type '<span class="codefrag">forrest run</span>' in your project root
to start Forrest's
@@ -1549,7 +1554,7 @@
           servlet container, type <span class="codefrag">forrest webapp</span>
to build an open
           webapp in <span class="codefrag">build/webapp/</span>)
         </p>
-<a name="N10371"></a><a name="using_webapp"></a>
+<a name="N10375"></a><a name="using_webapp"></a>
 <h4>Using the webapp</h4>
 <p>
             You can now edit the XML content in
@@ -1558,7 +1563,7 @@
           </p>
 </div>
     
-<a name="N10380"></a><a name="invoking_from_ant"></a>
+<a name="N10384"></a><a name="invoking_from_ant"></a>
 <h2 class="underlined_10">Invoking Forrest from Ant</h2>
 <div class="section">
 <p>

Modified: forrest/site/docs_0_80/your-project.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/your-project.pdf?view=diff&rev=465453&r1=465452&r2=465453
==============================================================================
Binary files - no diff available.

Modified: forrest/site/forrest-issues.html
URL: http://svn.apache.org/viewvc/forrest/site/forrest-issues.html?view=diff&rev=465453&r1=465452&r2=465453
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Wed Oct 18 19:46:20 2006
@@ -252,9 +252,6 @@
 <a href="#%5BFOR-537%5D+Plugin+documentation+sitemap+references">[FOR-537] Plugin documentation
sitemap references</a>
 </li>
 <li>
-<a href="#%5BFOR-635%5D+images+not+reproduced+in+PDFs%2C+if+sources+are+in+xdocs%2Fimages+directory">[FOR-635]
images not reproduced in PDFs, if sources are in xdocs/images directory</a>
-</li>
-<li>
 <a href="#%5BFOR-671%5D+Layering+error+of+HTML+headings+breaks+rest+of+the+page+w%2Fo+warning">[FOR-671]
Layering error of HTML headings breaks rest of the page w/o warning</a>
 </li>
 <li>
@@ -263,6 +260,9 @@
 <li>
 <a href="#%5BFOR-767%5D+Forrestbot+webapp+reports+succesful+even+when+there+are+broken+links">[FOR-767]
Forrestbot webapp reports succesful even when there are broken links</a>
 </li>
+<li>
+<a href="#%5BFOR-861%5D+Update+locationmap+docs+for+working+with+remote+files">[FOR-861]
Update locationmap docs for working with remote files</a>
+</li>
 </ul>
 </div>
 <div class="note">
@@ -659,15 +659,7 @@
 &lt;br/&gt;
 --tim</p>
 </div>
-<a name="N1010D"></a><a name="%5BFOR-635%5D+images+not+reproduced+in+PDFs%2C+if+sources+are+in+xdocs%2Fimages+directory"></a>
-<h2 class="underlined_10">[FOR-635] images not reproduced in PDFs, if sources are in
xdocs/images directory</h2>
-<div class="section">
-<p>
-<a href="http://issues.apache.org/jira/browse/FOR-635">http://issues.apache.org/jira/browse/FOR-635</a>
-</p>
-<p>We used to enable images to be placed in the xdocs/images directory. However, now
they are intended to go in the resources/images directory instead. Both methods will work
for html pages, but  only the latter method for the PDF pages.</p>
-</div>
-<a name="N10119"></a><a name="%5BFOR-671%5D+Layering+error+of+HTML+headings+breaks+rest+of+the+page+w%2Fo+warning"></a>
+<a name="N1010D"></a><a name="%5BFOR-671%5D+Layering+error+of+HTML+headings+breaks+rest+of+the+page+w%2Fo+warning"></a>
 <h2 class="underlined_10">[FOR-671] Layering error of HTML headings breaks rest of
the page w/o warning</h2>
 <div class="section">
 <p>
@@ -729,7 +721,7 @@
 &lt;br/&gt;
 &amp;lt;/html&amp;gt;</p>
 </div>
-<a name="N10125"></a><a name="%5BFOR-731%5D+empty+linkmap.html+document%2C+side-effect+of+workaround+to+FOR-675"></a>
+<a name="N10119"></a><a name="%5BFOR-731%5D+empty+linkmap.html+document%2C+side-effect+of+workaround+to+FOR-675"></a>
 <h2 class="underlined_10">[FOR-731] empty linkmap.html document, side-effect of workaround
to FOR-675</h2>
 <div class="section">
 <p>
@@ -737,7 +729,7 @@
 </p>
 <p>The main/webapp/resources/stylesheets/linkmap-to-document.xsl has a workaround for
a side-effect to the of the workaround for issue &lt;a href="http://issues.apache.org/jira/browse/FOR-675"
title="upgrading to commons-jxpath-1.2.jar causes failures with linkrewriter protocols site:
etc."&gt;FOR-675&lt;/a&gt;.</p>
 </div>
-<a name="N10131"></a><a name="%5BFOR-767%5D+Forrestbot+webapp+reports+succesful+even+when+there+are+broken+links"></a>
+<a name="N10125"></a><a name="%5BFOR-767%5D+Forrestbot+webapp+reports+succesful+even+when+there+are+broken+links"></a>
 <h2 class="underlined_10">[FOR-767] Forrestbot webapp reports succesful even when there
are broken links</h2>
 <div class="section">
 <p>
@@ -754,6 +746,26 @@
 - ??
 &lt;br/&gt;
 </p>
+</div>
+<a name="N10131"></a><a name="%5BFOR-861%5D+Update+locationmap+docs+for+working+with+remote+files"></a>
+<h2 class="underlined_10">[FOR-861] Update locationmap docs for working with remote
files</h2>
+<div class="section">
+<p>
+<a href="http://issues.apache.org/jira/browse/FOR-861">http://issues.apache.org/jira/browse/FOR-861</a>
+</p>
+<p>The docs for retrieving content from remote locations [1] have not kept up with
Tims wonderful naming conventions for the locationmap [2]
+&lt;br/&gt;
+
+&lt;br/&gt;
+We need to update the docs to reflect the situation described in [3] (don't miss the correction
in the next message)
+&lt;br/&gt;
+
+&lt;br/&gt;
+[1] &lt;a href="http://forrest.apache.org/docs_0_80/locationmap.html#source-via-http"&gt;http://forrest.apache.org/docs_0_80/locationmap.html#source-via-http&lt;/a&gt;
+&lt;br/&gt;
+[2] &lt;a href="http://forrest.apache.org/docs_0_80/locationmap.html#namingConvention"&gt;http://forrest.apache.org/docs_0_80/locationmap.html#namingConvention&lt;/a&gt;
+&lt;br/&gt;
+[3] &lt;a href="http://marc.theaimsgroup.com/?t=114492612100001&amp;r=1&amp;w=2"&gt;http://marc.theaimsgroup.com/?t=114492612100001&amp;amp;r=1&amp;amp;w=2&lt;/a&gt;</p>
 </div>
 </div>
 <!--+

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



Mime
View raw message