Skip to content

Commit c89c31c

Browse files
committed
use mdx and svg from drawio
1 parent d8cb56b commit c89c31c

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

src/content/docs/users/moosequery/index.md renamed to src/content/docs/users/moosequery/index.mdx

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ title: "Moose Query user documentation"
55
subtitle: "Documentation about Moose Query, the query feature of Metamodels described by Fame."
66
---
77

8-
<!-- TOC -->
8+
import MooseGraphSVG from './moose-graph.drawio.svg';
9+
import containmentTreeUserSVG from './containmentTreeUser.drawio.svg';
10+
import navigationUserSVG from './navigationUser.drawio.svg';
11+
12+
913
- [Introduction](#introduction)
1014
- [Relations between entities in Moose](#relations-between-entities-in-moose)
1115
- [Containment](#containment)
@@ -18,19 +22,25 @@ subtitle: "Documentation about Moose Query, the query feature of Metamodels desc
1822
- [Recursive queries](#recursive-queries)
1923
- [Stop condition](#stop-condition)
2024
- [Execute the containment query](#execute-the-containment-query)
25+
- [Containment queries examples](#containment-queries-examples)
2126
- [Containment syntactic sugar](#containment-syntactic-sugar)
27+
- [Examples of containment tree syntactic sugar](#examples-of-containment-tree-syntactic-sugar)
2228
- [Navigating Dependencies (Associations)](#navigating-dependencies-associations)
2329
- [Moose Query navigation DSL](#moose-query-navigation-dsl)
24-
- [Initialize the navigation query](#initialize-the-navigation-query)
25-
- [Add options to the navigation query](#add-options-to-the-navigation-query)
30+
- [Initialize a navigation query](#initialize-a-navigation-query)
31+
- [Navigation query options](#navigation-query-options)
2632
- [Get only local dependencies](#get-only-local-dependencies)
27-
- [Receive entities instead of associations](#receive-entities-instead-of-associations)
33+
- [Get entities instead of associations](#get-entities-instead-of-associations)
2834
- [Execute the navigation query](#execute-the-navigation-query)
29-
- [Navigation syntactic suggar](#navigation-syntactic-suggar)
35+
- [Navigation queries examples](#navigation-queries-examples)
36+
- [Navigation syntactic sugar](#navigation-syntactic-sugar)
37+
- [Examples of dependencies navigation syntactic sugar](#examples-of-dependencies-navigation-syntactic-sugar)
3038
- [Manipulating the gathered results of a navigation query](#manipulating-the-gathered-results-of-a-navigation-query)
39+
- [Accessing the opposite entities](#accessing-the-opposite-entities)
40+
- [Excluding internal dependencies](#excluding-internal-dependencies)
41+
- [Navigate the containment tree of the dependencies](#navigate-the-containment-tree-of-the-dependencies)
3142
- [Future plans for MooseQuery](#future-plans-for-moosequery)
3243

33-
<!-- /TOC -->
3444

3545
Moose-Query is a domain-specific language to build navigation and scope queries for entities in Moose.
3646
Its authors are Anne Etien, Jean-Christophe Bach, Vincent Blondeau and Cyril Ferlicot-Delbecque.
@@ -46,7 +56,8 @@ Moose-Query is an internal domain-specific language (DSL) for creating queries o
4656
It replaces Moose-Chef, and is designed to simplify and standardize the way to query Moose models.
4757

4858
In order to visualize the concepts, let's take an example of a simple application model:
49-
![Image representing a small model with containment and associations examples.](img/moose-graph.png)
59+
60+
<MooseGraphSVG className="svg-theme" />
5061

5162
### Relations between entities in Moose
5263

@@ -184,7 +195,7 @@ entity query containers withProperty: #hasSourceAnchor.
184195

185196
Example of a containment tree to use for the next examples:
186197

187-
![A schema of a containment tree.](img/containmentTreeUser.png)
198+
<containmentTreeUserSVG className="svg-theme" />
188199

189200
Let's query:
190201

@@ -274,7 +285,7 @@ In the previous versions of Moose, the API was less homogeneous:
274285

275286
For the following examples, let's use the same model as the previous example section:
276287

277-
![A schema of a containment tree.](img/containmentTreeUser.png)
288+
<containmentTreeUserSVG className="svg-theme" />
278289

279290
```smalltalk
280291
package1 containedEntities. "=> { package2 . class1 }"
@@ -399,7 +410,8 @@ entity query incoming dependenciesOfAnyType: { FamixTReference . FamixTInvocatio
399410
### Navigation queries examples
400411

401412
Example of a navigation model to use for the next examples:
402-
![A schema of a navigation model.](img/navigationUser.png)
413+
414+
<navigationUserSVG className="svg-theme" />
403415

404416
Let's query:
405417

0 commit comments

Comments
 (0)