Wiki Extensions en » 履歴 » バージョン 27
Haru Iida, 2009/10/08 13:07
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 | 3 | Haru Iida | *@{{fn(word, description)}}@*: |
37 | 2 | Haru Iida | |
38 | ex. |
||
39 | |||
40 | 1 | Haru Iida | <pre> |
41 | 2 | Haru Iida | This site is {{fn(Redmine, One of the best project management tool.)}} site. |
42 | 1 | Haru Iida | </pre> |
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 | 7 | 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 | * @{{project(project_identifier)}}@ |
||
86 | * @{{project(project_identifier, alias)}}@ |
||
87 | 1 | Haru Iida | |
88 | |||
89 | 5 | Haru Iida | ex.) |
90 | 1 | Haru Iida | <pre> |
91 | 10 | Haru Iida | The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}. |
92 | 1 | Haru Iida | </pre> |
93 | |||
94 | "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 | * @{{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 | And @{{tagcloud}}@ macro displays the tag cloud. so you can write this macro into [[SideBar]] like this site. |
||
115 | 20 | Haru Iida | |
116 | h2. Editing Style Sheet |
||
117 | |||
118 | {{new(2009-07-16)}} |
||
119 | |||
120 | 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. |
||
121 | So. you can even create a project-specific theme. |
||
122 | |||
123 | And if you want to change a style of a part of the page, you can use following macros. |
||
124 | |||
125 | *@{{div_start_tag(id_name)}}@* is changed to、<div id="id_name">. |
||
126 | *@{{div_start_tag(id_name, class_name)}}@* is changed to<div id="id_name" class="class_name">. |
||
127 | *@{{div_end_tag}}@* is changed to </div>. |
||
128 | |||
129 | ex. |
||
130 | |||
131 | <pre> |
||
132 | {{div_start_tag(sample_tag)}} |
||
133 | |||
134 | Style of this line was changed. |
||
135 | |||
136 | {{div_end_tag}} |
||
137 | </pre> |
||
138 | |||
139 | {{div_start_tag(sample_tag)}} |
||
140 | |||
141 | Style of this line was changed. |
||
142 | |||
143 | {{div_end_tag}} |
||
144 | 21 | Haru Iida | |
145 | h2. Footer |
||
146 | |||
147 | {{new(2009-08-04)}} |
||
148 | |||
149 | 22 | Haru Iida | If you create the page named "Footer", you can see it at the bottom of the every pages. |
150 | 21 | Haru Iida | |
151 | For example. If you want to add the comment form to every pages, you should write like below. |
||
152 | <pre> |
||
153 | {{comments}} |
||
154 | {{comment_form}} |
||
155 | </pre> |
||
156 | |||
157 | h2. Recently added pages |
||
158 | |||
159 | {{new(2009-08-04)}} |
||
160 | |||
161 | *@{{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. |
||
162 | 23 | Haru Iida | |
163 | 24 | Haru Iida | h2. Displays the person who updated the page. |
164 | 23 | Haru Iida | |
165 | {{new(2009-09-06,14)}} |
||
166 | |||
167 | 25 | Haru Iida | *@{{lastupdated_by}}@* macro displays the name of user who updated the wiki page. |
168 | 23 | Haru Iida | |
169 | 24 | Haru Iida | h2. Displays the time when the page was updated. |
170 | 23 | Haru Iida | |
171 | {{new(2009-09-06,14)}} |
||
172 | |||
173 | 25 | Haru Iida | *@{{lastupdated_at}}@* macrodisplays the timestamp when the wiki page was updated. |
174 | 23 | Haru Iida | |
175 | 25 | Haru Iida | h2. Add tabs to project menu. |
176 | 23 | Haru Iida | |
177 | {{new(2009-09-06,14)}} |
||
178 | |||
179 | 26 | Haru Iida | You can add project menu tabs that links to wiki page. |
180 | 23 | Haru Iida | |
181 | !setting.jpg! |
||
182 | |||
183 | !menu.jpg! |