Moodle in English: Changing one word across the whole site (2.6)

Changing one word across the whole site (2.6)

by Christoph Ruda - Friday, October 17, 2014, 7:09 PM

I would like to change the word 'student' to 'pupil' across the whole of our Moodle site. The language customisation editor shows almost 400 strings that contain 'student'. After reading the language customisation docs and various forum posts I've come to the conclusion that I have to replace 'student' with 'pupil' in each one of the strings individually.

My plan is to copy the strings into a spreadsheet, replace the word in the standard text column and then copy / paste the back into the local customisation fields.

Before I set out on this task I'd like to ask whether there is a better / faster / less error prone (manual copy/paste) method anyone has devised and would be happy to share with the Moodle community

Many thanks,

Christoph

Re: Changing one word across the whole site (2.6)

by Floyd Saner - Friday, October 17, 2014, 8:57 PM

Christoph,

Yes, if you want to change 'student' to 'pupil' in the entire site, then you have to make those over 400 changes.

However, I caution against doing this. The reason is that you will change the word in the site administration documentation, and that may lead to errors when instructions are followed - e.g. Moodle expects a string 'student' and someone enters 'pupil' instead. I'm not certain about that, but the possibility exists.

An argument against the above position is that the word 'student' is changed in the strings for other languages and that does not have adverse effects.

Changing all the strings is a big job, and will require a lot of extra work when you upgrade to later versions; you will need to do the entire process again. I would use Role Renaming in the Course Settings area. That's much easier and safer.

Floyd

Re: Changing one word across the whole site (2.6)

by Helen Foster - Friday, October 17, 2014, 11:26 PM

Hi Christoph,

I'm in agreement with Floyd that the best place to change 'student' to 'pupil' is via the role renaming section in the course settings. Also, there is most likely no need to change it everywhere it appears in the admin settings.

If you change it using Language customization though, you don't need to worry about upgrading, as all your customizations will be saved and will still be there when you upgrade.

Re: Changing one word across the whole site (2.6)

by Floyd Saner - Saturday, October 18, 2014, 12:59 AM

Helen,

Thanks for the correction on my comment about language file customization. I should have read the documentation!

So Christoph, consider this if you want to change all the strings and live dangerously. (I still hold to my original suggestion that you make changes in the course role renaming section).

Changes to the language file are stored in the moodledata/lang directory . These changes are applied to the standard Moodle language file cache after it is loaded.
Try making a few string changes to the standard English language moodle.php file using the language customization tool. Then look at moodledata/lang/en_local/moodle.php (assuming you have access to your site installation).
Notice the pattern for changes in the above file. Using a powerful text editor, such as Vi/Vim, you can likely do some fast string changes to the standard moodle.php language file, then delete any lines you did not change, and store the changes in moodledata/lang/en_local/moodle.php.

Try the above method with a few strings to be certain you have the method applied correctly.

I'll add a disclaimer:

I tried it with a couple strings, but did not do extensive testing.
I take no responsibility for any damages or mess-ups that happen when you do this.
As always, you should do extensive testing on a backup site before applying changes to a production system.
Before making any database or moodledata changes to a production system, you should make backups of those files and directories.
If Moodle is running when you create the .../en_local/moodle.php file, you will need to clear the cache to see your changes.

Floyd

Re: Changing one word across the whole site (2.6)

by Robert Brenstein - Saturday, October 18, 2014, 6:01 AM

I presume that the OT wants to change the messages, labels, headers, and texts that refer to students to refer to pupils not just create a pupil role. The latter can be done by customizing the role name without having to create a new role. Role names take multi-lang strings as well.

As Floyd explained, customized strings are stored in the _local folders for each language pack, in the php files with the same names as originals. Only the changed strings (when changing thru web interface) are put into the local files. One could use a global search through lang files to identify the strings that need to be changed and copy them manually to local files to speed things up. However, global change still won't work because "student" is part of the name of many strings and those should not be changed unless fancy GREPing is used to apply changes only after the equal sign. One could also automate this by writing a script that scans original language files, finds student in the content of strings, copies them to _local files and replaces student with pupil only on the content side.

