Skip to content

Commit 1f8d0d8

Browse files
fterpstrafterpstra
authored
Initial commit
0 parents  commit 1f8d0d8

13 files changed

+1045
-0
lines changed

‎.github/workflows/build.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Build and Check
2+
on:
3+
workflow_dispatch:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
jobs:
9+
build:
10+
name: Build
11+
uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@snapshot-in-repo
12+
check:
13+
needs: build
14+
name: Check
15+
uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main
16+
publish:
17+
needs: build
18+
name: Publish (Logius)
19+
uses: Logius-standaarden/Automatisering/.github/workflows/publish.yml@main
20+
secrets: inherit

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*_log

‎LICENSE

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
The W3C SOFTWARE NOTICE AND LICENSE (W3C)
2+
3+
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
4+
5+
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.
6+
7+
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:
8+
1. The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
9+
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.
10+
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)."
11+
12+
13+
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.
14+
15+
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
16+
17+
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

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
## ReSpec template instructies
2+
3+
ReSpec is een tool om html en pdf documenten te genereren op basis van markdown content.
4+
5+
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.
6+
7+
De dynamische pagina is van het template document [hier](https://geonovum.github.io/NL-ReSpec-GN-template/) te zien.
8+
9+
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.
10+
11+
### Vereiste voor gebruik
12+
- Kennis van git/github
13+
- Kennis van markdown en/of HTML
14+
- Een webserver om de documentatie te hosten
15+
16+
### Gebruikersinstructie
17+
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.
18+
Een gratis voorbeeld van een IDE is: [Visual studio code](https://code.visualstudio.com/).
19+
20+
Aanpassingen maken aan het document gaat op 2 manieren:
21+
- De configuratie van het document aanpassing in de config files
22+
- Markdown files toevoegen/veranderen
23+
- Plaatsen waar de template ingevuld moeten worden zijn gemarkeerd met 'TODO:'.
24+
25+
De **configuratie files** bevatten informatie over de organisatie en over
26+
de status van het document. Bekijk de [Logius ReSpec wiki](https://github.com/Logius-standaarden/respec/wiki)
27+
voor meer informatie over de configuratie opties. De files zijn gesplitst in 2 files:
28+
[organisation-config.js](https://github.com/Geonovum/NL-ReSpec-GN-beheer/tree/9a606242041171dbf507c439863e4ffb94701463/js) en [config.js](js/config.js).
29+
Deze laatste is te vinden in de `js` folder.
30+
31+
De organisation_config bevat informatie over de organisatie, de informatie in deze file
32+
zal bijna nooit veranderen zoals de naam van de organisatie. Het wordt aangeraden de file
33+
zelf te hosten zodat hij in alle documentatie van de organisatie gebruikt kan worden en
34+
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.
35+
36+
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.
37+
38+
Beide configuratie bestanden worden gelinkt in de `index.html` file.
39+
40+
**Markdown files** bevatten de content van het document. Alle content
41+
kan in 1 document, maar het is aan te raden om de content te splitsen
42+
in verschillende files, bijvoorbeeld per hoofdstuk, met een toepasselijke naam om onderhoud
43+
makkelijker te maken. HTML is overigens ook mogelijk.
44+
45+
Na het toevoegen van een nieuwe markdown file moet hij toegevoegd worden
46+
aan de [index.html](index.html). Je voegt hem toe door de naam en eventueel relevante CSS class
47+
toe te voegen aan de lijst met "data includes":
48+
49+
<pre>
50+
&lt;section data-include-format="markdown" data-include="ch01.md" class="informative">&lt;/section>
51+
&lt;section data-include-format="markdown" data-include="ch02.md">&lt;/section>
52+
</pre>
53+
54+
Dat wil zeggen, voeg een `<section>` toe met op de plaats van "ch01.md" de naam van het bestand.
55+
56+
Voor een volledige lijst van CSS classes zie de [ReSpec Documentation](https://respec.org/docs/#css-classes)
57+
58+
Deze classes zijn ook binnen de markdown files te gebruiken op de volgende manier:
59+
```<div class="example">voorbeeld</div>```
60+
61+
### Automatische controles
62+
Bij het uploaden van een nieuwe versie naar github worden er via github actions 2 controles
63+
uitgevoerd:
64+
65+
Een WCAG-check (Web Content Accessibility Guidelines), deze guidelines
66+
gemaakt door W3C zorgen voor een verbetering van de toegankelijkheid
67+
van webapplicaties verbeterd voor zowel verschillende apparaten
68+
als voor mensen met een beperking.
69+
70+
Een link-check, deze check controleert of alle links die in het
71+
document staan ook naar iets wijzen.
72+
73+
outputs van deze tests zijn te vinden in het tabblad `Actions` in de GitHub repository.
74+
75+
### Publiceren van documenten
76+
Na een update in de main branch wordt er een statische HTML en een PDF-versie gemaakt.
77+
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.
78+
De PDF-versie wordt aangemaakt indien `alternateFormats` in `config.js` geconfigureerd staat:
79+
```js
80+
alternateFormats: [
81+
{
82+
label: "pdf",
83+
uri: "template.pdf",
84+
},
85+
]
86+
```
87+
88+
### Transitie van 'oude' Geonovum ReSpec naar NL-ReSpec van Logius
89+
90+
Hieronder staan de instructies voor gebruikers van Geonovum ReSpec die willen overstappen naar de nieuwe NL-ReSpec.
91+
92+
Als je een gepubliceerd document wilt omzetten naar de nieuwe ReSpec:
93+
- Dit hoeft niet. Eenmaal op docs gepubliceerde documenten hoeven niet aangepast te worden.
94+
95+
Als je een bestaand werkdocument wilt omzetten naar de nieuwe ReSpec:
96+
- 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.
97+
- Pas in `config.js` de `specStatus aan. De afkortingen zijn veranderd (!):
98+
- `wv` of `WV` = Werkversie
99+
- `cv` of `CV` = Consultatieversie
100+
- `vv` of `VV` = Versie ter vaststelling
101+
- `def` of `DEF` = Vastgestelde versie
102+
- `basis` of `BASIS` = Basis Document
103+
- 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:
104+
105+
`title: "Informatiemodel Golf",`
106+
107+
Als je een nieuw werkdocument gaat maken:
108+
- 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

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: vul in abstract.md een abstract in.

‎ch01.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Niet-normatieve deel
2+
3+
Bijvoorbeeld een introductie is niet normatief.
4+
5+
<p class="note" title="index">
6+
Dit hoofdstuk is toegevoegd met `class="informative"` in `config.js`.
7+
</p>
8+
9+
## Een subparagraaf
10+
11+
| Sleutel | Waarde |
12+
| ------- | ------ |
13+
| key | value |
14+

‎ch02.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Meer inhoud
2+
3+
## Definities
4+
<dfn>Definitie</dfn>: Een definitie is een beschrijving van een woord. Een ander woord voor _definitie_ is betekenis of beschrijving.
5+
6+
## Afbeeldingen
7+
8+
Afbeeldingen krijgen een nummer en vermelding in de figurenlijst [[[#tof]]].
9+
10+
![Tekstueel alternatief voor toegankelijkheid](media/Bomos_levenscyclus.svg "Onderschrift")
11+
12+
## Referenties
13+
14+
Referenties kunnen op drie plaatsen staan:
15+
16+
- In SpecRef [Specref](https://www.specref.org/)
17+
- In de organisatie configuraties [[SemVer]]. Deze zijn te vinden op [tools.geostandaarden.nl](https://github.com/Geonovum/tools.geostandaarden.nl/blob/main/tools.geostandaarden.nl/respec/config/geonovum-config.js).
18+
- In het document, zoals [[MIM12]]. Deze zijn te vinden in `js/config.js`.
19+
20+
Referentie uit organisatie lijst [[SemVer]] of de locale lijst [[MIM12]]. Lijst staat in `organisation-config.js`. Alleen referenties die in de tekst voorkomen worden getoond.
21+
22+
We gebruiken een <a>definitie</a> om een woord te omschrijven.
23+
24+
## Optioneel
25+
26+
De onderstaande secties (_Conformiteit_ e.d.) zijn optioneel, zie `index.html`:
27+
28+
```
29+
<body>
30+
<section id="abstract" data-include-format="markdown" data-include="abstract.md"></section>
31+
<section id="sotd"></section><!-- Wordt automatisch gevuld -->
32+
<section data-include-format="markdown" class="informative" data-include="ch01.md"></section>
33+
<section data-include-format="markdown" data-include="ch02.md"></section>
34+
<!-- Hieronder optionele secties. Worden automatisch gevuld -->
35+
<section id='conformance'></section>
36+
<section id='tof'></section>
37+
<section id="index"></section>
38+
</body>
39+
```

‎index.html

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html>
2+
<html lang="nl">
3+
4+
<head>
5+
<meta content="text/html; charset=utf-8" http-equiv="content-type">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
7+
<script src="https://cdn.jsdelivr.net/gh/digitalbazaar/[email protected]/dist/main.js" class="remove"></script>
8+
<script src="https://tools.geostandaarden.nl/respec/config/geonovum-config.js" class="remove"></script>
9+
<script src="js/config.js" class="remove"></script>
10+
<script class="remove">
11+
respecConfig.localBiblio = Object.assign(organisationConfig.localBiblio,respecConfig.localBiblio);
12+
respecConfig = {...organisationConfig, ...respecConfig};
13+
</script>
14+
<script>document.title = respecConfig.title</script>
15+
<title>TODO: Vul hier de titel in</title>
16+
<link rel="shortcut icon" type="image/x-icon" href="https://tools.geostandaarden.nl/respec/style/logos/Geonovum.ico" />
17+
<script src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js" class="remove" async></script>
18+
<!-- De volgende regel zorgt ervoor dat plaatjes uit Imvertor niet geschaald
19+
worden, zodat de imagemap die op deze plaatjes zit werkt. -->
20+
<style>div.imageinfo img {max-width: none;}</style>
21+
</head>
22+
23+
<body>
24+
<section id="abstract" data-include-format="markdown" data-include="abstract.md"></section>
25+
<section id="sotd"></section><!-- Wordt automatisch gevuld -->
26+
27+
<!-- TODO: voeg hier je eigen hoofdstukken toe -->
28+
<section data-include-format="markdown" data-include="ch01.md" class="informative"></section>
29+
<section data-include-format="markdown" data-include="ch02.md"></section>
30+
<section data-include-format="markdown" data-include="mermaid.md"></section>
31+
32+
<!-- Als je document een door imvertor gegenereerde catalogus bevat kan je die -->
33+
<!-- opnemen door de volgende regel uit commentaarhaakjes te halen en aan te passen -->
34+
<!-- <div id="catalogus" data-include="data/TODO-cat.respec.html" data-include-replace=true></div> -->
35+
36+
<!-- De volgende paragrafen worden automatisch gevuld. Je kunt ze uitzetten -->
37+
<section id='conformance'></section> <!-- Gegeneerd hoofdstuk over conformiteit-->
38+
<section id='tof'></section><!-- Lijst van figuren -->
39+
<section id="index"></section><!-- Lijst van begrippen -->
40+
</body>
41+
42+
</html>

‎js/config.js

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
let respecConfig = {
2+
useLogo: true,
3+
useLabel: true,
4+
// title is verplicht! Neem hier de titel van het document op ----------------------
5+
title: "[TODO: Neem titel op in config.js]",
6+
//-- specStatus is verplicht! (activeer 1 van de volgende) --------------------------
7+
specStatus: "wv", // Werkversie
8+
//specStatus: "cv", // Consultatieversie
9+
//specStatus: "vv", // Versie ter vaststelling
10+
//specStatus: "def", // Vastgestelde versie
11+
//specStatus: "basis", // Basis Document
12+
//-- specType is verplicht bij alle andere dan BASIS ---------------------------------
13+
//specType: "NO", // Norm
14+
//specType: "ST", // Standaard
15+
//specType: "IM", // Informatie Model
16+
//specType: "PR", // Praktijkrichtlijn
17+
specType: "HR", // HandReiking
18+
//specType: "WA", // Werkafspraak
19+
//specType: "BD", // Beheer Documentatie
20+
//specType: "AL", // Algemeen document
21+
//specType: "BP", // Best Practice
22+
//-- pubDomain is verplicht! (komt in de URL) -------------------------------------
23+
//-- zie: https://geonovum.github.io/handleiding-tooling/ReSpec/#pubdomain
24+
pubDomain: "TODO",
25+
//-- license: voor de geldende gebruiksvoorwaarden. Default is cc-by.
26+
//license: "cc-by-nd", // bronvermelding, geen afgeleide werken (default)
27+
//license: "cc0", // Public Domain Dedication
28+
license: "cc-by", // Attribution, met bronvermelding
29+
//-- TODO shortName is verplicht! (komt in de URL: kies logische afkorting)--------------
30+
shortName: "NL-ReSpec-GN-template",
31+
32+
//edDraftURI = De URI van de draft version. Deze wordt automatisch afgeleid van de github URI; maar kan hier overschreven worden.
33+
//edDraftURI: ["https://geonovum.github.io", "/", "shortName"],
34+
35+
//-- publishDate is verplicht -------------------------------------------------------
36+
//-- NB: in de werkversie uitzetten, want dan pakt Respec de pushdate ---------------
37+
//publishDate: "2023-03-28",
38+
//eventueel is het mogelijk een versienummer mee te geven, maar bij Geonovum werken we gewoonlijk alleen met datum als onderdeel van de permanente URI.
39+
//publishVersion: "0.0.2",
40+
//previousVersion: "0.0.1",
41+
//-- Voor dit blok geldt: alleen als er eerdere versies zijn en altijd beiden aan/uit!
42+
//previousPublishDate: "2014-05-01",
43+
//previousMaturity: "CV",
44+
//-- TODO: de namen van de Editor(s) / Redacteur(en)---------------------------------------
45+
//-- vul in: per Editor: name:, company:, companyURL: -------------------------------
46+
editors:
47+
[
48+
{
49+
name: "voornaam achternaam",
50+
company: "Geonovum",
51+
companyURL: "https://www.geonovum.nl",
52+
}
53+
],
54+
//-- de namen van de auteur(s) ------------------------------------------------------
55+
//-- vul in: per auteur: name:, company:, companyURL: -------------------------------
56+
authors:
57+
[
58+
{
59+
name: "voornaam achternaam",
60+
company: "Geonovum",
61+
companyURL: "https://www.geonovum.nl",
62+
}
63+
],
64+
// TODO: Vul de github URL in.
65+
//neem hier de URL van de github repository op waar het respec document in staat
66+
github: "https://github.com/Geonovum/NL-ReSpec-GN-template",
67+
// Create PDF and link to file in header (optional):
68+
// TODO: Change the filename as preferred.
69+
alternateFormats: [
70+
{
71+
label: "pdf",
72+
uri: "template.pdf",
73+
},
74+
],
75+
// Lokale lijst voor bibliografie
76+
// - Kijk eerst naar de beschikbare www.specref.org .
77+
// - Kijk daarna in de organisatieconfig.
78+
// - Voeg dan pas hieronder toe.
79+
localBiblio:
80+
{
81+
MIM12: {
82+
id: "MIM12",
83+
title: "MIM - Metamodel Informatie Modellering (Versie 1.2)",
84+
href: "https://docs.geostandaarden.nl/mim/def-st-mim-20240613/",
85+
status: "Definitief",
86+
publisher: "Geonovum",
87+
date: "2024-06-13"
88+
}
89+
}
90+
};

0 commit comments

Comments
 (0)