reStructuredText解释文本角色¶
- Author
David Goodger
- Contact
- Revision
$Revision: 7307 $
- Date
$Date: 2012-01-06 12:11:51 +0100 (Fr, 06. J盲n 2012) $
- Copyright
This document has been placed in the public domain.
This document describes the interpreted text roles implemented in the reference reStructuredText parser.
Interpreted text uses backquotes (`) around the text. An explicit role marker may optionally appear before or after the text, delimited with colons. For example:
This is `interpreted text` using the default role.
This is :title:`interpreted text` using an explicit role.
A default role may be defined by applications of reStructuredText; it
is used if no explicit :role:
prefix or suffix is given. The
“default default role” is :title-reference:. It can be changed
using the default-role directive.
See the Interpreted Text section in the reStructuredText Markup Specification for syntax details. For details on the hierarchy of elements, please see The Docutils Document Tree and the Docutils Generic DTD XML document type definition. For interpreted text role implementation details, see Creating reStructuredText Interpreted Text Roles.
目录
Customization¶
Custom interpreted text roles may be defined in a document with the “role” directive. Customization details are listed with each role.
A class
option is recognized by the “role” directive for most
interpreted text roles. A description is provided in the “role”
directive documentation.
Standard Roles¶
:emphasis:
¶
- Aliases
None
- DTD Element
emphasis
- Customization
- Options
- Content
None.
Implements emphasis. These are equivalent:
*text*
:emphasis:`text`
:literal:
¶
- Aliases
None
- DTD Element
literal
- Customization
- Options
- Content
None.
Implements inline literal text. These are equivalent:
``text``
:literal:`text`
Care must be taken with backslash-escapes though. These are not equivalent:
``text \ and \ backslashes``
:literal:`text \ and \ backslashes`
The backslashes in the first line are preserved (and do nothing), whereas the backslashes in the second line escape the following spaces.
:code:
¶
- Aliases
None
- DTD Element
literal
- Customization
- Options
class, language
- Content
None.
(New in Docutils 0.9.)
The code
role marks its content as code in a formal language.
For syntax highlight of inline code, the “role” directive can be used to build custom roles with the code language specified in the “language” option.
For example, the following creates a LaTeX-specific “latex” role:
.. role:: latex(code)
:language: latex
Content of the new role is parsed and tagged by the Pygments syntax highlighter. See the code directive for more info on parsing and display of code in reStructuredText.
In addition to “class”, the following option is recognized:
language
textName of the code’s language. See supported languages and markup formats for recognized values.
:math:
¶
- Aliases
None
- DTD Element
math
- Customization
- Options
- Content
None.
(New in Docutils 0.8.)
The math
role marks its content as mathematical notation (inline
formula).
The input format is LaTeX math syntax without the 鈥渕ath delimiters鈥�
($ $
), for example:
The area of a circle is :math:`A_\text{c} = (\pi/4) d^2`.
See the math directive (producing display formulas) for more info on mathematical notation in reStructuredText.
:pep-reference:
¶
- Aliases
:PEP:
- DTD Element
reference
- Customization
- Options
- Content
None.
The :pep-reference:
role is used to create an HTTP reference to a
PEP (Python Enhancement Proposal). The :PEP:
alias is usually
used. For example:
See :PEP:`287` for more information about reStructuredText.
This is equivalent to:
See `PEP 287`__ for more information about reStructuredText.
__ http://www.python.org/peps/pep-0287.html
:rfc-reference:
¶
- Aliases
:RFC:
- DTD Element
reference
- Customization
- Options
- Content
None.
The :rfc-reference:
role is used to create an HTTP reference to an
RFC (Internet Request for Comments). The :RFC:
alias is usually
used. For example:
See :RFC:`2822` for information about email headers.
This is equivalent to:
See `RFC 2822`__ for information about email headers.
__ http://www.faqs.org/rfcs/rfc2822.html
:strong:
¶
- Aliases
None
- DTD Element
strong
- Customization
- Options
- Content
None.
Implements strong emphasis. These are equivalent:
**text**
:strong:`text`
:subscript:
¶
- Aliases
:sub:
- DTD Element
subscript
- Customization
- Options
- Content
None.
Implements subscripts.
小技巧
Whitespace or punctuation is required around interpreted text, but often not desired with subscripts & superscripts. Backslash-escaped whitespace can be used; the whitespace will be removed from the processed document:
H\ :sub:`2`\ O
E = mc\ :sup:`2`
In such cases, readability of the plain text can be greatly improved with substitutions:
The chemical formula for pure water is |H2O|.
.. |H2O| replace:: H\ :sub:`2`\ O
See the reStructuredText spec for further information on character-level markup and the substitution mechanism.
:superscript:
¶
- Aliases
:sup:
- DTD Element
superscript
- Customization
- Options
- Content
None.
Implements superscripts. See the tip in :subscript: above.
:title-reference:
¶
- Aliases
:title:
,:t:
.- DTD Element
title_reference
- Customization
- Options
- Content
None.
The :title-reference:
role is used to describe the titles of
books, periodicals, and other materials. It is the equivalent of the
HTML “cite” element, and it is expected that HTML writers will
typically render “title_reference” elements using “cite”.
Since title references are typically rendered with italics, they are
often marked up using *emphasis*
, which is misleading and vague.
The “title_reference” element provides accurate and unambiguous
descriptive markup.
Let’s assume :title-reference:
is the default interpreted text
role (see below) for this example:
`Design Patterns` [GoF95]_ is an excellent read.
The following document fragment (pseudo-XML) will result from processing:
<paragraph>
<title_reference>
Design Patterns
<citation_reference refname="gof95">
GoF95
is an excellent read.
:title-reference:
is the default interpreted text role in the
standard reStructuredText parser. This means that no explicit role is
required. Applications of reStructuredText may designate a different
default role, in which case the explicit :title-reference:
role
must be used to obtain a title_reference
element.
Specialized Roles¶
raw
¶
- Aliases
None
- DTD Element
raw
- Customization
- Options
class, format
- Content
None
警告
The “raw” role is a stop-gap measure allowing the author to bypass reStructuredText’s markup. It is a “power-user” feature that should not be overused or abused. The use of “raw” ties documents to specific output formats and makes them less portable.
If you often need to use “raw”-derived interpreted text roles or the “raw” directive, that is a sign either of overuse/abuse or that functionality may be missing from reStructuredText. Please describe your situation in a message to the Docutils-users mailing list.
The “raw” role indicates non-reStructuredText data that is to be passed untouched to the Writer. It is the inline equivalent of the “raw” directive; see its documentation for details on the semantics.
The “raw” role cannot be used directly. The “role” directive must first be used to build custom roles based on the “raw” role. One or more formats (Writer names) must be provided in a “format” option.
For example, the following creates an HTML-specific “raw-html” role:
.. role:: raw-html(raw)
:format: html
This role can now be used directly to pass data untouched to the HTML Writer. For example:
If there just *has* to be a line break here,
:raw-html:`<br />`
it can be accomplished with a "raw"-derived role.
But the line block syntax should be considered first.
小技巧
Roles based on “raw” should clearly indicate their origin, so they are not mistaken for reStructuredText markup. Using a “raw-” prefix for role names is recommended.
In addition to “class”, the following option is recognized:
format
textOne or more space-separated output format names (Writer names).