You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2007/04/10 05:48:57 UTC
svn commit: r527010 [2/26] - in /forrest/trunk/site-author/content: ./
skins/ xdocs/ xdocs/docs_0_70/ xdocs/docs_0_70/howto/
xdocs/docs_0_70/howto/bugzilla-patch/ xdocs/docs_0_70/howto/cvs-ssh/
xdocs/docs_0_70/howto/multi/ xdocs/docs_0_80/ xdocs/docs_0...
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/compliance.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/compliance.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/compliance.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/compliance.xml Mon Apr 9 20:48:52 2007
@@ -16,30 +16,28 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-<document>
- <header>
- <title>Standards Compliance</title>
- </header>
- <body>
+<document>
+ <header>
+ <title>Standards Compliance</title>
+ </header>
+ <body>
<section>
<title>Introduction</title>
<p>
- Forrest is still quite young, so there are known issues.
- Standards compliance is a definite major goal. Please send patches
- for the Forrest skin stylesheets to ensure such compliance.
+ Forrest is still quite young, so there are known issues. Standards
+ compliance is a definite major goal. Please send patches for the Forrest
+ skin stylesheets to ensure such compliance.
</p>
- <!--
+<!--
<note>
For your testing, use the Forrestbot generated website, because that
reflects the current SVN code ...
<link href="http://forrestbot.cocoondev.org/sites/xml-forrest/">http://forrestbot.cocoondev.org/sites/xml-forrest/</link>
</note>
-->
- </section>
-
+ </section>
<section>
<title>HTML</title>
-
<p>
Tested using the W3C HTML Validation Service
(<link href="http://validator.w3.org/">validator.w3.org</link>). The
@@ -47,64 +45,69 @@
unless the user has turned this off.
</p>
<p>
- The "<code>pelt</code>" skin
- validates as HTML 4.0.1
+ The "<code>pelt</code>" skin validates as HTML 4.0.1
</p>
<p>
- The "<code>tigris</code>" skin
- validates as HTML 4.0.1
+ The "<code>tigris</code>" skin validates as HTML 4.0.1
</p>
- </section>
-
+ </section>
<section>
<title>WAI</title>
-<p>See
-<link href="http://www.w3.org/WAI/">Web Accessibility Initiative (WAI)</link>
-</p>
-<p>
- There are actually many accessibility issues with the heavy use of
- tables and images. These skins are gradually being improved.
-</p>
-<p>
-Bobby with WAI:
-<link href="http://bobby.watchfire.com/">bobby.watchfire.com</link>
-</p>
-<p>Issues ...</p>
-<ol>
- <li>
+ <p>
+ See <link href="http://www.w3.org/WAI/">Web Accessibility Initiative
+ (WAI)</link>
+ </p>
+ <p>
+ There are actually many accessibility issues with the heavy use of
+ tables and images. These skins are gradually being improved.
+ </p>
+ <p>
+ Bobby with WAI:
+ <link href="http://bobby.watchfire.com/">bobby.watchfire.com</link>
+ </p>
+ <p>
+ Issues ...
+ </p>
+ <ol>
+ <li>
Priority 1: alt text for images.
</li>
- <li>Priority 2:
+ <li>Priority 2:
<link href="http://bobby.watchfire.com/bobby/html/en/gls/g41.html">Explicitly
associate form controls and their labels with the LABEL element</link>.
Perhaps we could have a label hidden with CSS?</li>
- <li>FIXME: need to list other issues here, or attend to them.</li>
-</ol>
-<note>The forrest-site skin does not have any missing alts. Perhaps Bobby
- does not like the trick with empty alt attributes. However, it only
- complains about the two in the footer, and not about the other 40.</note>
-<p>
-Bobby with U.S. Section 508 Guidelines:
-<link href="http://bobby.watchfire.com/">bobby.watchfire.com</link>
-</p>
-<p>Issues ...</p>
-<ol>
- <li>The same issues as above</li>
-</ol>
- </section>
-
+ <li>FIXME: need to list other issues here, or attend to them.</li>
+ </ol>
+ <note>
+ The forrest-site skin does not have any missing alts. Perhaps Bobby does
+ not like the trick with empty alt attributes. However, it only complains
+ about the two in the footer, and not about the other 40.
+ </note>
+ <p>
+ Bobby with U.S. Section 508 Guidelines:
+ <link href="http://bobby.watchfire.com/">bobby.watchfire.com</link>
+ </p>
+ <p>
+ Issues ...
+ </p>
+ <ol>
+ <li>The same issues as above</li>
+ </ol>
+ </section>
<section>
<title>CSS</title>
-<p>
-Jigsaw:
-<link href="http://jigsaw.w3.org/css-validator/">jigsaw.w3.org</link>
-</p>
-<p>Issues ...</p>
-<ol>
- <li>CSS 2: No errors. Some warnings.</li>
- <li>CSS 1: Errors: hover class, @media-print. Some warnings.</li>
- <li>FIXME: need to list other issues here, or attend to them.</li>
-</ol>
- </section>
+ <p>
+ Jigsaw:
+ <link href="http://jigsaw.w3.org/css-validator/">jigsaw.w3.org</link>
+ </p>
+ <p>
+ Issues ...
+ </p>
+ <ol>
+ <li>CSS 2: No errors. Some warnings.</li>
+ <li>CSS 1: Errors: hover class, @media-print. Some warnings.</li>
+ <li>FIXME: need to list other issues here, or attend to them.</li>
+ </ol>
+ </section>
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/dreams.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/dreams.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/dreams.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/dreams.xml Mon Apr 9 20:48:52 2007
@@ -16,116 +16,105 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
-
<document>
- <header>
- <title>Forrest dream list</title>
- <subtitle>Overview</subtitle>
- </header>
-
- <body>
- <section>
- <title>Introduction</title>
-
- <p>This is the initial attempt to give focus to the Forrest project.
- This summary is a loose collection of items from the forrest-dev
- mailing list. Please add and re-arrange so that it can evolve into a
- focus document. The <link href="site:v0.70//primer">Forrest Primer</link>
- provides an overview.
- </p>
-
- <p>These are the email threads and documents that are currently being
- summarised. Please see those documents for further detail.
- </p>
-
- <ul>
- <li>
+ <header>
+ <title>Forrest dream list</title>
+ <subtitle>Overview</subtitle>
+ </header>
+ <body>
+ <section>
+ <title>Introduction</title>
+ <p>
+ This is the initial attempt to give focus to the Forrest project. This
+ summary is a loose collection of items from the forrest-dev mailing
+ list. Please add and re-arrange so that it can evolve into a focus
+ document. The <link href="site:v0.70//primer">Forrest Primer</link>
+ provides an overview.
+ </p>
+ <p>
+ These are the email threads and documents that are currently being
+ summarised. Please see those documents for further detail.
+ </p>
+ <ul>
+ <li>
[RT] my Forrest dream-list
Date: Wed, 20 Feb 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101431895118349">http://marc.theaimsgroup.com/?l=forrest-dev&m=101431895118349</link>
[done]
</li>
- <li>
+ <li>
README
[FIXME: not yet started summarising]
</li>
- <li>
+ <li>
[phases] Forrest
Date: Fri, 22 Feb 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101445744931104">http://marc.theaimsgroup.com/?l=forrest-dev&m=101445744931104</link>
[FIXME: not yet started summarising]
</li>
- <li>
+ <li>
adding to the dream list
Date: Fri, 15 Mar 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263">http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263</link>
[FIXME: not yet started summarising]
</li>
- <li>
+ <li>
analysis paralysis :-)
Date: Mon, 25 Feb 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101465344708301">http://marc.theaimsgroup.com/?l=forrest-dev&m=101465344708301</link>
[FIXME: not yet started summarising]
</li>
- <li>
+ <li>
documentation architecture?
Date: Thu, 25 Apr 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101973705501466">http://marc.theaimsgroup.com/?l=forrest-dev&m=101973705501466</link>
[FIXME: not yet started summarising]
</li>
- <li>
+ <li>
Topic Maps for Forrest ?
Date: Mon, 18 Mar 2002
<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101647290524645">http://marc.theaimsgroup.com/?l=forrest-dev&m=101647290524645</link>
[FIXME: not yet started summarising]
</li>
- </ul>
- </section>
-
- <section>
- <title>Draft dream list</title>
-
- <ul>
- <li>
+ </ul>
+ </section>
+ <section>
+ <title>Draft dream list</title>
+ <ul>
+ <li>
Forrest provides a robust technological infrastructure for open software development for the Apache Software Foundation based on ASF software, ASF practices and experience, and modern software design principles.
</li>
- <li>
+ <li>
a publishing system for documentation
</li>
- <li>
+ <li>
analysis of logs and publishing of results
</li>
-
- <li>
+ <li>
Ok, first of all: "it hurts my spirit" (I should TM this) to see the
apache web sites with such a *poor* information infrastructure. Just
look at sourceforge: it's not the best site of the world, but gives you
lots of tools and information that we currently don't have (or have
hidden someplace).
</li>
-
- <li>
+ <li>
I want Forrest to be the development infrastructure of your dreams,
something that you'll be proud of showing your boss and say "if only we
had this in place, we would save big bucks" so...
</li>
-
- <li>
+ <li>
Dream #1: Forrest should make Sourceforge look obsolete.
</li>
-
- <li>
+ <li>
So, in order for this to happen, it must be dynamic.
Assumption #1: Forrest is a dynamic site.
The staticity of apache web sites was mostly due to the quest for heavy
mirroring, Forrest should allow mirroring, so
</li>
-
- <li>
+ <li>
Dream #2: Forrest should reduce xml.apache.org bandwidth use dramatically
</li>
-
- <li>
+ <li>
Dream #3: Forrest should automate mirroring in a simple and easy way.
My idea is to use the 'command line' features of Cocoon to generate
@@ -133,117 +122,93 @@
rsync or other mean. Anyway, the goal is to make sure mirroring is as
easy as possible. No, easier than that.
</li>
-
- <li>
+ <li>
coherence: all the site should look coherent, same graphics, same
look-and-feel, same information in the same locations, coherent and nice URI
space (build to last! so that broken links are reduced!)
</li>
-
- <li>
+ <li>
structure: the site should look professional, the structure should be
flexible enough to fit every need but solid enough to guide users
browsing and developers adding resources
</li>
-
- <li>
+ <li>
scalability
</li>
-
- <li>
+ <li>
functionality: everything you ever wanted to have in your project web site
</li>
-
- <li>
+ <li>
logs and community rating: I want to have numbers to judge the value
of a community/effort
</li>
-
- <li>
+ <li>
Downloads, number of committers, numbers of people subscribed on the users/dev
list, numbers of mail messages / week on these lists, CVS activity...
These are the kind of parameters I use to "judge" an Apache project that I
have not been looking into before.
</li>
-
- <li>
+ <li>
Graphs of various statistics.
</li>
-
- <li>
+ <li>
Having good site metrics will be a valuable aid to those involved in
maintenance and future re-design phases.
See some discussion in
-<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885">http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885</link>
- </li>
-
- <li>
+<link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885">http://marc.theaimsgroup.com/?l=forrest-dev&m=102238816218885</link></li>
+ <li>
Built-in search engine: users much have a simple way to find things.
Lucene.
</li>
-
- <li>
+ <li>
User-writable pages: people should have a way to add things to the pages.
See the thread for more detail on this.
FIXME: get MARC ref
</li>
-
- <li>
+ <li>
short bios for the project committers, with pictures: gives a better
sense of community. Having a weblog there would be great.
</li>
-
- <li>
+ <li>
news, announcements, events and project calendaring: the news and
the announcements will generate a RSS feed, events will be aggregated
into a project-wide calendar, or an effort-specific calendar, the events
will also be overwritten on the logs, to indicate how logs were
influenced by the events (say, a release or a new committer added)
</li>
-
- <li>
+ <li>
book-like PDF versions of documentation: easy to print out docs.
</li>
-
- <li>
+ <li>
integration with GUMP: dependencies, runs, committer that broke the run
</li>
-
- <li>
+ <li>
javadocs seemlessly integrated with the documentation and with the
search engine.
- <link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263">http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263</link>
- </li>
-
- <li>
+ <link href="http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263">http://marc.theaimsgroup.com/?l=forrest-dev&m=101620970016263</link></li>
+ <li>
mail archive seemlessly integrated with the search engine (one should
look for something and get results from either docs, javadocs or emails
messages)
</li>
-
- <li>
+ <li>
coherent-looking CVS view
</li>
-
- <li>
+ <li>
document translation using Google translation services
</li>
-
- <li>
+ <li>
Integrated project management, task management, bug tracking, feature requests, process management.
The idea is to integrate Scarab for bug tracking/patches and
managing/feature requests.
(As far as team management, this is a serious political issue and I do not
want to tackle that one yet, not even on the dreamlist.)
</li>
-
- <li>
+ <li>
overview doco for all projects ... CVS Usage precis, overview of opensource
and links to relevant doco
</li>
-
-</ul>
- </section>
-
- </body>
+ </ul>
+ </section>
+ </body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/faq.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/faq.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/faq.xml Mon Apr 9 20:48:52 2007
@@ -25,58 +25,71 @@
<question> How to use these FAQs? </question>
<answer>
<p>
- There is no particular order to these FAQs. Use your browser's
- "Find in this page" facility to search for keywords.
+ There is no particular order to these FAQs. Use your browser's "Find
+ in this page" facility to search for keywords.
</p>
</answer>
</faq>
<faq id="overview">
<question> Where can I read an overview about how to work with Forrest? </question>
<answer>
- <p> See the <link href="site:v0.70//your-project">Using Forrest</link> guide. </p>
+ <p>
+ See the <link href="site:v0.70//your-project">Using Forrest</link>
+ guide.
+ </p>
</answer>
</faq>
<faq id="requirements">
<question> What are the system requirements for Forrest? </question>
<answer>
- <p> Forrest includes everything necessary to build and run, except of course for Java. In
- addition to all the Cocoon JARs, Forrest includes and uses its own version of Apache Ant.
+ <p>
+ Forrest includes everything necessary to build and run, except of
+ course for Java. In addition to all the Cocoon JARs, Forrest includes
+ and uses its own version of Apache Ant.
</p>
<p>
Java 1.4 (or newer) is required. If you are only going to use Forrest
- as-is then you need only the Java Runtime Environment (JRE).
- If you intend to enhance and rebuild Forrest (or use the Forrest sources
- with Subversion or use a source snapshot) then you need the full JDK.
+ as-is then you need only the Java Runtime Environment (JRE). If you
+ intend to enhance and rebuild Forrest (or use the Forrest sources with
+ Subversion or use a source snapshot) then you need the full JDK.
</p>
</answer>
</faq>
<faq id="cvs">
<question> The old xml-forrest CVS code repository seems to be stale. What happened? </question>
<answer>
- <p> Forrest switched from a CVS code repository to SVN (Subversion) code repository. The old
- CVS repository is closed and not kept current. </p>
+ <p>
+ Forrest switched from a CVS code repository to SVN (Subversion) code
+ repository. The old CVS repository is closed and not kept current.
+ </p>
</answer>
</faq>
<faq id="svn">
<question> How can I use SVN to keep up to date with the latest codebase? </question>
<answer>
- <p> Follow these <link href="site:v0.70//build">Building Forrest</link> notes. </p>
- <p> The <link href="site:v0.70//your-project">Using Forrest</link> guide provides further
- step-by-step assistance in getting started with Forrest for your project. </p>
+ <p>
+ Follow these <link href="site:v0.70//build">Building Forrest</link>
+ notes.
+ </p>
+ <p>
+ The <link href="site:v0.70//your-project">Using Forrest</link> guide
+ provides further step-by-step assistance in getting started with
+ Forrest for your project.
+ </p>
</answer>
</faq>
<faq id="older-plugins">
<question> How to use older versions of specific plugins? </question>
<answer>
<p>
- Sometimes one does not want to use the most recent functionality
- of a plugin and instead need to use an older version.
- Information about changes to each plugin can be found in its
+ Sometimes one does not want to use the most recent functionality of a
+ plugin and instead need to use an older version. Information about
+ changes to each plugin can be found in its
<link href="site:v0.70//plugins/index">documentation</link>.
</p>
<p>
- In the forrest.properties file, specify the version of the plugin
- that you require, e.g.
+ In the forrest.properties file, specify the version of the plugin that
+ you require, e.g.
</p>
<source>project.required.plugins=org.apache.forrest.plugin.input.PhotoGallery-0.1,...</source>
<p>
@@ -96,32 +109,47 @@
<faq id="single-document">
<question> What is the best way to generate "standalone documents" using Forrest? </question>
<answer>
- <p> forrest site -Dproject.start-uri=myfile.pdf </p>
- <p> The <link href="site:v0.70//your-project">Using Forrest</link> guide provides further
- step-by-step assistance in getting started with Forrest for your project. </p>
+ <p>
+ forrest site -Dproject.start-uri=myfile.pdf
+ </p>
+ <p>
+ The <link href="site:v0.70//your-project">Using Forrest</link> guide
+ provides further step-by-step assistance in getting started with
+ Forrest for your project.
+ </p>
</answer>
</faq>
<faq id="cygwin_mutex_error">
<question> When running <code>./build.sh</code> in cygwin, I get an error: <code>cygpath.exe:
*** can't create title mutex, Win32 error 6</code>. </question>
<answer>
- <p> This <link href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
- to be a bug in cygwin</link>. Please use the .bat script instead. </p>
+ <p>
+ This
+ <link href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=FOR-10">appears
+ to be a bug in cygwin</link>. Please use the .bat script instead.
+ </p>
</answer>
</faq>
<faq id="maxmemory">
<question> How can I specify the amount of memory to be used by Java? </question>
<answer>
- <p> There are two ways to control this. If you get an OutOfMemoryError when Cocoon is
- generating pages, see the first paragraph. If you get an OutOfMemoryError when outside of
- Cocoon (e.g., copying raw files), see the second paragraph. </p>
- <p> The <code>maxmemory</code> property in the <code>forrest.properties</code> file controls
- how much memory Cocoon uses. Like many other properties you can copy them from the default
+ <p>
+ There are two ways to control this. If you get an OutOfMemoryError
+ when Cocoon is generating pages, see the first paragraph. If you get
+ an OutOfMemoryError when outside of Cocoon (e.g., copying raw files),
+ see the second paragraph.
+ </p>
+ <p>
+ The <code>maxmemory</code> property in the
+ <code>forrest.properties</code> file controls how much memory Cocoon
+ uses. Like many other properties you can copy them from the default
configuration at <code>src/core/fresh-site/forrest.properties</code>
</p>
- <p> Set the <code>ANT_OPTS</code> environment variable before you run forrest. The exact
- value you set it to is dependant on your JVM, but something like
- <code>ANT_OPTS=-Xmx500M</code> will probably work. </p>
+ <p>
+ Set the <code>ANT_OPTS</code> environment variable before you run
+ forrest. The exact value you set it to is dependant on your JVM, but
+ something like <code>ANT_OPTS=-Xmx500M</code> will probably work.
+ </p>
</answer>
</faq>
</part>
@@ -130,16 +158,27 @@
<faq id="edit-content">
<question>What tools can be used to edit the content?</question>
<answer>
- <p>If you are using the Apache Forrest xml <link href="site:v0.70//dtd-docs">document format</link>
- or DocBook or other xml document types, then you can use any text editor or even a
- dedicated xml editor. You must ensure valid xml. See our <link href="site:v0.70//catalog"
- >configuration notes</link> for various editors. </p>
- <p>There are content management systems like <link href="ext:lenya">Apache Lenya</link>. </p>
- <p>Remember that Forrest can also use other source formats, such as OpenOffice.org docs or
- JSPWiki. Use the appropriate editor for those document types and ensure that the document
- stucture is consistent. Forrest can also use "html" as the source format, in which case
- you can use text editors or "html editors" such as the one provided with the Mozilla web
- browser. </p>
+ <p>
+ If you are using the Apache Forrest xml
+ <link href="site:v0.70//dtd-docs">document format</link> or DocBook or
+ other xml document types, then you can use any text editor or even a
+ dedicated xml editor. You must ensure valid xml. See our
+ <link href="site:v0.70//catalog"
+ >configuration
+ notes</link> for various editors.
+ </p>
+ <p>
+ There are content management systems like
+ <link href="ext:lenya">Apache Lenya</link>.
+ </p>
+ <p>
+ Remember that Forrest can also use other source formats, such as
+ OpenOffice.org docs or JSPWiki. Use the appropriate editor for those
+ document types and ensure that the document stucture is consistent.
+ Forrest can also use "html" as the source format, in which case you
+ can use text editors or "html editors" such as the one provided with
+ the Mozilla web browser.
+ </p>
</answer>
</faq>
<faq id="site-xml">
@@ -148,40 +187,44 @@
</question>
<answer>
<p>
- The <code>site.xml</code> configuration file is used for two different purposes:
- defining the left-hand navigation menus, and as a method for defining references
- to be used when linking between documents.
- This file is fully explained in
- <link href="site:v0.70//linking">Menus and Linking</link>. Here is a precis:
+ The <code>site.xml</code> configuration file is used for two different
+ purposes: defining the left-hand navigation menus, and as a method for
+ defining references to be used when linking between documents. This
+ file is fully explained in <link href="site:v0.70//linking">Menus and
+ Linking</link>. Here is a precis:
</p>
<p>
The labels can be whatever text you want.
</p>
- <source><![CDATA[<faq label="FAQs" href="faq.html">
+ <source>
+<![CDATA[<faq label="FAQs" href="faq.html">
<tech label="Technical" href="faq-tech.html">
<docbook href="#docbook"/>
<ignoring_javadocs href="#ignoring_javadocs"/>
</tech>
<user label="User" href="faq-user.html">
-</faq>]]></source>
+</faq>]]>
+ </source>
<p>
That will create a menu like this with three links:
</p>
<source>FAQs
Technical
User</source>
-
<p>
These documents can be linked to from other documents, like this:
</p>
- <source><![CDATA[<a href="site:v0.70//faq/tech"> link to the top of the Tech FAQs
-<a href="site:v0.70//faq/tech/docbook"> link to the DocBook FAQ in the Tech FAQs]]></source>
-
+ <source>
+<![CDATA[<a href="site:v0.70//faq/tech"> link to the top of the Tech FAQs
+<a href="site:v0.70//faq/tech/docbook"> link to the DocBook FAQ in the Tech FAQs]]>
+ </source>
<p>
If that "docbook" entry was a unique name in your site.xml then you
can shorten that latter link:
</p>
- <source><![CDATA[<a href="site:v0.70//docbook"> link to the DocBook FAQ in the Tech FAQs]]></source>
+ <source>
+<![CDATA[<a href="site:v0.70//docbook"> link to the DocBook FAQ in the Tech FAQs]]>
+ </source>
</answer>
</faq>
<faq id="examples">
@@ -190,42 +233,59 @@
</question>
<answer>
<p>
- There are examples in the 'forrest seed site' and also the Forrest website documents
- are included with the distribution (cd forrest/site-author; forrest run).
+ There are examples in the 'forrest seed site' and also the Forrest
+ website documents are included with the distribution (cd
+ forrest/site-author; forrest run).
</p>
</answer>
</faq>
<faq id="PDF-output">
<question>How can I generate one pdf-file out of the whole site or selected pages of the site?</question>
<answer>
- <p>Add the following entries to your site.xml file:</p>
- <source><![CDATA[
+ <p>
+ Add the following entries to your site.xml file:
+ </p>
+ <source>
+<![CDATA[
<about tab="home" label="About" href="">
...
<all_site label="Full HTML" href="wholesite.html"/>
<all_sitePDF label="Full PDF" href="wholesite.pdf"/>
...
- </about>]]></source>
- <p> In this case the menu labeled "About" will have 2 new items: "Full PDF" and "Full HTML".
- (See also <link href="site:v0.70//howto/pdf-tab">How to create a PDF document for each
- tab</link>.) </p>
- <p> This assumes that you use the <link href="site:v0.70//linking">site.xml</link> method for your
- site structure and navigation, rather than the old book.xml method. </p>
+ </about>]]>
+ </source>
+ <p>
+ In this case the menu labeled "About" will have 2 new items: "Full
+ PDF" and "Full HTML". (See also
+ <link href="site:v0.70//howto/pdf-tab">How to create a PDF document
+ for each tab</link>.)
+ </p>
+ <p>
+ This assumes that you use the
+ <link href="site:v0.70//linking">site.xml</link> method for your site
+ structure and navigation, rather than the old book.xml method.
+ </p>
</answer>
</faq>
<faq id="pageBreaks">
<question>How do I insert page breaks into documents?</question>
<answer>
- <p>Page breaks do not make a great deal of sense in HTML documents intended for display on a
- screen. However, PDF documents are intended for printing and therefore page breaks can be
- important.</p>
- <p>To insert a page break in a PDF document simply add <em>pageBreakBefore</em> and/or
- <em>pageBreakAfter</em> to the class attribute of the block you wish to force a
- page break on. All the common block grouping elements support this class, for example,
- note, warning, p and so on.</p>
- <p>If you want these classes to be processed in your HTML documents as well you should add
- the following to the <code>extra-css</code> element in your projects
- <code>skinconf.xml</code>
+ <p>
+ Page breaks do not make a great deal of sense in HTML documents
+ intended for display on a screen. However, PDF documents are intended
+ for printing and therefore page breaks can be important.
+ </p>
+ <p>
+ To insert a page break in a PDF document simply add
+ <em>pageBreakBefore</em> and/or <em>pageBreakAfter</em> to the class
+ attribute of the block you wish to force a page break on. All the
+ common block grouping elements support this class, for example, note,
+ warning, p and so on.
+ </p>
+ <p>
+ If you want these classes to be processed in your HTML documents as
+ well you should add the following to the <code>extra-css</code>
+ element in your projects <code>skinconf.xml</code>
</p>
<source> .pageBreakBefore { margin-bottom: 0; page-break-before: always; } .pageBreakAfter {
margin-bottom: 0; page-break-after: always; } </source>
@@ -235,58 +295,82 @@
<question>How can I generate html-pages to show a 'clickable' email-address (of the
author-element)?</question>
<answer>
- <p>You would override <code>
- $FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</code> and edit the
- "headers/authors" template. </p>
+ <p>
+ You would override <code>
+ $FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</code>
+ and edit the "headers/authors" template.
+ </p>
</answer>
</faq>
<faq id="link_raw">
<question>How do I link to raw files such as config.txt and brochure.pdf? </question>
<answer>
- <p>Handling of raw files was significantly changed in Forrest 0.7. See
- <link href="site:v0.70//upgrading_07/raw">Upgrading to Apache Forrest 0.7</link> for
- all the details.</p>
+ <p>
+ Handling of raw files was significantly changed in Forrest 0.7. See
+ <link href="site:v0.70//upgrading_07/raw">Upgrading to Apache Forrest
+ 0.7</link> for all the details.
+ </p>
</answer>
</faq>
<faq id="pdf_images">
<question>Images don't display in PDFs. How do I fix this?</question>
<answer>
- <p> Forrest uses <link href="http://xml.apache.org/fop/">Apache FOP</link> 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 <link
- href="http://xml.apache.org/fop/graphics.html">FOP Graphics formats</link>
+ <p>
+ Forrest uses <link href="http://xml.apache.org/fop/">Apache FOP</link>
+ 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
+ <link
+ href="http://xml.apache.org/fop/graphics.html">FOP
+ Graphics formats</link>
+ </p>
+ <p>
+ To get PNGs working in PDFs with Jimi:
</p>
- <p>To get PNGs working in PDFs with Jimi:</p>
<ol>
<li>Download Jimi from <link href="http://java.sun.com/products/jimi/"
- >http://java.sun.com/products/jimi/</link>
- </li>
+ >http://java.sun.com/products/jimi/</link></li>
<li>Unpack the Jimi distribution and copy JimiProClasses.zip to
<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 info, see <link
- href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</link>
- </p>
- <note>Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</note>
+ <p>
+ Alternatively you can use JAI (Java Advanced Imaging API at
+ http://java.sun.com/products/java-media/jai). For more info, see
+ <link
+ href="http://xml.apache.org/fop/graphics.html#packages">FOP
+ Graphics Packages</link>
+ </p>
+ <note>
+ Due to Sun's licensing, we cannot redistribute Jimi or JAI with
+ Forrest.
+ </note>
</answer>
</faq>
<faq id="tab-index">
<question> The tab link in my site incorrectly assumes that 'index.html' is present in the
linked-to directory. How do I fix this? </question>
<answer>
- <p> In <code>tabs.xml</code>, use @href instead of @dir, and omit the trailing '/'. Which
- file to serve is then a concern of the sitemap. For example, if the "User Manual" tab
- should link to <code>manual/Introduction.html</code> then <code>tabs.xml</code> should
- contain: </p>
- <source><![CDATA[
- <tab label="User Manual" href="manual"/>]]></source>
- <p> and add this rule to the sitemap: </p>
- <source><![CDATA[
+ <p>
+ In <code>tabs.xml</code>, use @href instead of @dir, and omit the
+ trailing '/'. Which file to serve is then a concern of the sitemap.
+ For example, if the "User Manual" tab should link to
+ <code>manual/Introduction.html</code> then <code>tabs.xml</code>
+ should contain:
+ </p>
+ <source>
+<![CDATA[
+ <tab label="User Manual" href="manual"/>]]>
+ </source>
+ <p>
+ and add this rule to the sitemap:
+ </p>
+ <source>
+<![CDATA[
<map:match pattern="manual">
<map:redirect-to uri="manual/Introduction.html"/>
- </map:match>]]></source>
+ </map:match>]]>
+ </source>
</answer>
</faq>
<faq id="tab-site">
@@ -301,42 +385,56 @@
<question> How can I change the default file name that Forrest will look for when I request a
URL like <code>http://myserver</code> or <code>http://myserver/mydir/</code> ? </question>
<answer>
- <p>To change the default file name from 'index.html' (default) to 'overview.html' you need to
- make the following changes:</p>
+ <p>
+ To change the default file name from 'index.html' (default) to
+ 'overview.html' you need to make the following changes:
+ </p>
<ol>
<li> Create a '<link href="#cli-xconf">cli.xconf</link>' file for your project </li>
<li> Edit that file to replace 'index.html' in
<![CDATA[<default-filename>index.html</default-filename>]]>
with 'overview.html'. </li>
<li> Edit your project's <link href="site:v0.70//project-sitemap">sitemap.xmap</link> file. </li>
- <li> Add the following code just before the end of the pipelines-element:<source><![CDATA[
+ <li> Add the following code just before the end of the pipelines-element:<source>
+<![CDATA[
<map:pipeline>
<map:match type="regexp" pattern="^.+/$">
<map:redirect-to uri="overview.html"/>
</map:match>
</map:pipeline>
- ]]></source></li>
+ ]]>
+ </source></li>
</ol>
</answer>
</faq>
<faq id="defaultStartPage">
<question> How can I use a start-up-page other than index.html? </question>
<answer>
- <p>Forrest by default assumes that the first page (home page) of your site is named
- index.html. Which is good because most web servers are configured to look for index.html
- when you call a url like http://myserver</p>
- <p>Like most settings in Forrest however this can be changed, for example when you want your
- start-up-page for a CD-based documentation project to be named 'start.html'. </p>
- <p>To change the start page of a site:</p>
+ <p>
+ Forrest by default assumes that the first page (home page) of your
+ site is named index.html. Which is good because most web servers are
+ configured to look for index.html when you call a url like
+ http://myserver
+ </p>
+ <p>
+ Like most settings in Forrest however this can be changed, for example
+ when you want your start-up-page for a CD-based documentation project
+ to be named 'start.html'.
+ </p>
+ <p>
+ To change the start page of a site:
+ </p>
<ol>
<li>Edit your project's <link href="site:v0.70//project-sitemap">sitemap.xmap</link> file.</li>
- <li>Add the following code just before the end of the pipelines-element:<source><![CDATA[
+ <li>Add the following code just before the end of the pipelines-element:<source>
+<![CDATA[
<map:pipeline>
<map:match pattern="">
<map:redirect-to uri="start.html" />
</map:match>
</map:pipeline>
- ]]></source></li>
+ ]]>
+ </source></li>
<li>Name the uri-attribute whatever you'd like your start page to be.</li>
<li>Don't forget to create that page and refer to it in your site.xml</li>
</ol>
@@ -345,55 +443,98 @@
<faq id="label-entity">
<question> How to use special characters in the labels of the site.xml file? </question>
<answer>
- <p> Use the numeric values for character entities. For example, rather than using
- <code><![CDATA[ö]]></code> use <code><![CDATA[ö]]></code>
+ <p>
+ Use the numeric values for character entities. For example, rather
+ than using <code>
+<![CDATA[ö]]>
+ </code> use <code>
+<![CDATA[ö]]>
+ </code>
</p>
- <p> See the <link
+ <p>
+ See the
+ <link
href="http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_xhtml_character_entities"
- >XHTML Character Entities</link> and see more discussion at <link
- href="http://issues.apache.org/jira/browse/FOR-244">Issue FOR-244</link>. </p>
+ >XHTML
+ Character Entities</link> and see more discussion at
+ <link
+ href="http://issues.apache.org/jira/browse/FOR-244">Issue
+ FOR-244</link>.
+ </p>
</answer>
</faq>
<faq id="encoding">
<question>Does Forrest handle accents for non-English languages?</question>
<answer>
- <p>Yes, Forrest can process text in any language, so you can include:</p>
+ <p>
+ Yes, Forrest can process text in any language, so you can include:
+ </p>
<ul>
<li>accents: á é à ó ú</li>
<li>diereses: ä ë ï ö ü</li>
<li>tildes: ã ñ ĩ õ ũ</li>
</ul>
- <p>This is because sources for Forrest docs are xml documents, which can include 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:</p>
- <source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]></source>
- <p>but the file content is actually using ISO-8859-1 then you will receive validation
- errors, especially if you include some non-ASCII characters.</p>
- <p> This situation is commonly encountered when you edit the templates created by
- <code>forrest seed</code> with your favorite (probably localized) editor without paying
- attention to the encoding, or when you create a new file and simply copy the headers from
- another file. </p>
- <p>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 write the file in disk. With some editors the encoding of
- the file is preserved, while with others the default is used regardless of the original
- encoding. In most cases the encoding used to write files can be controlled by setting the
- environment variable <code>LANG</code> to an appropriate value, for instance: </p>
+ <p>
+ This is because sources for Forrest docs are xml documents, which can
+ include 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:
+ </p>
+ <source>
+<![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]>
+ </source>
+ <p>
+ but the file content is actually using ISO-8859-1 then you will
+ receive validation errors, especially if you include some non-ASCII
+ characters.
+ </p>
+ <p>
+ This situation is commonly encountered when you edit the templates
+ created by <code>forrest seed</code> with your favorite (probably
+ localized) editor without paying attention to the encoding, or when
+ you create a new file and simply copy the headers from another file.
+ </p>
+ <p>
+ 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 write
+ the file in disk. With some editors the encoding of the file is
+ preserved, while with others the default is used regardless of the
+ original encoding. In most cases the encoding used to write files can
+ be controlled by setting the environment variable <code>LANG</code> to
+ an appropriate value, for instance:
+ </p>
<source>[localhost]$ export LANG=en_US.UTF-8</source>
- <p>Of course the <em>appropriate</em> way to set the encoding depends on the editor/OS, but
- ultimately relys on the user preferences. So you can use the encoding you prefer, as long
- as the <code>encoding</code> attribute of the xml declaration matches the actual encoding
- of the file. This means that if you are not willing to abandon ISO-8859-1 you can always
- use the following declaration instead:</p>
- <source><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>]]></source>
- <p>Another option is to use "character entities" such as <code><![CDATA[ö]]></code>
- (ö) or the numeric form <code><![CDATA[ö]]></code> (ö). </p>
- <p>Another related issue is that your webserver needs to send http headers with the matching
- charset definitions to the html page. </p>
- <p>Here are some references which explain further: <link
- href="http://orixo.com/events/gt2004/bios.html#torsten">GT2004 presentation by Torsten
- Schlabach</link> and <link href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
- resources</link>. </p>
+ <p>
+ Of course the <em>appropriate</em> way to set the encoding depends on
+ the editor/OS, but ultimately relys on the user preferences. So you
+ can use the encoding you prefer, as long as the <code>encoding</code>
+ attribute of the xml declaration matches the actual encoding of the
+ file. This means that if you are not willing to abandon ISO-8859-1 you
+ can always use the following declaration instead:
+ </p>
+ <source>
+<![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>]]>
+ </source>
+ <p>
+ Another option is to use "character entities" such as <code>
+<![CDATA[ö]]>
+ </code> (ö) or the numeric form <code>
+<![CDATA[ö]]>
+ </code> (ö).
+ </p>
+ <p>
+ Another related issue is that your webserver needs to send http
+ headers with the matching charset definitions to the html page.
+ </p>
+ <p>
+ Here are some references which explain further:
+ <link
+ href="http://orixo.com/events/gt2004/bios.html#torsten">GT2004
+ presentation by Torsten Schlabach</link> and
+ <link href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
+ resources</link>.
+ </p>
</answer>
</faq>
<faq id="cleanSite">
@@ -405,32 +546,40 @@
successive runs of forrest.
</p>
<p>
- Doing 'forrest clean-site' will remove the contents of the project's
- generated documents directory. Doing 'forrest clean-work' will remove the
- project's work directories (usually build/tmp and build/webapp which
- include the Cocoon cache and the Cocoon logs).
- Doing 'forrest clean' will remove both sections.
+ Doing 'forrest clean-site' will remove the contents of the project's
+ generated documents directory. Doing 'forrest clean-work' will remove
+ the project's work directories (usually build/tmp and build/webapp
+ which include the Cocoon cache and the Cocoon logs). Doing 'forrest
+ clean' will remove both sections.
</p>
</answer>
</faq>
<faq id="i18n">
<question>How can I internationalise (i18n) my content?</question>
<answer>
- <p>The i18n features of Forrest are still under development (as of 0.7) however there are
- some features available. For example, navigation menus can be i18n'd (see fresh-site for an
- example). Currently, <link href="http://issues.apache.org/jira/browse/FOR-506">work is underway</link> to
- i18n skins</p>
-
- <p>All internationalistation of tokens in, for example, the skins and the menus, is carried out
- by the <link href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html">Cocoon i18n
- Transformer</link>. You can see an example of how it works in the above linked issue.</p>
+ <p>
+ The i18n features of Forrest are still under development (as of 0.7)
+ however there are some features available. For example, navigation
+ menus can be i18n'd (see fresh-site for an example). Currently,
+ <link href="http://issues.apache.org/jira/browse/FOR-506">work is
+ underway</link> to i18n skins
+ </p>
+ <p>
+ All internationalistation of tokens in, for example, the skins and the
+ menus, is carried out by the
+ <link href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html">Cocoon
+ i18n Transformer</link>. You can see an example of how it works in the
+ above linked issue.
+ </p>
</answer>
</faq>
<faq id="rawTML">
<question>How can I include HTML content that is not to be skinned by Forrest?</question>
<answer>
- <p>To server, for example, a legacy HTML site add something like the following
- to your projects sitemap:</p>
+ <p>
+ To server, for example, a legacy HTML site add something like the
+ following to your projects sitemap:
+ </p>
<source>
<map:match pattern="old_site/**.html">
<map:select type="exists">
@@ -444,8 +593,10 @@
</map:when>
</map:match>
</source>
- <p>There is a more detailed discussion of this topic in the samples
- of a freshly seeded site. To see this documentation do the following:</p>
+ <p>
+ There is a more detailed discussion of this topic in the samples of a
+ freshly seeded site. To see this documentation do the following:
+ </p>
<ol>
<li>mkdir seed</li>
<li>cd seed</li>
@@ -462,74 +613,111 @@
<question>I'm behind a proxy and it's preventing Plugins from being downloaded, what should I
do?</question>
<answer>
- <p>You can configure the proxy in the <code>forrest.properties</code> file. Set the
- <code>proxy.host</code> and <code>proxy.port</code> accordingly.</p>
- <p>You can also cross an authenticated proxy by setting the <code>proxy.user</code> and <code>proxy.password</code> accordingly.</p>
+ <p>
+ You can configure the proxy in the <code>forrest.properties</code>
+ file. Set the <code>proxy.host</code> and <code>proxy.port</code>
+ accordingly.
+ </p>
+ <p>
+ You can also cross an authenticated proxy by setting the
+ <code>proxy.user</code> and <code>proxy.password</code> accordingly.
+ </p>
</answer>
</faq>
<faq id="CVS_revison_tags">
<question>How can I generate html-pages to show the revision tag of cvs?</question>
<answer>
- <p>If you have:<code><version>$Revision: 1.30
+ <p>
+ If you have:<code><version>$Revision: 1.30
$</version></code>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 <link href="site:v0.70//your-project"> Using Forrest</link> document.</p>
- <p>This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47
- $</p>
+ displayed at the bottom of the page as "version 1.30". See for
+ example the bottom of the <link href="site:v0.70//your-project"> Using
+ Forrest</link> document.
+ </p>
+ <p>
+ This technique could also be used for a modification date with $Date:
+ 2004/01/15 08:52:47 $
+ </p>
</answer>
</faq>
<faq id="cli-xconf">
<question> How to control the processing of URIs by Cocoon, e.g. exclude certain URIs, include
other additional ones. </question>
<answer>
- <p> Forrest uses a configuration file to control the processing done by the Apache Cocoon
- command-line called cli.xconf </p>
- <p> Your project can supply its own <code>cli.xconf</code> and define patterns for URIs to
- exclude. There are also other powerful configuration features. </p>
- <p> This means creating a directory <code>src/documentation/conf</code> (or wherever
- <code>${forrest.conf-dir}</code> points) and copying
- <code>$FORREST_HOME/main/webapp/WEB-INF/cli.xconf</code> to it. Declare the location of
- this file in the forrest.properties configuration, e.g.
- <code>project.configfile=${project.home}/src/documentation/conf/cli.xconf</code>
- </p>
- <p> 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/': </p>
- <source><![CDATA[
+ <p>
+ Forrest uses a configuration file to control the processing done by
+ the Apache Cocoon command-line called cli.xconf
+ </p>
+ <p>
+ Your project can supply its own <code>cli.xconf</code> and define
+ patterns for URIs to exclude. There are also other powerful
+ configuration features.
+ </p>
+ <p>
+ This means creating a directory <code>src/documentation/conf</code>
+ (or wherever <code>${forrest.conf-dir}</code> points) and copying
+ <code>$FORREST_HOME/main/webapp/WEB-INF/cli.xconf</code> to it.
+ Declare the location of this file in the forrest.properties
+ configuration, e.g.
+ <code>project.configfile=${project.home}/src/documentation/conf/cli.xconf</code>
+ </p>
+ <p>
+ 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/':
+ </p>
+ <source>
+<![CDATA[
....
<!-- Includes and excludes can be used to limit which URLs are rendered -->
- ]]><strong><![CDATA[
+ ]]><strong>
+<![CDATA[
<exclude pattern="**/"/>
<exclude pattern="**apidocs**"/>
<exclude pattern="api/**"/>
- ]]></strong><![CDATA[
+ ]]></strong>
+<![CDATA[
<uri src="favicon.ico"/>
-</cocoon>]]></source>
- <p>This is just an example, and you should modify it appropriately for your site.</p>
- <note> Wildcards may be used. These are a powerful feature of Cocoon's <link
- href="site:v0.70//sitemap-ref">sitemap</link>. For example, <strong>foo/*</strong> would match
- <code>foo/bar</code>, but not <code>foo/bar/baz</code> — use
- <strong>foo/**</strong> to match that. </note>
+</cocoon>]]>
+ </source>
+ <p>
+ This is just an example, and you should modify it appropriately for
+ your site.
+ </p>
+ <note>
+ Wildcards may be used. These are a powerful feature of Cocoon's
+ <link
+ href="site:v0.70//sitemap-ref">sitemap</link>. For
+ example, <strong>foo/*</strong> would match <code>foo/bar</code>, but
+ not <code>foo/bar/baz</code> — use <strong>foo/**</strong> to
+ match that.
+ </note>
</answer>
</faq>
<faq id="ignoring_javadocs">
<question> How do I stop Forrest breaking on links to external files that may not exist, like
javadocs? </question>
<answer>
- <p> This can be done by overriding the <link href="#cli-xconf">
- <code>cli.xconf</code>
- </link> Cocoon config file, and defining patterns for URLs to exclude. </p>
+ <p>
+ This can be done by overriding the <link href="#cli-xconf">
+ <code>cli.xconf</code> </link> Cocoon config file, and defining
+ patterns for URLs to exclude.
+ </p>
</answer>
</faq>
<faq id="claimed_patterns">
<question>Some of my files are not being processed because they use common filenames. </question>
<answer>
- <p> Certain patterns are claimed by the default sitemaps for special processing. These
- include: <code>site, changes, todo, faq, images, my-images, skinconf, community,
- howto</code>
- </p>
- <p> 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 (<link href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</link>).
+ <p>
+ Certain patterns are claimed by the default sitemaps for special
+ processing. These include: <code>site, changes, todo, faq, images,
+ my-images, skinconf, community, howto</code>
+ </p>
+ <p>
+ 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
+ (<link href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</link>).
</p>
</answer>
</faq>
@@ -537,13 +725,15 @@
<question>What do the symbols and numbers mean when Forrest lists each document that it has
built? </question>
<answer>
- <source><![CDATA[...
+ <source>
+<![CDATA[...
* [212/166] [0/0] 1.16s 62.4Kb docs_0_60/your-project.pdf
X [0] /docs_0_80/upgrading_08.html BROKEN: No pipeline matched...
* [213/164] [0/0] 0.391s 29.2Kb docs_0_70/howto/howto-buildPlugin.pdf
^ apidocs/index.html
* [214/170] [7/66] 1.476s 45.5Kb docs_0_60/sitemap-ref.html
-...]]></source>
+...]]>
+ </source>
<ul>
<li>Column 1 is the page build status (*=okay X=brokenLink ^=pageSkipped).</li>
<li>Column 2 is the page count - the number of pages processed and the number remaining. The latter will change because during processing one page, Cocoon will discover more.</li>
@@ -557,12 +747,18 @@
<question> 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. </question>
<answer>
- <p> If you are using JDK 1.4.0 or newer, you can enable <em>headless</em> operation by
- running Forrest with the <code>forrest.jvmarg</code> parameter set to
- <code>-Djava.awt.headless=true</code>, like this: </p>
+ <p>
+ If you are using JDK 1.4.0 or newer, you can enable <em>headless</em>
+ operation by running Forrest with the <code>forrest.jvmarg</code>
+ parameter set to <code>-Djava.awt.headless=true</code>, like this:
+ </p>
<source>forrest -Dforrest.jvmargs=-Djava.awt.headless=true site</source>
- <p> See also <link href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html"
- >Cocoon FAQ</link>. </p>
+ <p>
+ See also
+ <link href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html"
+ >Cocoon
+ FAQ</link>.
+ </p>
</answer>
</faq>
<faq id="project-logo-svg">
@@ -571,15 +767,16 @@
</question>
<answer>
<p>
- In a 'forrest seed site' the project and the group logo are generated from a
- Scalable Vector Graphics (SVG) file, using the text from the
- <code><project-name></code> and
- <code><group-name></code> elements of the <code>skinconf.xml</code> file.
- If you have a long project-name then you may need to adjust the width of the image.
+ In a 'forrest seed site' the project and the group logo are generated
+ from a Scalable Vector Graphics (SVG) file, using the text from the
+ <code><project-name></code> and <code><group-name></code>
+ elements of the <code>skinconf.xml</code> file. If you have a long
+ project-name then you may need to adjust the width of the image.
Perhaps you want to change the colours too. Edit the file at
- <code>src/documentation/content/xdocs/images/project.svg</code> and adjust the "width"
- attribute of the <svg> element. For further details see
- <link href="http://www.w3.org/Graphics/SVG/">SVG</link> resources.
+ <code>src/documentation/content/xdocs/images/project.svg</code> and
+ adjust the "width" attribute of the <svg> element. For further
+ details see <link href="http://www.w3.org/Graphics/SVG/">SVG</link>
+ resources.
</p>
</answer>
</faq>
@@ -587,74 +784,108 @@
<question> How do i configure my favourite XML editor or parser to find the local Forrest
DTDs? </question>
<answer>
- <p> Notes are provided for various tools at <link href="site:v0.70//catalog">Using Catalog Entity
- Resolver for local DTDs</link>. </p>
+ <p>
+ Notes are provided for various tools at
+ <link href="site:v0.70//catalog">Using Catalog Entity Resolver for
+ local DTDs</link>.
+ </p>
</answer>
</faq>
<faq id="skin">
<question> How to make the site look better and change its skin? </question>
<answer>
- <p> There are <link href="site:v0.70//skins">default skins</link> provided, which are configurable
- and so should meet the needs of most projects. The aim is to provide many capabilities so
- that extra skins are not needed. </p>
- <p> See notes about <link href="site:v0.70//your-project/skins">configuration</link> of the skins.
- Some projects may have special needs and can define their <link
- href="site:v0.70//your-project/new-skin">own skin</link>. </p>
+ <p>
+ There are <link href="site:v0.70//skins">default skins</link>
+ provided, which are configurable and so should meet the needs of most
+ projects. The aim is to provide many capabilities so that extra skins
+ are not needed.
+ </p>
+ <p>
+ See notes about
+ <link href="site:v0.70//your-project/skins">configuration</link> of
+ the skins. Some projects may have special needs and can define their
+ <link
+ href="site:v0.70//your-project/new-skin">own
+ skin</link>.
+ </p>
</answer>
</faq>
<faq id="xsp">
<question>How do I enable <acronym title="eXtensible Server Pages">XSP</acronym> processing?</question>
<answer>
- <p>First consider whether your needs would be better met by Cocoon itself, rather than
- Forrest. </p>
- <p>That said, there are valid reasons for wanting programmatically generated content, so
- here is how to enable XSP:</p>
+ <p>
+ First consider whether your needs would be better met by Cocoon
+ itself, rather than Forrest.
+ </p>
+ <p>
+ That said, there are valid reasons for wanting programmatically
+ generated content, so here is how to enable XSP:
+ </p>
<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&content-type=application/java"
>jdtcore-2.1.0.jar</link>, and copy it to the $FORREST_HOME/main/webapp/WEB-INF/lib
directory (or lib/core/ directory in the source distribution).</li>
- <li>
- <p> Add the following generator definition in the map:generators section of your <link
- href="site:v0.70//project-sitemap">project sitemap</link>
+ <li><p>
+ Add the following generator definition in the map:generators
+ section of your
+ <link
+ href="site:v0.70//project-sitemap">project
+ sitemap</link>
</p>
- <source><![CDATA[
+ <source>
+<![CDATA[
<map:generator name="serverpages"
pool-grow="2" pool-max="32" pool-min="4"
- src="org.apache.cocoon.generation.ServerPagesGenerator"/>]]></source>
- </li>
- <li>
- <p>Decide how you want to use XSP. For single files, you could just define a *.xml
- matcher:</p>
- <source><![CDATA[
+ src="org.apache.cocoon.generation.ServerPagesGenerator"/>]]>
+ </source></li>
+ <li><p>
+ Decide how you want to use XSP. For single files, you could just
+ define a *.xml matcher:
+ </p>
+ <source>
+<![CDATA[
<map:match pattern="dynamic.xml">
<map:generate src="content/xdocs/dynamic.xsp" type="serverpages"/>
...
<map:serialize type="xml"/>
-</map:match>]]></source>
- <p>You may instead wish to override forrest.xmap to define a general mapping for
- XSPs.</p>
- </li>
+</map:match>]]>
+ </source>
+ <p>
+ You may instead wish to override forrest.xmap to define a general
+ mapping for XSPs.
+ </p></li>
</ol>
- <p>See also the <link href="http://wiki.apache.org/cocoon/AddingXSPToForrest"
- >AddingXSPToForrest</link> Wiki page.</p>
+ <p>
+ See also the
+ <link href="http://wiki.apache.org/cocoon/AddingXSPToForrest"
+ >AddingXSPToForrest</link>
+ Wiki page.
+ </p>
</answer>
</faq>
<faq id="breadcrumbs">
<question>How do breadcrumbs work? Why don't they work locally?</question>
<answer>
- <p>Breadcrumbs begin with up to three URLs specified in <code>skinconf.xml</code>. Here is
- what the Forrest site uses:</p>
- <source><![CDATA[
+ <p>
+ Breadcrumbs begin with up to three URLs specified in
+ <code>skinconf.xml</code>. Here is what the Forrest site uses:
+ </p>
+ <source>
+<![CDATA[
<trail>
<link1 name="apache" href="http://www.apache.org/"/>
<link2 name="xml.apache" href="http://xml.apache.org/"/>
<link3 name="" href=""/>
- </trail>]]></source>
- <p>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 <code>skinconf.xml</code>. </p>
+ </trail>]]>
+ </source>
+ <p>
+ 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 <code>skinconf.xml</code>.
+ </p>
</answer>
</faq>
<faq id="run_port">
@@ -663,8 +894,10 @@
<p>
<code>forrest run -Dforrest.jvmargs="-Djetty.port=80"</code>
</p>
- <p>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 <code>forrest run</code>
+ <p>
+ 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 <code>forrest run</code>
</p>
</answer>
</faq>
@@ -674,13 +907,16 @@
<faq id="old_claimed_patterns">
<question>Some of my files are not being processed because they use common filenames. </question>
<answer>
- <p> Certain patterns are claimed by the default sitemaps for special processing. These
- include: <code>site, changes, todo, faq, images, my-images, skinconf, community,
- howto</code>
- </p>
- <p> 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 (<link href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</link>).
+ <p>
+ Certain patterns are claimed by the default sitemaps for special
+ processing. These include: <code>site, changes, todo, faq, images,
+ my-images, skinconf, community, howto</code>
+ </p>
+ <p>
+ 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
+ (<link href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</link>).
</p>
</answer>
</faq>
@@ -690,33 +926,45 @@
<faq id="generating_menus">
<question>What is the relationship between &s; and <code>book.xml</code>? </question>
<answer>
- <p> One &s; file in your project root can replace all the book.xml files (one per
- directory) in your site. Internally, Forrest uses &s; 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
- &s;-generated menus aren't appropriate. See <link href="site:v0.70//linking">Menus and
- Linking</link>. </p>
+ <p>
+ One &s; file in your project root can replace all the book.xml files
+ (one per directory) in your site. Internally, Forrest uses &s; 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 &s;-generated menus aren't appropriate. See
+ <link href="site:v0.70//linking">Menus and Linking</link>.
+ </p>
</answer>
</faq>
<faq id="docbook">
<question> How do I use DocBook as the xml documentation format? </question>
<answer>
- <p> There are two ways. Forrest has a <code>simplifiedDocbook</code> 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. </p>
- <p> The other way is to use the full DocBook stylesheets directly. The 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 accordingly. You will need to create a <link href="site:v0.70//project-sitemap">project
- sitemap</link> as explained in <link href="site:v0.70//your-project">Using Forrest</link> 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 available. </p>
- <source><![CDATA[<?xml version="1.0"?>
+ <p>
+ There are two ways. Forrest has a <code>simplifiedDocbook</code>
+ 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.
+ </p>
+ <p>
+ The other way is to use the full DocBook stylesheets directly. The
+ 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
+ accordingly. You will need to create a
+ <link href="site:v0.70//project-sitemap">project sitemap</link> as
+ explained in <link href="site:v0.70//your-project">Using
+ Forrest</link> 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 available.
+ </p>
+ <source>
+<![CDATA[<?xml version="1.0"?>
<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0">
<map:pipelines>
<map:pipeline>
@@ -728,66 +976,99 @@
</map:match>
</map:pipeline>
</map:pipelines>
-</map:sitemap>]]></source>
- <p>You need to define the xhtml serializer used in <map:serialize type="xhtml"/>
- in the components section of the sitemap. See the
- <link href="http://cocoon.apache.org/2.1/userdocs/serializers/xhtml-serializer.html">Cocoon
- docs</link> for the elements you need to add to define this component. You can see examples
- of other components being added in the <code>FORREST_HOME/main/webapp/sitemap.xmap</code> file.</p>
- <p> You can also use a mixture of the two methods, some handled automatically by Forrest and
- some directly using DocBook stylesheets. You can also have a mixture of source files as
- "document-v*" DTD and DocBook. </p>
- <p> 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 Forrest. If you need to use
- different DTDs, then see <link href="site:v0.70//your-project/new_dtd">Using Forrest</link> for
- configuration guidance. </p>
+</map:sitemap>]]>
+ </source>
+ <p>
+ You need to define the xhtml serializer used in <map:serialize
+ type="xhtml"/> in the components section of the sitemap. See the
+ <link href="http://cocoon.apache.org/2.1/userdocs/serializers/xhtml-serializer.html">Cocoon
+ docs</link> for the elements you need to add to define this component.
+ You can see examples of other components being added in the
+ <code>FORREST_HOME/main/webapp/sitemap.xmap</code> file.
+ </p>
+ <p>
+ You can also use a mixture of the two methods, some handled
+ automatically by Forrest and some directly using DocBook stylesheets.
+ You can also have a mixture of source files as "document-v*" DTD and
+ DocBook.
+ </p>
+ <p>
+ 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 Forrest. If you need to use different DTDs, then see
+ <link href="site:v0.70//your-project/new_dtd">Using Forrest</link> for
+ configuration guidance.
+ </p>
</answer>
</faq>
<faq id="version">
<question> How to report which version of Forrest is being used and the properties that are
set? </question>
<answer>
- <p> Do <code>'forrest -projecthelp'</code> or <code>'./build.sh'</code> to find the version
- number. </p>
- <p> To list the properties, add "forrest.echo=true" to your forrest.properties file and
- watch the build messages. Doing <code>'forrest -v'</code> will provide verbose build
- messages. </p>
+ <p>
+ Do <code>'forrest -projecthelp'</code> or <code>'./build.sh'</code> to
+ find the version number.
+ </p>
+ <p>
+ To list the properties, add "forrest.echo=true" to your
+ forrest.properties file and watch the build messages. Doing
+ <code>'forrest -v'</code> will provide verbose build messages.
+ </p>
</answer>
</faq>
<faq id="logs">
<question> Where are the log files to find more infomation about errors? </question>
<answer>
- <p> The logfiles are at <code>build/webapp/WEB-INF/logs/</code>
+ <p>
+ The logfiles are at <code>build/webapp/WEB-INF/logs/</code>
</p>
- <p> The log level can be raised with the <code>logkit.xconf</code> configuration. If you are
- using Forrest in the interactive webapp mode (which is generally easiest for debugging
- errors) then see the <code>build/webapp/WEB-INF/logkit.xconf</code> file. If you are
+ <p>
+ The log level can be raised with the <code>logkit.xconf</code>
+ configuration. If you are using Forrest in the interactive webapp mode
+ (which is generally easiest for debugging errors) then see the
+ <code>build/webapp/WEB-INF/logkit.xconf</code> file. If you are
generating a static site (with command-line 'forrest') then copy
- <code>$FORREST_HOME/main/webapp/WEB-INF/logkit.xconf</code> to your project at
- <code>src/documentation/content/conf/logkit.xconf</code> and modify it. See more
- information and efficiency tips with <link
- href="http://wiki.apache.org/cocoon/ExploringTheLogs">Cocoon logging</link>. </p>
- <p> Doing <code>'forrest -v'</code> will provide verbose build messages to the standard
- output. </p>
+ <code>$FORREST_HOME/main/webapp/WEB-INF/logkit.xconf</code> to your
+ project at <code>src/documentation/content/conf/logkit.xconf</code>
+ and modify it. See more information and efficiency tips with
+ <link
+ href="http://wiki.apache.org/cocoon/ExploringTheLogs">Cocoon
+ logging</link>.
+ </p>
+ <p>
+ Doing <code>'forrest -v'</code> will provide verbose build messages to
+ the standard output.
+ </p>
</answer>
</faq>
<faq id="how_can_I_help">
<question> How to help? </question>
<answer>
- <p> Join one of the Forrest project <link href="site:mail-lists">mailing lists</link> and
- tell us what you would like to see improved. We regard all feedback as valuable,
- particularly from newcomers—often, close proximity blinds software developers to
- faults that are obvious to everyone else. Don't be shy! </p>
+ <p>
+ Join one of the Forrest project <link href="site:mail-lists">mailing
+ lists</link> and tell us what you would like to see improved. We
+ regard all feedback as valuable, particularly from
+ newcomers—often, close proximity blinds software developers to
+ faults that are obvious to everyone else. Don't be shy!
+ </p>
</answer>
</faq>
<faq id="patch">
<question> How to contribute a patch? </question>
<answer>
- <p>Please send all contributions via our <link href="site:bugs">issue tracker</link>. Here
- are notes about <link href="site:contrib/patch">making patches</link>. </p>
- <p>More info about contributing can be found at the <link href="site:contrib">Contributing
- to Forrest</link> page. It is always a good idea to check the Forrest <link
- href="site:bugs">issue tracker</link> before diving in. </p>
+ <p>
+ Please send all contributions via our <link href="site:bugs">issue
+ tracker</link>. Here are notes about
+ <link href="site:contrib/patch">making patches</link>.
+ </p>
+ <p>
+ More info about contributing can be found at the
+ <link href="site:contrib">Contributing to Forrest</link> page. It is
+ always a good idea to check the Forrest
+ <link
+ href="site:bugs">issue tracker</link> before diving
+ in.
+ </p>
</answer>
</faq>
</part>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/forrest-contract.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/forrest-contract.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/forrest-contract.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/forrest-contract.xml Mon Apr 9 20:48:52 2007
@@ -16,9 +16,9 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
-<document>
- <header>
- <title>Our Contract</title>
+<document>
+ <header>
+ <title>Our Contract</title>
<notice>The legal tone of this document is just a gimmick, this is not a
legal document in any sense. At all times: since this is open source: the real
contract is described in the implementation details of the full distribution.
@@ -27,28 +27,30 @@
<link href="site:mail-lists">mail list</link> know if
any of the bullets listed here are out of sync with the real
implementation.</notice>
- <abstract>This document describes, in a very techy bullet-style way, how
- to use Forrest.</abstract>
- </header>
- <body>
+ <abstract>
+ This document describes, in a very techy bullet-style way, how to use
+ Forrest.
+ </abstract>
+ </header>
+ <body>
<note>
- This document describes the formal contract between the
- <strong>Forrest distribution code</strong>, hereafter referred as
- "Forrest", and
- the <strong>Project (team)</strong> that is using it for generating
- its documentation and web-site, hereafter referred to as "TheProject".
+ This document describes the formal contract between the <strong>Forrest
+ distribution code</strong>, hereafter referred as "Forrest", and the
+ <strong>Project (team)</strong> that is using it for generating its
+ documentation and web-site, hereafter referred to as "TheProject".
</note>
<note>
Some terminology will assist: <code>{docroot}</code> is the location
inside TheProject's file hierarchy where all documentation related
resources are stored. Usually <code>{docroot}</code> equals to
<code>{projecthome}/src/documentation</code>
- </note>
-
- <section id="forrest-will">
- <title>Forrest will:</title>
- <p>Provide infrastructure ...</p>
- <ul>
+ </note>
+ <section id="forrest-will">
+ <title>Forrest will:</title>
+ <p>
+ Provide infrastructure ...
+ </p>
+ <ul>
<li>Provide document type definitions (DTDs), skins, default sitemaps,
Cocoon pipelines.
</li>
@@ -56,50 +58,49 @@
<link href="site:mail-lists">mail list</link>.
</li>
<li>Use Cocoon to generate the HTML and PDF documentation for
- TheProject.</li>
+ TheProject.</li>
</ul>
</section>
-
<section id="project-must">
- <title>TheProject must:</title>
- <p>Provide content and configuration ...</p>
- <ul>
+ <title>TheProject must:</title>
+ <p>
+ Provide content and configuration ...
+ </p>
+ <ul>
<li>Provide XML content in <code>{docroot}/content/xdocs</code>
according to the Forrest DTDs or one of the other input formats.
- </li>
- <li>Provide navigation metadata using the configuration files
- <code>site.xml</code> and <code>tabs.xml</code>
</li>
+ <li>Provide navigation metadata using the configuration files
+ <code>site.xml</code> and <code>tabs.xml</code></li>
<li>Provide the skin configuation file in
- <code>{projecthome}/skinconf.xml</code>
- </li>
- </ul>
- </section>
-
+ <code>{projecthome}/skinconf.xml</code></li>
+ </ul>
+ </section>
<section id="project-can">
- <title>TheProject can:</title>
- <p>Add extra abilities ...</p>
- <ul>
+ <title>TheProject can:</title>
+ <p>
+ Add extra abilities ...
+ </p>
+ <ul>
<li>Provide its own skin in
<code>{docroot}/skins/{your-skin-name}</code> (Check the current
Forrest skins and the related pipelines to see what they are doing.
Bear in mind that the provided skins are able to be configured and
- may already meet your needs.)</li>
+ may already meet your needs.)</li>
<li>Provide own DTDs to handle other specialised document types in
- <code>{docroot}/resources/schema/dtd</code>
- <ul>
+ <code>{docroot}/resources/schema/dtd</code>
+ <ul>
<li>and extra stylesheets to convert own grammar to the
- intermediate 'document' structure.</li>
+ intermediate 'document' structure.</li>
<li>and declare those extra DTDs in
- <code>{docroot}/resources/schema/catalog.xcat</code></li>
- </ul>
- </li>
+ <code>{docroot}/resources/schema/catalog.xcat</code></li>
+ </ul></li>
<li>Provide its own overwriting versions of sitemaps
(<code>{docroot}/sitemap.xmap</code> and other *.xmap files)
... (be sure you know what you are doing since you are then leaving
the area where other Forresters can help you out.
- </li>
- </ul>
- </section>
+ </li>
+ </ul>
+ </section>
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/book.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/book.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/book.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/howto/bugzilla-patch/book.xml Mon Apr 9 20:48:52 2007
@@ -16,16 +16,11 @@
limitations under the License.
-->
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "http://forrest.apache.org/dtd/book-cocoon-v10.dtd">
-
<book software="Forrest"
title="Forrest"
copyright="Copyright 2002-2005 The Apache Software Foundation or its licensors, as applicable"
xmlns:xlink="http://www.w3.org/1999/xlink">
-
- <menu label="How-Tos">
+ <menu label="How-Tos">
<menu-item label="Index" href="../index.html"/>
</menu>
-
-
-
</book>