Skip to main content link. Accesskey S
  • Log In
  • Help
  • IBM Logo
  • IBM Notes and Domino wiki
  • All Wikis
  • All Forums
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • IBM Redbooks
  • API Documentation
Community Articles Product Documentation Learning Center IBM Redbooks API Documentation This category IBM iNotes 9.0 Social Edition - Administering IBM iNotes 9.0 Social Edition - Using IBM Notes 9.0 Social Edition IBM Notes Traveler 9.0 - Administering IBM Notes Traveler 9.0 - Using Lotus Notes 8.5.3 Documentation Lotus Notes Traveler 8.5.3 Administration Documentation Lotus Notes Traveler 8.5.3 Usage Documentation Custom Search Scope...
Search
Community Articles > Lotus Notes > Making Lotus Notes 8.5.1 and greater language spell check dictionaries available to users
  • New Article
  • Share Show Menu▼
  • Subscribe Show Menu▼

About the Original Author

Pam Gilday
Contribution Summary:
  • Articles authored: 61
  • Articles edited: 97
  • Comments Posted: 31

Recent articles by this author

Locating supplied Notes install kit customization tools

The Utility subdirectory in the Notes install kit contains a NotesCustomizationKit10.zip file in which supplied Notes install customization tools reside.

Defining business card data retrieval

If you have multiple business card related applications installed, for example Lotus Notes, Connections, and Sametime, you can define the application from which to retrieve business card data, and optionally the seach order to use when retrieving business card data from multiple ...

Backing up and restoring Notes client data

Backing up a Lotus Notes user's personalized data and settings periodically, and specifically prior to Notes client upgrade, is suggested. If the user moves to a new computer, you can easily restore personalized data and settings.

Creating a personalized report template in Alloy 1.0 or 1.0.1

While an Alloy administrator can enable users to run certain reports, users can customize, using a personalized report template, some aspects of the reports that they can generate, including whether the report is run on a schedule, how the report is delivered, and what parameters are used for the ...

Signing custom or third party features and plug-ins properly so that the Notes user is not prompted to specify trust during installation

Lotus Notes and Domino 8.5.1 introduced the ability to push administrative trust defaults during Notes install or upgrade using a new deploy.nsf in the Notes install kit. The release also added additional Domino policy controls for timestamping of features and plugins. This article seeks to ...
Community articleMaking Lotus Notes 8.5.1 and greater language spell check dictionaries available to users
Added by Pam Gilday | Edited by IBM contributor Pam Gilday on August 16, 2010 | Version 54
expanded Abstract
collapsed Abstract
This post describes the process by which you can customize the supplied English language Lotus Notes install kit, for both Windows and Linux user platforms, to install various XTAF language dictionaries as part of the Notes install and upgrade process. It also references instruction on how to use a deployment widget to install the XTAF dictionaries to an existing Notes runtime.
Tags: Notes install, spelling dictionary, spell checker, spell check dictionary, 8.5.1, 8.5.2, install kit customization, MUI, NL, colocation-affinity, addToKit.exe

This procedure is for an English language Lotus Notes install kit for users who will not also be using Lotus Notes in conjunction with a MUI pack install or NL kit install. Most of the non-English language dictionaries are supplied in MUI packs and NL install kits. If you are using a MUI pack or NL install kit, you do need a customized English language Lotus Notes install kit, as described in this post, to install the language dictionaries and thus do not need to perform this procedure.

Dictionary files are obtained from their corresponding language pack (Notes installation executable, MUI pack, and or NL install kit) as follows:

-- Language dictionaries are automatically installed with the Notes installation program itself, those being the various English language (en) dictionaries as well as French Canadian (fr-CAN).
-- For non-English language Notes client install or upgrade on the Windows platform, additional language dictionaries are installed, after initial Notes install or upgrade, with the various MUI packs.
-- For non-English language Notes client install or upgrade on the Linux or Mac platform, the applicable language dictionaries are automatically installed with the specified NL pack.
 
