| Index: trunk/extensions/Lingo/README |
| — | — | @@ -1 +1,73 @@ |
| 2 | | -See http://www.mediawiki.org/wiki/Extension:Lingo for installation instructions |
| | 2 | +Lingo is a glossary extension to MediaWiki, that lets you define abbreviations |
| | 3 | +and their definitions on a wiki page. It displays these definitions whenever an |
| | 4 | +abbreviation is hovered over in an article. |
| | 5 | + |
| | 6 | +The extension is still in early stages, so please report bugs. |
| | 7 | + |
| | 8 | +See http://www.mediawiki.org/wiki/Extension:Lingo for online documentation. |
| | 9 | + |
| | 10 | + |
| | 11 | +== Installation == |
| | 12 | + |
| | 13 | +This extension was developed for MediaWiki 1.16 und upwards. Other version might |
| | 14 | +work, but are not tested. |
| | 15 | + |
| | 16 | +1. Download the package. Unpack the folder inside /extensions (so that the files |
| | 17 | + are in /extensions/Lingo, rename the folder if necessary). |
| | 18 | + |
| | 19 | +2. In your LocalSettings.php, add the following line to the end of the file: |
| | 20 | + |
| | 21 | + require_once("$IP/extensions/Lingo/Lingo.php"); |
| | 22 | + |
| | 23 | +3. Create the page "Terminology" (no namespace), and insert some entries using |
| | 24 | + the following syntax: |
| | 25 | + |
| | 26 | + |
| | 27 | +;FTP:File Transport Protocol |
| | 28 | +;AAAAA:American Association Against Acronym Abuse |
| | 29 | +;ACK:Acknowledge |
| | 30 | +;AFAIK:As Far As I Know |
| | 31 | +;AWGTHTGTATA:Are We Going To Have To Go Through All This Again |
| | 32 | +;HTTP:HyperText Transfer Protocol |
| | 33 | + |
| | 34 | + |
| | 35 | +== Customization == |
| | 36 | + |
| | 37 | +The following settings may be used: |
| | 38 | + |
| | 39 | +* $wgexLingoPage to specify the name of the terminology page |
| | 40 | + Example: $wgexLingoPage = 'Glossary'; |
| | 41 | + |
| | 42 | +* $wgexLingoDisplayOnce to specify that each term should be annotated only once |
| | 43 | + per page |
| | 44 | + Example: $wgexLingoDisplayOnce = true; |
| | 45 | + |
| | 46 | +* $wgexLingoUseNamespaces to specify what namespaces should or should not be used |
| | 47 | + Example: $wgexLingoUseNamespaces[NS_TALK] = false; |
| | 48 | + |
| | 49 | +If you want to use these settings, just include them in LocalSettings.php AFTER |
| | 50 | +the require_once("$IP/extensions/Lingo/Lingo.php"); |
| | 51 | + |
| | 52 | + |
| | 53 | +== Usage == |
| | 54 | + |
| | 55 | +By default Lingo will mark up any page that is not in a forbidden namespace. To |
| | 56 | +exclude a page from markup you can include __NOGLOSSARY__ anywhere in the |
| | 57 | +article. In some cases it may be necessary to exclude portions of a page, e.g. |
| | 58 | +because Lingo interferes with some JavaScript. This can be achieved by wrapping |
| | 59 | +the part in an HTML element (e.g. a span or a div) and specify class="noglossary". |
| | 60 | + |
| | 61 | + |
| | 62 | +== Credits == |
| | 63 | + |
| | 64 | +Lingo is a rewrite of Extension:Terminology, written by BarkerJr with |
| | 65 | +modifications by Benjamin Kahn. It was originally written by Barry Coughlan and |
| | 66 | +is currently maintained by Stephan Gambke. |
| | 67 | + |
| | 68 | + |
| | 69 | +== Reporting bugs == |
| | 70 | + |
| | 71 | +Comments, questions and suggestions should be sent or posted to: |
| | 72 | +* the Lingo discussion page: http://www.mediawiki.org/wiki/Extension_talk:Lingo |
| | 73 | +* the maintainer: http://www.mediawiki.org/wiki/Special:EmailUser/F.trott |
| | 74 | + |
| Index: trunk/extensions/Lingo/Lingo.php |
| — | — | @@ -9,7 +9,7 @@ |
| 10 | 10 | * @author Barry Coughlan |
| 11 | 11 | * @copyright 2010 Barry Coughlan |
| 12 | 12 | * @author Stephan Gambke |
| 13 | | - * @version 0.2 alpha |
| | 13 | + * @version 0.2 |
| 14 | 14 | * @licence GNU General Public Licence 2.0 or later |
| 15 | 15 | * @see http://www.mediawiki.org/wiki/Extension:Lingo Documentation |
| 16 | 16 | */ |
| — | — | @@ -17,7 +17,7 @@ |
| 18 | 18 | die( 'This file is part of a MediaWiki extension, it is not a valid entry point.' ); |
| 19 | 19 | } |
| 20 | 20 | |
| 21 | | -define( 'LINGO_VERSION', '0.2 alpha' ); |
| | 21 | +define( 'LINGO_VERSION', '0.2' ); |
| 22 | 22 | |
| 23 | 23 | |
| 24 | 24 | // set defaults for settings |