Template:Quest Header: Difference between revisions

From HorizonXI Wiki
(Created page with "<nowiki>{{Quest Header |Expansion= |Start= |Description= |Fame= |FLevel= |Quest Reqs= |Level= |Repeatable= |Previous= |Next= |Title= |Reward= }}</nowiki> {{Quest Header |Expansion= |Start= |Description= |Fame= |FLevel= |Quest Reqs= |Level= |Repeatable= |Previous= |Next= |Title= |Reward= }}")
 
m (added option to disable the preview only infobox (useful when working and wanting to see the page preview))
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<nowiki>{{Quest Header
[[Category:Templates/Headers|{{PAGENAME}}]]
|Expansion=
<includeonly><onlyinclude><!--
|Start=
 
Cheat sheet that is only visible during preview
-->{{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}
| Description = {Ingame Quest Description}
| Fame = {Fame area the quest counts for}
| Fame Level = {Fame Level required to start the 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}
| 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]]{{#if:{{{Expansion|}}}|[[Category:{{Mission Header/ExpansionSwitch|{{{Expansion}}}}}_Quests]]|}}{{#if:{{{Start Location|}}}|{{Categorize Location|location={{{Start Location}}}|category type=Quests}}}}}}__NOTOC__
{| class="horizon-infobox infobox-quest infobox-34-66"
|-
! colspan="2" style="text-align: center;" | {{#if: {{{Quest Name|}}}|{{{Quest Name}}}|{{PAGENAME}}}}<!--
 
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|}}}|&nbsp;
{{!}}-
! 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|}}}|,&nbsp;|, {{Information Needed}}}}|{{{Start}}}<!--
    -->{{#if: {{{Start Location|}}}|,&nbsp;|}}<!--
  -->}}<!--
-->|}}<!--
-->{{#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|}}}}}<!--
-->|''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|}}}|&nbsp;
{{!}}-
! Level Restriction:
{{!}} {{#switch: {{lc:{{{Level}}}}}|false|n|no|none=''None''| #default=Level {{{Level}}}}}
}}<!--
 
 
Items Needed. row vanishes if none are given
-->{{#if: {{{Items Needed|}}} |&nbsp;
{{!}}-
! Items Needed
{{!}} {{{Items Needed}}}
}}<!--
 
 
Requirements. row vanishes if none are given
-->{{#if: {{{Requirements|}}} |&nbsp;
{{!}}-
! Additional Requirements
{{!}} {{{Requirements}}}
}}<!--
 
 
If a title is given, display it. If no input is given, assume that there is no title from this quest.
-->
|-
! Title
| {{#if: {{{Title|}}} | {{{Title}}} | ''None'' }}<!--
 
 
If repeatable is given as y or yes, then yes. If given as af or mem, then yes after memory reset. For anything else, display no.
-->{{#if: {{{HAAP|}}}{{{HAAP|}}}|&nbsp;
{{!}}-
! HAAP
{{!}} [[:category:Horizon Adventuring Assistance Program|{{{HAAP|}}}]]
}}<!--
-->
|-
! Repeatable
| {{#if:{{{Repeatable|}}}|<!--
-->{{#switch: {{lc:{{{Repeatable}}}}}<!--
-->|y|yes=''Yes''[[Category:Repeatable Quests|{{PAGENAME}}]]<!--
-->|avatar=''Yes, after Japanese midnight after receiving your reward.''<!--
-->|af|memory|memory reset|reset|mem=''Yes, after [[Memory reset]]''<!--
-->|#default=''No''<!--
-->}}<!--
-->}}<!--
 
 
If a description is given, display it. If none is given, the row vanishes.
-->{{#if: {{{Description|}}} |&nbsp;
{{!}}-
! Description
{{!}} {{{Description}}}
}}<!--
 
 
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;" {{!}} &larr; Previous Quest
! style="text-align: center;" {{!}} Next Quest &rarr;
{{!}}-
{{!}} 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}}
|Description=
|Description=
|Fame=
|Fame=san d'oria
|FLevel=
|Fame Level=1
|Quest Reqs=
|Level=50
|Level=
|Repeatable= no
|Repeatable=
|Title=Lord of the Test Quest
|Previous=
|Requirements= [[Paladin]] Lvl. 15<br>Access to [[Chateau d'Oraguille]]
|Next=
|Items Needed={{KeyItem}}[[Adventurer's Certificate]]<br>[[Onion Sword]]<br>[[Chocobo Feather]]
|Title=
|Rewards=[[Pebble]]<br>[[Blue Chip]]<br>1,000 gil
|Reward=
|Previous= [[Last Quest Link|Last Quest Name]]
}}</nowiki>
|Next= [[Follow up Quest 1]]<br>[[Follow up Quest 2]]
}}</pre>
 
===Example===


{{Quest Header
{{Quest Header|nc
|Expansion=
|Quest Name=Secrets of San d'Oria
|Start=
|Expansion= Chains of Promathia
|Description=
|Start=Prishe
|Fame=
|Start Location={{Location|Tavnazian Safehold|H-9}}
|FLevel=
|Fame=san d'oria
|Quest Reqs=
|Fame Level=1
|Level=
|Level=50
|Repeatable=
|Repeatable= no
|Previous=
|Title=Lord of the Test Quest
|Next=
|Requirements= [[Paladin]] Lvl. 15<br>Access to [[Chateau d'Oraguille]]
|Title=
|Items Needed={{KeyItem}}[[Adventurer's Certificate]]<br>[[Onion Sword]]<br>[[Chocobo Feather]]
|Reward=
|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===
*'''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.
*'''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.
*'''Level''' (optional): If there is a level requirement, specify it here. If nothing is given, the row will vanish.
*'''Repeatable''' (optional): If yes, will display ''Yes''. Can put {{fontaccent|af, memory, memory reset, reset or mem}} to display ''Yes, after [[Memory Reset]]''. 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 18:51, 29 June 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}}
|Description=
|Fame=san d'oria
|Fame Level=1
|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 
Expansion Chains of Promathia
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

  • 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.
  • 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: 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.
  • Level (optional): If there is a level requirement, specify it here. If nothing is given, the row will vanish.
  • Repeatable (optional): If yes, will display Yes. Can put af, memory, memory reset, reset or mem to display Yes, after Memory Reset. 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 [[name]] and use <br> to separate multiple entries.
  • 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.
  • 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.
Retrieved from "https://horizonffxi.wiki/w/index.php?title=Template:Quest_Header&oldid=53618"