Difference between revisions of "Template:GeographyList/doc"
From SpiralKnights
m (more notes) |
m (more notes) |
||
| Line 1: | Line 1: | ||
| + | <noinclude>{{documentation subpage}}</noinclude> | ||
| + | |||
| + | ==Usage== | ||
| + | [[File:Icon-alert.png|36px]] '''This template should only be used for areas which are randomly generated.''' | ||
| + | |||
| + | ==Code== | ||
| + | <pre> | ||
| + | {{GeographyList | ||
| + | |parent = | ||
| + | |segment = | ||
| + | |number = | ||
| + | |letter = | ||
| + | |notes = | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | ==Parameters== | ||
|parent | |parent | ||
| − | :the [[mission]] or [[area]]. Only use mission names if the area is exclusive to a mission. In other words, default to the Arcade. For example, do not use '' | + | :the [[mission]] or [[area]]. Only use mission names if the area is exclusive to a mission. In other words, default to the Arcade. For example, do not use "''Alien Ooze-Slimeway.''" Use "''Clockwork Tunnels: Slimeway.''" |
|child | |child | ||
| Line 6: | Line 23: | ||
|segment | |segment | ||
| − | :'''Only use if the map is | + | :'''Only use if the map is randomly generated.''' Example: [[:File:Map-Gloaming Wildwoods-Terrilous Trail.png|this map]] is fixed. Less obviously, [[:File:Map-A Revelation in Flames-Frigid Passage-1A.png|this is fixed]]. Neither are randomly generated maps. Pay special attention and explore an area many times before publishing research on it. Segment types include: |
::Start (start only - does not involve party button segments. Arsenal station is usually available) | ::Start (start only - does not involve party button segments. Arsenal station is usually available) | ||
::I (straight) | ::I (straight) | ||
| Line 16: | Line 33: | ||
|number | |number | ||
| − | :the segment number as encountered. this establishes a "family" of maps which are pretty much the same. Defaults to 1. | + | :the segment number as encountered. this establishes a "family" of maps which are pretty much the same in general shape. Defaults to 1. |
|letter | |letter | ||
:the variant of the general number's shape. Doubt we'll ever see more than 26 area variants per number in the specified area/mission. Defaults to A. | :the variant of the general number's shape. Doubt we'll ever see more than 26 area variants per number in the specified area/mission. Defaults to A. | ||
| + | |||
| + | ==Examples== | ||
| + | See [http://wiki.spiralknights.com/index.php?title=Special%3AWhatLinksHere&limit=500&target=Template%3AGeographyList&namespace=0 what links here] for examples of this template in action. | ||
| + | |||
| + | ==Notes== | ||
| + | This naming convention is mostly random when it comes to chronology. Files are added in the order they happen to be found by the editor who uploads them. | ||
| + | |||
| + | Fixed maps use a similar naming convention - they are simply "File:Map-Parent-Child.png", and do not use segment, number, letter to define them, as there is no need for these variables. "Area" images of these locations are simply named "File:Area-Parent-Child.png", "File:Area-Parent-Child 1.png, "File:Area-Parent-Child 2.png", and so on. | ||
Revision as of 08:01, 15 September 2015
 |
This is a documentation subpage for Template:GeographyList (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
This template should only be used for areas which are randomly generated.
Code
{{GeographyList
|parent =
|segment =
|number =
|letter =
|notes =
}}
Parameters
|parent
- the mission or area. Only use mission names if the area is exclusive to a mission. In other words, default to the Arcade. For example, do not use "Alien Ooze-Slimeway." Use "Clockwork Tunnels: Slimeway."
|child
- Only use for mission exclusives. This is because "wild path" and "haunted passage" etc. segments are usually the exact same map, just with grass added or not or whatever. Here should be entered the level, a.k.a floor name, of the mission.
|segment
- Only use if the map is randomly generated. Example: this map is fixed. Less obviously, this is fixed. Neither are randomly generated maps. Pay special attention and explore an area many times before publishing research on it. Segment types include:
- Start (start only - does not involve party button segments. Arsenal station is usually available)
- I (straight)
- L (turn)
- + (crossroad)
- T (t-intersection)
- D (dead end, often with loot)
- End (end of level - elevator only, not dead ends)
|number
- the segment number as encountered. this establishes a "family" of maps which are pretty much the same in general shape. Defaults to 1.
|letter
- the variant of the general number's shape. Doubt we'll ever see more than 26 area variants per number in the specified area/mission. Defaults to A.
Examples
See what links here for examples of this template in action.
Notes
This naming convention is mostly random when it comes to chronology. Files are added in the order they happen to be found by the editor who uploads them.
Fixed maps use a similar naming convention - they are simply "File:Map-Parent-Child.png", and do not use segment, number, letter to define them, as there is no need for these variables. "Area" images of these locations are simply named "File:Area-Parent-Child.png", "File:Area-Parent-Child 1.png, "File:Area-Parent-Child 2.png", and so on.
