]> git.stg.codes - stg.git/blob - doc/xslt/params/man.charmap.uri.xml
Documentation intermediate update
[stg.git] / doc / xslt / params / man.charmap.uri.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="man.charmap.uri">
7 <refmeta>
8 <refentrytitle>man.charmap.uri</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.charmap.uri</refname>
13 <refpurpose>URI for custom roff character map</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.charmap.uri.frag">
18 <xsl:param name="man.charmap.uri"></xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>For converting certain Unicode symbols and special characters in
25 UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
26 equivalents in man-page output, the DocBook XSL Stylesheets
27 distribution includes an <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
28 map</link>. That character map can be considered the standard roff
29 character map for the distribution.</para>
30
31 <para>If the value of the <parameter>man.charmap.uri</parameter>
32 parameter is non-empty, that value is used as the URI for the location
33 for an alternate roff character map to use in place of the standard
34 roff character map provided in the distribution.</para>
35
36 <warning>
37 <para>Do not set a value for <parameter>man.charmap.uri</parameter>
38 unless you have a custom roff character map that differs from the
39 standard one provided in the distribution.</para>
40 </warning>
41 </refsection>
42 </refentry>