Re: [Scrollkeeper-devel] extracted index

[Mary D. <Mar...@su...>]

> > 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="id10791">Main Menu, Example</see>
> > >     </secondary>
> > >   </primary>
> > >   <primary>
> > >     <title>Main Menu</title>
> > >     <secondary>
> > >       <title linkid="idx-a3" id="id10791">Example</title>
> > >     </secondary>
> > >   </primary>
> >

> > >  In order to be able to match the <see>/<seealso> content to the correct 
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 are
> > coming from. Why is this needed?

Dan

it's more a problem of how to generate the id.
ie, when outputing the 'main' term need a way of generating an id which can be 
generated again when outputing the see/seealso term. The only way I have figured 
to match a see/seealso value to the appropriate index entry is via a key.  But 
in order to construct the "use" element of the key I need to know how the 
see/seealso value is constructed (ie spaces, commas between terms etc). 
This will be clearer when I commit the stylesheet to SK CVS - in the meantime if 
anyone has any ideas/suggestions .....


cheers
mary

> 
> 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="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="id10791" ptitle="Main Menu" stitle="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="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
> 

~ I speak for myself, not for my employer ~
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Mary Dwyer
Desktop Applications & Middleware Grp
Sun Microsystems Ireland
Tel: +353-1-8199222 (xt 19222)
Fax: +353-1-8199078
email: mar...@ir...
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=