MediaWiki extensions manual
Release status: stable
Implementation Page action
Description Add a button to read the current page aloud
Author(s) Sophivorustalk
Latest version 1.1
MediaWiki >= 1.39.0
Database changes No
License GNU General Public License 3.0 or later
Example [1]
  • $wgReadAloudNamespaces
  • $wgReadAloudNearEdit
Quarterly downloads 0
Translate the ReadAloud extension if it is available at translatewiki.net

The ReadAloud extension adds a button to read the current page aloud by using the speech synthesis software built into modern browsers.

Installation edit

  • Download and move the extracted ReadAloud 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/ReadAloud
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ReadAloud' );
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration edit

ReadAloud requires no configuration. However, the following options are available. They are shown along with their default values:

// Namespaces where to show the "Read aloud" button
$wgReadAloudNamespaces = [ NS_MAIN ];

// Location of the "Read aloud" button
$wgReadAloudNearEdit = true;

Usage edit

Simply go to any page and click the "Read aloud" button. Reading should start after a few seconds. You can click on any paragraph to skip directly to it. Click the "Pause reading" button to pause the reading.

See also edit