Difference between revisions of "Template:Quest Header/Doc"

The Beyond Skyrim Wiki — Hosted by UESP
Jump to: navigation, search
m (Add template protected notice)
 
m (→‎Parameters: example)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<includeonly>{{TemProtect}}</includeonly>
 
 
== Summary ==
 
== Summary ==
 
This template displays an informative table about a given quest and should be applied at the top of all quests pages.
 
This template displays an informative table about a given quest and should be applied at the top of all quests pages.
  
 
== Parameters ==
 
== Parameters ==
−
Please note that currently, some parameters are lower-case, others are mixed-case. Any that don't follow the pattern of Xxxx will allow for all possible case combinations for backwards compatibility and ease of use. The parameters below use the "official" case used by the template. It may be desirable in future to convert these all to lower-case for consistency with most other templates.
+
Please note that currently, some parameters are lower-case, others are mixed-case. The parameters below indicate the correct case used by the template. It may be desirable in future to convert these all to lower-case for consistency with most other templates.
  
−
{{Parameters
+
{| class="wikitable"
−
|description|required|A description of the quest.
+
!colspan="3"| {{{template|{{BASEPAGENAME}}}}}
−
|image|required|A thumbnail image of some part of the quest.  If this parameter is missing, a [[Template:NeedsImage|NeedsImage]] banner will automatically be added to the quest article.  In cases where an image is truly never needed, set image to "none".
+
|-
−
|TOClimit|optional|Limit the header levels displayed in the table of contents.
+
! Parameter !! Scope !! Description
−
|Icon|optional|The in-game icon for the quest. The name of the image is all that is needed — do not use <nowiki>[[File:...]] or [[Image:...]]</nowiki>.
+
|-
−
|addabove<br>addbelow|optional|Anything that should be added above or below the quest information table.
+
|description||required||A description of the quest.
−
|Giver|optional|Whoever gives you the quest, and where to find them.
+
|-
−
|Loc|optional|The locations you travel to in order to complete the quest (displays "None" if not specified). There is no need to include the location of the Giver in this list if it was already provided there.
+
|image||required||A thumbnail image of some part of the quest.  If this parameter is missing, a [[Template:NeedsImage|NeedsImage]] banner will automatically be added to the quest article.  In cases where an image is truly never needed, set image to "none".
−
|Prev|optional|If a series quest, the quest that needs to be completed before this one.
+
|-
−
|Next|optional|If a series quest, the quest that is presented to the player after completion.
+
|TOClimit||optional||Limit the header levels displayed in the table of contents.
−
|Conc|optional|If a series quest, any quest that can be done at the same time.
+
|-
−
|Reward|optional|Any gifts given to the player after a quest is completed (displays "None" if not specified).
+
|Icon||optional||The in-game icon for the quest. The name of the image is all that is needed — do not use <nowiki>[[File:...]] or [[Image:...]]</nowiki>.
−
|Disp|optional|Any Disposition bonuses earned by completing the quest.
+
|-
−
|Rep|optional|Any Reputation bonuses earned by completing the quest.
+
|addbelow||optional||Anything that should be added below the quest information table.
−
|Fame|optional<br>''Oblivion only''|Any fame and/or infamy points that will be added when the player completes the quest.
+
|-
−
|ID|optional|The editor identification of a quest.
+
|Giver||required||Whoever gives you the quest, and where to find them.
−
|ReqRank|optional|The required faction rank needed to begin the quest.
+
|-
−
|ReqRep|optional|Reputation required to receive the quest.
+
|Loc||required||The locations you travel to in order to complete the quest. There is no need to include the location of the Giver in this list if it was already provided there.
−
|ReqItem|optional|Any items that are required during the duration of the quest.
+
|-
−
|Prereq|optional|Any prerequisites not covered by other parameters.
+
|Prev||optional||If a series quest, the quest that needs to be completed before this one.
−
|SuggItem|optional|Any items that may be of use to the player during the quest.
+
|-
−
|SuggSpell|optional|Any spells that may be of use to the player during the quest.
+
|Next||optional||If a series quest, the quest that is presented to the player after completion.
−
|ReqLevel|optional|The level the player must be in order to begin the quest.
+
|-
−
|SuggLevel|optional|The level the player should be before beginning the quest.
+
|Conc||optional||If a series quest, any quest that can be done at the same time.
−
|Time|optional|The time it takes to do the quest, or time limit if there is one.
+
|-
−
|Difficulty|optional|The difficulty of the quest. (Different standards have been used historically. For future use, please use Easy, Medium, Hard.)
+
|Reward||required||Any gifts given to the player after a quest is completed.
−
|imgdesc|optional|A description of the thumbnail image.
+
|-
−
|mod|optional|Name of mod that adds the quest (if not in baseline version of game).
+
|Disp||optional||Any Disposition bonuses earned by completing the quest.
−
|nothumb|optional|Set nothumb{{=}}yes to force the image to be shown at full size rather than thumbnailed. This should only be used in exceptional cases, such as when the source image is an animated image.
+
|-
−
}}<includeonly>[[Category:Header Templates]][[Category:MetaTemplate-Templates Using Save]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>
+
|ID||optional||The editor identification of a quest.
 +
|-
 +
|ReqRank||optional||The required faction rank needed to begin the quest.
 +
|-
 +
|ReqItem||optional||Any items that are required during the duration of the quest.
 +
|-
 +
|Prereq||optional||Any prerequisites not covered by other parameters.
 +
|-
 +
|SuggItem||optional||Any items that may be of use to the player during the quest.
 +
|-
 +
|SuggSpell||optional||Any spells that may be of use to the player during the quest.
 +
|-
 +
|ReqLevel||optional||The level the player must be in order to begin the quest.
 +
|-
 +
|SuggLevel||optional||The level the player should be before beginning the quest.
 +
|-
 +
|Time||optional||The time it takes to do the quest, or time limit if there is one.
 +
|-
 +
|Difficulty||optional||The difficulty of the quest.
 +
|-
 +
|imgdesc||optional||A description of the thumbnail image.
 +
|-
 +
|mod||optional||Name of mod that adds the quest.
 +
|-
 +
|nothumb||optional||Set nothumb{{=}}yes to force the image to be shown at full size rather than thumbnailed. This should only be used in exceptional cases, such as when the source image is an animated image.
 +
|}
 +
 
 +
==Example==
 +
<pre>
 +
{{Quest Header
 +
|Giver=[[Skyrim:Esbern|Esbern]]
 +
|Reward=[[Skyrim:Dragonbane|Dragonbane]]
 +
|Rep=
 +
|Prev=[[Skyrim:A Cornered Rat|A Cornered Rat]]
 +
|Conc=
 +
|Next=[[Skyrim:The Throat of the World|The Throat of the World]]
 +
|Loc=
 +
|Image=SR-quest-Alduin's Wall.jpg
 +
|ImgDesc=Alduin's Wall
 +
|description=Locate the prophecy within [[Skyrim:Sky Haven Temple|Sky Haven Temple]].
 +
|ID=MQ203
 +
|Icon=SR-qico-Main.png
 +
}}
 +
</pre>
 +
{{Quest Header
 +
|Giver=[[Skyrim:Esbern|Esbern]]
 +
|Reward=[[Skyrim:Dragonbane|Dragonbane]]
 +
|Rep=
 +
|Prev=[[Skyrim:A Cornered Rat|A Cornered Rat]]
 +
|Conc=
 +
|Next=[[Skyrim:The Throat of the World|The Throat of the World]]
 +
|Loc=
 +
|Image=SR-quest-Alduin's Wall.jpg
 +
|ImgDesc=Alduin's Wall
 +
|description=Locate the prophecy within [[Skyrim:Sky Haven Temple|Sky Haven Temple]].
 +
|ID=MQ203
 +
|Icon=SR-qico-Main.png
 +
}}
 +
 
 +
 
 +
<includeonly>[[Category:Header Templates]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>

Latest revision as of 19:01, 30 June 2017

Summary[edit]

This template displays an informative table about a given quest and should be applied at the top of all quests pages.

Parameters[edit]

Please note that currently, some parameters are lower-case, others are mixed-case. The parameters below indicate the correct case used by the template. It may be desirable in future to convert these all to lower-case for consistency with most other templates.

Quest Header
Parameter Scope Description
description required A description of the quest.
image required A thumbnail image of some part of the quest. If this parameter is missing, a NeedsImage banner will automatically be added to the quest article. In cases where an image is truly never needed, set image to "none".
TOClimit optional Limit the header levels displayed in the table of contents.
Icon optional The in-game icon for the quest. The name of the image is all that is needed — do not use [[File:...]] or [[Image:...]].
addbelow optional Anything that should be added below the quest information table.
Giver required Whoever gives you the quest, and where to find them.
Loc required The locations you travel to in order to complete the quest. There is no need to include the location of the Giver in this list if it was already provided there.
Prev optional If a series quest, the quest that needs to be completed before this one.
Next optional If a series quest, the quest that is presented to the player after completion.
Conc optional If a series quest, any quest that can be done at the same time.
Reward required Any gifts given to the player after a quest is completed.
Disp optional Any Disposition bonuses earned by completing the quest.
ID optional The editor identification of a quest.
ReqRank optional The required faction rank needed to begin the quest.
ReqItem optional Any items that are required during the duration of the quest.
Prereq optional Any prerequisites not covered by other parameters.
SuggItem optional Any items that may be of use to the player during the quest.
SuggSpell optional Any spells that may be of use to the player during the quest.
ReqLevel optional The level the player must be in order to begin the quest.
SuggLevel optional The level the player should be before beginning the quest.
Time optional The time it takes to do the quest, or time limit if there is one.
Difficulty optional The difficulty of the quest.
imgdesc optional A description of the thumbnail image.
mod optional Name of mod that adds the quest.
nothumb optional Set nothumb=yes to force the image to be shown at full size rather than thumbnailed. This should only be used in exceptional cases, such as when the source image is an animated image.

Example[edit]

{{Quest Header
|Giver=[[Skyrim:Esbern|Esbern]]
|Reward=[[Skyrim:Dragonbane|Dragonbane]]
|Rep=
|Prev=[[Skyrim:A Cornered Rat|A Cornered Rat]]
|Conc=
|Next=[[Skyrim:The Throat of the World|The Throat of the World]]
|Loc=
|Image=SR-quest-Alduin's Wall.jpg
|ImgDesc=Alduin's Wall
|description=Locate the prophecy within [[Skyrim:Sky Haven Temple|Sky Haven Temple]].
|ID=MQ203
|Icon=SR-qico-Main.png
}}
This article could benefit from an image.
See Help:Images for information on how to upload images. Please remove this template from the page when finished.
 
0px
 Locate the prophecy within Sky Haven Temple.
Quest Giver: Esbern
Location(s):
Prerequisite Quest: A Cornered Rat
Next Quest: The Throat of the World
Reward: Dragonbane
ID: MQ203
   
Retrieved from "https://wiki.beyondskyrim.org/w/index.php?title=Template:Quest_Header/Doc&oldid=156"