LUDOC-104: Design elements to highlight lustre specific features.

[doc/manual.git] / style / customstyle_fo.xsl

diff --git a/style/customstyle_fo.xsl b/style/customstyle_fo.xsl
new file mode 100644 (file)
index 0000000..aeee0c0
--- /dev/null
+++ b/style/customstyle_fo.xsl
@@ -0,0 +1,122 @@
+<?xml version='1.0'?>
+<xsl:stylesheet  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+       xmlns:fo="http://www.w3.org/1999/XSL/Format"
+       xmlns:d="http://docbook.org/ns/docbook"
+       exclude-result-prefixes="d"
+       version="1.0" >
+<!-- xsl:import takes place at compile time. For this reason, I sed in the correct
+     primary xsl pdf, and then run xsltproc -->
+<xsl:import href="PRIMARYXSL"/>
+<xsl:output method='xml'/>
+
+<xsl:param name="chapter.autolabel" select="1"></xsl:param>
+<xsl:param name="section.autolabel" select="1"></xsl:param>
+<xsl:param name="appendix.autolabel" select="1"></xsl:param>
+<xsl:param name="autotoc.label.in.hyperlink" select="1"></xsl:param>
+<xsl:param name="section.label.includes.component.label" select="1"></xsl:param>
+
+<!--  textdecoration_1 applies the style to the text to highlight an region
+               of the documentation refers to a lustre specific version.
+
+               template_{1,2,3} all use the 'condition="{l23,l24}" attributes and add
+               decoration to the rendered version of the manual to show lustre version
+               specific features. -->
+
+<!-- textdecoration_1: a template to highlight regions of text. -->
+<xsl:template name='textdecoration_1'>
+       <xsl:param name='version'/>
+       <xsl:param name='chunkid'/>
+       <fo:block-container id="{$chunkid}"
+                       padding='5pt'
+                       border-color='gray'
+                       border-style='solid'
+                       border-width='1pt'>
+               <fo:block-container float='left' text-indent='3px' start-indent='-20px'>
+                       <fo:block background-color="gray">
+                               <xsl:value-of select='$version'/>
+                       </fo:block>
+               </fo:block-container>
+               <fo:block text-indent='0px' start-indent='0px'>
+                       <xsl:apply-templates/>
+               </fo:block>
+       </fo:block-container>
+</xsl:template>
+
+<!-- template_1: this tempate matches condition='l23' and calls
+               the textdecoration_1 template with the relevant image. -->
+<xsl:template match="*[@condition='l23']">
+       <xsl:variable name="id">
+               <xsl:call-template name="object.id"/>
+       </xsl:variable>
+       <xsl:call-template name='section.titlepage'/>
+       <xsl:call-template name='textdecoration_1'>
+               <xsl:with-param name='version' select="'introduced in Lustre 2.3'"/>
+               <xsl:with-param name='chunkid' select="$id"/>
+       </xsl:call-template>
+</xsl:template>
+<!-- template_2: this tempate matches condition='l24' and calls
+               the textdecoration_1 template with the relevant image. -->
+<xsl:template match="*[@condition='l24']">
+       <xsl:variable name="id">
+               <xsl:call-template name="object.id"/>
+       </xsl:variable>
+       <xsl:call-template name='section.titlepage'/>
+       <xsl:call-template name='textdecoration_1'>
+               <xsl:with-param name='version' select="'introduced in Lustre 2.4'"/>
+               <xsl:with-param name='chunkid' select="$id"/>
+       </xsl:call-template>
+</xsl:template>
+
+<!-- template_3: This template over loads the behavior of creating the table of contents. It
+               adds in a small entry to identify lustre version specific features.
+               for more information, see this page:
+               http://xml.web.cern.ch/XML/www.sagehill.net/xml/docbookxsl/PrintCustomEx.html#PrintTocEntries -->
+<xsl:template name="toc.line">
+       <xsl:variable name="id">
+               <xsl:call-template name="object.id"/>
+       </xsl:variable>
+       <xsl:variable name="lustrecond">
+               <xsl:choose>
+                       <xsl:when test="@condition='l23'">L 2.3</xsl:when>
+                       <xsl:when test="@condition='l24'">L 2.4</xsl:when>
+                       <xsl:otherwise></xsl:otherwise>
+               </xsl:choose>
+       </xsl:variable>
+
+       <xsl:variable name="label">
+               <xsl:apply-templates select="." mode="label.markup"/>
+       </xsl:variable>
+       <fo:block text-align-last="justify"
+                       end-indent="{$toc.indent.width}pt"
+                       last-line-end-indent="-{$toc.indent.width}pt">
+               <fo:inline keep-with-next.within-line="always">
+                       <xsl:choose>
+                               <xsl:when test="local-name(.) = 'chapter'">
+                                       <xsl:attribute name="font-weight">bold</xsl:attribute>
+                               </xsl:when>
+                       </xsl:choose>
+                       <fo:basic-link internal-destination="{$id}">
+                               <xsl:if test="$label != ''">
+                                       <xsl:copy-of select="$label"/>
+                                       <xsl:value-of select="$autotoc.label.separator"/>
+                               </xsl:if>
+                               <xsl:apply-templates select="." mode="title.markup"/>
+                       </fo:basic-link>
+               </fo:inline>
+               <fo:inline keep-together.within-line="always">
+                       <xsl:text> </xsl:text>
+                       <fo:leader leader-pattern="dots"
+                                       leader-pattern-width="3pt"
+                                       leader-alignment="reference-area"
+                                       keep-with-next.within-line="always"/>
+                       <xsl:text>  </xsl:text>
+                       <xsl:value-of select='$lustrecond'/>
+                       <xsl:text>  </xsl:text>
+                       <fo:basic-link internal-destination="{$id}">
+                               <fo:page-number-citation ref-id="{$id}"/>
+                       </fo:basic-link>
+               </fo:inline>
+       </fo:block>
+</xsl:template>
+
+</xsl:stylesheet>