Skip to content

Commit 36ced8d

Browse files
authored
Release version 3.0.0 (#440)
* Update RELEASE-NOTES.md * Update INSTALL.md * Update README.md * Update composer.json * Update extension.json
1 parent 158651e commit 36ced8d

File tree

5 files changed

+73
-58
lines changed

5 files changed

+73
-58
lines changed

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,9 @@ installation independently. For more information, visit the [SRF homepage][srf]
2020

2121
## Installation
2222

23-
The recommended way to install this extension is by using [Composer][composer].
24-
Just add the following to the MediaWiki `composer.local.json` file and run the
25-
`php composer.phar install/update "mediawiki/semantic-result-formats"` command.
26-
27-
```json
28-
{
29-
"require": {
30-
"mediawiki/semantic-result-formats": "~3.0"
31-
}
32-
}
33-
```
34-
Information about compatibility, details about the installation, and its configuration can be found [here](docs/INSTALL.md).
23+
The recommended way to install this extension is by using [Composer][composer]. See the detailed
24+
[installation guide](docs/INSTALL.md) which also contains information about compatibility and
25+
configuration.
3526

3627
## Contribution and support
3728

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

5242
## Tests
5343

RELEASE-NOTES.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,25 @@ These are the release notes for the [Semantic Result Formats](https://www.semant
22

33
## SRF 3.0.0
44

5-
This is not a release yet.
6-
7-
* Raised minimum required version of PHP to 5.6
8-
* Raised minimum required version of MediaWiki to 1.27
5+
Released on October 12, 2018.
6+
7+
* Minimum requirement for
8+
* PHP changed to version 5.6 and later
9+
* MediaWiki changed to version 1.27 and later
10+
* Semantic MediaWiki changed to version 3.0 and later
11+
* #438 Added support for extension registration via "extension.json" (by James Hong Kong)
12+
→ Now you have to use `wfLoadExtension( 'SemanticResultFormats' );` in the "LocalSettings.php" file to invoke the extension
913
* Improved filtered format: More options, better test coverage, re-enabled by default (by Stephan Gambke)
14+
* Refactored vcard format: Mostly code improvements (by James Hong Kong)
1015
* [#248](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/248) Fixed localization of numbers in the math result formats (by James Hong Kong)
11-
* [#365](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Added support for the latest versions of the GraphViz extension
12-
* [#375](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/375) Fixed exposing of file dimensions in captions for the "gallery" format
13-
* Tree format: Removed `template arguments` parameter
16+
* [#311](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Improved display of user preference options on special page "Preferences" (by James Hong Kong)
17+
* [#365](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/365) Added support for the latest versions of the GraphViz extension (by Sam Wilson)
18+
* [#375](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/375) Fixed exposing of file dimensions in captions for the "gallery" format (by James Hong Kong)
19+
* [#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)
20+
* [#435](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/435) Fixed time zone transitions (by James Hong Kong)
21+
* [#436](https://github.com/SemanticMediaWiki/SemanticResultFormats/pull/436) Removed the `template arguments` parameter of the "gallery" format (by Stephan Gambke)
1422
* Added support for installation together with the latest versions of the Maps extension (by Jeroen De Dauw)
23+
* Provided general code improvements as well as additional integrations tests for several result formats
1524
* Updated translations (by translatewiki.net community)
1625

1726
## SRF 2.5.6

composer.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,14 @@
3939
"support": {
4040
"email": "[email protected]",
4141
"issues": "https://github.com/SemanticMediaWiki/SemanticResultFormats/issues",
42-
"irc": "irc://irc.freenode.net/semantic-mediawiki",
4342
"forum": "https://www.semantic-mediawiki.org/wiki/semantic-mediawiki.org_talk:Community_portal",
4443
"wiki": "https://www.semantic-mediawiki.org/wiki/",
4544
"source": "https://github.com/SemanticMediaWiki/SemanticResultFormats"
4645
},
4746
"require": {
4847
"php": ">=5.6.0",
4948
"composer/installers": "1.*,>=1.0.1",
50-
"mediawiki/semantic-media-wiki": "~3.0@dev",
49+
"mediawiki/semantic-media-wiki": "~3.0",
5150
"nicmart/tree": "^0.2.7",
5251
"data-values/geo": "~4.0|~3.0|~2.0",
5352
"symfony/css-selector": "^3.3"

docs/INSTALL.md

Lines changed: 52 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ These are the installation and configuration instructions for [Semantic Result F
1313
</tr>
1414
<tr>
1515
<th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 3.0.x</a></th>
16-
<td>Development version</td>
17-
<td>-</td>
18-
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/master">master</a></td>
16+
<td>Stable version</td>
17+
<td>2018-10-11</td>
18+
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/3.0.x">3.0.x</a></td>
1919
</tr>
2020
<tr>
2121
<th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 2.5.6</a></th>
22-
<td>Stable version</td>
22+
<td>Obsolete version</td>
2323
<td>2018-09-07</td>
2424
<td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.5.x">2.5.x</a></td>
2525
</tr>
@@ -96,7 +96,7 @@ minimum requirements are indicated in bold.
9696
<th>SRF 2.5.x</th>
9797
<td><strong>5.5.x</strong> - 7.0.x</td>
9898
<td><strong>1.23</strong> - 1.29</td>
99-
<td>2.1.x - latest</td>
99+
<td>2.1.x - 2.5.x</td>
100100
<tr>
101101
<th>SRF 2.4.x</th>
102102
<td>5.3.2 - 7.0.x</td>
@@ -148,51 +148,67 @@ minimum requirements are indicated in bold.
148148
</table>
149149

150150
**Note:**
151-
* 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.
152-
* 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.
153-
154-
## Download and installation
151+
* It is strongly recommended to also always upgrade the underlying MediaWiki software to supported versions.
152+
See the [version lifecycle](https://www.mediawiki.org/wiki/Version_lifecycle) for current information on
153+
supported versions.
154+
* It is strongly recommended to also always upgrade the underlying Semantic MediaWiki software to supported
155+
versions. See the page on [compatibility](https://www.semantic-mediawiki.org/wiki/Help:Compatibility) for
156+
current information on supported versions.
155157

156-
### Composer Installation
158+
## Installation
157159

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

162-
#### Step 1
163+
Note that the required extension Semantic MediaWiki must be installed first according to the installation
164+
instructions provided.
163165

164-
Change to the root directory of your MediaWiki installation. This is where the
165-
"LocalSettings.php" file is located.
166+
### Step 1
166167

167-
#### Step 2
168+
Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php"
169+
file is located. If you have not yet installed Composer do it now by running the following command
170+
in your shell:
168171

169-
If you already have Composer installed continue to step 3. If not install
170-
Composer now:
171-
``` bash
172172
wget https://getcomposer.org/composer.phar
173+
174+
### Step 2
175+
176+
If you do not have a "composer.local.json" file yet, create one and add the following content to it:
177+
178+
```
179+
{
180+
"require": {
181+
"mediawiki/semantic-result-formats": "~3.0"
182+
}
183+
}
173184
```
174185

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

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

182-
* Remark: Remember to add a comma to the end of the preceding line in this
183-
section.
191+
Remember to add a comma to the end of the preceding line in this section.
184192

185-
#### Step 4
193+
### Step 3
186194

187-
When this is done run in your shell:
188-
``` bash
189-
php composer.phar update --no-dev --prefer-source "mediawiki/semantic-result-formats"
190-
```
195+
Run the following command in your shell:
196+
197+
php composer.phar update --no-dev
198+
199+
Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also
200+
note that it may be necessary to run this command twice. If unsure do it twice right away.
191201

192-
#### Verify installation success
202+
### Step 4
193203

194-
As final step, you can verify SRF got installed by looking at the "Special:Version" page on your
195-
wiki and verifying the Semantic Result Formats section is listed.
204+
Add the following line to the end of your "LocalSettings.php" file:
205+
206+
wfLoadExtension( 'SemanticResultFormats' );
207+
208+
### Verify installation success
209+
210+
As final step, you can verify SRF got installed by looking at the "Special:Version" page on your wiki and
211+
check that it is listed in the semantic extensions section.
196212

197213
## Configuration
198214

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

206-
Currently, these default formats thus are:
222+
Currently, these default formats are:
223+
207224
'icalendar', 'vcard', 'bibtex', 'calendar', 'eventcalendar', 'eventline', 'timeline', 'outline',
208225
'gallery', 'jqplotchart', 'jqplotseries', 'sum', 'average', 'min', 'max', 'median', 'product',
209226
'tagcloud', 'valuerank', 'array', 'tree', 'ultree', 'oltree', 'd3chart', 'latest', 'earliest',

extension.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "SemanticResultFormats",
3-
"version": "3.0.0-alpha",
3+
"version": "3.0.0",
44
"author": [
55
"James Hong Kong",
66
"Stephan Gambke",

0 commit comments

Comments
 (0)