Version 1 から Version 2 における更新: WikiRestructuredText
- Timestamp:
- Nov 29, 2010, 3:25:29 PM (14 years 前)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v1 v2 1 = Trac での reStructuredText 対応 = #reStructuredTextSupportinTrac1 = 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 は読みやすく、 WYSIWYG なプレーンテキストへのマークアップ文法と、そのパーサシステムです。 (Python の docstring のような) プログラムへのインラインドキュメンテーションや、シンプルな 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 === 必須条件 === #Requirements 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 に関する情報 === #MoreinformationonRST 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 で使用する == #UsingRSTinTrac20 テキストブロックが 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 === #TracLinksinreStructuredText26 === TracLinks in reStructuredText === 23 27 24 * Trac は RST テキストの中で TracLinks が可能になる、 RST のリファレンスディレクティブ 'trac' を提供しています。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 で TracLinks を簡単に作成できるように、 '':trac:'' という名前 (naming scheme) を予約しています。 40 41 例: 42 Example: 42 43 {{{ 43 44 {{{ … … 49 50 }}} 50 51 51 === reStructuredText におけるシンタックスハイライト === #SyntaxhighlightinginreStructuredText 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 の中における Wiki Macros === #WikiMacrosinreStructuredText90 === Wiki Macros in reStructuredText === 87 91 88 [WikiMacros Wiki マクロ] を ReST の中で使用するには、例えば code-block のようなシンタックスハイライトと同様の 89 ディレクティブを使用します。動作させるためには [http://trac.edgewall.org/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 Macro s の例 === #WikiMacroExample94 === Wiki Macro Example === 92 95 93 96 {{{ … … 102 105 }}} 103 106 104 この結果は以下のようになります:107 Will result in the below: 105 108 106 109 [[RecentChanges(Trac,3)]] 107 110 108 より簡素な構文でも Wiki マクロを利用できます:111 Or a more concise Wiki Macro like syntax is also available: 109 112 110 113 {{{ … … 116 119 }}} 117 120 118 === より大きい ReST の例 === #BiggerReSTExample119 この例のように書くと、とても分かりやすくなります:121 === Bigger RST Example === 122 The example below should be mostly self-explanatory: 120 123 {{{ 121 124 #!html 122 125 <pre class="wiki">{{{ 123 126 #!rst 124 ほげほげヘッダ 125 ============= =126 reStructuredText は **素敵** 。この続きは webpage_ で。127 FooBar Header 128 ============= 129 reStructuredText is **nice**. It has its own webpage_. 127 130 128 表:131 A table: 129 132 130 == 131 入力 出力132 ------ ------133 A BA or B134 == 135 偽 偽 偽 136 真 偽 真 137 偽 真 真 138 真 真 真 139 == 133 ===== ===== ====== 134 Inputs Output 135 ------------ ------ 136 A B A or B 137 ===== ===== ====== 138 False False False 139 True False True 140 False True True 141 True True True 142 ===== ===== ====== 140 143 141 RST でのTracLinks142 ------------- -----144 RST TracLinks 145 ------------- 143 146 144 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 147 See also ticket `#42`:trac:. 145 148 146 149 .. _webpage: http://docutils.sourceforge.net/rst.html … … 149 152 150 153 151 結果:154 Results in: 152 155 {{{ 153 156 #!rst 154 ほげほげヘッダ 155 ============= =156 reStructuredText は **素敵** 。この続きは webpage_ で。157 FooBar Header 158 ============= 159 reStructuredText is **nice**. It has its own webpage_. 157 160 158 表:161 A table: 159 162 160 == 161 入力 出力162 ------ ------163 A BA or B164 == 165 偽 偽 偽 166 真 偽 真 167 偽 真 真 168 真 真 真 169 == 163 ===== ===== ====== 164 Inputs Output 165 ------------ ------ 166 A B A or B 167 ===== ===== ====== 168 False False False 169 True False True 170 False True True 171 True True True 172 ===== ===== ====== 170 173 171 RST でのTracLinks172 ------------- -----174 RST TracLinks 175 ------------- 173 176 174 チケット `[http://trac.edgewall.org/ticket/42 #42]`:trac: のように使用します。 177 See also ticket `#42`:trac:. 175 178 176 179 .. _webpage: http://docutils.sourceforge.net/rst.html 177 180 }}} 178 181 179 '''訳注: 日本語でテーブルを作成する場合、 Python-2.4 以降かつ docutils-0.4 以降でない場合は、 docutils に日本語テーブルパッチを適用する必要があります。'''180 182 181 183 ----
