shannon 2002/08/21 18:32:42
Modified: src/documentation/xdocs Tag: cocoon_2_0_3_branch book.xml
index.xml
src/documentation/xdocs/faq Tag: cocoon_2_0_3_branch
faq-aggregators.xml faq-configure-c2.xml
faq-databases.xml faq-sitemap.xml faq-xslt.xml
src/documentation/xdocs/link Tag: cocoon_2_0_3_branch
books.xml livesites.xml
src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
doc.xml
src/documentation/xdocs/userdocs/concepts Tag:
cocoon_2_0_3_branch catalog.xml sitemap.xml
Added: src/documentation/xdocs Tag: cocoon_2_0_3_branch news.xml
Log:
sync documentation with HEAD branch docs
Revision Changes Path
No revision
No revision
1.8.2.5 +1 -0 xml-cocoon2/src/documentation/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/book.xml,v
retrieving revision 1.8.2.4
retrieving revision 1.8.2.5
diff -u -r1.8.2.4 -r1.8.2.5
--- book.xml 7 Jun 2002 20:14:37 -0000 1.8.2.4
+++ book.xml 22 Aug 2002 01:32:41 -0000 1.8.2.5
@@ -8,6 +8,7 @@
<menu label="About">
<menu-item label="Index" href="index.html"/>
+ <menu-item label="News" href="news.html"/>
<menu-item label="License" href="license.html"/>
<external label="Download" href="http://xml.apache.org/cocoon/dist/"/>
</menu>
1.7.2.5 +5 -0 xml-cocoon2/src/documentation/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/index.xml,v
retrieving revision 1.7.2.4
retrieving revision 1.7.2.5
diff -u -r1.7.2.4 -r1.7.2.5
--- index.xml 15 Jun 2002 17:16:35 -0000 1.7.2.4
+++ index.xml 22 Aug 2002 01:32:41 -0000 1.7.2.5
@@ -40,6 +40,11 @@
go to the <link href="http://xml.apache.org/cocoon1/";>Cocoon 1.x area</link>.
</p>
</s1>
+ <s1 title="More News about Cocoon">
+ <p>
+Check out our <link href="news.html">news page</link> for more up-to-date news
about Cocoon.
+ </p>
+ </s1>
<figure src="images/cocoon-built.gif" alt="Built with Apache Cocoon"/>
</body>
</document>
No revision
No revision
1.2.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/news.xml
Index: news.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/news.xml,v
retrieving revision 1.2
retrieving revision 1.2.2.1
diff -u -r1.2 -r1.2.2.1
No revision
No revision
1.1.2.2 +10 -2 xml-cocoon2/src/documentation/xdocs/faq/faq-aggregators.xml
Index: faq-aggregators.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/faq/faq-aggregators.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- faq-aggregators.xml 7 Jun 2002 19:45:13 -0000 1.1.2.1
+++ faq-aggregators.xml 22 Aug 2002 01:32:41 -0000 1.1.2.2
@@ -41,7 +41,15 @@
</answer>
</faq>
-
-
+<faq>
+ <question>
+ Where can I learn more about content aggregation?
+ </question>
+ <answer>
+ <p>
+Learn more about content aggregation by downloading the free chapter, <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>A User's Look at the Cocoon architecture,</link> from Langham and Ziegler's
<em>Cocoon: Building XML Applications</em> available at the New Riders web site.
+ </p>
+ </answer>
+</faq>
</faqs>
1.1.2.3 +4 -1 xml-cocoon2/src/documentation/xdocs/faq/faq-configure-c2.xml
Index: faq-configure-c2.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/faq/faq-configure-c2.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- faq-configure-c2.xml 3 Jul 2002 22:47:50 -0000 1.1.2.2
+++ faq-configure-c2.xml 22 Aug 2002 01:32:41 -0000 1.1.2.3
@@ -42,7 +42,7 @@
<p>1. <code>{cocoon}/WEB-INF/logkit.xconf</code>:</p>
<p>Please refer to the Avalon Excalibur Documentation:
<link href="http://jakarta.apache.org/avalon/excalibur/logger.html";>
- Avalon Excalibur LogKit Management</link></p>
+ Avalon Excalibur LogKit Management</link> </p>
<p>2. <code>{cocoon}/WEB-INF/web.xml</code>:</p>
<p>Here you can change following paramters:</p>
<ul>
@@ -62,6 +62,9 @@
importance.</li>
</ul>
<note>See inline comments in these files for further information!</note>
+ <p>
+Learn more about LogKit configuration by downloading the free chapter, <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>A User's Look at the Cocoon architecture,</link> from Langham and Ziegler's
<em>Cocoon: Building XML Applications</em> available at the New Riders web site.
+ </p>
</answer>
</faq>
1.1.2.3 +11 -0 xml-cocoon2/src/documentation/xdocs/faq/faq-databases.xml
Index: faq-databases.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/faq/faq-databases.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- faq-databases.xml 18 Jun 2002 15:48:34 -0000 1.1.2.2
+++ faq-databases.xml 22 Aug 2002 01:32:41 -0000 1.1.2.3
@@ -116,4 +116,15 @@
</answer>
</faq>
+<faq>
+ <question>
+ Where can I find more information about connecting to databases using Cocoon?
+ </question>
+ <answer>
+ <p>
+Learn more about connecting to databases by downloading the free chapter, <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>A User's Look at the Cocoon architecture,</link> from Langham and Ziegler's
<em>Cocoon: Building XML Applications</em> available at the New Riders web site.
+ </p>
+</answer>
+</faq>
+
</faqs>
1.4.2.4 +14 -0 xml-cocoon2/src/documentation/xdocs/faq/faq-sitemap.xml
Index: faq-sitemap.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/faq/faq-sitemap.xml,v
retrieving revision 1.4.2.3
retrieving revision 1.4.2.4
diff -u -r1.4.2.3 -r1.4.2.4
--- faq-sitemap.xml 10 Jul 2002 19:19:25 -0000 1.4.2.3
+++ faq-sitemap.xml 22 Aug 2002 01:32:41 -0000 1.4.2.4
@@ -264,4 +264,18 @@
</ul>
</answer>
</faq>
+
+ <faq>
+ <question>
+Where can I find more information about the sitemap?
+ </question>
+ <answer>
+ <p>
+Learn more about advanced Sitemap features by downloading the free chapter, <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>A User's Look at the Cocoon architecture,</link> from Langham and Ziegler's
<em>Cocoon: Building XML Applications</em> available at the New Riders web site.
+ </p>
+ <p>
+Check out a draft XML Schema <link
href="http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-cocoon2/src/documentation/xdocs/drafts/sitemap-2.1-draft.xsd?rev=HEAD&content-type=text/plain";>grammar
for the Cocoon sitemap</link>, and some <link
href="http://outerthought.net/sitemap/";>external documentation</link> generated from
this Schema. A poster diagram of the sitemap structure is also available.
+ </p>
+ </answer>
+ </faq>
</faqs>
1.2.2.4 +62 -0 xml-cocoon2/src/documentation/xdocs/faq/faq-xslt.xml
Index: faq-xslt.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/faq/faq-xslt.xml,v
retrieving revision 1.2.2.3
retrieving revision 1.2.2.4
diff -u -r1.2.2.3 -r1.2.2.4
--- faq-xslt.xml 3 Jul 2002 22:47:50 -0000 1.2.2.3
+++ faq-xslt.xml 22 Aug 2002 01:32:41 -0000 1.2.2.4
@@ -138,5 +138,67 @@
</answer>
</faq>
+<faq>
+ <question>
+What's "wrong" with use of the document() function in Cocoon?
+ </question>
+
+ <answer>
+ <p>
+Using the document() function for aggregation in Cocoon may break
+Separation of Concerns (SoC). That is, the designers of Cocoon
+view inclusion and transformation as different functions, best
+handled by separate Cocoon components. Treating them
+separately allows you to achieve performance gains and increases
+the resusability of your pipelines.
+ </p>
+ <p>
+Alternatives to the document() in the Cocoon environment include
+aggregation or the use of a multi-stage transformation using the
+XInclude Transformer. This involves transforming a list of documents
+(generated dynamically or statically) by adding xinclude elements which
+reference (via xpointer) specific document content, and then transforming
+again via the XInclude Transformer, to obtain the desired result. For an example of
this, see this <link
href="http://marc.theaimsgroup.com/?l=xml-cocoon-users&m=102617106411067&w=2";>email.</link>
+ </p>
+ <p>
+You'll achieve better performance if you aggregate content prior to transformation.
+This allows you to take full advantage of Cocoon's pipeline caching. In contrast,
+making dynamic document() calls inside an XSLT within a cached pipeline is
problematic.
+At this time, Cocoon does not recognize changes in documents (called by the
document() function)
+until the requested page expires from cache.
+ </p>
+ <p>
+Understand that the document() function was designed *before* xinclude
+with xpointer facilities existed. Had such capabilities been available,
+perhaps the document() function, which essentially mimics xinclude and xpointer,
+would have never been added to XSLT.
+ </p>
+ <p>
+Please note that if you must work with your XML files outside of the
+Cocoon environment, you may need to use the document() function
+in order to utilize the limited capabilities of other pipeline engines.
+This includes engines which are not xinclude-capable or which
+lack a predefined way to indicate document processing steps. If you
+are working with legacy code from non-pipelined engines, you may need to use
+the document() function as well, at least initially.
+ </p>
+ <p>
+If you do use the document() function in Cocoon, you can still observe SoC by
+having separate XSLT stylesheets perform inclusion and transformation functions.
+For example, you can put multiple XSLT transforms in a pipeline and have the
+first one perform inclusion and the second one perform transformation. However,
+be mindful of some unresolved caching issues in Cocoon related to the document()
function.
+At this time, Cocoon is unable to check validity of content included via the
document()
+function. In addition, the document() function implemented by Xalan is inefficient.
See:
+ http://nagoya.apache.org/bugzilla/show_bug.cgi?id=4257
+Until this bug is fixed, consider using Saxon instead for document()
function-related parsing
+needs.
+ </p>
+ <p>
+For other aggregation/inclusion approaches, please stay tuned for
XpathDirectoryGenerator (2.1 scratchpad),
+as well as Forrest's Libre (currently alpha in the Forrest cvs).
+ </p>
+ </answer>
+ </faq>
</faqs>
No revision
No revision
1.2.2.4 +3 -2 xml-cocoon2/src/documentation/xdocs/link/books.xml
Index: books.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/link/books.xml,v
retrieving revision 1.2.2.3
retrieving revision 1.2.2.4
diff -u -r1.2.2.3 -r1.2.2.4
--- books.xml 31 Jul 2002 02:35:31 -0000 1.2.2.3
+++ books.xml 22 Aug 2002 01:32:41 -0000 1.2.2.4
@@ -20,9 +20,10 @@
<strong>Availability:</strong> July 2002<br/>
<strong>Paperback:</strong> 504 pages<br/>
<strong>Publisher:</strong> New Riders Publishing<br/>
-<strong>ISBN:</strong> 0735712352
+<strong>ISBN:</strong> 0735712352<br/>
+Please note that you can download several <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>free chapters</link> at the New Riders web site.
</li>
-<li><link href="http://www.amazon.com/exec/obidos/ASIN/0672322579/";>Cocoon
Developer's Handbook</link> (Jeremy Aston)<br/>
+<li><link href="http://www.amazon.com/exec/obidos/ASIN/0672322579/";>Cocoon
Developer's Handbook</link> (Jeremy Aston, Lajos Moczar)<br/>
<strong>Availability:</strong> September 2002<br/>
<strong>Paperback:</strong> 500 pages<br/>
<strong>Publisher:</strong> Sams<br/>
1.1.2.9 +1 -0 xml-cocoon2/src/documentation/xdocs/link/livesites.xml
Index: livesites.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/link/livesites.xml,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -r1.1.2.8 -r1.1.2.9
--- livesites.xml 21 Aug 2002 05:00:29 -0000 1.1.2.8
+++ livesites.xml 22 Aug 2002 01:32:41 -0000 1.1.2.9
@@ -21,6 +21,7 @@
<ul>
<li><link href="http://sunshine.s-und-n.de/";>SunShine Portal Demo</link></li>
+ <li><link href="http://www.sirvisetti.com/uddi/";>Sirvisetti UDDI Registrar WAP
site</link></li>
<li><link href="http://www.xslt-patterns.com/";>XSLTPatterns.com</link></li>
<li><link href="http://www.adolos.com/";>Adolos</link></li>
<li><link href="http://outerthought.org/";>Outerthought</link></li>
No revision
No revision
1.1.2.5 +16 -2 xml-cocoon2/src/documentation/xdocs/plan/doc.xml
Index: doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/doc.xml,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- doc.xml 11 Jul 2002 05:32:14 -0000 1.1.2.4
+++ doc.xml 22 Aug 2002 01:32:42 -0000 1.1.2.5
@@ -24,8 +24,8 @@
<s2 title="Cocoon Docs List">
<p>
Find out what documentation efforts are already in process among other users
-and committers. First and foremost, join the
-cocoon-docs <link href="../mail-lists.html">mailing list</link>.
+and committers. Consider joining the
+cocoon-docs <link href="../mail-lists.html">mailing list</link>.
</p>
</s2>
@@ -39,6 +39,20 @@
<li><link href="../howto/howto-author-snippet.html">How to Author a Code
Snippet</link></li>
<li><link href="../howto/howto-author-core-docs.html">How to Author Core
Documentation</link></li>
</ul>
+ </s2>
+
+ <s2 title="Cocoon Wikis">
+ <p>
+Cocoon has two promising and complementary wiki efforts underway.
+</p>
+ <ul>
+ <li>
+<link href="http://www.outerthought.net/wiki/";>Cocoon Wiki</link> focuses on
content development for the Cocoon project. It is designed to facilitate document
development and collaboration from all levels of Cocoon users. Documents include FAQs,
snippets, how-tos, tutorials, RTs (random thoughts), dreams, surveys, and more. The
preliminary focus of this the wiki is to serve as a documentation "breeding ground,"
where docs can "grow" until mature enough to become official cvs docs. However, it
already represents a lively and valid document resource in its own right.
+ </li>
+ <li>
+<link href="http://www.anyware-tech.com/wikiland/";>Wikiland</link> is an ongoing
development effort to build a Cocoon-based wiki architecture. Wikiland features a
Cocoon dictionary as the pretext to use, test and develop the wiki. The project is
seeking Cocoon-oriented developers to further its development. For more information,
see the <link href="http://rossel.free.fr/"; >Wikiland home page.</link>
+ </li>
+ </ul>
</s2>
<s2 title="Other Information">
No revision
No revision
1.2.2.7 +6 -7
xml-cocoon2/src/documentation/xdocs/userdocs/concepts/catalog.xml
Index: catalog.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/catalog.xml,v
retrieving revision 1.2.2.6
retrieving revision 1.2.2.7
diff -u -r1.2.2.6 -r1.2.2.7
--- catalog.xml 13 Jul 2002 03:13:40 -0000 1.2.2.6
+++ catalog.xml 22 Aug 2002 01:32:42 -0000 1.2.2.7
@@ -390,7 +390,7 @@
<p>
A default catalog and some base entities (e.g. ISO*.pen character
entity sets) are included in the Cocoon distribution at
- <code>webapp/resources/entities/</code>
+ <code>WEB-INF/entities/</code>
- the default catalog is automatically loaded when Cocoon starts.
</p>
@@ -410,7 +410,7 @@
<s2 title="Using cocoon.xconf">
<p>Parameters (properties) for the resolver component can be specified in the
- <code>java/org/apache/cocoon/components/resolver/resolver.xconf</code>
+ <code>src/webapp/WEB-INF/cocoon.xconf</code>
configuration file. See the detailed internal notes - here is a precis.
</p>
@@ -438,11 +438,10 @@
</p>
<p>
- The build process will automatically copy the properties file from
-<code>$COCOON_HOME/webapp/resources/entities/CatalogManager.properties</code>
- to
-<code>$TOMCAT_HOME/webapps/cocoon/WEB-INF/classes/CatalogManager.properties</code>
- thereby making it available to the Java classpath.
+ The file is at
+<code>webapp/WEB-INF/classes/CatalogManager.properties</code>
+ thereby making it available to the Java classpath during startup of the
+ servlet engine.
</p>
<p>
1.3.2.7 +8 -5
xml-cocoon2/src/documentation/xdocs/userdocs/concepts/sitemap.xml
Index: sitemap.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/sitemap.xml,v
retrieving revision 1.3.2.6
retrieving revision 1.3.2.7
diff -u -r1.3.2.6 -r1.3.2.7
--- sitemap.xml 2 Aug 2002 01:55:56 -0000 1.3.2.6
+++ sitemap.xml 22 Aug 2002 01:32:42 -0000 1.3.2.7
@@ -1162,11 +1162,14 @@
</s2>
</s1>
- <s1 title="Additional information">
- <p>
- Also there is a draft XML Schema <link
href="http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-cocoon2/src/documentation/xdocs/drafts/sitemap-2.1-draft.xsd?rev=HEAD&content-type=text/plain";>grammar
for the Cocoon sitemap</link>, and some <link
href="http://outerthought.net/sitemap/";>external documentation</link>
- generated from this Schema. There you will also find a poster diagram of
- the sitemap structure.
+ <s1 title="Additional resources">
+ <p>
+Learn more about advanced Sitemap features by downloading the free chapter, <link
href="http://www.newriders.com/books/product.asp?product_id={C3C05052-BE3B-4E06-A60A-13FB40AF58F6}";
>A User's Look at the Cocoon architecture,</link> from Langham and Ziegler's
<em>Cocoon: Building XML Applications</em> available at the New Riders web site.
+ </p>
+ <p>
+ Check out a draft XML Schema <link
href="http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-cocoon2/src/documentation/xdocs/drafts/sitemap-2.1-draft.xsd?rev=HEAD&content-type=text/plain";>grammar
for the Cocoon sitemap</link>, and some <link
href="http://outerthought.net/sitemap/";>external documentation</link>
+ generated from this Schema. A poster diagram of
+ the sitemap structure is also available.
</p>
</s1>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
