Changeset 99116 in vbox for trunk/doc

Timestamp:

Mar 22, 2023 1:20:35 PM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

156481

Message:

manual: Compacted the C and latex syntax diagrams a tiny bit, adding a special role=compact to arg/group to selectively make nested groups tighter too. Fixed controlvm natpf syntax.

Location:

trunk/doc/manual

Files:

• common-formatcfg.xsl (modified) (1 diff)
• docbook-refentry-to-C-help.xsl (modified) (2 diffs)
• docbook2latex.xsl (modified) (3 diffs)
• en_US/man_VBoxManage-controlvm.xml (modified) (1 diff)

trunk/doc/manual/common-formatcfg.xsl

@@ -92 +92 @@
 <xsl:variable name="arg.rep.def.str"></xsl:variable>
 <xsl:variable name="arg.or.sep"> | </xsl:variable>
+<xsl:variable name="arg.or.sep.compact">|</xsl:variable>
 <xsl:variable name="cmdsynopsis.hanging.indent">4pi</xsl:variable>
 

trunk/doc/manual/docbook-refentry-to-C-help.xsl

@@ -265 +265 @@
     <!-- separator char if we're not the first child -->
     <xsl:if test="position() > 1">
+      <!--<xsl:value-of select="concat('*',name(),'=', position(),'#')"/>-->
       <xsl:choose>
+        <xsl:when test="parent::group and ancestor::*[@role='compact']"><xsl:value-of select="$arg.or.sep.compact"/></xsl:when>
         <xsl:when test="parent::group"><xsl:value-of select="$arg.or.sep"/></xsl:when>
-        <xsl:when test="ancestor-or-self::*/@sepchar"><xsl:value-of select="ancestor-or-self::*/@sepchar"/></xsl:when>
+        <xsl:when test="parent::arg"></xsl:when>
+        <xsl:when test="ancestor::*/@sepchar"><xsl:value-of select="ancestor::*/@sepchar"/></xsl:when>
         <xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
       </xsl:choose>
@@ -301 +304 @@
         <xsl:when test="@choice = 'req'">               <xsl:value-of select="$arg.choice.req.close.str"/></xsl:when>
       </xsl:choose>
-      <!-- Add a space padding if we're the last element in a repeating arg or group -->
-      <xsl:if test="(parent::arg or parent::group) and not(following-sibiling)">
-        <xsl:text> </xsl:text>
-      </xsl:if>
     </xsl:if>
   </xsl:template>

trunk/doc/manual/docbook2latex.xsl

@@ -97 +97 @@
   <!-- command synopsis -->
   <xsl:variable name="arg.rep.repeat.str.tex">\ldots{}</xsl:variable>
+  <xsl:variable name="arg.or.sep.compact.tex">|</xsl:variable>
   <xsl:variable name="arg.or.sep.tex"> |~</xsl:variable>
 
@@ -968 +969 @@
     <xsl:if test="position() > 1">
       <xsl:choose>
+        <xsl:when test="parent::group and ancestor::*[@role='compact']"><xsl:text>\textrm{</xsl:text><xsl:value-of select="$arg.or.sep.compact.tex"/><xsl:text>}</xsl:text></xsl:when>
         <xsl:when test="parent::group"><xsl:text>\textrm{</xsl:text><xsl:value-of select="$arg.or.sep.tex"/><xsl:text>}</xsl:text></xsl:when>
-        <xsl:when test="ancestor-or-self::*/@sepchar"><xsl:value-of select="ancestor-or-self::*/@sepchar"/></xsl:when>
+        <xsl:when test="parent::arg"></xsl:when>
+        <xsl:when test="ancestor::*/@sepchar"><xsl:value-of select="ancestor::*/@sepchar"/></xsl:when>
         <xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
       </xsl:choose>
@@ -1004 +1007 @@
       <xsl:when test="@choice = 'req'">               <xsl:text>\textrm{</xsl:text><xsl:value-of select="$arg.choice.req.close.str"/><xsl:text>}</xsl:text></xsl:when>
     </xsl:choose>
-
-    <!-- add space padding if we're the last element in a nested arg -->
-    <xsl:if test="parent::arg and not(following-sibling)">
-      <xsl:text> </xsl:text>
-    </xsl:if>
   </xsl:template>
 

trunk/doc/manual/en_US/man_VBoxManage-controlvm.xml

@@ -248 +248 @@
       </group>
       <arg choice="plain">natpf<replaceable>N</replaceable></arg>
-      <group choice="req">
-        <arg choice="plain">[<replaceable>rulename</replaceable>]<arg choice="plain">,tcp</arg></arg>
-        <arg choice="plain">udp,<arg><replaceable>host-IP</replaceable></arg>,<arg choice="plain"><replaceable>hostport</replaceable>,</arg><arg><replaceable>guest-IP</replaceable></arg>,<arg choice="plain"><replaceable>guestport</replaceable></arg></arg>
-      </group>
+
+      <arg choice="req" role="compact"><arg><replaceable>rulename</replaceable></arg>,<group choice="req"><arg choice="plain">tcp</arg><arg choice="plain">udp</arg></group>,<arg><replaceable>host-IP</replaceable></arg>,<arg choice="plain"><replaceable>hostport</replaceable></arg>,<arg><replaceable>guest-IP</replaceable></arg>,<arg choice="plain"><replaceable>guestport</replaceable></arg></arg>
     </cmdsynopsis>