Template:Official website/doc

This is a documentation subpage for Template:Official website.
It contains usage information, categories and other content that is not part of the original template page.

This template uses Lua:

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

Four parameters are available:

1= or URL= or url= is used to specify the URL. If this parameter is omitted, the value of "official website" Property (P856) on Wikidata is used.
- NOTE: If this parameter is specified and doesn't match "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 "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.
2= or 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 devices.
format=flash is 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=

Examples

URL in template

To the right of each example is the displayed output. Below each example is the actual output including <span></span> tags. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found. Lua error in package.lua at line 80: module 'Module:Template test case/data' not found.

URL in Wikidata

Usage in the article Amazon (company):

{{Official website}} → Official website

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

Note: If Wikidata holds two or more values, in different languages, the website in English will be used.

No URL in template or Wikidata

Usage on any page without a URL in Wikidata property (P856): Lua error in package.lua at line 80: module 'Module:Template test case/data' not found.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Official website

<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):