diff --git a/README.md b/README.md index 1f36b2c..792a024 100644 --- a/README.md +++ b/README.md @@ -20,23 +20,62 @@ This [video](https://vimeo.com/129347298) demonstrates the functionality of the - PHP 5.6 or later - MediaWiki 1.27 or later -- [Semantic MediaWiki][smw] 2.4 or later +- [Semantic MediaWiki][smw] 2.5 or later ## Installation -The recommended way to install Semantic Breadcrumb Links is by using [Composer][composer] with an entry in MediaWiki's `composer.json`. +The recommended way to install Semantic Breadcrumb Links is using [Composer](http://getcomposer.org) with +[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer). -```json +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-breadcrumb-links": "~1.5" + "mediawiki/semantic-breadcrumb-links": "~2.0" } } ``` -1. From your MediaWiki installation directory, execute - `composer require mediawiki/semantic-breadcrumb-links:~1.5` -2. Navigate to _Special:Version_ on your wiki and verify that the package - have been successfully installed. + +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-breadcrumb-links": "~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( 'SemanticBreadcrumbLinks' ); + +### 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. ## Usage @@ -46,8 +85,8 @@ This [document](docs/README.md) decribes available settings and features of this ## 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. +If you want to contribute work to the project please subscribe to the developers mailing list and have a look +at the contribution guideline. * [File an issue](https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/issues) * [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/pulls) diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index c5c12f2..26d5247 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,5 +1,13 @@ This file contains the RELEASE-NOTES of the Semantic Breadcrumb Links (a.k.a. SBL) extension. +### 2.0.0 + +Released on October 6, 2018. + +* #52 Adds support for extension registration via "extension.json" + → Now you have to use `wfLoadExtension( 'SemanticBreadcrumbLinks' );` in the "LocalSettings.php" file to invoke the extension +* Localization updates from https://translatewiki.net + ### 1.5.1 Released on September 23, 2018. @@ -10,7 +18,8 @@ Released on September 23, 2018. Released on September 22, 2018. -* Requires PHP 5.6 or later +* Minimum requirement for PHP changed to version 5.6 and later +* Minimum requirement for Semantic MediaWiki changed to version 2.5 and later * #47/#49 Fixed integration with MediaWiki 1.30+ by using `subtitle` to show redirect, revision and display title information * #50 Added `$egSBLDisableTranslationSubpageAnnotation` to allow for disabling translation subpage annotation * Localization updates from https://translatewiki.net @@ -19,8 +28,8 @@ Released on September 22, 2018. Released on June 10, 2017. -* Requires PHP 5.5 or later -* Requires MediaWiki 1.27 or later +* Minimum requirement for PHP changed to version 5.5 and later +* Minimum requirement for MediaWiki changed to version 1.27 and later * #30 Added the `__NOBREADCRUMBLINKS__` behaviour switch allowing to suppress the display of a generated breadcrumb trail. * Localization updates from https://translatewiki.net @@ -37,14 +46,15 @@ Released on March 27, 2017. Released on July 9, 2016. -* Requires Semantic MediaWiki 2.4 or later +* Minimum requirement for Semantic MediaWiki changed to version 2.4 and later * Added `onoi/shared-resources` dependency -* Support for `Display title of` provided by SMW 2.4.0 +* Support for `Display title of` provided by Semantic MediaWiki 2.4.0 * Added `$egSBLEnabledSubpageParentAnnotation` to allow for subpage parents to be annotated automatically if no other `Has parent page` exists * Recognize `$egSBLPageTitleToHideSubpageParent` / `$wgNamespacesWithSubpages` when building the breadcrumb title * Apply italic styles for "hasChildren" early to avoid JS async display clutter +* Localization updates from https://translatewiki.net ### 1.2.0 @@ -59,7 +69,7 @@ Released on December 19, 2015. Released on June 2, 2015. -* Fixed unstyled content flashing observed in MW 1.25 +* Fixed unstyled content flashing observed in MediaWiki 1.25 * Added `$egSBLBreadcrumbDividerStyleClass` to assign styling options such as `sbl-breadcrumb-pipe` or `sbl-breadcrumb-arrow` * Localization updates from https://translatewiki.net diff --git a/composer.json b/composer.json index 5901968..7cc4aa7 100644 --- a/composer.json +++ b/composer.json @@ -9,7 +9,7 @@ "mediawiki", "breadcrumb" ], - "homepage": "https://www.semantic-mediawiki.org/wiki/Extension:SemanticBreadcrumbLinks", + "homepage": "https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Breadcrumb_Links", "license": "GPL-2.0-or-later", "authors": [ { diff --git a/extension.json b/extension.json index 4f97d4c..7ccf37b 100644 --- a/extension.json +++ b/extension.json @@ -1,6 +1,6 @@ { "name": "SemanticBreadcrumbLinks", - "version": "2.0.0-alpha", + "version": "2.0.0", "author": [ "James Hong Kong", "..." @@ -22,6 +22,6 @@ "ExtensionFunctions": [ "SemanticBreadcrumbLinks::onExtensionFunction" ], - "load_composer_autoloader":true, + "load_composer_autoloader": true, "manifest_version": 1 }