Template:APIBreadcrumb/documentation

Template Documentation

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

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

The output appears as follows:

Member of: SynthesisAPI10.x.5Repository