Template:Deprecated code/doc

From Wikiversity
Jump to navigation Jump to search

Usage[edit source]

This 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. 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.

Parameters[edit source]

  • |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
  • |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}})

See also[edit source]

  • {{xtd}} and related templates for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation
Core semantic markup templates
  • {{strong}} – for semantically indicating strong emphasis instead of simple typographical boldfacing
  • {{strongbad}} – same as {{strong}} but red like this: Never use {{strongbad}} in articles.
  • {{stronggood}} – same as {{strongbad}} but green like this: Only use {{stronggood}} on non-article pages.
  • {{em}} – similar template for semantically indicating mild emphasis instead of simple typographical italicization
  • {{var}} – same as {{varserif}} use for all variables other than I (upper-case i) and l (lower-case L), for which use {{varserif}}
  • {{varserif}} – same as {{var}} but uses serif font, especially for distinguishing between I (upper-case i) and l (lower-case L) as variables
  • {{wikivar}} – for displaying wikicode variables and magicwords as they would appear in source code, e.g. {{PAGENAME}}, {{DEFAULTSORT:Lastname, Firstname}}
  • {{para}} – for displaying wiki template parameters (|title=) or parameters and values (|year=2008)
  • {{tlx}} and related – for displaying entire templates (with or without parameters and values) as code
  • {{tag}} – for using HTML elements ("tags") in prose, e.g. source code examples
  • {{code}} – for computer source code ({{var}} and other templates cannot be used inside it; in that case use <code>...</code> as the wrapper, not {{code}})
  • {{syntaxhighlight}} or {{sxhl}} – wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text
  • {{deprecated code}} or {{dc}} – for deprecated source code in template documentation, articles on HTML specs, etc.
  • {{pre}} – for larger blocks of source code and other pre-formatted text
  • {{bq}} – for indented blocks of content, such as block quotations, examples, poems, etc.
  • {{kbd}} – for indicating user input
  • {{key press}} – for indicating the input of specific keystrokes, e.g. CtrlX
  • {{PlayStation key press}} – for indicating PS-style gamepad key presses, e.g. Template:Pskeypress
  • {{samp}} – for example output