Skip to content

Commit

Permalink
Make 3.0.0 release (#75)
Browse files Browse the repository at this point in the history
* Update RELEASE-NOTES.md
* Update README.md
  • Loading branch information
kghbln authored Oct 5, 2018
1 parent d326608 commit a8a2653
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 16 deletions.
55 changes: 44 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,57 @@ Semantic Forms Select (a.k.a. SFS) can generate a select form element with value

## Installation

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`.
The recommended way to install Semantic Forms Select 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 extensions Semantic MediaWiki and Page Forms must be installed first according to the installation
instructions provided for them.

### 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-forms-select": "~3.0"
}
}
```
1. From your MediaWiki installation directory, execute
`composer require mediawiki/semantic-forms-select:~3.0`
2. Add the following line to your "LocalSettings.php" file _after the inclusion of Semantic MediaWiki and Page Forms_:
`wfLoadExtension( 'SemanticFormsSelect' );`
3. Navigate to _Special:Version_ on your wiki and verify that the extension
has been successfully installed.

Note that the required extensions Semantic MediaWiki and Page Forms must be installed first according to the installation
instructions provided with them.

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-forms-select": "~3.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( 'SemanticFormsSelect' );

### Verify installation success

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.

## Usage

Expand Down
15 changes: 10 additions & 5 deletions RELEASE-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@ This file contains the RELEASE-NOTES of the Semantic Forms Select (a.k.a. SFS) e

### 3.0.0

* #53 Support "mapping property" / "mapping template" in value field (by Alexander Gesinn), requires changes in Page Forms (former Semantic Forms extension)
* #62 Make SFS compliant with recent Page Forms versions (by Alexander Gesinn)
* refactored SemanticFormsSelectInput class -> moved logic to new SelectField class (by Alexander Gesinn)
* added Unit Tests (by Felix Ashu)
* Dropped support for PHP 5.5
Released on October 5, 2018.

* Dropped support for Semantic MediaWiki 2.4 and lower
* Dropped support for PHP 5.5 and lower
* #53 Added support for "mapping property" / "mapping template" in value fields (by Alexander Gesinn)
* #62 Added support for recent versions of the Page Forms extension (by Alexander Gesinn)
* Added styles to make single values fields appear like the combobox input type of Page Forms (by Alexander Gesinn)
* Added handling for the checkbox input type of Page Forms (by Alexander Gesinn)
* Refactored SemanticFormsSelectInput class -> moved logic to new SelectField class (by Alexander Gesinn)
* Added Unit Tests (by Felix Ashu)
* Provided translation updates (by TranslateWiki.net community)

### 2.1.1

Expand Down

0 comments on commit a8a2653

Please sign in to comment.