Skip to content

Commit

Permalink
Merge branch 'patch-2' of git://github.com/rngl4b/graphene-ui into rn…
Browse files Browse the repository at this point in the history
…gl4b-patch-2
  • Loading branch information
xeroc committed Oct 28, 2015
2 parents a6688d5 + dba02d8 commit fbaa6b7
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions translate-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,50 +5,53 @@ Translating Graphene

* **Graphene's GUI** repository is bridged with [**Transifex translation platform**](https://www.transifex.com/bitshares) for continuous localization.

* Source language files are updated in real time when added or modified in Graphene repository.
* Source language files are updated in real time when text is added or modified in Graphene's repository.
Tanslators can choose to be notified on changes.

* Once a translation is completed, and reviewed by its [**Language Coordinator**](http://docs.transifex.com/introduction/#user-roles-in-transifex),
it is automatically pushed to an intermediate repository where the code's syntax preservation is inspected.

* When all resources for a given language are translated and reviewed they are pushed to the main repository, to be included in the next release.

* **You can join the translation team** by requesting resources and language in which you want to start translating, at **https://transifex.com/bitshares**.
* **You can join the translation team** by requesting resources and language in which you want to participate at **https://transifex.com/bitshares**.
You can create an account for free or simply log in with your Github or Gmail account.

* [**Using the Transifex Web Editor is easy**](http://docs.transifex.com/tutorials/txeditor/)


## Instructions:

###### For a translation to be completed we have work on two different kind of files. There's one single file with all the short strings that belongs to the interface itself, and the markdown help files that are embedded on many sections from the interface.
###### For a translation to be completed we have to work on two different type of files. There's one single file with all the short strings that belongs to the interface itself, and on the other side the markdown help files that are embedded on many sections in the interface.
###### As both resources have different formats they are divided in two Transifex projects:

### Main interface strings
### Graphene User Interfase, main strings

**https://www.transifex.com/bitshares/graphene-ui**

* This file has JSON line key/value paires. Only values must be translated (just the text between double quotes).
#### **Two simple rules:**

* Some values have placeholders with the format "%(variable)s", those should not be translated. They can be moved inside a string if needed for better syntax but they should not be modified.
1. This file has JSON style key/value pairs. Only values must be translated (justthe text between "double quotes").

* The best practis is to use the [**Copy source string button**](http://docs.transifex.com/tutorials/txeditor/#4-translation-time) and edit just de translatable text.
2. Some values have placeholders with the format "%(variable)s", those should not be translated. They can be moved inside a string if needed for better grammar, but they should not be modified.

##### The best practice is to use the [**Copy source string button**](http://docs.transifex.com/tutorials/txeditor/#4-translation-time) and just replace de translatable text.
===

### Help content files

**https://www.transifex.com/bitshares/graphene-ui-help**

This are Github markdown pages. This makes translated content highly portable, ready to use on other interfacs and websites.
Actually Transifex does not support markdown format so we have to work with plain text here too. That means each line is considered as a string.
It can be a little annoying but worth it for the continuous integration.
* These are Github markdown pages. This approach makes translated content highly portable, ready to use on many other interfaces and websites.

* Actually Transifex does not support markdown format so we have to work with plain text here too. That means each line is parsed as one string. This can be a little annoying but it is worth for the sake of continuous integration.

##### Two simple rules:
#### **Two simple rules:**

* To preserve markdown syntax all symbols must remain where they are.
Here again, when markdown formating is present, using the [**Copy source string button**](http://docs.transifex.com/tutorials/txeditor/#4-translation-time) helpful.
1. To preserve markdown syntax all symbols must remain where they are: ###. [ ] ( ) ** ** __ __ etc.
Here again, when markdown formating is present, using the [**Copy source string button**](http://docs.transifex.com/tutorials/txeditor/#4-translation-time) is very helpful to prevent mistakes.

* Link names can be translated but we have to preserve paths and filenames. Links looks like:
2. Link names can be translated but we have to preserve paths and filenames. Links looks like this:
```
[translatable link name](non-translatable/path-to/filename.md)
```
* 100% translated and reviewed pages are instantly available at **https://github.com/rngl4b/graphene-ui/tree/transifex/help**
##### 100% translated and reviewed pages are instantly available at https://github.com/rngl4b/graphene-ui/tree/transifex/help

0 comments on commit fbaa6b7

Please sign in to comment.