Re: DocBook indexterm help

[Breda McColgan <breda mccolgan sun com>]

Hello again Eric,

I have attached the section on the <indexterm> tag for the DocBook.

Please note that this section documents how to tag index entries in an
XML file, and how to add an Index element to a book. However, neither
the GDP stylesheets, nor Norm Walsh's stylesheets, appear to generate
the index contents at present.

Do you know how to include index terms in an (XML) index?

Thank you,
Breda.

Breda McColgan wrote:
> 
> Hello Eric,
> 
> apologies for the delay in getting back to you.
> 
> I will investigate the section on the <indexterm> tag for the DocBook.
> I will try to get to this before Christmas, but as Pat mentioned
> below, we are very busy at the moment so it may be the New Year
> before I can get back to you.
> 
> Hope this is acceptable to you -- looking forward to working with you.
> 
> Regards,
> Breda.
> 
> Pat Costello wrote:
> >
> > > Subject: DocBook indexterm help
> > > To: Pat Costello <Patrick Costello Sun COM>, Irene Ryan <irene ryan Sun COM>,
> > "Eugene O'Connor" <Eugene Oconnor Sun COM>
> > > Mime-Version: 1.0
> > > Content-Transfer-Encoding: 7bit
> > >
> > > Sun Doc Team:
> > >
> > > I am continuing to write the Handbook, after a long break, and have
> > > found that I am not qualified to write the section on the <indexterm>
> > > tag in DocBook.  I know what it does, but that is about all.  Looking at
> > > your past documentation you have been using it a lot and in my opinion
> > > in good measure.  I was wondering if someone wanted to write the section
> > > on using the indexterm tag.  The section would include how to use the
> > > tag and a little bit about where and when to use the tag and what terms
> > > need to be indexed etc.  While I realize the where, when and what should
> > > belong in the GDSG some basic usage guidelines in the Handbook would be
> > > a good thing.  The section will be a sect2 under the sect1 "DocBook
> > > Basics" for the article version.
> > >
> > > Eric Baudais
> > >
> > Hi Eric,
> >
> > We are very busy at the moment getting the Sun GNOME 2.0 desktop ready for
> > release. I will be meeting up with the rest of the team at the end of this week,
> > so one of us will get back to you next week regarding your suggestion about
> > guidelines on using the <indexterm> tag and related tags.
> >
> > Pat

Title: Indexing

The information in this section is organized as follows: Creating an Index Chapter Creating Index Entries Use the block <index> element to create an Index chapter in your book. Insert this element before the closing </book> element, as shown in the following example: . . . <index><indexterm><primaryie></primaryie></indexterm></index> </book> Use the inline <indexterm> element to create index entries. The syntax of the <indexterm> element is as follows: <indexterm [ id="id" | startref="id" ] [ class="class" ] > <primary>primaryterm</primary> [ <secondary>secondaryterm</secondary> ] [ <tertiary>tertiaryterm</tertiary> ] [ <see>cross-reference</see> ] [ <seealso>cross-reference</seealso> ] </indexterm> The first six examples in the remainder of this section are taken from the GNOME 2.0 Desktop User Guide. The remaining two examples are arbitrary examples. Add the following code to the relevant section: <indexterm> <primary>access keys</primary> </indexterm> The above code creates the following index entry: access keys, 22 Add the following code to the relevant section: <indexterm> <primary>applications</primary> <secondary>overview</secondary> </indexterm> Add the following code to the relevant section: <indexterm> <primary>applications</primary> <secondary>help</secondary> </indexterm> The above code creates the following index entry: applications help, 41 overview, 40 Add the following code to the relevant section: <indexterm> <primary>file manager</primary> <secondary>emblems</secondary> <tertiary>introduction</tertiary> </indexterm> Add the following code to the relevant section: <indexterm> <primary>file manager</primary> <secondary>emblems</secondary> <tertiary>adding</tertiary> </indexterm> The above code creates the following index entry: file manager . . . emblems adding, 124 introduction, 106 Add the following code to the relevant section: <indexterm> <primary>preference tools</primary> <secondary>Keyboard Accessibility</secondary> </indexterm> <indexterm> <primary>AccessX</primary> <see>preference tools, Keyboard Accessibility</see> </indexterm> The above code creates the following index entry: AccessX See preference tools, Keyboard Accessibility . . . preference tools . . . Keyboard Accessibility, 198 Add the following code to the relevant section: <indexterm> <primary>FTP sites, accessing</primary> </indexterm> <indexterm> <primary>file manager</primary> <secondary>FTP sites</secondary> <see>FTP sites</see> </indexterm> The above code creates the following index entry: file manager . . . FTP sites See FTP sites . . . FTP sites, accessing, 114 Add the following code to the relevant section: <indexterm> <primary>Trash</primary> <secondary>displaying</secondary> </indexterm> Add the same code to the relevant section: <indexterm> <primary>Trash</primary> <secondary>displaying</secondary> </indexterm> The above code creates the following index entry: Trash displaying, 122, 155 Add the following code to the relevant section: <indexterm> <primary>view pane</primary> <secondary>introduction</secondary> <seealso>viewer components</seealso> </indexterm> The above code creates the following index entry: view pane introduction, 104 See also viewer components Add the following code at the start of the relevant section: <indexterm id="basics" class="startofrange"> <primary>basic skills</primary> </indexterm> Add the following code at the end of the relevant section: <indexterm startref="basics" class="endofrange"> </indexterm> The above code creates the following index entry: basic skills, 15-24