GNOME Bugzilla – Bug 632244
Doubled documentation
Last modified: 2018-06-29 22:45:53 UTC
Some chapter or sections are doubled between Tutorial and concept guide and Help Manual. The intention is to move the chapters or sections in the appropriate document and eventually add crossed reference where the doubled part is removed. The tutorial and concepts guide must concentrate on step by step tutorials while help manual fits better for descriptions of GUI, commands, preferences, etc.. At the moment the doubled sections are: - Preferences description (remove it from Tutorial and concepts guide) - Tip of the day description (remove it from Tutorial and concepts guide) The discussion started here on the mailing list: https://lists.gnucash.org/pipermail/gnucash-devel/2010-October/029790.html
At the moment I've updated the Preferences section of the GnuCash guide to version 2.4 of the software. THis section could be cut & pasted in the GnuCash Help but I would like to be able to create link from the guide to the help. There is a page on the Gnome Documentation Project about cross referencing [1] but I cannot get it to work. Can someone help me on this? [1] http://library.gnome.org/devel/gdp-handbook/stable/refering.html.en(In reply to comment #0)
Created attachment 173172 [details] [review] Patch for GnuCash guide
Created attachment 173173 [details] [review] Patch for GnuCash help
Hi Cristian, (In reply to comment #1) > At the moment I've updated the Preferences section of the GnuCash guide to > version 2.4 of the software. THis section could be cut & pasted in the GnuCash > Help but I would like to be able to create link from the guide to the help. > > There is a page on the Gnome Documentation Project about cross referencing [1] > but I cannot get it to work. Can someone help me on this? > > [1] http://library.gnome.org/devel/gdp-handbook/stable/refering.html.en(In > reply to comment #0) Sorry for the late reply, just now came across your bug. It seems to me that the technique mentioned in the Handbook above is used internally by Yelp to jump from one help manual to another. It wouldn't work for someone looking at generated HTML in a browser, or generated PDF. DocBook 5 has the concept of a `set' of books that can reference each other [2], but I'm not sure if we could easily move to DocBook 5. Will have to ask on the list if someone knows. The only other good way to refer to another document I can think of is to use hyperlinks to the help & guide pages available on the GnuCash website. But then the reader would need to be online, so maybe not such a good idea. Am downloading your patch now to review. [2] http://www.docbook.org/tdg5/en/html/set.html
(In reply to comment #4) > > [1] http://library.gnome.org/devel/gdp-handbook/stable/refering.html.en(In > > reply to comment #0) > > Sorry for the late reply, just now came across your bug. It seems to me that > the technique mentioned in the Handbook above is used internally by Yelp to > jump from one help manual to another. It wouldn't work for someone looking at > generated HTML in a browser, or generated PDF. DocBook 5 has the concept of a > `set' of books that can reference each other [2], but I'm not sure if we could > easily move to DocBook 5. Will have to ask on the list if someone knows. > > The only other good way to refer to another document I can think of is to use > hyperlinks to the help & guide pages available on the GnuCash website. But then > the reader would need to be online, so maybe not such a good idea. > > Am downloading your patch now to review. > > [2] http://www.docbook.org/tdg5/en/html/set.html I think that the concept of 'set of books' would be very worth looking into as it would surely enable what Cristian wants to do. Also, the 'set' idea permits treating sets as books within another set. I agree that the implications of moving upto DocBook 5 should be clearly understood.
Thanks Yawar for reviewing my changes. I've applied in rev 19737 all the two patches to documentation after including your corrections and after updating the images to latest changes in GUI [1]. [1] http://lists.gnucash.org/pipermail/gnucash-devel/2010-October/029943.html
Again, Cristian, I have to say this is a Herculean effort. Many thanks for your time and patience. Also, reviewing your initial patch and the final commit, I was reminded that there are many places in the docs that can benefit from fixing bug 633673 (I just reported it). Do you want to tackle this together--we could divide up the docs between us? Cheers, Yawar
Cristian, will you be committing the screenshots for the rest of the tabs in §9.2? I would myself, but mine wouldn't match with the Gnome Clearlooks style used throughout the docs.
> I was reminded that there are many places in the docs that can > benefit from fixing bug 633673 (I just reported it). Do you want to tackle > this together--we could divide up the docs between us? Cheers, Yawar Ok! I will experiment with this solution in the next days then I will post in that bug the file names that I will take care of. > Cristian, will you be committing the screenshots for the rest of the tabs in > §9.2? I would myself, but mine wouldn't match with the Gnome Clearlooks style > used throughout the docs. Done! I thought that I commited them with this patch but I was wrong!
GnuCash bug tracking has moved to a new Bugzilla host. This bug has been copied to https://bugs.gnucash.org/show_bug.cgi?id=632244. Please update any external references or bookmarks.