Bug 494015 - Missing documentation on static profiles

Change-Id: I19efafabc1301095ee5d50c11d21bdd49485e5b4
Signed-off-by: Onder GURCAN <onder.gurcan@cea.fr>

14 files changed, 97 insertions, 0 deletions

diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/generatingStaticProfiles.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/generatingStaticProfiles.mediawiki
new file mode 100644
index 00000000000..dfabeaf4174
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/generatingStaticProfiles.mediawiki
@@ -0,0 +1,96 @@
+= Generating Static Profiles =
+
+:'''Contents'''
+__TOC__
+
+This article shows how to generate static UML profiles from dynamic UML profiles.
+
+== Before Starting... ==
+
+Make sure that the following plug-ins are installed:
+* EMF - Eclipse Modeling Framework SDK
+* UML2 Extender SDK
+
+In the following, it is assumed that a (dynamic) UML profile named '''mylanguage''' has already been defined, the '''Ecore Profile'''profile has been applied on it and the '''EPackage'''streotype's '''nsUri''' property has been set to '''http://www.mycompany.com/MyLanguage/1'''.
+
+[[Image:images/beforeStarting.png|The MyLanguage UML Profile]]<br>
+
+== Generating an EMF Generator Model ==
+
+To generate the static profile, first a new EMF Generator Model should be generated. 
+
+Select '''File -> New -> Other… -> Eclipse Modeling Framework -> EMF Generator Model'''. When the '''EMF Generator Model''' dialog appears, select a parent folder and enter a file name for the generator model with an extension '''mylanguage.profile.genmodel''' and click '''Next>'''.
+
+[[Image:images/newEMFGeneratorModel.png|EMF Generator Model]]<br>
+
+When the '''Select a Model Importer''' dialog appears, select '''UML Model''' from the list and click '''Next>'''.
+
+[[Image:images/selectAModelImporter.png|Select a Model Importer]]<br>
+
+When the '''UML Import''' dialog appears, browse the '''.uml''' file of the profile, click '''OK''' in case a warning message dialog appears and then click '''Next>'''.
+
+[[Image:images/umlImport.png|UML Import]]<br>
+
+When the '''Package Selection''' dialog appears, firstly select all models from the '''Reference ''' list (down), then select the '''RootElement''' package from the '''RootPackages'''  list (above) and click '''Finish'''.
+
+[[Image:images/packageSelection.png|Package Selection]]<br>
+
+The generated '''mylanguage.profile.genmodel''' file will open and appear automatically in the editor.
+
+[[Image:images/generatedGenmodelFile.png|The Generated genmodel File]]<br>
+	
+
+== Generating the Static Profile ==
+	
+To generate the static profile, from the generated '''.genmodel''' file select the root element and go to the '''Properties''' view.
+
+From the '''Properties''' view, find the '''Model -> Model Directory''' property and modify it from '''…/src''' to '''…/src-gen''' and save the modifications.
+
+Then go back to the generated '''mylanguage.profile.genmodel''' file,	right click on the root element and select the '''Generate Model Code''' menu item.
+
+The generated files can be found in the '''…/src-gen''' folder.
+
+
+== Regenerating an existing Static Profile ==
+	
+Find and open to the generated '''mylanguage.profile.genmodel''' file, right click on the root element and select the '''Reload…''' menu item.
+
+When the '''Reload''' dialog appears, click '''Next>''', click '''Next>''' until the '''Finish''' button appers and then click '''Finish'''.
+
+Go to the '''…/src-gen''' folder and delete all previously generated files.
+
+Then go back to the generated '''mylanguage.profile.genmodel''' file,	right click on the root element and select the '''Generate Model Code''' menu item.
+
+The regenerated files can be found in the '''…/src-gen''' folder.
+
+== Registering the Generated Static Profile ==
+
+Open the '''MANIFEST.MF''' file, go to the '''Extensions''' tab, click on the autogenerated '''org.eclipse.emf.ecore.generated_package''' extension to see its element details. Note that the '''uri'''property is as defined in the '''EPackage''' stereotype ('''http://www.mycompany.com/MyLanguage/1''').
+
+[[Image:images/extensionEMFGeneratedPackage1.png|The Autogenerated generated_package Extension]]<br>
+
+Add an '''org.eclipse.emf.ecore.uri_mapping''' extension and set its '''source''' (the relative path to the profile) and '''target''' (the absolute path to the profile) properties.
+
+[[Image:images/uriMapping.png|The Ecore Uri Mapping Extension]]<br> 
+
+Then add an '''org.eclipse.uml2.uml.generated_package''' extension and set its '''uri''' (the uri of the profile as before) and '''location''' (the location to the xmi id of the profile) properties.
+
+[[Image:images/umlGeneratedPackage.png|The UML Generated Package Extension]]<br> 
+
+Lastly, add a '''org.eclipse.papyrus.uml.extensionpoints''' dependency from the '''Dependencies''' tab.
+
+[[Image:images/addUMLExtensionpointDependency.png|The UML Extension Points Dependency]]<br> 
+
+And then, go back to the '''Extensions''' tab, add an '''org.eclipse.papyrus.uml.extensionpoints.UMLProfile''' extension and set its '''name''', '''path''', '''description''' and '''provider''' properties.
+
+[[Image:images/papyrusUMLProfile.png|The Papyrus UML Profile Extension]]<br> 
+
+
+To test if the static profile registered successfully, open an '''Apply Registered Profile'''dialog and check if the '''MYLANGUAGE''' profile exists in the list.
+
+[[Image:images/applyRegisteredProfile.png|Apply Registered Profile]]<br> 
+
+<hr>
+''Tested on Papyrus 2.0 on Eclipse 4.6 RC1''<br>
+''Last updated: May 20, 2016 by Önder Gürcan <[mailto:onder.gurcan@cea.fr onder.gurcan@cea.fr]>'' 
+
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/addUMLExtensionpointDependency.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/addUMLExtensionpointDependency.png
new file mode 100644
index 00000000000..35fef85be14
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/addUMLExtensionpointDependency.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/applyRegisteredProfile.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/applyRegisteredProfile.png
new file mode 100644
index 00000000000..b1b82d64b89
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/applyRegisteredProfile.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/beforeStarting.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/beforeStarting.png
new file mode 100644
index 00000000000..008bac9cb14
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/beforeStarting.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/extensionEMFGeneratedPackage1.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/extensionEMFGeneratedPackage1.png
new file mode 100644
index 00000000000..39d21c55920
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/extensionEMFGeneratedPackage1.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/generatedGenmodelFile.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/generatedGenmodelFile.png
new file mode 100644
index 00000000000..9e03bd1cdc1
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/generatedGenmodelFile.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/newEMFGeneratorModel.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/newEMFGeneratorModel.png
new file mode 100644
index 00000000000..2476cdced1e
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/newEMFGeneratorModel.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/packageSelection.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/packageSelection.png
new file mode 100644
index 00000000000..f98af54568d
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/packageSelection.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/papyrusUMLProfile.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/papyrusUMLProfile.png
new file mode 100644
index 00000000000..b2f84ae8bb2
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/papyrusUMLProfile.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/selectAModelImporter.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/selectAModelImporter.png
new file mode 100644
index 00000000000..21c0f3a28df
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/selectAModelImporter.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlGeneratedPackage.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlGeneratedPackage.png
new file mode 100644
index 00000000000..46f48760359
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlGeneratedPackage.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlImport.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlImport.png
new file mode 100644
index 00000000000..348c74bf116
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/umlImport.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/uriMapping.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/uriMapping.png
new file mode 100644
index 00000000000..af64a983710
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/uriMapping.png
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
index a9cc04d1492..5b05571958f 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
@@ -7,6 +7,7 @@
           <link toc="target/generated-eclipse-help/users/definingProfilesAndStereotypes-toc.xml" />
            <link toc="target/generated-eclipse-help/users/usingProfilesAndStereotypes-toc.xml" />
       <link toc="target/generated-eclipse-help/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" />
+      <link toc="target/generated-eclipse-help/users/generatingStaticProfiles-toc.xml"/>
        <anchor id="profiles" />
         <link toc="target/generated-eclipse-help/users/papyrusProfileLimitations-toc.xml" />
       <anchor id="profiles-end" />