+++ /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.are.numbered">\r
-<refmeta>\r
-<refentrytitle>man.endnotes.are.numbered</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>man.endnotes.are.numbered</refname>\r
-<refpurpose>Number endnotes?</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="man.endnotes.are.numbered.frag">\r
-<xsl:param name="man.endnotes.are.numbered">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.are.numbered</parameter> is\r
-non-zero (the default), then for each non-empty<footnote>\r
-<para>A “non-empty” notesource 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” notesource is on that looks like this:<literallayout class="monospaced"> <ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/></literallayout>\r
-</para></footnote> “notesource”:\r
-\r
-<itemizedlist>\r
- <listitem>\r
- <para>a number (in square brackets) is displayed inline after the\r
- rendered inline contents (if any) of the notesource</para>\r
- </listitem>\r
- <listitem>\r
- <para>the contents of the notesource are included in a\r
- numbered list of endnotes that is generated at the end of\r
- each man page; the number for each endnote corresponds to\r
- the inline number for the notesource with which it is\r
- associated</para>\r
- </listitem>\r
-</itemizedlist>\r
-The default heading for the list of endnotes is\r
-<literal>NOTES</literal>. To output a different heading, set a value\r
-for the <parameter>man.endnotes.section.heading</parameter>\r
-parameter.</para>\r
-\r
-<note>\r
- <para>The endnotes list is also displayed (but without\r
- numbers) if the value of\r
- <parameter>man.endnotes.list.enabled</parameter> is\r
- non-zero.</para>\r
-</note>\r
-\r
-\r
-<para>If the value of <parameter>man.endnotes.are.numbered</parameter> is\r
-zero, numbering of endnotess is suppressed; only inline\r
-contents (if any) of the notesource are displayed inline.\r
-<important>\r
- <para>If you are thinking about disabling endnote numbering by setting\r
- the value of <parameter>man.endnotes.are.numbered</parameter> to zero,\r
- before you do so, first take some time to carefully\r
- consider the information needs and experiences of your users. The\r
- square-bracketed numbers displayed inline after notesources may seem\r
- obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might\r
- think it would be better to just display URLs for non-empty\r
- links inline, after their content, rather than displaying\r
- square-bracketed numbers all over the place. But it's not better. In\r
- fact, it's not even practical, because many (most) URLs for links\r
- are too long to be displayed inline. They end up overflowing the\r
- right margin. You can set a non-zero value for\r
- <parameter>man.break.after.slash</parameter> parameter to deal with\r
- that, but it could be argued that what you end up with is at least\r
- as ugly, and definitely more obstrusive, then having short\r
- square-bracketed numbers displayed inline.</para></footnote>,\r
-\r
- but in a text-only output format, the\r
- numbered-notesources/endnotes-listing mechanism is the only\r
- practical way to handle this kind of content.</para>\r
-\r
- <para>Also, users of “text based” browsers such as\r
- <command>lynx</command> will already be accustomed to seeing inline\r
- numbers for links. And various "man to html" applications, such as\r
- the widely used <command><link xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)\r
- application, can automatically turn URLs into "real" HTML hyperlinks\r
- in output. So leaving <parameter>man.endnotes.are.numbered</parameter>\r
- at its default (non-zero) value ensures that no information is\r
- lost in your man-page output. It just gets\r
- “rearranged”.</para>\r
-</important>\r
-</para>\r
-<para>The handling of empty links is not affected by this\r
-parameter. Empty links are handled simply by displaying their URLs\r
-inline. Empty links are never auto-numbered.</para>\r
-\r
-<para>If you disable endnotes numbering, you should probably also set\r
-<parameter>man.font.links</parameter> to an empty value (to\r
-disable font formatting for links.</para>\r
-</refsection>\r
-\r
-<refsection><info><title>Related Parameters</title></info>\r
- <para><parameter>man.endnotes.list.enabled</parameter>,\r
- <parameter>man.font.links</parameter></para>\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff