Trac 中的 reStructuredText 支持
简介
Trac 支持 reStructuredText (RST)，作为 Wiki 标记的替代方案，在 Wiki格式化 被使用的地方。
摘自 reStructuredText 网页
"reStructuredText 是一种易于阅读、所见即所得的纯文本标记语法和解析器系统。它对于行内程序文档（如 Python 文档字符串）、快速创建简单网页以及独立文档非常有用。reStructuredText 旨在为特定应用领域提供可扩展性。"
如果您希望 Subversion 存储库中的文件在 Trac 源代码浏览器中显示为 reStructuredText，请将 text/x-rst 设置为 Subversion 属性 svn:mime-type 的值，或者将扩展名 rst 添加到文件名。请参阅 此示例。
只有在安装了 docutils 的情况下，示例才会渲染为 reStructuredText。如果安装了 Pygments 但未安装 docutils，示例将进行语法高亮显示，而不是渲染为 reStructuredText。
要求
要在 Trac 中激活 RST 支持，请使用命令 easy_install docutils 安装 Python docutils 包，或者通过您的操作系统包管理器安装。如果您的操作系统尚未提供，您可以从 PyPI 下载。
更多关于 RST 的信息
在 Trac 中使用 RST
要指定文本块应使用 RST 进行解析，请使用 rst 处理器。
Trac链接 在 reStructuredText 中
- Trac 提供了一个自定义的 RST 指令
trac::，以便在 RST 文本中使用 Trac链接。
| 维基标记 | 显示 |
|---|---|
{{{#!rst
This is a reference to |a ticket|
.. |a ticket| trac:: #42
}}}
| This is a reference to |a ticket| .. |a ticket| trac:: #42 |
- 您还可以使用自定义的
:trac:角色来创建 Trac链接。
| 维基标记 | 显示 |
|---|---|
{{{#!rst
This is a reference to ticket `#12`:trac:
To learn how to use Trac, see `TracGuide`:trac:
}}}
| This is a reference to ticket `#12`:trac: To learn how to use Trac, see `TracGuide`:trac: |
有关
:trac:角色所有用法的完整示例，请参阅 Wiki重构文本链接。
reStructuredText 中的语法高亮
在 RST 中也有一个用于 Trac语法着色 的指令。该指令名为 code-block
| 维基标记 | 显示 |
|---|---|
{{{#!rst
.. code-block:: python
class Test:
def TestFunction(self):
pass
}}}
| .. code-block:: python class Test: def TestFunction(self): pass |
请注意，在 .. code-block 指令后，代码需要至少缩进一个字符。
reStructuredText 中的 Wiki 宏
要在 RST 中启用 Wiki 宏，您可以使用与语法高亮相同的 code-block 指令
| 维基标记 | 显示 |
|---|---|
{{{#!rst
.. code-block:: RecentChanges
Trac,3
}}}
| .. code-block:: RecentChanges Trac,3 |
或者使用 :code-block: 角色来获得更简洁的类似 Wiki 宏的语法
| 维基标记 | 显示 |
|---|---|
{{{
#!rst
:code-block:`RecentChanges:Trac,3`
}}}
| :code-block:`RecentChanges:Trac,3` |
大型 RST 示例
以下示例应不言自明
| 维基标记 | 显示 |
|---|---|
{{{#!rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.
A table:
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
RST TracLinks
-------------
See also ticket `#42`:trac:.
.. _webpage: http://docutils.sourceforge.net/rst.html
}}}
| FooBar Header ============= reStructuredText is **nice**. It has its own webpage_. A table: ===== ===== ====== Inputs Output ------------ ------ A B A or B ===== ===== ====== False False False True False True False True True True True True ===== ===== ====== RST TracLinks ------------- See also ticket `#42`:trac:. .. _webpage: http://docutils.sourceforge.net/rst.html |
另请参阅：Wiki重构文本链接，Wiki处理器，Wiki格式化
