Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Sirius/Tutorials/UpdateSiteModelerTutorial"

(Export the Update Site project)
(Blanked the page)
Line 1: Line 1:
=Overview=
 
  
This tutorial explains how to create your first update site to distribute a graphical modeling tool created with Eclipse Sirius.
 
 
The instructions describe the creation of an update site for the result of the basic tutorial: a modeling tool which simply allows the user to graphically represent a family.
 
 
[[File:Sirius_tuto5_21.png]]
 
 
=Get the modeling tool in your environment=
 
 
If you just followed the Sirius [[Sirius/Tutorials/4MinTutorial | Starter Tutorial]], you are ready! Directly go to next section:[[Sirius/Tutorials/UpdateSiteModelerTutorial#Start_creating_the_update_site | Start creating the update site]].
 
 
Otherwise, start by following the instructions to install the ''Basicfamily'' Domain Model:
 
* [[Sirius/Tutorials/StarterTutorial#Import_the_projects_containing_the_sample_Domain_Model | Import the projects containing the sample Domain Model]]
 
* [[Sirius/Tutorials/StarterTutorial#Select_the_Sirius_perspective | Select the Sirius perspective]]
 
 
Install the solution of the Starter Tutorial. It is implemented by a ''Viewpoint Specification Project'' that you need to import into your workspace.
 
This project can be easily installed from the provided examples (menu '''File > New > Example...''' : select '''Basic Family Sample Modeler Definition''').
 
 
[[File:Sirius_tuto5_02.png]]
 
 
 
By default the icons defined in the modeler are not exported into the update site: you have do update the project definition in order to get these icons in the final modeler.
 
 
Open the file '''MANIFEST.MF''' from the ''META-INF'' directory of the project ''org.eclipse.sirius.sample.design''.
 
 
In the tab '''Build''' check the ''icons'' folder in the '''Binary Build''' list.
 
 
[[File:Sirius_tuto5_22.png]]
 
 
=Start creating the update site=
 
 
==Create a Feature Project==
 
The first step consists in creating a feature project containning all the features necessary to create the update site.
 
 
Right click in the '''Model Explorer''' view and select '''Other...'''.
 
 
[[File:Sirius_tuto5_04.png]]
 
 
 
Select '''Feature Project'''.
 
 
[[File:Sirius_tuto5_23.png]]
 
 
 
Then set the feature's properties:
 
* '''Project name''': <code>org.eclipse.sirius.sample.basicfamily.feature</code>
 
* '''Feature Name''': <code>org.eclipse.sirius.sample.basicfamily</code>
 
* '''Feature Vendor''': <code>Your name company</code>
 
 
[[File:Sirius_tuto5_06.png]]
 
 
 
Finally, click on '''Next''' and select the projects defining your complete modeling tool: the metamodel, the modeler and all the other required plugins.
 
 
* '''org.eclipse.sirius.sample.basicfamily'''
 
* '''org.eclipse.sirius.sample.basicfamily.design'''
 
* '''org.eclipse.sirius.sample.basicfamily.edit'''
 
* '''org.eclipse.sirius.sample.basicfamily.editor'''
 
 
[[File:Sirius_tuto5_07.png]]
 
 
Click on '''Finish'''.
 
 
==Create an Update Site project==
 
 
'''Right click''' in the '''Model Explorer''' view and select '''New > Other…'''.
 
 
Select '''Update Site Project'''.
 
 
[[File:Sirius_tuto5_08.png]]
 
 
 
Then set the project name : <code>org.eclipse.sirius.sample.basicfamily.update</code>.
 
 
[[File:Sirius_tuto5_09.png]]
 
 
 
Click on '''Finish''': Eclipse creates the project and opens an editor on the '''site.xml''' file.
 
 
Add a new Category and name it Basic Family (id : <code>BasicFamily</code>).
 
 
[[File:Sirius_tuto5_10.png]]
 
 
 
Add the feature '''org.eclipse.sirius.sample.basicfamily.feature''' to the category. This defines a category proposed during the installation of the plugin.
 
 
[[File:Sirius_tuto5_11.png]]
 
 
 
Finally, click on '''Build''' to launch the update site creation:
 
 
[[File:Sirius_tuto5_12.png]]
 
 
==Export the Update Site project ==
 
 
Now it is necessary to export the update site to an archive.
 
 
Select these resources:
 
* folder '''features'''
 
* folder '''plugins'''
 
* file '''artifacts.jar'''
 
* file '''content.jar'''
 
* file '''site.xml'''
 
 
 
Right click on the selected resources and click on '''Export'''
 
 
[[File:Sirius_tuto5_13.png]]
 
 
 
Select '''Archive File''' in '''General''' section
 
 
[[File:Sirius_tuto5_14.png]]
 
 
 
Fill the '''To archive file''' field to define the archive location and select the option '''Create only selected directories'''.
 
 
[[File:Sirius_tuto5_24.png]]
 
 
 
'''Warning''' : The ''.project'' file should not be selected.
 
 
 
Click on '''Finish''': the archive is exported to the path defined previously.
 
 
=Test the Update Site=
 
==Install the modeler==
 
To verify if the Update Site works correctly, install the Basic Family modeler in a new Sirius environment or in a new Obeo Designer.
 
 
Open your Eclipse environment and select '''Help > Install New Software…'''.
 
 
[[File:Sirius_tuto5_16.png]]
 
 
 
Click on ''Add…'' and fill the fields
 
* '''Name''': <code>Basic Family Modeler</code>
 
* '''Location''':Click on "''Archive… ''" button and retrieve the archive exported previously
 
 
[[File:Sirius_tuto5_17.png]]
 
 
 
Click on '''Ok''' button
 
 
[[File:Sirius_tuto5_18.png]]
 
 
 
Ckick on '''Next''' button and follow instructions.
 
 
=Run the Modeler=
 
 
After Sirius or Obeo Designer has restarted, import the Sample Basic Family model as described in [[Sirius/Tutorials/StarterTutorial#Import_a_sample_model | Import a sample model]].
 
 
After selecting the viewpoint you can use the modeler
 
 
[[File:Sirius_tuto5_19.png]]
 
 
 
[[File:Sirius_tuto5_21.png]]
 

Revision as of 10:14, 11 August 2016

Back to the top