GNOME Bugzilla – Bug 651337
User manual
Last modified: 2011-07-17 17:11:40 UTC
Created attachment 188812 [details] User manual This is a skeleton of manual rather than something completed. However, the introduction page may be usefull to list available features, and the other pages may be improved if integrated to git ? I only worked on mallard help, so there is still some help feature to be coded. But the doc may be tested : inside the C folder, run 'yelp .'
Thank you! Just taken a look to your work with yelp and it looks like an awesome start point for a document like that. Well, more than an start point, it looks to me more like an initial version that could be perfectly shipped with the next release of frogr if we just filled the TODO sections, and probably talk about the new "Use GNOME General Proxy Settings" checkbox that is gonna be included in the next release of frogr, in the Settings > Connection tab :-) About the structure, I just liked it, although I must warn you I'm not an expert on these matters. I just open it with yelp, navigate it like I'd do with any other app and I just found the layout... "natural", so I guess it's ok :-) About integrating in git and improve it from there, I couldn't agree more with that... so much that I just pushed the files you provided to the repo (specifying you as the author, of course), so feel free to directly modify files in there as you need it. From now on, and if you agree, you're the "frogr documentation master" :-) You'd probably need to create/modify some makefiles at some point I guess, since I just unpacked your zip file and moved all of them to a new help/ folder inside of frogr. Here you have the commit where I added the files: http://git.gnome.org/browse/frogr/commit/?id=5a2673d37164ae8a9e9c162e44c13fd57534fb5d Thanks! PS: Leaving this bug open to track changes related to this matter
Created attachment 188857 [details] help Makefile We need to add some help/Makefile.am , a m4 folder , change the configure.ac The gnome-doc-prepare has to be added to the autogen.sh ( This tuto is about old doc format but the first section (requirements) explains this gnome-doc-prepare need http://developer.gnome.org/gnome-doc-make/unstable/migrating.html.en ) If i run 'gnome-doc-prepare then ./autogen.sh , there is a proper installation to (prefix)/share/gnome/help/frogr/whateverfile
(In reply to comment #2) > Created an attachment (id=188857) [details] > help Makefile > > We need to add some help/Makefile.am , a m4 folder , change the configure.ac > Ok > The gnome-doc-prepare has to be added to the autogen.sh > ( This tuto is about old doc format but the first section (requirements) > explains this gnome-doc-prepare need > http://developer.gnome.org/gnome-doc-make/unstable/migrating.html.en ) If i run > 'gnome-doc-prepare then ./autogen.sh , there is a proper installation to > (prefix)/share/gnome/help/frogr/whateverfile Ok, I'll take a look to that. Btw, I've seen there's a new thread in gnome-i18n mailing list precisely about we adding this new files to the project. Perhaps you (as the expert here in documentation matters :-), might find interesting to join the conversation or just to check it out: https://mail.gnome.org/archives/gnome-i18n/2011-May/msg00113.html
Btw, in the thread I pointed out to in my previous comment, people have mentioned that perhaps we could use a new build system for the documentation, so perhaps the files you submitted so far would need some additional changes so far.
I'm still trying to find out if the new itstool stuff is officially supported as the current wiki doesn't tell me anything about it. Anyway it's better to add it to the build system even if it's not finished yet, your patch seems about right, but you can drop the m4 directory (as it should be generated on the fly by autogen.sh) and I have no idea why the en_GB dir is in there as the strings seem to be the same.
I just pushed the files in comment #2 [1], followed by a second commit [2] removing the need of manually adding the m4 directory, as suggested by Łukasz Jernaś in comment #5. Not resolving the bug yet because pending on making a decision on whether we'll use or not the new itstool stuff. Łukasz, what do you think? Should we resolve this now and file a new bug for istool, or are you feeling like making that change soon, and then resolving this bug once that happens? Thanks! [1] http://git.gnome.org/browse/frogr/commit/?id=033836b58bca08e8f90a32d37a3bf48bb5d3a989 [2] http://git.gnome.org/browse/frogr/commit/?id=974dd2bd6a0732e504ddc1171a97ceaf1de92aa3
Added "Contents" menu item to the "Help" menu: http://git.gnome.org/browse/frogr/commit/?id=e0644b2c3b7d751875c8d41a87c3e7eea798d875
After passing more than one month since this stuff started, and considering now there's actually an User Manual in frogr that can be accessed through the "Contents" item in the "Help" menu... and that it's even translated to some languages (cs, de, en_GB, es, fr), I think it's time to admit this bug can be resolved as fixed :-) Of course the user manual can still be improved, updated, whatever... but I do think it's not arguable anymore that there's actually a User manual in frogr's master branch (Thanks!)