Documentation/Style guide/templates
Appearance
From mediawiki.org
Overview
[edit ]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.
Also see Help:Templates. There is also a similar list for wikitech.wikimedia.org.
Status and progress indicators
[edit ]| 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 |
Doing |
{{Doing}}
|
In progress In progress |
Not done |
{{Not done}}
|
N Not done |
Done |
{{Done}}
|
Yes Done |
Resolved |
{{Resolved}}
|
Yes Resolved |
Historical |
{{Historical}}
|
This page is obsolete. It is being retained for archival purposes. It may document extensions or features that are obsolete and/or no longer supported. Do not rely on the information here being up-to-date. |
Outdated (Alias: Update) |
{{Outdated}}
Alias: {{Update}}
|
This page is outdated. It was written for an older version of MediaWiki and may not apply to the most recent version. If you have checked or updated this page and found the content to be suitable, please remove this notice. See the talk page for a possible discussion on this. |
HistoricalProject |
{{HistoricalProject}}
|
This page documents a completed project. It is being retained for archival purposes. It may include information that is no longer accurate. |
Archived extension |
{{Archived extension}}
|
This extension or skin has been archived.
This extension or skin has not been maintained for some time, and no longer supports recent releases of MediaWiki. [[Special:PermanentLink/{{{1}}}|See this page before archival]] |
Draft |
{{Draft}}
|
This page is currently a draft.
More information and discussion about changes to this draft may be on the discussion page.
|
DoNotTranslate |
{{DoNotTranslate}}
|
Please do not mark this page for translation yet. It is still being drafted, or it contains incomplete translation markup which should be fixed before marking for translation. |
Last updated |
{{Last updated}}
|
Last updated: 2026年07月22日 by TBurmeister (WMF) |
Documentation needed |
{{Documentation needed}}
{{Documentation needed|section}}
|
The subject of this page is not very well documented yet. If you need help, feel free to ask at the support desk.
If you know more about this subject, don't hesitate to help expanding our documentation by editing this page (or other pages that need documentation). This section is incomplete or outdated. If you need help, feel free to ask at the support desk.
If you know more about this subject, don't hesitate to help expanding our documentation by editing this page (or other pages that need documentation). |
Fixme |
{{Fixme}}
|
This documentation is considered incorrect and should not be used as a reference. It needs reviewing by someone with subject matter expertise to identify and correct any issues. |
Tracked |
{{Tracked|T409768}}
|
Callouts and notices
[edit ]| 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! Caution: Here is my caution 1. Caution! Caution: Here is my caution 2.
|
Warning |
{{warning}} Here is my warning 1. {{warning|Here is my warning 2.}}
|
Warning Warning: Here is my warning 1. Warning 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 Note: Loose test |
Tip |
{{Tip|Here is my tip.}}
|
Here is my tip.
|
Notice |
{{Notice|Here is my notice.}}
|
Here is my notice. |
Paragraph and text formatting
[edit ]| Template | Example syntax | Example output |
|---|---|---|
Talkquote |
{{talkquote|foo bar bang|example}}
|
|
Smaller |
Body text {{Smaller|(note with smaller text)}}
|
Body text (note with smaller text) |
Links and link formatting
[edit ]| Template | Example syntax | Example output |
|---|---|---|
Soft redirect |
{{Soft redirect}}
|
#REDIRECT[[:{{{1}}}|{{{1}}}]] This page is a soft redirect. |
Main |
{{Main|test|sandbox|w:foo}}
|
|
See also |
{{See also|test|sandbox|w:foo}}
|
|
Merge |
{{{{merge|Example_page}}
|
It has been suggested that this page or section be merged with Example_page .(Discuss) |
Doc-links |
{{Doc-links|Link to an example doc}}
{{Doc-links|Link to a doc template|template}}
|
|
Git |
{{Git|Link to change-id}}
|
git #1240762 |
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
[edit ]| Template | Example syntax | Example output |
|---|---|---|
TabbedWindow |
{{TabbedWindowBegin}}...{{TabbedWindowEnd}}
|
|
Codesample |
{{Codesample|echo "hello world!"|copy=}}
|
echo"hello world!" |