Template:Reference Example/documentation: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
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!'''''
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.  
There are five templates in this series. This template in particular (i.e., Template: Reference Example) contains design elements for the banner/header that runs across the top of the pages. Complete instructions for using all these templates are provided below.  


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


<pre>{{Reference Example|XXX|YYY}}
<pre>{{Reference Example|{{XXX}}}}
Your text here.
Your text here.


Line 24: Line 24:
Your text here.
Your text here.


{{Reference_Example_Heading4|ZZZ}}
{{Reference_Example_Heading4|YYY}}
Your text here.</pre>
Your text here.</pre>


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.
where '''XXX''' is the name of the banner template for the software and '''YYY''' is the software name. If you do not define the parameters, the template will default to the Weibull++ banner design.


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


<pre>{{Reference Example|ALTA_Reference_Examples_Banner.png|ALTA_Reference_Examples}}
<pre>{{Reference Example|{{Banner ALTA Reference Examples}}}}
Your text here.
Your text here.


Line 46: Line 46:
Your text here.</pre>
Your text here.</pre>


==Notes==
For your convenience, below are the names of the banner templates for each software:


For your convenience, below are the names of the banner file graphics for the Reference Example pages:
* [[Template:Banner ALTA Reference Examples|Banner ALTA Reference Examples]]
 
* [[Template:Banner BlockSim Reference Examples|Banner BlockSim Reference Examples]]
* ALTA_Reference_Examples_Banner.png
* [[Template:Banner DOE Reference Examples|Banner DOE Reference Examples]]
* BlockSim_Reference_Examples_Banner.png
* [[Template:Banner Predict Reference Examples|Banner Predict Reference Examples]]
* DOE_Reference_Examples_Banner.png
* [[Template:Banner RCM Reference Examples|Banner RCM Reference Examples]]
* Predict_Reference_Examples_Banner.png
* [[Template:Banner RENO Reference Examples|Banner RENO Reference Examples]]
* RCM_Reference_Examples_Banner.png
* [[Template:Banner RGA Reference Examples|Banner RGA Reference Examples]]
* RENO_Reference_Examples_Banner.png
* [[Template:Banner Weibull Reference Examples|Banner Weibull Reference Examples]]
* RGA_Reference_Examples_Banner.png
* [[Template:Banner Xfmea Reference Examples|Banner Xfmea Reference Examples]]
* Xfmea_Reference_Examples_Banner.png




</div>
</div>

Revision as of 17:03, 13 June 2014


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 design elements 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}}}}
Your text here.

{{Reference_Example_Heading1}}
Your text here.

{{Reference_Example_Heading2}}
Your text here.

{{Reference_Example_Heading3}}
Your text here.

{{Reference_Example_Heading4|YYY}}
Your text here.

where XXX is the name of the banner template for the software and YYY is the software name. If you do not define the parameters, the template will default to the Weibull++ banner design.

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

{{Reference Example|{{Banner 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.

For your convenience, below are the names of the banner templates for each software: