+++ /dev/null
-<refentry xmlns="http://docbook.org/ns/docbook"\r
- xmlns:xlink="http://www.w3.org/1999/xlink"\r
- xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
- version="5.0" xml:id="man.base.url.for.relative.links">\r
- <refmeta>\r
- <refentrytitle>man.base.url.for.relative.links</refentrytitle>\r
- <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
- </refmeta>\r
- <refnamediv>\r
- <refname>man.base.url.for.relative.links</refname>\r
- <refpurpose>Specifies a base URL for relative links</refpurpose>\r
- </refnamediv>\r
-\r
- <refsynopsisdiv>\r
- <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
- </refsynopsisdiv>\r
-\r
- <refsection><info><title>Description</title></info>\r
-\r
- <para>For any “notesource” listed in the auto-generated\r
- “NOTES” section of output man pages (which is generated when\r
- the value of the\r
- <parameter>man.endnotes.list.enabled</parameter> parameter\r
- is non-zero), if the notesource is a link source with a\r
- relative URI, the URI is displayed in output with the value\r
- of the\r
- <parameter>man.base.url.for.relative.links</parameter>\r
- parameter prepended to the value of the link URI.</para>\r
-\r
- <note>\r
- <para>A link source is an notesource that references an\r
- external resource:\r
- <itemizedlist>\r
- <listitem>\r
- <para>a <tag>ulink</tag> element with a <tag\r
- class="attribute">url</tag> attribute</para>\r
- </listitem>\r
- <listitem>\r
- <para>any element with an <tag\r
- class="attribute">xlink:href</tag> attribute</para>\r
- </listitem>\r
- <listitem>\r
- <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or\r
- <tag>videodata</tag> element</para>\r
- </listitem>\r
- </itemizedlist>\r
- </para>\r
- </note>\r
-\r
- <para>If you use relative URIs in link sources in your DocBook\r
- <tag>refentry</tag> source, and you leave\r
- <parameter>man.base.url.for.relative.links</parameter>\r
- unset, the relative links will appear “as is” in the “Notes”\r
- section of any man-page output generated from your source.\r
- That’s probably not what you want, because such relative\r
- links are only usable in the context of HTML output. So, to\r
- make the links meaningful and usable in the context of\r
- man-page output, set a value for\r
- <parameter>man.base.url.for.relative.links</parameter> that\r
- points to the online version of HTML output generated from\r
- your DocBook <tag>refentry</tag> source. For\r
- example:\r
- <programlisting\r
- ><xsl:param name="man.base.url.for.relative.links"\r
- >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param></programlisting>\r
- </para>\r
-\r
- </refsection>\r
-\r
- <refsection><info><title>Related Parameters</title></info>\r
- <para><parameter>man.endnotes.list.enabled</parameter></para>\r
- </refsection>\r
-\r
-</refentry>\r