Häufig verwendete Makros

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

Siehe Andere Makros für Informationen über Makros, die selten verwendet werden, nur in speziellen Kontexten genutzt werden oder veraltet sind.

Verlinkung

MDN bietet eine Reihe von Link-Makros, 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 Sprachversionen wird er automatisch auf die richtige Version der Datei verlinken.

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

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

Verlinkung zu Seiten in Referenzen

Es gibt Makros für die sprachunabhängige Verlinkung zu Seiten in bestimmten Referenzbereichen von MDN: JavaScript, CSS, HTML-Elemente, SVG usw.

Die Makros sind einfach zu verwenden. Minimal müssen Sie nur den Namen des Elements, auf das Sie verlinken möchten, im ersten Argument angeben. Die meisten Makros erlauben auch ein zweites Argument, mit dem Sie den Anzeigetext ändern können (Dokumentation finden Sie in den Links in der äußersten linken Spalte unten).

Makro Verlinkt auf 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 Anzeigetext mit einem zweiten Parameter ändern: {{DOMxRef("document.getElementsByName()","getElementsByName()")}} ergibt [`getElementsByName()`](/de/docs/Web/API/Document/getElementsByName).
HTMLElement HTML Elements reference (/Web/HTML/Reference/Elements) {{HTMLElement("select")}} ergibt <select>
JSxRef JavaScript reference (/Web/JavaScript/Reference). {{JSxRef("Promise")}} ergibt Promise
SVGAttr SVG attribute reference (/Web/SVG/Reference/Attribute). {{SVGAttr("d")}} ergibt d
SVGElement SVG Element reference (/Web/SVG/Reference/Element). {{SVGElement("view")}} ergibt <view>
HTTPHeader HTTP headers (/Web/HTTP/Reference/Headers). {{HTTPHeader("ACCEPT")}} ergibt ACCEPT
HTTPMethod HTTP request methods (/Web/HTTP/Reference/Methods). {{HTTPMethod("HEAD")}} ergibt HEAD
HTTPStatus HTTP response status codes (/Web/HTTP/Reference/Status) {{HTTPStatus("404")}} ergibt 404

Previous, Next und PreviousNext bieten Navigationssteuerungen für Artikel, die Teil von Sequenzen sind. Für die einseitigen Vorlagen ist der einzige benötigte Parameter der Wiki-Standort des vorherigen oder nächsten Artikels in der Sequenz. 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 der API-Dokumentation verwendet, meist wenn die Liste der Eigenschaften eines Objekts oder die Parameter einer Funktion beschrieben werden.

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

isCustomObject Schreibgeschützt

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

parameterX Optional

Blah blah blah…

Status- und Kompatibilitätsindikatoren

Inline-Indikatoren ohne zusätzliche Parameter

Nicht-standardmäßig

Non-standard_Inline fügt einen Inline-Marker ein, der anzeigt, dass die API nicht standardisiert ist und sich nicht auf einer Standardstrecke befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Icon:

Experimentell

Experimental_Inline fügt einen Inline-Marker ein, der anzeigt, dass die API nicht weit verbreitet implementiert ist und sich in Zukunft ändern kann. Für weitere Informationen über die Definition experimentell siehe die Dokumentation Experimental, deprecated, and obsolete.

Syntax

{{Experimental_Inline}}

Beispiele
  • Icon:

Inline-Indikatoren, die die Technologie spezifizieren können

Veraltet

Deprecated_Inline fügt einen Inline-Marker für als veraltet markierte Funktionen ein ( ), um die Nutzung einer offiziell veralteten (oder entfernten) API zu entmutigen. Für weitere Informationen über die Definition veraltet siehe die Dokumentation Experimental, deprecated, and obsolete.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Icon:

Seiten- oder Abschnitts-Header-Indikatoren

Diese Vorlagen haben dieselbe Semantik wie ihre Inline-Gegenstücke, die oben beschrieben wurden. Die Vorlagen 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 kennzeichnen.

  • 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 verwendet auf Seiten, 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, 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.

Hinweis, dass eine Funktion in Web-Arbeitern verfügbar ist

Das AvailableInWorkers-Makro fügt eine lokalisierte Notiz ein, die anzeigt, 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}}

Erzeugt eine Kompatibilitätstabelle für das oder die in der Frontmatter durch browser-compat definierten Merkmale.

{{Specifications}}

Fügt eine Spezifikationstabelle für das oder die in der Frontmatter durch spec-urls definierten Merkmale ein, sofern vorhanden, oder aus der in den Browser-Kompatibilitätsdaten aufgeführten Spezifikation, die durch browser-compat in der Frontmatter definiert wurde.

Siehe auch