Added by Kiffin Gish over 8 years ago
I am investigating the plugin architecture and how best to implement my own plugins. However, there doesn’t seem to be that much detailed information available to assist programmers.
Out of curiosity, I checked the Redmine tutorial at http://www.redmine.org/projects/redmine/wiki/Plugin_Tutorial, but there are a number of subtle differences which are confusing when I try to put them into the perspective of the OpenProject way of doing things.
Please point me to a good reference.
Replies (7)
Hi Kiffin,
Thanks for asking this. I guess the documentation needs to be updated. I just created a work package for this. We will take care of this this week.
Best
Niels
That would be really cool, thanks.
Of course, I’d be happy to assist.
Either by trying things out from scratch and documenting my progress and/or evaluating the tutorial that you create by trying it out myself step by step.
I’m eager to learn…
Hi Kiffin,
Markus just updated the documentation:
https://github.com/opf/openproject/blob/release/6.1/doc/development/create-openproject-plugin.md
Can you please have a look at this and give us feedback on it? Is there anything relevant missing?
Best
Niels
Yes that looks very nice, thanks!
What I still miss however is more detailed instructions which document the available plugin-AP.
For example: how it can hook into the framework, subscribe to certain events, manipulate the front end, access models, and so on.
Otherwise, I can just continue my adventure exploring the code and trying to figure things out myself.
But you can imagine that that might not be as efficient were I to have more detailed instructions.
Keep up the good work.
Hey, we’re working on an example plugin that does all these things: https://github.com/opf/openproject-proto_plugin
That’s just the initial commit. There’s still lots missing including some actual documentation/instructions. But we will be updating this continuously.
I’ll push an update today still including home screen teasers, view hooks and plugin assets among other things.
Looking good, I will eagerly follow progress and see if I can follow suite with my own amazing shadow plugin.
One suggestion might be to use Active Record from the very beginning rather than a static array in the controller.
Don’t get me wrong, kittens are cute…
However, most serious developers prefer to learn to build a real mccoy plugin, e.g. with calls to the database, rake db:migrate and that sort of thing.
Keep up the good work.
Good point. I’ll add a model including the necessary migration later today.