Template:APIBreadcrumbClass/documentation

From ReliaWiki
Jump to navigation Jump to search


Template Documentation

Used for: Synthesis API reference documentation pages only.


This boilerplate template creates the breadcrumb link in the class and enumeration pages. If you're looking for the breadcrumb link for API methods and properties, see Template:APIBreadcrumb.

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.


* Note that 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. (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

This template has no parameters. To use it, simply copy and paste the following code:

 {{Template:APIBreadcrumbClass}}