Initial Version から Version 1 における更新: WikiRestructuredText

Timestamp:

Oct 30, 2008, 4:53:49 PM (17 years 前)

Author:

trac (IP: 127.0.0.1)

Comment:

--

WikiRestructuredText

@@ +1 @@
+= Trac での reStructuredText 対応 = #reStructuredTextSupportinTrac
+
+Trac は WikiFormatting を使用できるすべての箇所で、 Wiki マークアップの代わりに ''reStructuredText'' を使用することができます。
+
+reStructuredText の Web ページより:
+ "''reStructuredText は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな Web ページの素早い作成、スタンドアロンのドキュメントの記述に役立ちます。 reStructuredText は個別のアプリケーション向けに拡張ができるように設計されています。''"
+
+=== 必須条件 === #Requirements
+Trac で RST を使うためには、 Python の docutils パッケージがインストールされていなければなりません。
+あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。
+
+=== さらなる RST に関する情報 === #MoreinformationonRST
+
+ * reStructuredText  Web サイト -- http://docutils.sourceforge.net/rst.html
+ * RST クイックリファレンス -- http://docutils.sourceforge.net/docs/rst/quickref.html
+
+----
+
+== RST を Trac で使用する == #UsingRSTinTrac
+テキストブロックが RST でパースされるようにするには、 ''rst'' プロセッサを使用してください。
+
+=== reStructuredText における TracLinks === #TracLinksinreStructuredText
+
+ * Trac は RST テキストの中で TracLinks が可能になる、 RST のリファレンスディレクティブ 'trac' を提供しています。
+
+ 例:
+ {{{
+ {{{
+ #!rst
+ This is a reference to |a ticket|
+
+ .. |a ticket| trac:: #42
+ }}}
+ }}}
+
+ ''trac'' ディレクティブのすべての使用例の一覧は、 WikiRestructuredTextLinks を見てください。
+
+
+ * Trac は RST で TracLinks を簡単に作成できるように、 '':trac:'' という名前 (naming scheme) を予約しています。
+
+ 例:
+ {{{
+ {{{
+ #!rst
+ This is a reference to ticket `#12`:trac:
+
+ To learn how to use Trac, see `TracGuide`:trac:
+ }}}
+ }}}
+
+=== reStructuredText におけるシンタックスハイライト === #SyntaxhighlightinginreStructuredText
+
+同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。
+ディレクティブは code-block と呼ばれます。
+
+例
+
+{{{
+{{{
+#!rst
+
+.. code-block:: python
+
+ class Test:
+
+    def TestFunction(self):
+        pass
+
+}}}
+}}}
+
+上記の例は以下のように見えます。
+
+{{{
+#!rst
+
+.. code-block:: python
+
+ class Test:
+
+    def TestFunction(self):
+        pass
+
+}}}
+
+=== reStructuredText の中における Wiki Macros === #WikiMacrosinreStructuredText
+
+[WikiMacros Wiki マクロ] を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の
+ディレクティブを使用します。動作させるためには [http://trac.edgewall.org/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。
+
+=== Wiki Macros の例 === #WikiMacroExample
+
+{{{
+{{{
+#!rst
+
+.. code-block:: RecentChanges
+
+   Trac,3
+
+}}}
+}}}
+
+この結果は以下のようになります:
+
+     [[RecentChanges(Trac,3)]]
+
+より簡素な構文でも Wiki マクロを利用できます:
+
+{{{
+{{{
+#!rst
+
+:code-block:`RecentChanges:Trac,3`
+}}}
+}}}
+
+=== より大きい ReST の例 === #BiggerReSTExample
+この例のように書くと、とても分かりやすくなります:
+{{{
+#!html
+<pre class="wiki">{{{
+#!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
+}}}</pre>
+}}}
+
+
+結果:
+{{{
+#!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
+}}}
+
+'''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。'''
+
+----
+See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting