目录

• 一.插件来源
• 二.插件测试人员
• 三.实测环境
• 四.插件概述
• 五.安装和卸载
• 六.配置和使用
• 七.插件限制
• 八.注意事项
• 九.许可和版权
• 十.更新日志
• 十一.参考资料

一.插件来源

| 插件作者: | [Akiko Takano] |
| 官方站点: | http://www.r-labs.org/projects/banner |
| 代码源: | https://github.com/akiko-pusu/redmine_banner |
| 注册日期: | 2012-01-27 (over 6 years ago) |
| 当前版本: | 0.1.2 |
| 适合于: | Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x, 2.6.x, 2.5.x |

Redmine Banner plugin

二.插件测试人员

• 水士白 WaterWhite

三.实测环境

• Redmine 3.4.5.stable
• Ruby version 2.1.5-p273 (2014-11-13) [x86_64-linux]
• Rails version 4.2.8
• Environment production
• Database adapter Mysql2
• Git 1.9.1

四.插件概述

• 主要用于站点管理员在站点范围发送公告信息或项目经理发布项目公告信息等，例如项目信息、维护信息或通知。
• 支持自定义消息样式。

五.安装和卸载

安装

对于 Redmine 2.x:

• 对于Redmine 2.1或更高版本，请使用版本0.0.8或更高版本。 对于Redmine 2.0，请使用版本0.0.7。
  1.将插件目录复制到plugins目录中。

$ cd redmine
$ git clone https://github.com/akiko-pusu/redmine_banner.git plugins/redmine_banner

2. 运行迁移任务。 (For Redmine 2.x)

$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production 

• Banner插件0.0.5版本以后，需要迁移。

3. 重启Redmine服务

对于 Redmine 1.x:

• 对于Redmine 1.x, 请使用0.0.6版本.

1. 将插件目录复制到vendor/plugins目录中。
2. 运行迁移任务，例如：rake db:migrate_plugins RAILS_ENV=production (For Redmine 1.x)
3. 重启Redmine服务

卸载

对于Redmine 2.x,使用以下命令:

$ rake redmine:plugins:migrate NAME=redmine_banner VERSION=0 RAILS_ENV=production

对于 Redmine 1.x, 使用以下命令:

$ rake db:migrate_plugins NAME=redmine_banner VERSION=0 RAILS_ENV=production

六.配置和使用

对于网站范围的Banner（仅限系统管理员。）：

• 管理->插件->页面，然后单击Redmine Banner插件的“配置”链接。

  
  
  插件列表

• 选中“激活”，您可以打开/关闭Banner消息。

• 您可以编辑Banner消息并选择消息样式。 您还可以从管理菜单访问设置页面，单击“Banner”图标。

  
  
  启用&编辑页面

对于项目范围Banner：

• 添加Banner作为项目模块，并在项目设置页面的Banner选项卡上选中“激活”。

• 1.Banner可以用作项目模块。 如果要管理项目的Banner广告，则您的角色需要- “管理Banner”权限。

  
  
  管理Banner

• 2.转到项目->配置选项卡，然后选中“Banner”作为项目模块，编辑Banner内容。

  
  
  编辑Banner内容

• 3.然后，您可以在项目设置页面上看到“Banner”选项卡。

  
  
  某项目下的Banner信息

七.插件限制

1. 每个项目的Banner不支持计时器。

2. 每个项目的Banner仅位于项目的顶部。 （不支持页脚）

3. 渲染Banner需要javascript（prototype.js），所以如果您不使用主流的浏览器，Banner将无法正确显示。

八.注意事项

• 要将此插件与较旧的Redmine版本（1.xx，1.0.x ...）一起使用，请参阅此说明。
• https://github.com/akiko-pusu/redmine_banner/wiki/How-to-use-this-plugin-previous-version-(1.xx,-1.0.x...)

九.许可和版权

• 该软件根据GNU GPL v2 \许可。 有关详细信息，请参阅COPYRIGHT和COPYING。

十.更新日志

0.1.2

• Fix style and css selector. (Github: #45)
• Change global banner style for responsive mode. (Github: #68)
• Code refactoring.
• Fix: Prevent deprecation warning. (Github PR: #60) Thanks, Wojciech.
• Refactor: Rename file to prevent conflict (Github #63 / r-labs: 54).
• i18n: Update Italian translation file. (Github: #61 / r-labs: 57) Thanks, R-i-c-k-y.
• i18n: Add Spanish translation file. (Github: #61 / r-labs: 52) Thanks Picazamora!
• i18n: Update Turkish translation file. (Github: #64) Thank you so much, Adnan.
• i18n: Update Portuguese translation file. (Github: #50) Thanks, Guilherme.

0.1.1

• Support Redmine 3.x.
• Update some translation files. Bulgarian, German. Thank you so much, Ivan Cenov, Daniel Felix.
• Change column type of banner_description from string to text.Thank you so much Namezero. (#44)

0.1.0

• Fixed bug: Global banner timer does not work. (r-labs: #1337)
• Feature: Add related link field for more information to Global Banner. (r-labs: #1339)
• i18n: Update Korean translation file. (r-labs: #1329) Thank you so much, Ki Won Kim.

0.0.9

• Authenticated users can turn off global banner in their session.
• Add option to show global banner only for authenticated users.
• Add option to show only at the login page.
• Code refactoring.
• Italian translation was contributed by @R-i-c-k-y.
• French translation was contributed by Laurent HADJADJ.

0.0.8

• Support Redmine 2.1. (Redmine 2.0.x is no longer supported. Please use version 0.0.7 for Redmine 2.0.x)

0.0.7

• Compatible with Redmine 2.0.0

0.0.6

• Fixed bug: Project banner should be off when module turned disabled.
• Fixed bug: In some situation, "ActionView::TemplateError undefined method is_action_to_display" is happened.
• Update Russian Translation. Thank you so much, Александр Ананьев.

0.0.5

• Support banner for each project. Thank you so much, Denny Schäfer, Haru Iida.

0.0.4

• Support timer function.
• Add links to turn off or modify banner message quickly. (Links are shown to Administrator only)

0.0.3

• Code refactoring. Stop to override base.rhtml and use javascript. Great thanks, Haru Iida-san. Also, remove some "To-Do" section of README.

• Add translations. Russian, German, Brazilian Portugues. Thank you so much, Александр Ананьев, Denny Schäfer, Maiko de Andrade!

0.0.2

• Support i18n.

0.0.1

• First release

十一.参考资料

1. https://github.com/akiko-pusu/redmine_banner