Dobra dokumentacja do pisania wtyczek Redmine

Question

Obecnie rozwijam kilka wtyczek dla Redmine, i muszę powiedzieć, że jestem trochę rozczarowany brakiem dokumentacji na ten temat.

Normalnie, jeśli szukam wyjaśnień na temat zajęć/metod, muszę spędzić niezmienny czas przeglądając podstawowe klasy i starając się zrozumieć napisany tam kod (Wydaje się, że niektórzy ludzie zapomnieli udokumentować swoje kod, niestety).

Sprawdziłem swoje fora http://www.redmine.org/projects/redmine/boards, i wydaje się zawsze, aby na pytanie należy odpowiedzieć.

Dlatego chciałbym kilka porad dotyczących niektórych Dobra dokumentacja API/książki/fora na ten temat.

Answer 1

lepszą dokumentacją jest źródło kodów. Jeden z opiekunów Redmine ma prawie wszystkie wtyczki Redmine na github.

możesz wybrać dowolną wtyczkę i zobaczyć, jak wygląda. głównie chodzi o METAPROGRAMOWANIE i alias_method_in_chain użytkowania

Answer 2

Jak stwierdzono na redmine wiki page about plugin hooks:

Istnieje lista ważnych haków. Ale najlepszym sposobem na ich znalezienie jest po prostu zajrzenie do kodu, aby znaleźć miejsce, które chciałbyś przedłużyć i wyszukać połączenie z hakiem w pobliżu.

Wydaje przejrzenia podstawowych klas a także patrząc na innych wtyczek jest droga.

Zakładam, że już znaleźć całą dokumentację na wiki związanej z wtyczek:

• plugin tutorial
• plugin internals strona
• Powyższa strona wyjaśniając hooks
• I wreszcie list of the currently available hooks (rake redmine:plugins:hook_list, aby uzyskać najnowszą listę zainstalowanych wersji redmine)

Co do reaktywności na forum, można spróbować zadaje pytanie na forum of chiliproject niedawne rozwidleniu Redmine. Nie jestem pewien, jak dużo już się zmieniło.

Answer 3

Wiem, że to może zbyt późno dla oryginalnego zapytania plakat ale może pomóc komuś w podobnej sytuacji. Poniższe linki są dla totalnego początkującego (jak ja) dla RubyOnRails, ale kogoś, kto był zaprogramowany wcześniej. Możesz wybrać i wybrać odpowiednie zgodnie z poziomem umiejętności.

Zrozumienie Redmine (funkcjonalność):
Jeśli nie jesteś zaznajomiony z Redmine lub podawanie innych Issue Tracking Software Mastering Redmine książka jest ok miejsce, aby rozpocząć. Nie jest zbyt gęsto zapakowany, więc pomoże tylko jako uporządkowana organizacja informacji. Jeśli chcesz uzyskać bardziej gęste informacje, przejdź do dokumentacji.

Zrozumienie Redmine wtyczki:
"Redmine Plugin Extension and Development" by Alex Bevilacqua właśnie został zwolniony (marzec 2014). Jest dostępny zarówno w wersji drukowanej, jak i ebookowej z pakietu packtpub.

Sam przechodzę przez książkę, ponieważ potrzebuję dostosować/przepisać wtyczkę dla Redmine. Jestem nowy w Rails/Ruby/Redmine myself. Chociaż jestem z Unix/C++, tło wciąż poznaję arkany Ruby, Rails, Redmine poprzez następujące książki.

Zrozumienie szyn:
znalazłem książkę Agile Web Development with Rails być wystarczająco dobry wstęp do szyn dla programistów z innych języków.
Uwaga: Docelowi odbiorcy wydają się być programistami Rails, ale powinno być możliwe przejście przez tę krzywą uczenia się poprzez przeglądanie repozytoriów pluginów Github redmine.

Zrozumienie Ruby:
Programming Ruby (the PickAxe Book)

Zrozumienie idiomy Ruby metaprogramowanie (używane w Rails):
Na powierzchni Ruby wygląda większości języków skryptowych jest stosowanie METAPROGRAMOWANIE i dynamiczny charakter Ruby Model obiektowy, który pozwala na tworzenie złożonych wewnętrznych gimnastyki niewidocznych dla początkujących.

Pojedyncza linia kodu Railsa zawiera wystarczającą liczbę takich sztuczek, aby wypełnić małą książkę.
Na szczęście taka książka została już napisana - Ruby MetaProgramming książka w serii Pragmatic Programmers. To wspaniałe, aby poradzić sobie z tym dynamicznym MetaProgramming opartym na Mixin. Railsy i Redmine używają wielu tych trików jako haczyków itp., Aby wykonać pracę.

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