From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Thu, 6 May 2021 19:09:58 +0000 (-0400)
Subject: doc/man/manpage.xsl: indent the body of formal (example) blocks
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=61d3ad9f53733325286710f47dbc0dbd5a8282ca

doc/man/manpage.xsl: indent the body of formal (example) blocks

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I184b1bc54728cf0d770bc44f9f0923b9f8724396
---

diff --git a/doc/man/manpage.xsl b/doc/man/manpage.xsl
index 5f6a39642..b8f726848 100644
--- a/doc/man/manpage.xsl
+++ b/doc/man/manpage.xsl
@@ -109,4 +109,50 @@
 
     <!-- Disable hyphenation, except for URLs -->
     <xsl:param name="man.hyphenate">0</xsl:param>
+
+    <!--
+        Mainly for example blocks: indent the whole example after
+        the title, like this:
+
+            Example 1. Do something
+
+                Amet consectetur adipisicing minim sunt ad dolore culpa
+                enim labore incididunt cillum exercitation non non
+                deserunt veniam consectetur sint.
+
+                    $ lttng something
+
+                Voluptate aliquip.
+
+        instead of:
+
+            Example 1. Do something
+
+            Amet consectetur adipisicing minim sunt ad dolore culpa
+            enim labore incididunt cillum exercitation non non
+            deserunt veniam consectetur sint.
+
+                $ lttng something
+
+            Voluptate aliquip.
+    -->
+    <xsl:template name="formal.object">
+        <xsl:param name="placement" select="'before'"/>
+        <xsl:param name="class" select="local-name(.)"/>
+
+        <xsl:choose>
+            <xsl:when test="$placement = 'before'">
+                <xsl:call-template name="formal.object.heading"/>
+                <xsl:text>.RS 4&#10;</xsl:text>
+                <xsl:apply-templates/>
+                <xsl:text>.RE&#10;</xsl:text>
+            </xsl:when>
+            <xsl:otherwise>
+                <xsl:text>.RS 4&#10;</xsl:text>
+                <xsl:apply-templates/>
+                <xsl:text>.RE&#10;</xsl:text>
+                <xsl:call-template name="formal.object.heading"/>
+            </xsl:otherwise>
+        </xsl:choose>
+    </xsl:template>
 </xsl:stylesheet>