Habitica Wiki:Templates

There are many **templates** in use in Dansk Habitica Wikia; these are only a subset, representing some of the most important and commonly used ones. If you feel that a template belongs on this page, do not hesitate to add it.

* Category:Templates should cover all templates in the wiki, categorized into the various subcategories.
* The Template namespace (found from Special:Allpages) always has all templates in the wiki, sorted alphanumerically.

## What are templates?

Wiki templates provide a means to insert the same content over and over in different (or the same) pages. This saves editors the hassle of duplicating the same text again and again, and also helps ensure consistency.

Templates are generally shown with the format required to use the template (e.g. `{{stub}}`). Clicking the template name takes you to the template's page, where you can see what it looks like and how it is used.

**Detailed instructions on the usage of each template should exist on:**

1. **a subpage using {{documentation}}**; or
2. the template page itself (inside "noinclude" tags); or
3. the template's talk page.

For more information on templates, see Help:Templates.

## Article management templates

### Nominate an article for deletion

{{delete}}

* Add this to an article to nominate it for deletion. It will add the article to Category:Candidates for deletion.

{{speedydelete|*<reason>*}}

* Add this to an article for pages that qualify for speedy deletion.

### Disambiguation articles

{{disambig}}

* If you have several articles that have similar or identical names, you may wish to create a "disambiguation" page at the main article name, with the articles taking an extra phrase in brackets afterwards. For example:

**The Prince** <-- disambiguation page, with links to:
The Prince (frog)
The Prince (human)
* Using {{disambig}} marks an article as a disambiguation page by adding a banner to the article and categorizing it under Category:Disambiguations. Add links to the various articles under the banner.
* For more information, see Help:Disambiguation.

### Former Content

{{Former Content}}

* When a page is about a feature in Habitica that has been removed, then it is former content.

### Stubs

{{stub}}

* When a page has little or no useful information, then it is likely a stub. This template will include them in Category:Article stubs, and is used to list which articles need expanding.
* For more information, see Help:Stubs.

### Spoiler

{{spoiler}}

* This template can be used to mark Spoilers to Habitica.

### Speculation

{{speculation}}

* Pages can contain speculative or planned features that are still subject to change.

## Category templates

### General category template

{{category}}

* This can be added to categories to add general categorising details. Use in cases where it may be useful to point out to users how to categorise, such as popular categories.

### Template category template

{{templatecategory}}

* This should be added to any template-related categories, to list template-specific categorising details, which differ from those of normal pages.

## File copyright templates

On each file description page, a statement regarding the file's origin and copyright status is needed. If you are uncertain which tag to apply, please contact an admin. The most common copyright statuses can be indicated with a template as follows:

### Habitica images

All images from Habitica are under the {{CC-BY-NC-SA}} license.

### Self-made files

For self-made files (e.g. photos of yourself, diagrams you've drawn), the template {{self}} may be appropriate, or you may wish to use the {{fairuse}} template instead.

### Copyrighted files

For copyrighted files, (such as screenshots of non-Habitica websites) please use the {{fairuse}} template.

## General wiki templates

### Clear

{{clr}}, plus {{clrl}} and {{clrr}}

* This template is used to reduce the amount of non-wikicode used on pages, replacing the code `<br style="clear:both;" />`. Its use should generally be avoided.
* You can use {{clr}} instead of the HTML tag that clears space below things like images, pictures and tables, so the following stuff doesn't begin until the bottom of the image, picture or table box.
* You can also use {{clrl}} or {{clrr}} to clear only left or right floats.

### For

{{for|*<name>*|*<link>*}}

* Use at the top of articles as a simple "for x see y" template.

### Main article

{{main|*<main article>*}}

* Use at the start of a section to link to the main article on it.
* Underscores are not neccessary in this template, and should be avoided as they will be displayed on the page.

### Right-aligned Table of Contents

{{tocright}}

* This template floats the table of contents (toc) on the right. It should only be used when absolutely necessary, to keep consistent design.

### Sandbox

{{sandbox}}

* A template that should be used to head up all Project:Sandbox pages.

### T is for template

{{t|*<template>*}}

* This template allows you to show example template code (with a link to the templates) without using the template itself. It is used extensively on this page.

### Welcome

{{welcIP}} *and* {{welcome}}

* The first (with longer version "welcomeIP" for those of you who like typing more) is to welcome new non-vandalistic contributors who are "anonymous", identified only by their IP number; it encourages them to register.
* The second template is for welcoming new registered users. Should be customized for the wiki, indicating the pages we most want newcomers to visit.
* The above two templates are very suitable for having "subst:" prefixed, because they can be edited with additions or deletions appropriate to the apparent strengths of the person being welcomed; e.g. if the contributor has already demonstrated good wiki editing skills you could delete references to pages about "how to edit".

### Wikipedia

{{wikipedia}}, {{wikipedia-deleted}}

* Wikipedia-related templates. Use {{wikipedia}} for articles taken directly from Wikipedia, and {{wikipedia-deleted}} for articles deleted from Wikipedia.

## Habitica

Templates that are specific to the Habitica wikia.

### Github

{{github}} outputs a link to the "HabitRPG" GitHub repository. Options include linking to other "HabitRPG" repositories, specific issues, as well as other users' repositories.

### Hblog

{{hblog}} creates links to the Habitica Tumblr blog, with the option to link to specific blog posts.

### Spoiler start/end

Wrapping sensitive text in {{spoiler start}} and {{spoiler end}} can provide content blocks which are hidden shortly after page load, which the user can interactively view by clicking on a link.

### Tasks

{{task}} is a generic task creator which displays Habits, Todos, and Dailies with different options. It contains coding which can accomplish everything the Habit and Todo templates display, using different options.

### Trello

{{trello}} creates links to the Habitica Trello board. Options include linking to specific cards or boards.

### Deprecated Templates

Both {{Todo}} and {{Habit}}, in their various permutations have been deprecated in favor of {{task}} and its various configuration options.

#### Todo

{{Todo}}, {{TodoGrey}}, {{TodoGreen}}, {{TodoRed}}

* Todos and Dailies are a major part of Habitica, these templates mimic the Item-Style of different Todo colorisations.
* Use {{Todo}} as the standard yellow checkbox-style item.
* Use {{TodoGrey}} for a checked todo.
* Use {{TodoGreen}} to show a green todo which mimics a Daily the user is doing fairly good on.
* Use {{TodoRed}} to show a red todo which mimics a Daily or Todo the user is doing bad on.

#### Habits

{{Habit}}, {{Habit+}}, {{Habit-}}, {{HabitRed}}, {{HabitGreen}}

* Habits are items used on Habitica which contain a +/- Switch or just one of them.
* Use {{Habit}} for a standard yellow +/- switch.
* Use {{Habit+}} for a yellow only + switch.
* Use {{Habit-}} for a yellow only - switch.
* Use {{HabitRed}} for a habit the user is doing bad on.
* Use {{HabitGreen}} for a +/- habit the user is doing good on.

## Where you may find more templates

* Wikia Templates
* Wikipedia; may be copied with the proper acknowledgment, but some need tweaking to work properly on Wikia, so use a Wikia one if possible.