Editing Module:Clean image/doc

{{Documentation}}
Cleans an input image to prevent double linking.

{{Helper module
|name=Clean image
|fname1=<nowiki>clean{ file&nbsp;=&nbsp;[string|'no'], width&nbsp;=&nbsp;[string|nil], height&nbsp;=&nbsp;[string|nil], link&nbsp;=&nbsp;[string|nil], align&nbsp;=&nbsp;[string|nil] }</nowiki>
|ftype1=table
|fuse1=Used to clean up user input; extracts only the file name of the input and returns its own formatted link.
Input is a table with fields:
* <code>file</code> - the full wikitext to be cleaned. All processing is skipped if file is empty or is the string <code>no</code>.
* <code>width</code> - width to resize the file to; no default
* <code>height</code> - height to resize the file to, can be combined with width; no default
* <code>link</code> - what page to link the file to; no default (file will link to file page), <code>no</code> to link to nothing
* <code>align</code> - alignment for the image; <code>left, center, right</code>; no default
|example=
<syntaxhighlight lang='lua'>
local cleanImage = require( 'Module:Clean image' ).clean
mw.log( cleanImage{ file = '[[File:Basic bacon.png|link=Basic bacon|200px]]' } ) --> '[[File:Basic bacon.png|frameless]]'
</syntaxhighlight>
}}