diff --git a/docs/GitHub.md b/docs/GitHub.md index 12a6dae..0808a80 100644 --- a/docs/GitHub.md +++ b/docs/GitHub.md @@ -6,11 +6,16 @@ In dit hoofdstuk komen zowel GitHub als GitHub desktop client aan de orde. Geono ### 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 . +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. +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. +**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. @@ -20,7 +25,8 @@ 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. +Kies in dit scherm je persoonlijke plan. Bij Geonovum gebruiken we de gratis +versie, dus selecteer die. ![media/image4.png](media/image4.png) diff --git a/docs/Handleiding-ontologie-maken-en-publiceren.md b/docs/Handleiding-ontologie-maken-en-publiceren.md index c96cb02..f13ba2b 100644 --- a/docs/Handleiding-ontologie-maken-en-publiceren.md +++ b/docs/Handleiding-ontologie-maken-en-publiceren.md @@ -1,17 +1,19 @@ # Handleiding ontologie maken en publiceren ## Inleiding -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. +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. ## 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) +- **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 +- tagged value `baseURI` op packageniveau De ontologie is gegenereerd met scripts van Marco Brattinga. @@ -19,7 +21,8 @@ De ontologie is gegenereerd met scripts van Marco Brattinga. - 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. +Naast Marco Brattinga hebben Linda, Pano, en Jesse Bakker (Kadaster) kennis van +deze scripts. ## Regels voor de URI diff --git a/docs/Markdown.md b/docs/Markdown.md index 6a4cf55..f81a8cf 100644 --- a/docs/Markdown.md +++ b/docs/Markdown.md @@ -35,9 +35,9 @@ Dit kan je ook in een snelkoppeling zetten als icoon op de desktop. In Firefox kan je dat instellen via de parameters. -- Kies: -- Vertel firefox dat je weet waar je mee bezig bent. -- `security.fileuri.strict_origin_policy = false` (dus op false zetten) +- Ga naar het configuratiescherm van Firefox door `about:config` in de zoekbalk te zetten. +- Firefox vraag nu of je het zeker weet. Niet twijfelen. +- zet de instelling `security.fileuri.strict_origin_policy = false` op false. ## Tools voor Markdown diff --git a/docs/SVN-installeren-voor-EAP.md b/docs/SVN-installeren-voor-EAP.md index c5d7e74..142244d 100644 --- a/docs/SVN-installeren-voor-EAP.md +++ b/docs/SVN-installeren-voor-EAP.md @@ -46,6 +46,13 @@ Vraag een account aan voor svn.geostandaarden.nl bij de [beheerder](https://stic ![SVN Checkout](media/svn_checkout.png) + +Het kan zijn dat iemand anders een bestand uitgechecked heeft. Wie dat dan is geweest kan je via de command-line op de volgende manier controleren: + +``` +svn info svn://svn.geostandaarden.nl/Datatypes/datatypen-ISO19107-2003.xml +``` + ### Stap 4: Breng EAP-bestand (packages) onder SVN Het EAP bestand wordt op het niveau van packages onder SVN gebracht. diff --git a/docs/geonovum-werkwijze-modelleren.md b/docs/geonovum-werkwijze-modelleren.md index f95ca0d..eeb505d 100644 --- a/docs/geonovum-werkwijze-modelleren.md +++ b/docs/geonovum-werkwijze-modelleren.md @@ -13,31 +13,55 @@ De onderstaande tabbelen geven een overzicht van reeds beschikbare handleidingen 1. Handleiding introductie GitHub (org:`Handleiding introductie GitHub.docx`) > **Note** -> Wilko heeft twee bestaande [documenten samengevoegd](https://geonovum.github.io/handleiding-tooling/), 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` en `22` in de [tabel met het overzicht van beschikbare documentatie m.b.t. werkomgeving](werkomgeving-modelleren.md). ). Intranet luistert iets nauwer: daar misschien specifiekere verwijzingen maken. +> Wilko heeft twee bestaande [documenten +> samengevoegd](https://geonovum.github.io/handleiding-tooling/), 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` en `22` in de [tabel met het overzicht van beschikbare +> documentatie m.b.t. werkomgeving](werkomgeving-modelleren.md). ). Intranet +> luistert iets nauwer: daar misschien specifiekere verwijzingen maken. ## Suggestie voor de langetermijn > **Note** > Voorbeeld samenhang processen, data, inten/extern van [aquo-standaarden](https://aquo.nl) -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._" +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._" -- Dit zou heel aantrekkelijk kunnen zijn voor onze documentatie, zoals handleidingen en instructies, maar ook modellen. +- Dit zou heel aantrekkelijk kunnen zijn voor onze documentatie, zoals + handleidingen en instructies, maar ook modellen. - Imvertor maakt nu van UML een catalogus. -- Maar zou het niet mooier zijn om van datamodel naar database met objecten, definities en diagrammen te gaan +- Maar zou het niet mooier zijn om van datamodel naar database met objecten, + definities en diagrammen te gaan - En van daaruit kun je dat (bijvoorbeeld) een catalogus genereren? -- Informatie die op meerdere plekken terugkeert kan zo éénmalig opgeslagen en beheerd worden -- Op dit moment is verwijzen tussen standaarden onderling lastig, een dergelijke structuur zou een oplossing kunnen zijn., -- NEN3610 is topmodel voor veel modellen, daar wil je naar kunnen verwijzen; m.a.w. echt mee kunnen verbinden +- Informatie die op meerdere plekken terugkeert kan zo éénmalig opgeslagen en + beheerd worden +- Op dit moment is verwijzen tussen standaarden onderling lastig, een dergelijke + structuur zou een oplossing kunnen zijn., +- NEN3610 is topmodel voor veel modellen, daar wil je naar kunnen verwijzen; + m.a.w. echt mee kunnen verbinden - Wat is ervoor nodig? -- Welke stappen kunnen we nu al nemen zonder onszelf in de toekomst klem te zetten? -- Informatie in database zou applicatie-onafhankelijk moeten zijn (m.a.w. niet afhankelijk van EA of Imvertor) -- De huidige werkwijze van het publiceren van modellen en standaarden is te veel verzuild; ieder model is een zuil. +- Welke stappen kunnen we nu al nemen zonder onszelf in de toekomst klem te + zetten? +- Informatie in database zou applicatie-onafhankelijk moeten zijn (m.a.w. niet + afhankelijk van EA of Imvertor) +- De huidige werkwijze van het publiceren van modellen en standaarden is te veel + verzuild; ieder model is een zuil. - Gerard W. heeft affiniteit met de uitgeverswereld en weet hierover meer. -- Een ander deel van de workflow zou kunnen zijn om documenten via MS Word aan te leveren voor de database. +- Een ander deel van de workflow zou kunnen zijn om documenten via MS Word aan + te leveren voor de database. - Maar misschien wil je aan de aanleverkant meerdere formaten kunnen toestaan. -- Arjan Loeffen heeft hier vanuit andere invalshoek ook ideeën over: datamodel van heel NL -- Dan moet je ook kunnen verbinden en standaardistaie ook verder doorvoeren (bijv. lay-out) +- Arjan Loeffen heeft hier vanuit andere invalshoek ook ideeën over: datamodel + van heel NL +- Dan moet je ook kunnen verbinden en standaardistaie ook verder doorvoeren + (bijv. lay-out) ### Links naar informatie over DITA - [Uitleg op Wikipedia](https://nl.wikipedia.org/wiki/Darwin_Information_Typing_Architecture) @@ -48,6 +72,7 @@ De volgende lijst bevat een aantal suggesties om documentatie (van o.a. werkwijz 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. ### HIM + - Past misschien beter bij _Geonovumwerkwijze_ (i.p.v. ~_omgeving_) - Handreiking voor informatiemodellering - Voor informatieproduten uitwisselen in context DSO @@ -59,6 +84,7 @@ Deze paragraaf geeft per document een korte analyse van de inhoud. Op basis hier - Veel DSO-taal, hoewel idee toch voor alle informatiemodellen geldt? ### Geonovum Technisch register (2019) + - Bevat Drie Documenten - Niet allemaal even compleet - Heel inhoudelijk van aard, weinig extra uitleg @@ -66,6 +92,7 @@ Deze paragraaf geeft per document een korte analyse van de inhoud. Op basis hier - Deels in Nederlands, deels in Engels ### Publiceren van het IMGeluid EAP-bestand + - Heel nuttig! - Verwijst naar wijzigingsprotocol IMGeluid (ook breed nuttig) - Herinnert mij aan doc. Pano: versionering diff --git a/docs/index.md b/docs/index.md index 691a56b..ca5080f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -80,8 +80,11 @@ Technische onderdelen van de standaard worden op: dit met een webhook kan doen staat beschreven in: [technisch-register-2019](https://github.com/Geonovum/technisch-register-2019/blob/master/documentatie/Handleiding%20voor%20beheerders%20informatiemodellen.md) -### Ontologieën (begrippen.geostandaarden.nl) +### Ontologieën (modellen.geostandaarden.nl) +Er is één ontologie gepubliceerd: die van NEN 3610. + +Dit is uitgelegd in de [handleiding ontologie maken](Handleiding-ontologie-maken-en-publiceren.md) ### Conceptenbibliotheek (definities.geostandaarden.nl)