blob: e58b34fee91bf0b45df57a728ddef6af4d2b2457 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
<document>
<header>
<title>Zip archive Serializer</title>
<version>1.0</version>
<type>Technical document</type>
<authors>
<person name="Sylvain Wallez" email="sylvain@apache.org"/>
</authors>
<abstract>This document describes the Zip archive serializer of Cocoon.</abstract>
</header>
<body>
<s1 title="Zip archive Serializer">
<p>The Zip archive serializer generates a zip archive by aggregating several sources.</p>
<p>The input document should describe entries of the archive by means of
their name (which can be a path) and their content either as URLs or
inline data :</p>
<ul>
<li>URLs, given by the "src" attribute, are Cocoon sources and as such
can use any of the protocols handled by Cocoon, including "cocoon:" to
include dynamically generated content in the archive.</li>
<li>inline data is represented by an XML document that is serialized to the
zip entry using the serializer identified by the "serializer" attribute.</li>
</ul>
<p>
Example :
</p>
<source>
&lt;zip:archive xmlns:zip="http://apache.org/cocoon/zip-archive/1.0"&gt;
&lt;zip:entry name="foo.html" src="cocoon://dynFoo.html"/&gt;
&lt;zip:entry name="images/bar.jpeg" src="bar.jpeg"/&gt;
&lt;zip:entry name="index.html" serializer="html"&gt;
&lt;html&gt;
&lt;head&gt;
&lt;title&gt;Index page&lt;/title&gt;
&lt;/head&gt;
&lt;body&gt;
Please go &lt;a href="foo.html"&gt;there&lt;/a&gt;
&lt;/body&gt;
&lt;/html&gt;
&lt;/zip:entry&gt;
&lt;/zip:archive&gt;
</source>
<ul>
<li>Name: zip</li>
<li>Class: org.apache.cocoon.serialization.ZipArchiveSerializer</li>
<li>Cacheable: no</li>
</ul>
</s1>
</body>
</document>