<?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" version='1.0'> <!-- ******************************************************************** $Id: refentry.xsl 8235 2009-02-09 16:22:14Z xmldoc $ ******************************************************************** 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. ******************************************************************** --> <!-- ==================================================================== --> <xsl:template match="d:refnamediv"> <xsl:choose> <xsl:when test="preceding-sibling::d:refnamediv"> <!-- * No title on secondary refnamedivs! --> <!-- * Just put a single line break instead --> <xsl:text>.br </xsl:text> </xsl:when> <xsl:otherwise> <xsl:call-template name="make.subheading"> <xsl:with-param name="title"> <xsl:apply-templates select="." mode="subheading.markup"/> </xsl:with-param> </xsl:call-template> </xsl:otherwise> </xsl:choose> <xsl:call-template name="mark.subheading"/> <!-- * if we have multiple Refname instances, separate the names --> <!-- * with commas --> <xsl:for-each select="d:refname"> <xsl:if test="position()>1"> <xsl:text>, </xsl:text> </xsl:if> <xsl:call-template name="string.subst"> <!-- * To create the name(s) for this man page, replace any --> <!-- * spaces in the refname(s) with underscores. This ensures --> <!-- * that tools like lexgrog(1) will be able to parse the name --> <!-- * (lexgrog won’t parse names that contain spaces). --> <xsl:with-param name="string" select="."/> <xsl:with-param name="target" select="' '"/> <xsl:with-param name="replacement" select="'_'"/> </xsl:call-template> </xsl:for-each> <!-- * The man(7) man pages says: --> <!-- * --> <!-- * The only required heading is NAME, which should be the --> <!-- * first section and be followed on the next line by a one --> <!-- * line description of the program: --> <!-- * --> <!-- * .SH NAME chess \- the game of chess --> <!-- * --> <!-- * It is extremely important that this format is followed, --> <!-- * and that there is a backslash before the single dash --> <!-- * which follows the command name. This syntax is used by --> <!-- * the makewhatis(8) program to create a database of short --> <!-- * command descriptions for the whatis(1) and apropos(1) --> <!-- * commands. --> <!-- * --> <xsl:if test="d:refpurpose/node()"> <xsl:text> \- </xsl:text> <xsl:variable name="refpurpose"> <xsl:apply-templates select="d:refpurpose/node()"/> </xsl:variable> <xsl:value-of select="normalize-space($refpurpose)"/> </xsl:if> <xsl:text> </xsl:text> </xsl:template> <xsl:template match="d:refsynopsisdiv"> <xsl:call-template name="make.subheading"> <xsl:with-param name="title"> <xsl:apply-templates select="." mode="subheading.markup"/> </xsl:with-param> </xsl:call-template> <xsl:apply-templates/> </xsl:template> <xsl:template match="d:refsect1|d:refentry/d:refsection"> <xsl:variable name="title"> <xsl:apply-templates select="." mode="subheading.markup"/> </xsl:variable> <xsl:call-template name="make.subheading"> <xsl:with-param name="title"> <xsl:value-of select="normalize-space($title)"/> </xsl:with-param> </xsl:call-template> <xsl:apply-templates/> </xsl:template> <xsl:template match="d:refsect2|d:refentry/d:refsection/d:refsection"> <xsl:call-template name="mark.subheading"/> <xsl:variable name="title"> <xsl:apply-templates select="(d:info/d:title |d:refsectioninfo/d:title |d:refsect1info/d:title |d:title)[1]/node()"/> </xsl:variable> <xsl:text>.SS "</xsl:text> <xsl:value-of select="normalize-space($title)"/> <xsl:text>" </xsl:text> <xsl:call-template name="mark.subheading"/> <xsl:choose> <!-- * If default-indentation adjustment is on, then indent the --> <!-- * child content of this Refsect2 --> <xsl:when test="not($man.indent.refsect = 0)"> <xsl:text>.RS </xsl:text> <xsl:apply-templates/> <xsl:text>.RE </xsl:text> </xsl:when> <xsl:otherwise> <!-- * If default-indentation adjustment is on, then do not --> <!-- * indent the child content of this Refsect2, because --> <!-- * the title is already "sticking out to the left" --> <!-- * (as the groff_man(7) man page describes it), which --> <!-- * actually means the title is indented by the value of --> <!-- * the SN register, which appears by default to be --> <!-- * about half of the default indentation value --> <xsl:apply-templates/> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template match="d:refsect3|d:refentry/d:refsection/d:refsection/d:refsection"> <xsl:variable name="title"> <xsl:value-of select="(d:info/d:title |d:refsectioninfo/d:title |d:refsect1info/d:title |d:title)[1]"/> </xsl:variable> <xsl:choose> <!-- * If default-indentation adjustment is on, then indent the --> <!-- * child content of this Refsect3 or Refsection. --> <xsl:when test="not($man.indent.refsect != 0)"> <xsl:call-template name="nested-section-title"/> <xsl:text>.RS</xsl:text> <xsl:if test="not($man.indent.width = '')"> <xsl:text> </xsl:text> <xsl:value-of select="$man.indent.width"/> </xsl:if> <xsl:text> </xsl:text> <xsl:apply-templates/> <xsl:text>.RE </xsl:text> </xsl:when> <xsl:otherwise> <!-- * If default-indentation adjustment is on, then do not --> <!-- * indent the child content of this Refsect2, because --> <!-- * the title is already "sticking out to the left" --> <!-- * (as the groff_man(7) man page describes it), which --> <!-- * actually means the title is indented by the value of --> <!-- * the SN register, which appears by default to be --> <!-- * about half of the default indentation value --> <xsl:text>.ti (\n(SNu * 5u / 3u) </xsl:text> <xsl:call-template name="nested-section-title"/> <xsl:apply-templates/> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template match="d:refsection"> <!-- * This template is used for a nested Refsection that is --> <!-- * is a child of a Refsect3-level section (The numberd --> <!-- * Refsect hierarchy in DocBook ends with Refsect3, so --> <!-- * there is not actually a Refsect4 element.) --> <xsl:variable name="title"> <xsl:value-of select="(d:info/d:title |d:refsectioninfo/d:title |d:refsect1info/d:title |d:title)[1]"/> </xsl:variable> <xsl:variable name="indent-width"> <xsl:if test="not($man.indent.refsect = 0)"> <!-- * If default-indentation adjustment is on, then indent the --> <!-- * child content of this Refsect3 or Refsection. --> <xsl:text>(\n(SNu) </xsl:text> </xsl:if> </xsl:variable> <xsl:call-template name="nested-section-title"/> <xsl:text>.RS (\n(SNu) </xsl:text> <xsl:apply-templates/> <xsl:text>.RE </xsl:text> </xsl:template> <!-- ==================================================================== --> <xsl:template match="d:refsect1|d:refentry/d:refsection" mode="subheading.markup"> <xsl:variable name="title" select="(d:info/d:title |d:refsectioninfo/d:title |d:refsect1info/d:title |d:title)[1]"/> <xsl:apply-templates select="$title" mode="title.markup"/> </xsl:template> <xsl:template match="d:refsect1|d:refentry/d:refsection" mode="title.markup"> <!-- * Note: This template is used just for generating the text for --> <!-- * cross-references to Refsect1 or top-level Refsection instances. --> <xsl:variable name="title" select="(d:info/d:title |d:refsectioninfo/d:title |d:refsect1info/d:title |d:title)[1]"/> <xsl:call-template name="process.SH.xref"> <xsl:with-param name="title"> <xsl:apply-templates select="$title" mode="title.markup"/> </xsl:with-param> </xsl:call-template> </xsl:template> <!-- * Output of Titles from Xref with Endterm needs to be handled --> <!-- * separately from output for Endterm-less Xref --> <xsl:template match="d:refsect1/d:title |d:refentry/d:refsection/d:title |d:refsynopsisdiv/d:title" mode="endterm"> <xsl:call-template name="process.SH.xref"> <xsl:with-param name="title"> <xsl:apply-templates/> </xsl:with-param> </xsl:call-template> </xsl:template> <xsl:template match="d:refsynopsisdiv" mode="subheading.markup"> <xsl:param name="allow-anchors" select="0"/> <xsl:variable name="title"> <xsl:call-template name="get.refsynopsisdiv.title"> <xsl:with-param name="allow-anchors" select="$allow-anchors"/> </xsl:call-template> </xsl:variable> <xsl:value-of select="$title"/> </xsl:template> <xsl:template match="d:refsynopsisdiv" mode="title.markup"> <!-- * Note: This template is used just for generating the text for --> <!-- * cross-references to Refsynopsisdiv instances. --> <xsl:param name="allow-anchors" select="0"/> <xsl:variable name="title"> <xsl:call-template name="get.refsynopsisdiv.title"> <xsl:with-param name="allow-anchors" select="$allow-anchors"/> </xsl:call-template> </xsl:variable> <xsl:call-template name="process.SH.xref"> <xsl:with-param name="title" select="$title"/> </xsl:call-template> </xsl:template> <xsl:template name="get.refsynopsisdiv.title"> <xsl:param name="allow-anchors"/> <xsl:choose> <xsl:when test="d:info/d:title |d:refsynopsisdivinfo/d:title |d:title"> <xsl:apply-templates select="(d:info/d:title |d:refsynopsisdivinfo/d:title |d:title)[1]" mode="title.markup"> <xsl:with-param name="allow-anchors" select="$allow-anchors"/> </xsl:apply-templates> </xsl:when> <xsl:otherwise> <xsl:call-template name="gentext"> <xsl:with-param name="key" select="'RefSynopsisDiv'"/> </xsl:call-template> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template match="d:refnamediv" mode="subheading.markup"> <xsl:call-template name="gentext"> <xsl:with-param name="key" select="'RefName'"/> </xsl:call-template> </xsl:template> <xsl:template match="d:refnamediv" mode="title.markup"> <xsl:call-template name="process.SH.xref"> <xsl:with-param name="title"> <xsl:call-template name="gentext"> <xsl:with-param name="key" select="'RefName'"/> </xsl:call-template> </xsl:with-param> </xsl:call-template> </xsl:template> <xsl:template match="d:refnamediv" mode="xref-to"> <xsl:apply-templates select="." mode="title.markup"/> </xsl:template> <!-- * suppress any title we don't otherwise process elsewhere --> <xsl:template match="d:title"/> <!-- ==================================================================== --> <xsl:template name="process.SH.xref"> <xsl:param name="title"/> <xsl:choose> <xsl:when test="not($man.output.better.ps.enabled = 0)"> <xsl:text>\c</xsl:text> <xsl:text>▒</xsl:text> <xsl:text>.SH-xref </xsl:text> <xsl:text>"</xsl:text> <xsl:value-of select="$title"/> <xsl:text>\c"</xsl:text> <xsl:text>▒</xsl:text> <xsl:text>\&</xsl:text> </xsl:when> <xsl:otherwise> <xsl:call-template name="string.upper"> <xsl:with-param name="string" select="$title"/> </xsl:call-template> </xsl:otherwise> </xsl:choose> </xsl:template> </xsl:stylesheet>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/manpages/refentry.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. |