Module:File link/doc

This module is used to construct wikitext links to files, using a fluent Lua interface. This is done by creating a fileLink object, which has various methods corresponding to different file link parameters. The module is used from other Lua modules, and cannot be used directly from wiki pages.

Creating the object
First, you need to import the module.

Then, create the object using the  function. The first parameter is the filename, and is optional.

Basic usage
You can add parameters to the file link using the fileLink object's methods. (See the Methods section below for the full list.)

You can then produce the link wikitext using the object's  method.

Call-chaining
All the object's methods apart from the  method return the object itself, so can be used to call-chain.

Apart from the  method, all of the object's methods support   as an input, so call-chaining can be performed with variables whose value is unknown. However, an error will be raised if the input is of an unsupported type for that method. Please see the Methods section for supported input types for each method.

Use with tostring
Instead of using the  method, you can call   on the object to create the link wikitext.