Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 62892 invoked from network); 6 May 2005 03:55:04 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 6 May 2005 03:55:04 -0000 Received: (qmail 10623 invoked by uid 500); 6 May 2005 03:57:32 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 10564 invoked by uid 500); 6 May 2005 03:57:30 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Forrest Developers List" Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 10461 invoked by uid 99); 6 May 2005 03:57:29 -0000 X-ASF-Spam-Status: No, hits=0.2 required=10.0 tests=NO_REAL_NAME X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Thu, 05 May 2005 20:57:24 -0700 Received: (qmail 62753 invoked by uid 65534); 6 May 2005 03:54:51 -0000 Message-ID: <20050506035451.62751.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Subject: svn commit: r168512 [2/5] - /forrest/site/0.6 /forrest/site/0.7 /forrest/site/0.7/docs /forrest/site/0.7/docs/howto /forrest/site/0.7/docs/plugins /forrest/site/0.7/skin /forrest/site/0.7/skin/images Date: Fri, 06 May 2005 03:54:35 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.0-dev X-Virus-Checked: Checked X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Modified: forrest/site/0.7/docs/faq.html URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/faq.html?rev=3D168= 512&r1=3D168511&r2=3D168512&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- forrest/site/0.7/docs/faq.html (original) +++ forrest/site/0.7/docs/faq.html Thu May 5 20:54:30 2005 @@ -294,40 +294,26 @@ 1. Getting Started and Building Forrest @@ -338,36 +324,40 @@ 2.1. What tools can be used to edit the content?=
  • -2.2. How can I generate one pdf-file out of - the whole site or selected pages of the site? +2.2. How can I generate one pdf-file out of the wh= ole site or selected pages of the site?
  • 2.3. How do I insert page breaks into documents?
  • -2.4. How can I generate html-pages to= show a=20 - 'clickable' email-address (of the author-element)? +2.4. How can I generate html-pages to= show a 'clickable' email-address (of the + author-element)?
  • -2.5. How do I link to raw files such as config.txt a= nd brochure.pdf? - +2.5. How do I link to raw files such as config.txt a= nd brochure.pdf?
  • 2.6. Images don't display in PDFs. How do I fix th= is?
  • -2.7.=20 - The tab link in my site incorrectly assumes that 'index.html' is p= resent in - the linked-to directory. How do I fix this? - +2.7. The tab link in my site incorrectly assumes = that 'index.html' is present in the + linked-to directory. How do I fix this?
  • -2.8.=20 - How to use special characters in the labels of the site.xml file? - +2.8. How can I change the default file name = that Forrest will look for when I request a + URL like http://myserver or http://myserver/mydir/?
  • -2.9. Does Forrest handle accents for non-English lan= guages? +2.9. How can I use a start-up-page other th= an index.html? +
    • +
  • +2.10. How to use special characters in the labe= ls of the site.xml file? +
    • +
  • +2.11. Does Forrest handle accents for non-English la= nguages? +
    • +
  • +2.12. How can I make Forrest properly clean up the= build/site-directory?
    • @@ -375,56 +365,43 @@ 3. Technical -

    This is because sources for Forrest docs are xml documents, which can i= nclude any of these, - provided the encoding declared by the xml doc matches the actual= encoding used in the file. - For example if you declare the default encoding:

    +

    This is because sources for Forrest docs are xml documents, which can i= nclude any of + these, provided the encoding declared by the xml doc matches the= actual encoding used in + the file. For example if you declare the default encoding:

    <?xml version=3D"1.0" encoding=3D"UTF-8"?>
    -

    but the file content is actually using ISO-8859-1 then you will - receive validation errors, especially if=20 - you include some non-ASCII characters.

    -

    - This situation is commonly encountered when you edit the templat= es - created by forrest seed with you= r favorite=20 - (probably localized) editor without paying attention to the enco= ding, - or when you create a new file=20 - and simply copy the headers from another file. -

    -

    Although UTF-8 is an encoding well-suited for most languages, - it is not usually the default in popular editors or systems. - In UNIX-like systems, most popular editors can handle different = encodings to=20 - write the file in disk. With some editors the encoding of the fi= le is preserved, while with others the default - is used regardless of the original encoding. In most cases the e= ncoding used to write files - can be controlled by setting the environment variable LANG - to an appropriate value, for instance: -

    +

    but the file content is actually using ISO-8859-1 then you will receive= validation + errors, especially if you include some non-ASCII characters.

    +

    This situation is commonly encountered when you edit the templates cre= ated by + forrest seed with your favorit= e (probably localized) editor without paying + attention to the encoding, or when you create a new file and sim= ply copy the headers from + another file.

    +

    Although UTF-8 is an encoding well-suited for most languages, it is not= usually the + default in popular editors or systems. In UNIX-like systems, mos= t popular editors can + handle different encodings to write the file in disk. With some = editors the encoding of + the file is preserved, while with others the default is used reg= ardless of the original + encoding. In most cases the encoding used to write files can be = controlled by setting the + environment variable LANG to an = appropriate value, for instance: 

    [localhost]$ export LANG=3Den_US.UTF-8
    -

    Of course the appropriate way to set the encoding depends on t= he editor/OS,=20 - but ultimately relys on the user preferences. So you can use the= encoding you prefer, as long as=20 - the encoding attribute of the xm= l declaration matches the actual encoding of the file.=20 - This means=20 - that if you are not willing to abandon ISO-8859-1 you can always= use the following declaration instead:

    +

    Of course the appropriate way to set the encoding depends on t= he editor/OS, but + ultimately relys on the user preferences. So you can use the enc= oding you prefer, as long + as the encoding attribute of the= xml declaration matches the actual encoding + of the file. This means that if you are not willing to abandon I= SO-8859-1 you can always + use the following declaration instead:

    <?xml version=3D"1.0" encoding=3D"ISO-8859-1"?><=
/pre>
-
    Another option is to use "character entities" such as
-        &ouml; (ö) or the numeric=
 form
-        &#246; (ö).
-        
    
-
    Another related issue is that your webserver needs to send http
-          headers with the matching charset definitions to the html page.
-        
    
-
    Here are some references which explain further:
-          GT2=
004 presentation by Torsten Schlabach and=20
-          Alan Wood's Unicode=
 resources.
-        
    
+
    Another option is to use "character entities" such as &ouml;
+          (ö) or the numeric form &#246;=
 (ö). 
    
+
    Another related issue is that your webserver needs to send http headers=
 with the matching
+          charset definitions to the html page. 
    
+
    Here are some references which explain further: GT2004 presentation by Torsten
+            Schlabach and Alan Wood's Unicode
+            resources. 
    
+
+
+
    2.12.  How can I make Forrest properly clean up the buil=
d/site-directory? 
    
+
    
+^
+
    
+
    
+
    Forrest for performance reasons doesn't clean out the build/site-direct=
ory each time you
+          compile your project. This usually doesn't matter during develop=
ment but might become a
+          problem in a production environment.
    
+
    To ensure a clean build call 'forrest clean site' instead of just 'forr=
est' so Forrest
+          will delete all build directories before creating new content. <=
/p>
 
    
-
+
 
    3. Technical
    
-
-
    3.1. I'm behind a proxy and it's preventing Plugins from=20
-      being downloaded, what should I do?
    
+
+
    3.1. I'm behind a proxy and it's preventing Plugins from=
 being downloaded, what should I
+        do?
    
 
    
 ^
 
    
 
    
-
    You can configure the proxy in the forrest.pro=
perties
-        file. Set the proxy.host and proxy.port
-        accordingly (the port will default to port 80).
    
-
    
-
-
    3.2. How can I generate html-pages to show the
-      revision tag of cvs?
    
+
    You can configure the proxy in the forrest.pro=
perties file. Set the
+            proxy.host and proxy.port accordingly (the port will default
+          to port 80).
    
+
+
+
    3.2. How can I generate html-pages to show the revision =
tag of cvs?
    
 
    
 ^
 
    
 
    
 
    If you have:<version>$Revision: 1.30
