Changes between Version 2 and Version 3 of WikiRestructuredText


Ignore:
Timestamp:
Oct 1, 2012 9:35:34 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v2 v3  
    1 = Trac での reStructuredText 対応 = #reStructuredTextSupportinTrac 
    2  
    3 Trac は WikiFormatting を使用できるすべての箇所で、 Wiki マークアップの代わりに ''reStructuredText'' を使用することができます。 
    4  
    5 reStructuredText の Web ページより: 
    6  "''reStructuredText は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな Web ページの素早い作成、スタンドアロンのドキュメントの記述に役立ちます。 reStructuredText は個別のアプリケーション向けに拡張ができるように設計されています。''" 
    7  
    8 Subversion リポジトリのファイルを reStructuredText として Trac のソースブラウザに表示したい場合、 Subversion の `svn:mime-type` 属性に `text/x-rst` を設定してください。 [http://trac.edgewall.org/browser/trunk/INSTALL この例] が参考になります。 
    9  
    10 === 必須条件 === #Requirements 
    11 Trac で RST を使うためには、 Python の docutils パッケージがインストールされていなければなりません。 
    12 あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。 
    13  
    14 docutils のインストールには `easy_install docutils` を使用してください。 Trac が docutils パッケージを探すことが出来ない可能性があるので、 (`apt-get install python-docutils` などの) OS のパッケージマネージャは使わないでください。 
    15 ('''訳注:''' docutils が提供している `setup.py` では `setuptools` を使用していないため、 OS のパッケージでは `docutils-*.egg-info` が作成されない場合があることを指しています。 egg-info さえ作成されていれば OS のパッケージマネージャを使用しても問題ないと思われます。) 
    16  
    17 === さらなる RST に関する情報 === #MoreinformationonRST 
    18  
    19  * reStructuredText  Web サイト -- http://docutils.sourceforge.net/rst.html 
    20  * RST クイックリファレンス -- http://docutils.sourceforge.net/docs/rst/quickref.html 
     1= reStructuredText Support in Trac = 
     2 
     3Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. 
     4 
     5From the reStucturedText webpage: 
     6 "''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser   system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating  simple web pages, and for standalone documents. reStructuredText is designed for extensibility for  specific application domains. ''" 
     7 
     8If you want a file from your Subversion repository be displayed as reStructuredText in Trac's source browser, set `text/x-rst` as value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example]. 
     9 
     10=== Requirements === 
     11Note that to activate RST support in Trac, the python docutils package must be installed.  
     12If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 
     13 
     14Install docutils using `easy_install docutils`. Do not use the package manager of your OS (e.g. `apt-get install python-docutils`), because Trac will not find docutils then. 
     15 
     16=== More information on RST === 
     17 
     18 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html 
     19 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html 
    2120 
    2221---- 
    2322 
    24 == RST を Trac で使用する == #UsingRSTinTrac 
    25 テキストブロックが RST でパースされるようにするには、 ''rst'' プロセッサを使用してください。 
    26  
    27 === reStructuredText における TracLinks === #TracLinksinreStructuredText 
    28  
    29  * Trac は RST テキストの中で TracLinks が可能になる、 RST のディレクティブ 'trac' を提供しています。 
    30  
    31  例: 
    32  {{{ 
    33  {{{ 
    34  #!rst 
    35  This is a reference to |a ticket| 
    36  
    37  .. |a ticket| trac:: #42 
    38  }}} 
    39  }}} 
    40  
    41  * Trac は RST で TracLinks を簡単に作成できるように、 `:trac:` というロールを予約しています。 
    42  
    43  例: 
    44  {{{ 
    45  {{{ 
    46  #!rst 
    47  This is a reference to ticket `#12`:trac: 
    48  
    49  To learn how to use Trac, see `TracGuide`:trac: 
    50  }}} 
    51  }}} 
    52  
    53  `:trac:` ロールのすべての使用例の一覧は、 WikiRestructuredTextLinks を見てください。 
    54  
    55  
    56 === reStructuredText におけるシンタックスハイライト === #SyntaxhighlightinginreStructuredText 
    57  
    58 同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。 
    59 ディレクティブは code-block と呼ばれます。 
    60  
    61 例 
    62  
    63 {{{ 
    64 {{{ 
    65 #!rst 
    66  
    67 .. code-block:: python 
    68  
    69  class Test: 
    70  
    71     def TestFunction(self): 
    72         pass 
    73  
    74 }}} 
    75 }}} 
    76  
    77 上記の例は以下のように見えます。 
    78  
    79 {{{ 
    80 #!rst 
    81  
    82 .. code-block:: python 
    83  
    84  class Test: 
    85  
    86     def TestFunction(self): 
    87         pass 
    88  
    89 }}} 
    90  
    91 === reStructuredText の中における Wiki Macros === #WikiMacrosinreStructuredText 
    92  
    93 [WikiMacros Wiki マクロ] を RST の中で使用するには、 code-block のようなシンタックスハイライトと同様のディレクティブを使用します。 
    94  
    95 === Wiki Macros の例 === #WikiMacroExample 
    96  
    97 {{{ 
    98 {{{ 
    99 #!rst 
    100  
    101 .. code-block:: RecentChanges 
    102  
    103    Trac,3 
    104  
    105 }}} 
    106 }}} 
    107  
    108 この結果は以下のようになります: 
    109  
    110      [[RecentChanges(Trac,3)]] 
    111  
    112 より簡素な構文でも Wiki マクロを利用できます: 
    113  
    114 {{{ 
    115 {{{ 
    116 #!rst 
    117  
    118 :code-block:`RecentChanges:Trac,3` 
    119 }}} 
    120 }}} 
    121  
    122 === より大きい RST の例 === #BiggerRSTExample 
    123 この例のように書くと、とても分かりやすくなります: 
     23== Using RST in Trac == 
     24To specify that a block of text should be parsed using RST, use the ''rst'' processor.  
     25 
     26=== TracLinks in reStructuredText === 
     27 
     28 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 
     29   ||= Wiki Markup ||= Display || 
     30   {{{#!td 
     31     {{{ 
     32     {{{ 
     33     #!rst 
     34     This is a reference to |a ticket| 
     35 
     36     .. |a ticket| trac:: #42 
     37     }}} 
     38     }}} 
     39   }}} 
     40   {{{#!td 
     41     {{{ 
     42     #!rst 
     43     This is a reference to |a ticket| 
     44 
     45     .. |a ticket| trac:: #42 
     46     }}} 
     47   }}} 
     48 
     49 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 
     50   ||= Wiki Markup ||= Display || 
     51   {{{#!td 
     52     {{{ 
     53     {{{ 
     54     #!rst 
     55     This is a reference to ticket `#12`:trac: 
     56 
     57     To learn how to use Trac, see `TracGuide`:trac: 
     58     }}} 
     59     }}} 
     60   }}} 
     61   {{{#!td 
     62     {{{ 
     63     #!rst 
     64     This is a reference to ticket `#12`:trac: 
     65 
     66     To learn how to use Trac, see `TracGuide`:trac: 
     67     }}} 
     68   }}} 
     69 
     70 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.  
     71 
     72 
     73=== Syntax highlighting in reStructuredText === 
     74 
     75There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 
     76code-block 
     77 
     78||= Wiki Markup ||= Display || 
     79{{{#!td 
     80  {{{ 
     81  {{{ 
     82  #!rst 
     83 
     84  .. code-block:: python 
     85 
     86     class Test: 
     87 
     88         def TestFunction(self): 
     89             pass 
     90   
     91  }}} 
     92  }}} 
     93}}} 
     94{{{#!td 
     95  {{{ 
     96  #!rst 
     97 
     98  .. code-block:: python 
     99 
     100     class Test: 
     101 
     102         def TestFunction(self): 
     103             pass 
     104 
     105  }}} 
     106}}} 
     107Note the need to indent the code at least one character after the `.. code-block` directive. 
     108 
     109=== Wiki Macros in reStructuredText === 
     110 
     111For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 
     112 
     113||= Wiki Markup ||= Display || 
     114{{{#!td 
     115  {{{ 
     116  {{{ 
     117  #!rst 
     118 
     119  .. code-block:: RecentChanges 
     120 
     121     Trac,3 
     122 
     123  }}} 
     124  }}} 
     125}}} 
     126{{{#!td 
     127  {{{ 
     128  #!rst 
     129 
     130  .. code-block:: RecentChanges 
     131 
     132     Trac,3 
     133 
     134  }}} 
     135}}} 
     136 
     137Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 
     138 
     139||= Wiki Markup ||= Display || 
     140{{{#!td 
     141  {{{ 
     142  {{{ 
     143  #!rst 
     144 
     145  :code-block:`RecentChanges:Trac,3` 
     146  }}} 
     147  }}} 
     148}}} 
     149{{{#!td 
     150  {{{ 
     151  #!rst 
     152 
     153  :code-block:`RecentChanges:Trac,3` 
     154  }}} 
     155}}} 
     156 
     157=== Bigger RST Example === 
     158The example below should be mostly self-explanatory: 
     159 
     160||= Wiki Markup ||= Display || 
     161{{{#!td 
    124162{{{ 
    125163#!html 
    126164<pre class="wiki">{{{ 
    127165#!rst 
    128 ほげほげヘッダ 
    129 ============== 
    130 reStructuredText は **素敵** 。この続きは webpage_ で。 
    131  
    132 表: 
    133  
    134 ==  ==  ====== 
    135  入力    出力 
    136 ------  ------ 
    137 A   B   A or B 
    138 ==  ==  ====== 
    139 偽  偽    偽 
    140 真  偽    真 
    141 偽  真    真 
    142 真  真    真 
    143 ==  ==  ====== 
    144  
    145 RST での TracLinks 
    146 ------------------ 
    147  
    148 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 
     166FooBar Header 
     167============= 
     168reStructuredText is **nice**. It has its own webpage_. 
     169 
     170A table: 
     171 
     172=====  =====  ====== 
     173   Inputs     Output 
     174------------  ------ 
     175  A      B    A or B 
     176=====  =====  ====== 
     177False  False  False 
     178True   False  True 
     179False  True   True 
     180True   True   True 
     181=====  =====  ====== 
     182 
     183RST TracLinks 
     184------------- 
     185 
     186See also ticket `#42`:trac:. 
    149187 
    150188.. _webpage: http://docutils.sourceforge.net/rst.html 
    151189}}}</pre> 
    152190}}} 
    153  
    154  
    155 結果: 
     191}}} 
     192{{{#!td 
    156193{{{ 
    157194#!rst 
    158 ほげほげヘッダ 
    159 ============== 
    160 reStructuredText は **素敵** 。この続きは webpage_ で。 
    161  
    162 表: 
    163  
    164 ==  ==  ====== 
    165  入力    出力 
    166 ------  ------ 
    167 A   B   A or B 
    168 ==  ==  ====== 
    169 偽  偽    偽 
    170 真  偽    真 
    171 偽  真    真 
    172 真  真    真 
    173 ==  ==  ====== 
    174  
    175 RST での TracLinks 
    176 ------------------ 
    177  
    178 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 
     195FooBar Header 
     196============= 
     197reStructuredText is **nice**. It has its own webpage_. 
     198 
     199A table: 
     200 
     201=====  =====  ====== 
     202   Inputs     Output 
     203------------  ------ 
     204  A      B    A or B 
     205=====  =====  ====== 
     206False  False  False 
     207True   False  True 
     208False  True   True 
     209True   True   True 
     210=====  =====  ====== 
     211 
     212RST TracLinks 
     213------------- 
     214 
     215See also ticket `#42`:trac:. 
    179216 
    180217.. _webpage: http://docutils.sourceforge.net/rst.html 
    181218}}} 
    182  
    183 '''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。''' 
     219}}} 
    184220 
    185221----