Dictionary files are also availabe from IBM Passport Advantage.
 
When installed, Notes detects the installed language dictionaries and uses the operating system locale to display available dictionaries on the users File > Preferences > Spell Check page.

If the Notes user requires spelling dictionaries that are not already installed (based on their MUI pack, NL kit. or otherwise) and therefore not visible and available on their File > Preferences > Spell Check page, the administrator can make additional spelling dictionaries available using either a customized Notes install kit or a widget deployment process.

For Notes (basic configuration) users, the administrator can make additional spelling dictionaries available from a central location or in the user's Notes data directory and Notes user's can then "install" them manually by using the Install option on their File > Preferences > Spell Check page and then selecting the additional language dictionaries. However, for Notes (standard configuration) users, only the dictionaries for the Notes installed language(s), including MUI pack or NL kit, are available by default; and there is no Install option on the File > Preferences > Spell Check page. However, additional language dictionaries are supplied in the Notes install kit, which an administrator can provide to users via either a customized Notes install kit or a widget deployment process.

Note that for multi-user installation, a colocation-affinity consideration exists and is described in Lotus Tech Note 1440976 "Customizing Lotus Notes multi-user install kit for correct XTAF dictionary installation" at the Lotus Support site.
For related information about the additional Notes language dictionaries, see Installing Lotus Notes spelling dictionaries and possible "dictionary" posts in the Lotus Notes Support Site.

Additional language dictionaries are supplied as separate Eclipse zipped updateSites in the Notes install media in XTAF_Dictionaries.zip. The administrator can make these additional dictionaries available using an add-on installer, deployment widget and widget catalog, or other feature deployment mechanism.

Note: The Notes install DVD contains the XTAF_Dictionaries.zip file. For the Notes install webkit, the XTAF_Dictionaries.zip file is supplied in a separate webkit instead of the Notes install webkit.

Note: This wiki post describes how the administrator can make the additional dictionaries available during the Notes installation or upgrade procedure by customizing the Notes install kit. Another deployment approach would be for the administrator to add the additional dictionaries to a central NSF-based update site (for example moreupdatesite.nsf) and then create and use a deployment widget and widget catalog to automatically install the dictionaries to an existing Notes user's runtime based on widget policy settings. This second approach pushes the additional libraries to the Notes user's desktop without any user intervention. For details, see Managing client plug-in deployment.

Note: When customizing the Notes kit to add new features, those new features must be signed. The supplied XTAF dictionaries are signed.

Note: The language dictionaries are supplied as the required features of an "installfeature" as below::

installfeature default="true" id="Platform.XPD" required="true" show="false" version="8.5.2.2010xxxx-xxxx"
requirements
feature download-size="882" id="com.ibm.langware.v5.dic.de_DE_Reform.feature" match="perfect" size="1216" url="jar:${installer.root}/updateSite.zip!/" version="7.1.1.201006221804" /
...
...
installfeature/

For details about this format, see the supplied install.xml file in the Lotus Notes install kit and "Customizing the Notes install manifest for new or third-party Eclipse features" in Domino Administrator help.


Installing additional language dictionaries for Lotus Notes (standard configuration) on Windows

In this procedure you will add use the supplied addToKit tool to create a customized Notes install kit. You will also validate that customized Notes install kit before making it available for widespread use. The customized Notes install kit will contain dictionaries of your choosing. The addToKit and validation tools are supplied in the Notes install media kit's utility subdirectory. For reference, see Adding new features to the Notes install kit using a supplied tool and Validating your customized Notes install kit in the Domino Administrator's guide.

1. Locate the XTAF_Dictionaries.zip file in the install kit and extract its contents to a temporary directory, for example C:\temp\Dictionaries.all.

Note: The Notes install DVD contains the XTAF_Dictionaries.zip file. For the Notes install webkit, the XTAF_Dictionaries.zip file is supplied in a separate webkit.

