Template:Battlefield Header/Documentation: Difference between revisions

From HorizonXI Wiki
mNo edit summary
(improved documentation clarity)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
==Documentation==
==Documentation==
* No input is needed for the name of the battlefield, this will self-populate.
* '''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. [[:Category:BCNM|BCNM]], [[:Category:KSNM|KSNM]], [[:Category:ENM|ENM]] or [[:Category:ISNM|ISNM]], which are all accepted inputs.
* '''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.
* '''zone:''' = Zone of the battlefield
** '''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!''
* '''location:''' = '''Optional parameter''' When set it allows the editos to specify a location in case the zone is a map. See below examples.
* '''zone:''' - Zone where the battlefield is located.
* '''level:''' = Level cap for the battlefield. Use "75" if there are no restrictions.
* '''location:''' - '''(Optional)''' Coordinates of the battlefield. e.g. F-10, G-9, A-1, etc.
* '''members:''' = Maximum amount of players that can participate in the battlefield.
* '''location add:''' - '''(Optional)''' Additional information about where to find the battlefield.
* '''time:''' = Time limit of the battlefield.
* '''level:''' - Level cap of the battlefield. Use "75" if there are no restrictions.
* '''entry item:''' = The item or key item that is required to enter the battlefield
* '''members:''' - Maximum number of players that can participate in the battlefield.
* '''notes:''' = Any additional important information about 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==
==Usage==
Line 14: Line 16:
| type =  
| type =  
| zone =  
| zone =  
| mission affiliation =
| location =  
| location =  
| location add =
| level =  
| level =  
| members =  
| members =  
Line 24: Line 28:
==Examples==
==Examples==
=== Example 1 ===
=== Example 1 ===
<div class="flex-container">
<div class="flex-container"><div class="flex-container-item-2">{{Battlefield Header|nd
<div class="flex-container-item-2">
{{Battlefield Header
| type = BCNM
| type = BCNM
| zone = Horlais Peak
| zone = Horlais Peak
Line 33: Line 35:
| time = 15 minutes
| time = 15 minutes
| entry item = Cloudy Orb
| entry item = Cloudy Orb
| notes =
}}</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
| notes =
}}</pre></div></div>
}}</pre></div></div>


=== Example 2 ===
=== Example 2 ===
<div class="flex-container">
<div class="flex-container"><div class="flex-container-item-2"><!--
<div class="flex-container-item-2">
-->{{Battlefield Header|nd
{{Battlefield Header
| type = BCNM
| type = BCNM
| zone = Ghelsba Outpost
| zone = Ghelsba Outpost
Line 55: Line 54:
| members = 3
| members = 3
| time = 15 minutes
| time = 15 minutes
| location = Hut Door at ({{Location Tooltip|area=Ghelsba Outpost|pos=F-10}})
| location = F-10
| 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 67: Line 67:
| members = 3
| members = 3
| time = 15 minutes
| time = 15 minutes
| location = Hut Door at ({{Location Tooltip|area=Ghelsba Outpost|pos=F-10}})
| location = F-10
| 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.
}}
Retrieved from "https://horizonffxi.wiki/w/index.php?title=Template:Battlefield_Header/Documentation&oldid=111712"