1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Property-Unterseitenvorlage

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

API-Property-Unterseitenvorlage

Hinweis: Entfernen Sie diese gesamte erläuternde Anmerkung vor der Veröffentlichung.

Seiten-Metadaten:

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

md
---
title: "NameOfTheParentInterface: NameOfTheProperty property"
short-title: NameOfTheProperty
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

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

short-title

Der Name der Eigenschaft (verwendet in der Seitenleiste).

slug

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

Wenn die Eigenschaft statisch ist, muss der Slug ein _static-Suffix haben, z.B.: Web/API/NameOfTheParentInterface/NameOfTheProperty_static. Dies ermöglicht es 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 dieses Features 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 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 durch die Abfragezeichenfolge für die Eigenschaft im Browser-Kompatibilitätsdaten-Repo. Der Werkzeugkasten verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (Ersetzung der {{Compat}} und {{Specifications}}-Makros).

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 unser Leitfaden dazu.

Top-of-page Makros

Eine Anzahl von Makroaufrufen erscheinen oben im Inhaltsbereich (direkt unter den Seiten-Metadaten).

Diese Makros werden vom Werkzeugkasten automatisch hinzugefügt (es ist nicht notwendig, sie hinzuzufügen/zu entfernen):

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

Sie sollten die folgenden Makros entsprechend den unten stehenden Hinweisen aktualisieren oder löschen:

  • {{SecureContext_Header}} — dies generiert ein Sicherer Kontext-Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn ja, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies generiert eine Verfügbar in Workern-Anmerkung, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch im Worker-Kontext oder nur dort verfügbar ist, müssen Sie möglicherweise einen Parameter aufgrund seiner Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makroquelle für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs verfügbar in Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — dies generiert die linke Referenzseitenleiste, die Schnellzugriffslinks zeigt, die mit der aktuellen Seite zusammenhängen. Zum Beispiel zeigt jede Seite in der WebVR API dasselbe Seitenleisten-Menü, das 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 Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren Leitfaden zur API-Referenzseitenleiste für Informationen, wie dies zu tun ist.

Fügen Sie keinen Status-Header-Makros manuell hinzu. Sehen Sie den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-Standard-Banner werden direkt nach diesem Notizblock angezeigt.

Denken Sie daran, diese gesamte erläuternde Anmerkung 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.

Die NameOfTheProperty-Eigenschaft [nur lesbar] der {{domxref("NameOfTheParentInterface")}}-Schnittstelle <geben Sie eine prägnante Zusammenfassung des Verhaltens> an.

Beginnen Sie damit, die Eigenschaft zu benennen (mit der Angabe, ob sie nur lesbar ist) und die Schnittstelle, zu der sie gehört, und erläutern Sie dann, was sie tut.

Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Wenn Sie mehr als ein paar Absätze benötigen, sollte dies in einem "Beschreibung"-Abschnitt eingefügt werden, der vor dem "Beispiele"-Abschnitt platziert wird.

Wert

Ein {{domxref("SomeDataType" }}.

Normalerweise nur der Datentyp und die zulässigen Werte für diesen Datentyp, falls relevant. Falls die Eigenschaft unterschiedliches Getter- und Setter-Verhalten aufweist, sollten diese normalerweise in separaten Sätzen behandelt werden.

In einigen Fällen möchten Sie möglicherweise mehr darüber sagen, was der Datentyp darstellt. Dies ist akzeptabel, sollte aber keine Informationen aus dem "Beschreibung"-Abschnitt duplizieren (Informationen darüber, was der Wert bedeutet, sollten dort enthalten sein).

Beachten Sie, dass einige Eigenschaftsseiten in der Form "Gibt ein [Name des Eigenschaftstyps] zurück, das..." geschrieben sind, dies ist aber nicht die empfohlene Form. Auch können einige WebIDL-Erweiterungsattribute mit spezifischen Bedeutungen mit dem Typ verbunden werden. Es gibt standardisierte Wege, diese zu dokumentieren; konsultieren Sie Informationen in einer WebIDL-Datei für weitere 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 beschreibt. 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.

Siehe unseren Leitfaden, wie man Code-Beispiele hinzufügt.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite vorhanden 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 ein und dann eine abschließende 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 von Fetch

### 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 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 sich auf die aktuelle API beziehen. Weitere Richtlinien finden Sie im Abschnitt Siehe auch im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (Jahr)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden