Author: upayavira
Date: Mon Apr 18 02:19:32 2005
New Revision: 161748
URL: http://svn.apache.org/viewcvs?view=rev&rev=161748
Log:
Extending gump.xml to include a simple description of each block, ready for upco
ming GUI installer.
Most descriptions taken from BlockDescriptions wiki page, with rest added by me.
Please review and update descriptions, as some are clearly inadequate.
Modified:
cocoon/branches/BRANCH_2_1_X/gump.xml
Modified: cocoon/branches/BRANCH_2_1_X/gump.xml
URL:
http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/gump.xml?view=diff&r1=161747&r2=161748
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/gump.xml (original)
+++ cocoon/branches/BRANCH_2_1_X/gump.xml Mon Apr 18 02:19:32 2005
@@ -120,6 +120,11 @@
<project name="cocoon-block-fop" status="stable" dir="src/blocks/fop">
<package>org.apache.cocoon</package>
+ <description><link href='xml.apache.org/fop/'>FOP</link> reads an
+ <link href='www.w3.org/TR/xsl/'>XSL-FO</link> document and turns it into
a PDF,
+ PS or PCL format document using FOPSerializer. Include libraries and
docs.
+ Include FOP libraries, components and samples.</description>
+
<ant target="gump-block">
<property name="block-name" value="fop"/>
<property name="version" value="@@DATE@@"/>
@@ -143,6 +148,11 @@
<project name="cocoon-block-batik" status="stable" dir="src/blocks/batik">
<package>org.apache.cocoon</package>
+ <description>Allow rendering <link href='www.w3.org/TR/SVG/'>SVG</link>
+ images to JPEG and PNG using <link
href='xml.apache.org/batik/'>Batik</link>
+ library. Include SVGSerializer, FragmentExtractorGenerator and
+ FragmentExtractorTransformer. Includes samples.</description>
+
<ant target="gump-block">
<property name="block-name" value="batik"/>
<property name="version" value="@@DATE@@"/>
@@ -165,6 +175,10 @@
<project name="cocoon-block-chaperon" status="stable"
dir="src/blocks/chaperon">
<package>org.apache.cocoon</package>
+ <description>Provides TextGenerator and the required Chaperon libs
+ for the creation of XML from a structured plaintext (Grammars).
+ See also <link href='chaperon.sourceforge.net/'>Chaperon @
SF</link></description>
+
<ant target="gump-block">
<property name="block-name" value="chaperon"/>
<property name="version" value="@@DATE@@"/>
@@ -190,6 +204,11 @@
<project name="cocoon-block-swf" status="deprecated" dir="src/blocks/swf">
<package>org.apache.cocoon</package>
+ <description>Provides the SWFGenerator and SWFSerializer for the creation
+ and manipulation of Flash animations using Cocoon. Includes the required
+ <link href='www.tivano.de/software/spark/index.shtml'>Spark</link>
+ library. Deprecated.</description>
+
<ant target="gump-block">
<property name="block-name" value="swf"/>
<property name="version" value="@@DATE@@"/>
@@ -211,6 +230,8 @@
<project name="cocoon-block-jfor" status="stable" dir="src/blocks/jfor">
<package>org.apache.cocoon</package>
+ <description>Allows you to serialize data as RTF using FO.</description>
+
<ant target="gump-block">
<property name="block-name" value="jfor"/>
<property name="version" value="@@DATE@@"/>
@@ -231,6 +252,9 @@
<project name="cocoon-block-itext" status="stable" dir="src/blocks/itext">
<package>org.apache.cocoon</package>
+
+ <description>You need <link href='www.lowagie.com/iText/'>iText</link>
+ if you don't want to use the FOP block to generate PDF.</description>
<ant target="gump-block">
<property name="block-name" value="itext"/>
<property name="version" value="@@DATE@@"/>
@@ -253,6 +277,9 @@
<project name="cocoon-block-session-fw" status="stable"
dir="src/blocks/session-fw">
<package>org.apache.cocoon</package>
+ <description>Provides the components to manage (create, modify, delete)
+ sessions in xml with the Session Transformer.</description>
+
<ant target="gump-block">
<property name="block-name" value="session-fw"/>
<property name="version" value="@@DATE@@"/>
@@ -272,6 +299,10 @@
<project name="cocoon-block-authentication-fw" status="stable"
dir="src/blocks/authentication-fw">
<package>org.apache.cocoon</package>
+ <description>Components for the authentication framework. Provides
+ LoginAction, LogoutAction, ProtectedAction, ConfigurationGenerator.
+ Include samples.</description>
+
<ant target="gump-block">
<property name="block-name" value="authentication-fw"/>
<property name="version" value="@@DATE@@"/>
@@ -291,6 +322,9 @@
<project name="cocoon-block-portal-fw" status="deprecated"
dir="src/blocks/portal-fw">
<package>org.apache.cocoon</package>
+ <description>Provides the components which compose the framework which
allows you
+ to build a portal with Cocoon. Deprecated. Use portal
block.</description>
+
<ant target="gump-block">
<property name="block-name" value="portal-fw"/>
<property name="version" value="@@DATE@@"/>
@@ -311,6 +345,10 @@
<project name="cocoon-block-databases" status="stable"
dir="src/blocks/databases">
<package>org.apache.cocoon</package>
+ <description>Provides various database-related actions and transformers,
ESQL
+ and other database-related logicsheets, as well as various utility
classes.
+ You probably want this if you desire any sort of database
connectivity.</description>
+
<ant target="gump-block">
<property name="block-name" value="databases"/>
<property name="version" value="@@DATE@@"/>
@@ -334,6 +372,10 @@
<project name="cocoon-block-hsqldb" status="stable" dir="src/blocks/hsqldb">
<package>org.apache.cocoon</package>
+ <description>Add support for
+ <link href='hsqldb.sourceforge.net/'>HSQL Database Engine</link>,
+ a 100% Java Relational Database.</description>
+
<ant target="gump-block">
<property name="block-name" value="hsqldb"/>
<property name="version" value="@@DATE@@"/>
@@ -356,6 +398,11 @@
<project name="cocoon-block-poi" status="stable" dir="src/blocks/poi">
<package>org.apache.cocoon</package>
+ <description>Provides a <link
href='jakarta.apache.org/poi/hssf'>HSSF</link>
+ serializer that produce MS Excel spreadsheet format output. The input
+ format must be the one used by
+ <link href='www.gnome.org/projects/gnumeric/'>Gnumeric
</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="poi"/>
<property name="version" value="@@DATE@@"/>
@@ -378,6 +425,9 @@
<project name="cocoon-block-naming" status="stable" dir="src/blocks/naming">
<package>org.apache.cocoon</package>
+ <description>Provides the LDAPTransformer, for LDAP access. "Naming"
+ comes from the N in <link
href='java.sun.com/products/jndi/'>JNDI</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="naming"/>
<property name="version" value="@@DATE@@"/>
@@ -399,6 +449,9 @@
<project name="cocoon-block-jsp" status="stable" dir="src/blocks/jsp">
<package>org.apache.cocoon</package>
+ <description>Provides the JSPGenerator, JSPReader, utility components.
+ Include samples.</description>
+
<ant target="gump-block">
<property name="block-name" value="jsp"/>
<property name="version" value="@@DATE@@"/>
@@ -418,6 +471,9 @@
<project name="cocoon-block-php" status="deprecated" dir="src/blocks/php">
<package>org.apache.cocoon</package>
+ <description>Provides the PHPGenerator. This block is considered
deprecated.
+ The servlet that is distributed with PHP never worked
correctly.</description>
+
<ant target="gump-block">
<property name="block-name" value="php"/>
<property name="version" value="@@DATE@@"/>
@@ -438,6 +494,8 @@
<project name="cocoon-block-python" status="stable" dir="src/blocks/python">
<package>org.apache.cocoon</package>
+ <description>Enables to use the Python language in XSP pages</description>
+
<ant target="gump-block">
<property name="block-name" value="python"/>
<property name="version" value="@@DATE@@"/>
@@ -458,6 +516,10 @@
<project name="cocoon-block-lucene" status="stable" dir="src/blocks/lucene">
<package>org.apache.cocoon</package>
+ <description>Provides the components needed to add full text search to
+ your site, including the LuceneIndexTransformer. See also
+ <link href='jakarta.apache.org/lucene/docs/index.html'>the Lucene
website</link></description>
+
<ant target="gump-block">
<property name="block-name" value="lucene"/>
<property name="version" value="@@DATE@@"/>
@@ -479,6 +541,10 @@
<project name="cocoon-block-html" status="stable" dir="src/blocks/html">
<package>org.apache.cocoon</package>
+ <description>Provides the html file generator which extract xhtml sax
+ events from any html file. It is based on
+ <link href='sourceforge.net/projects/jtidy'>jtidy</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="html"/>
<property name="version" value="@@DATE@@"/>
@@ -502,6 +568,12 @@
<project name="cocoon-block-bsf" status="stable" dir="src/blocks/bsf">
<package>org.apache.cocoon</package>
+ <description> The Bean Scripting Framework (BSF) incorporate scripting
into
+ Cocoon. Using BSF, an application can use scripting, and become
scriptable,
+ against any BSF-supported language. When BSF supports additional
languages,
+ the application will automatically support the additional languages.
Provides
+ ScriptAction and ScriptGenerator. Include the required bsf
libraries.</description>
+
<ant target="gump-block">
<property name="block-name" value="bsf"/>
<property name="version" value="@@DATE@@"/>
@@ -530,6 +602,9 @@
<project name="cocoon-block-profiler" status="stable"
dir="src/blocks/profiler">
<package>org.apache.cocoon</package>
+ <description>Provides the ProfilerGenerator, which allows you to debug
+ and profile your pipelines.</description>
+
<ant target="gump-block">
<property name="block-name" value="profiler"/>
<property name="version" value="@@DATE@@"/>
@@ -548,6 +623,10 @@
<project name="cocoon-block-velocity" status="stable"
dir="src/blocks/velocity">
<package>org.apache.cocoon</package>
+ <description> This is a generator that uses the velocity template engine
+ to feed velocity documents into the Cocoon pipeline. See
+ <link href='jakarta.apache.org/velocity/'>Velocity</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="velocity"/>
<property name="version" value="@@DATE@@"/>
@@ -569,6 +648,12 @@
<project name="cocoon-block-linkrewriter" status="stable"
dir="src/blocks/linkrewriter">
<package>org.apache.cocoon</package>
+ <description>Provides the LinkRewriterTansformer and the
+ VariableRewriterTransformer. These allow you to change links in your
pages,
+ for something as simple as adding a request parameter to every URL, or
+ something more complicated as changing links to point elsewhere. See
the
+ samples and the Javadocs for the components for more
information.</description>
+
<ant target="gump-block">
<property name="block-name" value="linkrewriter"/>
<property name="version" value="@@DATE@@"/>
@@ -588,6 +673,9 @@
<project name="cocoon-block-web3" status="stable" dir="src/blocks/web3">
<package>org.apache.cocoon</package>
+ <description>Enables Cocoon to comunicate with SAP R/3(TM). Further
+ information can be found in the documentation.</description>
+
<ant target="gump-block">
<property name="block-name" value="web3"/>
<property name="version" value="@@DATE@@"/>
@@ -609,6 +697,8 @@
<project name="cocoon-block-slide" status="unstable" dir="src/blocks/slide">
<package>org.apache.cocoon</package>
+ <description>Jakarta Slide integration.</description>
+
<ant target="gump-block">
<property name="block-name" value="slide"/>
<property name="version" value="@@DATE@@"/>
@@ -642,6 +732,10 @@
<project name="cocoon-block-proxy" status="unstable" dir="src/blocks/proxy">
<package>org.apache.cocoon</package>
+ <description>Provides some generators which proxy requests to remote
+ HTTP servers, including the HttpProxyGenerator and the
+ WebServiceProxyGenerator.</description>
+
<ant target="gump-block">
<property name="block-name" value="proxy"/>
<property name="version" value="@@DATE@@"/>
@@ -666,6 +760,10 @@
<project name="cocoon-block-xmldb" status="stable" dir="src/blocks/xmldb">
<package>org.apache.cocoon</package>
+ <description>Provides infrastructure for connecting to XML Databases
+ using a number of methods, including the XMLDBGenerator,
+ XMLDBCollectionGenerator, DbXMLAuthenticatorAction, and the
XMLDBTransformer.</description>
+
<ant target="gump-block">
<property name="block-name" value="xmldb"/>
<property name="version" value="@@DATE@@"/>
@@ -694,6 +792,9 @@
<project name="cocoon-block-deli" status="unstable" dir="src/blocks/deli">
<package>org.apache.cocoon</package>
+ <description>Provides deli and rdffilter libs, DeliTransformer, as well as
+ the custom Deli components that Cocoon needs.</description>
+
<ant target="gump-block">
<property name="block-name" value="deli"/>
<property name="version" value="@@DATE@@"/>
@@ -721,6 +822,9 @@
<project name="cocoon-block-asciiart" status="unstable"
dir="src/blocks/asciiart">
<package>org.apache.cocoon</package>
+ <description>Provides a generator for reading ASCII art files and
+ rendering them into images.</description>
+
<ant target="gump-block">
<property name="block-name" value="asciiart"/>
<property name="version" value="@@DATE@@"/>
@@ -741,6 +845,10 @@
<project name="cocoon-block-mail" status="unstable" dir="src/blocks/mail">
<package>org.apache.cocoon</package>
+ <description>Functionality for sending mail using the SendmailAction,
+ a Sendmail Logicsheet for your XSPs, and an experimental IMAPGenerator.
+ There is also a WebMail application included in the samples for this
block.</description>
+
<ant target="gump-block">
<property name="block-name" value="mail"/>
<property name="version" value="@@DATE@@"/>
@@ -765,6 +873,9 @@
<project name="cocoon-block-axis" status="unstable" dir="src/blocks/axis">
<package>org.apache.cocoon</package>
+ <description>Provides the AxisRPCReader, which accepts a SOAP request.
+ Allows you to serve SOAP requests from your Cocoon
application.</description>
+
<ant target="gump-block">
<property name="block-name" value="axis"/>
<property name="version" value="@@DATE@@"/>
@@ -793,6 +904,8 @@
<project name="cocoon-block-taglib" status="unstable"
dir="src/blocks/taglib">
<package>org.apache.cocoon</package>
+ <description>Provides taglib capabilities.</description>
+
<ant target="gump-block">
<property name="block-name" value="taglib"/>
<property name="version" value="@@DATE@@"/>
@@ -811,6 +924,8 @@
<project name="cocoon-block-forms" status="unstable" dir="src/blocks/forms">
<package>org.apache.cocoon</package>
+ <description>Cocoon Forms - Cocoon's implementation of form
handling.</description>
+
<ant target="gump-block">
<property name="block-name" value="forms"/>
<property name="version" value="@@DATE@@"/>
@@ -845,6 +960,9 @@
<project name="cocoon-block-woody" status="deprecated"
dir="src/blocks/woody">
<package>org.apache.cocoon</package>
+ <description>Provides a form framework. Include samples. Deprecated -
+ see forms block.</description>
+
<ant target="gump-block">
<property name="block-name" value="woody"/>
<property name="version" value="@@DATE@@"/>
@@ -870,6 +988,8 @@
<project name="cocoon-block-qdox" status="unstable" dir="src/blocks/qdox">
<package>org.apache.cocoon</package>
+ <description>Parse JavaDocs using <link
href='qdox.codehaus.org/'>QDox</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="qdox"/>
<property name="version" value="@@DATE@@"/>
@@ -891,6 +1011,9 @@
<project name="cocoon-block-portal" status="stable" dir="src/blocks/portal">
<package>org.apache.cocoon</package>
+ <description>Provides the components for a framework for building
+ portals within Cocoon.</description>
+
<ant target="gump-block">
<property name="block-name" value="portal"/>
<property name="version" value="@@DATE@@"/>
@@ -923,6 +1046,8 @@
<project name="cocoon-block-petstore" status="unstable"
dir="src/blocks/petstore">
<package>org.apache.cocoon</package>
+ <description>The Cocoon flowscript version of the J2EE
PetStore.</description>
+
<ant target="gump-block">
<property name="block-name" value="petstore"/>
<property name="version" value="@@DATE@@"/>
@@ -945,6 +1070,9 @@
<project name="cocoon-block-stx" status="unstable" dir="src/blocks/stx">
<package>org.apache.cocoon</package>
+ <description>Allows you to use <link
href='stx.sourceforge.net/'>STX</link>
+ for transforming your documents.</description>
+
<ant target="gump-block">
<property name="block-name" value="stx"/>
<property name="version" value="@@DATE@@"/>
@@ -968,6 +1096,9 @@
<project name="cocoon-block-linotype" status="unstable"
dir="src/blocks/linotype">
<package>org.apache.cocoon</package>
+ <description>Linotype is a robust weblogging tool written on top of
Cocoon.
+ Check out the samples for more info.</description>
+
<ant target="gump-block">
<property name="block-name" value="linotype"/>
<property name="version" value="@@DATE@@"/>
@@ -986,6 +1117,10 @@
<project name="cocoon-block-webdav" status="unstable"
dir="src/blocks/webdav">
<package>org.apache.cocoon</package>
+ <description>Provides interconnectivity for
+ <link href='www.webdav.org/'>WebDav</link>. Allows you to use WebDav
sources
+ and also provides the DASLTransformer. Check out the samples for more
info.</description>
+
<ant target="gump-block">
<property name="block-name" value="webdav"/>
<property name="version" value="@@DATE@@"/>
@@ -1012,6 +1147,9 @@
<project name="cocoon-block-eventcache" status="unstable"
dir="src/blocks/eventcache">
<package>org.apache.cocoon</package>
+ <description>Event-based cache invalidation, where the events are external
+ to Cocoon, such as a database update. See the samples for more
info.</description>
+
<ant target="gump-block">
<property name="block-name" value="eventcache"/>
<property name="version" value="@@DATE@@"/>
@@ -1034,6 +1172,9 @@
<project name="cocoon-block-apples" status="unstable"
dir="src/blocks/apples">
<package>org.apache.cocoon</package>
+ <description>Apples is a new flow implementation for Cocoon that allows
+ you to write your deciding flow components (business logic) in pure OO
Java.</description>
+
<ant target="gump-block">
<property name="block-name" value="apples"/>
<property name="version" value="@@DATE@@"/>
@@ -1053,6 +1194,9 @@
<project name="cocoon-block-querybean" status="unstable"
dir="src/blocks/querybean">
<package>org.apache.cocoon</package>
+ <description>Allows more complex queries to be built up and run
+ against a lucene full text database.</description>
+
<ant target="gump-block">
<property name="block-name" value="querybean"/>
<property name="version" value="@@DATE@@"/>
@@ -1075,6 +1219,9 @@
<project name="cocoon-block-slop" status="unstable" dir="src/blocks/slop">
<package>org.apache.cocoon</package>
+ <description>Simple Line Oriented Parser. Allows you to parse text files
+ using the SlopGenerator.</description>
+
<ant target="gump-block">
<property name="block-name" value="slop"/>
<property name="version" value="@@DATE@@"/>
@@ -1093,6 +1240,11 @@
<project name="cocoon-block-midi" status="unstable" dir="src/blocks/midi">
<package>org.apache.cocoon</package>
+ <description>The MIDI block provides components to generate XMidi (an XML
+ representation of MIDI) from a MIDI file, and to serialize XMidi back
+ to a MIDI file. There are also simple stylesheets for transposition
+ and inversion.</description>
+
<ant target="gump-block">
<property name="block-name" value="midi"/>
<property name="version" value="@@DATE@@"/>
@@ -1111,6 +1263,10 @@
<project name="cocoon-block-cron" status="unstable" dir="src/blocks/cron">
<package>org.apache.cocoon</package>
+ <description>Provides a cron scheduler. Helps to run some task at
+ defined intervals of time. Eg: every day at 4:00 a.m. run
+ maintenance of the database</description>
+
<ant target="gump-block">
<property name="block-name" value="cron"/>
<property name="version" value="@@DATE@@"/>
@@ -1134,6 +1290,9 @@
<project name="cocoon-block-ojb" status="stable" dir="src/blocks/ojb">
<package>org.apache.cocoon</package>
+ <description>Provides components to use
+ <link href='db.apache.org/ojb/'>Apache OJB</link>.</description>
+
<ant target="gump-block">
<property name="block-name" value="ojb"/>
<property name="version" value="@@DATE@@"/>
@@ -1165,6 +1324,8 @@
<project name="cocoon-block-jms" status="unstable" dir="src/blocks/jms">
<package>org.apache.cocoon</package>
+ <description>Support for JMS within Cocoon</description>
+
<ant target="gump-block">
<property name="block-name" value="jms"/>
<property name="version" value="@@DATE@@"/>
@@ -1190,6 +1351,8 @@
<project name="cocoon-block-repository" status="unstable"
dir="src/blocks/repository">
<package>org.apache.cocoon</package>
+ <description>Provides interfaces to document repositories.</description>
+
<ant target="gump-block">
<property name="block-name" value="repository"/>
<property name="version" value="@@DATE@@"/>
@@ -1211,6 +1374,11 @@
<project name="cocoon-block-paranoid" status="stable"
dir="src/blocks/paranoid">
<package>org.apache.cocoon</package>
+ <description>Provides the ParanoidCocoonServlet which uses a
ParanoidClassLoader.
+ This can get around complex classloading issues, e.g. when the servlet
+ container needs an older version of a library, and the Cocoon application
+ requires a newer incompatible version.</description>
+
<ant target="gump-block">
<property name="block-name" value="paranoid"/>
<property name="version" value="@@DATE@@"/>
@@ -1230,6 +1398,9 @@
<project name="cocoon-block-xsp" status="stable" dir="src/blocks/xsp">
<package>org.apache.cocoon</package>
+ <description>The XSP language allows the creation of content in a
+ combination of Java and XML. Its use is no longer
recommended.</description>
+
<ant target="gump-block">
<property name="block-name" value="xsp"/>
<property name="version" value="@@DATE@@"/>
@@ -1251,6 +1422,8 @@
<project name="cocoon-block-javaflow" status="unstable"
dir="src/blocks/javaflow">
<package>org.apache.cocoon</package>
+ <description>A Java implementation of the Javascript flow script
engine.</description>
+
<ant target="gump-block">
<property name="block-name" value="javaflow"/>
<property name="version" value="@@DATE@@"/>
@@ -1271,6 +1444,9 @@
<project name="cocoon-block-serializers" status="unstable"
dir="src/blocks/serializers">
<package>org.apache.cocoon</package>
+ <description>Alternative implementation of text, XML, HTML and XHTML
+ serializers that do not use Xalan.</description>
+
<ant target="gump-block">
<property name="block-name" value="serializers"/>
<property name="version" value="@@DATE@@"/>
@@ -1292,6 +1468,8 @@
<project name="cocoon-block-tour" status="unstable" dir="src/blocks/tour">
<package>org.apache.cocoon</package>
+ <description>A guided tour of Cocoon, showing off many of its
features.</description>
+
<ant target="tour-block">
<property name="block-name" value="tour"/>
<property name="version" value="@@DATE@@"/>
@@ -1312,6 +1490,9 @@
<project name="cocoon-block-faces" status="unstable" dir="src/blocks/faces">
<package>org.apache.cocoon</package>
+
+ <description>An implementation of Java Server Faces (JSF) using
+ MyFaces within Cocoon.</description>
<ant target="faces-block">
<property name="block-name" value="faces"/>
