Template:Reference Example/documentation: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:




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.  
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===
===Usage===
By default, this template is configured for Weibull++; however, you can customize it for use with any other reference example pages.
When you create a new page for a reference example, copy and paste the following code into the page:


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


To add this template to a Weibull++ reference example page, type the following:
{{Reference_Example_Heading1}}
Your text here.


<pre>{{Reference Example}}</pre>
{{Reference_Example_Heading2}}
Your text here.


'''Example 2'''
{{Reference_Example_Heading3}}
Your text here.


To add this template to any other reference example pages, type the following:
{{Reference_Example_Heading4|ZZZ}}
Your text here.</pre>


<pre>{{Reference Example|Image=XXX|Link:YYY}}</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 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:
The following example shows what the parameters might look like for the ALTA pages.


<pre>{{Reference Example|Image=RGA_Reference_Examples_Banner.png|Link=RGA_Reference_Examples}}</pre>
<pre>{{Reference Example|ALTA_Reference_Examples_Banner.png|ALTA_Reference_Examples}}
Your text here.


For your convenience, below is a list of the file names for all other software:
{{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.</pre>
 
==Notes==
 
For your convenience, below are the names of the banner file graphics for the Reference Example pages:


* ALTA_Reference_Examples_Banner.png
* ALTA_Reference_Examples_Banner.png
Line 36: Line 58:
* RGA_Reference_Examples_Banner.png
* RGA_Reference_Examples_Banner.png
* Xfmea_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.
<pre>{{Reference Example}}
Sample content
{{Reference_Example_Heading1}}
Sample content
{{Reference_Example_Heading2}}
Sample content
{{Reference_Example_Heading3}}
Sample content
{{Reference_Example_Heading4}}
Sample content</pre>
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!'''''




</div>
</div>

Revision as of 21:21, 9 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 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


Retrieved from "https://www.reliawiki.com/index.php?title=Template:Reference_Example/documentation&oldid=55377"