Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.84 KB

README.textile

File metadata and controls

60 lines (38 loc) · 1.84 KB
Raw

What does it do?

This redmine plugin adds a macro in your redmine wikis, which allows the embedding of etherpads. It provides the same result as this hack, but more easily, and without the unsafety of allowing arbitrary html.

Macro: etherpad()

To use, just add {{etherpad(nameOfPad)}} to the issue/wiki/page in which to embed a pad.

Requires at least one argument, the name of the etherpad to embed.

Other arguments should be listed in “key=val” format, and include:

  • width: the width of the iframe (e.g. “640px”, “100%”), default=640px.
  • height: the height of the iframe (e.g. (“800px”), default=480px.
  • showControls: true/false (default true)
  • showChat: true/false (default true)
  • showLineNumbers: true/false (default false)
  • useMonospaceFont: true/false (default false)
  • noColors: true/false (default false)

Example:

{{etherpad(myHotPad, useMonospaceFont=true, width=100%)}}

Installation

On Redmine 1.x, Navigate to:
[redmine_install_path]/vendors/plugins
On Redmine >= 2.1, navigate to:
[redmine_install_path]/plugins

Clone this repo.
git clone git://github.com/yourcelf/redmine_etherpad.git

If you are using redmine 1.x, checkout the redmine_1.x branch:

git checkout -b redmine_1.x origin/redmine_1.x

For redmine 2.1+, just use master.

Configuration

Add an “etherpad” configuration section to “config/configuration.yml” in which you define the etherpad host to use:

default:
  etherpad:
    host: https://etherpad.example.com

You can also list any of the embed arguments to replace defaults, for example:

default:
  etherpad:
    host: https://etherpad.example.com
    showLineNumbers: true
    useMonospaceFont: true