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 Wed, 17 Sep 2003 03:12:48 GMT
crossley    2003/09/16 20:12:48

  Modified:    targets/forrest faq.html faq.pdf
  Log:
  Link to "upgrading 05" document from FAQ.
  
  Revision  Changes    Path
  1.25      +97 -43    xml-site/targets/forrest/faq.html
  
  Index: faq.html
  ===================================================================
  RCS file: /home/cvs/xml-site/targets/forrest/faq.html,v
  retrieving revision 1.24
  retrieving revision 1.25
  diff -u -r1.24 -r1.25
  --- faq.html	15 Sep 2003 07:22:44 -0000	1.24
  +++ faq.html	17 Sep 2003 03:12:48 -0000	1.25
  @@ -67,7 +67,7 @@
   </td><td width="6"><img alt="" height="8" width="6" src="skin/images/spacer.gif"></td><td
valign="bottom">
   <table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
   <tr>
  -<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt=""
src="skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a
class="base-not-selected" href="community/howto/index.html">Samples</a></td><td
valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-right.gif"></td>
  +<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt=""
src="skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a
class="base-not-selected" href="community/howto/index.html">How-to</a></td><td
valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-right.gif"></td>
   </tr>
   <tr>
   <td colspan="3" height="1"></td>
  @@ -351,6 +351,18 @@
   <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>
  +</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>
  +</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>
  +</li>
  +<li>
   <a name="ignoring_javadocs-menu"></a><a href="#ignoring_javadocs">
           How do I stop Forrest breaking on links to external files that may not
           exist, like javadocs?
  @@ -366,7 +378,7 @@
         </a>
   </li>
   <li>
  -<a name="pdf_images-menu"></a><a href="#pdf_images">Image don't display
in PDFs. How do I fix this?</a>
  +<a name="pdf_images-menu"></a><a href="#pdf_images">Images don't display
in PDFs. How do I fix this?</a>
   </li>
   <li>
   <a name="index.html-menu"></a><a href="#index.html">
  @@ -401,13 +413,13 @@
         </a>
   </li>
   <li>
  -<a name="validation_error:doctype_root_null-menu"></a><a href="#validation_error:doctype_root_null">
  +<a name="validation_error-doctype_root_null-menu"></a><a href="#validation_error-doctype_root_null">
           When building my project, I get an validation error: <span class="codefrag">Document
