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:

Module:Official website

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 edit

Basic usage edit

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 weblinks' section. If on Wikidata more than one official website is given, the entry tagged with the language being English is automatically preferred.

Advanced usage edit

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 Wikispecies 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=

Code	Result
`{{Official website}}`	Official website (URL must be on Wikidata)
`{{Official website\|example.org}}`	Official website
`{{Official website\|www.example.org}}`	Official website
`{{Official website\|//www.example.org}}`	Official website
`{{Official website\|http://www.example.org/}}`	Official website
`{{Official website\|https://www.example.org/}}`	Official website
`{{Official website\|1=http://www.example.org/?action=view}}`	Official website
`{{Official website\|http://www.example.org\|name=Example}}`	Example
`{{Official website\|example.org\|mobile=http://m.example.org}}`	Official website (Mobile)
`{{Official website\|example.org\|format=flash}}`	Official website (Requires Adobe Flash Player)

TemplateData edit

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Official website

The purpose of this template is to provide a standard format for labeling links to official websites.

Template parameters
Parameter		Description	Type	Status
URL	`1` `URL`	The URL that the template will link to	String	optional
URL Text	`name`	The text the URL will display. If not provided this will default to 'Official website''	String	optional
Mobile Website	`mobile`	If the website has a different 'official website' for mobile devices this website can be listed here	String	optional
Requires Flash	`format`	If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash'	String	optional

Tracking categories edit

One of the following categories may be added to articles using this template (via Module:Official website):