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