OS/2 Shareware BBS: InfoMgt/InfoMgt.zip/diary11.zip/EXDIARY.HLP

OS/2 Help File | 1995-09-07 | 43KB | 695 lines

ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ

The Exercise Diary program allows an athlete to store and summarize exercise
activity.

The Exercise Diary program allows the user to enter routes and performances.
The details for each route are entered only once.  Performances can then be
added for each route.  The performances can be summarized by route, year,
month, or week.  The times for a route can be graphed as well as the weekly,
monthly, yearly distances. The fitness information (weight & resting heart
rate) can also be graphed.

The Exercise Diary program makes extensive use of containers.  Containers are
used by the Workplace Shell so most users should be very familiar with them.
The functions of this program are activated by selecting from a context menu or
double-clicking on a container item.  Each container accepts and saves fonts
dragged from the Font Palette and colours dragged from the Color Palettes.

The Performances files that are saved by the program are automatically
associated with the program.  That means that you can load a Performances file
by double-clicking on the file.  The Performances files will have the same icon
as ExDiary.exe.

o Installation
o Getting Started
o Registration
o Version history

Note:  The unregistered version is fully functional except you cannot create
more than 30 performances per file.  There are NO nags.

Note:  Suggestions for new features and bug reports are welcome.  Anyone that
reports a bug that can be reproduced will receive a registration key. Send
requests and bug reports to [e-mail].


ΓòÉΓòÉΓòÉ 2. Installation ΓòÉΓòÉΓòÉ

Copy ExDiary.exe, ExDiary.hlp, ExDiary.inf, and common.dll to a directory of
your choice.

Note:  ExDiary.exe and ExDiary.hlp must be in the same directory.

Note:  Common.dll must be in the same directory as ExDiary.exe or somewhere on
the LIBPATH.


ΓòÉΓòÉΓòÉ 3. Registration ΓòÉΓòÉΓòÉ

To register the Exercise Diary program please send a cheque or money order for
$20 US to:

        Marc Loiselle
        608 Jolly Place
        Victoria, BC
        V8Z 6S1

Please include your name and an email address so that I can send you a
registration key.  If you do not have an email address, please include a SASE
(Self Addressed Stamped Envelope).  When you receive the key you can register
the Exercise Diary program by selecting 'Register Exercise Diary...' from the
Help submenu of the main window popup menu (See below).  Enter your name and
key in the appropriate fields and click on the OK button.

Advantages of registering:

 1. You can create as many performances as you want.  The unregistered version
    is limited to 30 performances per file.
 2. You will be notified of free updates and bug fixes.
 3. You feel good because you are using registered shareware.
 4. You encourage me to continue development.


ΓòÉΓòÉΓòÉ 4. Keys ΓòÉΓòÉΓòÉ

Alt+R   Open the route dialog

Alt+P   Open the performance dialog

F1    Context help

F3    Quit the program when main window is selected

Alt+F4  Close the current window

Del    Delete selected performance


ΓòÉΓòÉΓòÉ 5. Filtering ΓòÉΓòÉΓòÉ

The performances included in the Performances window, Summaries or Graphs are
filtered depending on which year or month was selected from the main window.
Selecting "All years" will include all the performances.

If you select Open Performances from the main window with "All years" selected,
then all the performances will be loaded and displayed in the Performances
window.

If you select Summary->Route from the main window popup menu with 1995
selected, then only the performances of 1995 will be included in the route
summary.

If you select Summary->Route from the Performances window popup menu with
"Performances for 1995" in the titlebar, then only the performances of 1995
will be included in the route summary.


ΓòÉΓòÉΓòÉ 6. Getting Started ΓòÉΓòÉΓòÉ

The first thing that the program does when it opens is to load the routes from
the Routes file.  If a Routes file doesn't exist in the current directory it
will be created automatically.

The main window shows the years and months (using a tree, see below) for which
at least one performance exists in the Performances file indicated in the
titlebar.

o Loading a file
o Creating routes
o Creating performances


ΓòÉΓòÉΓòÉ 6.1. Loading a file ΓòÉΓòÉΓòÉ

A Performances file can be loaded by specifying it on the command line, in the
Parameters field of a Program Object, by dragging it onto the main window from
the Workplace Shell, or by double-clicking on the file from the Workplace
Shell.


