forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 30842 - forrest/site
Date Wed, 28 Jul 2004 14:43:14 GMT
Author: crossley
Date: Wed Jul 28 07:43:14 2004
New Revision: 30842

Modified:
   forrest/site/faq.html
   forrest/site/faq.pdf
   forrest/site/faq.xml
Log:
Fix some pathnames.
Test commit of PDF as a binary file.


Modified: forrest/site/faq.html
==============================================================================
--- forrest/site/faq.html	(original)
+++ forrest/site/faq.html	Wed Jul 28 07:43:14 2004
@@ -525,7 +525,8 @@
   &lt;/about&gt;</pre>
 <p>
        In this case the menu labeled "About" will have 2 new items: 
-       "Full PDF" and "Full HTML".
+       "Full PDF" and "Full HTML". (See also
+       <a href="howto/howto-pdf-tab.html">How to create a PDF document for each tab</a>.)
        </p>
 <p>
          This assumes that you use the
@@ -533,7 +534,7 @@
          structure and navigation, rather than the old book.xml method.
        </p>
 </div>
-<a name="N10098"></a><a name="clickable-email-adress"></a>
+<a name="N1009C"></a><a name="clickable-email-adress"></a>
 <h5>2.2. How can I generate html-pages to show a 
       'clickable' email-address (of the author-element)?<span style="float: right"><a
href="#clickable-email-adress-menu">^</a></span>
 </h5>
@@ -543,7 +544,7 @@
        and edit the "headers/authors" template.
        </p>
 </div>
-<a name="N100A3"></a><a name="CVS_revison_tags"></a>
+<a name="N100A7"></a><a name="CVS_revison_tags"></a>
 <h5>2.3. How can I generate html-pages to show the
       revision tag of cvs?<span style="float: right"><a href="#CVS_revison_tags-menu">^</a></span>
 </h5>
@@ -556,7 +557,7 @@
 <p>This technique could also be used for a modification date with
       $Date: 2004/01/15 08:52:47 $</p>
 </div>
-<a name="N100B5"></a><a name="ignoring_javadocs"></a>
+<a name="N100B9"></a><a name="ignoring_javadocs"></a>
 <h5>2.4. 
         How do I stop Forrest breaking on links to external files that may not
         exist, like javadocs?
@@ -570,7 +571,7 @@
 <p>
           This means creating a directory <span class="codefrag">src/documentation/conf</span>
           (or wherever <span class="codefrag">${forrest.conf-dir}</span> points)
and copying
-          <span class="codefrag">$FORREST_HOME/WEB-INF/cli.xconf</span> to it.
 Then edit
+          <span class="codefrag">$FORREST_HOME/context/WEB-INF/cli.xconf</span>
to it.  Then edit
           cli.xconf, and add any exclude sections you require at the end.  The
           default cli.xconf ignores directory links and links containing
           'apidocs' or starting with 'api/':
@@ -598,7 +599,7 @@
         </div>
 </div>
 </div>
-<a name="N100E9"></a><a name="link_raw"></a>
+<a name="N100ED"></a><a name="link_raw"></a>
 <h5>2.5. How do I link to raw files such as config.txt and brochure.pdf?
       <span style="float: right"><a href="#link_raw-menu">^</a></span>
 </h5>
@@ -618,7 +619,7 @@
          <span class="codefrag">src/documentation/content/tools/</span> directory.
         </p>
 </div>
-<a name="N10103"></a><a name="claimed_patterns"></a>
+<a name="N10107"></a><a name="claimed_patterns"></a>
 <h5>2.6. Some of my files are not being processed because they use
       common filenames.
       <span style="float: right"><a href="#claimed_patterns-menu">^</a></span>
@@ -636,7 +637,7 @@
           In future versions of Forrest we will attempt to deal with this issue.
         </p>
 </div>
-<a name="N10111"></a><a name="build_msg_a"></a>
+<a name="N10115"></a><a name="build_msg_a"></a>
 <h5>2.7. What do the symbols and numbers mean when Forrest lists each
         document that it has built?
       <span style="float: right"><a href="#build_msg_a-menu">^</a></span>
