---
title: Commonly-used macros
slug: MDN/Structures/Macros/Commonly-used_macros
translation_of: MDN/Structures/Macros/Commonly-used_macros
---
<div>{{MDNSidebar}}</div>

<p><span class="seoSummary">Cette page présente un grand nombre de macros à usage général créées pour une utilisation avec MDN. Pour avoir des informations sur l'utilisation de ces macros, voir <a href="https://developer.mozilla.org/fr/docs/MDN/Contribute/Structures/Macros" title="/fr/docs/MDN/Contribute/Content/Macros"> Utilisation des macros </a> et <a href="/fr/docs/MDN/Contribute/Editor/Links#Using_link_macros" title="/fr/docs/MDN/Contribute/Editor/Links#Using_link_macros"> Utiliser les liens macros </a>.</span> Voir <a href="/fr/docs/MDN/Contribute/Structures/Macros/Other" title="/fr/docs/MDN/Contribute/Structures/Macros/Other"> les autres macros </a> pour avoir des informations sur les macros qui sont rarement utilisées, ou utilisées dans des contextes spécifiques, ou obsolètes. Il y a aussi une liste complète de <a href="/fr/docs/templates" title="/fr/docs/templates">toutes les macros MDN</a>.</p>

<p>Voir aussi le<a href="/fr/docs/MDN/Contribute/Guidelines/CSS_style_guide" title="/fr/docs/MDN/Contribute/Guidelines/CSS_style_guide"> Guide style CSS </a> pour l'utilisation des styles disponibles.</p>

<h2 id="Linking">Linking</h2>

<h3 id="Création_dun_lien_hypertexte_unique">Création d'un lien hypertexte unique</h3>

<p id="To_another_MDN_page_or_its_section_(anch_SectionOnPage_manch_Link_LinkItem_LinkItemDL)">En général, vous ne devez pas utiliser des macros pour créer des liens arbitraires. Utilisez le <strong> Lien </strong> dans l'interface de l'éditeur pour créer des liens.</p>

<ul>
 <li>La macro {{TemplateLink("Glossary")}} crée un lien vers une entrée du<a href="https://developer.mozilla.org/fr/docs/Glossaire"> glossaire</a> MDN. Cette macro accepte un paramètre obligatoire et deux optionnels:

  <ol>
   <li>Le nom d'un terme (comme "HTML").</li>
   <li>Le texte à afficher dans l'article au lieu du nom du terme (ce qui devrait être rarement utilisé). {{optional_inline}}</li>
   <li>Si ce paramètre est spécifié et est non nul, le style personnalisé normalement appliqué aux liens glossaire n'est pas appliquée. {{optional_inline}}</li>
  </ol>

  <p>Examples:</p>

  <ul>
   <li>\{{Glossary("HTML")}} yields {{Glossary("HTML")}}</li>
   <li>\{{Glossary("CSS", "Cascading Style Sheets")}} yields {{Glossary("CSS", "Cascading Style Sheets")}}</li>
   <li>\{{Glossary("HTML", "", 1)}} yields {{Glossary("HTML", "", 1)}}</li>
  </ul>
 </li>
</ul>

<h3 id="Liens_vers_des_pages_avec_références">Liens vers des pages avec références</h3>

<p>Il existe différentes macros pour des liens vers des pages dans les zones de référence spécifiques MDN.</p>

<ul>
 <li>{{TemplateLink("cssxref")}} links to a page in the <a href="/en-US/docs/CSS_Reference" title="en-US/docs/CSS_Reference">CSS Reference</a>. Example: <code>\{{cssxref("cursor")}}</code>, results in: {{ cssxref("cursor") }}.</li>
 <li>{{TemplateLink("domxref")}} links to pages in the DOM reference; if you include parentheses at the end, the template knows to display the link to look like a function name. For example, <span class="plain"><span class="nowiki">\{{domxref("document.getElementsByName()")}}</span></span> results in {{ domxref("document.getElementsByName()") }} while <code>\{\{domxref("Node")\}\}</code> results in {{ domxref("Node") }}.</li>
 <li>{{TemplateLink("event")}} links to pages in the DOM Event reference, for example: \{{event("change")}} results in {{event("change")}}.</li>
 <li>{{TemplateLink("HTMLElement")}} links to an HTML element in the HTML Reference.</li>
 <li>{{TemplateLink("htmlattrxref")}} links to an HTML attribute, either a global attribute description if you only specify the attribute name or an attribute associated with a specific element if you specify an attribute name and an element name. For example, <code>\{\{htmlattrxref("lang")\}\} </code>will create this link: {{htmlattrxref("lang")}}.<code> </code> <code>\{\{htmlattrxref("type","input")\}\}</code> will create this link: {{htmlattrxref("type","input")}}.</li>
 <li>{{TemplateLink("jsxref")}} links to a page in the <a href="/en-US/docs/Web/JavaScript/Reference" title="en-US/docs/Web/JavaScript/Reference">JavaScript Reference</a>.</li>
 <li>{{TemplateLink("SVGAttr")}} links to a specific SVG attribute. For example, <code>\{\{SVGAttr("d")\}\}</code> creates this link: {{SVGAttr("d")}}.</li>
 <li>{{TemplateLink("SVGElement")}} links to an SVG element in the SVG Reference.</li>
</ul>

<h3 id="Liens_vers_des_bugs_et_des_IRC">Liens vers des bugs et des <a href="https://fr.wikipedia.org/wiki/Internet_Relay_Chat">IRC</a></h3>

<ul>
 <li>Bugs
  <ul>
   <li>{{TemplateLink("bug")}} allows you to link to a bug on bugzilla.mozilla.org easily using this syntax: <code>\{\{Bug(123456)\}\}</code>. This gives you: {{ Bug(123456) }}.</li>
   <li>{{TemplateLink("WebkitBug")}} inserts a link to a bug in the WebKit bug database. For example, <code>\{\{WebkitBug(31277)\}\}</code> inserts {{ WebkitBug(31277) }}.</li>
  </ul>
 </li>
 <li>{{TemplateLink("IRCLink")}} inserts a link to the specified IRC channel, complete with a tooltip that says that's what it does and that an IRC client is needed.</li>
</ul>

<h3 id="Aides_à_la_navigation_pour_les_guides_multi-pages">Aides à la navigation pour les guides multi-pages</h3>

<p>{{TemplateLink("Previous")}}, {{TemplateLink("Next")}}, and {{TemplateLink("PreviousNext")}} provide navigation controls for articles which are part of sequences. For the single-way templates, the only parameter needed is the wiki location of the previous or next article in the sequence. For {{TemplateLink("PreviousNext")}}, the two parameters needed are the wiki locations of the appropriate articles. The first parameter is for the previous article and the second is for the next article.</p>

<h2 id="Exemples_de_code">Exemples de code</h2>

<h3 id="Live_samples">Live samples</h3>

<ul>
 <li>{{TemplateLink("EmbedLiveSample")}} lets you embed the output of a code sample on a page, as described in <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Live samples</a>.</li>
 <li>{{TemplateLink("LiveSampleLink")}} creates a link to a page containing the output of a code sample on a page, as described in <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Live samples</a>.</li>
</ul>

<h3 id="Fichiers_exemples_attachés">Fichiers exemples attachés</h3>

<ul>
 <li>{{TemplateLink("Embed_text")}} template lets you embed an attached text file into the body of your article. This is helpful if you want to have code snippets that are both downloadable but also displayed within the article's content. You may optionally specify a language for syntax highlighting; if you don't specify one, the text is embedded unformatted. The first parameter is the filename of the attachment to embed; the second, if provided, is the language for the syntax highlighter to apply, such as "javascript", "svg", or "cpp".</li>
 <li>{{TemplateLink("EmbedSVG")}} embeds an attached XML file as an SVG image, in place on the page. Specify the filename of the attached SVG file. You can use this in tandem with {{TemplateLink("Embed_text")}} to show the source and then the rendered output of the same file.</li>
</ul>

<h2 id="Génération_de_sidebar_barre_latérale">Génération de sidebar (barre latérale)</h2>

<p>Modèles pour presque toutes les grandes collection de pages. Ils permettent généralement de revenir à la page principale de référence/Guide/tutoriel et de mettre l'article dans la catégorie appropriée.</p>

<ul>
 <li>{{TemplateLink("CSSRef")}} generates the sidebar for CSS reference pages.</li>
 <li>{{TemplateLink("HTMLRef")}} generates the sidebar for HTML reference pages.</li>
 <li>{{TemplateLink("APIRef")}} generates the sidebar for Web API reference pages.</li>
</ul>

<h2 id="La_mise_en_forme_à_usage_général">La mise en forme à usage général</h2>

<h3 id="Inline_indicators_for_API_documentation">Inline indicators for API documentation</h3>

<p>{{TemplateLink("optional_inline")}} and {{TemplateLink("ReadOnlyInline")}} are used in API documentation, usually when describing the list of properties of an object or parameters of a function.</p>

<p>Usage: <code>\{{optional_inline()}}</code> or <code>\{{ReadOnlyInline()}}</code>. Example:</p>

<dl>
 <dt><code>isCustomObject</code> {{ReadOnlyInline()}}</dt>
 <dd>Indicates, if <code>true</code>, that the object is a custom one.</dd>
 <dt>parameterX {{ optional_inline() }}</dt>
 <dd>Blah blah blah...</dd>
</dl>

<h2 id="Status_and_compatibility_indicators">Status and compatibility indicators</h2>

<h3 id="Inline_indicators_with_no_additional_parameters">Inline indicators with no additional parameters</h3>

<h4 id="Non-standard">Non-standard</h4>

<p>{{TemplateLink("non-standard_inline")}} inserts an in-line mark indicating the API has not been standardized and is not on a standards track.</p>

<h5 id="Syntax"><strong>Syntax</strong></h5>

<p><code>\{{non-standard_inline}}</code></p>

<h5 id="Examples">Examples</h5>

<ul>
 <li>Icon: {{non-standard_inline}}</li>
</ul>

<h4 id="Experimental">Experimental</h4>

