Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add notes about automatic translation updates


  1. Configure the module to be updateable via the Transifex command-line client:
    1. Install the Transifex client and set up the the .transifexrc configuration file as specified here: the docs)

    2. Create a new directory .tx off   in the top-level module directory with a single file named "config" with the following content (replace htmlformentry-module with the slug you chose for your module in step #3):
      host =


      file_filter = api/src/main/resources/messages_<lang>.properties
      source_file = api/src/main/resources/
      source_lang = en

      Note: for more info on the tx config file see

  2. Add this new file and directory to git and push it up.
  3. If you have any existing translations for the module, push these translations up to Transifex via executing the following Transifex client command at the command line: "tx push -tf" 

Updating A Module With New Translations


Setting up Automatic Translation Updates

The Bamboo Commit Translations to GitHub job automatically downloads translation updates from Transifex, commits them, and pushes the changes to GitHub. To make it do that for a new repository, add the repository to "Repositories" and create a new "stage." The script it runs is in openmrs-contrib-bamboo.

Adding a New Language to a Module


One very important point–if you update a messages_*.properties file manually (ie, any of the translation files, but not the main you need to make sure to push these changes up to Transifex ("tx push -tf") or next time you import from Transifex, the translations added manually will be overwritten.