1.1.0 release

* Removed inline JSON to avoid hitting page size limit * Added config docs to README
ProfessionalWiki · Aug 28, 2019 · 59c62b7 · 59c62b7
1 parent 952e89b
commit 59c62b7
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -104,12 +104,34 @@ Display and behaviour of the timeline can be changed via several output paramete
 }}
 ```
 
+### Parameters
+
 A full list of supported output parameters can be obtained in wiki via the `smwdoc` parser function:
 
 ```
 {{#smwdoc: moderntimeline }}
 ```
 
+### Configuration
+
+The default value of all parameters can be changed by placing configuration in `LocalSettings.php`.
+These configuration settings are available:
+
+* wgModernTimelineWidth
+* wgModernTimelineHeight
+* wgModernTimelineBookmark
+* wgModernTimelineBackground
+* wgModernTimelineScaleFactor
+* wgModernTimelinePosition
+* wgModernTimelineTickWidth
+* wgModernTimelineStartSlide
+* wgModernTimelineStartAtEnd
+* wgModernTimelineTransitionDuration
+* wgModernTimelineNavHeight
+* wgModernTimelineTemplate
+
+Default values of these configuration settings can be found in `extension.json`. Do not change `extension.json`.
+
 ## Limitations
 
 * The template parameter is not supported on "Special:Ask"

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -2,10 +2,16 @@ These are the RELEASE NOTES for the **Modern Timeline** extension. See the
 [README](/README.md) for further information on platform requirements, installation
 and usage.
 
+## Version 1.1.0
+
+Released on August 28th, 2019.
+
+* Improved handling of large data sets
+
 ## Version 1.0.0
 
 Released on August 16th, 2019.
 
 Initial release with a [TimelineJS3](https://github.com/NUKnightLab/TimelineJS3)
 based result format featuring 12 customization parameters, template support and
-date range support.
+date range support.
diff --git a/extension.json b/extension.json
@@ -1,21 +1,21 @@
 {
 	"name": "ModernTimeline",
-	
-	"version": "1.0.0",
+
+	"version": "1.1.0",
 
 	"author": [
 		"[https://professional.wiki/ <span style=\"color: #df2e2c \">Professional</span>.Wiki]",
 		"[https://www.entropywins.wtf/mediawiki Jeroen De Dauw]"
 	],
-	
+
 	"url": "https://github.com/ProfessionalWiki/ModernTimeline#modern-timeline",
-	
+
 	"namemsg": "modern-timeline-name",
-	
+
 	"descriptionmsg": "modern-timeline-desc",
-	
+
 	"license-name": "GPL-2.0-or-later",
-	
+
 	"type": "semantic",
 
 	"requires": {

diff --git a/src/TimelinePresenter.php b/src/TimelinePresenter.php
@@ -33,14 +33,12 @@ private function newTimelineId(): string {
 	public function getResult( SMWQueryResult $result ): string {
 		SMWOutputs::requireResource( 'ext.modern.timeline' );
 
-		$json = $this->createJsonString( $result );
-
 		SMWOutputs::requireHeadItem(
 			$this->id,
-			$this->createJs( $json )
+			$this->createJs( $this->createJsonString( $result ) )
 		);
 
-		return $this->createDiv( $json );
+		return $this->createDiv();
 	}
 
 	private function createJsonString( SMWQueryResult $result ) {
@@ -76,7 +74,7 @@ private function createJs( string $json ): string {
 		);
 	}
 
-	private function createDiv( string $json ): string {
+	private function createDiv(): string {
 		$width = $this->parameters[TimelineOptions::PARAM_WIDTH]->getValue();
 		$height = $this->parameters[TimelineOptions::PARAM_HEIGHT]->getValue();
 
@@ -94,12 +92,7 @@ private function createDiv( string $json ): string {
 					'style' => 'width: 100%; height: calc(100% - 10px); background-color: rgba(0, 0, 0, 0.05); margin-top: 5px; margin-bottom: 5px;'
 				]
 			)
-		)
-			. \Html::element( // TODO: remove when system tests can test head items
-				'div',
-				[ 'style' => 'display:none' ],
-				$json
-			);
+		);
 	}
 
 }
diff --git a/tests/System/JsonScript/escaping.json b/tests/System/JsonScript/escaping.json
@@ -30,7 +30,10 @@
 				"to-contain": [
 					"Evil page",
 					"2019",
-					"Description: &amp;lt;script&amp;gt;&amp;lt;\\/script&amp;gt"
+					"&lt;script&gt;"
+				],
+				"not-contain": [
+					"<script></script>"
 				]
 			}
 		}
@@ -48,4 +51,4 @@
 		"is-incomplete": false,
 		"debug": false
 	}
-}
+}
diff --git a/tests/System/JsonScriptTest.php b/tests/System/JsonScriptTest.php
@@ -8,6 +8,14 @@
 
 class JsonScriptTest extends JsonTestCaseScriptRunnerTest {
 
+	public function setUp() {
+		if ( version_compare( SMW_VERSION, '3.1c', '<' ) ) {
+			$this->markTestSkipped( 'SMW version too old' );
+		}
+
+		parent::setUp();
+	}
+
 	protected function getTestCaseLocation() {
 		return __DIR__ . '/JsonScript';
 	}