1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>man.charmap.subset.profile</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: ReferenceDocumentation"><link rel="up" href="charmap.html" title="Character/string substitution"><link rel="prev" href="man.charmap.use.subset.html" title="man.charmap.use.subset"><link rel="next" href="man.charmap.subset.profile.english.html" title="man.charmap.subset.profile.english"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">man.charmap.subset.profile</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="man.charmap.use.subset.html">Prev</a></td><th width="60%" align="center">Character/string substitution</th><td width="20%" align="right"><a accesskey="n" href="man.charmap.subset.profile.english.html">Next</a></td></tr></table><hr></div><div class="refentry" title="man.charmap.subset.profile"><a name="man.charmap.subset.profile"></a><div class="titlepage"></div>
<div class="refnamediv"><h2><span class="refentrytitle">man.charmap.subset.profile</span></h2><p>
man.charmap.subset.profile
— Profile of character map subset
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<a name="man.charmap.subset.profile.frag"></a><pre class="programlisting">
<xsl:param name="man.charmap.subset.profile">
@*[local-name() = 'block'] = 'Miscellaneous Technical' or
(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and
(@*[local-name() = 'class'] = 'symbols' or
@*[local-name() = 'class'] = 'letters')
) or
@*[local-name() = 'block'] = 'Latin Extended-A'
or
(@*[local-name() = 'block'] = 'General Punctuation' and
(@*[local-name() = 'class'] = 'spaces' or
@*[local-name() = 'class'] = 'dashes' or
@*[local-name() = 'class'] = 'quotes' or
@*[local-name() = 'class'] = 'bullets'
)
) or
@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or
@*[local-name() = 'name'] = 'WORD JOINER' or
@*[local-name() = 'name'] = 'SERVICE MARK' or
@*[local-name() = 'name'] = 'TRADE MARK SIGN' or
@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'
</xsl:param>
</pre>
</div>
<div class="refsection" title="Description"><a name="id1438218"></a><h2>Description</h2>
<p>If the value of the
<a href="../manpages/man.charmap.use.subset.html"><em class="parameter"><code>man.charmap.use.subset</code></em></a> parameter is non-zero,
and your DocBook source is not written in English (that
is, if the <code class="sgmltag-attribute">lang</code> or <code class="sgmltag-attribute">xml:lang</code> attribute on the root element
in your DocBook source or on the first <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a>
element in your source has a value other than
<code class="literal">en</code>), then the character-map subset specified
by the <a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>
parameter is used instead of the full roff character map.</p>
<p>Otherwise, if the <code class="sgmltag-attribute">lang</code> or <code class="sgmltag-attribute">xml:lang</code> attribute on the root
element in your DocBook
source or on the first <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a> element in your source
has the value <code class="literal">en</code> or if it has no <code class="sgmltag-attribute">lang</code> or <code class="sgmltag-attribute">xml:lang</code> attribute, then the character-map
subset specified by the
<a href="../manpages/man.charmap.subset.profile.english.html"><em class="parameter"><code>man.charmap.subset.profile.english</code></em></a>
parameter is used instead of
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>.</p>
<p>The difference between the two subsets is that
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a> provides
mappings for characters in Western European languages that are
not part of the Roman (English) alphabet (ASCII character set).</p>
<p>The value of <a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>
is a string representing an XPath expression that matches attribute
names and values for <code class="sgmltag-element">output-character</code>
elements in the character map.</p>
<p>The attributes supported in the <a class="ulink" href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl" target="_top">standard roff character map included in the distribution</a> are:
</p><div class="variablelist"><dl><dt><span class="term">character</span></dt><dd>
a raw Unicode character or numeric Unicode
character-entity value (either in decimal or hex); all
characters have this attribute
</dd><dt><span class="term">name</span></dt><dd>
a standard full/long ISO/Unicode character name (e.g.,
"OHM SIGN"); all characters have this attribute
</dd><dt><span class="term">block</span></dt><dd>
a standard Unicode "block" name (e.g., "General
Punctuation"); all characters have this attribute. For the full
list of Unicode block names supported in the standard roff
character map, see <a class="xref" href="man.charmap.subset.profile.html#BlocksAndClasses" title='Supported Unicode block names and "class" values'>the section called “Supported Unicode block names and "class" values”</a>.
</dd><dt><span class="term">class</span></dt><dd>
a class of characters (e.g., "spaces"). Not all
characters have this attribute; currently, it is used only with
certain characters within the "C1 Controls And Latin-1
Supplement" and "General Punctuation" blocks. For details, see
<a class="xref" href="man.charmap.subset.profile.html#BlocksAndClasses" title='Supported Unicode block names and "class" values'>the section called “Supported Unicode block names and "class" values”</a>.
</dd><dt><span class="term">entity</span></dt><dd>
an ISO entity name (e.g., "ohm"); not all characters
have this attribute, because not all characters have ISO entity
names; for example, of the 800 or so characters in the standard
roff character map included in the distribution, only around 300
have ISO entity names.
</dd><dt><span class="term">string</span></dt><dd>
a string representing an roff/groff escape-code (with
"@esc@" used in place of the backslash), or a simple ASCII
string; all characters in the roff character map have this
attribute
</dd></dl></div><p>
</p>
<p>The value of <a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>
is evaluated as an XPath expression at run-time to select a portion of
the roff character map to use. You can tune the subset used by adding
or removing parts. For example, if you need to use a wide range of
mathematical operators in a document, and you want to have them
converted into roff markup properly, you might add the following:
</p><pre class="literallayout"> @*[local-name() = 'block'] ='MathematicalOperators' </pre><p>
That will cause a additional set of around 67 additional "math"
characters to be converted into roff markup. </p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
<p>Depending on which XSLT engine you use, either the EXSLT
<code class="function">dyn:evaluate</code> extension function (for xsltproc or
Xalan) or <code class="function">saxon:evaluate</code> extension function (for
Saxon) are used to dynamically evaluate the value of
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a> at run-time. If you
don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that
supports <code class="function">dyn:evaluate</code> -- you must either set the
value of the <a href="../manpages/man.charmap.use.subset.html"><em class="parameter"><code>man.charmap.use.subset</code></em></a> parameter
to zero and process your documents using the full character map
instead, or set the value of the
<a href="../manpages/man.charmap.enabled.html"><em class="parameter"><code>man.charmap.enabled</code></em></a> parameter to zero instead
(so that character-map processing is disabled completely.</p>
</div>
<p>An alternative to using
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a> is to create your
own custom character map, and set the value of
<a href="../manpages/man.charmap.uri.html"><em class="parameter"><code>man.charmap.uri</code></em></a> to the URI/filename for
that. If you use a custom character map, you will probably want to
include in it just the characters you want to use, and so you will
most likely also want to set the value of
<a href="../manpages/man.charmap.use.subset.html"><em class="parameter"><code>man.charmap.use.subset</code></em></a> to zero.</p>
<p>You can create a
custom character map by making a copy of the <a class="ulink" href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl" target="_top">standard roff character map</a> provided in the distribution, and
then adding to, changing, and/or deleting from that.</p>
<div class="caution" title="Caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Caution</h3>
<p>If you author your DocBook XML source in UTF-8 or UTF-16
encoding and aren't sure what OSes or environments your man-page
output might end up being viewed on, and not sure what version of
nroff/groff those environments might have, you should be careful about
what Unicode symbols and special characters you use in your source and
what parts you add to the value of
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>.</p>
<p>Many of the escape codes used are specific to groff and using
them may not provide the expected output on an OS or environment that
uses nroff instead of groff.</p>
<p>On the other hand, if you intend for your man-page output to be
viewed only on modern systems (for example, GNU/Linux systems, FreeBSD
systems, or Cygwin environments) that have a good, up-to-date groff,
then you can safely include a wide range of Unicode symbols and
special characters in your UTF-8 or UTF-16 encoded DocBook XML source
and add any of the supported Unicode block names to the value of
<a href="../manpages/man.charmap.subset.profile.html"><em class="parameter"><code>man.charmap.subset.profile</code></em></a>.</p>
</div>
<p>For other details, see the documentation for the
<a href="../manpages/man.charmap.use.subset.html"><em class="parameter"><code>man.charmap.use.subset</code></em></a> parameter.</p>
<div class="refsection" title='Supported Unicode block names and "class" values'><a name="BlocksAndClasses"></a><h3>Supported Unicode block names and "class" values</h3>
<p>Below is the full list of Unicode block names and "class"
values supported in the standard roff stylesheet provided in the
distribution, along with a description of which codepoints from the
Unicode range corresponding to that block name or block/class
combination are supported.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)" target="_top">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</a> (x00a0 to x00ff)
</p><div class="itemizedlist" title="class values"><p class="title"><b>class values</b></p><ul class="itemizedlist" type="circle"><li class="listitem">
<p>symbols</p>
</li><li class="listitem">
<p>letters</p>
</li></ul></div>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Latin%20Extended-A" target="_top">Latin Extended-A</a> (x0100 to x017f, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Spacing%20Modifier%20Letters" target="_top">Spacing Modifier Letters</a> (x02b0 to x02ee, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Greek%20and%20Coptic" target="_top">Greek and Coptic</a> (x0370 to x03ff, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=General%20Punctuation" target="_top">General Punctuation</a> (x2000 to x206f, partial)
</p><div class="itemizedlist" title="class values"><p class="title"><b>class values</b></p><ul class="itemizedlist" type="circle"><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8192&end=8203" target="_top">spaces</a></p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&start=8208&end=8213" target="_top">dashes</a></p>
</li><li class="listitem">
<p>quotes</p>
</li><li class="listitem">
<p>daggers</p>
</li><li class="listitem">
<p>bullets</p>
</li><li class="listitem">
<p>leaders</p>
</li><li class="listitem">
<p>primes</p>
</li></ul></div><p>
</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Superscripts%20and%20Subscripts" target="_top">Superscripts and Subscripts</a> (x2070 to x209f)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Currency%20Symbols" target="_top">Currency Symbols</a> (x20a0 to x20b1)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Letterlike%20Symbols" target="_top">Letterlike Symbols</a> (x2100 to x214b)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Number%20Forms" target="_top">Number Forms</a> (x2150 to x218f)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Arrows" target="_top">Arrows</a> (x2190 to x21ff, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Mathematical%20Operators" target="_top">Mathematical Operators</a> (x2200 to x22ff, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Control%20Pictures" target="_top">Control Pictures</a> (x2400 to x243f)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Enclosed%20Alphanumerics" target="_top">Enclosed Alphanumerics</a> (x2460 to x24ff)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Geometric%20Shapes" target="_top">Geometric Shapes</a> (x25a0 to x25f7, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Miscellaneous%20Symbols" target="_top">Miscellaneous Symbols</a> (x2600 to x26ff, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Dingbats" target="_top">Dingbats</a> (x2700 to x27be, partial)</p>
</li><li class="listitem">
<p><a class="ulink" href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&id=Alphabetic%20Presentation%20Forms" target="_top">Alphabetic Presentation Forms</a> (xfb00 to xfb04 only)</p>
</li></ul></div>
</div>
</div>
</div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="man.charmap.use.subset.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="charmap.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="man.charmap.subset.profile.english.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">man.charmap.use.subset</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">man.charmap.subset.profile.english</td></tr></table></div></body></html>
|
