Difference between revisions of "Template:Event documentation"

Revision as of 16:40, 6 August 2009

This template produces the standard formatting in the first part of category:Event types articles. The following is a comprehensive set of all the possible parameters for this template; feel free to delete the unused parameters when using it in an article for tidiness. The various parameter types have higher number ranges than just those shown here, for example you can use up to in6name and int6desc, but since they're not common they weren't included in the template.

sortkey

An optional parameter, this controls how the event is sorted in categories. Omit the "EVENT_TYPE_" part of the page's title.

when

This parameter is for a simple prose description of the situation in which the event is fired.

from

What's the source of this event? Usually engine or a script name.

to

What resource types receive this event?

tocategory1 through tocategory5

This is split into multiple parameters and used to generate categories, put one resource type in each to# parameter.

You can omit a particular variable from the example code by not setting its corresponding name parameter. For example, if an event has both object0 and creator as the "attacker", you can omit the creator from the example code by not setting creatorname.

{{event
|sourcefile=
|sourcemodule=
|sortkey=
|when=
|from=
|to=
|tocategory1=
|tocategory2=
|creatorname=
|creatordesc=
|int0name=
|int0desc=
|int1name=
|int1desc=
|int2name=
|int2desc=
|float0name=
|float0desc=
|float1name=
|float1desc=
|float2name=
|float2desc=
|string0name=
|string0desc=
|string1name=
|string1desc=
|string2name=
|string2desc=
|object0name=
|object0desc=
|object1name=
|object1desc=
|object2name=
|object2desc=
|location0name=
|location0desc=
|location1name=
|location1desc=
}}