stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/refentry.manual.profile.xml

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