MediaWiki extensions manual

MsLinks Release status: stableCategory:Stable extensions
Implementation	Parser function Category:Parser function extensions
Description	Creates links to view or download files using icons appropriate to the file type
Author(s)	Martin Schwindl, Martin Keyler
Maintainer(s)	Sophivorus
Latest version	6.0 (2024-06-16)
MediaWiki	1.39+Category:Extensions with manual MediaWiki version
PHP	8.2+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control
Parameters $wgMSL_FileTypes
Hooks used EditPage::showEditForm:initial Category:EditPage::showEditForm:initial extensions ParserFirstCallInit Category:ParserFirstCallInit extensions
Quarterly downloads	11 (Ranked 101st)
Translate the MsLinks extension if it is available at translatewiki.net

The MsLinks extension adds a button to the editor that creates links to view or download files using icons appropriate to the file type.

Installation

• Download and move the extracted MsLinks folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MsLinks
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'MsLinks' );
  

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Vagrant installation:

• If using Vagrant , install with vagrant roles enable MsLinks --provision

Configuration

You can configure the icon that is associated with each file type, by adding the icon to the images folder of the MsLinks extension and setting the $wgMSL_FileTypes array appropriately. Below is the default configuration:

$wgMSL_FileTypes = [
	'no' => 'no_icon.png',
	'jpg' => 'image_icon.png',
	'gif' => 'image_icon.png',
	'bmp' => 'image_icon.png',
	'png' => 'image_icon.png',
	'tiff' => 'image_icon.png',
	'tif' => 'image_icon.png',
	'ai' => 'image_ai_icon.png',
	'psd' => 'image_ps_icon.png',
	'pdf' => 'pdf_icon.png',
	'pps' => 'pps_icon.png',
	'ppt' => 'pps_icon.png',
	'pptx' => 'pps_icon.png',
	'xls' => 'xls_icon.png',
	'xlsx' => 'xls_icon.png',
	'doc' => 'doc_icon.png',
	'docx' => 'doc_icon.png',
	'dot' => 'doc_icon.png',
	'dotx' => 'doc_icon.png',
	'rtf' => 'doc_icon.png',
	'txt' => 'txt_icon.png',
	'html' => 'code_icon.png',
	'php' => 'code_icon.png',
	'exe' => 'exe_icon.gif',
	'asc' => 'txt_icon.png',
	'dwg' => 'dwg_icon.gif',
	'zip' => 'zip_icon.png',
	'mov' => 'movie_icon.png',
	'mpeg' => 'movie_icon.png',
	'mpg' => 'movie_icon.png',
	'wmv' => 'movie_icon.png',
	'avi' => 'movie_icon.png',
	'mp4' => 'movie_icon.png',
	'flv' => 'movie_flash_icon.png',
	'wma' => 'music_icon.png',
	'mp3' => 'music_icon.png',
	'wav' => 'music_icon.png',
	'mid' => 'music_icon.png',
];

Usage

To insert a MsLink, simply edit a page and click on the new button in the toolbar. It will insert an empty MsLink, which you can then fill with the filename of the file you want to link to. You can also add some parameters to it, like in regular images. Below are some examples of usage:

Description	Input	Result
Basic MsLink	{{#l:Testfile.pdf}}	Testfile.pdf
MsLink with description	{{#l:Testfile.pdf|File description}}	File description
Icon on the right side	{{#l:Testfile.pdf|File description|right}}	File description
Direct MsLink	{{#l:dlink|Testfile.pdf|This file will be downloaded when clicked}}	This file will be downloaded when clicked

See also

• Extension:MsWikiEditor
• Extension:MsUpload
• Extension:MsCatSelect
• Extension:MsInsert

This extension is included in the following wiki farms/hosts and/or packages: Miraheze Category:Extensions included in Miraheze WikiForgeCategory:Extensions included in WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.