Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

(Release Plans)
 
(108 intermediate revisions by 18 users not shown)
Line 1: Line 1:
 
== Development Environment  ==
 
== Development Environment  ==
  
To ease the development on Papyrus, each member of the team works with basically the same configuration. <br>
+
To ease the development on Papyrus, each member of the team works with basically the same configuration.
  
=== Common Environment  ===
+
One way to manage this is using the [[Eclipse Installer]] (by Oomph) to manage your Papyrus development workbench.
  
Following is a description of the basic configuration:
+
=== Papyrus Oomph Setup Model ===
  
*The latest Eclipse Modeling release.
+
The [[Eclipse Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
*[http://www.eclipse.org/projects/project_summary.php?projectid=technology.subversive] SVN Subversive (or Subclipse)
+
*[http://eclipse-cs.sourceforge.net/downloads.html] CheckStyle
+
*[http://jautodoc.sourceforge.net/] JAutoDoc
+
  
=== Required External Plugins ===
+
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse.  On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on.  Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like.  In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform.  This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
  
Papyrus requires some external plugins in order to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]
+
Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.
  
== Development Plan  ==
+
Amongst possibly other details, the setup model configures:
  
=== Specifications  ===
+
* your IDE with all of the tools needed to edit and build the source projects you choose
 +
* your workspace with a Git clone and the source projects imported from it that you choose
 +
* a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
 +
* Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
 +
* Mylyn queries for the status of the latest Papyrus automated builds, including tests
 +
* Mylyn queries for open Gerrit reviews
 +
* preferences enforcing the Papyrus standard compiler and code formatter/template settings
  
The specifications are available here&nbsp;: http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications
+
Please raise bugs if you see any problems in the setup configuration.
  
== Getting the code  ==
+
Follow this [[Papyrus_Developer_Guide/Papyrus_With_Oomph | link]] for a step by step installation guide.
  
=== Connecting to the svn ===
+
=== Common Environment ===
  
The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/
+
Following is a description of the basic configuration:  
  
=== Retrieve code  ===
+
*The latest Eclipse Modeling (Or Standard) release
 +
*EGit
 +
*[http://jautodoc.sourceforge.net/] JAutoDoc
 +
**Configure the header template according to your company: Eclipse Preferences -&gt; Java -&gt; JAutodoc
 +
*Java 1.8:
 +
**Eclipse Preferences -&gt; Java -&gt; Compiler
 +
**Eclipse Preferences -&gt; Java -&gt; Installed JREs
 +
**VM Arguments for debug mode:
 +
<pre>-Dosgi.requiredJavaVersion=1.8 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
 +
</pre>
  
[[PSF]] Following files will allow you to import all Papyrus plugins used during build phase:
+
=== Required External Plugins  ===
PSF files are now automatically generated using the SVN repository. They do not necessarily correspond to what is built.
+
The script used to generate them is available in this project http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/
+
The following psf files are automatically update several time by day.
+
  
*'''Trunk 0.10.X (Kepler)'''
+
Papyrus may require some external plugins to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]
**last versions of the psf files for Papyrus/trunk using http for non-commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_http.psf build_http.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_http.psf extraplugins_http.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_http.psf full_papyrus_http.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_http.psf plugins_http.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_http.psf tests_http.psf] Junit and other test plugins (mandatory for developers)
+
**last versions of the psf files for Papyrus/trunk using svn+ssh for commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_svn_ssh.psf build_svn_ssh.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_svn_ssh.psf extraplugins_svn_ssh.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_svn_ssh.psf full_papyrus_svn_ssh.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_svn_ssh.psf plugins_svn_ssh.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_svn_ssh.psf tests_svn_ssh.psf] Junit and other test plugins (mandatory for developers)
+
  
*'''Branch 0.9.X (Juno)'''
+
=== Version Management Tooling ===
**last versions of the psf files for Papyrus/branch using http for non-commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_0.9.X_http.psf build_0.9.X_http.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_0.9.X_http.psf extraplugins_0.9.X_http.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_0.9.X_http.psf full_papyrus_0.9.X_http.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_0.9.X_http.psf plugins_0.9.X_http.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_0.9.X_http.psf tests_0.9.X_http.psf] Junit and other test plugins (mandatory for developers)
+
**last versions of the psf files for Papyrus/branch using svn+ssh for commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_0.9.X_svn_ssh.psf build_0.9.X_svn_ssh.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_0.9.X_svn_ssh.psf extraplugins_0.9.X_svn_ssh.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_0.9.X_svn_ssh.psf full_papyrus_0.9.X_svn_ssh.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_0.9.X_svn_ssh.psf plugins_0.9.X_svn_ssh.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_0.9.X_svn_ssh.psf tests_0.9.X_svn_ssh.psf] Junit and other test plugins (mandatory for developers)
+
  
===How to update the script generating the psf files.===
+
Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]]
The script is located on build.eclipse.org in /opt/public/modeling/mdt/papyrus/create_psf_files.sh.
+
*To modify it :
+
**download this project with Eclipse http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/
+
**modify it and commit it on the SVN
+
**log you on hudson
+
**execute the script /opt/public/modeling/mdt/papyrus/update_psf_files_script.sh. This script allows to download and "install" the last version of the scripts located in trunk/readme/script (so it updates itself too)
+
  
 +
=== [Future] Maven Integration ===
  
===How to update the psf files provided in /trunk/readme.===
+
The Hudson builds are currently implemented with Maven, using Tycho to build Eclipse-compatible artifacts.  Therefore, all active plug-in and feature projects have Maven POM files describing them.  There is a proposal under consideration to implement Maven Nature provided by M2Eclipse in the Papyrus source projects, to more closely align the Hudson build environment with the developer's local build environment in the Eclipse workbench.
Coming soon
+
  
=== Retrieve configuration files  ===
+
An initial analysis of what would be involved in this change, both in terms of actually implementing the Maven Nature and its impact on Papyrus developers' daily workflow, is captured in this document:
  
The Papyrus [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Code Templates] and [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Java Formatter] files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"<br> [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]<br> [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]<br> Checkstyle&nbsp;: available soon <br>
+
* [http://www.slideshare.net/cdamus/adopting-maven-nature-in-papyrus-source-projects Adopting Maven Nature] in the Papyrus source projects
  
[http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
 
  
== Papyrus Architecture==
 
  
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture| Papyrus Architecture ]]
+
== Getting the code  ==
  
== Papyrus Generation  ==
+
If you are not using Oomph to set your environment you will need to fetch the code manually.
  
*Papyrus generation mechanism is explained here&nbsp;: [[Papyrus Developer Guide/Papyrus diagram generation]]
+
=== Cloning the Git repository and importing the code ===
  
== Papyrus Code Standards  ==
+
The Papyrus code and some documents are located in a Git repository. In the website [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git] you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).
  
*Java Doc - every class, method and field including private ones should be documented with Java Doc
+
Follow this [[Papyrus_Developer_Guide/Papyrus_Git_Tutorial | quick tutorial]] if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.
*No abbreviations - the class, methods and variables should have meaningful names
+
*Formatting - the code should be formatted in accordance with format templates
+
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!
+
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied&nbsp;: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...
+
*In case of doubt - check existing code from those following the rules&nbsp;:-)
+
  
== Papyrus Coding guidelines  ==
 
  
A few points may be a little tricky when coding for Papyrus. Among them&nbsp;:
 
  
=== Papyrus Plugin Naming Scheme and Folders Structure<br> ===
+
 
 +
== Papyrus Architecture ==
 +
 
 +
*[[Dependencies to Eclipse components ]]
 +
 
 +
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
 +
 
 +
*Here are the [[MDT/Papyrus/Developer Guide/HighRequirements|Papyrus Requirements ]].
 +
 
 +
