cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mikhail Fedotov" <mikh...@kittown.com>
Subject Re: document structure
Date Thu, 03 Jan 2002 21:47:15 GMT
Hi!

> My 0.02 cents inline:

I'll give my 0.02 cents also:

> >- Getting started

... and here goes brief description of section, AND link to
 one single page containing the whole section, as well as a
 group of links to those parts in separate pages.

It is really painfull to search for information in all
 those zillions of pages when it is possible to make one
 with a nice index at the top, that's why I'm writing this.
 

Of course, there are cases where lesser pages are useful,
 but for me in most cases it is much easier to use one
 single document, even if site provides nice seach
 capability and reasonable structure of documentation.

> >  - What you should know/read

And maybe it is a good idea to provide such a page for
 every level of hierarchy, except some higher levels where
 it becomes too big and require simpler html/txt formatting
 to keep size reasonable. But I don't think that current
 HTML docs of cocoon won't fit in a meg or to, excluding
 pictures and javadoc.

> >    - XML references
> >    - Avalon
> >  - Basics
> >    - Pipeline processing
> >  - Quick setup/installation
> 
> - In Detail (naming not fix)
>  - Sitemap
>    - Actions
>    - ...
>  - Components
>    - Pipelines
>    - ...
> 
> - Developer Corner
>   - API
>   - Extending
>   - ...
> 
> >- Some Samples
> >  - Hello World XML sample
> >    - the Content
> >    - the Stylesheet
> >    - the Sitemap
> >  - Hello Worl XSP sample
> >    ...
> >  - Aggregation
> >  - More Advanced samples
> >- Configurations
> >  - web.xml
> >  - cocoon.xconf
> >  - logkit.xconf
> >- Tuning
> >  - Component pools
> >  - Cache
> >  - Pipeline tuning
> >- Installation references
> 
>   Gerhard
> 

Mikhail

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


Mime
View raw message