Changes between Initial Version and Version 1 of WikiFormatting


Ignore:
Timestamp:
Jul 17, 2007, 3:05:36 AM (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiFormatting

    v1 v1  
     1= Wiki 文法 =
     2[[TracGuideToc]]
     3
     4Wiki マークアップは Trac のコアとなる機能です。他のパーツと緊密に統合することによって、 Trac をフレキシブルかつ強力にしています。
     5
     6Trac は小さく強力な Wiki レンダリングエンジンを内蔵しています。この Wiki エンジンは、他のポピュラーな Wiki からのコマンドの強化サブセットを実装しています。
     7(特に [http://moinmoin.wikiwikiweb.de/ MoinMoin])
     8
     9
     10このページは、 WikiFormatting でフォーマットできる文法の文例集です。
     11
     12
     13== フォント書式 ==
     14
     15Trac の Wiki は以下のフォント書式に対応しています:
     16{{{
     17 * '''ボールド''', '''!''' ボールドにできます''' そして '''! '''
     18 * ''イタリック''
     19 * '''''ボールドイタリック'''''
     20 * __アンダーライン__
     21 * {{{モノスペース}}} or `モノスペース`
     22 * ~~取り消し線~~
     23 * ^上付き文字^
     24 * ,,下付き文字,,
     25}}}
     26
     27表示内容:
     28 * '''ボールド''', '''!''' ボールドにできます''' そして '''! '''
     29 * ''イタリック''
     30 * '''''ボールドイタリック'''''
     31 * __アンダーライン__
     32 * {{{モノスペース}}} or `モノスペース`
     33 * ~~取り消し線~~
     34 * ^上付き文字^
     35 * ,,下付き文字,,
     36
     37Notes:
     38 * `{{{...}}}`と {{{`...`}}} コマンドは表示を等角フォントにするだけではなく、内容を整形済みテキストとして扱います。つまりテキストに対して、どのような Wiki 処理も行いません。
     39 * {{{ ! }}} は wiki パーサに wiki フォーマットとして解釈しないように伝えます。なので、 ! の後ろにスペースを置くことに注意して下さい。例えば、太字で行が終わるようなときです。
     40
     41== 見出し ==
     42
     431 文字から 5 文字の「イコール '='」を行頭に置き、 1 文字のスペースに続けてタイトルを置くと、
     44見出しになります。見出しの行末は1文字のスペースに続けて、行頭と同じ数の ''イコール (=)'' を
     45置きます。
     46見出しに続いて id 属性を明示的に付与することが出来ます。付与しない場合、暗黙の読み取り可能な id 属性が生成されます。
     47'''(訳注: 明示的に付与する id 属性では日本語は使用できないようです。)'''
     48
     49例:
     50{{{
     51= 見出し (第1レベル) =
     52== 見出し (第2レベル) ==
     53=== 見出し (第3レベル) ===
     54=== 明示的な id === #using-explicit-id-in-heading
     55}}}
     56
     57表示内容:
     58= 見出し (第1レベル) =
     59== 見出し (第2レベル) ==
     60=== 見出し (第3レベル) ===
     61=== 明示的な id === #using-explicit-id-in-heading
     62
     63== 改行 ==
     64
     652 つのテキストブロックの間に 1 行以上の空行がある場合、新しい段落として改行を行います。
     66
     67強制的に改行だけを行いたい場合、このように書いてください:
     68{{{
     691行目[[BR]]2行目
     70}}}
     71以下のように表示されます:
     72
     731行目[[BR]]2行目
     74
     75
     76== リスト ==
     77
     78番号付きリストと番号無しリストの両方があります。
     79
     80例:
     81{{{
     82 * Item 1
     83   * Item 1.1
     84 * Item 2
     85
     86 1. Item 1
     87   a. Item 1.a
     88   a. Item 1.b
     89      i. Item 1.b.i
     90      i. Item 1.b.ii
     91 1. Item 2
     92番号付きリストでは、番号を指定することもできます:
     93 3. Item 3
     94}}}
     95
     96表示内容:
     97 * Item 1
     98   * Item 1.1
     99 * Item 2
     100
     101 1. Item 1
     102   a. Item 1.a
     103   a. Item 1.b
     104      i. Item 1.b.i
     105      i. Item 1.b.ii
     106 1. Item 2
     107番号付きリストでは、番号を指定することもできます:
     108 3. Item 3
     109
     110リストマーカーの前にスペースを一つ以上置かなければなりません。スペースがない場合、通常のパラグラフとして扱われます。
     111
     112
     113== 用語定義リスト ==
     114
     115
     116Wikiは用語定義リストも作成できます。
     117
     118例:
     119{{{
     120 llama::
     121   毛の生えた哺乳類の一種。
     122 ppython::
     123   毛がない爬虫類の一種。
     124   (typoを見つけたかい?)
     125}}}
     126
     127表示内容:
     128 llama::
     129   毛の生えた哺乳類の一種。
     130 ppython::
     131   毛がない爬虫類の一種。
     132   (typoを見つけたかい?)
     133
     134定義する用語の前にスペースが一つ必要なことを忘れないで下さい。
     135
     136
     137== 整形済みテキスト ==
     138
     139整形済みテキストを含むブロックは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、 3 つの ''ブレース (curly braces)'' で括ってください。ブレースは独立した行に置かなければいけません。
     140 
     141例:
     142{{{
     143 {{{
     144  def HelloWorld():
     145      print "Hello World"
     146 }}}
     147}}}
     148
     149表示内容:
     150{{{
     151 def HelloWorld():
     152     print "Hello World"
     153}}}
     154
     155
     156== 引用ブロック ==
     157
     158段落を引用ブロックとしてマークするには、段落を 2 個のスペースでインデントします。
     159
     160例:
     161{{{
     162  This text is a quote from someone else.
     163}}}
     164
     165表示内容:
     166  This text is a quote from someone else.
     167
     168== 引用 ==
     169
     170進行中の議題のスレッド、チケットのコメントエリアなどで引用を表すために、メールライクな引用マーク (">", ">>" など) が使用できます。
     171
     172例:
     173{{{
     174>> Someone's original text
     175> Someone else's reply text
     176My reply text
     177}}}
     178
     179表示内容:
     180>> Someone's original text
     181> Someone else's reply text
     182My reply text
     183
     184''Note: いくつかの WikiFormatting の要素、 表やあらかじめ整形されたテキストは引用エリアでは整形が崩れてしまいます。きれいな引用を作るには再整形が必要になるでしょう。''
     185
     186== 表 ==
     187
     188簡単なテーブルはこのように記述します:
     189{{{
     190||Cell 1||Cell 2||Cell 3||
     191||Cell 4||Cell 5||Cell 6||
     192}}}
     193
     194表示内容:
     195||Cell 1||Cell 2||Cell 3||
     196||Cell 4||Cell 5||Cell 6||
     197
     198より複雑なテーブルは [wiki:WikiRestructuredText#より大きいReSTの例 reStructuredText]
     199を使用して書くことができます。
     200
     201
     202== リンク ==
     203
     204WikiPageNames や URL は自動的にハイパーリンクされます。 !WikiPageLinks を無効化したい場合、 {{{!WikiPageLink}}} のように、エクスクラメーションマーク (!) を語頭に置きます。
     205
     206例:
     207{{{
     208 TitleIndex, http://www.edgewall.com/, !NotAlink
     209}}}
     210
     211表示内容:
     212 TitleIndex, http://www.edgewall.com/, !NotAlink
     213
     214リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、角括弧 (square bracket) で括り、リンクに続いて 1 文字の空白を開けて記述します。もし説明のタイトルが省略された場合、そして明確なプレフィックスが記述されなかったとき、外部へのリンクにはなりません。これは WikiPageNames の仕様に準拠できない Wiki ページを使いたい場合に役に立ちます。
     215
     216例:
     217{{{
     218 * [http://www.edgewall.com/ Edgewall Software]
     219 * [wiki:TitleIndex Title Index]
     220 * [wiki:ISO9000]
     221}}}
     222
     223表示内容:
     224 * [http://www.edgewall.com/ Edgewall Software]
     225 * [wiki:TitleIndex Title Index]
     226 * [wiki:ISO9000]
     227
     228
     229=== Trac リンク ===
     230
     231Wiki ページでは Trac の他のコンポーネントに直接リンクできます。チケット、レポート、チェンジセット、マイルストーン、ソースファイル、他の Wiki ページへは以下のようにリンクを記述します:
     232{{{
     233 * チケット: #1 もしくは ticket:1
     234 * レポート: {1} もしくは report:1
     235 * チェンジセット: [1] もしくは changeset:1
     236 * ...
     237}}}
     238
     239表示内容:
     240 * チケット: #1 もしくは ticket:1
     241 * レポート: {1} もしくは report:1
     242 * チェンジセット: [1] もしくは changeset:1
     243 * ...
     244
     245より深い情報は TracLinks に記述されています。
     246
     247
     248== リンクの無効化 ==
     249
     250エクスクラメーションマーク (!) を語頭に付与することで、 TracLinks が出力するハイパーリンクを無効化できます。
     251
     252例:
     253{{{
     254 !NoHyperLink
     255 !#42 はリンクではありません。
     256}}}
     257
     258表示内容:
     259 !NoHyperLink
     260 !#42 はリンクではありません。
     261
     262
     263== 画像 ==
     264
     265URL が `.png`, `.gif` or `.jpg` で終わっている場合、自動的にイメージへのリンクとはならずに `<img>` タグに変換されます。
     266
     267![[Image]] マクロを使用しなければなりません (以下参照) 。
     268
     269
     270== マクロ ==
     271
     272マクロは、動的コンテンツを Wiki ページに挿入するための ''カスタム関数'' です。
     273
     274例:
     275{{{
     276 [[Timestamp]]
     277}}}
     278
     279表示内容:
     280 [[Timestamp]]
     281
     282使用方法とインストールされているマクロの一覧は WikiMacros に記述されています。
     283
     284
     285== プロセッサ ==
     286
     287Trac は WikiProcessors の機能によって、 Wiki 以外のマークアップにも対応しています。例えば、プロセッサとしてページの描画に
     288[wiki:WikiRestructuredText reStructuredText] や [wiki:WikiHtml HTML] を使用することができます。
     289
     290例1:
     291{{{
     292#!html
     293<pre class="wiki">{{{
     294#!html
     295&lt;h1 style="text-align: right; color: blue"&gt;HTMLテスト&lt;/h1&gt;
     296}}}</pre>
     297}}}
     298
     299表示内容:
     300{{{
     301#!html
     302<h1 style="text-align: right; color: blue">HTMLテスト</h1>
     303}}}
     304
     305例:
     306{{{
     307#!html
     308<pre class="wiki">{{{
     309#!python
     310class Test:
     311
     312    def __init__(self):
     313        print "Hello World"
     314if __name__ == '__main__':
     315   Test()
     316}}}</pre>
     317}}}
     318
     319表示内容:
     320{{{
     321#!python
     322class Test:
     323    def __init__(self):
     324        print "Hello World"
     325if __name__ == '__main__':
     326   Test()
     327}}}
     328
     329Perl:
     330{{{
     331#!perl
     332my ($test) = 0;
     333if ($test > 0) {
     334    print "hello";
     335}
     336}}}
     337
     338より詳細な情報は WikiProcessors に記載されています。
     339
     340
     341== その他 ==
     342
     3434 文字以上のハイフン (-) は水平ライン (<hr>) に置き換えられます。
     344
     345例:
     346{{{
     347 ----
     348}}}
     349
     350表示内容:
     351----
     352
     353
     354----
     355See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.