translating dtdocs
Translation of the darktable documentation is done via our Weblate instance.
You can either use Weblate’s web UI to translate the documentation or download the translation from Weblate to your computer, edit it, and then upload the changes.
Please do all translation work through Weblate. We will not accept pull requests directly on github to update PO files.
🔗Making a new branch in git
- Make a new branch to work on it in git.
For example:
git checkout -b fr-translation-init
🔗Adding a new language to Hugo
-
In the files
config.yaml
andconfig-pdf.yaml
, locate thelanguages:
line. -
Add the language you wish to translate. For example, the English looks like this:
en-us: title: darktable 3.4 user manual weight: 1
-
Save the files.
🔗Generating a PO file
Do the following steps if you want to update the POT and PO files from the markdown source.
- Create an empty PO file for your language in the
po
folder with the file namecontent.<language>.po
. For example:touch po/content.fr-fr.po
- Run the script to populate the PO file:
cd tools/ && ./generate-translations.sh --no-translations
🔗Generating translated files
Do the following steps to generate the website files from a translation.
- Generate the translated files:
cd tools/ && ./generate-translations.sh --no-update
. - Check the translation by starting hugo’s internal server:
hugo server
- Open a web browser and check the changes. The URL is in the output of the
hugo server
command. - Remove the translated files, as we never check them into git:
cd tools/ && ./generate-translations.sh --rm-translations
.
🔗Translating website and PDF strings
There are two themes for the darktable documentation: one for the HTML website and one for the PDF. You’ll need to translate the strings for both.
- Go to
themes/hugo-darktable-docs-themes/i18n
. - Copy content of the file
en.yaml
and name the new file<your language>.yaml
. - Translate the content of the new yaml file.
- Check the translated PO file into git, push it to github, and open a pull request to have your changes accepted.
- Repeat the last four steps for the other theme,
themes/hugo-darktable-docs-pdf-theme
.