« Modèle:CIO-d/Documentation » : différence entre les versions

Contenu supprimé Contenu ajouté
FDo64 (discuter | contributions)
ajout exemple
Mise en place d'un nouveau système de documentation TemplateData automatique pour les {{CIO-d}} : Les données TemplateData sont générées dynamiquement afin de corriger le problème majeur de l'ancien système : Impossible depuis l'éditeur visuel de savoir à quel pays correspondait un code. La description est maintenant générée avec l'aide de {{CIO2Pays}} et d'une Aide:Fonction genre : {{de?}} ; description modifiable manuellement si besoin
Ligne 2 :
 
== Utilisation ==
{{#ifeq: {{BASEPAGENAME}} | CIO-d |
Ce méta-modèle sert à construire des modèles de drapeaux basés généralement sur la [[liste des codes pays du CIO]].
 
Il ne doit pas être utilisé directement dans les articles.
 
== Convention ==
Les modèles de drapeaux simples sont de la forme suivante : <code><nowiki>{{</nowiki>'''{{rouge|<var><nowiki><Code CIO></nowiki>}}'''</var>-d<nowiki>}}</nowiki></code>
 
Par exemple, pour le drapeau du Canada dont le code [[Comité international olympique|CIO]] est CAN, le modèle est {{m|CAN-d}}.
 
La liste des différents codes [[Comité international olympique|CIO]] est disponible sur [[Liste des codes pays du CIO]].
 
== Documentation automatique ==
Les modèles basés sur {{m|CIO-d}} sont documentés automatiquement avec un TemplateData généré par {{m|CIO-d/Documentation}}. Le code CIO est converti en nom de pays par {{m|CIO2Pays}}.
 
La description TemplateData du modèle peut être modifiée manuellement (si celle-ci ne convient pas ou qu'il y a un message d'erreur) avec le paramètre <code>description=</code> dans l'appel au modèle {{m|CIO-d/Documentation}} sur le modèle de drapeau comme ceci :
<nowiki>{{Documentation|contenu=</nowiki>'''{{rouge|<nowiki>{{CIO-d/Documentation|description=</nowiki><var>Drapeau de PAYS.</var><nowiki>}}</nowiki>}}'''<nowiki>}}</nowiki>
 
|
Modèle permettant d'afficher un drapeau.
 
La liste des différents codes [[Comité international olympique|CIO]] est disponible sur [[Liste des codes pays du CIO]].
}}
 
== Syntaxe ==
{{#ifeq: {{BASEPAGENAME}} | CIO-d
|
* <code><nowiki>{{</nowiki>CIO-d<nowiki>|France|France}}</nowiki></code> : {{CIO-d|France|France}}
* <code><nowiki>{{</nowiki>CIO-d<nowiki>|United States|États-Unis}}</nowiki></code> : {{CIO-d|United States|États-Unis}}
* <code><nowiki>{{</nowiki>CIO-d<nowiki>|Canada|Canada|35px}}</nowiki></code> : {{CIO-d|Canada|Canada|35px}}
|
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code> : {{ {{BASEPAGENAME}} }}
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|35px}}</nowiki></code> : {{ {{BASEPAGENAME}} |35px}}
}}
 
