This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.

Internationalization

Labels and text rendered by the Assess API user interface can be changed or translated to other languages.

Instructions

When calling LearnosityAssess.init() an internationalization bundle of key value pairs can be supplied as labelBundle.

Data

The list of labels can be loaded as raw JSON here: Assess API label bundles.

Further reading

See Translating the Learnosity user interface with label bundles for more information.

Note: support has been added for i18n (internationalization) labels that were previously hard-coded, since version: v2021.1.LTS.

Label listing

Below, see the list of labels that can be changed through the labelBundle object.

object

Object of labels and values can be passed to override default English labeling

Note The previousButtonLabel setting only interact with the button hover state.

Important In Items API these options are only supported with rendering_type: "assess".

Properties
actionsave
string
Default: save
actionsubmit
string
Default: submit
acknowledgement
string
Default: Acknowledgements
allQuestionsAttempted
string
Default: All questions have been attempted
apply
string
Default: Apply
assessmentSettingsMenu
string
Default: Assessment settings menu
assessmentStarted
string
Default: Assessment started:
assessmentTime
string
Default: Assessment time
assessmentTimeExpired
string
Default: Your assessment time has expired and you are now required to submit.
timeExpired
string
Default: Time expired
sectionTimeExpired
string
Default: Your time has expired and you are required to progress to the next section.
assessmentTools
string
Default: Assessment Tools
assetUploadError
string
Default: Error uploading response
assetUploadRetry
string
Default: Try again
assetUploadErrorDetail
string
Default: One or more of your responses could not be uploaded.
assetUploadErrorRetryDetail
string
Default: Please check your network connection and try again.
assetUploadErrorDeclineDetail
string
Default: If you choose to cancel, the unuploaded responses will be lost and marked as unattempted.
moduleLoadErrorKnown
string
Default: Network Issues
moduleLoadErrorUnknown
string
Default: Technical Problem
moduleLoadErrorDetail
string
Default: We have lost our connection to you!
moduleLoadErrorInstructions
string
Default: Try checking your internet settings and reloading the page.
moduleLoadErrorReloadAction
string
Default: Reload Page
confirm
string
Default: OK
continue
string
Default: Continue
close
string
Default: Close
decline
string
Default: Cancel
elapsedTime
string
Default: Elapsed time
allowedTime
string
Default: Allowed time
countDownRemainingTime
string
Default: Remaining time is
timeNearlyExpired
string
Default: Your assessment time has nearly expired.
readingTime
string
Default: Reading time
remainingReadingTime
string
Default: Reading time {{readingTime}}
remainingReadingTimeWarning
string
Default: Reading time {{readingTime}} remaining!
error
string
Default: Error
errorUnknown
string
Default: Unknown error
toggleFullScreen
string
Default: Full screen
fullScreen
string
Default: Full Screen
exitFullScreen
string
Default: Exit Full Screen
calculator
string
Default: Calculator
lineReader
string
Default: Line Reader
notepad
string
Default: Notepad
stickynote
string
Default: Sticky Notes
addStickyNote
string
Default: Add sticky note
hideStickyNotes
string
Default: Hide sticky notes
showStickyNotes
string
Default: Show sticky notes
toggleStickyNotesVisibility
string
Default: Toggle sticky notes visibility
drawingMode
string
Default: Drawing mode
toggleDrawingMode
string
Default: Toggle drawing mode
toggleDrawingVisibility
string
Default: Toggle drawing visibility
hideDrawings
string
Default: Hide drawings
showDrawings
string
Default: Show drawings
accessibility
string
Default: Accessibility
answerMasking
string
Default: Response Masking
toggleResponseMasking
string
Default: Toggle response masking
configuration
string
Default: Administration controls
goBack
string
Default: Go back
yes
string
Default: Yes
no
string
Default: No
introItemMessage
string
Default: Please click <b>Start</b> when you are ready to begin the activity.
invalidQuestionsMessage
string
Default: The following questions are not currently valid. Please follow the links to review
testIsNotYetAvailable
string
Default: This test is not yet available
availableTestDateTime
string
Default: You can begin this test on {{testDateTime}}
testStarted
string
Default: Your test started on {{testDateTime}}
reachedLastItem
string
Default: You reached the last item of this activity. The activity will now be submitted.
idleSaveSuccess
string
Default: Your session was terminated after a period of inactivity and your activity has been saved.
idleSaveError
string
Default: An error occurred while saving your activity.
idleWarningMsg
string
Default: Your session is about to time-out. Click "Yes, let me continue!" to go back and continue your activity, or we will save your current progress and exit the activity.
idleHeadingMsg
string
Default: Are you still there?
idleCancelButton
string
Default: Yes, let me continue!
idleQuitButton
string
Default: Quit
warningOnChangeHeadingMsg
string
Default: More answers required
warningOnChangeBodyMsg
string
Default: One or more questions do not meet the required number of answers.<br/>Cancel to answer more or continue anyway.
warningOnChangeNoContinueMsg
string
Default: One or more questions do not meet the required number of answers.
warningOnChangeCancelButton
string
Default: Cancel
warningOnChangeContinueButton
string
Default: Continue
warningOnSectionChangeHeadingMsg
string
Default: Section changing
warningOnSectionChangeBodyMsg
string
Default: You are about to move to a new section and will not be able to go back. Do you wish to navigate away from this section anyway?
warningOnSectionChangeCancelButton
string
Default: Cancel
warningOnSectionChangeContinueButton
string
Default: Continue
fetchingErrorHeadingMsg
string
Default: Error loading items
fetchingErrorBodyMsg
string
Default: An error occurred while loading your next items.
question
string
Default: Question
feature
string
Default: Feature
loading
string
Default: Loading
nextButtonLabel
string
Default: Next
skipToNavigation
string
Default: Skip to navigation
ruler
string
Default: Ruler
protractor
string
Default: Protractor
imagetool
string
Default: Image Tool
menuRegionToggle
string
Default: Menu
menuRegionClose
string
Default: Close menu
pause
string
Default: Pause
resume
string
Default: Resume
play
string
Default: Play
previousButtonLabel
string
Default: Previous
quit
string
Default: Exit
retry
string
Default: Retry
saveButtonLabel
string
Default: Save/Exit
save
string
Default: Save
saveInProgress
string
Default: Saving...
saveWarningMsg
string
Default: Your activity has been paused and saved by your administrator and will exit in
saveError
string
Default: Save failed.
saving
string
Default: saving
saved
string
Default: saved
item
string
Default: Item
scrollingIndicatorLabel
string
Default: More
page
string
Default: Page
startTest
string
Default: Start
submitWarningMsg
string
Default: Your activity has been submitted by your administrator and will exit in
submitFailed
string
Default: Your activity could not be saved. Please check your network connection and try again.
submitFailedWithOnlyAccessRawDataOption
string
Default: If the problem continues, select all of the text in the area below, copy it, and provide it to your administrator. This text contains the full data of your activity and responses.
submitFailedWithOtherOptions
string
Default: If the problem continues, use one of the following options to access the full data of your activity and responses.
actionDownloadAsFile
string
Default: Download as file
actionSendEmail
string
Default: Send as email
actionAccessRawData
string
Default: View encoded string
actionAccessRawDataDescription
string
Default: Select all of the text in the area below, copy it, and provide it to your administrator.
submit
string
Default: Submit
submitButtonLabel
string
Default: Finish
submitCriteriaNotMet
string
Default: The following criteria for submission has not been met
submitInProgress
string
Default: Submitting...
submitting
string
Default: submitting
submitComplete
string
Default: Submitted
successfullySubmitted
string
Default: successfully submitted
test
string
Default: activity
submitTest
string
Default: Submit activity
testPaused
string
Default: Activity paused
testPausedProctor
string
Default: Your activity has been paused by your administrator.
timeoutMsg
string
Default: Please try again or contact your administrator.
tryAgain
string
Default: Try again
tryAgainButton
string
Default: Try current item again
unavailable
string
Default: Unavailable
flagItem
string
Default: Flag item
unflagItem
string
Default: Unflag item
errorOccurredWhile
string
Default: An error occurred while
contactAdministrator
string
Default: Please contact your administrator.
itemTryAgain
string
Default: Try again
resources
string
Default: Resources
resourceMenu
resourceMenu
Default: {}
skipToResources
string
Default: Skip to resources
regionHeaderTopLeft
string
Default: Assessment title
regionHeaderTopRight
string
Default: Assessment timer and count
regionHeaderRight
string
Default: Assessment menu bar
regionHeaderBottomRight
string
Default: Assessment navigation
regionHeaderBottomLeft
string
Default:
regionHeaderBottom
string
Default: Assessment navigation
regionHeaderItems
string
Default: Assessment items
regionHeaderMenu
string
Default: Assessment menu
regionHeaderTools
string
Default: Assessment tools
regionHeaderToc
string
Default: Assessment table of contents
questionHeader
string
Default: Question
singleQuestionHeader
string
Default: Question
tocElementHelp
string
Default: Table of Contents. Navigate between items using your Left and Right arrow keys.
itemNestedHelp
string
Default: This item is nested within page
questionsApiLabelBundle
object
The Label Bundle to be passed into Questions API.

See Questions API Label Bundle for more information.

administrationPanel
string
Default: Administration controls
saveQuit
string
Default: Save &amp; exit
submitQuit
string
Default: Submit &amp; exit
exitDiscard
string
Default: Discard &amp; exit
discardInProgress
string
Default: Exiting...
discardError
string
Default: Exit &amp; Discard failed.
discardWarningMsg
string
Default: Your activity has been discarded by your administrator and will exit in
hour
string
Default: hour(s)
minute
string
Default: minute(s)
seconds
string
Default: seconds
saveQuitConfirmationMsg
string
Default: Are you sure you want to save &amp; exit this session?
submitQuitConfirmationMsg
string
Default: Are you sure you want to submit &amp; exit this session?
exitDiscardConfirmationMsg
string
Default: Are you sure you want to discard this session?
lockMsg
string
Default: You have exceeded the limit on password attempts. Lockout time is
password
string
Default: Password
wrongPasswordMsg
string
Default: Incorrect password. Please try again.
proctorModalTitle
string
Default: Remote control activated
accessibilityPanel
string
Default: Accessibility options
openAccessibilityMenu
string
Default: Open Accessibility Menu
colorScheme
string
Default: Color scheme
fontSize
string
Default: Font size
zoom
string
Default: Zoom
paletteInstructions
string
Default: Change the background and foreground colors of your activity.
blackOnWhite
string
Default: Black on white (default)
purpleOnGreen
string
Default: Purple on light green
yellowOnBlue
string
Default: Yellow on navy
blackOnRose
string
Default: Black on violet
greyOnGrey
string
Default: Grey on light grey
whiteOnBlack
string
Default: White on black
customColorPalette
string
Default: Custom scheme
fontSizeInstructions
string
Default: Adjust the size of fonts in your activity.
small
string
Default: Small
normal
string
Default: Normal
large
string
Default: Large
xlarge
string
Default: Extra large
xxlarge
string
Default: Huge
zoomInstructions
string
Default: Zoom in and out using the following keyboard shortcuts:
command
string
Default: Command
control
string
Default: Ctrl
zoomIn
string
Default: Zoom in
zoomOut
string
Default: Zoom out
returnZoom
string
Default: Reset zoom
toZoomIn
string
Default: To zoom in, press
toZoomOut
string
Default: To zoom out, press
toReturnZoom
string
Default: Reset the zoom level by pressing
plus
string
Default: +
minus
string
Default: -
period
string
Default: .
zero
string
Default: 0
zoomInResult
string
Default: The browser will zoom in incrementally each time you press plus (+) key.
zoomOutResult
string
Default: The browser will zoom out incrementally each time you press the minus (-) key.
returnZoomResult
string
Default: The browser will return to its default zoom level.
collapseMenu
string
Default: Collapse menu
collapseAriaLabelSuffix
string
Default: Hides the button labels
expandMenu
string
Default: Expand menu
expandAriaLabelSuffix
string
Default: Displays the button labels
toggleMenu
string
Default: Toggle menu
toolEnabledAriaLabel
string
Default: you have a tool enabled
itemCountOf
string
Default: of
reviewScreen
string
Default: Review
reviewScreenButton
string
Default: Review screen
reviewScreenFilters
string
Default: Filters
reviewScreenFiltersAriaLabelSuffix
string
Default: with filters applied.
fullyAttempted
string
Default: Fully Attempted
partiallyAttempted
string
Default: Partially Attempted
notAttempted
string
Default: Unattempted
viewed
string
Default: Viewed
flagged
string
Default: Flagged
filterResults
string
Default: Filter results
reviewFlaggedFilter
string
Default: Filter results for flagged items
reviewNotAttemptedFilter
string
Default: Filter results for unattempted items
reviewPartiallyAttemptedFilter
string
Default: Filter results for partially attempted items
timerHour
string
Default: Hour
timerHours
string
Default: Hours
timerMinute
string
Default: Minute
timerMinutes
string
Default: Minutes
timerSecond
string
Default: Second
timerSeconds
string
Default: Seconds
timerSeparator
string
Default: out of
submittingInProgress
string
Default: Submitting in progress
savingInProgress
string
Default: Saving in progress
saveTestSuccessfully
string
Default: Your {{test}} has been saved.
saveTestSuccessfullyPrompt
string
Default: Do you want to resume your {{test}}, or exit?
submitCriteriaLessThanRequiredAttemptedQuestionsWarning
string
Default: You are required to attempt {{threshold}}% of the questions. Please attempt at least {{numberOfMoreQuestionsNeeded}} more questions.
submitCriteriaRequiredEnoughCorrectQuestionsWarning
string
Default: You are required to answer {{threshold}}% of the questions correctly. Please answer at least {{numberOfMoreQuestionsNeeded}} more questions correctly.
submitActionConfirmation
string
Default: Are you sure you want to {{action}} the {{test}}?
submitWithUnattemptedQuestion
string
Default: {{unattemptedResponsesCount}} question is unattempted.
submitWithUnattemptedQuestions
string
Default: {{unattemptedResponsesCount}} questions are unattempted.
submitFailedDownloadAsFile
string
Default: (to backup locally or attach to an email)
submitFailedSendEmail
string
Default: (requires a mail client set up on this device)
isAllResponsesAttempted
string
Default: {{allQuestionsAttempted}}. Do you want to {{action}} the {{test}} now?
copyToClipboard
string
Default: Copy data
saveErrorTitle
string
Default: Error saving activity
existingResponsesTitle
string
Default: Existing Responses Found
existingResponsesMessage
string
Default: It appears that this test has been attempted already. You may have gotten here by using your browser's back button.
existingResponsesDetail
string
Default: If so please click on the forward button of your browser to return to the previous page
authenticationErrorTitle
string
Default: Authentication Error
authenticationErrorMessage
string
Default: This error often results from a bad network connection. Please try the following: Check your internet connection and make sure it's stable; Use a different browser; Open the Assessment in an incognito tab.
authenticationErrorDetail
string
Default: If the problem persists please contact your administrator.
authorizationErrorTitle
string
Default: Authorization Error
authorizationErrorMessage
string
Default: User ID mismatch error.
authorizationErrorDetail
string
Default: Please contact your administrator.
responseTitleFor10017
string
Default: 10017
responseMessageFor10017
string
Default: Failed loading Questions API, can't load required modules. Ensure you have a reliable internet connection, and then refresh your browser to fix the issue. If the issue persists, contact your system administrator.
responseDetailFor10017
string
Default:
annotationsApiLabelBundle
object
The Label Bundle to be passed into Annotations API.

