WikiRestructuredText: バージョン 1 における更新

差分発生行の前後
無視リスト:
更新者:
trac (IPアドレス: 127.0.0.1)
更新日時:
2006/11/22 18:14:01 (18 年前)
コメント:

--

凡例:

変更無し
追加
削除
更新

  • WikiRestructuredText

    v0 v1  
     1= reStructuredText の対応 = 
     2 
     3Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' が利用可能です。 
     4 
     5reStructuredText の Web ページより: 
     6 "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''" 
     7 
     8=== 必須条件 === 
     9Trac で RST を使うためには、 Python の docutils パッケージがインストールされてなければなりません。 
     10あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。 
     11 
     12=== さらなる RST に関する情報 === 
     13 
     14 * reStructuredText  Web サイト -- http://docutils.sourceforge.net/rst.html 
     15 * RST クイックリファレンス -- http://docutils.sourceforge.net/docs/rst/quickref.html 
     16 
     17---- 
     18 
     19== RST を Trac で使用する == 
     20テキストが RST を使用してパースされるようにするには、 ''rst'' プロセッサを使用してください。 
     21 
     22=== reStructuredText における TracLinks === 
     23 
     24 * Trac は RST テキストの中で TracLinks を許可するための 'trac' というカスタマイズされたRSTのリファレンスディレクティブを提供しています。 
     25 
     26 例: 
     27 {{{ 
     28 {{{ 
     29 #!rst 
     30 This is a reference to |a ticket| 
     31 
     32 .. |a ticket| trac:: #42 
     33 }}} 
     34 }}} 
     35 
     36 ''trac'' ディレクティブのすべての使用方法の一覧は、 WikiRestructuredTextLinks を見てください。 
     37 
     38 
     39 * Trac は RST において、カスタマイズされた '':trac::'' というリンクのための命名体系を使用することにより、簡単な方法で TracLinks を作ることを許可しています。 
     40 
     41 例: 
     42 {{{ 
     43 {{{ 
     44 #!rst 
     45 This is a reference to ticket `#12`:trac: 
     46 
     47 To learn how to use Trac, see `TracGuide`:trac: 
     48 }}} 
     49 }}} 
     50 
     51=== reStructuredText におけるシンタックスハイライト === 
     52 
     53同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。 
     54ディレクティブは code-block と呼ばれます。 
     55 
     56例 
     57 
     58{{{ 
     59{{{ 
     60#!rst 
     61 
     62.. code-block:: python 
     63 
     64 class Test: 
     65 
     66    def TestFunction(self): 
     67        pass 
     68 
     69}}} 
     70}}} 
     71 
     72上記の例は以下のように見えます。 
     73 
     74{{{ 
     75#!rst 
     76 
     77.. code-block:: python 
     78 
     79 class Test: 
     80 
     81    def TestFunction(self): 
     82        pass 
     83 
     84}}} 
     85 
     86=== reStructuredText の中における WikiMacros === 
     87 
     88WikiMacros を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の 
     89ディレクティブを使用します。動作させるためには [http://trac.edgewall.org/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。 
     90 
     91=== WikiMacros の例 === 
     92 
     93{{{ 
     94{{{ 
     95#!rst 
     96 
     97.. code-block:: HelloWorld 
     98  
     99   Something I wanted to say 
     100 
     101 
     102}}} 
     103}}} 
     104 
     105この結果は以下のようになります。 
     106 
     107[[HelloWorld(Something I wanted to say)]] 
     108 
     109 
     110=== より大きい ReST の例 === 
     111この例のように書くと、とても分かりやすくなります: 
     112{{{ 
     113#!html 
     114<pre class="wiki">{{{ 
     115#!rst 
     116ほげほげヘッダ 
     117============== 
     118reStructuredText は **素敵** 。この続きは webpage_ で。 
     119 
     120表: 
     121 
     122==  ==  ====== 
     123 入力    出力 
     124------  ------ 
     125A   B   A or B 
     126==  ==  ====== 
     127偽  偽    偽 
     128真  偽    真 
     129偽  真    真 
     130真  真    真 
     131==  ==  ====== 
     132 
     133RST での TracLinks 
     134------------------ 
     135 
     136チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 
     137 
     138.. _webpage: http://docutils.sourceforge.net/rst.html 
     139}}}</pre> 
     140}}} 
     141 
     142 
     143結果: 
     144{{{ 
     145#!rst 
     146ほげほげヘッダ 
     147============== 
     148reStructuredText は **素敵** 。この続きは webpage_ で。 
     149 
     150表: 
     151 
     152==  ==  ====== 
     153 入力    出力 
     154------  ------ 
     155A   B   A or B 
     156==  ==  ====== 
     157偽  偽    偽 
     158真  偽    真 
     159偽  真    真 
     160真  真    真 
     161==  ==  ====== 
     162 
     163RST での TracLinks 
     164------------------ 
     165 
     166チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 
     167 
     168.. _webpage: http://docutils.sourceforge.net/rst.html 
     169}}} 
     170 
     171'''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。''' 
     172 
     173---- 
     174See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting 
track feed