Merge branch 'develop' into vvzvlad_local

modules/README.md

@@ -2,6 +2,18 @@
 
 This document describes the way to develop your own MagicMirror² modules.
 
+## General Advice
+
+As MagicMirror has gained huge popularity, so has the number of available modules. For new users and developers alike, it is very time consuming to navigate around the various repositories in order to find out what exactly a certain modules does, how it looks and what it depends on. Unfortunately, this information is rarely available, nor easily obtained without having to install it first. 
+Therefore **we highly recommend you to include the following information in your README file.**
+
+- A high quality screenshot of your working module
+- A short, one sentence, clear description what it does (duh!)
+- What external API's it depend on, including web links to those
+- Wheteher the API/request require a key and the user limitations of those. (Is it free?)
+
+Surely this also help you get better recognition and feedback for your work. 
+
 ## Module structure
 
 All modules are loaded in the `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.
@@ -230,11 +242,12 @@ notificationReceived: function(notification, payload, sender) {
 }
 ````
 
-**Note:** the system sends two notifications when starting up. These notifications could come in handy!
+**Note:** the system sends three notifications when starting up. These notifications could come in handy!
 
 
 - `ALL_MODULES_STARTED` - All modules are started. You can now send notifications to other modules.
 - `DOM_OBJECTS_CREATED` - All dom objects are created. The system is now ready to perform visual changes.
+- `MODULE_DOM_CREATED` - This module's dom has been fully loaded. You can now access your module's dom objects.
 
 
 #### `socketNotificationReceived: function(notification, payload)`

modules/default/calendar/vendor/ical.js/test/test.js

@@ -108,7 +108,7 @@ vows.describe('node-ical').addBatch({
         assert.equal(topic.end.getFullYear(), 1998);
         assert.equal(topic.end.getUTCMonth(), 2);
         assert.equal(topic.end.getUTCDate(), 15);
-        assert.equal(topic.end.getUTCHours(), 00);
+        assert.equal(topic.end.getUTCHours(), 0);
         assert.equal(topic.end.getUTCMinutes(), 30);
       }
     }
@@ -146,7 +146,7 @@ vows.describe('node-ical').addBatch({
       }
       , 'has a start datetime' : function(topic) {
         assert.equal(topic.start.getFullYear(), 2011);
-        assert.equal(topic.start.getMonth(), 09);
+        assert.equal(topic.start.getMonth(), 9);
         assert.equal(topic.start.getDate(), 11);
       }
 
@@ -192,7 +192,7 @@ vows.describe('node-ical').addBatch({
       }
       , 'has a start' : function(topic){
         assert.equal(topic.start.tz, 'America/Phoenix')
-        assert.equal(topic.start.toISOString(), new Date(2011, 10, 09, 19, 0,0).toISOString())
+        assert.equal(topic.start.toISOString(), new Date(2011, 10, 9, 19, 0,0).toISOString())
       }
     }
   }
@@ -208,7 +208,7 @@ vows.describe('node-ical').addBatch({
         })[0];
       }
       , 'has a start' : function(topic){
-        assert.equal(topic.start.toISOString(), new Date(2011, 07, 04, 12, 0,0).toISOString())
+        assert.equal(topic.start.toISOString(), new Date(2011, 7, 4, 12, 0,0).toISOString())
       }
     }
   , 'event with rrule' :{
@@ -249,7 +249,7 @@ vows.describe('node-ical').addBatch({
         },
         'task completed': function(task){
             assert.equal(task.completion, 100);
-            assert.equal(task.completed.toISOString(), new Date(2013, 06, 16, 10, 57, 45).toISOString());
+            assert.equal(task.completed.toISOString(), new Date(2013, 6, 16, 10, 57, 45).toISOString());
         }
     }
   }
@@ -367,7 +367,7 @@ vows.describe('node-ical').addBatch({
         assert.equal(topic.end.getFullYear(), 2014);
         assert.equal(topic.end.getMonth(), 3);
         assert.equal(topic.end.getUTCHours(), 19);
-        assert.equal(topic.end.getUTCMinutes(), 00);
+        assert.equal(topic.end.getUTCMinutes(), 0);
       }
     }
   },

modules/default/compliments/compliments.js

@@ -53,14 +53,15 @@ Module.register("compliments", {
 
 		this.lastComplimentIndex = -1;
 
+		var self = this;
 		if (this.config.remoteFile != null) {
 			this.complimentFile((response) => {
 				this.config.compliments = JSON.parse(response);
+				self.updateDom();
 			});
 		}
 
 		// Schedule update timer.
-		var self = this;
 		setInterval(function() {
 			self.updateDom(self.config.fadeSpeed);
 		}, this.config.updateInterval);

modules/default/currentweather/README.md

@@ -43,7 +43,7 @@ The following properties can be configured:
 | `showWindDirectionAsArrow`   | Show the wind direction as an arrow instead of abbreviation <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
 | `showHumidity`               | Show the current humidity <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
 | `showIndoorTemperature`      | If you have another module that emits the INDOOR_TEMPERATURE notification, the indoor temperature will be displayed <br> **Default value:** `false`
-| `onlyTemp`                   | Show only current Temperature and weather icon. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
+| `onlyTemp`                   | Show only current Temperature and weather icon without windspeed, sunset and sunrise time. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
 | `useBeaufort`                | Pick between using the Beaufort scale for wind speed or using the default units. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
 | `lang`                       | The language of the days. <br><br> **Possible values:** `en`, `nl`, `ru`, etc ... <br> **Default value:** uses value of _config.language_
 | `decimalSymbol`              | The decimal symbol to use.<br><br> **Possible values:** `.`, `,` or any other symbol.<br> **Default value:** `.`

modules/default/newsfeed/README.md

@@ -39,7 +39,7 @@ MagicMirror's [notification mechanism](https://github.com/MichMich/MagicMirror/t
 | ----------------------- | -----------
 | `ARTICLE_NEXT`          | Shows the next news title (hiding the summary or previously fully displayed article)
 | `ARTICLE_PREVIOUS`      | Shows the previous news title (hiding the summary or previously fully displayed article)
-| `ARTICLE_MORE_DETAILS`  | When received the _first time_, shows the corresponding description of the currently displayed news title. <br> The module expects that the module's configuration option `showDescription` is set to `false` (default value). <br><br> When received a _second consecutive time_, shows the full news article in an IFRAME. <br> This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. `DENY`.
+| `ARTICLE_MORE_DETAILS`  | When received the _first time_, shows the corresponding description of the currently displayed news title. <br> The module expects that the module's configuration option `showDescription` is set to `false` (default value). <br><br> When received a _second consecutive time_, shows the full news article in an IFRAME. <br> This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. `DENY`.<br><br>When received the _next consecutive times_, reloads the page and scrolls down by `scrollLength` pixels to paginate through the article.
 | `ARTICLE_LESS_DETAILS`  | Hides the summary or full news article and only displays the news title of the currently viewed news item.
 
 Note the payload of the sent notification event is ignored.
@@ -72,13 +72,14 @@ The following properties can be configured:
 | `updateInterval`   | How often do you want to display a new headline? (Milliseconds) <br><br> **Possible values:**`1000` - `60000` <br> **Default value:** `10000` (10 seconds)
 | `animationSpeed`   | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `2500` (2.5 seconds)
 | `maxNewsItems`     | Total amount of news items to cycle through. (0 for unlimited) <br><br> **Possible values:**`0` - `...` <br> **Default value:** `0`
-| `ignoreOldItems`   | Ignore news items that are outdated. <br><br> **Possible values:**`true` or `false <br> **Default value:** `false`
+| `ignoreOldItems`   | Ignore news items that are outdated. <br><br> **Possible values:**`true` or `false` <br> **Default value:** `false`
 | `ignoreOlderThan`  | How old should news items be before they are considered outdated? (Milliseconds) <br><br> **Possible values:**`1` - `...` <br> **Default value:** `86400000` (1 day)
 | `removeStartTags`  | Some newsfeeds feature tags at the **beginning** of their titles or descriptions, such as _[VIDEO]_. This setting allows for the removal of specified tags from the beginning of an item's description and/or title. <br><br> **Possible values:**`'title'`, `'description'`, `'both'`
 | `startTags`        | List the tags you would like to have removed at the beginning of the feed item <br><br> **Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
 | `removeEndTags`    | Remove specified tags from the **end** of an item's description and/or title. <br><br> **Possible values:**`'title'`, `'description'`, `'both'`
 | `endTags`          | List the tags you would like to have removed at the end of the feed item <br><br> **Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
 | `prohibitedWords` | Remove news feed item if one of these words is found anywhere in the title (case insensitive and greedy matching) <br><br> **Possible values:** `['word']` or `['word1','word2',...]`
