http://www.mediawiki.org/wiki/Special:Code/MediaWiki/90088
Revision: 90088
Author: foxtrott
Date: 2011-06-14 21:11:36 +0000 (Tue, 14 Jun 2011)
Log Message:
-----------
preparing version 0.2
Modified Paths:
--------------
trunk/extensions/Lingo/Lingo.php
trunk/extensions/Lingo/README
Modified: trunk/extensions/Lingo/Lingo.php
===================================================================
--- trunk/extensions/Lingo/Lingo.php 2011-06-14 21:10:33 UTC (rev 90087)
+++ trunk/extensions/Lingo/Lingo.php 2011-06-14 21:11:36 UTC (rev 90088)
@@ -9,7 +9,7 @@
* @author Barry Coughlan
* @copyright 2010 Barry Coughlan
* @author Stephan Gambke
- * @version 0.2 alpha
+ * @version 0.2
* @licence GNU General Public Licence 2.0 or later
* @see http://www.mediawiki.org/wiki/Extension:Lingo Documentation
*/
@@ -17,7 +17,7 @@
die( 'This file is part of a MediaWiki extension, it is not a valid
entry point.' );
}
-define( 'LINGO_VERSION', '0.2 alpha' );
+define( 'LINGO_VERSION', '0.2' );
// set defaults for settings
Modified: trunk/extensions/Lingo/README
===================================================================
--- trunk/extensions/Lingo/README 2011-06-14 21:10:33 UTC (rev 90087)
+++ trunk/extensions/Lingo/README 2011-06-14 21:11:36 UTC (rev 90088)
@@ -1 +1,73 @@
-See http://www.mediawiki.org/wiki/Extension:Lingo for installation instructions
+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.
+
+The extension is still in early stages, so please report bugs.
+
+See http://www.mediawiki.org/wiki/Extension:Lingo for online documentation.
+
+
+== Installation ==
+
+This extension was developed for MediaWiki 1.16 und upwards. Other version
might
+work, but are not tested.
+
+1. Download the package. Unpack the folder inside /extensions (so that the
files
+ are in /extensions/Lingo, rename the folder if necessary).
+
+2. In your LocalSettings.php, add the following line to the end of the file:
+
+ require_once("$IP/extensions/Lingo/Lingo.php");
+
+3. 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
+
+
+== Customization ==
+
+The following settings may be used:
+
+* $wgexLingoPage to specify the name of the terminology page
+ Example: $wgexLingoPage = 'Glossary';
+
+* $wgexLingoDisplayOnce to specify that each term should be annotated only once
+ per page
+ Example: $wgexLingoDisplayOnce = true;
+
+* $wgexLingoUseNamespaces to specify what namespaces should or should not be
used
+ Example: $wgexLingoUseNamespaces[NS_TALK] = false;
+
+If you want to use these settings, just include them in LocalSettings.php AFTER
+the require_once("$IP/extensions/Lingo/Lingo.php");
+
+
+== 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".
+
+
+== 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.
+
+
+== Reporting bugs ==
+
+Comments, questions and suggestions should be sent or posted to:
+* the Lingo discussion page: http://www.mediawiki.org/wiki/Extension_talk:Lingo
+* the maintainer: http://www.mediawiki.org/wiki/Special:EmailUser/F.trott
+
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