-      $</version>The '1.30' will be extracted and
-      displayed at the bottom of the page as "version 1.30". See for
-      example the bottom of the
-       Using Forrest document.
-
    This technique could also be used for a modification date with
-      $Date: 2004/01/15 08:52:47 $
    
-
    
-
-
    3.3.=20
-        How to control the processing of URIs by Cocoon, e.g. exclude
-        certain URIs, include other additional ones.
-      
    
+          $</version>The '1.30' will be extracted and
+          displayed at the bottom of the page as "version 1.30". See for e=
xample the
+          bottom of the  Using Forre=
st document.
    
+
    This technique could also be used for a modification date with $Date: 2=
004/01/15 08:52:47
+          $
    
+
+
+
    3.3.  How to control the processing of URIs by Cocoon, e=
.g. exclude certain URIs, include
+        other additional ones. 
    
 
    
 ^
 
    
 
    
-
    
-          Forrest uses a configuration file to control the processing
-          done by the Apache Cocoon command-line called cli.xconf
-        
    
-
    
-          Your project can supply its own cli.xco=
nf
-          and define patterns for URIs to exclude. There are also
-          other powerful configuration features.
-        
    
-
    
-          This means creating a directory src/doc=
umentation/conf
-          (or wherever ${forrest.conf-dir}=
 points) and copying
-          $FORREST_HOME/main/webapp/WEB-INF/cli.x=
conf to it.
-          Declare the location of this file in the forrest.properties
-          configuration, e.g.
-          project.configfile=3D${project.home}/sr=
c/documentation/conf/cli.xconf
+
     Forrest uses a configuration file to control the processing done by th=
e Apache Cocoon
+          command-line called cli.xconf 
    
+
     Your project can supply its own cli.xconf and define patterns for URIs to
+          exclude. There are also other powerful configuration features. <=
/p>
+
     This means creating a directory src/documenta=
tion/conf (or wherever
+            ${forrest.conf-dir} points) an=
d copying
+            $FORREST_HOME/main/webapp/WEB-INF/cli=
.xconf to it. Declare the location of
+          this file in the forrest.properties configuration, e.g.
+            project.configfile=3D${project.home}/=
src/documentation/conf/cli.xconf
        =20
 
    
-
    
-          Then edit
-          cli.xconf, and add any exclude sections that you require. The
-          default cli.xconf ignores directory links and links containing
-          'apidocs' or starting with 'api/':
-        
    
+
     Then edit cli.xconf, and add any exclude sections that you require. Th=
e default
+          cli.xconf ignores directory links and links containing 'apidocs'=
 or starting with 'api/': 
    
 
        ....
    <!-- Includes and excludes can be used to limit which URLs are rende=
red -->
@@ -930,60 +853,44 @@
    
    <uri src=3D"favicon.ico"/>
 </cocoon>
    
-
    This is just an example, and you should modify it appropriately for
-          your site.
    
+
    This is just an example, and you should modify it appropriately for you=
r site.
    
 
    
 
    Note
    
-
    
-          Wildcards may be used.  These are a powerful feature of Cocoon's
-          sitemap.
-          For example, foo/* would match
-          foo/bar, but not foo/bar/baz
-           — use foo/** to match that.
-        
    
+
     Wildcards may be used. These are a powerful featur=
e of Cocoon's sitemap. For example=
, foo/* would match
+            foo/bar, but not foo/bar/baz — use
+          foo/** to match that. 
    
 
    
 
    
-
-
    3.4.=20
-        How do I stop Forrest breaking on links to external files that may=
 not
-        exist, like javadocs?
-      
    
+
+
    3.4.  How do I stop Forrest breaking on links to externa=
l files that may not exist, like
+        javadocs? 
    
 
    
 ^
 
    
 
    
-
    
-          This can be done by overriding the=20
-          cli.xconf=

-          Cocoon config file, and defining patterns for URLs to exclude.
-        
    
+
     This can be done by overriding the 
+            cli.xconf
+           Cocoon config file, and defining patterns for URLs to exclu=
de. 
    
 
    
-
-
    3.5. Some of my files are not being processed because th=
ey use
-      common filenames.
-      
    
+
+
    3.5. Some of my files are not being processed because th=
ey use common filenames. 
    
 
    
 ^
 
    
 
    
-
    
-          Certain patterns are claimed by the default sitemaps for
-          special processing. These include:
-          site, changes, todo, faq, images, my-im=
ages, skinconf,
-          community, howto
+
     Certain patterns are claimed by the default sitemaps for special proce=
ssing. These
+          include: site, changes, todo, faq, imag=
es, my-images, skinconf, community,
+          howto
        =20
 
    
-
    
-          Sometimes there are workarounds, e.g. faq.html or faq-interview.=
html
-          would fail, but interview-faq.html would be fine.
-          In future versions of Forrest we will attempt to deal with this =
issue
-          (FOR-217<=
/a>).
+
     Sometimes there are workarounds, e.g. faq.html or faq-interview.html w=
ould fail, but
+          interview-faq.html would be fine. In future versions of Forrest =
we will attempt to deal
+          with this issue (FOR-217).
         
    
 
    
-
-
    3.6. What do the symbols and numbers mean when Forrest l=
ists each
-        document that it has built?
-      
    
+
+
    3.6. What do the symbols and numbers mean when Forrest l=
ists each document that it has
+        built? 
    
 
    
 ^
 
    
@@ -997,90 +904,64 @@
 * [50/0]     1.222s 20.2Kb  dreams.html
 * [0/0]      0.535s 11.1Kb  dreams.pdf
 =2E..
    -

    - Column 1 is the page build status (*=3Dokay X=3DbrokenLink ^=3Dpa= geSkipped). - 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. -

    - - -

    3.7.=20 - 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. -

    +

    Column 1 is the page build status (*=3Dokay X=3DbrokenLink ^=3DpageSki= pped). Column 2 is the + number of links that were gathered from that page. Column 3 is t= he time taken. Column 4 is + the page size.

    + + +

    3.7. When generating PNG images from SVG, I get an erro= r: Can't connect to X11 window + server using ':0.0' as the value of the DISPLAY variable.

    ^
    -

    - If you are using JDK 1.4.0 or newer, you can enable headless= - operation by running Forrest with the f= orrest.jvmarg - parameter set to -Djava.awt.headless=3D= true, like this: -

    +

    If you are using JDK 1.4.0 or newer, you can enable headless = operation by + running Forrest with the forrest.jvmarg= parameter set to + -Djava.awt.headless=3Dtrue, li= ke this: 

    forrest -Dforrest.jvmargs=3D-Djava.awt.headless=3Dtrue=
 site
    -

    - See also - Cocoon FAQ. -

    +

    See also Cocoon FAQ.

    - -

    3.8.=20 - How do i configure my favourite XML editor or parser to find the - local Forrest DTDs? -

    + +

    3.8. How do i configure my favourite XML editor or pars= er to find the local Forrest + DTDs?

    ^
    -

    - Notes are provided for various tools at - Using Catalog Entity Resolver f= or - local DTDs. -

    +

    Notes are provided for various tools at Using Catalog Entity + Resolver for local DTDs.

    - -

    3.9.=20 - How to make the site look better and change its skin? -

    + +

    3.9. How to make the site look better and change its sk= in?

    ^
    -

    - There are default skins provide= d, - which are configurable and so should meet the needs of most projec= ts. - The aim is to provide many capabilities so that extra skins are not - needed. -

    -

    - See notes about - configuration of t= he skins. - Some projects may have special needs and can define their - own skin. -

    +

    There are default skins provided, w= hich are configurable + and so should meet the needs of most projects. The aim is to pro= vide many capabilities so + that extra skins are not needed.

    +

    See notes about configurat= ion of the skins. + Some projects may have special needs and can define their own skin.

    - +

    3.10. How do I enable XSP processing?

    ^
    -

    First consider whether your needs would be better met by Cocoon itself,= rather than Forrest. -

    -

    That said, there are valid reasons for wanting programmatically generat= ed content, so here is how to enable - XSP:

    +

    First consider whether your needs would be better met by Cocoon itself,= rather than + Forrest.

    +

    That said, there are valid reasons for wanting programmatically generat= ed content, so + here is how to enable XSP:

      =20 -
    1. Download=20 - jdtcore-2.1.0.jar, - and copy it to the $FORREST_HOME/main/webapp/WEB-INF/lib direc= tory - (or lib/core/ directory in the source - distribution).
      2. +
    2. Download jdtcore-2.1.0.jar, and copy it to the $FORREST_HOME/main/webapp/WE= B-INF/lib + directory (or lib/core/ directory in the source distribution).=
      3. =20
    3. -

      - Add the following generator definition in the map:generators= section - of your project sit= emap + =20 +

      Add the following generator definition in the map:generators section o= f your project sitemap + =20

      =20 
      @@ -1091,7 +972,9 @@
      4. =20
    4. -

      Decide how you want to use XSP. For single files, you could just defin= e a *.xml matcher:

      + =20 +

      Decide how you want to use XSP. For single files, you could just define= a *.xml + matcher:

      =20 
       <map:match pattern=3D"dynamic.xml">
@@ -1100,127 +983,103 @@
   <map:serialize type=3D"xml"/>
 </map:match>
      =20 -

      You may instead wish to override forrest.xmap to define a general mappi= ng for XSPs.

      +

      You may instead wish to override forrest.xmap to define a general mappi= ng for + XSPs.

      =20
      5. =20
    -

    See also the=20 - Addin= gXSPToForrest Wiki page.

    +

    See also the AddingXSPToForrest Wiki page.

    - -

    3.11. How do breadcrumbs work? Why don't they work loca= lly?

    + +

    3.11. How do breadcrumbs work? Why don't they work local= ly?

    ^
    -

    Breadcrumbs begin with up to three URLs specified in - skinconf.xml. Here is what the Forr= est site uses:

    +

    Breadcrumbs begin with up to three URLs specified in skinconf.xml. Here is + what the Forrest site uses:

       <trail>
     <link1 name=3D"apache" href=3D"http://www.apache.org/"/>
     <link2 name=3D"xml.apache" href=3D"http://xml.apache.org/"/>
     <link3 name=3D"" href=3D""/>
   </trail>
    -

    If any links are blank, they are not used. After these first links, - JavaScript looks at the URL for the current page and - makes a link for each directory after the domain. If you are viewing - the site locally, there is no domain and so - there will be no extra breadcrumbs, only the ones that are specified - in skinconf.xml. -

    +

    If any links are blank, they are not used. After these first links, Jav= aScript looks at + the URL for the current page and makes a link for each directory= after the domain. If you + are viewing the site locally, there is no domain and so there wi= ll be no extra + breadcrumbs, only the ones that are specified in skinconf.xml.

    - +

    3.12. How do I make forrest run listen on a different po= rt?

    ^

    + =20 forrest run -Dforrest.jvmargs=3D"-Djetty.port=3D8= 0" + =20

    Or copy Forrest's main/webapp/jettyconf.xml file to your project's src/= documentation - directory and set the port number in that file. Then do forrest run - =20 + directory and set the port number in that file. Then do forrest run + =20

    - +

    4. Older version: 0.6

    - -

    4.1. Some of my files are not being processed because th= ey use - common filenames. -

    + +

    4.1. Some of my files are not being processed because th= ey use common filenames.

    ^
    -

    - Certain patterns are claimed by the default sitemaps for - special processing. These include: - site, changes, todo, faq, images, my-im= ages, skinconf, - community, howto +

    Certain patterns are claimed by the default sitemaps for special proce= ssing. These + include: site, changes, todo, faq, imag= es, my-images, skinconf, community, + howto =20

    -

    - Sometimes there are workarounds, e.g. faq.html or faq-interview.= html - would fail, but interview-faq.html would be fine. - In future versions of Forrest we will attempt to deal with this = issue - (FOR-217<= /a>). +

    Sometimes there are workarounds, e.g. faq.html or faq-interview.html w= ould fail, but + interview-faq.html would be fine. In future versions of Forrest = we will attempt to deal + with this issue (FOR-217).

    - +

    5. General

    - -

    5.1. What is the relationship between site.xml and - book.xml? -

    + +

    5.1. What is the relationship between site.xml and book.= xml?

    ^
    -

    - One site.xml file in your projec= t root can replace all the book.xml files - (one per directory) in your site. Internally, Forrest uses site.xml to - dynamically generate book.xml files. However, Forrest first che= cks - for the existence of a book.xml file, so backwards-compatibility= is - preserved. If a directory has a book.xml file, the book.xml wil= l be - used to generate the menu. This supplement is useful in situati= ons - where site.xml-generated menus a= ren't appropriate. - See Menus and Linking. -

    -
    - -

    5.2.=20 - How do I use DocBook as the xml documentation format? -

    +

    One site.xml file in your project root= can replace all the book.xml files (one per + directory) in your site. Internally, Forrest uses site.xml to dynamically generate book.xml + files. However, Forrest first checks for the existence of a book= .xml file, so + backwards-compatibility is preserved. If a directory has a book.= xml file, the book.xml + will be used to generate the menu. This supplement is useful in = situations where + site.xml-generated menus aren't = appropriate. See Menus and + Linking.

    + + +

    5.2. How do I use DocBook as the xml documentation form= at?

    ^
    -

    - There are two ways. Forrest has a simpli= fied-docbook plugin - which can transform the DocBook format into the - Forrest "xdocs" format on-the-fly and then render that as normal - Forrest documents. - Be aware that the stylesheet that does this transformation is - deliberately very limited and does not attempt to deal with all - DocBook elements. -

    -

    - The other way is to use the full DocBook stylesheets directly. Th= e DocBook - DTDs are shipped with Forrest and automatically handled. However,= you - will need to have the DocBook stylesheets on your system (they are - too massive to ship with Forrest) and configure Forrest according= ly. - You will need to create a - project sitemap - as explained in - Using Forrest - and add matches to handle your DocBook documents. - Here is an example. Note that you need to change it to suit your - situation. The match must be very specific so that only the - DocBook documents are matched. The rest of the documents will be - handled by Forrest core. Powerful regex capabilities are availabl= e=2E -

    +

    There are two ways. Forrest has a simplified-= docbook plugin which can + transform the DocBook format into the Forrest "xdocs" format on-= the-fly and then render + that as normal Forrest documents. Be aware that the stylesheet t= hat does this + transformation is deliberately very limited and does not attempt= to deal with all DocBook + elements.

    +

    The other way is to use the full DocBook stylesheets directly. The Doc= Book DTDs are + shipped with Forrest and automatically handled. However, you wil= l need to have the DocBook + stylesheets on your system (they are too massive to ship with Fo= rrest) and configure + Forrest accordingly. You will need to create a project + sitemap as explained in Using Forrest and + add matches to handle your DocBook documents. Here is an example= . Note that you need to + change it to suit your situation. The match must be very specifi= c so that only the DocBook + documents are matched. The rest of the documents will be handled= by Forrest core. Powerful + regex capabilities are available. 

    <?xml version=3D"1.0"?>
 <map:sitemap xmlns:map=3D"http://apache.org/cocoon/sitemap/1.0">
  <map:pipelines>
@@ -1233,105 +1092,68 @@
    </map:match>
   </map:pipeline>
  </map:pipelines>
-</map:sitemap>
-
    -

    - You can also use a mixture of the two methods, some handled - automatically by Forrest and some directly using DocBook styleshe= ets. - You can also have a mixture of source files as "document-v*" DTD = and DocBook. -

    -

    - Ensure that the document type declaration in your xml instance is - well specified. Use a public identifier. The DTD will then be pro= perly - resolved by Forrest. If you need to use different DTDs, then see - Using Forrest - for configuration guidance. -

    -
    - -

    5.3.=20 - How to report which version of Forrest is being used and the - properties that are set? -

    +</map:sitemap> +

    You can also use a mixture of the two methods, some handled automatica= lly by Forrest and + some directly using DocBook stylesheets. You can also have a mix= ture of source files as + "document-v*" DTD and DocBook.

    +

    Ensure that the document type declaration in your xml instance is well= specified. Use a + public identifier. The DTD will then be properly resolved by For= rest. If you need to use + different DTDs, then see Using Forrest for + configuration guidance.

    + + +

    5.3. How to report which version of Forrest is being us= ed and the properties that are + set?

    ^
    -

    - Do 'forrest -projecthelp' or './build.sh' - to find the version number. -

    -

    - To list the properties, add "forrest.echo=3Dtrue" to your - forrest.properties file and watch the build messages. - Doing 'forrest -v' will provide = verbose build messages. -

    +

    Do 'forrest -projecthelp' or './build.sh' to find the version + number.

    +

    To list the properties, add "forrest.echo=3Dtrue" to your forrest.prop= erties file and + watch the build messages. Doing 'forres= t -v' will provide verbose build + messages.

    - -

    5.4.=20 - Where are the log files to find more infomation about errors? -

    + +

    5.4. Where are the log files to find more infomation ab= out errors?

    ^
    -

    - The logfiles are at build/webapp/WEB-IN= F/logs/ +

    The logfiles are at build/webapp/WEB-INF/logs= / =20

    -

    - The log level can be raised with the lo= gkit.xconf - configuration. If you are using Forrest in the interactive webapp - mode (which is generally easiest for debugging errors) then see = the - build/webapp/WEB-INF/logkit.xconf file. - If you are generating a static site (with command-line 'forrest') - then copy $FORREST_HOME/main/webapp/WEB= -INF/logkit.xconf - to your project at - src/documentation/content/conf/logkit.x= conf - and modify it. See more information and efficiency tips with - Cocoo= n logging. -

    -

    - Doing 'forrest -v' will provide = verbose build messages - to the standard output. -

    +

    The log level can be raised with the logkit.x= conf configuration. If you are + using Forrest in the interactive webapp mode (which is generally= easiest for debugging + errors) then see the build/webapp/WEB-I= NF/logkit.xconf file. If you are + generating a static site (with command-line 'forrest') then copy + $FORREST_HOME/main/webapp/WEB-INF/log= kit.xconf to your project at + src/documentation/content/conf/logkit= .xconf and modify it. See more + information and efficiency tips with Cocoon logging.

    +

    Doing 'forrest -v' will provide verbos= e build messages to the standard + output.

    - -

    5.5.=20 - How to help? -

    + +

    5.5. How to help?

    ^
    -

    - Join one of the Forrest project - mailing lists - and tell us what you would like to see improved. We regard all = feedback - as valuable, particularly from newcomers—often, close prox= imity - blinds software developers to faults that are obvious to everyone - else. Don't be shy! -

    +

    Join one of the Forrest project mailing= lists and + tell us what you would like to see improved. We regard all feedb= ack as valuable, + particularly from newcomers—often, close proximity blinds = software developers to + faults that are obvious to everyone else. Don't be shy!

    - -

    5.6.=20 - How to contribute a patch? -

    + +

    5.6. How to contribute a patch?

    ^
    -

    Please send all contributions via our - issue tracker. - Here are notes about - making patches. -

    -

    More info about contributing can be found at the=20 - Contributing to Forrest page. - It is always a good idea to check the Forrest - issue tracker - before diving in. -

    +

    Please send all contributions via our issue tracker. Here + are notes about making patches= .

    +

    More info about contributing can be found at the Contributing + to Forrest page. It is always a good idea to check the For= rest issue tracker before diving in.

    @@ -1350,7 +1172,9 @@ // -->
    - Copyright © 2002-2005 The Apache Software Foundation.
    + Copyright © + 2002-2005 The Apache = Software Foundation. + Modified: forrest/site/0.7/docs/faq.pdf URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/faq.pdf?rev=3D1685= 12&r1=3D168511&r2=3D168512&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D Binary files - no diff available.