HTML element page template

Page front matter

The frontmatter at the top of the page is used to define page metadata. The values should be updated appropriately for the particular element.

---
title: '<NameOfTheElement>: The NameOfTheElement element'
slug: Web/HTML/Element/NameOfTheElement
tags:
  - NameOfTheElement
  - Element
  - HTML
  - Reference
  - Experimental
  - Deprecated
browser-compat: path.to.feature.NameOfTheElement
---
title
Title heading displayed at top of page. An HTML element page should have a title of: "<element_tag> Description of element's purpose". For example, the <video> element has a title of: <video>: The Video Embed element.
slug
The end of the URL path after https://developer.mozilla.org/en-US/docs/). This will be formatted like Web/HTML/Element/NameOfTheElement, where the name is in lower case. The <video> element has a slug of Web/HTML/Element/video.
tags

Always include the following tags: HTML, Element, Reference, NameOfTheElement (e.g. Video).

Include the following tags as appropriate:

  • Technology status: Experimental (if the technology is experimental), Deprecated (if it is deprecated).
  • Any other tags that represent terms people might search for related to the technology. For example, the <video> element includes the tags: HTML Video, Multimedia, Media Player, Movie Playback, etc.
browser-compat

Replace the placeholder value path.to.feature.NameOfTheElement with the query string for the element in the Browser compat data repo. The toolchain automatically uses the key to populate the compatibility and specification sections (replacing the {{Compat}} and {{Specifications}} macros).

Note that you may first need to create/update an entry for the element in our Browser compat data repo, and the entry will need to include specification information. See our guide on how to do this.

Top macros

A number of macro calls appear at the top of the content section. You should update or delete them according to the advice below:

  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental). If the technology you are documenting is not experimental, you can remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.
  • {{deprecated_header}} — this generates a Deprecated banner that indicates the technology is deprecated. If it isn't, then you can remove the macro call.
  • {{htmlref}} — this generates a suitable HTML sidebar, depending on what tags are included on the page.

Draft

This page is not complete.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The <insert_the_element_name> HTML element does ... insert a summary paragraph naming the element and saying what it does (ideally 1 or 2 short sentences).

{{EmbedInteractiveExample("pages/tabbed/nameOfElement.html", "tabbed-standard")}}

Further information — at this point, include a few more paragraphs explaining the most important things you need to know about using the element and its main features. It is good to explain briefly what is going on in the interactive example if it is not immediately obvious. You could also explain key points about how this element interacts with important related JavaScript or CSS features. Not too much detail — you don't want to repeat the documentation across pages — but a key point plus a link to that feature's page would be useful. Again, see the <video> page for an example.

Attributes

This element includes the global attributes.

attribute1
Include description here of what the attribute does. Include one term and definition for each attribute. If the attribute is not experimental/deprecated, remove the relevant macro calls.
attribute2
etc.

Events

Include a table of the events fired on this type of element, if any.

Event name Fired when
event 1 Explain briefly when it is fired...
event 2 Explain briefly when it is fired...
etc.

Examples

Fill in a simple example that nicely shows a typical usage of the element, then perhaps some more complex examples (see our guide on how to add code examples for more information).

my code block

And/or include a list of links to useful code samples that live elsewhere:

  • x
  • y
  • z

Accessibility concerns

Optionally, warn of any potential accessibility concerns that exist with using this element, and how to work around them. Remove this section if there are none to list.

Technical summary

Content categories Fill in a list of the content categories the HTML element belongs to.
Permitted content What content is the element allowed to contain?
Tag omission Can the end tag be omitted, or must it be present? Must it be omitted?
Permitted parents What parent elements can the element be a child of? For example "Any element that accepts flow content."
Permitted ARIA roles Fill in a list of ARIA roles that can be set on the element, inside {{ARIARole("nameOfRole")}} macro calls. For example directory.
DOM interface What DOM interface represents the element in JavaScript? For example HTMLOListElement in the case of ol.

Specifications

No specification found

No specification data found for path.to.feature.NameOfTheElement.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

No compatibility data found for path.to.feature.NameOfTheElement.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

See also

  • Include list of
  • other links related to
  • this Element that might
  • be useful