Template:APIBreadcrumb/documentation - Revision history

Kate Racaza at 15:27, 17 May 2016

2016-05-17T15:27:56Z

← Older revision		Revision as of 15:27, 17 May 2016
Line 5:		Line 5:
	This template creates a breadcrumb link in the Synthesis [[API Reference Documentation]] pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.		This template creates a breadcrumb link in the Synthesis [[API Reference Documentation]] pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	This template helps readers navigate the API object library by inserting links to the parent items of an API call, thereby showing the call's place in the hierarchy. ~~In this hierarchy, the~~ API object library itself is the top-level item ~~and is therefore~~ level 0~~. Classes~~ and enums are at level 1, ~~and~~ methods and properties~~, as well as sub classes,~~ are at level 2, ~~and so on~~.		This template helps readers navigate the API object library by inserting links to the parent items of an API call, thereby showing the call's place in the hierarchy. The API object library itself is the top-level item (level 0), classes and enums are level 1, methods and properties are level 2, etc.



	==Usage==		==Usage==
Line 15:		Line 13:
	where LINK1, LINK2, etc. are the parameters. You must add a period before each link.		where LINK1, LINK2, etc. are the parameters. You must add a period before each link.

	Each parameter corresponds to a sub level in the ~~API object library~~ hierarchy. This means that LINK1 is the link to the level 1 item, LINK2 is the link to the level 2 item, and so on.		Each parameter corresponds to a sub level in the hierarchy. This means that LINK1 is the link to the level 1 item, LINK2 is the link to the level 2 item, and so on.

	===Example 1===		===Example 1===
Line 44:		Line 42:

	</div>		</div>


	==Notes==		==Notes==
	As of 2016, we have only one API object library; therefore, the link to the V9/V10 API Reference Documentation was hard coded into this template. If Development creates a second object library in the future, you might want to create a new breadcrumb template for that library. ~~This~~ way, you have a way of ~~finding all wiki pages~~ related to a particular library.		As of 2016, we have only one API object library; therefore, the link to the V9/V10 API Reference Documentation was hard coded into this template. If Development creates a second object library in the future, you might want to create a new breadcrumb template for that library. That way, you have a way of navigating items related to a particular library.

Kate Racaza at 18:50, 5 May 2016

2016-05-05T18:50:50Z

← Older revision		Revision as of 18:50, 5 May 2016
Line 5:		Line 5:
	This template creates a breadcrumb link in the Synthesis [[API Reference Documentation]] pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.		This template creates a breadcrumb link in the Synthesis [[API Reference Documentation]] pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	This template helps readers navigate the API ~~product~~ by inserting ~~a single line~~ of ~~text that shows~~ the ~~API~~ call's ~~parent item(s)~~ in the ~~API object library~~. In this hierarchy, the API object library itself is the top-level item and is therefore level 0. Classes and enums are at level 1, and methods and properties, as well as sub classes, are at level 2, and so on.		This template helps readers navigate the API object library by inserting links to the parent items of an API call, thereby showing the call's place in the hierarchy. In this hierarchy, the API object library itself is the top-level item and is therefore level 0. Classes and enums are at level 1, and methods and properties, as well as sub classes, are at level 2, and so on.



	==Usage==		==Usage==
	This template has four optional parameters, each ~~corresponding~~ to the ~~sub-levels~~. This means that ~~parameter 1~~ is the level 1 item, ~~parameter 2~~ is the level 2 item, and so on.		This template has four optional parameters. The structure is as follows:
			<pre>{{Template:APIBreadcrumb\|.LINK1\|.LINK2\|.LINK3\|.LINK4}}</pre>

			where LINK1, LINK2, etc. are the parameters. You must add a period before each link.

			Each parameter corresponds to a sub level in the API object library hierarchy. This means that LINK1 is the link to the level 1 item, LINK2 is the link to the level 2 item, and so on.

	===Example 1===		===Example 1===
Line 25:		Line 32:

	===Example 2===		===Example 2===
	The following code example shows the breadcrumb link for a level 2 call. In this case, the template populates the first parameter by adding a link to ~~the reference doc of~~ the call's parent item.		The following code example shows the breadcrumb link for a level 2 call. In this case, the template populates the first parameter by adding a link to the call's parent item.
	<pre>{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}</pre>		<pre>{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}</pre>

