From b94f944d7e9bb31c41e30b891b6a65da7657ffdb Mon Sep 17 00:00:00 2001 From: Patrick Tessier Date: Wed, 11 Jun 2014 14:38:33 +0200 Subject: 399858: [Documentation] Papyrus shall have an embedded documentation https://bugs.eclipse.org/bugs/show_bug.cgi?id=399858 - Fix typo--- .../resource/newChild.html | 16 +++------ .../resource/newChild.mediawiki | 40 +++++++++------------- 2 files changed, 22 insertions(+), 34 deletions(-) diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html index a582d060c08..41bb3e024b1 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html @@ -1,24 +1,18 @@ -
  1. Requirements
  2. Use Cases
    1. UseCreateMenu
      1. How to
    2. Create or modify ElementCreationModel
      1. How to
    3. Generate "ElementCreationModel" from a profile
    4. Hide, change order or add submenus
      1. How to
    5. Create or modify ElementCreationModel at runtime thanks to a GUI

Requirements

- AddNewChild (id=newChild001):

Papyrus shall add in the menu new child for new customized elements by using extended type
-

- HideElement (id=newChild002):

Papyrus shall not display all UML or SysML element creation
-

- newChildFromProfile (id=newChild003):

Papyrus shall add the creation of new element from a subset of profile
-

- newChildMenuDisplay (id=newChild004):

Papyrus shall be able to associated icons to folder or creation menu
-

- RoleAndElementCreation (id=newChild005):

When an element can created from several  roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all role.
-

Use Cases

UseCaseDiagram

UseCreateMenu

The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. It can decide to display or not this element creation

How to

A user can create an element by select element in the model explorer, click on it ant then click on the diagram. -In order to not display a menu, a user can edit the model that represent the creation menu and set the attribute visibility to false. -EnableCreationMenu

Create or modify ElementCreationModel

An advanced User is able to create of modify creation menu. This menu is a model that can be edited

How to

An advanced user can contribuate to the menu by adding a new plugin that contains:

<extension
+
  1. Requirements
  2. Use Cases
    1. UseCreateMenu
      1. How to
    2. Create or modify ElementCreationModel
      1. How to
    3. Generate "ElementCreationModel" from a profile
    4. Hide, change order or add submenus
      1. How to
    5. Create or modify ElementCreationModel at runtime thanks to a GUI

Requirements

AddNewChild (id=newChild001):
Papyrus shall add in the menu new child for new customized elements by using extended type
HideElement (id=newChild002):
Papyrus shall not display all UML or SysML element creation
newChildFromProfile (id=newChild003):
Papyrus shall add the creation of new element from a subset of profile
newChildMenuDisplay (id=newChild004):
Papyrus shall be able to associate icons to folder or creation menu
RoleAndElementCreation (id=newChild005):
When an element can be created from several roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all roles.

Use Cases

UseCaseDiagram

UseCreateMenu

The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. He can decide to display or not this element creation.

How to

In order to not display a menu, a user can edit the model that represents the creation menu and set the attribute visibility to false. +EnableCreationMenu

Create or modify ElementCreationModel

An advanced User is able to create or modify creation menu. This menu is a model that can be edited

How to

An advanced user can contribute to the menu by adding a new plugin that contains:

<extension
          point="org.eclipse.papyrus.infra.newchild">
       <menuCreationModel
             model="YourCreationMenu.xmi">
       </menuCreationModel>
 </extension>
 
-

In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated a image for this menu. +

In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated an image for this menu.
Creation menu for a package with a specific icon
-
Result for this menu

In this following example, a creation menu will be specify to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass" +
Result for this menu

In this following example, a creation menu will be specified to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass"
Result for the menu nestedClass

Creation menu model for nested class

In the following example a creation menu is created for activities. In this case, all roles are displayed. Thanks to this, when we want to associate an activity to a state, 3 roles are proposed.
Creation menu model for activity

Result for this menu activity

Generate "ElementCreationModel" from a profile

From a stereotyped profile, a model of new child menu can be generated. For example a user after designing a profile, want to have a dedicated menu from this profile/ -For the moment this function is not implemented.

Hide, change order or add submenus

The User can modify the creation menu by adding submenus: order about new child menu, precise if the role must be displayed.

How to

It only needed to change the order of element in the corresponding creation menu model

Create or modify ElementCreationModel at runtime thanks to a GUI

