Template:Documentation/doc

Purpose

This template is used to insert descriptions on template pages.

Usage

On the Template page

<includeonly> Template code... Any categories to be inserted into articles by the template..</includeonly><noinclude> Template's categories.. {{documentation}}
</noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

== Purpose ==
This template is used to do something.

== Usage ==
<pre>{{templatename|template parameters}}</pr e>

== Parameters ==
{| class="sotawikitable"
! Parameter
! Explanation
|-
| firstparameter
| Description of the first parameter
|-
| ...
| ...
...
|}

== Example ==
<pre>{{templatename|template parameters}}</pr e>
{{templatename|template parameters}}

<noinclude>[[Category:Template Documentation|{{PAGENAME}}]]</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.

Parameters

Parameter	Explanation
1 (optional)	The name of template whose documentation will be displayed.

Example

{{documentation}} (inside the Template:Infobox)

Template documentation (for the above template, sometimes hidden or invisible) Purpose This template may be used for adding simple infobox with only an image. Usage {{Infobox|<image>|<imagewidth>|<imageheight>|<caption>|<collection>|<header1>|<label1>|<data1>|<header2..10>|<label2..10>|<data2..10>}} Parameters Parameter Explanation name (optional) The title displayed at the caption of the infobox. Default is page name. image (optional) The name of the image file (if there is any) together with its extension. imagewidth (optional) Width of the image in pixels. Default is 250. imageheight (optional) Height of the image in pixels. caption (optional) Caption for image collection Images that has a matching Property:has image collection. header1 (optional) header that appears above label1 label1 (optional) label for a row. Only appears if there is also data1. data1 (optional) data for a row. header2..10 (optional) 9 more headers. Same as header1. label2..10 (optional) 9 more labels. Same as label1. header2..10 (optional) 9 more datas. Same as data1. Example {{Infobox |name=[[New Britannia]] |image=New Britannia Coat of Arms.png |backgroundcolor =0000 |imagewidth=300 |caption=[[New Britannia Coat of Arms]] |header=HEADER 1 |label1=LABEL 1 |data1=DATA 1 }} New Britannia File:New Britannia Coat of Arms.png New Britannia Coat of Arms LABEL 1 DATA 1 Visit Template:Infobox/doc to edit this text! (How does this work?)

{{documentation|Infobox Location}}

Template documentation (for the above template, sometimes hidden or invisible) Purpose This template may be used to summarize information about a particular scene. This template is placed at the top of an article and appears in the upper right. Usage {{Infobox Location |name= |image= |imagebackgroundcolor= |imagewidth= |tier= |tierplus= |location= |mayor= |commander= |population= |firstseen= |region= |continent= |scene= |coordinates= |island= |showcontinent= }} Parameters Parameter Explanation name (optional) The name of the location. Defaults to the page name. image (optional) The name of the image file (if there is any) together with its extension. imagebackgroundcolor (optional) The background color of the image file. Useful if the image has odd transparencies. imagewidth (optional) The width of the image. Defaults to 250px. tier (optional) The difficulty tier (number of skulls) of the adventure scene. tierplus (optional) If the scene contains pockets of higher enemies (designated by a + in the scenes name), set this to 1. mayor (optional) The mayor (or governor) of the location. commander (optional) The commander of the fort (if there is any) protecting the city. population (optional) The population of the town (only NPCs). firstseen (optional) The Episode the first appearance of the location in the game. This will appear as a link. location (optional) A more precise location where the scene can be found; useful for nested scenes. island (optional) field to add a specific island name for islands on the Novia and Mistrendur continents. showcontinent (optional) Optional field to add to display the continent the scene is on. Useful for scene pages that do not display the continent they are in. region (optional) The region this scene is found in. continent (not used anymore) This field is no longer used. Just delete this line. The continent this scene can be found on: Novia, Hidden Vale, or Mistrendur. (Required to show map) showcontinent (optional) Will show an optional field with the name of the continent the scene is in. Useful for Mistrendur scenes. scene (not used anymore) This field is no longer used. Just delete this line. If the location is accessible from within another scene, note which scene here. (Sets which map is shown) coordinates (not used amymore) This option no longer works. Just delete this line. Example 1 (Hidden Vale) {{Infobox Location |name=Owl's Head |image=SotA Vale Owls Head market square.png |location=Hidden Vale |commander=Lord Delbert Enmar |population=unknown |firstseen=Episode 1 |continent=Hidden Vale }} Owl's Head File:SotA Vale Owls Head market square.png Location: Hidden Vale Commander: Lord Delbert Enmar Population: unknown Release: Episode 1 Example 2 (Novia) {{Infobox Location |name=Aerie |image=Aerie polish mUcpmpUv2.jpg |location=Longfall |showcontinent=Novia |firstseen=Episode 1 }} Aerie File:Aerie polish mUcpmpUv2.jpg Location: Longfall Continent: Novia Release: Episode 1 Example 3 (Mistrendur) {{Infobox Location |name=Grusk |tier=10 |image=Grusk-1.jpg |location=Rostfelt |firstseen=Episode 2 |island=Slangemagge |showcontinent=Mistrendur }} Grusk File:Grusk-1.jpg Scene Difficulty: File:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.pngFile:Zonetier.png Location: Rostfelt Island: Slangemagge Continent: Mistrendur Release: Episode 2 Visit Template:Infobox Location/doc to edit this text! (How does this work?)