Module:SportsRankings/doc

Koppelingen toevoegen
Uit Wikipedia, de vrije encyclopedie

Module om sport rankings van (landen)ploegen in verschillende sporten weer te geven. De data die gebruikt wordt voor de verschillende rankings staat in aparte module subpagina's waardoor deze per ranking geactualiseerd kan worden.

De module genereert ranking informatie in twee hoofdvormen, te weten "item" of "lijst" (tabel) achtige informatie.

Huidige data subpagina's[brontekst bewerken]

Sjablonen die gebruik maken van de module[brontekst bewerken]

Sjablonen die gebruik maken van de "item" functionaliteit[brontekst bewerken]

Sjablonen die gebruik maken van de "lijst" (tabel) functionaliteit[brontekst bewerken]

  • Nog geen

Algeme toelichting bij de parameters[brontekst bewerken]

Verder op deze pagina wordt gesproken over 2 soorten parameters, te weten:

  • positieparameter → Dit is een parameter waarbij het van belang is als hoeveelste parameter deze wordt meegegeven en alleen van de vorm "waarde" is. Wanneer hieronder een parameter als positieparameter wordt aangemerkt, staat bij deze parameter een integer (positie) vermeldt. E.g. de positieparameter met daarbij als getal 3, moet als 3e parameter (de waarde na het 3e "|" teken) meegegeven worden.
  • naamparameter → Bij deze parameters is het niet van belang als hoeveelste ze worden meegegeven, met die beperking dat ze niet op een positie mogen staan waar een positieparameter wordt verwacht. Ze zijn van de vorm "naam=waarde".

Bij de aanroep van de module worden als eerste de positieparameters meegegeven in een voorgeschreven volgorde, gevolgd door de naamparameters in willekeurige volgorde. De positieparameters zijn dan in beginsel verplicht en de naamparameters optioneel.

Gebruik[brontekst bewerken]

"Item" gericht[brontekst bewerken]

Formaat[brontekst bewerken]

