GPG guide/Translation Guide

From LibrePlanet
< GPG guide
Revision as of 11:41, 22 January 2016 by Zakkai (talk | contribs) (Using the git repository)
Jump to: navigation, search

Organization

Translating Email Self-Defense

So you want to translate the FSF's guide to email encryption? Great! To translate, you'll have to know or be willing to learn basic-level HTML, git and SSH, and possess fluency in English as well as the target language. If you're not comfortable with the technical tools but would like to translate, we recommend you find a friend with these skills and work with them.

First, send a message to campaigns@fsf.org stating your intention. We ask that you not begin translating until you receive a reply, so that we can connect you with other translators working in your language and avoid reduplicating effort.

Once you get the go-ahead from the FSF, send your SSH public keys to sysadmin@fsf.org, CCing campaigns@fsf.org. When they tell you that they have given you access to the git repository, you are ready to begin.


Using the git repository

The in-development translations are stored in a git repository that is visible at enc-dev0.fsf.org/master. Each language is stored in a directory there. When your translation is complete there, the FSF will copy it to emailselfdefense.fsf.org.

See https://libreplanet.org/wiki/GPG_guide/Checking_Out for technical instructions on using the git repo.

Before each translation session, make sure to run a git pull on your language directory, and commit and push your changes when you sign off. Don't wait until you've finished the whole translation to commit and push. This way, I'll be able to track your work and help if needed.

Once you've pushed your changes, they should appear at enc-dev0.fsf.org/master/[YOUR LANGUAGE CODE]

Working as an effective team

You are responsible for communicating with your fellow translators working in your language, but please let the FSF know if you experience any issues or need help resolving a conflict.


Review

Please have at least one person review everything that is translated, comparing the original and target texts. This person needs to be able to speak English as well as the target language. If a piece of text was translated by two or more people working as a team, that counts as well. In short, at least two sets of bilingual eyes should have seen everything before the translation is complete.


Elements to Translate

If you are just starting your translation, your folder will be pre-filled with a copy of the latest English copy when you start translating. This is just a placeholder - DON'T WORK FROM IT. Also, don't work from the current version at emailselfdefense.org. Instead, please work from the English copy at enc-dev0.fsf.org/en, which is also in the /en directory of the repo. The reason for this is that ocassionally we make changes during translation and we will only change them in enc-dev0.fsf.org/en. If we do make changes, we'll be sure to alert you.

It is important that you only edit your own language's directory. If you find a typo or other issue with the English version, please let the FSF know, rather than fixing it yourself.

If you are updating a translation or spend more than a week on your translation, see https://libreplanet.org/wiki/GPG_guide/Version_Log for a comprehensive version changelog.


Text on all pages

  • index.html
  • mac.html
  • windows.html
  • next_steps.html
  • confirmation.html
  • infographic.html

Text Instructions

There are three operating system pages: index.html (which is for GNU/Linux), windows.html and mac.html. They are exactly the same except for Section 1 and the troublshooting section for Step 2.a. This should allow you to copy and paste for most of them.

You don't need to translate anything that is commented out.

Make sure to translate the text in the sharing URLs, which are the ones with URLs that start with fsf.org/share. The URLs include the text of the message that will be shared, and that's what must be translated. Once you've translated them, click on them from the page and try sharing with a few different methods and check for formatting errors. You will need to not use hashtags in the sharing links because, ironically, they mess up our Twitter sharing.


Language Picker

On all pages with a language picker, modify the language picker so that your language is the active class instead of English.


Graphics

  • join and donate buttons
  • all inline images
  • infographic and "view and share our infographic" thumbnail image
    • Edit the large URL at the bottom of the infographic to point to your translation, by adding your two letter language code to the end. For an example, see [1].

Graphics Instructions

You can get the image source files from the source package in the /en directory. Translate them, using the closest you can find to the fonts in the source package for your language, then create the pngs from the sources. You may find the Graphics Howto useful if you have little experience with Inkscape.

Next you'll add your images to the static directory. This directory is a submodule, so you'll need to run 'git submodule update' from the root directory of the repo before working it. Then navigate to /static/img and create a directory named after your language, like en. Put all your translated pngs into that directory. Even if an image does not have text, copy it into your language's directory in static. For committing your changes in static submodule, see the simple instructions at https://libreplanet.org/wiki/GPG_guide/Checking_Out

Once you're done with this, edit the HTML in your language's pages to call the images from your language's directory in static. Even if an image does not have text, call the copy in your language's directory.


Source package

You can use the .zip source package in /en as a model for this. Make sure to translate the README as well. Even if an image isn't translated because there is not text, it should still be in the source package for your language.

The source package also includes the text of the messages for Edward the reply bot, which you should translate as well. This is the only place on the site where Edward's text is. Please preserve the numbers above each message and the "Subject" and "Body" tags so that the FSF's English-speaking sysadmins know what to put where.

When you are done, compress it and commit it as a single archive.

Remember to update this when you change an image.


Note: don't forget to remove the (normally hidden) backup files before compressing, for 2 reasons:


Links

If a link points to something that you can easily find a translation of in your language hosted by the FSF or GNU, please modify the link to point to it. If you find a translation by someone else, please let the FSF know and we will review the translation to see if we can link to it instead.

Make sure to test all links and buttons.

Test any forms.

Preserve HTTP/HTTPS.


Attribution and licensing

If you'd like to get credit for your work, add your name to the commented-out attribution line in the footer and comment it back in. Make sure to do this on all pages.

Please don't change the licensing info on the page there - this means that your translation will be copyright FSF under the terms currently in the footer. If you are concerned about a licensing question, let us know. Make sure the footer is the same on all translated pages.