The URICoplet

Mailing-List: contact docs-help@cocoon.apache.org; run by ezmlm
Precedence: bulk
Reply-To: docs@cocoon.apache.org
Message-ID: <3066696.1124112214602.JavaMail.daisy@cocoon.zones.apache.org>
Date: Mon, 15 Aug 2005 13:23:34 +0000 (GMT+00:00)
From: daisy@cocoon.zones.apache.org
To: docs@cocoon.apache.org
Subject: [DAISY] Updated: Configuring Coplets
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

A document has been updated:

http://cocoon.zones.apache.org/daisy/documentation/602.html

Document ID: 602
Branch: main
Language: default
Name: Configuring Coplets (unchanged)
Document Type: Document (unchanged)
Updated on: 8/15/05 1:23:20 PM
Updated by: Helma

A new version has been created, state: publish

Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 10584 bytes (previous version: 16015 bytes)
Content diff:
(184 equal lines skipped)
    set a timeout, the content is automatically buffered and the <em>buffer</em>
    configuration is ignored.</p>
    
--- <h1>The URICoplet</h1>
--- 
--- <p>This section describes the URICoplet and the different possibilities to
--- configure it. For general configuration see the previous section.</p>
--- 
--- <h2>The Content Location and Parameter Handling</h2>
--- 
--- <p>A URICoplet uses a uri to fetch the coplet. This configuration is obviously a
--- configuration of the coplet class (and not of the coplet type) as each coplet
--- uses a different location.</p>
--- 
--- <p>The attribute <em>uri</em> takes the complete uri (as a string) to fetch the
--- content from:</p>
--- 
--- <pre>...
---    &lt;coplet-data id="CZ Weblog" name="standard"&gt;
---       &lt;title&gt;CZ's Weblog&lt;/title&gt;
---       &lt;coplet-base-data&gt;URICoplet&lt;/coplet-base-data&gt;
---       &lt;attribute&gt;
---       	&lt;name&gt;uri&lt;/name&gt;
---       	&lt;value xsi:type="java:java.lang.String" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
---       	  cocoon:/news/liverss?feed=http://radio.weblogs.com/0107211/rss.xml
---       	&lt;/value&gt;
---       &lt;/attribute&gt;
---    &lt;/coplet-data&gt;
--- ...
---    </pre>
--- 
--- <p>If you're using the cocoon protocol to call internal pipelines, you can also
--- configure the boolean attribute <em>handleParameters</em> (default is false),
--- that defines if the coplet handles request parameters itself. This should be
--- used for coplets that process request parameters (have forms for example). In
--- that case, the parameters from the request are only forwarded to the coplet, if
--- they are meant for this coplet. All other coplets that use request parameters
--- don't get them in this request-response-cycle.</p>
--- 
--- <h2>Error Handling</h2>
--- 
--- <p>Usually, in the case of an error during rendering the content of a coplet, a
--- message is included in the coplet window instead of the coplet content. If you
--- want to customize this, you can specifiy the attribute <em>error-uri</em> that
--- should contain a valid uri that deliveres the content for a better error
--- message.</p>
--- 
--- <h1>The CachingURICoplet</h1>
--- 
--- <p>The CachingURICoplet is an extension of the URICoplet (see previous chapter)
--- providing caching of the coplet content. Usually the user of a portal only
--- interacts with one single coplet at a time. As the interaction redraws the whole
--- portal page with several coplets, all coplets are asked to give their content.
--- In many situations this is not wanted. For example if the coplet contains a form
--- or has a state, asking the coplet to give its content although the user has not
--- submitted the form, might result in unwanted responses.</p>
--- 
--- <p>Therefore the CachingURICoplet caches the content of a coplet in the session
--- of the user. All further requests are served from the cache until the user
--- interacts with exactly this coplet. In this case the cache is cleared, the
--- coplet is invoked again and the new content is cached for further requests.</p>
--- 
--- <p>If you want to disable the caching, you can specify the boolean attribute
--- <em>cache-enabled</em> with the value <em>false</em> in the coplet data
--- configuration.</p>
--- 
--- <p>You can also programmatically turn off caching for a coplet for a single
--- request by setting the attribute <em>doNotCache</em> with any value on the
--- coplet instance data. For example if you want to set this from flow:</p>
--- 
--- <pre>     ...
---        var coplet = GET_THE_COPLET_INSTANCE_DATA;
---        coplet.setAttribute("doNotCache", "1");
---      ...
---      </pre>
--- 
--- <p>By default the caching uri adapter ignores sizing events for clearing the
--- cache. This ensures that minimizing a coplet does not clear the cache. However,
--- if you want to disable the cache on a sizing event you can turn this on in the
--- configuration for a coplet data:</p>
--- 
--- <pre>...
--- &lt;coplet-data id="Portal-Demo" name="standard"&gt;
---    &lt;title&gt;Introduction&lt;/title&gt;
---    &lt;coplet-base-data&gt;CachingURICoplet&lt;/coplet-base-data&gt;
---    &lt;attribute&gt;
---       &lt;name&gt;uri&lt;/name&gt;
---       &lt;value xsi:type="java:java.lang.String" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
---          cocoon:/coplets/docs/portal-demo.html
---       &lt;/value&gt;
---    &lt;/attribute&gt;
---    &lt;attribute&gt;
---       &lt;name&gt;ignore-sizing-events&lt;/name&gt;
---       &lt;value xsi:type="java:java.lang.Boolean" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;false&lt;/value&gt;
---    &lt;/attribute&gt;
--- &lt;/coplet-data&gt;
--- ...
---    </pre>
--- 
--- <h2>Global Caching</h2>
--- 
--- <p>The default caching mechanism caches the contents in the user session. If you
--- want to use a global cache across all users, you can turn this on with an
--- attribute on the coplet data configuration:</p>
--- 
--- <pre>...
--- &lt;coplet-data id="Portal-Demo" name="standard"&gt;
---    &lt;title&gt;Introduction&lt;/title&gt;
---    &lt;coplet-base-data&gt;CachingURICoplet&lt;/coplet-base-data&gt;
---    &lt;attribute&gt;
---      &lt;name&gt;uri&lt;/name&gt;
---      &lt;value xsi:type="java:java.lang.String" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
---          cocoon:/coplets/docs/portal-demo.html
---      &lt;/value&gt;
---    &lt;/attribute&gt;
---    &lt;attribute&gt;
---      &lt;name&gt;cache-global&lt;/name&gt;
---      &lt;value xsi:type="java:java.lang.Boolean" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;true&lt;/value&gt;
---    &lt;/attribute&gt;
--- &lt;/coplet-data&gt;
--- ...
---      </pre>
--- 
--- <p>By using the boolean <em>cache-global</em> attribute with the value
--- <em>true</em> the contents of the coplet is cached in the usual Cocoon cache
--- making it available to all users.</p>
--- 
--- <p>The global cache is useful for static content that is the same for all users.
--- </p>
--- 
    <h1>Coplet Rendering</h1>
    
    <p>Each coplet can be configured for supporting different features, like
(69 equal lines skipped)


Fields
======
no changes

Links
=====
no changes

Custom Fields
=============
no changes

Collections
===========
no changes