Template:Deprecated: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
Adding a description of the template
Updated to link to Legacy OpenGL
Line 1: Line 1:
<noinclude>This template marks the section or article as being predominantly about [[Deprecation|deprecated]] material. This template takes one optional named parameter:
<noinclude>This template marks the section or article as being predominantly about [[Deprecation|deprecated]] material. This template takes one optional named parameter:


* alternate: This is a short string of text. It should grammatically fit in the sentence: "<nowiki>Consider using {{{alternate}}} instead.</nowiki>". This is preferably a link to non-deprecated alternatives.
* ''alternate'': This is a short string of text. It should grammatically fit in the sentence: "<nowiki>Consider using {{{alternate}}} instead.</nowiki>". This is preferably a link to non-deprecated alternatives.
* ''section'': Use this tag to state that it is about this section rather than the article. It doesn't matter what text you put here.


</noinclude><includeonly>{{alertbox
</noinclude><includeonly>{{alertbox
| color = #FA8
| color = #FA8
| text = '''Warning:''' This article or section describes material that has been [[Deprecation|deprecated]] in OpenGL 3.0, and removed in core GL 3.1 and above implementations. It is recommended that you not use this functionality in your programs. {{#if:{{{alternate|}}}|Consider using {{{alternate}}} instead. }}}}</includeonly>
| text = '''Warning:''' This {{#if:{{{section|}}}|section|article}} describes [[Legacy OpenGL|legacy OpenGL APIs]] that have been removed from [[Core And Compatibility in Contexts|core OpenGL 3.1 and above]] (they are only [[Deprecation|deprecated]] in OpenGL 3.0). It is recommended that you not use this functionality in your programs. {{#if:{{{alternate|}}}|Consider using {{{alternate}}} instead. }}}}</includeonly>

Revision as of 14:02, 2 September 2012

This template marks the section or article as being predominantly about deprecated material. This template takes one optional named parameter:

  • alternate: This is a short string of text. It should grammatically fit in the sentence: "Consider using {{{alternate}}} instead.". This is preferably a link to non-deprecated alternatives.
  • section: Use this tag to state that it is about this section rather than the article. It doesn't matter what text you put here.