diff options
author | ptessier | 2014-06-11 09:54:42 +0000 |
---|---|---|
committer | ptessier | 2014-06-11 09:54:42 +0000 |
commit | 7445cb3b007cb4788233bae9278a3ee5cb88bbec (patch) | |
tree | e087d3aee6eb24728b7c7a9ddf351484a054e00d | |
parent | d304f49850e1f8e45980c0103d876149f5d2c9ce (diff) | |
download | org.eclipse.papyrus-7445cb3b007cb4788233bae9278a3ee5cb88bbec.tar.gz org.eclipse.papyrus-7445cb3b007cb4788233bae9278a3ee5cb88bbec.tar.xz org.eclipse.papyrus-7445cb3b007cb4788233bae9278a3ee5cb88bbec.zip |
399858: [Documentation] Papyrus shall have an embedded documentation
https://bugs.eclipse.org/bugs/show_bug.cgi?id=399858
# WARNING: head commit changed in the meantime
Merge branch 'master' of
ssh://ptessier@git.eclipse.org:29418/papyrus/org.eclipse.papyrus
Change-Id: Idc754b074515e40c3003fbf1eef769d06d8d1aa5
26 files changed, 252 insertions, 0 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.classpath b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.classpath new file mode 100644 index 00000000000..e9bcd511f17 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.classpath @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+ <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.project b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.project new file mode 100644 index 00000000000..66fd5057324 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.infra.newchild.doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ </natures>
+</projectDescription>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 00000000000..98553c18ede --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,3 @@ +eclipse.preferences.version=1
+encoding//resource/newChild-toc.xml=utf-8
+encoding//resource/newChild.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.jdt.core.prefs b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 00000000000..980b98c1d5f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,12 @@ +eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.7
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
+org.eclipse.jdt.core.compiler.compliance=1.7
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.7
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..d046b91ada3 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/META-INF/MANIFEST.MF @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: new child Documentation +Bundle-SymbolicName: org.eclipse.papyrus.infra.newchild.doc;singleton:=true +Bundle-Version: 1.0.0.qualifier +Require-Bundle: org.eclipse.help;bundle-version="3.6.0", + org.eclipse.papyrus.infra.doc;bundle-version="1.0.0" +Bundle-Vendor: Eclipse Modeling Project diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/about.html b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/about.html new file mode 100644 index 00000000000..209103075a7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+<h2>About This Content</h2>
+
+<p>November 14, 2008</p>
+<h3>License</h3>
+
+<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise
+indicated below, the Content is provided to you under the terms and conditions of the
+Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available
+at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
+For purposes of the EPL, "Program" will mean the Content.</p>
+
+<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is
+being redistributed by another party ("Redistributor") and different terms and conditions may
+apply to your use of any object code in the Content. Check the Redistributor's license that was
+provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise
+indicated below, the terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.eclipse.org">http://www.eclipse.org</a>.</p>
+
+</body>
+</html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties new file mode 100644 index 00000000000..6e97839fcbd --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties @@ -0,0 +1,7 @@ +bin.includes = META-INF/,\
+ about.html,\
+ plugin.xml,\
+ resource/,\
+ pom.xml
+src.includes = about.html
+
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml new file mode 100644 index 00000000000..1d9a4f45f85 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="resource/newChild-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/newChild-toc.xml"
+ primary="false">
+ </toc>
+ </extension>
+
+</plugin>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml new file mode 100644 index 00000000000..1d549b17e16 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.0.0-SNAPSHOT</version> + <relativePath>../../../releng/top-pom-main.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.infra.newchild.doc</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.0.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> +</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivities.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivities.png Binary files differnew file mode 100644 index 00000000000..93a409795ee --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivities.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivitiesIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivitiesIllustration.png Binary files differnew file mode 100644 index 00000000000..2ead41a7865 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivitiesIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/Architecture.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/Architecture.png Binary files differnew file mode 100644 index 00000000000..9b86fcb30c2 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/Architecture.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/EnableCreationMenu.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/EnableCreationMenu.png Binary files differnew file mode 100644 index 00000000000..2ee0b82d010 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/EnableCreationMenu.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/MenuExample.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/MenuExample.png Binary files differnew file mode 100644 index 00000000000..e0996bc1801 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/MenuExample.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifier.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifier.png Binary files differnew file mode 100644 index 00000000000..26d8b568537 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifier.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifierIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifierIllustration.png Binary files differnew file mode 100644 index 00000000000..40046cf4bf3 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifierIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NewDiagram.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NewDiagram.png Binary files differnew file mode 100644 index 00000000000..9f50a45041d --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NewDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconO.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconO.png Binary files differnew file mode 100644 index 00000000000..63772d65186 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconO.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconOIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconOIllustration.png Binary files differnew file mode 100644 index 00000000000..f88d08f681e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconOIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/UseCaseDiagram.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/UseCaseDiagram.png Binary files differnew file mode 100644 index 00000000000..7d475969113 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/UseCaseDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/codeXML.PNG b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/codeXML.PNG Binary files differnew file mode 100644 index 00000000000..94721d526ab --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/codeXML.PNG diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/documentation.css b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/documentation.css new file mode 100644 index 00000000000..4bd322155ad --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/documentation.css @@ -0,0 +1,11 @@ +table {
+ border-collapse: collapse;
+}
+
+table, th, td, tr {
+ border: 1px solid black;
+ padding-left: 5px;
+ padding-right: 5px;
+ padding-top: 3px;
+ padding-bottom: 3px;
+}
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml new file mode 100644 index 00000000000..b2354f3915e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="CSS Stylesheets" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic href="resource/newChild.html" label="Menu new child"> + <anchor id="new Child"/> + <link toc="resource/newChild-toc.xml"/> + </topic> +</toc> 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 new file mode 100644 index 00000000000..eda7d4d26cf --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml @@ -0,0 +1,19 @@ +<?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> + </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 new file mode 100644 index 00000000000..8e019fcaf5d --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html @@ -0,0 +1,25 @@ +<?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 +</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>- 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. +<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 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. +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></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 new file mode 100644 index 00000000000..6753d20691e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki @@ -0,0 +1,69 @@ + +__TOC__ += New Child Menu into the model explorer = +==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== +[[Image:UseCaseDiagram.png|UseCaseDiagram]]<br> +===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. +[[Image:EnableCreationMenu.png|EnableCreationMenu]]<br> +===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: +*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> +***It correspond to a menu<br> +***The ElemenTypeIDRef correspond a reference to the element Type.<br> +***The role can be filled in order to specify the role play by the element.<br> +***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> +**Folder<br> +***It is possible to add owns label an icon.<br> +**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> +<extension + point="org.eclipse.papyrus.infra.newchild"> + <menuCreationModel + model="YourCreationMenu.xmi"> + </menuCreationModel> +</extension> +</code> + +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> +<br>[[Image:PackageWithIconOIllustration.png|Result for this menu]]<br> + +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>[[Image:NestedClassifierIllustration.png|Result for the menu nestedClass]]<br> +<br>[[Image:NestedClassifier.png|Creation menu model for nested class]]<br> + +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=== +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. |