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