Re: Changing one word across the whole site (2.6)

by Christoph Ruda - Monday, October 20, 2014, 8:59 PM

Floyd, and Helen and Robert,

Thank you all for going to the trouble to consider my question and even trying out your suggestions to see what the consequences are. It's much appreciated. Robert is correct, I was setting out to replace the word 'student' with 'pupil' wherever it appears on the site because that is the word we use in our school.

Not trying to shy away from the task I can see that it is more complex that I thought. What surprises me though is the suggestion that there could be issues with functions expecting the string 'student'. My understanding of the language customisation tool is that I am changing the values provided to arrays. What you're suggesting is that some functions have the string 'student' hard coded; but how would that allow different languages (as you question yourself in your original reply to my question)? My interpretation is that this only concerns output and that Moodle takes care of the mapping of language strings to functions. Using the language customisation tool I should not be altering any strings I shouldn't.

Also, if I make changes to moodledata/lang/en_local/moodle.php don't I have to tell the database about those changes? That's why I think I will make changes only through the language customisation tool even if it takes longer.

I will experiment on my development site and see what happens.

Christoph

Re: Changing one word across the whole site (2.6)

by David Mudrák - Monday, October 20, 2014, 11:43 PM

There is no code that relies on a particular value of the string to contain the "student" word (unless there is an ugly bug, of course). You are free to change them.

If you modify the en_local files directly at the file system, you have to purge caches from the Moodle administration UI to force Moodle to reload them. The language customization tool does this for you once you write the changes to the disk via it.

Re: Changing one word across the whole site (2.6)

by Christoph Ruda - Tuesday, October 21, 2014, 6:14 PM

Thanks David for clearing it up, all questions answered.

Re: Changing one word across the whole site (2.6)

by Robert Brenstein - Monday, October 20, 2014, 11:54 PM

When you edit the language files through the web interface, it does care of everything. Tedious work, but clear result.

To clarify your surprise about functions expecting string 'student': If you look at the raw language files, you will see lines with

