API-Eigenschafts-Unterseitenvorlage

Hinweis: Entfernen Sie diesen gesamten erklärenden Hinweis, bevor Sie die Seite veröffentlichen.

Page front matter:

Die "front matter" am Anfang der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten für die entsprechende Eigenschaft entsprechend aktualisiert werden.

md
---
title: "NameOfTheParentInterface: NameOfTheProperty-Eigenschaft"
slug: Web/API/NameOfTheParentInterface/NameOfTheProperty
page-type: web-api-instance-property OR web-api-static-property
status:
  - experimental
  - deprecated
  - 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". Zum Beispiel hat die capabilities Eigenschaft der VRDisplay Schnittstelle einen title von VRDisplay: capabilities property.

slug

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

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

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 Begriffe enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf den Werten in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Siehe "Anleitung zur Ergänzung oder Aktualisierung von Feature-Status".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheProperty mit der Abfragezeichenfolge für die Eigenschaft im Browser-Kompatibilitätsdaten-Repo. Die Toolchain verwendet diesen Schlüssel automatisch, um die Abschnitte zur Kompatibilität und Spezifikation (und ersetzt die {{Compat}} und {{Specifications}} Makros) auszufüllen.

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Eigenschaft in unserem Browser-Kompatibilitätsdaten-Repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden dazu.

Top-of-page macros

Eine Anzahl von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts (unmittelbar unter der Seiten-vorlage).

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

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

Sie sollten die folgenden Makros gemäß den unten stehenden Ratschlägen aktualisieren oder löschen:

  • {{SecureContext_Header}} — dieses erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn das nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Seite Auf sichere Kontexte beschränkte Funktionen ausfüllen.
  • {{AvailableInWorkers}} — dieses erzeugt einen Verfügbar in Web-Workern-Hinweis, der darauf hinweist, 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 oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter dafür anpassen, je nach ihrer Verfügbarkeit (siehe {{AvailableInWorkers}} Makro-Quellcode für alle verfügbaren Werte), möglicherweise müssen Sie auch einen Eintrag dafür auf der Seite Web-APIs, die in Workern verfügbar sind ergänzen.
  • {{APIRef("GroupDataName")}} — dieses erzeugt die Referenz-Sidebar auf der linken Seite, die Schnellreferenz-Links anzeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API dieselbe Sidebar, die auf die anderen Seiten der API verweist. Um die korrekte Sidebar für Ihre API zu erstellen, müssen Sie einen GroupData Eintrag in unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einsetzen. Siehe unseren Leitfaden zu API-Referenzsidebars für Informationen, wie man das macht.
  • Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Fügen Sie keine Statusheader-Makros manuell hinzu. Lesen Sie den Abschnitt "Anleitung zur Ergänzung oder Aktualisierung von Feature-Status", um diese Status zur Seite hinzuzufügen.

Beispiele für die Banner Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht standardisiert werden gleich nach diesem Hinweisblock gezeigt.

Denken Sie daran, diesen gesamten erklärenden Hinweis zu entfernen, bevor Sie die Seite veröffentlichen.

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

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

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.

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.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie mit der Benennung der Eigenschaft, der Angabe, zu welcher Schnittstelle sie gehört, und der Angabe, was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Sie könnten den größten Teil dieser Informationen 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 des Datentyps und was er darstellt. Dies sollte in der Form "Ein [Name des Eigenschaftstyps], der ... darstellt" sein. Zum Beispiel:

Ein String, der darstellt...

Beachten Sie, dass einige Eigenschaftsseiten in der Form "Gibt ein [Name des Eigenschaftstyps] zurück, der ... darstellt" geschrieben sind, aber dies ist nicht die empfohlene Form. Einige WebIDL erweiterte Attribute mit bestimmten Bedeutungen können mit dem Typ assoziiert werden. Es gibt standardisierte Wege, diese zu dokumentieren; schauen Sie in 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 beschreibend dafür sein, was das Beispiel macht. Zum Beispiel sagt die Überschrift "Ein einfaches Beispiel" nichts über das Beispiel aus und ist deshalb keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Siehe unseren Leitfaden, wie man Codebeispiele hinzufügt für mehr Informationen.

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

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

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

md
## Beispiele

### Verwenden der Fetch API

Beispiel für Fetch

### Mehr Beispiele

Links zu mehr 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 zu 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 sich auf die aktuelle API beziehen. Für weitere Richtlinien siehe den Abschnitt Siehe auch im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (year)