wiki:WikiFormatting

Version 2 (modified by trac, 12 years ago) (diff)

--

Wiki 文法

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

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

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

フォントスタイル

Trac の Wiki は以下のフォントスタイルをサポートしています: ボールド, イタリック, アンダーライン and 取り消し線

Trac の Wiki は以下のフォントスタイルをサポートしています: '''ボールド''', ''イタリック'',
__アンダーライン__ and ~~取り消し線~~。

見出し

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

Note: 見出しの箇所は、 TracLinks の対象になりません。

例:

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

改行

2つのテキストブロックの間に1行以上の空行がある場合、新しい段落として改行を行います。 (訳注: HTMLでは、p要素になります)

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

1行目[[BR]]2行目

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

1行目
2行目

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

整形済みテキスト

引用ブロック(block quote)、整形済みテキストは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、3つの ブレース (curly braces) で括ってください。 例:

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

表示内容:

 def HelloWorld()
     print "Hello World"

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

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

以下の通り表示されます:

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

リンク

WikiPageNames や URL は自動的にハイパーリンクされます。 WikiPageLinks を無効化したい場合、

!WikiPageLink のように、エクラメーションマーク (!) を語頭に置きます。

例:

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

リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、 角括弧 (square bracket) で括り、リンクに続いて1文字の空白を開けて記述します:

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

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

Trac リンク

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

  • チケット: #1 もしくは ticket:1
  • レポート: {1} もしくは report:1
  • チェンジセット: [1] もしくは changeset:1
  • Wiki ページ: CamelCase もしくは wiki:CamelCase
  • マイルストーン: milestone:1.0
  • ファイル: source:trunk/COPYING
  • 特定リビジョンのファイル: source:/trunk/COPYING#200

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

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

リンクの無効化

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

 !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

マクロ

マクロは、動的コンテンツを Wiki ページに挿入するための カスタム関数 です。使用方法は WikiMacros に記述されています。

例:

 [[Timestamp]]

表示内容:

Timestamp?

プロセッサ

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

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

例1:

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

その他

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

 ----

表示例:



参考: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.