Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-26105

User friendly block settings and help information

    Details

    • Testing Instructions:
      Hide

      How to test:

      Test block settings on different pages (including main course page, front page, module pages etc)
      1. Change 'display page types' and page contexts options to make sure it works as expected
      2. It should work as doc: http://docs.moodle.org/en/Development:Blocks_2.0.3_UI

      Additionally test for peer reviewer, please check if page type pattern displayed if callbacks (such as forum_pagetypelist() in mod/forum/lib.php) not defined. When callbacks not define, generate_page_type_list will try to generate page type list based on current page type, options in blocks settings may display a list like:
      mod-forum-x, mod-forum-view-x...not language strings, but in this case, we cannot find the right language file.

      Show
      How to test: Test block settings on different pages (including main course page, front page, module pages etc) 1. Change 'display page types' and page contexts options to make sure it works as expected 2. It should work as doc: http://docs.moodle.org/en/Development:Blocks_2.0.3_UI Additionally test for peer reviewer, please check if page type pattern displayed if callbacks (such as forum_pagetypelist() in mod/forum/lib.php) not defined. When callbacks not define, generate_page_type_list will try to generate page type list based on current page type, options in blocks settings may display a list like: mod-forum-x, mod-forum-view-x...not language strings, but in this case, we cannot find the right language file.
    • Affected Branches:
      MOODLE_20_STABLE
    • Fixed Branches:
      MOODLE_21_STABLE
    • Pull Master Branch:
      s7_MDL-26105_block_settings_master

      Description

      I'm marking usability aspects now as critical. I think if users don't understand features and can't find any help or explanation the feature won't work for them. That means the feature is not working and this is really a big critical problem.

      The settings for blocks are not user friendly. Terms and functionalities are not explained. Also search at docs don't give any better information:

      Where this block appears: missing help information.
      You can define where the block appears as a default block. Depending from the context where you are adding the block and your own role the options may be different.

      Page context: missing help information
      Display on actual page
      Display on actual page and all subpages
      Display on all page types
      Display on My own MyMoodle page
      Display on all MyMoodle subpages
      Display on ...

      Restrict to these pages types: human unfriendly cryptic description of page types. Really a mess.
      Some of the types have descriptions. Others not. If the cryptic terms are described in the brackets, the cryptic terms are only relevant for developers and can be deleted here.
      Make descriptions understandable.
      delete: course-view-topics write: Any course main page in topics format
      delete: course-view-topics-* write: Any course page in topics course format (Correct?)
      delete: course-view-* write: Any course main page (format independent) (Correct?)
      delete: course-* write: Any course page (format independent) (correct?)
      delete: * write: Any page everywhere
      delete: my-index write: Users 'My' home page
      delete: my-index-* write ? What does it mean?
      delete: my-* write: Any 'My' home pages from any user (Correct?)
      delete: * write: ? What does it mean?

      Specific sub page: missing help information
      Any page matching the above
      This specific page (page 7) ? what menans 'page 7'

      Default region missing help information
      Defines where the block is placed:

      • left left column
      • right right column
      • middle/center area of the page (only if the theme allows this location)

      Default weight Missing help information
      Defines the ordering of the block in the defined region
      -1 on top
      -2 second
      ..
      0 middle
      10 last

      On this page missing help information
      What are these settings for?
      Why can I define visibility on this page if it is predefined that a block is shown at all page types?
      Why is there a different region/weight setting? What happens if the definitions differ?

      Link to documentation page don't contain any of the information for the 2.0 page.

        Gliffy Diagrams

          Attachments

          1. 26105.patch
            7 kB
          2. block_my.png
            block_my.png
            11 kB
          3. block_my2.png
            block_my2.png
            6 kB
          4. block_set.png
            block_set.png
            16 kB

            Issue Links

              Activity

                People

                • Votes:
                  6 Vote for this issue
                  Watchers:
                  12 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:
                    Fix Release Date:
                    1/Jul/11