home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / 1997 / 940 / AGNDUMP.TXT < prev   
Encoding:
Text File  |  1997-03-03  |  11.8 KB  |  347 lines
  1. Agenda Dump v1.05 1997-Mar-03
  2. =============================
  3.  
  4. AgnDump is an OPL utility for the Psion Series 3a
  5. computer to extract data from S3a Agenda files.
  6.  
  7. Status
  8. ------
  9. This software is freely-distributable.
  10.  
  11. If you have any comments or feedback, please send
  12. them to me, Simon Pooley, by emailing
  13. spooley@cix.compulink.co.uk
  14. or see http://www.cix.co.uk/~ropewalk/psion
  15.  
  16. Introduction
  17. ------------
  18. Version 1.05 replaces 1.04 that was distributed in
  19. October 1997.  It fixes many bugs, addresses a few
  20. deficiencies and adds the following new features:
  21.  - Output via the Psion Printing system, supporting
  22.    print preview and output via PsiWin or even via
  23.    the Psion's fax modem!
  24.  - Use of proportional fonts for the screen output
  25.    makes the program look neater.
  26.  - Output to Psion Data databases and MC400 diary
  27.    options.
  28.  
  29. AgnDump is an OPL utility for the Psion Series 3a
  30. computer to extract data from S3a Agenda files.
  31.  
  32. Agenda entries are extracted as text in a form 
  33. suitable for post-processing.  The output may be
  34. sent to one of:
  35.     Screen    for checking
  36.     File    for post-processing by another program
  37.     Printer    (Psion parallel adaptor required)
  38.     Serial    serial printer or other device
  39.     Database for further manipulation
  40.     MC400 Diary file, if there's anyone out there
  41.         still using Psions old laptop!
  42.  
  43. Installation
  44. ------------
  45. Copy AGNDUMP.OPA to the \APP\ directory on any
  46. Psion drive.
  47. If you want the on-line help, copy AGNDUMP.RSC
  48. to the \APP\AGNDUMP\ directory on any Psion
  49. drive.
  50. Install AGNDUMP using Psion-I on the system screen.
  51.  
  52. If you are upgrading from a previous version, I'm afraid
  53. that the format of the parameter data files listed under
  54. the Agenda Dump icon has changed, so you'll have to
  55. delete and re-create them from the new version.
  56.  
  57. ************************************************
  58. Make sure you have a backup of your Agenda files
  59. before running this program!
  60. Although AgnDump is careful to open Agenda files
  61. read-only there is always the possibility that I
  62. have made a programming error that could destroy
  63. your data!
  64. ************************************************
  65.  
  66. Operation
  67. ---------
  68. The files listed under the AGNDUMP icon hold
  69. default values for the various parameters that can
  70. be changed in the application to produce customised
  71. reports.
  72. When first installed, there will be no pre-set
  73. reports and the Psion system screen will display a
  74. single dummy entry under the icon called `Agndump'.
  75. Launch AGNDUMP the first time by either pressing
  76. <Enter> on the Agndump label under the icon, or
  77. press <Psion>-N on the icon to create a new report
  78. parameter file with your choice of name.
  79. When AGNDUMP starts it displays the settings from
  80. the current data file (or the default settings if
  81. the data file has just been created).
  82. Use the <Menu> key or the hot keys shown after the
  83. labels on the screen to customise the reporting
  84. options:
  85.  
  86. Source        Select the name of the Agenda file 
  87.         containing entries to be reported.
  88.  
  89. Dates        Specify the period for the report.
  90.         Various common ranges may be selected
  91.         or you can choose "Other date
  92.         range..." to specify the actual
  93.         start and end dates explicitly.
  94.  
  95. Day filter    Allows the report to be restricted
  96.         to only some days of the week.
  97.         Choose "Change..." if none of the
  98.         other choices are what you want.
  99.  
  100. Record types    Allows choice over what types of
  101.         Agenda entry will be included in
  102.         the report.
  103.         In addition, you can specify that
  104.         ONLY entries with an Alarm, a Memo
  105.         or matching some particular text
  106.         will be reported.
  107.  
  108. Text filter    Allows the report to be restricted
  109. & Year symbol    to entries containing matching text
  110.         and/or one of several year symbol
  111.         characters.
  112.  
  113. Report to    Choose Screen, File... Serial or
  114.         Parallel Printer.  If you choose
  115.         File... you will be prompted for
  116.         the filename later.
  117.         If Serial is chosen, the serial
  118.         port parameters as setup using
  119.         Psion-Y on the System screen are
  120.         used.
  121.  
  122.         Psion printing will use the Psion's
  123.         built-in printing system to provide
  124.         print preview and the ability to
  125.         print via PsiWin, any supported
  126.         printers or even the 3-fax software,
  127.         if you have it!
  128.         See the on-line help for more details
  129.         on this option.
  130.  
  131.         Database... can be used to create
  132.         a Psion database file.  The first
  133.         record written to the database
  134.         contains the field lables, subsequent
  135.         records are produced for each output
  136.         item.
  137.  
  138.         MC diary... creates a diary file for
  139.         use on Psion's older MC200 and MC400
  140.         laptop computers.
  141.  
  142. Repeats        Determines how repeated entries are
  143.         handled.
  144.         Show next only - displays each
  145.         repeated item no more than once in
  146.         the report.
  147.         As normal - displays each repeated
  148.         item as determined by the similar
  149.         setting in the Agenda application.
  150.         Not shown - suppresses all repeated
  151.         items from the report.
  152.  
  153. Date format    Allows a choice for the way the
  154.         date at the start of each output
  155.         record is displayed.
  156.         
  157. Memo        Either "Shown" or "Not shown", depending
  158.         on whether you are interested in viewing
  159.         the text of Memos attached to Agenda
  160.         entries.
  161.         If "Shown" is selected, you can enter
  162.         the column at which the text is
  163.         word-wrapped.
  164.  
  165. Time format    Specifies how time is displayed on the
  166.         output report.
  167.  
  168. Having modified these settings, you can use the
  169. standard Psion menu options New, Open and Save to
  170. store the settings in files that will be listed
  171. under AGNDUMP's icon.
  172.  
  173. To produce a report, select Produce from the Report
  174. menu, <Psion>-P.
  175. The specified source agenda file will be opened and
  176. records matching the selected criteria will be
  177. included in the report.
  178. Note that you do not need to close Agenda before
  179. running Agndump on the same Agenda data file...if
  180. Agndump gets a "File busy" error when it tries to
  181. open the data file it tries to shut down any
  182. Agenda process that may be running and retries the
  183. open.  Agenda will be restarted with the same file
  184. when Agndump finishes its report (but note that
  185. the Agenda file will be re-opened in the default
  186. day-view).
  187. As the Agenda file is processed, progress is
  188. displayed as a percentage in the bottom-right of
  189. the screen.
  190.  
  191. Report Format
  192. -------------
  193. The first two lines of the output report contain
  194. comments (prefixed with a # character) describing
  195. the contents of the report.
  196. Subsequent report lines contain one row of text for
  197. each reported entry.
  198.  
  199. 16/01/1995 [b]hh:mm Entry text (duration)(anniv dtls)[ALARM...][MEMO]
  200. 1-------->23->4---->5-------->6--------->7---------->8-------->9---->
  201.  
  202. (* indicates optional fields)
  203. 1    date in the format specified in the report
  204.     parameters, or the text "UNDATED", or the
  205.     text "TODO"
  206. 2    space character
  207. 3*    day entry symbol (if any) in square brackets
  208. 4*    time of the entry as hh:mm (24-hour format) or
  209.     hh:mm followed by "am" or "pm".  This field is
  210.     only produced for timed entries.
  211. 5    text of the agenda entry
  212. 6    duration (if non-zero) for a timed entry
  213. 7    anniversary details, i.e. start year, no.
  214.     of years or both (as determined by the
  215.     entry settings in Agenda)
  216. 8    alarm data in square brackets - entries
  217.     with an alarm only
  218.     - the text "ALARM"
  219.     - the name of the alarm sound, or the
  220.       selected .WVE file
  221.     - the time when the alarm will sound, and a
  222.       number of days if the alarm is set to go
  223.       off on a different day to the event, e.g.
  224.       "at 10:00" or "at 21:30 2 days before"
  225. 9    the text "MEMO" in square brackets - entries
  226.     with a memo only.
  227.     If the memo is password-protected this field is
  228.     shown as [MEMO-PW]
  229.  
  230. If the entry has a memo, the memo report option is set
  231. to "Shown", and the memo is not password-protected, then
  232. the text of the memo entry is displayed on subsequent
  233. lines of the report.  Each line of memo data is
  234. preceeded with a | character, CHR$(124).  Formatting of
  235. the memo is not reproduced, instead the memo text is
  236. word-wrapped at the column specified on the report setup
  237. dialog.
  238.  
  239. Limitations
  240. -----------
  241. 1. The list of excluded dates from repeated entries
  242.    is ignored.
  243. 2. The text style of an entry is ignored.
  244. 3. Known bug: monthly by date events with a From
  245.    date that is not one of the the "Dates in
  246.    month..." are repeated incorrectly.
  247. 4. The text of memo entries is not available in the
  248.    database output option.
  249.  
  250. History
  251. -------
  252.  
  253. v0.0 16jan1996
  254. - first version
  255.  
  256. v0.1 18jan1996
  257. - Serial printing (9600 8n1 only)
  258. - Remember report destination and source agenda file
  259. - Display 2 digits for the mins part of hh:mm when mm < 10
  260. - "Pete's Mum" bug fixed.  (alarms on repeating events)
  261. - Check for End& before Start& in "Other date range"
  262. - Filter by days of the week
  263.  
  264. v0.2 28jan1996
  265. - Show WeekDays used in filter on report title
  266. - Always display 2 digits for months & days in all date formats
  267. - Option to o/p dates as no. of days
  268. - Type 3 APP, store report params in data files
  269. - Screen shows report settings...in fact, AgnDump now has a u/i!
  270. - Validate that i/p file really is an S3a agenda file
  271.  
  272. v0.3 4feb1996
  273. - Correct the bug that made never-ending repeats only display once
  274. - ESC now interrupts repeat loop processing, too
  275. - "More" on screen o/p: select o/p to "Screen (paged)"
  276. - filter by year symbol (incl. slightly changed text filter).
  277.   N.B. parameter database file format changed.  This situation
  278.   is trapped, but aborts the program.  Sorry!
  279. - Minor changes to some hot keys and dialog layouts
  280.  
  281. v0.4 28apr1996
  282. - Few minor updates to documentation and bundling for limited
  283.   distribution on the cix conferencing system.
  284.  
  285. v1.0 20jun1996
  286. - Added help file AGNDUMP.RSC and changed screen title to
  287.   reflect formal release status.
  288.  
  289. V1.00 jun1996
  290. - Serial printer parameters fetched from environment
  291. - Save as... implemented, and file handling re-worked
  292. - Correct bug preventing display of undated ToDo entries
  293. - Change o/p format: date time symbol text etc
  294. - Correctly suppress time display for untimed and anniversaries
  295. - Don't use UADD on long integers! - We can now handle >32K !!
  296. - bug: monthly by date events with a From date that is not one of
  297.   the "Dates in month..."  repeats incorrectly
  298. - Known limitation: Agenda places entries that would repeat on, e.g.
  299.   the 31st on the last day of shorter months.  We dont.
  300.  
  301. V1.01 10oct1996
  302. - Investigate memo data (prelim: only works if no alarm on entry!)
  303. - Memo data now dumped unconditionally if selected record has one.
  304.   Format "MEMO text, truncated at 78 chars" under entry.
  305.  
  306. V1.02 12oct1996
  307. - Search for text in memo text data, too.
  308. - Change data file format to store params re memo text
  309. - Add memo-related options
  310. - Handle memos on entries wirh alarms, too
  311. - Split source into AGNDUMP & AGNDUMP2: it's grown > 40Kb
  312. - Word-wrap memo output
  313. - SetPName to change process name
  314. - Blimey!  TODOs can have alarms and memos, too.
  315.  
  316. V1.03 15oct1996
  317. - Use GenGetAmPmText propperly, and parametrise TimeFmt%
  318. - ESC interrupts whilst memo being o/p
  319. - Discover that password-protected memos have a
  320.   different format which I cannot handle.  Plea on cix
  321.   leads to formal description of the format of memos
  322.   (what a great place, cix is!).  Now we can support
  323.   memos with confidence!
  324.  
  325. V1.04 20oct1996
  326. - Correct a silly bug in V1.03 that made most memo/text
  327.   searches produce an "ERROR - Cannot interpret memo data"
  328.  
  329. V1.05 03mar1997
  330. - Support for Psion printing
  331. - Use proportional font (abd itallic memos) for nicer-looking
  332.   screen output
  333. - Report the number of records output in addition to the
  334.   percentage of the Agenda scanned as the report is being
  335.   produced.
  336. - Option to output to MC400-style diary files
  337. - Option to output to Psion 'data' text databases
  338. - Fix bug: "Exit, lose changes" menu option ignored
  339. - Fix bug affecting non-repeating entries following a
  340.   monthly-by-date repeating entry
  341. - Fix bug on alarms set more than 22(ish) days before their
  342.   event
  343. - Enhance database output with more fields to aid import
  344.   into MS Schedule+ and Outlook.
  345.  
  346. ---end---
  347.