1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Verwendung von Makros
  5. Häufig verwendete Makros

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

Häufig verwendete Makros

Diese Seite listet viele der allgemein verwendeten Makros auf, die für den Einsatz auf MDN erstellt wurden. Für allgemeine Anleitungen zur Verwendung von Makros in MDN-Inhalten, siehe Makros verwenden.

Verlinkung

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

Das Glossary Makro erstellt einen Link zu einem bestimmten Begriff im MDN Glossar. Dieses Makro akzeptiert ein erforderliches und ein optionales Argument:

  1. Der Name des Begriffs (z. B. "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 auf Seiten in Referenzen

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

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

Makro Links 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 Anzeigetext 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-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/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 Navigationselemente für Artikel, die Teil von Sequenzen sind. Für die Templates, die nur eine Richtung unterstützen, ist der einzige erforderliche Parameter der Wiki-Standort des vorherigen oder nächsten Artikels in der Sequenz. Für PreviousNext sind die beiden erforderlichen 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

Allzweckformatierung

Inline-Indikatoren für API-Dokumentation

Optional_Inline und ReadOnlyInline werden in API-Dokumentationen verwendet, in der Regel wenn die Liste von Eigenschaften eines Objekts oder die Parameter einer Funktion beschrieben werden.

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

isCustomObject Schreibgeschützt

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

parameterX Optional

Zeigt an…

Status- und Kompatibilitätsindikatoren

Inline-Indikatoren ohne zusätzliche Parameter

Nicht standardisiert

Non-standard_Inline fügt eine Inline-Markierung ein, die anzeigt, dass die API nicht standardisiert ist und sich nicht auf einem Standardtrack befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Symbol:

Experimentell

Experimental_Inline fügt eine Inline-Markierung ein, die 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
  • Symbol:

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

Veraltet

Deprecated_Inline fügt eine Inline-Markierung ( ) ein, um die Verwendung einer API zu entmutigen, die offiziell als veraltet gilt (oder entfernt wurde). Für weitere Informationen zur Definition veraltet, siehe die Experimentell, veraltet, und obsolet Dokumentation.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Symbol:

Seiten- oder Abschnitts-Headerindikatoren

Diese Templates haben dieselbe Semantik wie ihre Inline-Gegenstücke, die oben beschrieben wurden. Die Templates sollten direkt unter dem Hauptseitentitel (oder der Brotkrümelnavigation, falls vorhanden) 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 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 jedoch 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.

Angabe, dass ein Feature in Web-Workern verfügbar ist

Das AvailableInWorkers Makro fügt ein lokalisiertes Hinweisfeld ein, das angibt, 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 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 aber auch von allen Seitentypen unterstützt:

{{Compat}}

Generiert eine Kompatibilitätstabelle für die Funktion(en), die durch browser-compat im Frontmatter definiert sind.

{{Specifications}}

Schließt eine Spezifikationstabelle für die Funktion(en) ein, die durch spec-urls im Frontmatter definiert sind, falls vorhanden, oder aus der Spezifikation, die in den Browser-Kompatibilitätsdaten definiert ist durch browser-compat im Frontmatter.

Siehe auch

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden