Template:Parameter Check/Doc

Summary

This template is intended to be used solely as a sub-template for other templates like {{Creature Summary}}, {{NPC Summary}}, {{Mission Header}} and the like. It will check any relevant parameters in a uniform manner to avoid repeating large code blocks and having to change them in multiple places every time site policy is changed. Currently, it is focused mostly on image parameters, though the description is also checked, and other parameters can be added as needed.

Parameters

Parameter Check

Parameter	Scope	Description
type	required	What it is that we're checking ("NPC", "Quest", etc.). This is the text used in category names.
types	optional	Plural of the above if it requires more than adding an "s" at the end.
ratio	optional	The desired ratio of the image ("4:3" and "square"/"1:1" are currently the only options). Defaults to square for NPCs and creatures, 4:3 for all others.
ratiomin	optional	If a non-standard ratio is desired, specify the minimum allowable width:height ratio here as a decimal (e.g., 4:3 defaults to 1.3).
ratiomax	optional	If a non-standard ratio is desired, specify the maximum allowable width:height ratio here as a decimal (e.g., 4:3 defaults to 1.35).
needsimage	optional	Whether or not to display a "Needs Image" message if an image is not present. Defaults to doing so, pass an empty value to stop it from displaying the error.
Inherited parameters
The following parameters are all inherited from the parent template where possible. In the event of naming discrepancies, you will have to pass them into the template (e.g., "image={{{customimage|}}}).
ns_base	optional	As per MetaTemplate documentation, the namespace the template will act as though it's in if not the actual namespace. (Note: checking has been disabled in non-gamespaces, even if ns_base is specified explicitly. Used only during name checks.)
image	optional	The image to check. If set to "none", all further image and imgdesc checks will be skipped. If not present, a {{Needs Image}} warning will be displayed. If not the right size, the page will be added to [[Category:types with Non-Square images]] or [[Category:types with Non-Standard images]]. If not the right name, the page will be added to [[Category:types with Incorrectly Named Images]].
imgdesc	optional	The image description. If not present, the page will be added to [[Category:types Needing Image Descriptions]].
description	optional	The description of the NPC, Quest, etc. If not present, the page will be added to [[Category:types Needing Descriptions]].

This page uses material from the UESP article "Template:Parameter Check".