ΓòÉΓòÉΓòÉ 6.2. Creating routes ΓòÉΓòÉΓòÉ

To create a new route, select Route from the Create submenu of the main window
context menu or press Alt+R.  A Route dialog will appear.  Close the dialog to
save the route.  The route will be automatically saved into the Routes file of
the current directory.


ΓòÉΓòÉΓòÉ 6.3. Creating performances ΓòÉΓòÉΓòÉ

To create a new performance, select Performance from the Create submenu of the
main window context menu or press Alt+P.  A Performance dialog will appear
along with a companion Route dialog.  Close the dialog to save the performance.
The performance will be saved into the Performances file shown in the titlebar
of the main window.

To create a new performance with the route already entered select 'Create
Another...' from the Performance context menu or 'Create Performance...' from
Route context menu.


ΓòÉΓòÉΓòÉ 7. Dialogs ΓòÉΓòÉΓòÉ

o Performance Dialog
o Route Dialog
o Preferences Dialog


ΓòÉΓòÉΓòÉ 7.1. Performance Dialog ΓòÉΓòÉΓòÉ

This dialog allows the user to create a performance.

The performance is saved when the dialog is closed or the New button is
pressed.  Press the ESC key to close the dialog without saving the performance.
A route dialog is automatically opened to show the route details.  The route
dialog cannot be closed.


ΓòÉΓòÉΓòÉ 7.1.1. Date ΓòÉΓòÉΓòÉ

Enter the date of the performance. The default in today's date.

Note:  The date order is the same as the date order specified using the Country
object in the System Setup folder.


ΓòÉΓòÉΓòÉ 7.1.2. Route ΓòÉΓòÉΓòÉ

Choose the route travelled for the performance from the list. The details for
the route are shown in the Route dialog.

Note:  A route must exist before the performance dialog is displayed for the
route to appear in the list.


ΓòÉΓòÉΓòÉ 7.1.3. Time ΓòÉΓòÉΓòÉ

Enter the time in hours, minutes and seconds.


ΓòÉΓòÉΓòÉ 7.1.4. Temperature ΓòÉΓòÉΓòÉ

Enter the air temperature in this field.


ΓòÉΓòÉΓòÉ 7.1.5. Effort ΓòÉΓòÉΓòÉ

Choose the amount of effort expended using the spin button.  The choices are
very easy, easy, moderate, hard, and very hard.


ΓòÉΓòÉΓòÉ 7.1.6. Weight ΓòÉΓòÉΓòÉ

Enter your body weight in this field.


ΓòÉΓòÉΓòÉ 7.1.7. Heart rate ΓòÉΓòÉΓòÉ

Enter your resting heart rate in this field.


ΓòÉΓòÉΓòÉ 7.1.8. Notes ΓòÉΓòÉΓòÉ

Enter any notes in this field.  The limit is 100 characters.


ΓòÉΓòÉΓòÉ 7.1.9. New ΓòÉΓòÉΓòÉ

Choose this button to save the current performance and reset all the fields to
their defaults.


ΓòÉΓòÉΓòÉ 7.2. Route Dialog ΓòÉΓòÉΓòÉ

This dialog allows the user to create a route.

The route is saved when the dialog is closed, the New button is pressed, or the
Save button is pressed.  Pressing ESC closes the dialog without saving the
performance.

Note:  The dialog cannot be closed if it is opened automatically by the
Performance dialog.


ΓòÉΓòÉΓòÉ 7.2.1. Route ΓòÉΓòÉΓòÉ

Enter the name of the route in this field. The limit is 15 characters.  The
name must be unique.


ΓòÉΓòÉΓòÉ 7.2.2. Distance ΓòÉΓòÉΓòÉ

Enter the distance travelled for this route.


ΓòÉΓòÉΓòÉ 7.2.3. Rating ΓòÉΓòÉΓòÉ

Enter the rating of the this route.  The limit is 1 character.


ΓòÉΓòÉΓòÉ 7.2.4. Pace Units ΓòÉΓòÉΓòÉ

Choose the units for the pace. The available options are kph, mph, min/mile.


ΓòÉΓòÉΓòÉ 7.2.5. Description ΓòÉΓòÉΓòÉ

Enter the description of this route.  The limit is 100 characters.


