Difference between revisions of "Template:GateLevel/doc"
From SpiralKnights
m (→Usage) |
m (major update regarding parameters, after all the changes.) |
||
| Line 1: | Line 1: | ||
<noinclude>{{documentation subpage}}</noinclude> | <noinclude>{{documentation subpage}}</noinclude> | ||
==Usage== | ==Usage== | ||
| − | To display [[:Category:Levels|level]] information in a compact manner. Compatible with various terms as needed. Use | + | To display [[:Category:Levels|level]] information in a compact manner. Compatible with various terms as needed. Use primarily on [[mission]] pages. Area pages such as [[Scarlet Fortress]] have their own special format to visually separate them from missions, and they do not have a set floor sequence at all. |
==Code== | ==Code== | ||
<pre> | <pre> | ||
| − | {{ | + | {{GateLevel |
| − | | | + | |missionlist = {{{missionlist|}}} |
| − | | | + | |size = {{{size|58px}}} |
| − | | | + | |floor = |
| − | |depth = | + | |icon = |
| + | |name = | ||
| + | |depth = | ||
| + | |plug = | ||
| + | |note = | ||
}} | }} | ||
</pre> | </pre> | ||
==Parameters== | ==Parameters== | ||
| − | | | + | *<nowiki>missionlist = {{{missionlist|}}}</nowiki> |
| − | * | + | *<nowiki>size = {{{size|58px}}}</nowiki> |
| + | :These are included so the gate map display can be flexible, because it is used in both the mission page and a mission list page. | ||
| − | + | *floor | |
| − | * | + | :The floor number. 0,1,2 etc. Only use if the gate is depicting a mission gate map, arcade gates do not concern themselves with this because depths are always predictable. In other words, in an arcade gate each "depth" is a "floor" that can be one level or rotate between 2 or more levels. |
| − | + | *icon | |
| − | * | + | :Specify icon file. There are many old, inconsistently named icons around the wiki. Only need to use NAME for entry: "File:Gate-NAME.png" is built into the template. If the level is new, you might need to upload an icon. Pay careful attention to icon naming convention for levels vs. areas. |
| + | ::This can be quite complicated for some floors. You might need to use icon 2, icon 3, etc. If there are levels in the floor's rotation. Make sure they line up with the plug order. | ||
| − | + | *name | |
| − | * | + | :The name of the floor. Pay attention to floor name vs. level. Mission floors often have special names for levels. For example, ''Tracking'' in [[High Temperature Hostages]] is a ''[[Wolver Den: Ashes to Ash Tails]]''. This special naming helps the game's story, but can be confusing. So we display the name in plain text and a link to the named level as well. |
| + | |||
| + | *depth | ||
| + | :A number, or <nowiki>Depends on [[Player Rank|rank]]''</nowiki> (for prestige) | ||
| + | |||
| + | *plug | ||
| + | :The name of the level the gate uses for this floor. This will be a [[:Category:Geography subpages|geography subpage]]. | ||
| + | ::This can be quite complicated for some floors. You might need to use plug 2, plug 3, etc if there are levels in the floor's rotation. Make sure they line up with the icon order. | ||
| + | |||
| + | *note | ||
| + | :Defaults to "level link." There are a few standardized entries, otherwise, carefully link the level with a specially worded input. | ||
| + | ::compact area | ||
| + | ::danger lobby | ||
| + | ::mission arena | ||
| + | ::standard lobby | ||
| + | ::starter lobby | ||
| + | ::unique | ||
| + | ::random | ||
| + | ::set | ||
| + | |||
| + | *special | ||
| + | :Only include if the level is otherwise the same as the arcade version, but always has something special in it somewhere, such as a scenario room at the end. | ||
| + | |||
| + | ==Examples== | ||
| + | See [http://wiki.spiralknights.com/Special:WhatLinksHere/Template:GateLevel what links here] for examples of this template in action. | ||
Revision as of 16:40, 30 December 2015
 |
This is a documentation subpage for Template:GateLevel (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
To display level information in a compact manner. Compatible with various terms as needed. Use primarily on mission pages. Area pages such as Scarlet Fortress have their own special format to visually separate them from missions, and they do not have a set floor sequence at all.
Code
{{GateLevel
|missionlist = {{{missionlist|}}}
|size = {{{size|58px}}}
|floor =
|icon =
|name =
|depth =
|plug =
|note =
}}
Parameters
- missionlist = {{{missionlist|}}}
- size = {{{size|58px}}}
- These are included so the gate map display can be flexible, because it is used in both the mission page and a mission list page.
- floor
- The floor number. 0,1,2 etc. Only use if the gate is depicting a mission gate map, arcade gates do not concern themselves with this because depths are always predictable. In other words, in an arcade gate each "depth" is a "floor" that can be one level or rotate between 2 or more levels.
- icon
- Specify icon file. There are many old, inconsistently named icons around the wiki. Only need to use NAME for entry: "File:Gate-NAME.png" is built into the template. If the level is new, you might need to upload an icon. Pay careful attention to icon naming convention for levels vs. areas.
- This can be quite complicated for some floors. You might need to use icon 2, icon 3, etc. If there are levels in the floor's rotation. Make sure they line up with the plug order.
- name
- The name of the floor. Pay attention to floor name vs. level. Mission floors often have special names for levels. For example, Tracking in High Temperature Hostages is a Wolver Den: Ashes to Ash Tails. This special naming helps the game's story, but can be confusing. So we display the name in plain text and a link to the named level as well.
- depth
- A number, or Depends on [[Player Rank|rank]]'' (for prestige)
- plug
- The name of the level the gate uses for this floor. This will be a geography subpage.
- This can be quite complicated for some floors. You might need to use plug 2, plug 3, etc if there are levels in the floor's rotation. Make sure they line up with the icon order.
- note
- Defaults to "level link." There are a few standardized entries, otherwise, carefully link the level with a specially worded input.
- compact area
- danger lobby
- mission arena
- standard lobby
- starter lobby
- unique
- random
- set
- special
- Only include if the level is otherwise the same as the arcade version, but always has something special in it somewhere, such as a scenario room at the end.
Examples
See what links here for examples of this template in action.
