MDL-21302 lang string polishing
authorHelen Foster <helen@moodle.org>
Fri, 12 Nov 2010 17:16:56 +0000 (17:16 +0000)
committerHelen Foster <helen@moodle.org>
Fri, 12 Nov 2010 17:16:56 +0000 (17:16 +0000)
lang/en/webservice.php

index 7d3fd22..7938d7f 100644 (file)
@@ -28,11 +28,11 @@ $string['accessnotallowed'] = 'Access to web service not allowed';
 $string['actwebserviceshhdr'] = 'Active web service protocols';
 $string['addaservice'] = 'Add service';
 $string['addcapabilitytousers'] = 'Check users capability';
-$string['addcapabilitytousersdescription'] = 'To use web services, users need to have two different capabilities: \'/webservice:createtoken\' and a capability matching the web service protocols (\'webservice/rest:use\', \'webservice/soap:use\', ...). <br/>Advice: one way to set this up is to create a new \'Web Service\' system role with the \'webservice:createtoken\' capability and some protocol capabilities. Then assign this system role to the web service user.';
+$string['addcapabilitytousersdescription'] = 'Users should have two capabilities - webservice:createtoken and a capability matching the protocols used, for example webservice/rest:use, webservice/soap:use. To achieve this, create a web services role with the appropriate capabilities allowed and assign it to the web services user as a system role.';
 $string['addfunction'] = 'Add function';
 $string['addfunctionhelp'] = 'Select the function to add to the service.';
 $string['addfunctions'] = 'Add functions';
-$string['addfunctionsdescription'] = 'On the <strong>Manage service</strong> page, click the <strong>Functions</strong> link for the newly created service. Add some functions to the service.';
+$string['addfunctionsdescription'] = 'Select required functions for the newly created service.';
 $string['addrequiredcapability'] = 'Assign/Unassign the required capability';
 $string['addservice'] = 'Add a new service: {$a->name} (id: {$a->id})';
 $string['addservicefunction'] = 'Add functions to the service "{$a}"';
@@ -48,9 +48,9 @@ $string['createservicedescription'] = 'A service is a set of web service functio
 $string['createserviceforusersdescription'] = 'A service is a set of web service functions. You will allow users to access to a new service. On the <strong>Add service</strong> page check \'Enable\' and uncheck \'Authorised users\' options. Select \'No required capability\'.';
 $string['createtoken'] = 'Create token';
 $string['createtokenforuser'] = 'Create a token for a user';
-$string['createtokenforuserdescription'] = 'On the <strong>Manage token</strong> page, click on \'Add\'. Then select the created user and service.';
+$string['createtokenforuserdescription'] = 'Create a token for the web services user.';
 $string['createuser'] = 'Create a specific user';
-$string['createuserdescription'] = 'You need to create a specific user for the system controlling Moodle.';
+$string['createuserdescription'] = 'A web services user is required to represent the system controlling Moodle.';
 $string['default'] = 'Default to "{$a}"';
 $string['deleteaservice'] = 'Delete service';
 $string['deleteservice'] = 'Delete the service: {$a->name} (id: {$a->id})';
@@ -64,9 +64,9 @@ $string['editaservice'] = 'Edit service';
 $string['editservice'] = 'Edit the service: {$a->name} (id: {$a->id})';
 $string['enabled'] = 'Enabled';
 $string['enabledocumentation'] = 'Enable developer documentation';
-$string['enabledocumentationdescription'] = 'Check it to give to the developers of the external system access to a detailed web services documentation. The developers only see the documentation of the service they have access to.';
+$string['enabledocumentationdescription'] = 'Detailed web services documentation is available for enabled protocols.';
 $string['enableprotocols'] = 'Enable protocols';
-$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. In counter part, even though Moodle takes a very good care about security issues, more you have enabled protocols, more your Moodle site is subject to external attacks.';
+$string['enableprotocolsdescription'] = 'At least one protocol should be enabled. For security reasons, only protocols that are to be used should be enabled.';
 $string['enablews'] = 'Enable web services';
 $string['enablewsdescription'] = 'Web services must be enabled in Advanced features.';
 $string['entertoken'] = 'Enter a security key/token:';