== Paramètres ==
{{#ifeq: {{BASEPAGENAME}} | CIO-d |
<templatedata>
{
"description": "CeRéservé modèleaux permetpages deinternes. générerMéta-modèle despour drapeauxconstruire deun paysdrapeau standardisésCIO.",
"format": "inline",
"params": {
"params": {
"1": {
"1": {
"label": "Image",
"label": "Image",
"description": "nom du fichier de l'image qui doit être de la forme suivante <code><nowiki>Flag of {{{1}}}.svg</nowiki></code> où <nowiki>{{{1}}}</nowiki> est le paramètre.",
"description": "Nom en anglais du drapeau issu du nom de l'image qui doit être de la forme suivante « Fichier:Flag of COUNTRY.svg », où « COUNTRY » est le nom à indiquer.",
"type": "string",
"type": "line",
"required": true
"required": true,
},
"example": "United States"
"2": {
},
"label": "Description",
"2": {
"description": "description du fichier image (infobulle).",
"label": "Description",
"type": "string",
"description": "Nom en français du pays affiché dans l'infobulle au survol du drapeau.",
"required": true
"type": "line",
},
"required": true,
"3": {
"example": "États-Unis"
"label": "Taille",
},
"description": "taille du drapeau.",
"3": {
"type": "string",
"label": "Taille du drapeau",
"default": "20px",
"description": "Largeur du drapeau, en pixels (px).",
"required": false
"type": "line",
}
"default": "20px",
}
"example": "25px"
}
}
}
</templatedata>
|
|Il n'y a qu'un unique paramètre non nommé permettant d'indiquer une taille au drapeau (par défaut 20px).
{{#ifeq: {{#if:{{{description|}}} || {{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}} | Inconnu <!-- Message d'erreur si le code pays est inconnu dans {{CIO2Pays}} ET que {{{description}}} est vide -->
<templatedata>
| <span class="error">Impossible de générer les données TemplateData. Le code CIO "{{padleft:|3|{{BASEPAGENAME}}}}" n'est pas reconnu par {{m|CIO2Pays}}. S'il s'agit d'un code CIO <u>valide</u> (actuel ou ancien), veuillez l'ajouter dans {{m|CIO2Pays}}, sinon, définissez manuellement une description TemplateData avec le paramètre <code>description=</code> dans l'appel au modèle {{m|CIO-d/Documentation}}.</span>
{
| {{#ifeq: {{#if:{{{description|}}} || {{de?|{{titre sans précision|{{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}}}}}} | de la zone&nbsp; <!-- Message d'erreur si le pays/territoire est inconnu dans {{de?}} ET que {{{description}}} est vide -->
"description": "Modèle insérant un drapeau.",
| <span class="error">Impossible de générer les données TemplateData. Le pays/territoire "{{titre sans précision|{{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}}" n'est pas reconnu par {{m|de?}}. Veuillez créer le modèle de géolocalisation {{m|Géolocalisation/{{titre sans précision|{{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}}}} (ou si celui-ci existe, définir correctement son paramètre <code>genre=</code>) ou définir manuellement une description TemplateData avec le paramètre <code>description=</code> dans l'appel au modèle {{m|CIO-d/Documentation}}.</span>
"params": {
| {{#tag:templatedata
"1": {
"label":| "Taille",{
"description": "Largeur{{#if: du drapeau.",{{{description|}}}
| {{{description}}} <!-- Utilisation de la description fournie manuellement -->
"type": "string",
| {{#invoke:String|replace <!-- Génération de la description, avec remplacement des &nbsp; (non supportés par TemplateData) du complément et/ou issus de {{de?}} par des espaces -->
"default": "20px",
|source=Drapeau {{de?|{{titre sans précision|{{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}}}}{{titre sans précision|{{CIO2Pays|{{padleft:|3|{{BASEPAGENAME}}}}}}}}{{#ifexpr: {{#invoke:String|len|s={{BASEPAGENAME}}}} > 5 | &nbsp;{{#invoke:String|sub|s={{BASEPAGENAME}}|5|-3}}}}
"example": "25px",
|pattern=&nbsp;| }}.
"required": false
}}",
"format": "inline",
}
"params": {
"1": {
"label": "Taille du drapeau",
"description": "Largeur du drapeau, en pixels (px).",
"example": "25px",
"type": "line",
"default": "20px"
}
}
}
}}</!-- Fin {{#tag:templatedata}} -->
}}
}}
 
''Données TemplateData générées automatiquement par {{m|CIO-d/Documentation}}.''
== Convention ==
Les modèles de drapeau simple sont de la forme suivante : '''<code><nowiki>{{<Code CIO>–d}}</nowiki></code>'''<br/>
Par exemple, pour le drapeau du Canada dont le code [[Comité international olympique|CIO]] est CAN, le modèle est {{m|CAN-d}}.<br/>
La liste des codes CIO est disponible sur l'article « [[Liste des codes pays du CIO]] ».
 
== Exemples ==
*{{CIO-d|France|France}} <code><nowiki>{{</nowiki>CIO-d<nowiki>|France|France}}</nowiki></code>
*{{CIO-d|Canada|Canada|35px}} <code><nowiki>{{</nowiki>CIO-d<nowiki>|Canada|Canada|35px}}</nowiki></code>
*{{CAN-d|35px}} <code><nowiki>{{</nowiki>CAN-d<nowiki>|35px}}</nowiki></code>
{{#ifeq: {{BASEPAGENAME}} |CIO-d||
*{{ {{BASEPAGENAME}} }} <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
}}
 
== Modèles connexes ==
* {{m|Drapeau}}
<includeonly>
{{Projet|Drapeaux|Sport}}
[[Catégorie:Modèle drapeau sans lien]]
</includeonly>