Translating Moodle Docs
- 1 Contributing to the documentation
- 2 Translating the screen images used in Moodle Docs
- 3 Which documentation pages are most important or useful to translate?
- 4 Translating the Documentation pages for 'Mooodle Docs for this page' and 'More help' links
- 5 Is it important to translate English Documentation pages that only have one #Redirect instruction?
- 6 Which English documentation pages will change when there is a new Moodle version release
- 7 See also
Contributing to the documentation
Moodle Docs pages, such as the page you are reading right now, are wiki pages available in several languages. Any registered Moodle user can contribute to Moodle Docs and improve or translate these wiki pages. Please make sure to follow the guidelines for contributors.
You need to make at least one edit to an existing docs page before you are allowed to create a new page (an anti-spam feature).
You might find it useful to add the original English documentation pages that you have just translated to your watchlist (alt-shift-w), so that you will know when your translation might need to be re-checked for a possible update.
If your language does not have a documentation wiki, you are welcome to add a link to en:Moodle manuals to documentation available elsewhere e.g. Google Docs.
Translating the screen images used in Moodle Docs
- If you want to recreate the bright orange-coloured screen images used in the Documentation pages (eg, Moodle 3.0 New features Docs page), you can replicate the Mount Orange school theme in your local server by following the details outlined here for Moodle 3.0 and here for the Boost theme in more recent Moodle branches.
Replicating the Mount Orange theme look in a local server with the Boost theme
- You will need to download the cloudy background from here and the Mount Orange image from here.
- You may insert these two images in a label in a Moodle course and notice (write down) the paths that references where these images have been stored, as you will need to input these paths later.
- Go to your site home and edit the site home summary.
- You need to click on the very first tool button in order to show all the tools buttons in the Atto editor.
- You need to click on the </> button in order to input HTML code:
- You must input the code described in 'Front page topic section' of https://docs.moodle.org/34/en/Standard_themes#Example_of_a_customised_Boost_theme. Do NOT click the 'Save' button yet:
- Replace 'YOUR UPLOADED FRONT PAGE IMAGE.jpg' with the path to your recently uploaded front page image, that you carefully wrote down earlier.
- Now is the time when you replace the 'YOUR HEADING' text with the translated text for your Orange-coloured School ('Escuela Monte Naranja' for this Spanish language example).
- Replace the 'SMALLER HEADING' text in both places with your language text strings.
- Replace 'Paragraph of text' in both places.
- Replace 'BUTTON TEXT' in both cases-
- When you click again on the <> button, the HTML code will be interpreted and you will see the graphics displayed and the texts rendered in a nice orange-colored style:
- Check the result, and correct if necessary.
- You can now save your changes.
- Go to Administration, Appearance, Themes, Boost, advanced settings
- Paste the 'Boost theme Advanced settings - Raw initial CSS:' and 'Boost theme Advanced settings - Raw SCSS:' codes from https://docs.moodle.org/34/en/Standard_themes#Example_of_a_customised_Boost_theme.
- In the 'Boost theme Advanced settings - Raw SCSS:' section, replace 'YOUR UPLOADED BACKGROUND IMAGE.jpg' with the path to your recently uploaded cloudy background image.
- Replace the original English language text with the appropiate text for your language pack.
- Check that your Mount Orange clone site looks good.
- Compare your site's front page with the image of Mount Orange 3.4 front page, or better yet, compare your site with the current Mount Orange page.
- Correct if necessary.
- If all is fine, save the changes.
- You can now use your emulated translated Orange site to replicate the beautiful images Moodle HQ used to illustrate Moodle 3.3 new features (or newer branches) in Moodle Docs.
Which documentation pages are most important or useful to translate?
Many Moodle users will start reading the English docs main page. This might be a good page to have translated.
The new features in the latest version would surely be of interest to the users of previous Moodle versions that want to catch up with the new available features.
The quick guides are very short pages (that hopefully you can very quickly translate) that teachers can quickly check, in order to grasp how an important Moodle feature works, without having to read the standard detailed (long) Moodle full documentation pages.
The Table of contents has a very comprehensive and organized list of important Moodle topics. This might be a worthy addition to your language documentation.
If you see a post which has been rated as 'Useful' several times in a Forum in a language other than English, which links to an untranslated English documentation page, it might be a good idea to translate this page.
The English Documentation Special Page with the Most linked-to pages shows the English pages that have the highest number of links and (except for all the User: pages) you will find there many pages highly useful for Moodlers of all languages and worth translating to your language (eg, Managing a Moodle site & Managing a Moodle course).
If you are a Moodle site admin or teacher, using a language other than English, and you use the 'Moodle Docs for this page' link in your daily work, please consider translating the English pages that helped you most to do your job and solve your problems. See below.
- When logged in as an admin or teacher, 'Moodle Docs for this page' links at the bottom of each page in Moodle take you to documentation about that page in your language, if it exists, otherwise in English.
- You might be tempted to start typing the documentation in your own language (if such a page exists), but please don't do it. Instead, change your language to English and then click in the 'Moodle Docs for this page' link.
- In the English documentation page that just opened, add a language link for your language (see Interlanguage-linking), save it and then open the given translation page.
- If the English Documentation page has only a redirect instruction, please add a translation for the redirection and then save the English page with the redirection
- Make sure that you add a translation link for the redirection, check that it works (create the page if it did not exist) and save the page.
- You can now jump to the redirected page in your own language and work on it.
- The 'More help' links have the same icon (i) and work the same way as the 'Moodle Docs for this page' links.
Is it important to translate English Documentation pages that only have one #Redirect instruction?
Yes, it is very, very fast and it will make your translated wiki more efficient, because you will replicate all the automatic redirections that exist in the English Docs in your own language Docs, specially with the Docs pages related to online help for specific pages in your Moodle server (see the example above).
If you have translated Documentation pages with #Redirect instructions, it will then be a good idea to go to the TOOLS column at the bottom of the page (in your language wiki documentation) and click on 'Special pages'. There, check the 'Broken redirects' and 'Double redirects' links and fix any pages that might show up there.
Which English documentation pages will change when there is a new Moodle version release
- If you have a translation of https://docs.moodle.org/dev/Releases you will need to update it
- The new features in the latest version mentioned above must now have the new available features.
- You might need to update the version numbers in your translated documentation for these pages: