Wiki 文法

Wiki マークアップは Trac のコアとなる機能です。他のパーツと緊密に統合することによって、Trac をフレキシブルかつ強力にしています。

Trac は小さく強力な Wiki レンダリングエンジンをビルトインしています。この Wiki エンジンは、他のポピュラーな Wiki からのコマンドの強化サブセットを実装しています。 (特に  MoinMoin)

このページは、 WikiFormatting でフォーマットできる文法の文例集です。

フォントスタイル

Trac の Wiki は以下のフォントスタイルをサポートしています:

 * '''ボールド'''
 * ''イタリック''
 * '''''ボールドイタリック'''''
 * __アンダーライン__
 * {{{モノスペース}}} or `モノスペース`
 * ~~取り消し線~~
 * ^上付き文字^ 
 * ,,下付き文字,,

表示内容:

• ボールド
• イタリック
• ボールドイタリック
• アンダーライン
• モノスペース or モノスペース
• 取り消し線
• ^{上付き文字}
• _{下付き文字}

Note: {{{...}}} と `...` コマンドは表示を等角フォントにするだけではなく、内容を整形済みテキストとして扱います。つまりテキストに対して、どのような Wiki 処理も行いません。

見出し

1文字から5文字の「イコール '='」を行頭に置き、1文字のスペースに続けてタイトルを置くと、 見出しになります。見出しの行末は1文字のスペースに続けて、行頭と同じ数の イコール (=)を 置きます。

例:

= 見出し(第1レベル) =
== 見出し(第2レベル) ==
=== 見出し(第3レベル) ===

表示内容:

見出し(第1レベル)

見出し(第2レベル)

見出し(第3レベル)

改行

2つのテキストブロックの間に1行以上の空行がある場合、新しい段落として改行を行います。

強制的に改行だけを行いたい場合、このように書いてください:

1行目[[BR]]2行目

以下のように表示されます:

1行目
2行目

リスト

番号付きリストと番号無しリストの両方をサポートします。

例:

 * Item 1
   * Item 1.1
 * Item 2

 1. Item 1
   1. Item 1.1
 1. Item 2

表示内容:

• Item 1
  • Item 1.1
• Item 2

1. Item 1
   1. Item 1.1
2. Item 2

リストマーカーの前にスペースを一つ以上置かなければなりません。スペースがない場合、通常のパラグラフとして扱われます。

用語定義リスト

Wikiは用語定義リストもサポートします。

例:

 llama::
   毛の生えた哺乳類の一種。
 ppython::
   毛がない爬虫類の一種。
   (typoを見つけたかい?)

表示内容:

llama

毛の生えた哺乳類の一種。

ppython

毛がない爬虫類の一種。 (typoを見つけたかい?)

定義する用語の前にスペースが一つ必要なことを忘れないで下さい。

整形済みテキスト

整形済みテキストを含むブロックは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、3つの ブレース (curly braces) で括ってください。ブレースは独立した行に置かなければいけません。 例:

 {{{
  def HelloWorld():
      print "Hello World"
 }}}

表示内容:

 def HelloWorld():
     print "Hello World"

引用ブロック

段落を引用ブロックとしてマークするには、段落を2個のスペースでインデントします。

例:

  This text is a quote from someone else.

表示内容:

This text is a quote from someone else.

表

簡単なテーブルはこのように記述します:

||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||

表示内容:

Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6

より複雑なテーブルはreStructuredText を使用して書くことができます。

リンク

WikiPageNames や URL は自動的にハイパーリンクされます。 WikiPageLinks を無効化したい場合、 !WikiPageLink のように、エクスクラメーションマーク (!) を語頭に置きます。

例:

 TitleIndex, http://www.edgewall.com/, !NotAlink

表示内容:

TitleIndex,  http://www.edgewall.com/, NotAlink

リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、角括弧 (square bracket) で括り、リンクに続いて1文字の空白を開けて記述します。もし説明のタイトルが省略された場合、そして明確なプレフィックスが記述されなかったとき、外部へのリンクにはなりません。これは WikiPageNames の仕様に準拠できない Wikiページを使いたい場合に役に立ちます。

例:

 * [http://www.edgewall.com/ Edgewall Software]
 * [wiki:TitleIndex Title Index]
 * [wiki:ISO9000]

表示内容:

•  Edgewall Software
• Title Index
• ISO9000?

Trac リンク

Wiki ページでは Trac の他のコンポーネントに直接リンクできます。チケット、レポート、チェンジセット、マイルストーン、ソースファイル、他の Wiki ページへは以下のようにリンクを記述します:

 * チケット: #1 もしくは ticket:1
 * レポート: {1} もしくは report:1
 * チェンジセット: [1] もしくは changeset:1
 * コミットログ: r1:3, [1:3] or log:branches/0.8-stable#1:3
 * Wiki ページ: CamelCase もしくは wiki:CamelCase
 * マイルストーン: milestone:1.0 もしくは milestone:"End-of-days Release"
 * ファイル: source:trunk/COPYING
 * 添付ファイル: attachment:"file name.doc"
 * 特定リビジョンのファイル: source:/trunk/COPYING#200
 * スペースが含まれたファイル名: source:"/trunk/README FIRST"

表示内容:

• チケット: #1 もしくは ticket:1
• レポート: {1} もしくは report:1
• チェンジセット: [1] もしくは changeset:1
• コミットログ: r1:3, [1:3] or log:branches/0.8-stable#1:3
• Wiki ページ: CamelCase もしくは wiki:CamelCase
• マイルストーン: milestone:1.0 もしくは milestone:"End-of-days Release"
• ファイル: source:trunk/COPYING
• 添付ファイル: attachment:"file name.doc"
• 特定リビジョンのファイル: source:/trunk/COPYING#200
• スペースが含まれたファイル名: source:"/trunk/README FIRST"

より深い情報は TracLinks に記述されています。

リンクの無効化

エクスクラメーションマーク(!)を語頭に付与することで、 TracLinks が出力するハイパーリンクを無効化できます。

Example:

 !NoHyperLink
 !#42 はリンクではありません。

表示内容:

NoHyperLink #42 はリンクではありません。

画像

URL が .png, .gif, .jpg で終わっている場合、自動的にイメージへのリンクとみなされ、 img タグに変換されます。

例:

http://www.edgewall.com/gfx/trac_example_image.png

表示内容:

 http://www.edgewall.com/gfx/trac_example_image.png

この方法では表示形式の細かな制御が出来ません。画像を挿入するには、より強力な Image マクロ (See WikiMacros) を使用してください。

マクロ

マクロは、動的コンテンツを Wiki ページに挿入するための カスタム関数 です。

例:

 [[Timestamp]]

表示内容:

Timestamp?

使用方法とインストールされているマクロの一覧は WikiMacros に記述されています。

プロセッサ

Trac は WikiProcessors の機能によって、 Wiki 以外のマークアップもサポートしています。例えば、プロセッサとしてページの描画に reStructuredText や HTML を使用することができます。

例1:

{{{
#!html
<h1 style="text-align: right; color: blue">HTMLテキスト</h1>
}}}

表示内容:

HTMLテキスト

例:

{{{
#!python
class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
}}}

表示内容:

class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()

Perl:

my ($test) = 0;
if ($test > 0) {
echo "hello";
}

より詳細な情報は WikiProcessors に記載されています。

その他

4文字以上のハイフン (-) は水平ライン (<hr>) に置き換えられます。

例:

 ----

表示内容:

---

---

See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.