diff --git a/.github/ISSUE_TEMPLATE/aanpassing_documentatie.yml b/.github/ISSUE_TEMPLATE/aanpassing_documentatie.yml new file mode 100644 index 0000000..2da0640 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/aanpassing_documentatie.yml @@ -0,0 +1,43 @@ +name: Aanpassing op documentatie +description: Stel een (tekstueele) wijziging voor in de documentatie van de Digikoppeling standaard +title: "RFC ..." +labels: ["digikoppeling", "documentatie"] +body: + - type: checkboxes + id: standaard + attributes: + label: Soort + description: Om wat voor wijziging gaat het? + options: + - label: Tekstuele fout + - label: Verbetersuggestie + - label: Onduidelijke tekst + - type: textarea + id: omschrijving + attributes: + label: Omschrijving + description: Wat is de voorgestelde wijziging? Op welke pagina of sectie staat het? + placeholder: Tik hier uw voorgestelde wijziging + validations: + required: true + - type: input + id: contact + attributes: + label: Naam + description: Naam. Uw naam wordt online getoond in het issue. U kunt ook anoniem invullem. + validations: + required: false + - type: input + id: email + attributes: + label: Email + description: E-mail adres. Uw e-mail adres wordt online getoond in het issue. U kunt ook anoniem invullem. + validations: + required: false + - type: input + id: organisatie + attributes: + label: Organisatie + description: Naam van uw organisatie. Dit veld is verplicht omdat we deze in het overzicht opnemen. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/wijzigingsformulier.yml b/.github/ISSUE_TEMPLATE/wijzigingsformulier.yml new file mode 100644 index 0000000..46dab0e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/wijzigingsformulier.yml @@ -0,0 +1,34 @@ +name: Wijzigingsformulier +description: Stel een (inhoudelijke) wijziging voor op de Digikoppeling standaard. Voor een tekstueele wijziging op de documentatie bestaat een ander formulier. +title: "RFC ..." +labels: ["Standaard: digikoppeling", "Type: wijziging"] +body: + - type: textarea + id: omschrijving + attributes: + label: Omschrijving + description: Wat is de voorgestelde wijziging? + placeholder: Vul hier de voorgestelde aanpassing in + validations: + required: true + - type: input + id: contact + attributes: + label: Naam + description: Naam. Uw naam wordt online getoond in het issue. U kunt ook anoniem invullem. + validations: + required: false + - type: input + id: email + attributes: + label: Email + description: E-mail adres. Uw e-mail adres wordt online getoond in het issue. U kunt ook anoniem invullem. + validations: + required: false + - type: input + id: organisatie + attributes: + label: Organisatie + description: Naam van uw organisatie. Dit veld is verplicht omdat we deze in het overzicht opnemen. + validations: + required: true diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..6021113 --- /dev/null +++ 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@main + 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 new file mode 100644 index 0000000..c80a0bf --- /dev/null +++ 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 new file mode 100644 index 0000000..d309d32 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# ReSpec template Logius + +Template voor Afdeling Standaarden. diff --git a/abstract.md b/abstract.md new file mode 100644 index 0000000..867a489 --- /dev/null +++ b/abstract.md @@ -0,0 +1 @@ +Tekst \ No newline at end of file diff --git a/ch01.md b/ch01.md new file mode 100644 index 0000000..72fd9c1 --- /dev/null +++ b/ch01.md @@ -0,0 +1,7 @@ +# Niet-normatieve deel + +Bijvoorbeeld een introductie. + +

+Dit hoofdstuk is toegevoegd met `class="informative"` in `config.js`. +

