r-labs

h1. Redmine Wiki Extensions Plugin

{{>toc}}

日本語は [[Wiki Extensions|こちら]].

This plugin adds usefull wiki macros into your Redmine.

h2. Downloads

"bitbucket":https://bitbucket.org/haru_iida/redmine_wiki_extensions/downloads

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

*This site is {{@fn(Redmine, One of the best project management tool.)@}} site.*

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

*The project of Wiki Extensions Plugin is {{@project(Wiki Extensions, here)@}}.*

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

{{@taggedpages(tagname)@}} macro displays the list of pages which have specified tag.{{new(2010-10-05)}}

{{@taggedpages(tagname1[,tagname2..,tagnamen], project)@}} macro displays the list of pages of project which have specified tags.{{new(2010-12-06)}}

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.

{{@div_start_tag(sample_tag)@}}

Style of this line was changed.

{{@div_end_tag@}}

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

{{@comments@}}

{{@comment_form@}}

h3. Comment notification

{{new(2011-09-23)}}

Watchers of wiki page can get notification if comment was added. You can configure about notification at Adminitistion -> Settings -> Email notifications.

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. Displays the person who updated the page. 

{{new(2009-09-06,14)}}

{{@lastupdated_by@}} macro displays the name of user who updated the wiki page.

h2. Displays the time when the page was updated.

{{new(2009-09-06,14)}}

{{@lastupdated_at@}} macrodisplays the timestamp when the wiki page was updated.

h2. Add tabs to project menu.

{{new(2009-09-06,14)}}

You can add project menu tabs that links to wiki page.

!setting.jpg!

!menu.jpg!

h2. Displays the page of other site.

{{new(2009-10-08,14)}}

iframe macro displays the page of other site into the wiki page.

h3. Syntacs

{{@iframe(url)@}}

{{@iframe(url, width, height)@}} or

{{@iframe(url, width, height, scrolling)@}} 

scrolling is a value of scrolling option of iframe.[yes, no, auto]

h3. example

Displaying wikipedia.

{{@iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)@}}

{{iframe(http://en.wikipedia.org/wiki/Redmine, 700, 400)}}

h2. Access counter

{{new(2009-10-31,14)}}

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

{{@show_count@}} macro displays the count of the page.

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

h2. Auto preview

{{new(2010-02-02,14)}}

If you enabled this function, preview of wiki, forum and issue is displayed automatically. You can enable it on project setting page.

!autopreview.png!

h2. Sortable table

{{new(2010-10-05)}}

You can sort table items by clicking header.

ex)

<pre>

|_.fruits|_.color|

|Apple|Red|

|Banana|Yellow|

|Mellon|Green|

</pre>

|_.fruits|_.color|

|Apple|Red|

|Banana|Yellow|

|Mellon|Green|

h2. twitter macro

{{new(2010-10-05)}}

{{@twitter(username)@}} macro links to tiwtter page.

ex.) {{@twitter(haru_iida)@}} -> {{twitter(haru_iida)}} 

h3. vote macro

{{new(2010-12-6)}}

{{@vote(key)@}} macro displays a link for vote. You must specify a "key" which is unique in the page.

ex.)

APPLE {{@vote(apple)@}}

LEMON {{@vote(lemon)@}}

BANANA {{@vote(banana)@}}

to

APPLE {{vote(apple)}}

LEMON {{vote(lemon)}}

BANANA {{vote(banana)}}

{{@vote(key,label)@}} displays label insteadof string "vote".

ex.)

{{@vote(apple2, I like apples.)@}}

{{@vote(lemon2, I like lemons.)@}}

{{@vote(banana2, I like bananas.)@}}

to

{{vote(apple2, I like apples.)}}

{{vote(lemon2, I like lemons.)}}

{{vote(banana2, I like bananas.)}}

h2. List issues

{{new(2011-01-19)}}

ref_issues macro displays list of issues.

You can use custom query or keyword for selecting issues.

h3. Syntacs

{{@ref_issues([options]..., [column]...)@}}

*options:* 

* -i=[CustomQuery ID]: ID of custom query.

* -q=[CustomQuery name]: Name of custom query.

* -s=[WORDs] : select issues that contain WORDs in subject. 

* -d=[WORDs] : select issues that contain WORDs in description. 

* -w=[WORDs] : select issues that contain WORDs in subject or description.

* -p : Only the issues in the same project is displayed. 

You can specify two or more select option, it affect AND condition.

WORDs is one or more search words divided by '|', and multiple words affect OR condition.

If you specify no select condition, page name of wiki or number of issue is used for search word.

*columns:* 

You can choose columns that you want to display.

If you do not specify the columns, same columns with customquery are displayed.

* project

* tracker

* parent

* status

* priority

* subject

* author

* assigned_to

* updated_on

* category

* fixed_version

* start_date

* due_date

* estimated_hours

* done_ratio

* created

h3. example

{{@ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)@}}

{{ref_issues(-s=ref_issues,subject,fixed_version,done_ratio,status)}}

{{@ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)@}}

{{ref_issues(-q=プロジェクト毎,-w=wiki extension|jenkins)}}

h2. Emoticons

{{new(2011-01-02)}}

You can add emoticons to wiki page.:)

!emoticons.png!

You can also use your original emoticons.

# Edit redmine_wiki_extensions/config/emocitons.yml

# Put your emoticon image into redmine_wiki_extensions/assets/images.

# Restart redmine.

h2. new_page macro

{{new(2011-09-23,14)}}

{{@new_page@}} macro shows link for creating a new wiki page. You could put this macro on a side bar.