Introduce id's and linkends

* Introduce id's for <deliverable>, <product>, <docset>
* Add idabbrev in transformation map. This is to abbreviate
  long product IDs to make it more readable for <deliverable> id's.
* Introduce id.sep parameter
* Don't copy PIs for product and docset
* Convert old ids into new "id":
  * productid -> id
  * setid -> id
* Rewrite <ref .../> into one single reference: <ref linkend="..."/>
* Create generate.id:
  abbrev-product-id [+ $id.sep + docset [+ $id.sep + dc.lowercase]?]?
* The ID values for a deliverable ID are generated by

Author: tomschr

src/docbuild/config/xml/data/convert-v6-to-v7.xsl

@@ -52,10 +52,15 @@
   <!-- Set the schemaversion attribute in the output XML -->
   <xsl:param name="schemaversion">7.0</xsl:param>
 
+  <!-- ID separator for autogenerated IDs -->
+  <xsl:param name="id.sep">.</xsl:param>
+
+
 <!-- ======== Keys -->
   <!-- Define a key to group <language> elements by their @lang attribute -->
   <xsl:key name="langKey" match="category/language[not(ancestor-or-self::product)]" use="@lang" />
 
+
 <!-- ======== Variables -->
   <xsl:variable name="_transformation-map">
     <!--
@@ -65,21 +70,22 @@
       * family (str): the product family that this product belongs
       * rank (int): The product rank that influences the tiles on the portal homepage
       * externals (bool): Convert external links into <deliverable> and <prebuilt> elements
+      * idabbrev (str): The product ID abbreviation used in <deliverable id="...">
     -->
     <config>
-      <product id="appliance" series="pas" family="linux" rank="04150" />
-      <product id="cloudnative" series="pas" family="cn" rank="00030" />
-      <product id="container" series="pas" family="linux" rank="04130" externals="1" />
-      <product id="compliance" series="pas" family="linux" rank="" />
-      <product id="liberty" series="pas" family="linux" rank="00060" />
-      <product id="releasenotes" series="rn" family="linux" />
+      <product id="appliance" series="pas" family="linux" rank="04150" idabbrev="app"/>
+      <product id="cloudnative" series="pas" family="cn" rank="00030" idabbrev="cn" />
+      <product id="container" series="pas" family="linux" rank="04130" externals="1" idabbrev="cont" />
+      <product id="compliance" series="pas" family="linux" rank="" idabbrev="comp" />
+      <product id="liberty" series="pas" family="linux" rank="00060" idabbrev="lib" />
+      <product id="releasenotes" series="rn" family="linux" idabbrev="rn"/>
       <product id="sbp" series="sbp" family="linux" />
       <product id="ses" series="pas" family="linux" rank="04160" />
       <product id="sled" series="pas" family="linux" rank="04100" />
       <product id="sle-ha" series="pas" family="linux" rank="04070" />
       <product id="sle-hpc" series="pas" family="linux" rank="04110" />
       <product id="sle-micro" series="pas" family="linux" rank="00020" />
-      <product id="sle-public-cloud" series="pas" family="linux" rank="04060" />
+      <product id="sle-public-cloud" series="pas" family="linux" rank="04060" idabbrev="spc" />
       <product id="sle-rt" series="pas" family="linux" rank="04080" />
       <product id="sles-sap" series="pas" family="linux" rank="00050" />
       <product id="sles" series="pas" family="linux" rank="00080" />
@@ -88,13 +94,13 @@
       <product id="smt" series="pas" family="linux" rank="04330" />
       <product id="soc" series="pas" family="linux" rank="04300" />
       <product id="style" series="pas" family="linux" />
-      <product id="subscription" series="pas" family="linux" rank="04140" />
+      <product id="subscription" series="pas" family="linux" rank="04140" idabbrev="sub" />
       <product id="suma" series="pas" family="linux" rank="" externals="1" />
       <product id="suma-retail" series="pas" family="linux" externals="1" />
       <product id="suma-ai" series="pas" family="suse-ai" rank="00010" />
       <product id="suma-caasp" series="pas" family="linux" rank="04310" />
       <product id="suma-cap" series="pas" family="linux" rank="04320"/>
-      <product id="suma-distribution-migration-system" series="pas" family="linux" />
+      <product id="suma-distribution-migration-system" series="pas" family="linux" idabbrev="suma-dms" />
       <product id="suma-edge" series="pas" family="suse-edge" rank="00040" />
       <product id="trd" series="trd" family="linux" />
     </config>
