From 3a6979dcaac3020bc1267bfcdaee7d661457d9ba Mon Sep 17 00:00:00 2001 From: Nick-Tallguy Date: Wed, 21 Jun 2017 01:05:12 +0100 Subject: [PATCH] Translator instructors updated. https://github.com/hotosm/learnosm/issues/329 refers --- _posts/0150-09-20-translator.md | 115 +++++++++++++++++++++++++++++--- _posts/0900-12-25-gps_zh_TW.md | 4 +- 2 files changed, 109 insertions(+), 10 deletions(-) diff --git a/_posts/0150-09-20-translator.md b/_posts/0150-09-20-translator.md index 4346fc602..c92211d4d 100644 --- a/_posts/0150-09-20-translator.md +++ b/_posts/0150-09-20-translator.md @@ -2,12 +2,12 @@ layout: doc permalink: /en/contribute/translator/ lang: en -title: Translators instructions +title: Translators using Transifex - instructions category: contribute nosearch: true --- -Translators instructions +Translators using Transifex - instructions ======================== **This guide is still at the draft stage.** @@ -15,15 +15,107 @@ Translators instructions - TOC {:toc} -This guide will have an updated version of the guides currently located at . +This guide is an updated version of the guides currently located at . When these instructions are complete they will be added to the site at and made to appear in all available languages. -When the instructions are updated & on this site in an agreed position then; +Transifex +------------ -1. Update the link on the Transifex site to the translator instructions, and -2. Delete the guide on the staging site wiki, but add a link there to these instructions in case someone has bookmarked it. +The volunteers who update LearnOSM have tried various ways to provide translations for the site, but have found that the simplest for all concerned involves using . We are part of the Humanitarian OpenStreetMap Team and fall within their charitable status. Transifex kindly allow us to use their services free of charge. +The Two sites +------------- -# Translator instructions - Transifex +### LearnOSM +The main LearnOSM site is at 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. + +### The Staging or testing site +We have a second site which we use for testing purposes, and which is used to allow translators to check on their progress and see how the site will appear in their language. + +When we are testing things out they will appear on the staging site - but sometimes they never appear on the main LearnOSM site - not all ideas are good! If we are considering altering the layout of pages, changing the margins, or otherwise altering the site it will appear here first. Modules which are being developed are also created on the staging site and reviewed before being placed on the main site, and into Transifex for your translation. + +The staging site is also there for you to check on your progress and to make sure things are formatted correctly - if you accidentally alter the 'address' for an image, the image will not appear on the web page, but you can review your work here, return to Transifex and fix the problem. **Modules appear on the staging site when they are at least 10% translated.** If you can't find the module you've been translating, you've probably made a mistake which we hope you can correct using the information from this guide. We're still working out the best time(s) to update the site, and at present (June 2017) the site updates at least once a day. + +Getting started +--------------- + +1. Go to and log in, or create an account. +2. Once logged in, search for **HOTOSM** and when you find it, request to join the team of translators +3. **HOTOSM** has several different projects on Transifex and LearnOSM is not always the most urgent - for instance a new version of the Tasking Manager may need 'strings' translated ready for its deployment. + +### Joining a Language Team + +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. + +### 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 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, + 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. + +### The Beginner Section is next + +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 + +**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 +-------------------- + +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 + + --- + +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 + +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** + +### 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 + +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/ + +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. + + +----------------------------------------------------------- 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. @@ -37,10 +129,12 @@ We are carrying out a review of any guide before uploading it to Transifex, and -### essential-setup.txt +### essential-setup txt + This is the file that contains all of the strings we need to use to make a language appear on the site, and to label all of the buttons. It's the first file we will need translating. Many of the strings appear on the Home page of the language you are translating, other strings will be used by the maintenance volunteers when they are adding downloadable versions of the guides, and also to add links to available sections. ### The priorities column + When you view the list of 'resources' for translation you should see a timer icon at the far right of the list. We can alter the priority of a guide using this timer. At present the only 'resource' which has a priority set is the **essential-setup.txt** resource which we need for ongoing maintenance. If / when there is an ongoing **Activation** because of a disaster, other guides may be labelled as more urgent. ### beginners section @@ -84,3 +178,8 @@ as should the file link which relates to it, which will probably be at the foot The spaces at the beginning of lines of text are formatting instructions that the text and images should be indented. There are often two spaces at the end of a line of text, which is also a formatting instruction, as is `>` if it is at the beginning of a line. + +[up-arrow]: /images/arrow-up.png +[tx-copy-button]: /images/contribute/tx-copy-button.png +[tx-save]: /images/contribute/tx-save.png +[Hungarian]: /images/contribute/Hungarian.png diff --git a/_posts/0900-12-25-gps_zh_TW.md b/_posts/0900-12-25-gps_zh_TW.md index 69a09f87f..2bd00565d 100644 --- a/_posts/0900-12-25-gps_zh_TW.md +++ b/_posts/0900-12-25-gps_zh_TW.md @@ -1,6 +1,6 @@ --- layout: doc -title： 用 Garmin GPS 來探勘 +title: 用 Garmin GPS 來探勘 permalink: /zh_TW/mobile-mapping/using-gps/ lang: zh_TW category: mobile-mapping @@ -295,4 +295,4 @@ places to OpenStreetMap. [turn on track]: /images/mobile-mapping/turn-on-track.png [GPSBabel Interface]: /images/mobile-mapping/babel.png [Choose GPX XML]: /images/mobile-mapping/xml.png -[GPS Files Open in JOSM]: /images/mobile-mapping/open-josm.png \ No newline at end of file +[GPS Files Open in JOSM]: /images/mobile-mapping/open-josm.png