Browse Source

Downgrade ModelVerse toolbar to alpha status. Create documentation for Ecore and ModelVerse toolbars.

Bentley James Oakes 6 years ago
parent
commit
38b8a2db2c

+ 1 - 0
doc/index.rst

@@ -26,6 +26,7 @@ Contents
     Executing a Model Transformation <executing_transformation>
     Workflows <workflows>
     Creating Buttons and Plugins <creating_buttons_and_plugins>
+    Toolbar/Plugin Documentation <toolbars_and_plugins>
     Troubleshooting <troubleshooting>
 
 

+ 76 - 0
doc/toolbars_and_plugins.rst

@@ -0,0 +1,76 @@
+.. _toolbars_and_plugins:
+
+Toolbar/Plugin Documentation
+============================
+
+This section describes the operation of the add-on toolbars and plugins available within AToMPM.
+
+
+Exporter of AToMPM's Metamodels and Models to Ecore
+---------------------------------------------------
+
+This implementation allows you to export metamodels and models from AToMPM to Ecore.
+
+Copyright (c) 2017 Khady FALL
+(khady.fall@umontreal.ca)
+
+.. Installation
+.. ^^^^^^^^^^^^
+
+.. In the \\implementation folder, there are two folders: \Ecore and \Plugins.
+
+.. To install the exporting files, do the following :
+
+.. 1. Copy and paste the \Ecore folder in your AToMPM installation at \atompm\users\[your_username]\Toolbars.
+
+.. 2. Copy and paste the two files ExportMM2Ecore.js and ExportM2Ecore.js located in \Plugins in your AToMPM installation at \atompm\plugins.
+
+.. All the files have been properly installed.
+
+Utilisation
+^^^^^^^^^^^
+
+To export metamodels or models in AToMPM, follow these steps:
+
+1. Open a new session in AToMPM.
+
+2. Click on the "(re-)load a toolbar" button.
+
+3. In the \\Toolbars\\Ecore folder, choose "Export2Ecore.buttons.model" then click the "ok" button.
+
+4. Load your metamodel or model in the current canvas.
+
+5. If you want to export a metamodel, click on the "MM -> Ecore" button of the loaded toolbar (the first button). If you want to export a model, rather click on the "M -> Ecore" button (the second button).
+
+6. If you want to export a model, you will be asked to enter the name of the model, the name of the metamodel and its URI. Also, you will be asked if you want a dynamic instance or a static one. There are default values:
+
+    * The model's name will be the current model name
+    * The metamodel's name and URI will be composed as follows:
+        * "[name_of_current_model]Metamodel"
+        * "http://[name_of_current_model]"
+
+7. If you want to export a metamodel, you will be asked to enter the name of the metamodel and its URI. There are default values:
+    * The name of the current metamodel
+    * A URI composed as follows: "http://[name_of_(meta)model]".
+
+8. After entering that information, click the "ok" button.
+
+9. A file .ecore for a metamodel, or a file .xmi for a model, has been created. That file is in a folder \\exported_to_ecore located in the \\atompm folder of your AToMPM installation.
+
+10. If you want to use the exported file in Eclipse, you have to register the metamodel.
+
+
+ModelVerse Toolbar
+------------------
+
+.. warning:: The ModelVerse toolbar is currently in an alpha state. It is only intended as a prototype and should not be used for everyday use, as data loss is certain to occur.
+
+The ModelVerse toolbar is intended to allow for the user to load and save models to/from AToMPM to the Modelverse. 
+
+.. warning:: Currently, only metamodels in the SimpleClassDiagram formalism can be loaded and saved, along with instance models.
+
+The first button on the toolbar connects to a running ModelVerse instance running on the current machine.
+
+The second button loads a model from the ModelVerse into the current AToMPM canvas.
+
+The third button saves the current AToMPM model to the ModelVerse.

+ 0 - 80
plugins/export2ecore_README.md

@@ -1,80 +0,0 @@
-==========================================================================================
-
-AToMPM - A Tool for Multi-Paradigm Modelling
-
-Copyright (c) 2017 Khady FALL
-(khady.fall@umontreal.ca)
-
-==========================================================================================
-
-EXPORTING AToMPM's METAMODELS AND MODELS TO ECORE
-
-This implementation allows you to export metamodels and models from AToMPM to Ecore.
-
-==========================================================================================
-
-INSTALLATION :
-
-In the \implementation folder, there are two folders : \Ecore and \Plugins.
-
-To install the exporting files, do the following :
-
-1- Copy and paste the \Ecore folder in your AToMPM installation at \atompm\users
-
-\[your_username]\Toolbars.
-
-2- Copy and paste the two files ExportMM2Ecore.js and ExportM2Ecore.js located in \Plugins
-
-in your AToMPM installation at \atompm\plugins.
-
-All the files have been properly installed.
-
-
-
-UTILISATION :
-
-To export metamodels or models in AToMPM, follow these steps :
-
-1- Open a new session in AToMPM.
-
-2- Click on the "(re-)load a toolbar" button.
-
-3- In the \Toolbars\Ecore folder, choose "Export2Ecore.buttons.model" then click the "ok"
-
-button.
-
-4- Load your metamodel or model in the current canvas.
-
-5- If you want to export a metamodel, click on the "MM -> Ecore" button of the loaded
-
-toolbar (the first button). If you want to export a model, rather click on the "M ->
-
-Ecore" button (the second button).
-
-6- If you want to export a model, you will be asked to enter the name of the model, the
-
-name of the metamodel and its URI. Also, you will be asked if you want a dynamic instance
-
-or a static one. There are default values : the model's name will be the current model
-
-name, the metamodel's name and URI will be composed as follow :
-
-"[name_of_current_model]Metamodel" and "http://[name_of_current_model]", respectively.
-
-7- If you want to export a metamodel, you will be asked to enter the name of the metamodel
-
-and its URI. There are default values : the name of the current metamodel and a URI
-
-composed as follow : "http://[name_of_(meta)model]".
-
-8- After entering those informations, click the "ok" button.
-
-9- A file .ecore for a metamodel, or a file .xmi for a model, has been created. That file
-
-is in a folder \exported_to_ecore located in the \atompm folder of your AToMPM
-
-installation.
-
-10- If you want to use the exported file in Eclipse, you have to register the metamodel.
-
-==========================================================================================

+ 4 - 4
users/(default)/Toolbars/ModelVerse/ModelVerse.buttons.model

@@ -560,7 +560,7 @@
 				},
 				"tooltip": {
 					"type": "string",
-					"value": "(BETA) Connect to the ModelVerse"
+					"value": "(ALPHA) Connect to the ModelVerse"
 				},
 				"code": {
 					"type": "code",
@@ -575,7 +575,7 @@
 				},
 				"tooltip": {
 					"type": "string",
-					"value": "(BETA) Load a model from the ModelVerse"
+					"value": "(ALPHA) Load a model from the ModelVerse"
 				},
 				"code": {
 					"type": "code",
@@ -590,7 +590,7 @@
 				},
 				"tooltip": {
 					"type": "string",
-					"value": "(BETA) Save a model to the ModelVerse"
+					"value": "(ALPHA) Save a model to the ModelVerse"
 				},
 				"code": {
 					"type": "code",
@@ -607,4 +607,4 @@
 			"/Formalisms/SCCD/SCCD"
 		]
 	}
-}
+}