| 1 | <refentry xmlns="http://docbook.org/ns/docbook"
|
|---|
| 2 | xmlns:xlink="http://www.w3.org/1999/xlink"
|
|---|
| 3 | xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 4 | xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
|
|---|
| 5 | xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
|---|
| 6 | version="5.0" xml:id="profile.role">
|
|---|
| 7 | <refmeta>
|
|---|
| 8 | <refentrytitle>profile.role</refentrytitle>
|
|---|
| 9 | <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
|
|---|
| 10 | </refmeta>
|
|---|
| 11 | <refnamediv>
|
|---|
| 12 | <refname>profile.role</refname>
|
|---|
| 13 | <refpurpose>Target profile for <tag class="attribute">role</tag>
|
|---|
| 14 | attribute</refpurpose>
|
|---|
| 15 | </refnamediv>
|
|---|
| 16 |
|
|---|
| 17 | <refsynopsisdiv>
|
|---|
| 18 | <src:fragment xml:id="profile.role.frag">
|
|---|
| 19 | <xsl:param name="profile.role"></xsl:param>
|
|---|
| 20 | </src:fragment>
|
|---|
| 21 | </refsynopsisdiv>
|
|---|
| 22 |
|
|---|
| 23 | <refsection><info><title>Description</title></info>
|
|---|
| 24 |
|
|---|
| 25 | <para>The value of this parameter specifies profiles which should be
|
|---|
| 26 | included in the output. You can specify multiple profiles by
|
|---|
| 27 | separating them by semicolon. You can change separator character by
|
|---|
| 28 | <parameter>profile.separator</parameter>
|
|---|
| 29 | parameter.</para>
|
|---|
| 30 |
|
|---|
| 31 | <para>This parameter has effect only when you are using profiling
|
|---|
| 32 | stylesheets (<filename>profile-docbook.xsl</filename>,
|
|---|
| 33 | <filename>profile-chunk.xsl</filename>, …) instead of normal
|
|---|
| 34 | ones (<filename>docbook.xsl</filename>,
|
|---|
| 35 | <filename>chunk.xsl</filename>, …).</para>
|
|---|
| 36 |
|
|---|
| 37 | <warning>
|
|---|
| 38 | <para>Note that <tag class="attribute">role</tag> is often
|
|---|
| 39 | used for other purposes than profiling. For example it is commonly
|
|---|
| 40 | used to get emphasize in bold font:</para>
|
|---|
| 41 |
|
|---|
| 42 | <programlisting><emphasis role="bold">very important</emphasis></programlisting>
|
|---|
| 43 |
|
|---|
| 44 | <para>If you are using <tag class="attribute">role</tag> for
|
|---|
| 45 | these purposes do not forget to add values like <literal>bold</literal> to
|
|---|
| 46 | value of this parameter. If you forgot you will get document with
|
|---|
| 47 | small pieces missing which are very hard to track.</para>
|
|---|
| 48 |
|
|---|
| 49 | <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
|
|---|
| 50 | 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>
|
|---|
| 51 | </warning>
|
|---|
| 52 |
|
|---|
| 53 | </refsection>
|
|---|
| 54 | </refentry>
|
|---|
