r-labs

h1. Redmine Wiki Extensions Plugin

{{>toc}}

This plugin adds usefull wiki macros into your Redmine.

h2. Downloads

h3. Releases

not yet.

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 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.