1. MDN Web Docs
  2. Règles d'écriture
  3. Structures des documents
  4. Types de pages
  5. Modèle de sous-page d'évènement d'API

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

Modèle de sous-page d'évènement d'API

Note : Supprimez cette note explicative avant la publication

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'évènement particulier.

md
---
title: "NameOfTheParentInterface : évènement NameOfTheEvent"
slug: Web/API/NameOfTheParentInterface/NameOfTheEvent_event
page-type: web-api-event
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheEvent_event
---
title

Titre affiché en haut de la page. Format : NameOfTheParentInterface : évènement NameOfTheEvent. Par exemple, l'évènement animationcancel de l'interface Window a un titre de Window : évènement animationcancel.

slug

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

page-type

La clé page-type pour les évènements Web/API est toujours web-api-event.

status

Indicateurs décrivant le statut de cette fonctionnalité. Un tableau pouvant 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.NameOfTheEvent_event par la chaîne de caractères de requête pour l'évènement dans le dépôt de données de compatibilité des navigateurs. 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 peut-être d'abord créer/met à jour une entrée pour l'évènement dans notre dépôt de données de compatibilité des navigateurs, et cette entrée doit inclure des informations sur la spécification. Consultez notre guide sur la façon de procéder.

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 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 le contexte des workers. Si elle n'est disponible que dans le contexte de la fenêtre, vous pouvez supprimer l'appel de macro. Si elle est également disponible ou uniquement disponible dans le contexte des workers, vous devez peut-être passer un paramètre en raison de sa disponibilité (voir le code source des macros {{AvailableInWorkers}} pour toutes les valeurs disponibles), vous devez peut-être également remplir une entrée pour elle dans la page API 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 à l'intérieur de l'appel de macro à la place de GroupDataName. Consultez notre guide sur les barres latérales de référence API pour obtenir des informations sur la façon de procéder.

Ne fournissez pas manuellement les macros d'en-tête de statut. Reportez-vous à la section « 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 affichés juste après ce bloc de notes.

Lien vers l'objet parent

Ajoutez un lien vers cette nouvelle page depuis la section Évènements de l'objet parent. Par exemple, Element : évènement wheel est lié depuis Évènements Element.

Si l'objet parent n'a pas de section Évènements, ajoutez-en une. Si c'est une nouvelle « classe » d'évènement, vous devez ajouter un lien vers cette section du parent depuis le guide Évènements DOM.

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

Contexte sécurisé: Cette fonctionnalité est uniquement disponible dans des contextes sécurisés (HTTPS), pour certains navigateurs qui la prennent en charge.

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

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.

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.

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.

Commencez le contenu de la page par un paragraphe introductif — commencez par nommer l'évènement, indiquez à quelle interface il appartient et expliquez ce qu'il fait. Idéalement, cela doit être une ou deux phrases courtes. Vous pouvez copier la plupart de ces informations à partir du résumé de la propriété sur la page de référence API correspondante.

Syntax

Utilisez le nom de l'évènement dans des méthodes comme addEventListener(), ou définissez une propriété de gestionnaire d'évènements.

js
addEventListener("NameOfTheEvent", (event) => { })

onNameOfTheEvent = (event) => { }

Type d'évènement

Si l'évènement a un type spécial, mentionnez-le ainsi que son héritage. Sinon, indiquez qu'il s'agit d'un évènement générique :

Un Event générique.

Ou, par exemple :

Un XRSessionEvent. Hérite de Event.

Event XRSessionEvent

Description

Si vous souhaitez fournir un texte supplémentaire (trop long pour le résumé), ajoutez une section Description. Elle peut contenir les titres

Déclenchement

et

Cas d'utilisation

qui peuvent fournir plus d'informations.

Exemples

Notez que nous utilisons le pluriel « Exemples » même si la page ne contient qu'un seul exemple.

Un titre descriptif

Chaque exemple doit avoir un titre H3 (###) nommant l'exemple. Le titre doit être descriptif de ce que fait l'exemple. Par exemple, « Un exemple simple » ne dit rien sur l'exemple et n'est donc pas un bon titre. Le titre doit être concis. Pour une description plus longue, utilisez le paragraphe après le titre.

Voir notre guide sur la façon d'ajouter des exemples de code pour plus d'informations.

Note : Parfois, vous pouvez vouloir créer un lien vers des exemples donnés sur une autre page.

Scénario 1 : Si vous avez des exemples sur cette page et d'autres exemples sur une autre page :

Incluez un titre H3 (###) pour chaque exemple sur cette page, puis un dernier titre H3 (###) avec le texte "Plus d'exemples", sous lequel vous pouvez créer des liens vers les exemples sur d'autres pages. Par exemple :

md
## Exemples

### Utiliser l'API fetch

Exemple de Fetch

### Plus d'exemples

Liens vers plus d'exemples sur d'autres pages

Scénario 2 : Si vous n'avez des exemples que sur une autre page et aucun sur cette page :

N'ajoutez pas de titres H3 ; ajoutez simplement les liens directement sous le titre H2 "Exemples". Par exemple :

md
## Exemples

Pour des exemples de cette API, voir [la page sur `fetch()`](https://example.org/).

Spécifications

{{Specifications}}

Pour utiliser cette macro, supprimez les accents inversés et la barre oblique inverse dans le fichier markdown.

Compatibilité des navigateurs

{{Compat}}

Pour utiliser cette macro, supprimez les accents inversés et la barre oblique inverse dans le fichier markdown.

Voir aussi

Incluez des liens vers des pages de référence et des guides liés à l'API actuelle. Pour plus de directives, consultez la section Voir aussi du Guide de style d'écriture.

  • lien1
  • lien2
  • lien_externe (année)

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