Another problem

Shaun McCance <shaunm at gnome.org>
Fri Nov 26 11:03:07 EST 2010

On Fri, 2010-11-26 at 12:47 -0300, John Coppens wrote:
> Hello guys...
> 
> Another problem popped up. In many pages 'quick links' are available
> near the top, to the several parts of that page - this is quite helpful.
> 
> I haven't found out how to implement those - is it possible to do this
> with the xref links? (i.e. automatically inserting them into the
> quicklink table) Any example somewhere?

Do you mean links to the sections within a page, like on this page?

http://openhelpconference.com/location.html

This can be accomplished using the proposed links element:

http://projectmallard.org/pipermail/mallard-list_projectmallard.org/2010-August/000025.html

Basically, wherever you want the links inserted, you would do this:

<links type="section"/>

This works only in the latest yelp-xsl from git.gnome.org, and since
it's not yet in the official spec, you have to use the experimental
namespace, so:

<e:links xmlns:e="http://projectmallard.org/experimental/"
  type="section"/>

You can also give it a title:

<e:links xmlns:e="http://projectmallard.org/experimental/"
  type="section">
  <title>On This Page</title>
</e:links>

This will almost certainly make its way into the spec before 1.0, so
the requirement to use the experimental namespace will go away. The
links element for topic and section links work well with everything
I've thrown at them. I still need to work on the links element for
some other types of links. I'd appreciate feedback so we can catch
problems early.

Thanks,
Shaun