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 155140 - write documentation
write documentation
Product: gossip
Classification: Deprecated
Component: General
Other Linux
: Normal enhancement
: ---
Assigned To: Keywan Najafi Tonekaboni
Gossip Maintainers
Depends on:
Reported: 2004-10-11 22:28 UTC by Keywan Najafi Tonekaboni
Modified: 2005-11-16 13:36 UTC
See Also:
GNOME target: ---
GNOME version: ---

draft for a gossip user guide (6.01 KB, text/plain)
2004-10-11 22:29 UTC, Keywan Najafi Tonekaboni
draft in doctype, with screenshots and entities (40.18 KB, application/x-compressed)
2004-11-16 11:11 UTC, Keywan Najafi Tonekaboni
Tarball with help folder & patch to build files, glade, and adding callback (67.90 KB, application/x-compressed-tar)
2005-11-11 22:30 UTC, Brian Pepple
Diff to Brians gossip.xml (4.74 KB, patch)
2005-11-12 20:01 UTC, Keywan Najafi Tonekaboni
none Details | Review
draft for german translation of the documentation (26.58 KB, text/xml)
2005-11-16 13:36 UTC, Keywan Najafi Tonekaboni

Description Keywan Najafi Tonekaboni 2004-10-11 22:28:20 UTC
1. transfer daniel taylors draft[1] to docbook
2. readapt it to current gossip version

Comment 1 Keywan Najafi Tonekaboni 2004-10-11 22:29:53 UTC
Created attachment 32493 [details]
draft for a gossip user guide
Comment 2 Keywan Najafi Tonekaboni 2004-11-16 11:11:34 UTC
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.
Comment 3 Keywan Najafi Tonekaboni 2004-11-16 11:18:19 UTC
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.
Comment 4 Brian Pepple 2005-11-11 22:30:12 UTC
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.
Comment 5 Martyn Russell 2005-11-12 11:56:02 UTC

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.
Comment 6 Brian Pepple 2005-11-12 14:21:25 UTC
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.
 ( ). 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 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 ====================================
if test x$SK_CONFIG = xno; then
  AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the
scrollkeeper package:
dnl ====================================
dnl = End tests for scrollkeeper
dnl ====================================
Comment 7 Keywan Najafi Tonekaboni 2005-11-12 20:01:20 UTC
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.
Comment 8 Martyn Russell 2005-11-13 11:20:14 UTC
Thanks Keywan & Brian, I have committed bot those patches.


Keywan, I look forward to your German version!
Comment 9 Mikael Hallendal 2005-11-13 17:18:49 UTC
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!
Comment 10 Keywan Najafi Tonekaboni 2005-11-16 13:36:34 UTC
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.