Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Official website/doc

Template page
Revision as of 14:58, 19 June 2024 by Master-Brent (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Basic usage[edit source]

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[edit source]

Two 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[edit source]

URL in template[edit source]

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>

URL in Wikidata[edit source]

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, websites in English will be preferred. The module also prefers websites with a "preferred" Wikidata rank. If multiple websites are otherwise equally ranked in the module's criteria, the module will choose the website listed first.

No URL in template or Wikidata[edit source]

Usage on any page without a URL in Wikidata property (P856):

  • {{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[edit source]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Official website in articles based on its TemplateData.

TemplateData for Official website

This template provides a standard format for labeling links to official websites, stating "Official website" with the website linked. If no parameters are set in this template, the template will use the official website entered into Wikidata, if available.

Template parameters

ParameterDescriptionTypeStatus
URL1 url URL

Leave this blank if using a URL entered into Wikidata. If there is no Wikidata URL or to override the Wikidata URL, entering a URL in this field will cause the template to link to this entered field.

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

If left blank, the template text will display the words "Official website" with the URL linked to it. This field should usually be left blank. If there another webpage that could reasonably understood as the official website and needs to be distinguished from the link in this template, replacement text can displayed by entering it into this field.

Default
Official website
Example
Publisher's website
Stringoptional

Tracking categories[edit source]

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

Handling dead links[edit source]

It's possible that a URL no longer references hosted content, or ends up hosting different content than intended. In this case, the {{Official website}} should be replaced with an invocation of {{webarchive}} with a title= parameter of "Official website". For example: {{webarchive |url=https://web.archive.org/web/20051222144340/http://en.wikipedia.org/ |date=2005-12-22 |title=Official website}}. Such an invocation appears as:

Official website at the Wayback Machine (archived 2005-12-22)

See also[edit source]

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