Skip to content

Commit c32a341

Browse files
khasselkhassel
committed
location of default modules changed, see MagicMirrorOrg/MagicMirror#4019 
1 parent c822d50 commit c32a341

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

‎module-development/core-module-file.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ MagicMirror will use this template to render your component. You may provide
229229
data to the template with `getTemplateData`.
230230

231231
An example of a default module that uses this method is
232-
[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/newsfeed/newsfeed.js).
232+
[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/newsfeed/newsfeed.js).
233233

234234
Read more about Rendering Components
235235
[in the Rendering Component documentation](/module-development/rendering.md).

‎module-development/introduction.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ maintained by the MagicMirrorOrg.
4747

4848
## Module structure
4949

50-
All modules are loaded in the `modules` folder. The default modules are grouped
51-
together in the `modules/default` folder. Your module should be placed in a
50+
We have 2 folders. The default modules are grouped together in the `defaultmodules`
51+
folder. All other modules should be placed in a
5252
subfolder of `modules`. Note that any file or folder you create in the `modules`
5353
folder will be ignored by git, allowing you to upgrade the MagicMirror² without
5454
the loss of your files.

‎module-development/notifications.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ These notifications are sent by the default modules:
3030

3131
| Notification | Payload | Description |
3232
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33-
| `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. |
34-
| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert) to hide the current alert or notification. |
35-
| `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. |
36-
| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
37-
| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
38-
| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
39-
| `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). |
40-
| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
33+
| `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. |
34+
| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert) to hide the current alert or notification. |
35+
| `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. |
36+
| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
37+
| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
38+
| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
39+
| `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). |
40+
| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
4141

4242
# 3rd Party Module notifications
4343

‎module-development/rendering.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@ this.nunjucksEnvironment().addFilter("space", function (str) {
104104
```
105105

106106
For filter examples see the
107-
[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/weather/weather.js#L221).
107+
[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/weather/weather.js#L221).

‎modules/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ see [configuration](/configuration/introduction.md) for more information.
55

66
| **Option** | **Description** |
77
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8-
| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
8+
| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `calendar` and `custommodules/mymodule`. |
99
| `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. |
1010
| | Note: <br><br>if your implementation of MagicMirror wishes to use custom position values, they need to be used in **index.html** , and in the format <br><br>class="region newpos-a newpos-b"<br> <br>MagicMirror will join the last two terms with an underscore to make a position value like <br><br>newpos-a_newpos-b<br><br>example: class="region top3 left" <br>the position will be "top3_left"<br><br>newpos_b is optional<br>class="region top3" would be valid and produce a position of "top3"<br><br>the new position values will be checked during MagicMirror startup and also in the configuration checker <br> node --run config:check <br><br> 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) |
1111
| `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. |

‎modules/customcss.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ it to your `custom.css`-file like in the example above.
2323

2424
Each module has a class set for the div it resides in named after the module
2525
(including all the 3rd-party modules). As an example the
26-
[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/clock)
26+
[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/clock)
2727
could be customized by using the class `.clock`.
2828

2929
### Help

0 commit comments

Comments
 (0)