Skip to content

Commit

Permalink
Release version 3.0.0 (#440)
Browse files Browse the repository at this point in the history
* Update RELEASE-NOTES.md
* Update INSTALL.md
* Update README.md
* Update composer.json
* Update extension.json
  • Loading branch information
kghbln authored Oct 12, 2018
1 parent 158651e commit 36ced8d
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 58 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,9 @@ installation independently. For more information, visit the [SRF homepage][srf]

## Installation

The recommended way to install this extension is by using [Composer][composer].
Just add the following to the MediaWiki `composer.local.json` file and run the
`php composer.phar install/update "mediawiki/semantic-result-formats"` command.

```json
{
"require": {
"mediawiki/semantic-result-formats": "~3.0"
}
}
```
Information about compatibility, details about the installation, and its configuration can be found [here](docs/INSTALL.md).
The recommended way to install this extension is by using [Composer][composer]. See the detailed
[installation guide](docs/INSTALL.md) which also contains information about compatibility and
configuration.

## Contribution and support

Expand All @@ -47,7 +38,6 @@ A list of people who have made contributions in the past can be found [here][con
* [File an issue](https://github.com/SemanticMediaWiki/SemanticResultFormats/issues)
* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticResultFormats/pulls)
* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
* Ask a question on the #semantic-mediawiki IRC channel on Freenode.

## Tests

Expand Down
23 changes: 16 additions & 7 deletions RELEASE-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,25 @@ These are the release notes for the [Semantic Result Formats](https://www.semant

## SRF 3.0.0

This is not a release yet.

* Raised minimum required version of PHP to 5.6
* Raised minimum required version of MediaWiki to 1.27
Released on October 12, 2018.

* Minimum requirement for
* PHP changed to version 5.6 and later
* MediaWiki changed to version 1.27 and later
* Semantic MediaWiki changed to version 3.0 and later
* #438 Added support for extension registration via "extension.json" (by James Hong Kong)
→ Now you have to use `wfLoadExtension( 'SemanticResultFormats' );` in the "LocalSettings.php" file to invoke the extension
* Improved filtered format: More options, better test coverage, re-enabled by default (by Stephan Gambke)
* Refactored vcard format: Mostly code improvements (by James Hong Kong)
* [#248](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/248) Fixed localization of numbers in the math result formats (by James Hong Kong)
* [#365](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Added support for the latest versions of the GraphViz extension
* [#375](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/375) Fixed exposing of file dimensions in captions for the "gallery" format
* Tree format: Removed `template arguments` parameter
* [#311](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Improved display of user preference options on special page "Preferences" (by James Hong Kong)
* [#365](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Added support for the latest versions of the GraphViz extension (by Sam Wilson)
* [#375](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/375) Fixed exposing of file dimensions in captions for the "gallery" format (by James Hong Kong)
* [#384](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/384) Updated "fullcalendar" library as well as added the "list views" feature for the "eventcalendar" format (by Nischay Nahata and James Hong Kong)
* [#435](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/435) Fixed time zone transitions (by James Hong Kong)
* [#436](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/436) Removed the `template arguments` parameter of the "gallery" format (by Stephan Gambke)
* Added support for installation together with the latest versions of the Maps extension (by Jeroen De Dauw)
* Provided general code improvements as well as additional integrations tests for several result formats
* Updated translations (by translatewiki.net community)

## SRF 2.5.6
Expand Down
3 changes: 1 addition & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,14 @@
"support": {
"email": "[email protected]",
"issues": "https://github.com/SemanticMediaWiki/SemanticResultFormats/issues",
"irc": "irc://irc.freenode.net/semantic-mediawiki",
"forum": "https://www.semantic-mediawiki.org/wiki/semantic-mediawiki.org_talk:Community_portal",
"wiki": "https://www.semantic-mediawiki.org/wiki/",
"source": "https://github.com/SemanticMediaWiki/SemanticResultFormats"
},
"require": {
"php": ">=5.6.0",
"composer/installers": "1.*,>=1.0.1",
"mediawiki/semantic-media-wiki": "~3.0@dev",
"mediawiki/semantic-media-wiki": "~3.0",
"nicmart/tree": "^0.2.7",
"data-values/geo": "~4.0|~3.0|~2.0",
"symfony/css-selector": "^3.3"
Expand Down
87 changes: 52 additions & 35 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ These are the installation and configuration instructions for [Semantic Result F
</tr>
<tr>
<th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 3.0.x</a></th>
<td>Development version</td>
<td>-</td>
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/master">master</a></td>
<td>Stable version</td>
<td>2018-10-11</td>
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/3.0.x">3.0.x</a></td>
</tr>
<tr>
<th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 2.5.6</a></th>
<td>Stable version</td>
<td>Obsolete version</td>
<td>2018-09-07</td>
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.5.x">2.5.x</a></td>
</tr>
Expand Down Expand Up @@ -96,7 +96,7 @@ minimum requirements are indicated in bold.
<th>SRF 2.5.x</th>
<td><strong>5.5.x</strong> - 7.0.x</td>
<td><strong>1.23</strong> - 1.29</td>
<td>2.1.x - latest</td>
<td>2.1.x - 2.5.x</td>
<tr>
<th>SRF 2.4.x</th>
<td>5.3.2 - 7.0.x</td>
Expand Down Expand Up @@ -148,51 +148,67 @@ minimum requirements are indicated in bold.
</table>

**Note:**
* It is strongly recommended to also always upgrade the underlying MediaWiki software to supported versions. See the [version lifecycle](https://www.mediawiki.org/wiki/Version_lifecycle) for current information on supported versions.
* It is strongly recommended to also always upgrade the underlying Semantic MediaWiki software to supported versions. See the page on [compatibility](https://www.semantic-mediawiki.org/wiki/Help:Compatibility) for current information on supported versions.

## Download and installation
* It is strongly recommended to also always upgrade the underlying MediaWiki software to supported versions.
See the [version lifecycle](https://www.mediawiki.org/wiki/Version_lifecycle) for current information on
supported versions.
* It is strongly recommended to also always upgrade the underlying Semantic MediaWiki software to supported
versions. See the page on [compatibility](https://www.semantic-mediawiki.org/wiki/Help:Compatibility) for
current information on supported versions.

### Composer Installation
## Installation

The recommended way to install Semantic Result Formats is with
[Composer](https://getcomposer.org) using [MediaWiki's built-in support for
Composer](https://www.mediawiki.org/wiki/Composer).
The recommended way to install Semantic Result Formats is using [Composer](http://getcomposer.org) with
[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer).

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

Change to the root directory of your MediaWiki installation. This is where the
"LocalSettings.php" file is located.
### Step 1

#### Step 2
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:

If you already have Composer installed continue to step 3. If not install
Composer now:
``` bash
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-result-formats": "~3.0"
}
}
```

#### Step 3
If you already have a "composer.local.json" file add the following line to the end of the "require"
section in your file:

Add the following line to the end of the "require" section in your "composer.local.json" file:
``` json
"mediawiki/semantic-result-formats": "~3.0"
```

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

#### Step 4
### Step 3

When this is done run in your shell:
``` bash
php composer.phar update --no-dev --prefer-source "mediawiki/semantic-result-formats"
```
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
### Step 4

As final step, you can verify SRF got installed by looking at the "Special:Version" page on your
wiki and verifying the Semantic Result Formats section is listed.
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

Expand All @@ -203,7 +219,8 @@ A default set of formats is enabled. These are the formats that satisfy the foll
any static external resources (such as an externally hosted image file),
* they are considered reasonably stable and secure.

Currently, these default formats thus are:
Currently, these default formats are:

'icalendar', 'vcard', 'bibtex', 'calendar', 'eventcalendar', 'eventline', 'timeline', 'outline',
'gallery', 'jqplotchart', 'jqplotseries', 'sum', 'average', 'min', 'max', 'median', 'product',
'tagcloud', 'valuerank', 'array', 'tree', 'ultree', 'oltree', 'd3chart', 'latest', 'earliest',
Expand Down
2 changes: 1 addition & 1 deletion extension.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "SemanticResultFormats",
"version": "3.0.0-alpha",
"version": "3.0.0",
"author": [
"James Hong Kong",
"Stephan Gambke",
Expand Down

0 comments on commit 36ced8d

Please sign in to comment.