Version 2 (modified by 19 years ago) (diff) | ,
---|
reStructuredTextのサポート
TracはWikiFormatting が使われているあらゆるコンテキストの中でWikiマークアップの代わりとなるものとしてreStructuredTextの使用をサポートしています。
reStructuredTextのウェブページより:
"reStructuredTextは読みやすく、見たものを手にする、マークアップされたプレインテキストとそのパーサーシステムです。reStructuredTextはプログラムのインラインのドキュメント(例えば、Python docstrings)や簡単なウェブページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。reStructuredTextは特定のアプリケーションの分野のための拡張として設計されています。"
必須条件
TracでRSTのサポートを有効にするためには、Pythonのdocutilsパッケージがインストールされてなければなりません。 あなたのオペレーティングシステムでまだ使用できない場合は、RST Websiteからダウンロードすることができます。
さらなるRSTに関する情報
- reStructuredText ウェブサイト -- 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 }}}
上記の例は以下のように見えます。
class Test: def TestFunction(self): pass
例
以下の例はほとんど一目瞭然です:
{{{ #!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|. .. |#42| trac:: #42 .. _webpage: http://docutils.sourceforge.net/rst.html }}}
結果:
参考: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting