MDN Web Docs Änderungsprotokoll

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

• Schreiben: Dokumentation darüber, wie man für MDN schreibt, was wir dokumentieren, Definitionen von experimentell, Stilrichtlinien und so weiter sind auf den Seiten Schreibrichtlinien zu finden.
• Gemeinschaft: Informationen über Open-Source-Etikette, Diskussionen, Prozesse für Pull-Requests und Probleme, Benutzer und Teams sowie allgemeine Hinweise für Beitragende sind auf den Seiten Gemeinschaft zu finden.

Weitere Details zu den Änderungen finden Sie im Blogbeitrag Überarbeitung der MDN Web Docs Beitragsdokumentation auf Mozilla Hacks.

Die Umstellung auf Markdown ist abgeschlossen, daher den alten CSS-Stil-Leitfaden entfernen und auf die Seite Markdown in MDN umleiten.

Mehrere Aktualisierungen des CSS-Stilleitfadens, um die Umstellung auf Markdown widerzuspiegeln und Autoren dazu zu ermutigen, HTML auf eine mit Markdown kompatible Weise zu schreiben.

• Hinweis- und Warnboxen haben keinen separaten <h4>-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 von dieser Klasse bereitgestellte Styling 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 anderen Elementen verwendet werden. Jetzt können sie nur noch auf Codeblöcken verwendet werden.

Zuvor wurden die Syntaxblöcke von JavaScript eingebauten und WebAPI-Methoden, die auf verschiedene Weise verwendet werden können (d.h. verschiedene Parameter sind optional), häufig unter Verwendung der BNF-Formsprache Notation geschrieben. Am bemerkenswertesten waren die eckigen Klammern, die optionale Parameter bezeichneten.

Das war problematisch – viele Entwickler waren darüber verwirrt, und es widerspricht gültigen Syntaxformen in anderen Programmiersprachen (z.B. [] ist auch ein Array in JavaScript).

Deshalb schreiben wir nun in Zukunft mehrere Syntaxformen einer Methode auf separaten Zeilen innerhalb des Syntaxblocks. Für weitere Informationen und Beispiele siehe Syntaxabschnitte > Mehrere Zeilen/Optionale Parameter.

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

Zuvor haben wir häufig eine Hauptseite für eine Mixin-Klasse selbst definiert und die definierten Mitglieder auf Unterseiten unterhalb dieser platziert, bevor wir von den Hauptseiten der Schnittstellen, die diese Mixins implementieren, auf sie verlinkt haben. Dies war verwirrend für Leser, da Mixins Spezkonstrukte sind – die definierten Mitglieder werden nie mit den Mixin-Klassen aufgerufen. Um diese Verwirrung zu vermeiden, haben wir die Seiten für Mitglieder, die auf Mixins definiert sind, direkt unter den implementierenden Klassenseiten platziert. Für weitere Details siehe die Leitfadenseite zur Anleitung zum Schreiben einer API-Referenz und die Diskussion, die zu dieser Änderung führte, auf mdn/content#1940.

Zuvor wurden Hinweis- und Warnkästen auf MDN mit <div>-Elementen mit note- und warning-Klassen umgeben. Häufig begannen ihre ersten Absätze mit einem <strong> umwickelten note oder warning Text.

Im Januar änderte sich dies – das class Attribut sollte nun eine zusätzliche notecard Klasse beinhalten, und der starke Text ist stattdessen in einer Überschrift am oberen Rand des Blocks enthalten.

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