MoodleDocs - User contributions [en]

Translation

2023-11-02T18:35:27Z

Koen: Redirected page to en:Translation

#Redirect [[:en:Translation|Translation]]

This page is now located in the user docs: [[:en:Translation|Translation]]

Creating a theme based on boost

2023-08-16T09:58:36Z

Koen: /* Theme specific files */ added missing setting in config.php

{{Moodle 3.2}}
{{Template:Themes}}

This is a tutorial for how to create a new theme in any version of Moodle from 3.2 and later.

Moodle 3.2 introduced a new core theme named "Boost" which is a great starting point for themers wanting to build a modern Moodle theme utilising all the latest features available to themes in Moodle. If you aren't sure where to start, then START HERE! :-)

== Getting started ==
What is a theme? A theme in Moodle is just another type of plugin that can be developed. Themes are responsible for setting up the structure of each page and have the ability to customise the output of any page in Moodle.

This tutorial is based on a working theme named "theme_photo" you can download it or view the source code for it here: https://github.com/damyon/moodle-theme_photo

=== Choosing a name ===
Your new theme will need a name. Try and think of something short and memorable - and make sure it is not a name that has already been used by someone else. A quick search on the moodle.org/plugins can save you a lot of work renaming things later.

Lets call our new example theme "photo" as we will add some settings to allow "photos" in various places in Moodle.

=== Starting files ===
As a plugin, themes must start with the basic structure of a plugin in Moodle. See https://docs.moodle.org/dev/Tutorial#The_skeleton_of_your_plugin for an overview of the files common to all plugins in Moodle.

Following this guide we can start creating our theme. First we create the folder for the new theme under "/theme/" folder in the Moodle root directory.

<syntaxhighlight lang="php">
/theme/photo/
</syntaxhighlight>

Now we need to add some standard plugin files to our theme. First is version.php

''/theme/photo/version.php''

<syntaxhighlight lang="php"><?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// This is the version of the plugin.
$plugin->version = '2016102100';

// This is the version of Moodle this plugin requires.
$plugin->requires = '2016070700';

// This is the component name of the plugin - it always starts with 'theme_'
// for themes and should be the same as the name of the folder.
$plugin->component = 'theme_photo';

// This is a list of plugins, this plugin depends on (and their versions).
$plugin->dependencies = [
'theme_boost' => '2016102100'
];

</syntaxhighlight>

We also need a language file so that all our strings can be translated into different languages. The name of this file is the component name of our plugin and it sits in the lang/en/ folder for our plugin. We can include translations of our plugin, but we can also provide translations via the https://lang.moodle.org/ website once our plugin has been published to the plugins database at http://www.moodle.org/plugins/.

''/theme/photo/lang/en/theme_photo.php''

<syntaxhighlight lang="php"><?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// A description shown in the admin theme selector.
$string['choosereadme'] = 'Theme photo is a child theme of Boost. It adds the ability to upload background photos.';
// The name of our plugin.
$string['pluginname'] = 'Photo';
// We need to include a lang string for each block region.
$string['region-side-pre'] = 'Right';
</syntaxhighlight>

=== Theme specific files ===
Theme plugins have a few more standard files they need to define.

Themes require a favicon file to show in the address bar. See [[http://docs.moodle.org/en/Favicon Favicon]].

''pix/favicon.ico''

(Image file not shown).

Themes also require an example screenshot to be displayed in the theme selector.

''pix/screenshot.jpg''

(Image file not shown).

Themes require a lib.php file. This file contains callbacks used by various API's in Moodle. Initially this file can be empty, but as we add features to our theme we will need to add some functions here.

''lib.php''
<syntaxhighlight lang="php">
<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// We will add callbacks here as we add features to our theme.
</syntaxhighlight>

Theme config goes in a config.php file. This is one of the most important files in our theme. Once we add this file we will be ready to test our theme for the first time.

''config.php''

<syntaxhighlight lang="php">
<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// $THEME is defined before this page is included and we can define settings by adding properties to this global object.

// The first setting we need is the name of the theme. This should be the last part of the component name, and the same
// as the directory name for our theme.
$THEME->name = 'photo';

// This setting list the style sheets we want to include in our theme. Because we want to use SCSS instead of CSS - we won't
// list any style sheets. If we did we would list the name of a file in the /style/ folder for our theme without any css file
// extensions.
$THEME->sheets = [];

// This is a setting that can be used to provide some styling to the content in the TinyMCE text editor. This is no longer the
// default text editor and "Atto" does not need this setting so we won't provide anything. If we did it would work the same
// as the previous setting - listing a file in the /styles/ folder.
$THEME->editor_sheets = [];

// This is a critical setting. We want to inherit from theme_boost because it provides a great starting point for SCSS bootstrap4
// themes. We could add more than one parent here to inherit from multiple parents, and if we did they would be processed in
// order of importance (later themes overriding earlier ones). Things we will inherit from the parent theme include
// styles and mustache templates and some (not all) settings.
$THEME->parents = ['boost'];

// A dock is a way to take blocks out of the page and put them in a persistent floating area on the side of the page. Boost
// does not support a dock so we won't either - but look at bootstrapbase for an example of a theme with a dock.
$THEME->enable_dock = false;

// This is an old setting used to load specific CSS for some YUI JS. We don't need it in Boost based themes because Boost
// provides default styling for the YUI modules that we use. It is not recommended to use this setting anymore.
$THEME->yuicssmodules = array();

// Most themes will use this rendererfactory as this is the one that allows the theme to override any other renderer.
$THEME->rendererfactory = 'theme_overridden_renderer_factory';

// This is a list of blocks that are required to exist on all pages for this theme to function correctly. For example
// bootstrap base requires the settings and navigation blocks because otherwise there would be no way to navigate to all the
// pages in Moodle. Boost does not require these blocks because it provides other ways to navigate built into the theme.
$THEME->requiredblocks = '';

// This is a feature that tells the blocks library not to use the "Add a block" block. We don't want this in boost based themes because
// it forces a block region into the page when editing is enabled and it takes up too much room.
$THEME->addblockposition = BLOCK_ADDBLOCK_POSITION_FLATNAV;

$THEME->haseditswitch = true;

</syntaxhighlight>

=== Ready set go! ===
If you have been following along - now we are at the point where we can actually install and test our new theme. Try it now by visiting the admin notifications page to install the new plugin, and then choosing the new theme from the theme selector.

[[https://docs.moodle.org/en/Standard_themes#Theme_selector Theme selector]]

When you choose the new theme - you will find that it looks exactly the same as Boost. At this point with our minimal configuration - we are inheriting almost everything from our parent theme including styles and templates. You will notice though that we don't inherit the settings from our parent theme. If you choose a different preset in Boost - it is not applied in this child theme.

<div class="warningbox">
Note: make sure your config.php file contains $THEME->hidefromselector = false; (or at least set to false) or else, your theme wont show up in theme selector.
</div>

=== What if I want the settings too? ===

<div class="warningbox">
This section is included for completeness - but it is not recommended for themes to utilise settings from their parents. To find out how to duplicate the settings from the parent theme so they operate independently skip to [[#Duplicate the settings from Boost]].
</div>

If I want the settings from Boost to apply to my child theme as well I need to know a bit about how each of the settings in Boost is applied to make them work in my child theme.

'''Setting 1 - preset.'''

The "preset" file is the file that is used as the main file for scss compilation. In Boost this is controlled by the theme config value:

''theme_boost/config.php''
<syntaxhighlight lang="php">
$THEME->scss = function($theme) {
return theme_boost_get_main_scss_content($theme);
};
</syntaxhighlight>
''theme_boost/lib.php''
<syntaxhighlight lang="php">
function theme_boost_get_main_scss_content($theme) {
global $CFG;

$scss = '';
$filename = !empty($theme->settings->preset) ? $theme->settings->preset : null;
$fs = get_file_storage();

$context = context_system::instance();
if ($filename == 'default.scss') {
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
} else if ($filename == 'plain.scss') {
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/plain.scss');
} else if ($filename && ($presetfile = $fs->get_file($context->id, 'theme_boost', 'preset', 0, '/', $filename))) {
$scss .= $presetfile->get_content();
} else {
// Safety fallback - maybe new installs etc.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
}

return $scss;
}
</syntaxhighlight>

What this function is doing is checking for a theme setting "preset" and either fetching the file from Moodles internal file storage, or from the /preset/ folder. The function then returns the contents of this file.

It does not automatically work for our child theme because we have no setting named "preset" in our child theme and this code is not searching the theme parents for the setting. If we wanted it to apply we could do this in our child theme:

''config.php''
<syntaxhighlight lang="php">
// This setting defines the main scss file for our theme to be compiled. We could set it to a static file in the scss folder or to a function which returns the SCSS based on theme settings.
$THEME->scss = function($theme) {

// We need to load the config for our parent theme because that is where the preset setting is defined.
$parentconfig = theme_config::load('boost');
// Call a function from our parent themes lib.php file to fetch the content of the themes main SCSS file based on it's own config, not ours.
return theme_boost_get_main_scss_content($parentconfig);
};
</syntaxhighlight>

'''Settings 2+3 brandcolor + scsspre'''

The way these settings work is they generate a chunk of SCSS to be prepended to the main scss file. In boost they work like this:

''theme_boost/config.php''
<syntaxhighlight lang="php">
$THEME->prescsscallback = 'theme_boost_get_pre_scss';
</syntaxhighlight>
''theme_boost/lib.php''
<syntaxhighlight lang="php">
function theme_boost_get_pre_scss($theme) {
global $CFG;

$scss = '';
$configurable = [
// Config key => [variableName, ...].
'brandcolor' => ['brand-primary'],
];

// Prepend variables first.
foreach ($configurable as $configkey => $targets) {
$value = isset($theme->settings->{$configkey}) ? $theme->settings->{$configkey} : null;
if (empty($value)) {
continue;
}
array_map(function($target) use (&$scss, $value) {
$scss .= '$' . $target . ': ' . $value . ";\n";
}, (array) $targets);
}

// Prepend pre-scss.
if (!empty($theme->settings->scsspre)) {
$scss .= $theme->settings->scsspre;
}

return $scss;
}
</syntaxhighlight>

What this code is doing is:
* looping over a list of theme settings that map to a SCSS variable and building some SCSS to initialise that variable from the setting. In Boost there is only one * brandprimary - but if we wanted to expose more bootstrap variables as theme settings we could use this function as a template in our child theme and add more settings to the $configurable array.
* Adding all of the raw SCSS from the scsspre theme setting
* Returning the whole thing as a string to be added before the main scss file.

If we want this code to work in our child theme, using the settings from Boost we could do this:

''config.php''
<syntaxhighlight lang="php">
// This is a function that returns some SCSS as a string to prepend to the main SCSS file.
$THEME->prescsscallback = 'theme_photo_get_pre_scss';
</syntaxhighlight>

''lib.php''
<syntaxhighlight lang="php">
// Function to return the SCSS to prepend to our main SCSS for this theme.
// Note the function name starts with the component name because this is a global function and we don't want namespace clashes.
function theme_photo_get_pre_scss($theme) {
// Load the settings from the parent.
$theme = theme_config::load('boost');
// Call the parent themes get_pre_scss function.
return theme_boost_get_pre_scss($theme);
}
</syntaxhighlight>

'''Setting 4 scss (post)'''

The final setting from Boost is a raw text field which adds SCSS to the end of the main SCSS file. This is a useful place to add style rules as they will override previously defined styles with the same specificity. It is applied in Boost by the following lines:

''theme_boost/config.php''
<syntaxhighlight lang="php">
$THEME->extrascsscallback = 'theme_boost_get_extra_scss';
</syntaxhighlight>
''theme_boost/lib.php''
<syntaxhighlight lang="php">
function theme_boost_get_extra_scss($theme) {
return !empty($theme->settings->scss) ? $theme->settings->scss : '';
}
</syntaxhighlight>

This is just returning the value of the setting as a string.

To make this setting apply in our child theme too - we use similar code to the previous sections.

''config.php''
<syntaxhighlight lang="php">
// This is a function that returns some SCSS as a string to append to the main SCSS file.
$THEME->extrascsscallback = 'theme_photo_get_extra_scss';
</syntaxhighlight>

''lib.php''
<syntaxhighlight lang="php">
// Function to return the SCSS to append to our main SCSS for this theme.
// Note the function name starts with the component name because this is a global function and we don't want namespace clashes.
function theme_photo_get_extra_scss($theme) {
// Load the settings from the parent.
$theme = theme_config::load('boost');
// Call the parent themes get_extra_scss function.
return theme_boost_get_extra_scss($theme);
}
</syntaxhighlight>

=== Duplicate the settings from Boost ===

This is the recommended way to extend boost as your child theme will not be affected by changes to the Boost settings, and both themes can be in use with different settings applied.

All that needs to happen is to create theme settings in the child theme that match each of the settings in the parent theme. You will need to add matching language strings for each of these settings in the language file.

This example shows how to do it - We are re-using the nice looking theme_boost_admin_settingspage_tabs class from boost and creating duplicate versions of each of the settings.

''settings.php''

<syntaxhighlight lang="php">
<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// This is used for performance, we don't need to know about these settings on every page in Moodle, only when
// we are looking at the admin settings pages.
if ($ADMIN->fulltree) {

// Boost provides a nice setting page which splits settings onto separate tabs. We want to use it here.
$settings = new theme_boost_admin_settingspage_tabs('themesettingphoto', get_string('configtitle', 'theme_photo'));

// Each page is a tab - the first is the "General" tab.
$page = new admin_settingpage('theme_photo_general', get_string('generalsettings', 'theme_photo'));

// Replicate the preset setting from boost.
$name = 'theme_photo/preset';
$title = get_string('preset', 'theme_photo');
$description = get_string('preset_desc', 'theme_photo');
$default = 'default.scss';

// We list files in our own file area to add to the drop down. We will provide our own function to
// load all the presets from the correct paths.
$context = context_system::instance();
$fs = get_file_storage();
$files = $fs->get_area_files($context->id, 'theme_photo', 'preset', 0, 'itemid, filepath, filename', false);

$choices = [];
foreach ($files as $file) {
$choices[$file->get_filename()] = $file->get_filename();
}
// These are the built in presets from Boost.
$choices['default.scss'] = 'default.scss';
$choices['plain.scss'] = 'plain.scss';

$setting = new admin_setting_configselect($name, $title, $description, $default, $choices);
$setting->set_updatedcallback('theme_reset_all_caches');
$page->add($setting);

// Preset files setting.
$name = 'theme_photo/presetfiles';
$title = get_string('presetfiles','theme_photo');
$description = get_string('presetfiles_desc', 'theme_photo');

$setting = new admin_setting_configstoredfile($name, $title, $description, 'preset', 0,
array('maxfiles' => 20, 'accepted_types' => array('.scss')));
$page->add($setting);

// Variable $brand-color.
// We use an empty default value because the default colour should come from the preset.
$name = 'theme_photo/brandcolor';
$title = get_string('brandcolor', 'theme_photo');
$description = get_string('brandcolor_desc', 'theme_photo');
$setting = new admin_setting_configcolourpicker($name, $title, $description, '');
$setting->set_updatedcallback('theme_reset_all_caches');
$page->add($setting);

// Must add the page after definiting all the settings!
$settings->add($page);

// Advanced settings.
$page = new admin_settingpage('theme_photo_advanced', get_string('advancedsettings', 'theme_photo'));

// Raw SCSS to include before the content.
$setting = new admin_setting_configtextarea('theme_photo/scsspre',
get_string('rawscsspre', 'theme_photo'), get_string('rawscsspre_desc', 'theme_photo'), '', PARAM_RAW);
$setting->set_updatedcallback('theme_reset_all_caches');
$page->add($setting);

// Raw SCSS to include after the content.
$setting = new admin_setting_configtextarea('theme_photo/scss', get_string('rawscss', 'theme_photo'),
get_string('rawscss_desc', 'theme_photo'), '', PARAM_RAW);
$setting->set_updatedcallback('theme_reset_all_caches');
$page->add($setting);

$settings->add($page);
}
</syntaxhighlight>

''lang/en/theme_photo.php''
<syntaxhighlight lang="php">
<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();
// The name of the second tab in the theme settings.
$string['advancedsettings'] = 'Advanced settings';
// The brand colour setting.
$string['brandcolor'] = 'Brand colour';
// The brand colour setting description.
$string['brandcolor_desc'] = 'The accent colour.';
// A description shown in the admin theme selector.
$string['choosereadme'] = 'Theme photo is a child theme of Boost. It adds the ability to upload background photos.';
// Name of the settings pages.
$string['configtitle'] = 'Photo settings';
// Name of the first settings tab.
$string['generalsettings'] = 'General settings';
// The name of our plugin.
$string['pluginname'] = 'Photo';
// Preset files setting.
$string['presetfiles'] = 'Additional theme preset files';
// Preset files help text.
$string['presetfiles_desc'] = 'Preset files can be used to dramatically alter the appearance of the theme. See <a href=https://docs.moodle.org/dev/Boost_Presets>Boost presets</a> for information on creating and sharing your own preset files, and see the <a href=http://moodle.net/boost>Presets repository</a> for presets that others have shared.';
// Preset setting.
$string['preset'] = 'Theme preset';
// Preset help text.
$string['preset_desc'] = 'Pick a preset to broadly change the look of the theme.';
// Raw SCSS setting.
$string['rawscss'] = 'Raw SCSS';
// Raw SCSS setting help text.
$string['rawscss_desc'] = 'Use this field to provide SCSS or CSS code which will be injected at the end of the style sheet.';
// Raw initial SCSS setting.
$string['rawscsspre'] = 'Raw initial SCSS';
// Raw initial SCSS setting help text.
$string['rawscsspre_desc'] = 'In this field you can provide initialising SCSS code, it will be injected before everything else. Most of the time you will use this setting to define variables.';
// We need to include a lang string for each block region.
$string['region-side-pre'] = 'Right';
</syntaxhighlight>

We aren't quite there yet as you will notice if you try and upload a preset file and then choose it. The "theme_boost_get_main_scss_content" function from Boost is expecting the preset files to be stored in a file area for theme_boost only. We need to add this function to our own theme and tweak it.

''config.php''
<syntaxhighlight lang="php">
// This is the function that returns the SCSS source for the main file in our theme. We override the boost version because
// we want to allow presets uploaded to our own theme file area to be selected in the preset list.
$THEME->scss = function($theme) {
return theme_photo_get_main_scss_content($theme);
};
</syntaxhighlight>

''lib.php''
<syntaxhighlight lang="php">
function theme_photo_get_main_scss_content($theme) {
global $CFG;

$scss = '';
$filename = !empty($theme->settings->preset) ? $theme->settings->preset : null;
$fs = get_file_storage();

$context = context_system::instance();
if ($filename == 'default.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
} else if ($filename == 'plain.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/plain.scss');

} else if ($filename && ($presetfile = $fs->get_file($context->id, 'theme_photo', 'preset', 0, '/', $filename))) {
// This preset file was fetched from the file area for theme_photo and not theme_boost (see the line above).
$scss .= $presetfile->get_content();
} else {
// Safety fallback - maybe new installs etc.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
}

return $scss;
}
</syntaxhighlight>

=== Stop and try it out ===
So now what is working and what isn't. Well - everything should be working and you should have a nice new theme extending boost with it's own settings pages. When Boost gets updates for bug fixes your new theme will inherit those fixes as it inherits all the SCSS and templates from theme boost. In addition your new theme will accept preset files and supports all the same features and settings as boost, ready to add more.

== Take it further ==
Now we have our very nice starting point we can start changing or adding features, customising templates and output or tweaking the SCSS.

=== Add some new settings ===

From this point in the tutorial we will start adding features to our theme to extend it and make it AWESOME!

Lets start with a new setting to set a background image on the login page. As you saw earlier, our theme defines it's list of settings in a file called settings.php. See [[Admin settings]] for more information about adding admin settings to any plugin. All of the different kinds of admin settings can be found in lib/adminlib.php. In our case we will want to add a setting which allows an admin to upload an image file. This is an "admin_setting_configstoredfile" and we add it to our theme by adding this code to the settings.php file (inside the "if ($ADMIN->fulltree) {" condition.

''settings.php''
<syntaxhighlight lang="php">
// Login page background setting.
// We use variables for readability.
$name = 'theme_photo/loginbackgroundimage';
$title = get_string('loginbackgroundimage', 'theme_photo');
$description = get_string('loginbackgroundimage_desc', 'theme_photo');
// This creates the new setting.
$setting = new admin_setting_configstoredfile($name, $title, $description, 'loginbackgroundimage');
// This means that theme caches will automatically be cleared when this setting is changed.
$setting->set_updatedcallback('theme_reset_all_caches');
// We always have to add the setting to a page for it to have any effect.
$page->add($setting);
</syntaxhighlight>

We also need to add new lang strings to our language file.

"lang/en/theme_photo.php"
<syntaxhighlight lang="php">
// Background image for login page.
$string['loginbackgroundimage'] = 'Login page background image';
// Background image for login page.
$string['loginbackgroundimage_desc'] = 'An image that will be stretched to fill the background of the login page.';
</syntaxhighlight>

Now we have a new setting that lets us upload a file - but it doesn't actually do anything yet. We need to update the theme to set this image background on the login page.

In order to change the SCSS for our theme we will add 2 additional SCSS files and include them before and after our main scss.

We already have a function in our lib.php file which fetches the main SCSS for our theme. This is a good point to include additional SCSS files. We can add 2 lines to the end of this function to achieve this.

''lib.php''
<syntaxhighlight lang="php">
function theme_photo_get_main_scss_content($theme) {
global $CFG;

$scss = '';
$filename = !empty($theme->settings->preset) ? $theme->settings->preset : null;
$fs = get_file_storage();

$context = context_system::instance();
if ($filename == 'default.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
} else if ($filename == 'plain.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/plain.scss');

} else if ($filename && ($presetfile = $fs->get_file($context->id, 'theme_photo', 'preset', 0, '/', $filename))) {
// This preset file was fetched from the file area for theme_photo and not theme_boost (see the line above).
$scss .= $presetfile->get_content();
} else {
// Safety fallback - maybe new installs etc.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
}

// Pre CSS - this is loaded AFTER any prescss from the setting but before the main scss.
$pre = file_get_contents($CFG->dirroot . '/theme/photo/scss/pre.scss');
// Post CSS - this is loaded AFTER the main scss but before the extra scss from the setting.
$post = file_get_contents($CFG->dirroot . '/theme/photo/scss/post.scss');

// Combine them together.
return $pre . "\n" . $scss . "\n" . $post;
}
</syntaxhighlight>

''scss/pre.scss''
<syntaxhighlight lang="scss">
// Pre SCSS for the theme.
</syntaxhighlight>

''scss/post.scss''
<syntaxhighlight lang="scss">
// Post SCSS for the theme.
</syntaxhighlight>

==== Why do we use pre and post SCSS? ====
SCSS/SASS is a powerful language for creating CSS. It supports variables, functions, loops just like php. For lots of information and an introduction to SCSS read about [https://en.wikipedia.org/wiki/Sass_(stylesheet_language) Sass on wikipedia].

'''Pre SCSS'''

In Boost we use many variables when creating style rules.

When declaring a variable in SCSS - it is best practice to define it like this:
<syntaxhighlight lang="scss">
$mycoolcolour: #FF0 !default;
</syntaxhighlight>

What this means is - if this variable is not defined already - set it to the hex value '#FF0';

So by setting this variable in some PRE scss we can override the default value of this variable everywhere it is used. Boost is built with the [https://v4-alpha.getbootstrap.com/ Bootstrap 4 (Alpha 4)] CSS Framework. This is a framework which uses SCSS to provide many extremely useful layouts and components which can be reused without adding specific CSS rules to style every page. Because bootstrap consistently uses variables we can customise many of these components easily by setting the value of the variables before we include the Bootstrap SCSS files.

Many variables are available in /theme/boost/scss/bootstrap/_variables.scss - as an example we can change the look of all buttons and input fields with this one variable:

<syntaxhighlight lang="scss">
$border-radius: 8px;
</syntaxhighlight>

'''Post SCSS'''

Post SCSS is useful for defining full CSS rules. Because they are included last, they override any previous matching selector with the same [https://en.wikipedia.org/wiki/Cascading_Style_Sheets#Specificity Specificity].

=== Tips for customising Moodle with SCSS (or CSS) ===
Some handy things to know when you are new to theming is that Moodle adds some classes to every page that helps you target a specific page or set of pages with some style rules.

If you inspect a moodle page and look at the body tag you will see a long list of classes e.g.

<syntaxhighlight lang="html">
<body id="page-course-view-weeks" class="format-weeks path-course path-course-view safari dir-ltr lang-en yui-skin-sam yui3-skin-sam damyon-per-in-moodle-com--stable_master pagelayout-course course-11 context-497 category-1 drawer-open-left jsenabled">
</syntaxhighlight>

You can see from this example that each page gets an id. This is a simplified representation of the current page in the navigation. In this example we are looking at the course page and this course is using the weeks format.

The classes on the body tag can also be used to target a page or set of pages.
* <syntaxhighlight lang="php">format-weeks</syntaxhighlight> The course format
* <syntaxhighlight lang="php">path-course path-course-view</syntaxhighlight> The parts of the bread-crumb leading up to the current page (The current page is what goes in the id)
* <syntaxhighlight lang="php">safari</syntaxhighlight> Some server side guessing of the browser type - it's not accurate so I would not rely on it
* <syntaxhighlight lang="php">dir-ltr</syntaxhighlight> The direction of the current language for the page ( dir-rtl for RTL languages )
* <syntaxhighlight lang="php">lang-en</syntaxhighlight> The current language of the page
* <syntaxhighlight lang="php">yui*</syntaxhighlight> Legacy yui classes - ignore these
* <syntaxhighlight lang="php">damyon-per-in-moodle-com--stable_master</syntaxhighlight> The current hostname for the site + the site name
* <syntaxhighlight lang="php">pagelayout-course</syntaxhighlight> The layout type for the current page
* <syntaxhighlight lang="php">course-11</syntaxhighlight> The id of the current course
* <syntaxhighlight lang="php">context-497</syntaxhighlight> The current context id
* <syntaxhighlight lang="php">category-1</syntaxhighlight> The category for the current course
* <syntaxhighlight lang="php">drawer-open-left</syntaxhighlight> Added / removed when the navigation drawer is opened / closed in Boost
* <syntaxhighlight lang="php">jsenabled</syntaxhighlight> True if the browser supports javascript

[https://docs.moodle.org/dev/Themes_overview#.3Cbody.3E_CSS_id_and_classes Read about Body id and classes].

In our example the page layout is the most useful here as we have a specific page layout for login pages. We can now craft a rule that applies a background image only to login pages using "body.pagelayout-login".

=== How do we refer to an image in SCSS ? ===
So now we can add a rule to the post.scss which will set the background image for the login page. First we need to know how to construct a url to the background images from our stylesheet.

In stylesheets in Moodle we can use a special pix tag to refer to images from our theme. The rule to attach the background image looks like this:
''scss/post.scss''
<syntaxhighlight lang="scss">
body.pagelayout-login {
background-image: url([[pix:theme_photo|loginbackgroundimage]]);
background-size: cover;
}
</syntaxhighlight>

There are 2 important parts to this tag (the bit in square brackets). The first is "theme_photo". In this case we are passing a component name, the image serving code in theme_config::resolve_image_location() will then look for an image file in several locations. One of these is in "$CFG->dataroot/pix_plugins/$type/$plugin/$image". We can use this to make sure the image gets served correctly by copying the file saved in the setting to this location every time it is updated. (There is an alterative way we could do this by implementing pluginfile.php in our theme - which you can read about in the [[File API]] ).

If we had just passed the value "theme" the image serving code would have looked for the image in the "pix" folder of our theme.

So - we need this final change to copy the image file into our dataroot each time the setting is changed.

In the settings file we will update the callback to a new function which we will define in our lib.php.
''settings.php''
<syntaxhighlight lang="php"> // Login page background setting.
// We use variables for readability.
$name = 'theme_photo/loginbackgroundimage';
$title = get_string('loginbackgroundimage', 'theme_photo');
$description = get_string('loginbackgroundimage_desc', 'theme_photo');
// This creates the new setting.
$setting = new admin_setting_configstoredfile($name, $title, $description, 'loginbackgroundimage');
// This function will copy the image into the data_root location it can be served from.
$setting->set_updatedcallback('theme_photo_update_settings_images');
// We always have to add the setting to a page for it to have any effect.
$page->add($setting);
</syntaxhighlight>

''lib.php''
<syntaxhighlight lang="php">
function theme_photo_update_settings_images($settingname) {
global $CFG;

// The setting name that was updated comes as a string like 's_theme_photo_loginbackgroundimage'.
// We split it on '_' characters.
$parts = explode('_', $settingname);
// And get the last one to get the setting name..
$settingname = end($parts);

// Admin settings are stored in system context.
$syscontext = context_system::instance();
// This is the component name the setting is stored in.
$component = 'theme_photo';

// This is the value of the admin setting which is the filename of the uploaded file.
$filename = get_config($component, $settingname);
// We extract the file extension because we want to preserve it.
$extension = substr($filename, strrpos($filename, '.') + 1);

// This is the path in the moodle internal file system.
$fullpath = "/{$syscontext->id}/{$component}/{$settingname}/0{$filename}";
// Get an instance of the moodle file storage.
$fs = get_file_storage();
// This is an efficient way to get a file if we know the exact path.
if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
// We got the stored file - copy it to dataroot.
// This location matches the searched for location in theme_config::resolve_image_location.
$pathname = $CFG->dataroot . '/pix_plugins/theme/photo/' . $settingname . '.' . $extension;

// This pattern matches any previous files with maybe different file extensions.
$pathpattern = $CFG->dataroot . '/pix_plugins/theme/photo/' . $settingname . '.*';

// Make sure this dir exists.
@mkdir($CFG->dataroot . '/pix_plugins/theme/photo/', $CFG->directorypermissions, true);

// Delete any existing files for this setting.
foreach (glob($pathpattern) as $filename) {
@unlink($filename);
}

// Copy the current file to this location.
$file->copy_content_to($pathname);
}

// Reset theme caches.
theme_reset_all_caches();
}
</syntaxhighlight>

I won't show it here - but it is now easy to add a new background image setting for every layout type. I can re-use this theme_photo_update_settings_images callback for each one - so all I have to do is add the setting to the settings.php file, add the SCSS rule to the scss/post.scss file and add the lang strings to the language file.

Thats it for this tutorial, but there are [[:Category:Themes| more Themes docs]] to browse.

[[Category:Themes]]

Talk:Translation FAQ

2022-08-05T08:39:40Z

Koen:

It would be very conveniente if Helen, or someone else, proficient at HTML, checks the new section on HTML codes that must not be translated.˜˜˜

: Thanks German, I've checked it, and hopefully others will too! --[[User:Helen Foster|Helen Foster]] ([[User talk:Helen Foster|talk]]) 15:54, 29 October 2015 (AWST)

I can't change the text myself. I found some problems in the text.

Why do Moodle has four different language packs for the German language?
should be changed to: Why does Moodle have four different language packs for the German language?

Why do Moodle has several different language packs for the Spanish language?
should be changed to: Why does Moodle have several different language packs for the Spanish language?

: This is resolved on the new location of this page: https://docs.moodle.org/en/Translation_FAQ --[[User:koen roggemans|koen roggemans]] ([[User talk:koen roggemans|talk]]) 08:39, 5 August 2022 (UTC)

Translation FAQ

2021-08-18T08:19:02Z

Koen: /* All fieldnames must be kept in English */ adding more examples

{{Translation}}
==How can I help with translating Moodle?==
Please see the guide [[Contributing a translation]].
==I've found an error in a language pack. What do I do?==
* You are welcome to [[Contributing a translation|contribute a fix]] for the error. Alternatively you can contact the language pack maintainer as listed in the [http://lang.moodle.org/local/amos/credits.php Translation credits].
* English language string typo fixes and suggested improvements can be [[Improving English language strings|contributed to the English (fixes) (en_fix) language pack]].
==The month names and days are displayed in English. How can I translate them?==
This is neither Moodle bug nor a missing translation. Names of days and months are pulled out of your operating system. Your server, where the Moodle is running, does not seem to have the specific [https://en.wikipedia.org/wiki/Locale_(computer_software) locale] installed. You need to contact the server administrator and ask them to install the needed locale. See [[Table of locales]] for details.

The particular locale to use for the given language is configured in the langconfig.php file in strings ''locale'' (for Unix like operating systems) and ''localewin'' (for Windows operating systems).

On Ubuntu/Debian, the package <tt>locale-all</tt> can be installed to support all existing languages.

Mac OS is known to have a very limited support for locales. This can not be fixed.
==Why are log descriptions displayed in English?==
In log reports, descriptions are intended to be displayed in English only; it is not possible to translate them. For example "The user with id '2' viewed the course with id '4'."
==I'm starting a new language pack or I'm contributing to one. Can I do the user interface strings first?==
No, there is no way to know which strings will be shown for users and which not. But to help you a little bit, there are some unofficial priorities you can take into account.

First:
* make sure [[Translation_langconfig|langconfig]] is properly set up.
* take a look at [[Translation priority]]. All files have a rating according to how urgent they need translating.
* less urgent are also the contributed plugins, since they are not part of a standard Moodle distribution. There is a list of [https://moodle.org/plugins/stats.php the 20 top plugins downloads for Moodle] which might be worth considering for translation priority.
==How many words are there in the English language pack?==
See the discussion [http://lang.moodle.org/mod/forum/discuss.php?d=3651 How many words are there in the English language pack?].
==Moodle languages with several available language packs==
===Are there translations for the American (and other branches of the) English language?===
The [http://lang.moodle.org/mod/forum/discuss.php?d=2617 "official"] language for Moodle is actually Australian English (''G'day mate!'') , which is almost 100% the same as UK English. [http://english.stackexchange.com/questions/74737/what-is-the-origin-of-the-phrase-two-nations-divided-by-a-common-language Someone] once said "America and England are two nations divided by a common language".
* The English - United States (en_us)] language pack mostly contains different spellings (color ''versus'' colour, enroll ''versus'' enrol etc).
* The English - Pirate (en_ar)] language pack is used in the '[https://moodle.org/mod/forum/discuss.php?d=132888 Talk Like a Pirate]' day.
* The English - United States K12 (en_us_k12) language pack is used in the [https://en.wikipedia.org/wiki/K%E2%80%9312 K-12] (kindergarten to grade 12) primary and secondary education in the USA, Canada, and other English speaking countries. It includes spellings from the en_us language pack and the term "course" is renamed as "class".
* The English for kids (en_kids) language pack seems to be a simplified version of the most common English strings seen by Moodle users, considered easier/suitable for small children.
* The English (fixes) (en_fix) language pack is used to suggest Moodle core language strings improvements and typo fixes, as described in the guide [[Improving English language strings]].
===Why do Moodle has four different language packs for the German language?===
* In Germany we have a formal language where people are talking with „Sie“ to each other. This is the language of the formal adults. I think it’s something like using „Sir“ in english language. The normal German language pack is using this formal language. Nearly all strings in the Moodle language pack and in the translated plugins are translated in the formal language.

* You can’t use these formal words in school … there you are using an informal language with „du“. Students are talking to each other like friends. Therefor we made the language pack „German personal“ (de_du). It come with the personal words „du“, „dein“, „dir“ and so on where the formal words are „Sie“, „Ihre“, „Ihnen“ (yes, these words are written with an uppercase letter).

* For my (Ralf Krause) personal use I take „German personal" (de_du) or „German Kids“ (de_kids). „German Kids“ uses the personal words „du“, „dein“ and „dir“ but it also uses an easier to understand language.

* Some time ago we tried to make Moodle as a platform for social communication but nobody wanted to use it. Therefore we made "German community“. In a social platform, nobody would talk about teachers or students or participants or classrooms or courses … in a social platform, you would use members of a group and meetings. I don’t know if this pack will be used in future.
===Why do Moodle has several different language packs for the Spanish language?===
* Spain and many South American countries use a (comma) [[Decimal separator]] that is different from the (decimal point) used in Mexico and Central America.
** Moodle core in English uses by default a decimal point for calculations, and Moodle Docs do too.
** This caused many problems in the [https://docs.moodle.org/31/en/Grader_report Gradebook] calculations and with the [https://docs.moodle.org/all/es/P%C3%A1gina_Principal Spanish Moodle Docs].
* Just as "America and England are two nations divided by a common language", so are Spain and Mexico. See [https://docs.moodle.org/all/es/Espa%C3%B1ol_de_M%C3%A9xico the Mexican Spanish documentation page] in Spanish.
* The Venezuelan Spanish (es_ve) is a very small child language of the international Spanish language.
* The Colombian Spanish (es_co) is a very small child language of the international Spanish language.
* The Mexican Spanish (es_mx) is a very modern, comprehensive, independent, language pack, specially made for Mexican Moodlers.
* The Mexican Spanish for kids (es_mx_kids) is a simplified version of the most common Mexican Spanish strings seen by Moodle users, considered easier/suitable for small children.
* You can read about [https://docs.moodle.org/all/es/Espa%C3%B1ol_internacional#Idiomas_hijos_que_depend.C3.ADan_del_Espa.C3.B1ol_internacional two (now defunct) other Spanish child languages].
===Why do other languages have child languages?===
* Languages with ''-kids'' in their code names are all child languages with a simplified version of common language strings aimed at small children.
* If you have the time, it is probably a good idea to have one such child language for kids for your main language pack.
* Current (mid 2017) languages for kids are:
** Deutsch - Kids
** English for kids
** Español de México para niños (Mexican Spanish for kids)
** עברית בתי־ספר (hebrew for kids)
** Japanese - kids
** Deutsch - Kids

* Norwegian (Primary) language pack is aimed at primary education.

* Finnish for companies is aimed at companies.

* Languages ending in "_wp" are supplementary languages for [https://docs.moodle.org/37/en/Moodle_Workplace Moodle Workplace]. They are maintained by the companies offering [https://docs.moodle.org/37/en/Moodle_Workplace Moodle Workplace].
==Are there items which are NOT to be translated?==
===Moodle variables enclosed within {curly brackets}===
The following words, when enclosed within {curly brackets}, are placeholders for Moodle names of variables. They should not be translated, but must remain as they are within the curly brackets:
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe , institution, department, idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, suspended, course1, course2, course3, course4
They must also be written exactly like this in all translations of the documentation pages (such as this page.) However, the translator might like to include a translation enclosed in brackets. For example, in the Spanish documentation pages you might find: password (''contraseña'').

The fact is: '''no placeholders can be translated in AMOS'''. There is no official list of "reserved" $a properties. Whatever xyz is put in {$a->xyz}, it must be kept as it is in AMOS.

Example:

[[File:26 AMOS fullnamedisplay_core original.png]]

'''Must''' be (in this case, when translated into Mexican Spanish):

[[File:26 AMOS fullnamedisplay_core.png]]

unless your language uses lastname before the firstname, as Japanese does, which translates to:

[[File:26 AMOS fullnamedisplay_core Japanese.png]]
===Placeholders enclosed within % characters (%example%) must not be translated===
The [https://moodle.org/plugins/local_moodlecloudsignup Moodle Cloud Signup and Portal strings] local plugin is used for accessing the [https://moodle.com/cloud/ MoodleCloud] and it includes several strings that have some words surrounded by % characters (eg, %date%). These words must not be translated, they must be copied exactly into the language pack translation, but the rest of the string might or might not be translated.
* Example of one string that can not be translated and must be copied exactly:
[[File:AMOS placeholders with percentace character.png|600px]]
* Example of one string with one placeholder (highlighted) and some regular text that can be easily translated:
[[File:AMOS text with placeholders with percentace character.png|600px]]
===Placeholders in H5P prefixed with % or : characters must not be translated===
The [http://h5p.org/ H5P editor] integrated with Moodle since 3.9 has some variables prefixed with "%" or ":" that must not be translated because they are transformed internally with the correct value. They should be treated as the Moodle curly brackets variables.
* Example of variables with "%" that can not be translated and must be copied exactly:
"Parameters contain %used while only %supported or earlier are supported."

In that case, %used and %supported must not be translated. So, for instance, the Spanish translation would be something like:
"Parámetros contiene %used mientras que sólo se soportan %supported o anterior."
* Example of variables with ":" that can not be translated and must be copied exactly:
"The :property value exceeds the maximum of :max."

In that case, :property and :max must not be translated. The Spanish translation for this string would be something like:
"El valor de :property excede el máximo de :max."
=== All fieldnames must be kept in English===
* These names are hooks that are used in the software. You should not translate them.
* See the example below for the string uploadcourses_help in the file tool_uploadcourse for Moodle 3.1:
[[File:Fieldnames are not to be translatd.png]]
* Notice that the string text indicates (red rectangle) that these words (enclosed in green rectangles) are fieldnames. Also notice that the Spanish translation clearly indicates, at the final part of the paragraph ''(así escritos, en inglés)'' that these fieldnames must be written in English as they are written here.
* Some used fieldnames in Moodle are:
category, category_id, category_idnumber, category_path, context, course, description, descriptionformat, email, enrolmentkey, firstname, fullname, groupname, hidepicture, idnumber, intro, lastname, maxgrade, maxrequest, name, password, picture, section, shortname, teachers, timeopen, timeclose, timeend, timestart, username, visible,
* Examples of strings where these fielnames appear are uploadcohorts_help | core_cohort, importgroups_help | core_group, uploadcourses_help | tool_uploadcourse and uploadusers_help | tool_uploaduser.
* Note that these fieldnames may appear as real fieldnames (must not be translated) or as regular words in another context (can and must be translated). You should exercise caution and, If possible, always check that Moodle works correctly by testing your translations with some data in a real or test server.
===Local addresses after <a href="../===
Addresses inside a Language string that have <a href="../ reference a specific URL inside your Moodle server and you must keep the address part of the expression, but you can translate the descriptive name part. See the following example:
noassignableroles | tool_cohortautoroles
There are currently no roles that can be assigned in the user context. <a href="../../roles/manage.php">Manage roles</a>
* You must keep the <a href="../../roles/manage.php"> part, as this references to the [https://docs.moodle.org/31/en/PHP PHP] code in your Moodle server that will be executed in order to manage roles
* You can/should/must translate 'Manage roles'
* Do not forget to keep the ending </a>
===Moodle Docs addresses after <syntaxhighlight lang="php"><nowiki><a href="http://docs.moodle.org/en/</nowiki></syntaxhighlight>===
Addresses inside a Language string that have <syntaxhighlight lang="php"><nowiki><a href="http://docs.moodle.org/en/ </nowiki></syntaxhighlight>reference a specific URL in the Moodle English Documentation. You must look at that address and '''only''' if your language has a valid translation for that page, you can/should replace the original English Docs address with your own language address. See the following example:
core backup | nonisowarning
Warning: this backup is from a non-Unicode version of Moodle (pre 1.6). If this backup contains any non-ISO-8859-1 texts then they may be CORRUPTED if you try to restore them to this Unicode version of Moodle. See the <a href="http://docs.moodle.org/en/Backup_FAQ">Backup FAQ</a> for more information about how to recover this backup correctly.
* There are six different language translations for that page. So, you can only replace this address if your language is one of these.
===Other internet addresses after <a href="http://===
* You must proceed as with Moodle Docs addresses:
* Example:
auth_radius | auth_radiusdescription
This method uses a <a href="http://en.wikipedia.org/wiki/RADIUS">RADIUS</a> server to check whether a given username and password is valid.
* You must check the (English language wikipedia) page about the RADIUS server, and then you can decide whether to keep this address or replace it with your own language matching wikipedia translation.
===HTML codes that must not be translated===
The following HTML codes are reserved words that must not be translated. However, it is important for the translators to understand their meaning in order to decide whether to keep them in the translation and if so, whether they can be rearranged.
* <syntaxhighlight lang="php">&nbsp</syntaxhighlight> - non-breaking space i.e. a space but there will never be a line-break inserted instead of this space at the end of a line.
* <syntaxhighlight lang="php">&ensp</syntaxhighlight> and <syntaxhighlight lang="php">&emsp</syntaxhighlight> - denote an en space and an em space respectively, where an en space is half the point size and an em space is equal to the point size of the current font. For fixed pitch fonts, the user agent can treat the en space as being equivalent to a single space character, and the em space as being equuivalent to two space characters.
* <syntaxhighlight lang="php">&amp</syntaxhighlight> - ampersand sign (&)
* <syntaxhighlight lang="php">&apos</syntaxhighlight> - apostrophe sign (')
* <syntaxhighlight lang="php">&copy</syntaxhighlight> - copyright sign (©)
* <syntaxhighlight lang="php">&plusmn</syntaxhighlight> - "plus or minus" sign (±)
* <syntaxhighlight lang="php">&times</syntaxhighlight> - multiply sign (*)
* <syntaxhighlight lang="php">&divide</syntaxhighlight> - divide sign (/)
* <syntaxhighlight lang="php">&gt</syntaxhighlight> - "greater than" sign ( > )
* <syntaxhighlight lang="php">&lt</syntaxhighlight> - "less than" sign (<)
* <syntaxhighlight lang="php">&laquo</syntaxhighlight> - quotation mark (‘)
* <syntaxhighlight lang="php">&lsquo</syntaxhighlight> - left single quotation sign (‘)
* <syntaxhighlight lang="php">&rsquo</syntaxhighlight> - right single quotation sign (’)
* <syntaxhighlight lang="php">&ouml</syntaxhighlight> - small letter o with diaeresis (ö)
* <syntaxhighlight lang="php">&mdash</syntaxhighlight> - [https://en.wikipedia.org/wiki/Dash#Em_dash em dash] sign (—)
===Calculation functions must not be translated===
[https://docs.moodle.org/32/en/Grade_calculations#Calculation_functions Calculation functions] start with an equal sign (=). Following is an expression using operators and functions supported by the system.
[[File:DO NOT translate calculation functions.png]]
===The 'thisdirection' and 'thisdirectionvertical' strings in core_langconfig should never be translated===
'''The 'thisdirection' and 'thisdirectionvertical' strings in core_langconfig should never be translated, as they are not variables meant to be translated. They are prefixing selectors used by the themes to display left-to-right or right-to-left languages. Read [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 more about problems with these variables].
===MoodleBox===
The word 'MoodleBox' must be kept in all languages.
===Safe Exam Browser===
A feedback by the Safe Exam Browser main developer:
The software is called “Safe Exam Browser” in any language, we don’t translate the name of the application. So it doesn’t make sense to translate it in any plugin, you could use it as a subtitle or in brackets, like “Safe Exam Browser (Navegador de Examen Seguro)”.
==Is there a way to check the integrity of all placeholders in a language pack?==
* Not a at the moment. See MDL-51775 .
* You can use [https://lang.moodle.org/mod/forum/discuss.php?d=4661 this trick] to check for integrity:
** Load the language pack in a [https://download.moodle.org/windows/ local instance of Moodle].
** In order to generate a [https://lang.moodle.org/mod/forum/discuss.php?d=4098 translation memory], load the language pack in the [https://docs.moodle.org/29/en/Language_customisation Language customization] tool, so that the texts are loaded in the database.
** Run the sql instance in the file (tm_generator.txt)
** Insert the result of the query in template.tmx file
** The result is a translation memory that can be analysed with [http://www.opentag.com/okapi/wiki/index.php?title=CheckMate Checkmate].
** The problem: probably you will get many errors due to some characters that are not allowed by Checkmate so you will have to remove manually some translation units. After doing it, you will get a report with some possible errors (see the attached image).
** Of course, it would be great to have an integrated quality check system in Moodle. Vote for MDL-51775 .

* The contents of the file tm_generator.txt are ('''change the language from eu to your language'''):
SELECT concat('<tu tuid="',mdl_tool_customlang_components.name,'|',mdl_tool_customlang.stringid,'">
<tuv xml:lang="en"><seg>',mdl_tool_customlang.original,'</seg></tuv>
<tuv xml:lang="',mdl_tool_customlang.lang,'"><seg>',mdl_tool_customlang.master,'</seg></tuv>
</tu>') as txt
FROM mdl_tool_customlang INNER JOIN mdl_tool_customlang_components ON mdl_tool_customlang.componentid = mdl_tool_customlang_components.id
WHERE (((mdl_tool_customlang.lang)="eu") AND ((mdl_tool_customlang.original) Is Not Null) AND ((mdl_tool_customlang.master) <>mdl_tool_customlang.original));
* the contents of the template.tmx file are:
<?xml version="1.0" encoding="UTF-8"?>
<tmx version="1.4"><header creationtool="SQLQuery" creationtoolversion="unknown" segtype="paragraph" o-tmf="unknown" adminlang="en" srclang="en" datatype="unknown"></header><body>
PLACE HERE THE RESULT OF THE SQL QUERY
</body>
</tmx>
==What is a ''translation memory'' and how can I create a translation memory out of a Moodle language pack?==
* Read the 'Is there a way to check the integrity of all placeholders in a language pack?' section above.
* See [https://lang.moodle.org/mod/forum/user.php?id=1489&page=1 this post] and [https://dl.dropboxusercontent.com/u/86242384/moodle/en/publish/moodle_tm/website_index.html this tutorial].
==How can I help with translating Moodle documentation?==
Please see the guide [[Translating Moodle Docs]].
==How can I find out the context of the strings?==
You can find where a language string is located as described in the user docs [[:en:Language_customisation#Finding_the_component_and_string_identifier|Finding the component and string identifier]] and [[:en:Language FAQ|Language FAQ]].

You may wish to use two windows (perhaps using two monitors), with one displaying the page in English and the other displaying the page in your language.

[[File:two windows translation.jpg|Two simultaneous windows in two languages|800px]]

If you think the original English language strings have more than one meaning and you can't guess which one applies, you are welcome to post in the [https://lang.moodle.org/mod/forum/view.php?id=5 AMOS translation forum].
==Is there a list of Moodle error messages which can be translated?==
Error messages are listed in the user docs [[:en:Category:Error|Category:Error]].
==Can the subtitles for Moodle HQ YouTube videos be translated?==
Unfortunately this is currently not possible. For details, see [[Translating Moodle video subtitles]].
==Can the User Tours from Moodle.net be translated?==
* Yes. See [[Translating User tours from Moodle.net]]
==How can I test my plugins translations of several (different) Moodle branches?==
*Linux
** You can have several Moodle branches in one Ubuntu (or any other Linux distro) machine by following [https://docs.moodle.org/31/en/Step-by-step_Installation_Guide_for_Ubuntu#Hosting_several_Moodle_branches_in_one_Ubuntu_server these steps].

* Windows
** You can have several [https://download.moodle.org/windows/ local Moodle servers] in different folders in a Windows (7,8,10) PC. It is very easy to start one branch server, work on it, stop it and then start a different branch.
{{Note|Some early local Moodle (versions before 3.0) server packages from [https://download.moodle.org/windows/ https://download.moodle.org/windows/] only work in Windows 7, but apparently not in Windows 8 and definitely not in Windows 10, regardless of compatibility settings. For these you would need to install XAMP separately. Moodle 3.0 and newer branches do work under Windows 10.}}
*Mac
**We need to write about this...
==Can I translate a language pack offline / can I use another language then English as source language?==
Yes you can, but it is not recommended because there is a high risk of causing problems (remember - sites update language packs automatically, so your problem spreads quickly over the world).
One problem is that you absolutely have to avoid untranslated strings or strings in the wrong language in the language pack. This should NEVER happen. Another problem is that there is no way to know which strings are already translated. There is also a higher risk for syntax errors. If you have to, you can follow the following procedure:
* download the English language pack (or another one if you want a different source language)
* translate directly in the php file, preferably using something with syntax highlighting (Geany, Gedit, Notepad++ on Windows, ...)
* IMPORTANT: delete all not-translated lines from the file, before uploading - therefore it is probably best to translate line by line and keep the original source files, so you can work with a record of processed line numbers.
* import the files in the translation portal following the manual on https://docs.moodle.org/dev/AMOS_manual#Importing_a_file (IMPORTANT: zip file cannot contain any folders)
==How can I translate H5P content types?==
Use [https://translate-h5p.tk/weblate/projects/h5p/ the Weblate H5P project translation page] or see the h5p.org guide [https://h5p.org/adding-content-type-translation-via-github Adding content type translations via GitHub] and the forum discussion [https://moodle.org/mod/forum/discuss.php?d=414325 Translate H5P items].
==See also==
* [[:en:Language customization|Language customization]] in the user docs for information on how to edit an existing language pack
* [[String Deprecation]] is introduced in Moodle 2.8 to help minimize the language files but avoid accidental lost of translations by simply removing strings.
* [https://lang.moodle.org/mod/forum/discuss.php?d=4098#p4879 Generating a translation memory and running a quality test] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=347843 translation in context] forum discussion
[[de:Übersetzung FAQ]]

Maintaining a language pack

2021-04-11T11:53:07Z

Koen: No more propagate button

{{Translation}}
==Volunteering to become a language pack maintainer==

If your language currently doesn't have a language pack maintainer, and you would like to volunteer, please [http://lang.moodle.org/login/signup.php create an account on the Translation site] and contact our Moodle translation coordinator, Koen Roggemans, [mailto:translation@moodle.org translation@moodle.org].

== The role of language pack maintainer==
A language pack maintainer for a Moodle language pack takes responsibility for that language pack. It means contributing to the translation, reviewing contributions of other contributors and approving, improving or rejecting them within a reasonable time frame. The language pack maintainer must pay special attention to the consistency of all Moodle and other terminology all over the language pack. He/She must also pay special attention to the technical correctness of what goes in the language pack since problematic strings can ultimately cause a site in that language to break.

The aim of a language pack maintainer is to get the language pack complete for a standard Moodle installation.

== Steps for the maintainer, making own contributions==

# Use AMOS translator interface to translate missing strings or amend the current translation
# Go to the Stage page
# Make a meaningful comment about your work in the 'Commit message' form
# Click on 'Commit'

== Approving contributions from others==

AMOS allows community members to help with the translation of Moodle strings.
[[image:amos-screenshot-contribution-details.png|300px|thumb|right|Contribution details page]]
# When a user submits a new contribution, you will receive an automatically generated email from AMOS containing a link to the contribution.
# Press 'Start review' button. That will assign the contribution to yourself, change the status from 'New' to 'In review', send an automatically generated email to the contributor and will copy the submitted strings into your stage. You should check that your stage is empty before you apply the submitted strings unless you want to merge several contributions into one commit.
# Review the submitted strings, eventually edit them. Commit the stage. It is nice to mention the contributor's name in the commit message and attribute the original authorship to them.
# Go back to the contribution record and change the status to Accepted or Rejected. An automatically generated email will be sent to the contributor whenever you change the status.
# Use contribution record comments for further communication with the contributor about the submitted translation.
# Accepted and Rejected contributions are not shown at the contributions page unless you click the 'Show resolved contributions' button.
# You will get a weekly reminder of contributed strings that are not processed yet.

==Translating strings offline==

You can use the [[:en:Language customization|Language customisation]] tool in your local Moodle server to enhance the translation of language strings for the Moodle core files.
If you want to translate the strings of a particular plugin, you must have that plugin installed on your server first.
Your translated files will be located inside the local language folder in your Moodle server.
You can upload these files to AMOS, one file at a time, or zip many files and upload the zip file (which will be un-zipped automatically inside AMOS).

==Uploading a file of translations==

To avoid making changes one by one, you can do your translations offline (as above) and upload them to AMOS.
# Click 'Stage' in the Navigation block.
# Choose 'Import translated strings from file'.
# Dag and drop the file.
# Click the 'Import' button.

*Note: You can import several files at once if you zip them first and upload the zip file. The zip file is not allowed to contain any folders, only files.

==See also==
* [[AMOS manual]] for further information about the AMOS translation toolkit
* [[:en:Language packs|Language packs]] user documentation

Translation langconfig

2020-12-12T12:15:45Z

Koen: /* locale,core_langconfig */ adding cldr

{{Translation}}
Langconfig is an important file in a language pack, dealing with all the configuration parameters of that language. It is good practice to review this first when starting of a new language pack or when taking on responsibility of an existing language pack. You can edit it by going to lang.moodle.org and find it as the core_langconfig component for your language.

On this page you find a little documentation for each setting to help you deciding what should go there for your language.

===alphabet,core_langconfig===
The alphabet in your language. Used e.g. for the list of letters on the participants page.

===backupnameformat,core_langconfig===
===decsep,core_langconfig===
How decimals are separated in your language. [http://en.wikipedia.org/wiki/Decimal_separator Usually a dot or a comma]. Take note that some countries which seem to share the same language may have a different character to separate the integer part from the fractional part of a number written in decimal form. e.g. Central American Spanish-speaking countries use the decimal point, while South American Spanish-speaking countries use the decimal comma.

Example:
* English: 36.5
* Dutch: 36,5

===firstdayofweek,core_langconfig===
The first day of the week in your language. Allowed values are 0,1,2,3,4,5,6, where 0 stands for Sunday.

===iso6391,core_langconfig===
The ISO 639.1 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Wikipedia].

===iso6392,core_langconfig===
The ISO 639.2 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes Wikipedia].

===labelsep,core_langconfig===
How a label is separated from a form. Could be a colon, a space and a colon or something different, according to what's generally used in your language. This character is not read by screen readers for accessibility reasons.

===listsep,core_langconfig===
The symbol usually used in your language, for separating items in a list. This is used e.g. when using formulas with multiple items in the gradebook. This must be a symbol different from the decsep symbol.

===locale,core_langconfig===
locale for *nix servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language)

{{Note|Locales, used in language packs should come only from the table of locales at https://docs.moodle.org/dev/Table_of_locales and the list at https://docs.moodle.org/dev/List_of_locales_supported_on_Moodle_community_servers}}

An unsupported locale in a Mac or Linux site will produce the following error when you try to update your language pack:

[[File:Unsupported locale mac.png|400px]]

And, more important, it may produce an intermitent 'undefined' error message:

[[File:ERROR undefined.png|400px]]

===localecldr,core_lanconfig===

See http://cldr.unicode.org/index/cldr-spec/picking-the-right-language-code

===localewin,core_langconfig===
locale for Windows servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language). There are quite a few languages that are not supported by Windows servers and the localewin server can not be set. In that case, you have to run your Moodle on a *nix server to make the translation of your Moodle calendar work

===localewincharset,core_langconfig===
The character set to use when Moodle is installed on a Windows server

===oldcharset,core_langconfig===
Necessary to upgrade from prior to 1.6. This string defines the charset used in 1.5 and earlier for this language pack. For language packs that start later then Moodle 1.5, this can be left empty

===parentlanguage,core_langconfig===
The original Moodle default Australian language pack has this field empty (as the Australian English language IS the official Moodle language).

If your language pack relies on another one (it is a 'child' language of a 'parent' language), then this is the place to point out which language pack. '''For most language packs, this should be left empty''', to default to English if strings are missing.

Example: Canadian French (fr_ca) is mostly the same as French (fr) apart from a few changes. Creating a language pack with as parent language French will shop French if a string does not exist in the language pack Canadian French. If a string doesn't exist in both language packs, English is shown.

On the download page for the language packs (https://download.moodle.org/langpack/3.7/) you can see how many strings are different from the parent language pack. In Moodle 3.7, Canadian French had 998 changes from French.

{{Note|Using language customization for parentlanguage inside langconfig.php in an existing Moodle server, where you add a parent language (while the AMOS parentlanguage string is actually empty) will ask for the installation of said parent language in the server, but will not substitute the missing translations in the child language with those of the parent language; English will be shown. Surgically editing (a dangerous, never recommended procedure) the langconfig.php file of the server would work, until the next language pack update -manual or cron made- erases the change.}}

===strftimedate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===strftimedatefullshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedateshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetimeshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedayshort,core_langconfig===
How time and day are displayed in short in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaytime,core_langconfig===
How time and day are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimemonthyear,core_langconfig===
How month and year are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecent,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecentfull,core_langconfig===
How time and date are displayed for recent activities in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimetime,core_langconfig===
How time is displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===thisdirection,core_langconfig===
In which direction your language should be displayed on the screen. The only possible options are ltr (left to right) or rtl (right to left).'''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thisdirectionvertical,core_langconfig===
How text that is printed vertical on the screen is oriënted (like in a docked block).

The only possible values can be btt (bottom to top) or ttb (top to bottom). '''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thislanguage,core_langconfig===
The name of your language in your own language

===thislanguageint,core_langconfig===
The name of your language in English

===thousandssep,core_langconfig===
How you separate thousands in your language.
Important: this can not be a space (more information in discussion http://lang.moodle.org/mod/forum/discuss.php?d=1450#p1730). If you want a space, you can try with &nbsp; but that is not fully tested yet.

Example:
* in Dutch 1.000.000 (with a dot)
* in English 1,000,000 (with a comma)

[[Category:Language]]

[[es:Langconfig]]

Translation langconfig

2020-12-12T12:15:02Z

Koen: /* locale,core_langconfig */

{{Translation}}
Langconfig is an important file in a language pack, dealing with all the configuration parameters of that language. It is good practice to review this first when starting of a new language pack or when taking on responsibility of an existing language pack. You can edit it by going to lang.moodle.org and find it as the core_langconfig component for your language.

On this page you find a little documentation for each setting to help you deciding what should go there for your language.

===alphabet,core_langconfig===
The alphabet in your language. Used e.g. for the list of letters on the participants page.

===backupnameformat,core_langconfig===
===decsep,core_langconfig===
How decimals are separated in your language. [http://en.wikipedia.org/wiki/Decimal_separator Usually a dot or a comma]. Take note that some countries which seem to share the same language may have a different character to separate the integer part from the fractional part of a number written in decimal form. e.g. Central American Spanish-speaking countries use the decimal point, while South American Spanish-speaking countries use the decimal comma.

Example:
* English: 36.5
* Dutch: 36,5

===firstdayofweek,core_langconfig===
The first day of the week in your language. Allowed values are 0,1,2,3,4,5,6, where 0 stands for Sunday.

===iso6391,core_langconfig===
The ISO 639.1 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Wikipedia].

===iso6392,core_langconfig===
The ISO 639.2 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes Wikipedia].

===labelsep,core_langconfig===
How a label is separated from a form. Could be a colon, a space and a colon or something different, according to what's generally used in your language. This character is not read by screen readers for accessibility reasons.

===listsep,core_langconfig===
The symbol usually used in your language, for separating items in a list. This is used e.g. when using formulas with multiple items in the gradebook. This must be a symbol different from the decsep symbol.

===locale,core_langconfig===
locale for *nix servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language)

{{Note|Locales, used in language packs should come only from the table of locales at https://docs.moodle.org/dev/Table_of_locales and the list at https://docs.moodle.org/dev/List_of_locales_supported_on_Moodle_community_servers}}

An unsupported locale in a Mac or Linux site will produce the following error when you try to update your language pack:

[[File:Unsupported locale mac.png|400px]]

And, more important, it may produce an intermitent 'undefined' error message:

[[File:ERROR undefined.png|400px]]

===localecldr,core_lanconfig

See http://cldr.unicode.org/index/cldr-spec/picking-the-right-language-code

===localewin,core_langconfig===
locale for Windows servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language). There are quite a few languages that are not supported by Windows servers and the localewin server can not be set. In that case, you have to run your Moodle on a *nix server to make the translation of your Moodle calendar work

===localewincharset,core_langconfig===
The character set to use when Moodle is installed on a Windows server

===oldcharset,core_langconfig===
Necessary to upgrade from prior to 1.6. This string defines the charset used in 1.5 and earlier for this language pack. For language packs that start later then Moodle 1.5, this can be left empty

===parentlanguage,core_langconfig===
The original Moodle default Australian language pack has this field empty (as the Australian English language IS the official Moodle language).

If your language pack relies on another one (it is a 'child' language of a 'parent' language), then this is the place to point out which language pack. '''For most language packs, this should be left empty''', to default to English if strings are missing.

Example: Canadian French (fr_ca) is mostly the same as French (fr) apart from a few changes. Creating a language pack with as parent language French will shop French if a string does not exist in the language pack Canadian French. If a string doesn't exist in both language packs, English is shown.

On the download page for the language packs (https://download.moodle.org/langpack/3.7/) you can see how many strings are different from the parent language pack. In Moodle 3.7, Canadian French had 998 changes from French.

{{Note|Using language customization for parentlanguage inside langconfig.php in an existing Moodle server, where you add a parent language (while the AMOS parentlanguage string is actually empty) will ask for the installation of said parent language in the server, but will not substitute the missing translations in the child language with those of the parent language; English will be shown. Surgically editing (a dangerous, never recommended procedure) the langconfig.php file of the server would work, until the next language pack update -manual or cron made- erases the change.}}

===strftimedate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===strftimedatefullshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedateshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetimeshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedayshort,core_langconfig===
How time and day are displayed in short in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaytime,core_langconfig===
How time and day are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimemonthyear,core_langconfig===
How month and year are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecent,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecentfull,core_langconfig===
How time and date are displayed for recent activities in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimetime,core_langconfig===
How time is displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===thisdirection,core_langconfig===
In which direction your language should be displayed on the screen. The only possible options are ltr (left to right) or rtl (right to left).'''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thisdirectionvertical,core_langconfig===
How text that is printed vertical on the screen is oriënted (like in a docked block).

The only possible values can be btt (bottom to top) or ttb (top to bottom). '''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thislanguage,core_langconfig===
The name of your language in your own language

===thislanguageint,core_langconfig===
The name of your language in English

===thousandssep,core_langconfig===
How you separate thousands in your language.
Important: this can not be a space (more information in discussion http://lang.moodle.org/mod/forum/discuss.php?d=1450#p1730). If you want a space, you can try with &nbsp; but that is not fully tested yet.

Example:
* in Dutch 1.000.000 (with a dot)
* in English 1,000,000 (with a comma)

[[Category:Language]]

[[es:Langconfig]]

Table of locales

2020-03-20T09:13:37Z

Koen: shorter and more robust locale installation for Ubuntu servers

==Introduction==
'''Definition:''' (from [http://en.wikipedia.org/wiki/Locale Wikipedia]) Locale is a set of parameters that defines the user's language, country and any special variant preferences that the user wants to see in their user interface. Usually a locale identifier consists of at least a language identifier and a region identifier.

Actually, the one and only place where Moodle requires some locales to be installed on the machine is when handling date translation (according to [https://tracker.moodle.org/browse/MDL-31622 this information]).

Currently such locales are named differently under Unix-based and Win32-based platforms so we need to have them defined separately to allow Moodle to use them as necessary. For each '''lang package''' available for Moodle, we must specify the '''locale''' value (Unix locale) and the ''localewin''' value (Win32 locale). Both those strings should be (no mandatory) defined inside each Moodle 1.6 and upwards langpack to be able to display locale strings properly.

The general syntax for locales is:

language[_country][.charset]

(with information under brackets being optional)

While the '''.charset''' part seems to work properly under Unix, it seems that is not working under Win32 (at least from PHP), and strings returned from some PHP functions aren't in the charset specified but in some sort of default charset. Let's call it '''localewincharset'''. This forces us to convert from this charset to the current_charset() being used by the user.

==Support in operating systems==
Just in case you freshly installed some new locales and they don't seem to work don't forget to restart your webserver.

===openSUSE===
* SUSE linux 10.1 contains all necessary locales in default installation

===Ubuntu based===
The default installation contains only limited number of locales. You can generate all locales on server from command line:

sudo apt install locales-all && sudo locale-gen

===Debian based===
The default installation contains only a limited number of locales. You can generate the locales you need on your server from the command line. Login as root and execute:

dpkg-reconfigure locales

choose the ones you need and press OK, next select the default locale for your server and press OK.

===MoodleBox===
You can add locales by typing in the MoodleBox console:
sudo dpkg-reconfigure locales

===FreeBSD===
All 5.x and later versions should already contain a large number of supported locales with utf-8 charset.

===MacOS===
Mac OS support for many locales is very poor. There is no easy way to add new locales to a Mac OS.

You can find the installed locales by issuing the following command in a Mac:

locale -a

Some people have attempted digital surgery to install a needed Mac locale, by copying an existing locale into a new file. You should really edit the newly copied file in order to make the changes needed from the source file in order to adapt to your real local settings (like currency). See [https://stackoverflow.com/questions/9991603/add-a-locale-in-mac-osx this site] and [https://lh.2xlibre.net/locales/ this one] and [https://lh.2xlibre.net/locale/es_MX/glibc/ this one too].

===MS Windows===
There is no way to add new locales, see following table for list of supported locales.

==Table==

So, for each 1.6 Moodle language pack, we'll describe below this columns:
* '''package_name:''' name of the language pack as shown in http://download.moodle.org/lang16/.
* '''lang_name:''' name of the language as shown in http://download.moodle.org/lang16/.
* '''locale:''' locale string to be used under Unix platforms. This will be stored in each language '''langconfig.php''' file.
* '''localewin:''' locale string to be used under Win32 platforms. This will be stored in each language '''langconfig.php''' file.
* '''localewincharset:''' charset in which PHP is retrieving information from locale-dependent functions (strftime...). This will allow us to convert such strings to the final charset properly. This will be stored in each language '''langconfig.php''' file.

<table align="center" border="1" cellpadding="5">
<tr>
<th>'''package_name'''</th>
<th>'''lang_name'''</th>
<th>'''locale'''</th>
<th>'''localewin'''</th>
<th>'''localewincharset</th></tr>
<tr>
<td>af_utf8</td>
<td>Afrikaans</td>
<td>af_ZA.UTF-8</td>
<td>Afrikaans_South Africa.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>sq_utf8</td>
<td>Albanian</td>
<td>sq_AL.UTF-8</td>
<td>Albanian_Albania.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>ar_utf8</td>
<td>Arabic</td>
<td>ar_SA.UTF-8</td>
<td>Arabic_Saudi Arabia.1256</td>
<td>WINDOWS-1256</td></tr>
<tr>
<td>eu_utf8</td>
<td>Basque</td>
<td>eu_ES.UTF-8</td>
<td>Basque_Spain.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>be_utf8</td>
<td>Belarusian</td>
<td>be_BY.UTF-8</td>
<td>Belarusian_Belarus.1251</td>
<td>WINDOWS-1251</td></tr>
<tr>
<td>bs_utf8</td>
<td>Bosnian</td>
<td>bs_BA.UTF-8</td>
<td>Bosnian (Latin)</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>bg_utf8</td>
<td>Bulgarian</td>
<td>bg_BG.UTF-8</td>
<td>Bulgarian_Bulgaria.1251</td>
<td>WINDOWS-1251</td></tr>
<tr>
<td>ca_utf8</td>
<td>Catalan</td>
<td>ca_ES.UTF-8</td>
<td>Catalan_Spain.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>hr_utf8</td>
<td>Croatian</td>
<td>hr_HR.UTF-8</td>
<td>Croatian_Croatia.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>zh_cn_utf8</td>
<td>Chinese (Simplified)</td>
<td>zh_CN.UTF-8</td>
<td>Chinese_China.936</td>
<td>CP936</td></tr>
<tr>
<td>zh_tw_utf8</td>
<td>Chinese (Traditional)</td>
<td>zh_TW.UTF-8</td>
<td>Chinese_Taiwan.950</td>
<td>CP950</td></tr>
<tr>
<td>cs_utf8</td>
<td>Czech</td>
<td>cs_CZ.UTF-8</td>
<td>Czech_Czech Republic.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>da_utf8</td>
<td>Danish</td>
<td>da_DK.UTF-8</td>
<td>Danish_Denmark.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>nl_utf8</td>
<td>Dutch</td>
<td>nl_NL.UTF-8</td>
<td>Dutch_Netherlands.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>en_utf8</td>
<td>English</td>
<td>en.UTF-8</td>
<td>English_Australia.1252</td>
<td>-empty string-</td></tr>
<tr>
<td>en_us_utf8</td>
<td>English (US)</td>
<td>-parent en_utf8 used-</td>
<td>-parent en_utf8 used-</td>
<td>-parent en_utf8 used-</td></tr>
<tr>
<td>et_utf8</td>
<td>Estonian</td>
<td>et_EE.UTF-8</td>
<td>Estonian_Estonia.1257</td>
<td>WINDOWS-1257</td></tr>
<tr>
<td>fa_utf8</td>
<td>Farsi</td>
<td>fa_IR.UTF-8</td>
<td>Farsi_Iran.1256</td>
<td>WINDOWS-1256</td></tr>
<tr>
<td>fil_utf8</td>
<td>Filipino</td>
<td>fil_PH.UTF-8</td>
<td>Filipino_Philippines.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>fi_utf8</td>
<td>Finnish</td>
<td>fi_FI.UTF-8</td>
<td>Finnish_Finland.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>fr_utf8</td>
<td>French</td>
<td>fr_FR.UTF-8 ''or'' fr_CH.UTF-8 ''or'' fr_BE.UTF-8</td>
<td>French_France.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>fr_ca_utf8</td>
<td>French (Canada)</td>
<td>fr_CA.UTF-8</td>
<td>French_Canada.1252</td>
<td>-parent fr_utf8 used-</td></tr>
<tr>
<td>ga_utf8</td>
<td>Gaelic</td>
<td>ga.UTF-8</td>
<td>Gaelic; Scottish Gaelic</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>gl_utf8</td>
<td>Gallego</td>
<td>gl_ES.UTF-8</td>
<td>Galician_Spain.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>ka_utf8</td>
<td>Georgian</td>
<td>ka_GE.UTF-8</td>
<td>Georgian_Georgia.65001</td>
<td>-empty string-</td></tr>
<tr>
<td>de_utf8</td>
<td>German</td>
<td>de_DE.UTF-8</td>
<td>German_Germany.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>de_du_utf8</td>
<td>German (Personal)</td>
<td>de_DE.UTF-8</td>
<td>-parent de_utf8 used-</td>
<td>-parent de_utf8 used-</td></tr>
<tr>
<td>el_utf8</td>
<td>Greek</td>
<td>el_GR.UTF-8</td>
<td>Greek_Greece.1253</td>
<td>WINDOWS-1253</td></tr>
<tr>
<td>gu_utf8</td>
<td>Gujarati</td>
<td>gu.UTF-8</td>
<td>Gujarati_India.0</td>
<td> </td></tr>
<tr>
<td>he_utf8</td>
<td>Hebrew</td>
<td>he_IL.utf8</td>
<td>Hebrew_Israel.1255</td>
<td>WINDOWS-1255</td></tr>
<tr>
<td>hi_utf8</td>
<td>Hindi</td>
<td>hi_IN.UTF-8</td>
<td>Hindi.65001</td>
<td>-empty string-</td></tr>
<tr>
<td>hu_utf8</td>
<td>Hungarian</td>
<td>hu.UTF-8</td>
<td>Hungarian_Hungary.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>is_utf8</td>
<td>Icelandic</td>
<td>is_IS.UTF-8</td>
<td>Icelandic_Iceland.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>id_utf8</td>
<td>Indonesian</td>
<td>id_ID.UTF-8</td>
<td>Indonesian_indonesia.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>it_utf8</td>
<td>Italian</td>
<td>it_IT.UTF-8</td>
<td>Italian_Italy.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>ja_utf8</td>
<td>Japanese</td>
<td>ja_JP.UTF-8</td>
<td>Japanese_Japan.932</td>
<td>CP932</td></tr>
<tr>
<td>kn_utf8</td>
<td>Kannada</td>
<td>kn_IN.UTF-8</td>
<td>Kannada.65001</td>
<td>-empty string-</td></tr>
<tr>
<td>km_utf8</td>
<td>Khmer</td>
<td>km_KH.UTF-8</td>
<td>Khmer.65001</td>
<td>-empty string-</td></tr>
<tr>
<td>ko_utf8</td>
<td>Korean</td>
<td>ko_KR.UTF-8</td>
<td>Korean_Korea.949</td>
<td>EUC-KR</td></tr>
<tr>
<td>lo_utf8</td>
<td>Lao</td>
<td>lo_LA.UTF-8</td>
<td>Lao_Laos.UTF-8</td>
<td>WINDOWS-1257</td></tr>
<tr>
<td>lt_utf8</td>
<td>Lithuanian</td>
<td>lt_LT.UTF-8</td>
<td>Lithuanian_Lithuania.1257</td>
<td>WINDOWS-1257</td></tr>
<tr>
<td>lv_utf8</td>
<td>Latvian</td>
<td>lat.UTF-8</td>
<td>Latvian_Latvia.1257</td>
<td>WINDOWS-1257</td></tr>
<tr>
<td>ml_utf8</td>
<td>Malayalam</td>
<td>ml_IN.UTF-8</td>
<td>Malayalam_India.x-iscii-ma</td>
<td>x-iscii-ma</td></tr>
<tr>
<td>ms_utf8</td>
<td>Malaysian</td>
<td>ms_MY.UTF-8</td>
<td>Malay_malaysia.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>mi_tn_utf8</td>
<td>Maori (Ngai Tahu)</td>
<td>mi_NZ.UTF-8</td>
<td>Maori.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>mi_wwow_utf8</td>
<td>Maori (Waikoto Uni)</td>
<td>mi_NZ.UTF-8</td>
<td>Maori.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>mn_utf8</td>
<td>Mongolian</td>
<td>mn.UTF-8</td>
<td>Cyrillic_Mongolian.1251</td>
<td></tr>
<tr>
<td>no_utf8</td>
<td>Norwegian</td>
<td>no_NO.UTF-8</td>
<td>Norwegian_Norway.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>no_gr_utf8</td>
<td>Norwegian (Primary)</td>
<td>no_NO.UTF-8</td>
<td>-parent no_utf8 used-</td>
<td>-parent no_utf8 used-</td></tr>
<tr>
<td>nn_utf8</td>
<td>Nynorsk</td>
<td>nn_NO.UTF-8</td>
<td>Norwegian-Nynorsk_Norway.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>pl_utf8</td>
<td>Polish</td>
<td>pl.UTF-8</td>
<td>Polish_Poland.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>pt_utf8</td>
<td>Portuguese</td>
<td>pt_PT.UTF-8</td>
<td>Portuguese_Portugal.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>pt_br_utf8</td>
<td>Portuguese (Brazil)</td>
<td>pt_BR.UTF-8</td>
<td>Portuguese_Brazil.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>ro_utf8</td>
<td>Romanian</td>
<td>ro_RO.UTF-8</td>
<td>Romanian_Romania.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>ru_utf8</td>
<td>Russian</td>
<td>ru_RU.UTF-8</td>
<td>Russian_Russia.1251</td>
<td>WINDOWS-1251</td></tr>
<tr>
<td>sm_utf8</td>
<td>Samoan</td>
<td>mi_NZ.UTF-8</td>
<td>Maori.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>sr_utf8</td>
<td>Serbian</td>
<td>sr_CS.UTF-8</td>
<td>Bosnian(Cyrillic), Serbian (Cyrillic)</td>
<td>WINDOWS-1251</td></tr>
<tr>
<td>sk_utf8</td>
<td>Slovak</td>
<td>sk_SK.UTF-8</td>
<td>Slovak_Slovakia.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>sl_utf8</td>
<td>Slovenian</td>
<td>sl_SI.UTF-8</td>
<td>Slovenian_Slovenia.1250</td>
<td>WINDOWS-1250</td></tr>
<tr>
<td>so_utf8</td>
<td>Somali</td>
<td>so_SO.UTF-8</td>
<td>not found!</td>
<td>not found!</td></tr>
<tr>
<td>es_utf8</td>
<td>Spanish (International)</td>
<td>es_ES.UTF-8</td>
<td>Spanish_Spain.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>sv_utf8</td>
<td>Swedish</td>
<td>sv_SE.UTF-8</td>
<td>Swedish_Sweden.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>tl_utf8</td>
<td>Tagalog</td>
<td>tl.UTF-8</td>
<td>not found!</td>
<td>not found!</td></tr>
<tr>
<td>ta_utf8</td>
<td>Tamil</td>
<td>ta_IN.UTF-8</td>
<td>English_Australia.1252</td>
<td></td></tr>
<tr>
<td>th_utf8</td>
<td>Thai</td>
<td>th_TH.UTF-8</td>
<td>Thai_Thailand.874</td>
<td>WINDOWS-874</td></tr>
<tr>
<td>to_utf8</td>
<td>Tongan</td>
<td>mi_NZ.UTF-8'</td>
<td>Maori.1252</td>
<td>WINDOWS-1252</td></tr>
<tr>
<td>tr_utf8</td>
<td>Turkish</td>
<td>tr_TR.UTF-8</td>
<td>Turkish_Turkey.1254</td>
<td>WINDOWS-1254</td></tr>
<tr>
<td>uk_utf8</td>
<td>Ukrainian</td>
<td>uk_UA.UTF-8</td>
<td>Ukrainian_Ukraine.1251</td>
<td>WINDOWS-1251</td></tr>
<tr>
<td>vi_utf8</td>
<td>Vietnamese</td>
<td>vi_VN.UTF-8</td>
<td>Vietnamese_Viet Nam.1258</td>
<td>WINDOWS-1258</td></tr>
</table>

'''Note:''' Some locales for windows in red could be incorrect (technically or geographically but they are the only way I've found to show dates properly in my XP box). Also some other coloured cells must be revised because they are not working.

== References ==

=== Windows===

* Win32 Language names: http://msdn.microsoft.com/en-us/library/dd318693.aspx
* Win32 Country names: http://msdn.microsoft.com/en-us/library/cdax410z.aspx
* Win32 Codepage codes: http://www.microsoft.com/globaldev/reference/wincp.mspx
* Win32 NLS Reference: http://msdn.microsoft.com/es-es/goglobal/bb896001.aspx
* Languages and codepages: http://www.science.co.il/Language/Locale-Codes.asp
* More languages and codepages: http://code.cside.com/3rdpage/windows/
* Languages and locales: http://www.livio.net/main/charset.asp
* Table of language identifiers: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/intl/nls_238z.asp

===Unix===

* Unix Language names: http://www.loc.gov/standards/iso639-2/englangn.html (639-2 is used only if 639-1 doesn't exist, see the "Locale Name Guide" below).
* Unix Country names: http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html
* Unix Charset codes: http://www.w3.org/International/O-charset-list.html
* More locales: http://search.cpan.org/~drolsky/DateTime-Locale-0.42/lib/DateTime/Locale/Catalog.pm

===Other Information===
* [[List of locales supported on Moodle community servers]]
* Locale Name Guide: http://openi18n.org/docs/text/LocNameGuide-V10.txt
* FAQ about ISO 639: http://www.loc.gov/standards/iso639-2/faq.html
* One initiative from Unicode: http://www.unicode.org/cldr/index.html
* Weekdays and Months: http://www.domesticat.net/misc/monthsdays.php

[[Category:Language]]
[[Category:UTF-8]]

Contributing a translation

2019-11-17T16:50:09Z

Koen: /* Tips and Tricks */ more guidelines to prevent unnecessary load on language pack maintainers and improve quality of contributions.

{{Translation}}
The [http://lang.moodle.org Translation site] enables translators to work collaboratively on language packs using a special Moodle translation tool called ''AMOS''. If you see an error or non-translated term in Moodle in your language, you can contribute a correction or translation via the Translation site.

When contributing, the quality of your work is more important then the quantity. Make sure spelling, grammar, capitals and punctuation are correct. Only use terminology consistent with the rest of the language pack. Don't make mistakes in technical parts of the strings, like variable placeholders, html etc. For these reasons, using automatic translation (e.g, Google Translate) is never good enough.

If you'd like to help translating more than just a few strings, please contact the maintainer of your language pack as listed in the [http://lang.moodle.org/local/amos/credits.php Translation credits]. (If you don't receive a reply within a reasonable time, contact our Moodle translation coordinator, Koen Roggemans, [mailto:translation@moodle.org translation@moodle.org].)

==Getting started with AMOS==

# [http://lang.moodle.org/login/signup.php Create an account on the Translation site] and log in.
# Click the link [http://lang.moodle.org/local/amos/view.php AMOS translator].
# In the Languages box, ''select your language''.
# In the Components box, find the language strings you wish to translate.
# Click the button 'Save filter settings'.
# Type your translation into the boxes on the right. When you click out of the box, it will turn blue and your text will be saved automatically.
# When you have finished translating, click the button at the bottom of the page 'Go to the stage'. Do no more than 30 strings at a time.
# Review your translation, then click the button 'Send strings to language pack maintainers'.
# (Optional) Add a message for the language pack maintainer explaining what you have done.

{|
|[[File:translate1.png|thumb|Add your translation]]
|[[File:translate2.png|thumb|Submit your translation]]
|}

Note: You only need to contribute translations for ONE version, as the translations are added automatically to other versions when your contribution is accepted. Simply leave 'Latest available version' ticked.

==What happens next==

The maintainer(s) of the language pack will receive notification of your contribution. It will be reviewed and then most likely added to the language pack. You will receive email notification when the status of your contribution changes i.e. when a maintainer begins their review and then when they accept or reject it. At any time you can use the contribution record comments to communicate with the maintainer about your submitted translation.

In addition, your name will then appear on the [http://lang.moodle.org Translation site] front page as a recent, valued contributor. Well done!

Once you have three contributions accepted, you are listed as a contributor in the [http://lang.moodle.org/local/amos/credits.php Translation credits].

==Tips and Tricks==
* If you are a bilingual (or multilingual) developer of a Moodle plugin, please send your strings of languages other than English to the language pack maintainer(s).
* Bear in mind that If a language pack maintainer gets a contribution with 250 strings of various modules, that is a nightmare to review :(
** It is better to send contributions of a few strings at a time.
** 30 strings of one module should really be the maximum, 10 strings from one module at a time is better :)
* Please note that '''there are some things that should never be translated''', such as Moodle placeholders and HTML variables. See [[Translation_FAQ#Are_there_items_which_are_not_to_be_translated.3F| Translation FAQ]]
* Please don't flood the language pack maintainer by sending the same strings more then once. If strings are in the contribution queue, they stay in the queue until the maintainer can review them.
* Never submit untranslated or half translated strings. Only good quality translations with checked spelling, correct punctuation, well formed sentences and consistent wording with the rest of the language pack are worth adding to the language pack.
* Never send strings that are translated already without improving them, e.g. by blindly uploading offline translated strings.
* Avoid a mix of newly translated strings and improved strings.

==See also==
* [[AMOS manual]] for further information about the AMOS translation toolkit
* [http://www.youtube.com/watch?v=XClUZOuFfWo| Video on how to contribute to a language pack]
* [[Improving English language strings]]

Maintaining a language pack

2019-11-01T12:02:13Z

Koen: adding a task description of a language pack maintainer

{{Translation}}
==Volunteering to become a language pack maintainer==

If your language currently doesn't have a language pack maintainer, and you would like to volunteer, please [http://lang.moodle.org/login/signup.php create an account on the Translation site] and contact our Moodle translation coordinator, Koen Roggemans, [mailto:translation@moodle.org translation@moodle.org].

== The role of language pack maintainer==
A language pack maintainer for a Moodle language pack takes the responsibility for that language pack. It means contributing to the translation, reviewing contributions of other contributors and approving, improving or rejecting them within a reasonable time frame. The language pack maintainer has special attention for the consistency of the used Moodle and other terminology all over the language pack. He/She pays also special attention to the technical correctness of what goes in the language pack, since problematic strings can ultimately cause a site in that language to break.

The aim of a language pack maintainer is to get the language pack complete for a standard Moodle installation.

== Steps for the maintainer, making own contributions==

# Use AMOS translator interface to translate missing strings or amend the current translation
# Go to the Stage page
# Click on the propagate button to add the translated strings to all versions of the language pack (this is usually the case)
# Make a meaningful comment about your work in the 'Commit message' form
# Click on 'Commit'

== Approving contributions from others==

AMOS allows community members to help with the translation of Moodle strings.
[[image:amos-screenshot-contribution-details.png|300px|thumb|right|Contribution details page]]
# When a user submits new contribution, you will receive an automatically generated email from AMOS containing a link to the contribution.
# Press 'Start review' button. That will assign the contribution to yourself, change the status from 'New' to 'In review', send automatically generated email to the contributor and will copy the submitted strings into your stage. You should check that your stage is empty before you apply the submitted strings, unless you want to merge several contributions into one commit.
# Review the submitted strings, eventually edit them. Commit the stage. It is nice to mention the contributor's name in the commit message and attribute the original authorship to them.
# Go back to the contribution record and change the status to Accepted or Rejected. An automatically generated email will be sent to the contributor whenever you change the status.
# Use contribution record comments for further communication with the contributor about the submitted translation.
# Accepted and Rejected contributions are not shown at the contributions page unless you click the 'Show resolved contributions' button.
# You will get a weekly reminder of contributed strings that are not processed yet.

==Translating strings offline==

You can use the [[:en:Language customization|Language customisation]] tool in your local Moodle server to enhance the translation of language strings for the Moodle core files.
If you want to translate the strings of a particular plugin, you must have that plugin installed in your server first.
Your translated files will be located inside the local language folder in your Moodle server.
You can upload these file to AMOS, one file at a time, or zip many files and upload the zip file (which will be un-zipped automatically inside AMOS).

==Uploading a file of translations==

To avoid making changes one by one, you can do your translations offline (as above) and upload them to AMOS.
# Click 'Stage' in the Navigation block.
# Choose 'Import translated strings from file'.
# Dag and drop the file.
# Click the 'Import' button.

*Note: You can import several files at once if you zip them first and upload the zip file. The zip file is not allowed to contain any folders, only files.

==See also==
* [[AMOS manual]] for further information about the AMOS translation toolkit
* [[:en:Language packs|Language packs]] user documentation

Translation FAQ

2019-08-03T13:22:37Z

Koen:

{{Translation}}
==How can I help with translating Moodle?==

Please see the guide [[Contributing a translation]].

==I've found an error in a language pack. What do I do?==

* You are welcome to [[Contributing a translation|contribute a fix]] for the error. Alternatively you can contact the language pack maintainer as listed in the [http://lang.moodle.org/local/amos/credits.php Translation credits].
* English language string typo fixes and suggested improvements can be [[Improving English language strings|contributed to the English (fixes) (en_fix) language pack]].

==The month names and days are displayed in English. How can I translate them?==

This is neither Moodle bug nor a missing translation. Names of days and months are pulled out of your operating system. Your server, where the Moodle is running, does not seem to have the specific [https://en.wikipedia.org/wiki/Locale_(computer_software) locale] installed. You need to contact the server administrator and ask them to install the needed locale. See [[Table of locales]] for details.

The particular locale to use for the given language is configured in the langconfig.php file in strings ''locale'' (for Unix like operating systems) and ''localewin'' (for Windows operating systems).

On Ubuntu/Debian, the package <tt>locale-all</tt> can be installed to support all existing languages.

==Why are log descriptions displayed in English?==

In log reports, descriptions are intended to be displayed in English only; it is not possible to translate them. For example "The user with id '2' viewed the course with id '4'."

==I'm starting a new language pack or I'm contributing to one. Can I do the user interface strings first?==

No, there is no way to know which strings will be shown for users and which not. But to help you a little bit, there are some unofficial priorities you can take into account.

First:
* make sure [[Translation_langconfig|langconfig]] is properly set up.
* take a look at [[Translation priority]]. All files have a rating according to how urgent they need translating.
* less urgent are also the contributed plugins, since they are not part of a standard Moodle distribution. There is a list of [https://moodle.org/plugins/stats.php the 20 top plugins downloads for Moodle] which might be worth considering for translation priority.

==How many words are there in the English language pack?==

See the discussion [http://lang.moodle.org/mod/forum/discuss.php?d=3651 How many words are there in the English language pack?].

==Moodle languages with several available language packs==
===Are there translations for the American (and other branches of the) English language?===

* The [http://lang.moodle.org/mod/forum/discuss.php?d=2617 "official"] language for Moodle is actually Australian English (''G'day mate!'') , which is almost 100% the same as UK English.
* [http://english.stackexchange.com/questions/74737/what-is-the-origin-of-the-phrase-two-nations-divided-by-a-common-language Someone] once said "America and England are two nations divided by a common language".
* The [http://download.moodle.org/download.php/langpack/2.6/en_us.zip English - United States (en_us)] language pack mostly contains different spellings (color ''versus'' colour, enroll ''versus'' enrol etc).
* The [http://download.moodle.org/download.php/langpack/2.6/en_ar.zip English - Pirate (en_ar)] language pack is used in the '[https://moodle.org/mod/forum/discuss.php?d=132888 Talk Like a Pirate]' day.
* The [https://download.moodle.org/download.php/langpack/3.2/en_us_k12.zip English US-K12] language pack is used in the [https://en.wikipedia.org/wiki/K%E2%80%9312 K-12] (kindergargarten to grade 12) primary and secondary education in the USA, Canada, and other English speaking countries.
* The [http://download.moodle.org/download.php/langpack/2.6/en_kids.zip English for kids (en_kids)] language pack seems to be a simplified version of the most common English strings seen by Moodle users, considered easier/suitable for small children.

* The [https://tracker.moodle.org/browse/MDLSITE-1363 English (fixes) (en_fix)] is just used to suggest Moodle core language strings improvements and typo fixes.

===Why do Moodle has four different language packs for the German language?===
* In Germany we have a formal language where people are talking with „Sie“ to each other. This is the language of the formal adults. I think it’s something like using „Sir“ in english language. The normal German language pack is using this formal language. Nearly all strings in the Moodle language pack and in the translated plugins are translated in the formal language.

* You can’t use these formal words in school … there you are using an informal language with „du“. Students are talking to each other like friends. Therefor we made the language pack „German personal“ (de_du). It come with the personal words „du“, „dein“, „dir“ and so on where the formal words are „Sie“, „Ihre“, „Ihnen“ (yes, these words are written with an uppercase letter).

* For my (Ralf Krause) personal use I take „German personal" (de_du) or „German Kids“ (de_kids). „German Kids“ uses the personal words „du“, „dein“ and „dir“ but it also uses an easier to understand language.

* Some time ago we tried to make Moodle as a platform for social communication but nobody wanted to use it. Therefore we made "German community“. In a social platform, nobody would talk about teachers or students or participants or classrooms or courses … in a social platform, you would use members of a group and meetings. I don’t know if this pack will be used in future.

===Why do Moodle has several different language packs for the Spanish language?===
* Spain and many South American countries use a (comma) [[Decimal separator]] that is different from the (decimal point) used in Mexico and Central America.
** Moodle core in English uses by default a decimal point for calculations, and Moodle Docs do too.
** This caused many problems in the [https://docs.moodle.org/31/en/Grader_report Gradebook] calculations and with the [https://docs.moodle.org/all/es/P%C3%A1gina_Principal Spanish Moodle Docs].
* Just as "America and England are two nations divided by a common language", so are Spain and Mexico. See [https://docs.moodle.org/all/es/Espa%C3%B1ol_de_M%C3%A9xico the Mexican Spanish documentation page] in Spanish.
* The Venezuelan Spanish (es_ve) is a very small child language of the international Spanish language.
* The Colombian Spanish (es_co) is a very small child language of the international Spanish language.
* The Mexican Spanish (es_mx) is a very modern, comprehensive, independent, language pack, specially made for Mexican Moodlers.
* The Mexican Spanish for kids (es_mx_kids) is a simplified version of the most common Mexican Spanish strings seen by Moodle users, considered easier/suitable for small children.
* You can read about [https://docs.moodle.org/all/es/Espa%C3%B1ol_internacional#Idiomas_hijos_que_depend.C3.ADan_del_Espa.C3.B1ol_internacional two (now defunct) other Spanish child languages].

===Why do other languages have child languages?===
* Languages with ''-kids'' in their code names are all child languages with a simplified version of common language strings aimed at small children.
* If you have the time, it is probably a good idea to have one such child language for kids for your main language pack.
* Current (mid 2017) languages for kids are:
** Deutsch - Kids
** English for kids
** Español de México para niños (Mexican Spanish for kids)
** עברית בתי־ספר (hebrew for kids)
** Japanese - kids
** Deutsch - Kids

* Norwegian (Primary) language pack is aimed at primary education.

* Finnish for companies is aimed at companies

==Are there items which are NOT to be translated?==
===Moodle variables enclosed within {curly brackets}===
The following words, when enclosed within {curly brackets}, are placeholders for Moodle names of variables. They should not be translated, but must remain as they are within the curly brackets:

firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe , institution, department, idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, suspended, course1, course2, course3, course4

They must also be written exactly like this in all translations of the documentation pages (such as this page.) However, the translator might like to include a translation enclosed in brackets. For example, in the Spanish documentation pages you might find: password (''contraseña'').

The fact is: '''no placeholders can be translated in AMOS'''. There is no official list of "reserved" $a properties. Whatever xyz is put in {$a->xyz}, it must be kept as it is in AMOS.

Example:

[[File:26 AMOS fullnamedisplay_core original.png]]

'''Must''' be (in this case, when translated into Mexican Spanish):

[[File:26 AMOS fullnamedisplay_core.png]]

unless your language uses lastname before the firstname, as Japanese does, which translates to:

[[File:26 AMOS fullnamedisplay_core Japanese.png]]

===Placeholders enclosed within % characters (%example%) must not be translated===
The [https://moodle.org/plugins/local_moodlecloudsignup Moodle Cloud Signup and Portal strings] local plugin is used for accessing the [https://moodle.com/cloud/ MoodleCloud] and it includes several strings that have some words surrounded by % characters (eg, %date%). These words must not be translated, they must be copied exactly into the language pack translation, but the rest of the string might or might not be translated.

* Example of one string that can not be translate and must be copied exactly:
[[File:AMOS placeholders with percentace character.png|600px]]

* Example of one string with one placeholder (highlighted) and some regular text that can be easily translated:
[[File:AMOS text with placeholders with percentace character.png|600px]]

=== All fieldnames must be kept in English===
* These names are hooks that are used in the software. You should not translate them.
* See the example below for the string uploadcourses_help in the file tool_uploadcourse for Moodle 3.1:
[[File:Fieldnames are not to be translatd.png]]
* Notice that the string text indicates (red rectangle) that these words (enclosed in green rectangles) are fieldnames. Also notice that the Spanish translation clearly indicates, at the final part of the paragraph ''(así escritos, en inglés)'' that these fieldnames must be written in English as they are written here.
* Some used fieldnames in Moodle are:

category, category_id, category_idnumber, category_path, context, course, description, descriptionformat, email, enrolmentkey, firstname, fullname, groupname, hidepicture, idnumber, intro, lastname, maxgrade, maxrequest, name, password, picture, section, shortname, teachers, timeopen, timeclose, timeend, timestart, username, visible,

* Note that these fieldnames may appear as real fieldnames (must not be translated) or as regular words in another context (can and must be translated). You should exercise caution and, If possible, always check that Moodle works correctly by testing your translations with some data in a real or test server.

===Local addresses after <a href="../===
Addresses inside a Language string that have <a href="../ reference a specific URL inside your Moodle server and you must keep the address part of the expression, but you can translate the descriptive name part. See the following example:
noassignableroles | tool_cohortautoroles
There are currently no roles that can be assigned in the user context. <a href="../../roles/manage.php">Manage roles</a>
* You must keep the <a href="../../roles/manage.php"> part, as this references to the [https://docs.moodle.org/31/en/PHP PHP] code in your Moodle server that will be executed in order to manage roles
* You can/should/must translate 'Manage roles'
* Do not forget to keep the ending </a>

===Moodle Docs addresses after <code><nowiki><a href="http://docs.moodle.org/en/</nowiki></code>===
Addresses inside a Language string that have <code><nowiki><a href="http://docs.moodle.org/en/ </nowiki></code>reference a specific URL in the Moodle English Documentation. You must look at that address and '''only''' if your language has a valid translation for that page, you can/should replace the original English Docs address with your own language address. See the following example:
core backup | nonisowarning
Warning: this backup is from a non-Unicode version of Moodle (pre 1.6). If this backup contains any non-ISO-8859-1 texts then they may be CORRUPTED if you try to restore them to this Unicode version of Moodle. See the <a href="http://docs.moodle.org/en/Backup_FAQ">Backup FAQ</a> for more information about how to recover this backup correctly.
* There are six different language translations for that page. So, you can only replace this address if your language is one of these.

===Other internet addresses after <a href="http://===
* You must proceed as with Moodle Docs addresses:
* Example:
auth_radius | auth_radiusdescription
This method uses a <a href="http://en.wikipedia.org/wiki/RADIUS">RADIUS</a> server to check whether a given username and password is valid.
* You must check the (English language wikipedia) page about the RADIUS server, and then you can decide whether to keep this address or replace it with your own language matching wikipedia translation.

===HTML codes that must not be translated===
The following HTML codes are reserved words that must not be translated. However, it is important for the translators to understand their meaning in order to decide whether to keep them in the translation and if so, whether they can be rearranged.

* <code>&nbsp</code> - non-breaking space i.e. a space but there will never be a line-break inserted instead of this space at the end of a line.
* <code>&ensp</code> and <code>&emsp</code> - denote an en space and an em space respectively, where an en space is half the point size and an em space is equal to the point size of the current font. For fixed pitch fonts, the user agent can treat the en space as being equivalent to a single space character, and the em space as being equuivalent to two space characters.
* <code>&amp</code> - ampersand sign (&)
* <code>&apos</code> - apostrophe sign (')
* <code>&copy</code> - copyright sign (©)
* <code>&plusmn</code> - "plus or minus" sign (±)
* <code>&times</code> - multiply sign (*)
* <code>&divide</code> - divide sign (/)
* <code>&gt</code> - "greater than" sign ( > )
* <code>&lt</code> - "less than" sign (<)
* <code>&laquo</code> - quotation mark (‘)
* <code>&lsquo</code> - left single quotation sign (‘)
* <code>&rsquo</code> - right single quotation sign (’)
* <code>&ouml</code> - small letter o with diaeresis (ö)
* <code>&mdash</code> - [https://en.wikipedia.org/wiki/Dash#Em_dash em dash] sign (—)

===Calculation functions must not be translated===
[https://docs.moodle.org/32/en/Grade_calculations#Calculation_functions Calculation functions] start with an equal sign (=). Following is an expression using operators and functions supported by the system.
[[File:DO NOT translate calculation functions.png]]

===The 'thisdirection' and 'thisdirectionvertical' strings in core_langconfig should never be translated===
'''The 'thisdirection' and 'thisdirectionvertical' strings in core_langconfig should never be translated, as they are not variables meant to be translated. They are prefixing selectors used by the themes to display left-to-right or right-to-left languages. Read [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 more about problems with these variables].

==Is there a way to check the integrity of all placeholders in a language pack?==
* Not a at the moment. See MDL-51775 .
* You can use [https://lang.moodle.org/mod/forum/discuss.php?d=4661 this trick] to check for integrity:
** Load the language pack in a [https://download.moodle.org/windows/ local instance of Moodle].
** In order to generate a [https://lang.moodle.org/mod/forum/discuss.php?d=4098 translation memory], load the language pack in the [https://docs.moodle.org/29/en/Language_customisation Language customization] tool, so that the texts are loaded in the database.
** Run the sql instance in the file (tm_generator.txt)
** Insert the result of the query in template.tmx file
** The result is a translation memory that can be analysed with [http://www.opentag.com/okapi/wiki/index.php?title=CheckMate Checkmate].
** The problem: probably you will get many errors due to some characters that are not allowed by Checkmate so you will have to remove manually some translation units. After doing it, you will get a report with some possible errors (see the attached image).
** Of course, it would be great to have an integrated quality check system in Moodle. Vote for MDL-51775 .

* The contents of the file tm_generator.txt are ('''change the language from eu to your language'''):
SELECT concat('<tu tuid="',mdl_tool_customlang_components.name,'|',mdl_tool_customlang.stringid,'">
<tuv xml:lang="en"><seg>',mdl_tool_customlang.original,'</seg></tuv>
<tuv xml:lang="',mdl_tool_customlang.lang,'"><seg>',mdl_tool_customlang.master,'</seg></tuv>
</tu>') as txt
FROM mdl_tool_customlang INNER JOIN mdl_tool_customlang_components ON mdl_tool_customlang.componentid = mdl_tool_customlang_components.id
WHERE (((mdl_tool_customlang.lang)="eu") AND ((mdl_tool_customlang.original) Is Not Null) AND ((mdl_tool_customlang.master) <>mdl_tool_customlang.original));

* the contents of the template.tmx file are:
<?xml version="1.0" encoding="UTF-8"?>
<tmx version="1.4"><header creationtool="SQLQuery" creationtoolversion="unknown" segtype="paragraph" o-tmf="unknown" adminlang="en" srclang="en" datatype="unknown"></header><body>
PLACE HERE THE RESULT OF THE SQL QUERY
</body>
</tmx>

==What is a ''translation memory'' and how can I create a translation memory out of a Moodle language pack?==
* Read the 'Is there a way to check the integrity of all placeholders in a language pack?' section above.
* See [https://lang.moodle.org/mod/forum/user.php?id=1489&page=1 this post] and [https://dl.dropboxusercontent.com/u/86242384/moodle/en/publish/moodle_tm/website_index.html this tutorial].

==How can I help with translating Moodle documentation?==

Please see the guide [[Translating Moodle Docs]].

==How can I find out the context of the strings?==

You can find where a language string is located as described in the user docs [[:en:Language_customisation#Finding_the_component_and_string_identifier|Finding the component and string identifier]] and [[:en:Language FAQ|Language FAQ]].

You may wish to use two windows (perhaps using two monitors), with one displaying the page in English and the other displaying the page in your language.

[[File:two windows translation.jpg|Two simultaneous windows in two languages|800px]]

If you think the original English language strings have more than one meaning and you can't guess which one applies, you are welcome to post in the [https://lang.moodle.org/mod/forum/view.php?id=5 AMOS translation forum].

==Is there a list of Moodle error messages which can be translated?==

Error messages are listed in the user docs [[:en:Category:Error|Category:Error]].

==Can the subtitles for Moodle HQ YouTube videos be translated?==
For Moodle 3.2 onwards, yes. See [[Translating Moodle video subtitles]].

See also [https://lang.moodle.org/mod/forum/discuss.php?d=4739#p5582 this forum thread].

==Can the User Tours from Moodle.net be translated?==
* Yes. See [[Translating User tours from Moodle.net]]

==How can I test my plugins translations of several (different) Moodle branches?==

*Linux
** You can have several Moodle branches in one Ubuntu (or any other Linux distro) machine by following [https://docs.moodle.org/31/en/Step-by-step_Installation_Guide_for_Ubuntu#Hosting_several_Moodle_branches_in_one_Ubuntu_server these steps].

* Windows
** You can have several [https://download.moodle.org/windows/ local Moodle servers] in different folders in a Windows 7 PC. It is very easy to start one branch server, work on it, stop it and then start a different branch.
{{Note|Some early local Moodle (versions before 3.0) server packages from [https://download.moodle.org/windows/ https://download.moodle.org/windows/] only work in Windows 7, but apparently not in Windows 8 and definitely not in Windows 10, regardless of compatibility settings. For these you would need to install XAMP separately. Moodle 3.0 and newer branches do work under Windows 10.}}
*Mac
**We need to write about this...

==Can I translate a language pack offline / can I use another language then English as source language?==
Yes you can, but it is not recommended because there is a high risk of causing problems (remember - sites update language packs automatically, so your problem spreads quickly over the world).
One problem is that you absolutely have to avoid untranslated strings or strings in the wrong language in the language pack. This should NEVER happen. Another problem is that there is no way to know which strings are already translated. There is also a higher risk for syntax errors. If you have to, you can follow the following procedure:
* download the English language pack (or another one if you want a different source language)
* translate directly in the php file, preferably using something with syntax highlighting (Geany, Gedit, Notepad++ on Windows, ...)
* IMPORTANT: delete all not-translated lines from the file, before uploading - therefore it is probably best to translate line by line and keep the original source files, so you can work with a record of processed line numbers.
* import the files in the translation portal following the manual on https://docs.moodle.org/dev/AMOS_manual#Importing_a_file (IMPORTANT: zip file cannot contain any folders)

==See also==

* [[:en:Language customization|Language customization]] in the user docs for information on how to edit an existing language pack
* [[String Deprecation]] is introduced in Moodle 2.8 to help minimize the language files but avoid accidental lost of translations by simply removing strings.
* [https://lang.moodle.org/mod/forum/discuss.php?d=4098#p4879 Generating a translation memory and running a quality test] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=347843 translation in context] forum discussion

[[de:Übersetzung FAQ]]

Translation langconfig

2019-07-06T08:32:35Z

Koen: Moved up to *nix servers since that affects the Moodle sites

{{Translation}}
Langconfig is an important file in a language pack, dealing with all the configuration parameters of that language. It is good practice to review this first when starting of a new language pack or when taking on responsibility of an existing language pack. You can edit it by going to lang.moodle.org and find it as the core_langconfig component for your language.

On this page you find a little documentation for each setting to help you deciding what should go there for your language.

===alphabet,core_langconfig===
The alphabet in your language. Used e.g. for the list of letters on the participants page.

===backupnameformat,core_langconfig===
===decsep,core_langconfig===
How decimals are separated in your language. [http://en.wikipedia.org/wiki/Decimal_separator Usually a dot or a comma]. Take note that some countries which seem to share the same language may have a different character to separate the integer part from the fractional part of a number written in decimal form. e.g. Central American Spanish-speaking countries use the decimal point, while South American Spanish-speaking countries use the decimal comma.

Example:
* English: 36.5
* Dutch: 36,5

===firstdayofweek,core_langconfig===
The first day of the week in your language. Allowed values are 0,1,2,3,4,5,6, where 0 stands for Sunday.

===iso6391,core_langconfig===
The ISO 639.1 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Wikipedia].

===iso6392,core_langconfig===
The ISO 639.2 value for your language. You can find this value easily on [https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes Wikipedia].

===labelsep,core_langconfig===
How a label is separated from a form. Could be a colon, a space and a colon or something different, according to what's generally used in your language. This character is not read by screen readers for accessibility reasons.

===listsep,core_langconfig===
The symbol usually used in your language, for separating items in a list. This is used e.g. when using formulas with multiple items in the gradebook. This must be a symbol different from the decsep symbol.

===locale,core_langconfig===
locale for *nix servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language)

{{Note|Locales, used in language packs should come only from the table of locales at https://docs.moodle.org/dev/Table_of_locales and the list at https://docs.moodle.org/dev/List_of_locales_supported_on_Moodle_community_servers}}

===localewin,core_langconfig===
locale for Windows servers.

If your Moodle calendar is not translated, then this string is wrong (or your server is not configured to support the language). There are quite a few languages that are not supported by Windows servers and the localewin server can not be set. In that case, you have to run your Moodle on a *nix server to make the translation of your Moodle calendar work

===localewincharset,core_langconfig===
The character set to use when Moodle is installed on a Windows server

===oldcharset,core_langconfig===
Necessary to upgrade from prior to 1.6. This string defines the charset used in 1.5 and earlier for this language pack. For language packs that start later then Moodle 1.5, this can be left empty

===parentlanguage,core_langconfig===
If your language pack relies on another one, then this is the place to point out which language pack. '''For most language packs, this should be left empty''', to default to English if strings are missing.

Example: Canadian French (fr_ca) is mostly the same as French (fr) apart from a few changes. Creating a language pack with as parent language French will shop French if a string does not exist in the language pack Canadian French. If a string doesn't exist in both language packs, English is shown.

On the download page for the language packs (http://download.moodle.org/langpack) you can see how many strings are different from the parent language pack. In Moodle 2.6, Canadian French had 1048 changes from French.

===strftimedate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===strftimedatefullshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedateshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedatetimeshort,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydate,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaydatetime,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedayshort,core_langconfig===
How time and day are displayed in short in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimedaytime,core_langconfig===
How time and day are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimemonthyear,core_langconfig===
How month and year are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecent,core_langconfig===
How time and date are displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimerecentfull,core_langconfig===
How time and date are displayed for recent activities in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp
===strftimetime,core_langconfig===
How time is displayed in Moodle. Usually it is fine to check the order of the English one and use the same symbols. If that doesn't serve your needs, the complete reference for what is possible can be found on http://www.w3schools.com/php/func_date_strftime.asp

===thisdirection,core_langconfig===
In which direction your language should be displayed on the screen. The only possible options are ltr (left to right) or rtl (right to left).'''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thisdirectionvertical,core_langconfig===
How text that is printed vertical on the screen is oriënted (like in a docked block).

The only possible values can be btt (bottom to top) or ttb (top to bottom). '''Do not attempt to translate these''', or [https://moodle.org/mod/forum/discuss.php?d=328567#p1323101 you will wreak havoc on many themes].

===thislanguage,core_langconfig===
The name of your language in your own language

===thislanguageint,core_langconfig===
The name of your language in English

===thousandssep,core_langconfig===
How you separate thousands in your language.
Important: this can not be a space (more information in discussion http://lang.moodle.org/mod/forum/discuss.php?d=1450#p1730). If you want a space, you can try with &nbsp; but that is not fully tested yet.

Example:
* in Dutch 1.000.000 (with a dot)
* in English 1,000,000 (with a comma)

[[Category:Language]]

[[es:Langconfig]]

List of locales supported on Moodle community servers

2019-07-04T15:08:07Z

Koen: Link to relevant bug report

Locales, used in language packs should come from this list only:

<pre>
aa_DJ
aa_DJ.utf8
aa_ER
aa_ER@saaho
aa_ET
af_ZA
af_ZA.utf8
ak_GH
am_ET
an_ES
an_ES.utf8
anp_IN
ar_AE
ar_AE.utf8
ar_BH
ar_BH.utf8
ar_DZ
ar_DZ.utf8
ar_EG
ar_EG.utf8
ar_IN
ar_IQ
ar_IQ.utf8
ar_JO
ar_JO.utf8
ar_KW
ar_KW.utf8
ar_LB
ar_LB.utf8
ar_LY
ar_LY.utf8
ar_MA
ar_MA.utf8
ar_OM
ar_OM.utf8
ar_QA
ar_QA.utf8
ar_SA
ar_SA.utf8
ar_SD
ar_SD.utf8
ar_SS
ar_SY
ar_SY.utf8
ar_TN
ar_TN.utf8
ar_YE
ar_YE.utf8
as_IN
ast_ES
ast_ES.utf8
ayc_PE
az_AZ
be_BY
be_BY@latin
be_BY.utf8
bem_ZM
ber_DZ
ber_MA
bg_BG
bg_BG.utf8
bhb_IN.utf8
bho_IN
bn_BD
bn_IN
bo_CN
bo_IN
br_FR
br_FR@euro
br_FR.utf8
brx_IN
bs_BA
bs_BA.utf8
byn_ER
C
ca_AD
ca_AD.utf8
ca_ES
ca_ES@euro
ca_ES.utf8
ca_ES.utf8@valencia
ca_ES@valencia
ca_FR
ca_FR.utf8
ca_IT
ca_IT.utf8
ce_RU
ckb_IQ
cmn_TW
crh_UA
csb_PL
cs_CZ
cs_CZ.utf8
C.UTF-8
cv_RU
cy_GB
cy_GB.utf8
da_DK
da_DK.utf8
de_AT
de_AT@euro
de_AT.utf8
de_BE
de_BE@euro
de_BE.utf8
de_CH
de_CH.utf8
de_DE
de_DE@euro
de_DE.utf8
de_LI.utf8
de_LU
de_LU@euro
de_LU.utf8
doi_IN
dv_MV
dz_BT
el_CY
el_CY.utf8
el_GR
el_GR.utf8
en_AG
en_AU
en_AU.utf8
en_BW
en_BW.utf8
en_CA
en_CA.utf8
en_DK
en_DK.iso885915
en_DK.utf8
en_GB
en_GB.iso885915
en_GB.utf8
en_HK
en_HK.utf8
en_IE
en_IE@euro
en_IE.utf8
en_IN
en_NG
en_NZ
en_NZ.utf8
en_PH
en_PH.utf8
en_SG
en_SG.utf8
en_US
en_US.iso885915
en_US.utf8
en_ZA
en_ZA.utf8
en_ZM
en_ZW
en_ZW.utf8
eo
eo_US.utf8
eo.utf8
es_AR
es_AR.utf8
es_BO
es_BO.utf8
es_CL
es_CL.utf8
es_CO
es_CO.utf8
es_CR
es_CR.utf8
es_CU
es_DO
es_DO.utf8
es_EC
es_EC.utf8
es_ES
es_ES@euro
es_ES.utf8
es_GT
es_GT.utf8
es_HN
es_HN.utf8
es_MX
es_MX.utf8
es_NI
es_NI.utf8
es_PA
es_PA.utf8
es_PE
es_PE.utf8
es_PR
es_PR.utf8
es_PY
es_PY.utf8
es_SV
es_SV.utf8
es_US
es_US.utf8
es_UY
es_UY.utf8
es_VE
es_VE.utf8
et_EE
et_EE.iso885915
et_EE.utf8
eu_ES
eu_ES@euro
eu_ES.utf8
eu_FR
eu_FR@euro
eu_FR.utf8
fa_IR
ff_SN
fi_FI
fi_FI@euro
fi_FI.utf8
fil_PH
fo_FO
fo_FO.utf8
fr_BE
fr_BE@euro
fr_BE.utf8
fr_CA
fr_CA.utf8
fr_CH
fr_CH.utf8
fr_FR
fr_FR@euro
fr_FR.utf8
fr_LU
fr_LU@euro
fr_LU.utf8
fur_IT
fy_DE
fy_NL
ga_IE
ga_IE@euro
ga_IE.utf8
gd_GB
gd_GB.utf8
gez_ER
gez_ER@abegede
gez_ET
gez_ET@abegede
gl_ES
gl_ES@euro
gl_ES.utf8
gu_IN
gv_GB
gv_GB.utf8
hak_TW
ha_NG
he_IL
he_IL.utf8
hi_IN
hne_IN
hr_HR
hr_HR.utf8
hsb_DE
hsb_DE.utf8
ht_HT
hu_HU
hu_HU.utf8
hy_AM
hy_AM.armscii8
ia_FR
id_ID
id_ID.utf8
ig_NG
ik_CA
is_IS
is_IS.utf8
it_CH
it_CH.utf8
it_IT
it_IT@euro
it_IT.utf8
iu_CA
iw_IL
iw_IL.utf8
ja_JP.eucjp
ja_JP.utf8
ka_GE
ka_GE.utf8
kk_KZ
kk_KZ.utf8
kl_GL
kl_GL.utf8
km_KH
kn_IN
kok_IN
ko_KR.euckr
ko_KR.utf8
ks_IN
ks_IN@devanagari
ku_TR
ku_TR.utf8
kw_GB
kw_GB.utf8
ky_KG
lb_LU
lg_UG
lg_UG.utf8
li_BE
lij_IT
li_NL
ln_CD
lo_LA
lt_LT
lt_LT.utf8
lv_LV
lv_LV.utf8
lzh_TW
mag_IN
mai_IN
mg_MG
mg_MG.utf8
mhr_RU
mi_NZ
mi_NZ.utf8
mk_MK
mk_MK.utf8
ml_IN
mni_IN
mn_MN
mr_IN
ms_MY
ms_MY.utf8
mt_MT
mt_MT.utf8
my_MM
nan_TW
nan_TW@latin
nb_NO
nb_NO.utf8
nds_DE
nds_NL
ne_NP
nhn_MX
niu_NU
niu_NZ
nl_AW
nl_BE
nl_BE@euro
nl_BE.utf8
nl_NL
nl_NL@euro
nl_NL.utf8
nn_NO
nn_NO.utf8
nr_ZA
nso_ZA
oc_FR
oc_FR.utf8
om_ET
om_KE
om_KE.utf8
or_IN
os_RU
pa_IN
pap_AN
pap_AW
pap_CW
pa_PK
pl_PL
pl_PL.utf8
POSIX
ps_AF
pt_BR
pt_BR.utf8
pt_PT
pt_PT@euro
pt_PT.utf8
quz_PE
raj_IN
ro_RO
ro_RO.utf8
ru_RU
ru_RU.cp1251
ru_RU.koi8r
ru_RU.utf8
ru_UA
ru_UA.utf8
rw_RW
sa_IN
sat_IN
sc_IT
sd_IN
sd_IN@devanagari
sd_PK
se_NO
shs_CA
sid_ET
si_LK
sk_SK
sk_SK.utf8
sl_SI
sl_SI.utf8
so_DJ
so_DJ.utf8
so_ET
so_KE
so_KE.utf8
so_SO
so_SO.utf8
sq_AL
sq_AL.utf8
sq_MK
sr_ME
sr_RS
sr_RS@latin
ss_ZA
st_ZA
st_ZA.utf8
sv_FI
sv_FI@euro
sv_FI.utf8
sv_SE
sv_SE.iso885915
sv_SE.utf8
sw_KE
sw_TZ
szl_PL
ta_IN
ta_LK
tcy_IN.utf8
te_IN
tg_TJ
tg_TJ.utf8
the_NP
th_TH
th_TH.utf8
ti_ER
ti_ET
tig_ER
tk_TM
tl_PH
tl_PH.utf8
tn_ZA
tr_CY
tr_CY.utf8
tr_TR
tr_TR.utf8
ts_ZA
tt_RU
tt_RU@iqtelif
ug_CN
ug_CN@latin
uk_UA
uk_UA.utf8
unm_US
ur_IN
ur_PK
uz_UZ
uz_UZ@cyrillic
uz_UZ.utf8
ve_ZA
vi_VN
wa_BE
wa_BE@euro
wa_BE.utf8
wae_CH
wal_ET
wo_SN
xh_ZA
xh_ZA.utf8
yi_US
yi_US.utf8
yo_NG
yue_HK
zh_CN
zh_CN.gb18030
zh_CN.gbk
zh_CN.utf8
zh_HK
zh_HK.utf8
zh_SG
zh_SG.gbk
zh_SG.utf8
zh_TW
zh_TW.euctw
zh_TW.utf8
zu_ZA
zu_ZA.utf8
</pre>

== See also ==
https://tracker.moodle.org/browse/MDLSITE-5744

List of locales supported on Moodle community servers

2019-07-04T15:06:52Z

Koen: Created page with "Locales, used in language packs should come from this list only: <pre> aa_DJ aa_DJ.utf8 aa_ER aa_ER@saaho aa_ET af_ZA af_ZA.utf8 ak_GH am_ET an_ES an_ES.utf8 anp_IN ar_AE ar_..."

2012-04-05T13:46:50Z

Koen: /* locale,core_langconfig */

Translation langconfig

2012-04-05T13:45:18Z

Koen: /* parentlanguage,core_langconfig */