Skip to main content
Jump to: navigation, search

Difference between revisions of "Graphical Modeling Framework/Documentation"

(General)
(Documentation Index)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{GMF}}
 
{{GMF}}
  
= Documentation Index =
+
= Introduction and Overview =
Feel free to contribute to this [[/Index | index]]!
+
The core of Graphical Modeling Framework (GMF) is GMF Runtime, a Java based framework to run graphical editors for EMF Models. It provides a highly customizable way to render any model elements with several kinds of graphical shape and an ergonomic UX.
 +
 
 +
The project page of GMF Runtime is available at [https://www.eclipse.org/modeling/gmp/?project=gmf-runtime].
 +
Most of the documentation is available in this [[/Index | index]].
 +
 
 +
On the top of GMF Runtime, two main Eclipse projects provides tooling to ease the creation and customization of GMF based editors:
 +
* [https://www.eclipse.org/gmf-tooling/ GMF Tooling] with a generative approach. This project was discontinued.
 +
* [https://www.eclipse.org/sirius/ Eclipse Sirius] with an interpretive approach. It is now the preferred way to create GMF based editors
 +
 
 +
So, if you want to ramp-up and start to create your own graphical editors, you can start with [https://www.eclipse.org/sirius/getstarted.html these tutorials] which hide some GMF internal complexities. Then, if you need advanced customization for specific usage, read GMF Runtime Tutorials below.
  
 
= Tutorials =
 
= Tutorials =
Line 11: Line 20:
 
*[[Simple Telecom Network|Flash (video) based GMF Tutorial of a Simple Telecom Network]]  
 
*[[Simple Telecom Network|Flash (video) based GMF Tutorial of a Simple Telecom Network]]  
  
=== External tutorials ===
+
External Tutorials:
 
* [http://gmfsamples.tuxfamily.org/wiki/doku.php?id=start Additional Tutorial, tips & tricks]
 
* [http://gmfsamples.tuxfamily.org/wiki/doku.php?id=start Additional Tutorial, tips & tricks]
  
Line 24: Line 33:
 
= Online Help =
 
= Online Help =
  
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/prog-guide/runtime/index.html Runtime Programmer's Guide]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/prog-guide/runtime/index.html Runtime Programmer's Guide]</del>
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/howto/diagram/index.html Runtime How-To Guide]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/howto/diagram/index.html Runtime How-To Guide]</del>
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/examples-guide/index.html Runtime Examples]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/examples-guide/index.html Runtime Examples]</del>
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/api/runtime/overview-summary.html Runtime API Reference]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/api/runtime/overview-summary.html Runtime API Reference]</del>
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/api/tooling/overview-summary.html Tooling API Reference]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/api/tooling/overview-summary.html Tooling API Reference]</del>
*[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/extension-points/index.html Extension Points Reference]
+
*<del>[http://help.eclipse.org/help32/topic/org.eclipse.gmf.doc/reference/extension-points/index.html Extension Points Reference]</del>
  
 
= How-To's / Q&A  =
 
= How-To's / Q&A  =
  
*[[Graphical Modeling Framework FAQ|Frequently Asked Questions (FAQ)]]
+
*[[../FAQ|Frequently Asked Questions (FAQ)]]
*[[GMF Tips|Tips and Code Snippets]]
+
*[[GMF_Newsgroup_Q_and_A|eclipse.modeling.gmf]] (current)
*[[GMF/Recipes| Recipes ]]
+
*[[GMF_Archived_Newsgroup_Q_and_A|eclipse.technology.gmf]] (archived)
*[[GMF Migration|Model Migration]]
+
*[[../Tips|Tips and Code Snippets]]
*[[GMF Reconciler|Reconciler]]
+
*[[../Recipes| Recipes ]]
*[[GMF RCP Support|RCP Support]]
+
*[[../Migration|Model Migration]]
*[[GMF Troubleshooting Guide|Troubleshooting Guide]]
+
*[[../Reconciler|Reconciler]]
*[[GMF Build Instructions|GMF Build Instructions]]
+
*[[../RCP Support|RCP Support]]
 +
*[[../Troubleshooting|Troubleshooting]]
 +
*[[../Build|GMF Build Instructions]]
 +
 
 +
== GMF Concepts ==
 
Articles about diagram editor concepts and how they are supported in GMF tooling (definition, mapping, generation):
 
Articles about diagram editor concepts and how they are supported in GMF tooling (definition, mapping, generation):
*[[GMF Nodes|Nodes]]
+
*[[../Concepts/Nodes|Nodes]]
*[[GMF Links|Links]]
+
*[[../Concepts/Links|Links]]
*[[GMF Labels|Labels]]
+
*[[../Concepts/Labels|Labels]]
 
Information on OCL, constraints, audit, and metric features:
 
Information on OCL, constraints, audit, and metric features:
*[[GMF Constraints|GMF Constraints and Validation]]
+
*[[../Concepts/Constraints|GMF Constraints and Validation]]
  
 
== Tooling Model Hints ==
 
== Tooling Model Hints ==
  
 
Description of GMF models and usage hints.
 
Description of GMF models and usage hints.
*[[GMFGraph Hints|Graphical Definition Model]]
+
*[[../Models/GMFGraph|Graphical Definition Model]]
*[[GMF MapModel Hints|Mapping Model]]
+
*[[../Models/GMFTool|Tools model]]
*[[GMF GenModel Hints|Generator Model]]
+
*[[../Models/GMFMap|Mapping Model]]
 
+
*[[../Models/GMFGen|Generator Model]]
== Newsgroup Noteworthy Q&A ==
+
*[[GMF_Newsgroup_Q_and_A|eclipse.modeling.gmf]] (current)
+
*[[GMF_Archived_Newsgroup_Q_and_A|eclipse.technology.gmf]] (archived)
+
  
 
= Resources =
 
= Resources =

Latest revision as of 07:56, 19 May 2020



GMF
Website
Download
Dev Builds
Update Site releases milestones
Community
Mailing ListNewsgroupIRC
Bugzilla
Open
Help Wanted
Bug Day
Source
GMF Notation: View CVS repo

GMF Runtime: View CVS repo
GMF Tooling: View Git Repo, GitHub


Introduction and Overview

The core of Graphical Modeling Framework (GMF) is GMF Runtime, a Java based framework to run graphical editors for EMF Models. It provides a highly customizable way to render any model elements with several kinds of graphical shape and an ergonomic UX.

The project page of GMF Runtime is available at [1]. Most of the documentation is available in this index.

On the top of GMF Runtime, two main Eclipse projects provides tooling to ease the creation and customization of GMF based editors:

  • GMF Tooling with a generative approach. This project was discontinued.
  • Eclipse Sirius with an interpretive approach. It is now the preferred way to create GMF based editors

So, if you want to ramp-up and start to create your own graphical editors, you can start with these tutorials which hide some GMF internal complexities. Then, if you need advanced customization for specific usage, read GMF Runtime Tutorials below.

Tutorials

General

External Tutorials:

Specific tutorials

Online Help

How-To's / Q&A

GMF Concepts

Articles about diagram editor concepts and how they are supported in GMF tooling (definition, mapping, generation):

Information on OCL, constraints, audit, and metric features:

Tooling Model Hints

Description of GMF models and usage hints.

Resources

Eclipse Corner Articles

Presentations

  • EclipseCon 2006
    • Introduction to GMF slides
    • Creating your own Domain Specific Modeler using GMF slides
  • EclipseWorld 2006 Building Better Graphical Editors with GMF slides
  • Eclipse Summit Europe 2006 What's New in Modeling at Eclipse slides
  • EclipseCon 2008
    • Introduction to the Graphical Modeling Framework (Network domain demo) Submission
    • GMF:Exemplary MDD Submission
    • Using GMF and M2M for Model-driven-development Submission
  • EclipseCon 2009
    • GMF and QVTO: roads (finally) crossed Session
  • EclipseCon 2010
  • EclipseCon 2011
    • GMF : Create you graphical DSL slides
  • Eclipse Democamp Grenoble 2011
    • Leveraging Modeling Stack in your application: Bonita Open Solution Case Study slides

Back to the top