Help:Item
 Part of a series of tutorials for the Refuge Wiki | |||||||||||||||||||
Tutorial Navigation
| |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Demo Pages
| |||||||||||||||||||
Templates within MediaWiki function by calling on elements defined in the CSS file, in the JavaScript file, or just by using raw html. Templates exist to allow users to navigate this code without rewriting it countless times or by using elements that are too complicated to easily be understood. The Template:Infobox functions by using elements defined in the CSS file, while the Template:Navbox calls on the table forming mechanics of CSS. Since they're both templates within this wiki, knowledge about how either system works is unnecessary to fill one out.
This page will show you have to fill out the item template for use on your pages. See Help:Templates for help on creating your own template from scratch.
The Info Box
Infoboxes are panels that are automatically placed on the side of whatever article that they are placed on in order to provide a brief and easy to read summary of the topic at hand. The templates Template:Character, Template:Nation, and Template:Item are all specialised templates that are derived from Template:Infobox so that they're easier to use and better convey the topic at hand. All three of these function in the same way, which means that they can be constructed in the same way once you get to know how the infobox is put together. For demonstration purposes, we'll work on filling out the item template. The complete interface for this template will be at the bottom of this page.
We can begin by navigating to the page that we want to write the article. If this page doesn't exist already, type the name of the article into the wiki search bar. If there is no article by that name, you will be asked if you would like to write one. For this example, we'll just be filling out the item template in this page.
The Template and Name
Start by invoking the template:
{{item
The {{ symbols mean you are starting the template. We can close it off with }} after we're done putting in our data.
The first entry we can add is |name =. This is usually the name that will display over the infobox in bold letters. Usually, this is the title of the article because it's the name of the item that the article is about. But if ever you have the need to have the infobox be a title that's different, you can do so by writing something else here.
{{item
|name = Sentience
Each instance of | indicates an input slot that was designated in the template we're working in. So "name|" is registered as an input in Template:Item that means we can put something there.
Image
The next line we'll add is |image =. This is the main profile picture that will be displayed for your item. Whatever image you select will automatically be scaled to a resolution of 150px. In this example, we'll be using File:Sentience.jpg.
{{item
|name = Sentience
|image = File:Sentience.jpg
Notice how there is abundant whitespace in between the variables and what we've input for them. When the code is run, all of this is reduced to a single white space. Therefore, you may use as many spaces as you would like to organise your template and make it easier for you and everyone else to read.
Caption
The caption is the blob of text that is generated under the item. Pick a phrase that talks about the picture provided or is a fitting sentiment to describe what is being looked at.
{{item
|name = Sentience
|image = File:Sentience.jpg
|caption = Azuma's most valued possession.
Quality
The quality section is the first to be generated in the item information section. The colour of the header for this item is determined by your input here. There are five distinctive quality levels that have been encoded into this template.
standard
uncommon
rare
legendary
divine
Use the |quality = input to set the quality of your item. Only these five phrases can be used in this space, and they must all be lower case. For this example, we'll use the Rare level.
{{item
|name = Sentience
|image = File:Sentience.jpg
|caption = Azuma's most valued possession.
|quality = rare
Information
For the main data entry for this box, the following input fields are available to us.
|rp - Input the RP's acronym here, and it will link to the main page of that series.
|owner - The person who is in possession of the item. You can link a character here if there is an article for them.
|type - What type of item is it? If it is a weapon, what type of weapon is it?
|appearance - A short description of what the item looks like.
|attributes - Empirical descriptions of the item.
|abilities - A short list of abilities that the item grants the owner when used.
|notes - The "below" section. Write in anything that doesn't fit anywhere else.
For this example item, we'll be using the following:
{{item
|name = Sentience
|image = File:Sentience.jpg
|caption = Azuma's most valued possession.
|quality = rare
|rp = FTaWSotR
|owner = Azuma
|type = Magical Longsword
|appearance = Mithrilic gold with an obsidian darkwood hilt
|attributes = <br>
*Weight: 0.1 lbs
|abilities = <br>
*Sentient weapon
*Projects defensive barriers
*Regenerates damage
|notes = This is an example item.
}}
You may notice that some lines begins with
. This is because I am dumb and cannot figure out how to make the template work without it. Bullet points need to each be on a new line to work and even if a linebreak is a part of the template itself, this input doesn't recognise the first thing you write as wiki code. If you have a solution to this issue, please let me know. Do not forget to close out your template with }}.
Display
The template is ready and will display on the side of the article as follows:
| Wiki Code | Result | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{item
|name = Sentience
|image = File:Sentience.jpg
|caption = Azuma's most valued possession.
|quality = rare
|rp = FTaWSotR
|owner = Azuma
|type = Magical Longsword
|appearance = Mithrilic gold with an obsidian darkwood hilt
|attributes = <br>
*Weight: 0.1 lbs
|abilities = <br>
*Sentient weapon
*Projects defensive barriers
*Regenerates damage
|notes = This is an example item.
}} |
| ||||||||||||||||||||||
Base Template
The complete interface for this template is below. Copy this template to your item's page and feel free to delete or leave the parts blank that you do not need to use.
{{item
|name =
|image =
|caption =
|quality =
|rp =
|owner =
|type =
|appearance =
|attributes =
|abilities =
|notes =
}}