Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.1.1, 2.2
    • Fix Version/s: 2.1.2
    • Component/s: Course, Filters
    • Labels:
    • Testing Instructions:
      Hide
      1. Log in as an admin
      2. Enable the multilang filter (Settings > Plugins > Filters > Manage filters)
      3. Set the multilang filter to apply to both content and headings
      4. Edit your site settings and make the site fullname a multilang string
      5. Create a new course or edit an existing course and give it a multilang fullname
      6. Browse around the site and make sure you always see just correct language for the course fullname
      7. The following places are some suggestions to check:
        • Site registration form
        • Backup and Restore
        • Course blogs (and there RSS)
        • Calendar
        • Course completion details
        • Deleting a course
        • Authorize and paypay enrolment methods
        • Courses on the navigation
        • Portfolio
        • Upload assignement upload pages
        • Notes
        • Tags
        • Editing a user (not advanced edit but regular edit)
        • Viewing a users course profile.

      Example multilang = <span class="multilang" lang="en">EN</span><span class="multilang" lang="NZ">NZ</span>

      Show
      Log in as an admin Enable the multilang filter (Settings > Plugins > Filters > Manage filters) Set the multilang filter to apply to both content and headings Edit your site settings and make the site fullname a multilang string Create a new course or edit an existing course and give it a multilang fullname Browse around the site and make sure you always see just correct language for the course fullname The following places are some suggestions to check: Site registration form Backup and Restore Course blogs (and there RSS) Calendar Course completion details Deleting a course Authorize and paypay enrolment methods Courses on the navigation Portfolio Upload assignement upload pages Notes Tags Editing a user (not advanced edit but regular edit) Viewing a users course profile. Example multilang = <span class="multilang" lang="en">EN</span><span class="multilang" lang="NZ">NZ</span>
    • Affected Branches:
      MOODLE_21_STABLE, MOODLE_22_STABLE
    • Fixed Branches:
      MOODLE_21_STABLE
    • Pull Master Branch:
      wip-MDL-29186-master
    • Rank:
      18523

      Description

      This just involve reviewing all uses of the course fullname for display in order to make sure they are formatted consistently.

        Issue Links

          Activity

          Hide
          Sam Hemelryk added a comment -

          Up for peer-review

          Show
          Sam Hemelryk added a comment - Up for peer-review
          Hide
          Sam Hemelryk added a comment -

          Will help resolve MDL-23902

          Show
          Sam Hemelryk added a comment - Will help resolve MDL-23902
          Hide
          Rajesh Taneja added a comment -
          1. course/externallib.php
          2. enrol/externallib.php
            return course->fullname, should this be formatted?
          3. mnet/service/enrol/host.php
            line 105
            s($course->shortname),
            s($course->fullname),
            
          4. course/publish/forms.php
            line 165
            $defaultfullname = $course->fullname;
            
          5. enrol/paypal/return.php
            redirect($destination, get_string('paymentthanks', '', $course->fullname));
            
          6. blocks/completionstatus/details.php
            line 110
            $title = format_string($course->fullname) . ': ' . $page;
            

            format_string can be removed as it is done by set_heading

          There are lot of places where format_string is used in set_heading and set_title
          which is redundant and probably can be removed as part of this bug or subtask

          $PAGE->set_heading(format_string($course->fullname));
          $PAGE->set_title(format_string($feedback->name));
          
          1. mod/feedback/edit_item.php
          2. mod/glossary/exportentry.php
          3. mod/feedback/import.php
          4. question/format/qti_two/templates/imsmanifest.tpl
          5. mod/feedback/index.php
          6. mod/feedback/view.php
          7. mod/feedback/use_templ.php
          8. mod/forum/unsubscribeall.php
          9. mod/feedback/show_nonrespondents.php
          10. mod/feedback/show_entries.php
          11. mod/feedback/print.php
          12. mod/wiki/pagelib.php
          13. lib/navigationlib.php
          14. mod/feedback/mapcourse.php
          Show
          Rajesh Taneja added a comment - course/externallib.php enrol/externallib.php return course->fullname, should this be formatted? mnet/service/enrol/host.php line 105 s($course->shortname), s($course->fullname), course/publish/forms.php line 165 $defaultfullname = $course->fullname; enrol/paypal/return.php redirect($destination, get_string('paymentthanks', '', $course->fullname)); blocks/completionstatus/details.php line 110 $title = format_string($course->fullname) . ': ' . $page; format_string can be removed as it is done by set_heading There are lot of places where format_string is used in set_heading and set_title which is redundant and probably can be removed as part of this bug or subtask $PAGE->set_heading(format_string($course->fullname)); $PAGE->set_title(format_string($feedback->name)); mod/feedback/edit_item.php mod/glossary/exportentry.php mod/feedback/import.php question/format/qti_two/templates/imsmanifest.tpl mod/feedback/index.php mod/feedback/view.php mod/feedback/use_templ.php mod/forum/unsubscribeall.php mod/feedback/show_nonrespondents.php mod/feedback/show_entries.php mod/feedback/print.php mod/wiki/pagelib.php lib/navigationlib.php mod/feedback/mapcourse.php
          Hide
          Sam Hemelryk added a comment -

          Thanks for looking at that Raj,
          In regards to the points you spotted:

          1. For the externallib libraries I will create a separate bug after I have completed my specific multilang bugs so that Jerome/Dongsheng can review the external lib functions. What ever we do there has to work with them and I'm not presently sure what they require... best to let them decide.
          2. Those courses within the mnet/service are remote courses coming from mnetservice_enrol_coruses rather than standard courses. No need to format those.
          3. course/publish/forms.php doesn't require formatting as it is part of an editing form. Its a bit like editing a course in general we want to show them the raw string to a:preserve data, and b:allow them to change it in its entirety.
          4. enrol/paypal/return.php indeed I had missed that one - its been fixed up now.
          5. format_string calls that are leading to set_heading, set_title, and navigation_node::add_content calls should all be cleaned up as part of MDL-29240. I don't want to start down that path presently as there are literally thousands.

          I'll put this up for integration shortly.

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - Thanks for looking at that Raj, In regards to the points you spotted: For the externallib libraries I will create a separate bug after I have completed my specific multilang bugs so that Jerome/Dongsheng can review the external lib functions. What ever we do there has to work with them and I'm not presently sure what they require... best to let them decide. Those courses within the mnet/service are remote courses coming from mnetservice_enrol_coruses rather than standard courses. No need to format those. course/publish/forms.php doesn't require formatting as it is part of an editing form. Its a bit like editing a course in general we want to show them the raw string to a:preserve data, and b:allow them to change it in its entirety. enrol/paypal/return.php indeed I had missed that one - its been fixed up now. format_string calls that are leading to set_heading, set_title, and navigation_node::add_content calls should all be cleaned up as part of MDL-29240 . I don't want to start down that path presently as there are literally thousands. I'll put this up for integration shortly. Cheers Sam
          Hide
          Sam Hemelryk added a comment -

          Up for integration

          Show
          Sam Hemelryk added a comment - Up for integration
          Hide
          Eloy Lafuente (stronk7) added a comment -

          The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week.

          TIA and ciao

          Show
          Eloy Lafuente (stronk7) added a comment - The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week. TIA and ciao
          Hide
          Sam Hemelryk added a comment -

          Rebased thanks Eloy

          Show
          Sam Hemelryk added a comment - Rebased thanks Eloy
          Hide
          Sam Hemelryk added a comment -

          Hi Apu,

          I've created some branches that resolve the conflicts you would hit if you attempted to integrate the the current branches (as MDL-29189 has been integrated now ).

          Repo: git://github.com/samhemelryk/moodle.git

          master
          Branch: wip-MDL-29186-master-integration
          Diff: https://github.com/samhemelryk/moodle/commit/e55bf50ae25349b81ee3d0d4c6cb1abebf1eca97

          MOODLE_21_STABLE
          Branch: wip-MDL-29186-m21-integration
          Diff: https://github.com/samhemelryk/moodle/commit/d00a7fd5123a46c08fb576cc76e1753fe5e771c3

          These branches are based off the integration master. Hopefully they merge easily and without troubles.

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - Hi Apu, I've created some branches that resolve the conflicts you would hit if you attempted to integrate the the current branches (as MDL-29189 has been integrated now ). Repo: git://github.com/samhemelryk/moodle.git master Branch: wip- MDL-29186 -master-integration Diff: https://github.com/samhemelryk/moodle/commit/e55bf50ae25349b81ee3d0d4c6cb1abebf1eca97 MOODLE_21_STABLE Branch: wip- MDL-29186 -m21-integration Diff: https://github.com/samhemelryk/moodle/commit/d00a7fd5123a46c08fb576cc76e1753fe5e771c3 These branches are based off the integration master. Hopefully they merge easily and without troubles. Cheers Sam
          Hide
          Aparup Banerjee added a comment -

          this has been integrated!
          I've resolved a bunch of conflicts between MDL-29189 down to MDL-29186 and edited minor bits.

          (kept out of 20 stable)

          Show
          Aparup Banerjee added a comment - this has been integrated! I've resolved a bunch of conflicts between MDL-29189 down to MDL-29186 and edited minor bits. (kept out of 20 stable )
          Hide
          Sam Hemelryk added a comment -

          Did you have any luck with the branches above?

          Show
          Sam Hemelryk added a comment - Did you have any luck with the branches above?
          Hide
          Andrew Davis added a comment - - edited

          After much clicking testing past.

          Show
          Andrew Davis added a comment - - edited After much clicking testing past.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          YTC !

          (aka, yay, thanks and ciao ) Closing.

          Show
          Eloy Lafuente (stronk7) added a comment - YTC ! (aka, yay, thanks and ciao ) Closing.
          Hide
          Burton Schane added a comment -

          Hello,

          Somewhat new to Moodle tracker so I hope the following questions are being posted to the appropariate audience.

          Does the fix for displaying long names in lieu of short names within the Navigation block now require the use of multi-language filters? We ask as our courses are automatically created via a Luminis Message Broker (LMB) enrollment plug-in. I'm not familiar with multi-language filters, but the implication seems to be that course settings (long name and short name) would have to be manually edited unless we customize the LMB plug-in.

          Is this fix included in baseline 2.2.2 or will it be available with a subsequent release?

          Any information you can provide will be greatly appreciated.

          Show
          Burton Schane added a comment - Hello, Somewhat new to Moodle tracker so I hope the following questions are being posted to the appropariate audience. Does the fix for displaying long names in lieu of short names within the Navigation block now require the use of multi-language filters? We ask as our courses are automatically created via a Luminis Message Broker (LMB) enrollment plug-in. I'm not familiar with multi-language filters, but the implication seems to be that course settings (long name and short name) would have to be manually edited unless we customize the LMB plug-in. Is this fix included in baseline 2.2.2 or will it be available with a subsequent release? Any information you can provide will be greatly appreciated.
          Hide
          Sam Hemelryk added a comment -

          Hi Burton,

          This issue has was fixed during the development of 2.2 and has been included in 2.1.2, and 2.2.0.
          The multilang filter is entirely optional, and this issue was just about making sure that the course fullname was always being formatted correctly so that those who are using the multilang filter, or any other filter for that matter see things correctly formatted.

          The navigation was changed as part of this fix however it wasn't a change from shortname to fullname (just a formatting correction).
          When a course is displayed on the navigation the shortname is used for the main text and the fullname is used as the title for the course.

          Either way the multilang filter is entirely optional so I would assume the integration with LMB would continue to work fine.

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - Hi Burton, This issue has was fixed during the development of 2.2 and has been included in 2.1.2, and 2.2.0. The multilang filter is entirely optional, and this issue was just about making sure that the course fullname was always being formatted correctly so that those who are using the multilang filter, or any other filter for that matter see things correctly formatted. The navigation was changed as part of this fix however it wasn't a change from shortname to fullname (just a formatting correction). When a course is displayed on the navigation the shortname is used for the main text and the fullname is used as the title for the course. Either way the multilang filter is entirely optional so I would assume the integration with LMB would continue to work fine. Cheers Sam
          Hide
          Burton Schane added a comment -

          Sam,

          Thank you for the explanation.

          Show
          Burton Schane added a comment - Sam, Thank you for the explanation.

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: