IgnitionDeck Documentation

Language Translation & Rewording

IgnitionDeck products come in American English by default, but can easily be modified to appear in other languages. Using this tutorial, you’ll be able to download the necessary translation files, modify them as desired, and add them to your IgnitionDeck installation. You can also use this method to merely change wording – just use the English language code (en_US) where appropriate. If you’re new to translation in WordPress, please see WordPress.org’s documentation page called Translating WordPress.

Text Domains for IgnitionDeck Products:

ProductText Domain
IgnitionDeck Frameworkidf
IgnitionDeck Commercememberdeck
IgnitionDeck Crowdfundingignitiondeck
Theme 500 Framework*fivehundred

*Unlike plugin language files, a name like my_theme-en_US.mo will NOT work for a theme. Although plugin language files allow you to specify the text-domain in the filename, this will NOT work with themes. Language files for themes should include the language shortcut ONLY like en_US.po and en_US.mo.

Step 1: Download the Translation Files with FTP or Via github

To make your own translation from scratch or reword IgnitionDeck products:

Using your favorite FTP client (we recommend Filezilla), download the translation files from /theme-or-plugin-directory/languages_default/

They will have the file extensions “.po” and “.mo”

 

Step 2: Translate IgnitionDeck

Download a copy of PO Edit for Mac, Windows, or Linux and install using system prompts.

Open the ignitiondeck.po file (this will be the default en_US version) within POEdit.  Click on the Catalog > Update from Sources button to ensure that you have the most up to date list of translatable text.  Save the file.

Copy and paste the updated ignitiondeck.po file to your computer to work with the file. Rename the file using the language structures found in the WordPress codex (for example, if you are translating the IgnitionDeck Framework to Spanish, the files should now be called ignitiondeck-es_ES.po and ignitiondeck-es_ES.mo).

Open the new .po file with PO Edit and you should now see two columns. The left column contains the English source version, the right will eventually display your translated version. Clicking on a row enables an editor in the bottom of the screen, that will allow you to type the translated values.  Do not alter the source text.

Before you start the translatation, open the catalog settings menu and ensure that the catalog is set to the language in which the file will be translated.

Finally, translate the file into your language, and then click the save button. This should save both the .po and .mo file.

Step 3: Install Translation Files

Upload these files to the WordPress site containing your IgnitionDeck installation.

Using FTP, upload the .po and .mo files (do not upload the folder containing the files, just the two files themselves) to the /theme-or-plugin-directory/languages/ directory.

If they already exist from prior version of IgnitionDeck, you are free to overwrite them.

Step 4: Activate Language Files

If your WordPress installation is already activated in your language, then you can skip this step. If your site is still in English, you’ll need to configure your site in order to activate your language of choice.  Go to Settings > General and select the Language of Site to your language of choice.  Save the changes.

Your WordPress blog and IgnitionDeck installation should now be translated!

Step 5: Repeat steps 2-3 for other ID themes/plugins

If you use IgnitionDeck Commerce or one of our 500 themes, you’ll need appropriately named .mo and .po files for these as well. You can find the base language files inside of plugins/idcommerce/languages_default and themes/fivehundred/languages, respectively. Copy these and name them in the following formats (see chart above for text domains of each product):

For ID Commerce: memberdeck-xx_XX.mo and memberdeck-xx_XX.po, where xx_XX is your language code.  Create a language folder within the idcommerce folder and save your translated PO and MO files here.  This will prevent the translated file from being deleted on an update:

idcommerce_languageFolders

For Theme 500: xx_XX.mo and xx_XX.po. This is because although plugin language files allow you to specify the text-domain in the filename, this will NOT work with themes. Language files for themes should include the language shortcut ONLY like en_US.po and en_US.mo.

Final Step: Share your work!

If you happened to translate IgnitionDeck into a language that was not listed in the Github repository, we would greatly appreciate if you could share with the community. To do so, simply create a github account and submit a pull request using these instructions.

You can also email your translation files to us at hello@virtuousgiant.com.

Troubleshooting

1. What happens if the translation file is incorrect or missing?

The best way to fix this is to revisit step 2 and translate manually, re-saving when done.

2. There are strange characters in the translation.

This is probably caused by a corrupt translation file. Open the .po file with PO Edit and look for mistakes. Correct them and re-save.

3. Some of the fields are missing.

We think we’ve got them all, but sometimes we miss a few. Post a request in our support forums and we’ll take a look.