Another problem

On Fri, 2010-11-26 at 13:43 -0300, John Coppens wrote:
> On Fri, 26 Nov 2010 11:03:07 -0500
> Shaun McCance <shaunm at gnome.org> wrote:
> 
> > 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
> 
> Hi Shaun.
> 
> Not exactly. At least the links on that page are to other documents. 

Sorry, I should have been more explicit. I meant the blue box with
the links to Flights and Venue. Those are just links to anchors in
the same page. I think that's what you were talking about.

> But, as I understand it, the proposed element would solve 'my' problem
> too. I am working on translating and editing the Anjuta manual to
> Mallard, I encountered this frequently. Eg.:
> 
> http://library.gnome.org/devel/anjuta-manual/stable/groups-and-targets.html.en
>  
> > This can be accomplished using the proposed links element:
> > 
> > http://projectmallard.org/pipermail/mallard-list_projectmallard.org/2010-August/000025.html
> ...
> > 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.
> 
> I'll try to recompile yelp later today. But I guess that, to generare
> HTML, I would be needing changes to gnome-doc-tool too, won't I?

If you're using gnome-doc-tool, then you're using the XSLT from
gnome-doc-utils. That's not actively developed, and isn't getting
new features like the links element.

The new stylesheets are in the yelp-xsl package. There will be a
replacement for gnome-doc-tool in yelp-tools, but it's not there
yet. You can always just call xsltproc yourself, though. A little
more work, but not too hard. The only tricky part is generating a
cache file, but the cache format hasn't changed, so you can still
use gnome-doc-tool for that. This should work:

gnome-doc-tool html .
for page in *.page; do
  xsltproc --stringparam mal.cache.file index.cache \
    `pkg-config --variable mal2html yelp-xsl` $page
done

--
Shaun