Template:Official website/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 20:37, May 21, 2023

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 is used on approximately 239,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Shortcut

{{oweb}}

This template uses Lua:

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 (P7736) 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:

1= or URL= or url= is used to specify the URL. If this parameter is omitted, the value of "official website" Property (P7736) on Wikidata is used.
- NOTE: If this parameter is specified and doesn't match "official website" Property (P7736) on Wikidata, the page is added to Category:Official website different in Wikidata and Wikipedia for maintenance.
- If this parameter is specified but the "official website" Property (P7736) 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=

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

<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#P7736|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 official website (P7736):

{{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
Parameter		Description	Type	Status
url	`1` `url` `URL`	The url that the template will link to. This is required unless the URL is available from Wikidata. Default Wikidata property P7736 Example https://example.com	URL	optional
Text	`name`	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	String	optional
Mobile Website	`mobile`	If the website has a different 'official website' for mobile devices this website can be listed here Example https://m.example.com	String	optional
Requires Flash	`format`	If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash' Example flash	String	optional

Tracking categories

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

@@ Line 4: / Line 4: @@
 {{tsh|oweb}}
 {{Lua|Module:Official website|Module:Check for unknown parameters}}
-{{Uses Wikidata|P856}}
+{{Uses Wikidata|P7736}}
-{{Tracks Wikidata|P856}}
+{{Tracks Wikidata|P7736}}
 The purpose of this template is to provide a standard format for labeling links to the official website of an article's main topic.
@@ Line 12: / Line 12: @@
 === Basic usage ===
-This template can be used without specifying any parameters, if the [[d:Property:P856|"official website" Property (P856)]] is set in the respective article's [[WP:Wikidata|Wikidata]] record. Just add {{tlx|official website}} to the article's [[WP:ELOFFICIAL|External links]] section. If on Wikidata more than one official website is given, the entry tagged with the [[d:Property:P856|language]] being [[d:Q1860|English]] is automatically preferred.
+This template can be used without specifying any parameters, if the [[d:Property:P7736|"official website" Property (P7736)]] is set in the respective article's [[WP:Wikidata|Wikidata]] record. Just add {{tlx|official website}} to the article's [[WP:ELOFFICIAL|External links]] section. If on Wikidata more than one official website is given, the entry tagged with the [[d:Property:P7736|language]] being [[d:Q1860|English]] is automatically preferred.
 === Advanced usage ===
 Four parameters are available:
-*<code>1=</code> or <code>URL=</code> or <code>url=</code> is used to specify the URL. If this parameter is omitted, the value of [[d:Property:P856|"official website" Property (P856)]] on [[Wikidata]] is used.
+*<code>1=</code> or <code>URL=</code> or <code>url=</code> is used to specify the URL. If this parameter is omitted, the value of [[d:Property:P7736|"official website" Property (P7736)]] on [[Wikidata]] is used.
-**NOTE: If this parameter is specified and doesn't match [[d:Property:P856|"official website" Property (P856)]] on Wikidata, the page is added to [[:Category:Official website different in Wikidata and Wikipedia]] for maintenance.
+**NOTE: If this parameter is specified and doesn't match [[d:Property:P7736|"official website" Property (P7736)]] on Wikidata, the page is added to [[:Category:Official website different in Wikidata and Wikipedia]] for maintenance.
-**If this parameter is specified but the [[d:Property:P856|"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 specified but the [[d:Property:P7736|"official website" Property (P7736)]] 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]].
 *<code>2=</code> or <code>name=</code> is used to reformat the title if "Official website" is not suitable.
@@ Line 42: / Line 42: @@
 === URL in Wikidata ===
 Usage in the article [[Amazon (company)]]:
-* <code><nowiki>{{Official website}}</nowiki></code> → {{Official website|https://www.amazon.com}} [[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]]<pre style="white-space: pre-wrap;"><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]]</pre>
+* <code><nowiki>{{Official website}}</nowiki></code> → {{Official website|https://www.amazon.com}} [[File:OOjs UI icon edit-ltr-progressive.svg |frameless |text-top |10px |alt=Edit this at Wikidata |link=https://www.wikidata.org/wiki/Q3884#P7736|Edit this at Wikidata]]<pre style="white-space: pre-wrap;"><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#P7736|Edit this at Wikidata]]</pre>
 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 {{Property|P856}}:
+Usage on any page without a URL in Wikidata property {{Property|P7736}}:
 {{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Official website}}</nowiki>}}
@@ Line 65: / Line 65: @@
 			"type": "url",
 			"required": false,
-			"default": "Wikidata property P856",
+			"default": "Wikidata property P7736",
 			"example": "https://example.com"
 		},