root
             element "site", must match DOCTYPE root "null".</span>.
         </a>
   </li>
   <li>
  -<a name="building_error:custom_sitemap-menu"></a><a href="#building_error:custom_sitemap">
  +<a name="building_error-custom_sitemap-menu"></a><a href="#building_error-custom_sitemap">
           When building my project, I get any of these errors: 
   	<span class="codefrag">menu.xmap (The system cannot find the file specified)</span>
   	<span class="codefrag">static.xmap (The system cannot find the file specified)</span>
  @@ -440,13 +452,13 @@
   </li>
   </ol>
   </div>
  -<a name="N10095"></a><a name="Answers"></a>
  +<a name="N100A4"></a><a name="Answers"></a>
   <h3>Answers</h3>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N10099"></a><a name="getting_started"></a>
  +<a name="N100A8"></a><a name="getting_started"></a>
   <h4>1. Building Forrest</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N1009D"></a><a name="checked_out_now_what"></a>
  +<a name="N100AC"></a><a name="checked_out_now_what"></a>
   <h5>1.1. 
           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>
  @@ -465,7 +477,7 @@
             further step-by-step assistance in getting started with Forrest for your project.
           </p>
   </div>
  -<a name="N100BB"></a><a name="cygwin_mutex_error"></a>
  +<a name="N100CA"></a><a name="cygwin_mutex_error"></a>
   <h5>1.2. 
           When running ./build.sh in cygwin, I get an error:
           cygpath.exe: *** can't create title mutex, Win32 error 6. 
  @@ -478,11 +490,49 @@
           </p>
   </div>
   </div>
  -<a name="N100CD"></a><a name="technical"></a>
  +<a name="N100DC"></a><a name="technical"></a>
   <h4>2. Technical</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N100D1"></a><a name="ignoring_javadocs"></a>
  -<h5>2.1. 
  +<a name="N100E0"></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>
  +</h5>
  +<div style="margin-left: 15 ; border: 2px">
  +<p>
  +        &lt;about tab="home" label="Home" href=""&gt;
  + 	  ...
  +          &lt;all_site label="Full HTML" href="site.html"/&gt;    
  +          &lt;all_sitePDF label="Full PDF" href="site.pdf"/&gt;  
  +          ...
  +        &lt;/about&gt;
  +       In this case the menu labeled "About" will have 2 new items: 
  +       "Full PDF" and "Full HTML".
  +       </p>
  +</div>
  +<a name="N100E8"></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>
  +</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>
  +       and edit the "headers/authors" template.
  +       </p>
  +</div>
  +<a name="N100F3"></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>
  +</h5>
  +<div style="margin-left: 15 ; border: 2px">
  +<p>If you have:<span class="codefrag">&lt;version&gt;$Revision: 1.30
  +      $&lt;/version&gt;</span>The '1.30' will be extracted and
  +      displayed at the bottom of the page as "version 1.30". See for
  +      example the bottom of <a href="http://xml.apache.org/forrest/your-project.html">
  +      http://xml.apache.org/forrest/your-project.html</a>
  +</p>
  +</div>
  +<a name="N10101"></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?
         <span style="float: right"><a href="#ignoring_javadocs-menu">^</a></span>
  @@ -521,8 +571,8 @@
           </div>
   </div>
   </div>
  -<a name="N10102"></a><a name="link_raw"></a>
  -<h5>2.2. How do I link to raw files such as config.txt and brochure.pdf?
  +<a name="N10132"></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>
   <div style="margin-left: 15 ; border: 2px">
  @@ -534,8 +584,8 @@
             project for a demonstration of this ability.
           </p>
   </div>
  -<a name="N1010D"></a><a name="build_msg_a"></a>
  -<h5>2.3. What do the numbers in square brackets mean when Forrest lists
  +<a name="N1013D"></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?
         <span style="float: right"><a href="#build_msg_a-menu">^</a></span>
   </h5>
  @@ -552,18 +602,21 @@
            This is the number of links that were gathered from that page.
           </p>
   </div>
  -<a name="N1011A"></a><a name="pdf_images"></a>
  -<h5>2.4. Image don't display in PDFs. How do I fix this?<span style="float: right"><a
href="#pdf_images-menu">^</a></span>
  +<a name="N1014A"></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">
   <p>
  -          Forrest uses <a href="http://xml.apache.org/fop/">Apache FOP</a>
  -          for rendering images.  FOP cannot handle all image types natively, and
  -          requires third-party jars to be added.  For an overview, see <a href="http://xml.apache.org/fop/graphics.html">FOP
