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