Template:APIBreadcrumb/documentation

Template Documentation

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

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):

LibraryName.Level1.Level2.Level3.Level4

The name and link to the V9/V10 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.

{{Template:APIBreadcrumb}}

The output of this code is as follows:

Member of: SynthesisAPI

Example 2

The following code example shows the template with one parameter in use.

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

The output of this code is as follows:

Member of: SynthesisAPI.Repository