Graphics
  -            formats</a>
  +	  Forrest uses <a href="http://xml.apache.org/fop/">Apache FOP</a>
  +          for rendering PDFs.  FOP cannot handle all image types natively, and
  +          requires third-party jars to be added. FOP natively handles BMP, GIF,
  +	  JPG, TIFF and EPS (with a few limitations). FOP can also handle SVG
  +	  (via Batik!and PNG (see below). For details, see 
  +	  <a href="http://xml.apache.org/fop/graphics.html">FOP Graphics
  +          formats</a>
           
   </p>
  -<p>Specifically, to get PNGs working in PDFs with Jimi:</p>
  +<p>To get PNGs working in PDFs with Jimi:</p>
   <ol>
             
   <li>Download Jimi from <a href="http://java.sun.com/products/jimi/">http://java.sun.com/products/jimi/</a>
  @@ -577,9 +630,10 @@
   <li>Rebuild Forrest (if you used the lib/core/ option above).</li>
           
   </ol>
  -<p>Alternative you can use JAI (Java Advanced Imaging API). For more
  +<p>Alternatively you can use JAI (Java Advanced Imaging API at 
  +	  http://java.sun.com/products/java-media/jai). For more
             info, see <a href="http://xml.apache.org/fop/graphics.html#packages">FOP
Graphics 
  -            Packages</a>
  +          Packages</a>
           
   </p>
   <div class="frame note">
  @@ -588,8 +642,8 @@
             Forrest</div>
   </div>
   </div>
  -<a name="N1014C"></a><a name="index.html"></a>
  -<h5>2.5. 
  +<a name="N1017C"></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?
         <span style="float: right"><a href="#index.html-menu">^</a></span>
  @@ -613,8 +667,8 @@
             &lt;/map:match&gt;
             </pre>
   </div>
  -<a name="N1016A"></a><a name="headless_operation"></a>
  -<h5>2.6. 
  +<a name="N1019A"></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>
   </h5>
  @@ -626,8 +680,8 @@
           </p>
   <pre class="code">forrest -Dforrest.jvmargs=-Djava.awt.headless=true site</pre>
   </div>
  -<a name="N10180"></a><a name="xsp"></a>
  -<h5>2.7. How do I enable XSP processing?<span style="float: right"><a href="#xsp-menu">^</a></span>
  +<a name="N101B0"></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">
   <p>First consider whether your needs would be better met by Cocoon itself, rather
than Forrest.  Forrest was
  @@ -670,10 +724,10 @@
   <p>See also the <a href="http://wiki.cocoondev.org/Wiki.jsp?page=AddingXSPToForrest">AddingXSPToForrest</a>
Wiki page.</p>
   </div>
   </div>
  -<a name="N101B7"></a><a name="old_faqs"></a>
  +<a name="N101E7"></a><a name="old_faqs"></a>
   <h4>3. Older versions</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N101BB"></a><a name="unresolved_project.home"></a>
  +<a name="N101EB"></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.
  @@ -693,7 +747,7 @@
          &lt;classpath refid="forrest-classpath"/&gt;
          &lt;jvmarg value="-Dforrest.home=${forrest.home}"/&gt;</pre>
   </div>
  -<a name="N101D1"></a><a name="odd_html"></a>
  +<a name="N10201"></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?
  @@ -713,11 +767,11 @@
             &lt;doctype-system&gt;http://www.w3.org/TR/html4/loose.dtd&lt;/doctype-system&gt;
             </pre>
   </div>
  -<a name="N101E4"></a><a name="validation_error:doctype_root_null"></a>
  +<a name="N10214"></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"..
  -      <span style="float: right"><a href="#validation_error:doctype_root_null-menu">^</a></span>
  +      <span style="float: right"><a href="#validation_error-doctype_root_null-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
   <p>
  @@ -734,25 +788,25 @@
             listed to prevent an attempt at DTD-based validation.
           </p>
   </div>
  -<a name="N10201"></a><a name="building_error:custom_sitemap"></a>
  +<a name="N10231"></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)
   	static.xmap (The system cannot find the file specified)
   	Type 'xml-document' is not defined for 'serialize'
  -      <span style="float: right"><a href="#building_error:custom_sitemap-menu">^</a></span>
  +      <span style="float: right"><a href="#building_error-custom_sitemap-menu">^</a></span>
   </h5>
   <div style="margin-left: 15 ; border: 2px">
   <p>
  -          You are using an old version of sitemap.xmap and need to upgrade it
  -	  manualy.
  +          You are using an old version of sitemap.xmap (see the document
  +          <a href="upgrading_05.html">Upgrading to Forrest 0.5</a>).
           </p>
   </div>
   </div>
  -<a name="N10212"></a><a name="general"></a>
  +<a name="N10246"></a><a name="general"></a>
   <h4>4. General</h4>
   <div style="margin-left: 0 ; border: 2px">
  -<a name="N10216"></a><a name="generating_menus"></a>
  +<a name="N1024A"></a><a name="generating_menus"></a>
   <h5>4.1. What is the relation between site.xml and
           book.xml?
         <span style="float: right"><a href="#generating_menus-menu">^</a></span>
  @@ -768,7 +822,7 @@
             <span class="codefrag">site.xml</span>-generated menus aren't appropriate.
         </p>
   </div>
  -<a name="N1022D"></a><a name="docbook"></a>
  +<a name="N10261"></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>
  @@ -806,7 +860,7 @@
            You can also have a mixture of "document-v*" DTD and DocBook.
           </p>
   </div>
  -<a name="N10244"></a><a name="how_can_I_help"></a>
  +<a name="N10278"></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.20      +563 -431  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