[gtk-doc] Improve the design of the navigation bar
- From: Stefan Kost <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] Improve the design of the navigation bar
- Date: Wed, 24 Jul 2013 20:28:38 +0000 (UTC)
commit 0fab530ad580011d8fee87755a37d180392e9970
Author: William Jon McCann <william jon mccann gmail com>
Date: Tue Jul 16 15:14:26 2013 -0400
Improve the design of the navigation bar
Put the shortcuts on the left, buttons at the right, and insert placeholder icons
instead of hiding the links when necessary.
Move the book title into the page title.
https://bugzilla.gnome.org/show_bug.cgi?id=696570
Makefile.am | 3 +
gtk-doc-single.xsl | 210 +++++++++++++++++-----------------
gtk-doc.xsl | 306 ++++++++++++++++++++++++-------------------------
left-insensitive.png | Bin 0 -> 395 bytes
right-insensitive.png | Bin 0 -> 373 bytes
up-insensitive.png | Bin 0 -> 374 bytes
6 files changed, 260 insertions(+), 259 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 8e33c3f..fa2e3cc 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -36,8 +36,11 @@ gtkdocdata_DATA = \
gtk-doc.notmpl-flat.make \
home.png \
left.png \
+ left-insensitive.png \
right.png \
+ right-insensitive.png \
up.png \
+ up-insensitive.png \
style.css
pkgconfigdir = $(datadir)/pkgconfig
diff --git a/gtk-doc-single.xsl b/gtk-doc-single.xsl
index 2885dd9..b9fd576 100644
--- a/gtk-doc-single.xsl
+++ b/gtk-doc-single.xsl
@@ -135,6 +135,13 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
<xsl:apply-imports/>
</xsl:template>
+ <xsl:template name="user.head.title">
+ <xsl:variable name="home" select="/*[1]"/>
+ <title>
+ <xsl:apply-templates select="$home" mode="object.title.markup"/>: <xsl:copy-of select="$title"/>
+ </title>
+ </xsl:template>
+
<xsl:template name="user.head.content">
<xsl:if test="$gtkdoc.version">
<meta name="generator"
@@ -223,108 +230,11 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
<xsl:if test="$suppress.navigation = '0' and $home != .">
<table class="navigation" id="top" width="100%"
- summary = "Navigation header" cellpadding="2" cellspacing="2">
+ summary = "Navigation header" cellpadding="2" cellspacing="10">
<tr valign="middle">
- <xsl:choose>
- <xsl:when test="count($prev) > 0">
- <td>
- <a accesskey="p">
- <xsl:attribute name="href">
- <xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$prev"/>
- </xsl:call-template>
- </xsl:attribute>
- <img src="left.png" width="16" height="16" border="0">
- <xsl:attribute name="alt">
- <xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-prev</xsl:with-param>
- </xsl:call-template>
- </xsl:attribute>
- </img>
- </a>
- </td>
- </xsl:when>
- <xsl:otherwise>
- <td> </td>
- </xsl:otherwise>
- </xsl:choose>
- <xsl:choose>
- <xsl:when test="count($up) > 0 and $up != $home">
- <td>
- <a accesskey="u">
- <xsl:attribute name="href">
- <xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$up"/>
- </xsl:call-template>
- </xsl:attribute>
- <img src="up.png" width="16" height="16" border="0">
- <xsl:attribute name="alt">
- <xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-up</xsl:with-param>
- </xsl:call-template>
- </xsl:attribute>
- </img>
- </a>
- </td>
- </xsl:when>
- <xsl:otherwise>
- <td> </td>
- </xsl:otherwise>
- </xsl:choose>
- <xsl:choose>
- <xsl:when test="$home != .">
- <td>
- <a accesskey="h">
- <xsl:attribute name="href">
- <xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$home"/>
- </xsl:call-template>
- </xsl:attribute>
- <img src="home.png" width="16" height="16" border="0">
- <xsl:attribute name="alt">
- <xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-home</xsl:with-param>
- </xsl:call-template>
- </xsl:attribute>
- </img>
- </a>
- </td>
- </xsl:when>
- <xsl:otherwise>
- <td> </td>
- </xsl:otherwise>
- </xsl:choose>
- <th width="100%" align="center">
- <xsl:apply-templates select="$home" mode="object.title.markup"/>
- </th>
- <xsl:choose>
- <xsl:when test="count($next) > 0">
- <td>
- <a accesskey="n">
- <xsl:attribute name="href">
- <xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$next"/>
- </xsl:call-template>
- </xsl:attribute>
- <img src="right.png" width="16" height="16" border="0">
- <xsl:attribute name="alt">
- <xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-next</xsl:with-param>
- </xsl:call-template>
- </xsl:attribute>
- </img>
- </a>
- </td>
- </xsl:when>
- <xsl:otherwise>
- <td> </td>
- </xsl:otherwise>
- </xsl:choose>
- </tr>
- <!--<xsl:if test="name()='refentry'"-->
- <xsl:if test="count($sections) > 0">
- <tr>
- <td colspan="5" class="shortcuts">
+ <td width="100%" align="left">
+ <!--<xsl:if test="name()='refentry'"-->
+ <xsl:if test="count($sections) > 0">
<xsl:if test="count($sect_synopsis) > 0">
<a href="#{$section_id}.synopsis" class="shortcut">Top</a>
</xsl:if>
@@ -420,9 +330,101 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
 | 
