stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.string.subst.map.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           xmlns:ss="http://docbook.sf.net/xmlns/string.subst/1.0"\r
   7           version="5.0" xml:id="man.string.subst.map">\r
   8 <refmeta>\r
   9 <refentrytitle>man.string.subst.map</refentrytitle>\r
  10 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>\r
  11 </refmeta>\r
  12 <refnamediv>\r
  13 <refname>man.string.subst.map</refname>\r
  14 <refpurpose>Specifies a set of string substitutions</refpurpose>\r
  15 </refnamediv>\r
  16 \r
  17 <refsynopsisdiv>\r
  18 <src:fragment xml:id="man.string.subst.map.frag">\r
  19 <xsl:param name="man.string.subst.map">\r
  20 \r
  21   <!-- * remove no-break marker at beginning of line (stylesheet artifact) --> \r
  22   <ss:substitution oldstring="&#x2592;&#x2580;" newstring="&#x2592;"/>\r
  23   <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space -->\r
  24   <ss:substitution oldstring="&#x2580;" newstring="\ "/>\r
  25 \r
  26   <!-- ==================================================================== -->\r
  27 \r
  28   <!-- * squeeze multiple newlines before a roff request  -->\r
  29   <ss:substitution oldstring="&#10;&#10;." newstring="&#10;."/>\r
  30   <!-- * remove any .sp instances that directly precede a .PP  -->\r
  31   <ss:substitution oldstring=".sp&#10;.PP" newstring=".PP"/>\r
  32   <!-- * remove any .sp instances that directly follow a .PP  -->\r
  33   <ss:substitution oldstring=".sp&#10;.sp" newstring=".sp"/>\r
  34   <!-- * squeeze multiple .sp instances into a single .sp-->\r
  35   <ss:substitution oldstring=".PP&#10;.sp" newstring=".PP"/>\r
  36   <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. -->\r
  37   <ss:substitution oldstring=".nf&#10;&#10;" newstring=".nf&#10;"/>\r
  38   <!-- * squeeze multiple newlines after REstoring margin -->\r
  39   <ss:substitution oldstring=".RE&#10;&#10;" newstring=".RE&#10;"/>\r
  40   <!-- * U+2591 is a marker we add before and after every Parameter in -->\r
  41   <!-- * Funcprototype output -->\r
  42   <ss:substitution oldstring="&#x2591;" newstring=" "/>\r
  43   <!-- * U+2592 is a marker we add for the newline before output of <sbr>; -->\r
  44   <ss:substitution oldstring="&#x2592;" newstring="&#10;"/>\r
  45   <!-- * -->\r
  46   <!-- * Now deal with some other characters that are added by the -->\r
  47   <!-- * stylesheets during processing. -->\r
  48   <!-- * -->\r
  49   <!-- * bullet -->\r
  50   <ss:substitution oldstring="•" newstring="\(bu"/>\r
  51   <!-- * left double quote -->\r
  52   <ss:substitution oldstring="“" newstring="\(lq"/>\r
  53   <!-- * right double quote -->\r
  54   <ss:substitution oldstring="”" newstring="\(rq"/>\r
  55   <!-- * left single quote -->\r
  56   <ss:substitution oldstring="‘" newstring="\(oq"/>\r
  57   <!-- * right single quote -->\r
  58   <ss:substitution oldstring="’" newstring="\(cq"/>\r
  59   <!-- * copyright sign -->\r
  60   <ss:substitution oldstring="©" newstring="\(co"/>\r
  61   <!-- * registered sign -->\r
  62   <ss:substitution oldstring="®" newstring="\(rg"/>\r
  63   <!-- * ...servicemark... -->\r
  64   <!-- * There is no groff equivalent for it. -->\r
  65   <ss:substitution oldstring="&#x2120;" newstring="(SM)"/>\r
  66   <!-- * ...trademark... -->\r
  67   <!-- * We don't do "\(tm" because for console output, -->\r
  68   <!-- * groff just renders that as "tm"; that is: -->\r
  69   <!-- * -->\r
  70   <!-- *   Product&#x2122; -> Producttm -->\r
  71   <!-- * -->\r
  72   <!-- * So we just make it to "(TM)" instead; thus: -->\r
  73   <!-- * -->\r
  74   <!-- *   Product&#x2122; -> Product(TM) -->\r
  75   <ss:substitution oldstring="™" newstring="(TM)"/>\r
  76 \r
  77 </xsl:param>\r
  78 </src:fragment>\r
  79 </refsynopsisdiv>\r
  80 \r
  81 <refsection><info><title>Description</title></info>\r
  82 \r
  83 <para>The <parameter>man.string.subst.map</parameter> parameter\r
  84 contains <link linkend="map">a map</link> that specifies a set of\r
  85 string substitutions to perform over the entire roff source for each\r
  86 man page, either just before generating final man-page output (that\r
  87 is, before writing man-page files to disk) or, if the value of the\r
  88 <parameter>man.charmap.enabled</parameter> parameter is non-zero,\r
  89 before applying the roff character map.</para>\r
  90 \r
  91 <para>You can use <parameter>man.string.subst.map</parameter> as a\r
  92 “lightweight” character map to perform “essential” substitutions --\r
  93 that is, substitutions that are <emphasis>always</emphasis> performed,\r
  94 even if the value of the <parameter>man.charmap.enabled</parameter>\r
  95 parameter is zero. For example, you can use it to replace quotation\r
  96 marks or other special characters that are generated by the DocBook\r
  97 XSL stylesheets for a particular locale setting (as opposed to those\r
  98 characters that are actually in source XML documents), or to replace\r
  99 any special characters that may be automatically generated by a\r
 100 particular customization of the DocBook XSL stylesheets.</para>\r
 101 \r
 102 <warning>\r
 103   <para>Do you not change value of the\r
 104   <parameter>man.string.subst.map</parameter> parameter unless you are\r
 105   sure what you are doing. First consider adding your\r
 106   string-substitution mappings to either or both of the following\r
 107   parameters:\r
 108   <variablelist>\r
 109     <varlistentry>\r
 110       <term><parameter>man.string.subst.map.local.pre</parameter></term>\r
 111       <listitem><para>applied before\r
 112       <parameter>man.string.subst.map</parameter></para></listitem>\r
 113     </varlistentry>\r
 114     <varlistentry>\r
 115       <term><parameter>man.string.subst.map.local.post</parameter></term>\r
 116       <listitem><para>applied after\r
 117       <parameter>man.string.subst.map</parameter></para></listitem>\r
 118     </varlistentry>\r
 119   </variablelist>\r
 120   By default, both of those parameters contain no\r
 121   string substitutions. They are intended as a means for you to\r
 122   specify your own local string-substitution mappings.</para>\r
 123 \r
 124   <para>If you remove any of default mappings from the value of the\r
 125   <parameter>man.string.subst.map</parameter> parameter, you are\r
 126   likely to end up with broken output. And be very careful about adding\r
 127   anything to it; it’s used for doing string substitution over the\r
 128   entire roff source of each man page – it causes target strings to be\r
 129   replaced in roff requests and escapes, not just in the visible\r
 130   contents of the page.</para>\r
 131 \r
 132 </warning>\r
 133 \r
 134 <refsection xml:id="map">\r
 135   <info>\r
 136     <title>Contents of the substitution map</title>\r
 137   </info>\r
 138   <para>The string-substitution map contains one or more\r
 139   <tag>ss:substitution</tag> elements, each of which has two\r
 140   attributes:\r
 141   <variablelist>\r
 142     <varlistentry>\r
 143       <term>oldstring</term>\r
 144       <listitem>\r
 145         <simpara>string to replace</simpara>\r
 146       </listitem>\r
 147     </varlistentry>\r
 148     <varlistentry>\r
 149       <term>newstring</term>\r
 150       <listitem>\r
 151         <simpara>string with which to replace <tag\r
 152         class="attribute">oldstring</tag></simpara>\r
 153       </listitem>\r
 154     </varlistentry>\r
 155   </variablelist>\r
 156   It may also include XML comments (that is, delimited with\r
 157   "<literal>&lt;!--</literal>" and "<literal>--&gt;</literal>").\r
 158   </para>\r
 159 </refsection>\r
 160 \r
 161 </refsection>\r
 162 </refentry>\r