$string['stringname‘] = 'stringtext';

When customizing strings, you are to edit only the stringtext and not the stringname. Stringnames are hard coded in the Moodle code. This is normal. The program needs to know the reference to a specific string. The thing is that some stringnames contain "student" (for example, 'defaultcoursestudent') so when editing a language file directly, one has to watch to change only stringtexts. This was with regards to Floyd's suggestion to use vim or similar editor.

You do not need to tell database about the changes to files. Moodle loads the language files as needed. You will only need to clear caches (on the server as well as on your local computer) to see the changes right away.

Re: Changing one word across the whole site (2.6)

by Christoph Ruda - Tuesday, October 21, 2014, 6:18 PM

Robert, thanks for your reply. Your illustration has cleared up my remaining uncertainty and helped my to fully understand your and Floyd's earlier reply.

Christoph

Re: Changing one word across the whole site (2.6)

by Keith Bryant - Tuesday, October 21, 2014, 1:44 AM

Somewhat ironically I recently changed, via the language customisation tool, the word "pupil" (actually "elev" because our Moodle uses the Swedish language pack) into the word "student", moving in exactly the opposite direction to Christoph.

I judged that I didn't need to change every occurrence of the term because a lot of them occurred in little used help files that the students would never see, and even the teachers would rarely see.

I've informed the staff that if they find the word "pupil" in a context that irritates them they can contact me and I'll change it directly.

This saved me a lot of work! If you have helpful teachers you could adopt the same strategy.

When it comes to $string['stringname'] and 'stringtext' it is even clearer how it works with a non-English language pack - the string name is still in English ('defaultcoursestudent') but the users see the term "Lärande". So leave the string names alone!

Good luck

Keith

Re: Changing one word across the whole site (2.6)

by Christoph Ruda - Tuesday, October 21, 2014, 6:22 PM

I like your idea, Keith. Let's see how I get on with using a text editor and not changing string names on a small sample. Thanks for your reply.

Christoph

Re: Changing one word across the whole site (2.6)

by Vikram Solia - Thursday, January 15, 2015, 11:18 PM

Perhaps rather heavy duty for you but you can give it a shot after exhausting all other alternatives. This is what we use for changing the string 'course' in Moodle. Perhaps it is one of the most used strings. Here is the recipe which can be used in similar cases:

For lower case search use as it occurs in the middle of the string and might be used as an object property and variable:
For upper case, it will occur mostly at the start of the string and has minimal chance of being used as an object property and variable:
Please note that besides uppercase and lowercase, multiple occurrences of the word 'course' will require running search / replace multiple times. Note the use of the following in the search pattern:
1. groups and back-reference inside the search pattern itself;
2. negation operation inside the character class i.e. square brackets
The replacement pattern would be:
Please note that both in notepad++ and Netbeans, back-references in the search pattern work with a backslash '\' but in the replacement pattern, a '$' is required.

Please type carefully. Had provided the patterns as text but Mathjax ends up rendering some part in mathematical notation and hence providing the search and replacement strings in the text file.

Please use these after thorough testing and at your own risk.

replace_course_regex.txt

Re: Changing one word across the whole site (2.6)

by Frédéric Collin - Sunday, April 10, 2016, 10:52 PM

This thread is over a year old, but does Moodle 3.0 enable a more efficient change of a single word like "course" ?

Also, has this regex been tested on a Moodle 3.0 installation ?

Thanks, i am curious about this subject and very new to Moodle.

Re: Changing one word across the whole site (2.6)

by David Mudrák - Monday, April 11, 2016, 2:08 PM

No, there has been no recent development in this area. As far as I know, neither 3.0 nor 3.1 brings anything new, I am afraid.

Re: Changing one word across the whole site (2.6)

by Frédéric Collin - Monday, April 11, 2016, 6:27 PM

Ok, thanks David. We are still evaluating the amount of work in order to rename all/most instances of courses into workshops across several languages.

Re: Changing one word across the whole site (2.6)

by Mary Cooch - Monday, April 11, 2016, 6:32 PM

Just out of interest Frédéric - if you rename courses to workshops, what are you going to rename workshops to?

Re: Changing one word across the whole site (2.6)

by Frédéric Collin - Tuesday, April 12, 2016, 12:40 AM

Hello Mary, actually i wanted to rename the french version of course (cours) to activity (activité) to be precise.

I do realize there will be problems. I am trying to see how doable such an undertaking is, especially since we plan to offer our Moodle in a minimum of 3 languages: French, English and Spanish.

I am also trying to see if by doing greps on the source .php files to identify where the bulk of these words are located if there isn't a more efficient way, like doing a new language pack specific to our project for example. I am still trying to identify the most efficient way of doing this besides rewriting manually 2000 strings in each language using the built-in GUI to manage the language pack.

So far i couldn't find a magic bullet, no computerized way to easily implement something like this. I will also remember your workshop example and search also for possible collisions. I don't want to end up with strings like "This workshop workshop is full"

Re: Changing one word across the whole site (2.6)

by Mary Cooch - Tuesday, April 12, 2016, 1:30 AM

actually i wanted to rename the french version of course (cours) to activity (activité)

Goodness

Then what are you going to rename activité to then? There are even more instances of that than of atelier/workshop!

Anyway, good luck.

Re: Changing one word across the whole site (2.6)

by Frédéric Collin - Tuesday, April 12, 2016, 5:28 AM

Thanks Mary for your clairvoyant output, the more i dig into this word change the further down it goes, i feel like Alice.

Languages

Changing one word across the whole site (2.6)