[GNC-dev] Autogenerated GUI description? was: Long Term Documentation Directions

Frank H. Ellenberger frank.h.ellenberger at gmail.com
Mon Sep 10 17:41:57 EDT 2018

Am 10.09.2018 um 13:46 schrieb Geert Janssens:
> Op zondag 9 september 2018 12:21:08 CEST schreef Frank H. Ellenberger:
>> ?: Usability: Will F1 or pressing the Help button still deliver the
>> right content? I know it is aslo now not always th case.
> If I read David's proposal carefully there remains some kind of interface 
> index document (listing all ui buttons, menu items,...). But instead of having 
> full documentation they would point to relevant sections in the manual. 
> Assuming we can make cross-linking work, this should be covered.
> On the other hand if we think of our documentation more as a clever 
> composition of documentation snippets, we could also opt to compose help 
> information from the same snippets that are used to compose the full manual. 
> That's theory of course. I don't know if this would be possible in practice.

Let me concentrate here on the reference part - whereever it might
appear later:
Woking on https://bugs.gnucash.org/show_bug.cgi?id=782423 I got the
following basic idea:
Scan the .glade files for Label, corresponding tooltip_text and value
lists to generate the menu and dialog descriptions (curently4. GnuCash
Windows & Menus Options Overview). We want additional the help context
id and eventally a Purpose field for each dialog (i.e. by doxygen?).

The tables in Help Appendix A are a edited compilation of several
sources (gnc & FQ code, a website, a email).

I am not sure, if it would help editors and/or users to reenable a cross
reference again, but each good markup language should be able to produce

In theory the glossary would also belong here. The question: Should it
be derived from po/glossary?
> Documentation updates may be a circular nightmare, finding a way to manage it 
> makes us running in circles as well...

Right, isn't it part of modern delevopment models? Probably we need some
formalization here.

> Geert

More information about the gnucash-devel mailing list