1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Ereignis-Unterseitenschablone

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

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

Seiten-Metadaten:

Das Frontmatter oben auf der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend für das jeweilige 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 es als "NameOfTheParentInterface: NameOfTheEvent event". Zum Beispiel hat das animationcancel-Ereignis der Window-Schnittstelle einen title von Window: animationcancel event.

slug

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

page-type

Der page-type-Schlüssel 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 Elemente enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch anhand von 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.NameOfTheEvent_event durch den Abfragestring für das Ereignis im Browser compat data repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (und ersetzt die {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für das Ereignis in unserem Browser compat data repo erstellen/aktualisieren müssen, und dieser Eintrag muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden, wie man dies macht.

Makros oben auf der Seite

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (direkt unter dem Metadatenbereich der Seite).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit, sie hinzuzufügen oder 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 Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — dies erzeugt ein Veraltet-Banner, das anzeigt, dass die Nutzung der Technologie nicht empfohlen wird.
  • {{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äß dem unten stehenden Rat 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 dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn es so ist, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies erzeugt eine In Workers verfügbar-Notiz, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Fensterebene 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 aufgrund seiner Verfügbarkeit ein Parameter an den Makroaufruf übergeben (siehe {{AvailableInWorkers}} Makroquellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs, die in Workern verfügbar sind ausfüllen.
  • {{APIRef("GroupDataName")}} — dies erzeugt die linke Referenz-Seitenleiste, die Schnellzugrifflinks im Zusammenhang mit der aktuellen Seite anzeigt. Zum Beispiel hat jede Seite in der WebVR API dieselbe Seitenleiste, die auf die anderen Seiten der API verweist. Um die richtige Seitenleiste für Ihre API zu erzeugen, müssen Sie einen GroupData-Eintrag zu unserem GitHub-Repo hinzufügen und den Namen des Eintrags in den Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren API-Referenz-Seitenleisten Leitfaden für Informationen dazu, wie man dies macht.

Geben Sie keine Statuskopfzeilenmakros manuell an. Siehe den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele der Sicherer Kontext, In Workers verfügbar, Experimentell, Veraltet und Nicht-Standard Banner sind direkt nach diesem Notizblock gezeigt.

Link zum Elternelement

Fügen Sie einen Link zu dieser neuen Seite aus dem Events-Abschnitt des Elternelements hinzu. Zum Beispiel ist Element: wheel event vom Element Events verlinkt.

Wenn das Elternelement keinen Events-Abschnitt hat, fügen Sie einen hinzu. Wenn dies eine neue "Klasse" von Ereignis 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 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.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie mit der Benennung des Ereignisses, geben Sie an, zu welcher Schnittstelle es gehört und was es 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.

Syntax

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

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

onNameOfTheEvent = (event) => { }

Ereignistyp

Wenn das Ereignis einen speziellen Typ hat, erwähnen Sie ihn zusammen mit dessen 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

Eigenschaften des Ereignisses

Wenn das Ereignis nicht nur ein generisches Event ist, listen Sie die zusätzlichen Eigenschaften auf, die das Ereignis hat.

Zusätzlich zu den unten aufgeführten Eigenschaften sind Eigenschaften der übergeordneten Schnittstelle, Event, verfügbar.

session Schreibgeschützt

Die XRSession, auf die sich das Ereignis bezieht.

Beschreibung

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

Auslöser

und

Anwendungsfälle

enthalten, welche mehr Informationen bieten können.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, selbst 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 sein, was das Beispiel macht. Eine Überschrift wie "Ein einfaches Beispiel" sagt 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 zum Hinzufügen von Code-Beispielen für mehr Informationen.

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 ein und dann eine letzte H3-Überschrift (###) mit dem Text "Mehr Beispiele", unter denen Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwendung der fetch API

Beispiel von Fetch

### Mehr 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

Beziehen Sie Links zu Referenzseiten und Leitfäden ein, die mit der aktuellen API zusammenhängen. Für weitere Richtlinien siehe den Abschnitt Siehe auch im Stil-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