Allgemein verwendete Makros

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. Beispielsweise muss ein Glossar- oder Referenzlink, der mithilfe eines Makros erstellt wurde, nicht übersetzt werden: In anderen Sprachen wird er automatisch auf die korrekte Version der Datei verlinken.

Das Glossary-Makro erstellt einen Link zum Eintrag eines angegebenen Begriffs im MDN-Glossar. Dieses Makro akzeptiert einen erforderlichen und einen optionalen Parameter:

1. Der Name des Begriffs (zum Beispiel "HTML"): {{Glossary("HTML")}} ergibt HTML
2. Optional: Der anzuzeigende Text im Artikel anstelle des Begriffsnamens: {{Glossary("CSS", "Cascading Style Sheets")}} ergibt Cascading Style Sheets

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

Die Makros sind einfach zu verwenden. Minimal müssen Sie lediglich den Namen des Elements angeben, auf das verlinkt werden soll, als erstes Argument. Die meisten Makros akzeptieren auch ein zweites Argument, das Ihnen ermöglicht, den angezeigten Text zu ändern (Dokumentation dazu finden Sie in den Links in der linken Spalte unten).

Previous, Next und PreviousNext bieten Navigationssteuerungen 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 erforderlich. Für PreviousNext sind die beiden 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.

• EmbedLiveSample ermöglicht das Einbetten der Ausgabe eines Codebeispiels auf einer Seite, wie unter Live-Beispiele beschrieben.
• LiveSampleLink erstellt einen Link zu einer Seite, die die Ausgabe eines Codebeispiels enthält, wie unter Live-Beispiele beschrieben.
• EmbedGHLiveSample ermöglicht das Einbetten von Live-Beispielen von GitHub-Seiten. Weitere Informationen finden Sie unter GitHub Live-Beispiele.

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

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

isCustomObject Schreibgeschützt

Gibt an, ob true das Objekt ein benutzerdefiniertes ist.

parameterX Optional

Blah blah blah…

Nicht standardisiert

Non-standard_Inline fügt ein Inline-Zeichen ein, das anzeigt, dass die API nicht standardisiert ist und sich nicht auf dem Weg zur Standardisierung befindet.

Syntax

{{Non-standard_Inline}}

Beispiele

• Symbol: Nicht standardisiert

Experimentell

Experimental_Inline fügt ein Inline-Zeichen ein, das anzeigt, dass die API nicht weit verbreitet implementiert ist und sich in Zukunft ändern kann. Weitere Informationen zur Definition experimentell finden Sie in der Dokumentation Experimentell, veraltet und obsolet.

Syntax

{{Experimental_Inline}}

Beispiele

• Symbol: Experimentell

Veraltet

Deprecated_Inline fügt ein Inline-Zeichen für veraltet ein ( Veraltet ), um den Gebrauch einer offiziell veralteten (oder entfernten) API zu vermeiden. Weitere Informationen zur Definition veraltet finden Sie in der Dokumentation Experimentell, veraltet und obsolet.

Syntax

{{Deprecated_Inline}}

Beispiele

• Symbol: Veraltet

Diese Vorlagen haben dieselbe Semantik wie ihre oben beschriebenen Inline-Gegenstücke. Die Vorlagen sollten direkt unter dem Haupttitel der Seite (oder der Brotkrümelnavigation, falls verfügbar) 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, verwendet auf Seiten, 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. Soll auf Hauptseiten wie Interface-Seiten, API-Übersichtsseiten und API-Einstiegspunkten verwendet werden (z. B. navigator.xyz), 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.

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

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

Syntax

{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}

Beispiele

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

{{Compat}} / {{Compat(<feature>)}} / {{Compat(<feature>, <depth>)}}

Erzeugt eine Kompatibilitätstabelle für das übergebene Feature als Parameter. Wenn kein Parameter enthalten ist, wird auf die in der Frontmatter definierten Features zurückgegriffen, die durch browser-compat angegeben werden. Ein optionaler Tiefenparameter legt fest, wie tief untergeordnete Features zur Tabelle hinzugefügt werden sollen. Die Tiefe, wenn weggelassen, ist standardmäßig 1, was bedeutet, dass nur die erste Ebene der Unterfeature-Daten aus BCD in die Tabelle aufgenommen wird.

{{Specifications}} / {{Specifications(<feature>)}}

Beinhaltet die Spezifikation für das im Parameter angegebene Feature. Wenn kein Parameter übergeben wird, wird die Spezifikation auf Grundlage des Wertes für spec-urls in der Frontmatter aufgelistet, wenn vorhanden, oder aus der in den Browser-Kompatibilitätsdaten definierten Spezifikation, die durch browser-compat in der Frontmatter festgelegt wird. Die Spezifikation wird als externer Link angezeigt.

• Sidebar-Makros
• Seitentemplates
• Seitenkomponenten
• Feature-Status-Makros