プロジェクト

全般

プロフィール

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

Haru Iida, 2010/12/07 00:13

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
h3. Releases
12
13 19 Haru Iida
http://code.google.com/p/redminewikiext/downloads/list
14 1 Haru Iida
15
h3. Development version
16
17
http://hudson.r-labs.org/hudson/job/Wiki%20Extensions%20Plugin/
18
19 17 Haru Iida
h3. Installation
20
21
# Copy the plugin into the vendor/plugins directory
22
# Migrate plugin: rake db:migrate_plugins RAILS_ENV=production
23
# Start Redmine
24 18 Haru Iida
# Enable the module on the project setting page.
25 1 Haru Iida
26
h2. Footnote
27
28 11 Haru Iida
This macro creates {{fn(footnotes, Notes of text placed at the bottom of a page.)}} in wiki pages.
29 1 Haru Iida
30 2 Haru Iida
h3. Syntacs
31 1 Haru Iida
32 34 Haru Iida
{{@fn(word, description)@}}: 
33 2 Haru Iida
34
ex.
35 1 Haru Iida
36
37 34 Haru Iida
*This site is {{@fn(Redmine, One of the best project management tool.)@}} site.*
38
39
40 2 Haru Iida
"This site is {{fn(Redmine, One of the best project management tool.)}} site."
41 1 Haru Iida
42 12 Haru Iida
You can see footnotes on the bottom of this page.
43 1 Haru Iida
44 15 Haru Iida
h2. Adding comment form
45 1 Haru Iida
46 4 Haru Iida
You can add a comment form in a page.
47 1 Haru Iida
48 4 Haru Iida
h3. Syntacs
49 1 Haru Iida
50 34 Haru Iida
{{@comment_form@}} displays the comment form in a page. And {{@comments@}} macro displays the list of comment.
51 1 Haru Iida
52
{{comments}}
53
{{comment_form}}
54
55
56 15 Haru Iida
h2. Link to the page of other projects.
57 1 Haru Iida
58 14 Haru Iida
{{new(2009-06-11)}}
59
60 5 Haru Iida
You can create the link to the page of other projects.
61 1 Haru Iida
62 5 Haru Iida
h3. Syntacs
63 1 Haru Iida
64 5 Haru Iida
* @{{wiki(project_name, wiki_page)}}@
65
* @{{wiki(project_name, wiki_page, alias)}}@
66
* @{{wiki(project_identifier, wiki_page)}}@
67
* @{{wiki(project_identifier, wiki_page, alias)}}@
68 1 Haru Iida
69
70 5 Haru Iida
h2. Link to other projects
71 14 Haru Iida
72
73
{{new(2009-06-11)}}
74 1 Haru Iida
75 5 Haru Iida
You can create the link to projects.
76 1 Haru Iida
77 5 Haru Iida
h3. Syntacs
78 1 Haru Iida
79 5 Haru Iida
* @{{project(project_name)}}@
80
* @{{project(project_name, alias)}}@
81 1 Haru Iida
* @{{project(project_identifier)}}@
82 5 Haru Iida
* @{{project(project_identifier, alias)}}@
83 1 Haru Iida
84
85 5 Haru Iida
ex.)
86 1 Haru Iida
87 34 Haru Iida
*The project of Wiki Extensions Plugin is {{@project(Wiki Extensions, here)@}}.*
88
89
90 1 Haru Iida
"The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}."
91 13 Haru Iida
92
h2. New macro
93
94
{{new(2009-06-12)}}
95
96
h3. Syntacs
97
98 32 Haru Iida
* {{@new(yyyy-mm-dd)@}}
99
* {{@new(yyyy-mm-dd, expire)@}}
100 1 Haru Iida
101
102 15 Haru Iida
Displays the string "new" if specific date does not expired. Default of expire is 5 days.
103
104
h2. Tags
105
106 16 Haru Iida
{{new(2009-06-23)}}
107
108 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. 
109 15 Haru Iida
110
And {{@tagcloud@}} macro displays the tag cloud. so you can write this macro into [[SideBar]] like this site.
111 34 Haru Iida
112 38 Haru Iida
{{@taggedpages(tagname)@}} macro displays the list of pages which have specified tag.{{new(2010-10-05)}}
113 35 Haru Iida
114 39 Haru Iida
{{@taggedpages(tagname, project)@}} macro displays the list of pages of project which have specified tag.{{new(2010-12-06)}}
115
116
117 20 Haru Iida
h2. Editing Style Sheet
118
119
{{new(2009-07-16)}}
120
121
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.
122
So. you can even create a project-specific theme.
123 1 Haru Iida
124 20 Haru Iida
And if you want to change a style of a part of the page, you can use following macros.
125
126 1 Haru Iida
* {{@div_start_tag(id_name)@}} is changed to、< div id="id_name">.
127 32 Haru Iida
* {{@div_start_tag(id_name, class_name)@}} is changed to< div id="id_name" class="class_name">.
128
* {{@div_end_tag@}} is changed to < /div>.
129 20 Haru Iida
130
ex.
131
132
133 34 Haru Iida
{{@div_start_tag(sample_tag)@}}
134
135 20 Haru Iida
Style of this line was changed.
136
137 34 Haru Iida
{{@div_end_tag@}}
138 20 Haru Iida
139 34 Haru Iida
140 1 Haru Iida
{{div_start_tag(sample_tag)}}
141
142 20 Haru Iida
Style of this line was changed.
143
144
{{div_end_tag}}
145
146 21 Haru Iida
h2. Footer
147
148
{{new(2009-08-04)}}
149
150
If you create the page named "Footer", you can see it at the bottom of the every pages.
151 22 Haru Iida
152 21 Haru Iida
For example. If you want to add the comment form to every pages, you should write like below.
153
154 34 Haru Iida
{{@comments@}}
155
156
{{@comment_form@}}
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
と書くと以下のようになります。
291
292
{{vote(apple2, I like apples.)}}
293
294
{{vote(lemon2, I like lemons.)}}
295
296
{{vote(banana2, I like bananas.)}}