refentry.source.name.profile.xml 3.4 KB

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