PrayTimes.org

Add-on Translation Guide

From Pray Times

(Difference between revisions)
m (→Start Translation)
m
Line 1: Line 1:
This is a quick guide on how to translate Pray Times! Firefox add-on.
This is a quick guide on how to translate Pray Times! Firefox add-on.
-
== Preparing Environment ==
+
== Set Up the Environment ==
=== Copy files ===
=== Copy files ===
-
Download the addon [http://praytimes.org/addon/files/praytimes1.2 zip file] and extract it in a directory on your local drive. We refer to this directory as [addon-dir] in the following.
+
Download [http://praytimes.org/addon/files/praytimes1.2 Pray Times! 1.2 zip file] and extract it in a directory on your local drive. We refer to this directory as [addon-dir] in the following.
=== Make a new Firefox profile ===
=== Make a new Firefox profile ===
-
Use the following steps to create a new Firefox profile for the translation work (it is assumed that your operating system is Windows):
+
* Open [addon-dir]/dev folder and double-click on <code>my-firefox.bat</code> to run it (we assume that you are using Windows)
-
 
+
-
* Open [addon-dir]/dev folder
+
-
* Double-click on <code>my-firefox.bat</code>
+
* The Firefox profile dialog appears. Click on 'Create Profile..'
* The Firefox profile dialog appears. Click on 'Create Profile..'
-
** Skip the first page of the wizard.
+
* Create a profile with name 'praytimes' in a custom folder that you choose. We refer to this folder as [profile-dir].
-
** In the second page, change profile name to 'praytimes' and press on 'Choose Folder...' to set a folder for the profile. Choose a folder in a safe place on your local drive. We call this folder [profile-dir].  
+
* Press Finish on the dialog box and then press 'Exit'.
* Press Finish on the dialog box and then press 'Exit'.
-
The praytimes Firefox profile is now created. You can double-click on <code>my-firefox.bat</code> to open Firefox with this new profile.
+
You can now double-click on <code>my-firefox.bat</code> to open Firefox under the newly created profile.
=== Install Pray Times! ===
=== Install Pray Times! ===
-
 
-
To add Pray Times to the newly created Firefox profile, do the following steps:
 
* Copy a file named <code>azan-times@hamid.net</code> from [addon-dir]/dev to [profile-dir]/extensions.
* Copy a file named <code>azan-times@hamid.net</code> from [addon-dir]/dev to [profile-dir]/extensions.
-
* Open the file using notepad and replace its first list with [addon-dir].
+
* Open the file using Notepad and change its first line to [addon-dir].
* Close your Firefox and reopen it using <code>my-firefox.bat</code>.
* Close your Firefox and reopen it using <code>my-firefox.bat</code>.
=== Choose Locale ===
=== Choose Locale ===
-
If you are using a [http://www.mozilla.com/en-US/firefox/all.html localized version of Firefox] (instead of the English one), then skip this step. Otherwise, do the following:
+
If you are using a [http://www.mozilla.com/en-US/firefox/all.html localized version of Firefox], then skip this step. Otherwise, do the followings:
* Install [https://addons.mozilla.org/en-US/firefox/addon/1333 Quick Locale Switcher] add-on onto your browser.
* Install [https://addons.mozilla.org/en-US/firefox/addon/1333 Quick Locale Switcher] add-on onto your browser.
-
* From the addon options menu, change the browser default language to your own language.
+
* From the add-on options menu, change the browser's default language to your own language.
-
== Translation ==
+
== Start Translation ==
The translation process is pretty easy. You only need to translate expressions in two files.
The translation process is pretty easy. You only need to translate expressions in two files.
Line 44: Line 38:
* Make a copy of the folder en-US and rename it to your language id. (You may find your language id using [https://addons.mozilla.org/en-US/firefox/addon/1333 Quick Locale Switcher] add-on.)
* Make a copy of the folder en-US and rename it to your language id. (You may find your language id using [https://addons.mozilla.org/en-US/firefox/addon/1333 Quick Locale Switcher] add-on.)
-
=== Start Translation ===
+
=== Translate ===
* Open [addon-dir]/chrome/chrome/locale/[your-language-id].
* Open [addon-dir]/chrome/chrome/locale/[your-language-id].
-
* Open the two files <code>praytimes.dtd</code> and <code>common.properties</code> using a text editor like notepad. (Note: your editor should be able to store files in UTF-8 format.)
+
* Open the two files <code>praytimes.dtd</code> and <code>common.properties</code> using a text editor like notepad (Note: your editor should be able to store files in UTF-8 format).
* Start translating expressions in the above two files.
* Start translating expressions in the above two files.
=== View changes ===
=== View changes ===
-
The changes you make to dialogue windows (including Options, About, and Comments dialogues) can be viewed immediately. Changes to the main menu and the display panel in the status bar
+
The changes you make to the dialogue windows (including Options, About, and Comments dialogues) can be viewed immediately. Changes to the main menu and the display panel in the status bar needs a browser restart (you can use [https://addons.mozilla.org/en-US/firefox/addon/7434/ Extension Developer add-on] to reload all chromes without restart).
-
needs a browser restart (you can use [https://addons.mozilla.org/en-US/firefox/addon/7434/ this add-on] to reload all chromes without restart).
+
== Submit Your Translation ==
== Submit Your Translation ==

Revision as of 08:20, 15 March 2009

This is a quick guide on how to translate Pray Times! Firefox add-on.

Contents

Set Up the Environment

Copy files

Download Pray Times! 1.2 zip file and extract it in a directory on your local drive. We refer to this directory as [addon-dir] in the following.

Make a new Firefox profile

  • Open [addon-dir]/dev folder and double-click on my-firefox.bat to run it (we assume that you are using Windows)
  • The Firefox profile dialog appears. Click on 'Create Profile..'
  • Create a profile with name 'praytimes' in a custom folder that you choose. We refer to this folder as [profile-dir].
  • Press Finish on the dialog box and then press 'Exit'.

You can now double-click on my-firefox.bat to open Firefox under the newly created profile.

Install Pray Times!

  • Copy a file named azan-times@hamid.net from [addon-dir]/dev to [profile-dir]/extensions.
  • Open the file using Notepad and change its first line to [addon-dir].
  • Close your Firefox and reopen it using my-firefox.bat.

Choose Locale

If you are using a localized version of Firefox, then skip this step. Otherwise, do the followings:

  • Install Quick Locale Switcher add-on onto your browser.
  • From the add-on options menu, change the browser's default language to your own language.

Start Translation

The translation process is pretty easy. You only need to translate expressions in two files.

Prepare files

  • Open [addon-dir]/chrome/chrome/locale.
  • Make a copy of the folder en-US and rename it to your language id. (You may find your language id using Quick Locale Switcher add-on.)

Translate

  • Open [addon-dir]/chrome/chrome/locale/[your-language-id].
  • Open the two files praytimes.dtd and common.properties using a text editor like notepad (Note: your editor should be able to store files in UTF-8 format).
  • Start translating expressions in the above two files.

View changes

The changes you make to the dialogue windows (including Options, About, and Comments dialogues) can be viewed immediately. Changes to the main menu and the display panel in the status bar needs a browser restart (you can use Extension Developer add-on to reload all chromes without restart).

Submit Your Translation

After your translation is complete, please send the two files praytimes.dtd and common.properties to the developer.

Retrieved from "http://praytimes.org/wiki/Add-on_Translation_Guide"
Personal tools