123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182 |
- <?xml version="1.0" encoding="ASCII"?>
- <!--This file was created automatically by html2xhtml-->
- <!--from the HTML stylesheets.-->
- <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/1999/xhtml" exclude-result-prefixes="doc" version="1.0">
- <!-- ********************************************************************
- $Id$
- ********************************************************************
- This file is part of the XSL DocBook Stylesheet distribution.
- See ../README or http://docbook.sf.net/release/xsl/current/ for
- copyright and other information.
- ******************************************************************** -->
- <doc:reference xmlns=""><info xmlns="http://www.w3.org/1999/xhtml"><title>HTML Processing Instruction Reference</title>
- <releaseinfo role="meta">
- $Id$
- </releaseinfo>
- </info>
- <partintro xmlns="http://www.w3.org/1999/xhtml" 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>
- </doc:reference>
- <!-- ==================================================================== -->
- <doc:pi xmlns="" name="dbhtml_background-color">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Sets background color for an image</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml background-color="<replaceable>color</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
- <listitem>
- <para>An HTML color value</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_background-color">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'background-color'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_bgcolor">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Sets background color on a table row or table cell</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml bgcolor</tag> PI as child of a table row
- or cell to set a background color for that table row or cell.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
- <listitem>
- <para>An HTML color value</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_bgcolor">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'bgcolor'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_cellpadding">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies cellpadding in table or qandaset output</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml cellpadding</tag> PI as a child of a
- <tag>table</tag> or <tag>qandaset</tag> to specify the value
- for the HTML <literal>cellpadding</literal> attribute in the
- output HTML table.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml cellpadding="<replaceable>number</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>cellpadding="<replaceable>number</replaceable>"</term>
- <listitem>
- <para>Specifies the cellpadding</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>html.cellpadding</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <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>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_cellpadding">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'cellpadding'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_cellspacing">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies cellspacing in table or qandaset output</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml cellspacing</tag> PI as a child of a
- <tag>table</tag> or <tag>qandaset</tag> to specify the value
- for the HTML <literal>cellspacing</literal> attribute in the
- output HTML table.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml cellspacing="<replaceable>number</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>cellspacing="<replaceable>number</replaceable>"</term>
- <listitem>
- <para>Specifies the cellspacing</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>html.cellspacing</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <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>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_cellspacing">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'cellspacing'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_class">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Set value of the class attribute for a table row</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml class="<replaceable>name</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>class="<replaceable>name</replaceable>"</term>
- <listitem>
- <para>Specifies the class name</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="CSSTableCells.html">Table styles in HTML output</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_class">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'class'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_dir">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies a directory name in which to write files</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml dir="<replaceable>path</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>dir="<replaceable>path</replaceable>"</term>
- <listitem>
- <para>Specifies the pathname for the directory</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>base.dir</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Chunking.html#dbhtmlDirPI">dbhtml dir processing instruction</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_dir">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'dir'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_filename">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies a filename for a chunk</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml filename="<replaceable>filename</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>filename="<replaceable>path</replaceable>"</term>
- <listitem>
- <para>Specifies the filename for the file</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>use.id.as.filename</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Chunking.html#DbhtmlFilenames">dbhtml filenames</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_filename">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'filename'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_funcsynopsis-style">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies presentation style for a funcsynopsis</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml funcsynopsis-style</tag> PI as a child of
- a <tag>funcprototype</tag> or anywhere within a funcprototype
- control the presentation style for the <tag>funcsynopsis</tag>
- in output.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml funcsynopsis-style="kr"|"ansi"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>funcsynopsis-style="kr"</term>
- <listitem>
- <para>Displays the <tag>funcprototype</tag> in K&R style</para>
- </listitem>
- </varlistentry>
- <varlistentry><term>funcsynopsis-style="ansi"</term>
- <listitem>
- <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>funcsynopsis.style</parameter></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_funcsynopsis-style">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'funcsynopsis-style'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_img.src.path">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies a path to the location of an image file</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml img.src.path="<replaceable>path</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>img.src.path</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="GraphicsLocations.html#UsingFileref">Using fileref</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_img.src.path">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'img.src.path'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_label-width">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies the label width for a qandaset</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml label-width="<replaceable>width</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
- <listitem>
- <para>Specifies the label width (including units)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_label-width">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'label-width'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_linenumbering.everyNth">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies interval for lines numbers in verbatims</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>linenumbering.everyNth</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_linenumbering.everyNth">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'linenumbering.everyNth'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_linenumbering.separator">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies separator text for line numbers in verbatims</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
- <listitem>
- <para>Specifies the text (zero or more characters)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>linenumbering.separator</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_linenumbering.separator">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'linenumbering.separator'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_linenumbering.width">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies width for line numbers in verbatims</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
- <listitem>
- <para>Specifies the width (inluding units)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>linenumbering.width</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_linenumbering.width">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'linenumbering.width'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_list-presentation">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies presentation style for a variablelist or
- segmentedlist</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml list-presentation="list"|"table"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <itemizedlist>
- <listitem>
- <para><parameter>variablelist.as.table</parameter></para>
- </listitem>
- <listitem>
- <para><parameter>segmentedlist.as.table</parameter></para>
- </listitem>
- </itemizedlist>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_list-presentation">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'list-presentation'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_list-width">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies the width of a variablelist or simplelist</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml list-width="<replaceable>width</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
- <listitem>
- <para>Specifies the output width (including units)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_list-width">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'list-width'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_row-height">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies the height for a table row</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml row-height="<replaceable>height</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
- <listitem>
- <para>Specifies the label height (including units)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_row-height">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'row-height'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_start">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">(obsolete) Sets the starting number on an ordered list</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml start="<replaceable>character</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_start">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="pi-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'start'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_table-summary">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies summary for table, variablelist, segmentedlist, or qandaset output</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml table-summary</tag> PI as a child of
- a <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml table-summary="<replaceable>text</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>table-summary="<replaceable>text</replaceable>"</term>
- <listitem>
- <para>Specifies the summary text (zero or more characters)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <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>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_table-summary">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'table-summary'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_table-width">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies the width for a table</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <para>Use the <tag class="xmlpi">dbhtml table-width</tag> PI as a child of a
- <tag>table</tag> to specify the width of the table in
- output.</para>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml table-width="<replaceable>width</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>default.table.width</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_table-width">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'table-width'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_term-presentation">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Sets character formatting for terms in a variablelist</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml term-presentation="bold"|"italic"|"bold-italic"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_term-presentation">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'term-presentation'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_term-separator">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies separator text among terms in a varlistentry</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml term-separator="<replaceable>text</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>term-separator="<replaceable>text</replaceable>"</term>
- <listitem>
- <para>Specifies the text (zero or more characters)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>variablelist.term.separator</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_term-separator">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'term-separator'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_term-width">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies the term width for a variablelist</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml term-width="<replaceable>width</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <variablelist>
- <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
- <listitem>
- <para>Specifies the term width (including units)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="Variablelists.html#VarListFormatting">Variable list formatting in HTML</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_term-width">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'term-width'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml_toc">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Specifies whether a TOC should be generated for a qandaset</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml toc="0"|"1"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <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>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml_toc">
- <xsl:param name="node" select="."/>
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="$node/processing-instruction('dbhtml')"/>
- <xsl:with-param name="attribute" select="'toc'"/>
- </xsl:call-template>
- </xsl:template>
- <doc:pi xmlns="" name="dbcmdlist">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Generates a hyperlinked list of commands</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <para>[No parameters]</para>
- </refparameter>
- </doc:pi>
- <xsl:template name="pi.dbcmdlist">
- <xsl:variable name="cmdsynopses" select="..//cmdsynopsis"/>
- <xsl:if test="count($cmdsynopses)<1">
- <xsl:message><xsl:text>No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep?</xsl:text>
- </xsl:message>
- </xsl:if>
- <dl>
- <xsl:call-template name="process.cmdsynopsis.list">
- <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
- </xsl:call-template>
- </dl>
- </xsl:template>
- <doc:pi xmlns="" name="dbfunclist">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Generates a hyperlinked list of functions</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbfunclist</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <para>[No parameters]</para>
- </refparameter>
- </doc:pi>
- <xsl:template name="pi.dbfunclist">
- <xsl:variable name="funcsynopses" select="..//funcsynopsis"/>
- <xsl:if test="count($funcsynopses)<1">
- <xsl:message><xsl:text>No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep?</xsl:text>
- </xsl:message>
- </xsl:if>
- <dl>
- <xsl:call-template name="process.funcsynopsis.list">
- <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
- </xsl:call-template>
- </dl>
- </xsl:template>
- <doc:pi xmlns="" name="dbhtml-include_href">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Copies an external well-formed HTML/XML file into current doc</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhtml-include href="<replaceable>URI</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="params">
- <para><parameter>textinsert.extension</parameter></para>
- </refsee>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>,
- <link xlink:href="ExternalCode.html">External code files</link></para>
- </refsee>
- </doc:pi>
- <xsl:template name="pi.dbhtml-include">
- <xsl:param name="href">
- <xsl:call-template name="dbhtml-attribute">
- <xsl:with-param name="pis" select="."/>
- <xsl:with-param name="attribute">href</xsl:with-param>
- </xsl:call-template>
- </xsl:param>
- <xsl:choose>
- <xsl:when test="$href != ''">
- <xsl:variable name="content" select="document($href,/)"/>
- <xsl:choose>
- <xsl:when test="$content/*">
- <xsl:choose>
- <xsl:when test="$content/*[1][self::html]">
- <!-- include just the children of html wrapper -->
- <xsl:copy-of select="$content/*[1]/node()"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:copy-of select="$content"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:when>
- <xsl:otherwise>
- <xsl:message>
- <xsl:text>ERROR: dbhtml-include processing instruction </xsl:text>
- <xsl:text>href has no content.</xsl:text>
- </xsl:message>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:when>
- <xsl:otherwise>
- <xsl:message>
- <xsl:text>ERROR: dbhtml-include processing instruction has </xsl:text>
- <xsl:text>missing or empty href value.</xsl:text>
- </xsl:message>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template name="dbhtml-attribute">
- <!-- * dbhtml-attribute is an interal utility template for retrieving -->
- <!-- * pseudo-attributes/parameters from PIs -->
- <xsl:param name="pis" select="processing-instruction('dbhtml')"/>
- <xsl:param name="attribute">filename</xsl:param>
- <xsl:call-template name="pi-attribute">
- <xsl:with-param name="pis" select="$pis"/>
- <xsl:with-param name="attribute" select="$attribute"/>
- </xsl:call-template>
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template match="processing-instruction()">
- </xsl:template>
- <xsl:template match="processing-instruction('dbhtml')">
- <!-- nop -->
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template match="processing-instruction('dbcmdlist')">
- <xsl:call-template name="pi.dbcmdlist"/>
- </xsl:template>
- <xsl:template name="process.cmdsynopsis.list">
- <xsl:param name="cmdsynopses"/><!-- empty node list by default -->
- <xsl:param name="count" select="1"/>
- <xsl:choose>
- <xsl:when test="$count>count($cmdsynopses)"/>
- <xsl:otherwise>
- <xsl:variable name="cmdsyn" select="$cmdsynopses[$count]"/>
- <dt>
- <a>
- <xsl:attribute name="href">
- <xsl:text>#</xsl:text>
- <xsl:call-template name="object.id">
- <xsl:with-param name="object" select="$cmdsyn"/>
- </xsl:call-template>
- </xsl:attribute>
- <xsl:choose>
- <xsl:when test="$cmdsyn/@xreflabel">
- <xsl:call-template name="xref.xreflabel">
- <xsl:with-param name="target" select="$cmdsyn"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:otherwise>
- <xsl:apply-templates select="$cmdsyn" mode="xref-to">
- <xsl:with-param name="target" select="$cmdsyn"/>
- </xsl:apply-templates>
- </xsl:otherwise>
- </xsl:choose>
- </a>
- </dt>
- <xsl:call-template name="process.cmdsynopsis.list">
- <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/>
- <xsl:with-param name="count" select="$count+1"/>
- </xsl:call-template>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template match="processing-instruction('dbfunclist')">
- <xsl:call-template name="pi.dbfunclist"/>
- </xsl:template>
- <xsl:template name="process.funcsynopsis.list">
- <xsl:param name="funcsynopses"/><!-- empty node list by default -->
- <xsl:param name="count" select="1"/>
- <xsl:choose>
- <xsl:when test="$count>count($funcsynopses)"/>
- <xsl:otherwise>
- <xsl:variable name="cmdsyn" select="$funcsynopses[$count]"/>
- <dt>
- <a>
- <xsl:attribute name="href">
- <xsl:text>#</xsl:text>
- <xsl:call-template name="object.id">
- <xsl:with-param name="object" select="$cmdsyn"/>
- </xsl:call-template>
- </xsl:attribute>
- <xsl:choose>
- <xsl:when test="$cmdsyn/@xreflabel">
- <xsl:call-template name="xref.xreflabel">
- <xsl:with-param name="target" select="$cmdsyn"/>
- </xsl:call-template>
- </xsl:when>
- <xsl:otherwise>
- <xsl:apply-templates select="$cmdsyn" mode="xref-to">
- <xsl:with-param name="target" select="$cmdsyn"/>
- </xsl:apply-templates>
- </xsl:otherwise>
- </xsl:choose>
- </a>
- </dt>
- <xsl:call-template name="process.funcsynopsis.list">
- <xsl:with-param name="funcsynopses" select="$funcsynopses"/>
- <xsl:with-param name="count" select="$count+1"/>
- </xsl:call-template>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template match="processing-instruction('dbhtml-include')">
- <xsl:call-template name="pi.dbhtml-include"/>
- </xsl:template>
- <!-- ==================================================================== -->
- <xsl:template name="dbhtml-dir">
- <xsl:param name="context" select="."/>
- <!-- directories are now inherited from previous levels -->
- <xsl:variable name="ppath">
- <xsl:if test="$context/parent::*">
- <xsl:call-template name="dbhtml-dir">
- <xsl:with-param name="context" select="$context/parent::*"/>
- </xsl:call-template>
- </xsl:if>
- </xsl:variable>
- <xsl:variable name="path">
- <xsl:call-template name="pi.dbhtml_dir">
- <xsl:with-param name="node" select="$context"/>
- </xsl:call-template>
- </xsl:variable>
- <xsl:choose>
- <xsl:when test="$path = ''">
- <xsl:if test="$ppath != ''">
- <xsl:value-of select="$ppath"/>
- </xsl:if>
- </xsl:when>
- <xsl:otherwise>
- <xsl:if test="$ppath != ''">
- <xsl:value-of select="$ppath"/>
- <xsl:if test="substring($ppath, string-length($ppath), 1) != '/'">
- <xsl:text>/</xsl:text>
- </xsl:if>
- </xsl:if>
- <xsl:value-of select="$path"/>
- <xsl:text>/</xsl:text>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
- <!-- There are two templates matching this PI in htmlhelp-common.xsl -->
- <doc:pi xmlns="" name="dbhh">
- <refpurpose xmlns="http://www.w3.org/1999/xhtml">Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
- <refdescription xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refdescription>
- <refsynopsisdiv xmlns="http://www.w3.org/1999/xhtml">
- <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
- </refsynopsisdiv>
- <refparameter xmlns="http://www.w3.org/1999/xhtml">
- <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>
- </refparameter>
- <refsee xmlns="http://www.w3.org/1999/xhtml" role="tcg">
- <para><link role="tcg" xlink:href="HtmlHelp.html#HHContextHelp">Context-sensitive help</link></para>
- </refsee>
- </doc:pi>
- </xsl:stylesheet>
|