AppSuite:Developing for the UI: Difference between revisions
| Line 30: | Line 30: | ||
[[AppSuite:Writing a portal plugin | A portal plugin]] is a widget, which can be used in the 'portal'-section of appsuite only. Please just check for the right [[AppSuite:Extension points |extension point]] to write a plugin which extends and interacts with other parts of AppSuite. | [[AppSuite:Writing a portal plugin | A portal plugin]] is a widget, which can be used in the 'portal'-section of appsuite only. Please just check for the right [[AppSuite:Extension points |extension point]] to write a plugin which extends and interacts with other parts of AppSuite. | ||
Configure portal plugins can be achieved by reading [[AppSuite:Configuring portal plugins | this guide]] | |||
The Upsell widget following [[AppSuite:Using the Upsell widget | this one]]. | |||
If you need to develop a complete application for AppSuite which should be displayed full screen and appear as a bread crump in the title bar, take a look at the article about [[AppSuite:Writing a simple application | 'Writing a simple application']]. | If you need to develop a complete application for AppSuite which should be displayed full screen and appear as a bread crump in the title bar, take a look at the article about [[AppSuite:Writing a simple application | 'Writing a simple application']]. | ||
Revision as of 12:08, 17 October 2013
This portal contains articles about the inner workings of the web-based graphical user interface. It is aimed at software developers that want to improve on existing features, implement extensions or just gain a general understanding.
Tech Overview
All technologies and frameworks used for developing the UI are listed and described in the following article: Skills needed to develop the UI
In addition to those UI developing technologies you also need the environment for running (at least parts of) the appsuite locally. Therefore you can either copy the source from openxchange git repositories and host it locally using apache or run Appserver (with local parts of the appsuite) automaticly getting the recent stable source packages from the appsuite servers.
Developing Style Guide
While developing code for OX products the UI Developement Style Guide helps you writing safe, clear and functional code.
Designing apps, plugins and widgets running with the right layout, colors, look and feel is a breeze following the guidelines described in the UI Design Guide.
Always keep in mind, that using OX products should be possible for everyone and therefor it's important to follow simple rules regarding accessibility.
Writing apps or plugins for appsuite will often include extending the existing user interface. Appsuite provides extension points offering you possibilties to add your own contents. Beginning to develop using extension points? Read this guide first having a hands-on introduction for extending the OX user interface. Get more information and a complete list of extension points offered by OX products.
How to get code
Using git as a version version control system getting the code from existing OX products is quite easy. Simply clone the UI or the backend repository and start working with it.
What can i build?
There are several possibilities to develop for AppSuite.
A portal plugin is a widget, which can be used in the 'portal'-section of appsuite only. Please just check for the right extension point to write a plugin which extends and interacts with other parts of AppSuite.
Configure portal plugins can be achieved by reading this guide
The Upsell widget following this one.
If you need to develop a complete application for AppSuite which should be displayed full screen and appear as a bread crump in the title bar, take a look at the article about 'Writing a simple application'.
Other ways to extend appsuite are:
- Writing a plugin for the notification area
- Writing a wizard
- Embedding your application settings into the general Appsuite settings module
You got stuck somewhere? There are some hints, which might help you debugging the UI.
How to get your code running
Written your first app/plugin? Using the UI build system will help you to get fast, easy-to-distribute and correct builds running on your AppSuite. The article will show you how to package your code and copy from OX source code / directories.