Extension:FontAwesome

MediaWiki extensions manual

FontAwesome Release status: stable
Implementation	Parser function , Skin
Description	Provides parser functions to insert FontAwesome icons
Author(s)	Stephan Gambke (F.trotttalk)
Maintainer(s)	Professional Wiki
Latest version	2.0.0 (2023-01-27)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.35+
PHP	7.4.3+
Database changes	No
Composer	mediawiki/font-awesome
License	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . README
Parameters $wgFaRenderMode
Hooks used ParserFirstCallInit ResourceLoaderRegisterModules

The FontAwesome extension provides parser functions to insert Font Awesome Free icons into the wiki text.

Currently Font Awesome Free, version 6.2.1 is included.

Requirements

• PHP 7.4.3 or later
• MediaWiki 1.35 or later

Installation

Using Composer

Using Composer is the recommended way to install this extension.

Run the following commands from the MediaWiki installation directory:

1. COMPOSER=composer.local.json php composer.phar require --no-update mediawiki/font-awesome ^2.0
2. php composer.phar update --no-dev mediawiki/font-awesome

To update the extension run the last command again.

Using a download from GitHub

1. Download a tar ball or zip file from GitHub
2. Extract it into the extensions directory of your MediaWiki installation
3. Rename the folder FontAwesome-... to FontAwesome

To update the extension delete the FontAwesome folder completely and re-install.

Activation

Add the following line to your "LocalSettings.php" file:

wfLoadExtension( 'FontAwesome' );

Configuration

There are two render modes available for FontAwesome icons:

• Web Fonts with CSS: This implementation uses web fonts as the file format and relies on the browser to render icons as it would any custom font.
• SVG with JavaScript: This implementation encodes icon data and the mechanism to display them in the browser in JavaScript code that the browser executes.

The render mode can be selected by setting the configuration parameter $wgFaRenderMode in "LocalSettings.php". Allowed values are: webfonts (default) and javascript.

Example: $wgFaRenderMode = 'javascript';

For a discussion of the advantages and drawbacks of the render modes see Performance & Font Awesome on fontawesome.com.

Usage

This extension defines three parser functions:

• {{#far:...}} to insert an icon from the FontAwesome Regular font
• {{#fas:...}} to insert an icon from the FontAwesome Solid font
• {{#fab:...}} to insert an icon from the FontAwesome Brands font

Example: {{#fab:wikipedia-w}} will insert the "Wikipedia-W" icon

For valid icon names see https://fontawesome.com/v6/search.

License

GNU General Public License 3.0 or later

The Font Awesome Free package is included in the extension. See its license file for details.

This extension is professionally maintained by the Professional Wiki team.