@@ -658,7 +659,7 @@
          Column 4 is the page size.
         </p>
 </div>
-<a name="N1011D"></a><a name="pdf_images"></a>
+<a name="N10121"></a><a name="pdf_images"></a>
 <h5>2.8. Images don't display in PDFs. How do I fix this?<span style="float: right"><a
href="#pdf_images-menu">^</a></span>
 </h5>
 <div style="margin-left: 15 ; border: 2px">
@@ -680,7 +681,7 @@
 </li>
           
 <li>Unpack the Jimi distribution and copy JimiProClasses.zip to
-            <span class="codefrag">${forrest.home}/../../lib/optional/jimi-1.0.jar</span>.</li>
+            <span class="codefrag">$FORREST/lib/optional/jimi-1.0.jar</span>.</li>
         
 </ol>
 <p>Alternatively you can use JAI (Java Advanced Imaging API at 
@@ -693,10 +694,10 @@
 <div class="frame note">
 <div class="label">Note</div>
 <div class="content">Due to Sun's licensing, we cannot redistribute Jimi or JAI with
-          Forrest</div>
+          Forrest.</div>
 </div>
 </div>
-<a name="N10149"></a><a name="index.html"></a>
+<a name="N1014D"></a><a name="index.html"></a>
 <h5>2.9. 
         The tab link in my site incorrectly assumes that 'index.html' is present in
         the linked-to directory. How do I fix this?
@@ -720,7 +721,7 @@
     &lt;map:redirect-to uri="manual/Introduction.html"/&gt;
   &lt;/map:match&gt;</pre>
 </div>
-<a name="N10165"></a><a name="headless_operation"></a>
+<a name="N10169"></a><a name="headless_operation"></a>
 <h5>2.10. 
         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.
       <span style="float: right"><a href="#headless_operation-menu">^</a></span>
@@ -737,7 +738,7 @@
           <a class="external" href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html">Cocoon
FAQ</a>.
         </p>
 </div>
-<a name="N10181"></a><a name="catalog"></a>
+<a name="N10185"></a><a name="catalog"></a>
 <h5>2.11. 
         How do i configure my favourite XML editor or parser to find the
         local Forrest DTDs?
@@ -750,7 +751,7 @@
           local DTDs</a>.
         </p>
 </div>
-<a name="N1018D"></a><a name="xsp"></a>
+<a name="N10191"></a><a name="xsp"></a>
 <h5>2.12. How do I enable XSP processing?<span style="float: right"><a href="#xsp-menu">^</a></span>
 </h5>
 <div style="margin-left: 15 ; border: 2px">
@@ -762,12 +763,13 @@
           
 <li>Download 
           <a class="external" href="http://cvs.apache.org/viewcvs.cgi/*checkout*/cocoon-2.1/lib/optional/jdtcore-2.1.0.jar?rev=1.1&content-type=application/java">jdtcore-2.1.0.jar</a>,
-            and copy it to the $FORREST_HOME/WEB-INF/lib directory (or lib/core/ directory
in the source
+            and copy it to the $FORREST_HOME/context/WEB-INF/lib directory
+            (or lib/core/ directory in the source
             distribution).</li>
           
 <li>
 <p>Override sitemap.xmap in your local project (copy $FORREST_HOME/context/sitemap.xmap
to
-              src/documentation/conf/), and add the following generator definition in the
map:generators section:</p>
+              src/documentation/), and add the following generator definition in the map:generators
section:</p>
             
 <pre class="code">
   &lt;map:generator name="serverpages"
@@ -792,9 +794,9 @@
         
 </ol>
 <p>See also the 
-        <a class="external" href="http://wiki.cocoondev.org/Wiki.jsp?page=AddingXSPToForrest">AddingXSPToForrest</a>
Wiki page.</p>
+        <a class="external" href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a>
Wiki page.</p>
 </div>
-<a name="N101C2"></a><a name="breadcrumbs"></a>
+<a name="N101C6"></a><a name="breadcrumbs"></a>
 <h5>2.13. How do breadcrumbs work?  Why don't they work locally?<span style="float:
right"><a href="#breadcrumbs-menu">^</a></span>
 </h5>
 <div style="margin-left: 15 ; border: 2px">
@@ -815,10 +817,10 @@
       </p>
 </div>
 </div>
-<a name="N101D7"></a><a name="old_faqs"></a>
+<a name="N101DB"></a><a name="old_faqs"></a>
 <h4>3. Older versions</h4>
 <div style="margin-left: 0 ; border: 2px">
-<a name="N101DB"></a><a name="unresolved_project.home"></a>
+<a name="N101DF"></a><a name="unresolved_project.home"></a>
 <h5>3.1. When invoking Forrest 0.4 from the
         forrest.antproxy.xml, the build fails because
         ${project.home} isn't resolved.
@@ -838,7 +840,7 @@
        &lt;classpath refid="forrest-classpath"/&gt;
        &lt;jvmarg value="-Dforrest.home=${forrest.home}"/&gt;</pre>
 </div>
-<a name="N101F0"></a><a name="odd_html"></a>
+<a name="N101F4"></a><a name="odd_html"></a>
 <h5>3.2. 
         After upgrading to 0.4 my HTML looks significantly different, and table
         widths are wrong. What happened?
@@ -859,7 +861,7 @@
 <pre class="code">
   &lt;doctype-system&gt;http://www.w3.org/TR/html4/loose.dtd&lt;/doctype-system&gt;</pre>
 </div>
-<a name="N10206"></a><a name="validation_error-doctype_root_null"></a>
+<a name="N1020A"></a><a name="validation_error-doctype_root_null"></a>
 <h5>3.3. 
         When building my project, I get an validation error: Document root
           element "site", must match DOCTYPE root "null"..
@@ -880,7 +882,7 @@
           listed to prevent an attempt at DTD-based validation.
         </p>
 </div>
-<a name="N10223"></a><a name="building_error-custom_sitemap"></a>
+<a name="N10227"></a><a name="building_error-custom_sitemap"></a>
 <h5>3.4. 
         When building my project, I get any of these errors: 
 	menu.xmap (The system cannot find the file specified)
@@ -895,10 +897,10 @@
         </p>
 </div>
 </div>
-<a name="N10238"></a><a name="general"></a>
+<a name="N1023C"></a><a name="general"></a>
 <h4>4. General</h4>
 <div style="margin-left: 0 ; border: 2px">
-<a name="N1023C"></a><a name="generating_menus"></a>
+<a name="N10240"></a><a name="generating_menus"></a>
 <h5>4.1. What is the relationship between site.xml and
         book.xml?
       <span style="float: right"><a href="#generating_menus-menu">^</a></span>
@@ -915,7 +917,7 @@
           See <a href="docs/linking.html">Menus and Linking</a>.
       </p>
 </div>
-<a name="N10257"></a><a name="docbook"></a>
+<a name="N1025B"></a><a name="docbook"></a>
 <h5>4.2. 
         How do I use DocBook as the xml documentation format?
       <span style="float: right"><a href="#docbook-menu">^</a></span>
@@ -961,7 +963,7 @@
          for configuration guidance.
         </p>
 </div>
-<a name="N10274"></a><a name="version"></a>
+<a name="N10278"></a><a name="version"></a>
 <h5>4.3. 
         How to report which version of Forrest is being used and the
         properties that are set?
@@ -978,7 +980,7 @@
           Doing <span class="codefrag">'forrest -v'</span> will provide verbose
build messages.
         </p>
 </div>
-<a name="N10288"></a><a name="logs"></a>
+<a name="N1028C"></a><a name="logs"></a>
 <h5>4.4. 
         Where are the log files to find more infomation about errors?
       <span style="float: right"><a href="#logs-menu">^</a></span>
@@ -1005,7 +1007,7 @@
           to the standard output.
         </p>
 </div>
-<a name="N102AC"></a><a name="how_can_I_help"></a>
+<a name="N102B0"></a><a name="how_can_I_help"></a>
 <h5>4.5. 
         How can I help?
       <span style="float: right"><a href="#how_can_I_help-menu">^</a></span>

Modified: forrest/site/faq.pdf
==============================================================================
Binary files. No diff available.

Modified: forrest/site/faq.xml
==============================================================================
--- forrest/site/faq.xml	(original)
+++ forrest/site/faq.xml	Wed Jul 28 07:43:14 2004
@@ -91,7 +91,8 @@
   &lt;/about&gt;</source>
        <p>
        In this case the menu labeled "About" will have 2 new items: 
-       "Full PDF" and "Full HTML".
+       "Full PDF" and "Full HTML". (See also
+       <link href="site:howto/pdf-tab">How to create a PDF document for each tab</link>.)
        </p>
        <p>
          This assumes that you use the
@@ -124,7 +125,7 @@
         <p>
           This means creating a directory <code>src/documentation/conf</code>
           (or wherever <code>${forrest.conf-dir}</code> points) and copying
-          <code>$FORREST_HOME/WEB-INF/cli.xconf</code> to it.  Then edit
+          <code>$FORREST_HOME/context/WEB-INF/cli.xconf</code> to it.  Then edit
           cli.xconf, and add any exclude sections you require at the end.  The
           default cli.xconf ignores directory links and links containing
           'apidocs' or starting with 'api/':
@@ -210,7 +211,7 @@
           <li>Download Jimi from
            <link href="http://java.sun.com/products/jimi/">http://java.sun.com/products/jimi/</link></li>
           <li>Unpack the Jimi distribution and copy JimiProClasses.zip to
-            <code>${forrest.home}/../../lib/optional/jimi-1.0.jar</code>.</li>
+            <code>$FORREST/lib/optional/jimi-1.0.jar</code>.</li>
         </ol>
         <p>Alternatively you can use JAI (Java Advanced Imaging API at 
 	  http://java.sun.com/products/java-media/jai). For more
@@ -219,7 +220,7 @@
           Packages</link>
         </p>
         <note>Due to Sun's licensing, we cannot redistribute Jimi or JAI with
-          Forrest</note>
+          Forrest.</note>
       </section><section id="index.html"><title>2.9. 
         The tab link in my site incorrectly assumes that 'index.html' is present in
         the linked-to directory. How do I fix this?
@@ -270,10 +271,11 @@
         <ol>
           <li>Download 
           <link href="http://cvs.apache.org/viewcvs.cgi/*checkout*/cocoon-2.1/lib/optional/jdtcore-2.1.0.jar?rev=1.1&amp;content-type=application/java">jdtcore-2.1.0.jar</link>,
-            and copy it to the $FORREST_HOME/WEB-INF/lib directory (or lib/core/ directory
in the source
+            and copy it to the $FORREST_HOME/context/WEB-INF/lib directory
+            (or lib/core/ directory in the source
             distribution).</li>
           <li><p>Override sitemap.xmap in your local project (copy $FORREST_HOME/context/sitemap.xmap
to
-              src/documentation/conf/), and add the following generator definition in the
map:generators section:</p>
+              src/documentation/), and add the following generator definition in the map:generators
section:</p>
             <source xml:space="preserve">
   &lt;map:generator name="serverpages"
      pool-grow="2" pool-max="32" pool-min="4"
@@ -290,7 +292,7 @@
           </li>
         </ol>
         <p>See also the 
-        <link href="http://wiki.cocoondev.org/Wiki.jsp?page=AddingXSPToForrest">AddingXSPToForrest</link>
Wiki page.</p>
+        <link href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</link>
Wiki page.</p>
       </section><section id="breadcrumbs"><title>2.13. How do breadcrumbs
work?  Why don't they work locally?</title>
       <p>Breadcrumbs begin with up to three URLs specified in
       <code>skinconf.xml</code>.  Here is what the Forrest site uses:</p>

Mime
View raw message