Template:Reference Example/documentation - Revision history

Lisa Hacker at 23:40, 24 June 2015

2015-06-24T23:40:32Z

← Older revision		Revision as of 23:40, 24 June 2015
Line 1:		Line 1:
	__NOTOC__<div style="background-color: #DBE9F4;"~~><noinclude>[[Category: Template Documentation]]</noinclude~~>		__NOTOC__<div style="background-color: #DBE9F4;">

Kate Racaza at 21:10, 20 June 2014

2014-06-20T21:10:53Z

@@ Line 57: / Line 57: @@
 * [[Template:Banner Weibull Reference Examples|Banner Weibull Reference Examples]]
 * [[Template:Banner Xfmea Reference Examples|Banner Xfmea Reference Examples]]
 </div>

Kate Racaza at 17:03, 13 June 2014

2014-06-13T17:03:43Z

← Older revision		Revision as of 17:03, 13 June 2014
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>

Kate Racaza at 21:21, 9 June 2014

2014-06-09T21:21:35Z

← Older revision		Revision as of 21:21, 9 June 2014
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>

Kate Racaza at 23:04, 4 June 2014

2014-06-04T23:04:48Z

← Older revision		Revision as of 23:04, 4 June 2014
Line 1:		Line 1:
	__NOTOC__<div style="background-color: #DBE9F4;">		__NOTOC__<div style="background-color: #DBE9F4;"><noinclude>[[Category: Template Documentation]]</noinclude>

Kate Racaza at 18:48, 30 May 2014

2014-05-30T18:48:33Z

← Older revision		Revision as of 18:48, 30 May 2014
Line 5:		Line 5:


	This template is ~~used~~ in the ~~Reference Examples~~ pages ~~for all Synthesis applications~~. It contains the design for the banner/header that runs across the top of those pages.		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===		===Usage===

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


	'''Example 1'''		'''Example 1'''
Line 17:		Line 15:

	<pre>{{Reference Example}}</pre>		<pre>{{Reference Example}}</pre>


	'''Example 2'''		'''Example 2'''
Line 40:		Line 37:
	* Xfmea_Reference_Examples_Banner.png		* Xfmea_Reference_Examples_Banner.png

	~~===Related Templates===~~

			==Related Templates==
	* [[Template:Reference_Example_Heading1]]		* [[Template:Reference_Example_Heading1]]
	* [[Template:Reference_Example_Heading2]]		* [[Template:Reference_Example_Heading2]]
	* [[Template:Reference_Example_Heading3]]		* [[Template:Reference_Example_Heading3]]
	* [[Template:Reference_Example_Heading4]]		* [[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>

Kate Racaza at 16:57, 30 May 2014

2014-05-30T16:57:47Z

← Older revision		Revision as of 16:57, 30 May 2014
Line 5:		Line 5:


	This template is used in the Reference Examples pages for all Synthesis applications.		This template is used in the Reference Examples pages for all Synthesis applications. It contains the design for the banner/header that runs across the top of those pages.

	==Usage==		===Usage===

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

	==Related Templates==		===Related Templates===

	* [[Template:Reference_Example_Heading1]]		* [[Template:Reference_Example_Heading1]]

Kate Racaza: /* Usage */

2014-05-29T22:59:22Z

Usage

← Older revision		Revision as of 22:59, 29 May 2014
Line 9:		Line 9:
	==Usage==		==Usage==

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

Kate Racaza: /* Usage */

2014-05-29T22:58:35Z

Usage

← Older revision		Revision as of 22:58, 29 May 2014
Line 29:		Line 29:
	<pre>{{Reference Example\|Image=RGA_Reference_Examples_Banner.png\|Link=RGA_Reference_Examples}}</pre>		<pre>{{Reference Example\|Image=RGA_Reference_Examples_Banner.png\|Link=RGA_Reference_Examples}}</pre>

	For your convenience, ~~the~~ list of ~~banner images~~ for all other software ~~are listed below~~:		For your convenience, below is a list of the file names for all other software:

	* ALTA_Reference_Examples_Banner.png		* ALTA_Reference_Examples_Banner.png
Line 39:		Line 39:
	* RGA_Reference_Examples_Banner.png		* RGA_Reference_Examples_Banner.png
	* Xfmea_Reference_Examples_Banner.png		* Xfmea_Reference_Examples_Banner.png


	==Related Templates==		==Related Templates==

Kate Racaza at 22:25, 29 May 2014

2014-05-29T22:25:57Z

← Older revision		Revision as of 22:25, 29 May 2014
Line 1:		Line 1:
	__NOTOC__<div style="background-color: #~~E3DAC9~~;">		__NOTOC__<div style="background-color: #DBE9F4;">


	{{Font\|Template Documentation\|16\|Calibri\|bold\|black}}		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=


	This template is used in the Reference Examples pages for all Synthesis applications.		This template is used in the Reference Examples pages for all Synthesis applications.

	=Usage=		==Usage==

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


			'''Example 1'''

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

	<pre>{{Reference Example}}</pre>		<pre>{{Reference Example}}</pre>

	~~===~~Example 2~~===~~
			'''Example 2'''

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

	<pre>{{Reference Example\|Image=XXX\|Link:YYY}}</pre>		<pre>{{Reference Example\|Image=XXX\|Link:YYY}}</pre>

	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:		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:

	<pre>{{Reference Example\|Image=RGA_Reference_Examples_Banner.png\|Link=RGA_Reference_Examples}}</pre>		<pre>{{Reference Example\|Image=RGA_Reference_Examples_Banner.png\|Link=RGA_Reference_Examples}}</pre>
Line 37:		Line 41:


	=Related Templates=		==Related Templates==

	* [[Template:Reference_Example_Heading1]]		* [[Template:Reference_Example_Heading1]]