mediawiki/semantic-meta-tags

A Semantic Mediawiki extension to add meta tags with content generated from semantic annotations.

1.5.0 2018-10-09 12:04 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Packagist download count

Semantic Meta Tags (a.k.a. SMT) is a Semantic Mediawiki extension to enhance the meta tags of an article with content generated from semantic annotations.

This extension enables to automatically extend the HTML <meta> tags of an article with content generated from selected properties to create:

  • Standard tags (e.g meta name="keywords") as well as
  • Summary card and Open Graph protocol tags (e.g meta property="og:title")

Requirements

Installation

The recommended way to install Semantic Meta Tags is using Composer with MediaWiki's built-in support for Composer.

Note that the required extension Semantic MediaWiki must be installed first according to the installation instructions provided.

Step 1

Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php" file is located. If you have not yet installed Composer do it now by running the following command in your shell:

wget https://getcomposer.org/composer.phar

Step 2

If you do not have a "composer.local.json" file yet, create one and add the following content to it:

{
	"require": {
		"mediawiki/semantic-meta-tags": "~1.5"
	}
}

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-meta-tags": "~1.5"

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

Step 3

Run the following command in your shell:

php composer.phar update --no-dev

Note if you have Git installed on your system add the --prefer-source flag to the above command. Also note that it may be necessary to run this command twice. If unsure do it twice right away.

Verify installation success

As final step, you can verify SCI got installed by looking at the "Special:Version" page on your wiki and check that it is listed in the semantic extensions section.

Documentation

This document describes features as well as necessary settings.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

Tests

This extension provides unit and integration tests that are run by a continues integration platform but can also be executed using composer phpunit from the extension base directory.

License

GNU General Public License, version 2 or later.