search

andrewhancox / moodle-filter_translations

7 stars 8 forks source link

Revision suggestions to Moodle doc for Content Translation Plugin Set #182

Open carlicockrell opened 8 months ago

carlicockrell commented 8 months ago

Please see https://docs.moodle.org/403/en/Content_translation_plugin_set.

The Moodle US team would like to suggest the following revisions as cautionary tales before running the Insert hash span CLI as some of these suggestions come at the bottom of the doc and we should at least link to the known issues before they run the CLI.

  1. Do not translate Matching questions in quiz or lessons and remove them from JSON file
  2. (Missing entirely from doc) We recommend excluding the following pages from translation /user/index.php /user/view.php /user/profile.php /user/preferences.php /user/files.php /grade/report/overview/index.php

We did not know it was a good idea to exclude these pages. It is unclear if excluding these pages at the plugin level, and then running the CLI will result in the CLI adding these to the JSON or not (I do not have CLI access to a site).

Translating user profile fields can result in issues with third party integrations in particular because even if the profile field is not an atto-enabled field, it can add a hash.

rjnl commented 8 months ago

Thanks Carli for the suggestions. Agreed, the documentation needs to be updated, particularly with regards to the CLI scripts. I will update the docs in due course.