GNOME Bugzilla – Bug 349253
incorrect uses of DocBook tags in manual
Last modified: 2009-08-15 18:40:50 UTC
I have found several incorrect uses of DocBook tags in the manual: 1. menu commands: Manual has this: <guimenu>Settings->Preferences->Text Filters</guimenu> Correct usage: <menuchoice><guimenu>Accessories</guimenu><guimenuitem>Character Map</guimenuitem></menuchoice> The fancy arrows are added by Yelp, which makes life easier :) 2. menu commands (again) The manual: and choosing <command>Copy all left</command> The command tag is only used for the command line. Use guimenuitem (probably!) 3. mousebutton As far as I can tell, we don't bother with this one. At least, there is no use of it in the GNOME User Guide. No idea why though. 4. keyboard shorcuts Manual has: <keysym>Control+F</keysym> Correct tag is keycombo, which magically adds the + symbol (or the - if that's what we're using now -- this way we don't have to worry, Yelp does the work). I'm happy to make these changes myself if you're ok with me committing to meld's CVS. I'm also going to add this to the list of why DocBook is evil :)
It would be great if you could make those changes, thanks.
In addition, I've changed all <keysym> to <keycap>, as yelp doesn't do anything with the former. I've assumed that commands that seemed to refer to File->New-> being a submenu refer to an older menu structure, and changed to match what I see in 1.1.2 -- if that's incorrect let me know and I'll fix it. I've also taken the liberty of making a few minor changes of style to match the GDP's guidelines, eg using 'choose' for menu commands. Changes committed to CVS.
Thanks Joachim, much appreciated.
Batch close of old bugs.