Wikitech documentation templates

From Wikitech
Jump to navigation Jump to search

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

Caution and Warning

{{Caution}}

{{Caution}} Here is my note.

Warning Caution: Here is my note.


{{Caution|Here is my note.}}

Warning Caution: Here is my note.


{{warning}}

Different version than on mediawikiwiki. Just uses ambox here.

{{warning|Here is my note.}}

Here is my note.

Codesample

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

Doing Not Done Done

{{Doing}}

{{Doing}}

Doing...

{{Not done}}

{{Not done}}

☒N Not done

{{Done}}

{{Done}}

Yes Done

Draft

{{Draft}}

{{Draft}}

Fixme

{{Fixme}}

{{Fixme|foo}}

FIXME: foo

Fixme inline

{{Fixme inline}}

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

[Fix Me]
[Where?]
[When?]

Historical

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

{{Historical}}

{{Historical|year=2005}}

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

Just a note

{{Justanote}}

{{Justanote|foo}}

foo

Merge

{{Merge}}

{{Merge|foo}}

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


Notice

{{Notice}}

{{Notice|foo bar bang}}

Outdated

{{Outdated}}

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

{{Outdated-inline}}

Remark

{{Remark}}

{{Remark|Foo}}
{{Remark|Foo|reminder}}
{{Remark|Foo|error}}
{{Remark|Foo|gotcha}}
Foo
Foo
Foo
Foo

See also

{{See also}}

{{See also|test|sandbox|w:foo}}

Staging

{{Staging}}

{{Staging}}

Status

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

Linking to Gerrit, Phabricator, etc

Link to Phabricator

{{tracked|T327319}}

Link to a repository

{{git repo}}

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

wikimedia/developer-portal

Link to a change

{{gerrit}}

{{Gerrit|4203}}

4203

Link to a file

{{gitweb}}

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

extension.json