Utilisateur:Alserv/Documentation

Attention : Idées en l'air

Lassé de passer des siècles à patauger dans les vingt modèles pour afficher des siècles,

voici une petite documentation de ce que j'aimerais avoir comme modèle. Just wishful thinking.

Ceci est la page de documentation de Utilisateur:Alserv [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son utilisateur d'origine et elle n'est pas destinée à être visualisée directement.

Ce modèle utilise le module S, 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 | modifier le code]

Les modèles S (avec lien) et S- (sans lien) permettent d'afficher les siècles en respectant les conventions typographiques.

Syntaxe[modifier | modifier le code]

Les modèles S et S- sont utilisés de la manière suivante :

{{s|numéro|format|séparateur|numéro|format|suffixe}}
{{s-|numéro|format|séparateur|numéro|format|suffixe}}

Tous les paramètres sont facultatifs, excepté le premier numéro, toujours obligatoire, et le second numéro, obligatoire quand un séparateur est spécifié. Quand un paramètre est omis, il n'est pas indispensable de le remplacer par une chaîne vide : il suffit d'aligner les paramètres voulus l'un après l'autre.

Numéro[modifier | modifier le code]

Le numéro du siècle.

Peut être écrit en chiffres romains :

{{s|XIV}} donne XIV^e siècle

ou en chiffres arabes :

{{s|17}} donne XVII^e siècle

Un siècle avant Jésus-Christ s'écrit comme un nombre négatif :

{{s|-II}} donne II^e siècle av. J.-C.
{{s|-4}} donne IV^e siècle av. J.-C.

Format[modifier | modifier le code]

Format à utiliser pour le siècle, si le format généré par défaut ne convient pas :

vide ou omis : le modèle utilisera le format le plus approprié, en fonction des autres paramètres. C'est ce qui donne en général le meilleur résultat :
- {{s|XVIII}} donne XVIII^e siècle
- {{s|X|XI}} donne X^e et XI^e siècles
- {{s|-I|au|II}} donne I^er siècle av. J.-C. au II^e siècle apr. J.-C.

« mini » : supprime toute indication après le numéro du siècle :
- {{s|I|mini}} donne I^er
- {{s|-I|mini}} donne I^er

« av » indique « siècle av. J.-C. ». Un éventuel numéro positif est forcé en numéro négatif :
- {{s|-IV|av} donne IV^e siècle av. J.-C.
- {{s|IV|av} donne IV^e siècle av. J.-C.

« ap » indique « siècle apr. J.-C. ». Un éventuel numéro négatif est forcé en numéro positif :
- {{s|III|ap} donne III^e siècle apr. J.-C.
- {{s|-III|ap} donne III^e siècle apr. J.-C.

« ec » (ec pour ère commune) indique simplement « siècle ». Un éventuel numéro négatif est forcé en numéro positif. Il est très rare de devoir utiliser cette valeur, vu qu'il est plus simple de pas spécifier le format du tout :
- {{s|II|ec}} donne II^e siècle
- {{s|-II|ec}} donne II^e siècle

« aec » (aec pour avant l'ère commune) indique simplement « siècle ». Un éventuel numéro positif est forcé en numéro négatif :
- {{s|II|aec}} donne II^e siècle
- {{s|-II|aec}} donne II^e siècle

Séparateur[modifier | modifier le code]

Un séparateur n'est admis que quand deux numéros sont spécifiés. Tout texte est admis, et sert à séparer les deux numéros. Si le séparateur n'est pas spécifié, le modèle utilisera « et ».

{{s|V|VI} donne V^e et VI^e siècles
{{s|V|ou|VI} donne V^e ou VI^e siècle

Suffixe[modifier | modifier le code]

Suffixe à ajouter à la fin. Généralement utilisé pour ajouter un « s » au dernier siècle, si le modèle ne l'ajoute pas de lui-même, mais rarement nécessaire en pratique :

les {{s|VI|mini}}, {{s|VII|mini}} et {{s|VIII|s}} donne les VI^e, VII^e et VIII^e siècles

Templatedata[modifier | modifier le code]

Mise en forme des siècles.

Paramètres du modèle
La mise en forme sur une seule ligne est préférée pour ce modèle.
Paramètre		Description	Type	État
Siècle	`1`	Numéro du siècle Exemple VII ou -VII	Chaîne	obligatoire
Format	`2`	Format du siècle Exemple mini, av, ap, ec ou aec	Chaîne	facultatif
Séparateur	`3`	Séparateur entre les siècles Exemple jusqu'au	Chaîne	facultatif
Siècle	`4`	Numéro du siècle Exemple VII ou -VII	Chaîne	facultatif
Format	`5`	Format du siècle Exemple mini, av, ap, ec ou aec	Chaîne	facultatif
Suffixe	`6`	Suffixe pour le dernier siècle Exemple s	Chaîne	facultatif

Détails[modifier | modifier le code]

Les détails dans cette section ne sont pas indispensables à la compréhension du modèle, ils reflètent surtout des détails d'implémentation.

Format par défaut[modifier | modifier le code]

Si un format n'est pas spécifié, le modèle utilisera le format suivant, par ordre de priorité décroissant :

« mini » pour le premier numéro, si deux numéros sont spécifiés et qu'ils sont tous deux positifs ou tous deux négatifs ;
- {{s|II|III}} donne II^e et III^e siècles
- {{s|-II|-III}} donne II^e et III^e siècles av. J.-C.
« av » pour le premier numéro, si deux numéros sont spécifiés et que le premier numéro est négatif et que le second numéro est positif ;
- {{s|-II|au|III}} donne II^e siècle av. J.-C. au III^e siècle apr. J.-C.
« ap » pour le premier numéro, si deux numéros sont spécifiés et que le premier numéro est positif et que le second numéro est négatif ;
- {{s|II|depuis le|-III}} donne II^e siècle apr. J.-C. depuis le III^e siècle av. J.-C.
« av » pour le second numéro, si deux numéros sont spécifiés et que le second numéro est négatif ;
- {{s|-II|-III}} donne II^e et III^e siècles av. J.-C.
« ap » pour le second numéro, si deux numéros sont spécifiés, et que le premier numéro est négatif et le second est positif ;
- {{s|-II|au|III}} donne II^e siècle av. J.-C. au III^e siècle apr. J.-C.
« ec » pour le second numéro, si deux numéros sont spécifiés, et qu'ils sont tous deux positifs ;
- {{s|II|ou|III}} donne II^e ou III^e siècle
« av » si un seul numéro est spécifié et qu'il est négatif ;
- {{s|-II}} donne II^e siècle av. J.-C.
« ec » si un seul numéro est spécifié et qu'il est positif ;
- {{s|II}} donne II^e siècle

Compatibilité[modifier | modifier le code]

Le modèle {{S}} historique accepte de un à trois arguments :

le premier argument est toujours le siècle, et le présent modèle est parfaitement compatible ;
le second argument est toujours un "e"^{[à vérifier]}, utilisé pour raison historique. Le présent modèle l'ignorera pour compatibilité.
le troisième argument est toujours un "s"^{[à vérifier]}. Le présent modèle l'utilisera comme suffixe, pour compatibilité.

Le modèle {{S-}} historique accepte de un à deux arguments :

le premier argument est toujours le siècle, et le présent modèle est parfaitement compatible ;
le second argument est toujours "er" ou "re"^{[à vérifier]}, utilisé pour raison historique. Le présent modèle l'ignorera pour compatibilité.