Template:Official website/doc

From Visualshower
Jump to navigation Jump to search

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.

Prefer using this template instead of adding direct urls in the External links section.

Advanced usage[edit]

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

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 documentation for this template used by VisualEditor and other tools.

See the monthly error 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"],
                       "description": "The URL that the template will link to",
                       "type": "string",
                       "required": false
               },
               "name": {
                       "label": "URL Text",
                       "description": "The text the URL will display. If not provided this will default to 'Official website",
                       "type": "string",
                       "required": false
               },

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

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

} </TemplateData>

Tracking categories[edit]

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

See also[edit]