bzr-windows team mailing list archive
-
bzr-windows team
-
Mailing list archive
-
Message #00106
Re: Call for testing: chm documentation for Bazaar 2.0
On 03/09/2009 08:44, Ian Clatworthy wrote:
> If so, go to http://doc.bazaar-vcs.org/bzr.2.0rc2-downloads/, grab the
> chm file and let me know what you think.
Mmm, no index? Would be nice to have at least the list of commands and
aliases, and significant VCS terms like repository.
> The things I want feedback on
> in particular are:
>
> 1. Ease of navigation
The Related Links in the Table of Contents go to the Internet site, not
to some CHM page. Perhaps intended, but a bit odd, particularly for the
glossary.
> 2. Scope and impact on searching
> 3. Granularity and impact on printing.
About the latter: recently I saw a topic on StackOverflow on how to
convert a CHM file to a PDF one. A trick was to print the whole CHM with
a PDF driver. But for this, the document need a "root", parent of all
entries. Thus we can print this root node with the second option to
print the whole document.
Now, that's perhaps too much, and one can print each of the top-level
nodes, there are only 5 of them, not an overkill, and allow to be selective.
But well, I wanted to pass on the information... :-)
> W.r.t scope, I'm thinking that the Developer Docs and Foreign language
> docs ought to be excluded.
I agree. Seeing Russian in the list of results (not even correct, the
list view shows garbled characters, while the page itself shows
Cyrillic) is a bit odd...
> W.r.t. granularity, I've put some effort into making topics of a
> sensible size for the purposes of printing. In particular, the 250+ page
> Release Notes are broken up by release now. The User Guide is also
> broken up.
Not sure if the whole release notes need to be there. I don't know how
much they "bloat" the final file, if it is minor, they are OK, if they
contribute significantly to the overall size, they should be separated.
--
Philippe Lhoste
-- (near) Paris -- France
-- http://Phi.Lho.free.fr
-- -- -- -- -- -- -- -- -- -- -- -- -- --
References