2. Based on whether you want to add one or several dictionaries to the install kit, do one of the following:

-- If you want a single language dictionary be installed with Notes, move that language dictionary file to a temporary directory and rename it to updateSite.zip, for example, move C:\temp\Dictionaries.all\updateSite_de.zip to C:\temp\Dictionaries\updateSite.zip.

-- If you want multiple languages dictionaries to be installed with Notes, unzip the language dictionary files to a central location. For example, unzip both updateSite_de.zip and updateSite_fr.zip to C:\temp\Dictionaries.
Then update the site.xml file (C:\temp\Dictionaries\site.xml) and ensure that it correctly lists the contents of the features subdirectories(C:\temp\Dictionaries\features). Then compress the site.xml, the features subdirectory and the plugins subdirectory (C:\temp\Dictionaries\features and C:\temp\Dictionaries\plugins) to updateSite.zip.

3. Create and validate the new INSTALL.XML install manifest in the deploy directory (deploy\install.xml) under C:\temp\Dictionaries; the new manifest file should include all the features listed in C:\temp\Dictionaries\updateSite.zip\site.xml.

4. Locate the Note 8.5.1 or greater Notes install media -- either DVD or Webkit download.

5a. For DVD, copy the Notes installation from <DVDroot>\Clients\W32Intel to a temporary directory, for example C:\temp\Notes85.w32.

5b. For Webkit, unzip the webkit to a temporary directory, for example C:\temp\Notes85.w32.

6. Extract addToKit.exe from C:\temp\Notes85.w32\Utility\NotesCustomizationKit_*_*.zip to anywhere.

7. Open a command window, change to the directory in which the addToKit.exe resides, and run the tool, preferably with the source path and target path arguments, using the following format:

addToKit.exe <addTokitPath>

<addTokitPath> is the source path containing the source updateSite.zip file and deploy directory, in this post, it should be C:\temp\Dictionaries.

<destkit> is the target directory in which your Notes installation resides. In this post, it should be C:\temp\Notes85.w32.

The source update site is an update site directory containing the features subdirectory, plugins subdirectory, and SITE.XML file. The deploy directory contains the updated INSTALL.XML file. The format of the source update site directory zip file and deploy directory must match the format of the target update site directory zip file and deploy directory.

After the command is successfully run with no error, you can run the Notes installation executable to install the customized Notes install kit -- C:\temp\Notes85.w32.

Note For a Notes multi-user install, do the following to make the additional dictionary features available to all users on the client computer.

1. Use the Notes only-multi-user install kit in multi-user mode using an administrator account.

2. Copy the entire contents of the installed "applications" directory in the administrator's workspace (for example C:\Documents and Settings\admin\Local Settings\Application Data\Lotus\Notes\Data\workspace\applications) to each user's workspace (for example, C:\Documents and Settings\USERNAME\Local Settings\Application Data\Lotus\Notes\Data\workspace\applications).



Installing additional language dictionaries for Lotus Notes (standard configuration) on Linux

In this example, the install manifest is /etc/ibm//install.xml and the platform RPM/DEB name is ibm_lotus_notes. This example assumes you are using the Notes 8.5.1 ibm_lotus_notes-8.5.1.i586.rpm or ibm_lotus_notes-8.5.1.i586.deb package and the default install directory /opt/ibm/lotus/notes.

1. Locate the XTAF_Dictionaries.zip file in the install kit and extract its contents to a temporary directory, for example, for example /root/temp/Dictionaries.all.

Note: The Notes install DVD contains the XTAF_Dictionaries.zip file. For the Notes install webkit, the XTAF_Dictionaries.zip file is supplied in a separate webkit.

2. Based on whether you want to add one or several dictionaries to the customized install kit, do one of the following:

-- If you want a single language dictionary to be installed with Notes, unzip the language dictionary file you want to /etc/ibm/ibm_lotus_notes/updateSite directory, for example, unzip /root/temp/Dictionaries.all/updateSite_de.zip to /etc/ibm/ibm_lotus_notes/updateSite.

