|
|
AF3 Plugins Conventions
|
|
|
=======================
|
|
|
|
|
|
Naming conventions
|
|
|
------------------
|
|
|
|
|
|
We distinguish consistently between plugins concerning the AF3 modeling
|
|
|
language and its user interface implementation.
|
|
|
The naming convention is
|
|
|
|
|
|
org.fortiss.af3.the_plugin
|
|
|
|
|
|
|
|
|
for the language (meta-model, semantic functionality), and
|
|
|
|
|
|
org.fortiss.af3.the_plugin.ui
|
|
|
|
|
|
|
|
|
for the presentation and user interaction implementation.
|
|
|
|
|
|
Top-level Packages
|
|
|
------------------
|
|
|
|
|
|
The modeling language plugins will adhere to the following list of
|
|
|
top-level packages.
|
|
|
|
|
|
**model**: The EMF meta-model classes. This package is usually found in
|
|
|
*generated-src* folder.
|
|
|
**annotations**: Implementation related to the annotation framework.
|
|
|
**compose**: Implementations of compositors.
|
|
|
**constraint**: Implementations of constraints.
|
|
|
**generator**: Implementations of generators (if the language supports
|
|
|
that). Target language identifier is usually the next level of package
|
|
|
names, e.g. **generator.java**.
|
|
|
**prototypes**: Implementation of prototypes.
|
|
|
**simulator**: Implementations of a simulator backend (if the language
|
|
|
supports that).
|
|
|
**utils**: Utility classes and methods. Classes in this package only
|
|
|
contain static implementations.
|
|
|
|
|
|
The user interface plugins will adhere to the following list of
|
|
|
top-level elements.
|
|
|
|
|
|
**editor**: Implementations of editors.
|
|
|
**editpart**: Implementations of graphical editors’ parts.
|
|
|
**handler**: Implementations of model element handlers.
|
|
|
**properties**: Implementations of property sections.
|
|
|
**simulator**: Implementations of a simulator front-end (if the language
|
|
|
supports that).
|
|
|
**utils**: Utility classes and methods. Classes in this package only
|
|
|
contain static implementations.
|
|
|
|
|
|
Adding a new plugin
|
|
|
===================
|
|
|
|
... | ... | @@ -6,6 +58,8 @@ the AF3 repository, adjusting the developer product files and installer, |
|
|
and registering it at the maven/jenkins config files. The following
|
|
|
section explain these steps in detail.
|
|
|
|
|
|
|
|
|
|
|
|
Preparational steps & checks
|
|
|
----------------------------
|
|
|
|
... | ... | |