GNOME Bugzilla – Bug 155140
write documentation
Last modified: 2005-11-16 13:36:35 UTC
1. transfer daniel taylors draft[1] to docbook 2. readapt it to current gossip version [1]http://lists.imendio.com/pipermail/gossip-dev/2003-November/000516.html
Created attachment 32493 [details] draft for a gossip user guide
Created attachment 33831 [details] draft in doctype, with screenshots and entities sometimes ago i start to convert the draft to docbook. here the first results.
the attechment 33831 is an with bzip2 compressed tar file. when you extract it, you can read the documantation in yelp with the command "yelp gossip.xml". please change first to the directory.
Created attachment 54656 [details] Tarball with help folder & patch to build files, glade, and adding callback I've update the help that Daniel & Keywan started for most of the changes made since it was last worked on. Also, cleaned up a lot of the errors that pop-upped with xmllint. I've also include a patch in the tarball that modifies the build files needed to add the help, glade file to add the contents menu item, and gossip-app.c for the callback. And finally, I've also include omf.make & xmldocs.make scripts.
Committed. Thanks for all the hard work. Seems to work ok when I install it into prefix=/usr but not my prefix=/usr/local for some reason - but this could be a dodgy Gossip install - I have loads of them lying around ;) I noticed you include the omf.make and xmldocs.make scripts, by my understanding these are generated somehow if you use the gnome-common macros right? At least when I looked at GEdit, it seemed to have them generated somehow. I did add to your code where you call the gnome_help_() API to show a dialog when there are errors involved. This is a really good start, feel free to submit patches for further improvements on the documentation. Thanks again for this everyone involved.
I think your right about the problem you had with the install not being correct. The help should be installed into whatever was defined as $(datadir). The omf.make & xmldocs.make scripts come from the scrollkeeper-example2 package. ( http://sourceforge.net/projects/scrollkeeper ). I pretty sure it's not defined in the gnome-common macros, but I could be wrong. One thing I did forgot to do, was add a simple test to configure.ac to verify that scrollkeeper is present, since it's needed. Something like this should be more than sufficent. dnl ==================================== dnl = Begin tests for scrollkeeper dnl ==================================== AC_PATH_PROG(SK_CONFIG,scrollkeeper-config,no) if test x$SK_CONFIG = xno; then AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package: http://scrollkeeper.sourceforge.net) fi dnl ==================================== dnl = End tests for scrollkeeper dnl ====================================
Created attachment 54678 [details] [review] Diff to Brians gossip.xml first brian, thanks that you finished the doc. great work! I nearly finished the translation to german (87% in vimdiff). I just use an old version from grossip, so I have some problems with the new interface on the last meters. :D I will submit my translation as soon as possible, when I got/compile the correct version of gossip. I correct a little bit and attached a diff. Please check my corrections, if they are correct.
Thanks Keywan & Brian, I have committed bot those patches. :) Keywan, I look forward to your German version!
Martyn, iirc we are not using gnome-common so we should include things automatically generated by it. Great work to all of you for the documentation, that is truly splendid!
Created attachment 54824 [details] draft for german translation of the documentation i finished the german translation for now. there are still some strings in gossip itself untranslated, so i didnt translate them in the docu at the moment. i guess there are a lot of grammer mistakes and typos.