-- If you want multiple languages dictionaries to be installed with Notes, unzip all the language dictionary files you want to /etc/ibm/ibm_lotus_notes/updateSite. For example, unzip both updateSite_de.zip and updateSite_fr.zip to /etc/ibm/ibm_lotus_notes/updateSite. Then update the site.xml site manifest file (/root/temp/Dictionaries/site.xml) and ensure it correctly lists the contents of features subdirectories( /etc/ibm/ibm_lotus_notes/updateSite/features).

The new updateSite folder should contain customized features and corresponding plugins. For the features already in an RPM or DEB package, you do not need a new updateSite folder.

3. Create a valid install.xml file in the existing /etc/ibm/ibm_lotus_notes/ directory by doing below steps:

a. Extract install.xml(/opt/ibm/lotus/notes/framework/rcp/deploy/install.xml) from RPM/DEB package to /etc/ibm/ibm_lotus_notes/ directory.

b. Add the corresponding contents in /etc/ibm/ibm_lotus_notes/install.xml file for all the features listed in /etc/ibm/ibm_lotus_notes/updateSite/site.xml file.

The install.xml file must contain all features, including the Lotus-supplied features already in rpm or deb package plus any customized features you want to add to the installer. Use the install.xml provided with the Notes install kit for formatting.

For the RPM or DEB platform (ibm_lotus_notes-8.5.1.i586.rpm or ibm_lotus_notes-8.5.1.i586.deb) the Notes install manifest is located at /opt/ibm/lotus/notes/framework/rcp/deploy/install.xml or externally as an override to the default location at /etc/ibm/<Platform RPM/DEB name

 
/install.xml.

5. Run the RPM or DEB Notes installer as follows:

run '# rpm -i ibm_lotus_notes-8.5.1.i586.rpm"

run '$ sudo dpkg -i ibm_lotus_notes-8.5.1.i586.deb"

6. After Notes is installed, the additional dictionary files are in /opt/ibm/lotus/notes/framework/rcp/systemdata/applications directory.

The Root user should copy all the contents under /opt/ibm/lotus/notes/framework/rcp/systemdata/applications directory including itself to /home/<USERNAME

 
/lotus/notes/data/workspace directory and then give all permission to the directory and its contents as below:

chmod 777 -R /home/<USERNAME

 
/lotus/notes/data/workspace

The additional dictionary files will be available to users when they log in to Notes.

Installing additional language dictionaries for Lotus Notes (standard configuration) on Mac OS X

1. Locate the XTAF_Dictionaries.zip file in the install kit and extract its contents to a temporary directory, for example /tmp/Dictionaries.all.

Note: The Notes install DVD contains the XTAF_Dictionaries.zip file. For the Notes install webkit, the XTAF_Dictionaries.zip file is supplied in a separate webkit.

2. Based on whether you want to add one or several dictionaries to the install kit, do one of the following:

-- If you want a single language dictionary to be installed with Notes, move the language dictionary file you want to a temporary directory and rename it to updateSite.zip, for example, move /tmp/Dictionaries.all/updateSite_de.zip to /tmp/Dictionaries/updateSite.zip.

-- If you want multiple languages dictionaries to be installed with Notes, unzip all the language dictionary files you want to a central location, . For example, unzip both updateSite_de.zip and updateSite_fr.zip to /tmp/Dictionaries. Then update the site.xml site manifest file ( /tmp/Dictionaries/site.xml) and ensure it correctly lists the contents of features subdirectories( /tmp/Dictionaries/features). Then compress the site.xml, the features and plugins update site subdirectories (/tmp/Dictionaries/features and /tmp/Dictionaries/plugins) to updateSite.zip.

3. Create and validate the new INSTALL.XML install manifest in the deploy directory (deploy/install.xml) under /tmp/Dictionaries; the new manifest file should include all the features listed in the /tmp/Dictionaries/updateSite.zip/site.xml file.

4. Locate the Note 8.5.1 or greater Notes install media -- either DVD or Webkit download.

5a. For DVD user, copy the Notes installation from <DVDroot

 
\Clients\Mac to a temporary directory, for example /tmp/Notes85.mac.

5b. For Webkit (dmg) user, mount the dmg in system, copy addToKit_Mac.pl from <dmgRoot

 
/Utility to anywhere on the disk.

6. Run the supplied addToKit tool using the following command line to merge information from <addTokitPath

 
into <destkit
 
:

./addToKit_Mac.pl <addTokitPath

 
<destkit
 

<addTokitPath

 
is the source path containing the source updateSite.zip file and deploy directory, in this post, it should be /tmp/Dictionaries.

<destkit

 
identifies the Lotus Notes installation Meta Package and defaults to "Lotus Notes Installer.mpkg". In this post, it should be /tmp/Notes85.mac/Lotus Notes Installer.mpkg

The source update site is an update site directory containing the features subdirectory, plugins subdirectory, and SITE.XML file.

The deploy directory contains the updated INSTALL.XML file.

The format of the source update site directory zip file and deploy directory must match the format of the target update site directory zip file and deploy directory.

After the command is successfully run with no error, the new customized Notes installation kit, under /tmp/Notes85, .is ready to use.

Installing additional language dictionaries for Lotus Notes (basic configuration)

Notes (basic configuration) users can "install" a new language dictionary using the Install option on their File > Preferences > Spell Check page. If a Notes user wants to use a language dictionary that is not listed on the page, they can click Install and choose additional dictionaries provided that the administrator has made the additional dictionaries available as follows:

