Re: [jamboost] New BoostBook user manual

From: Vladimir Prus (ghost_at_[hidden])
Date: 2004-02-05 03:01:18

Hi Christopher,
> I've just checked in a *very* rough cut at the BoostBook version of the
> v2 User Manual into v2/doc/userman.xml. It's basically a straight
> conversion of boost_build_v2.html, with a couple of tweaks to fit it
> into Docbook.

Thanks you very much! Even though you say it's raw, all the content is there 
and the structure is represented quite fine.

> I've also added a Jamfile.v2 in the same directory, which can be used to
> build the docs if the boostbook toolset is configured on your system.
> Note that while the docs build fine using boostbook, the xml is still
> not 100% valid to the DTD, so I'll be cleaning that up over the next day
> or so.

Ok, that's surely not very critical.

> Nothing has been done to clean up the content as yet, but there's been
> some discussion of reorganization, so now's your chance to give us your
> docs wishlist.

I think there are just some things that must be added to docs, but no large 
scale reorganization was planned yet....

I actually though that it would be nice to cleanly separate the docs into 
"User documentation", "Extender documentation" and "Developer" documentation,
but the way you put the last two in appendix is quite fine with me. After all 
"User documentation" is the most important part there.

I also though it's probably better to split the xml source into smaller 
chunks, to ease editing. What do you think? In either case, this can be done 
only when structure is completely finalized?

BTW, what editor for XML do you use? I'm not really happy with emacs in this 
respect.

> I'm going to move the BoostBook stylesheet discussion over to the
> documentation list, since it's been quiet there lately and there might
> be readers there that can help or give feedback. If you're interested
> and not on that list, sign up here:

I'll go there with some minor glitches I see. 

And, while we're at it, I'm going to add the first FAQ entry right now!

- Volodya