Skip to content

Commit a8a2653

Browse files
authored
Make 3.0.0 release (#75)
* Update RELEASE-NOTES.md * Update README.md
1 parent d326608 commit a8a2653

File tree

2 files changed

+54
-16
lines changed

2 files changed

+54
-16
lines changed

README.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,57 @@ Semantic Forms Select (a.k.a. SFS) can generate a select form element with value
1717

1818
## Installation
1919

20-
The recommended way to install Semantic Forms Select is by using [Composer][composer] with an entry in MediaWiki's `composer.json` or alternatively `composer.local.json`.
20+
The recommended way to install Semantic Forms Select is using [Composer](http://getcomposer.org) with
21+
[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer).
2122

22-
```json
23+
Note that the required extensions Semantic MediaWiki and Page Forms must be installed first according to the installation
24+
instructions provided for them.
25+
26+
### Step 1
27+
28+
Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php"
29+
file is located. If you have not yet installed Composer do it now by running the following command
30+
in your shell:
31+
32+
wget https://getcomposer.org/composer.phar
33+
34+
### Step 2
35+
36+
If you do not have a "composer.local.json" file yet, create one and add the following content to it:
37+
38+
```
2339
{
2440
"require": {
2541
"mediawiki/semantic-forms-select": "~3.0"
2642
}
2743
}
2844
```
29-
1. From your MediaWiki installation directory, execute
30-
`composer require mediawiki/semantic-forms-select:~3.0`
31-
2. Add the following line to your "LocalSettings.php" file _after the inclusion of Semantic MediaWiki and Page Forms_:
32-
`wfLoadExtension( 'SemanticFormsSelect' );`
33-
3. Navigate to _Special:Version_ on your wiki and verify that the extension
34-
has been successfully installed.
35-
36-
Note that the required extensions Semantic MediaWiki and Page Forms must be installed first according to the installation
37-
instructions provided with them.
45+
46+
If you already have a "composer.local.json" file add the following line to the end of the "require"
47+
section in your file:
48+
49+
"mediawiki/semantic-forms-select": "~3.0"
50+
51+
Remember to add a comma to the end of the preceding line in this section.
52+
53+
### Step 3
54+
55+
Run the following command in your shell:
56+
57+
php composer.phar update --no-dev
58+
59+
Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also
60+
note that it may be necessary to run this command twice. If unsure do it twice right away.
61+
62+
### Step 4
63+
64+
Add the following line to the end of your "LocalSettings.php" file:
65+
66+
wfLoadExtension( 'SemanticFormsSelect' );
67+
68+
### Verify installation success
69+
70+
As final step, you can verify SFS got installed by looking at the "Special:Version" page on your wiki and check that it is listed in the semantic extensions section.
3871

3972
## Usage
4073

RELEASE-NOTES.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@ This file contains the RELEASE-NOTES of the Semantic Forms Select (a.k.a. SFS) e
22

33
### 3.0.0
44

5-
* #53 Support "mapping property" / "mapping template" in value field (by Alexander Gesinn), requires changes in Page Forms (former Semantic Forms extension)
6-
* #62 Make SFS compliant with recent Page Forms versions (by Alexander Gesinn)
7-
* refactored SemanticFormsSelectInput class -> moved logic to new SelectField class (by Alexander Gesinn)
8-
* added Unit Tests (by Felix Ashu)
9-
* Dropped support for PHP 5.5
5+
Released on October 5, 2018.
6+
107
* Dropped support for Semantic MediaWiki 2.4 and lower
8+
* Dropped support for PHP 5.5 and lower
9+
* #53 Added support for "mapping property" / "mapping template" in value fields (by Alexander Gesinn)
10+
* #62 Added support for recent versions of the Page Forms extension (by Alexander Gesinn)
11+
* Added styles to make single values fields appear like the combobox input type of Page Forms (by Alexander Gesinn)
12+
* Added handling for the checkbox input type of Page Forms (by Alexander Gesinn)
13+
* Refactored SemanticFormsSelectInput class -> moved logic to new SelectField class (by Alexander Gesinn)
14+
* Added Unit Tests (by Felix Ashu)
15+
* Provided translation updates (by TranslateWiki.net community)
1116

1217
### 2.1.1
1318

0 commit comments

Comments
 (0)