<?xml version='1.0'?>
<xsl:stylesheet exclude-result-prefixes="d"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:d="http://docbook.org/ns/docbook"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
version='1.0'>
<!-- ********************************************************************
$Id: formal.xsl 8544 2009-12-02 06:06:53Z bobstayton $
********************************************************************
This file is part of the XSL DocBook Stylesheet distribution.
See ../README or http://docbook.sf.net/release/xsl/current/ for
copyright and other information.
******************************************************************** -->
<!-- formal.object creates a basic block containing the
result of processing the object, including its title
and any keep-together properties.
The template calling formal.object may wrap these results in a
float or pgwide block. -->
<xsl:template name="formal.object">
<xsl:param name="placement" select="'before'"/>
<xsl:variable name="id">
<xsl:call-template name="object.id"/>
</xsl:variable>
<xsl:variable name="content">
<xsl:if test="$placement = 'before'">
<xsl:call-template name="formal.object.heading">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</xsl:if>
<xsl:apply-templates/>
<xsl:if test="$placement != 'before'">
<xsl:call-template name="formal.object.heading">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</xsl:if>
</xsl:variable>
<xsl:variable name="keep.together">
<xsl:call-template name="pi.dbfo_keep-together"/>
</xsl:variable>
<xsl:choose>
<!-- tables have their own templates and
are not handled by formal.object -->
<xsl:when test="self::d:figure">
<fo:block id="{$id}"
xsl:use-attribute-sets="figure.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:copy-of select="$content"/>
</fo:block>
</xsl:when>
<xsl:when test="self::d:example">
<fo:block id="{$id}"
xsl:use-attribute-sets="example.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:copy-of select="$content"/>
</fo:block>
</xsl:when>
<xsl:when test="self::d:equation">
<fo:block id="{$id}"
xsl:use-attribute-sets="equation.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:copy-of select="$content"/>
</fo:block>
</xsl:when>
<xsl:when test="self::d:procedure">
<fo:block id="{$id}"
xsl:use-attribute-sets="procedure.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:copy-of select="$content"/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="formal.object.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:copy-of select="$content"/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="formal.object.heading">
<xsl:param name="object" select="."/>
<xsl:param name="placement" select="'before'"/>
<fo:block xsl:use-attribute-sets="formal.title.properties">
<xsl:choose>
<xsl:when test="$placement = 'before'">
<xsl:attribute
name="keep-with-next.within-column">always</xsl:attribute>
</xsl:when>
<xsl:otherwise>
<xsl:attribute
name="keep-with-previous.within-column">always</xsl:attribute>
</xsl:otherwise>
</xsl:choose>
<xsl:apply-templates select="$object" mode="object.title.markup">
<xsl:with-param name="allow-anchors" select="1"/>
</xsl:apply-templates>
</fo:block>
</xsl:template>
<xsl:template name="informal.object">
<xsl:variable name="id">
<xsl:call-template name="object.id"/>
</xsl:variable>
<xsl:variable name="keep.together">
<xsl:call-template name="pi.dbfo_keep-together"/>
</xsl:variable>
<!-- Some don't have a pgwide attribute, so may use a PI -->
<xsl:variable name="pgwide.pi">
<xsl:call-template name="pi.dbfo_pgwide"/>
</xsl:variable>
<xsl:variable name="pgwide">
<xsl:choose>
<xsl:when test="@pgwide">
<xsl:value-of select="@pgwide"/>
</xsl:when>
<xsl:when test="$pgwide.pi">
<xsl:value-of select="$pgwide.pi"/>
</xsl:when>
<!-- child element may set pgwide -->
<xsl:when test="*[@pgwide]">
<xsl:value-of select="*[@pgwide][1]/@pgwide"/>
</xsl:when>
</xsl:choose>
</xsl:variable>
<xsl:choose>
<!-- informaltables have their own templates and
are not handled by formal.object -->
<xsl:when test="local-name(.) = 'equation'">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block id="{$id}"
xsl:use-attribute-sets="pgwide.properties
equation.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:call-template name="equation.without.title"/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="equation.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:call-template name="equation.without.title"/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:when test="local-name(.) = 'procedure'">
<fo:block id="{$id}"
xsl:use-attribute-sets="procedure.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:when>
<xsl:when test="local-name(.) = 'informalfigure'">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block id="{$id}"
xsl:use-attribute-sets="pgwide.properties
informalfigure.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="informalfigure.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:when test="local-name(.) = 'informalexample'">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block id="{$id}"
xsl:use-attribute-sets="pgwide.properties
informalexample.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="informalexample.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:when test="local-name(.) = 'informalequation'">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block id="{$id}"
xsl:use-attribute-sets="pgwide.properties
informalequation.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="informalequation.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:otherwise>
<fo:block id="{$id}"
xsl:use-attribute-sets="informal.object.properties">
<xsl:if test="$keep.together != ''">
<xsl:attribute name="keep-together.within-column"><xsl:value-of
select="$keep.together"/></xsl:attribute>
</xsl:if>
<xsl:apply-templates/>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="equation.without.title">
<!-- Lay out equation and number next to equation using a table -->
<fo:table table-layout="fixed" width="100%">
<fo:table-column column-width="proportional-column-width(15)"/>
<fo:table-column column-width="proportional-column-width(1)"/>
<fo:table-body start-indent="0pt" end-indent="0pt">
<fo:table-row>
<fo:table-cell padding-end="6pt">
<fo:block>
<xsl:apply-templates/>
</fo:block>
</fo:table-cell>
<fo:table-cell xsl:use-attribute-sets="equation.number.properties">
<fo:block>
<xsl:text>(</xsl:text>
<xsl:apply-templates select="." mode="label.markup"/>
<xsl:text>)</xsl:text>
</fo:block>
</fo:table-cell>
</fo:table-row>
</fo:table-body>
</fo:table>
</xsl:template>
<xsl:template name="semiformal.object">
<xsl:param name="placement" select="'before'"/>
<xsl:choose>
<xsl:when test="d:title or d:info/d:title">
<xsl:call-template name="formal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="informal.object"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template match="d:figure">
<xsl:variable name="param.placement"
select="substring-after(normalize-space($formal.title.placement),
concat(local-name(.), ' '))"/>
<xsl:variable name="placement">
<xsl:choose>
<xsl:when test="contains($param.placement, ' ')">
<xsl:value-of select="substring-before($param.placement, ' ')"/>
</xsl:when>
<xsl:when test="$param.placement = ''">before</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$param.placement"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:variable name="figure">
<xsl:choose>
<xsl:when test="@pgwide = '1'">
<fo:block xsl:use-attribute-sets="pgwide.properties">
<xsl:call-template name="formal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</fo:block>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="formal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:variable name="floatstyle">
<xsl:call-template name="floatstyle"/>
</xsl:variable>
<xsl:choose>
<xsl:when test="$floatstyle != ''">
<xsl:call-template name="floater">
<xsl:with-param name="position" select="$floatstyle"/>
<xsl:with-param name="content" select="$figure"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:copy-of select="$figure"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template match="d:example">
<xsl:variable name="param.placement"
select="substring-after(normalize-space($formal.title.placement),
concat(local-name(.), ' '))"/>
<xsl:variable name="placement">
<xsl:choose>
<xsl:when test="contains($param.placement, ' ')">
<xsl:value-of select="substring-before($param.placement, ' ')"/>
</xsl:when>
<xsl:when test="$param.placement = ''">before</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$param.placement"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<!-- Example doesn't have a pgwide attribute, so may use a PI -->
<xsl:variable name="pgwide.pi">
<xsl:call-template name="pi.dbfo_pgwide"/>
</xsl:variable>
<xsl:variable name="pgwide">
<xsl:choose>
<xsl:when test="$pgwide.pi">
<xsl:value-of select="$pgwide.pi"/>
</xsl:when>
<!-- child element may set pgwide -->
<xsl:when test="*[@pgwide]">
<xsl:value-of select="*[@pgwide][1]/@pgwide"/>
</xsl:when>
</xsl:choose>
</xsl:variable>
<!-- Get align value from internal mediaobject -->
<xsl:variable name="align">
<xsl:if test="d:mediaobject|d:mediaobjectco">
<xsl:variable name="olist" select="d:mediaobject/d:imageobject
|d:mediaobjectco/d:imageobjectco
|d:mediaobject/d:videoobject
|d:mediaobject/d:audioobject
|d:mediaobject/d:textobject"/>
<xsl:variable name="object.index">
<xsl:call-template name="select.mediaobject.index">
<xsl:with-param name="olist" select="$olist"/>
<xsl:with-param name="count" select="1"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="object" select="$olist[position() = $object.index]"/>
<xsl:value-of select="$object/descendant::d:imagedata[@align][1]/@align"/>
</xsl:if>
</xsl:variable>
<xsl:variable name="example">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block xsl:use-attribute-sets="pgwide.properties">
<xsl:if test="$align != ''">
<xsl:attribute name="text-align">
<xsl:value-of select="$align"/>
</xsl:attribute>
</xsl:if>
<xsl:call-template name="formal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</fo:block>
</xsl:when>
<xsl:otherwise>
<fo:block>
<xsl:if test="$align != ''">
<xsl:attribute name="text-align">
<xsl:value-of select="$align"/>
</xsl:attribute>
</xsl:if>
<xsl:call-template name="formal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</fo:block>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:variable name="floatstyle">
<xsl:call-template name="floatstyle"/>
</xsl:variable>
<xsl:choose>
<xsl:when test="$floatstyle != ''">
<xsl:call-template name="floater">
<xsl:with-param name="position" select="$floatstyle"/>
<xsl:with-param name="content" select="$example"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:copy-of select="$example"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- Unified handling of CALS and HTML tables, formal and not -->
<!-- Creates a hierarchy of nested containers:
- Outer container does a float.
- Nested container does block-container for rotation
- Nested block contains title, layout table and footnotes
- Nested layout table placeholder template supports extensions.
- fo:table is innermost.
Created from the innermost and working out.
Not all layers apply to every table.
-->
<xsl:template match="d:table|d:informaltable">
<xsl:if test="d:tgroup/d:tbody/d:tr
|d:tgroup/d:thead/d:tr
|d:tgroup/d:tfoot/d:tr">
<xsl:message terminate="yes">
<xsl:text>Broken table: tr descendent of CALS Table.</xsl:text>
<xsl:text>The text in the first tr is: </xsl:text>
<xsl:value-of
select="(d:tgroup//d:tr)[1]"/>
</xsl:message>
</xsl:if>
<xsl:if test="not(d:tgroup) and .//d:row">
<xsl:message terminate="yes">
<xsl:text>Broken table: row descendent of HTML table.</xsl:text>
<xsl:text>The text in the first row is: </xsl:text>
<xsl:value-of
select=".//d:row[1]"/>
</xsl:message>
</xsl:if>
<!-- Contains fo:table, not title or footnotes -->
<xsl:variable name="table.content">
<xsl:call-template name="make.table.content"/>
</xsl:variable>
<!-- Optional layout table template for extensions -->
<xsl:variable name="table.layout">
<xsl:call-template name="table.layout">
<xsl:with-param name="table.content" select="$table.content"/>
</xsl:call-template>
</xsl:variable>
<!-- fo:block contains title, layout table, and footnotes -->
<xsl:variable name="table.block">
<xsl:call-template name="table.block">
<xsl:with-param name="table.layout" select="$table.layout"/>
</xsl:call-template>
</xsl:variable>
<!-- pgwide or orient container -->
<xsl:variable name="table.container">
<xsl:call-template name="table.container">
<xsl:with-param name="table.block" select="$table.block"/>
</xsl:call-template>
</xsl:variable>
<!-- float or not -->
<xsl:variable name="floatstyle">
<xsl:call-template name="floatstyle"/>
</xsl:variable>
<xsl:choose>
<xsl:when test="$floatstyle != ''">
<xsl:call-template name="floater">
<xsl:with-param name="position" select="$floatstyle"/>
<xsl:with-param name="content" select="$table.container"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:copy-of select="$table.container"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template match="d:equation">
<xsl:variable name="param.placement"
select="substring-after(normalize-space($formal.title.placement),
concat(local-name(.), ' '))"/>
<xsl:variable name="placement">
<xsl:choose>
<xsl:when test="contains($param.placement, ' ')">
<xsl:value-of select="substring-before($param.placement, ' ')"/>
</xsl:when>
<xsl:when test="$param.placement = ''">before</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$param.placement"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<!-- Equation doesn't have a pgwide attribute, so may use a PI -->
<xsl:variable name="pgwide">
<xsl:call-template name="pi.dbfo_pgwide"/>
</xsl:variable>
<xsl:variable name="equation">
<xsl:choose>
<xsl:when test="$pgwide = '1'">
<fo:block xsl:use-attribute-sets="pgwide.properties">
<xsl:call-template name="semiformal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</fo:block>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="semiformal.object">
<xsl:with-param name="placement" select="$placement"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:variable name="floatstyle">
<xsl:call-template name="floatstyle"/>
</xsl:variable>
<xsl:choose>
<xsl:when test="$floatstyle != ''">
<xsl:call-template name="floater">
<xsl:with-param name="position" select="$floatstyle"/>
<xsl:with-param name="content" select="$equation"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:copy-of select="$equation"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template match="d:figure/d:title"></xsl:template>
<xsl:template match="d:figure/d:titleabbrev"></xsl:template>
<xsl:template match="d:table/d:title"></xsl:template>
<xsl:template match="d:table/d:titleabbrev"></xsl:template>
<xsl:template match="d:table/d:textobject"></xsl:template>
<xsl:template match="d:example/d:title"></xsl:template>
<xsl:template match="d:example/d:titleabbrev"></xsl:template>
<xsl:template match="d:equation/d:title"></xsl:template>
<xsl:template match="d:equation/d:titleabbrev"></xsl:template>
<xsl:template match="d:informalfigure">
<xsl:call-template name="informal.object"/>
</xsl:template>
<xsl:template match="d:informalexample">
<xsl:call-template name="informal.object"/>
</xsl:template>
<xsl:template match="d:informaltable/d:textobject"></xsl:template>
<xsl:template match="d:informalequation">
<xsl:call-template name="informal.object"/>
</xsl:template>
<xsl:template name="floatstyle">
<xsl:if test="(@float and @float != '0') or @floatstyle != ''">
<xsl:choose>
<xsl:when test="@floatstyle != ''">
<xsl:value-of select="@floatstyle"/>
</xsl:when>
<xsl:when test="@float = '1'">
<xsl:value-of select="$default.float.class"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="@float"/>
</xsl:otherwise>
</xsl:choose>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 26953 | Paul Allen | Move //guest/perforce_software/p4convert to //guest/perforce_software/p4convert/main | ||
| //guest/perforce_software/p4convert/docs/docbook-xsl-ns-1.78.1/fo/formal.xsl | |||||
| #2 | 14806 | Paul Allen | Update docs and add +w. | ||
| #1 | 13920 | Paul Allen | copy part 2 (no errors) | ||
| //guest/paul_allen/p4convert-maven/docs/docbook-xsl-ns-1.78.1/fo/formal.xsl | |||||
| #1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
| //guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/fo/formal.xsl | |||||
| #1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |
||