adapt-authoring-ui 1.5.4 → 1.5.6

package/adapt-authoring.json

@@ -3,9 +3,7 @@
     "enable": true,
     "manualPlugins": ["docs/plugins/uidocs.js"],
     "manualPages": {
-      "migrating-from-legacy.md": "ui",
-      "ui-extensions.md": "ui",
-      "ui-libraries.md": "ui"
+      "ui.md": "development"
     }
   }
 }

package/app/modules/editor/contentObject/views/editorMenuItemView.js

@@ -85,10 +85,10 @@ define(function(require){
 
       /**
        * Lang string keys used (for at-langcheck):
-       * - app.confirmdeletemenu
-       * - app.confirmdeletepage
-       * - app.deleteitemmenu
-       * - app.deleteitempage
+       * - 'app.confirmdeletemenu'
+       * - 'app.confirmdeletepage'
+       * - 'app.deleteitemmenu'
+       * - 'app.deleteitempage'
        */
       Origin.Notify.confirm({
         type: 'warning',

package/app/modules/frameworkImport/templates/frameworkImportSummary.hbs

@@ -10,20 +10,20 @@
     <p>Find below a summary of the course being imported.</p>
     <div class="statusReport">
       {{! Lang string keys used (for at-langcheck):
-        - app.import.status.ASSETS_IMPORTED_SUCCESSFULLY
-        - app.import.status.CONTENT_IMPORTED
-        - app.import.status.INSTALL_PLUGIN
-        - app.import.status.INSTALLED
-        - app.import.status.INVALID
-        - app.import.status.INVALID_PLUGIN_VERSION
-        - app.import.status.MANAGED_PLUGIN_UPDATE_DISABLED
-        - app.import.status.MIGRATE_CONTENT
-        - app.import.status.PLUGIN_INSTALL_MIGRATING
-        - app.import.status.NO_CHANGE
-        - app.import.status.OLDER
-        - app.import.status.TAGS_IMPORTED
-        - app.import.status.UPDATE_BLOCKED
-        - app.import.status.UPDATED
+        - 'app.import.status.ASSETS_IMPORTED_SUCCESSFULLY'
+        - 'app.import.status.CONTENT_IMPORTED'
+        - 'app.import.status.INSTALL_PLUGIN'
+        - 'app.import.status.INSTALLED'
+        - 'app.import.status.INVALID'
+        - 'app.import.status.INVALID_PLUGIN_VERSION'
+        - 'app.import.status.MANAGED_PLUGIN_UPDATE_DISABLED'
+        - 'app.import.status.MIGRATE_CONTENT'
+        - 'app.import.status.PLUGIN_INSTALL_MIGRATING'
+        - 'app.import.status.NO_CHANGE'
+        - 'app.import.status.OLDER'
+        - 'app.import.status.TAGS_IMPORTED'
+        - 'app.import.status.UPDATE_BLOCKED'
+        - 'app.import.status.UPDATED'
       }}
       {{> part_frameworkImportStatusMessages type='error' messages=statusReport.error heading='Errors'}}
       {{> part_frameworkImportStatusMessages type='warn' messages=statusReport.warn heading='Warnings'}}
@@ -54,3 +54,4 @@
       </table>
     </div>
 </div>
+

package/docs/ui.md

@@ -0,0 +1,38 @@
+# Working with the UI
+
+## Extending the UI
+
+The UI can be extended easily from an Adapt authoring tool module.
+
+### Register your plugin
+Register your UI plugin by calling the [UIModule#addUiPlugin](https://tomtaylor.codes/ls/jsdoc3/UIModule.html#addUiPlugin) function from your own module's [init](https://tomtaylor.codes/ls/jsdoc3/AbstractModule.html#init) function, which ensures that your plugin code is included in the build of the front-end app.
+
+Any files found in this folder will be included in the app build process, so make sure you include all front-end code, Handlebars templates and LESS/CSS in here.
+
+### Define language strings
+Add any translated language strings to the `/lang` folder in the root of your module
+
+### Resources
+
+- **GitHub template**: You can use the following GitHub template repository as a starting point: 
+[adapt-security/adapt-authoring-uiplugintemplate](https://github.com/adapt-security/adapt-authoring-uiplugintemplate)
+
+## Migrating from legacy
+
+> During development, set `adapt-authoring-ui.isProduction` to `false` in your config file for easier debugging (all .js files are served directly, rather using than the minified adapt.js file)
+
+### Changes
+
+#### Permissions
+
+The permissions mechanism has been completely rewritten to use permissions 'scopes' which are human-readable strings. Permissions utilities are now accessed directly from the SessionModel.
+
+- `Origin.permissions.hasPermission` => `Origin.sessionModel.hasScopes`
+- `hasPermission` => `ifHasScopes`
+
+#### APIs
+
+##### TODO
+
+#### Language strings
+Language strings are now served directly from the back-end server, and therefore need to be stored in the root `lang` folder of your authoring tool module. The server will need to be restarted for any changes to these to be recognised.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-ui",
-  "version": "1.5.4",
+  "version": "1.5.6",
   "description": "Front-end application for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-ui",
   "license": "GPL-3.0",

package/docs/migrating-from-legacy.md

@@ -1,19 +0,0 @@
-# Migrating from legacy
-
-> During development, set `adapt-authoring-ui.isProduction` to `false` in your config file for easier debugging (all .js files are served directly, rather using than the minified adapt.js file)
-
-## Changes
-
-### Permissions
-
-The permissions mechanism has been completely rewritten to use permissions 'scopes' which are human-readable strings. Permissions utilities are now accessed directly from the SessionModel.
-
-- `Origin.permissions.hasPermission` => `Origin.sessionModel.hasScopes`
-- `hasPermission` => `ifHasScopes`
-
-### APIs
-
-#### TODO
-
-### Language strings
-Language strings are now served directly from the back-end server, and therefore need to be stored in the root `lang` folder of your authoring tool module. The server will need to be restarted for any changes to these to be recognised.

package/docs/ui-extensions.md

@@ -1,15 +0,0 @@
-# Extending the UI
-The UI can be extended easily from an Adapt authoring tool module.
-
-## Register your plugin
-Register your UI plugin by calling the [UIModule#addUiPlugin](https://tomtaylor.codes/ls/jsdoc3/UIModule.html#addUiPlugin) function from your own module's [init](https://tomtaylor.codes/ls/jsdoc3/AbstractModule.html#init) function, which ensures that your plugin code is included in the build of the front-end app.
-
-Any files found in this folder will be included in the app build process, so make sure you include all front-end code, Handlebars templates and LESS/CSS in here.
-
-## Define language strings
-Add any translated language strings to the `/lang` folder in the root of your module
-
-## Resources
-
-- **GitHub template**: You can use the following GitHub template repository as a starting point: 
-[adapt-security/adapt-authoring-uiplugintemplate](https://github.com/adapt-security/adapt-authoring-uiplugintemplate)