Template:Instead/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 3: Line 3:
Use this template to indicate that a specified tool or item is outdated and suggest considering a newer alternative.
Use this template to indicate that a specified tool or item is outdated and suggest considering a newer alternative.


{{Code
 
| {{Tl|instead|ToolName}}
<code><nowiki>{{instead|ToolName}}</nowiki></code>
}}
{{instead|ToolName}}


==Parameters==
==Parameters==
Line 11: Line 11:


==Examples==
==Examples==
<code>
{{instead|WinBSPC}}
{{Tl|instead|dododo}}
<code>{{Tl2|instead|WinBSPC}}</code>
{{Tl|instead|OldTool}}
 
</code>
{{instead|BspTwoMap}}
<code>{{Tl2|instead|BspTwoMap}}</code>


==Notes==
==Notes==
* If the specified tool or item exists as a page, it will generate a message suggesting a newer alternative.
* If the specified tool or item exists as a page, it will generate a message suggesting a newer alternative.
* Ensure the replacement link is provided in the format: '''[[ToolName (replacement)|a newer alternative]]''' within the respective page.
* The replacement link is the source one, that is, no changes.


== Limitations ==
* Using the [[Template:Software|Software Template]] with this template is contraindicated, since this template only creates a replacement link.


{{Sandbox other||
{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Categories below this line, please; interwikis at Wikidata -->
}}
}}

Latest revision as of 07:29, 21 November 2023

Edit-copy.png
This is a documentation subpage for Template:Instead.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Usage

Use this template to indicate that a specified tool or item is outdated and suggest considering a newer alternative.


{{instead|ToolName}}

Icon-ambox-instead.png
Instead/doc is outdated. Consider using a newer alternative.

Parameters

ToolName (required): Specifies the name of the tool or item that is considered outdated.

Examples

Icon-ambox-instead.png
Instead/doc is outdated. Consider using a newer alternative.

{{instead|WinBSPC}}


Icon-ambox-instead.png
Instead/doc is outdated. Consider using a newer alternative.

{{instead|BspTwoMap}}

Notes

  • If the specified tool or item exists as a page, it will generate a message suggesting a newer alternative.
  • The replacement link is the source one, that is, no changes.

Limitations

  • Using the Software Template with this template is contraindicated, since this template only creates a replacement link.