[kde-doc-english]Re: Tool to check the menu items and the GUI labels

[Frederik Fouvry]

| Then we were speaking about different things. What I would like is a tool 
| that checks that what is marked up in the documentation really exists in the 
| menues and buttons. It's not a tool that would guess *all* of the menus and 
| buttons that exist in an application.
| 
| The tool I would like to see could not help you determine whether you 
| described in the documentation all the interface elements or forgot some, but 
| at least you would know if your descriptions are misspelled our outdated. And 
| if it's not mistaken and if you're a translator, you would know the 
| translation used in the GUI too.
| 
| A tool somehow similar to the one you describe already exists and is 
| implemented at Qt level: it's the accelerator checker (Ctrl-Alt-A). Of 
| course, it lists the available accelerators at a given point of time, not 
| independantly of the context.

I've suggested a few times to extend the accelerator checker with
a list output in text (or even better DocBook) format so that
documentors can get a lot of the painful stuff out of the way
easily, but no one has taken it up so far.  That seems to be what
Jacob is proposing.  While it would be useful for big changes or
new documentation, it wouldn't do very much for small changes,
which is probably what happens most of the time.  That's what
Eric would like to see (and it would indeed be nice to have it).

I don't think the two proposals are incompatible.  Eric's needs
more extraction and string massaging, so Jacob's/my proposal is a
first step on the way to a GUI-doc consistency checking tool.

Frederik