=== Papyrus Plugin Naming Scheme and Folders Structure  ===
  
 
*Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: [[Papyrus Plugin Naming Scheme|Papyrus_Plugin_Naming_Scheme]]
 
*Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: [[Papyrus Plugin Naming Scheme|Papyrus_Plugin_Naming_Scheme]]
Line 108: Line 87:
 
=== Structure and behavior of papyrus  ===
 
=== Structure and behavior of papyrus  ===
  
*Presentation of the papyrus stucture and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
+
*Presentation of the papyrus structure and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
  
 
=== Papyrus Command Execution, History, Undo/Redo  ===
 
=== Papyrus Command Execution, History, Undo/Redo  ===
Line 114: Line 93:
 
*This first document describes the usage of editing domains and gmf/gef/emf commands. See this detailed article [[Papyrus Developer Guide/Editing Domains and Commands]].
 
*This first document describes the usage of editing domains and gmf/gef/emf commands. See this detailed article [[Papyrus Developer Guide/Editing Domains and Commands]].
  
*This second document tries to explain how the differents Eclipse Command frameworks work and how they are related. It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.
+
=== Papyrus ServiceRegistry  ===
**http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/architecture/commandExecution.doc
+
**Following UML model with code reverse can also be useful:
+
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.di
+
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.notation
+
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.uml
+
  
=== Papyrus ServiceRegistry<br>  ===
+
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.  
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.
+
 
 +
The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task. <br> A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discussed here [[Papyrus Developer Guide/Service Registry]]
 +
 
 +
=== Manage Decorators On Papyrus ===
 +
Papyrus provide services in order To manage decoration on Edit Parts from graphical editor or on icons from model explorer. An application example are describe here: [[Manage Decorators On Papyrus]]
 +
 
 +
=== Papyrus Log  ===
 +
 
 +
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]]
 +
 
 +
=== Papyrus Editors  ===
 +
 
 +
Currently Papyrus provides 2 editors kinds&nbsp;: Diagrams and Table. How to add your own editor kind is explained here [[Papyrus Developper Guide/How to - Add your own editor in Papyrus]]
 +
 
 +
=== JUnit Tests  ===
 +
 
 +
* How to add JUnit tests to the build: [[Papyrus Developer Guide/Add JUnit Test Bundle]]
 +
* A code generation framework has been developed to automatically generate JUnit tests for GMF-based editors:  [[Papyrus Developer Guide/Automatic Test Generation for Diagram Editors]]
 +
* Useful utilities for JUnit tests:  [[Papyrus Developer Guide/JUnit Test Framework]]
 +
 
 +
=== Papyrus Table Developer Documentation  ===
 +
* The documentation for developers is available here [[Table Developer Documentation]]
 +
 
 +
=== Papyrus Diagram Developer Documentation  ===
 +
* The documentation for developpers is available here [[Diagram Developer Documentation]]
 +
 
 +
=== Papyrus Embedded Editors Documentation  ===
 +
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
 +
 
 +
 
 +
 
 +
== Developer Charter==
 +
This is the charter that all papyrus contrubitor must respect.[[MDT/Papyrus/Developer Guide/Charter|Papyrus Contributor charter ]]
 +
 
 +
 
 +
 
 +
== Contributing to Papyrus  ==
 +
 
 +
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
 +
 
 +
=== Retrieve configuration files  ===
 +
 
 +
The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/Papyrus%20Code%20templates.xml Code Templates], [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_cleanup.xml Java Cleanup] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_formatter.xml Java Formatter] files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.
 +
 
 +
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
 +
 
 +
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
 +
 
 +
[http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
 +
 
 +
===String Externalization/Internalization===
 +
*the goal of the externalization process is to distinguish the string used as messages and visible by the final user and the string required in your code, but not visible for the user,
 +
 
 +
Follow this [[Papyrus_Developer_Guide/Externalize_Strings_In_Java | link]] for a guide on externalization in Eclipse.
 +
 
 +
=== Papyrus Plug-ins and Features  ===
 +
 
 +
See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
 +
 
 +
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
 +
 
 +
=== Write Documentation for Papyrus  ===
 +
 
 +
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]
 +
 
 +
