Initial commit

MinBZK · May 16, 2024 · 446b3bb · 446b3bb
commit 446b3bb
Show file tree

Hide file tree

Showing 13 changed files with 1,094 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.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
diff --git a/LICENSE b/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.
diff --git a/README.md b/README.md
@@ -0,0 +1,85 @@
+## 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/Logius-standaarden/ReSpec-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://logius-standaarden.github.io/ReSpec-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
+- Kennis van de vorm van een Javascript object
+- 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
+
+De **configuratie files** bevat 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](js/organisation-config.js) en [config.js](js/config.js).
+Deze files zijn 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
+
+De document_config bevat informatie die alleen relevant is voor het huidige document.
+
+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 met een toepasselijke naam om onderhoud 
+makkelijker te maken.
+
+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 het ```content``` object in de ```config.js```. 
+De volgorde van ```content``` bepaalt de volgorde in het resulterende document.
+
+```content: {"ch01": "informative", "mermaid": ""},```
+Deze code voegt 2 markdown files toe:
+- `ch01.md` met de CSS class `informative`
+- `mermaid.md` zonder CSS class
+
+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 gepubliceerd, indien de repo onder [Logius-standaarden](https://github.com/Logius-standaarden) op GitHub staat.
+De PDF-versie wordt aangemaakt indien `alternateFormats` in `config.js` geconfigureerd staat:
+```js
+alternateFormats: [
+  {
+	  label: "pdf",
+	  uri: "template.pdf",
+  },
+]
+```
diff --git a/abstract.md b/abstract.md
@@ -0,0 +1 @@
+Tekst
diff --git a/ch01.md b/ch01.md
@@ -0,0 +1,7 @@
+# Niet-normatieve deel
+
+Bijvoorbeeld een introductie.
+
+<p class="note" title="index">
+Dit hoofdstuk is toegevoegd met `class="informative"` in `config.js`.
+</p>
diff --git a/ch02.md b/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>
+```
diff --git a/index.html b/index.html
@@ -0,0 +1,38 @@
+<!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/[email protected]/dist/main.js" class="remove"></script>
+  <script src="js/organisation-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>Default</title>
+  <link rel="shortcut icon" type="image/x-icon" href="https://gitdocumentatie.logius.nl/publicatie/respec/style/logos/logius.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 -->
+  <script>
+    let content = "";
+
+    const getClass = function(key) {
+      if (respecConfig.content[key]!==""){return ` class="${respecConfig.content[key]}"`}
+    }
+
+    for (let contentKey in respecConfig.content) {
+      content += `<section data-include-format="markdown" data-include="${contentKey}.md" ${getClass(contentKey)||""}></section>`
+    }
+
+    document.getElementById("sotd").insertAdjacentHTML('afterend', content);
+  </script>
+  <section id='conformance'></section>
+  <section id='tof'></section>
+  <section id="index"></section>
+</body>
+
+</html>
diff --git a/js/config.js b/js/config.js
@@ -0,0 +1,43 @@
+let respecConfig = {
+  useLogo: true,
+  useLabel: true,
+  license: "cc-by",
+  specStatus: "DEF",
+  specType: "HR",
+  pubDomain: "dk",
+  shortName: "template",
+  publishDate: "2023-06-21",
+  publishVersion: "0.0.3",
+
+  previousPublishVersion: "0.0.2",
+  previousPublishDate: "2022-06-24",
+  previousMaturity: "WV",
+  title: "titleText",
+  content: {"ch01": "informative", "ch02": "", "mermaid": ""},
+  editors:
+    [
+      {
+        name: "Logius Standaarden",
+        company: "Logius",
+        companyURL: "https://github.com/Logius-standaarden",
+      }
+    ],
+  authors:
+    [
+      {
+        name: "Logius Standaarden",
+        company: "Logius",
+        companyURL: "https://github.com/Logius-standaarden",
+      }
+    ],
+  github: "https://github.com/Logius-standaarden/ReSpec-template",
+
+
+  // Create PDF and link to file in header (optional):
+  alternateFormats: [
+      {
+          label: "pdf",
+          uri: "template.pdf",
+      },
+  ],
+};
diff --git a/js/organisation-config.js b/js/organisation-config.js
@@ -0,0 +1,118 @@
+// Plaats dit bestand op een centrale locatie voor hergebruik in meerdere documenten.
+var organisationConfig = {
+    nl_organisationName: "Logius",
+    nl_organisationStylesURL: "https://gitdocumentatie.logius.nl/publicatie/respec/style/",
+    nl_organisationPublishURL: "https://gitdocumentatie.logius.nl/publicatie/",
+    logos: [{
+        src: "https://gitdocumentatie.logius.nl/publicatie/respec/style/logos/figure-logius.svg",
+        alt: "Logius",
+        id: "Logius",
+        height: 77,
+        width: 44,
+        url: "https://www.logius.nl/standaarden",
+    }],
+
+    postProcess: [window.respecMermaid.createFigures],
+
+    latestVersion: ["nl_organisationPublishURL", "pubDomain", "/", "shortName"],
+    thisVersion: ["nl_organisationPublishURL", "pubDomain", "/", "specStatus", "-", "specType", "-", "shortName", "-", "publishDate"],
+    prevVersion: ["nl_organisationPublishURL", "pubDomain", "/", "previousMaturity", "-", "specType", "-", "shortName", "-", "previousPublishDate"],
+    useLogo: true,
+    useLabel: true,
+
+    license: "cc0",
+    addSectionLinks: true,
+
+    localizationStrings: {
+        en: {
+            wv: "Draft",
+            cv: "Recommendation",
+            vv: "Proposed recommendation",
+            def: "Definitive version",
+            basis: "Document",
+            eo: "Outdated version",
+            tg: "Rescinded version",
+            no: "Norm",
+            st: "Standard",
+            im: "Information model",
+            pr: "Guideline",
+            hr: "Guide",
+            wa: "Proposed recommendation",
+            al: "General",
+            bd: "Governance documentation",
+            bp: "Best practice",
+        },
+        nl: {
+            wv: "Werkversie",
+            cv: "Consultatieversie",
+            vv: "Versie ter vaststelling",
+            def: "Vastgestelde versie",
+            basis: "Document",
+            eo: "Verouderde versie",
+            tg: "Teruggetrokken versie",
+            no: "Norm",
+            st: "Standaard",
+            im: "Informatiemodel",
+            pr: "Praktijkrichtlijn",
+            hr: "Handreiking",
+            wa: "Werkafspraak",
+            al: "Algemeen",
+            bd: "Beheerdocumentatie",
+            bp: "Best practice",
+        },
+    },
+
+    sotdText: {
+        nl: {
+            sotd: "Status van dit document",
+            def: `Dit is de definitieve versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
+            wv: `Dit is een werkversie die op elk moment kan worden gewijzigd, verwijderd of vervangen door andere documenten. Het is geen door het TO goedgekeurde consultatieversie.`,
+            cv: `Dit is een door het TO goedgekeurde consultatieversie. Commentaar over dit document kan gestuurd worden naar `,
+            vv: `Dit is een definitief concept van de nieuwe versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
+            basis: "Dit is een document zonder officiële status.",
+        },
+        en: {
+            sotd: "Status of This Document",
+            def: `This is the definitive version of this document. Edits resulting from consultations have been applied.`,
+            wv: `This is a draft that could be altered, removed or replaced by other documents. It is not a recommendation approved by TO.`,
+            cv: `This is a proposed recommendation approved by TO. Comments regarding this document may be sent to `,
+            vv: `This is the definitive concept of this document. Edits resulting from consultations have been applied.`,
+            basis: "This document has no official standing.",
+        },
+    },
+
+    labelColor: {
+        def: "#154273",
+        wv: "#39870c",
+    },
+
+    licenses: {
+        cc0: {
+            name: "Creative Commons 0 Public Domain Dedication",
+            short: "CC0",
+            url: "https://creativecommons.org/publicdomain/zero/1.0/",
+            image: "https://gitdocumentatie.logius.nl/publicatie/respec/media/logos/cc-zero.svg",
+        },
+        "cc-by": {
+            name: "Creative Commons Attribution 4.0 International Public License",
+            short: "CC-BY",
+            url: "https://creativecommons.org/licenses/by/4.0/legalcode",
+            image: "https://gitdocumentatie.logius.nl/publicatie/respec/media/logos/cc-by.svg",
+        },
+        "cc-by-nd": {
+            name: "Creative Commons Naamsvermelding-GeenAfgeleideWerken 4.0 Internationaal",
+            short: "CC-BY-ND",
+            url: "https://creativecommons.org/licenses/by-nd/4.0/legalcode.nl",
+            image: "https://gitdocumentatie.logius.nl/publicatie/respec/media/logos/cc-by-nd.svg",
+        },
+    },
+
+    localBiblio: {
+        "SemVer": {
+            href: "https://semver.org",
+            title: "Semantic Versioning 2.0.0",
+            authors: ["T. Preston-Werner"],
+            date: "June 2013"
+        },
+    },
+}