Re: Tutorial - Implementing Help

[Eric Baudais <baudais kkpsi org>]

Andrew-

If you want to create a tutorial for adding documentation to a GNOME
app that would be great!  The instructions in the GDP Handbook just
give the easiest way to include documentation in a GNOME app.  There
are many variations which are not listed.  If you could write a
tutorial giving the variations on including help it would definitely
be included in the GDP Handbook.

Eric Baudais

On Tue, Jan 06, 2004 at 06:33:51PM -0600, Shaun McCance wrote:
> On Sun, 2003-12-07 at 17:51, Andrew Burton wrote:
> > Hi,
> > 
> > I got a little bit frustrated recently with the lack of Gnome
> > documentation on the website about how to actually implement a help
> > system in an application. After a lot of messing about, that involved
> > Google searching for similar problems, incomplete docs that mentioned
> > files in passing, checking other Gnome apps for inspiration, I came up
> > with the idea of writing a short tutorial on how to actually implement
> > Help from scratch.
> > 
> > It'd cover details on what files to write, basic contents of these files
> > (with pointers for more information), code samples, configure script
> > details.
> > 
> > What do you think?
> 
> We do have the GNOME Handbook of Writing Software Documentation.  I'll
> admit that it's rather terse on how to work things into your build.  If
> you'd like to help out with providing information, it would be a good
> idea to contribute to the Handbook.
> 
> http://developer.gnome.org/projects/gdp/handbook.html
> 
> --
> Shaun
> 
> 
> _______________________________________________
> gnome-doc-list mailing list
> gnome-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-doc-list

-- 
They give you illusion that has the appearance of truth.  I give you
truth in the pleasant disguise of illusion.
                                             --Tennessee Williams