xml-general-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject cvs commit: xml-site/targets/forrest faq.html faq.pdf
Date Sat, 22 Nov 2003 06:14:56 GMT
crossley    2003/11/21 22:14:56

  Modified:    targets/forrest faq.html faq.pdf
  Log:
  Encourage them to read the "Using Forrest" document.
  Explain checkout CVS.
  Better explain "PDF whole site".
  Other minor text tidy-up.
  
  Revision  Changes    Path
  1.33      +100 -58   xml-site/targets/forrest/faq.html
  
  Index: faq.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/forrest/faq.html,v
  retrieving revision 1.32
  retrieving revision 1.33
  diff -u -r1.32 -r1.33
  --- faq.html	7 Nov 2003 05:43:01 -0000	1.32
  +++ faq.html	22 Nov 2003 06:14:56 -0000	1.33
  @@ -146,7 +146,7 @@
   </li>
       
   <li>
  -<a href="live-sites.html">Live sites</a>
  +<a href="live-sites.html">Example sites</a>
   </li>
     
   </ul>
  @@ -248,7 +248,7 @@
   </li>
       
   <li>
  -<a href="http://cvs.apache.org/viewcvs/xml-forrest/">CVS</a>
  +<a href="http://cvs.apache.org/viewcvs/xml-forrest/">Browse CVS</a>
   </li>
       
   <li>
  @@ -336,9 +336,19 @@
   <div style="margin-left: 0 ; border: 2px">
   <ol>
   <li>
  -<strong>Building Forrest</strong>
  +<strong>Getting Started and Building Forrest</strong>
   <ul>
   <li>
  +<a name="overview-menu"></a><a href="#overview">
  +        Where can i read an overview about how to work with Forrest?
  +      </a>
  +</li>
  +<li>
  +<a name="cvs-menu"></a><a href="#cvs">
  +        I would rather use CVS so that i can keep up-to-date. How?
  +      </a>
  +</li>
  +<li>
   <a name="checked_out_now_what-menu"></a><a href="#checked_out_now_what">
           I have checked out a working copy of <span class="codefrag">xml-forrest</span>
CVS, now what?
         </a>
  @@ -361,16 +371,16 @@
   <strong>Technical</strong>
   <ul>
   <li>
  -<a name="PDF-output-menu"></a><a href="#PDF-output">How can I get at
it to generate one pdf-file out of
  -      the whole site or selected pages of the site ?</a>
  +<a name="PDF-output-menu"></a><a href="#PDF-output">How can I generate
one pdf-file out of
  +      the whole site or selected pages of the site?</a>
   </li>
   <li>
  -<a name="clickable-email-adress-menu"></a><a href="#clickable-email-adress">How
can I get at it that generated html-pages show a 
  -      'clickable' email-adress (of the author-element)</a>
  +<a name="clickable-email-adress-menu"></a><a href="#clickable-email-adress">How
can I generate html-pages show a 
  +      'clickable' email-address (of the author-element)?</a>
   </li>
   <li>
  -<a name="CVS_revison_tags-menu"></a><a href="#CVS_revison_tags">How can
I get at it that generated html-pages show the
  -      revision tag of cvs ? </a>
  +<a name="CVS_revison_tags-menu"></a><a href="#CVS_revison_tags">How can
I generate html-pages show the
  +      revision tag of cvs?</a>
   </li>
   <li>
   <a name="ignoring_javadocs-menu"></a><a href="#ignoring_javadocs">
  @@ -383,8 +393,8 @@
         </a>
   </li>
   <li>
  -<a name="build_msg_a-menu"></a><a href="#build_msg_a">What do the numbers
in square brackets mean when Forrest lists
  -        each document that it has built?
  +<a name="build_msg_a-menu"></a><a href="#build_msg_a">What do the symbols
and numbers mean when Forrest lists each
  +        document that it has built?
         </a>
   </li>
   <li>
  @@ -443,7 +453,7 @@
   <strong>General</strong>
   <ul>
   <li>
  -<a name="generating_menus-menu"></a><a href="#generating_menus">What
is the relation between <span class="codefrag">site.xml</span> and
  +<a name="generating_menus-menu"></a><a href="#generating_menus">What
is the relationship between <span class="codefrag">site.xml</span> and
           <span class="codefrag">book.xml</span>?
         </a>
   </li>
  @@ -462,14 +472,35 @@
   </li>
   </ol>
   </div>
  -<a name="N100A9"></a><a name="Answers"></a>
  +<a name="N100B3"></a><a name="Answers"></a>
   <h3>Answers</h3>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N100AD"></a><a name="getting_started"></a>
  -<h4>1. Building Forrest</h4>
  +<a name="N100B7"></a><a name="getting_started"></a>
  +<h4>1. Getting Started and Building Forrest</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N100B1"></a><a name="checked_out_now_what"></a>
  +<a name="N100BB"></a><a name="overview"></a>
   <h5>1.1. 
  +        Where can i read an overview about how to work with Forrest?
  +      <span style="float: right"><a href="#overview-menu">^</a></span>
  +</h5>
  +<div style="margin-left: 15 ; border: 2px">
  +<p>
  +          See the <a href="your-project.html">Using Forrest</a> guide.
  +        </p>
  +</div>
  +<a name="N100C7"></a><a name="cvs"></a>
  +<h5>1.2. 
  +        I would rather use CVS so that i can keep up-to-date. How?
  +      <span style="float: right"><a href="#cvs-menu">^</a></span>
  +</h5>
  +<div style="margin-left: 15 ; border: 2px">
  +<p>
  +          Follow these
  +          <a href="your-project.html#getting_from_source">Using Forrest</a>
