Project

General

Profile

Wiki Extensions » History » Version 57

Haru Iida, 12/07/2010 12:03 AM

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