Re: [Scrollkeeper-devel] extracted index

[Dan M. <d-...@uc...>]

On Thu, 24 May 2001, L=E1szl=F3 Kov=E1cs wrote:

> Mary Dwyer wrote:
>
> > 3.  ids are generated within the index to provide internal links for =
see and
> >     seealso references. For example, where "Main Menu, Example" is an=
 index
> > entry, and there is a see reference from "Chapter, Example" to "Main =
Menu,
> > Example" the output will be as follows:
> >
> > <primary>
> >     <title>Chapter</title>
> >     <secondary>
> >       <title>Example</title>
> >       <see id=3D"id10791">Main Menu, Example</see>
> >     </secondary>
> >   </primary>
> >   <primary>
> >     <title>Main Menu</title>
> >     <secondary>
> >       <title linkid=3D"idx-a3" id=3D"id10791">Example</title>
> >     </secondary>
> >   </primary>
>
> Isnt there a restriction that id attributes have to be unique throughou=
t
> the document? If it is then we will need to name the "id" attribute
> something else.

It looks like the <see> tag above does not want an 'id' attribute, but
instead it needs something like a 'linkid' - perhaps called 'seeid':
      <see seeid=3D"id10791">Main Menu, Example</see>

> >  In order to be able to match the <see>/<seealso> content to the corr=
ect index
> > term I need to be able to assume the <see>/<seealso> content will be =
structured
> > in a set way, ie primary, secondary, tertiary (each term seperated by=
 a comma
> > and a space - or whatever, once it is consistent).
> This might be a problem considering the variety of sources documents ar=
e
> coming from. Why is this needed?

I think we have three options here:

(1) Use the title as one expects all browsers to display them, such as
Mary did: "Main Menu, Example"
     <secondary>
       <title>Example</title>
       <see id=3D"id10791">Main Menu, Example</see>
     </secondary>

(2) Provide the information about where it is linking to as metadata so
that the help browser can construct the string however it wants to:

     <secondary>
       <title>Example</title>
       <see id=3D"id10791" ptitle=3D"Main Menu" stitle=3D"Example"/>
     </secondary>

(3) Don't bother giving the title of the section you are linking to,
because the help browser can always go in and extract it since it has the
id:

     <secondary>
       <title>Example</title>
       <see id=3D"id10791">
     </secondary>

I tend to prefer #2 I think, since it gives the help browser the
flexibility to present the information in different ways without doing
much work.

Dan