Template:Official website/doc
 | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]The purpose of this template is to provide a standard format for labeling links to official websites. The only required parameter is the URL. Three other parameters are also available:
name=is used to reformat the title if "official website" is not suitable.
- NOTE: This name should succinctly and accurately describe the external link in relation to the subject. In particular, it should not include the article subject's name as the reader reasonably expects that all external links pertain to the subject.
mobile=is optionally used if there is a different "official website" for use with Mobile Web devicesformat=flashis optionally used if the website requires Adobe Flash Player software
Some URLs that contain special characters, such as & or =, will break the template. The solution is to prepend the URL with 1=
| Code | Result |
|---|---|
{{Official website|example.org}}
|
Official website |
{{Official website|www.example.org}}
|
Official website |
{{Official website|http://www.example.org/}}
|
Official website |
{{Official website|https://www.example.org/}}
|
Official website |
{{Official website|1=http://www.example.org/?action=view}}
|
Official website |
{{Official website|http://www.example.org|name=Example}}
|
Example |
{{Official website|example.org|mobile=http://m.example.org}}
|
Official website (Mobile) |
{{Official website|example.org|format=flash}}
|
Lua error: expandTemplate: template "Link note" does not exist. |
TemplateData
[edit]This is the TemplateData documentation for the template used by the new VisualEditor.
Official website
The purpose of this template is to provide a standard format for labeling links to official websites.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| URL | 1 | The URL that the template will link to | String | required |
| URL Text | name | The text the URL will display. If not provided this will default to 'Official website'' | String | optional |
| Mobile Website | mobile | If the website has a different 'official website' for mobile devices this website can be listed here | String | optional |
| Requires Flash | format | If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash' | String | optional |
See also
[edit]- {{URL}} – for use instead of {{Official website}} in infoboxes
- {{Official websites}} – for multiple websites such as for different countries (preferably in English)
- {{Official websites in}} – for multiple websites in different languages (preferably in English)