Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-23 Thread Andrew C. Oliver

*shrugs*

On Sat, 2002-03-23 at 00:14, [EMAIL PROTECTED] wrote:
 Andrew C. Oliver [EMAIL PROTECTED] wrote on 22/03/2002 11:58:20 PM:
 
  Perhaps you should contribute to the project. 
  
 [snip]
 
 No point really.
 
  
  Your message to me suggests that you think I care whether you use
  centipede or not.  You are mistaken.  It works for me.  If it works for
  you, cool.  If not, use whatever.  Be free. 
  
  singingChorusEnd title=Born Free/
 
 Done. I'll spend my time making site2 a better vehicle for docs.
 
  
  -Andy
 [snip]
 
 --
 dIon Gillard, Multitask Consulting
 Work:  http://www.multitask.com.au
 Developers: http://www.multitask.com.au/developers
-- 
http://www.superlinksoftware.com
http://jakarta.apache.org/poi - port of Excel/Word/OLE 2 Compound
Document 
format to java
http://developer.java.sun.com/developer/bugParade/bugs/4487555.html 
- fix java generics!
The avalanche has already started. It is too late for the pebbles to
vote.
-Ambassador Kosh


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-22 Thread Andrew C. Oliver

On Thu, 2002-03-21 at 21:13, [EMAIL PROTECTED] wrote:
 Andrew C. Oliver [EMAIL PROTECTED] wrote on 22/03/2002 12:13:01 PM:
 
  On Thu, 2002-03-21 at 20:10, [EMAIL PROTECTED] 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?
 

http://cvs.apache.org/viewcvs/~checkout~/jakarta-poi/src/documentation/xdocs/book.xml?rev=1.9content-type=text/plain

The left nav bar basically.  I believe there is an example included.

  
   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.
 

Perhaps you could contribute to the documentation.  Personally, I didn't
have such problems.  (And I don't even mess with it on POI)

   If it's just for LF, 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? 

I did nothing to the sitemap

 What naming convention did you use for your files?

Random mood of what I felt like with .xml as the extension 
(there are files included)

 What directory did you put them in? /src/documentation/xdocs?

yes

 How did you work out what to put in the index.xml file?

One example of what I put in the index.xml file (though I use an older
version) was this http://www.trilug.org/~acoliver

 Where did you put the project specific images/css/js files?

I didn't.  Javascript is for losers.

 How did you include other files into the final directory structure?

images.

 How did you change the build file so it didn't generate all the Krysalis 
 stuff?
 

edit project-info.xml  change the name.  The doc's and stuff well you
already found those.

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

Perhaps you should contribute to the project.  

 Anyway most of this doesn't belong here, but it gives you an idea of the 
 sort questions that a 'user' might raise.

You're preaching to the documentation choir.  However build matters do
not particularly interest me.  I'm most interested in reducing object
counts in low level file format ports (
http://developer.java.sun.com/developer/bugParade/bugs/4487555.html )
without sacrificing usability, improving the documentation to Cocoon,
and adding application extensions to Lucene.  

Your message to me suggests that you think I care whether you use
centipede or not.  You are mistaken.  It works for me.  If it works for
you, cool.  If not, use whatever.  Be free.  

singingChorusEnd title=Born Free/

-Andy

 --
 dIon Gillard, Multitask Consulting
 Work:  http://www.multitask.com.au
 Developers: http://www.multitask.com.au/developers
-- 
http://www.superlinksoftware.com
http://jakarta.apache.org/poi - port of Excel/Word/OLE 2 Compound
Document 
format to java
http://developer.java.sun.com/developer/bugParade/bugs/4487555.html 
- fix java generics!
The avalanche has already started. It is too late for the pebbles to
vote.
-Ambassador Kosh


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-22 Thread Nicola Ken Barozzi

From: [EMAIL PROTECTED]

 Andrew C. Oliver [EMAIL PROTECTED] wrote on 22/03/2002 12:13:01 PM:
  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.

All these points are correct, and you have my backing.

Krysalis Centipede is in version 0.2, and it's still growing very fast.
The docs will start to come out as soon as the structure stabilizes.

Next version coming out next week will have:

- multiple skin support (jakarta and xml.apache LF)
- build target aliasing and description
- basic docs on how to start, and the dir layout
- gump descriptor integration with project-info
- examples jar build, along with proper, scratchpad and contrib
- new build script
- endorsed jar dir, used by both build and tools
- corrected dist target, with test run before jar generation
- new testmodule target that tests all the build
- new gump target
- ready for automatic site update from Gump runs

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

Patches are welcome ;-)

If any project wants to use Centipede in his build, we will help
them get it running, as already done with Jakarta POI,
xml-Forrest and Chaperon, and bring the benefits
of cross-project pollination to the build.

Since this topic doesn't properly belong to this list, I hope
that this brief explanation of Krysalis Centipede will be enough
to give a basic understanding of what the discussion was
about and move interested users to krysalis.org .

Thank you.

--
Nicola Ken Barozzi   [EMAIL PROTECTED]
- verba volant, scripta manent -
   (discussions get forgotten, just code remains)
-


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-22 Thread dion

Andrew C. Oliver [EMAIL PROTECTED] wrote on 22/03/2002 11:58:20 PM:

 Perhaps you should contribute to the project. 
 
[snip]

No point really.

 
 Your message to me suggests that you think I care whether you use
 centipede or not.  You are mistaken.  It works for me.  If it works for
 you, cool.  If not, use whatever.  Be free. 
 
 singingChorusEnd title=Born Free/

Done. I'll spend my time making site2 a better vehicle for docs.

 
 -Andy
[snip]

--
dIon Gillard, Multitask Consulting
Work:  http://www.multitask.com.au
Developers: http://www.multitask.com.au/developers



Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread dion

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.

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.

If it's just for LF, I'd much rather tweak the existing stylesheets.
--
dIon Gillard, Multitask Consulting
Work:  http://www.multitask.com.au
Developers: http://www.multitask.com.au/developers



Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread Andrew C. Oliver

On Thu, 2002-03-21 at 20:10, [EMAIL PROTECTED] 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.

 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.  

 If it's just for LF, 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.  :-)

-Andy

 --
 dIon Gillard, Multitask Consulting
 Work:  http://www.multitask.com.au
 Developers: http://www.multitask.com.au/developers
-- 
http://www.superlinksoftware.com
http://jakarta.apache.org/poi - port of Excel/Word/OLE 2 Compound
Document 
format to java
http://developer.java.sun.com/developer/bugParade/bugs/4487555.html 
- fix java generics!
The avalanche has already started. It is too late for the pebbles to
vote.
-Ambassador Kosh


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread Jon Scott Stevens

on 3/21/02 5:10 PM, [EMAIL PROTECTED] [EMAIL PROTECTED] wrote:

 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.

Imagine that.

-jon


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread Jeff Turner

On Fri, Mar 22, 2002 at 12:10:13PM +1100, [EMAIL PROTECTED] 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.
 
 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.

export
CVSROOT=:pserver:[EMAIL PROTECTED]:/cvsroot/krysalis
cvs login
cvs co krysalis-centipede
cd krysalis-centipede
chmod +x build.sh
./build.sh docs

Works fine for me. If you had problems, ask on the krysalis-users list.
The doc format is standard Apache document-v10.dtd. You only need to
edit the sitemap if your site has special needs, eg merging XML files
before processing, Docbook - stylebook, stylebook - PDF, svg - .png.
I find that being able to manage the generated site's URI space in one
file is very handy.

--Jeff

 If it's just for LF, I'd much rather tweak the existing stylesheets.
 --
 dIon Gillard, Multitask Consulting
 Work:  http://www.multitask.com.au
 Developers: http://www.multitask.com.au/developers

--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread Vladimir Bossicard

My 2 cents on printer friendly pages and documentation

I still like the idea of a generated pdf document for the documentation. 
  Avalon already provides a pdf file and I personally find it very useful.

if cocoon/krysalis must be used to generate the website and (maybe) the 
pdf file, I really don't see the problem.  I think people in this 
community are smart enough to deal with that issue.  To ease the 
process, a separate ant file (jakarta.xml ?) can be provided, listing 
the required libraries, how to set up the environment and how to modify 
your actual xml files.

-Vladimir

-- 
Vladimir Bossicard
www.bossicard.com


--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]




Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread dion

