DocBook documentation stub added

[stg.git] / doc / help / xslt / params / man.break.after.slash.xml

diff --git a/doc/help/xslt/params/man.break.after.slash.xml b/doc/help/xslt/params/man.break.after.slash.xml
new file mode 100644 (file)
index 0000000..859edb7
--- /dev/null
+++ b/doc/help/xslt/params/man.break.after.slash.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.break.after.slash">
+<refmeta>
+<refentrytitle>man.break.after.slash</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.break.after.slash</refname>
+<refpurpose>Enable line-breaking after slashes?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.break.after.slash.frag">
+<xsl:param name="man.break.after.slash">0</xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If non-zero, line-breaking after slashes is enabled. This is
+mainly useful for causing long URLs or pathnames/filenames to be
+broken up or "wrapped" across lines (though it also has the side
+effect of sometimes causing relatively short URLs and pathnames to be
+broken up across lines too).</para>
+
+<para>If zero (the default), line-breaking after slashes is
+disabled. In that case, strings containing slashes (for example, URLs
+or filenames) are not broken across lines, even if they exceed the
+maximum column widith.</para>
+
+<warning>
+  <para>If you set a non-zero value for this parameter, check your
+  man-page output carefuly afterwards, in order to make sure that the
+  setting has not introduced an excessive amount of breaking-up of URLs
+  or pathnames. If your content contains mostly short URLs or
+  pathnames, setting a non-zero value for
+  <parameter>man.break.after.slash</parameter> will probably result in
+  in a significant number of relatively short URLs and pathnames being
+  broken across lines, which is probably not what you want.</para>
+</warning>
+
+</refsection>
+</refentry>