Doc review & quick ref card - anyone with some DTP skills?

[Sabin Iacob]

Aaron Bentley wrote:
> There are some line-spacing issues:
> - - the example text seems to have too little whitespace between lines,
>   especially on FF.
> - - the example text should be closer to its heading than to the following
>   heading.
>   

somewhat fixed

> You may wish to use the svg version of the logo:
> http://bazaar-vcs.org/LogoOptions?action=AttachFile&do=get&target=Bazaar+Logo+2006-07-27.svg
>   

thanks, I missed that (or didn't dig deep enough)

> I'm not sure whether the items (e.g. "New Project", "Working tree
> status") need colons, but I don't feel strongly about that.
>   

seems to look better without them...

> The png seems to print reasonably well, despite its RGB colorspace.  On
> my printer, the blue is a bit greener, the yellow is redder, and the
> logo arrow's gray is much more obviously gray.
>   

i tried importing in scribus, which knows about CMYK, but the resulting 
colours look, um, strange :)

> I'm tempted to think something should go to the right of the title.
> Perhaps "Your notes here"?
>   

I followed Ian's suggestion and added "bzr help" and the website address 
for those who need more information

Joachim Nilsson wrote:
> 1. There are several examples of font mixup -- e.g. "bzr resolve" uses
> serifs and "bzr push" is sans serif.  For clarity I propose using serif
> for headlines, sans serif for running text and a proportional font forll
> examples.
>   

hmm the examples were supposed to be monospaced actually, looks like I 
missed some (lots) of them; fixed :)

> 2. My Thinkpad only has 1024x768 and some of the longer examples are
> printed outside the frames.  Maybe this is OK, as long as we don't
> publish the card in .svg but instead in PostScript or PDF, which we can
> be sure are displayed properly everywhere.
>   

it's more likely that you don't have Bitstream Vera Sans/Bitstream Vera 
Sans Mono and the browser uses another font to render them, ir have a 
bigger default font size

also, Firefox seems to have its own idea about what "px" means and it 
looks like px's dimension sometimes changes from one element to another :)

> 3. Add/"version" files: ... how about using some other term (e.g. track)
> or just drop the "version" and "unversion" clutter altogether?
>   

I'm not so sure about that... the most correct would probably be "add to 
version control" and "remove from version control", but they are sooooo 
long! "Track" doesn't tell me anything, honestly.


Ian Clatworthy wrote:
> * Add a "More Information" box above "Merging" showing how to use help
>   (just 'bzr help' is enough) and referencing the web site.
>   

done

> * Leave out the "to apply to ../myproject-base" after
>   "Create a revision bundle:"
>   

done, although I'm not so sure about that...

> * I think we should favour short options when they exist, e.g. for
>   the bundle example.
>   

in "bundle"'s case it was ok, but for commit, branch, remove, update, 
the short aliases (ci, get/clone, rm, up) may be confusing to the 
non-hardcore user :)

> * It feels a bit weird that both "remove" examples require options.
>   What about this ...
>
>     Remove files: bzr remove foo.py
>     Unversion but keep files: bzr remove --keep foo.py
>
>   If "unversion" is not a real word, perhaps "Stop Tracking files".
>   If we do that, perhaps make "Add files" "Track files" for consistency
>   (as Joachim suggested as well).
>   

the default "remove" command's behaviour is kind of strange, maybe 
--keep should be the default option, not --safe

> * Under "Concepts", Merging (verb) -> Merge (noun) and reword
>   accordingly (as mentioned elsewhere).
>   

done


http://m0n5t3r.info/stuff/bzr-quickref.svg
http://m0n5t3r.info/stuff/bzr-quickref.png