reStructuredText の対応
Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして reStructuredText が利用可能です。
reStructuredText の Web ページより:
"reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。"
必須条件
Trac で RST を使うためには、 Python の docutils パッケージがインストールされてなければなりません。 あなたのオペレーティングシステムでまだ使用できない場合は、 RST Website からダウンロードすることができます。
さらなる RST に関する情報
- reStructuredText Web サイト -- http://docutils.sourceforge.net/rst.html
- RST クイックリファレンス -- http://docutils.sourceforge.net/docs/rst/quickref.html
RST を Trac で使用する
テキストが RST を使用してパースされるようにするには、 rst プロセッサを使用してください。
reStructuredText における TracLinks
- Trac は RST テキストの中で TracLinks を許可するための 'trac' というカスタマイズされたRSTのリファレンスディレクティブを提供しています。
例:
{{{ #!rst This is a reference to |a ticket| .. |a ticket| trac:: #42 }}}
trac ディレクティブのすべての使用方法の一覧は、 WikiRestructuredTextLinks を見てください。
- Trac は RST において、カスタマイズされた :trac:: というリンクのための命名体系を使用することにより、簡単な方法で TracLinks を作ることを許可しています。
例:
{{{ #!rst This is a reference to ticket `#12`:trac: To learn how to use Trac, see `TracGuide`:trac: }}}
reStructuredText におけるシンタックスハイライト
同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。 ディレクティブは code-block と呼ばれます。
例
{{{
#!rst
.. code-block:: python
class Test:
def TestFunction(self):
pass
}}}
上記の例は以下のように見えます。
.. code-block:: python
class Test:
def TestFunction(self):
pass
reStructuredText の中における WikiMacros
WikiMacros を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の ディレクティブを使用します。動作させるためには #801 のパッチ適用をした Trac を使用しなければなりません。
WikiMacros の例
{{{
#!rst
.. code-block:: HelloWorld
Something I wanted to say
}}}
この結果は以下のようになります。
より大きい ReST の例
この例のように書くと、とても分かりやすくなります:
{{{
#!rst
ほげほげヘッダ
==============
reStructuredText は **素敵** 。この続きは webpage_ で。
表:
== == ======
入力 出力
------ ------
A B A or B
== == ======
偽 偽 偽
真 偽 真
偽 真 真
真 真 真
== == ======
RST での TracLinks
------------------
チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。
.. _webpage: http://docutils.sourceforge.net/rst.html
}}}
結果:
ほげほげヘッダ ============== reStructuredText は **素敵** 。この続きは webpage_ で。 表: == == ====== 入力 出力 ------ ------ A B A or B == == ====== 偽 偽 偽 真 偽 真 偽 真 真 真 真 真 == == ====== RST での TracLinks ------------------ チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 .. _webpage: http://docutils.sourceforge.net/rst.html
訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。
See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting
