~8@bx@7Vtg%oxua&-=j6#rG)4D4=4VM3psk5%4Rp@9`3vC4)R45E6%%oM>DJH
z
**Possible values:** `true` or `false`
**Default value:** `true` |
| `showWeek` | Turn off or on the Week section.
**Possible values:** `true` or `false`
**Default value:** `false` |
| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only).
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `showMoonTimes` | Turn off or on the section showing moonrise and moonset times (digital clock only).
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `showMoonTimes` | Turn off or on the section showing moonrise and moonset times (digital clock only). Optionally display an image of lunar phase and lit percentage of the moon
**Possible values:** `times`, `percent`, `phase`, `both` or `false` (disable)
**Default value:** `false` |
| `lat` | Latitude for sun/moon calculations.
**Default value:** `47.630539` |
| `lon` | Longitude for sun/moon calculations.
**Default value:** `-122.344147` |
| `dateFormat` | Configure the date format as you like.
**Possible values:** [Docs](https://momentjs.com/docs/#/displaying/format/)
**Default value:** `"dddd, LL"` |
From b284abf0eba528651154e92186d06fca18ea8325 Mon Sep 17 00:00:00 2001
From: Veeck
-**Note 2:** The socket connection is
-established as soon as the module sends its first message using
+type receive the same notifications.
+
+**Note 2:** The socket connection is established as soon as the module sends its
+first message using
[sendSocketNotification](#this-sendsocketnotification-notification-payload).
**Example:**
@@ -316,8 +317,7 @@ module.
### `this.file(filename)`
**_filename_ String** - The name of the file you want to create the path
-for.
-**Returns String**
+for.
**Returns String**
If you want to create a path to a file in your module folder, use the `file()`
method. It returns the path to the filename given as the attribute. Is method
@@ -345,22 +345,24 @@ start: function() {
...
```
-**_options_ Object** - (_Introduced in version: 2.25.0._) Optional. Allows you to determine the animation speed and animation type options, whenever your module needs to be updated
+**_options_ Object** - (_Introduced in version: 2.25.0._) Optional. Allows you
+to determine the animation speed and animation type options, whenever your
+module needs to be updated
-| options | type | description |
-| ------- | ---- | ----------- |
-| speed | Number | animation speed in ms |
+| options | type | description |
+| ------- | ------ | ------------------------------------ |
+| speed | Number | animation speed in ms |
| animate | Object | animate IN and OUT rules (see below) |
-
**animate Object**
-| animate | type | description |
-| ------- | ---- | ----------- |
-| in | String | Animate name when module will be shown (after dom update), it will use an `animateIn` type name (see [Animation Guide](../modules/animate#animatein)) |
+| animate | type | description |
+| ------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| in | String | Animate name when module will be shown (after dom update), it will use an `animateIn` type name (see [Animation Guide](../modules/animate#animatein)) |
| out | String | Animate name when module will be hidden (before dom update), it will use an `animateOut` type name (see [Animation Guide](../modules/animate#animateout)) |
As an example:
+
```javascript
...
this.updateDom( {
@@ -377,8 +379,8 @@ As an example:
### `this.sendNotification(notification, payload)`
-**_notification_ String** - The notification identifier.
-**_payload_ AnyType** - Optional. A notification payload.
+- `notification` - String - The notification identifier.
+- `payload` - AnyType - (Optional) A notification payload.
If you want to send a notification to all other modules, use the
`sendNotification(notification, payload)`. All other modules will receive the
@@ -395,8 +397,8 @@ this.sendNotification("MYMODULE_READY_FOR_ACTION", { foo: bar });
### `this.sendSocketNotification(notification, payload)`
-**_notification_ String** - The notification identifier.
-**_payload_ AnyType** - Optional. A notification payload.
+- `notification` - String - The notification identifier.
+- `payload` - AnyType - (Optional) A notification payload.
If you want to send a notification to the node_helper, use the
`sendSocketNotification(notification, payload)`. Only the node_helper of this
diff --git a/development/node-helper.md b/development/node-helper.md
index e90d1e5c..7e7b24fe 100644
--- a/development/node-helper.md
+++ b/development/node-helper.md
@@ -147,12 +147,12 @@ module.
### `this.sendSocketNotification(notification, payload)`
-**_notification_ String** - The notification identifier.
-**_payload_ AnyType** - Optional. A notification payload.
+- `notification` - String - The notification identifier.
+- `payload` - AnyType - (Optional) The payload of a notification.
If you want to send a notification to your module, use the
-`sendSocketNotification(notification, payload)`.
-Only the module of your module type will receive the socket notification.
+`sendSocketNotification(notification, payload)`. Only the module of your module
+type will receive the socket notification.
**Note:** Since all instances of your module will receive the notifications,
it's your task to make sure the right module responds to your messages.
diff --git a/getting-started/installation.md b/getting-started/installation.md
index aa42171f..3729a442 100644
--- a/getting-started/installation.md
+++ b/getting-started/installation.md
@@ -14,7 +14,9 @@ installers can be found under:
## Manual Installation
-1. Download and install the latest _Node.js_ version, see the official documentation:
+1. Download and install the latest _Node.js_ version, see the official
+ documentation:
+
- [Linux based distributions](https://github.com/nodesource/distributions)
- [Others](https://nodejs.org/en/download)
diff --git a/modules/animate.md b/modules/animate.md
index e846db9a..a89c1d51 100644
--- a/modules/animate.md
+++ b/modules/animate.md
@@ -1,4 +1,5 @@
# Animation Guide
+
(_Introduced in version: 2.25.0_)
::: tip Preview of animation
@@ -6,6 +7,7 @@ check the [animate.css](https://animate.style/) library to see a preview of the
:::
::: warning Where animation can be used?
+
- [global module configuration](configuration.html#animated) of a module
- [this.hide()](../development/core-module-file.html#this-hide-speed-callback-options) function in core module file
- [this.show()](../development/core-module-file.html#this-show-speed-callback-options) function in core module file
diff --git a/modules/calendar.md b/modules/calendar.md
index b9a378b3..568e231d 100755
--- a/modules/calendar.md
+++ b/modules/calendar.md
@@ -26,55 +26,55 @@ modules: [
The following properties can be configured:
-| Option | Description |
-| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `maximumEntries` | The maximum number of events shown. / **Possible values:** `0` - `100`
**Default value:** `10` |
-| `maximumNumberOfDays` | The maximum number of days in the future.
**Default value:** `365` |
-| `pastDaysCount` | The number of days of which events in the past should be displayed.
**Default value:** `0` |
-| `displaySymbol` | Display a symbol in front of an entry.
**Possible values:** `true` or `false`
**Default value:** `true` |
-| `defaultSymbol` | The default symbol.
**Possible values:** See [Font Awesome](https://fontawesome.com/v6/search?o=r&m=free) website.
**Default value:** `calendar` |
-| `showLocation` | Whether to show event locations.
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `maxTitleLength` | The maximum title length.
**Possible values:** `10` - `50`
**Default value:** `25` |
-| `maxLocationTitleLength` | The maximum location title length.
**Possible values:** `10` - `50`
**Default value:** `25` |
-| `wrapEvents` | Wrap event titles to multiple lines. Breaks lines at the length defined by `maxTitleLength`.
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `wrapLocationEvents` | Wrap event location titles to multiple lines. Breaks lines at the length defined by `maxLocationTitleLength`.
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `maxTitleLines` | The maximum number of lines a title will wrap vertically before being cut (Only enabled if `wrapEvents` is also enabled).
**Possible values:** `0` - `10`
**Default value:** `3` |
-| `maxEventTitleLines` | The maximum number of lines a location title will wrap vertically before being cut (Only enabled if `wrapLocationEvents` is also enabled).
**Possible values:** `0` - `10`
**Default value:** `3` |
-| `fetchInterval` | How often does the content needs to be fetched? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `300000` (5 minutes) |
-| `animationSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:** `0` - `5000`
**Default value:** `2000` (2 seconds) |
-| `fade` | Fade the future events to black. (Gradient)
**Possible values:** `true` or `false`
**Default value:** `true` |
-| `fadePoint` | Where to start fade?
**Possible values:** `0` (top of the list) - `1` (bottom of list)
**Default value:** `0.25` |
-| `tableClass` | Name of the classes issued from `main.css`.
**Possible values:** xsmall, small, medium, large, xlarge.
**Default value:** _small._ |
-| `calendars` | The list of calendars.
**Possible values:** An array, see _calendar configuration_ below.
**Default value:** _An example calendar._ |
-| `titleReplace` | DEPRECATED, please consider switching to `customEvents`
An object of textual replacements applied to the tile of the event. This allow to remove or replace certain words in the title.
**Example:** `{'Birthday of ' : '', 'foo':'bar'}`
**Default value:** `{ "De verjaardag van ": "", "'s birthday": "" }` |
-| `displayRepeatingCountTitle` | Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary")
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `dateFormat` | Format to use for the date of events when using absolute dates. (version <= 2.16.0) From version 2.16.0, this option will be used to format absolute and relative dates. (e.g. DD/MM/YY to change from the default MM/DD/YYYY)
To show the event time along with the date, use a format like `MMM Do HH:mm`. Depending on configuration, may also require the options `timeFormat:"absolute", urgency:0, getRelative:0,`
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) |
-| `dateEndFormat` | Format to use for the end time of events
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `HH:mm` (e.g. 16:30) |
-| `showEnd` | Show end time of events
**Possible values:** `true` or `false`
**Default value:** `true` |
-| `fullDayEventDateFormat` | Format to use for the date of full day events (when using absolute dates)
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) |
-| `timeFormat` | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it
**Possible values:** `absolute` or `relative` or `dateheaders`
**Default value:** `relative` |
-| `showEnd` | Display the end of a date as well
**Possible values:** `true` or `false`
**Default value:** `true` |
-| `getRelative` | How much time (in hours) should be left until calendar events start getting relative?
**Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts)
**Default value:** `6` |
-| `urgency` | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates
**Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days)
**Default value:** `7` |
-| `broadcastEvents` | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`.
**Possible values:** `true`, `false`
**Default value:** `true` |
-| `hidePrivate` | Hides private calendar events.
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `hideOngoing` | Hides calendar events that have already started.
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `excludedEvents` | An array of words / phrases from event titles that will be excluded from being shown.
Additionally advanced filter objects can be passed in. Below is the configuration for the advance filtering object.
**Required**
`filterBy` - string used to determine if filter is applied.
**Optional**
`until` - Time before an event to display it Ex: [`'3 days'`, `'2 months'`, `'1 week'`]
`caseSensitive` - By default, excludedEvents are case insensitive, set this to true to enforce case sensitivity
`regex` - set to `true` if filterBy is a regex. For those not familiar with regex it is used for pattern matching, please see [here](https://regexr.com/) for more info.
**Example:** `['Birthday', 'Hide This Event', {filterBy: 'Payment', until: '6 days', caseSensitive: true}, {filterBy: '^[0-9]{1,}.*', regex: true}]`
**Default value:** `[]` |
-| `broadcastPastEvents` | If this is set to true, events from the past `maximumNumberOfDays` will be included in event broadcasts
**Default value:** `false` |
-| `sliceMultiDayEvents` | If this is set to true, events exceeding at least one midnight will be sliced into separate events including a counter like (1/2). This is especially helpful in "dateheaders" mode. Events will be sliced at midnight, end time for all events but the last will be 23:59
**Default value:** `false` |
-| `nextDaysRelative` | If this is set to true, the appointments of today and tomorrow are displayed relatively, even if the timeformat is set to absolute.
**Default value:** `false` |
-| `customEvents` | An array of `keyword`/`symbol`/`color`/`transform` that will customize events based on keyword in title.
`keyword` is a case-insensitive string that if present in event title will trigger the use of custom symbol and/or color for that event,
`symbol` is the Font Awesome icon to use as symbol and
`color` is the CSS color to use for the event.
`transform` is an object for regular expression text replacement of the calendar title consisting of the following elements:
- `search` regular expression to search for
- `replace` replace string, may contain group match references
- `yearmatchgroup` (optional) the regex match group of a year that you want to replace to the current age
`keyword` and at least one of `symbol`, `color`, `transform` is required.
**Examples:**
`customEvents: [{keyword: 'Birthday', symbol: 'birthday-cake', color: 'Gold'}]`
`customEvents: [{keyword: 'Geburtstag', symbol: 'birthday-cake', color: 'Gold', transform: { search: '^([^\']*) \'(\\d{4})$' , replace: '$1 ($2.)', yearmatchgroup: 2}},{keyword: 'in Hamburg', transform: { search: ' in Hamburg$' , replace: ''}} ]`
Will transform
to
 |
-| `limitDays` | If this property is set to a value greater than zero, the number of unique days displayed will be limited to `limitDays` days.
**Default value:** `0` (no limit) |
-| `limitDaysNeverSkip` | If this property is set to true, every event for every day will be shown regardless of if the day on has a single full day event or not.
**Default value:** `false` |
-| `flipDateHeaderTitle` | This property deterines if the title for the date header in the `dateheaders` time format will align to the left or right.
**Possible values:** `true` (right) or `false` (left)
**Default value:** `false` (left) |
-| `hideTime` | If this property is set to true the time portion on relative times will be hidden.
**Default value:** `false` |
-| `showTimeToday` | If this property is set to true, the event time will be displayed for same-day events even when relative display is being used.
**Default value:** `false` |
-| `colored`
_(deprecated)_ | If this property is set to true, an individual color can be set for each calendar.
**Default value:** `false` |
-| `coloredSymbolOnly`
_(deprecated)_ | If this property is set to true, an individual symbol color can be set for each calendar, not the whole line. This is only applicable when `colored` is also enabled.
**Default value:** `false` |
-| `coloredText` | If this property is set to true, an individual text color can be set for each calendar.
**Default value:** `false` |
-| `coloredBorder` | If this property is set to true, an individual border color can be set for each calendar.
**Default value:** `false` |
-| `coloredSymbol` | If this property is set to true, an individual symbol color can be set for each calendar.
**Default value:** `false` |
-| `coloredBackground` | If this property is set to true, an individual background color can be set for each calendar.
**Default value:** `false` |
+| Option | Description |
+| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `maximumEntries` | The maximum number of events shown. / **Possible values:** `0` - `100`
**Default value:** `10` |
+| `maximumNumberOfDays` | The maximum number of days in the future.
**Default value:** `365` |
+| `pastDaysCount` | The number of days of which events in the past should be displayed.
**Default value:** `0` |
+| `displaySymbol` | Display a symbol in front of an entry.
**Possible values:** `true` or `false`
**Default value:** `true` |
+| `defaultSymbol` | The default symbol.
**Possible values:** See [Font Awesome](https://fontawesome.com/v6/search?o=r&m=free) website.
**Default value:** `calendar` |
+| `showLocation` | Whether to show event locations.
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `maxTitleLength` | The maximum title length.
**Possible values:** `10` - `50`
**Default value:** `25` |
+| `maxLocationTitleLength` | The maximum location title length.
**Possible values:** `10` - `50`
**Default value:** `25` |
+| `wrapEvents` | Wrap event titles to multiple lines. Breaks lines at the length defined by `maxTitleLength`.
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `wrapLocationEvents` | Wrap event location titles to multiple lines. Breaks lines at the length defined by `maxLocationTitleLength`.
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `maxTitleLines` | The maximum number of lines a title will wrap vertically before being cut (Only enabled if `wrapEvents` is also enabled).
**Possible values:** `0` - `10`
**Default value:** `3` |
+| `maxEventTitleLines` | The maximum number of lines a location title will wrap vertically before being cut (Only enabled if `wrapLocationEvents` is also enabled).
**Possible values:** `0` - `10`
**Default value:** `3` |
+| `fetchInterval` | How often does the content needs to be fetched? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `300000` (5 minutes) |
+| `animationSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:** `0` - `5000`
**Default value:** `2000` (2 seconds) |
+| `fade` | Fade the future events to black. (Gradient)
**Possible values:** `true` or `false`
**Default value:** `true` |
+| `fadePoint` | Where to start fade?
**Possible values:** `0` (top of the list) - `1` (bottom of list)
**Default value:** `0.25` |
+| `tableClass` | Name of the classes issued from `main.css`.
**Possible values:** xsmall, small, medium, large, xlarge.
**Default value:** _small._ |
+| `calendars` | The list of calendars.
**Possible values:** An array, see _calendar configuration_ below.
**Default value:** _An example calendar._ |
+| `titleReplace` | DEPRECATED, please consider switching to `customEvents`
An object of textual replacements applied to the tile of the event. This allow to remove or replace certain words in the title.
**Example:** `{'Birthday of ' : '', 'foo':'bar'}`
**Default value:** `{ "De verjaardag van ": "", "'s birthday": "" }` |
+| `displayRepeatingCountTitle` | Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary")
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `dateFormat` | Format to use for the date of events when using absolute dates. (version <= 2.16.0) From version 2.16.0, this option will be used to format absolute and relative dates. (e.g. DD/MM/YY to change from the default MM/DD/YYYY)
To show the event time along with the date, use a format like `MMM Do HH:mm`. Depending on configuration, may also require the options `timeFormat:"absolute", urgency:0, getRelative:0,`
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) |
+| `dateEndFormat` | Format to use for the end time of events
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `HH:mm` (e.g. 16:30) |
+| `showEnd` | Show end time of events
**Possible values:** `true` or `false`
**Default value:** `true` |
+| `fullDayEventDateFormat` | Format to use for the date of full day events (when using absolute dates)
**Possible values:** See [Moment.js formats](https://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) |
+| `timeFormat` | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it
**Possible values:** `absolute` or `relative` or `dateheaders`
**Default value:** `relative` |
+| `showEnd` | Display the end of a date as well
**Possible values:** `true` or `false`
**Default value:** `true` |
+| `getRelative` | How much time (in hours) should be left until calendar events start getting relative?
**Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts)
**Default value:** `6` |
+| `urgency` | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates
**Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days)
**Default value:** `7` |
+| `broadcastEvents` | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`.
**Possible values:** `true`, `false`
**Default value:** `true` |
+| `hidePrivate` | Hides private calendar events.
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `hideOngoing` | Hides calendar events that have already started.
**Possible values:** `true` or `false`
**Default value:** `false` |
+| `excludedEvents` | An array of words / phrases from event titles that will be excluded from being shown.
Additionally advanced filter objects can be passed in. Below is the configuration for the advance filtering object.
**Required**
`filterBy` - string used to determine if filter is applied.
**Optional**
`until` - Time before an event to display it Ex: [`'3 days'`, `'2 months'`, `'1 week'`]
`caseSensitive` - By default, excludedEvents are case insensitive, set this to true to enforce case sensitivity
`regex` - set to `true` if filterBy is a regex. For those not familiar with regex it is used for pattern matching, please see [here](https://regexr.com/) for more info.
**Example:** `['Birthday', 'Hide This Event', {filterBy: 'Payment', until: '6 days', caseSensitive: true}, {filterBy: '^[0-9]{1,}.*', regex: true}]`
**Default value:** `[]` |
+| `broadcastPastEvents` | If this is set to true, events from the past `maximumNumberOfDays` will be included in event broadcasts
**Default value:** `false` |
+| `sliceMultiDayEvents` | If this is set to true, events exceeding at least one midnight will be sliced into separate events including a counter like (1/2). This is especially helpful in "dateheaders" mode. Events will be sliced at midnight, end time for all events but the last will be 23:59
**Default value:** `false` |
+| `nextDaysRelative` | If this is set to true, the appointments of today and tomorrow are displayed relatively, even if the timeformat is set to absolute.
**Default value:** `false` |
+| `customEvents` | An array of `keyword`/`symbol`/`color`/`transform` that will customize events based on keyword in title.
`keyword` is a case-insensitive string that if present in event title will trigger the use of custom symbol and/or color for that event,
`symbol` is the Font Awesome icon to use as symbol and
`color` is the CSS color to use for the event.
`transform` is an object for regular expression text replacement of the calendar title consisting of the following elements:
- `search` regular expression to search for
- `replace` replace string, may contain group match references
- `yearmatchgroup` (optional) the regex match group of a year that you want to replace to the current age
`keyword` and at least one of `symbol`, `color`, `transform` is required.
**Examples:**
`customEvents: [{keyword: 'Birthday', symbol: 'birthday-cake', color: 'Gold'}]`
`customEvents: [{keyword: 'Geburtstag', symbol: 'birthday-cake', color: 'Gold', transform: { search: '^([^\']*) \'(\\d{4})$' , replace: '$1 ($2.)', yearmatchgroup: 2}},{keyword: 'in Hamburg', transform: { search: ' in Hamburg$' , replace: ''}} ]`
Will transform
to
 |
+| `limitDays` | If this property is set to a value greater than zero, the number of unique days displayed will be limited to `limitDays` days.
**Default value:** `0` (no limit) |
+| `limitDaysNeverSkip` | If this property is set to true, every event for every day will be shown regardless of if the day on has a single full day event or not.
**Default value:** `false` |
+| `flipDateHeaderTitle` | This property deterines if the title for the date header in the `dateheaders` time format will align to the left or right.
**Possible values:** `true` (right) or `false` (left)
**Default value:** `false` (left) |
+| `hideTime` | If this property is set to true the time portion on relative times will be hidden.
**Default value:** `false` |
+| `showTimeToday` | If this property is set to true, the event time will be displayed for same-day events even when relative display is being used.
**Default value:** `false` |
+| `colored`
_(deprecated)_ | If this property is set to true, an individual color can be set for each calendar.
**Default value:** `false` |
+| `coloredSymbolOnly`
_(deprecated)_ | If this property is set to true, an individual symbol color can be set for each calendar, not the whole line. This is only applicable when `colored` is also enabled.
**Default value:** `false` |
+| `coloredText` | If this property is set to true, an individual text color can be set for each calendar.
**Default value:** `false` |
+| `coloredBorder` | If this property is set to true, an individual border color can be set for each calendar.
**Default value:** `false` |
+| `coloredSymbol` | If this property is set to true, an individual symbol color can be set for each calendar.
**Default value:** `false` |
+| `coloredBackground` | If this property is set to true, an individual background color can be set for each calendar.
**Default value:** `false` |
#### Default value:
@@ -121,7 +121,7 @@ config: {
#### Calendar authentication options:
| Option | Description |
-| -------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `user` | The username for HTTP authentication. |
| `pass` | The password for HTTP authentication. (If you use Bearer authentication, this should be your BearerToken.) |
| `method` | Which authentication method should be used. HTTP Basic and Bearer authentication methods are supported. Basic authentication is used by default if this option is omitted.
**Possible values:** `basic`, `bearer` **Default value:** `basic` |
diff --git a/modules/clock.md b/modules/clock.md
index 9cafac20..0c6d6b36 100644
--- a/modules/clock.md
+++ b/modules/clock.md
@@ -5,7 +5,7 @@ displays the current date and time. The information will be updated realtime.
## Screenshot
-- Current time 
+
## Using the module
@@ -40,7 +40,7 @@ The following properties can be configured:
| `showDate` | Turn off or on the Date section.
**Possible values:** `true` or `false`
**Default value:** `true` |
| `showWeek` | Turn off or on the Week section.
**Possible values:** `true` or `false`
**Default value:** `false` |
| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only).
**Possible values:** `true` or `false`
**Default value:** `false` |
-| `showMoonTimes` | Turn off or on the section showing moonrise and moonset times (digital clock only). Optionally display an image of lunar phase and lit percentage of the moon
**Possible values:** `times`, `percent`, `phase`, `both` or `false` (disable)
**Default value:** `false` |
+| `showMoonTimes` | Turn off or on the section showing moonrise and moonset times (digital clock only). Optionally display an image of lunar phase and lit percentage of the moon
**Possible values:** `times`, `percent`, `phase`, `both` or `false` (disable)
**Default value:** `false` |
| `lat` | Latitude for sun/moon calculations.
**Default value:** `47.630539` |
| `lon` | Longitude for sun/moon calculations.
**Default value:** `-122.344147` |
| `dateFormat` | Configure the date format as you like.
**Possible values:** [Docs](https://momentjs.com/docs/#/displaying/format/)
**Default value:** `"dddd, LL"` |
diff --git a/modules/compliments.md b/modules/compliments.md
index e12373a2..49589de4 100644
--- a/modules/compliments.md
+++ b/modules/compliments.md
@@ -3,10 +3,9 @@
The `compliments` module is one of the default modules of the MagicMirror. This
module displays a random compliment.
-## Screenshots
+## Screenshot
-- Compliments Screenshot
- 
+
## Using the module
diff --git a/modules/configuration.md b/modules/configuration.md
index e1dbbc3f..c6ae3b9d 100644
--- a/modules/configuration.md
+++ b/modules/configuration.md
@@ -64,6 +64,7 @@ screen, one under everything else and the other above.
All these regions will resize as needed.
## Animated
+
(_Introduced in version: 2.25.0_)
Animated feature allows to define an animation to a module
@@ -79,7 +80,8 @@ The whole of animation names are available [there](./animate.html).
### Example with `newsfeed` module
-For this example, news will come from the left (`slideInLeft` animation), wait in the middle, and exit from the right (`slideOutRight` animation)
+For this example, news will come from the left (`slideInLeft` animation), wait
+in the middle, and exit from the right (`slideOutRight` animation)
diff --git a/modules/newsfeed.md b/modules/newsfeed.md
index 922b8f4c..9ad069b6 100644
--- a/modules/newsfeed.md
+++ b/modules/newsfeed.md
@@ -7,8 +7,7 @@ sending news feed specific notifications to the module.
## Screenshot
-- News Feed Screenshot using the NYT
- 
+
## Using the module
diff --git a/modules/screenshots/clock_screenshot.png b/modules/screenshots/clock.png
similarity index 100%
rename from modules/screenshots/clock_screenshot.png
rename to modules/screenshots/clock.png
diff --git a/modules/screenshots/compliments_screenshot.png b/modules/screenshots/compliments.png
similarity index 100%
rename from modules/screenshots/compliments_screenshot.png
rename to modules/screenshots/compliments.png
diff --git a/modules/screenshots/current.png b/modules/screenshots/current.png
deleted file mode 100644
index de6c5a39ea341592fcd25d19d6a382457bad9e35..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 8141
zcmch6XEdB&^zIm=_vl?n5QGs?qPHMI^yp(kv}h5%*C=6#pJ4RfduO!KMJLgXQDQ{z
z1R1W}b-&&(cir{>@ILQ3>zwD^d+oE&KF_;OwDucSGGZoT002PtN=;c80Kj3mZx;~a
z-=oH{u-N?z$4ysN5l}VGvVGqH*(zu%006b|B!A!G-S>$;su{Zh0OY;@9-Kj!lJ@`r
zyX7lo1$}SGekPIK`&W#EN#RpSI7cN>ST}=;=>VhsRLi`CO|lAg9+y>~*c)bh#<}i_
zf&3Y#DQ{(%s