ARIA-Seitenschablone
Seiten-Metadaten
Seiten-Metadaten werden in Front-Matter beschrieben, wie im folgenden Beispiel:
---
title: aria-labelledby
slug: Web/Accessibility/ARIA/Reference/Attributes/aria-labelledby
page-type: aria-attribute
spec-urls: https://w3c.github.io/aria/#aria-labelledby
sidebar: accessibilitysidebar
---
Titel und Slug
Eine ARIA-Rollen-Seite sollte einen Titel und Slug von ARIA: Name Der Rolle haben. Zum Beispiel hat die Rolle der Schaltfläche einen Titel und Slug von ARIA/NameDerRolle_role und das Attribut aria-labelledby hat einen Titel von aria-labelledby.
Seitenleiste
Die accessibilitysidebar kann auf allen Seiten unter /Web/Accessibility verwendet werden:
sidebar: accessibilitysidebar
Details finden Sie unter Seitenstrukturen: Seitenleisten.
Obere Makros
Eine Reihe von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts. Sie sollten diese gemäß der unten stehenden Hinweise aktualisieren oder löschen.
Status
Fügen Sie keine Statusschlüssel manuell hinzu oder bearbeiten Sie diese. Um den (entsprechenden) Funktionsstatusschlüssel einzuschließen — experimentell, veraltet, oder nicht-standardisiert — siehe den Abschnitt "Wie Funktionsstatus hinzugefügt oder aktualisiert werden".
Spezifikationen
Im Wert des spec-urls Front-Matter Metadatenschlüssels, aktualisieren Sie die URLs, um auf die Fragment-IDs für die korrekten Abschnitte aus den folgenden Spezifikationen zu verweisen:
Zusätzliche Ressourcen:
Seitenschablone
Der Zusammenfassungsabsatz—beginnen Sie mit der Benennung der Rolle oder des Attributs und beschreiben Sie, was es tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Dieser Inhalt erscheint als Tooltip auf Links zu dieser Seite, daher sollte er gut formuliert sein.
<!-- Insert code block showing common use cases -->
(Optional) Fügen Sie eine kurze Beschreibung des vorherigen Beispiels hinzu.
Beschreibung
Fügen Sie eine vollständige Beschreibung des Attributs oder der Rolle ein.
Zugehörige ARIA-Rollen, Zustände und Eigenschaften
- Name der zugehörigen Rollen
-
Erklärung der Anforderung, Link zu Funktionsseiten.
- Name des/der zugehörigen Attribute(s)
-
Erklärung der Anforderung, Link zu den Attributseiten, zusammen mit einem Link zu dem erforderlichen JS, um den Wert zu ändern, falls zutreffend.
Tastaturinteraktionen
Erforderliche JavaScript-Features
- Erforderliche Ereignishandler
-
Erklärung jedes einzelnen
- Ändern von Attributwerten
-
Erklärung jedes einzelnen
Hinweis: Fügen Sie eine Hinweis zu semantischen Alternativen zur Verwendung dieser Rolle oder dieses Attributs hinzu. Die erste Regel der ARIA-Verwendung ist, dass, wenn Sie eine native Funktion mit der Semantik und dem Verhalten verwenden können, die Sie benötigen und die bereits integriert ist, anstatt ein Element neu zu nutzen und eine ARIA-Rolle, einen Zustand oder eine Eigenschaft hinzuzufügen, um es zugänglich zu machen, dann tun Sie dies. Veröffentlichen Sie dann die vollständigen Details im Best-Practices-Abschnitt unten.
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 verweisen, die auf einer anderen Seite gegeben sind.
Szenario 1: Wenn Sie einige Beispiele auf dieser Seite haben und einige weitere Beispiele auf einer anderen Seite:
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 der Sie Links zu den Beispielen auf anderen Seiten hinzufügen können. Zum Beispiel:
## Beispiele
### Verwenden der Fetch API
Beispiel des 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 einfach direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:
## Beispiele
Für Beispiele dieser API, siehe [die Seite über fetch()](https://example.org/).
Barrierefreiheitsbedenken
Optional warnen Sie vor etwaigen potenziellen Barrierefreiheitsproblemen, die mit der Verwendung dieser Eigenschaft bestehen, und wie man sie umgeht. Entfernen Sie diesen Abschnitt, wenn es keine gibt.
Best Practices
Optional listen Sie alle Best Practices auf, die für diese Rolle existieren. Entfernen Sie den Abschnitt, wenn keine existieren.
Zusätzliche Vorteile
- Zugehörige Rolle
-
Wenn diese Rolle ein erforderlicher Elternteil, ein Kind oder ein Geschwister ist und was sie tut.
Zusätzliche Vorteile, die diese Funktion für nicht typische Bildschirmleserbenutzer hat, wie Google oder mobiles Sprachverständnis.
Spezifikationen
{{Specifications}}
Denken Sie daran, die Backticks und den Backslash zu entfernen, um dieses Makro zu verwenden.
Vorrangordnung
Welche verwandten Eigenschaften bestehen, und in welcher Reihenfolge wird dieses Attribut oder diese Eigenschaft gelesen (welche Eigenschaft wird Vorrang vor dieser haben, und welche Eigenschaft wird überschrieben).
Bildschirmleserunterstützung
Siehe auch
Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die sich auf die aktuelle Rolle oder das Attribut beziehen. Für weitere Richtlinien, siehe den Abschnitt Siehe auch im Schreibstil-Leitfaden.
- link1
- link2