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.
Difference between revisions of "Papyrus/Papyrus User Guide"
m (Add Papyrus category) |
|||
Line 2: | Line 2: | ||
== Installation == | == Installation == | ||
==== Install Method under Eclipse 3.4 ==== | ==== Install Method under Eclipse 3.4 ==== | ||
− | --> | + | --> |
− | = Using UML modeling editors | + | = Using UML modeling editors = |
− | + | ||
− | == | + | == UML modeling == |
− | + | ||
− | + | === Getting Started === | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ==== Papyrus Perspective ==== | |
− | + | The Papyrus perspective contains : | |
− | + | *Model Explorer view | |
+ | *Outline view | ||
+ | *Multi diagram editor view | ||
+ | *Properties view | ||
+ | *Toolbar | ||
− | [[Image: | + | [[Image:Papyrus Perspective.png|600px]] |
− | + | ===== Model Explorer View ===== | |
− | + | The model explorer is used to navigate to the all model's elements and the diagrams. | |
− | + | [[Image:Papyrus ModelExplorer.png]] | |
− | + | This action link the model explorer with the active diagram selection. This action works bidirectionally. | |
− | + | [[Image:Papyrus ME Sync.png|400px]] | |
− | + | This action allow to add new semantic element. | |
− | + | [[Image:Papyrus ME NewChild.png|400px]] | |
− | + | This action allow to add new diagram in current selection. | |
− | + | [[Image:Papyrus ME NewDiagram.png|400px]] | |
− | + | All actions availables on diagram item. | |
− | + | [[Image:Papyrus ME DiagramMenu.png]] | |
− | + | The model explorer used Common Navigator Framework and provide facilities to customize view. | |
− | + | [[Image:Papyrus ME CustomizeView.png]] | |
− | + | To customize the content of treeViewer: | |
− | + | [[Image:Papyrus ME CustomizeView Content.png|400px]] | |
− | + | To filter the content of treeViewer: | |
− | [[Image: | + | [[Image:Papyrus ME CustomizeView Filters.png|400px]] |
− | <!-- | + | ===== Outline View ===== |
+ | |||
+ | The Outline offers a thumbnail of the graphical representation and the list of semantic elements used in current diagram. | ||
+ | |||
+ | [[Image:Papyrus OutLine.png]][[Image:Papyrus OutLine All.png]][[Image:Papyrus OutLine Tree.png]] <!-- | ||
===== Multi Editor View ===== | ===== Multi Editor View ===== | ||
===== Properties View ===== | ===== Properties View ===== | ||
− | --> | + | --> |
− | === Tutorials on UML modeling with Papyrus | + | === Tutorials on UML modeling with Papyrus === |
− | + | ||
+ | ==== Model/Diagram creation wizard ==== | ||
− | ===== Create a new Model. ===== | + | ===== Create a new Model. ===== |
− | [[Image: | + | [[Image:Papyrus CreateNewModel.png|400px]] |
+ | <br> Choose the model file name and the first diagram to create. | ||
− | + | [[Image:Papyrus CreateNewModel-2.png|400px]] [[Image:Papyrus CreateNewModel-3.png|400px]] | |
− | + | ===== Create a diagram from an existing uml file ===== | |
− | + | From your uml file, select the "Initialize Papyrus diagram" to access the creation wizard of Papyrus. Your Papyrus diagram will be linked with your existing model. | |
− | + | [[Image:CreateDiagramFromModel.PNG]] <!-- | |
− | + | ||
− | + | ||
− | [[Image:CreateDiagramFromModel.PNG]] | + | |
− | <!-- | + | |
== UML Diagrams == | == UML Diagrams == | ||
=== Class Diagram === | === Class Diagram === | ||
Line 89: | Line 87: | ||
=== Activity Diagram === | === Activity Diagram === | ||
=== Use Case Diagram === | === Use Case Diagram === | ||
− | --> | + | --> |
+ | <br> | ||
− | ===== Apply a static profile ===== | + | ===== Apply a static profile ===== |
− | *1 - Select a package element (ie a Model or a Package). | + | *1 - Select a package element (ie a Model or a Package). |
− | *2 - Select the tab "Profile" on the "Properties" view | + | *2 - Select the tab "Profile" on the "Properties" view |
− | *3 - Click on the plug-in icon | + | *3 - Click on the plug-in icon |
− | *4 - Select your static profile | + | *4 - Select your static profile |
*5 - Choose profiles to apply | *5 - Choose profiles to apply | ||
− | [[Image:PapyrusApplyStaticProfil.PNG]] | + | [[Image:PapyrusApplyStaticProfil.PNG]] |
− | ===== Load an additionnal resource ===== | + | ===== Load an additionnal resource ===== |
− | ====== Show additional resources in your model explorer view ====== | + | ====== Show additional resources in your model explorer view ====== |
− | + | ||
− | + | ||
− | + | Ensure that the filter for the additional resources is not checked on your model explorer view : [[Image:PapyrusFilterAdditionalResources.PNG]] | |
− | + | ||
− | + | ====== Add an additional resource ====== | |
+ | Right click on an element of your model and select the menu "Load resource..." | ||
+ | |||
+ | [[Image:PapyrusLoadResources.PNG]] | ||
+ | |||
+ | <br> | ||
=== Papyrus Zoo of UML Models === | === Papyrus Zoo of UML Models === | ||
Line 120: | Line 121: | ||
[[Image:CompositeSupport.PNG]] | [[Image:CompositeSupport.PNG]] | ||
− | The project is available here [http://wiki.eclipse.org/images/1/10/CompositeSupport.zip] | + | The project is available here [http://wiki.eclipse.org/images/1/10/CompositeSupport.zip] |
+ | |||
+ | == SysML Modeling == | ||
+ | |||
+ | === Tutorials on SysML modeling with Papyrus === | ||
+ | |||
+ | === Papyrus Zoo of SysML Models === | ||
+ | |||
+ | == MARTE Modeling == | ||
+ | |||
+ | === Tutorials on MARTE modeling with Papyrus === | ||
+ | |||
+ | === Papyrus Zoo of MARTE Models === | ||
+ | |||
+ | = Developing custom DSL based editor with Papyrus = | ||
+ | |||
+ | == UML Profile Modeling == | ||
+ | |||
+ | == MetaModel Modeling == | ||
+ | |||
+ | == Additional Editor Integration (this section is for the Backone) == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Diagram Editors Customizations == | == Diagram Editors Customizations == | ||
Line 148: | Line 159: | ||
=== Diagram Appearance Customization with CSS Stylesheets === | === Diagram Appearance Customization with CSS Stylesheets === | ||
− | [http://wiki.eclipse.org/MDT/Papyrus/UserGuide/CSS CSS Stylesheets in Papyrus] | + | [http://wiki.eclipse.org/MDT/Papyrus/UserGuide/CSS CSS Stylesheets in Papyrus] |
+ | |||
+ | = Additional Utilities of Papyrus = | ||
+ | |||
+ | == Collaborative Work Support == | ||
+ | |||
+ | == Layer Support == | ||
+ | |||
+ | == Automatic Layout Support == | ||
+ | |||
+ | == Code Generation Support == | ||
+ | |||
+ | === JAVA Code Generation === | ||
+ | |||
+ | === C/C++ Code Generation === | ||
+ | |||
+ | === ADA Code Generation === | ||
+ | |||
+ | == Documentation Support == | ||
+ | |||
+ | === Documentation Modelling === | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=== Documentation Generation === | === Documentation Generation === | ||
+ | |||
+ | [[Category:Papyrus]] |
Revision as of 13:39, 26 February 2013
Contents
- 1 Using UML modeling editors
- 2 Developing custom DSL based editor with Papyrus
- 3 Additional Utilities of Papyrus
Using UML modeling editors
UML modeling
Getting Started
Papyrus Perspective
The Papyrus perspective contains :
- Model Explorer view
- Outline view
- Multi diagram editor view
- Properties view
- Toolbar
Model Explorer View
The model explorer is used to navigate to the all model's elements and the diagrams.
This action link the model explorer with the active diagram selection. This action works bidirectionally.
This action allow to add new semantic element.
This action allow to add new diagram in current selection.
All actions availables on diagram item.
The model explorer used Common Navigator Framework and provide facilities to customize view.
To customize the content of treeViewer:
To filter the content of treeViewer:
Outline View
The Outline offers a thumbnail of the graphical representation and the list of semantic elements used in current diagram.
Tutorials on UML modeling with Papyrus
Model/Diagram creation wizard
Create a new Model.
Choose the model file name and the first diagram to create.
Create a diagram from an existing uml file
From your uml file, select the "Initialize Papyrus diagram" to access the creation wizard of Papyrus. Your Papyrus diagram will be linked with your existing model.
Apply a static profile
- 1 - Select a package element (ie a Model or a Package).
- 2 - Select the tab "Profile" on the "Properties" view
- 3 - Click on the plug-in icon
- 4 - Select your static profile
- 5 - Choose profiles to apply
Load an additionnal resource
Show additional resources in your model explorer view
Ensure that the filter for the additional resources is not checked on your model explorer view :
Add an additional resource
Right click on an element of your model and select the menu "Load resource..."
Papyrus Zoo of UML Models
Composite Structure Diagram
The project is available here [1]
SysML Modeling
Tutorials on SysML modeling with Papyrus
Papyrus Zoo of SysML Models
MARTE Modeling
Tutorials on MARTE modeling with Papyrus
Papyrus Zoo of MARTE Models
Developing custom DSL based editor with Papyrus
UML Profile Modeling
MetaModel Modeling
Additional Editor Integration (this section is for the Backone)
Diagram Editors Customizations
Specific Diagram Editors Creation
Diagram Editor Palette Customization
Here you can find the documentation describing palette customization: Doc
This document can also be found in Papyrus help section => User Guide => Palette customization