Re: Help files

[Pawel Salek <pawsa TheoChem kth se>]

On 2001-07-31 15:21 Peter Bloomfield wrote:
> Can someone give me a pointer to guidelines for help files? I added
> some text to help/C/balsa.sgml for adding IMAP subfolders, and it's
there
> in CVS, but it doesn't seem to make it into any of the installed html
> files.

I guess it may depend on setup. my db2html creates a page on IMAP folder
configuration, as seen on http://www.theochem.kth.se/~pawsa/balsa/help/

For me, the following two steps worked:
1. get gnome-doc-tools package from, for example,
http://people.redhat.com/dcm/software.html
2. make sure your SGML catalog contains proper sub-catalogs, in
particular PNG-support. In my case, I had to add a line
CATALOG /usr/share/sgml/docbook/png-support-3.1/catalog
to /etc/sgml/sgml-docbook.cat

You should never get any warning messages when parsing the sgml file.

The generated files for current CVS are:
/usr/share/gnome/help/balsa/C/authours.html
/usr/share/gnome/help/balsa/C/common-tasks.html
/usr/share/gnome/help/balsa/C/folder-config.html
/usr/share/gnome/help/balsa/C/getting-started.html
/usr/share/gnome/help/balsa/C/glossary.html
/usr/share/gnome/help/balsa/C/images
/usr/share/gnome/help/balsa/C/images/address-book-ldap.png
/usr/share/gnome/help/balsa/C/images/address-book-modify.png
/usr/share/gnome/help/balsa/C/images/address-book-start.png
/usr/share/gnome/help/balsa/C/images/address-book-vcard.png
/usr/share/gnome/help/balsa/C/images/address-book.png
/usr/share/gnome/help/balsa/C/images/balsa_logo.png
/usr/share/gnome/help/balsa/C/images/druid-start.png
/usr/share/gnome/help/balsa/C/images/example-alias.png
/usr/share/gnome/help/balsa/C/images/main-window-toolbar.png
/usr/share/gnome/help/balsa/C/images/main-window.png
/usr/share/gnome/help/balsa/C/images/newmsg-window-attachments.png
/usr/share/gnome/help/balsa/C/images/newmsg-window-toolbar.png
/usr/share/gnome/help/balsa/C/images/newmsg-window.png
/usr/share/gnome/help/balsa/C/images/preferences-window.png
/usr/share/gnome/help/balsa/C/images/spell-check.png
/usr/share/gnome/help/balsa/C/index.html
/usr/share/gnome/help/balsa/C/its-not-working.html
/usr/share/gnome/help/balsa/C/ln7.html
/usr/share/gnome/help/balsa/C/mbox-formats.html
/usr/share/gnome/help/balsa/C/stylesheet-images
/usr/share/gnome/help/balsa/C/stylesheet-images/caution.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/home.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/important.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/next.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/note.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/prev.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/tip.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/toc-blank.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/toc-minus.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/toc-plus.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/up.gif
/usr/share/gnome/help/balsa/C/stylesheet-images/warning.gif
/usr/share/gnome/help/balsa/C/topic.dat
/usr/share/gnome/help/balsa/C/win-composer.html
/usr/share/gnome/help/balsa/C/win-config-0.html
/usr/share/gnome/help/balsa/C/win-config-1.html
/usr/share/gnome/help/balsa/C/win-config-10.html
/usr/share/gnome/help/balsa/C/win-config-2.html
/usr/share/gnome/help/balsa/C/win-config-3.html
/usr/share/gnome/help/balsa/C/win-config-4.html
/usr/share/gnome/help/balsa/C/win-config-5.html
/usr/share/gnome/help/balsa/C/win-config-6.html
/usr/share/gnome/help/balsa/C/win-config-7.html
/usr/share/gnome/help/balsa/C/win-config-8.html
/usr/share/gnome/help/balsa/C/win-config-9.html
/usr/share/gnome/help/balsa/C/win-config.html
/usr/share/gnome/help/balsa/C/win-main.html

/Pawel
-- 
Pawel Salek (pawsa@theochem.kth.se) http://www.theochem.kth.se/~pawsa/
Theoretical Chemistry Division, KTH voice: +46 8 790-8202