Translating Release Notes


  1. Grab POT or PO file for your language from

  2. Translate it. Add a credit for yourself in your translation, after the list of writers.
  3. Clone the release-notes module and checkout the latest branch (e.g. git clone and git checkout -b gnome-3-8 origin/gnome-3-8)

  4. Put your translation to release-notes/help/LANG/LANG.po where LANG is your language code
  5. Add your LANG to release-notes/help/ (HELP_LINGUAS variable)
  6. Create localised screenshots and put them in LANG/figures/ subdirectory.
  7. Commit your work and push.
  8. Track changes on and update as necessary

  9. Look at to see generated HTML for your language


If there are any typos in original document, please fix them using "en" translation (replace LANG with "en" in above instructions). For some things, you'll also want to notify translators about that using and add a translators' comment in source XML files (see examples in "rnwhy.xml" for MandrakeSoft/Mandriva rename).


Ideally, you will create screenshots that show the translated software. They should be as similar as possible to the original screenshots. The file name should be the same as the original, and in the PNG format.

Instructions for making screenshots:

  1. If the screenshot contains part of the background, it's only a matter of taking a screenshot of the entire screen (e.g. with gnome-screenshot or Gimp), then cutting the unnecessary part of the image with an image editor.
  2. If the screenshot consists in a unique window, use gnome-screenshot with the following settings:



Preview in Damned Lies

Since September 2018, the GNOME Translation management website Damned Lies is able to build help/documentation files using the .po file uploaded by the translator. This feature can be used for testing and reviewing translation of the Release Notes.

In order to test it, one needs to:

  1. Go to release-notes module page in Damned Lies

  2. Click in your language to access your language's page for release-notes module translation
  3. Reserve it for translation by selection the proper option in action dropdown menu
  4. Download the .po file of the release-notes and translate it
  5. Upload the translated .po file to the release-notes module page
  6. Click the "build" button now be available next to diff URLs

After pressing the "build" button in the release-notes module page, you should be redirected to a temporary web page in Damned Lies representing the Release Note, with your translation applied. Browse it reviewing your translation work.

After reviewing, it is possible to re-upload the translation with any desired changes, or to move ahead in the translation workflow, by going back to your language's page for release-notes module translation.

Building locally

You can test the XML generation to see if all goes well (i.e. the PO file has correct XML syntax). See commands below, using "gnome-3-8" as example version.

Make sure you have gnome-doc-utils installed:

pkg-config gnome-doc-utils --modversion

should show a version number.

$ git clone
$ cd release-notes
$ git checkout -b gnome-3-8 origin/gnome-3-8
$ ./
$ make

Then view the XML document in the subdirectory for your language:

$ yelp help/LANG/release-notes.xml


TranslationProject/ReleaseNotes (last edited 2019-03-28 19:54:03 by RafaelFontenelle)