517 lines
22 KiB
XML
517 lines
22 KiB
XML
<?xml version="1.0"?>
|
|
|
|
<!--
|
|
|
|
This is the XSL FO configuration file for the Hibernate
|
|
Reference Documentation. It defines a custom titlepage and
|
|
the parameters for the A4 sized PDF printable output.
|
|
|
|
It took me days to figure out this stuff and fix most of
|
|
the obvious bugs in the DocBook XSL distribution. Some of
|
|
the workarounds might not be appropriate with a newer version
|
|
of DocBook XSL. This file is released as part of Hibernate,
|
|
hence LGPL licensed.
|
|
|
|
christian@hibernate.org
|
|
|
|
-->
|
|
|
|
<!DOCTYPE xsl:stylesheet [
|
|
<!ENTITY db_xsl_path "../../support/docbook-xsl/">
|
|
]>
|
|
|
|
<xsl:stylesheet
|
|
version="1.0"
|
|
xmlns="http://www.w3.org/TR/xhtml1/transitional"
|
|
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
|
xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
|
exclude-result-prefixes="#default">
|
|
|
|
<xsl:import href="&db_xsl_path;/fo/docbook.xsl"/>
|
|
|
|
<!--###################################################
|
|
Custom Title Page
|
|
################################################### -->
|
|
|
|
<xsl:template name="book.titlepage.recto">
|
|
<fo:block>
|
|
<fo:table table-layout="fixed" width="175mm">
|
|
<fo:table-column column-width="175mm"/>
|
|
<fo:table-body>
|
|
<fo:table-row>
|
|
<fo:table-cell text-align="center">
|
|
<fo:block>
|
|
<fo:external-graphic src="file:images/hibernate_logo_a.png"/>
|
|
</fo:block>
|
|
<fo:block font-family="Helvetica" font-size="22pt" padding-before="10mm">
|
|
<xsl:value-of select="bookinfo/subtitle"/>
|
|
</fo:block>
|
|
<fo:block font-family="Helvetica" font-size="12pt" padding="10mm">
|
|
Version:
|
|
<xsl:value-of select="bookinfo/releaseinfo"/>
|
|
</fo:block>
|
|
</fo:table-cell>
|
|
</fo:table-row>
|
|
</fo:table-body>
|
|
</fo:table>
|
|
</fo:block>
|
|
</xsl:template>
|
|
|
|
<!-- Prevent blank pages in output -->
|
|
<xsl:template name="book.titlepage.before.verso">
|
|
</xsl:template>
|
|
<xsl:template name="book.titlepage.verso">
|
|
</xsl:template>
|
|
<xsl:template name="book.titlepage.separator">
|
|
</xsl:template>
|
|
|
|
<!--###################################################
|
|
Header
|
|
################################################### -->
|
|
|
|
<!-- More space in the center header for long text -->
|
|
<xsl:attribute-set name="header.content.properties">
|
|
<xsl:attribute name="font-family">
|
|
<xsl:value-of select="$body.font.family"/>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="margin-left">-5em</xsl:attribute>
|
|
<xsl:attribute name="margin-right">-5em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!--###################################################
|
|
Custom Footer
|
|
################################################### -->
|
|
|
|
<!-- This footer prints the Hibernate version number on the left side -->
|
|
<xsl:template name="footer.content">
|
|
<xsl:param name="pageclass" select="''"/>
|
|
<xsl:param name="sequence" select="''"/>
|
|
<xsl:param name="position" select="''"/>
|
|
<xsl:param name="gentext-key" select="''"/>
|
|
|
|
<xsl:variable name="Version">
|
|
<xsl:choose>
|
|
<xsl:when test="//releaseinfo">
|
|
<xsl:text>Hibernate </xsl:text>
|
|
<xsl:value-of select="//releaseinfo"/>
|
|
</xsl:when>
|
|
<xsl:otherwise>
|
|
<!-- nop -->
|
|
</xsl:otherwise>
|
|
</xsl:choose>
|
|
</xsl:variable>
|
|
|
|
<xsl:choose>
|
|
<xsl:when test="$sequence='blank'">
|
|
<xsl:choose>
|
|
<xsl:when test="$double.sided != 0 and $position = 'left'">
|
|
<xsl:value-of select="$Version"/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided = 0 and $position = 'center'">
|
|
<!-- nop -->
|
|
</xsl:when>
|
|
|
|
<xsl:otherwise>
|
|
<fo:page-number/>
|
|
</xsl:otherwise>
|
|
</xsl:choose>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$pageclass='titlepage'">
|
|
<!-- nop: other titlepage sequences have no footer -->
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided != 0 and $sequence = 'even' and $position='left'">
|
|
<fo:page-number/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided != 0 and $sequence = 'odd' and $position='right'">
|
|
<fo:page-number/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided = 0 and $position='right'">
|
|
<fo:page-number/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided != 0 and $sequence = 'odd' and $position='left'">
|
|
<xsl:value-of select="$Version"/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided != 0 and $sequence = 'even' and $position='right'">
|
|
<xsl:value-of select="$Version"/>
|
|
</xsl:when>
|
|
|
|
<xsl:when test="$double.sided = 0 and $position='left'">
|
|
<xsl:value-of select="$Version"/>
|
|
</xsl:when>
|
|
|
|
<xsl:otherwise>
|
|
<!-- nop -->
|
|
</xsl:otherwise>
|
|
</xsl:choose>
|
|
</xsl:template>
|
|
|
|
<!--###################################################
|
|
Custom Toc Line
|
|
################################################### -->
|
|
|
|
<!-- Improve the TOC. -->
|
|
<xsl:template name="toc.line">
|
|
<xsl:variable name="id">
|
|
<xsl:call-template name="object.id"/>
|
|
</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">
|
|
<fo:basic-link internal-destination="{$id}">
|
|
|
|
<!-- Chapter titles should be bold. -->
|
|
<xsl:choose>
|
|
<xsl:when test="local-name(.) = 'chapter'">
|
|
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
|
</xsl:when>
|
|
</xsl:choose>
|
|
|
|
<xsl:if test="$label != ''">
|
|
<xsl:copy-of select="$label"/>
|
|
<xsl:value-of select="$autotoc.label.separator"/>
|
|
</xsl:if>
|
|
<xsl:apply-templates select="." mode="titleabbrev.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>
|
|
<fo:basic-link internal-destination="{$id}">
|
|
<fo:page-number-citation ref-id="{$id}"/>
|
|
</fo:basic-link>
|
|
</fo:inline>
|
|
</fo:block>
|
|
</xsl:template>
|
|
|
|
<!--###################################################
|
|
Extensions
|
|
################################################### -->
|
|
|
|
<!-- These extensions are required for table printing and other stuff -->
|
|
<xsl:param name="use.extensions">1</xsl:param>
|
|
<xsl:param name="tablecolumns.extension">0</xsl:param>
|
|
<!-- FOP provide only PDF Bookmarks at the moment -->
|
|
<xsl:param name="fop.extensions">1</xsl:param>
|
|
|
|
<!--###################################################
|
|
Table Of Contents
|
|
################################################### -->
|
|
|
|
<!-- Generate the TOCs for named components only -->
|
|
<xsl:param name="generate.toc">
|
|
book toc
|
|
</xsl:param>
|
|
|
|
<!-- Show only Sections up to level 3 in the TOCs -->
|
|
<xsl:param name="toc.section.depth">3</xsl:param>
|
|
|
|
<!-- Dot and Whitespace as separator in TOC between Label and Title-->
|
|
<xsl:param name="autotoc.label.separator" select="'. '"/>
|
|
|
|
|
|
<!--###################################################
|
|
Paper & Page Size
|
|
################################################### -->
|
|
|
|
<!-- Paper type, no headers on blank pages, no double sided printing -->
|
|
<xsl:param name="paper.type" select="'A4'"/>
|
|
<xsl:param name="double.sided">0</xsl:param>
|
|
<xsl:param name="headers.on.blank.pages">0</xsl:param>
|
|
<xsl:param name="footers.on.blank.pages">0</xsl:param>
|
|
|
|
<!-- Space between paper border and content (chaotic stuff, don't touch) -->
|
|
<xsl:param name="page.margin.top">5mm</xsl:param>
|
|
<xsl:param name="region.before.extent">10mm</xsl:param>
|
|
<xsl:param name="body.margin.top">10mm</xsl:param>
|
|
|
|
<xsl:param name="body.margin.bottom">15mm</xsl:param>
|
|
<xsl:param name="region.after.extent">10mm</xsl:param>
|
|
<xsl:param name="page.margin.bottom">0mm</xsl:param>
|
|
|
|
<xsl:param name="page.margin.outer">18mm</xsl:param>
|
|
<xsl:param name="page.margin.inner">18mm</xsl:param>
|
|
|
|
<!-- No intendation of Titles -->
|
|
<xsl:param name="title.margin.left">0pc</xsl:param>
|
|
|
|
<!--###################################################
|
|
Fonts & Styles
|
|
################################################### -->
|
|
|
|
<!-- Default Font size -->
|
|
<xsl:param name="body.font.master">11</xsl:param>
|
|
|
|
<!-- Line height in body text -->
|
|
<xsl:param name="line-height">1.4</xsl:param>
|
|
|
|
<!-- Monospaced fonts are smaller than regular text -->
|
|
<xsl:attribute-set name="monospace.properties">
|
|
<xsl:attribute name="font-family">
|
|
<xsl:value-of select="$monospace.font.family"/>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="font-size">0.8em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!--###################################################
|
|
Tables
|
|
################################################### -->
|
|
|
|
<!-- The table width should be adapted to the paper size -->
|
|
<xsl:param name="default.table.width">17.4cm</xsl:param>
|
|
|
|
<!-- Some padding inside tables -->
|
|
<xsl:attribute-set name="table.cell.padding">
|
|
<xsl:attribute name="padding-left">4pt</xsl:attribute>
|
|
<xsl:attribute name="padding-right">4pt</xsl:attribute>
|
|
<xsl:attribute name="padding-top">4pt</xsl:attribute>
|
|
<xsl:attribute name="padding-bottom">4pt</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!-- Only hairlines as frame and cell borders in tables -->
|
|
<xsl:param name="table.frame.border.thickness">0.1pt</xsl:param>
|
|
<xsl:param name="table.cell.border.thickness">0.1pt</xsl:param>
|
|
|
|
<!--###################################################
|
|
Labels
|
|
################################################### -->
|
|
|
|
<!-- Label Chapters and Sections (numbering) -->
|
|
<xsl:param name="chapter.autolabel">1</xsl:param>
|
|
<xsl:param name="section.autolabel" select="1"/>
|
|
<xsl:param name="section.label.includes.component.label" select="1"/>
|
|
|
|
<!-- Label only Sections up to level 2 -->
|
|
<xsl:param name="local.l10n.xml" select="document('')"/>
|
|
<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
|
|
<l:l10n language="en">
|
|
<l:context name="title-numbered">
|
|
<l:template name="sect3" text="%t"/>
|
|
<l:template name="sect4" text="%t"/>
|
|
<l:template name="sect5" text="%t"/>
|
|
</l:context>
|
|
<l:context name="section-xref-numbered">
|
|
<l:template name="sect3" text="the section called %t"/>
|
|
<l:template name="sect4" text="the section called %t"/>
|
|
<l:template name="sect5" text="the section called %t"/>
|
|
</l:context>
|
|
</l:l10n>
|
|
</l:i18n>
|
|
|
|
<!--###################################################
|
|
Titles
|
|
################################################### -->
|
|
|
|
<!-- Chapter title size -->
|
|
<xsl:attribute-set name="chapter.titlepage.recto.style">
|
|
<xsl:attribute name="text-align">left</xsl:attribute>
|
|
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
|
<xsl:attribute name="font-size">
|
|
<xsl:value-of select="$body.font.master * 1.8"/>
|
|
<xsl:text>pt</xsl:text>
|
|
</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!-- Why is the font-size for chapters hardcoded in the XSL FO templates?
|
|
Let's remove it, so this sucker can use our attribute-set only... -->
|
|
<xsl:template match="title" mode="chapter.titlepage.recto.auto.mode">
|
|
<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
|
xsl:use-attribute-sets="chapter.titlepage.recto.style">
|
|
<xsl:call-template name="component.title">
|
|
<xsl:with-param name="node" select="ancestor-or-self::chapter[1]"/>
|
|
</xsl:call-template>
|
|
</fo:block>
|
|
</xsl:template>
|
|
|
|
<!-- Sections 1, 2 and 3 titles have a small bump factor and padding -->
|
|
<xsl:attribute-set name="section.title.level1.properties">
|
|
<xsl:attribute name="space-before.optimum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="space-before.maximum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="font-size">
|
|
<xsl:value-of select="$body.font.master * 1.5"/>
|
|
<xsl:text>pt</xsl:text>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
<xsl:attribute-set name="section.title.level2.properties">
|
|
<xsl:attribute name="space-before.optimum">0.6em</xsl:attribute>
|
|
<xsl:attribute name="space-before.minimum">0.6em</xsl:attribute>
|
|
<xsl:attribute name="space-before.maximum">0.6em</xsl:attribute>
|
|
<xsl:attribute name="font-size">
|
|
<xsl:value-of select="$body.font.master * 1.25"/>
|
|
<xsl:text>pt</xsl:text>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
<xsl:attribute-set name="section.title.level3.properties">
|
|
<xsl:attribute name="space-before.optimum">0.4em</xsl:attribute>
|
|
<xsl:attribute name="space-before.minimum">0.4em</xsl:attribute>
|
|
<xsl:attribute name="space-before.maximum">0.4em</xsl:attribute>
|
|
<xsl:attribute name="font-size">
|
|
<xsl:value-of select="$body.font.master * 1.0"/>
|
|
<xsl:text>pt</xsl:text>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!-- Titles of formal objects (tables, examples, ...) -->
|
|
<xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
|
|
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
|
<xsl:attribute name="font-size">
|
|
<xsl:value-of select="$body.font.master"/>
|
|
<xsl:text>pt</xsl:text>
|
|
</xsl:attribute>
|
|
<xsl:attribute name="hyphenate">false</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!--###################################################
|
|
Programlistings
|
|
################################################### -->
|
|
|
|
<!-- Verbatim text formatting (programlistings) -->
|
|
<xsl:attribute-set name="verbatim.properties">
|
|
<xsl:attribute name="space-before.minimum">1em</xsl:attribute>
|
|
<xsl:attribute name="space-before.optimum">1em</xsl:attribute>
|
|
<xsl:attribute name="space-before.maximum">1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="border-color">#444444</xsl:attribute>
|
|
<xsl:attribute name="border-style">solid</xsl:attribute>
|
|
<xsl:attribute name="border-width">0.1pt</xsl:attribute>
|
|
<xsl:attribute name="padding-top">0.5em</xsl:attribute>
|
|
<xsl:attribute name="padding-left">0.5em</xsl:attribute>
|
|
<xsl:attribute name="padding-right">0.5em</xsl:attribute>
|
|
<xsl:attribute name="padding-bottom">0.5em</xsl:attribute>
|
|
<xsl:attribute name="margin-left">0.5em</xsl:attribute>
|
|
<xsl:attribute name="margin-right">0.5em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!-- Shade (background) programlistings -->
|
|
<xsl:param name="shade.verbatim">1</xsl:param>
|
|
<xsl:attribute-set name="shade.verbatim.style">
|
|
<xsl:attribute name="background-color">#F0F0F0</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!--###################################################
|
|
Callouts
|
|
################################################### -->
|
|
|
|
<!-- We want to use callouts... -->
|
|
<xsl:param name="callout.extensions">1</xsl:param>
|
|
|
|
<!-- Place callout bullets at this column in programmlisting.-->
|
|
<xsl:param name="callout.defaultcolumn">90</xsl:param>
|
|
|
|
<!--
|
|
No, don't use crappy graphics for the callout bullets. This setting
|
|
enables some weird Unicode rendering for some fancy bullet points
|
|
in callouts. By default, this can only count to 10 and produces
|
|
strange results if you ever have more than 10 callouts for one
|
|
programlisting. We will fix that next.
|
|
-->
|
|
<xsl:param name="callout.graphics">0</xsl:param>
|
|
|
|
<!--
|
|
Again, fun with DocBook XSL: The callout bullets are rendered in
|
|
two places: In the programlisting itself and in the list below
|
|
the listing, with the actual callout text. The rendering in the
|
|
programlisting is some XSL transformer extension (e.g. a Saxon
|
|
extension), so we can't change that without messing with the
|
|
extensions. We only can turn it off by setting this limit to
|
|
zero, then, a simple bracket style like "(3)" and "(4)" will
|
|
be used in the programlisting.
|
|
-->
|
|
<xsl:param name="callout.unicode.number.limit" select="'0'"></xsl:param>
|
|
|
|
<!--
|
|
The callout bullets in the actual callout list will be rendered
|
|
with an XSL FO template. The default template is broken: limited to 10
|
|
nice looking Unicode bullet points and then it doesn't print anything,
|
|
the fallback doesn't work. We implement our own template, which is not
|
|
as complicated, more ugly, but works. As always, function is more
|
|
important than form.
|
|
-->
|
|
<xsl:template name="callout-bug">
|
|
<xsl:param name="conum" select='1'/>
|
|
<fo:inline
|
|
color="black"
|
|
padding-top="0.1em"
|
|
padding-bottom="0.1em"
|
|
padding-start="0.2em"
|
|
padding-end="0.2em"
|
|
baseline-shift="0.1em"
|
|
font-family="{$monospace.font.family}"
|
|
font-weight="bold"
|
|
font-size="75%">
|
|
<xsl:text>(</xsl:text>
|
|
<xsl:value-of select="$conum"/>
|
|
<xsl:text>)</xsl:text>
|
|
</fo:inline>
|
|
|
|
</xsl:template>
|
|
|
|
<!--###################################################
|
|
Misc
|
|
################################################### -->
|
|
|
|
<!-- Correct placement of titles for figures and examples. -->
|
|
<xsl:param name="formal.title.placement">
|
|
figure after
|
|
example before
|
|
equation before
|
|
table before
|
|
procedure before
|
|
</xsl:param>
|
|
|
|
<!-- Format Variable Lists as Blocks (prevents horizontal overflow). -->
|
|
<xsl:param name="variablelist.as.blocks">1</xsl:param>
|
|
|
|
<!-- The horrible list spacing problems, this is much better. -->
|
|
<xsl:attribute-set name="list.block.spacing">
|
|
<xsl:attribute name="space-before.optimum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="space-before.maximum">0.8em</xsl:attribute>
|
|
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
|
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
|
</xsl:attribute-set>
|
|
|
|
<!-- Newer DocBook XSL apparently thinks that some sections are by
|
|
default "draft" status, and this idiotic thing is by default
|
|
also set to "maybe", so it spits out a lot of errors with the
|
|
latest FOP as the XSL/FO styles have references to some draft
|
|
watermarks, which you actually don't want in the first place.
|
|
Turn this crap off. If you have to work with the "status"
|
|
attribute, don't.
|
|
-->
|
|
<xsl:param name="draft.mode" select="'no'"/>
|
|
|
|
</xsl:stylesheet>
|