Changes between Initial Version and Version 1 of WikiRestructuredText

Timestamp:

06/11/06 17:57:32 (18 years ago)

Author:

trac

Comment:

--

WikiRestructuredText

@@ +1 @@
+= reStructuredText のサポート =
+
+Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' の使用をサポートしています。
+
+reStructuredText の Web ページより:
+ "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''"
+
+=== 必須条件 ===
+Trac で RST のサポートを有効にするためには、 Python の docutils パッケージがインストールされてなければなりません。
+あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html 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
+
+}}}
+}}}
+
+上記の例は以下のように見えます。
+
+{{{
+#!rst
+
+.. code-block:: python
+
+ class Test:
+
+    def TestFunction(self):
+        pass
+
+}}}
+
+=== reStructuredText の中における WikiMacros ===
+
+WikiMacros を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の
+ディレクティブを使用します。動作させるためには [http://projects.edgewall.com/trac/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。
+
+=== WikiMacros の例 ===
+
+{{{
+{{{
+#!rst
+
+.. code-block:: HelloWorld
+ 
+   Something I wanted to say
+
+
+}}}
+}}}
+
+この結果は以下のようになります。
+
+[[HelloWorld(Something I wanted to say)]]
+
+
+=== より大きい ReST の例 ===
+この例のように書くと、とても分かりやすくなります:
+{{{
+#!html
+<pre class="wiki">{{{
+#!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
+}}}</pre>
+}}}
+
+
+結果:
+{{{
+#!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
+}}}
+
+'''訳注: 日本語でテーブルを作成する場合、 docutils にパッチする必要があります。'''
+
+----
+See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting