cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bernhard Huber <>
Subject Re: Javadocs: need basic package information
Date Wed, 25 Dec 2002 09:12:43 GMT
>>* add a packages.dtd ala faq.dtd
> Yes, it is good to constrain the content.
> How much constraint is suitable? Perhaps faq.dtd
> is too loose, e.g. it allows <table> ...
> On the other hand, perhaps we should not try to
> pre-determine the content model. 
Hmm, i think we should reuse as much document-v10.dtd
as possible to keep the docs structure coherent.

Moreover I think packages.xml should reside in the xdocs/developing
directory of cocoon documentation.

* package.dtd suggestion:

<!-- augment standard header with local header elements names
   since : add Cocoon XX.YY version info here
<!ENTITY % local.headers ", since">

<!ENTITY % document-dtd SYSTEM "document-v10.dtd">

<!-- =============================================================== -->
<!-- Document Type Definition -->
<!-- =============================================================== -->

<!ELEMENT packages (authors?, package)+>
   packages %common.att;

<!ELEMENT package (header, description, appendices?)>
<!ATTLIST package

<!ELEMENT since (#PCDATA)>

<!ELEMENT description (anchor|figure| %blocks;)+>
<!ATTLIST description %common.att;>

<!ELEMENT appendices (%sections;)+>
<!ATTLIST appendices %common.att;>

* package.xml sample :
<?xml version="1.0" encoding="UTF-8"?>

   <package name="org.apache.cocoon">
       <title>Provides interfaces, classes, and exceptions of Cocoon's
       <type>API documentation</type>
         <person name="Bernhard Huber" email=""/>
       <since>Cocoon 2.0"</since>

         The Cocoon processor is the top-level controller of the Cocoon
         The interface Processor defines the basic contract of the Cocoon
         The class Cocoon implements the Processor interface.
         The Cocoon processor is an Avalon component, processing an
         Environment object.
         The Environment is created in a concrete runtime environment,
         Servlet environment, and Commandline environment.
       <s1 title="Specification">
       <s1 title="See Also">
   <!-- more packages -->

> I am not sure what you mean by "specs documents", and i have
> never understood what this DTD was intended for.
well, writting specs for sitemap components, et al.

bye bernhard

To unsubscribe, e-mail:
For additional commands, email:

View raw message