Re: [Xaraya_public-dev] Developer docs wishlist?
"Michael Cortez" <[email protected]> Tue, 8 Oct 2002 07:37:28 -0700
| Newsgroups | gmane.comp.cms.xaraya.documentation |
|---|---|
| Message-ID | <004e01c26ed8$3a778d60$0801a8c0__26959.8690713339$1053725797@tarsis> |
>> Or do you split it into tiny pieces with the nightmare of having >> to join it all back together to get a usable document. This isn't really as bad as it used to be. I'm currently using DocBook, XIncludes and xmlint to manage a roughly 800pg document, as ~100-125 small descrete units that automagically get linked together when you compile the document into HTML, PDF, MS-Help, etc. > There must be something that will help us, and allows the > documentation to be revision-controlled all the way. If it ain't easy to use, > it won't be used. No-one likes to jump through hoops when they wish to do > others a favour by nicely providing some documentation. I don't suppose we can wait a week or two? I'm currently working on a .714 compatible module that takes the above mentioned project and allows people to check out & check in the individual documents. At any time, someone can look at a section (chunk) of the documentation in raw mode (DocBook XML) or click on a "HTML" mode that renders the current section, and any sections that it links to as HTML for viewing. Administrators can then review "check ins" and merge them into the actual files. In the background, PHP is spawning CVS when the administrator check in changes, so full versioning is kept. Once I've got some of the more serious bugs worked out, and after putting some security controls in, and perhaps converting it to utilize a generic SCM module/plug in (so it can use bit keeper) --- it may be worth using for the Xaraya documentation project... If I can find the time to plug the "show stopper" bugs this afternoon (PST), I'll post a URL for people to poke at it.