Template:Reference Example/documentation: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by one other user not shown)
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 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===
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:
 
<pre>{{Reference Example|{{XXX}}}}
Your text here.
 
{{Reference_Example_Heading1}}
Your text here.


'''Example 1'''
{{Reference_Example_Heading2}}
Your text here.


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


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


'''Example 2'''
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.


To add this template to any other reference example pages, type the following:
The following example shows what the parameters might look like for the ALTA pages.


<pre>{{Reference Example|Image=XXX|Link:YYY}}</pre>
<pre>{{Reference Example|{{Banner ALTA Reference Examples}}}}
Your text here.


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


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


For your convenience, below is a list of the file names for all other software:
{{Reference_Example_Heading3}}
Your text here.


* ALTA_Reference_Examples_Banner.png
{{Reference_Example_Heading4|ALTA}}
* BlockSim_Reference_Examples_Banner.png
Your text here.</pre>
* 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


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


==Related Templates==
* [[Template:Banner ALTA Reference Examples|Banner ALTA Reference Examples]]
* [[Template:Reference_Example_Heading1]]
* [[Template:Banner BlockSim Reference Examples|Banner BlockSim Reference Examples]]
* [[Template:Reference_Example_Heading2]]
* [[Template:Banner DOE Reference Examples|Banner DOE Reference Examples]]
* [[Template:Reference_Example_Heading3]]
* [[Template:Banner Predict Reference Examples|Banner Predict Reference Examples]]
* [[Template:Reference_Example_Heading4]]
* [[Template:Banner RCM Reference Examples|Banner RCM Reference Examples]]
* [[Template:Banner RENO Reference Examples|Banner RENO Reference Examples]]
* [[Template:Banner RGA Reference Examples|Banner RGA Reference Examples]]
* [[Template:Banner Weibull Reference Examples|Banner Weibull Reference Examples]]
* [[Template:Banner Xfmea Reference Examples|Banner Xfmea Reference Examples]]


'''Notes'''
===Modifying the Blue Header===
Wherever this template is transcluded, a blue header that shows the name of the page will be displayed at the top of the said page. There may be several reasons why you might want to change the text displayed in the header; for example, the page name is not ideal or you want to change the capitalization, etc.


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.
'''''IMPORTANT''': If the page name has a typo, you must use the '''Move''' feature to transfer the page to a new page with an appropriate name. Do not use the instructions presented below.''


<pre>{{Reference Example}}
To change the text in the blue header, you must modify the Reference Example template as shown in the following example:
Sample content


{{Reference_Example_Heading1}}
<pre>{{Reference Example|{{Banner ALTA Reference Examples}}|ZZZ}}</pre>
Sample content


{{Reference_Example_Heading2}}
where '''ZZZ''' is the text you want to appear in the blue header.
Sample content


{{Reference_Example_Heading3}}
For another example, see [[Repairable Systems Analysis Reference Example]]. ''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!''
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>

Latest revision as of 23:40, 24 June 2015


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:

Modifying the Blue Header

Wherever this template is transcluded, a blue header that shows the name of the page will be displayed at the top of the said page. There may be several reasons why you might want to change the text displayed in the header; for example, the page name is not ideal or you want to change the capitalization, etc.

IMPORTANT: If the page name has a typo, you must use the Move feature to transfer the page to a new page with an appropriate name. Do not use the instructions presented below.

To change the text in the blue header, you must modify the Reference Example template as shown in the following example: 

{{Reference Example|{{Banner ALTA Reference Examples}}|ZZZ}}

where ZZZ is the text you want to appear in the blue header.

For another example, see Repairable Systems Analysis Reference Example. Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!



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