Changes between Version 2 and Version 3 of WikiRestructuredText
- Timestamp:
- Dec 31, 2005, 4:43:10 PM (18 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v2 v3 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のウェブページより:6 "''reStructuredText は読みやすく、見たものを手にする、マークアップされたプレインテキストとそのパーサーシステムです。reStructuredTextはプログラムのインラインのドキュメント(例えば、Python docstrings)や簡単なウェブページをすばやく作ること、スタンドアロンのドキュメントを書くのにとても役に立ちます。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 === Requirements === 9 Note that to activate RST support in Trac, the python docutils package must be installed. 10 If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website]. 11 11 12 === さらなるRSTに関する情報===12 === More information on RST === 13 13 14 * reStructuredText ウェブサイト-- http://docutils.sourceforge.net/rst.html15 * RST クイックリファレンス-- http://docutils.sourceforge.net/docs/rst/quickref.html14 * reStructuredText Website -- http://docutils.sourceforge.net/rst.html 15 * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html 16 16 17 17 ---- 18 18 19 == RSTをTracで使用する==20 テキストがRSTを使用してパースされるようにするには、''rst''プロセッサを使用してください。 19 == Using RST in Trac == 20 To specify that a block of text should be parsed using RST, use the ''rst'' processor. 21 21 22 === reStructuredTextにおける TracLinks===22 === TracLinks in reStructuredText === 23 23 24 * Trac はRSTテキストの中でTracLinks を許可するための 'trac'というカスタマイズされたRSTのリファレンスディレクティブを提供しています。24 * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text. 25 25 26 例:26 Example: 27 27 {{{ 28 28 {{{ … … 34 34 }}} 35 35 36 ''trac''ディレクティブのすべての使用方法の一覧は、WikiRestructuredTextLinks を見てください。36 For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks. 37 37 38 38 39 * Trac はRSTにおいて、カスタマイズされた'':trac::''というリンクのための命名体系を使用することにより、簡単な方法でTracLinks を作ることを許可しています。39 * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme. 40 40 41 例:41 Example: 42 42 {{{ 43 43 {{{ … … 49 49 }}} 50 50 51 === reStructuredTextにおけるシンタックスハイライト===51 === Syntax highlighting in reStructuredText === 52 52 53 同様に、RSTにおいてTracSyntaxColoring を行なうディレクティブがあります。 54 ディレクティブはcode-blockと呼ばれます。 53 There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called 54 code-block 55 55 56 例 56 Example 57 57 58 58 {{{ … … 70 70 }}} 71 71 72 上記の例は以下のように見えます。 72 Will result in the below. 73 73 74 74 {{{ … … 84 84 }}} 85 85 86 === WikiMacros in reStructuredText === 86 87 87 === 例 === 88 以下の例はほとんど一目瞭然です: 88 For doing WikiMacros in ReST you use the same directive as for syntax highlightning i.e 89 code-block. To work you must use a version of trac that has #801 applied. 90 91 === WikiMacro Example === 92 93 {{{ 94 {{{ 95 #!rst 96 97 .. code-block:: HelloWorld 98 99 Something I wanted to say 100 101 102 }}} 103 }}} 104 105 Will result in the below. 106 107 [[HelloWorld(Something I wanted to say)]] 108 109 110 === Bigger ReST Example === 111 The example below should be mostly self-explanatory: 89 112 {{{ 90 113 #!html … … 111 134 ------------- 112 135 113 See also ticket |#42|. 114 115 .. |#42| trac:: #42 136 See also ticket `#42`:trac:. 116 137 117 138 .. _webpage: http://docutils.sourceforge.net/rst.html … … 120 141 121 142 122 結果:143 Results in: 123 144 {{{ 124 145 #!rst … … 143 164 ------------- 144 165 145 See also ticket |#42|. 146 147 .. |#42| trac:: #42 166 See also ticket `#42`:trac:. 148 167 149 168 .. _webpage: http://docutils.sourceforge.net/rst.html … … 152 171 153 172 ---- 154 参考: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting173 See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting
