Skip to main content
Jump to: navigation, search

Difference between revisions of "EMF Compare/User Guide"

(UML Specialization)
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{EMF_Compare}}
+
This page has moved to http://www.eclipse.org/emf/compare/documentation/latest/user/user-guide.html
  
= Getting Started  =
+
[[Category:EMF Compare/Archive]]
 
+
== Installing EMF Compare  ==
+
 
+
'''Marketplace Client'''
+
 
+
Using the bundled Eclipse marketplace client you can install EMF Compare in one click. Just type "emf compare", click on search, and then on install.
+
 
+
 
+
[[Image:Marketplace.png]]
+
 
+
'''Update Site'''
+
 
+
EMF has been part of the Eclipse release train since Galileo, you can install it using the following update sites, depending on your platform. '''Note''' that the following are not meant to be visited in your internet browser; they must be pasted in the ''Help > Install New Software'' dialog of your Eclipse, as p2 repositories.
+
 
+
  http://download.eclipse.org/releases/galileo
+
  http://download.eclipse.org/releases/helios
+
  http://download.eclipse.org/releases/indigo
+
  http://download.eclipse.org/releases/juno
+
 
+
Please note that the EMF Compare development team does its best to maintain downward compatibility towards Galileo (Eclipse 3.5). Following is the compatibility chart :
+
{| border="1"
+
|-
+
! EMF Compare
+
! Eclipse 3.2 - EMF 2.2
+
! Eclipse 3.3 - EMF 2.3
+
! Eclipse 3.4 - EMF 2.4
+
! Eclipse 3.5 - EMF 2.5
+
! Eclipse 3.6 - EMF 2.6
+
! Eclipse 3.7 - EMF 2.7
+
! Eclipse 3.8 - EMF 2.8
+
|-
+
| 0.7
+
| style="text-align:center; background:green; color:white" | OK
+
|
+
|
+
|
+
|
+
|
+
|
+
|-
+
| 0.8
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|
+
|
+
|
+
|
+
|-
+
| 1.0
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|
+
|
+
|-
+
| 1.1
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|-
+
| 1.2
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|-
+
| 1.3
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|-
+
| bgcolor="#cccccc" | 2.0
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:red; color:white" | KO
+
| style="text-align:center; background:green; color:white" |OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
| style="text-align:center; background:green; color:white" | OK
+
|}
+
 
+
An empty cell indicates that the compatibility hasn't been tested for a particular combination.
+
 
+
== Usage ==
+
 
+
Once installed, you can compare your files (locally or from any Version Control System) as usual using the '''compare with''' menu.
+
 
+
[[Image:EMFC Compare With.png|center]]
+
 
+
== User Interface  ==
+
 
+
The main points of interest are highlighted in the following picture :
+
 
+
[[Image:CompareUI.png|center|EMF Compare's basic user interface]]
+
 
+
# Overview of the differences detected between the given two (or three) models.
+
# First version of the compared models.
+
# Second version of the compared models.
+
# This button will only be visible in the case of three-way comparisons (for example, comparing with a remote repository). It will make a third version of the compared model (the common ancestor of the two others) visible in the interface.
+
# This button will allow you to group differences together in the structural view. For example, grouping all "Additions" or "Deletions" together.
+
# This button will allow you to filter some differences out of the view according to a set predicate. For example, filtering out all "Additions" or "Moves".
+
# Allows you to merge all non conflicting differences (left to right, or right to left) at once.
+
# Allows you to merge the single, currently selected difference in a given direction (left to right, or right to left).
+
# Allows you to navigate through the detected differences.
+
 
+
= Features =
+
 
+
== Handling Conflicts  ==
+
 
+
PENDING
+
 
+
== Grouping Differences  ==
+
 
+
This feature allows you to group differences together in the structural view according to a set predicate. By default, EMF Compare provides three distinct grouping strategies :
+
[[Image:EMF Compare Groups Choice.png]]
+
 
+
; Default : Do not try and group differences together, display them as they were detected.
+
[[Image:EMF Compare Groups Default.png]]
+
; By Kind : Group differences by their kind (''additions'', ''deletions'', ''moves'', ''changes'').
+
[[Image:EMF Compare Groups Kind.png]]
+
; By Metaclass : Group difference according to the metaclass of the object on which they were detected.
+
[[Image:EMF Compare Groups Metaclass.png]]
+
 
+
PENDING UPDATE, this is a demo displaying EMF Compare 1.3
+
[http://www.eclipse.org/emf/compare/doc/features/videos/Groups/groups.htm Demo]
+
 
+
PENDING : New grouping strategies can be provided to EMF Compare through extension points.
+
 
+
== Filtering Differences  ==
+
 
+
This features allows you to filter differences out of the structural view according to a set predicate. By default, EMF Compare provides five distinct filters :
+
[[Image:EMF Compare Filters Choice.png]]
+
 
+
; Changed Elements : Filter out all differences of type '''CHANGE'''. Disabled by default.
+
; Added Elements : Filter out all differences of type '''ADD'''. Disabled by default.
+
; Removed Elements : Filter out all differences of type '''DELETE'''. Disabled by default.
+
; Moved Elements : Filter out all differences of type '''CHANGE'''. Disabled by default.
+
; Resource Mappings : Filter out all resource mappings from the view. Enabled by default.
+
 
+
PENDING UPDATE, this is a demo displaying EMF Compare 1.3
+
[http://www.eclipse.org/emf/compare/doc/features/videos/Filters/filters.htm Demo]
+
 
+
PENDING : New filters can be provided to EMF Compare through extension points.
+
 
+
== Text Attribute Comparison  ==
+
 
+
Differences made into ''String''-typed attributes can be compared and merged directly as text from the compare interface through a simple right-click on the difference.
+
 
+
[[Image:EMF Compare Text Compare.png]]
+
 
+
PENDING UPDATE, this demo displays EMF Compare 1.3
+
[http://www.eclipse.org/emf/compare/doc/features/videos/Text%20compare/textCompare.htm Demo]
+
 
+
== Graphical Comparison  ==
+
 
+
PENDING UPDATE
+
 
+
Since the 1.2 release EMF compare provides the ability to compare models with graphical modelers.
+
 
+
Have a look on the following demos :
+
 
+
[http://www.eclipse.org/emf/compare/doc/features/videos/EcoreTools-v2/EMFCompareEcoreTools.html [Demo : Comparing Ecore files with diagrams]]
+
 
+
[[http://www.eclipse.org/emf/compare/doc/features/videos/Papyrus/EMFComparePapyrus.html Demo : Comparing UML files with diagrams]]
+
 
+
[[Image:Diag comp diff.png]]
+
 
+
== Logical Model  ==
+
 
+
The Eclipse Platform logical model API allows to hook in all the workspace and team operations to adapt the user request. It enables, for instance, to add in a commit request new files which are required to keep model consistency.
+
 
+
[http://www.eclipse.org/emf/compare/doc/features/videos/LogicalModels/LogicalModels.html [Demo  : keeping model consistency on Workspace operation]]
+
 
+
[[Image:EGit logical Selection.png]]
+
 
+
== UML Specialization  ==
+
 
+
PENDING
+
 
+
[http://www.eclipse.org/emf/compare/doc/features/videos/UML%20comparison/compareUml.htm [Demo : Specific support to encapsulate profiles and stereotypes diffs]]
+
 
+
== SysML Specialization ==
+
 
+
== Exporting Differences  ==
+
 
+
= Other Materials  =
+
 
+
*[http://www.eclipse.org/emf/compare/doc/features/videos/index.html Videos of 2011 new features]
+
*[[EMF Compare/CompareUMLPapyrusAPI|Specification and Documentation about the comparison of UML diagrams]]
+
 
+
[[Category:EMF Compare]]
+

Latest revision as of 11:53, 5 March 2014

This page has moved to http://www.eclipse.org/emf/compare/documentation/latest/user/user-guide.html

Back to the top