Voir la source de Module:Sports table/WL OT/Documentation

{{ébauche|modèle}}
Ce style pour le [[Module: Sports table]] basé sur Lua est destiné à construire des tableaux de groupe et de classement pour les compétitions avec un format victoire/défaite soit au bout du temps régulier, soit en prolongation (ou tirs aux buts).

Notez que ce module est largement utilisé, donc testez les changements potentiels de manière rigoureuse dans le bac à sable et assurez-vous qu'il existe un consensus avant de mettre en œuvre des changements majeurs. Le reste de cette documentation explique comment utiliser ce module avec le style WL OT dans un article ou un modèle, vérifiez la table des matières pour des éléments spécifiques.





== Utilisation ==

===Utilisation Simple===
Dans sa version la plus simple, seuls quelques paramètres sont nécessaires pour créer le tableau.
Les colonnes Différence (de buts) et Nombre de points sont calculées et créées automatiquement.

====Dans un article====
{| class="wikitable" style="background:white;"
|-
! Code: 
|<code><nowiki>{{#invoke:Sports table|main|style=WL OT</nowiki><br>
<nowiki>|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE</nowiki><br>
<br><nowiki>|win_AAA=4               |loss_AAA=0 |gf_AAA=7 |ga_AAA=0</nowiki><br>
<nowiki>|win_BBB=3 |OTwin_BBB=1  |loss_BBB=0 |gf_BBB= 8 |ga_BBB=2</nowiki><br>
<nowiki>|win_CCC=2               |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3</nowiki><br>
<nowiki>|win_DDD=0 |OTloss_DDD=1 |loss_DDD=3 |gf_DDD= 2 |ga_DDD=4</nowiki><br>
<nowiki>|win_EEE=0               |loss_EEE=4 |gf_EEE= 0 |ga_EEE=6</nowiki><br>
<br><nowiki>|name_AAA=NomEquipeA</nowiki><br>
<nowiki>|name_BBB=NomEquipeB</nowiki><br>
<nowiki>|name_CCC=[[Club sportif des Terreaux]]</nowiki><br>
<nowiki>|name_DDD=nomEQUIPE </nowiki><br>
<nowiki>|name_EEE={{Pays|Royaume d'Araucanie et de Patagonie}}</nowiki><br>
}}</code>
|-
!Rendu
|{{#invoke:Sports table|main|style=WL OT
|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_AAA=4               |loss_AAA=0 |gf_AAA=7 |ga_AAA=0
|win_BBB=3 |OTwin_BBB=1  |loss_BBB=0 |gf_BBB= 8 |ga_BBB=2
|win_CCC=2               |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=0 |OTloss_DDD=1 |loss_DDD=3 |gf_DDD= 2 |ga_DDD=4
|win_EEE=0               |loss_EEE=4 |gf_EEE= 0 |ga_EEE=6

|name_AAA=NomEquipeA
|name_BBB=NomEquipeB
|name_CCC=[[Club sportif des Terreaux]]
|name_DDD=nomEQUIPE 
|name_EEE={{Pays|Royaume d'Araucanie et de Patagonie}}
}}
|}

===Personnalisation ===

==== Index (liste) des Paramètres====

{| class="wikitable" style="background:white;"
|-
! colspan=4 |Paramètres généraux
|-
! rowspan=2 |Paramètre 
! rowspan=2 |Usage
! colspan=2 |Options / Exemple
|-
! Alternatives
! Syntaxe du code : 
|-
|rowspan=4| Gestion des dates
|rowspan=4| Update 
|-
| pour une compétition terminée (tableau définitif)
| Option: <code><nowiki>|update=complete</nowiki></code> <br>
|-
| pour une compétition en cours (tableau à jour)
|Exemple: <code><nowiki>|update=1 Janvier 2018 </nowiki></code><br>
|-
| pour une compétition future
|<code><nowiki>|update=future |start_date=1 Janvier 2323</nowiki></code>
|-
| Lien vers la source des données
| source 
|colspan=2|Exemple: <code><nowiki>|source=[https://fr.wikipedia.org]</nowiki></code>

|-
| Règles d'établissement du classement,<br> pour affichage
|class_rules 
|colspan=2| Exemple: <code><nowiki>|class_rules= 1) Points; 2) Différence de buts; 3) Buts marqués;  ... </nowiki></code>
|-
|rowspan=4| gestion du nombre de points par type de résultat, <br>pour le calcul automatique
| winpoints= <br>
| nombre de points pour une victoire (par défaut:3)
|rowspan=4|<code><nowiki>|winpoints=5</nowiki><br><nowiki>|OTwinpoints=1.2</nowiki><br><nowiki>|OTlosspoints=0.3</nowiki><br><nowiki>|losspoints=-0.1</nowiki></code>
|-
|OTwinpoints=
|nombre de points pour une victoire après prolongation ou tirs au but (par défaut:2)
|-
|OTlosspoints=
|nombre de points pour une défaite après prolongation ou tirs au but (par défaut:1)
|-
|losspoints=
|nombre de points pour une défaite (par défaut:0)
|-
| rowspan=4|Options d'affichage de l'en-tête
|postitle=
|nommage de la 1{{e}} colonne (par défaut: Position, abbréviation Pos.)
|Exemple: <code><nowiki>|postitle={{abbr|Clt.|Classement}}</nowiki></code>
|-
|group_header=
|nommage de la colonne des Groupes (2{{e}} colonne éventuelle).
| 
|-
|OTwin_header= 
|nommage de la colonne des victoires après prolongation <br>(par défaut: Victoire en prolongation, abbréviation Vp)
|Exemple: <code><nowiki>|OTwin_header={{Abbr|VTaB|Victoire aux tirs au but}}</nowiki></code>
|-
|OTloss_header=
|nommage de la colonne des défaites après prolongation <br>(par défaut: Défaite en prolongation, abbréviation Vp)
|Exemple: <code><nowiki>|OTloss_header={{Abbr|DTaB|Defaite aux tirs au but}}</nowiki></code>
|-
| rowspan=2|Options d'affichage des données
|for_against_style=
| choix de l'unité de comptage des scores (pour, contre et  différence) (par défault: buts)
| Option: <code><nowiki>|for_against_style=points</nowiki></code>
|-
|use_goal_ratio
| possibilité d'afficher un ratio pour/contre plutôt qu'une différence(par défault:no)
| Option: <code><nowiki>|use_goal_ratio=yes</nowiki></code>
|-
| rowspan=1|formattage du tableau
|teamwidth=
|largeur de la colonne des équipes
|Exemple: <code><nowiki>|teamwidth=250</nowiki></code>
|-
! colspan=4| Paramètres par équipe pour chaque équipe TTT
|-
|Nom de l'équipe
| name_TTT=
| 
|
|-
| rowspan=8|Entrée des données
|win_TTT=
| nombre de victoires à l'issue du temps réglementaire.
| 
|-
|OTwin_TTT=
| nombre de victoires après prolongations.
| 
|-
|OTloss_TTT=
| nombre de défaites après prolongations.
|
|-
|loss_TTT=
| nombre de défaites à l'issue du temps réglementaire.
| 
|-
|gf_TTT=
| nombre de buts/points pour.
|
|-
|gf_TTT=
| nombre de buts/points contre.
|
|-
|startpoints_TTT=
|nombre de points de l'équipe au début du championnat
|
|-
|bonuspoints_TTT=
|bonification du nombre de points de classement ou pénalité, si négatif
|-
! colspan=4| Paramètres de classement (jusqu'à 24 équipes)
|-
|position de chaque équipe référencée par son label
|<nowiki>|team1= |team2= |team3= ...</nowiki> 
| colspan=2|Exemple: si l'équipe reférencée AAA est en i{{e}} position <code><nowiki>|teami=AAA</nowiki></code><br>Il faut veiller à ce que tous les teami de 1 à N soient affectés.
|}


<!--

Ajouter Options de notes 
par  |note_TTT=  |note_res_RRR= |note_header_res=  |hth_TTT=, 



=====Gestion des dates=====
Elle s'effectuent avec le paramètre update  

{| class="wikitable" style="background:white;"
|-
! Code: 
! Utilisation
|-
| pour une compétition terminée (tableau définitif)
|<code><nowiki>|update=complete</nowiki></code> <br>
|-
| pour une compétition en cours avec tableau à jour
|<code><nowiki>|update=date </nowiki></code><br>
<code><nowiki>|update=1 January 1900 </nowiki></code><br>
|-
| pour une compétition future
|<code><nowiki>|update=future |start_date=1 January 2121</nowiki></code>
|}








Fonctions exportables :
* <code>fonction(frame)</code> – description (courte description de <code>fonction(frame)</code> et autres informations pertinentes).
* <code>fonction2()</code> – description2 (courte description de <code>fonction2()</code> et autres informations pertinentes).

Autres fonctions :
* <code>fonction()</code> – description2 (courte description de <code>fonction()</code> et autres informations pertinentes).

Modules externes et autres éléments dont ce module a besoin pour fonctionner :
* <code>mw.title</code> – description (courte description expliquant la dépendance de ce module externe).

== Exemples ==
Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
-->
{{Projet Scribunto}}

<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>