Skip to content

Commit e78b7c3

Browse files
committed
docs: add minimalist metamodel-export documentation
1 parent c793daf commit e78b7c3

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

docs/global/modules/core/pages/howto/usage-model-api-gen-gradle.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ pluginManagement {
7070
[source,kotlin]
7171
--
7272
plugins {
73-
id("org.modelix.metamodel.gradle")
73+
id("org.modelix.model-api-gen")
7474
}
7575

7676
val mpsVersion: String by rootProject
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
= MPS solution for metamodel-export
22
:navtitle: `metamodel-export` (MPS)
3+
4+
== Overview
5+
6+
In order to export a meta-model (i.e. the structure aspect of a langauge) from MPS, modelix uses the MPS solution `metamodel-export`.
7+
This solution maps the structure of a language to corresponding serializable data classes of the `model-api`[https://api.modelix.org/2.3.0/model-api/org.modelix.model.data/index.html] (e.g. `LanguageData` and `ConcepData`).
8+
Further, the `metamodel-expor` provides a command line interface to export these data classes to a JSON file from outside of MPS.
9+
10+
The `metamodel-export` is mainly used in the corresponding gradle plugin xref:core:reference/component-model-api-gen-gradle.adoc[model-api-gen-gradle].
11+

docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ https://artifacts.itemis.cloud/#browse/browse:maven-mps:org%2Fmodelix%2Fmodel-ap
99
--
1010

1111
== Overview
12-
The `model-api-gen.gradle.plugin` is a Gradle plugin that wraps the functionality of xref:core:reference/component-model-api-gen.adoc[model-api-gen].
12+
The `model-api-gen.gradle.plugin` is a Gradle plugin that wraps the functionality of the xref:core:reference/component-metamodel-export.adoc[] and xref:core:reference/component-model-api-gen.adoc[].
1313
It provides an additional Gradle task which will apply a 2-staged process:
1414

1515
. MPS metamodel export to JSON (optional)
@@ -26,7 +26,7 @@ metamodel {
2626
jsonDir = File("path/to/json/dir")
2727
}
2828
--
29-
As a result, all MPS-specific configuration settings will be ignored and the specified directory will be used for the next step.
29+
As a result, all MPS-specific configuration settings will be ignored and the specified directory will be used for the next step.
3030

3131
. JSON to model API generation
3232
+
@@ -195,4 +195,4 @@ metamodel {
195195
languageClass.suffix = "MyLanguageSuffix"
196196
}
197197
}
198-
--
198+
--

0 commit comments

Comments
 (0)