Skip to content

Configure your project with config.json

Jump to bottom
Matt Leathes edited this page May 23, 2017 · 8 revisions

config.json

config.json is located at /src/course/config.json. This required file is included with the installation of the Adapt framework and the Adapt authoring tool.

Note: What's the difference between config.json and course.json?

  • config.json contains settings that determine how your Adapt project functions. Whereas course.json is focused on content that is used throughout your course, oftentimes being reused by various components and other plug-ins.
  • config.json resides outside of the language folder and course.json resides inside (e.g., /src/course/en). Settings that are language dependent go in course.json.

Settings Overview

The properties listed below and their values are used to configure an Adapt project. Reference config.json on GitHub to see them properly formatted as JSON. Configuration Settings provides information about how they appear in the authoring tool.

Attributes

_defaultLanguage (string): This value represents the primary language in which course content will appear. A subfolder of /course is created using this value (e.g., /course/en). Its value is assigned to the "lang" attribute of the HTML tag (e.g., <html lang='en'>). It is recommended to choose values from the IANA language tag registry.

_defaultDirection (string): This value is used to set the base direction of text for display. Adapt's default direction is left-to-right (ltr). To enable HTML for such right-to-left scripts as Arabic and Hebrew, use the value rtl. This will add the 'dir-rtl' class to the html tag. (No similar class is added for ltr.)

screenSize (object): The screen size group allows pixel widths to be assigned to three device widths: small, medium, and large. Values assigned must be numbers only; include no measurement unit. Note: The screen sizes set the Adapt.device.width that is used within the application code. They are not referenced by the CSS theme for media queries. Set screen sizes for CSS media queries in theme.json located in the theme folder.

_questionWeight (number): This value is used by Question components when using the function setScore(). This value functions as a global default for all Question components; but individual components may override it by including the same attribute in its JSON model. Reference the Matching component's example.json as an example.

_accessibility (object): Adapt's built-in accessibility feature provides tab-highlighting, enables aria-labels that are otherwise hidden, and processes content text to ensure screen readers can access it. The accessibility attributes group contains values for _isEnabled, _isEnabledOnTouchDevices, _shouldSupportLegacyBrowsers, and _isTextProcessorEnabled.

_isEnabled (boolean): Specify a value of true or false to enable or to disable the accessibility feature.

_isEnabledOnTouchDevices (boolean): If set to true, accessibility features will be enabled on 'touch' devices. Accessibility is disabled by default on such devices so that it can be switched on only when required; if left on by default (as it was in Adapt v2.0.19 and earlier) it can cause unexpected issues for courses that have no need for accessibility.

_shouldSupportLegacyBrowsers (boolean): If set to true, Adapt will supply the 'focused' class to accommodate some legacy browser's inability to recognize :focus. The 'focused' class is used to outline elements when tab-highlighting is enabled.

_isTextProcessorEnabled (boolean): If set to true, content text is processed by the a11y_text function of jquery.a11y.js. The primary goal is to ensure the text or HTML is accessible by tabbing.

_isSkipNavigationEnabled (boolean): If set to 'true' a 'Skip Navigation' link will appear allowing users to jump past the navigation and straight into the content, useful for screen reader users who don't want to have to keep tabbing through all the navigation bar items.

_drawer (object): Adapt's Drawer provides a slide out panel that is often used to display indicators of page level progress and links to ancillary course resources. The Drawer uses the velocity.js engine for its animations. The Drawer attributes group contains values for _showEasing, _hideEasing, and _duration.

_showEasing (string): This value controls the variations in speed and bounce as the Drawer opens. It must be a value acceptable to Velocity. Most of jQueryUI's easings are built into Velocity.

_hideEasing (string): This value controls the variations in speed and bounce as the Drawer closes. It must be a value acceptable to Velocity. Most of jQueryUI's easings are built into Velocity.

_duration (number): Specifies the number of milliseconds it will take for the Drawer to open or close.

_spoor (object): Adapt's Spoor extension provides course tracking functionality. Its attributes are detailed in its README.

_disableAnimationFor (string array): A comma separated list of jQuery selectors that could match on the HTML tag. A match allows core modules and other plug-ins to employ alternative styles for those browsers that do not support common animation techniques. Typical strings include ".ie8" (index.html), and ".iPhone.version-7\\.0" (src/core/js/device.js).

_forceRouteLocking (boolean): If menu locking is being used in the course, this setting prevents the user from bypassing the locking by doing things like specifying the route in the address bar or via the browser console.

build (object): By default, Adapt includes all installed plug-ins in its build process. (The result of the build is found at build/adapt/.) Sometimes the developer may install plug-ins that are only used during development or that are not yet being used by the content. This bloats the build needlessly. The build object allows the developer to specify explicitly which plug-ins will be included in the build or excluded from the build. The build attributes group is optional. It contains values for one of two arrays: excludes or includes.

excludes (string array): All plug-ins will be included in the build except those whose names appear in this comma separated list.

includes (string array): Only the plug-ins whose names appear in this comma separated list will be included in the build.

Example:

"build": {
    "excludes": [
        "adapt-inspector",
        "adapt-contrib-assessmentResultsTotal"
    ]
}

adapt logo

Getting Started

Course Authoring

Framework Development

Plugin Development

Resources

Clone this wiki locally