Re: [boost] Copy editing documentation - SOC project

From: Michael Caisse (boost_at_[hidden])
Date: 2007-03-10 03:51:14

Paul A Bristow wrote:
> As a newbie using QuickBook, I agree with this - getting a working setup needed guidance and assistance, but once you are airborne,
> using it is pretty much of a doddle.  
>
> html output works fine, pdf using free FOP is OK without pictures (and would be OK with SVG pics rather than jpegs), but if one can
> tolerate some discrete advertising, John Maddock has used a commercial package without much trouble.
> The advantage of also producing a pdf is that it can be printed, and that is can be searched using the Adobe Reader find.  Being
> able to do this would have helped a lot of Boost.Test confusion.  We could still use a better search (Googlish) tool.
>
> Quickbook 'language' is simple enough that we can expect the other tools to work better in time.
>
> IMO, the key advantage is that working collaboratively on files in the CVS sandbox, for example, worked smoothly.
>
> Paul
>
> ---
> Paul A Bristow
> Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
> [phone] & SMS, Mobile [phone] & SMS
> pbristow_at_[hidden]
>
>   
I'm just a simple user / lurker at the moment (though I'm hopeful to be 
a contributor someday), but if Boost is moving to subversion would 
moving to Trac make sense?

We have been using the wiki portion of Trac successfully to collaborate 
on documentation. Multiple engineers are able to contribute easily to 
content while having the ability to reference items in the repository, 
tickets and of course other wiki pages. There is an active community of 
Macro and Plugin authors providing features ranging from inline Graphviz 
support to News Flashes and enhanced image placement. Plug-ins such as 
CombineWiki allow you to produce html, pdf or postscript outputs. The 
conversion tools are a little raw right now; however, they are simply 
Python scripts that plug into the Trac framework and easily modified.

Best Regards -

Michael

-- 
----------------------------------
Michael Caisse
Object Modeling Designs
www.objectmodelingdesigns.com