man.font.links.xml 2.7 KB

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