diff options
| author | Anas Nashif <anas.nashif@intel.com> | 2012-11-08 13:38:28 -0800 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2012-11-08 13:38:28 -0800 |
| commit | 0cafa2afa8b68e48cbaac4a67c6d5929ed385574 (patch) | |
| tree | e8815e7ef185ccaba26bcd616eace378572b922e /params | |
| download | docbook-xsl-0cafa2afa8b68e48cbaac4a67c6d5929ed385574.tar.gz docbook-xsl-0cafa2afa8b68e48cbaac4a67c6d5929ed385574.tar.bz2 docbook-xsl-0cafa2afa8b68e48cbaac4a67c6d5929ed385574.zip | |
Imported Upstream version 1.77.1HEADupstream/1.77.1submit/tizen/20130517.020841submit/tizen/20130509.173846submit/tizen/20130503.191006submit/tizen/20130503.184845upstreamtizen
Diffstat (limited to 'params')
692 files changed, 25802 insertions, 0 deletions
diff --git a/params/abstract.notitle.enabled.xml b/params/abstract.notitle.enabled.xml new file mode 100644 index 0000000..1771f72 --- /dev/null +++ b/params/abstract.notitle.enabled.xml @@ -0,0 +1,22 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="abstract.notitle.enabled"> +<refmeta> +<refentrytitle>abstract.notitle.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>abstract.notitle.enabled</refname> +<refpurpose>Suppress display of abstract titles?</refpurpose> +</refnamediv> +<refsynopsisdiv> + <src:fragment xml:id="abstract.notitle.enabled.frag"><xsl:param name="abstract.notitle.enabled" select="0"/></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, in output of the <tag>abstract</tag> element on titlepages, +display of the abstract title is suppressed.</para> +</refsection> +</refentry> diff --git a/params/abstract.properties.xml b/params/abstract.properties.xml new file mode 100644 index 0000000..e802312 --- /dev/null +++ b/params/abstract.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="abstract.properties"> +<refmeta> +<refentrytitle>abstract.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>abstract.properties</refname> +<refpurpose>Properties associated with the block surrounding an abstract</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="abstract.properties.frag"> +<xsl:attribute-set name="abstract.properties"> + <xsl:attribute name="start-indent">0.0in</xsl:attribute> + <xsl:attribute name="end-indent">0.0in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Block styling properties for abstract.</para> + +<para>See also <parameter>abstract.title.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/abstract.title.properties.xml b/params/abstract.title.properties.xml new file mode 100644 index 0000000..d01f70c --- /dev/null +++ b/params/abstract.title.properties.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="abstract.title.properties"> +<refmeta> +<refentrytitle>abstract.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>abstract.title.properties</refname> +<refpurpose>Properties for abstract titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="abstract.title.properties.frag"> +<xsl:attribute-set name="abstract.title.properties"> + <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"/></xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"/></xsl:attribute> + <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"/></xsl:attribute> + <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"/></xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="text-align">center</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties for abstract titles.</para> + +<para>See also <parameter>abstract.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/active.toc.xml b/params/active.toc.xml new file mode 100644 index 0000000..f56aee1 --- /dev/null +++ b/params/active.toc.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="active.toc"> +<refmeta> +<refentrytitle>active.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>active.toc</refname> +<refpurpose>Active ToCs?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="active.toc.frag"> +<xsl:param name="active.toc" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, JavaScript is used to keep the ToC and the current slide +<quote>in sync</quote>. That is, each time the slide changes, the corresponding +ToC entry will be underlined.</para> + +</refsection> +</refentry> diff --git a/params/ade.extensions.xml b/params/ade.extensions.xml new file mode 100644 index 0000000..479591b --- /dev/null +++ b/params/ade.extensions.xml @@ -0,0 +1,32 @@ +<?xml version="1.0"?> +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" + xml:id="ade.extensions"> + <refmeta> + <refentrytitle>ade.extensions</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ade.extensions</refname> + <refpurpose>Enable Adobe Digitial Editions extensions for ePub rendering?</refpurpose> + </refnamediv> + <refsynopsisdiv> + <src:fragment xml:id="ade.extensions.frag"> + <xsl:param name="ade.extensions" select="0"/> + </src:fragment> + </refsynopsisdiv> + <refsection> + <info> + <title>Description</title> + </info> + <para>If non-zero, +<link xlink:href="http://www.adobe.com/products/digitaleditions/">Adobe Digital Editions</link> +extensions will be used when rendering to ePub output. Adobe Digital Editions extensions consists +rendering and layout extensions.</para> + <para>This parameter can also affect which graphics file formats are supported.</para> + </refsection> +</refentry> diff --git a/params/admon.graphics.extension.xml b/params/admon.graphics.extension.xml new file mode 100644 index 0000000..f655566 --- /dev/null +++ b/params/admon.graphics.extension.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admon.graphics.extension"> +<refmeta> +<refentrytitle>admon.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.extension</refname> +<refpurpose>Filename extension for admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admon.graphics.extension.frag"> +<xsl:param name="admon.graphics.extension">.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename extension to use on admonition graphics.</para> + +<itemizedlist> + <para>The DocBook XSL distribution provides admonition graphics in the following formats:</para> + <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem> + <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem> + <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem> + <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)</para></listitem> +</itemizedlist> + +</refsection> +</refentry> diff --git a/params/admon.graphics.path.xml b/params/admon.graphics.path.xml new file mode 100644 index 0000000..32b12b1 --- /dev/null +++ b/params/admon.graphics.path.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admon.graphics.path"> +<refmeta> +<refentrytitle>admon.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.path</refname> +<refpurpose>Path to admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admon.graphics.path.frag"><xsl:param name="admon.graphics.path">images/</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the path to the directory containing the admonition graphics +(caution.png, important.png etc). This location is normally relative +to the output html directory. See <parameter>base.dir</parameter></para> + +</refsection> +</refentry> diff --git a/params/admon.graphics.xml b/params/admon.graphics.xml new file mode 100644 index 0000000..f5e5ae4 --- /dev/null +++ b/params/admon.graphics.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admon.graphics"> +<refmeta> +<refentrytitle>admon.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics</refname> +<refpurpose>Use graphics in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admon.graphics.frag"> +<xsl:param name="admon.graphics" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), admonitions are presented in an alternate style that uses +a graphic. Default graphics are provided in the distribution. +</para> + +</refsection> +</refentry> diff --git a/params/admon.style.xml b/params/admon.style.xml new file mode 100644 index 0000000..5abe022 --- /dev/null +++ b/params/admon.style.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admon.style"> +<refmeta> +<refentrytitle>admon.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.style</refname> +<refpurpose>Specifies the CSS style attribute that should be added to +admonitions.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admon.style.frag"><xsl:param name="admon.style"> + <xsl:value-of select="concat('margin-', $direction.align.start, + ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"/> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the value of the CSS <tag class="attribute">style</tag> +attribute that should be added to admonitions. +</para> + +</refsection> +</refentry> diff --git a/params/admon.textlabel.xml b/params/admon.textlabel.xml new file mode 100644 index 0000000..ea1a53f --- /dev/null +++ b/params/admon.textlabel.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admon.textlabel"> +<refmeta> +<refentrytitle>admon.textlabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.textlabel</refname> +<refpurpose>Use text label in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admon.textlabel.frag"> +<xsl:param name="admon.textlabel" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), admonitions are presented with a generated +text label such as Note or Warning in the appropriate language. +If zero, such labels are turned off, but any title child +of the admonition element are still output. +The default value is 1. +</para> + +</refsection> +</refentry> diff --git a/params/admonition.properties.xml b/params/admonition.properties.xml new file mode 100644 index 0000000..4dddd26 --- /dev/null +++ b/params/admonition.properties.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admonition.properties"> +<refmeta> + <refentrytitle>admonition.properties</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admonition.properties</refname> +<refpurpose>To set the style for admonitions.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admonition.properties.frag"><xsl:attribute-set name="admonition.properties"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>How do you want admonitions styled? </para> +<para>Set the font-size, weight, etc. to the style required</para> + +</refsection> +</refentry> diff --git a/params/admonition.title.properties.xml b/params/admonition.title.properties.xml new file mode 100644 index 0000000..7af23e6 --- /dev/null +++ b/params/admonition.title.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="admonition.title.properties"> + +<refmeta> + <refentrytitle>admonition.title.properties</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admonition.title.properties</refname> +<refpurpose>To set the style for admonitions titles.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="admonition.title.properties.frag"> +<xsl:attribute-set name="admonition.title.properties"> + <xsl:attribute name="font-size">14pt</xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>How do you want admonitions titles styled? </para> +<para>Set the font-size, weight etc to the style required.</para> + +</refsection> +</refentry> diff --git a/params/alignment.xml b/params/alignment.xml new file mode 100644 index 0000000..9c0a3de --- /dev/null +++ b/params/alignment.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="alignment"> +<refmeta> +<refentrytitle>alignment</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> + <refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> + <refmiscinfo class="other" otherclass="value">left</refmiscinfo> + <refmiscinfo class="other" otherclass="value">start</refmiscinfo> + <refmiscinfo class="other" otherclass="value">right</refmiscinfo> + <refmiscinfo class="other" otherclass="value">end</refmiscinfo> + <refmiscinfo class="other" otherclass="value">center</refmiscinfo> + <refmiscinfo class="other" otherclass="value">justify</refmiscinfo> +</refmeta> +<refnamediv> +<refname>alignment</refname> +<refpurpose>Specify the default text alignment</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="alignment.frag"><xsl:param name="alignment">justify</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The default text alignment is used for most body text. +Allowed values are +<literal>left</literal>, +<literal>right</literal>, +<literal>start</literal>, +<literal>end</literal>, +<literal>center</literal>, +<literal>justify</literal>. +The default value is <literal>justify</literal>. +</para> + +</refsection> +</refentry> diff --git a/params/annotate.toc.xml b/params/annotate.toc.xml new file mode 100644 index 0000000..667fa32 --- /dev/null +++ b/params/annotate.toc.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotate.toc"> +<refmeta> +<refentrytitle>annotate.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotate.toc</refname> +<refpurpose>Annotate the Table of Contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotate.toc.frag"><xsl:param name="annotate.toc" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, TOCs will be annotated. At present, this just means +that the <tag>refpurpose</tag> of <tag>refentry</tag> +TOC entries will be displayed. +</para> + +</refsection> +</refentry> diff --git a/params/annotation.css.xml b/params/annotation.css.xml new file mode 100644 index 0000000..560c56a --- /dev/null +++ b/params/annotation.css.xml @@ -0,0 +1,71 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotation.css"> +<refmeta> +<refentrytitle>annotation.css</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.css</refname> +<refpurpose>CSS rules for annotations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotation.css.frag"> +<xsl:param name="annotation.css"> +/* ====================================================================== + Annotations +*/ + +div.annotation-list { visibility: hidden; + } + +div.annotation-nocss { position: absolute; + visibility: hidden; + } + +div.annotation-popup { position: absolute; + z-index: 4; + visibility: hidden; + padding: 0px; + margin: 2px; + border-style: solid; + border-width: 1px; + width: 200px; + background-color: white; + } + +div.annotation-title { padding: 1px; + font-weight: bold; + border-bottom-style: solid; + border-bottom-width: 1px; + color: white; + background-color: black; + } + +div.annotation-body { padding: 2px; + } + +div.annotation-body p { margin-top: 0px; + padding-top: 0px; + } + +div.annotation-close { position: absolute; + top: 2px; + right: 2px; + } +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>annotation.support</parameter> is enabled and the +document contains <tag>annotation</tag>s, then the CSS in this +parameter will be included in the document.</para> + +</refsection> +</refentry> diff --git a/params/annotation.graphic.close.xml b/params/annotation.graphic.close.xml new file mode 100644 index 0000000..002ebb4 --- /dev/null +++ b/params/annotation.graphic.close.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotation.graphic.close"> +<refmeta> +<refentrytitle>annotation.graphic.close</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.graphic.close</refname> +<refpurpose>Image for identifying a link that closes an annotation popup</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotation.graphic.close.frag"> +<xsl:param name="annotation.graphic.close"> +http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This image is used on popup annotations as the “x” that the +user can click to dismiss the popup.</para> +<para>This image is used on popup annotations as the “x” that the user can +click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para> + +</refsection> +</refentry> diff --git a/params/annotation.graphic.open.xml b/params/annotation.graphic.open.xml new file mode 100644 index 0000000..c7d1c32 --- /dev/null +++ b/params/annotation.graphic.open.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotation.graphic.open"> +<refmeta> +<refentrytitle>annotation.graphic.open</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.graphic.open</refname> +<refpurpose>Image for identifying a link that opens an annotation popup</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotation.graphic.open.frag"> +<xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/release/images/annot-open.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This image is used inline to identify the location of +annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para> + +</refsection> +</refentry> diff --git a/params/annotation.js.xml b/params/annotation.js.xml new file mode 100644 index 0000000..6c7e97e --- /dev/null +++ b/params/annotation.js.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotation.js"> +<refmeta> +<refentrytitle>annotation.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.js</refname> +<refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotation.js.frag"> + +<xsl:param name="annotation.js"> +<xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text></xsl:param> + +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <property>annotation.support</property> is enabled and the +document contains <tag>annotation</tag>s, then the URIs listed +in this parameter will be included. These JavaScript files are required +for popup annotation support.</para> + +</refsection> +</refentry> diff --git a/params/annotation.support.xml b/params/annotation.support.xml new file mode 100644 index 0000000..29e7633 --- /dev/null +++ b/params/annotation.support.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="annotation.support"> +<refmeta> +<refentrytitle>annotation.support</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotation.support</refname> +<refpurpose>Enable annotations?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="annotation.support.frag"> +<xsl:param name="annotation.support" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the stylesheets will attempt to support annotation +elements in HTML by including some JavaScript (see +<parameter>annotation.js</parameter>).</para> + +</refsection> +</refentry> diff --git a/params/appendix.autolabel.xml b/params/appendix.autolabel.xml new file mode 100644 index 0000000..bae38fa --- /dev/null +++ b/params/appendix.autolabel.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="appendix.autolabel"> +<refmeta> +<refentrytitle>appendix.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>appendix.autolabel</refname> +<refpurpose>Specifies the labeling format for Appendix titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="appendix.autolabel.frag"> +<xsl:param name="appendix.autolabel">A</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then appendices will be numbered using the +parameter value as the number format if the value matches one of the +following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (upperalpha). +</para> + +</refsection> +</refentry> diff --git a/params/arbortext.extensions.xml b/params/arbortext.extensions.xml new file mode 100644 index 0000000..2e571dd --- /dev/null +++ b/params/arbortext.extensions.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="arbortext.extensions"> +<refmeta> +<refentrytitle>arbortext.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>arbortext.extensions</refname> +<refpurpose>Enable Arbortext extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="arbortext.extensions.frag"><xsl:param name="arbortext.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +<link xlink:href="http://www.arbortext.com/">Arbortext</link> +extensions will be used. +</para> +<para>This parameter can also affect which graphics file formats +are supported</para> + +</refsection> +</refentry> diff --git a/params/article.appendix.title.properties.xml b/params/article.appendix.title.properties.xml new file mode 100644 index 0000000..61337a1 --- /dev/null +++ b/params/article.appendix.title.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="article.appendix.title.properties"> +<refmeta> +<refentrytitle>article.appendix.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>article.appendix.title.properties</refname> +<refpurpose>Properties for appendix titles that appear in an article</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="article.appendix.title.properties.frag"> +<xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties"> + <xsl:attribute name="margin-{$direction.align.start}"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties for the title of an appendix that +appears inside an article. The default is to use +the properties of sect1 titles.</para> + +</refsection> +</refentry> diff --git a/params/author.othername.in.middle.xml b/params/author.othername.in.middle.xml new file mode 100644 index 0000000..4ad21dd --- /dev/null +++ b/params/author.othername.in.middle.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="author.othername.in.middle"> +<refmeta> +<refentrytitle>author.othername.in.middle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>author.othername.in.middle</refname> +<refpurpose>Is <tag>othername</tag> in <tag>author</tag> a +middle name?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="author.othername.in.middle.frag"> +<xsl:param name="author.othername.in.middle" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the <tag>othername</tag> of an <tag>author</tag> +appears between the <tag>firstname</tag> and +<tag>surname</tag>. Otherwise, <tag>othername</tag> +is suppressed. +</para> + +</refsection> +</refentry> diff --git a/params/autolayout-file.xml b/params/autolayout-file.xml new file mode 100644 index 0000000..150f123 --- /dev/null +++ b/params/autolayout-file.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="autolayout-file"> +<refmeta> +<refentrytitle>autolayout-file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autolayout-file</refname> +<refpurpose>Identifies the autolayout.xml file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="autolayout-file.frag"> +<xsl:param name="autolayout-file">autolayout.xml</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>When the source pages are spread over several directories, this +parameter can be set (for example, from the command line of a batch-mode +XSLT processor) to indicate the location of the autolayout.xml file.</para> +<para>FIXME: for browser-based use, there needs to be a PI for this... +</para> +</refsection> +</refentry> diff --git a/params/autotoc.label.in.hyperlink.xml b/params/autotoc.label.in.hyperlink.xml new file mode 100644 index 0000000..dced0bd --- /dev/null +++ b/params/autotoc.label.in.hyperlink.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="autotoc.label.in.hyperlink"> +<refmeta> +<refentrytitle>autotoc.label.in.hyperlink</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autotoc.label.in.hyperlink</refname> +<refpurpose>Include label in hyperlinked titles in TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="autotoc.label.in.hyperlink.frag"><xsl:param name="autotoc.label.in.hyperlink" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels +are included in hyperlinked titles in the TOC. If it is instead zero, +labels are still displayed prior to the hyperlinked titles, but +are not hyperlinked along with the titles.</para> + +</refsection> +</refentry> diff --git a/params/autotoc.label.separator.xml b/params/autotoc.label.separator.xml new file mode 100644 index 0000000..b9cd53a --- /dev/null +++ b/params/autotoc.label.separator.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="autotoc.label.separator"> +<refmeta> +<refentrytitle>autotoc.label.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autotoc.label.separator</refname> +<refpurpose>Separator between labels and titles in the ToC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="autotoc.label.separator.frag"> +<xsl:param name="autotoc.label.separator">. </xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>String used to separate labels and titles in a table of contents.</para> + +</refsection> +</refentry> diff --git a/params/axf.extensions.xml b/params/axf.extensions.xml new file mode 100644 index 0000000..940a187 --- /dev/null +++ b/params/axf.extensions.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="axf.extensions"> +<refmeta> +<refentrytitle>axf.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>axf.extensions</refname> +<refpurpose>Enable XSL Formatter extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="axf.extensions.frag"> +<xsl:param name="axf.extensions" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +<link xlink:href="http://www.antennahouse.com/">XSL Formatter</link> +extensions will be used. XSL Formatter extensions consists of PDF bookmarks, +document information and better index processing.</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> + +</refsection> +</refentry> diff --git a/params/banner.before.navigation.xml b/params/banner.before.navigation.xml new file mode 100644 index 0000000..0883378 --- /dev/null +++ b/params/banner.before.navigation.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="banner.before.navigation"> +<refmeta> +<refentrytitle>banner.before.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>banner.before.navigation</refname> +<refpurpose>Put banner before navigation?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="banner.before.navigation.frag"> +<xsl:param name="banner.before.navigation" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>FIXME</para> +</refsection> +</refentry> diff --git a/params/base.dir.xml b/params/base.dir.xml new file mode 100644 index 0000000..4abf9c7 --- /dev/null +++ b/params/base.dir.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="base.dir"> +<refmeta> +<refentrytitle>base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>base.dir</refname> +<refpurpose>The base directory of chunks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="base.dir.frag"> +<xsl:param name="base.dir"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If specified, the <parameter>base.dir</parameter> parameter identifies +the output directory for chunks. (If not specified, the output directory +is system dependent.)</para> + +<para>Starting with version 1.77 of the stylesheets, +the param's value will have a trailing slash added if it does +not already have one.</para> + +<caution><para>Do not use <parameter>base.dir</parameter> +to add a filename prefix string to chunked files. +Instead, use the <parameter>chunked.filename.prefix</parameter> +parameter.</para></caution> + +</refsection> +</refentry> diff --git a/params/biblioentry.item.separator.xml b/params/biblioentry.item.separator.xml new file mode 100644 index 0000000..4a56ad6 --- /dev/null +++ b/params/biblioentry.item.separator.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="biblioentry.item.separator"> +<refmeta> +<refentrytitle>biblioentry.item.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>biblioentry.item.separator</refname> +<refpurpose>Text to separate bibliography entries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="biblioentry.item.separator.frag"><xsl:param name="biblioentry.item.separator">. </xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Text to separate bibliography entries +</para> + +</refsection> +</refentry> diff --git a/params/biblioentry.properties.xml b/params/biblioentry.properties.xml new file mode 100644 index 0000000..9e88ddb --- /dev/null +++ b/params/biblioentry.properties.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="biblioentry.properties"> +<refmeta> + <refentrytitle>biblioentry.properties</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>biblioentry.properties</refname> +<refpurpose>To set the style for biblioentry.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="biblioentry.properties.frag"><xsl:attribute-set name="biblioentry.properties" use-attribute-sets="normal.para.spacing"> + <xsl:attribute name="start-indent">0.5in</xsl:attribute> + <xsl:attribute name="text-indent">-0.5in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>How do you want biblioentry styled? </para> +<para>Set the font-size, weight, space-above and space-below, indents, etc. to the style required</para> + +</refsection> +</refentry> diff --git a/params/bibliography.collection.xml b/params/bibliography.collection.xml new file mode 100644 index 0000000..9245405 --- /dev/null +++ b/params/bibliography.collection.xml @@ -0,0 +1,122 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="bibliography.collection"> +<refmeta> +<refentrytitle>bibliography.collection</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.collection</refname> +<refpurpose>Name of the bibliography collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="bibliography.collection.frag"> +<xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param> + +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Maintaining bibliography entries across a set of documents is tedious, time +consuming, and error prone. It makes much more sense, usually, to store all of +the bibliography entries in a single place and simply <quote>extract</quote> +the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>bibliography.collection</parameter> parameter. To setup a global +bibliography <quote>database</quote>, follow these steps:</para> + +<para>First, create a stand-alone bibliography document that contains all of +the documents that you wish to reference. Make sure that each bibliography +entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>) +has an ID.</para> + +<para>My global bibliography, <filename>~/bibliography.xml</filename> begins +like this:</para> + +<informalexample> +<programlisting><!DOCTYPE bibliography + PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<bibliography><title>References</title> + +<bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray, +Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors. +<citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup +Language (XML) 1.0 Second Edition</ulink></citetitle>. +World Wide Web Consortium, 2000. +</bibliomixed> + +<bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray, +Dave Hollander, +and Andrew Layman, editors. +<citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in +XML</ulink></citetitle>. +World Wide Web Consortium, 1999. +</bibliomixed> + +<!-- ... --> +</bibliography> +</programlisting> +</informalexample> + +<para>When you create a bibliography in your document, simply +provide <emphasis>empty</emphasis> <tag>bibliomixed</tag> +entries for each document that you wish to cite. Make sure that these +elements have the same ID as the corresponding <quote>real</quote> +entry in your global bibliography.</para> + +<para>For example:</para> + +<informalexample> +<programlisting><bibliography><title>Bibliography</title> + +<bibliomixed id="xml-rec"/> +<bibliomixed id="xml-names"/> +<bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and +Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley, +1986. ISBN 0-201-13437-3. +</bibliomixed> +<bibliomixed id="relaxng"/> + +</bibliography></programlisting> +</informalexample> + +<para>Note that it's perfectly acceptable to mix entries from your +global bibliography with <quote>normal</quote> entries. You can use +<tag>xref</tag> or other elements to cross-reference your +bibliography entries in exactly the same way you do now.</para> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>bibliography.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global bibliography.</para> + +<para>A relative path in the parameter is interpreted in one +of two ways:</para> +<orderedlist numeration="loweralpha"> + <listitem> + <para>If your document contains no links to empty bibliographic elements, + then the path is relative to the file containing + the first <tag>bibliomixed</tag> element in the document.</para> + </listitem> + <listitem> + <para>If your document does contain links to empty bibliographic elements, + then the path is relative to the file containing + the first such link element in the document.</para> + </listitem> +</orderedlist> +<para>Once the collection file is opened by the first instance described +above, it stays open for the current document +and the relative path is not reinterpreted again.</para> + +<para>The stylesheets will format the bibliography in your document as if +all of the entries referenced appeared there literally.</para> + +</refsection> +</refentry> diff --git a/params/bibliography.numbered.xml b/params/bibliography.numbered.xml new file mode 100644 index 0000000..593a1fa --- /dev/null +++ b/params/bibliography.numbered.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="bibliography.numbered"> +<refmeta> +<refentrytitle>bibliography.numbered</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.numbered</refname> +<refpurpose>Should bibliography entries be numbered?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="bibliography.numbered.frag"> +<xsl:param name="bibliography.numbered" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero bibliography entries will be numbered</para> + +</refsection> +</refentry> diff --git a/params/bibliography.style.xml b/params/bibliography.style.xml new file mode 100644 index 0000000..fa44582 --- /dev/null +++ b/params/bibliography.style.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="5.0" xml:id="bibliography.style">
+<refmeta>
+<refentrytitle>bibliography.style</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
+<refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
+<refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>bibliography.style</refname>
+<refpurpose>Style used for formatting of biblioentries.</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id='bibliography.style.frag'>
+<xsl:param name="bibliography.style">normal</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>Currently only <literal>normal</literal> and
+<literal>iso690</literal> styles are supported.</para>
+
+<para>In order to use ISO690 style to the full extent you might need
+to use additional markup described on <link
+xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
+following WiKi page</link>.</para>
+
+</refsection>
+</refentry>
diff --git a/params/blockquote.properties.xml b/params/blockquote.properties.xml new file mode 100644 index 0000000..76d7f1c --- /dev/null +++ b/params/blockquote.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="blockquote.properties"> +<refmeta> + <refentrytitle>blockquote.properties</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>blockquote.properties</refname> +<refpurpose>To set the style for block quotations.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="blockquote.properties.frag"> +<xsl:attribute-set name="blockquote.properties"> +<xsl:attribute name="margin-{$direction.align.start}">0.5in</xsl:attribute> +<xsl:attribute name="margin-{$direction.align.end}">0.5in</xsl:attribute> +<xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> +<xsl:attribute name="space-after.optimum">1em</xsl:attribute> +<xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>blockquote.properties</parameter> attribute set specifies +the formating properties of block quotations.</para> + +</refsection> +</refentry> diff --git a/params/blurb.on.titlepage.enabled.xml b/params/blurb.on.titlepage.enabled.xml new file mode 100644 index 0000000..27e89d7 --- /dev/null +++ b/params/blurb.on.titlepage.enabled.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="blurb.on.titlepage.enabled"> +<refmeta> +<refentrytitle>blurb.on.titlepage.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>blurb.on.titlepage.enabled</refname> +<refpurpose>Display personblurb and authorblurb on title pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="blurb.on.titlepage.enabled.frag"> +<xsl:param name="blurb.on.titlepage.enabled" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, output from <tag>authorblurb</tag> and +<tag>personblurb</tag> elements is displayed on title pages. If zero +(the default), output from those elements is suppressed on title pages +(unless you are using a <literal>titlepage</literal> customization +that causes them to be included).</para> + +</refsection> +</refentry> diff --git a/params/body.attributes.xml b/params/body.attributes.xml new file mode 100644 index 0000000..8ee1ad9 --- /dev/null +++ b/params/body.attributes.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.attributes"> +<refmeta> +<refentrytitle>body.attributes</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.attributes</refname> +<refpurpose>DEPRECATED</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.attributes.frag"> +<xsl:attribute-set name="body.attributes"> + <xsl:attribute name="bgcolor">white</xsl:attribute> + <xsl:attribute name="text">black</xsl:attribute> + <xsl:attribute name="link">#0000FF</xsl:attribute> + <xsl:attribute name="vlink">#840084</xsl:attribute> + <xsl:attribute name="alink">#0000FF</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>DEPRECATED</para> +</refsection> +</refentry> diff --git a/params/body.bg.color.xml b/params/body.bg.color.xml new file mode 100644 index 0000000..8315b85 --- /dev/null +++ b/params/body.bg.color.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.bg.color"> +<refmeta> +<refentrytitle>body.bg.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.bg.color</refname> +<refpurpose>Background color for body frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.bg.color.frag"> +<xsl:param name="body.bg.color">#FFFFFF</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the background color used in the body column of +tabular slides.</para> + +</refsection> +</refentry> diff --git a/params/body.end.indent.xml b/params/body.end.indent.xml new file mode 100644 index 0000000..a5e098c --- /dev/null +++ b/params/body.end.indent.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.end.indent"> +<refmeta> +<refentrytitle>body.end.indent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.end.indent</refname> +<refpurpose>The end-indent for the body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.end.indent.frag"> +<xsl:param name="body.end.indent">0pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This end-indent property is added to the fo:flow +for certain page sequences. Which page-sequences it is +applied to is determined by the template named +<literal>set.flow.properties</literal>. +By default, that template adds it to the flow +for page-sequences using the <quote>body</quote> +master-reference, as well as appendixes and prefaces. +</para> + +<para>See also <parameter>body.start.indent</parameter>. +</para> + +</refsection> +</refentry> diff --git a/params/body.font.family.xml b/params/body.font.family.xml new file mode 100644 index 0000000..816deb4 --- /dev/null +++ b/params/body.font.family.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.font.family"> +<refmeta> +<refentrytitle>body.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.font.family</refname> +<refpurpose>The default font family for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.font.family.frag"> +<xsl:param name="body.font.family">serif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The body font family is the default font used for text in the page body.</para> +<para>If more than one font is required, enter the font names, +separated by a comma, e.g.</para> +<literallayout> + <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param> + +</literallayout> + +</refsection> +</refentry> diff --git a/params/body.font.master.xml b/params/body.font.master.xml new file mode 100644 index 0000000..323a6a0 --- /dev/null +++ b/params/body.font.master.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.font.master"> +<refmeta> +<refentrytitle>body.font.master</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.font.master</refname> +<refpurpose>Specifies the default point size for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.font.master.frag"> +<xsl:param name="body.font.master">10</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The body font size is specified in two parameters +(<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>) +so that math can be performed on the font size by XSLT. +</para> + +</refsection> +</refentry> diff --git a/params/body.font.size.xml b/params/body.font.size.xml new file mode 100644 index 0000000..fc35ade --- /dev/null +++ b/params/body.font.size.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.font.size"> +<refmeta> +<refentrytitle>body.font.size</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.font.size</refname> +<refpurpose>Specifies the default font size for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.font.size.frag"> +<xsl:param name="body.font.size"> + <xsl:value-of select="$body.font.master"/><xsl:text>pt</xsl:text> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The body font size is specified in two parameters +(<parameter>body.font.master</parameter> and <parameter>body.font.size</parameter>) +so that math can be performed on the font size by XSLT. +</para> + +</refsection> +</refentry> diff --git a/params/body.margin.bottom.xml b/params/body.margin.bottom.xml new file mode 100644 index 0000000..2302f64 --- /dev/null +++ b/params/body.margin.bottom.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.margin.bottom"> +<refmeta> +<refentrytitle>body.margin.bottom</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.margin.bottom</refname> +<refpurpose>The bottom margin of the body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.margin.bottom.frag"> +<xsl:param name="body.margin.bottom">0.5in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The body bottom margin is the distance from the last line of text +in the page body to the bottom of the region-after. +</para> + +</refsection> +</refentry> diff --git a/params/body.margin.inner.xml b/params/body.margin.inner.xml new file mode 100644 index 0000000..d1d514e --- /dev/null +++ b/params/body.margin.inner.xml @@ -0,0 +1,52 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.margin.inner"> +<refmeta> +<refentrytitle>body.margin.inner</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.margin.inner</refname> +<refpurpose>Specify the size of the inner margin of the body region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.margin.inner.frag"> +<xsl:param name="body.margin.inner">0in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The inner body margin is the extra inner side +(binding side) margin taken from the body +region in addition to the inner page margin. +It makes room for a side region for text content whose width is +specified by the <parameter>region.inner.extent</parameter> +parameter.</para> + +<para>For double-sided output, +this side region +is <literal>fo:region-start</literal> on a odd-numbered page, +and <literal>fo:region-end</literal> on an even-numbered page.</para> + +<para>For single-sided output, +this side region +is <literal>fo:region-start</literal> for all pages.</para> + +<para>This correspondence applies to all languages, +both left-to-right and right-to-left writing modes.</para> + +<para>The default value is zero.</para> + +<para>See also +<parameter>region.inner.extent</parameter>, +<parameter>region.outer.extent</parameter>, +<parameter>body.margin.outer</parameter>, +<parameter>side.region.precedence</parameter>. +</para> +</refsection> +</refentry> diff --git a/params/body.margin.outer.xml b/params/body.margin.outer.xml new file mode 100644 index 0000000..85c57fa --- /dev/null +++ b/params/body.margin.outer.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.margin.outer"> +<refmeta> +<refentrytitle>body.margin.outer</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.margin.outer</refname> +<refpurpose>Specify the size of the outer margin of the body region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.margin.outer.frag"> +<xsl:param name="body.margin.outer">0in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The outer body margin is the extra outer side +(opposite the binding side) margin taken +from the body +region in addition to the outer page margin. +It makes room for a side region for text content whose width is +specified by the <parameter>region.outer.extent</parameter> +parameter.</para> + +<para>For double-sided output, +this side region +is <literal>fo:region-end</literal> on a odd-numbered page, +and <literal>fo:region-start</literal> on an even-numbered page.</para> + +<para>For single-sided output, +this side region +is <literal>fo:region-end</literal> for all pages.</para> + +<para>This correspondence applies to all languages, +both left-to-right and right-to-left writing modes.</para> + +<para>The default value is zero.</para> + +<para>See also +<parameter>region.inner.extent</parameter>, +<parameter>region.outer.extent</parameter>, +<parameter>body.margin.inner</parameter>, +<parameter>side.region.precedence</parameter>. +</para> +</refsection> +</refentry> diff --git a/params/body.margin.top.xml b/params/body.margin.top.xml new file mode 100644 index 0000000..182bd9f --- /dev/null +++ b/params/body.margin.top.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.margin.top"> +<refmeta> +<refentrytitle>body.margin.top</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.margin.top</refname> +<refpurpose>To specify the size of the top margin of a page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.margin.top.frag"> +<xsl:param name="body.margin.top">0.5in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The body top margin is the distance from the top of the +region-before to the first line of text in the page body.</para> + +</refsection> +</refentry> diff --git a/params/body.start.indent.xml b/params/body.start.indent.xml new file mode 100644 index 0000000..4e348f1 --- /dev/null +++ b/params/body.start.indent.xml @@ -0,0 +1,64 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="body.start.indent"> +<refmeta> +<refentrytitle>body.start.indent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>body.start.indent</refname> +<refpurpose>The start-indent for the body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="body.start.indent.frag"> +<xsl:param name="body.start.indent"> + <xsl:choose> + <xsl:when test="$fop.extensions != 0">0pt</xsl:when> + <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when> + <xsl:otherwise>4pc</xsl:otherwise> + </xsl:choose> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter provides +the means of indenting the body text relative to +section titles. +For left-to-right text direction, it indents the left side. +For right-to-left text direction, it indents the right side. +It is used in place of the +<parameter>title.margin.left</parameter> for +all XSL-FO processors except FOP 0.25. +It enables support for side floats to appear +in the indented margin area. +</para> +<para>This start-indent property is added to the fo:flow +for certain page sequences. Which page-sequences it is +applied to is determined by the template named +<literal>set.flow.properties</literal>. +By default, that template adds it to the flow +for page-sequences using the <quote>body</quote> +master-reference, as well as appendixes and prefaces. +</para> +<para>If this parameter is used, section titles should have +a start-indent value of 0pt if they are to be +outdented relative to the body text. +</para> + +<para>If you are using FOP, then set this parameter to a zero +width value and set the <parameter>title.margin.left</parameter> +parameter to the negative value of the desired indent. +</para> + +<para>See also <parameter>body.end.indent</parameter> and +<parameter>title.margin.left</parameter>. +</para> + +</refsection> +</refentry> diff --git a/params/bookmarks.collapse.xml b/params/bookmarks.collapse.xml new file mode 100644 index 0000000..3320056 --- /dev/null +++ b/params/bookmarks.collapse.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="bookmarks.collapse"> +<refmeta> +<refentrytitle>bookmarks.collapse</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bookmarks.collapse</refname> +<refpurpose>Specifies the initial state of bookmarks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="bookmarks.collapse.frag"> +<xsl:param name="bookmarks.collapse" select="1"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the bookmark tree is collapsed so that only the +top-level bookmarks are displayed initially. Otherwise, the whole tree +of bookmarks is displayed.</para> + +<para>This parameter currently works with FOP 0.93 or later.</para> + +</refsection> +</refentry> diff --git a/params/bridgehead.in.toc.xml b/params/bridgehead.in.toc.xml new file mode 100644 index 0000000..490d556 --- /dev/null +++ b/params/bridgehead.in.toc.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="bridgehead.in.toc"> +<refmeta> +<refentrytitle>bridgehead.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bridgehead.in.toc</refname> +<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.in.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that +this option is not fully supported and may be removed in a future +version of the stylesheets. +</para> + +</refsection> +</refentry> diff --git a/params/bullet.image.xml b/params/bullet.image.xml new file mode 100644 index 0000000..acf2af5 --- /dev/null +++ b/params/bullet.image.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="bullet.image"> +<refmeta> +<refentrytitle>bullet.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bullet.image</refname> +<refpurpose>Bullet image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="bullet.image.frag"> +<xsl:param name="bullet.image">toc/bullet.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the bullet image used for foils in the +framed ToC.</para> + +</refsection> +</refentry> diff --git a/params/callout.defaultcolumn.xml b/params/callout.defaultcolumn.xml new file mode 100644 index 0000000..6cae381 --- /dev/null +++ b/params/callout.defaultcolumn.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.defaultcolumn"> +<refmeta> +<refentrytitle>callout.defaultcolumn</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.defaultcolumn</refname> +<refpurpose>Indicates what column callouts appear in by default</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.defaultcolumn.frag"> +<xsl:param name="callout.defaultcolumn">60</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If a callout does not identify a column (for example, if it uses +the <literal>linerange</literal> <tag class="attribute">unit</tag>), +it will appear in the default column. +</para> + +</refsection> +</refentry> diff --git a/params/callout.graphics.extension.xml b/params/callout.graphics.extension.xml new file mode 100644 index 0000000..febc690 --- /dev/null +++ b/params/callout.graphics.extension.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.graphics.extension"> +<refmeta> +<refentrytitle>callout.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.extension</refname> +<refpurpose>Filename extension for callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.graphics.extension.frag"> +<xsl:param condition="html" name="callout.graphics.extension">.png</xsl:param> +<xsl:param condition="fo" name="callout.graphics.extension">.svg</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Sets the filename extension to use on callout graphics. </para> + +<itemizedlist> +<para>The Docbook XSL distribution provides callout graphics in the following formats:</para> +<listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem> +<listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem> +<listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem> +</itemizedlist> +</refsection> +</refentry> diff --git a/params/callout.graphics.number.limit.xml b/params/callout.graphics.number.limit.xml new file mode 100644 index 0000000..cde5267 --- /dev/null +++ b/params/callout.graphics.number.limit.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.graphics.number.limit"> +<refmeta> +<refentrytitle>callout.graphics.number.limit</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.number.limit</refname> +<refpurpose>Number of the largest callout graphic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.graphics.number.limit.frag"> +<xsl:param condition="html" name="callout.graphics.number.limit">15</xsl:param> +<xsl:param condition="fo" name="callout.graphics.number.limit">30</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.graphics</parameter> is non-zero, graphics +are used to represent callout numbers instead of plain text. The value +of <parameter>callout.graphics.number.limit</parameter> is the largest +number for which a graphic exists. If the callout number exceeds this +limit, the default presentation "(plain text instead of a graphic)" +will be used. +</para> + +</refsection> +</refentry> diff --git a/params/callout.graphics.path.xml b/params/callout.graphics.path.xml new file mode 100644 index 0000000..00e54c1 --- /dev/null +++ b/params/callout.graphics.path.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.graphics.path"> +<refmeta> +<refentrytitle>callout.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.path</refname> +<refpurpose>Path to callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.graphics.path.frag"> +<xsl:param name="callout.graphics.path">images/callouts/</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the path to the directory holding the callout graphics. his +location is normally relative to the output html directory. see +base.dir. Always terminate the directory with / since the graphic file +is appended to this string, hence needs the separator. +</para> + +</refsection> +</refentry> diff --git a/params/callout.graphics.xml b/params/callout.graphics.xml new file mode 100644 index 0000000..a97ac0d --- /dev/null +++ b/params/callout.graphics.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.graphics"> +<refmeta> +<refentrytitle>callout.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics</refname> +<refpurpose>Use graphics for callouts?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.graphics.frag"> +<xsl:param name="callout.graphics" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, callouts are presented with graphics (e.g., reverse-video +circled numbers instead of "(1)", "(2)", etc.). +Default graphics are provided in the distribution. +</para> + +</refsection> +</refentry> diff --git a/params/callout.icon.size.xml b/params/callout.icon.size.xml new file mode 100644 index 0000000..d3acae8 --- /dev/null +++ b/params/callout.icon.size.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.icon.size"> +<refmeta> +<refentrytitle>callout.icon.size</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.icon.size</refname> +<refpurpose>Specifies the size of callout marker icons</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.icon.size.frag"> +<xsl:param name="callout.icon.size">7pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the size of the callout marker icons. +The default size is 7 points.</para> + +</refsection> +</refentry> diff --git a/params/callout.list.table.xml b/params/callout.list.table.xml new file mode 100644 index 0000000..6fece03 --- /dev/null +++ b/params/callout.list.table.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.list.table"> +<refmeta> +<refentrytitle>callout.list.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.list.table</refname> +<refpurpose>Present callout lists using a table?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.list.table.frag"> +<xsl:param name="callout.list.table" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The default presentation of <tag>calloutlist</tag>s uses +an HTML <tag>DL</tag> element. Some browsers don't align DLs very well +if <parameter>callout.graphics</parameter> is used. With this option +turned on, <tag>calloutlist</tag>s are presented in an HTML +<tag>TABLE</tag>, which usually results in better alignment +of the callout number with the callout description.</para> + +</refsection> +</refentry> diff --git a/params/callout.properties.xml b/params/callout.properties.xml new file mode 100644 index 0000000..d50b85f --- /dev/null +++ b/params/callout.properties.xml @@ -0,0 +1,23 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.properties"> +<refmeta> +<refentrytitle>callout.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.properties</refname> +<refpurpose>Properties that apply to the list-item generated by each callout within a calloutlist.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.properties.frag"><xsl:attribute-set name="callout.properties"> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to the fo:list-item generated by each callout within a calloutlist. Typically used to add spacing properties.</para> +</refsection> +</refentry> diff --git a/params/callout.unicode.font.xml b/params/callout.unicode.font.xml new file mode 100644 index 0000000..e63bffb --- /dev/null +++ b/params/callout.unicode.font.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.unicode.font"> +<refmeta> +<refentrytitle>callout.unicode.font</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.font</refname> +<refpurpose>Specify a font for Unicode glyphs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.unicode.font.frag"> +<xsl:param name="callout.unicode.font">ZapfDingbats</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The name of the font to specify around Unicode callout glyphs. +If set to the empty string, no font change will occur. +</para> + +</refsection> +</refentry> diff --git a/params/callout.unicode.number.limit.xml b/params/callout.unicode.number.limit.xml new file mode 100644 index 0000000..a9f1f3d --- /dev/null +++ b/params/callout.unicode.number.limit.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.unicode.number.limit"> +<refmeta> +<refentrytitle>callout.unicode.number.limit</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.number.limit</refname> +<refpurpose>Number of the largest unicode callout character</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.unicode.number.limit.frag"> +<xsl:param name="callout.unicode.number.limit">10</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.number.limit</parameter> +is +the largest number for which a unicode character exists. If the callout number +exceeds this limit, the default presentation "(nnn)" will always +be used. +</para> + +</refsection> +</refentry> diff --git a/params/callout.unicode.start.character.xml b/params/callout.unicode.start.character.xml new file mode 100644 index 0000000..2f03124 --- /dev/null +++ b/params/callout.unicode.start.character.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.unicode.start.character"> +<refmeta> +<refentrytitle>callout.unicode.start.character</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.start.character</refname> +<refpurpose>First Unicode character to use, decimal value.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.unicode.start.character.frag"> +<xsl:param name="callout.unicode.start.character">10102</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.start.character</parameter> +is the decimal unicode value used for callout number one. Currently, +only values 9312 and 10102 are supported in the stylesheets for this parameter. +</para> + +</refsection> +</refentry> diff --git a/params/callout.unicode.xml b/params/callout.unicode.xml new file mode 100644 index 0000000..4ec6a5f --- /dev/null +++ b/params/callout.unicode.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callout.unicode"> +<refmeta> +<refentrytitle>callout.unicode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode</refname> +<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callout.unicode.frag"><xsl:param name="callout.unicode" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option. +</para> + +</refsection> +</refentry> diff --git a/params/calloutlist.properties.xml b/params/calloutlist.properties.xml new file mode 100644 index 0000000..18976bd --- /dev/null +++ b/params/calloutlist.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="calloutlist.properties"> +<refmeta> +<refentrytitle>calloutlist.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>calloutlist.properties</refname> +<refpurpose>Properties that apply to each list-block generated by calloutlist.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="calloutlist.properties.frag"><xsl:attribute-set name="calloutlist.properties"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="provisional-distance-between-starts">2.2em</xsl:attribute> + <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to the fo:list-block generated by calloutlist. +Typically used to adjust spacing or margins of the entire list. +Change the <literal>provisional-distance-between-starts</literal> attribute to +change the indent of the list paragraphs relative to the +callout numbers.</para> +</refsection> +</refentry> diff --git a/params/callouts.extension.xml b/params/callouts.extension.xml new file mode 100644 index 0000000..80b5845 --- /dev/null +++ b/params/callouts.extension.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="callouts.extension"> +<refmeta> +<refentrytitle>callouts.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callouts.extension</refname> +<refpurpose>Enable the callout extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="callouts.extension.frag"> +<xsl:param name="callouts.extension" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<!-- DP. Note this is not used in the same manner as callout.graphics.extension --> +<para>The callouts extension processes <tag>areaset</tag> +elements in <tag>programlistingco</tag> and other text-based +callout elements. +</para> + +</refsection> +</refentry> diff --git a/params/chapter.autolabel.xml b/params/chapter.autolabel.xml new file mode 100644 index 0000000..32414bc --- /dev/null +++ b/params/chapter.autolabel.xml @@ -0,0 +1,71 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chapter.autolabel"> +<refmeta> +<refentrytitle>chapter.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>chapter.autolabel</refname> +<refpurpose>Specifies the labeling format for Chapter titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chapter.autolabel.frag"> +<xsl:param name="chapter.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then chapters will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (arabic). +</para> + +</refsection> +</refentry> diff --git a/params/chunk.append.xml b/params/chunk.append.xml new file mode 100644 index 0000000..1f65aad --- /dev/null +++ b/params/chunk.append.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.append"> +<refmeta> +<refentrytitle>chunk.append</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.append</refname> +<refpurpose>Specifies content to append to chunked HTML output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.append.frag"><xsl:param name="chunk.append"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies content to append to the end of HTML files output by +the <filename>html/chunk.xsl</filename> stylesheet, after the closing +<code><html></code> tag. You probably don’t want to set any value +for this parameter; but if you do, the only value it should ever be +set to is a newline character: <code>&#x0a;</code> or +<code>&#10;</code></para> + +</refsection> +</refentry> diff --git a/params/chunk.first.sections.xml b/params/chunk.first.sections.xml new file mode 100644 index 0000000..f0c1b82 --- /dev/null +++ b/params/chunk.first.sections.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.first.sections"> +<refmeta> +<refentrytitle>chunk.first.sections</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.first.sections</refname> +<refpurpose>Chunk the first top-level section?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.first.sections.frag"> +<xsl:param name="chunk.first.sections" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a chunk will be created for the first top-level +<tag>sect1</tag> or <tag>section</tag> elements in +each component. Otherwise, that section will be part of the chunk for +its parent. +</para> + +</refsection> +</refentry> diff --git a/params/chunk.quietly.xml b/params/chunk.quietly.xml new file mode 100644 index 0000000..8700b29 --- /dev/null +++ b/params/chunk.quietly.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.quietly"> +<refmeta> +<refentrytitle>chunk.quietly</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.quietly</refname> +<refpurpose>Omit the chunked filename messages.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.quietly.frag"> +<xsl:param name="chunk.quietly" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), the XSL processor emits a message naming +each separate chunk filename as it is being output. +If nonzero, then the messages are suppressed. +</para> + +</refsection> +</refentry> diff --git a/params/chunk.section.depth.xml b/params/chunk.section.depth.xml new file mode 100644 index 0000000..d46193c --- /dev/null +++ b/params/chunk.section.depth.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.section.depth"> +<refmeta> +<refentrytitle>chunk.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.section.depth</refname> +<refpurpose>Depth to which sections should be chunked</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.section.depth.frag"> +<xsl:param name="chunk.section.depth" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter sets the depth of section chunking.</para> + +</refsection> +</refentry> diff --git a/params/chunk.sections.xml b/params/chunk.sections.xml new file mode 100644 index 0000000..2ffb1a3 --- /dev/null +++ b/params/chunk.sections.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.sections"> +<refmeta> +<refentrytitle>chunk.sections</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.sections</refname> +<refpurpose>Should top-level sections be chunks in their own right?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.sections.frag"> +<xsl:param name="chunk.sections" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, chunks will be created for top-level +<tag>sect1</tag> and <tag>section</tag> elements in +each component. +</para> + +</refsection> +</refentry> diff --git a/params/chunk.separate.lots.xml b/params/chunk.separate.lots.xml new file mode 100644 index 0000000..aa54eab --- /dev/null +++ b/params/chunk.separate.lots.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.separate.lots"> +<refmeta> +<refentrytitle>chunk.separate.lots</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.separate.lots</refname> +<refpurpose>Should each LoT be in its own separate chunk?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.separate.lots.frag"> +<xsl:param name="chunk.separate.lots" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, each of the ToC and LoTs +(List of Examples, List of Figures, etc.) +will be put in its own separate chunk. +The title page includes generated links to each of the separate files. +</para> +<para> +This feature depends on the +<parameter>chunk.tocs.and.lots</parameter> +parameter also being non-zero. +</para> + +</refsection> +</refentry> diff --git a/params/chunk.toc.xml b/params/chunk.toc.xml new file mode 100644 index 0000000..12cdb2c --- /dev/null +++ b/params/chunk.toc.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.toc"> +<refmeta> +<refentrytitle>chunk.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.toc</refname> +<refpurpose>An explicit TOC to be used for chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.toc.frag"> +<xsl:param name="chunk.toc"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that +will be used for chunking. This parameter is only used by the +<filename>chunktoc.xsl</filename> stylesheet (and customization layers built +from it).</para> + +</refsection> +</refentry> diff --git a/params/chunk.tocs.and.lots.has.title.xml b/params/chunk.tocs.and.lots.has.title.xml new file mode 100644 index 0000000..0bdd31b --- /dev/null +++ b/params/chunk.tocs.and.lots.has.title.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.tocs.and.lots.has.title"> +<refmeta> +<refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.tocs.and.lots.has.title</refname> +<refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.tocs.and.lots.has.title.frag"> +<xsl:param name="chunk.tocs.and.lots.has.title" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero title of document is shown before ToC/LoT in +separate chunk.</para> + +</refsection> +</refentry> diff --git a/params/chunk.tocs.and.lots.xml b/params/chunk.tocs.and.lots.xml new file mode 100644 index 0000000..2a01fff --- /dev/null +++ b/params/chunk.tocs.and.lots.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunk.tocs.and.lots"> +<refmeta> +<refentrytitle>chunk.tocs.and.lots</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.tocs.and.lots</refname> +<refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunk.tocs.and.lots.frag"> +<xsl:param name="chunk.tocs.and.lots" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) +will be put in a separate chunk. At the moment, this chunk is not in the +normal forward/backward navigation list. Instead, a new link is added to the +navigation footer.</para> + +<para>This feature is still somewhat experimental. Feedback welcome.</para> + +</refsection> +</refentry> diff --git a/params/chunked.filename.prefix.xml b/params/chunked.filename.prefix.xml new file mode 100644 index 0000000..e4282c2 --- /dev/null +++ b/params/chunked.filename.prefix.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunked.filename.prefix"> +<refmeta> +<refentrytitle>chunked.filename.prefix</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunked.filename.prefix</refname> +<refpurpose>Filename prefix for chunked files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="chunked.filename.prefix.frag"> +<xsl:param name="chunked.filename.prefix"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If specified, the <parameter>chunked.filename.prefix</parameter> +parameter specifies a prefix string to add to each generated chunk filename. +For example:</para> +<programlisting><xsl:param name="chunked.filename.prefix">admin-<xsl:param></programlisting> +<para>will produce chunked filenames like:</para> +<programlisting>admin-index.html +admin-ch01.html +admin-ch01s01.html +... +</programlisting> + +<caution><para>Trying to use the <parameter>base.dir</parameter> +parameter to add a string prefix (by omitting the trailing slash) +no longer works (it never worked completely anyway). That parameter +value should contain only a directory path, and +now gets a trailing slash appended if it was omitted from the param.</para></caution> +</refsection> +</refentry> diff --git a/params/chunker.output.cdata-section-elements.xml b/params/chunker.output.cdata-section-elements.xml new file mode 100644 index 0000000..3e9be4d --- /dev/null +++ b/params/chunker.output.cdata-section-elements.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.cdata-section-elements"> +<refmeta> +<refentrytitle>chunker.output.cdata-section-elements</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.cdata-section-elements</refname> +<refpurpose>List of elements to escape with CDATA sections</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.cdata-section-elements.frag"> +<xsl:param name="chunker.output.cdata-section-elements"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the list of elements that should be escaped +as CDATA sections by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.doctype-public.xml b/params/chunker.output.doctype-public.xml new file mode 100644 index 0000000..6aa6e30 --- /dev/null +++ b/params/chunker.output.doctype-public.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.doctype-public"> +<refmeta> +<refentrytitle>chunker.output.doctype-public</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-public</refname> +<refpurpose>Public identifer to use in the document type of generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.doctype-public.frag"> +<xsl:param name="chunker.output.doctype-public"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the public identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.doctype-system.xml b/params/chunker.output.doctype-system.xml new file mode 100644 index 0000000..2d67906 --- /dev/null +++ b/params/chunker.output.doctype-system.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.doctype-system"> +<refmeta> +<refentrytitle>chunker.output.doctype-system</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-system</refname> +<refpurpose>System identifier to use for the document type in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.doctype-system.frag"> +<xsl:param name="chunker.output.doctype-system"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the system identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.encoding.xml b/params/chunker.output.encoding.xml new file mode 100644 index 0000000..f8993e9 --- /dev/null +++ b/params/chunker.output.encoding.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.encoding"> +<refmeta> +<refentrytitle>chunker.output.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.encoding</refname> +<refpurpose>Encoding used in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.encoding.frag"> +<xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the encoding to be used in files +generated by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> +<para>This parameter used to be named <literal>default.encoding</literal>.</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.indent.xml b/params/chunker.output.indent.xml new file mode 100644 index 0000000..3da9ad4 --- /dev/null +++ b/params/chunker.output.indent.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.indent"> +<refmeta> +<refentrytitle>chunker.output.indent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.indent</refname> +<refpurpose>Specification of indentation on generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.indent.frag"> +<xsl:param name="chunker.output.indent">no</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the indent +specification for generated pages. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.media-type.xml b/params/chunker.output.media-type.xml new file mode 100644 index 0000000..6186971 --- /dev/null +++ b/params/chunker.output.media-type.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.media-type"> +<refmeta> +<refentrytitle>chunker.output.media-type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.media-type</refname> +<refpurpose>Media type to use in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.media-type.frag"> +<xsl:param name="chunker.output.media-type"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the media type that should be used by +the chunking stylesheet. Not all processors support specification of +this parameter. +</para> +<para>This parameter specifies the media type that should be used by the +chunking stylesheet. This should be one from those defined in +<link xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and + <link xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +<para>It must be one from html, xml or text</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.method.xml b/params/chunker.output.method.xml new file mode 100644 index 0000000..dc9359b --- /dev/null +++ b/params/chunker.output.method.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.method"> +<refmeta> +<refentrytitle>chunker.output.method</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">html</refmiscinfo> +<refmiscinfo class="other" otherclass="value">xml</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.method</refname> +<refpurpose>Method used in generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.method.frag"> +<xsl:param name="chunker.output.method">html</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the output method to be used in files +generated by the chunking stylesheet. +</para> +<para>This parameter used to be named <literal>output.method</literal>.</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.omit-xml-declaration.xml b/params/chunker.output.omit-xml-declaration.xml new file mode 100644 index 0000000..4b8262f --- /dev/null +++ b/params/chunker.output.omit-xml-declaration.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.omit-xml-declaration"> +<refmeta> +<refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.omit-xml-declaration</refname> +<refpurpose>Omit-xml-declaration for generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.omit-xml-declaration.frag"> +<xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the omit-xml-declaration +specification for generated pages. Not all processors support +specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/chunker.output.standalone.xml b/params/chunker.output.standalone.xml new file mode 100644 index 0000000..8972c47 --- /dev/null +++ b/params/chunker.output.standalone.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="chunker.output.standalone"> +<refmeta> +<refentrytitle>chunker.output.standalone</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.standalone</refname> +<refpurpose>Standalone declaration for generated pages</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="chunker.output.standalone.frag"> +<xsl:param name="chunker.output.standalone">no</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>This parameter specifies the value of the standalone + specification for generated pages. It must be either + <literal>yes</literal> or <literal>no</literal>. Not all + processors support specification of this parameter. +</para> +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> +</refsection> +</refentry> diff --git a/params/citerefentry.link.xml b/params/citerefentry.link.xml new file mode 100644 index 0000000..623511b --- /dev/null +++ b/params/citerefentry.link.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="citerefentry.link"> +<refmeta> +<refentrytitle>citerefentry.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>citerefentry.link</refname> +<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="citerefentry.link.frag"> +<xsl:param name="citerefentry.link" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a web link will be generated, presumably +to an online man->HTML gateway. The text of the link is +generated by the <literal>generate.citerefentry.link</literal> template. +</para> + +</refsection> +</refentry> diff --git a/params/collect.xref.targets.xml b/params/collect.xref.targets.xml new file mode 100644 index 0000000..378c969 --- /dev/null +++ b/params/collect.xref.targets.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="collect.xref.targets"> +<refmeta> +<refentrytitle>collect.xref.targets</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">only</refmiscinfo> +</refmeta> +<refnamediv> +<refname>collect.xref.targets</refname> +<refpurpose>Controls whether cross reference data is +collected</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="collect.xref.targets.frag"> +<xsl:param name="collect.xref.targets">no</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +In order to resolve olinks efficiently, the stylesheets can +generate an external data file containing information about +all potential cross reference endpoints in a document. +This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output. +See also <parameter>targets.filename</parameter>. +</para> +</refsection> +</refentry> diff --git a/params/column.count.back.xml b/params/column.count.back.xml new file mode 100644 index 0000000..95ee76d --- /dev/null +++ b/params/column.count.back.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.back"> +<refmeta> +<refentrytitle>column.count.back</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.back</refname> +<refpurpose>Number of columns on back matter pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.back.frag"> +<xsl:param name="column.count.back" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on back matter (appendix, glossary, etc.) pages.</para> + +</refsection> +</refentry> diff --git a/params/column.count.body.xml b/params/column.count.body.xml new file mode 100644 index 0000000..a5d65b3 --- /dev/null +++ b/params/column.count.body.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.body"> +<refmeta> +<refentrytitle>column.count.body</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.body</refname> +<refpurpose>Number of columns on body pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.body.frag"> +<xsl:param name="column.count.body" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on body pages.</para> + +</refsection> +</refentry> diff --git a/params/column.count.front.xml b/params/column.count.front.xml new file mode 100644 index 0000000..64ff3ac --- /dev/null +++ b/params/column.count.front.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.front"> +<refmeta> +<refentrytitle>column.count.front</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.front</refname> +<refpurpose>Number of columns on front matter pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.front.frag"> +<xsl:param name="column.count.front" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on front matter (dedication, preface, etc.) pages.</para> + +</refsection> +</refentry> diff --git a/params/column.count.index.xml b/params/column.count.index.xml new file mode 100644 index 0000000..e485448 --- /dev/null +++ b/params/column.count.index.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.index"> +<refmeta> +<refentrytitle>column.count.index</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.index</refname> +<refpurpose>Number of columns on index pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.index.frag"> +<xsl:param name="column.count.index">2</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on index pages.</para> + +</refsection> +</refentry> diff --git a/params/column.count.lot.xml b/params/column.count.lot.xml new file mode 100644 index 0000000..770988d --- /dev/null +++ b/params/column.count.lot.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.lot"> +<refmeta> +<refentrytitle>column.count.lot</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.lot</refname> +<refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.lot.frag"> +<xsl:param name="column.count.lot" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on a page sequence containing the Table of Contents, +List of Figures, etc.</para> + +</refsection> +</refentry> diff --git a/params/column.count.titlepage.xml b/params/column.count.titlepage.xml new file mode 100644 index 0000000..3deba6f --- /dev/null +++ b/params/column.count.titlepage.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.count.titlepage"> +<refmeta> +<refentrytitle>column.count.titlepage</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.titlepage</refname> +<refpurpose>Number of columns on a title page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.count.titlepage.frag"> +<xsl:param name="column.count.titlepage" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Number of columns on a title page</para> + +</refsection> +</refentry> diff --git a/params/column.gap.back.xml b/params/column.gap.back.xml new file mode 100644 index 0000000..3aaa1d3 --- /dev/null +++ b/params/column.gap.back.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.back"> +<refmeta> +<refentrytitle>column.gap.back</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.back</refname> +<refpurpose>Gap between columns in back matter</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.back.frag"> +<xsl:param name="column.gap.back">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns in back matter (if +<parameter>column.count.back</parameter> is greater than one).</para> + +</refsection> +</refentry> diff --git a/params/column.gap.body.xml b/params/column.gap.body.xml new file mode 100644 index 0000000..57b0168 --- /dev/null +++ b/params/column.gap.body.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.body"> +<refmeta> +<refentrytitle>column.gap.body</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.body</refname> +<refpurpose>Gap between columns in the body</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.body.frag"> +<xsl:param name="column.gap.body">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns in body matter (if +<parameter>column.count.body</parameter> is greater than one).</para> + +</refsection> +</refentry> diff --git a/params/column.gap.front.xml b/params/column.gap.front.xml new file mode 100644 index 0000000..a6f7263 --- /dev/null +++ b/params/column.gap.front.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.front"> +<refmeta> +<refentrytitle>column.gap.front</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.front</refname> +<refpurpose>Gap between columns in the front matter</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.front.frag"> +<xsl:param name="column.gap.front">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns in front matter (if +<parameter>column.count.front</parameter> is greater than one).</para> + +</refsection> +</refentry> diff --git a/params/column.gap.index.xml b/params/column.gap.index.xml new file mode 100644 index 0000000..2279f77 --- /dev/null +++ b/params/column.gap.index.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.index"> +<refmeta> +<refentrytitle>column.gap.index</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.index</refname> +<refpurpose>Gap between columns in the index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.index.frag"> +<xsl:param name="column.gap.index">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns in indexes (if +<parameter>column.count.index</parameter> is greater than one).</para> + +</refsection> +</refentry> diff --git a/params/column.gap.lot.xml b/params/column.gap.lot.xml new file mode 100644 index 0000000..da0fa00 --- /dev/null +++ b/params/column.gap.lot.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.lot"> +<refmeta> +<refentrytitle>column.gap.lot</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.lot</refname> +<refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.lot.frag"> +<xsl:param name="column.gap.lot">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns on 'List-of-Titles' pages (if +<parameter>column.count.lot</parameter> is greater than one).</para> + +</refsection> +</refentry> diff --git a/params/column.gap.titlepage.xml b/params/column.gap.titlepage.xml new file mode 100644 index 0000000..7c13dbd --- /dev/null +++ b/params/column.gap.titlepage.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="column.gap.titlepage"> +<refmeta> +<refentrytitle>column.gap.titlepage</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.titlepage</refname> +<refpurpose>Gap between columns on title pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="column.gap.titlepage.frag"> +<xsl:param name="column.gap.titlepage">12pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the gap between columns on title pages (if +<parameter>column.count.titlepage</parameter> is greater than one).</para> + + +</refsection> +</refentry> diff --git a/params/compact.list.item.spacing.xml b/params/compact.list.item.spacing.xml new file mode 100644 index 0000000..f48f4a6 --- /dev/null +++ b/params/compact.list.item.spacing.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="compact.list.item.spacing"> +<refmeta> +<refentrytitle>compact.list.item.spacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>compact.list.item.spacing</refname> +<refpurpose>What space do you want between list items (when spacing="compact")?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="compact.list.item.spacing.frag"><xsl:attribute-set name="compact.list.item.spacing"> + <xsl:attribute name="space-before.optimum">0em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify what spacing you want between each list item when +<tag class="attribute">spacing</tag> is +<quote><literal>compact</literal></quote>.</para> +</refsection> +</refentry> diff --git a/params/component.label.includes.part.label.xml b/params/component.label.includes.part.label.xml new file mode 100644 index 0000000..6dd7a68 --- /dev/null +++ b/params/component.label.includes.part.label.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="component.label.includes.part.label"> +<refmeta> +<refentrytitle>component.label.includes.part.label</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.label.includes.part.label</refname> +<refpurpose>Do component labels include the part label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, number labels for <tag>chapter</tag>, +<tag>appendix</tag>, and other component elements are prefixed with +the label of the part element that contains them. So you might see +Chapter II.3 instead of Chapter 3. Also, the labels for formal +elements such as <tag>table</tag> and <tag>figure</tag> will include +the part label. If there is no part element container, then no prefix +is generated. +</para> +<para> +This feature is most useful when the +<parameter>label.from.part</parameter> parameter is turned on. +In that case, there would be more than one <tag>chapter</tag> +<quote>1</quote>, and the extra part label prefix will identify +each chapter unambiguously. +</para> + +</refsection> +</refentry> diff --git a/params/component.title.properties.xml b/params/component.title.properties.xml new file mode 100644 index 0000000..58cd4b4 --- /dev/null +++ b/params/component.title.properties.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="component.title.properties"> +<refmeta> +<refentrytitle>component.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.title.properties</refname> +<refpurpose>Properties for component titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="component.title.properties.frag"> +<xsl:attribute-set name="component.title.properties"> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master, 'pt')"/></xsl:attribute> + <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master, 'pt * 0.8')"/></xsl:attribute> + <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master, 'pt * 1.2')"/></xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="text-align"> + <xsl:choose> + <xsl:when test="((parent::article | parent::articleinfo | parent::info/parent::article) and not(ancestor::book) and not(self::bibliography)) or (parent::slides | parent::slidesinfo)">center</xsl:when> + <xsl:otherwise>start</xsl:otherwise> + </xsl:choose> + </xsl:attribute> + <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"/></xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties common to all component titles.</para> + +</refsection> +</refentry> diff --git a/params/component.titlepage.properties.xml b/params/component.titlepage.properties.xml new file mode 100644 index 0000000..47179f4 --- /dev/null +++ b/params/component.titlepage.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="component.titlepage.properties"> +<refmeta> +<refentrytitle>component.titlepage.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.titlepage.properties</refname> +<refpurpose>Properties for component titlepages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="component.titlepage.properties.frag"> +<xsl:attribute-set name="component.titlepage.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that are applied to the outer block containing +all the component title page information. +Its main use is to set a <literal>span="all"</literal> +property on the block that is a direct child of the flow.</para> + +<para>This attribute-set also applies to index titlepages. It is empty by default.</para> + +</refsection> +</refentry> diff --git a/params/contrib.inline.enabled.xml b/params/contrib.inline.enabled.xml new file mode 100644 index 0000000..5d5fa99 --- /dev/null +++ b/params/contrib.inline.enabled.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="contrib.inline.enabled"> +<refmeta> +<refentrytitle>contrib.inline.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>contrib.inline.enabled</refname> +<refpurpose>Display contrib output inline?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="contrib.inline.enabled.frag"><xsl:param name="contrib.inline.enabled">1</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (the default), output of the <tag>contrib</tag> element is +displayed as inline content rather than as block content.</para> + +</refsection> +</refentry> diff --git a/params/crop.mark.bleed.xml b/params/crop.mark.bleed.xml new file mode 100644 index 0000000..af3420e --- /dev/null +++ b/params/crop.mark.bleed.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="crop.mark.bleed"> +<refmeta> +<refentrytitle>crop.mark.bleed</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>crop.mark.bleed</refname> +<refpurpose>Length of invisible part of crop marks.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="crop.mark.bleed.frag"> +<xsl:param name="crop.mark.bleed">6pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Length of invisible part of crop marks. Crop marks are controlled by +<parameter>crop.marks</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/crop.mark.offset.xml b/params/crop.mark.offset.xml new file mode 100644 index 0000000..cfd9bd3 --- /dev/null +++ b/params/crop.mark.offset.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="crop.mark.offset"> +<refmeta> +<refentrytitle>crop.mark.offset</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>crop.mark.offset</refname> +<refpurpose>Length of crop marks.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="crop.mark.offset.frag"> +<xsl:param name="crop.mark.offset">24pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Length of crop marks. Crop marks are controlled by +<parameter>crop.marks</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/crop.mark.width.xml b/params/crop.mark.width.xml new file mode 100644 index 0000000..86c28b5 --- /dev/null +++ b/params/crop.mark.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="crop.mark.width"> +<refmeta> +<refentrytitle>crop.mark.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>crop.mark.width</refname> +<refpurpose>Width of crop marks.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="crop.mark.width.frag"> +<xsl:param name="crop.mark.width">0.5pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Width of crop marks. Crop marks are controlled by +<parameter>crop.marks</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/crop.marks.xml b/params/crop.marks.xml new file mode 100644 index 0000000..c68d5a0 --- /dev/null +++ b/params/crop.marks.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="crop.marks"> +<refmeta> +<refentrytitle>crop.marks</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>crop.marks</refname> +<refpurpose>Output crop marks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="crop.marks.frag"> +<xsl:param name="crop.marks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, crop marks will be added to each page. Currently this +works only with XEP if you have <parameter>xep.extensions</parameter> set.</para> + +</refsection> +</refentry> diff --git a/params/css.decoration.xml b/params/css.decoration.xml new file mode 100644 index 0000000..02e3026 --- /dev/null +++ b/params/css.decoration.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="css.decoration"> +<refmeta> +<refentrytitle>css.decoration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>css.decoration</refname> +<refpurpose>Enable CSS decoration of elements</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="css.decoration.frag"> +<xsl:param name="css.decoration" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, then html elements produced by the stylesheet may be +decorated with <literal>style</literal> attributes. For example, the +<literal>li</literal> tags produced for list items may include a +fragment of CSS in the <literal>style</literal> attribute which sets +the CSS property "list-style-type". +</para> + +</refsection> +</refentry> diff --git a/params/css.stylesheet.dir.xml b/params/css.stylesheet.dir.xml new file mode 100644 index 0000000..e32b178 --- /dev/null +++ b/params/css.stylesheet.dir.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="css.stylesheet.dir"> +<refmeta> +<refentrytitle>css.stylesheet.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>css.stylesheet.dir</refname> +<refpurpose>Default directory for CSS stylesheets</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="css.stylesheet.dir.frag"> +<xsl:param name="css.stylesheet.dir"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Identifies the default directory for the CSS stylesheet +generated on all the slides. This parameter can be set in the source +document with the <?dbhtml?> pseudo-attribute +<literal>css-stylesheet-dir</literal>.</para> + +<para>If non-empty, this value is prepended to each of the stylesheets. +</para> + +</refsection> +</refentry> diff --git a/params/css.stylesheet.xml b/params/css.stylesheet.xml new file mode 100644 index 0000000..2acc66c --- /dev/null +++ b/params/css.stylesheet.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="css.stylesheet"> +<refmeta> +<refentrytitle>css.stylesheet</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>css.stylesheet</refname> +<refpurpose>CSS stylesheet for slides</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="css.stylesheet.frag"> +<xsl:param name="css.stylesheet">slides.css</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Identifies the CSS stylesheet used by all the slides. This parameter +can be set in the source document with the <?dbhtml?> pseudo-attribute +<literal>css-stylesheet</literal>.</para> + +</refsection> +</refentry> diff --git a/params/current.docid.xml b/params/current.docid.xml new file mode 100644 index 0000000..93616f2 --- /dev/null +++ b/params/current.docid.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="current.docid"> +<refmeta> +<refentrytitle>current.docid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>current.docid</refname> +<refpurpose>targetdoc identifier for the document being +processed</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="current.docid.frag"> +<xsl:param name="current.docid"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet +the targetdoc identifier of the current document, since that +identifier does not appear in the document itself. </para> +<para>This parameter can also be used for print output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para> +</refsection> +</refentry> diff --git a/params/currentpage.marker.xml b/params/currentpage.marker.xml new file mode 100644 index 0000000..2bccf30 --- /dev/null +++ b/params/currentpage.marker.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="currentpage.marker"> +<refmeta> +<refentrytitle>currentpage.marker</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>currentpage.marker</refname> +<refpurpose>The text symbol used to mark the current page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="currentpage.marker.frag"> +<xsl:param name="currentpage.marker">@</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Character to use as identifying the current page in </para> +</refsection> +</refentry> diff --git a/params/custom.css.source.xml b/params/custom.css.source.xml new file mode 100644 index 0000000..24278ad --- /dev/null +++ b/params/custom.css.source.xml @@ -0,0 +1,119 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="custom.css.source"> + <refmeta> + <refentrytitle>custom.css.source</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>custom.css.source</refname> + <refpurpose>Name of a custom CSS input file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="custom.css.source.frag"><xsl:param name="custom.css.source"></xsl:param></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + +<para>The <parameter>custom.css.source</parameter> +parameter enables you to add CSS styles to DocBook's +HTML output.</para> + +<para>The parameter +specifies the name of a file containing custom +CSS styles. The file must be a well-formed XML file that +consists of a single <tag>style</tag> root +element that contains CSS styles as its text content. +For example:</para> +<programlisting><![CDATA[<?xml version="1.0"?> +<style> +h2 { + font-weight: bold; + color: blue; +} +... +</style> +]]></programlisting> + +<para>The filename specified by the parameter +should have a <literal>.xml</literal> +filename suffix, although that is not required. +The default value of this parameter is blank.</para> + +<para>If <parameter>custom.css.source</parameter> is not blank, then +the stylesheet takes the following actions. +These actions take place regardless of the value of +the <parameter>make.clean.html</parameter> parameter.</para> + +<orderedlist> + <listitem> + <para>The stylesheet uses the XSLT <literal>document()</literal> + function to open the file specified by the parameter and + load it into a variable.</para> + </listitem> + <listitem> + <para>The stylesheet forms an output pathname consisting of the + value of the <parameter>base.dir</parameter> parameter (if it is set) + and the value of <parameter>custom.css.source</parameter>, + with the <literal>.xml</literal> suffix stripped off. + </para> + </listitem> + <listitem> + <para>The stylesheet removes the <tag>style</tag> + wrapper element and writes just the CSS text content to the output file.</para> + </listitem> + <listitem> + <para>The stylesheet adds a <tag>link</tag> element to the + HTML <tag>HEAD</tag> element to reference this external CSS stylesheet. + For example: + <programlisting><link rel="stylesheet" href="custom.css" type="text/css"> + </programlisting> + </para> + </listitem> +</orderedlist> + + + +<para>If the <parameter>make.clean.html</parameter> parameter is nonzero +(the default is zero), +and if the <parameter>docbook.css.source</parameter> parameter +is not blank (the default is not blank), +then the stylesheet will also generate a default CSS file +and add a <tag>link</tag> tag to reference it. +The <tag>link</tag> to the custom CSS comes after the +<tag>link</tag> to the default, so it should cascade properly +in most browsers. +If you do not want two <tag>link</tag> tags, and +instead want your custom CSS to import the default generated +CSS file, then do the following: +</para> + +<orderedlist> + <listitem> + <para>Add a line like the following to your custom CSS source file:</para> + <programlisting>@import url("docbook.css") + </programlisting> + </listitem> + <listitem> + <para>Set the <parameter>docbook.css.link</parameter> parameter + to zero. This will omit the <tag>link</tag> tag + that references the default CSS file.</para> + </listitem> +</orderedlist> + +<para>If you set <parameter>make.clean.html</parameter> to nonzero but +you do not want the default CSS generated, then also set +the <parameter>docbook.css.source</parameter> parameter to blank. +Then no default CSS will be generated, and so +all CSS styles must come from your custom CSS file.</para> + +<para>You can use the <parameter>generate.css.header</parameter> +parameter to instead write the CSS to each HTML <tag>HEAD</tag> +element in a <tag>style</tag> tag instead of an external CSS file.</para> + + </refsection> +</refentry> diff --git a/params/default.float.class.xml b/params/default.float.class.xml new file mode 100644 index 0000000..1078b60 --- /dev/null +++ b/params/default.float.class.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.float.class"> +<refmeta> +<refentrytitle>default.float.class</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.float.class</refname> +<refpurpose>Specifies the default float class</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="default.float.class.frag"> +<xsl:param name="default.float.class"> + <xsl:choose> + <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl:when> + <xsl:otherwise>before</xsl:otherwise> + </xsl:choose> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the direction in which a float should be placed. for +xsl-fo this is before, for html it is left. For Western texts, the +before direction is the top of the page.</para> + +</refsection> +</refentry> diff --git a/params/default.image.width.xml b/params/default.image.width.xml new file mode 100644 index 0000000..0e84a72 --- /dev/null +++ b/params/default.image.width.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.image.width"> +<refmeta> +<refentrytitle>default.image.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.image.width</refname> +<refpurpose>The default width of images</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="default.image.width.frag"> +<xsl:param name="default.image.width"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If specified, this value will be used for the +<tag class="attribute">width</tag> attribute on images that do not specify any +<emphasis xlink:title="DocBook 5: The Definitive Guide" + xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para> + +</refsection> +</refentry> diff --git a/params/default.table.frame.xml b/params/default.table.frame.xml new file mode 100644 index 0000000..38c8667 --- /dev/null +++ b/params/default.table.frame.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.table.frame"> +<refmeta> +<refentrytitle>default.table.frame</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.frame</refname> +<refpurpose>The default framing of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="default.table.frame.frag"> +<xsl:param name="default.table.frame">all</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This value will be used when there is no frame attribute on the +table. </para> + +</refsection> +</refentry> diff --git a/params/default.table.rules.xml b/params/default.table.rules.xml new file mode 100644 index 0000000..ed698ec --- /dev/null +++ b/params/default.table.rules.xml @@ -0,0 +1,76 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.table.rules"> +<refmeta> +<refentrytitle>default.table.rules</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.rules</refname> +<refpurpose>The default column and row rules for tables using HTML markup</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="default.table.rules.frag"> +<xsl:param name="default.table.rules">none</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Tables using HTML markup elements can use an attribute +named <tag class="attribute">rules</tag> on the <tag>table</tag> or +<tag>informaltable</tag> element +to specify whether column and row border rules should be +displayed. This parameter lets you specify a global default +style for all HTML tables that don't otherwise have +that attribute.</para> +<para>These are the supported values:</para> + +<variablelist> +<varlistentry><term>all</term> +<listitem> +<para>Rules will appear between all rows and columns.</para> +</listitem> +</varlistentry> + +<varlistentry><term>rows</term> +<listitem> +<para>Rules will appear between rows only.</para> +</listitem> +</varlistentry> + +<varlistentry><term>cols</term> +<listitem> +<para>Rules will appear between columns only.</para> +</listitem> +</varlistentry> + +<varlistentry><term>groups</term> +<listitem> +<para>Rules will appear between row groups (thead, tfoot, tbody). +No support for rules between column groups yet. +</para> +</listitem> +</varlistentry> + +<varlistentry><term>none</term> +<listitem> +<para>No rules. This is the default value. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>The border after the last row and the border after +the last column are not affected by +this setting. Those borders are controlled by +the <tag class="attribute">frame</tag> attribute on the table element. +</para> + +</refsection> +</refentry> diff --git a/params/default.table.width.xml b/params/default.table.width.xml new file mode 100644 index 0000000..184ce52 --- /dev/null +++ b/params/default.table.width.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.table.width"> +<refmeta> +<refentrytitle>default.table.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.width</refname> +<refpurpose>The default width of tables</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="default.table.width.frag"> +<xsl:param name="default.table.width"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, this value will be used for the +<literal>width</literal> attribute on <tag>table</tag>s that do not specify an +alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or +<tag class="xmlpi">dbfo table-width</tag> processing instruction).</para> +</refsection> +</refentry> diff --git a/params/default.units.xml b/params/default.units.xml new file mode 100644 index 0000000..f83c822 --- /dev/null +++ b/params/default.units.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="default.units"> +<refmeta> +<refentrytitle>default.units</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">cm</refmiscinfo> +<refmiscinfo class="other" otherclass="value">mm</refmiscinfo> +<refmiscinfo class="other" otherclass="value">in</refmiscinfo> +<refmiscinfo class="other" otherclass="value">pt</refmiscinfo> +<refmiscinfo class="other" otherclass="value">pc</refmiscinfo> +<refmiscinfo class="other" otherclass="value">px</refmiscinfo> +<refmiscinfo class="other" otherclass="value">em</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.units</refname> +<refpurpose>Default units for an unqualified dimension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="default.units.frag"> +<xsl:param name="default.units">pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If an unqualified dimension is encountered (for example, in a +graphic width), the <parameter>default.units</parameter> will be used for the +units. Unqualified dimensions are not allowed in XSL Formatting Objects. +</para> + +</refsection> +</refentry> diff --git a/params/dingbat.font.family.xml b/params/dingbat.font.family.xml new file mode 100644 index 0000000..f9719cf --- /dev/null +++ b/params/dingbat.font.family.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="dingbat.font.family"> +<refmeta> +<refentrytitle>dingbat.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>dingbat.font.family</refname> +<refpurpose>The font family for copyright, quotes, and other symbols</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="dingbat.font.family.frag"> +<xsl:param name="dingbat.font.family">serif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The dingbat font family is used for dingbats. If it is defined +as the empty string, no font change is effected around dingbats. +</para> + +</refsection> +</refentry> diff --git a/params/docbook.css.link.xml b/params/docbook.css.link.xml new file mode 100644 index 0000000..6d9e6e6 --- /dev/null +++ b/params/docbook.css.link.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="docbook.css.link"> +<refmeta> +<refentrytitle>docbook.css.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>docbook.css.link</refname> +<refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="docbook.css.link.frag"> +<xsl:param name="docbook.css.link" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The stylesheets are capable of generating a default +CSS stylesheet file. The parameters +<parameter>make.clean.html</parameter> and +<parameter>docbook.css.source</parameter> control that feature.</para> + +<para>Normally if a default CSS file is generated, then +the stylesheet inserts a <tag>link</tag> tag in the HTML +<tag>HEAD</tag> element to reference it. +However, you can omit that <tag>link</tag> reference if +you set the <parameter>docbook.css.link</parameter> to zero +(1 is the default).</para> + +<para>This parameter is useful when you want to import the +default CSS into a custom CSS file generated using the +<parameter>custom.css.source</parameter> parameter. +</para> + +</refsection> +</refentry> diff --git a/params/docbook.css.source.xml b/params/docbook.css.source.xml new file mode 100644 index 0000000..8ba7eb7 --- /dev/null +++ b/params/docbook.css.source.xml @@ -0,0 +1,83 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="docbook.css.source"> + <refmeta> + <refentrytitle>docbook.css.source</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>docbook.css.source</refname> + <refpurpose>Name of the default CSS input file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="docbook.css.source.frag"><xsl:param name="docbook.css.source">docbook.css.xml</xsl:param></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + +<para>The <parameter>docbook.css.source</parameter> parameter +specifies the name of the file containing the default DocBook +CSS styles. Those styles are necessary when the +<parameter>make.clean.html</parameter> parameter is nonzero.</para> + +<para>The file is a well-formed XML file that +must consist of a single <tag>style</tag> root +element that contains CSS styles as its text content. +The default value of the parameter (and filename) +is <literal>docbook.css.xml</literal>. +The stylesheets ship with the default file. You can substitute +your own and specify its path in this parameter.</para> + +<para>If <parameter>docbook.css.source</parameter> is not blank, +and <parameter>make.clean.html</parameter> is nonzero, then +the stylesheet takes the following actions:</para> + +<orderedlist> + <listitem> + <para>The stylesheet uses the XSLT <literal>document()</literal> + function to open the file specified by the parameter and + load it into a variable.</para> + </listitem> + <listitem> + <para>The stylesheet forms an output pathname consisting of the + value of the <parameter>base.dir</parameter> parameter (if it is set) + and the value of <parameter>docbook.css.source</parameter>, + with the <literal>.xml</literal> suffix stripped off. + </para> + </listitem> + <listitem> + <para>The stylesheet removes the <tag>style</tag> + wrapper element and writes just the CSS text content to the output file.</para> + </listitem> + <listitem> + <para>The stylesheet adds a <tag>link</tag> element to the + HTML <tag>HEAD</tag> element to reference the external CSS stylesheet. + For example:</para> + <programlisting><link rel="stylesheet" href="docbook.css" type="text/css"> + </programlisting> + <para>However, if the <parameter>docbook.css.link</parameter> + parameter is set to zero, then no <tag>link</tag> is written + for the default CSS file. That is useful if a custom + CSS file will import the default CSS stylesheet to ensure + proper cascading of styles.</para> + </listitem> +</orderedlist> + +<para>If the <parameter>docbook.css.source</parameter> parameter +is changed from its default <literal>docbook.css.xml</literal> to blank, +then no default CSS is generated. Likewise if the +<parameter>make.clean.html</parameter> parameter is set to zero, +then no default CSS is generated. The +<parameter>custom.css.source</parameter> parameter can be used +instead to generate a complete custom CSS file.</para> + +<para>You can use the <parameter>generate.css.header</parameter> +parameter to instead write the CSS to each HTML <tag>HEAD</tag> +element in a <tag>style</tag> tag instead of an external CSS file.</para> + + </refsection> +</refentry> diff --git a/params/double.sided.xml b/params/double.sided.xml new file mode 100644 index 0000000..3758f1f --- /dev/null +++ b/params/double.sided.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="double.sided"> +<refmeta> +<refentrytitle>double.sided</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>double.sided</refname> +<refpurpose>Is the document to be printed double sided?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="double.sided.frag"> +<xsl:param name="double.sided" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Double-sided documents are printed with a slightly wider margin +on the binding edge of the page. +</para> +<para>FIXME: The current set of parameters does not take writing direction +into account.</para> + +</refsection> +</refentry> diff --git a/params/draft.mode.xml b/params/draft.mode.xml new file mode 100644 index 0000000..2f62d06 --- /dev/null +++ b/params/draft.mode.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="draft.mode"> +<refmeta> +<refentrytitle>draft.mode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.mode</refname> +<refpurpose>Select draft mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="draft.mode.frag"> +<xsl:param name="draft.mode">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects draft mode. If <parameter>draft.mode</parameter> is +<quote><literal>yes</literal></quote>, the entire document will be treated +as a draft. If it is <quote><literal>no</literal></quote>, the entire document +will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>, +individual sections will be treated as draft or final independently, depending +on how their <literal>status</literal> attribute is set. +</para> + +</refsection> +</refentry> diff --git a/params/draft.watermark.image.xml b/params/draft.watermark.image.xml new file mode 100644 index 0000000..ef053a0 --- /dev/null +++ b/params/draft.watermark.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="draft.watermark.image"> +<refmeta> +<refentrytitle>draft.watermark.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.watermark.image</refname> +<refpurpose>The URI of the image to be used for draft watermarks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="draft.watermark.image.frag"> +<xsl:param name="draft.watermark.image">images/draft.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The image to be used for draft watermarks.</para> + +</refsection> +</refentry> diff --git a/params/dry-run.xml b/params/dry-run.xml new file mode 100644 index 0000000..dd481c3 --- /dev/null +++ b/params/dry-run.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="dry-run"> +<refmeta> +<refentrytitle>dry-run</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>dry-run</refname> +<refpurpose>Indicates that no files should be produced</refpurpose> +</refnamediv> +<refsynopsisdiv> + <src:fragment xml:id="dry-run.frag"> + <xsl:param name="dry-run" select="0"/> + </src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>When using the XSLT processor to manage dependencies and construct +the website, this parameter can be used to suppress the generation of +new and updated files. Effectively, this allows you to see what the +stylesheet would do, without actually making any changes.</para> +<para>Only applies when XSLT-based chunking is being used.</para> +</refsection> +</refentry> diff --git a/params/dynamic.toc.xml b/params/dynamic.toc.xml new file mode 100644 index 0000000..232f19e --- /dev/null +++ b/params/dynamic.toc.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="dynamic.toc"> +<refmeta> +<refentrytitle>dynamic.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>dynamic.toc</refname> +<refpurpose>Dynamic ToCs?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="dynamic.toc.frag"> +<xsl:param name="dynamic.toc" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, JavaScript is used to make the ToC panel <quote>dynamic</quote>. +In a dynamic ToC, each section in the ToC can be expanded and collapsed by +clicking on the appropriate image.</para> + +</refsection> +</refentry> diff --git a/params/ebnf.assignment.xml b/params/ebnf.assignment.xml new file mode 100644 index 0000000..5c89748 --- /dev/null +++ b/params/ebnf.assignment.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ebnf.assignment"> +<refmeta> +<refentrytitle>ebnf.assignment</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.assignment</refname> +<refpurpose>The EBNF production assignment operator</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ebnf.assignment.frag"> +<xsl:param condition="html" name="ebnf.assignment"> +<code xmlns="">::=</code> +</xsl:param> +<xsl:param xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" condition="fo" name="ebnf.assignment"> + <fo:inline font-family="{$monospace.font.family}"> + <xsl:text>::=</xsl:text> + </fo:inline> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>ebnf.assignment</parameter> parameter determines what +text is used to show <quote>assignment</quote> in <tag>production</tag>s +in <tag>productionset</tag>s.</para> + +<para>While <quote><literal>::=</literal></quote> is common, so are several +other operators.</para> + +</refsection> +</refentry> diff --git a/params/ebnf.statement.terminator.xml b/params/ebnf.statement.terminator.xml new file mode 100644 index 0000000..4e8bd12 --- /dev/null +++ b/params/ebnf.statement.terminator.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ebnf.statement.terminator"> +<refmeta> +<refentrytitle>ebnf.statement.terminator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.statement.terminator</refname> +<refpurpose>Punctuation that ends an EBNF statement.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ebnf.statement.terminator.frag"> +<xsl:param condition="html" name="ebnf.statement.terminator"/> +<xsl:param condition="fo" name="ebnf.statement.terminator"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what +text is used to terminate each <tag>production</tag> +in <tag>productionset</tag>.</para> + +<para>Some notations end each statement with a period.</para> + +</refsection> +</refentry> diff --git a/params/ebnf.table.bgcolor.xml b/params/ebnf.table.bgcolor.xml new file mode 100644 index 0000000..747f140 --- /dev/null +++ b/params/ebnf.table.bgcolor.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ebnf.table.bgcolor"> +<refmeta> +<refentrytitle>ebnf.table.bgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.bgcolor</refname> +<refpurpose>Background color for EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ebnf.table.bgcolor.frag"> +<xsl:param name="ebnf.table.bgcolor" >#F5DCB3</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the background color for EBNF tables (a pale brown). No +<tag>bgcolor</tag> attribute is output if +<parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para> + + +</refsection> +</refentry> diff --git a/params/ebnf.table.border.xml b/params/ebnf.table.border.xml new file mode 100644 index 0000000..e4e50ae --- /dev/null +++ b/params/ebnf.table.border.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ebnf.table.border"> +<refmeta> +<refentrytitle>ebnf.table.border</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.border</refname> +<refpurpose>Selects border on EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ebnf.table.border.frag"><xsl:param name="ebnf.table.border" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the border on EBNF tables. If non-zero, the tables have +borders, otherwise they don't.</para> + +</refsection> +</refentry> diff --git a/params/eclipse.autolabel.xml b/params/eclipse.autolabel.xml new file mode 100644 index 0000000..622196e --- /dev/null +++ b/params/eclipse.autolabel.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="eclipse.autolabel"> +<refmeta> +<refentrytitle>eclipse.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="eclipse.autolabel.frag"> +<xsl:param name="eclipse.autolabel" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want to include chapter and section numbers into ToC in +the left panel, set this parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/eclipse.plugin.id.xml b/params/eclipse.plugin.id.xml new file mode 100644 index 0000000..75557e5 --- /dev/null +++ b/params/eclipse.plugin.id.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="eclipse.plugin.id"> +<refmeta> +<refentrytitle>eclipse.plugin.id</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.id</refname> +<refpurpose>Eclipse Help plugin id</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="eclipse.plugin.id.frag"> +<xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin id. You should change this id to something +unique for each help.</para> + +</refsection> +</refentry> diff --git a/params/eclipse.plugin.name.xml b/params/eclipse.plugin.name.xml new file mode 100644 index 0000000..0df83ec --- /dev/null +++ b/params/eclipse.plugin.name.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="eclipse.plugin.name"> +<refmeta> +<refentrytitle>eclipse.plugin.name</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.name</refname> +<refpurpose>Eclipse Help plugin name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="eclipse.plugin.name.frag"> +<xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin name.</para> + +</refsection> +</refentry> diff --git a/params/eclipse.plugin.provider.xml b/params/eclipse.plugin.provider.xml new file mode 100644 index 0000000..03261fe --- /dev/null +++ b/params/eclipse.plugin.provider.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="eclipse.plugin.provider"> +<refmeta> +<refentrytitle>eclipse.plugin.provider</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.provider</refname> +<refpurpose>Eclipse Help plugin provider name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="eclipse.plugin.provider.frag"> +<xsl:param name="eclipse.plugin.provider">Example provider</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Eclipse Help plugin provider name.</para> + +</refsection> +</refentry> diff --git a/params/editedby.enabled.xml b/params/editedby.enabled.xml new file mode 100644 index 0000000..78089f9 --- /dev/null +++ b/params/editedby.enabled.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="editedby.enabled"> +<refmeta> +<refentrytitle>editedby.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>editedby.enabled</refname> +<refpurpose>Display “Edited by” heading above editor name?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="editedby.enabled.frag"><xsl:param name="editedby.enabled">1</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a localized <emphasis role="bold">Edited +by</emphasis> heading is displayed above editor names in output of the +<tag>editor</tag> element.</para> + +</refsection> +</refentry> diff --git a/params/email.delimiters.enabled.xml b/params/email.delimiters.enabled.xml new file mode 100644 index 0000000..b07cd6d --- /dev/null +++ b/params/email.delimiters.enabled.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="email.delimiters.enabled"> +<refmeta> +<refentrytitle>email.delimiters.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>email.delimiters.enabled</refname> +<refpurpose>Generate delimiters around email addresses?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="email.delimiters.enabled.frag"> +<xsl:param name="email.delimiters.enabled" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, delimiters + +<footnote><para>For delimiters, the +stylesheets are currently hard-coded to output angle +brackets.</para></footnote> + +are generated around e-mail addresses +(the output of the <tag>email</tag> element).</para> + +</refsection> +</refentry> diff --git a/params/email.mailto.enabled.xml b/params/email.mailto.enabled.xml new file mode 100644 index 0000000..e4eb8d1 --- /dev/null +++ b/params/email.mailto.enabled.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="email.mailto.enabled"> +<refmeta> +<refentrytitle>email.mailto.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>email.mailto.enabled</refname> +<refpurpose>Generate mailto: links for email addresses?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="email.mailto.enabled.frag"> +<xsl:param name="email.mailto.enabled" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero the generated output for the <tag>email</tag> element +will be a clickable mailto: link that brings up the default mail client +on the system.</para> + +</refsection> +</refentry> diff --git a/params/emphasis.propagates.style.xml b/params/emphasis.propagates.style.xml new file mode 100644 index 0000000..9ff55f5 --- /dev/null +++ b/params/emphasis.propagates.style.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="emphasis.propagates.style"> +<refmeta> +<refentrytitle>emphasis.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>emphasis.propagates.style</refname> +<refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="emphasis.propagates.style.frag"> +<xsl:param name="emphasis.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, the <literal>role</literal> attribute of +<tag>emphasis</tag> elements will be passed through to the HTML as a +class attribute on a <literal>span</literal> that surrounds the +emphasis.</para> +</refsection> +</refentry> diff --git a/params/entry.propagates.style.xml b/params/entry.propagates.style.xml new file mode 100644 index 0000000..7f43c66 --- /dev/null +++ b/params/entry.propagates.style.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="entry.propagates.style"> +<refmeta> +<refentrytitle>entry.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>entry.propagates.style</refname> +<refpurpose>Pass entry role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="entry.propagates.style.frag"> +<xsl:param name="entry.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, the role attribute of <tag>entry</tag> elements +will be passed through to the HTML as a class attribute on the +<tag>td</tag> or <tag>th</tag> generated for the table +cell.</para> + +</refsection> +</refentry> diff --git a/params/epub.autolabel.xml b/params/epub.autolabel.xml new file mode 100644 index 0000000..8a64555 --- /dev/null +++ b/params/epub.autolabel.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="epub.autolabel"> +<refmeta> +<refentrytitle>epub.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>epub.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="epub.autolabel.frag"> +<xsl:param name="epub.autolabel" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want to include chapter and section numbers into ToC in, +set this parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/equation.number.properties.xml b/params/equation.number.properties.xml new file mode 100644 index 0000000..6e05d39 --- /dev/null +++ b/params/equation.number.properties.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="equation.number.properties"> +<refmeta> +<refentrytitle>equation.number.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>equation.number.properties</refname> +<refpurpose>Properties that apply to the <tag>fo:table-cell</tag> containing the number +of an <tag>equation</tag> that does not have a title.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="equation.number.properties.frag"><xsl:attribute-set name="equation.number.properties"> + <xsl:attribute name="text-align">end</xsl:attribute> + <xsl:attribute name="display-align">center</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to the fo:table-cell containing the number +of an equation when it has no title. The number in an equation with a +title is formatted along with the title, and this attribute-set does not apply.</para> +</refsection> +</refentry> diff --git a/params/equation.properties.xml b/params/equation.properties.xml new file mode 100644 index 0000000..a88f683 --- /dev/null +++ b/params/equation.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="equation.properties"> +<refmeta> +<refentrytitle>equation.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>equation.properties</refname> +<refpurpose>Properties associated with a equation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="equation.properties.frag"> +<xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for equations.</para> + +</refsection> +</refentry> diff --git a/params/example.properties.xml b/params/example.properties.xml new file mode 100644 index 0000000..42755ac --- /dev/null +++ b/params/example.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="example.properties"> +<refmeta> +<refentrytitle>example.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>example.properties</refname> +<refpurpose>Properties associated with a example</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="example.properties.frag"> +<xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"> + <xsl:attribute name="keep-together.within-column">auto</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for examples.</para> + +</refsection> +</refentry> diff --git a/params/exsl.node.set.available.xml b/params/exsl.node.set.available.xml new file mode 100644 index 0000000..c5d009e --- /dev/null +++ b/params/exsl.node.set.available.xml @@ -0,0 +1,44 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:exsl="http://exslt.org/common" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="exsl.node.set.available"> +<refmeta> +<refentrytitle>exsl.node.set.available</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>exsl.node.set.available</refname> +<refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.node.set.available"> + <xsl:choose> + <xsl:when exsl:foo="" xmlns:exsl="http://exslt.org/common" + test="function-available('exsl:node-set') or + contains(system-property('xsl:vendor'), + 'Apache Software Foundation')">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +then the exsl:node-set() function is available to be used in +the stylesheet. +If zero, then the function is not available. +This param automatically detects the presence of +the function and does not normally need to be set manually.</para> + +<para>This param was created to handle a long-standing +bug in the Xalan processor that fails to detect the +function even though it is available.</para> + +</refsection> +</refentry> diff --git a/params/feedback.href.xml b/params/feedback.href.xml new file mode 100644 index 0000000..bc37daf --- /dev/null +++ b/params/feedback.href.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="feedback.href"> +<refmeta> +<refentrytitle>feedback.href</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>feedback.href</refname> +<refpurpose>HREF (URI) for feedback link</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="feedback.href.frag"> +<xsl:param name="feedback.href"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The <varname>feedback.href</varname> value is used as the value +for the <tag class="attribute">href</tag> attribute on the feedback +link. If <varname>feedback.href</varname> +is empty, no feedback link is generated.</para> +</refsection> +</refentry> diff --git a/params/feedback.link.text.xml b/params/feedback.link.text.xml new file mode 100644 index 0000000..c80feef --- /dev/null +++ b/params/feedback.link.text.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="feedback.link.text"> +<refmeta> +<refentrytitle>feedback.link.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>feedback.link.text</refname> +<refpurpose>The text of the feedback link</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="feedback.link.text.frag"> +<xsl:param name="feedback.link.text">Feedback</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The contents of this variable is used as the text of the feedback +link if <varname>feedback.href</varname> is not empty. If +<varname>feedback.href</varname> is empty, no feedback link is +generated.</para> +</refsection> +</refentry> diff --git a/params/feedback.with.ids.xml b/params/feedback.with.ids.xml new file mode 100644 index 0000000..3edfa26 --- /dev/null +++ b/params/feedback.with.ids.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="feedback.with.ids"> +<refmeta> +<refentrytitle>feedback.with.ids</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>feedback.with.ids</refname> +<refpurpose>Toggle use of IDs in feedback</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="feedback.with.ids.frag"> +<xsl:param name="feedback.with.ids" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>feedback.with.ids</varname> is non-zero, the ID of the +current page will be added to the feedback link. This can be used, for +example, if the <varname>feedback.href</varname> is a CGI script.</para> +</refsection> +</refentry> diff --git a/params/figure.properties.xml b/params/figure.properties.xml new file mode 100644 index 0000000..e9f6748 --- /dev/null +++ b/params/figure.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="figure.properties"> +<refmeta> +<refentrytitle>figure.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>figure.properties</refname> +<refpurpose>Properties associated with a figure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="figure.properties.frag"> +<xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for figures.</para> + +</refsection> +</refentry> diff --git a/params/filename-prefix.xml b/params/filename-prefix.xml new file mode 100644 index 0000000..54c043d --- /dev/null +++ b/params/filename-prefix.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="filename-prefix"> +<refmeta> +<refentrytitle>filename-prefix</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>filename-prefix</refname> +<refpurpose>Prefix added to all filenames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="filename-prefix.frag"> +<xsl:param name="filename-prefix"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>To produce the <quote>text-only</quote> (that is, non-tabular) layout +of a website simultaneously with the tabular layout, the filenames have to +be distinguished. That's accomplished by adding the +<varname>filename-prefix</varname> to the front of each filename.</para> +</refsection> +</refentry> diff --git a/params/firstterm.only.link.xml b/params/firstterm.only.link.xml new file mode 100644 index 0000000..32ea305 --- /dev/null +++ b/params/firstterm.only.link.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="firstterm.only.link"> +<refmeta> +<refentrytitle>firstterm.only.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>firstterm.only.link</refname> +<refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="firstterm.only.link.frag"> +<xsl:param name="firstterm.only.link" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, only <tag>firstterm</tag>s will be automatically linked +to the glossary. If glossary linking is not enabled, this parameter +has no effect.</para> + +</refsection> +</refentry> diff --git a/params/foil.properties.xml b/params/foil.properties.xml new file mode 100644 index 0000000..11ad146 --- /dev/null +++ b/params/foil.properties.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foil.properties"> +<refmeta> +<refentrytitle>foil.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foil.properties</refname> +<refpurpose>Specifies properties for all foils</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="foil.properties.frag"> + <xsl:attribute-set name="foil.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$slide.font.family"/> + </xsl:attribute> + <xsl:attribute name="margin-{$direction.align.start}">1in</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.end}">1in</xsl:attribute> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.size"/> + </xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to all foils.</para> + +</refsection> +</refentry> diff --git a/params/foil.subtitle.properties.xml b/params/foil.subtitle.properties.xml new file mode 100644 index 0000000..4832fbe --- /dev/null +++ b/params/foil.subtitle.properties.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foil.subtitle.properties"> +<refmeta> +<refentrytitle>foil.subtitle.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foil.subtitle.properties</refname> +<refpurpose>Specifies properties for all foil subtitles</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="foil.subtitle.properties.frag"> + <xsl:attribute-set name="foil.subtitle.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$slide.title.font.family"/> + </xsl:attribute> + <xsl:attribute name="text-align">center</xsl:attribute> + <xsl:attribute name="font-size"> + <xsl:value-of select="$foil.title.master * 0.8"/><xsl:text>pt</xsl:text> + </xsl:attribute> + <xsl:attribute name="space-after">12pt</xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to all foil subtitles.</para> + +</refsection> +</refentry> diff --git a/params/foil.title.master.xml b/params/foil.title.master.xml new file mode 100644 index 0000000..f5ba07f --- /dev/null +++ b/params/foil.title.master.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foil.title.master"> +<refmeta> +<refentrytitle>foil.title.master</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foil.title.master</refname> +<refpurpose>Specifies unitless font size to use for foil titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="foil.title.master.frag"> +<xsl:param name="foil.title.master">36</xsl:param> +<!-- Inconsistant use of point size? --> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies a unitless font size to use for foil titles; used in +combination with the <parameter>foil.title.size</parameter> +parameter.</para> +</refsection> +</refentry> diff --git a/params/foil.title.size.xml b/params/foil.title.size.xml new file mode 100644 index 0000000..3163600 --- /dev/null +++ b/params/foil.title.size.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foil.title.size"> +<refmeta> +<refentrytitle>foil.title.size</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foil.title.size</refname> +<refpurpose>Specifies font size to use for foil titles, including units</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="foil.title.size.frag"> + <xsl:param name="foil.title.size"> + <xsl:value-of select="$foil.title.master"/><xsl:text>pt</xsl:text> + </xsl:param> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter combines the value of the +<parameter>foil.title.master</parameter> parameter with a unit +specification. The default unit is <literal>pt</literal> +(points).</para> + +</refsection> +</refentry> diff --git a/params/foilgroup.properties.xml b/params/foilgroup.properties.xml new file mode 100644 index 0000000..cd9805a --- /dev/null +++ b/params/foilgroup.properties.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foilgroup.properties"> +<refmeta> +<refentrytitle>foilgroup.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foilgroup.properties</refname> +<refpurpose>Specifies properties for all foilgroups</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="foilgroup.properties.frag"> + <xsl:attribute-set name="foilgroup.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$slide.font.family"/> + </xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to all foilgroups.</para> + +</refsection> +</refentry> diff --git a/params/foilgroup.toc.xml b/params/foilgroup.toc.xml new file mode 100644 index 0000000..31d7cb3 --- /dev/null +++ b/params/foilgroup.toc.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="foilgroup.toc"> +<refmeta> +<refentrytitle>foilgroup.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>foilgroup.toc</refname> +<refpurpose>Put ToC on foilgroup pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="foilgroup.toc.frag"> +<xsl:param name="foilgroup.toc" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a ToC will be placed on foilgroup pages (after any +other content). +</para> + +</refsection> +</refentry> diff --git a/params/footer.column.widths.xml b/params/footer.column.widths.xml new file mode 100644 index 0000000..eca2270 --- /dev/null +++ b/params/footer.column.widths.xml @@ -0,0 +1,80 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.column.widths"> +<refmeta> +<refentrytitle>footer.column.widths</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.column.widths</refname> +<refpurpose>Specify relative widths of footer areas</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment xml:id="footer.column.widths.frag"> +<xsl:param name="footer.column.widths">1 1 1</xsl:param> +</src:fragment></refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Page footers in print output use a three column table +to position text at the left, center, and right side of +the footer on the page. +This parameter lets you specify the relative sizes of the +three columns. The default value is +"1 1 1".</para> + +<para>The parameter value must be three numbers, separated +by white space. The first number represents the relative +width of the inside footer for +double-sided output. The second number is the relative +width of the center footer. The third number is the +relative width of the outside footer for +double-sided output. +</para> +<para>For single-sided output, the first number is the +relative width of left footer for left-to-right +text direction, or the right footer for right-to-left +text direction. +The third number is the +relative width of right footer for left-to-right +text direction, or the left footer for right-to-left +text direction.</para> + +<para>The numbers are used to specify the column widths +for the table that makes up the footer area. +In the FO output, this looks like: +</para> + +<programlisting> +<fo:table-column column-number="1" + column-width="proportional-column-width(1)"/> +</programlisting> + +<para> +The <literal>proportional-column-width()</literal> +function computes a column width by dividing its +argument by the total of the arguments for all the columns, and +then multiplying the result by the width of the whole table +(assuming all the column specs use the function). +Its argument can be any positive integer or floating point number. +Zero is an acceptable value, although some FO processors +may warn about it, in which case using a very small number might +be more satisfactory. +</para> + +<para>For example, the value "1 2 1" means the center +footer should have twice the width of the other areas. +A value of "0 0 1" means the entire footer area +is reserved for the right (or outside) footer text. +Note that to keep the center area centered on +the page, the left and right values must be +the same. A specification like "1 2 3" means the +center area is no longer centered on the page +since the right area is three times the width of the left area. +</para> + +</refsection> +</refentry> diff --git a/params/footer.content.properties.xml b/params/footer.content.properties.xml new file mode 100644 index 0000000..1212cbd --- /dev/null +++ b/params/footer.content.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.content.properties"> +<refmeta> +<refentrytitle>footer.content.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.content.properties</refname> +<refpurpose>Properties of page footer content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footer.content.properties.frag"> +<xsl:attribute-set name="footer.content.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="margin-left"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties of page footer content.</para> + +</refsection> +</refentry> diff --git a/params/footer.hr.xml b/params/footer.hr.xml new file mode 100644 index 0000000..d1a5bf8 --- /dev/null +++ b/params/footer.hr.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.hr"> +<refmeta> +<refentrytitle>footer.hr</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.hr</refname> +<refpurpose>Toggle <HR> before footer</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footer.hr.frag"> +<xsl:param name="footer.hr" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If non-zero, an <HR> is generated at the bottom of each web page, +before the footer.</para> +</refsection> +</refentry> diff --git a/params/footer.rule.xml b/params/footer.rule.xml new file mode 100644 index 0000000..6b00ade --- /dev/null +++ b/params/footer.rule.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.rule"> +<refmeta> +<refentrytitle>footer.rule</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.rule</refname> +<refpurpose>Rule over footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footer.rule.frag"> +<xsl:param name="footer.rule" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a rule will be drawn above the page footers.</para> + +</refsection> +</refentry> diff --git a/params/footer.table.height.xml b/params/footer.table.height.xml new file mode 100644 index 0000000..2f6c45e --- /dev/null +++ b/params/footer.table.height.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.table.height"> +<refmeta> +<refentrytitle>footer.table.height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.table.height</refname> +<refpurpose>Specify the minimum height of the table containing the running page footers</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment xml:id="footer.table.height.frag"> +<xsl:param name="footer.table.height" >14pt</xsl:param> +</src:fragment></refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Page footers in print output use a three column table +to position text at the left, center, and right side of +the footer on the page. +This parameter lets you specify the minimum height +of the single row in the table. +Since this specifies only the minimum height, +the table should automatically grow to fit taller content. +The default value is "14pt".</para> + +</refsection> +</refentry> diff --git a/params/footer.table.properties.xml b/params/footer.table.properties.xml new file mode 100644 index 0000000..12e67d3 --- /dev/null +++ b/params/footer.table.properties.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footer.table.properties"> +<refmeta> +<refentrytitle>footer.table.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.table.properties</refname> +<refpurpose>Apply properties to the footer layout table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id='footer.table.properties.frag'> +<xsl:attribute-set name="footer.table.properties"> + <xsl:attribute name="table-layout">fixed</xsl:attribute> + <xsl:attribute name="width">100%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties applied to the table that lays out the page footer.</para> + +</refsection> +</refentry> diff --git a/params/footers.on.blank.pages.xml b/params/footers.on.blank.pages.xml new file mode 100644 index 0000000..2964f78 --- /dev/null +++ b/params/footers.on.blank.pages.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footers.on.blank.pages"> +<refmeta> +<refentrytitle>footers.on.blank.pages</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footers.on.blank.pages</refname> +<refpurpose>Put footers on blank pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footers.on.blank.pages.frag"> +<xsl:param name="footers.on.blank.pages" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, footers will be placed on blank pages.</para> + +</refsection> +</refentry> diff --git a/params/footnote.font.size.xml b/params/footnote.font.size.xml new file mode 100644 index 0000000..88d0c0b --- /dev/null +++ b/params/footnote.font.size.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.font.size"> +<refmeta> +<refentrytitle>footnote.font.size</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.font.size</refname> +<refpurpose>The font size for footnotes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.font.size.frag"><xsl:param name="footnote.font.size"> + <xsl:value-of select="$body.font.master * 0.8"/><xsl:text>pt</xsl:text> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The footnote font size is used for...footnotes! +</para> + +</refsection> +</refentry> diff --git a/params/footnote.mark.properties.xml b/params/footnote.mark.properties.xml new file mode 100644 index 0000000..2dbc9c1 --- /dev/null +++ b/params/footnote.mark.properties.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.mark.properties"> +<refmeta> +<refentrytitle>footnote.mark.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.mark.properties</refname> +<refpurpose>Properties applied to each footnote mark +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.mark.properties.frag"> +<xsl:attribute-set name="footnote.mark.properties"> + <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"/></xsl:attribute> + <xsl:attribute name="font-size">75%</xsl:attribute> + <xsl:attribute name="font-weight">normal</xsl:attribute> + <xsl:attribute name="font-style">normal</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is applied to the footnote mark used +for each footnote. +It should contain only inline properties. +</para> + +<para>The property to make the mark a superscript is contained in the +footnote template itself, because the current version of FOP reports +an error if baseline-shift is used. +</para> + +</refsection> +</refentry> diff --git a/params/footnote.number.format.xml b/params/footnote.number.format.xml new file mode 100644 index 0000000..c323720 --- /dev/null +++ b/params/footnote.number.format.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.number.format"> +<refmeta> +<refentrytitle>footnote.number.format</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.number.format.frag"> +<xsl:param name="footnote.number.format" >1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A).</para> + +</refsection> +</refentry> diff --git a/params/footnote.number.symbols.xml b/params/footnote.number.symbols.xml new file mode 100644 index 0000000..10ca7d3 --- /dev/null +++ b/params/footnote.number.symbols.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.number.symbols"> +<refmeta> +<refentrytitle>footnote.number.symbols</refentrytitle> +<refmiscinfo class="other" otherclass="datatype"/> +</refmeta> +<refnamediv> +<refname>footnote.number.symbols</refname> +<refpurpose>Special characters to use as footnote markers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.number.symbols.frag"> +<xsl:param name="footnote.number.symbols"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>footnote.number.symbols</parameter> is not the empty string, +footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>footnote.number.format</parameter>.</para> + +<para>The use of symbols for footnotes depends on the ability of your +processor (or browser) to render the symbols you select. Not all systems are +capable of displaying the full range of Unicode characters. If the quoted characters +in the preceding paragraph are not displayed properly, that's a good indicator +that you may have trouble using those symbols for footnotes.</para> + +</refsection> +</refentry> diff --git a/params/footnote.properties.xml b/params/footnote.properties.xml new file mode 100644 index 0000000..f62adee --- /dev/null +++ b/params/footnote.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.properties"> +<refmeta> +<refentrytitle>footnote.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.properties</refname> +<refpurpose>Properties applied to each footnote body +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.properties.frag"> +<xsl:attribute-set name="footnote.properties"> + <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"/></xsl:attribute> + <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"/></xsl:attribute> + <xsl:attribute name="font-weight">normal</xsl:attribute> + <xsl:attribute name="font-style">normal</xsl:attribute> + <xsl:attribute name="text-align"><xsl:value-of select="$alignment"/></xsl:attribute> + <xsl:attribute name="start-indent">0pt</xsl:attribute> + <xsl:attribute name="text-indent">0pt</xsl:attribute> + <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"/></xsl:attribute> + <xsl:attribute name="wrap-option">wrap</xsl:attribute> + <xsl:attribute name="linefeed-treatment">treat-as-space</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is applied to the footnote-block +for each footnote. +It can be used to set the +font-size, font-family, and other inheritable properties that will be +applied to all footnotes.</para> + +</refsection> +</refentry> diff --git a/params/footnote.sep.leader.properties.xml b/params/footnote.sep.leader.properties.xml new file mode 100644 index 0000000..27f9489 --- /dev/null +++ b/params/footnote.sep.leader.properties.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="footnote.sep.leader.properties"> +<refmeta> +<refentrytitle>footnote.sep.leader.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.sep.leader.properties</refname> +<refpurpose>Properties associated with footnote separators</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="footnote.sep.leader.properties.frag"> +<xsl:attribute-set name="footnote.sep.leader.properties"> + <xsl:attribute name="color">black</xsl:attribute> + <xsl:attribute name="leader-pattern">rule</xsl:attribute> + <xsl:attribute name="leader-length">1in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for the rule line that separates the +footnotes from the body text. +These are properties applied to the fo:leader used as +the separator. +</para> +<para>If you want to do more than just set properties on +the leader element, then you can customize the template +named <literal>footnote.separator</literal> in +<filename>fo/pagesetup.xsl</filename>.</para> + +</refsection> +</refentry> diff --git a/params/fop.extensions.xml b/params/fop.extensions.xml new file mode 100644 index 0000000..e122368 --- /dev/null +++ b/params/fop.extensions.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="fop.extensions"> +<refmeta> +<refentrytitle>fop.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>fop.extensions</refname> +<refpurpose>Enable extensions for FOP version 0.20.5 and earlier</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="fop.extensions.frag"><xsl:param name="fop.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extensions intended for +<link xlink:href="http://xml.apache.org/fop/">FOP</link> +version 0.20.5 and earlier will be used. +At present, this consists of PDF bookmarks. +</para> + +<para>This parameter can also affect which graphics file formats +are supported.</para> + +<para>If you are using a version of FOP beyond +version 0.20.5, then use the <parameter>fop1.extensions</parameter> parameter +instead. +</para> +</refsection> +</refentry> diff --git a/params/fop1.extensions.xml b/params/fop1.extensions.xml new file mode 100644 index 0000000..dcbcf5b --- /dev/null +++ b/params/fop1.extensions.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="fop1.extensions"> +<refmeta> +<refentrytitle>fop1.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>fop1.extensions</refname> +<refpurpose>Enable extensions for FOP version 0.90 and later</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="fop1.extensions.frag"><xsl:param name="fop1.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extensions for +<link xlink:href="http://xml.apache.org/fop/">FOP</link> +version 0.90 and later will be used. +</para> + +<para>This parameter can also affect which graphics file formats +are supported.</para> + +<para>The original <parameter>fop.extensions</parameter> parameter +should still be used for FOP version 0.20.5 and earlier. +</para> +</refsection> +</refentry> diff --git a/params/formal.object.properties.xml b/params/formal.object.properties.xml new file mode 100644 index 0000000..f36aeaf --- /dev/null +++ b/params/formal.object.properties.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="formal.object.properties"> +<refmeta> +<refentrytitle>formal.object.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.object.properties</refname> +<refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="formal.object.properties.frag"> +<xsl:attribute-set name="formal.object.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> + <xsl:attribute name="keep-together.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for formal objects in docbook. Specify the spacing +before and after the object.</para> + +</refsection> +</refentry> diff --git a/params/formal.procedures.xml b/params/formal.procedures.xml new file mode 100644 index 0000000..4f10885 --- /dev/null +++ b/params/formal.procedures.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="formal.procedures"> +<refmeta> +<refentrytitle>formal.procedures</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.procedures</refname> +<refpurpose>Selects formal or informal procedures</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="formal.procedures.frag"> +<xsl:param name="formal.procedures" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Formal procedures are numbered and always have a title. +</para> + +</refsection> +</refentry> diff --git a/params/formal.title.placement.xml b/params/formal.title.placement.xml new file mode 100644 index 0000000..e56f200 --- /dev/null +++ b/params/formal.title.placement.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="formal.title.placement"> +<refmeta> +<refentrytitle>formal.title.placement</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.title.placement</refname> +<refpurpose>Specifies where formal object titles should occur</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="formal.title.placement.frag"> +<xsl:param name="formal.title.placement"> +figure before +example before +equation before +table before +procedure before +task before +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies where formal object titles should occur. For each formal object +type (<tag>figure</tag>, +<tag>example</tag>, +<tag>equation</tag>, +<tag>table</tag>, and <tag>procedure</tag>) +you can specify either the keyword +<quote><literal>before</literal></quote> or +<quote><literal>after</literal></quote>.</para> + +</refsection> +</refentry> diff --git a/params/formal.title.properties.xml b/params/formal.title.properties.xml new file mode 100644 index 0000000..898d572 --- /dev/null +++ b/params/formal.title.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="formal.title.properties"> +<refmeta> +<refentrytitle>formal.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.title.properties</refname> +<refpurpose>Style the title element of formal object such as a figure.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="formal.title.properties.frag"> +<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 * 1.2"/> + <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> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para> +</refsection> +</refentry> diff --git a/params/funcsynopsis.decoration.xml b/params/funcsynopsis.decoration.xml new file mode 100644 index 0000000..44037c3 --- /dev/null +++ b/params/funcsynopsis.decoration.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="funcsynopsis.decoration"> +<refmeta> +<refentrytitle>funcsynopsis.decoration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.decoration</refname> +<refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="funcsynopsis.decoration.frag"> +<xsl:param name="funcsynopsis.decoration" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, elements of the <tag>funcsynopsis</tag> will be +decorated (e.g. rendered as bold or italic text). The decoration is controlled by +templates that can be redefined in a customization layer. +</para> + +</refsection> +</refentry> diff --git a/params/funcsynopsis.style.xml b/params/funcsynopsis.style.xml new file mode 100644 index 0000000..fc3ad85 --- /dev/null +++ b/params/funcsynopsis.style.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="funcsynopsis.style"> +<refmeta> +<refentrytitle>funcsynopsis.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ansi</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kr</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.style</refname> +<refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsis.style">kr</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>, +ANSI-style function synopses are generated for a +<tag>funcsynopsis</tag>, otherwise K&R-style +function synopses are generated. +</para> + +</refsection> +</refentry> diff --git a/params/function.parens.xml b/params/function.parens.xml new file mode 100644 index 0000000..15d6df0 --- /dev/null +++ b/params/function.parens.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="function.parens"> +<refmeta> +<refentrytitle>function.parens</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>function.parens</refname> +<refpurpose>Generate parens after a function?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="function.parens.frag"> +<xsl:param name="function.parens" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the formatting of a <tag>function</tag> element +will include generated parentheses. +</para> + +</refsection> +</refentry> diff --git a/params/generate.consistent.ids.xml b/params/generate.consistent.ids.xml new file mode 100644 index 0000000..249cb8c --- /dev/null +++ b/params/generate.consistent.ids.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.consistent.ids"> +<refmeta> +<refentrytitle>generate.consistent.ids</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.consistent.ids</refname> +<refpurpose>Generate consistent id values if document is unchanged</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.consistent.ids.frag"> +<xsl:param name="generate.consistent.ids" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When the stylesheet assigns an id value to an output element, +the generate-id() function may be used. That function may not +produce consistent values between runs. Version control +systems may misidentify the changing id values as changes +to the document.</para> + +<para>If you set this parameter's value to 1, then the +template named <literal>object.id</literal> will replace +the use of the function generate-id() with +<literal><xsl:number level="multiple" count="*"/></literal>. +This counts preceding elements to generate a unique number for +the id value.</para> + +<caution> +<para>This param does not associate permanent unique id values +with particular elements. +The id values are consistent only as long as the document +structure does not change. +If the document structure changes, then the counting +of elements changes, and all id values after +the first such change may be different, even when there is +no change to the element itself or its output. +</para> +</caution> + +<para>The default value of this parameter is zero, so generate-id() is used +by default.</para> + +</refsection> +</refentry> diff --git a/params/generate.css.header.xml b/params/generate.css.header.xml new file mode 100644 index 0000000..05965c1 --- /dev/null +++ b/params/generate.css.header.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.css.header"> +<refmeta> +<refentrytitle>generate.css.header</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.css.header</refname> +<refpurpose>Insert generated CSS styles in HEAD element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.css.header.frag"> +<xsl:param name="generate.css.header" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The stylesheets are capable of generating both default +and custom CSS stylesheet files. The parameters +<parameter>make.clean.html</parameter>, +<parameter>docbook.css.source</parameter>, and +<parameter>custom.css.source</parameter> control that feature.</para> + +<para>If you require that CSS styles reside in the HTML +<tag>HEAD</tag> element instead of external CSS files, +then set the <parameter>generate.css.header</parameter> +parameter to nonzero (it is zero by default). +Then instead of generating the CSS in external files, +they are wrapped in <tag>style</tag> elements in +the <tag>HEAD</tag> element of each HTML output file. +</para> + +</refsection> +</refentry> diff --git a/params/generate.id.attributes.xml b/params/generate.id.attributes.xml new file mode 100644 index 0000000..6326841 --- /dev/null +++ b/params/generate.id.attributes.xml @@ -0,0 +1,59 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.id.attributes"> +<refmeta> +<refentrytitle>generate.id.attributes</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.id.attributes</refname> +<refpurpose>Generate ID attributes on container elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.id.attributes.frag"> +<xsl:param name="generate.id.attributes" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the HTML stylesheet will generate ID attributes on +containers. For example, the markup:</para> + +<screen><section id="foo"><title>Some Title</title> +<para>Some para.</para> +</section></screen> + +<para>might produce:</para> + +<screen><div class="section" id="foo"> +<h2>Some Title</h2> +<p>Some para.</p> +</div></screen> + +<para>The alternative is to generate anchors:</para> + +<screen><div class="section"> +<h2><a name="foo"></a>Some Title</h2> +<p>Some para.</p> +</div></screen> + +<para>Because the <tag class="attribute">name</tag> attribute of +the <tag>a</tag> element and the <tag class="attribute">id</tag> +attribute of other tags are both of type <quote>ID</quote>, producing both +generates invalid documents.</para> + +<para>As of version 1.50, you can use this switch to control which type of +identifier is generated. For backwards-compatibility, generating +<tag>a</tag> anchors is preferred.</para> + +<para>Note: at present, this switch is incompletely implemented. +Disabling ID attributes will suppress them, but enabling ID attributes +will not suppress the anchors.</para> + +</refsection> +</refentry> diff --git a/params/generate.index.xml b/params/generate.index.xml new file mode 100644 index 0000000..8cab350 --- /dev/null +++ b/params/generate.index.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.index"> +<refmeta> +<refentrytitle>generate.index</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.index</refname> +<refpurpose>Do you want an index?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.index.frag"><xsl:param name="generate.index" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specify if an index should be generated. </para> + +</refsection> +</refentry> diff --git a/params/generate.legalnotice.link.xml b/params/generate.legalnotice.link.xml new file mode 100644 index 0000000..534e050 --- /dev/null +++ b/params/generate.legalnotice.link.xml @@ -0,0 +1,72 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.legalnotice.link"> +<refmeta> +<refentrytitle>generate.legalnotice.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.legalnotice.link</refname> +<refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>generate.legalnotice.link</parameter> +is non-zero, the stylesheet: + +<itemizedlist> + <listitem> + <para>writes the contents of <tag>legalnotice</tag> to a separate + HTML file</para> + </listitem> + <listitem> + <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para> + </listitem> + <listitem> + <para>adds (in the HTML <literal>head</literal>) either a single + <literal>link</literal> or element or multiple + <literal>link</literal> elements (depending on the value of the + <parameter>html.head.legalnotice.link.multiple</parameter> + parameter), with the value or values derived from the + <parameter>html.head.legalnotice.link.types</parameter> + parameter</para> + </listitem> + </itemizedlist> + + Otherwise, if <parameter>generate.legalnotice.link</parameter> is + zero, <tag>legalnotice</tag> contents are rendered on the title + page.</para> + +<para>The name of the separate HTML file is computed as follows: + +<orderedlist> +<listitem> + <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> +processing instruction, that filename is used.</para> +</listitem> +<listitem> + <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename +is the concatenation of the id value and the value of the <parameter>html.ext</parameter> +parameter.</para> +</listitem> +<listitem> + <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> + attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-", +auto-generated id value, and <parameter>html.ext</parameter> value. + </para> +</listitem> +</orderedlist> + +</para> + +</refsection> +</refentry> diff --git a/params/generate.manifest.xml b/params/generate.manifest.xml new file mode 100644 index 0000000..b561c36 --- /dev/null +++ b/params/generate.manifest.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.manifest"> + <refmeta> + <refentrytitle>generate.manifest</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>generate.manifest</refname> + <refpurpose>Generate a manifest file?</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="generate.manifest.frag"><xsl:param name="generate.manifest" select="0"/></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>If non-zero, a list of HTML files generated by the + stylesheet transformation is written to the file named by + the <parameter>manifest</parameter> parameter.</para> + + </refsection> +</refentry> diff --git a/params/generate.meta.abstract.xml b/params/generate.meta.abstract.xml new file mode 100644 index 0000000..d3ca138 --- /dev/null +++ b/params/generate.meta.abstract.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.meta.abstract"> +<refmeta> +<refentrytitle>generate.meta.abstract</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.meta.abstract</refname> +<refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.meta.abstract.frag"> +<xsl:param name="generate.meta.abstract" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, document abstracts will be reproduced in the HTML +<literal>head</literal>, with <literal>>meta name="description" content="..."</literal></para> + + +</refsection> +</refentry> diff --git a/params/generate.revhistory.link.xml b/params/generate.revhistory.link.xml new file mode 100644 index 0000000..bd70cd9 --- /dev/null +++ b/params/generate.revhistory.link.xml @@ -0,0 +1,50 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.revhistory.link"> +<refmeta> +<refentrytitle>generate.revhistory.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.revhistory.link</refname> +<refpurpose>Write revhistory to separate chunk and generate link?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the contents of <tag>revhistory</tag> are written +to a separate HTML file and a link to the file is +generated. Otherwise, <tag>revhistory</tag> contents are rendered on +the title page.</para> + +<para>The name of the separate HTML file is computed as follows: + +<orderedlist> +<listitem> + <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction, +that filename is used.</para> +</listitem> +<listitem> + <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of +the id value and the value of the <parameter>html.ext</parameter> parameter.</para> +</listitem> +<listitem> + <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> +attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-", +auto-generated id value, and <parameter>html.ext</parameter> value. + </para> +</listitem> +</orderedlist> + +</para> + +</refsection> +</refentry> diff --git a/params/generate.section.toc.level.xml b/params/generate.section.toc.level.xml new file mode 100644 index 0000000..227735a --- /dev/null +++ b/params/generate.section.toc.level.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.section.toc.level"> +<refmeta> +<refentrytitle>generate.section.toc.level</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.section.toc.level</refname> +<refpurpose>Control depth of TOC generation in sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.section.toc.level.frag"> +<xsl:param name="generate.section.toc.level" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>generate.section.toc.level</parameter> parameter +controls the depth of <tag>section</tag> in which TOCs will be generated. Note +that this is related to, but not the same as +<parameter>toc.section.depth</parameter>, which controls the depth to +which TOC entries will be generated in a given TOC.</para> +<para>If, for example, <parameter>generate.section.toc.level</parameter> +is <literal>3</literal>, TOCs will be generated in first, second, and third +level sections, but not in fourth level sections. +</para> + +</refsection> +</refentry> diff --git a/params/generate.toc.xml b/params/generate.toc.xml new file mode 100644 index 0000000..d23c45e --- /dev/null +++ b/params/generate.toc.xml @@ -0,0 +1,108 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="generate.toc"> +<refmeta> +<refentrytitle>generate.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.toc</refname> +<refpurpose>Control generation of ToCs and LoTs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="generate.toc.frag"> +<xsl:param condition="html" name="generate.toc"> +appendix toc,title +article/appendix nop +article toc,title +book toc,title,figure,table,example,equation +chapter toc,title +part toc,title +preface toc,title +qandadiv toc +qandaset toc +reference toc,title +sect1 toc +sect2 toc +sect3 toc +sect4 toc +sect5 toc +section toc +set toc,title +</xsl:param> +<xsl:param condition="fo" name="generate.toc"> +/appendix toc,title +article/appendix nop +/article toc,title +book toc,title,figure,table,example,equation +/chapter toc,title +part toc,title +/preface toc,title +reference toc,title +/sect1 toc +/sect2 toc +/sect3 toc +/sect4 toc +/sect5 toc +/section toc +set toc,title +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter has a structured value. It is a table of space-delimited +path/value pairs. Each path identifies some element in the source document +using a restricted subset of XPath (only the implicit child axis, no wildcards, +no predicates). Paths can be either relative or absolute.</para> + +<para>When processing a particular element, the stylesheets consult this table to +determine if a ToC (or LoT(s)) should be generated.</para> + +<para>For example, consider the entry:</para> + +<screen>book toc,figure</screen> + +<para>This indicates that whenever a <tag>book</tag> is formatted, a +Table Of Contents and a List of Figures should be generated. Similarly,</para> + +<screen>/chapter toc</screen> + +<para>indicates that whenever a document <emphasis>that has a root +of</emphasis> <tag>chapter</tag> is formatted, a Table of +Contents should be generated. The entry <literal>chapter</literal> would match +all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag> +document elements.</para> + +<para>Generally, the longest match wins. So, for example, if you want to distinguish +articles in books from articles in parts, you could use these two entries:</para> + +<screen>book/article toc,figure +part/article toc</screen> + +<para>Note that an article in a part can never match a <literal>book/article</literal>, +so if you want nothing to be generated for articles in parts, you can simply leave +that rule out.</para> + +<para>If you want to leave the rule in, to make it explicit that you're turning +something off, use the value <quote>nop</quote>. For example, the following +entry disables ToCs and LoTs for articles:</para> + +<screen>article nop</screen> + +<para>Do not simply leave the word <quote>article</quote> in the file +without a matching value. That'd be just begging the silly little +path/value parser to get confused.</para> + +<para>Section ToCs are further controlled by the +<parameter>generate.section.toc.level</parameter> parameter. +For a given section level to have a ToC, it must have both an entry in +<parameter>generate.toc</parameter> and be within the range enabled by +<parameter>generate.section.toc.level</parameter>.</para> +</refsection> +</refentry> diff --git a/params/glossary.as.blocks.xml b/params/glossary.as.blocks.xml new file mode 100644 index 0000000..e18ed19 --- /dev/null +++ b/params/glossary.as.blocks.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossary.as.blocks"> +<refmeta> +<refentrytitle>glossary.as.blocks</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.as.blocks</refname> +<refpurpose>Present glossarys using blocks instead of lists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossary.as.blocks.frag"> +<xsl:param name="glossary.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>glossary</tag>s will be formatted as +blocks.</para> + +<para>If you have long <tag>glossterm</tag>s, proper list +markup in the FO case may produce unattractive lists. By setting this +parameter, you can force the stylesheets to produce block markup +instead of proper lists.</para> + +<para>You can override this setting with a processing instruction as the +child of <tag>glossary</tag>: <tag class="xmlpi">dbfo +glossary-presentation="blocks"</tag> or <tag class="xmlpi">dbfo +glossary-presentation="list"</tag></para> + +</refsection> +</refentry> diff --git a/params/glossary.collection.xml b/params/glossary.collection.xml new file mode 100644 index 0000000..9db037c --- /dev/null +++ b/params/glossary.collection.xml @@ -0,0 +1,271 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossary.collection"> +<refmeta> +<refentrytitle>glossary.collection</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.collection</refname> +<refpurpose>Name of the glossary collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossary.collection.frag"> +<xsl:param name="glossary.collection"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Glossaries maintained independently across a set of documents +are likely to become inconsistent unless considerable effort is +expended to keep them in sync. It makes much more sense, usually, to +store all of the glossary entries in a single place and simply +<quote>extract</quote> the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>glossary.collection</parameter> parameter. To setup a global +glossary <quote>database</quote>, follow these steps:</para> + +<refsection><info><title>Setting Up the Glossary Database</title></info> + +<para>First, create a stand-alone glossary document that contains all of +the entries that you wish to reference. Make sure that each glossary +entry has an ID.</para> + +<para>Here's an example glossary:</para> + +<informalexample> +<programlisting> +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE glossary + PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<glossary> +<glossaryinfo> +<editor><firstname>Eric</firstname><surname>Raymond</surname></editor> +<title>Jargon File 4.2.3 (abridged)</title> +<releaseinfo>Just some test data</releaseinfo> +</glossaryinfo> + +<glossdiv><title>0</title> + +<glossentry> +<glossterm>0</glossterm> +<glossdef> +<para>Numeric zero, as opposed to the letter `O' (the 15th letter of +the English alphabet). In their unmodified forms they look a lot +alike, and various kluges invented to make them visually distinct have +compounded the confusion. If your zero is center-dotted and letter-O +is not, or if letter-O looks almost rectangular but zero looks more +like an American football stood on end (or the reverse), you're +probably looking at a modern character display (though the dotted zero +seems to have originated as an option on IBM 3270 controllers). If +your zero is slashed but letter-O is not, you're probably looking at +an old-style ASCII graphic set descended from the default typewheel on +the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter, +curse this arrangement). (Interestingly, the slashed zero long +predates computers; Florian Cajori's monumental "A History of +Mathematical Notations" notes that it was used in the twelfth and +thirteenth centuries.) If letter-O has a slash across it and the zero +does not, your display is tuned for a very old convention used at IBM +and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis> +arrangement even more, because it means two of their letters collide). +Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis> +slash. Old CDC computers rendered letter O as an unbroken oval and 0 +as an oval broken at upper right and lower left. And yet another +convention common on early line printers left zero unornamented but +added a tail or hook to the letter-O so that it resembled an inverted +Q or cursive capital letter-O (this was endorsed by a draft ANSI +standard for how to draw ASCII characters, but the final standard +changed the distinguisher to a tick-mark in the upper-left corner). +Are we sufficiently confused yet?</para> +</glossdef> +</glossentry> + +<glossentry> +<glossterm>1TBS</glossterm> +<glossdef> +<para role="accidence"> +<phrase role="pronounce"></phrase> +<phrase role="partsofspeach">n</phrase> +</para> +<para>The "One True Brace Style"</para> +<glossseealso>indent style</glossseealso> +</glossdef> +</glossentry> + +<!-- ... --> + +</glossdiv> + +<!-- ... --> + +</glossary></programlisting> +</informalexample> + +</refsection> + +<refsection><info><title>Marking Up Glossary Terms</title></info> + +<para>That takes care of the glossary database, now you have to get the entries +into your document. Unlike bibliography entries, which can be empty, creating +<quote>placeholder</quote> glossary entries would be very tedious. So instead, +support for <parameter>glossary.collection</parameter> relies on implicit linking.</para> + +<para>In your source document, simply use <tag>firstterm</tag> and +<tag>glossterm</tag> to identify the terms you wish to have included +in the glossary. The stylesheets assume that you will either set the +<tag class="attribute">baseform</tag> attribute correctly, or that the +content of the element exactly matches a term in your glossary.</para> + +<para>If you're using a <parameter>glossary.collection</parameter>, don't +make explicit links on the terms in your document.</para> + +<para>So, in your document, you might write things like this:</para> + +<informalexample> +<programlisting><para>This is dummy text, without any real meaning. +The point is simply to reference glossary terms like <glossterm>0</glossterm> +and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>. +The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly +religious issue.</para></programlisting> +</informalexample> + +<para>If you set the <parameter>firstterm.only.link</parameter> parameter, +only the terms marked with <tag>firstterm</tag> will be links. +Otherwise, all the terms will be linked.</para> + +</refsection> + +<refsection><info><title>Marking Up the Glossary</title></info> + +<para>The glossary itself has to be identified for the stylesheets. For lack +of a better choice, the <tag class="attribute">role</tag> is used. +To identify the glossary as the target for automatic processing, set +the role to <quote><literal>auto</literal></quote>. The title of this +glossary (and any other information from the <tag>glossaryinfo</tag> +that's rendered by your stylesheet) will be displayed, but the entries will +come from the database. +</para> + +<para>Unfortunately, the glossary can't be empty, so you must put in +at least one <tag>glossentry</tag>. The content of this entry +is irrelevant, it will not be rendered:</para> + +<informalexample> +<programlisting><glossary role="auto"> +<glossentry> +<glossterm>Irrelevant</glossterm> +<glossdef> +<para>If you can see this, the document was processed incorrectly. Use +the <parameter>glossary.collection</parameter> parameter.</para> +</glossdef> +</glossentry> +</glossary></programlisting> +</informalexample> + +<para>What about glossary divisions? If your glossary database has glossary +divisions <emphasis>and</emphasis> your automatic glossary contains at least +one <tag>glossdiv</tag>, the automic glossary will have divisions. +If the <tag>glossdiv</tag> is missing from either location, no divisions +will be rendered.</para> + +<para>Glossary entries (and divisions, if appropriate) in the glossary will +occur in precisely the order they occur in your database.</para> + +</refsection> + +<refsection><info><title>Formatting the Document</title></info> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>glossary.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global glossary.</para> + +<para>A relative path in the parameter is interpreted in one +of two ways:</para> +<orderedlist numeration="loweralpha"> + <listitem> + <para>If the parameter <literal>glossterm.auto.link</literal> + is set to zero, then the path is relative to the file containing + the empty <tag>glossary</tag> element in the document.</para> + </listitem> + <listitem> + <para>If the parameter <literal>glossterm.auto.link</literal> + is set to non-zero, then the path is relative to the file containing + the first inline <tag>glossterm</tag> or + <tag>firstterm</tag> in the document to be linked.</para> + </listitem> +</orderedlist> +<para>Once the collection file is opened by the first instance described +above, it stays open for the current document +and the relative path is not reinterpreted again.</para> + +<para>The stylesheets will format the glossary in your document as if +all of the entries implicilty referenced appeared there literally.</para> +</refsection> + +<refsection><info><title>Limitations</title></info> + +<para>Glossary cross-references <emphasis>within the glossary</emphasis> are +not supported. For example, this <emphasis>will not</emphasis> work:</para> + +<informalexample> +<programlisting><glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry></programlisting> +</informalexample> + +<para>If you put glossary cross-references in your glossary that way, +you'll get the cryptic error: <computeroutput>Warning: +glossary.collection specified, but there are 0 automatic +glossaries</computeroutput>.</para> + +<para>Instead, you must do two things:</para> + +<orderedlist> +<listitem> +<para>Markup your glossary using <tag>glossseealso</tag>:</para> + +<informalexample> +<programlisting><glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry></programlisting> +</informalexample> +</listitem> + +<listitem> +<para>Make sure there is at least one <tag>glossterm</tag> reference to +<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The +easiest way to do that is probably within a <tag>remark</tag> in your +automatic glossary:</para> + +<informalexample> +<programlisting><glossary role="auto"> +<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark> +<glossentry> +<glossterm>Irrelevant</glossterm> +<glossdef> +<para>If you can see this, the document was processed incorrectly. Use +the <parameter>glossary.collection</parameter> parameter.</para> +</glossdef> +</glossentry> +</glossary></programlisting> +</informalexample> +</listitem> +</orderedlist> +</refsection> + +</refsection> +</refentry> diff --git a/params/glossary.sort.xml b/params/glossary.sort.xml new file mode 100644 index 0000000..216130a --- /dev/null +++ b/params/glossary.sort.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossary.sort"> +<refmeta> +<refentrytitle>glossary.sort</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.sort</refname> +<refpurpose>Sort glossentry elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossary.sort.frag"> +<xsl:param name="glossary.sort" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then the glossentry elements within a +glossary, glossdiv, or glosslist are sorted on the glossterm, using +the current lang setting. If zero (the default), then +glossentry elements are not sorted and are presented +in document order. +</para> + +</refsection> +</refentry> diff --git a/params/glossdef.block.properties.xml b/params/glossdef.block.properties.xml new file mode 100644 index 0000000..4fb481f --- /dev/null +++ b/params/glossdef.block.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossdef.block.properties"> +<refmeta> +<refentrytitle>glossdef.block.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossdef.block.properties</refname> +<refpurpose>To add properties to the block of a glossary definition.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossdef.block.properties.frag"><xsl:attribute-set name="glossdef.block.properties"> + <xsl:attribute name="margin-{$direction.align.start}">.25in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the block containing a +glossary definition in a glossary when +the <parameter>glossary.as.blocks</parameter> parameter +is non-zero. +Use this attribute-set to set the space above and below, +any font properties, +and any indent for the glossary definition.</para> + +</refsection> +</refentry> diff --git a/params/glossdef.list.properties.xml b/params/glossdef.list.properties.xml new file mode 100644 index 0000000..ba71578 --- /dev/null +++ b/params/glossdef.list.properties.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossdef.list.properties"> +<refmeta> +<refentrytitle>glossdef.list.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossdef.list.properties</refname> +<refpurpose>To add properties to the glossary definition in a list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossdef.list.properties.frag"> +<xsl:attribute-set name="glossdef.list.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the block containing a +glossary definition in a glossary when +the <parameter>glossary.as.blocks</parameter> parameter +is zero. +Use this attribute-set to set font properties, for example.</para> + +</refsection> +</refentry> diff --git a/params/glossentry.list.item.properties.xml b/params/glossentry.list.item.properties.xml new file mode 100644 index 0000000..6830f17 --- /dev/null +++ b/params/glossentry.list.item.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossentry.list.item.properties"> +<refmeta> +<refentrytitle>glossentry.list.item.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossentry.list.item.properties</refname> +<refpurpose>To add properties to each glossentry in a list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossentry.list.item.properties.frag"><xsl:attribute-set name="glossentry.list.item.properties"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the fo:list-item containing a +glossentry in a glossary when the <parameter>glossary.as.blocks</parameter> parameter +is zero. +Use this attribute-set to set +spacing between entries, for example.</para> + +</refsection> +</refentry> diff --git a/params/glossentry.show.acronym.xml b/params/glossentry.show.acronym.xml new file mode 100644 index 0000000..9736438 --- /dev/null +++ b/params/glossentry.show.acronym.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossentry.show.acronym"> +<refmeta> +<refentrytitle>glossentry.show.acronym</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">primary</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossentry.show.acronym</refname> +<refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossentry.show.acronym.frag"> +<xsl:param name="glossentry.show.acronym">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A setting of <quote>yes</quote> means they should be displayed; +<quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, +then they are shown as the primary text for the entry.</para> + +<note> +<para>This setting controls both <tag>acronym</tag> and +<tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para> +</note> + +</refsection> +</refentry> diff --git a/params/glosslist.as.blocks.xml b/params/glosslist.as.blocks.xml new file mode 100644 index 0000000..d720837 --- /dev/null +++ b/params/glosslist.as.blocks.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glosslist.as.blocks"> +<refmeta> +<refentrytitle>glosslist.as.blocks</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glosslist.as.blocks</refname> +<refpurpose>Use blocks for glosslists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glosslist.as.blocks.frag"> +<xsl:param name="glosslist.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>See <parameter>glossary.as.blocks</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/glossterm.auto.link.xml b/params/glossterm.auto.link.xml new file mode 100644 index 0000000..03d9a30 --- /dev/null +++ b/params/glossterm.auto.link.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossterm.auto.link"> +<refmeta> +<refentrytitle>glossterm.auto.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.auto.link</refname> +<refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossterm.auto.link.frag"> +<xsl:param name="glossterm.auto.link" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding +<tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag> +will be automatically generated. This is useful when your glossterms are consistent +and you don't want to add links manually.</para> + +<para>The automatic link generation feature is not used on <tag>glossterm</tag> elements +that have a <tag class="attribute">linkend</tag> attribute.</para> + +</refsection> +</refentry> diff --git a/params/glossterm.block.properties.xml b/params/glossterm.block.properties.xml new file mode 100644 index 0000000..84e6a6c --- /dev/null +++ b/params/glossterm.block.properties.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossterm.block.properties"> +<refmeta> +<refentrytitle>glossterm.block.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.block.properties</refname> +<refpurpose>To add properties to the block of a glossentry's glossterm.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossterm.block.properties.frag"><xsl:attribute-set name="glossterm.block.properties"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="keep-together.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the block containing a +glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter +is non-zero. +Use this attribute-set to set the space above and below, +font properties, +and any indent for the glossary term.</para> + +</refsection> +</refentry> diff --git a/params/glossterm.list.properties.xml b/params/glossterm.list.properties.xml new file mode 100644 index 0000000..abe0d31 --- /dev/null +++ b/params/glossterm.list.properties.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossterm.list.properties"> +<refmeta> +<refentrytitle>glossterm.list.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.list.properties</refname> +<refpurpose>To add properties to the glossterm in a list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossterm.list.properties.frag"> +<xsl:attribute-set name="glossterm.list.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the block containing a +glossary term in a glossary when the <parameter>glossary.as.blocks</parameter> parameter +is zero. +Use this attribute-set to set +font properties, for example.</para> + +</refsection> +</refentry> diff --git a/params/glossterm.separation.xml b/params/glossterm.separation.xml new file mode 100644 index 0000000..d0d2b8d --- /dev/null +++ b/params/glossterm.separation.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossterm.separation"> +<refmeta> +<refentrytitle>glossterm.separation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.separation</refname> +<refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossterm.separation.frag"> +<xsl:param name="glossterm.separation" >0.25in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the miminum horizontal +separation between glossary terms and descriptions when +they are presented side-by-side using lists +when the <parameter>glossary.as.blocks</parameter> +is zero.</para> + +</refsection> +</refentry> diff --git a/params/glossterm.width.xml b/params/glossterm.width.xml new file mode 100644 index 0000000..0cd3b82 --- /dev/null +++ b/params/glossterm.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="glossterm.width"> +<refmeta> +<refentrytitle>glossterm.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.width</refname> +<refpurpose>Width of glossterm in list presentation mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="glossterm.width.frag"> +<xsl:param name="glossterm.width" >2in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the width reserved for glossary terms when +a list presentation is used.</para> + +</refsection> +</refentry> diff --git a/params/graphic.default.extension.xml b/params/graphic.default.extension.xml new file mode 100644 index 0000000..93f2983 --- /dev/null +++ b/params/graphic.default.extension.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="graphic.default.extension"> +<refmeta> +<refentrytitle>graphic.default.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphic.default.extension</refname> +<refpurpose>Default extension for graphic filenames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="graphic.default.extension.frag"><xsl:param name="graphic.default.extension"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If a <tag>graphic</tag> or <tag>mediaobject</tag> +includes a reference to a filename that does not include an extension, +and the <tag class="attribute">format</tag> attribute is +<emphasis>unspecified</emphasis>, the default extension will be used. +</para> + +</refsection> +</refentry> diff --git a/params/graphical.admonition.properties.xml b/params/graphical.admonition.properties.xml new file mode 100644 index 0000000..ca257d7 --- /dev/null +++ b/params/graphical.admonition.properties.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="graphical.admonition.properties"> +<refmeta> +<refentrytitle>graphical.admonition.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphical.admonition.properties</refname> +<refpurpose>To add properties to the outer block of a graphical admonition.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="graphical.admonition.properties.frag"><xsl:attribute-set name="graphical.admonition.properties"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the outer block containing the +entire graphical admonition, including its title. +It is used when the parameter +<parameter>admon.graphics</parameter> is set to nonzero. +Use this attribute-set to set the space above and below, +and any indent for the whole admonition.</para> + +<para>In addition to these properties, a graphical admonition +also applies the <parameter>admonition.title.properties</parameter> +attribute-set to the title, and applies the +<parameter>admonition.properties</parameter> attribute-set +to the rest of the content.</para> + +</refsection> +</refentry> diff --git a/params/graphics.dir.xml b/params/graphics.dir.xml new file mode 100644 index 0000000..e8d83ae --- /dev/null +++ b/params/graphics.dir.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="graphics.dir"> +<refmeta> +<refentrytitle>graphics.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphics.dir</refname> +<refpurpose>Graphics directory</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="graphics.dir.frag"> +<xsl:param name="graphics.dir"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Identifies the graphics directory for the navigation components +generated on all the slides. This parameter can be set in the source +document with the <?dbhtml?> pseudo-attribute +<literal>graphics-dir</literal>.</para> + +<para>If non-empty, this value is prepended to each of the graphic +image paths.</para> + +</refsection> +</refentry> diff --git a/params/graphicsize.extension.xml b/params/graphicsize.extension.xml new file mode 100644 index 0000000..169228a --- /dev/null +++ b/params/graphicsize.extension.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="graphicsize.extension"> +<refmeta> +<refentrytitle>graphicsize.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphicsize.extension</refname> +<refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="graphicsize.extension.frag"> +<xsl:param name="graphicsize.extension" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero +and if you're using a processor that supports extension functions), the +<function>getWidth</function> and <function>getDepth</function> functions +will be used to extract image sizes from graphics.</para> + +<para>The main supported image formats are GIF, JPEG, and PNG. Somewhat cruder +support for EPS and PDF images is also available.</para> +</refsection> +</refentry> diff --git a/params/graphicsize.use.img.src.path.xml b/params/graphicsize.use.img.src.path.xml new file mode 100644 index 0000000..aff5b30 --- /dev/null +++ b/params/graphicsize.use.img.src.path.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="graphicsize.use.img.src.path"> +<refmeta> +<refentrytitle>graphicsize.use.img.src.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphicsize.use.img.src.path</refname> +<refpurpose>Prepend <parameter>img.src.path</parameter> before +filenames passed to extension functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="graphicsize.use.img.src.path.frag"> +<xsl:param name="graphicsize.use.img.src.path" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero <parameter>img.src.path</parameter> parameter will +be appended before filenames passed to extension functions for +measuring image dimensions.</para> + +</refsection> +</refentry> diff --git a/params/header.column.widths.xml b/params/header.column.widths.xml new file mode 100644 index 0000000..7d85b96 --- /dev/null +++ b/params/header.column.widths.xml @@ -0,0 +1,80 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.column.widths"> +<refmeta> +<refentrytitle>header.column.widths</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.column.widths</refname> +<refpurpose>Specify relative widths of header areas</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment xml:id="header.column.widths.frag"> +<xsl:param name="header.column.widths">1 1 1</xsl:param> +</src:fragment></refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Page headers in print output use a three column table +to position text at the left, center, and right side of +the header on the page. +This parameter lets you specify the relative sizes of the +three columns. The default value is +"1 1 1".</para> + +<para>The parameter value must be three numbers, separated +by white space. The first number represents the relative +width of the inside header for +double-sided output. The second number is the relative +width of the center header. The third number is the +relative width of the outside header for +double-sided output. +</para> +<para>For single-sided output, the first number is the +relative width of left header for left-to-right +text direction, or the right header for right-to-left +text direction. +The third number is the +relative width of right header for left-to-right +text direction, or the left header for right-to-left +text direction.</para> + +<para>The numbers are used to specify the column widths +for the table that makes up the header area. +In the FO output, this looks like: +</para> + +<programlisting> +<fo:table-column column-number="1" + column-width="proportional-column-width(1)"/> +</programlisting> + +<para> +The <literal>proportional-column-width()</literal> +function computes a column width by dividing its +argument by the total of the arguments for all the columns, and +then multiplying the result by the width of the whole table +(assuming all the column specs use the function). +Its argument can be any positive integer or floating point number. +Zero is an acceptable value, although some FO processors +may warn about it, in which case using a very small number might +be more satisfactory. +</para> + +<para>For example, the value "1 2 1" means the center +header should have twice the width of the other areas. +A value of "0 0 1" means the entire header area +is reserved for the right (or outside) header text. +Note that to keep the center area centered on +the page, the left and right values must be +the same. A specification like "1 2 3" means the +center area is no longer centered on the page +since the right area is three times the width of the left area. +</para> + +</refsection> +</refentry> diff --git a/params/header.content.properties.xml b/params/header.content.properties.xml new file mode 100644 index 0000000..2d0291c --- /dev/null +++ b/params/header.content.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.content.properties"> +<refmeta> +<refentrytitle>header.content.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.content.properties</refname> +<refpurpose>Properties of page header content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="header.content.properties.frag"> +<xsl:attribute-set name="header.content.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="margin-left"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties of page header content.</para> + +</refsection> +</refentry> diff --git a/params/header.hr.xml b/params/header.hr.xml new file mode 100644 index 0000000..08d846a --- /dev/null +++ b/params/header.hr.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.hr"> +<refmeta> +<refentrytitle>header.hr</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.hr</refname> +<refpurpose>Toggle <HR> after header</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="header.hr.frag"> +<xsl:param name="header.hr" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If non-zero, an <HR> is generated at the bottom of each web page, +before the footer.</para> +</refsection> +</refentry> diff --git a/params/header.rule.xml b/params/header.rule.xml new file mode 100644 index 0000000..b4c031e --- /dev/null +++ b/params/header.rule.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.rule"> +<refmeta> +<refentrytitle>header.rule</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.rule</refname> +<refpurpose>Rule under headers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="header.rule.frag"> +<xsl:param name="header.rule" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a rule will be drawn below the page headers.</para> + +</refsection> +</refentry> diff --git a/params/header.table.height.xml b/params/header.table.height.xml new file mode 100644 index 0000000..69b6f08 --- /dev/null +++ b/params/header.table.height.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.table.height"> +<refmeta> +<refentrytitle>header.table.height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.table.height</refname> +<refpurpose>Specify the minimum height of the table containing the running page headers</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment xml:id="header.table.height.frag"> +<xsl:param name="header.table.height">14pt</xsl:param> +</src:fragment></refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Page headers in print output use a three column table +to position text at the left, center, and right side of +the header on the page. +This parameter lets you specify the minimum height +of the single row in the table. +Since this specifies only the minimum height, +the table should automatically grow to fit taller content. +The default value is "14pt".</para> + +</refsection> +</refentry> diff --git a/params/header.table.properties.xml b/params/header.table.properties.xml new file mode 100644 index 0000000..b5f6052 --- /dev/null +++ b/params/header.table.properties.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.or/g2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="header.table.properties"> +<refmeta> +<refentrytitle>header.table.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.table.properties</refname> +<refpurpose>Apply properties to the header layout table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id='header.table.properties.frag'> +<xsl:attribute-set name="header.table.properties"> + <xsl:attribute name="table-layout">fixed</xsl:attribute> + <xsl:attribute name="width">100%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties applied to the table that lays out the page header.</para> + +</refsection> +</refentry> diff --git a/params/headers.on.blank.pages.xml b/params/headers.on.blank.pages.xml new file mode 100644 index 0000000..1fad48e --- /dev/null +++ b/params/headers.on.blank.pages.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="headers.on.blank.pages"> +<refmeta> +<refentrytitle>headers.on.blank.pages</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>headers.on.blank.pages</refname> +<refpurpose>Put headers on blank pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="headers.on.blank.pages.frag"> +<xsl:param name="headers.on.blank.pages" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, headers will be placed on blank pages.</para> + +</refsection> +</refentry> diff --git a/params/hidetoc.image.xml b/params/hidetoc.image.xml new file mode 100644 index 0000000..705b61f --- /dev/null +++ b/params/hidetoc.image.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="hidetoc.image"> +<refmeta> +<refentrytitle>hidetoc.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>hidetoc.image</refname> +<refpurpose>Hide ToC image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="hidetoc.image.frag"> +<xsl:param name="hidetoc.image">hidetoc.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the <quote>hide ToC</quote> image. This is used +when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is +enabled.</para> + +</refsection> +</refentry> diff --git a/params/highlight.default.language.xml b/params/highlight.default.language.xml new file mode 100644 index 0000000..0f00103 --- /dev/null +++ b/params/highlight.default.language.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="highlight.default.language"> +<refmeta> +<refentrytitle>highlight.default.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>highlight.default.language</refname> +<refpurpose>Default language of programlisting</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="highlight.default.language.frag"> +<xsl:param name="highlight.default.language"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This language is used when there is no language attribute on programlisting.</para> + +</refsection> +</refentry> diff --git a/params/highlight.source.xml b/params/highlight.source.xml new file mode 100644 index 0000000..41d7b2f --- /dev/null +++ b/params/highlight.source.xml @@ -0,0 +1,82 @@ +<refentry xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="5.0" xml:id="highlight.source">
+<refmeta>
+<refentrytitle>highlight.source</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>highlight.source</refname>
+<refpurpose>Should the content of <tag>programlisting</tag>
+be syntactically highlighted?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="highlight.source.frag">
+<xsl:param name="highlight.source" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
+content of <tag>programlisting</tag> elements. You specify the language for each programlisting
+by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
+parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
+attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
+
+<para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
+downloaded separately (see below).</para>
+
+<itemizedlist>
+<para>In order to use this extension, you must</para>
+
+<listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
+from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
+at SourceForge.</para>
+</listitem>
+<listitem>
+<para>use a customization layer in which you import one of the following stylesheet modules:
+<itemizedlist>
+ <listitem>
+ <para><filename>html/highlight.xsl</filename>
+ </para>
+ </listitem>
+<listitem>
+ <para><filename>xhtml/highlight.xsl</filename>
+ </para>
+ </listitem>
+<listitem>
+ <para><filename>xhtml-1_1/highlight.xsl</filename>
+ </para>
+ </listitem>
+<listitem>
+ <para><filename>fo/highlight.xsl</filename>
+ </para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+<listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
+<parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
+highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
+<filename>highlighting/xslthl-config.xml</filename>.</para>
+</listitem>
+</itemizedlist>
+
+<para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
+an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
+
+<para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
+
+<informalexample>
+<para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
+-Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
+-o test.html test.xml myhtml.xsl</command></para>
+</informalexample>
+
+</refsection>
+</refentry>
diff --git a/params/highlight.xslthl.config.xml b/params/highlight.xslthl.config.xml new file mode 100644 index 0000000..451937c --- /dev/null +++ b/params/highlight.xslthl.config.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="highlight.xslthl.config"> +<refmeta> +<refentrytitle>highlight.xslthl.config</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>highlight.xslthl.config</refname> +<refpurpose>Location of XSLTHL configuration file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="highlight.xslthl.config.frag"> +<xsl:param name="highlight.xslthl.config"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This location has precedence over the corresponding Java property.</para> + +<para>Please note that usually you have to specify location as URL not +just as a simple path on the local +filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para> + + + +</refsection> +</refentry> diff --git a/params/home.image.xml b/params/home.image.xml new file mode 100644 index 0000000..22e5455 --- /dev/null +++ b/params/home.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="home.image"> +<refmeta> +<refentrytitle>home.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>home.image</refname> +<refpurpose>Home image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="home.image.frag"> +<xsl:param name="home.image">active/nav-home.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the home navigation icon.</para> + +</refsection> +</refentry> diff --git a/params/html.append.xml b/params/html.append.xml new file mode 100644 index 0000000..461e61b --- /dev/null +++ b/params/html.append.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.append"> +<refmeta> +<refentrytitle>html.append</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.append</refname> +<refpurpose>Specifies content to append to HTML output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.append.frag"><xsl:param name="html.append"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies content to append to the end of HTML files output by +the <filename>html/docbook.xsl</filename> stylesheet, after the +closing <code><html></code> tag. You probably don’t want to set any +value for this parameter; but if you do, the only value it should ever +be set to is a newline character: <code>&#x0a;</code> or +<code>&#10;</code></para> + +</refsection> +</refentry> diff --git a/params/html.base.xml b/params/html.base.xml new file mode 100644 index 0000000..74e7fd9 --- /dev/null +++ b/params/html.base.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.base"> +<refmeta> +<refentrytitle>html.base</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.base</refname> +<refpurpose>An HTML base URI</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.base.frag"> +<xsl:param name="html.base"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If html.base is set, it is used for the <tag>base</tag> element +in the <tag>head</tag> of the html documents. The parameter specifies +the base URL for all relative URLs in the document. This is useful +for dynamically served html where the base URI needs to be +shifted.</para> + +</refsection> +</refentry> diff --git a/params/html.cellpadding.xml b/params/html.cellpadding.xml new file mode 100644 index 0000000..7240f0f --- /dev/null +++ b/params/html.cellpadding.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.cellpadding"> +<refmeta> +<refentrytitle>html.cellpadding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellpadding</refname> +<refpurpose>Default value for cellpadding in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.cellpadding.frag"> +<xsl:param name="html.cellpadding"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, this value will be used as the default cellpadding value +in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or +5%</para> + +</refsection> +</refentry> diff --git a/params/html.cellspacing.xml b/params/html.cellspacing.xml new file mode 100644 index 0000000..5ddfdac --- /dev/null +++ b/params/html.cellspacing.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.cellspacing"> +<refmeta> +<refentrytitle>html.cellspacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellspacing</refname> +<refpurpose>Default value for cellspacing in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.cellspacing.frag"> +<xsl:param name="html.cellspacing"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, this value will be used as the default cellspacing +value in HTML tables. nn for pixels or nn% for percentage +length. E.g. 5 or 5%</para> + +</refsection> +</refentry> diff --git a/params/html.cleanup.xml b/params/html.cleanup.xml new file mode 100644 index 0000000..e4fc0c8 --- /dev/null +++ b/params/html.cleanup.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.cleanup"> +<refmeta> +<refentrytitle>html.cleanup</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cleanup</refname> +<refpurpose>Attempt to clean up the resulting HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.cleanup.frag"> +<xsl:param name="html.cleanup" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, and if the <link xlink:href="http://www.exslt.org/">EXSLT</link> +extensions are supported by your processor, the resulting HTML will be +<quote>cleaned up</quote>. This improves the chances that the +resulting HTML will be valid. It may also improve the formatting of +some elements.</para> + +<para>This parameter is different from <parameter>make.valid.html</parameter> +because it uses extension functions to manipulate result-tree-fragments.</para> + +</refsection> +</refentry> diff --git a/params/html.ext.xml b/params/html.ext.xml new file mode 100644 index 0000000..8d6fd95 --- /dev/null +++ b/params/html.ext.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.ext"> +<refmeta> +<refentrytitle>html.ext</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.ext</refname> +<refpurpose>Identifies the extension of generated HTML files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.ext.frag"> +<xsl:param name="html.ext">.html</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The extension identified by <parameter>html.ext</parameter> will +be used as the filename extension for chunks created by this +stylesheet. </para> + +</refsection> +</refentry> diff --git a/params/html.extra.head.links.xml b/params/html.extra.head.links.xml new file mode 100644 index 0000000..ddc666f --- /dev/null +++ b/params/html.extra.head.links.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.extra.head.links"> +<refmeta> +<refentrytitle>html.extra.head.links</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.extra.head.links</refname> +<refpurpose>Toggle extra HTML head link information</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.extra.head.links.frag"> +<xsl:param name="html.extra.head.links" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extra <tag>link</tag> elements will be +generated in the <tag>head</tag> of chunked HTML files. These +extra links point to chapters, appendixes, sections, etc. as supported +by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). +</para> + +</refsection> +</refentry> diff --git a/params/html.head.legalnotice.link.multiple.xml b/params/html.head.legalnotice.link.multiple.xml new file mode 100644 index 0000000..7c0cba1 --- /dev/null +++ b/params/html.head.legalnotice.link.multiple.xml @@ -0,0 +1,44 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.head.legalnotice.link.multiple"> +<refmeta> +<refentrytitle>html.head.legalnotice.link.multiple</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.head.legalnotice.link.multiple</refname> +<refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.head.legalnotice.link.multiple.frag"> +<xsl:param name="html.head.legalnotice.link.multiple" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>html.head.legalnotice.link.multiple</parameter> is +non-zero and the value of +<parameter>html.head.legalnotice.link.types</parameter> contains +multiple link types, then the stylesheet generates (in the +<literal>head</literal> section of the HTML source) one +<literal>link</literal> element for each link type specified. For +example, if the value of +<parameter>html.head.legalnotice.link.types</parameter> is +“<literal>copyright license</literal>”: + +<screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"> + <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> + + Otherwise, the stylesheet generates generates a single + <literal>link</literal> instance; for example: + +<screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"></screen> + +</para> +</refsection> +</refentry> diff --git a/params/html.head.legalnotice.link.types.xml b/params/html.head.legalnotice.link.types.xml new file mode 100644 index 0000000..4ca02ff --- /dev/null +++ b/params/html.head.legalnotice.link.types.xml @@ -0,0 +1,75 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.head.legalnotice.link.types"> +<refmeta> +<refentrytitle>html.head.legalnotice.link.types</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.head.legalnotice.link.types</refname> +<refpurpose>Specifies link types for legalnotice link in html head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.head.legalnotice.link.types.frag"> +<xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of +<parameter>html.head.legalnotice.link.types</parameter> is a +space-separated list of link types, as described in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12 +of the HTML 4.01 specification</link>. If the value of the +<parameter>generate.legalnotice.link</parameter> parameter is +non-zero, then the stylesheet generates (in the +<literal>head</literal> section of the HTML source) either a single +HTML <literal>link</literal> element or, if the value of the +<parameter>html.head.legalnotice.link.multiple</parameter> is +non-zero, one <literal>link</literal> element for each link type +specified. Each <literal>link</literal> has the following attributes: + +<itemizedlist> + <listitem> + <para>a <tag class="attribute">rel</tag> attribute whose + value is derived from the value of + <parameter>html.head.legalnotice.link.types</parameter></para> + </listitem> + <listitem> + <para>an <tag class="attribute">href</tag> attribute whose + value is set to the URL of the file containing the + <tag>legalnotice</tag></para> + </listitem> + <listitem> + <para>a <tag class="attribute">title</tag> attribute whose + value is set to the title of the corresponding + <tag>legalnotice</tag> (or a title programatically + determined by the stylesheet)</para> + </listitem> +</itemizedlist> + +For example: + +<screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"></screen> +</para> + +<refsection><info><title>About the default value</title></info> + + <para>In an ideal world, the default value of + <parameter>html.head.legalnotice.link.types</parameter> would + probably be “<literal>license</literal>”, since the content of the + DocBook <tag>legalnotice</tag> is typically license + information, not copyright information. However, the default value + is “<literal>copyright</literal>” for pragmatic reasons: because + that’s among the set of “recognized link types” listed in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section + 6.12 of the HTML 4.01 specification</link>, and because certain + browsers and browser extensions are preconfigured to recognize that + value.</para> +</refsection> + +</refsection> +</refentry> diff --git a/params/html.longdesc.link.xml b/params/html.longdesc.link.xml new file mode 100644 index 0000000..2497563 --- /dev/null +++ b/params/html.longdesc.link.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.longdesc.link"> +<refmeta> +<refentrytitle>html.longdesc.link</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc.link</refname> +<refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.longdesc.link.frag"> +<xsl:param name="html.longdesc.link" select="$html.longdesc"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, links will be created to the +HTML files created for the +<literal>longdesc</literal> attribute. It makes no +sense to enable this option without also enabling the +<parameter>html.longdesc</parameter> parameter.</para> + +<!-- +<para>The <literal>longdesc.link</literal> named template is called +to construct the link.</para> +Assumption. That this documentation is for the user, do they need to know +how it's done? + +--> + +</refsection> +</refentry> diff --git a/params/html.longdesc.xml b/params/html.longdesc.xml new file mode 100644 index 0000000..10f341a --- /dev/null +++ b/params/html.longdesc.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.longdesc"> +<refmeta> +<refentrytitle>html.longdesc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc</refname> +<refpurpose>Should longdesc URIs be created?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="html.longdesc.frag"> +<xsl:param name="html.longdesc" select="1"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, HTML files will be created for the +<literal>longdesc</literal> attribute. These files +are created from the <tag>textobject</tag>s in +<tag>mediaobject</tag>s and +<tag>inlinemediaobject</tag>. +</para> +</refsection> +</refentry> diff --git a/params/html.script.type.xml b/params/html.script.type.xml new file mode 100644 index 0000000..bf6eb34 --- /dev/null +++ b/params/html.script.type.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.script.type"> +<refmeta> +<refentrytitle>html.script.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.script.type</refname> +<refpurpose>The type of script used in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.script.type.frag"><xsl:param name="html.script.type">text/javascript</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The type of script to place in the HTML <tag>script</tag> element. +Specifically, the value of the <tag>script</tag> element's <tag>type</tag> +attribute. +The default value is <literal>text/javascript</literal>. +This param is used only when the stylesheet parameter +<tag>html.script</tag> is non-blank and specifies the location of a script.</para> + + +</refsection> +</refentry> diff --git a/params/html.script.xml b/params/html.script.xml new file mode 100644 index 0000000..60dd9ed --- /dev/null +++ b/params/html.script.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.script"> +<refmeta> +<refentrytitle>html.script</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.script</refname> +<refpurpose>Name of the script(s) to use in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.script.frag"> +<xsl:param name="html.script" ></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>html.script</parameter> parameter is either +empty (default), indicating that no <tag>script</tag> element should be +generated in the html output, or it is a list of one or more +script locations.</para> + +<para>Multiple script locations are space-delimited. If you need to +reference a script URI that includes a space, encode it with +<literal>%20</literal>. A separate html <literal>script</literal> element will +be generated for each script in the order they are listed in the +parameter.</para> + +</refsection> +</refentry> diff --git a/params/html.stylesheet.type.xml b/params/html.stylesheet.type.xml new file mode 100644 index 0000000..f20b706 --- /dev/null +++ b/params/html.stylesheet.type.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.stylesheet.type"> +<refmeta> +<refentrytitle>html.stylesheet.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet.type</refname> +<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.stylesheet.type.frag"><xsl:param name="html.stylesheet.type">text/css</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The type of the stylesheet to place in the HTML <tag>link</tag> tag. +</para> + +</refsection> +</refentry> diff --git a/params/html.stylesheet.xml b/params/html.stylesheet.xml new file mode 100644 index 0000000..3407094 --- /dev/null +++ b/params/html.stylesheet.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="html.stylesheet"> +<refmeta> +<refentrytitle>html.stylesheet</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet</refname> +<refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="html.stylesheet.frag"> +<xsl:param name="html.stylesheet" ></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>html.stylesheet</parameter> parameter is either +empty, indicating that no stylesheet <tag>link</tag> tag should be +generated in the html output, or it is a list of one or more +stylesheet files.</para> + +<para>Multiple stylesheets are space-delimited. If you need to +reference a stylesheet URI that includes a space, encode it with +<literal>%20</literal>. A separate html <literal>link</literal> element will +be generated for each stylesheet in the order they are listed in the +parameter.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.alias.file.xml b/params/htmlhelp.alias.file.xml new file mode 100644 index 0000000..be11b28 --- /dev/null +++ b/params/htmlhelp.alias.file.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.alias.file"> +<refmeta> +<refentrytitle>htmlhelp.alias.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.alias.file</refname> +<refpurpose>Filename of alias file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.alias.file.frag"> +<xsl:param name="htmlhelp.alias.file">alias.h</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the alias file (used for context-sensitive help).</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.autolabel.xml b/params/htmlhelp.autolabel.xml new file mode 100644 index 0000000..1426d00 --- /dev/null +++ b/params/htmlhelp.autolabel.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.autolabel"> +<refmeta> +<refentrytitle>htmlhelp.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.autolabel.frag"> +<xsl:param name="htmlhelp.autolabel" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set this to non-zero to include chapter and section numbers into ToC +in the left panel.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.back.xml b/params/htmlhelp.button.back.xml new file mode 100644 index 0000000..1fc12bb --- /dev/null +++ b/params/htmlhelp.button.back.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.back"> +<refmeta> +<refentrytitle>htmlhelp.button.back</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.back</refname> +<refpurpose>Should the Back button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.back.frag"> +<xsl:param name="htmlhelp.button.back" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Hide/Show button shown on toolbar</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.forward.xml b/params/htmlhelp.button.forward.xml new file mode 100644 index 0000000..f6411bb --- /dev/null +++ b/params/htmlhelp.button.forward.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.forward"> +<refmeta> +<refentrytitle>htmlhelp.button.forward</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.forward</refname> +<refpurpose>Should the Forward button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.forward.frag"> +<xsl:param name="htmlhelp.button.forward" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Forward button on the toolbar.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.hideshow.xml b/params/htmlhelp.button.hideshow.xml new file mode 100644 index 0000000..04f1ff0 --- /dev/null +++ b/params/htmlhelp.button.hideshow.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.hideshow"> +<refmeta> +<refentrytitle>htmlhelp.button.hideshow</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.hideshow</refname> +<refpurpose>Should the Hide/Show button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.hideshow.frag"> +<xsl:param name="htmlhelp.button.hideshow" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Hide/Show button shown on toolbar</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.home.url.xml b/params/htmlhelp.button.home.url.xml new file mode 100644 index 0000000..3027507 --- /dev/null +++ b/params/htmlhelp.button.home.url.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.home.url"> +<refmeta> +<refentrytitle>htmlhelp.button.home.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home.url</refname> +<refpurpose>URL address of page accessible by Home button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.home.url.frag"> +<xsl:param name="htmlhelp.button.home.url"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Home button.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.home.xml b/params/htmlhelp.button.home.xml new file mode 100644 index 0000000..e4e97fe --- /dev/null +++ b/params/htmlhelp.button.home.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.home"> +<refmeta> +<refentrytitle>htmlhelp.button.home</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home</refname> +<refpurpose>Should the Home button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.home.frag"> +<xsl:param name="htmlhelp.button.home" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Home button on the toolbar.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump1.title.xml b/params/htmlhelp.button.jump1.title.xml new file mode 100644 index 0000000..aa9da59 --- /dev/null +++ b/params/htmlhelp.button.jump1.title.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump1.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.title</refname> +<refpurpose>Title of Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump1.title.frag"> +<xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Title of Jump1 button.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump1.url.xml b/params/htmlhelp.button.jump1.url.xml new file mode 100644 index 0000000..22248c4 --- /dev/null +++ b/params/htmlhelp.button.jump1.url.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump1.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.url</refname> +<refpurpose>URL address of page accessible by Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump1.url.frag"> +<xsl:param name="htmlhelp.button.jump1.url"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Jump1 button.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump1.xml b/params/htmlhelp.button.jump1.xml new file mode 100644 index 0000000..f6f8d9c --- /dev/null +++ b/params/htmlhelp.button.jump1.xml @@ -0,0 +1,23 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump1"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1</refname> +<refpurpose>Should the Jump1 button be shown?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump1.frag"> +<xsl:param name="htmlhelp.button.jump1" select="0"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para> +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump2.title.xml b/params/htmlhelp.button.jump2.title.xml new file mode 100644 index 0000000..3b5f124 --- /dev/null +++ b/params/htmlhelp.button.jump2.title.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump2.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.title</refname> +<refpurpose>Title of Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump2.title.frag"> +<xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Title of Jump2 button.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump2.url.xml b/params/htmlhelp.button.jump2.url.xml new file mode 100644 index 0000000..dcd2434 --- /dev/null +++ b/params/htmlhelp.button.jump2.url.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump2.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.url</refname> +<refpurpose>URL address of page accessible by Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump2.url.frag"> +<xsl:param name="htmlhelp.button.jump2.url"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>URL address of page accessible by Jump2 button.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.jump2.xml b/params/htmlhelp.button.jump2.xml new file mode 100644 index 0000000..916b1ee --- /dev/null +++ b/params/htmlhelp.button.jump2.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.jump2"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2</refname> +<refpurpose>Should the Jump2 button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.jump2.frag"> +<xsl:param name="htmlhelp.button.jump2" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Jump2 button on the toolbar.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.locate.xml b/params/htmlhelp.button.locate.xml new file mode 100644 index 0000000..5b55552 --- /dev/null +++ b/params/htmlhelp.button.locate.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.locate"> +<refmeta> +<refentrytitle>htmlhelp.button.locate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.locate</refname> +<refpurpose>Should the Locate button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.locate.frag"> +<xsl:param name="htmlhelp.button.locate" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Locate button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.next.xml b/params/htmlhelp.button.next.xml new file mode 100644 index 0000000..b5352b2 --- /dev/null +++ b/params/htmlhelp.button.next.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.next"> +<refmeta> +<refentrytitle>htmlhelp.button.next</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.next</refname> +<refpurpose>Should the Next button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.next.frag"> +<xsl:param name="htmlhelp.button.next" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Next button on the toolbar.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.options.xml b/params/htmlhelp.button.options.xml new file mode 100644 index 0000000..21bed81 --- /dev/null +++ b/params/htmlhelp.button.options.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.options"> +<refmeta> +<refentrytitle>htmlhelp.button.options</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.options</refname> +<refpurpose>Should the Options button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.options.frag"> +<xsl:param name="htmlhelp.button.options" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Options button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.prev.xml b/params/htmlhelp.button.prev.xml new file mode 100644 index 0000000..a6d989b --- /dev/null +++ b/params/htmlhelp.button.prev.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.prev"> +<refmeta> +<refentrytitle>htmlhelp.button.prev</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.prev</refname> +<refpurpose>Should the Prev button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.prev.frag"> +<xsl:param name="htmlhelp.button.prev" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Prev button on the toolbar. +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.print.xml b/params/htmlhelp.button.print.xml new file mode 100644 index 0000000..1c0e816 --- /dev/null +++ b/params/htmlhelp.button.print.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.print"> +<refmeta> +<refentrytitle>htmlhelp.button.print</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.print</refname> +<refpurpose>Should the Print button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.print.frag"> +<xsl:param name="htmlhelp.button.print" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Print button on the toolbar. +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.refresh.xml b/params/htmlhelp.button.refresh.xml new file mode 100644 index 0000000..294fcbe --- /dev/null +++ b/params/htmlhelp.button.refresh.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.refresh"> +<refmeta> +<refentrytitle>htmlhelp.button.refresh</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.refresh</refname> +<refpurpose>Should the Refresh button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.refresh.frag"> +<xsl:param name="htmlhelp.button.refresh" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Stop button on the toolbar.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.stop.xml b/params/htmlhelp.button.stop.xml new file mode 100644 index 0000000..fdbe549 --- /dev/null +++ b/params/htmlhelp.button.stop.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.stop"> +<refmeta> +<refentrytitle>htmlhelp.button.stop</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.stop</refname> +<refpurpose>Should the Stop button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.stop.frag"> +<xsl:param name="htmlhelp.button.stop" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want Stop button shown on toolbar, turn this +parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.button.zoom.xml b/params/htmlhelp.button.zoom.xml new file mode 100644 index 0000000..a25dc40 --- /dev/null +++ b/params/htmlhelp.button.zoom.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.button.zoom"> +<refmeta> +<refentrytitle>htmlhelp.button.zoom</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.zoom</refname> +<refpurpose>Should the Zoom button be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.button.zoom.frag"> +<xsl:param name="htmlhelp.button.zoom" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include the Zoom button on the toolbar. +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.chm.xml b/params/htmlhelp.chm.xml new file mode 100644 index 0000000..51cba30 --- /dev/null +++ b/params/htmlhelp.chm.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.chm"> +<refmeta> +<refentrytitle>htmlhelp.chm</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.chm</refname> +<refpurpose>Filename of output HTML Help file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.chm.frag"> +<xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the name of resulting CHM file</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.default.topic.xml b/params/htmlhelp.default.topic.xml new file mode 100644 index 0000000..577f440 --- /dev/null +++ b/params/htmlhelp.default.topic.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.default.topic"> +<refmeta> +<refentrytitle>htmlhelp.default.topic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.default.topic</refname> +<refpurpose>Name of file with default topic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.default.topic.frag"> +<xsl:param name="htmlhelp.default.topic"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Normally first chunk of document is displayed when you open HTML +Help file. If you want to display another topic, simply set its +filename by this parameter.</para> + +<para>This is useful especially if you don't generate ToC in front of +your document and you also hide root element in ToC. E.g.:</para> + +<programlisting><xsl:param name="generate.book.toc" select="0"/> +<xsl:param name="htmlhelp.hhc.show.root" select="0"/> +<xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param> +</programlisting> + +</refsection> +</refentry> diff --git a/params/htmlhelp.display.progress.xml b/params/htmlhelp.display.progress.xml new file mode 100644 index 0000000..eab1c96 --- /dev/null +++ b/params/htmlhelp.display.progress.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.display.progress"> +<refmeta> +<refentrytitle>htmlhelp.display.progress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.display.progress</refname> +<refpurpose>Display compile progress?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.display.progress.frag"> +<xsl:param name="htmlhelp.display.progress" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to to display compile progress +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.encoding.xml b/params/htmlhelp.encoding.xml new file mode 100644 index 0000000..d69392d --- /dev/null +++ b/params/htmlhelp.encoding.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.encoding"> +<refmeta> +<refentrytitle>htmlhelp.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.encoding</refname> +<refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.encoding.frag"> +<xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The HTML Help Compiler is not UTF-8 aware, so you should always use an +appropriate single-byte encoding here. See also <link xlink:href="HtmlHelp.html#HelpProcOptions" +role="tcg">Processing options</link>.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.enhanced.decompilation.xml b/params/htmlhelp.enhanced.decompilation.xml new file mode 100644 index 0000000..558e89b --- /dev/null +++ b/params/htmlhelp.enhanced.decompilation.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.enhanced.decompilation"> +<refmeta> +<refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enhanced.decompilation</refname> +<refpurpose>Allow enhanced decompilation of CHM?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.enhanced.decompilation.frag"> +<xsl:param name="htmlhelp.enhanced.decompilation" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When non-zero this parameter enables enhanced decompilation of CHM.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.enumerate.images.xml b/params/htmlhelp.enumerate.images.xml new file mode 100644 index 0000000..a2aaac8 --- /dev/null +++ b/params/htmlhelp.enumerate.images.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.enumerate.images"> +<refmeta> +<refentrytitle>htmlhelp.enumerate.images</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enumerate.images</refname> +<refpurpose>Should the paths to all used images be added to the project file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.enumerate.images.frag"> +<xsl:param name="htmlhelp.enumerate.images" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero if you insert images into your documents as +external binary entities or if you are using absolute image paths.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.force.map.and.alias.xml b/params/htmlhelp.force.map.and.alias.xml new file mode 100644 index 0000000..7dca30b --- /dev/null +++ b/params/htmlhelp.force.map.and.alias.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.force.map.and.alias"> +<refmeta> +<refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.force.map.and.alias</refname> +<refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.force.map.and.alias.frag"> +<xsl:param name="htmlhelp.force.map.and.alias" select="0"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + <para>Set to non-zero if you have your own + <literal>alias.h</literal> and <literal>context.h</literal> + files and you want to include references to them in the project + file.</para> +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.binary.xml b/params/htmlhelp.hhc.binary.xml new file mode 100644 index 0000000..ea978f7 --- /dev/null +++ b/params/htmlhelp.hhc.binary.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc.binary"> +<refmeta> +<refentrytitle>htmlhelp.hhc.binary</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.binary</refname> +<refpurpose>Generate binary ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.binary.frag"> +<xsl:param name="htmlhelp.hhc.binary" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to generate a binary TOC. You must create a binary TOC +if you want to add Prev/Next buttons to toolbar (which is default +behaviour). Files with binary TOC can't be merged.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.folders.instead.books.xml b/params/htmlhelp.hhc.folders.instead.books.xml new file mode 100644 index 0000000..ca36e5a --- /dev/null +++ b/params/htmlhelp.hhc.folders.instead.books.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc.folders.instead.books"> +<refmeta> +<refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.folders.instead.books</refname> +<refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.folders.instead.books.frag"> +<xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC. +If you want to use folder-like icons, you must switch off the binary ToC using +<parameter>htmlhelp.hhc.binary</parameter>. + +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.section.depth.xml b/params/htmlhelp.hhc.section.depth.xml new file mode 100644 index 0000000..35c492a --- /dev/null +++ b/params/htmlhelp.hhc.section.depth.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc.section.depth"> +<refmeta> +<refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.section.depth</refname> +<refpurpose>Depth of TOC for sections in a left pane.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.section.depth.frag"> +<xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the section depth in the left pane of HTML Help viewer. </para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.show.root.xml b/params/htmlhelp.hhc.show.root.xml new file mode 100644 index 0000000..0de26b9 --- /dev/null +++ b/params/htmlhelp.hhc.show.root.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc.show.root"> +<refmeta> +<refentrytitle>htmlhelp.hhc.show.root</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.show.root</refname> +<refpurpose>Should there be an entry for the root element in the ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.show.root.frag"> +<xsl:param name="htmlhelp.hhc.show.root" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If set to zero, there will be no entry for the root element in the +ToC. This is useful when you want to provide the user with an expanded +ToC as a default.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.width.xml b/params/htmlhelp.hhc.width.xml new file mode 100644 index 0000000..4011399 --- /dev/null +++ b/params/htmlhelp.hhc.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc.width"> +<refmeta> +<refentrytitle>htmlhelp.hhc.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.width</refname> +<refpurpose>Width of navigation pane</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.width.frag"> +<xsl:param name="htmlhelp.hhc.width"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the width of the navigation pane (containing TOC and +other navigation tabs) in pixels.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhc.xml b/params/htmlhelp.hhc.xml new file mode 100644 index 0000000..475ef20 --- /dev/null +++ b/params/htmlhelp.hhc.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhc"> +<refmeta> +<refentrytitle>htmlhelp.hhc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc</refname> +<refpurpose>Filename of TOC file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhc.frag"> +<xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhk.xml b/params/htmlhelp.hhk.xml new file mode 100644 index 0000000..aee473e --- /dev/null +++ b/params/htmlhelp.hhk.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhk"> +<refmeta> +<refentrytitle>htmlhelp.hhk</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhk</refname> +<refpurpose>Filename of index file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhk.frag"> +<xsl:param name="htmlhelp.hhk">index.hhk</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>set the name of the index file. The default is <filename>index.hhk</filename>.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhp.tail.xml b/params/htmlhelp.hhp.tail.xml new file mode 100644 index 0000000..c239b9a --- /dev/null +++ b/params/htmlhelp.hhp.tail.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhp.tail"> +<refmeta> +<refentrytitle>htmlhelp.hhp.tail</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.tail</refname> +<refpurpose>Additional content for project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhp.tail.frag"> +<xsl:param name="htmlhelp.hhp.tail"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want to include some additional parameters into project file, +store appropriate part of project file into this parameter.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhp.window.xml b/params/htmlhelp.hhp.window.xml new file mode 100644 index 0000000..6c29eed --- /dev/null +++ b/params/htmlhelp.hhp.window.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhp.window"> +<refmeta> +<refentrytitle>htmlhelp.hhp.window</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.window</refname> +<refpurpose>Name of default window.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhp.window.frag"> +<xsl:param name="htmlhelp.hhp.window">Main</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Name of default window. If empty no [WINDOWS] section will be +added to project file.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhp.windows.xml b/params/htmlhelp.hhp.windows.xml new file mode 100644 index 0000000..afd435f --- /dev/null +++ b/params/htmlhelp.hhp.windows.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhp.windows"> +<refmeta> +<refentrytitle>htmlhelp.hhp.windows</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.windows</refname> +<refpurpose>Definition of additional windows</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhp.windows.frag"> +<xsl:param name="htmlhelp.hhp.windows"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Content of this parameter is placed at the end of [WINDOWS] +section of project file. You can use it for defining your own +addtional windows.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.hhp.xml b/params/htmlhelp.hhp.xml new file mode 100644 index 0000000..74954d7 --- /dev/null +++ b/params/htmlhelp.hhp.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.hhp"> +<refmeta> +<refentrytitle>htmlhelp.hhp</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp</refname> +<refpurpose>Filename of project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.hhp.frag"> +<xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Change this parameter if you want different name of project +file than htmlhelp.hhp.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.map.file.xml b/params/htmlhelp.map.file.xml new file mode 100644 index 0000000..b47c565 --- /dev/null +++ b/params/htmlhelp.map.file.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.map.file"> +<refmeta> +<refentrytitle>htmlhelp.map.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.map.file</refname> +<refpurpose>Filename of map file.</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.map.file.frag"> +<xsl:param name="htmlhelp.map.file">context.h</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Set the name of map file. The default is + <filename>context.h</filename>. (used for context-sensitive + help).</para> +</refsection> +</refentry> diff --git a/params/htmlhelp.only.xml b/params/htmlhelp.only.xml new file mode 100644 index 0000000..f10dbf5 --- /dev/null +++ b/params/htmlhelp.only.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.only"> +<refmeta> +<refentrytitle>htmlhelp.only</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.only</refname> +<refpurpose>Should only project files be generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.only.frag"> +<xsl:param name="htmlhelp.only" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + + +<para>Set to non-zero if you want to play with various HTML Help parameters +and you don't need to regenerate all HTML files. This setting will not +process whole document, only project files (hhp, hhc, hhk,...) will be +generated.</para> + + +</refsection> +</refentry> diff --git a/params/htmlhelp.remember.window.position.xml b/params/htmlhelp.remember.window.position.xml new file mode 100644 index 0000000..3aaea1f --- /dev/null +++ b/params/htmlhelp.remember.window.position.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.remember.window.position"> +<refmeta> +<refentrytitle>htmlhelp.remember.window.position</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.remember.window.position</refname> +<refpurpose>Remember help window position?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.remember.window.position.frag"> +<xsl:param name="htmlhelp.remember.window.position" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to remember help window position between starts.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.show.advanced.search.xml b/params/htmlhelp.show.advanced.search.xml new file mode 100644 index 0000000..3aa09a6 --- /dev/null +++ b/params/htmlhelp.show.advanced.search.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.show.advanced.search"> +<refmeta> +<refentrytitle>htmlhelp.show.advanced.search</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.advanced.search</refname> +<refpurpose>Should advanced search features be available?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.show.advanced.search.frag"> +<xsl:param name="htmlhelp.show.advanced.search" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want advanced search features in your help, turn this +parameter to 1.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.show.favorities.xml b/params/htmlhelp.show.favorities.xml new file mode 100644 index 0000000..925bbb1 --- /dev/null +++ b/params/htmlhelp.show.favorities.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.show.favorities"> +<refmeta> +<refentrytitle>htmlhelp.show.favorities</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.favorities</refname> +<refpurpose>Should the Favorites tab be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.show.favorities.frag"> +<xsl:param name="htmlhelp.show.favorities" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to include a Favorites tab in the navigation pane +of the help window.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.show.menu.xml b/params/htmlhelp.show.menu.xml new file mode 100644 index 0000000..b3d6285 --- /dev/null +++ b/params/htmlhelp.show.menu.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.show.menu"> +<refmeta> +<refentrytitle>htmlhelp.show.menu</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.menu</refname> +<refpurpose>Should the menu bar be shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.show.menu.frag"> +<xsl:param name="htmlhelp.show.menu" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to have an application menu bar in your HTML Help window. +</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.show.toolbar.text.xml b/params/htmlhelp.show.toolbar.text.xml new file mode 100644 index 0000000..fc87d9c --- /dev/null +++ b/params/htmlhelp.show.toolbar.text.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.show.toolbar.text"> +<refmeta> +<refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.toolbar.text</refname> +<refpurpose>Show text under toolbar buttons?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.show.toolbar.text.frag"> +<xsl:param name="htmlhelp.show.toolbar.text" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set to non-zero to display texts under toolbar buttons, zero to switch +off displays.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.title.xml b/params/htmlhelp.title.xml new file mode 100644 index 0000000..f4397ca --- /dev/null +++ b/params/htmlhelp.title.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.title"> +<refmeta> +<refentrytitle>htmlhelp.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.title</refname> +<refpurpose>Title of HTML Help</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.title.frag"> +<xsl:param name="htmlhelp.title"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Content of this parameter will be used as a title for generated +HTML Help. If empty, title will be automatically taken from document.</para> + +</refsection> +</refentry> diff --git a/params/htmlhelp.use.hhk.xml b/params/htmlhelp.use.hhk.xml new file mode 100644 index 0000000..720c1e2 --- /dev/null +++ b/params/htmlhelp.use.hhk.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.use.hhk"> +<refmeta> +<refentrytitle>htmlhelp.use.hhk</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.use.hhk</refname> +<refpurpose>Should the index be built using the HHK file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.use.hhk.frag"> +<xsl:param name="htmlhelp.use.hhk" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag> +elements in the HTML files). For more information, see <link +role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para> +</refsection> +</refentry> diff --git a/params/htmlhelp.window.geometry.xml b/params/htmlhelp.window.geometry.xml new file mode 100644 index 0000000..0ec75f7 --- /dev/null +++ b/params/htmlhelp.window.geometry.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="htmlhelp.window.geometry"> +<refmeta> +<refentrytitle>htmlhelp.window.geometry</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.window.geometry</refname> +<refpurpose>Set initial geometry of help window</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="htmlhelp.window.geometry.frag"> +<xsl:param name="htmlhelp.window.geometry"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies initial position of help +window. E.g.</para> + +<programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param></programlisting> + +</refsection> +</refentry> diff --git a/params/hyphenate.verbatim.characters.xml b/params/hyphenate.verbatim.characters.xml new file mode 100644 index 0000000..e6cae20 --- /dev/null +++ b/params/hyphenate.verbatim.characters.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="hyphenate.verbatim.characters"> +<refmeta> +<refentrytitle>hyphenate.verbatim.characters</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>hyphenate.verbatim.characters</refname> +<refpurpose>List of characters after which a line break can occur in listings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="hyphenate.verbatim.characters.frag"> +<xsl:param name="hyphenate.verbatim.characters"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you enable <parameter>hyphenate.verbatim</parameter> line +breaks are allowed only on space characters. If this is not enough for +your document, you can specify list of additional characters after +which line break is allowed in this parameter.</para> + +</refsection> +</refentry> diff --git a/params/hyphenate.verbatim.xml b/params/hyphenate.verbatim.xml new file mode 100644 index 0000000..c66e700 --- /dev/null +++ b/params/hyphenate.verbatim.xml @@ -0,0 +1,45 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="hyphenate.verbatim"> +<refmeta> +<refentrytitle>hyphenate.verbatim</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>hyphenate.verbatim</refname> +<refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the lines of program listing are too long to fit into one +line it is quite common to split them at space and indicite by hook +arrow that code continues on the next line. You can turn on this +behaviour for <tag>programlisting</tag>, +<tag>screen</tag> and <tag>synopsis</tag> elements by +using this parameter.</para> + +<para>Note that you must also enable line wrapping for verbatim environments and +select appropriate hyphenation character (e.g. hook arrow). This can +be done using <parameter>monospace.verbatim.properties</parameter> +attribute set:</para> + +<programlisting><xsl:attribute-set name="monospace.verbatim.properties" + use-attribute-sets="verbatim.properties monospace.properties"> + <xsl:attribute name="wrap-option">wrap</xsl:attribute> + <xsl:attribute name="hyphenation-character">&#x25BA;</xsl:attribute> +</xsl:attribute-set></programlisting> + +<para>For a list of arrows available in Unicode see <uri xlink:href="http://www.unicode.org/charts/PDF/U2190.pdf">http://www.unicode.org/charts/PDF/U2190.pdf</uri> and <uri xlink:href="http://www.unicode.org/charts/PDF/U2900.pdf">http://www.unicode.org/charts/PDF/U2900.pdf</uri> and make sure that +selected character is available in the font you are using for verbatim +environments.</para> + +</refsection> +</refentry> diff --git a/params/hyphenate.xml b/params/hyphenate.xml new file mode 100644 index 0000000..aa6e129 --- /dev/null +++ b/params/hyphenate.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="hyphenate"> +<refmeta> +<refentrytitle>hyphenate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">closed</refmiscinfo> +<refmiscinfo class="other" otherclass="value">true</refmiscinfo> +<refmiscinfo class="other" otherclass="value">false</refmiscinfo> +</refmeta> +<refnamediv> +<refname>hyphenate</refname> +<refpurpose>Specify hyphenation behavior</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="hyphenate.frag"><xsl:param name="hyphenate">true</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, words may be hyphenated. Otherwise, they may not.</para> +<para>See also <parameter>ulink.hyphenate.chars</parameter> </para> + +</refsection> +</refentry> diff --git a/params/id.warnings.xml b/params/id.warnings.xml new file mode 100644 index 0000000..7b2716f --- /dev/null +++ b/params/id.warnings.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="id.warnings"> +<refmeta> +<refentrytitle>id.warnings</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>id.warnings</refname> +<refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="id.warnings.frag"> +<xsl:param name="id.warnings" select="0"/> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, the stylesheet will issue a warning for any element +(other than the root element) which has a <tag>title</tag> but does not have an +ID.</para> +</refsection> +</refentry> diff --git a/params/ignore.image.scaling.xml b/params/ignore.image.scaling.xml new file mode 100644 index 0000000..c35d178 --- /dev/null +++ b/params/ignore.image.scaling.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ignore.image.scaling"> +<refmeta> +<refentrytitle>ignore.image.scaling</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ignore.image.scaling</refname> +<refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ignore.image.scaling.frag"> +<xsl:param name="ignore.image.scaling" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the scaling attributes on graphics and media objects are +ignored.</para> + +</refsection> +</refentry> diff --git a/params/img.src.path.xml b/params/img.src.path.xml new file mode 100644 index 0000000..d295019 --- /dev/null +++ b/params/img.src.path.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="img.src.path"> +<refmeta> +<refentrytitle>img.src.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>img.src.path</refname> +<refpurpose>Path to HTML/FO image files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="img.src.path.frag"><xsl:param name="img.src.path"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Add a path prefix to the value of the <tag class="attribute">fileref</tag> +attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting +compound path is used in the output as the value of the <tag class="attribute">src</tag> +attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO). +</para> + +<para> +The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO +files are created, or it could be an absolute URI. +The default value is empty. +Be sure to include a trailing slash if needed. +</para> + +<para>This prefix is not applied to any filerefs that start +with "/" or contain "//:". +</para> + +</refsection> +</refentry> diff --git a/params/index.div.title.properties.xml b/params/index.div.title.properties.xml new file mode 100644 index 0000000..edbec2f --- /dev/null +++ b/params/index.div.title.properties.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.div.title.properties"> +<refmeta> +<refentrytitle>index.div.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.div.title.properties</refname> +<refpurpose>Properties associated with the letter headings in an +index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.div.title.properties.frag"> +<xsl:attribute-set name="index.div.title.properties"> + <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute> + <xsl:attribute name="font-size">14.4pt</xsl:attribute> + <xsl:attribute name="font-family"><xsl:value-of select="$title.fontset"/></xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.optimum"><xsl:value-of select="concat($body.font.master,'pt')"/></xsl:attribute> + <xsl:attribute name="space-before.minimum"><xsl:value-of select="concat($body.font.master,'pt * 0.8')"/></xsl:attribute> + <xsl:attribute name="space-before.maximum"><xsl:value-of select="concat($body.font.master,'pt * 1.2')"/></xsl:attribute> + <xsl:attribute name="start-indent">0pt</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is used on the letter headings that separate +the divisions in an index.</para> + +</refsection> +</refentry> diff --git a/params/index.entry.properties.xml b/params/index.entry.properties.xml new file mode 100644 index 0000000..3232358 --- /dev/null +++ b/params/index.entry.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.entry.properties"> +<refmeta> +<refentrytitle>index.entry.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.entry.properties</refname> +<refpurpose>Properties applied to the formatted entries +in an index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.entry.properties.frag"> +<xsl:attribute-set name="index.entry.properties"> + <xsl:attribute name="start-indent">0pt</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is applied to the block containing +the entries in a letter division in an index. It can be used to set the +font-size, font-family, and other inheritable properties that will be +applied to all index entries.</para> + +</refsection> +</refentry> diff --git a/params/index.links.to.section.xml b/params/index.links.to.section.xml new file mode 100644 index 0000000..47c0da5 --- /dev/null +++ b/params/index.links.to.section.xml @@ -0,0 +1,76 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.links.to.section"> +<refmeta> +<refentrytitle>index.links.to.section</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.links.to.section</refname> +<refpurpose>HTML index entries link to container section title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.links.to.section.frag"> +<xsl:param name="index.links.to.section" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero, then an index entry in an index links +directly to the location of the +generated <tag>anchor</tag> that is output +for the indexterm. If two identical indexterm elements +exist in the same section, then both entries appear +in the index with the same title but link to different +locations.</para> + +<para>If non-zero, then an index entry in an index links to the +section title containing the <tag>indexterm</tag>, rather than +directly to the <tag>anchor</tag> output for the indexterm. +Duplicate indexterm entries in the same section are dropped. +</para> + +<para>The default value is 1, so index entries link to +section titles by default.</para> + +<para>In both cases, the link text in an index entry is the +title of the section containing the indexterm. +That is because HTML does not have numbered pages. +It also provides the reader with context information +for each link.</para> + +<para>This parameter lets you choose which style of +index linking you want. </para> + +<itemizedlist> +<listitem> +<para>When set to 0, an index entry takes you +to the precise location of its corresponding indexterm. +However, if you have a lot of duplicate +entries in sections, then you have a lot of duplicate +titles in the index, which makes it more cluttered. +The reader may not recognize why duplicate titles +appear until they follow the links. Also, the links +may land the reader in the middle of a section where the +section title is not visible, which may also be +confusing to the reader.</para> +</listitem> +<listitem> +<para>When set to 1, an index entry link is +less precise, but duplicate titles in the +index entries are eliminated. +Landing on the section title location may confirm the reader's +expectation that a link that +shows a section title will take them to that section title, +not a location within the section. +</para> +</listitem> +</itemizedlist> + +</refsection> +</refentry> diff --git a/params/index.method.xml b/params/index.method.xml new file mode 100644 index 0000000..2127956 --- /dev/null +++ b/params/index.method.xml @@ -0,0 +1,162 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.method"> +<refmeta> +<refentrytitle>index.method</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">basic</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kosek</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kimber</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.method</refname> +<refpurpose>Select method used to group index entries in an index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.method.frag"> +<xsl:param name="index.method">basic</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter lets you select which method to use for sorting and grouping + index entries in an index. +Indexes in Latin-based languages that have accented characters typically +sort together accented words and unaccented words. +Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together +with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote> +section of the index. +Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet) +and languages using ideographic chararacters (such as Japanese) +require grouping specific to the languages and alphabets. +</para> + +<para>The default indexing method is limited. +It can group accented characters in Latin-based languages only. +It cannot handle non-Latin alphabets or ideographic languages. +The other indexing methods require extensions of one type or +another, and do not work with +all XSLT processors, which is why they are not used by default.</para> + +<para>The three choices for indexing method are:</para> +<variablelist> +<varlistentry> +<term><literal>basic</literal></term> +<listitem> +<para> +(default) Sort and groups words based only on the Latin alphabet. +Words with accented Latin letters will group and sort with +their respective primary letter, but +words in non-Latin alphabets will be +put in the <quote>Symbols</quote> section of the index. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>kosek</literal></term> +<listitem> +<para> +This method sorts and groups words based on letter groups configured in +the DocBook locale file for the given language. +See, for example, the French locale file <filename>common/fr.xml</filename>. +This method requires that the XSLT processor +supports the EXSLT extensions (most do). +It also requires support for using +user-defined functions in xsl:key (xsltproc does not). +</para> +<para>This method is suitable for any language for which you can +list all the individual characters that should appear +in each letter group in an index. +It is probably not practical to use it for ideographic languages +such as Chinese that have hundreds or thousands of characters. +</para> + +<para>To use the kosek method, you must:</para> + +<orderedlist> +<listitem> +<para>Use a processor that supports its extensions, such as +Saxon 6 or Xalan (xsltproc and Saxon 8 do not). +</para> +</listitem> +<listitem> +<para>Set the index.method parameter's value to <quote>kosek</quote>. +</para> +</listitem> +<listitem> +<para>Import the appropriate index extensions stylesheet module +<filename>fo/autoidx-kosek.xsl</filename> or +<filename>html/autoidx-kosek.xsl</filename> into your +customization. +</para> +</listitem> +</orderedlist> + +</listitem> +</varlistentry> +<varlistentry> +<term><literal>kimber</literal></term> +<listitem> +<para> +This method uses extensions to the Saxon processor to implement +sophisticated indexing processes. It uses its own +configuration file, which can include information for any number of +languages. Each language's configuration can group +words using one of two processes. In the +enumerated process similar to that used in the kosek method, +you indicate the groupings character-by-character. +In the between-key process, you specify the +break-points in the sort order that should start a new group. +The latter configuration is useful for ideographic languages +such as Chinese, Japanese, and Korean. +You can also define your own collation algorithms and how you +want mixed Latin-alphabet words sorted.</para> +<itemizedlist> +<listitem> +<para>For a whitepaper describing the extensions, see: +<link xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>. +</para> +</listitem> +<listitem> +<para>To download the extension library, see +<link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>. +</para> +</listitem> +</itemizedlist> + +<para>To use the kimber method, you must:</para> + +<orderedlist> +<listitem> +<para>Use Saxon (version 6 or 8) as your XSLT processor. +</para> +</listitem> +<listitem> +<para>Install and configure the Innodata Isogen library, using +the documentation that comes with it. +</para> +</listitem> +<listitem> +<para>Set the index.method parameter's value to <quote>kimber</quote>. +</para> +</listitem> +<listitem> +<para>Import the appropriate index extensions stylesheet module +<filename>fo/autoidx-kimber.xsl</filename> or +<filename>html/autoidx-kimber.xsl</filename> into your +customization. +</para> +</listitem> +</orderedlist> + +</listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> diff --git a/params/index.number.separator.xml b/params/index.number.separator.xml new file mode 100644 index 0000000..8f51512 --- /dev/null +++ b/params/index.number.separator.xml @@ -0,0 +1,54 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.number.separator"> +<refmeta> +<refentrytitle>index.number.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.number.separator</refname> +<refpurpose>Override for punctuation separating page numbers in index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.number.separator.frag"> +<xsl:param name="index.number.separator"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter permits you to override the text to insert between +page references in a formatted index entry. Typically +that would be a comma and a space. +</para> + +<para>Because this text may be locale dependent, +this parameter's value is normally taken from a gentext +template named 'number-separator' in the +context 'index' in the stylesheet +locale file for the language +of the current document. +This parameter can be used to override the gentext string, +and would typically be used on the command line. +This parameter would apply to all languages. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> parameter, or you can +override the gentext with the content of this parameter. +The content can be a simple string, or it can be +something more complex such as a call-template. +</para> + +<para>In HTML index output, section title references are used instead of +page number references. This punctuation appears between +such section titles in an HTML index. +</para> + +</refsection> +</refentry> diff --git a/params/index.on.role.xml b/params/index.on.role.xml new file mode 100644 index 0000000..81d65dd --- /dev/null +++ b/params/index.on.role.xml @@ -0,0 +1,48 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.on.role"> +<refmeta> +<refentrytitle>index.on.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.role</refname> +<refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.on.role.frag"> +<xsl:param name="index.on.role" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, +then an <tag>index</tag> element that has a +<tag class="attribute">role</tag> attribute +value will contain only those <tag>indexterm</tag> +elements with a matching role value. +If an <tag>index</tag> has no <tag class="attribute">role</tag> +attribute or it is blank, then the index will contain +all <tag>indexterm</tag>s in the current scope. +</para> +<para> +If <literal>index.on.role</literal> is zero, then the +<tag class="attribute">role</tag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>If you are using DocBook version 4.3 or later, you should +use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag> +on <tag>indexterm</tag> and <tag>index</tag>, +and set the <parameter>index.on.type</parameter> to a nonzero +value. +</para> + +</refsection> +</refentry> diff --git a/params/index.on.type.xml b/params/index.on.type.xml new file mode 100644 index 0000000..a5189c7 --- /dev/null +++ b/params/index.on.type.xml @@ -0,0 +1,52 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.on.type"> +<refmeta> +<refentrytitle>index.on.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.type</refname> +<refpurpose>Select indexterms based on <tag class="attribute">type</tag> +attribute value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.on.type.frag"> +<xsl:param name="index.on.type" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, +then an <tag>index</tag> element that has a +<tag class="attribute">type</tag> attribute +value will contain only those <tag>indexterm</tag> +elements with a matching <tag class="attribute">type</tag> attribute value. +If an <tag>index</tag> has no <tag class="attribute">type</tag> +attribute or it is blank, then the index will contain +all <tag>indexterm</tag>s in the current scope. +</para> + +<para> +If <literal>index.on.type</literal> is zero, then the +<tag class="attribute">type</tag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>For those using DocBook version 4.2 or earlier, +the <tag class="attribute">type</tag> attribute is not available +for index terms. However, you can achieve the same +effect by using the <tag class="attribute">role</tag> attribute +in the same manner on <tag>indexterm</tag> +and <tag>index</tag>, and setting the stylesheet parameter +<parameter>index.on.role</parameter> to a nonzero value. +</para> + +</refsection> +</refentry> diff --git a/params/index.page.number.properties.xml b/params/index.page.number.properties.xml new file mode 100644 index 0000000..74d105a --- /dev/null +++ b/params/index.page.number.properties.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.page.number.properties"> +<refmeta> +<refentrytitle>index.page.number.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.page.number.properties</refname> +<refpurpose>Properties associated with index page numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.page.number.properties.frag"> +<xsl:attribute-set name="index.page.number.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties associated with page numbers in indexes. +Changing color to indicate the page number is a link is +one possibility. +</para> + +</refsection> +</refentry> diff --git a/params/index.prefer.titleabbrev.xml b/params/index.prefer.titleabbrev.xml new file mode 100644 index 0000000..3f010ae --- /dev/null +++ b/params/index.prefer.titleabbrev.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.prefer.titleabbrev"> +<refmeta> +<refentrytitle>index.prefer.titleabbrev</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.prefer.titleabbrev</refname> +<refpurpose>Should abbreviated titles be used as back references?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.prefer.titleabbrev.frag"> +<xsl:param name="index.prefer.titleabbrev" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title +is used as the link text of a back reference in the index. +</para> + +</refsection> +</refentry> diff --git a/params/index.preferred.page.properties.xml b/params/index.preferred.page.properties.xml new file mode 100644 index 0000000..1b7a26f --- /dev/null +++ b/params/index.preferred.page.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.preferred.page.properties"> +<refmeta> +<refentrytitle>index.preferred.page.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.preferred.page.properties</refname> +<refpurpose>Properties used to emphasize page number references for +significant index terms</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.preferred.page.properties.frag"> +<xsl:attribute-set name="index.preferred.page.properties"> + <xsl:attribute name="font-weight">bold</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties used to emphasize page number references for +significant index terms (<tag class="attribute">significance</tag>=<tag class="attvalue">preferred</tag>). Currently works only with +XEP.</para> + +</refsection> +</refentry> diff --git a/params/index.range.separator.xml b/params/index.range.separator.xml new file mode 100644 index 0000000..aff09a9 --- /dev/null +++ b/params/index.range.separator.xml @@ -0,0 +1,57 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.range.separator"> +<refmeta> +<refentrytitle>index.range.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.range.separator</refname> +<refpurpose>Override for punctuation separating the two numbers +in a page range in index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.range.separator.frag"> +<xsl:param name="index.range.separator"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter permits you +to override the text to insert between +the two numbers of a page range in an index. +This parameter is only used by those XSL-FO processors +that support an extension for generating such page ranges +(such as XEP).</para> + +<para>Because this text may be locale dependent, +this parameter's value is normally taken from a gentext +template named 'range-separator' in the +context 'index' in the stylesheet +locale file for the language +of the current document. +This parameter can be used to override the gentext string, +and would typically be used on the command line. +This parameter would apply to all languages. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> parameter, or you can +override the gentext with the content of this parameter. +The content can be a simple string, or it can be +something more complex such as a call-template. +</para> + +<para>In HTML index output, section title references are used instead of +page number references. So there are no page ranges +and this parameter has no effect. +</para> + +</refsection> +</refentry> diff --git a/params/index.term.separator.xml b/params/index.term.separator.xml new file mode 100644 index 0000000..ab2f672 --- /dev/null +++ b/params/index.term.separator.xml @@ -0,0 +1,54 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="index.term.separator"> +<refmeta> +<refentrytitle>index.term.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.term.separator</refname> +<refpurpose>Override for punctuation separating an index term +from its list of page references in an index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.term.separator.frag"> +<xsl:param name="index.term.separator"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter permits you to override +the text to insert between +the end of an index term and its list of page references. +Typically that might be a comma and a space. +</para> + +<para>Because this text may be locale dependent, +this parameter's value is normally taken from a gentext +template named 'term-separator' in the +context 'index' in the stylesheet +locale file for the language +of the current document. +This parameter can be used to override the gentext string, +and would typically be used on the command line. +This parameter would apply to all languages. +</para> + +<para>So this text string can be customized in two ways. +You can reset the default gentext string using +the <parameter>local.l10n.xml</parameter> parameter, or you can +fill in the content for this normally empty +override parameter. +The content can be a simple string, or it can be +something more complex such as a call-template. +For fo output, it could be an <tag>fo:leader</tag> +element to provide space of a specific length, or a dot leader. +</para> + +</refsection> +</refentry> diff --git a/params/informal.object.properties.xml b/params/informal.object.properties.xml new file mode 100644 index 0000000..e89cc11 --- /dev/null +++ b/params/informal.object.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="informal.object.properties"> +<refmeta> +<refentrytitle>informal.object.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>informal.object.properties</refname> +<refpurpose>Properties associated with an informal (untitled) object, such as an informalfigure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="informal.object.properties.frag"><xsl:attribute-set name="informal.object.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para> +</refsection> +</refentry> diff --git a/params/informalequation.properties.xml b/params/informalequation.properties.xml new file mode 100644 index 0000000..88a57be --- /dev/null +++ b/params/informalequation.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="informalequation.properties"> +<refmeta> +<refentrytitle>informalequation.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>informalequation.properties</refname> +<refpurpose>Properties associated with an informalequation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="informalequation.properties.frag"> +<xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for informalequations.</para> + +</refsection> +</refentry> diff --git a/params/informalexample.properties.xml b/params/informalexample.properties.xml new file mode 100644 index 0000000..90ffb2c --- /dev/null +++ b/params/informalexample.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="informalexample.properties"> +<refmeta> +<refentrytitle>informalexample.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>informalexample.properties</refname> +<refpurpose>Properties associated with an informalexample</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="informalexample.properties.frag"> +<xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for informalexamples.</para> + +</refsection> +</refentry> diff --git a/params/informalfigure.properties.xml b/params/informalfigure.properties.xml new file mode 100644 index 0000000..c766248 --- /dev/null +++ b/params/informalfigure.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="informalfigure.properties"> +<refmeta> +<refentrytitle>informalfigure.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>informalfigure.properties</refname> +<refpurpose>Properties associated with an informalfigure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="informalfigure.properties.frag"> +<xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for informalfigures.</para> + +</refsection> +</refentry> diff --git a/params/informaltable.properties.xml b/params/informaltable.properties.xml new file mode 100644 index 0000000..c968883 --- /dev/null +++ b/params/informaltable.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="informaltable.properties"> +<refmeta> +<refentrytitle>informaltable.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>informaltable.properties</refname> +<refpurpose>Properties associated with the block surrounding an informaltable</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="informaltable.properties.frag"> +<xsl:attribute-set name="informaltable.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Block styling properties for informaltables. This parameter should really +have been called <literal>informaltable.block.properties</literal> or something +like that, but we’re leaving it to avoid backwards-compatibility +problems.</para> + +<para>See also <parameter>table.table.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/inherit.keywords.xml b/params/inherit.keywords.xml new file mode 100644 index 0000000..7939a6a --- /dev/null +++ b/params/inherit.keywords.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="inherit.keywords"> +<refmeta> +<refentrytitle>inherit.keywords</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>inherit.keywords</refname> +<refpurpose>Inherit keywords from ancestor elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="inherit.keywords.frag"> +<xsl:param name="inherit.keywords" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>inherit.keywords</parameter> +is non-zero, the keyword <literal>meta</literal> for each HTML +<literal>head</literal> element will include all of the keywords from +ancestor elements. Otherwise, only the keywords from the current section +will be used. +</para> + +</refsection> +</refentry> diff --git a/params/inner.region.content.properties.xml b/params/inner.region.content.properties.xml new file mode 100644 index 0000000..72d9322 --- /dev/null +++ b/params/inner.region.content.properties.xml @@ -0,0 +1,48 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="inner.region.content.properties"> +<refmeta> +<refentrytitle>inner.region.content.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>inner.region.content.properties</refname> +<refpurpose>Properties of running inner side content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="inner.region.content.properties.frag"> +<xsl:attribute-set name="inner.region.content.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The FO stylesheet supports optional side regions +similar to the header and footer regions. +Any attributes declared in this attribute-set +are applied to the fo:block in the side region +on the inner side (binding side) of the page. +This corresponds to the <literal>start</literal> +region on odd-numbered pages and the <literal>end</literal> +region on even-numbered pages. +For single-sided output, it always corresponds to +the <literal>start</literal> region.</para> + +<para>You can customize the template named +<literal>inner.region.content</literal> to specify +the content of the inner side region.</para> + +<para>See also +<parameter>region.inner.properties</parameter>, +<parameter>page.margin.inner</parameter>, +<parameter>body.margin.inner</parameter>, +and the corresponding <literal>outer</literal> +parameters.</para> + +</refsection> +</refentry> diff --git a/params/insert.link.page.number.xml b/params/insert.link.page.number.xml new file mode 100644 index 0000000..b26c0f6 --- /dev/null +++ b/params/insert.link.page.number.xml @@ -0,0 +1,69 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="insert.link.page.number"> +<refmeta> +<refentrytitle>insert.link.page.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.link.page.number</refname> +<refpurpose>Turns page numbers in link elements on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="insert.link.page.number.frag"> +<xsl:param name="insert.link.page.number">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines if +cross references using the <tag>link</tag> element in +printed output will +include standard page number citations. +It has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <tag>link</tag> elements. +The style of page reference may be changed +if an <tag class="attribute">xrefstyle</tag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for a <tag>link</tag> element unless +it has an +<tag class="attribute">xrefstyle</tag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> + +<para>Although the <tag>xrefstyle</tag> attribute +can be used to turn the page reference on or off, it cannot be +used to control the formatting of the page number as it +can in <tag>xref</tag>. +In <tag>link</tag> it will always format with +the style established by the +gentext template with <literal>name="page.citation"</literal> +in the <literal>l:context name="xref"</literal>. +</para> +</refsection> +</refentry> diff --git a/params/insert.olink.page.number.xml b/params/insert.olink.page.number.xml new file mode 100644 index 0000000..dc6da3d --- /dev/null +++ b/params/insert.olink.page.number.xml @@ -0,0 +1,83 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="insert.olink.page.number"> +<refmeta> +<refentrytitle>insert.olink.page.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.page.number</refname> +<refpurpose>Turns page numbers in olinks on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="insert.olink.page.number.frag"> +<xsl:param name="insert.olink.page.number">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines if +cross references made between documents with +<tag>olink</tag> will +include page number citations. +In most cases this is only applicable to references in printed output. +</para> +<para>The parameter has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated for olinks. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <tag>olink</tag> references. +The style of page reference may be changed +if an <tag class="attribute">xrefstyle</tag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <tag>olink</tag> element unless +it has an +<tag class="attribute">xrefstyle</tag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> +<para>Olinks that point to targets within the same document +are treated as <tag>xref</tag>s, and controlled by +the <parameter>insert.xref.page.number</parameter> parameter. +</para> + +<para>Page number references for olinks to +external documents can only be inserted if the +information exists in the olink database. +This means each olink target element +(<tag>div</tag> or <tag>obj</tag>) +must have a <tag class="attribute">page</tag> attribute +whose value is its page number in the target document. +The XSL stylesheets are not able to extract that information +during processing because pages have not yet been created in +XSLT transformation. Only the XSL-FO processor knows what +page each element is placed on. +Therefore some postprocessing must take place to populate +page numbers in the olink database. +</para> + + + +</refsection> +</refentry> diff --git a/params/insert.olink.pdf.frag.xml b/params/insert.olink.pdf.frag.xml new file mode 100644 index 0000000..e937060 --- /dev/null +++ b/params/insert.olink.pdf.frag.xml @@ -0,0 +1,68 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="insert.olink.pdf.frag"> +<refmeta> +<refentrytitle>insert.olink.pdf.frag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.pdf.frag</refname> +<refpurpose>Add fragment identifiers for links into PDF files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="insert.olink.pdf.frag.frag"> +<xsl:param name="insert.olink.pdf.frag" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines whether +the cross reference URIs to PDF documents made with +<tag>olink</tag> will +include fragment identifiers. +</para> + +<para>When forming a URI to link to a PDF document, +a fragment identifier (typically a '#' followed by an +id value) appended to the PDF filename can be used by +the PDF viewer to open +the PDF file to a location within the document instead of +the first page. +However, not all PDF files have id +values embedded in them, and not all PDF viewers can +handle fragment identifiers. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> is set +to a non-zero value, then any olink targeting a +PDF file will have the fragment identifier appended to the URI. +The URI is formed by concatenating the value of the +<parameter>olink.base.uri</parameter> parameter, the +value of the <tag class="attribute">baseuri</tag> +attribute from the <tag class="element">document</tag> +element in the olink database with the matching +<tag class="attribute">targetdoc</tag> value, +and the value of the <tag class="attribute">href</tag> +attribute for the targeted element in the olink database. +The <tag class="attribute">href</tag> attribute +contains the fragment identifier. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> is set +to zero (the default value), then +the <tag class="attribute">href</tag> attribute +from the olink database +is not appended to PDF olinks, so the fragment identifier is left off. +A PDF olink is any olink for which the +<tag class="attribute">baseuri</tag> attribute +from the matching <tag class="element">document</tag> +element in the olink database ends with '.pdf'. +Any other olinks will still have the fragment identifier added. +</para> +</refsection> +</refentry> diff --git a/params/insert.xref.page.number.xml b/params/insert.xref.page.number.xml new file mode 100644 index 0000000..8c3aa07 --- /dev/null +++ b/params/insert.xref.page.number.xml @@ -0,0 +1,60 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="insert.xref.page.number"> +<refmeta> +<refentrytitle>insert.xref.page.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.xref.page.number</refname> +<refpurpose>Turns page numbers in xrefs on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="insert.xref.page.number.frag"> +<xsl:param name="insert.xref.page.number">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter determines if +cross references (<tag>xref</tag>s) in +printed output will +include page number citations. +It has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <tag>xref</tag> elements. +The style of page reference may be changed +if an <tag class="attribute">xrefstyle</tag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <tag>xref</tag> element unless +it has an +<tag class="attribute">xrefstyle</tag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> diff --git a/params/itemizedlist.label.properties.xml b/params/itemizedlist.label.properties.xml new file mode 100644 index 0000000..49f8ee6 --- /dev/null +++ b/params/itemizedlist.label.properties.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="itemizedlist.label.properties"> +<refmeta> +<refentrytitle>itemizedlist.label.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>itemizedlist.label.properties</refname> +<refpurpose>Properties that apply to each label inside itemized list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="itemizedlist.label.properties.frag"><xsl:attribute-set name="itemizedlist.label.properties"> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to each label inside itemized list. E.g.:</para> +<programlisting><xsl:attribute-set name="itemizedlist.label.properties"> + <xsl:attribute name="text-align">right</xsl:attribute> +</xsl:attribute-set></programlisting> +</refsection> +</refentry> diff --git a/params/itemizedlist.label.width.xml b/params/itemizedlist.label.width.xml new file mode 100644 index 0000000..1d2c88c --- /dev/null +++ b/params/itemizedlist.label.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="itemizedlist.label.width"> +<refmeta> +<refentrytitle>itemizedlist.label.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> + <refname>itemizedlist.label.width</refname> +<refpurpose>The default width of the label (bullet) in an itemized list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="itemizedlist.label.width.frag"> + <xsl:param name="itemizedlist.label.width">1.0em</xsl:param> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Specifies the default width of the label (usually a bullet or other +symbol) in an itemized list. You can override the default value on any +particular list with the “dbfo” processing instruction using the +“label-width” pseudoattribute.</para> +</refsection> +</refentry> diff --git a/params/itemizedlist.properties.xml b/params/itemizedlist.properties.xml new file mode 100644 index 0000000..d7c7c1d --- /dev/null +++ b/params/itemizedlist.properties.xml @@ -0,0 +1,23 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="itemizedlist.properties"> +<refmeta> +<refentrytitle>itemizedlist.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>itemizedlist.properties</refname> +<refpurpose>Properties that apply to each list-block generated by itemizedlist.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="itemizedlist.properties.frag"><xsl:attribute-set name="itemizedlist.properties" use-attribute-sets="list.block.properties"> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to each fo:list-block generated by itemizedlist.</para> +</refsection> +</refentry> diff --git a/params/javahelp.encoding.xml b/params/javahelp.encoding.xml new file mode 100644 index 0000000..ba729c8 --- /dev/null +++ b/params/javahelp.encoding.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="javahelp.encoding"> +<refmeta> +<refentrytitle>javahelp.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>javahelp.encoding</refname> +<refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="javahelp.encoding.frag"> +<xsl:param name="javahelp.encoding">iso-8859-1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>JavaHelp crashes on some characters when written as character +references. In that case you can use this parameter to select an appropriate encoding.</para> + +</refsection> +</refentry> + + + diff --git a/params/keep.relative.image.uris.xml b/params/keep.relative.image.uris.xml new file mode 100644 index 0000000..3a5a098 --- /dev/null +++ b/params/keep.relative.image.uris.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="keep.relative.image.uris"> +<refmeta> +<refentrytitle>keep.relative.image.uris</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>keep.relative.image.uris</refname> +<refpurpose>Should image URIs be resolved against xml:base?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="keep.relative.image.uris.frag"> +<xsl:param condition="html" name="keep.relative.image.uris" select="1"/> +<xsl:param condition="fo" name="keep.relative.image.uris" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, relative URIs (in, for example +<literal>fileref</literal> attributes) will be used in the generated +output. Otherwise, the URIs will be made absolute with respect to the +base URI.</para> + +<para>Note that the stylesheets calculate (and use) the absolute form +for some purposes, this only applies to the resulting output.</para> + +</refsection> +</refentry> diff --git a/params/keyboard.nav.xml b/params/keyboard.nav.xml new file mode 100644 index 0000000..49b0c0b --- /dev/null +++ b/params/keyboard.nav.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="keyboard.nav"> +<refmeta> +<refentrytitle>keyboard.nav</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>keyboard.nav</refname> +<refpurpose>Enable keyboard navigation?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="keyboard.nav.frag"> +<xsl:param name="keyboard.nav" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, JavaScript is added to the slides to enable keyboard +navigation. Pressing 'n', space, or return moves forward; pressing 'p' moves +backward.</para> + +</refsection> +</refentry> diff --git a/params/l10n.gentext.default.language.xml b/params/l10n.gentext.default.language.xml new file mode 100644 index 0000000..ed89e06 --- /dev/null +++ b/params/l10n.gentext.default.language.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" + xml:id="l10n.gentext.default.language"> + <refmeta> + <refentrytitle>l10n.gentext.default.language</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>l10n.gentext.default.language</refname> + <refpurpose>Sets the default language for generated text</refpurpose> + </refnamediv> + + <refsynopsisdiv> +<src:fragment xml:id="l10n.gentext.default.language.frag"> +<xsl:param name="l10n.gentext.default.language">en</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of the <parameter>l10n.gentext.default.language</parameter> +parameter is used as the language for generated text if no setting is provided +in the source document.</para> + +</refsection> +</refentry> diff --git a/params/l10n.gentext.language.xml b/params/l10n.gentext.language.xml new file mode 100644 index 0000000..ff941c7 --- /dev/null +++ b/params/l10n.gentext.language.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="l10n.gentext.language"> +<refmeta> +<refentrytitle>l10n.gentext.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.language</refname> +<refpurpose>Sets the gentext language</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="l10n.gentext.language.frag"> +<xsl:param name="l10n.gentext.language"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If this parameter is set to any value other than the empty string, its +value will be used as the value for the language when generating text. Setting +<parameter>l10n.gentext.language</parameter> overrides any settings within the +document being formatted.</para> + +<para>It's much more likely that you might want to set the +<parameter>l10n.gentext.default.language</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/l10n.gentext.use.xref.language.xml b/params/l10n.gentext.use.xref.language.xml new file mode 100644 index 0000000..d70017a --- /dev/null +++ b/params/l10n.gentext.use.xref.language.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="l10n.gentext.use.xref.language"> +<refmeta> +<refentrytitle>l10n.gentext.use.xref.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.use.xref.language</refname> +<refpurpose>Use the language of target when generating cross-reference text?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="l10n.gentext.use.xref.language.frag"> +<xsl:param name="l10n.gentext.use.xref.language" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the language of the target will be used when +generating cross reference text. Usually, the <quote>current</quote> +language is used when generating text (that is, the language of the +element that contains the cross-reference element). But setting this parameter +allows the language of the element <emphasis>pointed to</emphasis> to control +the generated text.</para> + +<para>Consider the following example:</para> + +<informalexample> +<programlisting><para lang="en">See also <xref linkend="chap3"/>.</para> +</programlisting> +</informalexample> + +<para>Suppose that Chapter 3 happens to be written in German. +If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the +resulting text will be something like this:</para> + +<blockquote> +<para>See also Kapital 3.</para> +</blockquote> + +<para>Where the more traditional rendering would be:</para> + +<blockquote> +<para>See also Chapter 3.</para> +</blockquote> + +</refsection> +</refentry> diff --git a/params/l10n.lang.value.rfc.compliant.xml b/params/l10n.lang.value.rfc.compliant.xml new file mode 100644 index 0000000..e0dbd79 --- /dev/null +++ b/params/l10n.lang.value.rfc.compliant.xml @@ -0,0 +1,57 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="l10n.lang.value.rfc.compliant"> +<refmeta> +<refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.lang.value.rfc.compliant</refname> +<refpurpose>Make value of lang attribute RFC compliant?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="l10n.lang.value.rfc.compliant.frag"> +<xsl:param name="l10n.lang.value.rfc.compliant" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC +compliant<footnote><para>Section 8.1.1, <link xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that: + +<blockquote><para>[RFC1766] defines and explains the language codes +that must be used in HTML documents.</para> +<para>Briefly, language codes consist of a primary code and a possibly +empty series of subcodes: + +<literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout> +</para> +<para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification +of Languages</link>, the EBNF for "language tag" is given as: + +<literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) +Primary-tag = 1*8ALPHA +Subtag = 1*8ALPHA</literallayout> +</para> +</blockquote> +</para></footnote>. + +by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and +replacing them with hyphen characters in output HTML files. For +example, <literal>zh_CN</literal> in a source document becomes +<literal>zh-CN</literal> in the HTML output form that source. + +<note> +<para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766 +explicitly states that all "language tags" (as it calls them) "are +to be treated as case insensitive".</para> +</note> +</para> + +</refsection> +</refentry> diff --git a/params/label.from.part.xml b/params/label.from.part.xml new file mode 100644 index 0000000..5deb960 --- /dev/null +++ b/params/label.from.part.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="label.from.part"> +<refmeta> +<refentrytitle>label.from.part</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>label.from.part</refname> +<refpurpose>Renumber components in each part?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="label.from.part.frag"> +<xsl:param name="label.from.part" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>label.from.part</parameter> is non-zero, then + numbering of components — <tag>preface</tag>, + <tag>chapter</tag>, <tag>appendix</tag>, and + <tag>reference</tag> (when <tag>reference</tag> occurs at the + component level) — is re-started within each + <tag>part</tag>.</para> +<para>If <parameter>label.from.part</parameter> is zero (the + default), numbering of components is <emphasis>not</emphasis> + re-started within each <tag>part</tag>; instead, components are + numbered sequentially throughout each <tag>book</tag>, + regardless of whether or not they occur within <tag>part</tag> + instances.</para> + +</refsection> +</refentry> diff --git a/params/line-height.xml b/params/line-height.xml new file mode 100644 index 0000000..f0f4b32 --- /dev/null +++ b/params/line-height.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="line-height"> +<refmeta> +<refentrytitle>line-height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>line-height</refname> +<refpurpose>Specify the line-height property</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="line-height.frag"> +<xsl:param name="line-height">normal</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the line-height property.</para> + +</refsection> +</refentry> diff --git a/params/linenumbering.everyNth.xml b/params/linenumbering.everyNth.xml new file mode 100644 index 0000000..0abdf8e --- /dev/null +++ b/params/linenumbering.everyNth.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="linenumbering.everyNth"> +<refmeta> +<refentrytitle>linenumbering.everyNth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.everyNth</refname> +<refpurpose>Indicate which lines should be numbered</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="linenumbering.everyNth.frag"> +<xsl:param name="linenumbering.everyNth">5</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If line numbering is enabled, everyNth line will be +numbered. Note that numbering is one based, not zero based. +</para> +<para>See also <parameter>linenumbering.extension</parameter>, +<parameter>linenumbering.separator</parameter>, +<parameter>linenumbering.width</parameter> and +<parameter>use.extensions</parameter></para> + +</refsection> +</refentry> diff --git a/params/linenumbering.extension.xml b/params/linenumbering.extension.xml new file mode 100644 index 0000000..726781a --- /dev/null +++ b/params/linenumbering.extension.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="linenumbering.extension"> +<refmeta> +<refentrytitle>linenumbering.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.extension</refname> +<refpurpose>Enable the line numbering extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="linenumbering.extension.frag"> +<xsl:param name="linenumbering.extension" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>, +<tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will +have line numbers. +</para> + +</refsection> +</refentry> diff --git a/params/linenumbering.separator.xml b/params/linenumbering.separator.xml new file mode 100644 index 0000000..8bf7d22 --- /dev/null +++ b/params/linenumbering.separator.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="linenumbering.separator"> +<refmeta> +<refentrytitle>linenumbering.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.separator</refname> +<refpurpose>Specify a separator between line numbers and lines</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="linenumbering.separator.frag"> +<xsl:param name="linenumbering.separator"><xsl:text> </xsl:text></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The separator is inserted between line numbers and lines in the +verbatim environment. The default value is a single white space. + Note the interaction with <parameter>linenumbering.width</parameter> +</para> + +</refsection> +</refentry> diff --git a/params/linenumbering.width.xml b/params/linenumbering.width.xml new file mode 100644 index 0000000..78515c3 --- /dev/null +++ b/params/linenumbering.width.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="linenumbering.width"> +<refmeta> +<refentrytitle>linenumbering.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.width</refname> +<refpurpose>Indicates the width of line numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="linenumbering.width.frag"> +<xsl:param name="linenumbering.width">3</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If line numbering is enabled, line numbers will appear right +justified in a field "width" characters wide. +</para> + +</refsection> +</refentry> diff --git a/params/link.mailto.url.xml b/params/link.mailto.url.xml new file mode 100644 index 0000000..0715b32 --- /dev/null +++ b/params/link.mailto.url.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="link.mailto.url"> +<refmeta> +<refentrytitle>link.mailto.url</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>link.mailto.url</refname> +<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="link.mailto.url.frag"> +<xsl:param name="link.mailto.url"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If not the empty string, this address will be used for the +rel=made <literal>link</literal> element in the html <literal>head</literal> +</para> + +</refsection> +</refentry> diff --git a/params/list.block.properties.xml b/params/list.block.properties.xml new file mode 100644 index 0000000..dbf9dfc --- /dev/null +++ b/params/list.block.properties.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="list.block.properties"> +<refmeta> +<refentrytitle>list.block.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>list.block.properties</refname> +<refpurpose>Properties that apply to each list-block generated by list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="list.block.properties.frag"><xsl:attribute-set name="list.block.properties"> + <xsl:attribute name="provisional-label-separation">0.2em</xsl:attribute> + <xsl:attribute name="provisional-distance-between-starts">1.5em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to each fo:list-block generated by itemizedlist/orderedlist.</para> +</refsection> +</refentry> diff --git a/params/list.block.spacing.xml b/params/list.block.spacing.xml new file mode 100644 index 0000000..377e6f8 --- /dev/null +++ b/params/list.block.spacing.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="list.block.spacing"> +<refmeta> +<refentrytitle>list.block.spacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>list.block.spacing</refname> +<refpurpose>What spacing do you want before and after lists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="list.block.spacing.frag"><xsl:attribute-set name="list.block.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras. </para> +</refsection> +</refentry> diff --git a/params/list.item.spacing.xml b/params/list.item.spacing.xml new file mode 100644 index 0000000..2191652 --- /dev/null +++ b/params/list.item.spacing.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="list.item.spacing"> +<refmeta> +<refentrytitle>list.item.spacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>list.item.spacing</refname> +<refpurpose>What space do you want between list items?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="list.item.spacing.frag"><xsl:attribute-set name="list.item.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify what spacing you want between each list item.</para> +</refsection> +</refentry> diff --git a/params/make.clean.html.xml b/params/make.clean.html.xml new file mode 100644 index 0000000..fbf80d0 --- /dev/null +++ b/params/make.clean.html.xml @@ -0,0 +1,51 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.clean.html"> +<refmeta> +<refentrytitle>make.clean.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.clean.html</refname> +<refpurpose>Make HTML conform to modern coding standards</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.clean.html.frag"> +<xsl:param name="make.clean.html" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>make.clean.html</parameter> is true, the stylesheets take +extra effort to ensure that the resulting HTML is conforms to +modern HTML coding standards. In addition to eliminating +excessive and noncompliant coding, it moves presentation +HTML coding to a CSS stylesheet.</para> + +<para>The resulting HTML is dependent on +CSS for formatting, and so the stylesheet is capable of +generating a supporting CSS file. The <parameter>docbook.css.source</parameter> +and <parameter>custom.css.source</parameter> parameters control +how a CSS file is generated.</para> + +<para>If you require your CSS to reside in the HTML +<tag>head</tag> element, then the <parameter>generate.css.header</parameter> +can be used to do that.</para> + +<para>The <parameter>make.clean.html</parameter> parameter is +different from <parameter>html.cleanup</parameter> +because the former changes the resulting markup; it does not use extension functions +like the latter to manipulate result-tree-fragments, +and is therefore applicable to any XSLT processor.</para> + +<para>If <parameter>make.clean.html</parameter> is set to zero (the default), +then the stylesheet retains its original +<quote>old style</quote> +HTML formatting features.</para> +</refsection> +</refentry> diff --git a/params/make.graphic.viewport.xml b/params/make.graphic.viewport.xml new file mode 100644 index 0000000..0bad336 --- /dev/null +++ b/params/make.graphic.viewport.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.graphic.viewport"> +<refmeta> +<refentrytitle>make.graphic.viewport</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.graphic.viewport</refname> +<refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.graphic.viewport.frag"> +<xsl:param name="make.graphic.viewport" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The HTML <tag>img</tag> element only supports the notion +of content-area scaling; it doesn't support the distinction between a +content-area and a viewport-area, so we have to make some compromises.</para> + +<para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table +will be used to frame the image. This creates an effective viewport-area. +</para> + +<para>Tables and alignment don't work together, so this parameter is ignored +if alignment is specified on an image.</para> +</refsection> +</refentry> diff --git a/params/make.index.markup.xml b/params/make.index.markup.xml new file mode 100644 index 0000000..7942b5a --- /dev/null +++ b/params/make.index.markup.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.index.markup"> +<refmeta> +<refentrytitle>make.index.markup</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.index.markup</refname> +<refpurpose>Generate XML index markup in the index?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.index.markup.frag"> +<xsl:param name="make.index.markup" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter enables a very neat trick for getting properly +merged, collated back-of-the-book indexes. G. Ken Holman suggested +this trick at Extreme Markup Languages 2002 and I'm indebted to him +for it.</para> + +<para>Jeni Tennison's excellent code in +<filename>autoidx.xsl</filename> does a great job of merging and +sorting <tag>indexterm</tag>s in the document and building a +back-of-the-book index. However, there's one thing that it cannot +reasonably be expected to do: merge page numbers into ranges. (I would +not have thought that it could collate and suppress duplicate page +numbers, but in fact it appears to manage that task somehow.)</para> + +<para>Ken's trick is to produce a document in which the index at the +back of the book is <quote>displayed</quote> in XML. Because the index +is generated by the FO processor, all of the page numbers have been resolved. +It's a bit hard to explain, but what it boils down to is that instead of having +an index at the back of the book that looks like this:</para> + +<blockquote> +<formalpara><info><title>A</title></info> +<para>ap1, 1, 2, 3</para> +</formalpara> +</blockquote> + +<para>you get one that looks like this:</para> + +<blockquote> +<programlisting><indexdiv>A</indexdiv> +<indexentry> +<primaryie>ap1</primaryie>, +<phrase role="pageno">1</phrase>, +<phrase role="pageno">2</phrase>, +<phrase role="pageno">3</phrase> +</indexentry></programlisting> +</blockquote> + +<para>After building a PDF file with this sort of odd-looking index, you can +extract the text from the PDF file and the result is a proper index expressed in +XML.</para> + +<para>Now you have data that's amenable to processing and a simple Perl script +(such as <filename>fo/pdf2index</filename>) can +merge page ranges and generate a proper index.</para> + +<para>Finally, reformat your original document using this literal index instead of +an automatically generated one and <quote>bingo</quote>!</para> + +</refsection> +</refentry> diff --git a/params/make.single.year.ranges.xml b/params/make.single.year.ranges.xml new file mode 100644 index 0000000..c49ab97 --- /dev/null +++ b/params/make.single.year.ranges.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.single.year.ranges"> +<refmeta> +<refentrytitle>make.single.year.ranges</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.single.year.ranges</refname> +<refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.single.year.ranges.frag"> +<xsl:param name="make.single.year.ranges" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, year ranges that span a single year will be printed +in range notation (1998-1999) instead of discrete notation +(1998, 1999).</para> + +</refsection> +</refentry> diff --git a/params/make.valid.html.xml b/params/make.valid.html.xml new file mode 100644 index 0000000..8618d39 --- /dev/null +++ b/params/make.valid.html.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.valid.html"> +<refmeta> +<refentrytitle>make.valid.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.valid.html</refname> +<refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.valid.html.frag"> +<xsl:param name="make.valid.html" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>make.valid.html</parameter> is true, the stylesheets take +extra effort to ensure that the resulting HTML is valid. This may mean that some +<tag>para</tag> tags are translated into HTML <tag>div</tag>s or +that other substitutions occur.</para> + +<para>This parameter is different from <parameter>html.cleanup</parameter> +because it changes the resulting markup; it does not use extension functions +to manipulate result-tree-fragments and is therefore applicable to any +XSLT processor.</para> + +</refsection> +</refentry> diff --git a/params/make.year.ranges.xml b/params/make.year.ranges.xml new file mode 100644 index 0000000..b1a2382 --- /dev/null +++ b/params/make.year.ranges.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="make.year.ranges"> +<refmeta> +<refentrytitle>make.year.ranges</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.year.ranges</refname> +<refpurpose>Collate copyright years into ranges?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="make.year.ranges.frag"><xsl:param name="make.year.ranges" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, multiple copyright <tag>year</tag> elements will be +collated into ranges. +This works only if each year number is put into a separate +year element. The copyright element permits multiple +year elements. If a year element contains a dash or +a comma, then that year element will not be merged into +any range. +</para> + +</refsection> +</refentry> diff --git a/params/man.authors.section.enabled.xml b/params/man.authors.section.enabled.xml new file mode 100644 index 0000000..73cb637 --- /dev/null +++ b/params/man.authors.section.enabled.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.authors.section.enabled"> +<refmeta> +<refentrytitle>man.authors.section.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.authors.section.enabled</refname> +<refpurpose>Display auto-generated AUTHORS section?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="man.authors.section.enabled.frag"> +<xsl:param name="man.authors.section.enabled">1</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>man.authors.section.enabled</parameter> is non-zero +(the default), then an <literal>AUTHORS</literal> section is +generated near the end of each man page. The output of the +<literal>AUTHORS</literal> section is assembled from any +<tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag> +metadata found in the contents of the child <tag>info</tag> or +<tag>refentryinfo</tag> (if any) of the <tag>refentry</tag> +itself, or from any <tag>author</tag>, <tag>editor</tag>, and +<tag>othercredit</tag> metadata that may appear in <tag>info</tag> +contents of any ancestors of the <tag>refentry</tag>.</para> + +<para>If the value of +<parameter>man.authors.section.enabled</parameter> is zero, the +the auto-generated <literal>AUTHORS</literal> section is +suppressed.</para> + +<para>Set the value of + <parameter>man.authors.section.enabled</parameter> to zero if + you want to have a manually created <literal>AUTHORS</literal> + section in your source, and you want it to appear in output + instead of the auto-generated <literal>AUTHORS</literal> + section.</para> +</refsection> +</refentry> diff --git a/params/man.base.url.for.relative.links.xml b/params/man.base.url.for.relative.links.xml new file mode 100644 index 0000000..a802ec8 --- /dev/null +++ b/params/man.base.url.for.relative.links.xml @@ -0,0 +1,76 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.base.url.for.relative.links"> + <refmeta> + <refentrytitle>man.base.url.for.relative.links</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>man.base.url.for.relative.links</refname> + <refpurpose>Specifies a base URL for relative links</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="man.base.url.for.relative.links.frag"><xsl:param name="man.base.url.for.relative.links">[set $man.base.url.for.relative.links]/</xsl:param></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>For any “notesource” listed in the auto-generated + “NOTES” section of output man pages (which is generated when + the value of the + <parameter>man.endnotes.list.enabled</parameter> parameter + is non-zero), if the notesource is a link source with a + relative URI, the URI is displayed in output with the value + of the + <parameter>man.base.url.for.relative.links</parameter> + parameter prepended to the value of the link URI.</para> + + <note> + <para>A link source is an notesource that references an + external resource: + <itemizedlist> + <listitem> + <para>a <tag>ulink</tag> element with a <tag + class="attribute">url</tag> attribute</para> + </listitem> + <listitem> + <para>any element with an <tag + class="attribute">xlink:href</tag> attribute</para> + </listitem> + <listitem> + <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or + <tag>videodata</tag> element</para> + </listitem> + </itemizedlist> + </para> + </note> + + <para>If you use relative URIs in link sources in your DocBook + <tag>refentry</tag> source, and you leave + <parameter>man.base.url.for.relative.links</parameter> + unset, the relative links will appear “as is” in the “Notes” + section of any man-page output generated from your source. + That’s probably not what you want, because such relative + links are only usable in the context of HTML output. So, to + make the links meaningful and usable in the context of + man-page output, set a value for + <parameter>man.base.url.for.relative.links</parameter> that + points to the online version of HTML output generated from + your DocBook <tag>refentry</tag> source. For + example: + <programlisting + ><xsl:param name="man.base.url.for.relative.links" + >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param></programlisting> + </para> + + </refsection> + + <refsection><info><title>Related Parameters</title></info> + <para><parameter>man.endnotes.list.enabled</parameter></para> + </refsection> + +</refentry> diff --git a/params/man.break.after.slash.xml b/params/man.break.after.slash.xml new file mode 100644 index 0000000..859edb7 --- /dev/null +++ b/params/man.break.after.slash.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.break.after.slash"> +<refmeta> +<refentrytitle>man.break.after.slash</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.break.after.slash</refname> +<refpurpose>Enable line-breaking after slashes?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.break.after.slash.frag"> +<xsl:param name="man.break.after.slash">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, line-breaking after slashes is enabled. This is +mainly useful for causing long URLs or pathnames/filenames to be +broken up or "wrapped" across lines (though it also has the side +effect of sometimes causing relatively short URLs and pathnames to be +broken up across lines too).</para> + +<para>If zero (the default), line-breaking after slashes is +disabled. In that case, strings containing slashes (for example, URLs +or filenames) are not broken across lines, even if they exceed the +maximum column widith.</para> + +<warning> + <para>If you set a non-zero value for this parameter, check your + man-page output carefuly afterwards, in order to make sure that the + setting has not introduced an excessive amount of breaking-up of URLs + or pathnames. If your content contains mostly short URLs or + pathnames, setting a non-zero value for + <parameter>man.break.after.slash</parameter> will probably result in + in a significant number of relatively short URLs and pathnames being + broken across lines, which is probably not what you want.</para> +</warning> + +</refsection> +</refentry> diff --git a/params/man.charmap.enabled.xml b/params/man.charmap.enabled.xml new file mode 100644 index 0000000..5522339 --- /dev/null +++ b/params/man.charmap.enabled.xml @@ -0,0 +1,55 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.charmap.enabled"> +<refmeta> +<refentrytitle>man.charmap.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.charmap.enabled</refname> +<refpurpose>Apply character map before final output?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.charmap.enabled.frag"> +<xsl:param name="man.charmap.enabled" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the <parameter>man.charmap.enabled</parameter> +parameter is non-zero, a "character map" is used to substitute certain +Unicode symbols and special characters with appropriate roff/groff +equivalents, just before writing each man-page file to the +filesystem. If instead the value of +<parameter>man.charmap.enabled</parameter> is zero, Unicode characters +are passed through "as is".</para> + +<refsection><info><title>Details</title></info> + +<para>For converting certain Unicode symbols and special characters in +UTF-8 or UTF-16 encoded XML source to appropriate groff/roff +equivalents in man-page output, the DocBook XSL Stylesheets +distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character +map</link> format as detailed in the XSLT 2.0 specification. The map +contains more than 800 character mappings and can be considered the +standard roff character map for the distribution.</para> + +<para>You can use the <parameter>man.charmap.uri</parameter> +parameter to specify a URI for the location for an alternate roff +character map to use in place of the standard roff character map +provided in the distribution.</para> + +<para>You can also use a subset of a character map. For details, +see the <parameter>man.charmap.use.subset</parameter>, +<parameter>man.charmap.subset.profile</parameter>, and +<parameter>man.charmap.subset.profile.english</parameter> +parameters.</para> + +</refsection> +</refsection> +</refentry> diff --git a/params/man.charmap.subset.profile.english.xml b/params/man.charmap.subset.profile.english.xml new file mode 100644 index 0000000..cbc9fb0 --- /dev/null +++ b/params/man.charmap.subset.profile.english.xml @@ -0,0 +1,80 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.charmap.subset.profile.english"> +<refmeta> +<refentrytitle>man.charmap.subset.profile.english</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.charmap.subset.profile.english</refname> +<refpurpose>Profile of character map subset</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.charmap.subset.profile.english.frag"> +<xsl:param name="man.charmap.subset.profile.english"> +@*[local-name() = 'block'] = 'Miscellaneous Technical' or +(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and + @*[local-name() = 'class'] = 'symbols') +or +(@*[local-name() = 'block'] = 'General Punctuation' and + (@*[local-name() = 'class'] = 'spaces' or + @*[local-name() = 'class'] = 'dashes' or + @*[local-name() = 'class'] = 'quotes' or + @*[local-name() = 'class'] = 'bullets' + ) +) or +@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or +@*[local-name() = 'name'] = 'WORD JOINER' or +@*[local-name() = 'name'] = 'SERVICE MARK' or +@*[local-name() = 'name'] = 'TRADE MARK SIGN' or +@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE' +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the + <parameter>man.charmap.use.subset</parameter> parameter is + non-zero, and your DocBook source is written in English (that + is, if its <tag class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute on the root element + in your DocBook source or on the first <tag>refentry</tag> + element in your source has the value <literal>en</literal> or if + it has no <tag class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute), then the + character-map subset specified by the + <parameter>man.charmap.subset.profile.english</parameter> + parameter is used instead of the full roff character map.</para> + +<para>Otherwise, if the <tag class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute + on the root element in your DocBook source or on the first + <tag>refentry</tag> element in your source has a value other + than <literal>en</literal>, then the character-map subset + specified by the + <parameter>man.charmap.subset.profile</parameter> parameter is + used instead of + <parameter>man.charmap.subset.profile.english</parameter>.</para> + +<para>The difference between the two subsets is that + <parameter>man.charmap.subset.profile</parameter> provides + mappings for characters in Western European languages that are + not part of the Roman (English) alphabet (ASCII character set).</para> + +<para>The value of <parameter>man.charmap.subset.profile.english</parameter> +is a string representing an XPath expression that matches attribute +names and values for <tag + namespace="http://docbook.sf.net/xmlns/unichar/1.0" + >output-character</tag> elements in the character map.</para> + +<para>For other details, see the documentation for the +<parameter>man.charmap.subset.profile.english</parameter> and +<parameter>man.charmap.use.subset</parameter> parameters.</para> + +</refsection> +</refentry> diff --git a/params/man.charmap.subset.profile.xml b/params/man.charmap.subset.profile.xml new file mode 100644 index 0000000..913a4e3 --- /dev/null +++ b/params/man.charmap.subset.profile.xml @@ -0,0 +1,297 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.charmap.subset.profile"> +<refmeta> +<refentrytitle>man.charmap.subset.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.charmap.subset.profile</refname> +<refpurpose>Profile of character map subset</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.charmap.subset.profile.frag"> +<xsl:param name="man.charmap.subset.profile"> +@*[local-name() = 'block'] = 'Miscellaneous Technical' or +(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and + (@*[local-name() = 'class'] = 'symbols' or + @*[local-name() = 'class'] = 'letters') +) or +@*[local-name() = 'block'] = 'Latin Extended-A' +or +(@*[local-name() = 'block'] = 'General Punctuation' and + (@*[local-name() = 'class'] = 'spaces' or + @*[local-name() = 'class'] = 'dashes' or + @*[local-name() = 'class'] = 'quotes' or + @*[local-name() = 'class'] = 'bullets' + ) +) or +@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or +@*[local-name() = 'name'] = 'WORD JOINER' or +@*[local-name() = 'name'] = 'SERVICE MARK' or +@*[local-name() = 'name'] = 'TRADE MARK SIGN' or +@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE' +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.charmap.use.subset</parameter> parameter is non-zero, +and your DocBook source is not written in English (that + is, if the <tag class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute on the root element + in your DocBook source or on the first <tag>refentry</tag> + element in your source has a value other than + <literal>en</literal>), then the character-map subset specified + by the <parameter>man.charmap.subset.profile</parameter> + parameter is used instead of the full roff character map.</para> + +<para>Otherwise, if the <tag class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute on the root + element in your DocBook + source or on the first <tag>refentry</tag> element in your source + has the value <literal>en</literal> or if it has no <tag + class="attribute">lang</tag> or <tag + class="attribute">xml:lang</tag> attribute, then the character-map + subset specified by the + <parameter>man.charmap.subset.profile.english</parameter> + parameter is used instead of + <parameter>man.charmap.subset.profile</parameter>.</para> + +<para>The difference between the two subsets is that + <parameter>man.charmap.subset.profile</parameter> provides + mappings for characters in Western European languages that are + not part of the Roman (English) alphabet (ASCII character set).</para> + +<para>The value of <parameter>man.charmap.subset.profile</parameter> +is a string representing an XPath expression that matches attribute +names and values for <tag + namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> +elements in the character map.</para> + +<para>The attributes supported in the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are: +<variablelist> + <varlistentry> + <term>character</term> + <listitem> + <simpara>a raw Unicode character or numeric Unicode + character-entity value (either in decimal or hex); all + characters have this attribute</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <simpara>a standard full/long ISO/Unicode character name (e.g., + "OHM SIGN"); all characters have this attribute</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>block</term> + <listitem> + <simpara>a standard Unicode "block" name (e.g., "General + Punctuation"); all characters have this attribute. For the full + list of Unicode block names supported in the standard roff + character map, see <xref linkend="BlocksAndClasses"/>.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>class</term> + <listitem> + <simpara>a class of characters (e.g., "spaces"). Not all + characters have this attribute; currently, it is used only with + certain characters within the "C1 Controls And Latin-1 + Supplement" and "General Punctuation" blocks. For details, see + <xref linkend="BlocksAndClasses"/>.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>entity</term> + <listitem> + <simpara>an ISO entity name (e.g., "ohm"); not all characters + have this attribute, because not all characters have ISO entity + names; for example, of the 800 or so characters in the standard + roff character map included in the distribution, only around 300 + have ISO entity names. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>string</term> + <listitem> + <simpara>a string representing an roff/groff escape-code (with + "@esc@" used in place of the backslash), or a simple ASCII + string; all characters in the roff character map have this + attribute</simpara> + </listitem> + </varlistentry> +</variablelist> +</para> +<para>The value of <parameter>man.charmap.subset.profile</parameter> +is evaluated as an XPath expression at run-time to select a portion of +the roff character map to use. You can tune the subset used by adding +or removing parts. For example, if you need to use a wide range of +mathematical operators in a document, and you want to have them +converted into roff markup properly, you might add the following: + +<literallayout class="monospaced"> @*[local-name() = 'block'] ='MathematicalOperators' </literallayout> + +That will cause a additional set of around 67 additional "math" +characters to be converted into roff markup. </para> + +<note> +<para>Depending on which XSLT engine you use, either the EXSLT +<function>dyn:evaluate</function> extension function (for xsltproc or +Xalan) or <function>saxon:evaluate</function> extension function (for +Saxon) are used to dynamically evaluate the value of +<parameter>man.charmap.subset.profile</parameter> at run-time. If you +don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that +supports <function>dyn:evaluate</function> -- you must either set the +value of the <parameter>man.charmap.use.subset</parameter> parameter +to zero and process your documents using the full character map +instead, or set the value of the +<parameter>man.charmap.enabled</parameter> parameter to zero instead +(so that character-map processing is disabled completely.</para> +</note> + +<para>An alternative to using +<parameter>man.charmap.subset.profile</parameter> is to create your +own custom character map, and set the value of +<parameter>man.charmap.uri</parameter> to the URI/filename for +that. If you use a custom character map, you will probably want to +include in it just the characters you want to use, and so you will +most likely also want to set the value of +<parameter>man.charmap.use.subset</parameter> to zero.</para> +<para>You can create a +custom character map by making a copy of the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and +then adding to, changing, and/or deleting from that.</para> + +<caution> +<para>If you author your DocBook XML source in UTF-8 or UTF-16 +encoding and aren't sure what OSes or environments your man-page +output might end up being viewed on, and not sure what version of +nroff/groff those environments might have, you should be careful about +what Unicode symbols and special characters you use in your source and +what parts you add to the value of +<parameter>man.charmap.subset.profile</parameter>.</para> +<para>Many of the escape codes used are specific to groff and using +them may not provide the expected output on an OS or environment that +uses nroff instead of groff.</para> +<para>On the other hand, if you intend for your man-page output to be +viewed only on modern systems (for example, GNU/Linux systems, FreeBSD +systems, or Cygwin environments) that have a good, up-to-date groff, +then you can safely include a wide range of Unicode symbols and +special characters in your UTF-8 or UTF-16 encoded DocBook XML source +and add any of the supported Unicode block names to the value of +<parameter>man.charmap.subset.profile</parameter>.</para> +</caution> + + +<para>For other details, see the documentation for the +<parameter>man.charmap.use.subset</parameter> parameter.</para> + +<refsection xml:id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info> + + + <para>Below is the full list of Unicode block names and "class" + values supported in the standard roff stylesheet provided in the + distribution, along with a description of which codepoints from the + Unicode range corresponding to that block name or block/class + combination are supported.</para> + + <itemizedlist> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</link> (x00a0 to x00ff) + <itemizedlist><info><title>class values</title></info> + + <listitem> + <para>symbols</para> + </listitem> + <listitem> + <para>letters</para> + </listitem> + </itemizedlist></para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial) + <itemizedlist><info><title>class values</title></info> + + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203">spaces</link></para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213">dashes</link></para> + </listitem> + <listitem> + <para>quotes</para> + </listitem> + <listitem> + <para>daggers</para> + </listitem> + <listitem> + <para>bullets</para> + </listitem> + <listitem> + <para>leaders</para> + </listitem> + <listitem> + <para>primes</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para> + </listitem> + <listitem> + <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para> + </listitem> + </itemizedlist> +</refsection> +</refsection> +</refentry> diff --git a/params/man.charmap.uri.xml b/params/man.charmap.uri.xml new file mode 100644 index 0000000..0c8f574 --- /dev/null +++ b/params/man.charmap.uri.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.charmap.uri"> +<refmeta> +<refentrytitle>man.charmap.uri</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.charmap.uri</refname> +<refpurpose>URI for custom roff character map</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.charmap.uri.frag"> +<xsl:param name="man.charmap.uri"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>For converting certain Unicode symbols and special characters in +UTF-8 or UTF-16 encoded XML source to appropriate groff/roff +equivalents in man-page output, the DocBook XSL Stylesheets +distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character +map</link>. That character map can be considered the standard roff +character map for the distribution.</para> + +<para>If the value of the <parameter>man.charmap.uri</parameter> +parameter is non-empty, that value is used as the URI for the location +for an alternate roff character map to use in place of the standard +roff character map provided in the distribution.</para> + +<warning> +<para>Do not set a value for <parameter>man.charmap.uri</parameter> +unless you have a custom roff character map that differs from the +standard one provided in the distribution.</para> +</warning> +</refsection> +</refentry> diff --git a/params/man.charmap.use.subset.xml b/params/man.charmap.use.subset.xml new file mode 100644 index 0000000..4403704 --- /dev/null +++ b/params/man.charmap.use.subset.xml @@ -0,0 +1,80 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.charmap.use.subset"> +<refmeta> +<refentrytitle>man.charmap.use.subset</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.charmap.use.subset</refname> +<refpurpose>Use subset of character map instead of full map?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.charmap.use.subset.frag"> +<xsl:param name="man.charmap.use.subset" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.charmap.use.subset</parameter> parameter is non-zero, +a subset of the roff character map is used instead of the full roff +character map. The profile of the subset used is determined either +by the value of the +<parameter>man.charmap.subset.profile</parameter> +parameter (if the source is not in English) or the +<parameter>man.charmap.subset.profile.english</parameter> +parameter (if the source is in English).</para> + +<note> + <para>You may want to experiment with setting a non-zero value of + <parameter>man.charmap.use.subset</parameter>, so that the full + character map is used. Depending on which XSLT engine you run, + setting a non-zero value for + <parameter>man.charmap.use.subset</parameter> may significantly + increase the time needed to process your documents. Or it may + not. For example, if you set it and run it with xsltproc, it seems + to dramatically increase processing time; on the other hand, if you + set it and run it with Saxon, it does not seem to increase + processing time nearly as much.</para> + + <para>If processing time is not a important concern and/or you can + tolerate the increase in processing time imposed by using the full + character map, set <parameter>man.charmap.use.subset</parameter> to + zero.</para> +</note> + +<refsection><info><title>Details</title></info> + +<para>For converting certain Unicode symbols and special characters in +UTF-8 or UTF-16 encoded XML source to appropriate groff/roff +equivalents in man-page output, the DocBook XSL Stylesheets +distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character +map</link> format as detailed in the XSLT 2.0 specification. The map +contains more than 800 character mappings and can be considered the +standard roff character map for the distribution.</para> + +<note> +<para>You can use the <parameter>man.charmap.uri</parameter> +parameter to specify a URI for the location for an alternate roff +character map to use in place of the standard roff character map +provided in the distribution.</para> +</note> + +<para>Because it is not terrifically efficient to use the standard +800-character character map in full -- and for most (or all) users, +never necessary to use it in full -- the DocBook XSL Stylesheets +support a mechanism for using, within any given character map, a +subset of character mappings instead of the full set. You can use the +<parameter>man.charmap.subset.profile</parameter> or +<parameter>man.charmap.subset.profile.english</parameter> +parameter to tune the profile of that subset to use.</para> + +</refsection> +</refsection> +</refentry> diff --git a/params/man.copyright.section.enabled.xml b/params/man.copyright.section.enabled.xml new file mode 100644 index 0000000..9e83587 --- /dev/null +++ b/params/man.copyright.section.enabled.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.copyright.section.enabled"> +<refmeta> +<refentrytitle>man.copyright.section.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.copyright.section.enabled</refname> +<refpurpose>Display auto-generated COPYRIGHT section?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="man.copyright.section.enabled.frag"> +<xsl:param name="man.copyright.section.enabled">1</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>man.copyright.section.enabled</parameter> is non-zero +(the default), then a <literal>COPYRIGHT</literal> section is +generated near the end of each man page. The output of the +<literal>COPYRIGHT</literal> section is assembled from any +<tag>copyright</tag> and <tag>legalnotice</tag> metadata found in +the contents of the child <tag>info</tag> or +<tag>refentryinfo</tag> (if any) of the <tag>refentry</tag> +itself, or from any <tag>copyright</tag> and +<tag>legalnotice</tag> metadata that may appear in <tag>info</tag> +contents of any ancestors of the <tag>refentry</tag>.</para> + +<para>If the value of +<parameter>man.copyright.section.enabled</parameter> is zero, the +the auto-generated <literal>COPYRIGHT</literal> section is +suppressed.</para> + +<para>Set the value of + <parameter>man.copyright.section.enabled</parameter> to zero if + you want to have a manually created <literal>COPYRIGHT</literal> + section in your source, and you want it to appear in output + instead of the auto-generated <literal>COPYRIGHT</literal> + section.</para> +</refsection> +</refentry> diff --git a/params/man.endnotes.are.numbered.xml b/params/man.endnotes.are.numbered.xml new file mode 100644 index 0000000..b069ec3 --- /dev/null +++ b/params/man.endnotes.are.numbered.xml @@ -0,0 +1,106 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.endnotes.are.numbered"> +<refmeta> +<refentrytitle>man.endnotes.are.numbered</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.endnotes.are.numbered</refname> +<refpurpose>Number endnotes?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.endnotes.are.numbered.frag"> +<xsl:param name="man.endnotes.are.numbered">1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.endnotes.are.numbered</parameter> is +non-zero (the default), then for each non-empty<footnote> +<para>A “non-empty” notesource is one that looks like +this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout> +an “empty” notesource is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout> +</para></footnote> “notesource”: + +<itemizedlist> + <listitem> + <para>a number (in square brackets) is displayed inline after the + rendered inline contents (if any) of the notesource</para> + </listitem> + <listitem> + <para>the contents of the notesource are included in a + numbered list of endnotes that is generated at the end of + each man page; the number for each endnote corresponds to + the inline number for the notesource with which it is + associated</para> + </listitem> +</itemizedlist> +The default heading for the list of endnotes is +<literal>NOTES</literal>. To output a different heading, set a value +for the <parameter>man.endnotes.section.heading</parameter> +parameter.</para> + +<note> + <para>The endnotes list is also displayed (but without + numbers) if the value of + <parameter>man.endnotes.list.enabled</parameter> is + non-zero.</para> +</note> + + +<para>If the value of <parameter>man.endnotes.are.numbered</parameter> is +zero, numbering of endnotess is suppressed; only inline +contents (if any) of the notesource are displayed inline. +<important> + <para>If you are thinking about disabling endnote numbering by setting + the value of <parameter>man.endnotes.are.numbered</parameter> to zero, + before you do so, first take some time to carefully + consider the information needs and experiences of your users. The + square-bracketed numbers displayed inline after notesources may seem + obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might + think it would be better to just display URLs for non-empty + links inline, after their content, rather than displaying + square-bracketed numbers all over the place. But it's not better. In + fact, it's not even practical, because many (most) URLs for links + are too long to be displayed inline. They end up overflowing the + right margin. You can set a non-zero value for + <parameter>man.break.after.slash</parameter> parameter to deal with + that, but it could be argued that what you end up with is at least + as ugly, and definitely more obstrusive, then having short + square-bracketed numbers displayed inline.</para></footnote>, + + but in a text-only output format, the + numbered-notesources/endnotes-listing mechanism is the only + practical way to handle this kind of content.</para> + + <para>Also, users of “text based” browsers such as + <command>lynx</command> will already be accustomed to seeing inline + numbers for links. And various "man to html" applications, such as + the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>) + application, can automatically turn URLs into "real" HTML hyperlinks + in output. So leaving <parameter>man.endnotes.are.numbered</parameter> + at its default (non-zero) value ensures that no information is + lost in your man-page output. It just gets + “rearranged”.</para> +</important> +</para> +<para>The handling of empty links is not affected by this +parameter. Empty links are handled simply by displaying their URLs +inline. Empty links are never auto-numbered.</para> + +<para>If you disable endnotes numbering, you should probably also set +<parameter>man.font.links</parameter> to an empty value (to +disable font formatting for links.</para> +</refsection> + +<refsection><info><title>Related Parameters</title></info> + <para><parameter>man.endnotes.list.enabled</parameter>, + <parameter>man.font.links</parameter></para> +</refsection> +</refentry> diff --git a/params/man.endnotes.list.enabled.xml b/params/man.endnotes.list.enabled.xml new file mode 100644 index 0000000..89d8188 --- /dev/null +++ b/params/man.endnotes.list.enabled.xml @@ -0,0 +1,105 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.endnotes.list.enabled"> +<refmeta> +<refentrytitle>man.endnotes.list.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.endnotes.list.enabled</refname> +<refpurpose>Display endnotes list at end of man page?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.endnotes.list.enabled.frag"> +<xsl:param name="man.endnotes.list.enabled">1</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is +non-zero (the default), then an endnotes list is added to the end of +the output man page.</para> + +<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is +zero, the list is suppressed — unless link numbering is enabled (that +is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in +which case, that setting overrides the +<parameter>man.endnotes.list.enabled</parameter> setting, and the +endnotes list is still displayed. The reason is that inline +numbering of notesources associated with endnotes only makes sense +if a (numbered) list of endnotes is also generated.</para> + +<note> + <para>Leaving + <parameter>man.endnotes.list.enabled</parameter> at its default + (non-zero) value ensures that no “out of line” information (such + as the URLs for hyperlinks and images) gets lost in your + man-page output. It just gets “rearranged”.</para> + <para>So if you’re thinking about disabling endnotes listing by + setting the value of + <parameter>man.endnotes.list.enabled</parameter> to zero: + Before you do so, first take some time to carefully consider + the information needs and experiences of your users. The “out + of line” information has value even if the presentation of it + in text output is not as interactive as it may be in other + output formats.</para> + <para>As far as the specific case of URLs: Even though the URLs + displayed in text output may not be “real” (clickable) + hyperlinks, many X terminals have convenience features for + recognizing URLs and can, for example, present users with + an options to open a URL in a browser with the user clicks on + the URL is a terminal window. And short of those, users with X + terminals can always manually cut and paste the URLs into a web + browser.</para> + <para>Also, note that various “man to html” tools, such as the + widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>) + application, automatically mark up URLs with <literal>a@href</literal> markup + during conversion — resulting in “real” hyperlinks in HTML + output from those tools.</para> +</note> + +<para>To “turn off” numbering of endnotes in the +endnotes list, set <parameter>man.endnotes.are.numbered</parameter> +to zero. The endnotes list will +still be displayed; it will just be displayed without the +numbers<footnote><para>It can still make sense to have +the list of endnotes displayed even if you have endnotes numbering turned +off. In that case, your endnotes list basically becomes a “list +of references” without any association with specific text in +your document. This is probably the best option if you find the inline +endnotes numbering obtrusive. Your users will still have access to all the “out of line” +such as URLs for hyperlinks.</para></footnote> +</para> + +<para>The default heading for the endnotes list is +<literal>NOTES</literal>. To change that, set a non-empty +value for the <parameter>man.endnotes.list.heading</parameter> +parameter.</para> + +<para>In the case of notesources that are links: Along with the +URL for each link, the endnotes list includes the contents of the +link. The list thus includes only non-empty<footnote> + +<para>A “non-empty” link is one that looks like +this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout> +an “empty link” is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout> +</para></footnote> links. + +Empty links are never included, and never numbered. They are simply +displayed inline, without any numbering.</para> + +<para>In addition, if there are multiple instances of links in a +<tag>refentry</tag> that have the same URL, the URL is listed only +once. The contents listed for that link in the endnotes list are +the contents of the first link which has that URL.</para> + +<para>If you disable endnotes listing, you should probably also set +<parameter>man.links.are.underlined</parameter> to zero (to disable +link underlining).</para> +</refsection> +</refentry> diff --git a/params/man.endnotes.list.heading.xml b/params/man.endnotes.list.heading.xml new file mode 100644 index 0000000..fe6545c --- /dev/null +++ b/params/man.endnotes.list.heading.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.endnotes.list.heading"> +<refmeta> +<refentrytitle>man.endnotes.list.heading</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.endnotes.list.heading</refname> +<refpurpose>Specifies an alternate name for endnotes list</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.endnotes.list.heading.frag"> +<xsl:param name="man.endnotes.list.heading"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.endnotes.are.numbered</parameter> parameter +and/or the <parameter>man.endnotes.list.enabled</parameter> +parameter is non-zero (the defaults for both are non-zero), a +numbered list of endnotes is generated near the end of each man +page. The default heading for the list of endnotes is the +equivalent of the English word <literal>NOTES</literal> in +the current locale. To cause an alternate heading to be displayed, +set a non-empty value for the +<parameter>man.endnotes.list.heading</parameter> parameter — +for example, <literal>REFERENCES</literal>.</para> +</refsection> +</refentry> diff --git a/params/man.font.funcprototype.xml b/params/man.font.funcprototype.xml new file mode 100644 index 0000000..67b698b --- /dev/null +++ b/params/man.font.funcprototype.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.font.funcprototype"> +<refmeta> +<refentrytitle>man.font.funcprototype</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.font.funcprototype</refname> +<refpurpose>Specifies font for funcprototype output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.font.funcprototype.frag"> + <xsl:param name="man.font.funcprototype">BI</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.font.funcprototype</parameter> parameter +specifies the font for <tag>funcprototype</tag> output. It +should be a valid roff font name, such as <literal>BI</literal> or +<literal>B</literal>.</para> + +</refsection> +</refentry> diff --git a/params/man.font.funcsynopsisinfo.xml b/params/man.font.funcsynopsisinfo.xml new file mode 100644 index 0000000..bd7a36f --- /dev/null +++ b/params/man.font.funcsynopsisinfo.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.font.funcsynopsisinfo"> +<refmeta> +<refentrytitle>man.font.funcsynopsisinfo</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.font.funcsynopsisinfo</refname> +<refpurpose>Specifies font for funcsynopsisinfo output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.font.funcsynopsisinfo.frag"> + <xsl:param name="man.font.funcsynopsisinfo">B</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter +specifies the font for <tag>funcsynopsisinfo</tag> output. It +should be a valid roff font name, such as <literal>B</literal> or +<literal>I</literal>.</para> + +</refsection> +</refentry> diff --git a/params/man.font.links.xml b/params/man.font.links.xml new file mode 100644 index 0000000..0f8a1e0 --- /dev/null +++ b/params/man.font.links.xml @@ -0,0 +1,64 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.font.links"> +<refmeta> +<refentrytitle>man.font.links</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.font.links</refname> +<refpurpose>Specifies font for links</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.font.links.frag"> +<xsl:param name="man.font.links">B</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.font.links</parameter> parameter +specifies the font for output of links (<tag>ulink</tag> instances +and any instances of any element with an <tag + class="attribute">xlink:href</tag> attribute).</para> + +<para>The value of <parameter>man.font.links</parameter> must be + either <literal>B</literal> or <literal>I</literal>, or empty. If +the value is empty, no font formatting is applied to links.</para> + +<para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or +<parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then +you should probably also set an empty value for +<parameter>man.font.links</parameter>. But if +<parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled), +you should probably keep +<parameter>man.font.links</parameter> set to +<literal>B</literal> or <literal>I</literal><footnote><para>The + main purpose of applying a font format to links in most output +formats it to indicate that the formatted text is +“clickable”; given that links rendered in man pages are +not “real” hyperlinks that users can click on, it might +seem like there is never a good reason to have font formatting for +link contents in man output.</para> +<para>In fact, if you suppress the +display of inline link references (by setting +<parameter>man.endnotes.are.numbered</parameter> to zero), there is no +good reason to apply font formatting to links. However, if +<parameter>man.endnotes.are.numbered</parameter> is non-zero, having +font formatting for links (arguably) serves a purpose: It provides +“context” information about exactly what part of the text +is being “annotated” by the link. Depending on how you +mark up your content, that context information may or may not +have value.</para></footnote>.</para> +</refsection> + +<refsection><info><title>Related Parameters</title></info> + <para><parameter>man.endnotes.list.enabled</parameter>, + <parameter>man.endnotes.are.numbered</parameter></para> +</refsection> + +</refentry> diff --git a/params/man.font.table.headings.xml b/params/man.font.table.headings.xml new file mode 100644 index 0000000..5056f2b --- /dev/null +++ b/params/man.font.table.headings.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.font.table.headings"> +<refmeta> +<refentrytitle>man.font.table.headings</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.font.table.headings</refname> +<refpurpose>Specifies font for table headings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.font.table.headings.frag"> + <xsl:param name="man.font.table.headings">B</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.font.table.headings</parameter> parameter +specifies the font for <tag>table</tag> headings. It should be +a valid roff font, such as <literal>B</literal> or +<literal>I</literal>.</para> + +</refsection> +</refentry> diff --git a/params/man.font.table.title.xml b/params/man.font.table.title.xml new file mode 100644 index 0000000..a7f2ae9 --- /dev/null +++ b/params/man.font.table.title.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.font.table.title"> +<refmeta> +<refentrytitle>man.font.table.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.font.table.title</refname> +<refpurpose>Specifies font for table headings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.font.table.title.frag"> + <xsl:param name="man.font.table.title">B</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.font.table.title</parameter> parameter +specifies the font for <tag>table</tag> titles. It should be +a valid roff font, such as <literal>B</literal> or +<literal>I</literal>.</para> + +</refsection> +</refentry> diff --git a/params/man.funcsynopsis.style.xml b/params/man.funcsynopsis.style.xml new file mode 100644 index 0000000..0597087 --- /dev/null +++ b/params/man.funcsynopsis.style.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.funcsynopsis.style"> +<refmeta> +<refentrytitle>man.funcsynopsis.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ansi</refmiscinfo> +<refmiscinfo class="other" otherclass="value">kr</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.funcsynopsis.style</refname> +<refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="man.funcsynopsis.style.frag"><xsl:param name="man.funcsynopsis.style">ansi</xsl:param></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If <parameter>man.funcsynopsis.style</parameter> is +<literal>ansi</literal>, ANSI-style function synopses are +generated for a <tag>funcsynopsis</tag>, otherwise K&R-style +function synopses are generated.</para> +</refsection> +</refentry> diff --git a/params/man.hyphenate.computer.inlines.xml b/params/man.hyphenate.computer.inlines.xml new file mode 100644 index 0000000..3e23ade --- /dev/null +++ b/params/man.hyphenate.computer.inlines.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.hyphenate.computer.inlines"> +<refmeta> +<refentrytitle>man.hyphenate.computer.inlines</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.hyphenate.computer.inlines</refname> +<refpurpose>Hyphenate computer inlines?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.hyphenate.computer.inlines.frag"> +<xsl:param name="man.hyphenate.computer.inlines">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), hyphenation is suppressed for +<quote>computer inlines</quote> such as environment variables, +constants, etc. This parameter current affects output of the following +elements: +<simplelist type="inline"> + <?dbchoice choice="and" ?> + <member><tag>classname</tag></member> + <member><tag>constant</tag></member> + <member><tag>envar</tag></member> + <member><tag>errorcode</tag></member> + <member><tag>option</tag></member> + <member><tag>replaceable</tag></member> + <member><tag>userinput</tag></member> + <member><tag>type</tag></member> + <member><tag>varname</tag></member> +</simplelist> +</para> + +<note> + <para>If hyphenation is already turned off globally (that is, if + <parameter>man.hyphenate</parameter> is zero, setting the + <parameter>man.hyphenate.computer.inlines</parameter> is not + necessary.</para> +</note> + +<para>If <parameter>man.hyphenate.computer.inlines</parameter> is +non-zero, computer inlines will not be treated specially and will be +hyphenated like other words when needed.</para> + +</refsection> +</refentry> diff --git a/params/man.hyphenate.filenames.xml b/params/man.hyphenate.filenames.xml new file mode 100644 index 0000000..891d6da --- /dev/null +++ b/params/man.hyphenate.filenames.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.hyphenate.filenames"> +<refmeta> +<refentrytitle>man.hyphenate.filenames</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.hyphenate.filenames</refname> +<refpurpose>Hyphenate filenames?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.hyphenate.filenames.frag"> +<xsl:param name="man.hyphenate.filenames">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), hyphenation is suppressed for +<tag>filename</tag> output.</para> + +<note> + <para>If hyphenation is already turned off globally (that is, if + <parameter>man.hyphenate</parameter> is zero, setting + <parameter>man.hyphenate.filenames</parameter> is not + necessary.</para> +</note> + +<para>If <parameter>man.hyphenate.filenames</parameter> is non-zero, +filenames will not be treated specially and are subject to hyphenation +just like other words.</para> + +<note> + <para>If you are thinking about setting a non-zero value for + <parameter>man.hyphenate.filenames</parameter> in order to make long + filenames/pathnames break across lines, you'd probably be better off + experimenting with setting the + <parameter>man.break.after.slash</parameter> parameter first. That + will cause long pathnames to be broken after slashes.</para> +</note> + +</refsection> +</refentry> diff --git a/params/man.hyphenate.urls.xml b/params/man.hyphenate.urls.xml new file mode 100644 index 0000000..a64dfa7 --- /dev/null +++ b/params/man.hyphenate.urls.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.hyphenate.urls"> +<refmeta> +<refentrytitle>man.hyphenate.urls</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.hyphenate.urls</refname> +<refpurpose>Hyphenate URLs?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.hyphenate.urls.frag"> +<xsl:param name="man.hyphenate.urls">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), hyphenation is suppressed for output of +the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para> + +<note> + <para>If hyphenation is already turned off globally (that is, if + <parameter>man.hyphenate</parameter> is zero, setting + <parameter>man.hyphenate.urls</parameter> is not necessary.</para> +</note> + +<para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs +will not be treated specially and are subject to hyphenation just like +other words.</para> + +<note> + <para>If you are thinking about setting a non-zero value for + <parameter>man.hyphenate.urls</parameter> in order to make long + URLs break across lines, you'd probably be better off + experimenting with setting the + <parameter>man.break.after.slash</parameter> parameter first. That + will cause long URLs to be broken after slashes.</para> +</note> + +</refsection> +</refentry> diff --git a/params/man.hyphenate.xml b/params/man.hyphenate.xml new file mode 100644 index 0000000..9198bbb --- /dev/null +++ b/params/man.hyphenate.xml @@ -0,0 +1,59 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.hyphenate"> +<refmeta> +<refentrytitle>man.hyphenate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.hyphenate</refname> +<refpurpose>Enable hyphenation?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.hyphenate.frag"> +<xsl:param name="man.hyphenate">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, hyphenation is enabled.</para> + +<note> +<para>The default value for this parameter is zero because groff is +not particularly smart about how it does hyphenation; it can end up +hyphenating a lot of things that you don't want hyphenated. To +mitigate that, the default behavior of the stylesheets is to suppress +hyphenation of computer inlines, filenames, and URLs. (You can +override the default behavior by setting non-zero values for the +<parameter>man.hyphenate.urls</parameter>, +<parameter>man.hyphenate.filenames</parameter>, and +<parameter>man.hyphenate.computer.inlines</parameter> parameters.) But +the best way is still to just globally disable hyphenation, as the +stylesheets do by default.</para> + +<para>The only good reason to enabled hyphenation is if you have also +enabled justification (which is disabled by default). The reason is +that justified text can look very bad unless you also hyphenate it; to +quote the <quote>Hypenation</quote> node from the groff info page: + +<blockquote> + <para><emphasis>Since the odds are not great for finding a set of + words, for every output line, which fit nicely on a line without + inserting excessive amounts of space between words, 'gtroff' + hyphenates words so that it can justify lines without inserting too + much space between words.</emphasis></para> +</blockquote> + +So, if you set a non-zero value for the +<parameter>man.justify</parameter> parameter (to enable +justification), then you should probably also set a non-zero value for +<parameter>man.hyphenate</parameter> (to enable hyphenation).</para> +</note> + + +</refsection> +</refentry> diff --git a/params/man.indent.blurbs.xml b/params/man.indent.blurbs.xml new file mode 100644 index 0000000..bf9bb91 --- /dev/null +++ b/params/man.indent.blurbs.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.indent.blurbs"> +<refmeta> +<refentrytitle>man.indent.blurbs</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.indent.blurbs</refname> +<refpurpose>Adjust indentation of blurbs?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.indent.blurbs.frag"> +<xsl:param name="man.indent.blurbs" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.indent.blurbs</parameter> is +non-zero, the width of the left margin for +<tag>authorblurb</tag>, <tag>personblurb</tag>, and +<tag>contrib</tag> output is set to the value of the +<parameter>man.indent.width</parameter> parameter +(<literal>3n</literal> by default). If instead the value of +<parameter>man.indent.blurbs</parameter> is zero, the built-in roff +default width (<literal>7.2n</literal>) is used.</para> + +</refsection> +</refentry> diff --git a/params/man.indent.lists.xml b/params/man.indent.lists.xml new file mode 100644 index 0000000..a2654d0 --- /dev/null +++ b/params/man.indent.lists.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.indent.lists"> +<refmeta> +<refentrytitle>man.indent.lists</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.indent.lists</refname> +<refpurpose>Adjust indentation of lists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.indent.lists.frag"> +<xsl:param name="man.indent.lists" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.indent.lists</parameter> is +non-zero, the width of the left margin for list items in +<tag>itemizedlist</tag>, +<tag>orderedlist</tag>, +<tag>variablelist</tag> output (and output of some other +lists) is set to the value of the +<parameter>man.indent.width</parameter> parameter +(<literal>4n</literal> by default). If instead the value of +<parameter>man.indent.lists</parameter> is zero, the built-in roff +default width (<literal>7.2n</literal>) is used.</para> + +</refsection> +</refentry> diff --git a/params/man.indent.refsect.xml b/params/man.indent.refsect.xml new file mode 100644 index 0000000..2865f8c --- /dev/null +++ b/params/man.indent.refsect.xml @@ -0,0 +1,70 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.indent.refsect"> +<refmeta> +<refentrytitle>man.indent.refsect</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.indent.refsect</refname> +<refpurpose>Adjust indentation of refsect* and refsection?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.indent.refsect.frag"> +<xsl:param name="man.indent.refsect" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.indent.refsect</parameter> is +non-zero, the width of the left margin for +<tag>refsect1</tag>, <tag>refsect2</tag> and +<tag>refsect3</tag> contents and titles (and first-level, +second-level, and third-level nested +<tag>refsection</tag>instances) is adjusted by the value of +the <parameter>man.indent.width</parameter> parameter. With +<parameter>man.indent.width</parameter> set to its default value of +<literal>3n</literal>, the main results are that: + +<itemizedlist> + <listitem> + <para>contents of <tag>refsect1</tag> are output with a + left margin of three characters instead the roff default of seven + or eight characters</para> + </listitem> + <listitem> + <para>contents of <tag>refsect2</tag> are displayed in + console output with a left margin of six characters instead the of + the roff default of seven characters</para> + </listitem> + <listitem> + <para> the contents of <tag>refsect3</tag> and nested + <tag>refsection</tag> instances are adjusted + accordingly.</para> + </listitem> +</itemizedlist> + +If instead the value of <parameter>man.indent.refsect</parameter> is +zero, no margin adjustment is done for <literal>refsect*</literal> +output.</para> + +<tip> + <para>If your content is primarly comprised of + <tag>refsect1</tag> and <tag>refsect2</tag> content + (or the <tag>refsection</tag> equivalent) – with few or + no <tag>refsect3</tag> or lower nested sections , you may be + able to “conserve” space in your output by setting + <parameter>man.indent.refsect</parameter> to a non-zero value. Doing + so will “squeeze” the left margin in such as way as to provide an + additional four characters of “room” per line in + <tag>refsect1</tag> output. That extra room may be useful + if, for example, you have many verbatim sections with long lines in + them.</para> +</tip> + +</refsection> +</refentry> diff --git a/params/man.indent.verbatims.xml b/params/man.indent.verbatims.xml new file mode 100644 index 0000000..0436c9e --- /dev/null +++ b/params/man.indent.verbatims.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.indent.verbatims"> +<refmeta> +<refentrytitle>man.indent.verbatims</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.indent.verbatims</refname> +<refpurpose>Adjust indentation of verbatims?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.indent.verbatims.frag"> +<xsl:param name="man.indent.verbatims" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.indent.verbatims</parameter> is +non-zero, the width of the left margin for output of verbatim +environments (<tag>programlisting</tag>, +<tag>screen</tag>, and so on) is set to the value of the +<parameter>man.indent.width</parameter> parameter +(<literal>3n</literal> by default). If instead the value of +<parameter>man.indent.verbatims</parameter> is zero, the built-in roff +default width (<literal>7.2n</literal>) is used.</para> + +</refsection> +</refentry> diff --git a/params/man.indent.width.xml b/params/man.indent.width.xml new file mode 100644 index 0000000..2d4496d --- /dev/null +++ b/params/man.indent.width.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.indent.width"> +<refmeta> +<refentrytitle>man.indent.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.indent.width</refname> +<refpurpose>Specifies width used for adjusted indents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.indent.width.frag"> +<xsl:param name="man.indent.width">4</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The <parameter>man.indent.width</parameter> parameter specifies +the width used for adjusted indents. The value of +<parameter>man.indent.width</parameter> is used for indenting of +lists, verbatims, headings, and elsewhere, depending on whether the +values of certain <literal>man.indent.*</literal> boolean parameters +are non-zero.</para> + +<para>The value of <parameter>man.indent.width</parameter> should +include a valid roff measurement unit (for example, +<literal>n</literal> or <literal>u</literal>). The default value of +<literal>4n</literal> specifies a 4-en width; when viewed on a +console, that amounts to the width of four characters. For details +about roff measurment units, see the <literal>Measurements</literal> +node in the groff info page.</para> + +</refsection> +</refentry> diff --git a/params/man.justify.xml b/params/man.justify.xml new file mode 100644 index 0000000..5495d05 --- /dev/null +++ b/params/man.justify.xml @@ -0,0 +1,52 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.justify"> +<refmeta> +<refentrytitle>man.justify</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.justify</refname> +<refpurpose>Justify text to both right and left margins?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.justify.frag"> +<xsl:param name="man.justify">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, text is justified to both the right and left +margins (or, in roff terminology, "adjusted and filled" to both the +right and left margins). If zero (the default), text is adjusted to +the left margin only -- producing what is traditionally called +"ragged-right" text.</para> + +<note> +<para>The default value for this parameter is zero because justified +text looks good only when it is also hyphenated. Without hyphenation, +excessive amounts of space often end up getting between words, in +order to "pad" lines out to align on the right margin.</para> + +<para>The problem is that groff is not particularly smart about how it +does hyphenation; it can end up hyphenating a lot of things that you +don't want hyphenated. So, disabling both justification and +hyphenation ensures that hyphens won't get inserted where you don't +want to them, and you don't end up with lines containing excessive +amounts of space between words.</para> + +<para>However, if do you decide to set a non-zero value for the +<parameter>man.justify</parameter> parameter (to enable +justification), then you should probably also set a non-zero value for +<parameter>man.hyphenate</parameter> (to enable hyphenation).</para> + +<para>Yes, these default settings run counter to how most existing man +pages are formatted. But there are some notable exceptions, such as +the <literal>perl</literal> man pages.</para> +</note> +</refsection> +</refentry> diff --git a/params/man.output.base.dir.xml b/params/man.output.base.dir.xml new file mode 100644 index 0000000..25113d0 --- /dev/null +++ b/params/man.output.base.dir.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.base.dir"> +<refmeta> +<refentrytitle>man.output.base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.base.dir</refname> +<refpurpose>Specifies separate output directory</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.base.dir.frag"><xsl:param name="man.output.base.dir">man/</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.output.base.dir</parameter> parameter +specifies the base directory into which man-page files are output. The +<parameter>man.output.subdirs.enabled</parameter> parameter controls +whether the files are output in subdirectories within the base +directory.</para> + +<note> + <para>The values of the <parameter>man.output.base.dir</parameter> + and <parameter>man.output.subdirs.enabled</parameter> parameters are + used only if the value of + <parameter>man.output.in.separate.dir</parameter> parameter is + non-zero. If the value of the + <parameter>man.output.in.separate.dir</parameter> is zero, man-page + files are not output in a separate directory.</para> +</note> + +</refsection> +</refentry> diff --git a/params/man.output.better.ps.enabled.xml b/params/man.output.better.ps.enabled.xml new file mode 100644 index 0000000..82d15dd --- /dev/null +++ b/params/man.output.better.ps.enabled.xml @@ -0,0 +1,61 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.better.ps.enabled"> +<refmeta> +<refentrytitle>man.output.better.ps.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.better.ps.enabled</refname> +<refpurpose>Enable enhanced print/PostScript output?</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="man.output.better.ps.enabled.frag"> +<xsl:param name="man.output.better.ps.enabled">0</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.output.better.ps.enabled</parameter> parameter is +non-zero, certain markup is embedded in each generated man page +such that PostScript output from the <command>man -Tps</command> +command for that page will include a number of enhancements +designed to improve the quality of that output.</para> + +<para>If <parameter>man.output.better.ps.enabled</parameter> is +zero (the default), no such markup is embedded in generated man +pages, and no enhancements are included in the PostScript +output generated from those man pages by the <command>man + -Tps</command> command.</para> + +<warning> + <para>The enhancements provided by this parameter rely on + features that are specific to groff (GNU troff) and that are + not part of “classic” AT&T troff or any of its + derivatives. Therefore, any man pages you generate with this + parameter enabled will be readable only on systems on which + the groff (GNU troff) program is installed, such as GNU/Linux + systems. The pages <emphasis role="bold">will not not be + readable on systems on with the classic troff (AT&T + troff) command is installed</emphasis>.</para> +</warning> + +<para>The value of this parameter only affects PostScript output + generated from the <command>man</command> command. It has no + effect on output generated using the FO backend.</para> + +<tip> + <para>You can generate PostScript output for any man page by + running the following command:</para> + <programlisting> man <replaceable>FOO</replaceable> -Tps > <replaceable>FOO</replaceable>.ps</programlisting> + <para>You can then generate PDF output by running the following + command:</para> + <programlisting> ps2pdf <replaceable>FOO</replaceable>.ps</programlisting> +</tip> + +</refsection> +</refentry> diff --git a/params/man.output.encoding.xml b/params/man.output.encoding.xml new file mode 100644 index 0000000..7154bc8 --- /dev/null +++ b/params/man.output.encoding.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.encoding"> +<refmeta> +<refentrytitle>man.output.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.encoding</refname> +<refpurpose>Encoding used for man-page output</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.encoding.frag"> +<xsl:param name="man.output.encoding">UTF-8</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the encoding to use for files generated +by the manpages stylesheet. Not all processors support specification +of this parameter.</para> + +<important> + <para>If the value of the <parameter>man.charmap.enabled</parameter> + parameter is non-zero (the default), keeping the + <parameter>man.output.encoding</parameter> parameter at its default + value (<literal>UTF-8</literal>) or setting it to + <literal>UTF-16</literal> <emphasis role="bold">does not cause your + man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because + any Unicode characters for which matches are found in the enabled + character map will be replaced with roff escape sequences before the + final man-page files are generated.</para> + + <para>So if you want to generate "real" UTF-8 man pages, without any + character substitution being performed on your content, you need to + set <parameter>man.charmap.enabled</parameter> to zero (which will + completely disable character-map processing). </para> + + <para>You may also need to set + <parameter>man.charmap.enabled</parameter> to zero if you want to + output man pages in an encoding other than <literal>UTF-8</literal> + or <literal>UTF-16</literal>. Character-map processing is based on + Unicode character values and may not work with other output + encodings.</para> +</important> + +</refsection> +</refentry> diff --git a/params/man.output.in.separate.dir.xml b/params/man.output.in.separate.dir.xml new file mode 100644 index 0000000..1492720 --- /dev/null +++ b/params/man.output.in.separate.dir.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.in.separate.dir"> +<refmeta> +<refentrytitle>man.output.in.separate.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.in.separate.dir</refname> +<refpurpose>Output man-page files in separate output directory?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.in.separate.dir.frag"> +<xsl:param name="man.output.in.separate.dir" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <literal>man.output.in.separate.dir</literal> +parameter is non-zero, man-page files are output in a separate +directory, specified by the <parameter>man.output.base.dir</parameter> +parameter; otherwise, if the value of +<literal>man.output.in.separate.dir</literal> is zero, man-page files +are not output in a separate directory.</para> + +</refsection> +</refentry> diff --git a/params/man.output.lang.in.name.enabled.xml b/params/man.output.lang.in.name.enabled.xml new file mode 100644 index 0000000..1fed3c0 --- /dev/null +++ b/params/man.output.lang.in.name.enabled.xml @@ -0,0 +1,50 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.lang.in.name.enabled"> +<refmeta> +<refentrytitle>man.output.lang.in.name.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.lang.in.name.enabled</refname> +<refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.lang.in.name.enabled.frag"> +<xsl:param name="man.output.lang.in.name.enabled" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + + <para>The <parameter>man.output.lang.in.name.enabled</parameter> + parameter specifies whether a <literal>$lang</literal> value is + included in man-page filenames and pathnames.</para> + + <para>If the value of + <parameter>man.output.lang.in.name.enabled</parameter> is non-zero, + man-page files are output with the <literal>$lang</literal> value + included in their filenames or pathnames as follows; + + <itemizedlist> + <listitem> + <para>if <parameter>man.output.subdirs.enabled</parameter> is + non-zero, each file is output to, e.g., a + <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename> + pathname</para> + </listitem> + <listitem> + <para>if <parameter>man.output.subdirs.enabled</parameter> is + zero, each file is output with a + <literal>foo.<replaceable>$lang</replaceable>.8</literal> + filename</para> + </listitem> + </itemizedlist> + </para> + +</refsection> +</refentry> diff --git a/params/man.output.manifest.enabled.xml b/params/man.output.manifest.enabled.xml new file mode 100644 index 0000000..5da041c --- /dev/null +++ b/params/man.output.manifest.enabled.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.manifest.enabled"> + <refmeta> + <refentrytitle>man.output.manifest.enabled</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>man.output.manifest.enabled</refname> + <refpurpose>Generate a manifest file?</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="man.output.manifest.enabled.frag"><xsl:param name="man.output.manifest.enabled" select="0"/></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>If non-zero, a list of filenames for man pages generated by + the stylesheet transformation is written to the file named by the + <parameter>man.output.manifest.filename</parameter> parameter.</para> + + </refsection> +</refentry> diff --git a/params/man.output.manifest.filename.xml b/params/man.output.manifest.filename.xml new file mode 100644 index 0000000..f514ede --- /dev/null +++ b/params/man.output.manifest.filename.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.manifest.filename"> + <refmeta> + <refentrytitle>man.output.manifest.filename</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>man.output.manifest.filename</refname> + <refpurpose>Name of manifest file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="man.output.manifest.filename.frag"><xsl:param name="man.output.manifest.filename">MAN.MANIFEST</xsl:param></src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>The <parameter>man.output.manifest.filename</parameter> parameter + specifies the name of the file to which the manpages manifest file + is written (if the value of the + <parameter>man.output.manifest.enabled</parameter> parameter is + non-zero).</para> + + </refsection> +</refentry> diff --git a/params/man.output.quietly.xml b/params/man.output.quietly.xml new file mode 100644 index 0000000..acde7f4 --- /dev/null +++ b/params/man.output.quietly.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.quietly"> +<refmeta> +<refentrytitle>man.output.quietly</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.quietly</refname> +<refpurpose>Suppress filename messages emitted when generating output?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.quietly.frag"> +<xsl:param name="man.output.quietly" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), for each man-page file created, a message +with the name of the file is emitted. If non-zero, the files are +output "quietly" -- that is, the filename messages are +suppressed.</para> + +<tip> + <para>If you are processing a large amount of <tag>refentry</tag> + content, you may be able to speed up processing significantly by + setting a non-zero value for + <parameter>man.output.quietly</parameter>.</para> +</tip> + +</refsection> +</refentry> diff --git a/params/man.output.subdirs.enabled.xml b/params/man.output.subdirs.enabled.xml new file mode 100644 index 0000000..876b94e --- /dev/null +++ b/params/man.output.subdirs.enabled.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.output.subdirs.enabled"> +<refmeta> +<refentrytitle>man.output.subdirs.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.output.subdirs.enabled</refname> +<refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.output.subdirs.enabled.frag"> +<xsl:param name="man.output.subdirs.enabled" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.output.subdirs.enabled</parameter> parameter +controls whether man-pages files are output in subdirectories within +the base directory specified by the directory specified by the +<parameter>man.output.base.dir</parameter> parameter.</para> + +<note> + <para>The values of the <parameter>man.output.base.dir</parameter> + and <parameter>man.output.subdirs.enabled</parameter> parameters are + used only if the value of + <parameter>man.output.in.separate.dir</parameter> parameter is + non-zero. If the value of the + <parameter>man.output.in.separate.dir</parameter> is zero, man-page + files are not output in a separate directory.</para> +</note> + +</refsection> +</refentry> diff --git a/params/man.segtitle.suppress.xml b/params/man.segtitle.suppress.xml new file mode 100644 index 0000000..e54336d --- /dev/null +++ b/params/man.segtitle.suppress.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.segtitle.suppress"> +<refmeta> +<refentrytitle>man.segtitle.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.segtitle.suppress</refname> +<refpurpose>Suppress display of segtitle contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.segtitle.suppress.frag"> +<xsl:param name="man.segtitle.suppress" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.segtitle.suppress</parameter> is +non-zero, then display of <tag>segtitle</tag> contents is +suppressed in output.</para> + +</refsection> +</refentry> diff --git a/params/man.string.subst.map.local.post.xml b/params/man.string.subst.map.local.post.xml new file mode 100644 index 0000000..b12448d --- /dev/null +++ b/params/man.string.subst.map.local.post.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.string.subst.map.local.post"> +<refmeta> +<refentrytitle>man.string.subst.map.local.post</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.string.subst.map.local.post</refname> +<refpurpose>Specifies “local” string substitutions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.string.subst.map.local.post.frag"> +<xsl:param name="man.string.subst.map.local.post"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Use the <parameter>man.string.subst.map.local.post</parameter> +parameter to specify any “local” string substitutions to perform over +the entire roff source for each man page <emphasis>after</emphasis> +performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para> + +<para>For details about the format of this parameter, see the +documentation for the <parameter>man.string.subst.map</parameter> +parameter.</para> + +</refsection> +</refentry> diff --git a/params/man.string.subst.map.local.pre.xml b/params/man.string.subst.map.local.pre.xml new file mode 100644 index 0000000..6483752 --- /dev/null +++ b/params/man.string.subst.map.local.pre.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.string.subst.map.local.pre"> +<refmeta> +<refentrytitle>man.string.subst.map.local.pre</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.string.subst.map.local.pre</refname> +<refpurpose>Specifies “local” string substitutions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.string.subst.map.local.pre.frag"> + <xsl:param name="man.string.subst.map.local.pre"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Use the <parameter>man.string.subst.map.local.pre</parameter> +parameter to specify any “local” string substitutions to perform over +the entire roff source for each man page <emphasis>before</emphasis> +performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para> + +<para>For details about the format of this parameter, see the +documentation for the <parameter>man.string.subst.map</parameter> +parameter.</para> + +</refsection> +</refentry> diff --git a/params/man.string.subst.map.xml b/params/man.string.subst.map.xml new file mode 100644 index 0000000..0feed4a --- /dev/null +++ b/params/man.string.subst.map.xml @@ -0,0 +1,162 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:ss="http://docbook.sf.net/xmlns/string.subst/1.0" + version="5.0" xml:id="man.string.subst.map"> +<refmeta> +<refentrytitle>man.string.subst.map</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.string.subst.map</refname> +<refpurpose>Specifies a set of string substitutions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.string.subst.map.frag"> +<xsl:param name="man.string.subst.map"> + + <!-- * remove no-break marker at beginning of line (stylesheet artifact) --> + <ss:substitution oldstring="▒▀" newstring="▒"/> + <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space --> + <ss:substitution oldstring="▀" newstring="\ "/> + + <!-- ==================================================================== --> + + <!-- * squeeze multiple newlines before a roff request --> + <ss:substitution oldstring=" ." newstring=" ."/> + <!-- * remove any .sp instances that directly precede a .PP --> + <ss:substitution oldstring=".sp .PP" newstring=".PP"/> + <!-- * remove any .sp instances that directly follow a .PP --> + <ss:substitution oldstring=".sp .sp" newstring=".sp"/> + <!-- * squeeze multiple .sp instances into a single .sp--> + <ss:substitution oldstring=".PP .sp" newstring=".PP"/> + <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. --> + <ss:substitution oldstring=".nf " newstring=".nf "/> + <!-- * squeeze multiple newlines after REstoring margin --> + <ss:substitution oldstring=".RE " newstring=".RE "/> + <!-- * U+2591 is a marker we add before and after every Parameter in --> + <!-- * Funcprototype output --> + <ss:substitution oldstring="░" newstring=" "/> + <!-- * U+2592 is a marker we add for the newline before output of <sbr>; --> + <ss:substitution oldstring="▒" newstring=" "/> + <!-- * --> + <!-- * Now deal with some other characters that are added by the --> + <!-- * stylesheets during processing. --> + <!-- * --> + <!-- * bullet --> + <ss:substitution oldstring="•" newstring="\(bu"/> + <!-- * left double quote --> + <ss:substitution oldstring="“" newstring="\(lq"/> + <!-- * right double quote --> + <ss:substitution oldstring="”" newstring="\(rq"/> + <!-- * left single quote --> + <ss:substitution oldstring="‘" newstring="\(oq"/> + <!-- * right single quote --> + <ss:substitution oldstring="’" newstring="\(cq"/> + <!-- * copyright sign --> + <ss:substitution oldstring="©" newstring="\(co"/> + <!-- * registered sign --> + <ss:substitution oldstring="®" newstring="\(rg"/> + <!-- * ...servicemark... --> + <!-- * There is no groff equivalent for it. --> + <ss:substitution oldstring="℠" newstring="(SM)"/> + <!-- * ...trademark... --> + <!-- * We don't do "\(tm" because for console output, --> + <!-- * groff just renders that as "tm"; that is: --> + <!-- * --> + <!-- * Product™ -> Producttm --> + <!-- * --> + <!-- * So we just make it to "(TM)" instead; thus: --> + <!-- * --> + <!-- * Product™ -> Product(TM) --> + <ss:substitution oldstring="™" newstring="(TM)"/> + +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>man.string.subst.map</parameter> parameter +contains <link linkend="map">a map</link> that specifies a set of +string substitutions to perform over the entire roff source for each +man page, either just before generating final man-page output (that +is, before writing man-page files to disk) or, if the value of the +<parameter>man.charmap.enabled</parameter> parameter is non-zero, +before applying the roff character map.</para> + +<para>You can use <parameter>man.string.subst.map</parameter> as a +“lightweight” character map to perform “essential” substitutions -- +that is, substitutions that are <emphasis>always</emphasis> performed, +even if the value of the <parameter>man.charmap.enabled</parameter> +parameter is zero. For example, you can use it to replace quotation +marks or other special characters that are generated by the DocBook +XSL stylesheets for a particular locale setting (as opposed to those +characters that are actually in source XML documents), or to replace +any special characters that may be automatically generated by a +particular customization of the DocBook XSL stylesheets.</para> + +<warning> + <para>Do you not change value of the + <parameter>man.string.subst.map</parameter> parameter unless you are + sure what you are doing. First consider adding your + string-substitution mappings to either or both of the following + parameters: + <variablelist> + <varlistentry> + <term><parameter>man.string.subst.map.local.pre</parameter></term> + <listitem><para>applied before + <parameter>man.string.subst.map</parameter></para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>man.string.subst.map.local.post</parameter></term> + <listitem><para>applied after + <parameter>man.string.subst.map</parameter></para></listitem> + </varlistentry> + </variablelist> + By default, both of those parameters contain no + string substitutions. They are intended as a means for you to + specify your own local string-substitution mappings.</para> + + <para>If you remove any of default mappings from the value of the + <parameter>man.string.subst.map</parameter> parameter, you are + likely to end up with broken output. And be very careful about adding + anything to it; it’s used for doing string substitution over the + entire roff source of each man page – it causes target strings to be + replaced in roff requests and escapes, not just in the visible + contents of the page.</para> + +</warning> + +<refsection xml:id="map"> + <info> + <title>Contents of the substitution map</title> + </info> + <para>The string-substitution map contains one or more + <tag>ss:substitution</tag> elements, each of which has two + attributes: + <variablelist> + <varlistentry> + <term>oldstring</term> + <listitem> + <simpara>string to replace</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>newstring</term> + <listitem> + <simpara>string with which to replace <tag + class="attribute">oldstring</tag></simpara> + </listitem> + </varlistentry> + </variablelist> + It may also include XML comments (that is, delimited with + "<literal><!--</literal>" and "<literal>--></literal>"). + </para> +</refsection> + +</refsection> +</refentry> diff --git a/params/man.subheading.divider.enabled.xml b/params/man.subheading.divider.enabled.xml new file mode 100644 index 0000000..1156c5f --- /dev/null +++ b/params/man.subheading.divider.enabled.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.subheading.divider.enabled"> +<refmeta> +<refentrytitle>man.subheading.divider.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.subheading.divider.enabled</refname> +<refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.subheading.divider.enabled.frag"> +<xsl:param name="man.subheading.divider.enabled">0</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.subheading.divider.enabled</parameter> parameter is +non-zero, the contents of the +<parameter>man.subheading.divider</parameter> parameter are used to +add a "divider" before and after subheadings in the roff +output. <emphasis role="bold">The divider is not visisble in the +rendered man page</emphasis>; it is added as a comment, in the source, +simply for the purpose of increasing reability of the source.</para> + +<para>If <parameter>man.subheading.divider.enabled</parameter> is zero +(the default), the subheading divider is suppressed.</para> + +</refsection> +</refentry> diff --git a/params/man.subheading.divider.xml b/params/man.subheading.divider.xml new file mode 100644 index 0000000..dbd2669 --- /dev/null +++ b/params/man.subheading.divider.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.subheading.divider"> +<refmeta> +<refentrytitle>man.subheading.divider</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.subheading.divider</refname> +<refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.subheading.divider.frag"> +<xsl:param name="man.subheading.divider">========================================================================</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of the +<parameter>man.subheading.divider.enabled</parameter> parameter is +non-zero, the contents of the +<parameter>man.subheading.divider</parameter> parameter are used to +add a "divider" before and after subheadings in the roff +output. <emphasis role="bold">The divider is not visisble in the +rendered man page</emphasis>; it is added as a comment, in the source, +simply for the purpose of increasing reability of the source.</para> + +<para>If <parameter>man.subheading.divider.enabled</parameter> is zero +(the default), the subheading divider is suppressed.</para> + +</refsection> +</refentry> diff --git a/params/man.table.footnotes.divider.xml b/params/man.table.footnotes.divider.xml new file mode 100644 index 0000000..2ad4608 --- /dev/null +++ b/params/man.table.footnotes.divider.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.table.footnotes.divider"> +<refmeta> +<refentrytitle>man.table.footnotes.divider</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.table.footnotes.divider</refname> +<refpurpose>Specifies divider string that appears before table footnotes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.table.footnotes.divider.frag"> +<xsl:param name="man.table.footnotes.divider">----</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In each table that contains footenotes, the string specified by +the <parameter>man.table.footnotes.divider</parameter> parameter is +output before the list of footnotes for the table.</para> + +</refsection> +</refentry> diff --git a/params/man.th.extra1.suppress.xml b/params/man.th.extra1.suppress.xml new file mode 100644 index 0000000..c0241d2 --- /dev/null +++ b/params/man.th.extra1.suppress.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.extra1.suppress"> +<refmeta> +<refentrytitle>man.th.extra1.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.extra1.suppress</refname> +<refpurpose>Suppress extra1 part of header/footer?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.extra1.suppress.frag"> +<xsl:param name="man.th.extra1.suppress">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.th.extra1.suppress</parameter> is +non-zero, then the <literal>extra1</literal> part of the +<literal>.TH</literal> title line header/footer is suppressed.</para> + +<para>The content of the <literal>extra1</literal> field is almost +always displayed in the center footer of the page and is, universally, +a date.</para> + +</refsection> +</refentry> diff --git a/params/man.th.extra2.max.length.xml b/params/man.th.extra2.max.length.xml new file mode 100644 index 0000000..d3513ec --- /dev/null +++ b/params/man.th.extra2.max.length.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.extra2.max.length"> +<refmeta> +<refentrytitle>man.th.extra2.max.length</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.extra2.max.length</refname> +<refpurpose>Maximum length of extra2 in header/footer</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.extra2.max.length.frag"> +<xsl:param name="man.th.extra2.max.length">30</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the maximum permitted length of the +<literal>extra2</literal> part of the man-page part of the +<literal>.TH</literal> title line header/footer. If the +<literal>extra2</literal> content exceeds the maxiumum specified, it +is truncated down to the maximum permitted length.</para> + +<para>The content of the <literal>extra2</literal> field is usually +displayed in the left footer of the page and is typically "source" +data indicating the software system or product that the item +documented in the man page belongs to, often in the form +<replaceable>Name</replaceable> <replaceable>Version</replaceable>; +for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal> +man page).</para> + +<para>The default value for this parameter is reasonable but somewhat +arbitrary. If you are processing pages with long "source" information, +you may want to experiment with changing the value in order to achieve +the correct aesthetic results.</para> +</refsection> +</refentry> diff --git a/params/man.th.extra2.suppress.xml b/params/man.th.extra2.suppress.xml new file mode 100644 index 0000000..0fcd3ed --- /dev/null +++ b/params/man.th.extra2.suppress.xml @@ -0,0 +1,44 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.extra2.suppress"> +<refmeta> +<refentrytitle>man.th.extra2.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.extra2.suppress</refname> +<refpurpose>Suppress extra2 part of header/footer?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.extra2.suppress.frag"> +<xsl:param name="man.th.extra2.suppress">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.th.extra2.suppress</parameter> is +non-zero, then the <literal>extra2</literal> part of the +<literal>.TH</literal> title line header/footer is suppressed.</para> + +<para>The content of the <literal>extra2</literal> field is usually +displayed in the left footer of the page and is typically "source" +data, often in the form +<replaceable>Name</replaceable> <replaceable>Version</replaceable>; +for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal> +man page).</para> + +<note> + <para>You can use the + <parameter>refentry.source.name.suppress</parameter> and + <parameter>refentry.version.suppress</parameter> parameters to + independently suppress the <replaceable>Name</replaceable> and + <replaceable>Version</replaceable> parts of the + <literal>extra2</literal> field.</para> +</note> + +</refsection> +</refentry> diff --git a/params/man.th.extra3.max.length.xml b/params/man.th.extra3.max.length.xml new file mode 100644 index 0000000..77e55e4 --- /dev/null +++ b/params/man.th.extra3.max.length.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.extra3.max.length"> +<refmeta> +<refentrytitle>man.th.extra3.max.length</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.extra3.max.length</refname> +<refpurpose>Maximum length of extra3 in header/footer</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.extra3.max.length.frag"> +<xsl:param name="man.th.extra3.max.length">30</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the maximum permitted length of the +<literal>extra3</literal> part of the man-page <literal>.TH</literal> +title line header/footer. If the <literal>extra3</literal> content +exceeds the maxiumum specified, it is truncated down to the maximum +permitted length.</para> + +<para>The content of the <literal>extra3</literal> field is usually +displayed in the middle header of the page and is typically a "manual +name"; for example, "GTK+ User's Manual" (from the +<literal>gtk-options(7)</literal> man page).</para> + +<para>The default value for this parameter is reasonable but somewhat +arbitrary. If you are processing pages with long "manual names" -- or +especially if you are processing pages that have both long "title" +parts (command/function, etc. names) <emphasis>and</emphasis> long +manual names -- you may want to experiment with changing the value in +order to achieve the correct aesthetic results.</para> +</refsection> +</refentry> diff --git a/params/man.th.extra3.suppress.xml b/params/man.th.extra3.suppress.xml new file mode 100644 index 0000000..81d6c0d --- /dev/null +++ b/params/man.th.extra3.suppress.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.extra3.suppress"> +<refmeta> +<refentrytitle>man.th.extra3.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.extra3.suppress</refname> +<refpurpose>Suppress extra3 part of header/footer?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.extra3.suppress.frag"> +<xsl:param name="man.th.extra3.suppress">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>man.th.extra3.suppress</parameter> is +non-zero, then the <literal>extra3</literal> part of the +<literal>.TH</literal> title line header/footer is +suppressed.</para> + +<para>The content of the <literal>extra3</literal> field is usually +displayed in the middle header of the page and is typically a "manual +name"; for example, "GTK+ User's Manual" (from the +<literal>gtk-options(7)</literal> man page).</para> + +</refsection> +</refentry> diff --git a/params/man.th.title.max.length.xml b/params/man.th.title.max.length.xml new file mode 100644 index 0000000..7fdf0bf --- /dev/null +++ b/params/man.th.title.max.length.xml @@ -0,0 +1,63 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="man.th.title.max.length"> +<refmeta> +<refentrytitle>man.th.title.max.length</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>man.th.title.max.length</refname> +<refpurpose>Maximum length of title in header/footer</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="man.th.title.max.length.frag"> +<xsl:param name="man.th.title.max.length">20</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the maximum permitted length of the title part of the +man-page <literal>.TH</literal> title line header/footer. If the title +exceeds the maxiumum specified, it is truncated down to the maximum +permitted length.</para> + +<refsection><info><title>Details</title></info> + + +<para>Every man page generated using the DocBook stylesheets has a +title line, specified using the <literal>TH</literal> roff +macro. Within that title line, there is always, at a minimum, a title, +followed by a section value (representing a man "section" -- usually +just a number).</para> + +<para>The title and section are displayed, together, in the visible +header of each page. Where in the header they are displayed depends on +OS the man page is viewed on, and on what version of nroff/groff/man +is used for viewing the page. But, at a minimum and across all +systems, the title and section are displayed on the right-hand column +of the header. On many systems -- those with a modern groff, including +Linux systems -- they are displayed twice: both in the left and right +columns of the header.</para> + +<para>So if the length of the title exceeds a certain percentage of +the column width in which the page is viewed, the left and right +titles can end up overlapping, making them unreadable, or breaking to +another line, which doesn't look particularly good.</para> + +<para>So the stylesheets provide the +<parameter>man.th.title.max.length</parameter> parameter as a means +for truncating titles that exceed the maximum length that can be +viewing properly in a page header.</para> + +<para>The default value is reasonable but somewhat arbitrary. If you +have pages with long titles, you may want to experiment with changing +the value in order to achieve the correct aesthetic results.</para> +</refsection> + +</refsection> +</refentry> diff --git a/params/manifest.in.base.dir.xml b/params/manifest.in.base.dir.xml new file mode 100644 index 0000000..d002767 --- /dev/null +++ b/params/manifest.in.base.dir.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="manifest.in.base.dir"> +<refmeta> +<refentrytitle>manifest.in.base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manifest.in.base.dir</refname> +<refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="manifest.in.base.dir.frag"> +<xsl:param name="manifest.in.base.dir" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the manifest file as well as project files for HTML Help and +Eclipse Help are written into <parameter>base.dir</parameter> instead +of the current directory.</para> + +</refsection> +</refentry> diff --git a/params/manifest.xml b/params/manifest.xml new file mode 100644 index 0000000..96d092a --- /dev/null +++ b/params/manifest.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="manifest"> + <refmeta> + <refentrytitle>manifest</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>manifest</refname> + <refpurpose>Name of manifest file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment xml:id="manifest.frag"> + <xsl:param name="manifest" >HTML.manifest</xsl:param> + </src:fragment> + </refsynopsisdiv> + + <refsection><info><title>Description</title></info> + + <para>The name of the file to which a manifest is written (if the + value of the <parameter>generate.manifest</parameter> parameter + is non-zero).</para> + + </refsection> +</refentry> diff --git a/params/manual.toc.xml b/params/manual.toc.xml new file mode 100644 index 0000000..7a640c7 --- /dev/null +++ b/params/manual.toc.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="manual.toc"> +<refmeta> +<refentrytitle>manual.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manual.toc</refname> +<refpurpose>An explicit TOC to be used for the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="manual.toc.frag"> +<xsl:param name="manual.toc"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>manual.toc</parameter> identifies an explicit TOC that +will be used for building the printed TOC. +</para> + +</refsection> +</refentry> diff --git a/params/margin.note.float.type.xml b/params/margin.note.float.type.xml new file mode 100644 index 0000000..0b34230 --- /dev/null +++ b/params/margin.note.float.type.xml @@ -0,0 +1,77 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="margin.note.float.type"> +<refmeta> +<refentrytitle>margin.note.float.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">before</refmiscinfo> +<refmiscinfo class="other" otherclass="value">left</refmiscinfo> +<refmiscinfo class="other" otherclass="value">start</refmiscinfo> +<refmiscinfo class="other" otherclass="value">right</refmiscinfo> +<refmiscinfo class="other" otherclass="value">end</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inside</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outside</refmiscinfo> +</refmeta> +<refnamediv> +<refname>margin.note.float.type</refname> +<refpurpose>Select type of float for margin note customizations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="margin.note.float.type.frag"> +<xsl:param name="margin.note.float.type">none</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the type of float for margin notes. +DocBook does not define a margin note element, so this +feature must be implemented as a customization of the stylesheet. +See <parameter>margin.note.properties</parameter> for +an example. +</para> +<itemizedlist> +<listitem> +<para>If <parameter>margin.note.float.type</parameter> is +<quote><literal>none</literal></quote>, then +no float is used. +</para> +</listitem> +<listitem> +<para>If <parameter>margin.note.float.type</parameter> is +<quote><literal>before</literal></quote>, then +the float appears at the top of the page. On some processors, +that may be the next page rather than the current page. +</para> +</listitem> +<listitem> +<para>If <parameter>margin.note.float.type</parameter> is +<quote><literal>left</literal></quote> or +<quote><literal>start</literal></quote>, then +a left side float is used. +</para> +</listitem> +<listitem> +<para>If <parameter>margin.note.float.type</parameter> is +<quote><literal>right</literal></quote> or +<quote><literal>end</literal></quote>, then +a right side float is used. +</para> +</listitem> +<listitem> +<para>If your XSL-FO processor supports floats positioned on the +<quote><literal>inside</literal></quote> or +<quote><literal>outside</literal></quote> +of double-sided pages, then you have those two +options for side floats as well. +</para> +</listitem> +</itemizedlist> + +</refsection> +</refentry> diff --git a/params/margin.note.properties.xml b/params/margin.note.properties.xml new file mode 100644 index 0000000..02dc20e --- /dev/null +++ b/params/margin.note.properties.xml @@ -0,0 +1,54 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="margin.note.properties"> +<refmeta> +<refentrytitle>margin.note.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>margin.note.properties</refname> +<refpurpose>Attribute set for margin.note properties</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="margin.note.properties.frag"> +<xsl:attribute-set name="margin.note.properties"> + <xsl:attribute name="font-size">90%</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for margin notes. +By default, margin notes are not implemented for any +element. A stylesheet customization is needed to make +use of this attribute-set.</para> + +<para>You can use a template named <quote>floater</quote> +to create the customization. +That template can create side floats by specifying the +content and characteristics as template parameters. +</para> + +<para>For example:</para> +<programlisting><xsl:template match="para[@role='marginnote']"> + <xsl:call-template name="floater"> + <xsl:with-param name="position"> + <xsl:value-of select="$margin.note.float.type"/> + </xsl:with-param> + <xsl:with-param name="width"> + <xsl:value-of select="$margin.note.width"/> + </xsl:with-param> + <xsl:with-param name="content"> + <xsl:apply-imports/> + </xsl:with-param> + </xsl:call-template> +</xsl:template></programlisting> + +</refsection> +</refentry> diff --git a/params/margin.note.title.properties.xml b/params/margin.note.title.properties.xml new file mode 100644 index 0000000..84399bb --- /dev/null +++ b/params/margin.note.title.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="margin.note.title.properties"> +<refmeta> +<refentrytitle>margin.note.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>margin.note.title.properties</refname> +<refpurpose>Attribute set for margin note titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="margin.note.title.properties.frag"> +<xsl:attribute-set name="margin.note.title.properties"> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for margin note titles.</para> + +</refsection> +</refentry> diff --git a/params/margin.note.width.xml b/params/margin.note.width.xml new file mode 100644 index 0000000..3ee0aa4 --- /dev/null +++ b/params/margin.note.width.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="margin.note.width"> +<refmeta> +<refentrytitle>margin.note.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>margin.note.width</refname> +<refpurpose>Set the default width for margin notes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="margin.note.width.frag"> +<xsl:param name="margin.note.width" >1in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the default width for margin notes when used as a side +float. The width determines the degree to which the margin note block +intrudes into the text area. +</para> +<para>If <parameter>margin.note.float.type</parameter> is +<quote><literal>before</literal></quote> or +<quote><literal>none</literal></quote>, then +this parameter is ignored. +</para> + +</refsection> +</refentry> diff --git a/params/marker.section.level.xml b/params/marker.section.level.xml new file mode 100644 index 0000000..70bd4fd --- /dev/null +++ b/params/marker.section.level.xml @@ -0,0 +1,50 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="marker.section.level"> +<refmeta> +<refentrytitle>marker.section.level</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>marker.section.level</refname> +<refpurpose>Control depth of sections shown in running headers or footers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="marker.section.level.frag"> +<xsl:param name="marker.section.level" >2</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>marker.section.level</parameter> parameter +controls the depth of section levels that may be displayed +in running headers and footers. For example, if the value +is 2 (the default), then titles from <tag>sect1</tag> and +<tag>sect2</tag> or equivalent <tag>section</tag> +elements are candidates for use in running headers and +footers. +</para> +<para>Each candidate title is marked in the FO output with a +<tag><fo:marker marker-class-name="section.head.marker"></tag> +element. +</para> +<para>In order for such titles to appear in headers +or footers, the <literal>header.content</literal> +or <literal>footer.content</literal> template +must be customized to retrieve the marker using +an output element such as: +</para> +<programlisting> +<fo:retrieve-marker retrieve-class-name="section.head.marker" + retrieve-position="first-including-carryover" + retrieve-boundary="page-sequence"/> +</programlisting> + + +</refsection> +</refentry> diff --git a/params/menuchoice.menu.separator.xml b/params/menuchoice.menu.separator.xml new file mode 100644 index 0000000..cf142e2 --- /dev/null +++ b/params/menuchoice.menu.separator.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="menuchoice.menu.separator"> +<refmeta> +<refentrytitle>menuchoice.menu.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.menu.separator</refname> +<refpurpose>Separator between items of a <tag>menuchoice</tag> +with <tag>guimenuitem</tag> or +<tag>guisubmenu</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="menuchoice.menu.separator.frag"> +<xsl:param name="menuchoice.menu.separator"> → </xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator used to connect items of a <tag>menuchoice</tag> with +<tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements +are linked with <parameter>menuchoice.separator</parameter>. +</para> +<para>The default value is &#x2192;, which is the +&rarr; (right arrow) character entity. +The current FOP (0.20.5) requires setting the font-family +explicitly. +</para> +<para>The default value also includes spaces around the arrow, +which will allow a line to break. Replace the spaces with +&#xA0; (nonbreaking space) if you don't want those +spaces to break. +</para> + +</refsection> +</refentry> diff --git a/params/menuchoice.separator.xml b/params/menuchoice.separator.xml new file mode 100644 index 0000000..3034f25 --- /dev/null +++ b/params/menuchoice.separator.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="menuchoice.separator"> +<refmeta> +<refentrytitle>menuchoice.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.separator</refname> +<refpurpose>Separator between items of a <tag>menuchoice</tag> +other than <tag>guimenuitem</tag> and +<tag>guisubmenu</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="menuchoice.separator.frag"> +<xsl:param name="menuchoice.separator">+</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator used to connect items of a <tag>menuchoice</tag> other +than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter +elements are linked with <parameter>menuchoice.menu.separator</parameter>. +</para> + +</refsection> +</refentry> diff --git a/params/minus.image.xml b/params/minus.image.xml new file mode 100644 index 0000000..ea86e23 --- /dev/null +++ b/params/minus.image.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="minus.image"> +<refmeta> +<refentrytitle>minus.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>minus.image</refname> +<refpurpose>Minus image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="minus.image.frag"> +<xsl:param name="minus.image">toc/open.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the <quote>minus</quote> image; the image used in a +<link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section +can be collapsed.</para> + +</refsection> +</refentry> diff --git a/params/monospace.font.family.xml b/params/monospace.font.family.xml new file mode 100644 index 0000000..7e772e9 --- /dev/null +++ b/params/monospace.font.family.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="monospace.font.family"> +<refmeta> +<refentrytitle>monospace.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>monospace.font.family</refname> +<refpurpose>The default font family for monospace environments</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="monospace.font.family.frag"> +<xsl:param name="monospace.font.family">monospace</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The monospace font family is used for verbatim environments +(program listings, screens, etc.). +</para> +<para>If more than one font is required, enter the font names, +separated by a comma, e.g.</para> +<literallayout> + <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param> + +</literallayout> +</refsection> +</refentry> diff --git a/params/monospace.properties.xml b/params/monospace.properties.xml new file mode 100644 index 0000000..0a8425b --- /dev/null +++ b/params/monospace.properties.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="monospace.properties"> +<refmeta> +<refentrytitle>monospace.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>monospace.properties</refname> +<refpurpose>Properties of monospaced content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="monospace.properties.frag"> +<xsl:attribute-set name="monospace.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$monospace.font.family"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the font name for monospaced output. This property set +used to set the font-size as well, but that doesn't work very well +when different fonts are used (as they are in titles and paragraphs, +for example).</para> + +<para>If you want to set the font-size in a customization layer, it's +probably going to be more appropriate to set font-size-adjust, if your +formatter supports it.</para> + +</refsection> +</refentry> diff --git a/params/monospace.verbatim.font.width.xml b/params/monospace.verbatim.font.width.xml new file mode 100644 index 0000000..88b88dc --- /dev/null +++ b/params/monospace.verbatim.font.width.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="monospace.verbatim.font.width"> +<refmeta> +<refentrytitle>monospace.verbatim.font.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>monospace.verbatim.font.width</refname> +<refpurpose>Width of a single monospace font character</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="monospace.verbatim.font.width.frag"> +<xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies with em units the width of a single character +of the monospace font. The default value is <literal>0.6em</literal>.</para> + +<para>This parameter is only used when a <tag>screen</tag> +or <tag>programlisting</tag> element has a +<tag class="attribute">width</tag> attribute, which is +expressed as a plain integer to indicate the maximum character count +of each line. +To convert this character count to an actual maximum width +measurement, the width of the font characters must be provided. +Different monospace fonts have different character width, +so this parameter should be adjusted to fit the +monospace font being used. +</para> + +</refsection> +</refentry> diff --git a/params/monospace.verbatim.properties.xml b/params/monospace.verbatim.properties.xml new file mode 100644 index 0000000..3d7ca3d --- /dev/null +++ b/params/monospace.verbatim.properties.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="monospace.verbatim.properties"> +<refmeta> +<refentrytitle>monospace.verbatim.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>monospace.verbatim.properties</refname> +<refpurpose>What font and size do you want for monospaced content?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="monospace.verbatim.properties.frag"> +<xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties"> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="wrap-option">no-wrap</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify the font name and size you want for monospaced output</para> +</refsection> +</refentry> diff --git a/params/multiframe.bottom.bgcolor.xml b/params/multiframe.bottom.bgcolor.xml new file mode 100644 index 0000000..f0667d7 --- /dev/null +++ b/params/multiframe.bottom.bgcolor.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="multiframe.bottom.bgcolor"> +<refmeta> +<refentrytitle>multiframe.bottom.bgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>multiframe.bottom.bgcolor</refname> +<refpurpose>Background color for bottom navigation frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="multiframe.bottom.bgcolor.frag"> +<xsl:param name="multiframe.bottom.bgcolor">white</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the background color of the bottom navigation frame when +<link linkend="multiframe">multiframe</link> is enabled.</para> + +</refsection> +</refentry> diff --git a/params/multiframe.navigation.height.xml b/params/multiframe.navigation.height.xml new file mode 100644 index 0000000..06dbc1c --- /dev/null +++ b/params/multiframe.navigation.height.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="multiframe.navigation.height"> +<refmeta> +<refentrytitle>multiframe.navigation.height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>multiframe.navigation.height</refname> +<refpurpose>Height of navigation frames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="multiframe.navigation.height.frag"> +<xsl:param name="multiframe.navigation.height">40</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the height of the navigation frames in pixels when +<link linkend="multiframe">multiframe</link> is enabled.</para> + +</refsection> +</refentry> diff --git a/params/multiframe.top.bgcolor.xml b/params/multiframe.top.bgcolor.xml new file mode 100644 index 0000000..4814fc8 --- /dev/null +++ b/params/multiframe.top.bgcolor.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="multiframe.top.bgcolor"> +<refmeta> +<refentrytitle>multiframe.top.bgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>multiframe.top.bgcolor</refname> +<refpurpose>Background color for top navigation frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="multiframe.top.bgcolor.frag"> +<xsl:param name="multiframe.top.bgcolor" >white</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the background color of the top navigation frame when +<link linkend="multiframe">multiframe</link> is enabled.</para> + +</refsection> +</refentry> diff --git a/params/multiframe.xml b/params/multiframe.xml new file mode 100644 index 0000000..b4fbf37 --- /dev/null +++ b/params/multiframe.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="multiframe"> +<refmeta> +<refentrytitle>multiframe</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>multiframe</refname> +<refpurpose>Use multiple frames for slide bodies?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="multiframe.frag"> +<xsl:param name="multiframe" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, multiple frames are used for the body of each +slide. This is one way of forcing the slide navigation elements to +appear in constant locations. The other way is with <link linkend="overlay">overlays</link>. The <link linkend="overlay"><parameter>overlay</parameter></link> and +<parameter>multiframe</parameter> parameters are mutually +exclusive.</para> + +</refsection> +</refentry> diff --git a/params/nav.separator.xml b/params/nav.separator.xml new file mode 100644 index 0000000..e3695f9 --- /dev/null +++ b/params/nav.separator.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nav.separator"> +<refmeta> +<refentrytitle>nav.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nav.separator</refname> +<refpurpose>Output separator between navigation and body?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nav.separator.frag"> +<xsl:param name="nav.separator" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a separator (<literal><HR></literal>) is +added between the navigation links and the content of each slide.</para> + +</refsection> +</refentry> diff --git a/params/nav.table.summary.xml b/params/nav.table.summary.xml new file mode 100644 index 0000000..1c1559b --- /dev/null +++ b/params/nav.table.summary.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nav.table.summary"> +<refmeta> +<refentrytitle>nav.table.summary</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nav.table.summary</refname> +<refpurpose>HTML Table summary attribute value for navigation tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nav.table.summary.frag"> +<xsl:param name="nav.table.summary">Navigation</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The value of this parameter is used as the value of the table +summary attribute for the navigation table.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/navbgcolor.xml b/params/navbgcolor.xml new file mode 100644 index 0000000..c6fcece --- /dev/null +++ b/params/navbgcolor.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navbgcolor"> +<refmeta> +<refentrytitle>navbgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navbgcolor</refname> +<refpurpose>The background color of the navigation TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navbgcolor.frag"> +<xsl:param name="navbgcolor">#4080FF</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The background color of the navigation TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/navbodywidth.xml b/params/navbodywidth.xml new file mode 100644 index 0000000..b93cf82 --- /dev/null +++ b/params/navbodywidth.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navbodywidth"> +<refmeta> +<refentrytitle>navbodywidth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navbodywidth</refname> +<refpurpose>Specifies the width of the navigation table body</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navbodywidth.frag"> +<xsl:param name="navbodywidth"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The width of the body column.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/navig.graphics.extension.xml b/params/navig.graphics.extension.xml new file mode 100644 index 0000000..416e0c4 --- /dev/null +++ b/params/navig.graphics.extension.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navig.graphics.extension"> +<refmeta> +<refentrytitle>navig.graphics.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.extension</refname> +<refpurpose>Extension for navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navig.graphics.extension.frag"> +<xsl:param name="navig.graphics.extension">.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename extension to use on navigational graphics used +in the headers and footers of chunked HTML.</para> + +</refsection> +</refentry> diff --git a/params/navig.graphics.path.xml b/params/navig.graphics.path.xml new file mode 100644 index 0000000..373208e --- /dev/null +++ b/params/navig.graphics.path.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navig.graphics.path"> +<refmeta> +<refentrytitle>navig.graphics.path</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.path</refname> +<refpurpose>Path to navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navig.graphics.path.frag"> +<xsl:param name="navig.graphics.path">images/</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the path, probably relative to the directory where the HTML +files are created, to the navigational graphics used in the +headers and footers of chunked HTML. +</para> + +</refsection> +</refentry> diff --git a/params/navig.graphics.xml b/params/navig.graphics.xml new file mode 100644 index 0000000..03e28b6 --- /dev/null +++ b/params/navig.graphics.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navig.graphics"> +<refmeta> +<refentrytitle>navig.graphics</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics</refname> +<refpurpose>Use graphics in navigational headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navig.graphics.frag"> +<xsl:param name="navig.graphics" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the navigational headers and footers in chunked +HTML are presented in an alternate style that uses graphical icons for +Next, Previous, Up, and Home. Default graphics are provided in the +distribution. If zero, text is used instead of graphics. +</para> + +</refsection> +</refentry> diff --git a/params/navig.showtitles.xml b/params/navig.showtitles.xml new file mode 100644 index 0000000..a4eb3ff --- /dev/null +++ b/params/navig.showtitles.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navig.showtitles"> +<refmeta> +<refentrytitle>navig.showtitles</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.showtitles</refname> +<refpurpose>Display titles in HTML headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navig.showtitles.frag"><xsl:param name="navig.showtitles">1</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +the headers and footers of chunked HTML +display the titles of the next and previous chunks, +along with the words 'Next' and 'Previous' (or the +equivalent graphical icons if navig.graphics is true). +If false (zero), then only the words 'Next' and 'Previous' +(or the icons) are displayed. +</para> + +</refsection> +</refentry> diff --git a/params/navtocwidth.xml b/params/navtocwidth.xml new file mode 100644 index 0000000..0d21ae0 --- /dev/null +++ b/params/navtocwidth.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="navtocwidth"> +<refmeta> +<refentrytitle>navtocwidth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navtocwidth</refname> +<refpurpose>Specifies the width of the navigation table TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="navtocwidth.frag"> +<xsl:param name="navtocwidth">220</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The width, in pixels, of the navigation column.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/next.image.xml b/params/next.image.xml new file mode 100644 index 0000000..4dbd60a --- /dev/null +++ b/params/next.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="next.image"> +<refmeta> +<refentrytitle>next.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>next.image</refname> +<refpurpose>Right-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="next.image.frag"> +<xsl:param name="next.image" >active/nav-next.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the right-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/no.home.image.xml b/params/no.home.image.xml new file mode 100644 index 0000000..2f4ecd8 --- /dev/null +++ b/params/no.home.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="no.home.image"> +<refmeta> +<refentrytitle>no.home.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>no.home.image</refname> +<refpurpose>Inactive home image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="no.home.image.frag"> +<xsl:param name="no.home.image">inactive/nav-home.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the inactive home navigation icon.</para> + +</refsection> +</refentry> diff --git a/params/no.next.image.xml b/params/no.next.image.xml new file mode 100644 index 0000000..966fe26 --- /dev/null +++ b/params/no.next.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="no.next.image"> +<refmeta> +<refentrytitle>no.next.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>no.next.image</refname> +<refpurpose>Inactive right-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="no.next.image.frag"> +<xsl:param name="no.next.image">inactive/nav-next.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the inactive right-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/no.prev.image.xml b/params/no.prev.image.xml new file mode 100644 index 0000000..7632231 --- /dev/null +++ b/params/no.prev.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="no.prev.image"> +<refmeta> +<refentrytitle>no.prev.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>no.prev.image</refname> +<refpurpose>Inactive left-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="no.prev.image.frag"> +<xsl:param name="no.prev.image" >inactive/nav-prev.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the inactive left-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/no.toc.image.xml b/params/no.toc.image.xml new file mode 100644 index 0000000..43e9eea --- /dev/null +++ b/params/no.toc.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="no.toc.image"> +<refmeta> +<refentrytitle>no.toc.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>no.toc.image</refname> +<refpurpose>Inactive ToC image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="no.toc.image.frag"> +<xsl:param name="no.toc.image">inactive/nav-toc.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the inactive ToC navigation icon.</para> + +</refsection> +</refentry> diff --git a/params/no.up.image.xml b/params/no.up.image.xml new file mode 100644 index 0000000..a19a34d --- /dev/null +++ b/params/no.up.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="no.up.image"> +<refmeta> +<refentrytitle>no.up.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>no.up.image</refname> +<refpurpose>Inactive up-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="no.up.image.frag"> +<xsl:param name="no.up.image" >inactive/nav-up.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the inactive upward-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/nominal.image.depth.xml b/params/nominal.image.depth.xml new file mode 100644 index 0000000..a4e615f --- /dev/null +++ b/params/nominal.image.depth.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nominal.image.depth"> +<refmeta> +<refentrytitle>nominal.image.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.depth</refname> +<refpurpose>Nominal image depth</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nominal.image.depth.frag"> +<xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>See <parameter>nominal.image.width</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/nominal.image.width.xml b/params/nominal.image.width.xml new file mode 100644 index 0000000..bfa989a --- /dev/null +++ b/params/nominal.image.width.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nominal.image.width"> +<refmeta> +<refentrytitle>nominal.image.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.width</refname> +<refpurpose>The nominal image width</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nominal.image.width.frag"> +<xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Graphic widths expressed as a percentage are problematic. In the +following discussion, we speak of width and contentwidth, but +the same issues apply to depth and contentdepth.</para> + +<para>A width of 50% means "half of the available space for the image." +That's fine. But note that in HTML, this is a dynamic property and +the image size will vary if the browser window is resized.</para> + +<para>A contentwidth of 50% means "half of the actual image width". +But what does that mean if the stylesheets cannot assess the image's +actual size? Treating this as a width of 50% is one possibility, but +it produces behavior (dynamic scaling) that seems entirely out of +character with the meaning.</para> + +<para>Instead, the stylesheets define a +<parameter>nominal.image.width</parameter> and convert percentages to +actual values based on that nominal size.</para> + +</refsection> +</refentry> diff --git a/params/nominal.table.width.xml b/params/nominal.table.width.xml new file mode 100644 index 0000000..f5dcfb9 --- /dev/null +++ b/params/nominal.table.width.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nominal.table.width"> +<refmeta> +<refentrytitle>nominal.table.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.table.width</refname> +<refpurpose>The (absolute) nominal width of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nominal.table.width.frag"> +<xsl:param name="nominal.table.width">6in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In order to convert CALS column widths into HTML column widths, it +is sometimes necessary to have an absolute table width to use for conversion +of mixed absolute and relative widths. This value must be an absolute +length (not a percentage).</para> + +</refsection> +</refentry> diff --git a/params/nongraphical.admonition.properties.xml b/params/nongraphical.admonition.properties.xml new file mode 100644 index 0000000..ba8a06a --- /dev/null +++ b/params/nongraphical.admonition.properties.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="nongraphical.admonition.properties"> +<refmeta> +<refentrytitle>nongraphical.admonition.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nongraphical.admonition.properties</refname> +<refpurpose>To add properties to the outer block of a nongraphical admonition.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="nongraphical.admonition.properties.frag"><xsl:attribute-set name="nongraphical.admonition.properties"> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.start}">0.25in</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.end}">0.25in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the outer block containing the +entire nongraphical admonition, including its title. +It is used when the parameter +<parameter>admon.graphics</parameter> is set to zero. +Use this attribute-set to set the space above and below, +and any indent for the whole admonition.</para> + +<para>In addition to these properties, a nongraphical admonition +also applies the <parameter>admonition.title.properties</parameter> +attribute-set to the title, and the +<parameter>admonition.properties</parameter> attribute-set +to the rest of the content.</para> + +</refsection> +</refentry> diff --git a/params/normal.para.spacing.xml b/params/normal.para.spacing.xml new file mode 100644 index 0000000..9ad7488 --- /dev/null +++ b/params/normal.para.spacing.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="normal.para.spacing"> +<refmeta> +<refentrytitle>normal.para.spacing</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>normal.para.spacing</refname> +<refpurpose>What space do you want between normal paragraphs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="normal.para.spacing.frag"><xsl:attribute-set name="normal.para.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify the spacing required between normal paragraphs as well as +the following block-level elements: +</para> +<literallayout>ackno +acknowledgements +cmdsynopsis +glosslist +sidebar +simpara +simplelist +</literallayout> +<para>To customize the spacing, you need to reset all three attributes.</para> + +<para>To specify properties on just <tag>para</tag> elements without +affecting these other elements, +use the +<link linkend="para.properties">para.properties</link> +attribute-set. </para> +</refsection> +</refentry> diff --git a/params/olink.base.uri.xml b/params/olink.base.uri.xml new file mode 100644 index 0000000..d88dd62 --- /dev/null +++ b/params/olink.base.uri.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.base.uri"> +<refmeta> +<refentrytitle>olink.base.uri</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.base.uri</refname> +<refpurpose>Base URI used in olink hrefs</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="olink.base.uri.frag"> +<xsl:param name="olink.base.uri"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>When cross reference data is collected for resolving olinks, it +may be necessary to prepend a base URI to each target's href. This +parameter lets you set that base URI when cross reference data is +collected. This feature is needed when you want to link to a document +that is processed without chunking. The output filename for such a +document is not known to the XSL stylesheet; the only target +information consists of fragment identifiers such as +<literal>#idref</literal>. To enable the resolution of olinks between +documents, you should pass the name of the HTML output file as the +value of this parameter. Then the hrefs recorded in the cross +reference data collection look like +<literal>outfile.html#idref</literal>, which can be reached as links +from other documents.</para> +</refsection> +</refentry> diff --git a/params/olink.debug.xml b/params/olink.debug.xml new file mode 100644 index 0000000..e49a176 --- /dev/null +++ b/params/olink.debug.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.debug"> +<refmeta> +<refentrytitle>olink.debug</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.debug</refname> +<refpurpose>Turn on debugging messages for olinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="olink.debug.frag"> +<xsl:param name="olink.debug" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then each olink will generate several +messages about how it is being resolved during processing. +This is useful when an olink does not resolve properly +and the standard error messages are not sufficient to +find the problem. +</para> + +<para>You may need to read through the olink XSL templates +to understand the context for some of the debug messages. +</para> + +</refsection> +</refentry> diff --git a/params/olink.doctitle.xml b/params/olink.doctitle.xml new file mode 100644 index 0000000..356347d --- /dev/null +++ b/params/olink.doctitle.xml @@ -0,0 +1,146 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.doctitle"> +<refmeta> +<refentrytitle>olink.doctitle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +<refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.doctitle</refname> +<refpurpose>show the document title for external olinks?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="olink.doctitle.frag"> +<xsl:param name="olink.doctitle">no</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>When olinks between documents are resolved, the generated text +may not make it clear that the reference is to another document. +It is possible for the stylesheets to append the other document's +title to external olinks. For this to happen, two parameters must +be set.</para> +<itemizedlist> +<listitem> +<para>This <parameter>olink.doctitle</parameter> parameter +should be set to either <literal>yes</literal> or <literal>maybe</literal> +to enable this feature. +</para> +</listitem> +<listitem> +<para>And you should also set the <parameter>current.docid</parameter> +parameter to the document id for the document currently +being processed for output. +</para> +</listitem> +</itemizedlist> + +<para> +Then if an olink's <literal>targetdoc</literal> id differs from +the <literal>current.docid</literal> value, the stylesheet knows +that it is a reference to another document and can +append the target document's +title to the generated olink text. </para> + +<para>The text for the target document's title is copied from the +olink database from the <tag>ttl</tag> element +of the top-level <tag>div</tag> for that document. +If that <tag>ttl</tag> element is missing or empty, +no title is output. +</para> + +<para>The supported values for <parameter>olink.doctitle</parameter> are: +</para> +<variablelist> +<varlistentry> +<term><literal>yes</literal></term> +<listitem> +<para> +Always insert the title to the target document if it is not +the current document. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>no</literal></term> +<listitem> +<para> +Never insert the title to the target document, even if requested +in an <tag class="attribute">xrefstyle</tag> attribute. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>maybe</literal></term> +<listitem> +<para> +Only insert the title to the target document, if requested +in an <tag class="attribute">xrefstyle</tag> attribute. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>An <tag class="attribute">xrefstyle</tag> attribute +may override the global setting for individual olinks. +The following values are supported in an +<tag class="attribute">xrefstyle</tag> +attribute using the <literal>select:</literal> syntax: +</para> + +<variablelist> +<varlistentry> +<term><literal>docname</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docname</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>docnamelong</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docnamelong</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>nodocname</literal></term> +<listitem> +<para> +Omit the target document name even if +the value of <parameter>olink.doctitle</parameter> +is <literal>yes</literal>. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>Another way of inserting the target document name +for a single olink is to employ an +<tag class="attribute">xrefstyle</tag> +attribute using the <literal>template:</literal> syntax. +The <literal>%o</literal> placeholder (the letter o, not zero) +in such a template +will be filled in with the target document's title when it is processed. +This will occur regardless of +the value of <parameter>olink.doctitle</parameter>. +</para> +<para>Note that prior to version 1.66 of the XSL stylesheets, +the allowed values for this parameter were 0 and 1. Those +values are still supported and mapped to 'no' and 'yes', respectively. +</para> +</refsection> +</refentry> diff --git a/params/olink.fragid.xml b/params/olink.fragid.xml new file mode 100644 index 0000000..3258038 --- /dev/null +++ b/params/olink.fragid.xml @@ -0,0 +1,23 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.fragid"> +<refmeta> +<refentrytitle>olink.fragid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.fragid</refname> +<refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="olink.fragid.frag"> +<xsl:param name="olink.fragid">fragid=</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>The fragment identifier portion of an <tag>olink</tag> target.</para> +</refsection> +</refentry> diff --git a/params/olink.lang.fallback.sequence.xml b/params/olink.lang.fallback.sequence.xml new file mode 100644 index 0000000..7d3d811 --- /dev/null +++ b/params/olink.lang.fallback.sequence.xml @@ -0,0 +1,83 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.lang.fallback.sequence"> +<refmeta> +<refentrytitle>olink.lang.fallback.sequence</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.lang.fallback.sequence</refname> +<refpurpose>look up translated documents if olink not found?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="olink.lang.fallback.sequence.frag"> +<xsl:param name="olink.lang.fallback.sequence"></xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + + +<para>This parameter defines a list of lang values +to search among to resolve olinks. +</para> + +<para>Normally an olink tries to resolve to a document in the same +language as the olink itself. The language of an olink +is determined by its nearest ancestor element with a +<tag class="attribute">lang</tag> attribute, otherwise the +value of the <parameter>l10n.gentext.default.lang</parameter> +parameter. +</para> + +<para>An olink database can contain target data for the same +document in multiple languages. Each set of data has the +same value for the <tag>targetdoc</tag> attribute in +the <tag>document</tag> element in the database, but with a +different <tag>lang</tag> attribute value. +</para> + +<para>When an olink is being resolved, the target is first +sought in the document with the same language as the olink. +If no match is found there, then this parameter is consulted +for additional languages to try.</para> + +<para>The <parameter>olink.lang.fallback.sequence</parameter> +must be a whitespace separated list of lang values to +try. The first one with a match in the olink database is used. +The default value is empty.</para> + +<para>For example, a document might be written in German +and contain an olink with +<literal>targetdoc="adminguide"</literal>. +When the document is processed, the processor +first looks for a target dataset in the +olink database starting with:</para> + +<literallayout><literal><document targetdoc="adminguide" lang="de"></literal>. +</literallayout> + +<para>If there is no such element, then the +<parameter>olink.lang.fallback.sequence</parameter> +parameter is consulted. +If its value is, for example, <quote>fr en</quote>, then the processor next +looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and +then for <literal>targetdoc="adminguide" lang="en"</literal>. +If there is still no match, it looks for +<literal>targetdoc="adminguide"</literal> with no +lang attribute. +</para> + +<para>This parameter is useful when a set of documents is only +partially translated, or is in the process of being translated. +If a target of an olink has not yet been translated, then this +parameter permits the processor to look for the document in +other languages. This assumes the reader would rather have +a link to a document in a different language than to have +a broken link. +</para> + +</refsection> +</refentry> diff --git a/params/olink.outline.ext.xml b/params/olink.outline.ext.xml new file mode 100644 index 0000000..2de2fe2 --- /dev/null +++ b/params/olink.outline.ext.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.outline.ext"> +<refmeta> +<refentrytitle>olink.outline.ext</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.outline.ext</refname> +<refpurpose>The extension of OLink outline files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="olink.outline.ext.frag"> +<xsl:param name="olink.outline.ext">.olink</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The extension to be expected for OLink outline files</para> +<para>Bob has this parameter as dead. Please don't use</para> + +</refsection> +</refentry> diff --git a/params/olink.properties.xml b/params/olink.properties.xml new file mode 100644 index 0000000..b76657e --- /dev/null +++ b/params/olink.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.properties"> +<refmeta> +<refentrytitle>olink.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.properties</refname> +<refpurpose>Properties associated with the cross-reference +text of an olink.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="olink.properties.frag"> +<xsl:attribute-set name="olink.properties"> + <xsl:attribute name="show-destination">replace</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This <literal>attribute set</literal> is applied to the +<literal>fo:basic-link</literal> element of an olink. It is not applied to the +optional page number or optional title of the external +document.</para> + +</refsection> +</refentry> diff --git a/params/olink.pubid.xml b/params/olink.pubid.xml new file mode 100644 index 0000000..4f0b50c --- /dev/null +++ b/params/olink.pubid.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.pubid"> +<refmeta> +<refentrytitle>olink.pubid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.pubid</refname> +<refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="olink.pubid.frag"> +<xsl:param name="olink.pubid">pubid</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para></para> + +</refsection> +</refentry> diff --git a/params/olink.resolver.xml b/params/olink.resolver.xml new file mode 100644 index 0000000..fa7d471 --- /dev/null +++ b/params/olink.resolver.xml @@ -0,0 +1,23 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.resolver"> +<refmeta> +<refentrytitle>olink.resolver</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.resolver</refname> +<refpurpose>The root name of the OLink resolver (usually a script)</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="olink.resolver.frag"> + <xsl:param name="olink.resolver" >/cgi-bin/olink</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>FIXME:</para> +</refsection> +</refentry> diff --git a/params/olink.sysid.xml b/params/olink.sysid.xml new file mode 100644 index 0000000..6d4542f --- /dev/null +++ b/params/olink.sysid.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="olink.sysid"> +<refmeta> +<refentrytitle>olink.sysid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.sysid</refname> +<refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="olink.sysid.frag"> +<xsl:param name="olink.sysid">sysid</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME</para> + +</refsection> +</refentry> diff --git a/params/orderedlist.label.properties.xml b/params/orderedlist.label.properties.xml new file mode 100644 index 0000000..39b0432 --- /dev/null +++ b/params/orderedlist.label.properties.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="orderedlist.label.properties"> +<refmeta> +<refentrytitle>orderedlist.label.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>orderedlist.label.properties</refname> +<refpurpose>Properties that apply to each label inside ordered list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="orderedlist.label.properties.frag"><xsl:attribute-set name="orderedlist.label.properties"> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to each label inside ordered list. E.g.:</para> +<programlisting><xsl:attribute-set name="orderedlist.label.properties"> + <xsl:attribute name="text-align">right</xsl:attribute> +</xsl:attribute-set></programlisting> +</refsection> +</refentry> diff --git a/params/orderedlist.label.width.xml b/params/orderedlist.label.width.xml new file mode 100644 index 0000000..18c8fa8 --- /dev/null +++ b/params/orderedlist.label.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="orderedlist.label.width"> +<refmeta> +<refentrytitle>orderedlist.label.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>orderedlist.label.width</refname> +<refpurpose>The default width of the label (number) in an ordered list.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="orderedlist.label.width.frag"> +<xsl:param name="orderedlist.label.width">1.2em</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Specifies the default width of the label (usually a number or +sequence of numbers) in an ordered list. You can override the default +value on any particular list with the “dbfo” processing instruction +using the “label-width” pseudoattribute.</para> +</refsection> +</refentry> diff --git a/params/orderedlist.properties.xml b/params/orderedlist.properties.xml new file mode 100644 index 0000000..59061cb --- /dev/null +++ b/params/orderedlist.properties.xml @@ -0,0 +1,24 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="orderedlist.properties"> +<refmeta> +<refentrytitle>orderedlist.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>orderedlist.properties</refname> +<refpurpose>Properties that apply to each list-block generated by orderedlist.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="orderedlist.properties.frag"><xsl:attribute-set name="orderedlist.properties" use-attribute-sets="list.block.properties"> + <xsl:attribute name="provisional-distance-between-starts">2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Properties that apply to each fo:list-block generated by orderedlist.</para> +</refsection> +</refentry> diff --git a/params/othercredit.like.author.enabled.xml b/params/othercredit.like.author.enabled.xml new file mode 100644 index 0000000..2e789dd --- /dev/null +++ b/params/othercredit.like.author.enabled.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="othercredit.like.author.enabled"> +<refmeta> +<refentrytitle>othercredit.like.author.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>othercredit.like.author.enabled</refname> +<refpurpose>Display othercredit in same style as author?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="othercredit.like.author.enabled.frag"><xsl:param name="othercredit.like.author.enabled">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, output of the +<tag>othercredit</tag> element on titlepages is displayed in +the same style as <tag>author</tag> and +<tag>editor</tag> output. If zero then +<tag>othercredit</tag> output is displayed using a style +different than that of <tag>author</tag> and +<tag>editor</tag>.</para> + +</refsection> +</refentry> diff --git a/params/outer.region.content.properties.xml b/params/outer.region.content.properties.xml new file mode 100644 index 0000000..43695c6 --- /dev/null +++ b/params/outer.region.content.properties.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="outer.region.content.properties"> +<refmeta> +<refentrytitle>outer.region.content.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>outer.region.content.properties</refname> +<refpurpose>Properties of running outer side content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="outer.region.content.properties.frag"> +<xsl:attribute-set name="outer.region.content.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The FO stylesheet supports optional side regions +similar to the header and footer regions. +Any attributes declared in this attribute-set +are applied to the fo:block in the side region +on the outer side (opposite the binding side) of the page. +This corresponds to the <literal>start</literal> +region on odd-numbered pages and the <literal>end</literal> +region on even-numbered pages. +For single-sided output, it always corresponds to +the <literal>start</literal> region.</para> + +<para>You can customize the template named +<literal>outer.region.content</literal> to specify +the content of the outer side region.</para> + +<para>See also +<parameter>region.outer.properties</parameter>, +<parameter>page.margin.outer</parameter>, +<parameter>body.margin.outer</parameter>, +and the corresponding <literal>inner</literal> +parameters.</para> +</refsection> +</refentry> diff --git a/params/output-root.xml b/params/output-root.xml new file mode 100644 index 0000000..d37b054 --- /dev/null +++ b/params/output-root.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="output-root"> +<refmeta> +<refentrytitle>output-root</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>output-root</refname> +<refpurpose>Specifies the root directory of the website</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="output-root.frag"> +<xsl:param name="output-root">.</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>When using the XSLT processor to manage dependencies and construct +the website, this parameter can be used to indicate the root directory +where the resulting pages are placed.</para> +<para>Only applies when XSLT-based chunking is being used.</para> +</refsection> +</refentry> diff --git a/params/output.indent.xml b/params/output.indent.xml new file mode 100644 index 0000000..40406d7 --- /dev/null +++ b/params/output.indent.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="output.indent"> +<refmeta> +<refentrytitle>output.indent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">no</refmiscinfo> +<refmiscinfo class="other" otherclass="value">yes</refmiscinfo> +</refmeta> +<refnamediv> +<refname>output.indent</refname> +<refpurpose>Indent output?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="output.indent.frag"> +<xsl:param name="output.indent" >no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the setting of the <parameter>indent</parameter> +parameter on the HTML slides. For more information, see the discussion +of the <tag>xsl:output</tag> element in the XSLT specification.</para> +<para>Select from <literal>yes</literal> or <literal>no</literal>.</para> + +</refsection> +</refentry> diff --git a/params/overlay.js.xml b/params/overlay.js.xml new file mode 100644 index 0000000..162f87a --- /dev/null +++ b/params/overlay.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="overlay.js"> +<refmeta> +<refentrytitle>overlay.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>overlay.js</refname> +<refpurpose>Overlay JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="overlay.js.frag"> +<xsl:param name="overlay.js">overlay.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the overlay JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/overlay.logo.xml b/params/overlay.logo.xml new file mode 100644 index 0000000..e740771 --- /dev/null +++ b/params/overlay.logo.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="overlay.logo"> +<refmeta> +<refentrytitle>overlay.logo</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>overlay.logo</refname> +<refpurpose>Logo to overlay on ToC frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="overlay.logo.frag"> +<xsl:param name="overlay.logo">http://docbook.sourceforge.net/release/buttons/slides-1.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If this URI is non-empty, JavaScript is used to overlay the +specified image on the ToC frame.</para> + +</refsection> +</refentry> diff --git a/params/overlay.xml b/params/overlay.xml new file mode 100644 index 0000000..f955b23 --- /dev/null +++ b/params/overlay.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="overlay"> +<refmeta> +<refentrytitle>overlay</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>overlay</refname> +<refpurpose>Overlay footer navigation?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="overlay.frag"> +<xsl:param name="overlay" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, JavaScript is added to the slides to make the +bottom navigation appear at the bottom of each page. This option and +<link linkend="multiframe">multiframe</link> are mutually exclusive.</para> + +<para>If this parameter is zero, the bottom navigation simply appears +below the content of each slide.</para> + +</refsection> +</refentry> diff --git a/params/page.height.portrait.xml b/params/page.height.portrait.xml new file mode 100644 index 0000000..0dee73e --- /dev/null +++ b/params/page.height.portrait.xml @@ -0,0 +1,69 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.height.portrait"> +<refmeta> +<refentrytitle>page.height.portrait</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.height.portrait</refname> +<refpurpose>Specify the physical size of the long edge of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.height.portrait.frag"><xsl:param name="page.height.portrait"> + <xsl:choose> + <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when> + <xsl:when test="$paper.type = 'USletter'">11in</xsl:when> + <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when> + <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when> + <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when> + <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when> + <xsl:when test="$paper.type = 'A1'">841mm</xsl:when> + <xsl:when test="$paper.type = 'A2'">594mm</xsl:when> + <xsl:when test="$paper.type = 'A3'">420mm</xsl:when> + <xsl:when test="$paper.type = 'A4'">297mm</xsl:when> + <xsl:when test="$paper.type = 'A5'">210mm</xsl:when> + <xsl:when test="$paper.type = 'A6'">148mm</xsl:when> + <xsl:when test="$paper.type = 'A7'">105mm</xsl:when> + <xsl:when test="$paper.type = 'A8'">74mm</xsl:when> + <xsl:when test="$paper.type = 'A9'">52mm</xsl:when> + <xsl:when test="$paper.type = 'A10'">37mm</xsl:when> + <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when> + <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when> + <xsl:when test="$paper.type = 'B2'">707mm</xsl:when> + <xsl:when test="$paper.type = 'B3'">500mm</xsl:when> + <xsl:when test="$paper.type = 'B4'">353mm</xsl:when> + <xsl:when test="$paper.type = 'B5'">250mm</xsl:when> + <xsl:when test="$paper.type = 'B6'">176mm</xsl:when> + <xsl:when test="$paper.type = 'B7'">125mm</xsl:when> + <xsl:when test="$paper.type = 'B8'">88mm</xsl:when> + <xsl:when test="$paper.type = 'B9'">62mm</xsl:when> + <xsl:when test="$paper.type = 'B10'">44mm</xsl:when> + <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when> + <xsl:when test="$paper.type = 'C1'">917mm</xsl:when> + <xsl:when test="$paper.type = 'C2'">648mm</xsl:when> + <xsl:when test="$paper.type = 'C3'">458mm</xsl:when> + <xsl:when test="$paper.type = 'C4'">324mm</xsl:when> + <xsl:when test="$paper.type = 'C5'">229mm</xsl:when> + <xsl:when test="$paper.type = 'C6'">162mm</xsl:when> + <xsl:when test="$paper.type = 'C7'">114mm</xsl:when> + <xsl:when test="$paper.type = 'C8'">81mm</xsl:when> + <xsl:when test="$paper.type = 'C9'">57mm</xsl:when> + <xsl:when test="$paper.type = 'C10'">40mm</xsl:when> + <xsl:otherwise>11in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The portrait page height is the length of the long +edge of the physical page. +</para> + +</refsection> +</refentry> diff --git a/params/page.height.xml b/params/page.height.xml new file mode 100644 index 0000000..96e32c0 --- /dev/null +++ b/params/page.height.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.height"> +<refmeta> +<refentrytitle>page.height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.height</refname> +<refpurpose>The height of the physical page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.height.frag"><xsl:param name="page.height"> + <xsl:choose> + <xsl:when test="$page.orientation = 'portrait'"> + <xsl:value-of select="$page.height.portrait"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$page.width.portrait"/> + </xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The page height is generally calculated from the +<parameter>paper.type</parameter> and +<parameter>page.orientation</parameter> parameters. +</para> + +</refsection> +</refentry> diff --git a/params/page.margin.bottom.xml b/params/page.margin.bottom.xml new file mode 100644 index 0000000..e1877f3 --- /dev/null +++ b/params/page.margin.bottom.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.margin.bottom"> +<refmeta> +<refentrytitle>page.margin.bottom</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.margin.bottom</refname> +<refpurpose>The bottom margin of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.margin.bottom.frag"> +<xsl:param name="page.margin.bottom">0.5in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The bottom page margin is the distance from the bottom of the region-after +to the physical bottom of the page. +</para> + +</refsection> +</refentry> diff --git a/params/page.margin.inner.xml b/params/page.margin.inner.xml new file mode 100644 index 0000000..97782ba --- /dev/null +++ b/params/page.margin.inner.xml @@ -0,0 +1,56 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.margin.inner"> +<refmeta> +<refentrytitle>page.margin.inner</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.margin.inner</refname> +<refpurpose>The inner page margin</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.margin.inner.frag"><xsl:param name="page.margin.inner"> + <xsl:choose> + <xsl:when test="$double.sided != 0">1.25in</xsl:when> + <xsl:otherwise>1in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The inner page margin is the distance from bound edge of the +page to the first column of text. </para> + +<para>The inner page margin is the distance from bound edge of the +page to the outer edge of the first column of text.</para> + +<para>In left-to-right text direction, +this is the left margin of recto (front side) pages. +For single-sided output, it is the left margin +of all pages.</para> + +<para>In right-to-left text direction, +this is the right margin of recto pages. +For single-sided output, this is the +right margin of all pages.</para> + +<note> +<para>Current versions (at least as of version 4.13) +of the XEP XSL-FO processor do not +correctly handle these margin settings for documents +with right-to-left text direction. +The workaround in that situation is to reverse +the values for <parameter>page.margin.inner</parameter> +and <parameter>page.margin.outer</parameter>, until +this bug is fixed by RenderX. It does not affect documents +with left-to-right text direction.</para> +</note> + +</refsection> +</refentry> diff --git a/params/page.margin.outer.xml b/params/page.margin.outer.xml new file mode 100644 index 0000000..61dfeb8 --- /dev/null +++ b/params/page.margin.outer.xml @@ -0,0 +1,53 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.margin.outer"> +<refmeta> +<refentrytitle>page.margin.outer</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.margin.outer</refname> +<refpurpose>The outer page margin</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.margin.outer.frag"><xsl:param name="page.margin.outer"> + <xsl:choose> + <xsl:when test="$double.sided != 0">0.75in</xsl:when> + <xsl:otherwise>1in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The outer page margin is the distance from non-bound edge of the +page to the outer edge of the last column of text.</para> + +<para>In left-to-right text direction, +this is the right margin of recto (front side) pages. +For single-sided output, it is the right margin +of all pages.</para> + +<para>In right-to-left text direction, +this is the left margin of recto pages. +For single-sided output, this is the +left margin of all pages.</para> + +<note> +<para>Current versions (at least as of version 4.13) +of the XEP XSL-FO processor do not +correctly handle these margin settings for documents +with right-to-left text direction. +The workaround in that situation is to reverse +the values for <parameter>page.margin.inner</parameter> +and <parameter>page.margin.outer</parameter>, until +this bug is fixed by RenderX. It does not affect documents +with left-to-right text direction.</para> +</note> + +</refsection> +</refentry> diff --git a/params/page.margin.top.xml b/params/page.margin.top.xml new file mode 100644 index 0000000..a7e53e8 --- /dev/null +++ b/params/page.margin.top.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.margin.top"> +<refmeta> +<refentrytitle>page.margin.top</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.margin.top</refname> +<refpurpose>The top margin of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.margin.top.frag"> +<xsl:param name="page.margin.top">0.5in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The top page margin is the distance from the physical top of the +page to the top of the region-before.</para> + +</refsection> +</refentry> diff --git a/params/page.orientation.xml b/params/page.orientation.xml new file mode 100644 index 0000000..37971c0 --- /dev/null +++ b/params/page.orientation.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.orientation"> +<refmeta> +<refentrytitle>page.orientation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">portrait</refmiscinfo> +<refmiscinfo class="other" otherclass="value">landscape</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.orientation</refname> +<refpurpose>Select the page orientation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.orientation.frag"> +<xsl:param name="page.orientation">portrait</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> Select one from portrait or landscape. +In portrait orientation, the short edge is horizontal; in +landscape orientation, it is vertical. +</para> + +</refsection> +</refentry> diff --git a/params/page.width.portrait.xml b/params/page.width.portrait.xml new file mode 100644 index 0000000..8216fc3 --- /dev/null +++ b/params/page.width.portrait.xml @@ -0,0 +1,67 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.width.portrait"> +<refmeta> +<refentrytitle>page.width.portrait</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.width.portrait</refname> +<refpurpose>Specify the physical size of the short edge of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.width.portrait.frag"><xsl:param name="page.width.portrait"> + <xsl:choose> + <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when> + <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when> + <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when> + <xsl:when test="$paper.type = 'A0'">841mm</xsl:when> + <xsl:when test="$paper.type = 'A1'">594mm</xsl:when> + <xsl:when test="$paper.type = 'A2'">420mm</xsl:when> + <xsl:when test="$paper.type = 'A3'">297mm</xsl:when> + <xsl:when test="$paper.type = 'A4'">210mm</xsl:when> + <xsl:when test="$paper.type = 'A5'">148mm</xsl:when> + <xsl:when test="$paper.type = 'A6'">105mm</xsl:when> + <xsl:when test="$paper.type = 'A7'">74mm</xsl:when> + <xsl:when test="$paper.type = 'A8'">52mm</xsl:when> + <xsl:when test="$paper.type = 'A9'">37mm</xsl:when> + <xsl:when test="$paper.type = 'A10'">26mm</xsl:when> + <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when> + <xsl:when test="$paper.type = 'B1'">707mm</xsl:when> + <xsl:when test="$paper.type = 'B2'">500mm</xsl:when> + <xsl:when test="$paper.type = 'B3'">353mm</xsl:when> + <xsl:when test="$paper.type = 'B4'">250mm</xsl:when> + <xsl:when test="$paper.type = 'B5'">176mm</xsl:when> + <xsl:when test="$paper.type = 'B6'">125mm</xsl:when> + <xsl:when test="$paper.type = 'B7'">88mm</xsl:when> + <xsl:when test="$paper.type = 'B8'">62mm</xsl:when> + <xsl:when test="$paper.type = 'B9'">44mm</xsl:when> + <xsl:when test="$paper.type = 'B10'">31mm</xsl:when> + <xsl:when test="$paper.type = 'C0'">917mm</xsl:when> + <xsl:when test="$paper.type = 'C1'">648mm</xsl:when> + <xsl:when test="$paper.type = 'C2'">458mm</xsl:when> + <xsl:when test="$paper.type = 'C3'">324mm</xsl:when> + <xsl:when test="$paper.type = 'C4'">229mm</xsl:when> + <xsl:when test="$paper.type = 'C5'">162mm</xsl:when> + <xsl:when test="$paper.type = 'C6'">114mm</xsl:when> + <xsl:when test="$paper.type = 'C7'">81mm</xsl:when> + <xsl:when test="$paper.type = 'C8'">57mm</xsl:when> + <xsl:when test="$paper.type = 'C9'">40mm</xsl:when> + <xsl:when test="$paper.type = 'C10'">28mm</xsl:when> + <xsl:otherwise>8.5in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The portrait page width is the length of the short +edge of the physical page. +</para> + +</refsection> +</refentry> diff --git a/params/page.width.xml b/params/page.width.xml new file mode 100644 index 0000000..ff16060 --- /dev/null +++ b/params/page.width.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="page.width"> +<refmeta> +<refentrytitle>page.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>page.width</refname> +<refpurpose>The width of the physical page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="page.width.frag"><xsl:param name="page.width"> + <xsl:choose> + <xsl:when test="$page.orientation = 'portrait'"> + <xsl:value-of select="$page.width.portrait"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$page.height.portrait"/> + </xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The page width is generally calculated from the +<parameter>paper.type</parameter> and +<parameter>page.orientation</parameter> parameters.</para> + +</refsection> +</refentry> diff --git a/params/pages.template.xml b/params/pages.template.xml new file mode 100644 index 0000000..fff546c --- /dev/null +++ b/params/pages.template.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="pages.template"> +<refmeta> +<refentrytitle>pages.template</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>pages.template</refname> +<refpurpose>Specify the template Pages document</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="pages.template.frag"> +<xsl:param name="pages.template"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>pages.template</parameter> parameter specifies a Pages (the Apple word processing application) document to use as a template for the generated document. The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements. Any content in the template document is ignored.</para> + +<para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Pages itself, rather than these XSL stylesheets.</para> + +</refsection> +</refentry> diff --git a/params/paper.type.xml b/params/paper.type.xml new file mode 100644 index 0000000..2656c9c --- /dev/null +++ b/params/paper.type.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="paper.type"> +<refmeta> +<refentrytitle>paper.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">USletter<alt>8.5x11in</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">USlandscape<alt>11x8.5in</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">USlegal<alt>8.5inx14in</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">USlegallandscape<alt>14inx8.5in</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">4A0<alt>2378x1682mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">2A0<alt>1682x1189mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A0<alt>1189x841mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A1<alt>841x594mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A2<alt>594x420mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A3<alt>420x297mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A4<alt>297x210mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A5<alt>210x148mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A6<alt>148x105mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A7<alt>105x74mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A8<alt>74x52mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A9<alt>52x37mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A10<alt>37x26mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B0<alt>1414x1000mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B1<alt>1000x707mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B2<alt>707x500mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B3<alt>500x353mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B4<alt>353x250mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B5<alt>250x176mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B6<alt>176x125mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B7<alt>125x88mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B8<alt>88x62mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B9<alt>62x44mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">B10<alt>44x31mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C0<alt>1297x917mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C1<alt>917x648mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C2<alt>648x458mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C3<alt>458x324mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C4<alt>324x229mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C5<alt>229x162mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C6<alt>162x114mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C7<alt>114x81mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C8<alt>81x57mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C9<alt>57x40mm</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">C10<alt>40x28mm</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>paper.type</refname> +<refpurpose>Select the paper type</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="paper.type.frag"> +<xsl:param name="paper.type">USletter</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The paper type is a convenient way to specify the paper size. +The list of known paper sizes includes USletter and most of the A, +B, and C sizes. See <parameter>page.width.portrait</parameter>, for example. + + +</para> + +</refsection> +</refentry> diff --git a/params/para.propagates.style.xml b/params/para.propagates.style.xml new file mode 100644 index 0000000..0415adf --- /dev/null +++ b/params/para.propagates.style.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="para.propagates.style"> +<refmeta> +<refentrytitle>para.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>para.propagates.style</refname> +<refpurpose>Pass para role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="para.propagates.style.frag"> +<xsl:param name="para.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, the role attribute of <tag>para</tag> elements +will be passed through to the HTML as a class attribute on the +<tag>p</tag> generated for the paragraph.</para> + +</refsection> +</refentry> diff --git a/params/para.properties.xml b/params/para.properties.xml new file mode 100644 index 0000000..e36c33a --- /dev/null +++ b/params/para.properties.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="para.properties"> +<refmeta> +<refentrytitle>para.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>para.properties</refname> +<refpurpose>Properties to apply to para elements</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="para.properties.frag"><xsl:attribute-set name="para.properties" use-attribute-sets="normal.para.spacing"> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>Specify properties to apply to the fo:block of a para element, +such as <literal>text-indent</literal>. +Although the default attribute-set is empty, it uses the attribute-set +named <literal>normal.para.spacing</literal> to add vertical space before +each para. The <literal>para.properties</literal> attribute-set can override those +spacing properties for para only.</para> +<para>See also +<link linkend="normal.para.spacing">normal.para.spacing</link>. +</para> +</refsection> +</refentry> diff --git a/params/part.autolabel.xml b/params/part.autolabel.xml new file mode 100644 index 0000000..4f1a42c --- /dev/null +++ b/params/part.autolabel.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="part.autolabel"> +<refmeta> +<refentrytitle>part.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>part.autolabel</refname> +<refpurpose>Specifies the labeling format for Part titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="part.autolabel.frag"> +<xsl:param name="part.autolabel">I</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, then parts will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (upperroman). +</para> + + +</refsection> +</refentry> diff --git a/params/passivetex.extensions.xml b/params/passivetex.extensions.xml new file mode 100644 index 0000000..32415ec --- /dev/null +++ b/params/passivetex.extensions.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="passivetex.extensions"> +<refmeta> +<refentrytitle>passivetex.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>passivetex.extensions</refname> +<refpurpose>Enable PassiveTeX extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="passivetex.extensions.frag"><xsl:param name="passivetex.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +<link xlink:href="http://projects.oucs.ox.ac.uk/passivetex/">PassiveTeX</link> +extensions will be used. At present, this consists of PDF bookmarks +and sorted index terms. +</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> + +<note> + <para>PassiveTeX is incomplete and development has ceased. In most cases, +another XSL-FO engine is probably a better choice.</para> +</note> + +</refsection> +</refentry> diff --git a/params/pgwide.properties.xml b/params/pgwide.properties.xml new file mode 100644 index 0000000..c63b461 --- /dev/null +++ b/params/pgwide.properties.xml @@ -0,0 +1,52 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="pgwide.properties"> +<refmeta> +<refentrytitle>pgwide.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>pgwide.properties</refname> +<refpurpose>Properties to make a figure or table page wide. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="pgwide.properties.frag"> +<xsl:attribute-set name="pgwide.properties"> + <xsl:attribute name="start-indent">0pt</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is used to set the properties +that make a figure or table "page wide" in fo output. +It comes into effect when an attribute <literal>pgwide="1"</literal> +is used. +</para> + +<para> +By default, it sets <parameter>start-indent</parameter> +to <literal>0pt</literal>. +In a stylesheet that sets the parameter +<parameter>body.start.indent</parameter> +to a non-zero value in order to indent body text, +this attribute set can be used to outdent pgwide +figures to the start margin. +</para> + +<para>If a document uses a multi-column page layout, +then this attribute set could try setting <parameter>span</parameter> +to a value of <literal>all</literal>. However, this may +not work with some processors because a span property must be on an +fo:block that is a direct child of fo:flow. It may work in +some processors anyway. +</para> + +</refsection> +</refentry> diff --git a/params/phrase.propagates.style.xml b/params/phrase.propagates.style.xml new file mode 100644 index 0000000..8c25892 --- /dev/null +++ b/params/phrase.propagates.style.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="phrase.propagates.style"> +<refmeta> +<refentrytitle>phrase.propagates.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>phrase.propagates.style</refname> +<refpurpose>Pass phrase role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="phrase.propagates.style.frag"> +<xsl:param name="phrase.propagates.style" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the role attribute of <tag>phrase</tag> elements +will be passed through to the HTML as a <literal>class</literal> +attribute on a <literal>span</literal> that surrounds the +phrase.</para> + +</refsection> +</refentry> diff --git a/params/pixels.per.inch.xml b/params/pixels.per.inch.xml new file mode 100644 index 0000000..86faff5 --- /dev/null +++ b/params/pixels.per.inch.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="pixels.per.inch"> +<refmeta> +<refentrytitle>pixels.per.inch</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>pixels.per.inch</refname> +<refpurpose>How many pixels are there per inch?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="pixels.per.inch.frag"> +<xsl:param name="pixels.per.inch">90</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When lengths are converted to pixels, this value is used to +determine the size of a pixel. The default value is taken from the +<link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL +Recommendation</link>. +</para> + +</refsection> +</refentry> diff --git a/params/plus.image.xml b/params/plus.image.xml new file mode 100644 index 0000000..17b3d3c --- /dev/null +++ b/params/plus.image.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="plus.image"> +<refmeta> +<refentrytitle>plus.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>plus.image</refname> +<refpurpose>Plus image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="plus.image.frag"> +<xsl:param name="plus.image">toc/closed.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the <quote>plus</quote> image; the image used in a +<link linkend="dynamic.toc">dynamic ToC</link> to indicate that a section +can be expanded.</para> + +</refsection> +</refentry> diff --git a/params/points.per.em.xml b/params/points.per.em.xml new file mode 100644 index 0000000..76bd22e --- /dev/null +++ b/params/points.per.em.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="points.per.em"> +<refmeta> +<refentrytitle>points.per.em</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>points.per.em</refname> +<refpurpose>Specify the nominal size of an em-space in points</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="points.per.em.frag"> +<xsl:param name="points.per.em">10</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The fixed value used for calculations based upon the size of a +character. The assumption made is that ten point font is in use. This +assumption may not be valid.</para> + +</refsection> +</refentry> diff --git a/params/preface.autolabel.xml b/params/preface.autolabel.xml new file mode 100644 index 0000000..f59115a --- /dev/null +++ b/params/preface.autolabel.xml @@ -0,0 +1,71 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="preface.autolabel"> +<refmeta> +<refentrytitle>preface.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>preface.autolabel</refname> +<refpurpose>Specifices the labeling format for Preface titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero then prefaces will be numbered using the parameter +value as the number format if the value matches one of the following: +</para> + +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> + +<para>Any nonzero value other than the above will generate +the default number format (arabic). +</para> + + +</refsection> +</refentry> diff --git a/params/prefer.internal.olink.xml b/params/prefer.internal.olink.xml new file mode 100644 index 0000000..2599d76 --- /dev/null +++ b/params/prefer.internal.olink.xml @@ -0,0 +1,78 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="prefer.internal.olink"> +<refmeta> +<refentrytitle>prefer.internal.olink</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>prefer.internal.olink</refname> +<refpurpose>Prefer a local olink reference to an external reference</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="prefer.internal.olink.frag"> +<xsl:param name="prefer.internal.olink" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you are re-using XML content modules in multiple documents, +you may want to redirect some of your olinks. This parameter +permits you to redirect an olink to the current document. +</para> + +<para>For example: you are writing documentation for a product, +which includes 3 manuals: a little installation +booklet (booklet.xml), a user +guide (user.xml), and a reference manual (reference.xml). +All 3 documents begin with the same introduction section (intro.xml) that +contains a reference to the customization section (custom.xml) which is +included in both user.xml and reference.xml documents. +</para> + +<para>How do you write the link to custom.xml in intro.xml +so that it is interpreted correctly in all 3 documents?</para> +<itemizedlist> +<listitem><para>If you use xref, it will fail in user.xml.</para> +</listitem> +<listitem><para>If you use olink (pointing to reference.xml), +the reference in user.xml +will point to the customization section of the reference manual, while it is +actually available in user.xml.</para> +</listitem> +</itemizedlist> + +<para>If you set the <parameter>prefer.internal.olink</parameter> +parameter to a non-zero value, then the processor will +first look in the olink database +for the olink's <tag>targetptr</tag> attribute value +in document matching the <parameter>current.docid</parameter> +parameter value. If it isn't found there, then +it tries the document in the database +with the <tag>targetdoc</tag> +value that matches the olink's <tag>targetdoc</tag> +attribute. +</para> + +<para>This feature permits an olink reference to resolve to +the current document if there is an element +with an id matching the olink's <tag>targetptr</tag> +value. The current document's olink data must be +included in the target database for this to work.</para> + +<caution> +<para>There is a potential for incorrect links if +the same <tag>id</tag> attribute value is used for different +content in different documents. +Some of your olinks may be redirected to the current document +when they shouldn't be. It is not possible to control +individual olink instances.</para> +</caution> + +</refsection> +</refentry> diff --git a/params/preferred.mediaobject.role.xml b/params/preferred.mediaobject.role.xml new file mode 100644 index 0000000..57b0989 --- /dev/null +++ b/params/preferred.mediaobject.role.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="preferred.mediaobject.role"> +<refmeta> +<refentrytitle>preferred.mediaobject.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>preferred.mediaobject.role</refname> +<refpurpose>Select which mediaobject to use based on +this value of an object's <tag class="attribute">role</tag> attribute. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="preferred.mediaobject.role.frag"> +<xsl:param name="preferred.mediaobject.role"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A mediaobject may contain several objects such as imageobjects. +If the parameter <parameter>use.role.for.mediaobject</parameter> is +non-zero, then the <literal>role</literal> attribute on +<tag>imageobject</tag>s and other objects within a +<tag>mediaobject</tag> container will be used to select which object +will be used. If one of the objects has a role value that matches the +<parameter>preferred.mediaobject.role</parameter> parameter, then it +has first priority for selection. If more than one has such a role +value, the first one is used. +</para> +<para> +See the <parameter>use.role.for.mediaobject</parameter> parameter +for the sequence of selection.</para> +</refsection> +</refentry> diff --git a/params/prev.image.xml b/params/prev.image.xml new file mode 100644 index 0000000..b017115 --- /dev/null +++ b/params/prev.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="prev.image"> +<refmeta> +<refentrytitle>prev.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>prev.image</refname> +<refpurpose>Left-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="prev.image.frag"> +<xsl:param name="prev.image">active/nav-prev.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the left-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/procedure.properties.xml b/params/procedure.properties.xml new file mode 100644 index 0000000..f6cadb0 --- /dev/null +++ b/params/procedure.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="procedure.properties"> +<refmeta> +<refentrytitle>procedure.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>procedure.properties</refname> +<refpurpose>Properties associated with a procedure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="procedure.properties.frag"> +<xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties"> + <xsl:attribute name="keep-together.within-column">auto</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for procedures.</para> + +</refsection> +</refentry> diff --git a/params/process.empty.source.toc.xml b/params/process.empty.source.toc.xml new file mode 100644 index 0000000..772b456 --- /dev/null +++ b/params/process.empty.source.toc.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="process.empty.source.toc"> +<refmeta> +<refentrytitle>process.empty.source.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.empty.source.toc</refname> +<refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies that if an empty <tag>toc</tag> element is found in a +source document, an automated TOC is generated at this point in the +document. +<note> + <para>Depending on what the value of the + <parameter>generate.toc</parameter> parameter is, setting this + parameter to <literal>1</literal> could result in generation of + duplicate automated TOCs. So the + <parameter>process.empty.source.toc</parameter> is primarily useful + as an "override": by placing an empty <tag>toc</tag> in your + document and setting this parameter to <literal>1</literal>, you can + force a TOC to be generated even if <tag>generate.toc</tag> + says not to.</para> +</note> +</para> + +</refsection> +</refentry> diff --git a/params/process.source.toc.xml b/params/process.source.toc.xml new file mode 100644 index 0000000..b91657a --- /dev/null +++ b/params/process.source.toc.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="process.source.toc"> +<refmeta> +<refentrytitle>process.source.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.source.toc</refname> +<refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies that the contents of a non-empty "hard-coded" +<tag>toc</tag> element in a source document are processed to +generate a TOC in output. +<note> + <para>This parameter has no effect on automated generation of + TOCs. An automated TOC may still be generated along with the + "hard-coded" TOC. To suppress automated TOC generation, adjust the + value of the <parameter>generate.toc</parameter> paramameter.</para> + + <para>The <tag>process.source.toc</tag> parameter also has + no effect if the <tag>toc</tag> element is empty; handling + for empty <tag>toc</tag> is controlled by the + <parameter>process.empty.source.toc</parameter> parameter.</para> +</note> +</para> + +</refsection> +</refentry> diff --git a/params/profile.arch.xml b/params/profile.arch.xml new file mode 100644 index 0000000..afcd34c --- /dev/null +++ b/params/profile.arch.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.arch"> +<refmeta> +<refentrytitle>profile.arch</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.arch</refname> +<refpurpose>Target profile for <tag class="attribute">arch</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.arch.frag"> +<xsl:param name="profile.arch"></xsl:param> +</src:fragment> +</refsynopsisdiv> + + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.attribute.xml b/params/profile.attribute.xml new file mode 100644 index 0000000..e7dc5d0 --- /dev/null +++ b/params/profile.attribute.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.attribute"> +<refmeta> +<refentrytitle>profile.attribute</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.attribute</refname> +<refpurpose>Name of user-specified profiling attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.attribute.frag"> +<xsl:param name="profile.attribute"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter is used in conjuction with +<parameter>profile.value</parameter>.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.audience.xml b/params/profile.audience.xml new file mode 100644 index 0000000..1c5b1a3 --- /dev/null +++ b/params/profile.audience.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.audience"> +<refmeta> +<refentrytitle>profile.audience</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.audience</refname> +<refpurpose>Target profile for <tag class="attribute">audience</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.audience.frag"> +<xsl:param name="profile.audience"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.condition.xml b/params/profile.condition.xml new file mode 100644 index 0000000..8bb01a3 --- /dev/null +++ b/params/profile.condition.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.condition"> +<refmeta> +<refentrytitle>profile.condition</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.condition</refname> +<refpurpose>Target profile for <tag class="attribute">condition</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.condition.frag"> +<xsl:param name="profile.condition"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.conformance.xml b/params/profile.conformance.xml new file mode 100644 index 0000000..606af4c --- /dev/null +++ b/params/profile.conformance.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.conformance"> +<refmeta> +<refentrytitle>profile.conformance</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.conformance</refname> +<refpurpose>Target profile for <tag class="attribute">conformance</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.conformance.frag"> +<xsl:param name="profile.conformance"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.lang.xml b/params/profile.lang.xml new file mode 100644 index 0000000..43b9439 --- /dev/null +++ b/params/profile.lang.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.lang"> +<refmeta> +<refentrytitle>profile.lang</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.lang</refname> +<refpurpose>Target profile for <tag class="attribute">lang</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.lang.frag"> +<xsl:param name="profile.lang"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.os.xml b/params/profile.os.xml new file mode 100644 index 0000000..ba6f430 --- /dev/null +++ b/params/profile.os.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.os"> +<refmeta> +<refentrytitle>profile.os</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.os</refname> +<refpurpose>Target profile for <tag class="attribute">os</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.os.frag"> +<xsl:param name="profile.os"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.revision.xml b/params/profile.revision.xml new file mode 100644 index 0000000..28f668d --- /dev/null +++ b/params/profile.revision.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.revision"> +<refmeta> +<refentrytitle>profile.revision</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revision</refname> +<refpurpose>Target profile for <tag class="attribute">revision</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.revision.frag"> +<xsl:param name="profile.revision" ></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.revisionflag.xml b/params/profile.revisionflag.xml new file mode 100644 index 0000000..3ab8919 --- /dev/null +++ b/params/profile.revisionflag.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.revisionflag"> +<refmeta> +<refentrytitle>profile.revisionflag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revisionflag</refname> +<refpurpose>Target profile for <tag class="attribute">revisionflag</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.revisionflag.frag"> +<xsl:param name="profile.revisionflag"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.role.xml b/params/profile.role.xml new file mode 100644 index 0000000..5758e4a --- /dev/null +++ b/params/profile.role.xml @@ -0,0 +1,54 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.role"> +<refmeta> +<refentrytitle>profile.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.role</refname> +<refpurpose>Target profile for <tag class="attribute">role</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.role.frag"> +<xsl:param name="profile.role"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +<warning> +<para>Note that <tag class="attribute">role</tag> is often +used for other purposes than profiling. For example it is commonly +used to get emphasize in bold font:</para> + +<programlisting><emphasis role="bold">very important</emphasis></programlisting> + +<para>If you are using <tag class="attribute">role</tag> for +these purposes do not forget to add values like <literal>bold</literal> to +value of this parameter. If you forgot you will get document with +small pieces missing which are very hard to track.</para> + +<para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should +rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para> +</warning> + +</refsection> +</refentry> diff --git a/params/profile.security.xml b/params/profile.security.xml new file mode 100644 index 0000000..8ffca0f --- /dev/null +++ b/params/profile.security.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.security"> +<refmeta> +<refentrytitle>profile.security</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.security</refname> +<refpurpose>Target profile for <tag class="attribute">security</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.security.frag"> +<xsl:param name="profile.security"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.separator.xml b/params/profile.separator.xml new file mode 100644 index 0000000..a4317f5 --- /dev/null +++ b/params/profile.separator.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.separator"> +<refmeta> +<refentrytitle>profile.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.separator</refname> +<refpurpose>Separator character for compound profile values</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.separator.frag"> +<xsl:param name="profile.separator">;</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para> + +</refsection> +</refentry> diff --git a/params/profile.status.xml b/params/profile.status.xml new file mode 100644 index 0000000..c9fc469 --- /dev/null +++ b/params/profile.status.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.status"> +<refmeta> +<refentrytitle>profile.status</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.status</refname> +<refpurpose>Target profile for <tag class="attribute">status</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.status.frag"> +<xsl:param name="profile.status"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.userlevel.xml b/params/profile.userlevel.xml new file mode 100644 index 0000000..39e263b --- /dev/null +++ b/params/profile.userlevel.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.userlevel"> +<refmeta> +<refentrytitle>profile.userlevel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.userlevel</refname> +<refpurpose>Target profile for <tag class="attribute">userlevel</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.userlevel.frag"> +<xsl:param name="profile.userlevel"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.value.xml b/params/profile.value.xml new file mode 100644 index 0000000..85f7190 --- /dev/null +++ b/params/profile.value.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.value"> +<refmeta> +<refentrytitle>profile.value</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.value</refname> +<refpurpose>Target profile for user-specified attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.value.frag"> +<xsl:param name="profile.value"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When you are using this parameter you must also specify name of +profiling attribute with parameter +<parameter>profile.attribute</parameter>.</para> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.vendor.xml b/params/profile.vendor.xml new file mode 100644 index 0000000..c0187f0 --- /dev/null +++ b/params/profile.vendor.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.vendor"> +<refmeta> +<refentrytitle>profile.vendor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.vendor</refname> +<refpurpose>Target profile for <tag class="attribute">vendor</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.vendor.frag"> +<xsl:param name="profile.vendor"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/profile.wordsize.xml b/params/profile.wordsize.xml new file mode 100644 index 0000000..e30ffc7 --- /dev/null +++ b/params/profile.wordsize.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="profile.wordsize"> +<refmeta> +<refentrytitle>profile.wordsize</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.wordsize</refname> +<refpurpose>Target profile for <tag class="attribute">wordsize</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.wordsize.frag"> +<xsl:param name="profile.wordsize"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsection> +</refentry> diff --git a/params/punct.honorific.xml b/params/punct.honorific.xml new file mode 100644 index 0000000..7c8a38e --- /dev/null +++ b/params/punct.honorific.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="punct.honorific"> +<refmeta> +<refentrytitle>punct.honorific</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>punct.honorific</refname> +<refpurpose>Punctuation after an honorific in a personal name.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="punct.honorific.frag"> +<xsl:param name="punct.honorific">.</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the punctuation that should be added after an +honorific in a personal name.</para> + +</refsection> +</refentry> diff --git a/params/qanda.defaultlabel.xml b/params/qanda.defaultlabel.xml new file mode 100644 index 0000000..0b43f0d --- /dev/null +++ b/params/qanda.defaultlabel.xml @@ -0,0 +1,86 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.defaultlabel"> +<refmeta> +<refentrytitle>qanda.defaultlabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">number</refmiscinfo> +<refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.defaultlabel</refname> +<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.defaultlabel.frag"> +<xsl:param name="qanda.defaultlabel">number</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If no <literal>defaultlabel</literal> attribute is specified on +a <tag>qandaset</tag>, this value is used. It is generally one of the legal +values for the defaultlabel attribute (<literal>none</literal>, +<literal>number</literal> or +<literal>qanda</literal>), or one of the additional stylesheet-specific values +(<literal>qnumber</literal> or <literal>qnumberanda</literal>). +The default value is 'number'. +</para> +<para>The values are rendered as follows:</para> +<variablelist> +<varlistentry><term><literal>qanda</literal></term> +<listitem> +<para><tag>question</tag>s are labeled "Q:" and +<tag>answer</tag>s are labeled "A:". </para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>number</literal></term> +<listitem> +<para>The questions are enumerated and the answers +are not labeled. </para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>qnumber</literal></term> +<listitem> +<para>The questions are labeled "Q:" followed by a number, and answers are not +labeled. +When sections are numbered, adding a label +to the number distinguishes the question numbers +from the section numbers. +This value is not allowed in the +<tag class="attribute">defaultlabel</tag> attribute +of a <tag>qandaset</tag> element.</para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>qnumberanda</literal></term> +<listitem> +<para>The questions are labeled "Q:" followed by a number, and +the answers are labeled "A:". +When sections are numbered, adding a label +to the number distinguishes the question numbers +from the section numbers. +This value is not allowed in the +<tag class="attribute">defaultlabel</tag> attribute +of a <tag>qandaset</tag> element.</para> +</listitem> +</varlistentry> + +<varlistentry><term><literal>none</literal></term> +<listitem> +<para>No distinguishing label precedes Questions or Answers. +</para> +</listitem> +</varlistentry> +</variablelist> + +</refsection> +</refentry> diff --git a/params/qanda.in.toc.xml b/params/qanda.in.toc.xml new file mode 100644 index 0000000..9597b71 --- /dev/null +++ b/params/qanda.in.toc.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.in.toc"> +<refmeta> +<refentrytitle>qanda.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.in.toc</refname> +<refpurpose>Should qandaentry questions appear in +the document table of contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), then the generated table of contents +for a document will include <tag>qandaset</tag> titles, +<tag>qandadiv</tag> titles, +and <tag>question</tag> elements. The default value (zero) excludes +them from the TOC. +</para> +<para>This parameter does not affect any tables of contents +that may be generated inside a qandaset or qandadiv. +</para> + +</refsection> +</refentry> diff --git a/params/qanda.inherit.numeration.xml b/params/qanda.inherit.numeration.xml new file mode 100644 index 0000000..744c0e8 --- /dev/null +++ b/params/qanda.inherit.numeration.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.inherit.numeration"> +<refmeta> +<refentrytitle>qanda.inherit.numeration</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.inherit.numeration</refname> +<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.inherit.numeration.frag"> +<xsl:param name="qanda.inherit.numeration" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, numbered <tag>qandadiv</tag> elements and +<tag>question</tag> and <tag>answer</tag> inherit the enumeration of +the ancestors of the <tag>qandaset</tag>. +</para> + +</refsection> +</refentry> diff --git a/params/qanda.nested.in.toc.xml b/params/qanda.nested.in.toc.xml new file mode 100644 index 0000000..01bdf5a --- /dev/null +++ b/params/qanda.nested.in.toc.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.nested.in.toc"> +<refmeta> +<refentrytitle>qanda.nested.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.nested.in.toc</refname> +<refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.nested.in.toc.frag"> +<xsl:param name="qanda.nested.in.toc" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, instances of <tag>qandaentry</tag> +that are children of <tag>answer</tag> elements are shown in +the TOC.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level1.properties.xml b/params/qanda.title.level1.properties.xml new file mode 100644 index 0000000..edaecc9 --- /dev/null +++ b/params/qanda.title.level1.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level1.properties"> +<refmeta> +<refentrytitle>qanda.title.level1.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level1.properties</refname> +<refpurpose>Properties for level-1 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level1.properties.frag"> +<xsl:attribute-set name="qanda.title.level1.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 2.0736"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-1 qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level2.properties.xml b/params/qanda.title.level2.properties.xml new file mode 100644 index 0000000..ca48ca1 --- /dev/null +++ b/params/qanda.title.level2.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level2.properties"> +<refmeta> +<refentrytitle>qanda.title.level2.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level2.properties</refname> +<refpurpose>Properties for level-2 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level2.properties.frag"> +<xsl:attribute-set name="qanda.title.level2.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.728"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-2 qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level3.properties.xml b/params/qanda.title.level3.properties.xml new file mode 100644 index 0000000..c9c098e --- /dev/null +++ b/params/qanda.title.level3.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level3.properties"> +<refmeta> +<refentrytitle>qanda.title.level3.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level3.properties</refname> +<refpurpose>Properties for level-3 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level3.properties.frag"> +<xsl:attribute-set name="qanda.title.level3.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.44"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-3 qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level4.properties.xml b/params/qanda.title.level4.properties.xml new file mode 100644 index 0000000..4344e76 --- /dev/null +++ b/params/qanda.title.level4.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level4.properties"> +<refmeta> +<refentrytitle>qanda.title.level4.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level4.properties</refname> +<refpurpose>Properties for level-4 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level4.properties.frag"> +<xsl:attribute-set name="qanda.title.level4.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.2"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-4 qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level5.properties.xml b/params/qanda.title.level5.properties.xml new file mode 100644 index 0000000..31b0d20 --- /dev/null +++ b/params/qanda.title.level5.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level5.properties"> +<refmeta> +<refentrytitle>qanda.title.level5.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level5.properties</refname> +<refpurpose>Properties for level-5 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level5.properties.frag"> +<xsl:attribute-set name="qanda.title.level5.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-5 qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.level6.properties.xml b/params/qanda.title.level6.properties.xml new file mode 100644 index 0000000..920c7e9 --- /dev/null +++ b/params/qanda.title.level6.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.level6.properties"> +<refmeta> +<refentrytitle>qanda.title.level6.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level6.properties</refname> +<refpurpose>Properties for level-6 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.level6.properties.frag"> +<xsl:attribute-set name="qanda.title.level6.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-6 qanda set titles. +This property set is actually +used for all titles below level 5.</para> + +</refsection> +</refentry> diff --git a/params/qanda.title.properties.xml b/params/qanda.title.properties.xml new file mode 100644 index 0000000..24c2037 --- /dev/null +++ b/params/qanda.title.properties.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qanda.title.properties"> +<refmeta> +<refentrytitle>qanda.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.properties</refname> +<refpurpose>Properties for qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qanda.title.properties.frag"> +<xsl:attribute-set name="qanda.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.fontset"/> + </xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <!-- font size is calculated dynamically by qanda.heading template --> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties common to all qanda set titles.</para> + +</refsection> +</refentry> diff --git a/params/qandadiv.autolabel.xml b/params/qandadiv.autolabel.xml new file mode 100644 index 0000000..596350a --- /dev/null +++ b/params/qandadiv.autolabel.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="qandadiv.autolabel"> +<refmeta> +<refentrytitle>qandadiv.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qandadiv.autolabel</refname> +<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, unlabeled qandadivs will be enumerated. +</para> + +</refsection> +</refentry> diff --git a/params/rebuild-all.xml b/params/rebuild-all.xml new file mode 100644 index 0000000..6dcd5e0 --- /dev/null +++ b/params/rebuild-all.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="rebuild-all"> +<refmeta> +<refentrytitle>rebuild-all</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>rebuild-all</refname> +<refpurpose>Indicates that all files should be produced</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="rebuild-all.frag"> +<xsl:param name="rebuild-all" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>When using the XSLT processor to manage dependencies and construct +the website, this parameter can be used to regenerate the whole website, +updating even pages that don't appear to need to be updated.</para> +<para>The dependency extension only looks at the source documents. So +if you change something in the stylesheet, for example, that has a global +effect, you can use this parameter to force the stylesheet to rebuild the +whole website. +</para> +<para>Only applies when XSLT-based chunking is being used.</para> +</refsection> +</refentry> diff --git a/params/refclass.suppress.xml b/params/refclass.suppress.xml new file mode 100644 index 0000000..8f9b52a --- /dev/null +++ b/params/refclass.suppress.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refclass.suppress"> +<refmeta> +<refentrytitle>refclass.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refclass.suppress</refname> +<refpurpose>Suppress display of refclass contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refclass.suppress.frag"> +<xsl:param name="refclass.suppress" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>refclass.suppress</parameter> is +non-zero, then display of <tag>refclass</tag> contents is +suppressed in output.</para> + +</refsection> +</refentry> diff --git a/params/refentry.date.profile.enabled.xml b/params/refentry.date.profile.enabled.xml new file mode 100644 index 0000000..11de660 --- /dev/null +++ b/params/refentry.date.profile.enabled.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.date.profile.enabled"> +<refmeta> +<refentrytitle>refentry.date.profile.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.date.profile.enabled</refname> +<refpurpose>Enable refentry "date" profiling?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.date.profile.enabled.frag"> +<xsl:param name="refentry.date.profile.enabled">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>refentry.date.profile.enabled</parameter> is non-zero, then +during <tag>refentry</tag> metadata gathering, the info profile +specified by the customizable +<parameter>refentry.date.profile</parameter> parameter is used.</para> + +<para>If instead the value of +<parameter>refentry.date.profile.enabled</parameter> is zero (the +default), then "hard coded" logic within the DocBook XSL stylesheets +is used for gathering <tag>refentry</tag> "date" data.</para> + +<para>If you find that the default <tag>refentry</tag> +metadata-gathering behavior is causing incorrect "date" data to show +up in your output, then consider setting a non-zero value for +<parameter>refentry.date.profile.enabled</parameter> and adjusting the +value of <parameter>refentry.date.profile</parameter> to cause correct +data to be gathered. </para> + +<para>Note that the terms "source" and "date" have special meanings in +this context. For details, see the documentation for the +<parameter>refentry.date.profile</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.date.profile.xml b/params/refentry.date.profile.xml new file mode 100644 index 0000000..1220ed0 --- /dev/null +++ b/params/refentry.date.profile.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.date.profile"> +<refmeta> +<refentrytitle>refentry.date.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.date.profile</refname> +<refpurpose>Specifies profile for refentry "date" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.date.profile.frag"> +<xsl:param name="refentry.date.profile"> + (($info[//date])[last()]/date)[1]| + (($info[//pubdate])[last()]/pubdate)[1] +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of <parameter>refentry.date.profile</parameter> is a +string representing an XPath expression. It is evaluated at run-time +and used only if <parameter>refentry.date.profile.enabled</parameter> +is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering +logic "hard coded" into the stylesheets is used.</para> + +<para> The <literal>man(7)</literal> man page describes this content +as "the date of the last revision". In man pages, it is the content +that is usually displayed in the center footer.</para> + +</refsection> +</refentry> diff --git a/params/refentry.generate.name.xml b/params/refentry.generate.name.xml new file mode 100644 index 0000000..f59e6d5 --- /dev/null +++ b/params/refentry.generate.name.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.generate.name"> +<refmeta> +<refentrytitle>refentry.generate.name</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.name</refname> +<refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.generate.name.frag"> +<xsl:param name="refentry.generate.name" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, a "NAME" section title is output before the list +of <tag>refname</tag>s. This parameter and +<parameter>refentry.generate.title</parameter> are mutually +exclusive. This means that if you change this parameter to zero, you +should set <parameter>refentry.generate.title</parameter> to non-zero unless +you want get quite strange output. +</para> + +</refsection> +</refentry> diff --git a/params/refentry.generate.title.xml b/params/refentry.generate.title.xml new file mode 100644 index 0000000..8029b20 --- /dev/null +++ b/params/refentry.generate.title.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.generate.title"> +<refmeta> +<refentrytitle>refentry.generate.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.title</refname> +<refpurpose>Output title before <tag>refname</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.generate.title.frag"> +<xsl:param name="refentry.generate.title" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the reference page title or first name is +output before the list of <tag>refname</tag>s. This parameter and +<parameter>refentry.generate.name</parameter> are mutually exclusive. +This means that if you change this parameter to non-zero, you +should set <parameter>refentry.generate.name</parameter> to zero unless +you want get quite strange output.</para> + + +</refsection> +</refentry> diff --git a/params/refentry.manual.fallback.profile.xml b/params/refentry.manual.fallback.profile.xml new file mode 100644 index 0000000..6362785 --- /dev/null +++ b/params/refentry.manual.fallback.profile.xml @@ -0,0 +1,48 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.manual.fallback.profile"> +<refmeta> +<refentrytitle>refentry.manual.fallback.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.manual.fallback.profile</refname> +<refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.manual.fallback.profile.frag"> +<xsl:param name="refentry.manual.fallback.profile"> +refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of +<parameter>refentry.manual.fallback.profile</parameter> is a string +representing an XPath expression. It is evaluated at run-time and +used only if no "manual" data can be found by other means (that is, +either using the <tag>refentry</tag> metadata-gathering logic "hard +coded" in the stylesheets, or the value of +<parameter>refentry.manual.profile</parameter>, if it is +enabled).</para> + +<important> +<para>Depending on which XSLT engine you run, either the EXSLT +<function>dyn:evaluate</function> extension function (for xsltproc or +Xalan) or <function>saxon:evaluate</function> extension function (for +Saxon) are used to dynamically evaluate the value of +<parameter>refentry.manual.fallback.profile</parameter> at +run-time. If you don't use xsltproc, Saxon, Xalan -- or some other +XSLT engine that supports <function>dyn:evaluate</function> -- you +must manually disable fallback processing by setting an empty value +for the <parameter>refentry.manual.fallback.profile</parameter> +parameter.</para> +</important> + +</refsection> +</refentry> diff --git a/params/refentry.manual.profile.enabled.xml b/params/refentry.manual.profile.enabled.xml new file mode 100644 index 0000000..a3b7b54 --- /dev/null +++ b/params/refentry.manual.profile.enabled.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.manual.profile.enabled"> +<refmeta> +<refentrytitle>refentry.manual.profile.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.manual.profile.enabled</refname> +<refpurpose>Enable refentry "manual" profiling?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.manual.profile.enabled.frag"> +<xsl:param name="refentry.manual.profile.enabled">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>refentry.manual.profile.enabled</parameter> is +non-zero, then during <tag>refentry</tag> metadata gathering, the info +profile specified by the customizable +<parameter>refentry.manual.profile</parameter> parameter is +used.</para> + +<para>If instead the value of +<parameter>refentry.manual.profile.enabled</parameter> is zero (the +default), then "hard coded" logic within the DocBook XSL stylesheets +is used for gathering <tag>refentry</tag> "manual" data.</para> + +<para>If you find that the default <tag>refentry</tag> +metadata-gathering behavior is causing incorrect "manual" data to show +up in your output, then consider setting a non-zero value for +<parameter>refentry.manual.profile.enabled</parameter> and adjusting +the value of <parameter>refentry.manual.profile</parameter> to cause +correct data to be gathered. </para> + +<para>Note that the term "manual" has a special meanings in this +context. For details, see the documentation for the +<parameter>refentry.manual.profile</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.manual.profile.xml b/params/refentry.manual.profile.xml new file mode 100644 index 0000000..214b170 --- /dev/null +++ b/params/refentry.manual.profile.xml @@ -0,0 +1,72 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.manual.profile"> +<refmeta> +<refentrytitle>refentry.manual.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.manual.profile</refname> +<refpurpose>Specifies profile for refentry "manual" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.manual.profile.frag"> +<xsl:param name="refentry.manual.profile"> + (($info[//title])[last()]/title)[1]| + ../title/node() +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of <parameter>refentry.manual.profile</parameter> is +a string representing an XPath expression. It is evaluated at +run-time and used only if +<parameter>refentry.manual.profile.enabled</parameter> is +non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic +"hard coded" into the stylesheets is used.</para> + +<para>In man pages, this content is usually displayed in the middle of +the header of the page. The <literal>man(7)</literal> man page +describes this as "the title of the manual (e.g., <citetitle>Linux +Programmer's Manual</citetitle>)". Here are some examples from +existing man pages: +<itemizedlist> + <listitem> + <para><citetitle>dpkg utilities</citetitle> + (<command>dpkg-name</command>)</para> + </listitem> + <listitem> + <para><citetitle>User Contributed Perl Documentation</citetitle> + (<command>GET</command>)</para> + </listitem> + <listitem> + <para><citetitle>GNU Development Tools</citetitle> + (<command>ld</command>)</para> + </listitem> + <listitem> + <para><citetitle>Emperor Norton Utilities</citetitle> + (<command>ddate</command>)</para> + </listitem> + <listitem> + <para><citetitle>Debian GNU/Linux manual</citetitle> + (<command>faked</command>)</para> + </listitem> + <listitem> + <para><citetitle>GIMP Manual Pages</citetitle> + (<command>gimp</command>)</para> + </listitem> + <listitem> + <para><citetitle>KDOC Documentation System</citetitle> + (<command>qt2kdoc</command>)</para> + </listitem> +</itemizedlist> +</para> + +</refsection> +</refentry> diff --git a/params/refentry.meta.get.quietly.xml b/params/refentry.meta.get.quietly.xml new file mode 100644 index 0000000..0ed29f6 --- /dev/null +++ b/params/refentry.meta.get.quietly.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.meta.get.quietly"> +<refmeta> +<refentrytitle>refentry.meta.get.quietly</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.meta.get.quietly</refname> +<refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.meta.get.quietly.frag"> +<xsl:param name="refentry.meta.get.quietly" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If zero (the default), notes and warnings about “missing” markup +are generated during gathering of refentry metadata. If non-zero, the +metadata is gathered “quietly” -- that is, the notes and warnings are +suppressed.</para> + +<tip> + <para>If you are processing a large amount of <tag>refentry</tag> + content, you may be able to speed up processing significantly by + setting a non-zero value for + <parameter>refentry.meta.get.quietly</parameter>.</para> +</tip> + +</refsection> +</refentry> diff --git a/params/refentry.pagebreak.xml b/params/refentry.pagebreak.xml new file mode 100644 index 0000000..42b8466 --- /dev/null +++ b/params/refentry.pagebreak.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.pagebreak"> +<refmeta> +<refentrytitle>refentry.pagebreak</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.pagebreak</refname> +<refpurpose>Start each refentry on a new page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.pagebreak.frag"><xsl:param name="refentry.pagebreak" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (the default), each <tag>refentry</tag> +element will start on a new page. If zero, a page +break will not be generated between <tag>refentry</tag> elements. +The exception is when the <tag>refentry</tag> elements are children of +a <tag>part</tag> element, in which case the page breaks are always +retained. That is because a <tag>part</tag> element does not generate +a page-sequence for its children, so each <tag>refentry</tag> must +start its own page-sequence. +</para> + +</refsection> +</refentry> diff --git a/params/refentry.separator.xml b/params/refentry.separator.xml new file mode 100644 index 0000000..a7eeb84 --- /dev/null +++ b/params/refentry.separator.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.separator"> +<refmeta> +<refentrytitle>refentry.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.separator</refname> +<refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.separator.frag"> +<xsl:param name="refentry.separator" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true, a separator will be generated between consecutive +reference pages. +</para> + +</refsection> +</refentry> diff --git a/params/refentry.source.fallback.profile.xml b/params/refentry.source.fallback.profile.xml new file mode 100644 index 0000000..1761378 --- /dev/null +++ b/params/refentry.source.fallback.profile.xml @@ -0,0 +1,49 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.source.fallback.profile"> +<refmeta> +<refentrytitle>refentry.source.fallback.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.source.fallback.profile</refname> +<refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.source.fallback.profile.frag"> +<xsl:param name="refentry.source.fallback.profile"> +refmeta/refmiscinfo[not(@class = 'date')][1]/node()</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of +<parameter>refentry.source.fallback.profile</parameter> is a string +representing an XPath expression. It is evaluated at run-time and used +only if no "source" data can be found by other means (that is, either +using the <tag>refentry</tag> metadata-gathering logic "hard coded" in +the stylesheets, or the value of the +<parameter>refentry.source.name.profile</parameter> and +<parameter>refentry.version.profile</parameter> parameters, if those +are enabled).</para> + +<important> +<para>Depending on which XSLT engine you run, either the EXSLT +<function>dyn:evaluate</function> extension function (for xsltproc or +Xalan) or <function>saxon:evaluate</function> extension function (for +Saxon) are used to dynamically evaluate the value of +<parameter>refentry.source.fallback.profile</parameter> at +run-time. If you don't use xsltproc, Saxon, Xalan -- or some other +XSLT engine that supports <function>dyn:evaluate</function> -- you +must manually disable fallback processing by setting an empty value +for the <parameter>refentry.source.fallback.profile</parameter> +parameter.</para> +</important> + +</refsection> +</refentry> diff --git a/params/refentry.source.name.profile.enabled.xml b/params/refentry.source.name.profile.enabled.xml new file mode 100644 index 0000000..f87ec0f --- /dev/null +++ b/params/refentry.source.name.profile.enabled.xml @@ -0,0 +1,48 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.source.name.profile.enabled"> +<refmeta> +<refentrytitle>refentry.source.name.profile.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.source.name.profile.enabled</refname> +<refpurpose>Enable refentry "source name" profiling?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.source.name.profile.enabled.frag"> +<xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>refentry.source.name.profile.enabled</parameter> is +non-zero, then during <tag>refentry</tag> metadata gathering, the info +profile specified by the customizable +<parameter>refentry.source.name.profile</parameter> parameter is +used.</para> + +<para>If instead the value of +<parameter>refentry.source.name.profile.enabled</parameter> is zero (the +default), then "hard coded" logic within the DocBook XSL stylesheets +is used for gathering <tag>refentry</tag> "source name" data.</para> + +<para>If you find that the default <tag>refentry</tag> +metadata-gathering behavior is causing incorrect "source name" data to +show up in your output, then consider setting a non-zero value for +<parameter>refentry.source.name.profile.enabled</parameter> and +adjusting the value of +<parameter>refentry.source.name.profile</parameter> to cause correct +data to be gathered. </para> + +<para>Note that the terms "source" and "source name" have special +meanings in this context. For details, see the documentation for the +<parameter>refentry.source.name.profile</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.source.name.profile.xml b/params/refentry.source.name.profile.xml new file mode 100644 index 0000000..c9a1012 --- /dev/null +++ b/params/refentry.source.name.profile.xml @@ -0,0 +1,89 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.source.name.profile"> +<refmeta> +<refentrytitle>refentry.source.name.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.source.name.profile</refname> +<refpurpose>Specifies profile for refentry "source name" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.source.name.profile.frag"> +<xsl:param name="refentry.source.name.profile"> + (($info[//productname])[last()]/productname)[1]| + (($info[//corpname])[last()]/corpname)[1]| + (($info[//corpcredit])[last()]/corpcredit)[1]| + (($info[//corpauthor])[last()]/corpauthor)[1]| + (($info[//orgname])[last()]/orgname)[1]| + (($info[//publishername])[last()]/publishername)[1] +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of <parameter>refentry.source.name.profile</parameter> +is a string representing an XPath expression. It is evaluated at +run-time and used only if +<parameter>refentry.source.name.profile.enabled</parameter> is +non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic +"hard coded" into the stylesheets is used.</para> + +<para>A "source name" is one part of a (potentially) two-part +<replaceable>Name</replaceable> <replaceable>Version</replaceable> +"source" field. In man pages, it is usually displayed in the left +footer of the page. It typically indicates the software system or +product that the item documented in the man page belongs to. The +<literal>man(7)</literal> man page describes it as "the source of +the command", and provides the following examples: +<itemizedlist> + <listitem> + <para>For binaries, use something like: GNU, NET-2, SLS + Distribution, MCC Distribution.</para> + </listitem> + <listitem> + <para>For system calls, use the version of the kernel that you + are currently looking at: Linux 0.99.11.</para> + </listitem> + <listitem> + <para>For library calls, use the source of the function: GNU, BSD + 4.3, Linux DLL 4.4.1.</para> + </listitem> +</itemizedlist> +</para> + +<para>In practice, there are many pages that simply have a Version +number in the "source" field. So, it looks like what we have is a +two-part field, +<replaceable>Name</replaceable> <replaceable>Version</replaceable>, +where: +<variablelist> + <varlistentry> + <term>Name</term> + <listitem> + <para>product name (e.g., BSD) or org. name (e.g., GNU)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Version</term> + <listitem> + <para>version number</para> + </listitem> + </varlistentry> +</variablelist> +Each part is optional. If the <replaceable>Name</replaceable> is a +product name, then the <replaceable>Version</replaceable> is probably +the version of the product. Or there may be no +<replaceable>Name</replaceable>, in which case, if there is a +<replaceable>Version</replaceable>, it is probably the version +of the item itself, not the product it is part of. Or, if the +<replaceable>Name</replaceable> is an organization name, then there +probably will be no <replaceable>Version</replaceable>.</para> +</refsection> +</refentry> diff --git a/params/refentry.source.name.suppress.xml b/params/refentry.source.name.suppress.xml new file mode 100644 index 0000000..b29127e --- /dev/null +++ b/params/refentry.source.name.suppress.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.source.name.suppress"> +<refmeta> +<refentrytitle>refentry.source.name.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.source.name.suppress</refname> +<refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.source.name.suppress.frag"> +<xsl:param name="refentry.source.name.suppress">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>refentry.source.name.suppress</parameter> is non-zero, then +during <tag>refentry</tag> metadata gathering, no "source name" data +is added to the <tag>refentry</tag> "source" contents. Instead (unless +<parameter>refentry.version.suppress</parameter> is also non-zero), +only "version" data is added to the "source" contents.</para> + +<para>If you find that the <tag>refentry</tag> metadata gathering +mechanism is causing unwanted "source name" data to show up in your +output -- for example, in the footer (or possibly header) of a man +page -- then you might consider setting a non-zero value for +<parameter>refentry.source.name.suppress</parameter>.</para> + +<para>Note that the terms "source", "source name", and "version" have +special meanings in this context. For details, see the documentation +for the <parameter>refentry.source.name.profile</parameter> +parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.title.properties.xml b/params/refentry.title.properties.xml new file mode 100644 index 0000000..5523e5d --- /dev/null +++ b/params/refentry.title.properties.xml @@ -0,0 +1,59 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.title.properties"> +<refmeta> +<refentrytitle>refentry.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.title.properties</refname> +<refpurpose>Title properties for a refentry title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.title.properties.frag"> +<xsl:attribute-set name="refentry.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.fontset"/> + </xsl:attribute> + <xsl:attribute name="font-size">18pt</xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="space-after">1em</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute> + <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute> + <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"/></xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Formatting properties applied to the title generated for the +<tag>refnamediv</tag> part of output for +<tag>refentry</tag> when the value of the +<parameter>refentry.generate.title</parameter> parameter is +non-zero. The font size is supplied by the appropriate <parameter>section.level<replaceable>X</replaceable>.title.properties</parameter> +attribute-set, computed from the location of the +<tag>refentry</tag> in the section hierarchy.</para> + +<note> + <para>This parameter has no effect on the the title generated for + the <tag>refnamediv</tag> part of output for + <tag>refentry</tag> when the value of the + <parameter>refentry.generate.name</parameter> parameter is + non-zero. By default, that title is formatted with the same + properties as the titles for all other first-level children of + <tag>refentry</tag>.</para> +</note> + +</refsection> +</refentry> diff --git a/params/refentry.version.profile.enabled.xml b/params/refentry.version.profile.enabled.xml new file mode 100644 index 0000000..3b95bbe --- /dev/null +++ b/params/refentry.version.profile.enabled.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.version.profile.enabled"> +<refmeta> +<refentrytitle>refentry.version.profile.enabled</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.version.profile.enabled</refname> +<refpurpose>Enable refentry "version" profiling?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.version.profile.enabled.frag"> +<xsl:param name="refentry.version.profile.enabled">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of +<parameter>refentry.version.profile.enabled</parameter> is +non-zero, then during <tag>refentry</tag> metadata gathering, the info +profile specified by the customizable +<parameter>refentry.version.profile</parameter> parameter is +used.</para> + +<para>If instead the value of +<parameter>refentry.version.profile.enabled</parameter> is zero (the +default), then "hard coded" logic within the DocBook XSL stylesheets +is used for gathering <tag>refentry</tag> "version" data.</para> + +<para>If you find that the default <tag>refentry</tag> +metadata-gathering behavior is causing incorrect "version" data to show +up in your output, then consider setting a non-zero value for +<parameter>refentry.version.profile.enabled</parameter> and adjusting +the value of <parameter>refentry.version.profile</parameter> to cause +correct data to be gathered. </para> + +<para>Note that the terms "source" and "version" have special +meanings in this context. For details, see the documentation for the +<parameter>refentry.version.profile</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.version.profile.xml b/params/refentry.version.profile.xml new file mode 100644 index 0000000..ff85825 --- /dev/null +++ b/params/refentry.version.profile.xml @@ -0,0 +1,41 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.version.profile"> +<refmeta> +<refentrytitle>refentry.version.profile</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.version.profile</refname> +<refpurpose>Specifies profile for refentry "version" data</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.version.profile.frag"> +<xsl:param name="refentry.version.profile"> + (($info[//productnumber])[last()]/productnumber)[1]| + (($info[//edition])[last()]/edition)[1]| + (($info[//releaseinfo])[last()]/releaseinfo)[1] +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of <parameter>refentry.version.profile</parameter> is +a string representing an XPath expression. It is evaluated at +run-time and used only if +<parameter>refentry.version.profile.enabled</parameter> is +non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic +"hard coded" into the stylesheets is used.</para> + +<para>A "source.name" is one part of a (potentially) two-part +<replaceable>Name</replaceable> <replaceable>Version</replaceable> +"source" field. For more details, see the documentation for the +<parameter>refentry.source.name.profile</parameter> parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.version.suppress.xml b/params/refentry.version.suppress.xml new file mode 100644 index 0000000..b701ad8 --- /dev/null +++ b/params/refentry.version.suppress.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.version.suppress"> +<refmeta> +<refentrytitle>refentry.version.suppress</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.version.suppress</refname> +<refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.version.suppress.frag"> +<xsl:param name="refentry.version.suppress">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the value of <parameter>refentry.version.suppress</parameter> +is non-zero, then during <tag>refentry</tag> metadata gathering, no +"version" data is added to the <tag>refentry</tag> "source" +contents. Instead (unless +<parameter>refentry.source.name.suppress</parameter> is also +non-zero), only "source name" data is added to the "source" +contents.</para> + +<para>If you find that the <tag>refentry</tag> metadata gathering +mechanism is causing unwanted "version" data to show up in your output +-- for example, in the footer (or possibly header) of a man page -- +then you might consider setting a non-zero value for +<parameter>refentry.version.suppress</parameter>.</para> + +<para>Note that the terms "source", "source name", and "version" have +special meanings in this context. For details, see the documentation +for the <parameter>refentry.source.name.profile</parameter> +parameter.</para> + +</refsection> +</refentry> diff --git a/params/refentry.xref.manvolnum.xml b/params/refentry.xref.manvolnum.xml new file mode 100644 index 0000000..56b93b7 --- /dev/null +++ b/params/refentry.xref.manvolnum.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="refentry.xref.manvolnum"> +<refmeta> +<refentrytitle>refentry.xref.manvolnum</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.xref.manvolnum</refname> +<refpurpose>Output <tag>manvolnum</tag> as part of +<tag>refentry</tag> cross-reference?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="refentry.xref.manvolnum.frag"> +<xsl:param name="refentry.xref.manvolnum" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing +<tag>refentry</tag>s, either with <tag>xref</tag> +or <tag>citerefentry</tag>. +</para> + +</refsection> +</refentry> diff --git a/params/reference.autolabel.xml b/params/reference.autolabel.xml new file mode 100644 index 0000000..1a9dc5b --- /dev/null +++ b/params/reference.autolabel.xml @@ -0,0 +1,67 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="reference.autolabel"> +<refmeta> +<refentrytitle>reference.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>reference.autolabel</refname> +<refpurpose>Specifies the labeling format for Reference titles</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="reference.autolabel.frag"> + <xsl:param name="reference.autolabel">I</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>If non-zero, references will be numbered using the parameter + value as the number format if the value matches one of the + following: +</para> +<variablelist> + <varlistentry> + <term>1 or arabic</term> + <listitem> + <para>Arabic numeration (1, 2, 3 ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A or upperalpha</term> + <listitem> + <para>Uppercase letter numeration (A, B, C ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a or loweralpha</term> + <listitem> + <para>Lowercase letter numeration (a, b, c ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>I or upperroman</term> + <listitem> + <para>Uppercase roman numeration (I, II, III ...).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i or lowerroman</term> + <listitem> + <para>Lowercase roman letter numeration (i, ii, iii ...).</para> + </listitem> + </varlistentry> +</variablelist> +<para>Any non-zero value other than the above will generate +the default number format (upperroman). +</para> +</refsection> +</refentry> diff --git a/params/region.after.extent.xml b/params/region.after.extent.xml new file mode 100644 index 0000000..b29abba --- /dev/null +++ b/params/region.after.extent.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.after.extent"> +<refmeta> +<refentrytitle>region.after.extent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.after.extent</refname> +<refpurpose>Specifies the height of the footer.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.after.extent.frag"> +<xsl:param name="region.after.extent">0.4in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The region after extent is the height of the area where footers +are printed. +</para> + +</refsection> +</refentry> diff --git a/params/region.before.extent.xml b/params/region.before.extent.xml new file mode 100644 index 0000000..c62cc40 --- /dev/null +++ b/params/region.before.extent.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.before.extent"> +<refmeta> +<refentrytitle>region.before.extent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.before.extent</refname> +<refpurpose>Specifies the height of the header</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.before.extent.frag"> +<xsl:param name="region.before.extent">0.4in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The region before extent is the height of the area where headers +are printed. +</para> + +</refsection> +</refentry> diff --git a/params/region.inner.extent.xml b/params/region.inner.extent.xml new file mode 100644 index 0000000..48792a2 --- /dev/null +++ b/params/region.inner.extent.xml @@ -0,0 +1,51 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.inner.extent"> +<refmeta> +<refentrytitle>region.inner.extent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.inner.extent</refname> +<refpurpose>Specifies the width of the inner side region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.inner.extent.frag"> +<xsl:param name="region.inner.extent">0in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The region inner extent is the width of the optional +text area next to the inner side (binding side) of the +body region. </para> + +<para>For double-sided output, this side region +is <literal>fo:region-start</literal> on a odd-numbered page, +and <literal>fo:region-end</literal> on an even-numbered page.</para> + +<para>For single-sided output, this side region +is <literal>fo:region-start</literal> for all pages.</para> + +<para>This correspondence applies to all languages, +both left-to-right and right-to-left writing modes.</para> + +<para>The default value of this parameter is zero. If you enlarge this extent, +be sure to also enlarge the <parameter>body.margin.inner</parameter> +parameter to make room for its content, otherwise any text in +the side region may overlap with the body text.</para> + +<para>See also +<parameter>region.outer.extent</parameter>, +<parameter>body.margin.inner</parameter>, +<parameter>body.margin.outer</parameter>, +<parameter>side.region.precedence</parameter>. +</para> + +</refsection> +</refentry> diff --git a/params/region.inner.properties.xml b/params/region.inner.properties.xml new file mode 100644 index 0000000..44e8bb4 --- /dev/null +++ b/params/region.inner.properties.xml @@ -0,0 +1,51 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.inner.properties"> +<refmeta> +<refentrytitle>region.inner.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.inner.properties</refname> +<refpurpose>Properties of running inner side region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.inner.properties.frag"> +<xsl:attribute-set name="region.inner.properties"> + <xsl:attribute name="border-width">0</xsl:attribute> + <xsl:attribute name="padding">0</xsl:attribute> + <xsl:attribute name="reference-orientation">90</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The FO stylesheet supports optional side regions +similar to the header and footer regions. +Any attributes declared in this attribute-set +are applied to the region element in the page master +on the inner side (binding side) of the page. +This corresponds to <literal><fo:regin-start></literal> +on odd-numbered pages and <literal><fo:region-end></literal> +on even-numbered pages. +For single-sided output, it always corresponds to +<literal><fo:regin-start></literal>.</para> + +<para>You can customize the template named +<literal>inner.region.content</literal> to specify +the content of the inner side region.</para> + +<para>See also +<parameter>inner.region.content.properties</parameter>, +<parameter>page.margin.inner</parameter>, +<parameter>body.margin.inner</parameter>, +and the corresponding <literal>outer</literal> +parameters.</para> + +</refsection> +</refentry> diff --git a/params/region.outer.extent.xml b/params/region.outer.extent.xml new file mode 100644 index 0000000..086a3a6 --- /dev/null +++ b/params/region.outer.extent.xml @@ -0,0 +1,50 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.outer.extent"> +<refmeta> +<refentrytitle>region.outer.extent</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.outer.extent</refname> +<refpurpose>Specifies the width of the outer side region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.outer.extent.frag"> +<xsl:param name="region.outer.extent">0in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The region outer extent is the width of the optional +text area next to the outer side (opposite the binding side) of the +body region. </para> + +<para>For double-sided output, this side region +is <literal>fo:region-end</literal> on a odd-numbered page, +and <literal>fo:region-start</literal> on an even-numbered page.</para> + +<para>For single-sided output, this side region +is <literal>fo:region-end</literal> for all pages.</para> + +<para>This correspondence applies to all languages, +both left-to-right and right-to-left writing modes.</para> + +<para>The default value of this parameter is zero. If you enlarge this extent, +be sure to also enlarge the <parameter>body.margin.outer</parameter> +parameter to make room for its content, otherwise any text in +the side region may overlap with the body text.</para> + +<para>See also +<parameter>region.inner.extent</parameter>, +<parameter>body.margin.inner</parameter>, +<parameter>body.margin.outer</parameter>, +<parameter>side.region.precedence</parameter>. +</para> +</refsection> +</refentry> diff --git a/params/region.outer.properties.xml b/params/region.outer.properties.xml new file mode 100644 index 0000000..1ed1c50 --- /dev/null +++ b/params/region.outer.properties.xml @@ -0,0 +1,51 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="region.outer.properties"> +<refmeta> +<refentrytitle>region.outer.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>region.outer.properties</refname> +<refpurpose>Properties of running outer side region</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="region.outer.properties.frag"> +<xsl:attribute-set name="region.outer.properties"> + <xsl:attribute name="border-width">0</xsl:attribute> + <xsl:attribute name="padding">0</xsl:attribute> + <xsl:attribute name="reference-orientation">90</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The FO stylesheet supports optional side regions +similar to the header and footer regions. +Any attributes declared in this attribute-set +are applied to the region element in the page master +on the outer side (opposite the binding side) of the page. +This corresponds to <literal><fo:regin-start></literal> +on odd-numbered pages and <literal><fo:region-end></literal> +on even-numbered pages. +For single-sided output, it always corresponds to +<literal><fo:regin-start></literal>.</para> + +<para>You can customize the template named +<literal>outer.region.content</literal> to specify +the content of the outer side region.</para> + +<para>See also +<parameter>outer.region.content.properties</parameter>, +<parameter>page.margin.outer</parameter>, +<parameter>body.margin.outer</parameter>, +and the corresponding <literal>inner</literal> +parameters.</para> + +</refsection> +</refentry> diff --git a/params/revhistory.table.cell.properties.xml b/params/revhistory.table.cell.properties.xml new file mode 100644 index 0000000..49c4037 --- /dev/null +++ b/params/revhistory.table.cell.properties.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="revhistory.table.cell.properties"> +<refmeta> +<refentrytitle>revhistory.table.cell.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>revhistory.table.cell.properties</refname> +<refpurpose>The properties of table cells used for formatting revhistory</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="revhistory.table.cell.properties.frag"> +<xsl:attribute-set name="revhistory.table.cell.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This property set defines appearance of individual cells in revhistory table.</para> + +</refsection> +</refentry> diff --git a/params/revhistory.table.properties.xml b/params/revhistory.table.properties.xml new file mode 100644 index 0000000..43116d0 --- /dev/null +++ b/params/revhistory.table.properties.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="revhistory.table.properties"> +<refmeta> +<refentrytitle>revhistory.table.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>revhistory.table.properties</refname> +<refpurpose>The properties of table used for formatting revhistory</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="revhistory.table.properties.frag"> +<xsl:attribute-set name="revhistory.table.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This property set defines appearance of revhistory table.</para> + +</refsection> +</refentry> diff --git a/params/revhistory.title.properties.xml b/params/revhistory.title.properties.xml new file mode 100644 index 0000000..f97d646 --- /dev/null +++ b/params/revhistory.title.properties.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="revhistory.title.properties"> +<refmeta> +<refentrytitle>revhistory.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>revhistory.title.properties</refname> +<refpurpose>The properties of revhistory title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="revhistory.title.properties.frag"> +<xsl:attribute-set name="revhistory.title.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This property set defines appearance of revhistory title.</para> + +</refsection> +</refentry> diff --git a/params/root.filename.xml b/params/root.filename.xml new file mode 100644 index 0000000..ae5ca5b --- /dev/null +++ b/params/root.filename.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="root.filename"> +<refmeta> +<refentrytitle>root.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>root.filename</refname> +<refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="root.filename.frag"> +<xsl:param name="root.filename">index</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>root.filename</parameter> is the base filename for +the chunk created for the root of each document processed. +</para> + +</refsection> +</refentry> diff --git a/params/root.properties.xml b/params/root.properties.xml new file mode 100644 index 0000000..26c9951 --- /dev/null +++ b/params/root.properties.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="root.properties"> +<refmeta> +<refentrytitle>root.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>root.properties</refname> +<refpurpose>The properties of the fo:root element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="root.properties.frag"> +<xsl:attribute-set name="root.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.size"/> + </xsl:attribute> + <xsl:attribute name="text-align"> + <xsl:value-of select="$alignment"/> + </xsl:attribute> + <xsl:attribute name="line-height"> + <xsl:value-of select="$line-height"/> + </xsl:attribute> + <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute> + <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute> + <xsl:attribute name="writing-mode"> + <xsl:value-of select="$direction.mode"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This property set is used on the <tag>fo:root</tag> element of +an FO file. It defines a set of default, global parameters.</para> + +</refsection> +</refentry> diff --git a/params/rootid.xml b/params/rootid.xml new file mode 100644 index 0000000..a0715af --- /dev/null +++ b/params/rootid.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="rootid"> +<refmeta> +<refentrytitle>rootid</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>rootid</refname> +<refpurpose>Specify the root element to format</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="rootid.frag"> +<xsl:param name="rootid" ></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>rootid</parameter> is not empty, it must be the +value of an ID that occurs in the document being formatted. The entire +document will be loaded and parsed, but formatting will begin at the +element identified, rather than at the root. For example, this allows +you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para> +<para>Because the entire document is available to the processor, automatic +numbering, cross references, and other dependencies are correctly +resolved.</para> + +</refsection> +</refentry> diff --git a/params/runinhead.default.title.end.punct.xml b/params/runinhead.default.title.end.punct.xml new file mode 100644 index 0000000..d151e8b --- /dev/null +++ b/params/runinhead.default.title.end.punct.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="runinhead.default.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.default.title.end.punct</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.default.title.end.punct</refname> +<refpurpose>Default punctuation character on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="runinhead.default.title.end.punct.frag"><xsl:param name="runinhead.default.title.end.punct">.</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, For a <tag>formalpara</tag>, use the specified +string as the separator between the title and following text. The period is the default value.</para> + +</refsection> +</refentry> diff --git a/params/runinhead.title.end.punct.xml b/params/runinhead.title.end.punct.xml new file mode 100644 index 0000000..025aeed --- /dev/null +++ b/params/runinhead.title.end.punct.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="runinhead.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.title.end.punct</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.title.end.punct</refname> +<refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="runinhead.title.end.punct.frag"> +<xsl:param name="runinhead.title.end.punct">.!?:</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specify which characters are to be counted as punctuation. These +characters are checked for a match with the last character of the +title. If no match is found, the +<parameter>runinhead.default.title.end.punct</parameter> contents are +inserted. This is to avoid duplicated punctuation in the output. +</para> + +</refsection> +</refentry> diff --git a/params/running.foot.properties.xml b/params/running.foot.properties.xml new file mode 100644 index 0000000..ee98592 --- /dev/null +++ b/params/running.foot.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="running.foot.properties"> +<refmeta> +<refentrytitle>running.foot.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>running.foot.properties</refname> +<refpurpose>Specifies properties for running foot on each slide</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="running.foot.properties.frag"> + <xsl:attribute-set name="running.foot.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$slide.font.family"/> + </xsl:attribute> + <xsl:attribute name="font-size">14pt</xsl:attribute> + <xsl:attribute name="color">#9F9F9F</xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to the +running foot area of each slide.</para> + +</refsection> +</refentry> diff --git a/params/sans.font.family.xml b/params/sans.font.family.xml new file mode 100644 index 0000000..d569b12 --- /dev/null +++ b/params/sans.font.family.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sans.font.family"> +<refmeta> +<refentrytitle>sans.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sans.font.family</refname> +<refpurpose>The default sans-serif font family</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sans.font.family.frag"> +<xsl:param name="sans.font.family" >sans-serif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The default sans-serif font family. At the present, this isn't +actually used by the stylesheets. +</para> + +</refsection> +</refentry> diff --git a/params/saxon.callouts.xml b/params/saxon.callouts.xml new file mode 100644 index 0000000..e08fcdb --- /dev/null +++ b/params/saxon.callouts.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="saxon.callouts"> +<refmeta> +<refentrytitle>saxon.callouts</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.callouts</refname> +<refpurpose>Enable the callout extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="saxon.callouts.frag"> +<xsl:param name="saxon.callouts" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The callouts extension processes <tag>areaset</tag> +elements in <tag>ProgramListingCO</tag> and other text-based +callout elements. +</para> + +</refsection> +</refentry> diff --git a/params/saxon.character.representation.xml b/params/saxon.character.representation.xml new file mode 100644 index 0000000..bd8bcac --- /dev/null +++ b/params/saxon.character.representation.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="saxon.character.representation"> +<refmeta> +<refentrytitle>saxon.character.representation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.character.representation</refname> +<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="saxon.character.representation.frag"><xsl:param name="saxon.character.representation" select="'entity;decimal'"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later). +It sets the character representation in files generated by the chunking stylesheets. +If you want to suppress entity references for characters with direct representations in +<parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>. +</para> + +<para> For more information, see <link +role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsection> + +</refentry> diff --git a/params/saxon.linenumbering.xml b/params/saxon.linenumbering.xml new file mode 100644 index 0000000..451028b --- /dev/null +++ b/params/saxon.linenumbering.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="saxon.linenumbering"> +<refmeta> +<refentrytitle>saxon.linenumbering</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.linenumbering</refname> +<refpurpose>Enable the line numbering extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="saxon.linenumbering.frag"> +<xsl:param name="saxon.linenumbering" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, verbatim environments (elements that have the +format='linespecific' notation attribute: <tag>address</tag>, +<tag>literallayout</tag>, <tag>programlisting</tag>, +<tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering +will have line numbers. +</para> + +</refsection> +</refentry> diff --git a/params/saxon.tablecolumns.xml b/params/saxon.tablecolumns.xml new file mode 100644 index 0000000..e9d9674 --- /dev/null +++ b/params/saxon.tablecolumns.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="saxon.tablecolumns"> +<refmeta> +<refentrytitle>saxon.tablecolumns</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.tablecolumns</refname> +<refpurpose>Enable the table columns extension function</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="saxon.tablecolumns.frag"> +<xsl:param name="saxon.tablecolumns" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The table columns extension function adjusts the widths of table +columns in the HTML result to more accurately reflect the specifications +in the CALS table. +</para> + +</refsection> +</refentry> diff --git a/params/script.dir.xml b/params/script.dir.xml new file mode 100644 index 0000000..9cb92af --- /dev/null +++ b/params/script.dir.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="script.dir"> +<refmeta> +<refentrytitle>script.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>script.dir</refname> +<refpurpose>Script directory</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="script.dir.frag"> +<xsl:param name="script.dir"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Identifies the JavaScript source directory for the slides. +This parameter can be set in the source +document with the <?dbhtml?> pseudo-attribute +<literal>script-dir</literal>.</para> + +<para>If non-empty, this value is prepended to each of the JavaScript files. +</para> + +</refsection> +</refentry> diff --git a/params/section.autolabel.max.depth.xml b/params/section.autolabel.max.depth.xml new file mode 100644 index 0000000..e588e00 --- /dev/null +++ b/params/section.autolabel.max.depth.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.autolabel.max.depth"> +<refmeta> +<refentrytitle>section.autolabel.max.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel.max.depth</refname> +<refpurpose>The deepest level of sections that are numbered.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.autolabel.max.depth.frag"> +<xsl:param name="section.autolabel.max.depth">8</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When section numbering is turned on by the +<parameter>section.autolabel</parameter> parameter, then this +parameter controls the depth of <tag>section</tag> nesting that is +numbered. Sections nested to a level deeper than this value will not +be numbered. +</para> + +</refsection> +</refentry> diff --git a/params/section.autolabel.xml b/params/section.autolabel.xml new file mode 100644 index 0000000..85eede6 --- /dev/null +++ b/params/section.autolabel.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.autolabel"> +<refmeta> +<refentrytitle>section.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel</refname> +<refpurpose>Are sections enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.autolabel.frag"><xsl:param name="section.autolabel" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If true (non-zero), unlabeled sections will be enumerated. +</para> + +</refsection> +</refentry> diff --git a/params/section.container.element.xml b/params/section.container.element.xml new file mode 100644 index 0000000..a6c4059 --- /dev/null +++ b/params/section.container.element.xml @@ -0,0 +1,62 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.container.element"> +<refmeta> +<refentrytitle>section.container.element</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">block</refmiscinfo> +<refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.container.element</refname> +<refpurpose>Select XSL-FO element name to contain sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.container.element.frag"> +<xsl:param name="section.container.element">block</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the element name for outer container of +each section. The choices are <literal>block</literal> (default) +or <literal>wrapper</literal>. +The <literal>fo:</literal> namespace prefix is added +by the stylesheet to form the full element name. +</para> + +<para>This element receives the section <literal>id</literal> +attribute and the appropriate section level attribute-set. +</para> + +<para>Changing this parameter to <literal>wrapper</literal> +is only necessary when producing multi-column output +that contains page-wide spans. Using <literal>fo:wrapper</literal> +avoids the nesting of <literal>fo:block</literal> +elements that prevents spans from working (the standard says +a span must be on a block that is a direct child of +<literal>fo:flow</literal>). +</para> + +<para>If set to <literal>wrapper</literal>, the +section attribute-sets only support properties +that are inheritable. That's because there is no +block to apply them to. Properties such as +font-family are inheritable, but properties such as +border are not. +</para> + +<para>Only some XSL-FO processors need to use this parameter. +The Antenna House processor, for example, will handle +spans in nested blocks without changing the element name. +The RenderX XEP product and FOP follow the XSL-FO standard +and need to use <literal>wrapper</literal>. +</para> + +</refsection> +</refentry> diff --git a/params/section.label.includes.component.label.xml b/params/section.label.includes.component.label.xml new file mode 100644 index 0000000..505d472 --- /dev/null +++ b/params/section.label.includes.component.label.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.label.includes.component.label"> +<refmeta> +<refentrytitle>section.label.includes.component.label</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.label.includes.component.label</refname> +<refpurpose>Do section labels include the component label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.label.includes.component.label.frag"><xsl:param name="section.label.includes.component.label" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, section labels are prefixed with the label of the +component that contains them. +</para> + +</refsection> +</refentry> diff --git a/params/section.level1.properties.xml b/params/section.level1.properties.xml new file mode 100644 index 0000000..4aa70b0 --- /dev/null +++ b/params/section.level1.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level1.properties"> +<refmeta> +<refentrytitle>section.level1.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level1.properties</refname> +<refpurpose>Properties for level-1 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level1.properties.frag"> +<xsl:attribute-set name="section.level1.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level-1 section, and therefore apply to +the whole section. This includes <tag>sect1</tag> +elements and <tag>section</tag> elements at level 1. +</para> + +<para>For example, you could start each level-1 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level1.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.level2.properties.xml b/params/section.level2.properties.xml new file mode 100644 index 0000000..5dd76e9 --- /dev/null +++ b/params/section.level2.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level2.properties"> +<refmeta> +<refentrytitle>section.level2.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level2.properties</refname> +<refpurpose>Properties for level-2 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level2.properties.frag"> +<xsl:attribute-set name="section.level2.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level-2 section, and therefore apply to +the whole section. This includes <tag>sect2</tag> +elements and <tag>section</tag> elements at level 2. +</para> + +<para>For example, you could start each level-2 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level2.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.level3.properties.xml b/params/section.level3.properties.xml new file mode 100644 index 0000000..0bcd696 --- /dev/null +++ b/params/section.level3.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level3.properties"> +<refmeta> +<refentrytitle>section.level3.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level3.properties</refname> +<refpurpose>Properties for level-3 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level3.properties.frag"> +<xsl:attribute-set name="section.level3.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level-3 section, and therefore apply to +the whole section. This includes <tag>sect3</tag> +elements and <tag>section</tag> elements at level 3. +</para> + +<para>For example, you could start each level-3 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level3.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.level4.properties.xml b/params/section.level4.properties.xml new file mode 100644 index 0000000..1408851 --- /dev/null +++ b/params/section.level4.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level4.properties"> +<refmeta> +<refentrytitle>section.level4.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level4.properties</refname> +<refpurpose>Properties for level-4 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level4.properties.frag"> +<xsl:attribute-set name="section.level4.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level-4 section, and therefore apply to +the whole section. This includes <tag>sect4</tag> +elements and <tag>section</tag> elements at level 4. +</para> + +<para>For example, you could start each level-4 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level4.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.level5.properties.xml b/params/section.level5.properties.xml new file mode 100644 index 0000000..9093b94 --- /dev/null +++ b/params/section.level5.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level5.properties"> +<refmeta> +<refentrytitle>section.level5.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level5.properties</refname> +<refpurpose>Properties for level-5 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level5.properties.frag"> +<xsl:attribute-set name="section.level5.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level-5 section, and therefore apply to +the whole section. This includes <tag>sect5</tag> +elements and <tag>section</tag> elements at level 5. +</para> + +<para>For example, you could start each level-5 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level5.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.level6.properties.xml b/params/section.level6.properties.xml new file mode 100644 index 0000000..dda7937 --- /dev/null +++ b/params/section.level6.properties.xml @@ -0,0 +1,43 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.level6.properties"> +<refmeta> +<refentrytitle>section.level6.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level6.properties</refname> +<refpurpose>Properties for level-6 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.level6.properties.frag"> +<xsl:attribute-set name="section.level6.properties" use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of a level 6 or lower section, and therefore apply to +the whole section. This includes +<tag>section</tag> elements at level 6 and lower. +</para> + +<para>For example, you could start each level-6 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level6.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <tag>section.properties</tag> attribute set. +</para> + +</refsection> +</refentry> diff --git a/params/section.properties.xml b/params/section.properties.xml new file mode 100644 index 0000000..06acc31 --- /dev/null +++ b/params/section.properties.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.properties"> +<refmeta> +<refentrytitle>section.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.properties</refname> +<refpurpose>Properties for all section levels</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.properties.frag"> +<xsl:attribute-set name="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties that apply to the containing +block of all section levels, and therefore apply to +the whole section. +This attribute set is inherited by the +more specific attribute sets such as +<tag>section.level1.properties</tag>. +The default is empty. +</para> + +</refsection> +</refentry> diff --git a/params/section.title.level1.properties.xml b/params/section.title.level1.properties.xml new file mode 100644 index 0000000..91c63ed --- /dev/null +++ b/params/section.title.level1.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level1.properties"> +<refmeta> +<refentrytitle>section.title.level1.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level1.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level1.properties.frag"> +<xsl:attribute-set name="section.title.level1.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 2.0736"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-1 section titles.</para> + +</refsection> +</refentry> diff --git a/params/section.title.level2.properties.xml b/params/section.title.level2.properties.xml new file mode 100644 index 0000000..a25648a --- /dev/null +++ b/params/section.title.level2.properties.xml @@ -0,0 +1,33 @@ + +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level2.properties"> +<refmeta> +<refentrytitle>section.title.level2.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level2.properties</refname> +<refpurpose>Properties for level-2 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level2.properties.frag"> +<xsl:attribute-set name="section.title.level2.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.728"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-2 section titles.</para> + +</refsection> +</refentry> diff --git a/params/section.title.level3.properties.xml b/params/section.title.level3.properties.xml new file mode 100644 index 0000000..a009a6e --- /dev/null +++ b/params/section.title.level3.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level3.properties"> +<refmeta> +<refentrytitle>section.title.level3.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level3.properties</refname> +<refpurpose>Properties for level-3 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level3.properties.frag"> +<xsl:attribute-set name="section.title.level3.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.44"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-3 section titles.</para> + +</refsection> +</refentry> diff --git a/params/section.title.level4.properties.xml b/params/section.title.level4.properties.xml new file mode 100644 index 0000000..00d4398 --- /dev/null +++ b/params/section.title.level4.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level4.properties"> +<refmeta> +<refentrytitle>section.title.level4.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level4.properties</refname> +<refpurpose>Properties for level-4 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level4.properties.frag"> +<xsl:attribute-set name="section.title.level4.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.2"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-4 section titles.</para> + +</refsection> +</refentry> diff --git a/params/section.title.level5.properties.xml b/params/section.title.level5.properties.xml new file mode 100644 index 0000000..c25b5ef --- /dev/null +++ b/params/section.title.level5.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level5.properties"> +<refmeta> +<refentrytitle>section.title.level5.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level5.properties</refname> +<refpurpose>Properties for level-5 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level5.properties.frag"> +<xsl:attribute-set name="section.title.level5.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-5 section titles.</para> + +</refsection> +</refentry> diff --git a/params/section.title.level6.properties.xml b/params/section.title.level6.properties.xml new file mode 100644 index 0000000..a2a0feb --- /dev/null +++ b/params/section.title.level6.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.level6.properties"> +<refmeta> +<refentrytitle>section.title.level6.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level6.properties</refname> +<refpurpose>Properties for level-6 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.level6.properties.frag"> +<xsl:attribute-set name="section.title.level6.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties of level-6 section titles. This property set is actually +used for all titles below level 5.</para> + +</refsection> +</refentry> diff --git a/params/section.title.properties.xml b/params/section.title.properties.xml new file mode 100644 index 0000000..1317da1 --- /dev/null +++ b/params/section.title.properties.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="section.title.properties"> +<refmeta> +<refentrytitle>section.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.properties</refname> +<refpurpose>Properties for section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="section.title.properties.frag"> +<xsl:attribute-set name="section.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.fontset"/> + </xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <!-- font size is calculated dynamically by section.heading template --> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="start-indent"><xsl:value-of select="$title.margin.left"/></xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The properties common to all section titles.</para> + +</refsection> +</refentry> diff --git a/params/segmentedlist.as.table.xml b/params/segmentedlist.as.table.xml new file mode 100644 index 0000000..fb2c236 --- /dev/null +++ b/params/segmentedlist.as.table.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="segmentedlist.as.table"> +<refmeta> +<refentrytitle>segmentedlist.as.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>segmentedlist.as.table</refname> +<refpurpose>Format segmented lists as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="segmentedlist.as.table.frag"> +<xsl:param name="segmentedlist.as.table" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>segmentedlist</tag>s will be formatted as +tables.</para> + +</refsection> +</refentry> diff --git a/params/sequential.links.xml b/params/sequential.links.xml new file mode 100644 index 0000000..293827d --- /dev/null +++ b/params/sequential.links.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sequential.links"> +<refmeta> +<refentrytitle>sequential.links</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sequential.links</refname> +<refpurpose>Make sequentional links?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sequential.links.frag"> +<xsl:param name="sequential.links" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>FIXME</para> +</refsection> +</refentry> diff --git a/params/shade.verbatim.style.xml b/params/shade.verbatim.style.xml new file mode 100644 index 0000000..0907806 --- /dev/null +++ b/params/shade.verbatim.style.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="shade.verbatim.style"> +<refmeta> +<refentrytitle>shade.verbatim.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim.style</refname> +<refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="shade.verbatim.style.frag"> +<xsl:attribute-set condition="html" name="shade.verbatim.style"> + <xsl:attribute name="border">0</xsl:attribute> + <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> +</xsl:attribute-set> +<xsl:attribute-set condition="fo" name="shade.verbatim.style"> + <xsl:attribute name="background-color">#E0E0E0</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties that specify the style of shaded verbatim listings. The +parameters specified (the border and background color) are added to +the styling of the xsl-fo output. A border might be specified as "thin +black solid" for example. See <link xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para> + +</refsection> +</refentry> diff --git a/params/shade.verbatim.xml b/params/shade.verbatim.xml new file mode 100644 index 0000000..82a7216 --- /dev/null +++ b/params/shade.verbatim.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="shade.verbatim"> +<refmeta> +<refentrytitle>shade.verbatim</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim</refname> +<refpurpose>Should verbatim environments be shaded?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In the FO stylesheet, if this parameter is non-zero then the +<property>shade.verbatim.style</property> properties will be applied +to verbatim environments.</para> + +<para>In the HTML stylesheet, this parameter is now deprecated. Use +CSS instead.</para> + +</refsection> +</refentry> diff --git a/params/show.comments.xml b/params/show.comments.xml new file mode 100644 index 0000000..ac7bc24 --- /dev/null +++ b/params/show.comments.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="show.comments"> +<refmeta> +<refentrytitle>show.comments</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.comments</refname> +<refpurpose>Display <tag>remark</tag> elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="show.comments.frag"> +<xsl:param name="show.comments" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, comments will be displayed, otherwise they +are suppressed. Comments here refers to the <tag>remark</tag> element +(which was called <literal>comment</literal> prior to DocBook +4.0), not XML comments (<-- like this -->) which are +unavailable. +</para> + +</refsection> +</refentry> diff --git a/params/show.foil.number.xml b/params/show.foil.number.xml new file mode 100644 index 0000000..627c6a7 --- /dev/null +++ b/params/show.foil.number.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="show.foil.number"> +<refmeta> +<refentrytitle>show.foil.number</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.foil.number</refname> +<refpurpose>Show foil number on each foil?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="show.foil.number.frag"> +<xsl:param name="show.foil.number" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, on each slide there will be its number. Currently +not supported in all output formats.</para> + +</refsection> +</refentry> diff --git a/params/show.revisionflag.xml b/params/show.revisionflag.xml new file mode 100644 index 0000000..c589b01 --- /dev/null +++ b/params/show.revisionflag.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="show.revisionflag"> +<refmeta> +<refentrytitle>show.revisionflag</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.revisionflag</refname> +<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="show.revisionflag.frag"> +<xsl:param name="show.revisionflag" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets +may produce additional markup designed to allow a CSS stylesheet to +highlight elements that have specific revisionflag settings.</para> + +<para>The markup inserted will be usually be either a <span> or +<div> with an appropriate <literal>class</literal> +attribute. (The value of the class attribute will be the same as the +value of the revisionflag attribute). In some contexts, for example +tables, where extra markup would be structurally illegal, the class +attribute will be added to the appropriate container element.</para> + +<para>In general, the stylesheets only test for revisionflag in contexts +where an importing stylesheet would have to redefine whole templates. +Most of the revisionflag processing is expected to be done by another +stylesheet, for example <filename>changebars.xsl</filename>.</para> + +</refsection> +</refentry> diff --git a/params/showtoc.image.xml b/params/showtoc.image.xml new file mode 100644 index 0000000..7b1fca3 --- /dev/null +++ b/params/showtoc.image.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="showtoc.image"> +<refmeta> +<refentrytitle>showtoc.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>showtoc.image</refname> +<refpurpose>Show ToC image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="showtoc.image.frag"> +<xsl:param name="showtoc.image">showtoc.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the <quote>show ToC</quote> image. This is used +when the <link linkend="toc.hide.show">ToC hide/show</link> parameter is +enabled.</para> + +</refsection> +</refentry> diff --git a/params/side.float.properties.xml b/params/side.float.properties.xml new file mode 100644 index 0000000..0a6d904 --- /dev/null +++ b/params/side.float.properties.xml @@ -0,0 +1,50 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="side.float.properties"> +<refmeta> +<refentrytitle>side.float.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>side.float.properties</refname> +<refpurpose>Attribute set for side float container properties</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="side.float.properties.frag"> +<xsl:attribute-set name="side.float.properties"> + <xsl:attribute name="width">2in</xsl:attribute> + <xsl:attribute name="padding-start">4pt</xsl:attribute> + <xsl:attribute name="padding-end">4pt</xsl:attribute> + <xsl:attribute name="padding-top">2pt</xsl:attribute> + <xsl:attribute name="padding-bottom">2pt</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties that are applied to the +<tag class="element">fo:block-container</tag> inside of +a side float that is generated by the template named +<literal>floater</literal>. +That template generates a side float +when the <parameter>side.float.type</parameter> is set to one +of the values for a side float.</para> + +<para>If you do only <literal>left</literal> or +<literal>start</literal> side floats, you may want to set the +<literal>padding-start</literal> attribute to zero. +If you do only <literal>right</literal> or +<literal>end</literal> side floats, you may want to set the +<literal>padding-end</literal> attribute to zero. +</para> + +</refsection> +</refentry> diff --git a/params/side.region.precedence.xml b/params/side.region.precedence.xml new file mode 100644 index 0000000..e573e43 --- /dev/null +++ b/params/side.region.precedence.xml @@ -0,0 +1,56 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="side.region.precedence"> +<refmeta> +<refentrytitle>side.region.precedence</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>side.region.precedence</refname> +<refpurpose>Determines side region page layout precedence</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="side.region.precedence.frag"> +<xsl:param name="side.region.precedence">false</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>If optional side regions on a page +are established using parameters such as +<parameter>body.margin.inner</parameter>, +<parameter>region.inner.extent</parameter>, etc., then this +parameter determines what happens at the corners where the +side regions meet the header and footer regions.</para> + +<para>If the value of this parameter is <literal>true</literal>, +then the side regions have precedence and extend higher +and lower, while the header and footer regions are narrower +and fit inside the side regions.</para> + +<para>If the value of this parameter is <literal>false</literal> +(the default value), then the header and footer regions +have precedence and extend over and below the side regions. +Any value other than <literal>true</literal> or +<literal>false</literal> is taken to be <literal>false</literal>.</para> + +<para>If you need to set precedence separately for +individual regions, then you can set four +parameters that are normally internal to the stylesheet. +These four parameters are normally set based +on the value from <parameter>side.region.precedence</parameter>:</para> + +<programlisting>region.before.precedence +region.after.precedence +region.start.precedence +region.end.precedence</programlisting> + +<para>See also +<parameter>region.inner.extent</parameter>, +<parameter>region.outer.extent</parameter>, +<parameter>body.margin.inner</parameter>, +<parameter>body.margin.outer</parameter>. +</para> +</refsection> </refentry> diff --git a/params/sidebar.float.type.xml b/params/sidebar.float.type.xml new file mode 100644 index 0000000..8c6a286 --- /dev/null +++ b/params/sidebar.float.type.xml @@ -0,0 +1,90 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sidebar.float.type"> +<refmeta> +<refentrytitle>sidebar.float.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">before</refmiscinfo> +<refmiscinfo class="other" otherclass="value">left</refmiscinfo> +<refmiscinfo class="other" otherclass="value">start</refmiscinfo> +<refmiscinfo class="other" otherclass="value">right</refmiscinfo> +<refmiscinfo class="other" otherclass="value">end</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inside</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outside</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sidebar.float.type</refname> +<refpurpose>Select type of float for sidebar elements</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sidebar.float.type.frag"> +<xsl:param name="sidebar.float.type">none</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Selects the type of float for sidebar elements. +</para> +<itemizedlist> +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>none</literal></quote>, then +no float is used. +</para> +</listitem> +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>before</literal></quote>, then +the float appears at the top of the page. On some processors, +that may be the next page rather than the current page. +</para> +</listitem> + +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>left</literal></quote>, +then a left side float is used. +</para> +</listitem> + +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>start</literal></quote>, +then when the text direction is left-to-right a left side float is used. +When the text direction is right-to-left, a right side float is used. +</para> +</listitem> + +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>right</literal></quote>, +then a right side float is used. +</para> +</listitem> + +<listitem> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>end</literal></quote>, +then when the text direction is left-to-right a right side float is used. +When the text direction is right-to-left, a left side float is used. +</para> +</listitem> + +<listitem> +<para>If your XSL-FO processor supports floats positioned on the +<quote><literal>inside</literal></quote> or +<quote><literal>outside</literal></quote> +of double-sided pages, then you have those two +options for side floats as well. +</para> +</listitem> +</itemizedlist> + +</refsection> +</refentry> diff --git a/params/sidebar.float.width.xml b/params/sidebar.float.width.xml new file mode 100644 index 0000000..cb989e4 --- /dev/null +++ b/params/sidebar.float.width.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sidebar.float.width"> +<refmeta> +<refentrytitle>sidebar.float.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sidebar.float.width</refname> +<refpurpose>Set the default width for sidebars</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sidebar.float.width.frag"> +<xsl:param name="sidebar.float.width">1in</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the default width for sidebars when used as a side float. +The width determines the degree to which the sidebar block intrudes into +the text area. +</para> +<para>If <parameter>sidebar.float.type</parameter> is +<quote><literal>before</literal></quote> or +<quote><literal>none</literal></quote>, then +this parameter is ignored. +</para> + +</refsection> +</refentry> diff --git a/params/sidebar.properties.xml b/params/sidebar.properties.xml new file mode 100644 index 0000000..fc98ac0 --- /dev/null +++ b/params/sidebar.properties.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sidebar.properties"> +<refmeta> +<refentrytitle>sidebar.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sidebar.properties</refname> +<refpurpose>Attribute set for sidebar properties</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sidebar.properties.frag"> +<xsl:attribute-set name="sidebar.properties" use-attribute-sets="formal.object.properties"> + <xsl:attribute name="border-style">solid</xsl:attribute> + <xsl:attribute name="border-width">1pt</xsl:attribute> + <xsl:attribute name="border-color">black</xsl:attribute> + <xsl:attribute name="background-color">#DDDDDD</xsl:attribute> + <xsl:attribute name="padding-start">12pt</xsl:attribute> + <xsl:attribute name="padding-end">12pt</xsl:attribute> + <xsl:attribute name="padding-top">6pt</xsl:attribute> + <xsl:attribute name="padding-bottom">6pt</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.start}">0pt</xsl:attribute> + <xsl:attribute name="margin-{$direction.align.end}">0pt</xsl:attribute> +<!-- + <xsl:attribute name="margin-top">6pt</xsl:attribute> + <xsl:attribute name="margin-bottom">6pt</xsl:attribute> +--> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for sidebars.</para> + +</refsection> +</refentry> diff --git a/params/sidebar.title.properties.xml b/params/sidebar.title.properties.xml new file mode 100644 index 0000000..f1b1d51 --- /dev/null +++ b/params/sidebar.title.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="sidebar.title.properties"> +<refmeta> +<refentrytitle>sidebar.title.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sidebar.title.properties</refname> +<refpurpose>Attribute set for sidebar titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="sidebar.title.properties.frag"> +<xsl:attribute-set name="sidebar.title.properties"> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for sidebars titles.</para> + +</refsection> +</refentry> diff --git a/params/simplesect.in.toc.xml b/params/simplesect.in.toc.xml new file mode 100644 index 0000000..9bc3ab5 --- /dev/null +++ b/params/simplesect.in.toc.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="simplesect.in.toc"> +<refmeta> +<refentrytitle>simplesect.in.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>simplesect.in.toc</refname> +<refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.in.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>simplesect</tag>s will be included in the TOC. +</para> + +</refsection> +</refentry> diff --git a/params/slide.font.family.xml b/params/slide.font.family.xml new file mode 100644 index 0000000..e1c7541 --- /dev/null +++ b/params/slide.font.family.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="slide.font.family"> +<refmeta> +<refentrytitle>slide.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>slide.font.family</refname> +<refpurpose>Specifies font family to use for slide bodies</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="slide.font.family.frag"> +<xsl:param name="slide.font.family" >Helvetica</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the font family to use for slides bodies.</para> + +</refsection> +</refentry> diff --git a/params/slide.title.font.family.xml b/params/slide.title.font.family.xml new file mode 100644 index 0000000..a5a3a88 --- /dev/null +++ b/params/slide.title.font.family.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="slide.title.font.family"> +<refmeta> +<refentrytitle>slide.title.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>slide.title.font.family</refname> +<refpurpose>Specifies font family to use for slide titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="slide.title.font.family.frag"> +<xsl:param name="slide.title.font.family">Helvetica</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the font family to use for slides titles.</para> + +</refsection> +</refentry> diff --git a/params/slides.js.xml b/params/slides.js.xml new file mode 100644 index 0000000..90fffae --- /dev/null +++ b/params/slides.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="slides.js"> +<refmeta> +<refentrytitle>slides.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>slides.js</refname> +<refpurpose>Slides overlay file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="slides.js.frag"> +<xsl:param name="slides.js" >slides.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the slides JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/slides.properties.xml b/params/slides.properties.xml new file mode 100644 index 0000000..daca82c --- /dev/null +++ b/params/slides.properties.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="slides.properties"> +<refmeta> +<refentrytitle>slides.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>slides.properties</refname> +<refpurpose>Specifies properties for all slides</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="slides.properties.frag"> + <xsl:attribute-set name="slides.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$slide.font.family"/> + </xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to all slides.</para> + +</refsection> +</refentry> diff --git a/params/spacing.paras.xml b/params/spacing.paras.xml new file mode 100644 index 0000000..2f2323a --- /dev/null +++ b/params/spacing.paras.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="spacing.paras"> +<refmeta> +<refentrytitle>spacing.paras</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>spacing.paras</refname> +<refpurpose>Insert additional <p> elements for spacing?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="spacing.paras.frag"> +<xsl:param name="spacing.paras" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When non-zero, additional, empty paragraphs are inserted in +several contexts (for example, around informal figures), to create a +more pleasing visual appearance in many browsers. +</para> + +</refsection> +</refentry> diff --git a/params/speakernote.properties.xml b/params/speakernote.properties.xml new file mode 100644 index 0000000..089115a --- /dev/null +++ b/params/speakernote.properties.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="speakernote.properties"> +<refmeta> +<refentrytitle>speakernote.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>speakernote.properties</refname> +<refpurpose>Specifies properties for all speakernotes</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <src:fragment xml:id="speakernote.properties.frag"> + <xsl:attribute-set name="speakernote.properties"> + <xsl:attribute name="font-family">Times Roman</xsl:attribute> + <xsl:attribute name="font-style">italic</xsl:attribute> + <xsl:attribute name="font-size">12pt</xsl:attribute> + <xsl:attribute name="font-weight">normal</xsl:attribute> + </xsl:attribute-set> + </src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies properties that are applied to all speakernotes.</para> + +</refsection> +</refentry> diff --git a/params/subscript.properties.xml b/params/subscript.properties.xml new file mode 100644 index 0000000..d2c7711 --- /dev/null +++ b/params/subscript.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="subscript.properties"> +<refmeta> +<refentrytitle>subscript.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>subscript.properties</refname> +<refpurpose>Properties associated with subscripts</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="subscript.properties.frag"> +<xsl:attribute-set name="subscript.properties"> + <xsl:attribute name="font-size">75%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies styling properties for subscripts.</para> + +</refsection> +</refentry> diff --git a/params/superscript.properties.xml b/params/superscript.properties.xml new file mode 100644 index 0000000..ecf6af1 --- /dev/null +++ b/params/superscript.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="superscript.properties"> +<refmeta> +<refentrytitle>superscript.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>superscript.properties</refname> +<refpurpose>Properties associated with superscripts</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="superscript.properties.frag"> +<xsl:attribute-set name="superscript.properties"> + <xsl:attribute name="font-size">75%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies styling properties for superscripts.</para> + +</refsection> +</refentry> diff --git a/params/suppress.footer.navigation.xml b/params/suppress.footer.navigation.xml new file mode 100644 index 0000000..430ed97 --- /dev/null +++ b/params/suppress.footer.navigation.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="suppress.footer.navigation"> +<refmeta> +<refentrytitle>suppress.footer.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.footer.navigation</refname> +<refpurpose>Disable footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="suppress.footer.navigation.frag"><xsl:param name="suppress.footer.navigation">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, footer navigation will be suppressed.</para> + +</refsection> +</refentry> diff --git a/params/suppress.header.navigation.xml b/params/suppress.header.navigation.xml new file mode 100644 index 0000000..8fff081 --- /dev/null +++ b/params/suppress.header.navigation.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="suppress.header.navigation"> +<refmeta> +<refentrytitle>suppress.header.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.header.navigation</refname> +<refpurpose>Disable header navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="suppress.header.navigation.frag"> +<xsl:param name="suppress.header.navigation" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, header navigation will be suppressed.</para> + +</refsection> +</refentry> diff --git a/params/suppress.homepage.title.xml b/params/suppress.homepage.title.xml new file mode 100644 index 0000000..38a3306 --- /dev/null +++ b/params/suppress.homepage.title.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="suppress.homepage.title"> +<refmeta> +<refentrytitle>suppress.homepage.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.homepage.title</refname> +<refpurpose>Suppress title on homepage?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="suppress.homepage.title.frag"> +<xsl:param name="suppress.homepage.title" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>FIXME:If non-zero, the title on the homepage is suppressed?</para> +</refsection> +</refentry> diff --git a/params/suppress.navigation.xml b/params/suppress.navigation.xml new file mode 100644 index 0000000..351fc4d --- /dev/null +++ b/params/suppress.navigation.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="suppress.navigation"> +<refmeta> +<refentrytitle>suppress.navigation</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.navigation</refname> +<refpurpose>Disable header and footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="suppress.navigation.frag"> +<xsl:param name="suppress.navigation" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, header and footer navigation will be suppressed.</para> + +</refsection> +</refentry> diff --git a/params/symbol.font.family.xml b/params/symbol.font.family.xml new file mode 100644 index 0000000..8acc791 --- /dev/null +++ b/params/symbol.font.family.xml @@ -0,0 +1,45 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="symbol.font.family"> +<refmeta> +<refentrytitle>symbol.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>symbol.font.family</refname> +<refpurpose>The font families to be searched for symbols outside + of the body font</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="symbol.font.family.frag"> +<xsl:param name="symbol.font.family">Symbol,ZapfDingbats</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A typical body or title font does not contain all +the character glyphs that DocBook supports. This parameter +specifies additional fonts that should be searched for +special characters not in the normal font. +These symbol font names are automatically appended +to the body or title font family name when fonts +are specified in a +<tag class="attribute">font-family</tag> +property in the FO output. +</para> +<para>The symbol font names should be entered as a +comma-separated list. The default value is +<literal>Symbol,ZapfDingbats</literal>. +</para> + +</refsection> +</refentry> diff --git a/params/table.borders.with.css.xml b/params/table.borders.with.css.xml new file mode 100644 index 0000000..2640fb9 --- /dev/null +++ b/params/table.borders.with.css.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.borders.with.css"> +<refmeta> +<refentrytitle>table.borders.with.css</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.borders.with.css</refname> +<refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.borders.with.css.frag"> +<xsl:param name="table.borders.with.css" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, CSS will be used to draw table borders. +</para> + +</refsection> +</refentry> diff --git a/params/table.caption.properties.xml b/params/table.caption.properties.xml new file mode 100644 index 0000000..8f028a5 --- /dev/null +++ b/params/table.caption.properties.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.caption.properties"> +<refmeta> +<refentrytitle>table.caption.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.caption.properties</refname> +<refpurpose>Properties associated with a table caption</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.caption.properties.frag"> +<xsl:attribute-set name="table.caption.properties"> + <xsl:attribute name="keep-together.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for table caption element (not the table title).</para> + +<para>See also <parameter>table.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/table.cell.border.color.xml b/params/table.cell.border.color.xml new file mode 100644 index 0000000..326e148 --- /dev/null +++ b/params/table.cell.border.color.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.cell.border.color"> +<refmeta> +<refentrytitle>table.cell.border.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.color</refname> +<refpurpose>Specifies the border color of table cells</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.cell.border.color.frag"> +<xsl:param condition="html" name="table.cell.border.color"></xsl:param> +<xsl:param condition="fo" name="table.cell.border.color">black</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set the color of table cell borders. If non-zero, the value is used +for the border coloration. See <link +xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A +<literal>color</literal> is either a keyword or a numerical RGB specification. +Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon, +navy, olive, orange, purple, red, silver, teal, white, and +yellow.</para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> diff --git a/params/table.cell.border.style.xml b/params/table.cell.border.style.xml new file mode 100644 index 0000000..221a29c --- /dev/null +++ b/params/table.cell.border.style.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.cell.border.style"> +<refmeta> +<refentrytitle>table.cell.border.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> +<refmiscinfo class="other" otherclass="value">double</refmiscinfo> +<refmiscinfo class="other" otherclass="value">groove</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.style</refname> +<refpurpose>Specifies the border style of table cells</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.cell.border.style.frag"> +<xsl:param name="table.cell.border.style">solid</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border style of table cells.</para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> diff --git a/params/table.cell.border.thickness.xml b/params/table.cell.border.thickness.xml new file mode 100644 index 0000000..093e38e --- /dev/null +++ b/params/table.cell.border.thickness.xml @@ -0,0 +1,35 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.cell.border.thickness"> +<refmeta> +<refentrytitle>table.cell.border.thickness</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.thickness</refname> +<refpurpose>Specifies the thickness of table cell borders</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.cell.border.thickness.frag"> +<xsl:param name="table.cell.border.thickness">0.5pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, specifies the thickness of borders on table +cells. The units are points. See <link +xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties"> +CSS</link></para> + +<note> + <para>To control properties of cell borders in HTML output, you must also turn on the + <parameter>table.borders.with.css</parameter> parameter.</para> +</note> + +</refsection> +</refentry> diff --git a/params/table.cell.padding.xml b/params/table.cell.padding.xml new file mode 100644 index 0000000..25fd653 --- /dev/null +++ b/params/table.cell.padding.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.cell.padding"> +<refmeta> +<refentrytitle>table.cell.padding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.padding</refname> +<refpurpose>Specifies the padding of table cells</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.cell.padding.frag"> +<xsl:attribute-set name="table.cell.padding"> + <xsl:attribute name="padding-start">2pt</xsl:attribute> + <xsl:attribute name="padding-end">2pt</xsl:attribute> + <xsl:attribute name="padding-top">2pt</xsl:attribute> + <xsl:attribute name="padding-bottom">2pt</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the padding of table cells.</para> + +</refsection> +</refentry> diff --git a/params/table.entry.padding.xml b/params/table.entry.padding.xml new file mode 100644 index 0000000..cfd6aa3 --- /dev/null +++ b/params/table.entry.padding.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.entry.padding"> +<refmeta> +<refentrytitle>table.entry.padding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.entry.padding</refname> +<refpurpose/> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.entry.padding.frag"> +<xsl:param name="table.entry.padding">2pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/table.footnote.number.format.xml b/params/table.footnote.number.format.xml new file mode 100644 index 0000000..ebbd2ea --- /dev/null +++ b/params/table.footnote.number.format.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.footnote.number.format"> +<refmeta> +<refentrytitle>table.footnote.number.format</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo> +<refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.footnote.number.format.frag"> +<xsl:param name="table.footnote.number.format">a</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>table.footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A) in tables.</para> + +</refsection> +</refentry> diff --git a/params/table.footnote.number.symbols.xml b/params/table.footnote.number.symbols.xml new file mode 100644 index 0000000..a8d8c23 --- /dev/null +++ b/params/table.footnote.number.symbols.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.footnote.number.symbols"> +<refmeta> +<refentrytitle>table.footnote.number.symbols</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.symbols</refname> +<refpurpose>Special characters to use a footnote markers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.footnote.number.symbols.frag"> +<xsl:param name="table.footnote.number.symbols"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string, +table footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>table.footnote.number.format</parameter>.</para> + +<para>The use of symbols for footnotes depends on the ability of your +processor (or browser) to render the symbols you select. Not all systems are +capable of displaying the full range of Unicode characters. If the quoted characters +in the preceding paragraph are not displayed properly, that's a good indicator +that you may have trouble using those symbols for footnotes.</para> + +</refsection> +</refentry> diff --git a/params/table.footnote.properties.xml b/params/table.footnote.properties.xml new file mode 100644 index 0000000..94bed80 --- /dev/null +++ b/params/table.footnote.properties.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.footnote.properties"> +<refmeta> +<refentrytitle>table.footnote.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.properties</refname> +<refpurpose>Properties applied to each table footnote body +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.footnote.properties.frag"> +<xsl:attribute-set name="table.footnote.properties"> + <xsl:attribute name="font-family"><xsl:value-of select="$body.fontset"/></xsl:attribute> + <xsl:attribute name="font-size"><xsl:value-of select="$footnote.font.size"/></xsl:attribute> + <xsl:attribute name="font-weight">normal</xsl:attribute> + <xsl:attribute name="font-style">normal</xsl:attribute> + <xsl:attribute name="space-before">2pt</xsl:attribute> + <xsl:attribute name="text-align"><xsl:value-of select="$alignment"/></xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is applied to the footnote-block +for each table footnote. +It can be used to set the +font-size, font-family, and other inheritable properties that will be +applied to all table footnotes.</para> + +</refsection> +</refentry> diff --git a/params/table.frame.border.color.xml b/params/table.frame.border.color.xml new file mode 100644 index 0000000..070cb6a --- /dev/null +++ b/params/table.frame.border.color.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.frame.border.color"> +<refmeta> +<refentrytitle>table.frame.border.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.color</refname> +<refpurpose>Specifies the border color of table frames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.frame.border.color.frag"> +<xsl:param condition="html" name="table.frame.border.color"></xsl:param> +<xsl:param condition="fo" name="table.frame.border.color">black</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border color of table frames.</para> + +</refsection> +</refentry> diff --git a/params/table.frame.border.style.xml b/params/table.frame.border.style.xml new file mode 100644 index 0000000..881840c --- /dev/null +++ b/params/table.frame.border.style.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.frame.border.style"> +<refmeta> +<refentrytitle>table.frame.border.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">none</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> +<refmiscinfo class="other" otherclass="value">double</refmiscinfo> +<refmiscinfo class="other" otherclass="value">groove</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> +<refmiscinfo class="other" otherclass="value">inset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">outset</refmiscinfo> +<refmiscinfo class="other" otherclass="value">solid</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.style</refname> +<refpurpose>Specifies the border style of table frames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.frame.border.style.frag"> +<xsl:param name="table.frame.border.style">solid</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the border style of table frames.</para> + +</refsection> +</refentry> diff --git a/params/table.frame.border.thickness.xml b/params/table.frame.border.thickness.xml new file mode 100644 index 0000000..1eaa04a --- /dev/null +++ b/params/table.frame.border.thickness.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.frame.border.thickness"> +<refmeta> +<refentrytitle>table.frame.border.thickness</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.thickness</refname> +<refpurpose>Specifies the thickness of the frame border</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.frame.border.thickness.frag"> +<xsl:param name="table.frame.border.thickness">0.5pt</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the thickness of the border on the table's frame.</para> + +</refsection> +</refentry> diff --git a/params/table.properties.xml b/params/table.properties.xml new file mode 100644 index 0000000..76340c8 --- /dev/null +++ b/params/table.properties.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.properties"> +<refmeta> +<refentrytitle>table.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.properties</refname> +<refpurpose>Properties associated with the block surrounding a table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.properties.frag"> +<xsl:attribute-set name="table.properties" use-attribute-sets="formal.object.properties"> + <xsl:attribute name="keep-together.within-column">auto</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Block styling properties for tables. This parameter should really +have been called <literal>table.block.properties</literal> or something +like that, but we’re leaving it to avoid backwards-compatibility +problems.</para> + +<para>See also <parameter>table.table.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/table.spacer.image.xml b/params/table.spacer.image.xml new file mode 100644 index 0000000..12e6d5a --- /dev/null +++ b/params/table.spacer.image.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.spacer.image"> +<refmeta> +<refentrytitle>table.spacer.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.spacer.image</refname> +<refpurpose>Invisible pixel for tabular accessibility</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.spacer.image.frag"> +<xsl:param name="table.spacer.image">graphics/spacer.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>This is the 1x1 pixel, transparent pixel used for <link xlink:href="http://diveintoaccessibility.org/day_10_presenting_your_main_content_first.html">the table trick</link> to increase the accessibility of the tabular +website presentation.</para> +</refsection> +</refentry> diff --git a/params/table.table.properties.xml b/params/table.table.properties.xml new file mode 100644 index 0000000..4ee3422 --- /dev/null +++ b/params/table.table.properties.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="table.table.properties"> +<refmeta> +<refentrytitle>table.table.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.table.properties</refname> +<refpurpose>Properties associated with a table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="table.table.properties.frag"> +<xsl:attribute-set name="table.table.properties"> + <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute> + <xsl:attribute name="border-collapse">collapse</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The styling for tables. This parameter should really +have been called <literal>table.properties</literal>, but that parameter +name was inadvertently established for the block-level properties +of the table as a whole. +</para> + +<para>See also <parameter>table.properties</parameter>.</para> + +</refsection> +</refentry> diff --git a/params/tablecolumns.extension.xml b/params/tablecolumns.extension.xml new file mode 100644 index 0000000..2ec817a --- /dev/null +++ b/params/tablecolumns.extension.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="tablecolumns.extension"> +<refmeta> +<refentrytitle>tablecolumns.extension</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tablecolumns.extension</refname> +<refpurpose>Enable the table columns extension function</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="tablecolumns.extension.frag"> +<xsl:param name="tablecolumns.extension" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The table columns extension function adjusts the widths of table +columns in the HTML result to more accurately reflect the specifications +in the CALS table. +</para> + +</refsection> +</refentry> diff --git a/params/target.database.document.xml b/params/target.database.document.xml new file mode 100644 index 0000000..042f017 --- /dev/null +++ b/params/target.database.document.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="target.database.document"> +<refmeta> +<refentrytitle>target.database.document</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>target.database.document</refname> +<refpurpose>Name of master database file for resolving +olinks</refpurpose> +</refnamediv> +<refsynopsisdiv> +<src:fragment xml:id="target.database.document.frag"> + <xsl:param name="target.database.document">olinkdb.xml</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +To resolve olinks between documents, the stylesheets use a master +database document that identifies the target datafiles for all the +documents within the scope of the olinks. This parameter value is the +URI of the master document to be read during processing to resolve +olinks. The default value is <filename>olinkdb.xml</filename>.</para> + +<para>The data structure of the file is defined in the +<filename>targetdatabase.dtd</filename> DTD. The database file +provides the high level elements to record the identifiers, locations, +and relationships of documents. The cross reference data for +individual documents is generally pulled into the database using +system entity references or XIncludes. See also +<parameter>targets.filename</parameter>. </para> </refsection> +</refentry> diff --git a/params/targets.filename.xml b/params/targets.filename.xml new file mode 100644 index 0000000..de6e29c --- /dev/null +++ b/params/targets.filename.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="targets.filename"> +<refmeta> +<refentrytitle>targets.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>targets.filename</refname> +<refpurpose>Name of cross reference targets data file</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="targets.filename.frag"> +<xsl:param name="targets.filename">target.db</xsl:param> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para> +In order to resolve olinks efficiently, the stylesheets can +generate an external data file containing information about +all potential cross reference endpoints in a document. +This parameter lets you change the name of the generated +file from the default name <filename>target.db</filename>. +The name must agree with that used in the target database +used to resolve olinks during processing. +See also <parameter>target.database.document</parameter>. +</para> +</refsection> +</refentry> diff --git a/params/task.properties.xml b/params/task.properties.xml new file mode 100644 index 0000000..3ded676 --- /dev/null +++ b/params/task.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="task.properties"> +<refmeta> +<refentrytitle>task.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>task.properties</refname> +<refpurpose>Properties associated with a task</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="task.properties.frag"> +<xsl:attribute-set name="task.properties" use-attribute-sets="formal.object.properties"> + <xsl:attribute name="keep-together.within-column">auto</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties to style the entire block containing a task element.</para> + +</refsection> +</refentry> diff --git a/params/template.xml b/params/template.xml new file mode 100644 index 0000000..9d35f83 --- /dev/null +++ b/params/template.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="[[NAME]]"> +<refmeta> +<refentrytitle>[[NAME]]</refentrytitle> +<refmiscinfo class="other" otherclass="datatype"/> +</refmeta> +<refnamediv> +<refname>[[NAME]]</refname> +<refpurpose/> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="[[NAME]].frag"> +<xsl:param name="[[NAME]]" select=""/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/tex.math.delims.xml b/params/tex.math.delims.xml new file mode 100644 index 0000000..3a302f7 --- /dev/null +++ b/params/tex.math.delims.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="tex.math.delims"> +<refmeta> +<refentrytitle>tex.math.delims</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.delims</refname> +<refpurpose>Should equations output for processing by TeX be +surrounded by math mode delimiters?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="tex.math.delims.frag"> +<xsl:param name="tex.math.delims" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell +you should set this parameter to 0.</para> + +<warning> + <para>This feature is useful for print/PDF output only if you + use the obsolete and now unsupported PassiveTeX XSL-FO + engine.</para> +</warning> + +</refsection> +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.in.alt</parameter>, + <parameter>passivetex.extensions</parameter></para> +</refsection> + +<refsection><info><title>See Also</title></info> + <para>You can also use the <tag + class="xmlpi">dbtex delims</tag> processing + instruction to control whether delimiters are output.</para> +</refsection> + + +</refentry> diff --git a/params/tex.math.file.xml b/params/tex.math.file.xml new file mode 100644 index 0000000..fbc6eaa --- /dev/null +++ b/params/tex.math.file.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="tex.math.file"> +<refmeta> +<refentrytitle>tex.math.file</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.file</refname> +<refpurpose>Name of temporary file for generating images from equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="tex.math.file.frag"> +<xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Name of auxiliary file for TeX equations. This file can be +processed by dvi2bitmap to get bitmap versions of equations for HTML +output.</para> + +</refsection> +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.in.alt</parameter>, + <parameter>tex.math.delims</parameter>, + </para> +</refsection> +<refsection><info><title>More information</title></info> + <para>For how-to documentation on embedding TeX equations and + generating output from them, see + <link + role="tcg" + xlink:href="TexMath.html" + >DBTeXMath</link>.</para> +</refsection> +</refentry> diff --git a/params/tex.math.in.alt.xml b/params/tex.math.in.alt.xml new file mode 100644 index 0000000..ed1abb9 --- /dev/null +++ b/params/tex.math.in.alt.xml @@ -0,0 +1,76 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="tex.math.in.alt"> +<refmeta> +<refentrytitle>tex.math.in.alt</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">plain</refmiscinfo> +<refmiscinfo class="other" otherclass="value">latex</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.in.alt</refname> +<refpurpose>TeX notation used for equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="tex.math.in.alt.frag"> +<xsl:param name="tex.math.in.alt"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If you want type math directly in TeX notation in equations, +this parameter specifies notation used. Currently are supported two +values -- <literal>plain</literal> and <literal>latex</literal>. Empty +value means that you are not using TeX math at all.</para> + +<para>Preferred way for including TeX alternative of math is inside of +<tag>textobject</tag> element. Eg.:</para> + +<programlisting><inlineequation> +<inlinemediaobject> +<imageobject> +<imagedata fileref="eq1.gif"/> +</imageobject> +<textobject><phrase>E=mc squared</phrase></textobject> +<textobject role="tex"><phrase>E=mc^2</phrase></textobject> +</inlinemediaobject> +</inlineequation></programlisting> + +<para>If you are using <tag>graphic</tag> element, you can +store TeX inside <tag>alt</tag> element:</para> + +<programlisting><inlineequation> +<alt role="tex">a^2+b^2=c^2</alt> +<graphic fileref="a2b2c2.gif"/> +</inlineequation></programlisting> + +<para>If you want use this feature, you should process your FO with +PassiveTeX, which only supports TeX math notation. When calling +stylsheet, don't forget to specify also +passivetex.extensions=1.</para> + +<para>If you want equations in HTML, just process generated file +<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run +dvi2bitmap program on result DVI file. You will get images for +equations in your document.</para> + +<warning> + <para>This feature is useful for print/PDF output only if you + use the obsolete and now unsupported PassiveTeX XSL-FO + engine.</para> +</warning> + +</refsection> + +<refsection><info><title>Related Parameters</title></info> + <para><parameter>tex.math.delims</parameter>, + <parameter>passivetex.extensions</parameter>, + <parameter>tex.math.file</parameter></para> +</refsection> + +</refentry> diff --git a/params/text.home.xml b/params/text.home.xml new file mode 100644 index 0000000..0bc81dd --- /dev/null +++ b/params/text.home.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="text.home"> +<refmeta> +<refentrytitle>text.home</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>text.home</refname> +<refpurpose>Home</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="text.home.frag"> +<xsl:param name="text.home">Home</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/text.next.xml b/params/text.next.xml new file mode 100644 index 0000000..d89b8e8 --- /dev/null +++ b/params/text.next.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="text.next"> +<refmeta> +<refentrytitle>text.next</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>text.next</refname> +<refpurpose>FIXME:</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="text.next.frag"> +<xsl:param name="text.next">Next</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/text.prev.xml b/params/text.prev.xml new file mode 100644 index 0000000..62d28e3 --- /dev/null +++ b/params/text.prev.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="text.prev"> +<refmeta> +<refentrytitle>text.prev</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>text.prev</refname> +<refpurpose>FIXME:</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="text.prev.frag"> +<xsl:param name="text.prev">Prev</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/text.toc.xml b/params/text.toc.xml new file mode 100644 index 0000000..083b8e3 --- /dev/null +++ b/params/text.toc.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="text.toc"> +<refmeta> +<refentrytitle>text.toc</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>text.toc</refname> +<refpurpose>FIXME:</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="text.toc.frag"> +<xsl:param name="text.toc">ToC</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/text.up.xml b/params/text.up.xml new file mode 100644 index 0000000..f6dca22 --- /dev/null +++ b/params/text.up.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="text.up"> +<refmeta> +<refentrytitle>text.up</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>text.up</refname> +<refpurpose>FIXME:</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="text.up.frag"> +<xsl:param name="text.up" >Up</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>FIXME:</para> + +</refsection> +</refentry> diff --git a/params/textbgcolor.xml b/params/textbgcolor.xml new file mode 100644 index 0000000..b9aefe6 --- /dev/null +++ b/params/textbgcolor.xml @@ -0,0 +1,26 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="textbgcolor"> +<refmeta> +<refentrytitle>textbgcolor</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>textbgcolor</refname> +<refpurpose>The background color of the table body</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="textbgcolor.frag"> +<xsl:param name="textbgcolor">white</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The background color of the table body.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/textdata.default.encoding.xml b/params/textdata.default.encoding.xml new file mode 100644 index 0000000..b6f30a8 --- /dev/null +++ b/params/textdata.default.encoding.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="textdata.default.encoding"> +<refmeta> +<refentrytitle>textdata.default.encoding</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>textdata.default.encoding</refname> +<refpurpose>Default encoding of external text files which are included +using textdata element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="textdata.default.encoding.frag"> +<xsl:param name="textdata.default.encoding"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the encoding of any external text files included using +<tag>textdata</tag> element. This value is used only when you do +not specify encoding by the appropriate attribute <!-- Which is what? --> +directly on textdata. An empty string is interpreted as the system +default encoding.</para> + +</refsection> +</refentry> diff --git a/params/textinsert.extension.xml b/params/textinsert.extension.xml new file mode 100644 index 0000000..a6f1ea4 --- /dev/null +++ b/params/textinsert.extension.xml @@ -0,0 +1,62 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="textinsert.extension"> + <refmeta> + <refentrytitle>textinsert.extension</refentrytitle> + <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>textinsert.extension</refname> + <refpurpose>Enables the textinsert extension element</refpurpose> + </refnamediv> + <refsynopsisdiv> + <src:fragment xml:id="textinsert.extension.frag"> + <xsl:param name="textinsert.extension" select="1"/> +</src:fragment> + </refsynopsisdiv> + <refsection><info><title>Description</title></info> + <para>The textinsert extension element inserts the contents of + a file into the result tree (as text).</para> + <note> + <para>To use the textinsert extension element, you must use + either Saxon or Xalan as your XSLT processor (it doesn’t + work with xsltproc), along with either the DocBook Saxon + extensions or DocBook Xalan extensions (for more + information about those extensions, see <link + role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions" + >DocBook Saxon Extensions</link> and <link + role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions" + >DocBook Xalan Extensions</link>), and you must set both + the <parameter>use.extensions</parameter> and + <parameter>textinsert.extension</parameter> parameters to + <literal>1</literal>.</para> + <para>As an alternative to using the textinsert element, + consider using an Xinclude element with the + <literal>parse="text"</literal> attribute and value + specified, as detailed in <link + role="tcg" xlink:href="ExternalCode.html#XIncludeCode" + >Using XInclude for text inclusions</link>.</para> + </note> + </refsection> + <refsection><info><title>See Also</title></info> + <para>You can also use the <tag + class="xmlpi">dbhtml-include href</tag> processing + instruction to insert external files — both files containing + plain text and files with markup content (including HTML + content).</para> + </refsection> + <refsection><info><title>More information</title></info> + <para>For how-to documentation on inserting contents of + external code files and other text files into output, see + <link + role="tcg" xlink:href="ExternalCode.html" + >External code files</link>.</para> + <para>For guidelines on inserting contents of + HTML files into output, see <link + role="tcg" xlink:href="InsertExtHtml.html" + >Inserting external HTML code</link>.</para> + </refsection> +</refentry> diff --git a/params/title.font.family.xml b/params/title.font.family.xml new file mode 100644 index 0000000..f04e616 --- /dev/null +++ b/params/title.font.family.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="title.font.family"> +<refmeta> +<refentrytitle>title.font.family</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="list-type">open</refmiscinfo> +<refmiscinfo class="other" otherclass="value">serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">sans-serif</refmiscinfo> +<refmiscinfo class="other" otherclass="value">monospace</refmiscinfo> +</refmeta> +<refnamediv> +<refname>title.font.family</refname> +<refpurpose>The default font family for titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="title.font.family.frag"> +<xsl:param name="title.font.family">sans-serif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The title font family is used for titles (chapter, section, figure, +etc.) +</para> +<para>If more than one font is required, enter the font names, +separated by a comma, e.g.</para> +<literallayout> + <xsl:param name="body.font.family">Arial, SimSun, serif</xsl:param> + +</literallayout> +</refsection> +</refentry> diff --git a/params/title.margin.left.xml b/params/title.margin.left.xml new file mode 100644 index 0000000..dc50dd1 --- /dev/null +++ b/params/title.margin.left.xml @@ -0,0 +1,65 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="title.margin.left"> +<refmeta> +<refentrytitle>title.margin.left</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>title.margin.left</refname> +<refpurpose>Adjust the left margin for titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="title.margin.left.frag"> +<xsl:param name="title.margin.left"> + <xsl:choose> + <xsl:when test="$fop.extensions != 0">-4pc</xsl:when> + <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when> + <xsl:otherwise>0pt</xsl:otherwise> + </xsl:choose> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter provides +the means of adjusting the left margin for titles +when the XSL-FO processor being used is +an old version of FOP (0.25 and earlier). +It is only useful when the <parameter>fop.extensions</parameter> +is nonzero.</para> + +<para>The left margin of the body region +is calculated to include this space, +and titles are outdented to the left outside +the body region by this amount, +effectively leaving titles at the intended left margin +and the body text indented. +Currently this method is only used for old FOP because +it cannot properly use the <parameter>body.start.indent</parameter> +parameter. +</para> +<para> +The default value when the <parameter>fop.extensions</parameter> +parameter is nonzero is -4pc, which means the +body text is indented 4 picas relative to +the titles. +The default value when the <parameter>fop.extensions</parameter> +parameter equals zero is 0pt, and +the body indent should instead be specified +using the <parameter>body.start.indent</parameter> +parameter. +</para> +<para> +If you set the value to zero, be sure to still include +a unit indicator such as <literal>0pt</literal>, or +the FO processor will report errors. +</para> + +</refsection> +</refentry> diff --git a/params/titlefoil.html.xml b/params/titlefoil.html.xml new file mode 100644 index 0000000..5fa2acd --- /dev/null +++ b/params/titlefoil.html.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="titlefoil.html"> +<refmeta> +<refentrytitle>titlefoil.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>titlefoil.html</refname> +<refpurpose>Name of title foil HTML file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="titlefoil.html.frag"> +<xsl:param name="titlefoil.html" select="concat('index', $html.ext)"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename used for the slides titlepage.</para> + +</refsection> +</refentry> diff --git a/params/toc.bg.color.xml b/params/toc.bg.color.xml new file mode 100644 index 0000000..1389c62 --- /dev/null +++ b/params/toc.bg.color.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.bg.color"> +<refmeta> +<refentrytitle>toc.bg.color</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.bg.color</refname> +<refpurpose>Background color for ToC frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.bg.color.frag"> +<xsl:param name="toc.bg.color">#FFFFFF</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the background color used in the ToC frame.</para> + +</refsection> +</refentry> diff --git a/params/toc.blank.graphic.xml b/params/toc.blank.graphic.xml new file mode 100644 index 0000000..bb24888 --- /dev/null +++ b/params/toc.blank.graphic.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.blank.graphic"> +<refmeta> +<refentrytitle>toc.blank.graphic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.blank.graphic</refname> +<refpurpose>Use graphic for "blanks" in TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.blank.graphic.frag"> +<xsl:param name="toc.blank.graphic" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If non-zero, "blanks" in the the TOC will be accomplished +with the graphic identified by <varname>toc.spacer.image</varname>. +</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.blank.image.xml b/params/toc.blank.image.xml new file mode 100644 index 0000000..82caa2f --- /dev/null +++ b/params/toc.blank.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.blank.image"> +<refmeta> +<refentrytitle>toc.blank.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.blank.image</refname> +<refpurpose>The image for "blanks" in the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.blank.image.frag"> +<xsl:param name="toc.blank.image">graphics/blank.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.blank.graphic</varname> is non-zero, this image +will be used to for "blanks" in the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.blank.text.xml b/params/toc.blank.text.xml new file mode 100644 index 0000000..d39aec4 --- /dev/null +++ b/params/toc.blank.text.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.blank.text"> +<refmeta> +<refentrytitle>toc.blank.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.blank.text</refname> +<refpurpose>The text for "blanks" in the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.blank.text.frag"> +<xsl:param name="toc.blank.text">   </xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.blank.graphic</varname> is zero, this text string +will be used for "blanks" in the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.hide.show.xml b/params/toc.hide.show.xml new file mode 100644 index 0000000..1570ec4 --- /dev/null +++ b/params/toc.hide.show.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.hide.show"> +<refmeta> +<refentrytitle>toc.hide.show</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.hide.show</refname> +<refpurpose>Enable hide/show button for ToC frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.hide.show.frag"> +<xsl:param name="toc.hide.show" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, JavaScript (and an additional icon, see +<link linkend="hidetoc.image">hidetoc.image</link> and +<link linkend="hidetoc.image">showtoc.image</link>) is added to each slide +to allow the ToC panel to be <quote>toggled</quote> on each panel.</para> + +<note><para>There is a bug in Mozilla 1.0 (at least as of CR3) that causes +the browser to reload the titlepage when this feature is used.</para></note> + +</refsection> +</refentry> diff --git a/params/toc.html.xml b/params/toc.html.xml new file mode 100644 index 0000000..62c060c --- /dev/null +++ b/params/toc.html.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.html"> +<refmeta> +<refentrytitle>toc.html</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.html</refname> +<refpurpose>Name of ToC HTML file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.html.frag"> +<xsl:param name="toc.html" select="concat('toc', $html.ext)"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets the filename used for the table of contents page.</para> + +</refsection> +</refentry> diff --git a/params/toc.image.xml b/params/toc.image.xml new file mode 100644 index 0000000..147155c --- /dev/null +++ b/params/toc.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.image"> +<refmeta> +<refentrytitle>toc.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.image</refname> +<refpurpose>ToC image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.image.frag"> +<xsl:param name="toc.image">active/nav-toc.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the ToC navigation icon.</para> + +</refsection> +</refentry> diff --git a/params/toc.indent.width.xml b/params/toc.indent.width.xml new file mode 100644 index 0000000..449e74c --- /dev/null +++ b/params/toc.indent.width.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.indent.width"> +<refmeta> +<refentrytitle>toc.indent.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">float</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.indent.width</refname> +<refpurpose>Amount of indentation for TOC entries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.indent.width.frag"> +<xsl:param name="toc.indent.width">24</xsl:param> +<!-- inconsistant point specification? --> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies, in points, the distance by which each level of the +TOC is indented from its parent.</para> + +<para>This value is expressed in points, without +a unit (in other words, it is a bare number). Using a bare number allows the stylesheet +to perform calculations that would otherwise have to be performed by the FO processor +because not all processors support expressions.</para> + +</refsection> +</refentry> diff --git a/params/toc.line.properties.xml b/params/toc.line.properties.xml new file mode 100644 index 0000000..0886fa4 --- /dev/null +++ b/params/toc.line.properties.xml @@ -0,0 +1,44 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.line.properties"> +<refmeta> +<refentrytitle>toc.line.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.line.properties</refname> +<refpurpose>Properties for lines in ToCs and LoTs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.line.properties.frag"> +<xsl:attribute-set name="toc.line.properties"> + <xsl:attribute name="text-align-last">justify</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="end-indent"><xsl:value-of select="concat($toc.indent.width, 'pt')"/></xsl:attribute> + <xsl:attribute name="last-line-end-indent"><xsl:value-of select="concat('-', $toc.indent.width, 'pt')"/></xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties which are applied to every line in ToC (or LoT). You can +modify them in order to change appearance of all, or some lines. For +example, in order to make lines for chapters bold, specify the +following in your customization layer:</para> + +<programlisting><xsl:attribute-set name="toc.line.properties"> + <xsl:attribute name="font-weight"> + <xsl:choose> + <xsl:when test="self::chapter">bold</xsl:when> + <xsl:otherwise>normal</xsl:otherwise> + </xsl:choose> + </xsl:attribute> +</xsl:attribute-set></programlisting> + +</refsection> +</refentry> diff --git a/params/toc.list.type.xml b/params/toc.list.type.xml new file mode 100644 index 0000000..31dc465 --- /dev/null +++ b/params/toc.list.type.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.list.type"> +<refmeta> +<refentrytitle>toc.list.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> +<refmiscinfo class="other" otherclass="value">dl</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ul</refmiscinfo> +<refmiscinfo class="other" otherclass="value">ol</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.list.type</refname> +<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.list.type.frag"><xsl:param name="toc.list.type">dl</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When an automatically generated Table of Contents (or List of Titles) +is produced, this HTML element will be used to make the list. +</para> + +</refsection> +</refentry> diff --git a/params/toc.margin.properties.xml b/params/toc.margin.properties.xml new file mode 100644 index 0000000..25963df --- /dev/null +++ b/params/toc.margin.properties.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.margin.properties"> +<refmeta> +<refentrytitle>toc.margin.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.margin.properties</refname> +<refpurpose>Margin properties used on Tables of Contents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.margin.properties.frag"> +<xsl:attribute-set name="toc.margin.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>This attribute set is used on Tables of Contents. These attributes are set +on the wrapper that surrounds the ToC block, not on each individual lines.</para> +</refsection> +</refentry> diff --git a/params/toc.max.depth.xml b/params/toc.max.depth.xml new file mode 100644 index 0000000..75902b3 --- /dev/null +++ b/params/toc.max.depth.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.max.depth"> +<refmeta> +<refentrytitle>toc.max.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.max.depth</refname> +<refpurpose>How many levels should be created for each TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth">8</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the maximal depth of TOC on all levels.</para> + +</refsection> +</refentry> diff --git a/params/toc.pointer.graphic.xml b/params/toc.pointer.graphic.xml new file mode 100644 index 0000000..4b2cb74 --- /dev/null +++ b/params/toc.pointer.graphic.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.pointer.graphic"> +<refmeta> +<refentrytitle>toc.pointer.graphic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.pointer.graphic</refname> +<refpurpose>Use graphic for TOC pointer?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.pointer.graphic.frag"> +<xsl:param name="toc.pointer.graphic" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If non-zero, the "pointer" in the TOC will be displayed +with the graphic identified by <varname>toc.pointer.image</varname>. +</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.pointer.image.xml b/params/toc.pointer.image.xml new file mode 100644 index 0000000..bf06901 --- /dev/null +++ b/params/toc.pointer.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.pointer.image"> +<refmeta> +<refentrytitle>toc.pointer.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.pointer.image</refname> +<refpurpose>The image for the "pointer" in the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.pointer.image.frag"> +<xsl:param name="toc.pointer.image">graphics/arrow.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.pointer.graphic</varname> is non-zero, this image +will be used for the "pointer" in the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.pointer.text.xml b/params/toc.pointer.text.xml new file mode 100644 index 0000000..b094765 --- /dev/null +++ b/params/toc.pointer.text.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.pointer.text"> +<refmeta> +<refentrytitle>toc.pointer.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.pointer.text</refname> +<refpurpose>The text for the "pointer" in the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.pointer.text.frag"> +<xsl:param name="toc.pointer.text"> > </xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.pointer.graphic</varname> is zero, this text string +will be used to display the "pointer" in the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.row.height.xml b/params/toc.row.height.xml new file mode 100644 index 0000000..89bac83 --- /dev/null +++ b/params/toc.row.height.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.row.height"> +<refmeta> +<refentrytitle>toc.row.height</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.row.height</refname> +<refpurpose>Height of ToC rows in dynamic ToCs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.row.height.frag"> +<xsl:param name="toc.row.height">22</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This parameter specifies the height of each row in the table of +contents. This is only applicable if a <link +linkend="dynamic.toc">dynamic ToC</link> is used. You may want to +adjust this parameter for optimal appearance with the font and image +sizes selected by your <link linkend="css.stylesheet">CSS +stylesheet</link>. +</para> +<!-- This uses link for cross param linking, unlike most others --> +</refsection> +</refentry> diff --git a/params/toc.section.depth.xml b/params/toc.section.depth.xml new file mode 100644 index 0000000..db99f9c --- /dev/null +++ b/params/toc.section.depth.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.section.depth"> +<refmeta> +<refentrytitle>toc.section.depth</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.section.depth</refname> +<refpurpose>How deep should recursive <tag>section</tag>s appear +in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.section.depth.frag"><xsl:param name="toc.section.depth">2</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the depth to which recursive sections should appear in the +TOC. +</para> + +</refsection> +</refentry> diff --git a/params/toc.spacer.graphic.xml b/params/toc.spacer.graphic.xml new file mode 100644 index 0000000..0a5729c --- /dev/null +++ b/params/toc.spacer.graphic.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.spacer.graphic"> +<refmeta> +<refentrytitle>toc.spacer.graphic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.spacer.graphic</refname> +<refpurpose>Use graphic for TOC spacer?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.spacer.graphic.frag"> +<xsl:param name="toc.spacer.graphic" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If non-zero, the indentation in the TOC will be accomplished +with the graphic identified by <varname>toc.spacer.image</varname>. +</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.spacer.image.xml b/params/toc.spacer.image.xml new file mode 100644 index 0000000..0d55016 --- /dev/null +++ b/params/toc.spacer.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.spacer.image"> +<refmeta> +<refentrytitle>toc.spacer.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.spacer.image</refname> +<refpurpose>The image for spacing the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.spacer.image.frag"> +<xsl:param name="toc.spacer.image">graphics/blank.gif</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.spacer.graphic</varname> is non-zero, this image +will be used to indent the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.spacer.text.xml b/params/toc.spacer.text.xml new file mode 100644 index 0000000..bfb605f --- /dev/null +++ b/params/toc.spacer.text.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.spacer.text"> +<refmeta> +<refentrytitle>toc.spacer.text</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.spacer.text</refname> +<refpurpose>The text for spacing the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.spacer.text.frag"> +<xsl:param name="toc.spacer.text">   </xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If <varname>toc.spacer.graphic</varname> is zero, this text string +will be used to indent the TOC.</para> +<para>Only applies with the tabular presentation is being used.</para> +</refsection> +</refentry> diff --git a/params/toc.width.xml b/params/toc.width.xml new file mode 100644 index 0000000..71a3c03 --- /dev/null +++ b/params/toc.width.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="toc.width"> +<refmeta> +<refentrytitle>toc.width</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.width</refname> +<refpurpose>Width of ToC frame</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="toc.width.frag"> +<xsl:param name="toc.width" >250</xsl:param> +<!-- Presumably in pixels? --> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the width of the ToC frame in pixels.</para> + +</refsection> +</refentry> diff --git a/params/ua.js.xml b/params/ua.js.xml new file mode 100644 index 0000000..8242a71 --- /dev/null +++ b/params/ua.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ua.js"> +<refmeta> +<refentrytitle>ua.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ua.js</refname> +<refpurpose>UA JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ua.js.frag"> +<xsl:param name="ua.js">ua.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the UA JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/ulink.footnotes.xml b/params/ulink.footnotes.xml new file mode 100644 index 0000000..f17c884 --- /dev/null +++ b/params/ulink.footnotes.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ulink.footnotes"> +<refmeta> +<refentrytitle>ulink.footnotes</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.footnotes</refname> +<refpurpose>Generate footnotes for <tag>ulink</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ulink.footnotes.frag"> +<xsl:param name="ulink.footnotes" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, and if <parameter>ulink.show</parameter> also is non-zero, +the URL of each <tag>ulink</tag> will appear as a footnote.</para> + +<note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing +DocBoook 5 documents, <parameter>ulink.footnotes</parameter> applies to all inline +elements that are marked up with <tag class="attribute">xlink:href</tag> attributes +that point to external resources.</para> +</note> + +</refsection> +</refentry> diff --git a/params/ulink.hyphenate.chars.xml b/params/ulink.hyphenate.chars.xml new file mode 100644 index 0000000..7419e87 --- /dev/null +++ b/params/ulink.hyphenate.chars.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ulink.hyphenate.chars"> +<refmeta> +<refentrytitle>ulink.hyphenate.chars</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.hyphenate.chars</refname> +<refpurpose>List of characters to allow ulink URLs to be automatically +hyphenated on</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ulink.hyphenate.chars.frag"> +<xsl:param name="ulink.hyphenate.chars">/</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If the <parameter>ulink.hyphenate</parameter> parameter is not +empty, then hyphenation of ulinks is turned on, and any character +contained in this parameter is treated as an allowable hyphenation +point. This and <parameter>ulink.hyphenate</parameter> work together, +one is pointless without the other being set to a non-empty value</para> + +<para>The default value is <quote>/</quote>, but the parameter could +be customized to contain other URL characters, as for example:</para> +<programlisting> +<xsl:param name="ulink.hyphenate.chars">:/@&?.#</xsl:param> +</programlisting> + +</refsection> +</refentry> diff --git a/params/ulink.hyphenate.xml b/params/ulink.hyphenate.xml new file mode 100644 index 0000000..8aa1dfe --- /dev/null +++ b/params/ulink.hyphenate.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ulink.hyphenate"> +<refmeta> +<refentrytitle>ulink.hyphenate</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.hyphenate</refname> +<refpurpose>Allow URLs to be automatically hyphenated</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ulink.hyphenate.frag"> +<xsl:param name="ulink.hyphenate"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If not empty, the specified character (or more generally, +content) is added to URLs after every character included in the string +in the <parameter>ulink.hyphenate.chars</parameter> parameter (default +is <quote>/</quote>) to enable hyphenation of ulinks. If the character +in this parameter is a Unicode soft hyphen (0x00AD) or Unicode +zero-width space (0x200B), some FO processors will be able to +reasonably hyphenate long URLs.</para> + +<para>Note that this hyphenation process is only applied when the +ulink element is empty and the url attribute is reused as the link +text. It is not applied if the ulink has literal text content. The +same applies in in DocBook 5, where ulink was replaced with link with +an xlink:href attribute.</para> + +</refsection> +</refentry> diff --git a/params/ulink.show.xml b/params/ulink.show.xml new file mode 100644 index 0000000..6f90d58 --- /dev/null +++ b/params/ulink.show.xml @@ -0,0 +1,37 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ulink.show"> +<refmeta> +<refentrytitle>ulink.show</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.show</refname> +<refpurpose>Display URLs after <tag>ulink</tag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ulink.show.frag"> +<xsl:param name="ulink.show" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the URL of each <tag>ulink</tag> will +appear after the text of the link. If the text of the link and the URL +are identical, the URL is suppressed. </para> + +<para>See also <parameter>ulink.footnotes</parameter>.</para> + +<note><para>DocBook 5 does not have an <tag>ulink</tag> element. When processing +DocBoook 5 documents, <parameter>ulink.show</parameter> applies to all inline +elements that are marked up with <tag class="attribute">xlink:href</tag> attributes +that point to external resources.</para> +</note> + +</refsection> +</refentry> diff --git a/params/ulink.target.xml b/params/ulink.target.xml new file mode 100644 index 0000000..cf1d42b --- /dev/null +++ b/params/ulink.target.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="ulink.target"> +<refmeta> +<refentrytitle>ulink.target</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.target</refname> +<refpurpose>The HTML anchor target for ULinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="ulink.target.frag"> +<xsl:param name="ulink.target">_top</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>ulink.target</parameter> is non-zero, its value will +be used for the <literal>target</literal> attribute +on anchors generated for <tag>ulink</tag>s.</para> + +</refsection> +</refentry> diff --git a/params/up.image.xml b/params/up.image.xml new file mode 100644 index 0000000..1c3bfa2 --- /dev/null +++ b/params/up.image.xml @@ -0,0 +1,27 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="up.image"> +<refmeta> +<refentrytitle>up.image</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>up.image</refname> +<refpurpose>Up-arrow image</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="up.image.frag"> +<xsl:param name="up.image">active/nav-up.png</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the upward-pointing navigation arrow.</para> + +</refsection> +</refentry> diff --git a/params/use.embed.for.svg.xml b/params/use.embed.for.svg.xml new file mode 100644 index 0000000..f7c52cc --- /dev/null +++ b/params/use.embed.for.svg.xml @@ -0,0 +1,33 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.embed.for.svg"> +<refmeta> +<refentrytitle>use.embed.for.svg</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.embed.for.svg</refname> +<refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.embed.for.svg.frag"> +<xsl:param name="use.embed.for.svg" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, an <tag>embed</tag> element will be created for +SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created, +this parameter merely controls whether or not an additional <tag>embed</tag> +is generated inside the <tag>object</tag>.</para> + +<para>On the plus side, this may be more portable among browsers and plug-ins. +On the minus side, it isn't valid HTML.</para> + +</refsection> +</refentry> diff --git a/params/use.extensions.xml b/params/use.extensions.xml new file mode 100644 index 0000000..4dce71b --- /dev/null +++ b/params/use.extensions.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.extensions"> +<refmeta> +<refentrytitle>use.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.extensions</refname> +<refpurpose>Enable extensions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.extensions.frag"> +<xsl:param name="use.extensions" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, extensions may be used. Each extension is +further controlled by its own parameter. But if +<parameter>use.extensions</parameter> is zero, no extensions will +be used. +</para> + +</refsection> +</refentry> diff --git a/params/use.id.as.filename.xml b/params/use.id.as.filename.xml new file mode 100644 index 0000000..e5133e9 --- /dev/null +++ b/params/use.id.as.filename.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.id.as.filename"> +<refmeta> +<refentrytitle>use.id.as.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.id.as.filename</refname> +<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.id.as.filename.frag"> +<xsl:param name="use.id.as.filename" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>use.id.as.filename</parameter> +is non-zero, the filename of chunk elements that have IDs will be +derived from the ID value. +</para> + +</refsection> +</refentry> diff --git a/params/use.id.function.xml b/params/use.id.function.xml new file mode 100644 index 0000000..5f4e6f7 --- /dev/null +++ b/params/use.id.function.xml @@ -0,0 +1,32 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.id.function"> +<refmeta> +<refentrytitle>use.id.function</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.id.function</refname> +<refpurpose>Use the XPath id() function to find link targets?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.id.function.frag"> +<xsl:param name="use.id.function" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If 1, the stylesheets use the <function>id()</function> function +to find the targets of cross reference elements. This is more +efficient, but only works if your XSLT processor implements the +<function>id()</function> function, naturally.</para> +<para>THIS PARAMETER IS NOT SUPPORTED. IT IS ALWAYS ASSUMED TO BE 1. +SEE xref.xsl IF YOU NEED TO TURN IT OFF.</para> + +</refsection> +</refentry> diff --git a/params/use.local.olink.style.xml b/params/use.local.olink.style.xml new file mode 100644 index 0000000..eb4f57a --- /dev/null +++ b/params/use.local.olink.style.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.local.olink.style"> +<refmeta> +<refentrytitle>use.local.olink.style</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.local.olink.style</refname> +<refpurpose>Process olinks using xref style of current +document</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment xml:id="use.local.olink.style.frag"> +<xsl:param name="use.local.olink.style" select="0"/> </src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> + +<para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross +reference string is formed again from the target title, number, and +element name, using the stylesheet processing the targeting document. +Then olinks will match the xref style in the targeting document +rather than in the target document. If both documents are processed +with the same stylesheet, then the results will be the same.</para> +</refsection> +</refentry> diff --git a/params/use.role.as.xrefstyle.xml b/params/use.role.as.xrefstyle.xml new file mode 100644 index 0000000..56c4470 --- /dev/null +++ b/params/use.role.as.xrefstyle.xml @@ -0,0 +1,93 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.role.as.xrefstyle"> +<refmeta> +<refentrytitle>use.role.as.xrefstyle</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.as.xrefstyle</refname> +<refpurpose>Use <tag class="attribute">role</tag> attribute for +<tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.role.as.xrefstyle.frag"> +<xsl:param name="use.role.as.xrefstyle" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In DocBook documents that conform to a schema older than V4.3, this parameter allows +<tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para> + +<para>If non-zero, the <tag class="attribute">role</tag> attribute on +<tag>xref</tag> will be used to select the cross reference style. +In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose. +If the <tag class="attribute">xrefstyle</tag> attribute is present, +<tag class="attribute">role</tag> will be ignored, regardless of the setting +of this parameter.</para> + +</refsection> + +<refsection><info><title>Example</title></info> + +<para>The following small stylesheet shows how to configure the +stylesheets to make use of the cross reference style:</para> + +<programlisting><?xml version="1.0"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + +<xsl:import href="../xsl/html/docbook.xsl"/> + +<xsl:output method="html"/> + +<xsl:param name="local.l10n.xml" select="document('')"/> +<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> + <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"> + <l:context name="xref"> + <l:template name="chapter" style="title" text="Chapter %n, %t"/> + <l:template name="chapter" text="Chapter %n"/> + </l:context> + </l:l10n> +</l:i18n> + +</xsl:stylesheet></programlisting> + +<para>With this stylesheet, the cross references in the following document:</para> + +<programlisting><?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<book id="book"><title>Book</title> + +<preface> +<title>Preface</title> + +<para>Normal: <xref linkend="ch1"/>.</para> +<para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para> + +</preface> + +<chapter id="ch1"> +<title>First Chapter</title> + +<para>Irrelevant.</para> + +</chapter> +</book></programlisting> + +<para>will appear as:</para> + +<informalexample> +<para>Normal: Chapter 1.</para> +<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> +</informalexample> +</refsection> + +</refentry> diff --git a/params/use.role.for.mediaobject.xml b/params/use.role.for.mediaobject.xml new file mode 100644 index 0000000..9241ace --- /dev/null +++ b/params/use.role.for.mediaobject.xml @@ -0,0 +1,56 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.role.for.mediaobject"> +<refmeta> +<refentrytitle>use.role.for.mediaobject</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.for.mediaobject</refname> +<refpurpose>Use <tag class="attribute">role</tag> attribute +value for selecting which of several objects within a mediaobject to use. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.role.for.mediaobject.frag"> +<xsl:param name="use.role.for.mediaobject" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, the <tag class="attribute">role</tag> attribute on +<tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be +used. +</para> +<para> +The order of selection when then parameter is non-zero is: +</para> +<orderedlist> +<listitem> + <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para> +</listitem> +<listitem> +<para>Else if an object's role attribute has a value of +<literal>html</literal> for HTML processing or +<literal>fo</literal> for FO output, then the first +of such objects is selected. +</para> +</listitem> +<listitem> +<para>Else the first suitable object is selected.</para> +</listitem> +</orderedlist> +<para> +If the value of +<parameter>use.role.for.mediaobject</parameter> +is zero, then role attributes are not considered +and the first suitable object +with or without a role value is used. +</para> +</refsection> +</refentry> diff --git a/params/use.svg.xml b/params/use.svg.xml new file mode 100644 index 0000000..8f13be0 --- /dev/null +++ b/params/use.svg.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="use.svg"> +<refmeta> +<refentrytitle>use.svg</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.svg</refname> +<refpurpose>Allow SVG in the result tree?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="use.svg.frag"> +<xsl:param name="use.svg" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, SVG will be considered an acceptable image format. SVG +is passed through to the result tree, so correct rendering of the resulting +diagram depends on the formatter (FO processor or web browser) that is used +to process the output from the stylesheet.</para> + +</refsection> +</refentry> diff --git a/params/variablelist.as.blocks.xml b/params/variablelist.as.blocks.xml new file mode 100644 index 0000000..71e1c98 --- /dev/null +++ b/params/variablelist.as.blocks.xml @@ -0,0 +1,62 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.as.blocks"> +<refmeta> +<refentrytitle>variablelist.as.blocks</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.as.blocks</refname> +<refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.as.blocks.frag"> +<xsl:param name="variablelist.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>variablelist</tag>s will be formatted as +blocks.</para> + +<para>If you have long terms, proper list markup in the FO case may produce +unattractive lists. By setting this parameter, you can force the stylesheets +to produce block markup instead of proper lists.</para> + +<para>You can override this setting with a processing instruction as the +child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo +list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo +list-presentation="list"</tag>.</para> + +<para>When using <literal>list-presentation="list"</literal>, +you can also control the amount of space used for the <tag>term</tag>s with +the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction, +the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>, +or allow the stylesheets to attempt to calculate the amount of space to leave based on the +number of letters in the longest term. +</para> + +<programlisting> <variablelist> + <?dbfo list-presentation="list"?> + <?dbfo term-width="1.5in"?> + <?dbhtml list-presentation="table"?> + <?dbhtml term-width="1.5in"?> + <varlistentry> + <term>list</term> + <listitem> + <para> + Formatted as a list even if variablelist.as.blocks is set to 1. + </para> + </listitem> + </varlistentry> + </variablelist></programlisting> + + +</refsection> + +</refentry> diff --git a/params/variablelist.as.table.xml b/params/variablelist.as.table.xml new file mode 100644 index 0000000..113d2f5 --- /dev/null +++ b/params/variablelist.as.table.xml @@ -0,0 +1,54 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.as.table"> +<refmeta> +<refentrytitle>variablelist.as.table</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.as.table</refname> +<refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.as.table.frag"> +<xsl:param name="variablelist.as.table" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, <tag>variablelist</tag>s will be formatted as +tables. A processing instruction exists to specify a particular width for the +column containing the <tag>term</tag>s: +<tag class="xmlpi">dbhtml term-width=".25in"</tag></para> + +<para>You can override this setting with a processing instruction as the +child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml +list-presentation="table"</tag> or <tag class="xmlpi">dbhtml +list-presentation="list"</tag>.</para> + +<para>This parameter only applies to the HTML transformations. In the +FO case, proper list markup is robust enough to handle the formatting. +But see also <parameter>variablelist.as.blocks</parameter>.</para> + +<programlisting> <variablelist> + <?dbhtml list-presentation="table"?> + <?dbhtml term-width="1.5in"?> + <?dbfo list-presentation="list"?> + <?dbfo term-width="1in"?> + <varlistentry> + <term>list</term> + <listitem> + <para> + Formatted as a table even if variablelist.as.table is set to 0. + </para> + </listitem> + </varlistentry> + </variablelist></programlisting> + +</refsection> +</refentry> diff --git a/params/variablelist.max.termlength.xml b/params/variablelist.max.termlength.xml new file mode 100644 index 0000000..ff56a87 --- /dev/null +++ b/params/variablelist.max.termlength.xml @@ -0,0 +1,46 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.max.termlength"> +<refmeta> +<refentrytitle>variablelist.max.termlength</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.max.termlength</refname> +<refpurpose>Specifies the longest term in variablelists</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.max.termlength.frag"> +<xsl:param name="variablelist.max.termlength">24</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>In variablelists, the <tag>listitem</tag> +is indented to leave room for the +<tag>term</tag> elements. That indent may be computed +if it is not specified with a <tag class="attribute">termlength</tag> +attribute on the <tag>variablelist</tag> element. +</para> +<para> +The computation counts characters in the +<tag>term</tag> elements in the list +to find the longest term. However, some terms are very long +and would produce extreme indents. This parameter lets you +set a maximum character count. Any terms longer than the maximum +would line wrap. The default value is 24. +</para> +<para> +The character counts are converted to physical widths +by multiplying by 0.50em. There will be some variability +in how many actual characters fit in the space +since some characters are wider than others. +</para> + +</refsection> +</refentry> diff --git a/params/variablelist.term.break.after.xml b/params/variablelist.term.break.after.xml new file mode 100644 index 0000000..8472f5e --- /dev/null +++ b/params/variablelist.term.break.after.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.term.break.after"> +<refmeta> +<refentrytitle>variablelist.term.break.after</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.term.break.after</refname> +<refpurpose>Generate line break after each <tag>term</tag> within a +multi-term <tag>varlistentry</tag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.term.break.after.frag"> +<xsl:param name="variablelist.term.break.after">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Set a non-zero value for the +<parameter>variablelist.term.break.after</parameter> parameter to +generate a line break between <tag>term</tag>s in a +multi-term <tag>varlistentry</tag>.</para> + +<note> +<para>If you set a non-zero value for +<parameter>variablelist.term.break.after</parameter>, you may also +want to set the value of the +<parameter>variablelist.term.separator</parameter> parameter to an +empty string (to suppress rendering of the default comma and space +after each <tag>term</tag>).</para> +</note> + +</refsection> +</refentry> diff --git a/params/variablelist.term.properties.xml b/params/variablelist.term.properties.xml new file mode 100644 index 0000000..4a4835d --- /dev/null +++ b/params/variablelist.term.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.term.properties"> +<refmeta> +<refentrytitle>variablelist.term.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.term.properties</refname> +<refpurpose>To add properties to the term elements in a variablelist.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.term.properties.frag"> +<xsl:attribute-set name="variablelist.term.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsection><info><title>Description</title></info> +<para>These properties are added to the block containing a +term in a variablelist. +Use this attribute-set to set +font properties or alignment, for example.</para> + +</refsection> +</refentry> diff --git a/params/variablelist.term.separator.xml b/params/variablelist.term.separator.xml new file mode 100644 index 0000000..f3df883 --- /dev/null +++ b/params/variablelist.term.separator.xml @@ -0,0 +1,40 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="variablelist.term.separator"> +<refmeta> +<refentrytitle>variablelist.term.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.term.separator</refname> +<refpurpose>Text to separate <tag>term</tag>s within a multi-term +<tag>varlistentry</tag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="variablelist.term.separator.frag"> +<xsl:param name="variablelist.term.separator">, </xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag> +elements, the string specified in the value of the +<parameter>variablelist.term.separator</parameter> parameter is placed +after each <tag>term</tag> except the last.</para> + +<note> + <para>To generate a line break between multiple <tag>term</tag>s in + a <tag>varlistentry</tag>, set a non-zero value for the + <parameter>variablelist.term.break.after</parameter> parameter. If + you do so, you may also want to set the value of the + <parameter>variablelist.term.separator</parameter> parameter to an + empty string (to suppress rendering of the default comma and space + after each <tag>term</tag>).</para> +</note> + +</refsection> +</refentry> diff --git a/params/verbatim.properties.xml b/params/verbatim.properties.xml new file mode 100644 index 0000000..28a368a --- /dev/null +++ b/params/verbatim.properties.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="verbatim.properties"> +<refmeta> +<refentrytitle>verbatim.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>verbatim.properties</refname> +<refpurpose>Properties associated with verbatim text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="verbatim.properties.frag"> +<xsl:attribute-set name="verbatim.properties"> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="wrap-option">no-wrap</xsl:attribute> + <xsl:attribute name="white-space-collapse">false</xsl:attribute> + <xsl:attribute name="white-space-treatment">preserve</xsl:attribute> + <xsl:attribute name="linefeed-treatment">preserve</xsl:attribute> + <xsl:attribute name="text-align">start</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>This attribute set is used on all verbatim environments.</para> +</refsection> + +</refentry> diff --git a/params/webhelp.autolabel.xml b/params/webhelp.autolabel.xml new file mode 100644 index 0000000..de20701 --- /dev/null +++ b/params/webhelp.autolabel.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.autolabel"> +<refmeta> +<refentrytitle>webhelp.autolabel</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.autolabel.frag"> +<xsl:param name="webhelp.autolabel">0</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>To include chapter and section numbers the table of contents pane, set this parameter to 1.</para> +</refsection> +</refentry> diff --git a/params/webhelp.base.dir.xml b/params/webhelp.base.dir.xml new file mode 100644 index 0000000..1dcf688 --- /dev/null +++ b/params/webhelp.base.dir.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.base.dir"> +<refmeta> +<refentrytitle>webhelp.base.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.base.dir</refname> +<refpurpose>The base directory for webhelp output.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.base.dir.frag"> +<xsl:param name="webhelp.base.dir">docs</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>If specified, the <parameter>webhelp.base.dir</parameter> +parameter identifies the output directory for webhelp. (If not +specified, the output directory is system dependent.) By default, this +parameter is set to <filename>docs</filename>.</para> + +</refsection> +</refentry> diff --git a/params/webhelp.common.dir.xml b/params/webhelp.common.dir.xml new file mode 100644 index 0000000..8d5267b --- /dev/null +++ b/params/webhelp.common.dir.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.common.dir"> +<refmeta> +<refentrytitle>webhelp.common.dir</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.common.dir</refname> +<refpurpose>Path to the directory for the common webhelp resources (JavaScript, css, common images, etc).</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.common.dir.frag"> +<xsl:param name="webhelp.common.dir">../common/</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>By default, webhelp creates a common directory containing resources such as JavaScript files, css, common images, etc. In some cases you may prefer to store these files in a standard location on your site and point all webhelp documents to that location. You can use this parameter to control the urls written to these common resources. For example, you might set this parameter to <code>/common</code> and create a single common directory at the root of your web server. </para> +</refsection> +</refentry> diff --git a/params/webhelp.default.topic.xml b/params/webhelp.default.topic.xml new file mode 100644 index 0000000..4dca60e --- /dev/null +++ b/params/webhelp.default.topic.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.default.topic"> +<refmeta> +<refentrytitle>webhelp.default.topic</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.default.topic</refname> +<refpurpose>The name of the file to which the start file in the webhelp base directory redirects</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.default.topic.frag"> +<xsl:param name="webhelp.default.topic">index.html</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Currently webhelp creates a base directory and puts the output +files in a <filename>content</filename> subdirectory. It creates a +file in the base directory that redirects to a configured file in the +<filename>content</filename> directory. The +<parameter>webhelp.default.topic</parameter> parameter lets you +configure the name of the file that is redirected to. +<note> + <para>This parameter will be removed from a future version of + webhelp along with the <filename>content</filename> + directory.</para> +</note> +</para> +</refsection> +</refentry> diff --git a/params/webhelp.include.search.tab.xml b/params/webhelp.include.search.tab.xml new file mode 100644 index 0000000..131f32d --- /dev/null +++ b/params/webhelp.include.search.tab.xml @@ -0,0 +1,25 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.include.search.tab"> +<refmeta> +<refentrytitle>webhelp.include.search.tab</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.include.search.tab</refname> +<refpurpose>Should the webhelp output include a Search tab?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.include.search.tab.frag"> +<xsl:param name="webhelp.include.search.tab">true</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Set this parameter to 0 to suppress the search tab from webhelp output.</para> +</refsection> +</refentry> diff --git a/params/webhelp.indexer.language.xml b/params/webhelp.indexer.language.xml new file mode 100644 index 0000000..1bead3c --- /dev/null +++ b/params/webhelp.indexer.language.xml @@ -0,0 +1,47 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.indexer.language"> +<refmeta> +<refentrytitle>webhelp.indexer.language</refentrytitle> +<refmiscinfo class="other" otherclass="datatype"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.indexer.language</refname> +<refpurpose>The language to use for creating the webhelp search index.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.indexer.language.frag"> +<xsl:param name="webhelp.indexer.language">en</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>To support stemming in the client-side webhelp stemmer, you must provide the language code. By default, the following languages are supported: +<itemizedlist> + <listitem> + <para><code>en</code>: English</para> + </listitem> + <listitem> + <para><code>de</code>: German</para> + </listitem> + <listitem> + <para><code>fr</code>: French</para> + </listitem> + <listitem> + <para><code>zh</code>: Chinese</para> + </listitem> + <listitem> + <para><code>ja</code>: Japanese</para> + </listitem> + <listitem> + <para><code>ko</code>: Korean</para> + </listitem> +</itemizedlist> +See the webhelp documentation for information on adding support for additional languages. +</para> +</refsection> +</refentry> diff --git a/params/webhelp.start.filename.xml b/params/webhelp.start.filename.xml new file mode 100644 index 0000000..2106de4 --- /dev/null +++ b/params/webhelp.start.filename.xml @@ -0,0 +1,34 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.start.filename"> +<refmeta> +<refentrytitle>webhelp.start.filename</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.start.filename</refname> +<refpurpose>The name of the start file in the webhelp base directory.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.start.filename.frag"> +<xsl:param name="webhelp.start.filename">index.html</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>Currently webhelp creates a base directory and puts the output +files in a <filename>content</filename> subdirectory. It creates a +file in the base directory that redirects to a configured file in the +<filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file. +<note> + <para>This parameter will be removed from a future version of + webhelp along with the <filename>content</filename> + directory.</para> +</note> +</para> +</refsection> +</refentry> diff --git a/params/webhelp.tree.cookie.id.xml b/params/webhelp.tree.cookie.id.xml new file mode 100644 index 0000000..8f790be --- /dev/null +++ b/params/webhelp.tree.cookie.id.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="webhelp.tree.cookie.id"> +<refmeta> +<refentrytitle>webhelp.tree.cookie.id</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>webhelp.tree.cookie.id</refname> +<refpurpose>Controls how the cookie that stores the webhelp toc state is named.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="webhelp.tree.cookie.id.frag"> +<xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(//node()) )"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> +<para>The webhelp output does not use a frameset. Instead, the table of contents is a div on each page. To preserve the state of the table of contents as the user navigates from page to page, webhelp stores the state in a cookie and reads that cookie when you get to the next page. If you've published several webhelp documents on the same domain, it is important that each cookie have a unique id. In lieu of calling on a GUID generator, by default this parameter is just set to the number of nodes in the document on the assumption that it is unlikely that you will have more than one document with the exact number of nodes. A more optimal solution would be for the user to pass in some unique, stable identifier from the build system to use as the webhelp cookie id. For example, if you have safeguards in place to ensure that the xml:id of the root element of each document will be unique on your site, then you could set webhelptree.cookie.id as follows: +<programlisting><![CDATA[ + <xsl:param name="webhelp.tree.cookie.id"> + <xsl:choose> + <xsl:when test="/*/@xml:id"> + <xsl:value-of select="concat('treeview-',/*/@xml:id)"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="concat( 'treeview-', count(//node()) )"/> + </xsl:otherwise> + </xsl:choose> + </xsl:param>]]> + </programlisting> + </para> +</refsection> +</refentry> diff --git a/params/wordml.template.xml b/params/wordml.template.xml new file mode 100644 index 0000000..4dae8a8 --- /dev/null +++ b/params/wordml.template.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="wordml.template"> +<refmeta> +<refentrytitle>wordml.template</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>wordml.template</refname> +<refpurpose>Specify the template WordML document</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="wordml.template.frag"> +<xsl:param name="wordml.template"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The <parameter>wordml.template</parameter> parameter specifies a WordML document to use as a template for the generated document. The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements. Any content in the template document is ignored.</para> + +<para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Word itself, rather than these XSL stylesheets.</para> + +</refsection> +</refentry> diff --git a/params/writing.mode.xml b/params/writing.mode.xml new file mode 100644 index 0000000..c695933 --- /dev/null +++ b/params/writing.mode.xml @@ -0,0 +1,83 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="writing.mode"> +<refmeta> +<refentrytitle>writing.mode</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>writing.mode</refname> +<refpurpose>Direction of text flow based on locale</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="writing.mode.frag"> +<xsl:param name="writing.mode"> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">writing-mode</xsl:with-param> + <xsl:with-param name="lang"> + <xsl:call-template name="l10n.language"> + <xsl:with-param name="target" select="/*[1]"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Sets direction of text flow and text alignment based on locale. +The value is normally taken from the gentext file for the +lang attribute of the document's root element, using the +key name 'writing-mode' to look it up in the gentext file. +But the param can also be +set on the command line to override that gentext value. +</para> +<para>Accepted values are: +<variablelist> + <varlistentry> + <term>lr-tb</term> + <listitem> + <para>Left-to-right text flow in each line, lines stack top to bottom.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rl-tb</term> + <listitem> + <para>Right-to-left text flow in each line, lines stack top to bottom.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>tb-rl</term> + <listitem> + <para>Top-to-bottom text flow in each vertical line, lines stack right to left. + Supported by only a few XSL-FO processors. Not supported in HTML output.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lr</term> + <listitem> + <para>Shorthand for lr-tb.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rl</term> + <listitem> + <para>Shorthand for rl-tb.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>tb</term> + <listitem> + <para>Shorthand for tb-rl.</para> + </listitem> + </varlistentry> +</variablelist> +</para> + +</refsection> +</refentry> diff --git a/params/xbCollapsibleLists.js.xml b/params/xbCollapsibleLists.js.xml new file mode 100644 index 0000000..b30391f --- /dev/null +++ b/params/xbCollapsibleLists.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xbCollapsibleLists.js"> +<refmeta> +<refentrytitle>xbCollapsibleLists.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xbCollapsibleLists.js</refname> +<refpurpose>xbCollapsibleLists JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xbCollapsibleLists.js.frag"> +<xsl:param name="xbCollapsibleLists.js">xbCollapsibleLists.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the xbCollapsibleLists JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/xbDOM.js.xml b/params/xbDOM.js.xml new file mode 100644 index 0000000..a699e9c --- /dev/null +++ b/params/xbDOM.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xbDOM.js"> +<refmeta> +<refentrytitle>xbDOM.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xbDOM.js</refname> +<refpurpose>xbDOM JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xbDOM.js.frag"> +<xsl:param name="xbDOM.js">xbDOM.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the xbDOM JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/xbLibrary.js.xml b/params/xbLibrary.js.xml new file mode 100644 index 0000000..fe2d8fe --- /dev/null +++ b/params/xbLibrary.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xbLibrary.js"> +<refmeta> +<refentrytitle>xbLibrary.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xbLibrary.js</refname> +<refpurpose>xbLibrary JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xbLibrary.js.frag"> +<xsl:param name="xbLibrary.js">xbLibrary.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the xbLibrary JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/xbStyle.js.xml b/params/xbStyle.js.xml new file mode 100644 index 0000000..b587573 --- /dev/null +++ b/params/xbStyle.js.xml @@ -0,0 +1,28 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xbStyle.js"> +<refmeta> +<refentrytitle>xbStyle.js</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">filename</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xbStyle.js</refname> +<refpurpose>xbStyle JavaScript file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xbStyle.js.frag"> +<xsl:param name="xbStyle.js">xbStyle.js</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Specifies the filename of the xbStyle JavaScript file. It's unlikely +that you will ever need to change this parameter.</para> + +</refsection> +</refentry> diff --git a/params/xep.extensions.xml b/params/xep.extensions.xml new file mode 100644 index 0000000..8ac2520 --- /dev/null +++ b/params/xep.extensions.xml @@ -0,0 +1,31 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xep.extensions"> +<refmeta> +<refentrytitle>xep.extensions</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xep.extensions</refname> +<refpurpose>Enable XEP extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xep.extensions.frag"><xsl:param name="xep.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, +<link xlink:href="http://www.renderx.com/">XEP</link> +extensions will be used. XEP extensions consists of PDF bookmarks, +document information and better index processing. +</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> +</refsection> +</refentry> diff --git a/params/xep.index.item.properties.xml b/params/xep.index.item.properties.xml new file mode 100644 index 0000000..b1db129 --- /dev/null +++ b/params/xep.index.item.properties.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xep.index.item.properties"> +<refmeta> +<refentrytitle>xep.index.item.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xep.index.item.properties</refname> +<refpurpose>Properties associated with XEP index-items</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xep.index.item.properties.frag"> +<xsl:attribute-set name="xep.index.item.properties" use-attribute-sets="index.page.number.properties"> + <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute> + <xsl:attribute name="link-back">true</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>Properties associated with XEP index-items, which generate +page numbers in an index processed by XEP. For more info see +the XEP documentation section "Indexes" in +<uri xlink:href="http://www.renderx.com/reference.html#Indexes">http://www.renderx.com/reference.html#Indexes</uri>.</para> + +<para>This attribute-set also adds by default any properties from the +<tag class="attribute">index.page.number.properties</tag> +attribute-set.</para> +</refsection> +</refentry> diff --git a/params/xref.label-page.separator.xml b/params/xref.label-page.separator.xml new file mode 100644 index 0000000..355fc4a --- /dev/null +++ b/params/xref.label-page.separator.xml @@ -0,0 +1,38 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xref.label-page.separator"> +<refmeta> +<refentrytitle>xref.label-page.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-page.separator</refname> +<refpurpose>Punctuation or space separating label from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both label and page +but no title, +then the value of this parameter is inserted between +label and page number in the output. +If a title is included, then other separators are used. +</para> + +</refsection> +</refentry> diff --git a/params/xref.label-title.separator.xml b/params/xref.label-title.separator.xml new file mode 100644 index 0000000..3d6e222 --- /dev/null +++ b/params/xref.label-title.separator.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xref.label-title.separator"> +<refmeta> +<refentrytitle>xref.label-title.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-title.separator</refname> +<refpurpose>Punctuation or space separating label from title in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xref.label-title.separator.frag"><xsl:param name="xref.label-title.separator">: </xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both label and title, +then the value of this parameter is inserted between +label and title in the output. +</para> + +</refsection> +</refentry> diff --git a/params/xref.properties.xml b/params/xref.properties.xml new file mode 100644 index 0000000..6438f6c --- /dev/null +++ b/params/xref.properties.xml @@ -0,0 +1,29 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xref.properties"> +<refmeta> +<refentrytitle>xref.properties</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.properties</refname> +<refpurpose>Properties associated with cross-reference text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xref.properties.frag"> +<xsl:attribute-set name="xref.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>This attribute set is used to set properties +on cross reference text.</para> + +</refsection> +</refentry> diff --git a/params/xref.title-page.separator.xml b/params/xref.title-page.separator.xml new file mode 100644 index 0000000..32ef9f1 --- /dev/null +++ b/params/xref.title-page.separator.xml @@ -0,0 +1,36 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xref.title-page.separator"> +<refmeta> +<refentrytitle>xref.title-page.separator</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.title-page.separator</refname> +<refpurpose>Punctuation or space separating title from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xref.title-page.separator.frag"><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<tag class="element">xref</tag> or +<tag class="element">olink</tag> element +using an <tag class="attribute">xrefstyle</tag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both title and page number, +then the value of this parameter is inserted between +title and page number in the output. +</para> + +</refsection> +</refentry> diff --git a/params/xref.with.number.and.title.xml b/params/xref.with.number.and.title.xml new file mode 100644 index 0000000..06fcc7e --- /dev/null +++ b/params/xref.with.number.and.title.xml @@ -0,0 +1,30 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="xref.with.number.and.title"> +<refmeta> +<refentrytitle>xref.with.number.and.title</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.with.number.and.title</refname> +<refpurpose>Use number and title in cross references</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="xref.with.number.and.title.frag"> +<xsl:param name="xref.with.number.and.title" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>A cross reference may include the number (for example, the number of +an example or figure) and the <tag>title</tag> which is a required child of some +targets. This parameter inserts both the relevant number as well as +the title into the link. </para> + +</refsection> +</refentry> |
