Difference between revisions of "Template:DeprecatedAPI/documentation"

From ReliaWiki
Jump to navigation Jump to search
Line 5: Line 5:
  
  
This boilerplate template is for use with deprecated Synthesis API methods. It inserts a text box that alerts the reader to the deprecated status of the method call. (Deprecated means that the method call is marked for removal in future versions of the API.)  
+
This boilerplate template is for use with deprecated Synthesis API methods. It inserts a text box that alerts the reader to the deprecated status of the call. (Deprecated means that the method call is marked for removal in future versions of the API.)  
  
  
 
==Usage==
 
==Usage==
This template has one optional string parameter. The parameter gives you the option to append additional text to the message in the text box.
+
This template has 2 optional string parameters:
  
For example, the following code shows how to use the optional parameter:
+
:1 = Allows you to indicate whether the deprecated call is a class or enumeration. The default value is "method."
 +
:2 = Allows you to append additional text to the message in the text box.
 +
 
 +
For example, the following code shows how to use the 1st parameter:
 +
 
 +
<pre>
 +
{{Template:DeprecatedAPI|class}}
 +
</pre>
 +
 
 +
The code output is as follows:
 +
{{Template:DeprecatedAPI|class}}
 +
 
 +
 
 +
The next exampel shows how to use the 2nd parameter:
  
 
<pre>
 
<pre>
{{Template:DeprecatedAPI| Please use the ABC method going forward.}}
+
{{Template:DeprecatedAPI|2=Addtional Text.}}
 
</pre>
 
</pre>
  
 
The code output is as follows:
 
The code output is as follows:
{{Template:DeprecatedAPI| Please use the ABC method going forward.}}
+
{{Template:DeprecatedAPI|2=Addtional Text.}}
  
  

Revision as of 15:52, 23 March 2017


Template Documentation

This boilerplate template is for use with deprecated Synthesis API methods. It inserts a text box that alerts the reader to the deprecated status of the call. (Deprecated means that the method call is marked for removal in future versions of the API.)


Usage

This template has 2 optional string parameters:

1 = Allows you to indicate whether the deprecated call is a class or enumeration. The default value is "method."
2 = Allows you to append additional text to the message in the text box.

For example, the following code shows how to use the 1st parameter:

{{Template:DeprecatedAPI|class}}

The code output is as follows:

This class has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications.


The next exampel shows how to use the 2nd parameter:

{{Template:DeprecatedAPI|2=Addtional Text.}}

The code output is as follows:

This method has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications. Addtional Text.


Related Templates

Template:DeprecatedAPIpic - This template is for use with in-line text. It inserts a label that says "Deprecated".