home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 2 / RISC_DISC_2.iso / pd_share / comms / hamradio / dire / Docs / DireManual < prev    next >
Encoding:
Text File  |  1994-08-29  |  16.7 KB  |  416 lines

  1.                    +--------------------------------------+
  2.                    :                                      :
  3.                    :                !Dire                 :
  4.                    :         Directory Enquiries          :
  5.                    :                                      :
  6.                    :     Version 1.07 (29th Aug 1994)     :
  7.                    : (c) Tony Howat & 20-20 Software 1994 :
  8.                    :               Freeware               :
  9.                    :                                      :
  10.                    +--------------------------------------+
  11.  
  12. Dire : your one-stop window to UK Callsigns
  13.      - sophisticated
  14.      - stylish
  15.      - easy-to-use
  16.      - speedy
  17. .....all you need for using hi-tech search criteria.
  18.  
  19. ------------+
  20. What is it? :
  21. ------------+
  22.  
  23. Dire is basically the radio-hams' equivalent of an address book, but
  24. instead of phone numbers there are call signs. The advantage Dire has
  25. over the paper version is that it can search through the entire callbook
  26. for wildcards in a few seconds (42 to be precise - from a 25Mhz A5000
  27. with the data on a 250mb Conner drive). That's it really.
  28.  
  29. ------------------+
  30. Conditions of use :
  31. ------------------+
  32.  
  33. The data and software may be distributed freely as long as all files remain
  34. intact and unmodified.
  35.  
  36. I take no responsibility for the accuracy of the data or anyone [ab]using
  37. it. 
  38.  
  39. Don't bother me with any legal gubbins if you have a problem with my
  40. software or anything like that. Go flame someone else.
  41.  
  42. I better point out, before we go any further, that the data supplied
  43. is from the 1993 callbook, so it's not totally up-to-date.
  44.  
  45. Now, on with the manual...
  46.  
  47. --------------------------+
  48. Installing and Setting up :
  49. --------------------------+
  50.  
  51. Dire is supplied on five disks (called Callbook1 through 5), and can be
  52. run from either floppies or hard disk (requires 3.5MB - this may sound
  53. huge, but remember the PC version took 7 MEGS!).
  54.  
  55. Below we tell you how to use the sophisticated facilities of Dire,
  56. whether operation is from Hard or Floppy disc.
  57.  
  58.  
  59. Floppy disk use
  60.  
  61. o Insert disk Callbook1, bring up the filer window and click on !Dire.
  62.   Dire will then install on the icon bar
  63. o Click on Dire on the icon bar and proceed as below for operation
  64. o You will be prompted to enter the correct disk for Dire's operation
  65.  
  66.  
  67. Hard disk installation
  68.  
  69. o Insert disk Callbook1, bring up the filer window and click on !INSTALL.
  70.   INSTALL will appear on the icon bar.
  71. o Clicking the MENU mouse button over the icon will give INFO or QUIT
  72.   options
  73. o Clicking the SELECT mouse button on the INSTALL icon gives a directory
  74.   icon - drag this where you'd like to install Dire. You can rename the
  75.   directory icon if you wish
  76. o At various stages during the installation you'll be asked to insert
  77.   disks Callbook2 through to 5, and then 1 again
  78. o After installation is complete reboot the machine using CTRL-BREAK
  79.  
  80.  
  81. -----------+
  82. Using Dire :
  83. -----------+
  84. Double click on !Dire, from the filer window where you installed it, to
  85. put Dire on the icon bar.
  86.  
  87. Clicking the MENU mouse button on the Dire icon shows the menu....
  88.  
  89.   - INFO        gives version number and author details
  90.   - DATA INFO   gives the version of the UK Callbook used
  91.   - USER DATA   allows addition of new records, or deletion....
  92.             ....ADD RECORD allows typing in a new record's name, address,
  93.                            postcode and callsign. Clicking on ADD or
  94.                            pressing <CR> after 'Callsign' saves the record
  95.   - QUIT        clears Dire
  96.  
  97.  
  98. Searches
  99. ~~~~~~~~
  100. Clicking the SELECT mouse button on the Dire icon shows a box for a search.
  101. Into the box can be entered any or all of the name, address, postcode, or
  102. callsign for the data search. If data is entered into more than one search
  103. field there are two options available....
  104.  
  105.   - ALL MATCHES means Dire will only show entries where every data field
  106.                 matches
  107.   - ANY MATCHES means Dire will show all entries that match any data field
  108.  
  109. To enter data click on the required field and type the text. To move to
  110. another data field use <CR> or click SELECT on the required data field.
  111. Clicking on SEARCH with SELECT, or pressing <CR> after CALL, starts the
  112. search.
  113.  
  114. When the data file has been scanned, and if matching entries have been
  115. found, then the FOUND MATCHES box will pop up. Use the tape recorder
  116. buttons to move through the found records either individually, at a pace,
  117. or from end to end.
  118.  
  119. >From the FOUND MATCHES box the records can be saved four ways....
  120.  
  121.   - IMPRESSION DDF saves a file suitable for dropping straight into an
  122.                    IMPRESSION document and includes sympathetic styling
  123.  
  124.   - COMMA-SEPERATED DATA, where each line of data is seperated by a comma.
  125.                           This is a standard format used on virtually all
  126.                           platforms for databases, spreadsheets etc.
  127.  
  128.   - FORMATTED TEXT gives a file with details of the matches searched for, 
  129.                    along with the number of matches found, and the matches
  130.                    themselves, each line of data being seperated by a
  131.                    line feed. This option is designed specifically for use
  132.                    with Impression's mailmerger.
  133.   
  134.   - RETURN-SEPERATED DATA gives each match found, with each line seperated
  135.                           by a carriage return/line feed.
  136.  
  137. Dire does its best to correctly format the text - unfortunately the
  138. punctuation inside the data was inconsistent (when it existed). In CSD, 
  139. DDF and RSD formats the data is spread over a constant number of fields
  140. to make using results with a database easier.
  141.  
  142. Click on the radio icon of the format you require, then click on SAVE. A
  143. file icon will pop up - drag this to the filer window where you'd like the
  144. data saved.
  145.  
  146. -------------------------------+
  147. Extra notes for Impression DDF :
  148. -------------------------------+
  149.  
  150. If you want to change the styles used by Dire when saving to a DDF file
  151. modify Resources.DDFHeader in the Resources directory.
  152.  
  153. ------------------------+
  154. Notes to accompany Dire :
  155. ------------------------+
  156. 1) Dire will not run if your scrap directory is set to Memphis. Use the
  157.    new version in the extras directory on disc 1.
  158. 2) For some unknown reason Dire produces bad results under certain
  159.    configurations. If you have trouble with Dire please contact me
  160.    and I'll do my best to help.
  161. 3) The logic in this program for stepping back with the viewer is
  162.    errr... complex. It really needs rewriting, but as it is it
  163.    seems to work OK.
  164. 4) There is a known bug when running this program on older machines
  165.    (pre-A5000). When saving lists of addresses the program seems
  166.    to go in a loop, cutting a character off from each field for
  167.    each iteration. As I use an A5000 I can't emulate this problem
  168.    and so it is proving difficult to detect the bug.
  169.  
  170. ---------+
  171. The data :
  172. ---------+
  173.  
  174. The data was converted from a direct access file used by a manky QBASIC
  175. program on a PC using !CallConv in the extras directory. I believe it
  176. originally came from the World callbook CD - any further info would
  177. be welcome! For details on how to use Callconv see its !Help file.
  178.  
  179. If anyone has 1994 callbook data conversion to !Dire's format should be
  180. fairly straightforward for most competent programmers.
  181.  
  182. -------+
  183. Trivia :
  184. -------+
  185.  
  186. The manual for Dire was edited using StrongEd V3.02 (From Stallion Software) which is really rather good! :-)  Odd bits of code and text were done on a Z88 using Pipedream and Z-Link II (which is wonderful in its own special kind of moving-files-between-machines-type way) to shift the data to the Arc. The program was compiled using Acorn Desktop C V4 and
  187. Express Assembler.
  188.  
  189. --------+
  190. Sources :
  191. --------+
  192.  
  193. Well, parts of them are pretty embarassing, but if you grovel enough I'll
  194. probably send them to you.
  195.  
  196. --------+
  197. Credits :
  198. --------+
  199. Written by Tony Howat, G7LZB.
  200. Tested by Dave Norris, G4TUP.
  201. With thanks to Ben Summers, G0SOQ and all those who have helped by reporting
  202. bugs etc.
  203.  
  204. -------+
  205. Advert :
  206. -------+
  207. ____________________________________________________________________________
  208.  
  209.       ######        ##      ##         ##            ######## ########
  210.           ##        ##                 ##               ##       ##
  211.          ##         ##     ###  #####  ##  ##           ##       ##
  212.         ##   ###### ##      ##  ##  ## ## ##            ##       ##
  213.        ##           ##      ##  ##  ## ####             ##       ##
  214.       ##            ##      ##  ##  ## ## ##            ##       ##
  215.       ######        ###### #### ##  ## ##  ##        ######## ########
  216.  
  217. T h e   l a s t   w o r d   i n    s e r i a l   s o p h i s t i c a t i o n
  218. ____________________________________________________________________________
  219.  
  220. Z-Link II integrates the Cambridge Computers Z88 into the world of
  221. RISC OS. Files can be quickly and easily transferred to and from the Z88 
  222. using the RISC OS desktop - without having to pay out for any expensive 
  223. EPROMs for the Z88. Other features include automatic text file conversion, 
  224. Pipedream file-type recognition, efficient memory usage, status window and 
  225. full printed manual. It's the only option.
  226.  
  227. Z-Link II is £24.95 from The Really Good Software Company. A suitable Z88
  228. to Acorn cable can be supplied for £9. Contact The Really Good Software
  229. Company, 39 Carisbrooke Road, Harpenden, Herts AL5 5QS. Tel/Fax 0582 761395
  230. ____________________________________________________________________________
  231.  
  232.  
  233. -----------------------------+
  234. APPENDIX I - Version History :
  235. -----------------------------+
  236.  
  237. 0.00  940228 Initial non-wimp version. Limited Distribution
  238. 1.00  940406 First complete wimp version. Limited Distribution.
  239. 1.01  940409 Various bugs ironed out. Complete version.
  240. 1.01b 940410 A few extras put onto the disc
  241. 1.01c 940411 Ditto
  242. 1.04  940423 Impression DDF header now read from file, allows you to
  243.              change the styles and also reduces !Runimage size (by
  244.              2k)
  245. 1.05  940508 Dire$Running now set when program *really* starts - so
  246.              no problems are caused in wimpslot command fails.
  247. 1.06  940509 Various viewer inconsistencies fixed. Jumping to the
  248.              end of the results is now slower - but it does keep
  249.              count! The window update is now more efficient - you won't
  250.              get records flashing up in the window as you fast forward
  251.              etc.
  252. 1.07  940829 Dire now checks to see if it is running all ready using
  253.              wimp messaging - much nicer.
  254.              Escape key now works during searches - press and hold until
  255.              it lets you out - checks are rather infrequent to keep search
  256.              speed.
  257.              !Killbook obey file now run by program rather than statement
  258.              in !Run file - means !Run isn't left open.
  259.              
  260. -------------------------------------------+
  261. APPENDIX II - The file format (gurus only) :
  262. -------------------------------------------+
  263.  
  264. File format for the Ham Callbook Database 
  265. by Tony Howat 1994                       
  266.                                          
  267. Version 1 Revision 0                     
  268.  
  269. The original PC format 
  270. ~~~~~~~~~~~~~~~~~~~~~~
  271.  
  272. DATA.<l>  -- Where <l> is the last letter of the call
  273.  
  274.         6 bytes per call, padded with spaces 
  275.  
  276. CALL.<l>
  277.         
  278.         Name (19 bytes)
  279.         Address (66 bytes)
  280.         Postcode (9 bytes)
  281.  
  282. New Archimedes format
  283. ~~~~~~~~~~~~~~~~~~~~~
  284.  
  285. Files a-z and user reside in <CallBookData$Dir>.data. or
  286. <CallBookData$Path>. Where a-z is the last letter of the
  287. call.
  288.  
  289. byte 0 : ASCII 'C'
  290. byte 1 : ASCII 'B'
  291. byte 2 : ASCII 'L'
  292. byte 3 : ASCII 'Z'
  293. byte 4 : ASCII 'B'
  294. byte 5 : Version number of file format (ie higher numbers
  295.          are incompatible with previous versions and vice
  296.          versa.
  297. byte 6 : Revision number of file format
  298. .
  299. .
  300. .
  301.  
  302. Start of data denoted by character 255
  303.  
  304. For each record :
  305.  
  306. Callsign...     Prefix (1 byte OR see note)
  307.                 From the following table :
  308.  
  309. /* Prefix coding table - Numbered sequentially */
  310.  
  311. static const char *prefix_coding_table[255] = {
  312.     "G0",  "G1",  "G2",  "G3",  "G4",  "G5",  "G6",  "G7",  "G8",  "G9",  /* 10 */
  313.     "GM0", "GM1", "GM2", "GM3", "GM4", "GM5", "GM6", "GM7", "GM8", "GM9", /* 20 */
  314.     "GI0", "GI1", "GI2", "GI3", "GI4", "GI5", "GI6", "GI7", "GI8", "GI9", /* 30 */
  315.     "GD0", "GD1", "GD2", "GD3", "GD4", "GD5", "GD6", "GD7", "GD8", "GD9", /* 40 */
  316.     "GU0", "GU1", "GU2", "GU3", "GU4", "GU5", "GU6", "GU7", "GU8", "GU9", /* 50 */
  317.     "EI0", "EI1", "EI2", "EI3", "EI4", "EI5", "EI6", "EI7", "EI8", "EI9", /* 60 */
  318.     "2E0", "2E1", "2E2", "2E3", "2E4", "2E5", "2E6", "2E7", "2E8", "2E9", /* 70 */
  319.     "2M0", "2M1", "2M2", "2M3", "2M4", "2M5", "2M6", "2M7", "2M8", "2M9", /* 80 */
  320.     "2W0", "2W1", "2W2", "2W3", "2W4", "2W5", "2W6", "2W7", "2W8", "2W9", /* 90 */
  321.     "2I0", "2I1", "GJ0", "GJ1", "GJ2", "GJ3", "GJ4", "GJ5", "GJ6", "GJ7", /* 100 */
  322.     "GX0", "GX1", "GX2", "GX3", "GX4", "GX5", "GX6", "GX7", "GX8", "GX9", /* 110 */
  323.     "GW0", "GW1", "GW2", "GW3", "GW4", "GW5", "GW6", "GW7", "GW8", "GW9", /* 120 */
  324.     "DA0", "DA1", "DA2", "DA3", "DA4", "DA5", "DA6", "DA7", "DA8", "DA9", /* 130 */
  325.     "DB0", "DB1", "DB2", "DB3", "DB4", "DB5", "DB6", "DB7", "DB8", "DB9", /* 140 */
  326.     "DC0", "DC1", "DC2", "DC3", "DC4", "DC5", "DC6", "DC7", "DC8", "DC9", /* 150 */
  327.     "DD0", "DD1", "DD2", "DD3", "DD4", "DD5", "DD6", "DD7", "DD8", "DD9", /* 160 */
  328.     "DE0", "DE1", "DE2", "DE3", "DE4", "DE5", "DE6", "DE7", "DE8", "DE9", /* 170 */
  329.     "DF0", "DF1", "DF2", "DF3", "DF4", "DF5", "DF6", "DF7", "DF8", "DF9", /* 180 */
  330.     "DG0", "DG1", "DG2", "DG3", "DG4", "DG5", "DG6", "DG7", "DG8", "DG9", /* 190 */
  331.     "DH0", "DH1", "DH2", "DH3", "DH4", "DH5", "DH6", "DH7", "DH8", "DH9", /* 200 */
  332.     "DI0", "DI1", "DI2", "DI3", "DI4", "DI5", "DI6", "DI7", "DI8", "DI9", /* 210 */
  333.     "DJ0", "DJ1", "DJ2", "DJ3", "DJ4", "DJ5", "DJ6", "DJ7", "DJ8", "DJ9", /* 220 */
  334.     "DK0", "DK1", "DK2", "DK3", "DK4", "DK5", "DK6", "DK7", "DK8", "DK9", /* 230 */
  335.     "DL0", "DL1", "DL2", "DL3", "DL4", "DL5", "DL6", "DL7", "DL8", "DL9", /* 240 */
  336.     "PA0", "PA1", "PA2", "PA3", "PA4", "PA5", "PA6", "PA7", "PA8", "PA9", /* 250 */
  337.     "PB0", "PB1", "PB2", "PB3", "PB4" /* 254 */ 
  338. };
  339.  
  340. This table is a C ragged array  +----------------------------------------
  341. but all programmers with a few  |
  342. IQ points should be able to     | The control character 255 indicates
  343. understand it.                  | that this prefix isn't in the table.
  344.                                 | The format is then :
  345. --------------------------------|
  346.                                 |
  347. This space is left blank for    | [255]9M1[255]
  348. no real reason apart from that  | ^^^^^
  349. I had nothing to fill it with.  | N i T   E o P
  350.                                 | o n a   n f r   (Read these d
  351. --------------------------------| t   b   d   e               o
  352.                                 |     l       f               w
  353. Call postfix:   This is just    |     e       i               nwards! :)
  354.                 stored as three |             x
  355.                 ascii characters|
  356.                                 | ...then carry on as usual...
  357. Name:           String          |
  358.                 terminated by   +----------------------------------------
  359.                 a [255]
  360.  
  361. Address:        As with name
  362.  
  363. Postcode:       As with name
  364.  
  365. Each record is terminated by ¤.
  366.  
  367. The end of file is indicated by the OS, so no signal is needed.
  368.  
  369. A typical file would be :
  370.  
  371. CBLZB[001][000][255][007]LZBMr A.R. Howat[255]12 Dover Road, Birkdale, Sou
  372. thport, Merseyside[255]PR8 4SY[255]¤[004]TUPMr D.W. Norris[255]148 Sefton 
  373. St., Southport, Merseyside[255]PR8 4SY[255]¤
  374.  
  375. Which is much more efficient than the original PC file format. Of course,
  376. this is sequential, not random access, but because of the speed of disc
  377. drives nowadays it seemed reasonable to sacrifice speed for size.
  378.  
  379. The final file, <CallBookData$Path>.User, contains all the user additions.
  380. It is stored in the same format as the a-z files.
  381.  
  382. The conversion table contains most UK & Eire call prefixes, and it is 
  383. filled out with call prefixes for Germany and the first few prefixes 
  384. the Netherlands - basically because they are the countries where most 
  385. Arc owners reside. Particular attention was paid to the UK and Eire as
  386. that's what the original call book data contained. Some of the 2I's and
  387. GB's were sacrficied for GJ prefixes as they aren't used much. Sorry,
  388. but it only means 4 extra bytes!
  389.  
  390. Searches using this system take roughly 50 seconds for a complete search
  391. and two seconds for a search for a specific call (Using typical IDE hard
  392. disc)
  393.  
  394. Tony Howat (g7lzb@gb7nwi)
  395.  
  396. 15th January 1994 [Version 1 Revision 0]
  397.  
  398. ------------------+
  399. How to contact me :
  400. ------------------+
  401.  
  402. Tony Howat
  403. 12 Dover Road    Tel : (0704) 563344 (evenings) - Only if desperate!
  404. Birkdale                               
  405. Southport        Packet : G7LZB@GB7NWI.#16.GBR.EU
  406. Merseyside     Internet : thowat@xargle.demon.co.uk
  407. England
  408. PR8 4SY
  409.  
  410.  
  411.                                    - O -
  412.                                    
  413. The first draft of this  manual was produced by Electronic Script Consultants - 0704 535947.
  414.  
  415.  
  416.