summaryrefslogtreecommitdiff
path: root/common/pi.xml
diff options
context:
space:
mode:
Diffstat (limited to 'common/pi.xml')
-rw-r--r--common/pi.xml168
1 files changed, 168 insertions, 0 deletions
diff --git a/common/pi.xml b/common/pi.xml
new file mode 100644
index 0000000..64efdca
--- /dev/null
+++ b/common/pi.xml
@@ -0,0 +1,168 @@
+<?xml version="1.0"?>
+
+<reference><info><title>Common Processing Instruction Reference</title>
+ <releaseinfo role="meta">
+ $Id: pi.xsl 8782 2010-07-27 21:15:17Z mzjn $
+ </releaseinfo>
+ </info>
+ <partintro xml:id="partintro">
+ <title>Introduction</title>
+
+<para>This is generated reference documentation for all
+ user-specifiable processing instructions (PIs) in the
+ “common” part of the DocBook XSL stylesheets.
+ <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="dbchoice_choice">
+<refnamediv>
+<refname>dbchoice_choice</refname>
+<refpurpose>Generates a localized choice separator</refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+
+ <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
+
+</refsynopsisdiv>
+<refsect1><title>Description</title>
+
+<para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
+ generate an appropriate localized “choice” separator (for
+ example, <literal>and</literal> or <literal>or</literal>)
+ before the final item in an inline <tag>simplelist</tag></para>
+
+ <warning>
+
+<para>This PI is a less-than-ideal hack; support for it may
+ disappear in the future (particularly if and when a more
+ appropriate means for marking up "choice" lists becomes
+ available in DocBook).</para>
+
+ </warning>
+ </refsect1><refsect1><title>Parameters</title>
+
+<variablelist>
+ <varlistentry><term>choice="and"</term>
+ <listitem>
+
+<para>generates a localized <literal>and</literal> separator</para>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>choice="or"</term>
+ <listitem>
+
+<para>generates a localized <literal>or</literal> separator</para>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
+ <listitem>
+
+<para>generates a literal <replaceable>string</replaceable> separator</para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect1></refentry>
+
+<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbtimestamp">
+<refnamediv>
+<refname>dbtimestamp</refname>
+<refpurpose>Inserts a date timestamp</refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+
+ <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
+
+</refsynopsisdiv>
+<refsect1><title>Description</title>
+
+<para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
+ source document to cause a date timestamp (a formatted
+ string representing the current date and time) to be
+ inserted in output of the document.</para>
+
+ </refsect1><refsect1><title>Parameters</title>
+
+<variablelist>
+ <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
+ <listitem>
+
+<para>Specifies format in which the date and time are
+ output</para>
+
+ <note>
+
+<para>For details of the content of the format string,
+ see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
+
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>padding="0"|"1"</term>
+ <listitem>
+
+<para>Specifies padding behavior; if non-zero, padding is is added</para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect1></refentry>
+
+<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbtex_delims">
+<refnamediv>
+<refname>dbtex_delims</refname>
+<refpurpose>Generates delimiters around embedded TeX equations
+ in output</refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+
+ <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
+
+</refsynopsisdiv>
+<refsect1><title>Description</title>
+
+<para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
+ child of a <tag>textobject</tag> containing embedded TeX
+ markup, to cause that markup to be surrounded by
+ <literal>$</literal> delimiter characters in output.</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>
+ </refsect1><refsect1><title>Parameters</title>
+
+<variablelist>
+ <varlistentry><term>dbtex delims="no"|"yes"</term>
+ <listitem>
+
+<para>Specifies whether delimiters are output</para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
+
+<para><parameter>tex.math.delims</parameter></para>
+
+ </refsect1></refentry>
+</reference>
+