Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
May 13, 2012, 9:15:45 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    1 = reStructuredText の対応 =
    2 
    3 Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' が利用可能です。
     1= Trac での reStructuredText 対応 = #reStructuredTextSupportinTrac
     2
     3Trac は WikiFormatting を使用できるすべての箇所で、 Wiki マークアップの代わりに ''reStructuredText'' を使用することができます。
    44
    55reStructuredText の Web ページより:
    6  "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''"
    7 
    8 === 必須条件 ===
    9 Trac で RST を使うためには、 Python の docutils パッケージがインストールされてなければなりません。
     6 "''reStructuredText は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな Web ページの素早い作成、スタンドアロンのドキュメントの記述に役立ちます。 reStructuredText は個別のアプリケーション向けに拡張ができるように設計されています。''"
     7
     8Subversion リポジトリのファイルを reStructuredText として Trac のソースブラウザに表示したい場合、 Subversion の `svn:mime-type` 属性に `text/x-rst` を設定してください。 [http://trac.edgewall.org/browser/trunk/INSTALL この例] が参考になります。
     9
     10=== 必須条件 === #Requirements
     11Trac で RST を使うためには、 Python の docutils パッケージがインストールされていなければなりません。
    1012あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。
    1113
    12 === さらなる RST に関する情報 ===
     14docutils のインストールには `easy_install docutils` を使用してください。 Trac が docutils パッケージを探すことが出来ない可能性があるので、 (`apt-get install python-docutils` などの) OS のパッケージマネージャは使わないでください。('''訳注:''' docutils が提供している `setup.py` では `setuptools` を使用していないため、 OS のパッケージでは `docutils-*.egg-info` が作成されない場合があることを指しています。 egg-info さえ作成されていれば OS のパッケージマネージャを使用しても問題ないと思われます。)
     15
     16=== さらなる RST に関する情報 === #MoreinformationonRST
    1317
    1418 * reStructuredText  Web サイト -- http://docutils.sourceforge.net/rst.html
    … …  
    1721----
    1822
    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 におけるシンタックスハイライト ===
     23== RST を Trac で使用する == #UsingRSTinTrac
     24テキストブロックが RST でパースされるようにするには、 ''rst'' プロセッサを使用してください。
     25
     26=== reStructuredText における TracLinks === #TracLinksinreStructuredText
     27
     28 * Trac は RST テキストの中で TracLinks が可能になる、 RST のディレクティブ 'trac' を提供しています。
     29   ||= Wiki マークアップ ||= 表示 ||
     30   {{{#!td
     31     {{{
     32     {{{
     33     #!rst
     34     これは |チケット| へのリンクです。
     35
     36     .. |チケット| trac:: #42
     37     }}}
     38     }}}
     39   }}}
     40   {{{#!td
     41     {{{
     42     #!rst
     43     これは |チケット| へのリンクです。
     44
     45     .. |チケット| trac:: #42
     46     }}}
     47   }}}
     48
     49 * Trac は RST で TracLinks を簡単に作成できるように、 `:trac:` というロールを予約しています。
     50   ||= Wiki マークアップ ||= 表示 ||
     51   {{{#!td
     52     {{{
     53     {{{
     54     #!rst
     55     これはチケット `#12`:trac: へのリンクです。
     56
     57     Trac の使い方を学ぶためには、 `TracGuide`:trac: を参照して下さい。
     58     }}}
     59     }}}
     60   }}}
     61   {{{#!td
     62     {{{
     63     #!rst
     64     これはチケット `#12`:trac: へのリンクです。
     65
     66     Trac の使い方を学ぶためには、 `TracGuide`:trac: を参照して下さい。
     67     }}}
     68   }}}
     69
     70 `:trac:` ロールのすべての使用例の一覧は、 WikiRestructuredTextLinks を見てください。
     71
     72
     73=== reStructuredText におけるシンタックスハイライト === #SyntaxhighlightinginreStructuredText
    5274
    5375同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。
    5476ディレクティブは code-block と呼ばれます。
    5577
    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 の例 ===
     78||= Wiki マークアップ ||= 表示 ||
     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}}}
     107`.. code-block` ディレクティブの後のコードは少なくとも1文字インデントする必要があります。
     108
     109=== reStructuredText の中における Wiki Macros === #WikiMacrosinreStructuredText
     110
     111[WikiMacros Wiki マクロ] を RST の中で使用するには、 code-block のようなシンタックスハイライトと同様のディレクティブを使用します。
     112
     113||= Wiki マークアップ ||= 表示 ||
     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
     137 `:code-block:` を使って、より簡素な構文でも Wiki マクロを利用できます:
     138
     139||= Wiki マークアップ ||= 表示 ||
     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=== より大きい RST の例 === #BiggerRSTExample
    111158この例のように書くと、とても分かりやすくなります:
     159
     160||= Wiki マークアップ ||= 表示 ||
     161{{{#!td
    112162{{{
    113163#!html
    … …  
    139189}}}</pre>
    140190}}}
    141 
    142 
    143 結果:
     191}}}
     192{{{#!td
    144193{{{
    145194#!rst
    … …  
    168217.. _webpage: http://docutils.sourceforge.net/rst.html
    169218}}}
     219}}}
    170220
    171221'''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。'''