pageLevelProgress wiki

#adapt-contrib-pageLevelProgress

❗ Do not edit here. Edit the wiki in the repo. ❗

Page Level Progress is a extension bundled with the Adapt framework.

Secondary description.

Back to Top

Link to Usage and Tips

##Installation

As one of Adapt's core extensions, Page Level Progress is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Page Level Progress has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
  adapt install adapt-contrib-pageLevelProgress

• If Page Level Progress has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Back to Top

##Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Page Level Progress source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Page Level Progress's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Is Enabled (_isEnabled): Turns on and off Page Level Progress. Acceptable values are true and false. This true/false switch is available in course configuration, pages/sections, and components.

Is Optional (_isOptional): This true/false switch is available on individual menus, pages, articles, blocks, and components. If set on an element that has "child" elements (e.g., blocks that contain components), all the "children" will inherit the setting from their parent element. Is Optional is a property that is utilized by several extensions. To Page Level Progress it signifies that the course element does not need to be included when calculating the percent of components that have been completed. Because this property is read by other extensions, the choices made for Page Level Progress will affect Spoor. [Provide an example of how these interact.]

Back to Top

Usage

• Brian in conversation with Helen says that progress bars on menus is unaffected by components that have disabled PLP.

##Limitations

No known limitations.

Back to Top

##Browser spec

This component has been tested to the standard Adapt browser specification.

Back to Top