findinsite-cd Language support

The first two characters of the locale string give the ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. Here is a full list of language codes taken from http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

If supplied, the next two characters of the locale string give the ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. Here is a full list of country codes taken from http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

DefaultLocale

You can change the default locale for these older browsers by setting the defaultLocale applet parameter. For example, to set the default locale to French, add the following parameter to your search page:

<PARAM NAME=defaultLocale VALUE="fr">

• The best matching available language is chosen.
• If more than one index parameter is specified with locales, then the most appropriate index is chosen - see the Indexes page for full details.

• the user can switch language using the "Languages" button (if it is available)
• If present, the user can change index using the "Indexes" button.

• Write a language file
• Tell FindinSite-CD to use it using the Languages parameter.

Writing a language file

The display button labels, text and messages for a language are defined in a language file. FindinSite-CD has built-in support for English and many other languages. The language files are in the COM/phdcc/lang subdirectory of the FindinSite-CD runtime. By convention, a language file usually has a file extension of .hil.

There are three different language file formats. The recommended format is a plain text file, starting with a line containing the number 3. Then specify more lines with name=value string definitions. See the string name definitions section below for details all strings.

A language file must include Language, Country, Localname and Englishname definitions, as can been seen in this excerpt from the German language file:

3 Language=de Country= Localname=Deutsch Englishname=German   L_AND=UND L_OR=ODER L_NOT=NICHT   L_PAGES_AND=\ Seiten und L_WORDS=\ W\u00F6rter.

The last two definitions illustrate these points:

• If you want a space at the beginning or end of a string value then you must write it as \ .
• Any non-USASCII characters should be expressed in Unicode format, ie \uHHHH where HHHH is the hexadecimal for the Unicode character. For example:
  • \u00F6 for the small letter o with a diaeresis:  ö, ie U+00F6
  • \u20AC for the Euro symbol:  €, ie U+20AC.
• The backslash character must be represented as \\.
• Other characters may also be preceded by \, as in the space example above \ .

Alternatively, you can store the language file in UTF-8 format, with UTF-8 prefix bytes 0xEF 0xBB 0xBF. Windows Notepad normally stores these prefix bytes automatically if you store in the UTF-8 Encoding. Note that you must use \  for a space at the end of a string.

If you do not specify definitions for any strings, then the English version will be used.

Languages parameter

Once you have written a language file, you must tell FindinSite-CD to use it. Put the language file in your FindinSite-CD directory in your CD image and add a Languages parameter.

The optional Languages parameter should contain a comma-separated list of language file URLs. If you supply a language file for a language that is built-in to FindinSite-CD, then your language definition will take precedence.

For example, to add Greek language support and replace the English language file, you could specify the following, where FindEl3.hil has the Greek locale language code of el, and FindMyEn3.hil has the English locale language code of en.

<PARAM NAME=Languages VALUE="FindEl3.hil,FindMyEn3.hil">

For older language file formats, you need to specify language and country codes in addition to the language file URL. Put these after semi-colons after the URL, eg:

<PARAM NAME=Languages VALUE="FindEl3.hil,FindEnUK.hil;en;gb">

This method will change any language, including the ones you supply using the Languages parameter.

You can provide one or more parameters for each built-in language. The parameter name must be in this format:

Lang_<language code><country code>_<index>

where

<language code> is the language code
<country code> is the optional language country code
<index> is a number incrementing from 1 for each language

The parameter value is in this format:

<string name>,<new string>

where

<string name> is the name of the string that you want to replace in upper case
<new string> is the new string

The parameter name is case insensitive, but the <string name> in the parameter value must be in upper case. The <new string> must use the backslash escape sequences described above if necessary.

The string name definitions are given below. Note that you cannot change the Language, Country, Localname and Englishname definitions.

This example replaces two English strings and one string each for French and Traditional Chinese:

<PARAM NAME="Lang_en_1" VALUE="L_SUBSETS,Sets"> <PARAM NAME="Lang_en_2" VALUE="L_SELECT_SUBSETS, Choose which data set to use\:"> <PARAM NAME="Lang_fr_1" VALUE="L_DATABASES,bases de donn\u00E9es"> <PARAM NAME="Lang_zhTW_1" VALUE="L_SUBSETS,\u7528\u6237\u7535\u8BDD\u673A">

<PARAM NAME=UseLanguages VALUE="en,fr,zhTW">

<PARAM NAME=UseLanguages VALUE="en">

Do not specify a UseLanguages parameter at all if you want all the supplied FindinSite-CD languages available.

<PARAM NAME=ShowLanguages VALUE="no">

Language file string name definitions

In most cases the string name is self explanatory. However, a special description is added where necessary. Note carefully that some strings require spaces at the beginning and end. As can be seen, you can use basic HTML in some strings, as described in the Screen layout - Results layout section.