IBM Support

How to add additional dictionary languages to Notes 8.5.1 or later installs

Technote (FAQ)


Question

How can you add additional dictionary languages to later be provisioned during the Notes 8.5.1 or later install?

Answer

Existing documentation is available in the following wiki article, which provides steps to add additional dictionary languages: "Making Lotus Notes 8.5.1 and greater language spell check dictionaries available to users".

This technote document attempts to simplify the process, and provides detailed steps for adding all additional language dictionaries using the AddToKit.exe utility.

Building folders to create new install packages

1. Obtain the additional UpdateSite_xx.zip dictionaries either from the Notes installation DVD, or you can download them from Passport Advantage.

For more information, see Technote 1411732 - " How to obtain additional languages for the new spell check engine in Notes 8.5.1"

Extract the 8.5.1 (or later) installation package into a separate directory. For this exercise, create the directory C:\SpellCheckerInstall.

2. Next, create a second directory for the dictionaries. Name this directory "Dictionaries" under C:\Dictionaries.

3. Copy all dictionaries from the extracted XTAF_Dictionaries.zip into the C:\Dictionaries folder.

4. Extract all UpdateSite_xx.zip files (where "xx" is the ISO language abbreviation) into the C:\Dictionaries folder.

NOTE: While extracting the UpdateSite_xx.zip files, please be sure to extract each dictionary into it's own folder, to ensure you can distinguish between all of the different dictionaries you intend to provision.

For example, if you are using UpdateSite_es.zip, ensure it's extracted to the folder UpdateSite_es

5. Create a new subdirectory, under C:\Dictionaries called "New Update Site contents". This makes it easier to build a new UpdateSite.zip, which will be explained later.

6. In the "New Update Site Contents" folder, create two new sub-folders named "features" and "plugins".

(i.e. C:\Dictionaries\New Update Site Content\features and C:\Dictionaries\New Update Site Content\plugins )

NOTE: Each UpdateSite_xx.zip contains it's own "plugins" and "features" sub-folder

7. From each of the UpdateSite_xx folders, copy the contents of it's "features" folder into the newly created C:\Dictionaries\New Update Site Contents\features folder. Repeat this step for each UpdateSite_xx dictionary you intend to provision.

8. Now you should have the .JAR files for all languages in the C:\Dictionaries\New Update Sites Contents\features folder

9. Next, from each of the UpdateSite_xx folders, copy the contents of the plugins folder into the C:\Dictionaries\New Update Site Contents\plugins folder. Repeat this step for each UpdateSite_xx dictionary you intend to provision.

10. Now you should have the .JAR files for both languages in the C:\Dictionaries\New Update Sites Contents\plugins folder.


Building a new site.xml

1. Copy a site.xml file from one of the UpdateSite_xx folders (stored under C:\Dictionaries) and paste it into the C:\Dictionaries\New Update Sites Contents

2. Open this site.xml using WordPad or NotePad. (Do not use any Word Processors, such as Microsoft Word while editing this code.)

3. Open another site.xml from a different UpdateSite_xx folder (stored under C:\Dictionaries) using either WordPad or NotePad.

4. Copy the XML code from this additional site.xml, starting with the <category-def name=...> XML tag and ending with the </feature> XML tag.

Below is an example used to add additional XML code to the Afrikan (UpdateSite_af) site.xml. The additional dictionaries added in this example are for the Arabic (UpdateSite_ar), Catalan (UpdateSite_ca), and Czech (UpdateSite_cs) dictionaries.




NOTE: The beginning and end tags of the site.xml are <site> and </site> respectively

5. Repeat Step #4 until all dictionaries are included in this one site.xml, stored in the C:\Dictionaries\New Update Site Contents folder. The resulting site.xml file should contain all dictionaries you intend to provision during the Notes install. It should also have matching open and end XML tags throughout.

Building a new install.xml

1. In the C:\Dictionaries directory, create a subdirectory called deploy

2. Copy an install.xml file from one of the UpdateSite_xx folders (stored under C:\Dictionaries) and paste it into the C:\Dictionaries\deploy folder.

3. Open this install.xml using WordPad or NotePad. Note: Do not use any Word Processors, such as Microsoft Word while editing this code.

4. Open another install.xml from a different UpdateSite_xx folder (stored under C:\Dictionaries) using either WordPad or NotePad.

5. Copy the XML code from this additional site.xml, starting with the <install version=...> XML tag and ending with the </install> XML tag.

Below is an example used to add additional XML code to the Afrikan (UpdateSite_af) install.xml. The additional dictionaries added in this example are for the Arabic (UpdateSite_ar), Catalan (UpdateSite_ca), and Czech (UpdateSite_cs) dictionaries. This screen shot of the install.xml has been abbreviated for simplicity.

6.



NOTE: The beginning and end tags of the install.xml are <ibm-portal-composite> and </ibm-portal-composite> respectively .

7. Repeat Step #5 until all dictionaries are included in this one install.xml, stored in the C:\Dictionaries\deploy folder. The resulting install.xml file should contain all dictionaries you intend to provision during the Notes install. It should also have matching open and end XML tags throughout.


Building a new UpdateSite.zip

1. Go to the C:\Dictionaries\New Update Site Contents folder.

2. Select the features, plugins and site.xml file, and zip them all together

3. Rename the resulting zip file to UpdateSite.zip

4. Move the new UpdateSite.zip to the C:\Dictionaries folder.


Now you are ready to run the AddToKit utility

1. Go to your installation folder (in this exercise it should be C:\SpellCheckerInstall)

2. Navigate to the \Utility folder

3. Extract the "NotesCustomizationKit_1_0.zip" file

4. Open the DOS window, and navigate (using the CD command) to the C:\SpellCheckerInstall\Utility\NotesCustomizationKit_1_0 folder

5. Run the following command (in italics ; bold font is the DOS prompt) according to the steps provided in this technote:
C:\SpellCheckerInstall\Utility\NotesCustomizationKit_1_0> addtokit C:\Dictionaries C:\SpellCheckerInstall

Now you can run the setup.exe, stored in the C:\SpellCheckerInstall directory, for a new or an existing Notes 8.5.1 (or later) install.

Related information

How to obtain additional languages for the new spell ch
Customizing Lotus Notes multi-user install kit for corr
Making Lotus Notes 8.5.1 and greater language spell che
Installing Lotus Notes spelling dictionaries

Document information

More support for: IBM Notes
Editor

Software version: 8.5.1, 8.5.2

Operating system(s): Windows

Software edition: All Editions

Reference #: 1459641

Modified date: 05 July 2011