X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Fmanpage.xsl;h=67dff76513b2529cfc4104cb692f59257fca9db7;hb=HEAD;hp=d576e1406b7aae13b8ff9d094a024e5867618c1d;hpb=360c4f63da21d6d5518a381aa78441d4b72da446;p=lttng-tools.git

diff --git a/doc/man/manpage.xsl b/doc/man/manpage.xsl
index d576e1406..67dff7651 100644
--- a/doc/man/manpage.xsl
+++ b/doc/man/manpage.xsl
@@ -1,7 +1,7 @@
 <?xml version='1.0'?>
 <xsl:stylesheet version="1.0"
                 xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
-    <!-- callouts -->
+    <!-- Callouts -->
     <xsl:template match="*[local-name() = 'co']">
         <xsl:value-of select="concat('\','fB(',substring-after(@id,'-'),')','\','fR')"/>
     </xsl:template>
@@ -18,21 +18,138 @@
         <xsl:text>br&#10;</xsl:text>
     </xsl:template>
 
-    <!-- links -->
+    <!-- Links -->
     <xsl:template match="*[local-name() = 'ulink']">
         <xsl:apply-templates/><xsl:text> &lt;</xsl:text><xsl:value-of select="@url"/><xsl:text>&gt;</xsl:text>
     </xsl:template>
-    <xsl:template match="*[local-name() = 'link']">
-        <xsl:text>\fI</xsl:text><xsl:apply-templates/><xsl:text>\fR</xsl:text>
-    </xsl:template>
 
-    <!-- literal -->
+    <!-- Literal -->
     <xsl:template match="*[local-name() = 'literal']">
         <xsl:text>\fB</xsl:text>
         <xsl:value-of select="." />
         <xsl:text>\fR</xsl:text>
     </xsl:template>
 
-    <!-- disable end notes -->
+    <!--
+        Make admonitions look like this:
+
+            Some paragraph.
+
+            Note
+                Sit sed culpa elit dolore esse irure dolor amet magna
+                veniam elit ut.
+
+                Duis adipisicing magna quis in in in reprehenderit
+                proident minim cupidatat dolore sit minim deserunt duis dolore ex ea.
+
+            Next paragraph.
+
+        instead of:
+
+            Some paragraph.
+
+                Note
+                Sit sed culpa elit dolore esse irure dolor amet magna
+                veniam elit ut.
+
+                Duis adipisicing magna quis in in in reprehenderit
+                proident minim cupidatat dolore sit minim deserunt duis
+                dolore ex ea.
+
+            Next paragraph.
+
+        This looks better when, for example, you put a note immediately
+        after a list:
+
+        Ambiguous:
+            •   Some list item.
+
+            •   Some other list item.
+
+                Note
+                Does this note apply to the last list item or to the
+                previous block?
+
+        Clear:
+            •   Some list item.
+
+            •   Some other list item.
+
+            Note
+                This note applies to the previous block.
+    -->
+    <xsl:template match="caution|important|note|tip|warning">
+        <xsl:call-template name="roff-if-start">
+            <xsl:with-param name="condition">n</xsl:with-param>
+        </xsl:call-template>
+        <xsl:text>.sp&#10;</xsl:text>
+        <xsl:call-template name="roff-if-end"/>
+        <xsl:if test="not($man.output.better.ps.enabled = 0)">
+            <xsl:text>.BM yellow&#10;</xsl:text>
+        </xsl:if>
+        <xsl:call-template name="pinch.together"/>
+        <xsl:text>.ps +1&#10;</xsl:text>
+        <xsl:call-template name="make.bold.title"/>
+        <xsl:text>.ps -1&#10;</xsl:text>
+        <xsl:text>.br&#10;</xsl:text>
+        <xsl:text>.RS 4&#10;</xsl:text>
+        <xsl:apply-templates/>
+        <xsl:text>.sp .5v&#10;</xsl:text>
+        <xsl:if test="not($man.output.better.ps.enabled = 0)">
+            <xsl:text>.EM yellow&#10;</xsl:text>
+        </xsl:if>
+        <xsl:text>.RE&#10;</xsl:text>
+    </xsl:template>
+
+    <!-- Disable end notes -->
     <xsl:param name="man.endnotes.are.numbered">0</xsl:param>
+
+    <!-- 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>