=== Code Contributions and Reviews ===
 +
 
 +
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]]
  
The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task.
 
<br>
 
A new implementation of the ServiceRegistry is submitted.
 
The new ServiceRegistry is discused here [[Papyrus Developer Guide/Service Registry]]
 
  
<br>
 
  
 
== How To ...  ==
 
== How To ...  ==
  
=== Commit, Report Bugs, patchs (Code Contributing) ===
+
=== Gerrit Contributions ===
  
*How To - related to reporting bugs, patching, commit, ... [[Papyrus Developer Guide/How To- Code Contributing]]
+
*[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to contribute via Gerrit]]
 +
 
 +
=== Papyrus Diagram Generation  ===
 +
 
 +
*Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]]
 +
 
 +
=== Model your papyrus development, and generate User doc  ===
 +
 
 +
*How To - create your model (requirements, use cases, design, tests) ... [[Papyrus Developer Guide/Model your development]]
  
 
=== Papyrus Code Examples  ===
 
=== Papyrus Code Examples  ===
Line 141: Line 185:
 
*How to - Related to Papyrus code,[[Papyrus Developer Guide/How To Code Examples]]<br>
 
*How to - Related to Papyrus code,[[Papyrus Developer Guide/How To Code Examples]]<br>
  
=== Papyrus Log  ===
+
===Rcptt Tests ===
  
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]]
+
Rcptt is under evaluation but a developer guide can be find [[Papyrus/RCPTT|here]].
  
=== Papyrus Editors ===
 
Currently Papyrus provides 2 editors kinds : Diagrams and Table. How to add your own editor kind is explained here [[Papyrus Developper Guide/How to - Add your own editor in Papyrus]]
 
  
=== Papyrus Discovery===
 
To add extra features to the Papyrus Discover, you should edit the files located here : /cvsroot/org.eclipse/HEAD/www/modeling/mdt/papyrus/downloazds/discovery/juno/
 
  
== Papyrus Build Process  ==
+
== Release Engineering ==
  
*Papyrus build process on Athena is explained here [[Papyrus Developer Guide/Build Process]].<br>
+
=== Release Plans  ===
  
 +
The specifications are available here:
 +
* [https://wiki.eclipse.org/Oxygen/Simultaneous_Release_Plan Oxygen release plan]
 +
* [https://wiki.eclipse.org/Photon/Simultaneous_Release_Plan Photon release plan]
  
 +
Future Release plans should become available here:
 +
* [https://wiki.eclipse.org/SimRel/Simultaneous_Release_Cycle_FAQ#What_is_the_schedule_of_the_next_releases_.3F Eclipse 20xx.xx release plan]
  
== New plugin Submition Process  ==
+
=== Contributing to the plan for the release ===
  
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
+
* [[Papyrus Developer Guide/Contributing To Release Plan | Contribute to the Release Plan]]
 +
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
 +
 
 +
=== Release Process ===
 +
 
 +
*[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]].
 +
*[[Papyrus Developer Guide/Release Process: Doc | Releng Documentation]].
 +
*[[Papyrus Developer Guide/Release Standard Operating Procedure: Doc | Release Standard Operating Procedure]].
 +
 
 +
=== API Evolution ===
 +
 
 +
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]
 +
 
 +
=== Hudson Instance ===
 +
 
 +
*Papyrus Hipp standard guide: [[Papyrus Developer Guide/How to use the Hipp and its functionalities]].
 +
 
 +
 
 +
[[Category:Papyrus]]

Latest revision as of 02:47, 3 July 2018

Development Environment

To ease the development on Papyrus, each member of the team works with basically the same configuration.

One way to manage this is using the Eclipse Installer (by Oomph) to manage your Papyrus development workbench.

Papyrus Oomph Setup Model

The Eclipse Installer provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.

Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand Eclipse.org / Papyrus to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).

Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.

