Template:Examples Box/doc
Usage
Use this template to insert 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.
To insert the box in a wiki page, paste the following code.
{{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/>
}}
The code inserts Template:Examples Box and 4 other "bullet" templates that serve as the content for the box, where the configurable parameters are shown in ALL CAPS. You can edit the paragraph text (e.g., “More application examples are available…”) as needed to suit the situation. You can also choose which of the four “bullet” templates are appropriate for the situation and then duplicate/delete the rows as needed.
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:
- WIKI PAGE = the name of the wiki page (e.g., Page_Name).
- ANCHOR NAME = 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:
- 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 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 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...").
- 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:
More application examples are available! See also:
This is a link to another wiki page
This is a link to an example on ReliaSoft.com
This is an example with video only
Reliability Analysis of a Storage Cluster System or Watch the video...