SE5210 Koha Project Wiki:Templates

There are many templates in use in ; 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. ). 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.

Nominate an article for deletion
delete reason
 * Add this to an article to nominate it for deletion. It will add the article to Category:Candidates for deletion.
 * 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.

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.

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.

Clear
clr, plus clrl and clrr
 * This template is used to reduce the amount of non-wikicode used on pages, replacing the code . 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
name
 * Use at the top of articles as a simple "for x see y" template.

Main article
main article
 * Use at the start of a section to link to the main article on it.

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

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.