refentry.manual.profile.xml 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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="refentry.manual.profile">
  7. <refmeta>
  8. <refentrytitle>refentry.manual.profile</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>refentry.manual.profile</refname>
  13. <refpurpose>Specifies profile for refentry "manual" data</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="refentry.manual.profile.frag">
  17. <xsl:param name="refentry.manual.profile">
  18. (($info[//title])[last()]/title)[1]|
  19. ../title/node()
  20. </xsl:param>
  21. </src:fragment>
  22. </refsynopsisdiv>
  23. <refsection><info><title>Description</title></info>
  24. <para>The value of <parameter>refentry.manual.profile</parameter> is
  25. a string representing an XPath expression. It is evaluated at
  26. run-time and used only if
  27. <parameter>refentry.manual.profile.enabled</parameter> is
  28. non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
  29. "hard coded" into the stylesheets is used.</para>
  30. <para>In man pages, this content is usually displayed in the middle of
  31. the header of the page. The <literal>man(7)</literal> man page
  32. describes this as "the title of the manual (e.g., <citetitle>Linux
  33. Programmer's Manual</citetitle>)". Here are some examples from
  34. existing man pages:
  35. <itemizedlist>
  36. <listitem>
  37. <para><citetitle>dpkg utilities</citetitle>
  38. (<command>dpkg-name</command>)</para>
  39. </listitem>
  40. <listitem>
  41. <para><citetitle>User Contributed Perl Documentation</citetitle>
  42. (<command>GET</command>)</para>
  43. </listitem>
  44. <listitem>
  45. <para><citetitle>GNU Development Tools</citetitle>
  46. (<command>ld</command>)</para>
  47. </listitem>
  48. <listitem>
  49. <para><citetitle>Emperor Norton Utilities</citetitle>
  50. (<command>ddate</command>)</para>
  51. </listitem>
  52. <listitem>
  53. <para><citetitle>Debian GNU/Linux manual</citetitle>
  54. (<command>faked</command>)</para>
  55. </listitem>
  56. <listitem>
  57. <para><citetitle>GIMP Manual Pages</citetitle>
  58. (<command>gimp</command>)</para>
  59. </listitem>
  60. <listitem>
  61. <para><citetitle>KDOC Documentation System</citetitle>
  62. (<command>qt2kdoc</command>)</para>
  63. </listitem>
  64. </itemizedlist>
  65. </para>
  66. </refsection>
  67. </refentry>