API-Methode Unterseite Vorlage

Note: Diesen gesamten erklärenden Hinweis vor der Veröffentlichung entfernen.

---

Seiten-Frontmatter:

Das Frontmatter am Anfang der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten für die jeweilige Methode entsprechend aktualisiert werden.

md

---
title: NameOfTheParentInterface.NameOfTheMethod()
slug: Web/API/NameOfTheParentInterface/NameOfTheMethod
page-type: web-api-instance-method OR web-api-static-method
status:
  - experimental
  - deprecated
  - non-standard
browser-compat: path.to.feature.NameOfTheMethod
---

title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie als "NameOfTheParentInterface: NameOfTheMethod() Methode". Zum Beispiel hat die count() Methode der IDBIndex Schnittstelle einen Titel von IDBIndex: count() Methode.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird formatiert wie Web/API/NameOfTheParentInterface/NameOfTheMethod.

Wenn die Methode statisch ist, muss der Slug ein _static Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheMethod_static. Dies ermöglicht uns, Instanz- und statische Methoden mit demselben Namen zu unterstützen.

Beachten Sie, dass der Name der Methode im Slug die Klammern weglässt (er endet mit NameOfTheMethod nicht NameOfTheMethod()).

page-type

Der page-type Schlüssel für Web/API-Methoden ist entweder web-api-instance-method (für Instanzmethoden) oder web-api-static-method (für statische Methoden).

status

Kennzeichnungen, die den Status dieser Funktion beschreiben. Ein Array, das eine oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: er wird automatisch basierend auf Werten in den Browser-Kompatibilitätsdaten für die Funktion gesetzt. Siehe "Anleitung, um Funktionsstatuse zu hinzufügen oder zu aktualisieren".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod mit der Abfragezeichenfolge für die Methode im Browser compat data repo. Die Toolchain verwendet automatisch den Schlüssel, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (anstelle der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Methode in unserem Browser compat data repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unser Leitfaden dazu.

---

Makros am Anfang der Seite

Mehrere Makroaufrufe erscheinen am Anfang des Inhaltsabschnitts (unmittelbar unter dem Frontmatter der Seite).

Diese Makros werden automatisch durch die Toolchain hinzugefügt (es gibt keinen Bedarf zum Hinzufügen/Entfernen):

• {{SeeCompatTable}} — dies generiert ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie sich hinter einer Voreinstellung in Firefox versteckt, sollten Sie auch einen Eintrag auf der Seite Experimentelle Funktionen in Firefox dafür ausfüllen.
• {{Deprecated_Header}} — dies generiert ein Veraltet Banner, das anzeigt, dass die Nutzung der Technologie nicht empfohlen ist.
• {{Non-standard_Header}} — dies generiert ein Nicht standardisiert Banner, das anzeigt, dass die Funktion nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros aktualisieren oder löschen gemäß dem unten stehenden Rat:

• {{SecureContext_Header}} — dies generiert ein Sicherer Kontext Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn nicht, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag auf der Seite Auf sichere Kontexte beschränkte Funktionen dafür ausfüllen.
• {{AvailableInWorkers}} — dies generiert eine Verfügbar in Workern Notiz, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch im Worker-Kontext verfügbar oder nur dort verfügbar ist, müssen Sie möglicherweise ein Parameter dafür übergeben, aufgrund ihrer Verfügbarkeit (sehen Sie sich den {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte an), und Sie müssen möglicherweise einen Eintrag auf der Seite Web APIs verfügbar in Workern dafür ausfüllen.
• {{APIRef("GroupDataName")}} — dies generiert die linke Referenz-Sidebar, die schnelle Referenzlinks zeigt, die mit der aktuellen Seite zusammenhängen. Zum Beispiel hat jede Seite der WebVR API dieselbe Sidebar, die auf andere Seiten in der API verweist. Um die richtige Sidebar für Ihre API zu generieren, müssen Sie einen GroupData Eintrag zu unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unser Leitfaden für API-Referenz-Sidebars für Informationen dazu wie Sie es tun können.
• Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Fügen Sie keine Status-Kopfzeilenmakros manuell hinzu. Verweisen Sie auf den Abschnitt "Anleitung, um Funktionsstatuse zu hinzufügen oder zu aktualisieren", um diese Statuse zur Seite hinzuzufügen.

Beispiele der Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht standardisiert Banner werden direkt nach diesem Hinweisblock gezeigt.

Erinnern Sie sich daran, diesen gesamten erklärenden Hinweis vor der Veröffentlichung zu entfernen.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie mit dem Benennen der Methode, sagen Sie, zu welcher Schnittstelle sie gehört, und was sie macht. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den größten Teil davon aus der Zusammenfassung der Methode auf der entsprechenden API-Referenzseite kopieren.