API-Eigenschafts-Subseitentemplate

Note: Entfernen Sie diese gesamte erklärende Notiz vor der Veröffentlichung.

Seiteneigenschaften:

Die Seiteneigenschaften am Anfang der Seite werden verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend der jeweiligen Eigenschaft aktualisiert werden.

md
---
title: "NameOfTheParentInterface: NameOfTheProperty property"
slug: Web/API/NameOfTheParentInterface/NameOfTheProperty
page-type: web-api-instance-property OR web-api-static-property
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheProperty
---
title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie es als "NameOfTheParentInterface: NameOfTheProperty property". Beispiel: Die capabilities-Eigenschaft der VRDisplay-Schnittstelle hat den title VRDisplay: capabilities property.

slug

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

Wenn die Eigenschaft statisch ist, muss der Slug ein _static-Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheProperty_static. Dies ermöglicht uns, Instanz- und statische Eigenschaften, die denselben Namen haben, zu unterstützen.

page-type

Der page-type-Schlüssel für Web/API-Eigenschaften ist entweder web-api-instance-property (für Instanzeigenschaften) oder web-api-static-property (für statische Eigenschaften).

status

Flags, die den Status dieser Funktion beschreiben. Ein Array, das einen oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch anhand der Werte in den Daten zur Browser-Kompatibilität für die Funktion gesetzt. Siehe "Wie Funktionsstatus hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheProperty durch die Abfragezeichenfolge für die Eigenschaft im Browser-Compat-Daten-Repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (ersetzt die {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Eigenschaft in unserem Browser-Compat-Daten-Repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unser Leitfaden, wie das geht.

Makros am Seitenanfang

Eine Reihe von Makro-Aufrufen erscheint am Anfang des Inhaltsbereichs (unmittelbar unter den Seiteneigenschaften).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist keine Hinzufügung/Entfernung erforderlich):

  • {{SeeCompatTable}} — erzeugt ein Dies ist eine experimentelle Technologie-Banner, das darauf hinweist, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie in Firefox hinter einem Pref verborgen ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — erzeugt ein Veraltet-Banner, das darauf hinweist, dass die Nutzung der Technologie nicht empfohlen wird.
  • {{Non-standard_Header}} — erzeugt ein Nicht standardisiert-Banner, das darauf hinweist, dass die Funktion nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den untenstehenden Empfehlungen aktualisieren oder löschen:

  • {{SecureContext_Header}} — erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn sie das nicht ist, können Sie den Makro-Aufruf entfernen. Wenn sie es ist, sollten Sie auch einen Eintrag auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind eintragen.
  • {{AvailableInWorkers}} — erzeugt eine In Workers verfügbar-Notiz, die darauf hinweist, dass die Technologie in einem Worker-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makro-Aufruf entfernen. Wenn sie auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter aufgrund ihrer Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag auf der Seite Web-APIs in Workers verfügbar ausfüllen.
  • {{APIRef("GroupDataName")}} — erzeugt die linke Referenz-Seitenleiste, die schnelle Referenzlinks umfasst, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API dieselbe Seitenleiste, die auf die anderen Seiten in der API verweist. Um die korrekte Seitenleiste für Ihre API zu generieren, müssen Sie einen GroupData-Eintrag in unserem GitHub-Repo hinzufügen und den Name des Eintrags im Makro-Aufruf anstelle von GroupDataName einsetzen. Siehe unseren API-Referenzseitenleisten Leitfaden für Informationen, wie Sie dies tun können.

Geben Sie keine Status-Header-Makros manuell an. Beziehen Sie sich auf den Abschnitt "Wie Funktionsstatus hinzugefügt oder aktualisiert werden", um diese Status auf der Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, In Workers verfügbar, Experimentell, Veraltet und Nicht standardisiert-Banner werden direkt nach diesem Notizblock gezeigt.

Denken Sie daran, diese gesamte erklärende Notiz vor der Veröffentlichung zu entfernen.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Beginnen Sie den Inhalt der Seite mit einem einleitenden Absatz — benennen Sie zuerst die Eigenschaft, sagen Sie, zu welcher Schnittstelle sie gehört, und was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Sie könnten den Großteil hiervon aus der Zusammenfassung der Eigenschaft auf der entsprechenden API-Referenzseite kopieren. Geben Sie an, ob sie schreibgeschützt ist oder nicht.

Wert

Fügen Sie eine Beschreibung des Wertes der Eigenschaft hinzu, einschließlich des Datentyps und was sie repräsentiert. Dies sollte in der Form sein: "Ein [Name des Eigenschaftstyps], der ... darstellt". Beispiel:

Ein String, der...

Beachten Sie, dass einige Eigenschaftsseiten in der Form "Gibt einen [Name des Eigenschaftstyps] zurück, der ... darstellt" geschrieben sind, dies ist jedoch nicht die empfohlene Form. Auch können einige WebIDL-erweiterte Attribute mit spezifischen Bedeutungen mit dem Typ assoziiert sein. Es gibt standardisierte Weisen, diese zu dokumentieren; konsultieren Sie Informationen, die in einer WebIDL-Datei enthalten sind für weitere Informationen.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, selbst wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift (###) haben, die das Beispiel benennt. Die Überschrift sollte beschreiben, was das Beispiel tut. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung nutzen Sie den Absatz nach der Überschrift.

Siehe unseren Leitfaden, wie man Code-Beispiele hinzufügt, für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben werden.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite und einige weitere auf einer anderen Seite haben:

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite hinzu und dann eine abschließende H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter dem Sie die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwendung der Fetch API

Beispiel der Fetch API

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite und keine auf dieser Seite haben:

Fügen Sie keine H3-Überschriften hinzu; fügen Sie einfach die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

Für Beispiele von dieser API, siehe [die Seite zu fetch()](https://example.org/).

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Rückwärts-Schrägstrich in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Rückwärts-Schrägstrich in der Markdown-Datei.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die sich auf die aktuelle API beziehen. Für weitere Richtlinien, siehe den Abschnitt Siehe auch im Leitfaden zum Schreibstil.

  • link1
  • link2
  • externer_link (Jahr)