Template:Reference Example/documentation

Template Documentation

This template is one of five in a series of templates designed for use in the reference example pages. This template in particular contains the design for the banner/header that runs across the top of those pages. For information about the other templates in the series and how to put them together in the reference example pages, see the Related Templates section below.

Usage

By default, this template is configured for Weibull++; however, you can customize it for use with any other reference example pages.

Example 1

To add this template to a Weibull++ reference example page, type the following:

{{Reference Example}}

Example 2

To add this template to any other reference example pages, type the following:

{{Reference Example|Image=XXX|Link:YYY}}

where XXX is the name of the banner image and YYY is the link to the application's reference example index page. For example, to customize the template for RGA, type the following:

{{Reference Example|Image=RGA_Reference_Examples_Banner.png|Link=RGA_Reference_Examples}}

For your convenience, below is a list of the file names for all other software:

• ALTA_Reference_Examples_Banner.png
• BlockSim_Reference_Examples_Banner.png
• DOE_Reference_Examples_Banner.png
• Predict_Reference_Examples_Banner.png
• RCM_Reference_Examples_Banner.png
• RENO_Reference_Examples_Banner.png
• RGA_Reference_Examples_Banner.png
• Xfmea_Reference_Examples_Banner.png

Related Templates

• Template:Reference_Example_Heading1
• Template:Reference_Example_Heading2
• Template:Reference_Example_Heading3
• Template:Reference_Example_Heading4

Notes

Below is an example of the general structure of a reference example page, using the complete set of templates. Note that not all examples may need the complete set.

{{Reference Example}}
Sample content

{{Reference_Example_Heading1}}
Sample content

{{Reference_Example_Heading2}}
Sample content

{{Reference_Example_Heading3}}
Sample content

{{Reference_Example_Heading4}}
Sample content

For a demo on how the complete set of templates is used in a reference example page, see the following page: Median Rank for Single Censored Data. Note that this example is a live page on ReliaWiki. Please do not edit or use it to experiment with the templates!