Template:DeprecatedAPI/documentation - Revision history

Kate Racaza at 21:32, 30 March 2017

2017-03-30T21:32:04Z

← Older revision		Revision as of 21:32, 30 March 2017
Line 24:		Line 24:


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

	<pre>		<pre>
	{{Template:DeprecatedAPI\|2=~~Addtional Text~~.}}		{{Template:DeprecatedAPI\|2=Blah Blah Blah.}}
	</pre>		</pre>

	The code output is as follows:		The code output is as follows:
	{{Template:DeprecatedAPI\|2=~~Addtional Text~~.}}		{{Template:DeprecatedAPI\|2=Blah Blah Blah.}}

Kate Racaza at 15:52, 23 March 2017

2017-03-23T15:52:00Z

← Older revision		Revision as of 15:52, 23 March 2017
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.}}

Kate Racaza at 18:15, 13 November 2015

2015-11-13T18:15:36Z

← Older revision		Revision as of 18:15, 13 November 2015
Line 20:		Line 20:
	{{Template:DeprecatedAPI\| Please use the ABC method going forward.}}		{{Template:DeprecatedAPI\| Please use the ABC method going forward.}}


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

Kate Racaza at 18:11, 13 November 2015

2015-11-13T18:11:32Z

← Older revision		Revision as of 18:11, 13 November 2015
Line 5:		Line 5:


	This ~~is a~~ boilerplate template for Synthesis API methods ~~and properties~~ that ~~have been~~ deprecated (~~i.e.,~~ 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 method call. (Deprecated means that the method call is marked for removal in future versions of the API.)


	==Usage==		==Usage==
	This template has ~~no parameters~~.		This template has one optional string parameter. The parameter gives you the option to append additional text to the message in the text box.

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

			<pre>
			{{Template:DeprecatedAPI\| Please use the ABC method going forward.}}
			</pre>

			The code output is as follows:
			{{Template:DeprecatedAPI\| Please use the ABC method going forward.}}





	</div>		</div>

Kate Racaza at 20:32, 22 October 2015

2015-10-22T20:32:13Z

@@ Line 8: / Line 8: @@
 ==Usage==
-This template requires two parameters:
+This template has no parameters.
 </div>

Kate Racaza at 21:15, 8 July 2015

2015-07-08T21:15:24Z

← Older revision		Revision as of 21:15, 8 July 2015
Line 8:		Line 8:

	==Usage==		==Usage==
	This template ~~has~~ two parameters:		This template requires two parameters:

	:1 - Indicate whether it is a method or property.		:1 - Indicate whether it is a method or property.

	:2 - Add the link to the new or recommended method/property ~~to use instead~~.		:2 - Add the link to the new or recommended method/property.


	For example, the following code will generate a template for a deprecated ''method'' has been replaced with the ''Repository.Model.GetAllModels'' method:		For example, the following code will generate a template for a deprecated ''method'' that has been replaced with the ''Repository.Model.GetAllModels'' method:

	<pre>		<pre>

	{{Template:DeprecatedAPI\|method\|[[Repository.Model.GetAllModels]]}}		{{Template:DeprecatedAPI\|method\|[[Repository.Model.GetAllModels]]}}

Kate Racaza: Created page with 'NOTOC
={{Font|Template Documentation|16|Calibri|bold|black}}= This is a boilerplate template for Synthesis API methods and proper…'

2015-07-08T21:11:12Z

Created page with '__NOTOC__<div style="background-color: #DBE9F4;"> ={{Font|Template Documentation|16|Calibri|bold|black}}= This is a boilerplate template for Synthesis API methods and proper…'

New page

__NOTOC__<div style="background-color: #DBE9F4;">

={{Font|Template Documentation|16|Calibri|bold|black}}=

This is a boilerplate template for Synthesis API methods and properties that have been deprecated (i.e., marked for removal in future versions of the API).

==Usage==
This template has two parameters:

:1 - Indicate whether it is a method or property.

:2 - Add the link to the new or recommended method/property to use instead.

For example, the following code will generate a template for a deprecated ''method'' has been replaced with the ''Repository.Model.GetAllModels'' method:

<pre>
{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}

</pre>

The output appears as follows:

{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}

</div>