Translating Moodle Docs

Revision as of 16:48, 8 March 2016 by German Valero (talk | contribs) (tidy up)

Jump to: navigation, search

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 you wish to translate the latest release notes or the Moodle roadmap or some other pages in the dev docs that are considered particularly important and may be frequently updated, please use a Frequently updated page translation template, as done for Spanish (Plantilla:Frequently_updated_page_translation) and French (Modèle:Frequently updated page translation).

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.

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 Table of contents has a very comprehensive and organized list of important Moodle topics. This might be a worthy addition to your language documentation.

The Security page and all pages linked from there are probably very important for Moodle admins in all languages.

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.

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.

Translating the Documentation pages for 'Mooodle Docs for this page' and 'More help' links

  • When a user clicks on the 'Moodle Docs for this page' at the bottom of a page in a Moodle site, the browser will open a Moodle documentation page related to the page the user was in.

Moodle Docs for this page.png

  • If the user was using a non-English language, the page opened will be from the Documentation wiki of the given language (if such a page exists). If your language wiki does not have that particular page, you will see the English documentation page instead.
  • 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, 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

Redirected page.png Redirected page in English.png

  • 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.

Redirected page in English with Spanish translation link.png Redirected page in Spanish.png

  • You can now jump to the redirected page in your own language and work on it.
  • This way you will have a more efficient translated wiki.
  • The 'More help' links have a symbol of an exclamation mark inside a circle More help symbol.png 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 usually very fast and it will make your translated wiki more efficient, 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 might 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

See also