HTML attribute page template

HTML attributes fall into two categories: element-specific attributes, which apply only to certain elements (e.g., the accept attribute on <input type="file">), and global attributes which can be used for any HTML element (e.g., class, id). The former should be put under HTML/Reference/Attributes, while the latter should be put under HTML/Reference/Global_attributes.

Note that most element-specific attributes don't need standalone articles if the attribute list in the element reference is sufficient to describe its behavior. Only add an article if the attribute has enough nuance to deserve its own examples, or it is a global attribute.

Note: Remove this whole explanatory note before publishing

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 attribute.

---
title: name-of-the-attribute
slug: Web/HTML/Reference/Global_attributes/name-of-the-attribute
page-type: html-attribute
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: html.global_attributes.name-of-the-attribute
sidebar: htmlsidebar
---

title

Title heading displayed at the top of the page. Format as name-of-the-attribute (just the attribute name itself). For example, the class attribute has a title of class.

slug

The end of the URL path after https://developer.mozilla.org/en-US/docs/. This will be formatted like Web/HTML/Reference/Global_attributes/name-of-the-attribute or Web/HTML/Reference/Attributes/name-of-the-attribute, where the attributes name is in lower case. For example, the class attribute has a slug of Web/HTML/Reference/Global_attributes/class.

page-type

Always html-attribute.

status

Flags describing the status of this feature. An array which may contain one or more of the following: experimental, deprecated, non-standard. This key should not be set manually: it is set automatically based on values in the browser compatibility data for the feature. See "How feature statuses are added or updated".

browser-compat

Replace the placeholder value html.global_attributes.name-of-the-attribute with the query string for the global attribute in the Browser compat data repo. For element-specific attributes, use the format html.elements.name-of-the-element.name-of-the-attribute, with each query string on its own line, preceded by a dash. For example:

yaml

browser-compat:
  - html.elements.form.autocomplete
  - html.elements.input.autocomplete
  - html.elements.select.autocomplete
  - html.elements.textarea.autocomplete

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 attribute in our Browser compat data repo, and the entry will need to include specification information. See our guide on how to do this.

sidebar

Keep as htmlsidebar (all pages under /web/html/ use this sidebar). See Page structures: Sidebars for details.

Top-of-page macros

A number of macro calls appear at the top of the content section (immediately below the page frontmatter). These macros are automatically added by the toolchain (there is no need to add/remove):

{{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental. 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 that use of the technology is discouraged.
{{Non-standard_Header}} — this generates a Non-standard banner that indicates that the feature is not part of any specification.

Do not provide status header macros manually. Refer to the section "How feature statuses are added or updated" to add these statuses to the page.

Samples of the Experimental, Deprecated, and Non-standard banners are shown right after this note block.

Remember to remove this whole explanatory note before publishing

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.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Start by introducing the reader to the attribute, and its usage. For example: The name-of-the-attribute global attribute describes or manipulates [insert usage description].

Try it

This section is generated by the InteractiveExample macro. This includes the "Try it" section title and the code editor. See the Interactive examples section in our Writing guidelines for more information. If included, follow it with 1-2 brief paragraphs explaining the behavior implemented, and optionally highlighting any interaction with JavaScript, CSS, or other attributes. Keep it concise and avoid duplicating full docs — link out what needed. Again, see the class attribute page.

Values

Provide a list of possible values for the attribute if any (remove if not applicable). Include the default value if there is one, and a brief description for each value.

"value1": Description of value 1. This is the default value.
"value2": Description of value 2.
"value3": Description of value 3.

Accessibility

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

Examples

Show relevant examples for this attribute, and how to use this attribute in practical HTML contexts. Note that we use the plural "Examples" even if the page only contains one example.

A descriptive heading

Each example must have an H3 heading (###) highlighting the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading. See our guide on how to add code examples for more information.

Note: Sometimes you will want to link to examples given on another page.

Case 1: If you have some examples on this page and some more examples on another page:

Include an H3 heading (###) for each example on this page and then a final H3 heading (###) with the text "More examples", under which you can link to the examples on other pages. For example:

## Examples

### Using the `for` attribute

Example of `for` attribute

### More examples

Links to more examples on other pages

Case 2: If you only have examples on another page and none on this page:

Don't add any H3 headings; just add the links directly under the H2 heading "Examples". For example:

## Examples

For examples of this attribute, see [the page on `for` attribute](https://example.org/).

Specifications

{{Specifications}} To use this macro, remove the backticks and backslash in the markdown file.

Browser compatibility

{{Compat}} To use this macro, remove the backticks and backslash in the markdown file.