home *** CD-ROM | disk | FTP | other *** search
/ Chip 2001 Mobile / Chip_Mobile_2001.iso / palm / business / qdiary / qdiary.exe / readme.txt < prev    next >
Text File  |  2000-11-10  |  12KB  |  259 lines
  1. QDiary (Quick Diary) Version 1.0.5
  2. ==================================
  3. a free application for the Palm family of hand-held computers.
  4.  
  5. A small program to make quick diaries of sequential values triggered by
  6. time/date, based on the Palm's internal memo application. Written by:
  7. Jens Albrecht (j.albr@web.de), 07/2000..11/2000 (program and
  8. documentation are currently available in English only)
  9.  
  10. CAREFULLY READ THE LICENSE, USAGE CONDITIONS AND GENERAL WARNINGS FOR
  11. QDIARY AS PROVIDED IN THIS DOCUMENT BEFORE USING THE PROGRAM !
  12.  
  13.  
  14.  Ein kleines Programm zur schnellen Erstellung von chronologischen
  15.  Werteprotokollen, basierend auf dem Palm-internen Merkzettel-Programm
  16.  (Memo). Geschrieben von: Jens Albrecht (j.albr@web.de), 07/2000..
  17.  11/2000 (Programm und Dokumentation sind zur Zeit nur in Englisch)
  18.  
  19.  LESEN SIE DIE LIZENZBEDINGUNGEN, DIE NUTZUNGSBESTIMMUNGEN UND
  20.  ALLGEMEINEN WARNUNGEN F▄R QDIARY IN DIESEM DOKUMENT SORGF─LTIG DURCH,
  21.  BEVOR SIE MIT DEM PROGRAMM ARBEITEN ! 
  22.  
  23.  
  24. Content:
  25. ========
  26. - Installation
  27. - Purpose
  28. - Principles
  29. - Usage
  30. - Features
  31. - License
  32. - History
  33. - Notes
  34.  
  35.  
  36. Installation:
  37. =============
  38. Simply install the file "qdiary.prc". It is recommended to uninstall a
  39. previous version before doing so.
  40.  
  41. If you are updating, it will be necessary to change the first line of
  42. all diaries using MemoPad (field labels are now separated by "," and all
  43. are braced by "[]"). Check the settings of all diaries for the new field
  44. separator option.
  45.  
  46.  
  47. Purpose:
  48. ========
  49. QDiary is a utility that creates and modifies text memos from the Palm's
  50. internal memo application in order to establish a quick way to create
  51. protocols of values (e.g. diaries, lists, ...). An entry in a protocol
  52. always is a single line of text that may include date, time and other
  53. user defined fields with values to be entered manually. The advantage is
  54. that you only have to enter the values; date and time are filled in
  55. automatically and the entry is inserted into the memo either at the top
  56. or at the bottom without the need to place the cursor. Because QDiary
  57. uses the memo application database, no own database is required and the
  58. diaries can easily be modified and exported.
  59.  
  60. A sample diary to store the measurements of temperatur and wind speed
  61. can look like this (title "QDiary Test", checked "enumerate", selection
  62. "[date] [time]", not checked "bottom up", selection "tabulator"):
  63.  
  64. QDiary Test[Temp,Wind]
  65. 1    12.07.00    14:03    15    0
  66. 2    12.07.00    15:16    13    3
  67. 3    13.07.00    4:00    7    2
  68. ...
  69.  
  70.  
  71. Principles:
  72. ===========
  73. A diary always is a single memo within the MemoPad's application database.
  74. A line in a diary is terminated by carrige return (if a line is too long
  75. to be displayed in MemoPad it is wrapped). A diary stores a title and some
  76. other parameters in the first line. The title is limited to 16 characters
  77. and may NOT include "[". Only this title is used to refer a memo, therefor
  78. it must be unique. "[" in line 1 starts the definition of names for the
  79. fields, "]" terminates it. Names for fields may NOT include "," and "]",
  80. they are separated by ",". If a name starts with a number, this character
  81. will be ignored at the moment. Any character of the first line behind "]"
  82. (and all characters after the 16th) are preserved as extra information.
  83.  
  84. Each entry in a diary is a single line below the first line. Diaries can
  85. be organised "bottom up" (the last entry is written on top) or "top down"
  86. (the last entry is written on bottom). The position and content of the
  87. first line is always preserved, the other lines can be overwritten if the
  88. size of the diary (memo) becomes TOO large. An entry in a diary usually
  89. contains different fields. All fields are separated by a character,
  90. usually by a tabulator. The first fields (the prefix) are normally
  91. generated automatically according to the settings you have made. They
  92. are followed by user fields, up to three can be used in a diary. The
  93. content of user fields must be entered into the edit fields of QDiary,
  94. is limited to 10 characters (enough for numbers) and may be empty.
  95.  
  96.  
  97. Usage:
  98. ======
  99. - Select a set number in QDiary (numbered buttons at the top) to work with
  100.   (up to 8 sets are currently supported to manage diaries simultaneously).
  101. - Enter a title (limited to 16 characters) that identifies this diary
  102.   within all memos existing (the title is placed in the first line of the
  103.   memo together with the definitions of the fields).
  104. - Set-up the options for that diary:
  105.   - include the numbering of the entries in the first column ?
  106.     -> check "enumerate"
  107.   - columns to be added in front of the values (time, date, ...) ?
  108.     -> select a predefined format out of the listbox
  109.   - direction in which to order the diary (bottom to top or reverse) ?
  110.     -> check "bottom up"
  111.   - character(s) to separate fields
  112.     -> select your choice out of the listbox
  113.   If your title is unique and no memo currently exists you are asked for
  114.   the definition of the names for the user fields. (Otherwise press
  115.   "Edit" to go to MemoPad, delete the memo and return to QDiary again.)
  116.   - enter the names for the fields starting with field 1 and ending with
  117.     field 3. Fields without names cannot be used later on (you need to
  118.     edit the memo to change this later on).
  119. - Press "Add" to create a new diary and confirm the notice.
  120. - You now see the names of the fields in front of the edit fields and the
  121.   current prefix according to the settings you have made. You can change
  122.   the settings at any time. If you want to change the names or the number
  123.   of the fields do so by changing the first line of the memo in MemoPad.
  124. - Enter sample values into the edit fields.
  125. - Press "Add" to append this new entry to the diary (the last entry will
  126.   always be displayed at the bottom).
  127. - Continue to add further entries.
  128. - Go to MemoPad, e.g. by pressing "Edit", and look for the new memo (do
  129.   NOT edit the title in the first line, because it is used for
  130.   identification; otherwise you will need to change the title in QDiary
  131.   accordingly). You will understand how the diaries look like.
  132. - Set the category of the memo as desired (the category is preserved by
  133.   QDiary).
  134.  
  135.  
  136. Features:
  137. =========
  138. It is possible to select the title directly from an existing memo in the
  139. memo database (menu). Memos are identified as diaries if their first line
  140. contains a "[".
  141.  
  142. The following internal fields to be inserted at the beginning of each line
  143. are currently available:
  144. - number of line (the counter is saved in QDiary and reset for each new
  145.   memo)
  146. - date (in the current system format)
  147. - time (in the current system format)
  148. - date and time
  149. - seconds (Palm's internal timer value)
  150. - relative time, days and seconds (relative to the time of the first
  151.   entry)
  152.  
  153. Fields may be separated by either:
  154. - a single or double space
  155. - a tabulator (preferred)
  156. - a comma or
  157. - a semicolon
  158. Changes will only apply to new entries.
  159.  
  160. The button "Edit" opens the diary in MemoPad. In case CryptoPad (by
  161. Maxime Labelle & Jean-Baptiste Labelle) is installed CryptoPad is used for
  162. viewing instead of MemoPad (the default memo application). This is the
  163. only way to edit or delete a diary or to change the field labels. There is
  164. no direct way to return to QDiary later on (use the application launcher).
  165.  
  166. Further settings of QDiary (as the titles and options) are currently saved
  167. separately. To reset ALL preferences and internal variables, select the
  168. corresponding menu item in QDiary. The counter of ONE diary can be reset
  169. by menu option.
  170.  
  171.  
  172. License:
  173. ========
  174. QDiary is freeware, it may be distributed freely, but may not be sold or
  175. included in for-profit collections without written permission from the
  176. author.
  177.  
  178. This program is distributed in the hope that it will be useful, but
  179. WITHOUT ANY WARRANTY; without even the implied warranty of
  180. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  181.  
  182. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
  183. THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
  184. OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
  185. PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  186. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  187. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
  188. ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
  189. YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
  190. NECESSARY SERVICING, REPAIR OR CORRECTION.
  191.  
  192.  
  193. History:
  194. ========
  195. 1.0.0, 30.07.00: first version
  196. 1.0.1, 01.08.00: bug fixes (crash if title without CR, memo ID changed so
  197.   that each hotsync doubled the memo);
  198.   improvements (button to view the memo directly from QDiary, menu item to
  199.   reset counter of active diary)
  200. 1.0.2, 04.08.00: bug fixes (slow MainFormInit, prefs not saved on view)
  201. 1.0.3, 12.08.00: bug fixes (crash on view for non-existing memo);
  202.   improvements (changed format of 24h-time with fixed length)
  203. 1.0.4, 04.11.00: use CryptoPad before MemoPad for viewing (if installed),
  204.   field lengths increased to 10 characters, new label in display: current
  205.   prefix string (above field one)
  206. 1.0.5, 12.11.00: changed format for title and field labels, listbox to
  207.   select field separator, checkboxes and buttons renamed, display of the
  208.   last entry in a diary (not only if just made), setup of field names for
  209.   new diaries, changed internal preferences, code optimised and other
  210.   minor changes
  211.  
  212.  
  213. Notes:
  214. ======
  215. Important warnings:
  216. - Use QDiary completely at your own risk ! Crashes with data loss may
  217.   happen (although not yet observed).
  218. - QDiary heavily uses the internal memo database. It cannot be guaranteed
  219.   that this works with all current or future versions of PalmOS in all
  220.   languages. Tests have only been made with PalmOS 3.1 and 3.3 in German.
  221. - The size constraints of the memo application also apply to QDiary. In
  222.   case the memo becomes too large, the memo is cut at the opposite (!)
  223.   position to the place where the new line is inserted while preserving
  224.   the first line of the memo.
  225. - You must not set a password on a memo used as diary when using
  226.   CryptoPad. Encrypted diaries cannot be used by QDiary.
  227.  
  228. Development environment:
  229. - PRC-Tools 2.0 / GCC tool chain (http://www.palm.com/devzone/tools/gcc/)
  230. - PalmOS SDK 3.5 (http://www.palm.com/devzone/tools/gcc/#sdks)
  231. - PalmOS Emulator 3.0a5 (http://www.palm.com/devzone/pose/seed.html)
  232. - PilRC version 2.5c (http://www.pilrc.com/)
  233.  
  234. Known problems and bugs:
  235. - Application preferences are not yet stored in an own preferences
  236.   database.
  237. - A new memo used for a diary is always placed at the end of the memo list
  238.   in the memo application (no automatic sorting).
  239. - The prefix display is only refreshed when you release the pen somewhere.
  240. - The time for refreshing the labels is not optimal.
  241. - The buttons for scrolling are not functional at this time.
  242.  
  243. Possible improvements and suggestions:
  244. - Problems listed above will be solved.
  245. - Scroll existing entries in diaries within QDiary.
  246. - The documentation will also be continued and improved in the future.
  247. - Translations to other languages than English are currently not planned.
  248. - New option to fill fields with spaces to a minimum field length for
  249.   better tabbing.
  250. - New option to disable the warning and question if memo size limit is
  251.   reached.
  252. - Edit fields to allow changes to time and date fields (maybe).
  253. - Preferences dialog instead of main dialog settings.
  254. - References to memos by id instead of by name.
  255.  
  256. Comments and bug reports are always welcome by email to "j.albr@web.de".
  257. Go to "http://www.palmgear.com/software/showsoftware.cfm?prodID=8967"
  258. to find the latest version available.
  259.