Template:Official website/doc: Difference between revisions
en>DePiep |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Please add categories at the bottom of this page and interwikis at Wikidata --> | <!-- Please add categories at the bottom of this page and interwikis at Wikidata --> | ||
{{tsh|oweb|official}} | {{tsh|oweb|official}} | ||
{{Lua|Module:Official website|Module:Check for unknown parameters}} | {{Lua|Module:Official website|Module:Check for unknown parameters}} | ||
The purpose of this template is to provide a standard format for labeling links to the official website of an article's main topic. | 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 41: | Line 38: | ||
=== URL in Wikidata === | === URL in Wikidata === | ||
Usage in the article [[Amazon (company)]]: | Usage in the article [[w:Amazon (company)|Amazon]]: | ||
* <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#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> | ||
Note: If Wikidata holds two or more values, in different languages, the website in English will be used. | Note: If Wikidata holds two or more values, in different languages, the website in English will be used. | ||
== TemplateData == | == TemplateData == | ||
Latest revision as of 21:57, 16 November 2022
 | This is a documentation subpage for Template:Official website It may contain usage information, categories and other content that is not part of the original template page. |
 | 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 (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:
1=orURL=orurl=is used to specify the URL. If this parameter is omitted, the value of "official website" Property (P856) on Wikidata is used.- NOTE: If this parameter is specified and doesn't match "official website" Property (P856) 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 (P856) 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=orname=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=flashis 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<span class="official-website"><span class="url">[https://example.org Official website]</span></span>
{{Official website|https://example.org|format=flash}}→ Official website<span class="official-website"><span class="url">[https://example.org Official website]</span></span>
URL in Wikidata
Usage in the article Amazon:
{{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#P856|Edit this at Wikidata]]
Note: If Wikidata holds two or more values, in different languages, the website in English will be used.
TemplateData
TemplateData for Official website
The purpose of this template is to provide a standard format for labeling links to official websites.
| 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.
| URL | optional |
| Text | name 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.
| String | optional |
| Mobile Website | mobile | If the website has a different 'official website' for mobile devices this website can be listed here
| String | optional |
| Requires Flash | format | If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash'
| String | optional |
Tracking categories
One of the following categories may be added to articles using this template (via Module:Official website):
- Category:Official website different in Wikidata and Wikipedia (0)
- Category:Official website not in Wikidata (30)
- Category:Official website missing URL (0)
- Category:Pages using Official website with unknown parameters (0)
See also
- {{Official URL}} – For inserting the official link itself as opposed to its name. Useful for Infoboxes.
