Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Improving English language strings: Difference between revisions

From MoodleDocs
m (Linking to new page (combined is not the target anymore))
(→‎en_fix and different versions: info from MDL-64509)
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Translation}}
{{Translation}}
==Moodle core==
==The English (fixes) (en_fix) language pack==
 
Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in the Moodle core may be submitted via the [http://lang.moodle.org Translation site] by contributing them to the ''English (fixes) (en_fix)'' language pack, as described in [[Contributing a translation|contributing a translation]]. They will then be reviewed and merged with the ''English (en)'' language pack two weeks prior to each release (as mentioned in [[Release process]]).
Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in the Moodle core may be submitted via the [http://lang.moodle.org Translation site] by contributing them to the ''English (fixes) (en_fix)'' language pack, as described in [[Contributing a translation|contributing a translation]]. They will then be reviewed and merged with the ''English (en)'' language pack two weeks prior to each release (as mentioned in [[Release process]]).


US English versions of words e.g. 'color' versus 'colour' and 'point' versus 'mark' can be contributed to the ''English - United States (en_us)'' language pack, as described in [[Contributing a translation|contributing a translation]].  
Sometimes bugs reported in the tracker can be fixed simply by changing an English language string. In these cases, the string can be changed in the en_fix language pack and the issue closed (as mentioned in [[Bug triage]]), thus saving developer time in not having to create a patch, go through peer review etc.
 
==New features and improvements==
 
Developers are welcome to ask for suggestions for new language string wordings by pinging Helen Foster in a tracker issue comment.
 
Otherwise all new and changed language strings (as listed in the [https://lang.moodle.org/mod/forum/view.php?id=7 Notification of string changes forum]) are reviewed prior to each release, and any improvements (for consistency, clearer description etc.) are added to the English (fixes) language pack.


Similarly, simplified English words and phrases for use with younger children can be contributed to the ''English for kids (en_kids)'' language pack, and 'Talk Like a Pirate' day phrases can be contributed to the ''English - Pirate (en_ar)'' language pack.
==Using en_fix versus changing strings in a patch==
 
en_fix is mainly for fixing or improving the English - typos, incorrect spelling or grammar, consistency improvements. For major terminology changes, a patch should be used. Note that UI string changes can require Behat tests to be fixed
 
==en_fix and different versions==
 
Changes should be applied to all supported versions unless there is an exceptional reason for not doing so. Applying to all branches doesn't result in extra work for translators because AMOS automatically propagates the changes if they apply.
 
==English child language packs==
 
The following child language packs enable particular strings to be changed:
 
* English - United States (en_us) - for US English versions of words e.g. 'enroll' versus 'enrol', 'color' versus 'colour' and 'point' versus 'mark'  
* English for kids (en_kids) - for simplified English words and phrases for use with younger children
* English - Pirate (en_ar) - for 'Talk Like a Pirate' day phrases


==Additional plugins==
==Additional plugins==
Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in any of the 800+ additional plugins available for Moodle should be forwarded to the plugin maintainer listed in the [https://moodle.org/plugins/ Moodle plugins database]. Most plugins maintainers will be happy to receive suggestions for improving their plugin.  
 
Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in any of the 1000+ additional plugins available for Moodle should be forwarded to the plugin maintainer listed in the [https://moodle.org/plugins/ Moodle plugins directory]. Plugin maintainers are generally happy to receive suggestions for improving their plugin.  


==See also==
==See also==


* [[Help strings]]
* [[String API]]
* The section 'Language strings' in [[Coding style]]
* [[String deprecation]]


[[Category:Language]]
[[Category:Language]]

Revision as of 14:21, 8 January 2019

The English (fixes) (en_fix) language pack

Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in the Moodle core may be submitted via the Translation site by contributing them to the English (fixes) (en_fix) language pack, as described in contributing a translation. They will then be reviewed and merged with the English (en) language pack two weeks prior to each release (as mentioned in Release process).

Sometimes bugs reported in the tracker can be fixed simply by changing an English language string. In these cases, the string can be changed in the en_fix language pack and the issue closed (as mentioned in Bug triage), thus saving developer time in not having to create a patch, go through peer review etc.

New features and improvements

Developers are welcome to ask for suggestions for new language string wordings by pinging Helen Foster in a tracker issue comment.

Otherwise all new and changed language strings (as listed in the Notification of string changes forum) are reviewed prior to each release, and any improvements (for consistency, clearer description etc.) are added to the English (fixes) language pack.

Using en_fix versus changing strings in a patch

en_fix is mainly for fixing or improving the English - typos, incorrect spelling or grammar, consistency improvements. For major terminology changes, a patch should be used. Note that UI string changes can require Behat tests to be fixed

en_fix and different versions

Changes should be applied to all supported versions unless there is an exceptional reason for not doing so. Applying to all branches doesn't result in extra work for translators because AMOS automatically propagates the changes if they apply.

English child language packs

The following child language packs enable particular strings to be changed:

  • English - United States (en_us) - for US English versions of words e.g. 'enroll' versus 'enrol', 'color' versus 'colour' and 'point' versus 'mark'
  • English for kids (en_kids) - for simplified English words and phrases for use with younger children
  • English - Pirate (en_ar) - for 'Talk Like a Pirate' day phrases

Additional plugins

Suggested fixes for typos or misspellings and any other suggested improvements to English language strings in any of the 1000+ additional plugins available for Moodle should be forwarded to the plugin maintainer listed in the Moodle plugins directory. Plugin maintainers are generally happy to receive suggestions for improving their plugin.

See also