From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 15 Aug 2019 08:14:08 +0000 (+0200)
Subject: docs: Make anchors in API html files clickable/linkable
X-Git-Tag: v5.7.0-rc1~219
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5726e4723473d047977db414b027de6e3d19bed8;p=thirdparty%2Flibvirt.git

docs: Make anchors in API html files clickable/linkable

Use 'id' instead of 'name' for anchors which adds the hidden clickable
headerlink helper so it's way simpler to link to a specific part of the
docs.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/docs/newapi.xsl b/docs/newapi.xsl
index c808fe5ff8..4c7b241659 100644
--- a/docs/newapi.xsl
+++ b/docs/newapi.xsl
@@ -308,7 +308,7 @@
 
   <xsl:template match="typedef[@type = 'enum']">
     <xsl:variable name="name" select="string(@name)"/>
-    <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+    <h3><a id="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
     <div class="api">
       <pre>
         <span class="keyword">enum</span><xsl:text> </xsl:text>
@@ -357,7 +357,7 @@
   </xsl:template>
 
   <xsl:template match="struct">
-    <h3><a name="{@name}"><code><xsl:value-of select="@name"/></code></a></h3>
+    <h3><a id="{@name}"><code><xsl:value-of select="@name"/></code></a></h3>
     <div class="api">
       <pre>
         <span class="keyword">struct </span>
@@ -447,7 +447,7 @@
 
   <xsl:template match="macro">
     <xsl:variable name="name" select="string(@name)"/>
-    <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+    <h3><a id="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
     <pre class="api"><span class="directive">#define</span><xsl:text> </xsl:text><xsl:value-of select="$name"/></pre>
     <div class="description">
     <xsl:call-template name="formattext">
@@ -558,7 +558,7 @@
     <xsl:variable name="nlen" select="string-length($name)"/>
     <xsl:variable name="tlen" select="string-length(return/@type)"/>
     <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
-    <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+    <h3><a id="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
     <pre class="api">
     <span class="keyword">typedef</span><xsl:text> </xsl:text>
     <span class="type">
@@ -636,7 +636,7 @@
     <xsl:variable name="nlen" select="string-length($name)"/>
     <xsl:variable name="tlen" select="string-length(return/@type)"/>
     <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
-    <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+    <h3><a id="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
     <pre class="api">
     <span class="type">
       <xsl:call-template name="dumptext">
@@ -783,16 +783,16 @@
         <h2>Description</h2>
 
         <xsl:if test="count(exports[@type='macro']) > 0">
-          <h3><a name="macros">Macros</a></h3>
+          <h3><a id="macros">Macros</a></h3>
           <xsl:apply-templates select="exports[@type='macro']">
             <xsl:sort select='@symbol'/>
           </xsl:apply-templates>
         </xsl:if>
-        <h3><a name="types">Types</a></h3>
+        <h3><a id="types">Types</a></h3>
         <xsl:apply-templates select="exports[@type='typedef']">
           <xsl:sort select='@symbol'/>
         </xsl:apply-templates>
-        <h3><a name="functions">Functions</a></h3>
+        <h3><a id="functions">Functions</a></h3>
         <xsl:apply-templates select="exports[@type='function']">
           <xsl:sort select='@symbol'/>
         </xsl:apply-templates>