WikiNG plugin for Redmine/ChiliProject¶

The WikiNG plugin for Redmine and ChiliProject is aimed to extend Redmine Wiki syntax by making it more developer-ready, more emotional and social...

Extensions¶

The WikiNG plugin adds the following extensions:

• New links:
  • user#<id> or user:<login> → Andriy Lesyuk
  • file#<id> or file:<filename> → wiking-0.0.2.tar.bz2
  • [[wikipedia>Resource]] → Ruby
  • [[google>Search string]] → Redmine WikiNG plugin
  • [[redmine>Resource]] or [[redmine>#<issue>]] → #4179
  • [[chiliproject>Resource]] or [[chiliproject>#<issue>]] → Why Fork?
• New blocks:
  • <warning> ... </warning> or warning. ...
  • <notice> ... </notice> or notice. ...
  • <tip> ... </tip> or tip. ...
• Smileys:
  • :), =), :D, =D, :'(, :(, ;), :P, :O, :/, :S, :|, :X, :*, O:), >:), B), (!), (?) and @}->-
    , , , , , , , , , , , , , , , , , , and
• Special characters:
  • <-, <->, ->, <=, <=>, =>, -- and ---
    ←, ↔, →, ⇐, ⇔, ⇒, – and —
• Markers:
  • {TODO} →
  • {UPDATE} →
  • {FIXME} →
  • {NEW} →
  • {FREE} →
• CSS classes:
  • shadow → drops shadow for images, e.g., !(wiking shadow).image.png!
  • mac-shadow → drops the Mac-style shadow for images, e.g., !(wiking mac-shadow).image.png!
  • pressed → embosses code blocks, e.g., <pre class="wiking pressed">...</pre>
  • button → renders a link as a button, e.g., "(wiking button)anchor":link
  • small → makes font slightly smaller, e.g., %(wiking small)small text% or p(wiking small). small paragraph
• Macros:
  
  Macros {{version}} and {{date}} are not compatible with formatted text caching.
  • Conditional macro: {{date >= YYYY-MM-DD}} ... {{date}} (not available under ChiliProject)
  • Conditional macro: {{version < x.x.x}} ... {{version}} (not available under ChiliProject)
  • Macro for creating and calling custom hook: {{hook(<name>)}} ({% hook(<name>) %} under ChiliProject)

Check this page for more detailed syntax. To experiment with the syntax use the playground.

Install¶

To install the plugin do:

• Copy wiking directory to #{RAILS_ROOT}/vendor/plugins.
• Restart Redmine/ChiliProject.

Contributing¶

You can contribute to the plugin by sharing a theme if you have created one or by improving icons/pictures used for e.g. markers.

Similar plugins¶

• Wiki Notes by Daniel Seifert
• Wiki Extensions by r-labs