DocBook documentation stub added

[stg.git] / doc / help / xslt / params / man.hyphenate.urls.xml

diff --git a/doc/help/xslt/params/man.hyphenate.urls.xml b/doc/help/xslt/params/man.hyphenate.urls.xml
new file mode 100644 (file)
index 0000000..a64dfa7
--- /dev/null
+++ b/doc/help/xslt/params/man.hyphenate.urls.xml
@@ -0,0 +1,46 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.hyphenate.urls">
+<refmeta>
+<refentrytitle>man.hyphenate.urls</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.hyphenate.urls</refname>
+<refpurpose>Hyphenate URLs?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.hyphenate.urls.frag">
+<xsl:param name="man.hyphenate.urls">0</xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If zero (the default), hyphenation is suppressed for output of
+the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>
+
+<note>
+  <para>If hyphenation is already turned off globally (that is, if
+  <parameter>man.hyphenate</parameter> is zero, setting
+  <parameter>man.hyphenate.urls</parameter> is not necessary.</para>
+</note>
+
+<para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs
+will not be treated specially and are subject to hyphenation just like
+other words.</para>
+
+<note>
+  <para>If you are thinking about setting a non-zero value for
+  <parameter>man.hyphenate.urls</parameter> in order to make long
+  URLs break across lines, you'd probably be better off
+  experimenting with setting the
+  <parameter>man.break.after.slash</parameter> parameter first. That
+  will cause long URLs to be broken after slashes.</para>
+</note>
+
+</refsection>
+</refentry>