summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml')
-rw-r--r--kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml b/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml
new file mode 100644
index 000000000..7c664c5c1
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml
@@ -0,0 +1,33 @@
+<refentry id="preferred.mediaobject.role">
+<refmeta>
+<refentrytitle>preferred.mediaobject.role</refentrytitle>
+</refmeta>
+<refnamediv>
+<refname>preferred.mediaobject.role</refname>
+<refpurpose>Select which mediaobject to use based on
+this value of an object's <sgmltag class="attribute">role</sgmltag> attribute.
+</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='preferred.mediaobject.role.frag'>
+<xsl:param name="preferred.mediaobject.role"></xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>A mediaobject may contain several objects such as imageobjects.
+If the parameter <parameter>use.role.for.mediaobject</parameter>
+is non-zero, then the <sgmltag class="attribute">role</sgmltag> attribute on
+<sgmltag>imageobject</sgmltag>s and other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be
+used. If one of the objects has a role value that matches the
+preferred.mediaobject.role parameter, then it has first
+priority for selection. If more than one has such a
+role value, the first one is used.
+</para>
+<para>
+See the <parameter>use.role.for.mediaobject</parameter> parameter
+for the sequence of selection.</para>
+</refsect1>
+</refentry>