+++ /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
- xmlns:ss="http://docbook.sf.net/xmlns/string.subst/1.0"\r
- version="5.0" xml:id="man.string.subst.map">\r
-<refmeta>\r
-<refentrytitle>man.string.subst.map</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>man.string.subst.map</refname>\r
-<refpurpose>Specifies a set of string substitutions</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="man.string.subst.map.frag">\r
-<xsl:param name="man.string.subst.map">\r
-\r
- <!-- * remove no-break marker at beginning of line (stylesheet artifact) --> \r
- <ss:substitution oldstring="▒▀" newstring="▒"/>\r
- <!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space -->\r
- <ss:substitution oldstring="▀" newstring="\ "/>\r
-\r
- <!-- ==================================================================== -->\r
-\r
- <!-- * squeeze multiple newlines before a roff request -->\r
- <ss:substitution oldstring=" ." newstring=" ."/>\r
- <!-- * remove any .sp instances that directly precede a .PP -->\r
- <ss:substitution oldstring=".sp .PP" newstring=".PP"/>\r
- <!-- * remove any .sp instances that directly follow a .PP -->\r
- <ss:substitution oldstring=".sp .sp" newstring=".sp"/>\r
- <!-- * squeeze multiple .sp instances into a single .sp-->\r
- <ss:substitution oldstring=".PP .sp" newstring=".PP"/>\r
- <!-- * squeeze multiple newlines after start of no-fill (verbatim) env. -->\r
- <ss:substitution oldstring=".nf " newstring=".nf "/>\r
- <!-- * squeeze multiple newlines after REstoring margin -->\r
- <ss:substitution oldstring=".RE " newstring=".RE "/>\r
- <!-- * U+2591 is a marker we add before and after every Parameter in -->\r
- <!-- * Funcprototype output -->\r
- <ss:substitution oldstring="░" newstring=" "/>\r
- <!-- * U+2592 is a marker we add for the newline before output of <sbr>; -->\r
- <ss:substitution oldstring="▒" newstring=" "/>\r
- <!-- * -->\r
- <!-- * Now deal with some other characters that are added by the -->\r
- <!-- * stylesheets during processing. -->\r
- <!-- * -->\r
- <!-- * bullet -->\r
- <ss:substitution oldstring="•" newstring="\(bu"/>\r
- <!-- * left double quote -->\r
- <ss:substitution oldstring="“" newstring="\(lq"/>\r
- <!-- * right double quote -->\r
- <ss:substitution oldstring="”" newstring="\(rq"/>\r
- <!-- * left single quote -->\r
- <ss:substitution oldstring="‘" newstring="\(oq"/>\r
- <!-- * right single quote -->\r
- <ss:substitution oldstring="’" newstring="\(cq"/>\r
- <!-- * copyright sign -->\r
- <ss:substitution oldstring="©" newstring="\(co"/>\r
- <!-- * registered sign -->\r
- <ss:substitution oldstring="®" newstring="\(rg"/>\r
- <!-- * ...servicemark... -->\r
- <!-- * There is no groff equivalent for it. -->\r
- <ss:substitution oldstring="℠" newstring="(SM)"/>\r
- <!-- * ...trademark... -->\r
- <!-- * We don't do "\(tm" because for console output, -->\r
- <!-- * groff just renders that as "tm"; that is: -->\r
- <!-- * -->\r
- <!-- * Product™ -> Producttm -->\r
- <!-- * -->\r
- <!-- * So we just make it to "(TM)" instead; thus: -->\r
- <!-- * -->\r
- <!-- * Product™ -> Product(TM) -->\r
- <ss:substitution oldstring="™" newstring="(TM)"/>\r
-\r
-</xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>The <parameter>man.string.subst.map</parameter> parameter\r
-contains <link linkend="map">a map</link> that specifies a set of\r
-string substitutions to perform over the entire roff source for each\r
-man page, either just before generating final man-page output (that\r
-is, before writing man-page files to disk) or, if the value of the\r
-<parameter>man.charmap.enabled</parameter> parameter is non-zero,\r
-before applying the roff character map.</para>\r
-\r
-<para>You can use <parameter>man.string.subst.map</parameter> as a\r
-“lightweight” character map to perform “essential” substitutions --\r
-that is, substitutions that are <emphasis>always</emphasis> performed,\r
-even if the value of the <parameter>man.charmap.enabled</parameter>\r
-parameter is zero. For example, you can use it to replace quotation\r
-marks or other special characters that are generated by the DocBook\r
-XSL stylesheets for a particular locale setting (as opposed to those\r
-characters that are actually in source XML documents), or to replace\r
-any special characters that may be automatically generated by a\r
-particular customization of the DocBook XSL stylesheets.</para>\r
-\r
-<warning>\r
- <para>Do you not change value of the\r
- <parameter>man.string.subst.map</parameter> parameter unless you are\r
- sure what you are doing. First consider adding your\r
- string-substitution mappings to either or both of the following\r
- parameters:\r
- <variablelist>\r
- <varlistentry>\r
- <term><parameter>man.string.subst.map.local.pre</parameter></term>\r
- <listitem><para>applied before\r
- <parameter>man.string.subst.map</parameter></para></listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>man.string.subst.map.local.post</parameter></term>\r
- <listitem><para>applied after\r
- <parameter>man.string.subst.map</parameter></para></listitem>\r
- </varlistentry>\r
- </variablelist>\r
- By default, both of those parameters contain no\r
- string substitutions. They are intended as a means for you to\r
- specify your own local string-substitution mappings.</para>\r
-\r
- <para>If you remove any of default mappings from the value of the\r
- <parameter>man.string.subst.map</parameter> parameter, you are\r
- likely to end up with broken output. And be very careful about adding\r
- anything to it; it’s used for doing string substitution over the\r
- entire roff source of each man page – it causes target strings to be\r
- replaced in roff requests and escapes, not just in the visible\r
- contents of the page.</para>\r
-\r
-</warning>\r
-\r
-<refsection xml:id="map">\r
- <info>\r
- <title>Contents of the substitution map</title>\r
- </info>\r
- <para>The string-substitution map contains one or more\r
- <tag>ss:substitution</tag> elements, each of which has two\r
- attributes:\r
- <variablelist>\r
- <varlistentry>\r
- <term>oldstring</term>\r
- <listitem>\r
- <simpara>string to replace</simpara>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term>newstring</term>\r
- <listitem>\r
- <simpara>string with which to replace <tag\r
- class="attribute">oldstring</tag></simpara>\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
- It may also include XML comments (that is, delimited with\r
- "<literal><!--</literal>" and "<literal>--></literal>").\r
- </para>\r
-</refsection>\r
-\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff