Extension:XGlossary/Readme

=xGlossary Readme (v0.1.3)= Well, this archive contains the current version of xGlossary extension (v. 0.1.3), released under the GNU GPL 3 license. It is now completed and fully featured (from my point of view, of course ;) ) but it yet needs to be tested by others!

It is mainly a PHP extension, with a few wiki templates and JS to help a bit things.

It has been tested with MediaWiki 1.15 and PHP 5.2.

The “ ” directory is the PHP extension – install it as any other mediawiki extension. It is fully documented in the “ ” file, preferably accessed through the  wiki func (just put it in an empty page…).

The other parts are sample content, designed for Blender wiki – but they should be easily usable with other wiki, as long as you append the jQuery inclusion in your wiki skin. Note the wiki-xml-export version of templates and sample content should be the easiest way to quickly setup a functional sample!

The “ ” directory contains the templates used in conjunction with the xGlossary extension:

IMPORTANT: These templates also use some of the “Languages” ones already defined on Blender wiki. However, I have included them here:

The “ ” directory contains text files of all “glossary content” example pages. WARNING: All these use the “Doc” namespace – they won’t work if you have not such defined namespace!

The CSS and JS files… For Blender skin:

For Monobook skin:

I also put a wiki-xml-export version of these templates and sample content, “ ”.

The “ ” is a copy of the official skin (as of 2009/12/15), with just jQuery path made local (to be able to use it offline!) – so you shouldn’t need it in most cases…

Note: to use the example data of the archive, you should add these lines in your “ ” file, after including glossary extension:

require_once "$IP/extensions/xglossary/xglossary.setup.php"; $wgxGlossarySettings->mEnsynRedirMsg = array("en" => "See the “” entry.",                                            "fr" => "Voyez l’entrée “”.");
 * 1) xGlossary extension…

With this glossary-template redefined this way, the auto-generated “synonyms” entries will use the  template for back link, instead of a standard wiki-link – not a crucial point, but for consistency…