Kate Racaza at 17:29, 5 May 2016

2016-05-05T17:29:48Z

← Older revision		Revision as of 17:29, 5 May 2016
Line 3:		Line 3:

	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=
	This ~~boilerplate~~ template ~~is for use with~~ the Synthesis API ~~reference documentation~~ pages ~~only~~. It ~~allows you~~ to ~~create a breadcrumb link that helps users navigate~~ the ~~API product~~.		This template creates a breadcrumb link in the Synthesis [[API Reference Documentation]] pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	This template ~~attempts to provide structure to~~ the ~~docs~~ by inserting a single line of text that shows the ~~method~~'s ~~or class'~~s ~~hierarchy~~ in the API object library. ~~It's meant to resemble~~ the ~~navigation element found in VBA~~ and VB.~~NET's Object Browser window~~.		This template helps readers navigate the API product by inserting a single line of text that shows the API call's parent item(s) in the API object library. In this hierarchy, the API object library itself is the top-level item and is therefore level 0. Classes and enums are at level 1, and methods and properties, as well as sub classes, are at level 2, and so on.

	==Usage==		==Usage==
	This template has four optional parameters. ~~The first~~ parameter ~~represents~~ the level 1 item, ~~the second~~ parameter ~~represents~~ the level 2 item, and so on. ~~The structure is as follows (note how the breadcrumb uses periods to delimit each item):~~		This template has four optional parameters, each corresponding to the sub-levels. This means that parameter 1 is the level 1 item, parameter 2 is the level 2 item, and so on.

	<pre>~~LibraryName.Level1.Level2.Level3.Level4~~</pre>		===Example 1===
			The following code example shows the breadcumb link for a level 1 call. Because the parent item is the API object library itself, the template omits all parameters.
			<pre>{{Template:APIBreadcrumb}}</pre>

	The ~~name and link to the V9/V10 [[API Reference Documentation\|SynthesisAPI]] object library is hard coded into~~ this ~~template. If Development creates a new object library in~~ the ~~future, please create a new breadcrumb template for that library. This way~~, ~~you have a method for finding all wiki pages related to a particular library.~~		The output of this code shows the level 0 parent item, as follows:

	=~~==Example 1===~~		<div style="background-color: #E6E6E6;">
	~~The following code example shows the template without using any of the parameters.~~
	~~<pre>{{Template~~:~~APIBreadcrumb}}</pre~~>

	~~The output of this code is as follows:~~

	{{Template:APIBreadcrumb}}		{{Template:APIBreadcrumb}}


			</div>

	===Example 2===		===Example 2===
	The following code example shows the template ~~with one~~ parameter ~~in use~~.		The following code example shows the breadcrumb link for a level 2 call. In this case, the template populates the first parameter by adding a link to the reference doc of the call's parent item.
	<pre>{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}</pre>		<pre>{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}</pre>

	The output of this code ~~is as follows~~:		The output of this code shows the level 0 and level 1 parent items, separated by a period:

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


	{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}		{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}


			</div>


			==Notes==
			As of 2016, we have only one API object library; therefore, the link to the V9/V10 API Reference Documentation was hard coded into this template. If Development creates a second object library in the future, you might want to create a new breadcrumb template for that library. This way, you have a way of finding all wiki pages related to a particular library.

Kate Racaza at 18:50, 4 May 2016

2016-05-04T18:50:30Z

← Older revision		Revision as of 18:50, 4 May 2016
Line 5:		Line 5:
	This boilerplate template is for use with the Synthesis API reference documentation pages only. It allows you to create a breadcrumb link that helps users navigate the API product.		This boilerplate template is for use with the Synthesis API reference documentation pages only. It allows you to create a breadcrumb link that helps users navigate the API product.

	As of July 2015, we've decided to stop using MediaWiki categories to organize the pages on the wiki. This means that the content on the ReliaWiki site has no real structure. This is problematic for the API reference documentation, which requires some structure in order for the content to make sense.		This template attempts to provide structure to the docs by inserting a single line of text that shows the method's or class's hierarchy in the API object library. It's meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	This template attempts to provide ~~that~~ structure by inserting a single line of text that shows the method's or class's ~~location~~ in the API object library. ~~Its~~ meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	==Usage==		==Usage==
