プロジェクト

全般

プロフィール

Wiki Extensions » 履歴 » バージョン 64

Haru Iida, 2011/01/03 16:05

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