Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: Clarify the behavior when _assessmentId is left blank (fixes #81) #85

Merged
merged 3 commits into from
May 29, 2024
Merged

Fix: Clarify the behavior when _assessmentId is left blank (fixes #81) #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61f71a9
Clarify the behavior when _assessmentId is left blank
swashbuck May 15, 2024
5f8a21e
Add period at end of description
swashbuck May 29, 2024
39bbdc1
Add period at end of description
swashbuck May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The attributes listed below are used in *components.json* to configure **Assessm
**instruction** (string): This optional text appears above the component. It is frequently used to
guide the learner’s interaction with the component.

**_assessmentId** (string): This value must match the [`_id` of the assessment](https://github.com/adaptlearning/adapt-contrib-assessment#attributes) for which results should be displayed.
**_assessmentId** (string): This value must match the [`_id` of the assessment](https://github.com/adaptlearning/adapt-contrib-assessment#attributes) for which results should be displayed. If you only have *one* assessment, you can leave this blank (the article's `_assessment._id` must also be blank).

**\_isVisibleBeforeCompletion** (boolean): Determines whether this component will be visible as the learner enters the assessment article or if it will be displayed only after the learner completes all question components. Acceptable values are `true` or `false`. The default is `false`.

Expand Down
4 changes: 2 additions & 2 deletions properties.schema
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@
"type": "string",
"required": true,
"default": "",
"title": "Assessment Name",
"title": "Linked assessment ID",
"inputType": "Text",
"validators": [],
"help": "This is the unique name of the assessment for which results should be displayed. If you only have one assessment you can leave this blank."
"help": "This is the unique name of the assessment for which results should be displayed. If you only have one assessment, you can leave this blank (the article's assessment ID must also be blank)."
},
"_retry": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/component.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"_assessmentId": {
"type": "string",
"title": "Linked assessment ID",
"description": "This is the unique name of the assessment for which results should be displayed. If you only have one assessment you can leave this blank",
"description": "This is the unique name of the assessment for which results should be displayed. If you only have one assessment, you can leave this blank (the article's assessment ID must also be blank).",
"default": ""
},
"_retry": {
Expand Down