Template:ParseInputQuality/doc

Description
This is a utility function that processes quality-related arguments and combines them all into a single list of to-be-displayed quality values. It is intended for use only within other templates.

Syntax
Standard usage:

Complete argument list:

Parameters
All of the following arguments are optional named arguments. In the absence of any arguments, it will return the default quality list (Normal,Silver,Gold). Default value for all arguments is empty, unless specified otherwise.


 * quality=values
 * Requested quality values. Default value is Normal, Silver, Gold
 * This can be a comma-separated list of individual values (Normal, Silver, Gold, Iridium).
 * More typically it is set to one of the following special values:
 * true = Normal, Silver, Gold
 * false = Normal
 * Also one special combination is recognized for potential convenience
 * true, iridium = Normal, Silver, Gold, Iridium


 * iridium = true
 * Set to any value to turn on iridium quality
 * Note that  |iridium|  will NOT work. It must be assigned a value using '=', e.g.  |iridium=true|  or  |iridium=1| .


 * hide = values
 * Quality values to hide, as a comma-separated list of individual values.
 * In case of conflict, hide overrides any other input.
 * For backwards compatibility with Template:Edibility, hide=base is recognized as equivalent to hide=normal, but this is deprecated.


 * translate = true
 * Set to true if the return values should be translated, i.e., use text from $lang_quals instead of $engl_quals.


 * case = lc;uc
 * Set to one of lc or uc to convert the case of all return values.

Return Value
The return value will always be a comma-separated list of one or more of the following values, always in this order:

Normal, Silver, Gold, Iridium

Examples
Default qualities Returns: 

Demonstrate iridium and hide parameters Returns: 

Demonstrate quality=false Returns: 