Template:Obsolete/doc

From Valve Developer Community
Jump to: navigation, search
Edit-copy.png
This is a documentation subpage for Template:Obsolete.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

This template marks a page as obsolete. It has three parameters, used to specify if the page is an entity, a tool, or a shader. This template automatically adds a page to an Obsolete Entites, Obsolete Tools, or Obsolete Shaders category, depending on parameter. If no parameter is specified, the template does not specify what the page is, and it will not be added to any categories.

Usage

{{obsolete|entity=1}}

Specifies that the page is an entity. Result below.
Obsolete-notext.png
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.

{{obsolete|tool=1}}

Specifies that the page is a tool. Result below.
Obsolete-notext.png
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.

{{obsolete|shader=1}}

Specifies that the page is a shader. Result below.
Obsolete-notext.png
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.

{{obsolete|replacement=<text>}}

Indicates a newer entity, tool, or shader that has been introduced to replace this. For example, {{obsolete|entity=1|replacement={{ent|func_brush}}}} would produce:
Obsolete-notext.png
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.
It has since been replaced by func_brush.