mediawiki / lingo
Provides hover-over tool tips on wiki pages from terms defined on a wiki page
Installs: 66 877
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 5
Language:JavaScript
Type:mediawiki-extension
Requires
- ext-dom: *
- composer/installers: >1.0.12
Requires (Dev)
Suggests
- mediawiki/semantic-glossary: Alternative back-end that retrieves terms and definitions from a Semantic MediaWiki store
- dev-master / 3.x-dev
- 3.2.4
- 3.2.3
- 3.2.0
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.0
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.2.0
- 1.1.0
- 1.0.1
- 1.0.0
- dev-REL1_43
- dev-REL1_42
- dev-REL1_39
- dev-REL1_41
- dev-REL1_40
- dev-REL1_35
- dev-REL1_38
- dev-REL1_37
- dev-REL1_36
- dev-REL1_31
- dev-REL1_34
- dev-REL1_33
- dev-REL1_32
- dev-REL1_30
- dev-REL1_29
- dev-REL1_28
- dev-REL1_27
- dev-REL1_26
- dev-REL1_25
- dev-REL1_24
- dev-REL1_23
This package is not auto-updated.
Last update: 2024-12-12 09:31:28 UTC
README
Lingo is a glossary extension to MediaWiki, that lets you define abbreviations and their definitions on a wiki page. It displays these definitions whenever an abbreviation is hovered over in an article.
See https://www.mediawiki.org/wiki/Extension:Lingo for online documentation.
Installation & Activation
The recommended way to install this extension is by using Composer.
- Add the following to the MediaWiki
composer.local.json
file
{ "require": { "mediawiki/lingo": "^3.0" } }
-
Run
php composer.phar update mediawiki/lingo
from the MediaWiki installation directory. -
Add the following code to your LocalSettings.php:
wfLoadExtension('Lingo');
Updating
Run php composer.phar update mediawiki/lingo
from the MediaWiki installation
directory.
Customization
Add the following to LocalSettings.php
and uncomment/modify as needed:
$wgHooks['SetupAfterCache'][] = function() { // specify a different name for the terminology page (Default: 'Terminology' (or localised version). See MediaWiki:Lingo-terminologypagename.) //$GLOBALS['wgexLingoPage'] = 'Terminology'; // specify that each term should be annotated only once per page (Default: false) //$GLOBALS['wgexLingoDisplayOnce'] = false; // specify what namespaces should or should not be used (Default: Empty, i.e. use all namespaces) //$GLOBALS['wgexLingoUseNamespaces'][NS_SPECIAL] = false; // set default cache type (Default: null, i.e. use main cache) //$GLOBALS['wgexLingoCacheType'] = CACHE_NONE; // use ApprovedRevs extension on the Terminology page (Default: false) //$GLOBALS['wgexLingoEnableApprovedRevs'] = true; };
Usage
By default Lingo will mark up any page that is not in a forbidden namespace. To exclude a page from markup you can include NOGLOSSARY anywhere in the article. In some cases it may be necessary to exclude portions of a page, e.g. because Lingo interferes with some JavaScript. This can be achieved by wrapping the part in an HTML element (e.g. a span or a div) and specify class="noglossary".
Terminology page
Create the page "Terminology" (no namespace), and insert some entries using the following syntax:
;FTP:File Transport Protocol ;AAAAA:American Association Against Acronym Abuse ;ACK:Acknowledge ;AFAIK:As Far As I Know ;AWGTHTGTATA:Are We Going To Have To Go Through All This Again ;HTTP:HyperText Transfer Protocol
Running tests
From the Lingo
directory run
php ../../tests/phpunit/phpunit.php --group extensions-lingo -c phpunit.xml.dist
Reporting bugs
Comments, questions and suggestions should be sent or posted to:
- the Lingo discussion page: https://www.mediawiki.org/wiki/Extension_talk:Lingo
- the maintainer: https://www.mediawiki.org/wiki/Special:EmailUser/F.trott
Credits
Lingo is a rewrite of Extension:Terminology, written by BarkerJr with modifications by Benjamin Kahn. It was originally written by Barry Coughlan and is currently maintained by Stephan Gambke.
License
GNU General Public License 2.0 or later.