</
element>
, the abbreviated end tag for closing the
innermost element </>
or the slash /
which
finishes the most abbreviated form of element markup (see SGML markup and metacharacters, chapter 1).
<em>
- emphasis
Typically this will be represented by italics if available, or emboldened or underlined text, or in plain text formats with no character highlighting available by surrounding the text with asterisks like *this*.
<var>
- metasyntactic variable
Typically this will be represented by italics, or in plain text
formats by surrounding the text with angle brackets like <this>.
If several metasyntactic variables appear one after the other they
should each be given their own <var>
element.
<prgn>
- name of a program or well-known fileIn output formats where character highlighting and various font styles are available this is usually represented by using a fixed-width font. In plain text output formats these names are not specially marked at all, as they occur frequently and introducing quoting would disrupt the flow of the text.
<tt>
- pathname, code or output fragment, command string<tt>
element rather than elements alongside it.This will usually be rendered using a fixed-width font; in plain-text formats quotes may be used around the element.
<qref id="
refid">
- quiet referenceIn formats where cross-references can be made non-intrusively by making a region of text a hyperlink without introducing in-line text this element will cause its contained text to become a hyperlink to the target of the cross-reference. In other formats this element will not have any effect.
The intra-document cross-references are based on a scheme of reference
identifiers. Each chapter, section, subsection etc. may have an
id
attribute giving its reference id - for example <chapt
id="spong">
specifies that the chapter being started has reference
id spong
. This reference id can then be referred to in other
parts of the document using the special cross-referencing elements.
The reference identifier will also be used for generating filenames and reference tokens for formats such as HTML which produce several output files; if no reference ids are specified then the chapter and section numbers will be used. It is a good idea to give at least all your chapters reference ids so that the filenames will not change if you change the order of the chapters or sections in your document.
<ref id="
refid">
- intra-document cross reference
The <ref>
element does not have any contents; the section
or chapter number and title and its page number or whatever is
appropriate for the output format will be inserted into the text at
the point where the tag appears.
Syntactically the cross reference is a noun phrase,
suitable for uses like (see <ref id="
...">)
or
further info is in <ref id="
...">.
.
<manref name="
name" section="
section">
-
manpage
name(
section)
, will be inserted
at the point where <manref>
appears.
<email>
- email address</email>
may not be omitted, but it may be
left out when it appears in an <author>
as the end of the
<author>
, implied by the start of the next element, will
imply the end of the email address.
In some formats this will generate a true cross-reference which might
(for example) be used to send email to the address quoted. In others
it will just mark the text specially, usually including angle brackets
<
>
around it.
<ftpsite>
- anonymous FTP site name<ftppath>
- path on most recently named FTP site<ftpsite>
indicates that the content of the element is the
DNS name of an anonymous FTP site, and <ftppath;em>
that it
is a pathname on that site. Both elements may not contain any
character style markup or cross-references.
Typically both elements will be rendered in a fixed with font; if
possible, the <ftppath>
will be made into a functional
hyperlink to the named file or directory on the most recent
<ftpsite>
.
<ftppath>
must always have been preceded by a
<ftpsite>
in the same chapter, but once one site has been
named several paths may be appear.
<footnote>
...</footnote>
. The text of the
footnote itself will be removed and placed elsewhere (where depends on
the format), and replaced with a reference or hyperlink to the
footnote.The contents of the footnote should be one or more paragraphs; the start of the first paragraph need not be marked explicitly. Inline markup elements such as character style do not take effect on the contents of footnotes defined inside them - the footnote gets a `clean slate'.
Footnotes may be nested, but this is rarely a good idea.