Template:Clean image/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
(Created page with "{{Documentation}} Cleans and formats an input image. This removes the following things if present: * <code><nowiki>[[File:</nowiki></code> * <code><nowiki>]]</nowiki></code> * <code><nowiki>|</nowiki></code> and <code><nowiki>{{!}}</nowiki></code>, and everything following the first of these until the end Then it re-packages the image into a new file container, with specified height, width, and link. The <code>frameless</code> modifier is used, which prevents the image...") |
InvalidCards (talk | contribs) (fix links with bsw stuff instead of rsw) |
||
Line 28: | Line 28: | ||
| Just clean |
| Just clean |
||
| <pre>{{clean image|file={{{image}}}}}</pre> |
| <pre>{{clean image|file={{{image}}}}}</pre> |
||
| {{clean image|file=[[File:Basic bacon.png|100px|link= |
| {{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]}} |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}]]</pre> |
<pre>[[File:{FILENAME}]]</pre> |
||
Line 35: | Line 35: | ||
| Clean + width |
| Clean + width |
||
| <pre>{{clean image|file={{{image}}}|width=50}}</pre> |
| <pre>{{clean image|file={{{image}}}|width=50}}</pre> |
||
| {{clean image|file=[[File:Basic bacon.png|100px|link= |
| {{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|width=50}} |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}|{WIDTH}px]]</pre> |
<pre>[[File:{FILENAME}|{WIDTH}px]]</pre> |
||
Line 41: | Line 41: | ||
| Clean + height |
| Clean + height |
||
| <pre>{{clean image|file={{{image}}}|height=20}}</pre> |
| <pre>{{clean image|file={{{image}}}|height=20}}</pre> |
||
| {{clean image|file=[[File:Basic bacon.png|100px|link= |
| {{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|height=20}} |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}|x{HEIGHT}px]]</pre> |
<pre>[[File:{FILENAME}|x{HEIGHT}px]]</pre> |
||
Line 50: | Line 50: | ||
{{clean image|file={{{image}}}|width=11|height=50}} |
{{clean image|file={{{image}}}|width=11|height=50}} |
||
{{clean image|file={{{image}}}|width=66|height=66}}</pre> |
{{clean image|file={{{image}}}|width=66|height=66}}</pre> |
||
|<poem>{{clean image|file=[[File:Basic bacon.png|100px|link= |
|<poem>{{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|width=44|height=20}} |
||
{{clean image|file=[[File:Basic bacon.png|100px|link= |
{{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|width=11|height=50}} |
||
{{clean image|file=[[File:Basic bacon.png|100px|link= |
{{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|width=66|height=60}}</poem> |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}|{WIDTH}x{HEIGHT}px]]</pre> |
<pre>[[File:{FILENAME}|{WIDTH}x{HEIGHT}px]]</pre> |
||
Line 60: | Line 60: | ||
|- |
|- |
||
| Clean + link |
| Clean + link |
||
| <pre>{{clean image|file={{{image}}}|link= |
| <pre>{{clean image|file={{{image}}}|link=Sturlet}}</pre> |
||
| {{clean image|file=[[File:Basic bacon.png|100px|link= |
| {{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|link=Sturlet}} |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}|link={LINK}]]</pre> |
<pre>[[File:{FILENAME}|link={LINK}]]</pre> |
||
Line 67: | Line 67: | ||
| Clean + link suppress |
| Clean + link suppress |
||
| <pre>{{clean image|file={{{image}}}|link=no}}</pre> |
| <pre>{{clean image|file={{{image}}}|link=no}}</pre> |
||
| {{clean image|file=[[File:Basic bacon.png|100px|link= |
| {{clean image|file=[[File:Basic bacon.png|100px|link=pirate]]|link=no}} |
||
| Should result in |
| Should result in |
||
<pre>[[File:{FILENAME}|link=]]</pre> |
<pre>[[File:{FILENAME}|link=]]</pre> |
Latest revision as of 12:45, 7 April 2024
Template:Clean image invokes function main in Module:Clean image using Lua.
Cleans and formats an input image. This removes the following things if present:
[[File:
]]
|
and{{!}}
, and everything following the first of these until the end
Then it re-packages the image into a new file container, with specified height, width, and link. The frameless
modifier is used, which prevents the image being resized larger than its actual dimensions.
Usage
{{clean image |file = wikitext to be cleaned; this should usually be a template parameter (e.g. |file={{{image}}}); required |width = width of image; no default; exclude 'px' |height = height of image; no default; exclude 'px'; can be combined with width |link = link to apply to image; no default (will link to file page); setting to no will suppress normal link |align = alignment of image; left, center, right; no default }}
Examples
To be practical the results will be as if |image=[[File:Basic bacon.png|100px|link=abyssal whip]]
as the input.