Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-16600

Improve layout/organization of tools in site-info

    XMLWordPrintable

    Details

    • Type: Feature Request
    • Status: Verified
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 10.0
    • Component/s: Site Info
    • Labels:
    • Property addition/change required:
      Yes
    • Test Plan:
      Hide

      1. Verify no regressions with default toolOrder.xml
      a) can add (single instance) tools, when creating new site
      b) can add (multiple instance) tools, when creating new site
      c) can add blti tools, when creating new site
      d) can add/delete (single instance) tools, when editing existing site
      e) can add/delete (multiple instance) tools, when editing existing site
      f) can add/delete blti tools, when editing existing site
      g) Home page is selected by default in sites
      h) Home page can be removed
      i) Site Info page is selected by default and cannot be unselected
      j) Verify stealthed and tools not categorized for type of site (i.e. added in Admin Sites) persist

      2 Verify new toolOrder.xml (toolGroup) model is parsed correctly
      a) Verify a graceful handling of a toolOrder.xml file with a log message
      b) verify log error when sakai.properties indicates toolGroup but group names not found in localized tool properties file
      c) verify default name used when config.sitemanage.externalToolGroupName not set
      d) Verify correct tools are displayed if no category specified, as well as if it is (e.g. myworkspace, course)
      e) Verify ungrouped tools displayed/not displayed per sakai.property 'config.sitemanage.showUngrouped'
      f) Verify name for ungrouped tool accordion displayed/default displayed per sakai.properties 'config.sitemanage.ungroupedToolGroupName'
      g) Verify stealthed tool does not show up on tool picker
      h) Verify that if a site type (i.e. 'course') is not in the tool's properties (i.e. sakai.siteinfo.tool.xml) list of categories, that tool does not show up on the tool picker displayed when adding/editing a site of that type.
      i) Verify stealthed and tools not categorized for type of site (i.e. added in Admin Sites) persist

      3. Verify new functionality with new toolOrder.xml
      a) verify all groupnames found in tool.properties are displayed
      b) verify all tools under each groupId are displayed in accordion tool
      c) can add/delete (single instance) tools, when creating new site
      d) can add/delete (multiple instance) tools, when creating new site
      e) can add/delete blti tools, when creating new site
      f) can add/delete (single instance) tools, when editing existing site
      g) can add/delete (multiple instance) tools, when editing existing site
      h) can add/delete blti tools, when editing existing site
      i) Home page is selected by default in sites
      j) Home page can be removed
      k) Site Info page is selected by default and cannot be removed
      l) Verify working 'more info' link is displayed if a tool image is available
      m) Verify no 'more info' link is displayed if a tool image is not available
      n) verify when tool is checked it appears in toolList on right of screen
      o) verify when red X clicked on toolList the tool is unchecked from ALL groups in accordion tool
      p) verify clicking red X on toolList for 'tool multiples' displays a confirmation dialog (i.e. 'Lessons' tool)
      q) verify operation of 'select all' on tools accordion
      r) verify 'unselect all' leaves 'required' tools selected
      s) verify if no groupnames are located in tools.properties default 'config.sitemanage.ungroupedToolGroupName. is used and all tools for site type are listed in that dropdown.
      t) verify stealthed tools are not displayed (and appropriate tools for type of site are displayed)
      u) verify that tools not configured for a specific site-type do not appear (e.g. if sakai.news is not configured for project site-types, it should not be displayed (even if listed in toolOrder.xml)

      4. Verify screen navigation
      a) 'back' button on 'Confirming site tool edits' screen keeps all selections
      b) 'continue' button on 'Course Site Tool : if tool multiples are added, navigation proceeds to 'Customize tool instances' screen
      c) 'back' button on 'Customize tool instances' keeps all selections
      d) 'continue' button navigates to 'Confirming site tools edits' screen
      e) On 'Confirming site tools edits' pge, all removed tools appear in black on top list, all added tools appear in red in lower list, all unchnaged tools appear in black in lower list.

      Show
      1. Verify no regressions with default toolOrder.xml a) can add (single instance) tools, when creating new site b) can add (multiple instance) tools, when creating new site c) can add blti tools, when creating new site d) can add/delete (single instance) tools, when editing existing site e) can add/delete (multiple instance) tools, when editing existing site f) can add/delete blti tools, when editing existing site g) Home page is selected by default in sites h) Home page can be removed i) Site Info page is selected by default and cannot be unselected j) Verify stealthed and tools not categorized for type of site (i.e. added in Admin Sites) persist 2 Verify new toolOrder.xml (toolGroup) model is parsed correctly a) Verify a graceful handling of a toolOrder.xml file with a log message b) verify log error when sakai.properties indicates toolGroup but group names not found in localized tool properties file c) verify default name used when config.sitemanage.externalToolGroupName not set d) Verify correct tools are displayed if no category specified, as well as if it is (e.g. myworkspace, course) e) Verify ungrouped tools displayed/not displayed per sakai.property 'config.sitemanage.showUngrouped' f) Verify name for ungrouped tool accordion displayed/default displayed per sakai.properties 'config.sitemanage.ungroupedToolGroupName' g) Verify stealthed tool does not show up on tool picker h) Verify that if a site type (i.e. 'course') is not in the tool's properties (i.e. sakai.siteinfo.tool.xml) list of categories, that tool does not show up on the tool picker displayed when adding/editing a site of that type. i) Verify stealthed and tools not categorized for type of site (i.e. added in Admin Sites) persist 3. Verify new functionality with new toolOrder.xml a) verify all groupnames found in tool.properties are displayed b) verify all tools under each groupId are displayed in accordion tool c) can add/delete (single instance) tools, when creating new site d) can add/delete (multiple instance) tools, when creating new site e) can add/delete blti tools, when creating new site f) can add/delete (single instance) tools, when editing existing site g) can add/delete (multiple instance) tools, when editing existing site h) can add/delete blti tools, when editing existing site i) Home page is selected by default in sites j) Home page can be removed k) Site Info page is selected by default and cannot be removed l) Verify working 'more info' link is displayed if a tool image is available m) Verify no 'more info' link is displayed if a tool image is not available n) verify when tool is checked it appears in toolList on right of screen o) verify when red X clicked on toolList the tool is unchecked from ALL groups in accordion tool p) verify clicking red X on toolList for 'tool multiples' displays a confirmation dialog (i.e. 'Lessons' tool) q) verify operation of 'select all' on tools accordion r) verify 'unselect all' leaves 'required' tools selected s) verify if no groupnames are located in tools.properties default 'config.sitemanage.ungroupedToolGroupName. is used and all tools for site type are listed in that dropdown. t) verify stealthed tools are not displayed (and appropriate tools for type of site are displayed) u) verify that tools not configured for a specific site-type do not appear (e.g. if sakai.news is not configured for project site-types, it should not be displayed (even if listed in toolOrder.xml) 4. Verify screen navigation a) 'back' button on 'Confirming site tool edits' screen keeps all selections b) 'continue' button on 'Course Site Tool : if tool multiples are added, navigation proceeds to 'Customize tool instances' screen c) 'back' button on 'Customize tool instances' keeps all selections d) 'continue' button navigates to 'Confirming site tools edits' screen e) On 'Confirming site tools edits' pge, all removed tools appear in black on top list, all added tools appear in red in lower list, all unchnaged tools appear in black in lower list.

      Description

      On the edit tools page for site info, there is potential to have a long, unorganized list of tools. This will increase as new tools are added from contrib or Basic LTI.

      This proposal describes how Sakai core tools, contrib tools, and dynamically added Basic LTI ('external') tools can be ordered into pre-defined tool groups. A "more info" link can optionally be added to each tool description, where a tool-specific screenshot can provide additional information.

      Different sets of groups can be configured for different site types (e.g. course, project). The category keyword is required.
      <group name="core-c" category="course">
      ...
      </group>
      <group name="core-p" category="project">
      ...
      </group>

      A sample toolOrder.xml file leveraging the new format is attached, along with an sample tools.properties file, updated with tool group localizations. The changes are backward compatible; i.e. if the original toolOrder.xml file format is used, none of the new toolGroup enhancements are displayed.

      Enabling this feature requires three changes:

      1. sakai.properties (see new properties below)
      2. toolOrder.xml (see attached example)
      3. tools.properties – (optional) sakai/config/localization/bundles/src/bundle/org/sakaiproject/localization/bundle/tool/tools.properties (see attached example)

        • tools.properties in sakai trunk currently has tool group pre-defined, you only need to modify this in order to customize

      Additions to sakai.propeties, with default values specified:

      1. Enable tool groups
        config.sitemanage.useToolGroup=false|true
      1. OPTIONAL: Directory for tool 'more info' link. HTML(<body> content) file must have the same name as the tool registration id, with any extension (e.g. sakai.siteinfo.html)
        config.sitemanage.moreInfoDir=library/image/

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  jkusnetz Jeremy Kusnetz
                  Reporter:
                  jonespm Matthew Jones
                • Votes:
                  1 Vote for this issue
                  Watchers:
                  17 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Git Source Code