Allgemein genutzte Makros

Diese Seite listet viele der allgemein verwendbaren Makros auf, die für die Nutzung auf MDN erstellt wurden. Für allgemeine Anleitungen zur Nutzung dieser Makros in MDN-Inhalten siehe Makros verwenden.

Verlinkung

MDN bietet eine Reihe von Link-Makros an, um die Erstellung von Links zu Referenzseiten, Glossareinträgen und anderen Themen zu 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 Sprachvarianten wird automatisch auf die richtige Version der Datei verlinkt.

Das Glossary Makro erstellt einen Link zu einem bestimmten Begriffseintrag im MDN Glossar. Dieses Makro akzeptiert einen erforderlichen Parameter und einen optionalen Parameter:

  1. Der Name des Begriffs (zum Beispiel "HTML"): {{Glossary("HTML")}} ergibt HTML
  2. Optional: Der im Artikel angezeigte Text anstelle des Begriffnamens: {{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 benutzen. Minimal müssen Sie nur den Namen des Elements, zu dem Sie verlinken möchten, im ersten Argument angeben. Die meisten Makros akzeptieren auch ein zweites Argument, mit dem Sie den Anzeige-Text ändern können (Dokumentation dazu finden Sie unter den Links in der linken Spalte unten).

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

Previous, Next und PreviousNext bieten Navigationskontrollen für Artikel, die Teil einer Serie sind. Für die einseitigen Templates ist der einzige benötigte Parameter der Wiki-Standort des vorherigen oder nächsten Artikels in der Serie. Für PreviousNext sind die beiden benötigten Parameter die Wiki-Standorte der entsprechenden Artikel. Der erste Parameter ist für den vorherigen Artikel und der zweite für den nächsten Artikel.

Code-Beispiele

Live-Beispiele

Allgemeine Formatierung

Inline-Indikatoren für API-Dokumentation

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

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

isCustomObject Schreibgeschützt

Gibt an, wenn true, dass das Objekt ein benutzerdefiniertes ist.

parameterX Optional

Blah blah blah…

Status- und Kompatibilitätsindikatoren

Inline-Indikatoren ohne zusätzliche Parameter

Nicht-standardisiert

Non-standard_Inline fügt ein Inline-Zeichen ein, das anzeigt, dass die API nicht standardisiert ist und sich nicht auf einem Standardpfad befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Icon:

Experimentell

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

Syntax

{{Experimental_Inline}}

Beispiele
  • Icon:

Inline-Indikatoren, die die Angabe der Technologie unterstützen

Veraltet

Deprecated_Inline fügt ein Inline-Zeichen zu einem als veraltet markierten API ein ( ), um die Nutzung einer API zu entmutigen, die offiziell als veraltet (oder entfernt) eingestuft wurde. Für mehr Informationen zur Definition veraltet siehe die Experimentell, veraltet und obsolet Dokumentation.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Icon:

Seiten- oder Abschnittsheader-Indikatoren

Diese Templates haben die gleiche Semantik wie ihre Inline-Gegenstücke, die oben beschrieben wurden. Die Templates sollten direkt unter dem Hauptseitentitel (oder der Breadcrumb-Navigation, falls verfügbar) auf 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. 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.

  • SeeCompatTable wird auf Seiten verwendet, die experimentelle Features 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 Interface-Seiten, API-Übersichtsseiten und API-Einstiegspunkten (z. B. navigator.xyz) verwendet werden, aber normalerweise 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 ein Feature in Web Workern verfügbar ist

Das AvailableInWorkers Makro fügt eine lokalisierte Hinweisbox ein, die anzeigt, dass ein Feature in einem Worker-Kontext verfügbar ist. Sie können auch einige Argumente übergeben, um anzugeben, dass ein Feature in einem bestimmten Workerkontext 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 Spezifikations-Makros

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

{{Compat}}

Erstellt eine Kompatibilitätstabelle für das/die von browser-compat im Frontmatter definierte(n) Feature(s).

{{Specifications}}

Enthält eine Spezifikationstabelle für das/die von spec-urls im Frontmatter definierte(n) Feature(s), falls vorhanden, oder aus der Spezifikation, die in den Browser-Kompatibilitätsdaten aufgeführt ist, die durch browser-compat im Frontmatter definiert sind.

Siehe auch