Modèle:Str split/Documentation
Ceci est la page de documentation de Modèle:Str split [modifier] [purger].
Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.
Ce modèle utilise le module String2, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via une sous-page bac à sable. Voir le projet Scribunto si vous voulez en savoir plus.
Utilisation[modifier le code]
Ce modèle de manipulation de chaînes de caractères sert à découper en segments une chaîne de caractère selon un délimiteur, puis retourne le segment désiré.
Ce modèle technique est destiné à la construction d'autres modèles. Il n'est pas destiné à être utilisé directement dans les articles.
Paramètres[modifier le code]
Modèle de manipulation de chaînes de caractères. Sert à découper une chaîne en plusieurs segments selon un séparateur défini.
| Paramètre | Description | Type | État | |
|---|---|---|---|---|
| Chaîne de caractères | 1 | Chaîne de caractères sur laquelle travailler.
| Chaîne | obligatoire |
| Délimiteur | 2 | Délimiteur entre les différents segments à découper. ATTENTION : Le délimiteur « " » n'est pas utilisable ; utiliser « {{!}} » au lieu de « | ».
| Ligne de texte | obligatoire |
| Segment à retourner | 3 | Numéro du segment à retourner. La numérotation commence à 1. Utiliser une valeur négative pour compter depuis la fin de la chaîne.
| Nombre | suggéré |
| Délimiteur - plain text/Lua pattern | 4 | Fonction avancée. Définir à « false » pour traiter le délimiteur comme étant un « motif Lua ». Autrement le texte est traité comme « plain text » (par défaut).
| Ligne de texte | facultatif |
Exemples[modifier le code]
{{str split|ABC/123/XYZ|/|2}}- → 123
{{str split|ABC 123 XYZ| |2}}- → 123
{{str split| ABC 123 XYZ| |2}}- → ABC
- Si vous utilisez une espace comme séparateur, assurez-vous que votre chaîne de caractère est correctement trimée (par ex. en appelant {{trim}}), tout particulièrement si votre chaîne provient d'un paramètre positionnel non nommé. Autrement des résultats imprévisibles peuvent se produire comme ici.
{{str split|ABC 123 XYZ|" "|2}}- → 123
- Les guillemets doubles « " » sont automatiquement supprimés lors du traitement.
{{str split|Pommes, poires, oranges; Chiens, chats|%p|4|false}}- → Chiens
{{str split|Ceci est un morceau de texte à découper| |-1}}- → découper
