Skip to content

Commit

Permalink
updates to translator guides. hotosm/learnosm#329 refers
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick-Tallguy committed Jun 21, 2017
1 parent 271b87d commit 8057b02
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 21 deletions.
9 changes: 9 additions & 0 deletions _posts/0150-06-20-images-translator.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,16 @@ Any problems, please make contact -
- raise an issue on Transifex
- all of these means (and some others!) make their way to the same team.

![pull-request][]

![comment-pull][]

![compare-fork][]

[Github 1]: /images/contribute/translate-image-header.png
[Github 2]: /images/contribute/translate-image-upload.png
[fork]: /images/contribute/translate-image-fork.png
[Github 2]: /images/contribute/translate-image-upload.png
[pull-request]: /images/contribute/creating_new_pull_request.png
[comment-pull]: /images/contribute/comment_your_pull_request.png
[compare-fork]: /images/contribute/choose_your_fork_to_compare.png
50 changes: 29 additions & 21 deletions _posts/0150-09-20-translator.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Translators using Transifex - instructions
- TOC
{:toc}

This guide is an updated version of the guides currently located at <https://github.com/Nick-Tallguy/Nick-Tallguy.github.io/wiki/Translator-instructions-for-Transifex>. When these instructions are complete they will be added to the site at <http://learnosm.org/en/> and made to appear in all available languages.
This guide is an updated version of the guides currently located at <https://github.com/Nick-Tallguy/Nick-Tallguy.github.io/wiki/Translator-instructions-for-Transifex>. When these instructions are complete they will be added to the site at <http://learnosm.org/en/> and made to appear in all available languages.

Transifex
------------
Expand All @@ -26,7 +26,7 @@ The Two sites
-------------

### LearnOSM
The main LearnOSM site is at <http://learnosm.org/> and this is the site we are aiming to update. If you search on the internet, this is the site you will find. The modules on this site are all at 100% completion, but there are a few shortcuts in place to make sure that visitors do not get .404 errors.
The main LearnOSM site is at <http://learnosm.org/> and this is the site we are aiming to update. If you search on the internet, this is the site you will find. The modules on this site are all at 100% completion, but there are a few shortcuts in place to make sure that visitors do not get .404 errors.

There are also some translations on this site which were created before we started using Transifex. However, these modules are gradually becoming out of date, and we would like them replaced with new translations provided by you using Transifex.

Expand All @@ -48,20 +48,20 @@ Getting started

Before requesting a new language, check to see which languages are already in use. It may be that your language team already exists within **HOTOSM**, and you just need to change your search slightly.

A language team may include; translators, reviewers and co-ordinators, or you may be the only person doing the translations for your language.
A language team may include; translators, reviewers and co-ordinators, or you may be the only person doing the translations for your language.

### 1-essential_setup txt

There are some language 'strings' which appear within fairly complex files needed to make LearnOSM work in your language. These strings have been put together into a file called **1-essential_setup.txt** and this file should be your first priority when starting to translate LearnOSM.

Please check back on this file at intervals as well please, as we sometimes add extra strings - for instance we added a ![up-arrow][]{: height="24px"} at the bottom of each page, and it needed the language string **Return to top of page**.
Please check back on this file at intervals as well please, as we sometimes add extra strings - for instance we added a ![up-arrow][]{: height="24px"} at the bottom of each page, and it needed the language string **Return to top of page**.

**Please note**
Most, but not all of the strings are a simple translation.
However, the string:

Replace all of this text with the one word to be
used in the 'language switcher', such as English,
Replace all of this text with the one word to be
used in the 'language switcher', such as English,
Español, or Русский

just requires you to provide the name of your language in its native tongue. This may only be one word, such as **Español**, or it may be more than one word.
Expand All @@ -72,51 +72,59 @@ Please translate the following, preferably in this order;

1. 0200-12-31-beginner.md
2. 0200-12-29-introduction.md
3. 0200-12-27-start-osm.md
3. 0200-12-27-start-osm.md

**We will only add you're completed translations to the main LearnOSM site once you have translated *1-essential_setup.txt, 0200-12-31-beginner.md, 0200-12-29-introduction.md, and 0200-12-27-start-osm.md***

Translating a module - using 0200-12-31-beginner as an example
--------------------
Translating a module - using 0200-12-31-beginner as an example
--------------------

The first few lines of any module (apart from 1-essential_setup.txt) are instructions to the computer on how and where to display the module. If you get it wrong you may have trouble finding it, and it may cause problems elsewhere on the site - however, the problems are easily fixed - read on......
The first few lines of any module (apart from 1-essential_setup.txt) are instructions to the computer on how and where to display the module. If you get it wrong you may have trouble finding it, and it may cause problems elsewhere on the site - however, the problems are easily fixed - read on......

### Three dashes
### Three dashes

---
---

The three dashes are a computer instruction - just copy them. You can use this button ![tx-copy-button][]{: height="34px"} and then click on ![tx-save][]{: height="34px"}
The three dashes are a computer instruction - just copy them. You can use this button ![tx-copy-button][]{: height="34px"} and then click on ![tx-save][]{: height="34px"}


### layout doc

layout: doc
layout: doc

is a computer instruction and should be copied across unchanged. The computer is not friendly and it will not accept any variations! The spacing must be exactly the same and it must be a colon. The safest thing to do is ![tx-copy-button][]{: height="34px"} and then click on ![tx-save][]{: height="34px"}
is a computer instruction and should be copied across unchanged. The computer is not friendly and it will not accept any variations! The spacing must be exactly the same and it must be a colon. The safest thing to do is ![tx-copy-button][]{: height="34px"} and then click on ![tx-save][]{: height="34px"}

> If your is a right to left language, please add **-rtl** after **doc** so that it reads **layout: doc-rtl**
> If your is a right to left language, please add **-rtl** after **doc** so that it reads **layout: doc-rtl**
### permalink en beginner

permalink: /en/beginner/
permalink: /en/beginner/

This needs altering. The **/en/** part of the string is instructing the computer that this is part of the English section. You need to alter this to your language. Transifex is very helpful, if you look at your screen you will see in the web address bar something like (I'm using Hungarian in this example)

https://www.transifex.com/hotosm/learnosm-1/translate/#hu/0200-12-31-beginnermd/51681420
https://www.transifex.com/hotosm/learnosm-1/translate/#hu/0200-12-31-beginnermd/51681420

and the /#hu/ indicates that the language code is **hu**. You will also see this information elsewhere on your screen, looking something like this ![Hungarian][]{: height="34px"}
and the /#hu/ indicates that the language code is **hu**. You will also see this information elsewhere on your screen, looking something like this ![Hungarian][]{: height="34px"}

In this example, with the language code **hu**, you need to change the string to read

permalink: /hu/beginner/
permalink: /hu/beginner/

and then save it.

> Some language codes have more than two letters, such as **zh_TW**. Please ensure that you use your language code in exactly the same way as Transifex does.
> Some language codes have more than two letters, such as **zh_TW**. Please ensure that you use your language code in exactly the same way as Transifex does.
ToDo
add another language for examples above - one using something like nl_NL or zh_TW
hidden text
images
Getting help - email, issues, transifex issues
Links to Transifex guides

-----------------------------------------------------------

## Below this line is waiting for review - the 'old instructions'

You are viewing these instructions on a 'staging site', but the information is transferred frequently between this site and the main LearnOSM site. The [current staging site can be viewed here](http://nick-tallguy.github.io/en/). By using this staging site as an interim, we can check that we haven't lost any formatting marks in the translation process. Don't worry about losing the formatting - we'll put it back in afterwards, as long as we can work out where it goes.

LearnOSM has been using Transifex for a while, but we're still learning! Feedback is appreciated. At present we're not sure how many formatting marks will actually appear in the file that you view, or in the file which we download at the end of the process, so this guide is written on a very provisional basis.
Expand Down
Binary file added images/contribute/Hungarian.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/contribute/tx-copy-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/contribute/tx-save.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8057b02

Please sign in to comment.