m (Removed an unnecessary qualifier) |
(Clarified the use paragraph a bit) |
||
| Line 1: | Line 1: | ||
[[Template:Deprecated]] creates an [[Help:Admonition|admonition]] that indicates a page, section, or code listing is becoming obsolete. It is used to show that, while the deprecated text may still be useful, it is likely to be deleted in the future. This is useful to allow pages that contain entries for contests, or votes to be removed gracefully. | [[Template:Deprecated]] creates an [[Help:Admonition|admonition]] that indicates a page, section, or code listing is becoming obsolete. It is used to show that, while the deprecated text may still be useful, it is likely to be deleted in the future. This is useful to allow pages that contain entries for contests, or votes to be removed gracefully. | ||
To use this template, | To use this template, insert <code><nowiki>{{deprecated}}</nowiki></code> which will yield a default deprecation message. It is recommended to provide a reason for deprecation, which can be done by inserting <code><nowiki>{{deprecated|type your reason}}</nowiki></code>. The reason should also contain information about the replacement or contingency for the deprecated text, if such information is applicable. | ||
=== Example: Typical usage === | === Example: Typical usage === | ||
Revision as of 05:21, 28 June 2010
Template:Deprecated creates an admonition that indicates a page, section, or code listing is becoming obsolete. It is used to show that, while the deprecated text may still be useful, it is likely to be deleted in the future. This is useful to allow pages that contain entries for contests, or votes to be removed gracefully.
To use this template, insert {{deprecated}} which will yield a default deprecation message. It is recommended to provide a reason for deprecation, which can be done by inserting {{deprecated|type your reason}}. The reason should also contain information about the replacement or contingency for the deprecated text, if such information is applicable.
Example: Typical usage
This example demonstrates a typical use of this template. Code:
{{deprecated|This contest has ended. We are no longer accepting entries.}}
Output:
This contest has ended. We are no longer accepting entries.
Example: Minimal use
This example demonstrates the minimal use of this template.
Code:
{{deprecated}}
Output: