Template:Reference Example/documentation

From ReliaWiki
Jump to navigation Jump to search


Template Documentation

This series of templates is designed for use in the Reference Example pages for all Synthesis applications. For an example on how the templates are used, 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!

There are five templates in this series. This template in particular (i.e., Template: Reference Example) contains the design for the banner/header that runs across the top of the pages. Complete instructions for using all these templates are provided below.

Usage

When you create a new page for a reference example, copy and paste the following code into the page:

{{Reference Example|XXX|YYY}}
Your text here.

{{Reference_Example_Heading1}}
Your text here.

{{Reference_Example_Heading2}}
Your text here.

{{Reference_Example_Heading3}}
Your text here.

{{Reference_Example_Heading4|ZZZ}}
Your text here.

where XXX is the name of the banner image, YYY is the link to the application's reference example index page and ZZZ is the software name. If you do not define the parameters, the template will default to the Weibull++ design.

The following example shows what the parameters might look like for the ALTA pages.

{{Reference Example|ALTA_Reference_Examples_Banner.png|ALTA_Reference_Examples}}
Your text here.

{{Reference_Example_Heading1}}
Your text here.

{{Reference_Example_Heading2}}
Your text here.

{{Reference_Example_Heading3}}
Your text here.

{{Reference_Example_Heading4|ALTA}}
Your text here.

Notes

For your convenience, below are the names of the banner file graphics for the Reference Example pages:

  • 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