Users Guide

Hebrew Support for PalmOS
 
Version 2.00

June 15, 1998


1 Introduction
--------------
Hebrew Support for PalmOS provides basic Hebrew 
language capabilities for the Palm Organizer.  Hebrew 
Support allows all applications on the Palm Organizer 
(built-in applications as well as 3rd party applications)
to handle textual data, which contains Hebrew Characters.

Hebrew Support for PalmOS, Version 2.00 runs on the 
PalmPilot (Personal and Professional) as well as on the 
Palm III.

Hebrew Support for PalmOS has been implemented in a 
way that provides seamless integration between the 
Palm Organizer and the Windows desktop.  In order to 
achieve this, Hebrew characters on the Palm Organizer 
are mapped to the same character codes that they are 
mapped to in Windows (characters 224 - 251).  This 
ensures that any Hebrew characters which are 
transferred between the Palm Organizer and any 
Windows based program will be displayed properly 
both on the Palm Organizer as well as in Windows.

This version of Hebrew Support requires a registration 
key, but can be used for a 30 day evaluation period 
without the registration key.  If the registration key
has not been entered within the 30 day evaluation
period, the Hebrew Support software will be disabled.

2 Hebrew Support Features
-------------------------

2.1 Hebrew Font Support
-----------------------
The Palm III contains four different fonts for text: 
normal, bold, large, and large bold.  Hebrew characters 
have been implemented for all of these fonts (on the 
PalmPilot there is no support for the large bold font).

2.2 Data Entry via the Hebrew Popup Keyboard
--------------------------------------------
Hebrew text can be entered on the Palm Organizer via a 
popup keyboard.  The Palm Organizers standard popup 
keyboard has been replaced with a Hebrew keyboard.  
The keyboard can be activated in any field where text 
entry is allowed.  The keyboard can be activated using 
any of the Palm Organizers standard mechanisms for 
activating the popup keyboard:

1. Tapping on the "a b c" in the lower left corner of
   the Graffiti area.

2. Entering "Command K" in text fields which support 
   this.

3. Selecting "Keyboard" from the Menu on text fields
   which support this, or 4) using the "Pen" stroke if 
   it is configured to activate the keyboard (this can
   be configured via the Palm Organizers System
   Preferences application - "Buttons" category).

While the Hebrew keyboard is active, standard  Graffiti 
characters may be entered in the Graffiti area, and the 
standard popup keyboard (alpha or numeric) can be 
activated from within the Hebrew Keyboard dialog by 
tapping the appropriate corners of the Graffiti area.

2.3 Right to Left Display
-------------------------
When Hebrew Support for PalmOS is enabled, all 
Hebrew texts will be displayed properly from right to 
left.  Support for fields containing both Hebrew and 
English text is provided as well.  The text of a field 
which contains both Hebrew and English characters can 
be interpreted in one of two ways; as Hebrew text with 
English embedded, or as English text with Hebrew 
embedded.  How this is interpreted is determined by the 
Hebrew Support software based on the text that has 
been entered into the field.  The Hebrew Support 
software scans the text looking for the first letter 
(numbers, punctuation and other characters are ignored).
If the first letter is a Hebrew letter, the field will
be considered to be a Hebrew field, and the characters
will be displayed from "right to left".  Any English
characters in this field will be displayed from "left
to right" within the display of the Hebrew text.  If 
the first letter of the field is an English letter, the
field will be treated as an English field, and will be
displayed from "left to right".  Any Hebrew text, which is
found in this field, will be displayed from "right to left"
within the display of the English text.

There is special handling of parenthesis when Hebrew 
text is being entered (via the Hebrew Keyboard Dialog).  
In a field which is displayed from "right to left", any 
parenthesis which are entered (from within the Hebrew 
Keyboard dialog) are stored as the opposite parenthesis 
(i.e., if a left parenthesis is entered, it will be changed
to a right parenthesis, and vice versa).  In order to 
compensate for this, in fields that are displayed from 
"right to left", parenthesis are swapped when they are 
displayed.  This may sound confusing, and not make 
much sense, since on the Pilot everything is displayed 
as expected (due to the double swap), however it is 
necessary in order to maintain compatibility with the 
way parenthesis are handled and displayed in Windows 
with Hebrew.