diff --git a/ch02.md b/ch02.md new file mode 100644 index 0000000..d864006 --- /dev/null +++ b/ch02.md @@ -0,0 +1,33 @@ +# Meer inhoud + +## Definities +Definitie: 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 definitie om een woord te omschrijven. + +## Optioneel + +De onderstaande secties (_Conformiteit_ e.d.) zijn optioneel, zie `index.html`: + +``` + +
+
+
+
+ +
+
+
+ +``` diff --git a/index.html b/index.html new file mode 100644 index 0000000..da246c4 --- /dev/null +++ b/index.html @@ -0,0 +1,28 @@ + + + + + + + + + + + + Default + + + + + +
+
+
+
+
+
+
+
+ + + diff --git a/js/config.js b/js/config.js new file mode 100644 index 0000000..6de8854 --- /dev/null +++ b/js/config.js @@ -0,0 +1,41 @@ +var respecConfig = { + useLogo: true, + useLabel: true, + license: "cc0", + specStatus: "WV", + specType: "HR", + pubDomain: "dk", + shortName: "template", + publishDate: "2023-01-31", + publishVersion: "0.0.1", + title: "Template", + // previousPublishVersion: "(none)", + 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", + }, + ], + postProcess: [window.respecMermaid.createFigures] +}; diff --git a/media/Bomos_levenscyclus.svg b/media/Bomos_levenscyclus.svg new file mode 100644 index 0000000..4e04d36 --- /dev/null +++ b/media/Bomos_levenscyclus.svg @@ -0,0 +1,3 @@ + + +
Creatie / Ontwikkeling
Creatie / Ontwikkeling
Adoptie
Adoptie
Introductiefase
Introductiefase
Implementatie / groei
Implementatie / groei
Volwaardige
 toepassing
[Not supported by viewer]
Uitfaseren
Uitfaseren
Tijd
Tijd \ No newline at end of file diff --git a/mermaid.md b/mermaid.md new file mode 100644 index 0000000..8c8fd03 --- /dev/null +++ b/mermaid.md @@ -0,0 +1,13 @@ +# Mermaid diagram +
+ +```mermaid +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` +
Mermaid voorbeeld
+
+ diff --git a/snapshot.html b/snapshot.html new file mode 100644 index 0000000..fe5aaad --- /dev/null +++ b/snapshot.html @@ -0,0 +1,672 @@ + + + + + + + + + + + + + + +titleText + +Default + + + + + + + + + + + + + + +
+

titleText

+ +

+ Logius Handreiking
+ Werkversie + +

+
+
Deze versie:
+ https://logius-standaarden.github.io/ReSpec-template/ +
Laatst gepubliceerde versie:
+ https://gitdocumentatie.logius.nl/publicatie/dk/template/ +
+
Laatste werkversie:
https://logius-standaarden.github.io/ReSpec-template/
+ + + + + +
Redacteur:
+
+ Logius Standaarden (Logius) +
+ +
Auteur:
+ Logius Standaarden (Logius) +
+
Doe mee:
+ GitHub Logius-standaarden/ReSpec-template +
+ Dien een melding in +
+ Revisiehistorie +
+ Pull requests +
+
+ + +

+ Dit document is ook beschikbaar in dit niet-normatieve formaat: + pdf +

+

+ Dit document valt onder de volgende licentie: + Creative Commons 0 Public Domain Dedication. +

+
+
+

Samenvatting

Tekst

+
+

Status van dit document

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.

1. Niet-normatieve deel

Dit onderdeel is niet normatief.

+

Bijvoorbeeld een introductie.

+
Noot: index

+Dit hoofdstuk is toegevoegd met class="informative" in config.js. +

2. Meer inhoud

+

2.1 Definities

+

Definitie: Een definitie is een beschrijving van een woord. Een ander woord voor definitie is betekenis of beschrijving.

+

2.2 Afbeeldingen

+

Afbeeldingen krijgen een nummer en vermelding in de figurenlijst 5. Lijst met figuren.

+

+

+ Tekstueel alternatief voor toegankelijkheid +
Figuur 1 Onderschrift
+
+

+

2.3 Referenties

+

Referentie uit locale lijst [SemVer]. Lijst staat in organisation-config.js. Alleen referenties die in de tekst voorkomen worden getoond.

+

We gebruiken een definitie om een woord te omschrijven.

+

2.4 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>
+
+

3. Mermaid diagram

+
+ +
A
B
C
D
+
Figuur 2 Mermaid voorbeeld
+
+ +

4. Conformiteit

Naast onderdelen die als niet normatief gemarkeerd zijn, zijn ook alle diagrammen, voorbeelden, en noten in dit document niet normatief. Verder is alles in dit document normatief.

+

5. Lijst met figuren

+

A. Index

+

A.1 Begrippen gedefinieerd door deze specificatie

+ +
+

A.2 Begrippen gedefinieerd door verwijzing

+ +
+ + + +

B. Referenties

+

B.1 Normatieve referenties

+
[SemVer]
+ Semantic Versioning 2.0.0. T. Preston-Werner. June 2013. URL: https://semver.org +
+
Logius Handreiking - Werkversie
\ No newline at end of file diff --git a/template.pdf b/template.pdf new file mode 100644 index 0000000..8e61f61 Binary files /dev/null and b/template.pdf differ