Project

General

Profile

Actions
History

FrontPage » Plugins »

Wiki Extensions en » History » Revision 48

« Previous | Revision 48/55 (diff) | Next »
Tomohisa Kusukawa, 06/09/2011 08:34 AM

Redmine Wiki Extensions Plugin

日本語は こちら.

This plugin adds usefull wiki macros into your Redmine.

Downloads

bitbucket

Installation

  1. Copy the plugin into the vendor/plugins directory
  2. Migrate plugin: rake db:migrate_plugins RAILS_ENV=production
  3. Start Redmine
  4. Enable the module on the project setting page.

Footnote

This macro creates footnotes*1 in wiki pages.

Syntacs

{{fn(word, description)}}:

ex.

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

"This site is Redmine*2 site."

You can see footnotes on the bottom of this page.

Adding comment form

You can add a comment form in a page.

Syntacs

{{comment_form}} displays the comment form in a page. And {{comments}} macro displays the list of comment.

  • Added by Haru Iida over 16 years ago

    This is a sample of comment.

    • Added by sundisb billaaa almost 13 years ago

      [b][url=http://www.outletchanelshop.com/]chanel bags outlet online[/url][/b]
      [b][url=http://www.outletchanelshop.com/]chanel <strong><a href="http://www.outletchanelshop.com/&quot;&gt;chanel bags outlet online</a></strong>
      <br>
      <strong><a href="http://www.outletchanelshop.com/&quot;&gt;chanel bags for sale</a></strong>
      <br>
      <strong><a href="http://www.outletchanelshop.com/&quot;&gt;chanel handbags for sale</a></strong>
      <br>
      <strong><a href="http://www.outletchanelshop.com/&quot;&gt;discount chanel handbags</a></strong>
      <br>
      <strong><a href="http://www.outletchanelshop.com/&quot;&gt;chanel handbags 2012</a></strong>
      <br>

  • Added by Haru Iida over 16 years ago

    Of course you can use Wiki format

Link to the page of other projects.

[06/11/2009]

You can create the link to the page of other projects.

Syntacs

  • {{wiki(project_name, wiki_page)}}
  • {{wiki(project_name, wiki_page, alias)}}
  • {{wiki(project_identifier, wiki_page)}}
  • {{wiki(project_identifier, wiki_page, alias)}}

Link to other projects

[06/11/2009]

You can create the link to projects.

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

New macro

[06/12/2009]

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.

Tags

[06/23/2009]

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.[10/05/2010]

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

Editing Style Sheet

[07/16/2009]

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

Style of this line was changed.

Footer

[08/04/2009]

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

Recently added pages

[08/04/2009]

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

Displays the person who updated the page.

[09/06/2009]

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

Displays the time when the page was updated.

[09/06/2009]

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

Add tabs to project menu.

[09/06/2009]

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

Displays the page of other site.

[10/08/2009]

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

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]

example

Displaying wikipedia.

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

Access counter

[10/31/2009]

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

Auto preview

[02/02/2010]

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

Sortable table

[10/05/2010]

You can sort table items by clicking header.

ex)

|_.fruits|_.color|
|Apple|Red|
|Banana|Yellow|
|Mellon|Green|
fruits color
Apple Red
Banana Yellow
Mellon Green

twitter macro

[10/05/2010]

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

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

vote macro

[12/06/2010]

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

LEMON vote 14

BANANA vote 14

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

I like apples. 14

I like lemons. 14

I like bananas. 14

List issues

[01/19/2011]

ref_issues macro displays list of issues.
You can use custom query or keyword for selecting issues.

Syntacs

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

options:

  • -q=[CustomQuery name]: Name of custom query.
    If you specify this option, -SD is used for default arugment. if not, -sd is used for default argument.
  • w=[search word]: Specify the word you want to search. The problem occurs in the latest version. It is investigating.
    If you do not specify the word, page name is used for search.
  • -s : The subjects are retrieved.
  • -S : The subjects are not retrieved.
  • -d : The descriptions are retrieved.
  • -D : The descriptions are not retrieved.
  • -p : Only the issues in the same project is displayed.

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

example

{{ref_issues(-q=プロジェクト毎,-sdw=commit)}}

# Tracker Status Priority Subject Assignee Updated Target version % Done
Hudson 1 Collapse all/Expand all
629 Proposal 新規（New） 高め（High） Trigger refresh of build information by URL hook 07/31/2011 09:43 PM

Actions
r-labs 2 Collapse all/Expand all
1290 Support 新規（New） 通常（Normal） Problem with Code Review plugin Haru Iida 10/24/2013 07:33 PM

Actions
984 Question 新規（New） 通常（Normal） How doesn sort column header disabled? 11/08/2013 12:55 AM

Actions

Emoticons

[01/02/2011]

You can add emoticons to wiki page.:)

You can also use your original emoticons.

  1. Edit redmine_wiki_extensions/config/emocitons.yml
  2. Put your emoticon image into redmine_wiki_extensions/assets/images.
  3. Restart redmine.

  • *1 footnotes:Notes of text placed at the bottom of a page.
  • *2 Redmine:One of the best project management tool.

Updated by Tomohisa Kusukawa , Updated over 14 years ago
Access count: 970354 :since 2009-10-30

Updated by Tomohisa Kusukawa over 14 years ago · 55 revisions