(重构建文本)reStructuredText 简明教程

Vim、Emacs配置和使用
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

(重构建文本)reStructuredText 简明教程

#1

帖子 kardinal » 2006-07-23 4:12

###############################################

!!!本贴包含附件,登录后才能看到!!!

###############################################

sudo apt-get install python-docutils 安装reStructuredText工具
rst2html xxx.rst xxx.html 将rst转换为html

简单介绍见下一贴


===============================================
带有 rst 字样的包是 源文件 ,带有 html 字样的包是 教程[/b]
附件
reStructuredTEXT.tar.gz
(27.33 KiB) 已下载 1260 次
上次由 kardinal 在 2006-07-26 14:18,总共编辑 10 次。
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#2

帖子 kardinal » 2006-07-23 4:13

reStructuredText 重构建文本,使用一些自然简单的语法规则,重新构建纯文本作为源文件,精细控制输出的格式。

语法:类似Python的语法,主要通过缩进的宽度来定义元素(具有相同缩进的行为一个段落,段落使用空行分隔)……
而不是使用复杂的符号体系来定义,像Html标签

源文件:由于没有复杂的符号体系,所以 reStrecturedText源文件可读性很强,这意味着源文件的编写更为容易

符号:符号体系进行了优化,常用到的符号都能够以直观的方式使用。例如 **特别加强** ,而不是 <b>粗体</b> <strong>加强</strong> ,或者 \textbf{粗体} 之类使源文件显得混乱的符号体系定义。

强制结构化源文件:例如标题,reStrecturedText是加下划线


标题
====


而不是 \section{标题} 之类

不但易于使用,而且使源文档保持了较高的可读性。

这种标题本身要求源文件符合结构化的规则,类似章节、段落等结构性元素,格式必须齐整[注];而不像 Html 、 Tex之类,良好的代码风格需要经验和磨练才能培养出来。

[注] 要求并不特别严格。本教程中关于元素部分的讨论最好能够熟悉,否则会遇到很多麻烦。而其它教程中似乎未发现类似的讨论。

例如下面的Html代码

代码: 全选

        <html>
            <head>
                ………………
            </head>
            <body>
                <p>……</p>
                <p>……</p>
                <p>……</p>
            </body>
        </html>
reStrecturedText的代码

代码: 全选

标题
------
  aaaaa
  aaaaa

  bb

ccccc
ccccc
  

上次由 kardinal 在 2006-07-26 14:26,总共编辑 5 次。
头像
karron
帖子: 6226
注册时间: 2005-06-11 14:03
来自: 不明真相的群众
联系:

#3

帖子 karron » 2006-07-23 7:55

楼主的文章那是想当的好阿.
我的blog,关于技术,软件,linux,vim <---- 所有博客均被河蟹.
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#4

帖子 kardinal » 2006-07-23 14:32

:lol: 参考了老兄教程中的许多部分,先斩后奏了 :oops:


老兄不要见怪 :wink:
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#5

帖子 kardinal » 2006-07-23 14:43

怎么没见有人下载教程??

第一楼有两个附件,需要登录后才能看到

:roll:
头像
millenniumdark
论坛版主
帖子: 4159
注册时间: 2005-07-02 14:41
系统: Ubuntu 14.04 (Kylin)
联系:

#6

帖子 millenniumdark » 2006-07-23 20:18

赞一个
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#7

帖子 kardinal » 2006-07-24 18:23

增加了一些内容,修正了部分链接

有时间再研究下怎么输出PDF :lol:
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#8

帖子 kardinal » 2006-07-26 4:07

麻烦版主给转到 文本编辑区 吧。。。

放在这里,本来是希望方便像我一样的菜鸟,但是大家似乎不怎么感兴趣,而且沉得又快 :shock:
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#9

帖子 kardinal » 2006-07-26 4:08

加上自己一次,总共才4次下载 :cry:
还没我上传的次数多。。。
头像
karron
帖子: 6226
注册时间: 2005-06-11 14:03
来自: 不明真相的群众
联系:

#10

帖子 karron » 2006-07-26 8:15

这个比较是需要写文档的人才会感兴趣.
无论如何,是个好帖.
我的blog,关于技术,软件,linux,vim <---- 所有博客均被河蟹.
头像
eexpress
帖子: 58428
注册时间: 2005-08-14 21:55
来自: 长沙

#11

帖子 eexpress » 2006-07-26 9:01

怎么没有点题的说明:比如什么软件,在什么情况下,如何使用。或者一个图解。让人一目了然。
● 鸣学
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#12

帖子 kardinal » 2006-07-26 14:24

已经把简单的转换步骤加上。教程里有比较详细的说明

图。。。。。。忘了咋截了 :em25 好像也不需要。。。
头像
Eric Fu
帖子: 3
注册时间: 2006-07-12 11:58

#13

帖子 Eric Fu » 2006-07-30 11:07

感觉和Wikepedia的编辑方式(语法?)很象 :)
kardinal
帖子: 750
注册时间: 2006-03-19 11:39

#14

帖子 kardinal » 2006-07-30 14:06

Wikepedia 没用过,所以不太清楚 …… 事实上reST使用了Python的语法规则,增加了一些写作需要的元素罢了 :?
zhuzhzh
帖子: 265
注册时间: 2005-07-28 15:08

#15

帖子 zhuzhzh » 2006-08-08 15:25

好贴。

楼主真是个不错的人
无声胜有声
回复