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 Tue, 28 May 2002 14:00:56 GMT
Welcome back, Diana ;)

From: "Diana Shannon" <terracare@mac.com>

>
> On Monday, May 27, 2002, at 05:06  AM, Konstantin Piroumian wrote:
>
> > 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.
>
> If you don't want to use a specific DTD (other than document dtd) then
> you at least need some shining examples and a template file. IMO,
> designing a example.dtd would help but perhaps this comes (as a second
> phase effort) once you've done the initial refactoring.

Yes, you are right.

>
> > 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.
> I agree. We should make this consistent.
>
> > 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.
> +1
>
> > 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 |
> Yes, you also should include content like last modified date, etc.
>
> > 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.
> +1
>   We need to keep it modular and easy to maintain.
>
> > 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?
>
> Go for it! Would it be too awkward to add a sample of this work first to
> Forrest (so we extend other modular approaches being proposed there)? I
> suspect we'll find some parallel issues and end up solving joint
> problems.

My proposal is somewhat Cocoon specific, because the samples should have
their own mounted sitemap, while the Forrest users should not be required to
know about how to the sitemap. See latest emails from Steven at forrest-dev.

To see examples of self contained samples look at '/samples/i18n' or
'/samples/jsp/'.

Konstantin

>
> Diana
>
>
> ---------------------------------------------------------------------
> 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