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 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 van het template document is hier 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. <-- Deze heb ik nog niet werkende.

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.

Aanpassingen maken aan het document gaat op 2 manieren:

• De configuratie van het document aanpassing in de config files
• Markdown of html files toevoegen/veranderen

De configuratie files bevatten informatie over de organisatie en over de status van het document. Bekijk de Logius ReSpec wiki voor meer informatie over de configuratie opties. De files zijn gesplitst in 2 files die weer in 2 verschillende repositories zijn ondergebracht: organisation-config.js en config.js.

De organisation_config (organisation-config.js) bevat configuratie properties die betrekking hebben op alle VNG-R Respec documentatie, de properties in deze file zullen zelden veranderen zoals bijv. de naam van de organisatie.

De document_config (config.js) bevat configuratie properties die alleen relevant is voor het betreffende Respec document en hoort dan ook in elke Respec renderende repository thuis.

Beide configuratie bestanden worden gelinkt in de index.html file waardoor ze beide bij het renderen van de Respec documentatie automatisch worden samengevoegd. Daardoor zijn de organisatie specifieke configuraties over alle Respec documentatie van VNG-R gelijk en hoeft deze niet steeds gekopieerd te worden. Op deze wijze zorgen we er voor dat alle VNG-R Respec documenten zo eenduidig mogelijk zijn en blijven.

In VNG-R-WOW.md staat beschreven hoe je de inhoud van het Respec document naar wens kunt aanpassen.

Rendering, automatische controles en publicatie

Het bestand '.github/workflows/build.yml' bevat een action script waarmee automatisch een drietal acties worden uitgevoerd nadat een bestand in de repository wordt gewijzigd, toegevoegd of verwijderd:

• het renderen van het Respec document;
• het checken of de gerenderde Respec html wel correct is en voldoet aan de toegankelijkheidseisen;
• het publiceren van de gegenereerde statische html en pdf naar een centrale Respec publicatie repository.

We beschrijven alle 3 de acties in het kort hieronder. Aangezien we de laatste actie nog niet werkende hebben wordt deze voorlopig nog handmatig uitgevoerd, ook dat beschrijven we. De resultaten van deze acties zijn te vinden in het tabblad Actions in de GitHub repository.

Rendering

Deze actie start het renderen van de Respec html. Vervolgens wordt er op basis daarvan een statische html en een pdf bestand gegenereerd. Die laatste 2 worden in de laatste actie gebruikt om te publiceren.

De PDF-versie wordt alleen aangemaakt indien alternateFormats in de document_config (config.js) als volgt geconfigureerd staat:

alternateFormats: [
  {
	  label: "pdf",
	  uri: "template.pdf",
  },
]

Checken

Na het renderen van de Respec html en pdf worden er via github actions 2 controles uitgevoerd op de html:

• 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. Ook wordt de validiteit van het HTML bestand gecheckt, bijv.:

  • of er geen <section> elementen met 'id' attributen voorkomen die al voorkomen in het bestand;
  • of er geen <a> elementen voorkomen met 'href' attributen die verwijzen naar <section> elementen die helemaal niet bestaan.

  Deze check moet eerst succesvol uitgevoerd zijn voordat wordt begonnen aan de volgende check. In de 'Action' die start met het woord 'Update' (zie het Actions tabblad) kun je in de actie 'Check/WCAG' de step 'Run pa11y snapshot.html' vinden. Daar kun je zien welke fouten geconstateerd zijn.

• een link-check, deze check controleert of alle links die in het document staan ook bestaan.

Publiceren van documenten

Het is de bedoeling dat het publiceren van de statische html en pdf geautomatiseerd gaat verlopen. Dat hebben we helaas nog niet op orde en om die reden doen we dit voorlopig handmatig.

Het publiceren van alle Respec documenten gebeurd via de GitHub repository 'gitdocumentatie'