Help:Templates

← Help:Editing

Templates enable you to do things much faster and/or easier. Templates are used very frequently on pages, so it's best to learn about them. When the wiki sees a template it recognizes on a page, it will automatically replace it with something else. What appears there is up to the users.

How to use a template

Before a template can be added somewhere, first its contents must be defined on its own page. Template pages should start with the prefix Template:.

Templates have some limited programming abilities, which gives them lots of possibilities. We'll talk more about those later.

To add a template to a page (which is called transcluding), simply type {{, the name of the template, and then }}. If you wish to add any parameters, put a | between the template's name and the }}, and define the parameters there. All parameters you define need to be separated by another |.

Note:Any page can be transcluded by another one actually. Below is a transclusion of the Main Page:

Welcome to the

Valve Developer Community

13,094 articles documenting the development process.

Sign up to become part of the community!

Whether you're building a commercial project or a modification for Half-Life® 2, you'll want to sign up as a Valve developer today. It's free to join and is open to anyone working with the Source engine and its software development kit.

 GoldSrc and the Half-Life SDK 

If you want to create a Mod for Half-Life or looking for more GoldSrc documentation, click above.

 Source and the Source SDK 

If you want to create a Source SDK Base mod, or content-based mod for Half-Life 2, Team Fortress 2 or looking for more Source documentation, click above.

 Source 2 Documentation 

If you want to port Source content to Source 2, create a content-based mod for Source 2 games or looking for more Source 2 documentation, click above. Otherwise, you can check out the following Source 2 games with Workshop Tools:

• Dota 2 Workshop Tools 

• SteamVR Workshop Tools 

• Half-Life: Alyx Workshop Tools 

• Counter-Strike 2 Workshop Tools 

The engine under the hood of Half-Life 2 can make your game a success. Let Source™ do the heavy lifting so that your team can focus on building great games.

---

If you're interested in building a product using Source or Source 2, talk to us about options for distribution on Steam.

Read about Valve Technology 

For Mod Teams

• Source Engine Features
• Why choose the Source engine for your mod?
• Read Making a Mod - building a team through the shipping process.
• Already using the SDK? Check the Source SDK FAQ for some helpful answers.
• New to Source coding? Get started with basic programming articles.
• Read (or add) a tutorial on Source development, or any part of the content creation process.

New to the wiki?

For help with using the wiki, see Help:Contents. For help with navigating the wiki, see Category:Entry pages or Category:Valve Developer Community. For more information on the community itself, see Community Portal.

Wiki Contents 

Community Portal 

© 2005–2025 Valve Corporation. All rights reserved. All trademarks are property of their respective owners in the US and other countries. See the Terms of Use for details
About Valve Developer Community · Privacy Policy · Third Party Legal Notices

Examples

Here's a template where we don't define any parameters, you just drop it right in.

{{restart}}

Result: Requires restart to take effect.

If you visit this template's page, you'll see that its just those five words.

The ent template is a template that can accept up to two unnamed parameters.

{{ent|sv_cheats|1}}

Result: sv_cheats 1

Unnamed parameters must be defined in a specific order.

KV is one of the most common templates used. It accepts an optional named parameter (since).

{{KV|Script think function (thinkfunction)|string|Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.|since=l4d2}}

Result:

Script think function (thinkfunction) ([todo internal name (i)]) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

Without the |since=l4d2 at the end, the Template:L4d2 add message would not have displayed. Named parameters can be defined in any order.

Templates can also use templates (nesting). In the KV template above, the |since=l4d2 part adds {{l4d2 add}} into the page, which is the Template:L4d2 add message.

Making templates

Making a template like Template:Restart is rather easy - just type the text you want, and save it. What about ones with parameters?

Tip:When making templates, you may want to space out your code to make it easier to read, but watch out for unintentional whitespace.

Unnamed parameters

To add an unnamed parameter, simply put {{{1}}} where you want it to be.

