From 70213fc3a073beda13a38dece232dec111e8c8da Mon Sep 17 00:00:00 2001 From: Karsten Hoffmeyer Date: Sat, 6 Oct 2018 22:55:10 +0200 Subject: [PATCH] Release version 2.0.0 (#65) * Update RELEASE-NOTES.md * Update README.md * Update composer.json * Update extension.json --- README.md | 90 ++++++++++++++++++++++++++++++++++-------------- RELEASE-NOTES.md | 15 ++++++++ composer.json | 2 +- extension.json | 6 ++-- 4 files changed, 84 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b224203..1c8b2c6 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Several short [videos](https://www.youtube.com/playlist?list=PLIJ9eX-UsA5eI_YFdn ## Requirements -- PHP 5.5 or later +- PHP 5.6 or later - MediaWiki 1.27 or later - [Semantic MediaWiki][smw] 2.5 or later @@ -32,31 +32,73 @@ as a means to declare a citation resource. ## Installation -The recommended way to install Semantic Cite is by using [Composer][composer] with an entry in MediaWiki's `composer.json`. +The recommended way to install Semantic Cite 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-cite": "~1.4" + "mediawiki/semantic-cite": "~2.0" } } ``` -1. From your MediaWiki installation directory, execute - `composer require mediawiki/semantic-cite:~1.1` -2. Run the **maintenance [`update.php`][mw-update] script** to ensure that property tables - are properly initialized -3. 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-cite": "~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( 'SemanticCite' ); + +### Step 5 + +Run the **maintenance script ["update.php"][mw-update]** to ensure that property tables are properly +initialized. + +### 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 ![scite-sneak](https://cloud.githubusercontent.com/assets/1245473/8370671/7d8bfeac-1bcb-11e5-9007-79a3d39f70ce.png) -A citation resource collects all structured data of a citation under one unique key that -can be accessed through out the wiki and is created and managed by the `#scite` parser. +A citation resource collects all structured data of a citation under one unique key that can be accessed +through out the wiki and is created and managed by the `#scite` parser function. -Citation resources (those created by `#scite`) can be added to a source page -or any other wiki page each being identifiable by a citation key. +Citation resources (those created by `#scite`) can be added to a source page or any other wiki page each +being identifiable by a citation key. ``` {{#scite:Byrne 2008 @@ -71,22 +113,20 @@ or any other wiki page each being identifiable by a citation key. }} ``` -Above shows an example for a citation resource to be created by the `#scite` parser. More -information about `#scite` can be found [here][docs-scite]. +Above shows an example for a citation resource to be created by the `#scite` parser. More information about +`#scite` can be found [here][docs-scite]. ### In-text citation -A resource can be cited using the `Citation reference` (or its alias `CiteRef`) -property for an in-text annotation in form of `Lorem ipsum [[CiteRef::Byrne 2008]] ...` to appear as -`Lorem ipsum``[1]`` ...`. +A resource can be cited using the `Citation reference` (or its alias `CiteRef`) property for an in-text +annotation in form of `Lorem ipsum [[CiteRef::Byrne 2008]] ...` to appear as `Lorem ipsum``[1]`` ...`. -A reference list is automatically added to the content as soon as a `Citation reference` -annotation is added to a page. The magic word `__NOREFERENCELIST__` can be used to suppress -a reference list from showing on an individual page while `#referencelist` can be used to position -the list differently. +A reference list is automatically added to the content as soon as a `Citation reference` annotation is added +to a page. The magic word `__NOREFERENCELIST__` can be used to suppress a reference list from showing on an +individual page while `#referencelist` can be used to position the list differently. -More information about in-text citations and references can be found [here][docs-intext] together -with a description about the usage of the [`#referencelist`][docs-referencelist] parser. +More information about in-text citations and references can be found [here][docs-intext] together with a +description about the usage of the [`#referencelist`][docs-referencelist] parser function. For questions about Semantic Cite and [`Cite`][mw-cite], see the comments [section][docs-faq]. diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 98cfdfd..c70491f 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,5 +1,20 @@ This file contains the RELEASE-NOTES of the Semantic Cite (a.k.a. SCI) extension. +### 2.0.0 + +Released on October 6, 2018. + +* Minimum requirement for PHP changed to version 5.6 and later +* Minimum requirement for MediaWiki changed to version 1.27 and later +* #62 Added support for extension registration via "extension.json" + → Now you have to use `wfLoadExtension( 'SemanticCite' );` in the "LocalSettings.php" file to invoke the extension +* #60 Made citation targets to be highlighted (only works with Semantic MediaWiki 3.0.0 and later) +* #60 Made the link to resource on special page "Browse" (`Special:Browse`) adaptable via class + `.scite-citation-resourcelink a:before` +* Several internal code changes +* Localization updates from https://translatewiki.net + + ### 1.4.0 Released on May 28, 2017. diff --git a/composer.json b/composer.json index 7e593a4..9b79dbb 100644 --- a/composer.json +++ b/composer.json @@ -39,7 +39,7 @@ }, "extra": { "branch-alias": { - "dev-master": "1.x-dev" + "dev-master": "2.x-dev" } }, "autoload": { diff --git a/extension.json b/extension.json index c47c218..19161ec 100644 --- a/extension.json +++ b/extension.json @@ -1,8 +1,8 @@ { "name": "SemanticCite", - "version": "2.0.0-alpha", + "version": "2.0.0", "author": [ - "James Hong Kong" + "James Hong Kong" ], "url": "https://github.com/SemanticMediaWiki/SemanticCite/", "descriptionmsg": "sci-desc", @@ -20,6 +20,6 @@ "ExtensionFunctions": [ "SemanticCite::onExtensionFunction" ], - "load_composer_autoloader":true, + "load_composer_autoloader": true, "manifest_version": 1 }