shannon 2002/07/03 19:39:45 Modified: src/documentation/xdocs Tag: cocoon_2_0_3_branch performancetips.xml src/documentation/xdocs/link Tag: cocoon_2_0_3_branch livesites.xml sites.xml src/documentation/xdocs/userdocs Tag: cocoon_2_0_3_branch index.xml src/documentation/xdocs/userdocs/concepts Tag: cocoon_2_0_3_branch modules.xml sitemap.xml views.xml xmlform.xml src/documentation/xdocs/userdocs/generators Tag: cocoon_2_0_3_branch book.xml generators.xml src/documentation/xdocs/userdocs/transformers Tag: cocoon_2_0_3_branch book.xml transformers.xml src/documentation/xdocs/userdocs/xsp Tag: cocoon_2_0_3_branch logicsheet.xml Log: sync with HEAD Revision Changes Path No revision No revision 1.4.2.2 +2 -6 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.1 retrieving revision 1.4.2.2 diff -u -r1.4.2.1 -r1.4.2.2 --- performancetips.xml 17 May 2002 05:28:09 -0000 1.4.2.1 +++ performancetips.xml 4 Jul 2002 02:39:44 -0000 1.4.2.2 @@ -13,7 +13,7 @@ <s1 title="Disclaimer"> <p>The Cocoon Performance Tips in this version is a loose collection of - usesnet articles regarding how to improve the Apache Cocoon performance.</p> + usenet articles regarding how to improve the Apache Cocoon performance.</p> <p>As in the real world, it needs some kind of evolution to get better. If you have suggestions how to make it better or new kool tips, then be brave and send it to the <link href="http://xml.apache.org/cocoon/mail-lists.html"> @@ -33,7 +33,7 @@ response is the one that is not even processed. Cocoon is very slow (compared to a proxy server) to read resources such as stylesheets and images. A transparent proxy (SQUID, for example, don't use Apache's - mod_proxy because is not HTTP/1.1 fully compatible and disables + mod_proxy because it is not fully compatible with HTTP/1.1 and disables connection keep-alive). Make sure you tune how long the static resources that Cocoon "read"s from the sitemap are cached (look into the readers code to find out more).</li> @@ -41,10 +41,6 @@ <li>Consider prerendering or time-based batch-process the static parts of your site. PDF reports, rasterized SVG graphs or things that change regularly.</li> - - <li>Use a transparent proxy in front of your web server! The fastest - response is the one that is not even processed. Cocoon is very slow - (compared to a proxy server) to read resources such as stylesheets</li> <li>For optimum performance with Tomcat 4 and Cocoon 2, use the HTTP/1.0 connector.</li> No revision No revision 1.1.2.6 +5 -1 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.5 retrieving revision 1.1.2.6 diff -u -r1.1.2.5 -r1.1.2.6 --- livesites.xml 3 Jun 2002 23:55:39 -0000 1.1.2.5 +++ livesites.xml 4 Jul 2002 02:39:44 -0000 1.1.2.6 @@ -3,7 +3,7 @@ <document> <header> - <title>Live Sites powered by Apache Cocoon</title> + <title>Live Sites Powered by Apache Cocoon</title> <authors> <person name="Donald Ball" email="[EMAIL PROTECTED]"/> <person name="Stefano Mazzocchi" email="[EMAIL PROTECTED]"/> @@ -107,6 +107,10 @@ <li><link href="http://www.caphnet.com/">CaphNet</link></li> <li><link href="http://help.unc.edu/">The technical support site for the University of North Carolina at Chapel Hill</link></li> <li><link href="http://www.estig.ipbeja.pt/">ESTIG</link></li> + <li><link href="http://www.terracare.com/">TerraCare Software</link></li> + <li><link href="http://www.westcoastsoaps.com/">West Coast Designer Soaps</link></li> + <li><link href="http://www.micinfo.com/">Medical Imaging Consultants</link></li> + <li><link href="http://www.dla.org/">Dartmouth Lawyers Association</link></li> <!--<li><link href=""></link></li>--> </ul> </s1> 1.3.2.2 +4 -0 xml-cocoon2/src/documentation/xdocs/link/sites.xml Index: sites.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/link/sites.xml,v retrieving revision 1.3.2.1 retrieving revision 1.3.2.2 diff -u -r1.3.2.1 -r1.3.2.2 --- sites.xml 19 May 2002 08:16:24 -0000 1.3.2.1 +++ sites.xml 4 Jul 2002 02:39:44 -0000 1.3.2.2 @@ -25,6 +25,10 @@ how-to articles written by Cocoon users. The articles - and other issues - can be discussed in a forum. </li> +<li><link href="http://www.cocoonhive.org/">CocoonHive.org</link><br/> + CocoonHive.org maintainings a catalog of articles on Best Practices, + Use Cases and Success Stories. +</li> <li><link href="http://outerthought.org/cocoon/resources/cocoon2/">Outerthought (Belgium) offers Cocoon support and a Cocoon sitemap editor.</link></li> <li><link href="http://www.luminas.co.uk/technology/cocoon/url/">Cocoon-URL, a weekly summary of links posted to the cocoon mailing lists</link></li> <li><link href="http://www.galatea.com/flashguides/index.html">Galatea FlashGuides(TM)</link></li> No revision No revision 1.1.2.2 +3 -1 xml-cocoon2/src/documentation/xdocs/userdocs/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/index.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- index.xml 7 Jun 2002 20:04:46 -0000 1.1.2.1 +++ index.xml 4 Jul 2002 02:39:44 -0000 1.1.2.2 @@ -20,7 +20,9 @@ and actions. This guide will fill in the details, such as "So how do I turn this query into XML data". </p> - + <p>If you are interested in developing real-world web-applications requiring + form handling, authentication or even developing your own portal, have a + look at the <link href="../developing/webapps/index.html">web application documentation</link>.</p> <p> Come back often...this guide is being updated regularly. </p> No revision No revision 1.1.2.2 +51 -12 xml-cocoon2/src/documentation/xdocs/userdocs/concepts/modules.xml Index: modules.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/modules.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- modules.xml 28 Apr 2002 20:06:15 -0000 1.1.2.1 +++ modules.xml 4 Jul 2002 02:39:44 -0000 1.1.2.2 @@ -80,7 +80,7 @@ <s2 title="Step 1: Making a new module know to Apache Cocoon"> <p> Like other core components of Apache Cocoon, modules are declared in - <code>cocoon.xconf</code>. + <code>cocoon.xconf</code>. There are already too many to list here. </p> <source> <![CDATA[ @@ -90,6 +90,14 @@ <component-instance name="URI" class="org.apache.cocoon.components.modules.input.RequestURIModule"/> <component-instance name="header" class="org.apache.cocoon.components.modules.input.HeaderAttributeModule"/> <component-instance name="session" class="org.apache.cocoon.components.modules.input.SessionAttributeModule"/> + <component-instance name="date" class="org.apache.cocoon.components.modules.input.DateInputModule"/> + <component-instance name="defaults" class="org.apache.cocoon.components.modules.input.DefaultsMetaModule"> + <input-module name="request"/> + <values> + <skin>defaultSkin</skin> + <base-url>http://localhost:8080/cocoon</base-url> + </values> + </component-instance> </input-modules> <output-modules> @@ -121,13 +129,43 @@ which one to use. </p> </s2> - <s2 title="Step 2: Have sitemap component use a module"> + <s2 title="Step 2: Use it"> <p> - This depends on the component that is to be used. As an example the - <code>CachingWildcardMatcher</code> requires to set the - <code>input-module</code> on declaration. + Two alternatives for using modules exist: </p> - <source> + <s3 title="Step 2a: Use it as sitemap variable"> + <p> + Input modules can be used in a sitemap almost like a sitemap + variable. If the variable name contains a colon (":"), the + preceeding string is used as the name of the module to use and the + trailing string is passed to the module. The expression is replaced + with the string value returned from the module. + </p> + <source> +<![CDATA[ + <map:transform src="resources/stylesheets/{../skin}.xsl"/> +]]> + </source> + <p> + The above example uses the variable <code>skin</code> declared + e.g. by an action for the stylesheet to apply to the page. The + example below uses an input module instead. The way this module was + declared above allows to override the skin with a request parameter + named "skin". + </p> + <source> +<![CDATA[ + <map:transform src="resources/stylesheets/{default:skin}.xsl"/> +]]> + </source> + </s3> + <s3 title="Step 2b: Have sitemap components use a module"> + <p> + This depends on the component that is to be used. As an example the + <code>CachingWildcardMatcher</code> requires to set the + <code>input-module</code> on declaration. + </p> + <source> <![CDATA[ <map:matchers default="wildcard"> <map:matcher name="cached-uri" src="org.apache.cocoon.matching.modular.CachingWildcardMatcher"> @@ -135,12 +173,13 @@ </map:matcher> </map:matchers> ]]> - </source> - <p> - By replacing the input module name with any of the other declared - input modules, this matcher can be used to match e.g. on session - attributes or request headers. - </p> + </source> + <p> + By replacing the input module name with any of the other declared + input modules, this matcher can be used to match e.g. on session + attributes, request headers or even dates! + </p> + </s3> </s2> </s1> 1.3.2.5 +9 -47 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.4 retrieving revision 1.3.2.5 diff -u -r1.3.2.4 -r1.3.2.5 --- sitemap.xml 1 Jul 2002 08:55:32 -0000 1.3.2.4 +++ sitemap.xml 4 Jul 2002 02:39:44 -0000 1.3.2.5 @@ -17,34 +17,17 @@ <s1 title="The Sitemap"> <s2 title="Introduction"> <p> - This document is used as a working draft for - Apache Cocoon architects to understand the issues associated with - sitemaps and XML publishing in general. It must be considered as a working - draft and may be updated at any time. + This document describes the Cocoon sitemap concept in full details, why + it's there, what it does, how it works and how you can use it. </p> - <p> + <note> See the <link href="../index.html">User documentation</link> for details about configuration of each sitemap component. See the <link href="sitemap-examples.html">Example sitemap snippets</link>. Explore each <code>sitemap.xmap</code> in the distribution, to see how the various situations are handled. - </p> - - <p> - This document is based on ideas and design patterns inspired by Stefano - Mazzocchi ([EMAIL PROTECTED]) and Pierpaolo Fumagalli ([EMAIL PROTECTED]) - but grew as a collaborative effort to provide a solid foundation of - design patterns and usability guidelines to create a solid foundation - of sitemap programmability and usability to the Cocoon Publishing - Framework. - </p> - - <p> - This is one of the few examples where open source is transformed into - "open development" leading both the implementation and the pure research - around software development and usability. - </p> + </note> </s2> <s2 title="Goals"> @@ -99,9 +82,7 @@ The Sitemap has the following general structure: </p> - <source> -<![CDATA[ - <?xml version="1.0"?> + <source><![CDATA[<?xml version="1.0"?> <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0"> @@ -110,18 +91,12 @@ <map:resources/> <map:action-sets/> <map:pipelines/> - </map:sitemap> -]]> - </source> + </map:sitemap>]]></source> </s2> <s2 title="The <map:sitemap>"> - <source> -<![CDATA[ - <map:sitemap - xmlns:map="http://apache.org/cocoon/sitemap/1.0"> -]]> - </source> + <source><![CDATA[<map:sitemap + xmlns:map="http://apache.org/cocoon/sitemap/1.0">]]></source> <p> The default namespaces are used mainly for versioning, instead of using @@ -407,20 +382,7 @@ <s2 title="The <map:resources>"> <p> The <code><map:resource></code> element is used as a placeholder for pipelines - that are used several times inside the document. This element - is redundant and its functionality is not directly related - to the sitemap, but could be cloned by the use of internal - XInclude, for example - </p> - - <p> - <code><xinclude:include href="#xpointer(resource[@name='Access refused'])"/></code> - </p> - - <p> - but given the usability constraints and very specific operation - it is much easier to include such an element instead of forcing - the use of xinclude/xpointer. + that are used several times inside the document. </p> <source> <![CDATA[ 1.2.2.2 +3 -4 xml-cocoon2/src/documentation/xdocs/userdocs/concepts/views.xml Index: views.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/views.xml,v retrieving revision 1.2.2.1 retrieving revision 1.2.2.2 diff -u -r1.2.2.1 -r1.2.2.2 --- views.xml 19 Jun 2002 00:21:50 -0000 1.2.2.1 +++ views.xml 4 Jul 2002 02:39:44 -0000 1.2.2.2 @@ -23,8 +23,8 @@ Views are yet another sitemap component. Unlike the rest, they are not inherited by sub-sitemaps and they are othogonal to the resource and pipeline definitions. - In the following I will not distinguish between resources and pipelines - because their differences are not relevant here. So, when I talk + In the following we will not distinguish between resources and pipelines + because their differences are not relevant here. So, when we talk about pipelines the said is valid for resources as well. </p> <p> @@ -52,9 +52,8 @@ </p> <p> Browsers requests resources of this URI space. - The response of a browser request is easy reenderable intended for presenting + The response of a browser request is normally intended for presenting to a human being. It may be augmented with navigation controls, and advertisment. - <br/> An indexer of a search engines requests resources of this URI space, too. In contrast to a browser an indexer is interested in the bare content of a resource. 1.1.2.2 +1 -1 xml-cocoon2/src/documentation/xdocs/userdocs/concepts/xmlform.xml Index: xmlform.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/xmlform.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- xmlform.xml 17 Jun 2002 09:44:17 -0000 1.1.2.1 +++ xmlform.xml 4 Jul 2002 02:39:44 -0000 1.1.2.2 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "document-v10.dtd"> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd"> <document> <header> No revision No revision 1.1.2.1 +1 -0 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 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- book.xml 3 Jan 2002 12:31:04 -0000 1.1 +++ book.xml 4 Jul 2002 02:39:45 -0000 1.1.2.1 @@ -31,6 +31,7 @@ <menu-item label="Profile Generator" href="profile-generator.html"/> <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> <menu label="Optional"> <menu-item label="Php Generator" href="php-generator.html"/> 1.1.2.2 +1 -0 xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml Index: generators.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- generators.xml 7 Jun 2002 19:59:47 -0000 1.1.2.1 +++ generators.xml 4 Jul 2002 02:39:45 -0000 1.1.2.2 @@ -43,6 +43,7 @@ <li><link href="profile-generator.html">Profile Generator</link></li> <li><link href="error-generator.html">Error Generator</link></li> <li><link href="search-generator.html">Search Generator</link></li> + <li><link href="linkstatus-generator.html">LinkStatus Generator</link></li> <li><link href="php-generator.html">Php Generator</link> (optional)</li> <li><link href="xmldb-generator.html">XML:DB Generator</link> (optional)</li> <li><link href="xmldbcollection-generator.html">XML:DB Collection Generator</link> (optional)</li> No revision No revision 1.1.2.1 +1 -0 xml-cocoon2/src/documentation/xdocs/userdocs/transformers/book.xml Index: book.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/book.xml,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- book.xml 3 Jan 2002 12:31:06 -0000 1.1 +++ book.xml 4 Jul 2002 02:39:45 -0000 1.1.2.1 @@ -26,6 +26,7 @@ <menu-item label="Write DOM Session Transformer" href="writedomsession-transformer.html"/> <menu-item label="XInclude Transformer" href="xinclude-transformer.html"/> <menu-item label="CInclude Transformer" href="cinclude-transformer.html"/> + <menu-item label="EncodeURL Transformer" href="encodeurl-transformer.html"/> </menu> <menu label="Optional"> <menu-item label="XT Transformer" href="xt-transformer.html"/> 1.1.2.2 +1 -0 xml-cocoon2/src/documentation/xdocs/userdocs/transformers/transformers.xml Index: transformers.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/transformers.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- transformers.xml 7 Jun 2002 19:57:47 -0000 1.1.2.1 +++ transformers.xml 4 Jul 2002 02:39:45 -0000 1.1.2.2 @@ -39,6 +39,7 @@ <li><link href="writedomsession-transformer.html">Write DOM Session Transformer</link></li> <li><link href="xinclude-transformer.html">XInclude Transformer</link></li> <li><link href="cinclude-transformer.html">CInclude Transformer</link></li> + <li><link href="encodeurl-transformer.html">EncodeURL Transformer</link></li> <li><link href="xt-transformer.html">XT Transformer</link> (optional)</li> <li><link href="ldap-transformer.html">LDAP Transformer</link> (optional)</li> </ul> No revision No revision 1.3.2.1 +14 -13 xml-cocoon2/src/documentation/xdocs/userdocs/xsp/logicsheet.xml Index: logicsheet.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/xsp/logicsheet.xml,v retrieving revision 1.3 retrieving revision 1.3.2.1 diff -u -r1.3 -r1.3.2.1 --- logicsheet.xml 7 Mar 2002 16:06:44 -0000 1.3 +++ logicsheet.xml 4 Jul 2002 02:39:45 -0000 1.3.2.1 @@ -62,7 +62,7 @@ <p>Here's a simple XML file:</p> <source> -<strong>greeting.xml</strong> +greeting.xml <![CDATA[ <?xml version="1.0"?> @@ -72,8 +72,9 @@ <p>...and here's the XSL stylesheet that will transform it into an HTML file similar to the one we started this section with:</p> + <source> -<strong>greeting.xsl</strong> +greeting.xsl <![CDATA[ <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> @@ -106,7 +107,7 @@ of this file is transformed to HTML by the same XSL stylesheet as above:</p> <source> -<strong>greeting2.xml</strong> +greeting2.xml <![CDATA[ <?xml version="1.0"?> @@ -131,9 +132,9 @@ logicsheet. There are two files shown below. The first is an XSP file that uses a custom logicsheet, logicsheet.greeting.xsl, which is the second file shown below.</p> - + <source> -<strong>greeting3.xml</strong> +greeting3.xml <![CDATA[ <?xml version="1.0"?> @@ -148,9 +149,8 @@ </xsp:page> ]]></source> - <source> -<strong>logicsheet.greeting.xsl</strong> +logicsheet.greeting.xsl <![CDATA[ <?xml version="1.0"?> <xsl:stylesheet @@ -246,24 +246,25 @@ processing instruction for each file that uses the logicsheet. The second way is to declare logicsheet in the cocoon.xconf file. These declarations take the form</p> -<source> +<source><![CDATA[ <builtin-logicsheet> <parameter name="prefix" value="<logicsheet's prefix>"/> <parameter name="uri" value="<logicsheet's namespace URI>"/> <parameter name="href" value="<URL to file>"/> </builtin-logicsheet> -</source> +]]></source> <p>Cocoon's pre-defined logicsheets are already declared in this file. For instance, the declaration of the XSP request taglib is the following:</p> -<source> +<source><![CDATA[ <builtin-logicsheet> <parameter name="prefix" value="xsp-request"/> <parameter name="uri" value="http://apache.org/xsp/request/2.0"/> <parameter name="href" value="resource://.../markup/xsp/java/request.xsl"/> </builtin-logicsheet> -</source> +]]></source> + <p>This line associates the <strong>http://apache.org/xsp/request/2.0</strong> namespace with the logicsheet named in the URL. This URL points to a file that is stored in the cocoon.jar. To use the request taglib, you must @@ -287,14 +288,14 @@ Hello, World! example above, and if the logicsheet were stored (on a UNIX filesystem) in the location /cocoon/logicsheets/logicsheet.greeting.xsl, we'd add this line to cocoon.xconf:</p> -<source> +<source><![CDATA[ <builtin-logicsheet> <parameter name="prefix" value="greeting"/> <parameter name="uri" value="http://duke.edu/tutorial/greeting"/> <parameter name="href" value="file:///cocoon/logicsheets/logicsheet.greeting.xsl"/> </builtin-logicsheet> -</source> +]]></source> <p>There are some very important differences between using the <?xml-logicsheet?> processing instruction vs. the cocoon.properties entry to apply a logicsheet.
---------------------------------------------------------------------- In case of troubles, e-mail: [EMAIL PROTECTED] To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]