トップ | バージョン2 最新版 | バージョン3 β版

初期バージョン から バージョン 1 における更新: WikiRestructuredText

差分発生行の前後
無視リスト:
更新日時:
2009/01/08 04:02:11 (15 年 前)
更新者:
trac (IP アドレス: 127.0.0.1)
コメント:

--

凡例:

変更なし
追加
削除
変更
  • WikiRestructuredText

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