cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Carsten Ziegeler" <cziege...@sundn.de>
Subject AW: [C2]: Documentation System
Date Tue, 02 Oct 2001 12:30:12 GMT
I like to answer my own mails....

A first version of the documentation system is finished.
It generates all documents including the images for the
labels and headers.
The only thing currently missing is the "site" target,
which means for generating the documentation for the
web-site, a different book is used as there are some
other links available in the navigation bar.

Please, have a look at it and decide if we could switch.


Carsten

Open Source Group                        sunShine - b:Integrated
================================================================
Carsten Ziegeler, S&N AG, Klingenderstrasse 5, D-33100 Paderborn
www.sundn.de                          mailto: cziegeler@sundn.de
================================================================

> Carsten Ziegeler wrote:

> -----Urspr√ľngliche Nachricht-----
> Von: Carsten Ziegeler [mailto:cziegeler@sundn.de]
> Gesendet: Freitag, 28. September 2001 15:50
> An: cocoon-dev@xml.apache.org
> Betreff: AW: [C2]: Documentation System
>
>
> Hi Team,
>
> due to some lack of time, I just checked-in a very earlier
> and ugly version of the documentation system. I checked
> in only into the head of the cvs.
> It's based on the avalon solution and uses the cli of
> cocoon to build the docs.
> The build target is "newdocs", all files are located
> in the documentation directory.
> There you find a sitemap, some stylesheets and all xdocs.
> I started to outline the docs to the proposal from Berin
> but didn't come very far...
>
> What has to be done:
> - Totally missing is the image generation for the labels.
>   I started some svg tests (a starting point is the
>   svg directory in the documentation directory).
> - All documentation has to be entered at two places:
>   the book.xml for describing the documentation outline
>   and the *.uris files which are used as input to c2
>   to build the docs.
>   I think we should unify this and generate from the
>   book.xml a *.uris file
> - The stylesheets currently do not cover all areas.
> ....
>
> So just play a little bit with it and enhance it, please.
> And if you think: "Oh my, that's crap" just change it
> the way you want.
>
> Carsten
>
> > Carsten Ziegeler wrote:
> >
> > Hi Team,
> >
> > for the final release of C2 we should take some time and
> > update the documentation.
> > Several weeks ago, Berin made a very good proposal
> > for outlining the documentation
> > (see
http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=99831665304443&w=2).
>
> I think as we developed Cocoon we should also use
> Cocoon to build the documentation!
>
> The Avalon project shows how to do this. Now, I
> just started to adapt the Avalon documentation
> build system to ours. Making it really working
> well and maintainable will be a more complex
> effort than I thought it is.
> So before I go any further, we should
> vote on this topic.
>
> So lets vote if we still should use stylebook
> or we should "update" to Cocoon for docs
> generation. Please note that this question
> has nothing to do with the question of
> the format the docs are written in!
> That's a separate task!
>
> Although it's a lot of work my vote:
> +1 on using cocoon
>
>
> Carsten
>
> Open Source Group                        sunShine - b:Integrated
> ================================================================
> Carsten Ziegeler, S&N AG, Klingenderstrasse 5, D-33100 Paderborn
> www.sundn.de                          mailto: cziegeler@sundn.de
> ================================================================
>
>
> ---------------------------------------------------------------------
> 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


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


Mime
View raw message