5.5 Inline Markup

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.

\bfcode {text}: Like \code, but also makes the font bold-face.

\cdata {name}: The name of a C-language variable.

\cfunction {name}: The name of a C-language function. name should include the function name and the trailing parentheses.

\character {char}: A character when discussing the character rather than a one-byte string value. The character will be typeset as with \samp.

\citetitle [url]{title}: A title for a referenced publication. If url is specified, the title will be made into a hyperlink when formatted as HTML.

\class {name}: A class name; a dotted name may be used.

\code {text}: A short code fragment or literal constant value. Typically, it should not include any spaces since no quotation marks are added.

\constant {name}: The name of a ``defined'' constant. This may be a C-language #define or a Python variable that is not intended to be changed.

\ctype {name}: The name of a C typedef or structure. For structures defined without a typedef, use \ctype{struct struct_tag} to make it clear that the struct is required.

\deprecated {version}{what to do}: Declare whatever is being described as being deprecated starting with release version. The text given as what to do should recommend something to use instead.

\dfn {term}: Mark the defining instance of term in the text. (No index entries are generated.)

\e: Produces a backslash. This is convenient in \code and similar macros, and is only defined there. To create a backslash in ordinary text (such as the contents of the \file macro), use the standard \textbackslash macro.

\email {address}: An email address. Note that this is not hyperlinked in any of the possible output formats. The domain name portion of the address should be lower case.

\emph {text}: Emphasized text; this will be presented in an italic font.

\envvar {name}: An environment variable. Index entries are generated.

\exception {name}: The name of an exception. A dotted name may be used.

\file {file or dir}: 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. Warning: The \file macro cannot be used in the content of a section title due to processing limitations.

\filenq {file or dir}: Like \file, but single quotes are never used. This can be used in conjunction with tables if a column will only contain file or directory names. Warning: The \filenq macro cannot be used in the content of a section title due to processing limitations.

\function {name}: The name of a Python function; dotted names may be used.

\kbd {key sequence}: Mark a sequence of keystrokes. What form key sequence takes may depend on platform- or application-specific conventions. For example, an xemacs key sequence may be marked like \kbd{C-x C-f}.

\keyword {name}: The name of a keyword in a programming language.

\makevar {name}: The name of a make variable.

\manpage {name}{section}: A reference to a Unix manual page.

\member {name}: The name of a data attribute of an object.

\method {name}: The name of a method of an object. name should include the method name and the trailing parentheses. A dotted name may be used.

\mimetype {name}: The name of a MIME type.

\module {name}: The name of a module; a dotted name may be used. This should also be used for package names.

\newsgroup {name}: The name of a USENET newsgroup.

\program {name}: The name of an executable program. This may differ from the file name for the executable for some platforms. In particular, the .exe (or other) extension should be omitted for DOS and Windows programs.

\programopt {option}: A command-line option to an executable program. Use this only for ``shot'' options, and include the leading hyphen.

\longprogramopt {option}: 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 option.

\pep {number}: A reference to a Python Enhancement Proposal. This generates appropriate index entries. The text "PEP number" is generated; in the HTML output, this text is a hyperlink to an online copy of the specified PEP.

\refmodule [key]{name}: Like \module, but create a hyperlink to the documentation for the named module. Note that the corresponding \declaremodule must be in the same document. If the \declaremodule defines a module key different from the module name, it must also be provided as key to the \refmodule macro.

\regexp {string}: Mark a regular expression.

\rfc {number}: A reference to an Internet Request for Comments. This generates appropriate index entries. The text "RFC number" is generated; in the HTML output, this text is a hyperlink to an online copy of the specified RFC.

\samp {text}: A short code sample, but possibly longer than would be given using \code. Since quotation marks are added, spaces are acceptable.

\shortversion: The ``short'' version number of the documented software, as specified using the \setshortversion macro in the preamble. For Python, the short version number for a release is the first three characters of the sys.version 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 \setshortversion is not used, this produces an empty expansion. See also the \version macro.

\strong {text}: Strongly emphasized text; this will be presented using a bold font.

\url {url}: 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. Note that many characters are special to L^ATEX and this macro does not always do the right thing. In particular, the tilde character ("~") is mis-handled; encoding it as a hex-sequence does work, use "%7e" in place of the tilde character.

\var {name}: The name of a variable or formal parameter in running text.

\version: The version number of the described software, as specified using \release in the preamble. See also the \shortversion macro.

\versionadded [explanation]{version}: The version of Python which added the described feature to the library or C API. explanation should be a brief explanation of the change consisting of a capitalized sentence fragment; a period will be appended by the formatting process. This is typically added to the end of the first paragraph of the description before any availability notes. The location should be selected so the explanation makes sense and may vary as needed.

\versionchanged [explanation]{version}: The version of Python in which the named feature was changed in some way (new parameters, changed side effects, etc.). explanation should be a brief explanation of the change consisting of a capitalized sentence fragment; a period will be appended by the formatting process. This is typically added to the end of the first paragraph of the description before any availability notes and after \versionadded. The location should be selected so the explanation makes sense and may vary as needed.

See About this document... for information on suggesting changes.