{{#invoke:SportsRankings|<item functie>|<ranking>|<land>|[mdy]}}

Parameters[brontekst bewerken]

Parameter Soort Omschrijving Type Status Opmerking
item functie 1 positioneel Er zijn 3 "item" gerichte functionaliteiten, te weten:
  • cur → geeft de actuele (current) positie van een ploeg in een ranking.
  • max → geeft de historisch maximale (beste) positie van een ploeg en de periode(n) wanneer de ploeg op die positie stond.
  • min → geeft de historisch minimale (slechste) positie van een ploeg en de periode(n) wanneer de ploeg op die positie stond.
 string verplicht Beperkt zich tot één van de drie gedefinieerde "item" functionaliteiten. Niet alle functionaliteiten hoeven te zijn geïmplementeerd. Dit is afhankelijk van de beschikbare informatie bij de bron. Welke van deze 3 functiomaliteiten is geimplementeerd is te zien in het databestand van de ranking. Indien daar een lijst "data.<functionaliteit>rankings" aanwezig is, dan is de desbetreffende functionaliteit geïmplementeerd.
ranking 2 positioneel De naam van de te gebruiken ranking zoals aangegeven bij "Huidige data subpagina's" string verplicht Beperkt zich tot één van de aanwezige datasets
team 3 positioneel De naam van de ploeg waarvoor we ranking informatie willen weten of de voor de ploeg gehanteerde afkorting in de desbetreffende ranking, e.g. de FIFA-code string verplicht
mdy |mdy= naam Standaard wordt in de ranking informatie het datum format "dmy" gebruikt. Met deze parameter kan voor het datum formaat "mdy" worden gekozen. string optioneel Elke waarde (dus niet leeg) voldoet, echter omwille van duidelijkheid wordt aangeraden on "ja" of "yes" te gebruiken.

"Lijst" gericht[brontekst bewerken]

"list"[brontekst bewerken]

Formaat[brontekst bewerken]

{{#invoke:SportsRankings|<lijst functie>|<ranking>|[startpositie]|[eindpositie]|[mdy]|[select]|[caption]|[header1]|[header2]|[header3]|[header4]|[header5]|[footer1]|[footer2]|[footer3]|[footer4]|[footer5]|[style]|[selection_header]|[rank_header]|[change_header]|[team_header]|[points_header]}}

of

{{#invoke:SportsRankings|<lijst functie>|<ranking>|[startpositie]|[eindpositie]|[mdy]|[selecteer]|[uitleg]|[koptekst1]|[koptekst2]|[koptekst3]|[koptekst4]|[koptekst5]|[voettekst1]|[voettekst2]|[voettekst3]|[voettekst4]|[voettekst5]|[style]|[selectie_kop]|[rang_kop]|[poswijz_kop]|[team_kop]|[punten_kop]}}

Parameters[brontekst bewerken]
Parameter Soort Omschrijving Type Status Opmerking
Lijst functie 1 positioneel list → genereert een lijst (tabel) van ploegen uit de ranking van beginpositie (standaard 1) t/m eindpositie (standaard 10). string verplicht Hier altijd de functionaliteit "list".
Ranking 2 positioneel De naam van de te gebruiken ranking zoals aangegeven bij "Huidige data subpagina's" string verplicht Beperkt zich tot één van de aanwezige datasets
beginpositie 3 positioneel De startpositie in de ranking van de landen die in de lijst moet worden opgenomen. integer verplicht/(optioneel) Een "lege" waarde betekent ongedefinieerd. Indien niet gedefinieerd, wordt standaard de waarde 1 gehanteerd. Als de parameter leeg is, en ook bij de parameter "eindpositie" een lege waarde wordt gekozen, en verder ook geen enkele naamparemeter wordt gebruikt (de aanroep van de module eindigt dus op "||}}"), dan krijgt deze parameter het karakter van een optionele parameter en kan in zijn geheel worden weggelaten.
eindpositie 4 positioneel De eindpositie in de ranking van de landen die in de lijst moet worden opgenomen. integer optioneel Een "lege" waarde betekent ongedefinieerd. Indien niet gedefinieerd, wordt standaard de waarde 10 gehanteerd. Als de parameter leeg is, en ook geen enkele naamparemeter wordt gebruikt (de aanroep van de module eindigt dus op "|}}"), dan krijgt deze parameter het karakter van een optionele parameter en kan in zijn geheel worden weggelaten.

"list2"[brontekst bewerken]

Formaat[brontekst bewerken]

{{#invoke:SportsRankings|<lijst functie>|<ranking>|<ploeg>|[positiebreedte]|[mdy]|[select]|[caption]|[header1]|[header2]|[header3]|[header4]|[header5]|[footer1]|[footer2]|[footer3]|[footer4]|[footer5]|[style]|[selection_header]|[rank_header]|[change_header]|[team_header]|[points_header]}}

of

{{#invoke:SportsRankings|<lijst functie>|<ranking>|<ploeg>|[positiebreedte]|[mdy]|[selecteer]|[uitleg]|[koptekst1]|[koptekst2]|[koptekst3]|[koptekst4]|[koptekst5]|[voettekst1]|[voettekst2]|[voettekst3]|[voettekst4]|[voettekst5]|[style]|[selectie_kop]|[rang_kop]|[poswijz_kop]|[team_kop]|[punten_kop]}}

Parameters[brontekst bewerken]
Parameter Soort Omschrijving Type Status Opmerking
Lijst functie 1 positioneel list2 → genereert een lijst (tabel) van ploegen uit de ranking vanaf de positie van de aangegeven ploeg - positiebreedte (standaard 2) t/m de positie van de aangegeven ploeg + positiebreedte (standaard 2). string verplicht Hier altijd de functionaliteit "list2".
Ranking 2 positioneel De naam van de te gebruiken ranking zoals aangegeven bij "Huidige data subpagina's" string verplicht Beperkt zich tot één van de aanwezige datasets
ploeg 3 positioneel De naam van de ploeg waarvoor we ranking informatie willen weten of de voor de ploeg gehanteerde afkorting in de desbetreffende ranking, e.g. de FIFA-code opgenomen. string verplicht
positiebreedte 4 positioneel Waarde die aangeeft hoeveel posities voor en na de positie van de aangegeven ploeg in de lijst (tabel) moeten worden opgenomen. Het aantal getoonde ploegen is dus 2×<waarde>+1. integer verplicht/(optioneel) Een "lege" waarde betekent ongedefinieerd. Indien niet gedefinieerd, wordt standaard de waarde 2 gehanteerd. Als de parameter leeg is, en ook geen enkele naamparemeter wordt gebruikt (de aanroep van de module eindigt dus op "|}}"), dan krijgt deze parameter het karakter van een optionele parameter en kan in zijn geheel worden weggelaten.

Gemeenschappelijke optionele naamparameters "list" en "list2"[brontekst bewerken]

Voor nagenoeg al deze naamparameters bestaat zowel een Nederlandse en een Engelse variant.

Parameter Soort Omschrijving Type Status Opmerking
mdy |mdy= naam Standaard wordt in de ranking informatie het datum format "dmy" gebruikt. Met deze parameter kan voor het datum formaat "mdy" worden gekozen. string optioneel Elke waarde voldoet, echter omwille van duidelijkheid wordt aangeraden on "ja" of "yes" te gebruiken.
select

of

selecteer 		|select=

of

|selecteer= 		naam Hiermee is het mogelijk om de lijst tot een bepaalde groep te beperken. Dit kan een vorgedefinieerde groep zijn of een zelfgedefinieerde groep. De voorgedefinieerde groepen zijn te zien in het databestand dat bij de gekozen ranking hoort. de ranking. Deze zijn te vinden in de lijst "data.groups". Zelfgedefineerde groepen zijn van de vorm "<groepsnaam>:<landenlijst", waarbij "groepsnaam een vrij te kiezen naam is, en "landenlijst" een aantal landsnamen of landscodes gescheiden door ","'s (komma's). string optioneel Voor FIFA-rankings zijn dit de voorgedefinieerde groepen de namen van de 6 confederaties, te weten "AFC", "CAF", "CONCACAF", "CONMEBO", "OFC" of "UEFA", waarbij elke confederatoiegroep bestaat uit een lijst van landen aangesloten bij doe confederatie. Een voorbeeld van een zelfgedefinieerde groep zou kunnen zijn "EK20GC:NED, UKR, AUT, MKD". "EK20GC" staat hier voor de ploegen (NED, UKR, AUT, MKD) die bij het EK van 2020 (wordt/werd gespeeld in 2021) in Groep C zijn ingedeeld. Wanneer deze parameter wordt gebruikt, wordt er een extra kolom (als eerste) aan de gegenereerde lijst (tabel) toegevoegd. Deze kolom geeft de relatieve rang van de ploegen binnen de gedefinieerde groep. De kolomkop wordt standaard de naam van de voor- of zelfgedefinieerde groep.
caption

of

uitleg 		|caption=

of

|uitleg= 		naam Boven de lijst (tabel) komt een standaard regel van het formaat "<ranking> sinds <datum>" te staan. Met deze parameter kan de regel zelf gedefinieerd of onderdrukt worden. string
of
leeg 		optioneel
header1

header5

of

koptekst1

koptekst5 		|header1=

|header5=

of

|koptekst1=

|koptekst5= 		naam Met deze parameters kunnen tot 5 kopteksten naar keuze boven de lijst (tabel) gedefinieerd worden. string optioneel
footer1

footer5

of

voettekst1

voettekst5 		|footer1=

|footer5=

of

|voettekst1=

|voettekst5= 		naam Met deze parameters kunnen tot 5 voetteksten naar keuze onder de lijst (tabel) gedefinieerd worden. string optioneel
style |style= naam Voor het toekennen van extra CSS style attributen aan de lijst (tabel). Deze zijn van de vorm "<attribuut>: <waarde>;" of bij meerdere "<attribuut1>: <waarde1>; <attribuut2>: <waarde2>;" string optioneel Bij gebruik van het CSS "float" attribuut, e.g. "float: right;" is het raadzaam om direct na de module aanroep, het sjabloon {{clearboth}} te gebruiken.
selection_header

of

selectie_kop 		|selection_header=

of

|selectie_kop= 		naam Voor het wijzigen van de standaard kolomnaam van de extra kolom die wordt toegevoegd wanneer de parameter |select= wordt gebruikt. string optioneel Standaard krijgt de kolomnaan dezelfde waarde als de met de parameter |select= geselecteerde groep. Wanneer de parameter |select= niet is gebruikt wordt de waarde van deze parameter genegeerd.
rank_header

of

rang_kop 		|rank_header=

of

|rang_kop= 		naam Voor het wijzigen van de kolomnaam van de kolom die de rang van een ploeg aangeeft. string optioneel Standaard is de kolomnaam "Rang"
change_header

of

poswijz_kop 		|change_header=

of

|poswijz_kop= 		naam Voor het wijzigen van de kolomnaam van de kolom die de positieverandering van een ploeg aangeeft. string optioneel Standaard is de kolomnaam "PW"
team_header

of

team_kop 		|team_header=

of

|team_kop= 		naam Voor het wijzigen van de kolomnaam van de kolom die de naam van een ploeg aangeeft. string optioneel Standaard is de kolomnaam "Team"
points_header

of

punten_kop 		|points_header=

of

|punten_kop= 		naam Voor het wijzigen van de kolomnaam van de kolom die het aantal punten van een ploeg aangeeft. string optioneel Standaard is de kolomnaam "Punten"

Substitutie strings[brontekst bewerken]

Wanneer de parameters |caption=, |header1= |header5= of |footer1= |footer5= gebruikt worden, kunnen hierin een drietal "vaste" strings gebruikt worden.

String Betekenis Opmerking
INSERT_UPDATE_DATE Wordt vervangen door de datum waarop de laatste ranking is gepubliceerd. Bij de datum wordt er rekening gehouden of de parameter |mdy= is gedefinieerd.
INSERT_LAST_DATE Wordt vervangen door de datum waarop de op een na laatste ranking is gepubliceerd. Bij de datum wordt er rekening gehouden of de parameter |mdy= is gedefinieerd.
INSERT_REFERENCE Wordt vervangen door een referentie naar de laatste gepubliceerde ranking.


Overgenomen van "https://nl.wikipedia.org/w/index.php?title=Module:SportsRankings/doc&oldid=58959535"