r-labs

h1. Redmine Wiki Extensions Plugin

{{>toc}}

English page is [[Wiki Extensions en|here]].

Redmineのwikiを拡張するプラグインです。

開発プロジェクトは{{project(Wiki Extensions)}}です。

h2. ダウンロード

"butbucket":https://bitbucket.org/haru_iida/redmine_wiki_extensions/downloads

h2. インストール

# プラグインをRedmineインストールフォルダの下の vendor/plugins に展開します。

# rake db:migrate_plugins RAILS_ENV=production を実行します。

# 「ロールと権限」で各ロールにWiki Extensionsの権限設定をします。

# プロジェクトの設定で WikiExtension モジュールをチェックします。

h3. 注意

本プラグインはdevelopmentモードでは動きません。productionモードでお使いください。

h2. 脚注

文中に{{fn(脚注, ページの下部に表示される注釈)}}を埋め込むための{{fn(マクロ, wikiの書式を拡張する機能)}}です。

h3. 書式

{{@fn(単語, 説明)@}} のように書きます。例えば

*このサイトは{{@fn(Redmine, 最強のプロジェクト管理ツール)@}}です。*

と書くと、"このサイトは{{fn(Redmine, 最強のプロジェクト管理ツール)}}です。"となります。

脚注の一覧はページ下部に表示されます。

h2. コメント追加機能

wikiにコメントを書き込めるようにします。

h3. 書式

{{@comment_form@}} と書くととコメント追加のためのフォームを表示します。 {{@comments@}} と書くとそのページに書きこまれたコメントの一覧を表示します。

{{comments}}

{{comment_form}}

h3. コメントの通知

{{new(2011-09-23)}}

Wiki にコメントが追加された場合に、そのwikiページをウォッチしている人にメールで通知します。「管理」→「設定」→「メール通知」で設定を行ってください。

h2. 他のプロジェクトのwikiページにリンクを張る

{{new(2009-06-11)}}

他のプロジェクト上のwikiページへのリンクを埋め込むことができます。

h3. 書式

* @{{wiki(プロジェクト名, ページ名)}}@

* @{{wiki(プロジェクト識別子, ページ名)}}@

また、{{wiki(プロジェクト名, ページ名, エイリアス)}} のようにエイリアスを指定することで表示する文字を変えることができます。

h2. 他のプロジェクトにリンクを張る

{{new(2009-06-11)}}

他のプロジェクトの概要ページへのリンクを埋め込むことができます。

h3. 書式

* @{{project(プロジェクト名)}}@

* @{{project(プロジェクト識別子)}}@

また、{{project(プロジェクト名, エイリアス)}} のようにエイリアスを指定することで表示する文字を変えることができます。

例)

Wiki Extensionsの開発プロジェクトは{{@project(Wiki Extensions, ここ)@}}です。

と書くと以下のようになります。

Wiki Extensionsの開発プロジェクトは{{project(Wiki Extensions, ここ)}}です。

h2. 更新情報を表示する

{{new(2009-06-12)}}

h3. 書式

* {{@new(yyyy-mm-dd)@}}

* {{@new(yyyy-mm-dd, expire)@}}

指定した日からexpireで指定した日付が経過していなければ"new"という文字列を表示します。expireのデフォルトは5日です。

h2. タグを入力する

{{new(2009-06-23)}}

wikiの編集画面下部にタグ入力フィールドがあります。ここでページにタグを設定できます。タグは複数設定できます。

{{@tagcloud@}} と入力するとタグクラウドを表示できます。[[SideBar]]に書いておくとよいでしょう。

{{@taggedpages(タグ名)@}} と入力すると指定されたタグを付けられたページの一覧を表示します。{{new(2010-10-05)}}

{{@taggedpages(タグ名1[,タグ名2.., タグ名n], プロジェクト名)@}}と入力すると指定されたプロジェクト内で指定されたタグを付けられたページの一覧を表示します。{{new(2010-12-06)}}

h2. スタイルシートを編集する

{{new(2009-07-16)}}

[[StyleSheet]] というページを作成し、CSSの記述をしておくとそれをHTMLヘッダ部分に読み込みます。

このスタイルはWikiだけでなくすべてのページで読み込まれます。なので[[プロジェクト毎にテーマを変える]]ようなことも可能です。

h2. Footer

{{new(2009-08-04)}}

Footerというページを作ると、すべてのwikiページの下部にFooterの内容を読み込みます。

Footerに以下の内容を書くと、すべてのwikiページにコメントフォームを追加できます。

{{@comments@}}

{{@comment_form@}}

h2. 最近更新されたページ一覧

{{new(2009-08-04)}}

{{@recent@}} と書くと、過去5日間に更新されたページの一覧を表示します。{{@recent(10)@}} のように、引数で数字を指定すると、その日数以内に更新されたページの一覧を表示します。

SideBarに記述しておくとよいでしょう。

h2. 更新者を表示する

{{new(2009-09-06,14)}}

{{@lastupdated_by@}} と書くと、そのページの最終更新者の名前を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新者の名前を表示できます。

h2. 更新時刻を表示する

{{new(2009-09-06,14)}}

{{@lastupdated_at@}} と書くと、そのページの最終更新時刻を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新時刻を表示できます。

h2. 任意のwikiページをプロジェクトメニューのタブに追加する

{{new(2009-09-06,14)}}

プロジェクトメニューにwikiページへのリンクをタブとして追加できるようになりました。

プロジェクト設定ページで設定できます。

!setting.jpg!

以下のようにメニューが追加されます。

!menu.jpg!

h2. 任意のwebページをwikiページ内に表示する

{{new(2009-10-08,14)}}

iframeを使用して外部のwebページをwikiページ内に表示します。

h3. 書式

{{@iframe(url)@}} 、

{{@iframe(url, width, height)@}} もしくは 

{{@iframe(url, width, height, scrolling)@}} のように書きます。

urlには表示対象ページのURLを指定します。　width, heightにはそれぞれ表示幅と高さを指定します。scrollingにはiframeのscrollingオプションを指定します。yesならスクロールあり、noならスクロールなし、autoなら自動判定です。デフォルトはautoです。

h3. 例

wikiペディアの内容を表示する例です。

{{@iframe(http://ja.wikipedia.org/wiki/Redmine, 700, 400)@}}

{{iframe(http://ja.wikipedia.org/wiki/Redmine, 700, 400)}}

h2. アクセスカウンタ

{{new(2009-10-31,14)}}

wikiにアクセスカウンタを付けることができます。

アクセス数をカウントしたいページに {{@count@}} を埋め込んでください。すべてのページのアクセス数をカウントしたい場合には[[Footer]]ページに {{@count@}} を埋め込んでください。

{{@show_count@}} マクロを使用すると、そのページのアクセス数を表示することができます。

{{@popularity@}} マクロを使用すると、アクセス数のリストを降順に表示します。引数で数字を指定するとそのアクセス数の上位指定数分表示します。

h2. オートプレビュー

{{new(2010-02-02,14)}}

wiki, フォーラム, および チケット入力時のプレビューを自動表示することができます。

デフォルトではオフになっているのでプロジェクト設定画面でオートプレビューにチェックを入れてください。

!autopreview.png!

h2. テーブルのソート

{{new(2010-10-05)}}

テーブルのヘッダをクリックしてソートを可能にします。

例)

<pre>

|_.果物|_.色|

|リンゴ|あか|

|バナナ|きいろ|

|メロン|みどり|

</pre>

|_.果物|_.色|

|リンゴ|あか|

|バナナ|きいろ|

|メロン|みどり|

h2. twitter マクロ

{{new(2010-10-05)}}

{{@twitter(ユーザ名)@}} でtiwtterのアカウントページへのリンクを埋め込みます。

例) {{@twitter(haru_iida)@}} と書くと {{twitter(haru_iida)}} となります。

h3. vote マクロ

{{new(2010-12-6)}}

{{@vote(key)@}} と書くと投票用リンクを作成します。keyにはそのページ内で一意となるキーを指定してください。

例)

りんご {{@vote(apple)@}}

レモン {{@vote(remon)@}}

バナナ {{@vote(banana)@}}

と書くと以下のようになります。

りんご {{vote(apple)}}

レモン {{vote(lemon)}}

バナナ {{vote(banana)}}

{{@vote(key,label)@}}と書くと"投票"という文字列の変わりにラベルで指定した文字列を表示します。

例)

{{@vote(apple2, りんご)@}}

{{@vote(lemon2, レモン)@}}

{{@vote(banana2, バナナ)@}}

と書くと以下のようになります。

{{vote(apple2, りんご)}}

{{vote(lemon2, レモン)}}

{{vote(banana2, バナナ)}}

h2. チケットリストの表示

チケットのカスタムクエリをwikiの中に表示します。

また、チケットの題名または説明にキーワードが書かれているチケットを検索して一覧表示します。

キーワードの指定が無い場合はwikiページのタイトル(及び別名)またはチケット番号表記をキーワードとしてチケット検索を行います。

h3. 書式

{{@ref_issues([options]..., [column]...)@}}

*options:* ハイフン(-)に続けて以下のアルファベットで指定します。

* -i=[CustomQueryID] : 表示項目および絞り込み条件にカスタムクエリの内容を使用します。

* -q=[CustomQuery名] : 表示項目および絞り込み条件にカスタムクエリの内容を使用します。

* -s=[WORDs] : 題名(subject)にキーワードを含むチケットに表示を絞り込みます。

* -d=[WORDs] : 説明(description)にキーワードを含むチケットに表示を絞り込みます。

* -w=[WORDs] : 題名または説明にキーワードを含むチケットに表示を絞り込みます。

* -p : 同一プロジェクト内のチケットのみ表示します。

絞り込み条件を複数記述した場合はAND条件となります。

WORDsは'|'で区切ることで複数のワードのOR条件を指定できます。

絞り込み条件の指定が無い場合はWikiページ名またはチケット番号が検索キーワードに使われます

*column:* 表示する列を指定します。

省略した場合はカスタムクエリで指定した列が表示されます。

* project : プロジェクト

* tracker : トラッカー

* parent : 親チケット

* status : ステータス

* priority : 優先度

* subject : 題名

* author : 作成者

* assigned_to : 担当者

* updated_on : 更新日

* category : カテゴリ

* fixed_version : 対象バージョン

* start_date : 開始日

* due_date : 期日

* estimated_hours : 予定工数

* done_ratio : 進捗％

* created : 作成日

h3. 例

{{@ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)@}}

{{ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)}}

{{@ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)@}}

{{ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)}}

h2. エモーティコン(顔文字)

{{new(2011-01-02)}}

Wiki編集時にメニューバーからエモーティコンを追加できます。:)

!emoticons.png!

また、任意のエモーティコンを追加できます。追加は以下の手順で行います。

# プラグインディレクトリのconfig/emocitons.ymlに定義を追加します。

# assets/imagesの下に画像ファイルを置きます。

# Redmineを再起動します。

h2. new_page マクロ

{{new(2011-09-23,14)}}

{{@new_page@}}と書くと新しいwikiページを作成するためのリンクを表示します。サイドバーの上辺りに入れておくと新規ページ作成が楽になります。