@@ -218,6 +224,24 @@
     </xsl:if>
   </xsl:template>
 
+  <xsl:template name="generate.id">
+    <xsl:param name="product.idabbrev"/>
+    <xsl:param name="docset"/>
+    <xsl:param name="dc"/>
+
+    <xsl:value-of select="$product.idabbrev"/>
+
+    <xsl:if test="string($docset)">
+      <xsl:value-of select="$id.sep"/>
+      <xsl:value-of select="$docset"/>
+    </xsl:if>
+
+    <xsl:if test="string($dc)">
+      <xsl:value-of select="$id.sep"/>
+      <xsl:value-of select="translate($dc, &uppercase;, &lowercase;)"/>
+    </xsl:if>
+  </xsl:template>
+
 
 <!-- ======== General Templates -->
   <xsl:template match="node() | @*" name="copy">
@@ -303,6 +327,18 @@
   </xsl:template>
 
   <!-- Product  -->
+  <!-- don't copy these attributes -->
+  <xsl:template match="product/processing-instruction()" />
+  <xsl:template match="product/@schemaversion" />
+  <xsl:template match="product/@site-section" />
+
+  <xsl:template match="product/@productid">
+    <xsl:variable name="id" select="." />
+    <xsl:attribute name="id">
+      <xsl:value-of select="$id" />
+    </xsl:attribute>
+  </xsl:template>
+
   <xsl:template match="product">
     <xsl:variable name="id" select="@productid" />
     <xsl:variable name="cnfg" select="$config/product[@id=$id]" />
@@ -369,15 +405,25 @@
   <!-- We ignore the product/category as this was moved to portal/categories -->
   <xsl:template match="product/category" />
 
+  <xsl:template match="product/@productid">
+    <xsl:attribute name="id">
+      <xsl:value-of select="."/>
+    </xsl:attribute>
+  </xsl:template>
+
   <!-- Docset -->
+  <xsl:template match="docset/@schemaversion" />
+  <xsl:template match="docset/processing-instruction()" />
+
   <xsl:template match="docset">
      <xsl:variable name="id" select="ancestor::product/@productid"/>
      <xsl:variable name="ver" select="@setid"/>
      <xsl:variable name="subpath" select="concat($id, '/', $ver, '.xml')"/>
 
-
      <xsl:variable name="content">
-        <xsl:apply-templates select="." mode="render"/>
+        <docset xmlns:xi="http://www.w3.org/2001/XInclude">
+           <xsl:apply-templates select="@*|node()" />
+        </docset>
      </xsl:variable>
 
      <xsl:call-template name="write.chunk">
@@ -387,32 +433,14 @@
      </xsl:call-template>
   </xsl:template>
 
-  <xsl:template match="docset" mode="render">
-     <xsl:copy>
-        <xsl:apply-templates select="node()|@*"/>
-     </xsl:copy>
-  </xsl:template>
-
-  <!-- don't copy these attributes -->
-  <xsl:template match="product/@schemaversion" />
-  <xsl:template match="product/@site-section" />
-
-  <xsl:template match="product/@productid">
-    <xsl:variable name="id" select="." />
+q  <xsl:template match="docset/@setid">
     <xsl:attribute name="id">
-      <xsl:value-of select="$id" />
+      <xsl:value-of select="concat(ancestor::product/@productid, $id.sep, .)" />
     </xsl:attribute>
-  </xsl:template>
-
-
-  <!--<xsl:template match="docset/@setid">
-    <xsl:variable name="id" select="." />
-    <xsl:attribute name="id">
-      <xsl:value-of select="$id"/>
+    <xsl:attribute name="path">
+      <xsl:value-of select="."/>
     </xsl:attribute>
-  </xsl:template>-->
-
-  <xsl:template match="docset/@schemaversion" />
+  </xsl:template>
 
   <xsl:template match="docset/overridedesc">
     <descriptions>
@@ -428,43 +456,91 @@
   </xsl:template>
 
   <xsl:template match="docset/builddocs/language">
+    <xsl:variable name="pid" select="ancestor::product/@productid"/>
+    <xsl:variable name="do_externals" select="$config[@id=$pid]/@externals"/>
+    <xsl:variable name="current_lang" select="@lang"/>
+
     <locale>
       <xsl:copy-of select="@lang" /><!-- no default attribute -->
       <xsl:apply-templates />