</xsl:if>
-->
- </td>
- </tr>
- </xsl:if>
+ </xsl:if>
+ </td>
+ <xsl:choose>
+ <xsl:when test="$home != .">
+ <td>
+ <a accesskey="h">
+ <xsl:attribute name="href">
+ <xsl:call-template name="href.target">
+ <xsl:with-param name="object" select="$home"/>
+ </xsl:call-template>
+ </xsl:attribute>
+ <img src="home.png" width="16" height="16" border="0">
+ <xsl:attribute name="alt">
+ <xsl:call-template name="gentext">
+ <xsl:with-param name="key">nav-home</xsl:with-param>
+ </xsl:call-template>
+ </xsl:attribute>
+ </img>
+ </a>
+ </td>
+ </xsl:when>
+ <xsl:otherwise>
+ <td> </td>
+ </xsl:otherwise>
+ </xsl:choose>
+ <xsl:choose>
+ <xsl:when test="count($up) > 0 and $up != $home">
+ <td>
+ <a accesskey="u">
+ <xsl:attribute name="href">
+ <xsl:call-template name="href.target">
+ <xsl:with-param name="object" select="$up"/>
+ </xsl:call-template>
+ </xsl:attribute>
+ <img src="up.png" width="16" height="16" border="0">
+ <xsl:attribute name="alt">
+ <xsl:call-template name="gentext">
+ <xsl:with-param name="key">nav-up</xsl:with-param>
+ </xsl:call-template>
+ </xsl:attribute>
+ </img>
+ </a>
+ </td>
+ </xsl:when>
+ <xsl:otherwise>
+ <td><img src="up-insensitive.png" width="16" height="16" border="0"/></td>
+ </xsl:otherwise>
+ </xsl:choose>
+ <xsl:choose>
+ <xsl:when test="count($prev) > 0">
+ <td>
+ <a accesskey="p">
+ <xsl:attribute name="href">
+ <xsl:call-template name="href.target">
+ <xsl:with-param name="object" select="$prev"/>
+ </xsl:call-template>
+ </xsl:attribute>
+ <img src="left.png" width="16" height="16" border="0">
+ <xsl:attribute name="alt">
+ <xsl:call-template name="gentext">
+ <xsl:with-param name="key">nav-prev</xsl:with-param>
+ </xsl:call-template>
+ </xsl:attribute>
+ </img>
+ </a>
+ </td>
+ </xsl:when>
+ <xsl:otherwise>
+ <td><img src="left-insensitive.png" width="16" height="16" border="0"/></td>
+ </xsl:otherwise>
+ </xsl:choose>
+ <xsl:choose>
+ <xsl:when test="count($next) > 0">
+ <td>
+ <a accesskey="n">
+ <xsl:attribute name="href">
+ <xsl:call-template name="href.target">
+ <xsl:with-param name="object" select="$next"/>
+ </xsl:call-template>
+ </xsl:attribute>
+ <img src="right.png" width="16" height="16" border="0">
+ <xsl:attribute name="alt">
+ <xsl:call-template name="gentext">
+ <xsl:with-param name="key">nav-next</xsl:with-param>
+ </xsl:call-template>
+ </xsl:attribute>
+ </img>
+ </a>
+ </td>
+ </xsl:when>
+ <xsl:otherwise>
+ <td><img src="right-insensitive.png" width="16" height="16" border="0"/></td>
+ </xsl:otherwise>
+ </xsl:choose>
+ </tr>
</table>
</xsl:if>
</xsl:template>
diff --git a/gtk-doc.xsl b/gtk-doc.xsl
index 1f68250..2cacf27 100644
--- a/gtk-doc.xsl
+++ b/gtk-doc.xsl
@@ -390,6 +390,15 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
<xsl:apply-imports/>
</xsl:template>
+ <xsl:template name="user.head.title">
+ <xsl:param name="node" select="."/>
+ <xsl:param name="title"/>
+ <xsl:variable name="home" select="/*[1]"/>
+ <title>
+ <xsl:apply-templates select="$home" mode="object.title.markup"/>: <xsl:copy-of select="$title"/>
+ </title>
+ </xsl:template>
+
<xsl:template name="user.head.content">
<xsl:if test="$gtkdoc.version">
<meta name="generator" content="GTK-Doc V{$gtkdoc.version} (XML mode)"/>
@@ -454,21 +463,149 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
<xsl:if test="$suppress.navigation = '0' and $home != .">
<table class="navigation" id="top" width="100%"
- summary = "Navigation header" cellpadding="2" cellspacing="2">
+ summary = "Navigation header" cellpadding="2" cellspacing="10">
<tr valign="middle">
+ <td width="100%" align="left">
+ <!--<xsl:if test="name()='refentry'"-->
+ <xsl:choose>
+ <xsl:when test="count($refsections) > 0">
+ <xsl:if test="count($sect_synopsis) > 0">
+ <a href="#{$section_id}.synopsis" class="shortcut">Top</a>
+ </xsl:if>
+ <xsl:if test="count($sect_desc) > 0">
+  | 
+ <a href="#{$section_id}.description" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='desc']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_object_hierarchy) > 0">
+  | 
+ <a href="#{$section_id}.object-hierarchy" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='object_hierarchy']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_impl_interfaces) > 0">
+  | 
+ <a href="#{$section_id}.implemented-interfaces" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='impl_interfaces']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_prerequisites) > 0">
+  | 
+ <a href="#{$section_id}.prerequisites" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='prerequisites']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_derived_interfaces) > 0">
+  | 
+ <a href="#{$section_id}.derived-interfaces" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='derived_interfaces']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_implementations) > 0">
+  | 
+ <a href="#{$section_id}.implementations" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='implementations']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_properties) > 0">
+  | 
+ <a href="#{$section_id}.properties" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='properties']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_child_properties) > 0">
+  | 
+ <a href="#{$section_id}.child-properties" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='child_properties']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_style_properties) > 0">
+  | 
+ <a href="#{$section_id}.style-properties" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='style_properties']/title"/>
+ </a>
+ </xsl:if>
+ <xsl:if test="count($sect_signal_proto) > 0">
+  | 
+ <a href="#{$section_id}.signals" class="shortcut">
+ <xsl:value-of select="./refsect1[ role='signal_proto']/title"/>
+ </a>
+ </xsl:if>
+ <!--
+ <xsl:if test="count($sect_details) > 0">
+ <a href="#details" class="shortcut">
+ <xsl:value-of select="./refsect1[ id='details']/title"/>
+ </a>
+  | 
+ </xsl:if>
+ <xsl:if test="count($sect_property_details) > 0">
+ <a href="#property_details" class="shortcut">
+ <xsl:value-of select="./refsect1[ id='property_details']/title"/>
+ </a>
+  | 
+ </xsl:if>
+ <xsl:if test="count($sect_child_property_details) > 0">
+ <a href="#child_property_details" class="shortcut">
+ <xsl:value-of select="./refsect1[ id='property_child_details']/title"/>
+ </a>
+  | 
+ </xsl:if>
+ <xsl:if test="count($sect_style_property_details) > 0">
+ <a href="#style_property_details" class="shortcut">
+ <xsl:value-of select="./refsect1[ id='style_property_details']/title"/>
+ </a>
+  | 
+ </xsl:if>
+ <xsl:if test="count($sect_signals) > 0">
+ <a href="#signals" class="shortcut">
+ <xsl:value-of select="./refsect1[ id='signals']/title"/>
+ </a>
+  | 
+ </xsl:if>
+ -->
+ </xsl:when>
+ <!-- this is not yet very nice, as it requires all glossdic/indexdiv
+ elements having a anchor element. maybe we can customize the xsl
+ to automaticaly create local anchors
+ -->
+ <xsl:when test="count($glssections) > 0">
+ <xsl:for-each select="./glossdiv">
+ <xsl:if test="position() > 1">
+  | 
+ </xsl:if>
+ <a class="shortcut">
+ <xsl:attribute name="href">#gls<xsl:value-of select="./title"/></xsl:attribute>
+ <xsl:value-of select="./title"/>
+ </a>
+ </xsl:for-each>
+ </xsl:when>
+ <xsl:when test="count($idxsections) > 0">
+ <xsl:for-each select="./indexdiv/indexdiv">
+ <xsl:if test="position() > 1">
+  | 
+ </xsl:if>
+ <a class="shortcut">
+ <xsl:attribute name="href">#idx<xsl:value-of select="./title"/></xsl:attribute>
+ <xsl:value-of select="./title"/>
+ </a>
+ </xsl:for-each>
+ </xsl:when>
+ </xsl:choose>
+ </td>
<xsl:choose>
- <xsl:when test="count($prev) > 0">
+ <xsl:when test="$home != .">
<td>
- <a accesskey="p">
+ <a accesskey="h">
<xsl:attribute name="href">
<xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$prev"/>
+ <xsl:with-param name="object" select="$home"/>
</xsl:call-template>
</xsl:attribute>
- <img src="left.png" width="16" height="16" border="0">
+ <img src="home.png" width="16" height="16" border="0">
<xsl:attribute name="alt">
<xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-prev</xsl:with-param>
+ <xsl:with-param name="key">nav-home</xsl:with-param>
</xsl:call-template>
</xsl:attribute>
</img>
@@ -499,22 +636,22 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
</td>
</xsl:when>
<xsl:otherwise>
- <td> </td>
+ <td><img src="up-insensitive.png" width="16" height="16" border="0"/></td>
</xsl:otherwise>
</xsl:choose>
<xsl:choose>
- <xsl:when test="$home != .">
+ <xsl:when test="count($prev) > 0">
<td>
- <a accesskey="h">
+ <a accesskey="p">
<xsl:attribute name="href">
<xsl:call-template name="href.target">
- <xsl:with-param name="object" select="$home"/>
+ <xsl:with-param name="object" select="$prev"/>
</xsl:call-template>
</xsl:attribute>
- <img src="home.png" width="16" height="16" border="0">
+ <img src="left.png" width="16" height="16" border="0">
<xsl:attribute name="alt">
<xsl:call-template name="gentext">
- <xsl:with-param name="key">nav-home</xsl:with-param>
+ <xsl:with-param name="key">nav-prev</xsl:with-param>
</xsl:call-template>
</xsl:attribute>
</img>
@@ -522,12 +659,9 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
</td>
</xsl:when>
<xsl:otherwise>
- <td> </td>
+ <td><img src="left-insensitive.png" width="16" height="16" border="0"/></td>
</xsl:otherwise>
</xsl:choose>
- <th width="100%" align="center">
- <xsl:apply-templates select="$home" mode="object.title.markup"/>
- </th>
<xsl:choose>
<xsl:when test="count($next) > 0">
<td>
@@ -548,148 +682,10 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
</td>
</xsl:when>
<xsl:otherwise>
- <td> </td>
+ <td><img src="right-insensitive.png" width="16" height="16" border="0"/></td>
</xsl:otherwise>
</xsl:choose>
</tr>
- <!--<xsl:if test="name()='refentry'"-->
- <xsl:choose>
- <xsl:when test="count($refsections) > 0">
- <tr>
- <td colspan="5" class="shortcuts">
- <xsl:if test="count($sect_synopsis) > 0">
- <a href="#{$section_id}.synopsis" class="shortcut">Top</a>
- </xsl:if>
- <xsl:if test="count($sect_desc) > 0">
-  | 
- <a href="#{$section_id}.description" class="shortcut">
- <xsl:value-of select="./refsect1[ role='desc']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_object_hierarchy) > 0">
-  | 
- <a href="#{$section_id}.object-hierarchy" class="shortcut">
- <xsl:value-of select="./refsect1[ role='object_hierarchy']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_impl_interfaces) > 0">
-  | 
- <a href="#{$section_id}.implemented-interfaces" class="shortcut">
- <xsl:value-of select="./refsect1[ role='impl_interfaces']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_prerequisites) > 0">
-  | 
- <a href="#{$section_id}.prerequisites" class="shortcut">
- <xsl:value-of select="./refsect1[ role='prerequisites']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_derived_interfaces) > 0">
-  | 
- <a href="#{$section_id}.derived-interfaces" class="shortcut">
- <xsl:value-of select="./refsect1[ role='derived_interfaces']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_implementations) > 0">
-  | 
- <a href="#{$section_id}.implementations" class="shortcut">
- <xsl:value-of select="./refsect1[ role='implementations']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_properties) > 0">
-  | 
- <a href="#{$section_id}.properties" class="shortcut">
- <xsl:value-of select="./refsect1[ role='properties']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_child_properties) > 0">
-  | 
- <a href="#{$section_id}.child-properties" class="shortcut">
- <xsl:value-of select="./refsect1[ role='child_properties']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_style_properties) > 0">
-  | 
- <a href="#{$section_id}.style-properties" class="shortcut">
- <xsl:value-of select="./refsect1[ role='style_properties']/title"/>
- </a>
- </xsl:if>
- <xsl:if test="count($sect_signal_proto) > 0">
-  | 
- <a href="#{$section_id}.signals" class="shortcut">
- <xsl:value-of select="./refsect1[ role='signal_proto']/title"/>
- </a>
- </xsl:if>
- <!--
- <xsl:if test="count($sect_details) > 0">
- <a href="#details" class="shortcut">
- <xsl:value-of select="./refsect1[ id='details']/title"/>
- </a>
-  | 
- </xsl:if>
- <xsl:if test="count($sect_property_details) > 0">
- <a href="#property_details" class="shortcut">
- <xsl:value-of select="./refsect1[ id='property_details']/title"/>
- </a>
-  | 
- </xsl:if>
- <xsl:if test="count($sect_child_property_details) > 0">
- <a href="#child_property_details" class="shortcut">
- <xsl:value-of select="./refsect1[ id='property_child_details']/title"/>
- </a>
-  | 
- </xsl:if>
- <xsl:if test="count($sect_style_property_details) > 0">
- <a href="#style_property_details" class="shortcut">
- <xsl:value-of select="./refsect1[ id='style_property_details']/title"/>
- </a>
-  | 
- </xsl:if>
- <xsl:if test="count($sect_signals) > 0">
- <a href="#signals" class="shortcut">
- <xsl:value-of select="./refsect1[ id='signals']/title"/>
- </a>
-  | 
- </xsl:if>
- -->
- </td>
- </tr>
- </xsl:when>
- <!-- this is not yet very nice, as it requires all glossdic/indexdiv
- elements having a anchor element. maybe we can customize the xsl
- to automaticaly create local anchors
- -->
- <xsl:when test="count($glssections) > 0">
- <tr>
- <td colspan="5" class="shortcuts">
- <xsl:for-each select="./glossdiv">
- <xsl:if test="position() > 1">
-  | 
- </xsl:if>
- <a class="shortcut">
- <xsl:attribute name="href">#gls<xsl:value-of select="./title"/></xsl:attribute>
- <xsl:value-of select="./title"/>
- </a>
- </xsl:for-each>
- </td>
- </tr>
- </xsl:when>
- <xsl:when test="count($idxsections) > 0">
- <tr>
- <td colspan="5" class="shortcuts">
- <xsl:for-each select="./indexdiv/indexdiv">
- <xsl:if test="position() > 1">
-  | 
- </xsl:if>
- <a class="shortcut">
- <xsl:attribute name="href">#idx<xsl:value-of select="./title"/></xsl:attribute>
- <xsl:value-of select="./title"/>
- </a>
- </xsl:for-each>
- </td>
- </tr>
- </xsl:when>
- </xsl:choose>
</table>
</xsl:if>
</xsl:template>
diff --git a/left-insensitive.png b/left-insensitive.png
new file mode 100644
index 0000000..3269393
Binary files /dev/null and b/left-insensitive.png differ
diff --git a/right-insensitive.png b/right-insensitive.png
new file mode 100644
index 0000000..4c95785
Binary files /dev/null and b/right-insensitive.png differ
diff --git a/up-insensitive.png b/up-insensitive.png
new file mode 100644
index 0000000..f404986
Binary files /dev/null and b/up-insensitive.png differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
