Re: new help browser

[skud netizen com au]

On Wed, May 31, 2000 at 03:37:04PM -0400, Alexander Kirillov wrote:
> Couple of comments:
> 
> a. I feel rather confident that we can produce reasonably good
> definitions for the glossary. I could volunteer to start this. We
> could also ask help of other doc people (OSWG, KDE, Debian,...) -
> after all, most of these terms are not GNOME-specific.  

There are issues here with distribution.  Sure, if you want a general
index of computer/Linux terms, you can make one.  But what format will
it be in?  How will it be distributed?  What about GNOME-specific
definitions?

> b. Do we want it to be glossary or index? That is: should the
> definitions be self-contained ("device is ...") or refer to other docs
> (device -- see ....) or both? 

If you have "see also" links, you need to make sure that those links
point to something meaningful on the user's system.  For instance, you
need to be sure that the relevant manual pages are installed.

> c. Do we really want to markup *all* appearances of the word "device"
> in all our docs so that the help browser can display the appropriate
> glossary definition? And same for all other non-obvious terms, such as
> shell, symlink,...? It seems like a terrible waste of time. Can
> anyone suggest a better idea?

First time it appears in any given navigational chunk (sect1?).

K.

-- 
Kirrily Robert -- <skud@netizen.com.au> -- http://netizen.com.au/
Internet and Open Source Development, Consulting and Training
Level 13, 500 Collins St, Melbourne VIC 3000
Phone: +61 3 9614 0949  Fax +61 3 9614 0948