I'm not vehemently opposed to XML, I just personally don't like writing docs
in XML. I like to be able to see what I'm doing right away.

Can we use Ant's XSLT stuff without all the DocBook cruft? That would indeed
be much nicer.

My main objective is to have a standard documentation scheme for all OS
projects, that way a distribution from OpenSymphony will always have the
same layout for libs, examples, docs, etc.

-Pat

----- Original Message -----
From: "Bill Lynch" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Tuesday, December 10, 2002 9:47 AM
Subject: Re: [OS-webwork] Documentation


> Pat,
>
> Patrick Lightbody wrote:
> > Sitemesh can decorate HTML files, so why the jsp extension? The
OSWorkflow
> > docs are all HTML. I really do think that HTML docs are the best bet.
Makes
> > our life real simple -- plus including all the docbook crap in the CVS
build
> > is never fun.
>
> I agree with Ken - XML really is the way to go and I think it'd be simple
to
> edit. Each file would likely just be some document meta-data then just a
series
> of <p>...</p> tags - pretty simple. And, Ant has XSL transforming
built-in -
> just use that in lieu of the docbook stuff.
>
> I buy Ken's arguments tho - I'd be a shame not to use XML since it really
isn't
> that big of a deal to edit it and transform it.
>
> Ken - thanks so much for offering to do this! I'm excited that expert
looking
> docs will breathe new life into the WW project.
>
> Cheers,
> --Bill
>
> >
> > -Pat
> >
> > ----- Original Message -----
> > From: "Ken Egervari [eXtremePHP]" <[EMAIL PROTECTED]>
> > To: <[EMAIL PROTECTED]>
> > Sent: Tuesday, December 10, 2002 8:59 AM
> > Subject: Re: [OS-webwork] Documentation
> >
> >
> >
> >>I'll devise 2 stylesheets then.  One to transform the document for local
> >>viewing and another to make them look the same way they are now with the
> >>.jsp extension for the website.  This way, we can use sitemesh to
decorate
> >>one version and also have a local .html version.  This will ensure
> >>compatibility with the current method while still going with XML+XSLT.
> >>
> >>----- Original Message -----
> >>From: "Hani Suleiman" <[EMAIL PROTECTED]>
> >>To: <[EMAIL PROTECTED]>
> >>Sent: Tuesday, December 10, 2002 11:49 AM
> >>Subject: Re: [OS-webwork] Documentation
> >>
> >>
> >>
> >>>Well, they were changed to jsp, which is the worst of both worlds
> >
> > (require
> >
> >>>processing, and single output format)
> >>>
> >>>Quoting Rickard Öberg <[EMAIL PROTECTED]>:
> >>>
> >>>
> >>>>Ken Egervari [eXtremePHP] wrote:
> >>>>
> >>>>>Pat,
> >>>>>You think it's overkill?  I rather like the simplicty of XML.  I
> >
> > also
> >
> >>>>have
> >>>>
> >>>>>used XSLT in many solutions already and I wrote about too in one of
> >
> > my
> >
> >>>>>books.  Needless to say, I'm really confortable with it.
> >>>>
> >>>>FWIW the docs used to be in DocBook. They changed to HTML when I
> >
> > "left".
> >
> >>>>IMHO XML is a better way to do it, for the reasons you've mentioned.
> >
> > But
> >
> >>>>that's just me.
> >>>>
> >>>>/Rickard
> >>>>
> >>>>
> >>>>
> >>>>-------------------------------------------------------
> >>>>This sf.net email is sponsored by:ThinkGeek
> >>>>Welcome to geek heaven.
> >>>>http://thinkgeek.com/sf
> >>>>_______________________________________________
> >>>>Opensymphony-webwork mailing list
> >>>>[EMAIL PROTECTED]
> >>>>https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork
> >>>>
> >>>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>-------------------------------------------------------
> >>>This sf.net email is sponsored by:ThinkGeek
> >>>Welcome to geek heaven.
> >>>http://thinkgeek.com/sf
> >>>_______________________________________________
> >>>Opensymphony-webwork mailing list
> >>>[EMAIL PROTECTED]
> >>>https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork
> >>>
> >>
> >>
> >>
> >>-------------------------------------------------------
> >>This sf.net email is sponsored by:ThinkGeek
> >>Welcome to geek heaven.
> >>http://thinkgeek.com/sf
> >>_______________________________________________
> >>Opensymphony-webwork mailing list
> >>[EMAIL PROTECTED]
> >>https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork
> >
> >
> >
> >
> > -------------------------------------------------------
> > This sf.net email is sponsored by:ThinkGeek
> > Welcome to geek heaven.
> > http://thinkgeek.com/sf
> > _______________________________________________
> > Opensymphony-webwork mailing list
> > [EMAIL PROTECTED]
> > https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork
>
> --
> ----------------------------------
> Bill Lynch, Jive Software
> [EMAIL PROTECTED]
>
>
>
> -------------------------------------------------------
> This sf.net email is sponsored by:ThinkGeek
> Welcome to geek heaven.
> http://thinkgeek.com/sf
> _______________________________________________
> Opensymphony-webwork mailing list
> [EMAIL PROTECTED]
> https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
Opensymphony-webwork mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork

Reply via email to