File 3726-docgen-Start-using-article-and-section-to-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 3726-docgen-Start-using-article-and-section-to-wrap-conte.patch of Package erlang

From 26d7ddae175ef686e25ef2447506a91d198ea91f Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Wed, 1 Sep 2021 17:58:34 +0200
Subject: [PATCH 06/12] docgen: Start using <article> and <section> to wrap
 content

This is done in order for web crawlers to better be
able to crawl the erlang documentation.
---
 lib/erl_docgen/priv/xsl/db_html.xsl | 106 +++++++++++++++-------------
 1 file changed, 55 insertions(+), 51 deletions(-)

diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl
index 4137173dbb..c9d386db6e 100644
--- a/lib/erl_docgen/priv/xsl/db_html.xsl
+++ b/lib/erl_docgen/priv/xsl/db_html.xsl
@@ -487,7 +487,7 @@
 
   
   <xsl:template match="datatype">
-    <div class="data-types-body">
+    <article class="data-types-body">
       <xsl:choose>
         <xsl:when test="string-length(name/@name) > 0">
           <xsl:variable name="apostrophe">'</xsl:variable>
@@ -524,7 +524,7 @@
         </xsl:otherwise>
       </xsl:choose>
       <div class="data-type-desc"><xsl:apply-templates select="desc"/></div>
-    </div>
+    </article>
   </xsl:template>
 
   
   <xsl:template match="erlref/section|cref/section|comref/section|fileref/section|appref/section|funcs/fsdescription">
     <xsl:param name="chapnum"/>
-    <div class="innertube">
-    <h3>
-      <xsl:for-each select="marker">
-	<xsl:call-template name="marker-before-title"/>
-      </xsl:for-each>
-      <xsl:call-template name="title_link">
-        <xsl:with-param name="title">
-          <xsl:value-of select="title"/>
-        </xsl:with-param>
-      </xsl:call-template>
-    </h3>
-    <div class="REFBODY rb-3">
-    <xsl:apply-templates>
-      <xsl:with-param name="chapnum" select="$chapnum"/>
-    </xsl:apply-templates>
-    </div>
-    </div>
+    <section class="innertube">
+      <h3>
+        <xsl:for-each select="marker">
+	  <xsl:call-template name="marker-before-title"/>
+        </xsl:for-each>
+        <xsl:call-template name="title_link">
+          <xsl:with-param name="title">
+            <xsl:value-of select="title"/>
+          </xsl:with-param>
+        </xsl:call-template>
+      </h3>
+      <div class="REFBODY rb-3">
+        <xsl:apply-templates>
+          <xsl:with-param name="chapnum" select="$chapnum"/>
+        </xsl:apply-templates>
+      </div>
+    </section>
   </xsl:template>
 
   
   <xsl:template match="erlref/section/section|cref/section/section|comref/section/section|fileref/section/section|appref/section/section">
     <xsl:param name="chapnum"/>
     <xsl:param name="sectnum"/>
-    <h4>
-      <xsl:value-of select="title"/>
-    </h4>
-    <div class="REFBODY rb-4">
-    <xsl:apply-templates>
-      <xsl:with-param name="chapnum" select="$chapnum"/>
-    </xsl:apply-templates>
-    </div>
+    <section>
+      <h4>
+        <xsl:value-of select="title"/>
+      </h4>
+      <div class="REFBODY rb-4">
+        <xsl:apply-templates>
+          <xsl:with-param name="chapnum" select="$chapnum"/>
+        </xsl:apply-templates>
+      </div>
+    </section>
   </xsl:template>
 
 
@@ -2264,18 +2266,20 @@
   <xsl:template match="description">
     <xsl:param name="partnum"/>
 
-    <div class="innertube">
-    <xsl:call-template name="h3_title_link">
-      <xsl:with-param name="title">Description</xsl:with-param>
-    </xsl:call-template>
-    <div class="REFBODY description-body">
-      <p>
-        <xsl:apply-templates>
-          <xsl:with-param name="partnum" select="$partnum"/>
-        </xsl:apply-templates>
-      </p>
-    </div>
-    </div>
+    <section class="description">
+      <div class="innertube">
+        <xsl:call-template name="h3_title_link">
+          <xsl:with-param name="title">Description</xsl:with-param>
+        </xsl:call-template>
+        <div class="REFBODY description-body">
+          <p>
+            <xsl:apply-templates>
+              <xsl:with-param name="partnum" select="$partnum"/>
+            </xsl:apply-templates>
+          </p>
+        </div>
+      </div>
+    </section>
   </xsl:template>
 
   
@@ -2303,18 +2307,18 @@
   
   <xsl:template match="func">
     <xsl:param name="partnum"/>
-
-    <xsl:apply-templates select="name"/>
-    <xsl:apply-templates
-        select="name[string-length(@arity) > 0 and position()=last()]"
-        mode="types"/>
-
-    <div class="exports-tube">
-    <xsl:apply-templates select="fsummary|type|desc">
-      <xsl:with-param name="partnum" select="$partnum"/>
-    </xsl:apply-templates>
-    </div>
-
+    <article class="func">
+      <xsl:apply-templates select="name"/>
+      <xsl:apply-templates
+          select="name[string-length(@arity) > 0 and position()=last()]"
+          mode="types"/>
+
+      <div class="exports-tube">
+        <xsl:apply-templates select="fsummary|type|desc">
+          <xsl:with-param name="partnum" select="$partnum"/>
+        </xsl:apply-templates>
+      </div>
+    </article>
   </xsl:template>
 
   <xsl:template match="name">
-- 
2.31.1

Places

File 3726-docgen-Start-using-article-and-section-to-wrap-conte.patch of Package erlang

Places