MDN Web Docs Änderungsprotokoll

Die MDN-Projektdokumentation wurde aktualisiert und in zwei Hauptkategorien organisiert:

• Writing: Dokumentation darüber, wie man für MDN schreibt, was wir dokumentieren, Definitionen von experimentell, Stilrichtlinien usw. finden Sie unter den Seiten der Schreibrichtlinien.
• Community: Informationen über Open-Source-Etikette, Diskussionen, Prozesse für Pull-Requests und Issues, Benutzer und Teams sowie allgemeine Hinweise für Mitwirkende finden Sie auf den Community-Seiten.

Weitere Details zu den Änderungen finden Sie im Revamp of MDN Web Docs Contribution Docs Blogbeitrag, der auf Mozilla Hacks veröffentlicht wurde.

Die Umstellung auf Markdown ist abgeschlossen, also entfernen Sie die alte CSS-Stilrichtlinie und leiten Sie auf die Markdown in MDN-Seite um.

Mehrere Aktualisierungen der CSS-Stilrichtlinie wurden vorgenommen, um den Übergang zu Markdown zu reflektieren und Autoren dazu zu ermutigen, HTML auf eine mit Markdown kompatible Weise zu schreiben.

• Hinweis- und Warnboxen haben keinen separaten <h4>-Titel für den Titel mehr (z.B. <h4>Warnung</h4>).

  Siehe unseren Markdown in MDN Leitfaden für die korrekte Syntax.

• Die seoSummary-Klasse sollte nicht mehr verwendet werden.

• Die standard-table-Klasse sollte nicht mehr verwendet werden. Das Styling, das durch diese Klasse bereitgestellt wird, wird jetzt standardmäßig auf Tabellen angewendet.

• Das <details>-Element sollte nicht mehr verwendet werden.

• Die Klassen hidden, example-good und example-bad wurden hauptsächlich für Codeblöcke verwendet, konnten aber auch auf andere Elemente angewendet werden. Jetzt können sie nur noch auf Codeblöcke angewendet werden.

Früher wurden die Syntaxblöcke von JavaScript-Builtin- und WebAPI-Methoden, die auf verschiedene Weise verwendet werden können (d.h. verschiedene Parameter sind optional), häufig mit der BNF-Formalsyntax-Notation geschrieben. Besonders auffällig war, dass eckige Klammern verwendet wurden, um optionale Parameter zu kennzeichnen.

Dies war problematisch — viele Entwickler waren verwirrt darüber, und es steht im Konflikt mit gültigen Syntaxformen in anderen Programmiersprachen (z.B. [] ist auch ein Array in JavaScript).

Daher schreiben wir von nun an mehrere Syntaxformen einer Methode auf separate Zeilen innerhalb des Syntaxblocks. Siehe Syntax sections > Multiple lines/Optional parameters für weitere Informationen und Beispiele.

Interface-Mixins im Web IDL werden in Spezifikationen verwendet, um Web-APIs zu definieren. Für Webentwickler sind sie nicht direkt sichtbar; sie dienen als Helfer, um die Wiederholung von API-Definitionen zu vermeiden.

Früher haben wir häufig eine Einstiegsseite für eine Mixin-Klasse selbst definiert und die definierten Mitglieder auf Unterseiten darunter gesetzt, bevor wir von den Einstiegsseiten der Schnittstellen aus, die diese Mixins implementieren, darauf verwiesen. Dies war für Leser verwirrend, da Mixins Spezifikationskonstrukte sind — Sie greifen nie mit den Mixin-Klassen auf die definierten Mitglieder zu. Um diese Verwirrung zu vermeiden, haben wir die Seiten für Mitglieder, die auf Mixins definiert sind, direkt unter die Seiten der implementierenden Klassen gestellt. Weitere Details finden Sie auf der Leitfaden-Seite über wie man eine API-Referenz schreibt und der Diskussion, die zu dieser Änderung geführt hat, unter mdn/content#1940.

Früher wurden auf MDN Hinweis- und Warnboxen von <div>-Elementen mit note- und warning-Klassen umschlossen. Häufig begann ihr erster Absatz mit einem <strong>-umfassten note- oder warning-Text.

Im Januar änderte sich dies — das class-Attribut sollte jetzt eine zusätzliche notecard-Klasse enthalten, und der starke Text wird stattdessen in einen Überschriftstext oben im Block aufgenommen.

Siehe unseren Markdown in MDN Leitfaden für weitere Informationen und Syntaxanleitungen.