Подтвердить что ты не робот

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

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

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

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

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

4b9b3361

Ответ 1

лучшей документацией является источник кода. Один из главных контроллеров Redmine имеет почти все плагины Redmine на github.

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

Ответ 2

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

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

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

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

Общие сведения о Rails:
Я нашел книгу Agile Web Development with Rails, чтобы быть достаточно хорошим введением в Rails для программистов с других языков.
Примечание. Целевая аудитория, по-видимому, является разработчиком Rails, но через эту обучающую кривую можно пройти, просмотрев репозитории gigub redmine plugin.

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

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

Одна строка кода Rails содержит достаточно таких трюков, чтобы заполнить небольшую книгу.
К счастью, такая книга уже написана - Ruby MetaProgramming в серии Pragmatic Programmers. Это превосходно, чтобы справиться с этим динамическим метапрограммированием на основе Mixin. Rails и Redmine используют множество этих трюков как крючки и т.д., Чтобы выполнить эту работу.

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

Ответ 3

Как указано на странице redmine wiki о подключаемых плагинах:

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

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

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

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