3.1.0 release (#529)

3.1.0 release * Update COMPATIBILITY.md ** Update compatibility table * Update extension.json ** Update MediaWiki requirements ** Add extension requirements ** Update manifest version * Update composer.json ** Update version requirements * Update README.md ** Update requirements section * Update INSTALL.md ** Update installation instructions * Update RELEASE-NOTES.md ** Provide release information
SemanticMediaWiki · Aug 18, 2019 · aa0649f · aa0649f
1 parent 0ab592d
commit aa0649f
Show file tree

Hide file tree

Showing 8 changed files with 63 additions and 114 deletions.
diff --git a/README.md b/README.md
@@ -13,10 +13,9 @@ installation independently. For more information, visit the [SRF homepage][srf]
 
 ## Requirements
 
-- PHP 5.6 or later
-- MediaWiki 1.27 or later
+- PHP 7.0 or later
+- MediaWiki 1.31 or later
 - Semantic MediaWiki 3.0 or later
-- MySQL 5 or later or SQLite 3 or later
 
 ## Installation
 

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -2,21 +2,25 @@ These are the release notes for the [Semantic Result Formats](https://www.semant
 
 ## SRF 3.1.0
 
-Not yet released.
+Released on August 18, 2019.
 
-- [#513](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/513) Added `filename` as parameter to `format=vcard`
-- [#510](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/510)
-- [#500](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/500)
-- [#492](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/492)
-- [#467](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/467)
-- [#457](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/457)
-- [#459](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/459)
-- [#445](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/445)
-- [#443](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/443)
-
-## SRF 3.0.2
-
-* [#400](https://github.com/SemanticMediaWiki/SemanticResultFormats/issues/391) Fix Timeseries format: `uncaught exception: Invalid dimensions for plot` (by Christian Zagrodnick)
+* Minimum requirement for
+  * PHP changed to version 7.0 and later
+  * MediaWiki changed to version 1.31 and later
+* Added compatibility with Semantic MediaWiki 3.1.x
+* Improved compatibility with PHP 7.2+
+* Added `spreadsheet` format (by Stephan Gambke)
+* Deprecated `excel` format (by Stephan Gambke)
+* Added `gantt` result format (by Sebastian Schmid)
+* Added `filename` parameter to the `vcard` format (by James Hong Kong)
+* Added `template` parameter to the `outline` format (by James Hong Kong)
+* Added css `class` parameter to the `tree` format (by Stephan Gambke)
+* Improved `timeseries` format (by Christian Zagrodnick)
+  * Fixed `uncaught exception: Invalid dimensions for plot` 
+  * Only correct plot height when there are tabs
+* Other bug fixes and code improvements
+* Made the extension installable without the `php-gd` PHP extension
+* Updated translations (by translatewiki.net community)
 
 ## SRF 3.0.1
 

diff --git a/composer.json b/composer.json
@@ -44,7 +44,7 @@
 		"source": "https://github.com/SemanticMediaWiki/SemanticResultFormats"
 	},
 	"require": {
-		"php": ">=5.6.0",
+		"php": ">=7.0",
 		"composer/installers": "1.*,>=1.0.1",
 		"mediawiki/semantic-media-wiki": "~3.0",
 		"nicmart/tree": "^0.2.7",

diff --git a/docs/COMPATIBILITY.md b/docs/COMPATIBILITY.md
@@ -1,6 +1,5 @@
 This document holds the **compatibility information** for the Semantic Result Formats (SRF) extension.
 
-- For information on the release series, see the [version overview](https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/VERSIONS.md).
 - For a full list of changes in each release, see the [release notes](https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/RELEASE-NOTES.md).
 - For instructions on how to install the latest version, see the [installation instructions](https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/INSTALL.md).
 
@@ -16,65 +15,90 @@ minimum requirements are indicated in bold.
 		<th>PHP</th>
 		<th>MediaWiki</th>
 		<th>Semantic MediaWiki</th>
+		<th>Release status</th>
 	</tr>
+	<tr>
+		<th>3.2.x</th>
+		<td><strong>7.1.0</strong> - 7.4.x</td>
+		<td>1.31 - 1.33+</td>
+		<td>3.0.x - 3.1.x+</td>
+		<td>Future release</td>
+	<tr>
+	<tr>
+		<th>3.1.x</th>
+		<td><strong>7.0.0</strong> - 7.3.x</td>
+		<td><strong>1.31</strong> - 1.33</td>
+		<td>3.0.x - 3.1.x</td>
+		<td><strong>Stable release</strong></td>
+	<tr>
 	<tr>
 		<th>3.0.x</th>
-		<td><strong>5.6.x</strong> - latest</td>
-		<td><strong>1.27</strong> - latest</td>
+		<td><strong>5.6.0</strong> - 7.1.x</td>
+		<td><strong>1.27</strong> - 1.33</td>
 		<td><strong>3.0.x</strong></td>
+		<td>Obsolete release, no support</td>
 	<tr>
 	<tr>
 		<th>2.5.x</th>
-		<td><strong>5.5.x</strong> - 7.0.x</td>
+		<td><strong>5.5.0</strong> - 7.0.x</td>
 		<td><strong>1.23</strong> - 1.29</td>
 		<td>2.1.x - 2.5.x</td>
+		<td>Obsolete release, no support</td>
 	<tr>
 		<th>2.4.x</th>
 		<td>5.3.2 - 7.0.x</td>
 		<td>1.19 - 1.28</td>
 		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>2.3.x</th>
 		<td>5.3.2 - 5.6.x</td>
 		<td>1.19 - 1.25</td>
 		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>2.2.x</th>
 		<td>5.3.2 - 5.6.x</td>
 		<td>1.19 - 1.25</td>
 		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>2.1.x</th>
 		<td>5.3.2 - 5.6.x</td>
 		<td>1.19 - 1.24</td>
 		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>2.0.x</th>
 		<td>5.3.2 - 5.5.x</td>
 		<td>1.19 - 1.23</td>
 		<td>2.0.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>1.9.x</th>
 		<td><strong>5.3.2</strong> - 5.5.x</td>
 		<td><strong>1.19</strong> - 1.23</td>
 		<td>1.9.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>1.8.x</th>
 		<td>5.2.0 - 5.5.x</td>
 		<td><strong>1.17</strong> - 1.22</td>
 		<td>1.8.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 	<tr>
 		<th>1.7.x</th>
 		<td>5.2.0 - 5.4.x</td>
 		<td>1.16 - 1.19</td>
 		<td>1.7.x</td>
+		<td>Obsolete release, no support</td>
 	</tr>
 </table>
 

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -14,32 +14,25 @@ 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:
+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-result-formats": "~3.0"
+		"mediawiki/semantic-result-formats": "~3.1"
 	}
 }
 ```
 
 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-result-formats": "~3.0"
+    "mediawiki/semantic-result-formats": "~3.1"
 
 Remember to add a comma to the end of the preceding line in this section.
 
-### Step 3
+### Step 2
 
 Run the following command in your shell:
 
@@ -48,17 +41,12 @@ Run the following command in your shell:
 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
+### Step 3
 
 Add the following line to the end of your "LocalSettings.php" file:
 
     wfLoadExtension( 'SemanticResultFormats' );
 
-### Verify installation success
-
-As final step, you can verify SRF got installed by looking at the "Special:Version" page on your wiki and
-check that it is listed in the semantic extensions section.
-
 ## Configuration
 
 A default set of formats is enabled. These are the formats that satisfy the following criteria:

diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,8 @@
 ## General documentation
 
-* [Release series](VERSIONS.md)
-* [Compatibility](COMPATIBILITY.md)
 * [Installation and configuration](INSTALL.md)
+* [Release notes (changes in each version)](../RELEASE-NOTES.md)
+* [Platform compatibility per version](COMPATIBILITY.md)
 * [Homepage](https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Result_Formats)
 
 ## Technical documentation

diff --git a/docs/VERSIONS.md b/docs/VERSIONS.md
diff --git a/extension.json b/extension.json
@@ -1,6 +1,6 @@
 {
     "name": "SemanticResultFormats",
-	"version": "3.1.0-alpha",
+	"version": "3.1.0",
 	"author": [
 		"James Hong Kong",
 		"Stephan Gambke",
@@ -14,7 +14,10 @@
 	"license-name": "GPL-2.0-or-later",
 	"type": "semantic",
 	"requires": {
-		"MediaWiki": ">= 1.27"
+		"MediaWiki": ">= 1.31",
+		"extensions": {
+			"SemanticMediaWiki": ">= 3.0"
+		}
 	},
 	"MessagesDirs": {
 		"SemanticResultFormats": [
@@ -26,5 +29,5 @@
 		"SemanticResultFormats::onExtensionFunction"
 	],
 	"load_composer_autoloader":true,
-	"manifest_version": 1
+	"manifest_version": 2
 }