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

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 Unterseitentemplate

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

Seiten-Front-Matter:

Das Front-Matter am Anfang der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend für die spezielle 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

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie 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 (wird in der Seitenleiste verwendet).

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, muss das Slug ein _static Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheProperty_static. Dies ermöglicht es 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 eines oder mehrere der folgenden 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 "Wie Feature-Status hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheProperty mit dem Abfrage-String für die Eigenschaft im Browser compat data repo. Die Toolchain verwendet diesen 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 data repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden, wie Sie dies tun.

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheinen am Anfang des Inhaltsbereichs (unmittelbar unter dem Seiten-Front-Matter).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht erforderlich hinzuzufügen/entfernen):

  • {{SeeCompatTable}} — Dies erzeugt ein Dies ist eine experimentelle Technologie Banner, das darauf hinweist, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie hinter einem Pref in Firefox versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox einfügen.
  • {{Deprecated_Header}} — Dies erzeugt ein Veraltet Banner, das anzeigt, dass die Verwendung der Technologie nicht empfohlen wird.
  • {{Non-standard_Header}} — Dies erzeugt ein Nicht-standard 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}} — Dies erzeugt 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 dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — Dies erzeugt einen Verfügbar in Arbeitern Hinweis, der darauf hinweist, dass die Technologie in einem worker context verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter dafür aufgrund seiner Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs verfügbar in Arbeitern ausfüllen.
  • {{APIRef("GroupDataName")}} — Dies erzeugt die linke Referenz-Sidebar, die schnelle Referenzlinks anzeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite der WebVR API dieselbe Sidebar, welche auf die anderen Seiten der API verweist. Um die korrekte Sidebar für Ihre API zu generieren, müssen Sie einen GroupData-Eintrag in unser GitHub-Repo hinzufügen und den Namen des Eintrags innerhalb des Makroaufrufs anstelle von GroupDataName verwenden. Siehe unseren API-Referenz-Sidebars Leitfaden für Informationen, wie man dies tut.

Status-Header-Makros nicht manuell bereitstellen. Verweisen Sie auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele der Sicherer Kontext, Verfügbar in Arbeitern, Experimentell, Veraltet und Nicht-standard 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.

Die NameOfTheProperty [schreibgeschützte] Eigenschaft der {{domxref("NameOfTheParentInterface")}} Schnittstelle <bereitstellen eine prägnante Zusammenfassung des Verhaltens>.

Beginnen Sie mit dem Benennen der Eigenschaft (unter Angabe, ob sie schreibgeschützt ist oder nicht) und der Schnittstelle, zu der sie gehört, und sagen Sie dann, was sie tut.

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

Wert

Ein {{domxref("SomeDataType" }}.

Normalerweise nur der Datentyp und die zulässigen Werte für diesen Datentyp, falls relevant. Wenn die Eigenschaft unterschiedliches Verhalten beim Festlegen und Abrufen hat, sollten diese normalerweise in separaten Sätzen beschrieben werden.

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

Beachten Sie, dass einige Eigenschaftsseiten in der Form "Gibt einen [Name des Eigenschaftstyps] zurück, das..." geschrieben sind, dies ist jedoch nicht die empfohlene Form. Außerdem können einige WebIDL-Erweiterungsattribute mit spezifischen Bedeutungen dem Typ zugeordnet sein. Es gibt standardisierte Wege, sie zu dokumentieren; konsultieren Sie Informationen, die in einer WebIDL-Datei enthalten sind für weitere Informationen.

Beispiele

Beachtn 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 (###) mit dem Namen des Beispiels haben. 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 zur Hinzufügung von Code-Beispielen für weitere Informationen.

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

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 hinzu 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

### Nutzung 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 zu dieser API siehe [die Seite zu 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 Siehe auch Abschnitt im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (Jahr)

Help improve MDN

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden