shannon 2002/10/18 11:17:52
Modified: src/documentation/xdocs Tag: cocoon_2_0_3_branch book.xml
performancetips.xml
src/documentation/xdocs/developing/webapps Tag:
cocoon_2_0_3_branch session.xml
src/documentation/xdocs/howto Tag: cocoon_2_0_3_branch
book.xml
src/documentation/xdocs/howto/xmlform-wizard Tag:
cocoon_2_0_3_branch howto-xmlform-wizard-1.xml
src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
changes-doc.xml release.xml
src/documentation/xdocs/userdocs/generators Tag:
cocoon_2_0_3_branch book.xml
src/documentation/xdocs/userdocs/transformers Tag:
cocoon_2_0_3_branch cinclude-transformer.xml
Added: src/documentation/xdocs Tag: cocoon_2_0_3_branch
bylaws-addendum.xml
src/documentation/xdocs/userdocs/generators Tag:
cocoon_2_0_3_branch wsproxy-generator.xml
Log:
Sync relevant docs with HEAD
in preparation for live site update.
Revision Changes Path
No revision
No revision
1.8.2.6 +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.5
retrieving revision 1.8.2.6
diff -u -r1.8.2.5 -r1.8.2.6
--- book.xml 22 Aug 2002 01:32:41 -0000 1.8.2.5
+++ book.xml 18 Oct 2002 18:17:51 -0000 1.8.2.6
@@ -34,6 +34,7 @@
</menu>
<menu label="Community">
+ <menu-item label="Cocoon Bylaws" href="bylaws-addendum.html"/>
<menu-item label="Hall of Fame" href="who.html"/>
<menu-item label="Contributing" href="contrib.html"/>
<menu-item label="Mail Lists" href="mail-lists.html"/>
1.4.2.5 +54 -0 xml-cocoon2/src/documentation/xdocs/performancetips.xml
Index: performancetips.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/performancetips.xml,v
retrieving revision 1.4.2.4
retrieving revision 1.4.2.5
diff -u -r1.4.2.4 -r1.4.2.5
--- performancetips.xml 12 Aug 2002 21:55:46 -0000 1.4.2.4
+++ performancetips.xml 18 Oct 2002 18:17:51 -0000 1.4.2.5
@@ -94,6 +94,51 @@
take more time to process them. In worst case scenario, slowdown up to
10% could be achieved (unscientifical observations, do your own
test).</li>
+
+ <li>
+ <p>
+ Utilize the pipeline <code>expires</code> parameter to dramatically
reduce
+ redundand requests. Even the most dynamic application pages have a
+ reasonable period of time during which they are static.
+ Even if a page doesn't change for just one minute, still use the
+ <code>expires</code> parameter. Here is an example:
+ </p>
+<source><![CDATA[
+<map:pipeline>
+ <map:parameter name="expires" value="access plus 1 minutes"/>
+ ...
+</map:pipeline>
+]]></source>
+ <p>
+ The value of the parameter is in a format borrowed from the Apache
HTTP module mod_expires.
+ Examples of other possible values are:
+ </p>
+<source><![CDATA[
+access plus 1 hours
+access plus 1 month
+access plus 4 weeks
+access plus 30 days
+access plus 1 month 15 days 2 hours
+]]></source>
+ <p>
+ Imagine 1'000 users hitting your web site at the same time.
+ Say that they are split into 5 groups, each of which has the same ISP.
+ Most ISPs use intermediate proxy servers to reduce traffic, hense
+ improving their end user experience and also reducing their operating
costs.
+ In our case the 1'000 end user requests will result in just 5 requests
to Cocoon.
+ </p>
+ <p>
+ After the first request from each group reaches the server, the
expires header will
+ be recognized by the proxy servers which will serve the following
requests from their cache.
+ Keep in mind however that most proxies cache HTTP GET requests, but
will not cache HTTP POST requests.
+ </p>
+ <p>
+ To feel the difference, set an expires parameter on one of your
pipelines and
+ load the page with the browser. Notice that after the first time,
there are no
+ access records in the server logs until the specified time expires.
+ </p>
+
+ </li>
</ul>
</s1>
@@ -143,6 +188,10 @@
<li>Try to keep the size of the documents going through the pipeline
small. To big documents slows down translation.</li>
+
+ <li>Use the <code>expires</code> parameter (see above) as frequently as you
can.
+ It improves the end user experience dramatically. Browsers and
intermediate
+ proxy servers love the HTTP <code>Expires</code> header.</li>
</ul>
</s1>
@@ -184,6 +233,11 @@
<li>How complicated are the XSLT stylesheets? If you are not using global
variables or parameters this will speeds things up.</li>
+
+ <li>Consider using XSLTC instead of Xalan. XSLTC compiles XSLT to bytecode
(translets)
+ the first time a stylesheet is used. Consequently it uses the compiled code
+ which is faster by a magnitude than the interpreted one.</li>
+
</ul>
</s1>
</body>
No revision
No revision
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/bylaws-addendum.xml
Index: bylaws-addendum.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/bylaws-addendum.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
No revision
No revision
1.1.2.3 +27 -27
xml-cocoon2/src/documentation/xdocs/developing/webapps/session.xml
Index: session.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/developing/webapps/session.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- session.xml 16 Aug 2002 07:57:28 -0000 1.1.2.2
+++ session.xml 18 Oct 2002 18:17:52 -0000 1.1.2.3
@@ -198,23 +198,22 @@
</s1>
<s1 title="Special Contexts">
<p>Cocoon creates and maintains special contexts that allow the
- applications to access the environment data. This allows the read-only
access
- to such things as the HttpRequest or the HtppResponse using the same XPath
+ applications to access the environment. This allows the read-only access
+ to such things as the current request or the response using the same XPath
commands previously described. These context do not require any session,
they
- are everytime available.</p>
+ are always available and change on every request.</p>
<s2 title="The Request Context - Accessing the Environment, Part One">
<p>The request context is an XML description of the current
- HttpRequest. This context is a special read only context which can be
accessed
- with the usual commands:</p>
+ (HTTP) request. This context is a special read only context that
+ can be accessed with the usual commands:</p>
<p><em><getxml context="request" path="/parameter"/></em></p>
- <p>If you for example want to get the value of a parameter with the
+ <p>For example, if you want to get the value of a parameter with the
name <em>username</em> you can include the following command in your XML
and it
will be replaced with the value of the parameter:</p>
<p><em><getxml context="request"
path="/parameter/username"/></em></p>
- <p>This command will be replaced with all parameters from the current
- request in XML format. If you wish to obtain the complete querystring as
it was
+ <p>If you wish to obtain the complete querystring as it was
passed into Cocoon - without converting the data to XML - then you can use
the "/querystring" path:</p>
<p><em><getxml context="request"
@@ -224,7 +223,8 @@
<p>The complete context you can access via these commands has the
following XML format:</p>
<source><parameter>
- <!-- All parameters: parameter names build the elements with the values as
text node childs -->
+ <!-- All parameters: parameter names build the elements with the value of the
first parameter with
+ this name as text node child -->
<firstparameter>value of parameter</firstparameter>
<secondparameter>value of parameter</secondparameter>
</parameter>
@@ -233,20 +233,20 @@
(The querystring contains only parameters send by the GET method)
<parametervalues>
- <!-- All parameters. The tags are all inside the session namespace.
- The generated xml can be used without modification for the
- session:connection command. -->
- <session:params>
- <session:param>
- <session:name>1st parameter name</session:name>
- <session:value>1st parameter value</session:value>
- </session:param>
+ <!-- All parameters. The tags are all inside the cinclude transformer
namespace.
+ The generated XML can be used without modification for the
+ cinclude:includexml command. -->
+ <cinclude:parameters>
+ <cinclude:parameter>
+ <cinclude:name>1st parameter name</cinclude:name>
+ <cinclude:value>1st parameter value</cinclude:value>
+ </cinclude:parameter>
...
- <session:param>
- <session:name>2nd parameter name</session:name>
- <session:value>2nd parameter value</session:value>
- </session:param>
- </session:params>
+ <cinclude:parameter>
+ <cinclude:name>2nd parameter name</cinclude:name>
+ <cinclude:value>2nd parameter value</cinclude:value>
+ </cinclude:parameter>
+ </cinclude:parameters>
<!-- If a parameter has more than one value, for each value a
<session:param> block is generated. -->
</parametervalues>
@@ -298,13 +298,13 @@
</s2>
<s2 title="The Response Context - Accessing the Environment, Part Two">
<p>The response context is an XML description of the current
- HttpResponse. This context is a special write only context which can be
+ (HTTP) response. This context is a special write only context that can be
accessed with the usual commands:</p>
<p><em><session:setxml context="response"
path="/header"/></em></p>
<p>This command will be removed from the XML and the information will
- be added to the response. Using the response context headers and cookies
can be
- added.</p>
+ be added to the response. Headers and cookies can be
+ added using the response context .</p>
<s3 title="Adding headers">
<p>Headers can be added either by <em>setxml</em> or by
<em>appendxml</em>. If <em>setxml</em> is used, the header with the
name gets
@@ -337,8 +337,8 @@
<p>The temporary context with the name <em>"temp"</em> is available on
each request. It is independent from the session and has no content when
a new
request starts. It can be used like any other context except that the
content
- is lost when the current response is finished.</p>
- <p>Using the tempory context it is possible to use store any xml
+ is lost/deleted when the current response is finished.</p>
+ <p>Using the tempory context it is possible to store any XML
information for processing the current request.</p>
</s2>
</s1>
No revision
No revision
1.6.2.4 +2 -11 xml-cocoon2/src/documentation/xdocs/howto/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/howto/book.xml,v
retrieving revision 1.6.2.3
retrieving revision 1.6.2.4
diff -u -r1.6.2.3 -r1.6.2.4
--- book.xml 16 Aug 2002 07:57:28 -0000 1.6.2.3
+++ book.xml 18 Oct 2002 18:17:52 -0000 1.6.2.4
@@ -1,36 +1,27 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN"
"../dtd/book-cocoon-v10.dtd">
-
-<book software="Apache Cocoon"
- title="Apache Cocoon HOWTO Documentation"
- copyright="@year@ The Apache Software Foundation">
-
+<book software="Apache Cocoon" title="Apache Cocoon HOWTO Documentation"
copyright="@year@ The Apache Software Foundation">
<menu label="Navigation">
<menu-item label="Main" href="../index.html"/>
</menu>
-
<menu label="How-Tos">
<menu-item label="Index" href="index.html"/>
</menu>
-
<menu label="Using Cocoon">
<menu-item label="XMLForm" href="xmlform-wizard/howto-xmlform-wizard.html"/>
<menu-item label="Paginator" href="howto-paginator-transformer.html"/>
<menu-item label="HTML-PDF" href="howto-html-pdf-publishing.html"/>
+ <menu-item label="Web Syndication"
href="../userdocs/generators/wsproxy-generator.html"/>
<menu-item label="Chaperon" href="chaperon/howto-chaperon-intro.html"/>
</menu>
-
<menu label="Documentation">
<menu-item label="Author How-To" href="howto-author-howto.html"/>
<menu-item label="Author FAQ" href="howto-author-faq.html"/>
<menu-item label="Author Snippet" href="howto-author-snippet.html"/>
<menu-item label="Author Docs" href="howto-author-core-docs.html"/>
</menu>
-
<menu label="Contribution">
<menu-item label="Prepare patch" href="howto-patch.html"/>
<menu-item label="Bugzilla" href="howto-bugzilla.html"/>
</menu>
-
-
</book>
No revision
No revision
1.2.2.3 +12 -0
xml-cocoon2/src/documentation/xdocs/howto/xmlform-wizard/howto-xmlform-wizard-1.xml
Index: howto-xmlform-wizard-1.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/howto/xmlform-wizard/howto-xmlform-wizard-1.xml,v
retrieving revision 1.2.2.2
retrieving revision 1.2.2.3
diff -u -r1.2.2.2 -r1.2.2.3
--- howto-xmlform-wizard-1.xml 10 Jun 2002 13:15:24 -0000 1.2.2.2
+++ howto-xmlform-wizard-1.xml 18 Oct 2002 18:17:52 -0000 1.2.2.3
@@ -182,6 +182,7 @@
<xf:textbox ref="/email">
<xf:caption>Email</xf:caption>
+ <xf:help>Please check this carefully</xf:help>
<xf:violations class="error"/>
</xf:textbox>
@@ -192,6 +193,7 @@
<xf:submit id="next" class="button">
<xf:caption>Next</xf:caption>
+ <xf:hint>Go to next page</xf:hint>
</xf:submit>
</xf:form>
@@ -252,10 +254,12 @@
<xf:submit id="prev" class="button">
<xf:caption>Prev</xf:caption>
+ <xf:hint>Go to previous page</xf:hint>
</xf:submit>
<xf:submit id="next" class="button">
<xf:caption>Next</xf:caption>
+ <xf:hint>Go to next page</xf:hint>
</xf:submit>
</xf:form>
@@ -303,10 +307,12 @@
<xf:submit id="prev" class="button">
<xf:caption>Prev</xf:caption>
+ <xf:hint>Go to previous page</xf:hint>
</xf:submit>
<xf:submit id="next" class="button">
<xf:caption>Next</xf:caption>
+ <xf:hint>Go to next page</xf:hint>
</xf:submit>
</xf:form>
@@ -349,10 +355,12 @@
<xf:submit id="prev" class="button">
<xf:caption>Prev</xf:caption>
+ <xf:hint>Go to previous page</xf:hint>
</xf:submit>
<xf:submit id="next" class="button">
<xf:caption>Next</xf:caption>
+ <xf:hint>Go to next page</xf:hint>
</xf:submit>
</xf:form>
@@ -393,10 +401,12 @@
<xf:submit id="prev" class="button">
<xf:caption>Prev</xf:caption>
+ <xf:hint>Go to previous page</xf:hint>
</xf:submit>
<xf:submit id="next" class="button">
<xf:caption>Next</xf:caption>
+ <xf:hint>Go to next page</xf:hint>
</xf:submit>
</xf:form>
@@ -504,10 +514,12 @@
<xf:submit id="prev" class="button">
<xf:caption>Prev</xf:caption>
+ <xf:hint>Go to previous page</xf:hint>
</xf:submit>
<xf:submit id="next" class="button">
<xf:caption>Finish</xf:caption>
+ <xf:hint>Submit the finished form</xf:hint>
</xf:submit>
</xf:form>
No revision
No revision
1.6.2.9 +51 -76 xml-cocoon2/src/documentation/xdocs/plan/changes-doc.xml
Index: changes-doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/changes-doc.xml,v
retrieving revision 1.6.2.8
retrieving revision 1.6.2.9
diff -u -r1.6.2.8 -r1.6.2.9
--- changes-doc.xml 13 Aug 2002 05:02:58 -0000 1.6.2.8
+++ changes-doc.xml 18 Oct 2002 18:17:52 -0000 1.6.2.9
@@ -1,166 +1,141 @@
<?xml version="1.0"?>
-
<!DOCTYPE changes PUBLIC "-//APACHE//DTD Changes V1.0//EN" "../dtd/changes-v10.dtd">
-
<!--
History of Cocoon Documentation changes
$Id$
-->
-
<changes title="Documentation History of Changes">
-
- <devs>
- <!-- in strict alphabetical order -->
- <person name="Nicola Ken Barozzi" email="[EMAIL PROTECTED]" id="NKB"/>
- <person name="David Crossley" email="[EMAIL PROTECTED]" id="DC"/>
- <person name="Bernhard Huber" email="[EMAIL PROTECTED]" id="BH"/>
- <person name="Ivelin Atanasoff Ivanov" email="[EMAIL PROTECTED]" id="IAI"/>
- <person name="Diana Shannon" email="[EMAIL PROTECTED]" id="DS"/>
- </devs>
-
- <release version="@version@" date="@date@">
- <action dev="DC" type="add" due-to="Geoff Howard"
due-to-email="[EMAIL PROTECTED]">
+ <devs>
+ <!-- in strict alphabetical order -->
+ <person name="Nicola Ken Barozzi" email="[EMAIL PROTECTED]" id="NKB"/>
+ <person name="David Crossley" email="[EMAIL PROTECTED]" id="DC"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]" id="BH"/>
+ <person name="Ivelin Atanasoff Ivanov" email="[EMAIL PROTECTED]" id="IAI"/>
+ <person name="Diana Shannon" email="[EMAIL PROTECTED]" id="DS"/>
+ </devs>
+ <release version="@version@" date="@date@">
+ <action dev="DC" type="add" due-to="Geoff Howard"
due-to-email="[EMAIL PROTECTED]">
New tutorial:
<link href="../tutorial/tutorial-generator.html">Write a Custom Generator</link>
- </action>
- </release>
-
- <release version="2.0.3" date="July 15 2002">
- <action dev="DC" type="add">
+ </action>
+ <action dev="IAI" type="add" due-to="Ivelin Ivanov"
due-to-email="[EMAIL PROTECTED]">
+ Added documentation for the WebServiceProxyGenerator component.
+ Explains how to implement Web Syndication.
+ </action>
+ <action dev="IAI" type="add" due-to="Ivelin Ivanov"
due-to-email="[EMAIL PROTECTED]">
+ Added WSDL descriptor and a REST style resource version
+ of the XMLForm demo.
+ </action>
+ </release>
+ <release version="2.0.3" date="July 15 2002">
+ <action dev="DC" type="add">
Encourage people to help with the mending broken links.
Added a
<link href="linkstatus.html">linkstatus</link> document describing some
tools.
</action>
-
- <action dev="DC" type="add">
+ <action dev="DC" type="add">
Added section to the
<link href="../mail-lists.html">Mailing Lists</link> document to describe
the new <code>cocoon-docs</code> mailing list.
</action>
-
- <action dev="NKB" type="add">
+ <action dev="NKB" type="add">
Established the new <code>cocoon-docs</code> mailing list.
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Updated and refactored some planning docs.
</action>
-
- <action dev="DS" type="add" due-to="Betrand Delacretaz"
due-to-email="[EMAIL PROTECTED]">
+ <action dev="DS" type="add" due-to="Betrand Delacretaz"
due-to-email="[EMAIL PROTECTED]">
Added new How-To for HTML-PDF Publishing.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
Added new How-To for Authoring Core Docs.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
Added new How-To for PaginatorTransformer.
</action>
-
- <action dev="BH" type="add">
+ <action dev="BH" type="add">
Added simple user documentation of LinkStatus Generator.
</action>
-
- <action dev="DC" type="add">
+ <action dev="DC" type="add">
Encourage people to help with the refactoring of Cocoon samples.
Provide a
<link href="samples.html">refactoring guidelines</link> document.
</action>
-
- <action dev="DC" type="add" due-to="Andrew Savory"
due-to-email="[EMAIL PROTECTED]">
+ <action dev="DC" type="add" due-to="Andrew Savory"
due-to-email="[EMAIL PROTECTED]">
Added overview documentation for
<link href="../userdocs/concepts/xmlform.html">XMLForm Handling</link>.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
New <link href="../snippet/index.html">Snippet</link> section added, along
with first <link href="../snippet/snippet-internal-pipeline.html">Snippet</link>
and <link href="../howto/howto-author-snippet.html">Snippet How-To</link>.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
Added additional FAQs pages: <link
href="../faq/faq-actions.html">Actions</link>,
<link href="../faq/faq-aggregators.html">Aggregators</link>, and
<link href="../faq/faq-xsp.html">XSP</link>.
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Edited <link href="../userdocs/matchers/matchers.html">Matchers</link>,
<link href="../userdocs/selectors/selectors.html">Selectors</link>, and a number
of other
user guide doc files to address grammar, typos, and general Global English
issues.
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Added stylesheet, src/documentation/stylesheets/faqcommon.xsl, which places two
FAQs at the bottom of every FAQs topic page. FAQs added include
"How can I add my FAQ to this document" and "How can I suggest
improvements to existing FAQs".
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Added five additional <link href="../faq/index.html">FAQ categories</link> and
pages.
Pulled useful FAQ content from various locations within existing docs and
sitemap files.
Provided "gateway links" to additional site documentation.
</action>
-
- <action dev="IAI" type="add" due-to="Heidi Brannan"
due-to-email="[EMAIL PROTECTED]">
+ <action dev="IAI" type="add" due-to="Heidi Brannan"
due-to-email="[EMAIL PROTECTED]">
Added Heidi Brannan's new
<link href="../howto/xmlform-wizard/howto-xmlform-wizard.html">XMLForm's
How-To</link>.
</action>
-
- <action dev="DC" type="add">
+ <action dev="DC" type="add">
Added new draft
<link href="../howto/howto-patch.html">How to Prepare a Patch</link>.
</action>
-
- <action dev="DC" type="add">
+ <action dev="DC" type="add">
Added new draft
<link href="../howto/howto-bugzilla.html">How to Contribute a Patch
via Bugzilla</link>.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
Added Tutorial section. Moved existing tutorial to new
location. Added draft tutorial contribution.
</action>
-
- <action dev="DS" type="add">
+ <action dev="DS" type="add">
Added <link href="../howto/index.html">How-To section</link>.
Added new How to author How-To and FAQ articles.
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Added new <link href="../faq/index.html">FAQ categories</link>.
Restructured FAQ content to facilitate user contributions via patches.
</action>
-
- <action dev="DC" type="update">
+ <action dev="DC" type="update">
Reviewed the <link href="linkalarm-readme.txt">LinkAlarm report</link>
and fixed some broken links.
</action>
-
- <action dev="DC" type="add" fixes-bug="8989"
- due-to="Andreas Hochsteger" due-to-email="[EMAIL PROTECTED]">
+ <action dev="DC" type="add" fixes-bug="8989" due-to="Andreas Hochsteger"
due-to-email="[EMAIL PROTECTED]">
Added new <link href="../link/index.html">Cocoon Links</link> section
with a collection of links to various external sources.
</action>
-
- <action dev="DS" type="update">
+ <action dev="DS" type="update">
Added many entries to the new To Do List.
</action>
-
- <action dev="DC" type="add">
+ <action dev="DC" type="add">
Started new documents for
<link href="todo-doc.html">Documentation To Do List</link> and
<link href="changes-doc.html">Documentation History of Changes</link>.
</action>
- </release>
-
- <release version="2.0.2" date="March 26 2002">
- <action dev="DS" type="add">
+ </release>
+ <release version="2.0.2" date="March 26 2002">
+ <action dev="DS" type="add">
Commenced discussion and planning for a Documentation Project.
</action>
- </release>
-
+ </release>
</changes>
1.1.2.10 +28 -43 xml-cocoon2/src/documentation/xdocs/plan/release.xml
Index: release.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/release.xml,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -u -r1.1.2.9 -r1.1.2.10
--- release.xml 22 Aug 2002 02:59:34 -0000 1.1.2.9
+++ release.xml 18 Oct 2002 18:17:52 -0000 1.1.2.10
@@ -15,13 +15,16 @@
<s1 title="Timeframe">
<p>This is the current time frame for the next releases:</p>
<ul>
- <li>September 2002 : Release date for 2.0.4 (bug fix release)</li>
- <li>August/September 2002 : Release date for 2.1 Alpha 1</li>
+ <li>October 2002 : 2.0.4 (bug fix release)</li>
+ <li>October 2002 : 2.1 Alpha</li>
+ <li>End of November 2002 : 2.1 Beta 1</li>
</ul>
</s1>
- <s1 title="ToDo List">
- <p>For 2.1 Beta 1:</p>
+ <s1 title="Version 2.0.4">
+ <p>See the todo list for more information.</p>
+ </s1>
+ <s1 title="Version 2.1 Beta 1">
<ul>
<li>apply patches</li>
<li>test flowmap + docs + etc</li>
@@ -39,48 +42,30 @@
strategic stuff has been a set a bit aside due to lack of time.</li>
</ul>
</s1>
-
- <s1 title="Preparation for the next release of Apache Cocoon">
-
- <p>
- The following is extracted from the thread
- [C2]: Release Candidate 2 ... 2001-10-29
- </p>
-
-<source><![CDATA[
-> The question is now, what has to be done until then?
->
-> 1) We have many open bugs in bugzilla. These must be reviewed
-> and then solved (or declared invalid etc).
->
-> 2) Documentation updates (this area lacks most)
-> We could move this to the final release.
+ <s1 title="Version 2.2 Beta 1">
+ <p>Although this version might be long in the future, we already have some
plans...</p>
+ <ul>
+ <li>Design and implement blocks</li>
+ <li>Move to a new Avalon container implementation (Merlin, Fortress or
whatever)</li>
+ </ul>
+ </s1>
+ <s1 title="General tasks for a release">
+<ul>
+<li>We have many open bugs in bugzilla. These must be reviewed
+ and then solved (or declared invalid etc).</li>
+<li>Documentation updates (this area lacks most).
+ We could move this to the final release.
Documentation must be happening all the time, and not left
-until last.
-
-> 3) Decide what to backport from the 2.1 head.
-> I'm +1 on removing the CodeFactories completly in 2.0, too.
-> This would avoid any backcompatibility problems.
->
-> 4) Layout the distribution
-> This is a point we haven't discussed yet. Currently our
-> distribution is a mixture of a source and a binary one.
-> We deliver the source and a compiled version, but in order
-> to run Cocoon, the user has to build a war file.
-> I propose to split this: one source distribution which is
-> similar to the current one but without the precompiled
-> cocoon jar and a binary distribution containing only the
-> war file. This war file should work in most servlet engines,
-> perhaps not in all.
->
-> So anything missing here?
-
-5) Ensure that licensing requirements have been met.
+until last.</li>
+<li>Checking what to backport. We have components in the
+latest developer versions, which might find their way into
+the bugfix version line (2.0.x).</li>
+<li>Ensure that licensing requirements have been met.
update jars.xml, ensure proper banner in *.java header,
verify the current LICENSE* files, ensure that external
- components have suitable licensing requirements.
-]]></source>
-
+ components have suitable licensing requirements.</li>
+<li>Everything we forgot...</li>
+</ul>
</s1>
</body>
No revision
No revision
1.1.2.3 +2 -9 xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml
Index: book.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- book.xml 16 Aug 2002 07:57:29 -0000 1.1.2.2
+++ book.xml 18 Oct 2002 18:17:52 -0000 1.1.2.3
@@ -1,15 +1,10 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN"
"../../dtd/book-cocoon-v10.dtd">
-
-<book software="Apache Cocoon"
- title="Apache Cocoon Generators"
- copyright="@year@ The Apache Software Foundation">
-
+<book software="Apache Cocoon" title="Apache Cocoon Generators" copyright="@year@
The Apache Software Foundation">
<menu label="Navigation">
<menu-item label="Main" href="../../index.html"/>
<menu-item label="User Documentation" href="../index.html"/>
</menu>
-
<menu label="Generators">
<menu-item label="Overview" href="generators.html"/>
</menu>
@@ -32,6 +27,7 @@
<menu-item label="Error Generator" href="error-generator.html"/>
<menu-item label="Search Generator" href="search-generator.html"/>
<menu-item label="LinkStatus Generator" href="linkstatus-generator.html"/>
+ <menu-item label="Web Service Proxy Generator" href="wsproxy-generator.html"/>
<menu-item label="Text Parser Generator" href="textparser-generator.html"/>
</menu>
<menu label="Optional">
@@ -39,7 +35,4 @@
<menu-item label="XML:DB Generator" href="xmldb-generator.html"/>
<menu-item label="XML:DB Collection Generator"
href="xmldbcollection-generator.html"/>
</menu>
-
</book>
-
-
No revision
No revision
1.1.2.1 +2 -2
xml-cocoon2/src/documentation/xdocs/userdocs/generators/wsproxy-generator.xml
Index: wsproxy-generator.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/wsproxy-generator.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- wsproxy-generator.xml 1 Sep 2002 05:06:17 -0000 1.1
+++ wsproxy-generator.xml 18 Oct 2002 18:17:52 -0000 1.1.2.1
@@ -307,8 +307,8 @@
</p>
<s2 title="Have more questions? ">
<p>
- Look at the online demo available here:
- <link
href="/cocoon/samples/webserviceproxy/">/cocoon/samples/webserviceproxy/</link>.
+ Look at the online demo available in the Cocoon distribution via:
+<code>http://localhost:8080/cocoon/samples/webserviceproxy/</code>
</p>
<p>
Then study the source code and if you still have questions, join the cocoon
users email list and ask. If you have ideas for improvement then you are more than
welcome to discuss it on the cocoon development email list and eventually submit a
patch through the Apache bug tracking system.
No revision
No revision
1.1.2.1 +75 -0
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/cinclude-transformer.xml
Index: cinclude-transformer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/cinclude-transformer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- cinclude-transformer.xml 3 Jan 2002 12:31:06 -0000 1.1
+++ cinclude-transformer.xml 18 Oct 2002 18:17:52 -0000 1.1.2.1
@@ -14,6 +14,11 @@
</header>
<body>
<s1 title="CInclude Transformer">
+ <p>This transformer includes XML in the current stream and acts therefore
+ is a kind of (dynamic) content aggregation. Two forms, one verbose
+ and flexible approach, and a simple approach are supported by the
+ transformer. We will first discuss the simple approach and
+ the more flexible is mentioned in the next chapter.</p>
<p>
This transformer triggers for the element <code>include</code> in the
namespace "http://apache.org/cocoon/include/1.0";.
@@ -125,5 +130,75 @@
</page>
]]></source>
</s1>
+<s1 title="Including External XML (simple)">
+ <p>One feature of the cinclude transformer (this is currently not
+ supported by the caching cinclude transformer) is including XML
from
+ external sources, e.g. files or from an HTTP server.
+ The <code>cinclude:includexml</code> tag starts including of
XML:</p>
+ <source>
+<cinclude:includexml> <!-- Include XML from HTTP server -->
+ <cinclude:src>http://external.news.com/flashnews.xml</cinclude:src>
+</cinclude:includexml>
+</source>
+ <p> This would be a simple way of "get"ting XML data from an
+ external site. Using this method it is also possible to pass
parameters in the
+ url - just as you would in a "get" sent from a browser.</p>
+ <source>
+<cinclude:includexml> <!-- Include XML from HTTP server -->
+
<cinclude:src>http://external.news.com/flashnews.xml?id=1234&myname=matthew</cinclude:src>
+</cinclude:includexml>
+</source>
+ <p>If the external XML is not valid or not available, the
+ transformer signals an error to the pipeline and the document
containing the
+ include command is not available.</p>
+ <p>For this purpose the <code>ignoreErrors</code> attribute can be
+ used:</p>
+ <source>
+<cinclude:includexml ignoreErrors="true">
+...
+</cinclude:includexml></source>
+ </s1>
+ <s1 title="Including External XML (advanced)">
+ <p>The above section shows you how to include XML data from an
+ external source such as an HTTP server using the simple "get"
method supplied
+ in the HTTP protocol. For more advanced uses you will wish to
be able to send
+ "Post" or other HTTP methods to the server. In addition you
may want to
+ actually send XML data to the server - just as you would
using an HTML form.
+ The format of this resource is slightly more complicated:</p>
+ <source>
+<?xml version="1.0"?>
+<data xmlns:cinclude="http://apache.org/cocoon/include/1.0">
+<cinclude:includexml>
+ <cinclude:src>http://itsunshine/tamino/blah</cinclude:src>
+ <cinclude:configuration>
+ <cinclude:parameter>
+ <cinclude:name>method</cinclude:name>
+ <cinclude:value>POST</cinclude:value>
+ </cinclude:parameter>
+ </cinclude:configuration>
+ <cinclude:parameters>
+ <cinclude:parameter>
+ <cinclude:name>message</session:name>
+ <cinclude:value>Hi there</session:value>
+ </cinclude:parameter>
+ <cinclude:parameter>
+ <cinclude:name>_Process</cinclude:name>
+
<cinclude:value><name>matti</name><age>36</age></cinclude:value>
+ </cinclude:param>
+ </cinclude:parameters>
+</cinclude:includexml>
+</data>
+ </source>
+ <p>Lets look at the tags. The tag <code>cinclude:src</code> defines
the address of the
+ resource we want to access and then comes a list of (optional)
+ connection-specific parameters (enclosed in the
<code>cinclude:configuration</code> tag).
+ In this example the HTTP-method ("POST") is passed into the
connection. The
+ format of these parameters is discussed next.</p>
+ <p>Then comes the list of parameters we wish to pass into the
+ function. Each parameter defined has a name and a value. The
value can either
+ be text or XML.</p>
+ <p>The format of the parameters is the same as for the connection
+ configuration.</p>
+ </s1>
</body>
</document>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
