]> git.stg.codes - stg.git/blob - doc/xslt/params/ulink.hyphenate.xml
Merge branch 'naffanya-dev'
[stg.git] / doc / xslt / params / ulink.hyphenate.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="ulink.hyphenate">
7 <refmeta>
8 <refentrytitle>ulink.hyphenate</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>ulink.hyphenate</refname>
13 <refpurpose>Allow URLs to be automatically hyphenated</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="ulink.hyphenate.frag">
18 <xsl:param name="ulink.hyphenate"></xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If not empty, the specified character (or more generally, content) is
25 added to URLs after every character included in the string
26 in the <parameter>ulink.hyphenate.chars</parameter> parameter (default
27 is <quote>/</quote>). If the character in this parameter is a
28 Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO
29 processors will be able to reasonably hyphenate long URLs.</para>
30
31 <para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly
32 supported than zero-width spaces for this purpose.</para>
33
34 </refsection>
35 </refentry>