]> git.evergreen-ils.org Git - working/Evergreen.git/blob - stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/hyphenate.verbatim.xml
Evergreen Version Fix to reflect the new EG releases 2.0.10 and 1.6.1.9
[working/Evergreen.git] / stylesheets / evergreen_docbook_files / docbook-xsl-1.75.2 / params / hyphenate.verbatim.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           version="5.0" xml:id="hyphenate.verbatim">\r
7 <refmeta>\r
8 <refentrytitle>hyphenate.verbatim</refentrytitle>\r
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
10 </refmeta>\r
11 <refnamediv>\r
12 <refname>hyphenate.verbatim</refname>\r
13 <refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose>\r
14 </refnamediv>\r
15 \r
16 <refsynopsisdiv>\r
17 <src:fragment xml:id="hyphenate.verbatim.frag"><xsl:param name="hyphenate.verbatim" select="0"/></src:fragment>\r
18 </refsynopsisdiv>\r
19 \r
20 <refsection><info><title>Description</title></info>\r
21 \r
22 <para>If the lines of program listing are too long to fit into one\r
23 line it is quite common to split them at space and indicite by hook\r
24 arrow that code continues on the next line. You can turn on this\r
25 behaviour for <tag>programlisting</tag>,\r
26 <tag>screen</tag> and <tag>synopsis</tag> elements by\r
27 using this parameter.</para>\r
28 \r
29 <para>Note that you must also enable line wrapping for verbatim environments and\r
30 select appropriate hyphenation character (e.g. hook arrow). This can\r
31 be done using <parameter>monospace.verbatim.properties</parameter>\r
32 attribute set:</para>\r
33 \r
34 <programlisting>&lt;xsl:attribute-set name="monospace.verbatim.properties" \r
35                    use-attribute-sets="verbatim.properties monospace.properties"&gt;\r
36   &lt;xsl:attribute name="wrap-option"&gt;wrap&lt;/xsl:attribute&gt;\r
37   &lt;xsl:attribute name="hyphenation-character"&gt;&amp;#x25BA;&lt;/xsl:attribute&gt;\r
38 &lt;/xsl:attribute-set&gt;</programlisting>\r
39 \r
40 <para>For a list of arrows available in Unicode see <uri xlink:href="http://www.unicode.org/charts/PDF/U2190.pdf">http://www.unicode.org/charts/PDF/U2190.pdf</uri> and <uri xlink:href="http://www.unicode.org/charts/PDF/U2900.pdf">http://www.unicode.org/charts/PDF/U2900.pdf</uri> and make sure that\r
41 selected character is available in the font you are using for verbatim\r
42 environments.</para>\r
43 \r
44 </refsection>\r
45 </refentry>\r