'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..12a4ecd --- /dev/null +++ b/404.html @@ -0,0 +1,251 @@ + + +
+ + + + + + + +Page not found
+++Note >
+@Gerard
: screenshots toevoegen
Bij Geonovum gebruiken we een aantal voorgedefineerde datatypes. Deze zijn +opgedeeld in drie categorieën:
+In: svn.geostandaarden.nl/Datatypes zijn drie collecties met primitieve types +opgenomen die alle primitieve types bevat die in Geonovum UML modellen gebruikt
+Deze packages zijn in beheer bij @wilkoquak. Het is de bedoeling dat er in +[Imvertor] een mapping komt die precies overeenkomt het deze drie collecties +types
+In dit package zitten de geometrische datatypes zoals genoemd in +ISO19107:2003.
+ +In dit package zitten de geometrische datatypes zoals genoemd in +MIM.
+ +In dit package zitten datatypes die niet in de twee eerdergenoemde packages +vallen maar wel ergens gebruikt zijn bij Geonovum.
+ +++Note >
+@Wilko
wil jij een korte toelichting geven op de driedeling. Wat +vind je waar en waarom?
Alle basic datatypes binnen UML zouden in één van deze packages moeten staan.
+Als dat niet zo is neem dan contact op met @Wilko
.
Je vindt ze op SVN: svn://svn.geostandaarden.nl/Datatypes
:
++Warning Onderstaande naamgeving klopt niet meer. Dit is door Wilko in +overleg aangepast.
+@Gerard
: graag updaten!
MIM11.xml
Geonovum-algemeen.xml
Geonovum-geometrie.xml
++Note Er is nu nog een
+Datatyps.xml
waarin alle datatypes zitten deze +gaat binnenkort verdwijnen.
Lees hoe je deze types als packages importeert in de handleiding +SVN - importeren bestaand project.
+Deze packages zijn bedoeld voor toepassing binnen een informatiemodel. Het is +niet de bedoeling om de packages in of uit te checken; er hoeven immers geen +wijzigingen in aangebracht te worden.
+++Note >
+@Wilko
en@Paul
: Eigenlijk zou je hier een beperkt aantal +mensen schrijfrechten willen geven en de rest alleen lees-rechten. Ik heb +zoiets nog niet kunnen vinden.@Gerart
: je kunt dat instellen door in +configuratiebestandjes op svn.geostandaarden.nl, maar dan moet je daar wel bij +kunnen.
+Note >
+@Gerard
: In deze paragraaf een uitleg opnemen hoe je vanuit +Enterprise Architect een voorgedefineerd datatype opneemt bij een +«Attribuutsoort»
. |
Instructie voor het gebruik van Enterprise Architect binnen Geonovum:
+Importeer de MIM toolbox:
+ +Externe links:
+Een algemene handleiding voor het opslaag van Geometrie in GML bestanden is te vinden in: Geometrie in model en GML
+Bij een XML applicatie schema (dus ook voor GML schema's) wordt vaak een namespace gebruikt. Deze namespace hoort vaak bij een domein en het is de bedoel dat de combinatie van de namespace en het element uniek is. Dit kan alleen als de namespace, die de vorm van een URI heeft uniek is. Door een URI te kiezen die bij jou onder beheer is weet je zeker dat de combinatie uniek is. In de volgende paragraaf zie je een lijste gebruikte namespaces. Hieronder wat richtlijnen.
+De volgende model onderdelen wordt gebruikt bij het maken construeren van schemas:
+Samen wordt dit:
+Bij een standaard zonder onderdelen wordt de bestandsnaam als onderdeelnaam gebruikt bij locatie.
+GML applicatieschema's zijn te vinden op: https://register.geostandaarden.nl/gmlapplicatieschema/
+Een korte inventarisatie levert:
+standaard | +versie | +namespace | +
---|---|---|
basisgeometrie | +1.0.0 | +http://www.geostandaarden.nl/basisgeometrie/1.0 | +
basisgeometrie | +v20190901 | +http://www.geostandaarden.nl/basisgeometrie/v20190901 | +
brt-algemeen | +1.2.0 | +http://register.geostandaarden.nl/gmlapplicatieschema/brt-algemeen/1.2.0 | +
imaer | +5.1.1 | +http://imaer.aerius.nl/5.1 | +
img | +3.0.0 | +http://www.geluidgegevens.nl/IMGeluid/3.0 | +
imgeo (simple) | +2.1.1 | +http://www.geostandaarden.nl/imgeo/2.1/simple/gml31 | +
imgeo | +2.1.1 | +http://www.geostandaarden.nl/imgeo/2.1 | +
imkl (wibon) | +2.0.0 | +http://www.geostandaarden.nl/imkl/wibon | +
imkl (wibonbr) | +2.0.0 | +http://www.geostandaarden.nl/imkl/wibonbr | +
imkl2015 (wionbr) | +1.2 | +http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 | +
imkl2015 (wionbr) | +1.2.1 | +http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 | +
top10nl | +1.1.1 | +http://www.kadaster.nl/schemas/top10nl/v20120116 | +
top10nl | +1.2.0 | +http://register.geostandaarden.nl/gmlapplicatieschema/top10nl/1.2.0 | +
+ | + | + |
Bij Geonovum worden documenten (standaarden, onderzoeken, rapporten, enz) web-based gepubliceerd. Ook worden de documenten vaak in een werkgroep gemaakt, waarbij ieder werkgroeplid meeschrijft aan het document. Om dit te kunnen gebruiken we een aantal tools: GitHub, Respec en Markdown.
+Deze introductie gaat over Github.
+Waarschijnlijk wil je weten wat GitHub is, anders was je nu niet deze handleiding aan het lezen. Je gaat hier meer over GitHub lezen en waarom het handig is. Er zijn een aantal GitHub termen die alvast handig zijn om te weten. Tot slot lees je hoe je zelf aan de slag kan gaan met GitHub.
+Veel programmeurs wereldwijd maken gebruik van de website GitHub. Zelf zal je er misschien ook wel van gehoord hebben. Als programmeur is het handig om te weten wat GitHub is en hoe je er gebruik van maakt.
+GitHub bestaat uit twee woorden, namelijk Git + Hub. Laten we beginnen met Git. *Git is een open source versiebeheersysteem. De website GitHub is gemaakt op basis van het versiebeheersysteem Git. Met GitHub heb je alle mogelijkheden van Git + extra features.
+In een versiebeheersysteem kunnen programmeurs projecten beheren met code. Het is mogelijk om verschillende versies te beheren en eventueel terug te vallen op een oude versie, mocht er iets misgaan.
+Stel dat je met een team een app wilt programmeren. Dan is het handig als iedereen bij het project kan met daarin alle code van de app. Ook is het handig dat iedereen de laatste code wijzigingen ziet van teamleden en daar eventueel op kan reageren en/of het aanpassen.
+Bij Geonovum gebruiken we Github op een andere manier. Namelijk voor het voor werken aan documentatie voor geostandaarden. Per project is een repository aangemaakt. Een Repository is eenvoudig gezegd een werkmap/projectomgeving.
+Je weet nu dat het mogelijk is om in een team projecten (Waarin code staat) te beheren op GitHub. Het is natuurlijk ook mogelijk om je eigen projecten op GitHub te beheren. Zo heb je een goed overzicht van de aanpassingen en verschillende versies.
+Daarnaast staat je project online. Als je een belangrijk project bijvoorbeeld alleen lokaal op je eigen computer opslaat en je computer houdt ermee op, dan ben je zwaar de pineut. Op GitHub kan je er gewoon altijd bij.
+Maar welke mogelijkheden heeft GitHub nog meer? Hier staan een aantal belangrijke mogelijkheden op een rijtje:
+GitHub zorgt ervoor dat een individueel of een project in teamverband erg overzichtelijk is. Je hebt een goed overzicht van de laatste aanpassingen en welke persoon dat heeft gedaan.
+Je kan eenvoudig meerdere versies maken en eenvoudig terugvallen op een vorige versie, mocht het misgaan. Door de verschillende branches loop je geen enkel risico bij het aanpassen en testen van nieuwe code. Meer over branches in “Betekenissen van GitHub termen”.
+Voor programmeurs maakt GitHub het werken een stuk makkelijker en leuker. Stel dat je als programmeur niet aan versiebeheer zou doen of dat zou doen met een slecht versiebeheersysteem, dan ga je vroeg of laat in de problemen komen.
+GitHub is een centrale plek waar heel veel programmeurs en teams hun projecten beheren. Veel projecten zijn open source en kunnen door iedereen worden ingezien en aangepast.
+Het is erg leerzaam om naar projecten van anderen te kijken. Als je wat meer ervaring hebt, kan je misschien wel verbeteringen voorstellen en meedoen aan gave projecten!
+Met GitHub gaat er als programmeur een wereld voor je open. Het is goed om projecten te beheren en je kan er ook heel veel leren.
+Betekenis van Github termen?
+Op GitHub zijn er een aantal termen die handig zijn om alvast te weten. Als je meer gebruik gaat maken van GitHub, dan leer je de betekenis van deze termen vanzelf kennen.
+Hieronder staan belangrijke GitHub termen en de betekenis ervan:
+GitHub term | +Betekenis | +
---|---|
Repository | +Een repository kan je zien als de hoofdmap van je project. Hierin staan alle bestanden van je project en de historie van wijzigingen die je hebt gedaan. | +
Branch | +Aparte plek binnen je repository, waar je bijvoorbeeld nieuwe code kan testen, zonder dat te hoeven doen op de 'productversie'. | +
Master | +Dit is de hoofdbranch, oftewel de “productversie” van je project. Nieuwe code die is getest en goedgekeurd, wordt samengevoegd met de Master branch. | +
Fork | +Een fork is een kopie van een repository. Hierdoor kan je werken aan een project van iemand anders, zonder het origineel aan te passen. | +
Commit | +Git commando dat veranderingen toevoegt aan je lokale repository. | +
Push | +Git commando om aanpassingen naar je (remote) repository te sturen, die staat op GitHub. | +
Pull | +Git commando om aanpassingen van je (remote) repository naar je lokale bestanden te sturen. | +
Merge | +Git commando om aanpassingen van een branch samen te voegen met een andere branch. Bijvoorbeeld aanpassingen die getest en goedgekeurd zijn in de “Develop” branch samenvoegen met de “Master” branch. | +
Checkout | +Deze Git commando wordt vaak gebruikt om te switchen tussen branches. Je checkt als het ware uit bij een branch en gaat aan de slag in een andere branch. | +
Hopelijk heb je een beter beeld over wat GitHub is. Ben je een gebruiker of wil je programmeur worden en werk je nog niet met een (goed) versiebeheersysteem? Dan is het zeker aan te raden om te beginnen met GitHub.
+Als je een account hebt aangemaakt kun je zelf een repository aanmaken. Zie hiervoor: Aanmaken GitHub Account
+Stuur een mail naar account@geonovum.nl om toegevoegd te worden aan deze repository. Je moet dan wel eerst een account aangemaakt hebben op github
In dit hoofdstuk komen zowel GitHub als GitHub desktop client aan de orde. Geonovum heeft op github een eigen ‘onderkomen’ op: https://github.com/Geonovum. In dit hoofdstuk staat beschreven wat je moet doen om “up-and-running” te komen voor het uitvoeren van je beheertaken op GitHub. Hoe je een account aanmaakt, en hoe je de benodigde software installeert.
+Als je nog geen GitHub account hebt, of als je een apart GitHub account wil maken voor je Geonovum werkzaamheden, ga naar: https://github.com/join/get-started .
+Dan zie je het scherm dat hiernaast staat. Maak in dat scherm een usernaam aan waarmee je op GitHub gaat werken.
+Tip: als je met meerdere accounts gaat werken, zorg er dan voor dat aan de accountnaam kan zien waarvoor die dan gebruikt moet worden. (Bijvoorbeeld door die naam te eindigen op –GNM). Verplicht is dit niet.
+Vul in het veld username je nieuwe GitHub naam in.
+Vul in het veld email adress je geonovum mailadres in
+ +Klik vervolgens op “Create Account” en dan wordt je account aangemaakt.
+Kies in dit scherm je persoonlijke plan. Bij Geonovum gebruiken we de gratis versie, dus selecteer die.
+ +Ga in je internet browser naar https://desktop.github.com/
+Klik daar op download for Windows (64bit).
+Nu wordt de installer gedownload, en dat zie je linksonder in je browser zoals in het plaatje rechts:
++
+Na starten van de installer verschijnt het scherm hiernaast
+Het volgende scherm zal nu openen
+we hebben in de vorige stap al een account aangemaakt dus klik op Sign Into Github.com
+ +Na Klikken op Sign into Github.com, verschijnt dit scherm. Hier hoeft verder niks ingevuld te worden, dus klik op continue.
+In dit scherm kan je desgewenst het vinkje bij het versturen van anonieme data uitzetten. Daarna klikken op Finish.
+GitHub Desktop is nu geïnstalleerd.
+ +GitHub Desktop kan worden aangepast aan persoonlijke voorkeuren. Dat doe je door in het hoofdscherm van de GitHub Desktop op het menu “File” te klikken en vervolgens voor “Opties” te kiezen.
++In het Accounts scherm staat hoe je bent ingelogd bij GitHub. Hier kan je uitloggen en opnieuw inloggen als je meerdere GitHub Accounts hebt.
++In het tabblad “Git” kan je je Github Naam eventueel aanpassen. De GitHub Email is de email die intern binnen Github wordt gebruikt. Die hoeft niet gewijzigd te worden.
++In het tabblad “Appearance” kan je ervoor kiezen om in Light of Dark modus te werken. Hiermee verander je alleen de achtergrondkleur van de GitHub Desktop omgeving.
+ +In dit scherm kan je de voorkeurs editor instellen. Default wordt gekeken naar de reeds aanwezige tekst editors. Omdat GitHub van nature een samenwerkomgeving is voor het ontwikkelen van programmatuur, gaat het hier om “platte tekst” editors.
+Geonovum heeft een eigen GitHub Bedrijfspagina: https://github.com/Geonovum .
+Voor alle projecten die een product maken of beheren wordt een repository aangemaakt.
+Het aanmaken van een repository staat beschreven in paragraaf 2.3.1.
++In de Repository maak je indien nodig submappen aan. Submappen zijn handig als er in je Repository meer dan één ReSpec document komt te staan. Over ReSpec meer in hoofdstuk 3.
+Hiernaast een afbeelding van de GitHub Repository voor MIM. Twee mappen omdat MIM twee documenten bevat.
+Ook maakt GitHub standaard een readme.md aan. De readme staat in het “Markdown” formaat, waarover in de volgende paragraaf meer.
+In de readme.md file staat nog eens beschreven Wat de inhoud van de Repository is. Neem ook de link naar de webversie van de documenten hier op, dan is het voor bezoekers gemakkelijker om het document te openen in een browser.
+Neem altijd een link naar https://docs.geostandaarden.nl/ op, en in het geval het technische documenten betreft zoals UML’s, XSD’s, GML’s, XML’s een link naar http://register.geostandaarden.nl/ in het Readme bestand op.
+ +In deze paragraaf een beschrijving van hoe je in GitHub een nieuwe repository aanmaakt, en hoe je die synchroniseert met je lokale GitHub client.
+Een nieuwe repository maak je aan in de Centrale GitHub omgeving.
+Klik in de banner bovenaan de pagina, naast je profielfoto op “+” en kies “Create Repository”
+Nadat je op “+” hebt geklikt, verschijnt het scherm hieronder.
+ +Vul hier de naam van de repository in. Gebruik een naam die kort en bondig is. Zie ook verderop in dit document voor de naamgevingsconventies.
+Vul ook de beschrijving in van het project.
+Geef als local path de naam van de GitHub map op. GitHub zal dan de naam van de standaard als mapnaam aanmaken onder de lokale GitHub map.
+Het is wel zo netjes om een readme file aan te maken, hierin zet je een korte omschrijving van de repository. Klik vervolgens op “Create Repository”
+Start de GitHub Client, en kies in het menu File voor Clone Repository. En kies de Repository die je wil clonen (in dit geval Geonovum/MIM). Als Local Path kies je een logische plek op je PC/Laptop. (Tip: het is handig om één plek voor je Github Repositories te maken, bijvoorbeeld C:. Na het aanklikken van de knop clone wordt een lokale kopie gemaakt. Github weet welke versie je hebt opgehaald, en zal de wijzingen die je maakt netjes voor je bijhouden.
+In de map die je als local path hebt opgegeven komt de mappen structuur te staan zoals hierboven beschreven.
+Een pull commando werkt de lokale versie van je GitHub Repository bij. Wijzigingen die zijn gedaan in de centrale repository (dus op Github.com) worden ook doorgevoerd in je lokale kopie. Het uitvoeren van een pull doe je door in het menu Repository op pull te klikken.
+NB: Voer dit commando regelmatig uit als er meerdere mensen in de repository werken, om conflicterende wijzigingen te voorkomen.
+Met de knop Commit to master zet je de wijzigingen die je hebt gedaan klaar om te uploaden naar de Centrale GitHub Repository. GitHub maakt daartoe een versie aan,
+die je verplicht voorziet van een summary en optioneel van een Description Let op: met
+het committen heb je dus nog niks ge-upload.
+Nadat je de wijzigingen hebt gecommit, moeten ze richting de centrale repository. Nu zijn er twee mogelijkheden. Ofwel je hebt schrijfrechten op de Centrale Repository, of je hebt ze niet. In het eerste geval kan je een Push Origin uitvoeren, dan worden de wijzigingen meteen in de Centrale GitHub Repository verwerkt. In het tweede geval doe je een Pull request bij de eigenaar van de Repository om de wijzigingen door te voeren. Github maakt dan een eigen versie voor je aan (dat heet een fork) en vraagt aan de eigenaar van de Repository om die fork te verwerken in de Centrale Repository.
+Naast UML-informatiemodellen en begrippenkaders maakt Geonovum wellicht in de toekomst ook meer ontologieën. Momenteel is er één ontologie gepubliceerd: die van NEN 3610. Hier is gedocumenteerd hoe dat is gedaan.
+De ontologie is gegenereerd uit het NEN3610-informatiemodel op basis van de regels in MIM.
+.ttl
) syntax en documentatie van de ontologie in Markdown (.md
) syntax (op te nemen in ReSpec-document) In je UML-project is daarvoor nodig:
+ - tagged value baseURI
op packageniveau
De ontologie is gegenereerd met scripts van Marco Brattinga.
+ - Scripts staan in de repository NEN3610-werkomgeving
+ - Het script dat je moet runnen is: convert.sh
. Dit kun je lokaal doen (onder Windows moet je dit aanroepen in een batch-bestand) of we kunnen dit in een git workflow zetten zodat het script elke keer wordt uitgevoerd als je een EAP-bestand of MIM-XML-bestand pusht. Jesse Bakker heeft dit laatste binnen IMX-Geo gedaan.
+ - Het script genereert met een aantal tussenstappen de uiteindelijke ontologie (RDF-bestand, .ttl
) en een markdown-bestand (.md
) met documentatie, dat je in een ReSpec-document kunt opnemen.
Naast Marco Brattinga hebben Linda, Pano, en Jesse Bakker (Kadaster) kennis van deze scripts.
+De URI (in EA: baseURI
) is de identifier URL van de ontologie. Het is belangrijk dat deze lange tijd stabiel blijft (dus geen projectnaam, organisatienaam, versieinformatie etc. erin opnemen). Samengevat gelden hiervoor de volgende regels:
http://modellen.geostandaarden.nl/def/
/def/
volgt een korte naam #
Voorbeeld: http://modellen.geostandaarden.nl/def/nen3610#
++Note +Waarom geen versie
+Hierover is veel discussie geweest. In de LinkedData-wereld is het de gewoonte om geen versie in de URL te zetten. De belangrijkste reden hiervoor is dat de URI een identificatie is. Als deze per versie zou wijzigen, zou dat eigenlijk betekenen dat het een nieuwe ontologie is en dat alles dat erin staat een nieuwe betekenis heeft. Dit is bijna nooit echt wat je wilt.
+De klasse
+Gebouw
uit NEN3610:2011 is in essentie nog steeds dezelfde als de klasseGebouw
uit NEN3610:2022. Mogelijk is de definitie en daarmee populatie een enigszins veranderd. Dat wil zeggen: misschien zit er tussen beide definities een verschil tussen wat je als een gebouw beschouwt. Maar in essentie bedoel je nog steeds hetzelfde, dus verander je dan niet de identificatie.Een andere reden om geen versie in de URI op te nemen is dat dit voorkomt dat je alle data die de ontologie gebruikt, moet updaten als de URI gewijzigd is vanwege een nieuwe versie van de ontologie.
+
Controleer het gegenereerde .ttl-bestand op correcte syntax met behulp van een online validator.
+De ontologie is gepubliceerd op http://modellen.geostandaarden.nl
+Beheerders, oa Linda en Pano hebben de FTP-toegang hiervan.
+De ontologie is gepubliceerd in vier bestandsformaten:
+ - HTML (.html
)
+ - Turtle (.ttl
)
+ - RDF/XML (.rdf
)
+ - JSON-LD (.json
)
Het .ttl
-bestand is automatisch geconverteerd naar RDF/XML en JSON-LD met behulp van een online conversietool.
De folderstructuur op de webserver is als volgt:
+/
+ index.html
+ .htaccess
+ /def
+ /nen3610
+ /nen36102022
+
+In de root /
staat een bestand index.html
dat de content bevat die je ziet in je browser als je naar http://modellen.geostandaarden.nl
gaat. Dit bestand wordt handmatig beheerd. Het moet worden aangepast als er meer ontologieën bij komen.
In de root /
staat verder een .htaccess
-bestand. Dat is een webserverscript dat ervoor zorgt dat een verzoek om de ontologie, afhankelijk van de client, de webserver het juiste bestandsformaat laat teruggeven. Als een gebruiker met een webbrowser om http://modellen.geostandaarden.nl/def/nen3610#
vraagt, geeft de webserver een html
-bestand terug dat de browser kan tonen en de gebruiker kan lezen. Als een gebruiker met een ontologie-editor vraagt om dezelfde URL, geeft de webserver bijvoorbeeld het .ttl
-bestand terug.
Het .htaccess
-bestand is gemaakt door Linda en Pano en wordt beheerd in github.
De ontologie-bestanden .ttl
, .rdf
en .json
staan in /def
. De ontologie is zowel als bestand met versieloze bestandsnaam en als bestand met versieaanduiding opgeslagen. NEN3610 gebruikt een jaartal, maar semantic versioning is ook toegestaan.
/def
+ nen3610.ttl
+ nen3610.rdf
+ nen3610.json
+ nen3610-2022.ttl
+ nen3610-2022.rdf
+ nen3610-2022.json
+
+De .html
-bestanden staan in twee subfolders, eentje met versieaanduiding en eentje zonder. De versieloze folder bevat altijd dezelfde inhoud als de nieuwste versie.
/nen3610
+ index.html
+ /nen36102022
+ index.html
+
+En pagina over de NEN3610-ontologie is daarnaast ook op Linked Open Vocabularies (LOV) gepubliceerd, een online catalogus van ontologieën. Dit is aangevraagd via een email naar de beheerders via de contactlink. De beheerders controleren de ontologie en geven tips ter verbetering. NEN3610 staat hier.
+Om te zorgen dat de ontologie vindbaar en bruikbaar is, zijn er aanvullende regels. Deze zijn gebaseerd op de regels voor FAIR-ontologieën van Linked Open Vocabularies, de vindplaats van ontologieën waar NEN3610 ook in is opgenomen. Hun regels zijn ook beschreven in een goed leesbare paper. De manier waarop de NEN3610-ontologie is gepubliceerd is hierop gebaseerd.
+De volgende metadata dient te worden opgenomen in de ontologie:
+owl:versionIRI
en owl:versionInfo
license
(CC-BY) creator
, eventueel contributor
, creationDate
en (als die bestaat) previousVersion
prefix
, title
and description
source
: verwijzing naar informatiemodel waar de ontologie op gebaseerd is publisher
: verwijzing naar GeonovumHet wordt aangeraden om de ontologie te vertalen naar het Engels (dit kan in hetzelfde bestand, door verschillende talige labels aan de klassen en eigenschappen te geven). Voor NEN3610 wordt dit overwogen.
+Het is good practice om de ontologie te relateren aan andere ontologieën, met name aan NEN3610, GeoSPARQL, OWL Time, de Semantic Sensor Network Ontology (SSN), NEN 2660 etc. Voor NEN3610 is dit nog niet gedaan. Hiervoor zijn een aantal standaardrelaties beschikbaar, zoals;
+ - equivalentClass
+ - equivalentProperty
+ - subClassOf
+ - subPropertyOf
In Enterprise Architect is het mogelijk om deze relaties aan te geven. De ontologie-generator zet ze dan ook in de ontologie, maar het mechanisme is nog niet gestandaardiseerd in MIM. De Generatie MIM-ontologie is ontwikkeld in het WaU als onderdeel van het IMX-Geo-project. Om aan te geven dat iets uit je model precies hetzelfde is als iets uit een ander model: Tagged value uri
bij klassen, attributen en relaties; gevuld met de URI van de ontologie plus de identifier van de klasse of eigenschap in de ontologie (de MIM naam). Dit wordt vertaald naar equivalentClass
of equivalentProperty
. Om aan te geven dat iets een subklasse of -eigenschap is van een klasse of eigenschap uit een ander model, is er nu nog geen methode.
De attributen domein en identificatie komen uit NEN3610.
+domein
heeft Tagged value:
uri = http: http://modellen.geostandaarden.nl/def/nen3610-2022#domein
+
+identificatie
heeft Tagged value:
uri = http://modellen.geostandaarden.nl/def/nen3610-2022#identificatie
+
++TODO: invullen vanuit de volgende documenten +
+
Imvertor wordt veel gebruikt binnen Geonovum voor het transformeren van UML modellen naar bijvoorbeeld xml-schema’s of feature catalogues. De instructies van hoe er mee om te gaan zijn overal verspreid. Op deze pagina probeer ik alles te verzamelen….
+onderwerp | +verwijzing | +
---|---|
Imvertor-properties | +Uitleg verschillende properties | +
Algemeen | +Verzamelde handleiding van organisaties | +
Algemeen | +Repository coördinatie Imvertor gebruik Geonovum | +
Werkinstructie | +IMGeluid werkinstructie | +
Imvertor meldingen | +Meldingen | +
Uitleg schema mapping | +Hier | +
data
folder. Niet meer gebruikt diagrammen worden nooit verwijderd uit deze folder waardoor er vaak veel niet gebruikt diagrammen in staan. Tip: gooi voor het draaien van Imvertor de data map een keer leeg.Software/Standaard | +Versie | +
---|---|
MIM-standaard | +1.1.1 | +
MIM-toolbox | +1.1.1 | +
Enterprise Architect (EA) | +15.2 | +
Deze handleiding beschrijft hoe je in Enterprise Architect een extensie maakt op de MIM-toolbox. Dit is van toepassing als er extra metamodelconstructies nodig zijn voor het maken van een informatiemodel. Meer informatie en spelregels hiervoor vind je in de MIM-standaard. Een extensie op de MIM-toolbox is ook bedoeld voor het maken van aanvullende constructies die alleen spelen op het niveau van implementatie, of op het niveau van afgeleide technsiche modellen ten behoeve van specifieke interfaces.
+Met een extensie breidt je MIM-toolbox uit. Dit is handig wanneer je extra informatie aan modelonderdelen (bijv. objecttypen) wilt toevoegen. Bijvoorbeeld voor: + - het uitbreiden van de set met metagegevens voor modelonderdelen van een specifiek sector-/domeinmodel (extra tagged values); + - het uitbreiden van de set met metagegevens voor specifieke toepassingen van het model, zoals bijvoorbeeld in Imvertor of voor een UML-JSON-encodings; + - het het toevoegen van extra stereotypen.
+Deze handleiding neemt het maken van een DiSGeo-extensie op MIM als voorbeeld. Voor het informatiemodel DiSGeo zijn voor de MIM-stereotypen «Objecttype»
en «Attribuutsoort»
meta-informatie nodig in de vorm van extra tagged values. Voor Objecttype gaat dat om het toevoegen van Actualiteit
en Inwinning verplicht
. Voor Attribuutsoort zijn dat: Inwinningsregels
en Positionele juistheid
.
Zorg dat je de volgende twee zaken bij de hand hebt: + 1. Enterprise Architect: Het is handig om de volgende venster te openen + - Browser + - Toolbox + - Properties + - Features + 1. De MIM-toolbox waarop je een extensie wilt bouwen, in de vorm van een MDG Technology (.xml). Hier vind je de meest actuele versie van de toolbox
+.xml
-extensie) van de MIM-toolbox.Indien je geen foutmelding krijgt, heb je de MIM-toolbox succesvol geïmporteerd.
+Ctrl+Shift+M
.In de project browser zie dat er nu een nieuwe package DiSGeo is toegevoegd. Dat package bevat een
+ - diagram;
+ - een «profile»
;
+ - een «diagram profile»
;
+ - en een «toolbox profile»
.
Je hebt nu succesvol de package structuur aangemaakt.
+«profile»DISGEO
uitUML::Profile
++Let op: deze zijn alleen beschikbaarbaar nadat je de MIM-toolbox hebt geïmporteerd (zie: stap: 1).
+
«Objecttype»
en «Attribuutsoort»
op, selecteer deze en klik op OK.«Attribuutsoort»
.Attribuutsoort
, maar dit kan elke andere willekeurige naam zijn.++Info: In hoofdstuk 3 van de MIM-standaard staat beschreven van welke UML-metaklasse elk MIM-stereotype is afgeleid. Omdat je een extensie maakt op MIM, is de nieuwe extensie automatisch óók een extensie op een UML-type. Desondanks moet je dit in Enterprise Architect expliciet benoemen.
+
Actualiteit
.«Objecttype»
.Je ziet nu het nieuwe stereotype met de tagged values. Daarnaast heeft het nu een relatie met de UML-metaklasse «Attribute»
. Als laatste onderdeel van deze stap moet nu de relatie gelegd worden tussen het nieuwe stereotype en het MIM-stereotype. Dit gaat als volgt:
Attribuutsoort
.MIM::Attribuutsoort
én UML::Attribute
.«Objecttype»
.Als laatste stap is het handig om het kleurenschema van het modelelement gelijk te maken aan dat van MIM. Dat gaat als volgt:
+Objecttype
. Hue: 128
+ Sat: 245
+ Lum: 230
+ Red: 206
+ Green: 253
+ Blue: 254
+
+zwart
.Attribuutsoort
.Je hebt nu succesvol het profiel van je extensie aangemaakt.
+In deze stap maak je de menupagina van de toolbox. Hiermee bepaal je hoe en welke stereotypes zichtbaar zijn in het menu. Het doel van de DiSGeo-extensie is om bestaande MIM-stereotypen uitbreiden met extra tagged values. Daarvoor introduceerden we in EA onder de moterkap weliswaar twee nieuwe stereotypen («Objectype»
en «Attribuutsoort»
), maar die willen we niet expliciet terugzien in de toolbox. In de toolbox willen we «Objecttype»
en «Attribuutsoort»
aanbieden.
«toolbox profile»DISGEO
.«profile»
DISGEO en selecter «stereotype»Objecttype
en klik op OK.alias
mee te geven (anders heet het toolbox-item DISGEO::Objectype(UML::Class)
. Vanwege het eerder genoemde uitgangspunt, krijgt dit stereotype het alias
'Objecttype'.+ DISGEO::Objecttype(UML::Class)
++ DISGEO::Attribuutsoort(UML::Attribute)
+
+In de MIM-toolbox heeft deze pagina nog drie andere stereotypes. Deze kun je uit het package MIM-UML halen. Deze beschrijving gaat ervan uit dat je hierover beschikt.
+«MIM-UMLprofile»
en voeg de volgende elementen toe:DISGEO::Objecttype(UML::Class)
+DISGEO::Attribuutsoort(UML::Attribute)
++ MIM::Gegevensgroep(UML::Attribute)
++ MIM::Gegevensgroeptype(UML::Class)
++ MIM_Keuzeattribuut::Keuze(UML::Attribute)
+
+Je hebt nu met succes het toolboxmenu gemaakt. Het is in alle gevallen mogelijk om de namen van de stereotypen met de hand op te voeren. De schrijfwijze luistert heel nauw, dus heeft het de voorkeur gebruik te maken van Add Stereotype.
+«Diagram Profile»DISGEO
.Class
.«metaclass» Diagram Logical
en voeg bij Features een nieuw attribuut toe met de naam: toolboxPage
.
+ Vul bij Initial Value de het volgende in:MIM: Objecten en attributen=1;MIM: Relaties=1;MIM: Datatypen=1;MIM: Waardelijsten=1;MIM: Packages=1;UML: Connectors=0;
1
) of ingevouwen (waarde: 0
) zijn.Je hebt nu succesvol een Diagram Profile aangemaakt.
+Je hebt nu succesvol de volgende drie profielen gemaakt:
+ - «profile»DISGEO
+ - «diagram profile»DISGEO
+ - «toolbox profile»DISGEO
In de volgende stap lees je hoe je de profielen publiceert +Volg deze link voor een beschrijving.
+Nadat je elk profiel gepubliceert hebt, 'bundel' je ze in een MDG Technology. +Hoe je dat doet, lees je hier
+Bekijk de meest actuele handleiding voor het gebruik van toolboxen in EA.
Software/Standaard | +Versie | +
---|---|
MIM-standaard | +1.1.1 | +
Enterprise Architect | +15.2 | +
Subversion (SVN) | +1.14.1 | +
Deze handleiding beschrijft het proces voor het genereren van een customized toolbox voor modelleren met Enterprise Architect. Het gaat specifiek in op het maken van de MIM-toolbox. Maar ook voor het genereren customized toolboxen in het algemeen, biedt deze beschrijving een handig overzicht van de benodigde stappen. Een inhoudelijke beschrijving voor het maken van de benodigde profielen, vind je hier (linkOpnemen). De meest actuele versie van MIM kun je hier (linkOpnemen) raadplegen.
+ + +Controleer voordat je (MIM-)profielen gaat genereren eerst de volgende zaken:
+Controleer of je beschikt over alle benodigde bestanden:
+«profile»
, «diagram profile»
en «toolbox profile»
(zie voor meer informatie over ... (linkOpnemenNaarWelkePackagesPubliceren).Het MTS- en CSV-bestand vind je hier (zie ook: onderstaande afbeelding).
+ +Controleer of je beschikt over alle benodigde profielen:
+MIM-UMLprofiel
.«profile» MIM
het element «document» QuickLinker
aanwezig is.++NOTE: Het CSV-bestand van de QuickLinker is een kopie van de informatie die in dit element is opgeslagen. Als je wijzigingen wilt aanbrengen in de QuickLinker, of als er in het model wijzingen zijn doorgevoerd die van invloed zijn op de QuickLinker, kun je die met behulp van het CSV-bestand aanpassen (hier linkOpnemenNaarQuickLinkerMakenOfBewerken lees je hoe dat moet).
+
Indien de profielen al in XML-formaat beschikbaar zijn (zie: (linkOpnemenNaarPackagePublicerenAlsProfiel), klik dan hier (linkOpnemenGenererenToolbox) om de volgende stap over te slaan en direct te beginnen met het genereren van de toolbox.
+Het is handig om een toolbox een versienummer mee te geven. Hiervoor zijn verschillende manieren. Bovendien is het mogelijk om te kiezen hoever je deze nummering doorvoert. Hieronder wordt uitgelegd op welke manier de MIM-toolbox van een versienummer wordt voorzien. Het belangrijkste uitgangspunt is dat het versienummer van de MIM-toolbox correspondeert met het versienummer van de MIM-dataspecificatie.
+Format: MIM<spatie>#.#.#
Voor de MIM-toolbox is besloten om het versienummer op verschillende plekken mee te geven:
+Dit is het officiële versienummer. Als een gebruiker de toolbox importeert, kan dit teruggevonden worden onder Specialize
> Manage Tech
. In het venster dat dan verschijnt zoek je MIM
op in de kolom Technology. In het subvenster rechtsboven vind je het versienummer terug.
De toolbox wordt gegenereerd uit profielen. Deze hebben ook een versienummer. Dit nummer is o.a. terug te vinden in XML-bestand. Omdat er in de loop van de tijd meerdere profielen gemaakt zullen worden, is het verstandig om dit in te vullen. Door dit bij te houden kun je in het XML-bestand van het profiel terugvinden welk profiel aan een bepaalde toolbox ten grondslag ligt.
+Door in het veld Alias
van elk package het versienummer mee te geven kan een gebruiker van de toolbox in één oogopslag in het properties-venster zien met welke versie van de toolbox een modelelement is gemaakt. Dit is vooral handig in het dagelijks gebruik van de toolbox. Ook als je twee (versies van) MIM-modellen wilt vergelijken, geeft dit snel inzicht in de gebruikte MIM-versie.
De toolbox pages krijgen eveneens een versienummer. Hiervoor vouw je het package met het stereotype toolbox profile
uit. Voor elke toolbox page is een element met het stereotype: stereotype
.
Controleer of bij elk element het versienummer klopt.
+ +Hierdoor ziet de gebruiker van de toolbox in één oogopslag met welke versie er gewerkt wordt.
+ +In MIM heeft het diagram geen versienummer. De MIM-dataspecificatie zegt daarom ook niets over een diagram; het is immers een hulpmiddel.
+++LET OP: Indien je ervoor kiest om de naam van het diagram toch aan te passen, dient de nieuwe diagramnaam ook worden doorgevoerd in het Quick Linker-element (
+kolom E
:Diagram Filter
) (lees hier hoe dat werkt).
++NOTE: Tussenkoppen toevoegen
+
MIM-UMLprofiel
.«profile» MIM
).1.1.1
).Let op er zijn twee belangrijke voorwaarden:
+1. De profile name moet overeenkomenm met de naam van het package.
+2. De namen van de packages met de stereotypen «profile»
, «profile diagram»
en «profile toolbox»
moeten exact hetzelfde zijn.
+3. De naam van een package moet overeenkomen met de prefix van een toolbox-element (zie: afbeelding).
++ +Opmerking: Dat er daarnaast packages zijn met een andere naam, maakt niet uit, zoals bijv.
+MIM_Keuzebasis
, zo lang de drie voorgenoemde packages maar hetzelfde zijn.
++Opmerking: Een toolbox-element verwijst naar de het package met het bijbehorende profiel. Als je de packagenaam van een profiel aanpast, verandert de naam van het toolbox-element niet automatisch mee. In de uiteindelijke toolbox zul je dit element dan niet kunnen gebruiken.
+
Doorloop voor het genereren van een toolbox de volgende stappen in de Generate MDG Technology Wizard.
+MIM-UMLprofiel
.++Opm: Het MTS-bestand vult een aantal standaard configuraties vooraf in, maar je kunt deze tijdens het proces nog aanpassen. Dit is een handig bestand. Het kan voorkomen dat je na het genereren van de toolbox aanpassingen wilt maken. Als je na het aanpassen van de gegevens opnieuw de toolbox wilt genereren, is het fijn als je deze gegevens niet opnieuw hoeft in te vullen.
+
Vanuit het MTS-bestand wordt het volgende venster al ingevuld
+ - Technology: MIM
+ - Filename: (kies een naam en locatie)
+ - ID: build + build number (bijv.: build03
)
+ - Version: 1.1.1
++Toelichting +1. Icon en logo: deze velden blijven vooralsnog leeg. +1. URL: link naar corresponderende MIM-documentatie op GitHub/ReSpec. +1. Support: link naar website Geonovum. +1. Notes: Vul in het notes veld kort in wat is er in deze versie nieuw is.
+
Klik 'Volgende'.
+In de volgende stap selecteer je tot slot het toolbox profiel.
+++NOTE: verder uitwerken
+
In ieder geval beschrijven:
+ - CSV-bestand nodig
+ - In Nederlandse versies van OS, is scheidingsteken een puntkomma: ;
+ - Voor Enterprise heb je een komma (,
) nodig als scheidingsteken.
+ - Ook iets zeggen over werken in Excel, kan ook in EAP, maar werkt onoverzichtelijk.
+ - Overigens schijnt er ook een alternatieve (lees:eenvoudigere) methode te zijn vanaf een bepaalde EA-versie (nog uitzoeken!)
++NOTE: verder uitwerken
+
initial value
, maar notes field
als datatype++NOTE: verder uitwerken
+
++NOTE: verder uitwerken
+
«profile»
, «diagram profile»
en «toolbox profile»
moeten dezelfde naam dragen«profile»
zijn. Software/Standaard | +Versie | +
---|---|
MIM-standaard | +1.1.1 | +
MIM-toolbox | +1.1.1, build 5 | +
Enterprise Architect | +15.2 | +
Subversion (SVN) | +1.14.1 | +
MDG_MIM_Toolbox_v1.1.1_build05.xml
.++Note
+
+Hier moet je de keuze maken of je de toolbox op model- of gebruikersniveau importeert. Beide hebben voor- en nadelen: + - Model: alleen te gebruiken binnen één EA-project. Voor elke project moet je apart de toolbox importeren. Indien je dit project met een andere gebruiker deelt, beschikt deze gebruiker ook over de toolbox. Dit is de aanbevolen optie. Dit geeft de minste kans op conflicten. + - User: Je hoeft de toolbox slechts éénmalig te importeren. Vervolgens is de toolbox automatisch beschikbaar voor alle EA-projecten waar je als gebruiker aan werkt. Het nadeel is dat bij het delen van projecten de toolbox niet mee komt. Bovendien kunnen er conflicten tussen toolboxen ontstaan (zie: volgende informatiekader).Warning
+
+Indien binnen jouw EA-omgeving ook een toolbox van een extensie op het MIM aanwezig is (bijvoorbeeld voor de BRO), dan is het raadzaam om de toolboxen alleen op model-niveau te importeren. Indien tenminste één van de twee op user-niveau is geïmporteerd, kan dit bij het toewijzen van stereotypen verwarring opleveren. Veel stereotypen hebben exact dezelfde naam en voor EA is het dan onduidelijk welke MDG Technology het moet kiezen. De bovenstaande aanpak houdt de werkwijze zuiverder.
Version: 1.1.1
.++Warning
+
+De MIM-toolbox heeft een versienummer. Deze staat niet in de naam. Indien je besloten hebt om oudere versies van de MIM-toolbox niet te verwijderen, komt de naam 'MIM' mogelijk meerdere malen voor. Het beheren van toolboxen in Enterprise Architect doe je op deze manier.
In voorgaande versies werd de MIM-toolbox toegepast op een standaard UML diagram (UML::Class
). Dat kan nog steeds. Dit heeft echter één nadelige eigenschap. Als je in je project met meerdere diagrammen werkt, kan het voorkomen dat bij het wisselen tussen diagrammen de toolbox terugspringt op de standaard UML-toolbox. Hierdoor moet je de MIM-toolbox opnieuw opzoeken.
Dit probleem wordt veroorzaakt doordat een diagram en een toolbox aan elkaar gekoppeld zijn. Daarom is in versie 1.1.1 van de MIM-toolbox een speciaal MIM-diagram aangemaakt waaraan de toolbox gekoppeld is. Dit diagram is een directe afgeleide van het standaard 'UML Class diagram'. Hieronder staat uitgelegd hoe je dit kunt toepassen.
+++Warning
+
+Dit kan alleen als je onder model in de Project browser al een package hebt aangemaakt. Als je dat nog niet hebt, maak dan eerst een (nieuw) package aan.
++Note
+
+Het is belangrijk dat je het diagram daadwerkelijk selecteert. Je kunt herkennen of dit gelukt is, doordat in het onderste deelvenster een toelichtende tekst op het diagram verschijnt (anders staat er alleen 'MIM').
+
Het MIM-versienummer komt nu ook terug het veld Stereotype in het venster 'Properties' van het object. + - Maak een objecttype "A" aan. + - Controleer vervolgens in de het venster 'Properties' of in de naam van het stereotype het betreffende MIM-versienummer verschijnt. + - Tevens verschijnt er in dit venster een deelmenu met de titel '«Objecttype» ( from MIM 1.1.1 - Basiselementen )' + - Als dit klopt, is de toolbox correct geïmporteerd.
+ +De Quick Linker is een hulpmiddel om snel en eenvoudig relaties te kunnen leggen tussen verschillende elementen. Het voordeel hiervan is dat het de gebruiker inzicht geeft in de volgens MIM toegestane relaties. De Quick Linker is beschikbaar via een icoontje dat rechtsboven een diagramelement verschijnt op het moment dat je het selecteert.
+ +Je kunt de Quick Linker op drie manieren inzetten, namelijk voor het:
+Hieronder beschrijven we elke methode afzonderlijk.
+«Generalisatie»
.Je kunt ook vanuit een bestaand element een nieuw modelelement creëren. Dat gaat als volgt:
+«Generalisatie»
)Ook is het mogelijk om vanuit een bestaand element meerdere én verschillende soorten modelelementen in één keer te creëren. Dat gaat als volgt:
+Net als alle andere modelelementen uit de MIM-toolbox, kun je ook de «Relatierol»
in het diagram slepen. Je doet dit door een «Relatierol»
naar uiteinde van een reeds bestaande «Relatiesoort»
te slepen. Wanneer je in EA het stereotype «Relatierol»
toewijst aan een relatie, worden de bijbehorende 'Tagged Values' automatisch meegenomen.
++Note
+
+In eerdere versies van de MIM1.1.1-toolbox ontbraken de Tagged Values bij de«Relatierol»
na toewijzing. Dit is opgelost in build 5:MDG_MIM_Toolbox_v1.1.1_build05
.
«Relatiesoort»
, kun je de «Relatierol»
aan de target end (of de source end) toevoegen door middel van het toolbox-item «Relatierol»
.«Relatierol»
en sleep het item met de muisknop ingedrukt naar de target end van de associatie en laat hier de muisknop weer los.«Relatierol»
in en klik op 'Ok'.Er zijn verschillende situaties denkbaar waarin je één of meerdere type modelelementen van een informatiemodel wilt updaten. Bijvoorbeeld omdat er een bug-fix is geweest. Zoals hierboven beschreven, kreeg een «Relatierol»
in de eerste versies van de MIM1.1.1-toolbox (build01-build04) geen Tagged Values mee. Maar het kan ook zijn dat je alle modelelementen in een model naar de nieuwste versie van toolbox wilt updaten. Hiervoor moet je het stereotype (het modelelement) synchroniseren. De volgende stappen beschrijven hoe dat werkt.
Verwijder de oude toolbox eerst en importeer vervolgens de nieuwe versie. Doorloop daarna de volgende stappen. Hieronder gebruiken we het updaten van «Relatierol»
als voorbeeld, maar je kunt dit voor elk gewenst modelelement uit de toolbox toepassen.
Relatierol
en klik hier met de rechtermuisknop op.Relatierol
al geselecteerd.Herhaal bovenstaande stappen als je ook andere modelelementen wilt updaten.
+Deze instructie is bedoeld voor het verwijderen van toolboxen die je niet meer wilt gebruiken. Bijvoorbeeld oudere versies van de MIM-toolbox.
+Controleer nu of er onder 'Model Technologies' en/of 'User Technologies' toolboxen staan die je niet meer wilt gebruiken.
+++Warning
+
+Indien je toolboxen gebruikt met gelijknamige modelelementen, bijvoorbeeld oudere MIM-toolboxen of NEN3610 BRO Grouping-NL (dat een extensie is op MIM), dan kan dit leiden tot een verwijzing naar het 'verkeerde' profiel. Enterprise Architect doet dit automatisch. Hierdoor beschikt het stereotype bijvoorbeeld niet over de gewenste tagged values.
++Note
+
+Onderstaande tekst is nog in conceptWarning
+
+Dit onderwerp hoort niet in deze handleiding thuis, maar in handleiding over EA. Het kan wel handig zijn om vanuit deze handleiding ernaar te verwijzen.
Ga allereerst naar +Klik rechtsboven op Portals en selecteer Windows.
+De meeste vensters uit 8.1 vind je terug in de volgende deelmenu's:
+Explore + - Project Browser + - Resources
+Properties + - Properties + - Notes + - Tagged Values + - Features
+Diagram + - Pan & Zoom
+Trace + - Relationships + - Relationship Matrix
+Het venster Toolbox vind je in de taakbalk bovenin. Ga naar:
+Design > Diagram > Toolbox (Ctrl
+Shift
+3
)
+Note +To do: tekst schrijven
+
Voor het extern publiceren van documenten en standaarden gebruiken we +ReSpec. Deze tool ondersteunt naast HTML en Javascript ook Markdown
+Markdown is een lichtgewicht +opmaaktaal op basis van platte tekst die zodanig ontworpen is dat het +gemakkelijk valt te converteren naar HTML en andere. Markdown wordt vaak +gebruikt voor de opmaak van project documentatie (README-bestanden), eenvoudige +CMS-systemen en berichten in online fora. Je kunt Markdown in iedere simpele +teksteditor bewerken.
+Het ontwerpdoel van de taal is leesbaarheid. Teksten geschreven met behulp van +Markdown worden geacht al leesbaar te zijn voordat opmaak is toegepast op de +tekst. Opmaakinstructies en tags zijn dan ook niet te vinden in pure Markdown.
+Sommige browsers weigeren het openen van lokale bestanden, of negeren links naar +locale bestanden. Dit kun je in de configuratie aanpassen:
+Je moet twee dingen instellen:
+--disable-web-security
Dit kan je ook in een snelkoppeling zetten als icoon op de desktop.
+In Firefox kan je dat instellen via de parameters.
+security.fileuri.strict_origin_policy = false
(dus op false zetten)tool | +omschrijving | +
---|---|
Markdown Tutorial | +Handleiding Markdown | +
Markdown Reference | +Naslag Markdown | +
Visual Studio Code | +Fijne teksteditor die ook goed integreert met Github Desktop | +
PowerToys | +Geeft preview van Markdown rechtstreeks in Windows Explorer (en nog heeel veel andere tooltjes) | +
Tables Generator | +Helpt met het maken van tabellen in MarkDown | +
Markdown Table | +VSCode plugin voor het editen van Markdown tabellen. | +
Prettier | +Een code formatter die automatisch zorgt dat je markdown aan de regels voldoet. | +
markdownlint | +Een style checker form markdown bestanden. Geeft meldingen voor verkeerde markdown | +
Live Server | +VSCode plugin. Klik rechtsonder op "Go Live" en je ReSpec doc wordt in live browser geopend. | +
Styling regels vastleggen voor Markdown zorgt ervoor dat wijzigingen in de markdown ook +altijd inhoudelijke wijzigingen zijn. Suggesties hiervoor
+Deze afspraken kunnen we ook vastleggen. Zie hieronder twee voorbeelden. Het lijkt +erop dat de veschillende tools op verschillende manier formatteren. Niet alles +gaat goed samen.
+Voorbeeld van '.prettierrc' gebruikt in dit project:
+{
+ "printWidth": 80,
+ "tabWidth": 2,
+ "useTabs": false,
+ "singleQuote": true,
+ "endOfLine": "lf",
+ "proseWrap": "always"
+}
+
+Voorbeeld van .markdownlinkt.json
:
{
+ "default": true,
+ "MD003": { "style": "atx" },
+ "MD007": { "indent": 4 },
+ "MD013": { "line_length": 80, "code_blocks": false, "heading_line_length": 200, "tables": false},
+ "no-hard-tabs": false
+}
+
Veel documenten die we bij Geonovum publiceren zijn datatspecificaties. In de tekst gebruik je daarom regelmatig stukken code. Het kan gaan om bepaalde termen of gegevens, waarover je iets in de lopende tekst wilt zeggen (inline code), of over langere stukken code (code block). +Deze handleiding is specifiek bedoeld voor de toepassing van code in documentantatie over informatiemodellen. Voor andere type code staat het je vrij hoe je dit toepast.
+Wanneer je in een lopende tekst een term of gegeven wilt markeren als code, pas je inline code toe. Door een term of gegeven als code
te markeren, maak je duidelijk dat het woord een specifieke technische betekenis heeft. Inline code pas je toe door tekst tussen backticks (`
) te plaatsen. De standaardopmaak voor inline code is sober: ReSpec zet het lettertype enkel om in een monospace font. Voor een duidelijkere opmaak van inline code, is daarom een css-bestand beschikbaar. De schrijfwijze van metaklassenamen, modelelementnamen of gegevens volgt de naamgevingsconventies van het MIM. Wees hierop alert als je inline code toepast in handgeschreven teksten.
Pas deze notatie toe als je een modelelement (in UML: stereotype) uit een metamodel opneemt in de lopende tekst. Geonovum past het metamodel informatiemodellering (MIM) toe, maar de onderstaande richtlijn kan ook toegepast worden op modelelementen uit een ander metamodel. Enkele voorbeelden van modelelementen uit het MIM zijn:
+«Objecttype»
«Attribuutsoort»
«Relatiesoort»
Plaats voor deze notatiewijze naam van de metaklasse tussen twee dubbele guillemets «
, »
. Je vindt ze met de volgende toetsencombinaties:
«
= "alt"
+ "["
»
= "alt"
+ "]"
In het markdown-bestand neem je een metaklassenaam als volgt op:
+`«metaklassenaam»`
.
Pas deze notatie toe als je de naam van een modelelement van een informatiemodel opneemt in de lopende tekst. Het gaat dan bijvoorbeeld om de naam van een «Objecttype»
of «Attribuutsoort»
in een specifiek domeinmodel, zoals bijvoorbeeld:
Pand
(«Objecttype»
)Persoon
(«Objecttype»
)naam
(«Attribuutsoort»
)geboortedatum
(«Attribuutsoort»
)geometrie
(«Attribuutsoort»
)VlakOfMultivlak
(«Keuze»
)In het markdown-bestand neem je een metaklassenaam als volgt op:
+`modelelementnaam`
.
Pas deze notitie toe als je een feitelijk of fictief gegeven opneemt in de lopende tekst. Het gaat om concrete waarden zoals die in een registratie (kunnen) voorkomen, zoals:
+"Jan"
"01-01-1970"
"234.5"
"[125.6, 10.1]"
Specifiek in de context van het MIM, gaat het om waarden die ingevuld (kunnen) worden bij de volgende modelelementen:
+«Attribuutsoort»
«Gegevensgroeptype»
«Relatiesoort»
«Relatieklasse»
«Data-element»
«Referentie-element»
«Enumeratie-waarde»
In het markdown-bestand neem je een metaklassenaam als volgt op:
+`"gegeven"`
.
Stel je wilt in een tekst de volgende zin opnemen:
+++Het model bevat een objecttype persoon met een attribuutsoort naam met het gegeven: Jan én een attribuutsoort geboortedatum met het gegeven: "01-01-1970".
+
Dan ziet die zin er, na toepassing van bovenstaande richtlijnen er als volgt uit:
+++Het model bevat een
+«Objecttype»
Persoon
met een«Attribuutsoort»
naam
met het gegeven:"Jan"
én een«Attribuutsoort»
geboortedatum
met het gegeven:"01-01-1970"
.
Uitgeplitst naar inlinecodetype, levert dat het volgende overzicht op:
+«Objecttype»
«Attribuutsoort»
Persoon
naam
geboortedatum
"Jan"
"01-01-1970"
Als je een stuk code hebt dat uit meerdere regels bestaat, kun je dit in een code block plaatsen. Hiermee scheidt je de code van de lopende tekst in een apart tekstblok. In het markdown-bestand neem je een stuk code dat uit meerdere regels bestaat als volgt op. Plaats de code tussen drie backticks (```
). Geef optioneel direct achter de eerste drie backticks de (programmeer-)taal op voor syntax highlighting, zoals in het volgende voorbeeld.
```json +{ + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [125.6, 10.1] + }, + "properties": { + "name": "Dinagat Islands" + } +} +```+ +
{
+ "type": "Feature",
+ "geometry": {
+ "type": "Point",
+ "coordinates": [125.6, 10.1]
+ },
+ "properties": {
+ "name": "Dinagat Islands"
+ }
+}
+
++Note +In dit stuk afbeeldingen opnemen waarin je het resultaat in ReSpec kunt zien. Daarvoor graag NL-ReSpec-GN-template aanvullen.
+
Een belangrijk onderdeel van een dataspecificatie is de definitie van begrippen. Steeds vaker leggen we bij Geonovum begrippen vast in een begrippenkader. 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.
+De meeste begrippen in een dataspecificatie worden gedefinieerd in het hoofdstuk Gegevensdefinitie. Imvertor genereert dit hoofdstuk automatisch op basis van het model in EA. Deze beschrijving richt zich alleen op de hoofdstukken die met de hand geschreven worden.
+De beschrijving in de handleiding van ReSpec is heel summier. Hierdoor pas je het snel en eenvoudig toe, maar het leidt niet vanzelfsprekend tot éénduidig gebruik. Er zijn namelijk verschillende manieren waarop je als gebruiker een begrip met definitie kunt opnemen:
+Binnen Geonovum willen we dit meer kaderen. Daarnaast hebben we aanvullende eisen ten aanzien van de weergave.
+++Warning +Blokweergave en 'normale' weergave niet door elkaar gebruiken. Als je het script gebruikt gaat dat niet goed. Dat kan aangepast worden, maar het is bovenal niet wenselijk om verschillende stijlen in één document toe te passen.
+
ReSpec toont een gedefinieerd begrip door de term schuin en dikgedrukt weer te geven. Deze styling is niet voor elk doeleinde geschikt. Voor inline- en lijstweergave werkt dit prima, maar als losse regel weer niet. Daar mist styling. Toch is dat soms wenselijk, zoals in het MIM-document. Hiervoor is een aanvulling gemaakt op ReSpec, die je kunt gebruikern door [nog invullen
].
<dfn>boek</dfn>een samengebonden of genaaid aantal bedrukte bladen.
+
+Wil je naar een gedefinineerd begrip verwijzen gaat dat zo: <a>boek</a>`` of
[=boek-]`
wrap een definitie in een aside met attribute class="definition"
+<aside class="definition">
+ <dfn>papier</dfn>stof om te beschrijven of bedrukken, uit vezelachtige
+ stoffen, hout, lompen, stro enz. vervaardigd
+</aside>
+
+[afbeelding opnemen
]
++ + +Warning +Een begrip mag maar één keer voorkomen; je kunt een term niet op twee verschillende manieren definiëren.
+
++Warning +Hier graag zoveel mogelijk één lijn in trekken. Graag voorbeelden van hoe dat in huidige documenten zit.
+
Als je op andere plekken in je document wilt verwijzen naar een gedefinieerd begrip, dan kan dat eenvoudig door het begrip tussen <a></a>
te zetten, bijv: <a>boek</a>
. Houd als richtlijn dat je alleen de eerste keer dat een term in een alinea voorkomt een verwijzing maakt. Dit voorkomt een overdaad aan verwijzingen in de tekst. Een verwijzing naar een term werkt in alle gevallen hetzelfde.
Binnen Geonovum gebruiken we ReSpec voor het maken van standaarden. ReSpec maakt +gebruik van input bestanden om HTML te genereren. Deze inputbestanden (de +content) wordt gemaakt in het Markdown formaat. Deze Markdown bestanden kunnen +worden aangemaakt met text editor. GitHub wordt gebruikt als de 'repository' +waarin alle bestanden die bij een standaard horen, beheerd worden.
+Deze handleiding beschrijft hoe je een GitHub Account maakt, hoe je GitHub +Desktop Client installeert en gebruikt, hoe je een Respec mappenstructuur +opbouwt, welke bestanden er nodig zijn voor een standaard, en hoe je de +verschillende versies van een standaard genereert. Ook wordt uitgelegd hoe je de +Markdown plugin in Microsoft Word installeert en gebruikt.
+ReSpec is een tool van W3C die het schrijven van specifications makkelijker +maakt. ReSpec zorgt voor een uniforme styling in het document, onderhoudt +referenties en verwijzingen naar andere documentatie, verzorgt de inhoudsopgave, +zorgt voor links naar vorige en meest recente versies, en heeft een integratie +met Github issues.
+Geonovum gebruikt een fork van ReSpec die door Logius beheerd wordt. Dit +document bevat een globale instructie over hoe snel aan de start te gaan. Meer +documentatie is op andere plaatsen te vinden:
+ReSpec documenten worden beheerd in een GitHub repository. Als je een +nieuw ReSpec document wilt maken gebruik dan de +Geonovum ReSpec template +als startpunt en druk op de 'Use this template' knop om een nieuw repository aan +te maken.
+Zoek in dit repository op de tekst 'TODO' om de plaatsen te vinden waar +aanpassen van de template vereist is.
+ReSpec documenten worden gepubliceerd op +docs.geostandaarden.nl. Iedere gepubliceerde +versie van een document heeft een eigen URL. Voor de laatst gepubliceerde versie +is een aparte URL.
+De URL van iedere publicatie wordt als volgt bepaald:
+https://docs.geostandaarden.nl/[pubdomain]/[specStatus]-[spectype]-[shortName]-[publishDate]/
+
+De laatst gepubliceerde versie is OOK te vinden op:
+https://docs.geostandaarden.nl/[pubdomain]/[shortName]/
+
+De namen van de variabelen staan verderop uitgelegd.
+Dit levert een nieuw repository op met de onderstaande mappenstructuur.
+hoofdmap | +map | +file | +omschrijving | +
---|---|---|---|
Hoofdmap | ++ | + | naam van de hoofdmap | +
+ | media | ++ | Map met mediabestanden | +
+ | + | Style.css | +File met vaste naam, bevat de styling van het document | +
+ | + | *.png | +Afbeeldingsbestanden | +
+ | index.html | ++ | File met de vaste naam Index.html |
+
+ | js | ++ | + |
+ | + | config.js | +File met de vaste naam config.js |
+
+ | *md | ++ | Tekstbestanden (Markdown) die de content bevatten | +
Hieronder staat een voorbeeld van zo’n mappenstructuur.
+ +Het bestand index.html zorgt ervoor dat het ReSpec document automatisch wordt +geladen in de browser. Bij het laden wordt ook automatisch de +geonovum-ReSpec-code geladen en uitgevoerd. Deze code zorgt ervoor dat het +document zijn standaard layout krijgt.
+Het bestand 'index.html' heeft een vaste indeling. Hieronder de structuur uit de +template:
+<!DOCTYPE html>
+<html lang="nl">
+ <head>
+ <meta content="text/html; charset=utf-8" http-equiv="content-type" />
+ <meta
+ name="viewport"
+ content="width=device-width, initial-scale=1, shrink-to-fit=no"
+ />
+ <script
+ src="https://cdn.jsdelivr.net/gh/digitalbazaar/respec-mermaid@1.0.1/dist/main.js"
+ class="remove"
+ ></script>
+ <script
+ src="https://tools.geostandaarden.nl/respec/config/geonovum-config.js"
+ class="remove"
+ ></script>
+ <script src="js/config.js" class="remove"></script>
+ <script class="remove">
+ respecConfig = { ...organisationConfig, ...respecConfig };
+ </script>
+ <script>
+ document.title = respecConfig.title;
+ </script>
+ <title>TODO: Vul hier de titel in</title>
+ <link
+ rel="shortcut icon"
+ type="image/x-icon"
+ href="https://tools.geostandaarden.nl/respec/style/logos/Geonovum.ico"
+ />
+ <script
+ src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js"
+ class="remove"
+ async
+ ></script>
+ </head>
+
+ <body>
+ <section
+ id="abstract"
+ data-include-format="markdown"
+ data-include="abstract.md"
+ ></section>
+ <section id="sotd"></section>
+ <!-- Wordt automatisch gevuld -->
+
+ <!-- TODO: voeg hier je eigen hoofdstukken toe -->
+ <section
+ data-include-format="markdown"
+ data-include="ch01.md"
+ class="informative"
+ ></section>
+ <section
+ data-include-format="markdown"
+ data-include="ch02.md"
+ ></section>
+ <section
+ data-include-format="markdown"
+ data-include="mermaid.md"
+ ></section>
+
+ <section id="conformance"></section>
+ <section id="tof"></section>
+ <section id="index"></section>
+ </body>
+</html>
+
+In de HTML-header wordt de js-ReSpec bibliotheek geladen. Het enige dat in de +header mag worden aangepast is de title (tussen \<title> en \</title>. Andere +aanpassingen die nodig zijn in de header mogen alleen worden gedaan in overleg +met de ReSpec beheerders. Een overzicht van de ReSpec beheerders staat in +Hoofdstuk 6
+In de HTML-Body geldt vrijheid in gebondenheid De <div>
en/of <section>
+regels mogen worden gekopieerd en toegevoegd. Wel belangrijk om de structuur
+over te nemen, dus als volgt:
<div id='H00' data-format='Markdown' data-include="ToCoVo.md"></div>
+
+<section id='H01' data-format='Markdown' data-include="H1-Inleiding.md"\>\<h2\>Inleiding\</h2\>\</section\>
+
+Een <div>
is een sectie plus bijbehorend document, dat niet in de
+inhoudsopgave terechtkomt. Deze gebruik je bijvoorbeeld voor een Toelichting,
+een Colofon of een Voorwoord.
Een <section>
komt wél in de inhoudsopgave terecht. Deze heeft daarom behalve
+de data-include van het document, ook (verplicht!) een <h2>
tag. De tekst
+tussen <h2>
en </h2>
komt in de inhoudsopgave te staan.
In config.js wordt een stuurvariabele voor ReSpec gevuld. De waarden in deze +variabele worden door ReSpec gebruikt om de layout te bepalen, en bevatten een +aantal document-eigenschappen.
+De SpecStatus in de configuratie geeft de keuze uit 4 waarden, deze waarden zijn +vastgesteld, en mogen niet zomaar uitgebreid of aangepast worden. Elke status +hoort bij een formele fase van een ReSpec document. Zie ook de Geonovum ReSpec +wiki.
+Het SpecType in de configuratie is een vaste lijst met waarden, deze waarden +zijn vastgesteld, en mogen niet zonder overleg met de Technische ReSpec +beheerders uitgebreid of aangepast worden.
+Onderstaande beschrijvingen komen uit het generiek
+beheerplan[5] Zie:
+https://www.geonovum.nl/uploads/documents/Geonovum%20GENERIEK%20Beheerplan%20geo-standaarden%20v1.1.pdf
+
.
NO Norm: Een norm is bij een officieel standaardisatie instituut + ondergebracht en bevat bindende afspraken. Naast het gebruik van normen is + NEN 3610 de enige norm waar Geonovum een inhoudelijke verantwoordelijkheid + heeft. Het formele beheer en beslissingen worden genomen in de NEN + normcommissie 351 240 waar Geonovum de voorzitter van is.
+ST Standaard: Een document met (bindende) afspraken.
+IM Informatiemodel: Een standaard waarbij door de term informatiemodel + te hanteren wordt aangegeven dat het een abstractie (het model) vormt van de + werkelijkheid zoals beschreven binnen een bepaalde sector/domein. + Informatiemodellen zijn een semantische invulling van normen voor sectoren + zoals ruimtelijke ordening, kabels en leidingen, water, etc..
+PR Praktijkrichtlijn: Praktijkrichtlijnen zijn producten die informatie + geven, vaak met een technisch karakter, die nodig is voor het toepassen van + standaarden. Een praktijkrichtlijn hoort altijd bij een standaard/norm.
+HR Handreiking: Op zichzelf staande documentatie dat als doel heeft een + hulpmiddel te zijn, niet verplichtend maar ondersteunend.
+WA Werkafspraak: Legt uit hoe wetgeving moet worden toegepast bij + onduidelijkheden, discrepanties of fouten in de standaarden.
+BD Beheerdocumentatie: Documentatie met betrekking tot het beheerproces + van de standaard. Deze documentatie betreft niet een standaard of onderdeel + daarvan, zoals een handreiking of werkafspraak.
+AL Algemeen: Op zichzelf staande algemene documentatie over standaarden. + De documentatie betreft niet een specifieke standaard of onderdeel daarvan, + het is ook geen beheerdocumentatie van een specifieke standaard.
+pubDomain bepaalt bij publicatie een deel van de URL waarop het document wordt +gepubliceerd. Het zorgt voor een groepering van de documenten op +docs.geostandaarden.nl Omdat je de URL van gepubliceerde documenten niet wilt +veranderen is moet je hier goed over nadenken en alleen in overleg nieuwe +toevoegen.
+De actuele lijst van pubDomains staat in de tabel hieronder. De herkomst van +deze lijst is als volgt:
+Naamgevinsregels voor pubDomain:
+Pubdomain | +Omschrijving | +Herkomst | +status | +GitHub Team | +Beslissing | +
---|---|---|---|---|---|
3dbv | +3D basisvoorziening | +docs.geostandaarden.nl | +inactief (gemigreerd) | ++ | mag niet meer gebruikt worden | +
api | +Kennisplatform APIs | +respec utils | ++ | API team | +OK | +
basisgeometrie | +Informatiemodel Basisgeometrie | +register.geostandaarden.nl | +zit op docs bij nen3610 | ++ | niet gebruiken eigenlijk xsd redirecten | +
bgt | +Basisregistratie grootschalige topografie | +docs.geostandaarden.nl | ++ | BGT team | +Arnoud vragen | +
brt | +Informatiemodellen Basisregistratie Topografie | +register.geostandaarden.nl | ++ | BRT team | +OK | +
crs | +Coördinaatreferentiesystemen | +docs.geostandaarden.nl | ++ | CRS team | +OK | +
cvgg | +Informatiemodel Geluid | +docs.geostandaarden.nl | +duplicaat van img | ++ | OK | +
disgeo | +DisGeo | +respec utils | ++ | + | OK | +
dsgo | +Digitaal Stelsel Gebouwde Omgeving | +docs.geostandaarden.nl | ++ | + | OK (rare uri) | +
dso | +Digitaal Stelsel Omgevingswet | +respec utils | +duplicaten: tpod imow ow | +DSO team | +OK | +
eu | ++ | docs.geostandaarden.nl | ++ | EU team | +OK (rare uri en werkversie weg) | +
g4w | ++ | docs.geostandaarden.nl | ++ | + | groeperen? | +
gbd | ++ | docs.geostandaarden.nl | ++ | + | groeperen? | +
geobag | ++ | docs.geostandaarden.nl | ++ | + | OK | +
gsw | ++ | docs.geostandaarden.nl | ++ | + | groeperen? | +
imaer | +Informatiemodel AERIUS | +register.geostandaarden.nl | ++ | + | OK | +
imev | +Informatiemodel Externe Veiligheid | +docs.geostandaarden.nl | ++ | IMEV team | +OK | +
img | +Informatiemodel Geluid | +respec utils | +duplicaat: cvgg | +IMG team | +redirecten naar cvgg | +
imgeo | +Informatiemodel Grootschalige Geografie | +docs.geostandaarden.nl | ++ | + | Arnoud vragen | +
imka | +Informatiemodel Klimaatadaptatie | +docs.geostandaarden.nl | ++ | + | OK | +
imkad | +Informatiemodel Kadaster | +register.geostandaarden.nl | ++ | IMKA team | +OK | +
imkl | +Informatiemodel Kabels en Leidingen | +register.geostandaarden.nl | +duplicaat: kl | +IMKL team | +Zou kl moeten worden | +
imle | ++ | docs.geostandaarden.nl | ++ | + | OK (niet netjes gepubliceerd) | +
imro | +Informatiemodel Ruimtelijke Ordening | +register.geostandaarden.nl | +duplicaat: ro | ++ | liefst naar RO | +
imow | +Informatiemodel Omgevingswet | +register.geostandaarden.nl | +duplicaten: tpod ow dso | ++ | liefst weg | +
kl | +IMKL | +respec utils | +duplicaat: imkl | ++ | OK | +
md | +Metadata | +respec utils | +duplicaat: metadata | ++ | OK | +
mim | +Metamodel Informatie Modellering (MIM | +respec utils | ++ | + | OK | +
metadata | +Nederlandse metadata profielen voor datasets en services | +register.geostandaarden.nl | +duplicaat: md | ++ | verplaatsen naar md?? | +
nen3610 | +NEN3610-Linkeddata | +respec utils | ++ | + | OK | +
ngii | ++ | docs.geostandaarden.nl | ++ | + | OK | +
oov | ++ | docs.geostandaarden.nl | ++ | + | OK | +
ow | +Standaarden omgevingswet | +respec utils | +duplicaten: tpod imow dso | ++ | OK | +
ro | +RO Standaarden | +respec utils | +duplicaat: imro | ++ | OK | +
rwgs | +Raamwerk van Geo-standaarden | +respec utils | ++ | + | groeperen? | +
serv | +Services | +respec utils | ++ | + | groeperen? | +
tpod | +Toepassingsprofiel omgevingsdocumenten | +respec utils | +duplicaten: ow imow dso | ++ | OK | +
vg | +Informatiemodel Vastgoedgebruik | +respec utils | ++ | + | OK | +
visu | +Visualisatie | +respec utils | ++ | + | groeperen? | +
vtm | ++ | docs.geostandaarden.nl | +is eigenlijk metadata | ++ | verhuizen naar MD | +
wp | +Whitepaper Geostandaarden | +respec utils | +ook een raar pubdomain | ++ | verhuizen naar ngii | +
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/ van ReSpec zelf te kijken. Pas als je een +verwijzing niet vindt in SpecRef voeg je hem hier toe!
+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]]
let respecConfig = {
+ useLogo: true,
+ useLabel: true,
+ // title is verplicht! Neem hier de titel van het document op ----------------------
+ title: "[Neem titel op in config.js]",
+ //-- specStatus is verplicht! (activeer 1 van de volgende) --------------------------
+ specStatus: "wv", // Werkversie
+
+ //-- specType is verplicht bij alle andere dan BASIS ---------------------------------
+ specType: "HR", // HandReiking
+
+ //-- pubDomain is verplicht! (komt in de URL) -------------------------------------
+ pubDomain: "TODO",
+ //-- license: voor de geldende gebruiksvoorwaarden. Default is cc-by.
+ //licence: "cc-by-nd", // bronvermelding, geen afgeleide werken (default)
+ //licence: "cc0", // Public Domain Dedication
+ licence: "cc-by", // Attribution, met bronvermelding
+ //-- shortName is verplicht! (komt in de URL: kies logische afkorting)--------------
+ shortName: "NL-ReSpec-GN-template",
+ //-- publishDate is verplicht -------------------------------------------------------
+ //-- NB: in de werkversie uitzetten, want dan pakt Respec de pushdate ---------------
+ //publishDate: "2023-03-28",
+ //eventueel is het mogelijk een versienummer mee te geven, maar bij Geonovum werken we gewoonlijk alleen met datum als onderdeel van de permanente URI.
+ //publishVersion: "0.0.2",
+ //previousVersion: "0.0.1",
+ //-- Voor dit blok geldt: alleen als er eerdere versies zijn en altijd beiden aan/uit!
+ //previousPublishDate: "2014-05-01",
+ //previousMaturity: "CV",
+ //-- de namen van de Editor(s) / Redacteur(en)---------------------------------------
+ //-- vul in: per Editor: name:, company:, companyURL: -------------------------------
+ editors:
+ [
+ {
+ name: "voornaam achternaam",
+ company: "Geonovum",
+ companyURL: "https://www.geonovum.nl",
+ }
+ ],
+ //-- de namen van de auteur(s) ------------------------------------------------------
+ //-- vul in: per auteur: name:, company:, companyURL: -------------------------------
+ authors:
+ [
+ {
+ name: "voornaam achternaam",
+ company: "Geonovum",
+ companyURL: "https://www.geonovum.nl",
+ }
+ ],
+ //neem hier de URL van de github repository op waar het respec document in staat
+ github: "https://github.com/Geonovum/NL-ReSpec-GN-template",
+ // Create PDF and link to file in header (optional):
+ alternateFormats: [
+ {
+ label: "pdf",
+ uri: "template.pdf",
+ },
+ ],
+};
+
+De file config.js is een stukje javascript (JSON) code, het bevat alle mogelijke +waarden voor de verschillende versies die wij hanteren bij Geonovum. In de file +zelf staat aangegeven welke waarden verplicht zijn, en uit welke waarden te +kiezen is. In bovenstaand voorbeeld gaat het om een 'Werkversie van een +standaard'.
+De 'echte' content wordt gemaakt in het formaat 'Markdown'. Er is een aantal +editors beschikbaar die dat formaat ondersteunen. Zie hiervoor +Hoofdstuk 3. Het is handig om voor elk hoofdstuk +een aparte Markdown file te maken, want dan blijven de bestanden beperkt in +grootte, en zijn er gemakkelijker werkafspraken te maken over wie wanneer in +welke file aan het editen is.
+Afbeeldingen worden als '.png' of '.svg' bestand neergezet in de map 'media'. In +je Markdown document neem je gewoon een plaatje op zoals je in Word gewend bent. +Writage en ReSpec zorgen ervoor dat de plaatjes worden getoond.
+De knop 'ReSpec' rechtsboven in de frontend van ReSpec, bevat een aantal handige +functies. Als je klikt op de knop, verschijnt het vervolgscherm met een viertal +functies.
+Elk van de functies wordt hieronder uitgelegd.
+ ++
De gevonden zoekresultaten kunnen worden overgenomen in het ReSpec document.
+Zie: definitielijst maken
+Omdat wij ervoor hebben gekozen om documenten te schrijven in Markdown, +gebruiken wij niet alle ReSpec functionaliteit. In dit hoofdstuk worden de +speciale ReSpec functies beschreven die als HTML code in het Markdown document +kunnen wordnen opgenomen, of die in de door respec gegenereerde HTML file kunnen +worden neergezet. Het gebruik van deze functionaliteit vereist dus wel HTML +kennis.
+Een lijst van afbeeldingen kan door ReSpec automatisch worden gegenereerd, maar +dan moet er wel aan een aantal ReSpec specifieke voorwaarden worden voldaan:
+In Index.html komt ergens te staan:
+<figure id="flowchart">
+ <img src="flowchart.svg" alt="">
+ <figcaption>The water flows from bucket A to bucket B.</figcaption>
+</figure>
+
+In de documenten worden de afbeeldingen op de volgende manier neergezet:
+<figure id="flowchart">
+ <img src="flowchart.svg" alt="">
+ <figcaption>The water flows from bucket A to bucket B.</figcaption>
+</figure>
+
+NB: <figure>
inclusief uniek ID en een ge-embedde <figcaption>
zijn
+verplicht!
Eventuele referenties naar plaatjes doe je op e volgende manier:
+<p>The flowchart shown in <a href="#flowchart"></a> is quite impressive.</p>
+</section>
+
+ReSpec ondersteunt ook een koppeling naar issues die zijn gemeld op GitHub. Jek +kan referenties opnemen naar individuele issues. Ook is het mogelijk om een +lijst met alle issues op te nemen in je document.
+Om GitHub issues op te nemen moet je in 'config.js' een referentie opnemen naar +de GitHub repository.
+issueBase: "https://github.com/Geonovum/MIM-Werkomgeving/issues/"
+
+Een referentie naar een issue neem je als volgt op:
+<div class="issue" data-number="363"></div>
+
+Waarbij data-number het issuenummer is.
+Een lijst met issues kan je toevoegen met de volgende HTML code:
+<section class="appendix" id="issue-summary">
+ <!-- Issues will magically be listed here! -->
+</section>
+
+
++
In dit geval is er een tikfout gemaakt bij de naam van de Markdownfile die
+ge-include wordt. Het moet natuurlijk H2-Testcases.md
zijn.
Een voorbeeld van een waarschuwing. Klikken hierop geeft je je de waarschuwing.
+In het onderstaande voorbeeld meldt ReSpec dat er een <h2>
header ontbreekt in
+het Markdown document.
In dit hoofdstuk staan checklists die je kan gebruiken als je vanuit GitHub en +ReSpec “Versies” gaat aanmaken. Bijvoorbeeld hoe maak je een nieuwe GitHub +repository aan, of hoe maak je vanuit een werkversie een consultatieversie aan,
+Controleer de volgende onderwerpen voor iedere publicatie:
+specStatus
:"GN-CV"
publishDate
: moet ingevuld zijn met de datum van publicatie van de
+ consultatieversie. "jjjj-mm-dd"
,Shortname
: moet ingevuld zijn met korte naam voor het document. Dit
+ wordt onderdeel van de URL. Moet uniek zijn binnen pubdomain (afgezien van
+ versies).Previousmaturity
: wat de status toen was.Previousmaturity
: wat de status toen was.index.html
staat in je
+ Github-repositoryKlik hier voor een beschrijving over hoe je een webhook eenmalig +configureert voor een repository. over het toepassen van de webhook.
+\{specStatus\}-\{specType\}-\{shortName\}-\{publishDate\}
snapshot.html
en de
+ bijbehorende afbeeldingen naar
+ [docs.geostandaarden.nl]http://docs.geostandaarden.nl).specStatus
in config.js
terug op "GN-WV"
previousMaturity
in met "GN-CV"
previousPublishDate
in met de datum van de zojuist gepubliceerde
+ consultatieversie++Note: uitwerken
+
Enterprise Architect versie: 15.2
+Tortoise SVN Subversion versie: 1.14.1
+Deze handleiding beschrijft hoe je in Enterprise Architect de packages van een bestaand project kunt importeren vanuit Subversion . Het stappenplan laat zien hoe je aan de hand van een EAP-bestand van het IMDiSGeo (IMSOR-XMI
) een bestaand package toevoegt. In dit voorbeeld wordt het package met standaarddatatypes toegevoegd. Je kunt ook bestaande packages importeren in een nieuw (leeg) EAP-bestand. De methode is vrijwel identiek. De handleiding licht beide opties toe.
Dit document bevat de volgende onderdelen:
+Importeer de MIM-toolbox (instructie). Dit is met name relevant als het bestaande project ontwikkeld is met de MIM-toolbox. Door de toolbox vooraf te importeren, maakt EA automatisch een koppeling met de MIM-modelelementen in de packages die je gaat importeren.
+Zie hiervoor stap 2 en stap 3 uit de handleiding SVN - installeren voor EAP.
+Configueer de version control settings van het bestaande project
+Configure
> Project-VC
.Version Control Settings
.Geonovum-{naam van het package}
, bijvoorbeeld; Geonovum-datatypes
, of: Geonovum-imkl
.svn.exe
), als dat nog niet is ingevuld.Package Control
> Get Package
.Geonovum-datatypes
.Geonovum-algemeen.xml
.++ +Note: Kies indien van toepassing het 'hoogtste' package in de hiërarchie van de package-structuur van het te importeren bestand. Op deze manier haal je ook in één keer alle subpackages op.
+Note: Het niveau in de package-structuur van de project browser waar je klikt, bepaalt de plek waar het geimporteerde package terecht komt. Het komt daaronder. kies je model, dan komt het op het 'hoogste' niveau. Dit is soms relevant. Als iets wel, of juist niet onderdeel van het model moet zijn. Ook voor Imvertor is/was dit relevant... (controleren)
+
In de Project Browser verschijnt nu het package Geonovum-algemeen
en indien aanwezig inclusief de subpackages. Het kan zijn dat de packages in dit stadium nog leeg zijn. Dat lossen we in de volgende stap op.
++Note: Via onderstaande stappen haal je de meest actuele versie op van de packages die onder versiebeheer staan. Als je met verschillende modelleurs aan een package werkt, is het verstandig om deze stappen tussentijds regelmatig uit te voeren.
+
Geonovum-geometrie
.Geonovum-geometrie
> Package Control
> Get All Latest
.Er verschijnt een venster Get All Latest + - Selecteer Import Changed Files Only (recommended) + - Klik Ok.
+ +Het package en de subpackages zijn succesvol geïmporteerd. Indien je meerdere basismodellen (of andere typen packages) wilt importeren, doorloop je stap 1 t/m 3 opnieuw.
+++Note: Het kan zijn dat de packages toch niet goed geïmporteerd worden. Doorloop dan onderstaande stappen.
+
«Geonovum-geometrie»
.Basismodel
> Package Control
> Get Latest
.Er verschijnt een venster Import Package + - Selecteer Force reload from XMI + - Klik Ok.
+UML modellen worden beheerd in Subversion (SVN) op 'svn.geostandaarden.nl'. Dit is een versiebeheertool die kan samenwerken met 'Enterprise Architect' en wordt daarom voor UML modellen gebruik.. Deze handleiding beschrijft hoe je een informatiemodel in de versiebeheeromgeving zet.
+Dit document bevat de volgende onderdelen:
+Als je SVN Tortoise nog niet hebt, installeer deze van +https://tortoisesvn.net/.
+++Note +Installeer ook de Command Line Client Tools mee. Dit heb je nodig bij stap 4: Breng EAP-bestand (packages) onder SVN. Het is een extra optie en valt niet onder de standaardinstallatie, dus je moet hier zelf alert op zijn. Het is ook mogelijk om dit achteraf te doen. Hoe je dit doet, staat beschreven in stap 4.
+
Vraag een account aan voor svn.geostandaarden.nl bij de beheerder
+svn.geostandaarden.nl
) aan met de naam van het model.imxx
met op de plaats van de xx
de (afkorting van de) naam van het model. Bijvoorbeeld imka
(informatiemodel klimaatadaptatie)svn.geostandaarden.nl/imxx
synchroniseert met deze folder.svn
met als subfolder imxx
.svn/imxx
svn/imxx
folder.svn://svn.geostandaarden.nl/imxx
) en checkout directory.Het EAP bestand wordt op het niveau van packages onder SVN gebracht.
+Geonovum-{naam van het package}
, bijv. Geonovum-imkl
.C:\Program Files\TortoiseSVN\bin\
en selecteer svn.exe
(dit is een éénmalige stap).++ +Note +Je kunt een melding krijgen dat er geen
+svn.exe
aanwezig is. Installeer dan de command line interface (CLI) mee volgens deze instructie. Je hoeft SVN hiervoor niet opnieuw te installeren; deze stap breidt de installatie alleen uit. Hierna staatsvn.exe
gewoon netjes in de bedoelde map. Je hoeft dus verder niet met de CLI aan de slag. Een andere optie is om SLIKSVN te installeren.
Wanneer een UML model in subversion beheerd is dan kun je deze als volgt op je eigen computer gebruiken.
+Configureer version control in EA - Kies uit het menu (de ribbon bovenin EA) Configure > Settings. Het Version Control Settings dialoogvenster verschijnt. Vul dit zoals hieronder in en klik dan op Save.
+ +Elk van de packages die in SVN zijn ondergebracht, hebben nu in EA een slotje. Je kunt de inhoud van het model dat in zo'n package staat niet zomaar meer wijzigen.
+ +Get Latest > Laatste wijzigingen van de SVN server ophalen zodat je ze kan zien, zonder te willen uitchecken.
+Klik met de rechtermuisknop op het package in de Project Browser van Enterprise Architect.
+++Note: Let op: we werken niet met
+Check in branch
enCheck out branch
!
Kijk voor meer informatie ook op de website van Sparx Systems
Hieronder volgt een ruwe opsomming van suggesties voor het maken van nieuwe, dan wel uitbreiden van bestaande handleidingen.
+++Note: Hoe omgaan met onderdelen die regelmatig wijzigen?
+Note: Op Confluence staan ook al verschillende documenten.
+
++Note: Waar kun je deze windows vinden?
+Note: Creëer workspaces
+
.xml
van het package dat je uit VC hebt gehaald uit checkout repo..xml
-bestanden van de verwijderde package(s)view_<naam>
of domein_<naam>
-overzicht
in diagramnaam EA, properties?+Note: op properties staan 2x beschreven. De lijst met CLI-properties is compleet/uitgebreider
+
Er zijn tools om MsWord documenten om te zetten naar Mardown: +- Word2Werkversie.
De onderstaande tabbelen geven een overzicht van reeds beschikbare handleidingen en andere documenten die voor een modelleur bij Geonovum relevant zijn.
+++Note +Nog verwerken
+
Handleiding GitHub ReSpec Markdown v1.1.docx
)Handleiding introductie GitHub.docx
)++Note +Wilko heeft twee bestaande documenten samengevoegd, maar daarin zit ook overlap met het document van Linda over Logius ReSpec. Bovendien bevat het document secties waarvan het fijn is om er apart naar te kunnen verwijzen. M.a.w.: tabellen kunnen aangevuld worden, maar goed kijken welke documenten (zie ook: rij
+16
en22
in de tabel met het overzicht van beschikbare documentatie m.b.t. werkomgeving. ). Intranet luistert iets nauwer: daar misschien specifiekere verwijzingen maken.
++Note +Voorbeeld samenhang processen, data, inten/extern van aquo-standaarden
+
De volgende lijst bevat een aantal suggesties om documentatie (van o.a. werkwijze en -omgeving) beter en efficienter op orde te krijgen. Voor documentatie zouden we eens kunnen kijken naar DITA, een standaard uit de uitgeverswereld. Op Wikipedia wordt het als volgt uitgelegd: "Uitgangspunt van de architectuur is het verdelen van tekst in bouwstenen of 'topics' ten behoeve van hergebruik en specialisatie en het bundelen van bouwstenen via zogenaamde DITA Maps."
+Deze paragraaf geeft per document een korte analyse van de inhoud. Op basis hiervan wordt een koppeling gemaakt met de lijst met personen die op dit moment verantwoordelijk zijn voor bepaalde onderdelen binnen Geonovum. Dit wordt voorlopig alleen toegepast op wat relevant is voor de Geonovumwerkomgeving (m.u.v. HIM). Op die manier wordt duidelijk welke onderdelen afgedekt zijn en welke niet, maar ook wie er mogelijk verantwoordelijk voor is.
+++Note +Overzicht verder aanvullen
+Note +Relevante passages uit Model Driven Design documentatie VNG-realisatie. In het algemeen heel mooi dat alles netjes bij elkaar staat: begrippen, werkomgeving en werkwijze:
+
Welkom bij de beschrijving van de Geonovum Werkwijze. Deze helpfiles beschrijven +welke tools we gebruiken voor het maken en beheren van de standaarden van +Geonovum. Deze tools staan in onderstaand overzicht. Daaronder staat de +publicatieomgeving van Geonovum beschreven.
+Voor licenties of de interne beheerder van de tooling kun je terecht op +intranet
+De documentatie van de werkwijze is niet alleen hier vastgelegd. Links naar +andere documenten:
+ +Verschillende onderdelen van standaarden worden op verschillende plaatsen +gepubliceerd. De publicatieomgeving ziet er als volgt uit
+ +Standaarden en technische documentatie. Voor een nette lijst van pubdomains op +docs.geostandaarden.nl moet de de volgende lijst up-to-date zijn: +pubDomainList.json
+Technische onderdelen van de standaard worden op: +register.geostandaarden.nl gezet. Hoe je +dit met een webhook kan doen staat beschreven in: +technisch-register-2019
+De handleiding wordt beheerd in MkDocs. Dit is een +lichtgewicht tool die een collectie Markdown handleidingen omzet in een +navigeerbare handleiding. De handleiding staat op +github pages. De +bronbestanden staan in: +handleiding-tooling.
+Je kunt mkdocs ook lokaal installeren. Dan kun je live je edits volgen in je +browser: http://127.0.0.1:8000/ met het commando:
+mkdocs serve
+
' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..43a48c3 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welkom Welkom bij de beschrijving van de Geonovum Werkwijze. Deze helpfiles beschrijven welke tools we gebruiken voor het maken en beheren van de standaarden van Geonovum. Deze tools staan in onderstaand overzicht. Daaronder staat de publicatieomgeving van Geonovum beschreven. Geonovum tooling Enterprise Architect Overzicht Primitieve datatypes : Handleiding en toelichting op het toepassen van standaarddatatypes in modelleeromgeving Geonovum. GitHub : GitHub werkwijze : algemene inleiding over GitHub. GitHub handleiding : Hoe maak je een account aan en hoe doe je beheertaken. Imvertor Imvertor : Verwijzingen naar verschillende onderwerpen met betrekking tot Imvertor. Markdown Markdown handleiding : Handleiding werken met Markdown voor ReSpec-documentatie. ReSpec Respec handleiding : Algemene handleiding. Respec code toepassen : Richtlijnen voor het toepassen van code in documentatie. Respec definitielijst maken : Handleiding voor het maken van een definitielijst in ReSpec-documentatie. MIM Toolbox importeren : Handleiding voor het importeren van de MIM-toolbox in EA. Toolbox genereren : Handleiding voor het maken van een EA-toolbox. Toolbox genereren extensie : Handleiding voor het maken van een extensie op de MIM-toolbox. Subversion (SVN) Subversion installeren voor EA : Installatie SVN en informatiemodel in versiebeheer zetten. Subversion importeren bestaand project : Packages importeren vanuit SVN in EA. GML GML : Toelichting GML, XSD en Namespaces. Ontologie Ontologie : Handleiding voor het maken en publiceren van een ontologie. Word Conversies Word2werkversie Voor licenties of de interne beheerder van de tooling kun je terecht op intranet Documentatie elders De documentatie van de werkwijze is niet alleen hier vastgelegd. Links naar andere documenten: werkomgeving modelleren . werkwijze modelleren . geonovum werkwijze modelleren Geonovum publicatieomgeving Verschillende onderdelen van standaarden worden op verschillende plaatsen gepubliceerd. De publicatieomgeving ziet er als volgt uit Documenten (docs.geostandaarden.nl) Standaarden en technische documentatie. Voor een nette lijst van pubdomains op docs.geostandaarden.nl moet de de volgende lijst up-to-date zijn: pubDomainList.json Het Technisch Register (register.geostandaarden.nl) Technische onderdelen van de standaard worden op: register.geostandaarden.nl gezet. Hoe je dit met een webhook kan doen staat beschreven in: technisch-register-2019 Ontologie\u00ebn (begrippen.geostandaarden.nl) Conceptenbibliotheek (definities.geostandaarden.nl) MkDocs voor deze handleiding De handleiding wordt beheerd in MkDocs . Dit is een lichtgewicht tool die een collectie Markdown handleidingen omzet in een navigeerbare handleiding. De handleiding staat op github pages . De bronbestanden staan in: handleiding-tooling . Je kunt mkdocs ook lokaal installeren. Dan kun je live je edits volgen in je browser: http://127.0.0.1:8000/ met het commando: mkdocs serve","title":"Welkom"},{"location":"#welkom","text":"Welkom bij de beschrijving van de Geonovum Werkwijze. Deze helpfiles beschrijven welke tools we gebruiken voor het maken en beheren van de standaarden van Geonovum. Deze tools staan in onderstaand overzicht. Daaronder staat de publicatieomgeving van Geonovum beschreven.","title":"Welkom"},{"location":"#geonovum-tooling","text":"Enterprise Architect Overzicht Primitieve datatypes : Handleiding en toelichting op het toepassen van standaarddatatypes in modelleeromgeving Geonovum. GitHub : GitHub werkwijze : algemene inleiding over GitHub. GitHub handleiding : Hoe maak je een account aan en hoe doe je beheertaken. Imvertor Imvertor : Verwijzingen naar verschillende onderwerpen met betrekking tot Imvertor. Markdown Markdown handleiding : Handleiding werken met Markdown voor ReSpec-documentatie. ReSpec Respec handleiding : Algemene handleiding. Respec code toepassen : Richtlijnen voor het toepassen van code in documentatie. Respec definitielijst maken : Handleiding voor het maken van een definitielijst in ReSpec-documentatie. MIM Toolbox importeren : Handleiding voor het importeren van de MIM-toolbox in EA. Toolbox genereren : Handleiding voor het maken van een EA-toolbox. Toolbox genereren extensie : Handleiding voor het maken van een extensie op de MIM-toolbox. Subversion (SVN) Subversion installeren voor EA : Installatie SVN en informatiemodel in versiebeheer zetten. Subversion importeren bestaand project : Packages importeren vanuit SVN in EA. GML GML : Toelichting GML, XSD en Namespaces. Ontologie Ontologie : Handleiding voor het maken en publiceren van een ontologie. Word Conversies Word2werkversie Voor licenties of de interne beheerder van de tooling kun je terecht op intranet","title":"Geonovum tooling"},{"location":"#documentatie-elders","text":"De documentatie van de werkwijze is niet alleen hier vastgelegd. Links naar andere documenten: werkomgeving modelleren . werkwijze modelleren . geonovum werkwijze modelleren","title":"Documentatie elders"},{"location":"#geonovum-publicatieomgeving","text":"Verschillende onderdelen van standaarden worden op verschillende plaatsen gepubliceerd. De publicatieomgeving ziet er als volgt uit","title":"Geonovum publicatieomgeving"},{"location":"#documenten-docsgeostandaardennl","text":"Standaarden en technische documentatie. Voor een nette lijst van pubdomains op docs.geostandaarden.nl moet de de volgende lijst up-to-date zijn: pubDomainList.json","title":"Documenten (docs.geostandaarden.nl)"},{"location":"#het-technisch-register-registergeostandaardennl","text":"Technische onderdelen van de standaard worden op: register.geostandaarden.nl gezet. Hoe je dit met een webhook kan doen staat beschreven in: technisch-register-2019","title":"Het Technisch Register (register.geostandaarden.nl)"},{"location":"#ontologieen-begrippengeostandaardennl","text":"","title":"Ontologie\u00ebn (begrippen.geostandaarden.nl)"},{"location":"#conceptenbibliotheek-definitiesgeostandaardennl","text":"","title":"Conceptenbibliotheek (definities.geostandaarden.nl)"},{"location":"#mkdocs-voor-deze-handleiding","text":"De handleiding wordt beheerd in MkDocs . Dit is een lichtgewicht tool die een collectie Markdown handleidingen omzet in een navigeerbare handleiding. De handleiding staat op github pages . De bronbestanden staan in: handleiding-tooling . Je kunt mkdocs ook lokaal installeren. Dan kun je live je edits volgen in je browser: http://127.0.0.1:8000/ met het commando: mkdocs serve","title":"MkDocs voor deze handleiding"},{"location":"EA-toepassing-standaarddatatypen/","text":"EA - Gebruik standaarddatatypes (intern) Note > @Gerard : screenshots toevoegen Bij Geonovum gebruiken we een aantal voorgedefineerde datatypes. Deze zijn opgedeeld in drie categorie\u00ebn: MIM11 -- Dit package bevat de datatypes die voorgedefinieerd zijn in het MIM Geonovum geometrie -- Dit package bevat de geometrietypes uit ISO19107 . Deze zijn in een los package gestopt zodat andere partijen die alleen geometrie willen gebruik deze types kunnen gebruiken, Geonovum algemeen -- In dit package zitten alle overige datatypes die in Geonovum UML packages gebruikt worden. Merk op dat in dit package ook wat geometrie types zitten; dit zijn types die niet uit ISO-19107 komen. Bij voorkeur worden deze niet in de modellering gebruikt. In: svn.geostandaarden.nl/Datatypes zijn drie collecties met primitieve types opgenomen die alle primitieve types bevat die in Geonovum UML modellen gebruikt Deze packages zijn in beheer bij @wilkoquak. Het is de bedoeling dat er in [Imvertor] een mapping komt die precies overeenkomt het deze drie collecties types Geometrie datatypes In dit package zitten de geometrische datatypes zoals genoemd in ISO19107:2003 . MIM datatypes In dit package zitten de geometrische datatypes zoals genoemd in MIM . Geonovum datatypes In dit package zitten datatypes die niet in de twee eerdergenoemde packages vallen maar wel ergens gebruikt zijn bij Geonovum. Note > @Wilko wil jij een korte toelichting geven op de driedeling. Wat vind je waar en waarom? Alle basic datatypes binnen UML zouden in \u00e9\u00e9n van deze packages moeten staan. Als dat niet zo is neem dan contact op met @Wilko . Je vindt ze op SVN: svn://svn.geostandaarden.nl/Datatypes : Warning Onderstaande naamgeving klopt niet meer. Dit is door Wilko in overleg aangepast. @Gerard : graag updaten! MIM11.xml Geonovum-algemeen.xml Geonovum-geometrie.xml Note Er is nu nog een Datatyps.xml waarin alle datatypes zitten deze gaat binnenkort verdwijnen. Datatypes importeren voor gebruik in EA Lees hoe je deze types als packages importeert in de handleiding SVN - importeren bestaand project . Gebruik packages in EA Deze packages zijn bedoeld voor toepassing binnen een informatiemodel. Het is niet de bedoeling om de packages in of uit te checken; er hoeven immers geen wijzigingen in aangebracht te worden. Note > @Wilko en @Paul : Eigenlijk zou je hier een beperkt aantal mensen schrijfrechten willen geven en de rest alleen lees-rechten. Ik heb zoiets nog niet kunnen vinden. @Gerart : je kunt dat instellen door in configuratiebestandjes op svn.geostandaarden.nl, maar dan moet je daar wel bij kunnen. Verwijzen naar een datatype Note > @Gerard : In deze paragraaf een uitleg opnemen hoe je vanuit Enterprise Architect een voorgedefineerd datatype opneemt bij een \u00abAttribuutsoort\u00bb . |","title":"standaarddatatypen"},{"location":"EA-toepassing-standaarddatatypen/#ea-gebruik-standaarddatatypes-intern","text":"Note > @Gerard : screenshots toevoegen Bij Geonovum gebruiken we een aantal voorgedefineerde datatypes. Deze zijn opgedeeld in drie categorie\u00ebn: MIM11 -- Dit package bevat de datatypes die voorgedefinieerd zijn in het MIM Geonovum geometrie -- Dit package bevat de geometrietypes uit ISO19107 . Deze zijn in een los package gestopt zodat andere partijen die alleen geometrie willen gebruik deze types kunnen gebruiken, Geonovum algemeen -- In dit package zitten alle overige datatypes die in Geonovum UML packages gebruikt worden. Merk op dat in dit package ook wat geometrie types zitten; dit zijn types die niet uit ISO-19107 komen. Bij voorkeur worden deze niet in de modellering gebruikt. In: svn.geostandaarden.nl/Datatypes zijn drie collecties met primitieve types opgenomen die alle primitieve types bevat die in Geonovum UML modellen gebruikt Deze packages zijn in beheer bij @wilkoquak. Het is de bedoeling dat er in [Imvertor] een mapping komt die precies overeenkomt het deze drie collecties types","title":"EA - Gebruik standaarddatatypes (intern)"},{"location":"EA-toepassing-standaarddatatypen/#geometrie-datatypes","text":"In dit package zitten de geometrische datatypes zoals genoemd in ISO19107:2003 .","title":"Geometrie datatypes"},{"location":"EA-toepassing-standaarddatatypen/#mim-datatypes","text":"In dit package zitten de geometrische datatypes zoals genoemd in MIM .","title":"MIM datatypes"},{"location":"EA-toepassing-standaarddatatypen/#geonovum-datatypes","text":"In dit package zitten datatypes die niet in de twee eerdergenoemde packages vallen maar wel ergens gebruikt zijn bij Geonovum. Note > @Wilko wil jij een korte toelichting geven op de driedeling. Wat vind je waar en waarom? Alle basic datatypes binnen UML zouden in \u00e9\u00e9n van deze packages moeten staan. Als dat niet zo is neem dan contact op met @Wilko . Je vindt ze op SVN: svn://svn.geostandaarden.nl/Datatypes : Warning Onderstaande naamgeving klopt niet meer. Dit is door Wilko in overleg aangepast. @Gerard : graag updaten! MIM11.xml Geonovum-algemeen.xml Geonovum-geometrie.xml Note Er is nu nog een Datatyps.xml waarin alle datatypes zitten deze gaat binnenkort verdwijnen.","title":"Geonovum datatypes"},{"location":"EA-toepassing-standaarddatatypen/#datatypes-importeren-voor-gebruik-in-ea","text":"Lees hoe je deze types als packages importeert in de handleiding SVN - importeren bestaand project .","title":"Datatypes importeren voor gebruik in EA"},{"location":"EA-toepassing-standaarddatatypen/#gebruik-packages-in-ea","text":"Deze packages zijn bedoeld voor toepassing binnen een informatiemodel. Het is niet de bedoeling om de packages in of uit te checken; er hoeven immers geen wijzigingen in aangebracht te worden. Note > @Wilko en @Paul : Eigenlijk zou je hier een beperkt aantal mensen schrijfrechten willen geven en de rest alleen lees-rechten. Ik heb zoiets nog niet kunnen vinden. @Gerart : je kunt dat instellen door in configuratiebestandjes op svn.geostandaarden.nl, maar dan moet je daar wel bij kunnen.","title":"Gebruik packages in EA"},{"location":"EA-toepassing-standaarddatatypen/#verwijzen-naar-een-datatype","text":"Note > @Gerard : In deze paragraaf een uitleg opnemen hoe je vanuit Enterprise Architect een voorgedefineerd datatype opneemt bij een \u00abAttribuutsoort\u00bb . |","title":"Verwijzen naar een datatype"},{"location":"EA/","text":"Enterprise Architect Instructie voor het gebruik van Enterprise Architect binnen Geonovum: Installatie van de software. Gebruik van de MIM Toolbox. Installatie Op de website is een proefversie van Enterprise Architect te downloaden. Neem voor een licentie contact op met de beheerder De MIM toolbox Importeer de MIM toolbox: Zie: MIM toolbox importeren Externe links: Handleiding gebruik MIM-toolbox Handleiding genereren MIM-profiel Handleiding genereren Extensie MIM-toolbox","title":"Overzicht"},{"location":"EA/#enterprise-architect","text":"Instructie voor het gebruik van Enterprise Architect binnen Geonovum: Installatie van de software. Gebruik van de MIM Toolbox.","title":"Enterprise Architect"},{"location":"EA/#installatie","text":"Op de website is een proefversie van Enterprise Architect te downloaden. Neem voor een licentie contact op met de beheerder","title":"Installatie"},{"location":"EA/#de-mim-toolbox","text":"Importeer de MIM toolbox: Zie: MIM toolbox importeren Externe links: Handleiding gebruik MIM-toolbox Handleiding genereren MIM-profiel Handleiding genereren Extensie MIM-toolbox","title":"De MIM toolbox"},{"location":"GML/","text":"GML en XSD Een algemene handleiding voor het opslaag van Geometrie in GML bestanden is te vinden in: Geometrie in model en GML XSD en Namespaces Bij een XML applicatie schema (dus ook voor GML schema's) wordt vaak een namespace gebruikt. Deze namespace hoort vaak bij een domein en het is de bedoel dat de combinatie van de namespace en het element uniek is. Dit kan alleen als de namespace, die de vorm van een URI heeft uniek is. Door een URI te kiezen die bij jou onder beheer is weet je zeker dat de combinatie uniek is. In de volgende paragraaf zie je een lijste gebruikte namespaces. Hieronder wat richtlijnen. Voor de basis wordt: http://www.geostandaarden.nl gebruikt. Het is nog even de vraag of we niet op https moeten overstappen. Dat doen we niet want niemand anders doet deze overstap. Daarna volgt een identificatie van de standaard. Een versienummer volgens semver X.Y. Een Z-versie is niet nodig omdat alle Z-versies backwards compatible zijn en je dus nooit meer dan 1 versie gebruikt. De volgende model onderdelen wordt gebruikt bij het maken construeren van schemas: Een schema heeft een [X.Y.Z] versienummer Een schema hoort bij een standaard met een [standaard] Een schema heeft een onderdeel [onderdeel] Samen wordt dit: namespace van schema: http://www.geostandaarden.nl/[standaard]/[onderdeel]/x.y locatie van schema: https://register.geostanadaarden.nl/xmlschema/[standaard]/[x.y.z]/[onderdeel].xsd vesion in het schema: [x.y.z] Bij een standaard zonder onderdelen wordt de bestandsnaam als onderdeelnaam gebruikt bij locatie. Namespaces in door Geonovum beheerde schema's GML applicatieschema's zijn te vinden op: https://register.geostandaarden.nl/gmlapplicatieschema/ Een korte inventarisatie levert: standaard versie namespace basisgeometrie 1.0.0 http://www.geostandaarden.nl/basisgeometrie/1.0 basisgeometrie v20190901 http://www.geostandaarden.nl/basisgeometrie/v20190901 brt-algemeen 1.2.0 http://register.geostandaarden.nl/gmlapplicatieschema/brt-algemeen/1.2.0 imaer 5.1.1 http://imaer.aerius.nl/5.1 img 3.0.0 http://www.geluidgegevens.nl/IMGeluid/3.0 imgeo (simple) 2.1.1 http://www.geostandaarden.nl/imgeo/2.1/simple/gml31 imgeo 2.1.1 http://www.geostandaarden.nl/imgeo/2.1 imkl (wibon) 2.0.0 http://www.geostandaarden.nl/imkl/wibon imkl (wibonbr) 2.0.0 http://www.geostandaarden.nl/imkl/wibonbr imkl2015 (wionbr) 1.2 http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 imkl2015 (wionbr) 1.2.1 http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 top10nl 1.1.1 http://www.kadaster.nl/schemas/top10nl/v20120116 top10nl 1.2.0 http://register.geostandaarden.nl/gmlapplicatieschema/top10nl/1.2.0","title":"GML"},{"location":"GML/#gml-en-xsd","text":"Een algemene handleiding voor het opslaag van Geometrie in GML bestanden is te vinden in: Geometrie in model en GML","title":"GML en XSD"},{"location":"GML/#xsd-en-namespaces","text":"Bij een XML applicatie schema (dus ook voor GML schema's) wordt vaak een namespace gebruikt. Deze namespace hoort vaak bij een domein en het is de bedoel dat de combinatie van de namespace en het element uniek is. Dit kan alleen als de namespace, die de vorm van een URI heeft uniek is. Door een URI te kiezen die bij jou onder beheer is weet je zeker dat de combinatie uniek is. In de volgende paragraaf zie je een lijste gebruikte namespaces. Hieronder wat richtlijnen. Voor de basis wordt: http://www.geostandaarden.nl gebruikt. Het is nog even de vraag of we niet op https moeten overstappen. Dat doen we niet want niemand anders doet deze overstap. Daarna volgt een identificatie van de standaard. Een versienummer volgens semver X.Y. Een Z-versie is niet nodig omdat alle Z-versies backwards compatible zijn en je dus nooit meer dan 1 versie gebruikt. De volgende model onderdelen wordt gebruikt bij het maken construeren van schemas: Een schema heeft een [X.Y.Z] versienummer Een schema hoort bij een standaard met een [standaard] Een schema heeft een onderdeel [onderdeel] Samen wordt dit: namespace van schema: http://www.geostandaarden.nl/[standaard]/[onderdeel]/x.y locatie van schema: https://register.geostanadaarden.nl/xmlschema/[standaard]/[x.y.z]/[onderdeel].xsd vesion in het schema: [x.y.z] Bij een standaard zonder onderdelen wordt de bestandsnaam als onderdeelnaam gebruikt bij locatie.","title":"XSD en Namespaces"},{"location":"GML/#namespaces-in-door-geonovum-beheerde-schemas","text":"GML applicatieschema's zijn te vinden op: https://register.geostandaarden.nl/gmlapplicatieschema/ Een korte inventarisatie levert: standaard versie namespace basisgeometrie 1.0.0 http://www.geostandaarden.nl/basisgeometrie/1.0 basisgeometrie v20190901 http://www.geostandaarden.nl/basisgeometrie/v20190901 brt-algemeen 1.2.0 http://register.geostandaarden.nl/gmlapplicatieschema/brt-algemeen/1.2.0 imaer 5.1.1 http://imaer.aerius.nl/5.1 img 3.0.0 http://www.geluidgegevens.nl/IMGeluid/3.0 imgeo (simple) 2.1.1 http://www.geostandaarden.nl/imgeo/2.1/simple/gml31 imgeo 2.1.1 http://www.geostandaarden.nl/imgeo/2.1 imkl (wibon) 2.0.0 http://www.geostandaarden.nl/imkl/wibon imkl (wibonbr) 2.0.0 http://www.geostandaarden.nl/imkl/wibonbr imkl2015 (wionbr) 1.2 http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 imkl2015 (wionbr) 1.2.1 http://www.geostandaarden.nl/imkl/2015/wionbr/1.2 top10nl 1.1.1 http://www.kadaster.nl/schemas/top10nl/v20120116 top10nl 1.2.0 http://register.geostandaarden.nl/gmlapplicatieschema/top10nl/1.2.0","title":"Namespaces in door Geonovum beheerde schema's"},{"location":"GitHub-Inleiding/","text":"Inleiding Github Bij Geonovum worden documenten (standaarden, onderzoeken, rapporten, enz) web-based gepubliceerd. Ook worden de documenten vaak in een werkgroep gemaakt, waarbij ieder werkgroeplid meeschrijft aan het document. Om dit te kunnen gebruiken we een aantal tools: GitHub, Respec en Markdown. Deze introductie gaat over Github. Waarschijnlijk wil je weten wat GitHub is, anders was je nu niet deze handleiding aan het lezen. Je gaat hier meer over GitHub lezen en waarom het handig is. Er zijn een aantal GitHub termen die alvast handig zijn om te weten. Tot slot lees je hoe je zelf aan de slag kan gaan met GitHub. Meer over Github Veel programmeurs wereldwijd maken gebruik van de website GitHub. Zelf zal je er misschien ook wel van gehoord hebben. Als programmeur is het handig om te weten wat GitHub is en hoe je er gebruik van maakt. GitHub bestaat uit twee woorden, namelijk Git + Hub. Laten we beginnen met Git. *Git is een open source versiebeheersysteem. De website GitHub is gemaakt op basis van het versiebeheersysteem Git. Met GitHub heb je alle mogelijkheden van Git + extra features. In een versiebeheersysteem kunnen programmeurs projecten beheren met code. Het is mogelijk om verschillende versies te beheren en eventueel terug te vallen op een oude versie, mocht er iets misgaan. Stel dat je met een team een app wilt programmeren. Dan is het handig als iedereen bij het project kan met daarin alle code van de app. Ook is het handig dat iedereen de laatste code wijzigingen ziet van teamleden en daar eventueel op kan reageren en/of het aanpassen. Bij Geonovum gebruiken we Github op een andere manier. Namelijk voor het voor werken aan documentatie voor geostandaarden. Per project is een repository aangemaakt. Een Repository is eenvoudig gezegd een werkmap/projectomgeving. Andere mogelijkheden van Github Je weet nu dat het mogelijk is om in een team projecten (Waarin code staat) te beheren op GitHub. Het is natuurlijk ook mogelijk om je eigen projecten op GitHub te beheren. Zo heb je een goed overzicht van de aanpassingen en verschillende versies. Daarnaast staat je project online. Als je een belangrijk project bijvoorbeeld alleen lokaal op je eigen computer opslaat en je computer houdt ermee op, dan ben je zwaar de pineut. Op GitHub kan je er gewoon altijd bij. Maar welke mogelijkheden heeft GitHub nog meer? Hier staan een aantal belangrijke mogelijkheden op een rijtje: Een project maken gebaseerd op een project dat al bestaat Discussie starten over een project Code reviewen Aparte branches maken, waarin je bijvoorbeeld code aanpassingen doet om te testen, die niet gelijk in de \u201cproductieversie\u201d komen Code van branch samenvoegen met andere branch Tags meegeven aan verschillende versies, zoals V1.0 en V2.0 Kwetsbaarheden in de code makkelijker ontdekken, GitHub stuurt ook een mail als het kwetsbaarheden ontdekt Een website hosten Voordelen van GitHub GitHub zorgt ervoor dat een individueel of een project in teamverband erg overzichtelijk is. Je hebt een goed overzicht van de laatste aanpassingen en welke persoon dat heeft gedaan. Je kan eenvoudig meerdere versies maken en eenvoudig terugvallen op een vorige versie, mocht het misgaan. Door de verschillende branches loop je geen enkel risico bij het aanpassen en testen van nieuwe code. Meer over branches in \u201cBetekenissen van GitHub termen\u201d . Voor programmeurs maakt GitHub het werken een stuk makkelijker en leuker. Stel dat je als programmeur niet aan versiebeheer zou doen of dat zou doen met een slecht versiebeheersysteem, dan ga je vroeg of laat in de problemen komen. GitHub is een centrale plek waar heel veel programmeurs en teams hun projecten beheren. Veel projecten zijn open source en kunnen door iedereen worden ingezien en aangepast. Het is erg leerzaam om naar projecten van anderen te kijken. Als je wat meer ervaring hebt, kan je misschien wel verbeteringen voorstellen en meedoen aan gave projecten! Met GitHub gaat er als programmeur een wereld voor je open. Het is goed om projecten te beheren en je kan er ook heel veel leren. Betekenis van Github termen? Op GitHub zijn er een aantal termen die handig zijn om alvast te weten. Als je meer gebruik gaat maken van GitHub, dan leer je de betekenis van deze termen vanzelf kennen. Hieronder staan belangrijke GitHub termen en de betekenis ervan: GitHub term Betekenis Repository Een repository kan je zien als de hoofdmap van je project. Hierin staan alle bestanden van je project en de historie van wijzigingen die je hebt gedaan. Branch Aparte plek binnen je repository, waar je bijvoorbeeld nieuwe code kan testen, zonder dat te hoeven doen op de 'productversie'. Master Dit is de hoofdbranch, oftewel de \u201cproductversie\u201d van je project. Nieuwe code die is getest en goedgekeurd, wordt samengevoegd met de Master branch. Fork Een fork is een kopie van een repository. Hierdoor kan je werken aan een project van iemand anders, zonder het origineel aan te passen. Commit Git commando dat veranderingen toevoegt aan je lokale repository. Push Git commando om aanpassingen naar je (remote) repository te sturen, die staat op GitHub. Pull Git commando om aanpassingen van je (remote) repository naar je lokale bestanden te sturen. Merge Git commando om aanpassingen van een branch samen te voegen met een andere branch. Bijvoorbeeld aanpassingen die getest en goedgekeurd zijn in de \u201cDevelop\u201d branch samenvoegen met de \u201cMaster\u201d branch. Checkout Deze Git commando wordt vaak gebruikt om te switchen tussen branches. Je checkt als het ware uit bij een branch en gaat aan de slag in een andere branch. Zelf aan de slag met Github Hopelijk heb je een beter beeld over wat GitHub is. Ben je een gebruiker of wil je programmeur worden en werk je nog niet met een (goed) versiebeheersysteem? Dan is het zeker aan te raden om te beginnen met GitHub. Als je een account hebt aangemaakt kun je zelf een repository aanmaken. Zie hiervoor: Aanmaken GitHub Account Stuur een mail naar account@geonovum.nl om toegevoegd te worden aan deze repository. Je moet dan wel eerst een account aangemaakt hebben op github","title":"GitHub Intro"},{"location":"GitHub-Inleiding/#inleiding-github","text":"Bij Geonovum worden documenten (standaarden, onderzoeken, rapporten, enz) web-based gepubliceerd. Ook worden de documenten vaak in een werkgroep gemaakt, waarbij ieder werkgroeplid meeschrijft aan het document. Om dit te kunnen gebruiken we een aantal tools: GitHub, Respec en Markdown. Deze introductie gaat over Github. Waarschijnlijk wil je weten wat GitHub is, anders was je nu niet deze handleiding aan het lezen. Je gaat hier meer over GitHub lezen en waarom het handig is. Er zijn een aantal GitHub termen die alvast handig zijn om te weten. Tot slot lees je hoe je zelf aan de slag kan gaan met GitHub.","title":"Inleiding Github"},{"location":"GitHub-Inleiding/#meer-over-github","text":"Veel programmeurs wereldwijd maken gebruik van de website GitHub. Zelf zal je er misschien ook wel van gehoord hebben. Als programmeur is het handig om te weten wat GitHub is en hoe je er gebruik van maakt. GitHub bestaat uit twee woorden, namelijk Git + Hub. Laten we beginnen met Git. *Git is een open source versiebeheersysteem. De website GitHub is gemaakt op basis van het versiebeheersysteem Git. Met GitHub heb je alle mogelijkheden van Git + extra features. In een versiebeheersysteem kunnen programmeurs projecten beheren met code. Het is mogelijk om verschillende versies te beheren en eventueel terug te vallen op een oude versie, mocht er iets misgaan. Stel dat je met een team een app wilt programmeren. Dan is het handig als iedereen bij het project kan met daarin alle code van de app. Ook is het handig dat iedereen de laatste code wijzigingen ziet van teamleden en daar eventueel op kan reageren en/of het aanpassen. Bij Geonovum gebruiken we Github op een andere manier. Namelijk voor het voor werken aan documentatie voor geostandaarden. Per project is een repository aangemaakt. Een Repository is eenvoudig gezegd een werkmap/projectomgeving.","title":"Meer over Github"},{"location":"GitHub-Inleiding/#andere-mogelijkheden-van-github","text":"Je weet nu dat het mogelijk is om in een team projecten (Waarin code staat) te beheren op GitHub. Het is natuurlijk ook mogelijk om je eigen projecten op GitHub te beheren. Zo heb je een goed overzicht van de aanpassingen en verschillende versies. Daarnaast staat je project online. Als je een belangrijk project bijvoorbeeld alleen lokaal op je eigen computer opslaat en je computer houdt ermee op, dan ben je zwaar de pineut. Op GitHub kan je er gewoon altijd bij. Maar welke mogelijkheden heeft GitHub nog meer? Hier staan een aantal belangrijke mogelijkheden op een rijtje: Een project maken gebaseerd op een project dat al bestaat Discussie starten over een project Code reviewen Aparte branches maken, waarin je bijvoorbeeld code aanpassingen doet om te testen, die niet gelijk in de \u201cproductieversie\u201d komen Code van branch samenvoegen met andere branch Tags meegeven aan verschillende versies, zoals V1.0 en V2.0 Kwetsbaarheden in de code makkelijker ontdekken, GitHub stuurt ook een mail als het kwetsbaarheden ontdekt Een website hosten","title":"Andere mogelijkheden van Github"},{"location":"GitHub-Inleiding/#voordelen-van-github","text":"GitHub zorgt ervoor dat een individueel of een project in teamverband erg overzichtelijk is. Je hebt een goed overzicht van de laatste aanpassingen en welke persoon dat heeft gedaan. Je kan eenvoudig meerdere versies maken en eenvoudig terugvallen op een vorige versie, mocht het misgaan. Door de verschillende branches loop je geen enkel risico bij het aanpassen en testen van nieuwe code. Meer over branches in \u201cBetekenissen van GitHub termen\u201d . Voor programmeurs maakt GitHub het werken een stuk makkelijker en leuker. Stel dat je als programmeur niet aan versiebeheer zou doen of dat zou doen met een slecht versiebeheersysteem, dan ga je vroeg of laat in de problemen komen. GitHub is een centrale plek waar heel veel programmeurs en teams hun projecten beheren. Veel projecten zijn open source en kunnen door iedereen worden ingezien en aangepast. Het is erg leerzaam om naar projecten van anderen te kijken. Als je wat meer ervaring hebt, kan je misschien wel verbeteringen voorstellen en meedoen aan gave projecten! Met GitHub gaat er als programmeur een wereld voor je open. Het is goed om projecten te beheren en je kan er ook heel veel leren. Betekenis van Github termen? Op GitHub zijn er een aantal termen die handig zijn om alvast te weten. Als je meer gebruik gaat maken van GitHub, dan leer je de betekenis van deze termen vanzelf kennen. Hieronder staan belangrijke GitHub termen en de betekenis ervan: GitHub term Betekenis Repository Een repository kan je zien als de hoofdmap van je project. Hierin staan alle bestanden van je project en de historie van wijzigingen die je hebt gedaan. Branch Aparte plek binnen je repository, waar je bijvoorbeeld nieuwe code kan testen, zonder dat te hoeven doen op de 'productversie'. Master Dit is de hoofdbranch, oftewel de \u201cproductversie\u201d van je project. Nieuwe code die is getest en goedgekeurd, wordt samengevoegd met de Master branch. Fork Een fork is een kopie van een repository. Hierdoor kan je werken aan een project van iemand anders, zonder het origineel aan te passen. Commit Git commando dat veranderingen toevoegt aan je lokale repository. Push Git commando om aanpassingen naar je (remote) repository te sturen, die staat op GitHub. Pull Git commando om aanpassingen van je (remote) repository naar je lokale bestanden te sturen. Merge Git commando om aanpassingen van een branch samen te voegen met een andere branch. Bijvoorbeeld aanpassingen die getest en goedgekeurd zijn in de \u201cDevelop\u201d branch samenvoegen met de \u201cMaster\u201d branch. Checkout Deze Git commando wordt vaak gebruikt om te switchen tussen branches. Je checkt als het ware uit bij een branch en gaat aan de slag in een andere branch.","title":"Voordelen van GitHub"},{"location":"GitHub-Inleiding/#zelf-aan-de-slag-met-github","text":"Hopelijk heb je een beter beeld over wat GitHub is. Ben je een gebruiker of wil je programmeur worden en werk je nog niet met een (goed) versiebeheersysteem? Dan is het zeker aan te raden om te beginnen met GitHub. Als je een account hebt aangemaakt kun je zelf een repository aanmaken. Zie hiervoor: Aanmaken GitHub Account Stuur een mail naar account@geonovum.nl om toegevoegd te worden aan deze repository. Je moet dan wel eerst een account aangemaakt hebben op github","title":"Zelf aan de slag met Github"},{"location":"GitHub/","text":"GitHub In dit hoofdstuk komen zowel GitHub als GitHub desktop client aan de orde. Geonovum heeft op github een eigen \u2018onderkomen\u2019 op: https://github.com/Geonovum . In dit hoofdstuk staat beschreven wat je moet doen om \u201cup-and-running\u201d te komen voor het uitvoeren van je beheertaken op GitHub. Hoe je een account aanmaakt, en hoe je de benodigde software installeert. Installatie en inrichting Aanmaken GitHub account Als je nog geen GitHub account hebt, of als je een apart GitHub account wil maken voor je Geonovum werkzaamheden, ga naar: https://github.com/join/get-started . Dan zie je het scherm dat hiernaast staat. Maak in dat scherm een usernaam aan waarmee je op GitHub gaat werken. Tip : als je met meerdere accounts gaat werken, zorg er dan voor dat aan de accountnaam kan zien waarvoor die dan gebruikt moet worden. (Bijvoorbeeld door die naam te eindigen op \u2013GNM). Verplicht is dit niet. Vul in het veld username je nieuwe GitHub naam in. Vul in het veld email adress je geonovum mailadres in Klik vervolgens op \u201cCreate Account\u201d en dan wordt je account aangemaakt. Kies in dit scherm je persoonlijke plan. Bij Geonovum gebruiken we de gratis versie, dus selecteer die. Installeren GitHub desktop Ga in je internet browser naar https://desktop.github.com/ Klik daar op download for Windows (64bit). Nu wordt de installer gedownload, en dat zie je linksonder in je browser zoals in het plaatje rechts: Na starten van de installer verschijnt het scherm hiernaast Het volgende scherm zal nu openen we hebben in de vorige stap al een account aangemaakt dus klik op Sign Into Github.com Na Klikken op Sign into Github.com, verschijnt dit scherm. Hier hoeft verder niks ingevuld te worden, dus klik op continue. In dit scherm kan je desgewenst het vinkje bij het versturen van anonieme data uitzetten. Daarna klikken op Finish. GitHub Desktop is nu ge\u00efnstalleerd. Opties voor GitHub desktop GitHub Desktop kan worden aangepast aan persoonlijke voorkeuren. Dat doe je door in het hoofdscherm van de GitHub Desktop op het menu \u201cFile\u201d te klikken en vervolgens voor \u201cOpties\u201d te kiezen. In het Accounts scherm staat hoe je bent ingelogd bij GitHub. Hier kan je uitloggen en opnieuw inloggen als je meerdere GitHub Accounts hebt. In het tabblad \u201cGit\u201d kan je je Github Naam eventueel aanpassen. De GitHub Email is de email die intern binnen Github wordt gebruikt. Die hoeft niet gewijzigd te worden. In het tabblad \u201cAppearance\u201d kan je ervoor kiezen om in Light of Dark modus te werken. Hiermee verander je alleen de achtergrondkleur van de GitHub Desktop omgeving. In dit scherm kan je de voorkeurs editor instellen. Default wordt gekeken naar de reeds aanwezige tekst editors. Omdat GitHub van nature een samenwerkomgeving is voor het ontwikkelen van programmatuur, gaat het hier om \u201cplatte tekst\u201d editors. Werkwijze Geonovum De Geonovum GitHub pagina Geonovum heeft een eigen GitHub Bedrijfspagina: https://github.com/Geonovum . Voor alle projecten die een product maken of beheren wordt een repository aangemaakt. Het aanmaken van een repository staat beschreven in paragraaf 2.3.1 . Mappenstructuur in de respository In de Repository maak je indien nodig submappen aan. Submappen zijn handig als er in je Repository meer dan \u00e9\u00e9n ReSpec document komt te staan. Over ReSpec meer in hoofdstuk 3. Hiernaast een afbeelding van de GitHub Repository voor MIM. Twee mappen omdat MIM twee documenten bevat. Ook maakt GitHub standaard een readme.md aan. De readme staat in het \u201cMarkdown\u201d formaat, waarover in de volgende paragraaf meer. Readme.md In de readme.md file staat nog eens beschreven Wat de inhoud van de Repository is. Neem ook de link naar de webversie van de documenten hier op, dan is het voor bezoekers gemakkelijker om het document te openen in een browser. Neem altijd een link naar https://docs.geostandaarden.nl/ op, en in het geval het technische documenten betreft zoals UML\u2019s, XSD\u2019s, GML\u2019s, XML\u2019s een link naar http://register.geostandaarden.nl/ in het Readme bestand op. Aan de slag met GitHub In deze paragraaf een beschrijving van hoe je in GitHub een nieuwe repository aanmaakt, en hoe je die synchroniseert met je lokale GitHub client. Het maken van een nieuwe repository Een nieuwe repository maak je aan in de Centrale GitHub omgeving. Klik in de banner bovenaan de pagina, naast je profielfoto op \u201c+\u201d en kies \u201cCreate Repository\u201d Nadat je op \u201c+\u201d hebt geklikt, verschijnt het scherm hieronder. Vul hier de naam van de repository in. Gebruik een naam die kort en bondig is. Zie ook verderop in dit document voor de naamgevingsconventies. Vul ook de beschrijving in van het project. Geef als local path de naam van de GitHub map op. GitHub zal dan de naam van de standaard als mapnaam aanmaken onder de lokale GitHub map. Het is wel zo netjes om een readme file aan te maken, hierin zet je een korte omschrijving van de repository. Klik vervolgens op \u201cCreate Repository\u201d GitHub Clone: eerste keer ophalen van de centrale repository Start de GitHub Client, en kies in het menu File voor Clone Repository. En kies de Repository die je wil clonen (in dit geval Geonovum/MIM). Als Local Path kies je een logische plek op je PC/Laptop. (Tip: het is handig om \u00e9\u00e9n plek voor je Github Repositories te maken, bijvoorbeeld C:. Na het aanklikken van de knop clone wordt een lokale kopie gemaakt. Github weet welke versie je hebt opgehaald, en zal de wijzingen die je maakt netjes voor je bijhouden. In de map die je als local path hebt opgegeven komt de mappen structuur te staan zoals hierboven beschreven. GitHub Pull origin: ophalen van wijzigingen Een pull commando werkt de lokale versie van je GitHub Repository bij. Wijzigingen die zijn gedaan in de centrale repository (dus op Github.com) worden ook doorgevoerd in je lokale kopie. Het uitvoeren van een pull doe je door in het menu Repository op pull te klikken. NB: Voer dit commando regelmatig uit als er meerdere mensen in de repository werken, om conflicterende wijzigingen te voorkomen. GitHub Commit to Master: wijzigingen opslaan Met de knop Commit to master zet je de wijzigingen die je hebt gedaan klaar om te uploaden naar de Centrale GitHub Repository. GitHub maakt daartoe een versie aan, die je verplicht voorziet van een summary en optioneel van een Description Let op: met het committen heb je dus nog niks ge-upload. GitHub Push origin of Pull request: wijzigingen uploaden Nadat je de wijzigingen hebt gecommit, moeten ze richting de centrale repository. Nu zijn er twee mogelijkheden. Ofwel je hebt schrijfrechten op de Centrale Repository, of je hebt ze niet. In het eerste geval kan je een Push Origin uitvoeren, dan worden de wijzigingen meteen in de Centrale GitHub Repository verwerkt. In het tweede geval doe je een Pull request bij de eigenaar van de Repository om de wijzigingen door te voeren. Github maakt dan een eigen versie voor je aan (dat heet een fork) en vraagt aan de eigenaar van de Repository om die fork te verwerken in de Centrale Repository. Enkele regels over GitHub binnen Geonovum Geonovum heeft binnen github een team: https://github.com/Geonovum. Github beheer Github teamleden met beheerders rechten zijn te vinden via: https://github.com/orgs/Geonovum/people?query=role%3Aowner Daarnaast zijn er nog drie inhoudelijk beheerders vanuit Geonovum: Arnoud de Boer, Frank Terpstra en Linda vd Brink. Github gebruikers Een overzicht van de gebruikers is te vinden op: https://github.com/orgs/Geonovum/people. In principe geldt de regels: als je lid bent van Geonovum Teams dan hoor je ook bij de Geonovum GitHub organisatie. De inhoudelijk beheerders kunnen besluiten daar van af te wijken. Er is geen bezwaar tegen het gebruiken van een priv\u00e9 account binnen de github omgeving. Bij vertrek wordt je omgezet naar 'External Collaborator'. GitHub teams Er is een aantal teams gemaakt binnen Geonovum. Deze zijn te vinden op: https://github.com/orgs/Geonovum/teams. Ieder repository moet aan een team worden toegekend. Het team is aanspreekpunt voor het repository. Team namen eindigen op ' team'. Bijvoorbeeld 'DSO team'. GitHub repositories Dit zijn de Geonovum repositories: https://github.com/orgs/Geonovum/repositories. Er is ook een dashboard met een overzicht van publieke git repositories: DashboardGit . Richtlijnen voor het inrichten van repositories zijn er nog niet. Wel is er een template voor respec documenten: NL-ReSpec-GN-template Naamgevingsconventies GitHub Voor repositories met een ReSpec document zijn aparte naamgevingsconventies. Kies korte betekenisvolle namen die in lijn zijn met bestaande repositories. Veelgebruikte prefixes zijn: dso- digitale ondersteuning omgevingswet. ow- omgevingswet. Dit lijkt wel een duplicaat. Laten opgaan in dso-? KP-APIs- kennisplatform API's. xml_ Dit was een prefix voor dso repositories maar wordt voor nieuwe repositories niet meer gebruikt. disgeo- DisGeo","title":"Manual"},{"location":"GitHub/#github","text":"In dit hoofdstuk komen zowel GitHub als GitHub desktop client aan de orde. Geonovum heeft op github een eigen \u2018onderkomen\u2019 op: https://github.com/Geonovum . In dit hoofdstuk staat beschreven wat je moet doen om \u201cup-and-running\u201d te komen voor het uitvoeren van je beheertaken op GitHub. Hoe je een account aanmaakt, en hoe je de benodigde software installeert.","title":"GitHub"},{"location":"GitHub/#installatie-en-inrichting","text":"","title":"Installatie en inrichting"},{"location":"GitHub/#aanmaken-github-account","text":"Als je nog geen GitHub account hebt, of als je een apart GitHub account wil maken voor je Geonovum werkzaamheden, ga naar: https://github.com/join/get-started . Dan zie je het scherm dat hiernaast staat. Maak in dat scherm een usernaam aan waarmee je op GitHub gaat werken. Tip : als je met meerdere accounts gaat werken, zorg er dan voor dat aan de accountnaam kan zien waarvoor die dan gebruikt moet worden. (Bijvoorbeeld door die naam te eindigen op \u2013GNM). Verplicht is dit niet. Vul in het veld username je nieuwe GitHub naam in. Vul in het veld email adress je geonovum mailadres in Klik vervolgens op \u201cCreate Account\u201d en dan wordt je account aangemaakt. Kies in dit scherm je persoonlijke plan. Bij Geonovum gebruiken we de gratis versie, dus selecteer die.","title":"Aanmaken GitHub account"},{"location":"GitHub/#installeren-github-desktop","text":"Ga in je internet browser naar https://desktop.github.com/ Klik daar op download for Windows (64bit). Nu wordt de installer gedownload, en dat zie je linksonder in je browser zoals in het plaatje rechts: Na starten van de installer verschijnt het scherm hiernaast Het volgende scherm zal nu openen we hebben in de vorige stap al een account aangemaakt dus klik op Sign Into Github.com Na Klikken op Sign into Github.com, verschijnt dit scherm. Hier hoeft verder niks ingevuld te worden, dus klik op continue. In dit scherm kan je desgewenst het vinkje bij het versturen van anonieme data uitzetten. Daarna klikken op Finish. GitHub Desktop is nu ge\u00efnstalleerd.","title":"Installeren GitHub desktop"},{"location":"GitHub/#opties-voor-github-desktop","text":"GitHub Desktop kan worden aangepast aan persoonlijke voorkeuren. Dat doe je door in het hoofdscherm van de GitHub Desktop op het menu \u201cFile\u201d te klikken en vervolgens voor \u201cOpties\u201d te kiezen. In het Accounts scherm staat hoe je bent ingelogd bij GitHub. Hier kan je uitloggen en opnieuw inloggen als je meerdere GitHub Accounts hebt. In het tabblad \u201cGit\u201d kan je je Github Naam eventueel aanpassen. De GitHub Email is de email die intern binnen Github wordt gebruikt. Die hoeft niet gewijzigd te worden. In het tabblad \u201cAppearance\u201d kan je ervoor kiezen om in Light of Dark modus te werken. Hiermee verander je alleen de achtergrondkleur van de GitHub Desktop omgeving. In dit scherm kan je de voorkeurs editor instellen. Default wordt gekeken naar de reeds aanwezige tekst editors. Omdat GitHub van nature een samenwerkomgeving is voor het ontwikkelen van programmatuur, gaat het hier om \u201cplatte tekst\u201d editors.","title":"Opties voor GitHub desktop"},{"location":"GitHub/#werkwijze-geonovum","text":"","title":"Werkwijze Geonovum"},{"location":"GitHub/#de-geonovum-github-pagina","text":"Geonovum heeft een eigen GitHub Bedrijfspagina: https://github.com/Geonovum . Voor alle projecten die een product maken of beheren wordt een repository aangemaakt. Het aanmaken van een repository staat beschreven in paragraaf 2.3.1 .","title":"De Geonovum GitHub pagina"},{"location":"GitHub/#mappenstructuur-in-de-respository","text":"In de Repository maak je indien nodig submappen aan. Submappen zijn handig als er in je Repository meer dan \u00e9\u00e9n ReSpec document komt te staan. Over ReSpec meer in hoofdstuk 3. Hiernaast een afbeelding van de GitHub Repository voor MIM. Twee mappen omdat MIM twee documenten bevat. Ook maakt GitHub standaard een readme.md aan. De readme staat in het \u201cMarkdown\u201d formaat, waarover in de volgende paragraaf meer.","title":"Mappenstructuur in de respository"},{"location":"GitHub/#readmemd","text":"In de readme.md file staat nog eens beschreven Wat de inhoud van de Repository is. Neem ook de link naar de webversie van de documenten hier op, dan is het voor bezoekers gemakkelijker om het document te openen in een browser. Neem altijd een link naar https://docs.geostandaarden.nl/ op, en in het geval het technische documenten betreft zoals UML\u2019s, XSD\u2019s, GML\u2019s, XML\u2019s een link naar http://register.geostandaarden.nl/ in het Readme bestand op.","title":"Readme.md"},{"location":"GitHub/#aan-de-slag-met-github","text":"In deze paragraaf een beschrijving van hoe je in GitHub een nieuwe repository aanmaakt, en hoe je die synchroniseert met je lokale GitHub client.","title":"Aan de slag met GitHub"},{"location":"GitHub/#het-maken-van-een-nieuwe-repository","text":"Een nieuwe repository maak je aan in de Centrale GitHub omgeving. Klik in de banner bovenaan de pagina, naast je profielfoto op \u201c+\u201d en kies \u201cCreate Repository\u201d Nadat je op \u201c+\u201d hebt geklikt, verschijnt het scherm hieronder. Vul hier de naam van de repository in. Gebruik een naam die kort en bondig is. Zie ook verderop in dit document voor de naamgevingsconventies. Vul ook de beschrijving in van het project. Geef als local path de naam van de GitHub map op. GitHub zal dan de naam van de standaard als mapnaam aanmaken onder de lokale GitHub map. Het is wel zo netjes om een readme file aan te maken, hierin zet je een korte omschrijving van de repository. Klik vervolgens op \u201cCreate Repository\u201d","title":"Het maken van een nieuwe repository"},{"location":"GitHub/#github-clone-eerste-keer-ophalen-van-de-centrale-repository","text":"Start de GitHub Client, en kies in het menu File voor Clone Repository. En kies de Repository die je wil clonen (in dit geval Geonovum/MIM). Als Local Path kies je een logische plek op je PC/Laptop. (Tip: het is handig om \u00e9\u00e9n plek voor je Github Repositories te maken, bijvoorbeeld C:. Na het aanklikken van de knop clone wordt een lokale kopie gemaakt. Github weet welke versie je hebt opgehaald, en zal de wijzingen die je maakt netjes voor je bijhouden. In de map die je als local path hebt opgegeven komt de mappen structuur te staan zoals hierboven beschreven.","title":"GitHub Clone: eerste keer ophalen van de centrale repository"},{"location":"GitHub/#github-pull-origin-ophalen-van-wijzigingen","text":"Een pull commando werkt de lokale versie van je GitHub Repository bij. Wijzigingen die zijn gedaan in de centrale repository (dus op Github.com) worden ook doorgevoerd in je lokale kopie. Het uitvoeren van een pull doe je door in het menu Repository op pull te klikken. NB: Voer dit commando regelmatig uit als er meerdere mensen in de repository werken, om conflicterende wijzigingen te voorkomen.","title":"GitHub Pull origin: ophalen van wijzigingen"},{"location":"GitHub/#github-commit-to-master-wijzigingen-opslaan","text":"Met de knop Commit to master zet je de wijzigingen die je hebt gedaan klaar om te uploaden naar de Centrale GitHub Repository. GitHub maakt daartoe een versie aan, die je verplicht voorziet van een summary en optioneel van een Description Let op: met het committen heb je dus nog niks ge-upload.","title":"GitHub Commit to Master: wijzigingen opslaan"},{"location":"GitHub/#github-push-origin-of-pull-request-wijzigingen-uploaden","text":"Nadat je de wijzigingen hebt gecommit, moeten ze richting de centrale repository. Nu zijn er twee mogelijkheden. Ofwel je hebt schrijfrechten op de Centrale Repository, of je hebt ze niet. In het eerste geval kan je een Push Origin uitvoeren, dan worden de wijzigingen meteen in de Centrale GitHub Repository verwerkt. In het tweede geval doe je een Pull request bij de eigenaar van de Repository om de wijzigingen door te voeren. Github maakt dan een eigen versie voor je aan (dat heet een fork) en vraagt aan de eigenaar van de Repository om die fork te verwerken in de Centrale Repository.","title":"GitHub Push origin of Pull request: wijzigingen uploaden"},{"location":"GitHub/#enkele-regels-over-github-binnen-geonovum","text":"Geonovum heeft binnen github een team: https://github.com/Geonovum.","title":"Enkele regels over GitHub binnen Geonovum"},{"location":"GitHub/#github-beheer","text":"Github teamleden met beheerders rechten zijn te vinden via: https://github.com/orgs/Geonovum/people?query=role%3Aowner Daarnaast zijn er nog drie inhoudelijk beheerders vanuit Geonovum: Arnoud de Boer, Frank Terpstra en Linda vd Brink.","title":"Github beheer"},{"location":"GitHub/#github-gebruikers","text":"Een overzicht van de gebruikers is te vinden op: https://github.com/orgs/Geonovum/people. In principe geldt de regels: als je lid bent van Geonovum Teams dan hoor je ook bij de Geonovum GitHub organisatie. De inhoudelijk beheerders kunnen besluiten daar van af te wijken. Er is geen bezwaar tegen het gebruiken van een priv\u00e9 account binnen de github omgeving. Bij vertrek wordt je omgezet naar 'External Collaborator'.","title":"Github gebruikers"},{"location":"GitHub/#github-teams","text":"Er is een aantal teams gemaakt binnen Geonovum. Deze zijn te vinden op: https://github.com/orgs/Geonovum/teams. Ieder repository moet aan een team worden toegekend. Het team is aanspreekpunt voor het repository. Team namen eindigen op ' team'. Bijvoorbeeld 'DSO team'.","title":"GitHub teams"},{"location":"GitHub/#github-repositories","text":"Dit zijn de Geonovum repositories: https://github.com/orgs/Geonovum/repositories. Er is ook een dashboard met een overzicht van publieke git repositories: DashboardGit . Richtlijnen voor het inrichten van repositories zijn er nog niet. Wel is er een template voor respec documenten: NL-ReSpec-GN-template","title":"GitHub repositories"},{"location":"GitHub/#naamgevingsconventies-github","text":"Voor repositories met een ReSpec document zijn aparte naamgevingsconventies. Kies korte betekenisvolle namen die in lijn zijn met bestaande repositories. Veelgebruikte prefixes zijn: dso- digitale ondersteuning omgevingswet. ow- omgevingswet. Dit lijkt wel een duplicaat. Laten opgaan in dso-? KP-APIs- kennisplatform API's. xml_ Dit was een prefix voor dso repositories maar wordt voor nieuwe repositories niet meer gebruikt. disgeo- DisGeo","title":"Naamgevingsconventies GitHub"},{"location":"Handleiding-ontologie-maken-en-publiceren/","text":"Handleiding ontologie maken en publiceren Inleiding Naast UML-informatiemodellen en begrippenkaders maakt Geonovum wellicht in de toekomst ook meer ontologie\u00ebn. Momenteel is er \u00e9\u00e9n ontologie gepubliceerd: die van NEN 3610. Hier is gedocumenteerd hoe dat is gedaan. Ontologie genereren De ontologie is gegenereerd uit het NEN3610-informatiemodel op basis van de regels in MIM. Input : MIM UML-model Output : Ontologie in Turtle ( .ttl ) syntax en documentatie van de ontologie in Markdown ( .md ) syntax (op te nemen in ReSpec-document) In je UML-project is daarvoor nodig: - tagged value baseURI op packageniveau De ontologie is gegenereerd met scripts van Marco Brattinga. - Scripts staan in de repository NEN3610-werkomgeving - Het script dat je moet runnen is: convert.sh . Dit kun je lokaal doen (onder Windows moet je dit aanroepen in een batch-bestand) of we kunnen dit in een git workflow zetten zodat het script elke keer wordt uitgevoerd als je een EAP-bestand of MIM-XML-bestand pusht. Jesse Bakker heeft dit laatste binnen IMX-Geo gedaan. - Het script genereert met een aantal tussenstappen de uiteindelijke ontologie (RDF-bestand, .ttl ) en een markdown-bestand ( .md ) met documentatie, dat je in een ReSpec-document kunt opnemen. Naast Marco Brattinga hebben Linda, Pano, en Jesse Bakker (Kadaster) kennis van deze scripts. Regels voor de URI De URI (in EA: baseURI ) is de identifier URL van de ontologie. Het is belangrijk dat deze lange tijd stabiel blijft (dus geen projectnaam , organisatienaam , versieinformatie etc. erin opnemen). Samengevat gelden hiervoor de volgende regels: Moet beginnen met http://modellen.geostandaarden.nl/def/ Na /def/ volgt een korte naam Na de korte naam volgt een # Geen versie-aanduiding in de URI Voorbeeld: http://modellen.geostandaarden.nl/def/nen3610# Note Waarom geen versie Hierover is veel discussie geweest. In de LinkedData-wereld is het de gewoonte om geen versie in de URL te zetten. De belangrijkste reden hiervoor is dat de URI een identificatie is. Als deze per versie zou wijzigen, zou dat eigenlijk betekenen dat het een nieuwe ontologie is en dat alles dat erin staat een nieuwe betekenis heeft. Dit is bijna nooit echt wat je wilt. De klasse Gebouw uit NEN3610:2011 is in essentie nog steeds dezelfde als de klasse Gebouw uit NEN3610:2022. Mogelijk is de definitie en daarmee populatie een enigszins veranderd. Dat wil zeggen: misschien zit er tussen beide definities een verschil tussen wat je als een gebouw beschouwt. Maar in essentie bedoel je nog steeds hetzelfde, dus verander je dan niet de identificatie. Een andere reden om geen versie in de URI op te nemen is dat dit voorkomt dat je alle data die de ontologie gebruikt, moet updaten als de URI gewijzigd is vanwege een nieuwe versie van de ontologie. Kwaliteitscontrole Controleer het gegenereerde .ttl-bestand op correcte syntax met behulp van een online validator . Publiceren De ontologie is gepubliceerd op http://modellen.geostandaarden.nl Beheerders, oa Linda en Pano hebben de FTP-toegang hiervan. De ontologie is gepubliceerd in vier bestandsformaten: - HTML ( .html ) - Turtle ( .ttl ) - RDF/XML ( .rdf ) - JSON-LD ( .json ) Het .ttl -bestand is automatisch geconverteerd naar RDF/XML en JSON-LD met behulp van een online conversietool . Folderstructuur en rootfolder De folderstructuur op de webserver is als volgt: / index.html .htaccess /def /nen3610 /nen36102022 In de root / staat een bestand index.html dat de content bevat die je ziet in je browser als je naar http://modellen.geostandaarden.nl gaat. Dit bestand wordt handmatig beheerd . Het moet worden aangepast als er meer ontologie\u00ebn bij komen. In de root / staat verder een .htaccess -bestand. Dat is een webserverscript dat ervoor zorgt dat een verzoek om de ontologie, afhankelijk van de client, de webserver het juiste bestandsformaat laat teruggeven. Als een gebruiker met een webbrowser om http://modellen.geostandaarden.nl/def/nen3610# vraagt, geeft de webserver een html -bestand terug dat de browser kan tonen en de gebruiker kan lezen. Als een gebruiker met een ontologie-editor vraagt om dezelfde URL, geeft de webserver bijvoorbeeld het .ttl -bestand terug. Het .htaccess -bestand is gemaakt door Linda en Pano en wordt beheerd in github. Ontologie-bestanden op de webserver De ontologie-bestanden .ttl , .rdf en .json staan in /def . De ontologie is zowel als bestand met versieloze bestandsnaam en als bestand met versieaanduiding opgeslagen. NEN3610 gebruikt een jaartal , maar semantic versioning is ook toegestaan. /def nen3610.ttl nen3610.rdf nen3610.json nen3610-2022.ttl nen3610-2022.rdf nen3610-2022.json HTML-bestanden op de webserver De .html -bestanden staan in twee subfolders, eentje met versieaanduiding en eentje zonder . De versieloze folder bevat altijd dezelfde inhoud als de nieuwste versie. /nen3610 index.html /nen36102022 index.html Opname in vocabulary catalogus En pagina over de NEN3610-ontologie is daarnaast ook op Linked Open Vocabularies (LOV) gepubliceerd, een online catalogus van ontologie\u00ebn. Dit is aangevraagd via een email naar de beheerders via de contactlink. De beheerders controleren de ontologie en geven tips ter verbetering. NEN3610 staat hier . FAIR ontologie Om te zorgen dat de ontologie vindbaar en bruikbaar is, zijn er aanvullende regels. Deze zijn gebaseerd op de regels voor FAIR-ontologie\u00ebn van Linked Open Vocabularies , de vindplaats van ontologie\u00ebn waar NEN3610 ook in is opgenomen. Hun regels zijn ook beschreven in een goed leesbare paper. De manier waarop de NEN3610-ontologie is gepubliceerd is hierop gebaseerd. Metadata De volgende metadata dient te worden opgenomen in de ontologie: Versie-informatie: owl:versionIRI en owl:versionInfo license (CC-BY) creator , eventueel contributor , creationDate en (als die bestaat) previousVersion prefix , title and description source : verwijzing naar informatiemodel waar de ontologie op gebaseerd is publisher : verwijzing naar Geonovum Vertaling naar het Engels Het wordt aangeraden om de ontologie te vertalen naar het Engels (dit kan in hetzelfde bestand, door verschillende talige labels aan de klassen en eigenschappen te geven). Voor NEN3610 wordt dit overwogen. Relatie met andere ontologie\u00ebn Het is good practice om de ontologie te relateren aan andere ontologie\u00ebn, met name aan NEN3610, GeoSPARQL, OWL Time, de Semantic Sensor Network Ontology (SSN), NEN 2660 etc. Voor NEN3610 is dit nog niet gedaan. Hiervoor zijn een aantal standaardrelaties beschikbaar, zoals; - equivalentClass - equivalentProperty - subClassOf - subPropertyOf Relatie met andere ontologie\u00ebn in Enterprise Architect In Enterprise Architect is het mogelijk om deze relaties aan te geven. De ontologie-generator zet ze dan ook in de ontologie, maar het mechanisme is nog niet gestandaardiseerd in MIM. De Generatie MIM-ontologie is ontwikkeld in het WaU als onderdeel van het IMX-Geo-project. Om aan te geven dat iets uit je model precies hetzelfde is als iets uit een ander model: Tagged value uri bij klassen , attributen en relaties ; gevuld met de URI van de ontologie plus de identifier van de klasse of eigenschap in de ontologie (de MIM naam). Dit wordt vertaald naar equivalentClass of equivalentProperty . Om aan te geven dat iets een subklasse of -eigenschap is van een klasse of eigenschap uit een ander model, is er nu nog geen methode. Voorbeeld relatie met andere ontologie IMX-Geo en NEN3610 De attributen domein en identificatie komen uit NEN3610. domein heeft Tagged value: uri = http: http://modellen.geostandaarden.nl/def/nen3610-2022#domein identificatie heeft Tagged value: uri = http://modellen.geostandaarden.nl/def/nen3610-2022#identificatie","title":"Ontologie"},{"location":"Handleiding-ontologie-maken-en-publiceren/#handleiding-ontologie-maken-en-publiceren","text":"","title":"Handleiding ontologie maken en publiceren"},{"location":"Handleiding-ontologie-maken-en-publiceren/#inleiding","text":"Naast UML-informatiemodellen en begrippenkaders maakt Geonovum wellicht in de toekomst ook meer ontologie\u00ebn. Momenteel is er \u00e9\u00e9n ontologie gepubliceerd: die van NEN 3610. Hier is gedocumenteerd hoe dat is gedaan.","title":"Inleiding"},{"location":"Handleiding-ontologie-maken-en-publiceren/#ontologie-genereren","text":"De ontologie is gegenereerd uit het NEN3610-informatiemodel op basis van de regels in MIM. Input : MIM UML-model Output : Ontologie in Turtle ( .ttl ) syntax en documentatie van de ontologie in Markdown ( .md ) syntax (op te nemen in ReSpec-document) In je UML-project is daarvoor nodig: - tagged value baseURI op packageniveau De ontologie is gegenereerd met scripts van Marco Brattinga. - Scripts staan in de repository NEN3610-werkomgeving - Het script dat je moet runnen is: convert.sh . Dit kun je lokaal doen (onder Windows moet je dit aanroepen in een batch-bestand) of we kunnen dit in een git workflow zetten zodat het script elke keer wordt uitgevoerd als je een EAP-bestand of MIM-XML-bestand pusht. Jesse Bakker heeft dit laatste binnen IMX-Geo gedaan. - Het script genereert met een aantal tussenstappen de uiteindelijke ontologie (RDF-bestand, .ttl ) en een markdown-bestand ( .md ) met documentatie, dat je in een ReSpec-document kunt opnemen. Naast Marco Brattinga hebben Linda, Pano, en Jesse Bakker (Kadaster) kennis van deze scripts.","title":"Ontologie genereren"},{"location":"Handleiding-ontologie-maken-en-publiceren/#regels-voor-de-uri","text":"De URI (in EA: baseURI ) is de identifier URL van de ontologie. Het is belangrijk dat deze lange tijd stabiel blijft (dus geen projectnaam , organisatienaam , versieinformatie etc. erin opnemen). Samengevat gelden hiervoor de volgende regels: Moet beginnen met http://modellen.geostandaarden.nl/def/ Na /def/ volgt een korte naam Na de korte naam volgt een # Geen versie-aanduiding in de URI Voorbeeld: http://modellen.geostandaarden.nl/def/nen3610# Note Waarom geen versie Hierover is veel discussie geweest. In de LinkedData-wereld is het de gewoonte om geen versie in de URL te zetten. De belangrijkste reden hiervoor is dat de URI een identificatie is. Als deze per versie zou wijzigen, zou dat eigenlijk betekenen dat het een nieuwe ontologie is en dat alles dat erin staat een nieuwe betekenis heeft. Dit is bijna nooit echt wat je wilt. De klasse Gebouw uit NEN3610:2011 is in essentie nog steeds dezelfde als de klasse Gebouw uit NEN3610:2022. Mogelijk is de definitie en daarmee populatie een enigszins veranderd. Dat wil zeggen: misschien zit er tussen beide definities een verschil tussen wat je als een gebouw beschouwt. Maar in essentie bedoel je nog steeds hetzelfde, dus verander je dan niet de identificatie. Een andere reden om geen versie in de URI op te nemen is dat dit voorkomt dat je alle data die de ontologie gebruikt, moet updaten als de URI gewijzigd is vanwege een nieuwe versie van de ontologie.","title":"Regels voor de URI"},{"location":"Handleiding-ontologie-maken-en-publiceren/#kwaliteitscontrole","text":"Controleer het gegenereerde .ttl-bestand op correcte syntax met behulp van een online validator .","title":"Kwaliteitscontrole"},{"location":"Handleiding-ontologie-maken-en-publiceren/#publiceren","text":"De ontologie is gepubliceerd op http://modellen.geostandaarden.nl Beheerders, oa Linda en Pano hebben de FTP-toegang hiervan. De ontologie is gepubliceerd in vier bestandsformaten: - HTML ( .html ) - Turtle ( .ttl ) - RDF/XML ( .rdf ) - JSON-LD ( .json ) Het .ttl -bestand is automatisch geconverteerd naar RDF/XML en JSON-LD met behulp van een online conversietool .","title":"Publiceren"},{"location":"Handleiding-ontologie-maken-en-publiceren/#folderstructuur-en-rootfolder","text":"De folderstructuur op de webserver is als volgt: / index.html .htaccess /def /nen3610 /nen36102022 In de root / staat een bestand index.html dat de content bevat die je ziet in je browser als je naar http://modellen.geostandaarden.nl gaat. Dit bestand wordt handmatig beheerd . Het moet worden aangepast als er meer ontologie\u00ebn bij komen. In de root / staat verder een .htaccess -bestand. Dat is een webserverscript dat ervoor zorgt dat een verzoek om de ontologie, afhankelijk van de client, de webserver het juiste bestandsformaat laat teruggeven. Als een gebruiker met een webbrowser om http://modellen.geostandaarden.nl/def/nen3610# vraagt, geeft de webserver een html -bestand terug dat de browser kan tonen en de gebruiker kan lezen. Als een gebruiker met een ontologie-editor vraagt om dezelfde URL, geeft de webserver bijvoorbeeld het .ttl -bestand terug. Het .htaccess -bestand is gemaakt door Linda en Pano en wordt beheerd in github.","title":"Folderstructuur en rootfolder"},{"location":"Handleiding-ontologie-maken-en-publiceren/#ontologie-bestanden-op-de-webserver","text":"De ontologie-bestanden .ttl , .rdf en .json staan in /def . De ontologie is zowel als bestand met versieloze bestandsnaam en als bestand met versieaanduiding opgeslagen. NEN3610 gebruikt een jaartal , maar semantic versioning is ook toegestaan. /def nen3610.ttl nen3610.rdf nen3610.json nen3610-2022.ttl nen3610-2022.rdf nen3610-2022.json","title":"Ontologie-bestanden op de webserver"},{"location":"Handleiding-ontologie-maken-en-publiceren/#html-bestanden-op-de-webserver","text":"De .html -bestanden staan in twee subfolders, eentje met versieaanduiding en eentje zonder . De versieloze folder bevat altijd dezelfde inhoud als de nieuwste versie. /nen3610 index.html /nen36102022 index.html","title":"HTML-bestanden op de webserver"},{"location":"Handleiding-ontologie-maken-en-publiceren/#opname-in-vocabulary-catalogus","text":"En pagina over de NEN3610-ontologie is daarnaast ook op Linked Open Vocabularies (LOV) gepubliceerd, een online catalogus van ontologie\u00ebn. Dit is aangevraagd via een email naar de beheerders via de contactlink. De beheerders controleren de ontologie en geven tips ter verbetering. NEN3610 staat hier .","title":"Opname in vocabulary catalogus"},{"location":"Handleiding-ontologie-maken-en-publiceren/#fair-ontologie","text":"Om te zorgen dat de ontologie vindbaar en bruikbaar is, zijn er aanvullende regels. Deze zijn gebaseerd op de regels voor FAIR-ontologie\u00ebn van Linked Open Vocabularies , de vindplaats van ontologie\u00ebn waar NEN3610 ook in is opgenomen. Hun regels zijn ook beschreven in een goed leesbare paper. De manier waarop de NEN3610-ontologie is gepubliceerd is hierop gebaseerd.","title":"FAIR ontologie"},{"location":"Handleiding-ontologie-maken-en-publiceren/#metadata","text":"De volgende metadata dient te worden opgenomen in de ontologie: Versie-informatie: owl:versionIRI en owl:versionInfo license (CC-BY) creator , eventueel contributor , creationDate en (als die bestaat) previousVersion prefix , title and description source : verwijzing naar informatiemodel waar de ontologie op gebaseerd is publisher : verwijzing naar Geonovum","title":"Metadata"},{"location":"Handleiding-ontologie-maken-en-publiceren/#vertaling-naar-het-engels","text":"Het wordt aangeraden om de ontologie te vertalen naar het Engels (dit kan in hetzelfde bestand, door verschillende talige labels aan de klassen en eigenschappen te geven). Voor NEN3610 wordt dit overwogen.","title":"Vertaling naar het Engels"},{"location":"Handleiding-ontologie-maken-en-publiceren/#relatie-met-andere-ontologieen","text":"Het is good practice om de ontologie te relateren aan andere ontologie\u00ebn, met name aan NEN3610, GeoSPARQL, OWL Time, de Semantic Sensor Network Ontology (SSN), NEN 2660 etc. Voor NEN3610 is dit nog niet gedaan. Hiervoor zijn een aantal standaardrelaties beschikbaar, zoals; - equivalentClass - equivalentProperty - subClassOf - subPropertyOf","title":"Relatie met andere ontologie\u00ebn"},{"location":"Handleiding-ontologie-maken-en-publiceren/#relatie-met-andere-ontologieen-in-enterprise-architect","text":"In Enterprise Architect is het mogelijk om deze relaties aan te geven. De ontologie-generator zet ze dan ook in de ontologie, maar het mechanisme is nog niet gestandaardiseerd in MIM. De Generatie MIM-ontologie is ontwikkeld in het WaU als onderdeel van het IMX-Geo-project. Om aan te geven dat iets uit je model precies hetzelfde is als iets uit een ander model: Tagged value uri bij klassen , attributen en relaties ; gevuld met de URI van de ontologie plus de identifier van de klasse of eigenschap in de ontologie (de MIM naam). Dit wordt vertaald naar equivalentClass of equivalentProperty . Om aan te geven dat iets een subklasse of -eigenschap is van een klasse of eigenschap uit een ander model, is er nu nog geen methode.","title":"Relatie met andere ontologie\u00ebn in Enterprise Architect"},{"location":"Handleiding-ontologie-maken-en-publiceren/#voorbeeld-relatie-met-andere-ontologie-imx-geo-en-nen3610","text":"De attributen domein en identificatie komen uit NEN3610. domein heeft Tagged value: uri = http: http://modellen.geostandaarden.nl/def/nen3610-2022#domein identificatie heeft Tagged value: uri = http://modellen.geostandaarden.nl/def/nen3610-2022#identificatie","title":"Voorbeeld relatie met andere ontologie IMX-Geo en NEN3610"},{"location":"Imvertor/","text":"Imvertor TODO: invullen vanuit de volgende documenten Imvertor wordt veel gebruikt binnen Geonovum voor het transformeren van UML modellen naar bijvoorbeeld xml-schema\u2019s of feature catalogues. De instructies van hoe er mee om te gaan zijn overal verspreid. Op deze pagina probeer ik alles te verzamelen\u2026. onderwerp verwijzing Imvertor-properties Uitleg verschillende properties Algemeen Verzamelde handleiding van organisaties Algemeen Repository co\u00f6rdinatie Imvertor gebruik Geonovum Werkinstructie IMGeluid werkinstructie Imvertor meldingen Meldingen Uitleg schema mapping Hier Denk hier aan Een Imvertor run levert een flink aantal UML diagrammen op in de data folder. Niet meer gebruikt diagrammen worden nooit verwijderd uit deze folder waardoor er vaak veel niet gebruikt diagrammen in staan. Tip: gooi voor het draaien van Imvertor de data map een keer leeg.","title":"Imvertor"},{"location":"Imvertor/#imvertor","text":"TODO: invullen vanuit de volgende documenten Imvertor wordt veel gebruikt binnen Geonovum voor het transformeren van UML modellen naar bijvoorbeeld xml-schema\u2019s of feature catalogues. De instructies van hoe er mee om te gaan zijn overal verspreid. Op deze pagina probeer ik alles te verzamelen\u2026. onderwerp verwijzing Imvertor-properties Uitleg verschillende properties Algemeen Verzamelde handleiding van organisaties Algemeen Repository co\u00f6rdinatie Imvertor gebruik Geonovum Werkinstructie IMGeluid werkinstructie Imvertor meldingen Meldingen Uitleg schema mapping Hier","title":"Imvertor"},{"location":"Imvertor/#denk-hier-aan","text":"Een Imvertor run levert een flink aantal UML diagrammen op in de data folder. Niet meer gebruikt diagrammen worden nooit verwijderd uit deze folder waardoor er vaak veel niet gebruikt diagrammen in staan. Tip: gooi voor het draaien van Imvertor de data map een keer leeg.","title":"Denk hier aan"},{"location":"MIM-toolbox-genereren-extensie/","text":"Handleiding - Extensie maken op MIM-toolbox Software/Standaard Versie MIM-standaard 1.1.1 MIM-toolbox 1.1.1 Enterprise Architect (EA) 15.2 Inhoud Beschrijving Importeer de MIM-toolbox in de EA-omgeving Maak de package-structuur aan voor de extensie Modelleer de toolbox-extensie Modelleer het toolbox-menu Modelleer het diagram Genereer MDG Technology Werken met de toolbox Beschrijving Deze handleiding beschrijft hoe je in Enterprise Architect een extensie maakt op de MIM-toolbox . Dit is van toepassing als er extra metamodelconstructies nodig zijn voor het maken van een informatiemodel. Meer informatie en spelregels hiervoor vind je in de MIM-standaard . Een extensie op de MIM-toolbox is ook bedoeld voor het maken van aanvullende constructies die alleen spelen op het niveau van implementatie, of op het niveau van afgeleide technsiche modellen ten behoeve van specifieke interfaces. Met een extensie breidt je MIM-toolbox uit. Dit is handig wanneer je extra informatie aan modelonderdelen (bijv. objecttypen) wilt toevoegen. Bijvoorbeeld voor: - het uitbreiden van de set met metagegevens voor modelonderdelen van een specifiek sector-/domeinmodel (extra tagged values); - het uitbreiden van de set met metagegevens voor specifieke toepassingen van het model, zoals bijvoorbeeld in Imvertor of voor een UML-JSON-encodings; - het het toevoegen van extra stereotypen. Deze handleiding neemt het maken van een DiSGeo-extensie op MIM als voorbeeld . Voor het informatiemodel DiSGeo zijn voor de MIM-stereotypen \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb meta-informatie nodig in de vorm van extra tagged values . Voor Objecttype gaat dat om het toevoegen van Actualiteit en Inwinning verplicht . Voor Attribuutsoort zijn dat: Inwinningsregels en Positionele juistheid . Voorbereiding Zorg dat je de volgende twee zaken bij de hand hebt: 1. Enterprise Architect: Het is handig om de volgende venster te openen - Browser - Toolbox - Properties - Features 1. De MIM-toolbox waarop je een extensie wilt bouwen, in de vorm van een MDG Technology (.xml). Hier vind je de meest actuele versie van de toolbox Stap 1: Importeer de MIM-toolbox in de EA-omgeving Open de project browser . Klik op de tab Resources . Klik op de map MDG Technologies . Klik met de rechtermuisknop op Model Technologies en selecteer Import Technology . Open de MDG Technology (dit bestand heeft een .xml -extensie) van de MIM-toolbox. Klik Openen . Selecteer daar linksonderin het diagloogvenster Import To Model en klik vervolgens op OK . Indien je geen foutmelding krijgt, heb je de MIM-toolbox succesvol ge\u00efmporteerd. Stap 2: Maak de package-structuur aan voor de extensie Klik in de project browser linksbovenin op de map met het gele sterretje , of druk Ctrl+Shift+M . Hierdoor open de Model Wizard . Selecteer het tabblad Model Patterns . Klik daaronder op Model Technologies Perspective . Ga naar Management en selecter vervolgens: MDG Technology Builder . In het venster verschijnen nu verschillende Model Patterns . Dit zijn templates voor het maken van modellen. Kies nu onder MDG Technology Builder voor Basic Template en klik linksonderin op Create Pattern(s) . Geef in het dialoogvenster dat nu verschijnt de naam van de extensie op die je gaat maken (bijvoorbeeld 'DISGEO') en klik op OK . In de project browser zie dat er nu een nieuwe package DiSGeo is toegevoegd. Dat package bevat een - diagram ; - een \u00abprofile\u00bb ; - een \u00abdiagram profile\u00bb ; - en een \u00abtoolbox profile\u00bb . Je hebt nu succesvol de package structuur aangemaakt. Stap 3: Modelleer de toolbox-extensie Vouw het package \u00abprofile\u00bbDISGEO uit Dubbelklik op het diagram Hierdoor opent het diagram en verschijnt de bijbehorende toolbox: UML::Profile Ga in het toolboxmenu naar Metaclass en sleep dit element in het diagram. Er verschijnt nu een venster Extend Metaclass . Klik in de linkerkolom op Stereotypes . Hierdoor verschijnen aan de rechterkant alle stereotypen die MIM kent. Let op : deze zijn alleen beschikbaarbaar nadat je de MIM-toolbox hebt ge\u00efmporteerd (zie: stap: 1 ). Zoek in de lijst aan de rechterkant \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb op, selecteer deze en klik op OK . Deze worden nu toegevoegd aan het diagram. Zoek nu in het toolboxmenu Add Stereotype op (onder Profile Helpers ) en sleep dit element op het diagram. Er verschijnt nu een venster Add Stereotype . We gaan nu een stereotype maken dat dient als extensie op het MIM-stereotype \u00abAttribuutsoort\u00bb . Geef een naam op voor het stereotype. In het geval van dit voorbeeld is gekozen voor Attribuutsoort , maar dit kan elke andere willekeurige naam zijn. Klik vervogens op de button Add Metaclass . Hier geef je de UML-metaklasse uit EA op waarop je extensie plaatsvindt. Als je niet weet van welke UML-metaklasse je stereotype wordt afgeleid, zoek dit dan op in het MIM-profiel. Info : In hoofdstuk 3 van de MIM-standaard staat beschreven van welke UML-metaklasse elk MIM-stereotype is afgeleid. Omdat je een extensie maakt op MIM, is de nieuwe extensie automatisch \u00f3\u00f3k een extensie op een UML-type. Desondanks moet je dit in Enterprise Architect expliciet benoemen. Laat de overige instellingen staan en klik op Volgende . In dit venster, Define Tagged Values , kun je de extra metadata-elementen opvoeren. Klik met de rechtermuisknop in de kolom Property Kies uit het menu Add Tagged Value . Voer een naam op voor de tagged value. In het geval van dit voorbeeld Actualiteit . In de linkerkolom kun je nog een standaardwaarde opvoeren, maar dat is niet verplicht. In dit voorbeeld blijft dit veld leeg. Herhaal deze stap voor alle tagged values die je aan dit element wilt toevoegen. Als je klaar bent, kun je bovenstaande stappen herhalen voor \u00abObjecttype\u00bb . Klik daarna op Voltooien Je ziet nu het nieuwe stereotype met de tagged values. Daarnaast heeft het nu een relatie met de UML-metaklasse \u00abAttribute\u00bb . Als laatste onderdeel van deze stap moet nu de relatie gelegd worden tussen het nieuwe stereotype en het MIM-stereotype. Dit gaat als volgt: Klik nu op het element Attribuutsoort . Er verschijnen nu rechts van het element een aantal iconen. Klik op de witte pijl ( QuickLinker ) met de muisknop ingedrukt en sleep dit naar het bijbehorende MIM-type (het bovenste icoon) Kies uit het menu dat nu verschijnt voor Generalization . Je extensie-type heeft nu een relatie met MIM::Attribuutsoort \u00e9n UML::Attribute . Herhaal deze stappen voor \u00abObjecttype\u00bb . Als laatste stap is het handig om het kleurenschema van het modelelement gelijk te maken aan dat van MIM. Dat gaat als volgt: Klik met de rechtermuisknop op het nieuwe element Objecttype . Navigeer naar Appearance en klik op Default Appearance . Nu opent een venster met dezelfde naam. Klik op Background Color . Klik op More Colors . Selecteer het tabblad Custom . En vul vervolgens onderstaande waarden in: Hue: 128 Sat: 245 Lum: 230 Red: 206 Green: 253 Blue: 254 Klik op OK . Zet Border Color en Font Color op zwart . Klik op OK . Herhaal deze stap voor de andere modelelementen, in dit geval Attribuutsoort . Je hebt nu succesvol het profiel van je extensie aangemaakt. Stap 4: Modelleer het toolbox-menu In deze stap maak je de menupagina van de toolbox. Hiermee bepaal je hoe en welke stereotypes zichtbaar zijn in het menu. Het doel van de DiSGeo-extensie is om bestaande MIM-stereotypen uitbreiden met extra tagged values . Daarvoor introduceerden we in EA onder de moterkap weliswaar twee nieuwe stereotypen ( \u00abObjectype\u00bb en \u00abAttribuutsoort\u00bb ), maar die willen we niet expliciet terugzien in de toolbox. In de toolbox willen we \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb aanbieden. Open het lege diagram uit het package \u00abtoolbox profile\u00bbDISGEO . Sleep uit de toolbox die bij dit diagram hoort de Profile Helper Add Toolbox Page op het diagram. Het venster Add Toolbox Page opent nu. Vul de naam in van de toolboxpagina die je wilt maken. In dit geval maken we een kopie van de MIM-toolbox, dus noemen we deze (eerste) pagina: MIM: Objecten en attributen . Klik vervolgens op de Add-button en selecteer de optie Add Stereotype . Het venster Select A Profile Element opent nu. Navigeer naar het package \u00abprofile\u00bb DISGEO en selecter \u00abstereotype\u00bbObjecttype en klik op OK . In de eerste rij van de tabel in het venster Add Toolbox Page , is nu dit stereotype toegevoegd. Voor de leesbaarheid is het fijn om het type een alias mee te geven (anders heet het toolbox-item DISGEO::Objectype(UML::Class) . Vanwege het eerder genoemde uitgangspunt, krijgt dit stereotype het alias 'Objecttype' . Voeg nu op dezelfde manier 'Attribuutsoort' toe en klik nog niet op OK! . Je hebt nu de twee nieuwe stereotypes toegevoeg aan de toolboxpagina: + DISGEO::Objecttype(UML::Class) + DISGEO::Attribuutsoort(UML::Attribute) In de MIM-toolbox heeft deze pagina nog drie andere stereotypes. Deze kun je uit het package MIM-UML halen. Deze beschrijving gaat ervan uit dat je hierover beschikt. Klik nogmaals op de Add-button en navigeer nu naar het package \u00abMIM-UMLprofile\u00bb en voeg de volgende elementen toe: DISGEO::Objecttype(UML::Class) DISGEO::Attribuutsoort(UML::Attribute) + MIM::Gegevensgroep(UML::Attribute) + MIM::Gegevensgroeptype(UML::Class) + MIM_Keuzeattribuut::Keuze(UML::Attribute) Geef ze de bijbehorende aliassen uit het MIM-profiel Klik nu op OK . Voeg de toolboxpage toe voor MIM-Relaties , MIM-Datatypen , MIM-Waardelijsten en MIM-Packages . Herhaal hiervoor de voorgaande stappen . Je hebt nu met succes het toolboxmenu gemaakt. Het is in alle gevallen mogelijk om de namen van de stereotypen met de hand op te voeren. De schrijfwijze luistert heel nauw, dus heeft het de voorkeur gebruik te maken van Add Stereotype . Stap 5: Modelleer het diagram Open het lege diagram uit het package \u00abDiagram Profile\u00bbDISGEO . Sleept uit de toolbox die bij dit diagram hoort de Profile Helper Add Diagram Extention op het diagram. Het venster Add Diagram Extention opent nu. Geef een naam op voor het diagram en kies bij Extention Type voor Class . Geef bij Description eventueel een beschrijving op voor de toepassing van dit diagram. Het is handig om hier te vermelden dat je dit diagram nodig hebt om voor de MIM-toolbox inclusief extensie! Vouw onder Properties de lijst met General uit. Kies bij Toolbox Profile uit de lijst met namen, de naam van het profiel, in dit geval: DISGEO en klik op OK . Klik nu op het modelelement \u00abmetaclass\u00bb Diagram Logical en voeg bij Features een nieuw attribuut toe met de naam: toolboxPage . Vul bij Initial Value de het volgende in: MIM: Objecten en attributen=1;MIM: Relaties=1;MIM: Datatypen=1;MIM: Waardelijsten=1;MIM: Packages=1;UML: Connectors=0; Dit geeft aan welke onderdelen van de het toolbox menu uit- (waarde: 1 ) of ingevouwen (waarde: 0 ) zijn. Je hebt nu succesvol een Diagram Profile aangemaakt. Stap 6: Genereer MDG Technology Je hebt nu succesvol de volgende drie profielen gemaakt: - \u00abprofile\u00bbDISGEO - \u00abdiagram profile\u00bbDISGEO - \u00abtoolbox profile\u00bbDISGEO In de volgende stap lees je hoe je de profielen publiceert Volg deze link voor een beschrijving. Nadat je elk profiel gepubliceert hebt, 'bundel' je ze in een MDG Technology. Hoe je dat doet, lees je hier Stap 7: Werken met de toolbox Bekijk de meest actuele handleiding voor het gebruik van toolboxen in EA.","title":"Toolbox genereren extensie"},{"location":"MIM-toolbox-genereren-extensie/#handleiding-extensie-maken-op-mim-toolbox","text":"Software/Standaard Versie MIM-standaard 1.1.1 MIM-toolbox 1.1.1 Enterprise Architect (EA) 15.2","title":"Handleiding - Extensie maken op MIM-toolbox"},{"location":"MIM-toolbox-genereren-extensie/#inhoud","text":"Beschrijving Importeer de MIM-toolbox in de EA-omgeving Maak de package-structuur aan voor de extensie Modelleer de toolbox-extensie Modelleer het toolbox-menu Modelleer het diagram Genereer MDG Technology Werken met de toolbox","title":"Inhoud"},{"location":"MIM-toolbox-genereren-extensie/#beschrijving","text":"Deze handleiding beschrijft hoe je in Enterprise Architect een extensie maakt op de MIM-toolbox . Dit is van toepassing als er extra metamodelconstructies nodig zijn voor het maken van een informatiemodel. Meer informatie en spelregels hiervoor vind je in de MIM-standaard . Een extensie op de MIM-toolbox is ook bedoeld voor het maken van aanvullende constructies die alleen spelen op het niveau van implementatie, of op het niveau van afgeleide technsiche modellen ten behoeve van specifieke interfaces. Met een extensie breidt je MIM-toolbox uit. Dit is handig wanneer je extra informatie aan modelonderdelen (bijv. objecttypen) wilt toevoegen. Bijvoorbeeld voor: - het uitbreiden van de set met metagegevens voor modelonderdelen van een specifiek sector-/domeinmodel (extra tagged values); - het uitbreiden van de set met metagegevens voor specifieke toepassingen van het model, zoals bijvoorbeeld in Imvertor of voor een UML-JSON-encodings; - het het toevoegen van extra stereotypen. Deze handleiding neemt het maken van een DiSGeo-extensie op MIM als voorbeeld . Voor het informatiemodel DiSGeo zijn voor de MIM-stereotypen \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb meta-informatie nodig in de vorm van extra tagged values . Voor Objecttype gaat dat om het toevoegen van Actualiteit en Inwinning verplicht . Voor Attribuutsoort zijn dat: Inwinningsregels en Positionele juistheid .","title":"Beschrijving"},{"location":"MIM-toolbox-genereren-extensie/#voorbereiding","text":"Zorg dat je de volgende twee zaken bij de hand hebt: 1. Enterprise Architect: Het is handig om de volgende venster te openen - Browser - Toolbox - Properties - Features 1. De MIM-toolbox waarop je een extensie wilt bouwen, in de vorm van een MDG Technology (.xml). Hier vind je de meest actuele versie van de toolbox","title":"Voorbereiding"},{"location":"MIM-toolbox-genereren-extensie/#stap-1-importeer-de-mim-toolbox-in-de-ea-omgeving","text":"Open de project browser . Klik op de tab Resources . Klik op de map MDG Technologies . Klik met de rechtermuisknop op Model Technologies en selecteer Import Technology . Open de MDG Technology (dit bestand heeft een .xml -extensie) van de MIM-toolbox. Klik Openen . Selecteer daar linksonderin het diagloogvenster Import To Model en klik vervolgens op OK . Indien je geen foutmelding krijgt, heb je de MIM-toolbox succesvol ge\u00efmporteerd.","title":"Stap 1: Importeer de MIM-toolbox in de EA-omgeving"},{"location":"MIM-toolbox-genereren-extensie/#stap-2-maak-de-package-structuur-aan-voor-de-extensie","text":"Klik in de project browser linksbovenin op de map met het gele sterretje , of druk Ctrl+Shift+M . Hierdoor open de Model Wizard . Selecteer het tabblad Model Patterns . Klik daaronder op Model Technologies Perspective . Ga naar Management en selecter vervolgens: MDG Technology Builder . In het venster verschijnen nu verschillende Model Patterns . Dit zijn templates voor het maken van modellen. Kies nu onder MDG Technology Builder voor Basic Template en klik linksonderin op Create Pattern(s) . Geef in het dialoogvenster dat nu verschijnt de naam van de extensie op die je gaat maken (bijvoorbeeld 'DISGEO') en klik op OK . In de project browser zie dat er nu een nieuwe package DiSGeo is toegevoegd. Dat package bevat een - diagram ; - een \u00abprofile\u00bb ; - een \u00abdiagram profile\u00bb ; - en een \u00abtoolbox profile\u00bb . Je hebt nu succesvol de package structuur aangemaakt.","title":"Stap 2: Maak de package-structuur aan voor de extensie"},{"location":"MIM-toolbox-genereren-extensie/#stap-3-modelleer-de-toolbox-extensie","text":"Vouw het package \u00abprofile\u00bbDISGEO uit Dubbelklik op het diagram Hierdoor opent het diagram en verschijnt de bijbehorende toolbox: UML::Profile Ga in het toolboxmenu naar Metaclass en sleep dit element in het diagram. Er verschijnt nu een venster Extend Metaclass . Klik in de linkerkolom op Stereotypes . Hierdoor verschijnen aan de rechterkant alle stereotypen die MIM kent. Let op : deze zijn alleen beschikbaarbaar nadat je de MIM-toolbox hebt ge\u00efmporteerd (zie: stap: 1 ). Zoek in de lijst aan de rechterkant \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb op, selecteer deze en klik op OK . Deze worden nu toegevoegd aan het diagram. Zoek nu in het toolboxmenu Add Stereotype op (onder Profile Helpers ) en sleep dit element op het diagram. Er verschijnt nu een venster Add Stereotype . We gaan nu een stereotype maken dat dient als extensie op het MIM-stereotype \u00abAttribuutsoort\u00bb . Geef een naam op voor het stereotype. In het geval van dit voorbeeld is gekozen voor Attribuutsoort , maar dit kan elke andere willekeurige naam zijn. Klik vervogens op de button Add Metaclass . Hier geef je de UML-metaklasse uit EA op waarop je extensie plaatsvindt. Als je niet weet van welke UML-metaklasse je stereotype wordt afgeleid, zoek dit dan op in het MIM-profiel. Info : In hoofdstuk 3 van de MIM-standaard staat beschreven van welke UML-metaklasse elk MIM-stereotype is afgeleid. Omdat je een extensie maakt op MIM, is de nieuwe extensie automatisch \u00f3\u00f3k een extensie op een UML-type. Desondanks moet je dit in Enterprise Architect expliciet benoemen. Laat de overige instellingen staan en klik op Volgende . In dit venster, Define Tagged Values , kun je de extra metadata-elementen opvoeren. Klik met de rechtermuisknop in de kolom Property Kies uit het menu Add Tagged Value . Voer een naam op voor de tagged value. In het geval van dit voorbeeld Actualiteit . In de linkerkolom kun je nog een standaardwaarde opvoeren, maar dat is niet verplicht. In dit voorbeeld blijft dit veld leeg. Herhaal deze stap voor alle tagged values die je aan dit element wilt toevoegen. Als je klaar bent, kun je bovenstaande stappen herhalen voor \u00abObjecttype\u00bb . Klik daarna op Voltooien Je ziet nu het nieuwe stereotype met de tagged values. Daarnaast heeft het nu een relatie met de UML-metaklasse \u00abAttribute\u00bb . Als laatste onderdeel van deze stap moet nu de relatie gelegd worden tussen het nieuwe stereotype en het MIM-stereotype. Dit gaat als volgt: Klik nu op het element Attribuutsoort . Er verschijnen nu rechts van het element een aantal iconen. Klik op de witte pijl ( QuickLinker ) met de muisknop ingedrukt en sleep dit naar het bijbehorende MIM-type (het bovenste icoon) Kies uit het menu dat nu verschijnt voor Generalization . Je extensie-type heeft nu een relatie met MIM::Attribuutsoort \u00e9n UML::Attribute . Herhaal deze stappen voor \u00abObjecttype\u00bb . Als laatste stap is het handig om het kleurenschema van het modelelement gelijk te maken aan dat van MIM. Dat gaat als volgt: Klik met de rechtermuisknop op het nieuwe element Objecttype . Navigeer naar Appearance en klik op Default Appearance . Nu opent een venster met dezelfde naam. Klik op Background Color . Klik op More Colors . Selecteer het tabblad Custom . En vul vervolgens onderstaande waarden in: Hue: 128 Sat: 245 Lum: 230 Red: 206 Green: 253 Blue: 254 Klik op OK . Zet Border Color en Font Color op zwart . Klik op OK . Herhaal deze stap voor de andere modelelementen, in dit geval Attribuutsoort . Je hebt nu succesvol het profiel van je extensie aangemaakt.","title":"Stap 3: Modelleer de toolbox-extensie"},{"location":"MIM-toolbox-genereren-extensie/#stap-4-modelleer-het-toolbox-menu","text":"In deze stap maak je de menupagina van de toolbox. Hiermee bepaal je hoe en welke stereotypes zichtbaar zijn in het menu. Het doel van de DiSGeo-extensie is om bestaande MIM-stereotypen uitbreiden met extra tagged values . Daarvoor introduceerden we in EA onder de moterkap weliswaar twee nieuwe stereotypen ( \u00abObjectype\u00bb en \u00abAttribuutsoort\u00bb ), maar die willen we niet expliciet terugzien in de toolbox. In de toolbox willen we \u00abObjecttype\u00bb en \u00abAttribuutsoort\u00bb aanbieden. Open het lege diagram uit het package \u00abtoolbox profile\u00bbDISGEO . Sleep uit de toolbox die bij dit diagram hoort de Profile Helper Add Toolbox Page op het diagram. Het venster Add Toolbox Page opent nu. Vul de naam in van de toolboxpagina die je wilt maken. In dit geval maken we een kopie van de MIM-toolbox, dus noemen we deze (eerste) pagina: MIM: Objecten en attributen . Klik vervolgens op de Add-button en selecteer de optie Add Stereotype . Het venster Select A Profile Element opent nu. Navigeer naar het package \u00abprofile\u00bb DISGEO en selecter \u00abstereotype\u00bbObjecttype en klik op OK . In de eerste rij van de tabel in het venster Add Toolbox Page , is nu dit stereotype toegevoegd. Voor de leesbaarheid is het fijn om het type een alias mee te geven (anders heet het toolbox-item DISGEO::Objectype(UML::Class) . Vanwege het eerder genoemde uitgangspunt, krijgt dit stereotype het alias 'Objecttype' . Voeg nu op dezelfde manier 'Attribuutsoort' toe en klik nog niet op OK! . Je hebt nu de twee nieuwe stereotypes toegevoeg aan de toolboxpagina: + DISGEO::Objecttype(UML::Class) + DISGEO::Attribuutsoort(UML::Attribute) In de MIM-toolbox heeft deze pagina nog drie andere stereotypes. Deze kun je uit het package MIM-UML halen. Deze beschrijving gaat ervan uit dat je hierover beschikt. Klik nogmaals op de Add-button en navigeer nu naar het package \u00abMIM-UMLprofile\u00bb en voeg de volgende elementen toe: DISGEO::Objecttype(UML::Class) DISGEO::Attribuutsoort(UML::Attribute) + MIM::Gegevensgroep(UML::Attribute) + MIM::Gegevensgroeptype(UML::Class) + MIM_Keuzeattribuut::Keuze(UML::Attribute) Geef ze de bijbehorende aliassen uit het MIM-profiel Klik nu op OK . Voeg de toolboxpage toe voor MIM-Relaties , MIM-Datatypen , MIM-Waardelijsten en MIM-Packages . Herhaal hiervoor de voorgaande stappen . Je hebt nu met succes het toolboxmenu gemaakt. Het is in alle gevallen mogelijk om de namen van de stereotypen met de hand op te voeren. De schrijfwijze luistert heel nauw, dus heeft het de voorkeur gebruik te maken van Add Stereotype .","title":"Stap 4: Modelleer het toolbox-menu"},{"location":"MIM-toolbox-genereren-extensie/#stap-5-modelleer-het-diagram","text":"Open het lege diagram uit het package \u00abDiagram Profile\u00bbDISGEO . Sleept uit de toolbox die bij dit diagram hoort de Profile Helper Add Diagram Extention op het diagram. Het venster Add Diagram Extention opent nu. Geef een naam op voor het diagram en kies bij Extention Type voor Class . Geef bij Description eventueel een beschrijving op voor de toepassing van dit diagram. Het is handig om hier te vermelden dat je dit diagram nodig hebt om voor de MIM-toolbox inclusief extensie! Vouw onder Properties de lijst met General uit. Kies bij Toolbox Profile uit de lijst met namen, de naam van het profiel, in dit geval: DISGEO en klik op OK . Klik nu op het modelelement \u00abmetaclass\u00bb Diagram Logical en voeg bij Features een nieuw attribuut toe met de naam: toolboxPage . Vul bij Initial Value de het volgende in: MIM: Objecten en attributen=1;MIM: Relaties=1;MIM: Datatypen=1;MIM: Waardelijsten=1;MIM: Packages=1;UML: Connectors=0; Dit geeft aan welke onderdelen van de het toolbox menu uit- (waarde: 1 ) of ingevouwen (waarde: 0 ) zijn. Je hebt nu succesvol een Diagram Profile aangemaakt.","title":"Stap 5: Modelleer het diagram"},{"location":"MIM-toolbox-genereren-extensie/#stap-6-genereer-mdg-technology","text":"Je hebt nu succesvol de volgende drie profielen gemaakt: - \u00abprofile\u00bbDISGEO - \u00abdiagram profile\u00bbDISGEO - \u00abtoolbox profile\u00bbDISGEO In de volgende stap lees je hoe je de profielen publiceert Volg deze link voor een beschrijving. Nadat je elk profiel gepubliceert hebt, 'bundel' je ze in een MDG Technology. Hoe je dat doet, lees je hier","title":"Stap 6: Genereer MDG Technology"},{"location":"MIM-toolbox-genereren-extensie/#stap-7-werken-met-de-toolbox","text":"Bekijk de meest actuele handleiding voor het gebruik van toolboxen in EA.","title":"Stap 7: Werken met de toolbox"},{"location":"MIM-toolbox-genereren/","text":"Handleiding - MIM-Profiel, -Toolbox & -MDG Genereren Software/Standaard Versie MIM-standaard 1.1.1 Enterprise Architect 15.2 Subversion (SVN) 1.14.1 Inhoud Voorbereiding Profiel publiceren Genereer MDG Technologie Test de Toolbox Quicklinker Aandachtspunten MIM MDG Regels Beschrijving Deze handleiding beschrijft het proces voor het genereren van een customized toolbox voor modelleren met Enterprise Architect. Het gaat specifiek in op het maken van de MIM-toolbox . Maar ook voor het genereren customized toolboxen in het algemeen, biedt deze beschrijving een handig overzicht van de benodigde stappen. Een inhoudelijke beschrijving voor het maken van de benodigde profielen, vind je hier ( linkOpnemen ). De meest actuele versie van MIM kun je hier ( linkOpnemen ) raadplegen. 1 Voorbereiding Controleer voordat je (MIM-)profielen gaat genereren eerst de volgende zaken: Beschik je over de benodigde bestanden ? Zijn de benodigde profielen aanwezig? Is het versienummer correct ingevuld ? 1.1 Benodigde bestanden Controleer of je beschikt over alle benodigde bestanden: EA-bestand met MIM profile packages voor het genereren van de profiles en mdg technology ( Create MDG Technology File ), hiertoe behoort ten minste \u00e9\u00e9n package per stereotype: \u00abprofile\u00bb , \u00abdiagram profile\u00bb en \u00abtoolbox profile\u00bb (zie voor meer informatie over ... ( linkOpnemenNaarWelkePackagesPubliceren ). MTS-bestand met MIM properties voor het genereren van MDG Technology ( Working with MTS Files ) CSV-bestand met definities van de quick linkers ( Quick Linker Definition Format ) Het MTS- en CSV-bestand vind je hier (zie ook: onderstaande afbeelding). 1.2 Benodigde profielen Controleer of je beschikt over alle benodigde profielen: Open met Enterprise Architect het project met de MIM-profielen. Ga in de project browser naar het package MIM-UMLprofiel . Controleer of daarin de benodigde profile packages aanwezig zijn: Controleer of in het package \u00abprofile\u00bb MIM het element \u00abdocument\u00bb QuickLinker aanwezig is. NOTE : Het CSV-bestand van de QuickLinker is een kopie van de informatie die in dit element is opgeslagen. Als je wijzigingen wilt aanbrengen in de QuickLinker, of als er in het model wijzingen zijn doorgevoerd die van invloed zijn op de QuickLinker, kun je die met behulp van het CSV-bestand aanpassen (hier linkOpnemenNaarQuickLinkerMakenOfBewerken lees je hoe dat moet). Indien de profielen al in XML-formaat beschikbaar zijn (zie: ( linkOpnemenNaarPackagePublicerenAlsProfiel ), klik dan hier ( linkOpnemenGenererenToolbox ) om de volgende stap over te slaan en direct te beginnen met het genereren van de toolbox. 1.3 Versienummer Toolbox Het is handig om een toolbox een versienummer mee te geven. Hiervoor zijn verschillende manieren. Bovendien is het mogelijk om te kiezen hoever je deze nummering doorvoert. Hieronder wordt uitgelegd op welke manier de MIM-toolbox van een versienummer wordt voorzien. Het belangrijkste uitgangspunt is dat het versienummer van de MIM-toolbox correspondeert met het versienummer van de MIM-dataspecificatie. Format : MIMOverzicht van onderwerpen en repositories die mogelijk betrekking hebben op de tooling die bij Geonovum gebruikt wordt.
+++Note +Een link naar dit document opnemen op intranet voor degenen die liever documentatie aan de hand van een tabel opzoeken.
+Note +
+docs.geostandaarden.nl
enregister.geostandaarden.nl
nog opnemen?
+ | Applicatie | +Naam document | +Korte omschrijving | +Laatst bijgewerkt | +Locatie | +Gebruik | +
---|---|---|---|---|---|---|
1 | +EA | +Handleiding gebruik MIM-toolbox | +Deze handleiding beschrijft hoe je de MIM toolbox kunt importeren en toepassen | +2023 | +GitHub | +Openbaar | +
2 | +EA | +Handleiding genereren MIM-profiel | +Deze handleiding beschrijft het proces voor het genereren van een customized toolbox voor modelleren met Enterprise Architect. | +2023 | +GitHub | +Openbaar | +
3 | +EA | +Handleiding genereren Extensie MIM-toolbox | +Deze handleiding beschrijft hoe je in Enterprise Architect een extensie maakt op de MIM-toolbox. | +2023 | +Github | +Openbaar | +
4 | +EA, Imvertor | +Imvertor installeren | +Instructies voor de installatie en configuratie van Imvertor voor Enterprise Architect | +2022 | +GitHub | +Openbaar | +
5 | +EA, SVN | +Strategie Semantic Versioning DiSGeo | +Beschrijft de implementatie van Semantic Versioning voor DiSGeo | +2022 | +GitHub | +Openbaar | +
6 | +Metadata kwaliteitsmonitor (MKM) | +Tool voor Validatie metadatakwaliteit | +De metadata kwaliteits monitor (MKM) maakt automatisch rapportages over de kwaliteit van metadata uit een Catalogue Servcie for the Web (CSW). | +2019 | +GitHub | +Openbaar | +
7 | +Imvertor, EA, SVN | +Handleiding tooling van VNG | +Deze Wiki is een inventarisatie van informatie over de Model Driven Design aanpak van VNG Realisatie. | +---- | +GitHub | +Openbaar | +
8 | +EA, SVN | +Installatie SVN | +Deze handleiding beschrijft hoe je SVN installeert en je een EA-project onder versiebeheer brengt | +2023 | +GitHub | +Intern | +
9 | +EA, SVN | +Importeren van een bestaand SVN-project in EA | +Deze handleiding beschrijft hoe je vanuit een nieuw project in Enterprise Architect, de packages van een bestaand project in Subversion, kunt importeren. | +2022 | +GitHub | +Intern | +
10 | +EA, Imvertor, Respec | +Het publiceren van het IMGeluid EAP bestand | +Een werkinstructie voor IMGeluid maar zeker toepasbaar voor alle standaarden | +2023 | +Confluence | +Intern | +
11 | +Imvertor | +Documentatie over Imvertor | +Lijstje links naar handige Imvertor dingetjes | +2021 | +Confluence | +Intern | +
12 | +EA | +Enterprise Architect, profielen en toolboxen | +Instructie voor het gebruik van profielen en toolboxen. Gekregen van de BRO (kan waarschijnlijk weg) | +2021 | +Confluence | +Intern | +
13 | +SVN | +Gebruik van subversion in EA | +Handleiding van hoe EA en subversion samenwerken | +2022 | +Github | +Intern | +
14 | +GitHub, Markdown, ReSpec | +Beheer GitHub/ Markdown/ ReSpec | +Handleiding van genoemde tooling | +2022 | +Onedrive | +Intern | +
15 | +VocBench | +Handleiding VocBench | +Een simpele snelstartgids voor het voor het ontwikkelen van begrippenmodellen in VocBench als Linked data. | +2022 | +Onedrive | +Intern | +
16 | +GitHub | +GitHub introductie | +Waarom github handig is en hoe je aan de slag kunt | +2023 | +Onedrive | +Intern | +
17 | +Overzicht | +Overzicht tooling team Standaardisatie | +handig overzicht | +2023 | +Onedrive | +Intern | +
18 | +Technisch register | +Geonovum technisch register 2019 | +Instructies hoe je een Respec document automatisch publiceert op docs.geostandaarden.nl | +2020 | +GitHub | +Intern | +
19 | +Technisch register | +Handleiding voor beheerders informatiemodellen | +In dit document worden de stappen beschreven voor het publiceren van de technische bestanden van een informatiemodel in het Technisch register van Geonovum. | +2019 | +GitHub | +Intern | +
20 | +Technisch register | +Handleiding voor beheerders technisch register | +In dit document worden de stappen beschreven voor het opzetten van een systeem voor het volgen van versies van een nieuw informatiemodel in het Technisch register van Geonovum. | +2022 | +GitHub | +Intern | +
21 | +EA, Imvertor, SVN | +Suggesties voor aanvullende handleidingen | +Dit document is op zichzelf geen handleiding, maar geeft een overzicht van mogelijke relevante onderwerpen om nog een handleiding voor te schrijven | +2022 | +GitHub | +Intern | +
22 | +ReSpec | +ReSpec Utilities | +ReSpec Utilities voor Geonovum | +2019 | +GitHub | +Intern | +
23 | +Word, Git, ReSpec | +word2werkversie/~markdown/~publicatie | +Beschrijving van ingerichte workflow waarmee je Word-bestanden om kunt zetten naar een ReSpec-werkversies. | +2023 | +Github | +Intern | +
++Note +Een link naar dit document opnemen op intranet voor degenen die liever documentatie aan de hand van een tabel opzoeken.
+Note +Todo geonovumwerkwijze voor informatiemodelleurs
+
++Note +Optioneel
+
beheer
toevoegen: ["Geonovum", "Armatiek", "W3C", "Logius"]
.ReSpec
toevoegen: ["Ja", "Nee"]
. Is het document in ReSpec-formaat beschikbaar?gepubliceerde versie
, of formele status
.+ | Onderwerp | +Naam document | +Korte omschrijving | +Laatst bijgewerkt | +Locatie | +Gebruik | +
---|---|---|---|---|---|---|
1 | +Opstellen van model | +HIM - Handreiking Informatie Modelleren | +Handleiding voor het opstellen van een informatiemodel of dataproductspecificatie. Beschrijft rol, proces en basismethodiek | +2019 | +Github | +Openbaar | +
2 | +Geometrie in model | +GIMEG | +Beschrijving van de toepassing van geometrie in informatiemodellering en de implementatie daarvan in GML. | +2021 | +GitHub | +Openbaar | +
3 | +Geometrie in uitwisselingsformaten | +Geometrie in uitwisselingsformaten | +Handreiking over het uitwisselen van geometrie, met o.a. een overzicht van de verschillende bestandsformaten, handvatten voor het kiezen van het juiste formaat en gedetaileerde informatie over het uitwisselen van geometrie in HTML, GML, JSON, GeoPackage en RDF. | +2022 | +GitHub | +Openbaar | +
4 | +CRS in uitwisselingsformaten | +Handreiking gebruik coördinaatreferentiesystemen bij uitwisseling en visualisatie van geo-informatie | +Bundeling van bestaande adviezen van het NSGI over geodetisch correcte gebruik van de in Nederland gebruikte CRS-en. | +2022 | +GitHub | +Openbaar | +
5 | +Lange lijnenadvies | +Eenduidige transformatie van grenzen tussen ETRS89 en RD | +Advies voor het waarborgen van de nauwkeurigheid van lange lijnstukken van grenzen. | +2018 | +Geoforum | +Openbaar | +
6 | +Keuzehulp standaarden | +Raamwerk Geostandaarden 4.0 | +Het Raamwerk van geo-standaarden helpt bij de opzet en ontwikkeling van een geo-informatie infrastructuur om de juiste set standaarden te kiezen. | +2023 | +GitHub | +Openbaar | +
7 | +Beschrijving MIM | +MIM - Metamodel Informatie Modellering | +Beschrijving van een metamodel waar informatiemodellen mee gemaakt worden. Het informeert over de metaklassen, metastructuur en metagegevens als grondslag voor een informatiemodel. | +2022 | +GitHub | +Openbaar | +
8 | +Toepassing NEN3610 | +Basismodel geo-informatie - toelichting | +Handreiking voor het toepassen van het Basismodel geo-informatie (NEN 3610:2022), bedoeld als service-informatie om te ondersteunen bij het toepassen van het model in sectorale informatiemodellen. | +2023 | +GitHub | +Openbaar | +
9 | +Toepassing NEN3610 in LD | +NEN 3610 - Linked Data | +Combinatie van een technisch rapport, een handboek en een standaard voor NEN3610 in Linked Data. | +2021 | +GitHub | +Openbaar | +
10 | +Doel en Toepassing Model Basisgeometrie | +Basisgeometrie | +Specificatie van het model basisgeometrie voor geo-informatiemodellen die een externe geometriereferentie nodig hebben. | +2020 | +GitHub | +Openbaar | +
11 | +Toepassing ReSpec | +ReSpec Wiki | +Engelstalige wiki voor de configuratie en het gebruik van ReSpec | +2021 | +GitHub | +Openbaar | +
12 | +Wijzigingen in model | +Wijzigingsprotocol geo-standaarden | +Sturende principes achter het generieke wijzigingsproces van de basisset geo-standaarden. | +2021 | +GitHub | +Openbaar | +
13 | +Beheer standaarden | +Beheer basis geo-standaarden | +Beschrijving van verschillende beheeraspecten, zoals o.a. implementatieondersteuning, wijzigingsproces, governance, etc. | +2021 | +GitHub | +Openbaar | +
14 | +Object-identificatie | +UOI Ontwerp | +Ontwerp voor een Unieke Objectidentificator (UOI) om gegevens op verantwoorde en betrouwbare wijze domein-overstijgend te kunnen registreren, uitwisselen (delen) en koppelen aan andere gegevens. | +2022 | +GitHub | +Openbaar | +
15 | +Wijzigingen in model | +Wijzigingsprotocol Informatiemodel Geluid | +Dit document beschrijft de sturende principes achter het wijzigingsproces voor IMG. | +2023 | +GitHub | +Intern | +
16 | +Geostandaarden ISO | +ISO 19xxx |
+Bestandsmap met bij Geonovum aanwezige documentatie van standaarden. Dit zijn niet altijd de meest actuele of formele versies. | +2022 | +Teams | +Intern | +
17 | +Bestaande modellen | +n.v.t. | +Verschillende bestandsmappen (en archief?) met (documentatie van) verschillende door Geonovum ontwikkelde (sectorale) standaarden | +n.v.t. | +Teams | +Intern | +