+| `scrollLength` | Scrolls the full news article page by a given number of pixels when a `ARTICLE_MORE_DETAILS` notification is received and the full news article is already displayed.<br><br> **Possible values:** `1` or `10000` <br> **Default value:** `500`
 
 The `feeds` property contains an array with multiple objects. These objects have the following properties:
 

modules/default/newsfeed/newsfeed.js

@@ -36,7 +36,8 @@ Module.register("newsfeed",{
 		removeEndTags: "",
 		startTags: [],
 		endTags: [],
-		prohibitedWords: []
+		prohibitedWords: [],
+		scrollLength: 500
 	},
 
 	// Define required scripts.
@@ -62,6 +63,7 @@ Module.register("newsfeed",{
 		this.newsItems = [];
 		this.loaded = false;
 		this.activeItem = 0;
+		this.scrollPosition = 0;
 
 		this.registerFeeds();
 
@@ -171,7 +173,6 @@ Module.register("newsfeed",{
 				var description = document.createElement("div");
 				description.className = "small light" + (!this.config.wrapDescription ? " no-wrap" : "");
 				var txtDesc = this.newsItems[this.activeItem].description;
-				//Log.info('txtDesc.length = ' + txtDesc.length + " - " + this.config.lengthDescription);
 				description.innerHTML = (this.config.truncDescription ? (txtDesc.length > this.config.lengthDescription ? txtDesc.substring(0, this.config.lengthDescription) + "..." : txtDesc) : txtDesc);
 				wrapper.appendChild(description);
 			}
@@ -180,12 +181,14 @@ Module.register("newsfeed",{
 				var fullArticle = document.createElement("iframe");
 				fullArticle.className = "";
 				fullArticle.style.width = "100%";
+				// very large height value to allow scrolling
+				fullArticle.height = "10000";
+				fullArticle.style.height = "10000";
 				fullArticle.style.top = "0";
 				fullArticle.style.left = "0";
-				fullArticle.style.position = "fixed";
-				fullArticle.height = window.innerHeight;
 				fullArticle.style.border = "none";
-				fullArticle.src = this.newsItems[this.activeItem].url;
+				fullArticle.src = typeof this.newsItems[this.activeItem].url  === "string" ? this.newsItems[this.activeItem].url : this.newsItems[this.activeItem].url.href;
+				fullArticle.style.zIndex = 1;
 				wrapper.appendChild(fullArticle);
 			}
 
@@ -322,6 +325,10 @@ Module.register("newsfeed",{
 	resetDescrOrFullArticleAndTimer: function() {
 		this.config.showDescription = false;
 		this.config.showFullArticle = false;
+		this.scrollPosition = 0;
+		// reset bottom bar alignment
+		document.getElementsByClassName("region bottom bar")[0].style.bottom = "0";
+		document.getElementsByClassName("region bottom bar")[0].style.top = "inherit";
 		if(!timer){
 			this.scheduleUpdateInterval();
 		}
@@ -350,12 +357,27 @@ Module.register("newsfeed",{
 		}
 		// if "more details" is received the first time: show article summary, on second time show full article
 		else if(notification == "ARTICLE_MORE_DETAILS"){
-			this.config.showDescription = !this.config.showDescription;
-			this.config.showFullArticle = !this.config.showDescription;
-			clearInterval(timer);
-			timer = null;
-			Log.info(this.name + " - showing " + this.config.showDescription ? "article description" : "full article");
-			this.updateDom(100);
+			// full article is already showing, so scrolling down
+			if(this.config.showFullArticle == true){
+				this.scrollPosition += this.config.scrollLength;
+				window.scrollTo(0, this.scrollPosition);
+				Log.info(this.name + " - scrolling down");
+				Log.info(this.name + " - ARTICLE_MORE_DETAILS, scroll position: " + this.config.scrollLength);
+			}
+			// display full article
+			else {
+				this.config.showDescription = !this.config.showDescription;
+				this.config.showFullArticle = !this.config.showDescription;
+				// make bottom bar align to top to allow scrolling
+				if(this.config.showFullArticle == true){
+					document.getElementsByClassName("region bottom bar")[0].style.bottom = "inherit";
+					document.getElementsByClassName("region bottom bar")[0].style.top = "-90px";
+				}
+				clearInterval(timer);
+				timer = null;
+				Log.info(this.name + " - showing " + this.config.showDescription ? "article description" : "full article");
+				this.updateDom(100);
+			}
 		} else if(notification == "ARTICLE_LESS_DETAILS"){
 			this.resetDescrOrFullArticleAndTimer();
 			Log.info(this.name + " - showing only article titles again");