Seitenstrukturen

Auf MDN gibt es Dokumentstrukturen, die verwendet werden, um eine konsistente Präsentation von Informationen in MDN-Artikeln zu gewährleisten. Diese Seite listet Artikel auf, die diese Strukturen beschreiben, damit Sie den Seiteninhalt entsprechend für die Dokumente, die Sie schreiben, bearbeiten oder übersetzen, 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 nicht in Produktionscode verwendet werden sollte oder nur in einem sicheren Kontext genutzt werden kann.
Code-Beispiele: Auf MDN werden zahlreiche Code-Beispiele eingefügt, um die Nutzung von Webplattform-Funktionen zu demonstrieren. Dieser Artikel diskutiert die verschiedenen Mechanismen, die zum Hinzufügen von Code-Beispielen zu Seiten zur Verfügung stehen, sowie die Frage, welche Sie wann verwenden sollten.
Die Verwendung von Makros: Die Yari-Plattform, auf der MDN läuft, bietet ein Makrosystem, KumaScript, das es ermöglicht, bestimmte Aufgaben zu automatisieren. Dieser Artikel bietet Informationen dazu, wie man die Makros von MDN innerhalb von Artikeln aufruft.
Feature Status: Ein Feature-Status bietet Entwicklern Informationen über den Implementierungsstand des Features unter den Browseranbietern und ist eine der folgenden:
Kompatibilitätstabellen und das Browser-Kompatibilitätsdaten-Repository (BCD): MDN hat ein Standardformat für Tabellen, die die Kompatibilität von gemeinsam genutzten Technologien in allen Browsern veranschaulichen, wie z.B. DOM, HTML, CSS, JavaScript, SVG usw. Um diese Daten programmatisch in mehreren Projekten verfügbar zu machen, wird ein Node.js-Paket aus dem browser-compat-data-Repository erstellt und in npm veröffentlicht.
Link-Makros: MDN bietet zahlreiche Makros, um stets aktuelle Links zu MDN-Inhalten zu erstellen. In diesem Leitfaden lernen Sie die MDN-Querverweis-Makros kennen, die Sie verwenden können, um einen einzelnen Link zu einer anderen Seite oder eine Liste von Links zu allen Unterseiten eines Dokuments einzufügen.
Live-Beispiele: MDN unterstützt die Anzeige von Codeblöcken innerhalb der Artikel als Live-Beispiele, damit Leser sowohl den Code als auch dessen Ausgabe sehen können, wie sie auf einer Webseite aussehen würde. Diese Funktion ermöglicht es den Lesern, genau zu verstehen, welches Ergebnis der ausgeführte Code produziert, und macht die Dokumentation dynamisch und informativ. Darüber hinaus können Autoren sicherstellen, dass die Codeblöcke in der Dokumentation die erwartete Ausgabe liefern und in verschiedenen Browsern korrekt funktionieren.
Seitentypen: Es gibt eine Vielzahl von Seitentypen, die auf MDN wiederholt verwendet werden. Dieser Artikel beschreibt diese Seitentypen, ihren Zweck und gibt Beispiele für jeden und Vorlagen, die bei der Erstellung einer neuen Seite verwendet werden können.
Sidebars: Alle Seiten, die von Mitgliedern der MDN-Community bearbeitet werden können, beinhalten eine Sidebar. Diese Sidebars werden mithilfe von Makros erstellt. Dieser Artikel beschreibt die verschiedenen MDN-Sidebar-Makros und zeigt, wie Sidebars auf MDN-Seiten eingefügt werden können.
Spezifikationstabellen: Jede Referenzseite auf MDN sollte Informationen über die Spezifikation oder Spezifikationen bereitstellen, in denen diese API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen, und erklärt, wie man sie hinzufügt.
Syntax-Abschnitte: Der Syntaxabschnitt einer MDN-Referenzseite enthält ein Syntaxfeld, das die genaue Syntax definiert, die ein Feature hat (z.B. welche Parameter es akzeptieren kann, welche optional sind). Dieser Artikel erklärt, wie Syntaxfelder für Referenzartikel geschrieben werden.