Häufig verwendete Makros

Diese Seite listet viele der allgemein verwendbaren Makros auf, die für die Verwendung auf MDN erstellt wurden. Für zusätzliche Anleitungen zur Verwendung dieser Makros, siehe Verwendung von Makros.

Siehe Andere Makros für Informationen über Makros, die selten verwendet werden, nur in speziellen Kontexten oder nicht mehr unterstützt werden.

Verlinkung

MDN bietet eine Reihe von Link-Makros, die das Erstellen von Links zu Referenzseiten, Glossareinträgen und anderen Themen erleichtern.

Link-Makros werden gegenüber normalen Markdown-Links empfohlen, da sie prägnant und übersetzungsfreundlich sind. Zum Beispiel muss ein Glossar- oder Referenzlink, der mit einem Makro erstellt wurde, nicht übersetzt werden: In anderen Lokalisierungen wird automatisch auf die richtige Version der Datei verlinkt.

Das Glossary-Makro erstellt einen Link zu einem angegebenen Glossarbegriff im MDN-Glossar. Dieses Makro akzeptiert einen Pflichtparameter und einen optionalen Parameter:

  1. Den Namen des Begriffs (wie "HTML"): {{Glossary("HTML")}} ergibt HTML
  2. Optional: Der Text, der im Artikel anstelle des Begriffsnamens angezeigt wird: {{Glossary("CSS", "Cascading Style Sheets")}} ergibt Cascading Style Sheets

Verlinkung zu Seiten in Referenzen

Es gibt Makros für sprachunabhängiges Verlinken zu Seiten in spezifischen Referenzbereichen von MDN: JavaScript, CSS, HTML-Elemente, SVG, usw.

Die Makros sind einfach zu verwenden. Im einfachsten Fall müssen Sie nur den Namen des Elements, zu dem verlinkt werden soll, im ersten Argument angeben. Die meisten Makros akzeptieren auch ein zweites Argument, das es Ihnen ermöglicht, den angezeigten Text zu ändern (Dokumentation finden Sie in den Links in der ganz linken Spalte unten).

Makro Verlinkt zu Seite unter Beispiel
CSSxRef CSS-Referenz (/Web/CSS/Reference) {{CSSxRef("cursor")}} ergibt cursor.
DOMxRef DOM-Referenz (/Web/API) {{DOMxRef("Document")}} oder {{DOMxRef("document")}} ergibt [`Document`](/de/docs/Web/API/Document),
{{DOMxRef("document.getElementsByName()")}} ergibt [`document.getElementsByName()`](/de/docs/Web/API/Document/getElementsByName)
{{DOMxRef("Node")}} ergibt [`Node`](/de/docs/Web/API/Node).
Sie können den angezeigten Text mit einem zweiten Parameter ändern: {{DOMxRef("document.getElementsByName()","getElementsByName()")}} ergibt [`getElementsByName()`](/de/docs/Web/API/Document/getElementsByName).
HTMLElement HTML-Elemente-Referenz (/Web/HTML/Element) {{HTMLElement("select")}} ergibt <select>
JSxRef JavaScript-Referenz (/Web/JavaScript/Reference). {{JSxRef("Promise")}} ergibt Promise
SVGAttr SVG-Attribut-Referenz (/Web/SVG/Attribute). {{SVGAttr("d")}} ergibt d
SVGElement SVG-Elemente-Referenz (/Web/SVG/Element). {{SVGElement("view")}} ergibt <view>
HTTPHeader HTTP-Header (/Web/HTTP/Headers). {{HTTPHeader("ACCEPT")}} ergibt ACCEPT
HTTPMethod HTTP-Anfragemethoden (/Web/HTTP/Methods). {{HTTPMethod("HEAD")}} ergibt HEAD
HTTPStatus HTTP-Antwortstatuscodes (/Web/HTTP/Status) {{HTTPStatus("404")}} ergibt 404

Previous, Next und PreviousNext bieten Navigationselemente für Artikel, die Teil von Sequenzen sind. Für die einseitigen Vorlagen ist nur der Wiki-Standort des vorherigen oder nächsten Artikels in der Sequenz als Parameter erforderlich. Für PreviousNext sind die zwei Parameter erforderlich, die die Wiki-Standorte der entsprechenden Artikel angeben. Der erste Parameter ist für den vorherigen Artikel, und der zweite ist für den nächsten Artikel.

Codebeispiele

Live-Beispiele

Allgemeine Formatierungen

Inline-Indikatoren für API-Dokumentationen

Optional_Inline und ReadOnlyInline werden in API-Dokumentationen verwendet, normalerweise bei der Beschreibung der Liste von Eigenschaften eines Objekts oder Parametern einer Funktion.

Verwendung: {{Optional_Inline}} oder {{ReadOnlyInline}}. Beispiel:

isCustomObject Schreibgeschützt

Gibt an, ob das Objekt, wenn true, benutzerdefiniert ist.

parameterX Optional

Blah blah blah…

Status- und Kompatibilitätsindikatoren

Inline-Indikatoren ohne zusätzliche Parameter

Nicht standardisiert

Non-standard_Inline fügt eine Inline-Markierung ein, die angibt, dass die API nicht standardisiert ist und sich nicht auf dem Standardisierungspfad befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Icon:

Experimentell

Experimental_Inline fügt eine Inline-Markierung ein, die angibt, dass die API nicht weit verbreitet implementiert ist und sich in Zukunft ändern könnte. Für weitere Informationen zur Definition von experimentell siehe die Experimentell, veraltet und obsolet Dokumentation.

Syntax

{{Experimental_Inline}}

Beispiele
  • Icon:

Inline-Indikatoren, die das Angeben der Technologie unterstützen

Veraltet

Deprecated_Inline fügt eine Inline-Markierung ein, die darauf hinweist, dass die API offiziell veraltet ist oder entfernt wurde, um die Verwendung zu entmutigen. Für weitere Informationen zur Definition von veraltet siehe die Experimentell, veraltet und obsolet Dokumentation.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Icon:

Kopfzeilenindikatoren für Seite oder Abschnitt

Diese Vorlagen haben die gleichen Semantiken wie ihre Inline-Gegenstücke, die oben beschrieben wurden. Die Vorlagen sollten direkt unter dem Hauptseitentitel (oder der Breadcrumb-Navigation, falls vorhanden) in der Referenzseite platziert werden. Sie können auch verwendet werden, um einen Abschnitt auf einer Seite zu markieren.

  • Non-standard_Header: {{Non-standard_Header}}

    Nicht standardisiert: Diese Funktion ist nicht standardisiert und befindet sich nicht auf dem Weg zur Standardisierung. Verwenden Sie sie nicht auf Produktionsseiten, die dem Web ausgesetzt sind: Sie funktioniert nicht für alle Benutzer. Es kann auch große Inkompatibilitäten zwischen Implementierungen geben, und das Verhalten kann sich in Zukunft ändern.

  • SeeCompatTable wird auf Seiten verwendet, die experimentelle Funktionen dokumentieren. Beispiel: {{SeeCompatTable}}

    Experimentell: Dies ist eine experimentelle Technologie
    Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

  • Deprecated_Header: {{Deprecated_Header}}

    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.

  • SecureContext_Header. Sollte auf Hauptseiten wie Schnittstellenseiten, API-Übersichtsseiten und API-Einstiegspunkten (z.B. navigator.xyz) verwendet werden, normalerweise aber nicht auf Unterseiten wie Methoden- und Eigenschaftsseiten. Beispiel: {{SecureContext_Header}}

    Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Anzeige, dass eine Funktion in Web-Workern verfügbar ist

Das AvailableInWorkers-Makro fügt eine lokalisierte Hinweisbox ein, die angibt, dass eine Funktion in einem Worker-Kontext verfügbar ist. Sie können auch einige Argumente übergeben, um anzugeben, dass eine Funktion in einem bestimmten Worker-Kontext funktioniert.

Syntax
{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}
Beispiele

Hinweis: Diese Funktion ist in Web Workers verfügbar, mit Ausnahme von Service Workers.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Browser-Kompatibilität und Spezifikationsmakros

Die folgenden Makros sind auf allen Referenzseiten enthalten, werden aber auch von allen Seitentypen unterstützt:

{{Compat}} / {{Compat(&lt;feature>)}} / {{Compat(&lt;feature>, &lt;depth>)}}

Generiert eine Kompatibilitätstabelle für das Feature, das als Parameter übergeben wird. Wenn kein Parameter enthalten ist, wird standardmäßig auf die Funktionen verwiesen, die durch browser-compat in der Frontmatter definiert sind. Ein optionaler Tiefenparameter legt fest, wie tief die Unterfunktionen in die Tabelle aufgenommen werden sollen. Die Tiefe, falls nicht angegeben, ist standardmäßig auf 1 gesetzt, was bedeutet, dass nur die erste Ebene der Unterfunktionsdaten aus BCD in die Tabelle aufgenommen wird.

{{Specifications}} / {{Specifications(&lt;feature>)}}

Beinhaltet die Spezifikation für das im Parameter angegebene Feature. Wenn kein Parameter übergeben wird, wird die aufgelistete Spezifikation durch den Wert für spec-urls in der Frontmatter definiert, falls vorhanden, oder aus der in den Browser-Kompatibilitätsdaten durch browser-compat in der Frontmatter definierten Spezifikation. Die Spezifikation wird als externer Link dargestellt.

Siehe auch