View source for Papyrus/Papyrus Developer Guide/Papyrus Plugin Naming Scheme

This page explains:<br> 

*how Papyrus plugins are named and located. 
*the structure of the trunk and branches<br>

All papyrus plugin should start with the same prefix: 

'''''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; org.eclipse.papyrus''''' <br> 

= Naming Scheme<br>  =

So you want to propose a new plugin. You need to give it a name. 

All papyrus plugins should start with the same prefix: 

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; '''org.eclipse.papyrus '''<br> 

But this is not enough. The next step is to decide where your plugin should be located:<br> 

#Read carrefully the next paragraph, and decide in which folder/subfolder your plugin will be located 
#Use the proposed prefix (ex: org.eclipse.papyrus.example. ) 
#If you want to contribute a set of plugins, give them a namespace name to identify all of them 
#Try to give a self explanatory name.

= [[Folders]] Structure<br>  =

The trunk and the branches have the same structure. Here we will only describe the trunk structure.<br> 

The trunk contains the following folders:<br> 

*'''plugins''' - contains all plugins included in the Papyrus distribution: core, main uml diagras, sysml<br> 
*'''tests''' - contains tests plugin. The internal structure is the same as plugins, but here we have tests.<br> 
*'''extraplugins''' - contains plugins that can be added to Papyrus in order to bring some extra functionalities: java reverse, autolayout, marte, ...<br> 
*'''incoming''' - this is a special folder used by Papyrus developper to propose new plugins (see [[Papyrus New Plugin Submition Process|Papyrus_New_Plugin_Submition_Process]])<br> 
*'''examples''' - contains some example of plugins, for user and developper.<br>

These folders can also contains subfolders.<br> 

== plugins  ==

This folder contains sub folders. All plugins in the sub folders form the main Papyrus distribution. 

{| cellspacing="1" cellpadding="1" border="1" style="width: 1003px; height: 148px;"
|-
| '''folder<br>''' 
| '''plugin prefixes'''<br> 
| '''description'''<br>
|-
| plugins/core<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''core.'''*'''<br>''' 
| <br>
|-
| plugins/uml<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''uml.*'''<br> 
| All plugins related to UML diagrams and UML should be located in this repository, except plugins related to a particular profile<br>
|-
| plugins/uml<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''uml.diagram.*'''<br> 
| Plugins related to common UML diagrams are located in this repository. The naming scheme include 'diagram' namespace.<br>
|-
| plugins/developer 
| bgcolor="#66ffff" | <br> 
| To be moved in extraplugins or in developer&nbsp;?<br>
|-
| plugins/others 
| bgcolor="#66ffff" | org.eclipse.papyrus.???<br> 
| Plugins that do no feet in other repositories<br>
|-
| plugins/sysml 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''sysml.*'''<br> 
| All plugins related to sysml UML profile<br>
|-
| <br> 
| bgcolor="#66ffff" | <br> 
| <br>
|}

<br> 

== tests  ==

This folders contains subfolders, each one dedicated to a kind of test: 

*junit 
*recipes 
*swbot

Each subfolder mimic the same structure as the trunk. The names of the plugins are usually the same name as the tested plugin, suffixed with the type of test. 

{| cellspacing="1" cellpadding="1" border="1" style="width: 1003px; height: 148px;"
|-
| '''folder<br>''' 
| '''plugin prefixes'''<br> 
| '''description'''<br>
|-
| tests/junit 
| bgcolor="#66ffff" | org.eclipse.papyrus'''.*.tests'''<br> 
| This folder mimic the trunk folder. It containt Plugin for junit tests. 
The plugins have the same name as the plugin they test, with the suffix '''.tests'''<br> 

|-
| tests/recipes 
| bgcolor="#66ffff" | org.eclipse.papyrus'''.*.recipetest'''<br> 
| This folder mimic the trunk folder. It containt Plugin for recipes tests. 
The plugins have the same name as the plugin they test, with the suffix '''.recipetest'''<br> 

|-
| tests/swbot 
| bgcolor="#66ffff" | org.eclipse.papyrus'''.*'''<br> 
| &nbsp;????<br>
|}

<br> 

== extraplugins  ==

This folder contains plugins that can be added to Papyrus in order to bring some extra functionalities. 

