Changes between Version 1 and Version 2 of WikiRestructuredText
- Timestamp:
- 12/14/10 02:51:48 (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v1 v2 1 = reStructuredText のサポート=1 = reStructuredText Support in Trac = 2 2 3 Trac は WikiFormatting が使われているあらゆるコンテキストの中で Wiki マークアップの代わりとなるものとして ''reStructuredText'' の使用をサポートしています。3 Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used. 4 4 5 reStructuredText の Web ページより:6 "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレーンテキストとそのパーサシステムです。 reStructuredText はプログラムのインラインのドキュメント (例えば、 Python docstrings) や簡単な Web ページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。 reStructuredText は特定のアプリケーションの分野のための拡張として設計されています。''"5 From 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 7 8 === 必須条件 === 9 Trac で RST のサポートを有効にするためには、 Python の docutils パッケージがインストールされてなければなりません。 10 あなたのオペレーティングシステムでまだ使用できない場合は、 [http://docutils.sourceforge.net/rst.html RST Website] からダウンロードすることができます。 8 If 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]. 11 9 12 === さらなる RST に関する情報 === 10 === Requirements === 11 Note that to activate RST support in Trac, the python docutils package must be installed. 12 If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 13 13 14 * reStructuredText Web サイト -- http://docutils.sourceforge.net/rst.html 15 * RST クイックリファレンス -- http://docutils.sourceforge.net/docs/rst/quickref.html 14 Install 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 16 20 17 21 ---- 18 22 19 == RST を Trac で使用する==20 テキストが RST を使用してパースされるようにするには、 ''rst'' プロセッサを使用してください。 23 == Using RST in Trac == 24 To specify that a block of text should be parsed using RST, use the ''rst'' processor. 21 25 22 === reStructuredText における TracLinks===26 === TracLinks in reStructuredText === 23 27 24 * Trac は RST テキストの中で TracLinks を許可するための 'trac' というカスタマイズされたRSTのリファレンスディレクティブを提供しています。28 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 25 29 26 例:30 Example: 27 31 {{{ 28 32 {{{ … … 34 38 }}} 35 39 36 ''trac'' ディレクティブのすべての使用方法の一覧は、 WikiRestructuredTextLinks を見てください。40 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 37 41 38 39 * Trac は RST において、カスタマイズされた '':trac::'' というリンクのための命名体系を使用することにより、簡単な方法で TracLinks を作ることを許可しています。 40 41 例: 42 Example: 42 43 {{{ 43 44 {{{ … … 49 50 }}} 50 51 51 === reStructuredText におけるシンタックスハイライト === 52 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. 52 53 53 同様に、 RST において TracSyntaxColoring を行なうディレクティブがあります。54 ディレクティブは code-block と呼ばれます。55 54 56 例 55 === Syntax highlighting in reStructuredText === 56 57 There is a directive for doing TracSyntaxColoring in RST as well. The directive is called 58 code-block 59 60 Example 57 61 58 62 {{{ … … 70 74 }}} 71 75 72 上記の例は以下のように見えます。 76 Will result in the below. 73 77 74 78 {{{ … … 84 88 }}} 85 89 86 === reStructuredText の中における WikiMacros===90 === Wiki Macros in reStructuredText === 87 91 88 WikiMacros を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の 89 ディレクティブを使用します。動作させるためには [http://projects.edgewall.com/trac/ticket/801 #801] のパッチ適用をした Trac を使用しなければなりません。 92 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 90 93 91 === Wiki Macros の例===94 === Wiki Macro Example === 92 95 93 96 {{{ … … 95 98 #!rst 96 99 97 .. code-block:: HelloWorld 98 99 Something I wanted to say 100 .. code-block:: RecentChanges 100 101 102 Trac,3 101 103 102 104 }}} 103 105 }}} 104 106 105 この結果は以下のようになります。 107 Will result in the below: 106 108 107 [[HelloWorld(Something I wanted to say)]]109 [[RecentChanges(Trac,3)]] 108 110 111 Or a more concise Wiki Macro like syntax is also available: 109 112 110 === より大きい ReST の例 === 111 この例のように書くと、とても分かりやすくなります: 113 {{{ 114 {{{ 115 #!rst 116 117 :code-block:`RecentChanges:Trac,3` 118 }}} 119 }}} 120 121 === Bigger RST Example === 122 The example below should be mostly self-explanatory: 112 123 {{{ 113 124 #!html … … 141 152 142 153 143 結果:154 Results in: 144 155 {{{ 145 156 #!rst … … 169 180 }}} 170 181 171 '''訳注: 日本語でテーブルを作成する場合、 docutils にパッチする必要があります。'''172 182 173 183 ----
