stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.charmap.subset.profile.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"\r
   2           xmlns:xlink="http://www.w3.org/1999/xlink"\r
   3           xmlns:xi="http://www.w3.org/2001/XInclude"\r
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
   6           version="5.0" xml:id="man.charmap.subset.profile">\r
   7 <refmeta>\r
   8 <refentrytitle>man.charmap.subset.profile</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
  10 </refmeta>\r
  11 <refnamediv>\r
  12 <refname>man.charmap.subset.profile</refname>\r
  13 <refpurpose>Profile of character map subset</refpurpose>\r
  14 </refnamediv>\r
  15 \r
  16 <refsynopsisdiv>\r
  17 <src:fragment xml:id="man.charmap.subset.profile.frag">\r
  18 <xsl:param name="man.charmap.subset.profile">\r
  19 @*[local-name() = 'block'] = 'Miscellaneous Technical' or\r
  20 (@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and\r
  21  (@*[local-name() = 'class'] = 'symbols' or\r
  22   @*[local-name() = 'class'] = 'letters')\r
  23 ) or\r
  24 @*[local-name() = 'block'] = 'Latin Extended-A'\r
  25 or\r
  26 (@*[local-name() = 'block'] = 'General Punctuation' and\r
  27  (@*[local-name() = 'class'] = 'spaces' or\r
  28   @*[local-name() = 'class'] = 'dashes' or\r
  29   @*[local-name() = 'class'] = 'quotes' or\r
  30   @*[local-name() = 'class'] = 'bullets'\r
  31  )\r
  32 ) or\r
  33 @*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or\r
  34 @*[local-name() = 'name'] = 'WORD JOINER' or\r
  35 @*[local-name() = 'name'] = 'SERVICE MARK' or\r
  36 @*[local-name() = 'name'] = 'TRADE MARK SIGN' or\r
  37 @*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'\r
  38 </xsl:param>\r
  39 </src:fragment>\r
  40 </refsynopsisdiv>\r
  41 \r
  42 <refsection><info><title>Description</title></info>\r
  43 \r
  44 <para>If the value of the\r
  45 <parameter>man.charmap.use.subset</parameter> parameter is non-zero,\r
  46 and your DocBook source is not written in English (that\r
  47   is, if the <tag class="attribute">lang</tag> or <tag\r
  48     class="attribute">xml:lang</tag> attribute on the root element\r
  49   in your DocBook source or on the first <tag>refentry</tag>\r
  50   element in your source has a value other than\r
  51   <literal>en</literal>), then the character-map subset specified\r
  52   by the <parameter>man.charmap.subset.profile</parameter>\r
  53   parameter is used instead of the full roff character map.</para>\r
  54 \r
  55 <para>Otherwise, if the <tag class="attribute">lang</tag> or <tag\r
  56     class="attribute">xml:lang</tag> attribute on the root\r
  57   element in your DocBook\r
  58   source or on the first <tag>refentry</tag> element in your source\r
  59   has the value <literal>en</literal> or if it has no <tag\r
  60     class="attribute">lang</tag> or <tag\r
  61     class="attribute">xml:lang</tag> attribute, then the character-map\r
  62   subset specified by the\r
  63   <parameter>man.charmap.subset.profile.english</parameter>\r
  64   parameter is used instead of\r
  65   <parameter>man.charmap.subset.profile</parameter>.</para>\r
  66 \r
  67 <para>The difference between the two subsets is that\r
  68   <parameter>man.charmap.subset.profile</parameter> provides\r
  69   mappings for characters in Western European languages that are\r
  70   not part of the Roman (English) alphabet (ASCII character set).</para>\r
  71 \r
  72 <para>The value of <parameter>man.charmap.subset.profile</parameter>\r
  73 is a string representing an XPath expression that matches attribute\r
  74 names and values for <tag\r
  75   namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>\r
  76 elements in the character map.</para>\r
  77 \r
  78 <para>The attributes supported in the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are:\r
  79 <variablelist>\r
  80   <varlistentry>\r
  81     <term>character</term>\r
  82     <listitem>\r
  83       <simpara>a raw Unicode character or numeric Unicode\r
  84       character-entity value (either in decimal or hex); all\r
  85       characters have this attribute</simpara>\r
  86     </listitem>\r
  87   </varlistentry>\r
  88   <varlistentry>\r
  89     <term>name</term>\r
  90     <listitem>\r
  91       <simpara>a standard full/long ISO/Unicode character name (e.g.,\r
  92       "OHM SIGN"); all characters have this attribute</simpara>\r
  93     </listitem>\r
  94   </varlistentry>\r
  95   <varlistentry>\r
  96     <term>block</term>\r
  97     <listitem>\r
  98       <simpara>a standard Unicode "block" name (e.g., "General\r
  99       Punctuation"); all characters have this attribute. For the full\r
 100       list of Unicode block names supported in the standard roff\r
 101       character map, see <xref linkend="BlocksAndClasses"/>.</simpara>\r
 102     </listitem>\r
 103   </varlistentry>\r
 104   <varlistentry>\r
 105     <term>class</term>\r
 106     <listitem>\r
 107       <simpara>a class of characters (e.g., "spaces"). Not all\r
 108       characters have this attribute; currently, it is used only with\r
 109       certain characters within the "C1 Controls And Latin-1\r
 110       Supplement" and "General Punctuation" blocks. For details, see\r
 111       <xref linkend="BlocksAndClasses"/>.</simpara>\r
 112     </listitem>\r
 113   </varlistentry>\r
 114   <varlistentry>\r
 115     <term>entity</term>\r
 116     <listitem>\r
 117       <simpara>an ISO entity name (e.g., "ohm"); not all characters\r
 118       have this attribute, because not all characters have ISO entity\r
 119       names; for example, of the 800 or so characters in the standard\r
 120       roff character map included in the distribution, only around 300\r
 121       have ISO entity names.\r
 122       </simpara>\r
 123     </listitem>\r
 124   </varlistentry>\r
 125   <varlistentry>\r
 126     <term>string</term>\r
 127     <listitem>\r
 128       <simpara>a string representing an roff/groff escape-code (with\r
 129       "@esc@" used in place of the backslash), or a simple ASCII\r
 130       string; all characters in the roff character map have this\r
 131       attribute</simpara>\r
 132     </listitem>\r
 133   </varlistentry>\r
 134 </variablelist>\r
 135 </para>\r
 136 <para>The value of <parameter>man.charmap.subset.profile</parameter>\r
 137 is evaluated as an XPath expression at run-time to select a portion of\r
 138 the roff character map to use. You can tune the subset used by adding\r
 139 or removing parts. For example, if you need to use a wide range of\r
 140 mathematical operators in a document, and you want to have them\r
 141 converted into roff markup properly, you might add the following:\r
 142 \r
 143 <literallayout class="monospaced">  @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>\r
 144 \r
 145 That will cause a additional set of around 67 additional "math"\r
 146 characters to be converted into roff markup. </para>\r
 147 \r
 148 <note>\r
 149 <para>Depending on which XSLT engine you use, either the EXSLT\r
 150 <function>dyn:evaluate</function> extension function (for xsltproc or\r
 151 Xalan) or <function>saxon:evaluate</function> extension function (for\r
 152 Saxon) are used to dynamically evaluate the value of\r
 153 <parameter>man.charmap.subset.profile</parameter> at run-time. If you\r
 154 don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that\r
 155 supports <function>dyn:evaluate</function> -- you must either set the\r
 156 value of the <parameter>man.charmap.use.subset</parameter> parameter\r
 157 to zero and process your documents using the full character map\r
 158 instead, or set the value of the\r
 159 <parameter>man.charmap.enabled</parameter> parameter to zero instead\r
 160 (so that character-map processing is disabled completely.</para>\r
 161 </note>\r
 162 \r
 163 <para>An alternative to using\r
 164 <parameter>man.charmap.subset.profile</parameter> is to create your\r
 165 own custom character map, and set the value of\r
 166 <parameter>man.charmap.uri</parameter> to the URI/filename for\r
 167 that. If you use a custom character map, you will probably want to\r
 168 include in it just the characters you want to use, and so you will\r
 169 most likely also want to set the value of\r
 170 <parameter>man.charmap.use.subset</parameter> to zero.</para>\r
 171 <para>You can create a\r
 172 custom character map by making a copy of the <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and\r
 173 then adding to, changing, and/or deleting from that.</para>\r
 174 \r
 175 <caution>\r
 176 <para>If you author your DocBook XML source in UTF-8 or UTF-16\r
 177 encoding and aren't sure what OSes or environments your man-page\r
 178 output might end up being viewed on, and not sure what version of\r
 179 nroff/groff those environments might have, you should be careful about\r
 180 what Unicode symbols and special characters you use in your source and\r
 181 what parts you add to the value of\r
 182 <parameter>man.charmap.subset.profile</parameter>.</para>\r
 183 <para>Many of the escape codes used are specific to groff and using\r
 184 them may not provide the expected output on an OS or environment that\r
 185 uses nroff instead of groff.</para>\r
 186 <para>On the other hand, if you intend for your man-page output to be\r
 187 viewed only on modern systems (for example, GNU/Linux systems, FreeBSD\r
 188 systems, or Cygwin environments) that have a good, up-to-date groff,\r
 189 then you can safely include a wide range of Unicode symbols and\r
 190 special characters in your UTF-8 or UTF-16 encoded DocBook XML source\r
 191 and add any of the supported Unicode block names to the value of\r
 192 <parameter>man.charmap.subset.profile</parameter>.</para>\r
 193 </caution>\r
 194 \r
 195 \r
 196 <para>For other details, see the documentation for the\r
 197 <parameter>man.charmap.use.subset</parameter> parameter.</para>\r
 198 \r
 199 <refsection xml:id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>\r
 200   \r
 201 \r
 202   <para>Below is the full list of Unicode block names and "class"\r
 203   values supported in the standard roff stylesheet provided in the\r
 204   distribution, along with a description of which codepoints from the\r
 205   Unicode range corresponding to that block name or block/class\r
 206   combination are supported.</para>\r
 207 \r
 208   <itemizedlist>\r
 209     <listitem>\r
 210       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</link> (x00a0 to x00ff)\r
 211       <itemizedlist><info><title>class values</title></info>\r
 212         \r
 213         <listitem>\r
 214           <para>symbols</para>\r
 215         </listitem>\r
 216         <listitem>\r
 217           <para>letters</para>\r
 218         </listitem>\r
 219       </itemizedlist></para>\r
 220     </listitem>\r
 221     <listitem>\r
 222       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para>\r
 223     </listitem>\r
 224     <listitem>\r
 225       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para>\r
 226     </listitem>\r
 227     <listitem>\r
 228       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para>\r
 229     </listitem>\r
 230     <listitem>\r
 231       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)\r
 232       <itemizedlist><info><title>class values</title></info>\r
 233         \r
 234         <listitem>\r
 235           <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8192&amp;end=8203">spaces</link></para>\r
 236         </listitem>\r
 237         <listitem>\r
 238           <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8208&amp;end=8213">dashes</link></para>\r
 239         </listitem>\r
 240         <listitem>\r
 241           <para>quotes</para>\r
 242         </listitem>\r
 243         <listitem>\r
 244           <para>daggers</para>\r
 245         </listitem>\r
 246         <listitem>\r
 247           <para>bullets</para>\r
 248         </listitem>\r
 249         <listitem>\r
 250           <para>leaders</para>\r
 251         </listitem>\r
 252         <listitem>\r
 253           <para>primes</para>\r
 254         </listitem>\r
 255       </itemizedlist>\r
 256       </para>\r
 257     </listitem>\r
 258     <listitem>\r
 259       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para>\r
 260     </listitem>\r
 261     <listitem>\r
 262       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>\r
 263     </listitem>\r
 264     <listitem>\r
 265       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>\r
 266     </listitem>\r
 267     <listitem>\r
 268       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>\r
 269     </listitem>\r
 270     <listitem>\r
 271       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>\r
 272     </listitem>\r
 273     <listitem>\r
 274       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para>\r
 275     </listitem>\r
 276     <listitem>\r
 277       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>\r
 278     </listitem>\r
 279     <listitem>\r
 280       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>\r
 281     </listitem>\r
 282     <listitem>\r
 283       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para>\r
 284     </listitem>\r
 285     <listitem>\r
 286       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para>\r
 287     </listitem>\r
 288     <listitem>\r
 289       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>\r
 290     </listitem>\r
 291     <listitem>\r
 292       <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para>\r
 293     </listitem>\r
 294   </itemizedlist>\r
 295 </refsection>\r
 296 </refsection>\r
 297 </refentry>\r