バージョン 1 から バージョン 2 における更新: WikiRestructuredText
- 更新日時:
- 2010/01/20 13:35:08 (15 年 前)
凡例:
- 変更なし
- 追加
- 削除
- 変更
-
WikiRestructuredText
v1 v2 1 = reStructuredText の対応 =1 = Trac での reStructuredText 対応 = #reStructuredTextSupportinTrac 2 2 3 Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' が利用可能です。3 Trac は WikiFormatting を使用できるすべての箇所で、 Wiki マークアップの代わりに ''reStructuredText'' を使用することができます。 4 4 5 5 reStructuredText の Web ページより: 6 "''reStructuredText は読みやすく、 見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''"6 "''reStructuredText は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな Web ページの素早い作成、スタンドアロンのドキュメントの記述に役立ちます。 reStructuredText は個別のアプリケーション向けに拡張ができるように設計されています。''" 7 7 8 === 必須条件 === 9 Trac で RST を使うためには、 Python の docutils パッケージがインストールされて なければなりません。8 === 必須条件 === #Requirements 9 Trac で RST を使うためには、 Python の docutils パッケージがインストールされていなければなりません。 10 10 あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。 11 11 12 === さらなる RST に関する情報 === 12 docutils のインストールには `easy_install docutils` を使用してください。 Trac が docutils パッケージを探すことが出来ない可能性があるので、 (`apt-get install python-docutils` などの) OS のパッケージマネージャは使わないでください。 13 ('''訳注:''' docutils が提供している `setup.py` では `setuptools` を使用していないため、 OS のパッケージでは `docutils-*.egg-info` が作成されない場合があることを指しています。 egg-info さえ作成されていれば OS のパッケージマネージャを使用しても問題ないと思われます。) 14 15 === さらなる RST に関する情報 === #MoreinformationonRST 13 16 14 17 * reStructuredText Web サイト -- http://docutils.sourceforge.net/rst.html … … 17 20 ---- 18 21 19 == RST を Trac で使用する == 20 テキスト が RST を使用してパースされるようにするには、 ''rst'' プロセッサを使用してください。22 == RST を Trac で使用する == #UsingRSTinTrac 23 テキストブロックが RST でパースされるようにするには、 ''rst'' プロセッサを使用してください。 21 24 22 === reStructuredText における TracLinks === 25 === reStructuredText における TracLinks === #TracLinksinreStructuredText 23 26 24 * Trac は RST テキストの中で TracLinks を許可するための 'trac' というカスタマイズされたRSTのリファレンスディレクティブを提供しています。27 * Trac は RST テキストの中で TracLinks が可能になる、 RST のディレクティブ 'trac' を提供しています。 25 28 26 29 例: … … 34 37 }}} 35 38 36 ''trac'' ディレクティブのすべての使用方法の一覧は、 WikiRestructuredTextLinks を見てください。 37 38 39 * Trac は RST において、カスタマイズされた '':trac::'' というリンクのための命名体系を使用することにより、簡単な方法で TracLinks を作ることを許可しています。 39 * Trac は RST で TracLinks を簡単に作成できるように、 `:trac:` というロールを予約しています。 40 40 41 41 例: … … 49 49 }}} 50 50 51 === reStructuredText におけるシンタックスハイライト === 51 `:trac:` ロールのすべての使用例の一覧は、 WikiRestructuredTextLinks を見てください。 52 53 54 === reStructuredText におけるシンタックスハイライト === #SyntaxhighlightinginreStructuredText 52 55 53 56 同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。 … … 84 87 }}} 85 88 86 === reStructuredText の中における Wiki Macros ===89 === reStructuredText の中における Wiki Macros === #WikiMacrosinreStructuredText 87 90 88 WikiMacros を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の 89 ディレクティブを使用します。動作させるためには [http://trac.edgewall.org/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。91 [WikiMacros Wiki マクロ] を RST の中で使用するには、 code-block のようなシンタックスハイライトと同様のディレクティブを使用します。 92 動作させるためには [http://trac.edgewall.org/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。 90 93 91 === Wiki Macros の例 ===94 === Wiki Macros の例 === #WikiMacroExample 92 95 93 96 {{{ … … 95 98 #!rst 96 99 97 .. code-block:: HelloWorld 98 99 Something I wanted to say 100 .. code-block:: RecentChanges 100 101 102 Trac,3 101 103 102 104 }}} 103 105 }}} 104 106 105 この結果は以下のようになります 。107 この結果は以下のようになります: 106 108 107 [[HelloWorld(Something I wanted to say)]]109 [[RecentChanges(Trac,3)]] 108 110 111 より簡素な構文でも Wiki マクロを利用できます: 109 112 110 === より大きい ReST の例 === 113 {{{ 114 {{{ 115 #!rst 116 117 :code-block:`RecentChanges:Trac,3` 118 }}} 119 }}} 120 121 === より大きい RST の例 === #BiggerRSTExample 111 122 この例のように書くと、とても分かりやすくなります: 112 123 {{{
