Skip to content

Commit 060e88c

Browse files
authored
Fix: Clarify _showPageCompletion functionality (fixes #215) #219
1 parent e52bf68 commit 060e88c

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Add to _course.json_.
7575
7676
> **\_isShownInNavigationBar** (boolean): Allows **Page Level Progress** to appear in the navigation bar. Acceptable values are `true` and `false`.
7777
78-
> **\_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).
78+
> **\_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`.
7979
8080
> **\_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`.
8181

properties.schema

+2-2
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
"title": "Show page completion",
145145
"inputType": "Checkbox",
146146
"validators": [],
147-
"help": "Controls whether the progress calculations are based on all components - or only those that are set to be displayed in Page Level Progress."
147+
"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."
148148
},
149149
"_isCompletionIndicatorEnabled": {
150150
"type": "boolean",
@@ -201,7 +201,7 @@
201201
"title": "Show page completion",
202202
"inputType": "Checkbox",
203203
"validators": [],
204-
"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."
204+
"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."
205205
},
206206
"_isCompletionIndicatorEnabled": {
207207
"type": "boolean",

schema/contentobject.schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"_showPageCompletion": {
2222
"type": "boolean",
2323
"title": "Include overall page completion",
24-
"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",
24+
"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.",
2525
"default": true
2626
},
2727
"_isCompletionIndicatorEnabled": {

schema/course.schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
"_showPageCompletion": {
131131
"type": "boolean",
132132
"title": "Include overall page completion",
133-
"description": "Controls whether the progress calculations are based on all components - or only those that are set to be displayed in Page Level Progress",
133+
"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.",
134134
"default": true
135135
},
136136
"_isCompletionIndicatorEnabled": {

0 commit comments

Comments
 (0)