Templates

General Notes

If you use any of these templates inside a table and they mess it up somehow make sure you add a newline after the "|".
e.g.:

{|
...
...
|previous entry
|
{{MW}}
|next entry
...
...
|}

Keyboard

Template	Example code	Example
Template:K	{{K\|A}}	A
Template:AK	{{AK\|A}}	Alt A
Template:CK	{{CK\|A}}	Ctrl A
Template:SK	{{SK\|A}}	Shift A
Template:CAK	{{CAK\|A}}	CtrlAlt A
Template:SCK	{{SCK\|A}}	ShiftCtrl A
Template:SCAK	{{SCAK\|A}}	ShiftCtrlAlt A
Template:N	{{N\|A}}	NumPad A
Template:SN	{{SN\|A}}	Shift NumPad A

Mouse

Template	Example code	Example
Mouse Button Template:MB	{{MB\|L}} {{MB\|R}} {{MB\|M}} {{MB}}	LMB / RMB / MMB / MB
Template:SMB	{{SMB\|L}} {{SMB\|R}} {{SMB\|M}} {{SMB}}	Shift LMB / Shift RMB / Shift MMB / Shift MB
Template:CMB	{{CMB\|L}} {{CMB\|R}} {{CMB\|M}} {{CMB}}	Ctrl LMB / Ctrl RMB / Ctrl MMB / Ctrl MB
Template:AMB	{{AMB\|L}} {{AMB\|R}} {{AMB\|M}} {{AMB}}	Alt LMB / Alt RMB / Alt MMB / Alt MB
Template:SAMB	{{SAMB\|L}} {{SAMB\|R}} {{SAMB\|M}} {{SAMB}}	ShiftAlt LMB / ShiftAlt RMB / ShiftAlt MMB / ShiftAlt MB
Template:SCMB	{{SCMB\|L}} {{SCMB\|R}} {{SCMB\|M}} {{SCMB}}	ShiftCtrl LMB / ShiftCtrl RMB / ShiftCtrl MMB / ShiftCtrl MB
Template:SCAMB	{{SCAMB\|L}} {{SCAMB\|R}} {{SCAMB\|M}} {{SCAMB}}	ShiftCtrlAlt LMB / ShiftCtrlAlt RMB / ShiftCtrlAlt MMB / ShiftCtrlAlt MB
Mouse Wheel Template:MW	{{MW}} {{MW\|U}} {{MW\|D}}	MW / MW Up / MW Down
Template:SMW	{{SMW}} {{SMW\|U}} {{SMW\|D}}	Shift MW / Shift MW Up / Shift MW Down

Various

Template	Description	Example code	Example
Template:open	Indicates that this task is still open.	{{open}}	[open]
Template:done	Indicates that this task has been finished.	{{done}}	[done]
Template:path	Used to display a directory or file-path.	{{path\|/home/username}}	Template:Path
Template:cvar	Used to display a console or script variable.	{{cvar\|cl_fps}}	`cl_fps`
Template:command	Used to display a console or script command.	{{command\|map farm08n}}	`map farm08n`
Template:svn	Used to link to our svn repositories. It takes two arguments. The first one is the relative path to the "ufoai" repository. i.e the link The second one is the text that should be displayed in the wiki. i.e the caption.	{{svn\|trunk/src\|src}}	`src`
Template:Svn-file	The same as svn template, but links directly to file text with optional line parameter. {{Svn-file\|tags/ufoai_2.2.0/INSTALL\|INSTALL\|58}}		`INSTALL`
Template:Datatype	Used to link to Datatype description	{{Datatype\|V_POS}}	V_POS

Tracker links

Template	Description	Example code	Example
Template:bug	Links to a bug-tracker.	{{bug\|bugnumber}}	#bugnumber
Template:fr	Links to a feature request-tracker.	{{fr\|frnumber}}	#frnumber
Template:patch	Links to a patch-tracker.	{{patch\|patchnumber}}	#patchnumber

Translation

See List of msgid for descriptions.

Template	Example code	Example
Template:translate	{{translate}}	[please translate]
Template:notranslate	{{notranslate}}	[source text unfinished]

Template:notranslate2

{{notranslate2}}

[source text unfinished] Please do not translate yet.
The text below is not intended to be used in-game. See List of msgid for more info.
See here for more unfinished pages like this.

Spoiler

Template:Spoiler

{{Spoiler}}

SPOILER WARNING! Do not read this if you are not a developer and don't want to be spoiled on the story.

Release tasks

{{No new features|x.y}}

Template:No new features

If you add items here make sure they are items VITAL to the x.y release only.
Critical bugs that would prevent the release also go here.
New features should not be included here. Add them to a future version or into TODO/General.
And if you find things that are not intended to go into x.y please move them as well.

{{New features|x.y}}

Template:New features

{{No commit|x.y|a.b}}

Template:No commit

A list of tasks planned for version x.y.
Do not commit these things to the trunk yet! Wait until we have a a.b branch.

One way to still use SVN for these tasks before the branch is made is to create your own branch (must not conflict with the release names). Smaller changes can be submitted as diffs to the patch tracker.

General site templates

Template:Trash can

Used to show an obsolete page.

{{Trash can}}

This page (and its content) has been moved to the trash can.
Please ignore all of this pages content.
If this page was a proposal, please see Equipment/Proposed for a short summary why it will not be included in the game.
See Trash Can and Whatlinkshere for more pages like this.