Template:Deprecated code

~~{{{1}}}~~

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

{{dc}}

Usage

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 ... 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}} (AKA {{dcs}}) 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 ... (source code), ... (example input), or ... (example output) as semantically appropriate. If you want monospace without semantic markup like , you can use the alternative templates {{mxtd}}: Example text, or {{!mxt}}: Example text.


Parameters
|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}} or {{dcs}})
Examples
{{dc|deprecated}} yields: deprecated
{{dcr|deprecated}} yields: deprecated
{{dc2|deprecated}} yields: deprecated
{{dcs|deprecated}} yields: deprecated
See also
{{xtd}} and related templates for indicating deprecated, good, bad, and neutral examples in guidelines, how-tos, and template documentation.
{{mxtd}} in this template group (example output here) is an alternative to {{dc}}.
{{!mxt}} in this template group (example output here) is an alternative to {{dcr}}.
{{strongbad}} – for introducing something as deprecated or issuing some other warning in documentation, e.g.: {{strongbad|Not for use in mainspace.}}
v
t
e
Semantic markup templates
 Template   Example output   Use 
 {{strong}}  Important!  To indicate  importance, seriousness, or urgency instead of just simple typographical boldfacing
 {{strongbad}}  "Never use ..."  Same as {{strong}} but in red
 {{stronggood}}  "Only use ..."  Same as {{strong}} but in green
 {{em}}  "An emphatic phrase"  To indicate  stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
 {{var}}  strPrefix  To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
 {{var serif}}  strIllustratePrefix  (see {{var}} above)
 {{tld}}  {{DEFAULTSORT:Y, X}}  To display wikicode variables and magic words as they would appear in code
 {{para}}  |year=2008  To display template parameters with or without values
 {{param}}  {{{title|alt}}}  To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
 {{tjp}}  |selfref=yes  To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
 {{param value}}  ··2·blanks·fore·and·aft··  To display parameter values lightly bordered; replaces ..., especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
 {{tlx}} etc.  {{Template|1|2|...|10}}  To display a template call (with or without parameters and values) as code
 {{tji}}  {{hatnote|Hello|selfref=yes|category=no}}  To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
 {{tag}}  "The ... tags ..."  To render HTML elements ("tags") in prose
 {{code}}/{{codett}}  "Ensure the alt= parameter ..."  To indicate text is source code. To nest other templates within {{code}}, use .... {{codett}} differs only in styling: someMethod becomes  someMethod
 {{PreCode}}  "FORTH has keyword ?BRANCH."  Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
 {{subst:codenowiki}}  {{small|small text example}}  To wrap example code in ...
 {{subst:kbdnowiki}}  {{large|large text example}}  To wrap example code in ...
 {{syntaxhighlight}}      _{[this is a block template]}  ( or {{sxhl}} )  Wrapper for ..., but will wrap overflowing text
 {{deprecated code}}  "Do not use <blink>."  ( or {{dc}} )  To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (<blink>) while {{dcr}} uses red (<blink>).
 {{pre}}      _{[this is a block template]}  For larger blocks of source code and other pre-formatted text
 {{tj}}      _{[this is a block template]}  To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
 {{quote}}      _{[this is a block template]}  For block quotations (only – never for non-quotations)
 {{block indent}}      _{[this is a block template]}  For indented blocks of material; visually identical to {{quote}} but without quote markup
 {{kbd}}  user input  To indicate user input
 {{key press}}  Ctrl+x  To indicate specific-keystroke input, including combinations
 {{key top}}  Left shift  Similar; includes more symbols, but does not directly support combinations
 {{button}}  Don't save  To indicate a button in a user interface
 {{samp}}  example output  To indicate sample or example output


The above documentation is transcluded from Template:Deprecated code/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.


Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Deprecated_code&oldid=1051978034"