编写Redmine插件的好文档

时间:2011-07-18 17:47:42

标签: ruby-on-rails ruby-on-rails-3 ruby-on-rails-plugins redmine redmine-plugins

我目前正在为Redmine开发一些插件,我必须说,我对此主题缺乏文档感到有点失望。

通常,如果我正在寻找关于类/方法的解释,我需要花费一致的时间浏览核心类,并努力理解那里编写的代码(似乎有些人忘记记录他们的代码,不幸的是。)

我已经检查了他们的论坛http://www.redmine.org/projects/redmine/boards,似乎需要永远才能回答问题。

这就是为什么我想就这个主题的一些好的API文档/书籍/论坛提供一些建议。

3 个答案:

答案 0 :(得分:13)

我知道这对于原始问题海报可能太迟了,但可能会帮助处于类似情况的其他人。下面的链接是针对RubyOnRails的新手(像我一样),但是之前编程过的人。您可以根据自己的技能水平挑选相关的一些。

了解Redmine(功能):
如果您不熟悉Redmine或管理其他问题跟踪软件,Mastering Redmine本书是个不错的选择。它的密集程度不是很高,所以它只能作为一个结构化的信息组织。如果您想要更密集的信息,请查看文档。

了解Redmine插件:
"Redmine Plugin Extension and Development" by Alex Bevilacqua刚刚发布(2014年3月)。它可以从packtpub以打印和电子书格式提供。

我正在阅读本书,因为我需要为Redmine自定义/重写插件。 我自己是Rails / Ruby / Redmine的新手。虽然我来自Unix / C ++背景,但仍然通过以下书籍了解Ruby,Rails,Redmine的知识。

了解Rails:
我发现这本书Agile Web Development with Rails对于来自其他语言的程序员的Rails是一个很好的介绍 注意:目标受众似乎是Rails开发人员,但应该可以通过浏览github redmine插件存储库来完成学习曲线。

了解Ruby:
Programming Ruby (the PickAxe Book)

了解Ruby Metaprogramming习语(在Rails中使用):
从表面上看,Ruby看起来像大多数脚本语言,它使用MetaProgramming和Ruby对象模型的动态特性,允许复杂的内部体操对新手不可见。

单行Rails代码包含足够的这些技巧来填充一本小书 幸运的是,这本书已经写成了 - Ruby MetaProgramming书中的实用程序员系列。掌握这款基于Mixin的Dynamic MetaProgramming非常棒。 Rails和Redmine使用大量这些技巧作为钩子等来完成工作。

Excellent Video on Ruby Object Model by Dave Thomas
Video on Ruby Object Model and Meta Programming

答案 1 :(得分:9)

更好的文档是codesource。一个Redmine的主要人员在github上拥有几乎所有Redmine的插件。

你可以选择任何插件,看看是什么样的。主要是关于元编程和alias_method_in_chain用法

答案 2 :(得分:6)

正如redmine wiki page about plugin hooks所述:

  

有一个有效挂钩列表。但找到它们的最佳方法是只需查看代码,找到您想要扩展的位置并搜索附近钩子的调用。

似乎浏览核心类以及查看其他插件是可行的方法。

我假设您已经在wiki上找到了与插件相关的所有文档:

关于论坛的反应性,您可以尝试在forum of chiliproject上提问,这是最近的redmine分支。虽然有多少已经改变,但不确定。