Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

(Retrieve code: update the documentation for the psf)
(Retrieve code: update the path for the psf + add psf for branch 0.9.X)
Line 35: Line 35:
 
The following psf files are automatically update several time by day.
 
The following psf files are automatically update several time by day.
  
*last versions of the psf files for Papyrus/trunk using http for non-commiters:
+
*'''Trunk'''
**[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/build_http.psf build_http.psf] release engineering projects
+
**last versions of the psf files for Papyrus/trunk using http for non-commiters:
**[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/extraplugins_http.psf extraplugins_http.psf] all papyrus extraplugins
+
***[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/trunk/full_papyrus_http.psf full_papyrus_http.psf] all papyrus plugins available on the SVN
+
***[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/trunk/plugins_http.psf plugins_http.psf] all papyrus plugins
+
***[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/trunk/tests_http.psf tests_http.psf] Junit and other test plugins (mandatory for developers)
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_http.psf plugins_http.psf] all papyrus plugins
*last versions of the psf files for Papyrus/trunk using svn+ssh for commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_http.psf tests_http.psf] Junit and other test plugins (mandatory for developers)
**[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/build_svn_ssh.psf build_svn_ssh.psf] release engineering projects
+
**last versions of the psf files for Papyrus/trunk using svn+ssh for commiters:
**[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/extraplugins_svn_ssh.psf extraplugins_svn_ssh.psf] all papyrus extraplugins
+
***[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/trunk/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/extraplugins_svn_ssh.psf extraplugins_svn_ssh.psf] all papyrus extraplugins
**[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/plugins_svn_ssh.psf plugins_svn_ssh.psf] all papyrus plugins
+
***[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/trunk/tests_svn_ssh.psf tests_svn_ssh.psf] Junit and other test plugins (mandatory for developers)
+
***[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'''
 +
**last versions of the psf files for Papyrus/trunk 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/trunk 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.===
 
===How to update the script generating the psf files.===

Revision as of 03:48, 31 August 2012

Development Environment

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

Common Environment

Following is a description of the basic configuration:

  • The latest Eclipse Modeling release.
  • [1] SVN Subversive (or Subclipse)
  • [2] CheckStyle
  • [3] JAutoDoc

Required External Plugins

Papyrus requires some external plugins in order to compile.
The following page maintain a list of Papyrus Required External Plugins

Development Plan

Specifications

The specifications are available here : http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications

Getting the code

Connecting to the svn

The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/

Retrieve code

PSF Following files will allow you to import all Papyrus plugins used during build phase: 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.

How to update the script generating the psf files.

The script is located on build.eclipse.org in /opt/public/modeling/mdt/papyrus/create_psf_files.sh.

  • To modify it :


How to update the psf files provided in /trunk/readme.

Coming soon

Retrieve configuration files

The Papyrus Code Templates and Java Formatter files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"
FAQ How do I control the Java formatter
FAQ How can templates make me the fastest coder ever
Checkstyle : available soon

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

Papyrus Architecture

Papyrus Generation

Papyrus Code Standards

  • Java Doc - every class, method and field including private ones should be documented with Java Doc
  • 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 : 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 :-)

Papyrus Coding guidelines

A few points may be a little tricky when coding for Papyrus. Among them :

Papyrus Plugin Naming Scheme and Folders Structure

Structure and behavior of papyrus

Papyrus Command Execution, History, Undo/Redo


How To ...

Commit, Report Bugs, patchs (Code Contributing)

Papyrus Code Examples

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

Papyrus Build Process


New plugin Submition Process

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

Back to the top