Re: Bug in gnome-hello doc/ directory?

[Dan Mueth <d-mueth uchicago edu>]

On Mon, 10 Apr 2000, Antonio Zugaldia wrote:
> Hello!

Hi:)

> 	I have been reading the GNOME Handbook of Writing Software
> Documentation and I have seen I must copy the structure of the doc/
> directory of the gnome-hello application. I have just done this and it
> does not work (modyfied properly). Makefile's look for a file called
> 'gnome-hello.html' and db2html produces a file called 'index.html' by
> default, so when trying to copy files we get some errors.
> 
> 	I use a RedHat 6.2 (corrected), is this a bug in my installation or in
> the gnome-hello package?

I'm afraid we have let gnome-hello fall somewhat out-of-date.  The format
of our documentation (and the Makefiles) has been changing quickly
lately.  The documentation templates we currently use can be found at:
http://www.gnome.org/gdp/templates.html

Most documentation authors don't worry about the Makefiles and how things
are layed out in CVS.  We typically pass the sgml files and screenshots on
to a developer who takes care of committing them to CVS, adjusting the
Makefiles, and linking the program to the documentation.  Which developer
we contact depends upon the particular application.

If you are a developer and would like to either write your own
documentation or bind in the documentation from another doc author:
I would look at how things are layed out in CVS. Jacob did some very nice
Makefile work that makes things very simple for applets.  So, for applets,
take a look at (for example) Drive Mount Applet in gnome-applets in
CVS.  For a non-applet application - I'm not sure what is the best
up-to-date example... perhaps the Panel docs in gnome-core.  (suggestions
anybody?)


Cheers,

Dan