Project

General

Profile

Wiki Extensions » History » Version 53

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