Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Developer Charter==
 
This is the charter that all papyrus contrubitor must respect.[[MDT/Papyrus/Developer Guide/Charter|Papyrus Contributor charter ]]
 
 
 
== Development Environment  ==
 
== Development Environment  ==
  
Line 28: Line 25:
 
Please raise bugs if you see any problems in the setup configuration.
 
Please raise bugs if you see any problems in the setup configuration.
  
When you first launch the Eclipse Installer, it will show the default "simple mode" installer presentation:
+
Follow the following link for a step by step installation guide: [[Papyrus_Developer_Guide/Papyrus_With_Oomph | Oomph setup guide]]
 
+
[[Image:Papyrus_Oomph_simple.png]]
+
 
+
You can choose to proceed from here, picking for example the "Eclipse IDE for Committers" package to install, which is the minimal configuration, and later using Oomph to import the Papyrus sources into the workspace (box 1 in the screenshot).  However, you may as well select all of the Papyrus content that you need in your development environment now to set everything up in one go.  To do that, switch to the "advanced mode":  open the dialog tray by clicking on the button (box 2) and select "Advanced Mode..." (box 3).  Now you should see the dialog reconfigured as shown below:
+
 
+
[[Image:Papyrus_Oomph_page1.png]]
+
 
+
Again, the simplest option is to start with the "Eclipse IDE for Committers" package because the setup model will add everything else you need for working on Papyrus's various code and models.
+
 
+
On the second page, pick whatever Papyrus components you need to import into the workspace:
+
 
+
[[Image:Papyrus_Oomph_page2.png]]
+
 
+
{{note|Minimal Project Selection|Note that, at a minimum, you must select the top-level "Papyrus" project node for import, to get the correct tooling installed for working with the source and to bring the nightly builds into your PDE Target}}.
+
 
+
If you need to work on and test the Papyrus setup model, itself, then you should also import the "Papyrus / Developer / Oomph Setup" project (selected in the screenshot above) to configure the workbench to load the Papyrus setup model from your Git checkout instead of from the central Git repository via HTTP.
+
 
+
Next, tell Oomph where to check out the Papyrus repository, where to install Eclipse, and where to create the workspace:
+
 
+
[[Image:Papyrus_Oomph_page3.png]]
+
 
+
'''Note''' that exactly how this page looks will depend on the options you choose for how to manage installation and workspace locations, and whether you have previously used Oomph to install other Eclipse instances (I have).
+
 
+
'''Note''' also that if you do not see the target platform that you need in the 'Target Platform' pick-list (for example, Neon to start working on the Papyrus Neon branch that is the master at the time of this writing), then you can just type the name into the field.
+
 
+
The last page summarizes the steps that Oomph will follow to start the installation:
+
 
+
[[Image:Papyrus_Oomph_page4.png]]
+
 
+
After the newly installed Eclipse instance starts up, it will complete the setup by performing the rest of the tasks that have to be done in the workspace that didn't exist initially.  These include the git checkout, importing projects from the checkout into the workspace, creating working sets, Mylyn queries, and more.  Once these steps have completed, you will be ready to start working on the Papyrus code.
+
 
