diff options
Diffstat (limited to 'www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md')
| -rw-r--r-- | www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md | 187 |
1 files changed, 12 insertions, 175 deletions
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md b/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md index 42fba85c..39087a47 100644 --- a/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md +++ b/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md @@ -1,161 +1,10 @@ -# Installation +This document holds the **installation and configuration instructions** for the [Semantic Result Formats](README.md) (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). -These are the installation and configuration instructions for [Semantic Result Formats](README.md) (SRF). - -## Versions - -<table> - <tr> - <th></th> - <th>Status</th> - <th>Release date</th> - <th>Git branch</th> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 3.0.1</a></th> - <td>Stable version</td> - <td>2019-03-27</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>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> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/2.5.x/RELEASE-NOTES.md">SRF 2.4.3</a></th> - <td>Obsolete version</td> - <td>2017-05-06</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.4.x">2.4.x</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/2.4.x/RELEASE-NOTES.md">SRF 2.3.0</a></th> - <td>Obsolete version</td> - <td>2015-09-24</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.3">2.3</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 2.2.0</a></th> - <td>Obsolete version</td> - <td>2015-07-30</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.2">2.2</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 2.1.2</a></th> - <td>Obsolete version</td> - <td>2015-02-26</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.1.2">2.1.2</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 2.0.0</a></th> - <td>Obsolete version</td> - <td>2014-08-06</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/2.0">2.0</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 1.9.1</a></th> - <td>Obsolete version</td> - <td>2014-04-25</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/1.9.1">1.9.1</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 1.9.0</a></th> - <td>Obsolete version</td> - <td>2014-01-10</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/1.9">1.9</a></td> - </tr> - <tr> - <th><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/docs/RELEASE-NOTES.md">SRF 1.8.0</a></th> - <td>Obsolete version</td> - <td>2012-12-02</td> - <td><a href="https://github.com/SemanticMediaWiki/SemanticResultFormats/tree/1.8">1.8</a></td> - </tr> -</table> - -### Platform compatibility - -The PHP and MediaWiki version ranges listed are those in which SRF is known to work. It might also -work with more recent versions of PHP and MediaWiki, though this is not guaranteed. Increases of -minimum requirements are indicated in bold. - -<table> - <tr> - <th></th> - <th>PHP</th> - <th>MediaWiki</th> - <th>Semantic MediaWiki</th> - </tr> - <tr> - <th>SRF 3.0.x</th> - <td><strong>5.6.x</strong> - latest</td> - <td><strong>1.27</strong> - latest</td> - <td><strong>3.0.x</strong></td> - <tr> - <tr> - <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 - 2.5.x</td> - <tr> - <th>SRF 2.4.x</th> - <td>5.3.2 - 7.0.x</td> - <td>1.19 - 1.28</td> - <td>2.1.x</td> - </tr> - <tr> - <th>SRF 2.3.x</th> - <td>5.3.2 - 5.6.x</td> - <td>1.19 - 1.25</td> - <td>2.1.x</td> - </tr> - <tr> - <th>SRF 2.2.x</th> - <td>5.3.2 - 5.6.x</td> - <td>1.19 - 1.25</td> - <td>2.1.x</td> - </tr> - <tr> - <th>SRF 2.1.x</th> - <td>5.3.2 - 5.6.x</td> - <td>1.19 - 1.24</td> - <td>2.1.x</td> - </tr> - <tr> - <th>SRF 2.0.x</th> - <td>5.3.2 - 5.5.x</td> - <td>1.19 - 1.23</td> - <td>2.0.x</td> - </tr> - <tr> - <th>SRF 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> - </tr> - <tr> - <th>SRF 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> - </tr> - <tr> - <th>SRF 1.7.x</th> - <td>5.2.0 - 5.4.x</td> - <td>1.16 - 1.19</td> - <td>1.7.x</td> - </tr> -</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. - -## Installation +# Installation 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). @@ -165,20 +14,13 @@ 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" } } ``` @@ -186,11 +28,11 @@ If you do not have a "composer.local.json" file yet, create one and add the foll 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: @@ -199,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: |