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