Preparing

Make some decisions

1. Find a translator. You will need the following information about this person:
   • Real name
   • Email
   • Make up a username
   • Make up a password

2. The short name for your language. This is something like "english" (as opposed to "U.S. English"). In this document, this name is referred to as "YOUR_LANG".
3. The formal name for your language. This is what people will see on the screen. It will be something like "U.S. English" or "Norwegian (Nynorsk)". This is simply referred to as the formal language name.
4. The language code for your language. Use these  guidelines. This is referred to as LANG-ID.
5. A flag icon or other image to represent your language. It should be 32x32 pixels.

With the AMIS source tree

1. In the AMIS subversion tree, go to the trunk/langpacks directory
2. Create a directory for your language. Use the short name for your language (see above).
3. From trunk/amis/src/DefaultLangpack, copy the entire AmisLangpack? directory and put it in trunk/langpacks/YOUR_LANG/
4. Remove the .svn directories from the copy of AmisLangpack?
5. create an empty directory called "audio" in trunk/langpacks/YOUR_LANG/
6. From trunk/amis/src/DefaultLangpack, copy the file called "moduleDesc.xml" and put it in trunk/langpacks/YOUR_LANG/

With the DAISY Lion

1. Log into the DAISY Lion server (requires authentication)
2. Go to the daisylion/scripts directory
3. Generate the correct configuration file for AMIS

   python ../config/generate_config.py > ../config/amislion.cfg
   

4. Run the add_lang script
   • Supply a username and password for the translator.
   • Also supply a  compliant language ID for your language.

     python add_lang.py --config="../config/amislion.cfg" --langname="My Language" --realname="Trans Lator" --email="translator@email.com" LANG-ID translator_username translator_password
     

5. Until this is part of the language creation process, do this too:

   python run_sql.py --config="../config/amislion.cfg" "UPDATE languages SET audiodir=\"langpacks/YOUR_LANG\" WHERE langid=\"LANG-ID\""
   

The directory "langpacks/YOUR_LANG" is the same as what you created in the AMIS source tree (using the short name for your language). The LANG-ID value is the one you calculated according to the guidelines (see above).

Be careful to specify the WHERE .. part of the statement -- otherwise you will overwrite all audiodir values for all languages. Also be sure to properly escape quotes (as shown).

Translating

1. The translator goes to the DAISY Lion website and logs in using their username and password
2. They follow all the instructions and translate all the text
3. They download a list of all the prompts and use Obi to make audio recordings
4. They upload these recordings in a batch at the DAISY Lion website.
5. They download the help file and translate it.
6. They record the help file as a DAISY book.
7. They submit the help file to the AMIS team.

Collect output

With the DAISY Lion

1. Log into the DAISY Lion server (requires authentication)
2. Run the following scripts from daisylion/scripts/:
   • python export_amis_rc langid > outfile.rc
   • python export_amis_xml langid > outfile.xml
   • python export_amis_keys langid > outdir

Organizing

Prepare the RC file

1. Copy outfile.rc into trunk/langpacks/YOUR_LANG/AmisLangpack
2. Rename outfile.rc to AmisLangpack?.rc (replace the existing file of the same name)
3. Open AmisLangpack?.rc in UltraEdit?
4. Run the following steps and save after each:
   • Choose "File->Conversions->Unicode/UTF-8 to UTF-8 (Unicode editing)"
   • Choose "File->Conversions->UTF-8 to Unicode"

Prepare the XML file

1. Copy outfile.xml into trunk/langpacks/YOUR_LANG/
2. Rename outfile.xml to amisAccessibleUi.xml (replace the existing file of the same name)

Copy the keyboard shortcuts book

1. Copy outdir into trunk/langpacks/YOUR_LANG
2. Rename the folder "outdir" to "shortcuts".

Edit the module description file

1. Open trunk/langpacks/YOUR_LANG/moduleDesc.xml
2. Replace the following text:
   • Change the language ID:

     <moduleDesc xmlns="http://amisproject.org" id="eng-US" filename="./AmisLangpack.dll" type="langpack" enabled="yes">
     
     becomes
     
     <moduleDesc xmlns="http://amisproject.org" id="LANG-ID" filename="./AmisLangpack.dll" type="langpack" enabled="yes">
     

• Change the name of the language:

<text>U.S. English</text>

becomes

<text>Formal language name</text>

3. Save and close moduleDesc.xml
4. Copy your flag icon into two places: trunk/langpacks/YOUR_LANG/flag.ico and trunk/langpacks/YOUR_LANG/AmisLangpack/flag.ico . Be sure it is named "flag.ico"
5. Make an MP3 audio recording of the formal name of your language. Save the audio file as trunk/langpacks/YOUR_LANG/thislang.mp3

Compiling

1. Open trunk/langpacks/YOUR_LANG/AmisLangpack/AmisLangpack.sln in Visual Studio 2008
2. Right-click the project properties
3. For the "Debug" configuration: under "Post-build", enter the following value for "Command line":

   ..\..\..\amis\bin\copyLangpack.bat LANG-ID  ..\..\..\langpacks\YOUR_LANG debug
   

You must replace LANG-ID and YOUR_LANG with real values.

4. For the "Release" configuration: under "Post-build", enter the following value for "Command line":

   ..\..\..\amis\bin\copyLangpack.bat LANG-ID  ..\..\..\langpacks\YOUR_LANG release
   

You must replace LANG-ID and YOUR_LANG with real values.

5. If you haven't already, run trunk/amis/bin/run_first_to_copy_settings.bat . This will copy the AMIS settings to your Windows application data directory.
6. Build the AmisLangpack? project from Visual Studio 2008
7. All the files have now been copied to c:\documents and settings\all users\application data\AMIS\settings\lang\LANG-ID\

Making an installer

You can build a version of AMIS which uses your language pack as the default. First, of course, you have to have already built AMIS.

1. in trunk/amis/installer, run "make_amis_installer.bat LANG-ID "Formal Language Name""
2. You should get an executable named something like "Setup-amis-3-LanguageName?.exe"

You can also build an installer which adds your language pack to an existing AMIS installation.

TBD