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

Verlinken

MDN bietet eine Reihe von Link-Makros an, um das Erstellen von Links zu Glossareinträgen, Referenzseiten 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 korrekte Version der Datei verlinkt.

Diese Makros werden auch detaillierter auf der Seite Link-Makros behandelt.

Verlinken zu Glossarbegriffen

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

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

Verlinken zu Referenzseiten

Es gibt Makros für sprachunabhängiges Verlinken zu Seiten in spezifischen 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 als ersten Parameter anzugeben. Ähnlich wie beim Glossar-Makro akzeptieren die meisten Referenz-Makros auch einen zweiten Parameter, um Ihnen die Möglichkeit zu geben, den Anzeigetext zu ändern.

Details 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-Elemente-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.

Previous, Next und PreviousNext Makros bieten Navigationssteuerungen für Artikel, die Teil einer Sequenz sind. Für die einseitigen Vorlagen ist der einzige erforderliche Parameter der Slug des vorherigen oder nächsten Artikels in der Sequenz. Das PreviousNext Makro 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.

Generieren von Codebeispielen

Live-Beispiele

Hinzufügen von allgemeinen Formatierungen

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

Optional_Inline und ReadOnlyInline werden in API-Dokumentationen verwendet, normalerweise beim Beschreiben der Liste von Eigenschaften eines Objekts oder Parametern einer Funktion.

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

isCustomObject Schreibgeschützt

Zeigt an, ob das Objekt, falls true, ein benutzerdefiniertes ist.

parameterX Optional

Zeigt an…

Hinzufügen von Status- und Kompatibilitätsindikatoren

Hinzufügen von Inline-Indikatoren ohne zusätzliche Parameter

Nicht-Standard

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

Syntax

{{Non-standard_Inline}}

Beispiele
  • Icon:

Experimentell

Experimental_Inline fügt eine Inline-Markierung ein, die anzeigt, dass die API nicht weit verbreitet implementiert ist und sich in Zukunft ändern kann. Für weitere Informationen zur Definition experimentell siehe die Experimentell, veraltet und obsolet Dokumentation.

Syntax

{{Experimental_Inline}}

Beispiele
  • Icon:

Hinzufügen von Inline-Indikatoren, die die Angabe der Technologie unterstützen

Veraltet

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

Syntax

{{Deprecated_Inline}}

Beispiele
  • Icon:

Indikatoren für Seiten- oder Abschnittskopfzeilen

Diese Vorlagen haben die gleichen Bedeutungen 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 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, aber gewöhnlich 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 Webworkern verfügbar ist

Das AvailableInWorkers Makro fügt eine lokalisierte Hinweisbox ein, die 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.

Verlinken zu Browser-Kompatibilität und Spezifikation

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

{{Compat}}

Erstellt eine Kompatibilitätstabelle für das (die) Merkmal(e), die durch browser-compat im Frontmatter definiert sind.

{{Specifications}}

Enthält eine Spezifikationstabelle für das (die) Merkmal(e), die durch spec-urls im Frontmatter definiert sind, falls vorhanden, oder von der Spezifikation, die in den in browser-compat im Frontmatter definierten Kompatibilitätsdaten aufgeführt ist.

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