cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Konstantin Piroumian <kpiroum...@apache.org>
Subject Re: Samples Refactoring: Documentation Structure
Date Mon, 27 May 2002 09:06:44 GMT
From: "Nicola Ken Barozzi" <nicolaken@apache.org>

> The Cocoon samples have always grown in a very patchy manner, and the
Webapp
> site has buonced between a big fat page and a more structured one.
>
> I have never been happy with either approach, and am unable myself to make
> it better.
>
> Diana, Doc People, could you please look into this?

A while ago I've proposed to use document DTD format for the samples that
does not require any custom formatting, but there were no any comment to it.
I noticed that some of the samples are using already the documentation
structure (Calculator, Tutorial - is this one really a sample?), others use
something else.

It'd be fine to refactor not only the samples, but also the Cocoon
front-page and samples index pages to use the same L & F. I'd also like to
have a plain table with a list of samples instead of current blocked
structure. Every block can have a single entry in the table and then provide
links for all its specific things. E.g.:
| Multimedia Hello World | A sample to show the power of Cocoon in serving
multiple formats from the same source |

I'd like also to propose some requirements/wishes to samples organization.
They should:
    - have a subsitemap where all the used (specific to the sample)
components are declared
    - provide a default access URI (like: /samples/i18n/, /samples/jsp/)
    - provide 'View source' links (where possible)
    - provide 'View sitemap source' link
    - can have also links to according docs, howtos, etc.

I'm not sure about the current directory organization when all the used
stylesheets are stored in one location. I'd prefer if all the custom
resources used only by a particular sample be located under its directory.
Samples can have a predefined set of common resources that can be accessed
using src="context://samples/[common-styles.xsl]" path.

What do you think, people?

Konstantin

>
> Thanks :-)
>
> --
> Nicola Ken Barozzi                   nicolaken@apache.org
>             - verba volant, scripta manent -
>    (discussions get forgotten, just code remains)
> ---------------------------------------------------------------------
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
> For additional commands, email: cocoon-dev-help@xml.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org


Mime
View raw message