Macros de liens

Listes de liens

MDN propose des macros qui créent une liste de liens :

{{SubpagesWithSummaries}} ^(angl.)

Insère une liste de définitions (<dl>) des sous-pages de la page courante, avec le titre de chaque page comme terme <dt> et son premier paragraphe comme terme <dd>.

{{ListSubpagesForSidebar()}} ^(angl.)

Sans paramètre, insère une liste ordonnée de liens vers les sous-pages de la page courante. Le premier paramètre est le slug de la page parente de l'arborescence. Le texte du lien est affiché comme code. Un second paramètre à true ou 1 convertit les liens en texte brut. Un troisième paramètre à true ou 1 ajoute un lien vers la page parente en haut de la liste avec « Aperçu » comme texte du lien.

{{QuickLinksWithSubpages()}} ^(angl.)

Crée un ensemble de liens rapides utilisant les enfants de la page courante (ou de la page spécifiée) comme destinations. Cela crée des listes hiérarchiques jusqu'à deux niveaux. Les titres des pages sont utilisés comme texte du lien et leurs résumés comme info-bulle.

Exemple de liste de liens

Pour inclure une liste ordonnée de liens qui inclut cette page et ses pages sœurs, écrivez :

{{ListSubpagesForSidebar("/fr/docs/MDN/Writing_guidelines/Page_structures/Macros", 1)}}

Liens de renvoi croisé

Certaines macros créent un lien unique pour référencer une fonctionnalité CSS, JavaScript, SVG ou HTML, y compris des attributs, éléments, propriétés, types de données et API. Les macros qui créent des liens uniques nécessitent au moins un paramètre : la fonctionnalité référencée.

Ces macros sont :

• {{CSSxRef("")}} ^(angl.)
• {{DOMxRef("")}} ^(angl.)
• {{HTMLElement("")}} ^(angl.)
• {{Glossary("")}} ^(angl.)
• {{JSxRef("")}} ^(angl.)
• {{SVGAttr("")}} ^(angl.)
• {{SVGElement("")}} ^(angl.)
• {{HTTPMethod("")}} ^(angl.)
• {{HTTPStatus("")}} ^(angl.)

Le premier paramètre de chaque macro est la dernière section du slug du document référencé. Par exemple, pour les éléments HTML, incluez {{HTMLElement("")}} avec la partie du slug qui suit Web/HTML/Reference/Elements/ comme premier paramètre. Avec {{CSSxRef("")}}, ajoutez la partie du slug qui suit Web/CSS/. Le lien pointera vers cette page.

Par défaut, le texte affiché est la ressource liée telle qu'écrite dans le premier paramètre, entre chevrons pour {{HTMLElement()}}. Ce n'est pas toujours ce que vous souhaitez. Par exemple, le slug pour le type d'entrée range est Web/HTML/Reference/Elements/input/range. Inclure {{HTMLElement("input/range")}} produit « <input/range> ». Ce n'est pas ce que vous voulez. Toutes les macros acceptent des paramètres supplémentaires, vous pouvez donc fournir le texte à afficher.

Le second paramètre, s'il est présent, fournit le texte du lien. Dans le cas de l'entrée range, on écrira {{HTMLElement("input/range", "<code>&lt;input type=&quot;range&quot;&gt;</code>")}} qui produit « <input type="range"> ». Cette macro retire le <code> et les chevrons si le second paramètre contient un espace, donc on ajoute les balises et chevrons.

Chaque macro est différente !

Pour éviter le rendu HTML ou le style code CSS, certaines macros de renvoi croisé acceptent un paramètre "nocode" pour désactiver ce style.

Par exemple, {{CSSxRef("background-color")}} crée le lien code « background-color » et {{DOMxRef("CSS.supports_static", "voir la prise en charge", "", "nocode")}} crée le lien texte « voir la prise en charge ».

Consultez le code source pour comprendre le fonctionnement de la macro utilisée et l'ordre des paramètres : même si la documentation est généralement complète, il existe des exceptions comme « ne pas afficher en code si le second paramètre contient un espace » pour {{HTMLElement("")}} qui n'est documentée que dans le code.

Pour connaître les paramètres de chaque macro et leur ordre, le fichier source de la macro (lien ci-dessus) inclut la documentation. Il existe une liste des macros courantes, qui produisent toutes des liens dans le contenu principal de la page.

Voir aussi

• Utiliser les macros
• Macros courantes, y compris les macros BCD ({{Compat}}) et les macros de spécification ({{Specifications}}).
• Guide des bannières et avis incluant les macros {{SeeCompatTable}}, {{Deprecated_Header}} et {{SecureContext_Header}}.