Project

General

Profile

Wiki Extensions » History » Version 64

Haru Iida, 01/03/2011 04:05 PM

1 1 Haru Iida
h1. Redmine Wiki Extensions Plugin
2
3
{{>toc}}
4
5 15 Haru Iida
English page is [[Wiki Extensions en|here]].
6
7 1 Haru Iida
Redmineのwikiを拡張するプラグインです。
8 12 Haru Iida
開発プロジェクトは{{project(Wiki Extensions)}}です。
9 1 Haru Iida
10 9 Haru Iida
h2. ダウンロード
11
12 59 Haru Iida
"butbucket":https://bitbucket.org/haru_iida/redmine_wiki_extensions/downloads
13 9 Haru Iida
14 24 Haru Iida
h2. インストール
15
16
# プラグインをRedmineインストールフォルダの下の vendor/plugins に展開します。
17
# rake db:migrate_plugins RAILS_ENV=production を実行します。
18
# 「ロールと権限」で各ロールにWiki Extensionsの権限設定をします。
19
# プロジェクトの設定で WikiExtension モジュールをチェックします。
20 9 Haru Iida
21 33 Haru Iida
h3. 注意
22
23
本プラグインはdevelopmentモードでは動きません。productionモードでお使いください。
24
25
26 3 Haru Iida
h2. 脚注
27 2 Haru Iida
28 3 Haru Iida
文中に{{fn(脚注, ページの下部に表示される注釈)}}を埋め込むための{{fn(マクロ, wikiの書式を拡張する機能)}}です。
29 2 Haru Iida
30 4 Haru Iida
h3. 書式
31
32 48 Haru Iida
{{@fn(単語, 説明)@}} のように書きます。例えば
33 4 Haru Iida
34 48 Haru Iida
*このサイトは{{@fn(Redmine, 最強のプロジェクト管理ツール)@}}です。*
35
36
37 5 Haru Iida
と書くと、"このサイトは{{fn(Redmine, 最強のプロジェクト管理ツール)}}です。"となります。
38
39 17 Haru Iida
脚注の一覧はページ下部に表示されます。
40 2 Haru Iida
41 7 Haru Iida
h2. コメント追加機能
42 6 Haru Iida
43
wikiにコメントを書き込めるようにします。
44
45
h3. 書式
46
47 48 Haru Iida
{{@comment_form@}} と書くととコメント追加のためのフォームを表示します。 {{@comments@}} と書くとそのページに書きこまれたコメントの一覧を表示します。
48 6 Haru Iida
49
{{comments}}
50
{{comment_form}}
51
52 13 Haru Iida
53 8 Haru Iida
h2. 他のプロジェクトのwikiページにリンクを張る
54
55 20 Haru Iida
56
{{new(2009-06-11)}}
57
58 8 Haru Iida
他のプロジェクト上のwikiページへのリンクを埋め込むことができます。
59
60
h3. 書式
61 1 Haru Iida
62 13 Haru Iida
* @{{wiki(プロジェクト名, ページ名)}}@
63
* @{{wiki(プロジェクト識別子, ページ名)}}@
64 1 Haru Iida
65 47 Takashi Takebayashi
また、{{wiki(プロジェクト名, ページ名, エイリアス)}} のようにエイリアスを指定することで表示する文字を変えることができます。
66 13 Haru Iida
67
h2. 他のプロジェクトにリンクを張る
68 20 Haru Iida
69
{{new(2009-06-11)}}
70 13 Haru Iida
71
他のプロジェクトの概要ページへのリンクを埋め込むことができます。
72
73
h3. 書式
74
75
* @{{project(プロジェクト名)}}@
76
* @{{project(プロジェクト識別子)}}@
77
78 47 Takashi Takebayashi
また、{{project(プロジェクト名, エイリアス)}} のようにエイリアスを指定することで表示する文字を変えることができます。
79 13 Haru Iida
80
例)
81 56 Haru Iida
82
Wiki Extensionsの開発プロジェクトは{{@project(Wiki Extensions, ここ)@}}です。
83
84 13 Haru Iida
と書くと以下のようになります。
85 14 Haru Iida
86 13 Haru Iida
Wiki Extensionsの開発プロジェクトは{{project(Wiki Extensions, ここ)}}です。
87 18 Haru Iida
88
h2. 更新情報を表示する
89
90
{{new(2009-06-12)}}
91 19 Haru Iida
92
h3. 書式
93
94 48 Haru Iida
* {{@new(yyyy-mm-dd)@}}
95
* {{@new(yyyy-mm-dd, expire)@}}
96 19 Haru Iida
97
指定した日からexpireで指定した日付が経過していなければ"new"という文字列を表示します。expireのデフォルトは5日です。
98 21 Haru Iida
99
h2. タグを入力する
100
101 23 Haru Iida
{{new(2009-06-23)}}
102
103 21 Haru Iida
wikiの編集画面下部にタグ入力フィールドがあります。ここでページにタグを設定できます。タグは複数設定できます。
104
105 1 Haru Iida
{{@tagcloud@}} と入力するとタグクラウドを表示できます。[[SideBar]]に書いておくとよいでしょう。
106 48 Haru Iida
107 27 Haru Iida
{{@taggedpages(タグ名)@}} と入力すると指定されたタグを付けられたページの一覧を表示します。{{new(2010-10-05)}}
108 64 Haru Iida
{{@taggedpages(タグ名1[,タグ名2.., タグ名n], プロジェクト名)@}}と入力すると指定されたプロジェクト内で指定されたタグを付けられたページの一覧を表示します。{{new(2010-12-06)}}
109 52 Haru Iida
110 27 Haru Iida
h2. スタイルシートを編集する
111
112
{{new(2009-07-16)}}
113
114 31 Haru Iida
[[StyleSheet]] というページを作成し、CSSの記述をしておくとそれをHTMLヘッダ部分に読み込みます。
115 46 Haru Iida
このスタイルはWikiだけでなくすべてのページで読み込まれます。なので[[プロジェクト毎にテーマを変える]]ようなことも可能です。
116 29 Haru Iida
117 34 Haru Iida
118
h2. Footer
119
120
{{new(2009-08-04)}}
121
122
Footerというページを作ると、すべてのwikiページの下部にFooterの内容を読み込みます。
123
Footerに以下の内容を書くと、すべてのwikiページにコメントフォームを追加できます。
124
125 50 Haru Iida
126
{{@comments@}}
127
128
{{@comment_form@}}
129
130 34 Haru Iida
131
h2. 最近更新されたページ一覧
132
133
{{new(2009-08-04)}}
134
135 49 Haru Iida
{{@recent@}} と書くと、過去5日間に更新されたページの一覧を表示します。{{@recent(10)@}} のように、引数で数字を指定すると、その日数以内に更新されたページの一覧を表示します。
136 34 Haru Iida
SideBarに記述しておくとよいでしょう。
137 35 Haru Iida
138
h2. 更新者を表示する
139
140 36 Haru Iida
{{new(2009-09-06,14)}}
141 35 Haru Iida
142 49 Haru Iida
{{@lastupdated_by@}} と書くと、そのページの最終更新者の名前を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新者の名前を表示できます。
143 35 Haru Iida
144
h2. 更新時刻を表示する
145
146 36 Haru Iida
{{new(2009-09-06,14)}}
147 1 Haru Iida
148 49 Haru Iida
{{@lastupdated_at@}} と書くと、そのページの最終更新時刻を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新時刻を表示できます。
149 36 Haru Iida
150
h2. 任意のwikiページをプロジェクトメニューのタブに追加する
151
152
{{new(2009-09-06,14)}}
153
154
プロジェクトメニューにwikiページへのリンクをタブとして追加できるようになりました。
155
プロジェクト設定ページで設定できます。
156 37 Haru Iida
157
!setting.jpg!
158 38 Haru Iida
159
以下のようにメニューが追加されます。
160
161
!menu.jpg!
162 39 Haru Iida
163
h2. 任意のwebページをwikiページ内に表示する
164
165
166
{{new(2009-10-08,14)}}
167
168
iframeを使用して外部のwebページをwikiページ内に表示します。
169
170 40 Haru Iida
h3. 書式
171
172 52 Haru Iida
{{@iframe(url)@}} 、
173 49 Haru Iida
{{@iframe(url, width, height)@}} もしくは 
174
{{@iframe(url, width, height, scrolling)@}} のように書きます。
175 40 Haru Iida
176
urlには表示対象ページのURLを指定します。 width, heightにはそれぞれ表示幅と高さを指定します。scrollingにはiframeのscrollingオプションを指定します。yesならスクロールあり、noならスクロールなし、autoなら自動判定です。デフォルトはautoです。
177 1 Haru Iida
178 41 Haru Iida
h3. 例
179 40 Haru Iida
180
wikiペディアの内容を表示する例です。
181
182
183 49 Haru Iida
{{@iframe(http://ja.wikipedia.org/wiki/Redmine, 700, 400)@}}
184
185
186 40 Haru Iida
{{iframe(http://ja.wikipedia.org/wiki/Redmine, 700, 400)}}
187 42 Haru Iida
188
h2. アクセスカウンタ
189
190
{{new(2009-10-31,14)}}
191
192
wikiにアクセスカウンタを付けることができます。
193 49 Haru Iida
アクセス数をカウントしたいページに {{@count@}} を埋め込んでください。すべてのページのアクセス数をカウントしたい場合には[[Footer]]ページに {{@count@}} を埋め込んでください。
194 42 Haru Iida
195 49 Haru Iida
{{@show_count@}} マクロを使用すると、そのページのアクセス数を表示することができます。
196 42 Haru Iida
197
198 49 Haru Iida
{{@popularity@}} マクロを使用すると、アクセス数のリストを降順に表示します。引数で数字を指定するとそのアクセス数の上位指定数分表示します。
199 43 Haru Iida
200
h2. オートプレビュー
201
202 44 Haru Iida
203
{{new(2010-02-02,14)}}
204
205 51 Haru Iida
wiki, フォーラム, および チケット入力時のプレビューを自動表示することができます。
206 43 Haru Iida
デフォルトではオフになっているのでプロジェクト設定画面でオートプレビューにチェックを入れてください。
207 45 Haru Iida
208 1 Haru Iida
!autopreview.png!
209 51 Haru Iida
210
h2. テーブルのソート
211
212
{{new(2010-10-05)}}
213
214
テーブルのヘッダをクリックしてソートを可能にします。
215
216 53 Haru Iida
例)
217
218
<pre>
219
|_.果物|_.色|
220
|リンゴ|あか|
221
|バナナ|きいろ|
222
|メロン|みどり|
223
</pre>
224
225 51 Haru Iida
|_.果物|_.色|
226
|リンゴ|あか|
227
|バナナ|きいろ|
228
|メロン|みどり|
229 52 Haru Iida
230
h2. twitter マクロ
231
232
{{new(2010-10-05)}}
233
234 1 Haru Iida
{{@twitter(ユーザ名)@}} でtiwtterのアカウントページへのリンクを埋め込みます。
235
236
例) {{@twitter(haru_iida)@}} と書くと {{twitter(haru_iida)}} となります。
237 56 Haru Iida
238
h3. vote マクロ
239
240
{{new(2010-12-6)}}
241
242
{{@vote(key)@}} と書くと投票用リンクを作成します。keyにはそのページ内で一意となるキーを指定してください。
243
244
例)
245
246
りんご {{@vote(apple)@}}
247
248
レモン {{@vote(remon)@}}
249
250
バナナ {{@vote(banana)@}}
251
252
と書くと以下のようになります。
253
254
りんご {{vote(apple)}}
255
256
レモン {{vote(lemon)}}
257
258
バナナ {{vote(banana)}}
259
260
{{@vote(key,label)@}}と書くと"投票"という文字列の変わりにラベルで指定した文字列を表示します。
261
262
例)
263
264 57 Haru Iida
{{@vote(apple2, りんご)@}}
265 56 Haru Iida
266 57 Haru Iida
{{@vote(lemon2, レモン)@}}
267 56 Haru Iida
268 57 Haru Iida
{{@vote(banana2, バナナ)@}}
269 56 Haru Iida
270
と書くと以下のようになります。
271
272 57 Haru Iida
{{vote(apple2, りんご)}}
273 56 Haru Iida
274 57 Haru Iida
{{vote(lemon2, レモン)}}
275 56 Haru Iida
276 57 Haru Iida
{{vote(banana2, バナナ)}}
277 60 Haru Iida
278
279
h2. キーワードを含むチケットの一覧表示
280
281
{{new(2010-12-28)}}
282
283
チケットの題名または説明にキーワードが書かれているチケットを検索して一覧表示します。
284
キーワードの指定が無い場合はwikiページのタイトル(及び別名)またはチケット番号表記をキーワードとして検索を行います。
285
286
h3. 書式
287
288
{{@ref_issues([options]..., [column]...)@}}
289
290
options: ハイフン(-)に続けて以下のアルファベットで指定します
291
292
* -S : 題名(subject)を検索対象としない
293
* -D : 説明(description)を検索対象としない
294
* -l : wikiリンク表記のみを検索します
295
* -p : 同一プロジェクト内のチケットのみ表示します
296
* -r : チケット番号の降順で表示します
297
* -w=[search word]: 検索するキーワードを指定します
298
299
column: 表示する列を指定します。
300
301
* project : プロジェクト名
302
* tracker : トラッカー名
303
* subject : 題名
304
* status : 状態
305
* author : 作成者
306
* assigned : 担当者
307
* created : 作成日時
308
* updated : 更新日時
309
310
h3. 例
311
312
{{@ref_issues(-rw=抽出,project,tracker,subject,status,author,assigned,created,updated)@}}
313
314
{{ref_issues(-rw=抽出,project,tracker,subject,status,author,assigned,created,updated)}}
315 61 Haru Iida
316 62 Haru Iida
h2. エモーティコン(顔文字)
317 61 Haru Iida
318
{{new(2011-01-02)}}
319
320 63 Haru Iida
Wiki編集時にメニューバーからエモーティコンを追加できます。:)
321 61 Haru Iida
322
!emoticons.png!
323
324
また、任意のエモーティコンを追加できます。追加は以下の手順で行います。
325
326
# プラグインディレクトリのconfig/emocitons.ymlに定義を追加します。
327
# assets/imagesの下に画像ファイルを置きます。
328
# Redmineを再起動します。