summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/variablelist.as.blocks.xml')
-rw-r--r--kdoctools/docbook/xsl/params/variablelist.as.blocks.xml44
1 files changed, 44 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml b/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml
new file mode 100644
index 000000000..017e16651
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml
@@ -0,0 +1,44 @@
+<refentry id="variablelist.as.blocks">
+<refmeta>
+<refentrytitle>variablelist.as.blocks</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>variablelist.as.blocks</refname>
+<refpurpose>Format <sgmltag>variablelist</sgmltag>s lists as blocks?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='variablelist.as.blocks.frag'>
+<xsl:param name="variablelist.as.blocks" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If non-zero, <sgmltag>variablelist</sgmltag>s will be formatted as
+blocks.</para>
+
+<para>If you have long terms, proper list markup in the FO case may produce
+unattractive lists. By setting this parameter, you can force the stylesheets
+to produce block markup instead of proper lists.</para>
+
+<para>You can override this setting with a processing instruction as the
+child of <sgmltag>variablelist</sgmltag>: <sgmltag class="pi">dbfo
+list-presentation="blocks"</sgmltag> or <sgmltag class="pi">dbfo
+list-presentation="list"</sgmltag></para>
+
+<programlisting><![CDATA[ <variablelist>
+ <?dbfo list-presentation="list"?>
+ <varlistentry>
+ <term>list</term>
+ <listitem>
+ <para>
+ Formatted as a list even if variablelist.as.blocks is set to 1.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>]]></programlisting>
+</refsect1>
+
+</refentry>