Template:APIBreadcrumb/documentation: Difference between revisions
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
This boilerplate template | 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 | : 2 - If the page is for a method or property, enter a link to the parent class. | ||
: 3 - If | : 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 | 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]]}} | ||
Revision as of 21:55, 29 July 2015
Template Documentation
Used for: Synthesis API documentation pages only
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:
- 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.
* 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
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.
- 2 - If the page is for a method or property, enter a link to the parent class.
- 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 the period (.) before the link and how the code uses the pipe character ( | ) to change the way the link is displayed.
{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
The output appears as follows:
Member of: SynthesisAPI10.Repository