Sjabloon:ReleaseNotes: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
(Update documentation for the optional release parameter)
k
 
Regel 63: Regel 63:
 
=== De release-cel ===
 
=== De release-cel ===
  
Wanneer de parameter <code>release</release> is meegegeven, genereert het sjabloon een cel waarin deze waarde terugkomt, gevolgd door de kolommen met de details van de issues.
+
Wanneer de parameter <code>release</code> is meegegeven, genereert het sjabloon een cel waarin deze waarde terugkomt, gevolgd door de kolommen met de details van de issues.
  
 
Doorgaans zal een release meer dan één issue bestrijken en zal deze cel overkoepelend zijn over de rijen met issue-details. Het aantal issues waarover de cel wordt uitgesmeerd, wordt meegegeven met de parameter <code>issues</code> (het is onmogelijk, of in ieder geval erg lastig, om het aantal issues in de parameters te tellen). Als deze parameter wordt weggelaten, wordt aangenomen dat dit 1 is.
 
Doorgaans zal een release meer dan één issue bestrijken en zal deze cel overkoepelend zijn over de rijen met issue-details. Het aantal issues waarover de cel wordt uitgesmeerd, wordt meegegeven met de parameter <code>issues</code> (het is onmogelijk, of in ieder geval erg lastig, om het aantal issues in de parameters te tellen). Als deze parameter wordt weggelaten, wordt aangenomen dat dit 1 is.

Huidige versie van 28 mei 2020 om 09:38

|-


Doel

Bij elke release worden de release notes van het desbetreffende issue in een tabel op de wiki geplaatst. Typisch bevat een tabelrij voor een specifieke release de beschrijving van een aantal issues in de laatste kolommen, daarvóór een overkoepelende cel met het release-nummer, en dáárvoor een overkoepelende cel met het package-nummer. Soms omvat een package meerdere releases en moet de package-cel worden uitgesmeerd.

Dit sjabloon is bedoeld om het deel van de tabel voor een specifieke release te genereren, met optioneel package-versie, release-nummer, en de issues.

Gebruik

Basis

Het sjabloon kan op pagina's ingezet worden met:

{{ReleaseNotes|[package=<package-omschrijving>]|[packageIssues=<aantal issues voor package>]|[release="<release-omschrijving>]|[issues=<aantal issues>]|<issue-1>|<issue-2>|...}}

Dit wordt vertaald naar een tabelrij met:

  • optioneel een kolom met de package-omschrijving, die mogelijk meerdere rijen overbrugt (zie parameters package en packageIssues
  • optioneel een kolom met het release-omschrijving, die mogelijk meerdere rijen overbrugt (zie parameters release en issues
  • per issue een rij met eerst de link naar het issue en vervolgens de release notes van dat issue (dit is afhankelijk van Sjabloon:BITS-issue)

Deze tabelrij bevat een "nieuwe rij"-aanduiding (|-) aan de bovenkant, maar niet aan de onderkant. Het sjabloon kan dus ingezet worden als vervanging van een gehele rij, maar de tabel-header en -footer moeten handmatig worden toegevoegd.

De release-cel

Wanneer de parameter release is meegegeven, genereert het sjabloon een cel waarin deze waarde terugkomt, gevolgd door de kolommen met de details van de issues.

Doorgaans zal een release meer dan één issue bestrijken en zal deze cel overkoepelend zijn over de rijen met issue-details. Het aantal issues waarover de cel wordt uitgesmeerd, wordt meegegeven met de parameter issues (het is onmogelijk, of in ieder geval erg lastig, om het aantal issues in de parameters te tellen). Als deze parameter wordt weggelaten, wordt aangenomen dat dit 1 is.

De package-cel

Wanneer de parameter package is meegegeven, wordt er vóór de release-kolom een kolom geplaatst die deze waarde bevat en die eveneens issues issue-rijen beslaat.

Het aantal rijen voor deze kolom kan overschreven worden met de parameter packageIssues. Deze specificeert domweg het totaal aantal issues dat het package omvat.

Dit mechanisme kan gebruikt worden om meerdere releases onder hetzelfde package te scharen, bv.

{{ReleaseNotes|package=MedMij-1.0.0|packageIssues=4|release=2.1.1|issues=3|MM-200|MM-300|MM-400}}
{{ReleaseNotes|release=2.1.1|MM-100}}

De issues

De issues worden opgesomd met hun code zoals ze in BITS staan. Er kunnen maximaal 20 issues aan een release worden gehangen, en elk issue moet gedefinieerd zijn is Sjabloon:BITS-issue. Zie verder de documentatie van dat sjabloon.

Zoals eerder aangegeven, moet het aantal issues worden doorgegeven met de issues-parameter.

Noot: over de code

Het sjabloon bevat op veel plekken de code . Dit is om een newline te behouden die anders in de #if-switch wordt weggetrimd. Deze tags worden bij het renderen verwijderd en hebben dus geen invloed op de uiteindelijke output.