RE: indexing

[Gregory Leblanc <GLeblanc cu-portland edu>]

> -----Original Message-----
> From: Erik Jarvi [mailto:ejarvi@megsinet.net]
> Sent: Sunday, July 30, 2000 6:14 PM
> To: gnome-doc-list@gnome.org
> Subject: Re: indexing
> 
> On Sat, Jul 29, 2000 at 10:57:39PM -0600, John Fleck wrote:
> > On Sat, Jul 29, 2000 at 11:38:40PM -0500, Dan Mueth wrote:
> > 
> > > Index (in document) - This is what you always see in the 
> back of books. It
> > > lists a lot of words and concepts in the book and lists 
> the relevant page
> > > numbers.  In DocBook, you do the indexing by hand using <index>,
> > > <indexterm>, ...  This produces an index at the end of 
> your document, as
> > > you would find in a book.  The main work here is having 
> somebody who knows
> > > how to index (which is an art unto itself) go through and 
> put in the
> > > indexing tags. 
> > 
> > Does this mean that once we manually mark up our documents with
> > <indexterm> etc tags, the help browser automatically gins 
> up an index
> > in the back of our "book" based on our index tagging? This does not
> > seem to occur with the current tools we're using. Will it with the 
> > new help system?
> 
> I haven't had this work either. In the new gtcd doc:
> 
>   <index>
>   <indexterm><primary>GNOME Mixer</primary><secondary>gmix</secondary>
>     
> <seealso>gtcd</seealso><seealso>grecord</seealso><seealso>grip
> </seealso>
>   </indexterm>
>   </index>
> 
> Intutively this seems correct indexing. I haven't taken a 
> look at the links 
> yet, tho.

I don't think that's how it works, but I could be mistaken.  The
<index></index> tags are for locating the actual index, not for placing
index terms.  Inside your document, you place

<indexterm>
  <primary>Big Cats</primary>
  <secondary>Tigers</secondary>
</indexterm>

And then your tools build something in the actual index that points to the
proper section when you look up Big Cats, Tigers in the index.  Clear as
mud?  Take a look at the examples for indexterm and related in DocBook: TDG,
I found them helpful for understating how the markup worked.
	Greg