diff options
Diffstat (limited to '3rdParty/DocBook/XSL/params/profile.role.xml')
-rw-r--r-- | 3rdParty/DocBook/XSL/params/profile.role.xml | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/3rdParty/DocBook/XSL/params/profile.role.xml b/3rdParty/DocBook/XSL/params/profile.role.xml new file mode 100644 index 0000000..5758e4a --- /dev/null +++ b/3rdParty/DocBook/XSL/params/profile.role.xml @@ -0,0 +1,54 @@ +<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="profile.role"> +<refmeta> +<refentrytitle>profile.role</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.role</refname> +<refpurpose>Target profile for <tag class="attribute">role</tag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="profile.role.frag"> +<xsl:param name="profile.role"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>The value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<parameter>profile.separator</parameter> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +<warning> +<para>Note that <tag class="attribute">role</tag> is often +used for other purposes than profiling. For example it is commonly +used to get emphasize in bold font:</para> + +<programlisting><emphasis role="bold">very important</emphasis></programlisting> + +<para>If you are using <tag class="attribute">role</tag> for +these purposes do not forget to add values like <literal>bold</literal> to +value of this parameter. If you forgot you will get document with +small pieces missing which are very hard to track.</para> + +<para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should +rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para> +</warning> + +</refsection> +</refentry> |