Initial commit

.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build and Check
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Build
+    uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@snapshot-in-repo
+  check:
+    needs: build
+    name: Check
+    uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main    
+  publish:
+    needs: build
+    name: Publish (Logius)
+    uses: Logius-standaarden/Automatisering/.github/workflows/publish.yml@main
+    secrets: inherit

.gitignore

@@ -0,0 +1 @@
+*_log

LICENSE

@@ -0,0 +1,17 @@
+The W3C SOFTWARE NOTICE AND LICENSE (W3C)
+
+https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+
+This work is being provided by the copyright holders under the following license. By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
+
+Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
+1. The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
+2. Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice (https://www.w3.org/Consortium/Legal/2015/copyright-software-short-notice.html) should be included.
+3. Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
+
+
+THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
+
+COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
+
+The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders.

README.md

@@ -0,0 +1,108 @@
+## ReSpec template instructies
+
+ReSpec is een tool om html en pdf documenten te genereren op basis van markdown content.
+
+Gebruik de knop [_Use this template_](https://github.com/Geonovum/NL-ReSpec-GN-template/generate) om aan de slag te gaan. Dit maakt een kopie van de template in uw eigen GitHub repository die dan aangepast en uitgebreid kan worden.
+
+De dynamische pagina is van het template document [hier](https://geonovum.github.io/NL-ReSpec-GN-template/) te zien.
+
+Deze repository bevat ook de GitHub Workflows om een statische HTML-pagina en PDF-document te genereren en enkele controles uit te voeren. Deze workflows worden automatisch gerund zodra er een aanpassing gedaan wordt aan de main branch.
+
+### Vereiste voor gebruik
+- Kennis van git/github
+- Kennis van markdown en/of HTML
+- Een webserver om de documentatie te hosten
+
+### Gebruikersinstructie
+Om het gebruik van dit template makkelijker te maken raden we het aan om een IDE te gebruiken. Die geeft een voorbeeld van hoe de markdown eruit zal zien, kan laten zien of de config files nog in de correcte vorm zijn en kan helpen in het gebruik van git.  
+Een gratis voorbeeld van een IDE is: [Visual studio code](https://code.visualstudio.com/).
+
+Aanpassingen maken aan het document gaat op 2 manieren:
+- De configuratie van het document aanpassing in de config files
+- Markdown files toevoegen/veranderen
+- Plaatsen waar de template ingevuld moeten worden zijn gemarkeerd met 'TODO:'.
+
+De **configuratie files** bevatten informatie over de organisatie en over 
+de status van het document. Bekijk de [Logius ReSpec wiki](https://github.com/Logius-standaarden/respec/wiki) 
+voor meer informatie over de configuratie opties. De files zijn gesplitst in 2 files:
+[organisation-config.js](https://github.com/Geonovum/NL-ReSpec-GN-beheer/tree/9a606242041171dbf507c439863e4ffb94701463/js) en [config.js](js/config.js).
+Deze laatste is te vinden in de `js` folder.
+
+De organisation_config bevat informatie over de organisatie, de informatie in deze file 
+zal bijna nooit veranderen zoals de naam van de organisatie. Het wordt aangeraden de file 
+zelf te hosten zodat hij in alle documentatie van de organisatie gebruikt kan worden en
+niet elke keer gekopieerd hoeft te worden. Geonovum host dit file onder de naam `geonovum-config.js` op https://tools.geostandaarden.nl/respec/config, zodat deze configuratie centraal ingevuld is en hergebruikt kan worden. 
+
+De document_config in [config.js](js/config.js) bevat informatie die alleen relevant is voor het huidige document. Hier kun je instellingen regelen voor het document dat je gaat schrijven, zoals documenttype, status, auteurs, etc. 
+
+Beide configuratie bestanden worden gelinkt in de `index.html` file.
+
+**Markdown files** bevatten de content van het document. Alle content
+kan in 1 document, maar het is aan te raden om de content te splitsen
+in verschillende files, bijvoorbeeld per hoofdstuk, met een toepasselijke naam om onderhoud 
+makkelijker te maken. HTML is overigens ook mogelijk.
+
+Na het toevoegen van een nieuwe markdown file moet hij toegevoegd worden
+aan de [index.html](index.html). Je voegt hem toe door de naam en eventueel relevante CSS class 
+toe te voegen aan de lijst met "data includes":
+
+<pre>
+  &lt;section data-include-format="markdown" data-include="ch01.md" class="informative">&lt;/section>
+  &lt;section data-include-format="markdown" data-include="ch02.md">&lt;/section>
+</pre>
+
+Dat wil zeggen, voeg een `<section>` toe met op de plaats van "ch01.md" de naam van het bestand. 
+
+Voor een volledige lijst van CSS classes zie de [ReSpec Documentation](https://respec.org/docs/#css-classes)
+
+Deze classes zijn ook binnen de markdown files te gebruiken op de volgende manier:  
+```<div class="example">voorbeeld</div>```
+
+### Automatische controles
+Bij het uploaden van een nieuwe versie naar github worden er via github actions 2 controles 
+uitgevoerd:  
+
+Een WCAG-check (Web Content Accessibility Guidelines), deze guidelines
+gemaakt door W3C zorgen voor een verbetering van de toegankelijkheid
+van webapplicaties verbeterd voor zowel verschillende apparaten 
+als voor mensen met een beperking.
+
+Een link-check, deze check controleert of alle links die in het 
+document staan ook naar iets wijzen.
+
+outputs van deze tests zijn te vinden in het tabblad `Actions` in de GitHub repository.
+
+### Publiceren van documenten
+Na een update in de main branch wordt er een statische HTML en een PDF-versie gemaakt.
+Dit zijn `snapshot.html` en `template.pdf` deze bestanden zijn te vinden in de root file van het project. Deze files kunnen daarna gepubliceerd worden.
+De PDF-versie wordt aangemaakt indien `alternateFormats` in `config.js` geconfigureerd staat:
+```js
+alternateFormats: [
+  {
+	  label: "pdf",
+	  uri: "template.pdf",
+  },
+]
+```
+
+### Transitie van 'oude' Geonovum ReSpec naar NL-ReSpec van Logius
+
+Hieronder staan de instructies voor gebruikers van Geonovum ReSpec die willen overstappen naar de nieuwe NL-ReSpec. 
+
+Als je een gepubliceerd document wilt omzetten naar de nieuwe ReSpec:
+- Dit hoeft niet. Eenmaal op docs gepubliceerde documenten hoeven niet aangepast te worden.
+
+Als je een bestaand werkdocument wilt omzetten naar de nieuwe ReSpec:
+- Pas de `<head>` van index.html aan. Wat er in moet staan kun je afkijken in [template index.html](https://github.com/Geonovum/NL-ReSpec-GN-template/blob/main/index.html). Het is belangrijk dat je in ieder geval de link naar `geonovum-config.js`, `respec-nlgov.js`, en `Geonovum.ico` overneemt. Vraag eventueel hulp aan de ReSpec beheerders.
+ - Pas in `config.js` de `specStatus aan. De afkortingen zijn veranderd (!): 
+   - `wv` of `WV` = Werkversie
+   - `cv` of `CV` = Consultatieversie
+   - `vv` of `VV` = Versie ter vaststelling
+   - `def` of `DEF` = Vastgestelde versie
+   - `basis` of `BASIS` = Basis Document
+- Pas in `config.js` de `title` aan. Dit is een nieuwe config optie. De hoofdtitel van je document zet je voortaan in `config.js` in plaats van bovenin `index.html`. Voorbeeld: 
+
+`title: "Informatiemodel Golf",`
+
+Als je een nieuw werkdocument gaat maken: 
+- gebruik de [template](https://github.com/Geonovum/NL-ReSpec-GN-template). Klik op `Use this template` en kies `Create a new repository`. Er wordt dan een nieuwe repository (dat al wel aangemaakt moet zijn) ingericht op basis van de nieuwe respec, waarmee je direct aan de slag kunt. Pas in `config.js` de titel van je document aan zoals hierboven beschreven. Neem contact op met een van de github beheerders als je zelf geen github repository kan aanmaken. 

abstract.md

@@ -0,0 +1 @@
+TODO: vul in abstract.md een abstract in.

ch01.md

@@ -0,0 +1,7 @@
+# Niet-normatieve deel
+
+Bijvoorbeeld een introductie is niet normatief.
+
+<p class="note" title="index">
+Dit hoofdstuk is toegevoegd met `class="informative"` in `config.js`.
+</p>

ch02.md

@@ -0,0 +1,33 @@
+# Meer inhoud
+
+## Definities
+<dfn>Definitie</dfn>: Een definitie is een beschrijving van een woord. Een ander woord voor _definitie_ is betekenis of beschrijving.
+
+## Afbeeldingen
+
+Afbeeldingen krijgen een nummer en vermelding in de figurenlijst [[[#tof]]].
+
+![Tekstueel alternatief voor toegankelijkheid](media/Bomos_levenscyclus.svg "Onderschrift")
+
+## Referenties
+
+Referentie uit locale lijst [[SemVer]]. Lijst staat in `organisation-config.js`. Alleen referenties die in de tekst voorkomen worden getoond.
+
+We gebruiken een <a>definitie</a> om een woord te omschrijven.
+
+## Optioneel
+
+De onderstaande secties (_Conformiteit_ e.d.) zijn optioneel, zie `index.html`:
+
+```
+<body>
+  <section id="abstract" data-include-format="markdown" data-include="abstract.md"></section>
+  <section id="sotd"></section><!-- Wordt automatisch gevuld -->
+  <section data-include-format="markdown" class="informative" data-include="ch01.md"></section>
+  <section data-include-format="markdown" data-include="ch02.md"></section>
+  <!-- Hieronder optionele secties. Worden automatisch gevuld -->
+  <section id='conformance'></section>
+  <section id='tof'></section>
+  <section id="index"></section>
+</body>
+```

index.html

@@ -0,0 +1,39 @@
+<!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>
+  <!-- De volgende regel zorgt ervoor dat plaatjes uit Imvertor niet geschaald
+       worden, zodat de imagemap die op deze plaatjes zit werkt. -->
+  <style>div.imageinfo img {max-width: none;}</style>
+</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>
+
+  <!-- Als je document een door imvertor gegenereerde catalogus bevat kan je die -->
+  <!-- opnemen door de volgende regel uit commentaarhaakjes te halen en aan te passen -->
+  <!-- <div id="catalogus" data-include="data/TODO-cat.respec.html" data-include-replace=true></div> -->
+
+  <!-- De volgende paragrafen worden automatisch gevuld. Je kunt ze uitzetten -->
+  <section id='conformance'></section> <!-- Gegeneerd hoofdstuk over conformiteit-->
+  <section id='tof'></section><!-- Lijst van figuren -->
+  <section id="index"></section><!-- Lijst van begrippen -->
+</body>
+
+</html>

js/config.js

@@ -0,0 +1,75 @@
+let respecConfig = {
+  useLogo: true,
+  useLabel: true,
+  // title is verplicht! Neem hier de titel van het document op ----------------------
+  title: "[TODO: Neem titel op in config.js]",
+  //-- specStatus is verplicht! (activeer 1 van de volgende) --------------------------
+  specStatus: "wv",                   // Werkversie
+  //specStatus: "cv",               // Consultatieversie
+  //specStatus: "vv",               // Versie ter vaststelling
+  //specStatus: "def",              // Vastgestelde versie
+  //specStatus: "basis",            // Basis Document
+  //-- specType is verplicht bij alle andere dan BASIS ---------------------------------
+  //specType: "NO",                 // Norm
+  //specType: "ST",                 // Standaard
+  //specType: "IM",                 // Informatie Model
+  //specType: "PR",                 // Praktijkrichtlijn
+  specType: "HR",                     // HandReiking
+  //specType: "WA",                 // Werkafspraak
+  //specType: "BD",                 // Beheer Documentatie
+  //specType: "AL",                 // Algemeen document
+  //specType: "BP",                 // Best Practice
+  //-- pubDomain is verplicht! (komt in de URL) -------------------------------------
+  //-- zie: https://geonovum.github.io/handleiding-tooling/ReSpec/#pubdomain
+  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
+  //-- TODO shortName is verplicht! (komt in de URL: kies logische afkorting)--------------
+  shortName: "NL-ReSpec-GN-template",
+
+  //edDraftURI = De URI van de draft version. Deze wordt automatisch afgeleid van de github URI; maar kan hier overschreven worden. 
+	//edDraftURI: ["https://geonovum.github.io", "/", "shortName"],
+
+  //-- 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",
+  //-- TODO: 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",
+      }
+    ],
+  // TODO: Vul de github URL in.
+  //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):
+  // TODO: Change the filename as preferred.
+  alternateFormats: [
+      {
+          label: "pdf",
+          uri: "template.pdf",
+      },
+  ],
+};