Papyrus/Papyrus Developer Guide
- 1 Development Environment
- 2 Getting the code
- 3 Papyrus Architecture
- 3.1 Papyrus Plugin Naming Scheme and Folders Structure
- 3.2 Structure and behavior of papyrus
- 3.3 Papyrus Command Execution, History, Undo/Redo
- 3.4 Papyrus ServiceRegistry
- 3.5 Manage Decorators On Papyrus
- 3.6 Papyrus Log
- 3.7 Papyrus Editors
- 3.8 JUnit Tests
- 3.9 Papyrus Table Developer Documentation
- 3.10 Papyrus Diagram Developer Documentation
- 3.11 Papyrus Embedded Editors Documentation
- 3.12 Papyrus Generation
- 4 Developer Charter
- 5 Contributing to Papyrus
- 6 How To ...
- 7 Release Engineering
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.
Following is a description of the basic configuration:
- The latest Eclipse Modeling (Or Standard) release
-  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:
- Adopting Maven Nature in the Papyrus source projects
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 is explained here: Papyrus Architecture
- Here are the 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
Structure and behavior of papyrus
- Presentation of the papyrus structure and the behavior of some parts Papyrus Developer Guide/Papyrus Structure Behavior
Papyrus Command Execution, History, Undo/Redo
- 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.
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 is explained here Papyrus Developer Guide/Papyrus Log
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
- 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
- Papyrus generation mechanism is explained here: Papyrus Developer Guide/Papyrus diagram generation
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 note explains how to install the templates in your environment.
- 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
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
How To ...
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
- How to - Related to Papyrus code,Papyrus Developer Guide/How To Code Examples
Rcptt is under evaluation but a developer guide can be find here.
The specifications are available here:
Contributing to the plan for the release
- Papyrus API Evolution Reports: Papyrus Developer Guide/API Evolution Reports
- Papyrus Hipp standard guide: Papyrus Developer Guide/How to use the Hipp and its functionalities.