|
|
| Ligne 1 : |
Ligne 1 : |
| <noinclude>{{Documentationpage}}</noinclude> | | <noinclude>{{page de documentation}}</noinclude> |
| Ce modèle permet de placer une icône standard.
| |
|
| |
|
| ==Syntaxe==
| | Ce modèle permet de placer une icône définie par un mot-clé. |
| <pre>{{icône|nom de l'icône}}</pre>
| |
| ou
| |
| <pre>{{icon|nom de l'icône}}</pre>
| |
|
| |
|
| ===Paramètres=== | | == Syntaxe == |
| {{Docparam|name=<non nommé 1>|req=yes|default=|desc=
| |
| Nom de l'icône à placer. Voir la [[#Available icons|liste]] ci-dessous pour connaître la liste des noms.
| |
| }}
| |
|
| |
|
| {{Docparam|name=<non nommé 2>|req=no|default=normal|desc= | | <pre>{{icône|mot-clé de l'icône}}</pre> |
| Taille spécifique de l'icône. Il est possible d'entrée directement la valeur de la taille en pixel ou de choisir l'un des deux entrées ci-dessous.
| | ou |
| | <pre>{{icon|mot-clé de l'icône}}</pre> |
|
| |
|
| Les entrées possibles sont :
| | == Paramètres == |
| * ''normal'' : l'icône sera disposée avec une hauteur de 14px ;
| |
| * ''grand'' : l'icône sera disposée avec une hauteur de 20px.
| |
| }}
| |
|
| |
|
| {{Docparam|name=link|req=no|default=|desc= | | <templatedata> |
| Nom du lien lorsque l'on clique sur l'icône (sans l'encadrer dans « <nowiki>[[]]</nowiki> »).
| | { |
| }}
| | "params": { |
| | "1": { |
| | "label": "Mot-clé de l'icône", |
| | "description": "Mot-clé de l'icône, voir la documentation du modèle pour une liste complète des mots-clés disponibles. Une icône par défaut s'affiche si le mot-clé n'est pas reconnu.", |
| | "example": "soin", |
| | "required": true, |
| | "type": "string" |
| | }, |
| | "2": { |
| | "label": "Dimension", |
| | "description": "Dimension de l'icône. Il est possible de renseigner une taille en pixel, ou d'utiliser le mot-clé normal ou grand.", |
| | "type": "string", |
| | "default": "normal" |
| | }, |
| | "lien": { |
| | "aliases": [ |
| | "link" |
| | ], |
| | "label": "Lien", |
| | "description": "Lien vers un article.", |
| | "example": "Maître", |
| | "type": "string" |
| | }, |
| | "infobulle": { |
| | "aliases": [ |
| | "tooltip" |
| | ], |
| | "label": "Infobulle", |
| | "description": "Texte qui s'affiche lorsque l'utilisateur survole l'icône. Par défaut, il s'agit du texte défini dans le module Icône/Données.", |
| | "example": "Je suis une icône", |
| | "type": "string" |
| | } |
| | }, |
| | "description": "Affiche une icône", |
| | "paramOrder": [ |
| | "1", |
| | "2", |
| | "lien", |
| | "infobulle" |
| | ], |
| | "format": "inline" |
| | } |
| | </templatedata> |
|
| |
|
| {{Docparam|name=tooltip|req=no|default=|desc=
| | === Tableau des icônes disponibles === |
| Texte de l'infobulle lorsque survole l'icône avec la souris. Remplace le texte des icônes par défaut.
| |
| }}
| |
|
| |
|
| ===Icônes disponibles===
| |
| {| class="va-table va-table-top" style="width: 208px; float: left; margin-right: 4px;" | | {| class="va-table va-table-top" style="width: 208px; float: left; margin-right: 4px;" |
| |- | | |- |
| Ligne 350 : |
Ligne 380 : |
| | style="text-align: center;" | {{icône|ts}} | | | style="text-align: center;" | {{icône|ts}} |
| |} | | |} |
| | |
| {{clear}} | | {{clear}} |
| En addition à cela, toutes les abréviations supportées {{tl|Abb}} peuvent être utilisées pour créer l'icône du jeu correspondant.
| |
|
| |
|
| ===Ajouter une nouvelle icône=== | | === Ajouter une nouvelle icône === |
| Ajoutez simplement les lignes suivantes dans section « DÉFINITION ICÔNE » du modèle :
| | |
| | Il faut se rendre sur le module [[:Module:Icône/Données|Icône/Données]] et ajouter les lignes suivantes dans la table <code>icons</code>. Merci de ranger l'icône dans l'ordre alphabétique. |
| | |
| <pre> | | <pre> |
| -->|<!-- NOM ICÔNE -->=<!--
| | ['mot_cle'] = { |
| -->{{#vardefine:icon-image|<!-- NOM FICHIER -->}}<!--
| | aliases = { 'alias1', 'alias2' }, |
| -->{{#vardefine:icon-tooltip|<!-- TEXTE INFOBULLE -->}}<!--
| | filename = 'mon_fichier.png', |
| | tooltip = 'Mon infobulle !' |
| | }, |
| </pre> | | </pre> |
| Veuillez noter que :
| |
| * Le nom d'un icône doit être écrit en petites capitales.
| |
| * Le nom du fichier spécifié ne doit pas contenir le préfixe « Fichier: ».
| |
| Enfin, essayez de ranger les icônes dans l'ordre alphabétique.
| |
|
| |
|
| ==="High-use" icons===
| | * <code>mot_cle</code> est le mot-clé qui permet d'identifier l'icône. Il doit être écrit en minuscule. |
| The template supports a special setup for "high-use" icons in order to minimize loading times and overcome certain technical limitations regarding the number of images on a given wiki page. Basically when this setup is used for an icon, the icon is rendered as a background image. As such, it requires manual additions to be made to [[MediaWiki:Common.css]] and should only be used for icons of which potentially very many are used on a given page.
| | * <code>aliases</code> est une table contenant des mots-clés supplémentaires permettant d'identifier l'icône. Les mots-clés doivent être écrits en minuscule. |
| | * <code>filename</code> est le nom du fichier qui sera affiché en tant qu'icône. |
| | * <code>tooltip</code> est l'infobulle par défaut de l'icône. |
|
| |
|
| To set up an icon as "high-use":
| | == Exemples == |
| * In the template, add a new row below the standard ones for file name and tooltip text which specifies the name of the icon's CSS class. All in all, the section for a high-use icon should look like this:
| | |
| <pre style="margin-left: 1.5em;">
| | {| class="va-table va-table-center-col2" |
| -->|ICONNAME=<!--
| |
| -->{{#vardefine:icon-image|FILENAME}}<!--
| |
| -->{{#vardefine:icon-tooltip|TOOLTIPTEXT}}<!--
| |
| -->{{#vardefine:icon-highuse|CLASSNAME}}<!--
| |
| </pre>
| |
| <div style="margin-left: 1.5em;">CLASSNAME should be in all-lowercase. The template automatically prepends "va-icon-highuse-" to whatever you specify; e.g. if you set the variable to "example", the class name would end up being "va-icon-highuse-example".</div>
| |
| * On this documentation page, add a new row to the table below and replace all instances of "FILENAME" with the name of the file (without "File:").
| |
| <pre style="margin-left: 1.5em;">
| |
| |- | | |- |
| | [[File:FILENAME|x14px]]
| | ! style="width: 70%;" | Entrée |
| | {{fileurl|FILENAME|x14px|url type=relative}}
| | ! style="width: 30%;" | Résultat |
| | [[File:FILENAME|x20px]]
| |
| | {{fileurl|FILENAME|x20px|url type=relative}}
| |
| </pre>
| |
| <div style="padding-left: 1.5em;">
| |
| {| class="va-table va-table-center mw-collapsible mw-collapsed va-table-left-col2 va-table-left-col4" style="width: 100%;"
| |
| |- | | |- |
| ! colspan="2" | Normal-sized icon
| | | <code><nowiki>{{icône|radiation}}</nowiki></code> |
| ! colspan="2" | Big-sized icon
| | | {{icône|radiation}} |
| |- | | |- |
| ! style="width: 10%;" | File
| | | <code><nowiki>{{icône|radiation|grand}}</nowiki></code> |
| ! style="width: 40%;" | PATH-NORMAL
| | | {{icône|radiation|grand}} |
| ! style="width: 10%;" | File
| |
| ! style="width: 40%;" | PATH-BIG
| |
| |- | | |- |
| | [[File:Icon check.png|x14px]] | | | <code><nowiki>{{icône|radiation|60}}</nowiki></code> |
| | {{fileurl|Icon check.png|x14px|url type=relative}}
| | | {{icône|radiation|60}} |
| | [[File:Icon check.png|x20px]]
| |
| | {{fileurl|Icon check.png|x20px|url type=relative}} | |
| |- | | |- |
| | [[File:Icon check temp.png|x14px]] | | | <code><nowiki>{{icône|radiation|100px}}</nowiki></code> |
| | {{fileurl|Icon check temp.png|x14px|url type=relative}}
| | | {{icône|radiation|100px}} |
| | [[File:Icon check temp.png|x20px]]
| |
| | {{fileurl|Icon check temp.png|x20px|url type=relative}} | |
| |- | | |- |
| | [[File:Icon cross.png|x14px]] | | | <code><nowiki>{{icône|radiation|lien=Mutation}}</nowiki></code> |
| | {{fileurl|Icon cross.png|x14px|url type=relative}}
| | | {{icône|radiation|lien=Capsule}} |
| | [[File:Icon cross.png|x20px]]
| |
| | {{fileurl|Icon cross.png|x20px|url type=relative}}
| |
| |}
| |
| </div> | |
| * In [[MediaWiki:Common.css]], add the following to the "Template:Icon" section (preferably in the vicinity of the already existing high-use icons):
| |
| <pre style="margin-left: 1.5em;"> | |
| .va-icon-big .va-icon-highuse-CLASSNAME {
| |
| background-image: url(PATH-NORMAL);
| |
| }
| |
| .va-icon-normal .va-icon-highuse-CLASSNAME {
| |
| background-image: url(PATH-BIG);
| |
| }
| |
| </pre>
| |
| <div style="margin-left: 1.5em;">Replace:
| |
| * "CLASSNAME" with the value of the "icon-highuse" variable.
| |
| * "PATH-NORMAL" with the content of the corresponding cell in the table above.
| |
| * "PATH-BIG" with the content of the corresponding cell in the table above.
| |
| </div>
| |
| | |
| ==Exemples==
| |
| {| class="va-table va-table-center-col2"
| |
| |- | |
| ! style="width: 70%;" | Input
| |
| ! style="width: 30%;" | Result
| |
| |-
| |
| | <code><nowiki>{{icon|cut}}</nowiki></code>
| |
| | {{icône|cut}} | |
| |- | | |- |
| | <code><nowiki>{{icon|cut|big}}</nowiki></code> | | | <code><nowiki>{{icône|radiation|infobulle=Une infobulle !}}</nowiki></code> |
| | {{icône|cut|big}}
| | | {{icône|radiation|infobulle=Une infobulle !}} |
| |-
| |
| | <code><nowiki>{{icon|cut|link=Fallout Wiki}}</nowiki></code>
| |
| | {{icône|cut|link=Fallout Wiki}}
| |
| |-
| |
| | <code><nowiki>{{icon|cut|tooltip=Custom tooltip}}</nowiki></code>
| |
| | {{icône|cut|tooltip=Custom tooltip}} | |
| |} | | |} |
|
| |
| ==Template Data==
| |
| <templatedata>
| |
| {
| |
| "params": {
| |
| "1": {
| |
| "description": "Mot-clé de l'icône à afficher. Voir la page de documentation du modèle pour connaître la liste de tous les mots-clés.",
| |
| "example": "soin",
| |
| "type": "string",
| |
| "required": true
| |
| },
| |
| "2": {
| |
| "description": "Taille de l'icône. Au choix normal (14px) ou grand (20px).",
| |
| "type": "string",
| |
| "default": "normal"
| |
| },
| |
| "link": {
| |
| "aliases": [
| |
| "lien"
| |
| ],
| |
| "description": "Nom de la page vers qui rediriger lorsqu'on clique sur l'icône (sans l'encadrer dans « [[]] »).",
| |
| "type": "wiki-page-name"
| |
| },
| |
| "tooltip": {
| |
| "aliases": [
| |
| "infobulle"
| |
| ],
| |
| "description": "Texte de l'infobulle lorsque survole l'icône avec la souris. Remplace l'infobulle par défaut de l'icône associé.",
| |
| "type": "string"
| |
| }
| |
| },
| |
| "description": "Affiche un icône standardisé. Voir la page de documentation du modèle pour connaître les icônes disponibles et leurs mots-clés associés.",
| |
| "paramOrder": [
| |
| "1",
| |
| "2",
| |
| "link",
| |
| "tooltip"
| |
| ],
| |
| "format": "inline"
| |
| }
| |
| </templatedata>
| |
|
| |
| ==Technique==
| |
| * Extension utilisée : [[mw:Extension:Variables|Variables]]
| |
|
| |
| ==Source==
| |
| * Le modèle et sa page de documentation sont issus du wiki [http://fallout.gamepedia.com/Fallout_Wiki The Vault]. Vous pouvez les retrouver en suivant ce [http://fallout.gamepedia.com/Template:Icon lien].
| |