Project

General

Profile

Wiki Extensions » History » Version 72

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