FW: Krysalis, Centipede, Generating docs with Cocoon?

[Steven Noels <st...@outerthought.org>]

fyi

-----Original Message-----
From: dion@multitask.com.au [mailto:dion@multitask.com.au]
Sent: vrijdag 22 maart 2002 3:14
To: Jakarta General List
Subject: Re: Krysalis, Centipede, Generating docs with Cocoon?


"Andrew C. Oliver" <ac...@apache.org> wrote on 22/03/2002 12:13:01
PM:

> On Thu, 2002-03-21 at 20:10, dion@multitask.com.au wrote:
> > I downloaded Krysalis and Centipede,  hoping to find some easy way
of
> > building docs, but I was sorely disappointed. You have to know a ton
of
> > stuff about Cocoon, Cocoon's 'book' format (which isn't DocBook),
and
the
> > other tools involved to even get your head around it.
> >
>
> Umm... no not really.  I just set it up today for work with no prob.
> you just have to have a "book" file in there and change all <a>'s to
> <links> and thats pretty much it.

Huh? You have to have a book file? What's a book file? What's allowed in
it?

>
> > If you have to setup and run Cocoon to generate a few HTML files,
what's
> > the point? At least the process with site.vsl and site.xsl is
documented
> > and easy to set up, and requires no special knowledge, for most
commons
> > projects.
> >
>
> Centipede is a bit more than just a fancy way of doing sites.  It is a
> project starter template with some pretty nice stuff for separating
out
> ant targets and the such.  I like it.

You mean using entities to include files as the targets? That just made
it
harder for me to work out what was going on with the existing stuff.

As a template, it's way lacking on how to use it. For me it was like,
here's a sample project, feel free to hack it. 'Hack' == 'time'. I was
hoping for something with more detail on how to use it.

> > If it's just for L&F, I'd much rather tweak the existing
stylesheets.
>
> I'm not sure why you had so much trouble.  I barely put any effort in
it
> at all today and got a project with complex dependencies and some doco
> out in like 0 time flat.  And I don't proclaim to be a Cocoon expert
or
> even particularly intelligent.  :-)

I'm not claiming either, either. Especially the intelligent part, and it
is Friday :)

What did you put in the sitemap?
What naming convention did you use for your files?
What directory did you put them in? /src/documentation/xdocs?
How did you work out what to put in the index.xml file?
Where did you put the project specific images/css/js files?
How did you include other files into the final directory structure?
How did you change the build file so it didn't generate all the Krysalis
stuff?

There's no real explanation/docs on what to do with the
directories/files
provided.

Anyway most of this doesn't belong here, but it gives you an idea of the
sort questions that a 'user' might raise.
--
dIon Gillard, Multitask Consulting
Work:      http://www.multitask.com.au
Developers: http://www.multitask.com.au/developers