Template:Rui/doc

Description
This template is a shortcut template of sorts. Rui stands for "Rugby union in" and it produces a wikilink to the Rugby union in article for a specified country. It's basic use is thus:  , which comes out as:.

A country's name or 3 letter code can be used. These codes are as specified by ISO, IOC, WR, or FIFA (most should work). A small handful of other well-known abbreviations are also available (such as UK, US, and USSR) – see the codes used as documented by the appropriate template in Category:Country data templates.

The main purpose of Rui is for use in tables and navboxes but it can be used in-line with text. An optional second parameter customises the display name, whether initially capitalized or shortened.

Usage
 

or

 

{ "description": "Creates a wikilink to the Rugby union in article for a specified country.", "params": { "1": {     "label": "Nation", "description": "Name of the nation or a three-letter country code (ISO, IOC, WR, FIFA – most will work). A small handful of other well-known abbreviations are also available (such as UK, US, and USSR).", "type": "string", "required": true },   "2": {      "label": "Config", "description": "Customizes the display name. The default option (when 2nd parameter not used) displays the initial letter as capitalised, i.e. Rugby union in .... If set to 1 the initial letter becomes lower case; rugby union in.... If set to 0 the display text is shortened to the country's NAME only. When set to any other value, the default Rugby union in ... version is used.", "type": "string", "required": false } } }

Please note:When the display text of this template is shortened to a "deceptive" plain country-name link wihin an article then readers are unlikely to click on it. It is often better to use the template in a compound item that includes "rugby in" or "rugby union in", so the reader knows where it goes. When used in a navbox or list, the heading should be such as to ensure the desination is known,

Usage
Standard examples with country names or country codes:
 *   →
 *   →
 *   →
 *   →.
 *   →
 *  </tt> →
 *  </tt> →

Examples showing effect of the optional 2nd parameter:
 *  </tt> →
 *  </tt> →
 *  </tt> →
 *  </tt> →
 *  </tt> →
 *  </tt> →
 *  </tt> →