Expand | Collapse

◀ 14. XHTML1 pass-through16. Manipulating URIs ▶

▼15. Display navigation menu

This stylesheet is responsible for displaying the navigation pane, that is visible for example in this HTML documentation. 

xsl:stylesheet id="stylesheet" exclude-result-prefixes="x2 lit xs" version="1.0" xml:lang="en"
  
  xsl:key name="labels" match="xs:label" use="@href"
  xsl:key name="html-uris" match="xs:html-uri" use="@href"
  xsl:key name="site-items" match="xs:site-item" use="@href"
  
  xsl:param name="site-map" select="'#DOES-NOT-EXIST'"
  xsl:param name="site-map-doc" select="document($site-map)"

  display-navigation template

  xsl:template match="xs:label"
  xsl:template match="xs:number"

  Navigation menu using site maps
  Navigation menu without site maps
  Page navigation in body pane
  Links to related pages in HTML head

▼15.1. display-navigation template

As with automatic numbering, there needs to be implemented two versions of the navigation pane: one when a site map is active, and the other for stand-alone single-file documents. The following template selects from one of the two approaches: 

xsl:template name="display-navigation"
      xsl:choose
        xsl:when test="count($site-map-doc)>0"
          <ul class="_navigation">
            xsl:apply-templates select="$site-map-doc/xs:site-map/xs:site-item" mode="navigation-from-site-map"
          </ul>
        
        xsl:otherwise
          xsl:apply-templates select="/" mode="navigation"

▼15.2. Navigation menu using site maps

xsl:template match="node()" mode="navigation-from-site-map"
      
xsl:template match="xs:site-item" mode="navigation-from-site-map"
        <li>
          <a>
            xsl:attribute name="href"
              xsl:call-template name="map-uri"
                xsl:with-param name="href" select="@href"
              
            
      
            xsl:apply-templates select="xs:title[1]" mode="title-text"
          </a>
      
          xsl:if test="xs:site-item"
            <ul class="_navigation">
              xsl:apply-templates select="xs:site-item" mode="navigation-from-site-map"
            </ul>
          
            
        </li>

▼15.3. Navigation menu without site maps

The navigation mode creates a navigation menu based on the nesting of sections in the current XML document only. 

xsl:template match="x2:section" mode="navigation"
        <li>
          <a>
            xsl:attribute name="href"
              xsl:text#
              xsl:call-template name="id"
            
            xsl:apply-templates select="x2:h" mode="title-text"
          </a>
      
          xsl:if test="x2:section"
            <ul class="_navigation">
              xsl:apply-templates mode="navigation"
            </ul>
          
        </li>
      
xsl:template match="text()" mode="navigation"
      
xsl:template match="/" mode="navigation"
        <ul class="_navigation">
          xsl:apply-templates mode="navigation"
        </ul>
      
xsl:template match="*" mode="navigation"
        xsl:apply-templates mode="navigation"

▼15.4. Page navigation in body pane

This displays the page navigation control in the body pane, containing the links to the “previous”, “next”, and “up” pages in relation to the current one.

It only applies when a site map is active.

display-page-navigation-item: displays an item in the navigation table display-page-navigation: displays the navigation table

▼15.4.1. display-page-navigation-item: displays an item in the navigation table

xsl:template name="display-page-navigation-item"
        xsl:param name="target"
        xsl:param name="left-symbol"
        xsl:param name="right-symbol"
        xsl:param name="access-key"
  
        xsl:if test="count($target) > 0"
          <a>
            xsl:attribute name="href"
              xsl:call-template name="map-uri"
                xsl:with-param name="href" select="$target/@href"
              
            

            xsl:if test="$access-key != ''"
              xsl:attribute name="accesskey"
                xsl:value-of select="$access-key"
              
            
  
            xsl:copy-of select="$left-symbol"
            xsl:apply-templates select="$target" mode="number-from-site-map"
            xsl:text 
            xsl:apply-templates select="$target/xs:title[1]" mode="title-text"
            xsl:copy-of select="$right-symbol"
          </a>

▼15.4.2. display-page-navigation: displays the navigation table

xsl:template name="display-page-navigation"

        xsl:param name="key-bindings" select="false()"

        xsl:variable name="uri"
          xsl:call-template name="absolute-uri"
        

  
        xsl:for-each select="$site-map-doc"

          Get the site map nodes
    
          <table class="_page-navigation">
            <tr>
              <td class="left">
                xsl:call-template name="display-page-navigation-item"
                  xsl:with-param name="left-symbol" select="'◀ '"
                  xsl:with-param name="target" select="$previous"
                  xsl:with-param name="access-key"
                    xsl:if test="$key-bindings"p
                  
                
              </td>
      
              <td class="middle">
                xsl:call-template name="display-page-navigation-item"
                  xsl:with-param name="left-symbol" select="'▲ '"
                  xsl:with-param name="target" select="$up"
                  xsl:with-param name="access-key"
                    xsl:if test="$key-bindings"u
                  
                
              </td>
      
              <td class="right">
                xsl:call-template name="display-page-navigation-item"
                  xsl:with-param name="right-symbol" select="' ▶'"
                  xsl:with-param name="target" select="$next"
                  xsl:with-param name="access-key"
                    xsl:if test="$key-bindings"n
                  
                
              </td>
            </tr>
          </table>
        

        xsl:if test="$key-bindings"
          <p>Keyboard shortcuts: <b>P</b>revious <b>U</b>p <b>N</b>ext</p>

This gets the nodes in the site map corresponding to the current, “previous”, “next”, and “up” items. 

xsl:variable name="me" select="key('html-uris', $uri)/parent::xs:site-item"
xsl:variable name="previous" select="$me/preceding-sibling::xs:site-item[1]"
xsl:variable name="next" select="$me/following-sibling::xs:site-item[1]"
xsl:variable name="up" select="$me/parent::xs:site-item"

▼15.5. Links to related pages in HTML head

This is similar to Page navigation in body pane above, but the pages are exposed as link elements inside the HTML head. These links may be used by web spiders, or special navigation functionality in web browsers.

output-page-link-item: outputs one link in head display-page-navigation: displays the navigation table

▼15.5.1. output-page-link-item: outputs one link in head

xsl:template name="output-page-link-item"
        xsl:param name="target"
        xsl:param name="relation"
        xsl:param name="title"
          xsl:apply-templates select="$target/xs:title[1]" mode="title-text"
        
  
        xsl:if test="count($target) > 0"
          <link rel="{$relation}" title="{$title}">
            xsl:attribute name="href"
              xsl:call-template name="map-uri"
                xsl:with-param name="href" select="$target/@href"
              
            
          </link>

▼15.5.2. output-page-links: outputs links in head

xsl:template name="output-page-links"

        xsl:variable name="uri"
          xsl:call-template name="absolute-uri"
        

        xsl:for-each select="$site-map-doc"
          Get the site map nodes

          xsl:call-template name="output-page-link-item"
            xsl:with-param name="relation" select="'previous'"
            xsl:with-param name="target" select="$previous"
          

          xsl:call-template name="output-page-link-item"
            xsl:with-param name="relation" select="'up'"
            xsl:with-param name="target" select="$up"
          

          xsl:call-template name="output-page-link-item"
            xsl:with-param name="relation" select="'next'"
            xsl:with-param name="target" select="$next"

Formatted using xhtml2to1 by Steve Cheng.

◀ 14. XHTML1 pass-through16. Manipulating URIs ▶

Keyboard shortcuts: Previous Up Next