Application Configuration

The UDL Curriculum Toolkit is highly configurable. A sample configuration file is available with the Example Application. The file is found in the root directory. It is called example.config.

Fine Tuning the Configuration File

Setting Directories and Files

The directory and name of both the Hibernate and Logging configuration files must be set.

  • cwm.hibernateConfig = /opt/tomcatInstanceName/example-hibernate.xml
  • cwm.logConfig = /opt/tomcatInstanceName/logback.xml

A CSV file of users can be loaded on initialization of the application. To specify this provide the directory and name of the csv file. The users will get loaded once, when the server is first started. The defaultUserFile.csv is a sample csv file included from the download site http://github.com/cast-org/udl-curriculum-toolkit/releases.

  • cwm.defaultUserFile = /opt/example/defaultUserFile.csv

The skin directory is the directory and name of the UDL Curriculum Toolkit theme files: HTML, CSS, image, JS and application property file. This directory is checked out from the github site: http://github.com/cast-org/udl-curriculum-toolkit. Any customized or modified files would be in the custom skin directory.

  • isi.skinDir = /opt/tomcatInstanceName/theme
  • isi.customSkinDir = /opt/tomcatInstanceName/customTheme

The transformation directory is the location of xsl files used to transform the xml files. This directory is normally the same as the skin directory. If custom transformations are created, they should be placed into a directory and added to the configuration file. If a specific custom file is needed, there are four files that may be modified.

  • isi.transformationDir = /opt/tomcatInstanceName/theme
  • isi.customTransformationDir = /opt/tomcatInstanceName/customTheme
  • isi.xslGlossaryFile = glossary.xsl
  • isi.xslStudentFile = student.xsl
  • isi.xslTocFile = toc.xsl
  • isi.xslEmailFile = email.xsl

The WebDAV server information should be set if content files are stored on a WebDAV server, otherwise, it must be commented out.

  • isi.davServer = servername.yourOrganizationName.org
  • isi.davUser = davUsername
  • isi.davPassword = davPassword

The directory of the content files (XML, image, video, etc.) for either the local or WebDAV server should be set.

  • isi.contentDir = /opt/tomcatInstanceName/content

The UDL Curriculum Toolkit content is stored in XML files. Indicate the files by providing a comma separated list of the file names found in the content directory.

  • isi.studentContentFiles = features.xml, demo.xml

If there is a glossary file, that file should be located in the content directory. Set the name of the glossary file. A sample file is available to download from the github site: http://github.com/cast-org/udl-curriculum-toolkit/releases. If there is no glossary file, then this may be commented out in conjunction with setting isi.glossary.isOn to false.

  • isi.glossaryFile = glossary.xml

Page and Section Levels

The UDL Curriculum Toolkit supports Sections and Pages at two different levels within your authored XML files. The sectionElement may be level2 with the pageElement at level3. Alternatively, if the sectionElement is at level3, the pageElement would be at level4.

  • isi.sectionElement = level3
  • isi.pageElement = level4

Reading Page Navigation Bar

The UDL Curriculum Toolkit has three navigation bars. The default bar contains section/chapter icons with links. The alternate1 nav bar does not contain any section/chapter links. The dropdown nav bar does not have status icons or links.

  • isi.navBarType = alternate1
  • isi.navBarType = dropdown

Feature Configuration

Features may be turned off or on within the UDL Curriculum toolkit.

  • isi.notebook.isOn: Set this value to false to turn the Notebook off. The Notebook button, as well as any links to the notebook, will no longer be visible. Default value is true.
  • isi.whiteboard.isOn: Set this value to false to turn the Whiteboard off. The Whiteboard button, as well as any links to the Whiteboard, will no longer be visible. Default value is true.
  • isi.responseCollection.isOn: Set this value to false to turn off the Collections features. The Collections tab will no longer be visible. Default value is true.
  • isi.classMessage.isOn: Set this value to false to turn off the Class Message feature. The Class Message will no longer be visible on the Home page. Default value is true.
  • isi.pageNotes.isOn: Set this value to false to turn off the Page Notes feature. The My Notes panel on the content page will no longer be visible. Default value is true.
  • isi.myQuestion.isOn: Set this value to false to turn off the My Questions features. The My Questions tab as well as the My Questions side panel on the Contents page will no longer be visible. Default value is true.
  • isi.tag.isOn: Set this value to false to turn off the Tags features. The Tags tab as well as the My Tags panel on both the home page and the content page will no longer be visible. Default value is true.
  • isi.mathML.isOn: Set this value to true to indicate that MathML is present in the authored content. Default value is false. If MathML is on, MathML rendering will be done through MathJax. The location of the MathJax javascript file can also be supplied.

Section Status and Score Summary Configuration

Set up a variety of section status options. The section status is either a completion indicator or an authored icon or neither, depending on the configuration. Each reading section (section is define above in Page and Section Levels) may have a section status.

  • isi.tocSectionCompleteIcons.isOn: Set this value to true to enable section complete icons in the student table of contents. This option is only available if isi.sectionToggleImageLinks.isOn is set to false. Default value is false.
  • isi.tocSectionIncompleteIcons.isOn: Set this value to true to enable section incomplete icons in the student TOC. This option is only available if isi.sectionToggleImageLinks.isOn is set to false. Default value is false.
  • isi.tocSectionToggles.isOn: Set this value to true to enable section complete toggle links in the student TOC. Note: As currently implemented, this will not show the TOC toggles unless isi.sectionToggleImageLinks.isOn is also set to true.
  • isi.sectionToggleTextLinks.isOn: Set this value to true to enable section complete toggle button on the last page of a section. Default value is false.
  • isi.sectionToggleImageLinks.isOn: Set this value to true to enable section complete toggle checkmarks, currently on both TOC as well as the reading (content) page. Default value is true.
  • isi.navbar.sectionIcons.teacher: Set this value to either class or status. This determines the types of icons displayed in the nav bar on the content page. Use status to show the teacher the student section complete indicator or class to show the teacher the authored icons. Default value is status.
  • isi.navbar.sectionIcons.student: Set this value to either class or status. This determines the types of icons displayed in the nav bar on the student content page. Use status to show the section complete indicator or class to show the student the authored icons. Default value is class.

