From 81014e5cb46166183723ae911f6968e56b403107 Mon Sep 17 00:00:00 2001
From: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Wed, 14 Apr 2021 15:51:02 -0300
Subject: Fix sort command in Help pages

After the introduction of the headings h1 ... h6  in the Help
pages the sort command broke. It relied only in the <paragraph>
tag for sorting, usually the first paragraph in the section.

The patch extend the DTD to handle the new descendant="" attribute
to select which tag to sort in the Help page

Default is <paragraph> for backward compatibility.

Pages with <sort> must be revisited.

Change-Id: I3c6f243369429ed7824a68b11757dc15f4555c0f
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/114110
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
---
 help3xsl/online_transform.xsl | 59 ++++++++++++++++++++++++++++++++++++++++---
 helpers/xmlhelp.dtd           |  1 +
 2 files changed, 56 insertions(+), 4 deletions(-)

diff --git a/help3xsl/online_transform.xsl b/help3xsl/online_transform.xsl
index c6e2ee1bbc..d30add9d93 100644
--- a/help3xsl/online_transform.xsl
+++ b/help3xsl/online_transform.xsl
@@ -589,20 +589,71 @@
 <xsl:template match="sort" >
     <xsl:variable name="order1">
         <xsl:choose>
-            <xsl:when test="string-length(@order) = 0"><xsl:value-of  select="'ascending'"/></xsl:when>
+            <xsl:when test="string-length(@order) = 0"><xsl:value-of select="'ascending'"/></xsl:when>
             <xsl:otherwise><xsl:value-of select="concat(@order,'ending')"/></xsl:otherwise>
         </xsl:choose>
     </xsl:variable>
-    <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+    <xsl:choose>
+        <xsl:when test="string-length(@descendant)=0">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h1'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h1"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h2'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h2"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h3'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h3"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h4'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h4"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h5'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h5"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h6'">
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h6"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+        </xsl:otherwise>
+    </xsl:choose>
 </xsl:template>
 <xsl:template match="sort" mode="embedded">
     <xsl:variable name="order1">
         <xsl:choose>
-            <xsl:when test="string-length(@order) = 0"><xsl:value-of  select="'ascending'"/></xsl:when>
+            <xsl:when test="string-length(@order) = 0"><xsl:value-of select="'ascending'"/></xsl:when>
             <xsl:otherwise><xsl:value-of select="concat(@order,'ending')"/></xsl:otherwise>
         </xsl:choose>
     </xsl:variable>
-    <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+    <xsl:choose>
+        <xsl:when test="string-length(@descendant)=0">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h1'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h1"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h2'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h2"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h3'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h3"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h4'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h4"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h5'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h5"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:when test="@descendant='h6'">
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::h6"/></xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+        <xsl:apply-templates><xsl:sort order="{$order1}" select="descendant::paragraph"/></xsl:apply-templates>
+        </xsl:otherwise>
+    </xsl:choose>
+
 </xsl:template>
 
 <!-- SWITCH -->
diff --git a/helpers/xmlhelp.dtd b/helpers/xmlhelp.dtd
index 488e7286f8..6a4ef9778b 100644
--- a/helpers/xmlhelp.dtd
+++ b/helpers/xmlhelp.dtd
@@ -215,6 +215,7 @@ Version Nov 2018
 <!ELEMENT sort (section+)>
 <!ATTLIST sort
   order (asc | desc) #IMPLIED
+  descendant (paragraph | h1 | h2 | h3 | h4 | h5 | h6 ) #IMPLIED
 >
 
 <!ELEMENT switch ((case | comment)* | default?)*>
-- 
cgit