Module:langues/Documentation

Documentation

Ce module permet de récupérer les informations des différentes langues définies dans Module:langues/data, notamment leur nom, à partir de leur code et vice-versa.

Fonctions pour modules

`getName(code, allowSpecial)`

Renvoie le nom d’une langue à partir de son code. Si aucune langue ne correspond, la fonction renvoie nil.

Paramètres

code (string) : Le code de la langue.
allowSpecial (boolean) : Si true, les codes de langue spéciaux seront pris en compte.

Type de retour: string ou nil

`getSortKey(code, allowSpecial)`

Renvoie la clé de tri d’une langue à partir de son code. Le nom est retourné si la clé n’est pas définie. Si aucune langue ne correspond, la fonction renvoie nil.

Paramètres

code (string) : Le code de la langue.
allowSpecial (boolean) : Si true, les codes de langue spéciaux seront pris en compte.

Type de retour: string ou nil

`getLanguageCode(name, allowSpecial)`

Renvoie le code d’une langue à partir de son nom. Si aucune langue ne correspond, la fonction renvoie nil. Voir la doc dans le code pour plus de précisions sur l’algorithme de recherche.

Paramètres

name (string) : Le nom de la langue.
allowSpecial (boolean) : Si true, les codes de langue spéciaux seront pris en compte.

Type de retour: string ou nil

`getWikimediaCode(code)`

Renvoie le code de langue Wikimedia correspondant au code de langue local. S’il n'y a pas de code spécial Wikimedia, la fonction renvoie nil.

Paramètres

code (string) : Le code de la langue.

Type de retour: string ou nil

`hasPortal(code)`

Renvoie true ou false selon que le code langue est associé à une langue qui a un portail ou non.

Paramètres

1 (string) : Le code de la langue.

Type de retour: boolean

`hasWiktionary(code)`

Renvoie true ou false selon que le code langue est associé à une langue qui possède un Wiktionnaire.

Paramètres

1 (string) : Le code de la langue.

Type de retour: boolean

Fonctions pour modèles

`languageName`

Retourne le nom de la langue ou, à défaut, une chaine vide. Veuillez utiliser le modèle {{nom langue}} plutôt que d’appeler cette fonction directement.

Paramètres (frame parente)

1 (string, optionnel) : Le code de la langue.

Type de retour: string

`languageSortKey`

Retourne la clé de tri d’une langue, à défaut, une chaine vide. Veuillez utiliser le modèle {{clé langue}} plutôt que d’appeler cette fonction directement.

Paramètres (frame parente)

1 (string, optionnel) : Le code de la langue.

Type de retour: string

`languageCode`

Retourne le code d’une langue à partir de son nom, à défaut, une chaine vide. Veuillez utiliser le modèle {{code langue}} plutôt que d’appeler cette fonction directement.

Paramètres (frame parente)

1 (string, optionnel) : Le nom de la langue.

Type de retour: string

`languageNameForList`

Retourne le nom de la langue avec la première letter en majuscule, à défaut, une chaine vide. Cette fonction est utilisée par le modèle {{L}}.

Paramètres (frame parente)

1 (string) : Le code de la langue.

Type de retour: string

`wikimediaCode`

Renvoie le code de langue Wikimedia correspondant au code de langue local. S’il n'y a pas de code spécial Wikimedia, la fonction renvoie une chaine vide.

Paramètres (frame parente)

code (string, optionnel) : Le code de la langue.

Type de retour: string

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis la page Module:langues/Documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.