Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

nls readme.md update #8438

Merged
merged 7 commits into from
Aug 4, 2014
Merged

nls readme.md update #8438

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e333fca
Sort localization by iso country code.
tan9 Jul 17, 2014
e6a06c8
Added Traditional Chinese.
tan9 Jul 17, 2014
a2938c6
Prefix "commit_" to "SHA_of_root_strings.js".
tan9 Jul 17, 2014
d050f9a
Recommend adding commit tracking comment in index.html.
tan9 Jul 17, 2014
26ee520
Described the "Getting Started" folder name localization limitation.
tan9 Jul 17, 2014
d2b672d
Fixed typo.
tan9 Jul 17, 2014
f03c94d
Fixed another typo :(
tan9 Jul 17, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions src/nls/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
4. Copy the root `strings.js` file into your subfolder and start translating!
5. Use the [UI walkthrough steps](https://github.com/adobe/brackets/wiki/Localization-Tests) to
see strings in context.
6. Add this comment ``/* Last translated for SHA_of_root_strings.js */`` at the end
of your `strings.js` and replace `SHA_of_root_strings.js` with the actual SHA. You can
copy the actual SHA in this [history page](https://github.com/adobe/brackets/commits/master/src/nls/root/strings.js)
6. Add this comment ``/* Last translated for commit_SHA_of_root_strings.js */`` at the end
of your `strings.js` and replace `commit_SHA_of_root_strings.js` with the actual SHA.
You can copy the actual SHA in this [history page](https://github.com/adobe/brackets/commits/master/src/nls/root/strings.js)
by hovering on the one you used for this translation and click on Copy SHA button.
7. Edit this file and update the list of languages below!

Expand All @@ -31,6 +31,9 @@ providing a ``urls.js`` file that points to a localized directory under the
``samples`` folder at the root of the Brackets repository. See the French
localization (`src/nls/fr/urls.js`) for an example.

It is also recommended to add this comment ``<!-- Last translated for commit_SHA_of_root_index.html -->``
at the end of your `index.html` and replace `commit_SHA_of_root_index.html` with the actual SHA.


# How to modify *existing* translations

Expand Down Expand Up @@ -64,6 +67,7 @@ The following languages have been contributed by the Brackets community:
* Galician (gl)
* Croatian (hr)
* Hungarian (hu)
* Indonesia (id)
* Italian (it)
* Korean (ko)
* Norwegian (nb)
Expand All @@ -78,7 +82,7 @@ The following languages have been contributed by the Brackets community:
* Swedish (sv)
* Turkish (tr)
* Simplified Chinese (zh-cn)
* Indonesia (id)
* Traditional Chinese (zh-tw)

These translations _can be directly modified_ through our normal pull request
process. Make sure that you also update the comment on the last line with the
Expand Down Expand Up @@ -106,8 +110,9 @@ You will be taken to a New File page where you:

1. Specify the file name as *language-id*/strings.js
2. Paste in the contents of root/strings.js and edit strings for new language
3. Add this comment `/* Last translated for SHA_of_root_strings.js */`
at the end of your strings.js and replace `SHA_of_root_strings.js` with the actual SHA.
3. Add this comment `/* Last translated for commit_SHA_of_root_strings.js */`
at the end of your strings.js and replace `commit_SHA_of_root_strings.js` with the
actual SHA.
You can copy the actual SHA in this
[history page](https://github.com/adobe/brackets/commits/master/src/nls/root/strings.js)
by hovering on the one you used for this translation and click on Copy SHA button.
Expand Down Expand Up @@ -171,3 +176,5 @@ Some strings cannot be localized yet:
* [Keyboard shortcuts](https://trello.com/c/4k2yalBd)
* [Some native menus on Mac](https://trello.com/c/0IsE7q02) (hardcoded support only for English, French, Japanese)
* Windows installer UI (hardcoded support only for English, Japanese - with some limitations)
* Localized folder name of "Getting Started" has to be made of up basic English characters only, as described
[here](https://github.com/adobe/brackets/pull/8332#issuecomment-48767847).