@@ -87,7 +87,7 @@ $string['errorresponsemissingkey'] = 'Error in response - Missing following requ
 $string['errorscalartype'] = 'Scalar type expected, array or object received.';
 $string['errorunexpectedkey'] = 'Unexpected keys detected in parameter array.';
 $string['execute'] = 'Execute';
-$string['executewarnign'] = 'WARNING: if you press execute your database will be modified and changes can not be reverted automatically!';
+$string['executewarnign'] = 'WARNING: If you press execute your database will be modified and changes can not be reverted automatically!';
 $string['externalservice'] = 'External service';
 $string['externalservicefunctions'] = 'External service functions';
 $string['externalservices'] = 'External services';
@@ -97,7 +97,7 @@ $string['function'] = 'Function';
 $string['functions'] = 'Functions';
 $string['generalstructure'] = 'General structure';
 $string['checkusercapability'] = 'Check user capability';
-$string['checkusercapabilitydescription'] = 'To use the web services, a user needs to have a capability matching the web service protocols (\'webservice/rest:use\', \'webservice/soap:use\', ...). <br/>Advice: one way to set this up is to create a new \'Web Service\' system role with protocol capabilities defined. Then you assign this system role to the web service user.';
+$string['checkusercapabilitydescription'] = 'The user should have appropriate capabilities according to the protocols used, for example webservice/rest:use, webservice/soap:use. To achieve this, create a web services role with protocol capabilities allowed and assign it to the web services user as a system role.';
 $string['information'] = 'Information';
 $string['invalidextparam'] = 'Invalid external api parameter: {$a}';
 $string['invalidextresponse'] = 'Invalid external api response: {$a}';
@@ -111,16 +111,15 @@ $string['key'] = 'Key';
 $string['keyshelp'] = 'The keys are used to access your Moodle account from external applications.';
 $string['manageprotocols'] = 'Manage protocols';
 $string['managetokens'] = 'Manage tokens';
-$string['missingcaps'] = 'Missing capabilities.';
-$string['missingcaps_help'] = 'List of capabilities that the service functions require but that the user hasn\'t. You need to add these capabilities to this user in order to use the service.
-Note: in some cases, some of these "required" capabilities could depend of a use case. For example: moodle_role_get_enrolled_users() function requires \'moodle/site:viewparticipants\' capability only for a site-wide request.';
+$string['missingcaps'] = 'Missing capabilities';
+$string['missingcaps_help'] = 'List of required capabilities for the service which the selected user does not have. Missing capabilities must be added to the user\'s role in order to use the service.';
 $string['missingpassword'] = 'Missing password';
 $string['missingusername'] = 'Missing username';
 $string['nofunctions'] = 'This service has no functions.';
 $string['norequiredcapability'] = 'No required capability';
 $string['notoken'] = 'The token list is empty.';
-$string['onesystemcontrolling'] = 'One system controlling Moodle with token';
-$string['onesystemcontrollingdescription'] = 'The following steps help you to set up the Moodle web service for one system controlling Moodle  (e.g a student information system). These steps also help to set up the recommended token (security keys) authentication method.';
+$string['onesystemcontrolling'] = 'One system controlling Moodle with token';
+$string['onesystemcontrollingdescription'] = '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.';
 $string['operation'] = 'Operation';
 $string['optional'] = 'Optional';
 $string['phpparam'] = 'XML-RPC (PHP structure)';
@@ -144,8 +143,7 @@ $string['restcode'] = 'REST';
 $string['restexception'] = 'REST';
 $string['restparam'] = 'REST (POST parameters)';
 $string['restrictedusers'] = 'Authorised users only';
-$string['restrictedusers_help'] = 'If this settings is disabled, any users with the \'moodle/webservice:createtoken\' capability will be able to generate a token for this service in their \'Security keys\' page.
-If this settings is enabled, you will choose which users can access this service. These users still need the \'moodle/webservice:createtoken\' capability to generate their own token in their \'Security keys\' page.';
+$string['restrictedusers_help'] = 'This setting determines whether all users with the permission to create a web services token can generate a token for this service via their security keys page or whether only authorised users can do so.';
 $string['securitykey'] = 'Security key (token)';
 $string['securitykeys'] = 'Security keys';
 $string['selectauthorisedusers'] = 'Select authorised users';
@@ -153,9 +151,9 @@ $string['selectedcapability'] = 'Selected';
 $string['selectedcapabilitydoesntexit'] = 'The currently set required capability ({$a}) doesn\'t exist any more. Please change it and save the changes.';
 $string['selectservice'] = 'Select a service';
 $string['selectspecificuser'] = 'Select a specific user';
-$string['selectspecificuserdescription'] = 'On the <strong>Manage service</strong> page, click on \'Authorised users\' and add the user to the authorised users list. The required user capabilities will be displayed. We recommend to create a role for this service and to add the capabilities to the role, then assign the role to the user.';
+$string['selectspecificuserdescription'] = 'Add the web services user as an authorised user.';
 $string['service'] = 'Service';
-$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users. <strong>Custom services</strong> are services that you created. <strong>Default services</strong> are services that were added by default to Moodle. You can not change functions from a <strong>Default service</strong>.';
+$string['servicehelpexplanation'] = 'A service is a set of functions. A service can be accessed by all users or just specified users.';
 $string['servicename'] = 'Service name';
 $string['servicesbuiltin'] = 'Built-in services';
 $string['servicescustom'] = 'Custom services';
@@ -165,19 +163,19 @@ $string['serviceusersmatching'] = 'Authorised users matching';
 $string['serviceuserssettings'] = 'Change settings for the authorised users';
 $string['simpleauthlog'] = 'Simple authentication login';
 $string['step'] = 'Step';
-$string['testauserwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Before going there, log on as a user set with the "moodle/webservice:createtoken" capability, and get his security key (token) from his "my moodle" block. You will use this token in the test client. In the test client, also choose an enabled protocol with the token authentication. <strong>Warning: the functions that you test WILL BE EXECUTED for this user, be carefull what you choose to test!!!</strong>';
+$string['testauserwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Before doing so, login as a user with the moodle/webservice:createtoken capability and obtain the security key (token) via My profile settings. You will use this token in the test client. In the test client, also choose an enabled protocol with the token authentication. <strong>WARNING: The functions that you test WILL BE EXECUTED for this user, so be careful what you choose to test!</strong>';
 $string['testclient'] = 'Web service test client';
 $string['testclientdescription'] = '* The web service test client <strong>executes</strong> the functions for <strong>REAL</strong>. Do not test functions that you don\'t know. <br/>* All existing web service functions are not yet implemented into the test client. <br/>* In order to check that a user cannot access some functions, you can test some functions that you didn\'t allow.<br/>* To see clearer error messages set the debugging to <strong>{$a->mode}</strong> into {$a->atag}<br/>* Access the {$a->amfatag}.';
 $string['testwithtestclient'] = 'Test the service';
-$string['testwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Use an enabled protocol with token authentication. <strong>Warning: the functions that you test WILL BE EXECUTED, be carefull what you choose to test!!!</strong>';
+$string['testwithtestclientdescription'] = 'Simulate external access to the service using the web service test client. Use an enabled protocol with token authentication. <strong>WARNING: The functions that you test WILL BE EXECUTED, so be careful what you choose to test!</strong>';
 $string['token'] = 'Token';
 $string['tokenauthlog'] = 'Token authentication';
 $string['tokencreatedbyadmin'] = 'Can only be reset by administrator (*)';
 $string['tokencreator'] = 'Creator';
 $string['updateusersettings'] = 'Update';
 $string['userasclients'] = 'Users as clients with token';
-$string['userasclientsdescription'] = 'The following steps help you to set up the Moodle web service for users as clients. These steps also help to set up the recommended token (security keys) authentication method. In this use case, the user will generate his token from his <strong>Security keys</strong> profile page.';
-$string['usermissingcaps'] = 'Missing capabilities: {$a}.';
+$string['userasclientsdescription'] = 'The following steps help you to set up the Moodle web service for users as clients. These steps also help to set up the recommended token (security keys) authentication method. In this use case, the user will generate his token from the security keys page via My profile settings.';
+$string['usermissingcaps'] = 'Missing capabilities: {$a}';
 $string['usernotallowed'] = 'The user is not allowed for this service. First you need to allow this user on the {$a}\'s allowed users administration page.';
 $string['usersettingssaved'] = 'User settings saved';
 $string['validuntil'] = 'Valid until';