Template:Main Page event/doc

From Team Fortress Wiki
Jump to: navigation, search

Documentation for Main Page event/doc

Important: files should NOT include Main Page event when linking. The prefix is automatically added.

Parameters

event
Required. Case-sensitive. Event inputs: Summer, Scream Fortress, Smissmas.
Inputting any of these will switch the theme based on the event. Leave blank to disable the banner.
event-duration
Optional. Adds the event duration.
Use start and end to specify the time gap.
suffix
Optional. Adds a custom suffix instead of the current year. This is currently used for exceptions like Scream Fortress with its roman numerals.
image
Required. Sets the image file path. The File: prefix should not be added.
image-title
Optional. Adds a custom alt text for the image.
overlay
Optional. Adds a dark overlay to the banner.
link-override
Optional. Overrides the page link.
festive
Optional. Adds festive lights on top of the banner at the top. Should only be used for Smissmas.

(Experimental)

video
Optional. Dynamically embeds a video and replaces the image. Must have an image as fallback.
Best practice: Upload a screenshot of the first frame and use that as the fallback image, which creates a smoother transition.
Files are to be uploaded under the naming convention: Main Page event <event> <desc>, e.g. Main Page event Scream Fortress castle loop.
The description doesn't have to be too specific, but keep it consistent.
video-url
Required if video is set. For internal video files, simply enter the file name like you normally would. The File: prefix should not be added.
video-external
Optional. Use this to serve externally linked video files by including the full URL in the video-url parameter once set.