← Back to team overview

bzr-windows team mailing list archive

Re: Call for testing: chm documentation for Bazaar 2.0

 

Ian Clatworthy wrote:
> Step 1 towards a better windows installer is now done ...
> 
> virus 

It passes the Symantec offering.

> I hope someone is still reading ....
> 
> If so, go to http://doc.bazaar-vcs.org/bzr.2.0rc2-downloads/, grab the
> chm file and let me know what you think. The things I want feedback on
> in particular are:
> 
> 1. Ease of navigation

The index is empty. I'm not sure what's involved in filling it, but the
index is most peoples first point of call in Windows helpfiles, rather
than the search box. The search tends to be slow on larger help files
(not this one), hence the habit. An empty index will be a minor but
persistent niggle to some people.

http://msdn.microsoft.com/en-us/library/ms644603%28VS.85%29.aspx

It's manual labour unless you find a way to automate it... I suppose
this is why people tend to prefer "Index" to "Search", because it's got
love and care in it :-)


> 2. Scope and impact on searching
> 3. Granularity and impact on printing.
> 
> W.r.t scope, I'm thinking that the 

> Developer Docs 

Probably

> and Foreign language docs 

Definitely ; they show up in a search.

> ought to be excluded.

> 
> Note: I'm yet to break up the User Reference so it's still 90+ pages
> long if someone wants to print that as a "topic". The fallback here is
> for developers to grab the User Reference in PDF (now also available!)
> and selectively print pages from there. Is that acceptable?

I think so ; I rarely print online help (that's why it's online, not
on-dead-tree). Suitability for printing is of secondary importance (IMHO).

> 
> In summary, I feel this is a big step forward compared to the chm file
> the current trunk produces. I hope it's now professional enough to
> include in the 2.0 installer. Yes/no?
> 

Is there a way to mark external links as being external, perhaps using a
stylesheet?

> Ian C.
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~bzr-windows
> Post to     : bzr-windows@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~bzr-windows
> More help   : https://help.launchpad.net/ListHelp




References