Uitleg over referenties in ReSpec verbeterd.

Geonovum · Jan 10, 2025 · fbe48a0 · fbe48a0
1 parent df7b98f
commit fbe48a0
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 14 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,5 +3,8 @@
         "CORS",
         "Geonovum",
         "Respec"
-    ]
-}
+    ],
+    "markdown.copyFiles.destination": {
+        "/docs/**/*": "media"
+    }
+}
diff --git a/docs/EA.md b/docs/EA.md
@@ -23,3 +23,28 @@ Externe links:
 - [Handleiding gebruik MIM-toolbox](https://github.com/Geonovum/MIM-Werkomgeving/blob/master/UML%20profieltooling/werkversie1.1.1/README.md)
 - [Handleiding genereren MIM-profiel](https://github.com/Geonovum/MIM-Werkomgeving/tree/master/UML%20profieltooling#readme)
 - [Handleiding genereren Extensie MIM-toolbox](https://github.com/Geonovum/MIM-Werkomgeving/blob/master/UML%20profieltooling/how_to_extensie_op_toolbox.md)
+
+
+
+## Exporteren en importeren van XMI
+
+XMI is een uitwisselformaat voor UML modellen. Er zijn heel veel versies:
+
+### Native EA XMI
+
+Dit formaat kan je gebruiken om een UML model met zo weinig mogelijk verlies te delen in gevallen dat het EAPX bestanden delen niet werkt.
+
+#### Export
+
+Open het te exporteren model en selecteer het top package:
+
+![selecteer top package](media/image.png)
+
+In Publish-->Export-XML->Export XML for Current package:
+
+![alt text](media/image36.png)
+
+Kies voor Native als Export Type en 'Export'!
+
+![alt text](media/image35.png)
+
diff --git a/docs/ReSpec-definitielijst-maken.md b/docs/ReSpec-definitielijst-maken.md
@@ -3,6 +3,10 @@
 > **Note**
 > In dit stuk afbeeldingen opnemen waarin je het resultaat in ReSpec kunt zien. Daarvoor graag [NL-ReSpec-GN-template](https://geonovum.github.io/NL-ReSpec-GN-template/) aanvullen.
 
+
+> **TODO**
+> Het zou wel heel leuk zijn om een link met [NL-SBB](https://docs.geostandaarden.nl/nl-sbb/nl-sbb/) te leggen.
+
 ## Intro
 
 Een belangrijk onderdeel van een dataspecificatie is de definitie van begrippen. Steeds vaker leggen we bij Geonovum begrippen vast in een [begrippenkader](https://definities.geostandaarden.nl/nl/). Idealiter zouden we voor de definitie van een begrip altijd daarnaar willen verwijzen. Op dit moment is dat om meerdere redenen nog niet mogelijk. Op deze plek leggen we uit hoe we nu een definitie opnemen.

diff --git a/docs/ReSpec.md b/docs/ReSpec.md
@@ -322,17 +322,23 @@ Naamgevinsregels voor pubDomain:
 | vtm            |                                                          | docs.geostandaarden.nl     | is eigenlijk metadata     |                                                               | verhuizen naar MD                       |
 | wp             | Whitepaper Geostandaarden                                | respec utils               | ook een raar pubdomain    |                                                               | verhuizen naar ngii                     |
 
-## LocalBiblio
+## Bibligrafie
 
-In de localBiblio variabele worden Referenties naar andere documenten gezet.
-Voordat je hier citaten toevoegt, loont het de moeite om eerst in de
-[https://www.specref.org/](SpecRef) van ReSpec zelf te kijken. Pas als je een
-verwijzing niet vindt in SpecRef voeg je hem hier toe!
+ReSpec maakt automatisch een literatuurlijst van alle documenten waarnaar
+je verwijst. Een normatieve verwijzing naar een document ziet er als volgt uit
 
-Verwijzen naar een bibliografieelement gebeurt als volgt `[[ID]]`. De dubbele
-haakjes zorgen ervoor dat er blokhaken om de verwijzing staan in de tekst. Je
-kunt ook aangeven dat een verwijzing normatief is door er een uitroepteken voor
-te zetten `[[!ID]]`
+```markdown
+we gebruiken [[SemVer]] voor het nummeren van versies.
+```
+
+Verwijzingen worden op drie manieren geresolved:
+
+- Een globale lijst is te vinden op: [SpecRef](https://www.specref.org/).
+- Een Geonovum brede lijst (TODO) is te vinden op: [tools.geostandaarden.nl](https://github.com/Geonovum/tools.geostandaarden.nl/blob/main/tools.geostandaarden.nl/respec/config/geonovum-config.js)
+- In de lokale `config.js` kan je lokale referenties toevoegen
+
+Je kunt met  aangeven of een verwijzing normatief is of niet door er een uitroepteken of vraagteken voor te zetten
+te zetten `[[!ID]]` of `[[?ID]]`.
 
 ## Voorbeeld config.js
 

diff --git a/docs/index.md b/docs/index.md
@@ -7,7 +7,7 @@ publicatieomgeving van Geonovum beschreven.
 
 ## Geonovum tooling
 
-- **Enterprise Architect**
+- **UML Modelleertool:** Enterprise Architect
     - [Overzicht](EA.md)
     - [Primitieve datatypes](EA-toepassing-standaarddatatypen.md): Handleiding
         en toelichting op het toepassen van standaarddatatypes in
@@ -91,8 +91,8 @@ Dit is uitgelegd in de [handleiding ontologie maken](Handleiding-ontologie-maken
 ## MkDocs voor deze handleiding
 
 De handleiding wordt beheerd in [MkDocs](https://www.mkdocs.org/). Dit is een
-lichtgewicht tool die een collectie Markdown handleidingen omzet in een
-navigeerbare handleiding. De handleiding staat op
+lichtgewicht tool die een doorzoekbare en navigeerbare site maakt van een
+verzameling Markdown documenten. De handleiding staat op
 [github pages](https://github.com/Geonovum/handleiding-tooling). De
 bronbestanden staan in:
 [handleiding-tooling](https://github.com/Geonovum/handleiding-tooling).

diff --git a/docs/media/image.png b/docs/media/image.png
diff --git a/docs/media/image35.png b/docs/media/image35.png
diff --git a/docs/media/image36.png b/docs/media/image36.png