| [2] | 1 | <refentry id="refentry.source.name.profile">
|
|---|
| 2 | <refmeta>
|
|---|
| 3 | <refentrytitle>refentry.source.name.profile</refentrytitle>
|
|---|
| 4 | <refmiscinfo role="type">string</refmiscinfo>
|
|---|
| 5 | </refmeta>
|
|---|
| 6 | <refnamediv>
|
|---|
| 7 | <refname>refentry.source.name.profile</refname>
|
|---|
| 8 | <refpurpose>Specifies profile for refentry "source name" data</refpurpose>
|
|---|
| 9 | </refnamediv>
|
|---|
| 10 |
|
|---|
| 11 | <refsynopsisdiv>
|
|---|
| 12 | <src:fragment id='refentry.source.name.profile.frag'>
|
|---|
| 13 | <xsl:param name="refentry.source.name.profile">
|
|---|
| 14 | ($info/productname
|
|---|
| 15 | |$parentinfo/productname
|
|---|
| 16 | |$info/orgname
|
|---|
| 17 | |$parentinfo/orgname
|
|---|
| 18 | |$info/corpname
|
|---|
| 19 | |$parentinfo/corpname
|
|---|
| 20 | |$info/corpcredit
|
|---|
| 21 | |$parentinfo/corpcredit
|
|---|
| 22 | |$info/corpauthor
|
|---|
| 23 | |$parentinfo/corpauthor
|
|---|
| 24 | |$info/author/orgname
|
|---|
| 25 | |$parentinfo/author/orgname
|
|---|
| 26 | |$info//publishername
|
|---|
| 27 | |$parentinfo//publishername)[1]/node()
|
|---|
| 28 | </xsl:param>
|
|---|
| 29 | </src:fragment>
|
|---|
| 30 | </refsynopsisdiv>
|
|---|
| 31 |
|
|---|
| 32 | <refsect1><title>Description</title>
|
|---|
| 33 |
|
|---|
| 34 | <para>The value of <parameter>refentry.source.name.profile</parameter>
|
|---|
| 35 | is a string representing an XPath expression. It is evaluated at
|
|---|
| 36 | run-time and used only if
|
|---|
| 37 | <parameter>refentry.source.name.profile.enabled</parameter> is
|
|---|
| 38 | non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
|
|---|
| 39 | "hard coded" into the stylesheets is used.</para>
|
|---|
| 40 |
|
|---|
| 41 | <para>A "source name" is one part of a (potentially) two-part
|
|---|
| 42 | <replaceable>Name</replaceable> <replaceable>Version</replaceable>
|
|---|
| 43 | "source" field. In man pages, it is usually displayed in the left
|
|---|
| 44 | footer of the page. The <literal>man(7)</literal> man page describes
|
|---|
| 45 | this as "the source of the command", and provides the following
|
|---|
| 46 | examples:
|
|---|
| 47 | <itemizedlist>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>For binaries, use something like: GNU, NET-2, SLS
|
|---|
| 50 | Distribution, MCC Distribution.</para>
|
|---|
| 51 | </listitem>
|
|---|
| 52 | <listitem>
|
|---|
| 53 | <para>For system calls, use the version of the kernel that you
|
|---|
| 54 | are currently looking at: Linux 0.99.11.</para>
|
|---|
| 55 | </listitem>
|
|---|
| 56 | <listitem>
|
|---|
| 57 | <para>For library calls, use the source of the function: GNU, BSD
|
|---|
| 58 | 4.3, Linux DLL 4.4.1.</para>
|
|---|
| 59 | </listitem>
|
|---|
| 60 | </itemizedlist>
|
|---|
| 61 | </para>
|
|---|
| 62 |
|
|---|
| 63 | <para>In practice, there are many pages that simply have a Version
|
|---|
| 64 | number in the "source" field. So, it looks like what we have is a
|
|---|
| 65 | two-part field,
|
|---|
| 66 | <replaceable>Name</replaceable> <replaceable>Version</replaceable>,
|
|---|
| 67 | where:
|
|---|
| 68 | <variablelist>
|
|---|
| 69 | <varlistentry>
|
|---|
| 70 | <term>Name</term>
|
|---|
| 71 | <listitem>
|
|---|
| 72 | <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
|
|---|
| 73 | </listitem>
|
|---|
| 74 | </varlistentry>
|
|---|
| 75 | <varlistentry>
|
|---|
| 76 | <term>Version</term>
|
|---|
| 77 | <listitem>
|
|---|
| 78 | <para>version number</para>
|
|---|
| 79 | </listitem>
|
|---|
| 80 | </varlistentry>
|
|---|
| 81 | </variablelist>
|
|---|
| 82 | Each part is optional. If the <replaceable>Name</replaceable> is a
|
|---|
| 83 | product name, then the <replaceable>Version</replaceable> is probably
|
|---|
| 84 | the version of the product. Or there may be no
|
|---|
| 85 | <replaceable>Name</replaceable>, in which case, if there is a
|
|---|
| 86 | <replaceable>Version</replaceable>, it is probably the version
|
|---|
| 87 | of the item itself, not the product it is part of. Or, if the
|
|---|
| 88 | <replaceable>Name</replaceable> is an organization name, then there
|
|---|
| 89 | probably will be no <replaceable>Version</replaceable>.</para>
|
|---|
| 90 | </refsect1>
|
|---|
| 91 | </refentry>
|
|---|