Jeff Turner [EMAIL PROTECTED] wrote on 22/03/2002 12:43:37 PM:

 export
 
CVSROOT=:pserver:[EMAIL PROTECTED]:/cvsroot/krysalis
 cvs login
 cvs co krysalis-centipede
 cd krysalis-centipede
 chmod +x build.sh
 ./build.sh docs
 
 Works fine for me. If you had problems, ask on the krysalis-users list.

It works for me too, but that just builds the existing stuff. If I want to 
customise it

 The doc format is standard Apache document-v10.dtd. You only need to

'standard Apache' - is that Cocoon? Got a URL.

 edit the sitemap if your site has special needs, eg merging XML files
 before processing, Docbook - stylebook, stylebook - PDF, svg - .png.

And how am I to know that from the Centipede docs?

 I find that being able to manage the generated site's URI space in one
 file is very handy.

It is, but there's no real detail on how to do it though.
--
dIon Gillard, Multitask Consulting
Work:  http://www.multitask.com.au
Developers: http://www.multitask.com.au/developers



Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread dion

Andrew C. Oliver [EMAIL PROTECTED] wrote on 22/03/2002 12:13:01 PM:

 On Thu, 2002-03-21 at 20:10, [EMAIL PROTECTED] 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 LF, 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



Re: Krysalis, Centipede, Generating docs with Cocoon?

2002-03-21 Thread Jeff Turner

Answered offlist. In the meanwhile, everyone pay homage to the
jakarta-site2 docs:

http://jakarta.apache.org/site/jakarta-site2.html

and acknowledge that anything less ain't good enough for everyday
Jakarta use.

The DVSL-based system that Jason van Zyl mentioned sounds best:

 Yup, that's my fault. I will remedy the situation with PDFs. A very
 long time ago before Anakia we had PDFs being produced with
 stylebook. The Turbine and Velocity docs were actually available in
 PDF format.  Anakia presented some problems that made it impossible
 to use the fop stuff we created but that is different now with DVSL.
 Long story short: you will have PDF docs for BCEL sooner rather than
 later.


--Jeff

On Fri, Mar 22, 2002 at 01:13:48PM +1100, [EMAIL PROTECTED] wrote:
...
  Works fine for me. If you had problems, ask on the krysalis-users list.
 
 It works for me too, but that just builds the existing stuff. If I want to 
 customise it

--
To unsubscribe, e-mail:   mailto:[EMAIL PROTECTED]
For additional commands, e-mail: mailto:[EMAIL PROTECTED]