Changeset 99160 in vbox for trunk/doc

Timestamp:

Mar 24, 2023 12:27:52 AM (21 months ago)

Author:

vboxsync

Message:

manual: More work on the refentry to dita converter - sbr trouble and paragraph hack between syntaxdiagrams. bugref:10302

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (1 diff)
• docbook-refentry-to-manual-dita.xsl (modified) (3 diffs)

trunk/doc/manual/Makefile.kmk

@@ -733 +733 @@
                 "/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
                 "/transtype:pdf" \
-                "/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
+                "/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
                 "/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
                 "/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf", \

trunk/doc/manual/docbook-refentry-to-manual-dita.xsl

@@ -250 +250 @@
     <xsl:apply-templates />
   </xsl:element>
+
+  <!-- HACK ALERT! Add an empty paragraph to keep syntax diagrams apart in the
+       PDF output, otherwise the commands becomes hard to tell apart. -->
+  <xsl:if test="position() &lt; last()">
+    <xsl:element name="p">
+      <xsl:attribute name="platform">ohc</xsl:attribute> <!-- 'och', so it gets filtered out from the html(help) docs. -->
+      <xsl:attribute name="rev">pdf space hack</xsl:attribute>
+      <xsl:text> </xsl:text>
+    </xsl:element>
+  </xsl:if>
 </xsl:template>
 
@@ -260 +270 @@
     <xsl:for-each select="sbr">
       <xsl:variable name="idxSbr" select="position()"/>
-      <xsl:element name="groupcomp">
-        <xsl:attribute name="rev">sbr/<xsl:value-of select="position()"/></xsl:attribute>
+      <!-- TODO: sbr cannot be translated, it seems. Whether we wrap things in
+           synblk, groupcomp or groupseq elements, the result is always the same:
+              - HTML: ignored.
+              - PDF: condensed arguments w/o spaces between  -->
+      <!-- <xsl:element name="synblk">
+        <xsl:attribute name="rev">sbr/<xsl:value-of select="position()"/></xsl:attribute> -->
 
         <xsl:if test="$idxSbr = 1">
@@ -270 +284 @@
                                                                  =     count(../sbr[$idxSbr - 1]/following-sibling::node())]"/>
         </xsl:if>
+      <!-- </xsl:element> -->
+      <!-- Ensure some space between these.-->
+      <xsl:text>
+ </xsl:text>
         <xsl:if test="$idxSbr = last()">
-          <xsl:apply-templates select="following-sibling::node()"/>
+          <!-- <xsl:element name="synblk">
+            <xsl:attribute name="rev">sbr/<xsl:value-of select="position()"/></xsl:attribute> -->
+            <xsl:apply-templates select="following-sibling::node()"/>
+          <!-- </xsl:element> -->
         </xsl:if>
-      </xsl:element>
     </xsl:for-each>
   </xsl:element>
+
+  <!-- HACK ALERT! Add an empty paragraph to keep syntax diagrams apart in the
+       PDF output, otherwise the commands becomes hard to tell apart. -->
+  <xsl:if test="position() &lt; last()">
+    <xsl:element name="p">
+      <xsl:attribute name="platform">ohc</xsl:attribute> <!-- 'och', so it gets filtered out from the html(help) docs. -->
+      <xsl:attribute name="rev">pdf space hack</xsl:attribute>
+      <xsl:text> </xsl:text>
+    </xsl:element>
+  </xsl:if>
 </xsl:template>