<?xml version="1.0" encoding="UTF-8"?>
<essay xml:lang="en" version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:gal="http://norman.walsh.name/rdf/gallery#" xmlns:foaf="http://xmlns.com/foaf/0.1/">
<info>
    
    
    
    
    
    
    
    
    
    
    
    
<title>Better navigation</title><biblioid class="uri">http://norman.walsh.name/2007/08/30/specNavigation</biblioid>
<volumenum>10</volumenum>
<issuenum>86</issuenum>
<pubdate>2007-08-30T10:11:18-04:00</pubdate>
<date>$Date$</date>
<author>
      <personname>
<firstname>Norman</firstname>
	<surname>Walsh</surname>
</personname>
    </author>
<copyright>
      <year>2007</year>
      <holder>Norman Walsh</holder>
    </copyright>
<abstract>
<para>It's been ages since I wrote about site navigation
links. As the XProc spec works its way towards Last Call, I'm reminded
of their value.</para>
</abstract>
<dc:subject rdf:resource="http://norman.walsh.name/knows/taxonomy#HTML"/>
<dc:subject rdf:resource="http://norman.walsh.name/knows/taxonomy#TheWeb"/>
<dc:subject rdf:resource="http://norman.walsh.name/knows/taxonomy#XProc"/>
</info>

<para xml:id="p1">As a spec editor, whenever review begins in earnest,
I get a large number of suggestions of the form:</para>

<blockquote>
<para xml:id="p2">In 3.4.5, I suggest XXX instead of YYY</para>
</blockquote>

<para xml:id="p3">Or words to that effect: a brief reference to some part of the
specification followed by some suggestion about the prose
therein.</para>

<para xml:id="p4">For simple editorial changes, I can just search for the affected
prose in my <wikipedia>Emacs</wikipedia> buffer, make the suggested
change, and move on. But for technical changes or more sweeping
editorial suggestions, its often necessary (or at least useful) to
review the prose as it currently appears in the spec.</para>

<para xml:id="p5">That means finding “3.4.5”. And that means searching or scrolling or
finding the Table of Contents and clicking. Finding the Table of
Contents also involves some degree of searching or scrolling, so
that's not always fastest.</para>

<para xml:id="p6">What would be nice is a quick way to go directly to the right
place: in other words, site navigation links. By tweaking the
stylesheets to produce a bunch of <tag>link</tag> elements in the HTML
<tag>head</tag>, I get nearly instant access to all the likely
places:</para>

<mediaobject role="flickr">
    <!--Site navigation bookmarks (XProc steps)-->
  <imageobject xlink:href="http://www.flickr.com/photos/ndw/1276862608/">
    <imagedata fileref="http://farm2.static.flickr.com/1261/1276862608_7246cea7df_d.jpg"/>
  </imageobject>
</mediaobject>

<para xml:id="p7">In <wikipedia>Firefox</wikipedia>, you need the <link xlink:href="http://www.christophm.de/software/firefox/cmSiteNavigation/">cmSiteNavigation</link>
toolbar extension. I don't know what you might need in other
browsers.</para>

<para xml:id="p8">The “Sections”, “Chapters”, and “Appendices” pulldowns give you
access to what you'd expect. I took advantage of the “Bookmarks” pulldown
to provide direct access to all of the steps described in the specification.
</para>

<para xml:id="p9">You can play with these links yourself in the current
<link xlink:href="http://www.w3.org/XML/XProc/docs/langspec.html">editor's
draft</link>. Enjoy!</para>

</essay>

