プロジェクト

全般

プロフィール

Wiki Extensions en » 履歴 » バージョン 51

Haru Iida, 2011/09/23 16:23

1 1 Haru Iida
h1. Redmine Wiki Extensions Plugin
2
3
{{>toc}}
4
5 27 Haru Iida
日本語は [[Wiki Extensions|こちら]].
6
7 4 Haru Iida
This plugin adds usefull wiki macros into your Redmine.
8 1 Haru Iida
9
h2. Downloads
10
11 41 Haru Iida
"bitbucket":https://bitbucket.org/haru_iida/redmine_wiki_extensions/downloads
12 1 Haru Iida
13 17 Haru Iida
h3. Installation
14
15
# Copy the plugin into the vendor/plugins directory
16
# Migrate plugin: rake db:migrate_plugins RAILS_ENV=production
17
# Start Redmine
18 18 Haru Iida
# Enable the module on the project setting page.
19 1 Haru Iida
20
h2. Footnote
21
22 11 Haru Iida
This macro creates {{fn(footnotes, Notes of text placed at the bottom of a page.)}} in wiki pages.
23 1 Haru Iida
24 2 Haru Iida
h3. Syntacs
25 1 Haru Iida
26 34 Haru Iida
{{@fn(word, description)@}}: 
27 2 Haru Iida
28
ex.
29 1 Haru Iida
30
31 34 Haru Iida
*This site is {{@fn(Redmine, One of the best project management tool.)@}} site.*
32
33
34 2 Haru Iida
"This site is {{fn(Redmine, One of the best project management tool.)}} site."
35 1 Haru Iida
36 12 Haru Iida
You can see footnotes on the bottom of this page.
37 1 Haru Iida
38 15 Haru Iida
h2. Adding comment form
39 1 Haru Iida
40 4 Haru Iida
You can add a comment form in a page.
41 1 Haru Iida
42 4 Haru Iida
h3. Syntacs
43 1 Haru Iida
44 34 Haru Iida
{{@comment_form@}} displays the comment form in a page. And {{@comments@}} macro displays the list of comment.
45 1 Haru Iida
46
{{comments}}
47
{{comment_form}}
48
49
50 15 Haru Iida
h2. Link to the page of other projects.
51 1 Haru Iida
52 14 Haru Iida
{{new(2009-06-11)}}
53
54 5 Haru Iida
You can create the link to the page of other projects.
55 1 Haru Iida
56 5 Haru Iida
h3. Syntacs
57 1 Haru Iida
58 5 Haru Iida
* @{{wiki(project_name, wiki_page)}}@
59
* @{{wiki(project_name, wiki_page, alias)}}@
60
* @{{wiki(project_identifier, wiki_page)}}@
61
* @{{wiki(project_identifier, wiki_page, alias)}}@
62 1 Haru Iida
63
64 5 Haru Iida
h2. Link to other projects
65 14 Haru Iida
66
67
{{new(2009-06-11)}}
68 1 Haru Iida
69 5 Haru Iida
You can create the link to projects.
70 1 Haru Iida
71 5 Haru Iida
h3. Syntacs
72 1 Haru Iida
73 5 Haru Iida
* @{{project(project_name)}}@
74
* @{{project(project_name, alias)}}@
75 1 Haru Iida
* @{{project(project_identifier)}}@
76 5 Haru Iida
* @{{project(project_identifier, alias)}}@
77 1 Haru Iida
78
79 5 Haru Iida
ex.)
80 1 Haru Iida
81 34 Haru Iida
*The project of Wiki Extensions Plugin is {{@project(Wiki Extensions, here)@}}.*
82
83
84 1 Haru Iida
"The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}."
85 13 Haru Iida
86
h2. New macro
87
88
{{new(2009-06-12)}}
89
90
h3. Syntacs
91
92 32 Haru Iida
* {{@new(yyyy-mm-dd)@}}
93
* {{@new(yyyy-mm-dd, expire)@}}
94 1 Haru Iida
95
96 15 Haru Iida
Displays the string "new" if specific date does not expired. Default of expire is 5 days.
97
98
h2. Tags
99
100 16 Haru Iida
{{new(2009-06-23)}}
101
102 1 Haru Iida
You can see the tag input form at the bottom of the wiki editing page. You can add several tags to each wiki pages. 
103 15 Haru Iida
104
And {{@tagcloud@}} macro displays the tag cloud. so you can write this macro into [[SideBar]] like this site.
105 34 Haru Iida
106 38 Haru Iida
{{@taggedpages(tagname)@}} macro displays the list of pages which have specified tag.{{new(2010-10-05)}}
107 35 Haru Iida
108 46 Haru Iida
{{@taggedpages(tagname1[,tagname2..,tagnamen], project)@}} macro displays the list of pages of project which have specified tags.{{new(2010-12-06)}}
109 39 Haru Iida
110
111 20 Haru Iida
h2. Editing Style Sheet
112
113
{{new(2009-07-16)}}
114
115
You can write CSS in the page named [[StyleSheet]]. This CSS is included in a HTML header of each page. Each page means every module of the project. not only wiki.
116
So. you can even create a project-specific theme.
117 1 Haru Iida
118 20 Haru Iida
And if you want to change a style of a part of the page, you can use following macros.
119
120 1 Haru Iida
* {{@div_start_tag(id_name)@}} is changed to、< div id="id_name">.
121 32 Haru Iida
* {{@div_start_tag(id_name, class_name)@}} is changed to< div id="id_name" class="class_name">.
122
* {{@div_end_tag@}} is changed to < /div>.
123 20 Haru Iida
124
ex.
125
126
127 34 Haru Iida
{{@div_start_tag(sample_tag)@}}
128
129 20 Haru Iida
Style of this line was changed.
130
131 34 Haru Iida
{{@div_end_tag@}}
132 20 Haru Iida
133 34 Haru Iida
134 1 Haru Iida
{{div_start_tag(sample_tag)}}
135
136 20 Haru Iida
Style of this line was changed.
137
138
{{div_end_tag}}
139
140 21 Haru Iida
h2. Footer
141
142
{{new(2009-08-04)}}
143
144
If you create the page named "Footer", you can see it at the bottom of the every pages.
145 22 Haru Iida
146 21 Haru Iida
For example. If you want to add the comment form to every pages, you should write like below.
147
148 34 Haru Iida
{{@comments@}}
149
150
{{@comment_form@}}
151
152 51 Haru Iida
h3. Comment notification
153 34 Haru Iida
154 51 Haru Iida
{{new(2011-09-23)}}
155
156
Watchers of wiki page can get notification if comment was added. You can configure about notification at Adminitistion -> Settings -> Email notifications.
157
158
159 21 Haru Iida
h2. Recently added pages
160
161
{{new(2009-08-04)}}
162
163 33 Haru Iida
{{@recent@}} macro displays the list of the pages that were changed within last 5 days. If you specify the argument like {{@recent(10)@}}, it displays the pages that were changed within 10 days.
164 23 Haru Iida
165 24 Haru Iida
h2. Displays the person who updated the page. 
166 23 Haru Iida
167
{{new(2009-09-06,14)}}
168
169 33 Haru Iida
{{@lastupdated_by@}} macro displays the name of user who updated the wiki page.
170 23 Haru Iida
171 24 Haru Iida
h2. Displays the time when the page was updated.
172 23 Haru Iida
173
{{new(2009-09-06,14)}}
174
175 33 Haru Iida
{{@lastupdated_at@}} macrodisplays the timestamp when the wiki page was updated.
176 23 Haru Iida
177 25 Haru Iida
h2. Add tabs to project menu.
178 23 Haru Iida
179
{{new(2009-09-06,14)}}
180
181 26 Haru Iida
You can add project menu tabs that links to wiki page.
182 23 Haru Iida
183
!setting.jpg!
184
185
!menu.jpg!
186 28 Haru Iida
187 1 Haru Iida
h2. Displays the page of other site.
188
189 28 Haru Iida
190
{{new(2009-10-08,14)}}
191
192
iframe macro displays the page of other site into the wiki page.
193
194
h3. Syntacs
195 1 Haru Iida
196 35 Haru Iida
{{@iframe(url)@}}
197 32 Haru Iida
{{@iframe(url, width, height)@}} or
198
{{@iframe(url, width, height, scrolling)@}} 
199 28 Haru Iida
200
scrolling is a value of scrolling option of iframe.[yes, no, auto]
201
202
h3. example
203
204
Displaying wikipedia.
205
206
207 34 Haru Iida
{{@iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)@}}
208
209
210 28 Haru Iida
{{iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)}}
211 29 Haru Iida
212
h2. Access counter
213
214
{{new(2009-10-31,14)}}
215
216
217 34 Haru Iida
{{@count@}} macro counts acesses to the wiki pages. You can write this macro into the wiki page that you want to count accesses. If you want to count accesses to all of the pages, you can write {{@count@}} to the [[Footer]] page.
218 29 Haru Iida
219 32 Haru Iida
{{@show_count@}} macro displays the count of the page.
220 29 Haru Iida
221 32 Haru Iida
{{@popularity@}} macro displays the list of the access counts. If you specify the number in the argument, ex. {{@popularity(10)@}}, displays the top 10 access list.
222 30 Haru Iida
223
h2. Auto preview
224
225
{{new(2010-02-02,14)}}
226 1 Haru Iida
227 35 Haru Iida
If you enabled this function, preview of wiki, forum and issue is displayed automatically. You can enable it on project setting page.
228 31 Haru Iida
229 1 Haru Iida
!autopreview.png!
230 35 Haru Iida
231
h2. Sortable table
232
233
{{new(2010-10-05)}}
234
235 37 Haru Iida
You can sort table items by clicking header.
236 35 Haru Iida
237 36 Haru Iida
ex)
238
239
<pre>
240
|_.fruits|_.color|
241
|Apple|Red|
242
|Banana|Yellow|
243
|Mellon|Green|
244
</pre>
245
246 35 Haru Iida
|_.fruits|_.color|
247
|Apple|Red|
248
|Banana|Yellow|
249
|Mellon|Green|
250
251
h2. twitter macro
252
253
{{new(2010-10-05)}}
254
255
{{@twitter(username)@}} macro links to tiwtter page.
256
257
ex.) {{@twitter(haru_iida)@}} -> {{twitter(haru_iida)}} 
258 39 Haru Iida
259
h3. vote macro
260
261
{{new(2010-12-6)}}
262
263
{{@vote(key)@}} macro displays a link for vote. You must specify a "key" which is unique in the page.
264
ex.)
265
266
APPLE {{@vote(apple)@}}
267
268
LEMON {{@vote(lemon)@}}
269
270
BANANA {{@vote(banana)@}}
271
272
to
273
274
APPLE {{vote(apple)}}
275
276
LEMON {{vote(lemon)}}
277
278
BANANA {{vote(banana)}}
279
280
{{@vote(key,label)@}} displays label insteadof string "vote".
281
282
ex.)
283
284
{{@vote(apple2, I like apples.)@}}
285
286
{{@vote(lemon2, I like lemons.)@}}
287
288
{{@vote(banana2, I like bananas.)@}}
289
290 40 Haru Iida
to
291 39 Haru Iida
292
{{vote(apple2, I like apples.)}}
293
294
{{vote(lemon2, I like lemons.)}}
295
296
{{vote(banana2, I like bananas.)}}
297 42 Haru Iida
298 47 Haru Iida
h2. List issues
299 42 Haru Iida
300 47 Haru Iida
{{new(2011-01-19)}}
301 1 Haru Iida
302 47 Haru Iida
ref_issues macro displays list of issues.
303
You can use custom query or keyword for selecting issues.
304 42 Haru Iida
305 47 Haru Iida
306 44 Haru Iida
h3. Syntacs
307 1 Haru Iida
308
{{@ref_issues([options]..., [column]...)@}}
309
310 47 Haru Iida
*options:* 
311 1 Haru Iida
312 50 Tomohisa Kusukawa
* -i=[CustomQuery ID]: ID of custom query.
313 47 Haru Iida
* -q=[CustomQuery name]: Name of custom query.
314 49 Tomohisa Kusukawa
* -s=[WORDs] : select issues that contain WORDs in subject. 
315
* -d=[WORDs] : select issues that contain WORDs in description. 
316
* -w=[WORDs] : select issues that contain WORDs in subject or description.
317 47 Haru Iida
* -p : Only the issues in the same project is displayed. 
318 1 Haru Iida
319 49 Tomohisa Kusukawa
You can specify two or more select option, it affect AND condition.
320
WORDs is one or more search words divided by '|', and multiple words affect OR condition.
321
If you specify no select condition, page name of wiki or number of issue is used for search word.
322
323 47 Haru Iida
*columns:* 
324
You can choose columns that you want to display.
325
If you do not specify the columns, same columns with customquery are displayed.
326 1 Haru Iida
327 47 Haru Iida
* project
328
* tracker
329
* parent
330
* status
331
* priority
332
* subject
333
* author
334
* assigned_to
335
* updated_on
336
* category
337
* fixed_version
338
* start_date
339
* due_date
340 1 Haru Iida
* estimated_hours
341
* done_ratio
342
* created
343 47 Haru Iida
344
h3. example
345
346 49 Tomohisa Kusukawa
{{@ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)@}}
347
{{ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)}}
348 47 Haru Iida
349 49 Tomohisa Kusukawa
350
{{@ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)@}}
351
{{ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)}}
352 47 Haru Iida
353 45 Haru Iida
354 43 Haru Iida
h2. Emoticons
355
356
{{new(2011-01-02)}}
357
358
You can add emoticons to wiki page.:)
359
360
!emoticons.png!
361
362 1 Haru Iida
You can also use your original emoticons.
363
364
# Edit redmine_wiki_extensions/config/emocitons.yml
365
# Put your emoticon image into redmine_wiki_extensions/assets/images.
366
# Restart redmine.
367 51 Haru Iida
368
h2. new_page macro
369
370
371
{{new(2011-09-23,14)}}
372
373
{{@new_page@}} macro shows link for creating a new wiki page. You could put this macro on a side bar.