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.

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

Update: Bringing base JSON files up-to-date (fixes: #3515) #3516

Merged
merged 8 commits into from
Feb 12, 2024

Conversation

joe-replin
Copy link
Contributor

@joe-replin joe-replin commented Feb 2, 2024

Update

With the add needed approach to updating the base JSON files, many of the base JSON fields have fallen out of sync with respective plug-in features. Adding them in would help raise awareness of what project teams can achieve out-of-the-box without having to figure out to reference example.json files or go to GitHub to read documentation. In fact, for others to know these features exist would encourage them to study up on them more.

  • fixes: Course folder JSON files #3515
  • Element IDs renumbered for easier development starting on new projects.
  • Enabled "_scrollingContainer" - per @oliverfoster, "It means that the focused element in the content body will never be under the navigation bar. The content body will be in a scrollable region under the navigation bar rather than overlayed by it."

Added many fields to various plugins (may not have captured everything):

  • Spoor - _shouldCompress
  • pageLevelProgress - _showAtCourseLevel
  • Resources - _drawerOrder, displayTitle, body, instruction, filename, _forceDownload
  • Bookmarking - _showPrompt
  • Graphic - longdescription, large, small, _url, _target, _isScrollable, _defaultScrollPercent
  • Narrative - _isTextBelowImage, _isMobileTextBelowImage, _isStackedOnMobile, attribution
  • Hot Graphic - _isRound, attribution, _tooltip, classes, _imageAlignment
  • Media - _pauseWhenOffScreen, _playsinline, _preventForwardScrubbing, _startLanguage, _showVolumeControl, _startVolume, _aspectRatio, _offsetMediaControls, _setCompletionOnView, features
  • Accordion - _shouldCollapseItems, _shouldExpandFirstItem, _setCompletionOn _imageAlignment
  • MCQ - _hasItemScoring, _canShowFeedback, _canShowMarking, _recordInteraction, _isPartlyCorrect, all feedback options
  • GMCQ - _hasItemScoring, _canShowFeedback, _canShowMarking, _recordInteraction, _isPartlyCorrect, _columns, _isRound, altText, _isPartlyCorrect, attribution, all feedback options
  • Text Input - _canShowFeedback, _canShowMarking, _recordInteraction, all feedback options
  • Matching - _shouldResetAllAnswers, _isRandomQuestionOrder, hasItemScoring, _canShowFeedback, _canShowMarking, _recordInteraction, _allowOnlyUniqueAnswers, all feedback options
  • Slider - ariaScaleName, _canShowFeedback, _canShowMarking, _recordInteraction, labelStart, labelEnd, scaleStepPrefix, scaleStepSuffix, _correctAnswer, all feedback options
  • assessmentResults - _resetType, feedbackNotFinal

Testing

  1. Install a fresh framework locally
  2. Replace local JSON files with these

@joe-replin joe-replin self-assigned this Feb 2, 2024
@joe-replin joe-replin linked an issue Feb 2, 2024 that may be closed by this pull request
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

@swashbuck swashbuck changed the title Update: Bringing base JSON files up-to-date (fixes: 3515) Update: Bringing base JSON files up-to-date (fixes: #3515) Feb 5, 2024
Copy link
Contributor

@joe-allen-89 joe-allen-89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@oliverfoster oliverfoster merged commit 16ef81b into master Feb 12, 2024
2 checks passed
@oliverfoster oliverfoster deleted the issue/3515 branch February 12, 2024 16:12
github-actions bot pushed a commit that referenced this pull request Feb 12, 2024
# [5.36.0](v5.35.7...v5.36.0) (2024-02-12)

### Update

* Bringing base JSON files up-to-date (fixes: #3515) (#3516) ([16ef81b](16ef81b)), closes [#3515](#3515) [#3516](#3516)
Copy link

🎉 This PR is included in version 5.36.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Course folder JSON files
5 participants