Page 1 of 1

Documentation needed?

Posted: 20 Jun 2013, 00:47
by andyf
Hi folks,

I'm new here. I've just set up and am starting to use OpenCATS, but I'm really a documentation guy. Can I lend a hand here? I would like to put together a manual (DocBook to PDF, built from XML source in subversion, say?) if I can get some technical partnership.

Cheers,

Andy

Re: Documentation needed?

Posted: 22 Jun 2013, 01:14
by andyf
OK, so I've started work on a manual. You can see the latest skeleton draft built at http://ocdocs.treffle.com.
I wanted to attach it, but the upload refused to accept PDF. Features of this draft:

- Fully developed outline, needs comments/feedback. See the table of contents.
- Built from DocBook XML source, with graphics in graphviz/dot.
- Life cycle discussion adapted from mabdalla's 2008 forum post
- Complete skeleton and working build apparatus. (Built from checked-in XML source using make/dot/xsltproc/fop.)

Next steps:

- Tune the layout and typography, especially the cover and the heading styles (currently everything is default values)
- Adapt material from the "CATS in 5 minutes" quick guide

Beyond that, I could sure use some technical partners to help generate content... Please PM me at the forum if you can help!

Andy

Re: Documentation needed?

Posted: 22 Jul 2013, 15:35
by RussH
Hi Andy,

I've changed the upload config - can you retry attaching the user Guide?