Fix: Clarify _showPageCompletion functionality (fixes #215) #219

README.md

@@ -75,7 +75,7 @@ Add to _course.json_.
 
 > **\_isShownInNavigationBar** (boolean): Allows **Page Level Progress** to appear in the navigation bar. Acceptable values are `true` and `false`.
 
-> **\_showPageCompletion** (boolean): Set to `false` to have the overall progress calculated only from components that have been set to display in **Page Level Progress** (ignoring the completion of those that haven't).
+> **\_showPageCompletion** (boolean): Set to `false` to have the overall progress calculated only from components that have been set to display in **Page Level Progress** (ignoring the completion of those that haven't). Defaults to `true`.
 
 > **\_showAtCourseLevel** (boolean): Allows **Page Level Progress** to display all content objects and the current page components together, or just the current page components as before. Acceptable values are `true` and `false`.
 

properties.schema

@@ -144,7 +144,7 @@
                   "title": "Show page completion",
                   "inputType": "Checkbox",
                   "validators": [],
-                  "help": "Controls whether the progress calculations are based on all components - or only those that are set to be displayed in Page Level Progress."
+                  "help": "When enabled, the overall course progress will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled."
                 },
                 "_isCompletionIndicatorEnabled": {
                   "type": "boolean",
@@ -201,7 +201,7 @@
                   "title": "Show page completion",
                   "inputType": "Checkbox",
                   "validators": [],
-                  "help": "Controls whether the progress calculations for this page are based on all components and the overall page - or only the components that are set to be displayed in Page Level Progress."
+                  "help": "When enabled, the overall progress for this page will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled."
                 },
                 "_isCompletionIndicatorEnabled": {
                   "type": "boolean",

schema/contentobject.schema.json

@@ -21,7 +21,7 @@
             "_showPageCompletion": {
               "type": "boolean",
               "title": "Include overall page completion",
-              "description": "Controls whether the progress calculations for this page are based on all components and the overall page - or only the components that are set to be displayed in Page Level Progress",
+              "description": "When enabled, the overall progress for this page will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled.",
               "default": true
             },
             "_isCompletionIndicatorEnabled": {

schema/course.schema.json

@@ -130,7 +130,7 @@
             "_showPageCompletion": {
               "type": "boolean",
               "title": "Include overall page completion",
-              "description": "Controls whether the progress calculations are based on all components - or only those that are set to be displayed in Page Level Progress",
+              "description": "When enabled, the overall course progress will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled.",
               "default": true
             },
             "_isCompletionIndicatorEnabled": {