Moodle
  1. Moodle
  2. MDL-29103

web services strings could be improved

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.1.1, 2.1.6, 2.2.3
    • Fix Version/s: 2.1.7, 2.2.4
    • Component/s: Language, Web Services
    • Labels:
    • Database:
      Any
    • Testing Instructions:
      Hide

      Go on Admin > Plugins > Web services > Overview

      Check that the following text exists:

      • Enable web services for mobile devices
      • Allow an external system to control Moodle
      • The following steps help you to set up the Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method.
      Show
      Go on Admin > Plugins > Web services > Overview Check that the following text exists: Enable web services for mobile devices Allow an external system to control Moodle The following steps help you to set up the Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method.
    • Affected Branches:
      MOODLE_21_STABLE, MOODLE_22_STABLE
    • Fixed Branches:
      MOODLE_21_STABLE, MOODLE_22_STABLE
    • Pull Master Branch:
    • Rank:
      18627

      Description

      Some of the strings are just a bit vague at /admin/settings.php?section=webservicesoverview and /admin/settings.php?section=externalservices

      "Enable mobile web service" appears on both pages and could be "Enable web services for mobile devices"

      "One system controlling Moodle with a token"
      I'm not quite sure what this means. Does it mean something like "Allow an external system to control Moodle"?

      "The following steps help you to set up the Moodle web service for a system to control Moodle. These steps also help to set up the recommended token (security keys) authentication method."
      should probably be something like
      "These steps will help you set up Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method."

        Issue Links

          Activity

          Hide
          Andrew Davis added a comment - - edited

          Also, Eloy commented in MDL-28990.

          "Also, the "mobilewsdisabled/enabled" strings surprised me a bit. Why cannot be simple disabled/enabled, can be missunderstood in any language? Note we have already active/inactive in moodle.php. For your consideration (in a separate issue)."

          Just making a note of it here in case its decided that this is work fixing. It can probably be done as part of this issue.

          Show
          Andrew Davis added a comment - - edited Also, Eloy commented in MDL-28990 . "Also, the "mobilewsdisabled/enabled" strings surprised me a bit. Why cannot be simple disabled/enabled, can be missunderstood in any language? Note we have already active/inactive in moodle.php. For your consideration (in a separate issue)." Just making a note of it here in case its decided that this is work fixing. It can probably be done as part of this issue.
          Hide
          Michael de Raadt added a comment -

          Hi, Jerome.

          I've just added you as a watcher as these definitions will require your input.

          Show
          Michael de Raadt added a comment - Hi, Jerome. I've just added you as a watcher as these definitions will require your input.
          Hide
          Jérôme Mouneyrac added a comment -

          Enable mobile web service" appears on both pages and could be "Enable web services for mobile devices" : +1

          "One system controlling Moodle with a token": "Allow one unique external system to control Moodle" +1

          "These steps will help you set up Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method." : note that admin should really use the token authentication method, not the username/login authentication method.. I guess we should restrict it to "The following steps help you to set up the Moodle web service for a system to control Moodle" without mentioning the possibility to authenticate without token but username.

          Thanks for creating the issue Andrew

          Show
          Jérôme Mouneyrac added a comment - Enable mobile web service" appears on both pages and could be "Enable web services for mobile devices" : +1 "One system controlling Moodle with a token": "Allow one unique external system to control Moodle" +1 "These steps will help you set up Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method." : note that admin should really use the token authentication method, not the username/login authentication method.. I guess we should restrict it to "The following steps help you to set up the Moodle web service for a system to control Moodle" without mentioning the possibility to authenticate without token but username. Thanks for creating the issue Andrew
          Hide
          Jérôme Mouneyrac added a comment -

          ping, Koen? I'm going through all web service issues, is it an issue for you? I can take it back if you don't want it.
          Cheers,
          Jerome

          Show
          Jérôme Mouneyrac added a comment - ping, Koen? I'm going through all web service issues, is it an issue for you? I can take it back if you don't want it. Cheers, Jerome
          Hide
          Koen Roggemans added a comment -

          I'll have a look at it - hope it is not too urgent?

          Show
          Koen Roggemans added a comment - I'll have a look at it - hope it is not too urgent?
          Hide
          Jérôme Mouneyrac added a comment -

          no it's not urgent. Thanks for keeping it Koen

          Show
          Jérôme Mouneyrac added a comment - no it's not urgent. Thanks for keeping it Koen
          Hide
          Koen Roggemans added a comment -

          [enablemobilewebservice,core_admin]
          "Enable mobile web service" appears on both pages and could be "Enable web services for mobile devices"
          I agree

          [onesystemcontrolling,core_webservice]
          "One system controlling Moodle with a token"
          I'm not quite sure what this means. Does it mean something like "Allow an external system to control Moodle"?
          Yes it does. your explanation would be more understandable.

          [onesystemcontrollingdescription,core_webservice]
          "The following steps help you to set up the Moodle web service for a system to control Moodle. These steps also help to set up the recommended token (security keys) authentication method."
          should probably be something like Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method."
          Yes, that is more clear.

          I suggest to accept all suggestions.
          Strings/location included.

          Sending it back to you for integration Jerome (I don't have the means to do that)

          Show
          Koen Roggemans added a comment - [enablemobilewebservice,core_admin] "Enable mobile web service" appears on both pages and could be "Enable web services for mobile devices" I agree [onesystemcontrolling,core_webservice] "One system controlling Moodle with a token" I'm not quite sure what this means. Does it mean something like "Allow an external system to control Moodle"? Yes it does. your explanation would be more understandable. [onesystemcontrollingdescription,core_webservice] "The following steps help you to set up the Moodle web service for a system to control Moodle. These steps also help to set up the recommended token (security keys) authentication method." should probably be something like Moodle web services to allow an external system to interact with Moodle. This includes setting up a token (security key) authentication method." Yes, that is more clear. I suggest to accept all suggestions. Strings/location included. Sending it back to you for integration Jerome (I don't have the means to do that)
          Hide
          Koen Roggemans added a comment -

          Back to you for integration.

          Show
          Koen Roggemans added a comment - Back to you for integration.
          Hide
          Jérôme Mouneyrac added a comment -

          Hi Koen, I made you the author of the commit.
          Cheers,
          Jerome

          Show
          Jérôme Mouneyrac added a comment - Hi Koen, I made you the author of the commit. Cheers, Jerome
          Hide
          Jérôme Mouneyrac added a comment -

          Can be cherry-pick in 2.1 and 2.2 too. Thank you.

          Show
          Jérôme Mouneyrac added a comment - Can be cherry-pick in 2.1 and 2.2 too. Thank you.
          Hide
          Dan Poltawski 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
          Dan Poltawski 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
          Dan Poltawski added a comment -

          Thanks Jerome, i've integrated that now.

          Note that it did not cherry-pick cleanly onto 21_STABLE, so I fixed this up for you this one time only. Please only ask us to cherry-pick if confirmed that it cherry picks cleanly.

          Show
          Dan Poltawski added a comment - Thanks Jerome, i've integrated that now. Note that it did not cherry-pick cleanly onto 21_STABLE, so I fixed this up for you this one time only. Please only ask us to cherry-pick if confirmed that it cherry picks cleanly.
          Hide
          Ankit Agarwal added a comment -

          works as expected
          Thanks!

          Show
          Ankit Agarwal added a comment - works as expected Thanks!
          Hide
          Eloy Lafuente (stronk7) added a comment -

          We could celebrate it today... but better if we perform a bigger party after releasing Moodle 2.3.

          Print this message and come to Perth that day, it's valid for one beer, wine, coke or... water, as you wish.

          Many thanks for your collaboration!

          Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - We could celebrate it today... but better if we perform a bigger party after releasing Moodle 2.3. Print this message and come to Perth that day, it's valid for one beer, wine, coke or... water, as you wish. Many thanks for your collaboration! Ciao

            People

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

              Dates

              • Created:
                Updated:
                Resolved: