Feature Status
Ein Feature-Status bietet Entwicklern Informationen über den Implementierungsstand des Features unter den Browseranbietern und ist eine der folgenden:
Wenn keiner der oben genannten Status zutrifft, wird das Feature als stabil und standardisiert betrachtet. Wir fügen diesen Status nicht explizit zu Inhaltsseiten hinzu. Weitere Informationen zu diesen Begriffen finden Sie auf der Seite "Experimental, deprecated, and obsolete".
Um detaillierte Anleitungen zur Auswahl eines Status für ein Feature zu sehen, beziehen Sie sich auf den Abschnitt choosing status properties im @mdn/browser-compat-data
(BCD) Repository.
Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status
Die Feature-Status aller auf MDN dokumentierten Features werden in ihrem begleitenden @mdn/browser-compat-data (BCD) Repository-Eintrag definiert und werden automatisch im mdn/content
Repository aktualisiert, wann immer eine neue Version von BCD veröffentlicht wird.
Warnung: Aktualisieren Sie die Feature-Status nicht manuell im mdn/content
Repository. Um den Status eines Features zu aktualisieren, müssen Sie einen Pull-Request einreichen im BCD-Repository. Nachdem Ihre Änderungen genehmigt und im BCD zusammengeführt wurden, aktualisiert ein automatisierter Pull-Request die Status im mdn/content
Repository.
Die Automatisierung verwendet den browser-compat
Schlüssel im Front-Matter. Der Schlüssel speichert die BCD-Abfrage, die erforderlich ist, um das Feature in den Kompatibilitätsdaten zu finden. Wenn der browser-compat
Schlüssel mehrere Werte hat, verwendet die Automatisierung nur den ersten Wert, um Statusmakros zu rendern.
Wie werden Feature-Status in Inhalten spezifiziert?
Die folgenden Abschnitte dokumentieren Mechanismen, mit denen Feature-Status in MDN-Dokumenten gerendert werden. Wie bereits erwähnt, sollten Sie diese Mechanismen als schreibgeschützt betrachten, da ihre Einbeziehung in den Inhalt automatisiert ist.
Feature-Status-Icons in Sidebars
Um Status-Icons für ein in Sidebars aufgeführtes Feature anzuzeigen, wird die Front-Matter status
Eigenschaft verwendet:
---
title: Feature name
status:
- experimental
- non-standard
- deprecated
browser-compat: api.feature
---
Wenn Sidebars gerendert werden, durchsucht der Code die Status in jedem Seiten-Front-Matter. Wie bereits erwähnt, werden diese Status automatisch aktualisiert; Sie müssen sie nicht manuell ändern.
Feature-Status-Seitenbanner
Die folgenden Makros werden verwendet, um die Status-Banner in Seitenkopfzeilen zu rendern:
{{SeeCompatTable}}
-
Für den
experimental
Status. Es erzeugt ein Experimental status Banner:Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden. {{Non-standard_Header}}
-
Für den
non-standard
Status. Es erzeugt ein Non-Standard status Banner:Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.
{{Deprecated_Header}}
-
Für den
deprecated
Status. Es erzeugt ein Deprecated status Banner:Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, kann sie bereits aus den relevanten Webstandards entfernt worden sein, befindet sich im Prozess der Entfernung oder wird nur aus Kompatibilitätsgründen beibehalten. Vermeiden Sie die Verwendung und aktualisieren Sie gegebenenfalls bestehenden Code; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu treffen. Beachten Sie, dass diese Funktion jederzeit nicht mehr funktionieren kann.
Feature-Status-Icons in Definitionslisten
Die folgenden Makros werden verwendet, um Inline-Status-Icons neben Einträgen in Definitionslisten zu rendern:
{{Experimental_Inline}}
Icon: Experimentell{{Non-standard_Inline}}
Icon: Nicht standardisiert{{Deprecated_Inline}}
Icon: Veraltet
Siehe auch
- Sidebar-Makros
- Link-Makros
- Liste der Makros auf GitHub