Template:Deprecated code

From Wikipedia, the free encyclopedia
Jump to: navigation, search

{{{1}}}

Template documentation[view] [edit] [history] [purge]

Usage[edit]

The {{deprecated code}} template (easiest used from its {{dc}} redirect) can be used to indicate, e.g. in template documentation or Wikipedia articles on things like HTML specifications, code that has been deprecated and should not normally be used. It can also be used to indicate other deleted or deprecated material. On the technical level it is a CSS-styled <del>...</del> that greys out the text (the near-universal sign in computing and computing documentation for "doesn't work", "don't do this", "bad code", "ignore", "option not available", etc.), and removes that element's usual strikethrough (CSS: "line-through") rendering, which makes the content hard to read. If you really want that line-through, use the {{dc2}} variant to do this; it is otherwise identical.

Note: This template does not apply a monospaced font. This is so that it can be used inside an existing code (or non-code) block and inherit its font style. If necessary, wrap the template in one of <code>...</code> (source code), <kbd>...</kbd> (example input), or <samp>...</samp> (example output) as semantically appropriate.

Parameters[edit]

  • |1=   the content to be marked as deprecated
  • |2= or |title= a mouse-over "tooltip" (in some browsers, anyway), e.g. for briefly explaining the deprecation, e.g. "Deprecated since HTML 3.0" or "Breaks infobox formatting"
  • |red=y   make the text red instead of grey, for indicating dangerous/error/forbidden things (a shortcut for this is {{dcr}})
  • |class=   assign a CSS class
  • |id=   assign an HTML ID for #linking and other purposes (must be unique on the page and start with an alphabetic letter)
  • |style=   add additional CSS styling (can be used to add text-decoration:line-through; back in if you want that formatting; a shortcut for this is {{dc2}})

Examples[edit]

  • {{dc|deprecated}} yields: deprecated
  • {{dcr|deprecated}} yields: deprecated
  • {{dc2|deprecated}} yields: deprecated

See also[edit]

  • {{xtd}} and related templates for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation.