README.md
<html>

<head>
<title>README for Kaluach Kaf� (Kaluach for the Palm�)</title>
<style type="text/css">
body {
background : white;
color : black;
font-family : Arial, Verdana, Helvetica;
text-align : justify;
}
ul.history {
margin : 0 0 0 0;
font-weight : bold;
}
ul.history ul.history {
margin : 0 0 1em 2em;
font-weight : normal;
list-style : disc;
}
a:link, a:visited, a:active {
color : purple;
}
a:hover {
color : black;
background : silver;
}
h2 {
border-top : 6pt solid green;
color : #efefef;
background : "#77af77";
}
h3 {
border-top : 3pt solid green;
color : #efefef;
background : "#77af77";
}
</style>
</head>

<body bgcolor="#FFFFFF">

<h2>Kaluach Kaf� (palm)<br>
<font size="4">Kaluach� for the Palm�</font></h2>

<p><b>Copyright � 5757-5761 (1996-2001 CE) Abu Mami.<br>
All rights reserved.</b></p>

<address>
E-Mail: <a href="mailto:contact@kaluach.org">contact@kaluach.org</a>
</address>

<address>
Web Page: <a href="http://www.kaluach.org">http://www.kaluach.org</a>
</address>

<h3>Forward</h3>

<p><i>Kaluach Kaf</i> is an easy to use Hebrew/Civil calendar
for the Palm� or compatible devices. Based on the original Kaluach
for Windows�, you will find the same accuracy and many of the
same features in both versions.</p>

<h3>Special Notes</h3>

<p>Please note that <i>Kaluach Kaf</i> is <b>FairWare.</b> If you would like
to use it, please send an amount that you feel is fair. I won't tell you how
much, but if you send nothing you're using an illegal copy.</p>

<p>If you have any comments or suggestions please feel free to mail
them to <a href="mailto:contact@kaluach.org"> contact@kaluach.org</a>.
But before you do, please read the <a href="#FAQ">FAQ</a> section first,
your question may already have been answered.</p>

<p>This is a new program. It is now a "final" product, but in some
ways is a <b>work in progress</b>. It has been tested fairly extensively
but there still might that odd bug or two lurking around the corner.

<p>If you are upgrading from an earlier version of <i>Kaluach Kaf</i>
you can find out what has changed by reading the
<a href="#Version History">Version History</a> section.</p>

<h3>Contents of This Document</h3>

<ol type="I">
<li><a href="#Installation">Installation</a></li>
<li><a href="#System Requirements">System Requirements</a></li>
<li><a href="#ZIP File Contents">ZIP File Contents</a></li>
<li><a href="#Usage">Usage</a></li>
<li><a href="#Version History">Version History</a></li>
<li><a href="#FAQ">FAQ</a></li>
<li><a href="#Bugs">Bugs</a></li>
<li><a href="#To Do">To Do</a></li>
<li><a href="#Credits">Credits</a></li>
<li><a href="#Web Sites">Web sites</a></li>
<li><a href="#Copyrights and trademarks">Copyright and trademarks</a></li>
</ol>

<h3><a name="Installation">I. Installation</a></h3>

<ul>
<li><i>Kaluach Kaf</i> is installed just like any other Palm program.</li>
<li>Optional installation of <a href="#Mathlib">MathLib.prc</a> is required for
display of zmanim. MathLib is a freeware package, and is included with the
distribution of Kaluach Kaf.</li>
</ul>

<h3><a name="System Requirements">II. System Requirements</a></h3>

<ul>
<li>Palm OS 3.0 or greater (because of Kaluach Kaf's built-in Hebrew support, earlier versions
will not work correctly)</li>
<li>If the display of zmanim (halachic times) is desired, then installation of Mathlib.prc is required.</li>
<li>Hebrew support is <b>not</b> needed.</li>
</ul>

<h3><a name="ZIP File Contents">III. ZIP File Contents</a></h3>

<table border="0">
<tr>
<td valign="top"><a href="tcAssist.prc"><i><b>Kaluach.prc</b></i></a></td>
<td>&nbsp;</td>
<td>The <i>Kaluach Kaf</i> application that you install on
your Palm� or compatible device.</td>
</tr>
<tr>
<td valign="top"><i><b>readme.htm</b></i></td>
<td>&nbsp;</td>
<td>this file - duh!</td>
</tr>
<tr>
<td valign="top"><a href="MathLib.prc"><i><b>MathLib.prc</b></i></a></td>
<td>&nbsp;</td>
<td>High precision math libary used for the halachic times calculations.</td>
</tr>
</table>

<h3><a name="Usage">IV. Usage</a></h3>
<ul>
<li><b><i>Summary of calendar buttons:</i></b></li>
<ul>
<li><b>scroll buttons (for month and year)</b><br>
right arrow advances month/year<br>
left arrow goes back month/year<br>
tapping year arrows and holding down will kick in "turbo scroll"
</li>
<li><b>(Locs) button</b><br>
Quick change between locations.<br>
</li>
<li><b>Clock button</b><br>
Display zmanim (halachic times).<br>
</li>
<li><b>[E|Ayin] button</b><br>
Switch between Hebrew (Ayin) and English (E) display.<br>
</li>
<li><b>[Right arrow] and [Left arrow] buttons</b><br>
Civil calendar displays from left to right.<br>
Hebrew calendar displays from right to left.<br>
&nbsp;&nbsp;&nbsp;&nbsp; so therefore...<br>
When in Civil calendar display, tapping on left arrow switches to Hebrew calendar view.<br>
When in Hebrew calendar display, right arrow switches to Civil calendar display.<br>
</li>
</ul>
</ul>

<ul>
<li><b><i>Summary of moadim/holiday icons:</i></b></li>
<ul>
<li><b>"candles" ii (two small letter i's)</b><br>
yamim noraim (Rosh Hashanah and Yom Kippur)<br>
chagim (Succot, Shmini Atzeret/Simchat Torah, Pesach, Shavuot)<br>
</li>
<li><b>tilde ~</b><br>
chol hamoed - intermediate days of holiday<br>
</li>
<li><b>magen David (star of David)</b><br>
national holidays (yom haatzmaut, yom yerushalayim, yom hazikaron)<br>
holocaust memorial day (yom hashoah), lag baomer<br>
</li>
<li><b>pound sign #</b><br>
minor holidays (Purim, Chanukah, tu b'shvat)<br>
</li>
<li><b>filled circle &#149</b><br>
Rosh Chodesh<br>
</li>
<li><b>square</b><br>
fast days<br>
</li>
<li><b>sun</b><br>
birchat hachama - every 28 years<br>
&nbsp;&nbsp;&nbsp;&nbsp;last occurence: April 8, 1981<br>
&nbsp;&nbsp;&nbsp;&nbsp;next occurence: April 8, 2009<br>
(It does not always occur on April 8, it moves forward. In 2121 it will fall on April 9.)

</li>
</ul>
</ul>

<ul>
<li><b><i>Maintaining list of locations:</i></b></li><br>
Open the location dialog box from the menu <i>Options ==> Locations</i><br>
Choose a location from the list to modify, delete, or copy - or enter in the details of a new location.<br>
==> Please note that only 10 locations are allowed.<br>
The following buttons will then perform the desired action:
<ul>
<li><b>plus +</b><br>
add a new location, this can be a predefined location that had some details changed (that is, copied and changed)<br>
</li>
<li><b>minus -</b><br>
delete selected location<br>
</li>
<li><b>double arrow</b><br>
save changed to current locations<br>
</li>
</ul>
</ul>

<h3><a name="Version History">V. Version History</a></h3>

<ul>

<li><b>version 1.01 (5 Elul 5761)</b>
<ul>
Didn't take long till the first bug showed up. Don't know how that sucker slipped
past me. Oh well, it's fixed.
<li>fixed Daylight Saving Time bug - wasn't automatically switching on transition days</li>
<li>recompiled using latest SDK (ver 4.00) from Palm (now aren't you thrilled to hear that)</li>
</ul>
</li>

<li><b>version 1.00 (18 Tammuz 5761)</b>
<ul>
Well, it's finally here - the final version, 1.00. Since there were
no more bug reports, I figured it must be perfect.
</ul>
</li>

<li><b>final beta (really - bli neder) 003 (24 Sivan 5761)</b>
<ul>
OK, so I lied. This one is <b>really</b> the final beta (until the next one :-)
<li>added "turbo scroll" - tap on a year scroll arrow, hold down, and "turbo scroll" kicks in - this allows for <b>much</b> faster scrolling</li>
<li>can enable/disable "turbo scroll" from the menu <i>options => scrolling</i></li>
</ul>
</li>

<li><b>[not quite] final beta 002 (10 Sivan 5761)</b>
<ul>
<li>minor changes which no one will really care about (believe me, you could care less)</li>
<li>fixed the thousands in the Hebrew date when displayed in Hebrew (only for dates beyond 10,999 :-)</li>
</ul>
</li>

<li><b>beta 001 (29 Nissan 5761)</b>
<ul>
<li>finally created a Kaluach Kaf icon (still needs work - Is it supposed
to be round?? Does anyone care?)</li>
<li>diaspora holidays were not cleared when switching from a diaspora
location to an Israel location</li>
<li>times were cut off for Shvii and Shmini Pesach (diaspora only)</li>
<li>date was not displayed in the English display of the halachic times</li>
<li>ask user to confirm delete of location</li>
<li>if location fields were blank, the location was added anyway</li>
<li>if there were already 10 locations, in spite of being told that no more
locations were premitted, the location was added anyway, causing billows of
smoke to emanate from the Palm</li>
<li>location list is now sorted</li>
<li>minor bug fixes</li>
</ul>
</li>
<li><b>alpha 003 (22 Nissan 5761)</b>
<ul>
<li>added Daylight Saving Time handling</li>
<li>changed location dialog box to specify shita for each location</li>
<li>completed the implementation of the Maaseh Nissim zmanim shita
(although I'm not 100% sure of some of the details - it needs some more checking)</li>
<li>added birchat hachama</li>
<li>minor bug fixes</li>
</ul>
</li>
<li><b>alpha 002 (11 Nissan 5761)</b>
<ul>
<li>Fixed Tel Aviv to Israel, was diaspora (sometimes it seems like it :-)</li>
<li>minor fixes to readme (this) file</li>
<li>Added different shitot for calculation of zmanim.</li>
</ul>
</li>
<li><b>alpha 001 (8 Nissan 5761)</b>
<ul>
<li>Most major features have been implemented.</li>
<li>Allow changing between 5 user defined locations.</li>
<li>Added different shitot for calculation of zmanim.</li>
</ul>
</li>
<li><b>alpha 000 (16 Adar 5761)</b>
<ul>
<li>Initial version - many basic features missing or not working.</li>
</ul>
</li>
</ul>

<h3><a name="FAQ">VI. FAQ</a></h3>

<ul>
<li><b><a name="Mathlib">What is Mathlib, and why do I need it?</b><br>
Mathlib is a high precision math library available as freeware.
Kaluach Kaf uses this library for the calculations of the
halachic times. Other methods do not provide the same level
of precision, or they unecessarily bloat the size of the program.
With Mathlib, the program size is kept reasonably small (while at
the same time being available for other programs). Furthermore,
the high precision of this library results in the same accuracy
as available in Kaluach for Windows.<br>
&nbsp;</li>
<li><b>Do I really have to have Mathlib installed?</b><br>
No. You can use Kaluach Kaf without Mathlib, but the zmanim
(halachic times) won't be displayed.<br>
&nbsp;</li>
<li><b>I know why you have Jerusalem in the locations list, and Tel Aviv and Haifa, OK,
I'll give you those. But why Karnei Shomron? And Pittsburgh? You gotta be kidding.
Why not New York? They've got a few Jews there.</b><br>
You're right, Jerusalem should be in everyone's list. Karnei Shomron is on the list
because that's where I live. And I put Pittsburgh in the list since I grew up there.
And come on, New York? It's such a cliche.<br>
&nbsp;</li>
<li><b>Do I need Hebrew support to use </b><b><i>Kaluach Kaf</i></b><b>?</b><br>
No. Kaluach Kaf comes with Hebrew built in. Just load it as you
would any other Palm program.<br>
&nbsp;</li>
<li><b>How do I register </b><b><i>Kaluach Kaf</i></b><b>?</b><br>
Please send payment to:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Yisrael Hersch<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Havradim 11<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ginot Shomron 44853<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Israel<br>
Please send an amount that you feel is fair. I won't tell you how much,
but if you send nothing you're using an illegal copy. An equally acceptable
alternative would be to send me taped episodes of the A-Team or Fraggle Rock
(NTSC or PAL). Actually, being a cultured and educated person, I would really
prefer getting the tapes. Please let me know what you have and I'll let you
know if I need it.<br>
&nbsp;</li>
<li><b>May I give <i>Kaluach Kaf</i> to my friends?</b><br>
<b>current answer</b> - Of course, Kaluach Kaf is <i>Fairware</i>
(a variation on ShareWare). Give out as many copies as you want.
<b>old answer (alpha version)</b> - I would prefer that the alpha
version not be freely distributed. Once I feel that the program
is stable, a beta version will be released which will still be
time-limited, but you will still be able to give it out freely.<br>
&nbsp;</li>
<li><b>Is there a Windows CE version?</b><br>
No. However, I hope to start working on this in the near future.<br>
&nbsp;</li>
<li><b>What do you mean by near?</b><br>
A wise guy huh?<br>
&nbsp;</li>
<li><b>What's green and red and goes 120 miles per hour?</b><br>
A frog in a blender.
&nbsp;</li>
</ul>

<h3><a name="Bugs">VII. Bugs</a></h3>

<b>new answer (version 1.0x)</b> - Kaluach Kaf has undergone alpha and
beta testing. I can almost guarantee that there are still bugs. :-))<br>
<b>old answer (final beta version)</b> - Kaluach Kaf has undergone alpha
and beta testing. This means that I think that there aren't any bugs.
So... There are probably lots of bugs. Big bugs. Little bugs. Bugs that
bite. Bugs that crawl. Bugs with wings that fly around your head and
drive you crazy. And maybe, just maybe, the program will work. ;-)<br>
<b>old answer (before final beta version)</b> - Hey, this is a new package.
There are probably lots of bugs. Big bugs. Little bugs. Bugs that bite.
Bugs that crawl. Bugs with wings that fly around your head and drive
you crazy. And maybe, just maybe, the program will work.<br>


<h3><a name="To Do">VIII. To Do</a></h3>

<b><i>Here is what's planned for future versions of <i>Kaluach Kaf</i>, (in no particular order).</i></b>

<ul>
<li>beaming of dates and times (knowing that luach also translates
to board, you'll actually be able to say "beam me a board")</li>
<li>user data (birthdays, yahrzeits, anniversaries)</li>
<li>work on smoothing the action of the "turbo scroll", not sure this
is possible and it might be a big job (and I'm lazy)</li>
</ul>

<h3><a name="Credits">IX. Credits</a></h3>

<b><i>Thank you for your interest in Kaluach Kaf. I appreciate all comments and suggestions.</i></b>
<b><i>Special thanks to the following people for their valuable comments:</i></b>
<ul>
<li><b>Reuven Langer</b><br>
The first beta tester - he pushed me to release a Palm version of Kaluach. Thanks Reuven, I've got <b>lots</b> of spare time.<br>
</li>
<li><b>D'n Russler</b><br>
He volunteered to be a beta tester - well actually, he begged. It was <b>not</b> pretty. In any case,
D'n provided me with excellent bug reports. Thanks D'n. I'll try to repay you some day - maybe I'll
try to find you a vowel.<br>
</li>
<li><b>Steve Weisberg</b><br>
Valuable comments and suggestions.<br>
</li>
<li><b>Yonaton Horen</b><br>
Discussed a number of user interface issues with me, and provided many comments and suggestions.<br>
</li>
<li><b>David Kramer</b><br>
Pointed out some user interface problems, and provided valuable suggestions.<br>
</li>
<li><b>Yosh Mantinband</b><br>
Piles of really useful comments. (Also found the Daylight Saving Time bug, a day after Adam Karp.)
</li>
<li><b>Adam Karp</b><br>
Reported the Daylight Saving Time bug.
</li>
</ul>

<h3><a name="Web sites">X. Web sites</a></h3>
<b><i>For more information, visit the Kaluach family of web sites:</i></b>
<ul>
<li><b><a href="http://www.kaluach.org">www.kaluach.org</a></b><br>
The main Kaluach web site - home of Kaluach for Windows, Kaluach Kaf, and Abu Mami's Javascripts<br>
</li>
<li><b><a href="http://www.kaluach.net">www.kaluach.net</a></b><br>
Kaluach.net Hebrew calendar portal<br>
</li>
<li><b><a href="http://www.kaluach.org">www.kaluach.com</a></b><br>
Hebrew calendar development tools<br>
</li>
</ul>


<h3><a name="Copyrights and trademarks">XI. Copyrights and trademarks</a></h3>
<ul>
<li>All trademarks are properties of their respective owners.<br></li>
<li>Kaluach and Kaluach Kaf are trademarks of Abu Mami.</li><br>
<li>Abu Mami is a trademark of Yisrael Hersch.</li><br>
<li>Yisrael Hersch is a trademark of Mort and Gloria Hersch.</li><br>
<li>Kaluach, Kaluach Kaf, and all contents of the Kaluach web sites are copyright
Abu Mami and Yisrael Hersch. All rights reserved.</li><br>
</ul>

<h3><a name="Copyrights">XII. Shameless plug</a></h3>

<p>Visit Gloria Hersch's web site at: <a href="http://www.gghersch.com">www.gghersch.com</a></p>

</body>
</html>