]> git.stg.codes - stg.git/blob - doc/xslt/params/man.hyphenate.urls.xml
Minor ChangeLog fix
[stg.git] / doc / xslt / params / man.hyphenate.urls.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.hyphenate.urls">
7 <refmeta>
8 <refentrytitle>man.hyphenate.urls</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.hyphenate.urls</refname>
13 <refpurpose>Hyphenate URLs?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.hyphenate.urls.frag">
18 <xsl:param name="man.hyphenate.urls">0</xsl:param></src:fragment>
19 </refsynopsisdiv>
20
21 <refsection><info><title>Description</title></info>
22
23 <para>If zero (the default), hyphenation is suppressed for output of
24 the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
25
26 <note>
27   <para>If hyphenation is already turned off globally (that is, if
28   <parameter>man.hyphenate</parameter> is zero, setting
29   <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
30 </note>
31
32 <para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
33 will not be treated specially and are subject to hyphenation just like
34 other words.</para>
35
36 <note>
37   <para>If you are thinking about setting a non-zero value for
38   <parameter>man.hyphenate.urls</parameter> in order to make long
39   URLs break across lines, you'd probably be better off
40   experimenting with setting the
41   <parameter>man.break.after.slash</parameter> parameter first. That
42   will cause long URLs to be broken after slashes.</para>
43 </note>
44
45 </refsection>
46 </refentry>