lib/docbook/common/pi.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <reference xmlns:xlink="http://www.w3.org/1999/xlink"><info><title>Common Processing Instruction Reference</title>
   3     <releaseinfo role="meta">
   4     </releaseinfo>
   5   </info>
   6   <partintro xml:id="partintro">
   7     <title>Introduction</title>
   8
   9 <para>This is generated reference documentation for all
  10       user-specifiable processing instructions (PIs) in the
  11       “common” part of the DocBook XSL stylesheets.
  12       <note>
  13
  14 <para>You add these PIs at particular points in a document to
  15           cause specific “exceptions” to formatting/output behavior. To
  16           make global changes in formatting/output behavior across an
  17           entire document, it’s better to do it by setting an
  18           appropriate stylesheet parameter (if there is one).</para>
  19
  20       </note>
  21     </para>
  22
  23   </partintro>
  24
  25 <refentry xml:id="dbchoice_choice">
  26 <refnamediv>
  27 <refname>dbchoice_choice</refname>
  28 <refpurpose>Generates a localized choice separator</refpurpose>
  29 </refnamediv>
  30 <refsynopsisdiv>
  31
  32     <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
  33
  34 </refsynopsisdiv>
  35 <refsect1><title>Description</title>
  36
  37 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
  38       generate an appropriate localized “choice” separator (for
  39       example, <literal>and</literal> or <literal>or</literal>)
  40       before the final item in an inline <tag>simplelist</tag></para>
  41
  42     <warning>
  43
  44 <para>This PI is a less-than-ideal hack; support for it may
  45         disappear in the future (particularly if and when a more
  46         appropriate means for marking up "choice" lists becomes
  47         available in DocBook).</para>
  48
  49     </warning>
  50   </refsect1><refsect1><title>Parameters</title>
  51
  52 <variablelist>
  53       <varlistentry><term>choice="and"</term>
  54         <listitem>
  55
  56 <para>generates a localized <literal>and</literal> separator</para>
  57
  58         </listitem>
  59       </varlistentry>
  60       <varlistentry><term>choice="or"</term>
  61         <listitem>
  62
  63 <para>generates a localized <literal>or</literal> separator</para>
  64
  65         </listitem>
  66       </varlistentry>
  67       <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
  68         <listitem>
  69
  70 <para>generates a literal <replaceable>string</replaceable> separator</para>
  71
  72         </listitem>
  73       </varlistentry>
  74     </variablelist>
  75
  76   </refsect1></refentry>
  77
  78 <refentry xml:id="dbtimestamp">
  79 <refnamediv>
  80 <refname>dbtimestamp</refname>
  81 <refpurpose>Inserts a date timestamp</refpurpose>
  82 </refnamediv>
  83 <refsynopsisdiv>
  84
  85     <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
  86
  87 </refsynopsisdiv>
  88 <refsect1><title>Description</title>
  89
  90 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
  91       source document to cause a date timestamp (a formatted
  92       string representing the current date and time) to be
  93       inserted in output of the document.</para>
  94
  95   </refsect1><refsect1><title>Parameters</title>
  96
  97 <variablelist>
  98       <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
  99         <listitem>
 100
 101 <para>Specifies format in which the date and time are
 102             output</para>
 103
 104         <note>
 105
 106 <para>For details of the content of the format string,
 107             see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
 108
 109         </note>
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry><term>padding="0"|"1"</term>
 113         <listitem>
 114
 115 <para>Specifies padding behavior; if non-zero, padding is is added</para>
 116
 117         </listitem>
 118       </varlistentry>
 119     </variablelist>
 120
 121   </refsect1></refentry>
 122
 123 <refentry xml:id="dbtex_delims">
 124 <refnamediv>
 125 <refname>dbtex_delims</refname>
 126 <refpurpose>Generates delimiters around embedded TeX equations
 127     in output</refpurpose>
 128 </refnamediv>
 129 <refsynopsisdiv>
 130
 131     <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
 132
 133 </refsynopsisdiv>
 134 <refsect1><title>Description</title>
 135
 136 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
 137       child of a <tag>textobject</tag> containing embedded TeX
 138       markup, to cause that markup to be surrounded by
 139       <literal>$</literal> delimiter characters in output.</para>
 140
 141       <warning>
 142
 143 <para>This feature is useful for print/PDF output only if you
 144        use the obsolete and now unsupported PassiveTeX XSL-FO
 145        engine.</para>
 146
 147       </warning>
 148   </refsect1><refsect1><title>Parameters</title>
 149
 150 <variablelist>
 151       <varlistentry><term>dbtex delims="no"|"yes"</term>
 152         <listitem>
 153
 154 <para>Specifies whether delimiters are output</para>
 155
 156         </listitem>
 157       </varlistentry>
 158     </variablelist>
 159
 160   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
 161
 162 <para><parameter>tex.math.delims</parameter></para>
 163
 164   </refsect1></refentry>
 165 </reference>