ΓòÉΓòÉΓòÉ 7.2.6. New ΓòÉΓòÉΓòÉ

Choose this button to save the current route and reset all the fields to their
defaults.


ΓòÉΓòÉΓòÉ 7.2.7. Save ΓòÉΓòÉΓòÉ

Choose this button to save the current route. note: This button is only
available when the dialog is opened automatically by the Performance dialog.


ΓòÉΓòÉΓòÉ 7.3. Settings Dialog ΓòÉΓòÉΓòÉ

This dialog allows the user to view and change the global settings for the
Exercise Diary application.


ΓòÉΓòÉΓòÉ 7.3.1. Distance Units ΓòÉΓòÉΓòÉ

Choose the distance units that you want.  The available units are kilometres
and miles.


ΓòÉΓòÉΓòÉ 7.3.2. Ok ΓòÉΓòÉΓòÉ

Select the Ok button to save the settings and dismiss the dialog.

Note:  Equivalent to pressing Alt-F4, pressing the Enter key, selecting close
from the System menu, or double-clicking on the System menu icon.


ΓòÉΓòÉΓòÉ 8. Context Menus ΓòÉΓòÉΓòÉ

This program makes extensive use of context menus.  A context menu appears when
the user clicks the right mouse button (RMB).  There are two types of context
menus for containers.  One is the container context menu; the other is the item
context menu.  The container context menu appears when the user clicks the RMB
in the container window but not on a container item.  A dashed line will appear
around the container.  The item context menu appears when the user clicks the
RMB on a container item.  A dashed line will appear around the item.


ΓòÉΓòÉΓòÉ 8.1. Main window context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked in the main window.
The available menu items are:

o File
o Settings...
o Create
o Routes Frame
o Help


ΓòÉΓòÉΓòÉ 8.1.1. File Menu ΓòÉΓòÉΓòÉ

Choose a file operation.  The available operations are:

o New
o Open...
o Save As...


ΓòÉΓòÉΓòÉ 8.1.1.1. New ΓòÉΓòÉΓòÉ

Select this menu item to creates a new untitled file.

Note:  The Routes file remains the same.


ΓòÉΓòÉΓòÉ 8.1.1.2. Open ΓòÉΓòÉΓòÉ

Select this menu item to open a Performances file. A standard file dialog is
displayed.  The Routes file in the same directory as the Performances file will
be opened automatically.


ΓòÉΓòÉΓòÉ 8.1.1.3. Save As ΓòÉΓòÉΓòÉ

Select this menu item to save the current file.  A standard file dialog is
displayed.

Note:  If there isn't a Routes file in the directory where the Performances
file is saved, the current Routes file will be copied into the directory.

Note:  You can have multiple Performances files in the same directory.


ΓòÉΓòÉΓòÉ 8.1.2. Settings... ΓòÉΓòÉΓòÉ

Opens the settings dialog.


ΓòÉΓòÉΓòÉ 8.1.3. Create ΓòÉΓòÉΓòÉ

Choose a create operation from the menu. The available create operations are:

o Route...
o Performance...


ΓòÉΓòÉΓòÉ 8.1.3.1. Route... ΓòÉΓòÉΓòÉ

Select this menu item to open a dialog which allows you to create routes.


ΓòÉΓòÉΓòÉ 8.1.3.2. Performance.... ΓòÉΓòÉΓòÉ

Select this menu item to open a dialog which allows you to create performances.


ΓòÉΓòÉΓòÉ 8.1.4. Routes Frame ΓòÉΓòÉΓòÉ

Displays all of the routes.


ΓòÉΓòÉΓòÉ 8.1.5. Help ΓòÉΓòÉΓòÉ

Use the choices on the Help menu to display:

o Help Index
o General Help
o Using Help
o Keys
o Register Exercise Diary...
o Product Information...


ΓòÉΓòÉΓòÉ 8.1.5.1. Help Index ΓòÉΓòÉΓòÉ

Use this choice to display the help index.

The help index lists the titles of the help information that is available.


ΓòÉΓòÉΓòÉ 8.1.5.2. General Help ΓòÉΓòÉΓòÉ

Use this choice to get general help for the program. General help provides
general information about the Exercise Diary program.


ΓòÉΓòÉΓòÉ 8.1.5.3. Using Help ΓòÉΓòÉΓòÉ

