MDN Web Docs Änderungsprotokoll

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

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

Weitere Einzelheiten zu den Änderungen finden Sie im Blog-Beitrag zur Überarbeitung der Beitragsdokumentation der MDN Web Docs, der bei Mozilla Hacks veröffentlicht wurde.

Die Umstellung auf Markdown ist abgeschlossen, daher wurde der alte CSS-Stilführer entfernt und zur Seite Markdown in MDN weitergeleitet.

Mehrere Aktualisierungen des CSS-Stilführers, um den Übergang zu Markdown widerzuspiegeln und Autoren zu ermutigen, HTML auf eine Markdown-kompatible Weise zu schreiben.

• Hinweis- und Warnungsboxen haben keinen separaten <h4>-Titel mehr (z.B. <h4>Warning</h4>).

  Sehen Sie sich unseren Markdown in MDN Leitfaden für die korrekte Syntax an.

• Die seoSummary-Klasse sollte nicht mehr verwendet werden.

• Die standard-table-Klasse sollte nicht mehr verwendet werden. Das von dieser Klasse bereitgestellte Styling wird nun standardmäßig auf Tabellen angewendet.

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

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

Bisher wurden die Syntaxblöcke von JavaScript-Built-in- und WebAPI-Methoden, die auf mehrere verschiedene Arten verwendet werden können (d.h. verschiedene Parameter sind optional), häufig unter Verwendung der BNF formalen Syntaxnotation geschrieben. Insbesondere wurden eckige Klammern verwendet, um optionale Parameter anzuzeigen.

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

Daher schreiben wir nun verschiedene Syntaxformen einer Methode in separaten Zeilen innerhalb des Syntaxblocks. Weitere Informationen und Beispiele finden Sie unter Syntaxabschnitte > Mehrzeilig/Optionale Parameter.

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

Bisher haben wir häufig eine Einstiegsseite für eine Mixin-Klasse selbst definiert und die definierten Mitglieder auf Unterseiten darunter platziert, bevor wir von den Einstiegsseiten der Schnittstellen, die diese Mixins implementieren, darauf verlinkt haben. Dies war verwirrend für die Leser, 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 den implementierenden Klassenseiten platziert. Für weitere Informationen siehe die Leitfadenseite über wie man eine API-Referenz schreibt und die Diskussion, die zu dieser Änderung führte bei mdn/content#1940.

Früher wurden auf MDN Hinweis- und Warnungsboxen von <div>-Elementen mit den Klassen note bzw. warning umgeben. Meistens begannen ihre ersten Absätze mit einem im <strong> eingeschlossenen 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 einer Überschrift am oberen Rand des Blocks eingeschlossen.

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