QDiary (Quick Diary) Version 1.0.5 ================================== a free application for the Palm family of hand-held computers. A small program to make quick diaries of sequential values triggered by time/date, based on the Palm's internal memo application. Written by: Jens Albrecht (j.albr@web.de), 07/2000..11/2000 (program and documentation are currently available in English only) CAREFULLY READ THE LICENSE, USAGE CONDITIONS AND GENERAL WARNINGS FOR QDIARY AS PROVIDED IN THIS DOCUMENT BEFORE USING THE PROGRAM ! Ein kleines Programm zur schnellen Erstellung von chronologischen Werteprotokollen, basierend auf dem Palm-internen Merkzettel-Programm (Memo). Geschrieben von: Jens Albrecht (j.albr@web.de), 07/2000.. 11/2000 (Programm und Dokumentation sind zur Zeit nur in Englisch) LESEN SIE DIE LIZENZBEDINGUNGEN, DIE NUTZUNGSBESTIMMUNGEN UND ALLGEMEINEN WARNUNGEN FÜR QDIARY IN DIESEM DOKUMENT SORGFÄLTIG DURCH, BEVOR SIE MIT DEM PROGRAMM ARBEITEN ! Content: ======== - Installation - Purpose - Principles - Usage - Features - License - History - Notes Installation: ============= Simply install the file "qdiary.prc". It is recommended to uninstall a previous version before doing so. If you are updating, it will be necessary to change the first line of all diaries using MemoPad (field labels are now separated by "," and all are braced by "[]"). Check the settings of all diaries for the new field separator option. Purpose: ======== QDiary is a utility that creates and modifies text memos from the Palm's internal memo application in order to establish a quick way to create protocols of values (e.g. diaries, lists, ...). An entry in a protocol always is a single line of text that may include date, time and other user defined fields with values to be entered manually. The advantage is that you only have to enter the values; date and time are filled in automatically and the entry is inserted into the memo either at the top or at the bottom without the need to place the cursor. Because QDiary uses the memo application database, no own database is required and the diaries can easily be modified and exported. A sample diary to store the measurements of temperatur and wind speed can look like this (title "QDiary Test", checked "enumerate", selection "[date] [time]", not checked "bottom up", selection "tabulator"): QDiary Test[Temp,Wind] 1 12.07.00 14:03 15 0 2 12.07.00 15:16 13 3 3 13.07.00 4:00 7 2 ... Principles: =========== A diary always is a single memo within the MemoPad's application database. A line in a diary is terminated by carrige return (if a line is too long to be displayed in MemoPad it is wrapped). A diary stores a title and some other parameters in the first line. The title is limited to 16 characters and may NOT include "[". Only this title is used to refer a memo, therefor it must be unique. "[" in line 1 starts the definition of names for the fields, "]" terminates it. Names for fields may NOT include "," and "]", they are separated by ",". If a name starts with a number, this character will be ignored at the moment. Any character of the first line behind "]" (and all characters after the 16th) are preserved as extra information. Each entry in a diary is a single line below the first line. Diaries can be organised "bottom up" (the last entry is written on top) or "top down" (the last entry is written on bottom). The position and content of the first line is always preserved, the other lines can be overwritten if the size of the diary (memo) becomes TOO large. An entry in a diary usually contains different fields. All fields are separated by a character, usually by a tabulator. The first fields (the prefix) are normally generated automatically according to the settings you have made. They are followed by user fields, up to three can be used in a diary. The content of user fields must be entered into the edit fields of QDiary, is limited to 10 characters (enough for numbers) and may be empty. Usage: ====== - Select a set number in QDiary (numbered buttons at the top) to work with (up to 8 sets are currently supported to manage diaries simultaneously). - Enter a title (limited to 16 characters) that identifies this diary within all memos existing (the title is placed in the first line of the memo together with the definitions of the fields). - Set-up the options for that diary: - include the numbering of the entries in the first column ? -> check "enumerate" - columns to be added in front of the values (time, date, ...) ? -> select a predefined format out of the listbox - direction in which to order the diary (bottom to top or reverse) ? -> check "bottom up" - character(s) to separate fields -> select your choice out of the listbox If your title is unique and no memo currently exists you are asked for the definition of the names for the user fields. (Otherwise press "Edit" to go to MemoPad, delete the memo and return to QDiary again.) - enter the names for the fields starting with field 1 and ending with field 3. Fields without names cannot be used later on (you need to edit the memo to change this later on). - Press "Add" to create a new diary and confirm the notice. - You now see the names of the fields in front of the edit fields and the current prefix according to the settings you have made. You can change the settings at any time. If you want to change the names or the number of the fields do so by changing the first line of the memo in MemoPad. - Enter sample values into the edit fields. - Press "Add" to append this new entry to the diary (the last entry will always be displayed at the bottom). - Continue to add further entries. - Go to MemoPad, e.g. by pressing "Edit", and look for the new memo (do NOT edit the title in the first line, because it is used for identification; otherwise you will need to change the title in QDiary accordingly). You will understand how the diaries look like. - Set the category of the memo as desired (the category is preserved by QDiary). Features: ========= It is possible to select the title directly from an existing memo in the memo database (menu). Memos are identified as diaries if their first line contains a "[". The following internal fields to be inserted at the beginning of each line are currently available: - number of line (the counter is saved in QDiary and reset for each new memo) - date (in the current system format) - time (in the current system format) - date and time - seconds (Palm's internal timer value) - relative time, days and seconds (relative to the time of the first entry) Fields may be separated by either: - a single or double space - a tabulator (preferred) - a comma or - a semicolon Changes will only apply to new entries. The button "Edit" opens the diary in MemoPad. In case CryptoPad (by Maxime Labelle & Jean-Baptiste Labelle) is installed CryptoPad is used for viewing instead of MemoPad (the default memo application). This is the only way to edit or delete a diary or to change the field labels. There is no direct way to return to QDiary later on (use the application launcher). Further settings of QDiary (as the titles and options) are currently saved separately. To reset ALL preferences and internal variables, select the corresponding menu item in QDiary. The counter of ONE diary can be reset by menu option. License: ======== QDiary is freeware, it may be distributed freely, but may not be sold or included in for-profit collections without written permission from the author. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. History: ======== 1.0.0, 30.07.00: first version 1.0.1, 01.08.00: bug fixes (crash if title without CR, memo ID changed so that each hotsync doubled the memo); improvements (button to view the memo directly from QDiary, menu item to reset counter of active diary) 1.0.2, 04.08.00: bug fixes (slow MainFormInit, prefs not saved on view) 1.0.3, 12.08.00: bug fixes (crash on view for non-existing memo); improvements (changed format of 24h-time with fixed length) 1.0.4, 04.11.00: use CryptoPad before MemoPad for viewing (if installed), field lengths increased to 10 characters, new label in display: current prefix string (above field one) 1.0.5, 12.11.00: changed format for title and field labels, listbox to select field separator, checkboxes and buttons renamed, display of the last entry in a diary (not only if just made), setup of field names for new diaries, changed internal preferences, code optimised and other minor changes Notes: ====== Important warnings: - Use QDiary completely at your own risk ! Crashes with data loss may happen (although not yet observed). - QDiary heavily uses the internal memo database. It cannot be guaranteed that this works with all current or future versions of PalmOS in all languages. Tests have only been made with PalmOS 3.1 and 3.3 in German. - The size constraints of the memo application also apply to QDiary. In case the memo becomes too large, the memo is cut at the opposite (!) position to the place where the new line is inserted while preserving the first line of the memo. - You must not set a password on a memo used as diary when using CryptoPad. Encrypted diaries cannot be used by QDiary. Development environment: - PRC-Tools 2.0 / GCC tool chain (http://www.palm.com/devzone/tools/gcc/) - PalmOS SDK 3.5 (http://www.palm.com/devzone/tools/gcc/#sdks) - PalmOS Emulator 3.0a5 (http://www.palm.com/devzone/pose/seed.html) - PilRC version 2.5c (http://www.pilrc.com/) Known problems and bugs: - Application preferences are not yet stored in an own preferences database. - A new memo used for a diary is always placed at the end of the memo list in the memo application (no automatic sorting). - The prefix display is only refreshed when you release the pen somewhere. - The time for refreshing the labels is not optimal. - The buttons for scrolling are not functional at this time. Possible improvements and suggestions: - Problems listed above will be solved. - Scroll existing entries in diaries within QDiary. - The documentation will also be continued and improved in the future. - Translations to other languages than English are currently not planned. - New option to fill fields with spaces to a minimum field length for better tabbing. - New option to disable the warning and question if memo size limit is reached. - Edit fields to allow changes to time and date fields (maybe). - Preferences dialog instead of main dialog settings. - References to memos by id instead of by name. Comments and bug reports are always welcome by email to "j.albr@web.de". Go to "http://www.palmgear.com/software/showsoftware.cfm?prodID=8967" to find the latest version available.