Module:Adjacent stations/Documentation
Ceci est la page de documentation de Module:Adjacent stations [modifier] [purger].
Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.
Ne doit pas être confondu avec Module:Stations voisines WD.
Ce module est initialement conçu pour un usage par le modèle anglais en:Template:Adjacent stations. Cette version importée n'est actuellement (février 2023) utilisée qu'au sein de Modèle:Rail icon.
Ce module fonctionne à l'aide des données des différentes sous-pages sur des lignes de chemin de fer. Il permet par exemple de générer des icônes comme Y à travers l'appel de modèle {{Rail icon|HSL|Y}}.
Utilisation
Format d'insertion des données
L'ajout d'informations sur un système de lignes ferroviaires se fait par la création d'une sous-page comme Module:Adjacent stations/HSL contenant des données au format :
local p = {
["system title"] = "[[Taiwan High Speed Rail]]",
["system icon"] = "[[File:Taiwan High Speed Rail Logo(Log Only).svg|18px|link=Taiwan High Speed Rail|alt=Taiwan High Speed Rail]]",
["system color"] = "c35617",
["name format"] = "color: #FFFFFF; background-color: #C35617;",
["station format"] = {
"%1 HSR station",
["Taipei"] = "Taipei Main Station",
["Nangang"] = x,
["Banqiao"] = x
},
["lines"] = {
["_default"] = {
["title"] = "[[Taiwan High Speed Rail|THSR]]",
["color"] = "c35617",
["left terminus"] = "Nangang",
["right terminus"] = "Zuoying"
}
}
}
return p
Plus précisément, ce format accepte cinq différents niveaux décrits ci-dessous. Tous les éléments pouvant être contenus par ces niveaux sont facultatifs et la plupart ne sont pas nécessaires au fonctionnement de Modèle:Rail icon qui est actuellement le seul modèle appelant ce module sur Wikipédia en français.
Niveau 1 : Données générales sur le système ferroviaire
["lang"]- chaîne de caractères. Seule valeur actuellement acceptée : "en-GB". Par défaut, vaut "en-GB".["system title"]- chaîne de caractères.["system icon"]- chaîne de caractères. Exemple :"[[Fichier:icon.svg|18px|link=XXX|alt=XXX]]".["system icon format"]- chaîne de caractères.["system color"]- chaîne de caractères. Code hexadécimal d'une couleur sans le #.["header stop noun"]- chaîne de caractères.["name format"]- chaîne de caractères.["header background color"]- chaîne de caractères. Code hexadécimal d'une couleur sans le #.["header text color"]- chaîne de caractères. Code hexadécimal d'une couleur sans le #.["station format"]- table ou chaîne de caractères.["lines"]- table. Contient la liste des lignes, qui sont les données de niveau 2.["aliases"]- table.
Niveau 2 : Liste des lignes du système
["_default"]- table ou chaîne de caractères. Contient les éventuelles valeurs par défaut pour les paramètres de niveau 3"title","icon"et"color".["nom_station"]- table ou chaîne de caractères. Chaque station est décrite par les données de niveau 3.
Niveau 3 : Données associées à ces lignes
["nom_ligne"]- table ou chaîne de caractères. Chaque ligne est décrite par les données de niveau 4.["title"]- chaîne de caractères.["short name"]- chaîne de caractères.["lang"]- chaîne de caractères.["icon"]- chaîne de caractères.["icon format"]- chaîne de caractères.["color"]- chaîne de caractères.["background color"]- chaîne de caractères.["border color"]- chaîne de caractères.["text color"]- chaîne de caractères.["left terminus"]- chaîne de caractères.["right terminus"]- chaîne de caractères.["note-mid"]- chaîne de caractères.["circular"]- booléen.["oneway-left"]- booléen.["oneway-right"]- booléen.["types"]- table.
Niveau 4 : Éventuelles données supplémentaires
["nom_type"]- table ou chaîne de caractères. Seule valeur d'un éventuel niveau de profondeur supplémentaire.
Niveau 5 : Valeurs associées à ces types
["title"]- chaîne de caractères.["short name"]- chaîne de caractères.["lang"]- chaîne de caractères.["icon"]- chaîne de caractères.["icon format"]- chaîne de caractères.["color"]- chaîne de caractères.["background color"]- chaîne de caractères.["border color"]- chaîne de caractères.["text color"]- chaîne de caractères.["left terminus"]- chaîne de caractères.["right terminus"]- chaîne de caractères.["note-mid"]- chaîne de caractères.["circular"]- booléen.
Fonctions exportables
main()– ;color()– ;box()– ;icon()– ;line()– ;station()– ;style(frame)– ;convert(frame)– .
Modules externes et autres éléments dont ce module a besoin pour fonctionner
strict– Provoque le déclenchement d'une erreur chaque fois qu'une variable est utilisée et n'est pas explicitement définie en tant que variable locale ;mw.title.new– Crée un nouvel objet title ;mw.ustring.lower– Met une chaine de caractères en minuscules ;mw.ustring.gsub– Retourne une tranche d'une chaîne de caractères ;mw.ustring.match– Cherche la première correspondance d'un motif dans une chaine de caractères ;mw.text.split– Découpe une chaine de caractères en sous-chaines et retourne le résultat sous la forme d'un tableau ;mw.text.trim– Enlève les espaces et autres caractères au début et à la fin d'une chaine de caractères ;mw.clone– Crée une copie de la valeur pour pouvoir l'exploiter sans la modifier ;Module:Yesno– Module permettant le traitement des chaînes de caractères « oui » et « non » comme des booléens ;Module:Arguments– Module simplifiant l'utilisation des arguments avec#invoke;Module:Trim quotes– Module retirant les guillemets simples'et doubles"lorsqu'elles entourent une chaîne de caractères ;Module:Color contrast– Module contenant des fonctions liées au calcul du contraste entre deux couleurs .
Sous-pages
Module:Adjacent stations/i18n– Contient les données de mise en forme propres à chaque langage. Actuellement, contient uniquement les données pour 'en-GB'.
Actuellement, une seule sous-page contient des informations décrivant des lignes ferroviaires :
Module:Adjacent stations/HSL– données des lignes ferroviaires d'Helsinki.
Modules lua utilisant ce module
Aucun
Modèles appelant directement ce module
Exemples
