Wiki: 1 revision

2014-05-11T08:12:38Z

1 revision

Corphine: /* See also */

2013-11-28T10:39:19Z

‎See also

New page

{{Documentation subpage}}


== Usage ==
The [[WP:Templates for deletion/Log/2009_August 13#Template:Official|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:
*<code>name=</code> 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.
*<code>mobile=</code> is optionally used if there is a different "official website" for use with [[Mobile Web]] devices
*<code>format=flash</code> is optionally used if the website requires [[Adobe Flash Player]] software

Some URLs that contain special characters, such as <code>&</code> or <code>=</code>, will break the template. The solution is to prepend the URL with <code>1=</code>

{|class="wikitable"
|-
! Code !! Result
|-
| <code><nowiki>{{Official website|example.org}}</nowiki></code>
| {{Official website|example.org/}}
|-
| <code><nowiki>{{Official website|www.example.org}}</nowiki></code>
| {{Official website|www.example.org/}}
|-
| <code><nowiki>{{Official website|http://www.example.org/}}</nowiki></code>
| {{Official website|http://www.example.org/}}
|-
| <code><nowiki>{{Official website|https://www.example.org/}}</nowiki></code>
| {{Official website|https://www.example.org/}}
|-
| <code><nowiki>{{Official website|1=http://www.example.org/?action=view}}</nowiki></code>
| {{Official website|1=http://www.example.org/?action=view}}
|-
| <code><nowiki>{{Official website|http://www.example.org|name=Official example website}}</nowiki></code>
| {{Official website|http://www.example.org/|name=Official example website}}
|-
| <code><nowiki>{{Official website|example.org|mobile=http://m.example.org}}</nowiki></code>
| {{Official website|example.org/|mobile=http://m.example.org}}
|-
| <code><nowiki>{{Official website|example.org|format=flash}}</nowiki></code>
| {{Official website|example.org/|format=flash}}
|}
== TemplateData ==
{{TemplateDataHeader}}
<TemplateData>
{
"description": "This template is used to mark articles without geolocation data (coordinates). Use the {{coord}} template to add geographical data.",
"params": {
"1": {
"label": "URL",
"description": "The URL that the template will link to",
"type": "string",
"required": true
},
"name": {
"label": "URL Text",
"description": "The text the URL will display. If not provided this will default to 'Official website''",
"type": "string",
"required": false
},
"mobile": {
"label": "Mobile Website",
"description": "If the website has a different 'official website' for mobile devices this website can be listed here",
"type": "string",
"required": false
},
"format": {
"label": "Requires Flash",
"description": "If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash'",
"type": "string",
"required": false
}
}
}
</TemplateData>

== See also ==
*{{Tl|URL}} – for use instead of {{Tl|Official website}} in infoboxes
*{{Tl|Official websites}} – for multiple websites such as for different countries (preferably in English)
*{{Tl|Official websites in}} – for multiple websites in different languages (preferably in English)
<includeonly>

[[Category:External link templates|{{PAGENAME}}]]

</includeonly>

← Older revision	Revision as of 08:12, 11 May 2014
(No difference)

Template:Official website/doc - Revision history

Wiki: 1 revision

Corphine: /* See also */