Template:Official website/doc

{{Documentation subpage}}

{{High-use|226351}}

{{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 "official website" Property (P856) is set in the respective article's Wikidata record. Just add {{tlx|official website}} to the article's External links section. If on Wikidata more than one official website is given, the entry tagged with the language being English is automatically preferred.

= Advanced usage =

Two parameters are available:

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

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={{Official website|example.org}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|www.example.org}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|//www.example.org}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|http://www.example.org}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|https://www.example.org}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|1=https://example.org/?action=view}}}}

{{nowiki template demo|format=inline|output=nowiki+|code={{Official website|https://example.org|name=Example}}}}

= URL in Wikidata =

Usage in the article Amazon (company):

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={{Official website}}}}

TemplateData

{{TemplateData header}}

{

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

]

}

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 inserting the official link itself as opposed to its name. Useful for Infoboxes.

{{sandbox other||

Category:External link templates using Wikidata

Category:Templates that add a tracking category

}}