{| cellspacing="1" cellpadding="1" border="1" style="width: 1003px; height: 148px;"
|-
| '''folder<br>''' 
| '''plugin prefixes'''<br> 
| '''description'''<br>
|-
| extraplugins/autolayout 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''layouttool.*'''<br> 
| Plugins providing autolayout<br>
|-
| extraplugins/marte 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''marte.*'''<br> 
| All plugins related to marte UML profile<br>
|-
| extraplugins/compare 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''compare.*'''<br> 
| Plugins for model comparison&nbsp;?<br>
|-
| extraplugins/conversion 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''conversion .*'''<br> 
| Plugins dedicated to conversion (ex: old di2 files to new di format).<br>
|-
| extraplugins/developer 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''???.*'''<br> 
| Plugins useful for developer. For example, plugins providing internal View of some services. Also contains plugins used to develop or to generate some parts of Papyrus.<br>
|-
| extraplugins/java 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''java .*'''<br> 
| Plugins dedicated to Java language: Code reverse to UML, Eclipse Plugin reverse<br>
|-
| extraplugins/modisco 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''modisco.*'''<br> 
| Plugins related to adaptating Modisco. Ex: An adaptator to the Modisco editor.<br>
|-
| extraplugins/spem2 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''spem2.*'''<br> 
| Plugins related to spem2 profile.<br>
|-
| extraplugins/others 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''???.*'''<br> 
| Plugins that do not fit (yet) in one of the previous folders.<br>
|-
| <br> 
| bgcolor="#66ffff" | <br> 
| <br>
|}

== incoming  ==

This is a special folder used by Papyrus developper to propose new plugins (see [[Papyrus New Plugin Submition Process|Papyrus_New_Plugin_Submition_Process]]) 

== examples  ==

There is two kind of examples: 

*user examples 
*Papyrus developer or customizer examples

The folder contains subfolders for each kind of examples. 

{| cellspacing="1" cellpadding="1" border="1" style="width: 1003px; height: 148px;"
|-
| '''folder<br>''' 
| '''plugin prefixes'''<br> 
| '''description'''<br>
|-
| examples/user 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''example.user.*'''<br> 
| Plugins providing examples for Papyrus end user (ex: models)<br>
|-
| examples/dev/core 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''example.core.*'''<br> 
| Plugins related to core and providing examples for developer or customizer. <br>
|-
| examples/dev/uml 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''example.uml.*'''<br> 
| Plugins related to UML and providing examples for developer or customizer. <br>
|-
| examples/dev/others 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''example.???.*'''<br> 
| Plugins providing examples that do not fit in other folders. <br>
|}

<br> 

= Actual Sub-Folders and Proposed Refactoring<br>  =

The following table try to resume the actual existing folders, their purpose, and eventually the proposed refactoring: 

{| cellspacing="1" cellpadding="1" border="1" style="width: 999px; height: 1053px;"
|-
| '''folder<br>''' 
| bgcolor="#66ffff" | '''plugin prefixes'''<br> 
| '''description'''<br> 
| 
'''required actions '''<br> 

|-
| plugins/core<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''core.'''*'''<br>''' 
| <br> 
| <br>
|-
| plugins/uml<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''uml.*'''<br> 
| All plugins related to UML diagrams and UML should be locate in this repository, except plugins related to a particular profile<br> 
| <br>
|-
| plugins/uml/diagram<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus'''''.uml.diagram.*'''<br> 
| All plugins related to UML diagrams.<br> 
| <br>
|-
| plugins/developer 
| bgcolor="#66ffff" | <br> 
| <br> 
| Move to extraplugins&nbsp;?<br>
|-
| plugins/marte 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''marte.*'''<br> 
| All plugins related to marte UML profile<br> 
| Delete from plugins. Marte stuff is in extraplugins/marte<br>
|-
| plugins/others 
| bgcolor="#66ffff" | org.eclipse.papyrus.???<br> 
| Plugins that do no feet in other repository<br> 
| 
oep.outline --&gt; extraplugins 

oep.profile --&gt; uml 

|-
| plugins/sysml 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''sysml.*'''<br> 
| All plugins related to sysml UML profile<br> 
| <br>
|-
| plugins/profile-tool 
| bgcolor="#66ffff" | <br> 
| bgcolor="#ff3333" | &nbsp;&nbsp;???<br> 
| bgcolor="#ff3333" | clarify this repository, its purpose, and its naming scheme. Move to UML&nbsp;?
|-
| incoming<br> 
| bgcolor="#66ffff" | org.eclipse.papyrus'''.*'''<br> 
| 
New plugins that should be added to Papyrus. See [[Papyrus Developer Guide/Build Process|Build_Process]]. 

Plugins in this repository should follow the naming scheme of there targeted repository.<br> 

| <br>
|-
| extraplugins<br> 
| bgcolor="#66ffff" | org.eclipse.papyrus'''.*'''<br> 
| 
This repository contains plugins providing some extra functionalities to Papyrus. For example:<br> 

*Java reverse tool<br> 
*diagram auto layout<br> 
*...<br>

| <br>
|-
| examples<br> 
| bgcolor="#66ffff" | ''org.eclipse.papyrus''.'''examples.*'''<br> 
| 
Examples for Papyrus users. 

This <br> 

| Need to separate user examples from developers examples.<br>
|-
| examples<br> 
| bgcolor="#66ffff" | org.eclipse.papyrus.'''examples.*'''<br> 
| 
Examples for Papyrus developpers / customizers. 

This repository contains some plugins illustrating how to use some Papyrus functionalities, or how to extends Papyrus.<br> 

| <br>
|-
| 
tests/junit/plugins 

tests/junit/extraplugins<br> 

| bgcolor="#66ffff" | ''sameNameAsTestedPlugin'''''.tests'''<br> 
| 
These repositories contain the same hierarchies as in plugins. 

The test plugins should have the name of its tested plugin, suffixed with ".tests"<br> 

| <br>
|-
| 
tests/recipes/plugins 

tests/recipes/extraplugins 

| bgcolor="#66ffff" | sameNameAsTestedPlugin.recipetest<br> 
| These repositories contain the same hierarchies as in plugins. 
The recipetest plugins should have the name of its tested plugin, suffixed with ".recipetest"<br> 

| <br>
|-
| tests/swbot 
| bgcolor="#66ffff" | <br> 
| &nbsp;??? 
| please complete
|}

<br>