Template:Deprecated

From Gentoo Wiki
Jump to:navigation Jump to:search
[edit Documentation
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Use this template to mark an article as deprecated for archival purposes.

Important
When deprecating a page, please remove it's categories so as to not add noise to them (unless there is a specific reason not to). Also, review pages that link to the deprecated article and remove or modify links that are no longer useful (tools menu -> what links here).

Use this template to mark an article as deprecated for archival purposes. Adding this template to an article automatically adds it to the Deprecated articles category.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Replace "article"1

Replace the word "article", if desired (e.g., by section, list, etc.)

Example
section
Stringoptional
Datedate

Specify the date the article became deprecated

Dateoptional
Notenote

Note about why the article became deprecated

Stringoptional

Usage

See the template's testcases:

No parameter
Wiki code {{Deprecated}}

Main version
Deprecated article

This article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this article!
Sandbox version
Deprecated article

This article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this article!
Parameter: date
Wiki code {{Deprecated|date=Aug 2, 2012}}

Main version
Deprecated article

As of Aug 2, 2012, this article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this article!
Sandbox version
Deprecated article

As of Aug 2, 2012, this article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this article!
Parameter: unnamed
Wiki code {{Deprecated|section}}

Main version
Deprecated section

This section is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this section!
Sandbox version
Deprecated section

This section is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!


TLDR: Do not use this section!
Parameter: note
Wiki code {{Deprecated|note=Outdated}}

Main version
Deprecated article

This article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!
Outdated

TLDR: Do not use this article!
Sandbox version
Deprecated article

This article is deprecated (obsolete). Contents are no longer relevant, and are intended for historical reference only!
Outdated

TLDR: Do not use this article!

See also

Note
The above documentation is transcluded from Template:Deprecated/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. (See the subpages of this template.)