Хорошая документация для написания плагинов к Redmine

в настоящее время я разрабатываю некоторые плагины для Redmine, и я должен сказать, что я немного разочарован отсутствием документации по этому вопросу.

обычно, если я ищу объяснения по классам / методам, мне нужно потратить последовательное количество времени на просмотр основных классов и стремление понять написанный там код (кажется, что некоторые люди забыли документировать свой код, к сожалению).

Я проверил их форумы http://www.redmine.org/projects/redmine/boards, и кажется, что для ответа на вопрос требуется вечность.

вот почему я хотел бы получить некоторые советы относительно хорошей документации API / книг / форумов по этому вопросу.

3 ответов


лучшая документация-это codesource. Один mainteners Редмайн есть плагин почти все в Redmine на github.

вы можете выбрать любой плагин и посмотреть, как он выглядит. в основном речь идет о метапрограммировании и использовании alias_method_in_chain


Я знаю, что это, возможно, слишком поздно для оригинального плаката с вопросом, но может помочь кому-то еще в подобной ситуации. Ниже приведены ссылки для общего новичка (как я) на RubyOnRails, но кто-то, кто запрограммирован раньше. Вы можете выбирать соответствующие, как за свой уровень мастерства.

понимание Redmine (функциональность):
Если вы не знакомы с Redmine или администрированием другого программного обеспечения для отслеживания проблем Освоение Redmine книга в порядке место для начала. Он не очень плотно упакован, поэтому он поможет только как структурированная организация информации. Если вы хотите получить более плотную информацию, просмотрите документацию.

Понимание Плагинов Redmine:
"расширение и разработка плагинов Redmine" от Alex Bevilacqua только что был выпущен (март 2014). Он доступен как в печатном, так и в электронном форматах из packtpub.

Я сам просматриваю книгу, как мне нужно настройки/переписать плагин для Redmine. Я сам новичок в Rails/Ruby/Redmine. Хотя я из фона Unix/C++ все еще знакомлюсь с веревками Ruby, Rails, Redmine через следующие книги.

Понимание Рельсы:
Я нашел книгу гибкая Веб-разработка с Rails чтобы быть достаточно хорошим вступлением в Rails для программистов с других языков.
Примечание: целевая аудитория, похоже, разработчики Rails, но это должно быть возможно кривая обучения при просмотре репозиториев плагинов GitHub redmine.

Понимание Ruby:
Программирование Ruby (Кирка книга)

понимание идиом метапрограммирования Ruby (используется в Rails):
На поверхности Ruby выглядит как большинство скриптовых языков именно использование метапрограммирования и динамического характера объектной модели Ruby позволяет сделать сложную внутреннюю гимнастику невидимой для новичков.

A одна строка кода Rails содержит достаточно таких трюков, чтобы заполнить небольшую книгу.
К счастью, такая книга уже написана ... --40-->Руби Метапрограммирование книга в серии прагматических программистов. Это превосходно, чтобы справиться с этим Mixin на основе динамического метапрограммирования. Rails и Redmine используют множество этих трюков в качестве крючков и т. д., Чтобы выполнить работу.

отличное видео на объектной модели Ruby от Dave Thomas
видео на объектной модели Ruby и мета-Программирование


Как говорится в redmine wiki страница о плагине крючки:

существует список допустимых крючков. Но лучший способ найти их - просто заглянуть в код, чтобы найти место, которое вы хотели бы расширить, и найти вызов на крючок поблизости.

Кажется просмотр основных классов а также смотреть на другие плагины-это путь.

Я предполагаю, что вы уже нашли всю документацию на вики, связанных с плагинами:

Как активность на форуме, вы можете попробовать задать вопрос на the форум chiliproject, недавняя вилка redmine. Не уверен, однако, насколько он уже изменился.