Find the answer to your Linux question:
Results 1 to 8 of 8
Allo tout la monde! I am developing a programme in GTK/GNOME, and I would like to start writing the documentation for it. (It really does provide a good break from ...
Enjoy an ad free experience by logging in. Not a member yet? Register.
  1. 10-18-2005 #1
    Reisswolf
    Reisswolf is offline
    Just Joined!
    Join Date
    Jul 2004
    Posts
    94

    Question about Writing GNOME Documentation

    Allo tout la monde!

    I am developing a programme in GTK/GNOME, and I would like to start writing the documentation for it. (It really does provide a good break from the intensity of writing code!) The problem is that I don't know how to display the online help topics in that cool, GNOME window "thingy" that is used by the "professional" GNOME programmes.

    I want to make my programme as professional as possible, and I even have hopes of submitting it to GNOME. Currently, choosing "Manual" from the Help menu displays the document as a big text file in a GtkTextView. There is no nice formatting or cross-linking between the sections.

    Can someone please tell me how to include formatted text, hyperlinks and images in my help documentation?

    Thanks a lot.
    Reply With Quote Reply With Quote
  2. 10-18-2005 #2
    lakerdonald
    lakerdonald is offline
    Linux Guru lakerdonald's Avatar
    Join Date
    Jun 2004
    Location
    St. Petersburg, FL
    Posts
    5,035
    Is this the sort of guide you're looking for?
    the lost art of found sound
    Reply With Quote Reply With Quote
  3. 10-19-2005 #3
    Reisswolf
    Reisswolf is offline
    Just Joined!
    Join Date
    Jul 2004
    Posts
    94
    Thanks lakerdonald! That's perfect!
    Reply With Quote Reply With Quote
  4. 10-19-2005 #4
    lakerdonald
    lakerdonald is offline
    Linux Guru lakerdonald's Avatar
    Join Date
    Jun 2004
    Location
    St. Petersburg, FL
    Posts
    5,035
    Just out of curiosity, do you use glade at all?
    the lost art of found sound
    Reply With Quote Reply With Quote
  5. 10-19-2005 #5
    Reisswolf
    Reisswolf is offline
    Just Joined!
    Join Date
    Jul 2004
    Posts
    94
    Yep, I use Glade. I am using Glade for this project. Initially, I started out by coding everything manually, but then, it became too much of a hassle. Glade gives me the flexibility of moving around the widgets with a minimum of effort--and for that, I love the programme.

    I wish there were some way by which I could generate documentation from within Glade.
    Reply With Quote Reply With Quote
  6. 10-19-2005 #6
    lakerdonald
    lakerdonald is offline
    Linux Guru lakerdonald's Avatar
    Join Date
    Jun 2004
    Location
    St. Petersburg, FL
    Posts
    5,035
    This isn't quite the same, but if you set up your project using GNOME extensions then you can at least use the standard GNOME help window ( although you're probably already doing that! )
    the lost art of found sound
    Reply With Quote Reply With Quote
  7. 10-22-2005 #7
    Reisswolf
    Reisswolf is offline
    Just Joined!
    Join Date
    Jul 2004
    Posts
    94
    Sorry for the delay in the response.

    Actually, I am using the GNOME extensions. I specified by project as a "GNOME Project" when I first created it. But I don't see anything called "Gnome Help Window" in any of the lists of widgets--not even in the list of deprecated widgets.

    Can yu please tell me which one you are talking about? I'm using the version of Glade that comes with Fedora Core 4.
    Reply With Quote Reply With Quote
  8. 10-22-2005 #8
    lakerdonald
    lakerdonald is offline
    Linux Guru lakerdonald's Avatar
    Join Date
    Jun 2004
    Location
    St. Petersburg, FL
    Posts
    5,035
    Hmm I must have been confusing the help window and about window...sorry about that.
    the lost art of found sound
    Reply With Quote Reply With Quote
« Previous Thread | Next Thread »

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

Forum Rules