mediawiki/lingo

Provides hover-over tool tips on wiki pages from terms defined on a wiki page

Friday, July 27, 2018
by s7eph4n
Repository
5 Watchers
1 Stars
11,322 Installations

JavaScript
2 Dependents
0 Suggesters
1 Forks
0 Open issues
19 Versions
8 % Grown

The README.md

Lingo

, _(*1)

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., _(*2)

See https://www.mediawiki.org/wiki/Extension:Lingo for online documentation., _(*3)

Installation & Activation

The recommended way to install this extension is by using Composer., _(*4)

Add the following to the MediaWiki composer.local.json file, _(*5)
```
{
"require": {
    "mediawiki/lingo": "^3.0"
}
}
```
Run php composer.phar update mediawiki/lingo from the MediaWiki installation directory., _(*6)
Add the following code to your LocalSettings.php:, _(*7)
```
wfLoadExtension('Lingo');
```

Updating

Run php composer.phar update mediawiki/lingo from the MediaWiki installation directory., _(*8)

Customization

Add the following to LocalSettings.php and uncomment/modify as needed:, _(*9)

$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"., _(*10)

Terminology page

Create the page "Terminology" (no namespace), and insert some entries using the following syntax:, _(*11)

;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, _(*12)

Running tests

From the Lingo directory run, _(*13)

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, _(*14)

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., _(*15)

License

GNU General Public License 2.0 or later., _(*16)

The Versions

27/07 2018

dev-master

9999999-dev https://www.mediawiki.org/wiki/Extension:Lingo

Provides hover-over tool tips on wiki pages from terms defined on a wiki page

mediawiki-extension lingo

Provides hover-over tool tips on wiki pages from terms defined on a wiki page

mediawiki/lingo

The README.md

Lingo

Installation & Activation

Updating

Customization

Usage

Terminology page

Running tests

Reporting bugs

Credits

License

The Versions

dev-master

The Requires

The Development Requires

by Stephan Gambke

3.0.0

The Requires

The Development Requires

by Stephan Gambke

dev-REL1_31

The Requires

The Development Requires

by Stephan Gambke

dev-REL1_30

The Requires

The Development Requires

by Stephan Gambke

2.0.3

The Requires

The Development Requires

by Stephan Gambke

2.0.2

The Requires

The Development Requires

by Stephan Gambke

dev-REL1_29

The Requires

The Development Requires

by Stephan Gambke

dev-REL1_28

The Requires

The Development Requires

by Stephan Gambke

dev-REL1_27

The Requires

The Development Requires

by Stephan Gambke

2.0.1

The Requires

The Development Requires

by Stephan Gambke

2.0.0

The Requires

by Stephan Gambke

dev-REL1_26

The Requires

by Stephan Gambke

dev-REL1_25

The Requires

by Stephan Gambke

dev-REL1_24

The Requires

by Stephan Gambke

1.2.0

The Requires

by Stephan Gambke

dev-REL1_23

The Requires

by Stephan Gambke

1.1.0

The Requires

by Stephan Gambke

1.0.1

The Requires

by Stephan Gambke

1.0.0