[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / doc / inline-markup.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="doc.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="doc.html" title='Documenting Python' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="misc-text-markup.html" />
<link rel="prev" href="showing-examples.html" />
<link rel="parent" href="special-constructs.html" />
<link rel="next" href="misc-text-markup.html" />
<meta name='aesop' content='information' />
<title>6.5 Inline Markup </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.4 Showing Code Examples"
  href="showing-examples.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs"
  href="special-constructs.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.6 Miscellaneous Text Markup"
  href="misc-text-markup.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="showing-examples.html">6.4 Showing Code Examples</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="misc-text-markup.html">6.6 Miscellaneous Text Markup</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION000750000000000000000"></A><A NAME="inline-markup"></A>
<BR>
6.5 Inline Markup 
</H2>

<P>
The macros described in this section are used to mark just about
    anything interesting in the document text.  They may be used in
    headings (though anything involving hyperlinks should be avoided
    there) as well as in the body text.

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;bfcode</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      Like <tt class='macro'>&#92;code</tt>, but also makes the font bold-face.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;cdata</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a C-language variable.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;cfunction</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a C-language function.  <var>name</var> should include the
      function name and the trailing parentheses.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;character</tt></b>
    <tt>{</tt><var>char</var><tt>}</tt></dt>
<dd>
      A character when discussing the character rather than a one-byte
      string value.  The character will be typeset as with <tt class='macro'>&#92;samp</tt>.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;citetitle</tt></b>
    <tt>[</tt><var>url</var><tt>]</tt><tt>{</tt><var>title</var><tt>}</tt></dt>
<dd>
      A title for a referenced publication.  If <var>url</var> is specified,
      the title will be made into a hyperlink when formatted as HTML.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;class</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      A class name; a dotted name may be used.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;code</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      A short code fragment or literal constant value.  Typically, it
      should not include any spaces since no quotation marks are
      added.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;constant</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a ``defined'' constant.  This may be a C-language
      <code>#define</code> or a Python variable that is not intended to be
      changed.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;csimplemacro</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a ``simple'' macro.  Simple macros are macros
      which are used for code expansion, but which do not take
      arguments so cannot be described as functions.  This is not to
      be used for simple constant definitions.  Examples of it's use
      in the Python documentation include
      PyObject_HEAD and
      Py_BEGIN_ALLOW_THREADS.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;ctype</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a C <tt class="keyword">typedef</tt> or structure.  For structures
      defined without a <tt class="keyword">typedef</tt>, use <code>&#92;ctype{struct
      struct_tag}</code> to make it clear that the <tt class="keyword">struct</tt> is
      required.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;deprecated</tt></b>
    <tt>{</tt><var>version</var><tt>}</tt><tt>{</tt><var>what to do</var><tt>}</tt></dt>
<dd>
      Declare whatever is being described as being deprecated starting
      with release <var>version</var>.  The text given as <var>what to do</var>
      should recommend something to use instead.  It should be
      complete sentences.  The entire deprecation notice will be
      presented as a separate paragraph; it should either precede or
      succeed the description of the deprecated feature.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;dfn</tt></b>
    <tt>{</tt><var>term</var><tt>}</tt></dt>
<dd>
      Mark the defining instance of <var>term</var> in the text.  (No index
      entries are generated.)
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;e</tt></b>
    </dt>
