<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 98.2 beta6 (August 14th, 1998)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>5.2 Inline Markup</TITLE>
<META NAME="description" CONTENT="5.2 Inline Markup">
<META NAME="keywords" CONTENT="doc">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="doc.css">
<LINK REL="next" HREF="node9.html">
<LINK REL="previous" HREF="info-units.html">
<LINK REL="up" HREF="node6.html">
<LINK REL="next" HREF="node9.html">
</HEAD>
<BODY bgcolor="#ffffff">
<div class=navigation>
<table align=center width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><A HREF="node9.html"><img width=32 height=32 align=bottom border=0 alt="next"
 src="../icons/next.gif"></A></td>
<td><A HREF="node6.html"><img width=32 height=32 align=bottom border=0 alt="up"
 src="../icons/up.gif"></A></td>
<td><A HREF="info-units.html"><img width=32 height=32 align=bottom border=0 alt="previous"
 src="../icons/previous.gif"></A></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Documenting Python</b></td>
<td><A HREF="contents.html"><img width=32 height=32 align=bottom border=0 alt="contents"
 src="../icons/contents.gif"></A></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="../icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="../icons/blank.gif"></td>
</tr></table><b class=navlabel>Next:</b> <span class=sectref><A HREF="node9.html">5.3 Module-specific Markup</A></span>
<b class=navlabel>Up:</b> <span class=sectref><A HREF="node6.html">5. Special Markup Constructs</A></span>
<b class=navlabel>Previous:</b> <span class=sectref><A HREF="info-units.html">5.1 Information Units</A></span>
<br><hr></div>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION000620000000000000000">
5.2 Inline Markup</A>
</H2>

<P>

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

<P>

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

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;character</tt></b>
    <tt>{</tt><var>char</var><tt>}</tt>
<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>.
    </dl>

<P>

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

<P>

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

<P>

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

<P>

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

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;email</tt></b>
    <tt>{</tt><var>address</var><tt>}</tt>
<dd>
      An email address.  Note that this is <i>not</i> hyperlinked in
      any of the possible output formats.
    </dl>

<P>

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

<P>

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

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;file</tt></b>
    <tt>{</tt><var>file or dir</var><tt>}</tt>
<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.
    </dl>

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;filenq</tt></b>
    <tt>{</tt><var>file or dir</var><tt>}</tt>
<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.
    </dl>

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;kbd</tt></b>
    <tt>{</tt><var>key sequence</var><tt>}</tt>
<dd>
      Mark a sequence of keystrokes.  What form <var>key sequence</var>
      takes may depend on platform- or application-specific
      conventions.  For example, an <b class=program>xemacs</b> key sequence
      may be marked like <tt>&#92;kbd{C-x C-f}</tt>.
    </dl>

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;makevar</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt>
<dd>
      The name of a <b class=program>make</b> variable.
    </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>
<dd>
      A reference to a Unix manual page.
    </dl>

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;method</tt></b>
    <tt>{</tt><var>name</var><tt>}</tt>
<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.
    </dl>

<P>

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

<P>

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

<P>

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

<P>

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

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;rfc</tt></b>
    <tt>{</tt><var>number</var><tt>}</tt>
<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.
    </dl>

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;samp</tt></b>
    <tt>{</tt><var>text</var><tt>}</tt>
<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.
    </dl>

<P>

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

<P>

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

<P>

<dl class=macrodesc>
<dt><b><tt class=macro>&#92;version</tt></b>
    
<dd>
      The version number for the documentation, as specified using
      <tt class=macro>&#92;release</tt> in the preamble.
    </dl>

<P>
<p>
<div class=navigation><hr><table align=center width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><A HREF="node9.html"><img width=32 height=32 align=bottom border=0 alt="next"
 src="../icons/next.gif"></A></td>
<td><A HREF="node6.html"><img width=32 height=32 align=bottom border=0 alt="up"
 src="../icons/up.gif"></A></td>
<td><A HREF="info-units.html"><img width=32 height=32 align=bottom border=0 alt="previous"
 src="../icons/previous.gif"></A></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Documenting Python</b></td>
<td><A HREF="contents.html"><img width=32 height=32 align=bottom border=0 alt="contents"
 src="../icons/contents.gif"></A></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="../icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="../icons/blank.gif"></td>
</tr></table><b class=navlabel>Next:</b> <span class=sectref><A HREF="node9.html">5.3 Module-specific Markup</A></span>
<b class=navlabel>Up:</b> <span class=sectref><A HREF="node6.html">5. Special Markup Constructs</A></span>
<b class=navlabel>Previous:</b> <span class=sectref><A HREF="info-units.html">5.1 Information Units</A></span>
</div>
<!--End of Navigation Panel-->
<ADDRESS>
<hr>Send comments on this document to <a href="mailto:python-docs@python.org">python-docs@python.org</a>.
</ADDRESS>
</BODY>
</HTML>
