Difference between revisions of "Template:Quest/Documentation"

From GodWiki
Jump to: navigation, search
m (Undo revision 99999 by WardPhoenix (talk))
(Tag: Undo)
m (typo)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
As well as automatically categorizing an article into [[:Category:Quests]], this template supplies some standard information about the subject of the article.
+
As well as automatically categorizing an article into [[:Category:Quests]], this template supplies some standard information about the subject of the article. For details on how to create a quest article, refers to the [[Creators Manual]] and the [[Guideline: Quest Articles]].
  
 
== Parameters ==
 
== Parameters ==
Line 6: Line 6:
 
:;{{para|caption|<var>Image description</var>}} : ''Optional'' — Use only if {{para|image}} is also set. Text of a descriptive caption to display beneath the image.
 
:;{{para|caption|<var>Image description</var>}} : ''Optional'' — Use only if {{para|image}} is also set. Text of a descriptive caption to display beneath the image.
  
;{{para|type|<var>Mini,Normal,Epic</var>}} : ''Required'' — What kind of quest it is (default: ''Unknown'').
+
;{{para|type|<var>Mini,Normal,Epic</var>}} : ''Required'' — What kind of quest it is (default: ''Normal'').
 
: ''('''Note:''' Setting {{para|type}} will auto-categorize the article into the appropriate quest sub-category.)''
 
: ''('''Note:''' Setting {{para|type}} will auto-categorize the article into the appropriate quest sub-category.)''
  
 
; {{para|description}} : ''Optional'' — Brief description of the quest.
 
; {{para|description}} : ''Optional'' — Brief description of the quest.
 +
: ''('''Note:''' Unlike other infoboxes, description is displayed above the picture, below the progress bar.)''
 +
 +
; {{para|status}} : ''Optional'' — Fill the bar according to the number.
 +
: ''('''Exemple:'''{{para|status|25}} will display a bar filled at 25%)''
 +
 +
; {{para|number}} : ''Optional'' — Give a non-meta number to the quest.
  
 
; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox.
 
; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox.
Line 15: Line 21:
 
==Example of Use==
 
==Example of Use==
  
<pre><nowiki>{{quest
+
<pre><nowiki>
 +
{{quest
 
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
 
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
 +
| caption= <!-- An appropriate caption for the picture -->
 
| type = <!-- What kind of quest it is. Can be: Mini, Normal, Epic. -->
 
| type = <!-- What kind of quest it is. Can be: Mini, Normal, Epic. -->
| description =  
+
| number = <!-- A non-meta number given to the quest -->
}}</nowiki></pre>
+
| status = <-- Percentage of progression displayed on the progress bar -->
 +
| description = <!-- A short description -->
 +
}}
 +
 
 +
</nowiki></pre>
 +
'''Mini-quest Exemple : The shortest tale with the longest title so far'''
 
{{quest
 
{{quest
 +
|title = The shortest tale with the longest title so far
 +
|status=80
 +
|number= 35
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
  | caption= A catchy caption
 
  | type = mini
 
  | type = mini
 
  | description = A one-page tale
 
  | description = A one-page tale
Line 28: Line 44:
 
<pre><nowiki>{{quest
 
<pre><nowiki>{{quest
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
|status=80
 +
|number= 35
 +
  | caption= A catchy caption
 
  | type = mini
 
  | type = mini
 
  | description = A one-page tale
 
  | description = A one-page tale
 
}}</nowiki></pre>
 
}}</nowiki></pre>
 
{{clear}}
 
{{clear}}
 +
 +
'''Normal Quest Exemple : Do the first quest of another RPG'''
 
{{quest
 
{{quest
 +
|title = Do the first quest of another RPG
 +
|status=50
 +
|number= 12
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
  | caption= A fitting caption of average lenght
 
  | type = Normal
 
  | type = Normal
 
  | description = "Kill five boars, three snakes and bring me my coffee please."
 
  | description = "Kill five boars, three snakes and bring me my coffee please."
 
}}
 
}}
<pre><nowiki>{{quest
+
<pre><nowiki>
 +
{{quest
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
|status=50
 +
|number= 12
 +
  | caption= A fitting caption of average lenght
 
  | type = Normal
 
  | type = Normal
 
  | description = "Kill five boars, three snakes and bring me my coffee please."
 
  | description = "Kill five boars, three snakes and bring me my coffee please."
 
}}</nowiki></pre>
 
}}</nowiki></pre>
 
{{clear}}
 
{{clear}}
 +
'''Epic Quest Exemple : Become King of the Unknown World'''
 
{{quest
 
{{quest
 +
|title = Become King of the Unknown World
 +
|status=25
 +
|number= 42
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
  | caption= A fairly way too long yet captivating and perfectly appropriate caption
 
  | type = Epic
 
  | type = Epic
 
  | description = So epic everyone will talk about it
 
  | description = So epic everyone will talk about it
Line 54: Line 84:
 
<pre><nowiki>{{quest
 
<pre><nowiki>{{quest
 
  | image = Example.jpg
 
  | image = Example.jpg
  | caption= A fitting caption
+
|status=25
 +
|number= 42
 +
  | caption= A fairly way too long yet captivating and perfectly appropriate caption
 
  | type = Epic
 
  | type = Epic
 
  | description = So epic everyone will talk about it
 
  | description = So epic everyone will talk about it
 
}}</nowiki></pre>
 
}}</nowiki></pre>
{{clear}}<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>
+
{{clear}}
 +
 
 +
NB: Those are exemples, not actually existing quests at the time of this documentation.
 +
<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>

Latest revision as of 10:32, 21 August 2019

As well as automatically categorizing an article into Category:Quests, this template supplies some standard information about the subject of the article. For details on how to create a quest article, refers to the Creators Manual and the Guideline: Quest Articles.

Parameters

|image=filename 
Optional but preferred — The full image file name.
If an image is not supplied, a placeholder will be used, and by default the template will place the {{picture}} hatnote before the infobox. Disable this if necessary with |ignore-no-image=yes (see below).
|caption=Image description 
Optional — Use only if |image= is also set. Text of a descriptive caption to display beneath the image.
|type=Mini,Normal,Epic 
Required — What kind of quest it is (default: Normal).
(Note: Setting |type= will auto-categorize the article into the appropriate quest sub-category.)
|description= 
Optional — Brief description of the quest.
(Note: Unlike other infoboxes, description is displayed above the picture, below the progress bar.)
|status= 
Optional — Fill the bar according to the number.
(Exemple:|status=25 will display a bar filled at 25%)
|number= 
Optional — Give a non-meta number to the quest.
|ignore-no-image=yes 
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.

Example of Use

{{quest
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| caption= <!-- An appropriate caption for the picture -->
| type = <!-- What kind of quest it is. Can be: Mini, Normal, Epic. -->
| number = <!-- A non-meta number given to the quest -->
| status = <-- Percentage of progression displayed on the progress bar -->
| description = <!-- A short description -->
}}

Mini-quest Exemple : The shortest tale with the longest title so far

Quests of Godville
#35
The shortest tale with the longest title so far
A one-page tale
Example.jpg
A catchy caption



{{quest
 | image = Example.jpg
 |status=80
 |number= 35
 | caption= A catchy caption
 | type = mini
 | description = A one-page tale
}}

Normal Quest Exemple : Do the first quest of another RPG

Quests of Godville

📘Quest

#12
Do the first quest of another RPG
"Kill five boars, three snakes and bring me my coffee please."
Example.jpg
A fitting caption of average lenght



{{quest
 | image = Example.jpg
 |status=50
 |number= 12
 | caption= A fitting caption of average lenght
 | type = Normal
 | description = "Kill five boars, three snakes and bring me my coffee please."
}}

Epic Quest Exemple : Become King of the Unknown World

Quests of Godville
#42
Become King of the Unknown World
So epic everyone will talk about it
Example.jpg
A fairly way too long yet captivating and perfectly appropriate caption



{{quest
 | image = Example.jpg
 |status=25
 |number= 42
 | caption= A fairly way too long yet captivating and perfectly appropriate caption
 | type = Epic
 | description = So epic everyone will talk about it
}}

NB: Those are exemples, not actually existing quests at the time of this documentation.