stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/common/pi.xml

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