Exporting and Importing Guide Content

This article explains the process for exporting and importing Iridize guides for translation purposes. Translation of guides allows you to dynamically control which language of the guide will be displayed to the end user. Once the guides are exported you can translate the relevant text in the provided files and import them back to Iridize with the new language.

 

Export

To Export the guides content you will need to access the Customize page in your Iridize account.

Look for the Multi-Language section and click on the Export button. This will prompt you to save the exported guides to your local disk.

Iridize guides will be saved as a ZIP file with all the exported content in the target directory.

Extract and save the information in the ZIP file to a directory of choice. If your operating systems does not support ZIP files you can use one of the following software providers: Winzip, Winrar, izip.

 

Your export folder should include the following directories:

 

    • active - This directory contains all published/active revisions of your guides; it should match what you see in your production environment. The directory will contain a list of directories, one for each language. In each such language directory you will find a list of files named according to your guides’ api-names.  The directory names ‘--’ denotes the native language you used to create your guides originally; this will be english in most cases.
    • testing - This directory contains all draft revisions of your guides; it should match what you see in your staging/test environment. The structure of this directory is identical to the active directory.

 

  • import - This directory has no real content. It is where you will need to place your translated guides before importing them back to Iridize. For more information about the import process please read the section below.

 

  • README.txt - this is the file you are reading now :)

 

Import

In order to import the translated guides back to Iridize you will need to populate the import directory with the translated content.

The import directory should include directory for each language you support. The name of each directory signifies the language it contains and should follow this naming convention. For your convenience, during the export process we have generated in the import directory a directory for each language you currently have guides for in the Iridize servers.

 

To import the translated content you will need to ZIP the contents of this directory only and upload it using the “Import” button in the Customize page of that product in your account.

Export Guide Format

The content of your guides will be saved in a tab-separated values file. This should allow you to double click and open it in any spreadsheet software (e.g. Microsoft Excel).

 

Header Section

This section contains meta-data related to the guide.

 

<BEGIN METADATA>

rev_key djebjwtsi7p9rqe

display_name display name

 

Use this section to translate the name of your guide to multiple languages. This name will be displayed in your Iridize dashboard and in the help widget for your end users.

 

Notice: please leave everything else untouched.

 

Content Section

This section contains the actual content of the guide.

<BEGIN CONTENT>

id uid type next contents

1 <NA> tip voila hello world - fr

 

The <BEGIN CONTENT> is a marker used during the import process.

The line after provides column headers. Each tooltip in your guide should have a corresponding line.

 

id, uid, type - are internal Iridize fields. They are used in the import process.

next - The text that will be displayed in the Iridize next button. This field will normally be empty unless you have changed it from the default value ‘Next’. To translate the default text for the Next button to a language please read the Tiplate section below.

contents - The contents of the tooltip.

 

Notice: do not change the order of the lines, it might break the import process.

Export Tiplate Format

The Iridize tiplate is a template of what your tooltip looks like. It defines the default look of the tooltips in your application.

 

This is important because through the tiplate you can define the texts of the following defaults:

  • Next - this is the default text for the next button. Simply search and replace the word Next in the tiplate.
  • Back - this is the default text for the back button. Simply search and replace the word Back in the tiplate.
  • Remind me later - change the default text of the remind me later button. search for Remind me later
  • Step counter - by default the step counter looks like this ‘Step 1/n”. Search for Step to replace.

 

The tiplate file will be named tiplate.csv in your export directory.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.