notes.
  +        </p>
  +</div>
  +<a name="N100D3"></a><a name="checked_out_now_what"></a>
  +<h5>1.3. 
           I have checked out a working copy of xml-forrest CVS, now what?
         <span style="float: right"><a href="#checked_out_now_what-menu">^</a></span>
   </h5>
  @@ -487,8 +518,8 @@
             further step-by-step assistance in getting started with Forrest for your project.
           </p>
   </div>
  -<a name="N100CF"></a><a name="cygwin_mutex_error"></a>
  -<h5>1.2. 
  +<a name="N100F1"></a><a name="cygwin_mutex_error"></a>
  +<h5>1.4. 
           When running ./build.sh in cygwin, I get an error:
           cygpath.exe: *** can't create title mutex, Win32 error 6. 
         <span style="float: right"><a href="#cygwin_mutex_error-menu">^</a></span>
  @@ -496,11 +527,11 @@
   <div style="margin-left: 15 ; border: 2px">
   <p>
             This <a href="http://issues.cocoondev.org/jira//secure/ViewIssue.jspa?key=FOR-10">appears
  -            to be a bug in cygwin</a>.  Please use the .bat script instead.
  +            to be a bug in cygwin</a>. Please use the .bat script instead.
           </p>
   </div>
  -<a name="N100E1"></a><a name="maxmemory"></a>
  -<h5>1.3. 
  +<a name="N10103"></a><a name="maxmemory"></a>
  +<h5>1.5. 
           How can i specify the amount of memory to be used by Java?
         <span style="float: right"><a href="#maxmemory-menu">^</a></span>
   </h5>
  @@ -514,12 +545,12 @@
   </p>
   </div>
   </div>
  -<a name="N100F2"></a><a name="technical"></a>
  +<a name="N10114"></a><a name="technical"></a>
   <h4>2. Technical</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N100F6"></a><a name="PDF-output"></a>
  -<h5>2.1. How can I get at it to generate one pdf-file out of
  -      the whole site or selected pages of the site ?<span style="float: right"><a
href="#PDF-output-menu">^</a></span>
  +<a name="N10118"></a><a name="PDF-output"></a>
  +<h5>2.1. How can I generate one pdf-file out of
  +      the whole site or selected pages of the site?<span style="float: right"><a
href="#PDF-output-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
   <p>
  @@ -532,20 +563,25 @@
          In this case the menu labeled "About" will have 2 new items: 
          "Full PDF" and "Full HTML".
          </p>
  +<p>
  +         This assumes that you use the
  +         <a href="linking.html">site.xml</a> method for your site
  +         structure and navigation, rather than the old book.xml method.
  +       </p>
   </div>
  -<a name="N100FE"></a><a name="clickable-email-adress"></a>
  -<h5>2.2. How can I get at it that generated html-pages show a 
  -      'clickable' email-adress (of the author-element)<span style="float: right"><a
href="#clickable-email-adress-menu">^</a></span>
  +<a name="N10127"></a><a name="clickable-email-adress"></a>
  +<h5>2.2. How can I generate html-pages show a 
  +      'clickable' email-address (of the author-element)?<span style="float: right"><a
