Aller au contenu

Module:Vikitablo/Documentation

Une page de Wikiversité, la communauté pédagogique libre.

Ceci est la page de documentation pour Module:Vikitablo

Ce module vise à fournir des fonctions qui facilite la construction de tableau, que ce soit avec des données générées automatiquement, ou simplement des grandes quantités de données qu’on souhaite pouvoir présenter sous diverses formes de matrices.

L’idée générale du module ne le rend pas adapté à une invocation direct dans un modèle. Il est conçu pour être appelé dans un autre module, qui s’occupe de l’alimenter en données pour les cellules et en informations de mise en forme.

Liste des fonctions

[modifier le wikicode]

La fonction linvikigxi prend un tableau de chaînes et renvois la ligne où chaque élément du tableau constitue une cellule.

titoligxi(titolo)
Modifie le titre du tableau en l’affectant de titolo.
titolo
(obligatoire) la chaîne qui servira de titre au tableau
linialdonu()
Ajoute un ligne au tableau. Les prochains appels de cxelaldonu ajoutera les cellules à cette nouvelle ligne.
cxelaldonu(datumo, titoligu, stilo )
Ajoute une cellule à la ligne courante. La première ligne est automatiquement créée lors du premier ajout d’une cellule. Aussi si le premier ajout de cellule est précédé d’appels à linialdonu, le tableau contiendra autant de lignes vides.
datumo
(obligatoire) la chaîne qui correspond au contenu de la cellule.
titoligu
(facultatif) le booléen qui indique si la cellule est une cellule titre.
stilo
(facultatif) chaîne qui contient les paramètres de mise en forme de la cellule, par exemple 'colspan="2" style="background:black"'.
linvikigxi( cxelaro )
Construit et renvoie une ligne de tableau wiki à partir du tableau cxelaro formant une cellule distincte pour chaque élément de cxelaro.
cxelaro
(obligatoire) tableau de chaînes.
viktabligxi(klaso)
Construit et renvoie le tableau wiki conformément aux données précédemment passés.
klaso
(facultatif) chaîne qui nourrit le champ class du tableau. Initialisé à wikitable alternance centre par défaut.
kolonaldonu(datumaro, kolono, titoligo, stilo )
Ajoute le tableau datumaro en tant que kolono-ième colonne du tableau wiki. Si le booléen titoligo est vrai, les cellules sont des cellules titres. La chaîne stilo permet de passer des paramètres de mise en forme qui s’applique à toutes les cellules de la colonne.

Le module fourni une page de tester : Module:Vikitablo/testu.