Template:Official website/doc

From imedwiki
< Template:Official website
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

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:

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.

  • {{Official website|example.org}}Official website
    <span class="official-website"><span class="url">[http://example.org Official website]</span></span>
  • {{Official website|www.example.org}}Official website
    <span class="official-website"><span class="url">[http://www.example.org Official website]</span></span>
  • {{Official website|//www.example.org}}Official website
    <span class="official-website"><span class="url">[//www.example.org Official website]</span></span>
  • {{Official website|http://www.example.org}}Official website
    <span class="official-website"><span class="url">[http://www.example.org Official website]</span></span>
  • {{Official website|https://www.example.org}}Official website
    <span class="official-website"><span class="url">[https://www.example.org Official website]</span></span>
  • {{Official website|1=https://example.org/?action=view}}Official website
    <span class="official-website"><span class="url">[https://example.org/?action=view Official website]</span></span>
  • {{Official website|https://example.org|name=Example}}Example
    <span class="official-website"><span class="url">[https://example.org Example]</span></span>
  • {{Official website|https://example.org|mobile=https://m.example.org}}Official website (Mobile)
    <span class="official-website"><span class="url">[https://example.org Official website]</span></span> (<span class="url">[https://m.example.org Mobile]</span>)
  • {{Official website|https://example.org|format=flash}}Official website (Requires Adobe Flash Player)
    <span class="official-website"><span class="url">[https://example.org Official website]</span></span> <span style="color:#505050">(Requires [[Adobe Flash Player]])</span>

URL in Wikidata

Usage in the article Amazon (company):

  • {{Official website}}Official website Edit this at Wikidata
    <span class="official-website"><span class="url">[https://www.amazon.com Official website]</span></span> [[File:OOjs UI icon edit-ltr-progressive.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 Template:Property:

  • {{Official website}}No URL found. Please specify a URL here or add one to Wikidata.
    <strong class="error">No URL found. Please specify a URL here or add one to Wikidata.</strong>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Official website

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

Template parameters

ParameterDescriptionTypeStatus
url1 url URL

The url that the template will link to. This is required unless the URL is available from Wikidata.

Default
Wikidata property P856
Example
https://example.com
URLoptional
Textname 2

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.

Default
Official website
Example
Publisher's website
Stringoptional
Mobile Websitemobile

If the website has a different 'official website' for mobile devices this website can be listed here

Example
https://m.example.com
Stringoptional
Requires Flashformat

If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash'

Example
flash
Stringoptional

Tracking categories

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

See also

  • {{Official URL}} – For inserting the official link itself as opposed to its name. Useful for Infoboxes.


This template is based (in parts) on the Template:Official website/doc from the free encyclopedia wikipedia and is licensed under GNU license for free documentation and the Creative Commons Attribution/Share Alike. On wikipedia there is a List of authors accessible. More about importing from wikipedia on page Imedwiki:Importing from wikipedia.