HTTP header page template

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

---
title: NameOfTheHeader
slug: Web/HTTP/Headers/NameOfTheHeader
status:
  - experimental
  - deprecated
  - non-standard
browser-compat: path.to.feature.NameOfTheHeader
---
title

Title heading displayed at top of page. Format as NameOfTheHeader. For example, the Cache-Control header has a title of Cache-Control.

slug

The end of the URL path after https://developer.mozilla.org/en-US/docs/). This will be formatted like Web/HTTP/Headers/NameOfTheHeader. For example, the Cache-Control slug is Web/HTTP/Headers/Cache-Control.

status

Include (appropriate) technology status keys: experimental, deprecated, non-standard (if not on a standards track).

browser-compat

Replace the placeholder value path.to.feature.NameOfTheHeader with the query string for the header in the Browser compat data repo. The toolchain automatically uses the key to populate the compatibility section (replacing the {{Compat}} macro).

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

Top-of-page macros

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

  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the header is experimental. If the header 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 that use of the header is discouraged. If it isn't, then you can remove the macro call.
  • {{httpsidebar}} — this generates the HTTP sidebar that must appear on every HTTP reference page. Remember to remove the {{MDNSidebar}} macro when you copy this page.

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.

The summary paragraph — start by naming the http header and saying what it does. This should ideally be 1 or 2 short sentences.

Header type Include header category (or categories), e.g. Request header, Response header, Client hint
Forbidden header name yes or no
CORS-safelisted response header yes or no

Syntax

Fill in a syntax box, like the one below, according to the guidance in our syntax sections article. If the header has a lot of available directives, feel free to include multiple syntax boxes, subsections and explanations as appropriate. 

NameOfTheHeader: <directive1>
NameOfTheHeader: <directive1>, <directive2>, …

The directives are case-insensitive and have an optional argument, that can use both token and quoted-string syntax. Multiple directives are comma-separated (delete information as appropriate).

Directives

directive1

Include a brief description of the directive and what it does here. Include one term and definition for each directive.

directive2

etc.

If the header has a lot of available directives, feel free to include multiple definition lists, subsections and explanations as appropriate.

Examples

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 (###) naming 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.

Scenario 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 fetch API

Example of Fetch

### More examples

Links to more examples on other pages

Scenario 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 API, see [the page on fetch()](https://example.org).

Specifications

No specification found

No specification data found for path.to.feature.NameOfTheHeader.
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

BCD tables only load in the browser

See also

Include links to reference pages and guides related to the current HTTP header. For more guidelines, see the See also section in the Writing style guide.

  • link1
  • link2