Template:Battlefield Header/Documentation: Difference between revisions
From HorizonXI Wiki
(updated location parameter description, added location add parameter to documentation and updated example) |
(improved documentation clarity) |
||
| Line 1: | Line 1: | ||
==Documentation== | ==Documentation== | ||
* No input is needed for the name of the battlefield, this will self-populate. In | * '''name:''' - '''(Optional)''' No input is needed for the name of the battlefield, this will self-populate. In cases where the page name deviates from the battlefield title, '''name''' can be used to specify the name of the battlefield manually. | ||
* '''type:''' | * '''type:''' - Links and auto-categorizes to [[:Category:Battlefields]] and the type of battlefield eg. [[:Category:BCNM|BCNM]], [[:Category:KSNM|KSNM]], [[:Category:ENM|ENM]] or [[:Category:ISNM|ISNM]], which are all accepted inputs. [[:Category:Missions|Mission]] and [[:Category:Quests|Quest]] are also possible. | ||
** '''mission affiliation:''' ('' | ** '''mission affiliation:''' - '''(Optional)''' If '''type''' is set to [[:Category:Missions|Mission]] or [[:Category:Quests|Quest]], this parameter can be set to specify which storyline the battlefield belongs to, e.g. "San d'Oria", "Treasures of Aht Urhgan", etc. Commonly used abbreviations like "toau", "sandy", or "windy" are also accepted. ''This will set the color of the battlefield header according to the type of content!'' | ||
* '''zone:''' | * '''zone:''' - Zone where the battlefield is located. | ||
* '''location:''' | * '''location:''' - '''(Optional)''' Coordinates of the battlefield. e.g. F-10, G-9, A-1, etc. | ||
* '''location add:''' | * '''location add:''' - '''(Optional)''' Additional information about where to find the battlefield. | ||
* '''level:''' | * '''level:''' - Level cap of the battlefield. Use "75" if there are no restrictions. | ||
* '''members:''' | * '''members:''' - Maximum number of players that can participate in the battlefield. | ||
* '''time:''' | * '''time:''' - Time limit of the battlefield. | ||
* '''entry item:''' | * '''entry item:''' - The item or key item that is required to enter the battlefield. | ||
* '''notes:''' | * '''notes:''' - Any additional important information about the battlefield. | ||
==Usage== | ==Usage== | ||
| Line 16: | Line 16: | ||
| type = | | type = | ||
| zone = | | zone = | ||
| mission affiliation = | |||
| location = | | location = | ||
| location add = | |||
| level = | | level = | ||
| members = | | members = | ||
| Line 33: | Line 35: | ||
| time = 15 minutes | | time = 15 minutes | ||
| entry item = Cloudy Orb | | entry item = Cloudy Orb | ||
}}</div> | }}</div> | ||
<div class="flex-container-item-2"> | <div class="flex-container-item-2"> | ||
| Line 43: | Line 44: | ||
| time = 15 minutes | | time = 15 minutes | ||
| entry item = Cloudy Orb | | entry item = Cloudy Orb | ||
}}</pre></div></div> | }}</pre></div></div> | ||
| Line 55: | Line 55: | ||
| time = 15 minutes | | time = 15 minutes | ||
| location = F-10 | | location = F-10 | ||
| location add = Hut Door | | location add = Near the Hut Door. | ||
| entry item = Cloudy Orb | | entry item = Cloudy Orb | ||
| notes = | | notes = Notes optionally go here. | ||
}}</div> | }}</div> | ||
<div class="flex-container-item-2"> | <div class="flex-container-item-2"> | ||
| Line 68: | Line 68: | ||
| time = 15 minutes | | time = 15 minutes | ||
| location = F-10 | | location = F-10 | ||
| location add = Hut Door | | location add = Near the Hut Door. | ||
| entry item = Cloudy Orb | | entry item = Cloudy Orb | ||
| notes = | | notes = Notes optionally go here. | ||
}} | }} | ||
</pre></div><div> | </pre></div><div> | ||
Latest revision as of 20:20, 25 September 2025
Documentation
- name: - (Optional) No input is needed for the name of the battlefield, this will self-populate. In cases where the page name deviates from the battlefield title, name can be used to specify the name of the battlefield manually.
- type: - Links and auto-categorizes to Category:Battlefields and the type of battlefield eg. BCNM, KSNM, ENM or ISNM, which are all accepted inputs. Mission and Quest are also possible.
- mission affiliation: - (Optional) If type is set to Mission or Quest, this parameter can be set to specify which storyline the battlefield belongs to, e.g. "San d'Oria", "Treasures of Aht Urhgan", etc. Commonly used abbreviations like "toau", "sandy", or "windy" are also accepted. This will set the color of the battlefield header according to the type of content!
- zone: - Zone where the battlefield is located.
- location: - (Optional) Coordinates of the battlefield. e.g. F-10, G-9, A-1, etc.
- location add: - (Optional) Additional information about where to find the battlefield.
- level: - Level cap of the battlefield. Use "75" if there are no restrictions.
- members: - Maximum number of players that can participate in the battlefield.
- time: - Time limit of the battlefield.
- entry item: - The item or key item that is required to enter the battlefield.
- notes: - Any additional important information about the battlefield.
Usage
{{Battlefield Header
| type =
| zone =
| mission affiliation =
| location =
| location add =
| level =
| members =
| time =
| entry item =
| notes =
}}
Examples
Example 1
| Battlefield Header/Documentation | |
|---|---|
| Type: | BCNM |
| Zone: | Horlais Peak |
| Entry Item: | Cloudy Orb |
| Level: | 20 |
| Members: | 3 |
| Time: | 15 minutes |
{{Battlefield Header
| type = BCNM
| zone = Horlais Peak
| level = 20
| members = 3
| time = 15 minutes
| entry item = Cloudy Orb
}}Example 2
| Battlefield Header/Documentation | |
|---|---|
| Type: | BCNM |
| Zone: | Ghelsba Outpost (F-10) Near the Hut Door. |
| Entry Item: | Cloudy Orb |
| Level: | 20 |
| Members: | 3 |
| Time: | 15 minutes |
| Additional Information: | Notes optionally go here. |
{{Battlefield Header
| type = BCNM
| zone = Ghelsba Outpost
| level = 20
| members = 3
| time = 15 minutes
| location = F-10
| location add = Near the Hut Door.
| entry item = Cloudy Orb
| notes = Notes optionally go here.
}}
