]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Make anchors follow HTML5
authorMichal Privoznik <mprivozn@redhat.com>
Tue, 27 Aug 2019 15:21:32 +0000 (17:21 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Wed, 28 Aug 2019 11:39:26 +0000 (13:39 +0200)
According to HTML specification, <a name=''> works in HTML4, but
<a id=''> works in both HTML4 and HTML5. This is followed even in
docs/page.xsl where HTML bookmark links are generated only for
those anchors which have @id attribute.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/api_extension.html.in
docs/dbus.html.in
docs/devhelp/html.xsl
docs/genaclperms.pl
docs/hvsupport.pl
docs/newapi.xsl

index 604c397c847d72c143ade0a4e5db2dfda2c05e27..79e7913c1a8199a8f4ff5690c3a139fb899c038b 100644 (file)
@@ -89,7 +89,7 @@
       separately.
     </p>
 
-    <h2><a name='publicapi'>Defining the public API</a></h2>
+    <h2><a id='publicapi'>Defining the public API</a></h2>
 
     <p>The first task is to define the public API.  If the new API
       involves an XML extension, you have to enhance the RelaxNG
       rework it as you go through the process of implementing it.
     </p>
 
-    <h2><a name='internalapi'>Defining the internal API</a></h2>
+    <h2><a id='internalapi'>Defining the internal API</a></h2>
 
     <p>
       Each public API call is associated with a driver, such as a host
       provide a <code>NULL</code> stub for the new function.
     </p>
 
-    <h2><a name='implpublic'>Implementing the public API</a></h2>
+    <h2><a id='implpublic'>Implementing the public API</a></h2>
 
     <p>
       Implementing the public API is largely a formality in which we wire up
 
     <p><code>src/libvirt-$MODULE.c</code></p>
 
-    <h2><a name='remoteproto'>Implementing the remote protocol</a></h2>
+    <h2><a id='remoteproto'>Implementing the remote protocol</a></h2>
 
     <p>
       Implementing the remote protocol is essentially a
       understood by referring to the existing code.
     </p>
 
-    <h3><a name='wireproto'>Defining the wire protocol format</a></h3>
+    <h3><a id='wireproto'>Defining the wire protocol format</a></h3>
 
     <p>
       Defining the wire protocol involves making additions to:
         src/remote/remote_protocol.h
     </code></p>
 
-    <h3><a name='rpcclient'>Implement the RPC client</a></h3>
+    <h3><a id='rpcclient'>Implement the RPC client</a></h3>
 
     <p>
       Implementing the RPC client uses the rpcgen generated .h files.
index 6ff71d2770b67ef4a0eba036e20045835c521a2d..4dfe4ca427e9789d71d67359f0ce21d7458ac9b6 100644 (file)
@@ -6,14 +6,14 @@
 
     <ul id="toc"></ul>
 
-    <h2><a name="description">Description</a></h2>
+    <h2><a id="description">Description</a></h2>
 
     <p>
       libvirt-dbus wraps libvirt API to provide a high-level object-oriented
       API better suited for dbus-based applications.
     </p>
 
-    <h2><a name="git">GIT source repository</a></h2>
+    <h2><a id="git">GIT source repository</a></h2>
     <p>
       The D-Bus bindings source code is maintained in a
       <a href="https://git-scm.com/">git</a> repository available on
@@ -32,7 +32,7 @@ git clone https://libvirt.org/git/libvirt-dbus.git
 <a href="https://libvirt.org/git/?p=libvirt-dbus.git">https://libvirt.org/git/?p=libvirt-dbus.git</a>
 </pre>
 
-    <h2><a name="usage">Usage</a></h2>
+    <h2><a id="usage">Usage</a></h2>
 
     <p>
       libvirt-dbus exports libvirt API using D-Bus objects with methods and
index 9cdc049150ffc3e7ef141c33670148b95702bece..587cbfc1a98c96f39f6d5f50c94a134c4ccc2b26 100644 (file)
   <xsl:template mode="details" match="struct">
     <xsl:variable name="name" select="string(@name)"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}">Structure </a><xsl:value-of select="$name"/></h3>
+    <h3><a id="{$name}">Structure </a><xsl:value-of select="$name"/></h3>
     <pre class="programlisting">
     <xsl:value-of select="@type"/><xsl:text> {
 </xsl:text>
   <xsl:template mode="details" match="typedef[@type != 'enum']">
     <xsl:variable name="name" select="string(@name)"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}">Typedef </a><xsl:value-of select="$name"/></h3>
+    <h3><a id="{$name}">Typedef </a><xsl:value-of select="$name"/></h3>
     <pre class="programlisting">
     <xsl:call-template name="dumptext">
       <xsl:with-param name="text" select="string(@type)"/>
   <xsl:template mode="details" match="variable">
     <xsl:variable name="name" select="string(@name)"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}">Variable </a><xsl:value-of select="$name"/></h3>
+    <h3><a id="{$name}">Variable </a><xsl:value-of select="$name"/></h3>
     <pre class="programlisting">
     <xsl:call-template name="dumptext">
       <xsl:with-param name="text" select="string(@type)"/>
   <xsl:template mode="details" match="typedef[@type = 'enum']">
     <xsl:variable name="name" select="string(@name)"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}">Enum </a><xsl:value-of select="$name"/></h3>
+    <h3><a id="{$name}">Enum </a><xsl:value-of select="$name"/></h3>
     <pre class="programlisting">
     <xsl:text>enum </xsl:text>
     <a href="#{$name}"><xsl:value-of select="$name"/></a>
     <xsl:for-each select="/api/symbols/enum[@type=$name]">
       <xsl:sort select="@value" data-type="number" order="ascending"/>
       <xsl:text>    </xsl:text>
-      <a name="{@name}"><xsl:value-of select="@name"/></a>
+      <a id="{@name}"><xsl:value-of select="@name"/></a>
       <xsl:if test="@value">
         <xsl:text> = </xsl:text>
        <xsl:value-of select="@value"/>
   <xsl:template mode="details" match="macro">
     <xsl:variable name="name" select="string(@name)"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}">Macro </a><xsl:value-of select="$name"/></h3>
+    <h3><a id="{$name}">Macro </a><xsl:value-of select="$name"/></h3>
     <pre class="programlisting">
     <xsl:text>#define </xsl:text>
     <a href="#{$name}"><xsl:value-of select="$name"/></a>
     <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))"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}"></a><xsl:value-of select="$name"/> ()</h3>
+    <h3><a id="{$name}"></a><xsl:value-of select="$name"/> ()</h3>
     <pre class="programlisting">
     <xsl:call-template name="dumptext">
       <xsl:with-param name="text" select="return/@type"/>
     <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))"/>
     <div class="refsect2" lang="en">
-    <h3><a name="{$name}"></a>Function type <xsl:value-of select="$name"/> </h3>
+    <h3><a id="{$name}"></a>Function type <xsl:value-of select="$name"/> </h3>
     <pre class="programlisting">
     <xsl:call-template name="dumptext">
       <xsl:with-param name="text" select="return/@type"/>
index 34c526021c5e5f14088bfb44d177e6d11a9a8c0d..e20b4c11c389ccc051fceeec1026111aa8ca7ffc 100755 (executable)
@@ -84,7 +84,7 @@ foreach my $object (sort { $a cmp $b } keys %perms) {
     my $class = $class{$object};
     my $olink = lc "object_" . $object;
     print <<EOF;
-<h3><a name="$olink">$class</a></h3>
+<h3><a id="$olink">$class</a></h3>
 <table class="acl">
   <thead>
     <tr>
@@ -106,7 +106,7 @@ EOF
 
         print <<EOF;
     <tr>
-      <td><a name="$plink">$perm</a></td>
+      <td><a id="$plink">$perm</a></td>
       <td>$description</td>
     </tr>
 EOF
index 4f4d86fbf12c5c3aecdb50cc17fae64fea253ba1..494b8a27ecfb91af8b9f85e9d101fd593db01aae 100755 (executable)
@@ -364,7 +364,7 @@ when it was removed is also mentioned (highlighted in
 EOF
 
     foreach my $grp (sort { $a cmp $b } keys %groups) {
-    print "<h2><a name=\"$grp\">", $groupheaders{$grp}, "</a></h2>\n";
+    print "<h2><a id=\"$grp\">", $groupheaders{$grp}, "</a></h2>\n";
     print <<EOF;
 <table class="top_table">
 <thead>
index 4c7b241659e7fe1ae02eba990f60fd773c7cddcc..ca8c703d5ce69ceef9afe5e72eea8448b5f9dd90 100644 (file)
       </xsl:call-template>
     </span>
     <xsl:text> </xsl:text>
-    <a name="{@name}"></a>
+    <a id="{@name}"></a>
     <xsl:value-of select="@name"/>
     <xsl:text>
 </xsl:text>
           </xsl:call-template>
         </span>
        <xsl:text> </xsl:text>
-       <a name="{$name}"><xsl:value-of select="$name"/></a>
+       <a id="{$name}"><xsl:value-of select="$name"/></a>
        <xsl:text>
 </xsl:text>
       </xsl:otherwise>
         <xsl:for-each select="/api/symbols/enum[@type = $name]">
           <xsl:sort select="@value" data-type="number" order="ascending"/>
           <tr>
-            <td><a name="{@name}"><xsl:value-of select="@name"/></a></td>
+            <td><a id="{@name}"><xsl:value-of select="@name"/></a></td>
             <td><xsl:text> = </xsl:text></td>
             <xsl:choose>
               <xsl:when test="@info != ''">