+
If you used Oomph's "simple mode" to create your Eclipse workspace, or if you need to make changes to what Papyrus bits you have imported (even for setting up the set-up model redirection), you can do this at any time by launching the Oomph installer wizard from within the Eclipse workbench.  '''Note''' that you will first have to make the Oomph setup actions available in the toolbar be enabling the preference:
+
 
+
[[Image:Papyrus_Oomph_updater.png]]
+
 
+
This launches essentially the same wizard as the "advanced mode" of the Oomph Installer.
+
  
 
=== Common Environment  ===
 
=== Common Environment  ===
Line 87: Line 48:
 
=== Version Management Tooling ===
 
=== Version Management Tooling ===
  
As of late February 2016 in the Neon development cycle, the Papyrus Main plug-ins and features and the Developer Tools are configured for PDE API Tooling and Oomph Version Management validation.  One of the value-added capabilities of Oomph is flagging plug-ins and features that aren't included in any other feature, and thus appear to be slipping through a crack in the release.  This only works when the workspace has all of the plug-in and feature projects of Papyrus imported.
+
Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]]
 
+
If your workspace only has a subset of the Papyrus projects imported, then you can tell Oomph that this check is not appropriate by configuring the "check mode" in the Preferences:
+
 
+
[[File:Papyrus_Oomph_versionmgmt_prefs.png|800px]]
+
  
 
=== [Future] Maven Integration ===
 
=== [Future] Maven Integration ===
Line 101: Line 58:
 
* [http://www.slideshare.net/cdamus/adopting-maven-nature-in-papyrus-source-projects Adopting Maven Nature] in the Papyrus source projects
 
* [http://www.slideshare.net/cdamus/adopting-maven-nature-in-papyrus-source-projects Adopting Maven Nature] in the Papyrus source projects
  
== Development Plan  ==
 
  
=== Specifications  ===
 
  
The specifications are available here: [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/papyrus/project-info/plan_luna.xml Luna plan]
+
== Getting the code  ==
  
=== Contributing to the plan for the release ===
+
If you are not using Oomph to set your environment you will need to fetch the code manually.
 
+
*How To - Contributing to the release plan, ... [[Papyrus Developer Guide/Contributing To Release Plan]]
+
 
+
== Getting the code  ==
+
  
 
=== Cloning the Git repository and importing the code ===
 
=== Cloning the Git repository and importing the code ===
Line 117: Line 68:
 
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).
 
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).
  
Follow the next instructions 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.  
+
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.
  
First, you have to clone the Papyrus repository. Open the Eclipse import wizard (“File” => “Import”), select “Git” => “Projects from Git” and click “Next”. Select “Clone URI” and click “Next”. Now you will have to enter the repository’s location and connection data. Entering the repository URI will automatically fill some fields. In the case of using the URI http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git, you will not have to fill any field. Complete any other required fields and hit “Next”.
 
  
The Git repository of Papyrus contains many different branches and you must select at least one. Select the branch “streams/1.1-maintenance” if you want to fix code bugs in the Mars version of the Papyrus plugins or “master” if you want to contribute with new features to the latest version of Papyrus called Neon. Click “Next” and select the storage location (e.g., “C:\git”) and the name of the initial branch (e.g., “streams/1.1-maintenance”).
 
  
Finally, follow the import projects wizard to select the plugins projects that you want to study or modify, and click “Finish”. You will see all those projects in your workspace.
 
 
See the [https://projects.eclipse.org/projects/modeling.mdt.papyrus/developer Papyrus project developer resources] page for more details
 
 
=== Note about compilable plugins ===
 
 
To know if a downloaded plugin should compile, you can have a look to a Papyrus installation. If the plugin comes with the installation, it should compile!
 
 
*The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
 
<pre>all plugins of the layer 'developer', except if you need to generate diagrams (in this case you should install GMF Tooling as well)
 
oep.infra.emf.editor
 
oep.infra.emf.embeddededitor
 
oep.infra.emf.newchild
 
oep.team.svn
 
</pre>
 
*Only the follwing projects are currently provided by the Papyrus extra-plugins update site. The others projects can be closed.(They are deprecated, not yet provided in the Papyrus distribution or for developpers only):
 
<pre>
 
org.eclipse.papyrus.compare.report.ui
 
org.eclipse.papyrus.compare.report
 
org.eclipse.papyrus.diagramtemplate.edit
 
org.eclipse.papyrus.diagramtemplate.editor
 
org.eclipse.papyrus.diagramtemplate
 
org.eclipse.papyrus.eclipse.project.editors
 
org.eclipse.papyrus.infra.gmfdiag.css.configuration
 
org.eclipse.papyrus.infra.gmfdiag.css.properties
 
org.eclipse.papyrus.infra.gmfdiag.css.theme
 
org.eclipse.papyrus.infra.gmfdiag.css.xtext.ui
 
org.eclipse.papyrus.infra.gmfdiag.css.xtext
 
org.eclipse.papyrus.infra.gmfdiag.css
 
org.eclipse.papyrus.layout.algorithms.gridAlgorithm
 
org.eclipse.papyrus.layout.algorithms.horizontalAlgorithm
 
org.eclipse.papyrus.layout.algorithms.horizontalSymmetryAlgorithm
 
org.eclipse.papyrus.layout.algorithms.horizontalTreeAlgorithm
 
org.eclipse.papyrus.layout.algorithms.radialAlgorithm
 
org.eclipse.papyrus.layout.algorithms.springAlgorithm
 
org.eclipse.papyrus.layout.algorithms.treeAlgorithm
 
org.eclipse.papyrus.layout.algorithms.verticalAlgorithm
 
org.eclipse.papyrus.layout.algorithms.verticalSymmetryAlgorithm
 
org.eclipse.papyrus.layout.subeditor.gmf
 
org.eclipse.papyrus.layout
 
org.eclipse.papyrus.marte.properties
 
org.eclipse.papyrus.marte.static.profile
 
org.eclipse.papyrus.marte.vsl
 
org.eclipse.papyrus.migration.properties.model
 
org.eclipse.papyrus.uml.export
 
</pre>
 
*The tests plug-ins are located under tests/junit/plugins or tests/junit/extraplugins. Other test projects are not necessarily maintained
 
 
 
=== 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/<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>
 
 
[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.
 
  
 
== Papyrus Architecture ==
 
== Papyrus Architecture ==
Line 184: Line 79:
 
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
 
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
  
== Papyrus Requirements==
+
*Here are the [[MDT/Papyrus/Developer Guide/HighRequirements|Papyrus Requirements ]].
*This topic contains all [[MDT/Papyrus/Developer Guide/HighRequirements|Papyrus Requirements ]].
+
  
== Papyrus Generation ==
+
=== Papyrus Plugin Naming Scheme and Folders Structure ===
  
*Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]]
+
*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 Code Standards ==
+
=== Structure and behavior of papyrus ===
  
*Java Doc - every class, method and field including private ones should be documented with Java Doc
+
*Presentation of the papyrus structure and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
*No abbreviations - the class, methods and variables should have meaningful names
+
*Formatting - the code should be formatted in accordance with format templates
+
*Always use brackets in conditions, loops, ...
+
*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: 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;:-)
+
  
===String Externalization/Internalization===
+
=== Papyrus Command Execution, History, Undo/Redo  ===
*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,
+
====in java code====
+
#messages/string visible by the user must be in a Messages.properties file, located in a java package called '''your.plugin.name.messages'''
+
#Exception message must not be translated, even if they are visible by the final user. We need to avoid to receive bugs with exception message in another language than english.
+
#String hidden for the final user, must have the tag //$NON-NLS-index. (index starting to 1, with no space between the <code>//</code> and the <code>$</code>.
+
#Each string displayed to the user, must be written in one string:
+
<b>Bad code</b>:
+
  
<code>String fileName = "aFileName";
+
*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]].
  
String message = "The file " + fileName + " can't be found";
+
=== Papyrus ServiceRegistry  ===
</code>
+
  
This message is splitted in 2 strings. It is not good, because the translator doesn't know what he is translating and the order of the words can change from english to another language, so we recommand:
+
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.
  
<b>Good code</b>:
+
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]]
  
<code>String fileName = "aFileName";
+
=== 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]]
  
String message = NLS.bind("The file {0} can't be found", fileName);
+
=== Papyrus Log  ===
</code>
+
  
In this message, there is only one string to translate, the translator, can move the {0} to the good location in the new language.
+
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]]
The method <code>String#format</code> should work fine too.
+
  
=====How to process to manage strings in your java file?=====
+
=== Papyrus Editors  ===
  
*step 1: Open the Externalization menu: Left Click -> Source-> Externalize Strings...:
+
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  ===
  
[[File:ExternalizationMenu.png]]
+
* 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]]
  
*step 2: give a nice name to the string
+
=== 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]]
  
[[File:giveAniceName.png]]
+
=== Papyrus Embedded Editors Documentation  ===
 +
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
  
*step3: configure the output package
 
  
  
[[File:configureOutput.png]]
+
== Contributing to Papyrus  ==
  
*step 4: the result
+
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
  
 +
=== Retrieve configuration files  ===
  
[[File:resultExternalizationt.png]]
+
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.
  
=====How to process to manage strings in your plugin.xml file?=====
+
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
In plugin.xml, you should do the same thing, from the Overview tab. The output folder shouldn't changed:
+
  
 +
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
  
[[File:pluginExternalization.png]]
+
[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.
 
+
=====How to define if a string must be externalized creating a new extension point?=====
+
Set the field '''translatable''' to <code>true</code>:
+
  
 +
===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,
  
[[File:pluginTranslatable.png]]
+
Follow this [[Papyrus_Developer_Guide/Externalize_Strings_In_Java | link]] for a guide on externalization in Eclipse.
  
 
=== Papyrus Plug-ins and Features  ===
 
=== Papyrus Plug-ins and Features  ===
Line 265: Line 150:
 
See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
 
See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
  
== Papyrus Coding guidelines  ==
+
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
  
A few points may be a little tricky when coding for Papyrus. Among them:
+
=== Write Documentation for Papyrus ===
  
=== Papyrus Plugin Naming Scheme and Folders Structure<br>  ===
+
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]
  
*Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: [[Papyrus Plugin Naming Scheme|Papyrus_Plugin_Naming_Scheme]]
+
=== Code Contributions and Reviews ===
  
=== Structure and behavior of papyrus ===
+
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to 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]].
 
 
*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.
 
**http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/commandExecution.doc
 
**Following UML model with code reverse can also be useful:
 
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.di
 
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.notation
 
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/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 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]]
 
  
 
== 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]]
  
=== Commit, Report Bugs, patchs (Gerrit Contributing) ===
+
=== Papyrus Diagram Generation ===
  
*How To - related to reporting bugs, patching, commit, ... [[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit]]
+
*Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]]
  
 
=== Model your papyrus development, and generate User doc  ===
 
=== Model your papyrus development, and generate User doc  ===
Line 314: Line 179:
  
 
*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  ===
 
 
*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]]
 
  
 
===Rcptt Tests ===
 
===Rcptt Tests ===
Line 333: Line 184:
 
Rcptt is under evaluation but a developer guide can be find [[Papyrus/RCPTT|here]].
 
Rcptt is under evaluation but a developer guide can be find [[Papyrus/RCPTT|here]].
  
=== Write Documentation for Papyrus  ===
 
  
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]
 
  
=== Contribute to Papyrus release plan ===
+
== Release Engineering ==
  
How to - Related to release plan contribution [[Papyrus Developer Guide/Contributing To Release Plan]]
+
=== Release Plans  ===
  
=== Papyrus Discovery  ===
+
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]
  
==== Papyrus additional components  ====
+
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]
  
To add extra features to the Papyrus Discover, you should edit the files located here: ssh://USER_ID@git.eclipse.org/gitroot/www.eclipse.org/papyrus.git
+
=== Contributing to the plan for the release ===
  
==== Papyrus as a Modeling component  ====
+
* [[Papyrus Developer Guide/Contributing To Release Plan | Contribute to the Release Plan]]
 +
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
  
Papyrus is available from the Modeling Package, using the discovery UI of this package. This contribution is made by the project located here:&nbsp;git://git.eclipse.org/gitroot/www.eclipse.org/modeling/amalgam.git,
+
=== Release Process ===
  
the file is located in the folders discovery/downloads/RELEASE_NAME
+
*[[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]].
  
== Papyrus Table Developer Documentation  ==
+
=== API Evolution ===
* The documentation for developers is available here [[Table Developer Documentation]]
+
  
== Papyrus Diagram Developer Documentation  ==
+
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]  
* The documentation for developpers is available here [[Diagram Developer Documentation]]
+
  
== Papyrus Embedded Editors Documentation  ==
+
=== Hudson Instance ===
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
+
  
== Papyrus Extraplugins Documentation ==
+
*Papyrus Hipp standard guide: [[Papyrus Developer Guide/How to use the Hipp and its functionalities]].
The following describe developer guide for papyrus extraplugins:
+
  
*[[Java Code Generation Developer Guide]]
 
*[[Java Code Reverse Developer Guide]]
 
 
== Papyrus Release Process  ==
 
 
*Papyrus release process: How to Use [[Papyrus Developer Guide/Release Process: How To]].
 
 
*Papyrus release process: Documentation [[Papyrus Developer Guide/Release Process: Doc]].
 
 
*Papyrus Release Standard Operating Procedure:  [[Papyrus Developer Guide/Release Standard Operating Procedure: Doc]].
 
 
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]
 
 
 
== Papyrus HIPP ==
 
 
*Papyrus Hipp standard guide: [[How to use the Hipp and its functionalities]].
 
 
== New plugin Submition Process  ==
 
 
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
 
  
 
[[Category:Papyrus]]
 
[[Category:Papyrus]]

Revision as of 09:17, 21 November 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 the following link for a step by step installation guide: Oomph setup 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


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