From Fedora Project Wiki
No edit summary |
(Seriously revamped this page) |
||
| 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. | |||
: | |||
To use this template, simply type <code><nowiki>{{deprecated}}</nowiki></code> which will yield a default deprecation message. It is recommended to provide a reason for deprecation. If applicable, a contingency should also be given. | |||
=== Example: Typical usage === | |||
This example demonstrates a typical use of this template. | |||
''Code:'' | |||
<pre><nowiki>{{deprecated|This contest has ended. We are no longer accepting entries.}}</nowiki></pre> | |||
''Output:'' | |||
{{deprecated|This contest has ended. We are no longer accepting entries.}} | |||
=== Example: Minimal use === | |||
This example demonstrates the minimal use of this template. | |||
''Code:'' | |||
<pre><nowiki>{{deprecated}}</nowiki></pre> | |||
''Output:'' | |||
{{deprecated}} | |||
Revision as of 02:16, 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, simply type {{deprecated}} which will yield a default deprecation message. It is recommended to provide a reason for deprecation. If applicable, a contingency should also be given.
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 page is outdated and is only retained for historical reference
This contest has ended. We are no longer accepting entries.
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:
This page is outdated and is only retained for historical reference