cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Cocoon Wiki] Update of "CocoonRefDocProject" by BertrandDelacretaz
Date Tue, 07 Jun 2005 09:54:03 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Cocoon Wiki" for change notification.

The following page has been changed by BertrandDelacretaz:
http://wiki.apache.org/cocoon/CocoonRefDocProject

------------------------------------------------------------------------------
  First specification for the [http://wiki.apache.org/general/SummerOfCode2005#cocoon-refdoc
cocoon-refdoc project] of the GoogleSummerOfCode2005.
  
- The project mentors are [BertrandDelacretaz] and [RossGardler].
+ The project mentors are [BertrandDelacretaz] and Ross Gardler (who doesn't have a page here
but is part of the Forrest team).
  
  = Overview =
+ The goal of the project is to 'Generate reference documentation by extracting, indexing
and assembling snippets of information from annotated java, XML, XSLT and other source code'.

+ 
+ The system will be used mainly for Cocoon itself, but applies to any code.
+ 
+ The main goal is to generate reference documentation for Cocoon itself, in XML form which
will be converted to HTML for web publication, either using Forrest, Daisy or a specific mechanism.
  
  = Current situation =
+ Although there are quite a lot of documents, the Cocoon documentation is not well organized
and information is hard to find.
+ 
+ Realizing that the many existing examples are often the best source of precise information,
this project aims to extract the reference information directly from the source code, by annotating
the code and extracting snippets of information from the various files (java code, sitemaps,
configuration files, XML input files, XSLT stylesheets, etc) which compose a Cocoon example
or application.
+ 
+ This will be applied mainly to the Cocoon sitemap components (Generators, Transformers,
Serializers, etc.), and to the many examples provided with Cocoon.
  
  = Use-cases =
  

Mime
View raw message