Use this choice to obtain information on how to use the Help facility.


ΓòÉΓòÉΓòÉ 8.1.5.4. Keys ΓòÉΓòÉΓòÉ

Use this choice to show the shortcut keys.


ΓòÉΓòÉΓòÉ 8.1.5.5. Register Exercise Diary... ΓòÉΓòÉΓòÉ

Use this choice to display the registration dialog.


ΓòÉΓòÉΓòÉ 8.1.5.6. Product Info... ΓòÉΓòÉΓòÉ

Use this choice to display the product information dialog.


ΓòÉΓòÉΓòÉ 8.2. Main window date context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked on "All years", a
year, or a month..  The available menu items are:

o Open Performances
o Summary
o Graph


ΓòÉΓòÉΓòÉ 8.2.1. Open Performances ΓòÉΓòÉΓòÉ

Loads and displays the performances that match the selected date.  If "All
years" is selected all the Performances in the file will be loaded.  This is
equivalent to double- clicking on the date.


ΓòÉΓòÉΓòÉ 8.2.2. Summary ΓòÉΓòÉΓòÉ

Summarizes the performances for the selected date.  The available options are:

o Date
o Route


ΓòÉΓòÉΓòÉ 8.2.2.1. Date ΓòÉΓòÉΓòÉ

Provides the count, total distance and average distance for the performances.

If "All years" was selected, the performances will be summarized by year.  If a
year was selected, the performances will be summarized by month for the
selected year. If a month was selected, the performances will be summarized by
week for the selected month. In this case of the summary by week, the month is
divided into 4 or 5 weeks depending on the date of the month.  So days 1-7 is
week 1, 8-14 is week 2, 15-21 is week 3, 22-28 is week 4, and 29-31 is week 5.

Note:  Filtering is in effect.


ΓòÉΓòÉΓòÉ 8.2.2.2. Route ΓòÉΓòÉΓòÉ

Provides the best, average, worst, and count of the performances for each route
in the Routes file.

Note:  Filtering is in effect.


ΓòÉΓòÉΓòÉ 8.2.3. Graph ΓòÉΓòÉΓòÉ

Graphically summarize the performances of the selected date.  The available
options are:

o Weight
o Heart Rate


ΓòÉΓòÉΓòÉ 8.2.3.1. Weight ΓòÉΓòÉΓòÉ

Graphically displays the weight information from the performances that have a
non-zero entry in the weight field.

Note:  Filtering is in effect.


ΓòÉΓòÉΓòÉ 8.2.3.2. Heart Rate ΓòÉΓòÉΓòÉ

Graphically displays the heart rate information from the performances that have
a non-zero entry in the heart rate field.

Note:  Filtering is in effect.


ΓòÉΓòÉΓòÉ 8.3. Performances context menu ΓòÉΓòÉΓòÉ

This menu appears up when the right mouse button is clicked in the whitespace
of the Performances window.  The available menu items are:

o Sort
o Create
o Summary
o Graph


ΓòÉΓòÉΓòÉ 8.3.1. Sort Menu ΓòÉΓòÉΓòÉ

Choose a sort operation from the menu. The available sorts are:

o Date
o Date Descending
o Route
o Time


ΓòÉΓòÉΓòÉ 8.3.1.1. Date ΓòÉΓòÉΓòÉ

Select this menu item to sort the performances by date in ascending order.


ΓòÉΓòÉΓòÉ 8.3.1.2. Date Descending ΓòÉΓòÉΓòÉ

Select this menu item to sort the performances by date in descending order.


ΓòÉΓòÉΓòÉ 8.3.1.3. Route ΓòÉΓòÉΓòÉ

Select this menu item to sort the performances by route name.


ΓòÉΓòÉΓòÉ 8.3.1.4. Time ΓòÉΓòÉΓòÉ

Select this menu item to sort the performances by time.


ΓòÉΓòÉΓòÉ 8.3.2. Create ΓòÉΓòÉΓòÉ

Choose a create operation from the menu. The available create operations are
Route and Performance.


ΓòÉΓòÉΓòÉ 8.3.2.1. Route... ΓòÉΓòÉΓòÉ

Same action as Route... menu item of Create submenu of main window context
menu.