Set up where the score summaries are available.

  • isi.collectionsScoreSummary.isOn: Set this value to true to display a summary of responses on the response collection page. Default value is false.
  • isi.compareScoreSummary.isOn: Set this value to true to display a summary of responses for the teacher when viewing the results on the compare responses page. Default value is false.

Glossary Configuration

There are three types of glossary links available: inline, mini modal popup or directly to the main glossary popup. An inline glossary link will display a highlighted text area with a short definition inline as well as a link to the full Glossary definition page. A mini modal popup glossary link will display a mini modal box with a short definition and a link to the full Glossary definition page. The last option links a glossary word to the full Glossary definition page. The default type of glossary link is mini modal popup (modal). Use one of the following to set the glossary type:

  • isi.glossary.isOn: Set this value to false to turn the Glossary off. The Glossary button, as well as any links to the glossary, will no longer be visible. Default value is true
  • isi.glossary.type: Set this value to either modal, inline or main to determine the type of glossary link to use. Default value is modal.

Highlighter Feature

The UDL Curriculum Toolkit provides a set of highlighters that may be used on the Content pages. The Highlighter panel may be turned on or off as well as individual highlighters may be turned on or off. The name of the highlighter may also be editable. If the highlighter name is not editable, the highlighter name is set in the application properties file.

  • isi.highlightsPanel.isOn: Set this value to false to turn off the Highlights panel. The Highlights panel on the content page will no longer be visible. Default value is true.
  • isi.highlighter.yellow.isOn: Set this value to false to turn off the yellow highlighter. Default value is true.
  • isi.highlighter.yellow.nameEditable: Set the value to true to make the yellow highlighter name editable. Default value is false.
  • isi.highlighter.blue.isOn: Set the value to false to turn off the blue highlighter. Default value is true.
  • isi.highlighter.blue.nameEditable: Set this value to true to make the blue highlighter name editable. Default value is false.
  • isi.highlighter.green.isOn: Set this value to false to turn off the green highlighter. Default value is true.
  • isi.highlighter.green.nameEditable: Set this value to false to make the green highlighter name not editable. Default value is true.

Response Areas and Types Configuration

The UDL Curriculum Toolkit supports text, audio, image, file, and table Responses. These five types are the default Response Types. To limit the type of response areas set the isi.defaultResponse.type to the desired types.

  • isi.defaultResponse.type = text, image, audio, file, table # this is the default
  • isi.defaultResponse.type = text, audio, image # this is an example of only 3 valid response types

There are two different categories of Response Areas in the UDL Curriculum Toolkit. They are authored Response Areas and non-authored Response Areas. Authored Response areas are found only within the Content and Glossary pages. Non-authored Response areas are found on all other non-content or glossary pages such as in the General Notebook, User Defined words, My Questions or Teacher Notes. The following option will enable authors to individually determine what Response Type is available for each Response Area:

  • isi.useAuthoredResponseType.isOn: Set this value to true if you want the author to specify the type of responses in the XML. Default is false.

Responses Areas contain the list of responses that can be sorted. The default is for the responses to be sorted by the create date, with the most recently added response at the top. You can modify the sort field and sort order with the following options.

  • isi.response.sortField: Set this value to lastUpdated to sort the responses by the date the response was last updated. Default value is createDate.
  • isi.response.sort: Set this value to ascending to sort the responses by least recent first. Default value is descending.

Text to Speech or Dictionary Toolbar

The UDL Curriculum Toolkit supports either a Text to Speech or Dictionary toolbar. By default, the application is set up to be on and to use the free dictionary WordNik. A free license is available here: http://developer.wordnik.com/. The toolbar can be turned on or off. Make sure that if the toolbar is turned on, that the WordNik api key is also entered.

  • isi.toolBar.isOn = true # this is the default
  • isi.wordnikApiKey = [your key here]

Setting Default Tags

The UDL Curriculum Toolkit provides a mechanism for supporting baseline tagging. These default tags need to be added before users have started tagging. The tags will then be available for all users. These tags are in addition to the tags the users create. Set the following for default tags:

  • isi.defaultTags = defaultTag1, defaultTag2

Self Service Login

UDL Curriculum Toolkit can be setup so that users can create their own logins. First, email must be turned on for the application using isi.email.isOn. The email server and delivering email address should also be setup. The app.url is used only for purpose of creating links sent out via email. UDL Curriculum Toolkit has the notion of classes or periods. When users are signing themselves up, there must be a default class or period (isi.defaultPeriod) that is previously setup through the administrative tool and specified in the configuration file.

  • isi.email.isOn = false
  • isi.selfRegister.isOn = false
  • cwm.mailHost = smtp.example.org
  • cwm.mailFromAddress = admin@example.org
  • app.url = http://localhost:8080/example
  • isi.defaultPeriod = test