Re: [boost] Copy editing documentation - SOC project

From: Paul A Bristow (pbristow_at_[hidden])
Date: 2007-03-09 04:47:29

>-----Original Message-----
>From: boost-bounces_at_[hidden] 
>[mailto:boost-bounces_at_[hidden]] On Behalf Of Joel de Guzman
>Sent: 08 March 2007 23:55
>To: boost_at_[hidden]
>Subject: Re: [boost] Copy editing documentation - SOC project
>
>Matthias Schabel wrote:
>>> FYI, QuickBook already has the reverse-lit feature. It lets you
>>> "import" code snippets from actual code. Rene and I are using it
>>> right now to great effect.
>> 
>> Two questions :
>> 
>> 1) is there a good tutorial on using QuickBook?
>
>Ehm, you don't really need a tutorial :-) Just read the docs.
>Anyway, the difficult part is having it installed. After that,
>all follows smoothly. The current docs has some sections on
>installation.

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]