【问题标题】:Good documentation for writing Redmine plugins编写Redmine插件的好文档
【发布时间】:2011-07-18 17:47:42
【问题描述】:

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

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

我查看了他们的论坛http://www.redmine.org/projects/redmine/boards,似乎需要很长时间才能回答问题。

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

【问题讨论】:

  • freenode.net 上的 IRC 频道 #redmine 可能对更快地获得答案更有用。
  • 如果我的回答有帮助,请接受作为您问题的答案。

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


【解决方案1】:

我知道这对于原始问题海报来说可能为时已晚,但可能会帮助处于类似情况的其他人。下面的链接是针对 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 元编程习语(在 Rails 中使用):
从表面上看,Ruby 看起来像大多数脚本语言,它使用了元编程和 Ruby 对象模型的动态特性,使得复杂的内部体操对新手来说是不可见的。

一行 Rails 代码包含的这些技巧足以填满一本小书。
幸运的是,已经编写了这样一本书 - Ruby MetaProgramming Pragmatic Programmers 系列中的一本书。掌握这个基于 Mixin 的动态元编程真是太棒了。 Rails 和 Redmine 使用大量这些技巧作为钩子等来完成工作。

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

【讨论】:

    【解决方案2】:

    更好的文档是代码源。 Redmine 的一位维护者在github 上拥有几乎所有Redmine 的插件。

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

    【讨论】:

    • 这似乎不是答案,但可以省去很多麻烦,相信我们确实如此。插件实际上并不难写。离开已经写好的东西,你应该能够找出如何做大部分事情。
    • 是的,我也找不到一个好的“文本”文档如何为 Redmine 编写插件。如果你能找到它,请告诉我吗?
    • 我正在考虑编写一些教程,以帮助其他人在获得更多经验后比我更快地入门。如果我成功了,我可能会在这里发布链接。感谢您的回答
    • @RailsRider 请参阅我的answer 了解有关 Redmine 插件开发的新书
    【解决方案3】:

    redmine wiki page about plugin hooks上所述:

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

    似乎浏览核心类以及查看其他插件是要走的路。

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

    关于论坛的反应,您可以尝试在 redmine 的最新分支 forum of chiliproject 上提问。不确定其中有多少已经改变。

    【讨论】:

    • Redmine 和 ChiliProject 1.x 非常接近,我们尽量保持兼容性。 ChiliProject 2.x 有一些重大变化,尤其是在期刊(发行说明)方面。旧代码应该仍然可以工作,但需要测试和移植。大约 50% 的插件在没有任何更改的情况下工作,40% 使用 Gemfile for bundler,其余的需要一些更新。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2016-12-10
    • 2023-03-19
    • 1970-01-01
    • 2011-11-13
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多