Difference between revisions of "Template:Aura/Documentation"

From GodWiki
Jump to navigation Jump to search
m (Updating documentation →‎Example of Use)
(documenting top parameter)
 
Line 11: Line 11:
  
 
; {{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.
 +
 +
; {{para|top|<var>no</var>}} : ''Optional'' — Set to <code>no</code> to disable the automatic placement of the {{tlx|Top}} template on the article.
  
 
==Example of Use==
 
==Example of Use==

Latest revision as of 14:41, 5 December 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.
|top=no
Optional — Set to no to disable the automatic placement of the {{Top}} template on the article.

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
}}