1 reStructuredText示例 ¶

orphan:	本文档不能通过导航到达

1.1 语法结构示例 ¶

Author:	eonwen
Address:	123 Example Street Example, EX Canada A1B 2C3
Contact:	eonwen@hotmail.com
Authors:	Me; Myself; I
organization:	humankind
date:	$Date: 2015-10-12 09:30:06 +0800 (Die, 03. Jän 2012) $
status:	工作的不错
revision:	$Revision: 7302 $
version:	1
copyright:	本文档已发布到公有域，你可以对文档做任何事，复制、修改重新发布、购买、贩卖等等，只要你愿意。
field name:	这是一个通用目录字段。
field name 2:	通用目录字段可以包含多个正文元素。像这样。
Dedication:	提供给Docutils用户和合作开发者。
abstract:	该文档是reStructuredText标记语言的示例，包含所有基础结构和很多高级结构。

内容列表

1 reStructuredText示例
- 1.1 语法结构示例
  - 1.1.1 结构化元素
    - 1.1.1.1 章节标题
    - 1.1.1.2 过渡
  - 1.1.2 正文元素
    - 1.1.2.1 段落
      - 1.1.2.1.1 行内标记
    - 1.1.2.2 无序列表
    - 1.1.2.3 有序列表
    - 1.1.2.4 定义列表
    - 1.1.2.5 字段列表
    - 1.1.2.6 选项列表
    - 1.1.2.7 文本块
    - 1.1.2.8 行块
    - 1.1.2.9 引用块
    - 1.1.2.10 测试代码块
    - 1.1.2.11 表格
    - 1.1.2.12 脚注
    - 1.1.2.13 引文
    - 1.1.2.14 目标
      - 1.1.2.14.1 链接名称重复
      - 1.1.2.14.2 链接名称重复
    - 1.1.2.15 指令
    - 1.1.2.16 替代定义
    - 1.1.2.17 注释
  - 1.1.3 错误处理

段落包含文本也可以包含行内标记: 强调, 重点强调, 行内文本, 独立超链接(http://www.python.org), 扩展超链接(Python [5]), 内部交叉引用(example), 包含嵌套的URI的扩展超链接(Python网站), 脚注引用(手动编号 [1], 匿名自动编号 [3], 标签自动编号 [2], 或符号 [*]), 引文引用([CIT2003]), 替代引用( EXAMPLE ), 及行内超链接目标 (见下面的目标反引用回这里)。也可以使用字符级行内标记(尽管很丑) reStructuredText 。问题由 |problematic| 文本展示(通过错误处理生成；这一个是故意的)。

解释文本的默认角色是标题引用。这里有一些显式解释文本角色：一个PEP引用(PEP 287); 一个RFC引用(RFC 2822); 一个 _下标; 一个 ^上标; 和为标准行内 标记 提供的显式角色。

让我们测试一下在行内文本中包装和空格的重要性: 这是一个 --行内-文本的例子，--包括某些-- 奇怪的--带有连字符的-词语。调整-你的-显示器-窗口的-宽度，以便查看这些文本是如何被包装的。-- ---- -------- 注意：句中单词之间的空格（单词必须组成一对对的）。

如果提供了 --pep-引用 选项，必须有一个可用连接到PEP 258。

1.1.2.2 无序列表 ¶

一个无序列表
- 嵌套无需列表
- 嵌套项2。
项目2.

项目2的段落2
- 嵌套无需列表
- 嵌套项2。
  - 三级
  - 项目2
- 嵌套项目3

1.1.2.3 有序列表 ¶

任意数字
1. 小写字母)
  1. (小写罗马字母)
    1. 大写字母.
      1. 大写罗马字母)
不以1开始的列表:
1. Three
2. Four
1. C
2. D
1. iii
2. iv
列表项也可以自动编号

1.1.2.4 定义列表 ¶

术语

定义

术语 : 分类器

定义第一段

定义第二段

术语

定义

1.1.2.5 字段列表 ¶

是什么:

字段列表映射字段名到字段正文，类似数据库记录。其常用语扩展语法。它们是RFC2822字段的明确变体

怎么样参数1 参数2:

字段标记是冒号、字段名、冒号

字段提可以包含一个或多个正文元素，以缩进与字段标记关联。

1.1.2.6 选项列表 ¶

用于列出命令行选项:

`-a`	命令行选项 “a”
`-b file`	选项可以有参数和长描述
`--long`	选项也可以很长
`--input=file`	长选项也可以有参数
`--very-long-option`
	描述也可以从下一行开始。描述可以包含多个正文元素，无论从那里开始
`-x, -y, -z`	多个选项是一个”选项组”.
`-v, --verbose`	通常可见: 段选项和长选项
`-1 file, --one=file, --two file`
	多个有参数的选项
`/V`	DOS/VMS风格的选项

选项与描述之间至少需要有两个空格

1.1.2.7 文本块 ¶

文本块由一个跟在段落后的双冒号(”::”)来展示（那里``–>``）。它们可以缩进:

if literal_block:
    text = 'is left as-is'
    spaces_and_linebreaks = 'are preserved'
    markup_processing = None

或可以被引用而无需缩进:

>> Great idea!
>
> Why didn't I think of that?

1.1.2.8 行块 ¶

这是一个行块。它以一个空行结束。

每个新航以一个竖线开始(“|”)。

折行和初始缩进被保留。

连续行辈超装为长行；它们以一个占据竖线位置的空格开始。

连续行的左边不需要与上面文本的左边对其。

这是第二个行块。

中间的空行是允许的，但也必须以 “|” 开头。

Take it away, Eric the Orchestra Leader!

A one, two, a one two three four

Half a bee, philosophically,

must, ipso facto, half not be.

But half the bee has got to be,

vis a vis its entity. D’you see?

But can a bee be said to be

or not to be an entire bee,

when half the bee is not a bee,

due to some ancient injury?

Singing...

1.1.2.9 引用块 ¶

引用快包含缩进的正文元素:

My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.

—Anne Elk (Miss)

1.1.2.10 测试代码块 ¶

>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)

1.1.2.11 表格 ¶

这是一个网格表格，之后是一个简单表格:

Header row, column 1 (header rows optional)	Header 2	Header 3	Header 4
body row 1, column 1	column 2	column 3	column 4
body row 2	Cells may span columns.
body row 3	Cells may span rows.	Table cells contain body elements.
body row 4	Cells may span rows.	Table cells contain body elements.
body row 5	Cells may also be empty: `-->`

Inputs		Output
A	B	A or B
False	False	False
True	False	True
False	True	True
True	True	True

1.1.2.12 脚注 ¶

[1]	(1, 2) 脚注包含正文元素、至少3个空格的统一的缩进。这是脚注的第二段。

[2]	(1, 2) 脚注可能是数字，手动编号(如 [1] )或使用”#”前缀标签自动编号这个脚注有一个标签，因此其可以指向多个位置，即作为脚注引用 ( [2] )又作为超链接引用( label )。

[3]	这个脚注自动数字编号，只使用一个匿名标签”#”。

[*]	脚注也可以使用符号，指定一个”*”标签。这是到下一个脚注的引用: [†] .

[†]	这个脚注展示序列中的下一个符号。

[4]	这是一个非引用脚注，包含一个引用到一个不存在的脚注: [5]_ 。

1.1.2.13 引文 ¶

[CIT2003]

(1, 2) 引文是文本标签的脚注。它们可以以与脚注分隔且不同的形式进行渲染。

这里是上面的引用， [CIT2003] , 和一个 [不存在] 的引文。

1.1.2.14 目标 ¶

这一段被显式的”example” target所指向。可以在上面的行内标记之下发现一个引用。行内超链接也是可以的。

章节标题为隐式目标，通过名字指向。见目标，其为正文元素的一个子章节。

显式扩展目标被插入到类似”Python [5]“的引用。

目标可以是间接和匿名的。因此这个短语也能指向目标章节。

这是一个 `没有目标的超链接引用`_ ，其会生成一个错误。

1.1.2.15.1 文档部分
1.1.2.15.2 图片
1.1.2.15.3 警告
1.1.2.15.4 主题、侧边栏和红体
1.1.2.15.5 目标脚注
1.1.2.15.6 替换文本
1.1.2.15.7 复合段落

这是一个众多reStructuredText指令中的一个的例子。其他的，详见指令

1.1.2.15.1 文档部分 ¶

“contents”指令的一个例子可以看看上面的章节(local反标题目录列表)，及文档开始的部分(全文的内容列表)。

1.1.2.15.2 图片 ¶

一个图片指令(也是可点击的 – 一个超链接引用):

一个figure指令:

figure是一个含有标题和/铭文的图片:

re	Revised, revisited, based on ‘re’ module.
Structured	Structure-enhanced text, structuredtext.
Text	Well it is, isn’t it?

这个段落也是铭文的一部分。

1.1.2.15.3 警告 ¶

注意

Directives at large.

警告

Don’t take any wooden nickels.

危险

Mad scientist at work!

错误

Does not compute.

提示

It’s bigger than a bread box.

重要

Wash behind your ears.
Clean up your room.
Call your mother.
Back up your data.

注解

This is a note.

小技巧

15% if the service is good.

警告

Strong prose may provoke extreme mental exertion. Reader discretion is strongly advised.

And, by the way...

You can make up your own admonition too.

1.1.2.15.4 主题、侧边栏和红体 ¶

主题标题

这是一个主题

这是一个红体

1.1.2.15.5 目标脚注 ¶

[5]	(1, 2, 3) http://www.python.org/

1.1.2.15.6 替换文本 ¶

建议试试 Python, 最好的语言 [5] .

1.1.2.15.7 复合段落 ¶

这个段落包含一个文本块:

Connecting... OK
Transmitting data... OK
Disconnecting... OK

且因此包含一个简单的段落、一个文本块和另一个简单的段落。尽管如此，它们是一个段落。

这个结构称为 复合段落 可以由”compound”指令生成。

下面有6个信息，自动生成章节，”Docutils System Messages”:

1 reStructuredText示例 ¶

1.1 语法结构示例 ¶

1.1.1 结构化元素 ¶

1.1.1.1 章节标题 ¶

1.1.1.2 过渡 ¶

1.1.2 正文元素 ¶

1.1.2.1 段落 ¶

1.1.2.1.1 行内标记 ¶