1. MDN Web Docs
  2. Règles d'écriture
  3. Structures des documents
  4. Utiliser les macros
  5. Macros couramment utilisées

Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

Macros couramment utilisées

Cette page liste de nombreuses macros générales que le système de compilation de MDN, rari (angl.), fournit 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 entrées de glossaire, des pages de référence 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 pointe automatiquement vers la bonne version du fichier.

Ces macros sont également couvertes plus en détail sur la page Macros de lien.

Lien vers le glossaire

La macro Glossary (angl.) 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 terme est un paramètre obligatoire. Par exemple, pour créer un lien vers la page du glossaire pour "HTML", la macro est {{Glossary("HTML")}}, et cela produit le lien HTML.
  • Le texte affiché est un paramètre optionnel. Par exemple, vous pouvez écrire le lien dans l'exemple précédent comme {{Glossary("HTML", "HyperText Markup Language")}}, ce qui produit le lien HyperText Markup Language.

Lien vers les pages de référence

Il existe des macros pour créer des liens indépendants de la langue vers des pages dans des domaines de référence spécifiques de MDN, y compris HTML, CSS, JavaScript, SVG et HTTP.

Ces macros sont faciles à utiliser. Il vous suffit de définir le nom de l'élément à lier dans le premier paramètre. Comme pour la macro de glossaire, la plupart des macros de référence acceptent également un second paramètre pour vous permettre de modifier le texte affiché.

Voir les fichiers source liés dans la première colonne du tableau suivant pour plus de détails.

Macro Liens vers les pages sous-jacente Exemple
CSSxRef (angl.) Référence CSS (/Web/CSS/Reference) {{CSSxRef("cursor")}} donne cursor.
{{CSSxRef(":hover")}} donne :hover.
{{CSSxRef("@media")}} donne @media.
{{CSSxRef("pow")}} donne pow().

Voir les détails dans Utiliser cssxref avec la référence CSS
DOMxRef (angl.) Référence DOM (/Web/API) {{DOMxRef("document")}} donne Document.
{{DOMxRef("document.getElementsByName()")}} donne document.getElementsByName().
{{DOMxRef("Node")}} donne Node.
HTMLElement (angl.) Référence des éléments HTML (/Web/HTML/Reference/Elements). {{HTMLElement("select")}} donne <select>
JSxRef (angl.) Référence JavaScript (/Web/JavaScript/Reference). {{JSxRef("Promise")}} donne Promise
SVGAttr (angl.) Référence des attributs SVG (/Web/SVG/Reference/Attribute). {{SVGAttr("d")}} donne d
SVGElement (angl.) Référence des éléments SVG (/Web/SVG/Reference/Element). {{SVGElement("view")}} donne <view>
HTTPHeader (angl.) En-têtes HTTP (/Web/HTTP/Reference/Headers). {{HTTPHeader("ACCEPT")}} donne ACCEPT
HTTPMethod (angl.) Méthodes de requête HTTP (/Web/HTTP/Reference/Methods). {{HTTPMethod("HEAD")}} donne HEAD
HTTPStatus (angl.) Codes d'état de réponse HTTP (/Web/HTTP/Reference/Status). {{HTTPStatus("404")}} donne 404

Ajouter des aides à la navigation pour les guides à pages multiples

Les macros Previous (angl.), Next (angl.) et PreviousNext (angl.) 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 (angl.), il faut deux paramètres : l'emplacement wiki de l'article précédent puis celui de l'article suivant.

Générer des exemples de code

Exemples interactifs

Ajouter une mise en forme générale

Ajouter des indicateurs en ligne pour la documentation API

Optional_Inline (angl.) et ReadOnlyInline (angl.) 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…

Ajouter des indicateurs de statut et de compatibilité

Ajouter des indicateurs en ligne sans paramètre supplémentaire

Non standard

Non-standard_Inline (angl.) 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 :

Expérimental

Experimental_Inline (angl.) 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 :

Ajouter des indicateurs en ligne avec technologie précisée

Obsolète

Deprecated_Inline (angl.) insère une marque en ligne de dépréciation () 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 :

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 (angl.) : {{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 (angl.) utilisé sur les pages documentant des fonctionnalités expérimentales. Exemple : {{SeeCompatTable}}

    Expérimental: Il s'agit d'une technologie expérimentale.
    Vérifiez attentivement le tableau de compatibilité des navigateurs avant de l'utiliser en production.

  • Deprecated_Header (angl.) : {{Deprecated_Header}}

    Obsolète: Cette fonctionnalité n'est plus recommandée. Même si certains navigateurs la prennent encore en charge, elle a peut-être déjà été supprimée des standards du web, est en passe d'être supprimée ou n'est conservée qu'à des fins de compatibilité. Évitez de l'utiliser et mettez à jour le code existant si possible ; consultez le tableau de compatibilité au bas de cette page pour vous aider à prendre votre décision. Sachez que cette fonctionnalité peut cesser de fonctionner à tout moment.

  • SecureContext_Header (angl.). À 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 : Cette fonctionnalité est disponible via les Web Workers, sauf pour les Service Workers.

Lier à la compatibilité navigateur et à la 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 par browser-compat dans le front-matter.

Voir aussi

Aider à améliorer MDN

Apprendre à contribuer

Cette page a été modifiée le par les contributeur·ice·s du MDN.

Voir cette page sur GitHub • Signaler un problème avec ce contenu