Module:File link/doc: Difference between revisions

{{Module rating|protected}}

This module is used to construct wikitext links to files. It is primarily useful for templates and modules that use complicated logic to make file links. Simple file links should be made with wikitext markup directly, as it uses less resources than calling this module. For help with wikitext file markup please refer to the [[mw:Help:Images|documentation at mediawiki.org]].

 

First, you need to import the module.

 

local mFileLink = require('Module:File link')

 

Then you can make file links using the <code>_main</code> function.

 

mFileLink._main(args)

 

<var>args</var> is a table of arguments that can have the following keys:

* <code>upright</code> - the 'upright' parameter, used for setting the size of tall and thin images.

* <code>link</code> - the page that the file should link to. Use the blank string <nowiki>''</nowiki> to suppress the default link to the file description page.

* <code>caption</code> - a caption for the file.

* <code>page</code> - sets a page number for multi-paged files such as PDFs.

 

With the file only:

mFileLink.main{file = 'Example.png'}

-- Renders as [[File:Example.png]]

 

With format, size, link and caption options:

mFileLink.main{

file = 'Example.png',

}

-- Renders as [[File:Example.png|thumb|220px|link=Wikipedia:Sandbox|An example.]]

 

With format, size, and border:

mFileLink.main{

file = 'Example.png',

}

-- Renders as [[File:Example.png|frameless|border|220px]]

 

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||