On Sat, 2003-03-15 at 17:40, Chris K Chew wrote:
> Hi Jeff.
> 
> It will definitely fit in!
> 
> But I suggest you wait a bit...There is talk about going away from xdoc
> towards something more robust like docbook.  

That's not going to happen so long as I'm around here. 

1) Docbook is massive and for the most part it's overkill for the type
of documentation written in these parts.

2) If it is desired to support multiple formats that is fine but the
anakia format has been around a long time and serves it's purpose well
and should remain the primary format.

I spent an inordinate amount of time converting the original text-based
documents to stylebook, then anakia format. It is easy enough to
transform to something else but I don't think that is really going to
buy us anything.

How about writing some documentation first. I have seen many of these
many half-hearted attempts, 4 if remember correctly, and I hope this one
if different. I would recommend working up some content and taking it in
all its forms before trying to change the infrastructure for the sake of
changing the infrastructure. The anakia format, for better for worse, is
the defacto standard in Jakarta and someone will have to do some serious
convincing before I life this -1 as that format as the primary form of
our documentation. If you don't want to use anakia, or maven there are
stylesheets that Craig has made that use the simple <style> task to
transform the docs.

Also there are maven plugins that support simple docbook, plain simple
text RST docs and now plain html with a plugin James Strachan just
wrote.

> It might be wise for us to
> decide on a format and start from there.
> 
> If you have any experience with documentation technologies, be sure and
> chime into turbine-dev for the discussion.

You write the documentation in _any_ form (on a napkin even) and I will
volunteer to get it into a format that can be published. The whole
infrastructure does not need to be redone again.

> Thanks,
> 
> Chris
> 
> 
> > -----Original Message-----
> > From: Jeff Linwood [mailto:[EMAIL PROTECTED]
> > Sent: Saturday, March 15, 2003 11:41 AM
> > To: Turbine Users List
> > Subject: Turibne Concepts
> >
> >
> > So it looks like my Turbine Concepts article fits into the outline of
> > the user's guide - should we use it as a base, or should I rewrite it as
> > an xdoc and submit it as it stands to the Turbine documentation?
> >
> > jeff
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > For additional commands, e-mail: [EMAIL PROTECTED]
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
-- 
jvz.

Jason van Zyl
[EMAIL PROTECTED]
http://tambora.zenplex.org

In short, man creates for himself a new religion of a rational
and technical order to justify his work and to be justified in it.
  
  -- Jacques Ellul, The Technological Society


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


Reply via email to