Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
08/27/15 23:20:06 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v1 v2  
    1 = reStructuredText の対応 =
    2 
    3 Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' が利用可能です。
    4 
    5 reStructuredText の Web ページより:
    6  "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''"
    7 
    8 === 必須条件 ===
    9 Trac で 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
     1= reStructuredText Support in Trac =
     2
     3Trac supports [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText (RST)] as an alternative to wiki markup where 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 to be displayed as reStructuredText in the Trac source browser, set `text/x-rst` as the value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].
     9
     10=== Requirements ===
     11To activate RST support in Trac, install the python docutils package: `easy_install docutils`. If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
     12
     13Do not use the package manager of your OS, eg `apt-get install python-docutils`, because Trac will not find docutils then.
     14
     15=== More information on RST ===
     16
     17 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
     18 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html
    1619
    1720----
    1821
    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 
    88 WikiMacros を 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 この例のように書くと、とても分かりやすくなります:
     22== Using RST in Trac ==
     23To specify that a block of text should be parsed using RST, use the ''rst'' processor.
     24
     25=== TracLinks in reStructuredText ===
     26
     27 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
     28   ||= Wiki Markup ||= Display ||
     29   {{{#!td
     30     {{{
     31     {{{
     32     #!rst
     33     This is a reference to |a ticket|
     34
     35     .. |a ticket| trac:: #42
     36     }}}
     37     }}}
     38   }}}
     39   {{{#!td
     40     {{{
     41     #!rst
     42     This is a reference to |a ticket|
     43
     44     .. |a ticket| trac:: #42
     45     }}}
     46   }}}
     47
     48 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
     49   ||= Wiki Markup ||= Display ||
     50   {{{#!td
     51     {{{
     52     {{{
     53     #!rst
     54     This is a reference to ticket `#12`:trac:
     55
     56     To learn how to use Trac, see `TracGuide`:trac:
     57     }}}
     58     }}}
     59   }}}
     60   {{{#!td
     61     {{{
     62     #!rst
     63     This is a reference to ticket `#12`:trac:
     64
     65     To learn how to use Trac, see `TracGuide`:trac:
     66     }}}
     67   }}}
     68
     69 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
     70
     71=== Syntax highlighting in reStructuredText ===
     72
     73There is a directive for doing TracSyntaxColoring in RST as well. The directive is called code-block:
     74
     75||= Wiki Markup ||= Display ||
     76{{{#!td
     77  {{{
     78  {{{
     79  #!rst
     80
     81  .. code-block:: python
     82
     83     class Test:
     84
     85         def TestFunction(self):
     86             pass
     87 
     88  }}}
     89  }}}
     90}}}
     91{{{#!td
     92  {{{
     93  #!rst
     94
     95  .. code-block:: python
     96
     97     class Test:
     98
     99         def TestFunction(self):
     100             pass
     101
     102  }}}
     103}}}
     104Note the need to indent the code at least one character after the `.. code-block` directive.
     105
     106=== Wiki Macros in reStructuredText ===
     107
     108To enable [WikiMacros Wiki Macros] in RST, you use the same directive as for syntax highlighting, ie code-block:
     109
     110||= Wiki Markup ||= Display ||
     111{{{#!td
     112  {{{
     113  {{{
     114  #!rst
     115
     116  .. code-block:: RecentChanges
     117
     118     Trac,3
     119
     120  }}}
     121  }}}
     122}}}
     123{{{#!td
     124  {{{
     125  #!rst
     126
     127  .. code-block:: RecentChanges
     128
     129     Trac,3
     130
     131  }}}
     132}}}
     133
     134Or a more concise Wiki Macro-like syntax is also available, using the `:code-block:` role:
     135
     136||= Wiki Markup ||= Display ||
     137{{{#!td
     138  {{{
     139  {{{
     140  #!rst
     141
     142  :code-block:`RecentChanges:Trac,3`
     143  }}}
     144  }}}
     145}}}
     146{{{#!td
     147  {{{
     148  #!rst
     149
     150  :code-block:`RecentChanges:Trac,3`
     151  }}}
     152}}}
     153
     154=== Bigger RST Example ===
     155The example below should be self-explanatory:
     156
     157||= Wiki Markup ||= Display ||
     158{{{#!td
    112159{{{
    113160#!html
    114161<pre class="wiki">{{{
    115162#!rst
    116 ほげほげヘッダ
    117 ==============
    118 reStructuredText は **素敵** 。この続きは webpage_ で。
    119 
    120 :
    121 
    122 ==  ==  ======
    123  入力    出力
    124 ------  ------
    125 A   B   A or B
    126 ==  ==  ======
    127 偽  偽    偽
    128 真  偽    真
    129 偽  真    真
    130 真  真    真
    131 ==  ==  ======
    132 
    133 RST での TracLinks
    134 ------------------
    135 
    136 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。
     163FooBar Header
     164=============
     165reStructuredText is **nice**. It has its own webpage_.
     166
     167A table:
     168
     169=====  =====  ======
     170   Inputs     Output
     171------------  ------
     172  A      B    A or B
     173=====  =====  ======
     174False  False  False
     175True   False  True
     176False  True   True
     177True   True   True
     178=====  =====  ======
     179
     180RST TracLinks
     181-------------
     182
     183See also ticket `#42`:trac:.
    137184
    138185.. _webpage: http://docutils.sourceforge.net/rst.html
    139186}}}</pre>
    140187}}}
    141 
    142 
    143 結果:
     188}}}
     189{{{#!td
    144190{{{
    145191#!rst
    146 ほげほげヘッダ
    147 ==============
    148 reStructuredText は **素敵** 。この続きは webpage_ で。
    149 
    150 :
    151 
    152 ==  ==  ======
    153  入力    出力
    154 ------  ------
    155 A   B   A or B
    156 ==  ==  ======
    157 偽  偽    偽
    158 真  偽    真
    159 偽  真    真
    160 真  真    真
    161 ==  ==  ======
    162 
    163 RST での TracLinks
    164 ------------------
    165 
    166 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。
     192FooBar Header
     193=============
     194reStructuredText is **nice**. It has its own webpage_.
     195
     196A table:
     197
     198=====  =====  ======
     199   Inputs     Output
     200------------  ------
     201  A      B    A or B
     202=====  =====  ======
     203False  False  False
     204True   False  True
     205False  True   True
     206True   True   True
     207=====  =====  ======
     208
     209RST TracLinks
     210-------------
     211
     212See also ticket `#42`:trac:.
    167213
    168214.. _webpage: http://docutils.sourceforge.net/rst.html
    169215}}}
    170 
    171 '''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。'''
     216}}}
    172217
    173218----