1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Verwendung von Makros
  5. Allgemein 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

Allgemein verwendete Makros

Diese Seite listet viele der universell einsetzbaren Makros auf, die das Build-System von MDN, 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 Anzahl von Link-Makros zur Vereinfachung der Erstellung von Links zu Glossareinträgen, Referenzseiten und anderen Themen.

Link-Makros werden gegenüber normalen 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 automatisch auf die richtige Version der Datei verlinkt.

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

Verlinkung 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 auf die Glossarseite für "HTML" zu verlinken, lautet das Makro {{Glossary("HTML")}}, 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 erzeugt.

Verlinkung zu Referenzseiten

Es gibt Makros für die lokalisierungsunabhängige Verlinkung 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 das 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 nachlesen 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 Headers (/Web/HTTP/Reference/Headers) {{HTTPHeader("ACCEPT")}} ergibt ACCEPT.
HTTPMethod HTTP-Anfragemethoden (/Web/HTTP/Reference/Methods) {{HTTPMethod("HEAD")}} ergibt HEAD.
HTTPStatus HTTP-Antwortstatus-Codes (/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. Bei den einseitigen Vorlagen ist nur der Slug des vorherigen oder nächsten Artikels in der Sequenz als Parameter erforderlich. 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 allgemeinem Formatierungszweck

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

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

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

isCustomObject Schreibgeschützt

zeigt an, ob das Objekt, wenn 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 standardisiert

Non-standard_Inline fügt eine Inline-Markierung hinzu, die angibt, dass die API nicht standardisiert und nicht auf einem Standardweg ist.

Syntax

{{Non-standard_Inline}}

Beispiele
  • Symbol:

Experimentell

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

Syntax

{{Experimental_Inline}}

Beispiele
  • Symbol:

Hinzufügen von Inline-Indikatoren mit Unterstützung zur Angabe der Technologie

Veraltet

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

Syntax

{{Deprecated_Inline}}

Beispiele
  • Symbol:

Seiten- oder Abschnittsheader-Indikatoren

Diese Vorlagen haben die gleiche Bedeutung wie ihre oben beschriebenen Inline-Gegenstücke. Die Vorlagen sollten direkt unter dem Hauptseitentitel (oder der Breadcrumb-Navigation, 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 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.

  • SecureContext_Header. Sollte auf Hauptseiten wie Schnittstellenseiten, API-Übersichtsseiten und API-Einstiegspunkte (z.B. navigator.xyz) verwendet werden, aber 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.

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

Das Makro AvailableInWorkers fügt eine lokalisierte Notizbox hinzu, die angibt, dass ein Merkmal im Worker-Kontext verfügbar ist. Sie können auch einige Argumente übergeben, um anzugeben, dass ein Merkmal im angegebenen Worker-Kontext funktioniert.

Syntax
{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}
Beispiele

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar, mit Ausnahme von Service Workers.

Verlinkung zu Browser-Kompatibilität und Spezifikation

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

{{Compat}}

Erstellt eine Kompatibilitätstabelle für das/die in der browser-compat des Frontmatters definierte(n) Merkmal(e).

{{Specifications}}

Enthält eine Spezifikationstabelle für das/die in der spec-urls des Frontmatters definierte(n) Merkmal(e), falls vorhanden, oder aus der Spezifikation, die in den in der browser-compat des Frontmatters definierten Browser-Kompatibilitätsdaten aufgeführt ist.

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