Line 14:		Line 12:
	<pre>LibraryName.Level1.Level2.Level3.Level4</pre>		<pre>LibraryName.Level1.Level2.Level3.Level4</pre>

	The name and link to the V9/V10 [[~~Full Synthesis~~ API\|SynthesisAPI]] object library is hard coded into this template. If Development creates a new object library in the future, please create a new breadcrumb template for that library. This way, you have a method for finding all wiki pages related to a particular library.		The name and link to the V9/V10 [[API Reference Documentation\|SynthesisAPI]] object library is hard coded into this template. If Development creates a new object library in the future, please create a new breadcrumb template for that library. This way, you have a method for finding all wiki pages related to a particular library.

	===Example 1===		===Example 1===

Kate Racaza at 23:23, 13 November 2015

2015-11-13T23:23:09Z

← Older revision		Revision as of 23:23, 13 November 2015
Line 3:		Line 3:

	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=
	~~Used~~ for: Synthesis API reference documentation pages only		This boilerplate template is for use with the Synthesis API reference documentation pages only. It allows you to create a breadcrumb link that helps users navigate the API product.

			As of July 2015, we've decided to stop using MediaWiki categories to organize the pages on the wiki. This means that the content on the ReliaWiki site has no real structure. This is problematic for the API reference documentation, which requires some structure in order for the content to make sense.

	This ~~boilerplate~~ template ~~creates~~ the ~~breadcrumb~~ found in ~~the method~~ and ~~property pages~~. ~~If you~~'~~re looking for the breadcrumb link for API classes and enums, see Template:APIBreadcrumbClass~~.		This template attempts to provide that structure by inserting a single line of text that shows the method's or class's location in the API object library. Its meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

	This breadcrumb link ~~resembles~~ the ~~navigation element found~~ in ~~VBA and VB~~.~~NET's Object Browser window~~, ~~and it serves as our main~~ method for ~~navigating~~ the ~~API product~~.		==Usage==
			This template has four optional parameters. The first parameter represents the level 1 item, the second parameter represents the level 2 item, and so on. The structure is as follows (note how the breadcrumb uses periods to delimit each item):

			<pre>LibraryName.Level1.Level2.Level3.Level4</pre>

			The name and link to the V9/V10 [[Full Synthesis API\|SynthesisAPI]] object library is hard coded into this template. If Development creates a new object library in the future, please create a new breadcrumb template for that library. This way, you have a method for finding all wiki pages related to a particular library.

			===Example 1===
			The following code example shows the template without using any of the parameters.
			<pre>{{Template:APIBreadcrumb}}</pre>

	The ~~breadcrumb contains the following information~~:		The output of this code is as follows:

	:~~a) The API version in which the call became available.~~		{{Template:APIBreadcrumb}}
	:b) The name of the object library.*
	~~:c) The name of the parent object and/or member, if applicable.~~


	<~~nowiki~~>*</nowiki> Note that the name and link to the V9/V10 [[~~Full Synthesis API~~\|~~SynthesisAPI~~]] object library is hard coded into this template. If Development creates a new object library in the future, please create a new breadcrumb template for that library. This way, you have a method for finding all wiki pages related to a particular library. (As of July 2015, we've decided to stop using admin categories to find related pages. Templates, along with the "What links here" utility, are now used for that purpose.)		===Example 2===
			The following code example shows the template with one parameter in use.
			<pre>{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}</pre>

	~~==Usage==~~		The output of this code is as follows:
	The ~~template has one required parameter and two optional ones, depending on what~~ is ~~being documented~~.
			{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

	~~: 1 - Enter the API version in which the call was <u>first</u> introduced. (Required)~~
	~~: 2 - If the page is for a method or property, enter a link to the parent class. Otherwise, leave it blank.~~
	~~: 3 - If the page is for a subclass, enter a link to the parent member. Otherwise, leave it blank.~~



	For example, the following code will generate a template for a call that was created in ''API Version 10'' and is associated with the ''Repository'' class. Notice the period ('''.''') before the link and how the code uses the pipe character (<nowiki> \| </nowiki>) to change the way the link is displayed.

	~~<pre> {{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}} </pre>~~

	~~The output appears as follows:~~

	~~{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}~~

Kate Racaza at 22:02, 29 July 2015

2015-07-29T22:02:59Z

← Older revision		Revision as of 22:02, 29 July 2015
Line 20:		Line 20:

	==Usage==		==Usage==
	The template has one required parameter and two optional ones, depending on ~~the~~ what is being documented~~. If documenting a class or enumeration, only parameter #1 is required, the rest can be left blank~~.		The template has one required parameter and two optional ones, depending on what is being documented.

	: 1 - Enter the API version in which the call <u>~~became~~</u> ~~available~~.		: 1 - Enter the API version in which the call was <u>first</u> introduced. (Required)
	: 2 - If the page is for a method or property, enter a link to the parent class.		: 2 - If the page is for a method or property, enter a link to the parent class. Otherwise, leave it blank.
	: 3 - If the page is for a subclass, enter a link to the parent member.		: 3 - If the page is for a subclass, enter a link to the parent member. Otherwise, leave it blank.


	For example, the following code will generate a template for a ''Version 10'' ~~call that~~ is associated with the ''Repository'' class. Notice the period ('''.''') before the link and how the code uses the pipe character (<nowiki> \| </nowiki>) to change the way the link is displayed.		For example, the following code will generate a template for a call that was created in ''API Version 10'' and is associated with the ''Repository'' class. Notice the period ('''.''') before the link and how the code uses the pipe character (<nowiki> \| </nowiki>) to change the way the link is displayed.

	<pre> {{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}} </pre>		<pre> {{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}} </pre>

Kate Racaza at 21:58, 29 July 2015

2015-07-29T21:58:53Z

← Older revision		Revision as of 21:58, 29 July 2015
Line 3:		Line 3:

	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=
	Used for: Synthesis API documentation pages only		Used for: Synthesis API reference documentation pages only

Kate Racaza at 21:55, 29 July 2015

2015-07-29T21:55:33Z

← Older revision		Revision as of 21:55, 29 July 2015
Line 6:		Line 6:


	This boilerplate template is for the breadcrumb link ~~in the~~ API ~~reference pages~~. It resembles the navigation element found in VBA and VB.NET's Object Browser window, and it serves as our main method for navigating the API product.		This boilerplate template creates the breadcrumb found in the method and property pages. If you're looking for the breadcrumb link for API classes and enums, see Template:APIBreadcrumbClass.

			This breadcrumb link resembles the navigation element found in VBA and VB.NET's Object Browser window, and it serves as our main method for navigating the API product.

	The breadcrumb contains the following information:		The breadcrumb contains the following information:
Line 20:		Line 22:
	The template has one required parameter and two optional ones, depending on the what is being documented. If documenting a class or enumeration, only parameter #1 is required, the rest can be left blank.		The template has one required parameter and two optional ones, depending on the what is being documented. If documenting a class or enumeration, only parameter #1 is required, the rest can be left blank.

	: 1 - Enter the API version in which the call became available.		: 1 - Enter the API version in which the call <u>became</u> available.
	: 2 - If ~~documenting methods and properties~~, enter a link to the parent class ~~or enumeration~~.		: 2 - If the page is for a method or property, enter a link to the parent class.
	: 3 - If ~~documenting~~ a subclass, enter a link to the parent member.		: 3 - If the page is for a subclass, enter a link to the parent member.


	For example, the following code will generate a template for a ''Version 10'' call that is associated with the ''Repository'' class. Notice how the code uses the pipe character (<nowiki>\|</nowiki>) to change the way the link ~~to the parent class~~ is displayed.		For example, the following code will generate a template for a ''Version 10'' call that is associated with the ''Repository'' class. Notice the period ('''.''') before the link and how the code uses the pipe character (<nowiki> \| </nowiki>) to change the way the link is displayed.

	<pre> {{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}} </pre>		<pre> {{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}} </pre>

	The output appears as follows:		The output appears as follows:

	{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}		{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}

Kate Racaza at 18:09, 17 July 2015

2015-07-17T18:09:57Z

← Older revision		Revision as of 18:09, 17 July 2015
Line 6:		Line 6:


	This boilerplate template ~~creates~~ the breadcrumb link in the ~~documentation~~ pages of the ~~API methods~~ and ~~properties~~. ~~If you~~'~~re looking~~ for the ~~breadcrumb link for~~ API ~~classes, see [[Template:APIBreadcrumbClass]]~~.		This boilerplate template is for the breadcrumb link in the API reference pages. It resembles the navigation element found in VBA and VB.NET's Object Browser window, and it serves as our main method for navigating the API product.

	The breadcrumb link ~~resembles~~ the ~~navigation element found~~ in ~~VBA and VB~~.~~NET's Object Browser window~~, ~~and it serves as our main~~ method for ~~navigating~~ the ~~API product~~.		The breadcrumb contains the following information:

			:a) The API version in which the call became available.
			:b) The name of the object library.*
			:c) The name of the parent object and/or member, if applicable.


			<nowiki>*</nowiki> Note that the name and link to the V9/V10 [[Full Synthesis API\|SynthesisAPI]] object library is hard coded into this template. If Development creates a new object library in the future, please create a new breadcrumb template for that library. This way, you have a method for finding all wiki pages related to a particular library. (As of July 2015, we've decided to stop using admin categories to find related pages. Templates, along with the "What links here" utility, are now used for that purpose.)

	==Usage==		==Usage==
	~~This~~ template ~~requires~~ two ~~parameters:~~		The template has one required parameter and two optional ones, depending on the what is being documented. If documenting a class or enumeration, only parameter #1 is required, the rest can be left blank.

	: 1 - ~~Indicate~~ the API version.		: 1 - Enter the API version in which the call became available.
	: 2 - ~~Add the name of~~ the parent class. ~~This parameter automatically creates~~ a link to the parent class's page. This automated process will work as long as the name of the page has the following format: <code>NAME_Class</code>. Examples are [[Repository Class]] or [[cModel Class]]. (Note how "Class" is uppercase.)		: 2 - If documenting methods and properties, enter a link to the parent class or enumeration.
			: 3 - If documenting a subclass, enter a link to the parent member.


	For example, the following code will generate a template for a ''Version 10~~.x.5~~'' ~~method~~ that is associated with the ''Repository'' class.		For example, the following code will generate a template for a ''Version 10'' call that is associated with the ''Repository'' class. Notice how the code uses the pipe character (<nowiki>\|</nowiki>) to change the way the link to the parent class is displayed.

	<pre> {{Template:APIBreadcrumb\|10~~.x.5~~\|Repository}} </pre>		<pre> {{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}} </pre>

	The output appears as follows:		The output appears as follows:

	{{Template:APIBreadcrumb\|10~~.x.5~~\|Repository}}		{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}

Kate Racaza: Created page with 'NOTOC
={{Font|Template Documentation|16|Calibri|bold|black}}= Used for: Synthesis API documentation pages only This boilerplate t…'

2015-07-10T18:07:46Z

Created page with '__NOTOC__<div style="background-color: #DBE9F4;"> ={{Font|Template Documentation|16|Calibri|bold|black}}= Used for: Synthesis API documentation pages only This boilerplate t…'

New page

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

={{Font|Template Documentation|16|Calibri|bold|black}}=
Used for: Synthesis API documentation pages only

This boilerplate template creates the breadcrumb link in the documentation pages of the API methods and properties. If you're looking for the breadcrumb link for API classes, see [[Template:APIBreadcrumbClass]].

The breadcrumb link resembles the navigation element found in VBA and VB.NET's Object Browser window, and it serves as our main method for navigating the API product.

==Usage==
This template requires two parameters:

: 1 - Indicate the API version.
: 2 - Add the name of the parent class. This parameter automatically creates a link to the parent class's page. This automated process will work as long as the name of the page has the following format: <code>NAME_Class</code>. Examples are [[Repository Class]] or [[cModel Class]]. (Note how "Class" is uppercase.)

For example, the following code will generate a template for a ''Version 10.x.5'' method that is associated with the ''Repository'' class.

<pre> {{Template:APIBreadcrumb|10.x.5|Repository}} </pre>

The output appears as follows:

{{Template:APIBreadcrumb|10.x.5|Repository}}

</div>