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 2005/04/17 03:47:44 UTC
svn commit: r161615 - in forrest/trunk/site-author/content/xdocs:
docs/faq.xml docs/upgrading_05.xml docs/upgrading_07.xml site.xml
Author: crossley
Date: Sat Apr 16 18:47:42 2005
New Revision: 161615
URL: http://svn.apache.org/viewcvs?view=rev&rev=161615
Log:
Add a new FAQ about the Cocoon cli.xconf
Modified:
forrest/trunk/site-author/content/xdocs/docs/faq.xml
forrest/trunk/site-author/content/xdocs/docs/upgrading_05.xml
forrest/trunk/site-author/content/xdocs/docs/upgrading_07.xml
forrest/trunk/site-author/content/xdocs/site.xml
Modified: forrest/trunk/site-author/content/xdocs/docs/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/faq.xml?view=diff&r1=161614&r2=161615
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/faq.xml Sat Apr 16 18:47:42 2005
@@ -391,15 +391,20 @@
</answer>
</faq>
- <faq id="ignoring_javadocs">
+ <faq id="cli-xconf">
<question>
- How do I stop Forrest breaking on links to external files that may not
- exist, like javadocs?
+ How to control the processing of URIs by Cocoon, e.g. exclude
+ certain URIs, include other additional ones.
</question>
<answer>
<p>
- This can be done by overriding the <code>cli.xconf</code> config file,
- and defining patterns for URLs to exclude.
+ 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>
@@ -434,6 +439,20 @@
<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>
</answer>
</faq>
Modified: forrest/trunk/site-author/content/xdocs/docs/upgrading_05.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/upgrading_05.xml?view=diff&r1=161614&r2=161615
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/upgrading_05.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/upgrading_05.xml Sat Apr 16 18:47:42 2005
@@ -149,7 +149,7 @@
<strong>does not use filterlinks.xsl</strong>. Instead, patterns for
command-line inclusion and exclusion can be specified in cli.xconf,
as described in
- <link href="site:faq/ignoring_javadocs">this FAQ entry</link>. There is
+ <link href="site:faq/cli-xconf">this FAQ entry</link>. There is
already a default cli.xconf but you can over-ride that with your own if
needed by copying <code>resources/conf/cli.xconf</code> from the Forrest
distribution into your project's top-level directory.
Modified: forrest/trunk/site-author/content/xdocs/docs/upgrading_07.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/upgrading_07.xml?view=diff&r1=161614&r2=161615
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/upgrading_07.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/upgrading_07.xml Sat Apr 16 18:47:42 2005
@@ -147,7 +147,7 @@
then place them in the src/documentation/content/ directories and
add an entry to conf/cli.xconf to exclude them from processing.
An FAQ describes the use of Cocoon's
- <a href="faq.html#ignoring_javadocs">cli.xconf</a>
+ <a href="faq.html#cli-xconf">cli.xconf</a>
</p>
</section>
Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/site.xml?view=diff&r1=161614&r2=161615
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Sat Apr 16 18:47:42 2005
@@ -34,6 +34,7 @@
<ignoring_javadocs href="#ignoring_javadocs"/>
<link_raw href="#link_raw"/>
<pdf_images href="#pdf_images"/>
+ <cli-xconf href="#cli-xconf"/>
</faq>
<changes label="Changes" href="changes.html"/>
<changes-rss href="changes.rss"/>