Module:données Unicode/Documentation

 Documentation[voir] [modifier] [historique] [purger]

Ce module définit des fonctions permettant de manipuler les données d’Unicode.

Fonctions pour modules

getBlocks()

Retourne la liste de tous les blocs Unicode.

Type de retour

table

getScripts()

Retourne la liste de tous les scripts Unicode.

Type de retour

table

getScriptRanges()

Retourne la liste des plages de tous les scripts Unicode.

Type de retour

table

getBlock(lowerCodepoint)

Retourne le bloc Unicode dont le point de code le plus petit correspond au paramètre ou nil si aucun ne correspond.

Paramètres

• lowerCodepoint (entier) : La borne inférieure du bloc (point de code).

Type de retour

table ou nil

getBlockForChar(char)

Retourne le bloc Unicode contenant le caractère donné ou nil s’il n’appartient à aucun bloc. Lance une erreur si aucun caractère ou plusieurs sont passés.

Paramètres

• char (chaîne) : Le caractère.

Type de retour

table ou nil

getScript(code)

Retourne le script Unicode correspondant au code donné ou nil si aucun ne correspond.

Paramètres

• code (chaîne) : Le code du script.

Type de retour

table ou nil

getScriptForChar(char)

Retourne le script Unicode pour le caractère donné. Lance une erreur si aucun caractère ou plusieurs sont passés.

Paramètres

• char (chaîne) : Le caractère.

Type de retour

table

getScriptForText(text)

Retourne le script Unicode pour le texte donné. Si le texte est composé de caractères dans plusieurs scripts, autres que Common ou Inherited, le script retourné est Common.

Paramètres

• text (chaîne) : Le texte.

Type de retour

table

getScriptsForText(text)

Retourne les scripts Unicode pour le texte donné.

Paramètres

• text (chaîne) : Le texte.

Type de retour

table

textHasScript(text, scriptCode)

Indique si le texte donné est dans le script Unicode donné. Retourne faux si le code ne correspond à aucun script existant.

Paramètres

• text (chaîne) : Le texte.
• scriptCode (chaîne) : Le code du script.

Type de retour

booléen

setWritingDirection(text)

Définit le sens d’écriture pour le texte donné, à partir de son script Unicode, en l’insérant dans une balise span.

Paramètres

• text (chaîne) : Le texte.

Type de retour

chaîne

Fonctions pour modèles

blockReference

Retourne le wikicode pour le modèle Modèle:R:Bloc Unicode.

Paramètres

• 1 (entier, optionnel) : Le point de code de la borne inférieure du bloc (décimal ou hexadécimal avec préfixe « 0x »). Si ce paramètre n’est pas renseigné, le code sera extrait du titre de la page.

Type de retour

chaîne

writingDirection

Définit le sens d’écriture pour le texte donné, à partir de son script Unicode, en l’insérant dans une balise span.

Paramètres

• 1 (chaîne) : Le texte.

Type de retour

chaîne

codepoint

Retourne le point de code Unicode du caractère donné. Lance une erreur si aucun caractère ou plusieurs sont passés.

Paramètres

• 1 (1 seul caractère) : Le caractère dont on veut le point de code.
• hexa (booléen, défaut = faux) : Indique si le point de code doit être retourné en hexadécimal (cf. Module:paramètres pour les valeurs possibles). La valeur hexadécimale est retournée sans le préfixe « 0x ».

Type de retour

chaîne ou entier

character

Retourne le caractère correspondant au point de code Unicode donné. Lance une erreur si le point de code est invalide.

Paramètres

• 1 (entier) : Le point de code (décimal ou hexadécimal avec préfixe « 0x »).

Type de retour

chaîne

Liste des sous-pages

• /data/blocks : Blocs
• /data/scripts : Scripts
• /data/script_ranges : Plages des scripts

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis la page Module:données Unicode/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.