Documentation - Redmine Wiki Admonition¶

Simple admonition blocks

The Redmine Wiki Admonition plugin is a Redmine plugin. It adds macros for simple admonition blocks for Redmine's wiki module.

• Table of contents
• Documentation - Redmine Wiki Admonition
  • Getting Started
    • Downloading the plugin
    • Restart Redmine
  • Plugin Usage
  • Uninstall
  • Changelog
  • Licence

Getting Started¶

This quick introduction shows you the most convenient way for trying out the plugin with your Redmine instance.

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

Download the latest development state as redmine_wiki_admonition folder into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone https://github.com/xmera-circle/redmine_wiki_admonition.git

Restart Redmine¶

Navigate into the root directoy.

Run the restart Rake task. This will touch restart.txt in order to force Redmine's application server to restart and load
everything from scratch. This will register the new plugin.

cd (REDMINE_ROOT_DIR)
rake restart

Plugin Usage¶

You can use the macro where you find a wiki toolbar above a text field like so:

tip - for valuable tips

Usage:

{{tip(TIP)
A very hot tip for you!
}}

note - for friendly hints

Usage:

{{note(NOTE)
That this is in fact a note.
}}

danger - for pointing out a potential danger

Usage:

{{danger(DANGER)
It's dangerous to go alone.
}}

important - for things that require some extra caution

Usage:

{{important(IMPORTANT)
The two most important days in your life are
the day you are born and the day you find out why.
}}

Uninstall¶

In order to uninstall the plugin just remove or delete the plugin from the plugin directory.

Changelog¶

Currently, there is no Changelog.

Licence¶

WTFPL