mediawiki/semantic-extra-special-properties

Provides extra special properties for Semantic MediaWiki

2.0.0 2018-10-12 08:33 UTC

README

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

Semantic Extra Special Properties (a.k.a. SESP) is an extension to Semantic MediaWiki which adds some extra special properties to enabled content pages.

Requirements

  • PHP 5.6 or later
  • MediaWiki 1.27 or later
  • Semantic MediaWiki 3.0 or later

Installation

The recommended way to install Semantic Extra Special Properties 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-extra-special-properties": "~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-extra-special-properties": "~2.0"

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.

Step 4

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

wfLoadExtension( 'SemanticExtraSpecialProperties' );

Step 5

Add the configuration parameters to the "LocalSettings.php" file according to your requirements below the call to wfLoadExtension added in step 4.

Step 6

This step may be skipped in case you are freshly intalling this extension. If this extension is being upgraded from an version earlier than 2.0.0 you have to change your configruation in the "LocalSettings.php" file according to the consise migration guide.

Step 7

Run the "update.php" maintenance script to ensure that property tables are properly initialized.

Verify installation success

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

Usage

The annotation process for predefined properties is mostly done in the background and therefore does not need any special interaction from a user but "LocalSettings.php" for SESP need to be enabled.

For details about available configruation parameters, please have a look at the configuration document.

Contribution and support

If you have remarks, questions, or suggestions, please send them to semediawiki-users@lists.sourceforge.net. You can subscribe to this list here.

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guildline. A list of people who have made contributions in the past can be found here.

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 2.0 or later