Note: While the following technique is possible, it is more likely that the administrator would place the available dictionary files in a central and accessible location (or simply add them to the user's Notes\data directory directly) rather than provide the user with the actual Notes install media.

1. Locate the Note install kit, MUI pack, or NL kit in which the applicable language dictionary resides.

2. Open the Client folder.

3. In the Client folder, open the Apps\Dictionaries\Traditional folder.

4. Double-click dictionaries.dic.

5. Enter the location of the user's Notes\Data directory (for example, C:Program Files\IBM\Lotus\Notes\data), and then click Unzip.

Alternatively, simply unzip the .dic files to a central location and then copy them to the user's Notes\data directory.

Once the dictionaries are resident in the user's Notes\data directory, the user can use the following UI sequence to select a new language dictionary and "install" it their dictionary selection list.

1. Click File > Preferences > Spell Check > Install Dictionary.

Macintosh OS X users: Click Lotus Notes > Preferences.

2. Select a dictionary from the Languages list and click OK.

expanded Attachments (0)
collapsed Attachments (0)
expanded Versions (55)
collapsed Versions (55)
Version Comparison     
VersionDateChanged by              Summary of changes
88Sep 22, 2010 10:48:30 AMPam Gilday  IBM contributor
87Sep 22, 2010 10:43:07 AMPam Gilday  IBM contributor
86Sep 22, 2010 10:39:41 AMPam Gilday  IBM contributor
85Sep 20, 2010 5:44:06 PMAmanda J Bauman  IBM contributor
84Sep 20, 2010 5:43:26 PMAmanda J Bauman  IBM contributor
83Sep 20, 2010 5:42:33 PMAmanda J Bauman  IBM contributor
82Sep 20, 2010 5:40:19 PMAmanda J Bauman  IBM contributor
81Sep 8, 2010 11:33:52 AMPam Gilday  IBM contributor
80Aug 17, 2010 9:42:06 AMPam Gilday  IBM contributor
79Aug 17, 2010 9:41:13 AMPam Gilday  IBM contributor
78Aug 17, 2010 7:54:38 AMPam Gilday  IBM contributor
77Aug 17, 2010 7:54:28 AMPam Gilday  IBM contributor
76Aug 17, 2010 7:52:13 AMPam Gilday  IBM contributor
75Aug 17, 2010 7:52:05 AMPam Gilday  IBM contributor
74Aug 17, 2010 7:51:23 AMPam Gilday  IBM contributor
73Aug 17, 2010 7:50:43 AMPam Gilday  IBM contributor
72Aug 16, 2010 7:11:13 PMPam Gilday  IBM contributor
71Aug 16, 2010 7:10:58 PMPam Gilday  IBM contributor
70Aug 16, 2010 7:08:18 PMPam Gilday  IBM contributor
69Aug 16, 2010 7:08:10 PMPam Gilday  IBM contributor
68Aug 16, 2010 7:07:53 PMPam Gilday  IBM contributor
67Aug 16, 2010 7:06:58 PMPam Gilday  IBM contributor
66Aug 16, 2010 7:06:32 PMPam Gilday  IBM contributor
65Aug 16, 2010 7:01:19 PMPam Gilday  IBM contributor
64Aug 16, 2010 7:01:12 PMPam Gilday  IBM contributor
63Aug 16, 2010 7:00:48 PMPam Gilday  IBM contributor
62Aug 16, 2010 7:00:05 PMPam Gilday  IBM contributor
61Aug 16, 2010 6:58:32 PMPam Gilday  IBM contributor
60Aug 16, 2010 6:57:36 PMPam Gilday  IBM contributor
59Aug 16, 2010 6:56:29 PMPam Gilday  IBM contributor
58Aug 16, 2010 6:55:13 PMPam Gilday  IBM contributor
57Aug 16, 2010 6:53:57 PMPam Gilday  IBM contributor
56Aug 16, 2010 6:50:48 PMPam Gilday  IBM contributor
55Aug 16, 2010 6:49:22 PMPam Gilday  IBM contributor
This version (54)Aug 16, 2010 6:44:50 PMPam Gilday  IBM contributor
53Aug 12, 2010 5:34:07 PMAmanda J Bauman  IBM contributor
52Aug 12, 2010 5:30:47 PMAmanda J Bauman  IBM contributor
51Aug 12, 2010 5:10:17 PMPam Gilday  IBM contributor
50Aug 12, 2010 5:08:23 PMPam Gilday  IBM contributor
49Aug 12, 2010 5:06:01 PMPam Gilday  IBM contributor
48Aug 12, 2010 4:28:54 PMPam Gilday  IBM contributor
47Aug 12, 2010 4:28:29 PMPam Gilday  IBM contributor
46Aug 12, 2010 4:18:37 PMPam Gilday  IBM contributor
45Aug 12, 2010 4:18:27 PMPam Gilday  IBM contributor
44Dec 2, 2009 11:41:58 AMAmy Smith  IBM contributor
42Oct 30, 2009 4:11:04 PMJulia Brown  IBM contributor
41Oct 30, 2009 4:09:32 PMJulia Brown  IBM contributor
40Oct 30, 2009 4:08:39 PMJulia Brown  IBM contributor
39Oct 30, 2009 4:06:43 PMJulia Brown  IBM contributor
38Oct 30, 2009 4:05:44 PMJulia Brown  IBM contributor
37Oct 30, 2009 4:04:21 PMJulia Brown  IBM contributor
36Oct 30, 2009 4:03:09 PMJulia Brown  IBM contributor
35Oct 30, 2009 2:22:14 PMKendra Bowker  IBM contributor
34Oct 28, 2009 6:04:31 PMAmy Smith  IBM contributor
33Oct 21, 2009 10:09:01 AMPam Gilday  IBM contributor
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedHelpAbout
  • IBM Collaboration Solutions wikis
  • IBM developerWorks
  • IBM Software support
  • Twitter LinkIBMSocialBizUX on Twitter
  • FacebookIBMSocialBizUX on Facebook
  • ForumsLotus product forums
  • BlogsIBM Social Business UX blog
  • Community LinkIBM Collaboration Solutions
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Accessibility
  • IBM Terms of use
  • Wiki terms of use