Jump to: navigation, search

Difference between revisions of "Papyrus Developer Guide"

(Development Environment)
m
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. <br>  
  
=== Common Environment ===
+
=== Common Environment ===
Following is a description of the basic configuration:
+
  
*The latest Eclipse Modeling release.
+
Following is a description of the basic configuration:
*[http://www.eclipse.org/projects/project_summary.php?projectid=technology.subversive] SVN Subversive (or Subclipse)
+
 
*[http://eclipse-cs.sourceforge.net/downloads.html] CheckStyle
+
*The latest Eclipse Modeling release.  
 +
*[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
 
*[http://jautodoc.sourceforge.net/] JAutoDoc
  
=== Required External Plugins ===
+
=== Required External Plugins ===
Papyrus requires some external plugins in order to compile.  
+
 
<br>
+
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]]  
The following page maintain a list of  
+
[[Papyrus_Required_External_Plugins| Papyrus Required External Plugins]]
+
  
 
== Development Plan  ==
 
== Development Plan  ==
Line 31: Line 30:
 
=== Retrieve code  ===
 
=== Retrieve code  ===
  
[[PSF]] Following files will allow you to import all Papyrus plugins used during build phase:
+
[[PSF]] Following files will allow you to import all Papyrus plugins used during build phase:  
* Nightly Builds:
+
 
** for subversive plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subversive_N.psf PSF Subversive PSF]
+
*Nightly Builds:  
** for subclipse plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subclipse_N.psf PSF Subclipse PSF]
+
**for subversive plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subversive_N.psf PSF Subversive PSF]  
 +
**for subclipse plugin user: [http://www.eclipse.org/downloads/download.php?file=/modeling/mdt/papyrus/psf/subclipse_N.psf PSF Subclipse PSF]
  
 
=== Retrieve configuration files  ===
 
=== Retrieve configuration files  ===
Line 59: Line 59:
 
A few points may be a little tricky when coding for Papyrus. Among them&nbsp;:  
 
A few points may be a little tricky when coding for Papyrus. Among them&nbsp;:  
  
*The usage of editing domains and gmf/gef/emf commands. See this detailed article [[Papyrus Developer Guide/Editing Domains and Commands]]
+
<br>
 +
 
 +
=== 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://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
 +
 
 +
<br>
  
 
== Papyrus Bugzilla usage  ==
 
== Papyrus Bugzilla usage  ==
Line 79: Line 92:
 
== Papyrus Creation Type  ==
 
== Papyrus Creation Type  ==
  
*mechanism of type creation used in the model explorer and in the property view is explained&nbsp;[[Papyrus_Developer_Guide\Type_Creation|Papyrus Developer Guide/Type Creation]] <br>
+
*mechanism of type creation used in the model explorer and in the property view is explained&nbsp;[[Papyrus Developer Guide\Type Creation|Papyrus Developer Guide/Type Creation]] <br>
  
== Papyrus Command Execution, History, Undo/Redo  ==
+
<br>  
The following 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://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/architecture/commandExecution.doc
+
<br>
+
 
+
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
+
<br>
+
  
 
== New plugin Submition Process  ==
 
== New plugin Submition Process  ==
New plugin should follow the submition process describe here:
+
 
[[Papyrus_New_Plugin_Submition_Process| Papyrus New Plugin Submition Process]]
+
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submition Process]]

Revision as of 05:03, 5 April 2011

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:

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 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 Command Execution, History, Undo/Redo


Papyrus Bugzilla usage

When adding a task to the buzilla, the following grammar should be used:

  • '[' Category ']' NameOfTheTask

The category helps to filter the bugs for developers. There are already some existing categories: General, XXX Diagram, Common, Property View, etc.

Papyrus Log

Papyrus Build Process

Papyrus Creation Type


New plugin Submition Process

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