<p>{{TemplateLink("experimental_inline")}} inserts an in-line mark indicating the API is not widely implemented and may change in the future.</p>

<h5 id="Syntax_2">Syntax</h5>

<p><code>\{{experimental_inline}}</code></p>

<h5 id="Examples_2"><code>Examples</code></h5>

<ul>
 <li>Icon: {{experimental_inline}}</li>
</ul>

<h3 id="Inline_indicators_that_support_specifying_the_technology">Inline indicators that support specifying the technology</h3>

<p>In these macros the parameter (when specified) should be one of the strings "html", "js", "css", or "gecko", followed by the version number.</p>

<h4 id="Deprecated">Deprecated</h4>

<p>{{TemplateLink("deprecated_inline")}} inserts an in-line deprecated mark to discourage the use of an API that is officially deprecated. <strong>Note:</strong> "Deprecated" means that the item should no longer be used, but still functions. If you mean that it no longer works at all, use the term "obsolete."</p>

<p>Don't use the parameter in any browser-agnostic area (HTML, APIs, JS, CSS, …).</p>

<h5 id="Syntax_3">Syntax</h5>

<p><code>\{{deprecated_inline}}</code> or<code> \{{deprecated_inline("gecko5")}}</code></p>

<h5 id="Examples_3">Examples</h5>

<ul>
 <li>Icon: {{deprecated_inline}}</li>
 <li>Badge: {{deprecated_inline("gecko5")}}</li>
</ul>

<h4 id="Obsolete">Obsolete</h4>

<p>{{TemplateLink("obsolete_inline")}} inserts an in-line obsolete mark to prevent the use of, for example, a function, method or property which is officially obsolete.</p>

<p>Don't use the parameter in any browser-agnostic area (HTML, APIs, JS, CSS, …).</p>

<h5 id="Syntax_4">Syntax</h5>

<p><code>\{{obsolete_inline}}</code> or<code> \{{obsolete_inline("js1.8.5")}}</code></p>

<h5 id="Examples_4">Examples</h5>

<ul>
 <li>Icon: {{obsolete_inline}}</li>
 <li>Badge: {{obsolete_inline("js1.8.5")}}</li>
</ul>

<h3 id="Template_badges">Template badges</h3>

<p>These macros are mostly used on the <a href="/en-US/docs/WebAPI">WebAPI</a> page. See {{anch("Creating new badges")}} for information on creating a new badge.</p>

<h3 id="Page_or_section_header_indicators">Page or section header indicators</h3>

<p>These templates have the same semantics as their inline counterparts described above. The templates should be placed directly underneath the main page title (or breadcrumb navigation if available) in the reference page. They can also be used to mark up a section on a page.</p>

<ul>
 <li>{{TemplateLink("non-standard_header")}}: <code>\{{Non-standard_header()}}</code> {{ Non-standard_header() }}</li>
 <li>{{TemplateLink("SeeCompatTable")}} should be used on pages that provide a "Browser compatibility" section. Example: <code>\{{SeeCompatTable()}}</code> {{ SeeCompatTable() }}</li>
 <li>{{TemplateLink("deprecated_header")}}: <code>\{{deprecated_header()}}</code> {{ Deprecated_header() }}</li>
 <li>{{TemplateLink("deprecated_header")}} with parameter: <code>\{{deprecated_header("gecko5")}}</code> {{ Deprecated_header("gecko5") }} Don't use the parameter in any browser-agnostic area (HTML, APIs, JS, CSS, …).</li>
 <li>{{TemplateLink("obsolete_header")}}: <code>\{{obsolete_header()}}</code> {{ Obsolete_header() }}</li>
 <li>{{TemplateLink("obsolete_header")}} with parameter: <code>\{{obsolete_header("gecko30")}}</code> {{ Obsolete_header("gecko30") }} Don't use the parameter in any browser-agnostic area (HTML, APIs, JS, CSS, …).</li>
</ul>

<h3 id="Indicating_that_a_feature_is_available_in_web_workers">Indicating that a feature is available in web workers</h3>

<p>The {{TemplateLink("AvailableInWorkers")}} macro inserts a localised note box indicating that a feature is available in a <a href="/en-US/docs/Web/API/Web_Workers_API">Web worker</a> context.</p>

<h2 id="Version_information_macros">Version information macros</h2>

<p>These macros are used to indicate that content is relevant only to specific versions of a product.</p>

<ul>
 <li>{{TemplateLink("gecko_minversion_inline")}}: For example: {{ gecko_minversion_inline("100.9") }}</li>
 <li>{{TemplateLink("fx_minversion_inline")}}: For example: {{ fx_minversion_inline("100.9") }}</li>
</ul>

<p>These macros are not shown when the specified version is lower than current gecko release.</p>

<ul>
 <li>{{TemplateLink("gecko_minversion_inline")}}(9.9): {{ gecko_minversion_inline("9.9") }}</li>
 <li>{{TemplateLink("fx_minversion_inline")}}(9.9): {{ fx_minversion_inline("9.9") }}</li>
</ul>

<ol>
</ol>

<p> </p>

<ol>
</ol>

<p> </p>