Re: [boost] Help request, boost docs

From: Paul A Bristow (pbristow_at_[hidden])
Date: 2007-06-21 05:08:32

>-----Original Message-----
>From: boost-bounces_at_[hidden] 
>[mailto:boost-bounces_at_[hidden]] On Behalf Of John Maddock
>Sent: 20 June 2007 18:24
>To: boost_at_[hidden]
>Subject: Re: [boost] Help request, boost docs
>
>Vladimir Prus wrote:
>>> I would strongly advise that everything go into Quickbook format.
>>> It's far easier to write documentation in Quickbook than Boostbook,
>>> and Quickbook gives us more options.
>>
>> What options? Since you've authored Boostbook you must know better,
>> but I still don't see the value in using home-grown documentation
>> format.

>Quickbook is also much easier to read, write and maintain than Docbook.
>
>To give you an example, when I originally did the TR1 docs, I 
>invested quite 
>a bit of time to learn Docbook, and authored the docs using 
>that.  About a 
>month later quickbook came along, and my first reaction was 
>much like yours: 
>I certainly didn't want to have to learn "yet another format". 

FWIW, having spent some time working on the Math Tool docs, I was also 
reluctant to earn "yet another format" (my brain is full!), and feared a custom tool, but I also found it *really* easy to use, and
revise - once the experts had ironed out some of the wrinkles for me. 

As must be clear, there are still plenty of wrinkles to flatten,
but the results are most pleasing.  If we can add MathML editing, even the hated math equations infested with greek and symbols will
be much easier.  SVG graphs from C++, currently under development by Jake Voytko, will make simple (and complex) graphs a doddle to
include.

Finally the ability to search the pdf, and Google the html will make it user-friendly.

Paul

---
Paul A Bristow
Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
[phone] & SMS, Mobile [phone] & SMS
pbristow_at_[hidden]