+
+      <xsl:if test="$do_externals">
+         <xsl:apply-templates select="../../external/link[language[@lang = $current_lang]]" mode="convert-to-prebuilt">
+            <xsl:with-param name="lang" select="$current_lang"/>
+         </xsl:apply-templates>
+      </xsl:if>
     </locale>
   </xsl:template>
 
 
   <!-- deliverable -->
-  <xsl:template match="deliverable">
-    <xsl:copy>
+  <xsl:template match="language[@lang='en-us']/deliverable">
+    <xsl:variable name="pid" select="ancestor::product/@productid"/>
+    <xsl:variable name="abbrev" select="$config/product[@id=$pid]/@idabbrev"/>
+    <xsl:variable name="product.idabbrev" select="$abbrev | $pid[not($abbrev)]"/>
+    <xsl:variable name="id">
+      <xsl:call-template name="generate.id">
+        <xsl:with-param name="product.idabbrev" select="$product.idabbrev"/>
+        <xsl:with-param name="docset" select="ancestor::docset/@setid"/>
+        <xsl:with-param name="dc" select="dc"/>
+      </xsl:call-template>
+    </xsl:variable>
+
+    <deliverable id="{$id}" type="dc">
       <xsl:copy-of select="@*"/>
-      <xsl:if test="../language/@lang='en-us'">
-        <!-- Add id attribute only for English to keep it unique -->
-        <xsl:attribute name="id">
-          <xsl:value-of select=" substring-after(translate(dc, &uppercase;, &lowercase;), 'dc-')"/>
-        </xsl:attribute>
-      </xsl:if>
-      <xsl:attribute name="type">dc</xsl:attribute>
       <xsl:apply-templates />
-    </xsl:copy>
+    </deliverable>
   </xsl:template>
 
   <!-- ref  -->
   <xsl:template match="ref">
-    <ref>
-      <xsl:copy-of select="@product|@docset|@category|@titleformat|@subdeliverable"/>
-      <xsl:if test="@dc">
-        <xsl:attribute name="deliverable">
-            <xsl:value-of select="@dc" />
-        </xsl:attribute>
-      </xsl:if>
+    <xsl:variable name="pid" select="@product"/>
+    <xsl:variable name="cnfg" select="$config/product[@id=$pid]"/>
+    <xsl:variable name="abbrev" select="$cnfg/@idabbrev"/>
+    <xsl:variable name="product.idabbrev" select="$abbrev | $pid[not($abbrev)]"/>
+    <xsl:variable name="ref" >
+      <xsl:choose>
+        <xsl:when test="not(@docset) and not(@dc)">
+          <xsl:call-template name="generate.id">
+            <xsl:with-param name="product.idabbrev" select="$product.idabbrev"/>
+          </xsl:call-template>
+        </xsl:when>
+        <xsl:when test="@product and @docset and not(@dc)">
+          <xsl:call-template name="generate.id">
+            <xsl:with-param name="product.idabbrev" select="$product.idabbrev"/>
+            <xsl:with-param name="docset" select="@docset"/>
+          </xsl:call-template>
+        </xsl:when>
+        <xsl:when test="@product and @docset and @dc">
+          <xsl:call-template name="generate.id">
+            <xsl:with-param name="product.idabbrev" select="$product.idabbrev"/>
+            <xsl:with-param name="docset" select="@docset"/>
+            <xsl:with-param name="dc" select="@dc"/>
+          </xsl:call-template>
+        </xsl:when>
+        <xsl:when test="@deliverable">
+          <xsl:value-of select="concat(@product, $id.sep, @docset, $id.sep, @deliverable)"/>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:message>WARN: Couldn't create a linkend for &lt;ref <xsl:for-each select="@*">
+              <xsl:value-of select="concat(local-name(.), '=&quot;', ., '&quot; ')"/>
+          </xsl:for-each>
+          <xsl:text>/&gt;</xsl:text>
+          </xsl:message>
+        </xsl:otherwise>
+      </xsl:choose>
+    </xsl:variable>
+    <!--<xsl:message>ref: <xsl:value-of select="count($cnfg)"/>
+      product=<xsl:value-of select="concat(@product, '::', $pid)"/>
+      idabbrev=<xsl:value-of select="$abbrev"/>
+    </xsl:message>-->
+    <ref linkend="{$ref}">
+      <xsl:copy-of select="@category|@titleformat"/>
     </ref>
   </xsl:template>
 
 
   <!-- desc -->
   <xsl:template match="desc/@default" />
 
-
 </xsl:stylesheet>