プロジェクト

全般

プロフィール

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

Haru Iida, 2010/10/06 00:28

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. Side bar
27
28 8 Haru Iida
If you create the page named [[SideBar]], displaying it on a {{fn(side-bar, You can see it on tha right side of this page.)}} of the wiki.
29 1 Haru Iida
30
h2. Footnote
31
32 11 Haru Iida
This macro creates {{fn(footnotes, Notes of text placed at the bottom of a page.)}} in wiki pages.
33 1 Haru Iida
34 2 Haru Iida
h3. Syntacs
35 1 Haru Iida
36 34 Haru Iida
{{@fn(word, description)@}}: 
37 2 Haru Iida
38
ex.
39 1 Haru Iida
40
41 34 Haru Iida
*This site is {{@fn(Redmine, One of the best project management tool.)@}} site.*
42
43
44 2 Haru Iida
"This site is {{fn(Redmine, One of the best project management tool.)}} site."
45 1 Haru Iida
46 12 Haru Iida
You can see footnotes on the bottom of this page.
47 1 Haru Iida
48 15 Haru Iida
h2. Adding comment form
49 1 Haru Iida
50 4 Haru Iida
You can add a comment form in a page.
51 1 Haru Iida
52 4 Haru Iida
h3. Syntacs
53 1 Haru Iida
54 34 Haru Iida
{{@comment_form@}} displays the comment form in a page. And {{@comments@}} macro displays the list of comment.
55 1 Haru Iida
56
{{comments}}
57
{{comment_form}}
58
59
60 15 Haru Iida
h2. Link to the page of other projects.
61 1 Haru Iida
62 14 Haru Iida
{{new(2009-06-11)}}
63
64 5 Haru Iida
You can create the link to the page of other projects.
65 1 Haru Iida
66 5 Haru Iida
h3. Syntacs
67 1 Haru Iida
68 5 Haru Iida
* @{{wiki(project_name, wiki_page)}}@
69
* @{{wiki(project_name, wiki_page, alias)}}@
70
* @{{wiki(project_identifier, wiki_page)}}@
71
* @{{wiki(project_identifier, wiki_page, alias)}}@
72 1 Haru Iida
73
74 5 Haru Iida
h2. Link to other projects
75 14 Haru Iida
76
77
{{new(2009-06-11)}}
78 1 Haru Iida
79 5 Haru Iida
You can create the link to projects.
80 1 Haru Iida
81 5 Haru Iida
h3. Syntacs
82 1 Haru Iida
83 5 Haru Iida
* @{{project(project_name)}}@
84
* @{{project(project_name, alias)}}@
85 1 Haru Iida
* @{{project(project_identifier)}}@
86 5 Haru Iida
* @{{project(project_identifier, alias)}}@
87 1 Haru Iida
88
89 5 Haru Iida
ex.)
90 1 Haru Iida
91 34 Haru Iida
*The project of Wiki Extensions Plugin is {{@project(Wiki Extensions, here)@}}.*
92
93
94 1 Haru Iida
"The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}."
95 13 Haru Iida
96
h2. New macro
97
98
{{new(2009-06-12)}}
99
100
h3. Syntacs
101
102 32 Haru Iida
* {{@new(yyyy-mm-dd)@}}
103
* {{@new(yyyy-mm-dd, expire)@}}
104 1 Haru Iida
105
106 15 Haru Iida
Displays the string "new" if specific date does not expired. Default of expire is 5 days.
107
108
h2. Tags
109
110 16 Haru Iida
{{new(2009-06-23)}}
111
112 15 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. 
113
114 34 Haru Iida
And {{@tagcloud@}} macro displays the tag cloud. so you can write this macro into [[SideBar]] like this site.
115 20 Haru Iida
116 35 Haru Iida
{{@tags(tagname)@}} macro displays the list of pages which have specified tag.{{new(2010-10-05)}}
117
118 20 Haru Iida
h2. Editing Style Sheet
119
120
{{new(2009-07-16)}}
121
122
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.
123
So. you can even create a project-specific theme.
124 1 Haru Iida
125 20 Haru Iida
And if you want to change a style of a part of the page, you can use following macros.
126
127 1 Haru Iida
* {{@div_start_tag(id_name)@}} is changed to、< div id="id_name">.
128 32 Haru Iida
* {{@div_start_tag(id_name, class_name)@}} is changed to< div id="id_name" class="class_name">.
129
* {{@div_end_tag@}} is changed to < /div>.
130 20 Haru Iida
131
ex.
132
133
134 34 Haru Iida
{{@div_start_tag(sample_tag)@}}
135
136 20 Haru Iida
Style of this line was changed.
137
138 34 Haru Iida
{{@div_end_tag@}}
139 20 Haru Iida
140 34 Haru Iida
141 1 Haru Iida
{{div_start_tag(sample_tag)}}
142
143 20 Haru Iida
Style of this line was changed.
144
145
{{div_end_tag}}
146
147 21 Haru Iida
h2. Footer
148
149
{{new(2009-08-04)}}
150
151
If you create the page named "Footer", you can see it at the bottom of the every pages.
152 22 Haru Iida
153 21 Haru Iida
For example. If you want to add the comment form to every pages, you should write like below.
154
155 34 Haru Iida
{{@comments@}}
156
157
{{@comment_form@}}
158
159
160 21 Haru Iida
h2. Recently added pages
161
162
{{new(2009-08-04)}}
163
164 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.
165 23 Haru Iida
166 24 Haru Iida
h2. Displays the person who updated the page. 
167 23 Haru Iida
168
{{new(2009-09-06,14)}}
169
170 33 Haru Iida
{{@lastupdated_by@}} macro displays the name of user who updated the wiki page.
171 23 Haru Iida
172 24 Haru Iida
h2. Displays the time when the page was updated.
173 23 Haru Iida
174
{{new(2009-09-06,14)}}
175
176 33 Haru Iida
{{@lastupdated_at@}} macrodisplays the timestamp when the wiki page was updated.
177 23 Haru Iida
178 25 Haru Iida
h2. Add tabs to project menu.
179 23 Haru Iida
180
{{new(2009-09-06,14)}}
181
182 26 Haru Iida
You can add project menu tabs that links to wiki page.
183 23 Haru Iida
184
!setting.jpg!
185
186
!menu.jpg!
187 28 Haru Iida
188 1 Haru Iida
h2. Displays the page of other site.
189
190 28 Haru Iida
191
{{new(2009-10-08,14)}}
192
193
iframe macro displays the page of other site into the wiki page.
194
195
h3. Syntacs
196 1 Haru Iida
197 35 Haru Iida
{{@iframe(url)@}}
198 32 Haru Iida
{{@iframe(url, width, height)@}} or
199
{{@iframe(url, width, height, scrolling)@}} 
200 28 Haru Iida
201
scrolling is a value of scrolling option of iframe.[yes, no, auto]
202
203
h3. example
204
205
Displaying wikipedia.
206
207
208 34 Haru Iida
{{@iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)@}}
209
210
211 28 Haru Iida
{{iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)}}
212 29 Haru Iida
213
h2. Access counter
214
215
{{new(2009-10-31,14)}}
216
217
218 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.
219 29 Haru Iida
220 32 Haru Iida
{{@show_count@}} macro displays the count of the page.
221 29 Haru Iida
222 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.
223 30 Haru Iida
224
h2. Auto preview
225
226
{{new(2010-02-02,14)}}
227 1 Haru Iida
228 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.
229 31 Haru Iida
230 1 Haru Iida
!autopreview.png!
231 35 Haru Iida
232
h2. Sortable table
233
234
{{new(2010-10-05)}}
235
236 37 Haru Iida
You can sort table items by clicking header.
237 35 Haru Iida
238 36 Haru Iida
ex)
239
240
<pre>
241
|_.fruits|_.color|
242
|Apple|Red|
243
|Banana|Yellow|
244
|Mellon|Green|
245
</pre>
246
247 35 Haru Iida
|_.fruits|_.color|
248
|Apple|Red|
249
|Banana|Yellow|
250
|Mellon|Green|
251
252
h2. twitter macro
253
254
{{new(2010-10-05)}}
255
256
{{@twitter(username)@}} macro links to tiwtter page.
257
258
ex.) {{@twitter(haru_iida)@}} -> {{twitter(haru_iida)}}