Link-Makros

MDN stellt Makros bereit, die eine Liste von Links erstellen:

{{SubpagesWithSummaries}}

Fügt eine Definitionsliste (<dl>) der Unterseiten der aktuellen Seite ein, wobei der Titel jeder Seite als <dt> Begriff und der erste Absatz als <dd> Begriff verwendet wird.

{{ListSubpagesForSidebar()}}

Wenn ohne Parameter eingebunden, wird eine geordnete Liste von Links zu den Unterseiten der aktuellen Seite eingefügt. Dieses Makro wird meist in Sidebars verwendet (daher der Makroname), wobei die Aufzählungszeichen nicht gerendert werden. Der erste Parameter ist ein Slug der übergeordneten Seite des Linkbaums. Der Linktext wird als Code angezeigt. Wenn ein zweiter Parameter auf true oder 1 gesetzt wird, werden die Links in normalen Text umgewandelt. Wird ein dritter Parameter auf true oder 1 gesetzt, wird oben in der Liste ein Link zur Slug-(übergeordneten) Seite mit "Übersicht" als Linktext hinzugefügt.

{{QuickLinksWithSubpages()}}

Erstellt ein Set von Schnelllinks, das die Kinder der aktuellen Seite (oder der angegebenen Seite) als Ziele verwendet. Dies erzeugt hierarchische Listen bis zu zwei Ebenen tief. Die Titel der Seiten werden als Linktext verwendet und ihre Zusammenfassungen als Tooltips.

Um eine geordnete Liste von Links zu erstellen, die diese Seite und ihre Geschwister umfasst, schreiben Sie folgendes:

{{ListSubpagesForSidebar("/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros", 1)}}

Einige Makros erstellen einen einzelnen Link, um auf eine CSS-, JavaScript-, SVG- oder HTML-Funktion, einschließlich Attribute, Elemente, Eigenschaften, Datentypen und APIs, zu verweisen. Die Makros, die einzelne Links erstellen, erfordern mindestens einen Parameter: die Funktion, auf die verwiesen wird.

Diese Makros sind:

• {{CSSxRef("")}}
• {{DOMxRef("")}}
• {{HTMLElement("")}}
• {{glossary("")}}
• {{JSxRef("")}}
• {{SVGAttr("")}}
• {{SVGElement("")}}
• {{HTTPMethod("")}}
• {{HTTPStatus("")}}

Der erste Parameter jedes dieser Makros ist der letzte Abschnitt des Slugs des referenzierten Dokuments. Zum Beispiel, für HTML-Elemente, fügen Sie {{HTMLElement("")}} mit dem Teil des Slugs ein, der nach Web/HTML/Element/ folgt und geben diesen als ersten Parameter an. Mit {{CSSxRef("")}}, fügen Sie den Teil des Slugs ein, der nach Web/CSS/ folgt. Der Link wird auf diese Seite verweisen.

Standardmäßig wird der Text, der angezeigt wird, als die verlinkte Ressource dargestellt, wie sie im ersten Parameter angegeben ist, in spitzen Klammern im Fall von {{HTMLElement()}}. Das ist möglicherweise nicht das gewünschte Ergebnis. Beispielsweise ist der Slug für den Bereichs-Input-Typ Web/HTML/Element/input/range. Die Einbindung von {{HTMLElement("input/range")}} ergibt "<input/range>". Das ist nicht das gewünschte Ergebnis. Alle Makros akzeptieren zusätzliche Parameter, sodass Sie den gewünschten Anzeigetext angeben können.

Der zweite Parameter, wenn vorhanden, stellt den Linktext bereit. Im Fall des Input-Bereichs würden wir {{HTMLElement("input/range", "<code>&lt;input type=&quot;range&quot;&gt;</code>")}} schreiben, was "<input type="range">" ergibt. Dieses spezielle Makro entfernt die <code>- und spitzen Klammern, wenn der zweite Parameter ein Leerzeichen enthält, daher haben wir die Klammern und Code-Tags hinzugefügt.

Jedes Makro ist anders!

Um HTML-Code-Semantik und CSS-Code-Styling zu verhindern, enthalten einige Querverweismakros einen Parameter mit dem "nocode", um dieses Styling zu deaktivieren.

Zum Beispiel erstellt {{CSSxRef("background-color")}} den Code-Link "background-color" und {{domxref("CSS.supports_static", "Unterstützung prüfen", "", "nocode")}} erstellt den normalen Text-Link "Unterstützung prüfen".

Stellen Sie sicher, dass Sie den Quellcode ansehen, um zu verstehen, wie das von Ihnen verwendete Makro funktioniert und um die verschiedenen Parameter zu verstehen; während die Parameter im Allgemeinen gut dokumentiert sind, gibt es Ausnahmen wie "nicht als Code rendern, wenn der zweite Parameter ein Leerzeichen enthält", die wir im {{HTMLElement("")}} Makro gesehen haben, die im Code aber sonst nicht dokumentiert sind.

Um zu erfahren, welche Parameter jedes Makro unterstützt und die Reihenfolge der Parameter für jedes Makro, enthält die oben verlinkte Makro-Quelldatei Dokumentation. Es gibt eine Liste häufig verwendeter Makros, von denen jedes Links im Hauptinhaltbereich der Seite erzeugt.

• Verwendung von Makros
• Häufig verwendete Makros, einschließlich BCD-Makros ({{Compat}}, {{Compat(<feature>)}}, und {{Compat(<feature>, <depth>)}}) und Spezifikationsmakros ({{Specifications}} / {{Specifications(<feature>)}})
• Leitfaden für Banner und Hinweise einschließlich der Makros {{SeeCompatTable}}, {{Deprecated_Header}}, und {{SecureContext_Header}}.