RestStructedText 实例练习篇

发布于: 2012年5月5日

标签：RestructedText, rst

RestStructedText 实例练习篇

Author:	Falcon Chen
Contact:	falcon_chen@qq.com
Date:	$Date$
Copyright:	public

Contents

Tip

一个非常好的在线练习工具

匿名链接

这是匿名链接,然后这个是按名称链接,链接与目标之间有空行。**前后有空格,特别注意`前面也要有空格。

列表

有序列表

一级项目1
1. 缩进的二级项目1 1. 三级项目1(貌似无效) 2. 三级项目2 3. 三级项目3
2. 缩进的二级项目2
一级项目2
一级项目3

无序列表

无序项目一级1
- 无序项目二级1
- 无序项目二级2
  
  +无序项目3
无序项目一级2

定义

(definition)

什么

定义是描述一个事物的专用术语

如何

如何是这样那样

哈哈。。。

预格式化

(prefomatting)

例子开始:

特殊字符
如(**这里**)或者不被转义
注意例子开始与结束的:: 号，空行还有相同的缩进

例子结束

图像

(images)

特殊指令

指令类型:	“attention”,”caution”,”danger”,”error”,”hint”,”important”,”note”,”tip”,”warning”,”admonition”
example 1:

!DANGER!

Don’t Do this!

example 2:	(缩进的部分会作为子部分加入段落)

Note

这是note指令

第一个段落的第二行，注意缩进和空行

列表项目1

仍然是列表的内容，使用缩进
列表项目2

指令元素:	attention, caution, danger, error, hint, important, note, tip, warning,title
指令选项:	:class: , :name:
指令内容:	会当作主体(body)元素解析

figure

figure包含image的数据，包括 image options 和可选的标题(caption)

Note

figure与image有区别的，figure是包括了标题的，在解析为html时,figure的image元素会被div所包裹。如

.. figure:: picture.png
 :scale: 50 %
 :alt: map to buried treasure

.. image:: picture.png
 :scale: 50 %
 :alt: map to buried treasure

html解析:

<div class="figure">
<img alt="map to buried treasure" src="picture.png" />
</div>
<img alt="map to buried treasure" src="picture.png" />

Body元素

topic

这是话题标题

此为内容

仍然是内容，下一段落

Note

:class和:name属性不可用？

Line Block(行内块)

原生解析，

God Bless You!

Parsed Literal Block(块原生解析)

这个不做实际解析了，用法如下:

.. parsed-literal::

   ( (title_, subtitle_?)?,
     decoration_?,
     (docinfo_, transition_?)?,
     `%structure.model;`_ )

Code (Docutils 0.9新增,使用了 Pygments 做语法高亮)

用法如下:

.. code:: python

 def my_function():
     "just a test"
     print 8/2

Epigraph

再见青春，再见美丽的疼痛。

——《汪峰-再见青春》

Compound

The ‘rm’ command is very dangerous. If you are logged in as root and enter

cd /
rm -rf *

you will erase the entire contents of your file system.

Table

Caution!

请务必使用等宽字体进行表格的编写，不然你就会遇到跟我一样的各种莫名其妙的坑爹事！

推荐字体：Lucida Console ,文泉驿等宽微米黑(下载) 虽然也是等宽，但是在中文下也有视觉错误

test:

测试中文
测试一下表格的中文

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.

姓名	年龄
陈小明	27

姓名	年龄
张三丰	18

简单表:

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

CSV Table

待续

保留换行符

保留换行符测试，行一
行二
再来一行

脚注 Footnotes

使用 [#name]_ 来标记位置, 并在文章底部 “Footnotes” 专栏之后追加脚注内容,如下使用:

这是 [1] ，这是 [2]

脚注参考，用了rubric标记

[1]

这是脚本1的参考

[2]

这是脚本2的参考

也可以使用确切编号的脚注 (如: [1]_) 或是自动编号(用 [#]_).

这是脚本 [3] ，这是第二个 [4]

但是要注意的是 [#x]_ 后面是有空格或者换行符的 [5] ,`也是一样，不能忽略后面的空格

脚注参考，用了rubric标记

[3] 这是脚本1的参考

[4] 这是脚本2的参考

[5] 注意上文

用数字的例子即 [#数字]_,不要忘记前后空格

这里使用数字 [6]

这里使用另一个数字 [7]

数字脚注

[6] 11号脚注

[7] 12号脚注