Module:Langue/Documentation

Aller à la navigation Aller à la recherche

La documentation pour ce module peut être créée à Module:Langue/Documentation/doc

Erreur de script : Erreur Lua à la ligne 1 : unexpected symbol near '<'.

<includeonly>{{protection}}</includeonly>

== Utilisation ==

Fonctions exportables :
* <code>codeLangue(frame)</code> : Convertit en code de langue IETF les noms français de langues les plus couramment citées.
* <code>codeLangue2(frame)</code> : Similaire à <code>codeLangue</code> à une exception près : si le nom de la langue ne se trouve pas dans la liste qui suit, le modèle n'affiche rien.
* <code>directionLangue(frame)</code> : Convertit en code de direction (rtl ou ltr) les codes ou noms français de langues.
* <code>lienLangue(frame)</code> : À partir d'un code de langue, retourne un lien avec le nom descriptif de celle-ci et pointant vers son article.
* <code>nomLangue(frame)</code> : À partir d'un code de langue, retourne le nom descriptif de celle-ci.
* <code>articleLangue(frame)</code> : À partir d'un code de langue, retourne le titre de l'article concernant celle-ci.
* <code>lang(frame)</code> : Indique la langue d’un texte dans le code [[HTML]], notamment pour les synthétiseurs vocaux et l’indexation correcte des inclusions de mots en langue différente par les moteurs de recherche.
* <code>langue(frame)</code> : Similaire à <code>lang</code> mais permet d’employer dans certains cas le nom de la langue en toutes lettres.
* <code>indicationDeLangue(frame)</code> : Utilisable comme métamodèle pour créer des indications de langue ({{cf.}} {{fr}}, {{de}}{{etc.}}).
* <code>indicationMultilingue(frame)</code> : Similaire à <code>indicationDeLangue</code> à l'exception qu'elle indique plusieurs langues. Sans paramètre, {{mul}} est indiqué.
* <code>langueAvecNom(frame)</code> : Indique le nom de la langue avant un court texte dans une langue donnée et met le texte en langue étrangère entre balises <code>xml:lang</code>. Similaire à <code>indicationDeLangue</code> mais avec la détermination automatique du nom et de la direction de la langue. Elle est donc un peu moins rapide.
* <code>tableauLangues(frame)</code> : Génère un tableau triable de la liste des langues disponibles dans Module:langue/Data.

Documentation TODO #1 - la fonction <code>langue</code> est maintenant un alias de la fonction <code>lang</code> (cf. [{{fullurl:Module:Langue|diff=prev&oldid=95780265#L-157}} 95780265#L-157] et [{{fullurl:Module:Langue|diff=prev&oldid=133914320}} 133914320])

Documentation TODO #2 - liste exhaustive <small>(en date du {{date|2024-11-20}})</small> des fonctions exposées publiquement mais ne figurant pas dans la liste au-dessus ; documenter celles ayant effectivement besoin de l'être :
* <code>determinationCode(langue)</code>
* <code>nonLatin(frame)</code>
* <code>erreurModuleData()</code>
* <code>listeCodeAlias()</code>
* <code>listeAliasCode()</code>

Modules externes et autres éléments dont ce module a besoin pour fonctionner :
* <code>[[Module:Langue/Data]]</code> : Base de données avec les codes et les noms des langues les plus courantes.

== Exemples ==
Pour des exemples, voir la [[Module:Langue/Bac à sable|page de test]] permettant de tester diverses modifications apportées.

== Voir aussi ==
* {{m|Code langue}}
* {{m|Code langue 2}}
* {{m|Direction langue}}
* {{m|Lien langue}}
* {{m|Nom langue}}
* {{m|Article langue}}
* {{m|Langue}}
* {{m|Indication de langue}}
* {{m|Mul}}
* {{m|Langue avec nom}}

{{Projet Scribunto}}

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