Template:Examples Box/documentation - Revision history

Kate Racaza at 19:00, 1 December 2015

2015-12-01T19:00:39Z

← Older revision		Revision as of 19:00, 1 December 2015
Line 4:		Line 4:
	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=

	~~This~~ series of templates is used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see [[Repairable_Systems_Analysis_Through_Simulation#Discussion\|Repairable Systems Analysis Through Simulation]]. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!'''''		The Examples Box template is a series of templates used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv.

	~~This template in~~ particular (i.e, ~~Template:Examples Box) contains~~ the ~~settings for~~ the ~~box itself, such as horizontal lines, shading~~, ~~etc~~. ~~There are four other templates~~ that ~~serve as the content for the box~~. ~~Complete instructions for building~~ the ~~box are given below.~~		Use this box to list examples that are relevant to the particular topic but are not appropriate for the reference book (e.g., examples that demonstrate how to perform the analysis in the software).

			For an example of how this element has been integrated into a reference book chapter, see [[Repairable_Systems_Analysis_Through_Simulation#Discussion\|Repairable Systems Analysis Through Simulation]]. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!'''''

	==Usage==		==Usage==
			There are five templates in this series. This template in particular (i.e., Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. The other four templates contain the settings for the bulleted contents of the box.

	To ~~insert~~ the ~~box and its contents~~, copy and paste the following code:		To use the templates, copy and paste the following code:

	<pre>		<pre>
	<div class="noprint">		<div class="noprint">
	{{Examples Box\|~~WIKI PAGE~~\|<p>More application examples are available! See also:</p>		{{Examples Box\|EXAMPLE_PAGE\|<p>More application examples are available! See also:</p>
	{{Examples Link\|~~WIKI PAGE~~\|~~ANCHOR TEXT~~}}<nowiki/>		{{Examples Link\|LINK\|ANCHOR_TEXT}}<nowiki/>
	{{Examples Link External\|~~HTML PAGE~~\|~~ANCHOR TEXT~~}}<nowiki/>		{{Examples Link External\|URL\|ANCHOR_TEXT}}<nowiki/>
	{{Examples Movie\|~~VIDEO~~ URL\|~~ANCHOR TEXT~~}}<nowiki/>		{{Examples Movie\|URL\|ANCHOR_TEXT}}<nowiki/>
	{{Examples Both\|~~HTML URL~~\|~~ANCHOR TEXT1~~\|~~VIDEO URL~~\|~~ANCHOR TEXT2~~}}<nowiki/>		{{Examples Both\|HTML_URL\|ANCHOR_TEXT1\|VIDEO_URL\|ANCHOR_TEXT2}}<nowiki/>}}
	}}
	</div>		</div>
	</pre>		</pre>
Line 25:		Line 27:
	The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.		The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.

	Once you have added the box code to your page, you will need to configure its parameters~~. The code shows the required parameters in ALL CAPS~~. Below are descriptions of the ~~templates and their~~ required parameters:		Once you have added the box code to your page, you will need to configure its parameters. Below are descriptions of the required parameters:

	:a) '''Examples Box''' contains the settings for the box itself, such as horizontal lines, shading, etc. It has 1 parameter:		:a) '''Examples Box''' contains the settings for the box itself, such as horizontal lines, shading, etc. It has 1 parameter:
	::* ~~WIKI PAGE~~ = the name of the wiki page that contains the application's examples index page (e.g., [[BlockSim Examples]])		::* EXAMPLE_PAGE = the name of the wiki page that contains the application's examples index page (e.g., [[BlockSim Examples]])

	:b) '''[[Template:Examples Link\|Examples Link]]''' is for linking to an example in another wiki page. It has 2 parameters:		:b) '''[[Template:Examples Link\|Examples Link]]''' is for linking to an example in another wiki page. It has 2 parameters:
	::* ~~WIKI PAGE~~ = the name of the wiki page (e.g., [[BlockSim Allocation Analysis Example]]).		::* LINK = the name of the wiki page (e.g., [[BlockSim Allocation Analysis Example]]).
	::* ~~ANCHOR NAME~~ = the name of the example that should be displayed for the wiki page (e.g., Allocation Example)		::* ANCHOR_TEXT = the name of the example that should be displayed for the wiki page (e.g., Allocation Example)

	:c) '''[[Template:Examples Link External\|Examples Link External]]''' is for linking to an example that's posted on another website such as ReliaSoft.com. It has 2 parameters:		:c) '''[[Template:Examples Link External\|Examples Link External]]''' is for linking to an example that's posted on another website such as ReliaSoft.com. It has 2 parameters:
	::*~~HTML~~ URL = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).		::*URL = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
	::*~~ANCHOR TEXT~~ = the name of the example that should be displayed for the link.		::*ANCHOR_TEXT = the name of the example that should be displayed for the link.

	:d) '''[[Template:Examples_Movie\|Examples Movie]]''' is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:		:d) '''[[Template:Examples_Movie\|Examples Movie]]''' is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:
	::*~~VIDEO~~ URL = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html).		::*URL = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html).
	::*~~ANCHOR TEXT~~ = the name of the example that should be displayed for the link (e.g., "Reliability of a Storage Cluster").		::*ANCHOR_TEXT = the name of the example that should be displayed for the link (e.g., "Reliability of a Storage Cluster").

	:e) '''[[Template:Examples Both\|Examples Both]]''' is for an example that's available both on an external website (e.g., ReliaSoft.com) and on ReliaSoft.tv. It has 4 parameters:		:e) '''[[Template:Examples Both\|Examples Both]]''' is for an example that's available both on an external website (e.g., ReliaSoft.com) and on ReliaSoft.tv. It has 4 parameters:
	::*~~HTML URL~~ = The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).		::*HTML_URL = The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
	::*~~ANCHOR TEXT1~~ = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").		::*ANCHOR_TEXT1 = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").
	::*~~VIDEO URL~~ = The URL for the video version of the example on ReliaSoft.tv (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.htm).		::*VIDEO_URL = The URL for the video version of the example on ReliaSoft.tv (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.htm).
	::*~~ANCHOR TEXT2~~ = The anchor text for the video version link (e.g., "Watch the video...").		::*ANCHOR_TEXT2 = The anchor text for the video version link (e.g., "Watch the video...").



			NOTE: The <code><nowiki><div class="noprint"></nowiki></code> in the template indicates that the box will NOT appear in the PDF version of the wiki page. The box does not render properly in PDF and is not very useful in printed materials anyway, so we've made the decision to exclude it from printing.

	==Example==		==Example==
Line 65:		Line 70:
	word-wrap: break-word;">		word-wrap: break-word;">
	<div class="noprint">		<div class="noprint">
	{{Examples_Box\| BlockSim_Examples\|<p>More application examples are available! See also:</p>		{{Examples_Box\|BlockSim_Examples\|<p>More application examples are available! See also:</p>
	{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>		{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>
	{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>		{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>
	{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>		{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>
	{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>		{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>}}
	}}
	</div>		</div>
	</pre>		</pre>

Kate Racaza at 18:18, 1 December 2015

2015-12-01T18:18:08Z

← Older revision		Revision as of 18:18, 1 December 2015
Line 13:		Line 13:

	<pre>		<pre>
			<div class="noprint">
	{{Examples Box\|WIKI PAGE\|<p>More application examples are available! See also:</p>		{{Examples Box\|WIKI PAGE\|<p>More application examples are available! See also:</p>
	{{Examples Link\|WIKI PAGE\|ANCHOR TEXT}}<nowiki/>		{{Examples Link\|WIKI PAGE\|ANCHOR TEXT}}<nowiki/>
Line 19:		Line 20:
	{{Examples Both\|HTML URL\|ANCHOR TEXT1\|VIDEO URL\|ANCHOR TEXT2}}<nowiki/>		{{Examples Both\|HTML URL\|ANCHOR TEXT1\|VIDEO URL\|ANCHOR TEXT2}}<nowiki/>
	}}		}}
			</div>
	</pre>		</pre>

Line 55:		Line 57:
	{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>		{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>
	{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>}}		{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>}}


	<pre style="white-space: pre-wrap;		<pre style="white-space: pre-wrap;
Line 61:		Line 64:
	white-space: -o-pre-wrap;		white-space: -o-pre-wrap;
	word-wrap: break-word;">		word-wrap: break-word;">
			<div class="noprint">
	{{Examples_Box\| BlockSim_Examples\|<p>More application examples are available! See also:</p>		{{Examples_Box\| BlockSim_Examples\|<p>More application examples are available! See also:</p>
	{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>		{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>
Line 67:		Line 71:
	{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>		{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>
	}}		}}
			</div>
	</pre>		</pre>


	</div>		</div>

Lisa Hacker at 23:37, 24 June 2015

2015-06-24T23:37:23Z

← Older revision		Revision as of 23:37, 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 16:30, 5 June 2014

2014-06-05T16:30:35Z

← Older revision		Revision as of 16:30, 5 June 2014
Line 70:		Line 70:


	.		</div>

Kate Racaza at 16:16, 5 June 2014

2014-06-05T16:16:10Z

Kate Racaza at 15:56, 5 June 2014

2014-06-05T15:56:39Z

← Older revision		Revision as of 15:56, 5 June 2014
Line 4:		Line 4:
	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=

	This series of templates is used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see ~~http://reliawiki.org/index.php/~~Repairable_Systems_Analysis_Through_Simulation#Discussion. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with templates!'''''		This template is one of five in a series of templates used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see [[Repairable_Systems_Analysis_Through_Simulation#Discussion\|Repairable Systems Analysis Through Simulation]]. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!'''''

	This template in particular (i.e, Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. There are four other templates that serve as the content for the box. Complete instructions for building the box are given below.		This template in particular (i.e, Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. There are four other templates that serve as the content for the box. Complete instructions for building the box are given below.
Line 23:		Line 23:
	The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.		The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.

	Once you have decided which "bullet" template you want to keep ~~or add~~, you will need to configure ~~the~~ parameters ~~of each template~~. In the code above, all the required parameters are shown in ALL CAPS.		Once you have decided which "bullet" template(s) you want to keep, you will need to configure its parameters. In the code above, all the required parameters are shown in ALL CAPS.

	Below are descriptions of the "bullet" templates and their parameters:		Below are descriptions of the "bullet" templates and their parameters:
Line 48:		Line 48:
	'''Example '''		'''Example '''

	The following example shows the complete box for a BlockSim ~~page:~~		The following example shows what the complete box might look like for a BlockSim topic. The code used to create the box is also shown below.

	~~<pre>~~		{{Examples_Box\|BlockSim_Examples\|<p>More application examples are available! See also:</p>
	{{Examples_Box\| BlockSim_Examples\|<p>More application examples are available! See also:</p>
	{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>		{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>
	{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>		{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>
	{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>		{{Examples Movie\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|This is an example with video only}}<nowiki/>
	{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>		{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>}}
	}}
	~~</pre>~~

	~~This code is rendered as follows~~:		<pre style="white-space: pre-wrap;
	{{Examples_Box\|BlockSim_Examples\|<p>More application examples are available! See also:</p>		white-space: -moz-pre-wrap;
			white-space: -pre-wrap;
			white-space: -o-pre-wrap;
			word-wrap: break-word;">
			{{Examples_Box\| BlockSim_Examples\|<p>More application examples are available! See also:</p>
	{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>		{{Examples Link\|BlockSim_Example:_CM_Triggered_by_Subsystem_Down\|This is a link to another wiki page}}<nowiki/>
	{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>		{{Examples Link External\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|This is a link to an example on ReliaSoft.com}}<nowiki/>
Line 66:		Line 67:
	{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>		{{Examples Both\|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm\|Reliability Analysis of a Storage Cluster System\|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html\|Watch the video...}}<nowiki/>
	}}		}}
			</pre>


			.

Kate Racaza: Created page with 'NOTOC
Category: Template Documentation ={{Font|Template Documentation|16|Calibri|bold|black}}= This serie…'

2014-06-05T00:02:25Z

Created page with '__NOTOC__<div style="background-color: #DBE9F4;"><noinclude>Category: Template Documentation</noinclude> ={{Font|Template Documentation|16|Calibri|bold|black}}= This serie…'

New page

__NOTOC__<div style="background-color: #DBE9F4;"><noinclude>[[Category: Template Documentation]]</noinclude>

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

This series of templates is used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see http://reliawiki.org/index.php/Repairable_Systems_Analysis_Through_Simulation#Discussion. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with templates!'''''

This template in particular (i.e, Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. There are four other templates that serve as the content for the box. Complete instructions for building the box are given below.

==Usage==

To insert the box and its contents, copy and paste the following code:

<pre>
{{Examples Box|WIKI PAGE|<p>More application examples are available! See also:</p>
{{Examples Link|WIKI PAGE|ANCHOR TEXT}}<nowiki/>
{{Examples Link External|HTML PAGE|ANCHOR TEXT}}<nowiki/>
{{Examples Movie|VIDEO URL|ANCHOR TEXT}}<nowiki/>
{{Examples Both|HTML URL|ANCHOR TEXT1|VIDEO URL|ANCHOR TEXT2}}<nowiki/>
}}
</pre>

The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.

Once you have decided which "bullet" template you want to keep or add, you will need to configure the parameters of each template. In the code above, all the required parameters are shown in ALL CAPS.

Below are descriptions of the "bullet" templates and their parameters:

:a) [[Template:Examples Link|Examples Link]] is for linking to an example in another wiki page. It has 2 parameters:
::* WIKI PAGE = the name of the wiki page (e.g., Page_Name).
::* ANCHOR NAME = the name of the example

:b) [[Template:Examples Link External|Examples Link External]] is for linking to an example that's posted on another website such as ReliaSoft.com. It has 2 parameters:
::*HTML URL = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
::*ANCHOR TEXT = the name of the example that should be displayed for the link.

:c) [[Template:Examples_Movie|Examples Movie]] is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:
::*VIDEO URL = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html).
::*ANCHOR TEXT = the name of the example that should be displayed for the link (e.g., "Reliability of a Storage Cluster").

:d) [[Template:Examples Both|Examples Both]] is for an example that's available both on an external website (e.g., ReliaSoft.com) and on ReliaSoft.tv. It has 4 parameters:
::*HTML URL = The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
::*ANCHOR TEXT1 = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").
::*VIDEO URL = The URL for the video version of the example on ReliaSoft.tv (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.htm).
::*ANCHOR TEXT2 = The anchor text for the video version link (e.g., "Watch the video...").

'''Example '''

The following example shows the complete box for a BlockSim page:

<pre>
{{Examples_Box| BlockSim_Examples|<p>More application examples are available! See also:</p>
{{Examples Link|BlockSim_Example:_CM_Triggered_by_Subsystem_Down|This is a link to another wiki page}}<nowiki/>
{{Examples Link External|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm|This is a link to an example on ReliaSoft.com}}<nowiki/>
{{Examples Movie|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html|This is an example with video only}}<nowiki/>
{{Examples Both|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm|Reliability Analysis of a Storage Cluster System|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html|Watch the video...}}<nowiki/>
}}
</pre>

This code is rendered as follows:
{{Examples_Box|BlockSim_Examples|<p>More application examples are available! See also:</p>
{{Examples Link|BlockSim_Example:_CM_Triggered_by_Subsystem_Down|This is a link to another wiki page}}<nowiki/>
{{Examples Link External|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm|This is a link to an example on ReliaSoft.com}}<nowiki/>
{{Examples Movie|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html|This is an example with video only}}<nowiki/>
{{Examples Both|http://www.reliasoft.com/BlockSim/examples/rc1/index.htm|Reliability Analysis of a Storage Cluster System|http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html|Watch the video...}}<nowiki/>
}}

← Older revision		Revision as of 16:16, 5 June 2014
Line 4:		Line 4:
	={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=		={{Font\|Template Documentation\|16\|Calibri\|bold\|black}}=

	This ~~template is one of five in a~~ series of templates used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see [[Repairable_Systems_Analysis_Through_Simulation#Discussion\|Repairable Systems Analysis Through Simulation]]. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!'''''		This series of templates is used to create a "See it in action box," which contains links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv. We will use this box when we have examples that are relevant to a particular topic but it’s not appropriate to integrate the example directly into the reference book chapter. For an example of how this element has been integrated into a reference book chapter, see [[Repairable_Systems_Analysis_Through_Simulation#Discussion\|Repairable Systems Analysis Through Simulation]]. '''''Note that this example is a live page on ReliaWiki. Please do not edit it or use it to experiment with the templates!'''''

	This template in particular (i.e, Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. There are four other templates that serve as the content for the box. Complete instructions for building the box are given below.		This template in particular (i.e, Template:Examples Box) contains the settings for the box itself, such as horizontal lines, shading, etc. There are four other templates that serve as the content for the box. Complete instructions for building the box are given below.
Line 23:		Line 23:
	The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.		The code inserts the box template and the four other "bullet" templates that serve as the content for the box. You can then choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed. You can also customize the content for any other situation by manually entering the necessary code to create the custom bullet.

	Once you have ~~decided which "bullet" template(s) you want~~ to ~~keep~~, you will need to configure its parameters. ~~In the~~ code ~~above, all~~ the required parameters ~~are shown~~ in ALL CAPS.		Once you have added the box code to your page, you will need to configure its parameters. The code shows the required parameters in ALL CAPS. Below are descriptions of the templates and their required parameters:

	~~Below are descriptions~~ of the ~~"bullet" templates and their parameters:~~		:a) '''Examples Box''' contains the settings for the box itself, such as horizontal lines, shading, etc. It has 1 parameter:
			::* WIKI PAGE = the name of the wiki page that contains the application's examples index page (e.g., [[BlockSim Examples]])

	:a) [[Template:Examples Link\|Examples Link]] is for linking to an example in another wiki page. It has 2 parameters:		:b) '''[[Template:Examples Link\|Examples Link]]''' is for linking to an example in another wiki page. It has 2 parameters:
	::* WIKI PAGE = the name of the wiki page (e.g., ~~Page_Name~~).		::* WIKI PAGE = the name of the wiki page (e.g., [[BlockSim Allocation Analysis Example]]).
	::* ANCHOR NAME = the name of the example		::* ANCHOR NAME = the name of the example that should be displayed for the wiki page (e.g., Allocation Example)

	:b) [[Template:Examples Link External\|Examples Link External]] is for linking to an example that's posted on another website such as ReliaSoft.com. It has 2 parameters:		:c) '''[[Template:Examples Link External\|Examples Link External]]''' is for linking to an example that's posted on another website such as ReliaSoft.com. It has 2 parameters:
	::*HTML URL = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).		::*HTML URL = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
	::*ANCHOR TEXT = the name of the example that should be displayed for the link.		::*ANCHOR TEXT = the name of the example that should be displayed for the link.

	:c) [[Template:Examples_Movie\|Examples Movie]] is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:		:d) '''[[Template:Examples_Movie\|Examples Movie]]''' is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:
	::*VIDEO URL = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html).		::*VIDEO URL = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html).
	::*ANCHOR TEXT = the name of the example that should be displayed for the link (e.g., "Reliability of a Storage Cluster").		::*ANCHOR TEXT = the name of the example that should be displayed for the link (e.g., "Reliability of a Storage Cluster").

	:d) [[Template:Examples Both\|Examples Both]] is for an example that's available both on an external website (e.g., ReliaSoft.com) and on ReliaSoft.tv. It has 4 parameters:		:e) '''[[Template:Examples Both\|Examples Both]]''' is for an example that's available both on an external website (e.g., ReliaSoft.com) and on ReliaSoft.tv. It has 4 parameters:
	::*HTML URL = The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).		::*HTML URL = The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
	::*ANCHOR TEXT1 = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").		::*ANCHOR TEXT1 = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").
Line 46:		Line 47:


	~~'''~~Example ~~'''~~		==Example==
			The following example shows what the box might look like for a BlockSim topic. The code used to build this example is also shown below.
	The following example shows what the ~~complete~~ box might look like for a BlockSim topic. The code used to ~~create the box~~ is also shown below.

	{{Examples_Box\|BlockSim_Examples\|<p>More application examples are available! See also:</p>		{{Examples_Box\|BlockSim_Examples\|<p>More application examples are available! See also:</p>