Macros couramment utilisées
Cette page liste de nombreuses macros générales créées pour être utilisées sur MDN. Pour des informations pratiques sur leur utilisation dans le contenu MDN, voir Utiliser les macros.
Liens
MDN propose plusieurs macros de lien pour faciliter la création de liens vers des pages de référence, des entrées de glossaire et d'autres sujets.
Les macros de lien sont recommandées à la place des liens Markdown classiques car elles sont concises et adaptées à la traduction. Par exemple, un lien de glossaire ou de référence créé avec une macro n'a pas besoin d'être traduit : dans d'autres langues, il pointera automatiquement vers la bonne version du fichier.
Liens vers le glossaire
La macro Glossary
crée un lien vers l'entrée d'un terme dans le glossaire MDN.
Cette macro accepte un paramètre obligatoire et un paramètre optionnel :
- Le nom du terme (par exemple « HTML ») :
{{Glossary("HTML")}}
donne HTML - Optionnel : le texte à afficher dans l'article à la place du nom du terme :
{{Glossary("CSS", "Feuilles de style en cascade")}}
donne Feuilles de style en cascade
Lien vers des pages de référence
Il existe des macros pour créer des liens indépendants de la langue vers des pages de référence spécifiques de MDN : JavaScript, CSS, éléments HTML, SVG, etc.
Les macros sont simples à utiliser. Il suffit de spécifier le nom de l'élément à lier en premier argument. La plupart des macros acceptent aussi un second argument pour personnaliser le texte affiché (voir la documentation dans la colonne de gauche du tableau ci-dessous).
Macro | Liens vers la page sous-jacente | Exemple |
---|---|---|
CSSxRef | Référence CSS (/Web/CSS/Reference) |
{{CSSxRef("cursor")}} donnera cursor .
|
DOMxRef | Référence DOM (/Web/API) |
{{DOMxRef("Document")}} ou {{DOMxRef("document")}} donne Document ,{{DOMxRef("document.getElementsByName()")}} donne document.getElementsByName() ,{{DOMxRef("Node")}} donne Node .Vous pouvez changer le texte affiché en utilisant un second paramètre : {{DOMxRef("document.getElementsByName()","getElementsByName()")}} donne getElementsByName() .
|
HTMLElement | Référence des éléments HTML (/Web/HTML/Reference/Elements) |
{{HTMLElement("select")}} donne <select>
|
JSxRef | Référence JavaScript (/Web/JavaScript/Reference). |
{{JSxRef("Promise")}} donne Promise
|
SVGAttr | Référence des attributs SVG (/Web/SVG/Reference/Attribute). |
{{SVGAttr("d")}} donne d
|
SVGElement | Référence des éléments SVG (/Web/SVG/Reference/Element). |
{{SVGElement("view")}} donne <view>
|
HTTPHeader
|
En-têtes HTTP (/Web/HTTP/Reference/Headers). |
{{HTTPHeader("ACCEPT")}} donne ACCEPT
|
HTTPMethod | Méthodes de requête HTTP (/Web/HTTP/Reference/Methods). |
{{HTTPMethod("HEAD")}} donne HEAD
|
HTTPStatus | Codes d'état de réponse HTTP (/Web/HTTP/Reference/Status) |
{{HTTPStatus("404")}} donne 404
|
Aides à la navigation pour les guides multi-pages
Previous
, Next
et PreviousNext
fournissent des contrôles de navigation pour les articles faisant partie d'une séquence.
Pour les modèles à sens unique, il suffit d'indiquer l'emplacement wiki de l'article précédent ou suivant.
Pour PreviousNext
, il faut deux paramètres : l'emplacement wiki de l'article précédent puis celui de l'article suivant.
Exemples de code
>Exemples interactifs
EmbedLiveSample
permet d'intégrer le résultat d'un exemple de code sur une page, comme expliqué dans Exemples interactifs.LiveSampleLink
crée un lien vers une page contenant le résultat d'un exemple de code, comme expliqué dans Exemples interactifs.EmbedGHLiveSample
permet d'intégrer des exemples interactifs depuis des pages GitHub. Plus d'informations dans Exemples interactifs GitHub.
Mise en forme générale
>Indicateurs en ligne pour la documentation API
Optional_Inline
et ReadOnlyInline
sont utilisés dans la documentation API, généralement pour décrire la liste des propriétés d'un objet ou les paramètres d'une fonction.
Utilisation : {{Optional_Inline}}
ou {{ReadOnlyInline}}
.
Exemple :
isCustomObject
Lecture seule-
Indique, si
true
, que l'objet est personnalisé. parameterX
Facultatif-
Bla bla bla…
Indicateurs de statut et de compatibilité
>Indicateurs en ligne sans paramètre supplémentaire
Non standard
`Non-standard_Inline` insère une marque en ligne indiquant que l'API n'est pas standardisée et n'est pas en cours de normalisation.
Syntaxe
{{Non-standard_Inline}}
Exemple
- Icône : Non standard
Expérimental
`Experimental_Inline` insère une marque en ligne indiquant que l'API n'est pas largement implémentée et peut évoluer à l'avenir. Pour plus d'informations sur la définition expérimental, voir la documentation Expérimental, déprécié et obsolète.
Syntaxe
{{Experimental_Inline}}
Exemple
- Icône : Expérimental
Indicateurs en ligne avec technologie précisée
Déprécié
`Deprecated_Inline` insère une marque en ligne de dépréciation ( Obsolète ) pour déconseiller l'utilisation d'une API officiellement dépréciée (ou supprimée). Pour plus d'informations sur la définition déprécié, voir la documentation Expérimental, déprécié et obsolète.
Syntaxe
{{Deprecated_Inline}}
Exemple
- Icône : Obsolète
Indicateurs d'en-tête de page ou de section
Ces modèles ont la même signification que leurs équivalents en ligne ci-dessus. Ils doivent être placés juste sous le titre principal de la page (ou le fil d'Ariane si présent) dans une page de référence. Ils peuvent aussi servir à marquer une section d'une page.
Non-standard_Header
:{{Non-standard_Header}}
Non standard: Cette fonctionnalité n'est pas standardisée. Nous déconseillons d'utiliser des fonctionnalités non standard en production, car leur prise en charge par les navigateurs est limitée, et elles peuvent être modifiées ou supprimées. Toutefois, elles peuvent constituer une alternative appropriée dans certains cas où aucune option standard n'existe.
SeeCompatTable
utilisé sur les pages documentant des fonctionnalités expérimentales. Exemple :{{SeeCompatTable}}
Expérimental: Cette fonction est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.Deprecated_Header
:{{Deprecated_Header}}
Obsolète: Cette fonctionnalité a été supprimée des standards du Web. Bien que quelques navigateurs puissent encore la supporter, elle est en cours d'éradication. Ne l'utilisez ni dans d'anciens projets, ni dans de nouveaux. Les pages et applications Web l'utilisant peuvent cesser de fonctionner à tout moment.
SecureContext_Header
. À utiliser sur les pages principales comme les pages d'interface, d'API ou d'entrée d'API (ex. :navigator.xyz
), mais généralement pas sur les sous-pages de méthodes ou propriétés. Exemple :{{SecureContext_Header}}
Contexte sécurisé: Cette fonctionnalité est uniquement disponible dans des contextes sécurisés (HTTPS), pour certains navigateurs qui la prennent en charge.
Indiquer qu'une fonctionnalité est disponible dans les web workers
La macro AvailableInWorkers
insère un encadré localisé indiquant qu'une fonctionnalité est disponible dans un contexte worker.
Vous pouvez aussi passer des arguments pour indiquer qu'une fonctionnalité fonctionne dans un contexte worker spécifique.
Syntaxe
{{AvailableInWorkers}} {{AvailableInWorkers("window_and_worker_except_service")}}
Exemples
Note : Cette fonctionnalité est disponible via les Web Workers.
Note : This feature is available in Web Workers, except for Service Workers.
Macros de compatibilité navigateur et de spécification
Les macros suivantes sont incluses sur toutes les pages de référence, mais sont aussi utilisables sur tous les types de pages :
{{Compat}}
-
Génère un tableau de compatibilité pour la ou les fonctionnalités définies par
browser-compat
dans le front-matter. {{Specifications}}
-
Ajoute un tableau de spécifications pour la ou les fonctionnalités définies par
spec-urls
dans le front-matter, si présent, ou à partir de la spécification listée dans les données de compatibilité définies parbrowser-compat
dans le front-matter.
Voir aussi
- Macros de barre latérale
- Modèles de page
- Composants de page
- Macros de statut de fonctionnalité
- Autres macros : macros rarement utilisées ou dépréciées