Structures des documents
À travers MDN, il existe des structures de document utilisées pour assurer une présentation cohérente des informations dans les articles MDN. Cette page liste les articles qui décrivent ces structures afin que vous puissiez modifier le contenu des pages de manière appropriée pour les documents que vous rédigez, modifiez ou traduisez.
- Bannières et avis
Bannières et avis sont affichés sur certaines pages, en particulier dans la référence des API, afin de mettre en avant des éléments importants qui influencent la façon dont le contenu décrit sera utilisé. Par exemple, les bannières servent à signaler lorsqu'une interface, une méthode ou une propriété est obsolète et ne doit pas être utilisée en production, ou n'est disponible que dans un contexte sécurisé.
Toutes les pages MDN doivent avoir une barre de navigation latérale. La plupart sont créées à l'aide d'un système qui définit des structures de données dans des fichiers YAML, et inclut les barres latérales dans les pages via le front-matter ou une macro.
- Exemples de code sur MDN
Sur MDN, vous trouverez de nombreux exemples de code qui montrent comment utiliser les fonctionnalités de la plateforme Web que nous documentons. Cet article décrit les différentes façons d'ajouter des exemples de code aux pages, ainsi que les types que vous pouvez utiliser et quand les utiliser.
- Exemples interactifs (EmbedLiveSample)
MDN prend en charge l'affichage de blocs de code dans les articles sous forme d'exemples interactifs, afin que les lecteur·ice·s puissent voir à la fois le code source et son résultat tel qu'il apparaît sur une page web. Cette fonctionnalité permet aux lecteur·ice·s de comprendre exactement ce que le code exécuté produira, rendant la documentation dynamique et instructive. Elle permet aussi aux auteur·ice·s d'être absolument certain·e·s que les blocs de code de la documentation produisent le résultat attendu et fonctionnent correctement avec différents navigateurs.
- Macros de liens
MDN propose de nombreuses macros pour créer des liens toujours à jour vers le contenu MDN. Ce guide présente les macros de renvoi croisé MDN que vous pouvez utiliser pour inclure un lien unique vers une autre page ou une liste de liens vers toutes les sous-pages d'un document.
- Prothèses d'émulation (polyfills)
Cette page présente la politique de MDN concernant l'inclusion de prothèses d'émulation (polyfills) dans la documentation de référence pour JavaScript et les API Web.
- Sections de syntaxe
La section de syntaxe d'une page de référence MDN contient un encadré de syntaxe définissant la syntaxe exacte d'une fonctionnalité (par exemple, quels paramètres peut-elle accepter, lesquels sont optionnels ?). Cet article explique comment rédiger les encadrés de syntaxe pour les articles de référence.
- Statut des fonctionnalités
Le statut d'une fonctionnalité indique globalement l'état d'implémentation entre les navigateurs et de standardisation d'une fonctionnalité de la plateforme web, comme une méthode d'API Web ou une propriété CSS.
MDN utilise un format standard pour les tableaux qui illustrent la compatibilité des technologies partagées entre tous les navigateurs, comme DOM, HTML, CSS, JavaScript, SVG, etc. Pour rendre ces données disponibles dans plusieurs projets de façon programmatique, un package Node.js est construit à partir du dépôt browser-compat-data (angl.) et publié sur npm.
- Tableaux de spécifications
Chaque page de référence sur MDN doit fournir des informations sur la ou les spécifications dans lesquelles cette API ou technologie a été définie. Cet article montre à quoi ressemblent ces tableaux et explique comment les ajouter.
- Types de pages
Il existe plusieurs types de pages qui sont utilisés de façon répétée sur MDN. Cet article décrit ces types de pages, leur objectif, et donne des exemples pour chacun ainsi que des modèles à utiliser lors de la création d'une nouvelle page.
- Utiliser les macros
Le backend rari est le système de construction de MDN et fournit une syntaxe de macro pour les tâches courantes.