Module:File link/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
m (Reverted edits by 198.223.227.19 (talk) to last version by Mr. Stradivarius)
m (27 revisions imported)
 
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Module rating|protected}}
{{Lua|Module:Yesno|Module:Arguments}}
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]].
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]].


Line 9: Line 11:
First, you need to import the module.
First, you need to import the module.


<source lang="lua">
<syntaxhighlight lang="lua">
local mFileLink = require('Module:File link')
local mFileLink = require('Module:File link')
</syntaxhighlight>
</source>


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


<source lang="lua">
<syntaxhighlight lang="lua">
mFileLink._main(args)
mFileLink._main(args)
</syntaxhighlight>
</source>


<var>args</var> is a table of arguments that can have the following keys:
<var>args</var> is a table of arguments that can have the following keys:
Line 28: Line 30:
* <code>size</code> - the size of the image, e.g. '100px', 'x100px' or '100x100px'.
* <code>size</code> - the size of the image, e.g. '100px', 'x100px' or '100x100px'.
* <code>upright</code> - the 'upright' parameter, used for setting the size of tall and thin images.
* <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 '' to suppress the default link to the file description page.
* <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>alt</code> - the alt text. Use the blank string '' to suppress the default alt text.
* <code>alt</code> - the alt text. Use the blank string <nowiki>''</nowiki> to suppress the default alt text.
* <code>caption</code> - a caption for the file.
* <code>caption</code> - a caption for the file.
* <code>page</code> - sets a page number for multi-paged files such as PDFs.
* <code>page</code> - sets a page number for multi-paged files such as PDFs.
Line 43: Line 45:


With the file only:
With the file only:
<source lang="lua">
<syntaxhighlight lang="lua">
mFileLink.main{file = 'Example.png'}
mFileLink.main{file = 'Example.png'}
-- Renders as [[File:Example.png]]
-- Renders as [[File:Example.png]]
</syntaxhighlight>
</source>


With format, size, link and caption options:
With format, size, link and caption options:
<source lang="lua">
<syntaxhighlight lang="lua">
mFileLink.main{
mFileLink.main{
file = 'Example.png',
file = 'Example.png',
Line 58: Line 60:
}
}
-- Renders as [[File:Example.png|thumb|220px|link=Wikipedia:Sandbox|An example.]]
-- Renders as [[File:Example.png|thumb|220px|link=Wikipedia:Sandbox|An example.]]
</syntaxhighlight>
</source>


With format, size, and border:
With format, size, and border:
<source lang="lua">
<syntaxhighlight lang="lua">
mFileLink.main{
mFileLink.main{
file = 'Example.png',
file = 'Example.png',
Line 69: Line 71:
}
}
-- Renders as [[File:Example.png|frameless|border|220px]]
-- Renders as [[File:Example.png|frameless|border|220px]]
</syntaxhighlight>
</source>


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

Latest revision as of 17:25, January 24, 2022

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 documentation at mediawiki.org.

Usage from wikitext

From wikitext, this module should be called from a template, usually {{file link}}. Please see the template page for documentation. However, it can also be called using the syntax {{#invoke:File link|main|arguments}}.

Usage from Lua

First, you need to import the module. 

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

Then you can make file links using the _main function. 

mFileLink._main(args)

args is a table of arguments that can have the following keys:

  • file - the filename. (required)
  • format - the file format, e.g. 'thumb', 'thumbnail', 'frame', 'framed', or 'frameless'.
  • formatfile - a filename to specify with the 'thumbnail' format option. The filename specified will be used instead of the automatically generated thumbnail.
  • border - set this to true or "yes" (or any other value recognized as true by Module:Yesno) to set a border for the image.
  • location - the horizontal alignment of the file, e.g. 'right', 'left', 'center', or 'none'.
  • alignment - the vertical alignment of the file, e.g. 'baseline', 'middle', 'sub', 'super', 'text-top', 'text-bottom', 'top', or 'bottom'.
  • size - the size of the image, e.g. '100px', 'x100px' or '100x100px'.
  • upright - the 'upright' parameter, used for setting the size of tall and thin images.
  • link - the page that the file should link to. Use the blank string '' to suppress the default link to the file description page.
  • alt - the alt text. Use the blank string '' to suppress the default alt text.
  • caption - a caption for the file.
  • page - sets a page number for multi-paged files such as PDFs.
  • class - adds a class parameter to image links. The MediaWiki software adds this parameter to the class="..." attribute of the image's <img /> element when the page is rendered into HTML.
  • lang - adds a language attribute to specify what language to render the file in.
  • start - specifies a start time for audio and video files.
  • end - specifies an end time for audio and video files.
  • thumbtime - specifies the time to use to generate the thumbnail image for video files.

To see the effect of each of these parameters, see the images help page on mediawiki.org.

Examples

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',
	format = 'thumb',
	size = '220px',
	link = 'Wikipedia:Sandbox',
	caption = 'An example.'
}
-- Renders as [[File:Example.png|thumb|220px|link=Wikipedia:Sandbox|An example.]]

With format, size, and border: 

mFileLink.main{
	file = 'Example.png',
	format = 'frameless',
	size = '220px',
	border = true
}
-- Renders as [[File:Example.png|frameless|border|220px]]


Retrieved from "https://crocwiki.com/wiki/Module:File_link/doc?oldid=21338"