mediawiki/semantic-bundle

Bundle extension that installs and loads Semantic MediaWiki and associated extensions

Installs: 361

Dependents: 0

Suggesters: 0

Stars: 3

Watchers: 3

Forks: 0

Open Issues: 0

Type:mediawiki-extension


README

Latest Stable Version Download count

Bundle extension that installs and loads Semantic MediaWiki and associated extensions.

This bundle is for everyone that wants to get the full Semantic MediaWiki experience without individually installing all extensions or figuring out what those extensions are in the first place.

This version of Semantic Bundle requires PHP 7.1+ and MediaWiki 1.31+.

Bundled extensions

  • Semantic MediaWiki – Allows to store and query data annotated to pages
  • Semantic Breadcrumb Links – Allows to build breadcrumb links using semantic annotations
  • Semantic Cite – Allows to manage citation resources using semantic annotations
  • Semantic Compound Queries – Provides a parser function that displays multiple semantic queries at the same time
  • Semantic Extra Special Properties – Adds extra special properties to all pages
  • Semantic Glossary – Allows to define terms as well as abbreviations and manage them with semantic annotations
  • Semantic Interlanguage Links – Allows to create and manage interlanguage links with semantic annotations
  • Semantic Meta Tags – Allows to extend the meta elements in the HTML header of a page with content generated from semantic annotations
  • Semantic Result Formats – Provides additional formats for semantic queries
  • Maps – Allows embedding of dynamic maps, geocoding and geospatial operations
  • Mermaid – Provides a parser function to generate diagrams and flowcharts with the help of the mermaid script language
  • Modern Timeline – Provides a modern timeline visualization for Semantic MediaWiki as a result format
  • Page Forms – Allows to create and use forms for adding and editing pages with and without semantic data

Installation

Semantic Bundle is installed using Composer with MediaWiki's built-in support for Composer.

Step 1/5: composer.local.json

Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:

{
	"require": {
		"mediawiki/semantic-bundle": "~2.0"
	}
}

If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:

"mediawiki/semantic-bundle": "~2.0"

Remember to add a comma to the end of the preceding line in this section.

Step 2/5: composer update

Run the following command in your shell:

composer update --no-dev

Step 3/5: require SemanticBundle.php

Add the following line to the end of your "LocalSettings.php" file:

require_once __DIR__ . '/extensions/SemanticBundle/SemanticBundle.php';

Step 4/5: enable Semantic MediaWiki

Add the following line to the end of your "LocalSettings.php" file:

enableSemantics( 'example.org' );

Update the enableSemantics line with your domain name. For more information see the enableSemantics documentation.

Step 5/5: run update.php

Run the update.php script from the base directory of your MediaWiki installation:

php maintenance/update.php

Verify everything went alright

Check the "Special:Version" page on your wiki. If it lists Semantic MediaWiki, installation was successful.

How this works

This section is to provide extra background to people familiar with the MediaWiki extension registration mechanism. Understanding it is not required for using Semantic Bundle.

Semantic Bundle pulls in all relevant Semantic MediaWiki extensions via Composer by defining them as dependency in its require section. By including SemanticBundle.php you enable these extensions, since SemanticBundle.php calls wfLoadExtensions just like you would do if you had installed them individually.

If you want to only load some of the extensions, you can call wfLoadExtensions yourself instead of including SemanticBundle.php.

Update/version policy

Like this included extensions, Semantic Bundle itself follows semantic versioning. This means that we avoid breaking changes in all but our major versions.

In other words, if you install version ~42.0 of Semantic Bundle, you can run composer update at any later time without worrying a breaking change will be included. No extensions will be removed, no extensions will be added and no extensions will be upgraded to a new version that itself has breaking changes.

To get the latest set of extensions included by Semantic Bundle, make sure your "composer.local.json" file contains the latest version of Semantic Bundle.