View source for Template:Official website/doc

{{Documentation subpage}}
<!-- Please add categories at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Official website|Module:Check for unknown parameters}}
{{Uses Wikidata|P856}}
{{Tracks Wikidata|P856}}

The purpose of this template is to provide a standard format for labeling links to the official website of an article's main topic.

== Usage ==

=== Basic usage ===
This template can be used without specifying any parameters, if the [[d:Property:P856|"official website" Property (P856)]] is set in the respective article's [[WP:Wikidata|Wikidata]] record. Just add {{tlx|official website}} to the article's [[WP:ELOFFICIAL|External links]] section. If on Wikidata more than one official website is given, the entry tagged with the [[d:Property:P856|language]] being [[d:Q1860|English]] is automatically preferred.

=== Advanced usage ===
Four parameters are available:
*<code>1=</code> or <code>URL=</code> or <code>url=</code> is used to specify the URL. If this parameter is omitted, the value of [[d:Property:P856|"official website" Property (P856)]] on [[Wikidata]] is used.
**NOTE: If this parameter is specified and doesn't match [[d:Property:P856|"official website" Property (P856)]] on Wikidata, the page is added to [[:Category:Official website different in Wikidata and Wikipedia]] for maintenance.
**If this parameter is specified but the [[d:Property:P856|"official website" Property (P856)]] on Wikidata has not been set, the page is added to [[:Category:Official website not in Wikidata]] for maintenance.
**If this parameter is not specified and there is no official website available on Wikidata, the page is added to [[:Category:Official website missing URL]].
*<code>2=</code> or <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>

== Examples ==
=== URL in template ===
To the right of each example is the displayed output. Below each example is the actual output including {{tag|span}} tags.
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|www.example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|//www.example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|http://www.example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|https://www.example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|1=https://example.org/?action=view}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|https://example.org|name=Example}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|https://example.org|mobile=https://m.example.org}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website|https://example.org|format=flash}}</nowiki>}}

=== URL in Wikidata ===
Usage in the article [[Amazon (company)]]:''
* <code><nowiki>{{Official website}}</nowiki></code> → {{Official website|https://www.amazon.com}} [[File:Blue pencil.svg |frameless |text-top |10px |alt=Edit this at Wikidata |link=https://www.wikidata.org/wiki/Q3884#P856|Edit this at Wikidata]]<pre style="white-space: pre-wrap;"><span class="official-website"><span class="url">[https://www.amazon.com Official website]</span></span> [[File:Blue pencil.svg |frameless |text-top |10px |alt=Edit this at Wikidata |link=https://www.wikidata.org/wiki/Q3884#P856|Edit this at Wikidata]]</pre>

=== No URL in template or Wikidata ===
Usage on any page without a URL in Wikidata property {{Property|P856}}:
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website}}</nowiki>}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "The purpose of this template is to provide a standard format for labeling links to official websites.",
	"params": {
		"1": {
			"label": "url",
			"aliases": [
				"url",
				"URL"
			],
			"description": "The url that the template will link to. This is required unless the URL is available from Wikidata.",
			"type": "url",
			"required": false,
			"default": "Wikidata property P856",
			"example": "https://example.com"
		},
		"name": {
			"label": "Text",
			"description": "The text the URL will display. This should usually be left to the default. However, this parameter may be provided when there is another webpage that could reasonably understood as the official website and needs to be distinguished from this link.",
			"type": "string",
			"required": false,
			"example": "Publisher's website",
			"default": "Official website"
		},
		"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,
			"example": "https://m.example.com"
		},
		"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,
			"example": "flash"
		}
	}
}
</templatedata>

== Tracking categories ==
One of the following categories may be added to articles using this template (via [[Module:Official website]]):
* {{clc|Official website different in Wikidata and Wikipedia}}
* {{clc|Official website not in Wikidata}}
* {{clc|Official website missing URL}}
* {{clc|Pages using Official website with unknown parameters}}

== See also ==
* {{Tl|Official URL}} – For automatically inserting the official website Wikidata property
* {{Tl|URL}} – For use instead of {{Tl|Official website}} in infoboxes

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:External link templates using Wikidata]]
[[Category:Templates that add a tracking category]]
}}</includeonly>