Wikitech documentation templates

This is a list of templates that exist on Wikitech and which may be useful for technical documentation. (Compare with mw:Documentation/Style guide/templates.)

Codesample

{{Codesample|name=metadata|lang=yaml|scheme=light|line=1|start=5|highlight=1,4|code=
  name: foo-redirect
  namespace: tool-foo
  labels:
    name: foo-redirect
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/permanent-redirect: https://bar.toolforge.org/$1$is_args$args
}}

metadata

name: foo-redirect
  namespace: tool-foo
  labels:
    name: foo-redirect
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/permanent-redirect: https://bar.toolforge.org/$1$is_args$args

Collapse top and Collapse bottom

{{Collapse top}} and {{Collapse bottom}}

{{Collapse top|Title}}
===Collapsed content===
The collapsed content can include multiple paragraphs.
{{Notice|And even include other templates}}
{{Collapse bottom}}

Caution

{{Caution|Here is my note.}}

Caution: Here is my note.

Doing, Not Done, Done

{{Doing}}

Doing...

{{Not done}}

N Not done

{{Done}}

Done

Draft

{{Draft}}

This page is currently a draft.
More information and discussion about changes to this draft on the talk page.

Fixme

{{Fixme|foo}}

FIXME: foo

Fixme inline

{{Fixme inline|foo}}
{{Fixme inline|where}}
{{Fixme inline|when}}

^{[Fix Me]}
^[Where?]
^[When?]

Hidden

Expand and collapse section contents with a stylized header.

{{Hidden|Title|Hidden content that will be shown after clicking Expand}}

Title
Hidden content that will be shown after clicking Expand

Historical

{{archive}} aka. {{Historical}}

{{Historical}}

{{Historical|year=2005}}

This page contains historical information. It may be outdated or unreliable.

2005

Just a note

{{Justanote|foo}}

foo

Merge

{{Merge|foo}}

It has been suggested that this page should be merged with foo

Navigation sidebar

{{Navigation_sidebar}} makes it easier for you to create navigation templates for a set of pages. For examples that use the template, see:

{{Toolforge_nav}}
{{Navigation_Event_Platform}}

Note

{{Note|text=Foo}}
{{Note|type=info|text=Foo}}
{{Note|type=reminder|text=Foo}}
{{Note|type=reminder|text=Multiple<br>lines<br>of<br>text}}
{{Note|type=warn|text=Foo}}
{{Note|type=error|text=Foo}}
{{Note}} Loose text
* Inline note {{Note|inline=1|text=Foo}}

Foo

Multiple
lines
of
text

Foo

Note: Loose text

Inline note
Foo

Notice

{{Notice|foo bar bang}}

Outdated

This page may be outdated or contain incorrect details. Please update it if you can.

This information is outdated.

Remark

This is a wrapper around {{Note}}. Using that template instead is recommended.

Staging

{{Staging}}

This is a staging page!
This page contains notes and working drafts that are subject to change and may be inaccurate.

Status

{{status}}	→	Status: Unresolved
{{status\|done}}	→	Status: Done
{{status\|on hold}}	→	Status: Unresolved
{{status\|not done}}	→	Status: Unresolved

See template page for more color options, and wording change options.

Warn

{{Warn|Here is my note.}}

Here is my note.

Warning

Alias for {{Warn}}

Different version than on mediawikiwiki. Just uses ambox here.

Linking to Gerrit, Phabricator, etc

Link to Phabricator

Tracked in Phabricator
Task T327319

{{tracked|T327319}} will display a "Tracked in Phabricator" box like the one on the right.

You can also use [[phab:T327319]] without using a template, it will display like this: phab:T327319

Link to a repository

{{git repo|wikimedia/developer-portal}}

wikimedia/developer-portal

Link to a change

{{Gerrit|4203}}

4203

Link to a file

{{Gitweb|project=mediawiki/extensions/examples|file=extension.json}}

extension.json