cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From da...@cocoon.zones.apache.org
Subject [DAISY] Updated: TraversableGenerator
Date Thu, 27 Mar 2008 20:33:06 GMT
A document has been updated:

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

Document ID: 1016
Branch: main
Language: default
Name: TraversableGenerator (unchanged)
Document Type: Sitemap Component (unchanged)
Updated on: 3/27/08 8:32:51 PM
Updated by: Luca Morandini

A new version has been created, state: draft

Parts
=====

Short description
-----------------
This part has been added.
Mime type: text/xml
File name: null
Size: 689 bytes
Content:
<html>
<body>

<p>Generates an XML source hierarchy listing from a Traversable Source</p>

<p>The root node of the generated document will normally be a collection node
and a collection node can contain zero or more resource or collection nodes. A
resource node has no children. Each node will contain the following attributes:
</p>

<blockquote>
<p>name the name of the source lastModified the time the source was last
modified, measured as the number of milliseconds since the epoch (as in
java.io.File.lastModified) size the source size, in bytes (as in
java.io.File.length) date (optional) the time the source was last modified in
human-readable form</p>
</blockquote>

</body>
</html>


Long description
----------------
This part has been added.
Mime type: text/xml
File name: null
Size: 1363 bytes
Content:
<html>
<body>

<p><strong>Configuration options:</strong></p>

<p><em>depth</em> (optional) Sets how deep TraversableGenerator should delve
into the source hierarchy. If set to 1 (the default), only the starting
collection's immediate contents will be returned. <em>sort</em> (optional) Sort
order in which the nodes are returned. Possible values are name, size, time,
collection. collection is the same as name, except that the collection entries
are listed first. System order is default. <em>reverse</em> (optional) Reverse
the order of the sort <em>dateFormat</em> (optional) Sets the format for the
date attribute of each node, as described in java.text.SimpleDateFormat. If
unset, the default format for the current locale will be used. <em>timeZone</em>
(optional) Sets the time zone offset ID for the date attribute, as described in
java.util.TimeZone. If unset, the default system time zone will be used.
<em>refreshDelay</em> (optional) Sets the delay (in seconds) between checks on
the source hierarchy for changed content. Defaults to 1 second. <em>root</em>
(optional) Sets the the regular expression for the root pattern.
<em>include</em> (optional) Sets the the regular expression for including
sources based on their names.<em>exclude</em> (optional) Sets the the regular
expression for excluding sources based on their names.</p>

</body>
</html>


Mime
View raw message