Wiki Templates

From Drunkapedia
Revision as of 06:12, 6 January 2009 by imported>Tlosk
Jump to: navigation, search

Related topics: Page Templates, Wiki Markup Reference

List of wiki templates that are used in formatting areas/items that recur frequently across different pages. Their purpose is two-fold, to make using advanced formatting simpler and to allow formatting changes in the future with a single edit (so you don't have to go back and reedit all the pages that use the template). Some templates are simple and do not require any parameters but most do. If you're new to the term parameter or argument passing in general, a more complete description is given below.

List of Templates

More information for each template can be found by clicking on the template name.

Table of Contents

  • {{LeftToC}} - Table of contents appears on left side with text wrapping along the right.
  • {{RightToC}} - Table of contents appears on right side with text wrapping along the left.
  • {{Quest Links}} - Placed in quest summary header provides ToC like links to the major sections of a quest writeup.
  • {{Exemplar ToC}} - Floats an exemplar image and Table of Contents on the right (text will wrap on the left).

Navigation

Quotations

Archive of Internet Article

  • {{Turbine 2008}} - Archived internet articles from Turbine's website following the redesign in August 2008.
  • {{Turbine 2005}} - Archived internet articles from Turbine's website between the redesigns in July 2005 and August 2008.
  • {{Turbine 2003}} - Archived internet articles from Turbine's new website in 2003 and the redesign in July 2005.
  • {{Microsoft Games}} - Archived internet articles from Microsoft Games.
  • {{Microsoft Zone}} - Archived internet articles from the Microsoft Zone.
  • {{Zogblaster}} - Archived internet articles from Turbine's prerelease website at zogblaster.com.

Parameters

A parameter, or argument, is information that the template needs to complete its job. If a parameter is required, you must include it, if it is optional you can omit it if it doesn't apply. For example if someone gives you a to do list, the purpose of the list is clear, you are supposed to do the items on the list. But for any given list, the items will differ. A template that requires parameters is the same idea. Parameters are separated with single pipes ( | ). Here's an example of formatting a to do list with three items using the fictional ToDoList template:

{{ToDoList|Buy milk.|Return videos.|Wash car.}}

How the list is formatted will depend on exactly how the actual template is setup, but here is one possibility:

To Do List


  1. Buy milk.
  2. Return videos.
  3. Wash car.

Named Variables

Unlike the ToDo list above where all the parameters are things to do, most templates that use parameters give each one an explicit name. This is needed when the parameters are formatted differently or put in particular locations.

An example would be a business card template. The phone number, address, name, etc all go in particular locations and so the template needs to know which parameter is the name, which is the address, etc.

For example:

{{Business Card
| Name = Martine Strathelar
| Address = 100 Planar Drive, Dereth
| Business = Temporal Translocations
| Phone Number = 555-555-1212
}}

which using the hypothetical Business Card template might be displayed as:


Martine Strathelar


Temporal Translocations


100 Planar Drive, Dereth - (555)555-1212

Advanced Template Syntax

To use templates you won't need to know any of the following, however in order to edit an existing template or to create a new template you may find this information useful.

Syntax

  • <includeonly></includeonly> - Optional tags you can place around the workhorse code that defines what the template does. It will cause the code to not display on the template page, improving the appearance of the page since most variables will be undefined. Also it will not compete with an example in situations where only one of an item can be displayed, such as a table of contents.

Parser Functions