Amongst possibly other details, the setup model configures:

  • your IDE with all of the tools needed to edit and build the source projects you choose
  • your workspace with a Git clone and the source projects imported from it that you choose
  • a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
  • Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
  • Mylyn queries for the status of the latest Papyrus automated builds, including tests
  • Mylyn queries for open Gerrit reviews
  • preferences enforcing the Papyrus standard compiler and code formatter/template settings

Please raise bugs if you see any problems in the setup configuration.

Follow this link for a step by step installation guide.

Common Environment

Following is a description of the basic configuration:

  • The latest Eclipse Modeling (Or Standard) release
  • EGit
  • [1] JAutoDoc
    • Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
  • Java 1.8:
    • Eclipse Preferences -> Java -> Compiler
    • Eclipse Preferences -> Java -> Installed JREs
    • VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=1.8 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled

Required External Plugins

Papyrus may require some external plugins to compile.
The following page maintain a list of Papyrus Required External Plugins

Version Management Tooling

Oomph includes a way to manage the version changes between two releases as illustrated here

[Future] Maven Integration

The Hudson builds are currently implemented with Maven, using Tycho to build Eclipse-compatible artifacts. Therefore, all active plug-in and feature projects have Maven POM files describing them. There is a proposal under consideration to implement Maven Nature provided by M2Eclipse in the Papyrus source projects, to more closely align the Hudson build environment with the developer's local build environment in the Eclipse workbench.

An initial analysis of what would be involved in this change, both in terms of actually implementing the Maven Nature and its impact on Papyrus developers' daily workflow, is captured in this document:


Getting the code

If you are not using Oomph to set your environment you will need to fetch the code manually.

Cloning the Git repository and importing the code

The Papyrus code and some documents are located in a Git repository. In the website http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).

Follow this quick tutorial if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.



Papyrus Architecture

Papyrus Plugin Naming Scheme and Folders Structure

Structure and behavior of papyrus

Papyrus Command Execution, History, Undo/Redo

Papyrus ServiceRegistry

The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.

The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task.
A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discussed here Papyrus Developer Guide/Service Registry

Manage Decorators On Papyrus

Papyrus provide services in order To manage decoration on Edit Parts from graphical editor or on icons from model explorer. An application example are describe here: Manage Decorators On Papyrus

Papyrus Log

Papyrus Editors

Currently Papyrus provides 2 editors kinds : Diagrams and Table. How to add your own editor kind is explained here Papyrus Developper Guide/How to - Add your own editor in Papyrus

JUnit Tests

Papyrus Table Developer Documentation

Papyrus Diagram Developer Documentation

Papyrus Embedded Editors Documentation


Developer Charter

This is the charter that all papyrus contrubitor must respect.Papyrus Contributor charter


Contributing to Papyrus

Each developer must follow the following rule in addition to the aforementioned Developer Charter.

Retrieve configuration files

The Papyrus Code Templates, Java Cleanup and Java Formatter files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.

FAQ How do I control the Java formatter

FAQ How can templates make me the fastest coder ever

The note explains how to install the templates in your environment.

String Externalization/Internalization

  • the goal of the externalization process is to distinguish the string used as messages and visible by the final user and the string required in your code, but not visible for the user,

Follow this link for a guide on externalization in Eclipse.

Papyrus Plug-ins and Features

See Papyrus code standards for plug-ins and features

New plugin should follow the submition process describe here: Papyrus New Plugin Submission Process

Write Documentation for Papyrus

How to - Related to documentation Papyrus Developer Guide/Writing Documentation

Code Contributions and Reviews


How To ...

Gerrit Contributions

Papyrus Diagram Generation

Model your papyrus development, and generate User doc

Papyrus Code Examples

Rcptt Tests

Rcptt is under evaluation but a developer guide can be find here.


Release Engineering

Release Plans

The specifications are available here:

Future Release plans should become available here:

Contributing to the plan for the release

Release Process

API Evolution

Hudson Instance

Back to the top