Here's part of the code for Template:Tip:

Tip:{{{1}}}

If you've seen this template before you know that it has its own special look, but this is all we will look at for now. All the user has to do when transcluding this is enter the text they want:

{{tip|Do not carve without vertex editing afterward.}}

Result:

Tip:Do not carve without vertex editing afterward.

If you want to add more than one unnamed parameter, simply change the number. Here's the (condensed) code for Template:Distinguish:

:''Not to be confused with [[:{{{1}}}]]{{#if:{{{2|}}} |{{#if:{{{3|}}} |, [[:{{{2}}}]]| or [[:{{{2}}}]].}}|.}}{{#if:{{{3|}}} |{{#if:{{{4|}}} |, [[:{{{3}}}]]|, or [[:{{{3}}}]].}}}}{{#if:{{{4|}}} |, or [[:{{{4}}}]].}}''

This template has some things we haven't talked about yet, but you can still see that there's four unnamed parameters used: {{{1}}}, {{{2}}}, {{{3}}}, and {{{4}}}.

All the user has to do when transcluding is this:

{{distinguish|Combine|Civil Protection|Overwatch}}

Result:

Not to be confused with Combine, Civil Protection or Overwatch.

Named parameters

Usually you would want to have named parameters affect anything only if they are defined when being transcluded. We'll talk about conditions later. For now, let's look at Template:IO, which has many named parameters. In this template, {{{param}}} marks a place to add wikitext that's defined by |param=texthere when transcluding.

With named parameter:

{{IO|SetString|Updates the string.|param=string}}

Result:

SetString <string>

Updates the string.

Without named parameter:

{{IO|SetString|Updates the string.}}

Result:

SetString

Updates the string.

Parser Functions

#if: checks if a string or parameter has anything inside it.

{{#if: {{{target|}}} | Target aqcuired | Sleep mode activated... }}

Result: Sleep mode activated... (The parameter {{{target|}}} returns null because you (probably) are not viewing this page through a transclusion, so it's never had a chance to be defined.)

{{#if: Something is there! | Target aqcuired | Sleep mode activated... }}

Result: Target aqcuired

#ifeq: checks for equality between two strings. It can be used with parameters as well.

{{#ifeq: {{{target|}}} | friend | Friend... | Go away! }}

Result: Go away!

{{#ifeq: friend | friend | Friend... | Go away! }}

Result: Friend...

#expr: solves math problems.

{{#expr: 2 + 2}}

Result: 4

See m:Help:Calculation for all it's abilities.

#ifexpr: tells if a math expression is correct.

{{#ifexpr: 6 + 3 = 9 | Right | Wrong }}

Result: Right

{{#ifexpr: 6 + 3 = 23 | Right | Wrong }}

Result: Wrong

Documentation

Please give a description of what your template is, and maybe examples. To keep this describing text from appearing on pages, there are 3 different HTML tags you can use.

noinclude keeps wikitext inside it from appearing on the destination page, while keeping it on the source page.

onlyinclude makes only wikitext inside it appear on destination pages. text not inside these will still appear on the tempalte's page.

includeonly wikitext inside this will not appear on the template page. It has no effect on the destination page however.

Templates not updating

If you've recently edited a template and the changes are not applying on pages it's been transcluded to, add ?action=purge at the end of the URL for those pages. This will tell the server to update the page's HTML immediately. You can achieve the same effect by editing a page and saving it without making any changes.

Useful templates

per-game templates

All games have templates that show their associated icon. (e.g. ) See Category:Game icons for the full list.

Most games also have templates to quickly note what game added a core engine feature. (e.g. Template:CSGO add) See Category:Notice templates for all available.

bug

Template:Bug notifies readers of a bug.

{{bug|The amount is double what it should be. Be careful!}}

Result:

Bug:The amount is double what it should be. Be careful!  [todo tested in ?]

cleanup

Template:Cleanup marks a page that needs to be fixed up, preferably by someone knowledgeable. The text message is optional. If you do not give sufficient reason for the notice on the transclusion or the talk page, expect it to be removed by someone else.

{{cleanup|The last section needs to be clarified.}}

Result:

This article needs to be cleaned up to conform to a higher standard of quality because:

The last section needs to be clarified.

For help, see the VDC Editing Help and Wikipedia cleanup process. Also, remember to check for any notes left by the tagger at this article's talk page.

confirm

Template:Confirm marks something that needs to be confirmed. It's green color is meant to stand out.

{{confirm|Always goes to the left.}}

Result:

Confirm:Always goes to the left.

Always goes to the left.{{confirm}}

Result: Always goes to the left.^[confirm]

delete

Template:Delete marks a page that should be deleted. If you do not give sufficient reason for the notice on the transclusion or the talk page, expect it to be removed by someone else.

{{delete|This is not a real thing.}}

Result:

This page is a candidate for speedy deletion because:

This is not a real thing.

If you disagree with its speedy deletion, please explain why on its talk page. If this page obviously does not meet the criteria for speedy deletion, or you intend to fix it, please remove this notice, but do not remove this notice from articles that you have created yourself.
Administrators - Remember to check if anything links here and the page history (last edit) before deleting.

distinguish

Template:Distinguish lets you notify users about pages that share similar names or may be confused for something else.

Example from Follow Freeman:

{{distinguish|"Follow Freeman!"}}

Result:

Not to be confused with "Follow Freeman!".

ent

Template:Ent is a really small template for making text that's both code and a link.

{{ent|noclip}}

Result: noclip

ExpandBox

Template:ExpandBox allows you to hide stuff inside a box that can be shrunk down so that it doesn't make pages as long.

{{ExpandBox|{{:KV BaseEntity}}}}

Result:

Classname (classname) ([todo internal name (i)]) <string>

The classname defines the type of entity.

Note:Classnames can be changed using AddOutput, which will influence how the engine deals with the entity in certain circumstances.

Name (targetname) ([todo internal name (i)]) <string>

The targetname that other entities refer to this entity by.

Global Entity Name (globalname) ([todo internal name (i)]) <string>

Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.

Parent (parentname) ([todo internal name (i)]) <targetname>

Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Note:Every entity can be parented, even point entities. Some entities which aren't intended to be parented may not function correctly. phys_constraint can be used as a workaround to parenting.

Origin {X Y Z} (origin) ([todo internal name (i)]) <origin>

The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Pitch Yaw Roll {Y Z X} (angles) ([todo internal name (i)]) <angle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Note:This works on brush entities, although Hammer doesn't show the new angles.

Hammer ID (hammerid) ([todo internal name (i)]) <string>

The entity's Hammer ID. Mainly used by plugins and debugging commands, such as ent_keyvalue. !FGD

Effects (effects) ([todo internal name (i)]) <string>

Effect flags. !FGD

Response Contexts (ResponseContext) ([todo internal name (i)]) <string>

Pre-defined response system contexts for this entity. Format is key:value,key:value,...

Note:Despite the description, this works for all entities, although it is missing from most entities in the FGD.

Minimum CPU Level (mincpulevel) ([todo internal name (i)]) <integer> (in all games since )

Minimum CPU Level allowed for this entity. 0 means all levels allowed. !FGD

Maximum CPU Level (maxcpulevel) ([todo internal name (i)]) <integer> (in all games since )

Maximum CPU Level allowed for this entity. 0 means all levels allowed. !FGD

Minimum GPU Level (mingpulevel) ([todo internal name (i)]) <integer> (in all games since )

Minimum GPU Level allowed for this entity. 0 means all levels allowed. !FGD

Maximum GPU Level (maxgpulevel) ([todo internal name (i)]) <integer> (in all games since )

Maximum GPU Level allowed for this entity. 0 means all levels allowed. !FGD

Todo: Better description for all of these.

Disable for Xbox 360 (disableX360) ([todo internal name (i)]) <boolean> (in all games since )

If Yes, disables this entity on the Xbox 360 version of Source. !FGD

Confirm:Playstation 3?

Glow Backface Multiple (glowbackfacemult) ([todo internal name (i)]) <string> (in all games since )

Unknown. only. !FGD

To do: Documentation.

Entity Scripts (vscripts) ([todo internal name (i)]) <scriptlist> (in all games since )

Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.

Script think function (thinkfunction) ([todo internal name (i)]) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Lag Compensation (LagCompensate) ([todo internal name (i)]) <boolean> (in all games since )

Set to Yes to lag compensate this entity. Should be used very sparingly!

Is Automatic-Aim Target (is_autoaim_target) ([todo internal name (i)]) <boolean> (in all games since )

If yes, automatic-aim assistance will target this entity. !FGD

idea

Template:Idea is a nifty way to suggest ideas.

{{idea|Reward players for being clever and creative, instead of forcing things to be only one way.}}

Result:

Idea:Reward players for being clever and creative, instead of forcing things to be only one way.

merge

Template:Merge is a notice that notifies editors that it's been suggested for two or more pages to be combined into one. All merges should be discussed before done.

{{merge|HDR}}

Result:

It has been suggested that this article or section be merged with HDR. (Discuss)

messagebox

Template:Messagebox provides a standard message box. This template is used by many notice templates, such as merge and cleanup.

{{messagebox|text=Remember to follow wiki etiquette.}}

Result:

Remember to follow wiki etiquette.

morescreenshots

Template:Morescreenshots marks pages that should have more images on them.

{{morescreenshots}}

Result:

To do: This article or section needs additional screenshots.
You can upload screenshots at Special:Upload. For help, see the Help:Images.

note

Template:Note is for making notes stand out more.

{{note|This will spawn at the map origin if you do not specify the position.}}

Result:

Note:This will spawn at the map origin if you do not specify the position.

obsolete

Template:Obsolete marks things that should no longer be used.

{{obsolete}}

Result:

This object is obsolete; its use is discouraged and it may only exist/function in older engine branches.

spammer

Template:Spammer marks users that should be banned for spamming.

Bug:This template's formatting may look weird sometimes. It's intended to be the only thing on a page.  [todo tested in ?]

{{spammer}}

Result:

Note:This user is a spammer, vandal or other problem poster and should be considered for a ban

---

• Block this user. (Requires admin rights)
• Check if this user has been banned.
• View this user's contributions.

stub

Template:Stub marks pages that are very small. It's okay if a page simply is small, though!

{{stub}}

Result:

This article is a stub. You can help by adding to it.

tip

Template:Tip marks text as a tip to readers.

{{tip|This is a much less tricky process when using the vertex edit tool as well.}}

Result:

Tip:This is a much less tricky process when using the vertex edit tool as well.

todo

Template:Todo marks things that need to be done. It's green color is meant to stand out.

{{todo|Find where this is in the game files.}}

Result: To do: Find where this is in the game files.

update

Template:Update marks outdated pages.

{{update}}

Result:

This article needs to be updated to include current information regarding the subject.

warning

Template:Warning marks things that readers should take caution of when doing something.

{{warning|This tool has been known to corrupt files. Try an alternative listed below.}}

Result:

Warning:This tool has been known to corrupt files. Try an alternative listed below.

wip

Template:Wip marks pages that are in the middle of major edits. The adder requests that other users do not edit in the meantime.

{{WIP|~~~}}

Result:

This article is actively undergoing a major edit.
As a courtesy, please do not edit this article while this message is displayed. If this page has not been edited for at least several hours to a few days, please remove this template. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page. The user who added this notice, should you wish to contact them, is: Pinsplash (talk)

See Also

• Wikipedia:Help:Template - a very helpful resource for template programming.
• New Help Desk - Questions? Ask here.