olink.docbook-xsl.params.refentry.source.name.profile.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of olink-maven-plugin Show documentation

There is a newer version: 1.2.6



refentry.source.name.profile
string


refentry.source.name.profile
Specifies profile for refentry "source name" data





  (($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]




Description

The value of refentry.source.name.profile
is a string representing an XPath expression. It is evaluated at
run-time and used only if
refentry.source.name.profile.enabled is
non-zero. Otherwise, the refentry metadata-gathering logic
"hard coded" into the stylesheets is used.

A "source name" is one part of a (potentially) two-part
Name Version
"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
man(7) man page describes it as "the source of
the command", and provides the following examples:

  
    For binaries, use something like: GNU, NET-2, SLS
    Distribution, MCC Distribution.
  
  
    For system calls, use the version of the kernel that you
    are currently looking at: Linux 0.99.11.
  
  
    For library calls, use the source of the function: GNU, BSD
    4.3, Linux DLL 4.4.1.
  



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,
Name Version,
where:

  
    Name
    
      product name (e.g., BSD) or org. name (e.g., GNU)
    
  
  
    Version
    
      version number
    
  

Each part is optional. If the Name is a
product name, then the Version is probably
the version of the product. Or there may be no
Name, in which case, if there is a
Version, it is probably the version
of the item itself, not the product it is part of. Or, if the
Name is an organization name, then there
probably will be no Version.