Template:Examples Box: Difference between revisions
Kate Racaza (talk | contribs) (updated template documentation) |
Kate Racaza (talk | contribs) No edit summary |
||
Line 23: | Line 23: | ||
: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: | :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: | ||
::*link = the URL | ::*link = the URL of the example on the external website (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm). | ||
::*anchor text = the | ::*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: | :c) [[Template:Examples_Movie]] is for linking to an example that's only available as a video on ReliaSoft.tv. It has 2 parameters: | ||
::*link = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html). | ::*link = the URL for the ReliaSoft.tv web page (e.g., http://www.reliasoft.tv/blocksim/appexamples/blocksim_app_ex_1.html). | ||
::*anchor text = the | ::*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: | :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: | ||
Line 55: | Line 55: | ||
{{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| | {{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/> | ||
}} | }} | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</noinclude> | </noinclude> |
Revision as of 07:17, 17 August 2012
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:
- link = 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:
- link = 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:
- link - The URL for the HTML version of the example (e.g., http://www.reliasoft.com/BlockSim/examples/rc1/index.htm).
- anchor text = The anchor text for the HTML version link (e.g., "Reliability Analysis of a Storage Cluster System").
- link2 - 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...