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 verwendbaren Makros auf, die das MDN-Buildsystem rari für die Nutzung auf MDN bereitstellt. Für allgemeine Anleitungen zur Verwendung dieser Makros in MDN-Inhalten siehe Verwendung von Makros.

Verlinkung

MDN bietet eine Reihe von Linkmakros zur Erleichterung der Erstellung von Links zu Glossareinträgen, Referenzseiten und anderen Themen.

Linkmakros 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 Lokalen wird er automatisch zur korrekten Version der Datei verlinken.

Diese Makros werden auch ausführlicher auf der Seite Linkmakros behandelt.

Verlinkung zu Glossarbegriffen

Das Glossary-Makro erstellt einen Link zur Seite des angegebenen Begriffs im MDN Glossary. Dieses Makro akzeptiert einen erforderlichen Parameter und einen optionalen Parameter.

  • Der Begriff ist ein erforderlicher Parameter. Um zum Beispiel zur Glossarseite für "HTML" zu verlinken, wird das Makro {{Glossary("HTML")}} lauten, und dies wird den Link HTML erzeugen.
  • Der Anzeigetext ist ein optionaler Parameter. Beispielsweise können Sie den Link im vorherigen Beispiel als {{Glossary("HTML", "HyperText Markup Language")}} schreiben, was den Link HyperText Markup Language erzeugen wird.

Verlinkung zu Referenzseiten

Es gibt Makros für sprachunabhängige Verlinkungen zu Seiten in bestimmten Referenzbereichen von MDN, einschließlich HTML, CSS, JavaScript, SVG und HTTP.

Die Makros sind einfach zu verwenden. Alles, was Sie tun müssen, ist den Namen des zu verlinkenden Elements im ersten Parameter anzugeben. Ähnlich wie beim Glossarmakro akzeptieren die meisten Referenzmakros auch einen zweiten Parameter, um den Anzeigetext zu ändern.

Einzelheiten finden Sie in den verlinkten Quelldateien in der ersten Spalte der folgenden Tabelle.

Makro Links zu Seiten unter Beispiel
CSSxRef CSS-Referenz (/Web/CSS/Reference) {{CSSxRef("cursor")}} ergibt cursor.
{{CSSxRef(":hover")}} ergibt :hover.
{{CSSxRef("@media")}} ergibt @media.
{{CSSxRef("pow")}} ergibt pow().

Details finden Sie unter Verwendung von cssxref mit der CSS-Referenz
DOMxRef DOM-Referenz (/Web/API) {{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).
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-Anforderungsmethoden (/Web/HTTP/Reference/Methods) {{HTTPMethod("HEAD")}} ergibt HEAD.
HTTPStatus HTTP-Antwortstatuscodes (/Web/HTTP/Reference/Status) {{HTTPStatus("404")}} ergibt 404.

Hinzufügen von Navigationselementen für mehrseitige Leitfäden

Die Makros Previous, Next und PreviousNext bieten Navigationselemente für Artikel, die Teil einer Sequenz sind. Für die einseitigen Vorlagen ist der einzige benötigte Parameter der Slug des vorherigen oder nächsten Artikels in der Sequenz. Das Makro PreviousNext erfordert zwei Parameter: Der erste Parameter ist der Slug für den vorherigen Artikel, und der zweite ist der Slug für den nächsten Artikel.

Generierung von Codebeispielen

Live-Beispiele

Hinzufügen von allgemein verwendbaren Formatierungen

Hinzufügen von Inline-Indikatoren für API-Dokumentation

Optional_Inline und ReadOnlyInline werden in API-Dokumentationen verwendet, normalerweise bei der Beschreibung der Liste von Objekteigenschaften oder Funktionsparametern.

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

isCustomObject Schreibgeschützt

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

parameterX Optional

Gibt an…

Hinzufügen von Status- und Kompatibilitätsindikatoren

Hinzufügen von 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 Standardisierungsweg befindet.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Symbol:

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 Dokumentation zu Experimentell, veraltet und obsolet.

Syntax

{{Experimental_Inline}}

Beispiele
  • Symbol:

Hinzufügen von Inline-Indikatoren, die die Technologie angeben

Veraltet

Deprecated_Inline fügt ein Inline-Zeichen für veraltete APIs ein (), um die Verwendung einer offiziell veralteten (oder entfernten) API zu entmutigen. Für weitere Informationen zur Definition veraltet siehe die Dokumentation zu Experimentell, veraltet und obsolet.

Syntax

{{Deprecated_Inline}}

Beispiele
  • Symbol:

Kopfzeilen-Indikatoren für Seiten oder Abschnitte

Diese Vorlagen haben die gleiche Semantik wie ihre Inline-Gegenstücke, die oben beschrieben sind. Die Vorlagen sollten direkt unter dem Hauptseitentitel (oder der Breadcrumb-Navigation, falls verfügbar) in der Referenzseite platziert werden. Sie können auch verwendet werden, um einen Abschnitt auf einer Seite auszuzeichnen.

  • 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 Schnittstellenseiten, API-Übersichtsseiten und API-Einstiegspunkten (z.B. navigator.xyz) verwendet werden, aber normalerweise nicht auf Unterseiten wie Methoden- und Eigenschaften-Seiten. Beispiel: {{SecureContext_Header}}

    Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

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

Das Makro AvailableInWorkers 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 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.

Verlinkung zu 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 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, falls vorhanden, oder aus den in der Browser-Kompatibilitätsdaten definierten Spezifikationen durch browser-compat im Frontmatter festgelegt wurden.

Siehe auch

Help improve MDN

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden