Wiki: Header Image Directive

The {{HeaderImage}} directive specifies the full-width hero image displayed at the top of an article above the title.

Syntax

Reference an uploaded file article by its slug:

{{HeaderImage slug-of-file-article}}

				

or explicitly using the file: namespace prefix:

{{HeaderImage file:slug-of-file-article}}

				

Rules and Resolution

• Target Article: The slug must correspond to an existing File article (ArticleType.File) that has an active canonical file revision.
• Prefix Handling: The file: prefix is optional and is stripped during database lookup.
• Site and Culture Matching: The file article must exist in the same site and culture as the current article.
• First Resolved Image Wins: The first valid, resolved header image becomes the page hero. If the referenced file cannot be found, no hero image is rendered.
• Uploads: To upload a new image to use as a header, visit the Media Uploader.

Example

{{HeaderImage file:byte-volume-1-issue-1-september-1975-cover}}
{{Eyebrow MAGAZINEISSUE}}
{{Subtitle Volume 1, Issue 1}}

# BYTE - September 1975

				

Return to the Formatting Guide.