[WIP] Add Weblate Support, Move Strings to YAML Files #1458

jonah · 2019-11-03T04:17:30Z

jonah commented

2019-11-03 04:17:30 +00:00

➡️ Info and checklist to-do @ #1106 ⬅️

11/02: Oops, I accidentally closed #1105. Continuing this discussion here!

Alright. So it turns out if we use jekyll-multiple-languages-plugin and throw every single string on the site into /_i18n/en.yml we can then use our Weblate install to translate the site much easier.

The problem of course, is moving all the strings manually 😅

So that's going to be my project for now. As of df38bc4 I have successfully moved... the index page to en.yml, which took about an hour 🙄

If anyone wants to help me out with this (which I would greatly appreciate), I'm doing this work in the i18n branch of this repo. If you aren't an org member you can create Pull Requests to that branch (as opposed to master), by selecting i18n instead as the base branch in your pull request:

What needs to be done

Every English text string in every (HTML and Markdown) file needs to be moved to a key in en.yml. For example, lets look this line in _includes/sections/privacy-resources.html:

...
<h1 id="resources" class="anchor"><a href="#resources"><i class="fas fa-link anchor-icon"></i></a> More Privacy Resources</h1>
...

That is of course the More Privacy Resources header on the homepage. What I've done is taken the English text out of that line, and placed it en.yml, like so:

...
privacy_resources:
  header: "More Privacy Resources"
  ...

Then, back in the HTML file, I replaced the English text with {% t privacy_resources.header %} (which is a Jekyll tag saying to translate the string privacy_resources.header (from the lines above). Like so:

<h1 id="resources" class="anchor"><a href="#resources"><i class="fas fa-link anchor-icon"></i></a> {% t privacy_resources.header %}</h1>

Which really isn't that hard! It's simply time consuming to copy/paste everything into this file.

`en.yml`

You can see how I've formatted this file already, but basically it should be like:

PAGE:
  KEY: "String"

Where "Page" is the section being translated, Key is a brief description, and "String" is the English text. At the top there is also a "Global" section, for strings that are reused a bunch on different pages:

global:
  further_reading: "Further Reading"

Pretty much everything needs to go into this file, and then this file will automatically be used as the base in Weblate upon which all translations will be based on (which will be far easier).

Closes #1106

➡️ **Info and checklist to-do @ #1106** ⬅️ --- 11/02: Oops, I accidentally closed #1105. Continuing this discussion here! --- Alright. So it turns out if we use [jekyll-multiple-languages-plugin](https://github.com/kurtsson/jekyll-multiple-languages-plugin) and throw *every single string on the site* into `/_i18n/en.yml` we can then use [our Weblate install](https://weblate.nablahost.com/projects/privacytoolsio/) to translate the site much easier. The problem of course, is moving all the strings manually 😅 So that's going to be my project for now. As of df38bc4 I have successfully moved... the index page to `en.yml`, which took about an hour 🙄 If anyone wants to help me out with this (which I would greatly appreciate), I'm doing this work in the [`i18n` branch](https://github.com/privacytoolsIO/privacytools.io/tree/i18n) of this repo. If you aren't an org member you can create Pull Requests to that branch (as opposed to master), by selecting i18n instead as the base branch in your pull request: <img width="234" alt="image" src="https://user-images.githubusercontent.com/3637842/62512624-55b41a00-b7de-11e9-95c1-5d7c3136098b.png"> ## What needs to be done Every English text string in every (HTML and Markdown) file needs to be moved to a key in `en.yml`. For example, lets look this line in `_includes/sections/privacy-resources.html`: ``` ... <h1 id="resources" class="anchor"><a href="#resources"><i class="fas fa-link anchor-icon"></i></a> More Privacy Resources</h1> ... ``` That is of course the **More Privacy Resources** header on the homepage. What I've done is taken the English text out of that line, and placed it `en.yml`, like so: ``` ... privacy_resources: header: "More Privacy Resources" ... ``` *Then*, back in the HTML file, I replaced the English text with `{% t privacy_resources.header %}` (which is a Jekyll tag saying to `t`ranslate the string `privacy_resources.header` (from the lines above). Like so: ``` <h1 id="resources" class="anchor"><a href="#resources"><i class="fas fa-link anchor-icon"></i></a> {% t privacy_resources.header %}</h1> ``` Which really isn't that hard! It's simply time consuming to copy/paste everything into this file. ## `en.yml` You can see how I've formatted this file already, but basically it should be like: ``` PAGE: KEY: "String" ``` Where "Page" is the section being translated, Key is a brief description, and "String" is the English text. At the top there is also a "Global" section, for strings that are reused a bunch on different pages: ``` global: further_reading: "Further Reading" ``` Pretty much everything needs to go into this file, and then this file will automatically be used as the base in Weblate upon which all translations will be based on (which will be far easier). Closes #1106

privacytoolsIO (Migrated from github.com) reviewed 2019-11-03 04:17:30 +00:00

netlify[bot] commented

2019-11-03 04:19:14 +00:00

(Migrated from github.com)

Deploy preview for privacytools-io ready!

Built with commit 86eb0a8f50

https://deploy-preview-1458--privacytools-io.netlify.com

Deploy preview for *privacytools-io* ready! Built with commit 86eb0a8f50e9e1ad1c05bceaad1e535c261b6418 https://deploy-preview-1458--privacytools-io.netlify.com

This repo is archived. You cannot comment on pull requests.

1 Participants

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: privacyguides/privacytools.io#1458