Seitenstrukturen

Auf MDN gibt es Dokumentstrukturen, die verwendet werden, um eine konsistente Darstellung von Informationen in MDN-Artikeln zu gewährleisten. Diese Seite listet Artikel auf, die diese Strukturen beschreiben, damit Sie den Seiteninhalt für die Dokumente, die Sie schreiben, bearbeiten oder übersetzen, entsprechend anpassen können.

Banner und Hinweise: Banner und Hinweise werden auf einigen Seiten angezeigt, insbesondere in der API-Referenz, um wichtige Faktoren hervorzuheben, die beeinflussen, wie der beschriebene Inhalt verwendet wird. Zum Beispiel werden Banner verwendet, um hervorzuheben, wenn eine bestimmte Schnittstelle, Methode oder Eigenschaft veraltet ist und in Produktionscode nicht verwendet werden sollte, oder nur in einem sicheren Kontext verwendet werden kann.
Code-Beispiele: Auf MDN finden Sie zahlreiche Code-Beispiele, die auf den Seiten eingefügt sind, um die Verwendung von Webplattform-Funktionen zu demonstrieren. Dieser Artikel erläutert die verschiedenen Mechanismen, die zum Hinzufügen von Code-Beispielen zu den Seiten verfügbar sind, und welche Sie wann verwenden sollten.
Funktionsstatus: Ein Funktionsstatus bietet Entwicklern Informationen über den Implementierungsstand der Funktion bei Browser-Herstellern und ist einer der folgenden:
Kompatibilitätstabellen und das Browser-Kompatibilitätsdaten-Repository (BCD): MDN hat ein Standardformat für Tabellen entwickelt, die die Kompatibilität gemeinsamer Technologien in allen Browsern aufzeigen, wie DOM, HTML, CSS, JavaScript, SVG usw. Um diese Daten programmgesteuert in mehreren Projekten verfügbar zu machen, wird ein Node.js-Paket aus dem browser-compat-data repository erstellt und auf npm veröffentlicht.
Link-Makros: MDN bietet zahlreiche Makros, um stets aktuelle Links zu MDN-Inhalten zu erstellen. In diesem Leitfaden lernen Sie MDN-Querverweis-Makros kennen, mit denen Sie entweder einen einzigen Link zu einer anderen Seite oder eine Liste von Links zu allen Unterseiten eines Dokuments einfügen können.
Live-Beispiele: MDN unterstützt die Anzeige von Codeblöcken innerhalb der Artikel als Live-Beispiele, die es den Lesern ermöglichen, sowohl den Code als auch seine Ausgabe zu sehen, wie sie auf einer Webseite aussehen würde. Diese Funktion erlaubt es den Lesern, genau zu verstehen, was der ausgeführte Code produzieren würde, und macht die Dokumentation dynamisch und lehrreich. Es ermöglicht auch den Autoren, absolut sicherzustellen, dass die Codeblöcke in der Dokumentation die erwartete Ausgabe haben und ordnungsgemäß funktionieren, wenn sie mit verschiedenen Browsern verwendet werden.
Seitenleisten: MDN-Seiten umfassen alle Seitenleisten. Die meisten von ihnen werden durch ein standardisiertes System erstellt, das Datenstrukturen in YAML-Dateien definiert und Seitenleisten auf Seiten mithilfe von Makroaufrufen einfügt.
Seitentypen: Es gibt eine Reihe von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, ihren Zweck und gibt Beispiele sowie Vorlagen zur Erstellung einer neuen Seite.
Spezifikationstabellen: Jede Referenzseite auf MDN sollte Informationen über die Spezifikation(en) bereitstellen, in der/denen diese API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie man sie hinzufügt.
Syntaxabschnitte: Der Syntaxabschnitt einer MDN-Referenzseite enthält eine Syntaxbox, die die genaue Syntax definiert, die ein Feature hat (z. B. welche Parameter es akzeptieren kann, welche optional sind?). Dieser Artikel erklärt, wie man Syntaxboxen für Referenzartikel schreibt.
Verwendung von Makros: Die Yari-Plattform, auf der MDN läuft, bietet ein Makrosystem namens KumaScript, das es ermöglicht, bestimmte Aufgaben zu automatisieren. Dieser Artikel liefert Informationen zur Verwendung von MDNs Makros innerhalb von Artikeln.