Modèle de sous-page de méthode d'API

Note : Supprimez cette note explicative avant de publier.

Page de garde :

Les métadonnées en haut de la page sont utilisées pour définir les « métadonnées de la page ». Les valeurs doivent être mises à jour de manière appropriée pour l'interface particulière.

---
title: "NameOfTheParentInterface : méthode NameOfTheMethod()"
slug: Web/API/NameOfTheParentInterface/NameOfTheMethod
page-type: web-api-instance-method OR web-api-static-method
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheMethod
---

title

Titre affiché en haut de la page. Format : "NameOfTheParentInterface : méthode NameOfTheMethod()". Par exemple, la méthode count() de l'interface IDBIndex a un titre de IDBIndex : méthode count().

slug

La fin du chemin URL après https://developer.mozilla.org/fr/docs/. C'est formaté comme Web/API/NameOfTheParentInterface/NameOfTheMethod.

Si la méthode est statique, le slug doit avoir un suffixe _static, comme : Web/API/NameOfTheParentInterface/NameOfTheMethod_static. Cela nous permet de prendre en charge les méthodes d'instance et les méthodes statiques qui ont le même nom.

Notez que le nom de la méthode dans le slug omet les parenthèses (il se termine par NameOfTheMethod et non NameOfTheMethod()).

page-type

La clé page-type pour les méthodes Web/API est soit web-api-instance-method (pour les méthodes d'instance) soit web-api-static-method (pour les méthodes statiques).

status

Indicateurs décrivant le statut de cette fonctionnalité. Un tableau qui peut contenir un ou plusieurs des éléments suivants : experimental, deprecated, non-standard. Cette clé ne doit pas être définie manuellement : elle est définie automatiquement en fonction des valeurs dans les données de compatibilité des navigateurs pour la fonctionnalité. Voir « Comment les statuts des fonctionnalités sont ajoutés ou mis à jour ».

browser-compat

Remplacez la valeur de l'espace réservé path.to.feature.NameOfTheMethod par la chaîne de requête pour la méthode dans le dépôt de données de compatibilité des navigateurs ^(angl.). La chaîne de l'outil utilise automatiquement la clé pour remplir les sections de compatibilité et de spécification (en remplaçant les macros {{Compat}} et {{Specifications}}).

Notez que vous devez d'abord créer/met à jour une entrée pour la méthode API dans notre dépôt de données de compatibilité des navigateurs ^(angl.), et l'entrée pour l'API doit inclure des informations sur la spécification. Consultez notre guide sur la façon de le faire.

Macros en haut de page

Un certain nombre d'appels de macros apparaissent en haut de la section de contenu (immédiatement sous les métadonnées de la page).

Ces macros sont ajoutées automatiquement par la chaîne d'outils (il n'est pas nécessaire de les ajouter/supprimer) :

• {{SeeCompatTable}} — cela génère une bannière Ceci est une technologie expérimentale qui indique que la technologie est expérimentale. Si elle est expérimentale et que la technologie est cachée derrière une préférence dans Firefox, vous devez également remplir une entrée pour elle dans la page Fonctionnalités expérimentales dans Firefox.
• {{Deprecated_Header}} — cela génère une bannière Obsolète qui indique que l'utilisation de la technologie est découragée.
• {{Non-standard_Header}} — cela génère une bannière Non standard qui indique que la fonctionnalité ne fait partie d'aucune spécification.

Vous devez mettre à jour ou supprimer les macros suivantes selon les conseils ci-dessous :

• {{SecureContext_Header}} — cela génère une bannière Contexte sécurisé qui indique que la technologie n'est disponible que dans un contexte sécurisé. Si ce n'est pas le cas, vous pouvez supprimer l'appel de la macro. Si c'est le cas, vous devez également remplir une entrée pour elle dans la page Fonctionnalités restreintes aux contextes sécurisés.
• {{AvailableInWorkers}} — cela génère une note Disponible dans les workers qui indique que la technologie est disponible dans un contexte worker. Si elle n'est disponible que dans le contexte window, vous pouvez supprimer l'appel de la macro. Si elle est également disponible ou uniquement disponible dans le contexte worker, vous devez passer un paramètre en raison de sa disponibilité (voir le code source des macros {{AvailableInWorkers}} ^(angl.) pour toutes les valeurs disponibles), vous devez également remplir une entrée pour elle dans la page APIs Web disponibles dans les workers.
• {{APIRef("GroupDataName")}} — cela génère la barre latérale de référence à gauche affichant des liens de référence rapide liés à la page actuelle. Par exemple, chaque page de l'API WebVR a la même barre latérale, qui pointe vers les autres pages de l'API. Pour générer la barre latérale correcte pour votre API, vous devez ajouter une entrée GroupData à notre dépôt GitHub, et inclure le nom de l'entrée dans l'appel de la macro à la place de GroupDataName. Consultez notre guide sur les barres latérales de référence API pour plus d'informations. Ne fournissez pas manuellement les macros d'en-tête de statut. Reportez-vous à la section Voir « Comment les statuts des fonctionnalités sont ajoutés ou mis à jour » pour ajouter ces statuts à la page.

Des exemples des bannières Contexte sécurisé, Disponible dans les workers, Expérimental, Obsolète et Non standard sont présentés juste après ce bloc de notes.

N'oubliez pas de supprimer cette note explicative avant de publier.

Note : Cette fonctionnalité est disponible via les Web Workers.