Adding a Localization

Please contact me before beginning a localization so that I can coordinate effort. Sometimes I have more than one volunteer per language!

Also, please join the mailing list so that I can notify you when new strings are added to Inkpad: Inkpad-Localization

Using Github and git (preferred method)

There steps assume familiarity with Github and git. See Email The Files below for alternative steps.

Translating Strings Files

1. Fork Inkpad

2. Duplicate the folder named en.lproj

3. Rename the duplicated folder with the appropriate 2 letter ISO 639-1 code for your language. For example, if you’re adding the German localization, name your folder de.lproj. Here is a list of language codes: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

4. Within each strings file in your localization folder, provide an appropriate translation for each string. See Strings File Format below.

5. Add the new localization folder to your Inkpad project (in the Resources group)

6. Commit the change via git and push the changes to Github

7. Submit a pull request for your changes.

Strings File Format

The format of the file is as follows (from en.lproj/Localizable.strings):

/* Add to Photo Album */
"Add to Photo Album" = "Add to Photo Album";

The first line (between /* and */) is a comment that may give more context for the string. The second line displays the English string on the left and the string to be localized on the right. You will want to edit all the strings on the right.

For example, here’s the corresponding entry in fr.lproj/Localizable.strings:

/* Add to Photo Album */
"Add to Photo Album" = "Ajouter à l'Album Photo";

#####Notes:

• You can submit additional pull requests for future edits or improvements.

• Please make sure that there are no other changes aside from the translation in the pull request.

• Contact me with any question or difficulties (or errors in this guide).

Translating the In-App Help

When localizing the user interface, we should ideally localize the in-app help too. To do so, follow these steps.

1. Duplicate the file Help/index.html

2. Rename the duplicated file to include your two letter language code (for example: index_de.html)

3. Translate the text in your duplicated file

4. Add the new file via git (NOTE: it’s NOT added directly to the Xcode project)

5. Commit the change and push it to Github

6. Submit a pull request.

Email The Files (alternative method)

If you're not comfortable with git and Github, follow these steps:

1. Download the Inkpad project by clicking the Download ZIP button here: https://github.com/sprang/Inkpad

2. Edit the files as described above (Steps 2-4)

3. Email me your modified files and I will integrate them into Inkpad