This is the first blog post in a series of posts relating to building plugins for Umbraco v5 (Jupiter)
This post is about developing for Umbraco v5 (Jupiter) which at the time of this post is still under development. The technical details described below may change by the time Umbraco Jupiter is released. If you have feedback on the technical implementation details, please comment below.
What is a plugin
Since Umbraco Jupiter has been built from the ground up, we first need to define some v5 terminology:
- Plugin = A single functional component that extends Umbraco such as a Tree, an Editor, a Menu Item, etc…
- Package = A group of Plugins installed into Umbraco via the ~/Plugins/Packages/[Package Name] folder
The Umbraco v5 back-office has been architected to run entirely on Plugins, in fact the core trees, editors, etc… that are shipped with Umbraco are Plugins in v5.
Types of plugins
The list of Plugin types will most likely increase from the time of this blog post to when Jupiter is launched but as it stands now here are the types of Plugins supported in v5:
- Property Editors
- This term is new to v5. In v4.x there was no differentiation between a Data Type and it’s underlying ‘Data Type’ editor. In v5 we’ve made a clear distinction between a ‘Data Type’ (as seen in the Data Type tree and used as properties for Document Types) and the underlying editor and pre-value editor that it exposes. An example of a Property Editor would be uComponents’ Multi-Node Tree Picker. An example of a Data Type would be when an Umbraco administrator creates a new Data Type node in the Data Type tree and assigns the Multi-Node Tree Picker as it’s Property Editor.
- So uComponents Team, this is where you need to focus your efforts for version 5!
- Menu Items
- Context menu items such as Create, Publish, Audit Trail, etc… are all plugins.
- See this post in regards to creating menu items in v5, though there have been some new features added since that article was created which I’ll detail in coming posts in this series.
- Editor plugins are all of the interactions performed in the right hand editor panel and in modal dialogs in the back-office.
- For example, the Content Editor core plugin in v5 manages the rendering for all views such as editing content, sorting, copying, and moving nodes, and nearly all of the other views that the context menu actions render.
- All trees are plugins, for example, the Content tree, Media tree, Document Type tree are all different plugins.
- Trees are actually MVC controllers.
- Tree nodes use Menu Items to render Editors
- Presentation Addins (Yet to be officially named)
- Another type of plugin are Controllers that are installed via packages that interact with the presentation layer, an example of this might be the Controller Action that accepts the post values from a Contour form.
In the coming blog posts I’ll talk about
- how plugins are installed and loaded
- how the Umbraco routing system works with all of these controllers
- how and where the Views are stored that the plugins reference
- how to create all of the different types of plugins
Code Garden 2011
I’ll be doing a talk on Plugins for Umbraco Jupiter at Code Garden 2011 this year which will go in to a lot more detail than these blog posts. If you are attending Code Garden already, then hopefully this series will give you a head start on Umbraco v5. If you haven’t got your tickets to Code Garden yet, what are you waiting for?! We have so much information to share with you :)