man.endnotes.are.numbered
man.endnotes.are.numbered — Number endnotes?
Synopsis
<xsl:param name="man.endnotes.are.numbered">1</xsl:param>
Description
If the value of man.endnotes.are.numbered is
non-zero (the default), then for each non-empty “notesource”:
a number (in square brackets) is displayed inline after the
rendered inline contents (if any) of the notesource
the contents of the notesource are included in a
numbered list of endnotes that is generated at the end of
each man page; the number for each endnote corresponds to
the inline number for the notesource with which it is
associated
The default heading for the list of endnotes is
NOTES. To output a different heading, set a value
for the man.endnotes.section.heading
parameter.
Note
The endnotes list is also displayed (but without
numbers) if the value of
man.endnotes.list.enabled is
non-zero.
If the value of man.endnotes.are.numbered is
zero, numbering of endnotess is suppressed; only inline
contents (if any) of the notesource are displayed inline.
Important
If you are thinking about disabling endnote numbering by setting
the value of man.endnotes.are.numbered to zero,
before you do so, first take some time to carefully
consider the information needs and experiences of your users. The
square-bracketed numbers displayed inline after notesources may seem
obstrusive and aesthetically unpleasing,
but in a text-only output format, the
numbered-notesources/endnotes-listing mechanism is the only
practical way to handle this kind of content.
Also, users of “text based” browsers such as
lynx will already be accustomed to seeing inline
numbers for links. And various "man to html" applications, such as
the widely used man2html (VH-Man2html)
application, can automatically turn URLs into "real" HTML hyperlinks
in output. So leaving man.endnotes.are.numbered
at its default (non-zero) value ensures that no information is
lost in your man-page output. It just gets
“rearranged”.
The handling of empty links is not affected by this
parameter. Empty links are handled simply by displaying their URLs
inline. Empty links are never auto-numbered.
If you disable endnotes numbering, you should probably also set
man.font.links to an empty value (to
disable font formatting for links.
Related Parameters
man.endnotes.list.enabled,
man.font.links