Template:Quest Header: Difference between revisions
From HorizonXI Wiki
Tsukuyomiii (talk | contribs) No edit summary |
m (adding "zone" as option to the repeatable parameter and extended categorization for repeatable quests) |
||
| (50 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Quest Header | [[Category:Templates/Headers|{{PAGENAME}}]] | ||
|Expansion= [[ | <includeonly><onlyinclude> | ||
| | {{Quest Header/Help|{{{1}}}}}<!-- | ||
| | |||
| | -->{{categorize|{{{1|}}}|[[Category:Quests]]<!-- | ||
| | Mission Header/ExpansionSwitch returns blank if the expression is not recognized so condition for that instead of the parameter | ||
| | -->{{#if:{{Mission Header/ExpansionSwitch|{{{Expansion|}}}}}|[[Category:{{Mission Header/ExpansionSwitch|{{{Expansion}}}}} Quests]]|}}<!-- | ||
| | Categorize Location does the categorization by itself | ||
| | -->{{#if:{{{Start Location|}}}|{{Categorize Location|location={{{Start Location}}}|category type=Quests}}}}<!-- | ||
| | Quest Header/Type returns blank if the expression is not recognized so condition for that instead of the parameter | ||
| | -->{{#if:{{Quest Header/Type|{{{Type|}}}}}|[[Category:{{Quest Header/Type|{{{Type}}}}} Quests]]|}}<!-- | ||
| | |||
| | if Custom Content is true then categorize as such | ||
[[ | -->{{#if:{{{Custom Content|}}}|{{#switch:{{lc:{{{Custom Content}}}}} | ||
}} | | y | yes | true = [[Category:HorizonXI Custom Content/Quests]][[Category:HorizonXI Custom Content]] | ||
|#default= | |||
}}|}}<!-- | |||
if content has Horizon Changes then categorize as such | |||
-->{{#if:{{{Horizon Changes|}}}|{{#switch:{{lc:{{{Horizon Changes}}}}} | |||
| y | yes | true = [[Category:Horizon Changes]] | |||
|#default= | |||
}}|}}<!-- | |||
if quest is an artifact quest, categorize as such | |||
-->{{#if:{{{AF|}}}|{{#switch:{{lc:{{{AF}}}}} | |||
| y | yes | true = [[Category:Artifact Quests]] | |||
|#default= | |||
}}|}}<!-- | |||
if the quest is horizon custom then add the horizon custom icon to the name | |||
-->}}__NOTOC__ | |||
{| class="horizon-infobox infobox-quest infobox-34-66" | |||
|- | |||
! colspan="2" style="text-align: center;" | {{#if: {{{Quest Name|}}}|{{{Quest Name}}}|{{PAGENAME}}}}<!-- | |||
-->{{#if:{{{Custom Content|}}}|{{#switch:{{lc:{{{Custom Content}}}}} | |||
| y | yes | true = <nowiki> </nowiki>{{changes|HorizonXI Custom Quest|link=:Category:HorizonXI Custom Content/Quests{{!}}HorizonXI Custom Quests}} | |||
|#default=}} | |||
}}<!-- | |||
If expansion is given and recognized, display it. Else, the row vanishes. Commented out for now since the purpose for displaying in quests is not entirely clear | |||
--><!--{{#if: {{Mission Header/ExpansionSwitch|{{{Expansion|}}}}}| | |||
{{!}}- | |||
! Expansion | |||
{{!}} [[{{Mission Header/ExpansionSwitch|{{{Expansion}}}}}]] | |||
}}--><!-- | |||
If Start is given (npc) then display left side as Starting NPC, otherwise just as Start | |||
If Start is given, check if link exists and output as such. If Start is given but link does NOT exist AND Start Location does NOT exist, then display no comma and space or {{Information Needed}} (this is the fallback case and backwards compatibility for writing everything into the Start parameter). If with existing Start as link, Start Location exist, add a comma and a space (to display Start Location in the next step), otherwise display {{Information Needed}} as it is unclear where the npc is located. | |||
If Start Location exists, display it. | |||
If neither Start nor Start Location exist, display {{Information Needed}} (no information whatsoever) | |||
--> | |||
|- | |||
! {{#if: {{{Start|}}}|Starting NPC|Start}} | |||
| {{#if: {{{Start|}}} |<!-- | |||
-->{{#ifexist:{{{Start|}}}|[[{{{Start}}}]]<!-- | |||
-->{{#if: {{{Start Location|}}}|, |, {{Information Needed}}}}|{{{Start}}}<!-- | |||
-->{{#if: {{{Start Location|}}}|, |}}<!-- | |||
-->}}<!-- | |||
-->|}}<!-- | |||
-->{{#if: {{{Start Location|}}}|{{{Start Location}}}}}<!-- | |||
-->{{#if: {{{Start|}}}{{{Start Location|}}}| |{{Information Needed}}}}<!-- | |||
If Fame is not specified, the default output is ''None'' | |||
If Fame is given: if it is a recognized area, that area is displayed along with the Fame Level parameter (a number. {{Information Needed}} if none given. This is the best practice for use.). If it is not a recognized area, the parameter is given as is without outputting fame level (this is for backwards compatibility and the fallback for custom user input). | |||
--> | |||
|- | |||
! Required Fame | |||
| {{#if:{{{Fame|}}}|<!-- | |||
-->{{Quest Header/Fame Area|{{{1|}}}|Fame={{{Fame}}}|Fame Level={{{Fame Level|}}}}}<!-- | |||
-->{{#if:{{{Fame 2|}}}|<!-- | |||
--><br>{{Quest Header/Fame Area|{{{1|}}}|Fame={{{Fame 2}}}|Fame Level={{{Fame 2 Level|}}}}}<!-- | |||
-->|}}<!-- | |||
-->|''None''}}<!-- | |||
If no level restriction is given, the row will vanish | |||
If one is given, false, n, no and none trigger ''None'', | |||
else the output for XX is Level XX | |||
-->{{#if: {{{Level|}}}| | |||
{{!}}- | |||
! Level Restriction: | |||
{{!}} {{#switch: {{lc:{{{Level}}}}}|false|n|no|none=''None''| #default=Level {{{Level}}}}} | |||
}}<!-- | |||
Items Needed. row vanishes if none are given | |||
-->{{#if: {{{Items Needed|}}} | | |||
{{!}}- | |||
! Items Needed | |||
{{!}} {{{Items Needed}}} | |||
}}<!-- | |||
Requirements. row vanishes if none are given | |||
-->{{#if: {{{Requirements|}}} | | |||
{{!}}- | |||
! Additional Requirements | |||
{{!}} {{{Requirements}}} | |||
}}<!-- | |||
If a title is given, display it. If no input is given, assume that there is no title from this quest. | |||
--> | |||
|- | |- | ||
| {{#if: {{{ | ! Title | ||
| {{#if: {{{Title|}}} | {{{Title}}} | ''None'' }}<!-- | |||
-->{{#if:{{{HAAP|}}}| | |||
{{!}}- | |||
! HAAP | |||
{{!}} [[:category:Horizon Adventuring Assistance Program|{{{HAAP|}}}]] | |||
}}<!-- | |||
If repeatable is given as y or yes, then yes. If given as af or mem, then yes after memory reset. weekly and daily and eco warrior are other options. For anything else, display no. | |||
--> | |||
|- | |- | ||
{{#if: {{{ | ! Repeatable | ||
! | | {{#if:{{{Repeatable|}}}|<!-- | ||
-->{{#switch: {{lc:{{{Repeatable}}}}}<!-- | |||
-->|y|yes=''Yes''{{Categorize|{{{1|}}}|[[Category:Repeatable Quests]]}}<!-- | |||
-->|zone = ''Yes, after zoning.''{{Categorize|{{{1|}}}|[[Category:Repeatable Quests]]}}<!-- | |||
-->|avatar|daily=''Yes, after Japanese midnight after receiving your reward.''{{Categorize|{{{1|}}}|[[Category:Repeatable Quests]]}}<!-- | |||
-->|af|memory|memory reset|reset|mem=''Yes, after [[Memory reset]]''<!-- | |||
-->|conquest|weekly=''Yes, after the weekly Conquest Update.''{{Categorize|{{{1|}}}|[[Category:Repeatable Quests]]}}<!-- | |||
-->|eco|eco-warrior|eco warrior=''Yes, after clearing the other two nations' Eco-Warrior quests. One Eco-Warrior quest can be accepted per conquest period.''{{Categorize|{{{1|}}}|[[Category:Repeatable Quests]]}}<!-- | |||
-->|#default={{{Repeatable}}}<!-- | |||
-->}}<!-- | |||
-->|''No''}}<!-- | |||
If a description is given, display it. If none is given, the row vanishes. | |||
-->{{#if: {{{Description|}}} | | |||
{{!}}- | {{!}}- | ||
! Description | |||
{{!}} {{{Description}}} | |||
{{#if: {{{ | }}<!-- | ||
See Also. To be used if a related quest would be useful to be displayed. If none is given, it will disappear. | |||
-->{{#if: {{{See Also|}}}| | |||
{{!}}- | {{!}}- | ||
! See Also | |||
{{!}} {{{See Also}}} | |||
}}<!-- | |||
Rewards. If Rewards are given, display it. If none are given, outputs ''None'' | |||
--> | |||
|- | |- | ||
! colspan="2" style="text-align: center;" | Rewards | |||
|- | |- | ||
|} | | colspan="2" style="text-align: center;" | {{#if:{{{Rewards|}}}|{{{Rewards}}}|''None''}} | ||
</ | |}<!-- | ||
</ | |||
</ | end main box. start previous/next box | ||
If either previous and/or next are given, then display the box. If neither are given, then no box. | |||
--> | |||
{{#if:{{{Previous|}}}{{{Next|}}}| | |||
{<!--open table-->{{!}} class="horizon-infobox infobox-quest infobox-50-50" style="text-align: center;" | |||
{{!}}- | |||
! style="text-align: center;" {{!}} ← Previous Quest | |||
! style="text-align: center;" {{!}} Next Quest → | |||
{{!}}- | |||
{{!}} style="vertical-align: middle;" {{!}} {{#if:{{{Previous|}}}|{{{Previous}}}|''None''}} | |||
{{!}} style="vertical-align: middle;" {{!}} {{#if:{{{Next|}}}|{{{Next}}}|''None''}} | |||
{{!}}<!--close table-->} | |||
}}<!-- | |||
--></onlyinclude></includeonly> | |||
==Usage== | |||
===Code=== | |||
<pre>{{Quest Header | |||
| Quest Name = Secrets of San d'Oria | |||
| Expansion = Chains of Promathia | |||
| Start = Prishe | |||
| Start Location = {{Location|Tavnazian Safehold|H-9}} | |||
| Start Location Add = Breakaway Bridge | |||
| Description = | |||
| Fame = san d'oria | |||
| Fame Level = 1 | |||
| Type = general | |||
| Level = 50 | |||
| Repeatable = no | |||
| Title = Lord of the Test Quest | |||
| Requirements = [[Paladin]] Lvl. 15<br>Access to [[Chateau d'Oraguille]] | |||
| Items Needed = {{KeyItem}}[[Adventurer's Certificate]]<br>[[Onion Sword]]<br>[[Chocobo Feather]] | |||
| Rewards = [[Pebble]]<br>[[Blue Chip]]<br>1,000 gil | |||
| Previous = [[Last Quest Link|Last Quest Name]] | |||
| Next = [[Follow up Quest 1]]<br>[[Follow up Quest 2]] | |||
}}</pre> | |||
===Example=== | |||
{{Quest Header|nc | |||
|Quest Name=Secrets of San d'Oria | |||
|Expansion= Chains of Promathia | |||
|Start=Prishe | |||
|Start Location={{Location|Tavnazian Safehold|H-9}} | |||
|Start Location Add = Breakaway Bridge | |||
|Fame=san d'oria | |||
|Fame Level=1 | |||
|Type=general | |||
|Level=50 | |||
|Repeatable= no | |||
|Title=Lord of the Test Quest | |||
|Requirements= [[Paladin]] Lvl. 15<br>Access to [[Chateau d'Oraguille]] | |||
|Items Needed={{KeyItem}}[[Adventurer's Certificate]]<br>[[Onion Sword]]<br>[[Chocobo Feather]] | |||
|Description=This is a quest, please do what the questlog says. You will die but you will have plot armor. | |||
|Rewards=[[Pebble]]<br>[[Blue Chip]]<br>1,000 gil | |||
|Previous= [[Last Quest Link|Last Quest Name]] | |||
|Next= [[Follow up Quest 1]]<br>[[Follow up Quest 2]] | |||
}} | |||
===Documentation=== | |||
{{Template:Quest Header/Documentation}} | |||
Latest revision as of 18:32, 21 November 2024
Usage
Code
{{Quest Header
| Quest Name = Secrets of San d'Oria
| Expansion = Chains of Promathia
| Start = Prishe
| Start Location = {{Location|Tavnazian Safehold|H-9}}
| Start Location Add = Breakaway Bridge
| Description =
| Fame = san d'oria
| Fame Level = 1
| Type = general
| Level = 50
| Repeatable = no
| Title = Lord of the Test Quest
| Requirements = [[Paladin]] Lvl. 15<br>Access to [[Chateau d'Oraguille]]
| Items Needed = {{KeyItem}}[[Adventurer's Certificate]]<br>[[Onion Sword]]<br>[[Chocobo Feather]]
| Rewards = [[Pebble]]<br>[[Blue Chip]]<br>1,000 gil
| Previous = [[Last Quest Link|Last Quest Name]]
| Next = [[Follow up Quest 1]]<br>[[Follow up Quest 2]]
}}
Example
| Secrets of San d'Oria | |
|---|---|
| Starting NPC | Prishe, Tavnazian Safehold (H-9) |
| Required Fame | San d'Oria Level 1 |
| Level Restriction: | Level 50 |
| Items Needed |  Adventurer's CertificateOnion Sword Chocobo Feather |
| Additional Requirements | Paladin Lvl. 15 Access to Chateau d'Oraguille |
| Title | Lord of the Test Quest |
| Repeatable | no |
| Description | This is a quest, please do what the questlog says. You will die but you will have plot armor. |
| Rewards | |
| Pebble Blue Chip 1,000 gil | |
| ← Previous Quest | Next Quest → |
|---|---|
| Last Quest Name | Follow up Quest 1 Follow up Quest 2 |
Documentation
- First unnamed Parameter (optional): You can set the first unnamed parameter to:
- nc (no category) to prevent automatic categorization (e.g. for example pages)
- nd (no documentation) to suppress the preview documentation (helpful in the editing process)
- bp (boilerplate) to have the preview documentation without comments so you can just copy it to the page (helpful for creating new pages to just start with {{Quest Header|bp}} and copy the boilerplate from the preview only)
- Quest Name (optional): Name of the quest. If not given, will take the page name.
- Expansion (optional): Expansion the Quest was shipped with. If not given, the row will not be displayed. The Expansion parameter is case insensitive and can use the following inputs:
- rise of the zilart, zilart or rotz will all display as Rise of the Zilart.
- chains of promathia, promathia or cop will all display as Chains of Promathia.
- treasures of aht urhgan, aht urhgan or toau will all display as Treasures of Aht Urhgan.
- wings of the goddess, wings or wotg will all display as Wings of the Goddess.
- seekers of adoulin, seekers, adoulin or soa will all display as Seekers of Adoulin.
- abyssea will display as Abyssea.
- Start and Start Location (mandatory): Will display
if both are left blank.
- Start refers to the NPC or Event that triggers the start of the Quest. If the Quest is triggered by entering an area, leave this field blank.
- Start Location refers to the position of the NPC or the area triggering the quest. Use Template:Location as input.
- Start Location Add (optional): Use the ingame names of locations often given in the quest description. (so far not shown on the page and only for retaining the information)
- Fame (mandatory): Fame area or none. Will display if left blank. Fame area is case insensitive, Valid fame areas:
- None: none
- Main Cities: bastok, san d'oria/sandoria, windurst, jeuno
- Others: kazham/mhaura, selbina/rabao/selbina and rabao, norg/tenshodo
- Abyssea zones:
- Vision: abyssea - la theine, abyssea - konschtat, abyssea - tahrongi
- Scars: abyssea - attohwa, abyssea - misareaux, abyssea - vunkerl
- Heroes: abyssea - altepa, abyssea - grauberg, abyssea - uleguerand
- Adoulin: adoulin
- Note that the output of the template might not match the input, e.g. inputting "kazham" or "mhaura" will both output "windurst" since they share the same fame.
- Fame Level (mandatory unless Fame is none): Fame Level required in the Fame area to trigger the quest.
- Fame 2 (optional): Additional Fame area, if required. Will disappear if left blank. Fame area is case insensitive, Valid fame areas are same as Fame parameter.
- Fame 2 Level (mandatory if Fame 2 parameter is set): Fame 2 Level required in the additional Fame 2 area to trigger the quest.
- Type (optional): type of the quest, e.g. general, map, job unlock, weapon skill, ... (so far not shown on the page and only for retaining the information)
- Level (optional): If there is a level requirement, specify it here. If nothing is given, the row will vanish.
- Repeatable (optional):
- yes to display Yes.
- no to display No.
- zone to display Yes, after zoning.
- af, memory, memory reset, reset, mem to display Yes, after Memory Reset.,
- avatar, daily to display Yes, after japanese midnight.
- conquest, weekly to display Yes, after weekly conquest.
- eco-warrior, eco warrior, eco to display: Yes, after clearing the other two nations' Eco-Warrior quests. One Eco-Warrior quest can be accepted per conquest period.
- Otherwise will display No by default. Still, best practice is to fill this field in case of no to signal to editors, that its not unknown.
- AF: If this quest is an artifact armor quest, set to yes/y/true and then the Quest will be categorized as Category:Artifact Armor.
- HAAP (optional): If HAAP points are available, use the format "# points". Parameter doesn't appear if not set.
- Title (optional): Title obtained from the Quest. If nothing is given, the assumption is there is no title and will display None.
- Requirements and Items Needed (optional): Items Needed refers to any item or key item needed for this quest. Requirements refers to anything that is not an item, like having access to an area, a certain job unlocked, .... The box vanishes if neither Requirements nor Items Needed exist.
- Enter entries as links if possible like [[name]] and use <br> to separate multiple entries.
- Description (optional): Quest Description as displayed in the Quest log. Row will vanish if left blank.
- See Also (optional): Any additional related quests.
- Rewards (optional): Rewards obtained by completing the quest.
- Enter entries as links if possible like [[name]] and use <br> to separate multiple entries.
- Previous and Next (optional): Refer to the name of the corresponding quests (case-sensitive). The box will vanish if neither previous nor next quests exist.
- Enter entries as links if possible like [[name]] and use <br> to separate multiple entries.
- Custom Content: If set to yes/y/true, then the Quest will be categorized as Category:HorizonXI Custom Content/Quests and Category:HorizonXI Custom Content.
- Horizon Changes: If set to yes/y/true, then the Quest will be categorized as Category:Horizon Changes.
- Categories are automatically added accordingly with this template.
- Note: The preview infobox can be disabled by setting the first unnamed parameter of the template to nd, no doc or no documentation. This is meant to make the user experience better when working on a page and the preview infobox is filling the page preview.
