Template Index

From School of CS Student Wiki
Jump to: navigation, search

Templates are re-usable bits of wiki-text that you can include in other pages without copy+pasting. You can pass parameters to templates which can modify what is displayed. See MediaWiki/Help:Templates for more information.

Usually a template has an associated documentation page (the /doc subpage). Read these documentation pages to learn what the parameters of each template do. The list below contains some of the templates available in this wiki. There are more templates available, but those templates are usually not used directly; they are used to help construct other templates (e.g. Template:ambox). It is a good idea to skim through the list and familiarise yourself with the available templates if you wish to do any major editing.

If you wish to create a new template, use an existing template as a guide on how to write the documentation. Keeping a consistent style will aid editors.

Core Project Templates

Module Pages

In order to keep the core project page's style consistent, a few templates that help with the layout of the pages have been created.

Template Name Description
template:core-nav-footer Used to place some navigation links at the base of a module page
template:core-layout-index Handles the layout of module index pages

Special Links

To simplify linking between various course related pages, the following templates have been created:

Template Name Description
template:course-link Inserts a link to the given course number's main page
template:syllabus-link Creates a link to the syllabus page of a given course

Miscellaneous

Template Name Description
template:course-fname Inserts the full name of a given course
template:course-sname Inserts the short name of a given course

Flags

Flags are used to help editors by marking issues or restrictions associated with a page. They also help editors and administrators find problem pages by checking the page information of a given template and seeing which pages include that template.

If you wish to extend the available flag types, see Template:FlagBox and consider creating aliases that use Template:FlagBox in the same way as those below. Also, for new FlagBox icons, grab the source files for the icon set and try to keep to the same style. Alternatively, if you do not feel confident creating a new icon, contact User:Mbax9mc3 (you can use a place holder until the a new icon is ready).

Template Name Description
template:FlagAbuse Used to flag abuse of the system (e.g. abusive conduct on talk pages, vandalism etc
template:FlagDelete Used to flag pages that need deletion
template:FlagFactCheck Used to flag pages that appear to have unverified facts or are known to be incorrect
template:FlagMaintenance Usually used to flag templates that have broken code or pages with serious problems with the markup
template:FlagObsolete Used to mark material no longer required, but that should be kept for reference purposes (e.g. a course unit that is no longer taught)
template:FlagProtected Used to mark pages that are protected from edits by regular users (usually due to vandalism or because a page has high traffic and damage to it would cause major issues)
template:FlagStub Used to mark pages that are short and could do with having more content
template:FlagUnderConstruction Used for pages that are new and not yet considered complete or correct

Utilities

Template Name Description
template:Borrow Adds some useful links and a notice that a page has been 'borrowed'. Use in place of simple transclusion.

Bespoke

These templates are not for general use and are usually used on a few very specific pages.

Template Name Description
template:Suggestion A standard format for site suggestions, used on Meta:Suggestions.

Authors

  • gravatar Mbax9mc3 [userbureaucrateditorsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPmVkaXRvcjxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+]