Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
09/18/14 10:48:12 (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredText

    v1 v2  
    55reStructuredText の Web ページより:
    66 "''reStructuredText は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな Web ページの素早い作成、スタンドアロンのドキュメントの記述に役立ちます。 reStructuredText は個別のアプリケーション向けに拡張ができるように設計されています。''"
     7
     8Subversion リポジトリのファイルを reStructuredText として Trac のソースブラウザに表示したい場合、 Subversion の `svn:mime-type` 属性に `text/x-rst` を設定してください。 [http://trac.edgewall.org/browser/trunk/INSTALL この例] が参考になります。
    79
    810=== 必須条件 === #Requirements
    … …  
    1012あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。
    1113
    12 docutils のインストールには `easy_install docutils` を使用してください。 Trac が docutils パッケージを探すことが出来ない可能性があるので、 (`apt-get install python-docutils` などの) OS のパッケージマネージャは使わないでください。
    13 ('''訳注:''' docutils が提供している `setup.py` では `setuptools` を使用していないため、 OS のパッケージでは `docutils-*.egg-info` が作成されない場合があることを指しています。 egg-info さえ作成されていれば OS のパッケージマネージャを使用しても問題ないと思われます。)
     14docutils のインストールには `easy_install docutils` を使用してください。 Trac が docutils パッケージを探すことが出来ない可能性があるので、 (`apt-get install python-docutils` などの) OS のパッケージマネージャは使わないでください。('''訳注:''' docutils が提供している `setup.py` では `setuptools` を使用していないため、 OS のパッケージでは `docutils-*.egg-info` が作成されない場合があることを指しています。 egg-info さえ作成されていれば OS のパッケージマネージャを使用しても問題ないと思われます。)
    1415
    1516=== さらなる RST に関する情報 === #MoreinformationonRST
    … …  
    2627
    2728 * 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  }}}
     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   }}}
    3848
    3949 * Trac は RST で TracLinks を簡単に作成できるように、 `:trac:` というロールを予約しています。
    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   ||= 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   }}}
    5069
    5170 `:trac:` ロールのすべての使用例の一覧は、 WikiRestructuredTextLinks を見てください。
    … …  
    5776ディレクティブは code-block と呼ばれます。
    5877
    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 }}}
     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文字インデントする必要があります。
    88108
    89109=== reStructuredText の中における Wiki Macros === #WikiMacrosinreStructuredText
    90110
    91111[WikiMacros Wiki マクロ] を RST の中で使用するには、 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 }}}
     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  }}}
    119155}}}
    120156
    121157=== より大きい RST の例 === #BiggerRSTExample
    122158この例のように書くと、とても分かりやすくなります:
     159
     160||= Wiki マークアップ ||= 表示 ||
     161{{{#!td
    123162{{{
    124163#!html
    … …  
    150189}}}</pre>
    151190}}}
    152 
    153 
    154 結果:
     191}}}
     192{{{#!td
    155193{{{
    156194#!rst
    … …  
    179217.. _webpage: http://docutils.sourceforge.net/rst.html
    180218}}}
     219}}}
    181220
    182221'''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。'''