Modèle:Table des caractères Unicode/Légende/Documentation
Ce modèle permet d'afficher une légende pour une table de caractères Unicode (p.ex. {{Table des caractères Unicode/U0000}} – dans Table des caractères Unicode/U0000 –, ou {{Table des caractères Unicode/U0300}} – dans Table des caractères Unicode/U0300 –).
La légende construite par ce modèle est spécifique aux tables de caractères Unicode. Les tables indiquent certains caractères (point de code) avec une couleur de fond différente.
La couleur de fond précise les particularités selon les types de point de code.
Les différents fonds de cellule, dans l'affichage des points de code, sont :
- le point de code est attribué ;
- le point de code n'est pas alloué (ou n'est pas définitif) ;
- le point de code est un diacritique ;
- le point de code est un diacritique, sur deux caractères ;
- le point de code n'est pas affichable ;
- le point de code est affichable, mais de façon conditionnelle (p.ex. le trait d'union conditionnel) ;
- le point de code représente le caractère d'une écriture de droite à gauche ;
- le point de code est alloué, à usage privé ;
- le point de code est réservé, comme « non-caractères ».
La légende générée par ce modèle est configurable. Elle permet ainsi de documenter les particularités des points de code présents dans la table.
Paramètre
Un seul paramètre, optionnel, consiste en la combinaison de différents attributs, séparés par des espaces :
- allouéOui (facultatif)
- allouéNon
- diacritiqueOui
- diacritiqueDouble
- affichableNon
- affichableOption
- droiteAgauche
- usagePrivé
- nonCaractère
Cette liste de neuf noms d'attributs correspond, dans le même ordre, aux neuf couleurs présentées dans l'introduction
La légende générée dépend uniquement des attributs invoqués. Elle ne dépend pas des attributs présents dans la table légendée.
Exemples
Pour une invocation sans paramètre :
{{Table des caractères Unicode/Légende}}affiche :
- Légende, point de code :
- alloué
Pour une invocation avec le paramètre constitué de tous les attributs :
{{Table des caractères Unicode/Légende|allouéOui allouéNon diacritiqueOui diacritiqueDouble affichableNon affichableOption droiteAgauche usagePrivé nonCaractère}}affiche :
- Légende, point de code :
- alloué
- alloué (écrit de droite à gauche)
- signe diacritique
- diacritique double
- contrôle ou mise en forme
- usage privé
- non-caractère
- non alloué
Notes :
- Dans le paramètre, l'attribut
allouéOuiest facultatif, il est toujours considéré comme actif.
Ainsi, dans la légende affichée, l'état « alloué » est toujours présent. - Si un attribut est dupliqué, seul le premier est pris en compte.
- Quel que soit leur assemblage, les attributs sont toujours affichés dans un seul ordre, celui présenté ci-dessus.
Par exemple, pour une invocation avec des attributs dans un ordre inversé et où l'attribut allouéOui est omis, et l'attribut diacritiqueOui est dupliqué :
{{Table des caractères Unicode/Légende|diacritiqueDouble diacritiqueOui diacritiqueOui allouéNon}}affiche :
- Légende, point de code :
- signe diacritique
- diacritique double
- non alloué
En illustration, pour compléter, trois exemples :
{{Table des caractères Unicode/Légende|affichableOption affichableNon}}affiche :
- Légende, point de code :
- contrôle ou mise en forme
{{Table des caractères Unicode/Légende|droiteAgauche affichableNon}}affiche :
- Légende, point de code :
- alloué (écrit de droite à gauche)
- contrôle ou mise en forme
{{Table des caractères Unicode/Légende|usagePrivé nonCaractère}}affiche :
- Légende, point de code :
- usage privé
- non-caractère