A user can edit a the model that represent the creation menu at runtime for papyrus thanks to a dedicated UI. +For the moment this function is not implemented.

Hide, change order or add submenus

The User can modify the creation menu by adding submenus: order about new child menu, precise if the role must be displayed.

How to

It only needed to change the order of element in the corresponding creation menu model

Create or modify ElementCreationModel at runtime thanks to a GUI

A user can edit a the model that represents the creation menu at runtime for papyrus thanks to a dedicated UI. For the moment this function is not implemented.

\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki index 3007a141fc3..916f8d09911 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki @@ -1,38 +1,32 @@ __TOC__ =Requirements= -- AddNewChild (id=newChild001): - Papyrus shall add in the menu new child for new customized elements by using extended type -- HideElement (id=newChild002): - Papyrus shall not display all UML or SysML element creation -- newChildFromProfile (id=newChild003): - Papyrus shall add the creation of new element from a subset of profile -- newChildMenuDisplay (id=newChild004): - Papyrus shall be able to associated icons to folder or creation menu -- RoleAndElementCreation (id=newChild005): - When an element can created from several roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all role. +; AddNewChild (id=newChild001): : Papyrus shall add in the menu new child for new customized elements by using extended type +; HideElement (id=newChild002): : Papyrus shall not display all UML or SysML element creation +; newChildFromProfile (id=newChild003): : Papyrus shall add the creation of new element from a subset of profile +; newChildMenuDisplay (id=newChild004): : Papyrus shall be able to associate icons to folder or creation menu +; RoleAndElementCreation (id=newChild005): : When an element can be created from several roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all roles. =Use Cases= [[Image:UseCaseDiagram.png|UseCaseDiagram]]
==UseCreateMenu== -The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. It can decide to display or not this element creation +The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. He can decide to display or not this element creation. ===How to=== -A user can create an element by select element in the model explorer, click on it ant then click on the diagram. -In order to not display a menu, a user can edit the model that represent the creation menu and set the attribute visibility to false. +In order to not display a menu, a user can edit the model that represents the creation menu and set the attribute visibility to false. [[Image:EnableCreationMenu.png|EnableCreationMenu]]
==Create or modify ElementCreationModel== -An advanced User is able to create of modify creation menu. This menu is a model that can be edited +An advanced User is able to create or modify creation menu. This menu is a model that can be edited ===How to=== -An advanced user can contribuate to the menu by adding a new plugin that contains: -*a xmi file that represents a creation menu. The model must be a instance of org.eclipse.papyrus.infra.newchild/resource/elementCreationMenuModel.ecore. It contains
+An advanced user can contribute to the menu by adding a new plugin that contains: +*a xmi file that represents a creation menu. The model must be an instance of org.eclipse.papyrus.infra.newchild/resource/elementCreationMenuModel.ecore. It contains
**CreationMenu
-***It correspond to a menu
-***The ElemenTypeIDRef correspond a reference to the element Type.
+***It corresponds to a menu
+***The ElemenTypeIDRef corresponds a reference to the element Type.
***The role can be filled in order to specify the role play by the element.
***If displayAllRole is set to true, it displays all roles played by the element if the number of roles is greater than 1. By default this property is true;
**Folder
***It is possible to add owns label an icon.
-**Visibilty to specify if the folder is visible.
-*a reference to an extension point, to specify that papyrus must take in account this file display the menu
+**Visibility to specify if the folder is visible.
+*a reference to an extension point, to specify that papyrus must take in account this file to display the menu
-In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated a image for this menu. +In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated an image for this menu.
[[Image:PackageWithIconO.png|Creation menu for a package with a specific icon]]

[[Image:PackageWithIconOIllustration.png|Result for this menu]]
-In this following example, a creation menu will be specify to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass" +In this following example, a creation menu will be specified to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass"
[[Image:NestedClassifierIllustration.png|Result for the menu nestedClass]]

[[Image:NestedClassifier.png|Creation menu model for nested class]]
@@ -64,5 +58,5 @@ The User can modify the creation menu by adding submenus: order about new child It only needed to change the order of element in the corresponding creation menu model ==Create or modify ElementCreationModel at runtime thanks to a GUI== -A user can edit a the model that represent the creation menu at runtime for papyrus thanks to a dedicated UI. +A user can edit a the model that represents the creation menu at runtime for papyrus thanks to a dedicated UI. For the moment this function is not implemented. -- cgit v1.2.3