X-Git-Url: https://git.stg.codes/stg.git/blobdiff_plain/0c9c28efcd43f53ac54aa60b2dfefa69c70dbadf..6b6d9b29e9e9e91f79507a8bf193fb30de311dcc:/doc/help/xslt/params/refentry.source.name.profile.xml

diff --git a/doc/help/xslt/params/refentry.source.name.profile.xml b/doc/help/xslt/params/refentry.source.name.profile.xml
new file mode 100644
index 00000000..c9a10122
--- /dev/null
+++ b/doc/help/xslt/params/refentry.source.name.profile.xml
@@ -0,0 +1,89 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="refentry.source.name.profile">
+<refmeta>
+<refentrytitle>refentry.source.name.profile</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>refentry.source.name.profile</refname>
+<refpurpose>Specifies profile for refentry "source name" data</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="refentry.source.name.profile.frag">
+<xsl:param name="refentry.source.name.profile">
+  (($info[//productname])[last()]/productname)[1]|
+  (($info[//corpname])[last()]/corpname)[1]|
+  (($info[//corpcredit])[last()]/corpcredit)[1]|
+  (($info[//corpauthor])[last()]/corpauthor)[1]|
+  (($info[//orgname])[last()]/orgname)[1]|
+  (($info[//publishername])[last()]/publishername)[1]
+</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The value of <parameter>refentry.source.name.profile</parameter>
+is a string representing an XPath expression. It is evaluated at
+run-time and used only if
+<parameter>refentry.source.name.profile.enabled</parameter> is
+non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
+"hard coded" into the stylesheets is used.</para>
+
+<para>A "source name" is one part of a (potentially) two-part
+<replaceable>Name</replaceable> <replaceable>Version</replaceable>
+"source" field. In man pages, it is usually displayed in the left
+footer of the page. It typically indicates the software system or
+product that the item documented in the man page belongs to. The
+<literal>man(7)</literal> man page describes it as "the source of
+the command", and provides the following examples:
+<itemizedlist>
+  <listitem>
+    <para>For binaries, use something like: GNU, NET-2, SLS
+    Distribution, MCC Distribution.</para>
+  </listitem>
+  <listitem>
+    <para>For system calls, use the version of the kernel that you
+    are currently looking at: Linux 0.99.11.</para>
+  </listitem>
+  <listitem>
+    <para>For library calls, use the source of the function: GNU, BSD
+    4.3, Linux DLL 4.4.1.</para>
+  </listitem>
+</itemizedlist>
+</para>
+
+<para>In practice, there are many pages that simply have a Version
+number in the "source" field. So, it looks like what we have is a
+two-part field,
+<replaceable>Name</replaceable> <replaceable>Version</replaceable>,
+where:
+<variablelist>
+  <varlistentry>
+    <term>Name</term>
+    <listitem>
+      <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
+    </listitem>
+  </varlistentry>
+  <varlistentry>
+    <term>Version</term>
+    <listitem>
+      <para>version number</para>
+    </listitem>
+  </varlistentry>
+</variablelist>
+Each part is optional. If the <replaceable>Name</replaceable> is a
+product name, then the <replaceable>Version</replaceable> is probably
+the version of the product. Or there may be no
+<replaceable>Name</replaceable>, in which case, if there is a
+<replaceable>Version</replaceable>, it is probably the version
+of the item itself, not the product it is part of. Or, if the
+<replaceable>Name</replaceable> is an organization name, then there
+probably will be no <replaceable>Version</replaceable>.</para>
+</refsection>
+</refentry>