Template:APIBreadcrumb/documentation: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
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 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==
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. The structure is as follows:
<pre>{{Template:APIBreadcrumb|.LINK1|.LINK2|.LINK3|.LINK4}}</pre>


<pre>LibraryName.Level1.Level2.Level3.Level4</pre>
where LINK1, LINK2, etc. are the parameters. You must add a period before each link.


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.
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===
The following code example shows the template without using any of the parameters.
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>
<pre>{{Template:APIBreadcrumb}}</pre>


The output of this code is as follows:
The output of this code shows the level 0 parent item, as follows:
 
<div style="background-color: #E6E6E6;">
 


{{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 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. That way, you have a way of navigating items related to a particular library. 





Latest revision as of 15:27, 17 May 2016


Template Documentation

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. 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

This template has four optional parameters. The structure is as follows:

{{Template:APIBreadcrumb|.LINK1|.LINK2|.LINK3|.LINK4}}

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

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

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.

{{Template:APIBreadcrumb}}

The output of this code shows the level 0 parent item, as follows:


Member of: SynthesisAPI


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 call's parent item.

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

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

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. That way, you have a way of navigating items related to a particular library.