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 Anmerkung vor der Veröffentlichung.

Seitenfrontmatter:

Das Frontmatter oben auf der Seite wird verwendet, um "Seitenmetadaten" 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

Der Überschriftstitel, der oben auf der Seite angezeigt wird. Formatieren Sie dies 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 wie Web/API/NameOfTheParentInterface/NameOfTheEvent_event formatiert.

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 einen oder mehrere der folgenden Werte 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.NameOfTheEvent_event mit dem Abfragezeichenfolgewert für das Ereignis im Browser-Kompatibilitätsdaten-Repo. Die Toolchain verwendet automatisch den Schlüssel, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (Ersetzung der {{Compat}} und {{Specifications}} Makros).

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

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (direkt unter dem Seitenfrontmatter).

Diese Makros werden automatisch durch die Toolchain hinzugefügt (es ist nicht notwendig, etwas hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — generiert 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 ausfüllen.
  • {{Deprecated_Header}} — generiert ein Veraltet-Banner, das darauf hinweist, dass die Nutzung der Technologie unerwünscht ist.
  • {{Non-standard_Header}} — generiert ein Nicht standardisiert-Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

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

  • {{SecureContext_Header}} — generiert ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn dies der Fall ist, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — generiert einen Verfügbar in Workern Hinweis, der darauf hinweist, 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 verfügbar ist oder nur dort verfügbar ist, dann müssen Sie möglicherweise einen Parameter aufgrund seiner Verfügbarkeit ü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 Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — generiert die linke Referenz-Seitenleiste, die schnelle Referenzlinks zeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API dieselbe 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 in unser GitHub-Repo hinzufügen und den Namen des Eintrags innerhalb des Makroaufrufs anstelle von GroupDataName verwenden. Siehe unseren API-Referenz-Seitenleisten Leitfaden für Informationen, wie Sie dies tun können.

Geben Sie keine Statusheader-Makros manuell an. Verweisen Sie auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden" um diese Status auf der Seite hinzuzufügen.

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

Link zum übergeordneten Objekt

Fügen Sie einen Link zu dieser neuen Seite aus dem Events-Abschnitt des übergeordneten Objekts hinzu. Zum Beispiel wird Element: wheel event von den Element Events verlinkt.

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

Denken Sie daran, diese gesamte erklärende 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.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie damit, das Ereignis zu benennen, sagen Sie, zu welcher Schnittstelle es gehört, und sagen Sie, was es tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Sie könnten das meiste davon aus der Zusammenfassung der Eigenschaft auf der entsprechenden API-Referenzseite kopieren.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener(), oder legen Sie eine Event-Handler-Eigenschaft fest.

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

onNameOfTheEvent = (event) => { }

Ereignistyp

Wenn das Ereignis einen besonderen 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 weiteren 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 weitere 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. 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 Codebeispiele hinzufügt für weitere Informationen.

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

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

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

md
## Beispiele

### Die Fetch-API nutzen

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 ü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 Siehe auch Abschnitt im Leitfaden für Schreibstil.

  • link1
  • link2
  • externer_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