After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 743671 - Propose Glossary Appendix
Propose Glossary Appendix
Status: RESOLVED FIXED
Product: GnuCash
Classification: Other
Component: Documentation
2.6.5
Other All
: Normal enhancement
: ---
Assigned To: gnucash-documentation-maint
gnucash-documentation-maint
Depends on:
Blocks:
 
 
Reported: 2015-01-29 01:05 UTC by David
Modified: 2018-06-29 23:38 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description David 2015-01-29 01:05:10 UTC
I propose incorporating the Glossary from the wiki (http://wiki.gnucash.org/wiki/Glossary) as Appendix A in the Guide and Tutorial. This will give users better access to definitions used in the Guide. Initial implementation will not include embedded links in the guide, but the expectation would be that they would.

Other Appendices would be adjusted as appropriate.
Comment 1 David 2015-02-07 21:55:25 UTC
Reading through Chapter 1, I see a reference to a Glossary in section 1.3, so this bug formalizes that intention.

Adding the glossary as Appendix A will require changes to gnucash-guide.xml and addition of glossary.xml to the fileset.
Comment 2 Frank H. Ellenberger 2016-11-29 20:30:12 UTC
I like the Idea. On the long term it would save time, because there will be only one place with definitions which again will reduce redundacies and inconsistencies.

Docbook - the xml dialect used in the docs - knows the following elements:

glossary - A glossary
glossaryinfo[4.0] - Meta-information for a Glossary
glossdef - A definition in a GlossEntry
glossdiv - A division in a Glossary
glossentry - An entry in a Glossary or GlossList
glosslist - A wrapper for a set of GlossEntrys
glosssee - A cross-reference from one GlossEntry to another
glossseealso - A cross-reference from one GlossEntry to another
glossterm - A glossary term

See e.g. http://tdg.docbook.org/tdg/4.5/docbook.html
Currently our docs are based on version 4.4.

I had not the time to play with above elements. So I can not say how expensive it will be.

http://wiki.gnucash.org/wiki/Glossary started as a partial translation of http://wiki.gnucash.org/wiki/De/Glossar which again is still incomplete. Perhaps with Google Translate you could understand it.
Comment 3 Frank H. Ellenberger 2016-11-29 20:41:53 UTC
My theoretical workflow:
1. write it quickly down in the wiki,
2. place typographical elements to improve usability (locating, understanding, structure ...),
3. replace the wiki tags by docbook tags and commit it.

So I would not drop the wiki page. Because it is mach quicker and easier to edit, it should represent the most recent version.
Comment 4 David 2017-01-16 12:01:10 UTC
Glossary has been added to Guide.
Comment 5 John Ralls 2018-06-29 23:38:04 UTC
GnuCash bug tracking has moved to a new Bugzilla host. This bug has been copied to https://bugs.gnucash.org/show_bug.cgi?id=743671. Please update any external references or bookmarks.