Translation Rules

Instructions

Before translating content, make sure someone is not doing so already. Incomplete translations that have not been updated for a week are free to be taken over by another person (unless a good reason is given). If you plan to edit a translation, please contact the original translator before proceeding. In the event you are not able to get a hold of the translator for a week, you are free to edit.

To indicate that you are translating/editing material, please add your name to the Translator and Editor List as follows:

• Filename
  • Translator/Editor Name: [ISO 639-1 Language Code]_[ISO_3166-2 Country Code (territory is optional)]

Example:

• Array.yaml
  • Japanese Translator: ja_JP
  • Japanese Editor: ja_JP

Example with territory (for Osaka dialect):

• Array.yaml
  • Japanese Translator: ja_JP-27
  • Japanese Editor: ja_JP-27

Once you've indicated your interest, copy the file in the form Filename.yaml to the form:

Filename-[ISO 639-1 Language Code]_[ISO_3166-2 Country Code (territory is optional)].yaml

Example:

Array-ja_JP.yaml Array-ja_JP-27.yaml

Editors do not need to rename the translated file.

Editing Rules

YAML is indentation sensitive. Sample YAML output looks like this:

---
:name: Array
:comment: |-
  Arrays are ordered, integer-indexed collections of any object.
  Array indexing starts at 0, as in C or Java.  A negative index is
  assumed to be relative to the end of the array---that is, an index of -1
  indicates the last element of the array, -2 is the next to last
  element in the array, and so on.
:instance_methods: 
- :name: initialize_copy
  :arglist: ary.replace(other_ary)  -> ary
  :comment: |-
    Replaces the contents of +self+ with the contents of
    <i>other_ary</i>, truncating or expanding if necessary.
    
       a = [ "a", "b", "c", "d", "e" ]
       a.replace([ "x", "y", "z" ])   #=> ["x", "y", "z"]
       a                              #=> ["x", "y", "z"]

The indentation must remain the same as the original. Indentation levels are 2 spaces each. Please set your editor accordingly and do not use tabs. Wrap lines at 75 characters. Files should be encoding in UTF-8 to be consistent.

The parts after :comment: |- are what need to be translated. I will be creating a separate categorization file for translation of the actual class / module names, so translation of the name is not necessary.

Submitting translations

To submit translated files please fork the project, create the files in your copy and the create a pull request with the changes.