Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 40 commits into from Nov 2, 2019

Conversation

@JonahAragon
Copy link
Member

JonahAragon commented Aug 6, 2019

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

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:

image

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

JonahAragon added 3 commits Aug 6, 2019
@netlify

This comment has been minimized.

Copy link

netlify bot commented Aug 6, 2019

Deploy preview for privacytools-io ready!

Built with commit d05de7f

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

JonahAragon and others added 9 commits Aug 6, 2019
yeet648 and others added 10 commits Aug 11, 2019
HTML code doesn't belong in en.yml
JonahAragon and others added 18 commits Aug 12, 2019
more: "More Cryptocurrencies"
the: "The"
team: "privacytools.io team"
endorse: "does not necessarily endorse all of the cryptocurrencies listed on this page. Please conduct your own research before purchasing any cryptocurrencies."

This comment has been minimized.

Copy link
@dawidpotocki

dawidpotocki Aug 31, 2019

Member

This is really bad idea. If someone will try to translate it, result will make zero sense.
We can't just seperate parts of one sentance.
Also, that "The" is impossible to translate in some languages, pretty much.

This comment has been minimized.

Copy link
@erciccione

erciccione Aug 31, 2019

Why? A translator will have to look for a context anyway and on weblate you can even add the context direcly on the page of the string (as picture or text).

that "The" is impossible to translate in some languages, pretty much.

Translators don't translate a sentence literally, they adapt it to their language. So i don't see any problem with this.

This comment has been minimized.

Copy link
@dawidpotocki

dawidpotocki Aug 31, 2019

Member

How you want to put in translation empty string?

This comment has been minimized.

Copy link
@erciccione

erciccione Aug 31, 2019

How you want to put in translation empty string

Why empty string?

how you want translators to know that these are part of one sentence?

Translators can find the context looking at the source string, which they should do anyway if they want their translation to be as accurate as possible and as i said, context can be added on Weblate (they have a native feature) directly when visualizing the string.

This comment has been minimized.

Copy link
@dawidpotocki

dawidpotocki Aug 31, 2019

Member

Why empty string?

Because "The privacytools.io team" would be translated to "Zespół privacytools.io" in Polish, there is no "The". So it has to be empty.

This comment has been minimized.

Copy link
@erciccione

erciccione Aug 31, 2019

Ok, i guess you are referring to the The two strings above. In that case i agree, only one variable should be used: team: "The privacytools.io team".

This comment has been minimized.

Copy link
@Mikaela

Mikaela Sep 5, 2019

Member

This may not be helpful this late, but Finnish and Czech don't have "the" either, in Swedish it would be a part of the word (vatten = the water IIRC) and some languages like Spanish have two different word for it, masculine and feminine, I am not sure if there is also neutral.

@JonahAragon JonahAragon merged commit d05de7f into master Nov 2, 2019
4 of 7 checks passed
4 of 7 checks passed
Header rules No header rules processed
Details
Pages changed 66 new files uploaded
Details
Redirect rules No redirect rules processed
Details
Mixed content No mixed content detected
Details
Travis CI - Branch Build Passed
Details
Travis CI - Pull Request Build Passed
Details
deploy/netlify Deploy preview ready!
Details
@djoate

This comment has been minimized.

Copy link
Contributor

djoate commented Nov 3, 2019

I'm sorry, @JonahAragon but it looks like my merging of master into i18n closed this PR and its associated issue, #1106. Could you see if you can reopen the PR and the issue?

@JonahAragon

This comment has been minimized.

Copy link
Member Author

JonahAragon commented Nov 3, 2019

@djoate oh. No, that was my mistake. Earlier I merged your PR into the master branch of the actual repository 😳 — I undid that little mistake but didn't realize that it had closed this PR too. I don't think I can reopen this so I'll make another PR.

@privacytoolsIO privacytoolsIO locked as resolved and limited conversation to collaborators Nov 3, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.