用于重构文本的工具

介绍

本文档介绍了一些可用于处理RestructuredText的工具。

分为以下几部分:

  • 编辑器:为REST文档提供语法突出显示的简单文本编辑器。

  • 生成器和转换器:自动将其余文档转换为其他格式(如HTML、PDF、Doc、ODT等)的工具。

  • 集成解决方案:允许用户使用单个集成环境生成、构建和转换文档的工具。

编辑

RestructuredText文档是文本文件,可以使用任何文本编辑器或字处理器进行编辑(前提是它们始终保存为文本文件)。

JEdit

jEdit 是一个用Java编写的FOS文本编辑器(因此它运行在Windows、Mac OS X、Linux等)中。其余的语言是由jedit本地支持的211种语言之一。

This document opened in jEdit.

记事本++

Notepad++ 是用于 MS Windows操作系统 只有。

Restructuredtext不是记事本++本机识别的语言,但可以使用 `User Defined Language File`_ (请参阅可用语言文件列表下面的安装说明)。

按照链接下载 `ReST syntax file`_ .

记事本++比jedit更简单、更用户友好。

This document opened in Notepad++.

ReText

ReText 是一个简单的编辑器,它使用标记或HTML标记读取文本,并将其保存为纯文本、HTML或PDF。它是使用qt库用python编写的。

Visual Studio代码

Visual Studio Code 是一个用typescript编写的FOSS文本编辑器(因此它在Windows、Mac OS X、Linux等系统中运行)。REST不在Visual Studio代码本机支持的语言中,但可以使用 an extension from LeXtudio .

This document opened in Visual Studio Code.

建设者和转换器

待处理

关于建筑者和转换器的章节,如斯芬克斯和潘多克。

狮身人面像

Sphinx 是一个python文档生成器。

它需要 Python 在Linux和Mac OS X系统中默认安装。对于Microsoft Windows系统,请参见 在Windows上安装python 如果需要帮助安装python和两个有用的安装实用程序 (easy_installpip

在安装了python之后,只需使用以下命令(在命令窗口中)::

easy_install -U Sphinx

不需要提升权限(即管理权限)。

Sphinx Builder可以生成许多输出格式(例如HTML、PDF)。PDF文件可以使用LaTex Builder(更复杂)或使用名为rst2pdf的直接PDF Builder(见下文)生成。

RST2PDF格式

rst2pdf是使用reportlab将restructuredtext转换为pdf的工具。要在Windows上安装rst2pdf,您还需要 Python 因为rst2pdf是用python编码的。

rst2pdf使用 ReportLab ,可以使用以下方式安装:

easy_install reportlab

同样,在Windows中,所需的Microsoft Visual Studio版本可能有问题。在为包安装运行setup.py时,python 2.7会搜索已安装的Visual Studio 2008。解决方案是定义vs90comntools变量以指向Visual Studio的工具目录:

SET VS90COMNTOOLS=%VS100COMNTOOLS%

如何在Windows上安装rst2pdf?

  1. 从https://code.google.com/p/rst2pdf/downloads/list下载rst2pdf源文件

  2. 将文件解压缩到rst2pdf文件夹。

  3. 转到包含setup.py文件的rst2pdf文件夹。

  4. python setup.py install 命令,它将被安装。

  5. 要将任何.rst文件转换为pdf文件,请运行rst2pdf myfile.rst命令,然后完成。

潘多克

集成解决方案

Eclipse的REST编辑器

这个 ReST editor for Eclipse is a plug-in for the Eclipse IDE. If Sphinx is installed, it can also be used to create (and build) Sphinx projects from within Eclipse. The following presentation 记录编辑器的使用。

这个REST编辑器有几个优点,即:

  • 使用Hunspell4Eclipse的集成拼写检查

  • 上下文REST语法帮助

  • 章节大纲重排

This document opened in the Eclipse ReST Editor.