1. MDN Web Docs
  2. Règles d'écriture
  3. Structures des documents
  4. Types de pages
  5. Modèle de sous-page de propriété 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 de propriété 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.

md
---
title: "NameOfTheParentInterface : propriété NameOfTheProperty"
short-title: NameOfTheProperty
slug: Web/API/NameOfTheParentInterface/NameOfTheProperty
page-type: web-api-instance-property OR web-api-static-property
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheProperty
---
title

Titre affiché en haut de la page. Formaté comme "NameOfTheParentInterface : propriété NameOfTheProperty". Par exemple, la propriété capabilities de l'interface VRDisplay a un title de VRDisplay : propriété capabilities.

short-title

Le nom de la propriété (utilisé dans la barre latérale).

slug

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

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

page-type

La clé page-type pour les propriétés Web/API est soit web-api-instance-property (pour les propriétés d'instance) soit web-api-static-property (pour les propriétés 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.NameOfTheProperty par la chaîne de requête pour la propriété dans le dépôt de données de compatibilité des navigateurs (angl.). La chaîne d'outils 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/mette à jour une entrée pour la propriété 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}} — 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}} — génère une bannière Obsolète qui indique que l'utilisation de la technologie est découragée.
  • {{Non-standard_Header}} — 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}} — 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}} — 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 API Web disponibles dans les workers.
  • {{APIRef("GroupDataName")}} — 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.

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.

La propriété [en lecture seule] NameOfTheProperty de l'interface {{DOMxRef("NameOfTheParentInterface")}} <fournir un résumé concis du comportement>.

Commencez par nommer la propriété (en indiquant si elle est en lecture seule ou non) et l'interface à laquelle elle appartient, puis indiquez ce qu'elle fait.

Cela doit idéalement être une ou deux phrases courtes. Si vous avez besoin de plus de quelques paragraphes, cela doit être ajouté dans une section « Description » placée avant la section « Exemples ».

Valeurs

Un {{DOMxRef("TypeDeDonnée")}}.

Normalement, il s'agit simplement du type de données, et des valeurs autorisées pour ce type de données si pertinent. Si la propriété a un comportement différent pour le mutateur et l'accesseur, ceux-ci doivent normalement être couverts dans des phrases séparées.

Dans certains cas, vous pouvez vouloir en dire plus sur ce que représente le type de données. Cela est acceptable, mais ne doit pas dupliquer les informations de la section « Description » (vous devez inclure des informations sur ce que signifie la valeur dans cette section).

Notez que certaines pages de propriétés sont rédigées sous la forme "Retourne un [nom du type de propriété] représentant...", mais ce n'est pas la forme recommandée. De plus, certains attributs étendus WebIDL avec des significations spécifiques peuvent être associés au type. Il existe des moyens standard de les documenter ; consultez Informations contenues dans un fichier WebIDL pour 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.

Consultez 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 l'antislash dans le fichier markdown.

Compatibilité des navigateurs

{{Compat}}

Pour utiliser cette macro, supprimez les accents inversés et l'antislash 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 dans le 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