Template:Event/doc: Difference between revisions
Jump to navigation
Jump to search
>Illviljan mNo edit summary |
No edit summary |
||
(11 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Documentation subpage}} | ||
The ''' | {{Lua|Module:Data_tables}} | ||
The '''{{BASEPAGENAME}}''' template is used to create a infocard for events such as [[expansion]]s, [[race]]s, [[league]]s. | |||
==Overview== | |||
The template will do the following: | |||
* Create an infocard. | |||
* Add relevant categories to the page. | |||
* Add cargo fields to the page. | |||
==Parameters== | ==Parameters== | ||
All parameters should be filled in if possible to ensure it's working correctly. | |||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter !! | ! Parameter | ||
! Description | |||
! Optional | |||
|- | |- | ||
| '''name''' || The name of the event. | | '''name''' || The name of the event. | ||
| | | {{no}} | ||
|- | |- | ||
| '''type''' || The type of the event. Available types: | | '''type''' || The type of the event. Available types: | ||
Line 17: | Line 27: | ||
* pvp | * pvp | ||
* race | * race | ||
| {{no}} | |||
|- | |||
| '''release_version''' || The [[version]] the event was released. | |||
| {{no}} | |||
|- | |- | ||
| '''release_date''' || The date when the event started. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here]. | | '''release_date''' || The date when the event started. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here]. | ||
| {{no}} | |||
|- | |- | ||
| '''end_date''' || The date when the event ended. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here]. | | '''end_date''' || The date when the event ended. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here]. | ||
| | | {{yes}} | ||
|- | |- | ||
| '''standard''' || Is it a standard event? Use <code>1</code> or <code>0</code>. | | '''standard''' || Is it a standard event? Use <code>1</code> or <code>0</code>. | ||
| {{yes}} | |||
|- | |- | ||
| '''hardcore''' || Is it a hardcore event? Use <code>1</code> or <code>0</code>. | | '''hardcore''' || Is it a hardcore event? Use <code>1</code> or <code>0</code>. | ||
| {{yes}} | |||
|- | |- | ||
| '''id''' || Id(s) of the event. Can find the id for events [http://api.pathofexile.com/leagues?type=main&compact=1 here] | | '''id''' || Id(s) of the event. Can find the id for events [http://api.pathofexile.com/leagues?type=main&compact=1 here] | ||
| {{yes}} | |||
|- | |||
| '''number_of_events''' || The rewards when reaching a certain point threshold during the event. | |||
| {{yes}} | |||
|- | |||
| '''rewards''' || The rewards when reaching a certain point threshold during the event. | |||
| {{yes}} | |||
|- | |||
| '''prize''' || The prize. | |||
| {{yes}} | |||
|- | |||
| '''image''' || Custom image for the event. Defaults to <code>{{{name}}} logo.png</code> if the parameter isn't specified. | |||
| {{yes}} | |||
|- | |||
| '''links''' || External website of the event, preferably official web page | |||
| {{yes}} | |||
|} | |} | ||
== | ==Cargo== | ||
{| class="wikitable" | |||
{| | ! Table !! Declared by !! Attached by | ||
|- | |||
| [[Special:CargoTables/events|events]] | |||
| {{tl|Event/cargo/events/declare}} | |||
| | | {{tl|Event/cargo/events/attach}} | ||
| | |||
| | |||
| | |||
| | |||
}} | |||
| | |||
{{Event | |||
}} | |||
|} | |} | ||
{{Documentation categories| | |||
<!-- Categories and interwikis go here. --> | |||
[[Category:Data templates]] | |||
{{ | |||
| | |||
< | |||
}} | }} | ||
Latest revision as of 02:05, 26 June 2022
This subpage provides documentation for Template:Event.
The Event template is used to create a infocard for events such as expansions, races, leagues.
Overview
The template will do the following:
- Create an infocard.
- Add relevant categories to the page.
- Add cargo fields to the page.
Parameters
All parameters should be filled in if possible to ensure it's working correctly.
Parameter | Description | Optional |
---|---|---|
name | The name of the event. | ✗
|
type | The type of the event. Available types:
|
✗
|
release_version | The version the event was released. | ✗
|
release_date | The date when the event started. Can find dates for events here. | ✗
|
end_date | The date when the event ended. Can find dates for events here. | ✓
|
standard | Is it a standard event? Use 1 or 0 .
|
✓
|
hardcore | Is it a hardcore event? Use 1 or 0 .
|
✓
|
id | Id(s) of the event. Can find the id for events here | ✓
|
number_of_events | The rewards when reaching a certain point threshold during the event. | ✓
|
rewards | The rewards when reaching a certain point threshold during the event. | ✓
|
prize | The prize. | ✓
|
image | Custom image for the event. Defaults to {{{name}}} logo.png if the parameter isn't specified.
|
✓
|
links | External website of the event, preferably official web page | ✓
|
Cargo
Table | Declared by | Attached by |
---|---|---|
events | {{Event/cargo/events/declare}} | {{Event/cargo/events/attach}} |