Extension:Lingo/en

Lingo is a glossary extension. It lets you define a list of abbreviations and their definitions on a page and then displays these definitions whenever an abbreviation is hovered over in an article.

The Terminology page
By default Lingo will mark up any page with the terms and definitions defined on the Terminology page of your wiki (or the respective page in the language of your wiki). Just create that page and insert some entries using the following syntax:


 * FTP:File Transfer 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

You can use any characters in a term (including punctuation, spaces, all UTF-8 characters, but excluding the colon of course), you are not limited to only letters.

To give some structure to the Terminology page you are also allowed to have Terms and Definitions on separate lines. Any lines not starting with a semicolon or a colon  are ignored, so go ahead and insert empty lines, headlines, explanatory text.

Using this format you may assign one definition to multiple terms, e.g. to cover grammatical variants (see the U.S.A. example below) and multiple definitions to one term, e.g. to cover different meanings (see the ACK example). You may even combine this, i.e. have multiple definitions for a set of multiple terms. Finally you may also use transclusion, e.g. to have different glossaries for different topics and pull them all together on the Terminology page.


 * FTP
 * File Transfer Protocol


 * AAAAA
 * American Association Against Acronym Abuse


 * ACK
 * Acknowledge
 * Acklington railway station


 * U.S.A.
 * USA
 * United States of America

Pull in more terminology from elsewhere:

Excluding text from markup
You can exclude an article from markup by including the magic word  anywhere in that article's text.

In some cases it may be necessary to exclude only portions of a page, e.g. because Lingo interferes with some JavaScript. This can be achieved by wrapping that part in an HTML element (e.g. a span or a div) and specifying. As a shorthand for  you can just use the  tag.

ApprovedRevs
Lingo supports the extension for the Terminology page. See Customization below.

Internationalization
The extension is pretty well internationalized by now, thanks to the efforts of the volunteers on https://translatewiki.net. (If your language is not supported yet, get an account there and help yourself. It's easy!) To find out the name of the Terminology page and of the  magic word in your wiki's language, have a look at the files in the   folder and the   file.

Installation
Lingo 3.1.2 requires


 * MediaWiki 1.39 or above
 * PHP 7.0 or above

Composer
Lingo should be installed using Composer. The package name is. For instructions on how to install Composer see MediaWiki's Composer User manual.


 * 1) Run   from the MediaWiki installation directory.
 * 2) Run   from the MediaWiki installation directory.
 * Any future update is then just a call to.
 * 1) Add to the end of :
 * 2) Do some customization if necessary (see below)
 * 3) Go to the Special:Version page of your wiki and verify that an entry for Lingo exists
 * 4) From Lingo's entry on the Special:Version page follow the link to the Terminology page of your wiki and insert some entries OR (if this page exists already) edit and re-save it to trigger the recreation of the glossary

Using packaged downloads
If Composer is not an option, you may also install it like this:
 * 1) Download Lingo 3.1.1 or the current development version (Alternatively you can clone Lingo using git.)
 * 2) Extract the files to the   directory
 * 3) If necessary rename the newly created directory to Lingo
 * 4) Add to the end of :
 * 5) Do some customization if necessary (see below)
 * 6) Go to the Special:Version page of your wiki and verify that an entry for Lingo exists
 * 7) From Lingo's entry on the Special:Version page follow the link to the Terminology page of your wiki and insert some entries OR (if this page exists already) edit and re-save it to trigger the recreation of the glossary

Customization
Add the following to  and uncomment/modify as needed:

MobileFrontend suppresses Lingo's styling, which makes all Definitions used on the article appear at the end of the page. To avoid this add the following to your LocalSettings.php when using MobileFrontend:

Lingo also provides an interface to plug in alternative dictionaries (backends). If you are interested in that, see Semantic Glossary for an example. You can also drop me a mail.

Finally you can provide your own styling. For the classes used by Lingo for the various HTML elements, please have a look at the.

Showcases

 * NORA online - Dutch Government Reference Architecture website
 * Helminthic Therapy Wiki - Information database about helminth replacement therapy - see notes here)
 * https://www.wissensmanagement.gv.at - Website for Knowledge Management in Austrian Government

Add your wiki here!

You can find other examples on the usage and version matrix

Version history

 * See here for the version history

Credits
Lingo is a rewrite of extension Terminology, written by BarkerJr with modifications by Benjamin Kahn. Lingo was originally written by Barry Coughlan and is currently maintained by WikiTeq.

Lingo makes use of the jQuery qTip2 library.

Reporting bugs
Bugs and feature requests should preferably be reported on the Wikimedia bug tracker.

Comments, questions and suggestions should be sent or posted to:


 * the Lingo discussion page
 * the maintainer