summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/xref.label-page.separator.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/xref.label-page.separator.xml')
-rw-r--r--kdoctools/docbook/xsl/params/xref.label-page.separator.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/xref.label-page.separator.xml b/kdoctools/docbook/xsl/params/xref.label-page.separator.xml
new file mode 100644
index 000000000..a54400294
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/xref.label-page.separator.xml
@@ -0,0 +1,33 @@
+<refentry id="xref.label-page.separator">
+<refmeta>
+<refentrytitle>xref.label-page.separator</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>xref.label-page.separator</refname>
+<refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='xref.label-page.separator.frag'><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+This parameter allows you to control the punctuation of certain
+types of generated cross reference text.
+When cross reference text is generated for an
+<sgmltag class="element">xref</sgmltag> or
+<sgmltag class="element">olink</sgmltag> element
+using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute
+that makes use of the <literal>select:</literal> feature,
+and the selected components include both label and page
+but no title,
+then the value of this parameter is inserted between
+label and page number in the output.
+If a title is included, then other separators are used.
+</para>
+
+</refsect1>
+</refentry>