Wiki Extensions en » 履歴 » リビジョン 23
リビジョン 22 (Haru Iida, 2009/08/04 15:24) → リビジョン 23/55 (Haru Iida, 2009/09/06 10:12)
h1. Redmine Wiki Extensions Plugin
{{>toc}}
This plugin adds usefull wiki macros into your Redmine.
h2. Downloads
h3. Releases
http://code.google.com/p/redminewikiext/downloads/list
h3. Development version
http://hudson.r-labs.org/hudson/job/Wiki%20Extensions%20Plugin/
h3. Installation
# Copy the plugin into the vendor/plugins directory
# Migrate plugin: rake db:migrate_plugins RAILS_ENV=production
# Start Redmine
# Enable the module on the project setting page.
h2. Side bar
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.
h2. Footnote
This macro creates {{fn(footnotes, Notes of text placed at the bottom of a page.)}} in wiki pages.
h3. Syntacs
*@{{fn(word, description)}}@*:
ex.
<pre>
This site is {{fn(Redmine, One of the best project management tool.)}} site.
</pre>
"This site is {{fn(Redmine, One of the best project management tool.)}} site."
You can see footnotes on the bottom of this page.
h2. Adding comment form
You can add a comment form in a page.
h3. Syntacs
*@{{comment_form}}@* displays the comment form in a page. And *@{{comments}}@* macro displays the list of comment.
{{comments}}
{{comment_form}}
h2. Link to the page of other projects.
{{new(2009-06-11)}}
You can create the link to the page of other projects.
h3. Syntacs
* @{{wiki(project_name, wiki_page)}}@
* @{{wiki(project_name, wiki_page, alias)}}@
* @{{wiki(project_identifier, wiki_page)}}@
* @{{wiki(project_identifier, wiki_page, alias)}}@
h2. Link to other projects
{{new(2009-06-11)}}
You can create the link to projects.
h3. Syntacs
* @{{project(project_name)}}@
* @{{project(project_name, alias)}}@
* @{{project(project_identifier)}}@
* @{{project(project_identifier, alias)}}@
ex.)
<pre>
The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}.
</pre>
"The project of Wiki Extensions Plugin is {{project(Wiki Extensions, here)}}."
h2. New macro
{{new(2009-06-12)}}
h3. Syntacs
* @{{new(yyyy-mm-dd)}}@
* @{{new(yyyy-mm-dd, expire)}}@
Displays the string "new" if specific date does not expired. Default of expire is 5 days.
h2. Tags
{{new(2009-06-23)}}
You can see the tag input form at the bottom of the wiki editing page. You can add several tags to each wiki pages.
And @{{tagcloud}}@ macro displays the tag cloud. so you can write this macro into [[SideBar]] like this site.
h2. Editing Style Sheet
{{new(2009-07-16)}}
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.
So. you can even create a project-specific theme.
And if you want to change a style of a part of the page, you can use following macros.
*@{{div_start_tag(id_name)}}@* is changed to、<div id="id_name">.
*@{{div_start_tag(id_name, class_name)}}@* is changed to<div id="id_name" class="class_name">.
*@{{div_end_tag}}@* is changed to </div>.
ex.
<pre>
{{div_start_tag(sample_tag)}}
Style of this line was changed.
{{div_end_tag}}
</pre>
{{div_start_tag(sample_tag)}}
Style of this line was changed.
{{div_end_tag}}
h2. Footer
{{new(2009-08-04)}}
If you create the page named "Footer", you can see it at the bottom of the every pages.
For example. If you want to add the comment form to every pages, you should write like below.
<pre>
{{comments}}
{{comment_form}}
</pre>
h2. Recently added pages
{{new(2009-08-04)}}
*@{{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.
h2. 更新者を表示する
{{new(2009-09-06,14)}}
*@{{lastupdated_by}}@* と書くと、そのページの最終更新者の名前を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新者の名前を表示できます。
h2. 更新時刻を表示する
{{new(2009-09-06,14)}}
*@{{lastupdated_at}}@* と書くと、そのページの最終更新時刻を表示します。[[Footer]]にこのマクロを記述するとすべてのページの下部に更新時刻を表示できます。
h2. 任意のwikiページをプロジェクトメニューのタブに追加する
{{new(2009-09-06,14)}}
プロジェクトメニューにwikiページへのリンクをタブとして追加できるようになりました。
プロジェクト設定ページで設定できます。
!setting.jpg!
以下のようにメニューが追加されます。
!menu.jpg! SideBarに記述しておくとよいでしょう。