When viewing Web sites that contain Hebrew using 
your Palm Organizer (there are several Web browsers 
available), occasionally the Hebrew text is displayed 
backwards.  In order to properly view web sites where 
Hebrew text is displayed backwards, the ability to 
temporarily disable the "right to left" display is 
provided.  In order to disable the "right to left" display, 
run "Hebrew" on the Palm Organizer.  On the main 
screen tap the "Menu" button, and select "Toggle 
Direction".  The Hebrew text on this screen will be 
reversed, as will all other Hebrew texts.  You can then 
return to the Web site where Hebrew was displayed 
backwards, and see the text displayed properly.  In 
order to return Hebrew to its normal "right to left" 
display, repeat the process described above.  
Alternatively, toggling the direction can be done by 
using the Command stroke followed by the letter "T" on 
the main screen of "Hebrew".  If the Palm Organizer is 
reset while "right to left" is disabled, it will 
automatically be enabled after the reset.

2.4 PC Synchronization
----------------------
Support is provided for displaying Hebrew text that was 
entered using the Palm(Pilot) Desktop (or any other 
desktop PIM that can be synchronized with the Palm 
Organizer).  The text will be displayed properly on the 
Palm Organizer after performing a HotSync with the PC 
(this may work on a Macintosh, but has not been 
tested).  In addition, Hebrew text, which is entered on 
the Palm Organizer, will be transferred properly to the 
desktop application, and displayed correctly in the 
desktop application.

2.5 Sort Order
--------------
Support is provided for proper sorting of Hebrew entries 
in the Address Book, and any other applications which 
require sorting.  Hebrew entries will appear after all of 
the English entries.  This is consistent with sorting 
performed by Windows.

3 Installation
--------------
The following files are required in order to install 
Hebrew support on the Palm Organizer:

hebrew.prc
----------
This file is the application that is run on the Palm
Organizer in order to Enable or Disable the Hebrew
Support software.  This application is also used to enter
the registration key.

hebfont.pdb
-----------
This file contains the Hebrew Fonts used by this software. 

Hebtraps.prc
------------
This file provides support for background features that
are required by Hebrew Support.  The background features
that are supported are: 1) displaying Hebrew text from
right to left, 2) providing a Hebrew popup keyboard for
entering Hebrew characters on the Palm Organizer, and
3) Providing support for proper sorting of data which
contains Hebrew characters.

The following sequence must be followed in order to 
install Hebrew Support on the Palm Organizer:

1. In order for Hebrew Support to work properly, 
   all of the above files must be installed on the 
   Desktop PC.  The files should be installed using 
   the Palm(Pilot) Install Tool (instapp.exe) that is 
   provided as part of the Palm(Pilot) desktop 
   software.

2. After installing all of the files using the 
   Palm(Pilot) Install Tool, a HotSync must be 
   performed in order to transfer the files to the 
   Palm Organizer.

3. After installing these files on the PC and 
   performing a HotSync to transfer the files to the 
   Palm Organizer, the "Hebrew" application must 
   be run on the Palm Organizer in order to enable 
   Hebrew Support.  To run the "Hebrew" 
   application, tap on the Icon which is labeled 
   "Hebrew".  If Hebrew is not enabled, a message 
   indicating this will be displayed, and there will 
   be a button labeled "Enable" (if Hebrew is 
   already enabled, a message indicating this will 
   be displayed on the Palm Organizer, and the 
   button will be labeled "Disable").  Tap the 
   "Enable" button in order to enable Hebrew 
   Support.  Hebrew Support can be disabled if 
   necessary, by running "Hebrew" again, and 
   tapping on the "Disable" button.

Once these steps are completed, Hebrew support is 
available on the Palm Organizer.

After Hebrew Support has been installed (or 
reinstalled), the entries in the Address Book may not be 
sorted correctly.  This can be corrected by using the 
following technique:

From within the Address List view of the Address 
Book, tap the "Menu" button on the Palm Organizer.  
Select Options / Preferences.  Change the "List By" 
selection to the unselected setting ("Last Name, First 
Name" or "Company, Last Name"), and tap the OK 
button.  Repeat this process to return the "List By" 
setting to its original setting.  Your Address Book 
should now be sorted correctly.

Alternatively, after installing and enabling Hebrew 
Support on the Palm Organizer, the Address Book will 
be re-sorted on the next HotSync after changes have 
been made to the data in the Address Book.

4 Registration
--------------
Hebrew Support for PalmOS can be used for a 30 day 
evaluation period before it must be registered.  At the 
end of the evaluation period the software will stop 
functioning if it has not been registered.

In order to register Hebrew Support for PalmOS a 
"registration key" must be obtained.  The key is 
determined by the User Name associated with the Palm 
Organizer.  The User Name is defined in the Palm(Pilot) 
Desktop software during the installation process, and is 
transferred to the Palm Organizer when the first 
HotSync is performed.

If the Hebrew Support software has not been registered, 
the User Name can be viewed by running the "Hebrew" 
application, and tapping the "Register Now" button.  
This will cause a dialog box which shows the User 
Name to be displayed.

The User Name can also be viewed by tapping the 
HotSync application icon on the Palm Organizer.  On a 
PalmPilot the User Name is displayed immediately 
following the word "Welcome,".  On a Palm III, the 
User Name is displayed in the top right corner of the 
screen.

Once a "registration key" has been obtained, the 
Hebrew Support software can be registered by running 
the "Hebrew" application on the Palm Organizer.  If the 
software has not been registered, the "Register Now" 
button will be displayed when the "Hebrew" application 
is run.  When you tap the "Register Now" button a 
dialog box will be displayed that shows the User Name, 
and has a field where the "registration key" can be 
entered.  The "registration key" is an eight character 
string which contains a combination of digits (0 - 9) 
and lower case letters (a - z).  Once the "registration 
key" has been entered, tap the "Register" button.  If you 
are not ready to register the software, or have not yet 
obtained a valid "registration key", tap the "Cancel" 
button.  If the "registration key" you entered is valid, a 
message will be displayed indicating that you have 
successfully registered the software.  Make sure that 
you have recorded the "registration key" in a safe place 
in case there is a need to re-register the software in the 
future.  If an invalid "registration key" was entered, a 
message will be displayed indicating that the key is not 
valid.

If you have never performed a HotSync on the Palm 
Organizer, the Palm Organizer will not have a User 
Name associated with it.  If this is the case, a message 
will be displayed to indicate this.  After the first 
HotSync has been performed, the User Name will be 
assigned on the Palm Organizer. The Hebrew Support 
software can then be registered.

Whenever the "Hebrew" application is run on the Palm 
Organizer, current registration information will be 
displayed on the main form of the application.  If the 
software has been registered, this will be indicated, and 
the User Name will be displayed.  In this case the 
"Register Now" button will not be displayed.  If the 
software has not been registered this will be indicated, 
and a message indicating the number of days left before 
expiration will be displayed.

If the "Hebrew" application is run after Hebrew Support 
has expired, and it has never been registered, Hebrew 
Support will automatically be disabled.  Once the 
evaluation period has expired, Hebrew support cannot 
be enabled until the software has been registered.

Information on the registration status will be displayed 
in the title line of the Hebrew Keyboard dialog as well.

From the main form of the "Hebrew" application, 
registration information can be viewed at any time by 
the menu selection - Options / Registration.  Selecting 
this menu entry will allow you to register, or to view 
registration information if you have already registered 
the software.

5 Using the Hebrew Keyboard
---------------------------
When the Hebrew Keyboard is activated, the Hebrew 
Keyboard dialog will be displayed.  The Hebrew 
Keyboard dialog is comprised of the following 
components:

1. The data entry area.

2. The Hebrew Keyboard (all Hebrew letters, plus 
   certain punctuation keys).

3. Control buttons ("Done", "Edit" / "Normal").

4. The Graffiti Shift Indicator (to the right of the 
   "Edit" / "Normal" button) which displays the 
   current Graffiti state (e.g., Shift, Punctuation, 
   Extended shift, etc.).

5. Scroll arrows which are displayed if the field 
   contains more than four lines of text (to the right 
   of the Graffiti Shift Indicator)

If there was text in the field from which the Hebrew 
Keyboard was activated, this text will be displayed in 
the data entry area of the Hebrew Keyboard dialog.  
When data entry is completed, and the "Done" button is 
tapped, the contents of the data entry area will be copied 
to the original field.  Certain properties of the original 
field will be maintained as follows:

- If the original field was limited to a single 
  line, the Hebrew Keyboard dialog will 
  display only a single line for data entry.  If
  the original field allowed multiple lines, then 
  the Hebrew Keyboard dialog will contain 
  multiple lines.

- If "Autoshift" was enabled in the original 
  field, it will be enabled in the field of the 
  Hebrew Keyboard dialog.

- The maximum number of characters that can 
  be entered into the field of the Hebrew 
  Keyboard dialog will be based on the 
  maximum number of characters allowed in 
  the original field.

The alpha and numeric popup keyboards can be 
activated from within the Hebrew Keyboard dialog by 
using the standard Palm Organizer mechanism of 
tapping in the lower left or right corners of the Graffiti 
area.  After you have finished entering data using one of 
these keyboards tap the "Done" button to return to the 
Hebrew Keyboard.

In order to edit text containing Hebrew, you should tap 
the "Edit" button.  This will reverse the text (i.e., it will 
be displayed from left to right), but will allow correct 
cursor placement for editing.  After editing is 
completed, tap the "Normal" button in order to have the 
Hebrew text displayed properly.

In order to minimize confusion when activating the 
Hebrew Keyboard, the cursor is placed at the end of the 
field.  New characters that are typed will be added to the 
end of the existing text.  In order to edit the text; use the 
"Edit" button as described above.

6 Disabling / Deleting / Reinstalling
-------------------------------------
6.1 Disabling
-------------
In order to disable Hebrew Support, run the "Hebrew" 
program on the Palm Organizer.  If Hebrew Support is 
enabled, tap the "Disable" button.

6.2 Deleting
------------
If Hebrew Support has been registered on your Palm 
Organizer, the "registration key" will be deleted if you 
delete "Hebrew" from the Pilot.  Before doing this, 
make sure that you have recorded the "registration key" 
in a safe place so that you can re-register after Hebrew 
Support has been reinstalled.

In order to delete Hebrew Support from the Palm 
Organizer, you must first "Disable" it (as described 
above).  Once Hebrew Support has been disabled, it can 
be deleted from the Palm Organizer.

In order to delete "Hebrew Support" on a Palm III, tap 
the "Applications" button, and then select Menu / 
Delete.  Select "Hebrew" in the list of applications, and 
tap the "Delete" button, and confirm its deletion.  This 
will delete all of the files that were installed as part of 
Hebrew Support for PalmOS.

In order to delete "Hebrew Support" on a PalmPilot, run 
the "Memory" application and tap the "Delete apps" 
button.  Select "Hebrew", and confirm its deletion.  This 
will delete all of the files that were installed as part of 
Hebrew Support for PalmOS.

Deleting Hebrew Support without first "Disabling" it 
will cause the Pilot to crash.  If this happens, reset the 
Pilot by inserting a paper clip in the hole on the back of 
the Pilot which is labeled "RESET".  Doing this should 
not cause any data loss.

6.3 Reinstalling
----------------
In order to reinstall Hebrew Support software on the 
Palm Organizer (or install a newer version of the 
software), you must make sure to "Disable" Hebrew 
Support (as described above) before installing the new 
software.  Once Hebrew Support has been "Disabled", 
just follow the installation procedures.  Do not delete 
the Hebrew Support software unless specifically 
instructed to do so.

7 Compatibility
---------------
This release has been tested on the PalmPilot Personal 
and the PalmPilot Professional running PalmOS 2.0.4, 
as well as on the Palm III running PalmOS 3.0.  Hebrew 
Support does not work on PalmOS 1.0 (Pilot 1000 / 
5000).  Hebrew Support has not been tested on the IBM 
WorkPad, although it has been reported that it does 
work properly.

Problems have been reported when trying to install 
Hebrew Support from the Macintosh Desktop software.  
If you encounter such a problem, it is recommended that 
you try to install Hebrew Support from a PC, or when 
running one of the Window's Emulators on the 
Macintosh.

8 Known Limitations
-------------------
- Hebrew Support for PalmOS does not provide 
  complete support for editing text that contains 
  Hebrew characters.  Due to the current 
  implementation, the Palm Organizer itself is not 
  aware of the fact that certain characters are 
  displayed "backwards", i.e.; from right to left.  As a 
  result of this, attempting to edit such text will 
  usually result in characters being added or deleted in 
  the wrong place.  The recommended way to edit 
  fields with Hebrew characters is via the Hebrew 
  Keyboard dialog.  Once the Hebrew Keyboard is 
  displayed, tap the "Edit" button.  This will cause the 
  Hebrew text to be displayed the way the Palm 
  Organizer thinks it should be shown (from left to 
  right), and the text can then be edited, without 
  confusing the Palm Organizer.  Trying to edit 
  Hebrew text in any other way (in a regular field, or 
  in the Hebrew Keyboard dialog while displaying 
  from right to left) will usually result in confusion.  
  After editing has been completed, return to "right to 
  left" mode by tapping the "Normal" button on the 
  Hebrew Keyboard dialog.

- Hebrew characters cannot be entered using Graffiti.

- Fields containing Hebrew characters remain left 
  justified.

- When entering more than four lines of text in the 
  Hebrew Keyboard dialog, the cursor does not 
  advance to the next line properly when the end of 
  the fourth line is reached (e.g., after a carriage 
  return).  Once the next character is typed the field is 
  adjusted properly, and the display is correct.  No 
  data is lost when this happens.

- If Hebrew text is included as part of a shortcut, and 
  it is entered in a text field (not from within the 
  Hebrew Keyboard dialog), it will be displayed 
  backwards when it is entered.  Updating the display 
  (by changing to a different screen and then returning 
  to the desired screen) will correct this situation, and 
  the text will then be displayed correctly.

- When Hebrew Support is enabled on the Palm 
  Organizer, lower case accented vowels (used in 
  some European languages) can not be used, since 
  the Hebrew characters use the character codes 
  normally used by these characters.

- On the Palm(Pilot) Desktop, Hebrew is not 
  displayed properly in certain fields of certain 
  applications (e.g.; the text field of the Memo 
  application).  This is a problem of the Palm(Pilot) 
  Desktop, and not of Hebrew Support for PalmOS.  
  If Hebrew is not displayed properly in the 
  Datebook, try changing the screen resolution to 640 
  x 480.

- When using Intellisync with Microsoft Outlook, 
  certain Hebrew characters (resh and pay) at the end 
  of names in the Address Book are truncated.  This 
  does not happen when using Microsoft Outlook with 
  Desktop to Go from Dataviz, or with Pocket Mirror 
  from Chapura.

9 Frequently Asked Questions
----------------------------
Q: How do I lookup a Hebrew name in the Address Book?
A: Activate the Hebrew keyboard when the cursor is in
   the "Lookup" field of the Address Book application.
   Enter the first few letters of the last name, and tap
   the "Done" button in the Hebrew Keyboard dialog.
   After returning to the "Lookup" field, the cursor will
   be on the first name which matches the letters that
   have been entered.  If there is no entry that matches
   all of the letters, the closest match will be found, 
   and the letters that do not match will be erased.

Q: How do I set an Untimed Event in Hebrew in the Date
   Book?
A: The easiest way for setting Untimed Events is to 
   begin writing in the Date Book when no time is 
   selected.  Doing this will automatically open an 
   Untimed Event.  Unfortunately, when no time is 
   selected, there is no way to activate the Hebrew 
   Keyboard.  There are two ways this can be 
   accomplished.  You can write the first character 
   in English, and then popup the Hebrew Keyboard.  The
   English character can then be erased, and you can
   continue entering data.  Alternatively, select a
   time, and activate the Hebrew Keyboard.  After
   entering the Hebrew text, return to the Date Book.
   After returning to the Date Book tap on the hour
   that the appointment was set for, and change the
   time to "No Time".

Q: Why cant I use the International (Intl) 
   keyboard with Hebrew?
A: The International keyboard is designed for 
   entering accented vowel characters which are 
   used in European characters.  Since the Hebrew 
   characters replace the accented vowel 
   characters, Hebrew characters are displayed 
   when the International keyboard is activated.  
   This keyboard should not be used for entering 
   Hebrew characters since they will not be 
   displayed properly when they are entered.  In 
   addition, they letters are not placed in their 
   correct positions on this keyboard.

Q: How do I activate the standard Palm Organizer 
   keyboard when Hebrew Support is enabled?
A: The numeric keyboard can be activated in the 
   normal way by tapping on the lower right corner 
   of the Graffiti area.  Once the numeric keyboard 
   is activated, you can switch to the Alpha 
   keyboard by tapping the "ABC" button.  Both 
   the Alpha and Numeric keyboards can be 
   activated from within the Hebrew Keyboard 
   dialog, however, when this is done, you will be 
   returned to the Hebrew Keyboard after tapping 
   the "Done" button in the Alpha or Numeric 
   keyboard.  If you dont want to enter any 
   Hebrew characters, its best to activate the 
   Numeric keyboard directly.

Q: Why cant I enter more than 8 characters in the 
   text field of the Hebrew Keyboard dialog?
A: You probably activated the Hebrew Keyboard 
   from the "Lookup" field of the Address Book.  
   This field accepts a maximum of eight 
   characters, and this limit is enforced by the 
   Hebrew Keyboard dialog.  You may have 
   activated the Hebrew Keyboard from another 
   field, which also has a limit on the number of 
   characters that can be entered.