ΓòÉΓòÉΓòÉ 8.3.2.2. Performance... ΓòÉΓòÉΓòÉ

Same action as Performance... menu item of Create submenu of main window
context menu.


ΓòÉΓòÉΓòÉ 8.3.3. Summary ΓòÉΓòÉΓòÉ

Summarizes the performances in the window.  The available options are:

o Date
o Route


ΓòÉΓòÉΓòÉ 8.3.3.1. Date ΓòÉΓòÉΓòÉ

Same action as Date of Summary submenu of main window date context menu.


ΓòÉΓòÉΓòÉ 8.3.3.2. Route ΓòÉΓòÉΓòÉ

Same action as Route of Summary submenu of main window date context menu.


ΓòÉΓòÉΓòÉ 8.3.4. Graph ΓòÉΓòÉΓòÉ

Graphically summarize the performances in the window.  The available options
are:

o Weight
o Heart Rate


ΓòÉΓòÉΓòÉ 8.3.4.1. Weight ΓòÉΓòÉΓòÉ

Same action as Weight of Graph submenu of main window date context menu.


ΓòÉΓòÉΓòÉ 8.3.4.2. Heart Rate ΓòÉΓòÉΓòÉ

Same action as Heart Rate of Graph submenu of main window date context menu.


ΓòÉΓòÉΓòÉ 8.4. Performance context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked on a performance.  The
available menu item are Create Another, Delete, and Route.


ΓòÉΓòÉΓòÉ 8.4.1. Create Another ΓòÉΓòÉΓòÉ

Select this menu item to create another performance with the same route as the
selected performance.


ΓòÉΓòÉΓòÉ 8.4.2. Delete ΓòÉΓòÉΓòÉ

Select this menu item to delete the selected performance.

Note:  You can also press the Del key to delete the selected performance.


ΓòÉΓòÉΓòÉ 8.4.3. Route ΓòÉΓòÉΓòÉ

Choose an operation for the route of the selected performance. The available
operations are Open... and Graph Times.


ΓòÉΓòÉΓòÉ 8.4.3.1. Open... ΓòÉΓòÉΓòÉ

Same action as Open... menu item of Route context menu.


ΓòÉΓòÉΓòÉ 8.4.3.2. Graph Times ΓòÉΓòÉΓòÉ

Same action as Graph Times menu item of Route context menu.


ΓòÉΓòÉΓòÉ 8.5. Route context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked on a route.  The
available menu items are Open..., Delete, Graph Times, and Create
Performance....


ΓòÉΓòÉΓòÉ 8.5.1. Open... ΓòÉΓòÉΓòÉ

Select this menu item to open a dialog which allows you to modify the route
selected.


ΓòÉΓòÉΓòÉ 8.5.2. Delete ΓòÉΓòÉΓòÉ

Select this menu item to delete the selected route.


ΓòÉΓòÉΓòÉ 8.5.3. Graph Times ΓòÉΓòÉΓòÉ

Select this menu item to graphically display the performances for the selected
route.

Note:  Filtering is in effect.


ΓòÉΓòÉΓòÉ 8.5.4. Create performance... ΓòÉΓòÉΓòÉ

Use this menu item to open a Performance dialog with the route set to the
currently selected route.


ΓòÉΓòÉΓòÉ 8.6. Summary by date context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked in the whitespace of
the Summary by date window.


ΓòÉΓòÉΓòÉ 8.6.1. Graph ΓòÉΓòÉΓòÉ

Creates a line graph for the distances displayed.


ΓòÉΓòÉΓòÉ 8.7. Summary by route context menu ΓòÉΓòÉΓòÉ

This menu appears when the right mouse button is clicked on a route.  The
following options are available: Open... and Graph Times


ΓòÉΓòÉΓòÉ 8.7.1. Open... ΓòÉΓòÉΓòÉ

Same action as Open... menu item of Route context menu.


ΓòÉΓòÉΓòÉ 8.7.2. Graph Times ΓòÉΓòÉΓòÉ

Same action as Graph Times menu item of Route context menu.


ΓòÉΓòÉΓòÉ 9. Version history ΓòÉΓòÉΓòÉ

1.0  Initial version

 1.1

     o Fix: Date fields not visible in dialog if your date format was M/D/Y.
     o Fix: Time not displayed correctly in container if your time format was
       12 hour.