<dd>
      Produces a backslash.  This is convenient in <tt class='macro'>&#92;code</tt>,
      <tt class='macro'>&#92;file</tt>, and similar macros, and the <tt class='environment'>&#92;alltt</tt>
      environment, and is only defined there.  To
      create a backslash in ordinary text (such as the contents of the
      <tt class='macro'>&#92;citetitle</tt> macro), use the standard <tt class='macro'>&#92;textbackslash</tt>
      macro.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;email</tt></b>
    <tt>{</tt><var>address</var><tt>}</tt></dt>
<dd>
      An email address.  Note that this is <em>not</em> hyperlinked in
      any of the possible output formats.  The domain name portion of
      the address should be lower case.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;emph</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      Emphasized text; this will be presented in an italic font.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;envvar</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      An environment variable.  Index entries are generated.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;exception</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of an exception.  A dotted name may be used.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;file</tt></b>
    <tt>{</tt><var>file or dir</var><tt>}</tt></dt>
<dd>
      The name of a file or directory.  In the PDF and PostScript
      outputs, single quotes and a font change are used to indicate
      the file name, but no quotes are used in the HTML output.
      <span class="warning"><b class="label">Warning:</b>
The <tt class='macro'>&#92;file</tt> macro cannot be used in the
      content of a section title due to processing limitations.</span>
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;filenq</tt></b>
    <tt>{</tt><var>file or dir</var><tt>}</tt></dt>
<dd>
      Like <tt class='macro'>&#92;file</tt>, but single quotes are never used.  This can
      be used in conjunction with tables if a column will only contain
      file or directory names.
      <span class="warning"><b class="label">Warning:</b>
The <tt class='macro'>&#92;filenq</tt> macro cannot be used in the
      content of a section title due to processing limitations.</span>
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;function</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a Python function; dotted names may be used.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;infinity</tt></b>
    </dt>
<dd>
      The symbol for mathematical infinity: &infin;.  Some Web
      browsers are not able to render the HTML representation of this
      symbol properly, but support is growing.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;kbd</tt></b>
    <tt>{</tt><var>key sequence</var><tt>}</tt></dt>
<dd>
      Mark a sequence of keystrokes.  What form <var>key sequence</var>
      takes may depend on platform- or application-specific
      conventions.  When there are no relevant conventions, the names
      of modifier keys should be spelled out, to improve accessibility
      for new users and non-native speakers.  For example, an
      <b class="program">xemacs</b> key sequence may be marked like
      <code>&#92;kbd{C-x C-f}</code>, but without reference to a specific
      application or platform, the same sequence should be marked as
      <code>&#92;kbd{Control-x Control-f}</code>.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;keyword</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a keyword in a programming language.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;mailheader</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of an <a class="rfc" id='rfcref-2637' xml:id='rfcref-2637'
href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a>-style mail header.  This markup does
      not imply that the header is being used in an email message, but
      can be used to refer to any header of the same ``style.''  This
      is also used for headers defined by the various MIME
      specifications.  The header name should be entered in the same
      way it would normally be found in practice, with the
      camel-casing conventions being preferred where there is more
      than one common usage.  The colon which follows the name of the
      header should not be included.
      For example: <code>&#92;mailheader{Content-Type}</code>.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;makevar</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a <b class="program">make</b> variable.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;manpage</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt><tt>{</tt><var>section</var><tt>}</tt></dt>
<dd>
      A reference to a <span class="Unix">Unix</span> manual page.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;member</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a data attribute of an object.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;method</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a method of an object.  <var>name</var> should include the
      method name and the trailing parentheses.  A dotted name may be
      used.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;mimetype</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a MIME type, or a component of a MIME type (the
      major or minor portion, taken alone).
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;module</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
       The name of a module; a dotted name may be used.  This should
       also be used for package names.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;newsgroup</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a Usenet newsgroup.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;note</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      An especially important bit of information about an API that a
      user should be aware of when using whatever bit of API the
      note pertains to.  This should be the last thing in the
      paragraph as the end of the note is not visually marked in
      any way.  The content of <var>text</var> should be written in
      complete sentences and include all appropriate punctuation.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;pep</tt></b>
    <tt>{</tt><var>number</var><tt>}</tt></dt>
<dd>
      A reference to a Python Enhancement Proposal.  This generates
      appropriate index entries.  The text "<tt class="samp">PEP <var>number</var></tt>" is
      generated; in the HTML output, this text is a hyperlink to an
      online copy of the specified PEP.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;plusminus</tt></b>
    </dt>
<dd>
      The symbol for indicating a value that may take a positive or
      negative value of a specified magnitude, typically represented
      by a plus sign placed over a minus sign.  For example:
      <code>&#92;plusminus 3%</code>.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;program</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of an executable program.  This may differ from the
      file name for the executable for some platforms.  In particular,
      the <span class="file">.exe</span> (or other) extension should be omitted for
      Windows programs.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;programopt</tt></b>
    <tt>{</tt><var>option</var><tt>}</tt></dt>
<dd>
      A command-line option to an executable program.  Use this only
      for ``short'' options, and include the leading hyphen.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;longprogramopt</tt></b>
    <tt>{</tt><var>option</var><tt>}</tt></dt>
<dd>
      A long command-line option to an executable program.  This
      should only be used for long option names which will be prefixed
      by two hyphens; the hyphens should not be provided as part of
      <var>option</var>.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;refmodule</tt></b>
    <tt>[</tt><var>key</var><tt>]</tt><tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      Like <tt class='macro'>&#92;module</tt>, but create a hyperlink to the documentation
      for the named module.  Note that the corresponding
      <tt class='macro'>&#92;declaremodule</tt> must be in the same document.  If the
      <tt class='macro'>&#92;declaremodule</tt> defines a module key different from the
      module name, it must also be provided as <var>key</var> to the
      <tt class='macro'>&#92;refmodule</tt> macro.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;regexp</tt></b>
    <tt>{</tt><var>string</var><tt>}</tt></dt>
<dd>
      Mark a regular expression.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;rfc</tt></b>
    <tt>{</tt><var>number</var><tt>}</tt></dt>
<dd>
      A reference to an Internet Request for Comments.  This generates
      appropriate index entries.  The text "<tt class="samp">RFC <var>number</var></tt>" is
      generated; in the HTML output, this text is a hyperlink to an
      online copy of the specified RFC.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;samp</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      A short code sample, but possibly longer than would be given
      using <tt class='macro'>&#92;code</tt>.  Since quotation marks are added, spaces are
      acceptable.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;shortversion</tt></b>
    </dt>
<dd>
      The ``short'' version number of the documented software, as
      specified using the <tt class='macro'>&#92;setshortversion</tt> macro in the
      preamble.  For Python, the short version number for a release is
      the first three characters of the <code>sys.version</code> value.  For
      example, versions 2.0b1 and 2.0.1 both have a short version of
      2.0.  This may not apply for all packages; if
      <tt class='macro'>&#92;setshortversion</tt> is not used, this produces an empty
      expansion.  See also the <tt class='macro'>&#92;version</tt> macro.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;strong</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      Strongly emphasized text; this will be presented using a bold
      font.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;ulink</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt><tt>{</tt><var>url</var><tt>}</tt></dt>
<dd>
      A hypertext link with a target specified by a URL, but for which
      the link text should not be the title of the resource.  For
      resources being referenced by name, use the <tt class='macro'>&#92;citetitle</tt>
      macro.  Not all formatted versions support arbitrary hypertext
      links.  Note that many characters are special to <span class="LaTeX">LaTeX</span> and
      this macro does not always do the right thing.  In particular,
      the tilde character ("<tt class="character">~</tt>") is mis-handled; encoding it
      as a hex-sequence does work, use "<tt class="samp">%7e</tt>" in place of the
      tilde character.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;url</tt></b>
    <tt>{</tt><var>url</var><tt>}</tt></dt>
<dd>
      A URL (or URN).  The URL will be presented as text.  In the HTML
      and PDF formatted versions, the URL will also be a hyperlink.
      This can be used when referring to external resources without
      specific titles; references to resources which have titles
      should be marked using the <tt class='macro'>&#92;citetitle</tt> macro.  See the
      comments about special characters in the description of the
      <tt class='macro'>&#92;ulink</tt> macro for special considerations.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;var</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt></dt>
<dd>
      The name of a variable or formal parameter in running text.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;version</tt></b>
    </dt>
<dd>
      The version number of the described software, as specified using
      <tt class='macro'>&#92;release</tt> in the preamble.  See also the
      <tt class='macro'>&#92;shortversion</tt> macro.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;warning</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt></dt>
<dd>
      An important bit of information about an API that a user should
      be very aware of when using whatever bit of API the warning
      pertains to.  This should be the last thing in the paragraph as
      the end of the warning is not visually marked in any way.  The
      content of <var>text</var> should be written in complete sentences
      and include all appropriate punctuation.  This differs from
      <tt class='macro'>&#92;note</tt> in that it is recommended over <tt class='macro'>&#92;note</tt> for
      information regarding security.
    </dd></dl>

<P>
The following two macros are used to describe information that's
    associated with changes from one release to another.  For features
    which are described by a single paragraph, these are typically
    added as separate source lines at the end of the paragraph.  When
    adding these to features described by multiple paragraphs, they
    are usually collected in a single separate paragraph after the
    description.  When both <tt class='macro'>&#92;versionadded</tt> and
    <tt class='macro'>&#92;versionchanged</tt> are used, <tt class='macro'>&#92;versionadded</tt> should come
    first; the versions should be listed in chronological order.  Both
    of these should come before availability statements.  The location
    should be selected so the explanation makes sense and may vary as
    needed.

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;versionadded</tt></b>
    <tt>[</tt><var>explanation</var><tt>]</tt><tt>{</tt><var>version</var><tt>}</tt></dt>
<dd>
      The version of Python which added the described feature to the
      library or C API.  <var>explanation</var> should be a <em>brief</em>
      explanation of the change consisting of a capitalized sentence
      fragment; a period will be appended by the formatting process.
      When this applies to an entire module, it should be placed at
      the top of the module section before any prose.
    </dd></dl>

<P>

<dl class='macrodesc'>
<dt><b><tt class='macro'>&#92;versionchanged</tt></b>
    <tt>[</tt><var>explanation</var><tt>]</tt><tt>{</tt><var>version</var><tt>}</tt></dt>
<dd>
      The version of Python in which the named feature was changed in
      some way (new parameters, changed side effects, etc.).
      <var>explanation</var> should be a <em>brief</em> explanation of the
      change consisting of a capitalized sentence fragment; a
      period will be appended by the formatting process.  This should
      not generally be applied to modules.
    </dd></dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.4 Showing Code Examples"
  href="showing-examples.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs"
  href="special-constructs.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.6 Miscellaneous Text Markup"
  href="misc-text-markup.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="showing-examples.html">6.4 Showing Code Examples</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="misc-text-markup.html">6.6 Miscellaneous Text Markup</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>