|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
-->
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
|
|
Packit |
e4b6da |
xmlns="http://docbook2x.sourceforge.net/xmlns/Man-XML"
|
|
Packit |
e4b6da |
exclude-result-prefixes="doc"
|
|
Packit |
e4b6da |
version='1.0'
|
|
Packit |
e4b6da |
xml:lang="en">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
$Id: param.xsl,v 1.15 2006/04/19 20:31:19 stevecheng Exp $
|
|
Packit |
e4b6da |
********************************************************************
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
(C) 2000-2004 Steve Cheng <stevecheng@users.sourceforge.net>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This file is part of the docbook2X XSLT stylesheets for
|
|
Packit |
e4b6da |
converting DocBook to man pages.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
See ../../COPYING for the copyright status of this software.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
******************************************************************** -->
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:reference xmlns="">
|
|
Packit |
e4b6da |
<title>Stylesheet parameters</title>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Stylesheet parameters influence various aspects of the rendering. They
|
|
Packit |
e4b6da |
can be set from the command line (the exact syntax depends on the XSLT
|
|
Packit |
e4b6da |
processor), or in a custom stylesheet.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
To set them in a custom stylesheet, simply copy the definition here and
|
|
Packit |
e4b6da |
change the <sgmltag class="attribute">select</sgmltag> attribute to
|
|
Packit |
e4b6da |
something else.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
If a parameter for what you want to change does not exist, you can write
|
|
Packit |
e4b6da |
templates in the custom stylesheet instead.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
</doc:reference>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="user-message-prefix" select="'docbook2man:'" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="lowercase-file" select="false()" />
|
|
Packit |
e4b6da |
<doc:param name="lowercase-file" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Make man-page file names lowercase?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Whenever a man-page title is
|
|
Packit |
e4b6da |
all uppercase and this option is set, then the name
|
|
Packit |
e4b6da |
of the file that contains that man-page should be changed to lowercase.
|
|
Packit |
e4b6da |
If the man-page title is mixed-case, the file name will be unchanged.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
This option is intended for the situation where
|
|
Packit |
e4b6da |
the title of the man-page is an identifier
|
|
Packit |
e4b6da |
in some language (e.g. SQL) that is case-insensitive,
|
|
Packit |
e4b6da |
but the official version of the identifier is in uppercase.
|
|
Packit |
e4b6da |
The user would probably prefer
|
|
Packit |
e4b6da |
that the man-page should not be filed as all uppercase,
|
|
Packit |
e4b6da |
even though the title displayed on the man-page should be upper-case.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="uppercase-headings" select="true()" />
|
|
Packit |
e4b6da |
<doc:param name="uppercase-headings" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Make headings uppercase?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Headings in man page content should be or should not be uppercased.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="manvolnum-cite-numeral-only" select="true()" />
|
|
Packit |
e4b6da |
<doc:param name="manvolnum-cite-numeral-only" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Man page section citation should use only the number</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
When citing other man pages, the man-page section is either given as is,
|
|
Packit |
e4b6da |
or has the letters stripped from it, citing only the number of the
|
|
Packit |
e4b6da |
section (e.g. section <literal>3x</literal> becomes
|
|
Packit |
e4b6da |
<literal>3</literal>). This option specifies which style.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="quotes-on-literals" select="false()" />
|
|
Packit |
e4b6da |
<doc:param name="quotes-on-literals" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Display quotes on <sgmltag class="element">literal</sgmltag>
|
|
Packit |
e4b6da |
elements?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
If true, render <sgmltag class="element">literal</sgmltag> elements
|
|
Packit |
e4b6da |
with quotes around them.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="show-comments" select="true()"/>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="show-comments" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Display <sgmltag>comment</sgmltag> elements?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>If true, comments will be displayed, otherwise they are suppressed.
|
|
Packit |
e4b6da |
Comments here refers to the <sgmltag>comment</sgmltag> element,
|
|
Packit |
e4b6da |
which will be renamed <sgmltag>remark</sgmltag> in DocBook V4.0,
|
|
Packit |
e4b6da |
not XML comments (<-- like this -->) which are unavailable.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="function-parens" select="false()" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="function-parens" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Generate parentheses after a function?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>If true, the formatting of
|
|
Packit |
e4b6da |
a <sgmltag class="starttag">function</sgmltag> element will include
|
|
Packit |
e4b6da |
generated parenthesis.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="xref-on-link" select="true()" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="xref-on-link" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Should <sgmltag class="element">link</sgmltag> generate a
|
|
Packit |
e4b6da |
cross-reference?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Man pages cannot render the hypertext links created by
|
|
Packit |
e4b6da |
class="element">link</sgmltag>. If this option is set, then the
|
|
Packit |
e4b6da |
stylesheet renders a cross reference to the target of the link.
|
|
Packit |
e4b6da |
(This may reduce clutter). Otherwise, only the content of the
|
|
Packit |
e4b6da |
class="element">link</sgmltag> is rendered and the actual link itself is
|
|
Packit |
e4b6da |
ignored.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="header-3" select="''" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="header-3" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Third header text</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Specifies the text of the third header of a man page,
|
|
Packit |
e4b6da |
typically the date for the man page. If empty, the
|
|
Packit |
e4b6da |
class="element">date</sgmltag> content for the
|
|
Packit |
e4b6da |
class="element">refentry</sgmltag> is used.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="header-4" select="''" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="header-4" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Fourth header text</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Specifies the text of the fourth header of a man page.
|
|
Packit |
e4b6da |
If empty, the <sgmltag class="element">refmiscinfo</sgmltag> content for
|
|
Packit |
e4b6da |
the <sgmltag class="element">refentry</sgmltag> is used.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="header-5" select="''" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="header-5" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Fifth header text</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
Specifies the text of the fifth header of a man page.
|
|
Packit |
e4b6da |
If empty, the <quote>manual name</quote>, that is, the title of the
|
|
Packit |
e4b6da |
<sgmltag class="element">book</sgmltag> or
|
|
Packit |
e4b6da |
class="element">reference</sgmltag> container is used.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="default-manpage-section" select="'1'" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="default-manpage-section" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Default man page section</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
The source document usually indicates the sections that each man page
|
|
Packit |
e4b6da |
should belong to (with <sgmltag class="element">manvolnum</sgmltag> in
|
|
Packit |
e4b6da |
<sgmltag class="element">refmeta</sgmltag>). In case the source
|
|
Packit |
e4b6da |
document does not indicate man-page sections, this option specifies the
|
|
Packit |
e4b6da |
default.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="custom-localization-file" select="''" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="custom-localization-file" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>URI of XML document containing custom localization data</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
This parameter specifies the URI of a XML document
|
|
Packit |
e4b6da |
that describes text translations (and other locale-specific information)
|
|
Packit |
e4b6da |
that is needed by the stylesheet to process the DocBook document.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
The text translations pointed to by this parameter always
|
|
Packit |
e4b6da |
override the default text translations
|
|
Packit |
e4b6da |
(from the internal parameter <parameter>localization-file</parameter>).
|
|
Packit |
e4b6da |
If a particular translation is not present here,
|
|
Packit |
e4b6da |
the corresponding default translation
|
|
Packit |
e4b6da |
is used as a fallback.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
This parameter is primarily for changing certain
|
|
Packit |
e4b6da |
punctuation characters used in formatting the source document.
|
|
Packit |
e4b6da |
The settings for punctuation characters are often specific
|
|
Packit |
e4b6da |
to the source document, but can also be dependent on the locale.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
To not use custom text translations, leave this parameter
|
|
Packit |
e4b6da |
as the empty string.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
select="document($custom-localization-file)" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="custom-l10n-data" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>XML document containing custom localization data</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
This parameter specifies the XML document
|
|
Packit |
e4b6da |
that describes text translations (and other locale-specific information)
|
|
Packit |
e4b6da |
that is needed by the stylesheet to process the DocBook document.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
This parameter is internal to the stylesheet.
|
|
Packit |
e4b6da |
To point to an external XML document with a URI or a file name,
|
|
Packit |
e4b6da |
you should use the <parameter>custom-localization-file</parameter>
|
|
Packit |
e4b6da |
parameter instead.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
However, inside a custom stylesheet
|
|
Packit |
e4b6da |
(<emphasis>not on the command-line</emphasis>)
|
|
Packit |
e4b6da |
this paramter can be set to the XPath expression
|
|
Packit |
e4b6da |
<literal>document('')</literal>,
|
|
Packit |
e4b6da |
which will cause the custom translations
|
|
Packit |
e4b6da |
directly embedded inside the custom stylesheet to be read.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<xsl:param name="author-othername-in-middle" select="1"/>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<doc:param name="author-othername-in-middle" xmlns="">
|
|
Packit |
e4b6da |
<refpurpose>Is <sgmltag>othername</sgmltag> in <sgmltag>author</sgmltag> a
|
|
Packit |
e4b6da |
middle name?</refpurpose>
|
|
Packit |
e4b6da |
<refdescription>
|
|
Packit |
e4b6da |
<para>If true, the <sgmltag>othername</sgmltag> of an <sgmltag>author</sgmltag>
|
|
Packit |
e4b6da |
appears between the <sgmltag>firstname</sgmltag> and
|
|
Packit |
e4b6da |
<sgmltag>surname</sgmltag>. Otherwise, <sgmltag>othername</sgmltag>
|
|
Packit |
e4b6da |
is suppressed.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
</refdescription>
|
|
Packit |
e4b6da |
</doc:param>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
</xsl:stylesheet>
|
|
Packit |
e4b6da |
|