See Annotations API Label Bundle for more information.

aria
aria
Default: {}
object
Properties
close
string
Default: Close the resource window
collapse
string
Default: Collapse the resource window
expand
string
Default: Expand the resource window
keyboardInstructionsButton
string
Default: Keyboard Instructions
keyboardInstructionsButtonAriaLabel
string
Default: Keyboard Instructions, press enter or space to display instructions on how to use the resource window.
keyboardInstructions
string
Default: Use the Skip-To-Question link or F6 to return to the question. Use the Skip-To-Resources link or F6 on the question to return to the resource. Use the Minimize button to collapse the Resources window. Use the Full View button to display the Resources in the full assessment area. When the Resize button is focused, use the arrow keys to adjust the window size. When the Close button is focused use the arrow keys to move the Resources window.
maximize
string
Default: Expand the resource window to full view
minimize
string
Default: Return the resource window to default view
resize
string
Default: Resize resource window. Select to resize resource window
resizeButtonActive
string
Default: Resize resource window. Use arrow keys to resize window, Enter key to drop, Escape key to cancel.
resizeButtonDropped
string
Default: Resource window resized
skipTo
string
Default: Skip to questions
title
string
Default: Resources
dragButton
string
Default: Move resource window. Select to move resource window around screen
dragButtonActive
string
Default: Resource window grabbed. Use arrow keys to move around the screen, Enter key to drop, Escape key to cancel.
dragButtonDropped
string
Default: Resource window dropped
object
Properties
item
string
Default: Item