Re: [Webware-discuss] Documentation format

[Ray L. <mai...@es...>]

I've already done some heavy work in transforming the OO-Xml files to other things.  It's definitely do-able, but from my perspective I'd rather go with something that VIM, or Emacs, or heck even nano can open.  reST seems to be amazingly easy.

I say go with reST, and we'll work out the translations later.  reST just seems like a much much better way to "write" content, and from a cursory overview of the site I think there's a tool to turn reST to html ... so not to very much of a leap to create xml.

So Ian, go with reST, but please let us know the conventions you're using for the docs.  From what I read (quick glimpse) there's no formal spec on the grammar.  So it's kinda open ended in that respect.

If you have some basic definitions for special characters / conventions that you would like to use for delimitting code-snippets, bookmarks / references to bookmarks, emphasis ( bold / italic / underline / crossed-out ).

I think that would be enough to get started.

Of course I could be wrong about the whole thing, but after having worked with the xml in the OpenOffice docs I think it's simpler / easier for writers to write in plain text, with just tabs / spacing to worry about.

Ray

On Wed, 30 Oct 2002 10:37:56 -0500
Matt Feifarek <ma...@da...> wrote:

> Ian Bicking wrote:
> 
> >The documentation format discussion kind of died down, but I'd like to
> >
> I know that I'm late to this discussion, but something has occurred to me.
> 
> As I understand it, OpenOffice stores all of its docs in pure XML 
> format. What if we had someone design a SIMPLE template, then all used 
> it to write in. One of the XML gurus in this list could then surely 
> devise a transform on the written data into whatever output we would like.
> 
> OpenOffice has GOT to be easier for people to write in than any of these 
> documentation generators.
> 
> If anyone who understands these things (XML) better than I, the 
> Open-Office file formats are just zip files with xml and dtd files 
> inside of them.
> 
> Just a thought...
> 
> 
> 
> -------------------------------------------------------
> This sf.net email is sponsored by:ThinkGeek
> Welcome to geek heaven.
> http://thinkgeek.com/sf
> _______________________________________________
> Webware-discuss mailing list
> Web...@li...
> https://lists.sourceforge.net/lists/listinfo/webware-discuss