kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-08-22 05:07:05 +00:00
Code Issues Projects Releases Wiki Activity

Improve documentation.

Browse Source
This commit is contained in:
Michael Teeuw
2016-10-13 16:47:00 +02:00
parent a75ff0c061
commit a6191320a1
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
modules/README.md
View File

@@ -87,7 +87,7 @@ A string that defines the minimum version of the MagicMirror framework. If it is
**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module. **Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
Example: Example:
```` ````javascript
requiresVersion: "2.1.0", requiresVersion: "2.1.0",
```` ````
@@ -336,48 +336,48 @@ Possible configurable options:
Visiblity locking helps the module system to prevent unwanted hide/show actions. The following scenario explains the concept: Visiblity locking helps the module system to prevent unwanted hide/show actions. The following scenario explains the concept:
**Module B asks module A to hide:** **Module B asks module A to hide:**
```` ````javascript
moduleA.hide(0, {lockString: "module_b_identifier"}); moduleA.hide(0, {lockString: "module_b_identifier"});
```` ````
Module A is now hidden, and has an lock array with the following strings: Module A is now hidden, and has an lock array with the following strings:
```` ````javascript
moduleA.lockStrings == ["module_b_identifier"] moduleA.lockStrings == ["module_b_identifier"]
moduleA.hidden == true moduleA.hidden == true
```` ````
**Module C asks module A to hide:** **Module C asks module A to hide:**
```` ````javascript
moduleA.hide(0, {lockString: "module_c_identifier"}); moduleA.hide(0, {lockString: "module_c_identifier"});
```` ````
Module A is now hidden, and has an lock array with the following strings: Module A is now hidden, and has an lock array with the following strings:
```` ````javascript
moduleA.lockStrings == ["module_b_identifier", "module_c_identifier"] moduleA.lockStrings == ["module_b_identifier", "module_c_identifier"]
moduleA.hidden == true moduleA.hidden == true
```` ````
**Module B asks module A to show:** **Module B asks module A to show:**
```` ````javascript
moduleA.show(0, {lockString: "module_b_identifier"}); moduleA.show(0, {lockString: "module_b_identifier"});
```` ````
The lockString will be removed from moduleA’s locks array, but since there still is an other lock string available, the module remains hidden: The lockString will be removed from moduleA’s locks array, but since there still is an other lock string available, the module remains hidden:
```` ````javascript
moduleA.lockStrings == ["module_c_identifier"] moduleA.lockStrings == ["module_c_identifier"]
moduleA.hidden == true moduleA.hidden == true
```` ````
**Module C asks module A to show:** **Module C asks module A to show:**
```` ````javascript
moduleA.show(0, {lockString: "module_c_identifier"}); moduleA.show(0, {lockString: "module_c_identifier"});
```` ````
The lockString will be removed from moduleA’s locks array, and since this will result in an empty lock array, the module will be visible: The lockString will be removed from moduleA’s locks array, and since this will result in an empty lock array, the module will be visible:
```` ````javascript
moduleA.lockStrings == [] moduleA.lockStrings == []
moduleA.hidden == false moduleA.hidden == false
```` ````
**Note:** The locking mechanism can be overwritten by using the force tag: **Note:** The locking mechanism can be overwritten by using the force tag:
```` ````javascript
moduleA.show(0, {force: true}); moduleA.show(0, {force: true});
```` ````
This will reset the lockstring array, and will show the module. This will reset the lockstring array, and will show the module.
```` ````javascript
moduleA.lockStrings == [] moduleA.lockStrings == []
moduleA.hidden == false moduleA.hidden == false
```` ````
@@ -475,7 +475,7 @@ A string that defines the minimum version of the MagicMirror framework. If it is
**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module. **Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
Example: Example:
```` ````javascript
requiresVersion: "2.1.0", requiresVersion: "2.1.0",
```` ````