diff options
Diffstat (limited to 'plugins/doc')
3 files changed, 41 insertions, 45 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml index eda7d4d26cf..09bc9744e31 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml @@ -1,19 +1,17 @@ <?xml version='1.0' encoding='utf-8' ?> <toc topic="resource/newChild.html" label="newChild"> - <topic href="resource/newChild.html" label="New Child Menu into the model explorer"> - <topic href="resource/newChild.html#Requirements" label="Requirements"></topic> - <topic href="resource/newChild.html#Use_Cases" label="Use Cases"> - <topic href="resource/newChild.html#UseCreateMenu" label="UseCreateMenu"> - <topic href="resource/newChild.html#How_to" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel" label="Create or modify ElementCreationModel"> - <topic href="resource/newChild.html#How_to_2" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Generate_.22ElementCreationModel.22_from_a_profile" label="Generate "ElementCreationModel" from a profile"></topic> - <topic href="resource/newChild.html#Hide.2C_change_order_or_add_submenus" label="Hide, change order or add submenus"> - <topic href="resource/newChild.html#How_to_3" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI" label="Create or modify ElementCreationModel at runtime thanks to a GUI"></topic> + <topic href="resource/newChild.html" label="Requirements"></topic> + <topic href="resource/newChild.html#Use_Cases" label="Use Cases"> + <topic href="resource/newChild.html#UseCreateMenu" label="UseCreateMenu"> + <topic href="resource/newChild.html#How_to" label="How to"></topic> </topic> + <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel" label="Create or modify ElementCreationModel"> + <topic href="resource/newChild.html#How_to_2" label="How to"></topic> + </topic> + <topic href="resource/newChild.html#Generate_.22ElementCreationModel.22_from_a_profile" label="Generate "ElementCreationModel" from a profile"></topic> + <topic href="resource/newChild.html#Hide.2C_change_order_or_add_submenus" label="Hide, change order or add submenus"> + <topic href="resource/newChild.html#How_to_3" label="How to"></topic> + </topic> + <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI" label="Create or modify ElementCreationModel at runtime thanks to a GUI"></topic> </topic> </toc>
\ No newline at end of file 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 8e019fcaf5d..a582d060c08 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,25 +1,24 @@ -<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><ol style="list-style: none;"><li><a href="#New_Child_Menu_into_the_model_explorer">New Child Menu into the model explorer</a><ol style="list-style: none;"><li><a href="#Requirements">Requirements</a></li><li><a href="#Use_Cases">Use Cases</a><ol style="list-style: none;"><li><a href="#UseCreateMenu">UseCreateMenu</a><ol style="list-style: none;"><li><a href="#How_to">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</a><ol style="list-style: none;"><li><a href="#How_to_2">How to</a></li></ol></li><li><a href="#Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</a></li><li><a href="#Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</a><ol style="list-style: none;"><li><a href="#How_to_3">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</a></li></ol></li></ol></li></ol><h1 id="New_Child_Menu_into_the_model_explorer">New Child Menu into the model explorer</h1><h2 id="Requirements">Requirements</h2><p>- AddNewChild (id=newChild001): </p><pre>Papyrus shall add in the menu new child for new customized elements by using extended type +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><ol style="list-style: none;"><li><a href="#Requirements">Requirements</a></li><li><a href="#Use_Cases">Use Cases</a><ol style="list-style: none;"><li><a href="#UseCreateMenu">UseCreateMenu</a><ol style="list-style: none;"><li><a href="#How_to">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</a><ol style="list-style: none;"><li><a href="#How_to_2">How to</a></li></ol></li><li><a href="#Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</a></li><li><a href="#Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</a><ol style="list-style: none;"><li><a href="#How_to_3">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</a></li></ol></li></ol><h1 id="Requirements">Requirements</h1><p>- AddNewChild (id=newChild001): </p><pre>Papyrus shall add in the menu new child for new customized elements by using extended type </pre><p>- HideElement (id=newChild002): </p><pre>Papyrus shall not display all UML or SysML element creation -</pre><p>- newChildFromProfile (id=newChild003): </p><pre>Papyrus shall add the creation of new elements from a subset of profile +</pre><p>- newChildFromProfile (id=newChild003): </p><pre>Papyrus shall add the creation of new element from a subset of profile </pre><p>- newChildMenuDisplay (id=newChild004): </p><pre>Papyrus shall be able to associated icons to folder or creation menu -</pre><p>- RoleAndElementCreation (id=newChild005): </p><pre>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. -</pre><h2 id="Use_Cases">Use Cases</h2><p><img title="UseCaseDiagram" alt="UseCaseDiagram" border="0" src="UseCaseDiagram.png"/><br/></p><h3 id="UseCreateMenu">UseCreateMenu</h3><p>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</p><h4 id="How_to">How to</h4><p>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 represents the creation menu and set the attribute visibility to false. -<img title="EnableCreationMenu" alt="EnableCreationMenu" border="0" src="EnableCreationMenu.png"/><br/></p><h3 id="Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</h3><p>An advanced User is able to create of modify creation menu. This menu is a model that can be edited </p><h4 id="How_to_2">How to</h4><p>An advanced user can contribuate to the menu by adding a new plugin that contains:</p><ul><li>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<br/><ul><li>CreationMenu<br/><ul><li>It corresponds to a menu<br/></li><li>The ElemenTypeIDRef corresponds a reference to the element Type.<br/></li><li>The role can be filled in order to specify the role play by the element.<br/></li><li>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;<br/></li></ul></li><li>Folder<br/><ul><li>It is possible to add owns label and icon.<br/></li></ul></li><li>Visibilty to specify if the folder is visible.<br/></li></ul></li><li>a reference to an extension point, to specify that papyrus must take in account this file to display the menu<br/></li></ul><p> -<br/> -<extension</p><pre> point="org.eclipse.papyrus.infra.newchild"> - <menuCreationModel - model="YourCreationMenu.xmi"> - </menuCreationModel> -</pre><p></extension> -<br/> -</p><p>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. +</pre><p>- RoleAndElementCreation (id=newChild005): </p><pre>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. +</pre><h1 id="Use_Cases">Use Cases</h1><p><img title="UseCaseDiagram" alt="UseCaseDiagram" border="0" src="UseCaseDiagram.png"/><br/></p><h2 id="UseCreateMenu">UseCreateMenu</h2><p>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</p><h3 id="How_to">How to</h3><p>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. +<img title="EnableCreationMenu" alt="EnableCreationMenu" border="0" src="EnableCreationMenu.png"/><br/></p><h2 id="Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</h2><p>An advanced User is able to create of modify creation menu. This menu is a model that can be edited </p><h3 id="How_to_2">How to</h3><p>An advanced user can contribuate to the menu by adding a new plugin that contains:</p><ul><li>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<br/><ul><li>CreationMenu<br/><ul><li>It correspond to a menu<br/></li><li>The ElemenTypeIDRef correspond a reference to the element Type.<br/></li><li>The role can be filled in order to specify the role play by the element.<br/></li><li>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;<br/></li></ul></li><li>Folder<br/><ul><li>It is possible to add owns label an icon.<br/></li></ul></li><li>Visibilty to specify if the folder is visible.<br/></li></ul></li><li>a reference to an extension point, to specify that papyrus must take in account this file display the menu<br/></li></ul><pre class="source-xml"><extension + point="org.eclipse.papyrus.infra.newchild"> + <menuCreationModel + model="YourCreationMenu.xmi"> + </menuCreationModel> +</extension> + +</pre><p>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. <br/><img title="Creation menu for a package with a specific icon" alt="Creation menu for a package with a specific icon" border="0" src="PackageWithIconO.png"/><br/> -<br/><img title="Result for this menu" alt="Result for this menu" border="0" src="PackageWithIconOIllustration.png"/><br/></p><p>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" +<br/><img title="Result for this menu" alt="Result for this menu" border="0" src="PackageWithIconOIllustration.png"/><br/></p><p>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" <br/><img title="Result for the menu nestedClass" alt="Result for the menu nestedClass" border="0" src="NestedClassifierIllustration.png"/><br/> <br/><img title="Creation menu model for nested class" alt="Creation menu model for nested class" border="0" src="NestedClassifier.png"/><br/></p><p>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. <br/><img title="Creation menu model for activity" alt="Creation menu model for activity" border="0" src="AllPossibleActivities.png"/><br/> -<br/><img title="Result for this menu activity" alt="Result for this menu activity" border="0" src="AllPossibleActivitiesIllustration.png"/><br/></p><h3 id="Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</h3><p>From a stereotyped profile, a model of new child menu can be generated. +<br/><img title="Result for this menu activity" alt="Result for this menu activity" border="0" src="AllPossibleActivitiesIllustration.png"/><br/></p><h2 id="Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</h2><p>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.</p><h3 id="Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</h3><p>The User can modify the creation menu by adding submenus: order about new child menu, precise if the role must be displayed.</p><h4 id="How_to_3">How to</h4><p>It only needed to change the order of element in the corresponding creation menu model</p><h3 id="Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</h3><p>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.</p><h2 id="Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</h2><p>The User can modify the creation menu by adding submenus: order about new child menu, precise if the role must be displayed.</p><h3 id="How_to_3">How to</h3><p>It only needed to change the order of element in the corresponding creation menu model</p><h2 id="Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</h2><p>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.</p></body></html>
\ 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 6753d20691e..3007a141fc3 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,7 +1,6 @@ - __TOC__ -= New Child Menu into the model explorer = -==Requirements== + +=Requirements= - AddNewChild (id=newChild001): Papyrus shall add in the menu new child for new customized elements by using extended type - HideElement (id=newChild002): @@ -12,17 +11,17 @@ __TOC__ 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== +=Use Cases= [[Image:UseCaseDiagram.png|UseCaseDiagram]]<br> -===UseCreateMenu=== +==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==== +===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. [[Image:EnableCreationMenu.png|EnableCreationMenu]]<br> -===Create or modify ElementCreationModel=== +==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==== +===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<br> **CreationMenu<br> @@ -35,14 +34,14 @@ An advanced user can contribuate to the menu by adding a new plugin that contain **Visibilty to specify if the folder is visible.<br> *a reference to an extension point, to specify that papyrus must take in account this file display the menu<br> -<code> +<source lang="xml"> <extension point="org.eclipse.papyrus.infra.newchild"> <menuCreationModel model="YourCreationMenu.xmi"> </menuCreationModel> </extension> -</code> +</source> 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. <br>[[Image:PackageWithIconO.png|Creation menu for a package with a specific icon]]<br> @@ -55,15 +54,15 @@ In this following example, a creation menu will be specify to allow creation of 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. <br>[[Image:AllPossibleActivities.png|Creation menu model for activity]]<br> <br>[[Image:AllPossibleActivitiesIllustration.png|Result for this menu activity]]<br> -===Generate "ElementCreationModel" from a profile=== +==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=== +==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==== +===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=== +==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. |