Fr/Aide:les modèles
Version traduite le 12 novembre 2022
Aide du Wiki |
---|
A lire |
Modification |
Fonctions avancées |
Writing about specific topics |
Les modèles sont des pages qui peuvent contenir des éléments complexes de balisage wiki et qui peuvent être réutilisés sur d'autres pages avec une relative facilité. Sur cette page d'aide, nous verrons ce qu'est un modèle, comment le trouver et l'utiliser, ainsi que la modification de modèles existants et la création de nouveaux modèles. Enfin, nous aborderons rapidement certains aspects plus avancés des modèles.
Les bases
Qu'est-ce qu'un modèle ?
En termes simples, lorsque vous utilisez un modèle, vous ajoutez une autre page, ou plutôt son contenu, dans la page que vous modifiez. C'est ce qu'on appelle la transclusion. Bien que le wiki ait un espace de noms de modèle spécial, indiqué par un préfixe Template: dans le titre de la page, n'importe quelle page peut être utilisée comme modèle.
Si un modèle par exemple s'appelle Template:Bonjour et contient :
Bonjour à tous !
Taper ce qui suit sur une page copierait ce contenu sur la page que vous éditez. Notez que le premier caractère n'est pas sensible à la casse.
{{bonjour}}
Cependant, les modèles peuvent, en plus du balisage MediaWiki, HTML et feuille de style, utiliser également un large éventail de fonctions spéciales pour faire beaucoup, beaucoup plus.
Les différents types de modèle
Il existe plusieurs types de modèle, certains des plus visibles sont les modèles de boîte de message, les modèles d'infobox et les modèles de boîte de navigation (navbox), mais il existe également de nombreux autres types de modèle. Voici quelques-uns des différents types de modèle :
- Modèle Messagebox
- Les modèles Messagebox (boîtes de message) se trouvent souvent en tête de page et parfois en tête de section. Dans de rares cas, ils se trouvent dans le paragraphe. Leur but est de donner des informations au lecteur ou aux éditeurs potentiels.
- Modèle Infobox
- Les modèles Infobox se trouvent presque toujours en haut à droite des pages. Ils sont littéralement une boîte d'informations complémentaires sur le sujet abordé sur la page.
- Modèle Navigation
- Les modèles de navigation se trouvent généralement en haut à droite ou en bas d'une page. Ils sont destinés à aider le lecteur à naviguer entre les pages sur un contexte similaire, par exemple une série d'articles ou des articles sur les avions FlightGear du même fabricant.
- Modèle Maintenace
- Les modèles de maintenance sont presque sans exception des modèles de boîte de message. Leur but est d'aider à la maintenance du wiki et de signaler les choses qui doivent être améliorées.
- Modèle Utility
- Les modèles utilitaires sont souvent petits, mais très utiles.
- Modèle Inline
- Ce sont des modèles intégrés, pouvant être utilisés dans des phrases et du texte flottant.:
Utiliser les modèles
Trouver des modèles
Il existe plusieurs façons de trouver un modèle à utiliser :
- Utiliser des catégories
- La plupart des modèles peuvent être trouvés dans Category:Templates et ses sous-catégories.
- Utiliser des listes de modèles
- Il existe également des listes de certains modèles, voir Help:Galerie de modèles de messagebox et Help:Gallery of infobox templates.
- Trouver des modèles via une page dans laquelle ils sont utilisés
- Une autre façon de trouver des modèles consiste à trouver une page utilisant des modèles qui vous intéressent. Si vous ouvrez cette page pour la modifier, vous trouverez tout en bas de la page une liste des modèles utilisés par cette page et les modèles que ces modèles utilisent.
- Trouver des modèles similaires à un autre
- Des liens vers des modèles similaires peuvent souvent être trouvés au bas de la documentation d'un modèle.
- Rechercher le contenu d'un modèle
- En dernier recours, vous pouvez rechercher en utilisant le contenu possible d'un modèle, en tapant "Template:<contenu recherché>" dans la zone de recherche. Au lieu d'aller directement à la page comme vous le feriez si vous connaissiez son nom, vous arriverez sur une page de résultats de recherche avec des pages qui pourraient contenir le modèle que vous recherchez.:
Paramètres du modèle
La plupart des modèles prennent des arguments, appelés paramètres. Certains modèles ne le font pas. Certains paramètres peuvent être facultatifs, d'autres obligatoires. Les paramètres obligatoires doivent toujours être utilisés, contrairement aux paramètres facultatifs. Il existe également des paramètres sans nom et d'autres nommés. Les paramètres sans nom sont parfois appelés paramètres numérotés car ils doivent être utilisés dans un certain ordre et sont numérotés dans la source du modèle. Les paramètres nommés sont toujours utilisés dans des paires clé-valeur, comme par exemple mois = novembre 2022.
Dans certains modèles de documentation, la convention suivante est utilisée pour illustrer comment les paramètres peuvent être utilisés :
{{template name|mandatory unnamed parameter|optional unnamed parameter |mandatory named parameter= |optional named parameter=}}
Dans la plupart des cas, il est possible d'utiliser n'importe quel type de balisage wiki dans les paramètres, par exemple des liens wiki.
Comme indiqué ci-dessus, les paramètres sans nom doivent être utilisés dans un certain ordre, bien qu'ils puissent, sinon obligatoirement, être laissés vides. Prenons par exemple le modèle suivant :
{{modèle|paramètre 1|paramètre 2|paramètre 3|paramètre 4|}}
Habituellement, les paramètres les plus couramment utilisés et/ou obligatoires sont le ou les premiers, mais si nous ne devions utiliser que les deux derniers paramètres, nous devrions faire comme ci-dessous :
{{modèle|||paramètre 3|paramètre 4}}
Documentation des modèles
Lorsque vous savez quel modèle vous souhaitez utiliser, il vous est recommandé de consulter sa documentation, à moins que vous ne l'ayez déjà fait plus tôt. Vous trouverez la documentation sur la page du modèle. La documentation décrit l'objectif du modèle et comment l'utiliser, ainsi que le lien vers les modèles associés. Malheureusement, tous les modèles ne sont pas documentés.
De nombreux modèles ont une section Problèmes connus dans la documentation du modèle. Certains modèles ont des particularités innées qui ne peuvent pas être corrigées, mais peuvent être contournées. L'un des problèmes les plus courants est que quelques caractères utilisés pour créer des tableaux ou utilisés dans des modèles cassent un modèle, ces caractères sont le signe égal = et un trait vertical et certaines combinaisons de celui-ci, |, || et |-. La solution de contournement habituelle consiste à utiliser les modèles =, |, || et |-.
La documentation du modèle contient une liste des paramètres utilisés par le modèle qui peuvent être copiés et collés sur la page que vous modifiez, parfois même avec certains des paramètres renseignés, comme par exemple ce modèle :
{{splitapart|Discussion page section |date=November 2024}}
Dans la documentation du modèle, il y a aussi une liste des paramètres et comment ils sont censés être utilisés. Il y a souvent des exemples pour illustrer les différentes façons dont les paramètres peuvent être utilisés.
Création d'un nouveau modèle
Choisir un nom explicite
Envisagez de donner au modèle un nom significatif. Habituellement, le caractère initial est en majuscule. Si vous céez un modèle à partir d'un autre wiki, utiliser son nom peut être une bonne idée. Si le modèle est utilisé très souvent, il peut être judicieux d'utiliser un nom très court ou une abréviation, mais une catégorisation et une documentation appropriées seront alors encore plus importantes. Notez que les noms de paramètres sont sensibles à la casse, sauf pour le premier caractère.
Commencez par rechercher
Pour créer un nouveau modèle, veuillez commencer par utiliser la fonction de recherche. De cette façon, vous saurez s'il existe déjà un modèle portant ce nom ou s'il en existe un avec un nom très similaire. S'il n'y a pas de modèle avec ce nom, vous aurez la possibilité de créer cette page.
Cliquez sur le lien rouge pour ouvrir une fenêtre d'édition.
Informations à inclure
Deux éléments importants à ajouter à votre modèle sont : la documentation du modèle, de préférence en utilisant Template:Modèle informatif ; et si possible, la catégorie du modèle, autre que la catégorie par défaut Category:Templates.
À moins qu'il ne s'agisse d'un modèle très simple à mettre en oeuvre, il peut être judicieux de commencer par écrire la documentation car cela peut vous aider à comprendre les dernières choses sur ce que vous voulez que le modèle fasse et comment vous voulez qu'il le fasse, et plus encore, utiliser la documentation comme référence lors de la saisie du modèle lui-même.
Prévisualisation
N'oubliez pas que vous pouvez et devez utiliser le bouton de prévisualisation de temps en temps, ou au moins une fois avant d'enregistrer, afin de détecter toute erreur avant enregistrement. Une façon de déboguer un modèle consiste à ajouter des indices évidents à l'endroit où se produit une anomalie dans un modèle, par exemple 1?, 2?... Cela peut être très utile dans certains cas, mêm si parfois, l'anomalie est évident.e Certaines erreurs courantes sont les mêmes que sur les pages d'articles : balises de fin manquantes dans les tableaux ou balises de fin manquantes ou encore balises de fin avec barres obliques manquantes.
Bien que le modèle puisse toujours être corrigé en cas d'erreurs, il est préférable d'avoir un aperçu supplémentaire plutôt qu'une modification supplémentaire. Notez que le modèle sera perdu si vous ne l'enregistrez pas.
Modification d'un modèle
L'édition d'un modèle est aussi simple que l'édition d'une page wiki normale. Sopposons que vous vouliez modifier un modèle avec le nom ce que vous avez toujours voulu savoir. Recherchez le modèle à l'aide du mot-clé modèle tel que Modèle : ce que vous avez toujours voulu savoir puis cliquez sur un lien pour vous y rendre.
Si le code du modèle est très complexe, il peut être judicieux de ne pas le modifier sous peine de le corrompre, même si les modifications peuvent facilement être annulées.
Essayez toujours d'ajouter de la documentation aux modèles manquants, de préférence en utilisant Template:Modèle informatif.
Passer des paramètres sans nom à un modèle
Passer des paramètres aux modèles les rend beaucoup plus souples à utiliser. Les paramètres sans nom peuvent être utilisés dans l'ordre dans lequel ils sont passés, essentiellement {{{1}}}, {{{2}}} etc. Considérez le modèle suivant, Template:Hello :
Hello, {{{1|}}}{{{2|stranger}}}!
Son utilisation :
{{hello|titre|nom}}
Les deux paramètres sont facultatifs . Voici des exemples d'utilisation :
{{hello|Dr.|Falken}} {{hello||}}
Résultats
Hello, Dr. Falken! Hello stranger!
Les valeurs par défaut des paramètres
Vous vous demandez peut-être ce que fait ce trait vertical et le texte qui suit, stranger, dans Template:Hello. La plupart d'entre vous auront déjà deviné qu'il s'agit de valeurs par défaut. Avoir au moins une valeur par défaut vide est une bonne pratique, sinon les modèles se plantent lorsqu'un paramètre vide leur est passé. Voici ce qui arrive lorsque le modèle ci-dessus est utilisé sans paramètres :
{{hello}}
Il est affiché :
Hello, stranger!
Et voici ce qui se passerait s'il était utilisé sans paramètres et n'avait pas de valeurs par défaut :
Hello, {{{1}}}{{{2}}}!
Passer des paramètres nommés ç un modèle
Bien que l'utilisation d'un modèle avec des paramètres nommés nécessite un peu plus de saisie, ils ne sont pas beaucoup plus complexes lors de la modification. Ils sont réellement très pratiques car ils peuvent être passés à un modèle dans n'importe quel ordre et, plus important encore, ils sont nommés (c'est-à-dire non numérotés). Cette dernière chose les rend immensément plus utiles dans les modèles complexes.
Les utiliser dans un modèle n'est pas si différent des paramètres sans nom. En utilisant le modèle ci-dessus, mais avec des paramètres nommés, nous pourrions plutôt taper :
Hello, {{{title|}}}{{{name|stranger}}}!
Son utilisation :
{{hello |title= |name=}}
En voici un exemple :
{{hello |title=Dr. |name=Falken}}
Il s’affichee :
Hello, Dr. Falken!
Inclure ou ne pas inclure ?
Parfois, vous avez du contenu dans un modèle que vous ne souhaitez pas transclure ou que vous souhaitez transclure mais pas inclure dans le modèle. Considérez, par exemple, la documentation du modèle, bien entendu,vous ne souhaitez pas qu'elle soit présente sur chaque page pour laquelle le modèle est utilisé. Par contre, parfois, vous voulez qu'un modèle ajoute une catégorie à la page pour laquelle il est utilisé, mais pas au modèle lui-même . Cela peut être fait en employant les balises <noinclude> et <includeonly>.
Pour revenir au modèle Template:Hello, l'exemple ci-dessous montre comment Category:Pages qui disent bonjour est ajouté à la page qui utilise le modèle mais pas au modèle lui-même, et comment la documentation et les modèles Category:Hello sont ajoutés au modèle, mais pas la page pour laquelle il sera utilisé. Notez que les deux balises <includeonly> et <noinclude> sont juste derrière le texte du modèle, car un saut de ligne entraînerait un saut de ligne lorsque le modèle est utilisé.
Voici le modèle complet : Template:Hello. Ne vous souciez pas de taper tout ce texte, {{informative template}} est l'un des modèles avec des exemples pré-remplis que vous pouvez copier et coller dans le modèle que vous modifiez.
Hello, {{{1|}}}{{{2|stranger}}}!<includeonly>[[Category:Pages that says hello]]</includeonly><noinclude> {{Informative template|1= __NOTOC__ == Goal == This template can be used to show a friendly hello. Adding this template to a page will automatically add that page to [[:Category:Pages that says hello]]. == Usage == <nowiki>{{</nowiki>'''hello'''<nowiki>|</nowiki>''title''<nowiki>|</nowiki>''name''<nowiki>}}</nowiki> ;parameter: Optional title, for example "<tt>Dr.</tt>" ;parameter: Optional name, defaults to "<tt>stranger</tt>" == Examples == <pre>{{hello|Dr.|Falken}}</pre> Hello, Dr. Falken! <pre>{{hello}}</pre> Hello, stranger! }} [[Category:Hello templates]] </noinclude>
Suppression de categorie
Parfois, il est utile qu'un modèle supprime la catégorisation et ne catégorise que certaines des pages pour lesquelles il est utilisé. Il existe quelques modèles qui peuvent être utilisés pour cela dans Category:Namespace templates. La plupart d'entre eux utilisent l'espace de noms de la page pour laquelle le modèle est appliqué. Par exemple, Help talk:Templates se trouve dans l'espace de noms Help talk.
L'un de ces modèles est {{main other}}.
{{main other|text if main|text if other |demospace=}}
Si le modèle est appliqué sur une page dans l'espace de noms principal, l'espace de noms dans lequel se trouvent les articles, text if main est utilisé. Sinon text if other est utilisé. Les deux peuvent être remplacés si demospace est défini comme demospace = other lorsqu'il se trouve dans l'espace de noms principal et demospace = main lorsqu'il se trouve dans n'importe quel autre.
Si un lien de catégorie est utilisé dans le text if main comme ci-dessous, la page ne sera catégorisée que si le modèle est placé dans l'espace de noms principal. Notez que tous les paramètres sont facultatifs.
... }} {{main other|[[Category:Hello templates]]}} </noinclude>
En dehors de demospace, certains modèles auront un paramètre nocat qui, lorsqu'il n'est pas vide ou défini comme nocat = yes, supprimera complètement la catégorisation.
Traduire un modèle
Les modèles sont traduits d'une manière différente des articles normaux. Au lieu de créer une autre page pour chaque traduction, toutes les traductions sont écrites dans un modèle. Pour ce faire, on peut utiliser le modèle {{LangSwitch}}, par exemple comme ci-dessous :
[http://{{LangSwitch | en = <!-- English --> en | de = <!-- German --> de | fr = <!-- French --> fr }}.wikipedia.org Wikipedia]
{{LangSwitch | en = <!-- English --> {{ The template with English contents }} | de = <!-- German --> {{ Die Vorlage mit deutschen Inhalten }} | fr = <!-- French --> {{ Le modèle avec le contenu en Français }} }}
Note De nombreux modèles utilisent des tableaux et doivent commencer au début de la ligne, comme dans l'exemple ci-dessus. |
Note L'insertion de lignes vides ou d'espaces entraînera généralement des modifications involontaires de la façon dont le modèle est rendu. |
Le modèle {{LangSwitch}} utilise le code de langue à deux lettres présent dans tous les titres de page sauf en anglais. Si aucune des langues traduites n'est trouvée, un modèle n'a pas encore été traduit dans cette langue et le texte anglais sera utilisé par défaut, à condition qu'il soit disponible.
Lorsque vous vérifiez que les versions linguistiques s'affichent comme elles le devraient, vous pouvez ajouter un paramètre lang au modèle à des fins de débogage. N'oubliez pas de le supprimer avant d'enregistrer ou le modèle ne sera affiché que dans cette langue. L'exemple ci-dessous montrerait la version française (fr) du modèle :
{{LangSwitch ... | lang = fr }}
Edition avancée d'un modèle
Les modèles peuvent contenir du code très avancé et souvent complexe, mais un code encore plus simple peut faire de grandes choses pour vous faciliter la vie en tant qu'éditeur, avec de perspectives de réutilisation.
Bien que cette page ne rentre pas dans les détails, il existe quelques secrets pour les modèles plus avancés :
- Tableaux
- Les tableaux wiki sont difficiles à comprendre, mais ils peuvent faire beaucoup pour tout type de modèle ou de boîtes de dialogue, ainsi que pour de petites mises en page.
- Mots magiques ou réservés
- Les mots magiques sont , la plupart du temps,en majuscules et beaucoup d'entre eux ressemblent à première vue à des modèles. Certains d'entre eux sont par exemple {{CURRENTMONTHNAME}} and __NOTOC__.
- Fonctions d'analyseur
- Les fonctions d'analyseur permettent une programmation plus ou moins régulière avec des conditions, des commutateurs, un formatage de chaîne, etc. L'une d'elles est #if, {{#if: string | passed if non-empty | passed if empty }}.
- HTML
- Cela peut sembler un peu drôle de le mentionner, mais parfois vous oubliez que vous pouvez utiliser (certaines) balises HTML dans un wiki MediaWiki.
- Cascading style sheets (CSS)
- Comme les mots magiques et les fonctions d'analyseur peuvent faire de la magie pour la fonctionnalité d'un modèle CSS peut faire de la magie pour son apparence.:
Une bonne astuce pour obtenir un code source de modèle plus lisible est que des commentaires HTML bien placés () aideront beaucoup à la compréhension.