[Insight-developers] First crack at usage documentation

Sayan Pathak spathak@statsci.com
Thu, 21 Dec 2000 10:18:07 -0800


Well I haven't looked into DocBook. But my brief experience with work in the
last to days was not good. In fact I wrote a lot of it in word and after
saving it in html format, word promptly cleaned up all the formatting like
background color. The documentation was so dry that I believe even a
motivated reader would think twice. Besides, word puts word-specific tags in
the HTML code. I came across this one when using a HTML editor (called
HomeSite part of Dreamweaver) used in our company.

However, I like the idea of having a standardize documentation approach. We
need to precipitate on a consistent format endorsed by the group. I am not
sure if  use of an opensource documentation standard should be a must.

-Sayan

-----Original Message-----
From: Bill Hoffman [mailto:bill.hoffman@kitware.com]
Sent: Thursday, December 21, 2000 8:14 AM
To: Daniel J. Blezek, Ph.D.; Will Schroeder
Cc: spathak@statsci.com; insight-developers@public.kitware.com;
aylward@unc.edu
Subject: Re: [Insight-developers] First crack at usage documentation


I really think that a modern graphical editor should be used.
What about Word, and StarOffice for opensource.   We could
save the files in Work 6.0 or RTF, and make sure that it stays
working in Staroffice.

-Bill


At 07:32 AM 12/21/00 -0500, Daniel J. Blezek, Ph.D. wrote:
>Will, et. al.,
>
> > Issues: I'd also like to settle on a implementation (e.g.,
> > Word, etc.) that can be used to create both a nice looking text as
> > well as producing html.  I'd also like to adopt some styles that are
> > reasonable consistent. Suggestions?
>
>   The DocBook framework allows anyone with a text editor to create nice
>looking print/PDF/HTML material.  It is written in XML, and should be easy
>to pick up by everyone.  From the DocBook file, we could generate a
>variety of formats.  More information about DocBook is at
>http://www.docbook.org  -- In the OpenSource spirit of Insight, I would
>suggest that on OpenSource documentation format be appropriate.
>
>-dan
>
>--
>Daniel Blezek, Ph.D.
>blezek@crd.ge.com
>Visual Information Program
>Electronic Systems Lab
>GE Corporate Research & Development
>
>
>_______________________________________________
>Insight-developers mailing list
>Insight-developers@public.kitware.com
>http://public.kitware.com/mailman/listinfo/insight-developers