doc/xslt/params/man.font.links.xml

   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="man.font.links">
   7 <refmeta>
   8 <refentrytitle>man.font.links</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>man.font.links</refname>
  13 <refpurpose>Specifies font for links</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="man.font.links.frag">
  18 <xsl:param name="man.font.links">B</xsl:param>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>The <parameter>man.font.links</parameter> parameter
  25 specifies the font for output of links (<tag>ulink</tag> instances
  26 and any instances of any element with an <tag
  27   class="attribute">xlink:href</tag> attribute).</para>
  28
  29 <para>The value of <parameter>man.font.links</parameter> must be
  30   either <literal>B</literal> or <literal>I</literal>, or empty. If
  31 the value is empty, no font formatting is applied to links.</para>
  32
  33 <para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or
  34 <parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then
  35 you should probably also set an empty value for
  36 <parameter>man.font.links</parameter>. But if
  37 <parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),
  38 you should probably keep
  39 <parameter>man.font.links</parameter> set to
  40 <literal>B</literal> or <literal>I</literal><footnote><para>The
  41     main purpose of applying a font format to links in most output
  42 formats it to indicate that the formatted text is
  43 “clickable”; given that links rendered in man pages are
  44 not “real” hyperlinks that users can click on, it might
  45 seem like there is never a good reason to have font formatting for
  46 link contents in man output.</para>
  47 <para>In fact, if you suppress the
  48 display of inline link references (by setting
  49 <parameter>man.endnotes.are.numbered</parameter> to zero), there is no
  50 good reason to apply font formatting to links. However, if
  51 <parameter>man.endnotes.are.numbered</parameter> is non-zero, having
  52 font formatting for links (arguably) serves a purpose: It provides
  53 “context” information about exactly what part of the text
  54 is being “annotated” by the link. Depending on how you
  55 mark up your content, that context information may or may not
  56 have value.</para></footnote>.</para>
  57 </refsection>
  58
  59 <refsection><info><title>Related Parameters</title></info>
  60   <para><parameter>man.endnotes.list.enabled</parameter>,
  61     <parameter>man.endnotes.are.numbered</parameter></para>
  62 </refsection>
  63
  64 </refentry>