MedMij:VersieInfo

Uit informatiestandaarden
Versie door Pieter Edelman (overleg | bijdragen) op 28 mei 2020 om 11:57 (Change package to 1.3.x)
Naar navigatie springen Naar zoeken springen

Doel

De MedMij-informatiestandaarden hebben allemaal een versienummer volgens semver (major.minor.patch). Dit versienummer wordt gebruikt:

  • in de titel van het FO
  • in de titel van het TO
  • voor versionering van systeemrolcodes

Dit sjabloon is bedoeld om het wat makkelijker te maken deze versienummers over alle verschillende pagina's heen te beheren.

Gebruik

Dit sjabloon koppelt simpelweg de naam van een informatiestandaard binnen een release aan een versienummer.

Het sjabloon kan op pagina's ingezet worden met:

{{VersieInfo|Release|InformatieStandaard}}

Dit wordt dan vervangen door het bijbehorende versienummer. De naam van 'InformatieStandaard' dient uiteraard exact overeen te komen met de naam in dit sjabloon. 'Release' is bijvoorbeeld de MedMij-release, zoals 2019.01.

Onderhoud versienummers

Het sjabloon bestaat uit een geneste switch; de eerste tak kijkt naar de Release (de eerste parameter), de tweede naar de Informatiestandaard (de tweede parameter). Deze informatie is staat bovenaan de pagina wanneer deze bewerkt wordt.

Wanneer het nodig is om een nieuwe release toe te voegen, volstaat het om het volgende stuk toe te voegen:

| <Release> = {{#switch: {{{2}}}
 | <InformatieStandaard1> = x.x.x
 | <InformatieStandaard2> = x.x.x
 ...
 | <InformatieStandaardN> = x.x.x

}}

Afwijkende versienummers in systeemrolcodes

In sommige informatiestandaarden zijn er systeemrolcodes met een versie die afwijkt van die van de standaard als geheel. Typisch gebeurt dit wanneer er een use case is bijgekomen in een standaard; de major-versie wordt opgehoogd, maar de systeemrollen in de oorspronkelijke use case blijven de oorspronkelijke versie gebruiken (zolang er nog geen reden is om over te gaan naar een nieuwe versie).

Er is gekozen voor een pragmatische aanpak in dit soort gevallen door simpelweg een tweede entry toe te voegen voor de afwijkende major-versie; de standaard "PDF/A" staat bijvoorbeeld twee keer in het lijstje, een keer als "PDFA" en een keer als "PDFA1" voor de oudere systeemrolcodes.