wiki:WikiFormatting

Wiki 文法

Wiki 文法を使用することで書式を変更したり、リンクの設定や画像の貼り付けができます。

以下に記述する Wiki 文法表に Wiki 文法の使用例を載せます。
カテゴリ 名をクリックすることで、より詳しい説明を見ることができます。


Wiki 文法表

基本

カテゴリ Wiki 文法 表示

フォント書式

'''太字''', ''斜体'' 太字, 斜体
__下線__, ~~取り消し線~~ 下線, 取り消し線
改行
改行なし、
改行[[br]]
改行

改行なし、 改行
改行

見出し
= 見出し 1 =
== 見出し 2 ==

見出し 1

見出し 2

リスト
* 番号なしリスト
 * 番号なしリスト2
  a. 番号付リスト
  a. 番号付リスト
* 番号なしリスト3
 1. 番号付リスト
 1. 番号付リスト
  • 番号なしリスト1
    • 番号なしリスト2
      1. 番号付リスト
      2. 番号付リスト
  • 番号なしリスト3
    1. 番号付リスト
    2. 番号付リスト
||= 表のヘッダ1 =||= ヘッダ2 =||
||内容||内容||
||||結合||
表のヘッダ1 ヘッダ2
内容内容
結合

リンク

http://trac.edgewall.org  http://trac.edgewall.org
WikiFormatting, wiki:"WikiFormatting" WikiFormatting, wiki:"WikiFormatting"
#1 (チケット), ticket:1 #1 (チケット), ticket:1
[1] (チェンジセット), r1 (チェンジセット) [1] (チェンジセット), r1 (チェンジセット)
リンクの無効化 !WikiFormatting, !#1 WikiFormatting, #1



便利

カテゴリ Wiki 文法 表示
整形済みテキスト
{{{
'''太字にならない'''
      空白文字も除去しない
}}}
'''太字にならない'''
      空白文字も除去しない
画像 [[Image(link)]] trac_logo_mini.png
横棒
----

参照の設定

[=#point1 (1)] 参照元 (1) 参照元
[#point1 (1)] 参照リンク (1) 参照リンク
引用
>> 元の文章
> 上記の文章を引用

元の文章

上記の文章を引用

引用ブロック
行の先頭にスペースが1 つ以上あると、
 テキストは引用を表します。

行の先頭にスペースが 1 つ以上あると、

テキストは引用を表します。

用語定義リスト

 用語:: 複数段落にわたる
        用語の定義
用語
複数段落にわたる 用語の定義
コメント
ここから先は表示されなくなります。
{{{#!comment
編集している人への注: ...
}}}

ここから先は表示されなくなります。



応用

カテゴリ Wiki 文法 表示
マクロ
[[RecentChanges(Trac,3)]]

プロセッサ
{{{
#!div style="font-size: 90%"
ソースコードのハイライト:
  {{{#!python
  hello = lambda: "world"
  }}}
}}}

ソースコードのハイライト:

hello = lambda: "world"



詳細説明

フォント書式

Trac の Wiki は以下のフォント書式に対応しています。

Wiki 文法 表示
 * '''太字''' 
 * ''斜体''
 * '''''太字 + 斜体''''' 
 * __下線__
 * {{{等幅}}} または `等幅`
 * ~~取り消し線~~
 * ^上付き文字^ 
 * ,,下付き文字,,
  • 太字
  • 斜体
  • 太字 + 斜体
  • 下線
  • 等幅 または 等幅
  • 取り消し線
  • 上付き文字
  • 下付き文字

戻る



改行

改行を行いたい場合、[[br]]または\\を入力して下さい。

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

Wiki 文法 表示
行 1[[BR]]行 2
行 1\\行 2
段落
1

段落 
2

行 1
行 2

行 1
行 2

段落 1

段落 2

戻る



見出し

行の先頭を等号記号 (=) からはじめ、その後にスペースを 1 つおいて、テキストを記述することにより、
見出しを作成することができます。

等号記号は 6 つまで対応しています。

Wiki 文法 表示
= 見出し1 =
== 見出し2 ==
=== 見出し3 ===
==== 見出し4 ====
===== 見出し5 =====
====== 見出し6 ======

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

戻る



リスト

番号付きリストと番号無しリストの両方があります。

Wiki 文法 表示
 * Item 1
   * Item 1.1
      * Item 1.1.1   
      * Item 1.1.2
   * Item 1.2
 * Item 2
- 各項目は行の先頭から開始することができます。
  複数行にまたがることもできます。
  - 複数行にまたがる場合は、適切なインデントをするよう
  注意してください。さもないと
このように、新しい段落が開始してしまいます。

 1. Item 1
   a. Item 1.a
   a. Item 1.b
      i. Item 1.b.i
      i. Item 1.b.ii
 1. Item 2
番号付きのリストは明示的に番号を付けることで
リストを再開できます。
 3. Item 3
  • Item 1
    • Item 1.1
      • Item 1.1.1
      • Item 1.1.2
    • Item 1.2
  • Item 2
  • 各項目は行の先頭から開始することができます。 複数行にまたがることもできます。
    • 複数行にまたがる場合は、適切なインデントをするよう 注意してください。さもないと

このように、新しい段落が開始してしまいます。

  1. Item 1
    1. Item 1.a
    2. Item 1.b
      1. Item 1.b.i
      2. Item 1.b.ii
  2. Item 2

番号付きのリストは明示的に番号を付けることでリストを再開できます。

  1. Item 3

戻る



簡単なテーブルは以下のように記述します。

Wiki 文法 表示
||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||
Cell 1Cell 2Cell 3
Cell 4Cell 5Cell 6

等号 (=) でテキストを挟むことで、ヘッダを指定することができます。
等号 (=) はセルのセパレータ (||) と接するように記述してください。

Wiki 文法 表示
||        ||= 安定版 =||= 最新版 =||
||= 0.10 =||  0.10.5  || 0.10.6dev||
||= 0.11 =||  0.11.6  || 0.11.7dev||
安定版 最新版
0.10 0.10.5 0.10.6dev
0.11 0.11.6 0.11.7dev

空のセルを指定すると、空ではないセルの範囲が空のセルまで広がります。

Wiki 文法 表示
|| 1 || 2 || 3 ||
|||| 1-2 || 3 ||
|||||| 1-2-3 ||
1 2 3
1-2 3
1-2-3

表内のテキストは左寄せで表示されますが
スペースを挿入することで、テキスト位置を中央寄せ・右寄せに変更することができます。

中央寄せ
左右のセパレータとの間に 2 つ以上スペースを挿入する
右寄せ
テキストより左側にスペースを 1 つ以上挿入し、テキストの右側がセパレータに接するよう記述する

Wiki 文法 表示
||= テキスト =||= 数字 =||
||左寄せ      ||1    ||
||  中央寄せ  ||  2  ||
||      右寄せ||    3||
||デフォルトの配置(左寄せ)||4.0||
テキスト 数字
左寄せ 1
中央寄せ 2
右寄せ 3
デフォルトの配置(左寄せ)4.0

バックスラッシュ (\) が行末にあるとき、次の行に書かれた内容は同じ組と認識されます。

Wiki 文法 表示
|| Cell 1 ||
|| Cell 2 || 
|| Cell 3 ||\
|| Cell 4 ||\
|| Cell 5 ||
Cell 1
Cell 2
Cell 3 Cell 4 Cell 5

テーブル用 Wiki プロセッサ を使用して、より凝ったテーブルを作成することができます。

戻る



WikiPageNames に沿ったタイトルの Wiki ページや URL は自動的にハイパーリンクされます。

Wiki 文法 表示
TitleIndex, http://www.edgewall.com/

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

ブラケット ([]) 内に、リンクとスペース 1 つとタイトルをつけることによって、リンクの表示を変更することができます。

Wiki 文法 表示
 * [http://www.edgewall.com Edgewall Software]
 * [wiki:TitleIndex Wiki ページ一覧] 

指定した Wiki ページが存在しない場合、文字の色が灰色になりクエスチョンマーク(?)がつきます。
そのリンクをたどりページを編集することで、新しいページを作成することができます。
詳細は WikiNewPage を参照ください。

Wiki 文法 表示
WikiFormatting/NonPage

WikiFormatting/NonPage?

特定のチケットやレポート、チェンジセット、マイルストーン、ソースファイル、他の Wiki ページへのリンクを張る特別な書式があります。
この書式方法を Trac リンクと呼びます。

Wiki 文法 表示
 * チケット: #1 または ticket:1
 * レポート: {1} または report:1
 * チェンジセット: r1, [1] または changeset:1

他にもさまざまな Trac リンクがあります。
別の Trac リンクや、より詳しい書式方法については Trac リンク を参照してください。

戻る



リンクの無効化

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

Wiki 文法 表示
 !NoHyperLink, 
 !#42 はリンクではありません。

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

戻る



整形済みテキスト

整形済みテキストを含むブロックは、ソースコードの一部や、ノート、例示に適しています。
引用ブロックとしたいテキストの前後を、 3 つのブレース ({})で括ってください。
ブレースと同じ行に文章を入力するとブロック化されないので注意してください。

Wiki 文法 表示
{{{
def HelloWorld():
    print '''Hello World'''
}}}
def HelloWorld():
    print '''Hello World'''

戻る



画像

画像を貼り付けるには [[Image]] マクロを使用します。
現在のページへ添付ファイルとして画像をアップロードし、 [[Image(picture.gif)]] のようにファイル名を指定してマクロを呼び出してください。

Wiki 文法 表示
[[Image(Trac_logo.png)]]

現在のページに加えて、他のリソースを参照することも可能です。

  • [[Image(wiki:WikiFormatting:picture.gif)]] (他のページの添付ファイルを参照する)
  • [[Image(ticket:1:picture.gif)]] (チケット 1 に添付されたファイルを参照する)
  • [[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]] (リポジトリにあるファイルを参照)

[[Image()]] マクロに関するより詳しい情報は WikiMacros に記載されています。

戻る



横棒

横線はページをいくつかに分けるために使用されます。

Wiki 文法 表示
4 つ以上のハイフン (-) は横線 に置き換えられます。
----

4 つ以上のハイフン (-) は横線に置き換えられます。


戻る



参照の設定

Wiki 文法を使用することで、ドキュメント内の特定の場所へのリンクを張ることができます。

Wiki 文法 表示
[#point1 (1)]: Wiki 文法表の[参照の設定] へジャンプする

下の[#point2 ポイント 2] にジャンプする

...

ポイント 2:  [=#point2] ここにジャンプしています

(1): Wiki 文法表の[参照の設定] へジャンプする

下のポイント 2 にジャンプする

...

ポイント 2: ここにジャンプしています

参照先を設定するには以下のような記述を行います。

[=#point]

その参照先に対応するリンクは以下のように記述します。

[#point]

見出し を参照先として設定するときにはブラケット ([]) と等号 (=) の記述は必要ありません。

== 見出し == #title

戻る



引用

進行中の議題のスレッド、チケットのコメントエリアなどで
引用を表すために、メールなどで見かける引用マーク (>, >> など) が使用できます。

Wiki 文法 表示
>> 元の文章
> 上記の文章を引用
>  - 引用内でも ''Wiki 文法''を使用することができます。
上記の文章を引用

元の文章

上記文章を引用して返信

  • 引用内でも Wiki 文法を使用することができます。

上記の文章を引用

戻る



引用ブロック

段落を引用ブロックとしてマークするには、段落を 1 つ以上のスペースでインデントします。
スペースの個数が不定であってもインデントの深さは変わりません。

Wiki 文法 表示
段落
    スペース 4 つ
 スペース 1 つ

段落

スペース 4 つ

スペース 1 つ

戻る



用語定義リスト

Wiki は用語定義リストも作成できます。
用語定義リストを作成するには、行の先頭にスペースが 1 つ必要です。

Wiki 文法 表示
 用語 1::
   用語 1 について。
 用語 2::
   用語 2 について。
用語 1
用語 1 について。
用語 2
用語 2 について。

戻る



コメント

編集時には表示され、編集完了時には表示されない文章を挿入することができます。

Wiki 文法 表示
何も
{{{
#!comment
ここに編集者向けのコメントを書く
}}}
見えません ;-)

何も

見えません ;-)

戻る



マクロ

マクロを使用することで動的なデータを挿入することができます。

下記は最近の Trac 内の更新を表示させるマクロです。

Wiki 文法 表示
[[RecentChanges(Trac, 3)]]

この他にも、Wiki ページのタイトルの一覧を表示させるマクロや、画像を挿入するマクロなどがあります。
使用できるマクロの一覧と使用方法は WikiMacros に記述されています。

戻る



プロセッサ

プロセッサという機能を使用することで、 HTMLreStructuredText を使用して Wiki ページを編集することができます。

Wiki 文法 表示

例 1: HTML

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

HTMLテスト

例 2: ソースコードのハイライト

{{{
#!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()

例 3: 複雑なテーブル

{{{#!th rowspan=3 align=justify
`#td` や `#th` プロセッサを用いることによって、
表の中にリストやテーブルを入れ込むことができます:
}}}
{{{#!td
  - リスト
  - 埋め込みテーブル
  - 簡単な複数行にわたる内容
}}}
|----------------
{{{#!td
表の中に表を作成することも可能です。
  {{{#!th
  例:
  }}}
  {{{#!td style="background: #eef"
  || ここは三重の入れ子になっています ||
  }}}
}}}
|----------------
{{{#!td
複数行にわたる内容を書くときには
この表のフォームは便利です。
}}}

#td#th プロセッサを用いることによって、 表の中にリストやテーブルを入れ込むことができます:

  • リスト
  • 埋め込みテーブル
  • 簡単な複数行にわたる内容

表の中に表を作成することも可能です。

例:

ここは三重の入れ子になっています

複数行にわたる内容を書くときには この表のフォームは便利です。

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

戻る


関連項目: OriginalWikiFormatting, TracGuide, TracWiki

Attachments