API-Eigenschafts-Unterseite Vorlage

Note: Entfernen Sie diese gesamte Erläuterungshilfe vor der Veröffentlichung.

Seiten-Metainformationen:

Die Metainformationen am oberen Rand der Seite werden verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten für die jeweilige Eigenschaft entsprechend 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

Der Überschriftstitel, der oben auf der Seite angezeigt wird. Formatieren Sie ihn als "NameOfTheParentInterface: NameOfTheProperty property". Zum Beispiel hat die capabilities Eigenschaft der VRDisplay Schnittstelle einen title von VRDisplay: capabilities property.

slug

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

Wenn die Eigenschaft statisch ist, muss der Slug einen _static Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheProperty_static. Dies ermöglicht uns, Instanz- und statische Eigenschaften mit demselben Namen 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 dieses Features beschreiben. Ein Array, das einen oder mehrere der folgenden Werte enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell festgelegt werden: Er wird automatisch basierend auf Werten in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".

browser-compat

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

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Eigenschaft in unserem Browser compat data repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Sehen Sie unseren Leitfaden, wie dies zu tun ist.

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheinen am Anfang des Inhaltsabschnitts (unmittelbar unter den Seiten-Metainformationen).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht nötig, hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — generiert ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie hinter einem Pref in Firefox verborgen ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Features in Firefox ausfüllen.
  • {{Deprecated_Header}} — generiert ein Veraltet Banner, das anzeigt, dass die Verwendung der Technologie nicht empfohlen wird.
  • {{Non-standard_Header}} — generiert ein Nicht standardisiert Banner, das anzeigt, dass das Feature kein Teil einer Spezifikation ist.

Sie sollten die folgenden Makros entsprechend dem unten stehenden Rat aktualisieren oder löschen:

  • {{SecureContext_Header}} — 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 ja, sollten Sie auch einen Eintrag dafür auf der Seite Features, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — generiert eine Verfügbar in Workern Notiz, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Window-Kontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter übergeben, der wegen ihrer Verfügbarkeit erforderlich ist (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag auf der Seite Web APIs verfügbar in Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — generiert die linke Referenz-Seitenleiste, die schnelle Referenzlinks anzeigt, die mit der aktuellen Seite zusammenhängen. Zum Beispiel hat jede Seite in der WebVR API die gleiche Seitenleiste, die auf die anderen Seiten in der API verweist. Um die richtige Seitenleiste für Ihre API zu generieren, müssen Sie einen GroupData Eintrag in unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Weitere Informationen dazu finden Sie in unserem Leitfaden für API-Referenzseitenleisten.
  • Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Status-Header-Makros nicht manuell bereitstellen. Lesen Sie die Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zu der Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht standardisiert Banner sind direkt nach diesem Hinweisblock zu sehen.

Denken Sie daran, diesen gesamten Erläuterungshinweis 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 und befindet sich nicht auf dem Weg zur Standardisierung. Verwenden Sie sie nicht auf Produktionsseiten, die dem Web ausgesetzt sind: Sie funktioniert nicht für alle Benutzer. Es kann auch große Inkompatibilitäten zwischen Implementierungen geben, und das Verhalten kann sich in Zukunft ändern.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie damit, die Eigenschaft zu benennen, zu sagen, zu welchem Interface sie gehört und zu beschreiben, was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den größten Teil davon 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 Eigenschaftswerts ein, einschließlich Datentyp und was er darstellt. Dies sollte in der Form erfolgen: "Ein [Name des Eigenschaftstyps], der ... darstellt". Zum Beispiel:

Ein String, der...

Beachten Sie, dass einige Eigenschaftsseiten in der Form "Gibt ein [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 Wege, diese zu dokumentieren; konsultieren Sie Informationen, die in einer WebIDL-Datei enthalten sind für mehr Informationen.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, auch 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 verwenden Sie den Absatz nach der Überschrift.

Weitere Informationen finden Sie in unserem Leitfaden zum Hinzufügen von Codebeispielen.

Hinweis: Manchmal möchten Sie auf Beispiele auf einer anderen Seite verlinken.

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

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

md
## Beispiele

### Verwendung der Fetch-API

Beispiel für Fetch

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

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

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

md
## Beispiele

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

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen API zusammenhängen. Weitere Richtlinien finden Sie im Abschnitt Siehe auch im Leitfaden für Schreibstil.

  • link1
  • link2
  • external_link (Jahr)