SCons / src / engine / SCons / Tool / docbook / docbook-xsl-1.76.1 / params / man.base.url.for.relative.links.xml

<refentry xmlns=""
          version="5.0" xml:id="man.base.url.for.relative.links">
    <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
    <refpurpose>Specifies a base URL for relative links</refpurpose>

    <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>


    <para>For any “notesource” listed in the auto-generated
      “NOTES” section of output man pages (which is generated when
      the value of the
      <parameter>man.endnotes.list.enabled</parameter> parameter
      is non-zero), if the notesource is a link source with a
      relative URI, the URI is displayed in output with the value
      of the
      parameter prepended to the value of the link URI.</para>

      <para>A link source is an notesource that references an
        external resource:
            <para>a <tag>ulink</tag> element with a <tag
                class="attribute">url</tag> attribute</para>
            <para>any element with an <tag
                class="attribute">xlink:href</tag> attribute</para>
            <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or
              <tag>videodata</tag> element</para>

    <para>If you use relative URIs in link sources in your DocBook
      <tag>refentry</tag> source, and you leave
      unset, the relative links will appear “as is” in the “Notes”
      section of any man-page output generated from your source.
      That’s probably not what you want, because such relative
      links are only usable in the context of HTML output. So, to
      make the links meaningful and usable in the context of
      man-page output, set a value for
      <parameter>man.base.url.for.relative.links</parameter> that
      points to the online version of HTML output generated from
      your DocBook <tag>refentry</tag> source. For
        >&lt;xsl:param name="man.base.url.for.relative.links"


  <refsection><info><title>Related Parameters</title></info>