Template:Quest Header: Difference between revisions

From HorizonXI Wiki
m (documentation updated to include Fame 2 and Fame 2 Level parameter)
m (redirected to correct category)
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Templates/Headers|{{PAGENAME}}]]
[[Category:Templates/Headers|{{PAGENAME}}]]
<includeonly><onlyinclude><!--
<includeonly><onlyinclude>
 
{{Quest Header/Help|{{{1}}}}}<!--
Cheat sheet that is only visible during preview
-->{{#switch:{{{1|}}}|bp|boilerplate={{Preview Only Infobox|<pre>{{Quest Header
| Quest Name =
| Expansion =
| Start =
| Start Location =
| Start Location Add =
| Description =
| Fame =
| Fame Level =
| Fame 2 =
| Fame 2 Level =
| Type =
| Level =
| Requirements =
| Items Needed =
| Repeatable =
| HAAP =
| Title =
| Rewards =
| Previous =
| Next =
}}
</pre>|disable={{{1|}}}}}<!--
-->|#default={{Preview Only Infobox|<pre>{{Quest Header
| Quest Name = {Name of the Quest}
| Expansion = {Expansion the Quest belongs to}
| Start = {NPC name that starts the quest}
| Start Location = {Location template}
| Start Location Add = {Ingame name of the Location vicinity}
| Description = {Ingame Quest Description}
| Fame = {Fame area the quest counts for}
| Fame Level = {Fame Level required to start the quest}
| Fame 2 = {Additional Fame area the quest counts for}
| Fame 2 Level = {Additional Fame Level required to start the quest}
| Type = {Type of Quest}
| Level = {Required Level to complete the quest}
| Requirements = {Requirements to ACCEPT the quest}
| Items Needed = {Items Needed to COMPLETE the quest}
| Repeatable = {yes/no/af/conquest}
| HAAP = {# points}
| Title = {Title(s) obtained thoughout the quest}
| Rewards = {Rewards obtained for COMPLETING the quest}
| Previous = [[Last Quest Link|Last Quest Name]]
| Next = [[Follow up Quest 1]]<br>[[Follow up Quest 2]]
}}
</pre>|disable={{{1|}}}}}}}<!--


-->{{categorize|{{{1|}}}|[[Category:Quests]]<!--
-->{{categorize|{{{1|}}}|[[Category:Quests]]<!--
-->{{#if:{{{Expansion|}}}|[[Category:{{Mission Header/ExpansionSwitch|{{{Expansion}}}}}_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}}}}<!--
-->{{#if:{{{Start Location|}}}|{{Categorize Location|location={{{Start Location}}}|category type=Quests}}}}<!--
--><!--{{#if:{{{Type|}}}|{{Quest Header/Type|{{{Type}}}|oc}}|}}--><!--
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__
-->}}__NOTOC__
{| class="horizon-infobox infobox-quest infobox-34-66"
{| class="horizon-infobox infobox-quest infobox-34-66"
|-
|-
! colspan="2" style="text-align: center;" | {{#if: {{{Quest Name|}}}|{{{Quest Name}}}|{{PAGENAME}}}}<!--
! 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 recognize, display it. If it is given and not recognized, it will display a blank field. If nothing is given, the row vanishes.  
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: {{{Expansion|}}}|&nbsp;
--><!--{{#if: {{Mission Header/ExpansionSwitch|{{{Expansion|}}}}}|&nbsp;
{{!}}-
{{!}}-
! Expansion
! Expansion
{{!}} {{Mission Header/ExpansionSwitch|{{{Expansion}}}}}
{{!}} [[{{Mission Header/ExpansionSwitch|{{{Expansion}}}}}]]
}}<!--
}}--><!--




Line 90: Line 70:
! Required Fame
! Required Fame
| {{#if:{{{Fame|}}}|<!--
| {{#if:{{{Fame|}}}|<!--
-->{{Quest Header/Fame Area|{{{1|}}}|Fame={{{Fame}}}|Fame Level={{{Fame Level|}}}}}<br>{{Quest Header/Fame Area|{{{1|}}}|Fame={{{Fame 2}}}|Fame Level={{{Fame 2 Level|}}}}}<!--
-->{{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''}}<!--
-->|''None''}}<!--




Line 127: Line 111:


   
   
-->{{#if: {{{HAAP|}}}{{{HAAP|}}}|&nbsp;
-->{{#if:{{{HAAP|}}}|&nbsp;
{{!}}-
{{!}}-
! HAAP
! HAAP
Line 155: Line 139:
{{!}} {{{Description}}}
{{!}} {{{Description}}}
}}<!--
}}<!--
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|}}}|&nbsp;
{{!}}-
! See Also
{{!}} {{{See Also}}}
}}<!--




Line 228: Line 222:


===Documentation===
===Documentation===
*'''First unnamed Parameter''' (optional): You can set the first unnamed parameter to:
{{Template:Quest Header/Documentation}}
** ''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 {{fontaccent|<nowiki>{{Quest Header|bp}}</nowiki>}} 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:
**{{fontaccent|rise of the zilart, zilart or rotz}} will all display as Rise of the Zilart.
**{{fontaccent|chains of promathia, promathia or cop}} will all display as Chains of Promathia.
**{{fontaccent|treasures of aht urhgan, aht urhgan or toau}} will all display as Treasures of Aht Urhgan.
**{{fontaccent|wings of the goddess, wings or wotg}} will all display as Wings of the Goddess.
**{{fontaccent|seekers of adoulin, seekers, adoulin or soa}} will all display as Seekers of Adoulin.
**{{fontaccent|abyssea}} will display as Abyssea.
*'''Start''' and '''Start Location''' (mandatory): Will display {{Information Needed}} 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)''
*'''Description''' (optional): Quest Description as displayed in the Quest log. Row will vanish if left blank.
*'''Fame''' (mandatory): Fame area or none. Will display {{Information Needed}} if left blank. Fame area is case insensitive, Valid fame areas:
**None: {{fontaccent|none}}
**Main Cities: {{fontaccent|bastok, san d'oria/sandoria, windurst, jeuno}}
**Others: {{fontaccent|kazham/mhaura, selbina/rabao/selbina and rabao, norg/tenshodo}}
**Abyssea zones:
***Vision: {{fontaccent|abyssea - la theine, abyssea - konschtat, abyssea - tahrongi}}
***Scars: {{fontaccent|abyssea - attohwa, abyssea - misareaux, abyssea - vunkerl}}
***Heroes: {{fontaccent|abyssea - altepa, abyssea - grauberg, abyssea - uleguerand}}
**Adoulin: {{fontaccent|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 {{fontaccent|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):
**{{fontaccent|yes}} to display ''Yes.''
**{{fontaccent|no}} to display ''No.''
**{{fontaccent|af, memory, memory reset, reset, mem}} to display ''Yes, after [[Memory Reset]].'',
**{{fontaccent|avatar, daily}} to display ''Yes, after japanese midnight.''
**{{fontaccent|conquest, weekly}} to display ''Yes, after weekly conquest''.
: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.
* '''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 {{fontaccent|<nowiki>[[name]]</nowiki>}} and use {{fontaccent|<nowiki><br></nowiki>}} to separate multiple entries.
*'''Rewards''' (optional):  Rewards obtained by completing the quest.
::'''Enter entries as links''' if possible like {{fontaccent|<nowiki>[[name]]</nowiki>}} and use {{fontaccent|<nowiki><br></nowiki>}} 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 {{fontaccent|<nowiki>[[name]]</nowiki>}} and use {{fontaccent|<nowiki><br></nowiki>}} to separate multiple entries.
<!--**If an alternate name must be specified for Previous/Next (that isn't the name of the article), use the <nowiki>{{!}}</nowiki> template as a pipe | separator.
::Example: Name of quest is "The greatest Quest ever" but corresponding wiki page is found at "Great_Quest" then you would use: '''<span style="font-family:monospace;"><nowiki>Great_Quest{{!}}The greatest Quest ever</nowiki></span>'''-->
*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.''

Revision as of 21:32, 18 September 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 Key ItemAdventurer's Certificate
Onion 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 Information Needed 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 Information Needed 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.
  • 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.
Retrieved from "https://horizonffxi.wiki/w/index.php?title=Template:Quest_Header&oldid=62061"