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 12:19:57 PM
Updated by: Helma
A new version has been created, state: draft
Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name: (unchanged)
Size: 15117 bytes (previous version: 12505 bytes)
Content diff:
(69 equal lines skipped)
<coplet-base-data>URICoplet</coplet-base-data>
<attribute>
<name>uri</name>
--- <value xsi:type="java:java.lang.String"
---
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">cocoon:/news/liverss?feed=http://radio.weblogs.com/0107211/rss.xml</value>
+++ <value xsi:type="java:java.lang.String"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+++
cocoon:/news/liverss?feed=http://radio.weblogs.com/0107211/rss.xml
+++ </value>
</attribute>
<attribute>
<name>buffer</name>
(60 equal lines skipped)
same. Let's have a look at an example:</p>
<pre>...
--- <coplet-base-data id="URICoplet">
--- <coplet-adapter>uri</coplet-adapter>
--- <configuration>
--- <name>buffer</name>
--- <value xsi:type="java:java.lang.Boolean"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">true</value>
--- </configuration>
--- </coplet-base-data>
--- ...
--- <coplet-data id="CZ Weblog" name="standard">
--- <title>CZ's Weblog</title>
--- <coplet-base-data>URICoplet</coplet-base-data>
--- <attribute>
--- <name>buffer</name>
--- <value xsi:type="java:java.lang.Boolean"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">false</value>
--- </attribute>
--- </coplet-data>
+++ <coplet-base-data id="URICoplet">
+++ <coplet-adapter>uri</coplet-adapter>
+++ <configuration>
+++ <name>buffer</name>
+++ <value xsi:type="java:java.lang.Boolean"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">true</value>
+++ </configuration>
+++ </coplet-base-data>
...
+++ <coplet-data id="CZ Weblog" name="standard">
+++ <title>CZ's Weblog</title>
+++ <coplet-base-data>URICoplet</coplet-base-data>
+++ <attribute>
+++ <name>buffer</name>
+++ <value xsi:type="java:java.lang.Boolean"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">false</value>
+++ </attribute>
+++ </coplet-data>
+++ ...
</pre>
<p>As you can see in the example above, there is no real difference in
(67 equal lines skipped)
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> ...
+++
+++ Introduction
+++ CachingURICoplet
+++
+++ uri
+++ cocoon:/coplets/docs/portal-demo.html
+++
+++
+++ ignore-sizing-events
+++ false
+++
+++
+++ ...
+++ </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> ...
+++
+++ Introduction
+++ CachingURICoplet
+++
+++ uri
+++ cocoon:/coplets/docs/portal-demo.html
+++
+++
+++ cache-global
+++ true
+++
+++
+++ ...
+++ </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
