Wiki Extensions en » 履歴 » バージョン 43
Haru Iida, 2011/01/02 01:50
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 | 39 | Haru Iida | {{@taggedpages(tagname, project)@}} macro displays the list of pages of project which have specified tag.{{new(2010-12-06)}} |
109 | |||
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 | |||
153 | 21 | Haru Iida | h2. Recently added pages |
154 | |||
155 | {{new(2009-08-04)}} |
||
156 | |||
157 | 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. |
158 | 23 | Haru Iida | |
159 | 24 | Haru Iida | h2. Displays the person who updated the page. |
160 | 23 | Haru Iida | |
161 | {{new(2009-09-06,14)}} |
||
162 | |||
163 | 33 | Haru Iida | {{@lastupdated_by@}} macro displays the name of user who updated the wiki page. |
164 | 23 | Haru Iida | |
165 | 24 | Haru Iida | h2. Displays the time when the page was updated. |
166 | 23 | Haru Iida | |
167 | {{new(2009-09-06,14)}} |
||
168 | |||
169 | 33 | Haru Iida | {{@lastupdated_at@}} macrodisplays the timestamp when the wiki page was updated. |
170 | 23 | Haru Iida | |
171 | 25 | Haru Iida | h2. Add tabs to project menu. |
172 | 23 | Haru Iida | |
173 | {{new(2009-09-06,14)}} |
||
174 | |||
175 | 26 | Haru Iida | You can add project menu tabs that links to wiki page. |
176 | 23 | Haru Iida | |
177 | !setting.jpg! |
||
178 | |||
179 | !menu.jpg! |
||
180 | 28 | Haru Iida | |
181 | 1 | Haru Iida | h2. Displays the page of other site. |
182 | |||
183 | 28 | Haru Iida | |
184 | {{new(2009-10-08,14)}} |
||
185 | |||
186 | iframe macro displays the page of other site into the wiki page. |
||
187 | |||
188 | h3. Syntacs |
||
189 | 1 | Haru Iida | |
190 | 35 | Haru Iida | {{@iframe(url)@}} |
191 | 32 | Haru Iida | {{@iframe(url, width, height)@}} or |
192 | {{@iframe(url, width, height, scrolling)@}} |
||
193 | 28 | Haru Iida | |
194 | scrolling is a value of scrolling option of iframe.[yes, no, auto] |
||
195 | |||
196 | h3. example |
||
197 | |||
198 | Displaying wikipedia. |
||
199 | |||
200 | |||
201 | 34 | Haru Iida | {{@iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)@}} |
202 | |||
203 | |||
204 | 28 | Haru Iida | {{iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)}} |
205 | 29 | Haru Iida | |
206 | h2. Access counter |
||
207 | |||
208 | {{new(2009-10-31,14)}} |
||
209 | |||
210 | |||
211 | 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. |
212 | 29 | Haru Iida | |
213 | 32 | Haru Iida | {{@show_count@}} macro displays the count of the page. |
214 | 29 | Haru Iida | |
215 | 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. |
216 | 30 | Haru Iida | |
217 | h2. Auto preview |
||
218 | |||
219 | {{new(2010-02-02,14)}} |
||
220 | 1 | Haru Iida | |
221 | 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. |
222 | 31 | Haru Iida | |
223 | 1 | Haru Iida | !autopreview.png! |
224 | 35 | Haru Iida | |
225 | h2. Sortable table |
||
226 | |||
227 | {{new(2010-10-05)}} |
||
228 | |||
229 | 37 | Haru Iida | You can sort table items by clicking header. |
230 | 35 | Haru Iida | |
231 | 36 | Haru Iida | ex) |
232 | |||
233 | <pre> |
||
234 | |_.fruits|_.color| |
||
235 | |Apple|Red| |
||
236 | |Banana|Yellow| |
||
237 | |Mellon|Green| |
||
238 | </pre> |
||
239 | |||
240 | 35 | Haru Iida | |_.fruits|_.color| |
241 | |Apple|Red| |
||
242 | |Banana|Yellow| |
||
243 | |Mellon|Green| |
||
244 | |||
245 | h2. twitter macro |
||
246 | |||
247 | {{new(2010-10-05)}} |
||
248 | |||
249 | {{@twitter(username)@}} macro links to tiwtter page. |
||
250 | |||
251 | ex.) {{@twitter(haru_iida)@}} -> {{twitter(haru_iida)}} |
||
252 | 39 | Haru Iida | |
253 | h3. vote macro |
||
254 | |||
255 | {{new(2010-12-6)}} |
||
256 | |||
257 | {{@vote(key)@}} macro displays a link for vote. You must specify a "key" which is unique in the page. |
||
258 | ex.) |
||
259 | |||
260 | APPLE {{@vote(apple)@}} |
||
261 | |||
262 | LEMON {{@vote(lemon)@}} |
||
263 | |||
264 | BANANA {{@vote(banana)@}} |
||
265 | |||
266 | to |
||
267 | |||
268 | APPLE {{vote(apple)}} |
||
269 | |||
270 | LEMON {{vote(lemon)}} |
||
271 | |||
272 | BANANA {{vote(banana)}} |
||
273 | |||
274 | {{@vote(key,label)@}} displays label insteadof string "vote". |
||
275 | |||
276 | ex.) |
||
277 | |||
278 | {{@vote(apple2, I like apples.)@}} |
||
279 | |||
280 | {{@vote(lemon2, I like lemons.)@}} |
||
281 | |||
282 | {{@vote(banana2, I like bananas.)@}} |
||
283 | |||
284 | 40 | Haru Iida | to |
285 | 39 | Haru Iida | |
286 | {{vote(apple2, I like apples.)}} |
||
287 | |||
288 | {{vote(lemon2, I like lemons.)}} |
||
289 | |||
290 | {{vote(banana2, I like bananas.)}} |
||
291 | 42 | Haru Iida | |
292 | h2. List issues which includes keyword |
||
293 | |||
294 | {{new(2010-12-26)}} |
||
295 | |||
296 | List issues which have keyword in each subject or description. |
||
297 | If you don't specify keword, wiki page title is used for keyword. |
||
298 | |||
299 | h3. 書式 |
||
300 | |||
301 | {{@ref_issues([options]..., [column]...)@}} |
||
302 | |||
303 | options: |
||
304 | |||
305 | * -S : The subjects are not retrieved. |
||
306 | * -D : The descriptions are not retrieved. |
||
307 | * -l : Only wiki links are retrieved. |
||
308 | * -p : Only the issues in the same project is displayed. |
||
309 | * -r : Displays in descending order. |
||
310 | * -w=[search word]: Specify keyword for search. |
||
311 | |||
312 | column: You can specify columns for display. |
||
313 | |||
314 | * project |
||
315 | * tracker |
||
316 | * subject |
||
317 | * status |
||
318 | * author |
||
319 | * assigned |
||
320 | * created |
||
321 | * updated |
||
322 | |||
323 | h3. for example |
||
324 | |||
325 | {{@ref_issues(-rw=commit,project,tracker,subject,status,author,assigned,created,updated)@}} |
||
326 | |||
327 | {{ref_issues(-rw=commit,project,tracker,subject,status,author,assigned,created,updated)}} |
||
328 | 43 | Haru Iida | |
329 | h2. Emoticons |
||
330 | |||
331 | {{new(2011-01-02)}} |
||
332 | |||
333 | You can add emoticons to wiki page. |
||
334 | |||
335 | !emoticons.png! |
||
336 | |||
337 | You can also use your original emoticons. |
||
338 | |||
339 | # Edit redmine_wiki_extensions/config/emocitons.yml |
||
340 | # Put your emoticon image into redmine_wiki_extensions/assets/images. |
||
341 | # Restart redmine. |