Template:Examples Box

From ReliaWiki
Revision as of 07:17, 17 August 2012 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search


Usage

Use this template to insert a "See it in action box," which contain links to examples in other wiki pages or in external websites, such as ReliaSoft.com and ReliaSoft.tv.

To insert the box in a wiki page, paste the following code.

{{Examples Box|link|<p>More application examples are available! See also:</p> 
{{Examples Link|link|anchor text}}<nowiki/>
{{Examples Link External|link|anchor text}}<nowiki/>
{{Examples Movie|link|anchor text}}<nowiki/>
{{Examples Both|link1|anchor text1|link2|anchor text2}}<nowiki/>
}}

The code inserts Template:Examples Box and 4 other templates that serve as the content for the box, where link and anchor text are the parameters of the templates


Template:Examples Box is for inserting the "See it in action" box. It has 2 parameters: the link to the application's examples page (e.g., BlockSim Examples) and any combination of the following templates that is appropriate for the situation.

a) Template:Examples Link is for linking to an example in another wiki page. It has 2 parameters:
  • link = the name of the wiki page (e.g., Page_Name).
  • anchor text = the name of the example
b) Template: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_Movie is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters:
d) Template: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) For any other situation, you can manually enter the necessary code to create the "custom" bullet.


For example:

{{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/>
}}

This code is rendered as: