Difference between revisions of "Template:Aura/Documentation"

From GodWiki
Jump to navigation Jump to search
(created page for helping in template construction - in progress)
 
m
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: ''Normal'').
+
;{{para|effect|<var>Mini,Normal,Epic</var>}} : ''Optional'' — What kind of effect the aura can have on {{heroes or heroines}}.
: ''('''Note:''' Setting {{para|type}} will auto-categorize the article into the appropriate quest sub-category.)''
 
  
; {{para|description}} : ''Optional'' — Brief description of the quest.
+
; {{para|colour}} : ''Optional'' — Colour of the aura.
: ''('''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 22: Line 15:
  
 
<pre><nowiki>
 
<pre><nowiki>
{{quest
+
{{aura
 
| 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 -->
 
| caption= <!-- An appropriate caption for the picture -->
| type = <!-- What kind of quest it is. Can be: Mini, Normal, Epic. -->
+
| effect = <!-- What kind of effect the aura can have on {{heroes or heroines}} -->
| number = <!-- A non-meta number given to the quest -->
+
| colour = <!-- Colour of the Aura -->
| status = <-- Percentage of progression displayed on the progress bar -->
 
| description = <!-- A short description -->
 
 
}}
 
}}
  
 
</nowiki></pre>
 
</nowiki></pre>
'''Mini-quest Exemple : The shortest tale with the longest title so far'''
+
'''Generic Aura'''
 
{{aura
 
{{aura
  |title = The shortest tale with the longest title so far
+
  |title = Generic Aura
 
  | image = Example.jpg
 
  | image = Example.jpg
 
  | caption= A catchy caption
 
  | caption= A catchy caption
  | effect= test
+
  | effect= Spectacular effect
  | colour= test
+
  | colour= Pretty colored
 
}}
 
}}
 
<pre><nowiki>{{aura
 
<pre><nowiki>{{aura
 
  | image = Example.jpg
 
  | image = Example.jpg
 
  | caption= A catchy caption
 
  | caption= A catchy caption
  | effect= test
+
  | effect= Spectacular effect
  | colour= test
+
  | colour= Pretty colored}}</nowiki></pre>
}}</nowiki></pre>
 
 
{{clear}}
 
{{clear}}

Revision as of 18:24, 21 September 2019

As well as automatically categorizing an article into Category:Auras, this template supplies some standard information about the subject of the article. For details on how to create an aura article, refers to the Creators Manual and the Guideline: Aura 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.
|effect=Mini,Normal,Epic
Optional — What kind of effect the aura can have on heroines.
|colour=
Optional — Colour of the aura.
|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

{{aura
| 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 -->
| effect = <!-- What kind of effect the aura can have on {{heroes or heroines}} -->
| colour = <!-- Colour of the Aura -->
}}

Generic Aura

Auras of Godville
Generic Aura
Example.jpg
A catchy caption
Effect Spectacular effect
Colour Pretty colored
{{aura
 | image = Example.jpg
 | caption= A catchy caption
 | effect= Spectacular effect
 | colour= Pretty colored}}