Template:Clean URL: Difference between revisions

Revision as of 17:59, 17 December 2024

This template cleans up the display of external URLs, to simplify how they are shown on the wiki.

Usage

The URL should be passed as the only parameter of template. While the link itself will remain unchanged, the protocol, subdomains of www, and trailing slashes will all be cut from the text displayed.

{{clean URL|https://www.riso.co.jp/}}

riso.co.jp

Pattern recognition

Certain domains are recognized by this template, with custom simplification.

Instagram

{{clean URL|https://www.instagram.com/risokagaku/}}

@risokagaku

Archive.org

{{clean URL|https://web.archive.org/web/19990508115212/http://www4.mediagalaxy.co.jp/riso/}}

[archived]

This template can be edited to facilitate additional pattern matches as needed.

Known issues

This template is primarily used to process URLs which are themselves parameters from other templates—it's usually called in a format like {{clean URL|{{{1}}}}}. However, when it is called directly on a URL, if that address contains protected MediaWiki characters like | and = (very common in URLs with parameters) it will break the template call. In these cases you must first escape these characters.

TemplateData

An external URL display simplifier.

Template parameters[Edit template data]
Parameter		Description	Type	Status
URL	`1`	The URL to clean	URL	required

@@ Line 12: / Line 12: @@
 ==== Instagram ====
-<pre>{{clean URL|https://www.instagram.com/risokagaku/?hl=en}}</pre>
-{{clean URL|https://www.instagram.com/risokagaku/?hl=en}}
 <pre>{{clean URL|https://www.instagram.com/risokagaku/}}</pre>
 {{clean URL|https://www.instagram.com/risokagaku/}}
-<pre>{{clean URL|https://www.instagram.com/risokagaku}}</pre>
-{{clean URL|https://www.instagram.com/risokagaku}}
 ==== Archive.org ====
@@ Line 24: / Line 20: @@
 ''This template can be edited to facilitate additional pattern matches as needed.''
+== Known issues ==
+This template is primarily used to process URLs which are themselves ''parameters from other templates''—it's usually called in a format like <code><nowiki>{{clean URL|{{{1}}}}}</nowiki></code>. However, when it is called directly on a URL, if that address contains protected MediaWiki characters like <code>|</code> and <code>=</code> (very common in URLs with parameters) it will break the template call. In these cases you must first escape these characters.
 == TemplateData ==
@@ Line 41: / Line 40: @@
 </noinclude><includeonly><!--
 -->{{#ifexpr:{{#invoke:String|find|{{lc:{{{1|}}}}}|instagram.com}}>0
-|[{{{1|}}} @{{#rmatch:{{{1|}}}|/^(?:https?:\/\/)?(?:www\.)?(?:instagram.com\/)(.+?)\/?.+$/|\1}}]
+|[{{{1|}}} @{{#rmatch:{{{1|}}}|/^(?:https?:\/\/)?(?:www\.)?(?:instagram.com\/)([a-zA-Z0-9\._]+)/|\1}}]
 |{{#ifexpr:{{#invoke:String|find|{{lc:{{{1|}}}}}|archive.org}}>0
    |[{{{1|}}} <nowiki>[archived]</nowiki>]