profile.role.xml 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. <refsynopsisdiv>
  17. <src:fragment xml:id="profile.role.frag">
  18. <xsl:param name="profile.role"></xsl:param>
  19. </src:fragment>
  20. </refsynopsisdiv>
  21. <refsection><info><title>Description</title></info>
  22. <para>The value of this parameter specifies profiles which should be
  23. included in the output. You can specify multiple profiles by
  24. separating them by semicolon. You can change separator character by
  25. <parameter>profile.separator</parameter>
  26. parameter.</para>
  27. <para>This parameter has effect only when you are using profiling
  28. stylesheets (<filename>profile-docbook.xsl</filename>,
  29. <filename>profile-chunk.xsl</filename>, …) instead of normal
  30. ones (<filename>docbook.xsl</filename>,
  31. <filename>chunk.xsl</filename>, …).</para>
  32. <warning>
  33. <para>Note that <tag class="attribute">role</tag> is often
  34. used for other purposes than profiling. For example it is commonly
  35. used to get emphasize in bold font:</para>
  36. <programlisting>&lt;emphasis role="bold"&gt;very important&lt;/emphasis&gt;</programlisting>
  37. <para>If you are using <tag class="attribute">role</tag> for
  38. these purposes do not forget to add values like <literal>bold</literal> to
  39. value of this parameter. If you forgot you will get document with
  40. small pieces missing which are very hard to track.</para>
  41. <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
  42. 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>
  43. </warning>
  44. </refsection>
  45. </refentry>