diff --git a/module-development/core-module-file.md b/module-development/core-module-file.md index df81f85e..45a1c9cc 100644 --- a/module-development/core-module-file.md +++ b/module-development/core-module-file.md @@ -229,7 +229,7 @@ MagicMirror will use this template to render your component. You may provide data to the template with `getTemplateData`. An example of a default module that uses this method is -[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/newsfeed/newsfeed.js). +[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/newsfeed/newsfeed.js). Read more about Rendering Components [in the Rendering Component documentation](/module-development/rendering.md). diff --git a/module-development/introduction.md b/module-development/introduction.md index 21c620ee..8a28b504 100644 --- a/module-development/introduction.md +++ b/module-development/introduction.md @@ -47,8 +47,8 @@ maintained by the MagicMirrorOrg. ## 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 +We have 2 folders. The default modules are grouped together in the `defaultmodules` +folder. All other modules should be placed in a subfolder of `modules`. Note that any file or folder you create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files. diff --git a/module-development/notifications.md b/module-development/notifications.md index ababe032..25fc63b3 100644 --- a/module-development/notifications.md +++ b/module-development/notifications.md @@ -30,14 +30,14 @@ These notifications are sent by the default modules: | Notification | Payload | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `SHOW_ALERT` | [message details](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert#notification-params) | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert) to show an alert or notification. | -| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert) to hide the current alert or notification. | -| `CALENDAR_EVENTS` | [calendar events](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/calendar) | Sent by [calendar module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/calendar) to inform modules of the calendar events. | -| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). | -| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). | -| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). | -| `ARTICLE_LESS_DETAILS` | _none_ | Hides the summary or full news article and only displays the news title of the currently viewed news item in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). | -| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). | +| `SHOW_ALERT` | [message details](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert#notification-params) | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert) to show an alert or notification. | +| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert) to hide the current alert or notification. | +| `CALENDAR_EVENTS` | [calendar events](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/calendar) | Sent by [calendar module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/calendar) to inform modules of the calendar events. | +| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). | +| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). | +| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). | +| `ARTICLE_LESS_DETAILS` | _none_ | Hides the summary or full news article and only displays the news title of the currently viewed news item in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). | +| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). | # 3rd Party Module notifications diff --git a/module-development/rendering.md b/module-development/rendering.md index db9f5d18..fef6fc56 100644 --- a/module-development/rendering.md +++ b/module-development/rendering.md @@ -104,4 +104,4 @@ this.nunjucksEnvironment().addFilter("space", function (str) { ``` For filter examples see the -[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/weather/weather.js#L221). +[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/weather/weather.js#L221). diff --git a/modules/configuration.md b/modules/configuration.md index e90adee4..8c368ef7 100644 --- a/modules/configuration.md +++ b/modules/configuration.md @@ -5,7 +5,7 @@ see [configuration](/configuration/introduction.md) for more information. | **Option** | **Description** | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. | +| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `calendar` and `custommodules/mymodule`. | | `position` | The location of the module in which the module will be loaded. The built in values are `top_bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. (if not set, the module will not be shown, but will run the same) Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file, top down. | | | Note:

if your implementation of MagicMirror wishes to use custom position values, they need to be used in **index.html** , and in the format

class="region newpos-a newpos-b"

MagicMirror will join the last two terms with an underscore to make a position value like

newpos-a_newpos-b

example: class="region top3 left"
the position will be "top3_left"

newpos_b is optional
class="region top3" would be valid and produce a position of "top3"

the new position values will be checked during MagicMirror startup and also in the configuration checker
node --run config:check

AND you have to have the appropriate css settings in custom.css for these new region values (top3 and left as used in the example above) | | `classes` | One or more additional CSS classes which will be set on the module, as a string of space-separated values. This field is optional. | diff --git a/modules/customcss.md b/modules/customcss.md index 289c6ac1..e8450e1e 100644 --- a/modules/customcss.md +++ b/modules/customcss.md @@ -23,7 +23,7 @@ it to your `custom.css`-file like in the example above. Each module has a class set for the div it resides in named after the module (including all the 3rd-party modules). As an example the -[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/clock) +[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/clock) could be customized by using the class `.clock`. ### Help