Extension:Semantic Glossary

From MediaWiki.org
(Redirected from Extension:SemanticGlossary)
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
Semantic Glossary
Release status: stable
px
Implementation User interface
Description A terminology markup extension with a Semantic MediaWiki back-end
Author(s) Stephan Gambke, James Hong Kong
Latest version 3.0 (2018-10-09)
Compatibility policy master
MediaWiki 1.27+
PHP 5.6+
Database changes No
Composer mediawiki/semantic-glossary
License GNU General Public License 2.0 or later
Download Download SemanticGlossary
README
RELEASE NOTES
Translate the Semantic Glossary extension if it is available at translatewiki.net
Check usage and version matrix.

The Semantic Glossary extension lets you define terms and abbreviations together with a definition. Whenever a term or abbreviation is hovered over in an article its definition is displayed.

The extension is an alternative back-end for the Lingo extension: Where the Lingo extension uses a dedicated page to store the glossary, Semantic Glossary retrieves the data from a Semantic MediaWiki store. The advantages of this approach are: the glossary can be queried like any other semantic data, storing of the data is not limited to one pre-defined page and editing the data can be made more user-friendly using Page Forms.

Properties[edit]

The following properties are used to hold the data of the glossary entries:

  • Glossary-Term: The term or abbreviation that is to be annotated on pages
  • Glossary-Definition: Its definition
  • Glossary-Link: The name of a page to which a link will be displayed alongside the definition (e.g. to link to a longer explanation of the term)
  • Glossary-Style: The name of a CSS class (or multiple classes, separated by spaces) that will be used to style the tooltip.

There must only ever be one definition per wiki page. The easiest way to ensure this and to keep the definition in one place is probably to use Semantic Internal Objects or SMW's subobjects.

The link may be any internal or interwiki link.

You can easily build a user interface to edit the glossary, e.g. using Page Forms. See this discussion entry for an example.

Internationalization[edit]

The extension is pretty well internationalized by now, thanks to the efforts of the volunteers on translatewiki.net. (If your language is not supported yet, get an account there and help yourself. It's easy!) To find out the names of the properties for your language, look at the "langcode".json file of the respective language and find the messages semanticglossary-prop-glt (Glossary-Term), semanticglossary-prop-gld (Glossary-Definition), semanticglossary-prop-gll (Glossary-Link), and semanticglossary-prop-gls (Glossary-Style). Or just use the default English property names, they should always work.

Features inherited from the Lingo extension[edit]

You can exclude an article from markup by including the magic word __NOGLOSSARY__ 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 class="noglossary". As a shorthand for <span class="noglossary"> you can just use the <noglossary> tag.

For inherited configuration parameters see Customization below.

Installation[edit]

Semantic Glossary requires MediaWiki 1.27.

The recommended way to install this extension is by using Composer.

1. Add the following to the MediaWiki composer.local.json file and run the php composer.phar update mediawiki/semantic-glossary command:

{
	"require": {
		"mediawiki/semantic-glossary": "~3.0"
	}
}

(Alternatively, if using Composer is not an option for you, you can download a tar ball or zip file from GitHub and extract it into the extensions directory of your MediaWiki installation.)

2. Add the following line to your LocalSettings.php:

wfLoadExtension( 'SemanticGlossary' );
Make sure that you do not invoke the required Lingo extension with the following call:
wfLoadExtension( 'Lingo' );
This will be done automatically via loading this extension.

3. Do some customization if necessary (see below)

4. Go to the Special:Version page of your wiki and verify that an entry for Semantic Glossary exists

Any future update is then just a call to php composer.phar update mediawiki/semantic-glossary.

You do not have to take care of any dependencies, those are solved by Composer. It is in particular NOT necessary to install the Lingo extension separately. Doing so will result in errors.

Customization[edit]

Semantic Glossary has inherited most of the settings available for the Lingo extension:

  • $wgexLingoPage to specify a different name for 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;
  • $wgexLingoCacheType to set default cache type (null = use main cache); Example: $wgexLingoCacheType = CACHE_NONE;

If you want to use these settings, just include them in LocalSettings.php. If you did not use Composer for the installation, they must come after the

wfLoadExtension( 'SemanticGlossary' );

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

Not yet implemented[edit]

The extension should be able to

  • store a context (page, category, namespace, concept) for every term and only markup the term on wiki pages belonging to the context;
  • invalidate affected pages when a term is changed;

Version history[edit]

Screen shots & example setup[edit]

Please find information for a detailed example here.

Contact[edit]

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

See also[edit]