HTML-Element-Seitenvorlage
Note: Entfernen Sie diese gesamte erklärende Notiz vor der Veröffentlichung
Seiten-Frontmatter:
Der Frontmatter-Abschnitt oben auf der Seite wird verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend für das jeweilige Element aktualisiert werden.
md--- title: "<NameOfTheElement>: Das NameOfTheElement-Element" slug: Web/HTML/Element/NameOfTheElement page-type: html-element status: - experimental - deprecated - non-standard browser-compat: html.elements.NameOfTheElement ---
- title
Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie sie als
'<NameOfTheElement>: Beschreibung des Zwecks des Elements'
. Zum Beispiel hat das<video>
Element einen title von: '<video>
: Das Videoeinbettungs-Element'.- slug
Das Ende des URL-Pfads nach
https://developer.mozilla.org/de/docs/
. Dies wird formatiert wieWeb/HTML/Element/NameOfTheElement
, wobei der Elementname in Kleinbuchstaben gehalten wird. Zum Beispiel hat das<video>
Element einen slug vonWeb/HTML/Element/video
.- page-type
Immer
html-element
.- 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 "Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status".- browser-compat
Ersetzen Sie den Platzhalterwert
html.elements.NameOfTheElement
durch den Abfrage-String für das Element im Browser-Kompatibilitätsdaten-Repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (Ersetzen der{{Compat}}
und{{Specifications}}
Makros).Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für das Element in unserem Browser-Kompatibilitätsdaten-Repo erstellen/aktualisieren müssen, und der Eintrag muss Spezifikationsinformationen enthalten. Siehe unser Leitfaden dazu.
Macros oben auf der Seite
Eine Anzahl von Macro-Aufrufen erscheint am Anfang des Inhaltsabschnitts (direkt unter dem Seiten-Frontmatter). Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit hinzuzufügen/zu 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 ausfüllen.{{Deprecated_Header}}
— Dies erzeugt ein Veraltet-Banner, das anzeigt, dass die Nutzung der Technologie nicht empfohlen ist.{{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äß der untenstehenden Ratschläge aktualisieren oder löschen:
{{SecureContext_Header}}
— Dies erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn nicht, können Sie den Macro-Aufruf entfernen. Wenn ja, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.{{HTMLSidebar}}
— Dies erzeugt die linke Seitenleiste für das Element. Der Inhalt der Seitenleiste hängt von den Tags in den Seitenmetadaten ab.- Denken Sie daran, das Macro
{{MDNSidebar}}
zu entfernen, wenn Sie diese Seite kopieren.Man sollte keine Status-Header-Makros manuell bereitstellen. Um diese Status zur Seite hinzuzufügen, lesen Sie die Sektion "Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status".
Beispiele der 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
Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.
Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, kann sie bereits aus den relevanten Webstandards entfernt worden sein, befindet sich im Prozess der Entfernung oder wird nur aus Kompatibilitätsgründen beibehalten. Vermeiden Sie die Verwendung und aktualisieren Sie gegebenenfalls bestehenden Code; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu treffen. Beachten Sie, dass diese Funktion jederzeit nicht mehr funktionieren kann.
Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.
Das <insert_the_element_name>
HTML Element macht (fügen Sie einen zusammenfassenden Absatz ein, der das Element benennt und beschreibt, was es tut, idealerweise ein oder zwei kurze Sätze).
{{EmbedInteractiveExample("pages/tabbed/nameOfElement.html", "tabbed-standard")}}
Weitere Informationen — an diesem Punkt sollten Sie einige weitere Absätze hinzufügen, die die wichtigsten Dinge erklären, die Sie über die Verwendung des Elements und seiner Hauptmerkmale wissen müssen. Es ist gut, kurz zu erklären, was in dem interaktiven Beispiel geschieht, wenn es nicht sofort offensichtlich ist. Sie könnten auch wichtige Punkte darüber erklären, wie dieses Element mit wichtigen verwandten JavaScript- oder CSS-Funktionen interagiert. Nicht zu viele Details — Sie möchten die Dokumentation über Seiten hinweg nicht wiederholen — aber ein wichtiger Punkt plus ein Link zur Seite dieser Funktion wäre nützlich. Siehe die <video>
Seite als Beispiel.
Attribute
Dieses Element schließt die globalen Attribute ein.
attribute1
Veraltet Experimentell-
Fügen Sie hier eine Beschreibung ein, was das Attribut tut. Fügen Sie einen Begriff und eine Definition für jedes Attribut ein. Wenn das Attribut nicht experimentell/veraltet ist, entfernen Sie die entsprechenden Macro-Aufrufe.
attribute2
-
etc.
Ereignisse
Fügen Sie eine Tabelle der Ereignisse ein, die bei diesem Elementtypen ausgelöst werden, wenn vorhanden.
Ereignisname | Wird ausgelöst, wenn |
---|---|
Ereignis 1 | Erklären Sie kurz, wann es ausgelöst wird |
Ereignis 2 | Erklären Sie kurz, wann es ausgelöst wird |
etc. |
Barrierefreiheit
Warnen Sie vor potenziellen Barrierefreiheitsbedenken, die bei der Verwendung dieses Elements bestehen, und wie sie umgangen werden können. Entfernen Sie diesen Abschnitt, wenn es keine zu erwähnen gibt.
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 beschreibend sein, 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 zum Hinzufügen von Code-Beispielen 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 eine H3-Überschrift (###
) für jedes Beispiel auf dieser Seite hinzu und dann eine abschließende H3-Überschrift (###
) mit dem Text "Weitere Beispiele", unter dem Sie die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:
## 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:
## Beispiele
Für Beispiele zu dieser API, siehe [die Seite zu fetch()](https://example.org/).
Technische Zusammenfassung
Inhaltskategorien | Füllen Sie eine Liste der Inhaltskategorien aus, zu denen das HTML-Element gehört. |
---|---|
Erlaubter Inhalt | Welchen Inhalt darf das Element enthalten? |
Tag-Auslassung | Kann das End-Tag weggelassen werden, oder muss es vorhanden sein? Muss es weggelassen werden? |
Erlaubte Eltern | Welche Elternelemente können das Element als Kind haben? Zum Beispiel "Jedes Element, das Fließinhalte akzeptiert." |
Erlaubte ARIA-Rollen |
Füllen Sie eine Liste der ARIA-Rollen aus, die auf dem Element gesetzt werden können; zum Beispiel
directory .
|
DOM-Schnittstelle | Welche DOM-Schnittstelle repräsentiert das Element in JavaScript? Zum Beispiel [`HTMLOListElement`](/de/docs/Web/API/HTMLOListElement) im Fall von ol. |
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 das aktuelle Element beziehen. Für weitere Richtlinien siehe den Siehe auch Abschnitt im Schreibstil-Leitfaden.
- link1
- link2
- external_link (Jahr)