+++ /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.endnotes.list.enabled">\r
-<refmeta>\r
-<refentrytitle>man.endnotes.list.enabled</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>man.endnotes.list.enabled</refname>\r
-<refpurpose>Display endnotes list at end of man page?</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="man.endnotes.list.enabled.frag">\r
-<xsl:param name="man.endnotes.list.enabled">1</xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is\r
-non-zero (the default), then an endnotes list is added to the end of\r
-the output man page.</para>\r
-\r
-<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is\r
-zero, the list is suppressed — unless link numbering is enabled (that\r
-is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in\r
-which case, that setting overrides the\r
-<parameter>man.endnotes.list.enabled</parameter> setting, and the\r
-endnotes list is still displayed. The reason is that inline\r
-numbering of notesources associated with endnotes only makes sense\r
-if a (numbered) list of endnotes is also generated.</para>\r
-\r
-<note>\r
- <para>Leaving\r
- <parameter>man.endnotes.list.enabled</parameter> at its default\r
- (non-zero) value ensures that no “out of line” information (such\r
- as the URLs for hyperlinks and images) gets lost in your\r
- man-page output. It just gets “rearranged”.</para>\r
- <para>So if you’re thinking about disabling endnotes listing by\r
- setting the value of\r
- <parameter>man.endnotes.list.enabled</parameter> to zero:\r
- Before you do so, first take some time to carefully consider\r
- the information needs and experiences of your users. The “out\r
- of line” information has value even if the presentation of it\r
- in text output is not as interactive as it may be in other\r
- output formats.</para>\r
- <para>As far as the specific case of URLs: Even though the URLs\r
- displayed in text output may not be “real” (clickable)\r
- hyperlinks, many X terminals have convenience features for\r
- recognizing URLs and can, for example, present users with\r
- an options to open a URL in a browser with the user clicks on\r
- the URL is a terminal window. And short of those, users with X\r
- terminals can always manually cut and paste the URLs into a web\r
- browser.</para>\r
- <para>Also, note that various “man to html” tools, such as the\r
- widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)\r
- application, automatically mark up URLs with <literal>a@href</literal> markup\r
- during conversion — resulting in “real” hyperlinks in HTML\r
- output from those tools.</para>\r
-</note>\r
-\r
-<para>To “turn off” numbering of endnotes in the\r
-endnotes list, set <parameter>man.endnotes.are.numbered</parameter>\r
-to zero. The endnotes list will\r
-still be displayed; it will just be displayed without the\r
-numbers<footnote><para>It can still make sense to have\r
-the list of endnotes displayed even if you have endnotes numbering turned\r
-off. In that case, your endnotes list basically becomes a “list\r
-of references” without any association with specific text in\r
-your document. This is probably the best option if you find the inline\r
-endnotes numbering obtrusive. Your users will still have access to all the “out of line”\r
-such as URLs for hyperlinks.</para></footnote>\r
-</para>\r
-\r
-<para>The default heading for the endnotes list is\r
-<literal>NOTES</literal>. To change that, set a non-empty\r
-value for the <parameter>man.endnotes.list.heading</parameter>\r
-parameter.</para>\r
-\r
-<para>In the case of notesources that are links: Along with the\r
-URL for each link, the endnotes list includes the contents of the\r
-link. The list thus includes only non-empty<footnote>\r
-\r
-<para>A “non-empty” link is one that looks like\r
-this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/">manpages</ulink></literallayout>\r
-an “empty link” is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>\r
-</para></footnote> links.\r
-\r
-Empty links are never included, and never numbered. They are simply\r
-displayed inline, without any numbering.</para>\r
-\r
-<para>In addition, if there are multiple instances of links in a\r
-<tag>refentry</tag> that have the same URL, the URL is listed only\r
-once. The contents listed for that link in the endnotes list are\r
-the contents of the first link which has that URL.</para>\r
-\r
-<para>If you disable endnotes listing, you should probably also set\r
-<parameter>man.links.are.underlined</parameter> to zero (to disable\r
-link underlining).</para>\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff