Creole マークアップのマクロ参照

Wiki の Creole マークアップで次のマクロを使用できます。

ファイル

構文 : <<file path/to/file revision linenumber>>
or

<<file revison:path/to/file#linenumber>> 

Wiki と同じプロジェクト内の指定されたファイルにリンクします。他のプロジェクトのリポジトリ内に格納されているファイルにリンクすることはできません。リンク構文はタグでは機能しません。

このマクロは次の引数をサポートします。

引数

説明

必須かどうか

path/to/file

リポジトリ ルートからファイルへの相対パス。パスにリポジトリ名を含めないでください。

はい

revison

リビジョンの名前またはハッシュ。既定では、システムは現在のバージョンを返します。

いいえ

linenumber

ファイルのリンク先となる場所。既定では、リンクは 0 行目を指します。

いいえ

:

1 <<file  stylesheets/foundation.css 55>>

以下が出力されます。

stylesheets/foundation.css

Issue

構文 : <<issue number>>

指定された課題へのリンク。次の引数をサポートします。

引数

説明

必須かどうか

Number (番号)

課題番号

はい

:

<<issue 4>>

以下が出力されます。

1 #4

課題のマイルストーン

構文 : <<milestone>>

指定されたマイルストーンの課題を一覧表示します。次の引数をサポートします。

引数

説明

必須かどうか

マイルストーン

マイルストーンの名前。

はい

:

<<milestone Version21>>

以下が出力されます。

1 2 3 Milestone Version21: * #3 MyIssue (open)

課題のクエリ

構文<<query queryString>>

指定された課題の queryString へのリンク。次の引数をサポートします。

引数

説明

必須かどうか

クエリ文字列

HTML クエリ文字列。このマークアップに AND 演算子はありません。クエリをグループ化することはできません。

はい

リンク

リンクのテキスト。

いいえ

:

<<query status=new&status=open Open Issues>>

出力は指定されたフレーズにリンクされます。

1 Open Issues 

課題の一覧

構文<<issues queryString>>

指定された queryString と一致する課題を一覧にします。このマークアップに AND 演算子はありません。クエリをグループ化することはできません。次の引数をサポートします。

引数

説明

必須かどうか

クエリ文字列

HTML クエリ文字列。

はい

<<issues queryString>> 構文は、並べ替え順についてのクエリ構文を完全にはサポートしていません。この問題については、課題 #3964 をフォローしてください。

:

<<issues status=resolved>>

結果として次のような一覧が表示されます。

1 2 * #7 Major Issue (resolved) * #4 Little Bug (resolved)

チェンジセット

構文<<changeset hashvalue>>

指定されたチェンジセットへのリンク。システムはチェンジセット ハッシュも自動的にリンクします。Wiki が格納されているリポジトリと同じリポジトリ内にあるチェンジセットにのみリンクできます。例えば、Wiki が projectA 内にある場合、projectB のチェンジセットにリンクすることはできません。  

このマクロは次の引数をサポートします。

引数

説明

必須かどうか

hashvalue

チェンジセットのハッシュ。

はい

:

<<changeset 9cc27f2>>

または

9cc27f2

結果として次のようなリンクの一覧が表示されます。

1 2 9cc27f29672b  9cc27f29672b

ユーザー

構文<<user accountname>>

指定された accountname のプロファイルへのリンク。次の引数をサポートします。

引数

説明

必須かどうか

accountname

個人またはユーザー アカウントの名前。

はい

:

<<user bitbucket>>

次の出力を生成します。

1 2 3 bitbucket tutorials

ソース

構文<<file filename branch line >> または <<source filename branch line >> または <<src filename branch line >>

指定された filename のリポジトリのソース ビューへのリンク。オプションとして、branch (リビジョン) および特定の line 番号を参照できます。次の引数をサポートします。

引数

説明

必須かどうか

filename

ソース ファイルの名前。

はい

branch

ハッシュまたはブランチの名前。

いいえ

line

行番号。

いいえ

:

<<file manage.py master 45>>

次のような出力を生成します。

1 manage.py

目次

構文<<toc path depth>>

Wiki でのみ使用できます。このマクロは、指定されたパスへの見出しを一覧化してリンクします。path には、ファイル名またはファイル パスを指定できます。次の引数をサポートします。

引数

説明

必須かどうか

path

シンプルなファイル名、または "/" (スラッシュ) で終わるファイルへのパス。現在のパスを使用する場合、path を指定しないでください。

いいえ

depth

取得する最も小さい HTML ヘッダーの数 (1 ~ 6)。

いいえ

<<toc>><<toc examples/>><<toc 2>><<toc troubleshooting 4>>

次の出力を生成します。

1 2 3 4 5 6 7 8 * Getting Started * Installation * OS X * Windows * Linux * Requirements * Best Practices * How to Contribute

Creole マクロの例

マークアップ

説明

1 <<issue 1>>

1 の ID を持つ課題へのリンクを追加します。

1 <<query ?status=open&status=new All open issues>>

ステータスが open または new のすべての課題へのリンクと、リンク テキスト "All open issues" を追加します。

1 <<milestone Beta 1>>

マイルストーン「Beta 1」のすべての課題の一覧と、各課題のリンクおよびステータスを追加します。

1 <<issues ?status=open&status=new count|list|compact>>

クエリ (ステータスが "open" または "new") と一致するすべての課題を 2 つのオプション スタイルのいずれかで一覧化するか、クエリに一致する課題の数を表示します。

1 <<issues ?status=open&status=new list>>

マイルストーン マクロと同じレイアウトで、open または new の課題の完全な一覧を表示します。

1 <<issues ?status=open&status=new compact>>

open または new の課題の一覧を表示しますが、トラッカー内の各課題へのリンクと課題 ID のみを示します。

<<issues ?content=~foo>>

特定の文字列で説明を検索したクエリの結果を表示します。

さらにヘルプが必要ですか?

アトラシアン コミュニティをご利用ください。