+++ /dev/null
-<refentry xmlns="http://docbook.org/ns/docbook"\r
- xmlns:xlink="http://www.w3.org/1999/xlink"\r
- xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
- version="5.0" xml:id="man.charmap.subset.profile">\r
-<refmeta>\r
-<refentrytitle>man.charmap.subset.profile</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>man.charmap.subset.profile</refname>\r
-<refpurpose>Profile of character map subset</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="man.charmap.subset.profile.frag">\r
-<xsl:param name="man.charmap.subset.profile">\r
-@*[local-name() = 'block'] = 'Miscellaneous Technical' or\r
-(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and\r
- (@*[local-name() = 'class'] = 'symbols' or\r
- @*[local-name() = 'class'] = 'letters')\r
-) or\r
-@*[local-name() = 'block'] = 'Latin Extended-A'\r
-or\r
-(@*[local-name() = 'block'] = 'General Punctuation' and\r
- (@*[local-name() = 'class'] = 'spaces' or\r
- @*[local-name() = 'class'] = 'dashes' or\r
- @*[local-name() = 'class'] = 'quotes' or\r
- @*[local-name() = 'class'] = 'bullets'\r
- )\r
-) or\r
-@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or\r
-@*[local-name() = 'name'] = 'WORD JOINER' or\r
-@*[local-name() = 'name'] = 'SERVICE MARK' or\r
-@*[local-name() = 'name'] = 'TRADE MARK SIGN' or\r
-@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'\r
-</xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>If the value of the\r
-<parameter>man.charmap.use.subset</parameter> parameter is non-zero,\r
-and your DocBook source is not written in English (that\r
- is, if the <tag class="attribute">lang</tag> or <tag\r
- class="attribute">xml:lang</tag> attribute on the root element\r
- in your DocBook source or on the first <tag>refentry</tag>\r
- element in your source has a value other than\r
- <literal>en</literal>), then the character-map subset specified\r
- by the <parameter>man.charmap.subset.profile</parameter>\r
- parameter is used instead of the full roff character map.</para>\r
-\r
-<para>Otherwise, if the <tag class="attribute">lang</tag> or <tag\r
- class="attribute">xml:lang</tag> attribute on the root\r
- element in your DocBook\r
- source or on the first <tag>refentry</tag> element in your source\r
- has the value <literal>en</literal> or if it has no <tag\r
- class="attribute">lang</tag> or <tag\r
- class="attribute">xml:lang</tag> attribute, then the character-map\r
- subset specified by the\r
- <parameter>man.charmap.subset.profile.english</parameter>\r
- parameter is used instead of\r
- <parameter>man.charmap.subset.profile</parameter>.</para>\r
-\r
-<para>The difference between the two subsets is that\r
- <parameter>man.charmap.subset.profile</parameter> provides\r
- mappings for characters in Western European languages that are\r
- not part of the Roman (English) alphabet (ASCII character set).</para>\r
-\r
-<para>The value of <parameter>man.charmap.subset.profile</parameter>\r
-is a string representing an XPath expression that matches attribute\r
-names and values for <tag\r
- namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>\r
-elements in the character map.</para>\r
-\r
-<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
-<variablelist>\r
- <varlistentry>\r
- <term>character</term>\r
- <listitem>\r
- <simpara>a raw Unicode character or numeric Unicode\r
- character-entity value (either in decimal or hex); all\r
- characters have this attribute</simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>name</term>\r
- <listitem>\r
- <simpara>a standard full/long ISO/Unicode character name (e.g.,\r
- "OHM SIGN"); all characters have this attribute</simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>block</term>\r
- <listitem>\r
- <simpara>a standard Unicode "block" name (e.g., "General\r
- Punctuation"); all characters have this attribute. For the full\r
- list of Unicode block names supported in the standard roff\r
- character map, see <xref linkend="BlocksAndClasses"/>.</simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>class</term>\r
- <listitem>\r
- <simpara>a class of characters (e.g., "spaces"). Not all\r
- characters have this attribute; currently, it is used only with\r
- certain characters within the "C1 Controls And Latin-1\r
- Supplement" and "General Punctuation" blocks. For details, see\r
- <xref linkend="BlocksAndClasses"/>.</simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>entity</term>\r
- <listitem>\r
- <simpara>an ISO entity name (e.g., "ohm"); not all characters\r
- have this attribute, because not all characters have ISO entity\r
- names; for example, of the 800 or so characters in the standard\r
- roff character map included in the distribution, only around 300\r
- have ISO entity names.\r
- </simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>string</term>\r
- <listitem>\r
- <simpara>a string representing an roff/groff escape-code (with\r
- "@esc@" used in place of the backslash), or a simple ASCII\r
- string; all characters in the roff character map have this\r
- attribute</simpara>\r
- </listitem>\r
- </varlistentry>\r
-</variablelist>\r
-</para>\r
-<para>The value of <parameter>man.charmap.subset.profile</parameter>\r
-is evaluated as an XPath expression at run-time to select a portion of\r
-the roff character map to use. You can tune the subset used by adding\r
-or removing parts. For example, if you need to use a wide range of\r
-mathematical operators in a document, and you want to have them\r
-converted into roff markup properly, you might add the following:\r
-\r
-<literallayout class="monospaced"> @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>\r
-\r
-That will cause a additional set of around 67 additional "math"\r
-characters to be converted into roff markup. </para>\r
-\r
-<note>\r
-<para>Depending on which XSLT engine you use, either the EXSLT\r
-<function>dyn:evaluate</function> extension function (for xsltproc or\r
-Xalan) or <function>saxon:evaluate</function> extension function (for\r
-Saxon) are used to dynamically evaluate the value of\r
-<parameter>man.charmap.subset.profile</parameter> at run-time. If you\r
-don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that\r
-supports <function>dyn:evaluate</function> -- you must either set the\r
-value of the <parameter>man.charmap.use.subset</parameter> parameter\r
-to zero and process your documents using the full character map\r
-instead, or set the value of the\r
-<parameter>man.charmap.enabled</parameter> parameter to zero instead\r
-(so that character-map processing is disabled completely.</para>\r
-</note>\r
-\r
-<para>An alternative to using\r
-<parameter>man.charmap.subset.profile</parameter> is to create your\r
-own custom character map, and set the value of\r
-<parameter>man.charmap.uri</parameter> to the URI/filename for\r
-that. If you use a custom character map, you will probably want to\r
-include in it just the characters you want to use, and so you will\r
-most likely also want to set the value of\r
-<parameter>man.charmap.use.subset</parameter> to zero.</para>\r
-<para>You can create a\r
-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
-then adding to, changing, and/or deleting from that.</para>\r
-\r
-<caution>\r
-<para>If you author your DocBook XML source in UTF-8 or UTF-16\r
-encoding and aren't sure what OSes or environments your man-page\r
-output might end up being viewed on, and not sure what version of\r
-nroff/groff those environments might have, you should be careful about\r
-what Unicode symbols and special characters you use in your source and\r
-what parts you add to the value of\r
-<parameter>man.charmap.subset.profile</parameter>.</para>\r
-<para>Many of the escape codes used are specific to groff and using\r
-them may not provide the expected output on an OS or environment that\r
-uses nroff instead of groff.</para>\r
-<para>On the other hand, if you intend for your man-page output to be\r
-viewed only on modern systems (for example, GNU/Linux systems, FreeBSD\r
-systems, or Cygwin environments) that have a good, up-to-date groff,\r
-then you can safely include a wide range of Unicode symbols and\r
-special characters in your UTF-8 or UTF-16 encoded DocBook XML source\r
-and add any of the supported Unicode block names to the value of\r
-<parameter>man.charmap.subset.profile</parameter>.</para>\r
-</caution>\r
-\r
-\r
-<para>For other details, see the documentation for the\r
-<parameter>man.charmap.use.subset</parameter> parameter.</para>\r
-\r
-<refsection xml:id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>\r
- \r
-\r
- <para>Below is the full list of Unicode block names and "class"\r
- values supported in the standard roff stylesheet provided in the\r
- distribution, along with a description of which codepoints from the\r
- Unicode range corresponding to that block name or block/class\r
- combination are supported.</para>\r
-\r
- <itemizedlist>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&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
- <itemizedlist><info><title>class values</title></info>\r
- \r
- <listitem>\r
- <para>symbols</para>\r
- </listitem>\r
- <listitem>\r
- <para>letters</para>\r
- </listitem>\r
- </itemizedlist></para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)\r
- <itemizedlist><info><title>class values</title></info>\r
- \r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203">spaces</link></para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213">dashes</link></para>\r
- </listitem>\r
- <listitem>\r
- <para>quotes</para>\r
- </listitem>\r
- <listitem>\r
- <para>daggers</para>\r
- </listitem>\r
- <listitem>\r
- <para>bullets</para>\r
- </listitem>\r
- <listitem>\r
- <para>leaders</para>\r
- </listitem>\r
- <listitem>\r
- <para>primes</para>\r
- </listitem>\r
- </itemizedlist>\r
- </para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>\r
- </listitem>\r
- <listitem>\r
- <para><link xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para>\r
- </listitem>\r
- </itemizedlist>\r
-</refsection>\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff