Add-on Translation Guide
From Pray Times
(Difference between revisions)
(New page: This is a simple guide for translating Pray Times Firefox add-on. == Preparing Environment == === Copy files === Download the addon zip file from here and extract it in a directory on ...) |
|||
| Line 1: | Line 1: | ||
| - | This is a | + | This is a quick guide on how to translate Pray Times! Firefox add-on. |
== Preparing Environment == | == Preparing Environment == | ||
| - | |||
=== Copy files === | === Copy files === | ||
| - | Download the addon zip file | + | 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. |
=== 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 | * Open [addon-dir]/dev folder | ||
| - | * Double-click on | + | * 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. | ** Skip the first page of the wizard. | ||
| - | ** In the second page, change profile name to 'praytimes' and press on 'Choose Folder...' to set a folder for the profile. | + | ** 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 | + | The praytimes Firefox profile is now created. You can double-click on <code>my-firefox.bat</code> to open Firefox with this new profile. |
=== Install Pray Times! === | === Install Pray Times! === | ||
| Line 25: | Line 24: | ||
To add Pray Times to the newly created Firefox profile, do the following steps: | To add Pray Times to the newly created Firefox profile, do the following steps: | ||
| - | * Copy a file named azan-times@hamid.net | + | * Copy a file named <code>azan-times@hamid.net</code> from [addon-dir]/dev to [profile-dir]/extensions. |
| - | * Open the file using | + | * Open the file using notepad and replace its first list with [addon-dir]. |
| - | * | + | * Close your Firefox and reopen it using <code>my-firefox.bat</code>. |
| - | + | === 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: |
| + | |||
| + | * 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. | ||
| + | |||
| + | == 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. | ||
| - | === Prepare | + | === Prepare files === |
* Open [addon-dir]/chrome/chrome/locale. | * 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 [https://addons.mozilla.org/en-US/firefox/addon/1333 Quick Locale Switcher] add-on.) |
| - | + | ||
| - | + | ||
| - | === | + | === Start Translation === |
| + | |||
| + | The translation process is pretty easy. You only need to translate expressions in two files. | ||
* Open [addon-dir]/chrome/chrome/locale/[your-language-id]. | * Open [addon-dir]/chrome/chrome/locale/[your-language-id]. | ||
| - | * Open two files | + | * Open two files <code>praytimes.dtd</code> and <code>common.properties</code> with a text editor like notepad. |
* Start translating expressions in the above two files. | * Start translating expressions in the above two files. | ||
Note that your editor should be able to store files in UTF-8 format. | Note that your editor should be able to store files in UTF-8 format. | ||
| - | === | + | === 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 | ||
| + | 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 == | ||
| + | |||
| + | After your translation is complete, please send the two files <code>praytimes.dtd</code> and <code>common.properties</code> to the developer. | ||
| + | |||
[[Category:Add-on]] | [[Category:Add-on]] | ||
Revision as of 08:01, 15 March 2009
This is a quick guide on how to translate Pray Times! Firefox add-on.
Contents |
Preparing Environment
Copy files
Download the addon 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
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
- Double-click on
my-firefox.bat - The Firefox profile dialog appears. Click on 'Create Profile..'
- Skip the first page of the wizard.
- 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'.
The praytimes Firefox profile is now created. You can double-click on my-firefox.bat to open Firefox with this new profile.
Install Pray Times!
To add Pray Times to the newly created Firefox profile, do the following steps:
- Copy a file named
azan-times@hamid.netfrom [addon-dir]/dev to [profile-dir]/extensions. - Open the file using notepad and replace its first list with [addon-dir].
- Close your Firefox and reopen it using
my-firefox.bat.
Choose Locale
If you are using a localized version of Firefox (instead of the English one), then skip this step. Otherwise, do the following:
- Install Quick Locale Switcher add-on onto your browser.
- From the addon options menu, change the browser default language to your own language.
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.)
Start Translation
The translation process is pretty easy. You only need to translate expressions in two files.
- Open [addon-dir]/chrome/chrome/locale/[your-language-id].
- Open two files
praytimes.dtdandcommon.propertieswith a text editor like notepad. - Start translating expressions in the above two files.
Note that your editor should be able to store files in UTF-8 format.
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 needs a browser restart (you can use this 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.
