Template:Event/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>Illviljan
mNo edit summary
No edit summary
 
(20 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}


The '''Event''' template is used to show a event [[Template:Infocard2|info card]].
{{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 !! Description
! Parameter  
! Description
! Optional
|-
|-
| '''name'''        || The name of the event.
| '''name'''        || The name of the event.
| {{no}}
|-
|-
| '''type'''        || The type of the event.
| '''type'''        || The type of the event. Available types:
* challenge
* expansion
* pvp
* race
| {{no}}
|-
| '''release_version''' || The [[version]] the event was released.
| {{no}}
|-
|-
| '''release_date''' || The date when the event started.
| '''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.
| '''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>.
| {{yes}}
|-
| '''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]
| {{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.
| '''rewards'''      || The rewards when reaching a certain point threshold during the event.
| {{yes}}
|-
|-
| '''prize'''        || The prize.
| '''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'''        || Relevant links for the event.
| '''links'''        || External website of the event, preferably official web page
| {{yes}}
|}
|}


==Example==
==Cargo==
{|
{| class="wikitable"
|
! Table !! Declared by !! Attached by
<pre>
|-
{{Event
| [[Special:CargoTables/events|events]]
|name            = Talisman league
| {{tl|Event/cargo/events/declare}}
|type            = challenge
| {{tl|Event/cargo/events/attach}}
|release_version = 2.1.0
|release_date    = 2015.12.11
|end_date        = 2016.03.04
}}
</pre>
|
{{Event
|name            = Talisman league
|type            = challenge
|release_version = 2.1.0
|release_date    = 2015.12.11
|end_date        = 2016.03.04
}}
|}
|}


{|
{{Documentation categories|
|
<!-- Categories and interwikis go here. -->
<pre>
[[Category:Data templates]]
{{Event
|name            = Forsaken Masters
|type            = expansion
|release_version = 1.2.0
|release_date    = 2014.08.20
}}
}}
</pre>
|
{{Event
|name            = Forsaken Masters
|type            = expansion
|release_version = 1.2.0
|release_date    = 2014.08.20
}}
|}
{|
|
<pre>
{{Event
|name            = Winterheart race season
|type            = race
|release_date    = 2016.01.29 (NZT)
|end_date        = 2016.02.25 (NZT)
|rewards        = [[Asphyxia's Wrath]] <br> [[Sapphire Ring]] <br> [[The Whispering Ice]] <br> [[Dyadian Dawn]] <br> [[Call of the Brotherhood]] <br> [[Winterheart]]
|prize          = [[Demigod's Dominance]]
|links          = [http://www.pathofexile.com/seasons Schedule and overview]
}}
</pre>
|
{{Event
|name            = Winterheart race season
|type            = race
|release_date    = 2016.01.29
|end_date        = 2016.02.25
|rewards        = [[Asphyxia's Wrath]] <br> [[Sapphire Ring]] <br> [[The Whispering Ice]] <br> [[Dyadian Dawn]] <br> [[Call of the Brotherhood]] <br> [[Winterheart]]
|prize          = [[Demigod's Dominance]]
|links          = [http://www.pathofexile.com/seasons Schedule and overview]
}}
|}
<includeonly>
[[Category:Infocard templates]]
</includeonly>

Latest revision as of 02:05, 26 June 2022

This subpage provides documentation for Template:Event.

Lua logo

This template uses the following modules:

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:
  • challenge
  • expansion
  • pvp
  • race
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}}