href="#clickable-email-adress-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
  -<p>You'd have to override <span class="codefrag">
  -       src/resources/skins/common/xslt/html/document2html.xsl,i</span>
  +<p>You would override <span class="codefrag">
  +       src/resources/skins/common/xslt/html/document2html.xsl</span>
          and edit the "headers/authors" template.
          </p>
   </div>
  -<a name="N10109"></a><a name="CVS_revison_tags"></a>
  -<h5>2.3. How can I get at it that generated html-pages show the
  -      revision tag of cvs ? <span style="float: right"><a href="#CVS_revison_tags-menu">^</a></span>
  +<a name="N10132"></a><a name="CVS_revison_tags"></a>
  +<h5>2.3. How can I generate html-pages show the
  +      revision tag of cvs?<span style="float: right"><a href="#CVS_revison_tags-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
   <p>If you have:<span class="codefrag">&lt;version&gt;$Revision: 1.30
  @@ -555,7 +591,7 @@
         http://xml.apache.org/forrest/your-project.html</a>
   </p>
   </div>
  -<a name="N10117"></a><a name="ignoring_javadocs"></a>
  +<a name="N10140"></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?
  @@ -595,7 +631,7 @@
           </div>
   </div>
   </div>
  -<a name="N10148"></a><a name="link_raw"></a>
  +<a name="N10171"></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>
  @@ -608,25 +644,30 @@
             project for a demonstration of this ability.
           </p>
   </div>
  -<a name="N10153"></a><a name="build_msg_a"></a>
  -<h5>2.6. What do the numbers in square brackets mean when Forrest lists
  -        each document that it has built?
  +<a name="N1017C"></a><a name="build_msg_a"></a>
  +<h5>2.6. 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>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
   <pre class="code">
  - * [37] index.html
  - * [0] images/project-logo.png
  - * [0] skin/images/printer.gif
  - * [32] components/index.html
  - * [31] components/resolver/index.html
  +* [56/0]     6.281s 23.0Kb  index.html
  +* [0/0]      0.0060s 4.0Kb   images/project-logo.gif
  +^ site:bugs
  +* [50/0]     1.582s 18.7Kb  todo.html
  +X [0]                       brokenlink.html     BROKEN: reason
  +* [50/0]     1.222s 20.2Kb  dreams.html
  +* [0/0]      0.535s 11.1Kb  dreams.pdf
   ...
             </pre>
   <p>
  -         This is the number of links that were gathered from that page.
  +         Column 1 is the page build status (*=okay X=brokenLink ^=pageSkipped).
  +         Column 2 is the number of links that were gathered from that page.
  +         Column 3 is the time taken.
  +         Column 4 is the page size.
           </p>
   </div>
  -<a name="N10160"></a><a name="pdf_images"></a>
  +<a name="N10189"></a><a name="pdf_images"></a>
   <h5>2.7. 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">
  @@ -666,7 +707,7 @@
             Forrest</div>
   </div>
   </div>
  -<a name="N10192"></a><a name="index.html"></a>
  +<a name="N101BB"></a><a name="index.html"></a>
   <h5>2.8. 
           The tab link in my site incorrectly assumes that 'index.html' is present in
           the linked-to directory. How do I fix this?
  @@ -691,7 +732,7 @@
             &lt;/map:match&gt;
             </pre>
   </div>
  -<a name="N101B0"></a><a name="headless_operation"></a>
  +<a name="N101D9"></a><a name="headless_operation"></a>
   <h5>2.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.
         <span style="float: right"><a href="#headless_operation-menu">^</a></span>
  @@ -704,7 +745,7 @@
           </p>
   <pre class="code">forrest -Dforrest.jvmargs=-Djava.awt.headless=true site</pre>
   </div>
  -<a name="N101C6"></a><a name="xsp"></a>
  +<a name="N101EF"></a><a name="xsp"></a>
   <h5>2.10. How do I enable XSP processing?<span style="float: right"><a href="#xsp-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
  @@ -748,10 +789,10 @@
   <p>See also the <a href="http://wiki.cocoondev.org/Wiki.jsp?page=AddingXSPToForrest">AddingXSPToForrest</a>
Wiki page.</p>
   </div>
   </div>
  -<a name="N101FD"></a><a name="old_faqs"></a>
  +<a name="N10226"></a><a name="old_faqs"></a>
   <h4>3. Older versions</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N10201"></a><a name="unresolved_project.home"></a>
  +<a name="N1022A"></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.
  @@ -771,7 +812,7 @@
          &lt;classpath refid="forrest-classpath"/&gt;
          &lt;jvmarg value="-Dforrest.home=${forrest.home}"/&gt;</pre>
   </div>
  -<a name="N10217"></a><a name="odd_html"></a>
  +<a name="N10240"></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?
  @@ -791,7 +832,7 @@
             &lt;doctype-system&gt;http://www.w3.org/TR/html4/loose.dtd&lt;/doctype-system&gt;
             </pre>
   </div>
  -<a name="N1022A"></a><a name="validation_error-doctype_root_null"></a>
  +<a name="N10253"></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"..
  @@ -812,7 +853,7 @@
             listed to prevent an attempt at DTD-based validation.
           </p>
   </div>
  -<a name="N10247"></a><a name="building_error-custom_sitemap"></a>
  +<a name="N10270"></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)
  @@ -827,11 +868,11 @@
           </p>
   </div>
   </div>
  -<a name="N1025C"></a><a name="general"></a>
  +<a name="N10285"></a><a name="general"></a>
   <h4>4. General</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N10260"></a><a name="generating_menus"></a>
  -<h5>4.1. What is the relation between site.xml and
  +<a name="N10289"></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>
   </h5>
  @@ -844,9 +885,10 @@
             preserved.  If a directory has a book.xml file, the book.xml will be
             used to generate the menu.  This is useful in situations where
             <span class="codefrag">site.xml</span>-generated menus aren't appropriate.
  +          See <a href="linking.html">Menus and Linking</a>.
         </p>
   </div>
  -<a name="N10277"></a><a name="docbook"></a>
  +<a name="N102A4"></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>
  @@ -891,7 +933,7 @@
            for configuration guidance.
           </p>
   </div>
  -<a name="N10295"></a><a name="how_can_I_help"></a>
  +<a name="N102C2"></a><a name="how_can_I_help"></a>
   <h5>4.3. 
           How can I help?
         <span style="float: right"><a href="#how_can_I_help-menu">^</a></span>
  
  
  
  1.27      +622 -508  xml-site/targets/forrest/faq.pdf
  
  	<<Binary file>>
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org


Mime
View raw message