stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.base.url.for.relative.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.base.url.for.relative.links">\r
   7   <refmeta>\r
   8     <refentrytitle>man.base.url.for.relative.links</refentrytitle>\r
   9     <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
  10   </refmeta>\r
  11   <refnamediv>\r
  12     <refname>man.base.url.for.relative.links</refname>\r
  13     <refpurpose>Specifies a base URL for relative links</refpurpose>\r
  14   </refnamediv>\r
  15 \r
  16   <refsynopsisdiv>\r
  17     <src:fragment xml:id="man.base.url.for.relative.links.frag"><xsl:param name="man.base.url.for.relative.links">[set $man.base.url.for.relative.links]/</xsl:param></src:fragment>\r
  18   </refsynopsisdiv>\r
  19 \r
  20   <refsection><info><title>Description</title></info>\r
  21 \r
  22     <para>For any “notesource” listed in the auto-generated\r
  23       “NOTES” section of output man pages (which is generated when\r
  24       the value of the\r
  25       <parameter>man.endnotes.list.enabled</parameter> parameter\r
  26       is non-zero), if the notesource is a link source with a\r
  27       relative URI, the URI is displayed in output with the value\r
  28       of the\r
  29       <parameter>man.base.url.for.relative.links</parameter>\r
  30       parameter prepended to the value of the link URI.</para>\r
  31 \r
  32     <note>\r
  33       <para>A link source is an notesource that references an\r
  34         external resource:\r
  35         <itemizedlist>\r
  36           <listitem>\r
  37             <para>a <tag>ulink</tag> element with a <tag\r
  38                 class="attribute">url</tag> attribute</para>\r
  39           </listitem>\r
  40           <listitem>\r
  41             <para>any element with an <tag\r
  42                 class="attribute">xlink:href</tag> attribute</para>\r
  43           </listitem>\r
  44           <listitem>\r
  45             <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or\r
  46               <tag>videodata</tag> element</para>\r
  47           </listitem>\r
  48         </itemizedlist>\r
  49       </para>\r
  50     </note>\r
  51 \r
  52     <para>If you use relative URIs in link sources in your DocBook\r
  53       <tag>refentry</tag> source, and you leave\r
  54       <parameter>man.base.url.for.relative.links</parameter>\r
  55       unset, the relative links will appear “as is” in the “Notes”\r
  56       section of any man-page output generated from your source.\r
  57       That’s probably not what you want, because such relative\r
  58       links are only usable in the context of HTML output. So, to\r
  59       make the links meaningful and usable in the context of\r
  60       man-page output, set a value for\r
  61       <parameter>man.base.url.for.relative.links</parameter> that\r
  62       points to the online version of HTML output generated from\r
  63       your DocBook <tag>refentry</tag> source. For\r
  64       example:\r
  65       <programlisting\r
  66         >&lt;xsl:param name="man.base.url.for.relative.links"\r
  67         >http://www.kernel.org/pub/software/scm/git/docs/&lt;/xsl:param></programlisting>\r
  68     </para>\r
  69 \r
  70   </refsection>\r
  71 \r
  72   <refsection><info><title>Related Parameters</title></info>\r
  73     <para><parameter>man.endnotes.list.enabled</parameter></para>\r
  74   </refsection>\r
  75 \r
  76 </refentry>\r