1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Ereignis-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-Ereignis-Unterseitentemplate

Hinweis: Entfernen Sie diese gesamte erklärende Notiz, bevor Sie veröffentlichen.

Seitenvorabinformationen:

Die Vorabinformationen am Anfang der Seite werden verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten angemessen für das spezifische Ereignis aktualisiert werden.

md
---
title: "NameOfTheParentInterface: NameOfTheEvent event"
slug: Web/API/NameOfTheParentInterface/NameOfTheEvent_event
page-type: web-api-event
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheEvent_event
---
title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie das wie "NameOfTheParentInterface: NameOfTheEvent event". Zum Beispiel hat das animationcancel Ereignis der Window Schnittstelle einen title von Window: animationcancel event.

slug

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

page-type

Der Schlüssel page-type für Web/API-Ereignisse ist immer web-api-event.

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 Werten in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Sehen Sie Wie Feature-Status hinzugefügt oder aktualisiert werden.

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheEvent_event durch die Abfragezeichenfolge für das Ereignis im Browser-Kompatibilitätsdaten-Repo. Die Werkzeugkette verwendet den Schlüssel automatisch, um die Abschnitte zur Kompatibilität und Spezifikation zu füllen (Ersetzen der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für das Ereignis in unserem Browser-Kompatibilitätsdaten-Repo erstellen/aktualisieren müssen, und dieser Eintrag muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden dazu, wie das gemacht wird.

Makros oben auf der Seite

Eine Reihe von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts (unmittelbar unterhalb der Seitenvorabinformation).

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

  • {{SeeCompatTable}} — dies erzeugt 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 versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Features in Firefox ausfüllen.
  • {{Non-standard_Header}} — dies erzeugt ein Nicht-Standard-Banner, das anzeigt, dass das Feature nicht Teil irgendeiner Spezifikation ist.

Sie sollten die folgenden Makros gemäß den untenstehenden 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 ja, sollten Sie auch einen Eintrag dafür auf der Seite Features, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies erzeugt eine Verfügbar In Workers-Notiz, die anzeigt, dass die Technologie in einem Worker-Kontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch verfügbar oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise aufgrund seiner Verfügbarkeit einen Parameter übergeben (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 Workers ausfüllen.
  • {{APIRef("GroupDataName")}} — dies erzeugt das linke Referenz-Seitenleistenfenster, das schnelle Referenzlinks zeigt, 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 korrekte Seitenleiste für Ihre API zu erzeugen, müssen Sie einen GroupData Eintrag zu unserem GitHub-Repo hinzufügen und den Eintragsnamen im Makroaufruf anstelle von GroupDataName einfügen. Sehen Sie unseren Leitfaden zu API-Referenz-Seitenleisten für Informationen, wie das geht.

Stellen Sie Status-Header-Makros nicht manuell bereit. Beziehen Sie sich auf 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 Workers, Experimentell, Veraltet und Nicht-Standard Banner werden direkt nach diesem Notizblock gezeigt.

Link zum übergeordneten Objekt

Fügen Sie einen Link zu dieser neuen Seite aus dem Ereignisse-Abschnitt seines übergeordneten Objekts hinzu. Beispielsweise wird Element: wheel event von Element Ereignisse verlinkt.

Wenn das übergeordnete Objekt keinen Ereignisse-Abschnitt hat, fügen Sie einen hinzu. Wenn dies eine neue "Klasse" von Ereignissen ist, sollten Sie einen Link zu diesem Abschnitt des Elternteils aus dem DOM-Ereignisse Leitfaden hinzufügen.

Denken Sie daran, diese gesamte erklärende Notiz zu entfernen, bevor Sie veröffentlichen.

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.

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 auf der Seite mit einem einleitenden Absatz – beginnen Sie mit dem Namen des Ereignisses, sagen Sie, zu welchem Interface es gehört, und was es macht. Dies sollte idealerweise ein bis zwei kurze Sätze umfassen. Sie könnten den größten Teil davon von der Zusammenfassung der Eigenschaft auf der entsprechenden API-Referenzseite kopieren.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("NameOfTheEvent", (event) => { })

onNameOfTheEvent = (event) => { }

Ereignistyp

Wenn das Ereignis einen speziellen Typ hat, erwähnen Sie es zusammen mit seiner Vererbung. Wenn nicht, geben Sie an, dass es sich um ein generisches Ereignis handelt:

Ein generisches Event.

Oder zum Beispiel:

Ein XRSessionEvent. Erbt von Event.

Event XRSessionEvent

Beschreibung

Wenn Sie zusätzlichen Text bereitstellen möchten (zu lang für die Zusammenfassung), fügen Sie einen Beschreibungsabschnitt hinzu. Er kann die Überschriften enthalten

Auslöser

und

Anwendungsfälle

die mehr Informationen bereitstellen können.

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. "Ein einfaches Beispiel" sagt nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte präzise sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Informieren Sie sich in unserem Leitfaden dazu, wie man Code-Beispiele hinzufügt.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben 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 letzte H3-Überschrift (###) mit dem Text "Weitere Beispiele" hinzu, unter denen Sie die Links zu den Beispielen auf anderen Seiten bereitstellen können. Zum Beispiel:

md
## Beispiele

### Verwendung der fetch API

Beispiel für Fetch

### Weitere 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 die Links direkt unter der H2-Überschrift "Beispiele". 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 Leitfaden für Schreibstil.

  • link1
  • link2
  • external_link (year)

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