Häufig verwendete Makros

Diese Seite listet viele der universell einsetzbaren Makros auf, die für die Verwendung auf MDN erstellt wurden. Weitere Anleitung zur Verwendung dieser Makros finden Sie unter Makros verwenden.

Informationen zu Makros, die selten verwendet werden, nur in speziellen Kontexten verwendet werden oder veraltet sind, finden Sie unter Andere Makros.

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 über normale Markdown-Links empfohlen, da sie prägnant und übersetzungsfreundlich sind. Zum Beispiel muss ein mit einem Makro erstellter Glossar- oder Referenzlink nicht übersetzt werden: In anderen Sprachversionen wird er automatisch auf die korrekte 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. Der Name des Begriffs (z.B. "HTML"): {{Glossary("HTML")}} ergibt HTML
  2. Optional: Der Text, der im Artikel statt des Begriffsnamens angezeigt werden soll: {{Glossary("CSS", "Cascading Style Sheets")}} ergibt Cascading Style Sheets

Verlinkung zu Seiten in Referenzen

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

Die Makros sind einfach zu verwenden. Sie müssen lediglich den Namen des Elements im ersten Argument angeben, zu dem Sie verlinken möchten. Die meisten Makros akzeptieren auch ein zweites Argument, mit dem Sie den Anzeigetext ändern können (die Dokumentation kann in den Links in der linken Spalte unten gefunden werden).

Makro Links zur 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 Anzeigetext 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/Reference/Attribute). {{SVGAttr("d")}} ergibt d
SVGElement SVG-Element-Referenz (/Web/SVG/Reference/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-Antwortstatus-Codes (/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 Templates ist der einzige benötigte Parameter der Wiki-Standort des vorherigen oder nächsten Artikels in der Sequenz. Für PreviousNext werden zwei Parameter benötigt, die die Wiki-Standorte der entsprechenden Artikel angeben. 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 Eigenschaftsliste 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 eine Inline-Markierung ein, die darauf hinweist, dass die API nicht standardisiert ist und sich nicht auf einem Standardisierungsweg befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Icon:

Experimentell

Experimental_Inline fügt eine Inline-Markierung ein, die darauf hinweist, 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 die Angabe der Technologie unterstützen

Veraltet

Deprecated_Inline fügt eine Inline-Markierung ( ) ein, die von der Verwendung einer offiziell veralteten (oder entfernten) API abrät. Für weitere Informationen zur Definition von veraltet, siehe die experimentell, veraltet und obsolet Dokumentation.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Icon:

Seiten- oder Abschnittsheaderindikatoren

Diese Vorlagen haben die gleiche Semantik wie ihre oben beschriebenen Inline-Entsprechungen. Die Vorlagen sollten direkt unter dem Hauptseitentitel (oder 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 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. Soll auf Hauptseiten wie Schnittstellen-Seiten, API-Übersichtsseiten und API-Einstiegspunkte (z. B. navigator.xyz) verwendet werden, jedoch 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 eine Funktion in Web-Workern verfügbar ist

Das AvailableInWorkers Makro fügt ein lokalisiertes Hinweisfeld ein, das anzeigt, dass eine Funktion in einem Worker-Kontext verfügbar ist. Sie können auch einige Argumente übergeben, um anzuzeigen, 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.

Makros für Browser-Kompatibilität und Spezifikationen

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

{{Compat}}

Erstellt eine Kompatibilitätstabelle für die im Frontmatter durch browser-compat definierten Funktion(en).

{{Specifications}}

Beinhaltet eine Spezifikationstabelle für die im Frontmatter durch spec-urls definierten Funktion(en), falls vorhanden, oder aus der in den Daten zur Browser-Kompatibilität durch browser-compat im Frontmatter definierten Spezifikation.

Siehe auch