Documentation/Style guide/Templates

Overview

Templates are wiki pages whose content can be embedded in other pages. They allow for easy translations and help maintain consistency among related documents. This page describes some templates for formatting text.

See also Help:Templates . There is also a similar list for wikitech.wikimedia.org.

Status and progress indicators

Template	Example syntax	Example output
Status	{{status}} {{status|done}} {{status|on hold}} {{status|not done}}	Status:    In progress Status:    Done Status:    On hold Status:    Not done
In progress	{{In progress}}	In progress
Not done	{{Not done}}	N Not done
Done	{{Done}}	Done
Resolved	{{Resolved}}	Resolved
Historical	{{Historical}}
Outdated (Alias: Update)	{{Outdated}} Alias: {{Update}}
HistoricalProject	{{HistoricalProject}}
Archived extension	{{Archived extension}}
Draft	{{Draft}}
DoNotTranslate	{{DoNotTranslate}}
Last updated	{{Last updated}}	Last updated: 2026-09-03 by TBurmeister (WMF)
Documentation needed	{{Documentation needed}} {{Documentation needed|section}}
Fixme	{{Fixme}}
Tracked	{{Tracked|T409768}}	Tracked in Phabricator Task T409768
Ptag	{{Ptag|Phabricator project name}}	(displayed next to the page title)

Callouts and notices

Template	Example syntax	Example output
Hatnote	{{hatnote|Here is my note.}}	Here is my note.
Caution	{{Caution}} Here is my caution 1. {{Caution|Here is my caution 2.}}	Caution: Here is my caution 1. Caution: Here is my caution 2.
Warning	{{warning}} Here is my warning 1. {{warning|Here is my warning 2.}}	Warning: Here is my warning 1. Warning: Here is my warning 2.
Todo	{{Todo|Here is my todo.}}	TODO: Here is my todo.
Todo-inline	{{Todo-inline}} A simpler inline template to flag TODOs.	(TODO) A simpler inline template to flag TODOs.
Fixtext	{{Fixtext|Here is my fixtext.}}	FIX: Here is my fixtext.
Note	{{note|Note 1}} {{note|Note 2|reminder}} {{note|Note 3|error}} {{note}} Loose test	Note 1 Note 2 Note 3  Note: Loose test
Tip	{{Tip|Here is my tip.}}	Here is my tip.
Notice	{{Notice|Here is my notice.}}

Paragraph and text formatting

Template	Example syntax	Example output
Talkquote	{{talkquote|foo bar bang|example}}	foo bar bang — User:example
Smaller	Body text {{Smaller|(note with smaller text)}}	Body text (note with smaller text)
Key press	{{Key press|Ctrl|Shift|I}}	Ctrl+⇧ Shift+I
Button	{{Button|Show preview}}	Show preview
Collapse	{{Collapse|title=Box title|content=The contents of the box…}} See also: Collapsible page elements	Box title The contents of the box…

Links and link formatting

Template	Example syntax	Example output
Soft redirect	{{Soft redirect}}	[[:{{{1}}}|{{{1}}}]] This page is a soft redirect.
Main	{{Main|test|sandbox|w:foo}}	Main pages: test , sandbox and w:foo
See also	{{See also|test|sandbox|w:foo}}	See also: test, sandbox and w:foo
Merge	{{{{merge|Example_page}}
irc	{{irc|wikimedia-tech}}	#wikimedia-tech connect
Doc-links	{{Doc-links|Link to an example doc}} {{Doc-links|Link to a doc template|template}}	Link to example doc Link to a doc template
Class doclink	{{Class doclink|MediaWiki\Title\Title}}	MediaWiki\Title\Title
File doclink	{{File doclink|includes/Title}}	includes/Title.php
Js doclink	{{Js doclink|mediawiki.util}}	mediawiki.util
Git	{{Git|Link to change-id}}	git #1240762
MW File	{{MW file|DefaultSettings.php|includes/}}	MediaWiki file: DefaultSettings.php Location: includes/ Source code: master • 1.46.2 • 1.45.6 • 1.43.11 Classes: Find code • Find documentation
Git file	{{Template:Git_file|Path to file, repo, branch, line number}}	ModuleSpecHandler.php
Gerrit	{{Gerrit|Change number or id}}	Gerrit #I2d7d6e
Phabricator	{{Phabricator|T409768}}	T409768

Code samples and technical content formatting

Template	Example syntax	Example output
TabbedWindow	{{TabbedWindowBegin}} ... {{TabbedWindowEnd}}	Python code JavaScript code
Codesample	{{Codesample|echo "hello world!"|copy=}} This template has options for displaying language and line highlights: {{Codesample |name=example.yaml |lang=yaml |scheme=dark |line=1 |highlight=2,4 |code= apiVersion: networking.k8s.io/v1beta1 kind: Ingress metadata: name: foo-redirect namespace: tool-foo }}	echo "hello world!" example.yaml apiVersion: networking.k8s.io/v1beta1 kind: Ingress metadata: name: foo-redirect namespace: tool-foo
ApiEx	{{ApiEx|action=query|meta=siteinfo}}	api.php?action=query&meta=siteinfo [try in ApiSandbox]
Wg	{{Wg|Sitename}}	$wgSitename
Tag	{{Tag|ref|open}}	‎<ref>...‎</ref>

The MediaWiki Action API documentation has a dedicated Template:Api help template, but that's not included above to save space.