Template:Official website/doc

40px

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.

wikipedia:Category:Template documentation pages

Usage

The purpose of this template is to provide a standard format for labeling links to official websites. The only required parameter is the URL. Three other parameters are also available:

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

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

Official website

Category:TemplateData documentation

<TemplateData> {

"description": "This template is used to mark articles without geolocation data (coordinates). Use the Coordinates: Missing latitude

Fatal error: The format of the coordinate could not be determined. Parsing failed.

template to add geographical data.",

       "params": {

"1": {

                       "label": "URL",
                       "description": "The URL that the template will link to",
                       "type": "string",
                       "required": true
               },
               "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>

Track changes made to this page

Official website/doc

Usage

TemplateData

See also