Quelltext der Seite Vorlage:Official website/doc

{{Documentation subpage}}
{{High-use|226351}}
<!-- Please add categories at the bottom of this page and interwikis at Wikidata -->
{{tsh|oweb|offl|offsite|official}}
{{Lua|Module:Official website|Module:Check for unknown parameters}}
{{Tracks and uses 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 ===
Two parameters are available:
* {{para|1}} or {{para|URL}} or {{para|url}} 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]].
*{{para|2}} or {{para|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.

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>}}

=== URL in Wikidata ===
Usage in the article [[Amazon (company)]]:
* <code><nowiki>{{Official website}}</nowiki></code> → {{Official website|https://www.amazon.com}} [[File:OOjs UI icon edit-ltr-progressive.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:OOjs UI icon edit-ltr-progressive.svg |frameless |text-top |10px |alt=Edit this at Wikidata |link=https://www.wikidata.org/wiki/Q3884#P856|Edit this at Wikidata]]</pre>

Note: If Wikidata holds two or more values in different languages, websites in English will be preferred. The module also prefers websites with a "preferred" Wikidata rank. If multiple websites are otherwise equally ranked in the module's criteria, the module will choose the website listed first.

=== 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": "This template provides a standard format for labeling links to official websites, stating \"Official website\" with the website linked. If no parameters are set in this template, the template will use the official website entered into Wikidata, if available.",
	"params": {
		"1": {
			"label": "URL",
			"aliases": [
				"url",
				"URL"
			],
			"description": "Leave this blank to use a URL entered into Wikidata. If there is no Wikidata URL or to override the Wikidata URL, entering a URL in this field will cause the template to link to this entered field.",
			"type": "url",
			"required": false,
			"default": "Wikidata property P856",
			"example": "https://example.com"
		},
		"name": {
			"label": "Display text",
			"description": "If left blank, the template text will display the words \"Official website\" with the URL linked to it. This field should usually be left blank. If there's another webpage that could reasonably understood as the official website and needs to be distinguished from the link in this template, replacement text can displayed by entering it into this field.",
			"type": "string",
			"required": false,
			"example": "Publisher's website",
			"default": "Official website",
			"aliases": [
				"2"
			]
		}
	},
	"paramOrder": [
		"1",
		"name"
	]
}
</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}}

== Handling dead links ==
It's possible that a URL no longer references hosted content, or ends up hosting different content than intended. In this case, the {{tlx|Official website}} should be replaced with an invocation of {{tlx|webarchive}} with a <code>title=</code> parameter of "Official website". For example: <code><nowiki>{{webarchive |url=https://web.archive.org/web/20051222144340/http://en.wikipedia.org/ |date=2005-12-22 |title=Official website}}</nowiki></code>. Such an invocation appears as:

:{{webarchive |url=https://web.archive.org/web/20051222144340/http://en.wikipedia.org/ |date=2005-12-22 |title=Official website}}

== See also ==
* {{Tl|Official URL}} – For inserting the official link itself as opposed to its name. Useful for [[Infobox]]es.

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
}}</includeonly>