olink.docbook-xsl.html.pi.xml Maven / Gradle / Ivy
<?xml version="1.0"?>
<reference><info><title>HTML Processing Instruction Reference</title>
<releaseinfo role="meta">
$Id: pi.xsl 9022 2011-07-14 19:21:36Z bobstayton $
</releaseinfo>
</info>
<partintro xml:id="partintro">
<title>Introduction</title>
<para>This is generated reference documentation for all
user-specifiable processing instructions (PIs) in the DocBook
XSL stylesheets for HTML output.
<note>
<para>You add these PIs at particular points in a document to
cause specific “exceptions” to formatting/output behavior. To
make global changes in formatting/output behavior across an
entire document, it’s better to do it by setting an
appropriate stylesheet parameter (if there is one).</para>
</note>
</para>
</partintro>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_background-color">
<refnamediv>
<refname>dbhtml_background-color</refname>
<refpurpose>Sets background color for an image</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml background-color</tag> PI before or
after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
<tag>imagedata</tag>, or <tag>videodata</tag> element) as a
sibling to the element, to set a background color for the
image.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
<listitem>
<para>An HTML color value</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_bgcolor">
<refnamediv>
<refname>dbhtml_bgcolor</refname>
<refpurpose>Sets background color on a CALS table row or table cell</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a CALS table row
or cell to set a background color for that table row or cell.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
<listitem>
<para>An HTML color value</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_cellpadding">
<refnamediv>
<refname>dbhtml_cellpadding</refname>
<refpurpose>Specifies cellpadding in CALS table or qandaset output</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
for the HTML <literal>cellpadding</literal> attribute in the
output HTML table.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
<listitem>
<para>Specifies the cellpadding</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>html.cellpadding</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
<link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_cellspacing">
<refnamediv>
<refname>dbhtml_cellspacing</refname>
<refpurpose>Specifies cellspacing in CALS table or qandaset output</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
CALS <tag>table</tag> or <tag>qandaset</tag> to specify the value
for the HTML <literal>cellspacing</literal> attribute in the
output HTML table.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
<listitem>
<para>Specifies the cellspacing</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>html.cellspacing</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="CellSpacing.html">Cell spacing and cell padding</link>,
<link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_class">
<refnamediv>
<refname>dbhtml_class</refname>
<refpurpose>Set value of the class attribute for a CALS table row</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml class</tag> PI as a child of a
<tag>row</tag> to specify a <literal>class</literal>
attribute and value in the HTML output for that row.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>class="<replaceable>name</replaceable>"</term>
<listitem>
<para>Specifies the class name</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_dir">
<refnamediv>
<refname>dbhtml_dir</refname>
<refpurpose>Specifies a directory name in which to write files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>When chunking output, use the <tag class="xmlpi">dbhtml dir</tag> PI
as a child of a chunk source to cause the output of that
chunk to be written to the specified directory; also, use it
as a child of a <tag>mediaobject</tag> to specify a
directory into which any long-description files for that
<tag>mediaobject</tag> will be written.</para>
<para>The output directory specification is inherited by all
chunks of the descendants of the element. If descendants need
to go to a different directory, then add another
<tag class="xmlpi">dbhtml dir</tag> processing
instruction as a child of the source element
for that chunk, and specify the path relative to the
ancestor path.</para>
<para>For example, to put most chunk files into
<filename class="directory">shared</filename>
but one chapter into
<filename class="directory">exception</filename>
at the same level, use:</para>
<programlisting><book>
<?dbhtml dir="shared"?>
...
<chapter>
<?dbhtml dir="../exception"?>
</chapter>
</book>
</programlisting>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>dir="<replaceable>path</replaceable>"</term>
<listitem>
<para>Specifies the pathname for the directory</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>base.dir</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_filename">
<refnamediv>
<refname>dbhtml_filename</refname>
<refpurpose>Specifies a filename for a chunk</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>When chunking output, use the <tag class="xmlpi">dbhtml filename</tag>
PI as a child of a chunk source to specify a filename for
the output file for that chunk. Include the filename suffix.</para>
<para>You cannot include a directory path in the filename value,
or your links may not work. Add a
<tag class="xmlpi">dbhtml dir</tag> processing instruction
to specify the output directory. You can also combine the two
specifications in one processing instruction:
<tag class="xmlpi">dbhtml dir="mydir" filename="myfile.html"</tag>.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>filename="<replaceable>path</replaceable>"</term>
<listitem>
<para>Specifies the filename for the file</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>use.id.as.filename</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_funcsynopsis-style">
<refnamediv>
<refname>dbhtml_funcsynopsis-style</refname>
<refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
to control the presentation style for output of all
<tag>funcprototype</tag> instances within that funcsynopsis.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>funcsynopsis-style="kr"</term>
<listitem>
<para>Displays <tag>funcprototype</tag> output in K&R style</para>
</listitem>
</varlistentry>
<varlistentry><term>funcsynopsis-style="ansi"</term>
<listitem>
<para>Displays <tag>funcprototype</tag> output in ANSI style</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>funcsynopsis.style</parameter></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_img.src.path">
<refnamediv>
<refname>dbhtml_img.src.path</refname>
<refpurpose>Specifies a path to the location of an image file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml img.src.path</tag> PI before or
after an image (<tag>graphic</tag>,
<tag>inlinegraphic</tag>, <tag>imagedata</tag>, or
<tag>videodata</tag> element) as a sibling to the element,
to specify a path to the location of the image; in HTML
output, the value specified for the
<code>img.src.path</code> attribute is prepended to the
filename.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>img.src.path="<replaceable>path</replaceable>"</term>
<listitem>
<para>Specifies the pathname to prepend to the name of the image file</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>img.src.path</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_label-width">
<refnamediv>
<refname>dbhtml_label-width</refname>
<refpurpose>Specifies the label width for a qandaset</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml label-width</tag> PI as a child of a
<tag>qandaset</tag> to specify the width of labels.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the label width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.everyNth">
<refnamediv>
<refname>dbhtml_linenumbering.everyNth</refname>
<refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml linenumbering.everyNth</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the interval at which lines are numbered.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
<listitem>
<para>Specifies numbering interval; a number is output
before every <replaceable>N</replaceable>th line</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>linenumbering.everyNth</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.separator">
<refnamediv>
<refname>dbhtml_linenumbering.separator</refname>
<refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml linenumbering.separator</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the separator text output between the line numbers and content.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
<listitem>
<para>Specifies the text (zero or more characters)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>linenumbering.separator</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_linenumbering.width">
<refnamediv>
<refname>dbhtml_linenumbering.width</refname>
<refpurpose>Specifies width for line numbers in verbatims</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml linenumbering.width</tag> PI as a child
of a “verbatim” element – <tag>programlisting</tag>,
<tag>screen</tag>, <tag>synopsis</tag> — to specify
the width set aside for line numbers.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the width (inluding units)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>linenumbering.width</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_list-presentation">
<refnamediv>
<refname>dbhtml_list-presentation</refname>
<refpurpose>Specifies presentation style for a variablelist or
segmentedlist</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml list-presentation</tag> PI as a child of
a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
control the presentation style for the list (to cause it, for
example, to be displayed as a table).</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>list-presentation="list"</term>
<listitem>
<para>Displays the list as a list</para>
</listitem>
</varlistentry>
<varlistentry><term>list-presentation="table"</term>
<listitem>
<para>Displays the list as a table</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<itemizedlist>
<listitem>
<para><parameter>variablelist.as.table</parameter></para>
</listitem>
<listitem>
<para><parameter>segmentedlist.as.table</parameter></para>
</listitem>
</itemizedlist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_list-width">
<refnamediv>
<refname>dbhtml_list-width</refname>
<refpurpose>Specifies the width of a variablelist or simplelist</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml list-width</tag> PI as a child of a
<tag>variablelist</tag> or a <tag>simplelist</tag> presented
as a table, to specify the output width.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the output width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_row-height">
<refnamediv>
<refname>dbhtml_row-height</refname>
<refpurpose>Specifies the height for a CALS table row</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml row-height</tag> PI as a child of a
<tag>row</tag> to specify the height of the row.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
<listitem>
<para>Specifies the row height (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_start">
<refnamediv>
<refname>dbhtml_start</refname>
<refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><emphasis>This PI is obsolete</emphasis>. The intent of
this PI was to provide a means for setting a specific starting
number for an ordered list. Instead of this PI, set a value
for the <literal>override</literal> attribute on the first
<tag>listitem</tag> in the list; that will have the same
effect as what this PI was intended for.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>start="<replaceable>character</replaceable>"</term>
<listitem>
<para>Specifies the character to use as the starting
number; use 0-9, a-z, A-Z, or lowercase or uppercase
Roman numerals</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_stop-chunking">
<refnamediv>
<refname>dbhtml_stop-chunking</refname>
<refpurpose>Do not chunk any descendants of this element.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml stop-chunking</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>When generating chunked HTML output, adding this PI as the child of an element that contains elements that would normally be generated on separate pages if generating chunked output causes chunking to stop at this point. No descendants of the current element will be split into new HTML pages:
<programlisting><section>
<title>Configuring pencil</title>
<?dbhtml stop-chunking?>
...
</section></programlisting>
</para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Chunking.html">Chunking into multiple HTML files</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_table-summary">
<refnamediv>
<refname>dbhtml_table-summary</refname>
<refpurpose>Specifies summary for CALS table, variablelist, segmentedlist, or qandaset output</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
a CALS <tag>table</tag>, <tag>variablelist</tag>,
<tag>segmentedlist</tag>, or <tag>qandaset</tag> to specify
the text for the HTML <literal>summary</literal> attribute
in the output HTML table.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
<listitem>
<para>Specifies the summary text (zero or more characters)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link>,
<link role="tcg" xlink:href="TableSummary.html">Table summary text</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_table-width">
<refnamediv>
<refname>dbhtml_table-width</refname>
<refpurpose>Specifies the width for a CALS table</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
CALS <tag>table</tag> to specify the width of the table in
output.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the table width (including units or as a percentage)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>default.table.width</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-presentation">
<refnamediv>
<refname>dbhtml_term-presentation</refname>
<refpurpose>Sets character formatting for terms in a variablelist</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml term-presentation</tag> PI as a child
of a <tag>variablelist</tag> to set character formatting for
the <tag>term</tag> output of the list.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>term-presentation="<replaceable>bold</replaceable>"</term>
<listitem>
<para>Specifies that terms are displayed in bold</para>
</listitem>
</varlistentry>
<varlistentry><term>term-presentation="<replaceable>italic</replaceable>"</term>
<listitem>
<para>Specifies that terms are displayed in italic</para>
</listitem>
</varlistentry>
<varlistentry><term>term-presentation="<replaceable>bold-italic</replaceable>"</term>
<listitem>
<para>Specifies that terms are displayed in bold-italic</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-separator">
<refnamediv>
<refname>dbhtml_term-separator</refname>
<refpurpose>Specifies separator text among terms in a varlistentry</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml term-separator</tag> PI as a child
of a <tag>variablelist</tag> to specify the separator text
among <tag>term</tag> instances.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
<listitem>
<para>Specifies the text (zero or more characters)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>variablelist.term.separator</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_term-width">
<refnamediv>
<refname>dbhtml_term-width</refname>
<refpurpose>Specifies the term width for a variablelist</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml term-width</tag> PI as a child of a
<tag>variablelist</tag> to specify the width for
<tag>term</tag> output.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
<listitem>
<para>Specifies the term width (including units)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml_toc">
<refnamediv>
<refname>dbhtml_toc</refname>
<refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml toc</tag> PI as a child of a
<tag>qandaset</tag> to specify whether a table of contents
(TOC) is generated for the <tag>qandaset</tag>.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>toc="0"</term>
<listitem>
<para>If zero, no TOC is generated</para>
</listitem>
</varlistentry>
<varlistentry><term>toc="1"</term>
<listitem>
<para>If <code>1</code> (or any non-zero value),
a TOC is generated</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
<link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbcmdlist">
<refnamediv>
<refname>dbcmdlist</refname>
<refpurpose>Generates a hyperlinked list of commands</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
element (for example, <tag>refsynopsisdiv</tag>) containing multiple
<tag>cmdsynopsis</tag> instances; a hyperlinked navigational
“command list” will be generated at the top of output for that
element, enabling users to quickly jump
to each command synopsis.</para>
</refsect1><refsect1><title>Parameters</title>
<para>[No parameters]</para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfunclist">
<refnamediv>
<refname>dbfunclist</refname>
<refpurpose>Generates a hyperlinked list of functions</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
element (for example, <tag>refsynopsisdiv</tag>) containing multiple
<tag>funcsynopsis</tag> instances; a hyperlinked
navigational “function list” will be generated at the top of
output for that element, enabling users to quickly
jump to to each function synopsis.</para>
</refsect1><refsect1><title>Parameters</title>
<para>[No parameters]</para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhtml-include_href">
<refnamediv>
<refname>dbhtml-include_href</refname>
<refpurpose>Copies an external well-formed HTML/XML file into current doc</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhtml-include href</tag> PI anywhere in a
document to cause the contents of the file referenced by the
<code>href</code> pseudo-attribute to be copied/inserted “as
is” into your HTML output at the point in document order
where the PI occurs in the source.</para>
<note>
<para>The referenced file may contain plain text (as long as
it is “wrapped” in an <tag>html</tag> element — see the
note below) or markup in any arbitrary vocabulary,
including HTML — but it must conform to XML
well-formedness constraints (because the feature in XSLT
1.0 for opening external files, the
<function>document()</function> function, can only handle
files that meet XML well-formedness constraints).</para>
<para>Among other things, XML well-formedness constraints
require a document to have <emphasis>a single root
element</emphasis>. So if the content you want to
include is plain text or is markup that does
<emphasis>not</emphasis> have a single root element,
<emphasis role="strong">wrap the content in an
<tag>html</tag> element</emphasis>. The stylesheets will
strip out that surrounding <tag>html</tag> “wrapper” when
they find it, leaving just the content you want to
insert.</para>
</note>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>href="<replaceable>URI</replaceable>"</term>
<listitem>
<para>Specifies the URI for the file to include; the URI
can be, for example, a remote <literal>http:</literal>
URI, or a local filesystem <literal>file:</literal>
URI</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="params"><title>Related Global Parameters</title>
<para><parameter>textinsert.extension</parameter></para>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
<link role="tcg" xlink:href="ExternalCode.html">External code files</link></para>
</refsect1></refentry>
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbhh">
<refnamediv>
<refname>dbhh</refname>
<refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
that should be used as targets for context-sensitive help requests.</para>
</refsect1><refsect1><title>Parameters</title>
<variablelist>
<varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
<listitem>
<para>Specifies a unique string constant that identifies a help topic</para>
</listitem>
</varlistentry>
<varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
<listitem>
<para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
<para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
</refsect1></refentry>
</reference>
© 2015 - 2024 Weber Informatics LLC | Privacy Policy