first commit

8 files changed, 355 insertions, 0 deletions

diff --git a/www/wiki/extensions/SemanticResultFormats/docs/COMPATIBILITY.md b/www/wiki/extensions/SemanticResultFormats/docs/COMPATIBILITY.md
new file mode 100644
index 00000000..e340b7b2
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/COMPATIBILITY.md
@@ -0,0 +1,111 @@
+This document holds the **compatibility information** for the Semantic Result Formats (SRF) extension.
+
+- 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).
+
+### 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>SRF</th>
+		<th>PHP</th>
+		<th>MediaWiki</th>
+		<th>Semantic MediaWiki</th>
+		<th>Release status</th>
+	</tr>
+	<tr>
+		<th>3.2.x</th>
+		<td><strong>7.1.0</strong> - 7.4.x</td>
+		<td>1.31 - 1.33+</td>
+		<td>3.0.x - 3.1.x+</td>
+		<td>Future release</td>
+	<tr>
+	<tr>
+		<th>3.1.x</th>
+		<td><strong>7.0.0</strong> - 7.3.x</td>
+		<td><strong>1.31</strong> - 1.33</td>
+		<td>3.0.x - 3.1.x</td>
+		<td><strong>Stable release</strong></td>
+	<tr>
+	<tr>
+		<th>3.0.x</th>
+		<td><strong>5.6.0</strong> - 7.1.x</td>
+		<td><strong>1.27</strong> - 1.33</td>
+		<td><strong>3.0.x</strong></td>
+		<td>Obsolete release, no support</td>
+	<tr>
+	<tr>
+		<th>2.5.x</th>
+		<td><strong>5.5.0</strong> - 7.0.x</td>
+		<td><strong>1.23</strong> - 1.29</td>
+		<td>2.1.x - 2.5.x</td>
+		<td>Obsolete release, no support</td>
+	<tr>
+		<th>2.4.x</th>
+		<td>5.3.2 - 7.0.x</td>
+		<td>1.19 - 1.28</td>
+		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>2.3.x</th>
+		<td>5.3.2 - 5.6.x</td>
+		<td>1.19 - 1.25</td>
+		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>2.2.x</th>
+		<td>5.3.2 - 5.6.x</td>
+		<td>1.19 - 1.25</td>
+		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>2.1.x</th>
+		<td>5.3.2 - 5.6.x</td>
+		<td>1.19 - 1.24</td>
+		<td>2.1.x</td>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>2.0.x</th>
+		<td>5.3.2 - 5.5.x</td>
+		<td>1.19 - 1.23</td>
+		<td>2.0.x</td>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>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>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>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>
+		<td>Obsolete release, no support</td>
+	</tr>
+	<tr>
+		<th>1.7.x</th>
+		<td>5.2.0 - 5.4.x</td>
+		<td>1.16 - 1.19</td>
+		<td>1.7.x</td>
+		<td>Obsolete release, no support</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.
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/CONTRIBUTING.md b/www/wiki/extensions/SemanticResultFormats/docs/CONTRIBUTING.md
new file mode 100644
index 00000000..fa62eb09
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+If you would like to make a contribution to [Semantic Result Formats][srf] (a.k.a. SRF), please ensure that pull requests are based on the current master.
+
+In order to swiftly coordinate a contribution, the following should be provided:
+- Code should be easily read and if necessary be put into separate components (or classes)
+- Newly added features should not alter an existing test but instead provide additional test coverage to verify the expected behaviour
+
+For a description on how to write and run PHPUnit test, please consult the [manual][mw-testing].
+
+### Reporting an issue
+
+If you report an issue, please ensure to use the current master (this helps to verify that the problem still persists and isn't solved already) and describe your environment (SMW, MW version etc.) together with a [stack trace][stack-trace] and a clear description on how to reproduce it.
+
+[srf]: https://github.com/SemanticMediaWiki/SemanticExtraSpecialProperties
+[mw-testing]: https://www.mediawiki.org/wiki/Manual:PHP_unit_testing
+[stack-trace]: https://semantic-mediawiki.org/wiki/Stack_trace
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md b/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md
new file mode 100644
index 00000000..39087a47
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/INSTALL.md
@@ -0,0 +1,88 @@
+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).
+
+# 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).
+
+Note that the required extension Semantic MediaWiki must be installed first according to the installation
+instructions provided.
+
+### Step 1
+
+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.1"
+	}
+}
+```
+
+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.1"
+
+Remember to add a comma to the end of the preceding line in this section.
+
+### Step 2
+
+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 3
+
+Add the following line to the end of your "LocalSettings.php" file:
+
+    wfLoadExtension( 'SemanticResultFormats' );
+    
+## Configuration
+
+A default set of formats is enabled. These are the formats that satisfy the following criteria:
+
+* they do not require further software to be installed (besides Semantic MediaWiki),
+* they do not transmit any data to external websites, not even by making client browsers request
+  any static external resources (such as an externally hosted image file),
+* they are considered reasonably stable and secure.
+
+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',
+'filtered', 'slideshow', 'timeseries', 'sparkline', 'listwidget', 'pagewidget', 'dygraphs', 'media',
+'datatables'
+
+To add more formats to this list, you can add lines like:
+
+    $srfgFormats[] = 'googlebar';
+
+... or you can override the set of formats entirely, with a call like:
+
+    $srfgFormats = [ 'calendar', 'timeline' ];
+
+There are some formats that you may not want to include because they may not follow certain policies
+within your wiki; the formats 'googlebar' and 'googlepie', for instance, send data to external web
+services for rendering, which may be considered a data leak.
+
+Notes on specific formats:
+* array: requires the MediaWiki Arrays extension to work.
+* excel: requires the phpexcel library from phpoffice to work.
+* googlebar: sends data to Google for rendering. It also requires
+  access to the Google servers in order to render.
+* googlepie: sends data to Google for rendering. It also requires
+  access to the Google servers in order to render.
+* graph: requires the MediaWiki GraphViz extension to work.
+* hash: requires the MediaWiki HashTables extensions to work.
+* process: requires the MediaWiki GraphViz extension to work.
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/ISSUE_TEMPLATE.md b/www/wiki/extensions/SemanticResultFormats/docs/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..880c078b
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/ISSUE_TEMPLATE.md
@@ -0,0 +1,30 @@
+### Setup
+
+- MW version:
+- DB (MySQL etc.):
+- PHP version:
+- SMW version:
+- SRF version:
+- Browsers and versions (if applicable):
+
+### Issue
+
+...context and general description...
+
+**Steps to reproduce**
+
+(recommendation is to use the [sandbox](https://sandbox.semantic-mediawiki.org))
+
+1. ... 
+2. ...
+3. ...
+
+**Expected result:** ...
+
+**Observed result:** ...
+
+**Stacktrace** 
+
+```
+...
+```
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/PULL_REQUEST_TEMPLATE.md b/www/wiki/extensions/SemanticResultFormats/docs/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..1384a39d
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+This PR is made in reference to: #
+
+This PR addresses or contains:
+- ...
+- ...
+- ...
+
+This PR includes:
+- [ ] Update of RELEASE-NOTES.md
+- [ ] Tests (unit/integration)
+- [ ] CI build passed
+
+Fixes #
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/README.md b/www/wiki/extensions/SemanticResultFormats/docs/README.md
new file mode 100644
index 00000000..898bcf8e
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/README.md
@@ -0,0 +1,16 @@
+## General documentation
+
+* [Installation and configuration](INSTALL.md)
+* [Release notes (changes in each version)](../RELEASE-NOTES.md)
+* [Platform compatibility per version](COMPATIBILITY.md)
+* [Homepage](https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Result_Formats)
+
+## Technical documentation
+
+* [Filtered format](https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/formats/filtered/README.md)
+
+## Repository documentation
+
+* [Contributing](CONTRIBUTING.md)
+* [Issue template](ISSUE_TEMPLATE.md)
+* [Pull request template](PULL_REQUEST_TEMPLATE.md)
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/jsduck.categories.json b/www/wiki/extensions/SemanticResultFormats/docs/jsduck.categories.json
new file mode 100644
index 00000000..c6522be8
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/jsduck.categories.json
@@ -0,0 +1,66 @@
+[
+	{
+		"name": "General",
+		"groups": [
+			{
+				"name": "Instance",
+				"classes": ["srf"]
+			}
+		]
+	},
+	{
+		"name": "Formats",
+		"groups": [
+			{
+				"name": "Meta",
+				"classes": ["srf.format"]
+			},
+			{
+				"name": "Formats",
+				"classes": ["srf.formats.*"]
+			}
+		]
+	},
+	{
+		"name": "Widgets",
+		"groups": [
+			{
+				"name": "Meta",
+				"classes": ["srf.widget*"]
+			}
+		]
+	},
+	{
+		"name": "Utilities",
+		"groups": [
+			{
+				"name": "Support",
+				"classes": ["srf.util*"]
+			}
+		]
+	},
+	{
+		"name": "Test",
+		"groups": [
+			{
+				"name": "QUnit",
+				"classes": ["QUnit", "QUnit.assert"]
+			}
+		]
+	},
+	{
+		"name": "Upstream",
+		"groups": [
+			{
+				"name": "jQuery",
+				"classes": ["jQuery", "jQuery.Event", "jQuery.Promise", "jQuery.Deferred", "jQuery.jqXHR", "QUnit"]
+			},
+			{
+				"name": "JavaScript",
+				"classes": [
+					"Array", "Boolean", "Date", "Function", "Number", "Object", "RegExp", "String"
+				]
+			}
+		]
+	}
+]
\ No newline at end of file
diff --git a/www/wiki/extensions/SemanticResultFormats/docs/jsduck.json b/www/wiki/extensions/SemanticResultFormats/docs/jsduck.json
new file mode 100644
index 00000000..e257880c
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/docs/jsduck.json
@@ -0,0 +1,16 @@
+{
+	"--title": "Semantic Result Formats Code Documentation",
+	"--categories": "../docs/jsduck.categories.json",
+	"--warnings": ["-no_doc"],
+	"--builtin-classes": true,
+	"--external": "HTMLDocument,Window",
+	"--":[
+		"../resources/docs",
+		"../resources/srf",
+		"../formats/tagcloud",
+		"../formats/gallery",
+		"../formats/datatables",
+		"../formats/media",
+		"../formats/calendar"	
+	]
+}
\ No newline at end of file